Google Git
Sign in
apache/pulsar-client-cpp/refs/tags/v3.1.0-candidate-1
commit
3b5aff7f7630295de6749bacfff53c2ebc63449c
[log] [tgz]
author
Yunze Xu <xyzinfernity@163.com>
Tue Nov 22 19:01:07 2022 +0800
committer
Yunze Xu <xyzinfernity@163.com>
Wed Nov 23 10:35:35 2022 +0800
tree
60eb9e32bf527aef46ea223531a68e0deadde63d
parent
f29d09d2184334660cbf179cd9776672507fded6 [diff]
Fix segmentation fault during the destruction of ConsumerImpl (#121)

### Motivation

When I ran the tests of Python wrapper in my local env, I observed a
segmentation fault. See the key stacktrace:

```
#3  0x00007ffff6d742c5 in std::unique_lock<std::mutex>::lock() () from /usr/local/lib/python3.8/dist-packages/_pulsar.cpython-38-x86_64-linux-gnu.so
#4  0x00007ffff6d72523 in std::unique_lock<std::mutex>::unique_lock(std::mutex&) ()
   from /usr/local/lib/python3.8/dist-packages/_pulsar.cpython-38-x86_64-linux-gnu.so
#5  0x00007ffff67de193 in pulsar::ClientImpl::newRequestId (this=0x0) at /home/xyz/github.com/apache/pulsar-client-cpp/lib/ClientImpl.cc:644
#6  0x00007ffff685d2c2 in pulsar::ConsumerImpl::~ConsumerImpl (this=0x7fff9800f9e0, __in_chrg=<optimized out>)
    at /home/xyz/github.com/apache/pulsar-client-cpp/lib/ConsumerImpl.cc:116
```

In the destructor of `ConsumerImpl`, `client->newRequestId` might be
called. However, `client` might be a null pointer because it's returned
by `std::weak_ptr::lock()`.

### Modifications

Add null check to avoid the segfault.

(cherry picked from commit 9f9314a1fa4615d7fb9a01ab582ebfdd9259ca97)
1 file changed
tree: 60eb9e32bf527aef46ea223531a68e0deadde63d
  1. .github/
  2. build-support/
  3. cmake_modules/
  4. examples/
  5. include/
  6. lib/
  7. perf/
  8. pkg/
  9. proto/
  10. templates/
  11. test-conf/
  12. tests/
  13. win-examples/
  14. wireshark/
  15. .asf.yaml
  16. .clang-format
  17. .gitignore
  18. CMakeLists.txt
  19. CONTRIBUTING.md
  20. dependencies.yaml
  21. Doxyfile
  22. eclipse-formatter.xml
  23. LICENSE
  24. log4cxx.conf
  25. NOTICE
  26. pulsar-test-service-start.sh
  27. pulsar-test-service-stop.sh
  28. README.md
  29. run-unit-tests.sh
  30. SECURITY.md
  31. vcpkg.json
  32. version.txt
README.md

Pulsar C++ client library

Examples for using the API to publish and consume messages can be found under the examples folder.

Generate the API documents

Pulsar C++ client uses doxygen to build API documents. After installing doxygen, you only need to run doxygen to generate the API documents whose main page is under the doxygen/html/index.html path.

Requirements

The default supported compression types are:

  • CompressionNone
  • CompressionLZ4

If you want to enable other compression types, you need to install:

If you want to build and run the tests, you need to install GTest. Otherwise, you need to add CMake option -DBUILD_TESTS=OFF.

If you want to use ClientConfiguration::setLogConfFilePath, you need to install the Log4CXX and add CMake option -DUSE_LOG4CXX=ON.

Platforms

Pulsar C++ Client Library has been tested on:

  • Linux
  • Mac OS X
  • Windows x64

Compilation

Clone

First of all, clone the source code:

git clone https://github.com/apache/pulsar-client-cpp
cd pulsar-client-cpp

Compile on Ubuntu

Install all dependencies:

sudo apt-get update -y && apt-get install -y g++ cmake libssl-dev libcurl4-openssl-dev \
                libprotobuf-dev libboost-all-dev libgtest-dev libgmock-dev \
                protobuf-compiler

Compile Pulsar client library:

cmake .
make

Checks

Client library will be placed in:

lib/libpulsar.so
lib/libpulsar.a

Tools will be placed in:

perf/perfProducer
perf/perfConsumer

Compile on Mac OS X

Install all dependencies:

brew install openssl protobuf boost boost-python3 googletest zstd snappy

Compile Pulsar client library:

cmake .
make

Checks

Client library will be placed in:

lib/libpulsar.dylib
lib/libpulsar.a

Tools will be placed in:

perf/perfProducer
perf/perfConsumer

Compile on Windows

Install with vcpkg

It‘s highly recommended to use vcpkg for C++ package management on Windows. It’s easy to install and well supported by Visual Studio (2015/2017/2019) and CMake. See here for quick start.

Take Windows 64-bit library as an example, you only need to run

vcpkg install --feature-flags=manifests --triplet x64-windows

NOTE: For Windows 32-bit library, change x64-windows to x86-windows, see here for more details about the triplet concept in Vcpkg.

The all dependencies, which are specified by vcpkg.json, will be installed in vcpkg_installed/ subdirectory,

With vcpkg, you only need to run two commands:

cmake \
 -B ./build \
 -A x64 \
 -DBUILD_TESTS=OFF \
 -DVCPKG_TRIPLET=x64-windows \
 -DCMAKE_BUILD_TYPE=Release \
 -S .
cmake --build ./build --config Release

Then all artifacts will be built into build subdirectory.

NOTE:

  1. For Windows 32-bit, you need to use -A Win32 and -DVCPKG_TRIPLET=x86-windows.
  2. For MSVC Debug mode, you need to replace Release with Debug for both CMAKE_BUILD_TYPE variable and --config option.

Install dependencies manually

You need to install dlfcn-win32 in addition.

If you installed the dependencies manually, you need to run

#If all dependencies are in your path, all that is necessary is
cmake .

#if all dependencies are not in your path, then passing in a PROTOC_PATH and CMAKE_PREFIX_PATH is necessary
cmake -DPROTOC_PATH=C:/protobuf/bin/protoc -DCMAKE_PREFIX_PATH="C:/boost;C:/openssl;C:/zlib;C:/curl;C:/protobuf;C:/googletest;C:/dlfcn-win32" .

#This will generate pulsar-cpp.sln. Open this in Visual Studio and build the desired configurations.

Checks

Client library will be placed in:

build/lib/Release/pulsar.lib
build/lib/Release/pulsar.dll

Examples

Add windows environment paths:

build/lib/Release
vcpkg_installed

Examples will be available in:

build/examples/Release

Tests

# Execution
# Start standalone broker
./pulsar-test-service-start.sh

# Run the tests
cd tests
./pulsar-tests

# When no longer needed, stop standalone broker
./pulsar-test-service-stop.sh

Requirements for Contributors

It's required to install LLVM for clang-tidy and clang-format. Pulsar C++ client use clang-format 11 to format files. make format automatically formats the files.

For Ubuntu users, you can install clang-format-11 via apt install clang-format-11. For other users, run ./build-support/docker-format.sh if you have Docker installed.

We welcome contributions from the open source community, kindly make sure your changes are backward compatible with GCC 4.8 and Boost 1.53.