MemoryLayout.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_MEMORY_LAYOUT_H
#define LIEF_RUNTIME_MEMORY_LAYOUT_H
 
#include <string_view>
#include <cstdint>
#include <memory>
#include <optional>
#include <ostream>
#include <string>
#include <utility>
 
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/runtime/Memory.hpp"
#include "LIEF/visibility.h"
 
namespace LIEF::runtime {
 
namespace details {
class MemoryLayoutIt;
}

class LIEF_API MemoryLayout {
  public:
  class Region {
    public:
    Region() = default;
    Region(std::string name, uint64_t addr, uint64_t size,
           uint32_t permissions = Memory::P_NONE) :
      name_(std::move(name)),
      addr_(addr),
      size_(size),
      permissions_(permissions) {}
 
    Region(const Region&) = default;
    Region& operator=(const Region&) = default;
 
    Region(Region&&) noexcept = default;
    Region& operator=(Region&&) noexcept = default;
 
    ~Region() = default;

    std::string_view name() const LIEF_LIFETIMEBOUND {
      return name_;
    }

    uint64_t addr() const {
      return addr_;
    }

    uint64_t size() const {
      return size_;
    }

    uint64_t end_addr() const {
      return addr() + size();
    }

    uint32_t permissions() const {
      return permissions_;
    }

    bool contains(uint64_t addr) const {
      return addr_ <= addr && addr < end_addr();
    }
 
    std::string to_string() const;
 
    LIEF_API friend std::ostream& operator<<(std::ostream& os,
                                             const Region& region) {
      os << region.to_string();
      return os;
    }
 
    private:
    std::string name_;
    uint64_t addr_ = 0;
    uint64_t size_ = 0;
    uint32_t permissions_ = Memory::P_NONE;
  };

  class Iterator final
    : public iterator_facade_base<Iterator, std::forward_iterator_tag, Region,
                                  std::ptrdiff_t, const Region*, const Region&> {
    public:
    using implementation = details::MemoryLayoutIt;
    using iterator_facade_base::operator++;
 
    LIEF_API Iterator();
 
    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(std::unique_ptr<details::MemoryLayoutIt> impl);
    LIEF_API ~Iterator();
 
    friend LIEF_API bool operator==(const Iterator& LHS, const Iterator& RHS);
    friend LIEF_API bool operator!=(const Iterator& LHS, const Iterator& RHS) {
      return !(LHS == RHS);
    }
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    LIEF_API Iterator& operator++();
 
    LIEF_API const Region& operator*() const LIEF_LIFETIMEBOUND;
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    LIEF_API const Region* operator->() const LIEF_LIFETIMEBOUND;

    LIEF_API std::unique_ptr<Region> yield();
 
    private:
    void load() const;
 
    std::unique_ptr<details::MemoryLayoutIt> impl_;
    mutable std::unique_ptr<Region> cached_;
  };
};
 
using memory_layout_it = iterator_range<MemoryLayout::Iterator>;

LIEF_API memory_layout_it memory_layout();
 
inline std::optional<MemoryLayout::Region> find_region(uint64_t addr) {
  for (const MemoryLayout::Region& region : memory_layout()) {
    if (region.contains(addr)) {
      return region;
    }
  }
  return std::nullopt;
}
 
}
#endif