remote_debugger.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793
  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/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) override {}
  48. void add(const Array &p_data) override {}
  49. void tick(double p_frame_time, double p_process_time, double p_physics_time, double p_physics_frame_time) override {
  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. Array custom_monitor_types = performance->call("get_custom_monitor_types");
  60. Array custom_monitor_data;
  61. custom_monitor_data.push_back(custom_monitor_names);
  62. custom_monitor_data.push_back(custom_monitor_types);
  63. uint64_t monitor_modification_time = performance->call("get_monitor_modification_time");
  64. if (monitor_modification_time > last_monitor_modification_time) {
  65. last_monitor_modification_time = monitor_modification_time;
  66. EngineDebugger::get_singleton()->send_message("performance:profile_names", custom_monitor_data);
  67. }
  68. int max = performance->get("MONITOR_MAX");
  69. Array arr;
  70. arr.resize(max + custom_monitor_names.size());
  71. for (int i = 0; i < max; i++) {
  72. arr[i] = performance->call("get_monitor", i);
  73. }
  74. for (int i = 0; i < custom_monitor_names.size(); i++) {
  75. Variant monitor_value = performance->call("get_custom_monitor", custom_monitor_names[i]);
  76. if (!monitor_value.is_num()) {
  77. ERR_PRINT(vformat("Value of custom monitor '%s' is not a number.", String(custom_monitor_names[i])));
  78. arr[i + max] = Variant();
  79. } else {
  80. arr[i + max] = monitor_value;
  81. }
  82. }
  83. EngineDebugger::get_singleton()->send_message("performance:profile_frame", arr);
  84. }
  85. explicit PerformanceProfiler(Object *p_performance) {
  86. performance = p_performance;
  87. }
  88. };
  89. Error RemoteDebugger::_put_msg(const String &p_message, const Array &p_data) {
  90. Array msg = { p_message, Thread::get_caller_id(), p_data };
  91. Error err = peer->put_message(msg);
  92. if (err != OK) {
  93. n_messages_dropped++;
  94. }
  95. return err;
  96. }
  97. 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) {
  98. RemoteDebugger *rd = static_cast<RemoteDebugger *>(p_this);
  99. if (rd->flushing && Thread::get_caller_id() == rd->flush_thread) { // Can't handle recursive errors during flush.
  100. return;
  101. }
  102. Vector<ScriptLanguage::StackInfo> si;
  103. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  104. si = ScriptServer::get_language(i)->debug_get_current_stack_info();
  105. if (si.size()) {
  106. break;
  107. }
  108. }
  109. // send_error will lock internally.
  110. 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);
  111. }
  112. void RemoteDebugger::_print_handler(void *p_this, const String &p_string, bool p_error, bool p_rich) {
  113. RemoteDebugger *rd = static_cast<RemoteDebugger *>(p_this);
  114. if (rd->flushing && Thread::get_caller_id() == rd->flush_thread) { // Can't handle recursive prints during flush.
  115. return;
  116. }
  117. String s = p_string;
  118. int allowed_chars = MIN(MAX(rd->max_chars_per_second - rd->char_count, 0), s.length());
  119. if (allowed_chars == 0 && s.length() > 0) {
  120. return;
  121. }
  122. if (allowed_chars < s.length()) {
  123. s = s.substr(0, allowed_chars);
  124. }
  125. MutexLock lock(rd->mutex);
  126. rd->char_count += allowed_chars;
  127. bool overflowed = rd->char_count >= rd->max_chars_per_second;
  128. if (rd->is_peer_connected()) {
  129. if (overflowed) {
  130. s += "[...]";
  131. }
  132. OutputString output_string;
  133. output_string.message = s;
  134. if (p_error) {
  135. output_string.type = MESSAGE_TYPE_ERROR;
  136. } else if (p_rich) {
  137. output_string.type = MESSAGE_TYPE_LOG_RICH;
  138. } else {
  139. output_string.type = MESSAGE_TYPE_LOG;
  140. }
  141. rd->output_strings.push_back(output_string);
  142. if (overflowed) {
  143. output_string.message = "[output overflow, print less text!]";
  144. output_string.type = MESSAGE_TYPE_ERROR;
  145. rd->output_strings.push_back(output_string);
  146. }
  147. }
  148. }
  149. RemoteDebugger::ErrorMessage RemoteDebugger::_create_overflow_error(const String &p_what, const String &p_descr) {
  150. ErrorMessage oe;
  151. oe.error = p_what;
  152. oe.error_descr = p_descr;
  153. oe.warning = false;
  154. uint64_t time = OS::get_singleton()->get_ticks_msec();
  155. oe.hr = time / 3600000;
  156. oe.min = (time / 60000) % 60;
  157. oe.sec = (time / 1000) % 60;
  158. oe.msec = time % 1000;
  159. return oe;
  160. }
  161. void RemoteDebugger::flush_output() {
  162. MutexLock lock(mutex);
  163. flush_thread = Thread::get_caller_id();
  164. flushing = true;
  165. if (!is_peer_connected()) {
  166. return;
  167. }
  168. if (n_messages_dropped > 0) {
  169. 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.");
  170. if (_put_msg("error", err_msg.serialize()) == OK) {
  171. n_messages_dropped = 0;
  172. }
  173. }
  174. if (output_strings.size()) {
  175. // Join output strings so we generate less messages.
  176. Vector<String> joined_log_strings;
  177. Vector<String> strings;
  178. Vector<int> types;
  179. for (const OutputString &output_string : output_strings) {
  180. if (output_string.type == MESSAGE_TYPE_ERROR) {
  181. if (!joined_log_strings.is_empty()) {
  182. strings.push_back(String("\n").join(joined_log_strings));
  183. types.push_back(MESSAGE_TYPE_LOG);
  184. joined_log_strings.clear();
  185. }
  186. strings.push_back(output_string.message);
  187. types.push_back(MESSAGE_TYPE_ERROR);
  188. } else if (output_string.type == MESSAGE_TYPE_LOG_RICH) {
  189. if (!joined_log_strings.is_empty()) {
  190. strings.push_back(String("\n").join(joined_log_strings));
  191. types.push_back(MESSAGE_TYPE_LOG_RICH);
  192. joined_log_strings.clear();
  193. }
  194. strings.push_back(output_string.message);
  195. types.push_back(MESSAGE_TYPE_LOG_RICH);
  196. } else {
  197. joined_log_strings.push_back(output_string.message);
  198. }
  199. }
  200. if (!joined_log_strings.is_empty()) {
  201. strings.push_back(String("\n").join(joined_log_strings));
  202. types.push_back(MESSAGE_TYPE_LOG);
  203. }
  204. Array arr = { strings, types };
  205. _put_msg("output", arr);
  206. output_strings.clear();
  207. }
  208. while (errors.size()) {
  209. ErrorMessage oe = errors.front()->get();
  210. _put_msg("error", oe.serialize());
  211. errors.pop_front();
  212. }
  213. // Update limits
  214. uint64_t ticks = OS::get_singleton()->get_ticks_usec() / 1000;
  215. if (ticks - last_reset > 1000) {
  216. last_reset = ticks;
  217. char_count = 0;
  218. err_count = 0;
  219. n_errors_dropped = 0;
  220. warn_count = 0;
  221. n_warnings_dropped = 0;
  222. }
  223. flushing = false;
  224. }
  225. void RemoteDebugger::send_message(const String &p_message, const Array &p_args) {
  226. MutexLock lock(mutex);
  227. if (is_peer_connected()) {
  228. _put_msg(p_message, p_args);
  229. }
  230. }
  231. 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) {
  232. ErrorMessage oe;
  233. oe.error = p_err;
  234. oe.error_descr = p_descr;
  235. oe.source_file = p_file;
  236. oe.source_line = p_line;
  237. oe.source_func = p_func;
  238. oe.warning = p_type == ERR_HANDLER_WARNING;
  239. uint64_t time = OS::get_singleton()->get_ticks_msec();
  240. oe.hr = time / 3600000;
  241. oe.min = (time / 60000) % 60;
  242. oe.sec = (time / 1000) % 60;
  243. oe.msec = time % 1000;
  244. oe.callstack.append_array(script_debugger->get_error_stack_info());
  245. if (flushing && Thread::get_caller_id() == flush_thread) { // Can't handle recursive errors during flush.
  246. return;
  247. }
  248. MutexLock lock(mutex);
  249. if (oe.warning) {
  250. warn_count++;
  251. } else {
  252. err_count++;
  253. }
  254. if (is_peer_connected()) {
  255. if (oe.warning) {
  256. if (warn_count > max_warnings_per_second) {
  257. n_warnings_dropped++;
  258. if (n_warnings_dropped == 1) {
  259. // Only print one message about dropping per second
  260. ErrorMessage overflow = _create_overflow_error("TOO_MANY_WARNINGS", "Too many warnings! Ignoring warnings for up to 1 second.");
  261. errors.push_back(overflow);
  262. }
  263. } else {
  264. errors.push_back(oe);
  265. }
  266. } else {
  267. if (err_count > max_errors_per_second) {
  268. n_errors_dropped++;
  269. if (n_errors_dropped == 1) {
  270. // Only print one message about dropping per second
  271. ErrorMessage overflow = _create_overflow_error("TOO_MANY_ERRORS", "Too many errors! Ignoring errors for up to 1 second.");
  272. errors.push_back(overflow);
  273. }
  274. } else {
  275. errors.push_back(oe);
  276. }
  277. }
  278. }
  279. }
  280. void RemoteDebugger::_send_stack_vars(List<String> &p_names, List<Variant> &p_vals, int p_type) {
  281. DebuggerMarshalls::ScriptStackVariable stvar;
  282. List<String>::Element *E = p_names.front();
  283. List<Variant>::Element *F = p_vals.front();
  284. while (E) {
  285. stvar.name = E->get();
  286. stvar.value = F->get();
  287. stvar.type = p_type;
  288. send_message("stack_frame_var", stvar.serialize());
  289. E = E->next();
  290. F = F->next();
  291. }
  292. }
  293. Error RemoteDebugger::_try_capture(const String &p_msg, const Array &p_data, bool &r_captured) {
  294. const int idx = p_msg.find_char(':');
  295. r_captured = false;
  296. if (idx < 0) { // No prefix, unknown message.
  297. return OK;
  298. }
  299. const String cap = p_msg.substr(0, idx);
  300. if (!has_capture(cap)) {
  301. return ERR_UNAVAILABLE; // Unknown message...
  302. }
  303. const String msg = p_msg.substr(idx + 1);
  304. return capture_parse(cap, msg, p_data, r_captured);
  305. }
  306. void RemoteDebugger::_poll_messages() {
  307. MutexLock mutex_lock(mutex);
  308. peer->poll();
  309. while (peer->has_message()) {
  310. Array cmd = peer->get_message();
  311. ERR_CONTINUE(cmd.size() != 3);
  312. ERR_CONTINUE(cmd[0].get_type() != Variant::STRING);
  313. ERR_CONTINUE(cmd[1].get_type() != Variant::INT);
  314. ERR_CONTINUE(cmd[2].get_type() != Variant::ARRAY);
  315. Thread::ID thread = cmd[1];
  316. if (!messages.has(thread)) {
  317. continue; // This thread is not around to receive the messages
  318. }
  319. Message msg;
  320. msg.message = cmd[0];
  321. msg.data = cmd[2];
  322. messages[thread].push_back(msg);
  323. }
  324. }
  325. bool RemoteDebugger::_has_messages() {
  326. MutexLock mutex_lock(mutex);
  327. return messages.has(Thread::get_caller_id()) && !messages[Thread::get_caller_id()].is_empty();
  328. }
  329. Array RemoteDebugger::_get_message() {
  330. MutexLock mutex_lock(mutex);
  331. ERR_FAIL_COND_V(!messages.has(Thread::get_caller_id()), Array());
  332. List<Message> &message_list = messages[Thread::get_caller_id()];
  333. ERR_FAIL_COND_V(message_list.is_empty(), Array());
  334. Array msg;
  335. msg.resize(2);
  336. msg[0] = message_list.front()->get().message;
  337. msg[1] = message_list.front()->get().data;
  338. message_list.pop_front();
  339. return msg;
  340. }
  341. void RemoteDebugger::debug(bool p_can_continue, bool p_is_error_breakpoint) {
  342. //this function is called when there is a debugger break (bug on script)
  343. //or when execution is paused from editor
  344. {
  345. MutexLock lock(mutex);
  346. // Tests that require mutex.
  347. if (script_debugger->is_skipping_breakpoints() && !p_is_error_breakpoint) {
  348. return;
  349. }
  350. ERR_FAIL_COND_MSG(!is_peer_connected(), "Script Debugger failed to connect, but being used anyway.");
  351. if (!peer->can_block()) {
  352. return; // Peer does not support blocking IO. We could at least send the error though.
  353. }
  354. }
  355. if (p_is_error_breakpoint && script_debugger->is_ignoring_error_breaks()) {
  356. return;
  357. }
  358. ScriptLanguage *script_lang = script_debugger->get_break_language();
  359. Array msg = {
  360. p_can_continue,
  361. script_lang ? script_lang->debug_get_error() : String(),
  362. script_lang && (script_lang->debug_get_stack_level_count() > 0),
  363. Thread::get_caller_id()
  364. };
  365. if (allow_focus_steal_fn) {
  366. allow_focus_steal_fn();
  367. }
  368. send_message("debug_enter", msg);
  369. Input::MouseMode mouse_mode = Input::MOUSE_MODE_VISIBLE;
  370. if (Thread::get_caller_id() == Thread::get_main_id()) {
  371. mouse_mode = Input::get_singleton()->get_mouse_mode();
  372. if (mouse_mode != Input::MOUSE_MODE_VISIBLE) {
  373. Input::get_singleton()->set_mouse_mode(Input::MOUSE_MODE_VISIBLE);
  374. }
  375. } else {
  376. MutexLock mutex_lock(mutex);
  377. messages.insert(Thread::get_caller_id(), List<Message>());
  378. }
  379. while (is_peer_connected()) {
  380. flush_output();
  381. _poll_messages();
  382. if (_has_messages()) {
  383. Array cmd = _get_message();
  384. ERR_CONTINUE(cmd.size() != 2);
  385. ERR_CONTINUE(cmd[0].get_type() != Variant::STRING);
  386. ERR_CONTINUE(cmd[1].get_type() != Variant::ARRAY);
  387. String command = cmd[0];
  388. Array data = cmd[1];
  389. if (command == "step") {
  390. script_debugger->set_depth(-1);
  391. script_debugger->set_lines_left(1);
  392. break;
  393. } else if (command == "next") {
  394. script_debugger->set_depth(0);
  395. script_debugger->set_lines_left(1);
  396. break;
  397. } else if (command == "out") {
  398. script_debugger->set_depth(1);
  399. script_debugger->set_lines_left(1);
  400. break;
  401. } else if (command == "continue") {
  402. script_debugger->set_depth(-1);
  403. script_debugger->set_lines_left(-1);
  404. break;
  405. } else if (command == "break") {
  406. ERR_PRINT("Got break when already broke!");
  407. break;
  408. } else if (command == "get_stack_dump") {
  409. DebuggerMarshalls::ScriptStackDump dump;
  410. if (script_lang) {
  411. int slc = script_lang->debug_get_stack_level_count();
  412. for (int i = 0; i < slc; i++) {
  413. ScriptLanguage::StackInfo frame;
  414. frame.file = script_lang->debug_get_stack_level_source(i);
  415. frame.line = script_lang->debug_get_stack_level_line(i);
  416. frame.func = script_lang->debug_get_stack_level_function(i);
  417. dump.frames.push_back(frame);
  418. }
  419. }
  420. send_message("stack_dump", dump.serialize());
  421. } else if (command == "get_stack_frame_vars") {
  422. ERR_FAIL_COND(data.size() != 1);
  423. if (!script_lang) {
  424. send_message("stack_frame_vars", Array{ 0 });
  425. continue;
  426. }
  427. int lv = data[0];
  428. List<String> members;
  429. List<Variant> member_vals;
  430. if (ScriptInstance *inst = script_lang->debug_get_stack_level_instance(lv)) {
  431. members.push_back("self");
  432. member_vals.push_back(inst->get_owner());
  433. }
  434. script_lang->debug_get_stack_level_members(lv, &members, &member_vals);
  435. ERR_FAIL_COND(members.size() != member_vals.size());
  436. List<String> locals;
  437. List<Variant> local_vals;
  438. script_lang->debug_get_stack_level_locals(lv, &locals, &local_vals);
  439. ERR_FAIL_COND(locals.size() != local_vals.size());
  440. List<String> globals;
  441. List<Variant> globals_vals;
  442. script_lang->debug_get_globals(&globals, &globals_vals);
  443. ERR_FAIL_COND(globals.size() != globals_vals.size());
  444. Array var_size = { local_vals.size() + member_vals.size() + globals_vals.size() };
  445. send_message("stack_frame_vars", var_size);
  446. _send_stack_vars(locals, local_vals, 0);
  447. _send_stack_vars(members, member_vals, 1);
  448. _send_stack_vars(globals, globals_vals, 2);
  449. } else if (command == "reload_scripts") {
  450. script_paths_to_reload = data;
  451. } else if (command == "reload_all_scripts") {
  452. reload_all_scripts = true;
  453. } else if (command == "breakpoint") {
  454. ERR_FAIL_COND(data.size() < 3);
  455. bool set = data[2];
  456. if (set) {
  457. script_debugger->insert_breakpoint(data[1], data[0]);
  458. } else {
  459. script_debugger->remove_breakpoint(data[1], data[0]);
  460. }
  461. } else if (command == "set_skip_breakpoints") {
  462. ERR_FAIL_COND(data.is_empty());
  463. script_debugger->set_skip_breakpoints(data[0]);
  464. } else if (command == "set_ignore_error_breaks") {
  465. ERR_FAIL_COND(data.is_empty());
  466. script_debugger->set_ignore_error_breaks(data[0]);
  467. } else if (command == "evaluate") {
  468. String expression_str = data[0];
  469. int frame = data[1];
  470. ScriptInstance *breaked_instance = script_debugger->get_break_language()->debug_get_stack_level_instance(frame);
  471. if (!breaked_instance) {
  472. break;
  473. }
  474. PackedStringArray input_names;
  475. Array input_vals;
  476. List<String> locals;
  477. List<Variant> local_vals;
  478. script_debugger->get_break_language()->debug_get_stack_level_locals(frame, &locals, &local_vals);
  479. ERR_FAIL_COND(locals.size() != local_vals.size());
  480. for (const String &S : locals) {
  481. input_names.append(S);
  482. }
  483. for (const Variant &V : local_vals) {
  484. input_vals.append(V);
  485. }
  486. List<String> globals;
  487. List<Variant> globals_vals;
  488. script_debugger->get_break_language()->debug_get_globals(&globals, &globals_vals);
  489. ERR_FAIL_COND(globals.size() != globals_vals.size());
  490. for (const String &S : globals) {
  491. input_names.append(S);
  492. }
  493. for (const Variant &V : globals_vals) {
  494. input_vals.append(V);
  495. }
  496. LocalVector<StringName> native_types;
  497. ClassDB::get_class_list(native_types);
  498. for (const StringName &class_name : native_types) {
  499. if (!ClassDB::is_class_exposed(class_name) || !Engine::get_singleton()->has_singleton(class_name) || Engine::get_singleton()->is_singleton_editor_only(class_name)) {
  500. continue;
  501. }
  502. input_names.append(class_name);
  503. input_vals.append(Engine::get_singleton()->get_singleton_object(class_name));
  504. }
  505. LocalVector<StringName> user_types;
  506. ScriptServer::get_global_class_list(user_types);
  507. for (const StringName &class_name : user_types) {
  508. String scr_path = ScriptServer::get_global_class_path(class_name);
  509. Ref<Script> scr = ResourceLoader::load(scr_path, "Script");
  510. ERR_CONTINUE_MSG(scr.is_null(), vformat(R"(Could not load the global class %s from resource path: "%s".)", class_name, scr_path));
  511. input_names.append(class_name);
  512. input_vals.append(scr);
  513. }
  514. Expression expression;
  515. expression.parse(expression_str, input_names);
  516. const Variant return_val = expression.execute(input_vals, breaked_instance->get_owner());
  517. DebuggerMarshalls::ScriptStackVariable stvar;
  518. stvar.name = expression_str;
  519. stvar.value = return_val;
  520. stvar.type = 3;
  521. send_message("evaluation_return", stvar.serialize());
  522. } else {
  523. bool captured = false;
  524. ERR_CONTINUE(_try_capture(command, data, captured) != OK);
  525. if (!captured) {
  526. WARN_PRINT(vformat("Unknown message received from debugger: %s.", command));
  527. }
  528. }
  529. } else {
  530. OS::get_singleton()->delay_usec(10000);
  531. if (Thread::get_caller_id() == Thread::get_main_id()) {
  532. // If this is a busy loop on the main thread, events still need to be processed.
  533. DisplayServer::get_singleton()->force_process_and_drop_events();
  534. }
  535. }
  536. }
  537. send_message("debug_exit", Array());
  538. if (Thread::get_caller_id() == Thread::get_main_id()) {
  539. if (mouse_mode != Input::MOUSE_MODE_VISIBLE) {
  540. Input::get_singleton()->set_mouse_mode(mouse_mode);
  541. }
  542. } else {
  543. MutexLock mutex_lock(mutex);
  544. messages.erase(Thread::get_caller_id());
  545. }
  546. }
  547. void RemoteDebugger::poll_events(bool p_is_idle) {
  548. if (peer.is_null()) {
  549. return;
  550. }
  551. flush_output();
  552. _poll_messages();
  553. while (_has_messages()) {
  554. Array arr = _get_message();
  555. ERR_CONTINUE(arr.size() != 2);
  556. ERR_CONTINUE(arr[0].get_type() != Variant::STRING);
  557. ERR_CONTINUE(arr[1].get_type() != Variant::ARRAY);
  558. const String cmd = arr[0];
  559. const int idx = cmd.find_char(':');
  560. bool parsed = false;
  561. if (idx < 0) { // Not prefix, use scripts capture.
  562. capture_parse("core", cmd, arr[1], parsed);
  563. continue;
  564. }
  565. const String cap = cmd.substr(0, idx);
  566. if (!has_capture(cap)) {
  567. continue; // Unknown message...
  568. }
  569. const String msg = cmd.substr(idx + 1);
  570. capture_parse(cap, msg, arr[1], parsed);
  571. }
  572. // Reload scripts during idle poll only.
  573. if (p_is_idle) {
  574. if (reload_all_scripts) {
  575. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  576. ScriptServer::get_language(i)->reload_all_scripts();
  577. }
  578. reload_all_scripts = false;
  579. } else if (!script_paths_to_reload.is_empty()) {
  580. Array scripts_to_reload;
  581. for (const Variant &v : script_paths_to_reload) {
  582. const String &path = v;
  583. Error err = OK;
  584. Ref<Script> script = ResourceCache::get_ref(path);
  585. if (script.is_null()) {
  586. if (path.is_resource_file()) {
  587. script = ResourceLoader::load(path, "", ResourceFormatLoader::CACHE_MODE_REUSE, &err);
  588. } else {
  589. // Built-in script that isn't in ResourceCache, no need to reload.
  590. continue;
  591. }
  592. }
  593. ERR_CONTINUE_MSG(err != OK, vformat("Could not reload script '%s': %s", path, error_names[err]));
  594. ERR_CONTINUE_MSG(script.is_null(), vformat("Could not reload script '%s': Not a script!", path, error_names[err]));
  595. scripts_to_reload.push_back(script);
  596. }
  597. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  598. ScriptServer::get_language(i)->reload_scripts(scripts_to_reload, true);
  599. }
  600. }
  601. script_paths_to_reload.clear();
  602. }
  603. }
  604. Error RemoteDebugger::_core_capture(const String &p_cmd, const Array &p_data, bool &r_captured) {
  605. r_captured = true;
  606. if (p_cmd == "reload_scripts") {
  607. script_paths_to_reload = p_data;
  608. } else if (p_cmd == "reload_all_scripts") {
  609. reload_all_scripts = true;
  610. } else if (p_cmd == "breakpoint") {
  611. ERR_FAIL_COND_V(p_data.size() < 3, ERR_INVALID_DATA);
  612. bool set = p_data[2];
  613. if (set) {
  614. script_debugger->insert_breakpoint(p_data[1], p_data[0]);
  615. } else {
  616. script_debugger->remove_breakpoint(p_data[1], p_data[0]);
  617. }
  618. } else if (p_cmd == "set_skip_breakpoints") {
  619. ERR_FAIL_COND_V(p_data.is_empty(), ERR_INVALID_DATA);
  620. script_debugger->set_skip_breakpoints(p_data[0]);
  621. } else if (p_cmd == "set_ignore_error_breaks") {
  622. ERR_FAIL_COND_V(p_data.is_empty(), ERR_INVALID_DATA);
  623. script_debugger->set_ignore_error_breaks(p_data[0]);
  624. } else if (p_cmd == "break") {
  625. script_debugger->debug(script_debugger->get_break_language());
  626. } else {
  627. r_captured = false;
  628. }
  629. return OK;
  630. }
  631. Error RemoteDebugger::_profiler_capture(const String &p_cmd, const Array &p_data, bool &r_captured) {
  632. r_captured = false;
  633. ERR_FAIL_COND_V(p_data.is_empty(), ERR_INVALID_DATA);
  634. ERR_FAIL_COND_V(p_data[0].get_type() != Variant::BOOL, ERR_INVALID_DATA);
  635. ERR_FAIL_COND_V(!has_profiler(p_cmd), ERR_UNAVAILABLE);
  636. Array opts;
  637. if (p_data.size() > 1) { // Optional profiler parameters.
  638. ERR_FAIL_COND_V(p_data[1].get_type() != Variant::ARRAY, ERR_INVALID_DATA);
  639. opts = p_data[1];
  640. }
  641. r_captured = true;
  642. profiler_enable(p_cmd, p_data[0], opts);
  643. return OK;
  644. }
  645. RemoteDebugger::RemoteDebugger(Ref<RemoteDebuggerPeer> p_peer) {
  646. peer = p_peer;
  647. max_chars_per_second = GLOBAL_GET("network/limits/debugger/max_chars_per_second");
  648. max_errors_per_second = GLOBAL_GET("network/limits/debugger/max_errors_per_second");
  649. max_warnings_per_second = GLOBAL_GET("network/limits/debugger/max_warnings_per_second");
  650. // Performance Profiler
  651. Object *perf = Engine::get_singleton()->get_singleton_object("Performance");
  652. if (perf) {
  653. performance_profiler.instantiate(perf);
  654. performance_profiler->bind("performance");
  655. profiler_enable("performance", true);
  656. }
  657. // Core and profiler captures.
  658. Capture core_cap(this,
  659. [](void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
  660. return static_cast<RemoteDebugger *>(p_user)->_core_capture(p_cmd, p_data, r_captured);
  661. });
  662. register_message_capture("core", core_cap);
  663. Capture profiler_cap(this,
  664. [](void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
  665. return static_cast<RemoteDebugger *>(p_user)->_profiler_capture(p_cmd, p_data, r_captured);
  666. });
  667. register_message_capture("profiler", profiler_cap);
  668. // Error handlers
  669. phl.printfunc = _print_handler;
  670. phl.userdata = this;
  671. add_print_handler(&phl);
  672. eh.errfunc = _err_handler;
  673. eh.userdata = this;
  674. add_error_handler(&eh);
  675. messages.insert(Thread::get_main_id(), List<Message>());
  676. }
  677. RemoteDebugger::~RemoteDebugger() {
  678. remove_print_handler(&phl);
  679. remove_error_handler(&eh);
  680. }