ELF/Binary.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_BINARY_H
#define LIEF_ELF_BINARY_H
 
#include <string_view>
#include <memory>
#include <vector>
 
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/errors.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/visibility.h"
 
#include "LIEF/Abstract/Binary.hpp"
 
#include "LIEF/ELF/Builder.hpp"
#include "LIEF/ELF/DynamicEntry.hpp"
#include "LIEF/ELF/Header.hpp"
#include "LIEF/ELF/Note.hpp"
#include "LIEF/ELF/Section.hpp"
#include "LIEF/ELF/Segment.hpp"
 

namespace LIEF::ELF {
namespace DataHandler {
class Handler;
}
 
class ExeLayout;
class GnuHash;
class Layout;
class ObjectFileLayout;
class Parser;
class Relocation;
class Section;
class Segment;
class Symbol;
class SymbolVersion;
class SymbolVersionDefinition;
class SymbolVersionRequirement;
class DynamicEntryLibrary;
class SysvHash;
struct sizing_info_t;

class LIEF_API Binary : public LIEF::Binary {
  friend class Parser;
  friend class Builder;
  friend class ExeLayout;
  friend class Layout;
  friend class ObjectFileLayout;
 
  public:
  using string_list_t = std::vector<std::string>;

  using notes_t = std::vector<std::unique_ptr<Note>>;

  using it_notes = ref_iterator<notes_t&, Note*>;

  using it_const_notes = const_ref_iterator<const notes_t&, const Note*>;

  using symbols_version_requirement_t =
      std::vector<std::unique_ptr<SymbolVersionRequirement>>;

  using it_symbols_version_requirement =
      ref_iterator<symbols_version_requirement_t&, SymbolVersionRequirement*>;

  using it_const_symbols_version_requirement =
      const_ref_iterator<const symbols_version_requirement_t&,
                         const SymbolVersionRequirement*>;

  using symbols_version_definition_t =
      std::vector<std::unique_ptr<SymbolVersionDefinition>>;

  using it_symbols_version_definition =
      ref_iterator<symbols_version_definition_t&, SymbolVersionDefinition*>;

  using it_const_symbols_version_definition =
      const_ref_iterator<const symbols_version_definition_t&,
                         const SymbolVersionDefinition*>;

  using segments_t = std::vector<std::unique_ptr<Segment>>;

  using it_segments = ref_iterator<segments_t&, Segment*>;

  using it_const_segments = const_ref_iterator<const segments_t&, const Segment*>;

  using dynamic_entries_t = std::vector<std::unique_ptr<DynamicEntry>>;

  using it_dynamic_entries = ref_iterator<dynamic_entries_t&, DynamicEntry*>;

  using it_const_dynamic_entries =
      const_ref_iterator<const dynamic_entries_t&, const DynamicEntry*>;

  using symbols_version_t = std::vector<std::unique_ptr<SymbolVersion>>;

  using it_symbols_version = ref_iterator<symbols_version_t&, SymbolVersion*>;

  using it_const_symbols_version =
      const_ref_iterator<const symbols_version_t&, const SymbolVersion*>;

  using relocations_t = std::vector<std::unique_ptr<Relocation>>;

  using it_pltgot_relocations = filter_iterator<relocations_t&, Relocation*>;

  using it_const_pltgot_relocations =
      const_filter_iterator<const relocations_t&, const Relocation*>;

  using it_dynamic_relocations = filter_iterator<relocations_t&, Relocation*>;

  using it_const_dynamic_relocations =
      const_filter_iterator<const relocations_t&, const Relocation*>;

  using it_object_relocations = filter_iterator<relocations_t&, Relocation*>;

  using it_const_object_relocations =
      const_filter_iterator<const relocations_t&, const Relocation*>;

  using it_relocations = ref_iterator<relocations_t&, Relocation*>;

  using it_const_relocations =
      const_ref_iterator<const relocations_t&, const Relocation*>;

