1 // output.h -- manage the output file for gold -*- C++ -*-
3 // Copyright 2006, 2007 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
6 // This file is part of gold.
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.
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.
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.
31 #include "reloc-types.h"
36 class General_options
;
42 template<int size
, bool big_endian
>
44 template<int size
, bool big_endian
>
47 // An abtract class for data which has to go into the output file.
52 explicit Output_data()
53 : address_(0), data_size_(0), offset_(-1),
54 is_address_valid_(false), is_data_size_valid_(false),
55 is_offset_valid_(false),
56 dynamic_reloc_count_(0)
62 // Return the address. For allocated sections, this is only valid
63 // after Layout::finalize is finished.
67 gold_assert(this->is_address_valid_
);
68 return this->address_
;
71 // Return the size of the data. For allocated sections, this must
72 // be valid after Layout::finalize calls set_address, but need not
73 // be valid before then.
77 gold_assert(this->is_data_size_valid_
);
78 return this->data_size_
;
81 // Return the file offset. This is only valid after
82 // Layout::finalize is finished. For some non-allocated sections,
83 // it may not be valid until near the end of the link.
87 gold_assert(this->is_offset_valid_
);
91 // Return the required alignment.
94 { return this->do_addralign(); }
96 // Return whether this is an Output_section.
99 { return this->do_is_section(); }
101 // Return whether this is an Output_section of the specified type.
103 is_section_type(elfcpp::Elf_Word stt
) const
104 { return this->do_is_section_type(stt
); }
106 // Return whether this is an Output_section with the specified flag
109 is_section_flag_set(elfcpp::Elf_Xword shf
) const
110 { return this->do_is_section_flag_set(shf
); }
112 // Return the output section index, if there is an output section.
115 { return this->do_out_shndx(); }
117 // Set the output section index, if this is an output section.
119 set_out_shndx(unsigned int shndx
)
120 { this->do_set_out_shndx(shndx
); }
122 // Set the address and file offset of this data, and finalize the
123 // size of the data. This is called during Layout::finalize for
124 // allocated sections.
126 set_address_and_file_offset(uint64_t addr
, off_t off
)
128 this->set_address(addr
);
129 this->set_file_offset(off
);
130 this->finalize_data_size();
135 set_address(uint64_t addr
)
137 gold_assert(!this->is_address_valid_
);
138 this->address_
= addr
;
139 this->is_address_valid_
= true;
142 // Set the file offset.
144 set_file_offset(off_t off
)
146 gold_assert(!this->is_offset_valid_
);
148 this->is_offset_valid_
= true;
151 // Finalize the data size.
155 if (!this->is_data_size_valid_
)
157 // Tell the child class to set the data size.
158 this->set_final_data_size();
159 gold_assert(this->is_data_size_valid_
);
163 // Set the TLS offset. Called only for SHT_TLS sections.
165 set_tls_offset(uint64_t tls_base
)
166 { this->do_set_tls_offset(tls_base
); }
168 // Return the TLS offset, relative to the base of the TLS segment.
169 // Valid only for SHT_TLS sections.
172 { return this->do_tls_offset(); }
174 // Write the data to the output file. This is called after
175 // Layout::finalize is complete.
177 write(Output_file
* file
)
178 { this->do_write(file
); }
180 // This is called by Layout::finalize to note that the sizes of
181 // allocated sections must now be fixed.
184 { Output_data::allocated_sizes_are_fixed
= true; }
186 // Used to check that layout has been done.
189 { return Output_data::allocated_sizes_are_fixed
; }
191 // Count the number of dynamic relocations applied to this section.
194 { ++this->dynamic_reloc_count_
; }
196 // Return the number of dynamic relocations applied to this section.
198 dynamic_reloc_count() const
199 { return this->dynamic_reloc_count_
; }
202 // Functions that child classes may or in some cases must implement.
204 // Write the data to the output file.
206 do_write(Output_file
*) = 0;
208 // Return the required alignment.
210 do_addralign() const = 0;
212 // Return whether this is an Output_section.
214 do_is_section() const
217 // Return whether this is an Output_section of the specified type.
218 // This only needs to be implement by Output_section.
220 do_is_section_type(elfcpp::Elf_Word
) const
223 // Return whether this is an Output_section with the specific flag
224 // set. This only needs to be implemented by Output_section.
226 do_is_section_flag_set(elfcpp::Elf_Xword
) const
229 // Return the output section index, if there is an output section.
232 { gold_unreachable(); }
234 // Set the output section index, if this is an output section.
236 do_set_out_shndx(unsigned int)
237 { gold_unreachable(); }
239 // This is a hook for derived classes to set the data size. This is
240 // called by finalize_data_size, normally called during
241 // Layout::finalize, when the section address is set.
243 set_final_data_size()
244 { gold_unreachable(); }
246 // Set the TLS offset. Called only for SHT_TLS sections.
248 do_set_tls_offset(uint64_t)
249 { gold_unreachable(); }
251 // Return the TLS offset, relative to the base of the TLS segment.
252 // Valid only for SHT_TLS sections.
254 do_tls_offset() const
255 { gold_unreachable(); }
257 // Functions that child classes may call.
259 // Whether the address is valid.
261 is_address_valid() const
262 { return this->is_address_valid_
; }
264 // Whether the file offset is valid.
266 is_offset_valid() const
267 { return this->is_offset_valid_
; }
269 // Whether the data size is valid.
271 is_data_size_valid() const
272 { return this->is_data_size_valid_
; }
274 // Set the size of the data.
276 set_data_size(off_t data_size
)
278 gold_assert(!this->is_data_size_valid_
);
279 this->data_size_
= data_size
;
280 this->is_data_size_valid_
= true;
283 // Get the current data size--this is for the convenience of
284 // sections which build up their size over time.
286 current_data_size_for_child() const
287 { return this->data_size_
; }
289 // Set the current data size--this is for the convenience of
290 // sections which build up their size over time.
292 set_current_data_size_for_child(off_t data_size
)
294 gold_assert(!this->is_data_size_valid_
);
295 this->data_size_
= data_size
;
298 // Return default alignment for the target size.
302 // Return default alignment for a specified size--32 or 64.
304 default_alignment_for_size(int size
);
307 Output_data(const Output_data
&);
308 Output_data
& operator=(const Output_data
&);
310 // This is used for verification, to make sure that we don't try to
311 // change any sizes of allocated sections after we set the section
313 static bool allocated_sizes_are_fixed
;
315 // Memory address in output file.
317 // Size of data in output file.
319 // File offset of contents in output file.
321 // Whether address_ is valid.
322 bool is_address_valid_
;
323 // Whether data_size_ is valid.
324 bool is_data_size_valid_
;
325 // Whether offset_ is valid.
326 bool is_offset_valid_
;
327 // Count of dynamic relocations applied to this section.
328 unsigned int dynamic_reloc_count_
;
331 // Output the section headers.
333 class Output_section_headers
: public Output_data
336 Output_section_headers(const Layout
*,
337 const Layout::Segment_list
*,
338 const Layout::Section_list
*,
342 // Write the data to the file.
344 do_write(Output_file
*);
346 // Return the required alignment.
349 { return Output_data::default_alignment(); }
352 // Write the data to the file with the right size and endianness.
353 template<int size
, bool big_endian
>
355 do_sized_write(Output_file
*);
357 const Layout
* layout_
;
358 const Layout::Segment_list
* segment_list_
;
359 const Layout::Section_list
* unattached_section_list_
;
360 const Stringpool
* secnamepool_
;
363 // Output the segment headers.
365 class Output_segment_headers
: public Output_data
368 Output_segment_headers(const Layout::Segment_list
& segment_list
);
371 // Write the data to the file.
373 do_write(Output_file
*);
375 // Return the required alignment.
378 { return Output_data::default_alignment(); }
381 // Write the data to the file with the right size and endianness.
382 template<int size
, bool big_endian
>
384 do_sized_write(Output_file
*);
386 const Layout::Segment_list
& segment_list_
;
389 // Output the ELF file header.
391 class Output_file_header
: public Output_data
394 Output_file_header(const Target
*,
396 const Output_segment_headers
*);
398 // Add information about the section headers. We lay out the ELF
399 // file header before we create the section headers.
400 void set_section_info(const Output_section_headers
*,
401 const Output_section
* shstrtab
);
404 // Write the data to the file.
406 do_write(Output_file
*);
408 // Return the required alignment.
411 { return Output_data::default_alignment(); }
414 // Write the data to the file with the right size and endianness.
415 template<int size
, bool big_endian
>
417 do_sized_write(Output_file
*);
419 const Target
* target_
;
420 const Symbol_table
* symtab_
;
421 const Output_segment_headers
* segment_header_
;
422 const Output_section_headers
* section_header_
;
423 const Output_section
* shstrtab_
;
426 // Output sections are mainly comprised of input sections. However,
427 // there are cases where we have data to write out which is not in an
428 // input section. Output_section_data is used in such cases. This is
429 // an abstract base class.
431 class Output_section_data
: public Output_data
434 Output_section_data(off_t data_size
, uint64_t addralign
)
435 : Output_data(), output_section_(NULL
), addralign_(addralign
)
436 { this->set_data_size(data_size
); }
438 Output_section_data(uint64_t addralign
)
439 : Output_data(), output_section_(NULL
), addralign_(addralign
)
442 // Return the output section.
443 const Output_section
*
444 output_section() const
445 { return this->output_section_
; }
447 // Record the output section.
449 set_output_section(Output_section
* os
);
451 // Add an input section, for SHF_MERGE sections. This returns true
452 // if the section was handled.
454 add_input_section(Relobj
* object
, unsigned int shndx
)
455 { return this->do_add_input_section(object
, shndx
); }
457 // Given an input OBJECT, an input section index SHNDX within that
458 // object, and an OFFSET relative to the start of that input
459 // section, return whether or not the corresponding offset within
460 // the output section is known. If this function returns true, it
461 // sets *POUTPUT to the output offset. The value -1 indicates that
462 // this input offset is being discarded.
464 output_offset(const Relobj
* object
, unsigned int shndx
,
465 section_offset_type offset
,
466 section_offset_type
*poutput
) const
467 { return this->do_output_offset(object
, shndx
, offset
, poutput
); }
469 // Write the contents to a buffer. This is used for sections which
470 // require postprocessing, such as compression.
472 write_to_buffer(unsigned char* buffer
)
473 { this->do_write_to_buffer(buffer
); }
476 // The child class must implement do_write.
478 // The child class may implement specific adjustments to the output
481 do_adjust_output_section(Output_section
*)
484 // May be implemented by child class. Return true if the section
487 do_add_input_section(Relobj
*, unsigned int)
488 { gold_unreachable(); }
490 // The child class may implement output_offset.
492 do_output_offset(const Relobj
*, unsigned int, section_offset_type
,
493 section_offset_type
*) const
496 // The child class may implement write_to_buffer. Most child
497 // classes can not appear in a compressed section, and they do not
500 do_write_to_buffer(unsigned char*)
501 { gold_unreachable(); }
503 // Return the required alignment.
506 { return this->addralign_
; }
508 // Return the section index of the output section.
510 do_out_shndx() const;
512 // Set the alignment.
514 set_addralign(uint64_t addralign
)
515 { this->addralign_
= addralign
; }
518 // The output section for this section.
519 const Output_section
* output_section_
;
520 // The required alignment.
524 // Some Output_section_data classes build up their data step by step,
525 // rather than all at once. This class provides an interface for
528 class Output_section_data_build
: public Output_section_data
531 Output_section_data_build(uint64_t addralign
)
532 : Output_section_data(addralign
)
535 // Get the current data size.
537 current_data_size() const
538 { return this->current_data_size_for_child(); }
540 // Set the current data size.
542 set_current_data_size(off_t data_size
)
543 { this->set_current_data_size_for_child(data_size
); }
546 // Set the final data size.
548 set_final_data_size()
549 { this->set_data_size(this->current_data_size_for_child()); }
552 // A simple case of Output_data in which we have constant data to
555 class Output_data_const
: public Output_section_data
558 Output_data_const(const std::string
& data
, uint64_t addralign
)
559 : Output_section_data(data
.size(), addralign
), data_(data
)
562 Output_data_const(const char* p
, off_t len
, uint64_t addralign
)
563 : Output_section_data(len
, addralign
), data_(p
, len
)
566 Output_data_const(const unsigned char* p
, off_t len
, uint64_t addralign
)
567 : Output_section_data(len
, addralign
),
568 data_(reinterpret_cast<const char*>(p
), len
)
572 // Write the data to the output file.
574 do_write(Output_file
*);
576 // Write the data to a buffer.
578 do_write_to_buffer(unsigned char* buffer
)
579 { memcpy(buffer
, this->data_
.data(), this->data_
.size()); }
585 // Another version of Output_data with constant data, in which the
586 // buffer is allocated by the caller.
588 class Output_data_const_buffer
: public Output_section_data
591 Output_data_const_buffer(const unsigned char* p
, off_t len
,
593 : Output_section_data(len
, addralign
), p_(p
)
597 // Write the data the output file.
599 do_write(Output_file
*);
601 // Write the data to a buffer.
603 do_write_to_buffer(unsigned char* buffer
)
604 { memcpy(buffer
, this->p_
, this->data_size()); }
607 const unsigned char* p_
;
610 // A place holder for a fixed amount of data written out via some
613 class Output_data_fixed_space
: public Output_section_data
616 Output_data_fixed_space(off_t data_size
, uint64_t addralign
)
617 : Output_section_data(data_size
, addralign
)
621 // Write out the data--the actual data must be written out
624 do_write(Output_file
*)
628 // A place holder for variable sized data written out via some other
631 class Output_data_space
: public Output_section_data_build
634 explicit Output_data_space(uint64_t addralign
)
635 : Output_section_data_build(addralign
)
638 // Set the alignment.
640 set_space_alignment(uint64_t align
)
641 { this->set_addralign(align
); }
644 // Write out the data--the actual data must be written out
647 do_write(Output_file
*)
651 // A string table which goes into an output section.
653 class Output_data_strtab
: public Output_section_data
656 Output_data_strtab(Stringpool
* strtab
)
657 : Output_section_data(1), strtab_(strtab
)
661 // This is called to set the address and file offset. Here we make
662 // sure that the Stringpool is finalized.
664 set_final_data_size();
666 // Write out the data.
668 do_write(Output_file
*);
670 // Write the data to a buffer.
672 do_write_to_buffer(unsigned char* buffer
)
673 { this->strtab_
->write_to_buffer(buffer
, this->data_size()); }
679 // This POD class is used to represent a single reloc in the output
680 // file. This could be a private class within Output_data_reloc, but
681 // the templatization is complex enough that I broke it out into a
682 // separate class. The class is templatized on either elfcpp::SHT_REL
683 // or elfcpp::SHT_RELA, and also on whether this is a dynamic
684 // relocation or an ordinary relocation.
686 // A relocation can be against a global symbol, a local symbol, an
687 // output section, or the undefined symbol at index 0. We represent
688 // the latter by using a NULL global symbol.
690 template<int sh_type
, bool dynamic
, int size
, bool big_endian
>
693 template<bool dynamic
, int size
, bool big_endian
>
694 class Output_reloc
<elfcpp::SHT_REL
, dynamic
, size
, big_endian
>
697 typedef typename
elfcpp::Elf_types
<size
>::Elf_Addr Address
;
699 // An uninitialized entry. We need this because we want to put
700 // instances of this class into an STL container.
702 : local_sym_index_(INVALID_CODE
)
705 // A reloc against a global symbol.
707 Output_reloc(Symbol
* gsym
, unsigned int type
, Output_data
* od
,
708 Address address
, bool is_relative
);
710 Output_reloc(Symbol
* gsym
, unsigned int type
, Relobj
* relobj
,
711 unsigned int shndx
, Address address
, bool is_relative
);
713 // A reloc against a local symbol.
715 Output_reloc(Sized_relobj
<size
, big_endian
>* relobj
,
716 unsigned int local_sym_index
, unsigned int type
,
717 Output_data
* od
, Address address
, bool is_relative
);
719 Output_reloc(Sized_relobj
<size
, big_endian
>* relobj
,
720 unsigned int local_sym_index
, unsigned int type
,
721 unsigned int shndx
, Address address
, bool is_relative
);
723 // A reloc against the STT_SECTION symbol of an output section.
725 Output_reloc(Output_section
* os
, unsigned int type
, Output_data
* od
,
728 Output_reloc(Output_section
* os
, unsigned int type
, Relobj
* relobj
,
729 unsigned int shndx
, Address address
);
731 // Return TRUE if this is a RELATIVE relocation.
734 { return this->is_relative_
; }
736 // Get the value of the symbol referred to by a Rel relocation.
739 symbol_value() const;
741 // Write the reloc entry to an output view.
743 write(unsigned char* pov
) const;
745 // Write the offset and info fields to Write_rel.
746 template<typename Write_rel
>
747 void write_rel(Write_rel
*) const;
750 // Return the symbol index. We can't do a double template
751 // specialization, so we do a secondary template here.
753 get_symbol_index() const;
755 // Codes for local_sym_index_.
762 // Invalid uninitialized entry.
768 // For a local symbol, the object. We will never generate a
769 // relocation against a local symbol in a dynamic object; that
770 // doesn't make sense. And our callers will always be
771 // templatized, so we use Sized_relobj here.
772 Sized_relobj
<size
, big_endian
>* relobj
;
773 // For a global symbol, the symbol. If this is NULL, it indicates
774 // a relocation against the undefined 0 symbol.
776 // For a relocation against an output section, the output section.
781 // If shndx_ is not INVALID CODE, the object which holds the input
782 // section being used to specify the reloc address.
784 // If shndx_ is INVALID_CODE, the output data being used to
785 // specify the reloc address. This may be NULL if the reloc
786 // address is absolute.
789 // The address offset within the input section or the Output_data.
791 // For a local symbol, the local symbol index. This is GSYM_CODE
792 // for a global symbol, or INVALID_CODE for an uninitialized value.
793 unsigned int local_sym_index_
;
794 // The reloc type--a processor specific code.
795 unsigned int type_
: 31;
796 // True if the relocation is a RELATIVE relocation.
797 bool is_relative_
: 1;
798 // If the reloc address is an input section in an object, the
799 // section index. This is INVALID_CODE if the reloc address is
800 // specified in some other way.
804 // The SHT_RELA version of Output_reloc<>. This is just derived from
805 // the SHT_REL version of Output_reloc, but it adds an addend.
807 template<bool dynamic
, int size
, bool big_endian
>
808 class Output_reloc
<elfcpp::SHT_RELA
, dynamic
, size
, big_endian
>
811 typedef typename
elfcpp::Elf_types
<size
>::Elf_Addr Address
;
812 typedef typename
elfcpp::Elf_types
<size
>::Elf_Addr Addend
;
814 // An uninitialized entry.
819 // A reloc against a global symbol.
821 Output_reloc(Symbol
* gsym
, unsigned int type
, Output_data
* od
,
822 Address address
, Addend addend
, bool is_relative
)
823 : rel_(gsym
, type
, od
, address
, is_relative
), addend_(addend
)
826 Output_reloc(Symbol
* gsym
, unsigned int type
, Relobj
* relobj
,
827 unsigned int shndx
, Address address
, Addend addend
,
829 : rel_(gsym
, type
, relobj
, shndx
, address
, is_relative
), addend_(addend
)
832 // A reloc against a local symbol.
834 Output_reloc(Sized_relobj
<size
, big_endian
>* relobj
,
835 unsigned int local_sym_index
, unsigned int type
,
836 Output_data
* od
, Address address
,
837 Addend addend
, bool is_relative
)
838 : rel_(relobj
, local_sym_index
, type
, od
, address
, is_relative
),
842 Output_reloc(Sized_relobj
<size
, big_endian
>* relobj
,
843 unsigned int local_sym_index
, unsigned int type
,
844 unsigned int shndx
, Address address
,
845 Addend addend
, bool is_relative
)
846 : rel_(relobj
, local_sym_index
, type
, shndx
, address
, is_relative
),
850 // A reloc against the STT_SECTION symbol of an output section.
852 Output_reloc(Output_section
* os
, unsigned int type
, Output_data
* od
,
853 Address address
, Addend addend
)
854 : rel_(os
, type
, od
, address
), addend_(addend
)
857 Output_reloc(Output_section
* os
, unsigned int type
, Relobj
* relobj
,
858 unsigned int shndx
, Address address
, Addend addend
)
859 : rel_(os
, type
, relobj
, shndx
, address
), addend_(addend
)
862 // Write the reloc entry to an output view.
864 write(unsigned char* pov
) const;
868 Output_reloc
<elfcpp::SHT_REL
, dynamic
, size
, big_endian
> rel_
;
873 // Output_data_reloc is used to manage a section containing relocs.
874 // SH_TYPE is either elfcpp::SHT_REL or elfcpp::SHT_RELA. DYNAMIC
875 // indicates whether this is a dynamic relocation or a normal
876 // relocation. Output_data_reloc_base is a base class.
877 // Output_data_reloc is the real class, which we specialize based on
880 template<int sh_type
, bool dynamic
, int size
, bool big_endian
>
881 class Output_data_reloc_base
: public Output_section_data_build
884 typedef Output_reloc
<sh_type
, dynamic
, size
, big_endian
> Output_reloc_type
;
885 typedef typename
Output_reloc_type::Address Address
;
886 static const int reloc_size
=
887 Reloc_types
<sh_type
, size
, big_endian
>::reloc_size
;
889 // Construct the section.
890 Output_data_reloc_base()
891 : Output_section_data_build(Output_data::default_alignment_for_size(size
))
895 // Write out the data.
897 do_write(Output_file
*);
899 // Set the entry size and the link.
901 do_adjust_output_section(Output_section
*os
);
903 // Add a relocation entry.
905 add(Output_data
*od
, const Output_reloc_type
& reloc
)
907 this->relocs_
.push_back(reloc
);
908 this->set_current_data_size(this->relocs_
.size() * reloc_size
);
909 od
->add_dynamic_reloc();
913 typedef std::vector
<Output_reloc_type
> Relocs
;
918 // The class which callers actually create.
920 template<int sh_type
, bool dynamic
, int size
, bool big_endian
>
921 class Output_data_reloc
;
923 // The SHT_REL version of Output_data_reloc.
925 template<bool dynamic
, int size
, bool big_endian
>
926 class Output_data_reloc
<elfcpp::SHT_REL
, dynamic
, size
, big_endian
>
927 : public Output_data_reloc_base
<elfcpp::SHT_REL
, dynamic
, size
, big_endian
>
930 typedef Output_data_reloc_base
<elfcpp::SHT_REL
, dynamic
, size
,
934 typedef typename
Base::Output_reloc_type Output_reloc_type
;
935 typedef typename
Output_reloc_type::Address Address
;
938 : Output_data_reloc_base
<elfcpp::SHT_REL
, dynamic
, size
, big_endian
>()
941 // Add a reloc against a global symbol.
944 add_global(Symbol
* gsym
, unsigned int type
, Output_data
* od
, Address address
)
945 { this->add(od
, Output_reloc_type(gsym
, type
, od
, address
, false)); }
948 add_global(Symbol
* gsym
, unsigned int type
, Output_data
* od
, Relobj
* relobj
,
949 unsigned int shndx
, Address address
)
950 { this->add(od
, Output_reloc_type(gsym
, type
, relobj
, shndx
, address
,
953 // Add a RELATIVE reloc against a global symbol. The final relocation
954 // will not reference the symbol.
957 add_global_relative(Symbol
* gsym
, unsigned int type
, Output_data
* od
,
959 { this->add(od
, Output_reloc_type(gsym
, type
, od
, address
, true)); }
962 add_global_relative(Symbol
* gsym
, unsigned int type
, Output_data
* od
,
963 Relobj
* relobj
, unsigned int shndx
, Address address
)
964 { this->add(od
, Output_reloc_type(gsym
, type
, relobj
, shndx
, address
,
967 // Add a reloc against a local symbol.
970 add_local(Sized_relobj
<size
, big_endian
>* relobj
,
971 unsigned int local_sym_index
, unsigned int type
,
972 Output_data
* od
, Address address
)
973 { this->add(od
, Output_reloc_type(relobj
, local_sym_index
, type
, od
,
977 add_local(Sized_relobj
<size
, big_endian
>* relobj
,
978 unsigned int local_sym_index
, unsigned int type
,
979 Output_data
* od
, unsigned int shndx
, Address address
)
980 { this->add(od
, Output_reloc_type(relobj
, local_sym_index
, type
, shndx
,
983 // Add a RELATIVE reloc against a local symbol.
986 add_local_relative(Sized_relobj
<size
, big_endian
>* relobj
,
987 unsigned int local_sym_index
, unsigned int type
,
988 Output_data
* od
, Address address
)
989 { this->add(od
, Output_reloc_type(relobj
, local_sym_index
, type
, od
,
993 add_local_relative(Sized_relobj
<size
, big_endian
>* relobj
,
994 unsigned int local_sym_index
, unsigned int type
,
995 Output_data
* od
, unsigned int shndx
, Address address
)
996 { this->add(od
, Output_reloc_type(relobj
, local_sym_index
, type
, shndx
,
999 // A reloc against the STT_SECTION symbol of an output section.
1000 // OS is the Output_section that the relocation refers to; OD is
1001 // the Output_data object being relocated.
1004 add_output_section(Output_section
* os
, unsigned int type
,
1005 Output_data
* od
, Address address
)
1006 { this->add(od
, Output_reloc_type(os
, type
, od
, address
)); }
1009 add_output_section(Output_section
* os
, unsigned int type
, Output_data
* od
,
1010 Relobj
* relobj
, unsigned int shndx
, Address address
)
1011 { this->add(od
, Output_reloc_type(os
, type
, relobj
, shndx
, address
)); }
1014 // The SHT_RELA version of Output_data_reloc.
1016 template<bool dynamic
, int size
, bool big_endian
>
1017 class Output_data_reloc
<elfcpp::SHT_RELA
, dynamic
, size
, big_endian
>
1018 : public Output_data_reloc_base
<elfcpp::SHT_RELA
, dynamic
, size
, big_endian
>
1021 typedef Output_data_reloc_base
<elfcpp::SHT_RELA
, dynamic
, size
,
1025 typedef typename
Base::Output_reloc_type Output_reloc_type
;
1026 typedef typename
Output_reloc_type::Address Address
;
1027 typedef typename
Output_reloc_type::Addend Addend
;
1030 : Output_data_reloc_base
<elfcpp::SHT_RELA
, dynamic
, size
, big_endian
>()
1033 // Add a reloc against a global symbol.
1036 add_global(Symbol
* gsym
, unsigned int type
, Output_data
* od
,
1037 Address address
, Addend addend
)
1038 { this->add(od
, Output_reloc_type(gsym
, type
, od
, address
, addend
,
1042 add_global(Symbol
* gsym
, unsigned int type
, Output_data
* od
, Relobj
* relobj
,
1043 unsigned int shndx
, Address address
,
1045 { this->add(od
, Output_reloc_type(gsym
, type
, relobj
, shndx
, address
,
1048 // Add a RELATIVE reloc against a global symbol. The final output
1049 // relocation will not reference the symbol, but we must keep the symbol
1050 // information long enough to set the addend of the relocation correctly
1051 // when it is written.
1054 add_global_relative(Symbol
* gsym
, unsigned int type
, Output_data
* od
,
1055 Address address
, Addend addend
)
1056 { this->add(od
, Output_reloc_type(gsym
, type
, od
, address
, addend
, true)); }
1059 add_global_relative(Symbol
* gsym
, unsigned int type
, Output_data
* od
,
1060 Relobj
* relobj
, unsigned int shndx
, Address address
,
1062 { this->add(od
, Output_reloc_type(gsym
, type
, relobj
, shndx
, address
,
1065 // Add a reloc against a local symbol.
1068 add_local(Sized_relobj
<size
, big_endian
>* relobj
,
1069 unsigned int local_sym_index
, unsigned int type
,
1070 Output_data
* od
, Address address
, Addend addend
)
1072 this->add(od
, Output_reloc_type(relobj
, local_sym_index
, type
, od
, address
,
1077 add_local(Sized_relobj
<size
, big_endian
>* relobj
,
1078 unsigned int local_sym_index
, unsigned int type
,
1079 Output_data
* od
, unsigned int shndx
, Address address
,
1082 this->add(od
, Output_reloc_type(relobj
, local_sym_index
, type
, shndx
,
1083 address
, addend
, false));
1086 // Add a RELATIVE reloc against a local symbol.
1089 add_local_relative(Sized_relobj
<size
, big_endian
>* relobj
,
1090 unsigned int local_sym_index
, unsigned int type
,
1091 Output_data
* od
, Address address
, Addend addend
)
1093 this->add(od
, Output_reloc_type(relobj
, local_sym_index
, type
, od
, address
,
1098 add_local_relative(Sized_relobj
<size
, big_endian
>* relobj
,
1099 unsigned int local_sym_index
, unsigned int type
,
1100 Output_data
* od
, unsigned int shndx
, Address address
,
1103 this->add(od
, Output_reloc_type(relobj
, local_sym_index
, type
, shndx
,
1104 address
, addend
, true));
1107 // A reloc against the STT_SECTION symbol of an output section.
1110 add_output_section(Output_section
* os
, unsigned int type
, Output_data
* od
,
1111 Address address
, Addend addend
)
1112 { this->add(os
, Output_reloc_type(os
, type
, od
, address
, addend
)); }
1115 add_output_section(Output_section
* os
, unsigned int type
, Relobj
* relobj
,
1116 unsigned int shndx
, Address address
, Addend addend
)
1117 { this->add(os
, Output_reloc_type(os
, type
, relobj
, shndx
, address
,
1121 // Output_data_got is used to manage a GOT. Each entry in the GOT is
1122 // for one symbol--either a global symbol or a local symbol in an
1123 // object. The target specific code adds entries to the GOT as
1126 template<int size
, bool big_endian
>
1127 class Output_data_got
: public Output_section_data_build
1130 typedef typename
elfcpp::Elf_types
<size
>::Elf_Addr Valtype
;
1131 typedef Output_data_reloc
<elfcpp::SHT_REL
, true, size
, big_endian
> Rel_dyn
;
1132 typedef Output_data_reloc
<elfcpp::SHT_RELA
, true, size
, big_endian
> Rela_dyn
;
1135 : Output_section_data_build(Output_data::default_alignment_for_size(size
)),
1139 // Add an entry for a global symbol to the GOT. Return true if this
1140 // is a new GOT entry, false if the symbol was already in the GOT.
1142 add_global(Symbol
* gsym
);
1144 // Add an entry for a global symbol to the GOT, and add a dynamic
1145 // relocation of type R_TYPE for the GOT entry.
1147 add_global_with_rel(Symbol
* gsym
, Rel_dyn
* rel_dyn
, unsigned int r_type
);
1150 add_global_with_rela(Symbol
* gsym
, Rela_dyn
* rela_dyn
, unsigned int r_type
);
1152 // Add an entry for a local symbol to the GOT. This returns true if
1153 // this is a new GOT entry, false if the symbol already has a GOT
1156 add_local(Sized_relobj
<size
, big_endian
>* object
, unsigned int sym_index
);
1158 // Add an entry for a global symbol to the GOT, and add a dynamic
1159 // relocation of type R_TYPE for the GOT entry.
1161 add_local_with_rel(Sized_relobj
<size
, big_endian
>* object
,
1162 unsigned int sym_index
, Rel_dyn
* rel_dyn
,
1163 unsigned int r_type
);
1166 add_local_with_rela(Sized_relobj
<size
, big_endian
>* object
,
1167 unsigned int sym_index
, Rela_dyn
* rela_dyn
,
1168 unsigned int r_type
);
1170 // Add an entry (or pair of entries) for a global TLS symbol to the GOT.
1171 // Return true if this is a new GOT entry, false if the symbol was
1172 // already in the GOT.
1174 add_global_tls(Symbol
* gsym
, bool need_pair
);
1176 // Add an entry for a global TLS symbol to the GOT, and add a dynamic
1177 // relocation of type R_TYPE.
1179 add_global_tls_with_rel(Symbol
* gsym
, Rel_dyn
* rel_dyn
,
1180 unsigned int r_type
);
1183 add_global_tls_with_rela(Symbol
* gsym
, Rela_dyn
* rela_dyn
,
1184 unsigned int r_type
);
1186 // Add a pair of entries for a global TLS symbol to the GOT, and add
1187 // dynamic relocations of type MOD_R_TYPE and DTV_R_TYPE, respectively.
1189 add_global_tls_with_rel(Symbol
* gsym
, Rel_dyn
* rel_dyn
,
1190 unsigned int mod_r_type
,
1191 unsigned int dtv_r_type
);
1194 add_global_tls_with_rela(Symbol
* gsym
, Rela_dyn
* rela_dyn
,
1195 unsigned int mod_r_type
,
1196 unsigned int dtv_r_type
);
1198 // Add an entry (or pair of entries) for a local TLS symbol to the GOT.
1199 // This returns true if this is a new GOT entry, false if the symbol
1200 // already has a GOT entry.
1202 add_local_tls(Sized_relobj
<size
, big_endian
>* object
,
1203 unsigned int sym_index
, bool need_pair
);
1205 // Add an entry (or pair of entries) for a local TLS symbol to the GOT,
1206 // and add a dynamic relocation of type R_TYPE for the first GOT entry.
1207 // Because this is a local symbol, the first GOT entry can be relocated
1208 // relative to a section symbol, and the second GOT entry will have an
1209 // dtv-relative value that can be computed at link time.
1211 add_local_tls_with_rel(Sized_relobj
<size
, big_endian
>* object
,
1212 unsigned int sym_index
, unsigned int shndx
,
1213 bool need_pair
, Rel_dyn
* rel_dyn
,
1214 unsigned int r_type
);
1217 add_local_tls_with_rela(Sized_relobj
<size
, big_endian
>* object
,
1218 unsigned int sym_index
, unsigned int shndx
,
1219 bool need_pair
, Rela_dyn
* rela_dyn
,
1220 unsigned int r_type
);
1222 // Add a constant to the GOT. This returns the offset of the new
1223 // entry from the start of the GOT.
1225 add_constant(Valtype constant
)
1227 this->entries_
.push_back(Got_entry(constant
));
1228 this->set_got_size();
1229 return this->last_got_offset();
1233 // Write out the GOT table.
1235 do_write(Output_file
*);
1238 // This POD class holds a single GOT entry.
1242 // Create a zero entry.
1244 : local_sym_index_(CONSTANT_CODE
)
1245 { this->u_
.constant
= 0; }
1247 // Create a global symbol entry.
1248 explicit Got_entry(Symbol
* gsym
)
1249 : local_sym_index_(GSYM_CODE
)
1250 { this->u_
.gsym
= gsym
; }
1252 // Create a local symbol entry.
1253 Got_entry(Sized_relobj
<size
, big_endian
>* object
,
1254 unsigned int local_sym_index
)
1255 : local_sym_index_(local_sym_index
)
1257 gold_assert(local_sym_index
!= GSYM_CODE
1258 && local_sym_index
!= CONSTANT_CODE
);
1259 this->u_
.object
= object
;
1262 // Create a constant entry. The constant is a host value--it will
1263 // be swapped, if necessary, when it is written out.
1264 explicit Got_entry(Valtype constant
)
1265 : local_sym_index_(CONSTANT_CODE
)
1266 { this->u_
.constant
= constant
; }
1268 // Write the GOT entry to an output view.
1270 write(unsigned char* pov
) const;
1281 // For a local symbol, the object.
1282 Sized_relobj
<size
, big_endian
>* object
;
1283 // For a global symbol, the symbol.
1285 // For a constant, the constant.
1288 // For a local symbol, the local symbol index. This is GSYM_CODE
1289 // for a global symbol, or CONSTANT_CODE for a constant.
1290 unsigned int local_sym_index_
;
1293 typedef std::vector
<Got_entry
> Got_entries
;
1295 // Return the offset into the GOT of GOT entry I.
1297 got_offset(unsigned int i
) const
1298 { return i
* (size
/ 8); }
1300 // Return the offset into the GOT of the last entry added.
1302 last_got_offset() const
1303 { return this->got_offset(this->entries_
.size() - 1); }
1305 // Set the size of the section.
1308 { this->set_current_data_size(this->got_offset(this->entries_
.size())); }
1310 // The list of GOT entries.
1311 Got_entries entries_
;
1314 // Output_data_dynamic is used to hold the data in SHT_DYNAMIC
1317 class Output_data_dynamic
: public Output_section_data
1320 Output_data_dynamic(Stringpool
* pool
)
1321 : Output_section_data(Output_data::default_alignment()),
1322 entries_(), pool_(pool
)
1325 // Add a new dynamic entry with a fixed numeric value.
1327 add_constant(elfcpp::DT tag
, unsigned int val
)
1328 { this->add_entry(Dynamic_entry(tag
, val
)); }
1330 // Add a new dynamic entry with the address of output data.
1332 add_section_address(elfcpp::DT tag
, const Output_data
* od
)
1333 { this->add_entry(Dynamic_entry(tag
, od
, false)); }
1335 // Add a new dynamic entry with the size of output data.
1337 add_section_size(elfcpp::DT tag
, const Output_data
* od
)
1338 { this->add_entry(Dynamic_entry(tag
, od
, true)); }
1340 // Add a new dynamic entry with the address of a symbol.
1342 add_symbol(elfcpp::DT tag
, const Symbol
* sym
)
1343 { this->add_entry(Dynamic_entry(tag
, sym
)); }
1345 // Add a new dynamic entry with a string.
1347 add_string(elfcpp::DT tag
, const char* str
)
1348 { this->add_entry(Dynamic_entry(tag
, this->pool_
->add(str
, true, NULL
))); }
1351 add_string(elfcpp::DT tag
, const std::string
& str
)
1352 { this->add_string(tag
, str
.c_str()); }
1355 // Adjust the output section to set the entry size.
1357 do_adjust_output_section(Output_section
*);
1359 // Set the final data size.
1361 set_final_data_size();
1363 // Write out the dynamic entries.
1365 do_write(Output_file
*);
1368 // This POD class holds a single dynamic entry.
1372 // Create an entry with a fixed numeric value.
1373 Dynamic_entry(elfcpp::DT tag
, unsigned int val
)
1374 : tag_(tag
), classification_(DYNAMIC_NUMBER
)
1375 { this->u_
.val
= val
; }
1377 // Create an entry with the size or address of a section.
1378 Dynamic_entry(elfcpp::DT tag
, const Output_data
* od
, bool section_size
)
1380 classification_(section_size
1381 ? DYNAMIC_SECTION_SIZE
1382 : DYNAMIC_SECTION_ADDRESS
)
1383 { this->u_
.od
= od
; }
1385 // Create an entry with the address of a symbol.
1386 Dynamic_entry(elfcpp::DT tag
, const Symbol
* sym
)
1387 : tag_(tag
), classification_(DYNAMIC_SYMBOL
)
1388 { this->u_
.sym
= sym
; }
1390 // Create an entry with a string.
1391 Dynamic_entry(elfcpp::DT tag
, const char* str
)
1392 : tag_(tag
), classification_(DYNAMIC_STRING
)
1393 { this->u_
.str
= str
; }
1395 // Write the dynamic entry to an output view.
1396 template<int size
, bool big_endian
>
1398 write(unsigned char* pov
, const Stringpool
* ACCEPT_SIZE_ENDIAN
) const;
1406 DYNAMIC_SECTION_ADDRESS
,
1408 DYNAMIC_SECTION_SIZE
,
1417 // For DYNAMIC_NUMBER.
1419 // For DYNAMIC_SECTION_ADDRESS and DYNAMIC_SECTION_SIZE.
1420 const Output_data
* od
;
1421 // For DYNAMIC_SYMBOL.
1423 // For DYNAMIC_STRING.
1428 // The type of entry.
1429 Classification classification_
;
1432 // Add an entry to the list.
1434 add_entry(const Dynamic_entry
& entry
)
1435 { this->entries_
.push_back(entry
); }
1437 // Sized version of write function.
1438 template<int size
, bool big_endian
>
1440 sized_write(Output_file
* of
);
1442 // The type of the list of entries.
1443 typedef std::vector
<Dynamic_entry
> Dynamic_entries
;
1446 Dynamic_entries entries_
;
1447 // The pool used for strings.
1451 // An output section. We don't expect to have too many output
1452 // sections, so we don't bother to do a template on the size.
1454 class Output_section
: public Output_data
1457 // Create an output section, giving the name, type, and flags.
1458 Output_section(const char* name
, elfcpp::Elf_Word
, elfcpp::Elf_Xword
);
1459 virtual ~Output_section();
1461 // Add a new input section SHNDX, named NAME, with header SHDR, from
1462 // object OBJECT. RELOC_SHNDX is the index of a relocation section
1463 // which applies to this section, or 0 if none, or -1U if more than
1464 // one. Return the offset within the output section.
1465 template<int size
, bool big_endian
>
1467 add_input_section(Sized_relobj
<size
, big_endian
>* object
, unsigned int shndx
,
1469 const elfcpp::Shdr
<size
, big_endian
>& shdr
,
1470 unsigned int reloc_shndx
);
1472 // Add generated data POSD to this output section.
1474 add_output_section_data(Output_section_data
* posd
);
1476 // Return the section name.
1479 { return this->name_
; }
1481 // Return the section type.
1484 { return this->type_
; }
1486 // Return the section flags.
1489 { return this->flags_
; }
1491 // Return the entsize field.
1494 { return this->entsize_
; }
1496 // Set the entsize field.
1498 set_entsize(uint64_t v
);
1500 // Set the link field to the output section index of a section.
1502 set_link_section(const Output_data
* od
)
1504 gold_assert(this->link_
== 0
1505 && !this->should_link_to_symtab_
1506 && !this->should_link_to_dynsym_
);
1507 this->link_section_
= od
;
1510 // Set the link field to a constant.
1512 set_link(unsigned int v
)
1514 gold_assert(this->link_section_
== NULL
1515 && !this->should_link_to_symtab_
1516 && !this->should_link_to_dynsym_
);
1520 // Record that this section should link to the normal symbol table.
1522 set_should_link_to_symtab()
1524 gold_assert(this->link_section_
== NULL
1526 && !this->should_link_to_dynsym_
);
1527 this->should_link_to_symtab_
= true;
1530 // Record that this section should link to the dynamic symbol table.
1532 set_should_link_to_dynsym()
1534 gold_assert(this->link_section_
== NULL
1536 && !this->should_link_to_symtab_
);
1537 this->should_link_to_dynsym_
= true;
1540 // Return the info field.
1544 gold_assert(this->info_section_
== NULL
);
1548 // Set the info field to the output section index of a section.
1550 set_info_section(const Output_data
* od
)
1552 gold_assert(this->info_
== 0);
1553 this->info_section_
= od
;
1556 // Set the info field to a constant.
1558 set_info(unsigned int v
)
1560 gold_assert(this->info_section_
== NULL
);
1564 // Set the addralign field.
1566 set_addralign(uint64_t v
)
1567 { this->addralign_
= v
; }
1569 // Indicate that we need a symtab index.
1571 set_needs_symtab_index()
1572 { this->needs_symtab_index_
= true; }
1574 // Return whether we need a symtab index.
1576 needs_symtab_index() const
1577 { return this->needs_symtab_index_
; }
1579 // Get the symtab index.
1581 symtab_index() const
1583 gold_assert(this->symtab_index_
!= 0);
1584 return this->symtab_index_
;
1587 // Set the symtab index.
1589 set_symtab_index(unsigned int index
)
1591 gold_assert(index
!= 0);
1592 this->symtab_index_
= index
;
1595 // Indicate that we need a dynsym index.
1597 set_needs_dynsym_index()
1598 { this->needs_dynsym_index_
= true; }
1600 // Return whether we need a dynsym index.
1602 needs_dynsym_index() const
1603 { return this->needs_dynsym_index_
; }
1605 // Get the dynsym index.
1607 dynsym_index() const
1609 gold_assert(this->dynsym_index_
!= 0);
1610 return this->dynsym_index_
;
1613 // Set the dynsym index.
1615 set_dynsym_index(unsigned int index
)
1617 gold_assert(index
!= 0);
1618 this->dynsym_index_
= index
;
1621 // Return whether this section should be written after all the input
1622 // sections are complete.
1624 after_input_sections() const
1625 { return this->after_input_sections_
; }
1627 // Record that this section should be written after all the input
1628 // sections are complete.
1630 set_after_input_sections()
1631 { this->after_input_sections_
= true; }
1633 // Return whether this section requires postprocessing after all
1634 // relocations have been applied.
1636 requires_postprocessing() const
1637 { return this->requires_postprocessing_
; }
1639 // If a section requires postprocessing, return the buffer to use.
1641 postprocessing_buffer() const
1643 gold_assert(this->postprocessing_buffer_
!= NULL
);
1644 return this->postprocessing_buffer_
;
1647 // If a section requires postprocessing, create the buffer to use.
1649 create_postprocessing_buffer();
1651 // If a section requires postprocessing, this is the size of the
1652 // buffer to which relocations should be applied.
1654 postprocessing_buffer_size() const
1655 { return this->current_data_size_for_child(); }
1657 // Return whether the offset OFFSET in the input section SHNDX in
1658 // object OBJECT is being included in the link.
1660 is_input_address_mapped(const Relobj
* object
, unsigned int shndx
,
1661 off_t offset
) const;
1663 // Return the offset within the output section of OFFSET relative to
1664 // the start of input section SHNDX in object OBJECT.
1666 output_offset(const Relobj
* object
, unsigned int shndx
,
1667 section_offset_type offset
) const;
1669 // Return the output virtual address of OFFSET relative to the start
1670 // of input section SHNDX in object OBJECT.
1672 output_address(const Relobj
* object
, unsigned int shndx
,
1673 off_t offset
) const;
1675 // Write the section header into *OPHDR.
1676 template<int size
, bool big_endian
>
1678 write_header(const Layout
*, const Stringpool
*,
1679 elfcpp::Shdr_write
<size
, big_endian
>*) const;
1682 // Return the section index in the output file.
1684 do_out_shndx() const
1686 gold_assert(this->out_shndx_
!= -1U);
1687 return this->out_shndx_
;
1690 // Set the output section index.
1692 do_set_out_shndx(unsigned int shndx
)
1694 gold_assert(this->out_shndx_
== -1U);
1695 this->out_shndx_
= shndx
;
1698 // Set the final data size of the Output_section. For a typical
1699 // Output_section, there is nothing to do, but if there are any
1700 // Output_section_data objects we need to set their final addresses
1703 set_final_data_size();
1705 // Write the data to the file. For a typical Output_section, this
1706 // does nothing: the data is written out by calling Object::Relocate
1707 // on each input object. But if there are any Output_section_data
1708 // objects we do need to write them out here.
1710 do_write(Output_file
*);
1712 // Return the address alignment--function required by parent class.
1714 do_addralign() const
1715 { return this->addralign_
; }
1717 // Return whether this is an Output_section.
1719 do_is_section() const
1722 // Return whether this is a section of the specified type.
1724 do_is_section_type(elfcpp::Elf_Word type
) const
1725 { return this->type_
== type
; }
1727 // Return whether the specified section flag is set.
1729 do_is_section_flag_set(elfcpp::Elf_Xword flag
) const
1730 { return (this->flags_
& flag
) != 0; }
1732 // Set the TLS offset. Called only for SHT_TLS sections.
1734 do_set_tls_offset(uint64_t tls_base
);
1736 // Return the TLS offset, relative to the base of the TLS segment.
1737 // Valid only for SHT_TLS sections.
1739 do_tls_offset() const
1740 { return this->tls_offset_
; }
1742 // Modify the section name. This is only permitted for an
1743 // unallocated section, and only before the size has been finalized.
1744 // Otherwise the name will not get into Layout::namepool_.
1746 set_name(const char* newname
)
1748 gold_assert((this->flags_
& elfcpp::SHF_ALLOC
) == 0);
1749 gold_assert(!this->is_data_size_valid());
1750 this->name_
= newname
;
1753 // This may be implemented by a child class.
1755 do_finalize_name(Layout
*)
1758 // Record that this section requires postprocessing after all
1759 // relocations have been applied. This is called by a child class.
1761 set_requires_postprocessing()
1763 this->requires_postprocessing_
= true;
1764 this->after_input_sections_
= true;
1767 // Write all the data of an Output_section into the postprocessing
1770 write_to_postprocessing_buffer();
1773 // In some cases we need to keep a list of the input sections
1774 // associated with this output section. We only need the list if we
1775 // might have to change the offsets of the input section within the
1776 // output section after we add the input section. The ordinary
1777 // input sections will be written out when we process the object
1778 // file, and as such we don't need to track them here. We do need
1779 // to track Output_section_data objects here. We store instances of
1780 // this structure in a std::vector, so it must be a POD. There can
1781 // be many instances of this structure, so we use a union to save
1787 : shndx_(0), p2align_(0)
1789 this->u1_
.data_size
= 0;
1790 this->u2_
.object
= NULL
;
1793 // For an ordinary input section.
1794 Input_section(Relobj
* object
, unsigned int shndx
, off_t data_size
,
1797 p2align_(ffsll(static_cast<long long>(addralign
)))
1799 gold_assert(shndx
!= OUTPUT_SECTION_CODE
1800 && shndx
!= MERGE_DATA_SECTION_CODE
1801 && shndx
!= MERGE_STRING_SECTION_CODE
);
1802 this->u1_
.data_size
= data_size
;
1803 this->u2_
.object
= object
;
1806 // For a non-merge output section.
1807 Input_section(Output_section_data
* posd
)
1808 : shndx_(OUTPUT_SECTION_CODE
),
1809 p2align_(ffsll(static_cast<long long>(posd
->addralign())))
1811 this->u1_
.data_size
= 0;
1812 this->u2_
.posd
= posd
;
1815 // For a merge section.
1816 Input_section(Output_section_data
* posd
, bool is_string
, uint64_t entsize
)
1818 ? MERGE_STRING_SECTION_CODE
1819 : MERGE_DATA_SECTION_CODE
),
1820 p2align_(ffsll(static_cast<long long>(posd
->addralign())))
1822 this->u1_
.entsize
= entsize
;
1823 this->u2_
.posd
= posd
;
1826 // The required alignment.
1830 return (this->p2align_
== 0
1832 : static_cast<uint64_t>(1) << (this->p2align_
- 1));
1835 // Return the required size.
1839 // Return whether this is a merge section which matches the
1842 is_merge_section(bool is_string
, uint64_t entsize
,
1843 uint64_t addralign
) const
1845 return (this->shndx_
== (is_string
1846 ? MERGE_STRING_SECTION_CODE
1847 : MERGE_DATA_SECTION_CODE
)
1848 && this->u1_
.entsize
== entsize
1849 && this->addralign() == addralign
);
1852 // Set the output section.
1854 set_output_section(Output_section
* os
)
1856 gold_assert(!this->is_input_section());
1857 this->u2_
.posd
->set_output_section(os
);
1860 // Set the address and file offset. This is called during
1861 // Layout::finalize. SECTION_FILE_OFFSET is the file offset of
1862 // the enclosing section.
1864 set_address_and_file_offset(uint64_t address
, off_t file_offset
,
1865 off_t section_file_offset
);
1867 // Finalize the data size.
1869 finalize_data_size();
1871 // Add an input section, for SHF_MERGE sections.
1873 add_input_section(Relobj
* object
, unsigned int shndx
)
1875 gold_assert(this->shndx_
== MERGE_DATA_SECTION_CODE
1876 || this->shndx_
== MERGE_STRING_SECTION_CODE
);
1877 return this->u2_
.posd
->add_input_section(object
, shndx
);
1880 // Given an input OBJECT, an input section index SHNDX within that
1881 // object, and an OFFSET relative to the start of that input
1882 // section, return whether or not the output offset is known. If
1883 // this function returns true, it sets *POUTPUT to the output
1886 output_offset(const Relobj
* object
, unsigned int shndx
,
1887 section_offset_type offset
,
1888 section_offset_type
*poutput
) const;
1890 // Write out the data. This does nothing for an input section.
1892 write(Output_file
*);
1894 // Write the data to a buffer. This does nothing for an input
1897 write_to_buffer(unsigned char*);
1900 // Code values which appear in shndx_. If the value is not one of
1901 // these codes, it is the input section index in the object file.
1904 // An Output_section_data.
1905 OUTPUT_SECTION_CODE
= -1U,
1906 // An Output_section_data for an SHF_MERGE section with
1907 // SHF_STRINGS not set.
1908 MERGE_DATA_SECTION_CODE
= -2U,
1909 // An Output_section_data for an SHF_MERGE section with
1911 MERGE_STRING_SECTION_CODE
= -3U
1914 // Whether this is an input section.
1916 is_input_section() const
1918 return (this->shndx_
!= OUTPUT_SECTION_CODE
1919 && this->shndx_
!= MERGE_DATA_SECTION_CODE
1920 && this->shndx_
!= MERGE_STRING_SECTION_CODE
);
1923 // For an ordinary input section, this is the section index in the
1924 // input file. For an Output_section_data, this is
1925 // OUTPUT_SECTION_CODE or MERGE_DATA_SECTION_CODE or
1926 // MERGE_STRING_SECTION_CODE.
1927 unsigned int shndx_
;
1928 // The required alignment, stored as a power of 2.
1929 unsigned int p2align_
;
1932 // For an ordinary input section, the section size.
1934 // For OUTPUT_SECTION_CODE, this is not used. For
1935 // MERGE_DATA_SECTION_CODE or MERGE_STRING_SECTION_CODE, the
1941 // For an ordinary input section, the object which holds the
1944 // For OUTPUT_SECTION_CODE or MERGE_DATA_SECTION_CODE or
1945 // MERGE_STRING_SECTION_CODE, the data.
1946 Output_section_data
* posd
;
1950 typedef std::vector
<Input_section
> Input_section_list
;
1952 // Fill data. This is used to fill in data between input sections.
1953 // When we have to keep track of the input sections, we can use an
1954 // Output_data_const, but we don't want to have to keep track of
1955 // input sections just to implement fills. For a fill we record the
1956 // offset, and the actual data to be written out.
1960 Fill(off_t section_offset
, off_t length
)
1961 : section_offset_(section_offset
), length_(length
)
1964 // Return section offset.
1966 section_offset() const
1967 { return this->section_offset_
; }
1969 // Return fill length.
1972 { return this->length_
; }
1975 // The offset within the output section.
1976 off_t section_offset_
;
1977 // The length of the space to fill.
1981 typedef std::vector
<Fill
> Fill_list
;
1983 // Add a new output section by Input_section.
1985 add_output_section_data(Input_section
*);
1987 // Add an SHF_MERGE input section. Returns true if the section was
1990 add_merge_input_section(Relobj
* object
, unsigned int shndx
, uint64_t flags
,
1991 uint64_t entsize
, uint64_t addralign
);
1993 // Add an output SHF_MERGE section POSD to this output section.
1994 // IS_STRING indicates whether it is a SHF_STRINGS section, and
1995 // ENTSIZE is the entity size. This returns the entry added to
1998 add_output_merge_section(Output_section_data
* posd
, bool is_string
,
2001 // Most of these fields are only valid after layout.
2003 // The name of the section. This will point into a Stringpool.
2005 // The section address is in the parent class.
2006 // The section alignment.
2007 uint64_t addralign_
;
2008 // The section entry size.
2010 // The file offset is in the parent class.
2011 // Set the section link field to the index of this section.
2012 const Output_data
* link_section_
;
2013 // If link_section_ is NULL, this is the link field.
2015 // Set the section info field to the index of this section.
2016 const Output_data
* info_section_
;
2017 // If info_section_ is NULL, this is the section info field.
2019 // The section type.
2020 const elfcpp::Elf_Word type_
;
2021 // The section flags.
2022 const elfcpp::Elf_Xword flags_
;
2023 // The section index.
2024 unsigned int out_shndx_
;
2025 // If there is a STT_SECTION for this output section in the normal
2026 // symbol table, this is the symbol index. This starts out as zero.
2027 // It is initialized in Layout::finalize() to be the index, or -1U
2028 // if there isn't one.
2029 unsigned int symtab_index_
;
2030 // If there is a STT_SECTION for this output section in the dynamic
2031 // symbol table, this is the symbol index. This starts out as zero.
2032 // It is initialized in Layout::finalize() to be the index, or -1U
2033 // if there isn't one.
2034 unsigned int dynsym_index_
;
2035 // The input sections. This will be empty in cases where we don't
2036 // need to keep track of them.
2037 Input_section_list input_sections_
;
2038 // The offset of the first entry in input_sections_.
2039 off_t first_input_offset_
;
2040 // The fill data. This is separate from input_sections_ because we
2041 // often will need fill sections without needing to keep track of
2044 // If the section requires postprocessing, this buffer holds the
2045 // section contents during relocation.
2046 unsigned char* postprocessing_buffer_
;
2047 // Whether this output section needs a STT_SECTION symbol in the
2048 // normal symbol table. This will be true if there is a relocation
2050 bool needs_symtab_index_
: 1;
2051 // Whether this output section needs a STT_SECTION symbol in the
2052 // dynamic symbol table. This will be true if there is a dynamic
2053 // relocation which needs it.
2054 bool needs_dynsym_index_
: 1;
2055 // Whether the link field of this output section should point to the
2056 // normal symbol table.
2057 bool should_link_to_symtab_
: 1;
2058 // Whether the link field of this output section should point to the
2059 // dynamic symbol table.
2060 bool should_link_to_dynsym_
: 1;
2061 // Whether this section should be written after all the input
2062 // sections are complete.
2063 bool after_input_sections_
: 1;
2064 // Whether this section requires post processing after all
2065 // relocations have been applied.
2066 bool requires_postprocessing_
: 1;
2067 // For SHT_TLS sections, the offset of this section relative to the base
2068 // of the TLS segment.
2069 uint64_t tls_offset_
;
2072 // An output segment. PT_LOAD segments are built from collections of
2073 // output sections. Other segments typically point within PT_LOAD
2074 // segments, and are built directly as needed.
2076 class Output_segment
2079 // Create an output segment, specifying the type and flags.
2080 Output_segment(elfcpp::Elf_Word
, elfcpp::Elf_Word
);
2082 // Return the virtual address.
2085 { return this->vaddr_
; }
2087 // Return the physical address.
2090 { return this->paddr_
; }
2092 // Return the segment type.
2095 { return this->type_
; }
2097 // Return the segment flags.
2100 { return this->flags_
; }
2102 // Return the memory size.
2105 { return this->memsz_
; }
2107 // Return the file size.
2110 { return this->filesz_
; }
2112 // Return the maximum alignment of the Output_data.
2116 // Add an Output_section to this segment.
2118 add_output_section(Output_section
* os
, elfcpp::Elf_Word seg_flags
)
2119 { this->add_output_section(os
, seg_flags
, false); }
2121 // Add an Output_section to the start of this segment.
2123 add_initial_output_section(Output_section
* os
, elfcpp::Elf_Word seg_flags
)
2124 { this->add_output_section(os
, seg_flags
, true); }
2126 // Add an Output_data (which is not an Output_section) to the start
2129 add_initial_output_data(Output_data
*);
2131 // Return the number of dynamic relocations applied to this segment.
2133 dynamic_reloc_count() const;
2135 // Set the address of the segment to ADDR and the offset to *POFF
2136 // (aligned if necessary), and set the addresses and offsets of all
2137 // contained output sections accordingly. Set the section indexes
2138 // of all contained output sections starting with *PSHNDX. Return
2139 // the address of the immediately following segment. Update *POFF
2140 // and *PSHNDX. This should only be called for a PT_LOAD segment.
2142 set_section_addresses(uint64_t addr
, off_t
* poff
, unsigned int* pshndx
);
2144 // Set the minimum alignment of this segment. This may be adjusted
2145 // upward based on the section alignments.
2147 set_minimum_addralign(uint64_t align
)
2149 gold_assert(!this->is_align_known_
);
2150 this->align_
= align
;
2153 // Set the offset of this segment based on the section. This should
2154 // only be called for a non-PT_LOAD segment.
2158 // Set the TLS offsets of the sections contained in the PT_TLS segment.
2162 // Return the number of output sections.
2164 output_section_count() const;
2166 // Write the segment header into *OPHDR.
2167 template<int size
, bool big_endian
>
2169 write_header(elfcpp::Phdr_write
<size
, big_endian
>*);
2171 // Write the section headers of associated sections into V.
2172 template<int size
, bool big_endian
>
2174 write_section_headers(const Layout
*, const Stringpool
*, unsigned char* v
,
2175 unsigned int* pshndx ACCEPT_SIZE_ENDIAN
) const;
2178 Output_segment(const Output_segment
&);
2179 Output_segment
& operator=(const Output_segment
&);
2181 typedef std::list
<Output_data
*> Output_data_list
;
2183 // Add an Output_section to this segment, specifying front or back.
2185 add_output_section(Output_section
*, elfcpp::Elf_Word seg_flags
,
2188 // Find the maximum alignment in an Output_data_list.
2190 maximum_alignment(const Output_data_list
*);
2192 // Set the section addresses in an Output_data_list.
2194 set_section_list_addresses(Output_data_list
*, uint64_t addr
, off_t
* poff
,
2195 unsigned int* pshndx
);
2197 // Return the number of Output_sections in an Output_data_list.
2199 output_section_count_list(const Output_data_list
*) const;
2201 // Return the number of dynamic relocs in an Output_data_list.
2203 dynamic_reloc_count_list(const Output_data_list
*) const;
2205 // Write the section headers in the list into V.
2206 template<int size
, bool big_endian
>
2208 write_section_headers_list(const Layout
*, const Stringpool
*,
2209 const Output_data_list
*, unsigned char* v
,
2210 unsigned int* pshdx ACCEPT_SIZE_ENDIAN
) const;
2212 // The list of output data with contents attached to this segment.
2213 Output_data_list output_data_
;
2214 // The list of output data without contents attached to this segment.
2215 Output_data_list output_bss_
;
2216 // The segment virtual address.
2218 // The segment physical address.
2220 // The size of the segment in memory.
2222 // The segment alignment. The is_align_known_ field indicates
2223 // whether this has been finalized. It can be set to a minimum
2224 // value before it is finalized.
2226 // The offset of the segment data within the file.
2228 // The size of the segment data in the file.
2230 // The segment type;
2231 elfcpp::Elf_Word type_
;
2232 // The segment flags.
2233 elfcpp::Elf_Word flags_
;
2234 // Whether we have finalized align_.
2235 bool is_align_known_
;
2238 // This class represents the output file.
2243 Output_file(const General_options
& options
, Target
*);
2245 // Get a pointer to the target.
2248 { return this->target_
; }
2250 // Open the output file. FILE_SIZE is the final size of the file.
2252 open(off_t file_size
);
2254 // Resize the output file.
2256 resize(off_t file_size
);
2258 // Close the output file (flushing all buffered data) and make sure
2259 // there are no errors.
2263 // We currently always use mmap which makes the view handling quite
2264 // simple. In the future we may support other approaches.
2266 // Write data to the output file.
2268 write(off_t offset
, const void* data
, off_t len
)
2269 { memcpy(this->base_
+ offset
, data
, len
); }
2271 // Get a buffer to use to write to the file, given the offset into
2272 // the file and the size.
2274 get_output_view(off_t start
, off_t size
)
2276 gold_assert(start
>= 0 && size
>= 0 && start
+ size
<= this->file_size_
);
2277 return this->base_
+ start
;
2280 // VIEW must have been returned by get_output_view. Write the
2281 // buffer to the file, passing in the offset and the size.
2283 write_output_view(off_t
, off_t
, unsigned char*)
2286 // Get a read/write buffer. This is used when we want to write part
2287 // of the file, read it in, and write it again.
2289 get_input_output_view(off_t start
, off_t size
)
2290 { return this->get_output_view(start
, size
); }
2292 // Write a read/write buffer back to the file.
2294 write_input_output_view(off_t
, off_t
, unsigned char*)
2297 // Get a read buffer. This is used when we just want to read part
2298 // of the file back it in.
2299 const unsigned char*
2300 get_input_view(off_t start
, off_t size
)
2301 { return this->get_output_view(start
, size
); }
2303 // Release a read bfufer.
2305 free_input_view(off_t
, off_t
, const unsigned char*)
2309 // Map the file into memory and return a pointer to the map.
2313 // Unmap the file from memory (and flush to disk buffers).
2319 const General_options
& options_
;
2328 // Base of file mapped into memory.
2329 unsigned char* base_
;
2330 // True iff base_ points to a memory buffer rather than an output file.
2331 bool map_is_anonymous_
;
2334 } // End namespace gold.
2336 #endif // !defined(GOLD_OUTPUT_H)