LazyLoadDylibInfo.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_LAZY_LOAD_DYLIB_INFO_COMMAND_H
#define LIEF_MACHO_LAZY_LOAD_DYLIB_INFO_COMMAND_H
#include <string_view>
#include <memory>
#include <ostream>
#include <string>
#include <vector>
 
#include "LIEF/errors.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/visibility.h"
 
#include "LIEF/MachO/LoadCommand.hpp"
 
namespace LIEF {
class SpanStream;
class BinaryStream;
class vector_iostream;
 
namespace MachO {
class Binary;
class BinaryParser;
class Builder;
class LinkEdit;
class SegmentCommand;
 
namespace details {
struct linkedit_data_command;
}

class LIEF_API LazyLoadDylibInfo : public LoadCommand {
  friend class BinaryParser;
  friend class Builder;
  friend class LinkEdit;
 
  public:
  class LIEF_API Fixup {
    friend class Binary;
 
    public:
    Fixup() = default;
    Fixup(uint64_t address, uint32_t ordinal, std::string symbol, bool is_auth) :
      address_(address),
      ordinal_(ordinal),
      symbol_(std::move(symbol)),
      is_auth_(is_auth) {}
 
    Fixup(const Fixup&) = default;
    Fixup& operator=(const Fixup&) = default;
 
    Fixup(Fixup&&) noexcept = default;
    Fixup& operator=(Fixup&&) noexcept = default;
 
    ~Fixup() = default;

    uint64_t address() const {
      return address_;
    }
 
    void address(uint64_t value) {
      address_ = value;
    }

    uint32_t ordinal() const {
      return ordinal_;
    }

    std::string_view symbol() const LIEF_LIFETIMEBOUND {
      return symbol_;
    }

    bool is_auth() const {
      return is_auth_;
    }
 
    std::string to_string() const;
 
    LIEF_API friend std::ostream& operator<<(std::ostream& os,
                                             const Fixup& fixup) {
      os << fixup.to_string();
      return os;
    }
 
    private:
    uint64_t address_ = 0;
    uint32_t ordinal_ = 0;
    std::string symbol_;
    bool is_auth_ = false;
  };
  static constexpr auto MAYBE_MISSING_FLAG = 1;
 
  using fixups_t = std::vector<Fixup>;

  using it_fixups = ref_iterator<fixups_t&>;

  using it_const_fixups = const_ref_iterator<const fixups_t&>;
 
  LazyLoadDylibInfo();
  LazyLoadDylibInfo(const details::linkedit_data_command& cmd);
 
  LazyLoadDylibInfo& operator=(const LazyLoadDylibInfo& copy) = default;
  LazyLoadDylibInfo(const LazyLoadDylibInfo& copy) = default;
 
  std::unique_ptr<LoadCommand> clone() const override {
    return std::make_unique<LazyLoadDylibInfo>(*this);
  }

  uint32_t data_offset() const {
    return data_offset_;
  }

  uint32_t data_size() const {
    return data_size_;
  }
 
  void data_offset(uint32_t offset) {
    data_offset_ = offset;
  }
 
  void data_size(uint32_t size) {
    data_size_ = size;
  }

  span<const uint8_t> content() const LIEF_LIFETIMEBOUND {
    return content_;
  }
 
  span<uint8_t> content() LIEF_LIFETIMEBOUND {
    return content_;
  }

  std::string_view load_path() const LIEF_LIFETIMEBOUND {
    return load_path_;
  }

  LazyLoadDylibInfo& load_path(std::string value) LIEF_LIFETIMEBOUND {
    load_path_ = std::move(value);
    return *this;
  }

  uint32_t flag_image_offset() const {
    return flag_image_offset_;
  }
 
  LazyLoadDylibInfo& flag_image_offset(uint32_t value) LIEF_LIFETIMEBOUND {
    flag_image_offset_ = value;
    return *this;
  }

  uint16_t flags() const {
    return flags_;
  }
 
  LazyLoadDylibInfo& flags(uint16_t value) LIEF_LIFETIMEBOUND {
    flags_ = value;
    return *this;
  }

  bool may_be_missing() const {
    return (flags_ & MAYBE_MISSING_FLAG) != 0;
  }

  LazyLoadDylibInfo& may_be_missing(bool value) LIEF_LIFETIMEBOUND {
    if (value) {
      flags_ |= MAYBE_MISSING_FLAG;
    } else {
      flags_ &= ~static_cast<uint16_t>(MAYBE_MISSING_FLAG);
    }
    return *this;
  }

  uint16_t pointer_format() const {
    return pointer_format_;
  }
 
  LazyLoadDylibInfo& pointer_format(uint16_t value) LIEF_LIFETIMEBOUND {
    pointer_format_ = value;
    return *this;
  }

  uint32_t chain_start_image_offset() const {
    return chain_start_image_offset_;
  }
 
  LazyLoadDylibInfo& chain_start_image_offset(uint32_t value) LIEF_LIFETIMEBOUND {
    chain_start_image_offset_ = value;
    return *this;
  }

  const std::vector<std::string>& symbols() const LIEF_LIFETIMEBOUND {
    return symbols_;
  }

  LazyLoadDylibInfo& symbols(std::vector<std::string> value) LIEF_LIFETIMEBOUND {
    symbols_ = std::move(value);
    return *this;
  }

  LazyLoadDylibInfo& add_symbol(std::string value) LIEF_LIFETIMEBOUND {
    symbols_.push_back(std::move(value));
    return *this;
  }

  LazyLoadDylibInfo& clear_symbols() LIEF_LIFETIMEBOUND {
    symbols_.clear();
    return *this;
  }

  it_fixups fixups() LIEF_LIFETIMEBOUND {
    return fixups_;
  }
 
  it_const_fixups fixups() const LIEF_LIFETIMEBOUND {
    return fixups_;
  }
 
  ~LazyLoadDylibInfo() override = default;
 
  std::ostream& print(std::ostream& os) const override;
 
  static bool classof(const LoadCommand* cmd) {
    return cmd->command() == LoadCommand::TYPE::LAZY_LOAD_DYLIB_INFO;
  }

  LIEF_LOCAL ok_error_t parse_payload(BinaryStream& stream);

  LIEF_LOCAL ok_error_t walk_fixups(uint64_t chain_va, SegmentCommand& seg);

  LIEF_LOCAL ok_error_t serialize(vector_iostream& ios) const;
 
 
  private:
  uint32_t data_offset_ = 0;
  uint32_t data_size_ = 0;
  span<uint8_t> content_;
 
  std::string load_path_;
  uint32_t flag_image_offset_ = 0;
  uint16_t flags_ = 0;
  uint16_t pointer_format_ = 0;
  uint32_t chain_start_image_offset_ = 0;
  std::vector<std::string> symbols_;
  fixups_t fixups_;
};
 
}
}
#endif