From patchwork Mon Jun 5 07:00:57 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mark Rutland X-Patchwork-Id: 10286 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp2497261vqr; Mon, 5 Jun 2023 00:02:52 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ6FcLsED1ltbKIkLLv5L/99MHvWkZU98KzfYcZ7alPuGb/BmBRbz3vvgeN246oCeoKDbH6Y X-Received: by 2002:a17:902:d506:b0:1b1:9233:bbf5 with SMTP id b6-20020a170902d50600b001b19233bbf5mr8749650plg.57.1685948572232; Mon, 05 Jun 2023 00:02:52 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1685948572; cv=none; d=google.com; s=arc-20160816; b=jf2ivOzE1w8ouAr+WgJOtnlGsQwigWb8i0KVRnRXEozJgjS6fN8CPg0b4HodICNZPi eTXIpNnXr/NjfQcMB/VvTy51aPyekCejn6UNDUkhTyIANKqBBXz+en3VzKH57Yiqfwl5 M2hg8Tm+trXy51ZlVuAjx5/xN8TdUkT6GUWGUOPTGkVmQoXOkMyk+oby/0rXzib6nvK8 gb57sMUxKJY2t0s/mZmOxm/FO3uf2htQa8VNAh0hLLjqSSpnlra5zzNBqHL7IdmWFZQB zw4EDHiXZu0IDiR1optBu0YHYsd+XZRafz+CKWOGxS35Hhew0HCpYVam2IT0WFKtjSSC 2lYA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from; bh=PC4P+67LMel0LRLIHyJP1+eDaSiIb9ivFODGK7ZbiCM=; b=onXrmOa40GpTkRRXGflVXQlto7+Rap6dDYBeQoB7H7+m/WyImmB6qfPF7c60wodukU AuVSvIgO5Ko+VUYnBHTDwXd+LgpeQJPA2Q7p9oDhAKjtu2DsTtECwQF1IhkZEDuo2FSJ hqWIIs7/bqJFO2hjMjlYkT6SRsTy2jEwr04Fvq4egVpMEQ+JM93AufXbyF7Jt3aPz//6 yaDutLAUaMT14iqHosMbs56TO3gZPXGNhvhzY9lohPUbwmHjFBs0ThH/9cRg4LCgrL7m exgs4O7aCP697Fk3O2wdOlF8xbaStlz0f5tXsUFfXRvQXSOig0eNGAxMlXfVJDRdmX0m szGA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=arm.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id d16-20020a170903231000b001aaea4707c1si5329343plh.99.2023.06.05.00.02.39; Mon, 05 Jun 2023 00:02:52 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=arm.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230109AbjFEHBh (ORCPT + 99 others); Mon, 5 Jun 2023 03:01:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34920 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229847AbjFEHBe (ORCPT ); Mon, 5 Jun 2023 03:01:34 -0400 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id 1FD1DB8; Mon, 5 Jun 2023 00:01:31 -0700 (PDT) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 261F6D75; Mon, 5 Jun 2023 00:02:16 -0700 (PDT) Received: from lakrids.cambridge.arm.com (usa-sjc-imap-foss1.foss.arm.com [10.121.207.14]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id D38683F793; Mon, 5 Jun 2023 00:01:28 -0700 (PDT) From: Mark Rutland To: linux-kernel@vger.kernel.org Cc: akiyks@gmail.com, boqun.feng@gmail.com, corbet@lwn.net, keescook@chromium.org, linux@armlinux.org.uk, linux-doc@vger.kernel.org, mark.rutland@arm.com, mchehab@kernel.org, paulmck@kernel.org, peterz@infradead.org, rdunlap@infradead.org, sstabellini@kernel.org, will@kernel.org Subject: [PATCH v2 00/27] locking/atomic: restructuring + kerneldoc Date: Mon, 5 Jun 2023 08:00:57 +0100 Message-Id: <20230605070124.3741859-1-mark.rutland@arm.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_MED, SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1767845210368056661?= X-GMAIL-MSGID: =?utf-8?q?1767845210368056661?= Hi all, These patches restructure the generated atomic headers, and add kerneldoc comments for all of the generic atomic{,64,_long}_t operations. The core headers now generate raw_atomic*() operations as the fundamental instrumentation-safe atomics, with the arch_atomic*() functions being an implementation detail that shouldn't be used directly. Each raw_atomic*() op is given a single definition with all related ifdeffery inside, e.g. | /** | * raw_atomic_inc_return_acquire() - atomic increment with acquire ordering | * @v: pointer to atomic_t | * | * Atomically updates @v to (@v + 1) with acquire ordering. | * | * Safe to use in noinstr code; prefer atomic_inc_return_acquire() elsewhere. | * | * Return: the updated value of @v. | */ | static __always_inline int | raw_atomic_inc_return_acquire(atomic_t *v) | { | #if defined(arch_atomic_inc_return_acquire) | return arch_atomic_inc_return_acquire(v); | #elif defined(arch_atomic_inc_return_relaxed) | int ret = arch_atomic_inc_return_relaxed(v); | __atomic_acquire_fence(); | return ret; | #elif defined(arch_atomic_inc_return) | return arch_atomic_inc_return(v); | #else | return raw_atomic_add_return_acquire(1, v); | #endif | } Similarly, the regular atomic*() ops (which already have a single definition) are given kerneldoc comments, e.g. | /** | * atomic_inc_return_acquire() - atomic increment with acquire ordering | * @v: pointer to atomic_t | * | * Atomically updates @v to (@v + 1) with acquire ordering. | * | * Unsafe to use in noinstr code; use raw_atomic_inc_return_acquire() there. | * | * Return: the updated value of @v. | */ | static __always_inline int | atomic_inc_return_acquire(atomic_t *v) | { | instrument_atomic_read_write(v, sizeof(*v)); | return raw_atomic_inc_return_acquire(v); | } The kerneldoc comments themselves are built from templates as with the fallbacks, which should allow them to be extended in future if necessary. I've compile-tested this for a number of architectures and configurations, but as usual this probably needs to see some testing by build robots. The patches are based on Peter Zijlstra's queued locking/core branch, specifically commit: bb6e9a06cba6b850 ("s390/cpum_sf: Convert to cmpxchg128()") Which can be found in the git tree at: https://git.kernel.org/pub/scm/linux/kernel/git/peterz/queue.git/ Since v1 [1]: * Add kernel-doc handling of "~@v" * Add atomic-instrumented.h to included documentation headers * Fix typos and punctuation * Clarify kerneldoc wording [1] https://lore.kernel.org/lkml/20230522122429.1915021-1-mark.rutland@arm.com/ Thanks, Mark. Mark Rutland (26): locking/atomic: arm: fix sync ops locking/atomic: remove fallback comments locking/atomic: hexagon: remove redundant arch_atomic_cmpxchg locking/atomic: make atomic*_{cmp,}xchg optional locking/atomic: arc: add preprocessor symbols locking/atomic: arm: add preprocessor symbols locking/atomic: hexagon: add preprocessor symbols locking/atomic: m68k: add preprocessor symbols locking/atomic: parisc: add preprocessor symbols locking/atomic: sh: add preprocessor symbols locking/atomic: sparc: add preprocessor symbols locking/atomic: x86: add preprocessor symbols locking/atomic: xtensa: add preprocessor symbols locking/atomic: scripts: remove bogus order parameter locking/atomic: scripts: remove leftover "${mult}" locking/atomic: scripts: factor out order template generation locking/atomic: scripts: add trivial raw_atomic*_() locking/atomic: treewide: use raw_atomic*_() locking/atomic: scripts: build raw_atomic_long*() directly locking/atomic: scripts: restructure fallback ifdeffery locking/atomic: scripts: split pfx/name/sfx/order locking/atomic: scripts: simplify raw_atomic_long*() definitions locking/atomic: scripts: simplify raw_atomic*() definitions docs: scripts: kernel-doc: accept bitwise negation like ~@var locking/atomic: scripts: generate kerneldoc comments locking/atomic: treewide: delete arch_atomic_*() kerneldoc Paul E. McKenney (1): locking/atomic: docs: Add atomic operations to the driver basic API documentation Documentation/driver-api/basics.rst | 8 +- arch/alpha/include/asm/atomic.h | 35 - arch/arc/include/asm/atomic-spinlock.h | 9 + arch/arc/include/asm/atomic.h | 24 - arch/arc/include/asm/atomic64-arcv2.h | 19 +- arch/arm/include/asm/assembler.h | 17 + arch/arm/include/asm/atomic.h | 15 +- arch/arm/include/asm/sync_bitops.h | 29 +- arch/arm/lib/bitops.h | 14 +- arch/arm/lib/testchangebit.S | 4 + arch/arm/lib/testclearbit.S | 4 + arch/arm/lib/testsetbit.S | 4 + arch/arm64/include/asm/atomic.h | 28 - arch/csky/include/asm/atomic.h | 35 - arch/hexagon/include/asm/atomic.h | 69 +- arch/ia64/include/asm/atomic.h | 7 - arch/loongarch/include/asm/atomic.h | 56 - arch/m68k/include/asm/atomic.h | 18 +- arch/mips/include/asm/atomic.h | 11 - arch/openrisc/include/asm/atomic.h | 3 - arch/parisc/include/asm/atomic.h | 27 +- arch/powerpc/include/asm/atomic.h | 24 - arch/powerpc/kernel/smp.c | 12 +- arch/riscv/include/asm/atomic.h | 72 - arch/sh/include/asm/atomic-grb.h | 9 + arch/sh/include/asm/atomic-irq.h | 9 + arch/sh/include/asm/atomic-llsc.h | 9 + arch/sh/include/asm/atomic.h | 3 - arch/sparc/include/asm/atomic_32.h | 18 +- arch/sparc/include/asm/atomic_64.h | 29 +- arch/x86/include/asm/atomic.h | 87 - arch/x86/include/asm/atomic64_32.h | 76 - arch/x86/include/asm/atomic64_64.h | 81 - arch/x86/include/asm/cmpxchg_64.h | 4 + arch/x86/kernel/alternative.c | 4 +- arch/x86/kernel/cpu/mce/core.c | 16 +- arch/x86/kernel/nmi.c | 2 +- arch/x86/kernel/pvclock.c | 4 +- arch/x86/kvm/x86.c | 2 +- arch/xtensa/include/asm/atomic.h | 12 +- include/asm-generic/atomic.h | 3 - include/asm-generic/bitops/atomic.h | 12 +- include/asm-generic/bitops/lock.h | 8 +- include/linux/atomic/atomic-arch-fallback.h | 5200 ++++++++++++------ include/linux/atomic/atomic-instrumented.h | 3484 ++++++++++-- include/linux/atomic/atomic-long.h | 2122 ++++--- include/linux/context_tracking.h | 4 +- include/linux/context_tracking_state.h | 2 +- include/linux/cpumask.h | 2 +- include/linux/jump_label.h | 2 +- kernel/context_tracking.c | 12 +- kernel/sched/clock.c | 2 +- scripts/atomic/atomic-tbl.sh | 112 +- scripts/atomic/atomics.tbl | 2 +- scripts/atomic/fallbacks/acquire | 4 - scripts/atomic/fallbacks/add_negative | 14 +- scripts/atomic/fallbacks/add_unless | 15 +- scripts/atomic/fallbacks/andnot | 6 +- scripts/atomic/fallbacks/cmpxchg | 3 + scripts/atomic/fallbacks/dec | 6 +- scripts/atomic/fallbacks/dec_and_test | 14 +- scripts/atomic/fallbacks/dec_if_positive | 8 +- scripts/atomic/fallbacks/dec_unless_positive | 8 +- scripts/atomic/fallbacks/fence | 4 - scripts/atomic/fallbacks/fetch_add_unless | 17 +- scripts/atomic/fallbacks/inc | 6 +- scripts/atomic/fallbacks/inc_and_test | 14 +- scripts/atomic/fallbacks/inc_not_zero | 13 +- scripts/atomic/fallbacks/inc_unless_negative | 8 +- scripts/atomic/fallbacks/read_acquire | 6 +- scripts/atomic/fallbacks/release | 4 - scripts/atomic/fallbacks/set_release | 6 +- scripts/atomic/fallbacks/sub_and_test | 15 +- scripts/atomic/fallbacks/try_cmpxchg | 6 +- scripts/atomic/fallbacks/xchg | 3 + scripts/atomic/gen-atomic-fallback.sh | 264 +- scripts/atomic/gen-atomic-instrumented.sh | 23 +- scripts/atomic/gen-atomic-long.sh | 38 +- scripts/atomic/kerneldoc/add | 13 + scripts/atomic/kerneldoc/add_negative | 13 + scripts/atomic/kerneldoc/add_unless | 18 + scripts/atomic/kerneldoc/and | 13 + scripts/atomic/kerneldoc/andnot | 13 + scripts/atomic/kerneldoc/cmpxchg | 14 + scripts/atomic/kerneldoc/dec | 12 + scripts/atomic/kerneldoc/dec_and_test | 12 + scripts/atomic/kerneldoc/dec_if_positive | 12 + scripts/atomic/kerneldoc/dec_unless_positive | 12 + scripts/atomic/kerneldoc/inc | 12 + scripts/atomic/kerneldoc/inc_and_test | 12 + scripts/atomic/kerneldoc/inc_not_zero | 12 + scripts/atomic/kerneldoc/inc_unless_negative | 12 + scripts/atomic/kerneldoc/or | 13 + scripts/atomic/kerneldoc/read | 12 + scripts/atomic/kerneldoc/set | 13 + scripts/atomic/kerneldoc/sub | 13 + scripts/atomic/kerneldoc/sub_and_test | 13 + scripts/atomic/kerneldoc/try_cmpxchg | 15 + scripts/atomic/kerneldoc/xchg | 13 + scripts/atomic/kerneldoc/xor | 13 + scripts/kernel-doc | 2 +- 101 files changed, 8979 insertions(+), 3689 deletions(-) create mode 100755 scripts/atomic/fallbacks/cmpxchg create mode 100755 scripts/atomic/fallbacks/xchg create mode 100644 scripts/atomic/kerneldoc/add create mode 100644 scripts/atomic/kerneldoc/add_negative create mode 100644 scripts/atomic/kerneldoc/add_unless create mode 100644 scripts/atomic/kerneldoc/and create mode 100644 scripts/atomic/kerneldoc/andnot create mode 100644 scripts/atomic/kerneldoc/cmpxchg create mode 100644 scripts/atomic/kerneldoc/dec create mode 100644 scripts/atomic/kerneldoc/dec_and_test create mode 100644 scripts/atomic/kerneldoc/dec_if_positive create mode 100644 scripts/atomic/kerneldoc/dec_unless_positive create mode 100644 scripts/atomic/kerneldoc/inc create mode 100644 scripts/atomic/kerneldoc/inc_and_test create mode 100644 scripts/atomic/kerneldoc/inc_not_zero create mode 100644 scripts/atomic/kerneldoc/inc_unless_negative create mode 100644 scripts/atomic/kerneldoc/or create mode 100644 scripts/atomic/kerneldoc/read create mode 100644 scripts/atomic/kerneldoc/set create mode 100644 scripts/atomic/kerneldoc/sub create mode 100644 scripts/atomic/kerneldoc/sub_and_test create mode 100644 scripts/atomic/kerneldoc/try_cmpxchg create mode 100644 scripts/atomic/kerneldoc/xchg create mode 100644 scripts/atomic/kerneldoc/xor