lib/Target/PIC16/MCSectionPIC16.h

   1 //===- MCSectionPIC16.h - PIC16-specific section representation -*- 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 MCSectionPIC16 class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_PIC16SECTION_H
  15 #define LLVM_PIC16SECTION_H
  16
  17 #include "llvm/MC/MCSection.h"
  18
  19 namespace llvm {
  20
  21   /// MCSectionPIC16 - Represents a physical section in PIC16 COFF.
  22   /// Contains data objects.
  23   ///
  24   class MCSectionPIC16 : public MCSection {
  25     /// Name of the section to uniquely identify it.
  26     std::string Name;
  27
  28     /// User can specify an address at which a section should be placed.
  29     /// Negative value here means user hasn't specified any.
  30     int Address;
  31
  32     /// FIXME: Keep overlay information here. uncomment the decl below.
  33     /// Overlay information - Sections with same color can be overlaid on
  34     /// one another.
  35     /// std::string Color;
  36
  37     /// Conatined data objects.
  38     std::vector<const GlobalVariable *>Items;
  39
  40     /// Total size of all data objects contained here.
  41     unsigned Size;
  42
  43     MCSectionPIC16(const StringRef &name, SectionKind K, int addr)
  44       : MCSection(K), Name(name), Address(addr) {
  45     }
  46
  47   public:
  48     /// Return the name of the section.
  49     const std::string &getName() const { return Name; }
  50
  51     /// Return the Address of the section.
  52     int getAddress() const { return Address; }
  53
  54     /// PIC16 Terminology for section kinds is as below.
  55     /// UDATA - BSS
  56     /// IDATA - initialized data (equiv to Metadata)
  57     /// ROMDATA - ReadOnly.
  58     /// UDATA_OVR - Sections that can be overlaid. Section of such type is
  59     ///             used to contain function autos an frame. We can think of
  60     ///             it as equiv to llvm ThreadBSS)
  61     /// So, let's have some convenience functions to Map PIC16 Section types
  62     /// to SectionKind just for the sake of better readability.
  63     static SectionKind UDATA_Kind() { return SectionKind::getBSS(); }
  64     static SectionKind IDATA_Kind() { return SectionKind::getMetadata(); }
  65     static SectionKind ROMDATA_Kind() { return SectionKind::getReadOnly(); }
  66     static SectionKind UDATA_OVR_Kind() { return SectionKind::getThreadBSS(); }
  67
  68     // If we could just do getKind() == UDATA_Kind() ?
  69     bool isUDATA_Kind() { return getKind().isBSS(); }
  70     bool isIDATA_Kind() { return getKind().isMetadata(); }
  71     bool isROMDATA_Kind() { return getKind().isMetadata(); }
  72     bool isUDATA_OVR_Kind() { return getKind().isThreadBSS(); }
  73
  74     /// This would be the only way to create a section.
  75     static MCSectionPIC16 *Create(const StringRef &Name, SectionKind K,
  76                                   int Address, MCContext &Ctx);
  77
  78     /// Override this as PIC16 has its own way of printing switching
  79     /// to a section.
  80     virtual void PrintSwitchToSection(const MCAsmInfo &MAI,
  81                                       raw_ostream &OS) const;
  82   };
  83
  84 } // end namespace llvm
  85
  86 #endif