Skip to contentSkip to conversation

locking/atomics: fix and improvement

PATCH Superseded Mark Rutland 2 participants 6 messages Dec 10, 2018 – Dec 12, 2018

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Mark Rutland

author reviewer
#0 lore raw

cover locking/atomics: fix and improvement

Hi Ingo,

I hope that these atomic scripting patches address your concerns with the atomics scripting infrastructure. These are based on the tip locking/core branch, leaving the headers checked-in.

The primary improvement is using a hash to detect when the headers have been erroneously modified, meaning check-atomics.sh takes ~0.15s, which I believe should be palatable.

It also turns out that some people are building without coreutils, so I've picked up Anders' fix for this. Since sha1sum is part of coreutils, the checks are skipped when this isn't present, on the assumption that anyone actually sending patches will have a working coreutils.

Are you happy to pick these up?

Thanks,
Mark.

Anders Roxell (1):
locking/atomics: Change 'fold' to 'grep'

Mark Rutland (1):
locking/atomics: Check atomic headers with sha1sum

 include/asm-generic/atomic-instrumented.h |  1 +
 include/asm-generic/atomic-long.h         |  1 +
 include/linux/atomic-fallback.h           |  1 +
 scripts/atomic/atomic-tbl.sh              |  2 +-
 scripts/atomic/check-atomics.sh           | 26 ++++++++++++++++++++------
 scripts/atomic/gen-atomics.sh             | 20 ++++++++++++++++++++
 6 files changed, 44 insertions(+), 7 deletions(-)
 create mode 100755 scripts/atomic/gen-atomics.sh
Signature · 1 line
2.11.0
author reviewer
#1 lore raw

PATCH 1/2 locking/atomics: Change 'fold' to 'grep'

From: Anders Roxell <[email protected]>

Some distibutions and build systems doesn't include 'fold' from coreutils default.

.../scripts/atomic/atomic-tbl.sh: line 183: fold: command not found

Rework to use 'grep' instead of 'fold' to use a dependency that is already used a lot in the kernel.

---
 scripts/atomic/atomic-tbl.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/atomic/atomic-tbl.sh +1 -1
index 9d6be538a987..81d5c32039dd 100755
@@ -180,7 +180,7 @@ gen_proto_variants()
 #gen_proto(meta, ...)
 gen_proto() {
 	local meta="$1"; shift
-	for m in $(echo "${meta}" | fold -w1); do
+	for m in $(echo "${meta}" | grep -o .); do
 		gen_proto_variants "${m}" "$@"
 	done
 }
Signature · 1 line
2.11.0
Acked-by on v1 1/2
#2 lore raw

Re: [PATCH 1/2] locking/atomics: Change 'fold' to 'grep'

Quoted 24 lines · Mark Rutland

From: Anders Roxell <[email protected]>

Some distibutions and build systems doesn't include 'fold' from coreutils default.

.../scripts/atomic/atomic-tbl.sh: line 183: fold: command not found

Rework to use 'grep' instead of 'fold' to use a dependency that is already used a lot in the kernel.

---
 scripts/atomic/atomic-tbl.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/atomic/atomic-tbl.sh +0 -0
index 9d6be538a987..81d5c32039dd 100755

scripts/atomic/atomic-tbl.sh gen_proto_variants() · line 186

Quoted 8 lines
scripts/atomic/atomic-tbl.sh +1 -1
@@ -180,7 +180,7 @@ gen_proto_variants()
 #gen_proto(meta, ...)
 gen_proto() {
 	local meta="$1"; shift
-	for m in $(echo "${meta}" | fold -w1); do
+	for m in $(echo "${meta}" | grep -o .); do
 		gen_proto_variants "${m}" "$@"
 	done
 }

Will

author reviewer
#3 lore raw

PATCH 2/2 locking/atomics: Check atomic headers with sha1sum

In reply to Mark Rutland

