[apple/xnu.git] / osfmk / i386 / asm.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */

#ifndef	_I386_ASM_H_
#define	_I386_ASM_H_

#ifdef _KERNEL
#include <gprof.h>
#endif	/* _KERNEL */

#ifdef MACH_KERNEL
#include <mach_kdb.h>
#else	/* !MACH_KERNEL */
#define	MACH_KDB 0
#endif	/* !MACH_KERNEL */


#if	defined(MACH_KERNEL) || defined(_KERNEL)
#include <gprof.h>
#endif	/* MACH_KERNEL || _KERNEL */

#if defined(__i386__)

#define S_PC	 (%esp)
#define S_ARG0	 4(%esp)
#define S_ARG1	 8(%esp)
#define S_ARG2	12(%esp)
#define S_ARG3	16(%esp)
#define S_ARG4	20(%esp)

#define FRAME	pushl %ebp; movl %esp, %ebp
#define EMARF	leave

#define B_LINK	 (%ebp)
#define B_PC	 4(%ebp)
#define B_ARG0	 8(%ebp)
#define B_ARG1	12(%ebp)
#define B_ARG2	16(%ebp)
#define B_ARG3	20(%ebp)

#elif defined(__x86_64__)

#define S_PC	 (%rsp)

#define FRAME	pushq %rbp; movq %rsp, %rbp
#define EMARF	leave

#define B_LINK	 (%rbp)
#define B_PC	 8(%rbp)

#else
#error unsupported architecture
#endif

/* There is another definition of ALIGN for .c sources */
#ifdef ASSEMBLER
#define ALIGN 4,0x90
#endif /* ASSEMBLER */

#ifndef FALIGN
#define FALIGN ALIGN
#endif

#define LB(x,n) n
#if	__STDC__
#ifndef __NO_UNDERSCORES__
#define	LCL(x)	L ## x
#define EXT(x) _ ## x
#define LEXT(x) _ ## x ## :
#else
#define	LCL(x)	.L ## x
#define EXT(x) x
#define LEXT(x) x ## :
#endif
#define LBc(x,n) n ## :
#define LBb(x,n) n ## b
#define LBf(x,n) n ## f
#else /* __STDC__ */
#ifndef __NO_UNDERSCORES__
#define LCL(x) L/**/x
#define EXT(x) _/**/x
#define LEXT(x) _/**/x/**/:
#else /* __NO_UNDERSCORES__ */
#define	LCL(x)	.L/**/x
#define EXT(x) x
#define LEXT(x) x/**/:
#endif /* __NO_UNDERSCORES__ */
#define LBc(x,n) n/**/:
#define LBb(x,n) n/**/b
#define LBf(x,n) n/**/f
#endif /* __STDC__ */

#define SVC .byte 0x9a; .long 0; .word 0x7

#define RPC_SVC .byte 0x9a; .long 0; .word 0xf

#define String	.asciz
#define Value	.word
#define Times(a,b) (a*b)
#define Divide(a,b) (a/b)

#define INB	inb	%dx, %al
#define OUTB	outb	%al, %dx
#define INL	inl	%dx, %eax
#define OUTL	outl	%eax, %dx

#define data16	.byte 0x66
#define addr16	.byte 0x67

#if !GPROF
#define MCOUNT

#elif defined(__SHARED__)
#define MCOUNT		; .data;\
			.align ALIGN;\
			LBc(x, 8) .long 0;\
			.text;\
			Gpush;\
			Gload;\
			leal Gotoff(LBb(x,8)),%edx;\
			Egaddr(%eax,_mcount_ptr);\
			Gpop;\
			call *(%eax);

#else	/* !GPROF, !__SHARED__ */
#define MCOUNT		; call mcount;
#endif /* GPROF */

#ifdef __ELF__
#define ELF_FUNC(x)	.type x,@function
#define ELF_DATA(x)	.type x,@object
#define ELF_SIZE(x,s)	.size x,s
#else
#define ELF_FUNC(x)
#define ELF_DATA(x)
#define ELF_SIZE(x,s)
#endif

