serenity/Userland/DevTools/UserspaceEmulator/Emulator.h

/*
 * Copyright (c) 2020-2021, Andreas Kling <kling@serenityos.org>
 * Copyright (c) 2021, sin-ack <sin-ack@protonmail.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include "MallocTracer.h"
#include "RangeAllocator.h"
#include "Report.h"
#include "SoftMMU.h"
#include <AK/FileStream.h>
#include <AK/Types.h>
#include <LibCore/MappedFile.h>
#include <LibDebug/DebugInfo.h>
#include <LibELF/AuxiliaryVector.h>
#include <LibELF/Image.h>
#include <LibLine/Editor.h>
#include <LibX86/Instruction.h>
#include <signal.h>
#include <sys/types.h>

namespace UserspaceEmulator {

class MallocTracer;
class SoftCPU;

class Emulator {
public:
    static Emulator& the();

    Emulator(String const& executable_path, Vector<StringView> const& arguments, Vector<String> const& environment);

    void set_profiling_details(bool should_dump_profile, size_t instruction_interval, OutputFileStream* profile_stream, NonnullOwnPtrVector<String>* profiler_strings, Vector<int>* profiler_string_id_map)
    {
        m_is_profiling = should_dump_profile;
        m_profile_instruction_interval = instruction_interval;
        m_profile_stream = profile_stream;
        m_profiler_strings = profiler_strings;
        m_profiler_string_id_map = profiler_string_id_map;
    }

    void set_in_region_of_interest(bool value)
    {
        m_is_in_region_of_interest = value;
    }

    OutputFileStream& profile_stream() { return *m_profile_stream; }
    NonnullOwnPtrVector<String>& profiler_strings() { return *m_profiler_strings; }
    Vector<int>& profiler_string_id_map() { return *m_profiler_string_id_map; }

    bool is_profiling() const { return m_is_profiling; }
    bool is_in_region_of_interest() const { return m_is_in_region_of_interest; }
    size_t profile_instruction_interval() const { return m_profile_instruction_interval; }
    bool is_memory_auditing_suppressed() const { return m_is_memory_auditing_suppressed; }

    bool load_elf();
    void dump_backtrace();
    void dump_backtrace(Vector<FlatPtr> const&);
    Vector<FlatPtr> raw_backtrace();

    int exec();
    void handle_repl();
    u32 virt_syscall(u32 function, u32 arg1, u32 arg2, u32 arg3);

    SoftMMU& mmu() { return m_mmu; }

    MallocTracer* malloc_tracer() { return m_malloc_tracer; }

    bool is_in_loader_code() const;
    bool is_in_libsystem() const;

    void pause()
    {
        m_steps_til_pause = 0;
        m_run_til_return = false;
    }
    ALWAYS_INLINE void return_callback(FlatPtr addr)
    {
        if (m_run_til_return) [[unlikely]] {
            if (addr == m_watched_addr)
                pause();
        }
    }
    ALWAYS_INLINE void call_callback(FlatPtr addr)
    {
        if (m_run_til_call) [[unlikely]] {
            if (addr == m_watched_addr)
                pause();
        }
    }

    struct SignalInfo {
        siginfo_t signal_info;
        ucontext_t context;
    };
    void did_receive_signal(int signum, SignalInfo info, bool from_emulator = false)
    {
        if (!from_emulator && signum == SIGINT)
            return did_receive_sigint(signum);

        m_pending_signals |= (1 << signum);
        m_signal_data[signum] = info;
    }

    void did_receive_sigint(int)
    {
        if (m_steps_til_pause == 0)
            m_shutdown = true;
        else
            pause();
    }

    struct SymbolInfo {
        String lib_name;
        String symbol;
        Optional<Debug::DebugInfo::SourcePosition> source_position;
    };

    Optional<SymbolInfo> symbol_at(FlatPtr address);

    void dump_regions() const;

private:
    const String m_executable_path;
    const Vector<StringView> m_arguments;
    const Vector<String> m_environment;

    SoftMMU m_mmu;
    NonnullOwnPtr<SoftCPU> m_cpu;

    OwnPtr<MallocTracer> m_malloc_tracer;

    void setup_stack(Vector<ELF::AuxiliaryValue>);
    Vector<ELF::AuxiliaryValue> generate_auxiliary_vector(FlatPtr load_base, FlatPtr entry_eip, String const& executable_path, int executable_fd) const;
    void register_signal_handlers();
    void setup_signal_trampoline();

    void send_signal(int);

    void emit_profile_sample(AK::OutputStream&);
    void emit_profile_event(AK::OutputStream&, StringView event_name, String const& contents);

    int virt$accept4(FlatPtr);
    int virt$access(FlatPtr, size_t, int);
    u32 virt$allocate_tls(FlatPtr, size_t);
    int virt$anon_create(size_t, int);
    int virt$beep();
    int virt$bind(int sockfd, FlatPtr address, socklen_t address_length);
    int virt$chdir(FlatPtr, size_t);
    int virt$chmod(FlatPtr);
    int virt$chown(FlatPtr);
    int virt$clock_gettime(int, FlatPtr);
    int virt$clock_nanosleep(FlatPtr);
    int virt$clock_settime(uint32_t clock_id, FlatPtr user_ts);
    int virt$close(int);
    int virt$connect(int sockfd, FlatPtr address, socklen_t address_size);
    int virt$create_inode_watcher(unsigned);
    int virt$dbgputstr(FlatPtr characters, int length);
    int virt$disown(pid_t);
    int virt$dup2(int, int);
    int virt$emuctl(FlatPtr, FlatPtr, FlatPtr);
    int virt$execve(FlatPtr);
    void virt$exit(int);
    int virt$fchmod(int, mode_t);
    int virt$fchown(int, uid_t, gid_t);
    u32 virt$fcntl(int fd, int, u32);
    int virt$fork();
    int virt$fstat(int, FlatPtr);
    int virt$ftruncate(int fd, FlatPtr length_addr);
    int virt$futex(FlatPtr);
    int virt$get_dir_entries(int fd, FlatPtr buffer, ssize_t);
    int virt$get_process_name(FlatPtr buffer, int size);
    int virt$get_stack_bounds(FlatPtr, FlatPtr);
    int virt$getcwd(FlatPtr buffer, size_t buffer_size);
    gid_t virt$getegid();
    uid_t virt$geteuid();
    gid_t virt$getgid();
    int virt$getgroups(ssize_t count, FlatPtr);
    int virt$gethostname(FlatPtr, ssize_t);
    int virt$getpeername(FlatPtr);
    int virt$getpgid(pid_t);
    int virt$getpgrp();
    u32 virt$getpid();
    pid_t virt$getppid();
    ssize_t virt$getrandom(FlatPtr buffer, size_t buffer_size, unsigned int flags);
    int virt$getsid(pid_t);
    int virt$getsockname(FlatPtr);
    int virt$getsockopt(FlatPtr);
    u32 virt$gettid();
    uid_t virt$getuid();
    int virt$inode_watcher_add_watch(FlatPtr);
    int virt$inode_watcher_remove_watch(int, int);
    int virt$ioctl(int fd, unsigned, FlatPtr);
    int virt$kill(pid_t, int);
    int virt$killpg(int pgrp, int sig);
    int virt$listen(int, int);
    int virt$lseek(int fd, FlatPtr offset_addr, int whence);
    u32 virt$madvise(FlatPtr, size_t, int);
    int virt$mkdir(FlatPtr path, size_t path_length, mode_t mode);
    u32 virt$mmap(u32);
    u32 virt$mount(u32);
    u32 virt$mprotect(FlatPtr, size_t, int);
    FlatPtr virt$mremap(FlatPtr);
    int virt$msyscall(FlatPtr);
    u32 virt$munmap(FlatPtr address, size_t size);
    u32 virt$open(u32);
    FlatPtr virt$perf_event(int type, FlatPtr arg1, FlatPtr arg2);
    FlatPtr virt$perf_register_string(FlatPtr, size_t);
    int virt$pipe(FlatPtr pipefd, int flags);
    u32 virt$pledge(u32);
    int virt$poll(FlatPtr);
    int virt$profiling_disable(pid_t);
    int virt$profiling_enable(pid_t);
    int virt$ptsname(int fd, FlatPtr buffer, size_t buffer_size);
    int virt$purge(int mode);
    u32 virt$read(int, FlatPtr, ssize_t);
    int virt$readlink(FlatPtr);
    int virt$realpath(FlatPtr);
    int virt$recvfd(int, int);
    int virt$recvmsg(int sockfd, FlatPtr msg_addr, int flags);
    int virt$rename(FlatPtr address);
    int virt$rmdir(FlatPtr path, size_t path_length);
    int virt$sched_getparam(pid_t, FlatPtr);
    int virt$sched_setparam(int, FlatPtr);
    int virt$sendfd(int, int);
    int virt$sendmsg(int sockfd, FlatPtr msg_addr, int flags);
    int virt$set_coredump_metadata(FlatPtr address);
    int virt$set_mmap_name(FlatPtr);
    int virt$set_process_name(FlatPtr buffer, int size);
    int virt$set_thread_name(pid_t, FlatPtr, size_t);
    int virt$setgid(gid_t);
    int virt$setgroups(ssize_t count, FlatPtr);
    int virt$setpgid(pid_t pid, pid_t pgid);
    pid_t virt$setsid();
    int virt$setsockopt(FlatPtr);
    int virt$setuid(uid_t);
    int virt$shutdown(int sockfd, int how);
    int virt$sigaction(int, FlatPtr, FlatPtr);
    int virt$sigprocmask(int how, FlatPtr set, FlatPtr old_set);
    int virt$sigreturn();
    int virt$socket(int, int, int);
    int virt$stat(FlatPtr);
    int virt$symlink(FlatPtr address);
    void virt$sync();
    u32 virt$sysconf(u32 name);
    int virt$ttyname(int fd, FlatPtr buffer, size_t buffer_size);
    mode_t virt$umask(mode_t);
    int virt$uname(FlatPtr params_addr);
    int virt$unlink(FlatPtr path, size_t path_length);
    u32 virt$unveil(u32);
    int virt$waitid(FlatPtr);
    u32 virt$write(int, FlatPtr, ssize_t);

    void dispatch_one_pending_signal();
    MmapRegion const* find_text_region(FlatPtr address);
    MmapRegion const* load_library_from_address(FlatPtr address);
    MmapRegion const* first_region_for_object(StringView name);
    String create_backtrace_line(FlatPtr address);
    String create_instruction_line(FlatPtr address, X86::Instruction const& insn);

    bool m_shutdown { false };
    int m_exit_status { 0 };

    i64 m_steps_til_pause { -1 };
    bool m_run_til_return { false };
    bool m_run_til_call { false };
    FlatPtr m_watched_addr { 0 };
    RefPtr<Line::Editor> m_editor;

    FlatPtr m_libsystem_start { 0 };
    FlatPtr m_libsystem_end { 0 };

    sigset_t m_pending_signals { 0 };
    sigset_t m_signal_mask { 0 };
    Array<SignalInfo, NSIG> m_signal_data;

    struct SignalHandlerInfo {
        FlatPtr handler { 0 };
        sigset_t mask { 0 };
        int flags { 0 };
    };
    SignalHandlerInfo m_signal_handler[NSIG];

    FlatPtr m_signal_trampoline { 0 };
    Optional<FlatPtr> m_loader_text_base;
    Optional<size_t> m_loader_text_size;

    struct CachedELF {
        NonnullRefPtr<Core::MappedFile> mapped_file;
        NonnullOwnPtr<Debug::DebugInfo> debug_info;
        NonnullOwnPtr<ELF::Image> image;
    };

    HashMap<String, CachedELF> m_dynamic_library_cache;

    RangeAllocator m_range_allocator;

    OutputFileStream* m_profile_stream { nullptr };
    Vector<int>* m_profiler_string_id_map { nullptr };
    NonnullOwnPtrVector<String>* m_profiler_strings { nullptr };

    bool m_is_profiling { false };
    size_t m_profile_instruction_interval { 0 };
    bool m_is_in_region_of_interest { false };
    bool m_is_memory_auditing_suppressed { false };
};

}