mirror of
https://github.com/RGBCube/serenity
synced 2025-10-31 14:22:43 +00:00
311a355505
Previously, we did source-level singlestepping by inserting a breakpoint at every source line and continued execution until we hit a breakpoint. We did this because we used to not generate source locations debug info for library code, and it allowed us to not single step through lots of library code to get to the next source line (which is super slow). Since we now do generate source locations debug info for libraries (-g1), we can improve the way we implement source level stepping by stepping at the assembly level until we reach a different source code location.
112 lines
3.9 KiB
C++
112 lines
3.9 KiB
C++
/*
|
|
* Copyright (c) 2020, Itamar S. <itamar8910@gmail.com>
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "BreakpointCallback.h"
|
|
#include <AK/Function.h>
|
|
#include <AK/Vector.h>
|
|
#include <LibDebug/DebugSession.h>
|
|
#include <LibThread/Lock.h>
|
|
#include <LibThread/Thread.h>
|
|
|
|
class Debugger {
|
|
public:
|
|
static Debugger& the();
|
|
|
|
enum class HasControlPassedToUser {
|
|
No,
|
|
Yes,
|
|
};
|
|
|
|
static void initialize(
|
|
Function<HasControlPassedToUser(const PtraceRegisters&)> on_stop_callback,
|
|
Function<void()> on_continue_callback,
|
|
Function<void()> on_exit_callback);
|
|
|
|
static bool is_initialized();
|
|
|
|
static void on_breakpoint_change(const String& file, size_t line, BreakpointChange change_type);
|
|
|
|
void set_executable_path(const String& path) { m_executable_path = path; }
|
|
|
|
DebugSession* session() { return m_debug_session.ptr(); }
|
|
|
|
// Thread entry point
|
|
static int start_static();
|
|
|
|
pthread_mutex_t* continue_mutex() { return &m_continue_mutex; }
|
|
pthread_cond_t* continue_cond() { return &m_continue_cond; }
|
|
|
|
enum class ContinueType {
|
|
Continue,
|
|
SourceSingleStep,
|
|
};
|
|
|
|
void set_continue_type(ContinueType type) { m_continue_type = type; }
|
|
void reset_breakpoints() { m_breakpoints.clear(); }
|
|
|
|
private:
|
|
class DebuggingState {
|
|
public:
|
|
enum State {
|
|
Normal,
|
|
SingleStepping,
|
|
};
|
|
State get() const { return m_state; }
|
|
void set_normal();
|
|
void set_single_stepping(DebugInfo::SourcePosition original_source_position);
|
|
bool should_stop_single_stepping(const DebugInfo::SourcePosition& current_source_position) const;
|
|
|
|
private:
|
|
State m_state { Normal };
|
|
Optional<DebugInfo::SourcePosition> m_original_source_position; // The source position at which we started the current single step
|
|
};
|
|
|
|
explicit Debugger(
|
|
Function<HasControlPassedToUser(const PtraceRegisters&)> on_stop_callback,
|
|
Function<void()> on_continue_callback,
|
|
Function<void()> on_exit_callback);
|
|
|
|
static DebugInfo::SourcePosition create_source_position(const String& file, size_t line);
|
|
|
|
void start();
|
|
int debugger_loop();
|
|
|
|
OwnPtr<DebugSession> m_debug_session;
|
|
|
|
pthread_mutex_t m_continue_mutex {};
|
|
pthread_cond_t m_continue_cond {};
|
|
|
|
Vector<DebugInfo::SourcePosition> m_breakpoints;
|
|
String m_executable_path;
|
|
|
|
Function<HasControlPassedToUser(const PtraceRegisters&)> m_on_stopped_callback;
|
|
Function<void()> m_on_continue_callback;
|
|
Function<void()> m_on_exit_callback;
|
|
|
|
ContinueType m_continue_type { ContinueType::Continue };
|
|
};
|