DynamicEntry.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2026 R. Thomas
 * Copyright 2017 - 2026 Quarkslab
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef LIEF_ELF_DYNAMIC_ENTRY_H
#define LIEF_ELF_DYNAMIC_ENTRY_H
 
#include <ostream>
#include <memory>
#include <cstdint>
 
#include "LIEF/visibility.h"
#include "LIEF/Object.hpp"
#include "LIEF/ELF/enums.hpp"
 
namespace LIEF {
namespace ELF {
namespace details {
struct Elf64_Dyn;
struct Elf32_Dyn;
}

class LIEF_API DynamicEntry : public Object {
  public:
  // clang-format off
  static constexpr uint64_t MIPS_DISC    = 0x100000000;
  static constexpr uint64_t AARCH64_DISC = 0x200000000;
  static constexpr uint64_t HEXAGON_DISC = 0x300000000;
  static constexpr uint64_t PPC_DISC     = 0x400000000;
  static constexpr uint64_t PPC64_DISC   = 0x500000000;
  static constexpr uint64_t RISCV_DISC   = 0x600000000;
  static constexpr uint64_t X86_64_DISC  = 0x700000000;
  static constexpr uint64_t IA_64_DISC   = 0x800000000;
 
  enum class TAG : uint64_t {
    UNKNOWN = uint64_t(-1),
    DT_NULL_ = 0,         
    NEEDED = 1,           
    PLTRELSZ = 2,         
    PLTGOT = 3,           
    HASH = 4,             
    STRTAB = 5,           
    SYMTAB = 6,           
    RELA = 7,             
    RELASZ = 8,           
    RELAENT = 9,          
    STRSZ = 10,           
    SYMENT = 11,          
    INIT = 12,            
    FINI = 13,            
    SONAME = 14,          
    RPATH = 15,           
    SYMBOLIC = 16,        
    REL = 17,             
    RELSZ = 18,           
    RELENT = 19,          
    PLTREL = 20,          
    DEBUG_TAG = 21,       
    TEXTREL = 22,         
    JMPREL = 23,          
    BIND_NOW = 24,        
    INIT_ARRAY = 25,      
    FINI_ARRAY = 26,      
    INIT_ARRAYSZ = 27,    
    FINI_ARRAYSZ = 28,    
    RUNPATH = 29,         
    FLAGS = 30,           
    PREINIT_ARRAY = 32,   
    PREINIT_ARRAYSZ = 33, 
    SYMTAB_SHNDX = 34,    
    RELRSZ = 35,          
    RELR = 36,            
    RELRENT = 37,         
 
    // GNU Extensions
    GNU_HASH    = 0x6FFFFEF5, 
    TLSDESC_PLT = 0x6FFFFEF6, 
    TLSDESC_GOT = 0x6FFFFEF7, 
    RELACOUNT   = 0x6FFFFFF9, 
    RELCOUNT    = 0x6FFFFFFA, 
    FLAGS_1     = 0x6FFFFFFB, 
    VERSYM      = 0x6FFFFFF0, 
    VERDEF      = 0x6FFFFFFC, 
    VERDEFNUM   = 0x6FFFFFFD, 
    VERNEED     = 0x6FFFFFFE, 
    VERNEEDNUM  = 0x6FFFFFFF, 
 
    AUXILIARY = 0x7ffffffd, 
    FILTER    = 0x7fffffff, 
 
    // Android Extensions
    ANDROID_REL_OFFSET = 0x6000000D, 
    ANDROID_REL_SIZE   = 0x6000000E, 
    ANDROID_REL        = 0x6000000F, 
    ANDROID_RELSZ      = 0x60000010, 
    ANDROID_RELA       = 0x60000011, 
    ANDROID_RELASZ     = 0x60000012, 
    ANDROID_RELR       = 0x6FFFE000, 
    ANDROID_RELRSZ     = 0x6FFFE001, 
    ANDROID_RELRENT    = 0x6FFFE003, 
    ANDROID_RELRCOUNT  = 0x6FFFE005, 
 
