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