#define	Entry(x)	.globl EXT(x); ELF_FUNC(EXT(x)); .align FALIGN; LEXT(x)
#define	ENTRY(x)	Entry(x) MCOUNT
#define	ENTRY2(x,y)	.globl EXT(x); .globl EXT(y); \
			ELF_FUNC(EXT(x)); ELF_FUNC(EXT(y)); \
			.align FALIGN; LEXT(x); LEXT(y) \
			MCOUNT
#if __STDC__
#define	ASENTRY(x) 	.globl x; .align FALIGN; x ## : ELF_FUNC(x) MCOUNT
#else
#define	ASENTRY(x) 	.globl x; .align FALIGN; x: ELF_FUNC(x) MCOUNT
#endif /* __STDC__ */

#define	DATA(x)		.globl EXT(x); ELF_DATA(EXT(x)); .align ALIGN; LEXT(x)

#define End(x)		ELF_SIZE(x,.-x)
#define END(x)		End(EXT(x))
#define ENDDATA(x)	END(x)
#define Enddata(x)	End(x)

/*
 * ELF shared library accessor macros.
 * Gpush saves the %ebx register used for the GOT address
 * Gpop pops %ebx if we need a GOT
 * Gload loads %ebx with the GOT address if shared libraries are used
 * Gcall calls an external function.
 * Gotoff allows you to reference local labels.
 * Gotoff2 allows you to reference local labels with an index reg.
 * Gotoff3 allows you to reference local labels with an index reg & size.
 * Gaddr loads up a register with an address of an external item.
 * Gstack is the number of bytes that Gpush pushes on the stack.
 *
 * Varients of the above with E or L prefixes do EXT(name) or LCL(name)
 * respectively.
 */

#ifndef __SHARED__
#define Gpush
#define Gpop
#define Gload
#define Gcall(func)		call func
#define Gotoff(lab)		lab
#define Gotoff2(l,r)		l(r)
#define Gotoff3(l,r,s)		l(,r,s)
#define Gaddr(to,lab)		movl $lab,to
#define Gcmp(lab,reg)		cmpl $lab,reg
#define Gmemload(lab,reg)	movl lab,reg
#define Gmemstore(reg,lab,tmp)	movl reg,lab
#define Gstack			0

#else
#ifdef __ELF__			/* ELF shared libraries */
#define Gpush			pushl %ebx
#define Gpop			popl %ebx
#define Gload			call 9f; 9: popl %ebx; addl $_GLOBAL_OFFSET_TABLE_+[.-9b],%ebx
#define Gcall(func)		call EXT(func)@PLT
#define Gotoff(lab)		lab@GOTOFF(%ebx)
#define Gotoff2(l,r)		l@GOTOFF(%ebx,r)
#define Gotoff3(l,r,s)		l@GOTOFF(%ebx,r,s)
#define Gaddr(to,lab)		movl lab@GOT(%ebx),to
#define Gcmp(lab,reg)		cmpl reg,lab@GOT(%ebx)
#define Gmemload(lab,reg)	movl lab@GOT(%ebx),reg; movl (reg),reg
#define Gmemstore(reg,lab,tmp)	movl lab@GOT(%ebx),tmp; movl reg,(tmp)
#define Gstack			4

#else				/* ROSE shared libraries */
#define Gpush
#define Gpop
#define Gload
#define Gcall(func)		call *9f; .data; .align ALIGN; 9: .long func; .text
#define Gotoff(lab)		lab
#define Gotoff2(l,r)		l(r)
#define Gotoff3(l,r,s)		l(,r,s)
#define Gaddr(to,lab)		movl 9f,to; .data; .align ALIGN; 9: .long lab; .text
#define Gcmp(lab,reg)		cmpl reg,9f; .data; .align ALIGN; 9: .long lab; .text
#define Gmemload(lab,reg)	movl 9f,reg; movl (reg),reg; .data; .align ALIGN; 9: .long lab; .text
#define Gmemstore(reg,lab,tmp)	movl 9f,tmp; movl reg,(tmp); .data; .align ALIGN; 9: .long lab; .text
#define Gstack			0
#endif	/* __ELF__ */
#endif	/* __SHARED__ */

