From patchwork Wed Sep 14 22:04:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Wakely X-Patchwork-Id: 1225 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:2302:b0:79:6ae5:3758 with SMTP id gv2csp954495dyb; Wed, 14 Sep 2022 15:06:20 -0700 (PDT) X-Google-Smtp-Source: AA6agR6kZ93T8YCirgTiYkVe6oCbRjoFZ6R7so6nmfSvtBcYisnv/e1t1IeLYwCqsAuWl45+XVKS X-Received: by 2002:aa7:d5d0:0:b0:44e:f6cc:7107 with SMTP id d16-20020aa7d5d0000000b0044ef6cc7107mr32371835eds.371.1663193180319; Wed, 14 Sep 2022 15:06:20 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1663193180; cv=none; d=google.com; s=arc-20160816; b=0/GJgdSskGbySKy/wxsMIqrrLDN+1UgEZNs70WbIhd+QEAh6/Fa6j/ocWpGkTSd1gq AYvJNWP7C3bFMxbnSKK77kbxBjrEx3N9jWpiVuB0bAg8vBWlVp/6QTIrtLVcXdOkF9uX uCVLmy54wX5T8z3kjCMLrkDymcY7X9Y+BbPr9l4NKSFraRjx7IErvsKIMFIMcNmFd47h 1WkvMQm+Sbx/EkCs63nFR3dBLwO3ePntY/3o4znbf9pxjUtjubDg9LTDhbpiqSmd9AX/ s/rN00xHYyGc6Jd53G1VkRN4Hj4SEnDw/oIHJDGKy6K/LOivQ3wRim357dw7uTfqBmpl 12lg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:reply-to:from:list-subscribe:list-help:list-post :list-archive:list-unsubscribe:list-id:precedence :content-transfer-encoding:mime-version:message-id:date:subject:to :dmarc-filter:delivered-to:dkim-signature:dkim-filter; bh=pQuvnAYy1r9kHiMXFiNwnMdq4nGEeCEQUyarqnA+PS8=; b=jmlx1B4cd7f8DQKvKu+QHW3ZaQRqz4aWTVjNXd4bEJg3d2iuGxOX5kBZMecJqj/YZ7 t5VMyiDshCEFAPpbWDM9IqL8olPA9a1/97VzWFQ+M0ICVczBoKh5xzFWhzheVTGnYq/F ecaNrCyw85S7KyDBo11M1p5ocPhrQL9vQJ0j22fSXKC+Qsyf7BlU9JY9bmSnWOrLaXka u+Ox9ndhDJDQpmhp1vLO28WRsUXPHsg2v6mAU05gAi1vYfz7iPisnnQswlk0lAqpFIDI xprZETIBgsZzoDNdFTEqzS7o3/5QwFaOY1078YIlmUJHNOXUi0XqtEqY8kZ4BYDEmhRy DFaw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gcc.gnu.org header.s=default header.b=Tdf2HiMY; spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gnu.org Received: from sourceware.org (ip-8-43-85-97.sourceware.org. [8.43.85.97]) by mx.google.com with ESMTPS id t23-20020a05640203d700b0044e9c289ae5si3103290edw.155.2022.09.14.15.06.20 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 14 Sep 2022 15:06:20 -0700 (PDT) Received-SPF: pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) client-ip=8.43.85.97; Authentication-Results: mx.google.com; dkim=pass header.i=@gcc.gnu.org header.s=default header.b=Tdf2HiMY; spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gnu.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 16AA3384D177 for ; Wed, 14 Sep 2022 22:05:40 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 16AA3384D177 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1663193140; bh=pQuvnAYy1r9kHiMXFiNwnMdq4nGEeCEQUyarqnA+PS8=; h=To:Subject:Date:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=Tdf2HiMYB6DJ+yq2y+MYNlXhheDY8/N/83Z2c+LMuMBpwbQvVYBBGCac7F/htZ+Hp U8OtiTG3hZn32FpT9lmNUKhIQAGfJC+d4uQsun3CShyd2OvPI/qLa0o1Z9AVKEJbVc DIlR3qRHg7J+9Jousbb7HYxUlPaC5oBTDH+fROsE= X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by sourceware.org (Postfix) with ESMTPS id ACFCC3851170 for ; Wed, 14 Sep 2022 22:04:54 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org ACFCC3851170 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-533-aCqW7CeSOqio3xqyMnZRHA-1; Wed, 14 Sep 2022 18:04:50 -0400 X-MC-Unique: aCqW7CeSOqio3xqyMnZRHA-1 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 0BBBD811E81; Wed, 14 Sep 2022 22:04:50 +0000 (UTC) Received: from localhost (unknown [10.33.36.214]) by smtp.corp.redhat.com (Postfix) with ESMTP id C71F040C6EC2; Wed, 14 Sep 2022 22:04:49 +0000 (UTC) To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org Subject: [committed] libstdc++: Add TSan annotations to std::atomic> Date: Wed, 14 Sep 2022 23:04:49 +0100 Message-Id: <20220914220449.276340-1-jwakely@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.2 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-14.0 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_LOW, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Jonathan Wakely via Gcc-patches From: Jonathan Wakely Reply-To: Jonathan Wakely Errors-To: gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org Sender: "Gcc-patches" X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1743984452378886402?= X-GMAIL-MSGID: =?utf-8?q?1743984452378886402?= Tested powerpc64le-linux, pushed to trunk. -- >8 -- This adds annotations to std::atomic> to enable TSan to understand the custom locking. Without this, TSan reports data races for accesses to the _M_ptr member, even though those are correctly synchronized using atomic operations on the tagged pointer. libstdc++-v3/ChangeLog: * include/bits/shared_ptr_atomic.h (_GLIBCXX_TSAN_MUTEX_DESTROY) (_GLIBCXX_TSAN_MUTEX_PRE_LOCK, _GLIBCXX_TSAN_MUTEX_POST_LOCK) (_GLIBCXX_TSAN_MUTEX_PRE_UNLOCK, _GLIBCXX_TSAN_MUTEX_POST_UNLOCK) (_GLIBCXX_TSAN_MUTEX_PRE_SIGNAL, _GLIBCXX_TSAN_MUTEX_POST_SIGNAL): Define macros for TSan annotation functions. (_Sp_atomic::_Atomic_count): Add annotations. --- libstdc++-v3/include/bits/shared_ptr_atomic.h | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/libstdc++-v3/include/bits/shared_ptr_atomic.h b/libstdc++-v3/include/bits/shared_ptr_atomic.h index d4bd712fc7d..4580807f42c 100644 --- a/libstdc++-v3/include/bits/shared_ptr_atomic.h +++ b/libstdc++-v3/include/bits/shared_ptr_atomic.h @@ -32,6 +32,30 @@ #include +#if defined _GLIBCXX_TSAN && __has_include() +#include +#define _GLIBCXX_TSAN_MUTEX_DESTROY(X) \ + __tsan_mutex_destroy(X, __tsan_mutex_not_static) +#define _GLIBCXX_TSAN_MUTEX_PRE_LOCK(X) \ + __tsan_mutex_pre_lock(X, __tsan_mutex_not_static) +#define _GLIBCXX_TSAN_MUTEX_POST_LOCK(X) \ + __tsan_mutex_post_lock(X, __tsan_mutex_not_static, 0) +#define _GLIBCXX_TSAN_MUTEX_PRE_UNLOCK(X) \ + __tsan_mutex_pre_unlock(X, __tsan_mutex_not_static) +#define _GLIBCXX_TSAN_MUTEX_POST_UNLOCK(X) \ + __tsan_mutex_post_unlock(X, __tsan_mutex_not_static) +#define _GLIBCXX_TSAN_MUTEX_PRE_SIGNAL(X) __tsan_mutex_pre_signal(X, 0) +#define _GLIBCXX_TSAN_MUTEX_POST_SIGNAL(X) __tsan_mutex_post_signal(X, 0) +#else +#define _GLIBCXX_TSAN_MUTEX_DESTROY(X) +#define _GLIBCXX_TSAN_MUTEX_PRE_LOCK(X) +#define _GLIBCXX_TSAN_MUTEX_POST_LOCK(X) +#define _GLIBCXX_TSAN_MUTEX_PRE_UNLOCK(X) +#define _GLIBCXX_TSAN_MUTEX_POST_UNLOCK(X) +#define _GLIBCXX_TSAN_MUTEX_PRE_SIGNAL(X) +#define _GLIBCXX_TSAN_MUTEX_POST_SIGNAL(X) +#endif + namespace std _GLIBCXX_VISIBILITY(default) { _GLIBCXX_BEGIN_NAMESPACE_VERSION @@ -377,6 +401,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION ~_Atomic_count() { auto __val = _M_val.load(memory_order_relaxed); + _GLIBCXX_TSAN_MUTEX_DESTROY(&_M_val); __glibcxx_assert(!(__val & _S_lock_bit)); if (auto __pi = reinterpret_cast(__val)) { @@ -406,6 +431,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION __current = _M_val.load(memory_order_relaxed); } + _GLIBCXX_TSAN_MUTEX_PRE_LOCK(&_M_val); + while (!_M_val.compare_exchange_strong(__current, __current | _S_lock_bit, __o, @@ -416,6 +443,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION #endif __current = __current & ~_S_lock_bit; } + _GLIBCXX_TSAN_MUTEX_POST_LOCK(&_M_val); return reinterpret_cast(__current); } @@ -423,7 +451,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION void unlock(memory_order __o) const noexcept { + _GLIBCXX_TSAN_MUTEX_PRE_UNLOCK(&_M_val); _M_val.fetch_sub(1, __o); + _GLIBCXX_TSAN_MUTEX_POST_UNLOCK(&_M_val); } // Swaps the values of *this and __c, and unlocks *this. @@ -434,7 +464,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION if (__o != memory_order_seq_cst) __o = memory_order_release; auto __x = reinterpret_cast(__c._M_pi); + _GLIBCXX_TSAN_MUTEX_PRE_UNLOCK(&_M_val); __x = _M_val.exchange(__x, __o); + _GLIBCXX_TSAN_MUTEX_POST_UNLOCK(&_M_val); __c._M_pi = reinterpret_cast(__x & ~_S_lock_bit); } @@ -443,20 +475,26 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION void _M_wait_unlock(memory_order __o) const noexcept { + _GLIBCXX_TSAN_MUTEX_PRE_UNLOCK(&_M_val); auto __v = _M_val.fetch_sub(1, memory_order_relaxed); + _GLIBCXX_TSAN_MUTEX_POST_UNLOCK(&_M_val); _M_val.wait(__v & ~_S_lock_bit, __o); } void notify_one() noexcept { + _GLIBCXX_TSAN_MUTEX_PRE_SIGNAL(&_M_val); _M_val.notify_one(); + _GLIBCXX_TSAN_MUTEX_POST_SIGNAL(&_M_val); } void notify_all() noexcept { + _GLIBCXX_TSAN_MUTEX_PRE_SIGNAL(&_M_val); _M_val.notify_all(); + _GLIBCXX_TSAN_MUTEX_POST_SIGNAL(&_M_val); } #endif