osfmk/arm64/asm.h

   1 /*
   2  * Copyright (c) 2007 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56
  57 #ifndef _ARM_ASM_H_
  58 #define _ARM_ASM_H_
  59
  60 #include <arm/arch.h>
  61
  62 #ifndef __arm64__
  63 #error Why are we  including this?
  64 #endif
  65
  66 /* There is another definition of ALIGN for .c sources */
  67 #ifdef __ASSEMBLER__
  68 #define ALIGN 2
  69 #endif /* ASSEMBLER */
  70
  71 #ifndef FALIGN
  72 #define FALIGN ALIGN
  73 #endif
  74
  75 #define LB(x,n) n
  76 #if     __STDC__
  77 #ifndef __NO_UNDERSCORES__
  78 #define LCL(x)  L ## x
  79 #define EXT(x) _ ## x
  80 #define LEXT(x) _ ## x ## :
  81 #else
  82 #define LCL(x)  .L ## x
  83 #define EXT(x) x
  84 #define LEXT(x) x ## :
  85 #endif
  86 #define LBc(x,n) n ## :
  87 #define LBb(x,n) n ## b
  88 #define LBf(x,n) n ## f
  89 #else /* __STDC__ */
  90 #ifndef __NO_UNDERSCORES__
  91 #define LCL(x) L/**/x
  92 #define EXT(x) _/**/x
  93 #define LEXT(x) _/**/x/**/:
  94 #else /* __NO_UNDERSCORES__ */
  95 #define LCL(x)  .L/**/x
  96 #define EXT(x) x
  97 #define LEXT(x) x/**/:
  98 #endif /* __NO_UNDERSCORES__ */
  99 #define LBc(x,n) n/**/:
 100 #define LBb(x,n) n/**/b
 101 #define LBf(x,n) n/**/f
 102 #endif /* __STDC__ */
 103
 104 #define String  .asciz
 105 #define Value   .word
 106 #define Times(a,b) (a*b)
 107 #define Divide(a,b) (a/b)
 108
 109 #ifdef __ASSEMBLER__
 110 #if     MACH_KDB
 111 #include <ddb/stab.h>
 112 /*
 113  * This pseudo-assembler line is added so that there will be at least
 114  *      one N_SO entry in the symbol stable to define the current file name.
 115  */
 116 #endif  /* MACH_KDB */
 117
 118 /*
 119  * Multiline macros must use .macro syntax for now,
 120  * as there is no ARM64 statement separator.
 121  */
 122 .macro ENTRY
 123         .align FALIGN
 124         .globl _$0
 125         _$0 :
 126 .endmacro
 127
 128 .macro ENTRY2
 129         .align FALIGN
 130         .globl _$0
 131         .globl _$1
 132         _$0 :
 133         _$1 :
 134 .endmacro
 135
 136 .macro READ_THREAD
 137         mrs $0, TPIDR_EL1
 138 .endmacro
 139
 140 .macro BRANCH_EXTERN
 141         b _$0
 142 .endmacro
 143
 144 .macro CALL_EXTERN
 145         bl _$0
 146 .endmacro
 147
 148 .macro MOV64
 149         movk $0, #((($1) >> 48) & 0x000000000000FFFF), lsl #48
 150         movk $0, #((($1) >> 32) & 0x000000000000FFFF), lsl #32
 151         movk $0, #((($1) >> 16) & 0x000000000000FFFF), lsl #16
 152         movk $0, #((($1) >> 00) & 0x000000000000FFFF), lsl #00
 153 .endmacro
 154
 155 .macro MOV32
 156         movz $0, #((($1) >> 16) & 0x000000000000FFFF), lsl #16
 157         movk $0, #((($1) >> 00) & 0x000000000000FFFF), lsl #00
 158 .endmacro
 159
 160 .macro ARM64_STACK_PROLOG
 161 #if __has_feature(ptrauth_returns)
 162         pacibsp
 163 #endif
 164 .endmacro
 165
 166 .macro ARM64_STACK_EPILOG
 167 #if __has_feature(ptrauth_returns)
 168         retab
 169 #else
 170         ret
 171 #endif
 172 .endmacro
 173
 174 #define PUSH_FRAME                      \
 175         stp fp, lr, [sp, #-16]!         %% \
 176         mov fp, sp                      %%
 177
 178 #define POP_FRAME                       \
 179         mov sp, fp                      %% \
 180         ldp fp, lr, [sp], #16           %%
 181
 182 #define EXT(x) _ ## x
 183
 184 #ifdef  XNU_KERNEL_PRIVATE
 185 .macro PANIC_UNIMPLEMENTED
 186         bl EXT(panic_unimplemented)
 187 .endmacro
 188 #endif
 189
 190 #else /* NOT __ASSEMBLER__ */
 191
 192 /* These defines are here for .c files that wish to reference global symbols
 193  * within __asm__ statements.
 194  */
 195 #ifndef __NO_UNDERSCORES__
 196 #define CC_SYM_PREFIX "_"
 197 #else
 198 #define CC_SYM_PREFIX ""
 199 #endif /* __NO_UNDERSCORES__ */
 200 #endif /* __ASSEMBLER__ */
 201
 202 #ifdef __ASSEMBLER__
 203
 204 # define BRANCH_EXTERN(x)       b       EXT(x)
 205
 206 #endif /* __ASSEMBLER__ */
 207
 208 #endif /* _ARM_ASM_H_ */