/* Egotoff is not provided, since external symbols should not use @GOTOFF
   relocations.  */
#define Egcall(func)		Gcall(EXT(func))
#define Egaddr(to,lab)		Gaddr(to,EXT(lab))
#define Egcmp(lab,reg)		Gcmp(EXT(lab),reg)
#define Egmemload(lab,reg)	Gmemload(EXT(lab),reg)
#define Egmemstore(reg,lab,tmp)	Gmemstore(reg,EXT(lab),tmp)

#define Lgotoff(lab)		Gotoff(LCL(lab))
#define Lgotoff2(l,r)		Gotoff2(LCL(l),r)
#define Lgotoff3(l,r,s)		Gotoff3(LCL(l),r,s)
#define Lgcmp(lab,reg)		Gcmp(LCL(lab),reg)
#define Lgmemload(lab,reg)	movl Lgotoff(lab),reg
#define Lgmemstore(reg,lab,tmp)	movl reg,Lgotoff(lab)

#ifdef ASSEMBLER
#if	MACH_KDB
#include <ddb/stab.h>
/*
 * This pseudo-assembler line is added so that there will be at least
 *	one N_SO entry in the symbol stable to define the current file name.
 */
#endif	/* MACH_KDB */

#else /* NOT ASSEMBLER */

/* These defines are here for .c files that wish to reference global symbols
 * within __asm__ statements. 
 */
#ifndef __NO_UNDERSCORES__
#define CC_SYM_PREFIX "_"
#else
#define CC_SYM_PREFIX ""
#endif /* __NO_UNDERSCORES__ */
#endif /* ASSEMBLER */

/*
 * The following macros make calls into C code.
 * They dynamically align the stack to 16 bytes.
 */
#if defined(__i386__)
/*
 * Arguments are moved (not pushed) onto the correctly aligned stack.
 * NOTE: ESI is destroyed in the process, and hence cannot
 * be directly used as a parameter. Users of this macro must
 * independently preserve ESI (a non-volatile) if the routine is
 * intended to be called from C, for instance.
 */

#define CCALL(fn)			\
	movl	%esp, %esi		;\
	andl	$0xFFFFFFF0, %esp	;\
	call	EXT(fn)			;\
	movl	%esi, %esp

#define CCALL1(fn, arg1)		\
	movl	%esp, %esi		;\
	subl	$4, %esp		;\
	andl	$0xFFFFFFF0, %esp	;\
	movl	arg1, (%esp)		;\
	call	EXT(fn)			;\
	movl	%esi, %esp

#define CCALL2(fn, arg1, arg2)		\
	movl	%esp, %esi		;\
	subl	$8, %esp		;\
	andl	$0xFFFFFFF0, %esp	;\
	movl	arg2, 4(%esp)		;\
	movl	arg1, (%esp)		;\
	call	EXT(fn)			;\
	movl	%esi, %esp

/* This variant exists to permit adjustment of the stack by "dtrace" */
#define CCALL1WITHSP(fn, arg1)		\
	movl	%esp, %esi		;\
	subl	$12, %esp		;\
	andl	$0xFFFFFFF0, %esp	;\
	movl	%esi, 8(%esp)		;\
	leal	8(%esp), %esi		;\
	movl	%esi, 4(%esp)		;\
	movl	arg1, (%esp)		;\
	call	EXT(fn)			;\
	movl	8(%esp), %esp

/*
 * CCALL5 is used for callee functions with 3 arguments but
 * where arg2 (a3:a2) and arg3 (a5:a4) are 64-bit values.
 */
#define CCALL5(fn, a1, a2, a3, a4, a5)	\
	movl	%esp, %esi		;\
	subl	$20, %esp		;\
	andl	$0xFFFFFFF0, %esp	;\
	movl	a5, 16(%esp)		;\
	movl	a4, 12(%esp)		;\
	movl	a3,  8(%esp)		;\
	movl	a2,  4(%esp)		;\
	movl	a1,  (%esp)		;\
	call	EXT(fn)			;\
	movl	%esi, %esp

#elif defined(__x86_64__)