  using symbols_t = std::vector<std::unique_ptr<Symbol>>;

  using it_dynamic_symbols = ref_iterator<symbols_t&, Symbol*>;

  using it_const_dynamic_symbols =
      const_ref_iterator<const symbols_t&, const Symbol*>;

  using it_symtab_symbols = ref_iterator<symbols_t&, Symbol*>;

  using it_const_symtab_symbols =
      const_ref_iterator<const symbols_t&, const Symbol*>;

  using it_symbols = ref_iterator<std::vector<Symbol*>>;

  using it_const_symbols = const_ref_iterator<std::vector<Symbol*>>;

  using it_exported_symbols = filter_iterator<std::vector<Symbol*>>;

  using it_const_exported_symbols = const_filter_iterator<std::vector<Symbol*>>;

  using it_imported_symbols = filter_iterator<std::vector<Symbol*>>;

  using it_const_imported_symbols = const_filter_iterator<std::vector<Symbol*>>;

  using sections_t = std::vector<std::unique_ptr<Section>>;

  using it_sections = ref_iterator<sections_t&, Section*>;

  using it_const_sections = const_ref_iterator<const sections_t&, const Section*>;
 
  public:
  enum PHDR_RELOC {
    AUTO = 0,

    PIE_SHIFT,

    BSS_END,
    BINARY_END,
    SEGMENT_GAP,
  };

  enum class SEC_INSERT_POS {
    AUTO = 0,

    POST_SEGMENT,

    POST_SECTION,
  };
 
  public:
  Binary& operator=(const Binary&) = delete;
  Binary(const Binary& copy) = delete;

  Header::CLASS type() const {
    return type_;
  }

  Header& header() LIEF_LIFETIMEBOUND {
    return header_;
  }
 
  const Header& header() const LIEF_LIFETIMEBOUND {
    return header_;
  }

  uint64_t last_offset_section() const;

  uint64_t last_offset_segment() const;

  uint64_t next_virtual_address() const;

  it_sections sections() LIEF_LIFETIMEBOUND {
    return sections_;
  }
 
  it_const_sections sections() const LIEF_LIFETIMEBOUND {
    return sections_;
  }

  uint64_t entrypoint() const override {
    return header_.entrypoint();
  }

  it_segments segments() LIEF_LIFETIMEBOUND {
    return segments_;
  }
 
  it_const_segments segments() const LIEF_LIFETIMEBOUND {
    return segments_;
  }

  it_dynamic_entries dynamic_entries() LIEF_LIFETIMEBOUND {
    return dynamic_entries_;
  }
 
  it_const_dynamic_entries dynamic_entries() const LIEF_LIFETIMEBOUND {
    return dynamic_entries_;
  }

  DynamicEntry& add(const DynamicEntry& entry) LIEF_LIFETIMEBOUND;

  Note& add(const Note& note) LIEF_LIFETIMEBOUND;

  void remove(const DynamicEntry& entry);

  void remove(DynamicEntry::TAG tag);

  void remove(const Section& section, bool clear = false);

  void remove(const Note& note);

  void remove(Note::TYPE type);

  void remove(const Segment& seg, bool clear = false);

  void remove(Segment::TYPE type, bool clear = false);

  it_dynamic_symbols dynamic_symbols() LIEF_LIFETIMEBOUND {
    return dynamic_symbols_;
  }
 
  it_const_dynamic_symbols dynamic_symbols() const LIEF_LIFETIMEBOUND {
    return dynamic_symbols_;
  }

  it_exported_symbols exported_symbols() LIEF_LIFETIMEBOUND;
  it_const_exported_symbols exported_symbols() const LIEF_LIFETIMEBOUND;

  it_imported_symbols imported_symbols() LIEF_LIFETIMEBOUND;
  it_const_imported_symbols imported_symbols() const LIEF_LIFETIMEBOUND;

  it_symtab_symbols symtab_symbols() LIEF_LIFETIMEBOUND {
    return symtab_symbols_;
  }
 