We currently check the atomic headers at build-time to ensure they haven't been modified directly, and these checks require regenerating the headers in full. As this takes a few seconds, even when parallelized, this is too slow to run for every kernel build.

Instead, we can generate a hash of each header as we generate them, which we can cheaply check at build time (~0.16s for all headers).

This patch does so, updating headers with their hashes using the new gen-atomics.sh script. As some users apparently build the kernel wihout coreutils, lacking sha1sum, the checks are skipped in this case. Presumably, most developers have a working coreutils installation.

Cc Andrew Morton <[email protected]>
Cc Boqun Feng <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Peter Zijlstra <[email protected]>
Cc Will Deacon <[email protected]>
---
 include/asm-generic/atomic-instrumented.h |  1 +
 include/asm-generic/atomic-long.h         |  1 +
 include/linux/atomic-fallback.h           |  1 +
 scripts/atomic/check-atomics.sh           | 26 ++++++++++++++++++++------
 scripts/atomic/gen-atomics.sh             | 20 ++++++++++++++++++++
 5 files changed, 43 insertions(+), 6 deletions(-)
 create mode 100755 scripts/atomic/gen-atomics.sh
include/asm-generic/atomic-instrumented.h +1 -0
index b8f5b35216e1..e8730c6b9fe2 100644
@@ -1785,3 +1785,4 @@ atomic64_dec_if_positive(atomic64_t *v)
 })
 
 #endif /* _ASM_GENERIC_ATOMIC_INSTRUMENTED_H */
+// b29b625d5de9280f680e42c7be859b55b15e5f6a
include/asm-generic/atomic-long.h +1 -0
index a833d385a70b..881c7e27af28 100644
@@ -1010,3 +1010,4 @@ atomic_long_dec_if_positive(atomic_long_t *v)
 
 #endif /* CONFIG_64BIT */
 #endif /* _ASM_GENERIC_ATOMIC_LONG_H */
+// 77558968132ce4f911ad53f6f52ce423006f6268
include/linux/atomic-fallback.h +1 -0
index 1c02c0112fbb..a7d240e465c0 100644
@@ -2292,3 +2292,4 @@ atomic64_dec_if_positive(atomic64_t *v)
 #define atomic64_cond_read_relaxed(v, c) smp_cond_load_relaxed(&(v)->counter, (c))
 
 #endif /* _LINUX_ATOMIC_FALLBACK_H */
+// 25de4a2804d70f57e994fe3b419148658bb5378a
scripts/atomic/check-atomics.sh +20 -6
index c30101cddf2d..cfa0c2f71c84 100755
@@ -7,13 +7,27 @@ ATOMICDIR=$(dirname $0)
 ATOMICTBL=${ATOMICDIR}/atomics.tbl
 LINUXDIR=${ATOMICDIR}/../..
 
+echo '' | sha1sum - > /dev/null 2>&1
+if [ $? -ne 0 ]; then
+	printf "sha1sum not available, skipping atomic header checks.\n"
+	exit 0
+fi
+
 cat <<EOF |
-gen-atomic-instrumented.sh      asm-generic/atomic-instrumented.h
-gen-atomic-long.sh              asm-generic/atomic-long.h
-gen-atomic-fallback.sh          linux/atomic-fallback.h
+asm-generic/atomic-instrumented.h
+asm-generic/atomic-long.h
+linux/atomic-fallback.h
 EOF
-while read script header; do
-	if ! (${ATOMICDIR}/${script} ${ATOMICTBL} | diff - ${LINUXDIR}/include/${header} > /dev/null); then
-		printf "warning: include/${header} is out-of-date.\n"
+while read header; do
+	OLDSUM="$(tail -n 1 ${LINUXDIR}/include/${header})"
+	OLDSUM="${OLDSUM#// }"
+
+	NEWSUM="$(head -n -1 ${LINUXDIR}/include/${header} | sha1sum)"
+	NEWSUM="${NEWSUM%% *}"
+
+	if [ "${OLDSUM}" != "${NEWSUM}" ]; then
+		printf "warning: generated include/${header} has been modified.\n"
 	fi
 done