/* This variant exists to permit adjustment of the stack by "dtrace" */
#define CCALLWITHSP(fn)				 \
	mov	%rsp, %r12			;\
	sub	$8, %rsp			;\
	and	$0xFFFFFFFFFFFFFFF0, %rsp	;\
	mov	%r12, (%rsp)			;\
	leaq	(%rsp), %rsi			;\
	call	EXT(fn)				;\
	mov	(%rsp), %rsp
	
#define CCALL(fn)				 \
	mov	%rsp, %r12			;\
	and	$0xFFFFFFFFFFFFFFF0, %rsp	;\
	call	EXT(fn)				;\
	mov	%r12, %rsp

#define CCALL1(fn, arg1) 			 \
	mov	arg1, %rdi 			;\
	CCALL(fn)

#define CCALL2(fn, arg1, arg2)		 	 \
	mov	arg1, %rdi 			;\
	CCALL(fn)

#define CCALL3(fn, arg1, arg2, arg3) 		 \
	mov	arg1, %rdi 			;\
	mov	arg2, %rsi 			;\
	mov	arg3, %rdx 			;\
	CCALL(fn)

#else
#error unsupported architecture
#endif

#endif /* _I386_ASM_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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 _I386_ASM_H_
	58	#define _I386_ASM_H_
	59
	60	#ifdef _KERNEL
	61	#include <gprof.h>
	62	#endif /* _KERNEL */
	63
	64	#ifdef MACH_KERNEL
	65	#include <mach_kdb.h>
	66	#else /* !MACH_KERNEL */
	67	#define MACH_KDB 0
	68	#endif /* !MACH_KERNEL */
	69
	70
	71	#if defined(MACH_KERNEL) \|\| defined(_KERNEL)
	72	#include <gprof.h>
	73	#endif /* MACH_KERNEL \|\| _KERNEL */
	74
b0d623f7	75	#if defined(__i386__)
1c79356b	76
2d21ac55	77	#define S_PC (%esp)
1c79356b A	78	#define S_ARG0 4(%esp)
	79	#define S_ARG1 8(%esp)
	80	#define S_ARG2 12(%esp)
	81	#define S_ARG3 16(%esp)
0c530ab8	82	#define S_ARG4 20(%esp)
1c79356b A	83
	84	#define FRAME pushl %ebp; movl %esp, %ebp
	85	#define EMARF leave
	86
2d21ac55	87	#define B_LINK (%ebp)
91447636	88	#define B_PC 4(%ebp)
1c79356b A	89	#define B_ARG0 8(%ebp)
	90	#define B_ARG1 12(%ebp)
	91	#define B_ARG2 16(%ebp)
	92	#define B_ARG3 20(%ebp)
	93
b0d623f7 A	94	#elif defined(__x86_64__)
	95
	96	#define S_PC (%rsp)
	97
	98	#define FRAME pushq %rbp; movq %rsp, %rbp
	99	#define EMARF leave
	100
	101	#define B_LINK (%rbp)
	102	#define B_PC 8(%rbp)
	103
	104	#else
	105	#error unsupported architecture
	106	#endif
	107
