RelocationFixup.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2025 R. Thomas
 * Copyright 2017 - 2025 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_MACHO_RELOCATION_FIXUP_H
#define LIEF_MACHO_RELOCATION_FIXUP_H
#include <ostream>
#include <memory>
 
#include "LIEF/visibility.h"
 
#include "LIEF/MachO/Relocation.hpp"
#include "LIEF/MachO/DyldChainedFormat.hpp"
 
namespace LIEF {
namespace MachO {
 
namespace details {
struct dyld_chained_ptr_arm64e_rebase;
struct dyld_chained_ptr_arm64e_auth_rebase;
struct dyld_chained_ptr_64_rebase;
struct dyld_chained_ptr_32_rebase;
struct dyld_chained_ptr_arm64e_segmented_rebase;
struct dyld_chained_ptr_arm64e_auth_segmented_rebase;
}
 
class BinaryParser;
class Builder;
class DyldChainedFixupsCreator;

class LIEF_API RelocationFixup : public Relocation {
 
  friend class BinaryParser;
  friend class Builder;
  friend class DyldChainedFixupsCreator;
 
  public:
  RelocationFixup() = delete;
  RelocationFixup(DYLD_CHAINED_PTR_FORMAT fmt, uint64_t imagebase);
 
  RelocationFixup& operator=(const RelocationFixup&);
  RelocationFixup(const RelocationFixup&);
 
  RelocationFixup& operator=(RelocationFixup&&) noexcept = default;
  RelocationFixup(RelocationFixup&&) noexcept = default;
 
  ~RelocationFixup() override;
 
  std::unique_ptr<Relocation> clone() const override {
    return std::unique_ptr<RelocationFixup>(new RelocationFixup(*this));
  }

  bool is_pc_relative() const override {
    return false;
  }

  ORIGIN origin() const override {
    return ORIGIN::CHAINED_FIXUPS;
  }
 
  DYLD_CHAINED_PTR_FORMAT ptr_format() const {
    return ptr_fmt_;
  }

  uint64_t target() const;
  void target(uint64_t target);

  void pc_relative(bool) override {}
 
  uint32_t offset() const {
    return offset_;
  }
 
  void offset(uint32_t offset) {
    offset_ = offset;
  }

  uint64_t address() const override {
    return address_;
  }

  void address(uint64_t address) override {
    address_ = address;
  }

  uint32_t next() const;

  void next(uint32_t value);
 
  void accept(Visitor& visitor) const override;
 
  static bool classof(const Relocation& r) {
    return r.origin() == Relocation::ORIGIN::CHAINED_FIXUPS;
  }
 
  std::ostream& print(std::ostream& os) const override;
 
  private:
  enum class REBASE_TYPES {
    UNKNOWN = 0,
 
    ARM64E_REBASE,
    ARM64E_AUTH_REBASE,
    PTR64_REBASE,
    PTR32_REBASE,
    SEGMENTED,
    AUTH_SEGMENTED,
  };
 
  LIEF_LOCAL void set(const details::dyld_chained_ptr_arm64e_rebase& fixup);
  LIEF_LOCAL void set(const details::dyld_chained_ptr_arm64e_auth_rebase& fixup);
  LIEF_LOCAL void set(const details::dyld_chained_ptr_64_rebase& fixup);
  LIEF_LOCAL void set(const details::dyld_chained_ptr_32_rebase& fixup);
  LIEF_LOCAL void set(const details::dyld_chained_ptr_arm64e_segmented_rebase& fixup);
  LIEF_LOCAL void set(const details::dyld_chained_ptr_arm64e_auth_segmented_rebase& fixup);
 
  DYLD_CHAINED_PTR_FORMAT ptr_fmt_ = DYLD_CHAINED_PTR_FORMAT::PTR_32;
  uint64_t imagebase_ = 0;
  uint32_t offset_ = 0;
 
  REBASE_TYPES rtypes_ = REBASE_TYPES::UNKNOWN;
 
  union {
    details::dyld_chained_ptr_arm64e_rebase*      arm64_rebase_ = nullptr;
    details::dyld_chained_ptr_arm64e_auth_rebase* arm64_auth_rebase_;
    details::dyld_chained_ptr_64_rebase*          p64_rebase_;
    details::dyld_chained_ptr_32_rebase*          p32_rebase_;
    details::dyld_chained_ptr_arm64e_segmented_rebase* segmented_rebase_;
    details::dyld_chained_ptr_arm64e_auth_segmented_rebase* auth_segmented_rebase_;
  };
};
 
}
}
#endif