Add a way of printing out an arbitrary label name for a section
[oota-llvm.git] / include / llvm / MC / MCSectionELF.h
1 //===- MCSectionELF.h - ELF Machine Code Sections ---------------*- 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 declares the MCSectionELF class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_MC_MCSECTIONELF_H
15 #define LLVM_MC_MCSECTIONELF_H
16
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/MC/MCSection.h"
19 #include "llvm/Support/ELF.h"
20 #include "llvm/Support/raw_ostream.h"
21 #include "llvm/Support/Debug.h"
22
23 namespace llvm {
24
25 class MCSymbol;
26
27 /// MCSectionELF - This represents a section on linux, lots of unix variants
28 /// and some bare metal systems.
29 class MCSectionELF : public MCSection {
30   /// SectionName - This is the name of the section.  The referenced memory is
31   /// owned by TargetLoweringObjectFileELF's ELFUniqueMap.
32   StringRef SectionName;
33
34   /// Type - This is the sh_type field of a section, drawn from the enums below.
35   unsigned Type;
36
37   /// Flags - This is the sh_flags field of a section, drawn from the enums.
38   /// below.
39   unsigned Flags;
40
41   /// EntrySize - The size of each entry in this section. This size only
42   /// makes sense for sections that contain fixed-sized entries. If a
43   /// section does not contain fixed-sized entries 'EntrySize' will be 0.
44   unsigned EntrySize;
45
46   const MCSymbol *Group;
47
48 private:
49   friend class MCContext;
50   MCSectionELF(StringRef Section, unsigned type, unsigned flags,
51                SectionKind K, unsigned entrySize, const MCSymbol *group)
52     : MCSection(SV_ELF, K), SectionName(Section), Type(type), Flags(flags),
53       EntrySize(entrySize), Group(group) {}
54   ~MCSectionELF();
55 public:
56
57   /// ShouldOmitSectionDirective - Decides whether a '.section' directive
58   /// should be printed before the section name
59   bool ShouldOmitSectionDirective(StringRef Name, const MCAsmInfo &MAI) const;
60
61   StringRef getSectionName() const { return SectionName; }
62   virtual std::string getLabelBeginName() const {
63     dbgs() << SectionName.data();
64     dbgs() << "_begin" << "\n";
65     return SectionName.str() + "_begin"; }
66   virtual std::string getLabelEndName() const {
67     return SectionName.str() + "_end";
68   }
69   unsigned getType() const { return Type; }
70   unsigned getFlags() const { return Flags; }
71   unsigned getEntrySize() const { return EntrySize; }
72   const MCSymbol *getGroup() const { return Group; }
73
74   void PrintSwitchToSection(const MCAsmInfo &MAI,
75                             raw_ostream &OS) const;
76   virtual bool UseCodeAlign() const;
77   virtual bool isVirtualSection() const;
78
79   /// isBaseAddressKnownZero - We know that non-allocatable sections (like
80   /// debug info) have a base of zero.
81   virtual bool isBaseAddressKnownZero() const {
82     return (getFlags() & ELF::SHF_ALLOC) == 0;
83   }
84
85   static bool classof(const MCSection *S) {
86     return S->getVariant() == SV_ELF;
87   }
88
89   // Return the entry size for sections with fixed-width data.
90   static unsigned DetermineEntrySize(SectionKind Kind);
91
92 };
93
94 } // end namespace llvm
95
96 #endif