Skip to main content

rucc_pp/
predef.rs

1//! The predefined macro set, generated from the target description.
2//!
3//! Design: `spec/04-driver-and-cli.md` section 4.5.
4//!
5//! The set is built as text and then read by the directive engine, which is what GCC does and
6//! is not laziness. Constructing a few hundred `MacroDef` values by hand would need its own
7//! parser for macro bodies, would not exercise the one that already exists, and could not be
8//! read by a person checking a limit against the psABI. A file of `#define` lines can be
9//! printed by `-dM`, diffed against GCC's output, and understood at a glance.
10//!
11//! Two synthetic files come out of this, and they are the two GCC names in a diagnostic:
12//! `<built-in>` for the generated set and `<command-line>` for `-D` and `-U`. Keeping them
13//! apart is what lets "`FOO` redefined" point at the command line rather than at a line
14//! nobody wrote.
15//!
16//! The decision that everything else follows from is in section 4.5: we define `__GNUC__`,
17//! which means glibc's headers, the kernel's headers and every autoconf probe take the GNU
18//! path. The version claimed is deliberately conservative and is a knob, because claiming too
19//! high a version means headers use extensions we do not have, and the matrix in `rucc-gnu`
20//! is the list of promises the claim makes.
21
22use rucc_base::float::Format;
23use rucc_session::{GnucVersion, OptLevel, Options, Pic, Std};
24use rucc_target::{Arch, Env, Os, TargetInfo, Triple};
25use rucc_tuple::{self as tuple};
26
27/// The name a diagnostic about the generated set points at.
28pub const BUILT_IN: &str = "<built-in>";
29
30/// The name a diagnostic about `-D` or `-U` points at.
31pub const COMMAND_LINE: &str = "<command-line>";
32
33/// The translation date, as `__DATE__` and `__TIME__` spell it.
34///
35/// Fixed for the whole translation unit, which is what the standard requires and what makes
36/// the two macros ordinary object-like macros rather than something the expander has to know
37/// about.
38#[derive(Debug, Clone, PartialEq, Eq)]
39pub struct Timestamp {
40    /// `Mmm dd yyyy`, with the day space padded, which is the format the standard fixes.
41    pub date: String,
42    /// `hh:mm:ss`.
43    pub time: String,
44}
45
46impl Timestamp {
47    /// The current time, or `SOURCE_DATE_EPOCH` when the build asked for a reproducible one.
48    ///
49    /// Reading the environment here rather than in the driver is what GCC does, and it keeps
50    /// the variable working for an embedder who never goes through a command line.
51    pub fn now() -> Timestamp {
52        let seconds = match std::env::var("SOURCE_DATE_EPOCH").ok().and_then(|v| v.parse().ok()) {
53            Some(fixed) => fixed,
54            None => std::time::SystemTime::now()
55                .duration_since(std::time::UNIX_EPOCH)
56                .map_or(0, |d| d.as_secs() as i64),
57        };
58        Timestamp::from_unix(seconds)
59    }
60
61    /// The time `seconds` after the epoch, in UTC.
62    ///
63    /// UTC rather than local time, because a compiler whose output depends on the machine's
64    /// time zone is a compiler whose output is not reproducible.
65    pub fn from_unix(seconds: i64) -> Timestamp {
66        let days = seconds.div_euclid(86_400);
67        let rest = seconds.rem_euclid(86_400);
68        let (year, month, day) = civil_from_days(days);
69        const MONTHS: [&str; 12] =
70            ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
71        let name = MONTHS[(month - 1) as usize];
72        Timestamp {
73            date: format!("{name} {day:2} {year}"),
74            time: format!("{:02}:{:02}:{:02}", rest / 3600, (rest / 60) % 60, rest % 60),
75        }
76    }
77}
78
79/// The year, month and day `days` after 1970-01-01.
80///
81/// Howard Hinnant's civil calendar algorithm, which is a handful of divisions and no table.
82/// It is here rather than in a dependency because the whole workspace has no dependencies,
83/// and a date conversion is not a good reason to acquire the first one.
84fn civil_from_days(days: i64) -> (i64, u32, u32) {
85    // Shift the epoch to 0000-03-01, so that a leap day is the last day of the year and the
86    // month lengths become a repeating pattern that one division can invert.
87    let shifted = days + 719_468;
88    let era = shifted.div_euclid(146_097);
89    let day_of_era = shifted.rem_euclid(146_097);
90    let year_of_era =
91        (day_of_era - day_of_era / 1460 + day_of_era / 36_524 - day_of_era / 146_096) / 365;
92    let year = year_of_era + era * 400;
93    let day_of_year = day_of_era - (365 * year_of_era + year_of_era / 4 - year_of_era / 100);
94    let marched = (5 * day_of_year + 2) / 153;
95    let day = (day_of_year - (153 * marched + 2) / 5 + 1) as u32;
96    let month = if marched < 10 { marched + 3 } else { marched - 9 } as u32;
97    (year + i64::from(month <= 2), month, day)
98}
99
100/// Everything the predefined set is built from that is not the target.
101#[derive(Debug, Clone, PartialEq, Eq)]
102pub struct Predef {
103    /// The dialect, which decides `__STDC_VERSION__`.
104    pub std: Std,
105    /// Whether the GNU extensions are on, which is `-std=gnu23` rather than `-std=c23`. It
106    /// decides `__STRICT_ANSI__` and the unarmoured `linux` and `unix` macros.
107    pub gnu_extensions: bool,
108    /// Whether the unit is under GNU's reading of `inline`, which is `-fgnu89-inline`. It decides
109    /// which of `__GNUC_GNU_INLINE__` and `__GNUC_STDC_INLINE__` is defined, and the C89 dialects
110    /// are under that reading whatever it says.
111    pub gnu89_inline: bool,
112    /// The GCC release claimed.
113    pub gnuc: GnucVersion,
114    /// Decides `__OPTIMIZE__`, `__OPTIMIZE_SIZE__` and `__NO_INLINE__`.
115    pub opt_level: OptLevel,
116    /// Whether there is a standard library, which is `-ffreestanding` turned around.
117    pub hosted: bool,
118    /// Which link the output is for, from `-fPIC` and `-fPIE`. It decides `__PIE__`, since
119    /// `__PIC__` is defined either way and says only that there are no absolute addresses.
120    pub pic: Pic,
121    /// `__DATE__` and `__TIME__`.
122    pub timestamp: Timestamp,
123    /// The glibc release the headers are, as the minor number alone, when they are ours.
124    ///
125    /// `__GLIBC_MINOR__` and nothing else: `__GLIBC__` is 2 in the tree itself, which is how Zig's
126    /// own patched `features.h` has it, and a version the compiler supplied and a version the
127    /// header supplied would be two answers to one question.
128    pub glibc_minor: Option<u32>,
129    /// `-D` in command line order. `FOO` means `FOO=1`, as GCC has it.
130    pub defines: Vec<String>,
131    /// `-U` in command line order, applied after the defines.
132    pub undefines: Vec<String>,
133}
134
135impl Predef {
136    /// The default dialect, `gnu23`, at `-O0`.
137    pub fn new() -> Predef {
138        Predef {
139            std: Std::default(),
140            gnu_extensions: true,
141            gnu89_inline: false,
142            gnuc: GnucVersion::default(),
143            opt_level: OptLevel::O0,
144            hosted: true,
145            pic: Pic::Executable,
146            timestamp: Timestamp::now(),
147            glibc_minor: None,
148            defines: Vec::new(),
149            undefines: Vec::new(),
150        }
151    }
152}
153
154impl Predef {
155    /// The set the command line asked for.
156    ///
157    /// The mapping lives here rather than in the driver because it is the definition of what
158    /// each flag means to the macro set, and the driver's job is to parse a command line, not
159    /// to know that `-ffreestanding` is `__STDC_HOSTED__` being zero.
160    pub fn for_options(opts: &Options) -> Predef {
161        Predef {
162            std: opts.std,
163            gnu_extensions: opts.gnu_extensions,
164            gnu89_inline: opts.gnu89_inline,
165            gnuc: opts.gnuc,
166            opt_level: opts.opt_level,
167            hosted: opts.hosted,
168            pic: opts.pic,
169            timestamp: Timestamp::now(),
170            glibc_minor: opts.glibc_minor,
171            defines: opts.defines.clone(),
172            undefines: opts.undefines.clone(),
173        }
174    }
175}
176
177impl Default for Predef {
178    fn default() -> Predef {
179        Predef::new()
180    }
181}
182
183/// A file of `#define` lines being built up.
184struct Defs {
185    text: String,
186}
187
188impl Defs {
189    fn new() -> Defs {
190        Defs { text: String::new() }
191    }
192
193    /// `#define name value`.
194    fn set(&mut self, name: &str, value: &str) {
195        self.text.push_str("#define ");
196        self.text.push_str(name);
197        self.text.push(' ');
198        self.text.push_str(value);
199        self.text.push('\n');
200    }
201
202    /// `#define name 1`, which is what a macro that is only ever tested for needs.
203    fn flag(&mut self, name: &str) {
204        self.set(name, "1");
205    }
206
207    fn set_if(&mut self, when: bool, name: &str, value: &str) {
208        if when {
209            self.set(name, value);
210        }
211    }
212
213    fn flag_if(&mut self, when: bool, name: &str) {
214        if when {
215            self.flag(name);
216        }
217    }
218}
219
220/// The whole predefined set for a target, as the text of a file.
221pub(crate) fn built_in(target: &TargetInfo, opts: &Predef) -> String {
222    let mut d = Defs::new();
223    identity(&mut d, target, opts);
224    // `__DATE__` and `__TIME__` are fixed for the whole translation unit, which is what the
225    // standard asks for, so they are ordinary object-like macros and the expander needs to
226    // know nothing about them.
227    d.set("__DATE__", &format!("\"{}\"", opts.timestamp.date));
228    d.set("__TIME__", &format!("\"{}\"", opts.timestamp.time));
229    dialect(&mut d, opts);
230    optimization(&mut d, opts);
231    platform(&mut d, target, opts);
232    sizes(&mut d, target);
233    integers(&mut d, target);
234    floats(&mut d, target);
235    atomics(&mut d, target);
236    d.text
237}
238
239/// `-D` and `-U`, as the text of a file.
240///
241/// Empty when there are none, so that the caller can skip adding a file that would say
242/// nothing. The undefines come last whatever order they were written in, because `-U` beats
243/// `-D` in GCC no matter which side of it the `-D` was on.
244pub(crate) fn command_line(opts: &Predef) -> String {
245    let mut d = Defs::new();
246    for define in &opts.defines {
247        match define.split_once('=') {
248            Some((name, value)) => d.set(name, value),
249            // `-DFOO` is `-DFOO=1`. A macro nobody gave a value to is one that is only ever
250            // tested for, and giving it an empty body would break `#if FOO`.
251            None => d.flag(define),
252        }
253    }
254    for name in &opts.undefines {
255        d.text.push_str("#undef ");
256        d.text.push_str(name);
257        d.text.push('\n');
258    }
259    d.text
260}
261
262/// Who the compiler says it is.
263fn identity(d: &mut Defs, target: &TargetInfo, opts: &Predef) {
264    d.flag("__rucc__");
265    d.set("__rucc_version__", "\"0.1.0\"");
266    d.set("__rucc_major__", "0");
267    d.set("__rucc_minor__", "1");
268    d.set("__rucc_patchlevel__", "0");
269    // The promise from section 4.5. Everything in the matrix hangs off this line.
270    d.set("__GNUC__", &opts.gnuc.major.to_string());
271    d.set("__GNUC_MINOR__", &opts.gnuc.minor.to_string());
272    d.set("__GNUC_PATCHLEVEL__", &opts.gnuc.patch.to_string());
273    d.set("__VERSION__", "\"rucc 0.1.0\"");
274    // Not `__clang__`, deliberately. Section 4.5 says so, and a header that takes the Clang
275    // path expects Clang's extension surface rather than GCC's.
276    //
277    // Which of the two readings of `inline` is in force, which a header reads to decide how to
278    // write its own inline definitions: glibc's `__extern_inline` is `extern __inline` under the
279    // one and adds `__attribute__ ((__gnu_inline__))` under the other. C99 changed the meaning of
280    // the keyword and gcc follows the dialect, so the C89 ones keep GNU's reading and every
281    // dialect after them takes C's until `-fgnu89-inline` says otherwise.
282    let gnu_inline = opts.gnu89_inline || opts.std == Std::C89;
283    d.flag_if(gnu_inline, "__GNUC_GNU_INLINE__");
284    d.flag_if(!gnu_inline, "__GNUC_STDC_INLINE__");
285    // The charsets a literal is converted to. Both are fixed here rather than settable, since
286    // there is no `-fexec-charset` to set them with, and both are what gcc answers with none.
287    // The wide one follows `wchar_t`, which is sixteen bits on Windows and thirty two
288    // everywhere else, so it is the one target fact in this function.
289    d.set("__GNUC_EXECUTION_CHARSET_NAME", "\"UTF-8\"");
290    let wide = if target.wchar_width == 16 { "\"UTF-16LE\"" } else { "\"UTF-32LE\"" };
291    d.set("__GNUC_WIDE_EXECUTION_CHARSET_NAME", wide);
292    // The C++ ABI this would be if it compiled C++, which gcc defines in C as well. It is not
293    // a claim about this compiler so much as a number headers read: libstdc++ is not the only
294    // thing that tests it, and a C header shared with a C++ one reaches it through `extern
295    // "C"` guards. The value is gcc 16's.
296    d.set("__GXX_ABI_VERSION", "1021");
297}
298
299/// What the dialect flags say.
300fn dialect(d: &mut Defs, opts: &Predef) {
301    d.flag("__STDC__");
302    d.set_if(opts.hosted, "__STDC_HOSTED__", "1");
303    d.set_if(!opts.hosted, "__STDC_HOSTED__", "0");
304    if let Some(version) = opts.std.stdc_version() {
305        d.set("__STDC_VERSION__", version);
306    }
307    // Defined exactly when the extensions are off, which is the whole difference between
308    // `-std=c23` and `-std=gnu23` as far as the preprocessor is concerned.
309    d.flag_if(!opts.gnu_extensions, "__STRICT_ANSI__");
310    d.flag("__STDC_UTF_16__");
311    d.flag("__STDC_UTF_32__");
312    d.flag("__STDC_IEC_559__");
313    d.flag("__STDC_IEC_559_COMPLEX__");
314    d.set_if(opts.std == Std::C23, "__STDC_IEC_60559_BFP__", "202311L");
315    d.set("__STDC_ISO_10646__", "201706L");
316    // The type behind `char8_t`, which C23 added and no dialect before it has. It sits here
317    // rather than next to `__CHAR16_TYPE__` and `__CHAR32_TYPE__` because those two are the
318    // same in every dialect and this one is not, which is the whole reason a header can test
319    // for it: gcc's own `stdatomic.h` writes `atomic_char8_t` under `#ifdef __CHAR8_TYPE__`
320    // and gets it in C23 and not in C17.
321    d.set_if(opts.std == Std::C23, "__CHAR8_TYPE__", "unsigned char");
322    // C11 made these conditional features, and a header that sees `__STDC_VERSION__` at
323    // 201112 with no `__STDC_NO_ATOMICS__` next to it will use `_Atomic`. Each one here is a
324    // claim not to have something, so each one is only correct while it stays true: atomics
325    // because there is no `stdatomic.h` to include, threads because there is no `threads.h`,
326    // and complex because the arithmetic is not lowered.
327    //
328    // Variable length arrays are not on this list, because they work. Claiming otherwise is
329    // not a harmless overstatement of caution: glibc's `regex.h` writes the bound of
330    // `regexec`'s match array as `_REGEX_NELTS (__nmatch)`, which is the parameter when the
331    // dialect has them and nothing at all when a compiler says it does not, so the claim
332    // silently changes a declaration in a header rather than turning something off.
333    if opts.std.has_c11() {
334        d.flag("__STDC_NO_ATOMICS__");
335        d.flag("__STDC_NO_THREADS__");
336        d.flag("__STDC_NO_COMPLEX__");
337    }
338    // What `__has_embed` answers with. They are defined in every dialect and not only in C23,
339    // because the operator is answerable in every dialect and a header that writes
340    // `#if __has_embed(...) == __STDC_EMBED_FOUND__` under `-std=gnu17` would otherwise be
341    // comparing against zero and taking the not found branch on a resource that is there.
342    d.set("__STDC_EMBED_NOT_FOUND__", "0");
343    d.set("__STDC_EMBED_FOUND__", "1");
344    d.set("__STDC_EMBED_EMPTY__", "2");
345}
346
347/// The memory orders and the lock free answers.
348///
349/// These are here whether or not `_Atomic` is, and `__STDC_NO_ATOMICS__` does not turn them
350/// off, because they are the numbering the `__atomic` builtins take rather than a promise
351/// about the language. musl's `stdatomic.h` writes `memory_order_relaxed = __ATOMIC_RELAXED`
352/// with no test around it at all, so a compiler without them prints an enumerator whose value
353/// is an identifier.
354///
355/// Two means always lock free, and every integer type gets a two on all three targets, which
356/// are all sixty four bit machines. `long long` is the one that would change on a thirty two
357/// bit target, where a double word load is an instruction the machine may or may not have.
358fn atomics(d: &mut Defs, target: &TargetInfo) {
359    d.set("__ATOMIC_RELAXED", "0");
360    d.set("__ATOMIC_CONSUME", "1");
361    d.set("__ATOMIC_ACQUIRE", "2");
362    d.set("__ATOMIC_RELEASE", "3");
363    d.set("__ATOMIC_ACQ_REL", "4");
364    d.set("__ATOMIC_SEQ_CST", "5");
365    // The gate is the machine word rather than `long`, because Windows has a thirty two bit
366    // `long` on a sixty four bit machine and its `long long` is still one instruction.
367    let llong = if target.pointer_width == 64 { "2" } else { "1" };
368    for name in [
369        "BOOL", "CHAR", "CHAR8_T", "CHAR16_T", "CHAR32_T", "WCHAR_T", "SHORT", "INT", "LONG",
370        "POINTER",
371    ] {
372        d.set(&format!("__GCC_ATOMIC_{name}_LOCK_FREE"), "2");
373    }
374    // The one that is not always two: a target whose word is thirty two bits wide can only
375    // promise `long long` is lock free if it has a double word instruction, and the honest
376    // answer there is sometimes rather than always.
377    d.set("__GCC_ATOMIC_LLONG_LOCK_FREE", llong);
378    d.set("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
379    // What `__sync_bool_compare_and_swap` works on, one macro per width in bytes. Every target
380    // here has the instruction at all four, and glibc reads these rather than the `__atomic_*`
381    // set because they are the older question and the answer is the same one.
382    for width in [1, 2, 4, 8] {
383        d.flag(&format!("__GCC_HAVE_SYNC_COMPARE_AND_SWAP_{width}"));
384    }
385    // The two flag bits an x86 memory order can carry, for the hardware lock elision prefixes.
386    // They are numbers a program passes back to a builtin rather than a claim that the prefix
387    // is emitted, and a program that computes one on a machine where the macro is missing gets
388    // a preprocessor error rather than a slower atomic.
389    if target.tuple.arch() == tuple::Arch::X86_64 {
390        d.set("__ATOMIC_HLE_ACQUIRE", "65536");
391        d.set("__ATOMIC_HLE_RELEASE", "131072");
392    }
393}
394
395/// What the optimizer level says.
396fn optimization(d: &mut Defs, opts: &Predef) {
397    d.flag_if(opts.opt_level.runs_optimizer(), "__OPTIMIZE__");
398    d.flag_if(opts.opt_level.is_size(), "__OPTIMIZE_SIZE__");
399    // glibc's headers test this before deciding whether to define a function as an inline
400    // wrapper, so getting it wrong changes what a program links against.
401    d.flag_if(!opts.opt_level.runs_optimizer(), "__NO_INLINE__");
402    // Zero, and zero until there is a `-ffast-math` to make it one. glibc's `math.h` reads it
403    // to decide whether to declare the `__*_finite` aliases, so it has to be defined rather
404    // than merely not claimed: a header testing `#if __FINITE_MATH_ONLY__ > 0` on a compiler
405    // that leaves it undefined takes the same branch, but one writing `#if
406    // !__FINITE_MATH_ONLY__` is a different question and gcc gives it an answer.
407    d.set("__FINITE_MATH_ONLY__", "0");
408}
409
410/// The architecture, the operating system and the object format.
411fn platform(d: &mut Defs, target: &TargetInfo, opts: &Predef) {
412    // The macros a target with no backend predefines are not written down here. They are a
413    // header's whole view of the machine, a wrong one is a header taking a branch written for
414    // another processor, and there is nothing cheap that would catch it. The driver takes a three
415    // field triple, so a target this cannot spell is one nobody can ask for yet rather than a
416    // hole in what it answers.
417    let Some(triple) = Triple::from_tuple(target.tuple) else {
418        return;
419    };
420    match triple.arch {
421        Arch::X86_64 => {
422            d.flag("__x86_64__");
423            d.flag("__x86_64");
424            d.flag("__amd64__");
425            d.flag("__amd64");
426            d.flag("__SSE__");
427            d.flag("__SSE2__");
428            d.flag("__MMX__");
429            d.flag("__SSE_MATH__");
430            d.flag("__SSE2_MATH__");
431            d.flag("__k8");
432            d.flag("__k8__");
433            // FXSAVE and FXRSTOR, which every x86-64 has, and the small code model, which is
434            // the default and the only one a program gets without being told otherwise.
435            d.flag("__FXSR__");
436            d.flag("__code_model_small__");
437            // The MMX registers are not used on x86-64: the sixty four bit operations go
438            // through SSE instead. gcc's own `xmmintrin.h` reads this to decide how to write
439            // `_mm_maskmove_si64`, so a compiler that leaves it undefined is handed a
440            // different function body than gcc is, which is what the header sweep found.
441            d.flag("__MMX_WITH_SSE__");
442        }
443        Arch::Aarch64 => {
444            d.flag("__aarch64__");
445            d.flag("__AARCH64EL__");
446            d.set("__ARM_ARCH", "8");
447            d.set("__ARM_ARCH_PROFILE", "'A'");
448            d.set("__ARM_64BIT_STATE", "1");
449            d.set("__ARM_ALIGN_MAX_PWR", "28");
450            d.set("__ARM_FP", "0xe");
451            d.set("__ARM_NEON", "1");
452            d.set("__ARM_FEATURE_UNALIGNED", "1");
453            d.set("__ARM_PCS_AAPCS64", "1");
454        }
455        Arch::Riscv64 => {
456            d.flag("__riscv");
457            d.set("__riscv_xlen", "64");
458            d.set("__riscv_flen", "64");
459            d.flag("__riscv_float_abi_double");
460            d.flag("__riscv_muldiv");
461            d.flag("__riscv_atomic");
462            d.flag("__riscv_compressed");
463            d.set("__riscv_cmodel_medlow", "1");
464        }
465    }
466    match triple.os {
467        Os::Linux => {
468            d.flag("__linux__");
469            d.flag("__linux");
470            d.flag("__unix__");
471            d.flag("__unix");
472            d.flag("__gnu_linux__");
473            d.flag("__ELF__");
474            // The unarmoured spellings are not reserved identifiers, so a strict mode may not
475            // define them. Autoconf still tests for `linux`, which is why they exist at all.
476            if opts.gnu_extensions {
477                d.flag("linux");
478                d.flag("unix");
479            }
480        }
481        Os::Darwin => {
482            d.flag("__APPLE__");
483            d.flag("__MACH__");
484            d.flag("__unix__");
485            d.flag("__unix");
486            d.set("__APPLE_CC__", "6000");
487            d.set("__DYNAMIC__", "1");
488            if triple.arch == Arch::Aarch64 {
489                // Apple's own spelling of the architecture, which its headers use rather than
490                // __aarch64__. sys/cdefs.h tests for it by name and reaches an #error called
491                // "Unsupported architecture" without it, so every system header on this
492                // platform fails on the first include until these two are here.
493                d.flag("__arm64__");
494                d.flag("__arm64");
495            }
496            if opts.gnu_extensions {
497                d.flag("unix");
498            }
499        }
500        Os::Windows => {
501            d.flag("_WIN32");
502            d.flag("__WIN32__");
503            d.flag("_WIN64");
504            d.flag("__WIN64__");
505            d.flag("__MINGW32__");
506        }
507        Os::None => {
508            // Freestanding. `__ELF__` still holds, because the object format is a property of
509            // the target rather than of having an operating system under it.
510            d.flag("__ELF__");
511        }
512    }
513    match triple.env {
514        Env::Musl => d.flag("__musl__"),
515        Env::Gnu | Env::None | Env::Msvc => {}
516    }
517    // The version of the libc's headers, and only when they are the tree we bundle. One tree serves
518    // every glibc release with the differences written as `#if __GLIBC_MINOR__ >= n` inside the
519    // files, so the release is the part of it the target supplies and the compiler is what supplies
520    // it. Zig patches the same macro into the same tree the same way, which is where the spelling
521    // comes from rather than from a scheme of ours: `__GLIBC_PREREQ` reads it and so does every
522    // autoconf probe ever written.
523    //
524    // The condition is the whole of it and it is not here. A host glibc defines this macro in its
525    // own `features.h` and so does a tree the user named, and a second definition with a different
526    // value is a warning on every compilation, so the driver decides and this writes down what it
527    // decided.
528    if let Some(minor) = opts.glibc_minor {
529        d.set("__GLIBC_MINOR__", &minor.to_string());
530    }
531    // LP64 is the model everywhere except Windows, and a great deal of code tests for it
532    // rather than testing pointer and long widths separately.
533    if target.long_width == 64 && target.pointer_width == 64 {
534        d.flag("__LP64__");
535        d.flag("_LP64");
536    }
537    // What the assembler prepends to a C name to get the symbol. Mach-O keeps the leading
538    // underscore that every a.out toolchain had and ELF dropped it. It has to be defined even
539    // where it is empty, because of how it is used: glibc writes `__asm__ (__ASMNAME (name))`
540    // and that stringifies `__USER_LABEL_PREFIX__`, so a compiler that leaves it undefined
541    // does not get an error, it gets the name of the macro as the string and renames the
542    // function.
543    d.set("__USER_LABEL_PREFIX__", if triple.os == Os::Darwin { "_" } else { "" });
544    // Its counterpart, what the assembler puts in front of a register name. Empty on every
545    // target here, since all three assemble in a syntax that does not mark registers, and
546    // defined anyway for the same reason as the line above: it is used inside a stringize.
547    d.set("__REGISTER_PREFIX__", "");
548
549    // Position independent code is the default on the ELF targets and on Apple's, which is
550    // what a distribution build expects. The value 2 is GCC's for `-fPIC` rather than `-fpic`.
551    //
552    // Both are defined whichever link the output is for, because `__PIC__` says there are no
553    // absolute addresses in the text and that is true either way. What says which link it is is
554    // `__PIE__`, and a program reads it to find out whether a name it exports is one something
555    // else may replace. gcc defines it under `-fPIE` and under the default on a distribution
556    // where the default is an executable, which is the default here too.
557    if !matches!(triple.os, Os::Windows) {
558        d.set("__PIC__", "2");
559        d.set("__pic__", "2");
560        if opts.pic == Pic::Executable {
561            d.set("__PIE__", "2");
562            d.set("__pie__", "2");
563        }
564    }
565}
566
567/// `__CHAR_BIT__`, the `__SIZEOF_*__` family and the alignment macros.
568fn sizes(d: &mut Defs, target: &TargetInfo) {
569    let pointer = target.pointer_width / 8;
570    // The two hardware interference sizes, which say how far apart two objects have to be for
571    // a write to one not to invalidate the other's cache line, and how close together two have
572    // to be to share one. A cache line is sixty four bytes on every target here, so the two
573    // answers are the same number and gcc gives the same number as well.
574    d.set("__GCC_CONSTRUCTIVE_SIZE", "64");
575    d.set("__GCC_DESTRUCTIVE_SIZE", "64");
576    let long = target.long_width / 8;
577    let long_double = target.long_double_width / 8;
578    d.set("__CHAR_BIT__", "8");
579    d.set("__SIZEOF_SHORT__", "2");
580    d.set("__SIZEOF_INT__", "4");
581    d.set("__SIZEOF_LONG__", &long.to_string());
582    d.set("__SIZEOF_LONG_LONG__", "8");
583    d.set("__SIZEOF_INT128__", "16");
584    d.set("__SIZEOF_FLOAT__", "4");
585    d.set("__SIZEOF_DOUBLE__", "8");
586    d.set("__SIZEOF_LONG_DOUBLE__", &long_double.to_string());
587    d.set("__SIZEOF_POINTER__", &pointer.to_string());
588    d.set("__SIZEOF_SIZE_T__", &pointer.to_string());
589    d.set("__SIZEOF_PTRDIFF_T__", &pointer.to_string());
590    d.set("__SIZEOF_WCHAR_T__", &wchar(target).size.to_string());
591    d.set("__SIZEOF_WINT_T__", "4");
592    d.set("__BIGGEST_ALIGNMENT__", "16");
593    // The `__BYTE_ORDER__` family, which the kernel and every serialisation library read.
594    // The names of the orders are defined whichever one is in force, because code compares
595    // against both.
596    d.set("__ORDER_LITTLE_ENDIAN__", "1234");
597    d.set("__ORDER_BIG_ENDIAN__", "4321");
598    d.set("__ORDER_PDP_ENDIAN__", "3412");
599    let order =
600        if target.little_endian { "__ORDER_LITTLE_ENDIAN__" } else { "__ORDER_BIG_ENDIAN__" };
601    d.set("__BYTE_ORDER__", order);
602    d.set("__FLOAT_WORD_ORDER__", order);
603    d.flag_if(!target.char_is_signed, "__CHAR_UNSIGNED__");
604}
605
606/// How `wchar_t` is spelled on a target, and what it holds.
607struct Wchar {
608    /// The C type it is a name for.
609    spelling: &'static str,
610    /// Its width in bytes.
611    size: u32,
612    /// `__WCHAR_MAX__`.
613    max: &'static str,
614    /// `__WCHAR_MIN__`.
615    min: &'static str,
616}
617
618/// `wchar_t` is the type that divides the targets most and is written down least.
619///
620/// Windows makes it 16 bits so that a wide string is UTF-16. AArch64 Linux makes it unsigned,
621/// following the psABI's rule for plain `char`, while x86-64 Linux makes it signed. Code that
622/// compares a `wchar_t` against a negative value is correct on one and not on the other.
623///
624/// The width and the signedness come from the target description rather than from another match
625/// on the triple, because the lexer needs the same two facts to convert a wide literal and the
626/// two answers have to be the same one.
627fn wchar(target: &TargetInfo) -> Wchar {
628    match (target.wchar_width, target.wchar_is_signed) {
629        (16, false) => Wchar { spelling: "short unsigned int", size: 2, max: "0xffff", min: "0" },
630        (16, true) => Wchar { spelling: "short int", size: 2, max: "0x7fff", min: "(-32767 - 1)" },
631        (_, false) => Wchar { spelling: "unsigned int", size: 4, max: "0xffffffffU", min: "0U" },
632        (_, true) => {
633            Wchar { spelling: "int", size: 4, max: "0x7fffffff", min: "(-__WCHAR_MAX__ - 1)" }
634        }
635    }
636}
637
638/// How `wint_t` is spelled on a target, and what it holds.
639struct Wint {
640    /// The C type it is a name for.
641    spelling: &'static str,
642    /// `__WINT_MAX__`.
643    max: &'static str,
644    /// `__WINT_MIN__`.
645    min: &'static str,
646    /// `__WINT_WIDTH__`, which follows the spelling rather than `__SIZEOF_WINT_T__`.
647    width: u32,
648}
649
650/// `wint_t` does not follow `wchar_t`, and Darwin is where that shows.
651///
652/// Apple makes it a signed `int`, so that `WEOF` is negative the way `EOF` is, while Linux
653/// makes it `unsigned int` and gives `WEOF` the value `0xffffffff`. The SDK's `arm/_types.h`
654/// spells `__darwin_wint_t` as `__WINT_TYPE__` and nothing else, so getting this wrong changes
655/// the signedness of every wide character function's argument on that platform.
656fn wint(target: &TargetInfo) -> Wint {
657    match target.tuple.os() {
658        tuple::Os::Windows => {
659            Wint { spelling: "short unsigned int", max: "0xffff", min: "0", width: 16 }
660        }
661        os if os.is_darwin() => {
662            Wint { spelling: "int", max: "0x7fffffff", min: "(-__WINT_MAX__ - 1)", width: 32 }
663        }
664        _ => Wint { spelling: "unsigned int", max: "0xffffffffU", min: "0U", width: 32 },
665    }
666}
667
668/// The integer type names, their limits, and the exact width family.
669fn integers(d: &mut Defs, target: &TargetInfo) {
670    // The one fact everything below turns on: which type is 64 bits wide. On LP64 it is
671    // `long`, and on Windows LLP64 it is `long long`, and every `size_t`, `intmax_t` and
672    // `int64_t` spelling follows from that.
673    let lp64 = target.long_width == 64;
674    let wide = if lp64 { "long int" } else { "long long int" };
675    let wide_unsigned = if lp64 { "long unsigned int" } else { "long long unsigned int" };
676    let wide_suffix = if lp64 { "L" } else { "LL" };
677    let wide_max = format!("0x7fffffffffffffff{wide_suffix}");
678    let wide_umax = format!("0xffffffffffffffffU{wide_suffix}");
679
680    d.set("__SCHAR_MAX__", "0x7f");
681    d.set("__SHRT_MAX__", "0x7fff");
682    d.set("__INT_MAX__", "0x7fffffff");
683    d.set("__LONG_MAX__", if lp64 { "0x7fffffffffffffffL" } else { "0x7fffffffL" });
684    d.set("__LONG_LONG_MAX__", "0x7fffffffffffffffLL");
685    d.set("__INTMAX_MAX__", &wide_max);
686    d.set("__UINTMAX_MAX__", &wide_umax);
687    d.set("__SIZE_MAX__", &wide_umax);
688    d.set("__PTRDIFF_MAX__", &wide_max);
689    d.set("__INTPTR_MAX__", &wide_max);
690    d.set("__UINTPTR_MAX__", &wide_umax);
691    d.set("__SIG_ATOMIC_MAX__", "0x7fffffff");
692    d.set("__SIG_ATOMIC_MIN__", "(-__SIG_ATOMIC_MAX__ - 1)");
693    // The widest `_BitInt` this compiler builds, which is narrower than gcc 16's sixty five
694    // thousand five hundred and thirty five because a folded constant here is a hundred and
695    // twenty eight bits wide. A program that reads this macro to decide what to write gets an
696    // answer it can rely on, which is the point of saying a number smaller than gcc's rather
697    // than saying gcc's and refusing what it asked for. `MAX_BIT_INT_WIDTH` in `rucc-sema` is
698    // the same number and has to be changed with it.
699    d.set("__BITINT_MAXWIDTH__", "128");
700
701    let wchar = wchar(target);
702    d.set("__WCHAR_TYPE__", wchar.spelling);
703    d.set("__WCHAR_MAX__", wchar.max);
704    d.set("__WCHAR_MIN__", wchar.min);
705    let wint = wint(target);
706    d.set("__WINT_TYPE__", wint.spelling);
707    d.set("__WINT_MAX__", wint.max);
708    d.set("__WINT_MIN__", wint.min);
709    d.set("__SIZE_TYPE__", wide_unsigned);
710    d.set("__PTRDIFF_TYPE__", wide);
711    d.set("__INTMAX_TYPE__", wide);
712    d.set("__UINTMAX_TYPE__", wide_unsigned);
713    d.set("__INTPTR_TYPE__", wide);
714    d.set("__UINTPTR_TYPE__", wide_unsigned);
715    d.set("__SIG_ATOMIC_TYPE__", "int");
716    d.set("__CHAR16_TYPE__", "short unsigned int");
717    d.set("__CHAR32_TYPE__", "unsigned int");
718    d.set("__INTMAX_C(c)", &format!("c ## {wide_suffix}"));
719    d.set("__UINTMAX_C(c)", &format!("c ## U{wide_suffix}"));
720
721    // The exact width family, which is what a freestanding `stdint.h` is written out of.
722    exact(d, 8, "signed char", "unsigned char", "0x7f", "0xff", "");
723    exact(d, 16, "short int", "short unsigned int", "0x7fff", "0xffff", "");
724    // No suffix. An `int` needs none, and the `U` on the unsigned side is added by `exact`
725    // rather than being part of the width.
726    exact(d, 32, "int", "unsigned int", "0x7fffffff", "0xffffffffU", "");
727    exact(d, 64, wide, wide_unsigned, &wide_max, &wide_umax, wide_suffix);
728
729    // The fast types. GCC makes the 16 and 32 bit ones `long` on x86-64 glibc and `int`
730    // everywhere else, and a header that computes a printf format from the type name notices
731    // the difference.
732    //
733    // musl is the reason this is not simply a question of the architecture. musl defines
734    // `int_fast16_t` and `int_fast32_t` as `int32_t` on every target it supports, GCC built
735    // for a musl target agrees with it, and GCC built for glibc on the same processor does
736    // not. The place it shows is `stdatomic.h`, which GCC ships and writes directly out of
737    // these macros: `typedef _Atomic __INT_FAST16_TYPE__ atomic_int_fast16_t;`. Get this wrong
738    // and every atomic fast type in the program is the wrong width.
739    let fast_is_wide = target.tuple.arch() == tuple::Arch::X86_64
740        && lp64
741        && target.tuple.env() != tuple::Env::Musl;
742    let fast_middle = if fast_is_wide { wide } else { "int" };
743    d.set("__INT_FAST8_TYPE__", "signed char");
744    d.set("__UINT_FAST8_TYPE__", "unsigned char");
745    d.set("__INT_FAST8_MAX__", "0x7f");
746    d.set("__UINT_FAST8_MAX__", "0xff");
747    for width in [16, 32] {
748        let unsigned = if fast_middle == "int" { "unsigned int" } else { wide_unsigned };
749        let max = if fast_middle == "int" { "0x7fffffff" } else { wide_max.as_str() };
750        let umax = if fast_middle == "int" { "0xffffffffU" } else { wide_umax.as_str() };
751        d.set(&format!("__INT_FAST{width}_TYPE__"), fast_middle);
752        d.set(&format!("__UINT_FAST{width}_TYPE__"), unsigned);
753        d.set(&format!("__INT_FAST{width}_MAX__"), max);
754        d.set(&format!("__UINT_FAST{width}_MAX__"), umax);
755    }
756    d.set("__INT_FAST64_TYPE__", wide);
757    d.set("__UINT_FAST64_TYPE__", wide_unsigned);
758    d.set("__INT_FAST64_MAX__", &wide_max);
759    d.set("__UINT_FAST64_MAX__", &wide_umax);
760
761    widths(d, target, &wchar, &wint, if fast_is_wide { 64 } else { 32 });
762}
763
764/// The widths, which C23's `limits.h` and `stdint.h` are written out of.
765///
766/// Twenty macros and not a few more: there is no `__INT8_WIDTH__`, because the width of an
767/// exact width type is in its name and gcc does not define one, and there is no unsigned member
768/// of any of these pairs, because a signed type and its unsigned counterpart have the same
769/// width and `UINTMAX_WIDTH` is written `__INTMAX_WIDTH__` in every header that needs it.
770///
771/// Each of these says how many value bits and sign bits the type has, which is not the same as
772/// how many bits it occupies. They agree for every type on every target here, and the day one of
773/// them does not, this is the family that has to say the smaller number.
774fn widths(d: &mut Defs, target: &TargetInfo, wchar: &Wchar, wint: &Wint, fast_middle: u32) {
775    let pointer = target.pointer_width;
776    d.set("__SCHAR_WIDTH__", "8");
777    d.set("__SHRT_WIDTH__", "16");
778    d.set("__INT_WIDTH__", "32");
779    d.set("__LONG_WIDTH__", &target.long_width.to_string());
780    d.set("__LONG_LONG_WIDTH__", "64");
781    d.set("__INTMAX_WIDTH__", "64");
782    d.set("__INTPTR_WIDTH__", &pointer.to_string());
783    d.set("__PTRDIFF_WIDTH__", &pointer.to_string());
784    d.set("__SIZE_WIDTH__", &pointer.to_string());
785    d.set("__SIG_ATOMIC_WIDTH__", "32");
786    d.set("__WCHAR_WIDTH__", &(wchar.size * 8).to_string());
787    d.set("__WINT_WIDTH__", &wint.width.to_string());
788    for width in [8, 16, 32, 64] {
789        d.set(&format!("__INT_LEAST{width}_WIDTH__"), &width.to_string());
790    }
791    d.set("__INT_FAST8_WIDTH__", "8");
792    d.set("__INT_FAST16_WIDTH__", &fast_middle.to_string());
793    d.set("__INT_FAST32_WIDTH__", &fast_middle.to_string());
794    d.set("__INT_FAST64_WIDTH__", "64");
795}
796
797/// One width of the exact and least families, which are the same types.
798fn exact(
799    d: &mut Defs,
800    width: u32,
801    signed: &str,
802    unsigned: &str,
803    max: &str,
804    umax: &str,
805    // The suffix the width needs and nothing more, so `""`, `"L"` or `"LL"`. The `U` that
806    // makes a constant unsigned is added below and is not part of this, because a caller that
807    // wrote it here would produce `UU` on the unsigned macro and a stray `U` on the signed one.
808    width_suffix: &str,
809) {
810    d.set(&format!("__INT{width}_TYPE__"), signed);
811    d.set(&format!("__UINT{width}_TYPE__"), unsigned);
812    d.set(&format!("__INT{width}_MAX__"), max);
813    d.set(&format!("__UINT{width}_MAX__"), umax);
814    d.set(&format!("__INT_LEAST{width}_TYPE__"), signed);
815    d.set(&format!("__UINT_LEAST{width}_TYPE__"), unsigned);
816    d.set(&format!("__INT_LEAST{width}_MAX__"), max);
817    d.set(&format!("__UINT_LEAST{width}_MAX__"), umax);
818    // The constant makers. `__INT8_C(1)` is `1` and not `1 ## `, because a paste with nothing
819    // on the right is not a token the expander should have to think about.
820    //
821    // The `U` goes on only where the type is still unsigned after promotion. `uint8_t` and
822    // `uint16_t` are narrower than `int`, so an integer promotion turns them into a signed
823    // `int` and `UINT8_C(1)` has that type in gcc and in the standard's own words. Writing
824    // `1U` there is not a harmless extra: `UINT8_C(1) - 2` comes out as four billion odd
825    // instead of minus one, and a `_Generic` on it picks the unsigned arm. Every target this
826    // compiler has makes `int` thirty two bits, which is what makes the width enough to decide.
827    let unsigned_after_promotion = width >= 32;
828    let u = if unsigned_after_promotion { "U" } else { "" };
829    if width_suffix.is_empty() && u.is_empty() {
830        d.set(&format!("__INT{width}_C(c)"), "c");
831        d.set(&format!("__UINT{width}_C(c)"), "c");
832    } else if width_suffix.is_empty() {
833        d.set(&format!("__INT{width}_C(c)"), "c");
834        d.set(&format!("__UINT{width}_C(c)"), &format!("c ## {u}"));
835    } else {
836        d.set(&format!("__INT{width}_C(c)"), &format!("c ## {width_suffix}"));
837        d.set(&format!("__UINT{width}_C(c)"), &format!("c ## {u}{width_suffix}"));
838    }
839}
840
841/// What a header needs to know about one floating format, as the text the macros expand to.
842///
843/// The four values are written to the digit gcc writes them to rather than rounded to something
844/// tidier, because a header carrying its own copy of a limit compares the two spellings and a
845/// difference in the last place is a difference.
846struct Characteristics {
847    mant_dig: &'static str,
848    dig: &'static str,
849    min_exp: &'static str,
850    min_10_exp: &'static str,
851    max_exp: &'static str,
852    max_10_exp: &'static str,
853    decimal_dig: &'static str,
854    max: &'static str,
855    /// The largest value with a full significand, which is `max` for every format whose values
856    /// all have one and is smaller for the double-double, whose largest values do not.
857    ///
858    /// A double-double's high half can be as large as a `double` gets while its low half is
859    /// nowhere near, and the sum is then a number above anything the format can write with a
860    /// hundred and six significand bits behind it. So `LDBL_MAX` on PowerPC is `DBL_MAX` and
861    /// `LDBL_NORM_MAX` is a bit under half of it, and a program that reaches for the largest
862    /// value it can compute with wants the second.
863    norm_max: &'static str,
864    min: &'static str,
865    epsilon: &'static str,
866    denorm_min: &'static str,
867    /// Whether the format is one IEC 60559 describes, which every one of them is but the brain
868    /// float, whose significand is a `float`'s with sixteen bits cut off the end of it, and the
869    /// double-double, which is not a binary floating point format in IEC 60559's sense at all.
870    is_iec_60559: &'static str,
871}
872
873/// IEEE binary16, which is `_Float16`.
874const HALF: Characteristics = Characteristics {
875    mant_dig: "11",
876    dig: "3",
877    min_exp: "(-13)",
878    min_10_exp: "(-4)",
879    max_exp: "16",
880    max_10_exp: "4",
881    decimal_dig: "5",
882    max: "6.55040000000000000000000000000000000e+4",
883    norm_max: "6.55040000000000000000000000000000000e+4",
884    min: "6.10351562500000000000000000000000000e-5",
885    epsilon: "9.76562500000000000000000000000000000e-4",
886    denorm_min: "5.96046447753906250000000000000000000e-8",
887    is_iec_60559: "1",
888};
889
890/// The brain float, which nothing here names yet and which every format table has a row for.
891const BFLOAT16: Characteristics = Characteristics {
892    mant_dig: "8",
893    dig: "2",
894    min_exp: "(-125)",
895    min_10_exp: "(-37)",
896    max_exp: "128",
897    max_10_exp: "38",
898    decimal_dig: "4",
899    max: "3.38953138925153547590470800371487867e+38",
900    norm_max: "3.38953138925153547590470800371487867e+38",
901    min: "1.17549435082228750796873653722224568e-38",
902    epsilon: "7.81250000000000000000000000000000000e-3",
903    denorm_min: "9.18354961579912115600575419704879436e-41",
904    is_iec_60559: "0",
905};
906
907/// IEEE binary32, which is `float` and `_Float32`.
908const SINGLE: Characteristics = Characteristics {
909    mant_dig: "24",
910    dig: "6",
911    min_exp: "(-125)",
912    min_10_exp: "(-37)",
913    max_exp: "128",
914    max_10_exp: "38",
915    decimal_dig: "9",
916    max: "3.40282346638528859811704183484516925e+38",
917    norm_max: "3.40282346638528859811704183484516925e+38",
918    min: "1.17549435082228750796873653722224568e-38",
919    epsilon: "1.19209289550781250000000000000000000e-7",
920    denorm_min: "1.40129846432481707092372958328991613e-45",
921    is_iec_60559: "1",
922};
923
924/// IEEE binary64, which is `double`, `_Float64`, `_Float32x` and `long double` on Apple and
925/// on Windows.
926const DOUBLE: Characteristics = Characteristics {
927    mant_dig: "53",
928    dig: "15",
929    min_exp: "(-1021)",
930    min_10_exp: "(-307)",
931    max_exp: "1024",
932    max_10_exp: "308",
933    decimal_dig: "17",
934    max: "1.79769313486231570814527423731704357e+308",
935    norm_max: "1.79769313486231570814527423731704357e+308",
936    min: "2.22507385850720138309023271733240406e-308",
937    epsilon: "2.22044604925031308084726333618164062e-16",
938    denorm_min: "4.94065645841246544176568792868221372e-324",
939    is_iec_60559: "1",
940};
941
942/// The x87 eighty bit format, which on x86-64 is both `long double` and `_Float64x`.
943const X87: Characteristics = Characteristics {
944    mant_dig: "64",
945    dig: "18",
946    min_exp: "(-16381)",
947    min_10_exp: "(-4931)",
948    max_exp: "16384",
949    max_10_exp: "4932",
950    decimal_dig: "21",
951    max: "1.18973149535723176502126385303097021e+4932",
952    norm_max: "1.18973149535723176502126385303097021e+4932",
953    min: "3.36210314311209350626267781732175260e-4932",
954    epsilon: "1.08420217248550443400745280086994171e-19",
955    denorm_min: "3.64519953188247460252840593361941982e-4951",
956    is_iec_60559: "1",
957};
958
959/// IEEE binary128, which is `_Float128`, `_Float64x` off x86 and `long double` on AArch64 and
960/// RISC-V Linux.
961const QUAD: Characteristics = Characteristics {
962    mant_dig: "113",
963    dig: "33",
964    min_exp: "(-16381)",
965    min_10_exp: "(-4931)",
966    max_exp: "16384",
967    max_10_exp: "4932",
968    decimal_dig: "36",
969    max: "1.18973149535723176508575932662800702e+4932",
970    norm_max: "1.18973149535723176508575932662800702e+4932",
971    min: "3.36210314311209350626267781732175260e-4932",
972    epsilon: "1.92592994438723585305597794258492732e-34",
973    denorm_min: "6.47517511943802511092443895822764655e-4966",
974    is_iec_60559: "1",
975};
976
977/// IBM double-double, which is `long double` on 64-bit PowerPC.
978///
979/// The row that does not follow from a precision and an exponent range, because the format has
980/// neither. `MANT_DIG` is 106 and `DIG` is 31, which are the figures near the top of the
981/// significand and not everywhere. `MAX` is a little above `DBL_MAX`, since the high half can be
982/// `DBL_MAX` and the low half then adds to it, and `NORM_MAX` is about half of that, so this is
983/// the one row where the two are different numbers. `EPSILON` is the same number as `DENORM_MIN`,
984/// two to the minus one thousand and seventy four, because the smallest value that changes a
985/// double-double near one is a subnormal in the low half rather than one unit in the last place
986/// of anything. `MIN` is two to the minus nine hundred and sixty nine rather than `DBL_MIN`,
987/// because below that the low half has no room left to be normal in.
988///
989/// Every value here is what the reference compiler prints for `powerpc64le-linux-gnu`, checked
990/// rather than derived, on the same terms as the data layouts in `rucc-abi`. The format is one
991/// where deriving them is how the four wrong numbers in those layouts happened.
992const DOUBLE_DOUBLE: Characteristics = Characteristics {
993    mant_dig: "106",
994    dig: "31",
995    min_exp: "(-968)",
996    min_10_exp: "(-291)",
997    max_exp: "1024",
998    max_10_exp: "308",
999    decimal_dig: "33",
1000    max: "1.79769313486231580793728971405301e+308",
1001    norm_max: "8.98846567431157953864652595394501e+307",
1002    min: "2.00416836000897277799610805135016e-292",
1003    epsilon: "4.94065645841246544176568792868221e-324",
1004    denorm_min: "4.94065645841246544176568792868221e-324",
1005    is_iec_60559: "0",
1006};
1007
1008/// The row of the table a format has, so that a type the target chooses the format of can look
1009/// its own limits up rather than have them written out again per architecture.
1010const fn characteristics(format: Format) -> &'static Characteristics {
1011    match format {
1012        Format::Half => &HALF,
1013        Format::BFloat16 => &BFLOAT16,
1014        Format::Single => &SINGLE,
1015        Format::Double => &DOUBLE,
1016        Format::X87Extended => &X87,
1017        Format::Quad => &QUAD,
1018        Format::DoubleDouble => &DOUBLE_DOUBLE,
1019    }
1020}
1021
1022/// The `float.h` characteristics.
1023///
1024/// Nine families of them, which is `float`, `double` and `long double` and the six C23 named
1025/// them after. Only two of the nine depend on the target, and they are the two whose format is
1026/// a target property: `long double`, which is x87 on x86-64 Linux, quad on AArch64 and RISC-V
1027/// Linux and a `double` on Apple and on Windows, and `_Float64x`, which is the widest format the
1028/// processor has and so does not follow `long double` down on the targets that shrink it.
1029///
1030/// `__FLT128X_*__` is deliberately missing. `_Float128x` is a type no target gcc supports has,
1031/// so gcc defines nothing for it and neither does this.
1032fn floats(d: &mut Defs, target: &TargetInfo) {
1033    d.set("__FLT_RADIX__", "2");
1034    // Real arithmetic follows IEC 60559 in every format on every target here, which is what
1035    // the value two says. Not `__GCC_IEC_559_COMPLEX`, which is the same claim about complex
1036    // arithmetic and would not be true: multiplication and division of complex values are not
1037    // lowered yet, and Annex G is mostly about what those two do with an infinity.
1038    d.set("__GCC_IEC_559", "2");
1039    // Every operation is done in the type of its operands, which is what SSE2 and the AArch64
1040    // and RISC-V floating units all do. The other two names are the same answer asked under the
1041    // rules of C99 and of TS 18661-3, which are the same rules for a target with no excess
1042    // precision to have, and glibc's `<math.h>` reads the last of the three.
1043    d.set("__FLT_EVAL_METHOD__", "0");
1044    d.set("__FLT_EVAL_METHOD_C99__", "0");
1045    d.set("__FLT_EVAL_METHOD_TS_18661_3__", "0");
1046
1047    family(d, "FLT", &SINGLE, |value| format!("{value}F"));
1048    // gcc writes the `double` values as `long double` constants cast back down, which is exact
1049    // in every format `long double` has and is the one family whose values are not a suffix.
1050    family(d, "DBL", &DOUBLE, |value| format!("((double){value}L)"));
1051    family(d, "LDBL", characteristics(target.long_double_format), |value| format!("{value}L"));
1052
1053    family(d, "FLT16", &HALF, |value| format!("{value}F16"));
1054    family(d, "FLT32", &SINGLE, |value| format!("{value}F32"));
1055    family(d, "FLT64", &DOUBLE, |value| format!("{value}F64"));
1056    family(d, "FLT128", &QUAD, |value| format!("{value}F128"));
1057    family(d, "FLT32X", &DOUBLE, |value| format!("{value}F32x"));
1058    // Nothing at all on a target whose widest format is a `double`, which is what gcc does
1059    // there: `_Float64x` is not a type on that machine and the family that describes it is not a
1060    // set of macros with a smaller answer in them.
1061    if let Some(format) = target.float64x_format {
1062        family(d, "FLT64X", characteristics(format), |value| format!("{value}F64x"));
1063    }
1064
1065    // The number itself rather than the name of the other macro. The value is the same either
1066    // way, since `long double` is the widest format here, but the two are not the same thing to
1067    // read: `-dM` prints what the macro is, and a program that undefines `__LDBL_DECIMAL_DIG__`
1068    // takes this one with it. gcc writes the number.
1069    d.set("__DECIMAL_DIG__", characteristics(target.long_double_format).decimal_dig);
1070}
1071
1072/// One family of `float.h` macros, named `__{prefix}_*__`.
1073///
1074/// `write` turns a value into the constant its macro expands to, which is a suffix for every
1075/// family but `double`.
1076fn family(d: &mut Defs, prefix: &str, c: &Characteristics, write: impl Fn(&str) -> String) {
1077    d.set(&format!("__{prefix}_MANT_DIG__"), c.mant_dig);
1078    d.set(&format!("__{prefix}_DIG__"), c.dig);
1079    d.set(&format!("__{prefix}_MIN_EXP__"), c.min_exp);
1080    d.set(&format!("__{prefix}_MIN_10_EXP__"), c.min_10_exp);
1081    d.set(&format!("__{prefix}_MAX_EXP__"), c.max_exp);
1082    d.set(&format!("__{prefix}_MAX_10_EXP__"), c.max_10_exp);
1083    d.set(&format!("__{prefix}_DECIMAL_DIG__"), c.decimal_dig);
1084    d.set(&format!("__{prefix}_MAX__"), &write(c.max));
1085    d.set(&format!("__{prefix}_NORM_MAX__"), &write(c.norm_max));
1086    d.set(&format!("__{prefix}_MIN__"), &write(c.min));
1087    d.set(&format!("__{prefix}_EPSILON__"), &write(c.epsilon));
1088    d.set(&format!("__{prefix}_DENORM_MIN__"), &write(c.denorm_min));
1089    d.set(&format!("__{prefix}_IS_IEC_60559__"), c.is_iec_60559);
1090    d.set(&format!("__{prefix}_HAS_DENORM__"), "1");
1091    d.set(&format!("__{prefix}_HAS_INFINITY__"), "1");
1092    d.set(&format!("__{prefix}_HAS_QUIET_NAN__"), "1");
1093}
1094
1095#[cfg(test)]
1096mod tests {
1097    use rucc_target::Triple;
1098
1099    use super::*;
1100
1101    fn set_for(triple: &str) -> String {
1102        let triple: Triple = triple.parse().expect("a triple the compiler supports");
1103        built_in(&TargetInfo::new(triple), &Predef::new())
1104    }
1105
1106    fn has(text: &str, line: &str) -> bool {
1107        text.lines().any(|l| l == line)
1108    }
1109
1110    #[test]
1111    fn the_set_is_driven_by_the_target_rather_than_by_the_host() {
1112        let x86 = set_for("x86_64-unknown-linux-gnu");
1113        let arm = set_for("aarch64-unknown-linux-gnu");
1114        assert!(has(&x86, "#define __x86_64__ 1"));
1115        assert!(!has(&x86, "#define __aarch64__ 1"));
1116        assert!(has(&arm, "#define __aarch64__ 1"));
1117        assert!(!has(&arm, "#define __x86_64__ 1"));
1118        assert!(has(&x86, "#define __linux__ 1") && has(&arm, "#define __linux__ 1"));
1119    }
1120
1121    #[test]
1122    fn windows_is_the_target_that_makes_long_thirty_two_bits() {
1123        let windows = set_for("x86_64-pc-windows-msvc");
1124        let linux = set_for("x86_64-unknown-linux-gnu");
1125        assert!(has(&windows, "#define __SIZEOF_LONG__ 4"));
1126        assert!(has(&windows, "#define __SIZE_TYPE__ long long unsigned int"));
1127        assert!(has(&windows, "#define __INT64_TYPE__ long long int"));
1128        assert!(!has(&windows, "#define __LP64__ 1"));
1129        assert!(has(&linux, "#define __SIZEOF_LONG__ 8"));
1130        assert!(has(&linux, "#define __SIZE_TYPE__ long unsigned int"));
1131        assert!(has(&linux, "#define __INT64_TYPE__ long int"));
1132        assert!(has(&linux, "#define __LP64__ 1"));
1133    }
1134
1135    #[test]
1136    fn wchar_t_is_the_type_that_divides_the_targets() {
1137        // Signed on x86-64 Linux, unsigned on AArch64 Linux, and sixteen bits on Windows.
1138        assert!(has(&set_for("x86_64-unknown-linux-gnu"), "#define __WCHAR_TYPE__ int"));
1139        assert!(has(&set_for("aarch64-unknown-linux-gnu"), "#define __WCHAR_TYPE__ unsigned int"));
1140        let windows = set_for("x86_64-pc-windows-msvc");
1141        assert!(has(&windows, "#define __WCHAR_TYPE__ short unsigned int"));
1142        assert!(has(&windows, "#define __SIZEOF_WCHAR_T__ 2"));
1143    }
1144
1145    #[test]
1146    fn apple_spells_the_architecture_its_own_way_and_its_headers_only_know_that_spelling() {
1147        // sys/cdefs.h reaches #error "Unsupported architecture" without these, which is the
1148        // first line of the first header of every program on the platform.
1149        let darwin = set_for("aarch64-apple-darwin");
1150        assert!(has(&darwin, "#define __arm64__ 1"));
1151        assert!(has(&darwin, "#define __arm64 1"));
1152        assert!(has(&darwin, "#define __aarch64__ 1"), "the portable spelling stays too");
1153        let linux = set_for("aarch64-unknown-linux-gnu");
1154        assert!(!has(&linux, "#define __arm64__ 1"), "Apple's spelling is Apple's alone");
1155        assert!(!has(&set_for("x86_64-apple-darwin"), "#define __arm64__ 1"));
1156    }
1157
1158    #[test]
1159    fn every_limit_is_spelled_in_hexadecimal_the_way_gcc_spells_it() {
1160        // The value was never in question and the spelling is, because these macros reach a
1161        // program's text. glibc's `limits.h` writes `#define INT_MAX __INT_MAX__`, openssl
1162        // writes `((unsigned int)INT_MAX + 1)`, and `-E` over that header printed a decimal
1163        // number where gcc printed a hexadecimal one. The type is the same either way here,
1164        // which is why the suffixes are unchanged: `0x7fffffff` and `2147483647` are both
1165        // `int`, and `0xffffffffffffffffUL` and its decimal twin are both `unsigned long`.
1166        let linux = set_for("x86_64-unknown-linux-gnu");
1167        for line in [
1168            "#define __SCHAR_MAX__ 0x7f",
1169            "#define __SHRT_MAX__ 0x7fff",
1170            "#define __INT_MAX__ 0x7fffffff",
1171            "#define __LONG_MAX__ 0x7fffffffffffffffL",
1172            "#define __LONG_LONG_MAX__ 0x7fffffffffffffffLL",
1173            "#define __INTMAX_MAX__ 0x7fffffffffffffffL",
1174            "#define __UINTMAX_MAX__ 0xffffffffffffffffUL",
1175            "#define __SIZE_MAX__ 0xffffffffffffffffUL",
1176            "#define __PTRDIFF_MAX__ 0x7fffffffffffffffL",
1177            "#define __SIG_ATOMIC_MAX__ 0x7fffffff",
1178            "#define __INT8_MAX__ 0x7f",
1179            "#define __UINT8_MAX__ 0xff",
1180            "#define __INT16_MAX__ 0x7fff",
1181            "#define __UINT16_MAX__ 0xffff",
1182            "#define __INT32_MAX__ 0x7fffffff",
1183            "#define __UINT32_MAX__ 0xffffffffU",
1184            "#define __INT64_MAX__ 0x7fffffffffffffffL",
1185            "#define __UINT64_MAX__ 0xffffffffffffffffUL",
1186            "#define __INT_FAST8_MAX__ 0x7f",
1187            "#define __UINT_FAST8_MAX__ 0xff",
1188        ] {
1189            assert!(has(&linux, line), "{line}");
1190        }
1191        // Windows, where `long` is thirty two bits, so the wide suffix moves and the narrow
1192        // `long` limit is not the same number.
1193        let windows = set_for("x86_64-pc-windows-msvc");
1194        assert!(has(&windows, "#define __LONG_MAX__ 0x7fffffffL"));
1195        assert!(has(&windows, "#define __INTMAX_MAX__ 0x7fffffffffffffffLL"));
1196        assert!(has(&windows, "#define __UINTMAX_MAX__ 0xffffffffffffffffULL"));
1197    }
1198
1199    #[test]
1200    fn wint_t_does_not_follow_wchar_t() {
1201        // Apple makes it signed so that WEOF is negative the way EOF is. Linux does not.
1202        let darwin = set_for("aarch64-apple-darwin");
1203        assert!(has(&darwin, "#define __WINT_TYPE__ int"));
1204        assert!(has(&darwin, "#define __WINT_MAX__ 0x7fffffff"));
1205        assert!(has(&darwin, "#define __WCHAR_TYPE__ int"));
1206        let linux = set_for("aarch64-unknown-linux-gnu");
1207        assert!(has(&linux, "#define __WINT_TYPE__ unsigned int"));
1208        assert!(has(&linux, "#define __WINT_MAX__ 0xffffffffU"));
1209        assert!(has(&linux, "#define __WCHAR_TYPE__ unsigned int"), "and wchar_t is its own");
1210        assert!(has(
1211            &set_for("x86_64-pc-windows-msvc"),
1212            "#define __WINT_TYPE__ short unsigned int"
1213        ));
1214    }
1215
1216    #[test]
1217    fn the_widths_say_what_the_type_holds_and_follow_the_target_that_changes_it() {
1218        // Twenty of them, which is gcc's set: no exact width member, since the width of an
1219        // `int32_t` is in its name, and no unsigned member, since a header that wants
1220        // `UINTMAX_WIDTH` writes `__INTMAX_WIDTH__`.
1221        let linux = set_for("x86_64-unknown-linux-gnu");
1222        assert_eq!(linux.lines().filter(|line| line.contains("_WIDTH__")).count(), 20);
1223        assert!(has(&linux, "#define __LONG_WIDTH__ 64"));
1224        assert!(has(&linux, "#define __SIZE_WIDTH__ 64"));
1225        assert!(has(&linux, "#define __WCHAR_WIDTH__ 32"));
1226        assert!(has(&linux, "#define __INT_LEAST16_WIDTH__ 16"));
1227        // x86-64 glibc is where `int_fast16_t` is a `long`, and the width has to say so or a
1228        // program that switches on it picks the wrong branch.
1229        assert!(has(&linux, "#define __INT_FAST16_WIDTH__ 64"));
1230        assert!(has(&set_for("x86_64-unknown-linux-musl"), "#define __INT_FAST16_WIDTH__ 32"));
1231        // Windows has a thirty two bit `long` and a sixteen bit `wint_t`, and the pointer
1232        // sized types stay sixty four bits wide whatever `long` does.
1233        let windows = set_for("x86_64-pc-windows-msvc");
1234        assert!(has(&windows, "#define __LONG_WIDTH__ 32"));
1235        assert!(has(&windows, "#define __WINT_WIDTH__ 16"));
1236        assert!(has(&windows, "#define __SIZE_WIDTH__ 64"));
1237        assert!(has(&windows, "#define __INTMAX_WIDTH__ 64"));
1238    }
1239
1240    #[test]
1241    fn a_constant_maker_gets_the_suffix_its_width_needs_and_no_other() {
1242        // Found by diffing `-dM` against the system compiler. The 32 bit row was passing `U`
1243        // as its width suffix, which put a `U` on the signed macro and two on the unsigned
1244        // one, and `UINT32_C(1)` expanded to `1UU`, which is not a token.
1245        let linux = set_for("x86_64-unknown-linux-gnu");
1246        assert!(has(&linux, "#define __INT32_C(c) c"));
1247        assert!(has(&linux, "#define __UINT32_C(c) c ## U"));
1248        assert!(has(&linux, "#define __INT16_C(c) c"));
1249        // No `U` on the two narrow ones, because `uint8_t` and `uint16_t` promote to a
1250        // signed `int` and the constant has that type. gcc leaves it off for the same reason.
1251        assert!(has(&linux, "#define __UINT16_C(c) c"));
1252        assert!(has(&linux, "#define __UINT8_C(c) c"));
1253        // The wide ones do take a suffix, and the `U` goes in front of it.
1254        assert!(has(&linux, "#define __INT64_C(c) c ## L"));
1255        assert!(has(&linux, "#define __UINT64_C(c) c ## UL"));
1256        // Windows has a thirty two bit `long`, so its sixty four bit constants are `long long`.
1257        let windows = set_for("x86_64-pc-windows-msvc");
1258        assert!(has(&windows, "#define __INT64_C(c) c ## LL"));
1259        assert!(has(&windows, "#define __UINT64_C(c) c ## ULL"));
1260    }
1261
1262    #[test]
1263    fn the_symbol_prefix_is_defined_everywhere_including_where_it_is_empty() {
1264        // Empty is not the same as absent, because glibc stringifies it. Leaving it undefined
1265        // turns `__asm__ (__ASMNAME ("__xpg_strerror_r"))` into an asm name of
1266        // "__USER_LABEL_PREFIX__" "__xpg_strerror_r", which renames the function instead of
1267        // failing, and that is a bug found at link time or later.
1268        for triple in
1269            ["x86_64-unknown-linux-gnu", "aarch64-unknown-linux-gnu", "x86_64-pc-windows-msvc"]
1270        {
1271            assert!(has(&set_for(triple), "#define __USER_LABEL_PREFIX__ "), "{triple}");
1272        }
1273        // Mach-O keeps the underscore that ELF dropped.
1274        assert!(has(&set_for("aarch64-apple-darwin"), "#define __USER_LABEL_PREFIX__ _"));
1275    }
1276
1277    /// The set gcc defines that headers read and that are true here. Written out one line at a
1278    /// time rather than counted, because the value is the whole point of each of them: a header
1279    /// asking `#if __FINITE_MATH_ONLY__` wants the number and not the existence.
1280    #[test]
1281    fn the_toolchain_macros_gcc_defines_are_defined_with_gccs_values() {
1282        let linux = set_for("x86_64-unknown-linux-gnu");
1283        for line in [
1284            "#define __GNUC_EXECUTION_CHARSET_NAME \"UTF-8\"",
1285            "#define __GNUC_WIDE_EXECUTION_CHARSET_NAME \"UTF-32LE\"",
1286            "#define __GXX_ABI_VERSION 1021",
1287            "#define __REGISTER_PREFIX__ ",
1288            "#define __FINITE_MATH_ONLY__ 0",
1289            "#define __GCC_IEC_559 2",
1290            "#define __GCC_CONSTRUCTIVE_SIZE 64",
1291            "#define __GCC_DESTRUCTIVE_SIZE 64",
1292            "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_1 1",
1293            "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_2 1",
1294            "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_4 1",
1295            "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_8 1",
1296            "#define __ATOMIC_HLE_ACQUIRE 65536",
1297            "#define __ATOMIC_HLE_RELEASE 131072",
1298            "#define __FXSR__ 1",
1299            "#define __MMX_WITH_SSE__ 1",
1300            "#define __code_model_small__ 1",
1301        ] {
1302            assert!(has(&linux, line), "{line}");
1303        }
1304        // The complex half of the IEC 60559 claim is not made, because complex multiplication
1305        // and division are not lowered and Annex G is mostly about what those two do.
1306        assert!(!linux.contains("__GCC_IEC_559_COMPLEX"));
1307        // The five that are the processor's rather than the compiler's stay on the processor.
1308        let arm = set_for("aarch64-unknown-linux-gnu");
1309        for name in ["__ATOMIC_HLE_ACQUIRE", "__FXSR__", "__MMX_WITH_SSE__", "__code_model_small__"]
1310        {
1311            assert!(!arm.contains(name), "{name}");
1312        }
1313        assert!(has(&arm, "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_8 1"));
1314        // A wide character is sixteen bits on Windows, so a wide string is UTF-16 there.
1315        let windows = set_for("x86_64-pc-windows-msvc");
1316        assert!(has(&windows, "#define __GNUC_WIDE_EXECUTION_CHARSET_NAME \"UTF-16LE\""));
1317    }
1318
1319    #[test]
1320    fn the_memory_orders_are_there_even_without_atomics() {
1321        // musl's stdatomic.h writes `memory_order_relaxed = __ATOMIC_RELAXED` with no test
1322        // around it, so these are not a promise about `_Atomic`, they are the numbering the
1323        // builtins take, and a compiler without them prints an enumerator whose value is an
1324        // identifier.
1325        let linux = set_for("x86_64-unknown-linux-gnu");
1326        assert!(has(&linux, "#define __ATOMIC_RELAXED 0"));
1327        assert!(has(&linux, "#define __ATOMIC_SEQ_CST 5"));
1328        assert!(has(&linux, "#define __STDC_NO_ATOMICS__ 1"), "and we still have no _Atomic");
1329        assert!(has(&linux, "#define __GCC_ATOMIC_INT_LOCK_FREE 2"));
1330        assert!(has(&linux, "#define __GCC_ATOMIC_LLONG_LOCK_FREE 2"));
1331        assert!(has(&set_for("x86_64-pc-windows-msvc"), "#define __GCC_ATOMIC_LLONG_LOCK_FREE 2"));
1332    }
1333
1334    #[test]
1335    fn long_double_is_three_types_and_the_macros_say_which() {
1336        assert!(has(&set_for("x86_64-unknown-linux-gnu"), "#define __LDBL_MANT_DIG__ 64"));
1337        assert!(has(&set_for("aarch64-unknown-linux-gnu"), "#define __LDBL_MANT_DIG__ 113"));
1338        assert!(has(&set_for("aarch64-apple-darwin"), "#define __LDBL_MANT_DIG__ 53"));
1339    }
1340
1341    #[test]
1342    fn the_extended_floating_types_have_the_limits_their_formats_have() {
1343        // Every one of these but `_Float64x` is the same format on every target, which is the
1344        // point of the interchange types, so the limits are the same everywhere too.
1345        let linux = set_for("x86_64-unknown-linux-gnu");
1346        assert!(has(&linux, "#define __FLT16_MANT_DIG__ 11"));
1347        assert!(has(&linux, "#define __FLT32_MANT_DIG__ 24"));
1348        assert!(has(&linux, "#define __FLT64_MANT_DIG__ 53"));
1349        assert!(has(&linux, "#define __FLT128_MANT_DIG__ 113"));
1350        assert!(has(&linux, "#define __FLT32X_MANT_DIG__ 53"));
1351        // Each family writes its values with its own suffix, so a header that assigns one to an
1352        // object of the type gets the type back rather than a conversion.
1353        assert!(has(&linux, "#define __FLT16_MAX__ 6.55040000000000000000000000000000000e+4F16"));
1354        assert!(has(
1355            &linux,
1356            "#define __FLT32X_MIN__ 2.22507385850720138309023271733240406e-308F32x"
1357        ));
1358        // `_Float128x` is a type no target has, so gcc defines nothing for it and neither
1359        // does this.
1360        assert!(!linux.contains("__FLT128X_"));
1361    }
1362
1363    #[test]
1364    fn float64x_keeps_the_width_that_long_double_loses_on_apple() {
1365        // The two are the same eighty bit x87 format on x86-64 and part company everywhere
1366        // else, because `_Float64x` follows the processor and `long double` follows the ABI.
1367        let linux = set_for("x86_64-unknown-linux-gnu");
1368        assert!(has(&linux, "#define __FLT64X_MANT_DIG__ 64"));
1369        assert!(has(&linux, "#define __LDBL_MANT_DIG__ 64"));
1370        let mac = set_for("aarch64-apple-darwin");
1371        assert!(has(&mac, "#define __FLT64X_MANT_DIG__ 113"));
1372        assert!(has(&mac, "#define __LDBL_MANT_DIG__ 53"));
1373        let windows = set_for("x86_64-pc-windows-msvc");
1374        assert!(has(&windows, "#define __FLT64X_MANT_DIG__ 64"));
1375        assert!(has(&windows, "#define __LDBL_MANT_DIG__ 53"));
1376    }
1377
1378    #[test]
1379    fn the_largest_value_of_an_ieee_format_is_also_its_largest_normal_one() {
1380        // `NORM_MAX` is only ever smaller than `MAX` for a format that holds values above its
1381        // largest normal one, and no IEEE encoding does. The double-double does, which is why
1382        // the two are separate fields now, and no target here has one.
1383        let linux = set_for("x86_64-unknown-linux-gnu");
1384        for prefix in ["FLT", "DBL", "LDBL", "FLT16", "FLT32", "FLT64", "FLT128", "FLT32X"] {
1385            let value = |suffix: &str| {
1386                let name = format!("#define __{prefix}_{suffix}__ ");
1387                let line = linux
1388                    .lines()
1389                    .find(|line| line.starts_with(&name))
1390                    .unwrap_or_else(|| panic!("__{prefix}_{suffix}__ is defined"));
1391                line[name.len()..].to_owned()
1392            };
1393            assert_eq!(value("MAX"), value("NORM_MAX"), "__{prefix}_NORM_MAX__");
1394        }
1395    }
1396
1397    #[test]
1398    fn the_double_double_is_the_row_where_the_largest_value_is_not_the_largest_normal_one() {
1399        // No target here has a double-double `long double`, so this asks the row rather than the
1400        // macros. It is the reason `norm_max` is a field: a program that wants the largest value
1401        // it can still compute a full significand with wants `NORM_MAX`, and on PowerPC that is
1402        // a bit under half of `MAX`.
1403        let c = characteristics(Format::DoubleDouble);
1404        assert_ne!(c.max, c.norm_max);
1405        // `NORM_MAX` is two to the one thousand and twenty three, which is about half of `MAX`,
1406        // and `MAX` is a shade above `DBL_MAX` because the high half can be `DBL_MAX` and the low
1407        // half then adds to it. Both are what the reference prints.
1408        assert!(c.norm_max.starts_with("8.98846567431157953864652595394501e+307"));
1409        assert!(c.max.starts_with("1.7976931348623158"));
1410        // Epsilon is the odd one. The smallest value that changes a double-double near one is a
1411        // subnormal in the low half rather than one unit in the last place of anything, so it is
1412        // the same number as this format's own `DENORM_MIN`, which no other row can say.
1413        assert_eq!(c.epsilon, c.denorm_min);
1414        for format in [Format::Half, Format::Single, Format::Double, Format::X87Extended] {
1415            assert_ne!(characteristics(format).epsilon, characteristics(format).denorm_min);
1416        }
1417        // And it is not an IEC 60559 format, which only the brain float can also say.
1418        assert_eq!(c.is_iec_60559, "0");
1419    }
1420
1421    #[test]
1422    fn the_widest_bit_int_is_said_in_every_dialect() {
1423        // gcc defines it under `-std=c17` as well as `-std=c23`, and a header that reaches for
1424        // `_BitInt` tests the macro rather than the version, so an absent one reads as a
1425        // compiler without the type at all.
1426        let mut opts = Predef::new();
1427        let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1428        assert!(has(&built_in(&target, &opts), "#define __BITINT_MAXWIDTH__ 128"));
1429        opts.std = Std::C17;
1430        assert!(has(&built_in(&target, &opts), "#define __BITINT_MAXWIDTH__ 128"));
1431    }
1432
1433    #[test]
1434    fn char_signedness_is_recorded_only_when_it_is_unsigned() {
1435        // Which is how GCC does it: the macro exists to mark the unusual case.
1436        assert!(has(&set_for("aarch64-unknown-linux-gnu"), "#define __CHAR_UNSIGNED__ 1"));
1437        assert!(!has(&set_for("x86_64-unknown-linux-gnu"), "#define __CHAR_UNSIGNED__ 1"));
1438    }
1439
1440    #[test]
1441    fn the_dialect_decides_the_standard_macros() {
1442        let mut opts = Predef::new();
1443        let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1444        assert!(has(&built_in(&target, &opts), "#define __STDC_VERSION__ 202311L"));
1445        assert!(!has(&built_in(&target, &opts), "#define __STRICT_ANSI__ 1"));
1446        assert!(has(&built_in(&target, &opts), "#define linux 1"));
1447
1448        opts.gnu_extensions = false;
1449        assert!(has(&built_in(&target, &opts), "#define __STRICT_ANSI__ 1"));
1450        assert!(!has(&built_in(&target, &opts), "#define linux 1"), "not a reserved name");
1451
1452        opts.std = Std::C89;
1453        let c89 = built_in(&target, &opts);
1454        assert!(!c89.contains("__STDC_VERSION__"), "C89 does not define it at all");
1455        assert!(has(&c89, "#define __STDC__ 1"));
1456    }
1457
1458    /// The conditional feature macros are claims not to have something, and a claim that is
1459    /// not true changes what a header declares rather than turning anything off.
1460    #[test]
1461    fn the_only_things_claimed_missing_are_the_ones_that_are_missing() {
1462        let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1463        let opts = Predef::new();
1464        let set = built_in(&target, &opts);
1465        assert!(has(&set, "#define __STDC_NO_ATOMICS__ 1"), "there is no stdatomic.h to include");
1466        assert!(has(&set, "#define __STDC_NO_THREADS__ 1"), "nor a threads.h");
1467        assert!(has(&set, "#define __STDC_NO_COMPLEX__ 1"), "the arithmetic is not lowered");
1468        assert!(!set.contains("__STDC_NO_VLA__"), "variable length arrays work");
1469    }
1470
1471    /// gcc's own `stdatomic.h` declares `atomic_char8_t` under `#ifdef __CHAR8_TYPE__`, so a
1472    /// compiler that defines it in C17 declares a type gcc does not and one that never defines
1473    /// it is missing one in C23. Both were caught by preprocessing that header both ways.
1474    #[test]
1475    fn the_type_behind_char8_t_is_defined_in_c23_and_in_no_dialect_before_it() {
1476        let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1477        let mut opts = Predef::new();
1478        assert!(has(&built_in(&target, &opts), "#define __CHAR8_TYPE__ unsigned char"));
1479
1480        for older in [Std::C17, Std::C11, Std::C99, Std::C89] {
1481            opts.std = older;
1482            assert!(!built_in(&target, &opts).contains("__CHAR8_TYPE__"), "{older:?}");
1483        }
1484    }
1485
1486    #[test]
1487    fn the_optimizer_level_is_visible_to_the_preprocessor() {
1488        let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1489        let mut opts = Predef::new();
1490        assert!(has(&built_in(&target, &opts), "#define __NO_INLINE__ 1"));
1491        assert!(!built_in(&target, &opts).contains("__OPTIMIZE__"));
1492
1493        opts.opt_level = OptLevel::O2;
1494        assert!(has(&built_in(&target, &opts), "#define __OPTIMIZE__ 1"));
1495        assert!(!built_in(&target, &opts).contains("__OPTIMIZE_SIZE__"));
1496
1497        opts.opt_level = OptLevel::Os;
1498        assert!(has(&built_in(&target, &opts), "#define __OPTIMIZE_SIZE__ 1"));
1499    }
1500
1501    #[test]
1502    fn a_command_line_define_with_no_value_is_one() {
1503        let mut opts = Predef::new();
1504        opts.defines = vec!["FOO".to_owned(), "BAR=2".to_owned(), "F(x)=x + 1".to_owned()];
1505        opts.undefines = vec!["__linux__".to_owned()];
1506        let text = command_line(&opts);
1507        assert!(has(&text, "#define FOO 1"));
1508        assert!(has(&text, "#define BAR 2"));
1509        assert!(has(&text, "#define F(x) x + 1"));
1510        // The undefine comes last, because `-U` beats `-D` whichever side of it it was on.
1511        assert!(text.trim_end().ends_with("#undef __linux__"));
1512    }
1513
1514    #[test]
1515    fn no_command_line_macros_is_no_file_at_all() {
1516        assert!(command_line(&Predef::new()).is_empty());
1517    }
1518
1519    #[test]
1520    fn a_date_is_spelled_the_way_the_standard_fixes() {
1521        // The epoch itself, and a day that needs the space padding the format asks for.
1522        let epoch = Timestamp::from_unix(0);
1523        assert_eq!(epoch.date, "Jan  1 1970");
1524        assert_eq!(epoch.time, "00:00:00");
1525        let leap = Timestamp::from_unix(1_709_164_800);
1526        assert_eq!(leap.date, "Feb 29 2024", "2024 is a leap year");
1527        let late = Timestamp::from_unix(1_735_689_599);
1528        assert_eq!(late.date, "Dec 31 2024");
1529        assert_eq!(late.time, "23:59:59");
1530    }
1531
1532    #[test]
1533    fn a_date_before_the_epoch_still_comes_out_right() {
1534        // Not because anyone compiles in 1969, but because the arithmetic that gets this
1535        // wrong is the same arithmetic that gets a time zone offset wrong.
1536        assert_eq!(Timestamp::from_unix(-1).date, "Dec 31 1969");
1537        assert_eq!(Timestamp::from_unix(-1).time, "23:59:59");
1538    }
1539
1540    #[test]
1541    fn the_gnuc_version_is_a_knob_rather_than_a_constant() {
1542        let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1543        let mut opts = Predef::new();
1544        assert!(has(&built_in(&target, &opts), "#define __GNUC__ 7"));
1545        opts.gnuc = GnucVersion { major: 15, minor: 1, patch: 0 };
1546        assert!(has(&built_in(&target, &opts), "#define __GNUC__ 15"));
1547        assert!(has(&built_in(&target, &opts), "#define __GNUC_MINOR__ 1"));
1548    }
1549
1550    /// Which of the two inline macros is defined, over the two things that decide it.
1551    ///
1552    /// Exactly one of them is defined at a time, which is what a header reads: glibc's
1553    /// `__extern_inline` writes `extern __inline` under one and adds `__gnu_inline__` under the
1554    /// other, so both being defined or neither being defined is a header taking a path it was
1555    /// never meant to take.
1556    #[test]
1557    fn one_of_the_two_inline_macros_is_defined_and_three_things_can_pick_which() {
1558        let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1559        let gnu = "#define __GNUC_GNU_INLINE__ 1";
1560        let stdc = "#define __GNUC_STDC_INLINE__ 1";
1561
1562        let mut opts = Predef::new();
1563        assert!(has(&built_in(&target, &opts), stdc));
1564        assert!(!has(&built_in(&target, &opts), gnu));
1565
1566        opts.gnu89_inline = true;
1567        assert!(has(&built_in(&target, &opts), gnu));
1568        assert!(!has(&built_in(&target, &opts), stdc));
1569
1570        // The dialect on its own, which is where the older reading came from.
1571        let mut opts = Predef::new();
1572        opts.std = Std::C89;
1573        assert!(has(&built_in(&target, &opts), gnu));
1574        assert!(!has(&built_in(&target, &opts), stdc));
1575    }
1576
1577    #[test]
1578    fn musl_and_glibc_disagree_about_the_fast_types_on_the_same_processor() {
1579        // The same x86-64 machine, two libcs, two answers. GCC built for glibc says `long int`
1580        // and GCC built for musl says `int`, because musl defines `int_fast16_t` as `int32_t`
1581        // everywhere. It shows in `stdatomic.h`, which GCC writes out of these macros, so
1582        // getting it wrong makes every atomic fast type the wrong width.
1583        let gnu = set_for("x86_64-unknown-linux-gnu");
1584        let musl = set_for("x86_64-unknown-linux-musl");
1585        assert!(has(&gnu, "#define __INT_FAST16_TYPE__ long int"));
1586        assert!(has(&gnu, "#define __INT_FAST32_TYPE__ long int"));
1587        assert!(has(&gnu, "#define __UINT_FAST16_TYPE__ long unsigned int"));
1588        assert!(has(&musl, "#define __INT_FAST16_TYPE__ int"));
1589        assert!(has(&musl, "#define __INT_FAST32_TYPE__ int"));
1590        assert!(has(&musl, "#define __UINT_FAST16_TYPE__ unsigned int"));
1591        // The limits have to move with the types or a header that checks them stops agreeing
1592        // with the header that uses them.
1593        assert!(has(&gnu, "#define __INT_FAST16_MAX__ 0x7fffffffffffffffL"));
1594        assert!(has(&musl, "#define __INT_FAST16_MAX__ 0x7fffffff"));
1595        assert!(has(&musl, "#define __UINT_FAST16_MAX__ 0xffffffffU"));
1596    }
1597
1598    #[test]
1599    fn the_libc_only_moves_the_two_fast_types_it_is_allowed_to_move() {
1600        // 8 and 64 are the same on both, and so is everything outside the fast family. A libc
1601        // is not a processor and this is the whole of what it is permitted to change here.
1602        let gnu = set_for("x86_64-unknown-linux-gnu");
1603        let musl = set_for("x86_64-unknown-linux-musl");
1604        for line in [
1605            "#define __INT_FAST8_TYPE__ signed char",
1606            "#define __INT_FAST64_TYPE__ long int",
1607            "#define __INT64_TYPE__ long int",
1608            "#define __SIZE_TYPE__ long unsigned int",
1609            "#define __SIZEOF_LONG__ 8",
1610            "#define __LP64__ 1",
1611        ] {
1612            assert!(has(&gnu, line), "glibc lost {line}");
1613            assert!(has(&musl, line), "musl lost {line}");
1614        }
1615    }
1616
1617    #[test]
1618    fn a_non_x86_target_has_int_sized_fast_types_whatever_the_libc() {
1619        // The `long` answer was always specific to x86-64. aarch64 glibc says `int` too, so
1620        // adding the libc axis must not have turned into a second way to say x86-64.
1621        let arm_gnu = set_for("aarch64-unknown-linux-gnu");
1622        let arm_musl = set_for("aarch64-unknown-linux-musl");
1623        assert!(has(&arm_gnu, "#define __INT_FAST16_TYPE__ int"));
1624        assert!(has(&arm_musl, "#define __INT_FAST16_TYPE__ int"));
1625    }
1626}