ladybird/Userland/Libraries/LibDebug/ProcessInspector.h

/*
 * Copyright (c) 2021, Itamar S. <itamar8910@gmail.com>
 * Copyright (c) 2022, the SerenityOS developers.
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include "LoadedLibrary.h"
#include <AK/Types.h>
#include <sys/arch/regs.h>

namespace Debug {

class ProcessInspector {
public:
    virtual ~ProcessInspector() = default;
    virtual bool poke(FlatPtr address, FlatPtr data) = 0;
    virtual Optional<FlatPtr> peek(FlatPtr address) const = 0;
    virtual PtraceRegisters get_registers() const = 0;
    virtual void set_registers(PtraceRegisters const&) = 0;
    virtual void for_each_loaded_library(Function<IterationDecision(LoadedLibrary const&)>) const = 0;

    LoadedLibrary const* library_at(FlatPtr address) const;
    struct SymbolicationResult {
        ByteString library_name;
        ByteString symbol;
    };
    Optional<SymbolicationResult> symbolicate(FlatPtr address) const;
    Optional<DebugInfo::SourcePositionAndAddress> get_address_from_source_position(ByteString const& file, size_t line) const;
    Optional<DebugInfo::SourcePosition> get_source_position(FlatPtr address) const;

protected:
    ProcessInspector() = default;
};

};