+
+exit 0
scripts/atomic/gen-atomics.sh new file +20 -0
new file mode 100755
index 000000000000..27400b0cd732
@@ -0,0 +1,20 @@
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0
+#
+# Generate atomic headers
+
+ATOMICDIR=$(dirname $0)
+ATOMICTBL=${ATOMICDIR}/atomics.tbl
+LINUXDIR=${ATOMICDIR}/../..
+
+cat <<EOF |
+gen-atomic-instrumented.sh      asm-generic/atomic-instrumented.h
+gen-atomic-long.sh              asm-generic/atomic-long.h
+gen-atomic-fallback.sh          linux/atomic-fallback.h
+EOF
+while read script header; do
+	${ATOMICDIR}/${script} ${ATOMICTBL} > ${LINUXDIR}/include/${header}
+	HASH="$(sha1sum ${LINUXDIR}/include/${header})"
+	HASH="${HASH%% *}"
+	printf "// %s\n" "${HASH}" >> ${LINUXDIR}/include/${header}
+done
Signature · 1 line
2.11.0
Acked-by on v1 2/2
#4 lore raw

Re: [PATCH 2/2] locking/atomics: Check atomic headers with sha1sum

Quoted 76 lines · Mark Rutland

We currently check the atomic headers at build-time to ensure they haven't been modified directly, and these checks require regenerating the headers in full. As this takes a few seconds, even when parallelized, this is too slow to run for every kernel build.

Instead, we can generate a hash of each header as we generate them, which we can cheaply check at build time (~0.16s for all headers).

This patch does so, updating headers with their hashes using the new gen-atomics.sh script. As some users apparently build the kernel wihout coreutils, lacking sha1sum, the checks are skipped in this case. Presumably, most developers have a working coreutils installation.

Cc Andrew Morton <[email protected]>
Cc Boqun Feng <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Peter Zijlstra <[email protected]>
Cc Will Deacon <[email protected]>
---
 include/asm-generic/atomic-instrumented.h |  1 +
 include/asm-generic/atomic-long.h         |  1 +
 include/linux/atomic-fallback.h           |  1 +
 scripts/atomic/check-atomics.sh           | 26 ++++++++++++++++++++------
 scripts/atomic/gen-atomics.sh             | 20 ++++++++++++++++++++
 5 files changed, 43 insertions(+), 6 deletions(-)
 create mode 100755 scripts/atomic/gen-atomics.sh
include/asm-generic/atomic-instrumented.h +1 -0
index b8f5b35216e1..e8730c6b9fe2 100644
@@ -1785,3 +1785,4 @@ atomic64_dec_if_positive(atomic64_t *v)
 })
 
 #endif /* _ASM_GENERIC_ATOMIC_INSTRUMENTED_H */
+// b29b625d5de9280f680e42c7be859b55b15e5f6a
include/asm-generic/atomic-long.h +1 -0
index a833d385a70b..881c7e27af28 100644
@@ -1010,3 +1010,4 @@ atomic_long_dec_if_positive(atomic_long_t *v)
 
 #endif /* CONFIG_64BIT */
 #endif /* _ASM_GENERIC_ATOMIC_LONG_H */
+// 77558968132ce4f911ad53f6f52ce423006f6268
include/linux/atomic-fallback.h +1 -0
index 1c02c0112fbb..a7d240e465c0 100644
@@ -2292,3 +2292,4 @@ atomic64_dec_if_positive(atomic64_t *v)
 #define atomic64_cond_read_relaxed(v, c) smp_cond_load_relaxed(&(v)->counter, (c))
 
 #endif /* _LINUX_ATOMIC_FALLBACK_H */
