xref: /illumos-gate/usr/src/uts/common/sys/isa_defs.h (revision fc2512cf)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 
23 /*
24  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
25  * Use is subject to license terms.
26  * Copyright 2016 Joyent, Inc.
27  */
28 
29 #ifndef	_SYS_ISA_DEFS_H
30 #define	_SYS_ISA_DEFS_H
31 
32 /*
33  * This header file serves to group a set of well known defines and to
34  * set these for each instruction set architecture.  These defines may
35  * be divided into two groups;  characteristics of the processor and
36  * implementation choices for Solaris on a processor.
37  *
38  * Processor Characteristics:
39  *
40  * _LITTLE_ENDIAN / _BIG_ENDIAN:
41  *	The natural byte order of the processor.  A pointer to an int points
42  *	to the least/most significant byte of that int.
43  *
44  * _STACK_GROWS_UPWARD / _STACK_GROWS_DOWNWARD:
45  *	The processor specific direction of stack growth.  A push onto the
46  *	stack increases/decreases the stack pointer, so it stores data at
47  *	successively higher/lower addresses.  (Stackless machines ignored
48  *	without regrets).
49  *
50  * _LONG_LONG_HTOL / _LONG_LONG_LTOH:
51  *	A pointer to a long long points to the most/least significant long
52  *	within that long long.
53  *
54  * _BIT_FIELDS_HTOL / _BIT_FIELDS_LTOH:
55  *	The C compiler assigns bit fields from the high/low to the low/high end
56  *	of an int (most to least significant vs. least to most significant).
57  *
58  * _IEEE_754:
59  *	The processor (or supported implementations of the processor)
60  *	supports the ieee-754 floating point standard.  No other floating
61  *	point standards are supported (or significant).  Any other supported
62  *	floating point formats are expected to be cased on the ISA processor
63  *	symbol.
64  *
65  * _CHAR_IS_UNSIGNED / _CHAR_IS_SIGNED:
66  *	The C Compiler implements objects of type `char' as `unsigned' or
67  *	`signed' respectively.  This is really an implementation choice of
68  *	the compiler writer, but it is specified in the ABI and tends to
69  *	be uniform across compilers for an instruction set architecture.
70  *	Hence, it has the properties of a processor characteristic.
71  *
72  * _CHAR_ALIGNMENT / _SHORT_ALIGNMENT / _INT_ALIGNMENT / _LONG_ALIGNMENT /
73  * _LONG_LONG_ALIGNMENT / _DOUBLE_ALIGNMENT / _LONG_DOUBLE_ALIGNMENT /
74  * _POINTER_ALIGNMENT / _FLOAT_ALIGNMENT:
75  *	The ABI defines alignment requirements of each of the primitive
76  *	object types.  Some, if not all, may be hardware requirements as
77  * 	well.  The values are expressed in "byte-alignment" units.
78  *
79  * _MAX_ALIGNMENT:
80  *	The most stringent alignment requirement as specified by the ABI.
81  *	Equal to the maximum of all the above _XXX_ALIGNMENT values.
82  *
83  * _MAX_ALIGNMENT_TYPE:
84  * 	The name of the C type that has the value descried in _MAX_ALIGNMENT.
85  *
86  * _ALIGNMENT_REQUIRED:
87  *	True or false (1 or 0) whether or not the hardware requires the ABI
88  *	alignment.
89  *
90  * _LONG_LONG_ALIGNMENT_32
91  *	The 32-bit ABI supported by a 64-bit kernel may have different
92  *	alignment requirements for primitive object types.  The value of this
93  *	identifier is expressed in "byte-alignment" units.
94  *
95  * _HAVE_CPUID_INSN
96  *	This indicates that the architecture supports the 'cpuid'
97  *	instruction as defined by Intel.  (Intel allows other vendors
98  *	to extend the instruction for their own purposes.)
99  *
100  *
101  * Implementation Choices:
102  *
103  * _ILP32 / _LP64:
104  *	This specifies the compiler data type implementation as specified in
105  *	the relevant ABI.  The choice between these is strongly influenced
106  *	by the underlying hardware, but is not absolutely tied to it.
107  *	Currently only two data type models are supported:
108  *
109  *	_ILP32:
110  *		Int/Long/Pointer are 32 bits.  This is the historical UNIX
111  *		and Solaris implementation.  Due to its historical standing,
112  *		this is the default case.
113  *
114  *	_LP64:
115  *		Long/Pointer are 64 bits, Int is 32 bits.  This is the chosen
116  *		implementation for 64-bit ABIs such as SPARC V9.
117  *
118  *	_I32LPx:
119  *		A compilation environment where 'int' is 32-bit, and
120  *		longs and pointers are simply the same size.
121  *
122  *	In all cases, Char is 8 bits and Short is 16 bits.
123  *
124  * _SUNOS_VTOC_8 / _SUNOS_VTOC_16 / _SVR4_VTOC_16:
125  *	This specifies the form of the disk VTOC (or label):
126  *
127  *	_SUNOS_VTOC_8:
128  *		This is a VTOC form which is upwardly compatible with the
129  *		SunOS 4.x disk label and allows 8 partitions per disk.
130  *
131  *	_SUNOS_VTOC_16:
132  *		In this format the incore vtoc image matches the ondisk
133  *		version.  It allows 16 slices per disk, and is not
134  *		compatible with the SunOS 4.x disk label.
135  *
136  *	Note that these are not the only two VTOC forms possible and
137  *	additional forms may be added.  One possible form would be the
138  *	SVr4 VTOC form.  The symbol for that is reserved now, although
139  *	it is not implemented.
140  *
141  *	_SVR4_VTOC_16:
142  *		This VTOC form is compatible with the System V Release 4
143  *		VTOC (as implemented on the SVr4 Intel and 3b ports) with
144  *		16 partitions per disk.
145  *
146  *
147  * _DMA_USES_PHYSADDR / _DMA_USES_VIRTADDR
148  *	This describes the type of addresses used by system DMA:
149  *
150  *	_DMA_USES_PHYSADDR:
151  *		This type of DMA, used in the x86 implementation,
152  *		requires physical addresses for DMA buffers.  The 24-bit
153  *		addresses used by some legacy boards is the source of the
154  *		"low-memory" (<16MB) requirement for some devices using DMA.
155  *
156  *	_DMA_USES_VIRTADDR:
157  *		This method of DMA allows the use of virtual addresses for
158  *		DMA transfers.
159  *
160  * _FIRMWARE_NEEDS_FDISK / _NO_FDISK_PRESENT
161  *      This indicates the presence/absence of an fdisk table.
162  *
163  *      _FIRMWARE_NEEDS_FDISK
164  *              The fdisk table is required by system firmware.  If present,
165  *              it allows a disk to be subdivided into multiple fdisk
166  *              partitions, each of which is equivalent to a separate,
167  *              virtual disk.  This enables the co-existence of multiple
168  *              operating systems on a shared hard disk.
169  *
170  *      _NO_FDISK_PRESENT
171  *              If the fdisk table is absent, it is assumed that the entire
172  *              media is allocated for a single operating system.
173  *
174  * _HAVE_TEM_FIRMWARE
175  *	Defined if this architecture has the (fallback) option of
176  *	using prom_* calls for doing I/O if a suitable kernel driver
177  *	is not available to do it.
178  *
179  * _DONT_USE_1275_GENERIC_NAMES
180  *		Controls whether or not device tree node names should
181  *		comply with the IEEE 1275 "Generic Names" Recommended
182  *		Practice. With _DONT_USE_GENERIC_NAMES, device-specific
183  *		names identifying the particular device will be used.
184  *
185  * __i386_COMPAT
186  *	This indicates whether the i386 ABI is supported as a *non-native*
187  *	mode for the platform.  When this symbol is defined:
188  *	-	32-bit xstat-style system calls are enabled
189  *	-	32-bit xmknod-style system calls are enabled
190  *	-	32-bit system calls use i386 sizes -and- alignments
191  *
192  *	Note that this is NOT defined for the i386 native environment!
193  *
194  * __x86
195  *	This is ONLY a synonym for defined(__i386) || defined(__amd64)
196  *	which is useful only insofar as these two architectures share
197  *	common attributes.  Analogous to __sparc.
198  *
199  * _PSM_MODULES
200  *	This indicates whether or not the implementation uses PSM
201  *	modules for processor support, reading /etc/mach from inside
202  *	the kernel to extract a list.
203  *
204  * _RTC_CONFIG
205  *	This indicates whether or not the implementation uses /etc/rtc_config
206  *	to configure the real-time clock in the kernel.
207  *
208  * _UNIX_KRTLD
209  *	This indicates that the implementation uses a dynamically
210  *	linked unix + krtld to form the core kernel image at boot
211  *	time, or (in the absence of this symbol) a prelinked kernel image.
212  *
213  * _OBP
214  *	This indicates the firmware interface is OBP.
215  *
216  * _SOFT_HOSTID
217  *	This indicates that the implementation obtains the hostid
218  *	from the file /etc/hostid, rather than from hardware.
219  */
220 
221 #ifdef	__cplusplus
222 extern "C" {
223 #endif
224 
225 /*
226  * The following set of definitions characterize Solaris on AMD's
227  * 64-bit systems.
228  */
229 #if defined(__x86_64) || defined(__amd64)
230 
231 #if !defined(__amd64)
232 #define	__amd64		/* preferred guard */
233 #endif
234 
235 #if !defined(__x86)
236 #define	__x86
237 #endif
238 
239 /*
240  * Define the appropriate "processor characteristics"
241  */
242 #define	_LITTLE_ENDIAN
243 #define	_STACK_GROWS_DOWNWARD
244 #define	_LONG_LONG_LTOH
245 #define	_BIT_FIELDS_LTOH
246 #define	_IEEE_754
247 #define	_CHAR_IS_SIGNED
248 #define	_BOOL_ALIGNMENT			1
249 #define	_CHAR_ALIGNMENT			1
250 #define	_SHORT_ALIGNMENT		2
251 #define	_INT_ALIGNMENT			4
252 #define	_FLOAT_ALIGNMENT		4
253 #define	_FLOAT_COMPLEX_ALIGNMENT	4
254 #define	_LONG_ALIGNMENT			8
255 #define	_LONG_LONG_ALIGNMENT		8
256 #define	_DOUBLE_ALIGNMENT		8
257 #define	_DOUBLE_COMPLEX_ALIGNMENT	8
258 #define	_LONG_DOUBLE_ALIGNMENT		16
259 #define	_LONG_DOUBLE_COMPLEX_ALIGNMENT	16
260 #define	_POINTER_ALIGNMENT		8
261 #define	_MAX_ALIGNMENT			16
262 #define	_ALIGNMENT_REQUIRED		1
263 #define	_MAX_ALIGNMENT_TYPE		long double
264 
265 /*
266  * Different alignment constraints for the i386 ABI in compatibility mode
267  */
268 #define	_LONG_LONG_ALIGNMENT_32		4
269 
270 /*
271  * Define the appropriate "implementation choices".
272  */
273 #if !defined(_LP64)
274 #define	_LP64
275 #endif
276 #if !defined(_I32LPx) && defined(_KERNEL)
277 #define	_I32LPx
278 #endif
279 #define	_MULTI_DATAMODEL
280 #define	_SUNOS_VTOC_16
281 #define	_DMA_USES_PHYSADDR
282 #define	_FIRMWARE_NEEDS_FDISK
283 #define	__i386_COMPAT
284 #define	_PSM_MODULES
285 #define	_RTC_CONFIG
286 #define	_SOFT_HOSTID
287 #define	_DONT_USE_1275_GENERIC_NAMES
288 #define	_HAVE_CPUID_INSN
289 
290 /*
291  * The feature test macro __i386 is generic for all processors implementing
292  * the Intel 386 instruction set or a superset of it.  Specifically, this
293  * includes all members of the 386, 486, and Pentium family of processors.
294  */
295 #elif defined(__i386) || defined(__i386__)
296 
297 #if !defined(__i386)
298 #define	__i386
299 #endif
300 
301 #if !defined(__x86)
302 #define	__x86
303 #endif
304 
305 /*
306  * Define the appropriate "processor characteristics"
307  */
308 #define	_LITTLE_ENDIAN
309 #define	_STACK_GROWS_DOWNWARD
310 #define	_LONG_LONG_LTOH
311 #define	_BIT_FIELDS_LTOH
312 #define	_IEEE_754
313 #define	_CHAR_IS_SIGNED
314 #define	_BOOL_ALIGNMENT			1
315 #define	_CHAR_ALIGNMENT			1
316 #define	_SHORT_ALIGNMENT		2
317 #define	_INT_ALIGNMENT			4
318 #define	_FLOAT_ALIGNMENT		4
319 #define	_FLOAT_COMPLEX_ALIGNMENT	4
320 #define	_LONG_ALIGNMENT			4
321 #define	_LONG_LONG_ALIGNMENT		4
322 #define	_DOUBLE_ALIGNMENT		4
323 #define	_DOUBLE_COMPLEX_ALIGNMENT	4
324 #define	_LONG_DOUBLE_ALIGNMENT		4
325 #define	_LONG_DOUBLE_COMPLEX_ALIGNMENT	4
326 #define	_POINTER_ALIGNMENT		4
327 #define	_MAX_ALIGNMENT			4
328 #define	_ALIGNMENT_REQUIRED		0
329 #define	_MAX_ALIGNMENT_TYPE		long
330 
331 #define	_LONG_LONG_ALIGNMENT_32		_LONG_LONG_ALIGNMENT
332 
333 /*
334  * Define the appropriate "implementation choices".
335  */
336 #if !defined(_ILP32)
337 #define	_ILP32
338 #endif
339 #if !defined(_I32LPx) && defined(_KERNEL)
340 #define	_I32LPx
341 #endif
342 #define	_SUNOS_VTOC_16
343 #define	_DMA_USES_PHYSADDR
344 #define	_FIRMWARE_NEEDS_FDISK
345 #define	_PSM_MODULES
346 #define	_RTC_CONFIG
347 #define	_SOFT_HOSTID
348 #define	_DONT_USE_1275_GENERIC_NAMES
349 #define	_HAVE_CPUID_INSN
350 
351 /*
352  * The following set of definitions characterize the Solaris on SPARC systems.
353  *
354  * The symbol __sparc indicates any of the SPARC family of processor
355  * architectures.  This includes SPARC V7, SPARC V8 and SPARC V9.
356  *
357  * The symbol __sparcv8 indicates the 32-bit SPARC V8 architecture as defined
358  * by Version 8 of the SPARC Architecture Manual.  (SPARC V7 is close enough
359  * to SPARC V8 for the former to be subsumed into the latter definition.)
360  *
361  * The symbol __sparcv9 indicates the 64-bit SPARC V9 architecture as defined
362  * by Version 9 of the SPARC Architecture Manual.
363  *
364  * The symbols __sparcv8 and __sparcv9 are mutually exclusive, and are only
365  * relevant when the symbol __sparc is defined.
366  */
367 /*
368  * XXX Due to the existence of 5110166, "defined(__sparcv9)" needs to be added
369  * to support backwards builds.  This workaround should be removed in s10_71.
370  */
371 #elif defined(__sparc) || defined(__sparcv9) || defined(__sparc__)
372 #if !defined(__sparc)
373 #define	__sparc
374 #endif
375 
376 /*
377  * You can be 32-bit or 64-bit, but not both at the same time.
378  */
379 #if defined(__sparcv8) && defined(__sparcv9)
380 #error	"SPARC Versions 8 and 9 are mutually exclusive choices"
381 #endif
382 
383 /*
384  * Existing compilers do not set __sparcv8.  Years will transpire before
385  * the compilers can be depended on to set the feature test macro. In
386  * the interim, we'll set it here on the basis of historical behaviour;
387  * if you haven't asked for SPARC V9, then you must've meant SPARC V8.
388  */
389 #if !defined(__sparcv9) && !defined(__sparcv8)
390 #define	__sparcv8
391 #endif
392 
393 /*
394  * Define the appropriate "processor characteristics" shared between
395  * all Solaris on SPARC systems.
396  */
397 #define	_BIG_ENDIAN
398 #define	_STACK_GROWS_DOWNWARD
399 #define	_LONG_LONG_HTOL
400 #define	_BIT_FIELDS_HTOL
401 #define	_IEEE_754
402 #define	_CHAR_IS_SIGNED
403 #define	_BOOL_ALIGNMENT			1
404 #define	_CHAR_ALIGNMENT			1
405 #define	_SHORT_ALIGNMENT		2
406 #define	_INT_ALIGNMENT			4
407 #define	_FLOAT_ALIGNMENT		4
408 #define	_FLOAT_COMPLEX_ALIGNMENT	4
409 #define	_LONG_LONG_ALIGNMENT		8
410 #define	_DOUBLE_ALIGNMENT		8
411 #define	_DOUBLE_COMPLEX_ALIGNMENT	8
412 #define	_ALIGNMENT_REQUIRED		1
413 
414 /*
415  * Define the appropriate "implementation choices" shared between versions.
416  */
417 #define	_SUNOS_VTOC_8
418 #define	_DMA_USES_VIRTADDR
419 #define	_NO_FDISK_PRESENT
420 #define	_HAVE_TEM_FIRMWARE
421 #define	_OBP
422 
423 /*
424  * The following set of definitions characterize the implementation of
425  * 32-bit Solaris on SPARC V8 systems.
426  */
427 #if defined(__sparcv8)
428 
429 /*
430  * Define the appropriate "processor characteristics"
431  */
432 #define	_LONG_ALIGNMENT			4
433 #define	_LONG_DOUBLE_ALIGNMENT		8
434 #define	_LONG_DOUBLE_COMPLEX_ALIGNMENT	8
435 #define	_POINTER_ALIGNMENT		4
436 #define	_MAX_ALIGNMENT			8
437 #define	_MAX_ALIGNMENT_TYPE		long double
438 
439 #define	_LONG_LONG_ALIGNMENT_32		_LONG_LONG_ALIGNMENT
440 
441 /*
442  * Define the appropriate "implementation choices"
443  */
444 #if !defined(_ILP32)
445 #define	_ILP32
446 #endif
447 #if !defined(_I32LPx) && defined(_KERNEL)
448 #define	_I32LPx
449 #endif
450 
451 /*
452  * The following set of definitions characterize the implementation of
453  * 64-bit Solaris on SPARC V9 systems.
454  */
455 #elif defined(__sparcv9)
456 
457 /*
458  * Define the appropriate "processor characteristics"
459  */
460 #define	_LONG_ALIGNMENT			8
461 #define	_LONG_DOUBLE_ALIGNMENT		16
462 #define	_LONG_DOUBLE_COMPLEX_ALIGNMENT	16
463 #define	_POINTER_ALIGNMENT		8
464 #define	_MAX_ALIGNMENT			16
465 #define	_MAX_ALIGNMENT_TYPE		long double
466 
467 #define	_LONG_LONG_ALIGNMENT_32		_LONG_LONG_ALIGNMENT
468 
469 /*
470  * Define the appropriate "implementation choices"
471  */
472 #if !defined(_LP64)
473 #define	_LP64
474 #endif
475 #if !defined(_I32LPx)
476 #define	_I32LPx
477 #endif
478 #define	_MULTI_DATAMODEL
479 
480 #else
481 #error	"unknown SPARC version"
482 #endif
483 
484 /*
485  * #error is strictly ansi-C, but works as well as anything for K&R systems.
486  */
487 #else
488 #error "ISA not supported"
489 #endif
490 
491 #if defined(_ILP32) && defined(_LP64)
492 #error "Both _ILP32 and _LP64 are defined"
493 #endif
494 
495 #ifdef	__cplusplus
496 }
497 #endif
498 
499 #endif	/* _SYS_ISA_DEFS_H */
500