Skip to contentSkip to conversation

RISC-V: Don't use a global include guard for uapi/asm/syscalls.

PATCH In review Palmer Dabbelt 3 participants 14 messages Aug 9, 2018 – Aug 20, 2018 RISC-V

lore
Share & tools
lore
#0 lore raw

It turns out that we weren't actually hooking sys_riscv_flush_icache into the syscall table, which results in any flush_icache() call that escapes the vDSO to silently do nothing.

Changes since v2:

* sys_riscv_flush_icache actually flushes the icache when SMP=n. Thanks to Andrew for pointing out the I screwed it up!

Changes since v1:

* sys_riscv_flush_icache is now defined even when SMP=n, which allows this patch set to build against SMP=n and SMP=y.

#1 lore raw

PATCH v3 1/2 RISC-V: Define sys_riscv_flush_icache when SMP=n

This would be necessary to make non-SMP builds work, but there is another error in the implementation of our syscall linkage that actually just causes sys_riscv_flush_icache to never build. I've build tested this on allnoconfig and allnoconfig+SMP=y, as well as defconfig like normal.

CC: Christoph Hellwig <[email protected]>
CC: Guenter Roeck <[email protected]>
In-Reply-To: <[email protected]>
In-Reply-To: <[email protected]>

---
 arch/riscv/include/asm/vdso.h |  2 --
 arch/riscv/kernel/sys_riscv.c | 12 ++++++++++--
 2 files changed, 10 insertions(+), 4 deletions(-)
arch/riscv/include/asm/vdso.h +0 -2
index 541544d64c33..ec6180a4b55d 100644
@@ -38,8 +38,6 @@ struct vdso_data {
 	(void __user *)((unsigned long)(base) + __vdso_##name);			\
 })
 
-#ifdef CONFIG_SMP
 asmlinkage long sys_riscv_flush_icache(uintptr_t, uintptr_t, uintptr_t);
-#endif
 
 #endif /* _ASM_RISCV_VDSO_H */
arch/riscv/kernel/sys_riscv.c +10 -2
index f7181ed8aafc..568026ccf6e8 100644
@@ -48,7 +48,6 @@ SYSCALL_DEFINE6(mmap2, unsigned long, addr, unsigned long, len,
 }
 #endif /* !CONFIG_64BIT */
 
-#ifdef CONFIG_SMP
 /*
  * Allows the instruction cache to be flushed from userspace.  Despite RISC-V
  * having a direct 'fence.i' instruction available to userspace (which we
@@ -66,15 +65,24 @@ SYSCALL_DEFINE6(mmap2, unsigned long, addr, unsigned long, len,
 SYSCALL_DEFINE3(riscv_flush_icache, uintptr_t, start, uintptr_t, end,
 	uintptr_t, flags)
 {
+#ifdef CONFIG_SMP
 	struct mm_struct *mm = current->mm;
 	bool local = (flags & SYS_RISCV_FLUSH_ICACHE_LOCAL) != 0;
+#endif
 
 	/* Check the reserved flags. */
 	if (unlikely(flags & ~SYS_RISCV_FLUSH_ICACHE_ALL))
 		return -EINVAL;
 
+	/*
+	 * Without CONFIG_SMP flush_icache_mm is a just a flush_icache_all(),
+	 * which generates unused variable warnings all over this function.
+	 */
+#ifdef CONFIG_SMP
 	flush_icache_mm(mm, local);
+#else
+	flush_icache_all();
+#endif
 
 	return 0;
 }
-#endif
Signature · 1 line
2.16.4
#2 lore raw

Re: [PATCH v3 1/2] RISC-V: Define sys_riscv_flush_icache when SMP=n

Quoted 5 lines · Palmer Dabbelt

This would be necessary to make non-SMP builds work, but there is another error in the implementation of our syscall linkage that actually just causes sys_riscv_flush_icache to never build. I've build tested this on allnoconfig and allnoconfig+SMP=y, as well as defconfig like normal.

Would't it make sense to use COND_SYSCALL to stub out the syscall for !SMP builds?

#3 lore raw

Re: [PATCH v3 1/2] RISC-V: Define sys_riscv_flush_icache when SMP=n

Quoted 9 lines · Christoph Hellwig
Quoted 5 lines · Palmer Dabbelt

This would be necessary to make non-SMP builds work, but there is another error in the implementation of our syscall linkage that actually just causes sys_riscv_flush_icache to never build. I've build tested this on allnoconfig and allnoconfig+SMP=y, as well as defconfig like normal.

