contrib/llvm/tools/lld/ELF/OutputSections.h

   1 //===- OutputSections.h -----------------------------------------*- C++ -*-===//
   2 //
   3 //                             The LLVM Linker
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLD_ELF_OUTPUT_SECTIONS_H
  11 #define LLD_ELF_OUTPUT_SECTIONS_H
  12
  13 #include "Config.h"
  14 #include "InputSection.h"
  15 #include "Relocations.h"
  16
  17 #include "lld/Core/LLVM.h"
  18 #include "llvm/MC/StringTableBuilder.h"
  19 #include "llvm/Object/ELF.h"
  20
  21 namespace lld {
  22 namespace elf {
  23
  24 struct PhdrEntry;
  25 class SymbolBody;
  26 struct EhSectionPiece;
  27 class EhInputSection;
  28 class InputSection;
  29 class InputSectionBase;
  30 class MergeInputSection;
  31 class OutputSection;
  32 template <class ELFT> class ObjectFile;
  33 template <class ELFT> class SharedFile;
  34 class SharedSymbol;
  35 class DefinedRegular;
  36
  37 // This represents a section in an output file.
  38 // It is composed of multiple InputSections.
  39 // The writer creates multiple OutputSections and assign them unique,
  40 // non-overlapping file offsets and VAs.
  41 class OutputSection final : public SectionBase {
  42 public:
  43   OutputSection(StringRef Name, uint32_t Type, uint64_t Flags);
  44
  45   static bool classof(const SectionBase *S) {
  46     return S->kind() == SectionBase::Output;
  47   }
  48
  49   uint64_t getLMA() const { return Addr + LMAOffset; }
  50   template <typename ELFT> void writeHeaderTo(typename ELFT::Shdr *SHdr);
  51
  52   unsigned SectionIndex;
  53   unsigned SortRank;
  54
  55   uint32_t getPhdrFlags() const;
  56
  57   void updateAlignment(uint32_t Val) {
  58     if (Val > Alignment)
  59       Alignment = Val;
  60   }
  61
  62   // If true, this section will be page aligned on disk.
  63   // Typically the first section of each PT_LOAD segment has this flag.
  64   bool PageAlign = false;
  65
  66   // Pointer to the first section in PT_LOAD segment, which this section
  67   // also resides in. This field is used to correctly compute file offset
  68   // of a section. When two sections share the same load segment, difference
  69   // between their file offsets should be equal to difference between their
  70   // virtual addresses. To compute some section offset we use the following
  71   // formula: Off = Off_first + VA - VA_first.
  72   OutputSection *FirstInPtLoad = nullptr;
  73
  74   // The following fields correspond to Elf_Shdr members.
  75   uint64_t Size = 0;
  76   uint64_t Offset = 0;
  77   uint64_t LMAOffset = 0;
  78   uint64_t Addr = 0;
  79   uint32_t ShName = 0;
  80
  81   void addSection(InputSection *S);
  82   void sort(std::function<int(InputSectionBase *S)> Order);
  83   void sortInitFini();
  84   void sortCtorsDtors();
  85   template <class ELFT> void finalize();
  86   template <class ELFT> void maybeCompress();
  87   void assignOffsets();
  88   std::vector<InputSection *> Sections;
  89
  90   // Used for implementation of --compress-debug-sections option.
  91   std::vector<uint8_t> ZDebugHeader;
  92   llvm::SmallVector<char, 1> CompressedData;
  93
  94   // Location in the output buffer.
  95   uint8_t *Loc = nullptr;
  96 };
  97
  98 // All output sections that are handled by the linker specially are
  99 // globally accessible. Writer initializes them, so don't use them
 100 // until Writer is initialized.
 101 struct Out {
 102   static uint8_t First;
 103   static OutputSection *Opd;
 104   static uint8_t *OpdBuf;
 105   static PhdrEntry *TlsPhdr;
 106   static OutputSection *DebugInfo;
 107   static OutputSection *ElfHeader;
 108   static OutputSection *ProgramHeaders;
 109   static OutputSection *PreinitArray;
 110   static OutputSection *InitArray;
 111   static OutputSection *FiniArray;
 112 };
 113
 114 struct SectionKey {
 115   StringRef Name;
 116   uint64_t Flags;
 117   uint32_t Alignment;
 118 };
 119 }
 120 }
 121 namespace llvm {
 122 template <> struct DenseMapInfo<lld::elf::SectionKey> {
 123   static lld::elf::SectionKey getEmptyKey();
 124   static lld::elf::SectionKey getTombstoneKey();
 125   static unsigned getHashValue(const lld::elf::SectionKey &Val);
 126   static bool isEqual(const lld::elf::SectionKey &LHS,
 127                       const lld::elf::SectionKey &RHS);
 128 };
 129 }
 130 namespace lld {
 131 namespace elf {
 132
 133 // This class knows how to create an output section for a given
 134 // input section. Output section type is determined by various
 135 // factors, including input section's sh_flags, sh_type and
 136 // linker scripts.
 137 class OutputSectionFactory {
 138 public:
 139   OutputSectionFactory(std::vector<OutputSection *> &OutputSections);
 140   ~OutputSectionFactory();
 141
 142   void addInputSec(InputSectionBase *IS, StringRef OutsecName);
 143   void addInputSec(InputSectionBase *IS, StringRef OutsecName,
 144                    OutputSection *&Sec);
 145
 146 private:
 147   llvm::SmallDenseMap<SectionKey, OutputSection *> Map;
 148   std::vector<OutputSection *> &OutputSections;
 149 };
 150
 151 uint64_t getHeaderSize();
 152
 153 } // namespace elf
 154 } // namespace lld
 155
 156
 157 #endif