sys/amd64/include/asmacros.h

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