reject invalid code like:
[oota-llvm.git] / include / llvm / Target / TargetLoweringObjectFile.h
1 //===-- llvm/Target/TargetLoweringObjectFile.h - Object 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 implements classes used to handle lowerings specific to common
11 // object file formats.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_TARGET_TARGETLOWERINGOBJECTFILE_H
16 #define LLVM_TARGET_TARGETLOWERINGOBJECTFILE_H
17
18 #include "llvm/MC/SectionKind.h"
19
20 namespace llvm {
21   class Mangler;
22   class MCSection;
23   class MCSectionMachO;
24   class MCContext;
25   class GlobalValue;
26   class StringRef;
27   class TargetMachine;
28   class TargetAsmInfo;
29   
30 class TargetLoweringObjectFile {
31   MCContext *Ctx;
32   
33   TargetLoweringObjectFile(const TargetLoweringObjectFile&); // DO NOT IMPLEMENT
34   void operator=(const TargetLoweringObjectFile&);           // DO NOT IMPLEMENT
35 protected:
36   
37   TargetLoweringObjectFile();
38   
39   /// TextSection - Section directive for standard text.
40   ///
41   const MCSection *TextSection;
42   
43   /// DataSection - Section directive for standard data.
44   ///
45   const MCSection *DataSection;
46   
47   /// BSSSection - Section that is default initialized to zero.
48   const MCSection *BSSSection;
49   
50   /// ReadOnlySection - Section that is readonly and can contain arbitrary
51   /// initialized data.  Targets are not required to have a readonly section.
52   /// If they don't, various bits of code will fall back to using the data
53   /// section for constants.
54   const MCSection *ReadOnlySection;
55   
56   /// StaticCtorSection - This section contains the static constructor pointer
57   /// list.
58   const MCSection *StaticCtorSection;
59
60   /// StaticDtorSection - This section contains the static destructor pointer
61   /// list.
62   const MCSection *StaticDtorSection;
63   
64   /// LSDASection - If exception handling is supported by the target, this is
65   /// the section the Language Specific Data Area information is emitted to.
66   const MCSection *LSDASection;
67   
68   /// EHFrameSection - If exception handling is supported by the target, this is
69   /// the section the EH Frame is emitted to.
70   const MCSection *EHFrameSection;
71   
72   // Dwarf sections for debug info.  If a target supports debug info, these must
73   // be set.
74   const MCSection *DwarfAbbrevSection;
75   const MCSection *DwarfInfoSection;
76   const MCSection *DwarfLineSection;
77   const MCSection *DwarfFrameSection;
78   const MCSection *DwarfPubNamesSection;
79   const MCSection *DwarfPubTypesSection;
80   const MCSection *DwarfDebugInlineSection;
81   const MCSection *DwarfStrSection;
82   const MCSection *DwarfLocSection;
83   const MCSection *DwarfARangesSection;
84   const MCSection *DwarfRangesSection;
85   const MCSection *DwarfMacroInfoSection;
86   
87 public:
88   
89   MCContext &getContext() const { return *Ctx; }
90   
91
92   virtual ~TargetLoweringObjectFile();
93   
94   /// Initialize - this method must be called before any actual lowering is
95   /// done.  This specifies the current context for codegen, and gives the
96   /// lowering implementations a chance to set up their default sections.
97   virtual void Initialize(MCContext &ctx, const TargetMachine &TM) {
98     Ctx = &ctx;
99   }
100   
101   
102   const MCSection *getTextSection() const { return TextSection; }
103   const MCSection *getDataSection() const { return DataSection; }
104   const MCSection *getStaticCtorSection() const { return StaticCtorSection; }
105   const MCSection *getStaticDtorSection() const { return StaticDtorSection; }
106   const MCSection *getLSDASection() const { return LSDASection; }
107   const MCSection *getEHFrameSection() const { return EHFrameSection; }
108   const MCSection *getDwarfAbbrevSection() const { return DwarfAbbrevSection; }
109   const MCSection *getDwarfInfoSection() const { return DwarfInfoSection; }
110   const MCSection *getDwarfLineSection() const { return DwarfLineSection; }
111   const MCSection *getDwarfFrameSection() const { return DwarfFrameSection; }
112   const MCSection *getDwarfPubNamesSection() const{return DwarfPubNamesSection;}
113   const MCSection *getDwarfPubTypesSection() const{return DwarfPubTypesSection;}
114   const MCSection *getDwarfDebugInlineSection() const {
115     return DwarfDebugInlineSection;
116   }
117   const MCSection *getDwarfStrSection() const { return DwarfStrSection; }
118   const MCSection *getDwarfLocSection() const { return DwarfLocSection; }
119   const MCSection *getDwarfARangesSection() const { return DwarfARangesSection;}
120   const MCSection *getDwarfRangesSection() const { return DwarfRangesSection; }
121   const MCSection *getDwarfMacroInfoSection() const {
122     return DwarfMacroInfoSection;
123   }
124   
125   /// shouldEmitUsedDirectiveFor - This hook allows targets to selectively
126   /// decide not to emit the UsedDirective for some symbols in llvm.used.
127   /// FIXME: REMOVE this (rdar://7071300)
128   virtual bool shouldEmitUsedDirectiveFor(const GlobalValue *GV,
129                                           Mangler *) const {
130     return GV != 0;
131   }
132   
133   /// getSectionForConstant - Given a constant with the SectionKind, return a
134   /// section that it should be placed in.
135   virtual const MCSection *getSectionForConstant(SectionKind Kind) const;
136   
137   /// getKindForGlobal - Classify the specified global variable into a set of
138   /// target independent categories embodied in SectionKind.
139   static SectionKind getKindForGlobal(const GlobalValue *GV,
140                                       const TargetMachine &TM);
141   
142   /// SectionForGlobal - This method computes the appropriate section to emit
143   /// the specified global variable or function definition.  This should not
144   /// be passed external (or available externally) globals.
145   const MCSection *SectionForGlobal(const GlobalValue *GV,
146                                     SectionKind Kind, Mangler *Mang,
147                                     const TargetMachine &TM) const;
148   
149   /// SectionForGlobal - This method computes the appropriate section to emit
150   /// the specified global variable or function definition.  This should not
151   /// be passed external (or available externally) globals.
152   const MCSection *SectionForGlobal(const GlobalValue *GV,
153                                     Mangler *Mang,
154                                     const TargetMachine &TM) const {
155     return SectionForGlobal(GV, getKindForGlobal(GV, TM), Mang, TM);
156   }
157   
158   
159   
160   /// getExplicitSectionGlobal - Targets should implement this method to assign
161   /// a section to globals with an explicit section specfied.  The
162   /// implementation of this method can assume that GV->hasSection() is true.
163   virtual const MCSection *
164   getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind, 
165                            Mangler *Mang, const TargetMachine &TM) const = 0;
166   
167   /// getSpecialCasedSectionGlobals - Allow the target to completely override
168   /// section assignment of a global.
169   virtual const MCSection *
170   getSpecialCasedSectionGlobals(const GlobalValue *GV, Mangler *Mang,
171                                 SectionKind Kind) const {
172     return 0;
173   }
174   
175 protected:
176   virtual const MCSection *
177   SelectSectionForGlobal(const GlobalValue *GV, SectionKind Kind,
178                          Mangler *Mang, const TargetMachine &TM) const;
179 };
180   
181   
182   
183
184 class TargetLoweringObjectFileELF : public TargetLoweringObjectFile {
185   bool HasCrazyBSS;
186 protected:
187   /// TLSDataSection - Section directive for Thread Local data.
188   ///
189   const MCSection *TLSDataSection;        // Defaults to ".tdata".
190   
191   /// TLSBSSSection - Section directive for Thread Local uninitialized data.
192   /// Null if this target doesn't support a BSS section.
193   ///
194   const MCSection *TLSBSSSection;         // Defaults to ".tbss".
195   
196   const MCSection *DataRelSection;
197   const MCSection *DataRelLocalSection;
198   const MCSection *DataRelROSection;
199   const MCSection *DataRelROLocalSection;
200   
201   const MCSection *MergeableConst4Section;
202   const MCSection *MergeableConst8Section;
203   const MCSection *MergeableConst16Section;
204   
205 protected:
206   const MCSection *getELFSection(const char *Name, bool isDirective,
207                                  SectionKind Kind) const;
208 public:
209   TargetLoweringObjectFileELF(// FIXME: REMOVE AFTER UNIQUING IS FIXED.
210                               bool hasCrazyBSS = false)
211     : HasCrazyBSS(hasCrazyBSS) {}
212   
213   virtual void Initialize(MCContext &Ctx, const TargetMachine &TM);
214   
215   /// getSectionForConstant - Given a constant with the SectionKind, return a
216   /// section that it should be placed in.
217   virtual const MCSection *getSectionForConstant(SectionKind Kind) const;
218   
219   
220   virtual const MCSection *
221   getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind, 
222                            Mangler *Mang, const TargetMachine &TM) const;
223   
224   virtual const MCSection *
225   SelectSectionForGlobal(const GlobalValue *GV, SectionKind Kind,
226                          Mangler *Mang, const TargetMachine &TM) const;
227 };
228
229   
230   
231 class TargetLoweringObjectFileMachO : public TargetLoweringObjectFile {
232   mutable void *UniquingMap;
233   
234   const MCSection *CStringSection;
235   const MCSection *UStringSection;
236   const MCSection *TextCoalSection;
237   const MCSection *ConstTextCoalSection;
238   const MCSection *ConstDataCoalSection;
239   const MCSection *ConstDataSection;
240   const MCSection *DataCoalSection;
241   const MCSection *FourByteConstantSection;
242   const MCSection *EightByteConstantSection;
243   const MCSection *SixteenByteConstantSection;
244   
245   const MCSection *LazySymbolPointerSection;
246   const MCSection *NonLazySymbolPointerSection;
247 public:
248   TargetLoweringObjectFileMachO() : UniquingMap(0) {}
249   ~TargetLoweringObjectFileMachO();
250   
251   virtual void Initialize(MCContext &Ctx, const TargetMachine &TM);
252
253   virtual const MCSection *
254   SelectSectionForGlobal(const GlobalValue *GV, SectionKind Kind,
255                          Mangler *Mang, const TargetMachine &TM) const;
256   
257   virtual const MCSection *
258   getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind, 
259                            Mangler *Mang, const TargetMachine &TM) const;
260   
261   virtual const MCSection *getSectionForConstant(SectionKind Kind) const;
262   
263   /// shouldEmitUsedDirectiveFor - This hook allows targets to selectively
264   /// decide not to emit the UsedDirective for some symbols in llvm.used.
265   /// FIXME: REMOVE this (rdar://7071300)
266   virtual bool shouldEmitUsedDirectiveFor(const GlobalValue *GV,
267                                           Mangler *) const;
268
269   /// getMachOSection - Return the MCSection for the specified mach-o section.
270   /// This requires the operands to be valid.
271   const MCSectionMachO *getMachOSection(const StringRef &Segment,
272                                         const StringRef &Section,
273                                         unsigned TypeAndAttributes,
274                                         SectionKind K) const {
275     return getMachOSection(Segment, Section, TypeAndAttributes, 0, K);
276   }
277   const MCSectionMachO *getMachOSection(const StringRef &Segment,
278                                         const StringRef &Section,
279                                         unsigned TypeAndAttributes,
280                                         unsigned Reserved2,
281                                         SectionKind K) const;
282
283   /// getTextCoalSection - Return the "__TEXT,__textcoal_nt" section we put weak
284   /// symbols into.
285   const MCSection *getTextCoalSection() const {
286     return TextCoalSection;
287   }
288   
289   /// getLazySymbolPointerSection - Return the section corresponding to
290   /// the .lazy_symbol_pointer directive.
291   const MCSection *getLazySymbolPointerSection() const {
292     return LazySymbolPointerSection;
293   }
294   
295   /// getNonLazySymbolPointerSection - Return the section corresponding to
296   /// the .non_lazy_symbol_pointer directive.
297   const MCSection *getNonLazySymbolPointerSection() const {
298     return NonLazySymbolPointerSection;
299   }
300 };
301
302
303
304 class TargetLoweringObjectFileCOFF : public TargetLoweringObjectFile {
305 public:
306   virtual void Initialize(MCContext &Ctx, const TargetMachine &TM);
307   
308   virtual const MCSection *
309   getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind, 
310                            Mangler *Mang, const TargetMachine &TM) const;
311   
312   virtual const MCSection *
313   SelectSectionForGlobal(const GlobalValue *GV, SectionKind Kind,
314                          Mangler *Mang, const TargetMachine &TM) const;
315
316   /// getCOFFSection - Return the MCSection for the specified COFF section.
317   /// FIXME: Switch this to a semantic view eventually.
318   const MCSection *getCOFFSection(const char *Name, bool isDirective,
319                                   SectionKind K) const;
320 };
321
322 } // end namespace llvm
323
324 #endif