e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
152 lines
3.3 KiB
C++
152 lines
3.3 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*
|
|
* Task graph.
|
|
*/
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
#include "BLI_task.h"
|
|
|
|
#include <memory>
|
|
#include <vector>
|
|
|
|
#ifdef WITH_TBB
|
|
# include <tbb/flow_graph.h>
|
|
#endif
|
|
|
|
/* Task Graph */
|
|
struct TaskGraph {
|
|
#ifdef WITH_TBB
|
|
tbb::flow::graph tbb_graph;
|
|
#endif
|
|
std::vector<std::unique_ptr<TaskNode>> nodes;
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("task_graph:TaskGraph")
|
|
#endif
|
|
};
|
|
|
|
/* TaskNode - a node in the task graph. */
|
|
struct TaskNode {
|
|
/* TBB Node. */
|
|
#ifdef WITH_TBB
|
|
tbb::flow::continue_node<tbb::flow::continue_msg> tbb_node;
|
|
#endif
|
|
/* Successors to execute after this task, for serial execution fallback. */
|
|
std::vector<TaskNode *> successors;
|
|
|
|
/* User function to be executed with given task data. */
|
|
TaskGraphNodeRunFunction run_func;
|
|
void *task_data;
|
|
/* Optional callback to free task data along with the graph. If task data
|
|
* is shared between nodes, only a single task node should free the data. */
|
|
TaskGraphNodeFreeFunction free_func;
|
|
|
|
TaskNode(TaskGraph *task_graph,
|
|
TaskGraphNodeRunFunction run_func,
|
|
void *task_data,
|
|
TaskGraphNodeFreeFunction free_func)
|
|
:
|
|
#ifdef WITH_TBB
|
|
tbb_node(task_graph->tbb_graph,
|
|
tbb::flow::unlimited,
|
|
[&](const tbb::flow::continue_msg input) { run(input); }),
|
|
#endif
|
|
run_func(run_func),
|
|
task_data(task_data),
|
|
free_func(free_func)
|
|
{
|
|
#ifndef WITH_TBB
|
|
UNUSED_VARS(task_graph);
|
|
#endif
|
|
}
|
|
|
|
TaskNode(const TaskNode &other) = delete;
|
|
TaskNode &operator=(const TaskNode &other) = delete;
|
|
|
|
~TaskNode()
|
|
{
|
|
if (task_data && free_func) {
|
|
free_func(task_data);
|
|
}
|
|
}
|
|
|
|
#ifdef WITH_TBB
|
|
tbb::flow::continue_msg run(const tbb::flow::continue_msg /*input*/)
|
|
{
|
|
run_func(task_data);
|
|
return tbb::flow::continue_msg();
|
|
}
|
|
#endif
|
|
|
|
void run_serial()
|
|
{
|
|
run_func(task_data);
|
|
for (TaskNode *successor : successors) {
|
|
successor->run_serial();
|
|
}
|
|
}
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("task_graph:TaskNode")
|
|
#endif
|
|
};
|
|
|
|
TaskGraph *BLI_task_graph_create()
|
|
{
|
|
return new TaskGraph();
|
|
}
|
|
|
|
void BLI_task_graph_free(TaskGraph *task_graph)
|
|
{
|
|
delete task_graph;
|
|
}
|
|
|
|
void BLI_task_graph_work_and_wait(TaskGraph *task_graph)
|
|
{
|
|
#ifdef WITH_TBB
|
|
task_graph->tbb_graph.wait_for_all();
|
|
#else
|
|
UNUSED_VARS(task_graph);
|
|
#endif
|
|
}
|
|
|
|
TaskNode *BLI_task_graph_node_create(TaskGraph *task_graph,
|
|
TaskGraphNodeRunFunction run,
|
|
void *user_data,
|
|
TaskGraphNodeFreeFunction free_func)
|
|
{
|
|
TaskNode *task_node = new TaskNode(task_graph, run, user_data, free_func);
|
|
task_graph->nodes.push_back(std::unique_ptr<TaskNode>(task_node));
|
|
return task_node;
|
|
}
|
|
|
|
bool BLI_task_graph_node_push_work(TaskNode *task_node)
|
|
{
|
|
#ifdef WITH_TBB
|
|
if (BLI_task_scheduler_num_threads() > 1) {
|
|
return task_node->tbb_node.try_put(tbb::flow::continue_msg());
|
|
}
|
|
#endif
|
|
|
|
task_node->run_serial();
|
|
return true;
|
|
}
|
|
|
|
void BLI_task_graph_edge_create(TaskNode *from_node, TaskNode *to_node)
|
|
{
|
|
#ifdef WITH_TBB
|
|
if (BLI_task_scheduler_num_threads() > 1) {
|
|
tbb::flow::make_edge(from_node->tbb_node, to_node->tbb_node);
|
|
return;
|
|
}
|
|
#endif
|
|
|
|
from_node->successors.push_back(to_node);
|
|
}
|