Improving NodeGraph::getNodeDef performance #2933
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| // | ||
| // Copyright Contributors to the MaterialX Project | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
|
|
||
| #include <MaterialXTest/External/Catch/catch.hpp> | ||
|
|
||
| #ifdef CATCH_CONFIG_ENABLE_BENCHMARKING | ||
|
|
||
| #include <MaterialXCore/Definition.h> | ||
| #include <MaterialXCore/Document.h> | ||
| #include <MaterialXCore/Node.h> | ||
|
|
||
| namespace mx = MaterialX; | ||
|
|
||
| // Build a document that scales the two axes feeding NodeGraph::getNodeDef | ||
| // from PortElement::validate: | ||
| // * numImplStubs - document-root <implementation> elements; sizes the | ||
| // Document::Cache nodegraph -> implementation map. | ||
| // * numNodegraphRefs - inputs that resolve through a nodegraph; each one | ||
| // performs a cache lookup. | ||
| static mx::DocumentPtr buildScalingDocument(size_t numImplStubs, size_t numNodegraphRefs) | ||
| { | ||
| mx::DocumentPtr doc = mx::createDocument(); | ||
|
|
||
| // A nodegraph with one internal node and one output, so that | ||
| // PortElement::getConnectedNode() resolves transitively through the | ||
| // output (see Input::getConnectedNode in Interface.cpp). | ||
| mx::NodeGraphPtr ng = doc->addNodeGraph("ng"); | ||
| mx::NodePtr inner = ng->addNode("constant", "inner", "color3"); | ||
| mx::OutputPtr out = ng->addOutput("out", "color3"); | ||
| out->setNodeName(inner->getName()); | ||
|
|
||
| // A host node parenting many inputs that reference the nodegraph. | ||
| mx::NodePtr host = doc->addNode("surface", "host", "surfaceshader"); | ||
| for (size_t i = 0; i < numNodegraphRefs; ++i) | ||
| { | ||
| mx::InputPtr in = host->addInput("in" + std::to_string(i), "color3"); | ||
| in->setNodeGraphString("ng"); | ||
| in->setOutputString("out"); | ||
| } | ||
|
|
||
| for (size_t i = 0; i < numImplStubs; ++i) | ||
| { | ||
| mx::ImplementationPtr impl = doc->addImplementation("i" + std::to_string(i)); | ||
| impl->setNodeDefString("n" + std::to_string(i)); | ||
| } | ||
|
|
||
| return doc; | ||
| } | ||
|
|
||
| TEST_CASE("NodeGraph getNodeDef performance", "[node][performance]") | ||
| { | ||
| BENCHMARK("validate, stubs=200 refs=100") | ||
| { | ||
| mx::DocumentPtr doc = buildScalingDocument(200, 100); | ||
| return doc->validate(); | ||
| }; | ||
|
|
||
| BENCHMARK("validate, stubs=1000 refs=100") | ||
| { | ||
| mx::DocumentPtr doc = buildScalingDocument(1000, 100); | ||
| return doc->validate(); | ||
| }; | ||
|
|
||
| BENCHMARK("validate, stubs=10000 refs=100") | ||
| { | ||
| mx::DocumentPtr doc = buildScalingDocument(10000, 100); | ||
| return doc->validate(); | ||
| }; | ||
| } | ||
|
|
||
| #endif // CATCH_CONFIG_ENABLE_BENCHMARKING |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think its possible for more than one Implementation element to use the same NodeGraph - so this might need to be
std::unordered_map<string, std::vector>
For standard surface (here) we have two different Implementation elements that have the same NodeGraph
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Curious if there are any metrics for the additional update cost especially if the cache updates frequently ? At most currently 1 or a few items will ever be found and it's mostly static during the lifetime of a document.