[common] move include of byteswap.hpp into source #2977
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @Irving-cl, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a critical build failure on macOS CI environments, which stemmed from a macro redefinition conflict between the project's byteswap.hpp and the protobuf library. The primary solution involves optimizing header inclusion by relocating the byteswap.hpp include from a widely used header file (types.hpp) to its corresponding source file (types.cpp), where its functionality is actually implemented and required. This change not only resolves the compilation issue but also introduces a new utility method for Ip6Address within types.cpp.
Highlights
- Build Fix & Header Optimization: I've resolved a
bswap_16macro redefinition error that was occurring on macOS CI environments. This was achieved by moving the#include "common/byteswap.hpp"directive fromsrc/common/types.hpptosrc/common/types.cpp. This ensures thatbyteswap.hppis only included where its functions are directly used, preventing conflicts with other libraries like Protobuf that might define similar macros. - IPv6 Address Utility: I've added an
IsLinkLocalmethod to theIp6Addressclass withinsrc/common/types.cpp. This new method allows for checking if an IPv6 address falls within the link-local prefix (fe80::/10).
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request moves the include of byteswap.hpp from types.hpp to types.cpp to resolve a macro redefinition issue on macOS. My feedback focuses on improving the clarity of the newly-exposed IsLinkLocal function by using a more idiomatic approach for endianness conversion and recommends adding unit tests to ensure its correctness.
Irving-cl
force-pushed
the
refine_common_types
branch
from
6ee6d63 to
a9e88e5
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2977 +/- ##
===========================================
- Coverage 55.77% 42.00% -13.78%
===========================================
Files 87 115 +28
Lines 6890 14064 +7174
Branches 0 961 +961
===========================================
+ Hits 3843 5907 +2064
- Misses 3047 7859 +4812
- Partials 0 298 +298 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Irving-cl
force-pushed
the
refine_common_types
branch
2 times, most recently
from
267537e to
fa3ee87
Compare
Irving-cl
force-pushed
the
refine_common_types
branch
from
fa3ee87 to
7b338c8
Compare
This PR moves the include of
byteswap.hppfromtypes.hpptotypes.cpp.Recently I met a build issue on CI on MacOS (with my code change): Failed Run
The cause is that the protobuf header and
byteswap.hpphas re-definition.types.hppis widely included by sources inotbr-agentwhilebyteswap.hppis only used by some implementations oftypes.hpp. So we can move the usage ofbyteswap.hppintotypes.cppto solve this issue.