SegmentCommand.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_SEGMENT_COMMAND_H
#define LIEF_MACHO_SEGMENT_COMMAND_H
 
#include <string>
#include <vector>
#include <ostream>
#include <memory>
 
#include "LIEF/enums.hpp"
#include "LIEF/span.hpp"
#include "LIEF/visibility.h"
 
#include "LIEF/iterators.hpp"
#include "LIEF/MachO/LoadCommand.hpp"
 
 
namespace LIEF {
class SpanStream;
namespace MachO {
 
class Binary;
class BinaryParser;
class Builder;
class DyldChainedFixupsCreator;
class DyldInfo;
class Relocation;
class Section;
 
namespace details {
struct segment_command_32;
struct segment_command_64;
}

class LIEF_API SegmentCommand : public LoadCommand {
 
  friend class DyldChainedFixupsCreator;
  friend class BinaryParser;
  friend class Binary;
  friend class Section;
  friend class Builder;
 
  public:
  using content_t = std::vector<uint8_t>;

  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*>;

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

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

  using it_const_relocations = const_ref_iterator<const relocations_t&, const Relocation*>;
 
  enum class FLAGS: uint64_t  {
    HIGHVM              = 0x1u, 
    FVMLIB              = 0x2u, 
    NORELOC             = 0x4u, 
    PROTECTED_VERSION_1 = 0x8u,
    READ_ONLY           = 0x10u,
  };

  enum class VM_PROTECTIONS  {
    READ    = 0x1, 
    WRITE   = 0x2, 
    EXECUTE = 0x4, 
  };
 
  public:
  SegmentCommand();
  SegmentCommand(const details::segment_command_32& cmd);
  SegmentCommand(const details::segment_command_64& cmd);
 
  SegmentCommand& operator=(SegmentCommand other);
  SegmentCommand(const SegmentCommand& copy);
 
  SegmentCommand(std::string name, content_t content);
 
  SegmentCommand(std::string name);
 
  void swap(SegmentCommand& other) noexcept;
 
  std::unique_ptr<LoadCommand> clone() const override {
    return std::unique_ptr<SegmentCommand>(new SegmentCommand(*this));
  }
 
  ~SegmentCommand() override;

  const std::string& name() const {
    return name_;
  }

  uint64_t virtual_address() const {
    return virtual_address_;
  }

  uint64_t virtual_size() const {
    return virtual_size_;
  }

  uint64_t file_size() const {
    return file_size_;
  }

  uint64_t file_offset() const {
    return file_offset_;
  }

  uint32_t max_protection() const {
    return max_protection_;
  }

  uint32_t init_protection() const {
    return init_protection_;
  }

  uint32_t numberof_sections() const {
    return nb_sections_;
  }

  uint32_t flags() const {
    return flags_;
  }

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

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

  const Section* get_section(const std::string& name) const;
  Section* get_section(const std::string& name);

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

  std::unique_ptr<SpanStream> stream() const;

  int8_t index() const {
    return this->index_;
  }
 
  void name(std::string name) {
    name_ = std::move(name);
  }
 
  void virtual_address(uint64_t virtual_address) {
    virtual_address_ = virtual_address;
  }
  void virtual_size(uint64_t virtual_size) {
    virtual_size_ = virtual_size;
  }
  void file_offset(uint64_t file_offset) {
    file_offset_ = file_offset;
  }
  void file_size(uint64_t file_size) {
    file_size_ = file_size;
  }
  void max_protection(uint32_t max_protection) {
    max_protection_ = max_protection;
  }
  void init_protection(uint32_t init_protection) {
    init_protection_ = init_protection;
  }
  void numberof_sections(uint32_t nb_section) {
    nb_sections_ = nb_section;
  }
  void flags(uint32_t flags) {
    flags_ = flags;
  }
 
  void content(content_t data);

  Section& add_section(const Section& section);

  void remove_all_sections();

  bool has(const Section& section) const;

  bool has_section(const std::string& section_name) const;
 
  bool is(VM_PROTECTIONS prot) const {
    return (init_protection() & (uint32_t)prot) > 0 ||
           (max_protection() & (uint32_t)prot) > 0;
  }
 
  std::ostream& print(std::ostream& os) const override;
 
  void accept(Visitor& visitor) const override;
 
  static bool classof(const LoadCommand* cmd) {
    const LoadCommand::TYPE type = cmd->command();
    return type == LoadCommand::TYPE::SEGMENT ||
           type == LoadCommand::TYPE::SEGMENT_64;
  }
 
  protected:
  span<uint8_t> writable_content() {
    return data_;
  }
 
  LIEF_LOCAL void content_resize(size_t size);
  LIEF_LOCAL void content_insert(size_t where, size_t size);
 
  void content_extend(size_t width) {
    content_resize(data_.size() + width);
  }
 
  using update_fnc_t    = std::function<void(std::vector<uint8_t>&)>;
  using update_fnc_ws_t = std::function<void(std::vector<uint8_t>&, size_t, size_t)>;
 
  LIEF_LOCAL virtual void update_data(const update_fnc_t& f);
  LIEF_LOCAL virtual void update_data(const update_fnc_ws_t& f,
                                      size_t where, size_t size);
 
  std::string name_;
  uint64_t virtual_address_ = 0;
  uint64_t virtual_size_ = 0;
  uint64_t file_offset_ = 0;
  uint64_t file_size_ = 0;
  uint32_t max_protection_ = 0;
  uint32_t init_protection_ = 0;
  uint32_t nb_sections_ = 0;
  uint32_t flags_ = 0;
  int8_t  index_ = -1;
  content_t data_;
  sections_t sections_;
  relocations_t relocations_;
};
 
LIEF_API const char* to_string(SegmentCommand::FLAGS flag);
LIEF_API const char* to_string(SegmentCommand::VM_PROTECTIONS protection);
 
}
}
 
ENABLE_BITMASK_OPERATORS(LIEF::MachO::SegmentCommand::FLAGS);
ENABLE_BITMASK_OPERATORS(LIEF::MachO::SegmentCommand::VM_PROTECTIONS);
 
#endif