remote_debugger.cpp 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737
  1. /**************************************************************************/
  2. /* remote_debugger.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "remote_debugger.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/debugger/debugger_marshalls.h"
  33. #include "core/debugger/engine_debugger.h"
  34. #include "core/debugger/engine_profiler.h"
  35. #include "core/debugger/script_debugger.h"
  36. #include "core/input/input.h"
  37. #include "core/io/resource_loader.h"
  38. #include "core/math/expression.h"
  39. #include "core/object/script_language.h"
  40. #include "core/os/os.h"
  41. #include "servers/display_server.h"
  42. class RemoteDebugger::PerformanceProfiler : public EngineProfiler {
  43. Object *performance = nullptr;
  44. int last_perf_time = 0;
  45. uint64_t last_monitor_modification_time = 0;
  46. public:
  47. void toggle(bool p_enable, const Array &p_opts) {}
  48. void add(const Array &p_data) {}
  49. void tick(double p_frame_time, double p_process_time, double p_physics_time, double p_physics_frame_time) {
  50. if (!performance) {
  51. return;
  52. }
  53. uint64_t pt = OS::get_singleton()->get_ticks_msec();
  54. if (pt - last_perf_time < 1000) {
  55. return;
  56. }
  57. last_perf_time = pt;
  58. Array custom_monitor_names = performance->call("get_custom_monitor_names");
  59. uint64_t monitor_modification_time = performance->call("get_monitor_modification_time");
  60. if (monitor_modification_time > last_monitor_modification_time) {
  61. last_monitor_modification_time = monitor_modification_time;
  62. EngineDebugger::get_singleton()->send_message("performance:profile_names", custom_monitor_names);
  63. }
  64. int max = performance->get("MONITOR_MAX");
  65. Array arr;
  66. arr.resize(max + custom_monitor_names.size());
  67. for (int i = 0; i < max; i++) {
  68. arr[i] = performance->call("get_monitor", i);
  69. }
  70. for (int i = 0; i < custom_monitor_names.size(); i++) {
  71. Variant monitor_value = performance->call("get_custom_monitor", custom_monitor_names[i]);
  72. if (!monitor_value.is_num()) {
  73. ERR_PRINT(vformat("Value of custom monitor '%s' is not a number.", String(custom_monitor_names[i])));
  74. arr[i + max] = Variant();
  75. } else {
  76. arr[i + max] = monitor_value;
  77. }
  78. }
  79. EngineDebugger::get_singleton()->send_message("performance:profile_frame", arr);
  80. }
  81. explicit PerformanceProfiler(Object *p_performance) {
  82. performance = p_performance;
  83. }
  84. };
  85. Error RemoteDebugger::_put_msg(const String &p_message, const Array &p_data) {
  86. Array msg;
  87. msg.push_back(p_message);
  88. msg.push_back(Thread::get_caller_id());
  89. msg.push_back(p_data);
  90. Error err = peer->put_message(msg);
  91. if (err != OK) {
  92. n_messages_dropped++;
  93. }
  94. return err;
  95. }
  96. 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) {
  97. if (p_type == ERR_HANDLER_SCRIPT) {
  98. return; //ignore script errors, those go through debugger
  99. }
  100. RemoteDebugger *rd = static_cast<RemoteDebugger *>(p_this);
  101. if (rd->flushing && Thread::get_caller_id() == rd->flush_thread) { // Can't handle recursive errors during flush.
  102. return;
  103. }
  104. Vector<ScriptLanguage::StackInfo> si;
  105. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  106. si = ScriptServer::get_language(i)->debug_get_current_stack_info();
  107. if (si.size()) {
  108. break;
  109. }
  110. }
  111. // send_error will lock internally.
  112. 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);
  113. }
  114. void RemoteDebugger::_print_handler(void *p_this, const String &p_string, bool p_error, bool p_rich) {
  115. RemoteDebugger *rd = static_cast<RemoteDebugger *>(p_this);
  116. if (rd->flushing && Thread::get_caller_id() == rd->flush_thread) { // Can't handle recursive prints during flush.
  117. return;
  118. }
  119. String s = p_string;
  120. int allowed_chars = MIN(MAX(rd->max_chars_per_second - rd->char_count, 0), s.length());
  121. if (allowed_chars == 0 && s.length() > 0) {
  122. return;
  123. }
  124. if (allowed_chars < s.length()) {
  125. s = s.substr(0, allowed_chars);
  126. }
  127. MutexLock lock(rd->mutex);
  128. rd->char_count += allowed_chars;
  129. bool overflowed = rd->char_count >= rd->max_chars_per_second;
  130. if (rd->is_peer_connected()) {
  131. if (overflowed) {
  132. s += "[...]";
  133. }
  134. OutputString output_string;
  135. output_string.message = s;
  136. if (p_error) {
  137. output_string.type = MESSAGE_TYPE_ERROR;
  138. } else if (p_rich) {
  139. output_string.type = MESSAGE_TYPE_LOG_RICH;
  140. } else {
  141. output_string.type = MESSAGE_TYPE_LOG;
  142. }
  143. rd->output_strings.push_back(output_string);
  144. if (overflowed) {
  145. output_string.message = "[output overflow, print less text!]";
  146. output_string.type = MESSAGE_TYPE_ERROR;
  147. rd->output_strings.push_back(output_string);
  148. }
  149. }
  150. }
  151. RemoteDebugger::ErrorMessage RemoteDebugger::_create_overflow_error(const String &p_what, const String &p_descr) {
  152. ErrorMessage oe;
  153. oe.error = p_what;
  154. oe.error_descr = p_descr;
  155. oe.warning = false;
  156. uint64_t time = OS::get_singleton()->get_ticks_msec();
  157. oe.hr = time / 3600000;
  158. oe.min = (time / 60000) % 60;
  159. oe.sec = (time / 1000) % 60;
  160. oe.msec = time % 1000;
  161. return oe;
  162. }
  163. void RemoteDebugger::flush_output() {
  164. MutexLock lock(mutex);
  165. flush_thread = Thread::get_caller_id();
  166. flushing = true;
  167. if (!is_peer_connected()) {
  168. return;
  169. }
  170. if (n_messages_dropped > 0) {
  171. 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.");
  172. if (_put_msg("error", err_msg.serialize()) == OK) {
  173. n_messages_dropped = 0;
  174. }
  175. }
  176. if (output_strings.size()) {
  177. // Join output strings so we generate less messages.
  178. Vector<String> joined_log_strings;
  179. Vector<String> strings;
  180. Vector<int> types;
  181. for (const OutputString &output_string : output_strings) {
  182. if (output_string.type == MESSAGE_TYPE_ERROR) {
  183. if (!joined_log_strings.is_empty()) {
  184. strings.push_back(String("\n").join(joined_log_strings));
  185. types.push_back(MESSAGE_TYPE_LOG);
  186. joined_log_strings.clear();
  187. }
  188. strings.push_back(output_string.message);
  189. types.push_back(MESSAGE_TYPE_ERROR);
  190. } else if (output_string.type == MESSAGE_TYPE_LOG_RICH) {
  191. if (!joined_log_strings.is_empty()) {
  192. strings.push_back(String("\n").join(joined_log_strings));
  193. types.push_back(MESSAGE_TYPE_LOG_RICH);
  194. joined_log_strings.clear();
  195. }
  196. strings.push_back(output_string.message);
  197. types.push_back(MESSAGE_TYPE_LOG_RICH);
  198. } else {
  199. joined_log_strings.push_back(output_string.message);
  200. }
  201. }
  202. if (!joined_log_strings.is_empty()) {
  203. strings.push_back(String("\n").join(joined_log_strings));
  204. types.push_back(MESSAGE_TYPE_LOG);
  205. }
  206. Array arr;
  207. arr.push_back(strings);
  208. arr.push_back(types);
  209. _put_msg("output", arr);
  210. output_strings.clear();
  211. }
  212. while (errors.size()) {
  213. ErrorMessage oe = errors.front()->get();
  214. _put_msg("error", oe.serialize());
  215. errors.pop_front();
  216. }
  217. // Update limits
  218. uint64_t ticks = OS::get_singleton()->get_ticks_usec() / 1000;
  219. if (ticks - last_reset > 1000) {
  220. last_reset = ticks;
  221. char_count = 0;
  222. err_count = 0;
  223. n_errors_dropped = 0;
  224. warn_count = 0;
  225. n_warnings_dropped = 0;
  226. }
  227. flushing = false;
  228. }
  229. void RemoteDebugger::send_message(const String &p_message, const Array &p_args) {
  230. MutexLock lock(mutex);
  231. if (is_peer_connected()) {
  232. _put_msg(p_message, p_args);
  233. }
  234. }
  235. 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) {
  236. ErrorMessage oe;
  237. oe.error = p_err;
  238. oe.error_descr = p_descr;
  239. oe.source_file = p_file;
  240. oe.source_line = p_line;
  241. oe.source_func = p_func;
  242. oe.warning = p_type == ERR_HANDLER_WARNING;
  243. uint64_t time = OS::get_singleton()->get_ticks_msec();
  244. oe.hr = time / 3600000;
  245. oe.min = (time / 60000) % 60;
  246. oe.sec = (time / 1000) % 60;
  247. oe.msec = time % 1000;
  248. oe.callstack.append_array(script_debugger->get_error_stack_info());
  249. if (flushing && Thread::get_caller_id() == flush_thread) { // Can't handle recursive errors during flush.
  250. return;
  251. }
  252. MutexLock lock(mutex);
  253. if (oe.warning) {
  254. warn_count++;
  255. } else {
  256. err_count++;
  257. }
  258. if (is_peer_connected()) {
  259. if (oe.warning) {
  260. if (warn_count > max_warnings_per_second) {
  261. n_warnings_dropped++;
  262. if (n_warnings_dropped == 1) {
  263. // Only print one message about dropping per second
  264. ErrorMessage overflow = _create_overflow_error("TOO_MANY_WARNINGS", "Too many warnings! Ignoring warnings for up to 1 second.");
  265. errors.push_back(overflow);
  266. }
  267. } else {
  268. errors.push_back(oe);
  269. }
  270. } else {
  271. if (err_count > max_errors_per_second) {
  272. n_errors_dropped++;
  273. if (n_errors_dropped == 1) {
  274. // Only print one message about dropping per second
  275. ErrorMessage overflow = _create_overflow_error("TOO_MANY_ERRORS", "Too many errors! Ignoring errors for up to 1 second.");
  276. errors.push_back(overflow);
  277. }
  278. } else {
  279. errors.push_back(oe);
  280. }
  281. }
  282. }
  283. }
  284. void RemoteDebugger::_send_stack_vars(List<String> &p_names, List<Variant> &p_vals, int p_type) {
  285. DebuggerMarshalls::ScriptStackVariable stvar;
  286. List<String>::Element *E = p_names.front();
  287. List<Variant>::Element *F = p_vals.front();
  288. while (E) {
  289. stvar.name = E->get();
  290. stvar.value = F->get();
  291. stvar.type = p_type;
  292. send_message("stack_frame_var", stvar.serialize());
  293. E = E->next();
  294. F = F->next();
  295. }
  296. }
  297. Error RemoteDebugger::_try_capture(const String &p_msg, const Array &p_data, bool &r_captured) {
  298. const int idx = p_msg.find_char(':');
  299. r_captured = false;
  300. if (idx < 0) { // No prefix, unknown message.
  301. return OK;
  302. }
  303. const String cap = p_msg.substr(0, idx);
  304. if (!has_capture(cap)) {
  305. return ERR_UNAVAILABLE; // Unknown message...
  306. }
  307. const String msg = p_msg.substr(idx + 1);
  308. return capture_parse(cap, msg, p_data, r_captured);
  309. }
  310. void RemoteDebugger::_poll_messages() {
  311. MutexLock mutex_lock(mutex);
  312. peer->poll();
  313. while (peer->has_message()) {
  314. Array cmd = peer->get_message();
  315. ERR_CONTINUE(cmd.size() != 3);
  316. ERR_CONTINUE(cmd[0].get_type() != Variant::STRING);
  317. ERR_CONTINUE(cmd[1].get_type() != Variant::INT);
  318. ERR_CONTINUE(cmd[2].get_type() != Variant::ARRAY);
  319. Thread::ID thread = cmd[1];
  320. if (!messages.has(thread)) {
  321. continue; // This thread is not around to receive the messages
  322. }
  323. Message msg;
  324. msg.message = cmd[0];
  325. msg.data = cmd[2];
  326. messages[thread].push_back(msg);
  327. }
  328. }
  329. bool RemoteDebugger::_has_messages() {
  330. MutexLock mutex_lock(mutex);
  331. return messages.has(Thread::get_caller_id()) && !messages[Thread::get_caller_id()].is_empty();
  332. }
  333. Array RemoteDebugger::_get_message() {
  334. MutexLock mutex_lock(mutex);
  335. ERR_FAIL_COND_V(!messages.has(Thread::get_caller_id()), Array());
  336. List<Message> &message_list = messages[Thread::get_caller_id()];
  337. ERR_FAIL_COND_V(message_list.is_empty(), Array());
  338. Array msg;
  339. msg.resize(2);
  340. msg[0] = message_list.front()->get().message;
  341. msg[1] = message_list.front()->get().data;
  342. message_list.pop_front();
  343. return msg;
  344. }
  345. void RemoteDebugger::debug(bool p_can_continue, bool p_is_error_breakpoint) {
  346. //this function is called when there is a debugger break (bug on script)
  347. //or when execution is paused from editor
  348. {
  349. MutexLock lock(mutex);
  350. // Tests that require mutex.
  351. if (script_debugger->is_skipping_breakpoints() && !p_is_error_breakpoint) {
  352. return;
  353. }
  354. ERR_FAIL_COND_MSG(!is_peer_connected(), "Script Debugger failed to connect, but being used anyway.");
  355. if (!peer->can_block()) {
  356. return; // Peer does not support blocking IO. We could at least send the error though.
  357. }
  358. }
  359. ScriptLanguage *script_lang = script_debugger->get_break_language();
  360. const String error_str = script_lang ? script_lang->debug_get_error() : "";
  361. Array msg;
  362. msg.push_back(p_can_continue);
  363. msg.push_back(error_str);
  364. ERR_FAIL_NULL(script_lang);
  365. msg.push_back(script_lang->debug_get_stack_level_count() > 0);
  366. msg.push_back(Thread::get_caller_id() == Thread::get_main_id() ? String(RTR("Main Thread")) : itos(Thread::get_caller_id()));
  367. if (allow_focus_steal_fn) {
  368. allow_focus_steal_fn();
  369. }
  370. send_message("debug_enter", msg);
  371. Input::MouseMode mouse_mode = Input::MOUSE_MODE_VISIBLE;
  372. if (Thread::get_caller_id() == Thread::get_main_id()) {
  373. mouse_mode = Input::get_singleton()->get_mouse_mode();
  374. if (mouse_mode != Input::MOUSE_MODE_VISIBLE) {
  375. Input::get_singleton()->set_mouse_mode(Input::MOUSE_MODE_VISIBLE);
  376. }
  377. } else {
  378. MutexLock mutex_lock(mutex);
  379. messages.insert(Thread::get_caller_id(), List<Message>());
  380. }
  381. while (is_peer_connected()) {
  382. flush_output();
  383. _poll_messages();
  384. if (_has_messages()) {
  385. Array cmd = _get_message();
  386. ERR_CONTINUE(cmd.size() != 2);
  387. ERR_CONTINUE(cmd[0].get_type() != Variant::STRING);
  388. ERR_CONTINUE(cmd[1].get_type() != Variant::ARRAY);
  389. String command = cmd[0];
  390. Array data = cmd[1];
  391. if (command == "step") {
  392. script_debugger->set_depth(-1);
  393. script_debugger->set_lines_left(1);
  394. break;
  395. } else if (command == "next") {
  396. script_debugger->set_depth(0);
  397. script_debugger->set_lines_left(1);
  398. break;
  399. } else if (command == "continue") {
  400. script_debugger->set_depth(-1);
  401. script_debugger->set_lines_left(-1);
  402. break;
  403. } else if (command == "break") {
  404. ERR_PRINT("Got break when already broke!");
  405. break;
  406. } else if (command == "get_stack_dump") {
  407. DebuggerMarshalls::ScriptStackDump dump;
  408. int slc = script_lang->debug_get_stack_level_count();
  409. for (int i = 0; i < slc; i++) {
  410. ScriptLanguage::StackInfo frame;
  411. frame.file = script_lang->debug_get_stack_level_source(i);
  412. frame.line = script_lang->debug_get_stack_level_line(i);
  413. frame.func = script_lang->debug_get_stack_level_function(i);
  414. dump.frames.push_back(frame);
  415. }
  416. send_message("stack_dump", dump.serialize());
  417. } else if (command == "get_stack_frame_vars") {
  418. ERR_FAIL_COND(data.size() != 1);
  419. ERR_FAIL_NULL(script_lang);
  420. int lv = data[0];
  421. List<String> members;
  422. List<Variant> member_vals;
  423. if (ScriptInstance *inst = script_lang->debug_get_stack_level_instance(lv)) {
  424. members.push_back("self");
  425. member_vals.push_back(inst->get_owner());
  426. }
  427. script_lang->debug_get_stack_level_members(lv, &members, &member_vals);
  428. ERR_FAIL_COND(members.size() != member_vals.size());
  429. List<String> locals;
  430. List<Variant> local_vals;
  431. script_lang->debug_get_stack_level_locals(lv, &locals, &local_vals);
  432. ERR_FAIL_COND(locals.size() != local_vals.size());
  433. List<String> globals;
  434. List<Variant> globals_vals;
  435. script_lang->debug_get_globals(&globals, &globals_vals);
  436. ERR_FAIL_COND(globals.size() != globals_vals.size());
  437. Array var_size;
  438. var_size.push_back(local_vals.size() + member_vals.size() + globals_vals.size());
  439. send_message("stack_frame_vars", var_size);
  440. _send_stack_vars(locals, local_vals, 0);
  441. _send_stack_vars(members, member_vals, 1);
  442. _send_stack_vars(globals, globals_vals, 2);
  443. } else if (command == "reload_scripts") {
  444. script_paths_to_reload = data;
  445. } else if (command == "reload_all_scripts") {
  446. reload_all_scripts = true;
  447. } else if (command == "breakpoint") {
  448. ERR_FAIL_COND(data.size() < 3);
  449. bool set = data[2];
  450. if (set) {
  451. script_debugger->insert_breakpoint(data[1], data[0]);
  452. } else {
  453. script_debugger->remove_breakpoint(data[1], data[0]);
  454. }
  455. } else if (command == "set_skip_breakpoints") {
  456. ERR_FAIL_COND(data.is_empty());
  457. script_debugger->set_skip_breakpoints(data[0]);
  458. } else if (command == "evaluate") {
  459. String expression_str = data[0];
  460. int frame = data[1];
  461. ScriptInstance *breaked_instance = script_debugger->get_break_language()->debug_get_stack_level_instance(frame);
  462. if (!breaked_instance) {
  463. break;
  464. }
  465. List<String> locals;
  466. List<Variant> local_vals;
  467. script_debugger->get_break_language()->debug_get_stack_level_locals(frame, &locals, &local_vals);
  468. ERR_FAIL_COND(locals.size() != local_vals.size());
  469. PackedStringArray locals_vector;
  470. for (const String &S : locals) {
  471. locals_vector.append(S);
  472. }
  473. Array local_vals_array;
  474. for (const Variant &V : local_vals) {
  475. local_vals_array.append(V);
  476. }
  477. Expression expression;
  478. expression.parse(expression_str, locals_vector);
  479. const Variant return_val = expression.execute(local_vals_array, breaked_instance->get_owner());
  480. DebuggerMarshalls::ScriptStackVariable stvar;
  481. stvar.name = expression_str;
  482. stvar.value = return_val;
  483. stvar.type = 3;
  484. send_message("evaluation_return", stvar.serialize());
  485. } else {
  486. bool captured = false;
  487. ERR_CONTINUE(_try_capture(command, data, captured) != OK);
  488. if (!captured) {
  489. WARN_PRINT(vformat("Unknown message received from debugger: %s.", command));
  490. }
  491. }
  492. } else {
  493. OS::get_singleton()->delay_usec(10000);
  494. if (Thread::get_caller_id() == Thread::get_main_id()) {
  495. // If this is a busy loop on the main thread, events still need to be processed.
  496. DisplayServer::get_singleton()->force_process_and_drop_events();
  497. }
  498. }
  499. }
  500. send_message("debug_exit", Array());
  501. if (Thread::get_caller_id() == Thread::get_main_id()) {
  502. if (mouse_mode != Input::MOUSE_MODE_VISIBLE) {
  503. Input::get_singleton()->set_mouse_mode(mouse_mode);
  504. }
  505. } else {
  506. MutexLock mutex_lock(mutex);
  507. messages.erase(Thread::get_caller_id());
  508. }
  509. }
  510. void RemoteDebugger::poll_events(bool p_is_idle) {
  511. if (peer.is_null()) {
  512. return;
  513. }
  514. flush_output();
  515. _poll_messages();
  516. while (_has_messages()) {
  517. Array arr = _get_message();
  518. ERR_CONTINUE(arr.size() != 2);
  519. ERR_CONTINUE(arr[0].get_type() != Variant::STRING);
  520. ERR_CONTINUE(arr[1].get_type() != Variant::ARRAY);
  521. const String cmd = arr[0];
  522. const int idx = cmd.find_char(':');
  523. bool parsed = false;
  524. if (idx < 0) { // Not prefix, use scripts capture.
  525. capture_parse("core", cmd, arr[1], parsed);
  526. continue;
  527. }
  528. const String cap = cmd.substr(0, idx);
  529. if (!has_capture(cap)) {
  530. continue; // Unknown message...
  531. }
  532. const String msg = cmd.substr(idx + 1);
  533. capture_parse(cap, msg, arr[1], parsed);
  534. }
  535. // Reload scripts during idle poll only.
  536. if (p_is_idle) {
  537. if (reload_all_scripts) {
  538. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  539. ScriptServer::get_language(i)->reload_all_scripts();
  540. }
  541. reload_all_scripts = false;
  542. } else if (!script_paths_to_reload.is_empty()) {
  543. Array scripts_to_reload;
  544. for (int i = 0; i < script_paths_to_reload.size(); ++i) {
  545. String path = script_paths_to_reload[i];
  546. Error err = OK;
  547. Ref<Script> script = ResourceLoader::load(path, "", ResourceFormatLoader::CACHE_MODE_REUSE, &err);
  548. ERR_CONTINUE_MSG(err != OK, vformat("Could not reload script '%s': %s", path, error_names[err]));
  549. ERR_CONTINUE_MSG(script.is_null(), vformat("Could not reload script '%s': Not a script!", path, error_names[err]));
  550. scripts_to_reload.push_back(script);
  551. }
  552. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  553. ScriptServer::get_language(i)->reload_scripts(scripts_to_reload, true);
  554. }
  555. }
  556. script_paths_to_reload.clear();
  557. }
  558. }
  559. Error RemoteDebugger::_core_capture(const String &p_cmd, const Array &p_data, bool &r_captured) {
  560. r_captured = true;
  561. if (p_cmd == "reload_scripts") {
  562. script_paths_to_reload = p_data;
  563. } else if (p_cmd == "reload_all_scripts") {
  564. reload_all_scripts = true;
  565. } else if (p_cmd == "breakpoint") {
  566. ERR_FAIL_COND_V(p_data.size() < 3, ERR_INVALID_DATA);
  567. bool set = p_data[2];
  568. if (set) {
  569. script_debugger->insert_breakpoint(p_data[1], p_data[0]);
  570. } else {
  571. script_debugger->remove_breakpoint(p_data[1], p_data[0]);
  572. }
  573. } else if (p_cmd == "set_skip_breakpoints") {
  574. ERR_FAIL_COND_V(p_data.is_empty(), ERR_INVALID_DATA);
  575. script_debugger->set_skip_breakpoints(p_data[0]);
  576. } else if (p_cmd == "break") {
  577. script_debugger->debug(script_debugger->get_break_language());
  578. } else {
  579. r_captured = false;
  580. }
  581. return OK;
  582. }
  583. Error RemoteDebugger::_profiler_capture(const String &p_cmd, const Array &p_data, bool &r_captured) {
  584. r_captured = false;
  585. ERR_FAIL_COND_V(p_data.is_empty(), ERR_INVALID_DATA);
  586. ERR_FAIL_COND_V(p_data[0].get_type() != Variant::BOOL, ERR_INVALID_DATA);
  587. ERR_FAIL_COND_V(!has_profiler(p_cmd), ERR_UNAVAILABLE);
  588. Array opts;
  589. if (p_data.size() > 1) { // Optional profiler parameters.
  590. ERR_FAIL_COND_V(p_data[1].get_type() != Variant::ARRAY, ERR_INVALID_DATA);
  591. opts = p_data[1];
  592. }
  593. r_captured = true;
  594. profiler_enable(p_cmd, p_data[0], opts);
  595. return OK;
  596. }
  597. RemoteDebugger::RemoteDebugger(Ref<RemoteDebuggerPeer> p_peer) {
  598. peer = p_peer;
  599. max_chars_per_second = GLOBAL_GET("network/limits/debugger/max_chars_per_second");
  600. max_errors_per_second = GLOBAL_GET("network/limits/debugger/max_errors_per_second");
  601. max_warnings_per_second = GLOBAL_GET("network/limits/debugger/max_warnings_per_second");
  602. // Performance Profiler
  603. Object *perf = Engine::get_singleton()->get_singleton_object("Performance");
  604. if (perf) {
  605. performance_profiler.instantiate(perf);
  606. performance_profiler->bind("performance");
  607. profiler_enable("performance", true);
  608. }
  609. // Core and profiler captures.
  610. Capture core_cap(this,
  611. [](void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
  612. return static_cast<RemoteDebugger *>(p_user)->_core_capture(p_cmd, p_data, r_captured);
  613. });
  614. register_message_capture("core", core_cap);
  615. Capture profiler_cap(this,
  616. [](void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
  617. return static_cast<RemoteDebugger *>(p_user)->_profiler_capture(p_cmd, p_data, r_captured);
  618. });
  619. register_message_capture("profiler", profiler_cap);
  620. // Error handlers
  621. phl.printfunc = _print_handler;
  622. phl.userdata = this;
  623. add_print_handler(&phl);
  624. eh.errfunc = _err_handler;
  625. eh.userdata = this;
  626. add_error_handler(&eh);
  627. messages.insert(Thread::get_main_id(), List<Message>());
  628. }
  629. RemoteDebugger::~RemoteDebugger() {
  630. remove_print_handler(&phl);
  631. remove_error_handler(&eh);
  632. }