1c79356b A	108	/* There is another definition of ALIGN for .c sources */
1c79356b A	109	#ifdef ASSEMBLER
0c530ab8	110	#define ALIGN 4,0x90
1c79356b A	111	#endif /* ASSEMBLER */
	112
	113	#ifndef FALIGN
	114	#define FALIGN ALIGN
	115	#endif
	116
	117	#define LB(x,n) n
	118	#if __STDC__
	119	#ifndef __NO_UNDERSCORES__
	120	#define LCL(x) L ## x
	121	#define EXT(x) _ ## x
	122	#define LEXT(x) _ ## x ## :
	123	#else
	124	#define LCL(x) .L ## x
	125	#define EXT(x) x
	126	#define LEXT(x) x ## :
	127	#endif
	128	#define LBc(x,n) n ## :
	129	#define LBb(x,n) n ## b
	130	#define LBf(x,n) n ## f
	131	#else /* __STDC__ */
	132	#ifndef __NO_UNDERSCORES__
	133	#define LCL(x) L/**/x
	134	#define EXT(x) _/**/x
	135	#define LEXT(x) _//x//:
	136	#else /* __NO_UNDERSCORES__ */
	137	#define LCL(x) .L/**/x
	138	#define EXT(x) x
	139	#define LEXT(x) x/**/:
	140	#endif /* __NO_UNDERSCORES__ */
	141	#define LBc(x,n) n/**/:
	142	#define LBb(x,n) n/**/b
	143	#define LBf(x,n) n/**/f
	144	#endif /* __STDC__ */
	145
	146	#define SVC .byte 0x9a; .long 0; .word 0x7
	147
	148	#define RPC_SVC .byte 0x9a; .long 0; .word 0xf
	149
	150	#define String .asciz
	151	#define Value .word
	152	#define Times(a,b) (a*b)
	153	#define Divide(a,b) (a/b)
	154
	155	#define INB inb %dx, %al
	156	#define OUTB outb %al, %dx
	157	#define INL inl %dx, %eax
	158	#define OUTL outl %eax, %dx
	159
	160	#define data16 .byte 0x66
	161	#define addr16 .byte 0x67
	162
	163	#if !GPROF
	164	#define MCOUNT
	165
	166	#elif defined(__SHARED__)
	167	#define MCOUNT ; .data;\
	168	.align ALIGN;\
	169	LBc(x, 8) .long 0;\
	170	.text;\
	171	Gpush;\
	172	Gload;\
	173	leal Gotoff(LBb(x,8)),%edx;\
	174	Egaddr(%eax,_mcount_ptr);\
175	Gpop;\
176	call *(%eax);
177
178	#else /* !GPROF, !__SHARED__ */
91447636	179	#define MCOUNT ; call mcount;
1c79356b A	180	#endif /* GPROF */
	181
	182	#ifdef __ELF__
	183	#define ELF_FUNC(x) .type x,@function
	184	#define ELF_DATA(x) .type x,@object
	185	#define ELF_SIZE(x,s) .size x,s
	186	#else
	187	#define ELF_FUNC(x)
	188	#define ELF_DATA(x)
	189	#define ELF_SIZE(x,s)
	190	#endif
	191
	192	#define Entry(x) .globl EXT(x); ELF_FUNC(EXT(x)); .align FALIGN; LEXT(x)
	193	#define ENTRY(x) Entry(x) MCOUNT
	194	#define ENTRY2(x,y) .globl EXT(x); .globl EXT(y); \
	195	ELF_FUNC(EXT(x)); ELF_FUNC(EXT(y)); \
	196	.align FALIGN; LEXT(x); LEXT(y) \
	197	MCOUNT
	198	#if __STDC__
	199	#define ASENTRY(x) .globl x; .align FALIGN; x ## : ELF_FUNC(x) MCOUNT
	200	#else
	201	#define ASENTRY(x) .globl x; .align FALIGN; x: ELF_FUNC(x) MCOUNT
	202	#endif /* __STDC__ */
	203
	204	#define DATA(x) .globl EXT(x); ELF_DATA(EXT(x)); .align ALIGN; LEXT(x)
	205
	206	#define End(x) ELF_SIZE(x,.-x)
	207	#define END(x) End(EXT(x))
	208	#define ENDDATA(x) END(x)
	209	#define Enddata(x) End(x)
	210
	211	/*
	212	* ELF shared library accessor macros.
	213	* Gpush saves the %ebx register used for the GOT address
	214	* Gpop pops %ebx if we need a GOT
	215	* Gload loads %ebx with the GOT address if shared libraries are used
	216	* Gcall calls an external function.
	217	* Gotoff allows you to reference local labels.
	218	* Gotoff2 allows you to reference local labels with an index reg.
	219	* Gotoff3 allows you to reference local labels with an index reg & size.
	220	* Gaddr loads up a register with an address of an external item.
	221	* Gstack is the number of bytes that Gpush pushes on the stack.
	222	*
	223	* Varients of the above with E or L prefixes do EXT(name) or LCL(name)
	224	* respectively.
	225	*/
	226
	227	#ifndef __SHARED__
	228	#define Gpush
	229	#define Gpop
	230	#define Gload
	231	#define Gcall(func) call func
	232	#define Gotoff(lab) lab
	233	#define Gotoff2(l,r) l(r)
	234	#define Gotoff3(l,r,s) l(,r,s)
	235	#define Gaddr(to,lab) movl $lab,to
	236	#define Gcmp(lab,reg) cmpl $lab,reg
	237	#define Gmemload(lab,reg) movl lab,reg
	238	#define Gmemstore(reg,lab,tmp) movl reg,lab
	239	#define Gstack 0
	240
	241	#else
	242	#ifdef __ELF__ /* ELF shared libraries */
	243	#define Gpush pushl %ebx
