Stub.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_MACHO_STUB_H
#define LIEF_MACHO_STUB_H
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/visibility.h"
 
#include "LIEF/errors.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/span.hpp"
 
#include "LIEF/MachO/Header.hpp"
 
#include <cstdint>
#include <ostream>
#include <vector>
 
 
namespace LIEF::MachO {
 
class Binary;
class Section;

class LIEF_API Stub {
  public:
  struct target_info_t {
    Header::CPU_TYPE arch = Header::CPU_TYPE::ANY;
    uint32_t subtype = 0;
    friend bool operator==(Stub::target_info_t lhs, Stub::target_info_t rhs) {
      return lhs.arch == rhs.arch && lhs.subtype == rhs.subtype;
    }
  };
  class LIEF_API Iterator
    : public iterator_facade_base<Iterator, std::random_access_iterator_tag,
                                  const Stub> {
    public:
    Iterator() = default;
 
    Iterator(target_info_t target_info, std::vector<const Section*> sections,
             size_t pos) :
      target_info_(target_info),
      stubs_(std::move(sections)),
      pos_(pos) {}
 
    Iterator(const Iterator&) = default;
    Iterator& operator=(const Iterator&) = default;
 
    Iterator(Iterator&&) noexcept = default;
    Iterator& operator=(Iterator&&) noexcept = default;
 
    ~Iterator() = default;
 
    bool operator<(const Iterator& rhs) const {
      return pos_ < rhs.pos_;
    }
 
    std::ptrdiff_t operator-(const Iterator& R) const {
      return pos_ - R.pos_;
    }
 
    Iterator& operator+=(std::ptrdiff_t n) {
      pos_ += n;
      return *this;
    }
 
    Iterator& operator-=(std::ptrdiff_t n) {
      pos_ -= n;
      return *this;
    }
 
    friend LIEF_API bool operator==(const Iterator& LHS, const Iterator& RHS) {
      return LHS.pos_ == RHS.pos_;
    }
 
    friend LIEF_API bool operator!=(const Iterator& LHS, const Iterator& RHS) {
      return !(LHS == RHS);
    }
 
    Stub operator*() const;
 
    private:
    const Section* find_section_offset(size_t pos, uint64_t& offset) const;
    target_info_t target_info_;
    std::vector<const Section*> stubs_;
    size_t pos_ = 0;
  };
 
  public:
  Stub() = delete;
  Stub(const Stub&) = default;
  Stub& operator=(const Stub&) = default;
 
  Stub(Stub&&) noexcept = default;
  Stub& operator=(Stub&&) noexcept = default;
  ~Stub() = default;
 
  Stub(target_info_t target_info, uint64_t addr, std::vector<uint8_t> raw) :
    target_info_(target_info),
    address_(addr),
    raw_(std::move(raw)) {}

  span<const uint8_t> raw() const LIEF_LIFETIMEBOUND {
    return raw_;
  }

  uint64_t address() const {
    return address_;
  }

  result<uint64_t> target() const;
 
  friend LIEF_API std::ostream& operator<<(std::ostream& os, const Stub& stub);
 
  private:
  target_info_t target_info_;
  uint64_t address_ = 0;
  LIEF_MAYBE_UNUSED mutable uint64_t target_addr_ = 0;
  std::vector<uint8_t> raw_;
};
 
}
 
#endif