This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/blender/depsgraph/intern/builder/deg_builder_stack.cc
Sergey Sharybin 2da7977e3e Depsgraph: Implement backtrace functionality
The goal is to make it easier to track down sources of errors during
the dependency graph builder.

With this change whenever a relation can not be added a trace to the
entity which requested the relation will be printed. For example:

```
Failed to add relation "Copy Location"
Could not find op_from: OperationKey(type: BONE, component name: 'MissingBone', operation code: BONE_DONE)

Trace:

Depth    Type                     Name
-----    ----                     ----
1        Object                   Armature.001
2        Pose Channel             Bone
3        Constraint               Copy Location
```

On an implementation detail traced places where `checkIsBuiltAndTag`
is called, with some additional places to help tracking pose channels,
constraints, and modifiers.

Further improvements in granularity are possible, but that could happen
as a followup development once the core part is proven to work.

An example of such improvement would be to have entries in the trace
which will indicate NLA and drivers building. Currently it might be
a bit confusing to see IDs in the trace referenced from driver.

Even with such limitation the current state of the patch brings a
very valuable information (some information is much better than no
information at all).

Differential Revision: https://developer.blender.org/D15017
2022-05-24 14:48:51 +02:00

95 lines
2.4 KiB
C++

/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2022 Blender Foundation. All rights reserved. */
/** \file
* \ingroup depsgraph
*/
#include "intern/builder/deg_builder_stack.h"
#include <iomanip>
#include <ios>
#include <iostream>
#include "BKE_idtype.h"
#include "DNA_ID.h"
#include "DNA_action_types.h"
#include "DNA_constraint_types.h"
#include "DNA_modifier_types.h"
namespace blender::deg {
/* Spacing between adjacent columns, in number of spaces. */
constexpr int kColumnSpacing = 4;
/* Width of table columns including column padding.
* The type column width is a guesstimate based on "Particle Settings" with some extra padding. */
constexpr int kPrintDepthWidth = 5 + kColumnSpacing;
constexpr int kPrintTypeWidth = 21 + kColumnSpacing;
namespace {
/* NOTE: Depth column printing is already taken care of. */
void print(std::ostream &stream, const ID *id)
{
const IDTypeInfo *id_type_info = BKE_idtype_get_info_from_id(id);
stream << std::setw(kPrintTypeWidth) << id_type_info->name << (id->name + 2) << "\n";
}
void print(std::ostream &stream, const bConstraint *constraint)
{
stream << std::setw(kPrintTypeWidth) << ("Constraint") << constraint->name << "\n";
}
void print(std::ostream &stream, const ModifierData *modifier_data)
{
stream << std::setw(kPrintTypeWidth) << ("Modifier") << modifier_data->name << "\n";
}
void print(std::ostream &stream, const bPoseChannel *pchan)
{
stream << std::setw(kPrintTypeWidth) << ("Pose Channel") << pchan->name << "\n";
}
} // namespace
void BuilderStack::print_backtrace(std::ostream &stream)
{
const std::ios_base::fmtflags old_flags(stream.flags());
stream << std::left;
stream << std::setw(kPrintDepthWidth) << "Depth" << std::setw(kPrintTypeWidth) << "Type"
<< "Name"
<< "\n";
stream << std::setw(kPrintDepthWidth) << "-----" << std::setw(kPrintTypeWidth) << "----"
<< "----"
<< "\n";
int depth = 1;
for (const Entry &entry : stack_) {
stream << std::setw(kPrintDepthWidth) << depth;
++depth;
if (entry.id_ != nullptr) {
print(stream, entry.id_);
}
else if (entry.constraint_ != nullptr) {
print(stream, entry.constraint_);
}
else if (entry.modifier_data_ != nullptr) {
print(stream, entry.modifier_data_);
}
else if (entry.pchan_ != nullptr) {
print(stream, entry.pchan_);
}
}
stream.flags(old_flags);
}
} // namespace blender::deg