1 /* Wrapper to call lto. Used by collect2 and the linker plugin.
2 Copyright (C) 2009, 2010 Free Software Foundation, Inc.
4 Factored out of collect2 by Rafael Espindola <espindola@google.com>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
23 /* This program is passed a gcc, a list of gcc arguments and a list of
24 object files containing IL. It scans the argument list to check if
25 we are in whopr mode or not modifies the arguments and needed and
26 prints a list of output files on stdout.
30 $ lto-wrapper gcc/xgcc -B gcc a.o b.o -o test -flto
32 The above will print something like
35 If WHOPR is used instead, more than one file might be produced
36 ./ccXj2DTk.lto.ltrans.o
37 ./ccCJuXGv.lto.ltrans.o
42 #include "coretypes.h"
44 #include "diagnostic.h"
49 int debug
; /* true if -save-temps. */
50 int verbose
; /* true if -v. */
53 LTO_MODE_NONE
, /* Not doing LTO. */
54 LTO_MODE_LTO
, /* Normal LTO. */
55 LTO_MODE_WHOPR
/* WHOPR. */
58 /* Current LTO mode. */
59 static enum lto_mode_d lto_mode
= LTO_MODE_NONE
;
61 static char *ltrans_output_file
;
62 static char *flto_out
;
63 static char *args_name
;
64 static unsigned int nr
;
65 static char **input_names
;
66 static char **output_names
;
67 static char *makefile
;
69 static void maybe_unlink_file (const char *);
71 /* Delete tempfiles. */
74 lto_wrapper_cleanup (void)
76 static bool cleanup_done
= false;
82 /* Setting cleanup_done prevents an infinite loop if one of the
83 calls to maybe_unlink_file fails. */
86 if (ltrans_output_file
)
87 maybe_unlink_file (ltrans_output_file
);
89 maybe_unlink_file (flto_out
);
91 maybe_unlink_file (args_name
);
93 maybe_unlink_file (makefile
);
94 for (i
= 0; i
< nr
; ++i
)
96 maybe_unlink_file (input_names
[i
]);
98 maybe_unlink_file (output_names
[i
]);
103 fatal_signal (int signum
)
105 signal (signum
, SIG_DFL
);
106 lto_wrapper_cleanup ();
107 /* Get the same signal again, this time not handled,
108 so its normal effect occurs. */
109 kill (getpid (), signum
);
112 /* Just die. CMSGID is the error message. */
114 static void __attribute__ ((format (printf
, 1, 2)))
115 fatal (const char * cmsgid
, ...)
119 va_start (ap
, cmsgid
);
120 fprintf (stderr
, "lto-wrapper: ");
121 vfprintf (stderr
, _(cmsgid
), ap
);
122 fprintf (stderr
, "\n");
125 lto_wrapper_cleanup ();
126 exit (FATAL_EXIT_CODE
);
130 /* Die when sys call fails. CMSGID is the error message. */
132 static void __attribute__ ((format (printf
, 1, 2)))
133 fatal_perror (const char *cmsgid
, ...)
138 va_start (ap
, cmsgid
);
139 fprintf (stderr
, "lto-wrapper: ");
140 vfprintf (stderr
, _(cmsgid
), ap
);
141 fprintf (stderr
, ": %s\n", xstrerror (e
));
144 lto_wrapper_cleanup ();
145 exit (FATAL_EXIT_CODE
);
149 /* Execute a program, and wait for the reply. ARGV are the arguments. The
150 last one must be NULL. */
152 static struct pex_obj
*
153 collect_execute (char **argv
)
164 for (p_argv
= argv
; (str
= *p_argv
) != (char *) 0; p_argv
++)
165 fprintf (stderr
, " %s", str
);
167 fprintf (stderr
, "\n");
173 pex
= pex_init (0, "lto-wrapper", NULL
);
175 fatal_perror ("pex_init failed");
177 /* Do not use PEX_LAST here, we use our stdout for communicating with
178 collect2 or the linker-plugin. Any output from the sub-process
179 will confuse that. */
180 errmsg
= pex_run (pex
, PEX_SEARCH
, argv
[0], argv
, NULL
,
187 fatal_perror (errmsg
);
197 /* Wait for a process to finish, and exit if a nonzero status is found.
198 PROG is the program name. PEX is the process we should wait for. */
201 collect_wait (const char *prog
, struct pex_obj
*pex
)
205 if (!pex_get_status (pex
, 1, &status
))
206 fatal_perror ("can't get program status");
211 if (WIFSIGNALED (status
))
213 int sig
= WTERMSIG (status
);
214 if (WCOREDUMP (status
))
215 fatal ("%s terminated with signal %d [%s], core dumped",
216 prog
, sig
, strsignal (sig
));
218 fatal ("%s terminated with signal %d [%s]",
219 prog
, sig
, strsignal (sig
));
222 if (WIFEXITED (status
))
223 fatal ("%s returned %d exit status", prog
, WEXITSTATUS (status
));
230 /* Unlink a temporary LTRANS file unless requested otherwise. */
233 maybe_unlink_file (const char *file
)
237 if (unlink_if_ordinary (file
)
239 fatal_perror ("deleting LTRANS file %s", file
);
242 fprintf (stderr
, "[Leaving LTRANS %s]\n", file
);
246 /* Execute program ARGV[0] with arguments ARGV. Wait for it to finish. */
249 fork_execute (char **argv
)
257 args_name
= make_temp_file (".args");
258 at_args
= concat ("@", args_name
, NULL
);
259 args
= fopen (args_name
, "w");
261 fatal ("failed to open %s", args_name
);
263 status
= writeargv (&argv
[1], args
);
266 fatal ("could not write to temporary file %s", args_name
);
270 new_argv
[0] = argv
[0];
271 new_argv
[1] = at_args
;
274 pex
= collect_execute (new_argv
);
275 collect_wait (new_argv
[0], pex
);
277 maybe_unlink_file (args_name
);
282 /* Template of LTRANS dumpbase suffix. */
283 #define DUMPBASE_SUFFIX ".ltrans18446744073709551615"
285 /* Create decoded options from the COLLECT_GCC and COLLECT_GCC_OPTIONS
286 environment according to LANG_MASK. */
289 get_options_from_collect_gcc_options (const char *collect_gcc
,
290 const char *collect_gcc_options
,
291 unsigned int lang_mask
,
292 struct cl_decoded_option
**decoded_options
,
293 unsigned int *decoded_options_count
)
299 /* Count arguments, account for the program name. */
301 for (j
= 0; collect_gcc_options
[j
] != '\0'; ++j
)
302 if (collect_gcc_options
[j
] == '\'')
305 fatal ("malformed COLLECT_GCC_OPTIONS");
307 /* Copy the options to a argv-like array. */
309 argv
= (const char **) xmalloc ((argc
+ 2) * sizeof (char *));
310 argv
[0] = collect_gcc
;
311 argv_storage
= xstrdup (collect_gcc_options
);
312 for (i
= 1, j
= 0; argv_storage
[j
] != '\0'; ++j
)
314 if (argv_storage
[j
] == '\'')
316 argv
[i
++] = &argv_storage
[++j
];
317 while (argv_storage
[j
] != '\'')
319 argv_storage
[j
] = '\0';
324 decode_cmdline_options_to_array (argc
, (const char **)argv
,
326 decoded_options
, decoded_options_count
);
331 /* Execute gcc. ARGC is the number of arguments. ARGV contains the arguments. */
334 run_gcc (unsigned argc
, char *argv
[])
337 const char **new_argv
;
338 const char **argv_ptr
;
339 char *list_option_full
= NULL
;
340 const char *linker_output
= NULL
;
341 const char *collect_gcc
, *collect_gcc_options
;
344 bool no_partition
= false;
345 struct cl_decoded_option
*decoded_options
;
346 unsigned int decoded_options_count
;
347 struct obstack argv_obstack
;
350 /* Get the driver and options. */
351 collect_gcc
= getenv ("COLLECT_GCC");
353 fatal ("environment variable COLLECT_GCC must be set");
354 collect_gcc_options
= getenv ("COLLECT_GCC_OPTIONS");
355 if (!collect_gcc_options
)
356 fatal ("environment variable COLLECT_GCC_OPTIONS must be set");
357 get_options_from_collect_gcc_options (collect_gcc
, collect_gcc_options
,
360 &decoded_options_count
);
362 /* Initalize the common arguments for the driver. */
363 obstack_init (&argv_obstack
);
364 obstack_ptr_grow (&argv_obstack
, collect_gcc
);
365 obstack_ptr_grow (&argv_obstack
, "-xlto");
366 obstack_ptr_grow (&argv_obstack
, "-c");
367 for (j
= 1; j
< decoded_options_count
; ++j
)
369 struct cl_decoded_option
*option
= &decoded_options
[j
];
371 /* Do not pass on frontend specific flags not suitable for lto. */
372 if (!(cl_options
[option
->opt_index
].flags
373 & (CL_COMMON
|CL_TARGET
|CL_DRIVER
|CL_LTO
)))
376 switch (option
->opt_index
)
379 linker_output
= option
->arg
;
380 /* We generate new intermediate output, drop this arg. */
391 case OPT_flto_partition_none
:
396 if (strcmp (option
->arg
, "jobserver") == 0)
403 parallel
= atoi (option
->arg
);
410 lto_mode
= LTO_MODE_WHOPR
;
411 /* We've handled these LTO options, do not pass them on. */
418 /* Pass the option on. */
419 for (i
= 0; i
< option
->canonical_option_num_elements
; ++i
)
420 obstack_ptr_grow (&argv_obstack
, option
->canonical_option
[i
]);
425 lto_mode
= LTO_MODE_LTO
;
432 char *output_dir
, *base
, *name
;
433 bool bit_bucket
= strcmp (linker_output
, HOST_BIT_BUCKET
) == 0;
435 output_dir
= xstrdup (linker_output
);
437 for (name
= base
; *name
; name
++)
438 if (IS_DIR_SEPARATOR (*name
))
442 linker_output
= &linker_output
[base
- output_dir
];
443 if (*output_dir
== '\0')
445 static char current_dir
[] = { '.', DIR_SEPARATOR
, '\0' };
446 output_dir
= current_dir
;
450 obstack_ptr_grow (&argv_obstack
, "-dumpdir");
451 obstack_ptr_grow (&argv_obstack
, output_dir
);
454 obstack_ptr_grow (&argv_obstack
, "-dumpbase");
457 /* Remember at which point we can scrub args to re-use the commons. */
458 new_head_argc
= obstack_object_size (&argv_obstack
) / sizeof (void *);
460 if (lto_mode
== LTO_MODE_LTO
)
462 flto_out
= make_temp_file (".lto.o");
464 obstack_ptr_grow (&argv_obstack
, linker_output
);
465 obstack_ptr_grow (&argv_obstack
, "-o");
466 obstack_ptr_grow (&argv_obstack
, flto_out
);
470 const char *list_option
= "-fltrans-output-list=";
471 size_t list_option_len
= strlen (list_option
);
476 char *dumpbase
= (char *) xmalloc (strlen (linker_output
)
477 + sizeof (".wpa") + 1);
478 strcpy (dumpbase
, linker_output
);
479 strcat (dumpbase
, ".wpa");
480 obstack_ptr_grow (&argv_obstack
, dumpbase
);
483 if (linker_output
&& debug
)
485 ltrans_output_file
= (char *) xmalloc (strlen (linker_output
)
486 + sizeof (".ltrans.out") + 1);
487 strcpy (ltrans_output_file
, linker_output
);
488 strcat (ltrans_output_file
, ".ltrans.out");
491 ltrans_output_file
= make_temp_file (".ltrans.out");
492 list_option_full
= (char *) xmalloc (sizeof (char) *
493 (strlen (ltrans_output_file
) + list_option_len
+ 1));
494 tmp
= list_option_full
;
496 obstack_ptr_grow (&argv_obstack
, tmp
);
497 strcpy (tmp
, list_option
);
498 tmp
+= list_option_len
;
499 strcpy (tmp
, ltrans_output_file
);
501 obstack_ptr_grow (&argv_obstack
, "-fwpa");
504 /* Append the input objects and possible preceeding arguments. */
505 for (i
= 1; i
< argc
; ++i
)
506 obstack_ptr_grow (&argv_obstack
, argv
[i
]);
507 obstack_ptr_grow (&argv_obstack
, NULL
);
509 new_argv
= XOBFINISH (&argv_obstack
, const char **);
510 argv_ptr
= &new_argv
[new_head_argc
];
511 fork_execute (CONST_CAST (char **, new_argv
));
513 if (lto_mode
== LTO_MODE_LTO
)
515 printf("%s\n", flto_out
);
521 FILE *stream
= fopen (ltrans_output_file
, "r");
522 FILE *mstream
= NULL
;
523 struct obstack env_obstack
;
526 fatal_perror ("fopen: %s", ltrans_output_file
);
528 /* Parse the list of LTRANS inputs from the WPA stage. */
529 obstack_init (&env_obstack
);
533 const unsigned piece
= 32;
534 char *output_name
= NULL
;
535 char *buf
, *input_name
= (char *)xmalloc (piece
);
540 if (!fgets (buf
, piece
, stream
))
542 len
= strlen (input_name
);
543 if (input_name
[len
- 1] != '\n')
545 input_name
= (char *)xrealloc (input_name
, len
+ piece
);
546 buf
= input_name
+ len
;
549 input_name
[len
- 1] = '\0';
551 if (input_name
[0] == '*')
552 output_name
= &input_name
[1];
555 input_names
= (char **)xrealloc (input_names
, nr
* sizeof (char *));
556 output_names
= (char **)xrealloc (output_names
, nr
* sizeof (char *));
557 input_names
[nr
-1] = input_name
;
558 output_names
[nr
-1] = output_name
;
561 maybe_unlink_file (ltrans_output_file
);
562 ltrans_output_file
= NULL
;
566 makefile
= make_temp_file (".mk");
567 mstream
= fopen (makefile
, "w");
570 /* Execute the LTRANS stage for each input file (or prepare a
571 makefile to invoke this in parallel). */
572 for (i
= 0; i
< nr
; ++i
)
575 char *input_name
= input_names
[i
];
576 /* If it's a pass-through file do nothing. */
580 /* Replace the .o suffix with a .ltrans.o suffix and write
581 the resulting name to the LTRANS output list. */
582 obstack_grow (&env_obstack
, input_name
, strlen (input_name
) - 2);
583 obstack_grow (&env_obstack
, ".ltrans.o", sizeof (".ltrans.o"));
584 output_name
= XOBFINISH (&env_obstack
, char *);
586 /* Adjust the dumpbase if the linker output file was seen. */
590 = (char *) xmalloc (strlen (linker_output
)
591 + sizeof(DUMPBASE_SUFFIX
) + 1);
593 strlen (linker_output
) + sizeof(DUMPBASE_SUFFIX
),
594 "%s.ltrans%u", linker_output
, i
);
595 argv_ptr
[0] = dumpbase
;
598 argv_ptr
[1] = "-fltrans";
600 argv_ptr
[3] = output_name
;
601 argv_ptr
[4] = input_name
;
605 fprintf (mstream
, "%s:\n\t@%s ", output_name
, new_argv
[0]);
606 for (j
= 1; new_argv
[j
] != NULL
; ++j
)
607 fprintf (mstream
, " '%s'", new_argv
[j
]);
608 fprintf (mstream
, "\n");
611 fork_execute (CONST_CAST (char **, new_argv
));
613 output_names
[i
] = output_name
;
620 fprintf (mstream
, "all:");
621 for (i
= 0; i
< nr
; ++i
)
622 fprintf (mstream
, " \\\n\t%s", output_names
[i
]);
623 fprintf (mstream
, "\n");
627 /* Avoid passing --jobserver-fd= and similar flags
628 unless jobserver mode is explicitly enabled. */
629 putenv (xstrdup ("MAKEFLAGS="));
630 putenv (xstrdup ("MFLAGS="));
632 new_argv
[0] = getenv ("MAKE");
634 new_argv
[0] = "make";
636 new_argv
[2] = makefile
;
640 snprintf (jobs
, 31, "-j%d", parallel
);
641 new_argv
[i
++] = jobs
;
643 new_argv
[i
++] = "all";
644 new_argv
[i
++] = NULL
;
645 pex
= collect_execute (CONST_CAST (char **, new_argv
));
646 collect_wait (new_argv
[0], pex
);
647 maybe_unlink_file (makefile
);
650 for (i
= 0; i
< nr
; ++i
)
652 fputs (output_names
[i
], stdout
);
654 maybe_unlink_file (input_names
[i
]);
655 free (input_names
[i
]);
660 free (list_option_full
);
661 obstack_free (&env_obstack
, NULL
);
664 obstack_free (&argv_obstack
, NULL
);
671 main (int argc
, char *argv
[])
675 p
= argv
[0] + strlen (argv
[0]);
676 while (p
!= argv
[0] && !IS_DIR_SEPARATOR (p
[-1]))
680 xmalloc_set_program_name (progname
);
684 diagnostic_initialize (global_dc
, 0);
686 if (signal (SIGINT
, SIG_IGN
) != SIG_IGN
)
687 signal (SIGINT
, fatal_signal
);
689 if (signal (SIGHUP
, SIG_IGN
) != SIG_IGN
)
690 signal (SIGHUP
, fatal_signal
);
692 if (signal (SIGTERM
, SIG_IGN
) != SIG_IGN
)
693 signal (SIGTERM
, fatal_signal
);
695 if (signal (SIGPIPE
, SIG_IGN
) != SIG_IGN
)
696 signal (SIGPIPE
, fatal_signal
);
699 /* We *MUST* set SIGCHLD to SIG_DFL so that the wait4() call will
700 receive the signal. A different setting is inheritable */
701 signal (SIGCHLD
, SIG_DFL
);
704 /* We may be called with all the arguments stored in some file and
705 passed with @file. Expand them into argv before processing. */
706 expandargv (&argc
, &argv
);
708 run_gcc (argc
, argv
);