Reenable callback on |break| instruction #216
Conversation
Call the given callback on every `dbreak` instruction in the code stream - which is emitted for every line break in the code.
Don't pass the state in multiple variables, but use a struct to hold the VM state.
Expose the file names of the source files.
Keep it as simple as possible.
To be able to set breakpoints we need to be able to get the cip of the function or line we want to break on.
Lookup the function address from the rtti.methods table if available.
vm/smx-v1-image.cpp
Outdated
| SmxV1Image::LookupFunctionAddress(const char* function, const char* file, ucell_t* funcaddr) | ||
| { | ||
| uint32_t index = 0; | ||
| const char* tgtfile; |
There was a problem hiding this comment.
nit: move tgtfile down to where it's actually used. Same for index. (We're not using C :p)
The stack should be aligned to 16 bytes before a call.
Simplify the API to only allow one debug break handler for all plugins instead of maintaining different ones per runtime.
ISourcePawnEnvironment::EnableDebugBreak() has to be called before any plugins are loaded to have the call to the debug break handler compiled into the jitted code of the plugins. This is disabled by default, so it has no impact on performance.
peace-maker
force-pushed
the
debug_api_v1
branch
from
b77d678
to
7e9ae3e
Compare
| */ | ||
| typedef struct sp_debug_break_info_s | ||
| { | ||
| uint16_t version; /**< Version of this struct */ |
There was a problem hiding this comment.
How is this version field supposed to be used?
There was a problem hiding this comment.
To know whether new fields are available. When adding more info to the struct, like maybe a pointer to the smx in memory to parse the debug symbols manually, allow extensions know which fields they can use.
Probably could get rid of this seperate version field and just increase the whole vm api version if it's changed. Extensions just don't have access to SOURCEPAWN_API_VERSION.
vm/debugging.cpp
Outdated
| void InvokeDebugger(PluginContext* ctx, const IErrorReport* report) | ||
| { | ||
| // Ignore any calls if this isn't enabled. | ||
| if (!Environment::get()->IsDebugBreakEnabled()) |
There was a problem hiding this comment.
Is it possible to get here if the debug break is not enabled?
There was a problem hiding this comment.
Yes, through the interpreter.
vm/smx-v1-image.cpp
Outdated
| // now find the first line in the function where we can "break" on | ||
| uint32_t index = 0; | ||
| for (; index < debug_info_->num_lines && debug_lines_[index].addr < *funcaddr; index++) | ||
| /* nothing */; |
There was a problem hiding this comment.
nit: prefer {} for empty statements, or continue
vm/smx-v1-image.cpp
Outdated
| for (file = 0; file < debug_info_->num_files; file++) { | ||
| // find the (next) matching instance of the file | ||
| if (debug_files_[file].name >= debug_names_section_->size || | ||
| strcmp(debug_names_ + debug_files_[file].name, filename) != 0) |
There was a problem hiding this comment.
nit: indent strcmp to line up with debug_files_
vm/smx-v1-image.cpp
Outdated
| SmxV1Image::LookupLineAddress(const uint32_t line, const char* filename, uint32_t* addr) | ||
| { | ||
| /* Find a suitable "breakpoint address" close to the indicated line (and in | ||
| * the specified file). The address is moved up to the next "breakable" line |
There was a problem hiding this comment.
nit: Line up * or use C++-style comments
vm/smx-v1-image.cpp
Outdated
|
|
||
| // browse until the line is found or until the top address is exceeded | ||
| while (index < debug_info_->num_lines && | ||
| debug_lines_[index].line < line && |
There was a problem hiding this comment.
nit: Line up debug_lines_ with index
No need to check it again when coming from the JIT path, because the debugger wouldn't be called at all if it wasn't enabled.
peace-maker
force-pushed
the
debug_api_v1
branch
from
b5d7bb3
to
9c8a1c0
Compare
Reenable theAddIPluginContext::SetDebugBreakISourcePawnEngine::SetDebugBreakHandlerto allow others to listen for everybreakinstruction in the code stream. Add functions toIPluginDebugInfoto allow finding the address of functions and lines in plugins for break points.This doesn't expose any local nor global variable information yet, so debugging capabilities are pretty limited. You can print which file and line the plugin is about to execute currently.
This is partly extracted from #51.