dcde9d9049e7a0b2bff3942bf5952682e10217d2
[oota-llvm.git] / include / llvm / MC / MCObjectFileInfo.h
1 //===-- llvm/MC/MCObjectFileInfo.h - Object File Info -----------*- C++ -*-===//
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 // This file describes common object file formats.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_MC_MCBJECTFILEINFO_H
15 #define LLVM_MC_MCBJECTFILEINFO_H
16
17 #include "llvm/Support/CodeGen.h"
18
19 namespace llvm {
20   class MCContext;
21   class MCSection;
22   class StringRef;
23   class Triple;
24
25 class MCObjectFileInfo {
26 protected:
27   /// CommDirectiveSupportsAlignment - True if .comm supports alignment.  This
28   /// is a hack for as long as we support 10.4 Tiger, whose assembler doesn't
29   /// support alignment on comm.
30   bool CommDirectiveSupportsAlignment;
31
32   /// SupportsWeakEmptyEHFrame - True if target object file supports a
33   /// weak_definition of constant 0 for an omitted EH frame.
34   bool SupportsWeakOmittedEHFrame;
35
36   /// IsFunctionEHFrameSymbolPrivate - This flag is set to true if the
37   /// "EH_frame" symbol for EH information should be an assembler temporary (aka
38   /// private linkage, aka an L or .L label) or false if it should be a normal
39   /// non-.globl label.  This defaults to true.
40   bool IsFunctionEHFrameSymbolPrivate;
41
42   /// PersonalityEncoding, LSDAEncoding, FDEEncoding, TTypeEncoding - Some
43   /// encoding values for EH.
44   unsigned PersonalityEncoding;
45   unsigned LSDAEncoding;
46   unsigned FDEEncoding;
47   unsigned FDECFIEncoding;
48   unsigned TTypeEncoding;
49   // Section flags for eh_frame
50   unsigned EHSectionType;
51   unsigned EHSectionFlags;
52
53   /// TextSection - Section directive for standard text.
54   ///
55   const MCSection *TextSection;
56
57   /// DataSection - Section directive for standard data.
58   ///
59   const MCSection *DataSection;
60
61   /// BSSSection - Section that is default initialized to zero.
62   const MCSection *BSSSection;
63
64   /// ReadOnlySection - Section that is readonly and can contain arbitrary
65   /// initialized data.  Targets are not required to have a readonly section.
66   /// If they don't, various bits of code will fall back to using the data
67   /// section for constants.
68   const MCSection *ReadOnlySection;
69
70   /// StaticCtorSection - This section contains the static constructor pointer
71   /// list.
72   const MCSection *StaticCtorSection;
73
74   /// StaticDtorSection - This section contains the static destructor pointer
75   /// list.
76   const MCSection *StaticDtorSection;
77
78   /// LSDASection - If exception handling is supported by the target, this is
79   /// the section the Language Specific Data Area information is emitted to.
80   const MCSection *LSDASection;
81
82   /// CompactUnwindSection - If exception handling is supported by the target
83   /// and the target can support a compact representation of the CIE and FDE,
84   /// this is the section to emit them into.
85   const MCSection *CompactUnwindSection;
86
87   // Dwarf sections for debug info.  If a target supports debug info, these must
88   // be set.
89   const MCSection *DwarfAbbrevSection;
90   const MCSection *DwarfInfoSection;
91   const MCSection *DwarfLineSection;
92   const MCSection *DwarfFrameSection;
93   const MCSection *DwarfPubTypesSection;
94   const MCSection *DwarfDebugInlineSection;
95   const MCSection *DwarfStrSection;
96   const MCSection *DwarfLocSection;
97   const MCSection *DwarfARangesSection;
98   const MCSection *DwarfRangesSection;
99   const MCSection *DwarfMacroInfoSection;
100
101   // DWARF5 Experimental Debug Info Sections
102   /// DwarfAccelNamesSection, DwarfAccelObjCSection,
103   /// DwarfAccelNamespaceSection, DwarfAccelTypesSection -
104   /// If we use the DWARF accelerated hash tables then we want to emit these
105   /// sections.
106   const MCSection *DwarfAccelNamesSection;
107   const MCSection *DwarfAccelObjCSection;
108   const MCSection *DwarfAccelNamespaceSection;
109   const MCSection *DwarfAccelTypesSection;
110
111   /// These are used for the Fission separate debug information files.
112   const MCSection *DwarfInfoDWOSection;
113   const MCSection *DwarfAbbrevDWOSection;
114   const MCSection *DwarfStrDWOSection;
115   const MCSection *DwarfLineDWOSection;
116   const MCSection *DwarfLocDWOSection;
117
118   // Extra TLS Variable Data section.  If the target needs to put additional
119   // information for a TLS variable, it'll go here.
120   const MCSection *TLSExtraDataSection;
121
122   /// TLSDataSection - Section directive for Thread Local data.
123   /// ELF, MachO and COFF.
124   const MCSection *TLSDataSection;        // Defaults to ".tdata".
125
126   /// TLSBSSSection - Section directive for Thread Local uninitialized data.
127   /// Null if this target doesn't support a BSS section.
128   /// ELF and MachO only.
129   const MCSection *TLSBSSSection;         // Defaults to ".tbss".
130
131
132   /// EHFrameSection - EH frame section. It is initialized on demand so it
133   /// can be overwritten (with uniquing).
134   const MCSection *EHFrameSection;
135
136   /// ELF specific sections.
137   ///
138   const MCSection *DataRelSection;
139   const MCSection *DataRelLocalSection;
140   const MCSection *DataRelROSection;
141   const MCSection *DataRelROLocalSection;
142   const MCSection *MergeableConst4Section;
143   const MCSection *MergeableConst8Section;
144   const MCSection *MergeableConst16Section;
145
146   /// MachO specific sections.
147   ///
148
149   /// TLSTLVSection - Section for thread local structure information.
150   /// Contains the source code name of the variable, visibility and a pointer
151   /// to the initial value (.tdata or .tbss).
152   const MCSection *TLSTLVSection;         // Defaults to ".tlv".
153
154   /// TLSThreadInitSection - Section for thread local data initialization
155   /// functions.
156   const MCSection *TLSThreadInitSection;  // Defaults to ".thread_init_func".
157
158   const MCSection *CStringSection;
159   const MCSection *UStringSection;
160   const MCSection *TextCoalSection;
161   const MCSection *ConstTextCoalSection;
162   const MCSection *ConstDataSection;
163   const MCSection *DataCoalSection;
164   const MCSection *DataCommonSection;
165   const MCSection *DataBSSSection;
166   const MCSection *FourByteConstantSection;
167   const MCSection *EightByteConstantSection;
168   const MCSection *SixteenByteConstantSection;
169   const MCSection *LazySymbolPointerSection;
170   const MCSection *NonLazySymbolPointerSection;
171
172   /// COFF specific sections.
173   ///
174   const MCSection *DrectveSection;
175   const MCSection *PDataSection;
176   const MCSection *XDataSection;
177
178 public:
179   void InitMCObjectFileInfo(StringRef TT, Reloc::Model RM, CodeModel::Model CM,
180                             MCContext &ctx);
181
182   bool isFunctionEHFrameSymbolPrivate() const {
183     return IsFunctionEHFrameSymbolPrivate;
184   }
185   bool getSupportsWeakOmittedEHFrame() const {
186     return SupportsWeakOmittedEHFrame;
187   }
188   bool getCommDirectiveSupportsAlignment() const {
189     return CommDirectiveSupportsAlignment;
190   }
191
192   unsigned getPersonalityEncoding() const { return PersonalityEncoding; }
193   unsigned getLSDAEncoding() const { return LSDAEncoding; }
194   unsigned getFDEEncoding(bool CFI) const {
195     return CFI ? FDECFIEncoding : FDEEncoding;
196   }
197   unsigned getTTypeEncoding() const { return TTypeEncoding; }
198
199   const MCSection *getTextSection() const { return TextSection; }
200   const MCSection *getDataSection() const { return DataSection; }
201   const MCSection *getBSSSection() const { return BSSSection; }
202   const MCSection *getLSDASection() const { return LSDASection; }
203   const MCSection *getCompactUnwindSection() const{
204     return CompactUnwindSection;
205   }
206   const MCSection *getDwarfAbbrevSection() const { return DwarfAbbrevSection; }
207   const MCSection *getDwarfInfoSection() const { return DwarfInfoSection; }
208   const MCSection *getDwarfLineSection() const { return DwarfLineSection; }
209   const MCSection *getDwarfFrameSection() const { return DwarfFrameSection; }
210   const MCSection *getDwarfPubTypesSection() const{return DwarfPubTypesSection;}
211   const MCSection *getDwarfDebugInlineSection() const {
212     return DwarfDebugInlineSection;
213   }
214   const MCSection *getDwarfStrSection() const { return DwarfStrSection; }
215   const MCSection *getDwarfLocSection() const { return DwarfLocSection; }
216   const MCSection *getDwarfARangesSection() const { return DwarfARangesSection;}
217   const MCSection *getDwarfRangesSection() const { return DwarfRangesSection; }
218   const MCSection *getDwarfMacroInfoSection() const {
219     return DwarfMacroInfoSection;
220   }
221
222   // DWARF5 Experimental Debug Info Sections
223   const MCSection *getDwarfAccelNamesSection() const {
224     return DwarfAccelNamesSection;
225   }
226   const MCSection *getDwarfAccelObjCSection() const {
227     return DwarfAccelObjCSection;
228   }
229   const MCSection *getDwarfAccelNamespaceSection() const {
230     return DwarfAccelNamespaceSection;
231   }
232   const MCSection *getDwarfAccelTypesSection() const {
233     return DwarfAccelTypesSection;
234   }
235   const MCSection *getDwarfInfoDWOSection() const {
236     return DwarfInfoDWOSection;
237   }
238   const MCSection *getDwarfAbbrevDWOSection() const {
239     return DwarfAbbrevDWOSection;
240   }
241   const MCSection *getDwarfStrDWOSection() const {
242     return DwarfStrDWOSection;
243   }
244   const MCSection *getDwarfLineDWOSection() const {
245     return DwarfLineDWOSection;
246   }
247   const MCSection *getDwarfLocDWOSection() const {
248     return DwarfLocDWOSection;
249   }
250
251   const MCSection *getTLSExtraDataSection() const {
252     return TLSExtraDataSection;
253   }
254   const MCSection *getTLSDataSection() const { return TLSDataSection; }
255   const MCSection *getTLSBSSSection() const { return TLSBSSSection; }
256
257   /// ELF specific sections.
258   ///
259   const MCSection *getDataRelSection() const { return DataRelSection; }
260   const MCSection *getDataRelLocalSection() const {
261     return DataRelLocalSection;
262   }
263   const MCSection *getDataRelROSection() const { return DataRelROSection; }
264   const MCSection *getDataRelROLocalSection() const {
265     return DataRelROLocalSection;
266   }
267   const MCSection *getMergeableConst4Section() const {
268     return MergeableConst4Section;
269   }
270   const MCSection *getMergeableConst8Section() const {
271     return MergeableConst8Section;
272   }
273   const MCSection *getMergeableConst16Section() const {
274     return MergeableConst16Section;
275   }
276
277   /// MachO specific sections.
278   ///
279   const MCSection *getTLSTLVSection() const { return TLSTLVSection; }
280   const MCSection *getTLSThreadInitSection() const {
281     return TLSThreadInitSection;
282   }
283   const MCSection *getCStringSection() const { return CStringSection; }
284   const MCSection *getUStringSection() const { return UStringSection; }
285   const MCSection *getTextCoalSection() const { return TextCoalSection; }
286   const MCSection *getConstTextCoalSection() const {
287     return ConstTextCoalSection;
288   }
289   const MCSection *getConstDataSection() const { return ConstDataSection; }
290   const MCSection *getDataCoalSection() const { return DataCoalSection; }
291   const MCSection *getDataCommonSection() const { return DataCommonSection; }
292   const MCSection *getDataBSSSection() const { return DataBSSSection; }
293   const MCSection *getFourByteConstantSection() const {
294     return FourByteConstantSection;
295   }
296   const MCSection *getEightByteConstantSection() const {
297     return EightByteConstantSection;
298   }
299   const MCSection *getSixteenByteConstantSection() const {
300     return SixteenByteConstantSection;
301   }
302   const MCSection *getLazySymbolPointerSection() const {
303     return LazySymbolPointerSection;
304   }
305   const MCSection *getNonLazySymbolPointerSection() const {
306     return NonLazySymbolPointerSection;
307   }
308
309   /// COFF specific sections.
310   ///
311   const MCSection *getDrectveSection() const { return DrectveSection; }
312   const MCSection *getPDataSection() const { return PDataSection; }
313   const MCSection *getXDataSection() const { return XDataSection; }
314
315   const MCSection *getEHFrameSection() {
316     if (!EHFrameSection)
317       InitEHFrameSection();
318     return EHFrameSection;
319   }
320
321 private:
322   enum Environment { IsMachO, IsELF, IsCOFF };
323   Environment Env;
324   Reloc::Model RelocM;
325   CodeModel::Model CMModel;
326   MCContext *Ctx;
327
328   void InitMachOMCObjectFileInfo(Triple T);
329   void InitELFMCObjectFileInfo(Triple T);
330   void InitCOFFMCObjectFileInfo(Triple T);
331
332   /// InitEHFrameSection - Initialize EHFrameSection on demand.
333   ///
334   void InitEHFrameSection();
335 };
336
337 } // end namespace llvm
338
339 #endif