share/man/man7/arch.7

   1 .\" Copyright (c) 2016-2017 The FreeBSD Foundation. All rights reserved.
   2 .\"
   3 .\" This documentation was created by Ed Maste under sponsorship of
   4 .\" The FreeBSD Foundation.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   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.
  14 .\"
  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
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd June 23, 2020
  30 .Dt ARCH 7
  31 .Os
  32 .Sh NAME
  33 .Nm arch
  34 .Nd Architecture-specific details
  35 .Sh DESCRIPTION
  36 Differences between CPU architectures and platforms supported by
  37 .Fx .
  38 .Ss Introduction
  39 This document is a quick reference of key ABI details of
  40 .Fx
  41 architecture ports.
  42 For full details consult the processor-specific ABI supplement
  43 documentation.
  44 .Pp
  45 If not explicitly mentioned, sizes are in bytes.
  46 The architecture details in this document apply to
  47 .Fx 10.0
  48 and later, unless otherwise noted.
  49 .Pp
  50 .Fx
  51 uses a flat address space.
  52 Variables of types
  53 .Vt unsigned long ,
  54 .Vt uintptr_t ,
  55 and
  56 .Vt size_t
  57 and pointers all have the same representation.
  58 .Pp
  59 In order to maximize compatibility with future pointer integrity mechanisms,
  60 manipulations of pointers as integers should be performed via
  61 .Vt uintptr_t
  62 or
  63 .Vt intptr_t
  64 and no other types.
  65 In particular,
  66 .Vt long
  67 and
  68 .Vt ptrdiff_t
  69 should be avoided.
  70 .Pp
  71 On some architectures, e.g.,
  72 .Dv sparc64 ,
  73 .Dv powerpc
  74 and AIM variants of
  75 .Dv powerpc64 ,
  76 the kernel uses a separate address space.
  77 On other architectures, kernel and a user mode process share a
  78 single address space.
  79 The kernel is located at the highest addresses.
  80 .Pp
  81 On each architecture, the main user mode thread's stack starts near
  82 the highest user address and grows down.
  83 .Pp
  84 .Fx
  85 architecture support varies by release.
  86 This table shows the first
  87 .Fx
  88 release to support each architecture, and, for discontinued
  89 architectures, the final release.
  90 .Pp
  91 .Bl -column -offset indent "Architecture" "Initial Release" "Final Release"
  92 .It Sy Architecture Ta Sy Initial Release Ta Sy Final Release
  93 .It aarch64     Ta 11.0
  94 .It alpha       Ta 3.2   Ta 6.4
  95 .It amd64       Ta 5.1
  96 .It arm         Ta 6.0   Ta 12.x
  97 .It armeb       Ta 8.0   Ta 11.x
  98 .It armv6       Ta 10.0
  99 .It armv7       Ta 12.0
 100 .It ia64        Ta 5.0   Ta 10.4
 101 .It i386        Ta 1.0
 102 .It mips        Ta 8.0
 103 .It mipsel      Ta 9.0
 104 .It mipselhf    Ta 12.0
 105 .It mipshf      Ta 12.0
 106 .It mipsn32     Ta 9.0
 107 .It mips64      Ta 9.0
 108 .It mips64el    Ta 9.0
 109 .It mips64elhf  Ta 12.0
 110 .It mips64hf    Ta 12.0
 111 .It pc98        Ta 2.2   Ta 11.x
 112 .It powerpc     Ta 6.0
 113 .It powerpcspe  Ta 12.0
 114 .It powerpc64   Ta 6.0
 115 .It riscv64     Ta 12.0
 116 .It riscv64sf   Ta 12.0
 117 .It sparc64     Ta 5.0   Ta 12.x
 118 .El
 119 .Ss Type sizes
 120 All
 121 .Fx
 122 architectures use some variant of the ELF (see
 123 .Xr elf 5 )
 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"
 128 .It Dv ILP32
 129 .Vt int ,
 130 .Vt long ,
 131 .Vt void *
 132 types machine representations all have 4-byte size.
 133 .It Dv LP64
 134 .Vt int
 135 type machine representation uses 4 bytes,
 136 while
 137 .Vt long
 138 and
 139 .Vt void *
 140 are 8 bytes.
 141 .El
 142 .Pp
 143 Some machines support more than one
 144 .Fx
 145 ABI.
 146 Typically these are 64-bit machines, where the
 147 .Dq native
 148 .Dv LP64
 149 execution environment is accompanied by the
 150 .Dq legacy
 151 .Dv ILP32
 152 environment, which was the historical 32-bit predecessor for 64-bit evolution.
 153 Examples are:
 154 .Bl -column -offset indent "powerpc64" "ILP32 counterpart"
 155 .It Sy LP64        Ta Sy ILP32 counterpart
 156 .It Dv amd64       Ta Dv i386
 157 .It Dv powerpc64   Ta Dv powerpc
 158 .It Dv mips64*     Ta Dv mips*
 159 .El
 160 .Pp
 161 .Dv aarch64
 162 currently does not support execution of
 163 .Dv armv6
 164 or
 165 .Dv armv7
 166 binaries, even if the CPU implements
 167 .Dv AArch32
 168 execution state.
 169 .Pp
 170 On all supported architectures:
 171 .Bl -column -offset -indent "long long" "Size"
 172 .It Sy Type Ta Sy Size
 173 .It short Ta 2
 174 .It int Ta 4
 175 .It long Ta sizeof(void*)
 176 .It long long Ta 8
 177 .It float Ta 4
 178 .It double Ta 8
 179 .El
 180 .Pp
 181 Integers are represented in two's complement.
 182 Alignment of integer and pointer types is natural, that is,
 183 the address of the variable must be congruent to zero modulo the type size.
 184 Most ILP32 ABIs, except
 185 .Dv arm ,
 186 require only 4-byte alignment for 64-bit integers.
 187 .Pp
 188 Machine-dependent type sizes:
 189 .Bl -column -offset indent "Architecture" "void *" "long double" "time_t"
 190 .It Sy Architecture Ta Sy void * Ta Sy long double Ta Sy time_t
 191 .It aarch64     Ta 8 Ta 16 Ta 8
 192 .It amd64       Ta 8 Ta 16 Ta 8
 193 .It arm         Ta 4 Ta  8 Ta 8
 194 .It armv6       Ta 4 Ta  8 Ta 8
 195 .It i386        Ta 4 Ta 12 Ta 4
 196 .It mips        Ta 4 Ta  8 Ta 8
 197 .It mipsel      Ta 4 Ta  8 Ta 8
 198 .It mipselhf    Ta 4 Ta  8 Ta 8
 199 .It mipshf      Ta 4 Ta  8 Ta 8
 200 .It mipsn32     Ta 4 Ta  8 Ta 8
 201 .It mips64      Ta 8 Ta  8 Ta 8
 202 .It mips64el    Ta 8 Ta  8 Ta 8
 203 .It mips64elhf  Ta 8 Ta  8 Ta 8
 204 .It mips64hf    Ta 8 Ta  8 Ta 8
 205 .It powerpc     Ta 4 Ta  8 Ta 8
 206 .It powerpcspe  Ta 4 Ta  8 Ta 8
 207 .It powerpc64   Ta 8 Ta  8 Ta 8
 208 .It riscv64     Ta 8 Ta 16 Ta 8
 209 .It riscv64sf   Ta 8 Ta 16 Ta 8
 210 .It sparc64     Ta 8 Ta 16 Ta 8
 211 .El
 212 .Pp
 213 .Sy time_t
 214 is 8 bytes on all supported architectures except i386.
 215 .Ss Endianness and Char Signedness
 216 .Bl -column -offset indent "Architecture" "Endianness" "char Signedness"
 217 .It Sy Architecture Ta Sy Endianness Ta Sy char Signedness
 218 .It aarch64     Ta little Ta unsigned
 219 .It amd64       Ta little Ta   signed
 220 .It arm         Ta little Ta unsigned
 221 .It armv6       Ta little Ta unsigned
 222 .It armv7       Ta little Ta unsigned
 223 .It i386        Ta little Ta   signed
 224 .It mips        Ta big    Ta   signed
 225 .It mipsel      Ta little Ta   signed
 226 .It mipselhf    Ta little Ta   signed
 227 .It mipshf      Ta big    Ta   signed
 228 .It mipsn32     Ta big    Ta   signed
 229 .It mips64      Ta big    Ta   signed
 230 .It mips64el    Ta little Ta   signed
 231 .It mips64elhf  Ta little Ta   signed
 232 .It mips64hf    Ta big    Ta   signed
 233 .It powerpc     Ta big    Ta unsigned
 234 .It powerpcspe  Ta big    Ta unsigned
 235 .It powerpc64   Ta big    Ta unsigned
 236 .It riscv64     Ta little Ta   signed
 237 .It riscv64sf   Ta little Ta   signed
 238 .It sparc64     Ta big    Ta   signed
 239 .El
 240 .Ss Page Size
 241 .Bl -column -offset indent "Architecture" "Page Sizes"
 242 .It Sy Architecture Ta Sy Page Sizes
 243 .It aarch64     Ta 4K, 2M, 1G
 244 .It amd64       Ta 4K, 2M, 1G
 245 .It arm         Ta 4K
 246 .It armv6       Ta 4K, 1M
 247 .It armv7       Ta 4K, 1M
 248 .It i386        Ta 4K, 2M (PAE), 4M
 249 .It mips        Ta 4K
 250 .It mipsel      Ta 4K
 251 .It mipselhf    Ta 4K
 252 .It mipshf      Ta 4K
 253 .It mipsn32     Ta 4K
 254 .It mips64      Ta 4K
 255 .It mips64el    Ta 4K
 256 .It mips64elhf  Ta 4K
 257 .It mips64hf    Ta 4K
 258 .It powerpc     Ta 4K
 259 .It powerpcspe  Ta 4K
 260 .It powerpc64   Ta 4K
 261 .It riscv64     Ta 4K, 2M, 1G
 262 .It riscv64sf   Ta 4K, 2M, 1G
 263 .It sparc64     Ta 8K
 264 .El
 265 .Ss Floating Point
 266 .Bl -column -offset indent "Architecture" "float, double" "long double"
 267 .It Sy Architecture Ta Sy float, double Ta Sy long double
 268 .It aarch64     Ta hard Ta soft, quad precision
 269 .It amd64       Ta hard Ta hard, 80 bit
 270 .It arm         Ta soft Ta soft, double precision
 271 .It armv6       Ta hard(1) Ta hard, double precision
 272 .It armv7       Ta hard(1) Ta hard, double precision
 273 .It i386        Ta hard Ta hard, 80 bit
 274 .It mips        Ta soft Ta identical to double
 275 .It mipsel      Ta soft Ta identical to double
 276 .It mipselhf    Ta hard Ta identical to double
 277 .It mipshf      Ta hard Ta identical to double
 278 .It mipsn32     Ta soft Ta identical to double
 279 .It mips64      Ta soft Ta identical to double
 280 .It mips64el    Ta soft Ta identical to double
 281 .It mips64elhf  Ta hard Ta identical to double
 282 .It mips64hf    Ta hard Ta identical to double
 283 .It powerpc     Ta hard Ta hard, double precision
 284 .It powerpcspe  Ta hard Ta hard, double precision
 285 .It powerpc64   Ta hard Ta hard, double precision
 286 .It riscv64     Ta hard Ta hard, quad precision
 287 .It riscv64sf   Ta soft Ta soft, quad precision
 288 .It sparc64     Ta hard Ta hard, quad precision
 289 .El
 290 .Pp
 291 (1) Prior to
 292 .Fx 11.0 ,
 293 armv6 used the softfp ABI even though it supported only processors
 294 with a floating point unit.
 295 .Ss Default Tool Chain
 296 .Fx uses a variety of tool chain components for the supported CPU
 297 architectures:
 298 .Xr clang 1
 299 and
 300 .Xr ld.lld 1
 301 provided by the base system,
 302 GNU
 303 .Xr gcc 1
 304 and Binutils
 305 .Xr ld 1 ,
 306 or an external toolchain compiler and linker provided by a port or package.
 307 This table shows the default tool chain for each architecture.
 308 .Bl -column -offset indent "Architecture" "Compiler" "Linker"
 309 .It Sy Architecture Ta Sy Compiler Ta Sy Linker
 310 .It aarch64     Ta Clang     Ta lld
 311 .It amd64       Ta Clang     Ta lld
 312 .It arm         Ta Clang     Ta GNU ld 2.17.50
 313 .It armv6       Ta Clang     Ta lld
 314 .It armv7       Ta Clang     Ta lld
 315 .It i386        Ta Clang     Ta lld
 316 .It mips        Ta GCC 4.2.1 Ta GNU ld 2.17.50
 317 .It mipsel      Ta GCC 4.2.1 Ta GNU ld 2.17.50
 318 .It mipselhf    Ta GCC 4.2.1 Ta GNU ld 2.17.50
 319 .It mipshf      Ta GCC 4.2.1 Ta GNU ld 2.17.50
 320 .It mipsn32     Ta GCC 4.2.1 Ta GNU ld 2.17.50
 321 .It mips64      Ta GCC 4.2.1 Ta GNU ld 2.17.50
 322 .It mips64el    Ta GCC 4.2.1 Ta GNU ld 2.17.50
 323 .It mips64elhf  Ta GCC 4.2.1 Ta GNU ld 2.17.50
 324 .It mips64hf    Ta GCC 4.2.1 Ta GNU ld 2.17.50
 325 .It powerpc     Ta GCC 4.2.1 Ta GNU ld 2.17.50
 326 .It powerpcspe  Ta GCC 4.2.1 Ta GNU ld 2.17.50
 327 .It powerpc64   Ta GCC 4.2.1 Ta GNU ld 2.17.50
 328 .It riscv64     Ta Clang     Ta lld
 329 .It riscv64sf   Ta Clang     Ta lld
 330 .It sparc64     Ta GCC 4.2.1 Ta GNU ld 2.17.50
 331 .El
 332 .Pp
 333 Note that GCC 4.2.1 is deprecated, and scheduled for removal on 2020-03-31.
 334 Any CPU architectures not migrated by then
 335 (to either base system Clang or external toolchain)
 336 may be removed from the tree after that date.
 337 .Ss Predefined Macros
 338 The compiler provides a number of predefined macros.
 339 Some of these provide architecture-specific details and are explained below.
 340 Other macros, including those required by the language standard, are not
 341 included here.
 342 .Pp
 343 The full set of predefined macros can be obtained with this command:
 344 .Bd -literal -offset indent
 345 cc -x c -dM -E /dev/null
 346 .Ed
 347 .Pp
 348 Common type size and endianness macros:
 349 .Bl -column -offset indent "BYTE_ORDER" "Meaning"
 350 .It Sy Macro Ta Sy Meaning
 351 .It Dv __LP64__ Ta 64-bit (8-byte) long and pointer, 32-bit (4-byte) int
 352 .It Dv __ILP32__ Ta 32-bit (4-byte) int, long and pointer
 353 .It Dv BYTE_ORDER Ta Either Dv BIG_ENDIAN or Dv LITTLE_ENDIAN .
 354 .Dv PDP11_ENDIAN
 355 is not used on
 356 .Fx .
 357 .El
 358 .Pp
 359 Architecture-specific macros:
 360 .Bl -column -offset indent "Architecture" "Predefined macros"
 361 .It Sy Architecture Ta Sy Predefined macros
 362 .It aarch64     Ta Dv __aarch64__
 363 .It amd64       Ta Dv __amd64__, Dv __x86_64__
 364 .It arm         Ta Dv __arm__
 365 .It armv6       Ta Dv __arm__, Dv __ARM_ARCH >= 6
 366 .It armv7       Ta Dv __arm__, Dv __ARM_ARCH >= 7
 367 .It i386        Ta Dv __i386__
 368 .It mips        Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_o32
 369 .It mipsel      Ta Dv __mips__, Dv __mips_o32
 370 .It mipselhf    Ta Dv __mips__, Dv __mips_o32
 371 .It mipshf      Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_o32
 372 .It mipsn32     Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_n32
 373 .It mips64      Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_n64
 374 .It mips64el    Ta Dv __mips__, Dv __mips_n64
 375 .It mips64elhf  Ta Dv __mips__, Dv __mips_n64
 376 .It mips64hf    Ta Dv __mips__, Dv __MIPSEB__, Dv __mips_n64
 377 .It powerpc     Ta Dv __powerpc__
 378 .It powerpcspe  Ta Dv __powerpc__, Dv __SPE__
 379 .It powerpc64   Ta Dv __powerpc__, Dv __powerpc64__
 380 .It riscv64     Ta Dv __riscv, Dv __riscv_xlen == 64
 381 .It riscv64sf   Ta Dv __riscv, Dv __riscv_xlen == 64, Dv __riscv_float_abi_soft
 382 .It sparc64     Ta Dv __sparc64__
 383 .El
 384 .Pp
 385 Compilers may define additional variants of architecture-specific macros.
 386 The macros above are preferred for use in
 387 .Fx .
 388 .Ss Important Xr make 1 variables
 389 Most of the externally settable variables are defined in the
 390 .Xr build 7
 391 man page.
 392 These variables are not otherwise documented and are used extensively
 393 in the build system.
 394 .Bl -tag -width "MACHINE_CPUARCH"
 395 .It Dv MACHINE
 396 Represents the hardware platform.
 397 This is the same as the native platform's
 398 .Xr uname 1
 399 .Fl m
 400 output.
 401 It defines both the userland / kernel interface, as well as the
 402 bootloader / kernel interface.
 403 It should only be used in these contexts.
 404 Each CPU architecture may have multiple hardware platforms it supports
 405 where
 406 .Dv MACHINE
 407 differs among them.
 408 It is used to collect together all the files from
 409 .Xr config 8
 410 to build the kernel.
 411 It is often the same as
 412 .Dv MACHINE_ARCH
 413 just as one CPU architecture can be implemented by many different
 414 hardware platforms, one hardware platform may support multiple CPU
 415 architecture family members, though with different binaries.
 416 For example,
 417 .Dv MACHINE
 418 of i386 supported the IBM-AT hardware platform while the
 419 .Dv MACHINE
 420 of pc98 supported the Japanese company NEC's PC-9801 and PC-9821
 421 hardware platforms.
 422 Both of these hardware platforms supported only the
 423 .Dv MACHINE_ARCH
 424 of i386 where they shared a common ABI, except for certain kernel /
 425 userland interfaces relating to underlying hardware platform
 426 differences in bus architecture, device enumeration and boot interface.
 427 Generally,
 428 .Dv MACHINE
 429 should only be used in src/sys and src/stand or in system imagers or
 430 installers.
 431 .It Dv MACHINE_ARCH
 432 Represents the CPU processor architecture.
 433 This is the same as the native platforms
 434 .Xr uname 1
 435 .Fl p
 436 output.
 437 It defines the CPU instruction family supported.
 438 It may also encode a variation in the byte ordering of multi-byte
 439 integers (endian).
 440 It may also encode a variation in the size of the integer or pointer.
 441 It may also encode a ISA revision.
 442 It may also encode hard versus soft floating point ABI and usage.
 443 It may also encode a variant ABI when the other factors do not
 444 uniquely define the ABI (e.g., MIPS' n32 ABI).
 445 It, along with
 446 .Dv MACHINE ,
 447 defines the ABI used by the system.
 448 For example, the MIPS CPU processor family supports 9 different
 449 combinations encoding pointer size, endian and hard versus soft float (for
 450 8 combinations) as well as N32 (which only ever had one variation of
 451 all these).
 452 Generally, the plain CPU name specifies the most common (or at least
 453 first) variant of the CPU.
 454 This is why mips and mips64 imply 'big endian' while 'arm' and 'armv7'
 455 imply little endian.
 456 If we ever were to support the so-called x32 ABI (using 32-bit
 457 pointers on the amd64 architecture), it would most likely be encoded
 458 as amd64-x32.
 459 It is unfortunate that amd64 specifies the 64-bit evolution of the x86
 460 platform (it matches the 'first rule') as everybody else uses x86_64.
 461 There is no standard name for the processor: each OS selects its own
 462 conventions.
 463 .It Dv MACHINE_CPUARCH
 464 Represents the source location for a given
 465 .Dv MACHINE_ARCH .
 466 For example,
 467 .Dv MACHINE_CPUARCH
 468 is defined to be mips for all the flavors of mips that we support
 469 since we support them all with a shared set of sources.
 470 While amd64 and i386 are closely related, MACHINE_CPUARCH is not x86
 471 for them.
 472 The FreeBSD source base supports amd64 and i386 with two
 473 distinct source bases living in subdirectories named amd64 and i386
 474 (though behind the scenes there's some sharing that fits into this
 475 framework).
 476 .It Dv CPUTYPE
 477 Sets the flavor of
 478 .Dv MACHINE_ARCH
 479 to build.
 480 It is used to optimize the build for a specific CPU / core that the
 481 binaries run on.
 482 Generally, this does not change the ABI, though it can be a fine line
 483 between optimization for specific cases.
 484 .It Dv TARGET
 485 Used to set
 486 .Dv MACHINE
 487 in the top level Makefile for cross building.
 488 Unused outside of that scope.
 489 It is not passed down to the rest of the build.
 490 Makefiles outside of the top level should not use it at all (though
 491 some have their own private copy for hysterical raisons).
 492 .It Dv TARGET_ARCH
 493 Used to set
 494 .Dv MACHINE_ARCH
 495 by the top level Makefile for cross building.
 496 Like
 497 .Dv TARGET ,
 498 it is unused outside of that scope.
 499 .El
 500 .Sh SEE ALSO
 501 .Xr src.conf 5 ,
 502 .Xr build 7
 503 .Sh HISTORY
 504 An
 505 .Nm
 506 manual page appeared in
 507 .Fx 11.1 .