244	#define Gpop popl %ebx
245	#define Gload call 9f; 9: popl %ebx; addl $_GLOBAL_OFFSET_TABLE_+[.-9b],%ebx
246	#define Gcall(func) call EXT(func)@PLT
247	#define Gotoff(lab) lab@GOTOFF(%ebx)
248	#define Gotoff2(l,r) l@GOTOFF(%ebx,r)
249	#define Gotoff3(l,r,s) l@GOTOFF(%ebx,r,s)
250	#define Gaddr(to,lab) movl lab@GOT(%ebx),to
251	#define Gcmp(lab,reg) cmpl reg,lab@GOT(%ebx)
252	#define Gmemload(lab,reg) movl lab@GOT(%ebx),reg; movl (reg),reg
253	#define Gmemstore(reg,lab,tmp) movl lab@GOT(%ebx),tmp; movl reg,(tmp)
254	#define Gstack 4
255
256	#else /* ROSE shared libraries */
257	#define Gpush
258	#define Gpop
259	#define Gload
260	#define Gcall(func) call *9f; .data; .align ALIGN; 9: .long func; .text
261	#define Gotoff(lab) lab
262	#define Gotoff2(l,r) l(r)
263	#define Gotoff3(l,r,s) l(,r,s)
264	#define Gaddr(to,lab) movl 9f,to; .data; .align ALIGN; 9: .long lab; .text
265	#define Gcmp(lab,reg) cmpl reg,9f; .data; .align ALIGN; 9: .long lab; .text
266	#define Gmemload(lab,reg) movl 9f,reg; movl (reg),reg; .data; .align ALIGN; 9: .long lab; .text
267	#define Gmemstore(reg,lab,tmp) movl 9f,tmp; movl reg,(tmp); .data; .align ALIGN; 9: .long lab; .text
268	#define Gstack 0
269	#endif /* __ELF__ */
270	#endif /* __SHARED__ */
271
272	/* Egotoff is not provided, since external symbols should not use @GOTOFF
273	relocations. */
274	#define Egcall(func) Gcall(EXT(func))
275	#define Egaddr(to,lab) Gaddr(to,EXT(lab))
276	#define Egcmp(lab,reg) Gcmp(EXT(lab),reg)
277	#define Egmemload(lab,reg) Gmemload(EXT(lab),reg)
278	#define Egmemstore(reg,lab,tmp) Gmemstore(reg,EXT(lab),tmp)
279
280	#define Lgotoff(lab) Gotoff(LCL(lab))
281	#define Lgotoff2(l,r) Gotoff2(LCL(l),r)
282	#define Lgotoff3(l,r,s) Gotoff3(LCL(l),r,s)
283	#define Lgcmp(lab,reg) Gcmp(LCL(lab),reg)
284	#define Lgmemload(lab,reg) movl Lgotoff(lab),reg
285	#define Lgmemstore(reg,lab,tmp) movl reg,Lgotoff(lab)
286
287	#ifdef ASSEMBLER
288	#if MACH_KDB
289	#include <ddb/stab.h>
290	/*
291	* This pseudo-assembler line is added so that there will be at least
292	* one N_SO entry in the symbol stable to define the current file name.
293	*/
294	#endif /* MACH_KDB */
295
296	#else /* NOT ASSEMBLER */
297
298	/* These defines are here for .c files that wish to reference global symbols
299	* within __asm__ statements.
300	*/
301	#ifndef __NO_UNDERSCORES__
302	#define CC_SYM_PREFIX "_"
303	#else
304	#define CC_SYM_PREFIX ""
305	#endif /* __NO_UNDERSCORES__ */
306	#endif /* ASSEMBLER */
307
6d2010ae A	308	/*
	309	* The following macros make calls into C code.
	310	* They dynamically align the stack to 16 bytes.
	311	*/
	312	#if defined(__i386__)
	313	/*
	314	* Arguments are moved (not pushed) onto the correctly aligned stack.
	315	* NOTE: ESI is destroyed in the process, and hence cannot
	316	* be directly used as a parameter. Users of this macro must
	317	* independently preserve ESI (a non-volatile) if the routine is
	318	* intended to be called from C, for instance.
	319	*/
	320
	321	#define CCALL(fn) \
	322	movl %esp, %esi ;\
	323	andl $0xFFFFFFF0, %esp ;\
	324	call EXT(fn) ;\
	325	movl %esi, %esp
	326
	327	#define CCALL1(fn, arg1) \
	328	movl %esp, %esi ;\
	329	subl $4, %esp ;\
	330	andl $0xFFFFFFF0, %esp ;\
	331	movl arg1, (%esp) ;\
	332	call EXT(fn) ;\
	333	movl %esi, %esp
	334
	335	#define CCALL2(fn, arg1, arg2) \
	336	movl %esp, %esi ;\
	337	subl $8, %esp ;\
	338	andl $0xFFFFFFF0, %esp ;\
	339	movl arg2, 4(%esp) ;\
	340	movl arg1, (%esp) ;\
	341	call EXT(fn) ;\
	342	movl %esi, %esp
	343
	344	/* This variant exists to permit adjustment of the stack by "dtrace" */
	345	#define CCALL1WITHSP(fn, arg1) \
	346	movl %esp, %esi ;\
	347	subl $12, %esp ;\
	348	andl $0xFFFFFFF0, %esp ;\
	349	movl %esi, 8(%esp) ;\
	350	leal 8(%esp), %esi ;\
	351	movl %esi, 4(%esp) ;\
	352	movl arg1, (%esp) ;\
	353	call EXT(fn) ;\
	354	movl 8(%esp), %esp
	355
	356	/*
	357	* CCALL5 is used for callee functions with 3 arguments but
	358	* where arg2 (a3:a2) and arg3 (a5:a4) are 64-bit values.
	359	*/
	360	#define CCALL5(fn, a1, a2, a3, a4, a5) \
	361	movl %esp, %esi ;\
	362	subl $20, %esp ;\
	363	andl $0xFFFFFFF0, %esp ;\
	364	movl a5, 16(%esp) ;\
	365	movl a4, 12(%esp) ;\
	366	movl a3, 8(%esp) ;\
	367	movl a2, 4(%esp) ;\
	368	movl a1, (%esp) ;\
	369	call EXT(fn) ;\
	370	movl %esi, %esp
	371
