1/*	$NetBSD: asm.h,v 1.23 2020/04/17 14:19:44 joerg Exp $ */
  2
  3/*
  4 * Copyright (c) 1994 Allen Briggs
  5 * All rights reserved.
  6 *
  7 * Gleaned from locore.s and sun3 asm.h which had the following copyrights:
  8 * locore.s:
  9 * Copyright (c) 1988 University of Utah.
 10 * Copyright (c) 1982, 1990 The Regents of the University of California.
 11 * sun3/include/asm.h:
 12 * Copyright (c) 1993 Adam Glass
 13 * Copyright (c) 1990 The Regents of the University of California.
 14 *
 15 * Redistribution and use in source and binary forms, with or without
 16 * modification, are permitted provided that the following conditions
 17 * are met:
 18 * 1. Redistributions of source code must retain the above copyright
 19 *    notice, this list of conditions and the following disclaimer.
 20 * 2. Redistributions in binary form must reproduce the above copyright
 21 *    notice, this list of conditions and the following disclaimer in the
 22 *    documentation and/or other materials provided with the distribution.
 23 * 3. All advertising materials mentioning features or use of this software
 24 *    must display the following acknowledgement:
 25 *	This product includes software developed by the University of
 26 *	California, Berkeley and its contributors.
 27 * 4. Neither the name of the University nor the names of its contributors
 28 *    may be used to endorse or promote products derived from this software
 29 *    without specific prior written permission.
 30 *
 31 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 32 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 33 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 34 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 35 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 39 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 40 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 41 * SUCH DAMAGE.
 42 */
 43
 44#ifndef _ASM_H_
 45#define _ASM_H_
 46
 47/* Pull in CCFSZ, CC64FSZ, and BIAS from frame.h */
 48#ifndef _LOCORE
 49#define _LOCORE
 50#endif
 51#include <machine/frame.h>
 52
 53#ifdef __ELF__
 54#define	_C_LABEL(name)		name
 55#else
 56#ifdef __STDC__
 57#define _C_LABEL(name)		_ ## name
 58#else
 59#define _C_LABEL(name)		_/**/name
 60#endif
 61#endif
 62#define	_ASM_LABEL(name)	name
 63
 64#ifdef __PIC__
 65/*
 66 * PIC_PROLOGUE() is akin to the compiler generated function prologue for
 67 * PIC code. It leaves the address of the Global Offset Table in DEST,
 68 * clobbering register TMP in the process.
 69 *
 70 * We can use two code sequences.  We can read the %pc or use the call
 71 * instruction that saves the pc in %o7.  Call requires the branch unit and
 72 * IEU1, and clobbers %o7 which needs to be restored.  This instruction
 73 * sequence takes about 4 cycles due to instruction interdependence.  Reading
 74 * the pc takes 4 cycles to dispatch and is always dispatched alone.  That
 75 * sequence takes 7 cycles.
 76 */
 77#ifdef __arch64__
 78#define PIC_PROLOGUE(dest,tmp) \
 79	mov %o7, tmp; \
 80	sethi %hi(_GLOBAL_OFFSET_TABLE_-4),dest; \
 81	call 0f; \
 82	 or dest,%lo(_GLOBAL_OFFSET_TABLE_+4),dest; \
 830: \
 84	add dest,%o7,dest; \
 85	mov tmp, %o7
 86#else
 87#define PIC_PROLOGUE(dest,tmp) \
 88	mov %o7,tmp; 3: call 4f; nop; 4: \
 89	sethi %hi(_C_LABEL(_GLOBAL_OFFSET_TABLE_)-(3b-.)),dest; \
 90	or dest,%lo(_C_LABEL(_GLOBAL_OFFSET_TABLE_)-(3b-.)),dest; \
 91	add dest,%o7,dest; mov tmp,%o7
 92#endif
 93
 94/*
 95 * PICCY_SET() does the equivalent of a `set var, %dest' instruction in
 96 * a PIC-like way, but without involving the Global Offset Table. This
 97 * only works for VARs defined in the same file *and* in the text segment.
 98 */
 99#ifdef __arch64__
