RelocationEntry.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_PE_RELOCATION_ENTRY_H
#define LIEF_PE_RELOCATION_ENTRY_H
 
#include <ostream>
#include <cassert>
 
#include "LIEF/Abstract/Relocation.hpp"
 
#include "LIEF/Object.hpp"
#include "LIEF/visibility.h"
#include "LIEF/PE/Header.hpp"
 
namespace LIEF {
namespace PE {
 
class Relocation;
class LIEF_API RelocationEntry : public LIEF::Relocation {
 
  friend class Parser;
  friend class Builder;
  friend class PE::Relocation;
 
  public:
  static constexpr auto MAX_ADDR = 1 << 12;
  enum class BASE_TYPES {
    UNKNOWN = -1,
    ABS = 0,
    HIGH = 1,
    LOW = 2,
    HIGHLOW = 3,
    HIGHADJ = 4,
 
    MIPS_JMPADDR = 5 | (1 << 8),
    ARM_MOV32 = 5 | (1 << 9),
    RISCV_HI20 = 5 | (1 << 10),
 
    SECTION = 6,
 
    THUMB_MOV32 = 7 | (1 << 11),
    RISCV_LOW12I = 7 | (1 << 12),
 
    RISCV_LOW12S = 8 | (1 << 13),
    LOONARCH_MARK_LA = 8 | (1 << 14),
 
    MIPS_JMPADDR16 = 9,
    DIR64  = 10,
    HIGH3ADJ = 11,
  };

static uint16_t get_position(uint16_t data) {

return data & 0xFFF;

}

static uint16_t get_type(uint16_t data) {

return (data >> 12) & 0xFF;

}

static BASE_TYPES type_from_data(Header::MACHINE_TYPES arch, uint16_t data);

RelocationEntry() = default;

RelocationEntry(const RelocationEntry& other) :

LIEF::Relocation(other),

position_(other.position_),

type_(other.type_),

// Parent relocation is not forwarded during copy

relocation_(nullptr)

{}

RelocationEntry& operator=(RelocationEntry other) {

swap(other);

return *this;

}

RelocationEntry(RelocationEntry&& other) = default;

RelocationEntry& operator=(RelocationEntry&& other) = default;

RelocationEntry(uint16_t position, BASE_TYPES type) :

position_(position),

type_(type)

{

assert(position_ < MAX_ADDR);

}

~RelocationEntry() override = default;

void swap(RelocationEntry& other) {

LIEF::Relocation::swap(other);

std::swap(position_, other.position_);

std::swap(type_, other.type_);

std::swap(relocation_, other.relocation_);

}

uint64_t address() const override;

void address(uint64_t address) override;

size_t size() const override;

void size(size_t size) override;

uint16_t data() const {

return (uint16_t((uint8_t)type_ & 0xFF) << 12) | position_;

}