* options.h (class General_options): Define
[external/binutils.git] / gold / gold.cc
1 // gold.cc -- main linker functions
2
3 // Copyright 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
5
6 // This file is part of gold.
7
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
12
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
22
23 #include "gold.h"
24
25 #include <cstdlib>
26 #include <cstdio>
27 #include <cstring>
28 #include <unistd.h>
29 #include <algorithm>
30 #include "libiberty.h"
31
32 #include "options.h"
33 #include "debug.h"
34 #include "workqueue.h"
35 #include "dirsearch.h"
36 #include "readsyms.h"
37 #include "symtab.h"
38 #include "common.h"
39 #include "object.h"
40 #include "layout.h"
41 #include "reloc.h"
42 #include "defstd.h"
43 #include "plugin.h"
44 #include "icf.h"
45 #include "incremental.h"
46
47 namespace gold
48 {
49
50 const char* program_name;
51
52 void
53 gold_exit(bool status)
54 {
55   if (parameters != NULL
56       && parameters->options_valid()
57       && parameters->options().has_plugins())
58     parameters->options().plugins()->cleanup();
59   if (!status && parameters != NULL && parameters->options_valid())
60     unlink_if_ordinary(parameters->options().output_file_name());
61   exit(status ? EXIT_SUCCESS : EXIT_FAILURE);
62 }
63
64 void
65 gold_nomem()
66 {
67   // We are out of memory, so try hard to print a reasonable message.
68   // Note that we don't try to translate this message, since the
69   // translation process itself will require memory.
70
71   // LEN only exists to avoid a pointless warning when write is
72   // declared with warn_use_result, as when compiling with
73   // -D_USE_FORTIFY on GNU/Linux.  Casting to void does not appear to
74   // work, at least not with gcc 4.3.0.
75
76   ssize_t len = write(2, program_name, strlen(program_name));
77   if (len >= 0)
78     {
79       const char* const s = ": out of memory\n";
80       len = write(2, s, strlen(s));
81     }
82   gold_exit(false);
83 }
84
85 // Handle an unreachable case.
86
87 void
88 do_gold_unreachable(const char* filename, int lineno, const char* function)
89 {
90   fprintf(stderr, _("%s: internal error in %s, at %s:%d\n"),
91           program_name, function, filename, lineno);
92   gold_exit(false);
93 }
94
95 // This class arranges to run the functions done in the middle of the
96 // link.  It is just a closure.
97
98 class Middle_runner : public Task_function_runner
99 {
100  public:
101   Middle_runner(const General_options& options,
102                 const Input_objects* input_objects,
103                 Symbol_table* symtab,
104                 Layout* layout, Mapfile* mapfile)
105     : options_(options), input_objects_(input_objects), symtab_(symtab),
106       layout_(layout), mapfile_(mapfile)
107   { }
108
109   void
110   run(Workqueue*, const Task*);
111
112  private:
113   const General_options& options_;
114   const Input_objects* input_objects_;
115   Symbol_table* symtab_;
116   Layout* layout_;
117   Mapfile* mapfile_;
118 };
119
120 void
121 Middle_runner::run(Workqueue* workqueue, const Task* task)
122 {
123   queue_middle_tasks(this->options_, task, this->input_objects_, this->symtab_,
124                      this->layout_, workqueue, this->mapfile_);
125 }
126
127 // This class arranges the tasks to process the relocs for garbage collection.
128
129 class Gc_runner : public Task_function_runner 
130 {
131   public:
132    Gc_runner(const General_options& options,
133              const Input_objects* input_objects,
134              Symbol_table* symtab,
135              Layout* layout, Mapfile* mapfile)
136     : options_(options), input_objects_(input_objects), symtab_(symtab),
137       layout_(layout), mapfile_(mapfile)
138    { }
139
140   void
141   run(Workqueue*, const Task*);
142
143  private:
144   const General_options& options_;
145   const Input_objects* input_objects_;
146   Symbol_table* symtab_;
147   Layout* layout_;
148   Mapfile* mapfile_;
149 };
150
151 void
152 Gc_runner::run(Workqueue* workqueue, const Task* task)
153 {
154   queue_middle_gc_tasks(this->options_, task, this->input_objects_, 
155                         this->symtab_, this->layout_, workqueue, 
156                         this->mapfile_);
157 }
158
159 // Queue up the initial set of tasks for this link job.
160
161 void
162 queue_initial_tasks(const General_options& options,
163                     Dirsearch& search_path,
164                     const Command_line& cmdline,
165                     Workqueue* workqueue, Input_objects* input_objects,
166                     Symbol_table* symtab, Layout* layout, Mapfile* mapfile)
167 {
168   if (cmdline.begin() == cmdline.end())
169     {
170       if (options.printed_version())
171         gold_exit(true);
172       gold_fatal(_("no input files"));
173     }
174
175   int thread_count = options.thread_count_initial();
176   if (thread_count == 0)
177     thread_count = cmdline.number_of_input_files();
178   workqueue->set_thread_count(thread_count);
179
180   if (cmdline.options().incremental())
181     {
182       Incremental_checker incremental_checker(
183           parameters->options().output_file_name());
184       if (incremental_checker.can_incrementally_link_output_file())
185         {
186           // TODO: remove when incremental linking implemented.
187           printf("Incremental linking might be possible "
188               "(not implemented yet)\n");
189         }
190       // TODO: If we decide on an incremental build, fewer tasks
191       // should be scheduled.
192     }
193
194   // Read the input files.  We have to add the symbols to the symbol
195   // table in order.  We do this by creating a separate blocker for
196   // each input file.  We associate the blocker with the following
197   // input file, to give us a convenient place to delete it.
198   Task_token* this_blocker = NULL;
199   for (Command_line::const_iterator p = cmdline.begin();
200        p != cmdline.end();
201        ++p)
202     {
203       Task_token* next_blocker = new Task_token(true);
204       next_blocker->add_blocker();
205       workqueue->queue(new Read_symbols(input_objects, symtab, layout,
206                                         &search_path, 0, mapfile, &*p, NULL,
207                                         this_blocker, next_blocker));
208       this_blocker = next_blocker;
209     }
210
211   if (options.has_plugins())
212     {
213       Task_token* next_blocker = new Task_token(true);
214       next_blocker->add_blocker();
215       workqueue->queue(new Plugin_hook(options, input_objects, symtab, layout,
216                                        &search_path, mapfile, this_blocker,
217                                        next_blocker));
218       this_blocker = next_blocker;
219     }
220
221   if (parameters->options().relocatable()
222       && (parameters->options().gc_sections() || parameters->options().icf()))
223     gold_error(_("cannot mix -r with --gc-sections or --icf"));
224
225   if (parameters->options().gc_sections() || parameters->options().icf())
226     {
227       workqueue->queue(new Task_function(new Gc_runner(options,
228                                                        input_objects,
229                                                        symtab,
230                                                        layout,
231                                                        mapfile),
232                                          this_blocker,
233                                          "Task_function Gc_runner"));
234     }
235   else
236     {
237       workqueue->queue(new Task_function(new Middle_runner(options,
238                                                            input_objects,
239                                                            symtab,
240                                                            layout,
241                                                            mapfile),
242                                          this_blocker,
243                                          "Task_function Middle_runner"));
244     }
245 }
246
247 // Queue up a set of tasks to be done before queueing the middle set
248 // of tasks.  This is only necessary when garbage collection
249 // (--gc-sections) of unused sections is desired.  The relocs are read
250 // and processed here early to determine the garbage sections before the
251 // relocs can be scanned in later tasks.
252
253 void
254 queue_middle_gc_tasks(const General_options& options,
255                       const Task* ,
256                       const Input_objects* input_objects,
257                       Symbol_table* symtab,
258                       Layout* layout,
259                       Workqueue* workqueue,
260                       Mapfile* mapfile)
261 {
262   // Read_relocs for all the objects must be done and processed to find
263   // unused sections before any scanning of the relocs can take place.
264   Task_token* blocker = new Task_token(true);
265   Task_token* symtab_lock = new Task_token(false);
266   for (Input_objects::Relobj_iterator p = input_objects->relobj_begin();
267        p != input_objects->relobj_end();
268        ++p)
269     {
270       // We can read and process the relocations in any order.  
271       blocker->add_blocker();
272       workqueue->queue(new Read_relocs(options, symtab, layout, *p,
273                                        symtab_lock, blocker));
274     }
275
276   Task_token* this_blocker = new Task_token(true);
277   workqueue->queue(new Task_function(new Middle_runner(options,
278                                                        input_objects,
279                                                        symtab,
280                                                        layout,
281                                                        mapfile),
282                                      this_blocker,
283                                      "Task_function Middle_runner"));
284 }
285
286 // Queue up the middle set of tasks.  These are the tasks which run
287 // after all the input objects have been found and all the symbols
288 // have been read, but before we lay out the output file.
289
290 void
291 queue_middle_tasks(const General_options& options,
292                    const Task* task,
293                    const Input_objects* input_objects,
294                    Symbol_table* symtab,
295                    Layout* layout,
296                    Workqueue* workqueue,
297                    Mapfile* mapfile)
298 {
299   // Add any symbols named with -u options to the symbol table.
300   symtab->add_undefined_symbols_from_command_line();
301
302   // If garbage collection was chosen, relocs have been read and processed
303   // at this point by pre_middle_tasks.  Layout can then be done for all 
304   // objects.
305   if (parameters->options().gc_sections())
306     {
307       // Find the start symbol if any.
308       Symbol* start_sym;
309       if (parameters->options().entry())
310         start_sym = symtab->lookup(parameters->options().entry());
311       else
312         start_sym = symtab->lookup("_start");
313       if (start_sym !=NULL)
314         {
315           bool is_ordinary;
316           unsigned int shndx = start_sym->shndx(&is_ordinary);
317           if (is_ordinary) 
318             {
319               symtab->gc()->worklist().push(
320                 Section_id(start_sym->object(), shndx));
321             }
322         }
323       // Symbols named with -u should not be considered garbage.
324       symtab->gc_mark_undef_symbols();
325       gold_assert(symtab->gc() != NULL);
326       // Do a transitive closure on all references to determine the worklist.
327       symtab->gc()->do_transitive_closure();
328     }
329
330   // If identical code folding (--icf) is chosen it makes sense to do it 
331   // only after garbage collection (--gc-sections) as we do not want to 
332   // be folding sections that will be garbage.
333   if (parameters->options().icf())
334     {
335       symtab->icf()->find_identical_sections(input_objects, symtab);
336     }
337
338   // Call Object::layout for the second time to determine the 
339   // output_sections for all referenced input sections.  When 
340   // --gc-sections or --icf is turned on, Object::layout is 
341   // called twice.  It is called the first time when the 
342   // symbols are added.
343   if (parameters->options().gc_sections() || parameters->options().icf())
344     {
345       for (Input_objects::Relobj_iterator p = input_objects->relobj_begin();
346            p != input_objects->relobj_end();
347            ++p)
348         {
349           (*p)->layout(symtab, layout, NULL);
350         }
351     }
352
353   // Layout deferred objects due to plugins.
354   if (parameters->options().has_plugins())
355     {
356       Plugin_manager* plugins = parameters->options().plugins();
357       gold_assert(plugins != NULL);
358       plugins->layout_deferred_objects();
359     }     
360
361   if (parameters->options().gc_sections() || parameters->options().icf())
362     {
363       for (Input_objects::Relobj_iterator p = input_objects->relobj_begin();
364            p != input_objects->relobj_end();
365            ++p)
366         {
367           // Update the value of output_section stored in rd.
368           Read_relocs_data *rd = (*p)->get_relocs_data();
369           for (Read_relocs_data::Relocs_list::iterator q = rd->relocs.begin();
370                q != rd->relocs.end();
371                ++q)
372             {
373               q->output_section = (*p)->output_section(q->data_shndx);
374               q->needs_special_offset_handling = 
375                       (*p)->is_output_section_offset_invalid(q->data_shndx);
376             }
377         }
378     }
379
380   // We have to support the case of not seeing any input objects, and
381   // generate an empty file.  Existing builds depend on being able to
382   // pass an empty archive to the linker and get an empty object file
383   // out.  In order to do this we need to use a default target.
384   if (input_objects->number_of_input_objects() == 0)
385     parameters_force_valid_target();
386
387   int thread_count = options.thread_count_middle();
388   if (thread_count == 0)
389     thread_count = std::max(2, input_objects->number_of_input_objects());
390   workqueue->set_thread_count(thread_count);
391
392   // Now we have seen all the input files.
393   const bool doing_static_link = (!input_objects->any_dynamic()
394                                   && !parameters->options().shared());
395   set_parameters_doing_static_link(doing_static_link);
396   if (!doing_static_link && options.is_static())
397     {
398       // We print out just the first .so we see; there may be others.
399       gold_assert(input_objects->dynobj_begin() != input_objects->dynobj_end());
400       gold_error(_("cannot mix -static with dynamic object %s"),
401                  (*input_objects->dynobj_begin())->name().c_str());
402     }
403   if (!doing_static_link && parameters->options().relocatable())
404     gold_fatal(_("cannot mix -r with dynamic object %s"),
405                (*input_objects->dynobj_begin())->name().c_str());
406   if (!doing_static_link
407       && options.oformat_enum() != General_options::OBJECT_FORMAT_ELF)
408     gold_fatal(_("cannot use non-ELF output format with dynamic object %s"),
409                (*input_objects->dynobj_begin())->name().c_str());
410
411   if (parameters->options().relocatable())
412     {
413       Input_objects::Relobj_iterator p = input_objects->relobj_begin();
414       if (p != input_objects->relobj_end())
415         {
416           bool uses_split_stack = (*p)->uses_split_stack();
417           for (++p; p != input_objects->relobj_end(); ++p)
418             {
419               if ((*p)->uses_split_stack() != uses_split_stack)
420                 gold_fatal(_("cannot mix split-stack '%s' and "
421                              "non-split-stack '%s' when using -r"),
422                            (*input_objects->relobj_begin())->name().c_str(),
423                            (*p)->name().c_str());
424             }
425         }
426     }
427
428   if (is_debugging_enabled(DEBUG_SCRIPT))
429     layout->script_options()->print(stderr);
430
431   // For each dynamic object, record whether we've seen all the
432   // dynamic objects that it depends upon.
433   input_objects->check_dynamic_dependencies();
434
435   // See if any of the input definitions violate the One Definition Rule.
436   // TODO: if this is too slow, do this as a task, rather than inline.
437   symtab->detect_odr_violations(task, options.output_file_name());
438
439   // Create any automatic note sections.
440   layout->create_notes();
441
442   // Create any output sections required by any linker script.
443   layout->create_script_sections();
444
445   // Define some sections and symbols needed for a dynamic link.  This
446   // handles some cases we want to see before we read the relocs.
447   layout->create_initial_dynamic_sections(symtab);
448
449   // Define symbols from any linker scripts.
450   layout->define_script_symbols(symtab);
451
452   // Attach sections to segments.
453   layout->attach_sections_to_segments();
454
455   if (!parameters->options().relocatable())
456     {
457       // Predefine standard symbols.
458       define_standard_symbols(symtab, layout);
459
460       // Define __start and __stop symbols for output sections where
461       // appropriate.
462       layout->define_section_symbols(symtab);
463     }
464
465   // Make sure we have symbols for any required group signatures.
466   layout->define_group_signatures(symtab);
467
468   Task_token* blocker = new Task_token(true);
469   Task_token* symtab_lock = new Task_token(false);
470
471   // If doing garbage collection, the relocations have already been read.
472   // Otherwise, read and scan the relocations.
473   if (parameters->options().gc_sections() || parameters->options().icf())
474     {
475       for (Input_objects::Relobj_iterator p = input_objects->relobj_begin();
476            p != input_objects->relobj_end();
477            ++p)
478         {
479           blocker->add_blocker();
480           workqueue->queue(new Scan_relocs(options, symtab, layout, *p, 
481                            (*p)->get_relocs_data(),symtab_lock, blocker));
482         }
483     }
484   else
485     {
486       // Read the relocations of the input files.  We do this to find
487       // which symbols are used by relocations which require a GOT and/or
488       // a PLT entry, or a COPY reloc.  When we implement garbage
489       // collection we will do it here by reading the relocations in a
490       // breadth first search by references.
491       //
492       // We could also read the relocations during the first pass, and
493       // mark symbols at that time.  That is how the old GNU linker works.
494       // Doing that is more complex, since we may later decide to discard
495       // some of the sections, and thus change our minds about the types
496       // of references made to the symbols.
497       for (Input_objects::Relobj_iterator p = input_objects->relobj_begin();
498            p != input_objects->relobj_end();
499            ++p)
500         {
501           // We can read and process the relocations in any order.  But we
502           // only want one task to write to the symbol table at a time.
503           // So we queue up a task for each object to read the
504           // relocations.  That task will in turn queue a task to wait
505           // until it can write to the symbol table.
506           blocker->add_blocker();
507           workqueue->queue(new Read_relocs(options, symtab, layout, *p,
508                    symtab_lock, blocker));
509         }
510     }
511
512   // Allocate common symbols.  This requires write access to the
513   // symbol table, but is independent of the relocation processing.
514   if (parameters->options().define_common())
515     {
516       blocker->add_blocker();
517       workqueue->queue(new Allocate_commons_task(symtab, layout, mapfile,
518                                                  symtab_lock, blocker));
519     }
520
521   // When all those tasks are complete, we can start laying out the
522   // output file.
523   // TODO(csilvers): figure out a more principled way to get the target
524   Target* target = const_cast<Target*>(&parameters->target());
525   workqueue->queue(new Task_function(new Layout_task_runner(options,
526                                                             input_objects,
527                                                             symtab,
528                                                             target,
529                                                             layout,
530                                                             mapfile),
531                                      blocker,
532                                      "Task_function Layout_task_runner"));
533 }
534
535 // Queue up the final set of tasks.  This is called at the end of
536 // Layout_task.
537
538 void
539 queue_final_tasks(const General_options& options,
540                   const Input_objects* input_objects,
541                   const Symbol_table* symtab,
542                   Layout* layout,
543                   Workqueue* workqueue,
544                   Output_file* of)
545 {
546   int thread_count = options.thread_count_final();
547   if (thread_count == 0)
548     thread_count = std::max(2, input_objects->number_of_input_objects());
549   workqueue->set_thread_count(thread_count);
550
551   bool any_postprocessing_sections = layout->any_postprocessing_sections();
552
553   // Use a blocker to wait until all the input sections have been
554   // written out.
555   Task_token* input_sections_blocker = NULL;
556   if (!any_postprocessing_sections)
557     input_sections_blocker = new Task_token(true);
558
559   // Use a blocker to block any objects which have to wait for the
560   // output sections to complete before they can apply relocations.
561   Task_token* output_sections_blocker = new Task_token(true);
562
563   // Use a blocker to block the final cleanup task.
564   Task_token* final_blocker = new Task_token(true);
565
566   // Queue a task to write out the symbol table.
567   final_blocker->add_blocker();
568   workqueue->queue(new Write_symbols_task(layout,
569                                           symtab,
570                                           input_objects,
571                                           layout->sympool(),
572                                           layout->dynpool(),
573                                           of,
574                                           final_blocker));
575
576   // Queue a task to write out the output sections.
577   output_sections_blocker->add_blocker();
578   final_blocker->add_blocker();
579   workqueue->queue(new Write_sections_task(layout, of, output_sections_blocker,
580                                            final_blocker));
581
582   // Queue a task to write out everything else.
583   final_blocker->add_blocker();
584   workqueue->queue(new Write_data_task(layout, symtab, of, final_blocker));
585
586   // Queue a task for each input object to relocate the sections and
587   // write out the local symbols.
588   for (Input_objects::Relobj_iterator p = input_objects->relobj_begin();
589        p != input_objects->relobj_end();
590        ++p)
591     {
592       if (input_sections_blocker != NULL)
593         input_sections_blocker->add_blocker();
594       final_blocker->add_blocker();
595       workqueue->queue(new Relocate_task(options, symtab, layout, *p, of,
596                                          input_sections_blocker,
597                                          output_sections_blocker,
598                                          final_blocker));
599     }
600
601   // Queue a task to write out the output sections which depend on
602   // input sections.  If there are any sections which require
603   // postprocessing, then we need to do this last, since it may resize
604   // the output file.
605   if (!any_postprocessing_sections)
606     {
607       final_blocker->add_blocker();
608       Task* t = new Write_after_input_sections_task(layout, of,
609                                                     input_sections_blocker,
610                                                     final_blocker);
611       workqueue->queue(t);
612     }
613   else
614     {
615       Task_token *new_final_blocker = new Task_token(true);
616       new_final_blocker->add_blocker();
617       Task* t = new Write_after_input_sections_task(layout, of,
618                                                     final_blocker,
619                                                     new_final_blocker);
620       workqueue->queue(t);
621       final_blocker = new_final_blocker;
622     }
623
624   // Queue a task to close the output file.  This will be blocked by
625   // FINAL_BLOCKER.
626   workqueue->queue(new Task_function(new Close_task_runner(&options, layout,
627                                                            of),
628                                      final_blocker,
629                                      "Task_function Close_task_runner"));
630 }
631
632 } // End namespace gold.