include/llvm/Object/RelocVisitor.h

   1 //===-- RelocVisitor.h - Visitor for object file relocations -*- 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 provides a wrapper around all the different types of relocations
  11 // in different file formats, such that a client can handle them in a unified
  12 // manner by only implementing a minimal number of functions.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_OBJECT_RELOCVISITOR_H
  17 #define LLVM_OBJECT_RELOCVISITOR_H
  18
  19 #include "llvm/ADT/StringRef.h"
  20 #include "llvm/Object/ObjectFile.h"
  21 #include "llvm/Object/ELF.h"
  22 #include "llvm/Support/Debug.h"
  23 #include "llvm/Support/ELF.h"
  24 #include "llvm/Support/raw_ostream.h"
  25
  26 namespace llvm {
  27 namespace object {
  28
  29 struct RelocToApply {
  30   // The computed value after applying the relevant relocations.
  31   int64_t Value;
  32
  33   // The width of the value; how many bytes to touch when applying the
  34   // relocation.
  35   char Width;
  36   RelocToApply(const RelocToApply &In) : Value(In.Value), Width(In.Width) {}
  37   RelocToApply(int64_t Value, char Width) : Value(Value), Width(Width) {}
  38   RelocToApply() : Value(0), Width(0) {}
  39 };
  40
  41 /// @brief Base class for object file relocation visitors.
  42 class RelocVisitor {
  43 public:
  44   explicit RelocVisitor(StringRef FileFormat)
  45     : FileFormat(FileFormat), HasError(false) {}
  46
  47   // TODO: Should handle multiple applied relocations via either passing in the
  48   // previously computed value or just count paired relocations as a single
  49   // visit.
  50   RelocToApply visit(uint32_t RelocType, RelocationRef R, uint64_t SecAddr = 0,
  51                      uint64_t Value = 0) {
  52     if (FileFormat == "ELF64-x86-64") {
  53       switch (RelocType) {
  54         case llvm::ELF::R_X86_64_NONE:
  55           return visitELF_X86_64_NONE(R);
  56         case llvm::ELF::R_X86_64_64:
  57           return visitELF_X86_64_64(R, Value);
  58         case llvm::ELF::R_X86_64_PC32:
  59           return visitELF_X86_64_PC32(R, Value, SecAddr);
  60         case llvm::ELF::R_X86_64_32:
  61           return visitELF_X86_64_32(R, Value);
  62         case llvm::ELF::R_X86_64_32S:
  63           return visitELF_X86_64_32S(R, Value);
  64         default:
  65           HasError = true;
  66           return RelocToApply();
  67       }
  68     } else if (FileFormat == "ELF32-i386") {
  69       switch (RelocType) {
  70       case llvm::ELF::R_386_NONE:
  71         return visitELF_386_NONE(R);
  72       case llvm::ELF::R_386_32:
  73         return visitELF_386_32(R, Value);
  74       case llvm::ELF::R_386_PC32:
  75         return visitELF_386_PC32(R, Value, SecAddr);
  76       default:
  77         HasError = true;
  78         return RelocToApply();
  79       }
  80     } else if (FileFormat == "ELF64-ppc64") {
  81       switch (RelocType) {
  82       case llvm::ELF::R_PPC64_ADDR32:
  83         return visitELF_PPC64_ADDR32(R, Value);
  84       default:
  85         HasError = true;
  86         return RelocToApply();
  87       }
  88     } else if (FileFormat == "ELF32-mips") {
  89       switch (RelocType) {
  90       case llvm::ELF::R_MIPS_32:
  91         return visitELF_MIPS_32(R, Value);
  92       default:
  93         HasError = true;
  94         return RelocToApply();
  95       }
  96     } else if (FileFormat == "ELF64-aarch64") {
  97       switch (RelocType) {
  98       case llvm::ELF::R_AARCH64_ABS32:
  99         return visitELF_AARCH64_ABS32(R, Value);
 100       case llvm::ELF::R_AARCH64_ABS64:
 101         return visitELF_AARCH64_ABS64(R, Value);
 102       default:
 103         HasError = true;
 104         return RelocToApply();
 105       }
 106     } else if (FileFormat == "ELF64-s390") {
 107       switch (RelocType) {
 108       case llvm::ELF::R_390_32:
 109         return visitELF_390_32(R, Value);
 110       case llvm::ELF::R_390_64:
 111         return visitELF_390_64(R, Value);
 112       default:
 113         HasError = true;
 114         return RelocToApply();
 115       }
 116     }
 117     HasError = true;
 118     return RelocToApply();
 119   }
 120
 121   bool error() { return HasError; }
 122
 123 private:
 124   StringRef FileFormat;
 125   bool HasError;
 126
 127   int64_t getAddend32LE(RelocationRef R) {
 128     const ELF32LEObjectFile *Obj = cast<ELF32LEObjectFile>(R.getObjectFile());
 129     DataRefImpl DRI = R.getRawDataRefImpl();
 130     int64_t Addend;
 131     Obj->getRelocationAddend(DRI, Addend);
 132     return Addend;
 133   }
 134
 135   int64_t getAddend64LE(RelocationRef R) {
 136     const ELF64LEObjectFile *Obj = cast<ELF64LEObjectFile>(R.getObjectFile());
 137     DataRefImpl DRI = R.getRawDataRefImpl();
 138     int64_t Addend;
 139     Obj->getRelocationAddend(DRI, Addend);
 140     return Addend;
 141   }
 142
 143   int64_t getAddend32BE(RelocationRef R) {
 144     const ELF32BEObjectFile *Obj = cast<ELF32BEObjectFile>(R.getObjectFile());
 145     DataRefImpl DRI = R.getRawDataRefImpl();
 146     int64_t Addend;
 147     Obj->getRelocationAddend(DRI, Addend);
 148     return Addend;
 149   }
 150
 151   int64_t getAddend64BE(RelocationRef R) {
 152     const ELF64BEObjectFile *Obj = cast<ELF64BEObjectFile>(R.getObjectFile());
 153     DataRefImpl DRI = R.getRawDataRefImpl();
 154     int64_t Addend;
 155     Obj->getRelocationAddend(DRI, Addend);
 156     return Addend;
 157   }
 158   /// Operations
 159
 160   /// 386-ELF
 161   RelocToApply visitELF_386_NONE(RelocationRef R) {
 162     return RelocToApply(0, 0);
 163   }
 164
 165   // Ideally the Addend here will be the addend in the data for
 166   // the relocation. It's not actually the case for Rel relocations.
 167   RelocToApply visitELF_386_32(RelocationRef R, uint64_t Value) {
 168     int64_t Addend = getAddend32LE(R);
 169     return RelocToApply(Value + Addend, 4);
 170   }
 171
 172   RelocToApply visitELF_386_PC32(RelocationRef R, uint64_t Value,
 173                                  uint64_t SecAddr) {
 174     int64_t Addend = getAddend32LE(R);
 175     uint64_t Address;
 176     R.getOffset(Address);
 177     return RelocToApply(Value + Addend - Address, 4);
 178   }
 179
 180   /// X86-64 ELF
 181   RelocToApply visitELF_X86_64_NONE(RelocationRef R) {
 182     return RelocToApply(0, 0);
 183   }
 184   RelocToApply visitELF_X86_64_64(RelocationRef R, uint64_t Value) {
 185     int64_t Addend = getAddend64LE(R);
 186     return RelocToApply(Value + Addend, 8);
 187   }
 188   RelocToApply visitELF_X86_64_PC32(RelocationRef R, uint64_t Value,
 189                                     uint64_t SecAddr) {
 190     int64_t Addend = getAddend64LE(R);
 191     uint64_t Address;
 192     R.getOffset(Address);
 193     return RelocToApply(Value + Addend - Address, 4);
 194   }
 195   RelocToApply visitELF_X86_64_32(RelocationRef R, uint64_t Value) {
 196     int64_t Addend = getAddend64LE(R);
 197     uint32_t Res = (Value + Addend) & 0xFFFFFFFF;
 198     return RelocToApply(Res, 4);
 199   }
 200   RelocToApply visitELF_X86_64_32S(RelocationRef R, uint64_t Value) {
 201     int64_t Addend = getAddend64LE(R);
 202     int32_t Res = (Value + Addend) & 0xFFFFFFFF;
 203     return RelocToApply(Res, 4);
 204   }
 205
 206   /// PPC64 ELF
 207   RelocToApply visitELF_PPC64_ADDR32(RelocationRef R, uint64_t Value) {
 208     int64_t Addend = getAddend64BE(R);
 209     uint32_t Res = (Value + Addend) & 0xFFFFFFFF;
 210     return RelocToApply(Res, 4);
 211   }
 212
 213   /// MIPS ELF
 214   RelocToApply visitELF_MIPS_32(RelocationRef R, uint64_t Value) {
 215     int64_t Addend;
 216     getELFRelocationAddend(R, Addend);
 217     uint32_t Res = (Value + Addend) & 0xFFFFFFFF;
 218     return RelocToApply(Res, 4);
 219   }
 220
 221   // AArch64 ELF
 222   RelocToApply visitELF_AARCH64_ABS32(RelocationRef R, uint64_t Value) {
 223     int64_t Addend = getAddend64LE(R);
 224     int64_t Res =  Value + Addend;
 225
 226     // Overflow check allows for both signed and unsigned interpretation.
 227     if (Res < INT32_MIN || Res > UINT32_MAX)
 228       HasError = true;
 229
 230     return RelocToApply(static_cast<uint32_t>(Res), 4);
 231   }
 232
 233   RelocToApply visitELF_AARCH64_ABS64(RelocationRef R, uint64_t Value) {
 234     int64_t Addend = getAddend64LE(R);
 235     return RelocToApply(Value + Addend, 8);
 236   }
 237
 238   // SystemZ ELF
 239   RelocToApply visitELF_390_32(RelocationRef R, uint64_t Value) {
 240     int64_t Addend = getAddend64BE(R);
 241     int64_t Res = Value + Addend;
 242
 243     // Overflow check allows for both signed and unsigned interpretation.
 244     if (Res < INT32_MIN || Res > UINT32_MAX)
 245       HasError = true;
 246
 247     return RelocToApply(static_cast<uint32_t>(Res), 4);
 248   }
 249
 250   RelocToApply visitELF_390_64(RelocationRef R, uint64_t Value) {
 251     int64_t Addend = getAddend64BE(R);
 252     return RelocToApply(Value + Addend, 8);
 253   }
 254 };
 255
 256 }
 257 }
 258 #endif