Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Sun, 9 Feb 2020 20:06:20 -0800
From:   Andrew Morton <akpm@linux-foundation.org>
To:     Qian Cai <cai@lca.pw>
Cc:     Matthew Wilcox <willy@infradead.org>,
        Marco Elver <elver@google.com>, jhubbard@nvidia.com,
        ira.weiny@intel.com, dan.j.williams@intel.com, jack@suse.cz,
        linux-mm@kvack.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH -next v2] mm: mark an intentional data race in
 page_zonenum
Message-Id: <20200209200620.883ad431b01bcd38939ff5b4@linux-foundation.org>
In-Reply-To: <2B333FA6-AB17-4169-B9EE-9355FF9C42A4@lca.pw>
References: <20200209182008.008c06f1cf4347a95f9de0a5@linux-foundation.org>
        <2B333FA6-AB17-4169-B9EE-9355FF9C42A4@lca.pw>
Mime-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Sun, 9 Feb 2020 21:41:56 -0500 Qian Cai <cai@lca.pw> wrote:

> 
> 
> > On Feb 9, 2020, at 9:20 PM, Andrew Morton <akpm@linux-foundation.org> wrote:
> > 
> > Using data_race() here seems misleading - there is no race, but we're
> > using data_race() to suppress a false positive warning from KCSAN, yes?
> 
> It is a data race in the sense of compilers, i.e., KCSAN is a compiler instrumentation, so here the load and store are both in word-size, but code here is only interested in 3 bits which are never changed. Thus, it is a harmless data race.
> 
> Marco also mentioned,
> 
> “Various options were considered, and based on feedback from Linus,
> decided 'data_race(..)' is the best option:”
> 
> lore.kernel.org/linux-fsdevel/CAHk-=wg5CkOEF8DTez1Qu0XTEFw_oHhxN98bDnFqbY7HL5AB2g@mail.gmail.com/
> 
> Paul also said,
> 
> ”People will get used to the name more quickly than they will get used
> to typing the extra seven characters.  Here is the current comment header:
> 
> /*
>  * data_race(): macro to document that accesses in an expression may conflict with
>  * other concurrent accesses resulting in data races, but the resulting
>  * behaviour is deemed safe regardless.
>  *
>  * This macro *does not* affect normal code generation, but is a hint to tooling
>  * that data races here should be ignored.
>  */
> 
> I will be converting this to docbook form.
> 
> In addition, in the KCSAN documentation:
> 
> * KCSAN understands the ``data_race(expr)`` annotation, which tells KCSAN that
>   any data races due to accesses in ``expr`` should be ignored and resulting
>   behaviour when encountering a data race is deemed safe.”

OK.  But I believe page_zonenum() still deserves a comment explaining
that there is no race and explaining why we're using data_race()
anyway.  Otherwise the use of data_race() is simply misleading.