Nodes: refactor node tree update handling

Goals of this refactor:
* More unified approach to updating everything that needs to be updated
  after a change in a node tree.
* The updates should happen in the correct order and quadratic or worse
  algorithms should be avoided.
* Improve detection of changes to the output to avoid tagging the depsgraph
  when it's not necessary.
* Move towards a more declarative style of defining nodes by having a
  more centralized update procedure.

The refactor consists of two main parts:
* Node tree tagging and update refactor.
  * Generally, when changes are done to a node tree, it is tagged dirty
    until a global update function is called that updates everything in
    the correct order.
  * The tagging is more fine-grained compared to before, to allow for more
    precise depsgraph update tagging.
* Depsgraph changes.
  * The shading specific depsgraph node for node trees as been removed.
  * Instead, there is a new `NTREE_OUTPUT` depsgrap node, which is only
    tagged when the output of the node tree changed (e.g. the Group Output
    or Material Output node).
  * The copy-on-write relation from node trees to the data block they are
    embedded in is now non-flushing. This avoids e.g. triggering a material
    update after the shader node tree changed in unrelated ways. Instead
    the material has a flushing relation to the new `NTREE_OUTPUT` node now.
  * The depsgraph no longer reports data block changes through to cycles
    through `Depsgraph.updates` when only the node tree changed in ways
    that do not affect the output.

Avoiding unnecessary updates seems to work well for geometry nodes and cycles.
The situation is a bit worse when there are drivers on the node tree, but that
could potentially be improved separately in the future.

Avoiding updates in eevee and the compositor is more tricky, but also less urgent.
* Eevee updates are triggered by calling `DRW_notify_view_update` in
  `ED_render_view3d_update` indirectly from `DEG_editors_update`.
* Compositor updates are triggered by `ED_node_composite_job` in `node_area_refresh`.
  This is triggered by calling `ED_area_tag_refresh` in `node_area_listener`.

Removing updates always has the risk of breaking some dependency that no
one was aware of. It's not unlikely that this will happen here as well. Adding
back missing updates should be quite a bit easier than getting rid of
unnecessary updates though.

Differential Revision: https://developer.blender.org/D13246

1 files changed, 11 insertions, 15 deletions

diff --git a/source/blender/nodes/shader/node_shader_tree.c b/source/blender/nodes/shader/node_shader_tree.c
index b79dbe3f3f8..b19835fae19 100644
--- a/source/blender/nodes/shader/node_shader_tree.c
+++ b/source/blender/nodes/shader/node_shader_tree.c
@@ -44,6 +44,7 @@
 #include "BKE_lib_id.h"
 #include "BKE_linestyle.h"
 #include "BKE_node.h"
+#include "BKE_node_tree_update.h"
 #include "BKE_scene.h"
 
 #include "RNA_access.h"
@@ -153,11 +154,6 @@ static void update(bNodeTree *ntree)
   ntreeSetOutput(ntree);
 
   ntree_update_reroute_nodes(ntree);
-
-  if (ntree->update & NTREE_UPDATE_NODES) {
-    /* clean up preview cache, in case nodes have been removed */
-    BKE_node_preview_remove_unused(ntree);
-  }
 }
 
 static bool shader_validate_link(eNodeSocketDatatype from, eNodeSocketDatatype to)
@@ -352,7 +348,7 @@ static void ntree_shader_unlink_hidden_value_sockets(bNode *group_node, bNodeSoc
   }
 
   if (removed_link) {
-    ntreeUpdateTree(G.main, group_ntree);
+    BKE_ntree_update_main_tree(G.main, group_ntree, NULL);
   }
 }
 
@@ -411,7 +407,7 @@ static void ntree_shader_groups_expand_inputs(bNodeTree *localtree)
   }
 
   if (link_added) {
-    ntreeUpdateTree(G.main, localtree);
+    BKE_ntree_update_main_tree(G.main, localtree, NULL);
   }
 }
 
@@ -491,7 +487,7 @@ static void flatten_group_do(bNodeTree *ntree, bNode *gnode)
     ntreeFreeLocalNode(ntree, node);
   }
 
-  ntree->update |= NTREE_UPDATE_NODES | NTREE_UPDATE_LINKS;
+  BKE_ntree_update_tag_all(ntree);
 }
 
 /* Flatten group to only have a simple single tree */
@@ -516,7 +512,7 @@ static void ntree_shader_groups_flatten(bNodeTree *localtree)
     }
   }
 
-  ntreeUpdateTree(G.main, localtree);
+  BKE_ntree_update_main_tree(G.main, localtree, NULL);
 }
 
 /* Check whether shader has a displacement.
@@ -536,7 +532,7 @@ static bool ntree_shader_has_displacement(bNodeTree *ntree,
     return false;
   }
   /* Make sure sockets links pointers are correct. */
-  ntreeUpdateTree(G.main, ntree);
+  BKE_ntree_update_main_tree(G.main, ntree, NULL);
   bNodeSocket *displacement = ntree_shader_node_find_input(output_node, "Displacement");
 
   if (displacement == NULL) {
@@ -625,7 +621,7 @@ static void ntree_shader_bypass_tagged_bump_nodes(bNodeTree *ntree)
       ntree_shader_bypass_bump_link(ntree, node, link);
     }
   }
-  ntreeUpdateTree(G.main, ntree);
+  BKE_ntree_update_main_tree(G.main, ntree, NULL);
 }
 
 static bool ntree_branch_count_and_tag_nodes(bNode *fromnode, bNode *tonode, void *userdata)
@@ -710,7 +706,7 @@ static void ntree_shader_copy_branch_displacement(bNodeTree *ntree,
   nodeRemLink(ntree, displacement_link);
   nodeAddLink(ntree, displacement_node, displacement_socket, tonode, tosock);
 
-  ntreeUpdateTree(G.main, ntree);
+  BKE_ntree_update_main_tree(G.main, ntree, NULL);
 }
 
 /* Re-link displacement output to unconnected normal sockets via bump node.
@@ -774,12 +770,12 @@ static void ntree_shader_relink_displacement(bNodeTree *ntree, bNode *output_nod
   geo_node->tmp_flag = -2;
   bump_node->tmp_flag = -2;
 
-  ntreeUpdateTree(G.main, ntree);
+  BKE_ntree_update_main_tree(G.main, ntree, NULL);
 
   /* Connect all free-standing Normal inputs and relink geometry/coordinate nodes. */
   ntree_shader_link_builtin_normal(ntree, bump_node, bump_output_socket);
   /* We modified the tree, it needs to be updated now. */
-  ntreeUpdateTree(G.main, ntree);
+  BKE_ntree_update_main_tree(G.main, ntree, NULL);
 }
 
 static void node_tag_branch_as_derivative(bNode *node, int dx)
@@ -859,7 +855,7 @@ void ntree_shader_tag_nodes(bNodeTree *ntree, bNode *output_node, nTreeTags *tag
     return;
   }
   /* Make sure sockets links pointers are correct. */
-  ntreeUpdateTree(G.main, ntree);
+  BKE_ntree_update_main_tree(G.main, ntree, NULL);
 
   nodeChainIterBackwards(ntree, output_node, ntree_tag_bsdf_cb, tags, 0);
 }