    /* Mips specific dynamic table entry tags. */
    MIPS_RLD_VERSION           = MIPS_DISC + 0x70000001, 
    MIPS_TIME_STAMP            = MIPS_DISC + 0x70000002, 
    MIPS_ICHECKSUM             = MIPS_DISC + 0x70000003, 
    MIPS_IVERSION              = MIPS_DISC + 0x70000004, 
    MIPS_FLAGS                 = MIPS_DISC + 0x70000005, 
    MIPS_BASE_ADDRESS          = MIPS_DISC + 0x70000006, 
    MIPS_MSYM                  = MIPS_DISC + 0x70000007, 
    MIPS_CONFLICT              = MIPS_DISC + 0x70000008, 
    MIPS_LIBLIST               = MIPS_DISC + 0x70000009, 
    MIPS_LOCAL_GOTNO           = MIPS_DISC + 0x7000000a, 
    MIPS_CONFLICTNO            = MIPS_DISC + 0x7000000b, 
    MIPS_LIBLISTNO             = MIPS_DISC + 0x70000010, 
    MIPS_SYMTABNO              = MIPS_DISC + 0x70000011, 
    MIPS_UNREFEXTNO            = MIPS_DISC + 0x70000012, 
    MIPS_GOTSYM                = MIPS_DISC + 0x70000013, 
    MIPS_HIPAGENO              = MIPS_DISC + 0x70000014, 
    MIPS_RLD_MAP               = MIPS_DISC + 0x70000016, 
    MIPS_DELTA_CLASS           = MIPS_DISC + 0x70000017, 
    MIPS_DELTA_CLASS_NO        = MIPS_DISC + 0x70000018, 
    MIPS_DELTA_INSTANCE        = MIPS_DISC + 0x70000019, 
    MIPS_DELTA_INSTANCE_NO     = MIPS_DISC + 0x7000001A, 
    MIPS_DELTA_RELOC           = MIPS_DISC + 0x7000001B, 
    MIPS_DELTA_RELOC_NO        = MIPS_DISC + 0x7000001C, 
    MIPS_DELTA_SYM             = MIPS_DISC + 0x7000001D, 
    MIPS_DELTA_SYM_NO          = MIPS_DISC + 0x7000001E, 
    MIPS_DELTA_CLASSSYM        = MIPS_DISC + 0x70000020, 
    MIPS_DELTA_CLASSSYM_NO     = MIPS_DISC + 0x70000021, 
    MIPS_CXX_FLAGS             = MIPS_DISC + 0x70000022, 
    MIPS_PIXIE_INIT            = MIPS_DISC + 0x70000023, 
    MIPS_SYMBOL_LIB            = MIPS_DISC + 0x70000024, 
    MIPS_LOCALPAGE_GOTIDX      = MIPS_DISC + 0x70000025, 
    MIPS_LOCAL_GOTIDX          = MIPS_DISC + 0x70000026, 
    MIPS_HIDDEN_GOTIDX         = MIPS_DISC + 0x70000027, 
    MIPS_PROTECTED_GOTIDX      = MIPS_DISC + 0x70000028, 
    MIPS_OPTIONS               = MIPS_DISC + 0x70000029, 
    MIPS_INTERFACE             = MIPS_DISC + 0x7000002A, 
    MIPS_DYNSTR_ALIGN          = MIPS_DISC + 0x7000002B, 
    MIPS_INTERFACE_SIZE        = MIPS_DISC + 0x7000002C, 
    MIPS_RLD_TEXT_RESOLVE_ADDR = MIPS_DISC + 0x7000002D, 
    MIPS_PERF_SUFFIX           = MIPS_DISC + 0x7000002E, 
    MIPS_COMPACT_SIZE          = MIPS_DISC + 0x7000002F, 
    MIPS_GP_VALUE              = MIPS_DISC + 0x70000030, 
    MIPS_AUX_DYNAMIC           = MIPS_DISC + 0x70000031, 
    MIPS_PLTGOT                = MIPS_DISC + 0x70000032, 
    MIPS_RWPLT                 = MIPS_DISC + 0x70000034,
    MIPS_RLD_MAP_REL           = MIPS_DISC + 0x70000035,
    MIPS_XHASH                 = MIPS_DISC + 0x70000036,
 
    AARCH64_BTI_PLT          = AARCH64_DISC + 0x70000001,
    AARCH64_PAC_PLT          = AARCH64_DISC + 0x70000003,
    AARCH64_VARIANT_PCS      = AARCH64_DISC + 0x70000005,
    AARCH64_MEMTAG_MODE      = AARCH64_DISC + 0x70000009,
    AARCH64_MEMTAG_HEAP      = AARCH64_DISC + 0x7000000b,
    AARCH64_MEMTAG_STACK     = AARCH64_DISC + 0x7000000c,
    AARCH64_MEMTAG_GLOBALS   = AARCH64_DISC + 0x7000000d,
    AARCH64_MEMTAG_GLOBALSSZ = AARCH64_DISC + 0x7000000f,
 
    HEXAGON_SYMSZ = HEXAGON_DISC + 0x70000000,
    HEXAGON_VER   = HEXAGON_DISC + 0x70000001,
    HEXAGON_PLT   = HEXAGON_DISC + 0x70000002,
 
    PPC_GOT = PPC_DISC + 0x70000000,
    PPC_OPT = PPC_DISC + 0x70000001,
 
    PPC64_GLINK = PPC64_DISC + 0x70000000,
    PPC64_OPT = PPC64_DISC + 0x70000003,
 
    RISCV_VARIANT_CC = RISCV_DISC + 0x70000003,
 
    X86_64_PLT    = X86_64_DISC + 0x70000000,
    X86_64_PLTSZ  = X86_64_DISC + 0x70000001,
    X86_64_PLTENT = X86_64_DISC + 0x70000003,
 
