From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.3 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id CED68C11D3D for ; Thu, 27 Feb 2020 17:43:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id A0680246A5 for ; Thu, 27 Feb 2020 17:43:18 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="TSB4IyoU" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730345AbgB0RnO (ORCPT ); Thu, 27 Feb 2020 12:43:14 -0500 Received: from mail-wr1-f66.google.com ([209.85.221.66]:33920 "EHLO mail-wr1-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729548AbgB0RnO (ORCPT ); Thu, 27 Feb 2020 12:43:14 -0500 Received: by mail-wr1-f66.google.com with SMTP id z15so4539625wrl.1; Thu, 27 Feb 2020 09:43:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=BMqi7wNVy74Epfw3/CXCjxssZh8rP45fbaF8FqplbtM=; b=TSB4IyoUJM+7SNxWfQHNWp8SqiXLs/3NwcS1pRcGPyEE+D7ZuwgScsLS7CtdvbMVdO VIxaPM83TNRCvMEMOXMAQ+BlQ6eapIXMfBKGpy7VEZyGYbykb6iVJfF0Z2DIUqMSTyFK HKOxhaOABj9VHS1ug6APUjjZuE8ZUWftGDf/WNk9nMEIEVInQBJgQ2RRCoarqsoZbHrs +caPNlVvfTCXQTeRuxQUVmZEVmCH6ISoqqH3h5Bcp5oVWwzZzAbn4RM49ylcI5hKHC2e NZ9gsxnem8Q6PWNKTPVqxB3AdJDeYmj6CQujbXfVlRMncQ0LKHG8tyM1DjoUCRuQp5+Y t8cQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=BMqi7wNVy74Epfw3/CXCjxssZh8rP45fbaF8FqplbtM=; b=JDwPgJMACTlh9kVll0OvtymAlK1AmXk9zn+uslEdH6TcbsAoZgDII7chqyCqBQuBPy LodSS3PD1NCsQAdAXKNbRHuiO1cXUWenjXnEF//Uc/wh3j/fBafe8ek3/3yDwXrsuqJ4 Ee8qwbmq8KNcEF5JLPqqyPUGyC8MGCwvxFP1sJfsmboYr+x6htKpWTl1wRaoGbeU4Pqf QaUwLropsf/voOjRGPNuSokX7ZJhmEQUeDXlLsQlbQD4++HgDT23Zg6DAvMTSEDBHtw/ bHWUm4IAaAF+/C2q7DUTY3bEZ7RJfAjOADWKxzvrOOdGGP3T+YKCHUsMrFLWbPhLuRGl F34Q== X-Gm-Message-State: APjAAAW3vZlJ3ylPauKyEc+QgkYcoL9xVI/jN+O5jCTuFsarw13JU1PK mi/cQVIqeUe20oHMigBYj8E= X-Google-Smtp-Source: APXvYqxn4Muee4YpYbF0JI/llZZZN3gjxROfWrgHUwhT9fQ/79cP1fhPKjJ0y9iFYP2aqzwY+Mcn5Q== X-Received: by 2002:a5d:56ca:: with SMTP id m10mr6155698wrw.313.1582825391327; Thu, 27 Feb 2020 09:43:11 -0800 (PST) Received: from andrea (ip-213-220-200-127.net.upcbroadband.cz. [213.220.200.127]) by smtp.gmail.com with ESMTPSA id d13sm9014648wrc.64.2020.02.27.09.43.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 27 Feb 2020 09:43:09 -0800 (PST) Date: Thu, 27 Feb 2020 18:43:04 +0100 From: Andrea Parri To: Boqun Feng Cc: linux-kernel@vger.kernel.org, Alan Stern , Will Deacon , Peter Zijlstra , Nicholas Piggin , David Howells , Jade Alglave , Luc Maranget , "Paul E. McKenney" , Akira Yokosawa , Daniel Lustig , Jonathan Corbet , Mauro Carvalho Chehab , "David S. Miller" , Rob Herring , Greg Kroah-Hartman , Jonathan Cameron , linux-arch@vger.kernel.org, linux-doc@vger.kernel.org Subject: Re: [PATCH v3 4/5] Documentation/locking/atomic: Add a litmus test for atomic_set() Message-ID: <20200227174304.GA11666@andrea> References: <20200227004049.6853-1-boqun.feng@gmail.com> <20200227004049.6853-5-boqun.feng@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20200227004049.6853-5-boqun.feng@gmail.com> User-Agent: Mutt/1.10.1 (2018-07-13) Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Thu, Feb 27, 2020 at 08:40:48AM +0800, Boqun Feng wrote: > We already use a litmus test in atomic_t.txt to describe the behavior of > an atomic_set() with the an atomic RMW, so add it into atomic-tests > directory to make it easily accessible for anyone who cares about the > semantics of our atomic APIs. > > Additionally, change the sentences describing the test in atomic_t.txt > with better wording. > > Signed-off-by: Boqun Feng > --- > ...c-RMW-ops-are-atomic-WRT-atomic_set.litmus | 24 +++++++++++++++++++ > Documentation/atomic-tests/README | 7 ++++++ > Documentation/atomic_t.txt | 6 ++--- > 3 files changed, 34 insertions(+), 3 deletions(-) > create mode 100644 Documentation/atomic-tests/Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus > > diff --git a/Documentation/atomic-tests/Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus b/Documentation/atomic-tests/Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus > new file mode 100644 > index 000000000000..5dd7f04e504a > --- /dev/null > +++ b/Documentation/atomic-tests/Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus > @@ -0,0 +1,24 @@ > +C Atomic-set-observable-to-RMW Nit: s/Atomic-set-observable-to-RMW/Atomic-RMW-ops-are-atomic-WRT-atomic_set > + > +(* > + * Result: Never > + * > + * Test that atomic_set() cannot break the atomicity of atomic RMWs. > + *) > + > +{ > + atomic_t v = ATOMIC_INIT(1); > +} > + > +P0(atomic_t *v) > +{ > + (void)atomic_add_unless(v,1,0); Nit: spaces after commas > +} > + > +P1(atomic_t *v) > +{ > + atomic_set(v, 0); > +} > + > +exists > +(v=2) > diff --git a/Documentation/atomic-tests/README b/Documentation/atomic-tests/README > index ae61201a4271..a1b72410b539 100644 > --- a/Documentation/atomic-tests/README > +++ b/Documentation/atomic-tests/README > @@ -2,3 +2,10 @@ This directory contains litmus tests that are typical to describe the semantics > of our atomic APIs. For more information about how to "run" a litmus test or > how to generate a kernel test module based on a litmus test, please see > tools/memory-model/README. > + > +============ > +LITMUS TESTS > +============ > + > +Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus > + Test that atomic_set() cannot break the atomicity of atomic RMWs. > diff --git a/Documentation/atomic_t.txt b/Documentation/atomic_t.txt > index ceb85ada378e..67d1d99f8589 100644 > --- a/Documentation/atomic_t.txt > +++ b/Documentation/atomic_t.txt > @@ -85,10 +85,10 @@ smp_store_release() respectively. Therefore, if you find yourself only using > the Non-RMW operations of atomic_t, you do not in fact need atomic_t at all > and are doing it wrong. > > -A subtle detail of atomic_set{}() is that it should be observable to the RMW > -ops. That is: > +A note for the implementation of atomic_set{}() is that it must not break the > +atomicity of the RMW ops. That is: > > - C atomic-set > + C Atomic-RMW-ops-are-atomic-WRT-atomic_set > > { > atomic_t v = ATOMIC_INIT(1); > -- > 2.25.0 >