cprover
Loading...
Searching...
No Matches
gcc_mode.cpp
Go to the documentation of this file.
1/*******************************************************************\
2
3Module: GCC Mode
4
5Author: CM Wintersteiger, 2006
6
7\*******************************************************************/
8
11
12#include "gcc_mode.h"
13
14#ifdef _WIN32
15#define EX_OK 0
16#define EX_USAGE 64
17#define EX_SOFTWARE 70
18#else
19#include <sysexits.h>
20#endif
21
22#include <util/cmdline.h>
23#include <util/config.h>
24#include <util/file_util.h>
25#include <util/get_base_name.h>
26#include <util/invariant.h>
27#include <util/prefix.h>
28#include <util/run.h>
29#include <util/suffix.h>
30#include <util/tempdir.h>
31#include <util/version.h>
32
33#include "compile.h"
34#include "goto_cc_cmdline.h"
35#include "hybrid_binary.h"
36#include "linker_script_merge.h"
37
38#include <fstream> // IWYU pragma: keep
39#include <iostream>
40#include <numeric>
41
42static std::string compiler_name(
43 const cmdlinet &cmdline,
44 const std::string &base_name)
45{
46 if(cmdline.isset("native-compiler"))
47 return cmdline.get_value("native-compiler");
48
49 if(base_name=="bcc" ||
50 base_name.find("goto-bcc")!=std::string::npos)
51 return "bcc";
52
53 if(base_name=="goto-clang")
54 return "clang";
55
56 std::string::size_type pos=base_name.find("goto-gcc");
57
58 if(pos==std::string::npos ||
59 base_name=="goto-gcc" ||
60 base_name=="goto-ld")
61 {
62 #ifdef __FreeBSD__
63 return "clang";
64 #else
65 return "gcc";
66 #endif
67 }
68
69 std::string result=base_name;
70 result.replace(pos, 8, "gcc");
71
72 return result;
73}
74
75static std::string linker_name(
76 const cmdlinet &cmdline,
77 const std::string &base_name)
78{
79 if(cmdline.isset("native-linker"))
80 return cmdline.get_value("native-linker");
81
82 std::string::size_type pos=base_name.find("goto-ld");
83
84 if(pos==std::string::npos ||
85 base_name=="goto-gcc" ||
86 base_name=="goto-ld")
87 return "ld";
88
89 std::string result=base_name;
90 result.replace(pos, 7, "ld");
91
92 return result;
93}
94
97 const std::string &_base_name,
99 goto_cc_modet(_cmdline, _base_name, gcc_message_handler),
100 produce_hybrid_binary(_produce_hybrid_binary),
101 goto_binary_tmp_suffix(".goto-cc-saved"),
102
103 // Keys are architectures specified in configt::set_arch().
104 // Values are lists of GCC architectures that can be supplied as
105 // arguments to the -march, -mcpu, and -mtune flags (see the GCC
106 // manual https://gcc.gnu.org/onlinedocs/).
107 arch_map(
108 {
109 // ARM information taken from the following:
110 //
111 // the "ARM core timeline" table on this page:
112 // https://en.wikipedia.org/wiki/List_of_ARM_microarchitectures
113 //
114 // articles on particular core groups, e.g.
115 // https://en.wikipedia.org/wiki/ARM9
116 //
117 // The "Cores" table on this page:
118 // https://en.wikipedia.org/wiki/ARM_architecture
119 // NOLINTNEXTLINE(whitespace/braces)
120 {"arm", {
121 "strongarm", "strongarm110", "strongarm1100", "strongarm1110",
122 "arm2", "arm250", "arm3", "arm6", "arm60", "arm600", "arm610",
123 "arm620", "fa526", "fa626", "fa606te", "fa626te", "fmp626",
124 "xscale", "iwmmxt", "iwmmxt2", "xgene1"
125 }}, // NOLINTNEXTLINE(whitespace/braces)
126 {"armhf", {
127 "armv7", "arm7m", "arm7d", "arm7dm", "arm7di", "arm7dmi",
128 "arm70", "arm700", "arm700i", "arm710", "arm710c", "arm7100",
129 "arm720", "arm7500", "arm7500fe", "arm7tdmi", "arm7tdmi-s",
130 "arm710t", "arm720t", "arm740t", "mpcore", "mpcorenovfp",
131 "arm8", "arm810", "arm9", "arm9e", "arm920", "arm920t",
132 "arm922t", "arm946e-s", "arm966e-s", "arm968e-s", "arm926ej-s",
133 "arm940t", "arm9tdmi", "arm10tdmi", "arm1020t", "arm1026ej-s",
134 "arm10e", "arm1020e", "arm1022e", "arm1136j-s", "arm1136jf-s",
135 "arm1156t2-s", "arm1156t2f-s", "arm1176jz-s", "arm1176jzf-s",
136 "cortex-a5", "cortex-a7", "cortex-a8", "cortex-a9",
137 "cortex-a12", "cortex-a15", "cortex-a53", "cortex-r4",
138 "cortex-r4f", "cortex-r5", "cortex-r7", "cortex-m7",
139 "cortex-m4", "cortex-m3", "cortex-m1", "cortex-m0",
140 "cortex-m0plus", "cortex-m1.small-multiply",
141 "cortex-m0.small-multiply", "cortex-m0plus.small-multiply",
142 "marvell-pj4", "ep9312", "fa726te",
143 }}, // NOLINTNEXTLINE(whitespace/braces)
144 {"arm64", {
145 "cortex-a57", "cortex-a72", "exynos-m1"
146 }}, // NOLINTNEXTLINE(whitespace/braces)
147 {"hppa", {"1.0", "1.1", "2.0"}}, // NOLINTNEXTLINE(whitespace/braces)
148 // PowerPC
149 // https://en.wikipedia.org/wiki/List_of_PowerPC_processors
150 // NOLINTNEXTLINE(whitespace/braces)
151 {"powerpc", {
152 "powerpc", "601", "602", "603", "603e", "604", "604e", "630",
153 // PowerPC G3 == 7xx series
154 "G3", "740", "750",
155 // PowerPC G4 == 74xx series
156 "G4", "7400", "7450",
157 // SoC and low power: https://en.wikipedia.org/wiki/PowerPC_400
158 "401", "403", "405", "405fp", "440", "440fp", "464", "464fp",
159 "476", "476fp",
160 // e series. x00 are 32-bit, x50 are 64-bit. See e.g.
161 // https://en.wikipedia.org/wiki/PowerPC_e6500
162 "e300c2", "e300c3", "e500mc", "ec603e",
163 // https://en.wikipedia.org/wiki/Titan_(microprocessor)
164 "titan",
165 }},
166 // NOLINTNEXTLINE(whitespace/braces)
167 {"powerpc64", {
168 "powerpc64",
169 // First IBM 64-bit processor
170 "620",
171 "970", "G5"
172 // All IBM POWER processors are 64 bit, but POWER 8 is
173 // little-endian so not in this list.
174 // https://en.wikipedia.org/wiki/Ppc64
175 "power3", "power4", "power5", "power5+", "power6", "power6x",
176 "power7", "rs64",
177 // e series SoC chips. x00 are 32-bit, x50 are 64-bit. See e.g.
178 // https://en.wikipedia.org/wiki/PowerPC_e6500
179 "e500mc64", "e5500", "e6500",
180 // https://en.wikipedia.org/wiki/IBM_A2
181 "a2",
182 }},
183 // The latest Power processors are little endian.
184 {"powerpc64le", {"powerpc64le", "power8"}},
185 // There are two MIPS architecture series. The 'old' one comprises
186 // MIPS I - MIPS V (where MIPS I and MIPS II are 32-bit
187 // architectures, and the III, IV and V are 64-bit). The 'new'
188 // architecture series comprises MIPS32 and MIPS64. Source: [0].
189 //
190 // CPROVER's names for these are in configt::this_architecture(),
191 // in particular note the preprocessor variable names. MIPS
192 // processors can run in little-endian or big-endian mode; [1]
193 // gives more information on particular processors. Particular
194 // processors and their architectures are at [2]. This means that
195 // we cannot use the processor flags alone to decide which CPROVER
196 // name to use; we also need to check for the -EB or -EL flags to
197 // decide whether little- or big-endian code should be generated.
198 // Therefore, the keys in this part of the map don't directly map
199 // to CPROVER architectures.
200 //
201 // [0] https://en.wikipedia.org/wiki/MIPS_architecture
202 // [1] https://www.debian.org/ports/mips/
203 // [2] https://en.wikipedia.org/wiki/List_of_MIPS_architecture_processors
204 // NOLINTNEXTLINE(whitespace/braces)
205 {"mips64n", {
206 "loongson2e", "loongson2f", "loongson3a", "mips64", "mips64r2",
207 "mips64r3", "mips64r5", "mips64r6 4kc", "5kc", "5kf", "20kc",
208 "octeon", "octeon+", "octeon2", "octeon3", "sb1", "vr4100",
209 "vr4111", "vr4120", "vr4130", "vr4300", "vr5000", "vr5400",
210 "vr5500", "sr71000", "xlp",
211 }}, // NOLINTNEXTLINE(whitespace/braces)
212 {"mips32n", {
213 "mips32", "mips32r2", "mips32r3", "mips32r5", "mips32r6",
214 // https://www.imgtec.com/mips/classic/
215 "4km", "4kp", "4ksc", "4kec", "4kem", "4kep", "4ksd", "24kc",
216 "24kf2_1", "24kf1_1", "24kec", "24kef2_1", "24kef1_1", "34kc",
217 "34kf2_1", "34kf1_1", "34kn", "74kc", "74kf2_1", "74kf1_1",
218 "74kf3_2", "1004kc", "1004kf2_1", "1004kf1_1", "m4k", "m14k",
219 "m14kc", "m14ke", "m14kec",
220 // https://en.wikipedia.org/wiki/List_of_MIPS_architecture_processors
221 "p5600", "xlr",
222 }}, // NOLINTNEXTLINE(whitespace/braces)
223 {"mips32o", {
224 "mips1", "mips2", "r2000", "r3000",
225 "r6000", // Not a mistake, r4000 came out _after_ this
226 }}, // NOLINTNEXTLINE(whitespace/braces)
227 {"mips64o", {
228 "mips3", "mips4", "r4000", "r4400", "r4600", "r4650", "r4700",
229 "r8000", "rm7000", "rm9000", "r10000", "r12000", "r14000",
230 "r16000",
231 }},
232 // These are IBM mainframes. s390 is 32-bit; s390x is 64-bit [0].
233 // Search that page for s390x and note that 32-bit refers to
234 // everything "prior to 2000's z900 model". The list of model
235 // numbers is at [1].
236 // [0] https://en.wikipedia.org/wiki/Linux_on_z_Systems
237 // [1] https://en.wikipedia.org/wiki/IBM_System_z
238 // NOLINTNEXTLINE(whitespace/braces)
239 {"s390", {
240 "z900", "z990", "g5", "g6",
241 }}, // NOLINTNEXTLINE(whitespace/braces)
242 {"s390x", {
243 "z9-109", "z9-ec", "z10", "z196", "zEC12", "z13"
244 }},
245 // SPARC
246 // In the "Implementations" table of [0], everything with an arch
247 // version up to V8 is 32-bit. V9 and onward are 64-bit.
248 // [0] https://en.wikipedia.org/wiki/SPARC
249 // NOLINTNEXTLINE(whitespace/braces)
250 {"sparc", {
251 "v7", "v8", "leon", "leon3", "leon3v7", "cypress", "supersparc",
252 "hypersparc", "sparclite", "f930", "f934", "sparclite86x",
253 "tsc701",
254 }}, // NOLINTNEXTLINE(whitespace/braces)
255 {"sparc64", {
256 "v9", "ultrasparc", "ultrasparc3", "niagara", "niagara2",
257 "niagara3", "niagara4",
258 }}, // NOLINTNEXTLINE(whitespace/braces)
259 {"ia64", {
260 "itanium", "itanium1", "merced", "itanium2", "mckinley"
261 }}, // NOLINTNEXTLINE(whitespace/braces)
262 // x86 and x86_64. See
263 // https://en.wikipedia.org/wiki/List_of_AMD_microprocessors
264 // https://en.wikipedia.org/wiki/List_of_Intel_microprocessors
265 {"i386", {
266 // Intel generic
267 "i386", "i486", "i586", "i686",
268 // AMD
269 "k6", "k6-2", "k6-3", "athlon" "athlon-tbird", "athlon-4",
270 "athlon-xp", "athlon-mp",
271 // Everything called "pentium" by GCC is 32 bits; the only 64-bit
272 // Pentium flag recognized by GCC is "nocona".
273 "pentium", "pentium-mmx", "pentiumpro" "pentium2", "pentium3",
274 "pentium3m", "pentium-m" "pentium4", "pentium4m", "prescott",
275 // Misc
276 "winchip-c6", "winchip2", "c3", "c3-2", "geode",
277 }}, // NOLINTNEXTLINE(whitespace/braces)
278 {"x86_64", {
279 // Intel
280 "nocona", "core2", "nehalem" "westmere", "sandybridge", "knl",
281 "ivybridge", "haswell", "broadwell" "bonnell", "silvermont",
282 // AMD generic
283 "k8", "k8-sse3", "opteron", "athlon64", "athlon-fx",
284 "opteron-sse3" "athlon64-sse3", "amdfam10", "barcelona",
285 // AMD "bulldozer" (high power, family 15h)
286 "bdver1", "bdver2" "bdver3", "bdver4",
287 // AMD "bobcat" (low power, family 14h)
288 "btver1", "btver2",
289 }},
290 })
291{
292}
293
294bool gcc_modet::needs_preprocessing(const std::string &file)
295{
296 if(has_suffix(file, ".c") ||
297 has_suffix(file, ".cc") ||
298 has_suffix(file, ".cp") ||
299 has_suffix(file, ".cpp") ||
300 has_suffix(file, ".CPP") ||
301 has_suffix(file, ".c++") ||
302 has_suffix(file, ".C"))
303 return true;
304 else
305 return false;
306}
307
310{
313
314 auto default_verbosity = (cmdline.isset("Wall") || cmdline.isset("Wextra")) ?
318
319 bool act_as_bcc=
320 base_name=="bcc" ||
321 base_name.find("goto-bcc")!=std::string::npos;
322
323 // if we are gcc or bcc, then get the version number
325
326 if((cmdline.isset('v') && cmdline.have_infile_arg()) ||
327 (cmdline.isset("version") && !produce_hybrid_binary))
328 {
329 // "-v" a) prints the version and b) increases verbosity.
330 // Compilation continues, don't exit!
331
332 if(act_as_bcc)
333 std::cout << "bcc: version " << gcc_version << " (goto-cc "
334 << CBMC_VERSION << ")\n";
335 else
336 {
338 std::cout << "clang version " << gcc_version << " (goto-cc "
339 << CBMC_VERSION << ")\n";
340 else
341 std::cout << "gcc (goto-cc " << CBMC_VERSION << ") " << gcc_version
342 << '\n';
343 }
344 }
345
348 cmdline.isset("Werror") &&
349 !cmdline.isset("Wno-error"));
350
351 if(cmdline.isset("version"))
352 {
354 return run_gcc(compiler);
355
356 std::cout
357 << '\n'
358 << "Copyright (C) 2006-2018 Daniel Kroening, Christoph Wintersteiger\n"
359 << "CBMC version: " << CBMC_VERSION << '\n'
360 << "Architecture: " << config.this_architecture() << '\n'
361 << "OS: " << config.this_operating_system() << '\n';
362
364 std::cout << "clang: " << gcc_version << '\n';
365 else
366 std::cout << "gcc: " << gcc_version << '\n';
367
368 return EX_OK; // Exit!
369 }
370
371 // In hybrid mode, when --help is requested, just reproduce the output of the
372 // original compiler. This is so as not to confuse configure scripts that
373 // depend on particular information (such as the list of supported targets).
374 if(cmdline.isset("help") && produce_hybrid_binary)
375 {
376 help();
377 return run_gcc(compiler);
378 }
379 else if(cmdline.isset('?') || cmdline.isset("help"))
380 {
381 help();
382 return EX_OK;
383 }
384
385 if(
386 cmdline.isset("dumpmachine") || cmdline.isset("dumpspecs") ||
387 cmdline.isset("dumpversion") || cmdline.isset("print-sysroot") ||
388 cmdline.isset("print-sysroot-headers-suffix"))
389 {
391 return run_gcc(compiler);
392
393 // GCC will only print one of these, even when multiple arguments are
394 // passed, so we do the same
395 if(cmdline.isset("dumpmachine"))
396 std::cout << config.this_architecture() << '\n';
397 else if(cmdline.isset("dumpversion"))
398 std::cout << gcc_version << '\n';
399
400 // we don't have any meaningful output for the other options, and GCC
401 // doesn't necessarily produce non-empty output either
402
403 return EX_OK;
404 }
405
407
408 if(act_as_bcc)
409 {
411 log.debug() << "BCC mode (hybrid)" << messaget::eom;
412 else
413 log.debug() << "BCC mode" << messaget::eom;
414 }
415 else
416 {
418 log.debug() << "GCC mode (hybrid)" << messaget::eom;
419 else
420 log.debug() << "GCC mode" << messaget::eom;
421 }
422
423 // model validation
424 compiler.validate_goto_model = cmdline.isset("validate-goto-model");
425
426 // determine actions to be undertaken
427 if(cmdline.isset('S'))
429 else if(cmdline.isset('c'))
431 else if(cmdline.isset('E'))
433 else if(cmdline.isset("shared") ||
434 cmdline.isset('r')) // really not well documented
436 else
438
439 // In gcc mode, we have just pass on to gcc to handle the following:
440 // * if -M or -MM is given, we do dependencies only
441 // * preprocessing (-E)
442 // * no input files given
443
444 if(cmdline.isset('M') ||
445 cmdline.isset("MM") ||
446 cmdline.isset('E') ||
448 return run_gcc(compiler); // exit!
449
450 // get configuration
452
453 // Intel-specific
454 // in GCC, m16 is 32-bit (!), as documented here:
455 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=59672
456 if(cmdline.isset("m16") ||
457 cmdline.isset("m32") || cmdline.isset("mx32"))
458 {
459 config.ansi_c.arch="i386";
460 config.ansi_c.set_arch_spec_i386();
461 }
462 else if(cmdline.isset("m64"))
463 {
464 config.ansi_c.arch="x86_64";
465 config.ansi_c.set_arch_spec_x86_64();
466 }
467
468 // ARM-specific
469 if(cmdline.isset("mbig-endian") || cmdline.isset("mbig"))
471 else if(cmdline.isset("little-endian") || cmdline.isset("mlittle"))
473
474 if(cmdline.isset("mthumb") || cmdline.isset("mthumb-interwork"))
475 config.ansi_c.set_arch_spec_arm("armhf");
476
477 // -mcpu sets both the arch and tune, but should only be used if
478 // neither -march nor -mtune are passed on the command line.
479 std::string target_cpu=
480 cmdline.isset("march") ? cmdline.get_value("march") :
481 cmdline.isset("mtune") ? cmdline.get_value("mtune") :
482 cmdline.isset("mcpu") ? cmdline.get_value("mcpu") : "";
483
484 if(!target_cpu.empty())
485 {
486 // Work out what CPROVER architecture we should target.
487 for(auto &pair : arch_map)
488 for(auto &processor : pair.second)
490 {
491 if(pair.first.find("mips")==std::string::npos)
492 config.set_arch(pair.first);
493 else
494 {
495 // Targeting a MIPS processor. MIPS is special; we also need
496 // to know the endianness. -EB (big-endian) is the default.
497 if(cmdline.isset("EL"))
498 {
499 if(pair.first=="mips32o")
500 config.set_arch("mipsel");
501 else if(pair.first=="mips32n")
502 config.set_arch("mipsn32el");
503 else
504 config.set_arch("mips64el");
505 }
506 else
507 {
508 if(pair.first=="mips32o")
509 config.set_arch("mips");
510 else if(pair.first=="mips32n")
511 config.set_arch("mipsn32");
512 else
513 config.set_arch("mips64");
514 }
515 }
516 }
517 }
518
519 // clang supports -target <arch-quadruple> and --target=<arch-quadruple>
520 if(cmdline.isset("target"))
521 {
522 // list of targets supported by LLVM 10.0, found using llc --version
523 static const std::map<std::string, std::string> target_map = {
524 {"aarch64", "arm64" /* AArch64 (little endian) */},
525 {"aarch64_32", "arm" /* AArch64 (little endian ILP32) */},
526 {"aarch64_be", "none" /* AArch64 (big endian) */},
527 {"amdgcn", "none" /* AMD GCN GPUs */},
528 {"arm", "arm" /* ARM */},
529 {"arm64", "arm64" /* ARM64 (little endian) */},
530 {"arm64_32", "arm" /* ARM64 (little endian ILP32) */},
531 {"armeb", "none" /* ARM (big endian) */},
532 {"avr", "none" /* Atmel AVR Microcontroller */},
533 {"bpf", "none" /* BPF (host endian) */},
534 {"bpfeb", "none" /* BPF (big endian) */},
535 {"bpfel", "none" /* BPF (little endian) */},
536 {"hexagon", "none" /* Hexagon */},
537 {"i386", "i386" /* (not in llc's list: 32-bit x86) */},
538 {"lanai", "none" /* Lanai */},
539 {"mips", "mips" /* MIPS (32-bit big endian) */},
540 {"mips64", "mips64" /* MIPS (64-bit big endian) */},
541 {"mips64el", "mips64el" /* MIPS (64-bit little endian) */},
542 {"mipsel", "mipsel" /* MIPS (32-bit little endian) */},
543 {"msp430", "none" /* MSP430 [experimental] */},
544 {"nvptx", "none" /* NVIDIA PTX 32-bit */},
545 {"nvptx64", "none" /* NVIDIA PTX 64-bit */},
546 {"ppc32", "powerpc" /* PowerPC 32 */},
547 {"ppc64", "ppc64" /* PowerPC 64 */},
548 {"ppc64le", "ppc64le" /* PowerPC 64 LE */},
549 {"r600", "none" /* AMD GPUs HD2XXX-HD6XXX */},
550 {"riscv32", "none" /* 32-bit RISC-V */},
551 {"riscv64", "riscv64" /* 64-bit RISC-V */},
552 {"sparc", "sparc" /* Sparc */},
553 {"sparcel", "none" /* Sparc LE */},
554 {"sparcv9", "sparc64" /* Sparc V9 */},
555 {"systemz", "none" /* SystemZ */},
556 {"thumb", "armhf" /* Thumb */},
557 {"thumbeb", "none" /* Thumb (big endian) */},
558 {"wasm32", "none" /* WebAssembly 32-bit */},
559 {"wasm64", "none" /* WebAssembly 64-bit */},
560 {"x86", "i386" /* 32-bit X86: Pentium-Pro and above */},
561 {"x86_64", "x86_64" /* 64-bit X86: EM64T and AMD64 */},
562 {"xcore", "none" /* XCore */},
563 };
564 std::string arch_quadruple = cmdline.get_value("target");
565 auto it =
566 target_map.find(arch_quadruple.substr(0, arch_quadruple.find('-')));
567 if(it == target_map.end())
568 config.set_arch("none");
569 else
570 config.set_arch(it->second);
571 }
572
573 // -fshort-wchar makes wchar_t "short unsigned int"
574 if(cmdline.isset("fshort-wchar"))
575 {
576 config.ansi_c.wchar_t_width=config.ansi_c.short_int_width;
577 config.ansi_c.wchar_t_is_unsigned=true;
578 }
579
580 // -fsingle-precision-constant makes floating-point constants "float"
581 // instead of double
582 if(cmdline.isset("-fsingle-precision-constant"))
583 config.ansi_c.single_precision_constant=true;
584
585 // -fshort-double makes double the same as float
586 if(cmdline.isset("fshort-double"))
587 config.ansi_c.double_width=config.ansi_c.single_width;
588
589 // configure version-specific gcc settings
591
592 switch(compiler.mode)
593 {
595 log.debug() << "Linking a library only" << messaget::eom;
596 break;
598 log.debug() << "Compiling only" << messaget::eom;
599 break;
601 log.debug() << "Assembling only" << messaget::eom;
602 break;
604 log.debug() << "Preprocessing only" << messaget::eom;
605 break;
607 log.debug() << "Compiling and linking a library" << messaget::eom;
608 break;
610 log.debug() << "Compiling and linking an executable" << messaget::eom;
611 break;
612 }
613
614 if(cmdline.isset("i386-win32") ||
615 cmdline.isset("winx64"))
616 {
617 // We may wish to reconsider the below.
619 log.debug() << "Enabling Visual Studio syntax" << messaget::eom;
620 }
621 else
622 {
625 else
627 }
628
630 compiler.object_file_extension="s";
631 else
632 compiler.object_file_extension="o";
633
634 if(cmdline.isset("std"))
635 {
636 std::string std_string=cmdline.get_value("std");
637
638 if(std_string=="gnu89" || std_string=="c89")
639 config.ansi_c.set_c89();
640
641 if(std_string=="gnu99" || std_string=="c99" || std_string=="iso9899:1999" ||
642 std_string=="gnu9x" || std_string=="c9x" || std_string=="iso9899:199x")
643 config.ansi_c.set_c99();
644
645 if(std_string=="gnu11" || std_string=="c11" ||
646 std_string=="gnu1x" || std_string=="c1x")
647 config.ansi_c.set_c11();
648
649 if(std_string=="c++11" || std_string=="c++1x" ||
650 std_string=="gnu++11" || std_string=="gnu++1x" ||
651 std_string=="c++1y" ||
652 std_string=="gnu++1y")
653 config.cpp.set_cpp11();
654
655 if(std_string=="gnu++14" || std_string=="c++14")
656 config.cpp.set_cpp14();
657
658 if(std_string == "gnu++17" || std_string == "c++17")
659 config.cpp.set_cpp17();
660 }
661 else
662 {
665 }
666
667 // gcc's default is 32 bits for wchar_t
668 if(cmdline.isset("short-wchar"))
669 config.ansi_c.wchar_t_width=16;
670
671 // gcc's default is 64 bits for double
672 if(cmdline.isset("short-double"))
673 config.ansi_c.double_width=32;
674
675 // gcc's default is signed chars on most architectures
676 if(cmdline.isset("funsigned-char"))
677 config.ansi_c.char_is_unsigned=true;
678
679 if(cmdline.isset("fsigned-char"))
680 config.ansi_c.char_is_unsigned=false;
681
682 if(cmdline.isset('U'))
683 config.ansi_c.undefines=cmdline.get_values('U');
684
685 if(cmdline.isset("undef"))
686 config.ansi_c.preprocessor_options.push_back("-undef");
687
688 if(cmdline.isset("nostdinc"))
689 config.ansi_c.preprocessor_options.push_back("-nostdinc");
690
691 if(cmdline.isset('L'))
692 compiler.library_paths=cmdline.get_values('L');
693 // Don't add the system paths!
694
695 if(cmdline.isset('l'))
696 compiler.libraries=cmdline.get_values('l');
697
698 if(cmdline.isset("static"))
699 compiler.libraries.push_back("c");
700
701 if(cmdline.isset("pthread"))
702 compiler.libraries.push_back("pthread");
703
704 if(cmdline.isset('o'))
705 {
706 // given gcc -o file1 -o file2,
707 // gcc will output to file2, not file1
708 compiler.output_file_object=cmdline.get_values('o').back();
709 compiler.output_file_executable=cmdline.get_values('o').back();
710 }
711 else
712 {
713 compiler.output_file_object.clear();
714 compiler.output_file_executable="a.out";
715 }
716
717 // We now iterate over any input files
718
719 std::vector<temp_dirt> temp_dirs;
720
721 {
722 std::string language;
723
724 for(goto_cc_cmdlinet::parsed_argvt::iterator
725 arg_it=cmdline.parsed_argv.begin();
727 arg_it++)
728 {
729 if(arg_it->is_infile_name)
730 {
731 // do any preprocessing needed
732
733 if(language=="cpp-output" || language=="c++-cpp-output")
734 {
735 compiler.add_input_file(arg_it->arg);
736 }
737 else if(
738 language == "c" || language == "c++" ||
739 (language.empty() && needs_preprocessing(arg_it->arg)))
740 {
741 std::string new_suffix;
742
743 if(language=="c")
744 new_suffix=".i";
745 else if(language=="c++")
746 new_suffix=".ii";
747 else
748 new_suffix=has_suffix(arg_it->arg, ".c")?".i":".ii";
749
750 std::string new_name=
751 get_base_name(arg_it->arg, true)+new_suffix;
752
753 temp_dirs.emplace_back("goto-cc-XXXXXX");
754 std::string dest = temp_dirs.back()(new_name);
755
756 int exit_code=
757 preprocess(language, arg_it->arg, dest, act_as_bcc);
758
759 if(exit_code!=0)
760 {
761 log.error() << "preprocessing has failed" << messaget::eom;
762 return exit_code;
763 }
764
765 compiler.add_input_file(dest);
766 }
767 else
768 compiler.add_input_file(arg_it->arg);
769 }
770 else if(arg_it->arg=="-x")
771 {
772 arg_it++;
773 if(arg_it!=cmdline.parsed_argv.end())
774 {
775 language=arg_it->arg;
776 if(language=="none")
777 language.clear();
778 }
779 }
780 else if(has_prefix(arg_it->arg, "-x"))
781 {
782 language=std::string(arg_it->arg, 2, std::string::npos);
783 if(language=="none")
784 language.clear();
785 }
786 }
787 }
788
789 if(
790 cmdline.isset('o') && cmdline.isset('c') &&
791 compiler.source_files.size() >= 2)
792 {
793 log.error() << "cannot specify -o with -c with multiple files"
794 << messaget::eom;
795 return 1; // to match gcc's behaviour
796 }
797
798 // Revert to gcc in case there is no source to compile
799 // and no binary to link.
800
801 if(compiler.source_files.empty() &&
802 compiler.object_files.empty())
803 return run_gcc(compiler); // exit!
804
806 return asm_output(act_as_bcc, compiler.source_files, compiler);
807
808 // do all the rest
809 if(compiler.doit())
810 return 1; // GCC exit code for all kinds of errors
811
812 // We can generate hybrid ELF and Mach-O binaries
813 // containing both executable machine code and the goto-binary.
816
817 return EX_OK;
818}
819
822 const std::string &language,
823 const std::string &src,
824 const std::string &dest,
825 bool act_as_bcc)
826{
827 // build new argv
828 std::vector<std::string> new_argv;
829
830 new_argv.reserve(cmdline.parsed_argv.size());
831
832 bool skip_next=false;
833
834 for(goto_cc_cmdlinet::parsed_argvt::const_iterator
835 it=cmdline.parsed_argv.begin();
836 it!=cmdline.parsed_argv.end();
837 it++)
838 {
839 if(skip_next)
840 {
841 // skip
842 skip_next=false;
843 }
844 else if(it->is_infile_name)
845 {
846 // skip
847 }
848 else if(it->arg=="-c" || it->arg=="-E" || it->arg=="-S")
849 {
850 // skip
851 }
852 else if(it->arg=="-o")
853 {
854 skip_next=true;
855 }
856 else if(has_prefix(it->arg, "-o"))
857 {
858 // ignore
859 }
860 else
861 new_argv.push_back(it->arg);
862 }
863
864 // We just want to preprocess.
865 new_argv.push_back("-E");
866
867 // destination file
868 std::string stdout_file;
869 if(act_as_bcc)
870 stdout_file=dest;
871 else
872 {
873 new_argv.push_back("-o");
874 new_argv.push_back(dest);
875 }
876
877 // language, if given
878 if(!language.empty())
879 {
880 new_argv.push_back("-x");
881 new_argv.push_back(language);
882 }
883
884 // source file
885 new_argv.push_back(src);
886
887 // overwrite argv[0]
888 INVARIANT(new_argv.size()>=1, "No program name in argv");
889 new_argv[0]=native_tool_name.c_str();
890
892 log.debug() << "RUN:";
893 for(std::size_t i=0; i<new_argv.size(); i++)
894 log.debug() << " " << new_argv[i];
895 log.debug() << messaget::eom;
896
898}
899
901{
903
904 // build new argv
905 std::vector<std::string> new_argv;
906 new_argv.reserve(cmdline.parsed_argv.size());
907 for(const auto &a : cmdline.parsed_argv)
908 new_argv.push_back(a.arg);
909
910 if(compiler.wrote_object_files())
911 {
912 // Undefine all __CPROVER macros for the system compiler
913 std::map<irep_idt, std::size_t> arities;
914 compiler.cprover_macro_arities(arities);
915 for(const auto &pair : arities)
916 {
917 std::ostringstream addition;
918 addition << "-D" << id2string(pair.first) << "(";
919 std::vector<char> params(pair.second);
920 std::iota(params.begin(), params.end(), 'a');
921 for(std::vector<char>::iterator it=params.begin(); it!=params.end(); ++it)
922 {
923 addition << *it;
924 if(it+1!=params.end())
925 addition << ",";
926 }
927 addition << ")= ";
928 new_argv.push_back(addition.str());
929 }
930 }
931
932 // overwrite argv[0]
934
936 log.debug() << "RUN:";
937 for(std::size_t i=0; i<new_argv.size(); i++)
938 log.debug() << " " << new_argv[i];
939 log.debug() << messaget::eom;
940
941 return run(new_argv[0], new_argv, cmdline.stdin_file, "", "");
942}
943
945{
946 {
947 bool have_files=false;
948
949 for(goto_cc_cmdlinet::parsed_argvt::const_iterator
950 it=cmdline.parsed_argv.begin();
951 it!=cmdline.parsed_argv.end();
952 it++)
953 if(it->is_infile_name)
954 have_files=true;
955
956 if(!have_files)
957 return EX_OK;
958 }
959
960 std::list<std::string> output_files;
961
962 if(cmdline.isset('c'))
963 {
964 if(cmdline.isset('o'))
965 {
966 // there should be only one input file
967 output_files.push_back(cmdline.get_value('o'));
968 }
969 else
970 {
971 for(goto_cc_cmdlinet::parsed_argvt::const_iterator
972 i_it=cmdline.parsed_argv.begin();
973 i_it!=cmdline.parsed_argv.end();
974 i_it++)
975 if(i_it->is_infile_name &&
977 output_files.push_back(get_base_name(i_it->arg, true)+".o");
978 }
979 }
980 else
981 {
982 // -c is not given
983 if(cmdline.isset('o'))
984 output_files.push_back(cmdline.get_value('o'));
985 else
986 output_files.push_back("a.out");
987 }
988
989 if(output_files.empty() ||
990 (output_files.size()==1 &&
991 output_files.front()=="/dev/null"))
992 return run_gcc(compiler);
993
995 log.debug() << "Running " << native_tool_name << " to generate hybrid binary"
996 << messaget::eom;
997
998 // save the goto-cc output files
999 std::list<std::string> goto_binaries;
1000 for(std::list<std::string>::const_iterator
1001 it=output_files.begin();
1002 it!=output_files.end();
1003 it++)
1004 {
1005 std::string bin_name=*it+goto_binary_tmp_suffix;
1006
1007 try
1008 {
1009 file_rename(*it, bin_name);
1010 }
1011 catch(const cprover_exception_baset &e)
1012 {
1013 log.error() << "Rename failed: " << e.what() << messaget::eom;
1014 return 1;
1015 }
1016
1017 goto_binaries.push_back(bin_name);
1018 }
1019
1020 int result=run_gcc(compiler);
1021
1022 if(result==0 &&
1023 cmdline.isset('T') &&
1024 goto_binaries.size()==1 &&
1025 output_files.size()==1)
1026 {
1028 output_files.front(),
1029 goto_binaries.front(),
1030 cmdline,
1032 result=ls_merge.add_linker_script_definitions();
1033 }
1034
1035 std::string native_tool;
1036
1039 else if(has_suffix(compiler_name(cmdline, base_name), "-gcc"))
1041
1042 // merge output from gcc with goto-binaries
1043 // using objcopy, or do cleanup if an earlier call failed
1044 for(std::list<std::string>::const_iterator
1045 it=output_files.begin();
1046 it!=output_files.end();
1047 it++)
1048 {
1049 std::string goto_binary=*it+goto_binary_tmp_suffix;
1050
1051 if(result==0)
1052 result = hybrid_binary(
1054 goto_binary,
1055 *it,
1058 }
1059
1060 return result;
1061}
1062
1064 bool act_as_bcc,
1065 const std::list<std::string> &preprocessed_source_files,
1066 const compilet &compiler)
1067{
1068 {
1069 bool have_files=false;
1070
1071 for(goto_cc_cmdlinet::parsed_argvt::const_iterator
1072 it=cmdline.parsed_argv.begin();
1073 it!=cmdline.parsed_argv.end();
1074 it++)
1075 if(it->is_infile_name)
1076 have_files=true;
1077
1078 if(!have_files)
1079 return EX_OK;
1080 }
1081
1083
1085 {
1086 log.debug() << "Running " << native_tool_name
1087 << " to generate native asm output" << messaget::eom;
1088
1089 int result=run_gcc(compiler);
1090 if(result!=0)
1091 // native tool failed
1092 return result;
1093 }
1094
1095 std::map<std::string, std::string> output_files;
1096
1097 if(cmdline.isset('o'))
1098 {
1099 // GCC --combine supports more than one source file
1100 for(const auto &s : preprocessed_source_files)
1101 output_files.insert(std::make_pair(s, cmdline.get_value('o')));
1102 }
1103 else
1104 {
1105 for(const std::string &s : preprocessed_source_files)
1106 output_files.insert(
1107 std::make_pair(s, get_base_name(s, true)+".s"));
1108 }
1109
1110 if(output_files.empty() ||
1111 (output_files.size()==1 &&
1112 output_files.begin()->second=="/dev/null"))
1113 return EX_OK;
1114
1115 log.debug() << "Appending preprocessed sources to generate hybrid asm output"
1116 << messaget::eom;
1117
1118 for(const auto &so : output_files)
1119 {
1120 std::ifstream is(so.first);
1121 if(!is.is_open())
1122 {
1123 log.error() << "Failed to open input source " << so.first
1124 << messaget::eom;
1125 return 1;
1126 }
1127
1128 std::ofstream os(so.second, std::ios::app);
1129 if(!os.is_open())
1130 {
1131 log.error() << "Failed to open output file " << so.second
1132 << messaget::eom;
1133 return 1;
1134 }
1135
1136 const char comment=act_as_bcc ? ':' : '#';
1137
1138 os << comment << comment << " GOTO-CC" << '\n';
1139
1140 std::string line;
1141
1142 while(std::getline(is, line))
1143 {
1144 os << comment << comment << line << '\n';
1145 }
1146 }
1147
1148 return EX_OK;
1149}
1150
1153{
1154 std::cout << "goto-cc understands the options of "
1155 << "gcc plus the following.\n\n";
1156}
configt config
Definition config.cpp:25
virtual void clear()
Reset the abstract state.
Definition ai.h:266
ait supplies three of the four components needed: an abstract interpreter (in this case handling func...
Definition ai.h:563
std::string get_value(char option) const
Definition cmdline.cpp:48
virtual bool isset(char option) const
Definition cmdline.cpp:30
const std::list< std::string > & get_values(const std::string &option) const
Definition cmdline.cpp:109
@ ASSEMBLE_ONLY
Definition compile.h:39
@ LINK_LIBRARY
Definition compile.h:40
@ PREPROCESS_ONLY
Definition compile.h:37
@ COMPILE_LINK_EXECUTABLE
Definition compile.h:42
@ COMPILE_ONLY
Definition compile.h:38
@ COMPILE_LINK
Definition compile.h:41
void set_arch(const irep_idt &)
Definition config.cpp:702
bool set(const cmdlinet &cmdline)
Definition config.cpp:798
static irep_idt this_architecture()
Definition config.cpp:1351
struct configt::cppt cpp
static irep_idt this_operating_system()
Definition config.cpp:1451
struct configt::ansi_ct ansi_c
Base class for exceptions thrown in the cprover project.
Definition c_errors.h:64
virtual std::string what() const
A human readable description of what went wrong.
std::string native_tool_name
Definition gcc_mode.h:43
int preprocess(const std::string &language, const std::string &src, const std::string &dest, bool act_as_bcc)
call gcc for preprocessing
Definition gcc_mode.cpp:821
gcc_modet(goto_cc_cmdlinet &_cmdline, const std::string &_base_name, bool _produce_hybrid_binary)
Definition gcc_mode.cpp:95
static bool needs_preprocessing(const std::string &)
Definition gcc_mode.cpp:294
int doit() final
does it.
Definition gcc_mode.cpp:309
const std::string goto_binary_tmp_suffix
Definition gcc_mode.h:45
int run_gcc(const compilet &compiler)
call gcc with original command line
Definition gcc_mode.cpp:900
gcc_message_handlert gcc_message_handler
Definition gcc_mode.h:39
void help_mode() final
display command line help
const std::map< std::string, std::set< std::string > > arch_map
Associate CBMC architectures with processor names.
Definition gcc_mode.h:48
gcc_versiont gcc_version
Definition gcc_mode.h:68
const bool produce_hybrid_binary
Definition gcc_mode.h:41
int asm_output(bool act_as_bcc, const std::list< std::string > &preprocessed_source_files, const compilet &compiler)
int gcc_hybrid_binary(compilet &compiler)
Definition gcc_mode.cpp:944
void get(const std::string &executable)
configt::cppt::cpp_standardt default_cxx_standard
Definition gcc_version.h:40
configt::ansi_ct::c_standardt default_c_standard
Definition gcc_version.h:39
enum gcc_versiont::flavort flavor
parsed_argvt parsed_argv
std::string stdin_file
bool have_infile_arg() const
goto_cc_cmdlinet & cmdline
const std::string base_name
void help()
display command line help
Synthesise definitions of symbols that are defined in linker scripts.
Class that provides messages with a built-in verbosity 'level'.
Definition message.h:155
static unsigned eval_verbosity(const std::string &user_input, const message_levelt default_verbosity, message_handlert &dest)
Parse a (user-)provided string as a verbosity level and set it as the verbosity of dest.
Definition message.cpp:105
@ M_ERROR
Definition message.h:170
@ M_WARNING
Definition message.h:170
static eomt eom
Definition message.h:297
Compile and link source and object files.
bool has_prefix(const std::string &s, const std::string &prefix)
Definition converter.cpp:13
void file_rename(const std::string &old_path, const std::string &new_path)
Rename a file.
static std::string linker_name(const cmdlinet &cmdline, const std::string &base_name)
Definition gcc_mode.cpp:75
static std::string compiler_name(const cmdlinet &cmdline, const std::string &base_name)
Definition gcc_mode.cpp:42
Base class for command line interpretation.
void configure_gcc(const gcc_versiont &gcc_version)
std::string get_base_name(const std::string &in, bool strip_suffix)
cleans a filename from path and extension
Command line interpretation for goto-cc.
int hybrid_binary(const std::string &compiler_or_linker, const std::string &goto_binary_file, const std::string &output_file, bool building_executable, message_handlert &message_handler, bool linking_efi)
Merges a goto binary into an object file (e.g.
Create hybrid binary with goto-binary section.
const std::string & id2string(const irep_idt &d)
Definition irep.h:47
Merge linker script-defined symbols into a goto-program.
literalt pos(literalt a)
Definition literal.h:194
static std::string comment(const rw_set_baset::entryt &entry, bool write)
int run(const std::string &what, const std::vector< std::string > &argv)
Definition run.cpp:48
#define PRECONDITION(CONDITION)
Definition invariant.h:463
#define INVARIANT(CONDITION, REASON)
This macro uses the wrapper function 'invariant_violated_string'.
Definition invariant.h:423
Definition kdev_t.h:19
bool has_suffix(const std::string &s, const std::string &suffix)
Definition suffix.h:17
const char * CBMC_VERSION