372	#elif defined(__x86_64__)
373
374	/* This variant exists to permit adjustment of the stack by "dtrace" */
375	#define CCALLWITHSP(fn) \
376	mov %rsp, %r12 ;\
377	sub $8, %rsp ;\
378	and $0xFFFFFFFFFFFFFFF0, %rsp ;\
379	mov %r12, (%rsp) ;\
380	leaq (%rsp), %rsi ;\
381	call EXT(fn) ;\
382	mov (%rsp), %rsp
383
384	#define CCALL(fn) \
385	mov %rsp, %r12 ;\
386	and $0xFFFFFFFFFFFFFFF0, %rsp ;\
387	call EXT(fn) ;\
388	mov %r12, %rsp
389
390	#define CCALL1(fn, arg1) \
391	mov arg1, %rdi ;\
392	CCALL(fn)
393
394	#define CCALL2(fn, arg1, arg2) \
395	mov arg1, %rdi ;\
396	CCALL(fn)
397
398	#define CCALL3(fn, arg1, arg2, arg3) \
399	mov arg1, %rdi ;\
400	mov arg2, %rsi ;\
401	mov arg3, %rdx ;\
402	CCALL(fn)
403
404	#else
405	#error unsupported architecture
406	#endif
407
1c79356b	408	#endif /* _I386_ASM_H_ */