RISC-V: Don't use a global include guard for uapi/asm/syscalls.h
PATCH 1/1 RISC-V: Don't use a global include guard for uapi/asm/syscalls.h
This file is expected to be included multiple times in the same file in order to allow the __SYSCALL macro to generate system call tables. With a global include guard we end up missing __NR_riscv_flush_icache in the syscall table, which results in icache flushes that escape the vDSO call to not actually do anything.
The fix is to move to per-#define include guards, which allows the system call tables to actually be populated. Thanks to Macrus Comstedt for finding and fixing the bug!
I also went ahead and fixed the SPDX header to use a //-style comment, which I've been told is the canonical way to do it.
--- arch/riscv/include/uapi/asm/syscalls.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-)
arch/riscv/include/uapi/asm/syscalls.h +7 -6
@@ -1,10 +1,11 @@ -/* SPDX-License-Identifier: GPL-2.0 */ +// SPDX-License-Identifier: GPL-2.0 /* -* Copyright (C) 2017 SiFive +* Copyright (C) 2017-2018 SiFive */ -#ifndef _ASM__UAPI__SYSCALLS_H -#define _ASM__UAPI__SYSCALLS_H +/* There is explicitly no include guard here because this file is expected to +* be included multiple times in order to define the syscall macros via +* __SYSCALL. */ /* * Allows the instruction cache to be flushed from userspace. Despite RISC-V
@@ -20,7 +21,7 @@* caller. We don't currently do anything with the address range, that's just * in there for forwards compatibility. */ +#ifndef __NR_riscv_flush_icache#define __NR_riscv_flush_icache (__NR_arch_specific_syscall + 15) -__SYSCALL(__NR_riscv_flush_icache, sys_riscv_flush_icache) -#endif +__SYSCALL (__NR_riscv_flush_icache, sys_riscv_flush_icache)
Signature · 1 line
2.16.4
arch/riscv/include/uapi/asm/syscalls.h line 1
Quoted 6 lines
index
818655b0d535..882a6aa09a33100644arch/riscv/include/uapi/asm/syscalls.h +1
-1@@ -1,10 +1,11 @@ -/* SPDX-License-Identifier: GPL-2.0 */ +// SPDX-License-Identifier: GPL-2.0
/* */ is the required style for headers, // is only for other files.
arch/riscv/include/uapi/asm/syscalls.h line 8
Quoted 3 lines
arch/riscv/include/uapi/asm/syscalls.h +3
-0+/* There is explicitly no include guard here because this file is expected to +* be included multiple times in order to define the syscall macros via +* __SYSCALL. */
Normal Linux comment style would be:
/*
* There is explicitly no include guard here because this file is expected to
* be included multiple times in order to define the syscall macros via
* __SYSCALL.
*/
Also syscalls.h isn't included directly anywhere, but through <asm/unistd.h>, so we'll probably need a similar comment there as well.
Quoted 15 lines · Christoph Hellwig
arch/riscv/include/uapi/asm/syscalls.h line 1
Quoted 6 lines
index
818655b0d535..882a6aa09a33100644arch/riscv/include/uapi/asm/syscalls.h +1
-1@@ -1,10 +1,11 @@ -/* SPDX-License-Identifier: GPL-2.0 */ +// SPDX-License-Identifier: GPL-2.0 /* */ is the required style for headers, // is only for other files.
arch/riscv/include/uapi/asm/syscalls.h line 8
Quoted 3 lines
arch/riscv/include/uapi/asm/syscalls.h +3
-0+/* There is explicitly no include guard here because this file is expected to +* be included multiple times in order to define the syscall macros via +* __SYSCALL. */ Normal Linux comment style would be:
Quoted 8 lines
/*
* There is explicitly no include guard here because this file is expected to
* be included multiple times in order to define the syscall macros via
*__SYSCALL.
*/Also
syscalls.hisn't included directly anywhere, but through <asm/unistd.h>, so we'll probably need a similar comment there as well.
I've attached a v2 with both of these fixed. Thanks!
PATCH v2 1/1 RISC-V: Don't use a global include guard for uapi/asm/syscalls.h
This file is expected to be included multiple times in the same file in order to allow the __SYSCALL macro to generate system call tables. With a global include guard we end up missing __NR_riscv_flush_icache in the syscall table, which results in icache flushes that escape the vDSO call to not actually do anything.
The fix is to move to per-#define include guards, which allows the system call tables to actually be populated. Thanks to Macrus Comstedt for finding and fixing the bug!
I also went ahead and fixed the SPDX header to use a //-style comment, which I've been told is the canonical way to do it.
--- arch/riscv/include/asm/unistd.h | 5 +++++ arch/riscv/include/uapi/asm/syscalls.h | 15 +++++++++------ 2 files changed, 14 insertions(+), 6 deletions(-)
arch/riscv/include/asm/unistd.h +5 -0
@@ -11,6 +11,11 @@* GNU General Public License for more details. */ +/* +* There is explicitly no include guard here because this file is expected to +* included multiple times. See uapi/asm/syscalls.h for more info. +*/ +#define __ARCH_WANT_SYS_CLONE#include <uapi/asm/unistd.h> #include <uapi/asm/syscalls.h>
arch/riscv/include/uapi/asm/syscalls.h +9 -6
@@ -1,10 +1,13 @@ -/* SPDX-License-Identifier: GPL-2.0 */ +// SPDX-License-Identifier: GPL-2.0 /* -* Copyright (C) 2017 SiFive +* Copyright (C) 2017-2018 SiFive */ -#ifndef _ASM__UAPI__SYSCALLS_H -#define _ASM__UAPI__SYSCALLS_H +/* +* There is explicitly no include guard here because this file is expected to +* be included multiple times in order to define the syscall macros via +* __SYSCALL. +*/ /* * Allows the instruction cache to be flushed from userspace. Despite RISC-V
@@ -20,7 +23,7 @@* caller. We don't currently do anything with the address range, that's just * in there for forwards compatibility. */ +#ifndef __NR_riscv_flush_icache#define __NR_riscv_flush_icache (__NR_arch_specific_syscall + 15) -__SYSCALL(__NR_riscv_flush_icache, sys_riscv_flush_icache) -#endif +__SYSCALL (__NR_riscv_flush_icache, sys_riscv_flush_icache)
Signature · 1 line
2.16.4
Quoted 25 lines · Palmer Dabbelt
This file is expected to be included multiple times in the same file in order to allow the
__SYSCALLmacro to generate system call tables. With a global include guard we end up missing__NR_riscv_flush_icachein the syscall table, which results in icache flushes that escape the vDSO call to not actually do anything.The fix is to move to per-#define include guards, which allows the system call tables to actually be populated. Thanks to Macrus Comstedt for finding and fixing the bug!
I also went ahead and fixed the SPDX header to use a //-style comment, which I've been told is the canonical way to do it.
Cc Marcus Comstedt <[email protected]>Signed-off-by Palmer Dabbelt <[email protected]>--- arch/riscv/include/asm/unistd.h | 5 +++++ arch/riscv/include/uapi/asm/syscalls.h | 15 +++++++++------ 2 files changed, 14 insertions(+), 6 deletions(-)arch/riscv/include/asm/unistd.h +0
-0
arch/riscv/include/asm/unistd.h line 15
Quoted 5 lines
arch/riscv/include/asm/unistd.h +2
-0@@ -11,6 +11,11 @@* GNU General Public License for more details. */ +/* +* There is explicitly no include guard here because this file is expected to
to .. be .. included
Quoted 13 lines
arch/riscv/include/asm/unistd.h +3
-0+* included multiple times. See uapi/asm/syscalls.h for more info. +*/ +#define __ARCH_WANT_SYS_CLONE#include <uapi/asm/unistd.h> #include <uapi/asm/syscalls.h> arch/riscv/include/uapi/asm/syscalls.h +1
-1@@ -1,10 +1,13 @@ -/* SPDX-License-Identifier: GPL-2.0 */ +// SPDX-License-Identifier: GPL-2.0
arch/riscv/include/uapi/asm/syscalls.h line 8
Quoted 10 lines
arch/riscv/include/uapi/asm/syscalls.h +4
-3/* -* Copyright (C) 2017 SiFive +* Copyright (C) 2017-2018 SiFive */ -#ifndef _ASM__UAPI__SYSCALLS_H -#define _ASM__UAPI__SYSCALLS_H +/* +* There is explicitly no include guard here because this file is expected to +* be included multiple times in order to define the syscall macros via
like that one :)
Quoted 5 lines
arch/riscv/include/uapi/asm/syscalls.h +2
-0+* __SYSCALL. +*/ /* * Allows the instruction cache to be flushed from userspace. Despite RISC-V
Signature · 1 line
~Randy
Quoted 29 lines · rdunlap at infradead.org
Quoted 28 lines · Palmer Dabbelt
This file is expected to be included multiple times in the same file in order to allow the
__SYSCALLmacro to generate system call tables. With a global include guard we end up missing__NR_riscv_flush_icachein the syscall table, which results in icache flushes that escape the vDSO call to not actually do anything.The fix is to move to per-#define include guards, which allows the system call tables to actually be populated. Thanks to Macrus Comstedt for finding and fixing the bug!
I also went ahead and fixed the SPDX header to use a //-style comment, which I've been told is the canonical way to do it.
Cc Marcus Comstedt <[email protected]>Signed-off-by Palmer Dabbelt <[email protected]>--- arch/riscv/include/asm/unistd.h | 5 +++++ arch/riscv/include/uapi/asm/syscalls.h | 15 +++++++++------ 2 files changed, 14 insertions(+), 6 deletions(-)arch/riscv/include/asm/unistd.h +0
-0@@ -11,6 +11,11 @@* GNU General Public License for more details. */
Quoted 4 lines
arch/riscv/include/asm/unistd.h line 15
Quoted 2 lines
arch/riscv/include/asm/unistd.h +2
-0+/* +* There is explicitly no include guard here because this file is expected to to .. be .. included
Thanks. I'm not going to spin a v3 unless there's more feedback, but I'll include it in the PR.
Quoted 32 lines
Quoted 14 lines
arch/riscv/include/asm/unistd.h +3
-0+* included multiple times. See uapi/asm/syscalls.h for more info. +*/ +#define __ARCH_WANT_SYS_CLONE#include <uapi/asm/unistd.h> #include <uapi/asm/syscalls.h> arch/riscv/include/uapi/asm/syscalls.h +1
-1@@ -1,10 +1,13 @@ -/* SPDX-License-Identifier: GPL-2.0 */ +// SPDX-License-Identifier: GPL-2.0 arch/riscv/include/uapi/asm/syscalls.h line 8
Quoted 10 lines
arch/riscv/include/uapi/asm/syscalls.h +4
-3/* -* Copyright (C) 2017 SiFive +* Copyright (C) 2017-2018 SiFive */ -#ifndef _ASM__UAPI__SYSCALLS_H -#define _ASM__UAPI__SYSCALLS_H +/* +* There is explicitly no include guard here because this file is expected to +* be included multiple times in order to define the syscall macros via like that one :)
Quoted 5 lines
arch/riscv/include/uapi/asm/syscalls.h +2
-0+* __SYSCALL. +*/ /* * Allows the instruction cache to be flushed from userspace. Despite RISC-V
Looks fine (modulo any typos):
This actually seems to break the compilation for me in for-next:
hch at carbon:~/work/linux$ make ARCH=riscv
CALL scripts/checksyscalls.sh
<stdin>:1335:2: warning: #warning syscall rseq not implemented [-Wcpp]
CHK include/generated/compile.h
CC arch/riscv/kernel/syscall_table.o./arch/riscv/include/uapi/asm/syscalls.h:29:36: error: 'sys_riscv_flush_icache' undeclared here (not in a function); did you mean '__NR_riscv_flush_icache'?
__SYSCALL(__NR_riscv_flush_icache, sys_riscv_flush_icache)
^
arch/riscv/kernel/syscall_table.c:21:37: note: in definition of macro '__SYSCALL'
#define __SYSCALL(nr, call) [nr] = (call),
^~~~make[1]: *** [scripts/Makefile.build:318: arch/riscv/kernel/syscall_table.o] Error 1
make: *** [Makefile:1029: arch/riscv/kernel] Error 2
Reverting it for now, but I guess this might hit others too..
Quoted 9 lines · Christoph Hellwig
This actually seems to break the compilation for me in for-next:
hch at carbon:~/work/linux$ make ARCH=riscv
CALLscripts/checksyscalls.sh
<stdin>:1335:2: warning: #warning syscall rseq not implemented [-Wcpp]
CHKinclude/generated/compile.h
CCarch/riscv/kernel/syscall_table.o./arch/riscv/include/uapi/asm/syscalls.h:29:36: error: 'sys_riscv_flush_icache' undeclared here (not in a function); did you mean '__NR_riscv_flush_icache'?
__SYSCALL(__NR_riscv_flush_icache, sys_riscv_flush_icache)
Quoted 8 lines
^ arch/riscv/kernel/syscall_table.c:21:37: note: in definition of macro '__SYSCALL' #define __SYSCALL(nr, call) [nr] = (call), ^~~~make[1]: *** [
scripts/Makefile.build:318:arch/riscv/kernel/syscall_table.o] Error 1
make: *** [Makefile:1029:arch/riscv/kernel] Error 2Reverting it for now, but I guess this might hit others too..
Thanks. I dropped this from for-next and just sent out a replacement.
Quoted 10 lines · Palmer Dabbelt
This file is expected to be included multiple times in the same file in order to allow the
__SYSCALLmacro to generate system call tables. With a global include guard we end up missing__NR_riscv_flush_icachein the syscall table, which results in icache flushes that escape the vDSO call to not actually do anything.The fix is to move to per-#define include guards, which allows the system call tables to actually be populated. Thanks to Macrus Comstedt for finding and fixing the bug!
Quoted 5 lines
I also went ahead and fixed the SPDX header to use a //-style comment, which I've been told is the canonical way to do it.
Cc Marcus Comstedt <[email protected]>Signed-off-by Palmer Dabbelt <[email protected]>
Fails to build riscv:allnoconfig.
CC arch/riscv/kernel/syscall_table.o./arch/riscv/include/uapi/asm/syscalls.h:29:36: error:
?sys_riscv_flush_icache? undeclared here (not in a function); did you mean ?__NR_riscv_flush_icache??
Guenter
Quoted 34 lines
--- arch/riscv/include/uapi/asm/syscalls.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-)arch/riscv/include/uapi/asm/syscalls.h +7
-6@@ -1,10 +1,11 @@ -/* SPDX-License-Identifier: GPL-2.0 */ +// SPDX-License-Identifier: GPL-2.0 /* -* Copyright (C) 2017 SiFive +* Copyright (C) 2017-2018 SiFive */ -#ifndef _ASM__UAPI__SYSCALLS_H -#define _ASM__UAPI__SYSCALLS_H +/* There is explicitly no include guard here because this file is expected to +* be included multiple times in order to define the syscall macros via +* __SYSCALL. */ /* * Allows the instruction cache to be flushed from userspace. Despite RISC-V @@ -20,7 +21,7 @@* caller. We don't currently do anything with the address range, that's just * in there for forwards compatibility. */ +#ifndef __NR_riscv_flush_icache#define __NR_riscv_flush_icache (__NR_arch_specific_syscall + 15) -__SYSCALL(__NR_riscv_flush_icache, sys_riscv_flush_icache) -#endif +__SYSCALL (__NR_riscv_flush_icache, sys_riscv_flush_icache)
Quoted 14 lines · linux at roeck-us.net
Quoted 13 lines · Palmer Dabbelt
This file is expected to be included multiple times in the same file in order to allow the
__SYSCALLmacro to generate system call tables. With a global include guard we end up missing__NR_riscv_flush_icachein the syscall table, which results in icache flushes that escape the vDSO call to not actually do anything.The fix is to move to per-#define include guards, which allows the system call tables to actually be populated. Thanks to Macrus Comstedt for finding and fixing the bug!
I also went ahead and fixed the SPDX header to use a //-style comment, which I've been told is the canonical way to do it.
Quoted 8 lines
Quoted 2 lines
Cc Marcus Comstedt <[email protected]>Signed-off-by Palmer Dabbelt <[email protected]>Fails to build riscv:allnoconfig.
CC
arch/riscv/kernel/syscall_table.o./arch/riscv/include/uapi/asm/syscalls.h:29:36: error:
?sys_riscv_flush_icache? undeclared here (not in a function); did you mean ?__NR_riscv_flush_icache??
Thanks. I added you to another patch set.