  it_const_symtab_symbols symtab_symbols() const LIEF_LIFETIMEBOUND {
    return symtab_symbols_;
  }

  it_symbols_version symbols_version() LIEF_LIFETIMEBOUND {
    return symbol_version_table_;
  }
  it_const_symbols_version symbols_version() const LIEF_LIFETIMEBOUND {
    return symbol_version_table_;
  }

  it_symbols_version_definition symbols_version_definition() LIEF_LIFETIMEBOUND {
    return symbol_version_definition_;
  }
 
  it_const_symbols_version_definition
      symbols_version_definition() const LIEF_LIFETIMEBOUND {
    return symbol_version_definition_;
  }

  it_symbols_version_requirement symbols_version_requirement() LIEF_LIFETIMEBOUND {
    return symbol_version_requirements_;
  }
 
  it_const_symbols_version_requirement
      symbols_version_requirement() const LIEF_LIFETIMEBOUND {
    return symbol_version_requirements_;
  }

  it_dynamic_relocations dynamic_relocations() LIEF_LIFETIMEBOUND;
  it_const_dynamic_relocations dynamic_relocations() const LIEF_LIFETIMEBOUND;

  Relocation&
      add_dynamic_relocation(const Relocation& relocation) LIEF_LIFETIMEBOUND;

  Relocation&
      add_pltgot_relocation(const Relocation& relocation) LIEF_LIFETIMEBOUND;

  Relocation* add_object_relocation(const Relocation& relocation,
                                    const Section& section) LIEF_LIFETIMEBOUND;

  it_pltgot_relocations pltgot_relocations() LIEF_LIFETIMEBOUND;
  it_const_pltgot_relocations pltgot_relocations() const LIEF_LIFETIMEBOUND;

  it_object_relocations object_relocations() LIEF_LIFETIMEBOUND;
  it_const_object_relocations object_relocations() const LIEF_LIFETIMEBOUND;

  it_relocations relocations() LIEF_LIFETIMEBOUND {
    return relocations_;
  }
 
  it_const_relocations relocations() const LIEF_LIFETIMEBOUND {
    return relocations_;
  }

  const Relocation* get_relocation(uint64_t address) const LIEF_LIFETIMEBOUND;
  Relocation* get_relocation(uint64_t address) LIEF_LIFETIMEBOUND {
    return const_cast<Relocation*>(
        static_cast<const Binary*>(this)->get_relocation(address)
    );
  }

  const Relocation* get_relocation(const Symbol& symbol) const LIEF_LIFETIMEBOUND;
  Relocation* get_relocation(const Symbol& symbol) LIEF_LIFETIMEBOUND {
    return const_cast<Relocation*>(
        static_cast<const Binary*>(this)->get_relocation(symbol)
    );
  }

  const Relocation*
      get_relocation(const std::string& symbol_name) const LIEF_LIFETIMEBOUND;
  Relocation* get_relocation(const std::string& symbol_name) LIEF_LIFETIMEBOUND {
    return const_cast<Relocation*>(
        static_cast<const Binary*>(this)->get_relocation(symbol_name)
    );
  }

  bool use_gnu_hash() const {
    return gnu_hash_ != nullptr && has(DynamicEntry::TAG::GNU_HASH);
  }

  const GnuHash* gnu_hash() const LIEF_LIFETIMEBOUND {
    return use_gnu_hash() ? gnu_hash_.get() : nullptr;
  }

  bool use_sysv_hash() const {
    return sysv_hash_ != nullptr && has(DynamicEntry::TAG::HASH);
  }

  const SysvHash* sysv_hash() const LIEF_LIFETIMEBOUND {
    return use_sysv_hash() ? sysv_hash_.get() : nullptr;
  }

  bool has_section(const std::string& name) const {
    return get_section(name) != nullptr;
  }

  bool has_section_with_offset(uint64_t offset) const;

  bool has_section_with_va(uint64_t va) const;

