microsoft / microsoft/STL

No thread-safe annotations for mutex and related classes

Open
#4,555 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C++
Stars
11.1k
Forks
1.7k
Avg merge
4d 15h
Merged PRs (30d)
22

Description

The clang compiler comes with some very useful warnings under the umbrella of -Wthread-safety. (See https://clang.llvm.org/docs/ThreadSafetyAnalysis.html) Unfortunately, the MS STL does not provide annotations to the relevant classes, such that this warning cannot be used with the standard STL types.

How about other implementations?

Would it be possible to decorate the thread safety analysis such that this warning can be used and prevent a lot of debugging time for threading issues that are easily caught by the compiler?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked libc++ mutex annotations and the libstdc++ mutex source, then inspect the corresponding MS STL mutex and related class headers. Determine which standard-library types need annotations and verify that Clang's -Wthread-safety can use them without breaking supported configurations.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.