    IA_64_PLT_RESERVE         = IA_64_DISC + (0x70000000 + 0),
    IA_64_VMS_SUBTYPE         = IA_64_DISC + (0x60000000 + 0),
    IA_64_VMS_IMGIOCNT        = IA_64_DISC + (0x60000000 + 2),
    IA_64_VMS_LNKFLAGS        = IA_64_DISC + (0x60000000 + 8),
    IA_64_VMS_VIR_MEM_BLK_SIZ = IA_64_DISC + (0x60000000 + 10),
    IA_64_VMS_IDENT           = IA_64_DISC + (0x60000000 + 12),
    IA_64_VMS_NEEDED_IDENT    = IA_64_DISC + (0x60000000 + 16),
    IA_64_VMS_IMG_RELA_CNT    = IA_64_DISC + (0x60000000 + 18),
    IA_64_VMS_SEG_RELA_CNT    = IA_64_DISC + (0x60000000 + 20),
    IA_64_VMS_FIXUP_RELA_CNT  = IA_64_DISC + (0x60000000 + 22),
    IA_64_VMS_FIXUP_NEEDED    = IA_64_DISC + (0x60000000 + 24),
    IA_64_VMS_SYMVEC_CNT      = IA_64_DISC + (0x60000000 + 26),
    IA_64_VMS_XLATED          = IA_64_DISC + (0x60000000 + 30),
    IA_64_VMS_STACKSIZE       = IA_64_DISC + (0x60000000 + 32),
    IA_64_VMS_UNWINDSZ        = IA_64_DISC + (0x60000000 + 34),
    IA_64_VMS_UNWIND_CODSEG   = IA_64_DISC + (0x60000000 + 36),
    IA_64_VMS_UNWIND_INFOSEG  = IA_64_DISC + (0x60000000 + 38),
    IA_64_VMS_LINKTIME        = IA_64_DISC + (0x60000000 + 40),
    IA_64_VMS_SEG_NO          = IA_64_DISC + (0x60000000 + 42),
    IA_64_VMS_SYMVEC_OFFSET   = IA_64_DISC + (0x60000000 + 44),
    IA_64_VMS_SYMVEC_SEG      = IA_64_DISC + (0x60000000 + 46),
    IA_64_VMS_UNWIND_OFFSET   = IA_64_DISC + (0x60000000 + 48),
    IA_64_VMS_UNWIND_SEG      = IA_64_DISC + (0x60000000 + 50),
    IA_64_VMS_STRTAB_OFFSET   = IA_64_DISC + (0x60000000 + 52),
    IA_64_VMS_SYSVER_OFFSET   = IA_64_DISC + (0x60000000 + 54),
    IA_64_VMS_IMG_RELA_OFF    = IA_64_DISC + (0x60000000 + 56),
    IA_64_VMS_SEG_RELA_OFF    = IA_64_DISC + (0x60000000 + 58),
    IA_64_VMS_FIXUP_RELA_OFF  = IA_64_DISC + (0x60000000 + 60),
    IA_64_VMS_PLTGOT_OFFSET   = IA_64_DISC + (0x60000000 + 62),
    IA_64_VMS_PLTGOT_SEG      = IA_64_DISC + (0x60000000 + 64),
    IA_64_VMS_FPMODE          = IA_64_DISC + (0x60000000 + 66),
  };
  // clang-format on
 
  static TAG from_value(uint64_t value, ARCH arch);
  static uint64_t to_value(TAG tag);
 
  DynamicEntry() = default;
  DynamicEntry(const details::Elf64_Dyn& header, ARCH arch);
  DynamicEntry(const details::Elf32_Dyn& header, ARCH arch);
 
  DynamicEntry(TAG tag, uint64_t value) :
    tag_(tag),
    value_(value) {}
 
  DynamicEntry& operator=(const DynamicEntry&) = default;
  DynamicEntry(const DynamicEntry&) = default;
  ~DynamicEntry() override = default;
 
  static std::unique_ptr<DynamicEntry> create(TAG tag, uint64_t value);
 
  static std::unique_ptr<DynamicEntry> create(TAG tag) {
    return create(tag, /*value=*/0);
  }
 
  virtual std::unique_ptr<DynamicEntry> clone() const {
    return std::unique_ptr<DynamicEntry>(new DynamicEntry(*this));
  }

  TAG tag() const {
    return tag_;
  }

  uint64_t value() const {
    return value_;
  }
 
  void tag(TAG tag) {
    tag_ = tag;
  }
 
  void value(uint64_t value) {
    value_ = value;
  }
 
  void accept(Visitor& visitor) const override;
 
  virtual std::ostream& print(std::ostream& os) const;
 
  std::string to_string() const;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os,
                                           const DynamicEntry& entry) {
    return entry.print(os);
  }
 
  template<class T>
  const T* cast() const {
    static_assert(std::is_base_of<DynamicEntry, T>::value,
                  "Require DynamicEntry inheritance");
    if (T::classof(this)) {
      return static_cast<const T*>(this);
    }
    return nullptr;
  }
 
  template<class T>
  T* cast() {
    return const_cast<T*>(static_cast<const DynamicEntry*>(this)->cast<T>());
  }
 
  protected:
  TAG tag_ = TAG::DT_NULL_;
  uint64_t value_ = 0;
};
 
LIEF_API const char* to_string(DynamicEntry::TAG e);
 
}
}
#endif