  Section* get_section(std::string_view name) LIEF_LIFETIMEBOUND {
    return const_cast<Section*>(
        static_cast<const Binary*>(this)->get_section(name)
    );
  }
  const Section* get_section(std::string_view name) const LIEF_LIFETIMEBOUND;

  Section* text_section() LIEF_LIFETIMEBOUND {
    return get_section(".text");
  }

  Section* dynamic_section() LIEF_LIFETIMEBOUND;

  Section* hash_section() LIEF_LIFETIMEBOUND;

  Section* symtab_symbols_section() LIEF_LIFETIMEBOUND;

  uint64_t imagebase() const override;

  uint64_t virtual_size() const override;

  bool has_interpreter() const;

  std::string_view interpreter() const LIEF_LIFETIMEBOUND {
    return interpreter_;
  }

  void interpreter(const std::string& interpreter) {
    interpreter_ = interpreter;
  }

  it_symbols symbols() LIEF_LIFETIMEBOUND {
    return symtab_dyn_symbols();
  }
 
  it_const_symbols symbols() const LIEF_LIFETIMEBOUND {
    return symtab_dyn_symbols();
  }

  Symbol& export_symbol(const Symbol& symbol) LIEF_LIFETIMEBOUND;

  Symbol& export_symbol(const std::string& symbol_name,
                        uint64_t value = 0) LIEF_LIFETIMEBOUND;

  bool has_dynamic_symbol(const std::string& name) const {
    return get_dynamic_symbol(name) != nullptr;
  }

  const Symbol*
      get_dynamic_symbol(const std::string& name) const LIEF_LIFETIMEBOUND;
 
  Symbol* get_dynamic_symbol(const std::string& name) LIEF_LIFETIMEBOUND {
    return const_cast<Symbol*>(
        static_cast<const Binary*>(this)->get_dynamic_symbol(name)
    );
  }

  bool has_symtab_symbol(const std::string& name) const {
    return get_symtab_symbol(name) != nullptr;
  }

  const Symbol*
      get_symtab_symbol(const std::string& name) const LIEF_LIFETIMEBOUND;
 
  Symbol* get_symtab_symbol(const std::string& name) LIEF_LIFETIMEBOUND {
    return const_cast<Symbol*>(
        static_cast<const Binary*>(this)->get_symtab_symbol(name)
    );
  }

  string_list_t strings(size_t min_size = 5) const;

  void remove_symbol(const std::string& name);

  void remove_symtab_symbol(const std::string& name);
  void remove_symtab_symbol(Symbol* symbol);

  void remove_dynamic_symbol(const std::string& name);

  void remove_dynamic_symbol(Symbol* symbol);

  result<uint64_t>
      get_function_address(const std::string& func_name) const override;

  //
  result<uint64_t> get_function_address(const std::string& func_name,
                                        bool demangled) const;

  Section* add(const Section& section, bool loaded = true,
               SEC_INSERT_POS pos = SEC_INSERT_POS::AUTO) LIEF_LIFETIMEBOUND;
 
  Section* extend(const Section& section, uint64_t size) LIEF_LIFETIMEBOUND;

  Symbol& add_symtab_symbol(const Symbol& symbol) LIEF_LIFETIMEBOUND;

  Symbol& add_dynamic_symbol(const Symbol& symbol, const SymbolVersion* version =
                                                       nullptr) LIEF_LIFETIMEBOUND;

  Symbol& add_exported_function(uint64_t address,
                                const std::string& name = "") LIEF_LIFETIMEBOUND;

  DynamicEntryLibrary&
      add_library(const std::string& library_name) LIEF_LIFETIMEBOUND;

  void remove_library(const std::string& library_name);

  DynamicEntryLibrary*
      get_library(const std::string& library_name) LIEF_LIFETIMEBOUND {
    return const_cast<DynamicEntryLibrary*>(
        static_cast<const Binary*>(this)->get_library(library_name)
    );
  }

