[05/41] Documentation/sparse: add hints about __CHECKER__

Message ID	20220323230533.28A5DC340E9@smtp.kernel.org (mailing list archive)
State	New
Headers	show Return-Path: <owner-linux-mm@kvack.org> Date: Wed, 23 Mar 2022 16:05:32 -0700 To: ndesaulniers@google.com,nathan@kernel.org,mst@redhat.com,corbet@lwn.net,bhelgaas@google.com,akpm@linux-foundation.org,patches@lists.linux.dev,linux-mm@kvack.org,mm-commits@vger.kernel.org,torvalds@linux-foundation.org,akpm@linux-foundation.org From: Andrew Morton <akpm@linux-foundation.org> In-Reply-To: <20220323160453.65922ced539cbf445b191555@linux-foundation.org> Subject: [patch 05/41] Documentation/sparse: add hints about __CHECKER__ Message-Id: <20220323230533.28A5DC340E9@smtp.kernel.org> Sender: owner-linux-mm@kvack.org Precedence: bulk
Series	[01/41] proc: alloc PATH_MAX bytes for /proc/${pid}/fd/ symlinks \| expand [01/41] proc: alloc PATH_MAX bytes for /proc/${pid}/fd/ symlinks [02/41] proc/vmcore: fix possible deadlock on concurrent mmap and read [03/41] proc/vmcore: fix vmcore_alloc_buf() kernel-doc comment [04/41] linux/types.h: remove unnecessary __bitwise__ [05/41] Documentation/sparse: add hints about __CHECKER__ [06/41] kernel/ksysfs.c: use helper macro __ATTR_RW [07/41] Kconfig.debug: make DEBUG_INFO selectable from a choice [08/41] include: drop pointless __compiler_offsetof indirection [09/41] ilog2: force inlining of __ilog2_u32() and __ilog2_u64() [10/41] bitfield: add explicit inclusions to the example [11/41] lib/Kconfig.debug: add ARCH dependency for FUNCTION_ALIGN option [12/41] lib: bitmap: fix many kernel-doc warnings [13/41] checkpatch: prefer MODULE_LICENSE("GPL") over MODULE_LICENSE("GPL v2") [14/41] checkpatch: add --fix option for some TRAILING_STATEMENTS [15/41] checkpatch: add early_param exception to blank line after struct/function test [16/41] checkpatch: use python3 to find codespell dictionary [17/41] init: use ktime_us_delta() to make initcall_debug log more precise [18/41] init.h: improve __setup and early_param documentation [19/41] init/main.c: return 1 from handled __setup() functions [20/41] fs/pipe: use kvcalloc to allocate a pipe_buffer array [21/41] fs/pipe.c: local vars have to match types of proper pipe_inode_info fields [22/41] minix: fix bug when opening a file with O_DIRECT [23/41] fat: use pointer to simple type in put_user() [24/41] cgroup: use irqsave in cgroup_rstat_flush_locked(). [25/41] kexec: make crashk_res, crashk_low_res and crash_notes symbols always visible [26/41] riscv: mm: init: use IS_ENABLED(CONFIG_KEXEC_CORE) instead of #ifdef [27/41] x86/setup: use IS_ENABLED(CONFIG_KEXEC_CORE) instead of #ifdef [28/41] arm64: mm: use IS_ENABLED(CONFIG_KEXEC_CORE) instead of #ifdef [29/41] docs: kdump: update description about sysfs file system support [30/41] docs: kdump: add scp example to write out the dump file [31/41] panic: unset panic_on_warn inside panic() [32/41] ubsan: no need to unset panic_on_warn in ubsan_epilogue() [33/41] kasan: no need to unset panic_on_warn in end_report() [34/41] taskstats: remove unneeded dead assignment [35/41] docs: sysctl/kernel: add missing bit to panic_print [36/41] panic: add option to dump all CPUs backtraces in panic_print [37/41] panic: move panic_print before kmsg dumpers [38/41] kcov: split ioctl handling into locked and unlocked parts [39/41] kcov: properly handle subsequent mmap calls [40/41] kernel/resource: fix kfree() of bootmem memory again [41/41] Revert "ubsan, kcsan: Don't combine sanitizer with kcov on clang"

Message ID

20220323230533.28A5DC340E9@smtp.kernel.org (mailing list archive)

State

New

Headers

Date: Wed, 23 Mar 2022 16:05:32 -0700
To: 
 ndesaulniers@google.com,nathan@kernel.org,mst@redhat.com,corbet@lwn.net,bhelgaas@google.com,akpm@linux-foundation.org,patches@lists.linux.dev,linux-mm@kvack.org,mm-commits@vger.kernel.org,torvalds@linux-foundation.org,akpm@linux-foundation.org
From: Andrew Morton <akpm@linux-foundation.org>
In-Reply-To: <20220323160453.65922ced539cbf445b191555@linux-foundation.org>
Subject: [patch 05/41] Documentation/sparse: add hints about __CHECKER__
Message-Id: <20220323230533.28A5DC340E9@smtp.kernel.org>
Sender: owner-linux-mm@kvack.org
Precedence: bulk

Series

[01/41] proc: alloc PATH_MAX bytes for /proc/${pid}/fd/ symlinks | expand

Commit Message

Andrew Morton March 23, 2022, 11:05 p.m. UTC

From: Bjorn Helgaas <bhelgaas@google.com>
Subject: Documentation/sparse: add hints about __CHECKER__

Several attributes depend on __CHECKER__, but previously there was no clue
in the tree about when __CHECKER__ might be defined.  Add hints at the
most common places (__kernel, __user, __iomem, __bitwise) and in the
sparse documentation.

Link: https://lkml.kernel.org/r/20220310220927.245704-3-helgaas@kernel.org
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Nathan Chancellor <nathan@kernel.org>
Cc: Nick Desaulniers <ndesaulniers@google.com>
Cc: "Michael S . Tsirkin" <mst@redhat.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
---

 Documentation/dev-tools/sparse.rst |    2 ++
 include/linux/compiler_types.h     |    1 +
 include/uapi/linux/types.h         |    1 +
 3 files changed, 4 insertions(+)

--- a/Documentation/dev-tools/sparse.rst~documentation-sparse-add-hints-about-__checker__
+++ a/Documentation/dev-tools/sparse.rst
@@ -100,3 +100,5 @@  have already built it.
 
 The optional make variable CF can be used to pass arguments to sparse.  The
 build system passes -Wbitwise to sparse automatically.
+
+Note that sparse defines the __CHECKER__ preprocessor symbol.
--- a/include/linux/compiler_types.h~documentation-sparse-add-hints-about-__checker__
+++ a/include/linux/compiler_types.h
@@ -4,6 +4,7 @@ 
 
 #ifndef __ASSEMBLY__
 
+/* sparse defines __CHECKER__; see Documentation/dev-tools/sparse.rst */
 #ifdef __CHECKER__
 /* address spaces */
 # define __kernel	__attribute__((address_space(0)))
--- a/include/uapi/linux/types.h~documentation-sparse-add-hints-about-__checker__
+++ a/include/uapi/linux/types.h
@@ -19,6 +19,7 @@ 
  * any application/library that wants linux/types.h.
  */
 
+/* sparse defines __CHECKER__; see Documentation/dev-tools/sparse.rst */
 #ifdef __CHECKER__
 #define __bitwise	__attribute__((bitwise))
 #else

[05/41] Documentation/sparse: add hints about CHECKER

Commit Message

Patch