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