1 //===- MCAssembler.h - Object File Generation -------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_MC_MCASSEMBLER_H
11 #define LLVM_MC_MCASSEMBLER_H
13 #include "llvm/ADT/ArrayRef.h"
14 #include "llvm/ADT/STLExtras.h"
15 #include "llvm/ADT/SmallPtrSet.h"
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/ADT/iterator.h"
18 #include "llvm/ADT/iterator_range.h"
19 #include "llvm/BinaryFormat/MachO.h"
20 #include "llvm/MC/MCDirectives.h"
21 #include "llvm/MC/MCDwarf.h"
22 #include "llvm/MC/MCFixup.h"
23 #include "llvm/MC/MCFragment.h"
24 #include "llvm/MC/MCLinkerOptimizationHint.h"
25 #include "llvm/MC/MCSymbol.h"
44 // FIXME: This really doesn't belong here. See comments below.
45 struct IndirectSymbolData {
50 // FIXME: Ditto this. Purely so the Streamer and the ObjectWriter can talk
52 struct DataRegionData {
53 // This enum should be kept in sync w/ the mach-o definition in
54 // llvm/Object/MachOFormat.h.
55 enum KindTy { Data = 1, JumpTable8, JumpTable16, JumpTable32 } Kind;
61 friend class MCAsmLayout;
64 using SectionListType = std::vector<MCSection *>;
65 using SymbolDataListType = std::vector<const MCSymbol *>;
67 using const_iterator = pointee_iterator<SectionListType::const_iterator>;
68 using iterator = pointee_iterator<SectionListType::iterator>;
70 using const_symbol_iterator =
71 pointee_iterator<SymbolDataListType::const_iterator>;
72 using symbol_iterator = pointee_iterator<SymbolDataListType::iterator>;
74 using symbol_range = iterator_range<symbol_iterator>;
75 using const_symbol_range = iterator_range<const_symbol_iterator>;
77 using const_indirect_symbol_iterator =
78 std::vector<IndirectSymbolData>::const_iterator;
79 using indirect_symbol_iterator = std::vector<IndirectSymbolData>::iterator;
81 using const_data_region_iterator =
82 std::vector<DataRegionData>::const_iterator;
83 using data_region_iterator = std::vector<DataRegionData>::iterator;
85 /// MachO specific deployment target version info.
86 // A Major version of 0 indicates that no version information was supplied
87 // and so the corresponding load command should not be emitted.
88 using VersionInfoType = struct {
89 bool EmitBuildVersion;
91 MCVersionMinType Type; ///< Used when EmitBuildVersion==false.
92 MachO::PlatformType Platform; ///< Used when EmitBuildVersion==true.
102 MCAsmBackend &Backend;
104 MCCodeEmitter &Emitter;
106 MCObjectWriter &Writer;
108 SectionListType Sections;
110 SymbolDataListType Symbols;
112 std::vector<IndirectSymbolData> IndirectSymbols;
114 std::vector<DataRegionData> DataRegions;
116 /// The list of linker options to propagate into the object file.
117 std::vector<std::vector<std::string>> LinkerOptions;
119 /// List of declared file names
120 std::vector<std::string> FileNames;
122 MCDwarfLineTableParams LTParams;
124 /// The set of function symbols for which a .thumb_func directive has
127 // FIXME: We really would like this in target specific code rather than
128 // here. Maybe when the relocation stuff moves to target specific,
129 // this can go with it? The streamer would need some target specific
131 mutable SmallPtrSet<const MCSymbol *, 32> ThumbFuncs;
133 /// \brief The bundle alignment size currently set in the assembler.
135 /// By default it's 0, which means bundling is disabled.
136 unsigned BundleAlignSize;
139 bool SubsectionsViaSymbols : 1;
140 bool IncrementalLinkerCompatible : 1;
142 /// ELF specific e_header flags
143 // It would be good if there were an MCELFAssembler class to hold this.
144 // ELF header flags are used both by the integrated and standalone assemblers.
145 // Access to the flags is necessary in cases where assembler directives affect
146 // which flags to be set.
147 unsigned ELFHeaderEFlags;
149 /// Used to communicate Linker Optimization Hint information between
150 /// the Streamer and the .o writer
151 MCLOHContainer LOHContainer;
153 VersionInfoType VersionInfo;
155 /// Evaluate a fixup to a relocatable expression and the value which should be
156 /// placed into the fixup.
158 /// \param Layout The layout to use for evaluation.
159 /// \param Fixup The fixup to evaluate.
160 /// \param DF The fragment the fixup is inside.
161 /// \param Target [out] On return, the relocatable expression the fixup
163 /// \param Value [out] On return, the value of the fixup as currently laid
165 /// \return Whether the fixup value was fully resolved. This is true if the
166 /// \p Value result is fixed, otherwise the value may change due to
168 bool evaluateFixup(const MCAsmLayout &Layout, const MCFixup &Fixup,
169 const MCFragment *DF, MCValue &Target,
170 uint64_t &Value) const;
172 /// Check whether a fixup can be satisfied, or whether it needs to be relaxed
173 /// (increased in size, in order to hold its value correctly).
174 bool fixupNeedsRelaxation(const MCFixup &Fixup, const MCRelaxableFragment *DF,
175 const MCAsmLayout &Layout) const;
177 /// Check whether the given fragment needs relaxation.
178 bool fragmentNeedsRelaxation(const MCRelaxableFragment *IF,
179 const MCAsmLayout &Layout) const;
181 /// \brief Perform one layout iteration and return true if any offsets
183 bool layoutOnce(MCAsmLayout &Layout);
185 /// \brief Perform one layout iteration of the given section and return true
186 /// if any offsets were adjusted.
187 bool layoutSectionOnce(MCAsmLayout &Layout, MCSection &Sec);
189 bool relaxInstruction(MCAsmLayout &Layout, MCRelaxableFragment &IF);
191 bool relaxPaddingFragment(MCAsmLayout &Layout, MCPaddingFragment &PF);
193 bool relaxLEB(MCAsmLayout &Layout, MCLEBFragment &IF);
195 bool relaxDwarfLineAddr(MCAsmLayout &Layout, MCDwarfLineAddrFragment &DF);
196 bool relaxDwarfCallFrameFragment(MCAsmLayout &Layout,
197 MCDwarfCallFrameFragment &DF);
198 bool relaxCVInlineLineTable(MCAsmLayout &Layout,
199 MCCVInlineLineTableFragment &DF);
200 bool relaxCVDefRange(MCAsmLayout &Layout, MCCVDefRangeFragment &DF);
202 /// finishLayout - Finalize a layout, including fragment lowering.
203 void finishLayout(MCAsmLayout &Layout);
205 std::tuple<MCValue, uint64_t, bool>
206 handleFixup(const MCAsmLayout &Layout, MCFragment &F, const MCFixup &Fixup);
209 /// Construct a new assembler instance.
211 // FIXME: How are we going to parameterize this? Two obvious options are stay
212 // concrete and require clients to pass in a target like object. The other
213 // option is to make this abstract, and have targets provide concrete
214 // implementations as we do with AsmParser.
215 MCAssembler(MCContext &Context, MCAsmBackend &Backend,
216 MCCodeEmitter &Emitter, MCObjectWriter &Writer);
217 MCAssembler(const MCAssembler &) = delete;
218 MCAssembler &operator=(const MCAssembler &) = delete;
221 /// Compute the effective fragment size assuming it is laid out at the given
222 /// \p SectionAddress and \p FragmentOffset.
223 uint64_t computeFragmentSize(const MCAsmLayout &Layout,
224 const MCFragment &F) const;
226 /// Find the symbol which defines the atom containing the given symbol, or
227 /// null if there is no such symbol.
228 const MCSymbol *getAtom(const MCSymbol &S) const;
230 /// Check whether a particular symbol is visible to the linker and is required
231 /// in the symbol table, or whether it can be discarded by the assembler. This
232 /// also effects whether the assembler treats the label as potentially
233 /// defining a separate atom.
234 bool isSymbolLinkerVisible(const MCSymbol &SD) const;
236 /// Emit the section contents using the given object writer.
237 void writeSectionData(const MCSection *Section,
238 const MCAsmLayout &Layout) const;
240 /// Check whether a given symbol has been flagged with .thumb_func.
241 bool isThumbFunc(const MCSymbol *Func) const;
243 /// Flag a function symbol as the target of a .thumb_func directive.
244 void setIsThumbFunc(const MCSymbol *Func) { ThumbFuncs.insert(Func); }
246 /// ELF e_header flags
247 unsigned getELFHeaderEFlags() const { return ELFHeaderEFlags; }
248 void setELFHeaderEFlags(unsigned Flags) { ELFHeaderEFlags = Flags; }
250 /// MachO deployment target version information.
251 const VersionInfoType &getVersionInfo() const { return VersionInfo; }
252 void setVersionMin(MCVersionMinType Type, unsigned Major, unsigned Minor,
254 VersionInfo.EmitBuildVersion = false;
255 VersionInfo.TypeOrPlatform.Type = Type;
256 VersionInfo.Major = Major;
257 VersionInfo.Minor = Minor;
258 VersionInfo.Update = Update;
260 void setBuildVersion(MachO::PlatformType Platform, unsigned Major,
261 unsigned Minor, unsigned Update) {
262 VersionInfo.EmitBuildVersion = true;
263 VersionInfo.TypeOrPlatform.Platform = Platform;
264 VersionInfo.Major = Major;
265 VersionInfo.Minor = Minor;
266 VersionInfo.Update = Update;
269 /// Reuse an assembler instance
273 MCContext &getContext() const { return Context; }
275 MCAsmBackend &getBackend() const { return Backend; }
277 MCCodeEmitter &getEmitter() const { return Emitter; }
279 MCObjectWriter &getWriter() const { return Writer; }
281 MCDwarfLineTableParams getDWARFLinetableParams() const { return LTParams; }
282 void setDWARFLinetableParams(MCDwarfLineTableParams P) { LTParams = P; }
284 /// Finish - Do final processing and write the object to the output stream.
285 /// \p Writer is used for custom object writer (as the MCJIT does),
286 /// if not specified it is automatically created from backend.
289 // Layout all section and prepare them for emission.
290 void layout(MCAsmLayout &Layout);
292 // FIXME: This does not belong here.
293 bool getSubsectionsViaSymbols() const { return SubsectionsViaSymbols; }
294 void setSubsectionsViaSymbols(bool Value) { SubsectionsViaSymbols = Value; }
296 bool isIncrementalLinkerCompatible() const {
297 return IncrementalLinkerCompatible;
299 void setIncrementalLinkerCompatible(bool Value) {
300 IncrementalLinkerCompatible = Value;
303 bool getRelaxAll() const { return RelaxAll; }
304 void setRelaxAll(bool Value) { RelaxAll = Value; }
306 bool isBundlingEnabled() const { return BundleAlignSize != 0; }
308 unsigned getBundleAlignSize() const { return BundleAlignSize; }
310 void setBundleAlignSize(unsigned Size) {
311 assert((Size == 0 || !(Size & (Size - 1))) &&
312 "Expect a power-of-two bundle align size");
313 BundleAlignSize = Size;
316 /// \name Section List Access
319 iterator begin() { return Sections.begin(); }
320 const_iterator begin() const { return Sections.begin(); }
322 iterator end() { return Sections.end(); }
323 const_iterator end() const { return Sections.end(); }
325 size_t size() const { return Sections.size(); }
328 /// \name Symbol List Access
330 symbol_iterator symbol_begin() { return Symbols.begin(); }
331 const_symbol_iterator symbol_begin() const { return Symbols.begin(); }
333 symbol_iterator symbol_end() { return Symbols.end(); }
334 const_symbol_iterator symbol_end() const { return Symbols.end(); }
336 symbol_range symbols() { return make_range(symbol_begin(), symbol_end()); }
337 const_symbol_range symbols() const {
338 return make_range(symbol_begin(), symbol_end());
341 size_t symbol_size() const { return Symbols.size(); }
344 /// \name Indirect Symbol List Access
347 // FIXME: This is a total hack, this should not be here. Once things are
348 // factored so that the streamer has direct access to the .o writer, it can
350 std::vector<IndirectSymbolData> &getIndirectSymbols() {
351 return IndirectSymbols;
354 indirect_symbol_iterator indirect_symbol_begin() {
355 return IndirectSymbols.begin();
357 const_indirect_symbol_iterator indirect_symbol_begin() const {
358 return IndirectSymbols.begin();
361 indirect_symbol_iterator indirect_symbol_end() {
362 return IndirectSymbols.end();
364 const_indirect_symbol_iterator indirect_symbol_end() const {
365 return IndirectSymbols.end();
368 size_t indirect_symbol_size() const { return IndirectSymbols.size(); }
371 /// \name Linker Option List Access
374 std::vector<std::vector<std::string>> &getLinkerOptions() {
375 return LinkerOptions;
379 /// \name Data Region List Access
382 // FIXME: This is a total hack, this should not be here. Once things are
383 // factored so that the streamer has direct access to the .o writer, it can
385 std::vector<DataRegionData> &getDataRegions() { return DataRegions; }
387 data_region_iterator data_region_begin() { return DataRegions.begin(); }
388 const_data_region_iterator data_region_begin() const {
389 return DataRegions.begin();
392 data_region_iterator data_region_end() { return DataRegions.end(); }
393 const_data_region_iterator data_region_end() const {
394 return DataRegions.end();
397 size_t data_region_size() const { return DataRegions.size(); }
400 /// \name Data Region List Access
403 // FIXME: This is a total hack, this should not be here. Once things are
404 // factored so that the streamer has direct access to the .o writer, it can
406 MCLOHContainer &getLOHContainer() { return LOHContainer; }
407 const MCLOHContainer &getLOHContainer() const {
408 return const_cast<MCAssembler *>(this)->getLOHContainer();
411 /// \name Backend Data Access
414 bool registerSection(MCSection &Section);
416 void registerSymbol(const MCSymbol &Symbol, bool *Created = nullptr);
418 ArrayRef<std::string> getFileNames() { return FileNames; }
420 void addFileName(StringRef FileName) {
421 if (!is_contained(FileNames, FileName))
422 FileNames.push_back(FileName);
425 /// \brief Write the necessary bundle padding to the given object writer.
426 /// Expects a fragment \p F containing instructions and its size \p FSize.
427 void writeFragmentPadding(const MCFragment &F, uint64_t FSize,
428 MCObjectWriter *OW) const;
435 /// \brief Compute the amount of padding required before the fragment \p F to
436 /// obey bundling restrictions, where \p FOffset is the fragment's offset in
437 /// its section and \p FSize is the fragment's size.
438 uint64_t computeBundlePadding(const MCAssembler &Assembler, const MCFragment *F,
439 uint64_t FOffset, uint64_t FSize);
441 } // end namespace llvm
443 #endif // LLVM_MC_MCASSEMBLER_H