Link to OpenSSL statically when LINK_STATIC is ON #31
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### Motivation See discussions here: apache#28 (comment) The original purpose to not include static OpenSSL library in `libpulsarwithnossl.so` and `libpulsarwithdeps.a` is apache/pulsar#6458. However, the ABI compatibility of OpenSSL is not good. If the Pulsar C++ library links dynamically to OpenSSL and the user only changes the OpenSSL dynamic library, some symbols might not be found. ### Modifications Use `LINK_STATIC` option to determine whether to link to OpenSSL library statically. After that, there are only 3 libraries generated when `LINK_STATIC` is ON. - `libpulsar.so`: the dynamic pulsar-client-cpp library. - `libpulsar.a`: the static pulsar-client-cpp library. When it's used, users must link to all 3rd party dependencies (OpenSSL, curl, etc.) - `libpulsarwithdeps.a`: the static pulsar-client-cpp library.
BewareMyPower
requested review from
Demogorgon314,
RobertIndie,
jiazhai and
merlimat
Contributor
Author
|
After this PR, here are examples about how do I build an application with the given three libraries on macOS. Assume they are built with Given such an application code ( #include <pulsar/Client.h>
using namespace pulsar;
int main() {
Client client("pulsar://localhost:6650");
client.close();
}Assuming the headers are under libpulsar.soBuild: clang++ example.cc -I include/ -L lib/ -lpulsarRun: # You have to add the path of `libpulsar.dylib` to a specific env variable so that symbols can be found
DYLD_LIBRARY_PATH=$PWD/lib ./a.outlibpulsar.aBuild: # You have to link all 3rd party dependencies.
# BTW, the directory followed by `-L` might be different in your actual env.
clang++ example.cc -I include/ \
lib/libpulsar.a \
-lcurl -lz -lzstd \
-L /usr/local/opt/protobuf/lib/ -lprotobuf \
-L /usr/local/opt/openssl@3/lib/ -lssl -lcrypto \
-L /usr/local/opt/snappy/lib/ -lsnappyRun: ./a.outlibpulsarwithdeps.aBuild: # NOTE: these -framework options are required by curl.a and only needed on macOS
clang++ example.cc lib/libpulsarwithdeps.a -framework SystemConfiguration -framework CoreFoundationRun: ./a.out |
merlimat
approved these changes
Oct 9, 2022
Contributor
Author
|
I will fix the rpm / deb scripts soon. |
Contributor
Author
|
I see the "Squash and merge" button is not disabled even if some tests failed. Could you help make some workflows REQUIRED? @merlimat |
merlimat
approved these changes
Oct 10, 2022
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
See discussions here: #28 (comment)
The original purpose to not include static OpenSSL library in
libpulsarwithnossl.soandlibpulsarwithdeps.ais apache/pulsar#6458. However, the ABI compatibility of OpenSSL is not good. If the Pulsar C++ library links dynamically to OpenSSL and the user only changes the OpenSSL dynamic library, some symbols might not be found.Modifications
Use
LINK_STATICoption to determine whether to link to OpenSSL library statically. After that, there are only 3 libraries generated whenLINK_STATICis ON.libpulsar.so: the dynamic pulsar-client-cpp library.libpulsar.a: the static pulsar-client-cpp library. When it's used, users must link to all 3rd party dependencies (OpenSSL, curl, etc.)libpulsarwithdeps.a: the static pulsar-client-cpp library.Documentation
doc-required(Your PR needs to update docs and you will update later)
doc-not-needed(Please explain why)
doc(Your PR contains doc changes)
doc-complete(Docs have been already added)