profiler.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2024 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include "BLI_timeit.hh"
 
#include "DNA_node_types.h"
 
#include "BKE_node.hh"
 
#include "NOD_derived_node_tree.hh"
 
#include "COM_context.hh"
#include "COM_profiler.hh"
 
namespace blender::realtime_compositor {
 
Map<bNodeInstanceKey, timeit::Nanoseconds> &Profiler::get_nodes_evaluation_times()
{
  return nodes_evaluation_times_;
}
 
void Profiler::set_node_evaluation_time(bNodeInstanceKey node_instance_key,
                                        timeit::Nanoseconds time)
{
  nodes_evaluation_times_.lookup_or_add(node_instance_key, timeit::Nanoseconds::zero()) += time;
}
 
timeit::Nanoseconds Profiler::accumulate_node_group_times(const bNodeTree &node_tree,
                                                          bNodeInstanceKey instance_key)
{
  timeit::Nanoseconds tree_evaluation_time = timeit::Nanoseconds::zero();
 
  for (const bNode *node : node_tree.all_nodes()) {
    const bNodeInstanceKey node_instance_key = bke::node_instance_key(
        instance_key, &node_tree, node);
    if (!node->is_group()) {
      /* Non-group node, no need to recurse into. Simply accumulate the node's evaluation time to
       * the current tree's evaluation time. Note that not every node might have an evaluation
       * time stored, so default to zero. See the documentation on nodes_evaluation_times_ for more
       * information. */
      tree_evaluation_time += nodes_evaluation_times_.lookup_default(node_instance_key,
                                                                     timeit::Nanoseconds::zero());
      continue;
    }
 
    const bNodeTree *child_tree = reinterpret_cast<bNodeTree *>(node->id);
    if (child_tree == nullptr) {
      /* Node group has lost link to its node tree. For example, due to missing linked file. */
      continue;
    }
 
    const timeit::Nanoseconds group_execution_time = this->accumulate_node_group_times(
        *child_tree, node_instance_key);
 
    /* Set evaluation time of the group node. */
    this->set_node_evaluation_time(node_instance_key, group_execution_time);
 
    /* Add group evaluation time to the overall tree execution time. */
    tree_evaluation_time += group_execution_time;
  }
 
  return tree_evaluation_time;
}
 
void Profiler::finalize(const bNodeTree &node_tree)
{
  /* Compute the evaluation time of all node groups starting from the root tree. */
  this->accumulate_node_group_times(node_tree, bke::NODE_INSTANCE_KEY_BASE);
}
 
}  // namespace blender::realtime_compositor