Skip to contentSkip to conversation

sh: Implement _THIS_IP_ using inline asm

PATCH In review Marco Elver 2 participants 2 messages May 21 SuperH

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 sh: Implement _THIS_IP_ using inline asm

Both GCC [1] and Clang [2] consider the generic version of _THIS_IP_ to be broken:

        #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })

In particular, the address of a label is only expected to be used with a computed goto.

While the generic version more or less works today, it is known to be brittle and may break with current and future optimizations. For example, Clang -O2 always returns 1 when this function is inlined:

static inline unsigned long get_ip(void)
{ return ({ __label__ __here; __here: (unsigned long)&&__here; }); }

Fix it by overriding _THIS_IP_ in <asm/linkage.h> (which is included by <linux/instruction_pointer.h>) using an architecture-specific inline asm version. Additionally, avoiding taking the address of a label prevents compilers from emitting spurious indirect branch targets (e.g. ENDBR or BTI) under control-flow integrity schemes.

---
 arch/sh/include/asm/linkage.h | 2 ++
 1 file changed, 2 insertions(+)
arch/sh/include/asm/linkage.h +2 -0
index 7c2fa27a43f8..af56b38b6001 100644
@@ -5,4 +5,6 @@
 #define __ALIGN .balign 4
 #define __ALIGN_STR ".balign 4"
 
+#define _THIS_IP_ ({ unsigned long __ip; asm volatile("mova 1f, %0\n1:" : "=z" (__ip)); __ip; })
+
 #endif
Signature · 1 line
2.54.0.746.g67dd491aae-goog
maintainer
#1 lore raw
Quoted 41 lines · Marco Elver

Both GCC [1] and Clang [2] consider the generic version of _THIS_IP_ to be broken:

        #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })

In particular, the address of a label is only expected to be used with a computed goto.

While the generic version more or less works today, it is known to be brittle and may break with current and future optimizations. For example, Clang -O2 always returns 1 when this function is inlined:

static inline unsigned long get_ip(void)
{ return ({ __label__ __here; __here: (unsigned long)&&__here; }); }

Fix it by overriding _THIS_IP_ in <asm/linkage.h> (which is included by <linux/instruction_pointer.h>) using an architecture-specific inline asm version. Additionally, avoiding taking the address of a label prevents compilers from emitting spurious indirect branch targets (e.g. ENDBR or BTI) under control-flow integrity schemes.

---
 arch/sh/include/asm/linkage.h | 2 ++
 1 file changed, 2 insertions(+)
arch/sh/include/asm/linkage.h +2 -0
index 7c2fa27a43f8..af56b38b6001 100644
@@ -5,4 +5,6 @@
 #define __ALIGN .balign 4
 #define __ALIGN_STR ".balign 4"
 
+#define _THIS_IP_ ({ unsigned long __ip; asm volatile("mova 1f, %0\n1:" : "=z" (__ip)); __ip; })
+
 #endif
Signature · 1 line
2.54.0.746.g67dd491aae-goog

Does this need an alignment directive before the label? mova can only emit 32-bit-aligned addresses, and I think the assembler will complain (since you'll be getting the wrong result) if the address isn't aligned.

Rich