  const DynamicEntryLibrary*
      get_library(const std::string& library_name) const LIEF_LIFETIMEBOUND;

  bool has_library(const std::string& name) const {
    return get_library(name) != nullptr;
  }

  Segment* add(const Segment& segment, uint64_t base = 0) LIEF_LIFETIMEBOUND;

  Segment* replace(const Segment& new_segment, const Segment& original_segment,
                   uint64_t base = 0) LIEF_LIFETIMEBOUND;
 
  Segment* extend(const Segment& segment, uint64_t size) LIEF_LIFETIMEBOUND;
 

  void patch_address(uint64_t address, const std::vector<uint8_t>& patch_value,
                     LIEF::Binary::VA_TYPES addr_type =
                         LIEF::Binary::VA_TYPES::AUTO) override;
 

  void patch_address(
      uint64_t address, uint64_t patch_value, size_t size = sizeof(uint64_t),
      LIEF::Binary::VA_TYPES addr_type = LIEF::Binary::VA_TYPES::AUTO
  ) override;

  void patch_pltgot(const Symbol& symbol, uint64_t address);
 

  void patch_pltgot(const std::string& symbol_name, uint64_t address);

  void strip();

  void remove_section(const std::string& name, bool clear = false) override;

  void write(const std::string& filename) {
    return write(filename, Builder::config_t{});
  }

  void write(const std::string& filename, const Builder::config_t& config);

  void write(std::ostream& os) {
    return write(os, Builder::config_t{});
  }

  void write(std::ostream& os, const Builder::config_t& config);

  std::vector<uint8_t> raw();

  result<uint64_t> virtual_address_to_offset(uint64_t virtual_address) const;

  result<uint64_t> offset_to_virtual_address(uint64_t offset,
                                             uint64_t slide = 0) const override;

  bool is_pie() const override;

  bool has_nx() const override;

  int64_t dynsym_idx(const std::string& name) const;
 
  int64_t dynsym_idx(const Symbol& sym) const;

  int64_t symtab_idx(const std::string& name) const;
 
  int64_t symtab_idx(const Symbol& sym) const;

  const Section*
      section_from_offset(uint64_t offset,
                          bool skip_nobits = true) const LIEF_LIFETIMEBOUND;
  Section* section_from_offset(uint64_t offset,
                               bool skip_nobits = true) LIEF_LIFETIMEBOUND {
    return const_cast<Section*>(
        static_cast<const Binary*>(this)->section_from_offset(offset, skip_nobits)
    );
  }

  const Section* section_from_virtual_address(
      uint64_t address, bool skip_nobits = true
  ) const LIEF_LIFETIMEBOUND;
 
  Section*
      section_from_virtual_address(uint64_t address,
                                   bool skip_nobits = true) LIEF_LIFETIMEBOUND {
    return const_cast<Section*>(
        static_cast<const Binary*>(this)->section_from_virtual_address(address,
                                                                       skip_nobits)
    );
  }

  const Segment*
      segment_from_virtual_address(uint64_t address) const LIEF_LIFETIMEBOUND;
 
  Segment* segment_from_virtual_address(uint64_t address) LIEF_LIFETIMEBOUND {
    return const_cast<Segment*>(
        static_cast<const Binary*>(this)->segment_from_virtual_address(address)
    );
  }
 
 
  const Segment*
      segment_from_virtual_address(Segment::TYPE type,
                                   uint64_t address) const LIEF_LIFETIMEBOUND;
  Segment* segment_from_virtual_address(Segment::TYPE type,
                                        uint64_t address) LIEF_LIFETIMEBOUND {
    return const_cast<Segment*>(
        static_cast<const Binary*>(this)->segment_from_virtual_address(type,
                                                                       address)
    );
  }

  const Segment* segment_from_offset(uint64_t offset) const LIEF_LIFETIMEBOUND;
  Segment* segment_from_offset(uint64_t offset) LIEF_LIFETIMEBOUND {
    return const_cast<Segment*>(
        static_cast<const Binary*>(this)->segment_from_offset(offset)
    );
  }

