Skip to content

Commit bd19c63

Browse files
BewareMyPowerBewareMyPower
committed
Find libpulsarwithdeps.a when LINK_STATIC is ON
### Motivation Currently when LINK_STATIC is ON, Python client will still find libpulsar.a, which doesn't include the 3rd party dependencies of C++ client. In this case, we have to find those libraries. A simple way is to link statically to libpulsarwithdeps.a, which already contains all the dependencies of C++ client. ### Modifications Find libpulsarwithdeps.a when LINK_STATIC is ON. For macOS, the statically linked libcurl depends on the Foundation and SystemConfiguration frameworks, so the related compile options are added. In addition, a `LINK_OPENSSL` option is also added because the old C++ client doesn't link to OpenSSL statically so that `libpulsarwithdeps.a` doesn't contain OpenSSL. For new C++ client releases, there is no need to enable this option.
1 parent d14aada commit bd19c63

5 files changed

Lines changed: 144 additions & 4 deletions

File tree

‎.github/workflows/ci-pr-validation.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,25 @@ jobs:
6464
- name: Stop Pulsar service
6565
run: ./build-support/pulsar-test-service-stop.sh
6666

67+
build-static-link:
68+
name: Build statically linked Python library
69+
runs-on: ubuntu-latest
70+
timeout-minutes: 120
71+
72+
steps:
73+
- name: checkout
74+
uses: actions/checkout@v3
75+
76+
- name: Install OpenSSL
77+
run: sudo apt install libssl-dev
78+
79+
- name: Install dependencies
80+
run: ./build-support/install-dependencies.sh ./deps
81+
82+
- name: Build Python
83+
run: |
84+
cmake -B build -DLINK_STATIC=ON -DCMAKE_PREFIX_PATH=$PWD/deps/install -DLINK_OPENSSL=ON
85+
cmake --build build -j8
86+
87+
- name: Verify the extension
88+
run: cd build && python3 -c 'import _pulsar'

‎CMakeLists.txt‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,24 @@ set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake_modules")
2424
option(LINK_STATIC "Link against static libraries" OFF)
2525
MESSAGE(STATUS "LINK_STATIC: " ${LINK_STATIC})
2626

27+
# The pre-built C++ client might not link to OpenSSL statically.
28+
# Enable this option to find OpenSSL when LINK_STATIC is ON.
29+
option(LINK_OPENSSL "Link against OpenSSL" OFF)
30+
message(STATUS "LINK_OPENSSL: " ${LINK_OPENSSL})
31+
2732
MESSAGE(STATUS "CMAKE_BUILD_TYPE: " ${CMAKE_BUILD_TYPE})
2833
set(THREADS_PREFER_PTHREAD_FLAG TRUE)
2934
find_package(Threads REQUIRED)
3035
MESSAGE(STATUS "Threads library: " ${CMAKE_THREAD_LIBS_INIT})
3136

3237
if (LINK_STATIC)
33-
find_library(PULSAR_LIBRARY NAMES libpulsar.a)
38+
find_library(PULSAR_LIBRARY NAMES libpulsarwithdeps.a)
39+
if (LINK_OPENSSL)
40+
find_package(OpenSSL REQUIRED)
41+
message(STATUS "Found OPENSSL_LIBRARIES: " ${OPENSSL_LIBRARIES})
42+
endif ()
3443
else()
35-
find_library(PULSAR_LIBRARY NAMES libpulsar.so)
44+
find_library(PULSAR_LIBRARY NAMES pulsar)
3645
endif()
3746
message(STATUS "PULSAR_LIBRARY: ${PULSAR_LIBRARY}")
3847

@@ -150,12 +159,14 @@ message(STATUS "All libraries: ${PYTHON_WRAPPER_LIBS}")
150159
if (LINK_STATIC)
151160
if (APPLE)
152161
set(CMAKE_SHARED_LIBRARY_CREATE_CXX_FLAGS "${CMAKE_SHARED_LIBRARY_CREATE_CXX_FLAGS} -undefined dynamic_lookup")
153-
target_link_libraries(_pulsar -Wl,-all_load ${PYTHON_WRAPPER_LIBS})
162+
target_link_libraries(_pulsar -Wl,-all_load ${PYTHON_WRAPPER_LIBS}
163+
"-framework Foundation"
164+
"-framework SystemConfiguration")
154165
else ()
155166
if (NOT MSVC)
156167
set (CMAKE_SHARED_LINKER_FLAGS " -static-libgcc -static-libstdc++")
157168
endif()
158-
target_link_libraries(_pulsar ${PYTHON_WRAPPER_LIBS})
169+
target_link_libraries(_pulsar ${PYTHON_WRAPPER_LIBS} ${OPENSSL_CRYPTO_LIBRARY} ${OPENSSL_SSL_LIBRARY})
159170
endif ()
160171
else()
161172
target_link_libraries(_pulsar ${PYTHON_WRAPPER_LIBS})

‎build-support/dep-version.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
#!/usr/bin/env python3
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
21+
import yaml, sys
22+
23+
deps = yaml.safe_load(open("dependencies.yaml"))
24+
print(deps[sys.argv[1]])

‎build-support/install-dependencies.sh‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
#!/usr/bin/env bash
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
21+
set -e -x
22+
23+
ROOT_DIR=$(git rev-parse --show-toplevel)
24+
cd $ROOT_DIR
25+
26+
CACHE_DIR=~/.pulsar-python-deps
27+
if [[ $# -le 1 ]]; then
28+
CACHE_DIR=$(mkdir -p $1 && cd $1 && pwd)
29+
fi
30+
PREFIX=$CACHE_DIR/install
31+
echo "Use $CACHE_DIR to cache dependencies"
32+
33+
python3 -m pip install pyyaml
34+
35+
BOOST_VERSION=$(./build-support/dep-version.py boost)
36+
mkdir -p $CACHE_DIR
37+
cd $CACHE_DIR
38+
39+
download() {
40+
URL=$1
41+
BASENAME=$(basename $URL)
42+
if [[ ! -f $BASENAME ]]; then
43+
echo "curl -O -L $URL"
44+
curl -O -L $URL
45+
fi
46+
tar xfz $BASENAME
47+
}
48+
49+
# Install Boost
50+
BOOST_VERSION_=${BOOST_VERSION//./_}
51+
DIR=boost_$BOOST_VERSION_
52+
if [[ ! -f $DIR/.done ]]; then
53+
echo "Building Boost $BOOST_VERSION"
54+
download https://boostorg.jfrog.io/artifactory/main/release/${BOOST_VERSION}/source/boost_${BOOST_VERSION_}.tar.gz
55+
mkdir -p $PREFIX/include
56+
pushd $DIR
57+
./bootstrap.sh --with-libraries=python --with-python=python3 --prefix=$PREFIX 2>&1 >/dev/null
58+
./b2 address-model=64 cxxflags="-fPIC" link=static threading=multi -j8 install 2>&1 >/dev/null
59+
touch .done
60+
popd
61+
else
62+
echo "Using cached Boost $BOOST_VERSION"
63+
fi

‎dependencies.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one
3+
# or more contributor license agreements. See the NOTICE file
4+
# distributed with this work for additional information
5+
# regarding copyright ownership. The ASF licenses this file
6+
# to you under the Apache License, Version 2.0 (the
7+
# "License"); you may not use this file except in compliance
8+
# with the License. You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing,
13+
# software distributed under the License is distributed on an
14+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
# KIND, either express or implied. See the License for the
16+
# specific language governing permissions and limitations
17+
# under the License.
18+
#
19+
20+
boost: 1.80.0

0 commit comments

Comments
 (0)