Documentation/litmus-tests: Introduce atomic directory
authorBoqun Feng <boqun.feng@gmail.com>
Thu, 26 Mar 2020 02:40:20 +0000 (10:40 +0800)
committerPaul E. McKenney <paulmck@kernel.org>
Mon, 29 Jun 2020 19:05:18 +0000 (12:05 -0700)
commitefff6150209694a78c8af8c2a7557af682086220
treeb29c06b3c2c8f2f2ddd2141e26065ff5253b5bae
parent4a9cc65f7a715ba1f4f58529f7bf6f1548d8701f
Documentation/litmus-tests: Introduce atomic directory

Although we have atomic_t.txt and its friends to describe the semantics
of atomic APIs and lib/atomic64_test.c for build testing and testing in
UP mode, the tests for our atomic APIs in real SMP mode are still
missing. Since now we have the LKMM tool in kernel and litmus tests can
be used to generate kernel modules for testing purpose with "klitmus" (a
tool from the LKMM toolset), it makes sense to put a few typical litmus
tests into kernel so that

1) they are the examples to describe the conceptual mode of the
semantics of atomic APIs, and

2) they can be used to generate kernel test modules for anyone
who is interested to test the atomic APIs implementation (in
most cases, is the one who implements the APIs for a new arch)

Therefore, introduce the atomic directory for this purpose. The
directory is maintained by the LKMM group to make sure the litmus tests
are always aligned with our memory model.

Acked-by: Alan Stern <stern@rowland.harvard.edu>
Acked-by: Andrea Parri <parri.andrea@gmail.com>
Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
Signed-off-by: Boqun Feng <boqun.feng@gmail.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Documentation/litmus-tests/atomic/README [new file with mode: 0644]