[yaml2obj][ELF] Move section index to the ELFState class.
[oota-llvm.git] / tools / yaml2obj / yaml2elf.cpp
1 //===- yaml2elf - Convert YAML to a ELF object file -----------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 ///
10 /// \file
11 /// \brief The ELF component of yaml2obj.
12 ///
13 //===----------------------------------------------------------------------===//
14
15 #include "yaml2obj.h"
16 #include "llvm/ADT/ArrayRef.h"
17 #include "llvm/Object/ELFObjectFile.h"
18 #include "llvm/Object/ELFYAML.h"
19 #include "llvm/Support/ELF.h"
20 #include "llvm/Support/MemoryBuffer.h"
21 #include "llvm/Support/YAMLTraits.h"
22 #include "llvm/Support/raw_ostream.h"
23
24 using namespace llvm;
25
26 // There is similar code in yaml2coff, but with some slight COFF-specific
27 // variations like different initial state. Might be able to deduplicate
28 // some day, but also want to make sure that the Mach-O use case is served.
29 //
30 // This class has a deliberately small interface, since a lot of
31 // implementation variation is possible.
32 //
33 // TODO: Use an ordered container with a suffix-based comparison in order
34 // to deduplicate suffixes. std::map<> with a custom comparator is likely
35 // to be the simplest implementation, but a suffix trie could be more
36 // suitable for the job.
37 namespace {
38 class StringTableBuilder {
39   /// \brief Indices of strings currently present in `Buf`.
40   StringMap<unsigned> StringIndices;
41   /// \brief The contents of the string table as we build it.
42   std::string Buf;
43 public:
44   StringTableBuilder() {
45     Buf.push_back('\0');
46   }
47   /// \returns Index of string in string table.
48   unsigned addString(StringRef S) {
49     StringMapEntry<unsigned> &Entry = StringIndices.GetOrCreateValue(S);
50     unsigned &I = Entry.getValue();
51     if (I != 0)
52       return I;
53     I = Buf.size();
54     Buf.append(S.begin(), S.end());
55     Buf.push_back('\0');
56     return I;
57   }
58   size_t size() const {
59     return Buf.size();
60   }
61   void writeToStream(raw_ostream &OS) {
62     OS.write(Buf.data(), Buf.size());
63   }
64 };
65 } // end anonymous namespace
66
67 // This class is used to build up a contiguous binary blob while keeping
68 // track of an offset in the output (which notionally begins at
69 // `InitialOffset`).
70 namespace {
71 class ContiguousBlobAccumulator {
72   const uint64_t InitialOffset;
73   SmallVector<char, 128> Buf;
74   raw_svector_ostream OS;
75
76   /// \returns The new offset.
77   uint64_t padToAlignment(unsigned Align) {
78     uint64_t CurrentOffset = InitialOffset + OS.tell();
79     uint64_t AlignedOffset = RoundUpToAlignment(CurrentOffset, Align);
80     for (; CurrentOffset != AlignedOffset; ++CurrentOffset)
81       OS.write('\0');
82     return AlignedOffset; // == CurrentOffset;
83   }
84
85 public:
86   ContiguousBlobAccumulator(uint64_t InitialOffset_)
87       : InitialOffset(InitialOffset_), Buf(), OS(Buf) {}
88   template <class Integer>
89   raw_ostream &getOSAndAlignedOffset(Integer &Offset, unsigned Align = 16) {
90     Offset = padToAlignment(Align);
91     return OS;
92   }
93   void writeBlobToStream(raw_ostream &Out) { Out << OS.str(); }
94 };
95 } // end anonymous namespace
96
97 // Used to keep track of section names, so that in the YAML file sections
98 // can be referenced by name instead of by index.
99 namespace {
100 class SectionNameToIdxMap {
101   StringMap<int> Map;
102 public:
103   /// \returns true if name is already present in the map.
104   bool addName(StringRef SecName, unsigned i) {
105     StringMapEntry<int> &Entry = Map.GetOrCreateValue(SecName, -1);
106     if (Entry.getValue() != -1)
107       return true;
108     Entry.setValue((int)i);
109     return false;
110   }
111   /// \returns true if name is not present in the map
112   bool lookupSection(StringRef SecName, unsigned &Idx) const {
113     StringMap<int>::const_iterator I = Map.find(SecName);
114     if (I == Map.end())
115       return true;
116     Idx = I->getValue();
117     return false;
118   }
119 };
120 } // end anonymous namespace
121
122 template <class T>
123 static size_t arrayDataSize(ArrayRef<T> A) {
124   return A.size() * sizeof(T);
125 }
126
127 template <class T>
128 static void writeArrayData(raw_ostream &OS, ArrayRef<T> A) {
129   OS.write((const char *)A.data(), arrayDataSize(A));
130 }
131
132 template <class T>
133 static void zero(T &Obj) {
134   memset(&Obj, 0, sizeof(Obj));
135 }
136
137 /// \brief Create a string table in `SHeader`, which we assume is already
138 /// zero'd.
139 template <class Elf_Shdr>
140 static void createStringTableSectionHeader(Elf_Shdr &SHeader,
141                                            StringTableBuilder &STB,
142                                            ContiguousBlobAccumulator &CBA) {
143   SHeader.sh_type = ELF::SHT_STRTAB;
144   STB.writeToStream(CBA.getOSAndAlignedOffset(SHeader.sh_offset));
145   SHeader.sh_size = STB.size();
146   SHeader.sh_addralign = 1;
147 }
148
149 namespace {
150 /// \brief "Single point of truth" for the ELF file construction.
151 /// TODO: This class still has a ways to go before it is truly a "single
152 /// point of truth".
153 template <class ELFT>
154 class ELFState {
155   /// \brief The future ".strtab" section.
156   StringTableBuilder DotStrtab;
157   typedef typename object::ELFFile<ELFT>::Elf_Ehdr Elf_Ehdr;
158
159   SectionNameToIdxMap SN2I;
160   const ELFYAML::Object &Doc;
161
162 public:
163   ELFState(const ELFYAML::Object &D) : Doc(D) {}
164
165   // - SHT_NULL entry (placed first, i.e. 0'th entry)
166   // - symbol table (.symtab) (placed third to last)
167   // - string table (.strtab) (placed second to last)
168   // - section header string table (.shstrtab) (placed last)
169   unsigned getDotSymTabSecNo() const { return Doc.Sections.size() + 1; }
170   unsigned getDotStrTabSecNo() const { return Doc.Sections.size() + 2; }
171   unsigned getDotShStrTabSecNo() const { return Doc.Sections.size() + 3; }
172   unsigned getSectionCount() const { return Doc.Sections.size() + 4; }
173
174   StringTableBuilder &getStringTable() { return DotStrtab; }
175   SectionNameToIdxMap &getSN2I() { return SN2I; }
176
177   bool buildSectionIndex() {
178     SN2I.addName(".symtab", getDotSymTabSecNo());
179     SN2I.addName(".strtab", getDotStrTabSecNo());
180     SN2I.addName(".shstrtab", getDotShStrTabSecNo());
181
182     for (unsigned i = 0, e = Doc.Sections.size(); i != e; ++i) {
183       StringRef Name = Doc.Sections[i].Name;
184       if (Name.empty())
185         continue;
186       // "+ 1" to take into account the SHT_NULL entry.
187       if (SN2I.addName(Name, i + 1)) {
188         errs() << "error: Repeated section name: '" << Name
189                << "' at YAML section number " << i << ".\n";
190         return false;
191       }
192     }
193     return true;
194   }
195 };
196 } // end anonymous namespace
197
198 // FIXME: At this point it is fairly clear that we need to refactor these
199 // static functions into methods of a class sharing some typedefs. These
200 // ELF type names are insane.
201 template <class ELFT>
202 static void
203 addSymbols(const std::vector<ELFYAML::Symbol> &Symbols, ELFState<ELFT> &State,
204            std::vector<typename object::ELFFile<ELFT>::Elf_Sym> &Syms,
205            unsigned SymbolBinding) {
206   typedef typename object::ELFFile<ELFT>::Elf_Sym Elf_Sym;
207   for (const auto &Sym : Symbols) {
208     Elf_Sym Symbol;
209     zero(Symbol);
210     if (!Sym.Name.empty())
211       Symbol.st_name = State.getStringTable().addString(Sym.Name);
212     Symbol.setBindingAndType(SymbolBinding, Sym.Type);
213     if (!Sym.Section.empty()) {
214       unsigned Index;
215       if (State.getSN2I().lookupSection(Sym.Section, Index)) {
216         errs() << "error: Unknown section referenced: '" << Sym.Section
217                << "' by YAML symbol " << Sym.Name << ".\n";
218         exit(1);
219       }
220       Symbol.st_shndx = Index;
221     } // else Symbol.st_shndex == SHN_UNDEF (== 0), since it was zero'd earlier.
222     Symbol.st_value = Sym.Value;
223     Symbol.st_size = Sym.Size;
224     Syms.push_back(Symbol);
225   }
226 }
227
228 template <class ELFT>
229 static void
230 handleSymtabSectionHeader(const ELFYAML::LocalGlobalWeakSymbols &Symbols,
231                           ELFState<ELFT> &State,
232                           typename object::ELFFile<ELFT>::Elf_Shdr &SHeader,
233                           ContiguousBlobAccumulator &CBA) {
234
235   typedef typename object::ELFFile<ELFT>::Elf_Sym Elf_Sym;
236   SHeader.sh_type = ELF::SHT_SYMTAB;
237   SHeader.sh_link = State.getDotStrTabSecNo();
238   // One greater than symbol table index of the last local symbol.
239   SHeader.sh_info = Symbols.Local.size() + 1;
240   SHeader.sh_entsize = sizeof(Elf_Sym);
241
242   std::vector<Elf_Sym> Syms;
243   {
244     // Ensure STN_UNDEF is present
245     Elf_Sym Sym;
246     zero(Sym);
247     Syms.push_back(Sym);
248   }
249   addSymbols(Symbols.Local, State, Syms, ELF::STB_LOCAL);
250   addSymbols(Symbols.Global, State, Syms, ELF::STB_GLOBAL);
251   addSymbols(Symbols.Weak, State, Syms, ELF::STB_WEAK);
252
253   writeArrayData(CBA.getOSAndAlignedOffset(SHeader.sh_offset),
254                  makeArrayRef(Syms));
255   SHeader.sh_size = arrayDataSize(makeArrayRef(Syms));
256 }
257
258 template <class ELFT>
259 static int writeELF(raw_ostream &OS, const ELFYAML::Object &Doc) {
260   using namespace llvm::ELF;
261   typedef typename object::ELFFile<ELFT>::Elf_Ehdr Elf_Ehdr;
262   typedef typename object::ELFFile<ELFT>::Elf_Shdr Elf_Shdr;
263
264   ELFState<ELFT> State(Doc);
265   if (!State.buildSectionIndex())
266     return 1;
267
268   const ELFYAML::FileHeader &Hdr = Doc.Header;
269
270   Elf_Ehdr Header;
271   zero(Header);
272   Header.e_ident[EI_MAG0] = 0x7f;
273   Header.e_ident[EI_MAG1] = 'E';
274   Header.e_ident[EI_MAG2] = 'L';
275   Header.e_ident[EI_MAG3] = 'F';
276   Header.e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
277   bool IsLittleEndian = ELFT::TargetEndianness == support::little;
278   Header.e_ident[EI_DATA] = IsLittleEndian ? ELFDATA2LSB : ELFDATA2MSB;
279   Header.e_ident[EI_VERSION] = EV_CURRENT;
280   Header.e_ident[EI_OSABI] = Hdr.OSABI;
281   Header.e_ident[EI_ABIVERSION] = 0;
282   Header.e_type = Hdr.Type;
283   Header.e_machine = Hdr.Machine;
284   Header.e_version = EV_CURRENT;
285   Header.e_entry = Hdr.Entry;
286   Header.e_flags = Hdr.Flags;
287   Header.e_ehsize = sizeof(Elf_Ehdr);
288
289   // TODO: Flesh out section header support.
290   // TODO: Program headers.
291
292   Header.e_shentsize = sizeof(Elf_Shdr);
293   // Immediately following the ELF header.
294   Header.e_shoff = sizeof(Header);
295   Header.e_shnum = State.getSectionCount();
296   Header.e_shstrndx = State.getDotShStrTabSecNo();
297
298   // XXX: This offset is tightly coupled with the order that we write
299   // things to `OS`.
300   const size_t SectionContentBeginOffset =
301       Header.e_ehsize + Header.e_shentsize * Header.e_shnum;
302   ContiguousBlobAccumulator CBA(SectionContentBeginOffset);
303
304   StringTableBuilder SHStrTab;
305   std::vector<Elf_Shdr> SHeaders;
306   {
307     // Ensure SHN_UNDEF entry is present. An all-zero section header is a
308     // valid SHN_UNDEF entry since SHT_NULL == 0.
309     Elf_Shdr SHdr;
310     zero(SHdr);
311     SHeaders.push_back(SHdr);
312   }
313   for (const auto &Sec : Doc.Sections) {
314     Elf_Shdr SHeader;
315     zero(SHeader);
316     SHeader.sh_name = SHStrTab.addString(Sec.Name);
317     SHeader.sh_type = Sec.Type;
318     SHeader.sh_flags = Sec.Flags;
319     SHeader.sh_addr = Sec.Address;
320
321     Sec.Content.writeAsBinary(CBA.getOSAndAlignedOffset(SHeader.sh_offset));
322     SHeader.sh_size = Sec.Content.binary_size();
323
324     if (!Sec.Link.empty()) {
325       unsigned Index;
326       if (State.getSN2I().lookupSection(Sec.Link, Index)) {
327         errs() << "error: Unknown section referenced: '" << Sec.Link
328                << "' at YAML section '" << Sec.Name << "'.\n";
329         return 1;
330       }
331       SHeader.sh_link = Index;
332     }
333     SHeader.sh_info = 0;
334     SHeader.sh_addralign = Sec.AddressAlign;
335     SHeader.sh_entsize = 0;
336     SHeaders.push_back(SHeader);
337   }
338
339   // .symtab section.
340   Elf_Shdr SymtabSHeader;
341   zero(SymtabSHeader);
342   SymtabSHeader.sh_name = SHStrTab.addString(StringRef(".symtab"));
343   handleSymtabSectionHeader<ELFT>(Doc.Symbols, State, SymtabSHeader, CBA);
344   SHeaders.push_back(SymtabSHeader);
345
346   // .strtab string table header.
347   Elf_Shdr DotStrTabSHeader;
348   zero(DotStrTabSHeader);
349   DotStrTabSHeader.sh_name = SHStrTab.addString(StringRef(".strtab"));
350   createStringTableSectionHeader(DotStrTabSHeader, State.getStringTable(), CBA);
351   SHeaders.push_back(DotStrTabSHeader);
352
353   // Section header string table header.
354   Elf_Shdr SHStrTabSHeader;
355   zero(SHStrTabSHeader);
356   SHStrTabSHeader.sh_name = SHStrTab.addString(StringRef(".shstrtab"));
357   createStringTableSectionHeader(SHStrTabSHeader, SHStrTab, CBA);
358   SHeaders.push_back(SHStrTabSHeader);
359
360   OS.write((const char *)&Header, sizeof(Header));
361   writeArrayData(OS, makeArrayRef(SHeaders));
362   CBA.writeBlobToStream(OS);
363   return 0;
364 }
365
366 static bool is64Bit(const ELFYAML::Object &Doc) {
367   return Doc.Header.Class == ELFYAML::ELF_ELFCLASS(ELF::ELFCLASS64);
368 }
369
370 static bool isLittleEndian(const ELFYAML::Object &Doc) {
371   return Doc.Header.Data == ELFYAML::ELF_ELFDATA(ELF::ELFDATA2LSB);
372 }
373
374 int yaml2elf(llvm::raw_ostream &Out, llvm::MemoryBuffer *Buf) {
375   yaml::Input YIn(Buf->getBuffer());
376   ELFYAML::Object Doc;
377   YIn >> Doc;
378   if (YIn.error()) {
379     errs() << "yaml2obj: Failed to parse YAML file!\n";
380     return 1;
381   }
382   using object::ELFType;
383   typedef ELFType<support::little, 8, true> LE64;
384   typedef ELFType<support::big, 8, true> BE64;
385   typedef ELFType<support::little, 4, false> LE32;
386   typedef ELFType<support::big, 4, false> BE32;
387   if (is64Bit(Doc)) {
388     if (isLittleEndian(Doc))
389       return writeELF<LE64>(outs(), Doc);
390     else
391       return writeELF<BE64>(outs(), Doc);
392   } else {
393     if (isLittleEndian(Doc))
394       return writeELF<LE32>(outs(), Doc);
395     else
396       return writeELF<BE32>(outs(), Doc);
397   }
398 }