COFF/Section.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_COFF_SECTION_H
#define LIEF_COFF_SECTION_H
#include <cstdint>
#include <memory>
#include <ostream>
#include <string>
 
#include "LIEF/Abstract/Section.hpp"
#include "LIEF/COFF/AuxiliarySymbols/AuxiliarySectionDefinition.hpp"
#include "LIEF/PE/Section.hpp"
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/visibility.h"
#include <optional>
 
namespace LIEF {
class BinaryStream;
 
namespace COFF {
class Relocation;
class Parser;
class Symbol;
 

class LIEF_API Section : public LIEF::Section {
  public:
  friend class Parser;
  using LIEF::Section::name;
 
  using COMDAT_SELECTION = AuxiliarySectionDefinition::COMDAT_SELECTION;

  struct LIEF_API ComdatInfo {
    Symbol* symbol = nullptr;
    COMDAT_SELECTION kind = COMDAT_SELECTION::NONE;
  };

  using CHARACTERISTICS = LIEF::PE::Section::CHARACTERISTICS;

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

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

  using it_const_relocations =
      const_ref_iterator<const relocations_t&, const Relocation*>;

  using symbols_t = std::vector<Symbol*>;

  using it_symbols = ref_iterator<symbols_t&, Symbol*>;

  using it_const_symbols = const_ref_iterator<const symbols_t&, const Symbol*>;

  static std::unique_ptr<Section> parse(BinaryStream& stream);

  uint32_t sizeof_raw_data() const {
    return size_;
  }

  uint32_t virtual_size() const {
    return virtual_size_;
  }

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

  uint32_t pointerto_raw_data() const {
    return offset_;
  }

  uint32_t pointerto_relocation() const {
    return pointer_to_relocations_;
  }

  uint32_t pointerto_line_numbers() const {
    return pointer_to_linenumbers_;
  }

  uint16_t numberof_relocations() const {
    return number_of_relocations_;
  }

  uint16_t numberof_line_numbers() const {
    return number_of_linenumbers_;
  }

  uint32_t characteristics() const {
    return characteristics_;
  }

  bool has_characteristic(CHARACTERISTICS c) const {
    return (characteristics() & (uint32_t)c) > 0;
  }

  std::vector<CHARACTERISTICS> characteristics_list() const {
    return LIEF::PE::Section::characteristics_to_list(characteristics_);
  }

  bool is_discardable() const {
    return has_characteristic(CHARACTERISTICS::MEM_DISCARDABLE);
  }
 
  void clear(uint8_t c) {
    std::fill(content_.begin(), content_.end(), c);
  }

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

  it_symbols symbols() LIEF_LIFETIMEBOUND {
    return symbols_;
  }
 
  it_const_symbols symbols() const LIEF_LIFETIMEBOUND {
    return symbols_;
  }

  std::optional<ComdatInfo> comdat_info() const;

  bool has_extended_relocations() const {
    static constexpr auto MAX_RELOC = /*uint16_t::max*/ 65535;
    return has_characteristic(CHARACTERISTICS::LNK_NRELOC_OVFL) &&
           numberof_relocations() == MAX_RELOC;
  }
 
  void content(const std::vector<uint8_t>& data) override {
    content_ = data;
  }
 
  void name(std::string name) override;
 
  void virtual_size(uint32_t virtual_sz) {
    virtual_size_ = virtual_sz;
  }
 
  void pointerto_raw_data(uint32_t ptr) {
    offset(ptr);
  }
 
  void pointerto_relocation(uint32_t ptr) {
    pointer_to_relocations_ = ptr;
  }
 
  void pointerto_line_numbers(uint32_t ptr) {
    pointer_to_linenumbers_ = ptr;
  }
 
  void numberof_relocations(uint16_t nb) {
    number_of_relocations_ = nb;
  }
 
  void numberof_line_numbers(uint16_t nb) {
    number_of_linenumbers_ = nb;
  }
 
  void sizeof_raw_data(uint32_t size) {
    this->size(size);
  }
 
  void characteristics(uint32_t characteristics) {
    characteristics_ = characteristics;
  }

  String* coff_string() {
    return coff_string_;
  }
 
  const String* coff_string() const {
    return coff_string_;
  }
 
  std::string to_string() const;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os, const Section& sec) {
    os << sec.to_string();
    return os;
  }
 
  ~Section() override = default;
 
  private:
  Section() = default;
 
  std::vector<uint8_t> content_;
  uint32_t virtual_size_ = 0;
  uint32_t pointer_to_relocations_ = 0;
  uint32_t pointer_to_linenumbers_ = 0;
  uint16_t number_of_relocations_ = 0;
  uint16_t number_of_linenumbers_ = 0;
  uint32_t characteristics_ = 0;
 
  relocations_t relocations_;
  symbols_t symbols_;
 
  String* coff_string_ = nullptr;
};
 
inline const char* to_string(Section::CHARACTERISTICS e) {
  return LIEF::PE::to_string(e);
}
 
}
}
#endif