e5754249e91b5445a0d6c67ae929ff99b05847f2
[oota-llvm.git] / include / llvm / MC / MCSection.h
1 //===- MCSection.h - 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 MCSection class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_MC_MCSECTION_H
15 #define LLVM_MC_MCSECTION_H
16
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/MC/SectionKind.h"
19 #include "llvm/Support/Compiler.h"
20
21 namespace llvm {
22   class MCAsmInfo;
23   class raw_ostream;
24
25   /// MCSection - Instances of this class represent a uniqued identifier for a
26   /// section in the current translation unit.  The MCContext class uniques and
27   /// creates these.
28   class MCSection {
29   public:
30     enum SectionVariant {
31       SV_COFF = 0,
32       SV_ELF,
33       SV_MachO
34     };
35
36   private:
37     MCSection(const MCSection&) LLVM_DELETED_FUNCTION;
38     void operator=(const MCSection&) LLVM_DELETED_FUNCTION;
39   protected:
40     MCSection(SectionVariant V, SectionKind K) : Variant(V), Kind(K) {}
41     SectionVariant Variant;
42     SectionKind Kind;
43   public:
44     virtual ~MCSection();
45
46     SectionKind getKind() const { return Kind; }
47
48     SectionVariant getVariant() const { return Variant; }
49
50     virtual void PrintSwitchToSection(const MCAsmInfo &MAI,
51                                       raw_ostream &OS) const = 0;
52
53     // Convenience routines to get label names for the beginning/end of a
54     // section.
55     virtual std::string getLabelBeginName() const = 0;
56     virtual std::string getLabelEndName() const = 0;
57
58     /// isBaseAddressKnownZero - Return true if we know that this section will
59     /// get a base address of zero.  In cases where we know that this is true we
60     /// can emit section offsets as direct references to avoid a subtraction
61     /// from the base of the section, saving a relocation.
62     virtual bool isBaseAddressKnownZero() const {
63       return false;
64     }
65
66     // UseCodeAlign - Return true if a .align directive should use
67     // "optimized nops" to fill instead of 0s.
68     virtual bool UseCodeAlign() const = 0;
69
70     /// isVirtualSection - Check whether this section is "virtual", that is
71     /// has no actual object file contents.
72     virtual bool isVirtualSection() const = 0;
73   };
74
75 } // end namespace llvm
76
77 #endif