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/SmallString.h"
14 #include "llvm/ADT/ilist.h"
15 #include "llvm/ADT/ilist_node.h"
16 #include "llvm/MC/MCValue.h"
17 #include "llvm/Support/Casting.h"
18 #include "llvm/Support/DataTypes.h"
26 class MCFragment : public ilist_node<MCFragment> {
27 MCFragment(const MCFragment&); // DO NOT IMPLEMENT
28 void operator=(const MCFragment&); // DO NOT IMPLEMENT
41 /// @name Assembler Backend Data
44 // FIXME: This could all be kept private to the assembler implementation.
46 /// Offset - The offset of this fragment in its section. This is ~0 until
50 /// FileSize - The file size of this section. This is ~0 until initialized.
56 MCFragment(FragmentType _Kind, MCSectionData *SD = 0);
61 virtual ~MCFragment();
63 FragmentType getKind() const { return Kind; }
65 // FIXME: This should be abstract, fix sentinel.
66 virtual uint64_t getMaxFileSize() const {
67 assert(0 && "Invalid getMaxFileSize call!");
71 /// @name Assembler Backend Support
74 // FIXME: This could all be kept private to the assembler implementation.
76 unsigned getFileSize() const {
77 assert(FileSize != ~UINT64_C(0) && "File size not set!");
80 void setFileSize(uint64_t Value) {
81 assert(Value <= getMaxFileSize() && "Invalid file size!");
85 uint64_t getOffset() const {
86 assert(Offset != ~UINT64_C(0) && "File offset not set!");
89 void setOffset(uint64_t Value) { Offset = Value; }
93 static bool classof(const MCFragment *O) { return true; }
96 class MCDataFragment : public MCFragment {
97 SmallString<32> Contents;
100 MCDataFragment(MCSectionData *SD = 0) : MCFragment(FT_Data, SD) {}
105 uint64_t getMaxFileSize() const {
106 return Contents.size();
109 SmallString<32> &getContents() { return Contents; }
110 const SmallString<32> &getContents() const { return Contents; }
114 static bool classof(const MCFragment *F) {
115 return F->getKind() == MCFragment::FT_Data;
117 static bool classof(const MCDataFragment *) { return true; }
120 class MCAlignFragment : public MCFragment {
121 /// Alignment - The alignment to ensure, in bytes.
124 /// Value - Value to use for filling padding bytes.
127 /// ValueSize - The size of the integer (in bytes) of \arg Value.
130 /// MaxBytesToEmit - The maximum number of bytes to emit; if the alignment
131 /// cannot be satisfied in this width then this fragment is ignored.
132 unsigned MaxBytesToEmit;
135 MCAlignFragment(unsigned _Alignment, int64_t _Value, unsigned _ValueSize,
136 unsigned _MaxBytesToEmit, MCSectionData *SD = 0)
137 : MCFragment(FT_Align, SD), Alignment(_Alignment),
138 Value(_Value),ValueSize(_ValueSize),
139 MaxBytesToEmit(_MaxBytesToEmit) {}
144 uint64_t getMaxFileSize() const {
145 return std::max(Alignment - 1, MaxBytesToEmit);
148 unsigned getAlignment() const { return Alignment; }
150 int64_t getValue() const { return Value; }
152 unsigned getValueSize() const { return ValueSize; }
154 unsigned getMaxBytesToEmit() const { return MaxBytesToEmit; }
158 static bool classof(const MCFragment *F) {
159 return F->getKind() == MCFragment::FT_Align;
161 static bool classof(const MCAlignFragment *) { return true; }
164 class MCFillFragment : public MCFragment {
165 /// Value - Value to use for filling bytes.
168 /// ValueSize - The size (in bytes) of \arg Value to use when filling.
171 /// Count - The number of copies of \arg Value to insert.
175 MCFillFragment(MCValue _Value, unsigned _ValueSize, uint64_t _Count,
176 MCSectionData *SD = 0)
177 : MCFragment(FT_Fill, SD),
178 Value(_Value), ValueSize(_ValueSize), Count(_Count) {}
183 uint64_t getMaxFileSize() const {
184 return ValueSize * Count;
187 MCValue getValue() const { return Value; }
189 unsigned getValueSize() const { return ValueSize; }
191 uint64_t getCount() const { return Count; }
195 static bool classof(const MCFragment *F) {
196 return F->getKind() == MCFragment::FT_Fill;
198 static bool classof(const MCFillFragment *) { return true; }
201 class MCOrgFragment : public MCFragment {
202 /// Offset - The offset this fragment should start at.
205 /// Value - Value to use for filling bytes.
209 MCOrgFragment(MCValue _Offset, int8_t _Value, MCSectionData *SD = 0)
210 : MCFragment(FT_Org, SD),
211 Offset(_Offset), Value(_Value) {}
215 uint64_t getMaxFileSize() const {
216 // FIXME: This doesn't make much sense.
220 MCValue getOffset() const { return Offset; }
222 uint8_t getValue() const { return Value; }
226 static bool classof(const MCFragment *F) {
227 return F->getKind() == MCFragment::FT_Org;
229 static bool classof(const MCOrgFragment *) { return true; }
232 // FIXME: Should this be a separate class, or just merged into MCSection? Since
233 // we anticipate the fast path being through an MCAssembler, the only reason to
234 // keep it out is for API abstraction.
235 class MCSectionData : public ilist_node<MCSectionData> {
236 MCSectionData(const MCSectionData&); // DO NOT IMPLEMENT
237 void operator=(const MCSectionData&); // DO NOT IMPLEMENT
240 typedef iplist<MCFragment> FragmentListType;
242 typedef FragmentListType::const_iterator const_iterator;
243 typedef FragmentListType::iterator iterator;
246 iplist<MCFragment> Fragments;
247 const MCSection &Section;
249 /// Alignment - The maximum alignment seen in this section.
252 /// @name Assembler Backend Data
255 // FIXME: This could all be kept private to the assembler implementation.
257 /// FileSize - The size of this section in the object file. This is ~0 until
264 // Only for use as sentinel.
266 MCSectionData(const MCSection &Section, MCAssembler *A = 0);
268 const MCSection &getSection() const { return Section; }
270 unsigned getAlignment() const { return Alignment; }
271 void setAlignment(unsigned Value) { Alignment = Value; }
273 /// @name Section List Access
276 const FragmentListType &getFragmentList() const { return Fragments; }
277 FragmentListType &getFragmentList() { return Fragments; }
279 iterator begin() { return Fragments.begin(); }
280 const_iterator begin() const { return Fragments.begin(); }
282 iterator end() { return Fragments.end(); }
283 const_iterator end() const { return Fragments.end(); }
285 size_t size() const { return Fragments.size(); }
287 bool empty() const { return Fragments.empty(); }
290 /// @name Assembler Backend Support
293 // FIXME: This could all be kept private to the assembler implementation.
295 unsigned getFileSize() const {
296 assert(FileSize != ~UINT64_C(0) && "File size not set!");
299 void setFileSize(uint64_t Value) { FileSize = Value; }
304 // FIXME: Same concerns as with SectionData.
305 class MCSymbolData : public ilist_node<MCSymbolData> {
309 /// Fragment - The fragment this symbol's value is relative to, if any.
310 MCFragment *Fragment;
312 /// Offset - The offset to apply to the fragment address to form this symbol's
316 /// IsExternal - True if this symbol is visible outside this translation
318 unsigned IsExternal : 1;
321 // Only for use as sentinel.
323 MCSymbolData(MCSymbol &_Symbol, MCFragment *_Fragment, uint64_t _Offset,
329 MCSymbol &getSymbol() const { return Symbol; }
331 MCFragment *getFragment() const { return Fragment; }
332 void setFragment(MCFragment *Value) { Fragment = Value; }
334 uint64_t getOffset() const { return Offset; }
335 void setOffset(uint64_t Value) { Offset = Value; }
338 /// @name Symbol Attributes
341 bool isExternal() const { return IsExternal; }
342 void setExternal(bool Value) { IsExternal = Value; }
349 typedef iplist<MCSectionData> SectionDataListType;
350 typedef iplist<MCSymbolData> SymbolDataListType;
352 typedef SectionDataListType::const_iterator const_iterator;
353 typedef SectionDataListType::iterator iterator;
355 typedef SymbolDataListType::const_iterator const_symbol_iterator;
356 typedef SymbolDataListType::iterator symbol_iterator;
359 MCAssembler(const MCAssembler&); // DO NOT IMPLEMENT
360 void operator=(const MCAssembler&); // DO NOT IMPLEMENT
364 iplist<MCSectionData> Sections;
366 iplist<MCSymbolData> Symbols;
369 /// LayoutSection - Assign offsets and sizes to the fragments in the section
370 /// \arg SD, and update the section size. The section file offset should
371 /// already have been computed.
372 void LayoutSection(MCSectionData &SD);
375 /// Construct a new assembler instance.
377 /// \arg OS - The stream to output to.
379 // FIXME: How are we going to parameterize this? Two obvious options are stay
380 // concrete and require clients to pass in a target like object. The other
381 // option is to make this abstract, and have targets provide concrete
382 // implementations as we do with AsmParser.
383 MCAssembler(raw_ostream &OS);
386 /// Finish - Do final processing and write the object to the output stream.
389 /// @name Section List Access
392 const SectionDataListType &getSectionList() const { return Sections; }
393 SectionDataListType &getSectionList() { return Sections; }
395 iterator begin() { return Sections.begin(); }
396 const_iterator begin() const { return Sections.begin(); }
398 iterator end() { return Sections.end(); }
399 const_iterator end() const { return Sections.end(); }
401 size_t size() const { return Sections.size(); }
404 /// @name Symbol List Access
407 const SymbolDataListType &getSymbolList() const { return Symbols; }
408 SymbolDataListType &getSymbolList() { return Symbols; }
410 symbol_iterator symbol_begin() { return Symbols.begin(); }
411 const_symbol_iterator symbol_begin() const { return Symbols.begin(); }
413 symbol_iterator symbol_end() { return Symbols.end(); }
414 const_symbol_iterator symbol_end() const { return Symbols.end(); }
416 size_t symbol_size() const { return Symbols.size(); }
421 } // end namespace llvm