1 // SPDX-License-Identifier: GPL-2.0-only
3 * fsgsbase.c, an fsgsbase test
4 * Copyright (c) 2014-2016 Andy Lutomirski
12 #include <sys/syscall.h>
16 #include <asm/prctl.h>
17 #include <sys/prctl.h>
20 #include <sys/ucontext.h>
22 #include <linux/futex.h>
27 #include <sys/ptrace.h>
32 # error This test is 64-bit only
35 static volatile sig_atomic_t want_segv
;
36 static volatile unsigned long segv_addr
;
38 static unsigned short *shared_scratch
;
42 static void sethandler(int sig
, void (*handler
)(int, siginfo_t
*, void *),
46 memset(&sa
, 0, sizeof(sa
));
47 sa
.sa_sigaction
= handler
;
48 sa
.sa_flags
= SA_SIGINFO
| flags
;
49 sigemptyset(&sa
.sa_mask
);
50 if (sigaction(sig
, &sa
, 0))
54 static void clearhandler(int sig
)
57 memset(&sa
, 0, sizeof(sa
));
58 sa
.sa_handler
= SIG_DFL
;
59 sigemptyset(&sa
.sa_mask
);
60 if (sigaction(sig
, &sa
, 0))
64 static void sigsegv(int sig
, siginfo_t
*si
, void *ctx_void
)
66 ucontext_t
*ctx
= (ucontext_t
*)ctx_void
;
69 clearhandler(SIGSEGV
);
70 return; /* Crash cleanly. */
74 segv_addr
= (unsigned long)si
->si_addr
;
76 ctx
->uc_mcontext
.gregs
[REG_RIP
] += 4; /* Skip the faulting mov */
80 static jmp_buf jmpbuf
;
82 static void sigill(int sig
, siginfo_t
*si
, void *ctx_void
)
84 siglongjmp(jmpbuf
, 1);
87 static bool have_fsgsbase
;
89 static inline unsigned long rdgsbase(void)
93 asm volatile("rdgsbase %0" : "=r" (gsbase
) :: "memory");
98 static inline unsigned long rdfsbase(void)
100 unsigned long fsbase
;
102 asm volatile("rdfsbase %0" : "=r" (fsbase
) :: "memory");
107 static inline void wrgsbase(unsigned long gsbase
)
109 asm volatile("wrgsbase %0" :: "r" (gsbase
) : "memory");
112 static inline void wrfsbase(unsigned long fsbase
)
114 asm volatile("wrfsbase %0" :: "r" (fsbase
) : "memory");
117 enum which_base
{ FS
, GS
};
119 static unsigned long read_base(enum which_base which
)
121 unsigned long offset
;
123 * Unless we have FSGSBASE, there's no direct way to do this from
124 * user mode. We can get at it indirectly using signals, though.
131 /* Use a constant-length instruction here. */
132 asm volatile ("mov %%fs:(%%rcx), %%rax" : : "c" (offset
) : "rax");
134 asm volatile ("mov %%gs:(%%rcx), %%rax" : : "c" (offset
) : "rax");
137 return segv_addr
+ offset
;
140 * If that didn't segfault, try the other end of the address space.
141 * Unless we get really unlucky and run into the vsyscall page, this
142 * is guaranteed to segfault.
145 offset
= (ULONG_MAX
>> 1) + 1;
147 asm volatile ("mov %%fs:(%%rcx), %%rax"
148 : : "c" (offset
) : "rax");
150 asm volatile ("mov %%gs:(%%rcx), %%rax"
151 : : "c" (offset
) : "rax");
154 return segv_addr
+ offset
;
159 static void check_gs_value(unsigned long value
)
164 printf("[RUN]\tARCH_SET_GS to 0x%lx\n", value
);
165 if (syscall(SYS_arch_prctl
, ARCH_SET_GS
, value
) != 0)
166 err(1, "ARCH_SET_GS");
168 asm volatile ("mov %%gs, %0" : "=rm" (sel
));
169 base
= read_base(GS
);
171 printf("[OK]\tGSBASE was set as expected (selector 0x%hx)\n",
175 printf("[FAIL]\tGSBASE was not as expected: got 0x%lx (selector 0x%hx)\n",
179 if (syscall(SYS_arch_prctl
, ARCH_GET_GS
, &base
) != 0)
180 err(1, "ARCH_GET_GS");
182 printf("[OK]\tARCH_GET_GS worked as expected (selector 0x%hx)\n",
186 printf("[FAIL]\tARCH_GET_GS was not as expected: got 0x%lx (selector 0x%hx)\n",
191 static void mov_0_gs(unsigned long initial_base
, bool schedule
)
193 unsigned long base
, arch_base
;
195 printf("[RUN]\tARCH_SET_GS to 0x%lx then mov 0 to %%gs%s\n", initial_base
, schedule
? " and schedule " : "");
196 if (syscall(SYS_arch_prctl
, ARCH_SET_GS
, initial_base
) != 0)
197 err(1, "ARCH_SET_GS");
202 asm volatile ("mov %0, %%gs" : : "rm" (0));
203 base
= read_base(GS
);
204 if (syscall(SYS_arch_prctl
, ARCH_GET_GS
, &arch_base
) != 0)
205 err(1, "ARCH_GET_GS");
206 if (base
== arch_base
) {
207 printf("[OK]\tGSBASE is 0x%lx\n", base
);
210 printf("[FAIL]\tGSBASE changed to 0x%lx but kernel reports 0x%lx\n", base
, arch_base
);
214 static volatile unsigned long remote_base
;
215 static volatile bool remote_hard_zero
;
216 static volatile unsigned int ftx
;
219 * ARCH_SET_FS/GS(0) may or may not program a selector of zero. HARD_ZERO
220 * means to force the selector to zero to improve test coverage.
222 #define HARD_ZERO 0xa1fa5f343cb85fa4
224 static void do_remote_base()
226 unsigned long to_set
= remote_base
;
227 bool hard_zero
= false;
228 if (to_set
== HARD_ZERO
) {
233 if (syscall(SYS_arch_prctl
, ARCH_SET_GS
, to_set
) != 0)
234 err(1, "ARCH_SET_GS");
237 asm volatile ("mov %0, %%gs" : : "rm" ((unsigned short)0));
240 asm volatile ("mov %%gs, %0" : "=rm" (sel
));
241 printf("\tother thread: ARCH_SET_GS(0x%lx)%s -- sel is 0x%hx\n",
242 to_set
, hard_zero
? " and clear gs" : "", sel
);
245 static __thread
int set_thread_area_entry_number
= -1;
247 static unsigned short load_gs(void)
250 * Sets GS != 0 and GSBASE != 0 but arranges for the kernel to think
251 * that GSBASE == 0 (i.e. thread.gsbase == 0).
254 /* Step 1: tell the kernel that we have GSBASE == 0. */
255 if (syscall(SYS_arch_prctl
, ARCH_SET_GS
, 0) != 0)
256 err(1, "ARCH_SET_GS");
258 /* Step 2: change GSBASE without telling the kernel. */
259 struct user_desc desc
= {
261 .base_addr
= 0xBAADF00D,
264 .contents
= 0, /* Data, grow-up */
267 .seg_not_present
= 0,
270 if (syscall(SYS_modify_ldt
, 1, &desc
, sizeof(desc
)) == 0) {
271 printf("\tusing LDT slot 0\n");
272 asm volatile ("mov %0, %%gs" : : "rm" ((unsigned short)0x7));
275 /* No modify_ldt for us (configured out, perhaps) */
277 struct user_desc
*low_desc
= mmap(
279 PROT_READ
| PROT_WRITE
,
280 MAP_PRIVATE
| MAP_ANONYMOUS
| MAP_32BIT
, -1, 0);
281 memcpy(low_desc
, &desc
, sizeof(desc
));
283 low_desc
->entry_number
= set_thread_area_entry_number
;
285 /* 32-bit set_thread_area */
287 asm volatile ("int $0x80"
288 : "=a" (ret
), "+m" (*low_desc
)
289 : "a" (243), "b" (low_desc
)
290 : "r8", "r9", "r10", "r11");
291 memcpy(&desc
, low_desc
, sizeof(desc
));
292 munmap(low_desc
, sizeof(desc
));
295 printf("[NOTE]\tcould not create a segment -- test won't do anything\n");
298 printf("\tusing GDT slot %d\n", desc
.entry_number
);
299 set_thread_area_entry_number
= desc
.entry_number
;
301 unsigned short gs
= (unsigned short)((desc
.entry_number
<< 3) | 0x3);
302 asm volatile ("mov %0, %%gs" : : "rm" (gs
));
307 void test_wrbase(unsigned short index
, unsigned long base
)
309 unsigned short newindex
;
310 unsigned long newbase
;
312 printf("[RUN]\tGS = 0x%hx, GSBASE = 0x%lx\n", index
, base
);
314 asm volatile ("mov %0, %%gs" : : "rm" (index
));
319 syscall(SYS_futex
, &ftx
, FUTEX_WAKE
, 0, NULL
, NULL
, 0);
321 syscall(SYS_futex
, &ftx
, FUTEX_WAIT
, 1, NULL
, NULL
, 0);
323 asm volatile ("mov %%gs, %0" : "=rm" (newindex
));
324 newbase
= rdgsbase();
326 if (newindex
== index
&& newbase
== base
) {
327 printf("[OK]\tIndex and base were preserved\n");
329 printf("[FAIL]\tAfter switch, GS = 0x%hx and GSBASE = 0x%lx\n",
335 static void *threadproc(void *ctx
)
339 syscall(SYS_futex
, &ftx
, FUTEX_WAIT
, 0, NULL
, NULL
, 0);
345 } else if (ftx
== 2) {
347 * On AMD chips, this causes GSBASE != 0, GS == 0, and
348 * thread.gsbase == 0.
352 asm volatile ("mov %0, %%gs" : : "rm" ((unsigned short)0));
354 errx(1, "helper thread got bad command");
358 syscall(SYS_futex
, &ftx
, FUTEX_WAKE
, 0, NULL
, NULL
, 0);
362 static void set_gs_and_switch_to(unsigned long local
,
363 unsigned short force_sel
,
364 unsigned long remote
)
367 unsigned short sel_pre_sched
, sel_post_sched
;
369 bool hard_zero
= false;
370 if (local
== HARD_ZERO
) {
375 printf("[RUN]\tARCH_SET_GS(0x%lx)%s, then schedule to 0x%lx\n",
376 local
, hard_zero
? " and clear gs" : "", remote
);
378 printf("\tBefore schedule, set selector to 0x%hx\n", force_sel
);
379 if (syscall(SYS_arch_prctl
, ARCH_SET_GS
, local
) != 0)
380 err(1, "ARCH_SET_GS");
382 asm volatile ("mov %0, %%gs" : : "rm" ((unsigned short)0));
384 if (read_base(GS
) != local
) {
386 printf("[FAIL]\tGSBASE wasn't set as expected\n");
390 asm volatile ("mov %0, %%gs" : : "rm" (force_sel
));
391 sel_pre_sched
= force_sel
;
392 local
= read_base(GS
);
395 * Signal delivery is quite likely to change a selector
396 * of 1, 2, or 3 back to 0 due to IRET being defective.
398 asm volatile ("mov %0, %%gs" : : "rm" (force_sel
));
400 asm volatile ("mov %%gs, %0" : "=rm" (sel_pre_sched
));
403 remote_base
= remote
;
405 syscall(SYS_futex
, &ftx
, FUTEX_WAKE
, 0, NULL
, NULL
, 0);
407 syscall(SYS_futex
, &ftx
, FUTEX_WAIT
, 1, NULL
, NULL
, 0);
409 asm volatile ("mov %%gs, %0" : "=rm" (sel_post_sched
));
410 base
= read_base(GS
);
411 if (base
== local
&& sel_pre_sched
== sel_post_sched
) {
412 printf("[OK]\tGS/BASE remained 0x%hx/0x%lx\n",
413 sel_pre_sched
, local
);
414 } else if (base
== local
&& sel_pre_sched
>= 1 && sel_pre_sched
<= 3 &&
415 sel_post_sched
== 0) {
417 * IRET is misdesigned and will squash selectors 1, 2, or 3
418 * to zero. Don't fail the test just because this happened.
420 printf("[OK]\tGS/BASE changed from 0x%hx/0x%lx to 0x%hx/0x%lx because IRET is defective\n",
421 sel_pre_sched
, local
, sel_post_sched
, base
);
424 printf("[FAIL]\tGS/BASE changed from 0x%hx/0x%lx to 0x%hx/0x%lx\n",
425 sel_pre_sched
, local
, sel_post_sched
, base
);
429 static void test_unexpected_base(void)
433 printf("[RUN]\tARCH_SET_GS(0), clear gs, then manipulate GSBASE in a different thread\n");
434 if (syscall(SYS_arch_prctl
, ARCH_SET_GS
, 0) != 0)
435 err(1, "ARCH_SET_GS");
436 asm volatile ("mov %0, %%gs" : : "rm" ((unsigned short)0));
439 syscall(SYS_futex
, &ftx
, FUTEX_WAKE
, 0, NULL
, NULL
, 0);
441 syscall(SYS_futex
, &ftx
, FUTEX_WAIT
, 1, NULL
, NULL
, 0);
443 base
= read_base(GS
);
445 printf("[OK]\tGSBASE remained 0\n");
448 printf("[FAIL]\tGSBASE changed to 0x%lx\n", base
);
452 #define USER_REGS_OFFSET(r) offsetof(struct user_regs_struct, r)
454 static void test_ptrace_write_gs_read_base(void)
457 pid_t child
= fork();
463 printf("[RUN]\tPTRACE_POKE GS, read GSBASE back\n");
465 printf("[RUN]\tARCH_SET_GS to 1\n");
466 if (syscall(SYS_arch_prctl
, ARCH_SET_GS
, 1) != 0)
467 err(1, "ARCH_SET_GS");
469 if (ptrace(PTRACE_TRACEME
, 0, NULL
, NULL
) != 0)
470 err(1, "PTRACE_TRACEME");
478 if (WSTOPSIG(status
) == SIGTRAP
) {
480 unsigned long gs_offset
= USER_REGS_OFFSET(gs
);
481 unsigned long base_offset
= USER_REGS_OFFSET(gs_base
);
483 /* Read the initial base. It should be 1. */
484 base
= ptrace(PTRACE_PEEKUSER
, child
, base_offset
, NULL
);
486 printf("[OK]\tGSBASE started at 1\n");
489 printf("[FAIL]\tGSBASE started at 0x%lx\n", base
);
492 printf("[RUN]\tSet GS = 0x7, read GSBASE\n");
494 /* Poke an LDT selector into GS. */
495 if (ptrace(PTRACE_POKEUSER
, child
, gs_offset
, 0x7) != 0)
496 err(1, "PTRACE_POKEUSER");
498 /* And read the base. */
499 base
= ptrace(PTRACE_PEEKUSER
, child
, base_offset
, NULL
);
501 if (base
== 0 || base
== 1) {
502 printf("[OK]\tGSBASE reads as 0x%lx with invalid GS\n", base
);
505 printf("[FAIL]\tGSBASE=0x%lx (should be 0 or 1)\n", base
);
509 ptrace(PTRACE_CONT
, child
, NULL
, NULL
);
512 if (!WIFEXITED(status
))
513 printf("[WARN]\tChild didn't exit cleanly.\n");
516 static void test_ptrace_write_gsbase(void)
519 pid_t child
= fork();
525 printf("[RUN]\tPTRACE_POKE(), write GSBASE from ptracer\n");
527 *shared_scratch
= load_gs();
529 if (ptrace(PTRACE_TRACEME
, 0, NULL
, NULL
) != 0)
530 err(1, "PTRACE_TRACEME");
538 if (WSTOPSIG(status
) == SIGTRAP
) {
539 unsigned long gs
, base
;
540 unsigned long gs_offset
= USER_REGS_OFFSET(gs
);
541 unsigned long base_offset
= USER_REGS_OFFSET(gs_base
);
543 gs
= ptrace(PTRACE_PEEKUSER
, child
, gs_offset
, NULL
);
545 if (gs
!= *shared_scratch
) {
547 printf("[FAIL]\tGS is not prepared with nonzero\n");
551 if (ptrace(PTRACE_POKEUSER
, child
, base_offset
, 0xFF) != 0)
552 err(1, "PTRACE_POKEUSER");
554 gs
= ptrace(PTRACE_PEEKUSER
, child
, gs_offset
, NULL
);
555 base
= ptrace(PTRACE_PEEKUSER
, child
, base_offset
, NULL
);
558 * In a non-FSGSBASE system, the nonzero selector will load
559 * GSBASE (again). But what is tested here is whether the
560 * selector value is changed or not by the GSBASE write in
563 if (gs
!= *shared_scratch
) {
565 printf("[FAIL]\tGS changed to %lx\n", gs
);
568 * On older kernels, poking a nonzero value into the
569 * base would zero the selector. On newer kernels,
570 * this behavior has changed -- poking the base
571 * changes only the base and, if FSGSBASE is not
572 * available, this may have no effect once the tracee
576 printf("\tNote: this is expected behavior on older kernels.\n");
577 } else if (have_fsgsbase
&& (base
!= 0xFF)) {
579 printf("[FAIL]\tGSBASE changed to %lx\n", base
);
581 printf("[OK]\tGS remained 0x%hx", *shared_scratch
);
583 printf(" and GSBASE changed to 0xFF");
589 ptrace(PTRACE_CONT
, child
, NULL
, NULL
);
591 if (!WIFEXITED(status
))
592 printf("[WARN]\tChild didn't exit cleanly.\n");
599 shared_scratch
= mmap(NULL
, 4096, PROT_READ
| PROT_WRITE
,
600 MAP_ANONYMOUS
| MAP_SHARED
, -1, 0);
602 /* Do these tests before we have an LDT. */
603 test_ptrace_write_gs_read_base();
606 sethandler(SIGILL
, sigill
, 0);
607 if (sigsetjmp(jmpbuf
, 1) == 0) {
609 have_fsgsbase
= true;
610 printf("\tFSGSBASE instructions are enabled\n");
612 printf("\tFSGSBASE instructions are disabled\n");
614 clearhandler(SIGILL
);
616 sethandler(SIGSEGV
, sigsegv
, 0);
620 check_gs_value(0x200000000);
622 check_gs_value(0x200000000);
625 for (int sched
= 0; sched
< 2; sched
++) {
626 mov_0_gs(0, !!sched
);
627 mov_0_gs(1, !!sched
);
628 mov_0_gs(0x200000000, !!sched
);
631 /* Set up for multithreading. */
636 if (sched_setaffinity(0, sizeof(cpuset
), &cpuset
) != 0)
637 err(1, "sched_setaffinity to CPU 0"); /* should never fail */
639 if (pthread_create(&thread
, 0, threadproc
, 0) != 0)
640 err(1, "pthread_create");
642 static unsigned long bases_with_hard_zero
[] = {
643 0, HARD_ZERO
, 1, 0x200000000,
646 for (int local
= 0; local
< 4; local
++) {
647 for (int remote
= 0; remote
< 4; remote
++) {
648 for (unsigned short s
= 0; s
< 5; s
++) {
649 unsigned short sel
= s
;
651 asm ("mov %%ss, %0" : "=rm" (sel
));
652 set_gs_and_switch_to(
653 bases_with_hard_zero
[local
],
655 bases_with_hard_zero
[remote
]);
660 test_unexpected_base();
665 asm volatile ("mov %%ss, %0" : "=rm" (ss
));
669 test_wrbase(0, 0x200000000);
670 test_wrbase(0, 0xffffffffffffffff);
673 test_wrbase(ss
, 0x200000000);
674 test_wrbase(ss
, 0xffffffffffffffff);
677 ftx
= 3; /* Kill the thread. */
678 syscall(SYS_futex
, &ftx
, FUTEX_WAKE
, 0, NULL
, NULL
, 0);
680 if (pthread_join(thread
, NULL
) != 0)
681 err(1, "pthread_join");
683 test_ptrace_write_gsbase();
685 return nerrs
== 0 ? 0 : 1;