+// 25de4a2804d70f57e994fe3b419148658bb5378a
scripts/atomic/check-atomics.sh +9 -3
index c30101cddf2d..cfa0c2f71c84 100755
@@ -7,13 +7,27 @@ ATOMICDIR=$(dirname $0)
 ATOMICTBL=${ATOMICDIR}/atomics.tbl
 LINUXDIR=${ATOMICDIR}/../..
 
+echo '' | sha1sum - > /dev/null 2>&1
+if [ $? -ne 0 ]; then
+	printf "sha1sum not available, skipping atomic header checks.\n"
+	exit 0
+fi
+
 cat <<EOF |
-gen-atomic-instrumented.sh      asm-generic/atomic-instrumented.h
-gen-atomic-long.sh              asm-generic/atomic-long.h
-gen-atomic-fallback.sh          linux/atomic-fallback.h
+asm-generic/atomic-instrumented.h
+asm-generic/atomic-long.h
+linux/atomic-fallback.h

scripts/atomic/check-atomics.sh ATOMICDIR=$(dirname $0) · line 26

Quoted 10 lines
scripts/atomic/check-atomics.sh +6 -3
 EOF
-while read script header; do
-	if ! (${ATOMICDIR}/${script} ${ATOMICTBL} | diff - ${LINUXDIR}/include/${header} > /dev/null); then
-		printf "warning: include/${header} is out-of-date.\n"
+while read header; do
+	OLDSUM="$(tail -n 1 ${LINUXDIR}/include/${header})"
+	OLDSUM="${OLDSUM#// }"
+
+	NEWSUM="$(head -n -1 ${LINUXDIR}/include/${header} | sha1sum)"
+	NEWSUM="${NEWSUM%% *}"

Here we're relying on head and tail being available, but it looks like they're also part of coreutils, so that should be fine.

Quoted 23 lines
scripts/atomic/check-atomics.sh +5 -0
+
+	if [ "${OLDSUM}" != "${NEWSUM}" ]; then
+		printf "warning: generated include/${header} has been modified.\n"
 	fi
 done
+
+exit 0
scripts/atomic/gen-atomics.sh new file +10 -0
new file mode 100755
index 000000000000..27400b0cd732
@@ -0,0 +1,20 @@
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0
+#
+# Generate atomic headers
+
+ATOMICDIR=$(dirname $0)
+ATOMICTBL=${ATOMICDIR}/atomics.tbl
+LINUXDIR=${ATOMICDIR}/../..
+
+cat <<EOF |

scripts/atomic/gen-atomics.sh line 20

Quoted 10 lines
scripts/atomic/gen-atomics.sh new file +10 -0
+gen-atomic-instrumented.sh      asm-generic/atomic-instrumented.h
+gen-atomic-long.sh              asm-generic/atomic-long.h
+gen-atomic-fallback.sh          linux/atomic-fallback.h
+EOF
+while read script header; do
+	${ATOMICDIR}/${script} ${ATOMICTBL} > ${LINUXDIR}/include/${header}
+	HASH="$(sha1sum ${LINUXDIR}/include/${header})"
+	HASH="${HASH%% *}"
+	printf "// %s\n" "${HASH}" >> ${LINUXDIR}/include/${header}
+done

Thanks, this looks sensible to me:

Will

author reviewer
#5 lore raw
In reply to Mark Rutland
Quoted 9 lines · Mark Rutland

Hi Ingo,

I hope that these atomic scripting patches address your concerns with the atomics scripting infrastructure. These are based on the tip locking/core branch, leaving the headers checked-in.

The primary improvement is using a hash to detect when the headers have been erroneously modified, meaning check-atomics.sh takes ~0.15s, which I believe should be palatable.

As a heads-up, it looks like my prior attempt [1] is in today's linux-next (next-20181212), via Andrew's tree.

Ingo, could you please let us know what you'd prefer? Are you happy to take this version, and should Andrew drop that patch?

Thanks,
Mark.

[1] https://lkml.kernel.org/r/[email protected]