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 <iostream>
23#include <fstream>
24#include <numeric>
25
26#include <util/cmdline.h>
27#include <util/config.h>
28#include <util/file_util.h>
29#include <util/get_base_name.h>
30#include <util/invariant.h>
31#include <util/prefix.h>
32#include <util/run.h>
33#include <util/suffix.h>
34#include <util/tempdir.h>
35#include <util/version.h>
36
37#include "compile.h"
38#include "goto_cc_cmdline.h"
39#include "hybrid_binary.h"
40#include "linker_script_merge.h"
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
96 goto_cc_cmdlinet &_cmdline,
97 const std::string &_base_name,
98 bool _produce_hybrid_binary):
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{
311 if(cmdline.isset('?') ||
312 cmdline.isset("help"))
313 {
314 help();
315 return EX_OK;
316 }
317
320
321 auto default_verbosity = (cmdline.isset("Wall") || cmdline.isset("Wextra")) ?
324 cmdline.get_value("verbosity"), default_verbosity, gcc_message_handler);
325
326 bool act_as_bcc=
327 base_name=="bcc" ||
328 base_name.find("goto-bcc")!=std::string::npos;
329
330 // if we are gcc or bcc, then get the version number
332
333 if((cmdline.isset('v') && cmdline.have_infile_arg()) ||
334 (cmdline.isset("version") && !produce_hybrid_binary))
335 {
336 // "-v" a) prints the version and b) increases verbosity.
337 // Compilation continues, don't exit!
338
339 if(act_as_bcc)
340 std::cout << "bcc: version " << gcc_version << " (goto-cc "
341 << CBMC_VERSION << ")\n";
342 else
343 {
345 std::cout << "clang version " << gcc_version << " (goto-cc "
346 << CBMC_VERSION << ")\n";
347 else
348 std::cout << "gcc (goto-cc " << CBMC_VERSION << ") " << gcc_version
349 << '\n';
350 }
351 }
352
353 compilet compiler(cmdline,
355 cmdline.isset("Werror") &&
356 !cmdline.isset("Wno-error"));
357
358 if(cmdline.isset("version"))
359 {
361 return run_gcc(compiler);
362
363 std::cout
364 << '\n'
365 << "Copyright (C) 2006-2018 Daniel Kroening, Christoph Wintersteiger\n"
366 << "CBMC version: " << CBMC_VERSION << '\n'
367 << "Architecture: " << config.this_architecture() << '\n'
368 << "OS: " << config.this_operating_system() << '\n';
369
371 std::cout << "clang: " << gcc_version << '\n';
372 else
373 std::cout << "gcc: " << gcc_version << '\n';
374
375 return EX_OK; // Exit!
376 }
377
378 if(
379 cmdline.isset("dumpmachine") || cmdline.isset("dumpspecs") ||
380 cmdline.isset("dumpversion") || cmdline.isset("print-sysroot") ||
381 cmdline.isset("print-sysroot-headers-suffix"))
382 {
384 return run_gcc(compiler);
385
386 // GCC will only print one of these, even when multiple arguments are
387 // passed, so we do the same
388 if(cmdline.isset("dumpmachine"))
389 std::cout << config.this_architecture() << '\n';
390 else if(cmdline.isset("dumpversion"))
391 std::cout << gcc_version << '\n';
392
393 // we don't have any meaningful output for the other options, and GCC
394 // doesn't necessarily produce non-empty output either
395
396 return EX_OK;
397 }
398
400
401 if(act_as_bcc)
402 {
404 log.debug() << "BCC mode (hybrid)" << messaget::eom;
405 else
406 log.debug() << "BCC mode" << messaget::eom;
407 }
408 else
409 {
411 log.debug() << "GCC mode (hybrid)" << messaget::eom;
412 else
413 log.debug() << "GCC mode" << messaget::eom;
414 }
415
416 // model validation
417 compiler.validate_goto_model = cmdline.isset("validate-goto-model");
418
419 // determine actions to be undertaken
420 if(cmdline.isset('S'))
422 else if(cmdline.isset('c'))
424 else if(cmdline.isset('E'))
426 else if(cmdline.isset("shared") ||
427 cmdline.isset('r')) // really not well documented
429 else
431
432 // In gcc mode, we have just pass on to gcc to handle the following:
433 // * if -M or -MM is given, we do dependencies only
434 // * preprocessing (-E)
435 // * no input files given
436
437 if(cmdline.isset('M') ||
438 cmdline.isset("MM") ||
439 cmdline.isset('E') ||
441 return run_gcc(compiler); // exit!
442
443 // get configuration
445
446 // Intel-specific
447 // in GCC, m16 is 32-bit (!), as documented here:
448 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=59672
449 if(cmdline.isset("m16") ||
450 cmdline.isset("m32") || cmdline.isset("mx32"))
451 {
452 config.ansi_c.arch="i386";
454 }
455 else if(cmdline.isset("m64"))
456 {
457 config.ansi_c.arch="x86_64";
459 }
460
461 // ARM-specific
462 if(cmdline.isset("mbig-endian") || cmdline.isset("mbig"))
464 else if(cmdline.isset("little-endian") || cmdline.isset("mlittle"))
466
467 if(cmdline.isset("mthumb") || cmdline.isset("mthumb-interwork"))
469
470 // -mcpu sets both the arch and tune, but should only be used if
471 // neither -march nor -mtune are passed on the command line.
472 std::string target_cpu=
473 cmdline.isset("march") ? cmdline.get_value("march") :
474 cmdline.isset("mtune") ? cmdline.get_value("mtune") :
475 cmdline.isset("mcpu") ? cmdline.get_value("mcpu") : "";
476
477 if(!target_cpu.empty())
478 {
479 // Work out what CPROVER architecture we should target.
480 for(auto &pair : arch_map)
481 for(auto &processor : pair.second)
482 if(processor==target_cpu)
483 {
484 if(pair.first.find("mips")==std::string::npos)
485 config.set_arch(pair.first);
486 else
487 {
488 // Targeting a MIPS processor. MIPS is special; we also need
489 // to know the endianness. -EB (big-endian) is the default.
490 if(cmdline.isset("EL"))
491 {
492 if(pair.first=="mips32o")
493 config.set_arch("mipsel");
494 else if(pair.first=="mips32n")
495 config.set_arch("mipsn32el");
496 else
497 config.set_arch("mips64el");
498 }
499 else
500 {
501 if(pair.first=="mips32o")
502 config.set_arch("mips");
503 else if(pair.first=="mips32n")
504 config.set_arch("mipsn32");
505 else
506 config.set_arch("mips64");
507 }
508 }
509 }
510 }
511
512 // -fshort-wchar makes wchar_t "short unsigned int"
513 if(cmdline.isset("fshort-wchar"))
514 {
517 }
518
519 // -fsingle-precision-constant makes floating-point constants "float"
520 // instead of double
521 if(cmdline.isset("-fsingle-precision-constant"))
523
524 // -fshort-double makes double the same as float
525 if(cmdline.isset("fshort-double"))
527
528 // configure version-specific gcc settings
530
531 switch(compiler.mode)
532 {
534 log.debug() << "Linking a library only" << messaget::eom;
535 break;
537 log.debug() << "Compiling only" << messaget::eom;
538 break;
540 log.debug() << "Assembling only" << messaget::eom;
541 break;
543 log.debug() << "Preprocessing only" << messaget::eom;
544 break;
546 log.debug() << "Compiling and linking a library" << messaget::eom;
547 break;
549 log.debug() << "Compiling and linking an executable" << messaget::eom;
550 break;
551 }
552
553 if(cmdline.isset("i386-win32") ||
554 cmdline.isset("winx64"))
555 {
556 // We may wish to reconsider the below.
558 log.debug() << "Enabling Visual Studio syntax" << messaget::eom;
559 }
560 else
561 {
564 else
566 }
567
568 if(compiler.mode==compilet::ASSEMBLE_ONLY)
569 compiler.object_file_extension="s";
570 else
571 compiler.object_file_extension="o";
572
573 if(cmdline.isset("std"))
574 {
575 std::string std_string=cmdline.get_value("std");
576
577 if(std_string=="gnu89" || std_string=="c89")
579
580 if(std_string=="gnu99" || std_string=="c99" || std_string=="iso9899:1999" ||
581 std_string=="gnu9x" || std_string=="c9x" || std_string=="iso9899:199x")
583
584 if(std_string=="gnu11" || std_string=="c11" ||
585 std_string=="gnu1x" || std_string=="c1x")
587
588 if(std_string=="c++11" || std_string=="c++1x" ||
589 std_string=="gnu++11" || std_string=="gnu++1x" ||
590 std_string=="c++1y" ||
591 std_string=="gnu++1y")
593
594 if(std_string=="gnu++14" || std_string=="c++14")
596
597 if(std_string == "gnu++17" || std_string == "c++17")
599 }
600 else
601 {
604 }
605
606 // gcc's default is 32 bits for wchar_t
607 if(cmdline.isset("short-wchar"))
609
610 // gcc's default is 64 bits for double
611 if(cmdline.isset("short-double"))
613
614 // gcc's default is signed chars on most architectures
615 if(cmdline.isset("funsigned-char"))
617
618 if(cmdline.isset("fsigned-char"))
620
621 if(cmdline.isset('U'))
623
624 if(cmdline.isset("undef"))
625 config.ansi_c.preprocessor_options.push_back("-undef");
626
627 if(cmdline.isset("nostdinc"))
628 config.ansi_c.preprocessor_options.push_back("-nostdinc");
629
630 if(cmdline.isset('L'))
631 compiler.library_paths=cmdline.get_values('L');
632 // Don't add the system paths!
633
634 if(cmdline.isset('l'))
635 compiler.libraries=cmdline.get_values('l');
636
637 if(cmdline.isset("static"))
638 compiler.libraries.push_back("c");
639
640 if(cmdline.isset("pthread"))
641 compiler.libraries.push_back("pthread");
642
643 if(cmdline.isset('o'))
644 {
645 // given gcc -o file1 -o file2,
646 // gcc will output to file2, not file1
647 compiler.output_file_object=cmdline.get_values('o').back();
648 compiler.output_file_executable=cmdline.get_values('o').back();
649 }
650 else
651 {
652 compiler.output_file_object.clear();
653 compiler.output_file_executable="a.out";
654 }
655
656 // We now iterate over any input files
657
658 std::vector<temp_dirt> temp_dirs;
659
660 {
661 std::string language;
662
663 for(goto_cc_cmdlinet::parsed_argvt::iterator
664 arg_it=cmdline.parsed_argv.begin();
665 arg_it!=cmdline.parsed_argv.end();
666 arg_it++)
667 {
668 if(arg_it->is_infile_name)
669 {
670 // do any preprocessing needed
671
672 if(language=="cpp-output" || language=="c++-cpp-output")
673 {
674 compiler.add_input_file(arg_it->arg);
675 }
676 else if(
677 language == "c" || language == "c++" ||
678 (language.empty() && needs_preprocessing(arg_it->arg)))
679 {
680 std::string new_suffix;
681
682 if(language=="c")
683 new_suffix=".i";
684 else if(language=="c++")
685 new_suffix=".ii";
686 else
687 new_suffix=has_suffix(arg_it->arg, ".c")?".i":".ii";
688
689 std::string new_name=
690 get_base_name(arg_it->arg, true)+new_suffix;
691
692 temp_dirs.emplace_back("goto-cc-XXXXXX");
693 std::string dest = temp_dirs.back()(new_name);
694
695 int exit_code=
696 preprocess(language, arg_it->arg, dest, act_as_bcc);
697
698 if(exit_code!=0)
699 {
700 log.error() << "preprocessing has failed" << messaget::eom;
701 return exit_code;
702 }
703
704 compiler.add_input_file(dest);
705 }
706 else
707 compiler.add_input_file(arg_it->arg);
708 }
709 else if(arg_it->arg=="-x")
710 {
711 arg_it++;
712 if(arg_it!=cmdline.parsed_argv.end())
713 {
714 language=arg_it->arg;
715 if(language=="none")
716 language.clear();
717 }
718 }
719 else if(has_prefix(arg_it->arg, "-x"))
720 {
721 language=std::string(arg_it->arg, 2, std::string::npos);
722 if(language=="none")
723 language.clear();
724 }
725 }
726 }
727
728 if(
729 cmdline.isset('o') && cmdline.isset('c') &&
730 compiler.source_files.size() >= 2)
731 {
732 log.error() << "cannot specify -o with -c with multiple files"
733 << messaget::eom;
734 return 1; // to match gcc's behaviour
735 }
736
737 // Revert to gcc in case there is no source to compile
738 // and no binary to link.
739
740 if(compiler.source_files.empty() &&
741 compiler.object_files.empty())
742 return run_gcc(compiler); // exit!
743
744 if(compiler.mode==compilet::ASSEMBLE_ONLY)
745 return asm_output(act_as_bcc, compiler.source_files, compiler);
746
747 // do all the rest
748 if(compiler.doit())
749 return 1; // GCC exit code for all kinds of errors
750
751 // We can generate hybrid ELF and Mach-O binaries
752 // containing both executable machine code and the goto-binary.
753 if(produce_hybrid_binary && !act_as_bcc)
754 return gcc_hybrid_binary(compiler);
755
756 return EX_OK;
757}
758
761 const std::string &language,
762 const std::string &src,
763 const std::string &dest,
764 bool act_as_bcc)
765{
766 // build new argv
767 std::vector<std::string> new_argv;
768
769 new_argv.reserve(cmdline.parsed_argv.size());
770
771 bool skip_next=false;
772
773 for(goto_cc_cmdlinet::parsed_argvt::const_iterator
774 it=cmdline.parsed_argv.begin();
775 it!=cmdline.parsed_argv.end();
776 it++)
777 {
778 if(skip_next)
779 {
780 // skip
781 skip_next=false;
782 }
783 else if(it->is_infile_name)
784 {
785 // skip
786 }
787 else if(it->arg=="-c" || it->arg=="-E" || it->arg=="-S")
788 {
789 // skip
790 }
791 else if(it->arg=="-o")
792 {
793 skip_next=true;
794 }
795 else if(has_prefix(it->arg, "-o"))
796 {
797 // ignore
798 }
799 else
800 new_argv.push_back(it->arg);
801 }
802
803 // We just want to preprocess.
804 new_argv.push_back("-E");
805
806 // destination file
807 std::string stdout_file;
808 if(act_as_bcc)
809 stdout_file=dest;
810 else
811 {
812 new_argv.push_back("-o");
813 new_argv.push_back(dest);
814 }
815
816 // language, if given
817 if(!language.empty())
818 {
819 new_argv.push_back("-x");
820 new_argv.push_back(language);
821 }
822
823 // source file
824 new_argv.push_back(src);
825
826 // overwrite argv[0]
827 INVARIANT(new_argv.size()>=1, "No program name in argv");
828 new_argv[0]=native_tool_name.c_str();
829
831 log.debug() << "RUN:";
832 for(std::size_t i=0; i<new_argv.size(); i++)
833 log.debug() << " " << new_argv[i];
834 log.debug() << messaget::eom;
835
836 return run(new_argv[0], new_argv, cmdline.stdin_file, stdout_file, "");
837}
838
839int gcc_modet::run_gcc(const compilet &compiler)
840{
842
843 // build new argv
844 std::vector<std::string> new_argv;
845 new_argv.reserve(cmdline.parsed_argv.size());
846 for(const auto &a : cmdline.parsed_argv)
847 new_argv.push_back(a.arg);
848
849 if(compiler.wrote_object_files())
850 {
851 // Undefine all __CPROVER macros for the system compiler
852 std::map<irep_idt, std::size_t> arities;
853 compiler.cprover_macro_arities(arities);
854 for(const auto &pair : arities)
855 {
856 std::ostringstream addition;
857 addition << "-D" << id2string(pair.first) << "(";
858 std::vector<char> params(pair.second);
859 std::iota(params.begin(), params.end(), 'a');
860 for(std::vector<char>::iterator it=params.begin(); it!=params.end(); ++it)
861 {
862 addition << *it;
863 if(it+1!=params.end())
864 addition << ",";
865 }
866 addition << ")= ";
867 new_argv.push_back(addition.str());
868 }
869 }
870
871 // overwrite argv[0]
872 new_argv[0]=native_tool_name;
873
875 log.debug() << "RUN:";
876 for(std::size_t i=0; i<new_argv.size(); i++)
877 log.debug() << " " << new_argv[i];
878 log.debug() << messaget::eom;
879
880 return run(new_argv[0], new_argv, cmdline.stdin_file, "", "");
881}
882
884{
885 {
886 bool have_files=false;
887
888 for(goto_cc_cmdlinet::parsed_argvt::const_iterator
889 it=cmdline.parsed_argv.begin();
890 it!=cmdline.parsed_argv.end();
891 it++)
892 if(it->is_infile_name)
893 have_files=true;
894
895 if(!have_files)
896 return EX_OK;
897 }
898
899 std::list<std::string> output_files;
900
901 if(cmdline.isset('c'))
902 {
903 if(cmdline.isset('o'))
904 {
905 // there should be only one input file
906 output_files.push_back(cmdline.get_value('o'));
907 }
908 else
909 {
910 for(goto_cc_cmdlinet::parsed_argvt::const_iterator
911 i_it=cmdline.parsed_argv.begin();
912 i_it!=cmdline.parsed_argv.end();
913 i_it++)
914 if(i_it->is_infile_name &&
915 needs_preprocessing(i_it->arg))
916 output_files.push_back(get_base_name(i_it->arg, true)+".o");
917 }
918 }
919 else
920 {
921 // -c is not given
922 if(cmdline.isset('o'))
923 output_files.push_back(cmdline.get_value('o'));
924 else
925 output_files.push_back("a.out");
926 }
927
928 if(output_files.empty() ||
929 (output_files.size()==1 &&
930 output_files.front()=="/dev/null"))
931 return run_gcc(compiler);
932
934 log.debug() << "Running " << native_tool_name << " to generate hybrid binary"
935 << messaget::eom;
936
937 // save the goto-cc output files
938 std::list<std::string> goto_binaries;
939 for(std::list<std::string>::const_iterator
940 it=output_files.begin();
941 it!=output_files.end();
942 it++)
943 {
944 std::string bin_name=*it+goto_binary_tmp_suffix;
945
946 try
947 {
948 file_rename(*it, bin_name);
949 }
950 catch(const cprover_exception_baset &e)
951 {
952 log.error() << "Rename failed: " << e.what() << messaget::eom;
953 return 1;
954 }
955
956 goto_binaries.push_back(bin_name);
957 }
958
959 int result=run_gcc(compiler);
960
961 if(result==0 &&
962 cmdline.isset('T') &&
963 goto_binaries.size()==1 &&
964 output_files.size()==1)
965 {
966 linker_script_merget ls_merge(
967 output_files.front(),
968 goto_binaries.front(),
969 cmdline,
971 result=ls_merge.add_linker_script_definitions();
972 }
973
974 std::string native_tool;
975
977 native_tool=linker_name(cmdline, base_name);
978 else if(has_suffix(compiler_name(cmdline, base_name), "-gcc"))
979 native_tool=compiler_name(cmdline, base_name);
980
981 // merge output from gcc with goto-binaries
982 // using objcopy, or do cleanup if an earlier call failed
983 for(std::list<std::string>::const_iterator
984 it=output_files.begin();
985 it!=output_files.end();
986 it++)
987 {
988 std::string goto_binary=*it+goto_binary_tmp_suffix;
989
990 if(result==0)
991 result = hybrid_binary(
992 native_tool,
993 goto_binary,
994 *it,
997 }
998
999 return result;
1000}
1001
1003 bool act_as_bcc,
1004 const std::list<std::string> &preprocessed_source_files,
1005 const compilet &compiler)
1006{
1007 {
1008 bool have_files=false;
1009
1010 for(goto_cc_cmdlinet::parsed_argvt::const_iterator
1011 it=cmdline.parsed_argv.begin();
1012 it!=cmdline.parsed_argv.end();
1013 it++)
1014 if(it->is_infile_name)
1015 have_files=true;
1016
1017 if(!have_files)
1018 return EX_OK;
1019 }
1020
1022
1024 {
1025 log.debug() << "Running " << native_tool_name
1026 << " to generate native asm output" << messaget::eom;
1027
1028 int result=run_gcc(compiler);
1029 if(result!=0)
1030 // native tool failed
1031 return result;
1032 }
1033
1034 std::map<std::string, std::string> output_files;
1035
1036 if(cmdline.isset('o'))
1037 {
1038 // GCC --combine supports more than one source file
1039 for(const auto &s : preprocessed_source_files)
1040 output_files.insert(std::make_pair(s, cmdline.get_value('o')));
1041 }
1042 else
1043 {
1044 for(const std::string &s : preprocessed_source_files)
1045 output_files.insert(
1046 std::make_pair(s, get_base_name(s, true)+".s"));
1047 }
1048
1049 if(output_files.empty() ||
1050 (output_files.size()==1 &&
1051 output_files.begin()->second=="/dev/null"))
1052 return EX_OK;
1053
1054 log.debug() << "Appending preprocessed sources to generate hybrid asm output"
1055 << messaget::eom;
1056
1057 for(const auto &so : output_files)
1058 {
1059 std::ifstream is(so.first);
1060 if(!is.is_open())
1061 {
1062 log.error() << "Failed to open input source " << so.first
1063 << messaget::eom;
1064 return 1;
1065 }
1066
1067 std::ofstream os(so.second, std::ios::app);
1068 if(!os.is_open())
1069 {
1070 log.error() << "Failed to open output file " << so.second
1071 << messaget::eom;
1072 return 1;
1073 }
1074
1075 const char comment=act_as_bcc ? ':' : '#';
1076
1077 os << comment << comment << " GOTO-CC" << '\n';
1078
1079 std::string line;
1080
1081 while(std::getline(is, line))
1082 {
1083 os << comment << comment << line << '\n';
1084 }
1085 }
1086
1087 return EX_OK;
1088}
1089
1092{
1093 std::cout << "goto-cc understands the options of "
1094 << "gcc plus the following.\n\n";
1095}
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
std::string output_file_object
Definition compile.h:54
bool add_input_file(const std::string &)
puts input file names into a list and does preprocessing for libraries.
Definition compile.cpp:173
std::list< std::string > libraries
Definition compile.h:48
void cprover_macro_arities(std::map< irep_idt, std::size_t > &cprover_macros) const
__CPROVER_... macros written to object files and their arities
Definition compile.h:93
std::list< std::string > object_files
Definition compile.h:47
bool doit()
reads and source and object files, compiles and links them into goto program objects.
Definition compile.cpp:60
std::list< std::string > source_files
Definition compile.h:46
bool wrote_object_files() const
Has this compiler written any object files?
Definition compile.h:86
std::string object_file_extension
Definition compile.h:50
bool validate_goto_model
Definition compile.h:35
enum compilet::@3 mode
std::list< std::string > library_paths
Definition compile.h:45
std::string output_file_executable
Definition compile.h:51
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:1350
struct configt::cppt cpp
static irep_idt this_operating_system()
Definition config.cpp:1450
struct configt::ansi_ct ansi_c
Base class for exceptions thrown in the cprover project.
virtual std::string what() const =0
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:760
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:839
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:883
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.
int add_linker_script_definitions()
Add values of linkerscript-defined symbols to the goto-binary.
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.
configt config
Definition config.cpp:25
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
enum configt::ansi_ct::c_standardt c_standard
endiannesst endianness
Definition config.h:177
bool wchar_t_is_unsigned
Definition config.h:122
void set_c89()
Definition config.h:135
irep_idt arch
Definition config.h:191
std::list< std::string > undefines
Definition config.h:236
std::list< std::string > preprocessor_options
Definition config.h:237
void set_c99()
Definition config.h:140
bool single_precision_constant
Definition config.h:126
void set_arch_spec_arm(const irep_idt &subarch)
Definition config.cpp:281
std::size_t wchar_t_width
Definition config.h:119
std::size_t double_width
Definition config.h:117
bool char_is_unsigned
Definition config.h:122
void set_arch_spec_x86_64()
Definition config.cpp:182
std::size_t single_width
Definition config.h:116
void set_arch_spec_i386()
Definition config.cpp:150
std::size_t short_int_width
Definition config.h:113
void set_c11()
Definition config.h:145
flavourt mode
Definition config.h:222
void set_cpp14()
Definition config.h:292
enum configt::cppt::cpp_standardt cpp_standard
void set_cpp11()
Definition config.h:288
void set_cpp17()
Definition config.h:296
Definition kdev_t.h:19
bool has_suffix(const std::string &s, const std::string &suffix)
Definition suffix.h:17
const char * CBMC_VERSION