Would't it make sense to use COND_SYSCALL to stub out the syscall for !SMP builds?

I'm not sure. We can implement the syscall fine in !SMP, it's just that the vDSO is expected to always eat these calls because in non-SMP mode you can do a global fence.i by just doing a local fence.i (there's only one hart).

The original rationale behind not having the syscall in non-SMP mode was to limit the user ABI, but on looking again that seems like it's just a bit of extra complexity that doesn't help anything. It's already been demonstrated that nothing is checking the error because it's been silently slipping past userspace for six months, so the extra complexity seems like it'll just cause someone else to have to chase the bug in the future.

But I'm really OK either way. Is there a precedent for what to do here?

#4 lore raw

Re: [PATCH v3 1/2] RISC-V: Define sys_riscv_flush_icache when SMP=n

Quoted 11 lines · Palmer Dabbelt
Quoted 9 lines · Christoph Hellwig
Quoted 5 lines · Palmer Dabbelt

This would be necessary to make non-SMP builds work, but there is another error in the implementation of our syscall linkage that actually just causes sys_riscv_flush_icache to never build. I've build tested this on allnoconfig and allnoconfig+SMP=y, as well as defconfig like normal.

Would't it make sense to use COND_SYSCALL to stub out the syscall for !SMP builds?

Quoted 7 lines

I'm not sure. We can implement the syscall fine in !SMP, it's just that the vDSO is expected to always eat these calls because in non-SMP mode you can do a global fence.i by just doing a local fence.i (there's only one hart).

The original rationale behind not having the syscall in non-SMP mode was to limit the user ABI, but on looking again that seems like it's just a bit of extra complexity that doesn't help anything. It's already been demonstrated

Doesn't this mean that some userspace code will only run if the kernel was compiled for SMP ? I always thought that was unacceptable.

Guenter

Quoted 5 lines

that nothing is checking the error because it's been silently slipping past userspace for six months, so the extra complexity seems like it'll just cause someone else to have to chase the bug in the future.

But I'm really OK either way. Is there a precedent for what to do here?

#5 lore raw

Re: [PATCH v3 1/2] RISC-V: Define sys_riscv_flush_icache when SMP=n

Quoted 16 lines · linux at roeck-us.net
Quoted 15 lines · Palmer Dabbelt
Quoted 9 lines · Christoph Hellwig
Quoted 5 lines · Palmer Dabbelt

This would be necessary to make non-SMP builds work, but there is another error in the implementation of our syscall linkage that actually just causes sys_riscv_flush_icache to never build. I've build tested this on allnoconfig and allnoconfig+SMP=y, as well as defconfig like normal.

Would't it make sense to use COND_SYSCALL to stub out the syscall for !SMP builds?

I'm not sure. We can implement the syscall fine in !SMP, it's just that the vDSO is expected to always eat these calls because in non-SMP mode you can do a global fence.i by just doing a local fence.i (there's only one hart).

Quoted 6 lines
Quoted 3 lines

The original rationale behind not having the syscall in non-SMP mode was to limit the user ABI, but on looking again that seems like it's just a bit of extra complexity that doesn't help anything. It's already been demonstrated

Doesn't this mean that some userspace code will only run if the kernel was compiled for SMP ? I always thought that was unacceptable.

Well, the officially sanctioned way to obtain this functionality is via a vDSO call. On non-SMP systems it will never make the system call. As a result we thought we'd keep it out of the ABI, but after looking again it seems yucky to do so. Here's the vDSO entry, for reference:

    ENTRY(__vdso_flush_icache)
            .cfi_startproc
    #ifdef CONFIG_SMP
            li a7, __NR_riscv_flush_icache
            ecall
    #else
            fence.i
            li a0, 0
    #endif
            ret
            .cfi_endproc
    ENDPROC(__vdso_flush_icache)

Note that glibc has a fallback to make the system call if it can't find the vDSO entry, but then doesn't have a secondary fallback to emit a local fence.i if the system call doesn't exist. It seems easier to fix the kernel to always provide the syscall and just call it a bug.

#6 lore raw

Re: [PATCH v3 1/2] RISC-V: Define sys_riscv_flush_icache when SMP=n

In reply to Palmer Dabbelt
Quoted 4 lines · Palmer Dabbelt

I'm not sure. We can implement the syscall fine in !SMP, it's just that the vDSO is expected to always eat these calls because in non-SMP mode you can do a global fence.i by just doing a local fence.i (there's only one hart).

Quoted 8 lines

The original rationale behind not having the syscall in non-SMP mode was to limit the user ABI, but on looking again that seems like it's just a bit of extra complexity that doesn't help anything. It's already been demonstrated that nothing is checking the error because it's been silently slipping past userspace for six months, so the extra complexity seems like it'll just cause someone else to have to chase the bug in the future.

But I'm really OK either way. Is there a precedent for what to do here?

I don't know of any.

Tested-by on v3 1/2
#7 lore raw

Re: [PATCH v3 1/2] RISC-V: Define sys_riscv_flush_icache when SMP=n

In reply to Palmer Dabbelt
Quoted 11 lines · Palmer Dabbelt

This would be necessary to make non-SMP builds work, but there is another error in the implementation of our syscall linkage that actually just causes sys_riscv_flush_icache to never build. I've build tested this on allnoconfig and allnoconfig+SMP=y, as well as defconfig like normal.

CC: Christoph Hellwig <[email protected]>
CC: Guenter Roeck <[email protected]>
In-Reply-To: <[email protected]>
In-Reply-To: <[email protected]>

Quoted 59 lines
---
 arch/riscv/include/asm/vdso.h |  2 --
 arch/riscv/kernel/sys_riscv.c | 12 ++++++++++--
 2 files changed, 10 insertions(+), 4 deletions(-)
arch/riscv/include/asm/vdso.h +0 -2
index 541544d64c33..ec6180a4b55d 100644
@@ -38,8 +38,6 @@ struct vdso_data {
 	(void __user *)((unsigned long)(base) + __vdso_##name);			\
 })
 
-#ifdef CONFIG_SMP
 asmlinkage long sys_riscv_flush_icache(uintptr_t, uintptr_t, uintptr_t);
-#endif
 
 #endif /* _ASM_RISCV_VDSO_H */
arch/riscv/kernel/sys_riscv.c +10 -2
index f7181ed8aafc..568026ccf6e8 100644
@@ -48,7 +48,6 @@ SYSCALL_DEFINE6(mmap2, unsigned long, addr, unsigned long, len,
 }
 #endif /* !CONFIG_64BIT */
 
-#ifdef CONFIG_SMP
 /*
  * Allows the instruction cache to be flushed from userspace.  Despite RISC-V
  * having a direct 'fence.i' instruction available to userspace (which we
@@ -66,15 +65,24 @@ SYSCALL_DEFINE6(mmap2, unsigned long, addr, unsigned long, len,
 SYSCALL_DEFINE3(riscv_flush_icache, uintptr_t, start, uintptr_t, end,
 	uintptr_t, flags)
 {
+#ifdef CONFIG_SMP
 	struct mm_struct *mm = current->mm;
 	bool local = (flags & SYS_RISCV_FLUSH_ICACHE_LOCAL) != 0;
+#endif
 
 	/* Check the reserved flags. */
 	if (unlikely(flags & ~SYS_RISCV_FLUSH_ICACHE_ALL))
 		return -EINVAL;
 
+	/*
+	 * Without CONFIG_SMP flush_icache_mm is a just a flush_icache_all(),
+	 * which generates unused variable warnings all over this function.
+	 */
+#ifdef CONFIG_SMP
 	flush_icache_mm(mm, local);
+#else
+	flush_icache_all();
+#endif
 
 	return 0;
 }
-#endif
Signature · 1 line
2.16.4
#8 lore raw

Re: [PATCH v3 1/2] RISC-V: Define sys_riscv_flush_icache when SMP=n

In reply to Palmer Dabbelt
Quoted 11 lines

SYSCALL_DEFINE3(riscv_flush_icache, uintptr_t, start, uintptr_t, end,

arch/riscv/kernel/sys_riscv.c +2 -0
 	uintptr_t, flags)
 {
+#ifdef CONFIG_SMP
 	struct mm_struct *mm = current->mm;
 	bool local = (flags & SYS_RISCV_FLUSH_ICACHE_LOCAL) != 0;
+#endif
 
 	/* Check the reserved flags. */
 	if (unlikely(flags & ~SYS_RISCV_FLUSH_ICACHE_ALL))
 		return -EINVAL;

arch/riscv/kernel/sys_riscv.c SYSCALL_DEFINE6(mmap2, unsigned long, addr, unsigned long, len, · line 85

Quoted 10 lines
arch/riscv/kernel/sys_riscv.c +8 -0
 
+	/*
+	 * Without CONFIG_SMP flush_icache_mm is a just a flush_icache_all(),
+	 * which generates unused variable warnings all over this function.
+	 */
+#ifdef CONFIG_SMP
 	flush_icache_mm(mm, local);
+#else
+	flush_icache_all();
+#endif

Eeek.

Something like an unconditional:

	flush_icache_mm(current->mm, flags & SYS_RISCV_FLUSH_ICACHE_LOCAL);

should solve those issues.

Also in the longer run we should turn the !SMP flush_icache_mm stub into an inline function to solve this problem for all potential callers. Excepte that flush_icache_mm happens to be a RISC-V specific API without any other callers. So for now I think the above is what I'd do, but this area has a lot of room for cleanup.

#9 lore raw

Re: [PATCH v3 1/2] RISC-V: Define sys_riscv_flush_icache when SMP=n

Quoted 28 lines · Christoph Hellwig
Quoted 11 lines

SYSCALL_DEFINE3(riscv_flush_icache, uintptr_t, start, uintptr_t, end,

arch/riscv/kernel/sys_riscv.c +2 -0
 	uintptr_t, flags)
 {
+#ifdef CONFIG_SMP
 	struct mm_struct *mm = current->mm;
 	bool local = (flags & SYS_RISCV_FLUSH_ICACHE_LOCAL) != 0;
+#endif
 
 	/* Check the reserved flags. */
 	if (unlikely(flags & ~SYS_RISCV_FLUSH_ICACHE_ALL))
 		return -EINVAL;

arch/riscv/kernel/sys_riscv.c SYSCALL_DEFINE6(mmap2, unsigned long, addr, unsigned long, len, · line 85

Quoted 10 lines
arch/riscv/kernel/sys_riscv.c +8 -0
 
+	/*
+	 * Without CONFIG_SMP flush_icache_mm is a just a flush_icache_all(),
+	 * which generates unused variable warnings all over this function.
+	 */
+#ifdef CONFIG_SMP
 	flush_icache_mm(mm, local);
+#else
+	flush_icache_all();
+#endif

Eeek.

Something like an unconditional:

	flush_icache_mm(current->mm, flags & SYS_RISCV_FLUSH_ICACHE_LOCAL);
Quoted 7 lines

should solve those issues.

Also in the longer run we should turn the !SMP flush_icache_mm stub into an inline function to solve this problem for all potential callers. Excepte that flush_icache_mm happens to be a RISC-V specific API without any other callers. So for now I think the above is what I'd do, but this area has a lot of room for cleanup.

Thanks, that's a lot cleaner. I missed this for the PR, but I'll submit a cleanup patch after RC1.

#10 lore raw

PATCH v3 2/2 RISC-V: Don't use a global include guard for uapi/asm/syscalls.h

In reply to Palmer Dabbelt

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
index 080fb28061de..0caea01d5cca 100644
@@ -11,6 +11,11 @@
  *   GNU General Public License for more details.
  */
 
+/*
+ * There is explicitly no include guard here because this file is expected to
+ * be 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
index 818655b0d535..690beb002d1d 100644
@@ -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
Tested-by on v3 2/2
#11 lore raw

Re: [PATCH v3 2/2] RISC-V: Don't use a global include guard for uapi/asm/syscalls.h

Quoted 10 lines · Palmer Dabbelt

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!

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.

Quoted 56 lines
---
 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
index 080fb28061de..0caea01d5cca 100644
@@ -11,6 +11,11 @@
  *   GNU General Public License for more details.
  */
 
+/*
+ * There is explicitly no include guard here because this file is expected to
+ * be 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
index 818655b0d535..690beb002d1d 100644
@@ -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
#12 lore raw

Re: [PATCH v3 2/2] RISC-V: Don't use a global include guard for uapi/asm/syscalls.h

In reply to Palmer Dabbelt

arch/riscv/include/uapi/asm/syscalls.h line 1

Quoted 6 lines

index 818655b0d535..690beb002d1d 100644

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

/* ... */ is the right style SPDX tag for headers, so please keep it as-is.

#13 lore raw

Re: [PATCH v3 2/2] RISC-V: Don't use a global include guard for uapi/asm/syscalls.h

Quoted 9 lines · Christoph Hellwig

arch/riscv/include/uapi/asm/syscalls.h line 1

Quoted 6 lines

index 818655b0d535..690beb002d1d 100644

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

/* ... */ is the right style SPDX tag for headers, so please keep it as-is.

Thanks, I didn't miss this one so I managed to fix it before the PR!