  const DynamicEntry* get(DynamicEntry::TAG tag) const LIEF_LIFETIMEBOUND;
  DynamicEntry* get(DynamicEntry::TAG tag) LIEF_LIFETIMEBOUND {
    return const_cast<DynamicEntry*>(static_cast<const Binary*>(this)->get(tag));
  }

  const Segment* get(Segment::TYPE type) const LIEF_LIFETIMEBOUND;
  Segment* get(Segment::TYPE type) LIEF_LIFETIMEBOUND {
    return const_cast<Segment*>(static_cast<const Binary*>(this)->get(type));
  }

  const Note* get(Note::TYPE type) const LIEF_LIFETIMEBOUND;
  Note* get(Note::TYPE type) LIEF_LIFETIMEBOUND {
    return const_cast<Note*>(static_cast<const Binary*>(this)->get(type));
  }

  const Section* get(Section::TYPE type) const LIEF_LIFETIMEBOUND;
  Section* get(Section::TYPE type) LIEF_LIFETIMEBOUND {
    return const_cast<Section*>(static_cast<const Binary*>(this)->get(type));
  }

  bool has(DynamicEntry::TAG tag) const {
    return get(tag) != nullptr;
  }

  bool has(Segment::TYPE type) const {
    return get(type) != nullptr;
  }

  bool has(Note::TYPE type) const {
    return get(type) != nullptr;
  }

  bool has(Section::TYPE type) const {
    return get(type) != nullptr;
  }

  span<const uint8_t> get_content_from_virtual_address(
      uint64_t virtual_address, uint64_t size,
      Binary::VA_TYPES addr_type = Binary::VA_TYPES::AUTO
  ) const LIEF_LIFETIMEBOUND override;

  void accept(LIEF::Visitor& visitor) const override;

  void permute_dynamic_symbols(const std::vector<size_t>& permutation);

  LIEF::Binary::functions_t ctor_functions() const override;

  LIEF::Binary::functions_t dtor_functions() const;

  LIEF::Binary::functions_t functions() const;

  bool has_notes() const;

  it_const_notes notes() const LIEF_LIFETIMEBOUND {
    return notes_;
  }
 
  it_notes notes() LIEF_LIFETIMEBOUND {
    return notes_;
  }

  uint64_t eof_offset() const;

  bool has_overlay() const {
    return !overlay_.empty();
  }

  span<const uint8_t> overlay() const LIEF_LIFETIMEBOUND {
    return overlay_;
  }

  void overlay(std::vector<uint8_t> overlay) {
    overlay_ = std::move(overlay);
  }

  uint64_t relocate_phdr_table(PHDR_RELOC type);

  std::vector<uint64_t> get_relocated_dynamic_array(DynamicEntry::TAG tag) const;

  bool is_targeting_android() const;

  result<size_t> get_section_idx(const Section& section) const {
    auto it = std::find_if(sections_.begin(), sections_.end(),
                           [&section](const std::unique_ptr<Section>& S) {
                             return S.get() == &section;
                           });
    if (it == sections_.end()) {
      return make_error_code(lief_errors::not_found);
    }
    return std::distance(sections_.begin(), it);
  }

  result<size_t> get_section_idx(const std::string& name) const {
    auto it = std::find_if(sections_.begin(), sections_.end(),
                           [name](const std::unique_ptr<Section>& S) {
                             return S->name() == name;
                           });
    if (it == sections_.end()) {
      return make_error_code(lief_errors::not_found);
    }
    return std::distance(sections_.begin(), it);
  }

  const SymbolVersionRequirement* find_version_requirement(
      const std::string& libname
  ) const LIEF_LIFETIMEBOUND;
 
  SymbolVersionRequirement*
      find_version_requirement(const std::string& name) LIEF_LIFETIMEBOUND {
    return const_cast<SymbolVersionRequirement*>(
        static_cast<const Binary*>(this)->find_version_requirement(name)
    );
  }

