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     /// Overlay information - Sections with same color can be overlaid on
  33     /// one another.
  34     int Color;
  35
  36     /// Conatined data objects.
  37     std::vector<const GlobalVariable *>Items;
  38
  39     /// Total size of all data objects contained here.
  40     unsigned Size;
  41
  42     MCSectionPIC16(const StringRef &name, SectionKind K, int addr, int color)
  43       : MCSection(K), Name(name), Address(addr), Color(color) {
  44     }
  45
  46   public:
  47     /// Return the name of the section.
  48     const std::string &getName() const { return Name; }
  49
  50     /// Return the Address of the section.
  51     int getAddress() const { return Address; }
  52
  53     /// Return the Color of the section.
  54     int getColor() const { return Color; }
  55
  56     /// PIC16 Terminology for section kinds is as below.
  57     /// UDATA - BSS
  58     /// IDATA - initialized data (equiv to Metadata)
  59     /// ROMDATA - ReadOnly.
  60     /// UDATA_OVR - Sections that can be overlaid. Section of such type is
  61     ///             used to contain function autos an frame. We can think of
  62     ///             it as equiv to llvm ThreadBSS)
  63     /// So, let's have some convenience functions to Map PIC16 Section types
  64     /// to SectionKind just for the sake of better readability.
  65     static SectionKind UDATA_Kind() { return SectionKind::getBSS(); }
  66     static SectionKind IDATA_Kind() { return SectionKind::getMetadata(); }
  67     static SectionKind ROMDATA_Kind() { return SectionKind::getReadOnly(); }
  68     static SectionKind UDATA_OVR_Kind() { return SectionKind::getThreadBSS(); }
  69
  70     // If we could just do getKind() == UDATA_Kind() ?
  71     bool isUDATA_Kind() { return getKind().isBSS(); }
  72     bool isIDATA_Kind() { return getKind().isMetadata(); }
  73     bool isROMDATA_Kind() { return getKind().isMetadata(); }
  74     bool isUDATA_OVR_Kind() { return getKind().isThreadBSS(); }
  75
  76     /// This would be the only way to create a section.
  77     static MCSectionPIC16 *Create(const StringRef &Name, SectionKind K,
  78                                   int Address, int Color, MCContext &Ctx);
  79
  80     /// Override this as PIC16 has its own way of printing switching
  81     /// to a section.
  82     virtual void PrintSwitchToSection(const MCAsmInfo &MAI,
  83                                       raw_ostream &OS) const;
  84   };
  85
  86 } // end namespace llvm
  87
  88 #endif