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

Replace Turbo-Base64 with aklomp/base64 #54119

Merged
merged 8 commits into from
Sep 9, 2023

Conversation

mkmkme
Copy link
Contributor

@mkmkme mkmkme commented Aug 31, 2023

Fixes #31643
Fixes #45790
Fixes #41957

Changelog category (leave one):

  • Improvement

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

Replaced the library to handle (encode/decode) base64 values from Turbo-Base64 to aklomp-base64. Both are SIMD-accelerated on x86 and ARM but 1. the license of the latter (BSD-2) is more favorable for ClickHouse, Turbo64 switched in the meantime to GPL-3, 2. with more GitHub stars, aklomp-base64 seems more future-proof, 3. aklomp-base64 has a slightly nicer API (which is arguably subjective), and 4. aklomp-base64 does not require us to hack around bugs (like non-threadsafe initialization). Note: aklomp-base64 rejects unpadded base64 values whereas Turbo-Base64 decodes them on a best-effort basis. RFC-4648 leaves it open whether padding is mandatory or not, but depending on the context this may be a behavioral change to be aware of.

@mkmkme mkmkme marked this pull request as draft August 31, 2023 16:17
@mkmkme
Copy link
Contributor Author

mkmkme commented Aug 31, 2023

I noticed the build fails on x86_64. I'll fix it and undraft it.

Please keep in mind that as I mentioned earlier, this actually makes base64{Encode,Decode} slower

@rschu1ze rschu1ze self-assigned this Aug 31, 2023
@mkmkme mkmkme marked this pull request as ready for review September 1, 2023 07:28
@rschu1ze rschu1ze added the can be tested Allows running workflows for external contributors label Sep 1, 2023
@robot-clickhouse-ci-1 robot-clickhouse-ci-1 added pr-improvement Pull request with some product improvements submodule changed At least one submodule changed in this PR. labels Sep 1, 2023
@robot-clickhouse-ci-1
Copy link
Contributor

robot-clickhouse-ci-1 commented Sep 1, 2023

This is an automated comment for commit 3c9d9ce with description of existing statuses. It's updated for the latest CI running
The full report is available here
The overall status of the commit is 🔴 failure

Check nameDescriptionStatus
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
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🟢 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 image for serversThe 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
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests🔴 failure
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub🟢 success
SQLTestThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS🟢 success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool🟢 success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed🟢 success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc🟢 success
Stateless testsRuns stateless 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

.gitmodules Outdated Show resolved Hide resolved
contrib/base64-cmake/CMakeLists.txt Outdated Show resolved Hide resolved
contrib/base64-cmake/CMakeLists.txt Outdated Show resolved Hide resolved
contrib/base64-cmake/README.md Outdated Show resolved Hide resolved
@mkmkme

This comment was marked as outdated.

@rschu1ze

This comment was marked as outdated.

@clickhouse-ci clickhouse-ci bot added manual approve Manual approve required to run CI labels Sep 6, 2023
@mkmkme

This comment was marked as outdated.

@rschu1ze

This comment was marked as outdated.

@mkmkme

This comment was marked as outdated.

@rschu1ze

This comment was marked as outdated.

@mkmkme

This comment was marked as outdated.

@den-crane

This comment was marked as outdated.

@rschu1ze rschu1ze removed the manual approve Manual approve required to run CI label Sep 6, 2023
* Remove generated `tables.h` and use the ones from upstream instead
* Add comment about compiling AVX512 codec
@clickhouse-ci clickhouse-ci bot added the manual approve Manual approve required to run CI label Sep 6, 2023
@rschu1ze rschu1ze removed the manual approve Manual approve required to run CI label Sep 6, 2023
@clickhouse-ci clickhouse-ci bot added the manual approve Manual approve required to run CI label Sep 7, 2023
@rschu1ze rschu1ze removed the manual approve Manual approve required to run CI label Sep 7, 2023
@clickhouse-ci clickhouse-ci bot added the manual approve Manual approve required to run CI label Sep 7, 2023
@rschu1ze

This comment was marked as outdated.

@mkmkme

This comment was marked as outdated.

@rschu1ze rschu1ze merged commit 4d2223d into ClickHouse:master Sep 9, 2023
278 of 281 checks passed
@spff
Copy link

spff commented Nov 17, 2023

I found select tryBase64Decode('aoeo054640eu=') returns non-empty string from 23.9, should we update the doc or should we turn it into empty string?

@rschu1ze
Copy link
Member

@spff Thanks for reporting, a fix is here.

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 manual approve Manual approve required to run CI pr-improvement Pull request with some product improvements submodule changed At least one submodule changed in this PR.
Projects
None yet
5 participants