2020-02-27 02:30:20 +00:00
|
|
|
/*************************************************************************/
|
|
|
|
/* remote_debugger.cpp */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/*************************************************************************/
|
2022-01-03 20:27:34 +00:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
2020-02-27 02:30:20 +00:00
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
|
|
|
#include "remote_debugger.h"
|
|
|
|
|
2020-11-07 22:33:38 +00:00
|
|
|
#include "core/config/project_settings.h"
|
2020-02-27 02:30:20 +00:00
|
|
|
#include "core/debugger/debugger_marshalls.h"
|
|
|
|
#include "core/debugger/engine_debugger.h"
|
2022-02-06 01:29:08 +00:00
|
|
|
#include "core/debugger/engine_profiler.h"
|
2020-02-27 02:30:20 +00:00
|
|
|
#include "core/debugger/script_debugger.h"
|
2020-04-28 13:19:37 +00:00
|
|
|
#include "core/input/input.h"
|
2020-11-07 22:33:38 +00:00
|
|
|
#include "core/object/script_language.h"
|
2020-02-27 02:30:20 +00:00
|
|
|
#include "core/os/os.h"
|
|
|
|
|
2022-02-06 01:29:08 +00:00
|
|
|
class RemoteDebugger::PerformanceProfiler : public EngineProfiler {
|
2020-04-01 23:20:12 +00:00
|
|
|
Object *performance = nullptr;
|
2020-02-27 02:30:20 +00:00
|
|
|
int last_perf_time = 0;
|
2020-06-04 13:18:57 +00:00
|
|
|
uint64_t last_monitor_modification_time = 0;
|
2020-02-27 02:30:20 +00:00
|
|
|
|
2022-02-06 01:29:08 +00:00
|
|
|
public:
|
2020-02-27 02:30:20 +00:00
|
|
|
void toggle(bool p_enable, const Array &p_opts) {}
|
|
|
|
void add(const Array &p_data) {}
|
2022-05-05 18:23:47 +00:00
|
|
|
void tick(double p_frame_time, double p_process_time, double p_physics_time, double p_physics_frame_time) {
|
2020-05-14 14:41:43 +00:00
|
|
|
if (!performance) {
|
2020-02-27 02:30:20 +00:00
|
|
|
return;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
uint64_t pt = OS::get_singleton()->get_ticks_msec();
|
2020-05-14 14:41:43 +00:00
|
|
|
if (pt - last_perf_time < 1000) {
|
2020-02-27 02:30:20 +00:00
|
|
|
return;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
last_perf_time = pt;
|
2020-06-04 13:18:57 +00:00
|
|
|
|
|
|
|
Array custom_monitor_names = performance->call("get_custom_monitor_names");
|
|
|
|
|
|
|
|
uint64_t monitor_modification_time = performance->call("get_monitor_modification_time");
|
|
|
|
if (monitor_modification_time > last_monitor_modification_time) {
|
|
|
|
last_monitor_modification_time = monitor_modification_time;
|
|
|
|
EngineDebugger::get_singleton()->send_message("performance:profile_names", custom_monitor_names);
|
|
|
|
}
|
|
|
|
|
2020-02-27 02:30:20 +00:00
|
|
|
int max = performance->get("MONITOR_MAX");
|
|
|
|
Array arr;
|
2020-06-04 13:18:57 +00:00
|
|
|
arr.resize(max + custom_monitor_names.size());
|
2020-02-27 02:30:20 +00:00
|
|
|
for (int i = 0; i < max; i++) {
|
|
|
|
arr[i] = performance->call("get_monitor", i);
|
|
|
|
}
|
2020-06-04 13:18:57 +00:00
|
|
|
|
|
|
|
for (int i = 0; i < custom_monitor_names.size(); i++) {
|
|
|
|
Variant monitor_value = performance->call("get_custom_monitor", custom_monitor_names[i]);
|
|
|
|
if (!monitor_value.is_num()) {
|
|
|
|
ERR_PRINT("Value of custom monitor '" + String(custom_monitor_names[i]) + "' is not a number");
|
|
|
|
arr[i + max] = Variant();
|
2022-04-05 10:40:26 +00:00
|
|
|
} else {
|
|
|
|
arr[i + max] = monitor_value;
|
2020-06-04 13:18:57 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-02-27 02:30:20 +00:00
|
|
|
EngineDebugger::get_singleton()->send_message("performance:profile_frame", arr);
|
|
|
|
}
|
|
|
|
|
2022-04-07 10:23:40 +00:00
|
|
|
explicit PerformanceProfiler(Object *p_performance) {
|
2020-02-27 02:30:20 +00:00
|
|
|
performance = p_performance;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
Error RemoteDebugger::_put_msg(String p_message, Array p_data) {
|
|
|
|
Array msg;
|
|
|
|
msg.push_back(p_message);
|
|
|
|
msg.push_back(p_data);
|
|
|
|
Error err = peer->put_message(msg);
|
2020-05-14 14:41:43 +00:00
|
|
|
if (err != OK) {
|
2020-02-27 02:30:20 +00:00
|
|
|
n_messages_dropped++;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
return err;
|
|
|
|
}
|
|
|
|
|
2021-09-22 15:36:40 +00:00
|
|
|
void RemoteDebugger::_err_handler(void *p_this, const char *p_func, const char *p_file, int p_line, const char *p_err, const char *p_descr, bool p_editor_notify, ErrorHandlerType p_type) {
|
2020-05-14 14:41:43 +00:00
|
|
|
if (p_type == ERR_HANDLER_SCRIPT) {
|
2020-02-27 02:30:20 +00:00
|
|
|
return; //ignore script errors, those go through debugger
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
2022-04-05 10:40:26 +00:00
|
|
|
RemoteDebugger *rd = static_cast<RemoteDebugger *>(p_this);
|
2020-05-14 14:41:43 +00:00
|
|
|
if (rd->flushing && Thread::get_caller_id() == rd->flush_thread) { // Can't handle recursive errors during flush.
|
2020-02-27 02:30:20 +00:00
|
|
|
return;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
Vector<ScriptLanguage::StackInfo> si;
|
|
|
|
|
|
|
|
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
|
|
|
|
si = ScriptServer::get_language(i)->debug_get_current_stack_info();
|
2020-05-14 14:41:43 +00:00
|
|
|
if (si.size()) {
|
2020-02-27 02:30:20 +00:00
|
|
|
break;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// send_error will lock internally.
|
2021-11-08 21:42:32 +00:00
|
|
|
rd->script_debugger->send_error(String::utf8(p_func), String::utf8(p_file), p_line, String::utf8(p_err), String::utf8(p_descr), p_editor_notify, p_type, si);
|
2020-02-27 02:30:20 +00:00
|
|
|
}
|
|
|
|
|
2022-05-02 23:29:38 +00:00
|
|
|
void RemoteDebugger::_print_handler(void *p_this, const String &p_string, bool p_error, bool p_rich) {
|
2022-04-05 10:40:26 +00:00
|
|
|
RemoteDebugger *rd = static_cast<RemoteDebugger *>(p_this);
|
2020-02-27 02:30:20 +00:00
|
|
|
|
2020-05-14 14:41:43 +00:00
|
|
|
if (rd->flushing && Thread::get_caller_id() == rd->flush_thread) { // Can't handle recursive prints during flush.
|
2020-02-27 02:30:20 +00:00
|
|
|
return;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
String s = p_string;
|
|
|
|
int allowed_chars = MIN(MAX(rd->max_chars_per_second - rd->char_count, 0), s.length());
|
|
|
|
|
2020-05-14 14:41:43 +00:00
|
|
|
if (allowed_chars == 0 && s.length() > 0) {
|
2020-02-27 02:30:20 +00:00
|
|
|
return;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
if (allowed_chars < s.length()) {
|
|
|
|
s = s.substr(0, allowed_chars);
|
|
|
|
}
|
|
|
|
|
|
|
|
MutexLock lock(rd->mutex);
|
|
|
|
|
|
|
|
rd->char_count += allowed_chars;
|
|
|
|
bool overflowed = rd->char_count >= rd->max_chars_per_second;
|
|
|
|
if (rd->is_peer_connected()) {
|
2020-05-14 14:41:43 +00:00
|
|
|
if (overflowed) {
|
2020-02-27 02:30:20 +00:00
|
|
|
s += "[...]";
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-05-01 16:23:51 +00:00
|
|
|
|
|
|
|
OutputString output_string;
|
|
|
|
output_string.message = s;
|
2022-05-02 23:29:38 +00:00
|
|
|
if (p_error) {
|
|
|
|
output_string.type = MESSAGE_TYPE_ERROR;
|
|
|
|
} else if (p_rich) {
|
|
|
|
output_string.type = MESSAGE_TYPE_LOG_RICH;
|
|
|
|
} else {
|
|
|
|
output_string.type = MESSAGE_TYPE_LOG;
|
|
|
|
}
|
2020-05-01 16:23:51 +00:00
|
|
|
rd->output_strings.push_back(output_string);
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
if (overflowed) {
|
2020-05-01 16:23:51 +00:00
|
|
|
output_string.message = "[output overflow, print less text!]";
|
|
|
|
output_string.type = MESSAGE_TYPE_ERROR;
|
|
|
|
rd->output_strings.push_back(output_string);
|
2020-02-27 02:30:20 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
RemoteDebugger::ErrorMessage RemoteDebugger::_create_overflow_error(const String &p_what, const String &p_descr) {
|
|
|
|
ErrorMessage oe;
|
|
|
|
oe.error = p_what;
|
|
|
|
oe.error_descr = p_descr;
|
|
|
|
oe.warning = false;
|
|
|
|
uint64_t time = OS::get_singleton()->get_ticks_msec();
|
|
|
|
oe.hr = time / 3600000;
|
|
|
|
oe.min = (time / 60000) % 60;
|
|
|
|
oe.sec = (time / 1000) % 60;
|
|
|
|
oe.msec = time % 1000;
|
|
|
|
return oe;
|
|
|
|
}
|
|
|
|
|
|
|
|
void RemoteDebugger::flush_output() {
|
|
|
|
flush_thread = Thread::get_caller_id();
|
|
|
|
flushing = true;
|
|
|
|
MutexLock lock(mutex);
|
2020-05-14 14:41:43 +00:00
|
|
|
if (!is_peer_connected()) {
|
2020-02-27 02:30:20 +00:00
|
|
|
return;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
if (n_messages_dropped > 0) {
|
|
|
|
ErrorMessage err_msg = _create_overflow_error("TOO_MANY_MESSAGES", "Too many messages! " + String::num_int64(n_messages_dropped) + " messages were dropped. Profiling might misbheave, try raising 'network/limits/debugger/max_queued_messages' in project setting.");
|
2020-05-14 14:41:43 +00:00
|
|
|
if (_put_msg("error", err_msg.serialize()) == OK) {
|
2020-02-27 02:30:20 +00:00
|
|
|
n_messages_dropped = 0;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (output_strings.size()) {
|
|
|
|
// Join output strings so we generate less messages.
|
2020-05-01 16:23:51 +00:00
|
|
|
Vector<String> joined_log_strings;
|
2020-02-27 02:30:20 +00:00
|
|
|
Vector<String> strings;
|
2020-05-01 16:23:51 +00:00
|
|
|
Vector<int> types;
|
2020-02-27 02:30:20 +00:00
|
|
|
for (int i = 0; i < output_strings.size(); i++) {
|
2020-05-01 16:23:51 +00:00
|
|
|
const OutputString &output_string = output_strings[i];
|
|
|
|
if (output_string.type == MESSAGE_TYPE_ERROR) {
|
2020-12-15 12:04:21 +00:00
|
|
|
if (!joined_log_strings.is_empty()) {
|
2020-05-01 16:23:51 +00:00
|
|
|
strings.push_back(String("\n").join(joined_log_strings));
|
|
|
|
types.push_back(MESSAGE_TYPE_LOG);
|
|
|
|
joined_log_strings.clear();
|
|
|
|
}
|
|
|
|
strings.push_back(output_string.message);
|
|
|
|
types.push_back(MESSAGE_TYPE_ERROR);
|
2022-06-30 19:33:59 +00:00
|
|
|
} else if (output_string.type == MESSAGE_TYPE_LOG_RICH) {
|
|
|
|
if (!joined_log_strings.is_empty()) {
|
|
|
|
strings.push_back(String("\n").join(joined_log_strings));
|
|
|
|
types.push_back(MESSAGE_TYPE_LOG_RICH);
|
|
|
|
joined_log_strings.clear();
|
|
|
|
}
|
|
|
|
strings.push_back(output_string.message);
|
|
|
|
types.push_back(MESSAGE_TYPE_LOG_RICH);
|
2020-05-01 16:23:51 +00:00
|
|
|
} else {
|
|
|
|
joined_log_strings.push_back(output_string.message);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-12-15 12:04:21 +00:00
|
|
|
if (!joined_log_strings.is_empty()) {
|
2020-05-01 16:23:51 +00:00
|
|
|
strings.push_back(String("\n").join(joined_log_strings));
|
|
|
|
types.push_back(MESSAGE_TYPE_LOG);
|
2020-02-27 02:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
Array arr;
|
|
|
|
arr.push_back(strings);
|
2020-05-01 16:23:51 +00:00
|
|
|
arr.push_back(types);
|
2020-02-27 02:30:20 +00:00
|
|
|
_put_msg("output", arr);
|
|
|
|
output_strings.clear();
|
|
|
|
}
|
|
|
|
|
|
|
|
while (errors.size()) {
|
|
|
|
ErrorMessage oe = errors.front()->get();
|
|
|
|
_put_msg("error", oe.serialize());
|
|
|
|
errors.pop_front();
|
|
|
|
}
|
|
|
|
|
|
|
|
// Update limits
|
|
|
|
uint64_t ticks = OS::get_singleton()->get_ticks_usec() / 1000;
|
|
|
|
|
|
|
|
if (ticks - last_reset > 1000) {
|
|
|
|
last_reset = ticks;
|
|
|
|
char_count = 0;
|
|
|
|
err_count = 0;
|
|
|
|
n_errors_dropped = 0;
|
|
|
|
warn_count = 0;
|
|
|
|
n_warnings_dropped = 0;
|
|
|
|
}
|
|
|
|
flushing = false;
|
|
|
|
}
|
|
|
|
|
|
|
|
void RemoteDebugger::send_message(const String &p_message, const Array &p_args) {
|
|
|
|
MutexLock lock(mutex);
|
|
|
|
if (is_peer_connected()) {
|
|
|
|
_put_msg(p_message, p_args);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-09-22 15:36:40 +00:00
|
|
|
void RemoteDebugger::send_error(const String &p_func, const String &p_file, int p_line, const String &p_err, const String &p_descr, bool p_editor_notify, ErrorHandlerType p_type) {
|
2020-02-27 02:30:20 +00:00
|
|
|
ErrorMessage oe;
|
|
|
|
oe.error = p_err;
|
|
|
|
oe.error_descr = p_descr;
|
|
|
|
oe.source_file = p_file;
|
|
|
|
oe.source_line = p_line;
|
|
|
|
oe.source_func = p_func;
|
|
|
|
oe.warning = p_type == ERR_HANDLER_WARNING;
|
|
|
|
uint64_t time = OS::get_singleton()->get_ticks_msec();
|
|
|
|
oe.hr = time / 3600000;
|
|
|
|
oe.min = (time / 60000) % 60;
|
|
|
|
oe.sec = (time / 1000) % 60;
|
|
|
|
oe.msec = time % 1000;
|
|
|
|
oe.callstack.append_array(script_debugger->get_error_stack_info());
|
|
|
|
|
2020-05-14 14:41:43 +00:00
|
|
|
if (flushing && Thread::get_caller_id() == flush_thread) { // Can't handle recursive errors during flush.
|
2020-02-27 02:30:20 +00:00
|
|
|
return;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
MutexLock lock(mutex);
|
|
|
|
|
|
|
|
if (oe.warning) {
|
|
|
|
warn_count++;
|
|
|
|
} else {
|
|
|
|
err_count++;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (is_peer_connected()) {
|
|
|
|
if (oe.warning) {
|
|
|
|
if (warn_count > max_warnings_per_second) {
|
|
|
|
n_warnings_dropped++;
|
|
|
|
if (n_warnings_dropped == 1) {
|
|
|
|
// Only print one message about dropping per second
|
|
|
|
ErrorMessage overflow = _create_overflow_error("TOO_MANY_WARNINGS", "Too many warnings! Ignoring warnings for up to 1 second.");
|
|
|
|
errors.push_back(overflow);
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
errors.push_back(oe);
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
if (err_count > max_errors_per_second) {
|
|
|
|
n_errors_dropped++;
|
|
|
|
if (n_errors_dropped == 1) {
|
|
|
|
// Only print one message about dropping per second
|
|
|
|
ErrorMessage overflow = _create_overflow_error("TOO_MANY_ERRORS", "Too many errors! Ignoring errors for up to 1 second.");
|
|
|
|
errors.push_back(overflow);
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
errors.push_back(oe);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void RemoteDebugger::_send_stack_vars(List<String> &p_names, List<Variant> &p_vals, int p_type) {
|
|
|
|
DebuggerMarshalls::ScriptStackVariable stvar;
|
|
|
|
List<String>::Element *E = p_names.front();
|
|
|
|
List<Variant>::Element *F = p_vals.front();
|
|
|
|
while (E) {
|
|
|
|
stvar.name = E->get();
|
|
|
|
stvar.value = F->get();
|
|
|
|
stvar.type = p_type;
|
|
|
|
send_message("stack_frame_var", stvar.serialize());
|
|
|
|
E = E->next();
|
|
|
|
F = F->next();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Error RemoteDebugger::_try_capture(const String &p_msg, const Array &p_data, bool &r_captured) {
|
|
|
|
const int idx = p_msg.find(":");
|
|
|
|
r_captured = false;
|
|
|
|
if (idx < 0) { // No prefix, unknown message.
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
const String cap = p_msg.substr(0, idx);
|
2020-05-14 14:41:43 +00:00
|
|
|
if (!has_capture(cap)) {
|
2020-02-27 02:30:20 +00:00
|
|
|
return ERR_UNAVAILABLE; // Unknown message...
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
const String msg = p_msg.substr(idx + 1);
|
|
|
|
return capture_parse(cap, msg, p_data, r_captured);
|
|
|
|
}
|
|
|
|
|
|
|
|
void RemoteDebugger::debug(bool p_can_continue, bool p_is_error_breakpoint) {
|
|
|
|
//this function is called when there is a debugger break (bug on script)
|
|
|
|
//or when execution is paused from editor
|
|
|
|
|
2020-05-14 14:41:43 +00:00
|
|
|
if (script_debugger->is_skipping_breakpoints() && !p_is_error_breakpoint) {
|
2020-02-27 02:30:20 +00:00
|
|
|
return;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
ERR_FAIL_COND_MSG(!is_peer_connected(), "Script Debugger failed to connect, but being used anyway.");
|
|
|
|
|
2020-05-14 14:41:43 +00:00
|
|
|
if (!peer->can_block()) {
|
2020-03-11 10:23:21 +00:00
|
|
|
return; // Peer does not support blocking IO. We could at least send the error though.
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-03-11 10:23:21 +00:00
|
|
|
|
2020-02-27 02:30:20 +00:00
|
|
|
ScriptLanguage *script_lang = script_debugger->get_break_language();
|
|
|
|
const String error_str = script_lang ? script_lang->debug_get_error() : "";
|
|
|
|
Array msg;
|
|
|
|
msg.push_back(p_can_continue);
|
|
|
|
msg.push_back(error_str);
|
2021-06-04 18:39:38 +00:00
|
|
|
ERR_FAIL_COND(!script_lang);
|
|
|
|
msg.push_back(script_lang->debug_get_stack_level_count() > 0);
|
2022-07-21 19:41:02 +00:00
|
|
|
if (allow_focus_steal_fn) {
|
|
|
|
allow_focus_steal_fn();
|
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
send_message("debug_enter", msg);
|
|
|
|
|
2020-04-28 13:19:37 +00:00
|
|
|
Input::MouseMode mouse_mode = Input::get_singleton()->get_mouse_mode();
|
2020-05-14 14:41:43 +00:00
|
|
|
if (mouse_mode != Input::MOUSE_MODE_VISIBLE) {
|
2020-04-28 13:19:37 +00:00
|
|
|
Input::get_singleton()->set_mouse_mode(Input::MOUSE_MODE_VISIBLE);
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
while (is_peer_connected()) {
|
|
|
|
flush_output();
|
|
|
|
peer->poll();
|
|
|
|
|
|
|
|
if (peer->has_message()) {
|
|
|
|
Array cmd = peer->get_message();
|
|
|
|
|
|
|
|
ERR_CONTINUE(cmd.size() != 2);
|
|
|
|
ERR_CONTINUE(cmd[0].get_type() != Variant::STRING);
|
|
|
|
ERR_CONTINUE(cmd[1].get_type() != Variant::ARRAY);
|
|
|
|
|
|
|
|
String command = cmd[0];
|
|
|
|
Array data = cmd[1];
|
|
|
|
|
|
|
|
if (command == "step") {
|
|
|
|
script_debugger->set_depth(-1);
|
|
|
|
script_debugger->set_lines_left(1);
|
|
|
|
break;
|
|
|
|
|
|
|
|
} else if (command == "next") {
|
|
|
|
script_debugger->set_depth(0);
|
|
|
|
script_debugger->set_lines_left(1);
|
|
|
|
break;
|
|
|
|
|
|
|
|
} else if (command == "continue") {
|
|
|
|
script_debugger->set_depth(-1);
|
|
|
|
script_debugger->set_lines_left(-1);
|
|
|
|
break;
|
|
|
|
|
|
|
|
} else if (command == "break") {
|
|
|
|
ERR_PRINT("Got break when already broke!");
|
|
|
|
break;
|
|
|
|
|
|
|
|
} else if (command == "get_stack_dump") {
|
|
|
|
DebuggerMarshalls::ScriptStackDump dump;
|
|
|
|
int slc = script_lang->debug_get_stack_level_count();
|
|
|
|
for (int i = 0; i < slc; i++) {
|
|
|
|
ScriptLanguage::StackInfo frame;
|
|
|
|
frame.file = script_lang->debug_get_stack_level_source(i);
|
|
|
|
frame.line = script_lang->debug_get_stack_level_line(i);
|
|
|
|
frame.func = script_lang->debug_get_stack_level_function(i);
|
|
|
|
dump.frames.push_back(frame);
|
|
|
|
}
|
|
|
|
send_message("stack_dump", dump.serialize());
|
|
|
|
|
|
|
|
} else if (command == "get_stack_frame_vars") {
|
|
|
|
ERR_FAIL_COND(data.size() != 1);
|
|
|
|
ERR_FAIL_COND(!script_lang);
|
|
|
|
int lv = data[0];
|
|
|
|
|
|
|
|
List<String> members;
|
|
|
|
List<Variant> member_vals;
|
|
|
|
if (ScriptInstance *inst = script_lang->debug_get_stack_level_instance(lv)) {
|
|
|
|
members.push_back("self");
|
|
|
|
member_vals.push_back(inst->get_owner());
|
|
|
|
}
|
|
|
|
script_lang->debug_get_stack_level_members(lv, &members, &member_vals);
|
|
|
|
ERR_FAIL_COND(members.size() != member_vals.size());
|
|
|
|
|
|
|
|
List<String> locals;
|
|
|
|
List<Variant> local_vals;
|
|
|
|
script_lang->debug_get_stack_level_locals(lv, &locals, &local_vals);
|
|
|
|
ERR_FAIL_COND(locals.size() != local_vals.size());
|
|
|
|
|
|
|
|
List<String> globals;
|
|
|
|
List<Variant> globals_vals;
|
|
|
|
script_lang->debug_get_globals(&globals, &globals_vals);
|
|
|
|
ERR_FAIL_COND(globals.size() != globals_vals.size());
|
|
|
|
|
2021-06-04 18:39:38 +00:00
|
|
|
Array var_size;
|
|
|
|
var_size.push_back(local_vals.size() + member_vals.size() + globals_vals.size());
|
|
|
|
send_message("stack_frame_vars", var_size);
|
2020-02-27 02:30:20 +00:00
|
|
|
_send_stack_vars(locals, local_vals, 0);
|
|
|
|
_send_stack_vars(members, member_vals, 1);
|
|
|
|
_send_stack_vars(globals, globals_vals, 2);
|
|
|
|
|
|
|
|
} else if (command == "reload_scripts") {
|
|
|
|
reload_all_scripts = true;
|
|
|
|
|
|
|
|
} else if (command == "breakpoint") {
|
|
|
|
ERR_FAIL_COND(data.size() < 3);
|
|
|
|
bool set = data[2];
|
2020-05-14 14:41:43 +00:00
|
|
|
if (set) {
|
2020-02-27 02:30:20 +00:00
|
|
|
script_debugger->insert_breakpoint(data[1], data[0]);
|
2020-05-14 14:41:43 +00:00
|
|
|
} else {
|
2020-02-27 02:30:20 +00:00
|
|
|
script_debugger->remove_breakpoint(data[1], data[0]);
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
} else if (command == "set_skip_breakpoints") {
|
|
|
|
ERR_FAIL_COND(data.size() < 1);
|
|
|
|
script_debugger->set_skip_breakpoints(data[0]);
|
|
|
|
} else {
|
|
|
|
bool captured = false;
|
|
|
|
ERR_CONTINUE(_try_capture(command, data, captured) != OK);
|
2020-05-14 14:41:43 +00:00
|
|
|
if (!captured) {
|
2020-02-27 02:30:20 +00:00
|
|
|
WARN_PRINT("Unknown message received from debugger: " + command);
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
OS::get_singleton()->delay_usec(10000);
|
|
|
|
OS::get_singleton()->process_and_drop_events();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
send_message("debug_exit", Array());
|
|
|
|
|
2020-05-14 14:41:43 +00:00
|
|
|
if (mouse_mode != Input::MOUSE_MODE_VISIBLE) {
|
2020-04-28 13:19:37 +00:00
|
|
|
Input::get_singleton()->set_mouse_mode(mouse_mode);
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void RemoteDebugger::poll_events(bool p_is_idle) {
|
2020-05-14 14:41:43 +00:00
|
|
|
if (peer.is_null()) {
|
2020-02-27 02:30:20 +00:00
|
|
|
return;
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
flush_output();
|
|
|
|
peer->poll();
|
|
|
|
while (peer->has_message()) {
|
|
|
|
Array arr = peer->get_message();
|
|
|
|
|
|
|
|
ERR_CONTINUE(arr.size() != 2);
|
|
|
|
ERR_CONTINUE(arr[0].get_type() != Variant::STRING);
|
|
|
|
ERR_CONTINUE(arr[1].get_type() != Variant::ARRAY);
|
|
|
|
|
|
|
|
const String cmd = arr[0];
|
|
|
|
const int idx = cmd.find(":");
|
|
|
|
bool parsed = false;
|
|
|
|
if (idx < 0) { // Not prefix, use scripts capture.
|
|
|
|
capture_parse("core", cmd, arr[1], parsed);
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
const String cap = cmd.substr(0, idx);
|
2020-05-14 14:41:43 +00:00
|
|
|
if (!has_capture(cap)) {
|
2020-02-27 02:30:20 +00:00
|
|
|
continue; // Unknown message...
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
const String msg = cmd.substr(idx + 1);
|
|
|
|
capture_parse(cap, msg, arr[1], parsed);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Reload scripts during idle poll only.
|
|
|
|
if (p_is_idle && reload_all_scripts) {
|
|
|
|
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
|
|
|
|
ScriptServer::get_language(i)->reload_all_scripts();
|
|
|
|
}
|
|
|
|
reload_all_scripts = false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Error RemoteDebugger::_core_capture(const String &p_cmd, const Array &p_data, bool &r_captured) {
|
|
|
|
r_captured = true;
|
|
|
|
if (p_cmd == "reload_scripts") {
|
|
|
|
reload_all_scripts = true;
|
|
|
|
|
|
|
|
} else if (p_cmd == "breakpoint") {
|
|
|
|
ERR_FAIL_COND_V(p_data.size() < 3, ERR_INVALID_DATA);
|
|
|
|
bool set = p_data[2];
|
2020-05-14 14:41:43 +00:00
|
|
|
if (set) {
|
2020-02-27 02:30:20 +00:00
|
|
|
script_debugger->insert_breakpoint(p_data[1], p_data[0]);
|
2020-05-14 14:41:43 +00:00
|
|
|
} else {
|
2020-02-27 02:30:20 +00:00
|
|
|
script_debugger->remove_breakpoint(p_data[1], p_data[0]);
|
2020-05-14 14:41:43 +00:00
|
|
|
}
|
2020-02-27 02:30:20 +00:00
|
|
|
|
|
|
|
} else if (p_cmd == "set_skip_breakpoints") {
|
|
|
|
ERR_FAIL_COND_V(p_data.size() < 1, ERR_INVALID_DATA);
|
|
|
|
script_debugger->set_skip_breakpoints(p_data[0]);
|
|
|
|
} else if (p_cmd == "break") {
|
|
|
|
script_debugger->debug(script_debugger->get_break_language());
|
|
|
|
} else {
|
|
|
|
r_captured = false;
|
|
|
|
}
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
|
|
|
|
Error RemoteDebugger::_profiler_capture(const String &p_cmd, const Array &p_data, bool &r_captured) {
|
|
|
|
r_captured = false;
|
|
|
|
ERR_FAIL_COND_V(p_data.size() < 1, ERR_INVALID_DATA);
|
|
|
|
ERR_FAIL_COND_V(p_data[0].get_type() != Variant::BOOL, ERR_INVALID_DATA);
|
|
|
|
ERR_FAIL_COND_V(!has_profiler(p_cmd), ERR_UNAVAILABLE);
|
|
|
|
Array opts;
|
|
|
|
if (p_data.size() > 1) { // Optional profiler parameters.
|
|
|
|
ERR_FAIL_COND_V(p_data[1].get_type() != Variant::ARRAY, ERR_INVALID_DATA);
|
|
|
|
opts = p_data[1];
|
|
|
|
}
|
|
|
|
r_captured = true;
|
|
|
|
profiler_enable(p_cmd, p_data[0], opts);
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
|
|
|
|
RemoteDebugger::RemoteDebugger(Ref<RemoteDebuggerPeer> p_peer) {
|
|
|
|
peer = p_peer;
|
|
|
|
max_chars_per_second = GLOBAL_GET("network/limits/debugger/max_chars_per_second");
|
|
|
|
max_errors_per_second = GLOBAL_GET("network/limits/debugger/max_errors_per_second");
|
|
|
|
max_warnings_per_second = GLOBAL_GET("network/limits/debugger/max_warnings_per_second");
|
|
|
|
|
2020-03-11 17:59:18 +00:00
|
|
|
// Performance Profiler
|
2020-02-27 02:30:20 +00:00
|
|
|
Object *perf = Engine::get_singleton()->get_singleton_object("Performance");
|
|
|
|
if (perf) {
|
2022-02-06 01:29:08 +00:00
|
|
|
performance_profiler = Ref<PerformanceProfiler>(memnew(PerformanceProfiler(perf)));
|
|
|
|
performance_profiler->bind("performance");
|
2020-02-27 02:30:20 +00:00
|
|
|
profiler_enable("performance", true);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Core and profiler captures.
|
|
|
|
Capture core_cap(this,
|
|
|
|
[](void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
|
2022-04-05 10:40:26 +00:00
|
|
|
return static_cast<RemoteDebugger *>(p_user)->_core_capture(p_cmd, p_data, r_captured);
|
2020-02-27 02:30:20 +00:00
|
|
|
});
|
|
|
|
register_message_capture("core", core_cap);
|
|
|
|
Capture profiler_cap(this,
|
|
|
|
[](void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
|
2022-04-05 10:40:26 +00:00
|
|
|
return static_cast<RemoteDebugger *>(p_user)->_profiler_capture(p_cmd, p_data, r_captured);
|
2020-02-27 02:30:20 +00:00
|
|
|
});
|
|
|
|
register_message_capture("profiler", profiler_cap);
|
|
|
|
|
|
|
|
// Error handlers
|
|
|
|
phl.printfunc = _print_handler;
|
|
|
|
phl.userdata = this;
|
|
|
|
add_print_handler(&phl);
|
|
|
|
|
|
|
|
eh.errfunc = _err_handler;
|
|
|
|
eh.userdata = this;
|
|
|
|
add_error_handler(&eh);
|
|
|
|
}
|
|
|
|
|
|
|
|
RemoteDebugger::~RemoteDebugger() {
|
|
|
|
remove_print_handler(&phl);
|
|
|
|
remove_error_handler(&eh);
|
|
|
|
}
|