From ace9bad4df2684f31cbfe8c4ce7a0f5d92b27925 Mon Sep 17 00:00:00 2001 From: Mark Rutland Date: Tue, 4 Sep 2018 11:48:25 +0100 Subject: locking/atomics: Add common header generation files To minimize repetition, to allow for future rework, and to ensure regularity of the various atomic APIs, we'd like to automatically generate (the bulk of) a number of headers related to atomics. This patch adds the infrastructure to do so, leaving actual conversion of headers to subsequent patches. This infrastructure consists of: * atomics.tbl - a table describing the functions in the atomics API, with names, prototypes, and metadata describing the variants that exist (e.g fetch/return, acquire/release/relaxed). Note that the return type is dependent on the particular variant. * atomic-tbl.sh - a library of routines useful for dealing with atomics.tbl (e.g. querying which variants exist, or generating argument/parameter lists for a given function variant). * gen-atomic-fallback.sh - a script which generates a header of fallbacks, covering cases where architecture omit certain functions (e.g. omitting relaxed variants). * gen-atomic-long.sh - a script which generates wrappers providing the atomic_long API atomic of the relevant atomic or atomic64 API, ensuring the APIs are consistent. * gen-atomic-instrumented.sh - a script which generates atomic* wrappers atop of arch_atomic* functions, with automatically generated KASAN instrumentation. * fallbacks/* - a set of fallback implementations for atomics, which should be used when no implementation of a given atomic is provided. These are used by gen-atomic-fallback.sh to generate fallbacks, and these are also used by other scripts to determine the set of optional atomics (as required to generate preprocessor guards correctly). Fallbacks may use the following variables: ${atomic} atomic prefix: atomic/atomic64/atomic_long, which can be used to derive the atomic type, and to prefix functions ${int} integer type: int/s64/long ${pfx} variant prefix, e.g. fetch_ ${name} base function name, e.g. add ${sfx} variant suffix, e.g. _return ${order} order suffix, e.g. _relaxed ${atomicname} full name, e.g. atomic64_fetch_add_relaxed ${ret} return type of the function, e.g. void ${retstmt} a return statement (with a trailing space), unless the variant returns void ${params} parameter list for the function declaration, e.g. "int i, atomic_t *v" ${args} argument list for invoking the function, e.g. "i, v" ... for clarity, ${ret}, ${retstmt}, ${params}, and ${args} are open-coded for fallbacks where these do not vary, or are critical to understanding the logic of the fallback. The MAINTAINERS entry for the atomic infrastructure is updated to cover the new scripts. There should be no functional change as a result of this patch. Signed-off-by: Mark Rutland Signed-off-by: Peter Zijlstra (Intel) Cc: linux-arm-kernel@lists.infradead.org Cc: catalin.marinas@arm.com Cc: Will Deacon Cc: linuxdrivers@attotech.com Cc: dvyukov@google.com Cc: Boqun Feng Cc: arnd@arndb.de Cc: aryabinin@virtuozzo.com Cc: glider@google.com Link: http://lkml.kernel.org/r/20180904104830.2975-2-mark.rutland@arm.com Signed-off-by: Ingo Molnar --- scripts/atomic/gen-atomic-instrumented.sh | 182 ++++++++++++++++++++++++++++++ 1 file changed, 182 insertions(+) create mode 100644 scripts/atomic/gen-atomic-instrumented.sh (limited to 'scripts/atomic/gen-atomic-instrumented.sh') diff --git a/scripts/atomic/gen-atomic-instrumented.sh b/scripts/atomic/gen-atomic-instrumented.sh new file mode 100644 index 000000000000..e09812372b17 --- /dev/null +++ b/scripts/atomic/gen-atomic-instrumented.sh @@ -0,0 +1,182 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 + +ATOMICDIR=$(dirname $0) + +. ${ATOMICDIR}/atomic-tbl.sh + +#gen_param_check(arg) +gen_param_check() +{ + local arg="$1"; shift + local type="${arg%%:*}" + local name="$(gen_param_name "${arg}")" + local rw="write" + + case "${type#c}" in + i) return;; + esac + + # We don't write to constant parameters + [ ${type#c} != ${type} ] && rw="read" + + printf "\tkasan_check_${rw}(${name}, sizeof(*${name}));\n" +} + +#gen_param_check(arg...) +gen_params_checks() +{ + while [ "$#" -gt 0 ]; do + gen_param_check "$1" + shift; + done +} + +# gen_guard(meta, atomic, pfx, name, sfx, order) +gen_guard() +{ + local meta="$1"; shift + local atomic="$1"; shift + local pfx="$1"; shift + local name="$1"; shift + local sfx="$1"; shift + local order="$1"; shift + + local atomicname="arch_${atomic}_${pfx}${name}${sfx}${order}" + + local template="$(find_fallback_template "${pfx}" "${name}" "${sfx}" "${order}")" + + # We definitely need a preprocessor symbol for this atomic if it is an + # ordering variant, or if there's a generic fallback. + if [ ! -z "${order}" ] || [ ! -z "${template}" ]; then + printf "defined(${atomicname})" + return + fi + + # If this is a base variant, but a relaxed variant *may* exist, then we + # only have a preprocessor symbol if the relaxed variant isn't defined + if meta_has_relaxed "${meta}"; then + printf "!defined(${atomicname}_relaxed) || defined(${atomicname})" + fi +} + +#gen_proto_order_variant(meta, pfx, name, sfx, order, atomic, int, arg...) +gen_proto_order_variant() +{ + local meta="$1"; shift + local pfx="$1"; shift + local name="$1"; shift + local sfx="$1"; shift + local order="$1"; shift + local atomic="$1"; shift + local int="$1"; shift + + local atomicname="${atomic}_${pfx}${name}${sfx}${order}" + + local guard="$(gen_guard "${meta}" "${atomic}" "${pfx}" "${name}" "${sfx}" "${order}")" + + local ret="$(gen_ret_type "${meta}" "${int}")" + local params="$(gen_params "${int}" "${atomic}" "$@")" + local checks="$(gen_params_checks "$@")" + local args="$(gen_args "$@")" + local retstmt="$(gen_ret_stmt "${meta}")" + + [ ! -z "${guard}" ] && printf "#if ${guard}\n" + +cat < +#include + +EOF + +grep '^[a-z]' "$1" | while read name meta args; do + gen_proto "${meta}" "${name}" "atomic" "int" ${args} +done + +grep '^[a-z]' "$1" | while read name meta args; do + gen_proto "${meta}" "${name}" "atomic64" "s64" ${args} +done + +for xchg in "xchg" "cmpxchg" "cmpxchg64"; do + for order in "" "_acquire" "_release" "_relaxed"; do + gen_optional_xchg "${xchg}" "${order}" + done +done + +for xchg in "cmpxchg_local" "cmpxchg64_local" "sync_cmpxchg"; do + gen_xchg "${xchg}" "" + printf "\n" +done + +gen_xchg "cmpxchg_double" "2 * " + +printf "\n\n" + +gen_xchg "cmpxchg_double_local" "2 * " + +cat < Date: Thu, 1 Nov 2018 12:44:48 +0100 Subject: locking/atomics: Fix scripts/atomic/ script permissions Mark all these scripts executable. Cc: Mark Rutland Cc: Peter Zijlstra (Intel) Cc: Will Deacon Cc: linux-arm-kernel@lists.infradead.org Cc: Catalin Marinas Cc: linuxdrivers@attotech.com Cc: dvyukov@google.com Cc: boqun.feng@gmail.com Cc: arnd@arndb.de Cc: aryabinin@virtuozzo.com Cc: glider@google.com Cc: linux-kernel@vger.kernel.org Signed-off-by: Ingo Molnar --- scripts/atomic/atomic-tbl.sh | 0 scripts/atomic/atomics.tbl | 0 scripts/atomic/check-atomics.sh | 0 scripts/atomic/fallbacks/acquire | 0 scripts/atomic/fallbacks/add_negative | 0 scripts/atomic/fallbacks/add_unless | 0 scripts/atomic/fallbacks/andnot | 0 scripts/atomic/fallbacks/dec | 0 scripts/atomic/fallbacks/dec_and_test | 0 scripts/atomic/fallbacks/dec_if_positive | 0 scripts/atomic/fallbacks/dec_unless_positive | 0 scripts/atomic/fallbacks/fence | 0 scripts/atomic/fallbacks/fetch_add_unless | 0 scripts/atomic/fallbacks/inc | 0 scripts/atomic/fallbacks/inc_and_test | 0 scripts/atomic/fallbacks/inc_not_zero | 0 scripts/atomic/fallbacks/inc_unless_negative | 0 scripts/atomic/fallbacks/read_acquire | 0 scripts/atomic/fallbacks/release | 0 scripts/atomic/fallbacks/set_release | 0 scripts/atomic/fallbacks/sub_and_test | 0 scripts/atomic/fallbacks/try_cmpxchg | 0 scripts/atomic/gen-atomic-fallback.sh | 0 scripts/atomic/gen-atomic-instrumented.sh | 0 scripts/atomic/gen-atomic-long.sh | 0 25 files changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 scripts/atomic/atomic-tbl.sh mode change 100644 => 100755 scripts/atomic/atomics.tbl mode change 100644 => 100755 scripts/atomic/check-atomics.sh mode change 100644 => 100755 scripts/atomic/fallbacks/acquire mode change 100644 => 100755 scripts/atomic/fallbacks/add_negative mode change 100644 => 100755 scripts/atomic/fallbacks/add_unless mode change 100644 => 100755 scripts/atomic/fallbacks/andnot mode change 100644 => 100755 scripts/atomic/fallbacks/dec mode change 100644 => 100755 scripts/atomic/fallbacks/dec_and_test mode change 100644 => 100755 scripts/atomic/fallbacks/dec_if_positive mode change 100644 => 100755 scripts/atomic/fallbacks/dec_unless_positive mode change 100644 => 100755 scripts/atomic/fallbacks/fence mode change 100644 => 100755 scripts/atomic/fallbacks/fetch_add_unless mode change 100644 => 100755 scripts/atomic/fallbacks/inc mode change 100644 => 100755 scripts/atomic/fallbacks/inc_and_test mode change 100644 => 100755 scripts/atomic/fallbacks/inc_not_zero mode change 100644 => 100755 scripts/atomic/fallbacks/inc_unless_negative mode change 100644 => 100755 scripts/atomic/fallbacks/read_acquire mode change 100644 => 100755 scripts/atomic/fallbacks/release mode change 100644 => 100755 scripts/atomic/fallbacks/set_release mode change 100644 => 100755 scripts/atomic/fallbacks/sub_and_test mode change 100644 => 100755 scripts/atomic/fallbacks/try_cmpxchg mode change 100644 => 100755 scripts/atomic/gen-atomic-fallback.sh mode change 100644 => 100755 scripts/atomic/gen-atomic-instrumented.sh mode change 100644 => 100755 scripts/atomic/gen-atomic-long.sh (limited to 'scripts/atomic/gen-atomic-instrumented.sh') diff --git a/scripts/atomic/atomic-tbl.sh b/scripts/atomic/atomic-tbl.sh old mode 100644 new mode 100755 diff --git a/scripts/atomic/atomics.tbl b/scripts/atomic/atomics.tbl old mode 100644 new mode 100755 diff --git a/scripts/atomic/check-atomics.sh b/scripts/atomic/check-atomics.sh old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/acquire b/scripts/atomic/fallbacks/acquire old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/add_negative b/scripts/atomic/fallbacks/add_negative old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/add_unless b/scripts/atomic/fallbacks/add_unless old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/andnot b/scripts/atomic/fallbacks/andnot old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/dec b/scripts/atomic/fallbacks/dec old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/dec_and_test b/scripts/atomic/fallbacks/dec_and_test old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/dec_if_positive b/scripts/atomic/fallbacks/dec_if_positive old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/dec_unless_positive b/scripts/atomic/fallbacks/dec_unless_positive old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/fence b/scripts/atomic/fallbacks/fence old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/fetch_add_unless b/scripts/atomic/fallbacks/fetch_add_unless old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/inc b/scripts/atomic/fallbacks/inc old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/inc_and_test b/scripts/atomic/fallbacks/inc_and_test old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/inc_not_zero b/scripts/atomic/fallbacks/inc_not_zero old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/inc_unless_negative b/scripts/atomic/fallbacks/inc_unless_negative old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/read_acquire b/scripts/atomic/fallbacks/read_acquire old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/release b/scripts/atomic/fallbacks/release old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/set_release b/scripts/atomic/fallbacks/set_release old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/sub_and_test b/scripts/atomic/fallbacks/sub_and_test old mode 100644 new mode 100755 diff --git a/scripts/atomic/fallbacks/try_cmpxchg b/scripts/atomic/fallbacks/try_cmpxchg old mode 100644 new mode 100755 diff --git a/scripts/atomic/gen-atomic-fallback.sh b/scripts/atomic/gen-atomic-fallback.sh old mode 100644 new mode 100755 diff --git a/scripts/atomic/gen-atomic-instrumented.sh b/scripts/atomic/gen-atomic-instrumented.sh old mode 100644 new mode 100755 diff --git a/scripts/atomic/gen-atomic-long.sh b/scripts/atomic/gen-atomic-long.sh old mode 100644 new mode 100755 -- cgit v1.2.3-59-g8ed1b