remote_debugger.cpp 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700
  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/object/script_language.h"
  39. #include "core/os/os.h"
  40. class RemoteDebugger::PerformanceProfiler : public EngineProfiler {
  41. Object *performance = nullptr;
  42. int last_perf_time = 0;
  43. uint64_t last_monitor_modification_time = 0;
  44. public:
  45. void toggle(bool p_enable, const Array &p_opts) {}
  46. void add(const Array &p_data) {}
  47. void tick(double p_frame_time, double p_process_time, double p_physics_time, double p_physics_frame_time) {
  48. if (!performance) {
  49. return;
  50. }
  51. uint64_t pt = OS::get_singleton()->get_ticks_msec();
  52. if (pt - last_perf_time < 1000) {
  53. return;
  54. }
  55. last_perf_time = pt;
  56. Array custom_monitor_names = performance->call("get_custom_monitor_names");
  57. uint64_t monitor_modification_time = performance->call("get_monitor_modification_time");
  58. if (monitor_modification_time > last_monitor_modification_time) {
  59. last_monitor_modification_time = monitor_modification_time;
  60. EngineDebugger::get_singleton()->send_message("performance:profile_names", custom_monitor_names);
  61. }
  62. int max = performance->get("MONITOR_MAX");
  63. Array arr;
  64. arr.resize(max + custom_monitor_names.size());
  65. for (int i = 0; i < max; i++) {
  66. arr[i] = performance->call("get_monitor", i);
  67. }
  68. for (int i = 0; i < custom_monitor_names.size(); i++) {
  69. Variant monitor_value = performance->call("get_custom_monitor", custom_monitor_names[i]);
  70. if (!monitor_value.is_num()) {
  71. ERR_PRINT("Value of custom monitor '" + String(custom_monitor_names[i]) + "' is not a number");
  72. arr[i + max] = Variant();
  73. } else {
  74. arr[i + max] = monitor_value;
  75. }
  76. }
  77. EngineDebugger::get_singleton()->send_message("performance:profile_frame", arr);
  78. }
  79. explicit PerformanceProfiler(Object *p_performance) {
  80. performance = p_performance;
  81. }
  82. };
  83. Error RemoteDebugger::_put_msg(String p_message, Array p_data) {
  84. Array msg;
  85. msg.push_back(p_message);
  86. msg.push_back(Thread::get_caller_id());
  87. msg.push_back(p_data);
  88. Error err = peer->put_message(msg);
  89. if (err != OK) {
  90. n_messages_dropped++;
  91. }
  92. return err;
  93. }
  94. 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) {
  95. if (p_type == ERR_HANDLER_SCRIPT) {
  96. return; //ignore script errors, those go through debugger
  97. }
  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 (int i = 0; i < output_strings.size(); i++) {
  180. const OutputString &output_string = output_strings[i];
  181. if (output_string.type == MESSAGE_TYPE_ERROR) {
  182. if (!joined_log_strings.is_empty()) {
  183. strings.push_back(String("\n").join(joined_log_strings));
  184. types.push_back(MESSAGE_TYPE_LOG);
  185. joined_log_strings.clear();
  186. }
  187. strings.push_back(output_string.message);
  188. types.push_back(MESSAGE_TYPE_ERROR);
  189. } else if (output_string.type == MESSAGE_TYPE_LOG_RICH) {
  190. if (!joined_log_strings.is_empty()) {
  191. strings.push_back(String("\n").join(joined_log_strings));
  192. types.push_back(MESSAGE_TYPE_LOG_RICH);
  193. joined_log_strings.clear();
  194. }
  195. strings.push_back(output_string.message);
  196. types.push_back(MESSAGE_TYPE_LOG_RICH);
  197. } else {
  198. joined_log_strings.push_back(output_string.message);
  199. }
  200. }
  201. if (!joined_log_strings.is_empty()) {
  202. strings.push_back(String("\n").join(joined_log_strings));
  203. types.push_back(MESSAGE_TYPE_LOG);
  204. }
  205. Array arr;
  206. arr.push_back(strings);
  207. arr.push_back(types);
  208. _put_msg("output", arr);
  209. output_strings.clear();
  210. }
  211. while (errors.size()) {
  212. ErrorMessage oe = errors.front()->get();
  213. _put_msg("error", oe.serialize());
  214. errors.pop_front();
  215. }
  216. // Update limits
  217. uint64_t ticks = OS::get_singleton()->get_ticks_usec() / 1000;
  218. if (ticks - last_reset > 1000) {
  219. last_reset = ticks;
  220. char_count = 0;
  221. err_count = 0;
  222. n_errors_dropped = 0;
  223. warn_count = 0;
  224. n_warnings_dropped = 0;
  225. }
  226. flushing = false;
  227. }
  228. void RemoteDebugger::send_message(const String &p_message, const Array &p_args) {
  229. MutexLock lock(mutex);
  230. if (is_peer_connected()) {
  231. _put_msg(p_message, p_args);
  232. }
  233. }
  234. 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) {
  235. ErrorMessage oe;
  236. oe.error = p_err;
  237. oe.error_descr = p_descr;
  238. oe.source_file = p_file;
  239. oe.source_line = p_line;
  240. oe.source_func = p_func;
  241. oe.warning = p_type == ERR_HANDLER_WARNING;
  242. uint64_t time = OS::get_singleton()->get_ticks_msec();
  243. oe.hr = time / 3600000;
  244. oe.min = (time / 60000) % 60;
  245. oe.sec = (time / 1000) % 60;
  246. oe.msec = time % 1000;
  247. oe.callstack.append_array(script_debugger->get_error_stack_info());
  248. if (flushing && Thread::get_caller_id() == flush_thread) { // Can't handle recursive errors during flush.
  249. return;
  250. }
  251. MutexLock lock(mutex);
  252. if (oe.warning) {
  253. warn_count++;
  254. } else {
  255. err_count++;
  256. }
  257. if (is_peer_connected()) {
  258. if (oe.warning) {
  259. if (warn_count > max_warnings_per_second) {
  260. n_warnings_dropped++;
  261. if (n_warnings_dropped == 1) {
  262. // Only print one message about dropping per second
  263. ErrorMessage overflow = _create_overflow_error("TOO_MANY_WARNINGS", "Too many warnings! Ignoring warnings for up to 1 second.");
  264. errors.push_back(overflow);
  265. }
  266. } else {
  267. errors.push_back(oe);
  268. }
  269. } else {
  270. if (err_count > max_errors_per_second) {
  271. n_errors_dropped++;
  272. if (n_errors_dropped == 1) {
  273. // Only print one message about dropping per second
  274. ErrorMessage overflow = _create_overflow_error("TOO_MANY_ERRORS", "Too many errors! Ignoring errors for up to 1 second.");
  275. errors.push_back(overflow);
  276. }
  277. } else {
  278. errors.push_back(oe);
  279. }
  280. }
  281. }
  282. }
  283. void RemoteDebugger::_send_stack_vars(List<String> &p_names, List<Variant> &p_vals, int p_type) {
  284. DebuggerMarshalls::ScriptStackVariable stvar;
  285. List<String>::Element *E = p_names.front();
  286. List<Variant>::Element *F = p_vals.front();
  287. while (E) {
  288. stvar.name = E->get();
  289. stvar.value = F->get();
  290. stvar.type = p_type;
  291. send_message("stack_frame_var", stvar.serialize());
  292. E = E->next();
  293. F = F->next();
  294. }
  295. }
  296. Error RemoteDebugger::_try_capture(const String &p_msg, const Array &p_data, bool &r_captured) {
  297. const int idx = p_msg.find(":");
  298. r_captured = false;
  299. if (idx < 0) { // No prefix, unknown message.
  300. return OK;
  301. }
  302. const String cap = p_msg.substr(0, idx);
  303. if (!has_capture(cap)) {
  304. return ERR_UNAVAILABLE; // Unknown message...
  305. }
  306. const String msg = p_msg.substr(idx + 1);
  307. return capture_parse(cap, msg, p_data, r_captured);
  308. }
  309. void RemoteDebugger::_poll_messages() {
  310. MutexLock mutex_lock(mutex);
  311. peer->poll();
  312. while (peer->has_message()) {
  313. Array cmd = peer->get_message();
  314. ERR_CONTINUE(cmd.size() != 3);
  315. ERR_CONTINUE(cmd[0].get_type() != Variant::STRING);
  316. ERR_CONTINUE(cmd[1].get_type() != Variant::INT);
  317. ERR_CONTINUE(cmd[2].get_type() != Variant::ARRAY);
  318. Thread::ID thread = cmd[1];
  319. if (!messages.has(thread)) {
  320. continue; // This thread is not around to receive the messages
  321. }
  322. Message msg;
  323. msg.message = cmd[0];
  324. msg.data = cmd[2];
  325. messages[thread].push_back(msg);
  326. }
  327. }
  328. bool RemoteDebugger::_has_messages() {
  329. MutexLock mutex_lock(mutex);
  330. return messages.has(Thread::get_caller_id()) && !messages[Thread::get_caller_id()].is_empty();
  331. }
  332. Array RemoteDebugger::_get_message() {
  333. MutexLock mutex_lock(mutex);
  334. ERR_FAIL_COND_V(!messages.has(Thread::get_caller_id()), Array());
  335. List<Message> &message_list = messages[Thread::get_caller_id()];
  336. ERR_FAIL_COND_V(message_list.is_empty(), Array());
  337. Array msg;
  338. msg.resize(2);
  339. msg[0] = message_list.front()->get().message;
  340. msg[1] = message_list.front()->get().data;
  341. message_list.pop_front();
  342. return msg;
  343. }
  344. void RemoteDebugger::debug(bool p_can_continue, bool p_is_error_breakpoint) {
  345. //this function is called when there is a debugger break (bug on script)
  346. //or when execution is paused from editor
  347. {
  348. MutexLock lock(mutex);
  349. // Tests that require mutex.
  350. if (script_debugger->is_skipping_breakpoints() && !p_is_error_breakpoint) {
  351. return;
  352. }
  353. ERR_FAIL_COND_MSG(!is_peer_connected(), "Script Debugger failed to connect, but being used anyway.");
  354. if (!peer->can_block()) {
  355. return; // Peer does not support blocking IO. We could at least send the error though.
  356. }
  357. }
  358. ScriptLanguage *script_lang = script_debugger->get_break_language();
  359. const String error_str = script_lang ? script_lang->debug_get_error() : "";
  360. Array msg;
  361. msg.push_back(p_can_continue);
  362. msg.push_back(error_str);
  363. ERR_FAIL_NULL(script_lang);
  364. msg.push_back(script_lang->debug_get_stack_level_count() > 0);
  365. msg.push_back(Thread::get_caller_id() == Thread::get_main_id() ? String(RTR("Main Thread")) : itos(Thread::get_caller_id()));
  366. if (allow_focus_steal_fn) {
  367. allow_focus_steal_fn();
  368. }
  369. send_message("debug_enter", msg);
  370. Input::MouseMode mouse_mode = Input::MOUSE_MODE_VISIBLE;
  371. if (Thread::get_caller_id() == Thread::get_main_id()) {
  372. mouse_mode = Input::get_singleton()->get_mouse_mode();
  373. if (mouse_mode != Input::MOUSE_MODE_VISIBLE) {
  374. Input::get_singleton()->set_mouse_mode(Input::MOUSE_MODE_VISIBLE);
  375. }
  376. } else {
  377. MutexLock mutex_lock(mutex);
  378. messages.insert(Thread::get_caller_id(), List<Message>());
  379. }
  380. while (is_peer_connected()) {
  381. flush_output();
  382. _poll_messages();
  383. if (_has_messages()) {
  384. Array cmd = _get_message();
  385. ERR_CONTINUE(cmd.size() != 2);
  386. ERR_CONTINUE(cmd[0].get_type() != Variant::STRING);
  387. ERR_CONTINUE(cmd[1].get_type() != Variant::ARRAY);
  388. String command = cmd[0];
  389. Array data = cmd[1];
  390. if (command == "step") {
  391. script_debugger->set_depth(-1);
  392. script_debugger->set_lines_left(1);
  393. break;
  394. } else if (command == "next") {
  395. script_debugger->set_depth(0);
  396. script_debugger->set_lines_left(1);
  397. break;
  398. } else if (command == "continue") {
  399. script_debugger->set_depth(-1);
  400. script_debugger->set_lines_left(-1);
  401. break;
  402. } else if (command == "break") {
  403. ERR_PRINT("Got break when already broke!");
  404. break;
  405. } else if (command == "get_stack_dump") {
  406. DebuggerMarshalls::ScriptStackDump dump;
  407. int slc = script_lang->debug_get_stack_level_count();
  408. for (int i = 0; i < slc; i++) {
  409. ScriptLanguage::StackInfo frame;
  410. frame.file = script_lang->debug_get_stack_level_source(i);
  411. frame.line = script_lang->debug_get_stack_level_line(i);
  412. frame.func = script_lang->debug_get_stack_level_function(i);
  413. dump.frames.push_back(frame);
  414. }
  415. send_message("stack_dump", dump.serialize());
  416. } else if (command == "get_stack_frame_vars") {
  417. ERR_FAIL_COND(data.size() != 1);
  418. ERR_FAIL_NULL(script_lang);
  419. int lv = data[0];
  420. List<String> members;
  421. List<Variant> member_vals;
  422. if (ScriptInstance *inst = script_lang->debug_get_stack_level_instance(lv)) {
  423. members.push_back("self");
  424. member_vals.push_back(inst->get_owner());
  425. }
  426. script_lang->debug_get_stack_level_members(lv, &members, &member_vals);
  427. ERR_FAIL_COND(members.size() != member_vals.size());
  428. List<String> locals;
  429. List<Variant> local_vals;
  430. script_lang->debug_get_stack_level_locals(lv, &locals, &local_vals);
  431. ERR_FAIL_COND(locals.size() != local_vals.size());
  432. List<String> globals;
  433. List<Variant> globals_vals;
  434. script_lang->debug_get_globals(&globals, &globals_vals);
  435. ERR_FAIL_COND(globals.size() != globals_vals.size());
  436. Array var_size;
  437. var_size.push_back(local_vals.size() + member_vals.size() + globals_vals.size());
  438. send_message("stack_frame_vars", var_size);
  439. _send_stack_vars(locals, local_vals, 0);
  440. _send_stack_vars(members, member_vals, 1);
  441. _send_stack_vars(globals, globals_vals, 2);
  442. } else if (command == "reload_scripts") {
  443. script_paths_to_reload = data;
  444. } else if (command == "reload_all_scripts") {
  445. reload_all_scripts = true;
  446. } else if (command == "breakpoint") {
  447. ERR_FAIL_COND(data.size() < 3);
  448. bool set = data[2];
  449. if (set) {
  450. script_debugger->insert_breakpoint(data[1], data[0]);
  451. } else {
  452. script_debugger->remove_breakpoint(data[1], data[0]);
  453. }
  454. } else if (command == "set_skip_breakpoints") {
  455. ERR_FAIL_COND(data.is_empty());
  456. script_debugger->set_skip_breakpoints(data[0]);
  457. } else {
  458. bool captured = false;
  459. ERR_CONTINUE(_try_capture(command, data, captured) != OK);
  460. if (!captured) {
  461. WARN_PRINT("Unknown message received from debugger: " + command);
  462. }
  463. }
  464. } else {
  465. OS::get_singleton()->delay_usec(10000);
  466. if (Thread::get_caller_id() == Thread::get_main_id()) {
  467. // If this is a busy loop on the main thread, events still need to be processed.
  468. OS::get_singleton()->process_and_drop_events();
  469. }
  470. }
  471. }
  472. send_message("debug_exit", Array());
  473. if (Thread::get_caller_id() == Thread::get_main_id()) {
  474. if (mouse_mode != Input::MOUSE_MODE_VISIBLE) {
  475. Input::get_singleton()->set_mouse_mode(mouse_mode);
  476. }
  477. } else {
  478. MutexLock mutex_lock(mutex);
  479. messages.erase(Thread::get_caller_id());
  480. }
  481. }
  482. void RemoteDebugger::poll_events(bool p_is_idle) {
  483. if (peer.is_null()) {
  484. return;
  485. }
  486. flush_output();
  487. _poll_messages();
  488. while (_has_messages()) {
  489. Array arr = _get_message();
  490. ERR_CONTINUE(arr.size() != 2);
  491. ERR_CONTINUE(arr[0].get_type() != Variant::STRING);
  492. ERR_CONTINUE(arr[1].get_type() != Variant::ARRAY);
  493. const String cmd = arr[0];
  494. const int idx = cmd.find(":");
  495. bool parsed = false;
  496. if (idx < 0) { // Not prefix, use scripts capture.
  497. capture_parse("core", cmd, arr[1], parsed);
  498. continue;
  499. }
  500. const String cap = cmd.substr(0, idx);
  501. if (!has_capture(cap)) {
  502. continue; // Unknown message...
  503. }
  504. const String msg = cmd.substr(idx + 1);
  505. capture_parse(cap, msg, arr[1], parsed);
  506. }
  507. // Reload scripts during idle poll only.
  508. if (p_is_idle) {
  509. if (reload_all_scripts) {
  510. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  511. ScriptServer::get_language(i)->reload_all_scripts();
  512. }
  513. reload_all_scripts = false;
  514. } else if (!script_paths_to_reload.is_empty()) {
  515. Array scripts_to_reload;
  516. for (int i = 0; i < script_paths_to_reload.size(); ++i) {
  517. String path = script_paths_to_reload[i];
  518. Error err = OK;
  519. Ref<Script> script = ResourceLoader::load(path, "", ResourceFormatLoader::CACHE_MODE_REUSE, &err);
  520. ERR_CONTINUE_MSG(err != OK, vformat("Could not reload script '%s': %s", path, error_names[err]));
  521. ERR_CONTINUE_MSG(script.is_null(), vformat("Could not reload script '%s': Not a script!", path, error_names[err]));
  522. scripts_to_reload.push_back(script);
  523. }
  524. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  525. ScriptServer::get_language(i)->reload_scripts(scripts_to_reload, true);
  526. }
  527. }
  528. script_paths_to_reload.clear();
  529. }
  530. }
  531. Error RemoteDebugger::_core_capture(const String &p_cmd, const Array &p_data, bool &r_captured) {
  532. r_captured = true;
  533. if (p_cmd == "reload_scripts") {
  534. script_paths_to_reload = p_data;
  535. } else if (p_cmd == "reload_all_scripts") {
  536. reload_all_scripts = true;
  537. } else if (p_cmd == "breakpoint") {
  538. ERR_FAIL_COND_V(p_data.size() < 3, ERR_INVALID_DATA);
  539. bool set = p_data[2];
  540. if (set) {
  541. script_debugger->insert_breakpoint(p_data[1], p_data[0]);
  542. } else {
  543. script_debugger->remove_breakpoint(p_data[1], p_data[0]);
  544. }
  545. } else if (p_cmd == "set_skip_breakpoints") {
  546. ERR_FAIL_COND_V(p_data.is_empty(), ERR_INVALID_DATA);
  547. script_debugger->set_skip_breakpoints(p_data[0]);
  548. } else if (p_cmd == "break") {
  549. script_debugger->debug(script_debugger->get_break_language());
  550. } else {
  551. r_captured = false;
  552. }
  553. return OK;
  554. }
  555. Error RemoteDebugger::_profiler_capture(const String &p_cmd, const Array &p_data, bool &r_captured) {
  556. r_captured = false;
  557. ERR_FAIL_COND_V(p_data.is_empty(), ERR_INVALID_DATA);
  558. ERR_FAIL_COND_V(p_data[0].get_type() != Variant::BOOL, ERR_INVALID_DATA);
  559. ERR_FAIL_COND_V(!has_profiler(p_cmd), ERR_UNAVAILABLE);
  560. Array opts;
  561. if (p_data.size() > 1) { // Optional profiler parameters.
  562. ERR_FAIL_COND_V(p_data[1].get_type() != Variant::ARRAY, ERR_INVALID_DATA);
  563. opts = p_data[1];
  564. }
  565. r_captured = true;
  566. profiler_enable(p_cmd, p_data[0], opts);
  567. return OK;
  568. }
  569. RemoteDebugger::RemoteDebugger(Ref<RemoteDebuggerPeer> p_peer) {
  570. peer = p_peer;
  571. max_chars_per_second = GLOBAL_GET("network/limits/debugger/max_chars_per_second");
  572. max_errors_per_second = GLOBAL_GET("network/limits/debugger/max_errors_per_second");
  573. max_warnings_per_second = GLOBAL_GET("network/limits/debugger/max_warnings_per_second");
  574. // Performance Profiler
  575. Object *perf = Engine::get_singleton()->get_singleton_object("Performance");
  576. if (perf) {
  577. performance_profiler = Ref<PerformanceProfiler>(memnew(PerformanceProfiler(perf)));
  578. performance_profiler->bind("performance");
  579. profiler_enable("performance", true);
  580. }
  581. // Core and profiler captures.
  582. Capture core_cap(this,
  583. [](void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
  584. return static_cast<RemoteDebugger *>(p_user)->_core_capture(p_cmd, p_data, r_captured);
  585. });
  586. register_message_capture("core", core_cap);
  587. Capture profiler_cap(this,
  588. [](void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
  589. return static_cast<RemoteDebugger *>(p_user)->_profiler_capture(p_cmd, p_data, r_captured);
  590. });
  591. register_message_capture("profiler", profiler_cap);
  592. // Error handlers
  593. phl.printfunc = _print_handler;
  594. phl.userdata = this;
  595. add_print_handler(&phl);
  596. eh.errfunc = _err_handler;
  597. eh.userdata = this;
  598. add_error_handler(&eh);
  599. messages.insert(Thread::get_main_id(), List<Message>());
  600. }
  601. RemoteDebugger::~RemoteDebugger() {
  602. remove_print_handler(&phl);
  603. remove_error_handler(&eh);
  604. }