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