sys/cpu/x86_64/include/asmacros.h

   1 /*
   2  * Copyright (c) 1993 The Regents of the University of California.
   3  * Copyright (c) 2008 The DragonFly Project.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. Neither the name of the University nor the names of its contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $FreeBSD: src/sys/amd64/include/asmacros.h,v 1.32 2006/10/28 06:04:29 bde Exp $
  31  */
  32
  33 #ifndef _CPU_ASMACROS_H_
  34 #define _CPU_ASMACROS_H_
  35
  36 #include <sys/cdefs.h>
  37
  38 /* XXX too much duplication in various asm*.h's. */
  39
  40 /*
  41  * CNAME is used to manage the relationship between symbol names in C
  42  * and the equivalent assembly language names.  CNAME is given a name as
  43  * it would be used in a C program.  It expands to the equivalent assembly
  44  * language name.
  45  */
  46 #define CNAME(csym)             csym
  47
  48 #define ALIGN_DATA      .p2align 3      /* 8 byte alignment, zero filled */
  49 #ifdef GPROF
  50 #define ALIGN_TEXT      .p2align 4,0x90 /* 16-byte alignment, nop filled */
  51 #else
  52 #define ALIGN_TEXT      .p2align 4,0x90 /* 16-byte alignment, nop filled */
  53 #endif
  54 #define SUPERALIGN_TEXT .p2align 4,0x90 /* 16-byte alignment, nop filled */
  55
  56 #define GEN_ENTRY(name)         ALIGN_TEXT; .globl CNAME(name); \
  57                                 .type CNAME(name),@function; CNAME(name):
  58 #define NON_GPROF_ENTRY(name)   GEN_ENTRY(name)
  59 #define NON_GPROF_RET           .byte 0xc3      /* opcode for `ret' */
  60
  61 #define END(name)               .size name, . - name
  62
  63 #ifdef GPROF
  64 /*
  65  * __mcount is like [.]mcount except that doesn't require its caller to set
  66  * up a frame pointer.  It must be called before pushing anything onto the
  67  * stack.  gcc should eventually generate code to call __mcount in most
  68  * cases.  This would make -pg in combination with -fomit-frame-pointer
  69  * useful.  gcc has a configuration variable PROFILE_BEFORE_PROLOGUE to
  70  * allow profiling before setting up the frame pointer, but this is
  71  * inadequate for good handling of special cases, e.g., -fpic works best
  72  * with profiling after the prologue.
  73  *
  74  * [.]mexitcount is a new function to support non-statistical profiling if an
  75  * accurate clock is available.  For C sources, calls to it are generated
  76  * by the FreeBSD extension `-mprofiler-epilogue' to gcc.  It is best to
  77  * call [.]mexitcount at the end of a function like the MEXITCOUNT macro does,
  78  * but gcc currently generates calls to it at the start of the epilogue to
  79  * avoid problems with -fpic.
  80  *
  81  * [.]mcount and __mcount may clobber the call-used registers and %ef.
  82  * [.]mexitcount may clobber %ecx and %ef.
  83  *
  84  * Cross-jumping makes non-statistical profiling timing more complicated.
  85  * It is handled in many cases by calling [.]mexitcount before jumping.  It
  86  * is handled for conditional jumps using CROSSJUMP() and CROSSJUMP_LABEL().
  87  * It is handled for some fault-handling jumps by not sharing the exit
  88  * routine.
  89  *
  90  * ALTENTRY() must be before a corresponding ENTRY() so that it can jump to
  91  * the main entry point.  Note that alt entries are counted twice.  They
  92  * have to be counted as ordinary entries for gprof to get the call times
  93  * right for the ordinary entries.
  94  *
  95  * High local labels are used in macros to avoid clashes with local labels
  96  * in functions.
  97  *
  98  * Ordinary `ret' is used instead of a macro `RET' because there are a lot
  99  * of `ret's.  0xc3 is the opcode for `ret' (`#define ret ... ret' can't
 100  * be used because this file is sometimes preprocessed in traditional mode).
 101  * `ret' clobbers eflags but this doesn't matter.
 102  */
 103 #define ALTENTRY(name)          GEN_ENTRY(name) ; MCOUNT ; MEXITCOUNT ; jmp 9f
 104 #define CROSSJUMP(jtrue, label, jfalse) \
 105         jfalse 8f; MEXITCOUNT; jmp __CONCAT(to,label); 8:
 106 #define CROSSJUMPTARGET(label) \
 107         ALIGN_TEXT; __CONCAT(to,label): ; MCOUNT; jmp label
 108 #define ENTRY(name)             GEN_ENTRY(name) ; 9: ; MCOUNT
 109 #define FAKE_MCOUNT(caller)     pushq caller ; call __mcount ; popq %rcx
 110 #define MCOUNT                  call __mcount
 111 #define MCOUNT_LABEL(name)      GEN_ENTRY(name) ; nop ; ALIGN_TEXT
 112 #ifdef GUPROF
 113 #define MEXITCOUNT              call .mexitcount
 114 #define ret                     MEXITCOUNT ; NON_GPROF_RET
 115 #else
 116 #define MEXITCOUNT
 117 #endif
 118
 119 #else /* !GPROF */
 120 /*
 121  * ALTENTRY() has to align because it is before a corresponding ENTRY().
 122  * ENTRY() has to align to because there may be no ALTENTRY() before it.
 123  * If there is a previous ALTENTRY() then the alignment code for ENTRY()
 124  * is empty.
 125  */
 126 #define ALTENTRY(name)          GEN_ENTRY(name)
 127 #define CROSSJUMP(jtrue, label, jfalse) jtrue label
 128 #define CROSSJUMPTARGET(label)
 129 #define ENTRY(name)             GEN_ENTRY(name)
 130 #define FAKE_MCOUNT(caller)
 131 #define MCOUNT
 132 #define MCOUNT_LABEL(name)
 133 #define MEXITCOUNT
 134 #endif /* GPROF */
 135
 136 #ifdef LOCORE
 137 /*
 138  * Convenience macro for declaring interrupt entry points.
 139  */
 140 #define IDTVEC(name)    ALIGN_TEXT; .globl __CONCAT(X,name); \
 141                         .type __CONCAT(X,name),@function; __CONCAT(X,name):
 142
 143 /*
 144  * Macros to create and destroy a trap frame.
 145  */
 146 #define PUSH_FRAME_REGS                                                 \
 147         movq    %rdi,TF_RDI(%rsp) ;                                     \
 148         movq    %rsi,TF_RSI(%rsp) ;                                     \
 149         movq    %rdx,TF_RDX(%rsp) ;                                     \
 150         movq    %rcx,TF_RCX(%rsp) ;                                     \
 151         movq    %r8,TF_R8(%rsp) ;                                       \
 152         movq    %r9,TF_R9(%rsp) ;                                       \
 153         movq    %rax,TF_RAX(%rsp) ;                                     \
 154         movq    %rbx,TF_RBX(%rsp) ;                                     \
 155         movq    %rbp,TF_RBP(%rsp) ;                                     \
 156         movq    %r10,TF_R10(%rsp) ;                                     \
 157         movq    %r11,TF_R11(%rsp) ;                                     \
 158         movq    %r12,TF_R12(%rsp) ;                                     \
 159         movq    %r13,TF_R13(%rsp) ;                                     \
 160         movq    %r14,TF_R14(%rsp) ;                                     \
 161         movq    %r15,TF_R15(%rsp)
 162
 163 #define PUSH_FRAME                                                      \
 164         subq    $TF_RIP,%rsp ;  /* extend hardware frame to trapframe */ \
 165         testb   $SEL_RPL_MASK,TF_CS(%rsp) ; /* come from kernel? */     \
 166         jz      1f ;            /* Yes, dont swapgs again */            \
 167         swapgs ;                                                        \
 168 1:                                                                      \
 169         PUSH_FRAME_REGS                                                 \
 170
 171 #define PUSH_FRAME_NOSWAP                                               \
 172         subq    $TF_RIP,%rsp ;  /* extend hardware frame to trapframe */ \
 173         PUSH_FRAME_REGS                                                 \
 174
 175 #define POP_FRAME                                                       \
 176         movq    TF_RDI(%rsp),%rdi ;                                     \
 177         movq    TF_RSI(%rsp),%rsi ;                                     \
 178         movq    TF_RDX(%rsp),%rdx ;                                     \
 179         movq    TF_RCX(%rsp),%rcx ;                                     \
 180         movq    TF_R8(%rsp),%r8 ;                                       \
 181         movq    TF_R9(%rsp),%r9 ;                                       \
 182         movq    TF_RAX(%rsp),%rax ;                                     \
 183         movq    TF_RBX(%rsp),%rbx ;                                     \
 184         movq    TF_RBP(%rsp),%rbp ;                                     \
 185         movq    TF_R10(%rsp),%r10 ;                                     \
 186         movq    TF_R11(%rsp),%r11 ;                                     \
 187         movq    TF_R12(%rsp),%r12 ;                                     \
 188         movq    TF_R13(%rsp),%r13 ;                                     \
 189         movq    TF_R14(%rsp),%r14 ;                                     \
 190         movq    TF_R15(%rsp),%r15 ;                                     \
 191         testb   $SEL_RPL_MASK,TF_CS(%rsp) ; /* come from kernel? */     \
 192         jz      1f ;            /* keep kernel GS.base */               \
 193         cli ;                                                           \
 194         swapgs ;                                                        \
 195 1:      addq    $TF_RIP,%rsp    /* skip over tf_err, tf_trapno, tf_xflags */
 196
 197 /*
 198  * Access per-CPU data.
 199  */
 200 #define PCPU(member)            %gs:gd_ ## member
 201 #define PCPU_E8(member,idx)     %gs:gd_ ## member(,idx,8)
 202 #define PCPU_ADDR(member, reg)                                  \
 203         movq %gs:PC_PRVSPACE, reg ;                             \
 204         addq $PC_ ## member, reg
 205
 206 #endif /* LOCORE */
 207
 208 #endif /* !_CPU_ASMACROS_H_ */