  bool remove_version_requirement(const std::string& libname);
 
  uint8_t ptr_size() const {
    switch (type()) {
      case Header::CLASS::ELF32: return sizeof(uint32_t);
      case Header::CLASS::ELF64: return sizeof(uint64_t);
      default: return 0;
    }
    return 0;
  }
 
  uint64_t page_size() const override;
 
  uint64_t layout_pagesize() const;
 
  static bool classof(const LIEF::Binary* bin) {
    return bin->format() == Binary::FORMATS::ELF ||
           bin->format() == Binary::FORMATS::OAT;
  }
 
  size_t hash(const std::string& name);
 
  ~Binary() override;
 
  std::ostream& print(std::ostream& os) const override;
 
  Binary& operator+=(const DynamicEntry& entry) LIEF_LIFETIMEBOUND {
    add(entry);
    return *this;
  }
  Binary& operator+=(const Section& section) LIEF_LIFETIMEBOUND {
    add(section);
    return *this;
  }
 
  Binary& operator+=(const Segment& segment) LIEF_LIFETIMEBOUND {
    add(segment);
    return *this;
  }
 
  Binary& operator+=(const Note& note) LIEF_LIFETIMEBOUND {
    add(note);
    return *this;
  }
 
  Binary& operator-=(const DynamicEntry& entry) LIEF_LIFETIMEBOUND {
    remove(entry);
    return *this;
  }
 
  Binary& operator-=(DynamicEntry::TAG tag) LIEF_LIFETIMEBOUND {
    remove(tag);
    return *this;
  }
 
  Binary& operator-=(const Note& note) LIEF_LIFETIMEBOUND {
    remove(note);
    return *this;
  }
 
  Binary& operator-=(Note::TYPE type) LIEF_LIFETIMEBOUND {
    remove(type);
    return *this;
  }
 
  Segment* operator[](Segment::TYPE type) LIEF_LIFETIMEBOUND {
    return get(type);
  }
 
  const Segment* operator[](Segment::TYPE type) const LIEF_LIFETIMEBOUND {
    return get(type);
  }
 
  DynamicEntry* operator[](DynamicEntry::TAG tag) LIEF_LIFETIMEBOUND {
    return get(tag);
  }
 
  const DynamicEntry* operator[](DynamicEntry::TAG tag) const LIEF_LIFETIMEBOUND {
    return get(tag);
  }
 
  Note* operator[](Note::TYPE type) LIEF_LIFETIMEBOUND {
    return get(type);
  }
 
  const Note* operator[](Note::TYPE type) const LIEF_LIFETIMEBOUND {
    return get(type);
  }
 
  Section* operator[](Section::TYPE type) LIEF_LIFETIMEBOUND {
    return get(type);
  }
 
  const Section* operator[](Section::TYPE type) const LIEF_LIFETIMEBOUND {
    return get(type);
  }
 
  bool should_swap() const {
    return should_swap_;
  }
 
  protected:
  struct phdr_relocation_info_t {
    uint64_t new_offset = 0;
    size_t nb_segments = 0;
    void clear() {
      new_offset = 0;
      nb_segments = 0;
    }
  };
  uint64_t entry_size(DynamicEntry::TAG ent_tag, uint64_t fallback) const {
    if (const DynamicEntry* dt_ent = get(ent_tag)) {
      return dt_ent->value();
    }
    return fallback;
  }
 
  LIEF_LOCAL Binary();

  LIEF_LOCAL LIEF::Binary::sections_t get_abstract_sections() override;
 
  LIEF_LOCAL LIEF::Header get_abstract_header() const override {
    return LIEF::Header::from(*this);
  }
 
