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, Math, 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 /// Whether an operation may raise an exception the program looks at, from `-ftrapping-math`.
130 pub trapping_math: bool,
131 /// The rest of the `-ffast-math` family. Each licence has a macro of its own and the family
132 /// together decides `__FAST_MATH__` and whether the arithmetic is still IEC 60559's.
133 pub math: Math,
134 /// `-D` in command line order. `FOO` means `FOO=1`, as GCC has it.
135 pub defines: Vec<String>,
136 /// `-U` in command line order, applied after the defines.
137 pub undefines: Vec<String>,
138}
139
140impl Predef {
141 /// The default dialect, `gnu23`, at `-O0`.
142 pub fn new() -> Predef {
143 Predef {
144 std: Std::default(),
145 gnu_extensions: true,
146 gnu89_inline: false,
147 gnuc: GnucVersion::default(),
148 opt_level: OptLevel::O0,
149 hosted: true,
150 pic: Pic::Executable,
151 timestamp: Timestamp::now(),
152 glibc_minor: None,
153 trapping_math: true,
154 math: Math::default(),
155 defines: Vec::new(),
156 undefines: Vec::new(),
157 }
158 }
159}
160
161impl Predef {
162 /// The set the command line asked for.
163 ///
164 /// The mapping lives here rather than in the driver because it is the definition of what
165 /// each flag means to the macro set, and the driver's job is to parse a command line, not
166 /// to know that `-ffreestanding` is `__STDC_HOSTED__` being zero.
167 pub fn for_options(opts: &Options) -> Predef {
168 Predef {
169 std: opts.std,
170 gnu_extensions: opts.gnu_extensions,
171 gnu89_inline: opts.gnu89_inline,
172 gnuc: opts.gnuc,
173 opt_level: opts.opt_level,
174 hosted: opts.hosted,
175 pic: opts.pic,
176 timestamp: Timestamp::now(),
177 glibc_minor: opts.glibc_minor,
178 trapping_math: opts.trapping_math,
179 math: opts.math,
180 defines: opts.defines.clone(),
181 undefines: opts.undefines.clone(),
182 }
183 }
184}
185
186impl Default for Predef {
187 fn default() -> Predef {
188 Predef::new()
189 }
190}
191
192/// A file of `#define` lines being built up.
193struct Defs {
194 text: String,
195}
196
197impl Defs {
198 fn new() -> Defs {
199 Defs { text: String::new() }
200 }
201
202 /// `#define name value`.
203 fn set(&mut self, name: &str, value: &str) {
204 self.text.push_str("#define ");
205 self.text.push_str(name);
206 self.text.push(' ');
207 self.text.push_str(value);
208 self.text.push('\n');
209 }
210
211 /// `#define name 1`, which is what a macro that is only ever tested for needs.
212 fn flag(&mut self, name: &str) {
213 self.set(name, "1");
214 }
215
216 fn set_if(&mut self, when: bool, name: &str, value: &str) {
217 if when {
218 self.set(name, value);
219 }
220 }
221
222 fn flag_if(&mut self, when: bool, name: &str) {
223 if when {
224 self.flag(name);
225 }
226 }
227}
228
229/// The whole predefined set for a target, as the text of a file.
230pub(crate) fn built_in(target: &TargetInfo, opts: &Predef) -> String {
231 let mut d = Defs::new();
232 identity(&mut d, target, opts);
233 // `__DATE__` and `__TIME__` are fixed for the whole translation unit, which is what the
234 // standard asks for, so they are ordinary object-like macros and the expander needs to
235 // know nothing about them.
236 d.set("__DATE__", &format!("\"{}\"", opts.timestamp.date));
237 d.set("__TIME__", &format!("\"{}\"", opts.timestamp.time));
238 dialect(&mut d, opts);
239 optimization(&mut d, opts);
240 platform(&mut d, target, opts);
241 sizes(&mut d, target);
242 integers(&mut d, target);
243 floats(&mut d, target, opts);
244 atomics(&mut d, target);
245 d.text
246}
247
248/// `-D` and `-U`, as the text of a file.
249///
250/// Empty when there are none, so that the caller can skip adding a file that would say
251/// nothing. The undefines come last whatever order they were written in, because `-U` beats
252/// `-D` in GCC no matter which side of it the `-D` was on.
253pub(crate) fn command_line(opts: &Predef) -> String {
254 let mut d = Defs::new();
255 for define in &opts.defines {
256 match define.split_once('=') {
257 Some((name, value)) => d.set(name, value),
258 // `-DFOO` is `-DFOO=1`. A macro nobody gave a value to is one that is only ever
259 // tested for, and giving it an empty body would break `#if FOO`.
260 None => d.flag(define),
261 }
262 }
263 for name in &opts.undefines {
264 d.text.push_str("#undef ");
265 d.text.push_str(name);
266 d.text.push('\n');
267 }
268 d.text
269}
270
271/// What this compiler says its own version is.
272///
273/// Read from the manifest at build time rather than written here, because a number written in a
274/// second place is a number that goes stale: these five macros said 0.1.0 through sixty seven
275/// releases. A program testing `__rucc_major__` for a feature was told the answer for a version
276/// nobody has run since, and a build log recording `__VERSION__` recorded the wrong compiler.
277const VERSION: &str = env!("CARGO_PKG_VERSION");
278
279/// One dotted field of a version, as the digits at the front of it.
280///
281/// `0.10.68-rc.1` has a patch level of 68 and not of `68-rc`, and a field that is not there at all
282/// is zero, which is what a two field version means by its third. Neither shape is one this
283/// workspace publishes, and a macro that expands to something no `#if` can read is worse than a
284/// macro that is approximately right.
285fn field(version: &str, n: usize) -> &str {
286 let part = version.split('.').nth(n).unwrap_or("0");
287 let digits = part.trim_start_matches(|c: char| !c.is_ascii_digit());
288 let end = digits.find(|c: char| !c.is_ascii_digit()).unwrap_or(digits.len());
289 if end == 0 { "0" } else { &digits[..end] }
290}
291
292/// Who the compiler says it is.
293fn identity(d: &mut Defs, target: &TargetInfo, opts: &Predef) {
294 d.flag("__rucc__");
295 d.set("__rucc_version__", &format!("\"{VERSION}\""));
296 d.set("__rucc_major__", field(VERSION, 0));
297 d.set("__rucc_minor__", field(VERSION, 1));
298 d.set("__rucc_patchlevel__", field(VERSION, 2));
299 // The promise from section 4.5. Everything in the matrix hangs off this line.
300 d.set("__GNUC__", &opts.gnuc.major.to_string());
301 d.set("__GNUC_MINOR__", &opts.gnuc.minor.to_string());
302 d.set("__GNUC_PATCHLEVEL__", &opts.gnuc.patch.to_string());
303 d.set("__VERSION__", &format!("\"rucc {VERSION}\""));
304 // Not `__clang__`, deliberately. Section 4.5 says so, and a header that takes the Clang
305 // path expects Clang's extension surface rather than GCC's.
306 //
307 // Which of the two readings of `inline` is in force, which a header reads to decide how to
308 // write its own inline definitions: glibc's `__extern_inline` is `extern __inline` under the
309 // one and adds `__attribute__ ((__gnu_inline__))` under the other. C99 changed the meaning of
310 // the keyword and gcc follows the dialect, so the C89 ones keep GNU's reading and every
311 // dialect after them takes C's until `-fgnu89-inline` says otherwise.
312 let gnu_inline = opts.gnu89_inline || opts.std == Std::C89;
313 d.flag_if(gnu_inline, "__GNUC_GNU_INLINE__");
314 d.flag_if(!gnu_inline, "__GNUC_STDC_INLINE__");
315 // The charsets a literal is converted to. Both are fixed here rather than settable, since
316 // there is no `-fexec-charset` to set them with, and both are what gcc answers with none.
317 // The wide one follows `wchar_t`, which is sixteen bits on Windows and thirty two
318 // everywhere else, so it is the one target fact in this function.
319 d.set("__GNUC_EXECUTION_CHARSET_NAME", "\"UTF-8\"");
320 let wide = if target.wchar_width == 16 { "\"UTF-16LE\"" } else { "\"UTF-32LE\"" };
321 d.set("__GNUC_WIDE_EXECUTION_CHARSET_NAME", wide);
322 // The C++ ABI this would be if it compiled C++, which gcc defines in C as well. It is not
323 // a claim about this compiler so much as a number headers read: libstdc++ is not the only
324 // thing that tests it, and a C header shared with a C++ one reaches it through `extern
325 // "C"` guards. The value is gcc 16's.
326 d.set("__GXX_ABI_VERSION", "1021");
327}
328
329/// What the dialect flags say.
330fn dialect(d: &mut Defs, opts: &Predef) {
331 d.flag("__STDC__");
332 d.set_if(opts.hosted, "__STDC_HOSTED__", "1");
333 d.set_if(!opts.hosted, "__STDC_HOSTED__", "0");
334 if let Some(version) = opts.std.stdc_version() {
335 d.set("__STDC_VERSION__", version);
336 }
337 // Defined exactly when the extensions are off, which is the whole difference between
338 // `-std=c23` and `-std=gnu23` as far as the preprocessor is concerned.
339 d.flag_if(!opts.gnu_extensions, "__STRICT_ANSI__");
340 d.flag("__STDC_UTF_16__");
341 d.flag("__STDC_UTF_32__");
342 // Only while the arithmetic is IEC 60559's, which a fast math licence ends. glibc's
343 // `<stdc-predef.h>` writes the same four from `__GCC_IEC_559` and writes none of them when that
344 // is zero, so saying them here under `-ffast-math` would be the redefinition described below
345 // with the opposite sign.
346 let iec = opts.math.iec_559(opts.trapping_math);
347 d.flag_if(iec, "__STDC_IEC_559__");
348 d.flag_if(iec, "__STDC_IEC_559_COMPLEX__");
349 // TS 18661-1's date, in every dialect, which is gcc 16's answer rather than the standard's.
350 // C23 folded that document into Annex F and gave the macro a date of its own, so 202311L is
351 // the value C23 asks for, and writing it is what a reading of the standard alone produces.
352 // It also breaks every translation unit that reaches glibc. `<stdc-predef.h>` is included
353 // ahead of the first line of the file and defines this name as 201404L whenever
354 // `__GCC_IEC_559` is positive, which it is here, so a different value is a redefinition with
355 // a different body and that is a diagnostic on a line the program never wrote. The cost is
356 // not only noise: sqlite's configure runs its feature tests through autosetup's `cctest
357 // -nooutput 1`, which reads any output at all as a failed test, and the readline completion
358 // test failed for no other reason than this warning.
359 d.set_if(iec, "__STDC_IEC_60559_BFP__", "201404L");
360 // The same date for the complex half, which is the other name `<stdc-predef.h>` writes and
361 // which was missing here. Withholding it looked like the careful answer and was not one, for
362 // two reasons. `__STDC_NO_COMPLEX__` is defined, so there is no complex arithmetic for the
363 // claim to be about and a program that reads one of these has already been told there is
364 // none. And the library makes the claim anyway: the `#else` in `<stdc-predef.h>` is reached
365 // by a compiler that says nothing about its intent, and it presumes an older compiler that
366 // meant yes. Saying nothing therefore does not withhold anything, it only makes the value
367 // arrive from somewhere else.
368 d.set_if(iec, "__STDC_IEC_60559_COMPLEX__", "201404L");
369 d.set("__STDC_ISO_10646__", "201706L");
370 // The type behind `char8_t`, which C23 added and no dialect before it has. It sits here
371 // rather than next to `__CHAR16_TYPE__` and `__CHAR32_TYPE__` because those two are the
372 // same in every dialect and this one is not, which is the whole reason a header can test
373 // for it: gcc's own `stdatomic.h` writes `atomic_char8_t` under `#ifdef __CHAR8_TYPE__`
374 // and gets it in C23 and not in C17.
375 d.set_if(opts.std >= Std::C23, "__CHAR8_TYPE__", "unsigned char");
376 // C11 made these conditional features, and a header that sees `__STDC_VERSION__` at
377 // 201112 with no `__STDC_NO_ATOMICS__` next to it will use `_Atomic`. Each one here is a
378 // claim not to have something, so each one is only correct while it stays true: atomics
379 // because there is no `stdatomic.h` to include, threads because there is no `threads.h`,
380 // and complex because the arithmetic is not lowered.
381 //
382 // Variable length arrays are not on this list, because they work. Claiming otherwise is
383 // not a harmless overstatement of caution: glibc's `regex.h` writes the bound of
384 // `regexec`'s match array as `_REGEX_NELTS (__nmatch)`, which is the parameter when the
385 // dialect has them and nothing at all when a compiler says it does not, so the claim
386 // silently changes a declaration in a header rather than turning something off.
387 if opts.std.has_c11() {
388 d.flag("__STDC_NO_ATOMICS__");
389 d.flag("__STDC_NO_THREADS__");
390 d.flag("__STDC_NO_COMPLEX__");
391 }
392 // What `__has_embed` answers with. They are defined in every dialect and not only in C23,
393 // because the operator is answerable in every dialect and a header that writes
394 // `#if __has_embed(...) == __STDC_EMBED_FOUND__` under `-std=gnu17` would otherwise be
395 // comparing against zero and taking the not found branch on a resource that is there.
396 d.set("__STDC_EMBED_NOT_FOUND__", "0");
397 d.set("__STDC_EMBED_FOUND__", "1");
398 d.set("__STDC_EMBED_EMPTY__", "2");
399}
400
401/// The memory orders and the lock free answers.
402///
403/// These are here whether or not `_Atomic` is, and `__STDC_NO_ATOMICS__` does not turn them
404/// off, because they are the numbering the `__atomic` builtins take rather than a promise
405/// about the language. musl's `stdatomic.h` writes `memory_order_relaxed = __ATOMIC_RELAXED`
406/// with no test around it at all, so a compiler without them prints an enumerator whose value
407/// is an identifier.
408///
409/// Two means always lock free, and every integer type gets a two on all three targets, which
410/// are all sixty four bit machines. `long long` is the one that would change on a thirty two
411/// bit target, where a double word load is an instruction the machine may or may not have.
412fn atomics(d: &mut Defs, target: &TargetInfo) {
413 d.set("__ATOMIC_RELAXED", "0");
414 d.set("__ATOMIC_CONSUME", "1");
415 d.set("__ATOMIC_ACQUIRE", "2");
416 d.set("__ATOMIC_RELEASE", "3");
417 d.set("__ATOMIC_ACQ_REL", "4");
418 d.set("__ATOMIC_SEQ_CST", "5");
419 // The gate is the machine word rather than `long`, because Windows has a thirty two bit
420 // `long` on a sixty four bit machine and its `long long` is still one instruction.
421 let llong = if target.pointer_width == 64 { "2" } else { "1" };
422 for name in [
423 "BOOL", "CHAR", "CHAR8_T", "CHAR16_T", "CHAR32_T", "WCHAR_T", "SHORT", "INT", "LONG",
424 "POINTER",
425 ] {
426 d.set(&format!("__GCC_ATOMIC_{name}_LOCK_FREE"), "2");
427 }
428 // The one that is not always two: a target whose word is thirty two bits wide can only
429 // promise `long long` is lock free if it has a double word instruction, and the honest
430 // answer there is sometimes rather than always.
431 d.set("__GCC_ATOMIC_LLONG_LOCK_FREE", llong);
432 d.set("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
433 // What `__sync_bool_compare_and_swap` works on, one macro per width in bytes. Every target
434 // here has the instruction at all four, and glibc reads these rather than the `__atomic_*`
435 // set because they are the older question and the answer is the same one.
436 for width in [1, 2, 4, 8] {
437 d.flag(&format!("__GCC_HAVE_SYNC_COMPARE_AND_SWAP_{width}"));
438 }
439 // The two flag bits an x86 memory order can carry, for the hardware lock elision prefixes.
440 // They are numbers a program passes back to a builtin rather than a claim that the prefix
441 // is emitted, and a program that computes one on a machine where the macro is missing gets
442 // a preprocessor error rather than a slower atomic.
443 if target.tuple.arch() == tuple::Arch::X86_64 {
444 d.set("__ATOMIC_HLE_ACQUIRE", "65536");
445 d.set("__ATOMIC_HLE_RELEASE", "131072");
446 }
447}
448
449/// What the optimizer level says.
450fn optimization(d: &mut Defs, opts: &Predef) {
451 d.flag_if(opts.opt_level.runs_optimizer(), "__OPTIMIZE__");
452 d.flag_if(opts.opt_level.is_size(), "__OPTIMIZE_SIZE__");
453 // glibc's headers test this before deciding whether to define a function as an inline
454 // wrapper, so getting it wrong changes what a program links against.
455 d.flag_if(!opts.opt_level.runs_optimizer(), "__NO_INLINE__");
456 // Zero, and one under `-ffinite-math-only`, which `-ffast-math` implies. glibc's `math.h`
457 // reads it to decide whether to declare the `__*_finite` aliases, so it has to be defined
458 // rather than merely not claimed: a header testing `#if __FINITE_MATH_ONLY__ > 0` on a
459 // compiler that leaves it undefined takes the same branch, but one writing `#if
460 // !__FINITE_MATH_ONLY__` is a different question and gcc gives it an answer.
461 let math = &opts.math;
462 let trapping = opts.trapping_math;
463 d.set("__FINITE_MATH_ONLY__", if math.finite_only { "1" } else { "0" });
464 // One macro per licence, each defined only when it was given, which is how gcc 16 spells
465 // them. `__FAST_MATH__` is all of them at once and is worked out rather than remembered from
466 // the flag, so `-ffast-math -ftrapping-math` does not claim it, and regrouping is the one gcc
467 // drops unless nothing could tell it happened.
468 d.flag_if(math.fast(trapping), "__FAST_MATH__");
469 d.flag_if(!math.errno, "__NO_MATH_ERRNO__");
470 d.flag_if(!trapping, "__NO_TRAPPING_MATH__");
471 d.flag_if(!math.signed_zeros, "__NO_SIGNED_ZEROS__");
472 d.flag_if(math.reciprocal, "__RECIPROCAL_MATH__");
473 d.flag_if(math.associative(trapping), "__ASSOCIATIVE_MATH__");
474}
475
476/// The architecture, the operating system and the object format.
477fn platform(d: &mut Defs, target: &TargetInfo, opts: &Predef) {
478 // The macros a target with no backend predefines are not written down here. They are a
479 // header's whole view of the machine, a wrong one is a header taking a branch written for
480 // another processor, and there is nothing cheap that would catch it. The driver takes a three
481 // field triple, so a target this cannot spell is one nobody can ask for yet rather than a
482 // hole in what it answers.
483 let Some(triple) = Triple::from_tuple(target.tuple) else {
484 return;
485 };
486 match triple.arch {
487 Arch::X86_64 => {
488 d.flag("__x86_64__");
489 d.flag("__x86_64");
490 d.flag("__amd64__");
491 d.flag("__amd64");
492 d.flag("__SSE__");
493 d.flag("__SSE2__");
494 d.flag("__MMX__");
495 d.flag("__SSE_MATH__");
496 d.flag("__SSE2_MATH__");
497 d.flag("__k8");
498 d.flag("__k8__");
499 // FXSAVE and FXRSTOR, which every x86-64 has, and the small code model, which is
500 // the default and the only one a program gets without being told otherwise.
501 d.flag("__FXSR__");
502 d.flag("__code_model_small__");
503 // The MMX registers are not used on x86-64: the sixty four bit operations go
504 // through SSE instead. gcc's own `xmmintrin.h` reads this to decide how to write
505 // `_mm_maskmove_si64`, so a compiler that leaves it undefined is handed a
506 // different function body than gcc is, which is what the header sweep found.
507 d.flag("__MMX_WITH_SSE__");
508 }
509 Arch::Aarch64 => {
510 d.flag("__aarch64__");
511 d.flag("__AARCH64EL__");
512 d.set("__ARM_ARCH", "8");
513 d.set("__ARM_ARCH_PROFILE", "'A'");
514 d.set("__ARM_64BIT_STATE", "1");
515 d.set("__ARM_ALIGN_MAX_PWR", "28");
516 d.set("__ARM_FP", "0xe");
517 d.set("__ARM_NEON", "1");
518 d.set("__ARM_FEATURE_UNALIGNED", "1");
519 d.set("__ARM_PCS_AAPCS64", "1");
520 // The rest of what gcc says for a plain Armv8-A. Every one is an instruction the
521 // base architecture has, so none of them depends on a `-march` this compiler does
522 // not take yet, and a program that tests one to choose `__builtin_clz` or a
523 // hardware divide over a portable loop takes the same branch it takes under gcc.
524 d.set("__ARM_ARCH_8A", "1");
525 d.set("__ARM_ARCH_ISA_A64", "1");
526 d.set("__ARM_FEATURE_CLZ", "1");
527 d.set("__ARM_FEATURE_FMA", "1");
528 d.set("__ARM_FEATURE_IDIV", "1");
529 d.set("__ARM_FEATURE_NUMERIC_MAXMIN", "1");
530 d.set("__ARM_ALIGN_MAX_STACK_PWR", "16");
531 d.set("__ARM_SIZEOF_MINIMAL_ENUM", "4");
532 d.set("__ARM_SIZEOF_WCHAR_T", "4");
533 d.set("__AARCH64_CMODEL_SMALL__", "1");
534 // A fused multiply add is one instruction here, and glibc's `math.h` turns these
535 // into `FP_FAST_FMA` and `FP_FAST_FMAF`, which a program reads to decide whether
536 // calling `fma` is cheaper than writing the product and the sum apart.
537 for name in ["", "F", "F32", "F64", "F32x"] {
538 d.set(&format!("__FP_FAST_FMA{name}"), "1");
539 }
540 }
541 Arch::Riscv64 => {
542 d.flag("__riscv");
543 d.set("__riscv_xlen", "64");
544 d.set("__riscv_flen", "64");
545 d.flag("__riscv_float_abi_double");
546 d.flag("__riscv_muldiv");
547 d.flag("__riscv_atomic");
548 d.flag("__riscv_compressed");
549 d.set("__riscv_cmodel_medlow", "1");
550 }
551 }
552 match triple.os {
553 Os::Linux => {
554 d.flag("__linux__");
555 d.flag("__linux");
556 d.flag("__unix__");
557 d.flag("__unix");
558 d.flag("__gnu_linux__");
559 d.flag("__ELF__");
560 // The unarmoured spellings are not reserved identifiers, so a strict mode may not
561 // define them. Autoconf still tests for `linux`, which is why they exist at all.
562 if opts.gnu_extensions {
563 d.flag("linux");
564 d.flag("unix");
565 }
566 }
567 Os::Darwin => {
568 d.flag("__APPLE__");
569 d.flag("__MACH__");
570 d.flag("__unix__");
571 d.flag("__unix");
572 d.set("__APPLE_CC__", "6000");
573 d.set("__DYNAMIC__", "1");
574 if triple.arch == Arch::Aarch64 {
575 // Apple's own spelling of the architecture, which its headers use rather than
576 // __aarch64__. sys/cdefs.h tests for it by name and reaches an #error called
577 // "Unsupported architecture" without it, so every system header on this
578 // platform fails on the first include until these two are here.
579 d.flag("__arm64__");
580 d.flag("__arm64");
581 // Older Apple spellings that the SDK still reads. `arm/arch.h` sets its own
582 // `_ARM_ARCH_*` family from `__ARM64_ARCH_8__`, and a header that tests
583 // `__ARM_NEON__` rather than `__ARM_NEON` is taking the portable path without
584 // the Advanced SIMD one. clang defines all three for every Apple arm64 target.
585 d.flag("__ARM64_ARCH_8__");
586 d.flag("__ARM_NEON__");
587 d.flag("__AARCH64_SIMD__");
588 }
589 // clang says this on every little endian target and gcc says it on none, which is
590 // why it is here rather than beside the byte order macros. Apple's headers were
591 // written for clang alone, and `CFByteOrder.h` and `architecture/byte_order.h` both
592 // choose their swaps from it.
593 d.flag("__LITTLE_ENDIAN__");
594 deployment_target(d, target);
595 if opts.gnu_extensions {
596 d.flag("unix");
597 }
598 }
599 Os::Windows => {
600 // Every spelling gcc has for this platform, because the mingw-w64 tree reads more
601 // than one of them and a missing one is a declaration that quietly is not there.
602 // `winuser.h` guards `EndTask` with `#ifdef WINNT` and `rpcdcep.h` guards six
603 // declarations with `#ifndef WINNT`, so a compiler that leaves it undefined
604 // preprocesses `windows.h` to a different set of functions than gcc does, which is
605 // what the token comparison against a real mingw install found.
606 d.flag("_WIN32");
607 d.flag("__WIN32");
608 d.flag("__WIN32__");
609 d.flag("__WINNT");
610 d.flag("__WINNT__");
611 d.flag("__MINGW32__");
612 // Not the machine word: `_WIN64` says the pointer is sixty four bits wide, and
613 // i686-w64-mingw32-gcc defines neither it nor `__MINGW64__`.
614 if target.pointer_width == 64 {
615 d.flag("_WIN64");
616 d.flag("__WIN64");
617 d.flag("__WIN64__");
618 d.flag("__MINGW64__");
619 }
620 // Which kind of exception machinery the platform has, and on this one there is only
621 // the one: a table the operating system reads rather than anything the prologue
622 // registers. mingw's `setjmp.h` reads this to choose the two argument `_setjmp`,
623 // whose second argument is `__builtin_frame_address(0)` and becomes the frame
624 // `longjmp` asks `RtlUnwindEx` to unwind to. That is the same address the function's
625 // own unwind record reports, because the record names the frame pointer with an
626 // offset of zero and the prologue leaves the pointer holding the body's stack
627 // pointer, so the number the builtin answers with and the number the walk arrives at
628 // are the same number by construction. Only for the architecture whose records this
629 // compiler writes: x86_64-w64-mingw32-gcc defines it and i686-w64-mingw32-gcc does
630 // not, because a thirty two bit Windows unwinds some other way.
631 if triple.arch == Arch::X86_64 && target.pointer_width == 64 {
632 d.flag("__SEH__");
633 }
634 // Which C runtime the headers are configured for. The sysroot this compiler fetches
635 // is built `--with-default-msvcrt=msvcrt` to match the link line, which names
636 // `libmsvcrt.a`, and gcc defines this for the same tree.
637 d.flag("__MSVCRT__");
638 // The widest integer the compiler has, which is what Microsoft's headers ask
639 // instead of asking about `long long`.
640 d.set("_INTEGRAL_MAX_BITS", "64");
641 // The unarmoured three, which are not reserved identifiers, so a strict mode may
642 // not define them and gcc does not. Windows code tests all three anyway, the same
643 // way portable Unix code still tests `linux`.
644 if opts.gnu_extensions {
645 d.flag("WIN32");
646 d.flag("WINNT");
647 if target.pointer_width == 64 {
648 d.flag("WIN64");
649 }
650 }
651 windows_spellings(d, opts);
652 }
653 Os::None => {
654 // Freestanding. `__ELF__` still holds, because the object format is a property of
655 // the target rather than of having an operating system under it.
656 d.flag("__ELF__");
657 }
658 }
659 match triple.env {
660 Env::Musl => d.flag("__musl__"),
661 Env::Gnu | Env::None | Env::Msvc => {}
662 }
663 // The version of the libc's headers, and only when they are the tree we bundle. One tree serves
664 // every glibc release with the differences written as `#if __GLIBC_MINOR__ >= n` inside the
665 // files, so the release is the part of it the target supplies and the compiler is what supplies
666 // it. Zig patches the same macro into the same tree the same way, which is where the spelling
667 // comes from rather than from a scheme of ours: `__GLIBC_PREREQ` reads it and so does every
668 // autoconf probe ever written.
669 //
670 // The condition is the whole of it and it is not here. A host glibc defines this macro in its
671 // own `features.h` and so does a tree the user named, and a second definition with a different
672 // value is a warning on every compilation, so the driver decides and this writes down what it
673 // decided.
674 if let Some(minor) = opts.glibc_minor {
675 d.set("__GLIBC_MINOR__", &minor.to_string());
676 }
677 // LP64 is the model everywhere except Windows, and a great deal of code tests for it
678 // rather than testing pointer and long widths separately.
679 if target.long_width == 64 && target.pointer_width == 64 {
680 d.flag("__LP64__");
681 d.flag("_LP64");
682 }
683 // What the assembler prepends to a C name to get the symbol. Mach-O keeps the leading
684 // underscore that every a.out toolchain had and ELF dropped it. It has to be defined even
685 // where it is empty, because of how it is used: glibc writes `__asm__ (__ASMNAME (name))`
686 // and that stringifies `__USER_LABEL_PREFIX__`, so a compiler that leaves it undefined
687 // does not get an error, it gets the name of the macro as the string and renames the
688 // function.
689 d.set("__USER_LABEL_PREFIX__", if triple.os == Os::Darwin { "_" } else { "" });
690 // Its counterpart, what the assembler puts in front of a register name. Empty on every
691 // target here, since all three assemble in a syntax that does not mark registers, and
692 // defined anyway for the same reason as the line above: it is used inside a stringize.
693 d.set("__REGISTER_PREFIX__", "");
694
695 // Position independent code is the default on the ELF targets and on Apple's, which is
696 // what a distribution build expects. The value 2 is GCC's for `-fPIC` rather than `-fpic`.
697 //
698 // Both are defined whichever link the output is for, because `__PIC__` says there are no
699 // absolute addresses in the text and that is true either way. What says which link it is is
700 // `__PIE__`, and a program reads it to find out whether a name it exports is one something
701 // else may replace. gcc defines it under `-fPIE` and under the default on a distribution
702 // where the default is an executable, which is the default here too.
703 if !matches!(triple.os, Os::Windows) {
704 d.set("__PIC__", "2");
705 d.set("__pic__", "2");
706 if opts.pic == Pic::Executable {
707 d.set("__PIE__", "2");
708 d.set("__pie__", "2");
709 }
710 }
711}
712
713/// The five spellings a Windows header writes a calling convention and an attribute in.
714///
715/// `int __cdecl f(void);` is the second declaration in mingw-w64's `stdio.h` and it stops a parser
716/// that has never heard of `__cdecl`, which reads it as the name being declared and then finds a
717/// second one. None of the five is a keyword, though: gcc defines every one of them as a macro over
718/// the GNU spelling of the same thing, which is why they are keywords on Windows and nowhere else
719/// without anything in its lexer being told what the target is. `-dM -E` on a mingw-w64 gcc prints
720/// exactly the lines below.
721///
722/// `__declspec(x)` being the GNU spelling of its argument is the part worth saying out loud, since
723/// it means `__declspec(dllimport)` and `__attribute__((dllimport))` cannot come to mean different
724/// things: there is one attribute and two ways of writing it, and everything that reads attributes
725/// reads both.
726///
727/// On x86-64 all four conventions name the one convention the target has, so the attributes go
728/// where every attribute nothing implements goes, which is left on the declaration. On i386 they
729/// differ over who pops the arguments and the choice is written into the symbol name, which is
730/// document 06.5 and is that target's work when there is one.
731/// The deployment target, which is the oldest release of the OS the program is promised to run
732/// on. `Availability.h` reads it through `__ENVIRONMENT_OS_VERSION_MIN_REQUIRED__` and the older
733/// per platform spelling, and turns it into `__MAC_OS_X_VERSION_MIN_REQUIRED`, which the whole
734/// SDK tests to decide which declarations exist and which are marked unavailable. Without it
735/// every one of those tests sees no version at all.
736///
737/// The version comes from the tuple, as in `aarch64-macos.13`, where `-mmacosx-version-min=`
738/// also puts it. With none given this is 11.0 on macOS, the first release that ran on Apple
739/// silicon, and 14.0 on iOS, the oldest a current SDK builds for. The oldest answer is the one
740/// that cannot hand a program a declaration the machine it runs on does not have. The encoding
741/// is two digits each for the major, minor and patch numbers, so 13.4 is 130400.
742fn deployment_target(d: &mut Defs, target: &TargetInfo) {
743 let (platform, default) = match target.tuple.os() {
744 tuple::Os::MacOs => ("MAC_OS_X", tuple::Version::new(11, 0)),
745 tuple::Os::IOs => ("IPHONE_OS", tuple::Version::new(14, 0)),
746 _ => return,
747 };
748 let version = target.tuple.os_version().unwrap_or(default);
749 let encoded = version.major_part() * 10000
750 + version.minor_part().unwrap_or(0) * 100
751 + version.patch_part().unwrap_or(0);
752 d.set(&format!("__ENVIRONMENT_{platform}_VERSION_MIN_REQUIRED__"), &encoded.to_string());
753 d.set("__ENVIRONMENT_OS_VERSION_MIN_REQUIRED__", &encoded.to_string());
754}
755
756fn windows_spellings(d: &mut Defs, opts: &Predef) {
757 for name in ["cdecl", "stdcall", "fastcall", "thiscall"] {
758 d.set(&format!("__{name}"), &format!("__attribute__((__{name}__))"));
759 // The single underscore spellings are not in the reserved namespace, so an implementation
760 // may not take them in a strict ISO mode and gcc does not.
761 if opts.gnu_extensions {
762 d.set(&format!("_{name}"), &format!("__attribute__((__{name}__))"));
763 }
764 }
765 d.set("__declspec(x)", "__attribute__((x))");
766}
767
768/// `__CHAR_BIT__`, the `__SIZEOF_*__` family and the alignment macros.
769fn sizes(d: &mut Defs, target: &TargetInfo) {
770 let pointer = target.pointer_width / 8;
771 // The two hardware interference sizes, which say how far apart two objects have to be for
772 // a write to one not to invalidate the other's cache line, and how close together two have
773 // to be to share one. A cache line is sixty four bytes on every target here, and x86-64
774 // gives that for both. Arm cores have been built with lines up to 256 bytes, so gcc and
775 // clang both give 256 for the distance that has to be safe on any of them.
776 let destructive = if target.tuple.arch() == tuple::Arch::Aarch64 { "256" } else { "64" };
777 d.set("__GCC_CONSTRUCTIVE_SIZE", "64");
778 d.set("__GCC_DESTRUCTIVE_SIZE", destructive);
779 let long = target.long_width / 8;
780 let long_double = target.long_double_width / 8;
781 d.set("__CHAR_BIT__", "8");
782 d.set("__SIZEOF_SHORT__", "2");
783 d.set("__SIZEOF_INT__", "4");
784 d.set("__SIZEOF_LONG__", &long.to_string());
785 d.set("__SIZEOF_LONG_LONG__", "8");
786 d.set("__SIZEOF_INT128__", "16");
787 d.set("__SIZEOF_FLOAT__", "4");
788 d.set("__SIZEOF_DOUBLE__", "8");
789 d.set("__SIZEOF_LONG_DOUBLE__", &long_double.to_string());
790 // Where the type has its old name and nowhere else, which is gcc's rule and the reason the
791 // macro is the one portable code tests before it writes `__float128`. PowerPC also says
792 // `__FLOAT128__`, which gcc defines there and not on x86.
793 if target.type_names().iter().any(|&(name, _)| name == "__float128") {
794 d.set("__SIZEOF_FLOAT128__", "16");
795 if target.tuple.arch() == tuple::Arch::PowerPc64 {
796 d.set("__FLOAT128__", "1");
797 }
798 }
799 d.set("__SIZEOF_POINTER__", &pointer.to_string());
800 d.set("__SIZEOF_SIZE_T__", &pointer.to_string());
801 d.set("__SIZEOF_PTRDIFF_T__", &pointer.to_string());
802 d.set("__SIZEOF_WCHAR_T__", &wchar(target).size.to_string());
803 // From the spelling rather than from a constant, because Windows makes `wint_t` a
804 // `short unsigned int` and this said four bytes there while `__WINT_WIDTH__` said sixteen
805 // bits two hundred lines away.
806 d.set("__SIZEOF_WINT_T__", &(wint(target).width / 8).to_string());
807 d.set("__BIGGEST_ALIGNMENT__", "16");
808 // The `__BYTE_ORDER__` family, which the kernel and every serialisation library read.
809 // The names of the orders are defined whichever one is in force, because code compares
810 // against both.
811 d.set("__ORDER_LITTLE_ENDIAN__", "1234");
812 d.set("__ORDER_BIG_ENDIAN__", "4321");
813 d.set("__ORDER_PDP_ENDIAN__", "3412");
814 let order =
815 if target.little_endian { "__ORDER_LITTLE_ENDIAN__" } else { "__ORDER_BIG_ENDIAN__" };
816 d.set("__BYTE_ORDER__", order);
817 d.set("__FLOAT_WORD_ORDER__", order);
818 d.flag_if(!target.char_is_signed, "__CHAR_UNSIGNED__");
819}
820
821/// How `wchar_t` is spelled on a target, and what it holds.
822struct Wchar {
823 /// The C type it is a name for.
824 spelling: &'static str,
825 /// Its width in bytes.
826 size: u32,
827 /// `__WCHAR_MAX__`.
828 max: &'static str,
829 /// `__WCHAR_MIN__`.
830 min: &'static str,
831}
832
833/// `wchar_t` is the type that divides the targets most and is written down least.
834///
835/// Windows makes it 16 bits so that a wide string is UTF-16. AArch64 Linux makes it unsigned,
836/// following the psABI's rule for plain `char`, while x86-64 Linux makes it signed. Code that
837/// compares a `wchar_t` against a negative value is correct on one and not on the other.
838///
839/// The width and the signedness come from the target description rather than from another match
840/// on the triple, because the lexer needs the same two facts to convert a wide literal and the
841/// two answers have to be the same one.
842fn wchar(target: &TargetInfo) -> Wchar {
843 match (target.wchar_width, target.wchar_is_signed) {
844 (16, false) => Wchar { spelling: "short unsigned int", size: 2, max: "0xffff", min: "0" },
845 (16, true) => Wchar { spelling: "short int", size: 2, max: "0x7fff", min: "(-32767 - 1)" },
846 (_, false) => Wchar { spelling: "unsigned int", size: 4, max: "0xffffffffU", min: "0U" },
847 (_, true) => {
848 Wchar { spelling: "int", size: 4, max: "0x7fffffff", min: "(-__WCHAR_MAX__ - 1)" }
849 }
850 }
851}
852
853/// How `wint_t` is spelled on a target, and what it holds.
854struct Wint {
855 /// The C type it is a name for.
856 spelling: &'static str,
857 /// `__WINT_MAX__`.
858 max: &'static str,
859 /// `__WINT_MIN__`.
860 min: &'static str,
861 /// `__WINT_WIDTH__`, which follows the spelling rather than `__SIZEOF_WINT_T__`.
862 width: u32,
863}
864
865/// `wint_t` does not follow `wchar_t`, and Darwin is where that shows.
866///
867/// Apple makes it a signed `int`, so that `WEOF` is negative the way `EOF` is, while Linux
868/// makes it `unsigned int` and gives `WEOF` the value `0xffffffff`. The SDK's `arm/_types.h`
869/// spells `__darwin_wint_t` as `__WINT_TYPE__` and nothing else, so getting this wrong changes
870/// the signedness of every wide character function's argument on that platform.
871fn wint(target: &TargetInfo) -> Wint {
872 match target.tuple.os() {
873 tuple::Os::Windows => {
874 Wint { spelling: "short unsigned int", max: "0xffff", min: "0", width: 16 }
875 }
876 os if os.is_darwin() => {
877 Wint { spelling: "int", max: "0x7fffffff", min: "(-__WINT_MAX__ - 1)", width: 32 }
878 }
879 _ => Wint { spelling: "unsigned int", max: "0xffffffffU", min: "0U", width: 32 },
880 }
881}
882
883/// The integer type names, their limits, and the exact width family.
884fn integers(d: &mut Defs, target: &TargetInfo) {
885 // The one fact everything below turns on: which type is 64 bits wide. On LP64 it is
886 // `long`, and on Windows LLP64 it is `long long`, and every `size_t`, `intmax_t` and
887 // `int64_t` spelling follows from that.
888 let lp64 = target.long_width == 64;
889 let wide = if lp64 { "long int" } else { "long long int" };
890 let wide_unsigned = if lp64 { "long unsigned int" } else { "long long unsigned int" };
891 let wide_suffix = if lp64 { "L" } else { "LL" };
892 let wide_max = format!("0x7fffffffffffffff{wide_suffix}");
893 let wide_umax = format!("0xffffffffffffffffU{wide_suffix}");
894
895 d.set("__SCHAR_MAX__", "0x7f");
896 d.set("__SHRT_MAX__", "0x7fff");
897 d.set("__INT_MAX__", "0x7fffffff");
898 d.set("__LONG_MAX__", if lp64 { "0x7fffffffffffffffL" } else { "0x7fffffffL" });
899 d.set("__LONG_LONG_MAX__", "0x7fffffffffffffffLL");
900 d.set("__INTMAX_MAX__", &wide_max);
901 d.set("__UINTMAX_MAX__", &wide_umax);
902 d.set("__SIZE_MAX__", &wide_umax);
903 d.set("__PTRDIFF_MAX__", &wide_max);
904 d.set("__INTPTR_MAX__", &wide_max);
905 d.set("__UINTPTR_MAX__", &wide_umax);
906 d.set("__SIG_ATOMIC_MAX__", "0x7fffffff");
907 d.set("__SIG_ATOMIC_MIN__", "(-__SIG_ATOMIC_MAX__ - 1)");
908 // The widest `_BitInt` this compiler builds, which is narrower than gcc 16's sixty five
909 // thousand five hundred and thirty five because a folded constant here is a hundred and
910 // twenty eight bits wide. A program that reads this macro to decide what to write gets an
911 // answer it can rely on, which is the point of saying a number smaller than gcc's rather
912 // than saying gcc's and refusing what it asked for. `MAX_BIT_INT_WIDTH` in `rucc-sema` is
913 // the same number and has to be changed with it.
914 d.set("__BITINT_MAXWIDTH__", "128");
915
916 let wchar = wchar(target);
917 d.set("__WCHAR_TYPE__", wchar.spelling);
918 d.set("__WCHAR_MAX__", wchar.max);
919 d.set("__WCHAR_MIN__", wchar.min);
920 let wint = wint(target);
921 d.set("__WINT_TYPE__", wint.spelling);
922 d.set("__WINT_MAX__", wint.max);
923 d.set("__WINT_MIN__", wint.min);
924 d.set("__SIZE_TYPE__", wide_unsigned);
925 d.set("__PTRDIFF_TYPE__", wide);
926 d.set("__INTMAX_TYPE__", wide);
927 d.set("__UINTMAX_TYPE__", wide_unsigned);
928 d.set("__INTPTR_TYPE__", wide);
929 d.set("__UINTPTR_TYPE__", wide_unsigned);
930 d.set("__SIG_ATOMIC_TYPE__", "int");
931 d.set("__CHAR16_TYPE__", "short unsigned int");
932 d.set("__CHAR32_TYPE__", "unsigned int");
933 d.set("__INTMAX_C(c)", &format!("c ## {wide_suffix}"));
934 d.set("__UINTMAX_C(c)", &format!("c ## U{wide_suffix}"));
935
936 // The exact width family, which is what a freestanding `stdint.h` is written out of.
937 exact(d, 8, "signed char", "unsigned char", "0x7f", "0xff", "");
938 exact(d, 16, "short int", "short unsigned int", "0x7fff", "0xffff", "");
939 // No suffix. An `int` needs none, and the `U` on the unsigned side is added by `exact`
940 // rather than being part of the width.
941 exact(d, 32, "int", "unsigned int", "0x7fffffff", "0xffffffffU", "");
942 exact(d, 64, wide, wide_unsigned, &wide_max, &wide_umax, wide_suffix);
943
944 // The fast types. GCC makes the 16 and 32 bit ones `long` on sixty four bit glibc, which
945 // is what glibc's `stdint.h` says under `__WORDSIZE == 64` whatever the processor, and
946 // `int` everywhere else. A header that computes a printf format from the type name notices
947 // the difference. gcc for aarch64, riscv64, powerpc64le and s390x all say `long int`.
948 //
949 // musl is the reason this is not simply a question of the architecture. musl defines
950 // `int_fast16_t` and `int_fast32_t` as `int32_t` on every target it supports, GCC built
951 // for a musl target agrees with it, and GCC built for glibc on the same processor does
952 // not. The place it shows is `stdatomic.h`, which GCC ships and writes directly out of
953 // these macros: `typedef _Atomic __INT_FAST16_TYPE__ atomic_int_fast16_t;`. Get this wrong
954 // and every atomic fast type in the program is the wrong width.
955 let fast_is_wide =
956 target.tuple.os() == tuple::Os::Linux && lp64 && target.tuple.env() != tuple::Env::Musl;
957 let fast_middle = if fast_is_wide { wide } else { "int" };
958 // Windows is the exception in the other direction, and it is only the 16 bit one. mingw's
959 // `stdint.h` makes `int_fast16_t` a `short` and gcc for that target says the same, while
960 // `int_fast32_t` there is the `int` it is nearly everywhere, so the two cannot share an
961 // answer on this platform the way they do on the others. The measurement is the mingw tree,
962 // which is the only Windows header tree this compiler fetches, and the msvc environment is
963 // given the same answer because nothing compiles against a tree of Microsoft's yet. Apple's
964 // `stdint.h` is the same shape, `int16_t` for the 16 bit one and `int32_t` for the other.
965 let fast16_is_short =
966 matches!(target.tuple.os(), tuple::Os::Windows | tuple::Os::MacOs | tuple::Os::IOs);
967 d.set("__INT_FAST8_TYPE__", "signed char");
968 d.set("__UINT_FAST8_TYPE__", "unsigned char");
969 d.set("__INT_FAST8_MAX__", "0x7f");
970 d.set("__UINT_FAST8_MAX__", "0xff");
971 for width in [16, 32] {
972 let (signed, unsigned, max, umax) = if width == 16 && fast16_is_short {
973 ("short int", "short unsigned int", "0x7fff", "0xffff")
974 } else if fast_middle == "int" {
975 ("int", "unsigned int", "0x7fffffff", "0xffffffffU")
976 } else {
977 (wide, wide_unsigned, wide_max.as_str(), wide_umax.as_str())
978 };
979 d.set(&format!("__INT_FAST{width}_TYPE__"), signed);
980 d.set(&format!("__UINT_FAST{width}_TYPE__"), unsigned);
981 d.set(&format!("__INT_FAST{width}_MAX__"), max);
982 d.set(&format!("__UINT_FAST{width}_MAX__"), umax);
983 }
984 d.set("__INT_FAST64_TYPE__", wide);
985 d.set("__UINT_FAST64_TYPE__", wide_unsigned);
986 d.set("__INT_FAST64_MAX__", &wide_max);
987 d.set("__UINT_FAST64_MAX__", &wide_umax);
988
989 let fast32 = if fast_is_wide { 64 } else { 32 };
990 widths(d, target, &wchar, &wint, if fast16_is_short { 16 } else { fast32 }, fast32);
991}
992
993/// The widths, which C23's `limits.h` and `stdint.h` are written out of.
994///
995/// Twenty macros and not a few more: there is no `__INT8_WIDTH__`, because the width of an
996/// exact width type is in its name and gcc does not define one, and there is no unsigned member
997/// of any of these pairs, because a signed type and its unsigned counterpart have the same
998/// width and `UINTMAX_WIDTH` is written `__INTMAX_WIDTH__` in every header that needs it.
999///
1000/// Each of these says how many value bits and sign bits the type has, which is not the same as
1001/// how many bits it occupies. They agree for every type on every target here, and the day one of
1002/// them does not, this is the family that has to say the smaller number.
1003fn widths(d: &mut Defs, target: &TargetInfo, wchar: &Wchar, wint: &Wint, fast16: u32, fast32: u32) {
1004 let pointer = target.pointer_width;
1005 d.set("__SCHAR_WIDTH__", "8");
1006 d.set("__SHRT_WIDTH__", "16");
1007 d.set("__INT_WIDTH__", "32");
1008 d.set("__LONG_WIDTH__", &target.long_width.to_string());
1009 d.set("__LONG_LONG_WIDTH__", "64");
1010 d.set("__INTMAX_WIDTH__", "64");
1011 d.set("__INTPTR_WIDTH__", &pointer.to_string());
1012 d.set("__PTRDIFF_WIDTH__", &pointer.to_string());
1013 d.set("__SIZE_WIDTH__", &pointer.to_string());
1014 d.set("__SIG_ATOMIC_WIDTH__", "32");
1015 d.set("__WCHAR_WIDTH__", &(wchar.size * 8).to_string());
1016 d.set("__WINT_WIDTH__", &wint.width.to_string());
1017 for width in [8, 16, 32, 64] {
1018 d.set(&format!("__INT_LEAST{width}_WIDTH__"), &width.to_string());
1019 }
1020 d.set("__INT_FAST8_WIDTH__", "8");
1021 d.set("__INT_FAST16_WIDTH__", &fast16.to_string());
1022 d.set("__INT_FAST32_WIDTH__", &fast32.to_string());
1023 d.set("__INT_FAST64_WIDTH__", "64");
1024}
1025
1026/// One width of the exact and least families, which are the same types.
1027fn exact(
1028 d: &mut Defs,
1029 width: u32,
1030 signed: &str,
1031 unsigned: &str,
1032 max: &str,
1033 umax: &str,
1034 // The suffix the width needs and nothing more, so `""`, `"L"` or `"LL"`. The `U` that
1035 // makes a constant unsigned is added below and is not part of this, because a caller that
1036 // wrote it here would produce `UU` on the unsigned macro and a stray `U` on the signed one.
1037 width_suffix: &str,
1038) {
1039 d.set(&format!("__INT{width}_TYPE__"), signed);
1040 d.set(&format!("__UINT{width}_TYPE__"), unsigned);
1041 d.set(&format!("__INT{width}_MAX__"), max);
1042 d.set(&format!("__UINT{width}_MAX__"), umax);
1043 d.set(&format!("__INT_LEAST{width}_TYPE__"), signed);
1044 d.set(&format!("__UINT_LEAST{width}_TYPE__"), unsigned);
1045 d.set(&format!("__INT_LEAST{width}_MAX__"), max);
1046 d.set(&format!("__UINT_LEAST{width}_MAX__"), umax);
1047 // The constant makers. `__INT8_C(1)` is `1` and not `1 ## `, because a paste with nothing
1048 // on the right is not a token the expander should have to think about.
1049 //
1050 // The `U` goes on only where the type is still unsigned after promotion. `uint8_t` and
1051 // `uint16_t` are narrower than `int`, so an integer promotion turns them into a signed
1052 // `int` and `UINT8_C(1)` has that type in gcc and in the standard's own words. Writing
1053 // `1U` there is not a harmless extra: `UINT8_C(1) - 2` comes out as four billion odd
1054 // instead of minus one, and a `_Generic` on it picks the unsigned arm. Every target this
1055 // compiler has makes `int` thirty two bits, which is what makes the width enough to decide.
1056 let unsigned_after_promotion = width >= 32;
1057 let u = if unsigned_after_promotion { "U" } else { "" };
1058 if width_suffix.is_empty() && u.is_empty() {
1059 d.set(&format!("__INT{width}_C(c)"), "c");
1060 d.set(&format!("__UINT{width}_C(c)"), "c");
1061 } else if width_suffix.is_empty() {
1062 d.set(&format!("__INT{width}_C(c)"), "c");
1063 d.set(&format!("__UINT{width}_C(c)"), &format!("c ## {u}"));
1064 } else {
1065 d.set(&format!("__INT{width}_C(c)"), &format!("c ## {width_suffix}"));
1066 d.set(&format!("__UINT{width}_C(c)"), &format!("c ## {u}{width_suffix}"));
1067 }
1068}
1069
1070/// What a header needs to know about one floating format, as the text the macros expand to.
1071///
1072/// The four values are written to the digit gcc writes them to rather than rounded to something
1073/// tidier, because a header carrying its own copy of a limit compares the two spellings and a
1074/// difference in the last place is a difference.
1075struct Characteristics {
1076 mant_dig: &'static str,
1077 dig: &'static str,
1078 min_exp: &'static str,
1079 min_10_exp: &'static str,
1080 max_exp: &'static str,
1081 max_10_exp: &'static str,
1082 decimal_dig: &'static str,
1083 max: &'static str,
1084 /// The largest value with a full significand, which is `max` for every format whose values
1085 /// all have one and is smaller for the double-double, whose largest values do not.
1086 ///
1087 /// A double-double's high half can be as large as a `double` gets while its low half is
1088 /// nowhere near, and the sum is then a number above anything the format can write with a
1089 /// hundred and six significand bits behind it. So `LDBL_MAX` on PowerPC is `DBL_MAX` and
1090 /// `LDBL_NORM_MAX` is a bit under half of it, and a program that reaches for the largest
1091 /// value it can compute with wants the second.
1092 norm_max: &'static str,
1093 min: &'static str,
1094 epsilon: &'static str,
1095 denorm_min: &'static str,
1096 /// Whether the format is one IEC 60559 describes, which every one of them is but the brain
1097 /// float, whose significand is a `float`'s with sixteen bits cut off the end of it, and the
1098 /// double-double, which is not a binary floating point format in IEC 60559's sense at all.
1099 is_iec_60559: &'static str,
1100}
1101
1102/// IEEE binary16, which is `_Float16`.
1103const HALF: Characteristics = Characteristics {
1104 mant_dig: "11",
1105 dig: "3",
1106 min_exp: "(-13)",
1107 min_10_exp: "(-4)",
1108 max_exp: "16",
1109 max_10_exp: "4",
1110 decimal_dig: "5",
1111 max: "6.55040000000000000000000000000000000e+4",
1112 norm_max: "6.55040000000000000000000000000000000e+4",
1113 min: "6.10351562500000000000000000000000000e-5",
1114 epsilon: "9.76562500000000000000000000000000000e-4",
1115 denorm_min: "5.96046447753906250000000000000000000e-8",
1116 is_iec_60559: "1",
1117};
1118
1119/// The brain float, which nothing here names yet and which every format table has a row for.
1120const BFLOAT16: Characteristics = Characteristics {
1121 mant_dig: "8",
1122 dig: "2",
1123 min_exp: "(-125)",
1124 min_10_exp: "(-37)",
1125 max_exp: "128",
1126 max_10_exp: "38",
1127 decimal_dig: "4",
1128 max: "3.38953138925153547590470800371487867e+38",
1129 norm_max: "3.38953138925153547590470800371487867e+38",
1130 min: "1.17549435082228750796873653722224568e-38",
1131 epsilon: "7.81250000000000000000000000000000000e-3",
1132 denorm_min: "9.18354961579912115600575419704879436e-41",
1133 is_iec_60559: "0",
1134};
1135
1136/// IEEE binary32, which is `float` and `_Float32`.
1137const SINGLE: Characteristics = Characteristics {
1138 mant_dig: "24",
1139 dig: "6",
1140 min_exp: "(-125)",
1141 min_10_exp: "(-37)",
1142 max_exp: "128",
1143 max_10_exp: "38",
1144 decimal_dig: "9",
1145 max: "3.40282346638528859811704183484516925e+38",
1146 norm_max: "3.40282346638528859811704183484516925e+38",
1147 min: "1.17549435082228750796873653722224568e-38",
1148 epsilon: "1.19209289550781250000000000000000000e-7",
1149 denorm_min: "1.40129846432481707092372958328991613e-45",
1150 is_iec_60559: "1",
1151};
1152
1153/// IEEE binary64, which is `double`, `_Float64`, `_Float32x` and `long double` on Apple and
1154/// on Windows.
1155const DOUBLE: Characteristics = Characteristics {
1156 mant_dig: "53",
1157 dig: "15",
1158 min_exp: "(-1021)",
1159 min_10_exp: "(-307)",
1160 max_exp: "1024",
1161 max_10_exp: "308",
1162 decimal_dig: "17",
1163 max: "1.79769313486231570814527423731704357e+308",
1164 norm_max: "1.79769313486231570814527423731704357e+308",
1165 min: "2.22507385850720138309023271733240406e-308",
1166 epsilon: "2.22044604925031308084726333618164062e-16",
1167 denorm_min: "4.94065645841246544176568792868221372e-324",
1168 is_iec_60559: "1",
1169};
1170
1171/// The x87 eighty bit format, which on x86-64 is both `long double` and `_Float64x`.
1172const X87: Characteristics = Characteristics {
1173 mant_dig: "64",
1174 dig: "18",
1175 min_exp: "(-16381)",
1176 min_10_exp: "(-4931)",
1177 max_exp: "16384",
1178 max_10_exp: "4932",
1179 decimal_dig: "21",
1180 max: "1.18973149535723176502126385303097021e+4932",
1181 norm_max: "1.18973149535723176502126385303097021e+4932",
1182 min: "3.36210314311209350626267781732175260e-4932",
1183 epsilon: "1.08420217248550443400745280086994171e-19",
1184 denorm_min: "3.64519953188247460252840593361941982e-4951",
1185 is_iec_60559: "1",
1186};
1187
1188/// IEEE binary128, which is `_Float128`, `_Float64x` off x86 and `long double` on AArch64 and
1189/// RISC-V Linux.
1190const QUAD: Characteristics = Characteristics {
1191 mant_dig: "113",
1192 dig: "33",
1193 min_exp: "(-16381)",
1194 min_10_exp: "(-4931)",
1195 max_exp: "16384",
1196 max_10_exp: "4932",
1197 decimal_dig: "36",
1198 max: "1.18973149535723176508575932662800702e+4932",
1199 norm_max: "1.18973149535723176508575932662800702e+4932",
1200 min: "3.36210314311209350626267781732175260e-4932",
1201 epsilon: "1.92592994438723585305597794258492732e-34",
1202 denorm_min: "6.47517511943802511092443895822764655e-4966",
1203 is_iec_60559: "1",
1204};
1205
1206/// IBM double-double, which is `long double` on 64-bit PowerPC.
1207///
1208/// The row that does not follow from a precision and an exponent range, because the format has
1209/// neither. `MANT_DIG` is 106 and `DIG` is 31, which are the figures near the top of the
1210/// significand and not everywhere. `MAX` is a little above `DBL_MAX`, since the high half can be
1211/// `DBL_MAX` and the low half then adds to it, and `NORM_MAX` is about half of that, so this is
1212/// the one row where the two are different numbers. `EPSILON` is the same number as `DENORM_MIN`,
1213/// two to the minus one thousand and seventy four, because the smallest value that changes a
1214/// double-double near one is a subnormal in the low half rather than one unit in the last place
1215/// of anything. `MIN` is two to the minus nine hundred and sixty nine rather than `DBL_MIN`,
1216/// because below that the low half has no room left to be normal in.
1217///
1218/// Every value here is what the reference compiler prints for `powerpc64le-linux-gnu`, checked
1219/// rather than derived, on the same terms as the data layouts in `rucc-abi`. The format is one
1220/// where deriving them is how the four wrong numbers in those layouts happened.
1221const DOUBLE_DOUBLE: Characteristics = Characteristics {
1222 mant_dig: "106",
1223 dig: "31",
1224 min_exp: "(-968)",
1225 min_10_exp: "(-291)",
1226 max_exp: "1024",
1227 max_10_exp: "308",
1228 decimal_dig: "33",
1229 max: "1.79769313486231580793728971405301e+308",
1230 norm_max: "8.98846567431157953864652595394501e+307",
1231 min: "2.00416836000897277799610805135016e-292",
1232 epsilon: "4.94065645841246544176568792868221e-324",
1233 denorm_min: "4.94065645841246544176568792868221e-324",
1234 is_iec_60559: "0",
1235};
1236
1237/// The row of the table a format has, so that a type the target chooses the format of can look
1238/// its own limits up rather than have them written out again per architecture.
1239const fn characteristics(format: Format) -> &'static Characteristics {
1240 match format {
1241 Format::Half => &HALF,
1242 Format::BFloat16 => &BFLOAT16,
1243 Format::Single => &SINGLE,
1244 Format::Double => &DOUBLE,
1245 Format::X87Extended => &X87,
1246 Format::Quad => &QUAD,
1247 Format::DoubleDouble => &DOUBLE_DOUBLE,
1248 }
1249}
1250
1251/// The `float.h` characteristics.
1252///
1253/// Nine families of them, which is `float`, `double` and `long double` and the six C23 named
1254/// them after. Two of the nine have a format the target decides: `long double`, which is x87 on
1255/// x86-64 Linux, quad on AArch64 and RISC-V Linux and a `double` on Apple and on Windows, and
1256/// `_Float64x`, which is the widest format the processor has and so does not follow `long
1257/// double` down on the targets that shrink it.
1258///
1259/// Three more have a target that decides whether they are there at all. `_Float64x` is missing
1260/// on a machine with nothing wider than a `double`, and `_Float16` and `_Float128` are missing
1261/// wherever the machine has no such format, which is four of the seven rows for the half and one
1262/// of them for the quad.
1263///
1264/// `__FLT128X_*__` is deliberately missing. `_Float128x` is a type no target gcc supports has,
1265/// so gcc defines nothing for it and neither does this.
1266fn floats(d: &mut Defs, target: &TargetInfo, opts: &Predef) {
1267 d.set("__FLT_RADIX__", "2");
1268 // Real arithmetic follows IEC 60559 in every format on every target here, which is what the
1269 // value two says. The complex one beside it says the same about complex arithmetic, and gcc
1270 // gives both the value two on every target this compiler has. These two are read rather than
1271 // tested: glibc's `<stdc-predef.h>` asks what the compiler intended and writes the
1272 // `__STDC_IEC_559` family from the answer, and a compiler that says nothing is presumed to
1273 // have meant yes. So the choice is not between claiming and not claiming, it is between
1274 // saying so and having it said for us. Zero for both once a fast math licence is given,
1275 // which is gcc's answer and what keeps glibc from claiming the family on our behalf.
1276 let iec = if opts.math.iec_559(opts.trapping_math) { "2" } else { "0" };
1277 d.set("__GCC_IEC_559", iec);
1278 d.set("__GCC_IEC_559_COMPLEX", iec);
1279 // Every operation is done in the type of its operands, which is what SSE2 and the AArch64
1280 // and RISC-V floating units all do. The other two names are the same answer asked under the
1281 // rules of C99 and of TS 18661-3, which are the same rules for a target with no excess
1282 // precision to have, and glibc's `<math.h>` reads the last of the three.
1283 d.set("__FLT_EVAL_METHOD__", "0");
1284 d.set("__FLT_EVAL_METHOD_C99__", "0");
1285 d.set("__FLT_EVAL_METHOD_TS_18661_3__", "0");
1286
1287 family(d, "FLT", &SINGLE, |value| format!("{value}F"));
1288 // gcc writes the `double` values as `long double` constants cast back down, which is exact
1289 // in every format `long double` has and is the one family whose values are not a suffix.
1290 family(d, "DBL", &DOUBLE, |value| format!("((double){value}L)"));
1291 family(d, "LDBL", characteristics(target.long_double_format), |value| format!("{value}L"));
1292
1293 // The two named types that are not on every machine, each written where the type is and left
1294 // out where it is not. A program reads `__FLT128_MANT_DIG__` to find out whether it may write
1295 // the type, which is what glibc's `<float.h>` and `<math.h>` do, so the macros and the type
1296 // have to agree or the header asks for something the compiler will refuse.
1297 if target.has_float16 {
1298 family(d, "FLT16", &HALF, |value| format!("{value}F16"));
1299 }
1300 family(d, "FLT32", &SINGLE, |value| format!("{value}F32"));
1301 family(d, "FLT64", &DOUBLE, |value| format!("{value}F64"));
1302 if target.has_float128 {
1303 family(d, "FLT128", &QUAD, |value| format!("{value}F128"));
1304 }
1305 family(d, "FLT32X", &DOUBLE, |value| format!("{value}F32x"));
1306 // Nothing at all on a target whose widest format is a `double`, which is what gcc does
1307 // there: `_Float64x` is not a type on that machine and the family that describes it is not a
1308 // set of macros with a smaller answer in them.
1309 if let Some(format) = target.float64x_format {
1310 family(d, "FLT64X", characteristics(format), |value| format!("{value}F64x"));
1311 }
1312
1313 // The number itself rather than the name of the other macro. The value is the same either
1314 // way, since `long double` is the widest format here, but the two are not the same thing to
1315 // read: `-dM` prints what the macro is, and a program that undefines `__LDBL_DECIMAL_DIG__`
1316 // takes this one with it. gcc writes the number.
1317 d.set("__DECIMAL_DIG__", characteristics(target.long_double_format).decimal_dig);
1318}
1319
1320/// One family of `float.h` macros, named `__{prefix}_*__`.
1321///
1322/// `write` turns a value into the constant its macro expands to, which is a suffix for every
1323/// family but `double`.
1324fn family(d: &mut Defs, prefix: &str, c: &Characteristics, write: impl Fn(&str) -> String) {
1325 d.set(&format!("__{prefix}_MANT_DIG__"), c.mant_dig);
1326 d.set(&format!("__{prefix}_DIG__"), c.dig);
1327 d.set(&format!("__{prefix}_MIN_EXP__"), c.min_exp);
1328 d.set(&format!("__{prefix}_MIN_10_EXP__"), c.min_10_exp);
1329 d.set(&format!("__{prefix}_MAX_EXP__"), c.max_exp);
1330 d.set(&format!("__{prefix}_MAX_10_EXP__"), c.max_10_exp);
1331 d.set(&format!("__{prefix}_DECIMAL_DIG__"), c.decimal_dig);
1332 d.set(&format!("__{prefix}_MAX__"), &write(c.max));
1333 d.set(&format!("__{prefix}_NORM_MAX__"), &write(c.norm_max));
1334 d.set(&format!("__{prefix}_MIN__"), &write(c.min));
1335 d.set(&format!("__{prefix}_EPSILON__"), &write(c.epsilon));
1336 d.set(&format!("__{prefix}_DENORM_MIN__"), &write(c.denorm_min));
1337 d.set(&format!("__{prefix}_IS_IEC_60559__"), c.is_iec_60559);
1338 d.set(&format!("__{prefix}_HAS_DENORM__"), "1");
1339 d.set(&format!("__{prefix}_HAS_INFINITY__"), "1");
1340 d.set(&format!("__{prefix}_HAS_QUIET_NAN__"), "1");
1341}
1342
1343#[cfg(test)]
1344mod tests {
1345 use rucc_target::Triple;
1346
1347 use super::*;
1348
1349 fn set_for(triple: &str) -> String {
1350 let triple: Triple = triple.parse().expect("a triple the compiler supports");
1351 built_in(&TargetInfo::new(triple), &Predef::new())
1352 }
1353
1354 /// The same, for a machine the three field triple cannot spell.
1355 fn set_for_tuple(tuple: &str) -> String {
1356 let target = TargetInfo::for_tuple(tuple.parse().expect("a row in the target table"));
1357 built_in(&target, &Predef::new())
1358 }
1359
1360 fn has(text: &str, line: &str) -> bool {
1361 text.lines().any(|l| l == line)
1362 }
1363
1364 #[test]
1365 fn the_version_macros_say_the_version_this_compiler_was_built_at() {
1366 // They said 0.1.0 through sixty seven releases, because the number was written here as
1367 // well as in the manifest, so a program asking which rucc it was is now told.
1368 let text = set_for("x86_64-unknown-linux-gnu");
1369 assert!(has(&text, &format!("#define __rucc_version__ \"{VERSION}\"")), "{text}");
1370 assert!(has(&text, &format!("#define __VERSION__ \"rucc {VERSION}\"")), "{text}");
1371 assert!(has(&text, &format!("#define __rucc_major__ {}", field(VERSION, 0))));
1372 assert!(has(&text, &format!("#define __rucc_minor__ {}", field(VERSION, 1))));
1373 assert!(has(&text, &format!("#define __rucc_patchlevel__ {}", field(VERSION, 2))));
1374
1375 // And what each of them expands to is something an `#if` can read, which is the whole
1376 // reason the three numbers are separate macros from the string.
1377 for n in 0..3 {
1378 assert!(field(VERSION, n).parse::<u32>().is_ok(), "{}", field(VERSION, n));
1379 }
1380 }
1381
1382 #[test]
1383 fn a_version_field_is_the_digits_at_the_front_of_it() {
1384 assert_eq!(
1385 (field("0.10.68", 0), field("0.10.68", 1), field("0.10.68", 2)),
1386 ("0", "10", "68")
1387 );
1388
1389 // A pre-release suffix belongs to the string and not to the number an `#if` compares, and
1390 // a field that is not there at all is what a two field version means by its third.
1391 assert_eq!(field("0.10.68-rc.1", 2), "68");
1392 assert_eq!(field("1.0", 2), "0");
1393 assert_eq!(field("", 0), "0");
1394 }
1395
1396 #[test]
1397 fn the_set_is_driven_by_the_target_rather_than_by_the_host() {
1398 let x86 = set_for("x86_64-unknown-linux-gnu");
1399 let arm = set_for("aarch64-unknown-linux-gnu");
1400 assert!(has(&x86, "#define __x86_64__ 1"));
1401 assert!(!has(&x86, "#define __aarch64__ 1"));
1402 assert!(has(&arm, "#define __aarch64__ 1"));
1403 assert!(!has(&arm, "#define __x86_64__ 1"));
1404 assert!(has(&x86, "#define __linux__ 1") && has(&arm, "#define __linux__ 1"));
1405 }
1406
1407 #[test]
1408 fn windows_is_the_target_that_makes_long_thirty_two_bits() {
1409 let windows = set_for("x86_64-pc-windows-msvc");
1410 let linux = set_for("x86_64-unknown-linux-gnu");
1411 assert!(has(&windows, "#define __SIZEOF_LONG__ 4"));
1412 assert!(has(&windows, "#define __SIZE_TYPE__ long long unsigned int"));
1413 assert!(has(&windows, "#define __INT64_TYPE__ long long int"));
1414 assert!(!has(&windows, "#define __LP64__ 1"));
1415 assert!(has(&linux, "#define __SIZEOF_LONG__ 8"));
1416 assert!(has(&linux, "#define __SIZE_TYPE__ long unsigned int"));
1417 assert!(has(&linux, "#define __INT64_TYPE__ long int"));
1418 assert!(has(&linux, "#define __LP64__ 1"));
1419 }
1420
1421 #[test]
1422 fn windows_spells_a_calling_convention_and_an_attribute_as_macros() {
1423 // The second declaration in mingw-w64's stdio.h is `int __cdecl __mingw_sscanf(...)`, so
1424 // a Windows target where these are missing reads no header at all.
1425 let windows = set_for("x86_64-pc-windows-gnu");
1426 assert!(has(&windows, "#define __cdecl __attribute__((__cdecl__))"));
1427 assert!(has(&windows, "#define __stdcall __attribute__((__stdcall__))"));
1428 assert!(has(&windows, "#define __fastcall __attribute__((__fastcall__))"));
1429 assert!(has(&windows, "#define __thiscall __attribute__((__thiscall__))"));
1430 assert!(has(&windows, "#define _cdecl __attribute__((__cdecl__))"));
1431 assert!(has(&windows, "#define __declspec(x) __attribute__((x))"));
1432 let linux = set_for("x86_64-unknown-linux-gnu");
1433 assert!(!has(&linux, "#define __cdecl __attribute__((__cdecl__))"));
1434 assert!(!has(&linux, "#define __declspec(x) __attribute__((x))"));
1435 }
1436
1437 #[test]
1438 fn a_strict_mode_keeps_the_spellings_that_are_not_the_implementations_to_take() {
1439 // `_cdecl` is a name a program may use and `__cdecl` is not, so gcc defines the first
1440 // only where the extensions are on and the second everywhere.
1441 let mut opts = Predef::new();
1442 opts.gnu_extensions = false;
1443 let triple: Triple = "x86_64-pc-windows-gnu".parse().expect("a triple");
1444 let strict = built_in(&TargetInfo::new(triple), &opts);
1445 assert!(has(&strict, "#define __cdecl __attribute__((__cdecl__))"));
1446 assert!(!has(&strict, "#define _cdecl __attribute__((__cdecl__))"));
1447 }
1448
1449 #[test]
1450 fn wchar_t_is_the_type_that_divides_the_targets() {
1451 // Signed on x86-64 Linux, unsigned on AArch64 Linux, and sixteen bits on Windows.
1452 assert!(has(&set_for("x86_64-unknown-linux-gnu"), "#define __WCHAR_TYPE__ int"));
1453 assert!(has(&set_for("aarch64-unknown-linux-gnu"), "#define __WCHAR_TYPE__ unsigned int"));
1454 let windows = set_for("x86_64-pc-windows-msvc");
1455 assert!(has(&windows, "#define __WCHAR_TYPE__ short unsigned int"));
1456 assert!(has(&windows, "#define __SIZEOF_WCHAR_T__ 2"));
1457 }
1458
1459 #[test]
1460 fn apple_spells_the_architecture_its_own_way_and_its_headers_only_know_that_spelling() {
1461 // sys/cdefs.h reaches #error "Unsupported architecture" without these, which is the
1462 // first line of the first header of every program on the platform.
1463 let darwin = set_for("aarch64-apple-darwin");
1464 assert!(has(&darwin, "#define __arm64__ 1"));
1465 assert!(has(&darwin, "#define __arm64 1"));
1466 assert!(has(&darwin, "#define __aarch64__ 1"), "the portable spelling stays too");
1467 let linux = set_for("aarch64-unknown-linux-gnu");
1468 assert!(!has(&linux, "#define __arm64__ 1"), "Apple's spelling is Apple's alone");
1469 assert!(!has(&set_for("x86_64-apple-darwin"), "#define __arm64__ 1"));
1470 }
1471
1472 #[test]
1473 fn every_limit_is_spelled_in_hexadecimal_the_way_gcc_spells_it() {
1474 // The value was never in question and the spelling is, because these macros reach a
1475 // program's text. glibc's `limits.h` writes `#define INT_MAX __INT_MAX__`, openssl
1476 // writes `((unsigned int)INT_MAX + 1)`, and `-E` over that header printed a decimal
1477 // number where gcc printed a hexadecimal one. The type is the same either way here,
1478 // which is why the suffixes are unchanged: `0x7fffffff` and `2147483647` are both
1479 // `int`, and `0xffffffffffffffffUL` and its decimal twin are both `unsigned long`.
1480 let linux = set_for("x86_64-unknown-linux-gnu");
1481 for line in [
1482 "#define __SCHAR_MAX__ 0x7f",
1483 "#define __SHRT_MAX__ 0x7fff",
1484 "#define __INT_MAX__ 0x7fffffff",
1485 "#define __LONG_MAX__ 0x7fffffffffffffffL",
1486 "#define __LONG_LONG_MAX__ 0x7fffffffffffffffLL",
1487 "#define __INTMAX_MAX__ 0x7fffffffffffffffL",
1488 "#define __UINTMAX_MAX__ 0xffffffffffffffffUL",
1489 "#define __SIZE_MAX__ 0xffffffffffffffffUL",
1490 "#define __PTRDIFF_MAX__ 0x7fffffffffffffffL",
1491 "#define __SIG_ATOMIC_MAX__ 0x7fffffff",
1492 "#define __INT8_MAX__ 0x7f",
1493 "#define __UINT8_MAX__ 0xff",
1494 "#define __INT16_MAX__ 0x7fff",
1495 "#define __UINT16_MAX__ 0xffff",
1496 "#define __INT32_MAX__ 0x7fffffff",
1497 "#define __UINT32_MAX__ 0xffffffffU",
1498 "#define __INT64_MAX__ 0x7fffffffffffffffL",
1499 "#define __UINT64_MAX__ 0xffffffffffffffffUL",
1500 "#define __INT_FAST8_MAX__ 0x7f",
1501 "#define __UINT_FAST8_MAX__ 0xff",
1502 ] {
1503 assert!(has(&linux, line), "{line}");
1504 }
1505 // Windows, where `long` is thirty two bits, so the wide suffix moves and the narrow
1506 // `long` limit is not the same number.
1507 let windows = set_for("x86_64-pc-windows-msvc");
1508 assert!(has(&windows, "#define __LONG_MAX__ 0x7fffffffL"));
1509 assert!(has(&windows, "#define __INTMAX_MAX__ 0x7fffffffffffffffLL"));
1510 assert!(has(&windows, "#define __UINTMAX_MAX__ 0xffffffffffffffffULL"));
1511 }
1512
1513 #[test]
1514 fn wint_t_does_not_follow_wchar_t() {
1515 // Apple makes it signed so that WEOF is negative the way EOF is. Linux does not.
1516 let darwin = set_for("aarch64-apple-darwin");
1517 assert!(has(&darwin, "#define __WINT_TYPE__ int"));
1518 assert!(has(&darwin, "#define __WINT_MAX__ 0x7fffffff"));
1519 assert!(has(&darwin, "#define __WCHAR_TYPE__ int"));
1520 let linux = set_for("aarch64-unknown-linux-gnu");
1521 assert!(has(&linux, "#define __WINT_TYPE__ unsigned int"));
1522 assert!(has(&linux, "#define __WINT_MAX__ 0xffffffffU"));
1523 assert!(has(&linux, "#define __WCHAR_TYPE__ unsigned int"), "and wchar_t is its own");
1524 assert!(has(
1525 &set_for("x86_64-pc-windows-msvc"),
1526 "#define __WINT_TYPE__ short unsigned int"
1527 ));
1528 }
1529
1530 #[test]
1531 fn the_widths_say_what_the_type_holds_and_follow_the_target_that_changes_it() {
1532 // Twenty of them, which is gcc's set: no exact width member, since the width of an
1533 // `int32_t` is in its name, and no unsigned member, since a header that wants
1534 // `UINTMAX_WIDTH` writes `__INTMAX_WIDTH__`.
1535 let linux = set_for("x86_64-unknown-linux-gnu");
1536 assert_eq!(linux.lines().filter(|line| line.contains("_WIDTH__")).count(), 20);
1537 assert!(has(&linux, "#define __LONG_WIDTH__ 64"));
1538 assert!(has(&linux, "#define __SIZE_WIDTH__ 64"));
1539 assert!(has(&linux, "#define __WCHAR_WIDTH__ 32"));
1540 assert!(has(&linux, "#define __INT_LEAST16_WIDTH__ 16"));
1541 // x86-64 glibc is where `int_fast16_t` is a `long`, and the width has to say so or a
1542 // program that switches on it picks the wrong branch.
1543 assert!(has(&linux, "#define __INT_FAST16_WIDTH__ 64"));
1544 assert!(has(&set_for("x86_64-unknown-linux-musl"), "#define __INT_FAST16_WIDTH__ 32"));
1545 // Windows has a thirty two bit `long` and a sixteen bit `wint_t`, and the pointer
1546 // sized types stay sixty four bits wide whatever `long` does.
1547 let windows = set_for("x86_64-pc-windows-msvc");
1548 assert!(has(&windows, "#define __LONG_WIDTH__ 32"));
1549 assert!(has(&windows, "#define __WINT_WIDTH__ 16"));
1550 assert!(has(&windows, "#define __SIZE_WIDTH__ 64"));
1551 assert!(has(&windows, "#define __INTMAX_WIDTH__ 64"));
1552 }
1553
1554 #[test]
1555 fn a_constant_maker_gets_the_suffix_its_width_needs_and_no_other() {
1556 // Found by diffing `-dM` against the system compiler. The 32 bit row was passing `U`
1557 // as its width suffix, which put a `U` on the signed macro and two on the unsigned
1558 // one, and `UINT32_C(1)` expanded to `1UU`, which is not a token.
1559 let linux = set_for("x86_64-unknown-linux-gnu");
1560 assert!(has(&linux, "#define __INT32_C(c) c"));
1561 assert!(has(&linux, "#define __UINT32_C(c) c ## U"));
1562 assert!(has(&linux, "#define __INT16_C(c) c"));
1563 // No `U` on the two narrow ones, because `uint8_t` and `uint16_t` promote to a
1564 // signed `int` and the constant has that type. gcc leaves it off for the same reason.
1565 assert!(has(&linux, "#define __UINT16_C(c) c"));
1566 assert!(has(&linux, "#define __UINT8_C(c) c"));
1567 // The wide ones do take a suffix, and the `U` goes in front of it.
1568 assert!(has(&linux, "#define __INT64_C(c) c ## L"));
1569 assert!(has(&linux, "#define __UINT64_C(c) c ## UL"));
1570 // Windows has a thirty two bit `long`, so its sixty four bit constants are `long long`.
1571 let windows = set_for("x86_64-pc-windows-msvc");
1572 assert!(has(&windows, "#define __INT64_C(c) c ## LL"));
1573 assert!(has(&windows, "#define __UINT64_C(c) c ## ULL"));
1574 }
1575
1576 #[test]
1577 fn the_symbol_prefix_is_defined_everywhere_including_where_it_is_empty() {
1578 // Empty is not the same as absent, because glibc stringifies it. Leaving it undefined
1579 // turns `__asm__ (__ASMNAME ("__xpg_strerror_r"))` into an asm name of
1580 // "__USER_LABEL_PREFIX__" "__xpg_strerror_r", which renames the function instead of
1581 // failing, and that is a bug found at link time or later.
1582 for triple in
1583 ["x86_64-unknown-linux-gnu", "aarch64-unknown-linux-gnu", "x86_64-pc-windows-msvc"]
1584 {
1585 assert!(has(&set_for(triple), "#define __USER_LABEL_PREFIX__ "), "{triple}");
1586 }
1587 // Mach-O keeps the underscore that ELF dropped.
1588 assert!(has(&set_for("aarch64-apple-darwin"), "#define __USER_LABEL_PREFIX__ _"));
1589 }
1590
1591 /// `-ffast-math` as gcc 16 spells it on x86-64 Linux: one macro per licence, the finite promise
1592 /// as a one, and the IEC 60559 family gone from both the compiler's lines and the ones glibc
1593 /// would write from `__GCC_IEC_559`.
1594 #[test]
1595 fn fast_math_defines_what_gcc_16_defines_for_it() {
1596 let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().expect("a triple"));
1597 let mut opts = Predef::new();
1598 opts.trapping_math = opts.math.set_fast(true);
1599 let fast = built_in(&target, &opts);
1600 for line in [
1601 "#define __FAST_MATH__ 1",
1602 "#define __FINITE_MATH_ONLY__ 1",
1603 "#define __NO_MATH_ERRNO__ 1",
1604 "#define __NO_TRAPPING_MATH__ 1",
1605 "#define __NO_SIGNED_ZEROS__ 1",
1606 "#define __RECIPROCAL_MATH__ 1",
1607 "#define __ASSOCIATIVE_MATH__ 1",
1608 "#define __GCC_IEC_559 0",
1609 "#define __GCC_IEC_559_COMPLEX 0",
1610 ] {
1611 assert!(has(&fast, line), "{line}");
1612 }
1613 for name in ["__STDC_IEC_559__", "__STDC_IEC_559_COMPLEX__", "__STDC_IEC_60559_BFP__"] {
1614 assert!(!fast.contains(&format!("#define {name} ")), "{name}");
1615 }
1616
1617 // `-ffast-math -ftrapping-math` keeps the members that do not need trapping off and
1618 // loses the name for the whole, and regrouping with it, which is gcc's answer.
1619 opts.trapping_math = true;
1620 let trapping = built_in(&target, &opts);
1621 assert!(has(&trapping, "#define __NO_MATH_ERRNO__ 1"));
1622 assert!(has(&trapping, "#define __GCC_IEC_559 0"));
1623 for name in ["__FAST_MATH__", "__NO_TRAPPING_MATH__", "__ASSOCIATIVE_MATH__"] {
1624 assert!(!trapping.contains(&format!("#define {name} ")), "{name}");
1625 }
1626
1627 // And none of it by default.
1628 let plain = built_in(&target, &Predef::new());
1629 for name in ["__FAST_MATH__", "__NO_MATH_ERRNO__", "__NO_TRAPPING_MATH__"] {
1630 assert!(!plain.contains(&format!("#define {name} ")), "{name}");
1631 }
1632 assert!(has(&plain, "#define __STDC_IEC_559__ 1"));
1633 }
1634
1635 /// The set gcc defines that headers read and that are true here. Written out one line at a
1636 /// time rather than counted, because the value is the whole point of each of them: a header
1637 /// asking `#if __FINITE_MATH_ONLY__` wants the number and not the existence.
1638 #[test]
1639 fn the_toolchain_macros_gcc_defines_are_defined_with_gccs_values() {
1640 let linux = set_for("x86_64-unknown-linux-gnu");
1641 for line in [
1642 "#define __GNUC_EXECUTION_CHARSET_NAME \"UTF-8\"",
1643 "#define __GNUC_WIDE_EXECUTION_CHARSET_NAME \"UTF-32LE\"",
1644 "#define __GXX_ABI_VERSION 1021",
1645 "#define __REGISTER_PREFIX__ ",
1646 "#define __FINITE_MATH_ONLY__ 0",
1647 "#define __GCC_IEC_559 2",
1648 "#define __GCC_IEC_559_COMPLEX 2",
1649 "#define __GCC_CONSTRUCTIVE_SIZE 64",
1650 "#define __GCC_DESTRUCTIVE_SIZE 64",
1651 "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_1 1",
1652 "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_2 1",
1653 "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_4 1",
1654 "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_8 1",
1655 "#define __ATOMIC_HLE_ACQUIRE 65536",
1656 "#define __ATOMIC_HLE_RELEASE 131072",
1657 "#define __FXSR__ 1",
1658 "#define __MMX_WITH_SSE__ 1",
1659 "#define __code_model_small__ 1",
1660 ] {
1661 assert!(has(&linux, line), "{line}");
1662 }
1663 // The five that are the processor's rather than the compiler's stay on the processor.
1664 let arm = set_for("aarch64-unknown-linux-gnu");
1665 for name in ["__ATOMIC_HLE_ACQUIRE", "__FXSR__", "__MMX_WITH_SSE__", "__code_model_small__"]
1666 {
1667 assert!(!arm.contains(name), "{name}");
1668 }
1669 assert!(has(&arm, "#define __GCC_HAVE_SYNC_COMPARE_AND_SWAP_8 1"));
1670 // A wide character is sixteen bits on Windows, so a wide string is UTF-16 there.
1671 let windows = set_for("x86_64-pc-windows-msvc");
1672 assert!(has(&windows, "#define __GNUC_WIDE_EXECUTION_CHARSET_NAME \"UTF-16LE\""));
1673 }
1674
1675 #[test]
1676 fn the_memory_orders_are_there_even_without_atomics() {
1677 // musl's stdatomic.h writes `memory_order_relaxed = __ATOMIC_RELAXED` with no test
1678 // around it, so these are not a promise about `_Atomic`, they are the numbering the
1679 // builtins take, and a compiler without them prints an enumerator whose value is an
1680 // identifier.
1681 let linux = set_for("x86_64-unknown-linux-gnu");
1682 assert!(has(&linux, "#define __ATOMIC_RELAXED 0"));
1683 assert!(has(&linux, "#define __ATOMIC_SEQ_CST 5"));
1684 assert!(has(&linux, "#define __STDC_NO_ATOMICS__ 1"), "and we still have no _Atomic");
1685 assert!(has(&linux, "#define __GCC_ATOMIC_INT_LOCK_FREE 2"));
1686 assert!(has(&linux, "#define __GCC_ATOMIC_LLONG_LOCK_FREE 2"));
1687 assert!(has(&set_for("x86_64-pc-windows-msvc"), "#define __GCC_ATOMIC_LLONG_LOCK_FREE 2"));
1688 }
1689
1690 #[test]
1691 fn long_double_is_three_types_and_the_macros_say_which() {
1692 assert!(has(&set_for("x86_64-unknown-linux-gnu"), "#define __LDBL_MANT_DIG__ 64"));
1693 assert!(has(&set_for("aarch64-unknown-linux-gnu"), "#define __LDBL_MANT_DIG__ 113"));
1694 assert!(has(&set_for("aarch64-apple-darwin"), "#define __LDBL_MANT_DIG__ 53"));
1695 }
1696
1697 #[test]
1698 fn the_size_of_float128_is_defined_where_gcc_has_the_name() {
1699 let line = "#define __SIZEOF_FLOAT128__ 16";
1700 assert!(has(&set_for("x86_64-unknown-linux-gnu"), line));
1701 assert!(has(&set_for_tuple("i686-linux-gnu"), line));
1702 let power = set_for_tuple("powerpc64le-linux-gnu");
1703 assert!(has(&power, line));
1704 assert!(has(&power, "#define __FLOAT128__ 1"));
1705 assert!(!set_for("x86_64-unknown-linux-gnu").contains("__FLOAT128__"));
1706 assert!(!set_for("aarch64-unknown-linux-gnu").contains("__SIZEOF_FLOAT128__"));
1707 }
1708
1709 #[test]
1710 fn the_extended_floating_types_have_the_limits_their_formats_have() {
1711 // Every one of these but `_Float64x` is the same format on every target, which is the
1712 // point of the interchange types, so the limits are the same everywhere too.
1713 let linux = set_for("x86_64-unknown-linux-gnu");
1714 assert!(has(&linux, "#define __FLT16_MANT_DIG__ 11"));
1715 assert!(has(&linux, "#define __FLT32_MANT_DIG__ 24"));
1716 assert!(has(&linux, "#define __FLT64_MANT_DIG__ 53"));
1717 assert!(has(&linux, "#define __FLT128_MANT_DIG__ 113"));
1718 assert!(has(&linux, "#define __FLT32X_MANT_DIG__ 53"));
1719 // Each family writes its values with its own suffix, so a header that assigns one to an
1720 // object of the type gets the type back rather than a conversion.
1721 assert!(has(&linux, "#define __FLT16_MAX__ 6.55040000000000000000000000000000000e+4F16"));
1722 assert!(has(
1723 &linux,
1724 "#define __FLT32X_MIN__ 2.22507385850720138309023271733240406e-308F32x"
1725 ));
1726 // `_Float128x` is a type no target has, so gcc defines nothing for it and neither
1727 // does this.
1728 assert!(!linux.contains("__FLT128X_"));
1729 }
1730
1731 #[test]
1732 fn the_family_for_a_named_type_is_written_where_the_type_is_and_nowhere_else() {
1733 // gcc 13's rows, measured with the cross compilers: the half is on x86-64, AArch64 and
1734 // RISC-V, and the quad is on every one of the seven but armv7. A program asks the macro
1735 // to find out whether it may write the type, so a row where the two disagree is a header
1736 // that asks for a type the compiler then refuses.
1737 let has_family = |target: &str, prefix: &str| {
1738 set_for_tuple(target).contains(&format!("#define __{prefix}_MANT_DIG__ "))
1739 };
1740 assert!(has_family("x86_64-linux-gnu", "FLT16"));
1741 assert!(has_family("aarch64-linux-gnu", "FLT16"));
1742 assert!(has_family("riscv64-linux-gnu", "FLT16"));
1743 assert!(!has_family("i686-linux-gnu", "FLT16"));
1744 assert!(!has_family("s390x-linux-gnu", "FLT16"));
1745 assert!(!has_family("armv7-linux-gnueabihf", "FLT16"));
1746
1747 assert!(has_family("i686-linux-gnu", "FLT128"));
1748 assert!(has_family("s390x-linux-gnu", "FLT128"));
1749 assert!(!has_family("armv7-linux-gnueabihf", "FLT128"));
1750
1751 // The families every machine has are still there on the machine that has least, and so
1752 // is `_Float64x` on the machines that have a format for it.
1753 let arm = set_for_tuple("armv7-linux-gnueabihf");
1754 for prefix in ["FLT", "DBL", "LDBL", "FLT32", "FLT64", "FLT32X"] {
1755 assert!(arm.contains(&format!("#define __{prefix}_MANT_DIG__ ")), "__{prefix}_");
1756 }
1757 assert!(!arm.contains("__FLT64X_"));
1758 }
1759
1760 #[test]
1761 fn float64x_keeps_the_width_that_long_double_loses_on_apple() {
1762 // The two are the same eighty bit x87 format on x86-64 and part company everywhere
1763 // else, because `_Float64x` follows the processor and `long double` follows the ABI.
1764 let linux = set_for("x86_64-unknown-linux-gnu");
1765 assert!(has(&linux, "#define __FLT64X_MANT_DIG__ 64"));
1766 assert!(has(&linux, "#define __LDBL_MANT_DIG__ 64"));
1767 let mac = set_for("aarch64-apple-darwin");
1768 assert!(has(&mac, "#define __FLT64X_MANT_DIG__ 113"));
1769 assert!(has(&mac, "#define __LDBL_MANT_DIG__ 53"));
1770 let windows = set_for("x86_64-pc-windows-msvc");
1771 assert!(has(&windows, "#define __FLT64X_MANT_DIG__ 64"));
1772 assert!(has(&windows, "#define __LDBL_MANT_DIG__ 53"));
1773 }
1774
1775 #[test]
1776 fn the_largest_value_of_an_ieee_format_is_also_its_largest_normal_one() {
1777 // `NORM_MAX` is only ever smaller than `MAX` for a format that holds values above its
1778 // largest normal one, and no IEEE encoding does. The double-double does, which is why
1779 // the two are separate fields now, and no target here has one.
1780 let linux = set_for("x86_64-unknown-linux-gnu");
1781 for prefix in ["FLT", "DBL", "LDBL", "FLT16", "FLT32", "FLT64", "FLT128", "FLT32X"] {
1782 let value = |suffix: &str| {
1783 let name = format!("#define __{prefix}_{suffix}__ ");
1784 let line = linux
1785 .lines()
1786 .find(|line| line.starts_with(&name))
1787 .unwrap_or_else(|| panic!("__{prefix}_{suffix}__ is defined"));
1788 line[name.len()..].to_owned()
1789 };
1790 assert_eq!(value("MAX"), value("NORM_MAX"), "__{prefix}_NORM_MAX__");
1791 }
1792 }
1793
1794 #[test]
1795 fn the_double_double_is_the_row_where_the_largest_value_is_not_the_largest_normal_one() {
1796 // No target here has a double-double `long double`, so this asks the row rather than the
1797 // macros. It is the reason `norm_max` is a field: a program that wants the largest value
1798 // it can still compute a full significand with wants `NORM_MAX`, and on PowerPC that is
1799 // a bit under half of `MAX`.
1800 let c = characteristics(Format::DoubleDouble);
1801 assert_ne!(c.max, c.norm_max);
1802 // `NORM_MAX` is two to the one thousand and twenty three, which is about half of `MAX`,
1803 // and `MAX` is a shade above `DBL_MAX` because the high half can be `DBL_MAX` and the low
1804 // half then adds to it. Both are what the reference prints.
1805 assert!(c.norm_max.starts_with("8.98846567431157953864652595394501e+307"));
1806 assert!(c.max.starts_with("1.7976931348623158"));
1807 // Epsilon is the odd one. The smallest value that changes a double-double near one is a
1808 // subnormal in the low half rather than one unit in the last place of anything, so it is
1809 // the same number as this format's own `DENORM_MIN`, which no other row can say.
1810 assert_eq!(c.epsilon, c.denorm_min);
1811 for format in [Format::Half, Format::Single, Format::Double, Format::X87Extended] {
1812 assert_ne!(characteristics(format).epsilon, characteristics(format).denorm_min);
1813 }
1814 // And it is not an IEC 60559 format, which only the brain float can also say.
1815 assert_eq!(c.is_iec_60559, "0");
1816 }
1817
1818 #[test]
1819 fn the_widest_bit_int_is_said_in_every_dialect() {
1820 // gcc defines it under `-std=c17` as well as `-std=c23`, and a header that reaches for
1821 // `_BitInt` tests the macro rather than the version, so an absent one reads as a
1822 // compiler without the type at all.
1823 let mut opts = Predef::new();
1824 let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1825 assert!(has(&built_in(&target, &opts), "#define __BITINT_MAXWIDTH__ 128"));
1826 opts.std = Std::C17;
1827 assert!(has(&built_in(&target, &opts), "#define __BITINT_MAXWIDTH__ 128"));
1828 }
1829
1830 #[test]
1831 fn char_signedness_is_recorded_only_when_it_is_unsigned() {
1832 // Which is how GCC does it: the macro exists to mark the unusual case.
1833 assert!(has(&set_for("aarch64-unknown-linux-gnu"), "#define __CHAR_UNSIGNED__ 1"));
1834 assert!(!has(&set_for("x86_64-unknown-linux-gnu"), "#define __CHAR_UNSIGNED__ 1"));
1835 }
1836
1837 #[test]
1838 fn the_dialect_decides_the_standard_macros() {
1839 let mut opts = Predef::new();
1840 let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1841 assert!(has(&built_in(&target, &opts), "#define __STDC_VERSION__ 202311L"));
1842 assert!(!has(&built_in(&target, &opts), "#define __STRICT_ANSI__ 1"));
1843 assert!(has(&built_in(&target, &opts), "#define linux 1"));
1844
1845 opts.gnu_extensions = false;
1846 assert!(has(&built_in(&target, &opts), "#define __STRICT_ANSI__ 1"));
1847 assert!(!has(&built_in(&target, &opts), "#define linux 1"), "not a reserved name");
1848
1849 opts.std = Std::C89;
1850 let c89 = built_in(&target, &opts);
1851 assert!(!c89.contains("__STDC_VERSION__"), "C89 does not define it at all");
1852 assert!(has(&c89, "#define __STDC__ 1"));
1853 }
1854
1855 /// The conditional feature macros are claims not to have something, and a claim that is
1856 /// not true changes what a header declares rather than turning anything off.
1857 #[test]
1858 fn the_only_things_claimed_missing_are_the_ones_that_are_missing() {
1859 let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1860 let opts = Predef::new();
1861 let set = built_in(&target, &opts);
1862 assert!(has(&set, "#define __STDC_NO_ATOMICS__ 1"), "there is no stdatomic.h to include");
1863 assert!(has(&set, "#define __STDC_NO_THREADS__ 1"), "nor a threads.h");
1864 assert!(has(&set, "#define __STDC_NO_COMPLEX__ 1"), "the arithmetic is not lowered");
1865 assert!(!set.contains("__STDC_NO_VLA__"), "variable length arrays work");
1866 }
1867
1868 /// gcc's own `stdatomic.h` declares `atomic_char8_t` under `#ifdef __CHAR8_TYPE__`, so a
1869 /// compiler that defines it in C17 declares a type gcc does not and one that never defines
1870 /// it is missing one in C23. Both were caught by preprocessing that header both ways.
1871 #[test]
1872 fn the_type_behind_char8_t_is_defined_in_c23_and_in_no_dialect_before_it() {
1873 let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1874 let mut opts = Predef::new();
1875 assert!(has(&built_in(&target, &opts), "#define __CHAR8_TYPE__ unsigned char"));
1876
1877 for older in [Std::C17, Std::C11, Std::C99, Std::C89] {
1878 opts.std = older;
1879 assert!(!built_in(&target, &opts).contains("__CHAR8_TYPE__"), "{older:?}");
1880 }
1881 }
1882
1883 /// glibc's `<stdc-predef.h>` is read before the first line of every translation unit and
1884 /// writes `#define __STDC_IEC_60559_BFP__ 201404L` whenever `__GCC_IEC_559` is positive.
1885 /// Any other value here is a redefinition with a different body, which is a warning the
1886 /// program did not ask for and which a configure script reads as a failed feature test.
1887 #[test]
1888 fn the_ieee_annex_macro_carries_the_value_glibcs_own_header_writes() {
1889 let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1890 let mut opts = Predef::new();
1891 for std in [Std::C23, Std::C17, Std::C11, Std::C99, Std::C89] {
1892 opts.std = std;
1893 let set = built_in(&target, &opts);
1894 assert!(has(&set, "#define __STDC_IEC_60559_BFP__ 201404L"), "{std:?}");
1895 assert!(has(&set, "#define __STDC_IEC_60559_COMPLEX__ 201404L"), "{std:?}");
1896 // The two the library reads to decide whether to write the four above itself.
1897 assert!(has(&set, "#define __GCC_IEC_559 2"), "{std:?}");
1898 assert!(has(&set, "#define __GCC_IEC_559_COMPLEX 2"), "{std:?}");
1899 }
1900 }
1901
1902 #[test]
1903 fn the_optimizer_level_is_visible_to_the_preprocessor() {
1904 let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1905 let mut opts = Predef::new();
1906 assert!(has(&built_in(&target, &opts), "#define __NO_INLINE__ 1"));
1907 assert!(!built_in(&target, &opts).contains("__OPTIMIZE__"));
1908
1909 opts.opt_level = OptLevel::O2;
1910 assert!(has(&built_in(&target, &opts), "#define __OPTIMIZE__ 1"));
1911 assert!(!built_in(&target, &opts).contains("__OPTIMIZE_SIZE__"));
1912
1913 opts.opt_level = OptLevel::Os;
1914 assert!(has(&built_in(&target, &opts), "#define __OPTIMIZE_SIZE__ 1"));
1915 }
1916
1917 #[test]
1918 fn a_command_line_define_with_no_value_is_one() {
1919 let mut opts = Predef::new();
1920 opts.defines = vec!["FOO".to_owned(), "BAR=2".to_owned(), "F(x)=x + 1".to_owned()];
1921 opts.undefines = vec!["__linux__".to_owned()];
1922 let text = command_line(&opts);
1923 assert!(has(&text, "#define FOO 1"));
1924 assert!(has(&text, "#define BAR 2"));
1925 assert!(has(&text, "#define F(x) x + 1"));
1926 // The undefine comes last, because `-U` beats `-D` whichever side of it it was on.
1927 assert!(text.trim_end().ends_with("#undef __linux__"));
1928 }
1929
1930 #[test]
1931 fn no_command_line_macros_is_no_file_at_all() {
1932 assert!(command_line(&Predef::new()).is_empty());
1933 }
1934
1935 #[test]
1936 fn a_date_is_spelled_the_way_the_standard_fixes() {
1937 // The epoch itself, and a day that needs the space padding the format asks for.
1938 let epoch = Timestamp::from_unix(0);
1939 assert_eq!(epoch.date, "Jan 1 1970");
1940 assert_eq!(epoch.time, "00:00:00");
1941 let leap = Timestamp::from_unix(1_709_164_800);
1942 assert_eq!(leap.date, "Feb 29 2024", "2024 is a leap year");
1943 let late = Timestamp::from_unix(1_735_689_599);
1944 assert_eq!(late.date, "Dec 31 2024");
1945 assert_eq!(late.time, "23:59:59");
1946 }
1947
1948 #[test]
1949 fn a_date_before_the_epoch_still_comes_out_right() {
1950 // Not because anyone compiles in 1969, but because the arithmetic that gets this
1951 // wrong is the same arithmetic that gets a time zone offset wrong.
1952 assert_eq!(Timestamp::from_unix(-1).date, "Dec 31 1969");
1953 assert_eq!(Timestamp::from_unix(-1).time, "23:59:59");
1954 }
1955
1956 #[test]
1957 fn the_gnuc_version_is_a_knob_rather_than_a_constant() {
1958 let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1959 let mut opts = Predef::new();
1960 assert!(has(&built_in(&target, &opts), "#define __GNUC__ 16"));
1961 opts.gnuc = GnucVersion { major: 15, minor: 1, patch: 0 };
1962 assert!(has(&built_in(&target, &opts), "#define __GNUC__ 15"));
1963 assert!(has(&built_in(&target, &opts), "#define __GNUC_MINOR__ 1"));
1964 }
1965
1966 /// Which of the two inline macros is defined, over the two things that decide it.
1967 ///
1968 /// Exactly one of them is defined at a time, which is what a header reads: glibc's
1969 /// `__extern_inline` writes `extern __inline` under one and adds `__gnu_inline__` under the
1970 /// other, so both being defined or neither being defined is a header taking a path it was
1971 /// never meant to take.
1972 #[test]
1973 fn one_of_the_two_inline_macros_is_defined_and_three_things_can_pick_which() {
1974 let target = TargetInfo::new("x86_64-unknown-linux-gnu".parse().unwrap());
1975 let gnu = "#define __GNUC_GNU_INLINE__ 1";
1976 let stdc = "#define __GNUC_STDC_INLINE__ 1";
1977
1978 let mut opts = Predef::new();
1979 assert!(has(&built_in(&target, &opts), stdc));
1980 assert!(!has(&built_in(&target, &opts), gnu));
1981
1982 opts.gnu89_inline = true;
1983 assert!(has(&built_in(&target, &opts), gnu));
1984 assert!(!has(&built_in(&target, &opts), stdc));
1985
1986 // The dialect on its own, which is where the older reading came from.
1987 let mut opts = Predef::new();
1988 opts.std = Std::C89;
1989 assert!(has(&built_in(&target, &opts), gnu));
1990 assert!(!has(&built_in(&target, &opts), stdc));
1991 }
1992
1993 #[test]
1994 fn a_darwin_target_says_its_deployment_target_as_the_sdk_reads_it() {
1995 let default = set_for("aarch64-apple-darwin");
1996 assert!(has(&default, "#define __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ 110000"));
1997 assert!(has(&default, "#define __ENVIRONMENT_OS_VERSION_MIN_REQUIRED__ 110000"));
1998 let pinned = set_for_tuple("aarch64-macos.13.4");
1999 assert!(has(&pinned, "#define __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ 130400"));
2000 assert!(has(&pinned, "#define __ENVIRONMENT_OS_VERSION_MIN_REQUIRED__ 130400"));
2001 let linux = set_for("aarch64-unknown-linux-gnu");
2002 assert!(!linux.contains("VERSION_MIN_REQUIRED"));
2003 }
2004
2005 #[test]
2006 fn apple_arm64_has_the_older_spellings_its_sdk_reads() {
2007 let darwin = set_for("aarch64-apple-darwin");
2008 for line in [
2009 "#define __ARM64_ARCH_8__ 1",
2010 "#define __ARM_NEON__ 1",
2011 "#define __AARCH64_SIMD__ 1",
2012 "#define __LITTLE_ENDIAN__ 1",
2013 ] {
2014 assert!(has(&darwin, line), "{line}");
2015 }
2016 // gcc defines none of them for Linux, and a header that tests `__LITTLE_ENDIAN__` there
2017 // is one written for clang that gcc users already build without it.
2018 let linux = set_for("aarch64-unknown-linux-gnu");
2019 assert!(!linux.contains("__ARM_NEON__"));
2020 assert!(!linux.contains("#define __LITTLE_ENDIAN__"));
2021 }
2022
2023 #[test]
2024 fn sixty_four_bit_glibc_makes_the_fast_types_long_on_every_processor() {
2025 // glibc's `stdint.h` picks `long` under `__WORDSIZE == 64` and never asks which
2026 // processor it is on, and gcc for aarch64, riscv64 and powerpc64le all agree.
2027 for triple in ["aarch64-unknown-linux-gnu", "riscv64-unknown-linux-gnu"] {
2028 let set = set_for(triple);
2029 assert!(has(&set, "#define __INT_FAST16_TYPE__ long int"), "{triple}");
2030 assert!(has(&set, "#define __UINT_FAST32_TYPE__ long unsigned int"), "{triple}");
2031 assert!(has(&set, "#define __INT_FAST32_WIDTH__ 64"), "{triple}");
2032 }
2033 assert!(has(&set_for("aarch64-unknown-linux-musl"), "#define __INT_FAST16_TYPE__ int"));
2034 // Apple's `stdint.h` makes the 16 bit one `int16_t` and the 32 bit one `int32_t`.
2035 let darwin = set_for("aarch64-apple-darwin");
2036 assert!(has(&darwin, "#define __INT_FAST16_TYPE__ short int"));
2037 assert!(has(&darwin, "#define __INT_FAST32_TYPE__ int"));
2038 }
2039
2040 #[test]
2041 fn armv8_a_says_what_the_base_architecture_has() {
2042 let arm = set_for("aarch64-unknown-linux-gnu");
2043 for line in [
2044 "#define __ARM_ARCH_ISA_A64 1",
2045 "#define __ARM_FEATURE_CLZ 1",
2046 "#define __ARM_FEATURE_IDIV 1",
2047 "#define __ARM_FEATURE_FMA 1",
2048 "#define __FP_FAST_FMA 1",
2049 "#define __GCC_DESTRUCTIVE_SIZE 256",
2050 ] {
2051 assert!(has(&arm, line), "{line}");
2052 }
2053 let x86 = set_for("x86_64-unknown-linux-gnu");
2054 assert!(!x86.contains("__ARM_FEATURE_CLZ"));
2055 assert!(!x86.contains("__FP_FAST_FMA"));
2056 assert!(has(&x86, "#define __GCC_DESTRUCTIVE_SIZE 64"));
2057 }
2058
2059 #[test]
2060 fn musl_and_glibc_disagree_about_the_fast_types_on_the_same_processor() {
2061 // The same x86-64 machine, two libcs, two answers. GCC built for glibc says `long int`
2062 // and GCC built for musl says `int`, because musl defines `int_fast16_t` as `int32_t`
2063 // everywhere. It shows in `stdatomic.h`, which GCC writes out of these macros, so
2064 // getting it wrong makes every atomic fast type the wrong width.
2065 let gnu = set_for("x86_64-unknown-linux-gnu");
2066 let musl = set_for("x86_64-unknown-linux-musl");
2067 assert!(has(&gnu, "#define __INT_FAST16_TYPE__ long int"));
2068 assert!(has(&gnu, "#define __INT_FAST32_TYPE__ long int"));
2069 assert!(has(&gnu, "#define __UINT_FAST16_TYPE__ long unsigned int"));
2070 assert!(has(&musl, "#define __INT_FAST16_TYPE__ int"));
2071 assert!(has(&musl, "#define __INT_FAST32_TYPE__ int"));
2072 assert!(has(&musl, "#define __UINT_FAST16_TYPE__ unsigned int"));
2073 // The limits have to move with the types or a header that checks them stops agreeing
2074 // with the header that uses them.
2075 assert!(has(&gnu, "#define __INT_FAST16_MAX__ 0x7fffffffffffffffL"));
2076 assert!(has(&musl, "#define __INT_FAST16_MAX__ 0x7fffffff"));
2077 assert!(has(&musl, "#define __UINT_FAST16_MAX__ 0xffffffffU"));
2078 }
2079
2080 #[test]
2081 fn the_libc_only_moves_the_two_fast_types_it_is_allowed_to_move() {
2082 // 8 and 64 are the same on both, and so is everything outside the fast family. A libc
2083 // is not a processor and this is the whole of what it is permitted to change here.
2084 let gnu = set_for("x86_64-unknown-linux-gnu");
2085 let musl = set_for("x86_64-unknown-linux-musl");
2086 for line in [
2087 "#define __INT_FAST8_TYPE__ signed char",
2088 "#define __INT_FAST64_TYPE__ long int",
2089 "#define __INT64_TYPE__ long int",
2090 "#define __SIZE_TYPE__ long unsigned int",
2091 "#define __SIZEOF_LONG__ 8",
2092 "#define __LP64__ 1",
2093 ] {
2094 assert!(has(&gnu, line), "glibc lost {line}");
2095 assert!(has(&musl, line), "musl lost {line}");
2096 }
2097 }
2098
2099 #[test]
2100 fn windows_is_the_one_target_where_the_two_middle_fast_types_differ_from_each_other() {
2101 // mingw's `stdint.h` declares `int_fast16_t` a `short` and `int_fast32_t` an `int`, and
2102 // x86_64-w64-mingw32-gcc says the same, so this is the one platform where the pair does
2103 // not share an answer.
2104 let windows = set_for("x86_64-pc-windows-gnu");
2105 assert!(has(&windows, "#define __INT_FAST16_TYPE__ short int"));
2106 assert!(has(&windows, "#define __UINT_FAST16_TYPE__ short unsigned int"));
2107 assert!(has(&windows, "#define __INT_FAST16_MAX__ 0x7fff"));
2108 assert!(has(&windows, "#define __UINT_FAST16_MAX__ 0xffff"));
2109 assert!(has(&windows, "#define __INT_FAST16_WIDTH__ 16"));
2110 assert!(has(&windows, "#define __INT_FAST32_TYPE__ int"));
2111 assert!(has(&windows, "#define __UINT_FAST32_TYPE__ unsigned int"));
2112 assert!(has(&windows, "#define __INT_FAST32_WIDTH__ 32"));
2113 // The two ends of the family are the same as everywhere.
2114 assert!(has(&windows, "#define __INT_FAST8_TYPE__ signed char"));
2115 assert!(has(&windows, "#define __INT_FAST64_TYPE__ long long int"));
2116 }
2117
2118 #[test]
2119 fn windows_answers_to_every_name_gcc_gives_it() {
2120 // The mingw tree reads more than one spelling of the platform and a missing one is a
2121 // declaration that quietly is not there: `winuser.h` guards `EndTask` with `#ifdef
2122 // WINNT` and `rpcdcep.h` guards six `I_Rpc` declarations with `#ifndef WINNT`.
2123 let windows = set_for("x86_64-pc-windows-gnu");
2124 let every = "_WIN32 __WIN32 __WIN32__ __WINNT __WINNT__ __MINGW32__ \
2125 _WIN64 __WIN64 __WIN64__ __MINGW64__ __MSVCRT__ __SEH__ WIN32 WIN64 WINNT";
2126 for name in every.split_whitespace() {
2127 assert!(has(&windows, &format!("#define {name} 1")), "no {name}");
2128 }
2129 assert!(has(&windows, "#define _INTEGRAL_MAX_BITS 64"));
2130 }
2131
2132 #[test]
2133 fn a_thirty_two_bit_windows_is_not_told_its_pointer_is_sixty_four_bits_wide() {
2134 // `_WIN64` is about the pointer rather than the processor, and i686-w64-mingw32-gcc
2135 // defines neither it nor `__MINGW64__`, nor `__SEH__`, since the unwind records this
2136 // compiler writes are the sixty four bit format and a thirty two bit Windows unwinds
2137 // some other way. The target is made by hand because the three field triple has no
2138 // 32-bit row yet, so `i686-windows-gnu` predefines nothing at all and there is no other
2139 // way to reach this arm.
2140 let mut target = TargetInfo::new("x86_64-pc-windows-gnu".parse().expect("a triple"));
2141 target.pointer_width = 32;
2142 let windows = built_in(&target, &Predef::new());
2143 assert!(has(&windows, "#define _WIN32 1"));
2144 assert!(has(&windows, "#define __MINGW32__ 1"));
2145 for name in ["_WIN64", "__WIN64", "__WIN64__", "__MINGW64__", "__SEH__", "WIN64"] {
2146 assert!(!has(&windows, &format!("#define {name} 1")), "{name} on a 32 bit target");
2147 }
2148 }
2149
2150 #[test]
2151 fn the_three_unreserved_windows_names_need_the_gnu_dialect() {
2152 // `WIN32`, `WIN64` and `WINNT` are in the user's namespace, so gcc drops all three under
2153 // `-std=c11` and keeps the underscored ones. Windows code tests them anyway, the same
2154 // way portable Unix code still tests `linux`.
2155 let triple: Triple = "x86_64-pc-windows-gnu".parse().expect("a triple");
2156 let mut opts = Predef::new();
2157 opts.gnu_extensions = false;
2158 let strict = built_in(&TargetInfo::new(triple), &opts);
2159 for name in ["WIN32", "WIN64", "WINNT"] {
2160 assert!(!has(&strict, &format!("#define {name} 1")), "{name} under -std=c11");
2161 }
2162 assert!(has(&strict, "#define _WIN32 1"));
2163 assert!(has(&strict, "#define __WINNT__ 1"));
2164 }
2165}