Sergey Sharybin
73a199e96a
Currently unused, but will allow to keep of an owner of the depsgraph. Could also simplify other APIs in the future by avoiding to pass bmain explicitly to relation update functions and things like that.
391 lines
12 KiB
C++
391 lines
12 KiB
C++
/*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2014 Blender Foundation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup depsgraph
|
|
*
|
|
* Implementation of tools for debugging the depsgraph
|
|
*/
|
|
|
|
#include "BLI_utildefines.h"
|
|
#include "BLI_ghash.h"
|
|
|
|
extern "C" {
|
|
#include "DNA_scene_types.h"
|
|
} /* extern "C" */
|
|
|
|
#include "DNA_object_types.h"
|
|
|
|
#include "DEG_depsgraph.h"
|
|
#include "DEG_depsgraph_debug.h"
|
|
#include "DEG_depsgraph_build.h"
|
|
#include "DEG_depsgraph_query.h"
|
|
|
|
#include "intern/depsgraph.h"
|
|
#include "intern/depsgraph_type.h"
|
|
#include "intern/debug/deg_debug.h"
|
|
#include "intern/node/deg_node_component.h"
|
|
#include "intern/node/deg_node_id.h"
|
|
#include "intern/node/deg_node_time.h"
|
|
|
|
void DEG_debug_flags_set(Depsgraph *depsgraph, int flags)
|
|
{
|
|
DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(depsgraph);
|
|
deg_graph->debug_flags = flags;
|
|
}
|
|
|
|
int DEG_debug_flags_get(const Depsgraph *depsgraph)
|
|
{
|
|
const DEG::Depsgraph *deg_graph = reinterpret_cast<const DEG::Depsgraph *>(depsgraph);
|
|
return deg_graph->debug_flags;
|
|
}
|
|
|
|
void DEG_debug_name_set(struct Depsgraph *depsgraph, const char *name)
|
|
{
|
|
DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(depsgraph);
|
|
deg_graph->debug_name = name;
|
|
}
|
|
|
|
const char *DEG_debug_name_get(struct Depsgraph *depsgraph)
|
|
{
|
|
const DEG::Depsgraph *deg_graph = reinterpret_cast<const DEG::Depsgraph *>(depsgraph);
|
|
return deg_graph->debug_name.c_str();
|
|
}
|
|
|
|
bool DEG_debug_compare(const struct Depsgraph *graph1, const struct Depsgraph *graph2)
|
|
{
|
|
BLI_assert(graph1 != NULL);
|
|
BLI_assert(graph2 != NULL);
|
|
const DEG::Depsgraph *deg_graph1 = reinterpret_cast<const DEG::Depsgraph *>(graph1);
|
|
const DEG::Depsgraph *deg_graph2 = reinterpret_cast<const DEG::Depsgraph *>(graph2);
|
|
if (deg_graph1->operations.size() != deg_graph2->operations.size()) {
|
|
return false;
|
|
}
|
|
/* TODO(sergey): Currently we only do real stupid check,
|
|
* which is fast but which isn't 100% reliable.
|
|
*
|
|
* Would be cool to make it more robust, but it's good enough
|
|
* for now. Also, proper graph check is actually NP-complex
|
|
* problem. */
|
|
return true;
|
|
}
|
|
|
|
bool DEG_debug_graph_relations_validate(Depsgraph *graph,
|
|
Main *bmain,
|
|
Scene *scene,
|
|
ViewLayer *view_layer)
|
|
{
|
|
Depsgraph *temp_depsgraph = DEG_graph_new(bmain, scene, view_layer, DEG_get_mode(graph));
|
|
bool valid = true;
|
|
DEG_graph_build_from_view_layer(temp_depsgraph, bmain, scene, view_layer);
|
|
if (!DEG_debug_compare(temp_depsgraph, graph)) {
|
|
fprintf(stderr, "ERROR! Depsgraph wasn't tagged for update when it should have!\n");
|
|
BLI_assert(!"This should not happen!");
|
|
valid = false;
|
|
}
|
|
DEG_graph_free(temp_depsgraph);
|
|
return valid;
|
|
}
|
|
|
|
bool DEG_debug_consistency_check(Depsgraph *graph)
|
|
{
|
|
const DEG::Depsgraph *deg_graph = reinterpret_cast<const DEG::Depsgraph *>(graph);
|
|
/* Validate links exists in both directions. */
|
|
for (DEG::OperationNode *node : deg_graph->operations) {
|
|
for (DEG::Relation *rel : node->outlinks) {
|
|
int counter1 = 0;
|
|
for (DEG::Relation *tmp_rel : node->outlinks) {
|
|
if (tmp_rel == rel) {
|
|
counter1++;
|
|
}
|
|
}
|
|
int counter2 = 0;
|
|
for (DEG::Relation *tmp_rel : rel->to->inlinks) {
|
|
if (tmp_rel == rel) {
|
|
counter2++;
|
|
}
|
|
}
|
|
if (counter1 != counter2) {
|
|
printf(
|
|
"Relation exists in outgoing direction but not in "
|
|
"incoming (%d vs. %d).\n",
|
|
counter1,
|
|
counter2);
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
for (DEG::OperationNode *node : deg_graph->operations) {
|
|
for (DEG::Relation *rel : node->inlinks) {
|
|
int counter1 = 0;
|
|
for (DEG::Relation *tmp_rel : node->inlinks) {
|
|
if (tmp_rel == rel) {
|
|
counter1++;
|
|
}
|
|
}
|
|
int counter2 = 0;
|
|
for (DEG::Relation *tmp_rel : rel->from->outlinks) {
|
|
if (tmp_rel == rel) {
|
|
counter2++;
|
|
}
|
|
}
|
|
if (counter1 != counter2) {
|
|
printf("Relation exists in incoming direction but not in outcoming (%d vs. %d).\n",
|
|
counter1,
|
|
counter2);
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Validate node valency calculated in both directions. */
|
|
for (DEG::OperationNode *node : deg_graph->operations) {
|
|
node->num_links_pending = 0;
|
|
node->custom_flags = 0;
|
|
}
|
|
|
|
for (DEG::OperationNode *node : deg_graph->operations) {
|
|
if (node->custom_flags) {
|
|
printf("Node %s is twice in the operations!\n", node->identifier().c_str());
|
|
return false;
|
|
}
|
|
for (DEG::Relation *rel : node->outlinks) {
|
|
if (rel->to->type == DEG::NodeType::OPERATION) {
|
|
DEG::OperationNode *to = (DEG::OperationNode *)rel->to;
|
|
BLI_assert(to->num_links_pending < to->inlinks.size());
|
|
++to->num_links_pending;
|
|
}
|
|
}
|
|
node->custom_flags = 1;
|
|
}
|
|
|
|
for (DEG::OperationNode *node : deg_graph->operations) {
|
|
int num_links_pending = 0;
|
|
for (DEG::Relation *rel : node->inlinks) {
|
|
if (rel->from->type == DEG::NodeType::OPERATION) {
|
|
num_links_pending++;
|
|
}
|
|
}
|
|
if (node->num_links_pending != num_links_pending) {
|
|
printf("Valency mismatch: %s, %u != %d\n",
|
|
node->identifier().c_str(),
|
|
node->num_links_pending,
|
|
num_links_pending);
|
|
printf("Number of inlinks: %d\n", (int)node->inlinks.size());
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/* ------------------------------------------------ */
|
|
|
|
/**
|
|
* Obtain simple statistics about the complexity of the depsgraph
|
|
* \param[out] r_outer The number of outer nodes in the graph
|
|
* \param[out] r_operations The number of operation nodes in the graph
|
|
* \param[out] r_relations The number of relations between (executable) nodes in the graph
|
|
*/
|
|
void DEG_stats_simple(const Depsgraph *graph,
|
|
size_t *r_outer,
|
|
size_t *r_operations,
|
|
size_t *r_relations)
|
|
{
|
|
const DEG::Depsgraph *deg_graph = reinterpret_cast<const DEG::Depsgraph *>(graph);
|
|
|
|
/* number of operations */
|
|
if (r_operations) {
|
|
/* All operations should be in this list, allowing us to count the total
|
|
* number of nodes. */
|
|
*r_operations = deg_graph->operations.size();
|
|
}
|
|
|
|
/* Count number of outer nodes and/or relations between these. */
|
|
if (r_outer || r_relations) {
|
|
size_t tot_outer = 0;
|
|
size_t tot_rels = 0;
|
|
|
|
for (DEG::IDNode *id_node : deg_graph->id_nodes) {
|
|
tot_outer++;
|
|
GHASH_FOREACH_BEGIN (DEG::ComponentNode *, comp_node, id_node->components) {
|
|
tot_outer++;
|
|
for (DEG::OperationNode *op_node : comp_node->operations) {
|
|
tot_rels += op_node->inlinks.size();
|
|
}
|
|
}
|
|
GHASH_FOREACH_END();
|
|
}
|
|
|
|
DEG::TimeSourceNode *time_source = deg_graph->find_time_source();
|
|
if (time_source != NULL) {
|
|
tot_rels += time_source->inlinks.size();
|
|
}
|
|
|
|
if (r_relations) {
|
|
*r_relations = tot_rels;
|
|
}
|
|
if (r_outer) {
|
|
*r_outer = tot_outer;
|
|
}
|
|
}
|
|
}
|
|
|
|
bool DEG_debug_is_evaluating(struct Depsgraph *depsgraph)
|
|
{
|
|
DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(depsgraph);
|
|
return deg_graph->debug_is_evaluating;
|
|
}
|
|
|
|
static DEG::string depsgraph_name_for_logging(struct Depsgraph *depsgraph)
|
|
{
|
|
const char *name = DEG_debug_name_get(depsgraph);
|
|
if (name[0] == '\0') {
|
|
return "";
|
|
}
|
|
return "[" + DEG::string(name) + "]: ";
|
|
}
|
|
|
|
void DEG_debug_print_begin(struct Depsgraph *depsgraph)
|
|
{
|
|
fprintf(stdout, "%s", depsgraph_name_for_logging(depsgraph).c_str());
|
|
}
|
|
|
|
void DEG_debug_print_eval(struct Depsgraph *depsgraph,
|
|
const char *function_name,
|
|
const char *object_name,
|
|
const void *object_address)
|
|
{
|
|
if ((DEG_debug_flags_get(depsgraph) & G_DEBUG_DEPSGRAPH_EVAL) == 0) {
|
|
return;
|
|
}
|
|
fprintf(stdout,
|
|
"%s%s on %s %s(%p)%s\n",
|
|
depsgraph_name_for_logging(depsgraph).c_str(),
|
|
function_name,
|
|
object_name,
|
|
DEG::color_for_pointer(object_address).c_str(),
|
|
object_address,
|
|
DEG::color_end().c_str());
|
|
fflush(stdout);
|
|
}
|
|
|
|
void DEG_debug_print_eval_subdata(struct Depsgraph *depsgraph,
|
|
const char *function_name,
|
|
const char *object_name,
|
|
const void *object_address,
|
|
const char *subdata_comment,
|
|
const char *subdata_name,
|
|
const void *subdata_address)
|
|
{
|
|
if ((DEG_debug_flags_get(depsgraph) & G_DEBUG_DEPSGRAPH_EVAL) == 0) {
|
|
return;
|
|
}
|
|
fprintf(stdout,
|
|
"%s%s on %s %s(%p)%s %s %s %s(%p)%s\n",
|
|
depsgraph_name_for_logging(depsgraph).c_str(),
|
|
function_name,
|
|
object_name,
|
|
DEG::color_for_pointer(object_address).c_str(),
|
|
object_address,
|
|
DEG::color_end().c_str(),
|
|
subdata_comment,
|
|
subdata_name,
|
|
DEG::color_for_pointer(subdata_address).c_str(),
|
|
subdata_address,
|
|
DEG::color_end().c_str());
|
|
fflush(stdout);
|
|
}
|
|
|
|
void DEG_debug_print_eval_subdata_index(struct Depsgraph *depsgraph,
|
|
const char *function_name,
|
|
const char *object_name,
|
|
const void *object_address,
|
|
const char *subdata_comment,
|
|
const char *subdata_name,
|
|
const void *subdata_address,
|
|
const int subdata_index)
|
|
{
|
|
if ((DEG_debug_flags_get(depsgraph) & G_DEBUG_DEPSGRAPH_EVAL) == 0) {
|
|
return;
|
|
}
|
|
fprintf(stdout,
|
|
"%s%s on %s %s(%p)%s %s %s[%d] %s(%p)%s\n",
|
|
depsgraph_name_for_logging(depsgraph).c_str(),
|
|
function_name,
|
|
object_name,
|
|
DEG::color_for_pointer(object_address).c_str(),
|
|
object_address,
|
|
DEG::color_end().c_str(),
|
|
subdata_comment,
|
|
subdata_name,
|
|
subdata_index,
|
|
DEG::color_for_pointer(subdata_address).c_str(),
|
|
subdata_address,
|
|
DEG::color_end().c_str());
|
|
fflush(stdout);
|
|
}
|
|
|
|
void DEG_debug_print_eval_parent_typed(struct Depsgraph *depsgraph,
|
|
const char *function_name,
|
|
const char *object_name,
|
|
const void *object_address,
|
|
const char *parent_comment,
|
|
const char *parent_name,
|
|
const void *parent_address)
|
|
{
|
|
if ((DEG_debug_flags_get(depsgraph) & G_DEBUG_DEPSGRAPH_EVAL) == 0) {
|
|
return;
|
|
}
|
|
fprintf(stdout,
|
|
"%s%s on %s %s(%p) [%s] %s %s %s(%p)%s\n",
|
|
depsgraph_name_for_logging(depsgraph).c_str(),
|
|
function_name,
|
|
object_name,
|
|
DEG::color_for_pointer(object_address).c_str(),
|
|
object_address,
|
|
DEG::color_end().c_str(),
|
|
parent_comment,
|
|
parent_name,
|
|
DEG::color_for_pointer(parent_address).c_str(),
|
|
parent_address,
|
|
DEG::color_end().c_str());
|
|
fflush(stdout);
|
|
}
|
|
|
|
void DEG_debug_print_eval_time(struct Depsgraph *depsgraph,
|
|
const char *function_name,
|
|
const char *object_name,
|
|
const void *object_address,
|
|
float time)
|
|
{
|
|
if ((DEG_debug_flags_get(depsgraph) & G_DEBUG_DEPSGRAPH_EVAL) == 0) {
|
|
return;
|
|
}
|
|
fprintf(stdout,
|
|
"%s%s on %s %s(%p)%s at time %f\n",
|
|
depsgraph_name_for_logging(depsgraph).c_str(),
|
|
function_name,
|
|
object_name,
|
|
DEG::color_for_pointer(object_address).c_str(),
|
|
object_address,
|
|
DEG::color_end().c_str(),
|
|
time);
|
|
fflush(stdout);
|
|
}
|