MIPS: Don't declare __current_thread_info globally
Subsystems (2)
PATCH 1/1 MIPS: Don't declare __current_thread_info globally
Declaring __current_thread_info as a global register variable has the effect of preventing GCC from saving & restoring its value in cases where the ABI would typically do so.
To quote GCC documentation:
Quoted 4 lines
If the register is a call-saved register, call ABI is affected: the register will not be restored in function epilogue sequences after the variable has been assigned. Therefore, functions cannot safely return to callers that assume standard ABI.
When our position independent VDSO is built for the n32 or n64 ABIs all functions it exposes should be preserving the value of $gp/$28 for their caller, but in the presence of the __current_thread_info global register variable GCC stops doing so & simply clobbers $gp/$28 when calculating the address of the GOT.
In cases where the VDSO returns success this problem will typically be masked by the caller in libc returning & restoring $gp/$28 itself, but that is by no means guaranteed. In cases where the VDSO returns an error libc will typically contain a fallback path which will now fail (typically with a bad memory access) if it attempts anything which relies upon the value of $gp/$28 - eg. accessing anything via the GOT.
Fix this by moving the declaration of __current_thread_info inside the current_thread_info() function, demoting it from global register variable to local register variable & avoiding inadvertently creating a non-standard calling ABI for the VDSO.
--- arch/mips/include/asm/thread_info.h | 4 ++-- arch/mips/kernel/relocate.c | 1 + 2 files changed, 3 insertions(+), 2 deletions(-)
arch/mips/include/asm/thread_info.h +2 -2
@@ -50,10 +50,10 @@ struct thread_info { }/* How to get the thread information struct from C. */ -registerstruct thread_info *__current_thread_info __asm__("$28" ); -static inline struct thread_info *current_thread_info (void ) { + registerstruct thread_info *__current_thread_info __asm__("$28" ); +return __current_thread_info; }
arch/mips/kernel/relocate.c +1 -0
@@ -296,6 +296,7 @@ static inline int __init relocation_addr_valid(void *loc_new)void *__init relocate_kernel (void ) { + registerstruct thread_info *__current_thread_info __asm__("$28" );void *loc_new;unsigned long kernel_length;unsigned long bss_length;
Signature · 1 line
2.24.0
Quoted 6 lines · Paul Burton
arch/mips/include/asm/thread_info.h +0
-0@@ -50,10 +50,10 @@ struct thread_info { }
arch/mips/include/asm/thread_info.h struct thread_info { · line 58
Quoted 10 lines
arch/mips/include/asm/thread_info.h +2
-2/* How to get the thread information struct from C. */ -registerstruct thread_info *__current_thread_info __asm__("$28" ); -static inline struct thread_info *current_thread_info (void ) { + registerstruct thread_info *__current_thread_info __asm__("$28" ); +return __current_thread_info; }
This looks like a nice fix, but are you sure it doesn't allow the compiler to reuse $28 for another purpose in the kernel under register pressure, which would break current_thread_info()?
I see in the MIPS ABI document that $28 is preserved across function calls, but I don't see any indication that a function is not allowed to modify it and later restore the original content.
Arnd
Quoted 22 lines · Arnd Bergmann
Quoted 6 lines · Paul Burton
arch/mips/include/asm/thread_info.h +0
-0@@ -50,10 +50,10 @@ struct thread_info { }arch/mips/include/asm/thread_info.h struct thread_info { · line 58
Quoted 10 lines
arch/mips/include/asm/thread_info.h +2
-2/* How to get the thread information struct from C. */ -registerstruct thread_info *__current_thread_info __asm__("$28" ); -static inline struct thread_info *current_thread_info (void ) { + registerstruct thread_info *__current_thread_info __asm__("$28" ); +return __current_thread_info; }This looks like a nice fix, but are you sure it doesn't allow the compiler to reuse $28 for another purpose in the kernel under register pressure, which would break
current_thread_info()?
Quoted 5 lines
I see in the MIPS ABI document that $28 is preserved across function calls, but I don't see any indication that a function is not allowed to modify it and later restore the original content.
Arnd
The compiler can already do that even with a global definition.
The doc since gcc 9 [1] says:
"Accesses to the variable may be optimized as usual and the register remains available for allocation and use in any computations, provided that observable values of the variable are not affected."
and
"Furthermore, since the register is not reserved exclusively for the variable, accessing it from handlers of asynchronous signals may observe unrelated temporary values residing in the register."
I'm not sure if this was a change in gcc 9 or simply the doc was wrong earlier.
Should there be a -ffixed-28 cflag for MIPS? alpha and hexagon seem to have that and they also keep current_thread_info in a register.
Also, commit fe92da0f355e9 ("MIPS: Changed current_thread_info() to an equivalent supported by both clang and GCC") moved this from local to global because local apparently didn't work on clang?
[1] https://gcc.gnu.org/onlinedocs/gcc-9.1.0/gcc/Global-Register-Variables.html
Quoted 46 lines · Arvind Sankar
Quoted 22 lines · Arnd Bergmann
Quoted 6 lines · Paul Burton
arch/mips/include/asm/thread_info.h +0
-0@@ -50,10 +50,10 @@ struct thread_info { }arch/mips/include/asm/thread_info.h struct thread_info { · line 58
Quoted 10 lines
arch/mips/include/asm/thread_info.h +2
-2/* How to get the thread information struct from C. */ -registerstruct thread_info *__current_thread_info __asm__("$28" ); -static inline struct thread_info *current_thread_info (void ) { + registerstruct thread_info *__current_thread_info __asm__("$28" ); +return __current_thread_info; }This looks like a nice fix, but are you sure it doesn't allow the compiler to reuse $28 for another purpose in the kernel under register pressure, which would break
current_thread_info()?Quoted 5 lines
I see in the MIPS ABI document that $28 is preserved across function calls, but I don't see any indication that a function is not allowed to modify it and later restore the original content.
Arnd
The compiler can already do that even with a global definition.
The doc since gcc 9 [1] says:
"Accesses to the variable may be optimized as usual and the register remains available for allocation and use in any computations, provided that observable values of the variable are not affected."
and
"Furthermore, since the register is not reserved exclusively for the variable, accessing it from handlers of asynchronous signals may observe unrelated temporary values residing in the register."
I'm not sure if this was a change in gcc 9 or simply the doc was wrong earlier.
Quoted 8 lines
Should there be a -ffixed-28 cflag for MIPS? alpha and hexagon seem to have that and they also keep
current_thread_infoin a register.Also, commit
fe92da0f355e9("MIPS: Changedcurrent_thread_info()to an equivalent supported by both clang and GCC") moved this from local to global because local apparently didn't work on clang?[1] https://gcc.gnu.org/onlinedocs/gcc-9.1.0/gcc/Global-Register-Variables.html
Yeah this patch appears to break booting malta_defconfig in QEMU when built with clang; additionally, there are a TON of warnings about this variable being uninitialized:
../arch/mips/include/asm/thread_info.h:57:9: warning: variable '__current_thread_info' is uninitialized when used here [-Wuninitialized]
return __current_thread_info;
^~~~~~~~~~~~~~~~~~~~~
../arch/mips/include/asm/thread_info.h:55:52: note: initialize the variable '__current_thread_info' to silence this warning
register struct thread_info *__current_thread_info __asm__("$28");
^
= NULL1 warning generated.
Seems like this is expected according to that previous commit? I noticed there is another instance in arch/mips but it doesn't appear to affect everything.
https://github.com/ClangBuiltLinux/linux/issues/606
Cheers,
Nathan
PATCH v2 1/1 MIPS: Avoid VDSO ABI breakage due to global register variable
In reply to Arvind SankarDeclaring __current_thread_info as a global register variable has the effect of preventing GCC from saving & restoring its value in cases where the ABI would typically do so.
To quote GCC documentation:
Quoted 4 lines
If the register is a call-saved register, call ABI is affected: the register will not be restored in function epilogue sequences after the variable has been assigned. Therefore, functions cannot safely return to callers that assume standard ABI.
When our position independent VDSO is built for the n32 or n64 ABIs all functions it exposes should be preserving the value of $gp/$28 for their caller, but in the presence of the __current_thread_info global register variable GCC stops doing so & simply clobbers $gp/$28 when calculating the address of the GOT.
In cases where the VDSO returns success this problem will typically be masked by the caller in libc returning & restoring $gp/$28 itself, but that is by no means guaranteed. In cases where the VDSO returns an error libc will typically contain a fallback path which will now fail (typically with a bad memory access) if it attempts anything which relies upon the value of $gp/$28 - eg. accessing anything via the GOT.
One fix for this would be to move the declaration of __current_thread_info inside the current_thread_info() function, demoting it from global register variable to local register variable & avoiding inadvertently creating a non-standard calling ABI for the VDSO. Unfortunately this causes issues for clang, which doesn't support local register variables as pointed out by commit fe92da0f355e ("MIPS: Changed current_thread_info() to an equivalent supported by both clang and GCC") which introduced the global register variable before we had a VDSO to worry about.
Instead, fix this by continuing to use the global register variable for the kernel proper but declare __current_thread_info as a simple extern variable when building the VDSO. It should never be referenced, and will cause a link error if it is. This resolves the calling convention issue for the VDSO without having any impact upon the build of the kernel itself for either clang or gcc.
---
Changes in v2:
- Switch to the #ifdef __VDSO__ approach rather than using a local register variable which clang doesn't support.
--- arch/mips/include/asm/thread_info.h | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-)
arch/mips/include/asm/thread_info.h +19 -1
@@ -49,8 +49,26 @@ struct thread_info { .addr_limit = KERNEL_DS, \ } -/* How to get the thread information struct from C. */ +/* +* A pointer to the struct thread_info for the currently executing thread is +* held in register $28/$gp. +* +* We declare __current_thread_info as a global register variable rather than a +* local register variable within current_thread_info() because clang doesn't +* support explicit local register variables. +* +* When building the VDSO we take care not to declare the global register +* variable because this causes GCC to not preserve the value of $28/$gp in +* functions that change its value (which is common in the PIC VDSO when +* accessing the GOT). Since the VDSO shouldn't be accessing +* __current_thread_info anyway we declare it extern in order to cause a link +* failure if it's referenced. +*/ +#ifdef __VDSO__ +extern struct thread_info *__current_thread_info; +#else registerstruct thread_info *__current_thread_info __asm__("$28" ); +#endif static inline struct thread_info *current_thread_info (void ) {
Signature · 1 line
2.24.1
Re: [PATCH v2] MIPS: Avoid VDSO ABI breakage due to global register variable
Thanks, looks good to me:
or
Re: [PATCH v2] MIPS: Avoid VDSO ABI breakage due to global register variable
In reply to Paul BurtonHi Paul,
Happy new year.
Quoted 17 lines · Paul Burton
Declaring
__current_thread_infoas a global register variable has the effect of preventing GCC from saving & restoring its value in cases where the ABI would typically do so.To quote GCC documentation:
Quoted 4 lines
If the register is a call-saved register, call ABI is affected: the register will not be restored in function epilogue sequences after the variable has been assigned. Therefore, functions cannot safely return to callers that assume standard ABI.
When our position independent VDSO is built for the n32 or n64 ABIs all functions it exposes should be preserving the value of $gp/$28 for their caller, but in the presence of the
__current_thread_infoglobal register variable GCC stops doing so & simply clobbers $gp/$28 when calculating the address of the GOT.
Quoted 7 lines
In cases where the VDSO returns success this problem will typically be masked by the caller in libc returning & restoring $gp/$28 itself, but that is by no means guaranteed. In cases where the VDSO returns an error libc will typically contain a fallback path which will now fail (typically with a bad memory access) if it attempts anything which relies upon the value of $gp/$28 - eg. accessing anything via the GOT.
First of all good catch. I just came back from holidays and seems that you guys had fun without me :)
Did you consider the option to use "-ffixed-gp -ffixed-28" as a compilation flags for the vDSO library (Arvind was mentioning it as well in his reply)? According to the GCC manual "treats the register as a fixed register; generated code should never refer to it"
(https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options)
I did some experiments this morning an seems that on MIPS the convention is not honored at least on GCC-9. Do you know who to contact to get it enabled/fixed in the compiler?
With this:
Quoted 65 lines
One fix for this would be to move the declaration of
__current_thread_infoinside thecurrent_thread_info()function, demoting it from global register variable to local register variable & avoiding inadvertently creating a non-standard calling ABI for the VDSO. Unfortunately this causes issues for clang, which doesn't support local register variables as pointed out by commitfe92da0f355e("MIPS: Changedcurrent_thread_info()to an equivalent supported by both clang and GCC") which introduced the global register variable before we had a VDSO to worry about.Instead, fix this by continuing to use the global register variable for the kernel proper but declare
__current_thread_infoas a simple extern variable when building the VDSO. It should never be referenced, and will cause a link error if it is. This resolves the calling convention issue for the VDSO without having any impact upon the build of the kernel itself for either clang or gcc.Signed-off-by Paul Burton <[email protected]>Reported-by "Jason A. Donenfeld" <[email protected]>Fixes ebb5e78cc634 ("MIPS: Initial implementation of a VDSO")Cc Arnd Bergmann <[email protected]>Cc Christian Brauner <[email protected]>Cc Vincenzo Frascino <[email protected]>Cc <[email protected]> # v4.4+---
Changes in v2:
- Switch to the #ifdef__VDSO__approach rather than using a local register variable which clang doesn't support.--- arch/mips/include/asm/thread_info.h | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-)arch/mips/include/asm/thread_info.h +19
-1@@ -49,8 +49,26 @@ struct thread_info { .addr_limit = KERNEL_DS, \ } -/* How to get the thread information struct from C. */ +/* +* A pointer to the struct thread_info for the currently executing thread is +* held in register $28/$gp. +* +* We declare __current_thread_info as a global register variable rather than a +* local register variable within current_thread_info() because clang doesn't +* support explicit local register variables. +* +* When building the VDSO we take care not to declare the global register +* variable because this causes GCC to not preserve the value of $28/$gp in +* functions that change its value (which is common in the PIC VDSO when +* accessing the GOT). Since the VDSO shouldn't be accessing +* __current_thread_info anyway we declare it extern in order to cause a link +* failure if it's referenced. +*/ +#ifdef __VDSO__ +extern struct thread_info *__current_thread_info; +#else registerstruct thread_info *__current_thread_info __asm__("$28" ); +#endif static inline struct thread_info *current_thread_info (void ) {
Signature · 2 lines
Regards, Vincenzo
Re: [PATCH v2] MIPS: Avoid VDSO ABI breakage due to global register variable
Hi Vincenzo,
Quoted 3 lines · Vincenzo Frascino
Hi Paul,
Happy new year.
Thanks; happy new year to you too!
Quoted 26 lines · Paul Burton
Quoted 17 lines
Declaring
__current_thread_infoas a global register variable has the effect of preventing GCC from saving & restoring its value in cases where the ABI would typically do so.To quote GCC documentation:
Quoted 4 lines
If the register is a call-saved register, call ABI is affected: the register will not be restored in function epilogue sequences after the variable has been assigned. Therefore, functions cannot safely return to callers that assume standard ABI.
When our position independent VDSO is built for the n32 or n64 ABIs all functions it exposes should be preserving the value of $gp/$28 for their caller, but in the presence of the
__current_thread_infoglobal register variable GCC stops doing so & simply clobbers $gp/$28 when calculating the address of the GOT.Quoted 7 lines
In cases where the VDSO returns success this problem will typically be masked by the caller in libc returning & restoring $gp/$28 itself, but that is by no means guaranteed. In cases where the VDSO returns an error libc will typically contain a fallback path which will now fail (typically with a bad memory access) if it attempts anything which relies upon the value of $gp/$28 - eg. accessing anything via the GOT.
Quoted 2 lines
First of all good catch. I just came back from holidays and seems that you guys had fun without me :)
The fun never stops ;)
Quoted 6 lines
Did you consider the option to use "-ffixed-gp -ffixed-28" as a compilation flags for the vDSO library (Arvind was mentioning it as well in his reply)? According to the GCC manual "treats the register as a fixed register; generated code should never refer to it"
(https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options)
Quoted 8 lines
I did some experiments this morning an seems that on MIPS the convention is not honored at least on GCC-9. Do you know who to contact to get it enabled/fixed in the compiler?
With this:
Reviewed-by Vincenzo Frascino <[email protected]>Tested-by Vincenzo Frascino <[email protected]>
Using -ffixed-gp wouldn't be correct for the VDSO - the VDSO itself is position independent code, and will need to use $gp to access the GOT which is part of how position-independence is achieved (technically you could access the GOT using another register of course but you'd need some way to persuade the compiler to break with convention & you'd gain nothing meaningful since you'd need to use some other register anyway). If we use -ffixed-gp then we're telling GCC not to use $gp, and that doesn't make sense. If we consider -ffixed-gp as telling GCC not to use $gp as a general purpose register then it's meaningless because $gp already has a specific use & isn't used as a general purpose register. If we consider -ffixed-gp as telling GCC not to use $gp at all then it doesn't make sense because it needs to in order to access the GOT.
In terms of GCC's flags we'd want to use -fcall-saved-gp, but that would just be telling GCC information it already knows about the n32 & n64 ABIs & indeed it seems to have no effect at all on the way GCC handles the global register variable - it doesn't cause gcc to save & restore $gp with the global register variable present, so you gain nothing.
We could use -ffixed-gp for the kernel proper (& not the VDSO), but:
1) The kernel builds as non-PIC code with no $gp-based optimizations enabled, and since this has been fine forever it seems safe to expect the compiler not to start using $gp in new ways.
2) It would be a separate issue to fixing the VDSO anyway.
So I'll go ahead with the v2 patch without changing compiler flags for now.
Thanks,
Paul
Quoted 69 lines
Quoted 65 lines
One fix for this would be to move the declaration of
__current_thread_infoinside thecurrent_thread_info()function, demoting it from global register variable to local register variable & avoiding inadvertently creating a non-standard calling ABI for the VDSO. Unfortunately this causes issues for clang, which doesn't support local register variables as pointed out by commitfe92da0f355e("MIPS: Changedcurrent_thread_info()to an equivalent supported by both clang and GCC") which introduced the global register variable before we had a VDSO to worry about.Instead, fix this by continuing to use the global register variable for the kernel proper but declare
__current_thread_infoas a simple extern variable when building the VDSO. It should never be referenced, and will cause a link error if it is. This resolves the calling convention issue for the VDSO without having any impact upon the build of the kernel itself for either clang or gcc.Signed-off-by Paul Burton <[email protected]>Reported-by "Jason A. Donenfeld" <[email protected]>Fixes ebb5e78cc634 ("MIPS: Initial implementation of a VDSO")Cc Arnd Bergmann <[email protected]>Cc Christian Brauner <[email protected]>Cc Vincenzo Frascino <[email protected]>Cc <[email protected]> # v4.4+---
Changes in v2:
- Switch to the #ifdef__VDSO__approach rather than using a local register variable which clang doesn't support.--- arch/mips/include/asm/thread_info.h | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-)arch/mips/include/asm/thread_info.h +19
-1@@ -49,8 +49,26 @@ struct thread_info { .addr_limit = KERNEL_DS, \ } -/* How to get the thread information struct from C. */ +/* +* A pointer to the struct thread_info for the currently executing thread is +* held in register $28/$gp. +* +* We declare __current_thread_info as a global register variable rather than a +* local register variable within current_thread_info() because clang doesn't +* support explicit local register variables. +* +* When building the VDSO we take care not to declare the global register +* variable because this causes GCC to not preserve the value of $28/$gp in +* functions that change its value (which is common in the PIC VDSO when +* accessing the GOT). Since the VDSO shouldn't be accessing +* __current_thread_info anyway we declare it extern in order to cause a link +* failure if it's referenced. +*/ +#ifdef __VDSO__ +extern struct thread_info *__current_thread_info; +#else registerstruct thread_info *__current_thread_info __asm__("$28" ); +#endif static inline struct thread_info *current_thread_info (void ) {Signature · 2 lines
Regards, Vincenzo
Re: [PATCH v2] MIPS: Avoid VDSO ABI breakage due to global register variable
Hi Paul,
Quoted 19 lines · Paul Burton
Using -ffixed-gp wouldn't be correct for the VDSO - the VDSO itself is position independent code, and will need to use $gp to access the GOT which is part of how position-independence is achieved (technically you could access the GOT using another register of course but you'd need some way to persuade the compiler to break with convention & you'd gain nothing meaningful since you'd need to use some other register anyway). If we use -ffixed-gp then we're telling GCC not to use $gp, and that doesn't make sense. If we consider -ffixed-gp as telling GCC not to use $gp as a general purpose register then it's meaningless because $gp already has a specific use & isn't used as a general purpose register. If we consider -ffixed-gp as telling GCC not to use $gp at all then it doesn't make sense because it needs to in order to access the GOT.
In terms of GCC's flags we'd want to use -fcall-saved-gp, but that would just be telling GCC information it already knows about the n32 & n64 ABIs & indeed it seems to have no effect at all on the way GCC handles the global register variable - it doesn't cause gcc to save & restore $gp with the global register variable present, so you gain nothing.
Quoted 7 lines
We could use -ffixed-gp for the kernel proper (& not the VDSO), but:
1) The kernel builds as non-PIC code with no $gp-based optimizations enabled, and since this has been fine forever it seems safe to expect the compiler not to start using $gp in new ways.
2) It would be a separate issue to fixing the VDSO anyway.
Makes totally sense. Thanks for the explanation.
Signature · 2 lines
Regards, Vincenzo
Paul Burton
AppliedRe: [PATCH v2] MIPS: Avoid VDSO ABI breakage due to global register variable
In reply to Paul BurtonHello,
Quoted 34 lines · Paul Burton
Declaring
__current_thread_infoas a global register variable has the effect of preventing GCC from saving & restoring its value in cases where the ABI would typically do so.To quote GCC documentation:
Quoted 4 lines
If the register is a call-saved register, call ABI is affected: the register will not be restored in function epilogue sequences after the variable has been assigned. Therefore, functions cannot safely return to callers that assume standard ABI.
When our position independent VDSO is built for the n32 or n64 ABIs all functions it exposes should be preserving the value of $gp/$28 for their caller, but in the presence of the
__current_thread_infoglobal register variable GCC stops doing so & simply clobbers $gp/$28 when calculating the address of the GOT.In cases where the VDSO returns success this problem will typically be masked by the caller in libc returning & restoring $gp/$28 itself, but that is by no means guaranteed. In cases where the VDSO returns an error libc will typically contain a fallback path which will now fail (typically with a bad memory access) if it attempts anything which relies upon the value of $gp/$28 - eg. accessing anything via the GOT.
One fix for this would be to move the declaration of
__current_thread_infoinside thecurrent_thread_info()function, demoting it from global register variable to local register variable & avoiding inadvertently creating a non-standard calling ABI for the VDSO. Unfortunately this causes issues for clang, which doesn't support local register variables as pointed out by commitfe92da0f355e("MIPS: Changedcurrent_thread_info()to an equivalent supported by both clang and GCC") which introduced the global register variable before we had a VDSO to worry about.
Quoted 6 lines
Instead, fix this by continuing to use the global register variable for the kernel proper but declare
__current_thread_infoas a simple extern variable when building the VDSO. It should never be referenced, and will cause a link error if it is. This resolves the calling convention issue for the VDSO without having any impact upon the build of the kernel itself for either clang or gcc.
Applied to mips-fixes.
Quoted 8 lines
commit
bbcc5672b006
https://git.kernel.org/mips/c/bbcc5672b006Signed-off-by Paul Burton <[email protected]>Fixes ebb5e78cc634 ("MIPS: Initial implementation of a VDSO")Reported-by Jason A. Donenfeld <[email protected]>Reviewed-by Jason A. Donenfeld <[email protected]>Tested-by Jason A. Donenfeld <[email protected]>
Thanks,
Paul
[ This message was auto-generated; if you believe anything is incorrect
then please email [email protected] to report it. ]