Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix build errors when linking OpenSSL dynamically #62888

Merged
merged 3 commits into from Apr 24, 2024

Conversation

HarryLeeIBM
Copy link
Contributor

@HarryLeeIBM HarryLeeIBM commented Apr 23, 2024

(see #59870 (comment))

The build for OpenSSL dynamic linking(mkdir build; cd build; cmake .. -DENABLE_OPENSSL_DYNAMIC=1) is broken due to the following reasons:

  • It picks up the GNU linker when using clang and generates linking errors,
  • undefined symbols,
  • duplicated symbols.

Changelog category (leave one):

  • Build/Testing/Packaging Improvement

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Fixed build errors when OpenSSL is linked dynamically (note: this is generally unsupported and only required for s390x platforms).

Documentation entry for user-facing changes

  • Documentation is written (mandatory for new features)

Information about CI checks: https://clickhouse.com/docs/en/development/continuous-integration/


Modify your CI run:

NOTE: If your merge the PR with modified CI you MUST KNOW what you are doing
NOTE: Checked options will be applied if set before CI RunConfig/PrepareRunConfig step

Include tests (required builds will be added automatically):

  • Fast test
  • Integration Tests
  • Stateless tests
  • Stateful tests
  • Unit tests
  • Performance tests
  • All with ASAN
  • All with TSAN
  • All with Analyzer
  • Add your option here

Exclude tests:

  • Fast test
  • Integration Tests
  • Stateless tests
  • Stateful tests
  • Performance tests
  • All with ASAN
  • All with TSAN
  • All with MSAN
  • All with UBSAN
  • All with Coverage
  • All with Aarch64
  • Add your option here

Extra options:

  • do not test (only style check)
  • disable merge-commit (no merge from master before tests)
  • disable CI cache (job reuse)

Only specified batches in multi-batch jobs:

  • 1
  • 2
  • 3
  • 4

@HarryLeeIBM

This comment was marked as outdated.

@rschu1ze rschu1ze self-assigned this Apr 24, 2024
@rschu1ze rschu1ze added the can be tested Allows running workflows for external contributors label Apr 24, 2024
@rschu1ze rschu1ze changed the title Fix build errors for openssl dynamic linking Fix build errors when linking OpenSSL dynamically Apr 24, 2024
@rschu1ze rschu1ze changed the title Fix build errors when linking OpenSSL dynamically Fix errors when linking OpenSSL dynamically Apr 24, 2024
@rschu1ze rschu1ze changed the title Fix errors when linking OpenSSL dynamically Fix build errors when linking OpenSSL dynamically Apr 24, 2024
@robot-clickhouse-ci-1 robot-clickhouse-ci-1 added pr-build Pull request with build/testing/packaging improvement submodule changed At least one submodule changed in this PR. labels Apr 24, 2024
@robot-clickhouse-ci-1
Copy link
Contributor

robot-clickhouse-ci-1 commented Apr 24, 2024

This is an automated comment for commit 2f0fb73 with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Check nameDescriptionStatus
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR⏳ pending
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Successful checks
Check nameDescriptionStatus
A SyncThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help✅ success
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker keeper imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docker server imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docs checkBuilds and tests the documentation✅ success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here✅ success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc✅ success
Install packagesChecks that the built packages are installable in a clear environment✅ success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests✅ success
Mergeable CheckChecks if all other necessary checks are successful✅ success
PR CheckThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors✅ success
Style checkRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts✅ success

contrib/openssl-cmake/CMakeLists.txt Show resolved Hide resolved
contrib/openssl-cmake/CMakeLists.txt Show resolved Hide resolved
contrib/openssl-cmake/CMakeLists.txt Show resolved Hide resolved
@@ -93,6 +93,7 @@ enable_language(ASM)

if(COMPILER_CLANG)
add_definitions(-Wno-unused-command-line-argument)
set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -fuse-ld=lld")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Setting a linker manually seems weird, tbh. This will potentially cause that different libraries of ClickHouse are linked by different linkers which is in the general case troublesome (as far as I know).

Including or not including l. 96 did not make a difference for me in local testing with static/dynamic link. I tested on x86 though, perhaps things are different on s390x.

I am not totally against explicitly specifying a linker but perhaps we can do so only for platforms where this makes a difference (s390x)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I observed higher versions of CMake fixed the issue(which is your case), but lower versions of CMake(my CMake version is 3.23.2 for example) has this issue. I suggest we keep the change for lower version CMake users.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, okay.

@rschu1ze rschu1ze added this pull request to the merge queue Apr 24, 2024
Merged via the queue into ClickHouse:master with commit 9c27cb6 Apr 24, 2024
220 of 230 checks passed
@HarryLeeIBM HarryLeeIBM deleted the hlee-fix-openssl-build branch April 24, 2024 18:42
@robot-clickhouse-ci-1 robot-clickhouse-ci-1 added the pr-synced-to-cloud The PR is synced to the cloud repo label Apr 24, 2024
@larryluogit
Copy link
Contributor

@rschu1ze @alexey-milovidov Can this pr be backported to 24.3LTS? This PR and #63135 are required to enable 24.3 in s390x

@alexey-milovidov
Copy link
Member

It is not a production build, and dynamic linking is strictly prohibited in production. If you need it for your own purposes, you can backport on your own.

@rschu1ze
Copy link
Member

@larryluogit
Copy link
Contributor

Thanks @rschu1ze we are all good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
can be tested Allows running workflows for external contributors pr-build Pull request with build/testing/packaging improvement pr-synced-to-cloud The PR is synced to the cloud repo submodule changed At least one submodule changed in this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants