src/runtime/x86-64-assem.S

   1 /*
   2  * very-low-level utilities for runtime support
   3  */
   4
   5 /*
   6  * This software is part of the SBCL system. See the README file for
   7  * more information.
   8  *
   9  * This software is derived from the CMU CL system, which was
  10  * written at Carnegie Mellon University and released into the
  11  * public domain. The software is in the public domain and is
  12  * provided with absolutely no warranty. See the COPYING and CREDITS
  13  * files for more information.
  14  */
  15 \f
  16 #define LANGUAGE_ASSEMBLY
  17 #include "genesis/config.h"
  18 #include "validate.h"
  19 #include "sbcl.h"
  20 #include "genesis/closure.h"
  21 #include "genesis/funcallable-instance.h"
  22 #include "genesis/fdefn.h"
  23 #include "genesis/static-symbols.h"
  24 #include "genesis/symbol.h"
  25 #include "genesis/thread.h"
  26
  27 /* Minimize conditionalization for different OS naming schemes. */
  28 #if defined __linux__  || defined __FreeBSD__ || defined __OpenBSD__ || defined __NetBSD__ || defined __sun || defined _WIN64
  29 #define GNAME(var) var
  30 #else
  31 #define GNAME(var) _##var
  32 #endif
  33
  34 /* Get the right type of alignment. Linux, FreeBSD and OpenBSD
  35  * want alignment in bytes. */
  36 #if defined(__linux__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined __NetBSD__ || defined(__sun) || defined _WIN64
  37 #define align_4byte     4
  38 #define align_8byte     8
  39 #define align_16byte    16
  40 #define align_32byte    32
  41 #define align_page      32768
  42 #else
  43 #define align_4byte     2
  44 #define align_8byte     3
  45 #define align_16byte    4
  46 #define align_page      15
  47 #endif
  48
  49 /*
  50  * The assembler used for win32 doesn't like .type or .size directives,
  51  * so we want to conditionally kill them out. So let's wrap them in macros
  52  * that are defined to be no-ops on win32. Hopefully this still works on
  53  * other platforms.
  54  */
  55 #if !defined(LISP_FEATURE_WIN32) && !defined(LISP_FEATURE_DARWIN)
  56 #define TYPE(name) .type name,@function
  57 #define SIZE(name) .size name,.-name
  58 #define DOLLAR(name) $(name)
  59 #else
  60 #define TYPE(name)
  61 #define SIZE(name)
  62 #endif
  63
  64 /*
  65  * x86/darwin (as of MacOS X 10.4.5) doesn't reliably fire signal
  66  * handlers (SIGTRAP or Mach exception handlers) for 0xCC, wo we have
  67  * to use ud2 instead. ud2 is an undefined opcode, #x0b0f, or
  68  * 0F 0B in low-endian notation, that causes SIGILL to fire. We check
  69  * for this instruction in the SIGILL handler and if we see it, we
  70  * advance the EIP by two bytes to skip over ud2 instruction and
  71  * call sigtrap_handler. */
  72 #if defined(LISP_FEATURE_UD2_BREAKPOINTS)
  73 #define TRAP ud2
  74 #else
  75 #define TRAP int3
  76 #endif
  77
  78 /*
  79  * More Apple assembler hacks
  80  */
  81
  82 #if defined(LISP_FEATURE_DARWIN)
  83 /* global symbol x86-64 sym(%rip) hack:*/
  84 #define GSYM(name) name(%rip)
  85 #define END()
  86 #else
  87 #define GSYM(name) $name
  88 #define END() .end
  89 #endif
  90
  91
  92         .text
  93         .globl  GNAME(all_threads)
  94
  95
  96 \f
  97 /* From lower to higher-numbered addresses, the stack contains
  98  * return address, arg 0, arg 1, arg 2 ...
  99  * rax contains the address of the function to call
 100  * Lisp expects return value in rax, whic is already consistent with C
 101  * XXXX correct floating point handling is unimplemented so far
 102  * Based on comments cleaned from x86-assem.S, we believe that
 103  * Lisp is expecting us to preserve rsi, rdi, rsp (no idea about r8-15)
 104  */
 105         .text
 106         .align  align_16byte,0x90
 107         .globl  GNAME(call_into_c)
 108         TYPE(GNAME(call_into_c))
 109 GNAME(call_into_c):
 110         push    %rbp            # Save old frame pointer.
 111         mov     %rsp,%rbp       # Establish new frame.
 112
 113         push    %rsi            # args are going in here
 114         push    %rdi
 115         mov     16(%rbp),%rdi
 116         mov     24(%rbp),%rsi
 117         mov     32(%rbp),%rdx
 118         mov     40(%rbp),%rcx
 119         mov     48(%rbp),%rcx
 120         mov     56(%rbp),%r8
 121         mov     64(%rbp),%r9
 122         call    *%rax
 123         mov     %rbp,%rsp
 124         pop     %rbp
 125         ret
 126         SIZE(GNAME(call_into_c))
 127
 128 \f
 129         .text
 130         .globl  GNAME(call_into_lisp_first_time)
 131         TYPE(GNAME(call_into_lisp_first_time))
 132
 133 /* We don't worry too much about saving registers
 134  * here, because we never expect to return from the initial call to lisp
 135  * anyway */
 136
 137         .align  align_16byte,0x90
 138 GNAME(call_into_lisp_first_time):
 139         push    %rbp            # Save old frame pointer.
 140         mov     %rsp,%rbp       # Establish new frame.
 141 #if defined(LISP_FEATURE_DARWIN)
 142         movq    GSYM(GNAME(all_threads)),%rax
 143 #else
 144         movq    GNAME(all_threads),%rax
 145 #endif
 146         mov     THREAD_CONTROL_STACK_END_OFFSET(%rax) ,%rsp
 147         jmp     Lstack
 148 \f
 149         .text
 150         .globl  GNAME(call_into_lisp)
 151         TYPE(GNAME(call_into_lisp))
 152
 153 /*
 154  * amd64 calling convention: C expects that
 155  * arguments go in rdi rsi rdx rcx r8 r9
 156  * return values in rax rdx
 157  * callee saves rbp rbx r12-15 if it uses them
 158  */
 159 #ifdef LISP_FEATURE_WIN32
 160 # define SUPPORT_FOMIT_FRAME_POINTER
 161 #endif
 162         .align  align_16byte,0x90
 163 GNAME(call_into_lisp):
 164 #ifdef SUPPORT_FOMIT_FRAME_POINTER
 165         mov     %rbp,%rax
 166 #endif
 167         push    %rbp            # Save old frame pointer.
 168         mov     %rsp,%rbp       # Establish new frame.
 169 Lstack:
 170 #ifdef SUPPORT_FOMIT_FRAME_POINTER
 171         /* If called through call_into_lisp_first_time, %r15 becomes invalid
 172          * here, but we will not return in that case. */
 173         push    %r15
 174         mov     %rax,%r15
 175 #endif
 176         /* FIXME x86 saves FPU state here */
 177         push    %rbx    # these regs are callee-saved according to C
 178         push    %r12    # so must be preserved and restored when
 179         push    %r13    # the lisp function returns
 180         push    %r14    #
 181         push    %r15    #
 182
 183         mov     %rsp,%rbx       # remember current stack
 184         push    %rbx            # Save entry stack on (maybe) new stack.
 185
 186         push    %rdi    # args from C
 187         push    %rsi    #
 188         push    %rdx    #
 189 #ifdef LISP_FEATURE_SB_THREAD
 190 # ifdef SUPPORT_FOMIT_FRAME_POINTER
 191         mov     (%rbp),%rcx
 192         sub     $32,%rsp
 193         call    GNAME(carry_frame_pointer)
 194         add     $32,%rsp
 195         mov     %rax,(%rbp)
 196 # endif
 197 #ifdef LISP_FEATURE_GCC_TLS
 198         movq    %fs:0, %rax
 199         movq    GNAME(current_thread)@TPOFF(%rax), %r12
 200 #else
 201 #ifdef LISP_FEATURE_DARWIN
 202         mov     GSYM(GNAME(specials)),%rdi
 203 #else
 204         mov     specials,%rdi
 205 #endif
 206         call    GNAME(pthread_getspecific)
 207         mov     %rax,%r12
 208 #endif
 209 #endif
 210         pop     %rcx    # num args
 211         pop     %rbx    # arg vector
 212         pop     %rax    # function ptr/lexenv
 213
 214         xor     %rdx,%rdx       # clear any descriptor registers
 215         xor     %rdi,%rdi       # that we can't be sure we'll
 216         xor     %rsi,%rsi       # initialise properly.  XX do r8-r15 too?
 217         shl     $(N_FIXNUM_TAG_BITS),%rcx       # (fixnumize num-args)
 218         cmp     $0,%rcx
 219         je      Ldone
 220         mov     0(%rbx),%rdx    # arg0
 221         cmp     $8,%rcx
 222         je      Ldone
 223         mov     8(%rbx),%rdi    # arg1
 224         cmp     $16,%rcx
 225         je      Ldone
 226         mov     16(%rbx),%rsi   # arg2
 227 Ldone:
 228         /* Registers rax, rcx, rdx, rdi, and rsi are now live. */
 229         xor     %rbx,%rbx       # available
 230
 231         /* Alloc new frame. */
 232         push    %rbp            # Dummy for return address
 233         push    %rbp            # fp in save location S1
 234         mov     %rsp,%rbp       # The current sp marks start of new frame.
 235         sub     $8,%rsp         # Ensure 3 slots are allocated, two above.
 236
 237 Lcall:
 238         call    *CLOSURE_FUN_OFFSET(%rax)
 239
 240         /* If the function returned multiple values, it will return to
 241            this point.  Lose them */
 242         jnc     LsingleValue
 243         mov     %rbx, %rsp
 244 LsingleValue:
 245
 246 /* Restore the stack, in case there was a stack change. */
 247         pop     %rsp            # c-sp
 248
 249 /* Restore C regs */
 250         pop     %r15
 251         pop     %r14
 252         pop     %r13
 253         pop     %r12
 254         pop     %rbx
 255
 256 /* FIXME Restore the NPX state. */
 257
 258         mov     %rdx,%rax       # c-val
 259 #ifdef SUPPORT_FOMIT_FRAME_POINTER
 260         mov     %r15,%rbp       # orig rbp
 261         pop     %r15            # orig r15
 262         add     $8,%rsp         # no need for saved (overridden) rbp
 263 #else
 264         leave
 265 #endif
 266         ret
 267         SIZE(GNAME(call_into_lisp))
 268 \f
 269 /* support for saving and restoring the NPX state from C */
 270         .text
 271         .globl  GNAME(fpu_save)
 272         TYPE(GNAME(fpu_save))
 273         .align  align_16byte,0x90
 274 GNAME(fpu_save):
 275         fnsave  (%rdi)          # Save the NPX state. (resets NPX)
 276         ret
 277         SIZE(GNAME(fpu_save))
 278
 279         .globl  GNAME(fpu_restore)
 280         TYPE(GNAME(fpu_restore))
 281         .align  align_16byte,0x90
 282 GNAME(fpu_restore):
 283         frstor  (%rdi)          # Restore the NPX state.
 284         ret
 285         SIZE(GNAME(fpu_restore))
 286 \f
 287 /*
 288  * the undefined-function trampoline
 289  */
 290         .text
 291         .align  align_16byte,0x90
 292         .globl  GNAME(undefined_tramp)
 293         TYPE(GNAME(undefined_tramp))
 294 GNAME(undefined_tramp):
 295         pop     8(%rbp)         # Save return PC for backtrace.
 296         TRAP
 297         .byte   trap_Error
 298         .byte   2
 299         .byte   UNDEFINED_FUN_ERROR
 300         .byte   sc_DescriptorReg # eax in the Descriptor-reg SC
 301         ret
 302         SIZE(GNAME(undefined_tramp))
 303
 304 /* KLUDGE: FIND-ESCAPED-FRAME (SYS:SRC;CODE;DEBUG-INT.LISP) needs
 305  * to know the name of the function immediately following the
 306  * undefined-function trampoline. */
 307
 308 /* Our call-site does not take care of caller-saved xmm registers, so it
 309  * falls to us spill them beforing hopping into C.
 310  *
 311  * We simply save all of them.
 312  *
 313  * (But for the sake of completeness, here is my understanding of the specs:)
 314  *                     System V       Microsoft
 315  * argument passing    xmm0-7         xmm0-3
 316  * caller-saved        xmm8-15        xmm4-5
 317  * callee-saved        -              xmm6-15
 318  *
 319  *  --DFL */
 320
 321 #define stkxmmsave(n) movaps %xmm##n, n*16(%rsp)
 322 #define stkxmmload(n) movaps n*16(%rsp), %xmm##n
 323 #define map_all_xmm(op) \
 324         op(0);op(1);op(2);op(3);op(4);op(5);op(6);op(7); \
 325     op(8);op(9);op(10);op(11);op(12);op(13);op(14);op(15);
 326
 327         .text
 328         .align  align_16byte,0x90
 329         .globl  GNAME(alloc_tramp)
 330         TYPE(GNAME(alloc_tramp))
 331 GNAME(alloc_tramp):
 332         cld
 333         push    %rbp            # Save old frame pointer.
 334         mov     %rsp,%rbp       # Establish new frame.
 335         and     $-32,%rsp
 336         sub     $16*16,%rsp
 337         map_all_xmm(stkxmmsave)
 338         push    %rax
 339         push    %rcx
 340         push    %rdx
 341         push    %rsi
 342         push    %rdi
 343         push    %r8
 344         push    %r9
 345         push    %r10
 346         push    %r11
 347         push    %r11
 348         mov     16(%rbp),%rdi
 349         call    GNAME(alloc)
 350         mov     %rax,16(%rbp)
 351         pop     %r11
 352         pop     %r11
 353         pop     %r10
 354         pop     %r9
 355         pop     %r8
 356         pop     %rdi
 357         pop     %rsi
 358         pop     %rdx
 359         pop     %rcx
 360         pop     %rax
 361         map_all_xmm(stkxmmload)
 362         mov     %rbp,%rsp
 363         pop     %rbp
 364         ret
 365         SIZE(GNAME(alloc_tramp))
 366
 367
 368 /*
 369  * the closure trampoline
 370  */
 371         .text
 372         .align  align_16byte,0x90
 373         .globl  GNAME(closure_tramp)
 374         TYPE(GNAME(closure_tramp))
 375 GNAME(closure_tramp):
 376         mov     FDEFN_FUN_OFFSET(%rax),%rax
 377         /* FIXME: The '*' after "jmp" in the next line is from PVE's
 378          * patch posted to the CMU CL mailing list Oct 6, 1999. It looks
 379          * reasonable, and it certainly seems as though if CMU CL needs it,
 380          * SBCL needs it too, but I haven't actually verified that it's
 381          * right. It would be good to find a way to force the flow of
 382          * control through here to test it. */
 383         jmp     *CLOSURE_FUN_OFFSET(%rax)
 384         SIZE(GNAME(closure_tramp))
 385
 386         .text
 387         .align  align_16byte,0x90
 388         .globl  GNAME(funcallable_instance_tramp)
 389 #if !defined(LISP_FEATURE_DARWIN)
 390         TYPE(GNAME(funcallable_instance_tramp))
 391 #endif
 392         GNAME(funcallable_instance_tramp):
 393         mov     FUNCALLABLE_INSTANCE_FUNCTION_OFFSET(%rax),%rax
 394         /* KLUDGE: on this platform, whatever kind of function is in %rax
 395          * now, the first word of it contains the address to jump to. */
 396         jmp     *CLOSURE_FUN_OFFSET(%rax)
 397 #if !defined(LISP_FEATURE_DARWIN)
 398         SIZE(GNAME(funcallable_instance_tramp))
 399 #endif
 400 /*
 401  * fun-end breakpoint magic
 402  */
 403
 404 /*
 405  * For an explanation of the magic involved in function-end
 406  * breakpoints, see the implementation in ppc-assem.S.
 407  */
 408
 409         .text
 410         .globl  GNAME(fun_end_breakpoint_guts)
 411         .align  align_16byte
 412 GNAME(fun_end_breakpoint_guts):
 413         /* Multiple Value return */
 414         jc      multiple_value_return
 415         /* Single value return: The eventual return will now use the
 416            multiple values return convention but with a return values
 417            count of one. */
 418         mov     %rsp,%rbx       # Setup ebx - the ofp.
 419         sub     $8,%rsp         # Allocate one stack slot for the return value
 420         mov     $8,%rcx         # Setup ecx for one return value.
 421 #if defined(LISP_FEATURE_DARWIN)
 422         mov     GSYM(NIL),%rdi  # default second value
 423         mov     GSYM(NIL),%rsi  # default third value
 424 #else
 425         mov     $NIL,%rdi       # default second value
 426         mov     $NIL,%rsi       # default third value
 427 #endif
 428 multiple_value_return:
 429
 430         .globl  GNAME(fun_end_breakpoint_trap)
 431         .align  align_16byte,0x90
 432 GNAME(fun_end_breakpoint_trap):
 433         TRAP
 434         .byte   trap_FunEndBreakpoint
 435         hlt                     # We should never return here.
 436
 437         .globl  GNAME(fun_end_breakpoint_end)
 438 GNAME(fun_end_breakpoint_end):
 439
 440 \f
 441         .globl  GNAME(do_pending_interrupt)
 442         TYPE(GNAME(do_pending_interrupt))
 443         .align  align_16byte,0x90
 444 GNAME(do_pending_interrupt):
 445         TRAP
 446         .byte   trap_PendingInterrupt
 447         ret
 448         SIZE(GNAME(do_pending_interrupt))
 449 \f
 450         .globl  GNAME(post_signal_tramp)
 451         TYPE(GNAME(post_signal_tramp))
 452         .align  align_16byte,0x90
 453 GNAME(post_signal_tramp):
 454         /* this is notionally the second half of a function whose first half
 455          * doesn't exist.  This is where call_into_lisp returns when called
 456          * using return_to_lisp_function */
 457         popq %r15
 458         popq %r14
 459         popq %r13
 460         popq %r12
 461         popq %r11
 462         popq %r10
 463         popq %r9
 464         popq %r8
 465         popq %rdi
 466         popq %rsi
 467         /* skip RBP and RSP */
 468         popq %rbx
 469         popq %rdx
 470         popq %rcx
 471         popq %rax
 472         popfq
 473         leave
 474         ret
 475         SIZE(GNAME(post_signal_tramp))
 476 \f
 477         .text
 478         .align  align_16byte,0x90
 479         .globl  GNAME(fast_bzero)
 480         TYPE(GNAME(fast_bzero))
 481
 482         #ifdef LISP_FEATURE_WIN32
 483         #define xmmreg xmm7
 484         #define redsave(reg,off) movups reg,-off(%rsp)
 485         #define redrestore(reg,off) movups -off(%rsp),reg
 486         #else
 487         #define xmmreg xmm0
 488         #define redsave(reg,off)
 489         #define redrestore(reg,off)
 490         #endif
 491
 492 GNAME(fast_bzero):
 493         /* A fast routine for zero-filling blocks of memory that are
 494          * guaranteed to start and end at a 4096-byte aligned address.
 495          */
 496         shr $6, %rsi              /* Amount of 64-byte blocks to copy */
 497         jz Lend                   /* If none, stop */
 498         mov %rsi, %rcx            /* Save start address */
 499         redsave(%xmmreg,16)
 500         xorps  %xmmreg, %xmmreg       /* Zero the XMM register */
 501         jmp Lloop
 502         .align align_16byte
 503 Lloop:
 504
 505         /* Copy the 16 zeroes from xmm7 to memory, 4 times. MOVNTDQ is the
 506          * non-caching double-quadword moving variant, i.e. the memory areas
 507          * we're touching are not fetched into the L1 cache, since we're just
 508          * going to overwrite the memory soon anyway.
 509          */
 510         movntdq %xmmreg, 0(%rdi)
 511         movntdq %xmmreg, 16(%rdi)
 512         movntdq %xmmreg, 32(%rdi)
 513         movntdq %xmmreg, 48(%rdi)
 514
 515         add $64, %rdi  /* Advance pointer */
 516         dec %rsi       /* Decrement 64-byte block count */
 517         jnz Lloop
 518         mfence         /* Ensure that the writes are globally visible, since
 519                         * MOVNTDQ is weakly ordered */
 520         redrestore(%xmmreg,16)
 521         prefetcht0 0(%rcx)      /* Prefetch the start of the block into cache,
 522                                  * since it's likely to be used immediately. */
 523 Lend:
 524         ret
 525         SIZE(GNAME(fast_bzero))
 526
 527 \f
 528 /* When LISP_FEATURE_C_STACK_IS_CONTROL_STACK, we cannot safely scrub
 529  * the control stack from C, largely due to not knowing where the
 530  * active stack frame ends.  On such platforms, we reimplement the
 531  * core scrubbing logic in assembly, in this case here:
 532  */
 533         .text
 534         .align  align_16byte,0x90
 535         .globl GNAME(arch_scrub_control_stack)
 536         TYPE(GNAME(arch_scrub_control_stack))
 537 GNAME(arch_scrub_control_stack):
 538         /* We are passed three parameters:
 539          * A (struct thread *) in RDI,
 540          * the address of the guard page in RSI, and
 541          * the address of the hard guard page in RDX.
 542          * We may trash RAX, RCX, and R8-R11 with impunity.
 543          * [RSP] is our return address, [RSP-8] is the first
 544          * stack slot to scrub. */
 545
 546         /* We start by setting up our scrub pointer in RAX, our
 547          * guard page upper bound in R8, and our hard guard
 548          * page upper bound in R9. */
 549         lea     -8(%rsp), %rax
 550 #ifdef LISP_FEATURE_DARWIN
 551         mov     GSYM(GNAME(os_vm_page_size)),%r9
 552 #else
 553         mov     os_vm_page_size,%r9
 554 #endif
 555         lea     (%rsi,%r9), %r8
 556         lea     (%rdx,%r9), %r9
 557
 558         /* Now we begin our main scrub loop. */
 559 ascs_outer_loop:
 560
 561         /* If we're about to scrub the hard guard page, exit. */
 562         cmp     %r9, %rax
 563         jae     ascs_check_guard_page
 564         cmp     %rax, %rdx
 565         jbe     ascs_finished
 566
 567 ascs_check_guard_page:
 568         /* If we're about to scrub the guard page, and the guard
 569          * page is protected, exit. */
 570         cmp     %r8, %rax
 571         jae     ascs_clear_loop
 572         cmp     %rax, %rsi
 573         ja      ascs_clear_loop
 574         cmpq    $(NIL), THREAD_CONTROL_STACK_GUARD_PAGE_PROTECTED_OFFSET(%rdi)
 575         jne     ascs_finished
 576
 577         /* Clear memory backwards to the start of the (4KiB) page */
 578 ascs_clear_loop:
 579         movq    $0, (%rax)
 580         test    $0xfff, %rax
 581         lea     -8(%rax), %rax
 582         jnz     ascs_clear_loop
 583
 584         /* If we're about to hit the hard guard page, exit. */
 585         cmp     %r9, %rax
 586         jae     ascs_finished
 587
 588         /* If the next (previous?) 4KiB page contains a non-zero
 589          * word, continue scrubbing. */
 590 ascs_check_loop:
 591         testq   $-1, (%rax)
 592         jnz     ascs_outer_loop
 593         test    $0xfff, %rax
 594         lea     -8(%rax), %rax
 595         jnz     ascs_check_loop
 596
 597 ascs_finished:
 598         ret
 599         SIZE(GNAME(arch_scrub_control_stack))
 600 \f
 601         END()