Skip to content

Support 64bit XID in Keeper#69908

Merged
antonio2368 merged 4 commits intomasterfrom
keeper-xid-64
Sep 30, 2024
Merged

Support 64bit XID in Keeper#69908
antonio2368 merged 4 commits intomasterfrom
keeper-xid-64

Conversation

@antonio2368
Copy link
Copy Markdown
Member

@antonio2368 antonio2368 commented Sep 24, 2024 •
edited
Loading

Changelog category (leave one):

  • Improvement

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

Support 64-bit XID in Keeper. It can be enabled with use_xid_64 config.

Close #56245

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/

CI Settings (Only check the boxes if you know what you are doing):

  • Allow: All Required Checks
  • Allow: Stateless tests
  • Allow: Stateful tests
  • Allow: Integration Tests
  • Allow: Performance tests
  • Allow: All Builds
  • Allow: batch 1, 2 for multi-batch jobs
  • Allow: batch 3, 4, 5, 6 for multi-batch jobs
  • Exclude: Style check
  • Exclude: Fast test
  • Exclude: All with ASAN
  • Exclude: All with TSAN, MSAN, UBSAN, Coverage
  • Exclude: All with aarch64, release, debug
  • Run only fuzzers related jobs (libFuzzer fuzzers, AST fuzzers, etc.)
  • Exclude: AST fuzzers
  • Do not test
  • Woolen Wolfdog
  • Upload binaries for special builds
  • Disable merge-commit
  • Disable CI cache

@antonio2368 antonio2368 added the jepsen-test Need to test this PR with jepsen tests label Sep 24, 2024
@robot-ch-test-poll3 robot-ch-test-poll3 added the pr-improvement Pull request with some product improvements label Sep 24, 2024
@robot-ch-test-poll4
Copy link
Copy Markdown
Contributor

robot-ch-test-poll4 commented Sep 24, 2024 •
edited by robot-ch-test-poll1
Loading

This is an automated comment for commit 932a563 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
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
Successful checks
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
BuildsThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
ClickHouse Keeper JepsenThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ 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. Integration 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
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

@antonio2368 antonio2368 marked this pull request as ready for review September 25, 2024 10:45
@vdimir vdimir self-assigned this Sep 25, 2024
vdimir
vdimir reviewed Sep 25, 2024
View reviewed changes
src/Server/KeeperTCPHandler.cpp
else if (protocol_version >= Coordination::ZOOKEEPER_PROTOCOL_VERSION_WITH_XID_64)
{
close_xid = Coordination::CLOSE_XID_64;
use_xid_64 = true;
Copy link
Copy Markdown
Member

@vdimir vdimir Sep 25, 2024

Choose a reason for hiding this comment

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

Why true is set for new protocol version unconditionally without taking into account config option? I'd expect setting it from config for new protocol and explicit disabling for old one.

UPD: seems in that case we will try to find second part for xid, but if it's not present will use 32 bit variant depending on what other side had sent, is it correct ?

Copy link
Copy Markdown
Member Author

@antonio2368 antonio2368 Sep 25, 2024

Choose a reason for hiding this comment

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

So client defines if XID will be 32 or 64 bit.
Based on the config, it will send a different protocol version (if use_xid_64 is set to true, ZOOKEEPER_PROTOCOL_VERSION_WITH_XID_64 will be used).
Why unconditionally? Because I see no reason to use 32bit XID if Keeper supports 64bit.

UPD: seems in that case we will try to find second part for xid, but if it's not present will use 32 bit variant depending on what other side had sent, is it correct ?

This is only true for serializing and deserializing RAFT log entries, but for communication the XID will be sent in a chunk as 32 or 64 bit integer, depending on the protocol version used.

tests/config/config.d/zookeeper_fault_injection.xml
<clickhouse>
<zookeeper>
<use_compression>1</use_compression>
<use_xid_64>1</use_xid_64>
Copy link
Copy Markdown
Member

@vdimir vdimir Sep 25, 2024

Choose a reason for hiding this comment

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

Don't we want to randomize it somehow? I recently added setting randomization #69328, but it's for user profile setting, not sure if can be easily extended for other config sections, though

Copy link
Copy Markdown
Member Author

@antonio2368 antonio2368 Sep 25, 2024

Choose a reason for hiding this comment

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

I need to push a change with randomization added for stress tests.
For integration tests, I'm not yet sure if we can enable it all because older binaries are used in some tests.

@antonio2368 antonio2368 requested a review from vdimir September 30, 2024 07:44
@antonio2368 antonio2368 added this pull request to the merge queue Sep 30, 2024
Merged via the queue into master with commit 61c8463 Sep 30, 2024
@antonio2368 antonio2368 deleted the keeper-xid-64 branch September 30, 2024 12:54
@robot-ch-test-poll4 robot-ch-test-poll4 added the pr-synced-to-cloud The PR is synced to the cloud repo label Sep 30, 2024
@antaljanosbenjamin antaljanosbenjamin mentioned this pull request Sep 30, 2024
Closed
20 tasks
@robot-clickhouse-ci-1 robot-clickhouse-ci-1 added the pr-backports-created-cloud deprecated label, NOOP label Sep 30, 2024
@antonio2368 antonio2368 mentioned this pull request Oct 23, 2024
Merged
21 tasks
@filimonov
Copy link
Copy Markdown
Contributor

filimonov commented Aug 27, 2025

Documentation is missing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vdimir vdimir vdimir approved these changes

Assignees

@vdimir vdimir

Labels

jepsen-test Need to test this PR with jepsen tests pr-backports-created-cloud deprecated label, NOOP pr-improvement Pull request with some product improvements pr-synced-to-cloud The PR is synced to the cloud repo

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Use Int64 for XID in Keeper

6 participants

@antonio2368 @robot-ch-test-poll4 @filimonov @vdimir @robot-ch-test-poll3 @robot-clickhouse-ci-1