script_debugger_remote.cpp 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119
  1. /*************************************************************************/
  2. /* script_debugger_remote.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md) */
  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 "script_debugger_remote.h"
  31. #include "engine.h"
  32. #include "io/ip.h"
  33. #include "io/marshalls.h"
  34. #include "os/input.h"
  35. #include "os/os.h"
  36. #include "project_settings.h"
  37. #include "scene/main/node.h"
  38. #include "scene/resources/packed_scene.h"
  39. void ScriptDebuggerRemote::_send_video_memory() {
  40. List<ResourceUsage> usage;
  41. if (resource_usage_func)
  42. resource_usage_func(&usage);
  43. usage.sort();
  44. packet_peer_stream->put_var("message:video_mem");
  45. packet_peer_stream->put_var(usage.size() * 4);
  46. for (List<ResourceUsage>::Element *E = usage.front(); E; E = E->next()) {
  47. packet_peer_stream->put_var(E->get().path);
  48. packet_peer_stream->put_var(E->get().type);
  49. packet_peer_stream->put_var(E->get().format);
  50. packet_peer_stream->put_var(E->get().vram);
  51. }
  52. }
  53. Error ScriptDebuggerRemote::connect_to_host(const String &p_host, uint16_t p_port) {
  54. IP_Address ip;
  55. if (p_host.is_valid_ip_address())
  56. ip = p_host;
  57. else
  58. ip = IP::get_singleton()->resolve_hostname(p_host);
  59. int port = p_port;
  60. const int tries = 6;
  61. int waits[tries] = { 1, 10, 100, 1000, 1000, 1000 };
  62. tcp_client->connect_to_host(ip, port);
  63. for (int i = 0; i < tries; i++) {
  64. if (tcp_client->get_status() == StreamPeerTCP::STATUS_CONNECTED) {
  65. break;
  66. } else {
  67. const int ms = waits[i];
  68. OS::get_singleton()->delay_usec(ms * 1000);
  69. print_line("Remote Debugger: Connection failed with status: '" + String::num(tcp_client->get_status()) + "', retrying in " + String::num(ms) + " msec.");
  70. };
  71. };
  72. if (tcp_client->get_status() != StreamPeerTCP::STATUS_CONNECTED) {
  73. print_line("Remote Debugger: Unable to connect");
  74. return FAILED;
  75. };
  76. // print_line("Remote Debugger: Connection OK!");
  77. packet_peer_stream->set_stream_peer(tcp_client);
  78. return OK;
  79. }
  80. static int _ScriptDebuggerRemote_found_id = 0;
  81. static Object *_ScriptDebuggerRemote_find = NULL;
  82. static void _ScriptDebuggerRemote_debug_func(Object *p_obj) {
  83. if (_ScriptDebuggerRemote_find == p_obj) {
  84. _ScriptDebuggerRemote_found_id = p_obj->get_instance_id();
  85. }
  86. }
  87. static ObjectID safe_get_instance_id(const Variant &p_v) {
  88. Object *o = p_v;
  89. if (o == NULL)
  90. return 0;
  91. else {
  92. REF r = p_v;
  93. if (r.is_valid()) {
  94. return r->get_instance_id();
  95. } else {
  96. _ScriptDebuggerRemote_found_id = 0;
  97. _ScriptDebuggerRemote_find = NULL;
  98. ObjectDB::debug_objects(_ScriptDebuggerRemote_debug_func);
  99. return _ScriptDebuggerRemote_found_id;
  100. }
  101. }
  102. }
  103. void ScriptDebuggerRemote::_put_variable(const String &p_name, const Variant &p_variable) {
  104. packet_peer_stream->put_var(p_name);
  105. Variant var = p_variable;
  106. if (p_variable.get_type() == Variant::OBJECT && !ObjectDB::instance_validate(p_variable)) {
  107. var = Variant();
  108. }
  109. int len = 0;
  110. Error err = encode_variant(var, NULL, len);
  111. if (err != OK)
  112. ERR_PRINT("Failed to encode variant");
  113. if (len > packet_peer_stream->get_output_buffer_max_size()) { //limit to max size
  114. packet_peer_stream->put_var(Variant());
  115. } else {
  116. packet_peer_stream->put_var(var);
  117. }
  118. }
  119. void ScriptDebuggerRemote::_save_node(ObjectID id, const String &p_path) {
  120. Node *node = Object::cast_to<Node>(ObjectDB::get_instance(id));
  121. ERR_FAIL_COND(!node);
  122. Ref<PackedScene> ps = memnew(PackedScene);
  123. ps->pack(node);
  124. ResourceSaver::save(p_path, ps);
  125. }
  126. void ScriptDebuggerRemote::debug(ScriptLanguage *p_script, bool p_can_continue) {
  127. //this function is called when there is a debugger break (bug on script)
  128. //or when execution is paused from editor
  129. if (!tcp_client->is_connected_to_host()) {
  130. ERR_EXPLAIN("Script Debugger failed to connect, but being used anyway.");
  131. ERR_FAIL();
  132. }
  133. packet_peer_stream->put_var("debug_enter");
  134. packet_peer_stream->put_var(2);
  135. packet_peer_stream->put_var(p_can_continue);
  136. packet_peer_stream->put_var(p_script->debug_get_error());
  137. skip_profile_frame = true; // to avoid super long frame time for the frame
  138. Input::MouseMode mouse_mode = Input::get_singleton()->get_mouse_mode();
  139. if (mouse_mode != Input::MOUSE_MODE_VISIBLE)
  140. Input::get_singleton()->set_mouse_mode(Input::MOUSE_MODE_VISIBLE);
  141. while (true) {
  142. _get_output();
  143. if (packet_peer_stream->get_available_packet_count() > 0) {
  144. Variant var;
  145. Error err = packet_peer_stream->get_var(var);
  146. ERR_CONTINUE(err != OK);
  147. ERR_CONTINUE(var.get_type() != Variant::ARRAY);
  148. Array cmd = var;
  149. ERR_CONTINUE(cmd.size() == 0);
  150. ERR_CONTINUE(cmd[0].get_type() != Variant::STRING);
  151. String command = cmd[0];
  152. if (command == "get_stack_dump") {
  153. packet_peer_stream->put_var("stack_dump");
  154. int slc = p_script->debug_get_stack_level_count();
  155. packet_peer_stream->put_var(slc);
  156. for (int i = 0; i < slc; i++) {
  157. Dictionary d;
  158. d["file"] = p_script->debug_get_stack_level_source(i);
  159. d["line"] = p_script->debug_get_stack_level_line(i);
  160. d["function"] = p_script->debug_get_stack_level_function(i);
  161. //d["id"]=p_script->debug_get_stack_level_
  162. d["id"] = 0;
  163. packet_peer_stream->put_var(d);
  164. }
  165. } else if (command == "get_stack_frame_vars") {
  166. cmd.remove(0);
  167. ERR_CONTINUE(cmd.size() != 1);
  168. int lv = cmd[0];
  169. List<String> members;
  170. List<Variant> member_vals;
  171. if (ScriptInstance *inst = p_script->debug_get_stack_level_instance(lv)) {
  172. members.push_back("self");
  173. member_vals.push_back(inst->get_owner());
  174. }
  175. p_script->debug_get_stack_level_members(lv, &members, &member_vals);
  176. ERR_CONTINUE(members.size() != member_vals.size());
  177. List<String> locals;
  178. List<Variant> local_vals;
  179. p_script->debug_get_stack_level_locals(lv, &locals, &local_vals);
  180. ERR_CONTINUE(locals.size() != local_vals.size());
  181. List<String> globals;
  182. List<Variant> globals_vals;
  183. p_script->debug_get_globals(&globals, &globals_vals);
  184. ERR_CONTINUE(globals.size() != globals_vals.size());
  185. packet_peer_stream->put_var("stack_frame_vars");
  186. packet_peer_stream->put_var(3 + (locals.size() + members.size() + globals.size()) * 2);
  187. { //locals
  188. packet_peer_stream->put_var(locals.size());
  189. List<String>::Element *E = locals.front();
  190. List<Variant>::Element *F = local_vals.front();
  191. while (E) {
  192. _put_variable(E->get(), F->get());
  193. E = E->next();
  194. F = F->next();
  195. }
  196. }
  197. { //members
  198. packet_peer_stream->put_var(members.size());
  199. List<String>::Element *E = members.front();
  200. List<Variant>::Element *F = member_vals.front();
  201. while (E) {
  202. _put_variable(E->get(), F->get());
  203. E = E->next();
  204. F = F->next();
  205. }
  206. }
  207. { //globals
  208. packet_peer_stream->put_var(globals.size());
  209. List<String>::Element *E = globals.front();
  210. List<Variant>::Element *F = globals_vals.front();
  211. while (E) {
  212. _put_variable(E->get(), F->get());
  213. E = E->next();
  214. F = F->next();
  215. }
  216. }
  217. } else if (command == "step") {
  218. set_depth(-1);
  219. set_lines_left(1);
  220. break;
  221. } else if (command == "next") {
  222. set_depth(0);
  223. set_lines_left(1);
  224. break;
  225. } else if (command == "continue") {
  226. set_depth(-1);
  227. set_lines_left(-1);
  228. OS::get_singleton()->move_window_to_foreground();
  229. break;
  230. } else if (command == "break") {
  231. ERR_PRINT("Got break when already broke!");
  232. break;
  233. } else if (command == "request_scene_tree") {
  234. if (request_scene_tree)
  235. request_scene_tree(request_scene_tree_ud);
  236. } else if (command == "request_video_mem") {
  237. _send_video_memory();
  238. } else if (command == "inspect_object") {
  239. ObjectID id = cmd[1];
  240. _send_object_id(id);
  241. } else if (command == "set_object_property") {
  242. _set_object_property(cmd[1], cmd[2], cmd[3]);
  243. } else if (command == "reload_scripts") {
  244. reload_all_scripts = true;
  245. } else if (command == "breakpoint") {
  246. bool set = cmd[3];
  247. if (set)
  248. insert_breakpoint(cmd[2], cmd[1]);
  249. else
  250. remove_breakpoint(cmd[2], cmd[1]);
  251. } else if (command == "save_node") {
  252. _save_node(cmd[1], cmd[2]);
  253. } else {
  254. _parse_live_edit(cmd);
  255. }
  256. } else {
  257. OS::get_singleton()->delay_usec(10000);
  258. }
  259. }
  260. packet_peer_stream->put_var("debug_exit");
  261. packet_peer_stream->put_var(0);
  262. if (mouse_mode != Input::MOUSE_MODE_VISIBLE)
  263. Input::get_singleton()->set_mouse_mode(mouse_mode);
  264. }
  265. void ScriptDebuggerRemote::_get_output() {
  266. mutex->lock();
  267. if (output_strings.size()) {
  268. locking = true;
  269. packet_peer_stream->put_var("output");
  270. packet_peer_stream->put_var(output_strings.size());
  271. while (output_strings.size()) {
  272. packet_peer_stream->put_var(output_strings.front()->get());
  273. output_strings.pop_front();
  274. }
  275. locking = false;
  276. }
  277. if (n_messages_dropped > 0) {
  278. Message msg;
  279. msg.message = "Too many messages! " + String::num_int64(n_messages_dropped) + " messages were dropped.";
  280. messages.push_back(msg);
  281. n_messages_dropped = 0;
  282. }
  283. while (messages.size()) {
  284. locking = true;
  285. packet_peer_stream->put_var("message:" + messages.front()->get().message);
  286. packet_peer_stream->put_var(messages.front()->get().data.size());
  287. for (int i = 0; i < messages.front()->get().data.size(); i++) {
  288. packet_peer_stream->put_var(messages.front()->get().data[i]);
  289. }
  290. messages.pop_front();
  291. locking = false;
  292. }
  293. if (n_errors_dropped > 0) {
  294. OutputError oe;
  295. oe.error = "TOO_MANY_ERRORS";
  296. oe.error_descr = "Too many errors! " + String::num_int64(n_errors_dropped) + " errors were dropped.";
  297. oe.warning = false;
  298. uint64_t time = OS::get_singleton()->get_ticks_msec();
  299. oe.hr = time / 3600000;
  300. oe.min = (time / 60000) % 60;
  301. oe.sec = (time / 1000) % 60;
  302. oe.msec = time % 1000;
  303. errors.push_back(oe);
  304. n_errors_dropped = 0;
  305. }
  306. while (errors.size()) {
  307. locking = true;
  308. packet_peer_stream->put_var("error");
  309. OutputError oe = errors.front()->get();
  310. packet_peer_stream->put_var(oe.callstack.size() + 2);
  311. Array error_data;
  312. error_data.push_back(oe.hr);
  313. error_data.push_back(oe.min);
  314. error_data.push_back(oe.sec);
  315. error_data.push_back(oe.msec);
  316. error_data.push_back(oe.source_func);
  317. error_data.push_back(oe.source_file);
  318. error_data.push_back(oe.source_line);
  319. error_data.push_back(oe.error);
  320. error_data.push_back(oe.error_descr);
  321. error_data.push_back(oe.warning);
  322. packet_peer_stream->put_var(error_data);
  323. packet_peer_stream->put_var(oe.callstack.size());
  324. for (int i = 0; i < oe.callstack.size(); i++) {
  325. packet_peer_stream->put_var(oe.callstack[i]);
  326. }
  327. errors.pop_front();
  328. locking = false;
  329. }
  330. mutex->unlock();
  331. }
  332. void ScriptDebuggerRemote::line_poll() {
  333. //the purpose of this is just processing events every now and then when the script might get too busy
  334. //otherwise bugs like infinite loops can't be caught
  335. if (poll_every % 2048 == 0)
  336. _poll_events();
  337. poll_every++;
  338. }
  339. void ScriptDebuggerRemote::_err_handler(void *ud, const char *p_func, const char *p_file, int p_line, const char *p_err, const char *p_descr, ErrorHandlerType p_type) {
  340. if (p_type == ERR_HANDLER_SCRIPT)
  341. return; //ignore script errors, those go through debugger
  342. Vector<ScriptLanguage::StackInfo> si;
  343. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  344. si = ScriptServer::get_language(i)->debug_get_current_stack_info();
  345. if (si.size())
  346. break;
  347. }
  348. ScriptDebuggerRemote *sdr = (ScriptDebuggerRemote *)ud;
  349. sdr->send_error(p_func, p_file, p_line, p_err, p_descr, p_type, si);
  350. }
  351. bool ScriptDebuggerRemote::_parse_live_edit(const Array &p_command) {
  352. String cmdstr = p_command[0];
  353. if (!live_edit_funcs || !cmdstr.begins_with("live_"))
  354. return false;
  355. //print_line(Variant(cmd).get_construct_string());
  356. if (cmdstr == "live_set_root") {
  357. if (!live_edit_funcs->root_func)
  358. return true;
  359. //print_line("root: "+Variant(cmd).get_construct_string());
  360. live_edit_funcs->root_func(live_edit_funcs->udata, p_command[1], p_command[2]);
  361. } else if (cmdstr == "live_node_path") {
  362. if (!live_edit_funcs->node_path_func)
  363. return true;
  364. //print_line("path: "+Variant(cmd).get_construct_string());
  365. live_edit_funcs->node_path_func(live_edit_funcs->udata, p_command[1], p_command[2]);
  366. } else if (cmdstr == "live_res_path") {
  367. if (!live_edit_funcs->res_path_func)
  368. return true;
  369. live_edit_funcs->res_path_func(live_edit_funcs->udata, p_command[1], p_command[2]);
  370. } else if (cmdstr == "live_node_prop_res") {
  371. if (!live_edit_funcs->node_set_res_func)
  372. return true;
  373. live_edit_funcs->node_set_res_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3]);
  374. } else if (cmdstr == "live_node_prop") {
  375. if (!live_edit_funcs->node_set_func)
  376. return true;
  377. live_edit_funcs->node_set_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3]);
  378. } else if (cmdstr == "live_res_prop_res") {
  379. if (!live_edit_funcs->res_set_res_func)
  380. return true;
  381. live_edit_funcs->res_set_res_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3]);
  382. } else if (cmdstr == "live_res_prop") {
  383. if (!live_edit_funcs->res_set_func)
  384. return true;
  385. live_edit_funcs->res_set_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3]);
  386. } else if (cmdstr == "live_node_call") {
  387. if (!live_edit_funcs->node_call_func)
  388. return true;
  389. live_edit_funcs->node_call_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3], p_command[4], p_command[5], p_command[6], p_command[7]);
  390. } else if (cmdstr == "live_res_call") {
  391. if (!live_edit_funcs->res_call_func)
  392. return true;
  393. live_edit_funcs->res_call_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3], p_command[4], p_command[5], p_command[6], p_command[7]);
  394. } else if (cmdstr == "live_create_node") {
  395. live_edit_funcs->tree_create_node_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3]);
  396. } else if (cmdstr == "live_instance_node") {
  397. live_edit_funcs->tree_instance_node_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3]);
  398. } else if (cmdstr == "live_remove_node") {
  399. live_edit_funcs->tree_remove_node_func(live_edit_funcs->udata, p_command[1]);
  400. } else if (cmdstr == "live_remove_and_keep_node") {
  401. live_edit_funcs->tree_remove_and_keep_node_func(live_edit_funcs->udata, p_command[1], p_command[2]);
  402. } else if (cmdstr == "live_restore_node") {
  403. live_edit_funcs->tree_restore_node_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3]);
  404. } else if (cmdstr == "live_duplicate_node") {
  405. live_edit_funcs->tree_duplicate_node_func(live_edit_funcs->udata, p_command[1], p_command[2]);
  406. } else if (cmdstr == "live_reparent_node") {
  407. live_edit_funcs->tree_reparent_node_func(live_edit_funcs->udata, p_command[1], p_command[2], p_command[3], p_command[4]);
  408. } else {
  409. return false;
  410. }
  411. return true;
  412. }
  413. void ScriptDebuggerRemote::_send_object_id(ObjectID p_id) {
  414. Object *obj = ObjectDB::get_instance(p_id);
  415. if (!obj)
  416. return;
  417. typedef Pair<PropertyInfo, Variant> PropertyDesc;
  418. List<PropertyDesc> properties;
  419. if (ScriptInstance *si = obj->get_script_instance()) {
  420. if (!si->get_script().is_null()) {
  421. typedef Map<const Script *, Set<StringName> > ScriptMemberMap;
  422. typedef Map<const Script *, Map<StringName, Variant> > ScriptConstantsMap;
  423. ScriptMemberMap members;
  424. members[si->get_script().ptr()] = Set<StringName>();
  425. si->get_script()->get_members(&(members[si->get_script().ptr()]));
  426. ScriptConstantsMap constants;
  427. constants[si->get_script().ptr()] = Map<StringName, Variant>();
  428. si->get_script()->get_constants(&(constants[si->get_script().ptr()]));
  429. Ref<Script> base = si->get_script()->get_base_script();
  430. while (base.is_valid()) {
  431. members[base.ptr()] = Set<StringName>();
  432. base->get_members(&(members[base.ptr()]));
  433. constants[base.ptr()] = Map<StringName, Variant>();
  434. base->get_constants(&(constants[base.ptr()]));
  435. base = base->get_base_script();
  436. }
  437. for (ScriptMemberMap::Element *sm = members.front(); sm; sm = sm->next()) {
  438. for (Set<StringName>::Element *E = sm->get().front(); E; E = E->next()) {
  439. Variant m;
  440. if (si->get(E->get(), m)) {
  441. String script_path = sm->key() == si->get_script().ptr() ? "" : sm->key()->get_path().get_file() + "/";
  442. PropertyInfo pi(m.get_type(), "Members/" + script_path + E->get());
  443. properties.push_back(PropertyDesc(pi, m));
  444. }
  445. }
  446. }
  447. for (ScriptConstantsMap::Element *sc = constants.front(); sc; sc = sc->next()) {
  448. for (Map<StringName, Variant>::Element *E = sc->get().front(); E; E = E->next()) {
  449. String script_path = sc->key() == si->get_script().ptr() ? "" : sc->key()->get_path().get_file() + "/";
  450. PropertyInfo pi(E->value().get_type(), "Constants/" + script_path + E->key());
  451. properties.push_back(PropertyDesc(pi, E->value()));
  452. }
  453. }
  454. }
  455. }
  456. if (Node *node = Object::cast_to<Node>(obj)) {
  457. PropertyInfo pi(Variant::NODE_PATH, String("Node/path"));
  458. properties.push_front(PropertyDesc(pi, node->get_path()));
  459. } else if (Resource *res = Object::cast_to<Resource>(obj)) {
  460. if (Script *s = Object::cast_to<Script>(res)) {
  461. Map<StringName, Variant> constants;
  462. s->get_constants(&constants);
  463. for (Map<StringName, Variant>::Element *E = constants.front(); E; E = E->next()) {
  464. PropertyInfo pi(E->value().get_type(), String("Constants/") + E->key());
  465. properties.push_front(PropertyDesc(pi, E->value()));
  466. }
  467. }
  468. }
  469. List<PropertyInfo> pinfo;
  470. obj->get_property_list(&pinfo, true);
  471. for (List<PropertyInfo>::Element *E = pinfo.front(); E; E = E->next()) {
  472. if (E->get().usage & (PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_CATEGORY)) {
  473. properties.push_back(PropertyDesc(E->get(), obj->get(E->get().name)));
  474. }
  475. }
  476. Array send_props;
  477. for (int i = 0; i < properties.size(); i++) {
  478. const PropertyInfo &pi = properties[i].first;
  479. Variant &var = properties[i].second;
  480. WeakRef *ref = Object::cast_to<WeakRef>(var);
  481. if (ref) {
  482. var = ref->get_ref();
  483. }
  484. RES res = var;
  485. Array prop;
  486. prop.push_back(pi.name);
  487. prop.push_back(pi.type);
  488. //only send information that can be sent..
  489. int len = 0; //test how big is this to encode
  490. encode_variant(var, NULL, len);
  491. if (len > packet_peer_stream->get_output_buffer_max_size()) { //limit to max size
  492. prop.push_back(PROPERTY_HINT_OBJECT_TOO_BIG);
  493. prop.push_back("");
  494. prop.push_back(pi.usage);
  495. prop.push_back(Variant());
  496. } else {
  497. prop.push_back(pi.hint);
  498. if (res.is_null())
  499. prop.push_back(pi.hint_string);
  500. else
  501. prop.push_back(String("RES:") + res->get_path());
  502. prop.push_back(pi.usage);
  503. prop.push_back(var);
  504. }
  505. send_props.push_back(prop);
  506. }
  507. packet_peer_stream->put_var("message:inspect_object");
  508. packet_peer_stream->put_var(3);
  509. packet_peer_stream->put_var(p_id);
  510. packet_peer_stream->put_var(obj->get_class());
  511. packet_peer_stream->put_var(send_props);
  512. }
  513. void ScriptDebuggerRemote::_set_object_property(ObjectID p_id, const String &p_property, const Variant &p_value) {
  514. Object *obj = ObjectDB::get_instance(p_id);
  515. if (!obj)
  516. return;
  517. String prop_name = p_property;
  518. if (p_property.begins_with("Members/")) {
  519. Vector<String> ss = p_property.split("/");
  520. prop_name = ss[ss.size() - 1];
  521. }
  522. obj->set(prop_name, p_value);
  523. }
  524. void ScriptDebuggerRemote::_poll_events() {
  525. //this si called from ::idle_poll, happens only when running the game,
  526. //does not get called while on debug break
  527. while (packet_peer_stream->get_available_packet_count() > 0) {
  528. _get_output();
  529. //send over output_strings
  530. Variant var;
  531. Error err = packet_peer_stream->get_var(var);
  532. ERR_CONTINUE(err != OK);
  533. ERR_CONTINUE(var.get_type() != Variant::ARRAY);
  534. Array cmd = var;
  535. ERR_CONTINUE(cmd.size() == 0);
  536. ERR_CONTINUE(cmd[0].get_type() != Variant::STRING);
  537. String command = cmd[0];
  538. //cmd.remove(0);
  539. if (command == "break") {
  540. if (get_break_language())
  541. debug(get_break_language());
  542. } else if (command == "request_scene_tree") {
  543. if (request_scene_tree)
  544. request_scene_tree(request_scene_tree_ud);
  545. } else if (command == "request_video_mem") {
  546. _send_video_memory();
  547. } else if (command == "inspect_object") {
  548. ObjectID id = cmd[1];
  549. _send_object_id(id);
  550. } else if (command == "set_object_property") {
  551. _set_object_property(cmd[1], cmd[2], cmd[3]);
  552. } else if (command == "start_profiling") {
  553. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  554. ScriptServer::get_language(i)->profiling_start();
  555. }
  556. max_frame_functions = cmd[1];
  557. profiler_function_signature_map.clear();
  558. profiling = true;
  559. frame_time = 0;
  560. idle_time = 0;
  561. physics_time = 0;
  562. physics_frame_time = 0;
  563. print_line("PROFILING ALRIGHT!");
  564. } else if (command == "stop_profiling") {
  565. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  566. ScriptServer::get_language(i)->profiling_stop();
  567. }
  568. profiling = false;
  569. _send_profiling_data(false);
  570. print_line("PROFILING END!");
  571. } else if (command == "reload_scripts") {
  572. reload_all_scripts = true;
  573. } else if (command == "breakpoint") {
  574. bool set = cmd[3];
  575. if (set)
  576. insert_breakpoint(cmd[2], cmd[1]);
  577. else
  578. remove_breakpoint(cmd[2], cmd[1]);
  579. } else {
  580. _parse_live_edit(cmd);
  581. }
  582. }
  583. }
  584. void ScriptDebuggerRemote::_send_profiling_data(bool p_for_frame) {
  585. int ofs = 0;
  586. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  587. if (p_for_frame)
  588. ofs += ScriptServer::get_language(i)->profiling_get_frame_data(&profile_info[ofs], profile_info.size() - ofs);
  589. else
  590. ofs += ScriptServer::get_language(i)->profiling_get_accumulated_data(&profile_info[ofs], profile_info.size() - ofs);
  591. }
  592. for (int i = 0; i < ofs; i++) {
  593. profile_info_ptrs[i] = &profile_info[i];
  594. }
  595. SortArray<ScriptLanguage::ProfilingInfo *, ProfileInfoSort> sa;
  596. sa.sort(profile_info_ptrs.ptrw(), ofs);
  597. int to_send = MIN(ofs, max_frame_functions);
  598. //check signatures first
  599. uint64_t total_script_time = 0;
  600. for (int i = 0; i < to_send; i++) {
  601. if (!profiler_function_signature_map.has(profile_info_ptrs[i]->signature)) {
  602. int idx = profiler_function_signature_map.size();
  603. packet_peer_stream->put_var("profile_sig");
  604. packet_peer_stream->put_var(2);
  605. packet_peer_stream->put_var(profile_info_ptrs[i]->signature);
  606. packet_peer_stream->put_var(idx);
  607. profiler_function_signature_map[profile_info_ptrs[i]->signature] = idx;
  608. }
  609. total_script_time += profile_info_ptrs[i]->self_time;
  610. }
  611. //send frames then
  612. if (p_for_frame) {
  613. packet_peer_stream->put_var("profile_frame");
  614. packet_peer_stream->put_var(8 + profile_frame_data.size() * 2 + to_send * 4);
  615. } else {
  616. packet_peer_stream->put_var("profile_total");
  617. packet_peer_stream->put_var(8 + to_send * 4);
  618. }
  619. packet_peer_stream->put_var(Engine::get_singleton()->get_frames_drawn()); //total frame time
  620. packet_peer_stream->put_var(frame_time); //total frame time
  621. packet_peer_stream->put_var(idle_time); //idle frame time
  622. packet_peer_stream->put_var(physics_time); //fixed frame time
  623. packet_peer_stream->put_var(physics_frame_time); //fixed frame time
  624. packet_peer_stream->put_var(USEC_TO_SEC(total_script_time)); //total script execution time
  625. if (p_for_frame) {
  626. packet_peer_stream->put_var(profile_frame_data.size()); //how many profile framedatas to send
  627. packet_peer_stream->put_var(to_send); //how many script functions to send
  628. for (int i = 0; i < profile_frame_data.size(); i++) {
  629. packet_peer_stream->put_var(profile_frame_data[i].name);
  630. packet_peer_stream->put_var(profile_frame_data[i].data);
  631. }
  632. } else {
  633. packet_peer_stream->put_var(0); //how many script functions to send
  634. packet_peer_stream->put_var(to_send); //how many script functions to send
  635. }
  636. for (int i = 0; i < to_send; i++) {
  637. int sig_id = -1;
  638. if (profiler_function_signature_map.has(profile_info_ptrs[i]->signature)) {
  639. sig_id = profiler_function_signature_map[profile_info_ptrs[i]->signature];
  640. }
  641. packet_peer_stream->put_var(sig_id);
  642. packet_peer_stream->put_var(profile_info_ptrs[i]->call_count);
  643. packet_peer_stream->put_var(profile_info_ptrs[i]->total_time / 1000000.0);
  644. packet_peer_stream->put_var(profile_info_ptrs[i]->self_time / 1000000.0);
  645. }
  646. if (p_for_frame) {
  647. profile_frame_data.clear();
  648. }
  649. }
  650. void ScriptDebuggerRemote::idle_poll() {
  651. // this function is called every frame, except when there is a debugger break (::debug() in this class)
  652. // execution stops and remains in the ::debug function
  653. _get_output();
  654. if (requested_quit) {
  655. packet_peer_stream->put_var("kill_me");
  656. packet_peer_stream->put_var(0);
  657. requested_quit = false;
  658. }
  659. if (performance) {
  660. uint64_t pt = OS::get_singleton()->get_ticks_msec();
  661. if (pt - last_perf_time > 1000) {
  662. last_perf_time = pt;
  663. int max = performance->get("MONITOR_MAX");
  664. Array arr;
  665. arr.resize(max);
  666. for (int i = 0; i < max; i++) {
  667. arr[i] = performance->call("get_monitor", i);
  668. }
  669. packet_peer_stream->put_var("performance");
  670. packet_peer_stream->put_var(1);
  671. packet_peer_stream->put_var(arr);
  672. }
  673. }
  674. if (profiling) {
  675. if (skip_profile_frame) {
  676. skip_profile_frame = false;
  677. } else {
  678. //send profiling info normally
  679. _send_profiling_data(true);
  680. }
  681. }
  682. if (reload_all_scripts) {
  683. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  684. ScriptServer::get_language(i)->reload_all_scripts();
  685. }
  686. reload_all_scripts = false;
  687. }
  688. _poll_events();
  689. }
  690. void ScriptDebuggerRemote::send_message(const String &p_message, const Array &p_args) {
  691. mutex->lock();
  692. if (!locking && tcp_client->is_connected_to_host()) {
  693. if (messages.size() >= max_messages_per_frame) {
  694. n_messages_dropped++;
  695. } else {
  696. Message msg;
  697. msg.message = p_message;
  698. msg.data = p_args;
  699. messages.push_back(msg);
  700. }
  701. }
  702. mutex->unlock();
  703. }
  704. void ScriptDebuggerRemote::send_error(const String &p_func, const String &p_file, int p_line, const String &p_err, const String &p_descr, ErrorHandlerType p_type, const Vector<ScriptLanguage::StackInfo> &p_stack_info) {
  705. OutputError oe;
  706. oe.error = p_err;
  707. oe.error_descr = p_descr;
  708. oe.source_file = p_file;
  709. oe.source_line = p_line;
  710. oe.source_func = p_func;
  711. oe.warning = p_type == ERR_HANDLER_WARNING;
  712. uint64_t time = OS::get_singleton()->get_ticks_msec();
  713. oe.hr = time / 3600000;
  714. oe.min = (time / 60000) % 60;
  715. oe.sec = (time / 1000) % 60;
  716. oe.msec = time % 1000;
  717. Array cstack;
  718. cstack.resize(p_stack_info.size() * 3);
  719. for (int i = 0; i < p_stack_info.size(); i++) {
  720. cstack[i * 3 + 0] = p_stack_info[i].file;
  721. cstack[i * 3 + 1] = p_stack_info[i].func;
  722. cstack[i * 3 + 2] = p_stack_info[i].line;
  723. }
  724. oe.callstack = cstack;
  725. mutex->lock();
  726. if (!locking && tcp_client->is_connected_to_host()) {
  727. if (errors.size() >= max_errors_per_frame) {
  728. n_errors_dropped++;
  729. } else {
  730. errors.push_back(oe);
  731. }
  732. }
  733. mutex->unlock();
  734. }
  735. void ScriptDebuggerRemote::_print_handler(void *p_this, const String &p_string, bool p_error) {
  736. ScriptDebuggerRemote *sdr = (ScriptDebuggerRemote *)p_this;
  737. uint64_t ticks = OS::get_singleton()->get_ticks_usec() / 1000;
  738. sdr->msec_count += ticks - sdr->last_msec;
  739. sdr->last_msec = ticks;
  740. if (sdr->msec_count > 1000) {
  741. sdr->char_count = 0;
  742. sdr->msec_count = 0;
  743. }
  744. String s = p_string;
  745. int allowed_chars = MIN(MAX(sdr->max_cps - sdr->char_count, 0), s.length());
  746. if (allowed_chars == 0)
  747. return;
  748. if (allowed_chars < s.length()) {
  749. s = s.substr(0, allowed_chars);
  750. }
  751. sdr->char_count += allowed_chars;
  752. bool overflowed = sdr->char_count >= sdr->max_cps;
  753. sdr->mutex->lock();
  754. if (!sdr->locking && sdr->tcp_client->is_connected_to_host()) {
  755. if (overflowed)
  756. s += "[...]";
  757. sdr->output_strings.push_back(s);
  758. if (overflowed) {
  759. sdr->output_strings.push_back("[output overflow, print less text!]");
  760. }
  761. }
  762. sdr->mutex->unlock();
  763. }
  764. void ScriptDebuggerRemote::request_quit() {
  765. requested_quit = true;
  766. }
  767. void ScriptDebuggerRemote::set_request_scene_tree_message_func(RequestSceneTreeMessageFunc p_func, void *p_udata) {
  768. request_scene_tree = p_func;
  769. request_scene_tree_ud = p_udata;
  770. }
  771. void ScriptDebuggerRemote::set_live_edit_funcs(LiveEditFuncs *p_funcs) {
  772. live_edit_funcs = p_funcs;
  773. }
  774. bool ScriptDebuggerRemote::is_profiling() const {
  775. return profiling;
  776. }
  777. void ScriptDebuggerRemote::add_profiling_frame_data(const StringName &p_name, const Array &p_data) {
  778. int idx = -1;
  779. for (int i = 0; i < profile_frame_data.size(); i++) {
  780. if (profile_frame_data[i].name == p_name) {
  781. idx = i;
  782. break;
  783. }
  784. }
  785. FrameData fd;
  786. fd.name = p_name;
  787. fd.data = p_data;
  788. if (idx == -1) {
  789. profile_frame_data.push_back(fd);
  790. } else {
  791. profile_frame_data[idx] = fd;
  792. }
  793. }
  794. void ScriptDebuggerRemote::profiling_start() {
  795. //ignores this, uses it via connection
  796. }
  797. void ScriptDebuggerRemote::profiling_end() {
  798. //ignores this, uses it via connection
  799. }
  800. void ScriptDebuggerRemote::profiling_set_frame_times(float p_frame_time, float p_idle_time, float p_physics_time, float p_physics_frame_time) {
  801. frame_time = p_frame_time;
  802. idle_time = p_idle_time;
  803. physics_time = p_physics_time;
  804. physics_frame_time = p_physics_frame_time;
  805. }
  806. ScriptDebuggerRemote::ResourceUsageFunc ScriptDebuggerRemote::resource_usage_func = NULL;
  807. ScriptDebuggerRemote::ScriptDebuggerRemote() :
  808. profiling(false),
  809. max_frame_functions(16),
  810. skip_profile_frame(false),
  811. reload_all_scripts(false),
  812. tcp_client(StreamPeerTCP::create_ref()),
  813. packet_peer_stream(Ref<PacketPeerStream>(memnew(PacketPeerStream))),
  814. last_perf_time(0),
  815. performance(Engine::get_singleton()->get_singleton_object("Performance")),
  816. requested_quit(false),
  817. mutex(Mutex::create()),
  818. max_cps(GLOBAL_GET("network/limits/debugger_stdout/max_chars_per_second")),
  819. max_messages_per_frame(GLOBAL_GET("network/limits/debugger_stdout/max_messages_per_frame")),
  820. max_errors_per_frame(GLOBAL_GET("network/limits/debugger_stdout/max_errors_per_frame")),
  821. char_count(0),
  822. n_messages_dropped(0),
  823. n_errors_dropped(0),
  824. last_msec(0),
  825. msec_count(0),
  826. locking(false),
  827. poll_every(0),
  828. request_scene_tree(NULL),
  829. live_edit_funcs(NULL) {
  830. packet_peer_stream->set_stream_peer(tcp_client);
  831. packet_peer_stream->set_output_buffer_max_size(1024 * 1024 * 8); //8mb should be way more than enough
  832. phl.printfunc = _print_handler;
  833. phl.userdata = this;
  834. add_print_handler(&phl);
  835. eh.errfunc = _err_handler;
  836. eh.userdata = this;
  837. add_error_handler(&eh);
  838. profile_info.resize(CLAMP(int(ProjectSettings::get_singleton()->get("debug/settings/profiler/max_functions")), 128, 65535));
  839. profile_info_ptrs.resize(profile_info.size());
  840. }
  841. ScriptDebuggerRemote::~ScriptDebuggerRemote() {
  842. remove_print_handler(&phl);
  843. remove_error_handler(&eh);
  844. memdelete(mutex);
  845. }