Upload Tizen:Base source
[external/gmp.git] / doc / isa_abi_headache
1 Copyright 2000 Free Software Foundation, Inc.
2
3 This file is part of the GNU MP Library.
4
5 The GNU MP Library is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or (at your
8 option) any later version.
9
10 The GNU MP Library is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
13 License for more details.
14
15 You should have received a copy of the GNU Lesser General Public License
16 along with the GNU MP Library.  If not, see http://www.gnu.org/licenses/.
17
18
19
20
21 Terms Used In This Document:
22   ISA = Instruction Set Architecture.   The instructions the current
23         processor provides.
24   ABI = Application Binary Interface.  Specifies calling convention,
25         type sizes, etc.
26   AR64 = Arithmetic operations are 64-bit using 64-bit instructions
27          (E.g., addition, subtraction, load, store, of 64-bit integer types
28          are done with single instructions, not 32 bits at a time.)
29   Environment = The operating system and compiler.
30
31 GMP is a very complex package to build since its speed is very
32 sensitive to the ISA and ABI.  For example, if the ISA provides 64-bit
33 instructions, it is crucial that GMP is configured to use them.
34
35 Most environments that run on a 64-bit ISA provide more than one ABI.
36 Typically one of the supported ABI's is a backward compatible 32-bit
37 ABI, and one ABI provides 64-bit addressing and `long' (sometimes
38 known as LP64).  But a few environments (IRIX, HP-UX) provide
39 intermediate ABI's using 32-bit addressing but allow efficient 64-bit
40 operations through a `long long' type.  For the latter to be useful to
41 GMP, the ABI must allow operations using the native 64-bit
42 instructions provided by the ISA, and allow passing of 64-bit
43 quantities atomically.
44
45 The ABI is typically chosen by means of command line options to the
46 compiler tools (gcc, cc, c89, nm, ar, ld, as).  Different environments
47 use different defaults, but as of this writing (May 2000) the
48 dominating default is to the plain 32-bit ABI in its most arcane form.
49
50 The GMP 3.0.x approach was to compile using the ABI that gives the
51 best performance.  That places the burden on users to pass special
52 options to the compiler when they compile their GMP applications.
53 That approach has its advantages and disadvantages.  The main
54 advantage is that users don't unknowingly get bad GMP performance.
55 The main disadvantage is that users' compiles (actually links) will
56 fail unless they pass special compiler options.
57
58 ** SPARC
59
60 System vendors often confuse ABI, ISA, and implementation.  The worst
61 case is Solaris, were the unbundled compiler confuses ISA and ABI, and
62 the options have very confusing names.
63
64      option             interpretation
65      ======             ==============
66 cc   -xarch=v8plus      ISA=sparcv9, ABI=V8plus (PTR=32, see below)
67 gcc  -mv8plus           ISA=sparcv9, ABI=V8plus (see below)
68 cc   -xarch=v9          ISA=sparcv9, ABI=V9 (implying AR=64, PTR=64)
69
70 It's hard to believe, but the option v8plus really means ISA=V9!
71
72 Solaris releases prior to version 7 running on a V9 CPU fails to
73 save/restore the upper 32 bits of the `i' and `l' registers.  The
74 `v8plus' option generates code that use as many V9 features as
75 possible under such circumstances.
76
77 ** MIPS
78
79 The IRIX 6 compilers gets things right.  They have a clear
80 understanding of the differences between ABI and ISA.  The option
81 names are descriptive.
82
83      option             interpretation
84      ======             ==============
85 cc   -n32               ABI=n32 (implying AR=64, PTR=32)
86 gcc  -mabi=n32          ABI=n32 (implying AR=64, PTR=32)
87 cc   -64                ABI=64 (implying AR=64, PTR=64)
88 gcc  -mabi=64           ABI=64 (implying AR=64, PTR=64)
89 cc   -mips3             ISA=mips3
90 gcc  -mips3             ISA=mips3
91 cc   -mips4             ISA=mips4
92 gcc  -mips4             ISA=mips4
93
94 ** HP-PA
95
96 HP-UX is somewhat weird, but not as broken as Solaris.
97
98      option             interpretation
99      ======             ==============
100 cc   +DA2.0             ABI=32bit (implying AR=64, PTR=32)
101 cc   +DD64              ABI=64bit (implying AR=64, PTR=64)
102
103 Code performing 64-bit arithmetic in the HP-UX 32-bit is not
104 compatible with the 64-bit ABI; the former has a calling convention
105 that passes/returns 64-bit integer quantities as two 32-bit chunks.
106
107 ** PowerPC
108
109 While the PowerPC ABI's are capable of supporting 64-bit
110 registers/operations, the compilers under AIX are similar to Solaris'
111 cc in that they don't currently provide any 32-bit addressing with
112 64-bit arithmetic.
113
114      option                     interpretation
115      ======                     ==============
116 cc   -q64                       ABI=64bit (implying AR=64, PTR=64)
117 gcc  -maix64 -mpowerpc64        ABI=64bit (implying AR=64, PTR=64)