zchuango opened a new pull request, #3475: URL: https://github.com/apache/brpc/pull/3475
### What problem does this PR solve? Issue Number: resolve #2593 Problem Summary: When brpc is integrated into a parent CMake project with `add_subdirectory`, include directories added by the parent project may be inherited by brpc targets. If one of those directories contains an unrelated header named `zlib.h`, such as Crypto++'s `zlib.h`, protobuf's `gzip_stream.h` may resolve that header instead of the zlib header discovered for the build. This causes protobuf compilation to fail because types such as `z_stream` are not defined: ```text /usr/include/google/protobuf/io/gzip_stream.h:93:3: error: 'z_stream' does not name a type ``` The issue is caused by compile-time header resolution, so linking brpc against the bare `z` library name does not ensure that protobuf includes the intended zlib header. ### What is changed and the side effects? Changed: - Find zlib explicitly with `find_package(ZLIB REQUIRED)`. - Link brpc with the standard CMake target `ZLIB::ZLIB` instead of the bare library name `z`. - Prioritize the discovered zlib include directories for `SOURCES_LIB`, where protobuf's `gzip_stream.h` is compiled. - Keep the include-path adjustment target-scoped so that it does not modify global include directories or affect unrelated parent-project targets. This allows brpc to use the intended zlib header even when a parent project supplies an inherited include directory containing another `zlib.h`. Side effects: - Performance effects: None expected. - Breaking backward compatibility: None expected. - Dependency changes: None. zlib was already required by brpc; this change uses CMake's standard `FindZLIB` result explicitly. ### Verification The issue was reproduced with a minimal parent CMake project that: - integrates brpc using `add_subdirectory`; - adds an inherited include directory containing Crypto++'s `zlib.h`; - builds and links a `parent_smoke` executable against brpc. Before this change, the reproduction failed while compiling protobuf's `gzip_stream.h` with: ```text error: 'z_stream' does not name a type ``` After this change, a fresh build of the same collision case completed successfully: ```powershell docker exec brpc-2593-dev bash -lc "cmake --build /workspace/screenshot-collision-build --target parent_smoke -j2 && /workspace/screenshot-collision-build/parent_smoke && echo PATCHED_COLLISION_CLEAN_BUILD_OK" ``` <img width="1096" height="119" alt="1" src="https://github.com/user-attachments/assets/e697a5a8-9437-4eb4-a4f3-25c217e07352"; /> <img width="881" height="82" alt="2" src="https://github.com/user-attachments/assets/619dfa78-48a9-4458-bcf2-0bb3ee978001"; /> The fresh build completed all 378 steps, linked `libbrpc.a` and `parent_smoke`, and ran `parent_smoke` successfully. Additional verification: - Standalone CMake configuration: passed. - Standalone `brpc-static` build: passed. - Parent-project CMake configuration: passed. - Parent-project `parent_smoke` compile, link, and execution: passed. - Collision reproduction with Crypto++'s `zlib.h`: passed after the change. - ARM64 cross-compilation and linking: passed. - ARM64 runtime execution: not performed because QEMU/binfmt was unavailable in the test environment. - `git diff --check`: passed. ### Check List: - Please make sure your changes are compilable. - When providing us with a new feature, it is best to add related tests. - Please follow [[Contributor Covenant Code of Conduct](https://github.com/apache/brpc/blob/master/CODE_OF_CONDUCT.md)](https://github.com/apache/brpc/blob/master/CODE_OF_CONDUCT.md). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