100#define PICCY_SET(var,dest,tmp) \
101	3: rd %pc, tmp; add tmp,(var-3b),dest
102#else
103#define PICCY_SET(var,dest,tmp) \
104	mov %o7,tmp; 3: call 4f; nop; 4: \
105	add %o7,(var-3b),dest; mov tmp,%o7
106#endif
107#else
108#define PIC_PROLOGUE(dest,tmp)
109#define PICCY_OFFSET(var,dest,tmp)
110#endif
111
112#define FTYPE(x)		.type x,@function
113#define OTYPE(x)		.type x,@object
114
115#define	_ENTRY(name) \
116	.align 4; .globl name; FTYPE(name); name:
117
118#ifdef GPROF
119/* see _MCOUNT_ENTRY in profile.h */
120#ifdef __ELF__
121#ifdef __arch64__
122#define _PROF_PROLOGUE \
123	.data; .align 8; 1: .word 0; .word 0; \
124	.text; save %sp,-CC64FSZ,%sp; sethi %hi(1b),%o0; call _mcount; \
125	or %o0,%lo(1b),%o0; restore
126#else
127#define _PROF_PROLOGUE \
128	.data; .align 4; 1: .long 0; \
129	.text; save %sp,-96,%sp; sethi %hi(1b),%o0; call _mcount; \
130	or %o0,%lo(1b),%o0; restore
131#endif
132#else
133#ifdef __arch64__
134#define _PROF_PROLOGUE \
135	.data; .align 8; 1: .word 0; .word 0; \
136	.text; save %sp,-CC64FSZ,%sp; sethi %hi(1b),%o0; call mcount; \
137	or %o0,%lo(1b),%o0; restore
138#else
139#define	_PROF_PROLOGUE \
140	.data; .align 4; 1: .long 0; \
141	.text; save %sp,-96,%sp; sethi %hi(1b),%o0; call mcount; \
142	or %o0,%lo(1b),%o0; restore
143#endif
144#endif
145#else
146#define _PROF_PROLOGUE
147#endif
148
149#define ENTRY(name)		_ENTRY(_C_LABEL(name)); _PROF_PROLOGUE
150#define ENTRY_NOPROFILE(name)	_ENTRY(_C_LABEL(name))
151#define	ASENTRY(name)		_ENTRY(_ASM_LABEL(name)); _PROF_PROLOGUE
152#define	FUNC(name)		ASENTRY(name)
153#define RODATA(name)		.align 4; .text; .globl _C_LABEL(name); \
154				OTYPE(_C_LABEL(name)); _C_LABEL(name):
155#define	END(y)		.size y, . - y
156
157#define ASMSTR			.asciz
158
159#ifdef __ELF__
160#define RCSID(x)	.pushsection ".ident","MS",@progbits,1;		\
161			.asciz x;					\
162			.popsection
163#else
164#define RCSID(name)		.asciz name
165#endif
166
167#ifdef NO_KERNEL_RCSIDS
168#define	__KERNEL_RCSID(_n, _s)	/* nothing */
169#else
170#define	__KERNEL_RCSID(_n, _s)	RCSID(_s)
171#endif
172
173#ifdef __ELF__
174#define	WEAK_ALIAS(alias,sym)						\
175	.weak alias;							\
176	alias = sym
177#endif
178/*
179 * STRONG_ALIAS: create a strong alias.
180 */
181#define STRONG_ALIAS(alias,sym)						\
182	.globl alias;							\
183	alias = sym
184
185/*
186 * WARN_REFERENCES: create a warning if the specified symbol is referenced.
187 */
188#ifdef __ELF__
189#ifdef __STDC__
190#define	WARN_REFERENCES(sym,msg)					\
191	.pushsection .gnu.warning. ## sym;				\
192	.ascii msg;							\
193	.popsection
194#else
195#define	WARN_REFERENCES(sym,msg)					\
196	.pushsection .gnu.warning./**/sym;				\
197	.ascii msg;							\
198	.popsection
199#endif /* __STDC__ */
200#else
201#ifdef __STDC__
202#define	__STRING(x)			#x
203#define	WARN_REFERENCES(sym,msg)					\
204	.stabs msg ## ,30,0,0,0 ;					\
205	.stabs __STRING(_ ## sym) ## ,1,0,0,0
206#else
207#define	__STRING(x)			"x"
208#define	WARN_REFERENCES(sym,msg)					\
209	.stabs msg,30,0,0,0 ;						\
210	.stabs __STRING(_/**/sym),1,0,0,0
211#endif /* __STDC__ */
212#endif /* __ELF__ */
213
214#ifdef __arch64__
215#define INCR64X(what,r0,r1)						\
216	sethi	%hi(what), r0;						\
217	ldx	[r0 + %lo(what)], r1;					\
218	inc	r1;							\
219	stx	r1, [r0 + %lo(what)]
220#define INCR64(what)		INCR64X(what,%o0,%o1)
221#else
222#define INCR64X(what,r0,r1,r2)						\
223	sethi	%hi(what), r2;						\
224	ldd	[r2 + %lo(what)], r0;					\
225	inccc	r1;							\
226	addx	r0, 0, r0;						\
227	std	r0, [r2 + %lo(what)]
228#define INCR64(what)		INCR64X(what,%o0,%o1,%l7)
229#endif
230
231#endif /* _ASM_H_ */