Skip to content

Commit d075a78

Browse files
akiykspaulmckrcu
authored andcommitted
tools/memory-model/README: Expand dependency of klitmus7
klitmus7 is independent of the memory model but depends on the build-target kernel release. It occasionally lost compatibility due to kernel API changes [1, 2, 3]. It was remedied in a backwards-compatible manner respectively [4, 5, 6]. Reflect this fact in README. [1]: b899a85 ("compiler.h: Remove ACCESS_ONCE()") [2]: 0bb95f8 ("Makefile: Globally enable VLA warning") [3]: d56c0d4 ("proc: decouple proc from VFS with "struct proc_ops"") [4]: herd/herdtools7@e87d7f9287d1 ("klitmus: Use WRITE_ONCE and READ_ONCE in place of deprecated ACCESS_ONCE") [5]: herd/herdtools7@a0cbb10d02be ("klitmus: Avoid variable length array") [6]: herd/herdtools7@46b9412d3a58 ("klitmus: Linux kernel v5.6.x compat") NOTE: [5] was ahead of herdtools7 7.53, which did not make an official release. Code generated by klitmus7 without [5] can still be built targeting Linux 4.20--5.5 if you don't care VLA warnings. Acked-by: Andrea Parri <[email protected]> Signed-off-by: Akira Yokosawa <[email protected]> Signed-off-by: Paul E. McKenney <[email protected]>
1 parent c425fb5 commit d075a78

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

tools/memory-model/README

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,34 @@ downloaded separately:
2828
See "herdtools7/INSTALL.md" for installation instructions.
2929

3030
Note that although these tools usually provide backwards compatibility,
31-
this is not absolutely guaranteed. Therefore, if a later version does
32-
not work, please try using the exact version called out above.
31+
this is not absolutely guaranteed.
32+
33+
For example, a future version of herd7 might not work with the model
34+
in this release. A compatible model will likely be made available in
35+
a later release of Linux kernel.
36+
37+
If you absolutely need to run the model in this particular release,
38+
please try using the exact version called out above.
39+
40+
klitmus7 is independent of the model provided here. It has its own
41+
dependency on a target kernel release where converted code is built
42+
and executed. Any change in kernel APIs essential to klitmus7 will
43+
necessitate an upgrade of klitmus7.
44+
45+
If you find any compatibility issues in klitmus7, please inform the
46+
memory model maintainers.
47+
48+
klitmus7 Compatibility Table
49+
----------------------------
50+
51+
============ ==========
52+
target Linux herdtools7
53+
------------ ----------
54+
-- 4.18 7.48 --
55+
4.15 -- 4.19 7.49 --
56+
4.20 -- 5.5 7.54 --
57+
5.6 -- HEAD
58+
============ ==========
3359

3460

3561
==================

0 commit comments

Comments
 (0)