include/llvm/MC/MCELFObjectWriter.h

   1 //===-- llvm/MC/MCELFObjectWriter.h - ELF Object Writer ---------*- 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 #ifndef LLVM_MC_MCELFOBJECTWRITER_H
  11 #define LLVM_MC_MCELFOBJECTWRITER_H
  12
  13 #include "llvm/ADT/Triple.h"
  14 #include "llvm/Support/DataTypes.h"
  15 #include "llvm/Support/ELF.h"
  16 #include <vector>
  17
  18 namespace llvm {
  19 class MCAssembler;
  20 class MCFixup;
  21 class MCFragment;
  22 class MCObjectWriter;
  23 class MCSectionData;
  24 class MCSymbol;
  25 class MCSymbolData;
  26 class MCValue;
  27
  28 class MCELFObjectTargetWriter {
  29   const uint8_t OSABI;
  30   const uint16_t EMachine;
  31   const unsigned HasRelocationAddend : 1;
  32   const unsigned Is64Bit : 1;
  33   const unsigned IsN64 : 1;
  34
  35 protected:
  36
  37   MCELFObjectTargetWriter(bool Is64Bit_, uint8_t OSABI_,
  38                           uint16_t EMachine_,  bool HasRelocationAddend,
  39                           bool IsN64=false);
  40
  41 public:
  42   static uint8_t getOSABI(Triple::OSType OSType) {
  43     switch (OSType) {
  44       case Triple::PS4:
  45       case Triple::FreeBSD:
  46         return ELF::ELFOSABI_FREEBSD;
  47       case Triple::Linux:
  48         return ELF::ELFOSABI_LINUX;
  49       default:
  50         return ELF::ELFOSABI_NONE;
  51     }
  52   }
  53
  54   virtual ~MCELFObjectTargetWriter() {}
  55
  56   virtual unsigned GetRelocType(const MCValue &Target, const MCFixup &Fixup,
  57                                 bool IsPCRel) const = 0;
  58
  59   virtual bool needsRelocateWithSymbol(const MCSymbolData &SD,
  60                                        unsigned Type) const;
  61
  62   /// @name Accessors
  63   /// @{
  64   uint8_t getOSABI() const { return OSABI; }
  65   uint16_t getEMachine() const { return EMachine; }
  66   bool hasRelocationAddend() const { return HasRelocationAddend; }
  67   bool is64Bit() const { return Is64Bit; }
  68   bool isN64() const { return IsN64; }
  69   /// @}
  70
  71   // Instead of changing everyone's API we pack the N64 Type fields
  72   // into the existing 32 bit data unsigned.
  73 #define R_TYPE_SHIFT 0
  74 #define R_TYPE_MASK 0xffffff00
  75 #define R_TYPE2_SHIFT 8
  76 #define R_TYPE2_MASK 0xffff00ff
  77 #define R_TYPE3_SHIFT 16
  78 #define R_TYPE3_MASK 0xff00ffff
  79 #define R_SSYM_SHIFT 24
  80 #define R_SSYM_MASK 0x00ffffff
  81
  82   // N64 relocation type accessors
  83   uint8_t getRType(uint32_t Type) const {
  84     return (unsigned)((Type >> R_TYPE_SHIFT) & 0xff);
  85   }
  86   uint8_t getRType2(uint32_t Type) const {
  87     return (unsigned)((Type >> R_TYPE2_SHIFT) & 0xff);
  88   }
  89   uint8_t getRType3(uint32_t Type) const {
  90     return (unsigned)((Type >> R_TYPE3_SHIFT) & 0xff);
  91   }
  92   uint8_t getRSsym(uint32_t Type) const {
  93     return (unsigned)((Type >> R_SSYM_SHIFT) & 0xff);
  94   }
  95
  96   // N64 relocation type setting
  97   unsigned setRType(unsigned Value, unsigned Type) const {
  98     return ((Type & R_TYPE_MASK) | ((Value & 0xff) << R_TYPE_SHIFT));
  99   }
 100   unsigned setRType2(unsigned Value, unsigned Type) const {
 101     return (Type & R_TYPE2_MASK) | ((Value & 0xff) << R_TYPE2_SHIFT);
 102   }
 103   unsigned setRType3(unsigned Value, unsigned Type) const {
 104     return (Type & R_TYPE3_MASK) | ((Value & 0xff) << R_TYPE3_SHIFT);
 105   }
 106   unsigned setRSsym(unsigned Value, unsigned Type) const {
 107     return (Type & R_SSYM_MASK) | ((Value & 0xff) << R_SSYM_SHIFT);
 108   }
 109 };
 110
 111 /// \brief Construct a new ELF writer instance.
 112 ///
 113 /// \param MOTW - The target specific ELF writer subclass.
 114 /// \param OS - The stream to write to.
 115 /// \returns The constructed object writer.
 116 MCObjectWriter *createELFObjectWriter(MCELFObjectTargetWriter *MOTW,
 117                                       raw_ostream &OS, bool IsLittleEndian);
 118 } // End llvm namespace
 119
 120 #endif