1 .\" Copyright (c) 2016-2017 The FreeBSD Foundation. All rights reserved.
3 .\" This documentation was created by Ed Maste under sponsorship of
4 .\" The FreeBSD Foundation.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .Nd Architecture-specific details
36 Differences between CPU architectures and platforms supported by
39 This document is a quick reference of key ABI details of
42 For full details consult the processor-specific ABI supplement
45 If not explicitly mentioned, sizes are in bytes.
46 The architecture details in this document apply to
48 and later, unless otherwise noted.
51 uses a flat address space.
57 and pointers all have the same representation.
59 In order to maximize compatibility with future pointer integrity mechanisms,
60 manipulations of pointers as integers should be performed via
71 On some architectures, e.g.,
76 the kernel uses a separate address space.
77 On other architectures, kernel and a user mode process share a
79 The kernel is located at the highest addresses.
81 On each architecture, the main user mode thread's stack starts near
82 the highest user address and grows down.
85 architecture support varies by release.
86 This table shows the first
88 release to support each architecture, and, for discontinued
89 architectures, the final release.
91 .Bl -column -offset indent "Sy Architecture" "Sy Initial Release" "Sy Final Release"
92 .It Sy Architecture Ta Sy Initial Release Ta Sy Final Release
94 .It alpha Ta 3.2 Ta 6.4
97 .It armeb Ta 8.0 Ta 11.x
100 .It ia64 Ta 5.0 Ta 10.x
109 .It mips64elhf Ta 12.0
111 .It pc98 Ta 2.2 Ta 11.x
113 .It powerpcspe Ta 12.0
116 .It riscv64sf Ta 12.0
122 architectures use some variant of the ELF (see
124 .Sy Application Binary Interface
125 (ABI) for the machine processor.
126 All supported ABIs can be divided into two groups:
127 .Bl -tag -width "Dv ILP32"
132 types machine representations all have 4-byte size.
135 type machine representation uses 4 bytes,
144 symbol when compiling for an
148 Some machines support more that one
151 Typically these are 64-bit machines, where the
154 execution environment is accompanied by the
157 environment, which was historical 32-bit predecessor for 64-bit evolution.
159 .Bl -column -offset indent "Dv powerpc64" "Sy ILP32 counterpart"
160 .It Sy LP64 Ta Sy ILP32 counterpart
161 .It Dv amd64 Ta Dv i386
162 .It Dv powerpc64 Ta Dv powerpc
163 .It Dv mips64* Ta Dv mips*
166 currently does not support execution of
170 binaries, even if the CPU implements
174 On all supported architectures:
175 .Bl -column -offset -indent "long long" "Size"
176 .It Sy Type Ta Sy Size
179 .It long Ta sizeof(void*)
184 Integers are represented in two's complement.
185 Alignment of integer and pointer types is natural, that is,
186 the address of the variable must be congruent to zero modulo the type size.
187 Most ILP32 ABIs, except
189 require only 4-byte alignment for 64-bit integers.
191 Machine-dependent type sizes:
192 .Bl -column -offset indent "Sy Architecture" "Sy void *" "Sy long double" "Sy time_t"
193 .It Sy Architecture Ta Sy void * Ta Sy long double Ta Sy time_t
194 .It aarch64 Ta 8 Ta 16 Ta 8
195 .It amd64 Ta 8 Ta 16 Ta 8
196 .It arm Ta 4 Ta 8 Ta 8
197 .It armv6 Ta 4 Ta 8 Ta 8
198 .It i386 Ta 4 Ta 12 Ta 4
199 .It mips Ta 4 Ta 8 Ta 8
200 .It mipsel Ta 4 Ta 8 Ta 8
201 .It mipselhf Ta 4 Ta 8 Ta 8
202 .It mipshf Ta 4 Ta 8 Ta 8
203 .It mipsn32 Ta 4 Ta 8 Ta 8
204 .It mips64 Ta 8 Ta 8 Ta 8
205 .It mips64el Ta 8 Ta 8 Ta 8
206 .It mips64elhf Ta 8 Ta 8 Ta 8
207 .It mips64hf Ta 8 Ta 8 Ta 8
208 .It powerpc Ta 4 Ta 8 Ta 8
209 .It powerpcspe Ta 4 Ta 8 Ta 8
210 .It powerpc64 Ta 8 Ta 8 Ta 8
211 .It riscv64 Ta 8 Ta 16 Ta 8
212 .It riscv64sf Ta 8 Ta 16 Ta 8
213 .It sparc64 Ta 8 Ta 16 Ta 8
217 is 8 bytes on all supported architectures except i386.
218 .Ss Endianness and Char Signedness
219 .Bl -column -offset indent "Sy Architecture" "Sy Endianness" "Sy char Signedness"
220 .It Sy Architecture Ta Sy Endianness Ta Sy char Signedness
221 .It aarch64 Ta little Ta unsigned
222 .It amd64 Ta little Ta signed
223 .It arm Ta little Ta unsigned
224 .It armv6 Ta little Ta unsigned
225 .It armv7 Ta little Ta unsigned
226 .It i386 Ta little Ta signed
227 .It mips Ta big Ta signed
228 .It mipsel Ta little Ta signed
229 .It mipselhf Ta little Ta signed
230 .It mipshf Ta big Ta signed
231 .It mipsn32 Ta big Ta signed
232 .It mips64 Ta big Ta signed
233 .It mips64el Ta little Ta signed
234 .It mips64elhf Ta little Ta signed
235 .It mips64hf Ta big Ta signed
236 .It powerpc Ta big Ta unsigned
237 .It powerpcspe Ta big Ta unsigned
238 .It powerpc64 Ta big Ta unsigned
239 .It riscv64 Ta little Ta signed
240 .It riscv64sf Ta little Ta signed
241 .It sparc64 Ta big Ta signed
244 .Bl -column -offset indent "Sy Architecture" "Sy Page Sizes"
245 .It Sy Architecture Ta Sy Page Sizes
246 .It aarch64 Ta 4K, 2M, 1G
247 .It amd64 Ta 4K, 2M, 1G
251 .It i386 Ta 4K, 2M (PAE), 4M
269 .Bl -column -offset indent "Sy Architecture" "Sy float, double" "Sy long double"
270 .It Sy Architecture Ta Sy float, double Ta Sy long double
271 .It aarch64 Ta hard Ta soft, quad precision
272 .It amd64 Ta hard Ta hard, 80 bit
273 .It arm Ta soft Ta soft, double precision
274 .It armv6 Ta hard(1) Ta hard, double precision
275 .It armv7 Ta hard(1) Ta hard, double precision
276 .It i386 Ta hard Ta hard, 80 bit
277 .It mips Ta soft Ta identical to double
278 .It mipsel Ta soft Ta identical to double
279 .It mipselhf Ta hard Ta identical to double
280 .It mipshf Ta hard Ta identical to double
281 .It mipsn32 Ta soft Ta identical to double
282 .It mips64 Ta soft Ta identical to double
283 .It mips64el Ta soft Ta identical to double
284 .It mips64elhf Ta hard Ta identical to double
285 .It mips64hf Ta hard Ta identical to double
286 .It powerpc Ta hard Ta hard, double precision
287 .It powerpcspe Ta hard Ta hard, double precision
288 .It powerpc64 Ta hard Ta hard, double precision
289 .It riscv64 Ta hard Ta hard, double precision
290 .It riscv64sf Ta soft Ta soft, double precision
291 .It sparc64 Ta hard Ta hard, quad precision
296 armv6 used the softfp ABI even though it supported only processors
297 with a floating point unit.
298 .Ss Predefined Macros
299 The compiler provides a number of predefined macros.
300 Some of these provide architecture-specific details and are explained below.
301 Other macros, including those required by the language standard, are not
304 The full set of predefined macros can be obtained with this command:
305 .Bd -literal -offset indent
306 cc -x c -dM -E /dev/null
309 Common type size and endianness macros:
310 .Bl -column -offset indent "BYTE_ORDER" "Sy Meaning"
311 .It Sy Macro Ta Sy Meaning
312 .It Dv __LP64__ Ta 64-bit (8-byte) long and pointer, 32-bit (4-byte) int
313 .It Dv __ILP32__ Ta 32-bit (4-byte) int, long and pointer
314 .It Dv BYTE_ORDER Ta Either Dv BIG_ENDIAN or Dv LITTLE_ENDIAN .
320 Architecture-specific macros:
321 .Bl -column -offset indent "Sy Architecture" "Sy Predefined macros"
322 .It Sy Architecture Ta Sy Predefined macros
323 .It aarch64 Ta Dv __aarch64__
324 .It amd64 Ta Dv __amd64__, Dv __x86_64__
325 .It arm Ta Dv __arm__
326 .It armv6 Ta Dv __arm__, Dv __ARM_ARCH >= 6
327 .It armv7 Ta Dv __arm__, Dv __ARM_ARCH >= 7
328 .It i386 Ta Dv __i386__
329 .It mips Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_o32
330 .It mipsel Ta Dv __mips__, Dv __mips_o32
331 .It mipselhf Ta Dv __mips__, Dv __mips_o32
332 .It mipshf Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_o32
333 .It mipsn32 Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_n32
334 .It mips64 Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_n64
335 .It mips64el Ta Dv __mips__, Dv __mips_n64
336 .It mips64elhf Ta Dv __mips__, Dv __mips_n64
337 .It mips64hf Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_n64
338 .It powerpc Ta Dv __powerpc__
339 .It powerpcspe Ta Dv __powerpc__, Dv __SPE__
340 .It powerpc64 Ta Dv __powerpc__, Dv __powerpc64__
341 .It riscv64 Ta Dv __riscv, Dv __riscv_xlen == 64
342 .It riscv64sf Ta Dv __riscv, Dv __riscv_xlen == 64
343 .It sparc64 Ta Dv __sparc64__
346 Compilers may define additional variants of architecture-specific macros.
347 The macros above are preferred for use in
349 .Ss Important Xr make 1 variables
350 Most of the externally settable variables are defined in the
353 These variables are not otherwise documented and are used extensively
355 .Bl -column -offset indent "Sy Variable" "Sy Meaning and usage"
356 .It Dv MACHINE Represent the hardware platform.
357 This is the same as the native platform's
361 It defines both the userland / kernel interface, as well as the
362 bootloader / kernel interface.
363 It should only be used in these contexts.
364 Each CPU architecture may have multiple hardware platforms it supports
368 It is used to collect together all the files from
371 It is often the same as
373 just as one CPU architecture can be implemented by many different
374 hardware platforms, one hardware platform may support multiple CPU
375 architecture family members, though with different binaries.
378 of i386 supported the IBM-AT hardware platform while the
380 of pc98 supported the Japanese company NEC's PC-9801 and PC-9821
382 Both of these hardware platforms supported only the
384 of i386 where they shared a common ABI, except for certain kernel /
385 userland interfaces relating to underlying hardware platform
386 differences in bus architecture, device enumeration and boot interface.
389 should only be used in src/sys and src/stand or in system imagers or
391 .It Dv MACHINE_ARCH Represents the CPU processor architecture.
392 This is the same as the native platforms
396 It defines the CPU instruction family supported.
397 It may also encode a variation in the byte ordering of multi-byte
399 It may also encode a variation in the size of the integer or pointer.
400 It may also encode a ISA revision.
401 It may also encode hard versus soft floating point ABI and usage.
402 It may also encode a variant ABI when the other factors do not
403 uniquely define the ABI (e.g., MIPS' n32 ABI).
406 defines the ABI used by the system.
407 For example, the MIPS CPU processor family supports 9 different
408 combinations encoding pointer size, endian and hard versus soft float (for
409 8 combinations) as well as N32 (which only ever had one variation of
411 Generally, the plain CPU name specifies the most common (or at least
412 first) variant of the CPU.
413 This is why mips and mips64 imply 'big endian' while 'arm' and 'armv7'
415 If we ever were to support the so-called x32 ABI (using 32-bit
416 pointers on the amd64 architecture), it would most likely be encoded
418 It is unfortunate that amd64 specifies the 64-bit evolution of the x86
419 platform (it matches the 'first rule') as everybody else uses x86_64.
420 There is no standard name for the processor: each OS selects its own
422 .It Dv MACHINE_CPUARCH Represents the source location for a given
426 is defined to be mips for all the flavors of mips that we support
427 since we support them all with a shared set of sources.
428 While amd64 and i386 are closely related, MACHINE_CPUARCH is not x86
430 The FreeBSD source base supports amd64 and i386 with two
431 distinct source bases living in subdirectories named amd64 and i386
432 (though behind the scenes there's some sharing that fits into this
434 .It Dv CPUTYPE Sets the flavor of
437 It is used to optimize the build for a specific CPU / core that the
439 Generally, this does not change the ABI, though it can be a fine line
440 between optimization for specific cases.
441 .It Dv TARGET Used to set
443 in the top level Makefile for cross building.
444 Unused outside of that scope.
445 It is not passed down to the rest of the build.
446 Makefiles outside of the top level should not use it at all (though
447 some have their own private copy for hysterical raisons).
448 .It Dv TARGET_ARCH Used to set
450 by the top level Makefile for cross building.
452 .Dv TARGET , it is unused outside of that scope.
460 manual page appeared in