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

Cancel PipelineExecutor properly in case of exception in spawnThreads #60499

Merged
merged 3 commits into from Mar 5, 2024

Conversation

Avogar
Copy link
Member

@Avogar Avogar commented Feb 28, 2024

Changelog category (leave one):

  • Not for changelog (changelog entry is not required)

Very similar to #57104, it could lead to crash in fiber because RemoteQueryExecutor is not cancelled properly.

@robot-clickhouse robot-clickhouse added the pr-not-for-changelog This PR should not be mentioned in the changelog label Feb 28, 2024
@robot-clickhouse
Copy link
Member

robot-clickhouse commented Feb 28, 2024

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

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

Successful checks
Check nameDescriptionStatus
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
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
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
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
Check nameDescriptionStatus
A SyncThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS❌ failure
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❌ failure
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
Mergeable CheckChecks if all other necessary checks are successful❌ failure
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors❌ failure

@rschu1ze rschu1ze self-assigned this Feb 28, 2024
{
/// spawnThreads can throw an exception, for example CANNOT_SCHEDULE_TASK.
/// We should cancel execution properly before rethrow.
cancel();
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't we rather wrap the entire executeImpl() body in try/catch and call cancel() accordingly? I find this fix too narrow

Copy link
Member Author

Choose a reason for hiding this comment

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

But spawnThreads is the only place where we don't cancel execution in case of an exception. Other code either doesn't throw or handles exceptions correctly. Ideally, spawnThreads should not throw, but by now it's not possible: https://github.com/ClickHouse/clickhouse-core-incidents/issues/10#issuecomment-1816103879

Copy link
Member

Choose a reason for hiding this comment

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

No pressure regarding merging the fix - feel free to, but ...

But spawnThreads is the only place ...

It seems, it's a strong statement which can change overtime, and I don't see an easy way to conclude it from the code. But the function should hold the contract, i.e. - in case of exception, cancel whatever background jobs/processes it's doing. If it'd be implemented in the proposed way, then we'd not have the escalation in the first place.

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, I just realized that there is a code above:

    SCOPE_EXIT_SAFE(
        if (!finished_flag)
        {
            finish();
            if (pool)
                pool->wait();
        }
    );

And AFAIU finished_flag can be false only in case of an exception in executeImpl(), but we should call cancel() instead of finish() in this case, it's similar to #52533. So, let's do it

finish();
/// If finished_flag is not set, there was an exception.
/// Cancel execution in this case.
cancel();
Copy link
Member

Choose a reason for hiding this comment

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

Unclear if there was any reason to call only finish() here. The more I read code around, the more questions I have regarding the contracts. In general, looks ok but can't say anything in particular from my current understanding 😕

@Avogar Avogar merged commit be13d8e into master Mar 5, 2024
235 of 243 checks passed
@Avogar Avogar deleted the Avogar-patch-1 branch March 5, 2024 11:06
@robot-clickhouse-ci-2 robot-clickhouse-ci-2 added the pr-synced-to-cloud The PR is synced to the cloud repo label Mar 5, 2024
@Avogar Avogar mentioned this pull request Mar 13, 2024
@Avogar Avogar added the pr-must-backport Pull request should be backported intentionally. Use this label with great care! label Mar 13, 2024
robot-ch-test-poll added a commit that referenced this pull request Mar 13, 2024
…5ec2c4138cd1d3167a3ad3a8d2e43

Cherry pick #60499 to 23.8: Cancel PipelineExecutor properly in case of exception in spawnThreads
robot-clickhouse added a commit that referenced this pull request Mar 13, 2024
robot-ch-test-poll added a commit that referenced this pull request Mar 13, 2024
…25ec2c4138cd1d3167a3ad3a8d2e43

Cherry pick #60499 to 23.12: Cancel PipelineExecutor properly in case of exception in spawnThreads
robot-clickhouse added a commit that referenced this pull request Mar 13, 2024
robot-ch-test-poll added a commit that referenced this pull request Mar 13, 2024
…5ec2c4138cd1d3167a3ad3a8d2e43

Cherry pick #60499 to 24.1: Cancel PipelineExecutor properly in case of exception in spawnThreads
robot-clickhouse added a commit that referenced this pull request Mar 13, 2024
robot-ch-test-poll added a commit that referenced this pull request Mar 13, 2024
…5ec2c4138cd1d3167a3ad3a8d2e43

Cherry pick #60499 to 24.2: Cancel PipelineExecutor properly in case of exception in spawnThreads
robot-clickhouse added a commit that referenced this pull request Mar 13, 2024
robot-clickhouse added a commit that referenced this pull request Mar 14, 2024
Backport #60499 to 24.1: Cancel PipelineExecutor properly in case of exception in spawnThreads
Avogar added a commit that referenced this pull request Mar 14, 2024
Backport #60499 to 24.2: Cancel PipelineExecutor properly in case of exception in spawnThreads
Avogar added a commit that referenced this pull request Mar 14, 2024
Backport #60499 to 23.12: Cancel PipelineExecutor properly in case of exception in spawnThreads
Avogar added a commit that referenced this pull request Mar 14, 2024
Backport #60499 to 23.8: Cancel PipelineExecutor properly in case of exception in spawnThreads
robot-ch-test-poll added a commit that referenced this pull request Mar 14, 2024
…5ec2c4138cd1d3167a3ad3a8d2e43

Cherry pick #60499 to 23.3: Cancel PipelineExecutor properly in case of exception in spawnThreads
robot-clickhouse added a commit that referenced this pull request Mar 14, 2024
@robot-ch-test-poll robot-ch-test-poll added the pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore label Mar 14, 2024
Avogar added a commit that referenced this pull request Mar 14, 2024
Backport #60499 to 23.3: Cancel PipelineExecutor properly in case of exception in spawnThreads
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore pr-backports-created-cloud pr-must-backport Pull request should be backported intentionally. Use this label with great care! pr-not-for-changelog This PR should not be mentioned in the changelog pr-synced-to-cloud The PR is synced to the cloud repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants