sys/cpu/i386/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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * $FreeBSD: src/sys/i386/include/asmacros.h,v 1.18 1999/08/28 00:44:06 peter Exp $
  34  * $DragonFly: src/sys/cpu/i386/include/asmacros.h,v 1.2 2003/06/17 04:28:35 dillon Exp $
  35  */
  36
  37 #ifndef _MACHINE_ASMACROS_H_
  38 #define _MACHINE_ASMACROS_H_
  39
  40 #include <sys/cdefs.h>
  41 #include <machine/asnames.h>
  42
  43 /* XXX too much duplication in various asm*.h's. */
  44
  45 /*
  46  * CNAME and HIDENAME manage the relationship between symbol names in C
  47  * and the equivalent assembly language names.  CNAME is given a name as
  48  * it would be used in a C program.  It expands to the equivalent assembly
  49  * language name.  HIDENAME is given an assembly-language name, and expands
  50  * to a possibly-modified form that will be invisible to C programs.
  51  */
  52 #if defined(__ELF__)
  53 #define CNAME(csym)             csym
  54 #define HIDENAME(asmsym)        __CONCAT(.,asmsym)
  55 #else
  56 #define CNAME(csym)             __CONCAT(_,csym)
  57 #define HIDENAME(asmsym)        asmsym
  58 #endif
  59
  60 #define ALIGN_DATA      .p2align 2      /* 4 byte alignment, zero filled */
  61 #ifdef GPROF
  62 #define ALIGN_TEXT      .p2align 4,0x90 /* 16-byte alignment, nop filled */
  63 #else
  64 #define ALIGN_TEXT      .p2align 2,0x90 /* 4-byte alignment, nop filled */
  65 #endif
  66 #define SUPERALIGN_TEXT .p2align 4,0x90 /* 16-byte alignment, nop filled */
  67
  68 #define GEN_ENTRY(name)         ALIGN_TEXT; .globl CNAME(name); \
  69                                 .type CNAME(name),@function; CNAME(name):
  70 #define NON_GPROF_ENTRY(name)   GEN_ENTRY(name)
  71 #define NON_GPROF_RET           .byte 0xc3      /* opcode for `ret' */
  72
  73 #ifdef GPROF
  74 /*
  75  * __mcount is like [.]mcount except that doesn't require its caller to set
  76  * up a frame pointer.  It must be called before pushing anything onto the
  77  * stack.  gcc should eventually generate code to call __mcount in most
  78  * cases.  This would make -pg in combination with -fomit-frame-pointer
  79  * useful.  gcc has a configuration variable PROFILE_BEFORE_PROLOGUE to
  80  * allow profiling before setting up the frame pointer, but this is
  81  * inadequate for good handling of special cases, e.g., -fpic works best
  82  * with profiling after the prologue.
  83  *
  84  * [.]mexitcount is a new function to support non-statistical profiling if an
  85  * accurate clock is available.  For C sources, calls to it are generated
  86  * by the FreeBSD extension `-mprofiler-epilogue' to gcc.  It is best to
  87  * call [.]mexitcount at the end of a function like the MEXITCOUNT macro does,
  88  * but gcc currently generates calls to it at the start of the epilogue to
  89  * avoid problems with -fpic.
  90  *
  91  * [.]mcount and __mcount may clobber the call-used registers and %ef.
  92  * [.]mexitcount may clobber %ecx and %ef.
  93  *
  94  * Cross-jumping makes non-statistical profiling timing more complicated.
  95  * It is handled in many cases by calling [.]mexitcount before jumping.  It
  96  * is handled for conditional jumps using CROSSJUMP() and CROSSJUMP_LABEL().
  97  * It is handled for some fault-handling jumps by not sharing the exit
  98  * routine.
  99  *
 100  * ALTENTRY() must be before a corresponding ENTRY() so that it can jump to
 101  * the main entry point.  Note that alt entries are counted twice.  They
 102  * have to be counted as ordinary entries for gprof to get the call times
 103  * right for the ordinary entries.
 104  *
 105  * High local labels are used in macros to avoid clashes with local labels
 106  * in functions.
 107  *
 108  * Ordinary `ret' is used instead of a macro `RET' because there are a lot
 109  * of `ret's.  0xc3 is the opcode for `ret' (`#define ret ... ret' can't
 110  * be used because this file is sometimes preprocessed in traditional mode).
 111  * `ret' clobbers eflags but this doesn't matter.
 112  */
 113 #define ALTENTRY(name)          GEN_ENTRY(name) ; MCOUNT ; MEXITCOUNT ; jmp 9f
 114 #define CROSSJUMP(jtrue, label, jfalse) \
 115         jfalse 8f; MEXITCOUNT; jmp __CONCAT(to,label); 8:
 116 #define CROSSJUMPTARGET(label) \
 117         ALIGN_TEXT; __CONCAT(to,label): ; MCOUNT; jmp label
 118 #define ENTRY(name)             GEN_ENTRY(name) ; 9: ; MCOUNT
 119 #define FAKE_MCOUNT(caller)     pushl caller ; call __mcount ; popl %ecx
 120 #define MCOUNT                  call __mcount
 121 #define MCOUNT_LABEL(name)      GEN_ENTRY(name) ; nop ; ALIGN_TEXT
 122 #define MEXITCOUNT              call HIDENAME(mexitcount)
 123 #define ret                     MEXITCOUNT ; NON_GPROF_RET
 124
 125 #else /* !GPROF */
 126 /*
 127  * ALTENTRY() has to align because it is before a corresponding ENTRY().
 128  * ENTRY() has to align to because there may be no ALTENTRY() before it.
 129  * If there is a previous ALTENTRY() then the alignment code for ENTRY()
 130  * is empty.
 131  */
 132 #define ALTENTRY(name)          GEN_ENTRY(name)
 133 #define CROSSJUMP(jtrue, label, jfalse) jtrue label
 134 #define CROSSJUMPTARGET(label)
 135 #define ENTRY(name)             GEN_ENTRY(name)
 136 #define FAKE_MCOUNT(caller)
 137 #define MCOUNT
 138 #define MCOUNT_LABEL(name)
 139 #define MEXITCOUNT
 140 #endif /* GPROF */
 141
 142 #endif /* !_MACHINE_ASMACROS_H_ */