78f1543e35
A new tab is added to the debugger that can help profile a game's memory usage. Specifically, this lets you save a snapshot of all the objects in a running game's ObjectDB to disk. It then lets you view the snapshot and diff two snapshots against each other. This is meant to work similarly to Chrome's heap snapshot tool or Unity's memory profiler.
262 lines
11 KiB
C++
262 lines
11 KiB
C++
/**************************************************************************/
|
|
/* node_view.cpp */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#include "node_view.h"
|
|
|
|
#include "editor/editor_node.h"
|
|
#include "editor/themes/editor_scale.h"
|
|
#include "scene/gui/check_button.h"
|
|
#include "scene/gui/split_container.h"
|
|
|
|
SnapshotNodeView::SnapshotNodeView() {
|
|
set_name("Nodes");
|
|
}
|
|
|
|
void SnapshotNodeView::show_snapshot(GameStateSnapshot *p_data, GameStateSnapshot *p_diff_data) {
|
|
SnapshotView::show_snapshot(p_data, p_diff_data);
|
|
|
|
set_v_size_flags(SizeFlags::SIZE_EXPAND_FILL);
|
|
set_h_size_flags(SizeFlags::SIZE_EXPAND_FILL);
|
|
|
|
HSplitContainer *diff_sides = memnew(HSplitContainer);
|
|
diff_sides->set_anchors_preset(LayoutPreset::PRESET_FULL_RECT);
|
|
add_child(diff_sides);
|
|
|
|
bool show_diff_label = diff_data && combined_diff_view;
|
|
main_tree = _make_node_tree(diff_data && !combined_diff_view ? TTR("A Nodes") : TTR("Nodes"), snapshot_data);
|
|
diff_sides->add_child(main_tree.root);
|
|
_add_snapshot_to_tree(main_tree.tree, snapshot_data, show_diff_label ? "-" : "");
|
|
|
|
if (diff_data) {
|
|
CheckButton *diff_mode_toggle = memnew(CheckButton(TTR("Combine Diff")));
|
|
diff_mode_toggle->set_pressed(combined_diff_view);
|
|
diff_mode_toggle->connect(SceneStringName(toggled), callable_mp(this, &SnapshotNodeView::_toggle_diff_mode));
|
|
main_tree.filter_bar->add_child(diff_mode_toggle);
|
|
main_tree.filter_bar->move_child(diff_mode_toggle, 0);
|
|
|
|
if (combined_diff_view) {
|
|
// Merge the snapshots together and add a diff.
|
|
_add_snapshot_to_tree(main_tree.tree, diff_data, "+");
|
|
} else {
|
|
// Add a second column with the diff snapshot.
|
|
diff_tree = _make_node_tree(TTR("B Nodes"), diff_data);
|
|
diff_sides->add_child(diff_tree.root);
|
|
_add_snapshot_to_tree(diff_tree.tree, diff_data, "");
|
|
}
|
|
}
|
|
|
|
_refresh_icons();
|
|
main_tree.filter_bar->apply();
|
|
if (diff_tree.filter_bar) {
|
|
diff_tree.filter_bar->apply();
|
|
diff_sides->set_split_offset(diff_sides->get_size().x * 0.5);
|
|
}
|
|
|
|
choose_object_menu = memnew(PopupMenu);
|
|
add_child(choose_object_menu);
|
|
choose_object_menu->connect(SceneStringName(id_pressed), callable_mp(this, &SnapshotNodeView::_choose_object_pressed).bind(false));
|
|
}
|
|
|
|
NodeTreeElements SnapshotNodeView::_make_node_tree(const String &p_tree_name, GameStateSnapshot *p_snapshot) {
|
|
NodeTreeElements elements;
|
|
elements.root = memnew(VBoxContainer);
|
|
elements.root->set_anchors_preset(LayoutPreset::PRESET_FULL_RECT);
|
|
elements.tree = memnew(Tree);
|
|
elements.filter_bar = memnew(TreeSortAndFilterBar(elements.tree, TTR("Filter Nodes")));
|
|
elements.root->add_child(elements.filter_bar);
|
|
elements.tree->set_select_mode(Tree::SelectMode::SELECT_ROW);
|
|
elements.tree->set_custom_minimum_size(Size2(150, 0) * EDSCALE);
|
|
elements.tree->set_hide_folding(false);
|
|
elements.root->add_child(elements.tree);
|
|
elements.tree->set_hide_root(true);
|
|
elements.tree->set_allow_reselect(true);
|
|
elements.tree->set_columns(1);
|
|
elements.tree->set_column_titles_visible(true);
|
|
elements.tree->set_column_title(0, p_tree_name);
|
|
elements.tree->set_column_expand(0, true);
|
|
elements.tree->set_column_clip_content(0, false);
|
|
elements.tree->set_column_custom_minimum_width(0, 150 * EDSCALE);
|
|
elements.tree->connect(SceneStringName(item_selected), callable_mp(this, &SnapshotNodeView::_node_selected).bind(elements.tree));
|
|
elements.tree->set_h_size_flags(SizeFlags::SIZE_EXPAND_FILL);
|
|
elements.tree->set_v_size_flags(SizeFlags::SIZE_EXPAND_FILL);
|
|
elements.tree->set_anchors_preset(LayoutPreset::PRESET_FULL_RECT);
|
|
|
|
elements.tree->create_item();
|
|
|
|
return elements;
|
|
}
|
|
|
|
void SnapshotNodeView::_node_selected(Tree *p_tree_selected_from) {
|
|
active_tree = p_tree_selected_from;
|
|
if (diff_tree.tree) {
|
|
// Deselect nodes in non-active tree, if needed.
|
|
if (active_tree == main_tree.tree) {
|
|
diff_tree.tree->deselect_all();
|
|
}
|
|
if (active_tree == diff_tree.tree) {
|
|
main_tree.tree->deselect_all();
|
|
}
|
|
}
|
|
|
|
List<SnapshotDataObject *> &objects = tree_item_owners[p_tree_selected_from->get_selected()];
|
|
if (objects.is_empty()) {
|
|
return;
|
|
}
|
|
if (objects.size() == 1) {
|
|
EditorNode::get_singleton()->push_item((Object *)(objects.get(0)));
|
|
}
|
|
if (objects.size() == 2) {
|
|
// This happens if we're in the combined diff view and the node exists in both trees
|
|
// The user has to specify which version of the node they want to see in the inspector.
|
|
_show_choose_object_menu();
|
|
}
|
|
}
|
|
|
|
void SnapshotNodeView::_toggle_diff_mode(bool p_state) {
|
|
combined_diff_view = p_state;
|
|
show_snapshot(snapshot_data, diff_data); // Redraw everything when we toggle views.
|
|
}
|
|
|
|
void SnapshotNodeView::_notification(int p_what) {
|
|
switch (p_what) {
|
|
case NOTIFICATION_ENTER_TREE:
|
|
case NOTIFICATION_LAYOUT_DIRECTION_CHANGED:
|
|
case NOTIFICATION_THEME_CHANGED:
|
|
case NOTIFICATION_TRANSLATION_CHANGED: {
|
|
_refresh_icons();
|
|
} break;
|
|
}
|
|
}
|
|
|
|
void SnapshotNodeView::_add_snapshot_to_tree(Tree *p_tree, GameStateSnapshot *p_snapshot, const String &p_diff_group_name) {
|
|
for (const KeyValue<ObjectID, SnapshotDataObject *> &kv : p_snapshot->objects) {
|
|
if (kv.value->is_node() && !kv.value->extra_debug_data.has("node_parent")) {
|
|
TreeItem *root_item = _add_child_named(p_tree, p_tree->get_root(), kv.value, p_diff_group_name);
|
|
_add_object_to_tree(root_item, kv.value, p_diff_group_name);
|
|
}
|
|
}
|
|
}
|
|
|
|
void SnapshotNodeView::_add_object_to_tree(TreeItem *p_parent_item, SnapshotDataObject *p_data, const String &p_diff_group_name) {
|
|
for (const Variant &v : (Array)p_data->extra_debug_data["node_children"]) {
|
|
SnapshotDataObject *child_object = p_data->snapshot->objects[ObjectID((uint64_t)v)];
|
|
TreeItem *child_item = _add_child_named(p_parent_item->get_tree(), p_parent_item, child_object, p_diff_group_name);
|
|
_add_object_to_tree(child_item, child_object, p_diff_group_name);
|
|
}
|
|
}
|
|
|
|
TreeItem *SnapshotNodeView::_add_child_named(Tree *p_tree, TreeItem *p_item, SnapshotDataObject *p_item_owner, const String &p_diff_group_name) {
|
|
bool has_group = !p_diff_group_name.is_empty();
|
|
const String &item_name = p_item_owner->extra_debug_data["node_name"];
|
|
// Find out if this node already exists.
|
|
TreeItem *child_item = nullptr;
|
|
if (has_group) {
|
|
for (int idx = 0; idx < p_item->get_child_count(); idx++) {
|
|
TreeItem *child = p_item->get_child(idx);
|
|
if (child->get_text(0) == item_name) {
|
|
child_item = child;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (child_item) {
|
|
// If it exists, clear the background color because we now know it exists in both trees.
|
|
child_item->clear_custom_bg_color(0);
|
|
} else {
|
|
// Add the new node and set it's background color to green or red depending on which snapshot it's a part of.
|
|
if (p_item_owner->extra_debug_data["node_is_scene_root"]) {
|
|
child_item = p_tree->get_root() ? p_tree->get_root() : p_tree->create_item();
|
|
} else {
|
|
child_item = p_tree->create_item(p_item);
|
|
}
|
|
if (has_group) {
|
|
if (p_diff_group_name == "+") {
|
|
child_item->set_custom_bg_color(0, Color(0, 1, 0, 0.1));
|
|
}
|
|
if (p_diff_group_name == "-") {
|
|
child_item->set_custom_bg_color(0, Color(1, 0, 0, 0.1));
|
|
}
|
|
}
|
|
}
|
|
|
|
child_item->set_text(0, item_name);
|
|
_add_tree_item_owner(child_item, p_item_owner);
|
|
return child_item;
|
|
}
|
|
|
|
// Each node in the tree may be part of one or two snapshots. This tracks that relationship
|
|
// so we can display the correct data in the inspector if a node is clicked.
|
|
void SnapshotNodeView::_add_tree_item_owner(TreeItem *p_item, SnapshotDataObject *p_owner) {
|
|
if (!tree_item_owners.has(p_item)) {
|
|
tree_item_owners.insert(p_item, List<SnapshotDataObject *>());
|
|
}
|
|
tree_item_owners[p_item].push_back(p_owner);
|
|
}
|
|
|
|
void SnapshotNodeView::_refresh_icons() {
|
|
for (TreeItem *item : _get_children_recursive(main_tree.tree)) {
|
|
item->set_icon(0, EditorNode::get_singleton()->get_class_icon(tree_item_owners[item].get(0)->type_name, ""));
|
|
}
|
|
if (diff_tree.tree) {
|
|
for (TreeItem *item : _get_children_recursive(diff_tree.tree)) {
|
|
item->set_icon(0, EditorNode::get_singleton()->get_class_icon(tree_item_owners[item].get(0)->type_name, ""));
|
|
}
|
|
}
|
|
}
|
|
|
|
void SnapshotNodeView::clear_snapshot() {
|
|
SnapshotView::clear_snapshot();
|
|
|
|
tree_item_owners.clear();
|
|
main_tree.tree = nullptr;
|
|
main_tree.filter_bar = nullptr;
|
|
main_tree.root = nullptr;
|
|
diff_tree.tree = nullptr;
|
|
diff_tree.filter_bar = nullptr;
|
|
diff_tree.root = nullptr;
|
|
active_tree = nullptr;
|
|
}
|
|
|
|
void SnapshotNodeView::_choose_object_pressed(int p_object_idx, bool p_confirm_override) {
|
|
List<SnapshotDataObject *> &objects = tree_item_owners[active_tree->get_selected()];
|
|
EditorNode::get_singleton()->push_item((Object *)objects.get(p_object_idx));
|
|
}
|
|
|
|
void SnapshotNodeView::_show_choose_object_menu() {
|
|
remove_child(choose_object_menu);
|
|
add_child(choose_object_menu);
|
|
choose_object_menu->clear(false);
|
|
choose_object_menu->add_item(TTR("Snapshot A"), 0);
|
|
choose_object_menu->add_item(TTR("Snapshot B"), 1);
|
|
choose_object_menu->reset_size();
|
|
choose_object_menu->set_position(get_screen_position() + get_local_mouse_position());
|
|
choose_object_menu->popup();
|
|
}
|