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 ThreadSanitizer: std::localtime() is not thread-safe. #4344

Merged
merged 9 commits into from
Mar 21, 2022
Merged

Fix ThreadSanitizer: std::localtime() is not thread-safe. #4344

merged 9 commits into from
Mar 21, 2022

Conversation

Lloyd-Pottiger
Copy link
Contributor

Replace thread-unsafe std::localtime() in DB::UnifiedLogPatternFormatter::getTimestamp() with localtime_r()

What problem does this PR solve?

Issue Number: close #4303

Problem Summary:

What is changed and how it works?

Replace thread-unsafe std::localtime() in DB::UnifiedLogPatternFormatter::getTimestamp() with localtime_r(). Because std::localtime() is not thread-safe, localtime_r() is thread-safe.

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No code

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

None

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Mar 18, 2022

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • JaySon-Huang
  • JinheLin

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 18, 2022
Copy link
Contributor

@JaySon-Huang JaySon-Huang left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Mar 18, 2022
@SchrodingerZhu SchrodingerZhu self-requested a review March 18, 2022 09:22
Copy link
Contributor

@SchrodingerZhu SchrodingerZhu left a comment

Choose a reason for hiding this comment

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

null pointer on error (which may be a runtime constraint violation or a failure to convert the specified time to local calendar time)

LGTM, but shall we check null pointers (i.e. throw exceptions instead)? cc @JaySon-Huang

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Mar 18, 2022
@JaySon-Huang
Copy link
Contributor

JaySon-Huang commented Mar 18, 2022

null pointer on error (which may be a runtime constraint violation or a failure to convert the specified time to local calendar time)

LGTM, but shall we check null pointers (i.e. throw exceptions instead)? cc @JaySon-Huang

Good catch. However, throwing exceptions maybe not a good idea, cause the exception usually is thrown to BaseDaemon, and leads to more logs while printing those exceptions. It will make things out of control.

I think if localtime_r() return nullptr, just return "0000/00/00 00:00:00.000 00000"?
/cc @SchrodingerZhu @Lloyd-Pottiger


Finally we decide to use "1970/01/01 00:00:00.000 +00:00" for invalid result

@SchrodingerZhu
Copy link
Contributor

SchrodingerZhu commented Mar 18, 2022

I think if localtime_r() return nullptr, just return "0000/00/00 00:00:00.000 00000"?

LGTM.

@ti-chi-bot ti-chi-bot removed the status/LGT2 Indicates that a PR has LGTM 2. label Mar 18, 2022
Copy link
Contributor

@JaySon-Huang JaySon-Huang left a comment

Choose a reason for hiding this comment

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

LGTM with minor comment

dbms/src/Common/UnifiedLogPatternFormatter.cpp Outdated Show resolved Hide resolved
dbms/src/Common/UnifiedLogPatternFormatter.cpp Outdated Show resolved Hide resolved
@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Mar 21, 2022
@Lloyd-Pottiger
Copy link
Contributor Author

/merge

@ti-chi-bot
Copy link
Member

@Lloyd-Pottiger: It seems you want to merge this PR, I will help you trigger all the tests:

/run-all-tests

You only need to trigger /merge once, and if the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

If you have any questions about the PR merge process, please refer to pr process.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Member

@Lloyd-Pottiger: /merge in this pull request requires 2 approval(s).

In response to this:

/merge

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@JaySon-Huang
Copy link
Contributor

@SchrodingerZhu @JinheLin PTAL again

@ti-chi-bot ti-chi-bot removed the status/LGT1 Indicates that a PR has LGTM 1. label Mar 21, 2022
@ti-chi-bot ti-chi-bot added the status/LGT2 Indicates that a PR has LGTM 2. label Mar 21, 2022
@Lloyd-Pottiger
Copy link
Contributor Author

/run-unit-test

@sre-bot
Copy link
Collaborator

sre-bot commented Mar 21, 2022

Coverage for changed files

Filename                                                                                                      Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
/home/jenkins/agent/workspace/tiflash-build-common/tiflash/dbms/src/Common/UnifiedLogPatternFormatter.cpp          78                25    67.95%           6                 0   100.00%         166                44    73.49%          78                26    66.67%
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                                                                              78                25    67.95%           6                 0   100.00%         166                44    73.49%          78                26    66.67%

Coverage summary

Functions  MissedFunctions  Executed  Lines   MissedLines  Cover
17016      9573             43.74%    191597  97039        49.35%

full coverage report (for internal network access only)

@JaySon-Huang
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

@JaySon-Huang: It seems you want to merge this PR, I will help you trigger all the tests:

/run-all-tests

You only need to trigger /merge once, and if the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

If you have any questions about the PR merge process, please refer to pr process.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 93498da

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 21, 2022
@sre-bot
Copy link
Collaborator

sre-bot commented Mar 21, 2022

Coverage for changed files

Filename                                                                                                      Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
/home/jenkins/agent/workspace/tiflash-build-common/tiflash/dbms/src/Common/UnifiedLogPatternFormatter.cpp          78                25    67.95%           6                 0   100.00%         166                44    73.49%          78                27    65.38%
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                                                                              78                25    67.95%           6                 0   100.00%         166                44    73.49%          78                27    65.38%

Coverage summary

Functions  MissedFunctions  Executed  Lines   MissedLines  Cover
17016      9573             43.74%    191597  97044        49.35%

full coverage report (for internal network access only)

@sre-bot
Copy link
Collaborator

sre-bot commented Mar 21, 2022

Coverage for changed files

Filename                                                                                                      Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
/home/jenkins/agent/workspace/tiflash-build-common/tiflash/dbms/src/Common/UnifiedLogPatternFormatter.cpp          78                25    67.95%           6                 0   100.00%         166                44    73.49%          78                28    64.10%
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                                                                              78                25    67.95%           6                 0   100.00%         166                44    73.49%          78                28    64.10%

Coverage summary

Functions  MissedFunctions  Executed  Lines   MissedLines  Cover
17031      9576             43.77%    191844  97041        49.42%

full coverage report (for internal network access only)

@ti-chi-bot ti-chi-bot merged commit b0542e5 into pingcap:master Mar 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ThreadSanitizer: std::localtime() is not thread-safe.
6 participants