Add threading support.
[external/binutils.git] / gold / layout.h
1 // layout.h -- lay out output file sections for gold  -*- C++ -*-
2
3 // Copyright 2006, 2007 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 #ifndef GOLD_LAYOUT_H
24 #define GOLD_LAYOUT_H
25
26 #include <list>
27 #include <string>
28 #include <utility>
29 #include <vector>
30
31 #include "workqueue.h"
32 #include "object.h"
33 #include "dynobj.h"
34 #include "stringpool.h"
35
36 namespace gold
37 {
38
39 class General_options;
40 class Input_objects;
41 class Symbol_table;
42 class Output_section_data;
43 class Output_section;
44 class Output_section_headers;
45 class Output_segment;
46 class Output_data;
47 class Output_data_dynamic;
48 class Eh_frame;
49 class Target;
50
51 // This task function handles mapping the input sections to output
52 // sections and laying them out in memory.
53
54 class Layout_task_runner : public Task_function_runner
55 {
56  public:
57   // OPTIONS is the command line options, INPUT_OBJECTS is the list of
58   // input objects, SYMTAB is the symbol table, LAYOUT is the layout
59   // object.
60   Layout_task_runner(const General_options& options,
61                      const Input_objects* input_objects,
62                      Symbol_table* symtab,
63                      Layout* layout)
64     : options_(options), input_objects_(input_objects), symtab_(symtab),
65       layout_(layout)
66   { }
67
68   // Run the operation.
69   void
70   run(Workqueue*);
71
72  private:
73   Layout_task_runner(const Layout_task_runner&);
74   Layout_task_runner& operator=(const Layout_task_runner&);
75
76   const General_options& options_;
77   const Input_objects* input_objects_;
78   Symbol_table* symtab_;
79   Layout* layout_;
80 };
81
82 // This class handles the details of laying out input sections.
83
84 class Layout
85 {
86  public:
87   Layout(const General_options& options);
88
89   // Given an input section SHNDX, named NAME, with data in SHDR, from
90   // the object file OBJECT, return the output section where this
91   // input section should go.  RELOC_SHNDX is the index of a
92   // relocation section which applies to this section, or 0 if none,
93   // or -1U if more than one.  RELOC_TYPE is the type of the
94   // relocation section if there is one.  Set *OFFSET to the offset
95   // within the output section.
96   template<int size, bool big_endian>
97   Output_section*
98   layout(Sized_relobj<size, big_endian> *object, unsigned int shndx,
99          const char* name, const elfcpp::Shdr<size, big_endian>& shdr,
100          unsigned int reloc_shndx, unsigned int reloc_type, off_t* offset);
101
102   // Like layout, only for exception frame sections.  OBJECT is an
103   // object file.  SYMBOLS is the contents of the symbol table
104   // section, with size SYMBOLS_SIZE.  SYMBOL_NAMES is the contents of
105   // the symbol name section, with size SYMBOL_NAMES_SIZE.  SHNDX is a
106   // .eh_frame section in OBJECT.  SHDR is the section header.
107   // RELOC_SHNDX is the index of a relocation section which applies to
108   // this section, or 0 if none, or -1U if more than one.  RELOC_TYPE
109   // is the type of the relocation section if there is one.  This
110   // returns the output section, and sets *OFFSET to the offset.
111   template<int size, bool big_endian>
112   Output_section*
113   layout_eh_frame(Sized_relobj<size, big_endian>* object,
114                   const unsigned char* symbols,
115                   off_t symbols_size,
116                   const unsigned char* symbol_names,
117                   off_t symbol_names_size,
118                   unsigned int shndx,
119                   const elfcpp::Shdr<size, big_endian>& shdr,
120                   unsigned int reloc_shndx, unsigned int reloc_type,
121                   off_t* offset);
122
123   // Handle a GNU stack note.  This is called once per input object
124   // file.  SEEN_GNU_STACK is true if the object file has a
125   // .note.GNU-stack section.  GNU_STACK_FLAGS is the section flags
126   // from that section if there was one.
127   void
128   layout_gnu_stack(bool seen_gnu_stack, uint64_t gnu_stack_flags);
129
130   // Add an Output_section_data to the layout.  This is used for
131   // special sections like the GOT section.
132   void
133   add_output_section_data(const char* name, elfcpp::Elf_Word type,
134                           elfcpp::Elf_Xword flags,
135                           Output_section_data*);
136
137   // Create dynamic sections if necessary.
138   void
139   create_initial_dynamic_sections(const Input_objects*, Symbol_table*);
140
141   // Define __start and __stop symbols for output sections.
142   void
143   define_section_symbols(Symbol_table*, const Target*);
144
145   // Return the Stringpool used for symbol names.
146   const Stringpool*
147   sympool() const
148   { return &this->sympool_; }
149
150   // Return the Stringpool used for dynamic symbol names and dynamic
151   // tags.
152   const Stringpool*
153   dynpool() const
154   { return &this->dynpool_; }
155
156   // Return whether a section is a .gnu.linkonce section, given the
157   // section name.
158   static inline bool
159   is_linkonce(const char* name)
160   { return strncmp(name, ".gnu.linkonce", sizeof(".gnu.linkonce") - 1) == 0; }
161
162   // Record the signature of a comdat section, and return whether to
163   // include it in the link.  The GROUP parameter is true for a
164   // section group signature, false for a signature derived from a
165   // .gnu.linkonce section.
166   bool
167   add_comdat(const char*, bool group);
168
169   // Finalize the layout after all the input sections have been added.
170   off_t
171   finalize(const Input_objects*, Symbol_table*);
172
173   // Return the size of the output file.
174   off_t
175   output_file_size() const
176   { return this->output_file_size_; }
177
178   // Return the TLS segment.  This will return NULL if there isn't
179   // one.
180   Output_segment*
181   tls_segment() const
182   { return this->tls_segment_; }
183
184   // Return the normal symbol table.
185   Output_section*
186   symtab_section() const
187   {
188     gold_assert(this->symtab_section_ != NULL);
189     return this->symtab_section_;
190   }
191
192   // Return the dynamic symbol table.
193   Output_section*
194   dynsym_section() const
195   {
196     gold_assert(this->dynsym_section_ != NULL);
197     return this->dynsym_section_;
198   }
199
200   // Return the dynamic tags.
201   Output_data_dynamic*
202   dynamic_data() const
203   { return this->dynamic_data_; }
204
205   // Write out the output sections.
206   void
207   write_output_sections(Output_file* of) const;
208
209   // Write out data not associated with an input file or the symbol
210   // table.
211   void
212   write_data(const Symbol_table*, Output_file*) const;
213
214   // Write out output sections which can not be written until all the
215   // input sections are complete.
216   void
217   write_sections_after_input_sections(Output_file* of) const;
218
219   // Return an output section named NAME, or NULL if there is none.
220   Output_section*
221   find_output_section(const char* name) const;
222
223   // Return an output segment of type TYPE, with segment flags SET set
224   // and segment flags CLEAR clear.  Return NULL if there is none.
225   Output_segment*
226   find_output_segment(elfcpp::PT type, elfcpp::Elf_Word set,
227                       elfcpp::Elf_Word clear) const;
228
229   // The list of segments.
230
231   typedef std::vector<Output_segment*> Segment_list;
232
233   // The list of sections not attached to a segment.
234
235   typedef std::vector<Output_section*> Section_list;
236
237   // The list of information to write out which is not attached to
238   // either a section or a segment.
239   typedef std::vector<Output_data*> Data_list;
240
241  private:
242   Layout(const Layout&);
243   Layout& operator=(const Layout&);
244
245   // Mapping from .gnu.linkonce section names to output section names.
246   struct Linkonce_mapping
247   {
248     const char* from;
249     int fromlen;
250     const char* to;
251     int tolen;
252   };
253   static const Linkonce_mapping linkonce_mapping[];
254   static const int linkonce_mapping_count;
255
256   // Create a .note section for gold.
257   void
258   create_gold_note();
259
260   // Record whether the stack must be executable.
261   void
262   create_executable_stack_info(const Target*);
263
264   // Find the first read-only PT_LOAD segment, creating one if
265   // necessary.
266   Output_segment*
267   find_first_load_seg();
268
269   // Create the output sections for the symbol table.
270   void
271   create_symtab_sections(const Input_objects*, Symbol_table*, off_t*);
272
273   // Create the .shstrtab section.
274   Output_section*
275   create_shstrtab();
276
277   // Create the section header table.
278   Output_section_headers*
279   create_shdrs(off_t*);
280
281   // Create the dynamic symbol table.
282   void
283   create_dynamic_symtab(const Target*, Symbol_table*, Output_section** pdynstr,
284                         unsigned int* plocal_dynamic_count,
285                         std::vector<Symbol*>* pdynamic_symbols,
286                         Versions* versions);
287
288   // Finish the .dynamic section and PT_DYNAMIC segment.
289   void
290   finish_dynamic_section(const Input_objects*, const Symbol_table*);
291
292   // Create the .interp section and PT_INTERP segment.
293   void
294   create_interp(const Target* target);
295
296   // Create the version sections.
297   void
298   create_version_sections(const Versions*,
299                           const Symbol_table*,
300                           unsigned int local_symcount,
301                           const std::vector<Symbol*>& dynamic_symbols,
302                           const Output_section* dynstr);
303
304   template<int size, bool big_endian>
305   void
306   sized_create_version_sections(const Versions* versions,
307                                 const Symbol_table*,
308                                 unsigned int local_symcount,
309                                 const std::vector<Symbol*>& dynamic_symbols,
310                                 const Output_section* dynstr
311                                 ACCEPT_SIZE_ENDIAN);
312
313   // Return whether to include this section in the link.
314   template<int size, bool big_endian>
315   bool
316   include_section(Sized_relobj<size, big_endian>* object, const char* name,
317                   const elfcpp::Shdr<size, big_endian>&);
318
319   // Return the output section name to use given an input section
320   // name.  Set *PLEN to the length of the name.  *PLEN must be
321   // initialized to the length of NAME.
322   static const char*
323   output_section_name(const char* name, size_t* plen);
324
325   // Return the output section name to use for a linkonce section
326   // name.  PLEN is as for output_section_name.
327   static const char*
328   linkonce_output_name(const char* name, size_t* plen);
329
330   // Return the output section for NAME, TYPE and FLAGS.
331   Output_section*
332   get_output_section(const char* name, Stringpool::Key name_key,
333                      elfcpp::Elf_Word type, elfcpp::Elf_Xword flags);
334
335   // Create a new Output_section.
336   Output_section*
337   make_output_section(const char* name, elfcpp::Elf_Word type,
338                       elfcpp::Elf_Xword flags);
339
340   // Set the final file offsets of all the segments.
341   off_t
342   set_segment_offsets(const Target*, Output_segment*, unsigned int* pshndx);
343
344   // Set the final file offsets of all the sections not associated
345   // with a segment.
346   off_t
347   set_section_offsets(off_t, bool do_bits_sections);
348
349   // Set the final section indexes of all the sections not associated
350   // with a segment.  Returns the next unused index.
351   unsigned int
352   set_section_indexes(unsigned int pshndx);
353
354   // Return whether SEG1 comes before SEG2 in the output file.
355   static bool
356   segment_precedes(const Output_segment* seg1, const Output_segment* seg2);
357
358   // Map from section flags to segment flags.
359   static elfcpp::Elf_Word
360   section_flags_to_segment(elfcpp::Elf_Xword flags);
361
362   // A mapping used for group signatures.
363   typedef Unordered_map<std::string, bool> Signatures;
364
365   // Mapping from input section name/type/flags to output section.  We
366   // use canonicalized strings here.
367
368   typedef std::pair<Stringpool::Key,
369                     std::pair<elfcpp::Elf_Word, elfcpp::Elf_Xword> > Key;
370
371   struct Hash_key
372   {
373     size_t
374     operator()(const Key& k) const;
375   };
376
377   typedef Unordered_map<Key, Output_section*, Hash_key> Section_name_map;
378
379   // A comparison class for segments.
380
381   struct Compare_segments
382   {
383     bool
384     operator()(const Output_segment* seg1, const Output_segment* seg2)
385     { return Layout::segment_precedes(seg1, seg2); }
386   };
387
388   // A reference to the options on the command line.
389   const General_options& options_;
390   // The output section names.
391   Stringpool namepool_;
392   // The output symbol names.
393   Stringpool sympool_;
394   // The dynamic strings, if needed.
395   Stringpool dynpool_;
396   // The list of group sections and linkonce sections which we have seen.
397   Signatures signatures_;
398   // The mapping from input section name/type/flags to output sections.
399   Section_name_map section_name_map_;
400   // The list of output segments.
401   Segment_list segment_list_;
402   // The list of output sections.
403   Section_list section_list_;
404   // The list of output sections which are not attached to any output
405   // segment.
406   Section_list unattached_section_list_;
407   // The list of unattached Output_data objects which require special
408   // handling because they are not Output_sections.
409   Data_list special_output_list_;
410   // A pointer to the PT_TLS segment if there is one.
411   Output_segment* tls_segment_;
412   // The SHT_SYMTAB output section.
413   Output_section* symtab_section_;
414   // The SHT_DYNSYM output section if there is one.
415   Output_section* dynsym_section_;
416   // The SHT_DYNAMIC output section if there is one.
417   Output_section* dynamic_section_;
418   // The dynamic data which goes into dynamic_section_.
419   Output_data_dynamic* dynamic_data_;
420   // The exception frame output section if there is one.
421   Output_section* eh_frame_section_;
422   // The exception frame data for eh_frame_section_.
423   Eh_frame* eh_frame_data_;
424   // The exception frame header output section if there is one.
425   Output_section* eh_frame_hdr_section_;
426   // The size of the output file.
427   off_t output_file_size_;
428   // Whether we have seen an object file marked to require an
429   // executable stack.
430   bool input_requires_executable_stack_;
431   // Whether we have seen at least one object file with an executable
432   // stack marker.
433   bool input_with_gnu_stack_note_;
434   // Whether we have seen at least one object file without an
435   // executable stack marker.
436   bool input_without_gnu_stack_note_;
437 };
438
439 // This task handles writing out data in output sections which is not
440 // part of an input section, or which requires special handling.  When
441 // this is done, it unblocks both output_sections_blocker and
442 // final_blocker.
443
444 class Write_sections_task : public Task
445 {
446  public:
447   Write_sections_task(const Layout* layout, Output_file* of,
448                       Task_token* output_sections_blocker,
449                       Task_token* final_blocker)
450     : layout_(layout), of_(of),
451       output_sections_blocker_(output_sections_blocker),
452       final_blocker_(final_blocker)
453   { }
454
455   // The standard Task methods.
456
457   Is_runnable_type
458   is_runnable(Workqueue*);
459
460   Task_locker*
461   locks(Workqueue*);
462
463   void
464   run(Workqueue*);
465
466   std::string
467   get_name() const
468   { return "Write_sections_task"; }
469
470  private:
471   class Write_sections_locker;
472
473   const Layout* layout_;
474   Output_file* of_;
475   Task_token* output_sections_blocker_;
476   Task_token* final_blocker_;
477 };
478
479 // This task handles writing out data which is not part of a section
480 // or segment.
481
482 class Write_data_task : public Task
483 {
484  public:
485   Write_data_task(const Layout* layout, const Symbol_table* symtab,
486                   Output_file* of, Task_token* final_blocker)
487     : layout_(layout), symtab_(symtab), of_(of), final_blocker_(final_blocker)
488   { }
489
490   // The standard Task methods.
491
492   Is_runnable_type
493   is_runnable(Workqueue*);
494
495   Task_locker*
496   locks(Workqueue*);
497
498   void
499   run(Workqueue*);
500
501   std::string
502   get_name() const
503   { return "Write_data_task"; }
504
505  private:
506   const Layout* layout_;
507   const Symbol_table* symtab_;
508   Output_file* of_;
509   Task_token* final_blocker_;
510 };
511
512 // This task handles writing out the global symbols.
513
514 class Write_symbols_task : public Task
515 {
516  public:
517   Write_symbols_task(const Symbol_table* symtab,
518                      const Input_objects* input_objects,
519                      const Stringpool* sympool, const Stringpool* dynpool,
520                      Output_file* of, Task_token* final_blocker)
521     : symtab_(symtab), input_objects_(input_objects), sympool_(sympool),
522       dynpool_(dynpool), of_(of), final_blocker_(final_blocker)
523   { }
524
525   // The standard Task methods.
526
527   Is_runnable_type
528   is_runnable(Workqueue*);
529
530   Task_locker*
531   locks(Workqueue*);
532
533   void
534   run(Workqueue*);
535
536   std::string
537   get_name() const
538   { return "Write_symbols_task"; }
539
540  private:
541   const Symbol_table* symtab_;
542   const Input_objects* input_objects_;
543   const Stringpool* sympool_;
544   const Stringpool* dynpool_;
545   Output_file* of_;
546   Task_token* final_blocker_;
547 };
548
549 // This task handles writing out data in output sections which can't
550 // be written out until all the input sections have been handled.
551 // This is for sections whose contents is based on the contents of
552 // other output sections.
553
554 class Write_after_input_sections_task : public Task
555 {
556  public:
557   Write_after_input_sections_task(const Layout* layout, Output_file* of,
558                                   Task_token* input_sections_blocker,
559                                   Task_token* final_blocker)
560     : layout_(layout), of_(of),
561       input_sections_blocker_(input_sections_blocker),
562       final_blocker_(final_blocker)
563   { }
564
565   // The standard Task methods.
566
567   Is_runnable_type
568   is_runnable(Workqueue*);
569
570   Task_locker*
571   locks(Workqueue*);
572
573   void
574   run(Workqueue*);
575
576   std::string
577   get_name() const
578   { return "Write_after_input_sections_task"; }
579
580  private:
581   class Write_sections_locker;
582
583   const Layout* layout_;
584   Output_file* of_;
585   Task_token* input_sections_blocker_;
586   Task_token* final_blocker_;
587 };
588
589 // This task function handles closing the file.
590
591 class Close_task_runner : public Task_function_runner
592 {
593  public:
594   Close_task_runner(Output_file* of)
595     : of_(of)
596   { }
597
598   // Run the operation.
599   void
600   run(Workqueue*);
601
602  private:
603   Output_file* of_;
604 };
605
606 // A small helper function to align an address.
607
608 inline uint64_t
609 align_address(uint64_t address, uint64_t addralign)
610 {
611   if (addralign != 0)
612     address = (address + addralign - 1) &~ (addralign - 1);
613   return address;
614 }
615
616 } // End namespace gold.
617
618 #endif // !defined(GOLD_LAYOUT_H)