MachO/Section.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_SECTION_H
#define LIEF_MACHO_SECTION_H
#include <string>
#include <vector>
#include <ostream>
#include <memory>
 
#include "LIEF/visibility.h"
 
#include "LIEF/Abstract/Section.hpp"
#include "LIEF/enums.hpp"
 
#include "LIEF/iterators.hpp"
 
namespace LIEF {
class SpanStream;
 
namespace MachO {
 
class BinaryParser;
class SegmentCommand;
class Binary;
class Relocation;
 
namespace details {
struct section_32;
struct section_64;
}

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

  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*>;
 
  static constexpr auto FLAGS_MASK = uint32_t(0xffffff00u);
  static constexpr auto TYPE_MASK = uint32_t(0xff);
 
  enum class TYPE: uint64_t  {
    REGULAR                             = 0x00u, 
    ZEROFILL                            = 0x01u, 
    CSTRING_LITERALS                    = 0x02u, 
    IS_4BYTE_LITERALS                    = 0x03u, 
    IS_8BYTE_LITERALS                    = 0x04u, 
    LITERAL_POINTERS                    = 0x05u, 
    NON_LAZY_SYMBOL_POINTERS            = 0x06u, 
    LAZY_SYMBOL_POINTERS                = 0x07u, 
    SYMBOL_STUBS                        = 0x08u, 
    MOD_INIT_FUNC_POINTERS              = 0x09u, 
    MOD_TERM_FUNC_POINTERS              = 0x0au, 
    COALESCED                           = 0x0bu, 
    GB_ZEROFILL                         = 0x0cu, 
    INTERPOSING                         = 0x0du, 
    IS_16BYTE_LITERALS                   = 0x0eu, 
    DTRACE_DOF                          = 0x0fu, 
    LAZY_DYLIB_SYMBOL_POINTERS          = 0x10u, 
    THREAD_LOCAL_REGULAR                = 0x11u, 
    THREAD_LOCAL_ZEROFILL               = 0x12u, 
    THREAD_LOCAL_VARIABLES              = 0x13u, 
    THREAD_LOCAL_VARIABLE_POINTERS      = 0x14u, 
    THREAD_LOCAL_INIT_FUNCTION_POINTERS = 0x15u, 
    INIT_FUNC_OFFSETS                   = 0x16u, 
  };
 
  enum class FLAGS: uint64_t  {
    PURE_INSTRUCTIONS   = 0x80000000u, 
    NO_TOC              = 0x40000000u, 
    STRIP_STATIC_SYMS   = 0x20000000u, 
    NO_DEAD_STRIP       = 0x10000000u, 
    LIVE_SUPPORT        = 0x08000000u, 
    SELF_MODIFYING_CODE = 0x04000000u, 
    DEBUG_INFO          = 0x02000000u, 
 
    SOME_INSTRUCTIONS   = 0x00000400u, 
    EXT_RELOC           = 0x00000200u, 
    LOC_RELOC           = 0x00000100u, 
  };
 
  public:
  Section();
  Section(const details::section_32& section_cmd);
  Section(const details::section_64& section_cmd);
 
  Section(std::string name);
  Section(std::string name, content_t content);
 
  Section& operator=(Section copy);
  Section(const Section& copy);
 
  void swap(Section& other) noexcept;
 
  ~Section() override;
 
  span<const uint8_t> content() const override;

  void content(const content_t& data) override;

  const std::string& segment_name() const;

  uint64_t address() const {
    return virtual_address();
  }

  uint32_t alignment() const {
    return align_;
  }

  uint32_t relocation_offset() const {
    return relocations_offset_;
  }

  uint32_t numberof_relocations() const {
    return nbof_relocations_;
  }

  FLAGS flags() const {
    return FLAGS(flags_ & FLAGS_MASK);
  }

  TYPE type() const {
    return TYPE(flags_ & TYPE_MASK);
  }

  uint32_t reserved1() const {
    return reserved1_;
  }

  uint32_t reserved2() const {
    return reserved2_;
  }

  uint32_t reserved3() const {
    return reserved3_;
  }

  std::vector<FLAGS> flags_list() const;

  uint32_t raw_flags() const {
    return flags_;
  }

  bool has_segment() const {
    return segment() != nullptr;
  }

  SegmentCommand* segment() {
    return segment_;
  }
  const SegmentCommand* segment() const {
    return segment_;
  }

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

  void clear(uint8_t v);

  it_relocations relocations() {
    return relocations_;
  }
  it_const_relocations relocations() const {
    return relocations_;
  }
 
  void segment_name(const std::string& name);
  void address(uint64_t address) {
    virtual_address(address);
  }
  void alignment(uint32_t align) {
    align_ = align;
  }
  void relocation_offset(uint32_t offset) {
    relocations_offset_ = offset;
  }
  void numberof_relocations(uint32_t nb_reloc) {
    nbof_relocations_ = nb_reloc;
  }
  void flags(uint32_t flags) {
    flags_ = flags_ | flags;
  }
  void flags(std::vector<FLAGS> flags);
  void type(TYPE type) {
    flags_ = (flags_ & FLAGS_MASK) | uint8_t(type);
  }
  void reserved1(uint32_t reserved1) {
    reserved1_ = reserved1;
  }
  void reserved2(uint32_t reserved2) {
    reserved2_ = reserved2;
  }
  void reserved3(uint32_t reserved3) {
    reserved3_ = reserved3;
  }

  bool has(FLAGS flag) const;

  void add(FLAGS flag);

  void remove(FLAGS flag);
 
  Section& operator+=(FLAGS flag) {
    add(flag);
    return *this;
  }
  Section& operator-=(FLAGS flag) {
    remove(flag);
    return *this;
  }
 
  void accept(Visitor& visitor) const override;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os, const Section& section);
 
  private:
  std::string segment_name_;
  uint64_t original_size_ = 0;
  uint32_t align_ = 0;
  uint32_t relocations_offset_ = 0;
  uint32_t nbof_relocations_ = 0;
  uint32_t flags_ = 0;
  uint32_t reserved1_ = 0;
  uint32_t reserved2_ = 0;
  uint32_t reserved3_ = 0;
  content_t content_;
  SegmentCommand *segment_ = nullptr;
  relocations_t relocations_;
};
 
LIEF_API const char* to_string(Section::TYPE type);
LIEF_API const char* to_string(Section::FLAGS flag);
 
}
}
 
ENABLE_BITMASK_OPERATORS(LIEF::MachO::Section::FLAGS);
 
#endif