Rearrange ordering of sections.
[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   // Extra TLS Variable Data section.  If the target needs to put additional
112   // information for a TLS variable, it'll go here.
113   const MCSection *TLSExtraDataSection;
114
115   /// TLSDataSection - Section directive for Thread Local data.
116   /// ELF, MachO and COFF.
117   const MCSection *TLSDataSection;        // Defaults to ".tdata".
118
119   /// TLSBSSSection - Section directive for Thread Local uninitialized data.
120   /// Null if this target doesn't support a BSS section.
121   /// ELF and MachO only.
122   const MCSection *TLSBSSSection;         // Defaults to ".tbss".
123
124
125   /// EHFrameSection - EH frame section. It is initialized on demand so it
126   /// can be overwritten (with uniquing).
127   const MCSection *EHFrameSection;
128
129   /// ELF specific sections.
130   ///
131   const MCSection *DataRelSection;
132   const MCSection *DataRelLocalSection;
133   const MCSection *DataRelROSection;
134   const MCSection *DataRelROLocalSection;
135   const MCSection *MergeableConst4Section;
136   const MCSection *MergeableConst8Section;
137   const MCSection *MergeableConst16Section;
138
139   /// MachO specific sections.
140   ///
141
142   /// TLSTLVSection - Section for thread local structure information.
143   /// Contains the source code name of the variable, visibility and a pointer
144   /// to the initial value (.tdata or .tbss).
145   const MCSection *TLSTLVSection;         // Defaults to ".tlv".
146
147   /// TLSThreadInitSection - Section for thread local data initialization
148   /// functions.
149   const MCSection *TLSThreadInitSection;  // Defaults to ".thread_init_func".
150
151   const MCSection *CStringSection;
152   const MCSection *UStringSection;
153   const MCSection *TextCoalSection;
154   const MCSection *ConstTextCoalSection;
155   const MCSection *ConstDataSection;
156   const MCSection *DataCoalSection;
157   const MCSection *DataCommonSection;
158   const MCSection *DataBSSSection;
159   const MCSection *FourByteConstantSection;
160   const MCSection *EightByteConstantSection;
161   const MCSection *SixteenByteConstantSection;
162   const MCSection *LazySymbolPointerSection;
163   const MCSection *NonLazySymbolPointerSection;
164
165   /// COFF specific sections.
166   ///
167   const MCSection *DrectveSection;
168   const MCSection *PDataSection;
169   const MCSection *XDataSection;
170
171 public:
172   void InitMCObjectFileInfo(StringRef TT, Reloc::Model RM, CodeModel::Model CM,
173                             MCContext &ctx);
174
175   bool isFunctionEHFrameSymbolPrivate() const {
176     return IsFunctionEHFrameSymbolPrivate;
177   }
178   bool getSupportsWeakOmittedEHFrame() const {
179     return SupportsWeakOmittedEHFrame;
180   }
181   bool getCommDirectiveSupportsAlignment() const {
182     return CommDirectiveSupportsAlignment;
183   }
184
185   unsigned getPersonalityEncoding() const { return PersonalityEncoding; }
186   unsigned getLSDAEncoding() const { return LSDAEncoding; }
187   unsigned getFDEEncoding(bool CFI) const {
188     return CFI ? FDECFIEncoding : FDEEncoding;
189   }
190   unsigned getTTypeEncoding() const { return TTypeEncoding; }
191
192   const MCSection *getTextSection() const { return TextSection; }
193   const MCSection *getDataSection() const { return DataSection; }
194   const MCSection *getBSSSection() const { return BSSSection; }
195   const MCSection *getLSDASection() const { return LSDASection; }
196   const MCSection *getCompactUnwindSection() const{
197     return CompactUnwindSection;
198   }
199   const MCSection *getDwarfAbbrevSection() const { return DwarfAbbrevSection; }
200   const MCSection *getDwarfInfoSection() const { return DwarfInfoSection; }
201   const MCSection *getDwarfLineSection() const { return DwarfLineSection; }
202   const MCSection *getDwarfFrameSection() const { return DwarfFrameSection; }
203   const MCSection *getDwarfPubTypesSection() const{return DwarfPubTypesSection;}
204   const MCSection *getDwarfDebugInlineSection() const {
205     return DwarfDebugInlineSection;
206   }
207   const MCSection *getDwarfStrSection() const { return DwarfStrSection; }
208   const MCSection *getDwarfLocSection() const { return DwarfLocSection; }
209   const MCSection *getDwarfARangesSection() const { return DwarfARangesSection;}
210   const MCSection *getDwarfRangesSection() const { return DwarfRangesSection; }
211   const MCSection *getDwarfMacroInfoSection() const {
212     return DwarfMacroInfoSection;
213   }
214
215   // DWARF5 Experimental Debug Info Sections
216   const MCSection *getDwarfAccelNamesSection() const {
217     return DwarfAccelNamesSection;
218   }
219   const MCSection *getDwarfAccelObjCSection() const {
220     return DwarfAccelObjCSection;
221   }
222   const MCSection *getDwarfAccelNamespaceSection() const {
223     return DwarfAccelNamespaceSection;
224   }
225   const MCSection *getDwarfAccelTypesSection() const {
226     return DwarfAccelTypesSection;
227   }
228
229   const MCSection *getTLSExtraDataSection() const {
230     return TLSExtraDataSection;
231   }
232   const MCSection *getTLSDataSection() const { return TLSDataSection; }
233   const MCSection *getTLSBSSSection() const { return TLSBSSSection; }
234
235   /// ELF specific sections.
236   ///
237   const MCSection *getDataRelSection() const { return DataRelSection; }
238   const MCSection *getDataRelLocalSection() const {
239     return DataRelLocalSection;
240   }
241   const MCSection *getDataRelROSection() const { return DataRelROSection; }
242   const MCSection *getDataRelROLocalSection() const {
243     return DataRelROLocalSection;
244   }
245   const MCSection *getMergeableConst4Section() const {
246     return MergeableConst4Section;
247   }
248   const MCSection *getMergeableConst8Section() const {
249     return MergeableConst8Section;
250   }
251   const MCSection *getMergeableConst16Section() const {
252     return MergeableConst16Section;
253   }
254
255   /// MachO specific sections.
256   ///
257   const MCSection *getTLSTLVSection() const { return TLSTLVSection; }
258   const MCSection *getTLSThreadInitSection() const {
259     return TLSThreadInitSection;
260   }
261   const MCSection *getCStringSection() const { return CStringSection; }
262   const MCSection *getUStringSection() const { return UStringSection; }
263   const MCSection *getTextCoalSection() const { return TextCoalSection; }
264   const MCSection *getConstTextCoalSection() const {
265     return ConstTextCoalSection;
266   }
267   const MCSection *getConstDataSection() const { return ConstDataSection; }
268   const MCSection *getDataCoalSection() const { return DataCoalSection; }
269   const MCSection *getDataCommonSection() const { return DataCommonSection; }
270   const MCSection *getDataBSSSection() const { return DataBSSSection; }
271   const MCSection *getFourByteConstantSection() const {
272     return FourByteConstantSection;
273   }
274   const MCSection *getEightByteConstantSection() const {
275     return EightByteConstantSection;
276   }
277   const MCSection *getSixteenByteConstantSection() const {
278     return SixteenByteConstantSection;
279   }
280   const MCSection *getLazySymbolPointerSection() const {
281     return LazySymbolPointerSection;
282   }
283   const MCSection *getNonLazySymbolPointerSection() const {
284     return NonLazySymbolPointerSection;
285   }
286
287   /// COFF specific sections.
288   ///
289   const MCSection *getDrectveSection() const { return DrectveSection; }
290   const MCSection *getPDataSection() const { return PDataSection; }
291   const MCSection *getXDataSection() const { return XDataSection; }
292
293   const MCSection *getEHFrameSection() {
294     if (!EHFrameSection)
295       InitEHFrameSection();
296     return EHFrameSection;
297   }
298
299 private:
300   enum Environment { IsMachO, IsELF, IsCOFF };
301   Environment Env;
302   Reloc::Model RelocM;
303   CodeModel::Model CMModel;
304   MCContext *Ctx;
305
306   void InitMachOMCObjectFileInfo(Triple T);
307   void InitELFMCObjectFileInfo(Triple T);
308   void InitCOFFMCObjectFileInfo(Triple T);
309
310   /// InitEHFrameSection - Initialize EHFrameSection on demand.
311   ///
312   void InitEHFrameSection();
313 };
314
315 } // end namespace llvm
316
317 #endif