LdrDataTableEntry.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_RUNTIME_WINDOWS_LDR_DATA_TABLE_ENTRY_H
#define LIEF_RUNTIME_WINDOWS_LDR_DATA_TABLE_ENTRY_H
#include <cstdint>
#include <memory>
#include <ostream>
#include <string>
 
#include <LIEF/visibility.h>
#include <LIEF/compiler_attributes.hpp>
#include <LIEF/iterators.hpp>
#include <LIEF/optional.hpp>
 
namespace LIEF {
namespace runtime {
namespace windows {
 
namespace details {
class ldr_entry;
class ldr_entry_it;
}

class LIEF_API LdrDataTableEntry {
  public:
  class Iterator final
    : public iterator_facade_base<Iterator, std::bidirectional_iterator_tag,
                                  LdrDataTableEntry, std::ptrdiff_t,
                                  const LdrDataTableEntry*,
                                  const LdrDataTableEntry&> {
    public:
    using implementation = details::ldr_entry_it;
    using iterator_facade_base::operator++;
    using iterator_facade_base::operator--;
 
    LIEF_API Iterator();
 
    LIEF_API Iterator(std::unique_ptr<details::ldr_entry_it> impl);
 
    LIEF_API Iterator(const Iterator&);
    LIEF_API Iterator& operator=(const Iterator&);
 
    LIEF_API Iterator(Iterator&&) noexcept;
    LIEF_API Iterator& operator=(Iterator&&) noexcept;
 
    LIEF_API ~Iterator();
 
    friend LIEF_API bool operator==(const Iterator& LHS, const Iterator& RHS);
    friend bool operator!=(const Iterator& LHS, const Iterator& RHS) {
      return !(LHS == RHS);
    }
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    LIEF_API Iterator& operator++() LIEF_LIFETIMEBOUND;
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    LIEF_API Iterator& operator--() LIEF_LIFETIMEBOUND;
 
    LIEF_API const LdrDataTableEntry& operator*() const LIEF_LIFETIMEBOUND;
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    LIEF_API const LdrDataTableEntry* operator->() const LIEF_LIFETIMEBOUND;

    LIEF_API std::unique_ptr<LdrDataTableEntry> yield();
 
    private:
    void load() const;
 
    std::unique_ptr<details::ldr_entry_it> impl_;
    mutable std::unique_ptr<LdrDataTableEntry> cached_;
  };
 
  LdrDataTableEntry() = delete;
  LdrDataTableEntry(std::unique_ptr<details::ldr_entry> impl);
 
  LdrDataTableEntry(const LdrDataTableEntry&) = delete;
  LdrDataTableEntry& operator=(const LdrDataTableEntry&) = delete;
 
  LdrDataTableEntry(LdrDataTableEntry&&) noexcept;
  LdrDataTableEntry& operator=(LdrDataTableEntry&&) noexcept;

  uintptr_t dll_base() const;

  uintptr_t entry_point() const;

  uint32_t size_of_image() const;

  std::string full_dll_name() const;

  std::string base_dll_name() const;

  uint32_t flags() const;

  uint16_t obsolete_load_count() const;

  uint16_t tls_index() const;

  uint32_t time_date_stamp() const;

  uintptr_t entry_point_activation_context() const;

  uintptr_t lock() const;

  optional<uintptr_t> ddag_node() const;

  optional<uintptr_t> load_context() const;

  optional<uintptr_t> parent_dll_base() const;

  optional<uintptr_t> switch_back_context() const;

  optional<uintptr_t> original_base() const;

  optional<int64_t> load_time() const;

  optional<uint32_t> base_name_hash_value() const;

  optional<int32_t> load_reason() const;

  optional<uint32_t> implicit_path_options() const;

  optional<uint32_t> reference_count() const;

  optional<uint32_t> dependent_load_flags() const;

  optional<uint8_t> signing_level() const;

  optional<uint32_t> check_sum() const;

  optional<uintptr_t> active_patch_image_base() const;

  optional<uint32_t> hot_patch_state() const;

  std::string to_string() const;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os,
                                           const LdrDataTableEntry& entry) {
    os << entry.to_string();
    return os;
  }
 
  ~LdrDataTableEntry();
 
  private:
  std::unique_ptr<details::ldr_entry> impl_;
};
 
}
}
}
#endif