  LIEF_LOCAL LIEF::Binary::functions_t
      get_abstract_exported_functions() const override;
  LIEF_LOCAL LIEF::Binary::functions_t
      get_abstract_imported_functions() const override;
  LIEF_LOCAL std::vector<std::string>
      get_abstract_imported_libraries() const override;
  LIEF_LOCAL LIEF::Binary::symbols_t get_abstract_symbols() override;
  LIEF_LOCAL LIEF::Binary::relocations_t get_abstract_relocations() override;
 
  template<ELF::ARCH ARCH>
  LIEF_LOCAL void patch_relocations(uint64_t from, uint64_t shift);
 
  template<class T>
  LIEF_LOCAL void patch_addend(Relocation& relocatio, uint64_t from,
                               uint64_t shift);
 
  LIEF_LOCAL void shift_sections(uint64_t from, uint64_t shift);
  LIEF_LOCAL void shift_segments(uint64_t from, uint64_t shift);
  LIEF_LOCAL void shift_dynamic_entries(uint64_t from, uint64_t shift);
  LIEF_LOCAL void shift_symbols(uint64_t from, uint64_t shift);
  LIEF_LOCAL void shift_relocations(uint64_t from, uint64_t shift);
 
  template<class ELF_T>
  LIEF_LOCAL void fix_got_entries(uint64_t from, uint64_t shift);
 
  LIEF_LOCAL LIEF::Binary::functions_t eh_frame_functions() const;
  LIEF_LOCAL LIEF::Binary::functions_t armexid_functions() const;
 
  template<Header::FILE_TYPE OBJECT_TYPE, bool note = false>
  LIEF_LOCAL Segment* add_segment(const Segment& segment,
                                  uint64_t base) LIEF_LIFETIMEBOUND;
 
  LIEF_LOCAL uint64_t relocate_phdr_table_auto(size_t required_segments = 1);
  LIEF_LOCAL uint64_t reuse_phdr_table();
  LIEF_LOCAL uint64_t relocate_phdr_table_pie();
  LIEF_LOCAL uint64_t relocate_phdr_table_v1();
  LIEF_LOCAL uint64_t relocate_phdr_table_v2();
  LIEF_LOCAL uint64_t relocate_phdr_table_v3();
 
  template<Segment::TYPE PT>
  LIEF_LOCAL Segment* extend_segment(const Segment& segment,
                                     uint64_t size) LIEF_LIFETIMEBOUND;
 
  template<bool LOADED>
  LIEF_LOCAL Section* add_section(const Section& section,
                                  SEC_INSERT_POS pos) LIEF_LIFETIMEBOUND;
 
  std::vector<Symbol*> symtab_dyn_symbols() const LIEF_LIFETIMEBOUND;
 
  LIEF_LOCAL std::string_view shstrtab_name() const;
  LIEF_LOCAL Section* add_frame_section(const Section& sec) LIEF_LIFETIMEBOUND;
  LIEF_LOCAL Section* add_section(std::unique_ptr<Section> sec) LIEF_LIFETIMEBOUND;
 
  LIEF_LOCAL LIEF::Binary::functions_t tor_functions(DynamicEntry::TAG tag) const;
 
  Header::CLASS type_ = Header::CLASS::NONE;
  Header header_;
  sections_t sections_;
  segments_t segments_;
  dynamic_entries_t dynamic_entries_;
  symbols_t dynamic_symbols_;
  symbols_t symtab_symbols_;
  relocations_t relocations_;
  symbols_version_t symbol_version_table_;
  symbols_version_requirement_t symbol_version_requirements_;
  symbols_version_definition_t symbol_version_definition_;
  notes_t notes_;
  std::unique_ptr<GnuHash> gnu_hash_;
  std::unique_ptr<SysvHash> sysv_hash_;
  std::unique_ptr<DataHandler::Handler> datahandler_;
  phdr_relocation_info_t phdr_reloc_info_;
 
  std::string interpreter_;
  std::vector<uint8_t> overlay_;
  std::unique_ptr<sizing_info_t> sizing_info_;
  uint64_t pagesize_ = 0;
  bool should_swap_ = false;
};
 
}
 
#endif