script_debugger_remote.cpp 32 KB

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