Geometry Nodes: refactor logging during geometry nodes evaluation

Many ui features for geometry nodes need access to information generated
during evaluation:
* Node warnings.
* Attribute search.
* Viewer node.
* Socket inspection (not in master yet).

The way we logged the required information before had some disadvantages:
* Viewer node used a completely separate system from node warnings and
  attribute search.
* Most of the context of logged information is lost when e.g. the same node
  group is used multiple times.
* A global lock was needed every time something is logged.

This new implementation solves these problems:
* All four mentioned ui features use the same underlying logging system.
* All context information for logged values is kept intact.
* Every thread has its own local logger. The logged informatiton is combined
  in the end.

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

5 files changed, 119 insertions, 73 deletions

diff --git a/source/blender/editors/space_node/CMakeLists.txt b/source/blender/editors/space_node/CMakeLists.txt
index 6e234c5b2ce..0c1463e69c1 100644
--- a/source/blender/editors/space_node/CMakeLists.txt
+++ b/source/blender/editors/space_node/CMakeLists.txt
@@ -24,6 +24,7 @@ set(INC
   ../../compositor
   ../../depsgraph
   ../../draw
+  ../../functions
   ../../gpu
   ../../imbuf
   ../../makesdna
@@ -78,4 +79,20 @@ if(WITH_OPENSUBDIV)
   add_definitions(-DWITH_OPENSUBDIV)
 endif()
 
+if(WITH_TBB)
+  add_definitions(-DWITH_TBB)
+  if(WIN32)
+    # TBB includes Windows.h which will define min/max macros
+    # that will collide with the stl versions.
+    add_definitions(-DNOMINMAX)
+  endif()
+  list(APPEND INC_SYS
+    ${TBB_INCLUDE_DIRS}
+  )
+
+  list(APPEND LIB
+    ${TBB_LIBRARIES}
+  )
+endif()
+
 blender_add_lib(bf_editor_space_node "${SRC}" "${INC}" "${INC_SYS}" "${LIB}")
diff --git a/source/blender/editors/space_node/node_draw.cc b/source/blender/editors/space_node/node_draw.cc
index 8a341da0b5c..d4f178603b8 100644
--- a/source/blender/editors/space_node/node_draw.cc
+++ b/source/blender/editors/space_node/node_draw.cc
@@ -48,7 +48,6 @@
 #include "BKE_lib_id.h"
 #include "BKE_main.h"
 #include "BKE_node.h"
-#include "BKE_node_ui_storage.hh"
 #include "BKE_object.h"
 
 #include "DEG_depsgraph.h"
@@ -76,6 +75,8 @@
 
 #include "RNA_access.h"
 
+#include "NOD_geometry_nodes_eval_log.hh"
+
 #include "node_intern.h" /* own include */
 
 #ifdef WITH_COMPOSITOR
@@ -86,6 +87,9 @@ using blender::Map;
 using blender::Set;
 using blender::Span;
 using blender::Vector;
+using blender::fn::CPPType;
+using blender::fn::GPointer;
+namespace geo_log = blender::nodes::geometry_nodes_eval_log;
 
 extern "C" {
 /* XXX interface.h */
@@ -1185,14 +1189,14 @@ void node_draw_sockets(const View2D *v2d,
   }
 }
 
-static int node_error_type_to_icon(const NodeWarningType type)
+static int node_error_type_to_icon(const geo_log::NodeWarningType type)
 {
   switch (type) {
-    case NodeWarningType::Error:
+    case geo_log::NodeWarningType::Error:
       return ICON_ERROR;
-    case NodeWarningType::Warning:
+    case geo_log::NodeWarningType::Warning:
       return ICON_ERROR;
-    case NodeWarningType::Info:
+    case geo_log::NodeWarningType::Info:
       return ICON_INFO;
   }
 
@@ -1200,14 +1204,14 @@ static int node_error_type_to_icon(const NodeWarningType type)
   return ICON_ERROR;
 }
 
-static uint8_t node_error_type_priority(const NodeWarningType type)
+static uint8_t node_error_type_priority(const geo_log::NodeWarningType type)
 {
   switch (type) {
-    case NodeWarningType::Error:
+    case geo_log::NodeWarningType::Error:
       return 3;
-    case NodeWarningType::Warning:
+    case geo_log::NodeWarningType::Warning:
       return 2;
-    case NodeWarningType::Info:
+    case geo_log::NodeWarningType::Info:
       return 1;
   }
 
@@ -1215,11 +1219,11 @@ static uint8_t node_error_type_priority(const NodeWarningType type)
   return 0;
 }
 
-static NodeWarningType node_error_highest_priority(Span<NodeWarning> warnings)
+static geo_log::NodeWarningType node_error_highest_priority(Span<geo_log::NodeWarning> warnings)
 {
   uint8_t highest_priority = 0;
-  NodeWarningType highest_priority_type = NodeWarningType::Info;
-  for (const NodeWarning &warning : warnings) {
+  geo_log::NodeWarningType highest_priority_type = geo_log::NodeWarningType::Info;
+  for (const geo_log::NodeWarning &warning : warnings) {
     const uint8_t priority = node_error_type_priority(warning.type);
     if (priority > highest_priority) {
       highest_priority = priority;
@@ -1229,15 +1233,17 @@ static NodeWarningType node_error_highest_priority(Span<NodeWarning> warnings)
   return highest_priority_type;
 }
 
+struct NodeErrorsTooltipData {
+  Span<geo_log::NodeWarning> warnings;
+};
+
 static char *node_errors_tooltip_fn(bContext *UNUSED(C), void *argN, const char *UNUSED(tip))
 {
-  const NodeUIStorage **storage_pointer_alloc = static_cast<const NodeUIStorage **>(argN);
-  const NodeUIStorage *node_ui_storage = *storage_pointer_alloc;
-  Span<NodeWarning> warnings = node_ui_storage->warnings;
+  NodeErrorsTooltipData &data = *(NodeErrorsTooltipData *)argN;
 
   std::string complete_string;
 
-  for (const NodeWarning &warning : warnings.drop_back(1)) {
+  for (const geo_log::NodeWarning &warning : data.warnings.drop_back(1)) {
     complete_string += warning.message;
     /* Adding the period is not ideal for multi-line messages, but it is consistent
      * with other tooltip implementations in Blender, so it is added here. */
@@ -1246,7 +1252,7 @@ static char *node_errors_tooltip_fn(bContext *UNUSED(C), void *argN, const char
   }
 
   /* Let the tooltip system automatically add the last period. */
-  complete_string += warnings.last().message;
+  complete_string += data.warnings.last().message;
 
   return BLI_strdupn(complete_string.c_str(), complete_string.size());
 }
@@ -1254,20 +1260,26 @@ static char *node_errors_tooltip_fn(bContext *UNUSED(C), void *argN, const char
 #define NODE_HEADER_ICON_SIZE (0.8f * U.widget_unit)
 
 static void node_add_error_message_button(
-    const bContext *C, bNodeTree &ntree, bNode &node, const rctf &rect, float &icon_offset)
+    const bContext *C, bNodeTree &UNUSED(ntree), bNode &node, const rctf &rect, float &icon_offset)
 {
-  const NodeUIStorage *node_ui_storage = BKE_node_tree_ui_storage_get_from_context(C, ntree, node);
-  if (node_ui_storage == nullptr || node_ui_storage->warnings.is_empty()) {
+  SpaceNode *snode = CTX_wm_space_node(C);
+  const geo_log::NodeLog *node_log = geo_log::ModifierLog::find_node_by_node_editor_context(*snode,
+                                                                                            node);
+  if (node_log == nullptr) {
+    return;
+  }
+
+  Span<geo_log::NodeWarning> warnings = node_log->warnings();
+
+  if (warnings.is_empty()) {
     return;
   }
 
-  /* The UI API forces us to allocate memory for each error button, because the
-   * ownership of #UI_but_func_tooltip_set's argument is transferred to the button. */
-  const NodeUIStorage **storage_pointer_alloc = (const NodeUIStorage **)MEM_mallocN(
-      sizeof(NodeUIStorage *), __func__);
-  *storage_pointer_alloc = node_ui_storage;
+  NodeErrorsTooltipData *tooltip_data = (NodeErrorsTooltipData *)MEM_mallocN(
+      sizeof(NodeErrorsTooltipData), __func__);
+  tooltip_data->warnings = warnings;
 
-  const NodeWarningType display_type = node_error_highest_priority(node_ui_storage->warnings);
+  const geo_log::NodeWarningType display_type = node_error_highest_priority(warnings);
 
   icon_offset -= NODE_HEADER_ICON_SIZE;
   UI_block_emboss_set(node.block, UI_EMBOSS_NONE);
@@ -1285,7 +1297,7 @@ static void node_add_error_message_button(
                             0,
                             0,
                             nullptr);
-  UI_but_func_tooltip_set(but, node_errors_tooltip_fn, storage_pointer_alloc, MEM_freeN);
+  UI_but_func_tooltip_set(but, node_errors_tooltip_fn, tooltip_data, MEM_freeN);
   UI_block_emboss_set(node.block, UI_EMBOSS);
 }
 
diff --git a/source/blender/editors/space_node/node_geometry_attribute_search.cc b/source/blender/editors/space_node/node_geometry_attribute_search.cc
index 94080a7b616..ab63531ff49 100644
--- a/source/blender/editors/space_node/node_geometry_attribute_search.cc
+++ b/source/blender/editors/space_node/node_geometry_attribute_search.cc
@@ -27,7 +27,6 @@
 #include "DNA_space_types.h"
 
 #include "BKE_context.h"
-#include "BKE_node_ui_storage.hh"
 #include "BKE_object.h"
 
 #include "RNA_access.h"
@@ -40,17 +39,21 @@
 #include "UI_interface.h"
 #include "UI_resources.h"
 
+#include "NOD_geometry_nodes_eval_log.hh"
+
 #include "node_intern.h"
 
 using blender::IndexRange;
 using blender::Map;
 using blender::Set;
 using blender::StringRef;
+namespace geo_log = blender::nodes::geometry_nodes_eval_log;
+using geo_log::GeometryAttributeInfo;
 
 struct AttributeSearchData {
-  AvailableAttributeInfo &dummy_info_for_search;
-  const NodeUIStorage &ui_storage;
-  bNodeSocket &socket;
+  const bNodeTree *tree;
+  const bNode *node;
+  bNodeSocket *socket;
 };
 
 /* This class must not have a destructor, since it is used by buttons and freed with #MEM_freeN. */
@@ -73,7 +76,7 @@ static StringRef attribute_domain_string(const AttributeDomain domain)
 /* Unicode arrow. */
 #define MENU_SEP "\xe2\x96\xb6"
 
-static bool attribute_search_item_add(uiSearchItems *items, const AvailableAttributeInfo &item)
+static bool attribute_search_item_add(uiSearchItems *items, const GeometryAttributeInfo &item)
 {
   const StringRef data_type_name = attribute_data_type_string(item.data_type);
   const StringRef domain_name = attribute_domain_string(item.domain);
@@ -84,31 +87,47 @@ static bool attribute_search_item_add(uiSearchItems *items, const AvailableAttri
       items, search_item_text.c_str(), (void *)&item, ICON_NONE, UI_BUT_HAS_SEP_CHAR, 0);
 }
 
-static void attribute_search_update_fn(const bContext *UNUSED(C),
-                                       void *arg,
-                                       const char *str,
-                                       uiSearchItems *items,
-                                       const bool is_first)
+static GeometryAttributeInfo &get_dummy_item_info()
+{
+  static GeometryAttributeInfo info;
+  return info;
+}
+
+static void attribute_search_update_fn(
+    const bContext *C, void *arg, const char *str, uiSearchItems *items, const bool is_first)
 {
   AttributeSearchData *data = static_cast<AttributeSearchData *>(arg);
 
-  const Set<AvailableAttributeInfo> &attribute_hints = data->ui_storage.attribute_hints;
+  SpaceNode *snode = CTX_wm_space_node(C);
+  const geo_log::NodeLog *node_log = geo_log::ModifierLog::find_node_by_node_editor_context(
+      *snode, *data->node);
+  if (node_log == nullptr) {
+    return;
+  }
+  blender::Vector<const GeometryAttributeInfo *> infos = node_log->lookup_available_attributes();
+
+  GeometryAttributeInfo &dummy_info = get_dummy_item_info();
 
   /* Any string may be valid, so add the current search string along with the hints. */
   if (str[0] != '\0') {
-    /* Note that the attribute domain and data type are dummies, since
-     * #AvailableAttributeInfo equality is only based on the string. */
-    if (!attribute_hints.contains(AvailableAttributeInfo{str, ATTR_DOMAIN_AUTO, CD_PROP_BOOL})) {
-      data->dummy_info_for_search.name = std::string(str);
-      UI_search_item_add(items, str, &data->dummy_info_for_search, ICON_ADD, 0, 0);
+    bool contained = false;
+    for (const GeometryAttributeInfo *attribute_info : infos) {
+      if (attribute_info->name == str) {
+        contained = true;
+        break;
+      }
+    }
+    if (!contained) {
+      dummy_info.name = str;
+      UI_search_item_add(items, str, &dummy_info, ICON_ADD, 0, 0);
     }
   }
 
   if (str[0] == '\0' && !is_first) {
     /* Allow clearing the text field when the string is empty, but not on the first pass,
      * or opening an attribute field for the first time would show this search item. */
-    data->dummy_info_for_search.name = std::string(str);
-    UI_search_item_add(items, str, &data->dummy_info_for_search, ICON_X, 0, 0);
+    dummy_info.name = str;
+    UI_search_item_add(items, str, &dummy_info, ICON_X, 0, 0);
   }
 
   /* Don't filter when the menu is first opened, but still run the search
@@ -116,15 +135,15 @@ static void attribute_search_update_fn(const bContext *UNUSED(C),
   const char *string = is_first ? "" : str;
 
   StringSearch *search = BLI_string_search_new();
-  for (const AvailableAttributeInfo &item : attribute_hints) {
-    BLI_string_search_add(search, item.name.c_str(), (void *)&item);
+  for (const GeometryAttributeInfo *item : infos) {
+    BLI_string_search_add(search, item->name.c_str(), (void *)item);
   }
 
-  AvailableAttributeInfo **filtered_items;
+  GeometryAttributeInfo **filtered_items;
   const int filtered_amount = BLI_string_search_query(search, string, (void ***)&filtered_items);
 
   for (const int i : IndexRange(filtered_amount)) {
-    const AvailableAttributeInfo *item = filtered_items[i];
+    const GeometryAttributeInfo *item = filtered_items[i];
     if (!attribute_search_item_add(items, *item)) {
       break;
     }
@@ -137,31 +156,21 @@ static void attribute_search_update_fn(const bContext *UNUSED(C),
 static void attribute_search_exec_fn(bContext *C, void *data_v, void *item_v)
 {
   AttributeSearchData *data = static_cast<AttributeSearchData *>(data_v);
-  AvailableAttributeInfo *item = static_cast<AvailableAttributeInfo *>(item_v);
+  GeometryAttributeInfo *item = (GeometryAttributeInfo *)item_v;
 
-  bNodeSocket &socket = data->socket;
+  bNodeSocket &socket = *data->socket;
   bNodeSocketValueString *value = static_cast<bNodeSocketValueString *>(socket.default_value);
   BLI_strncpy(value->value, item->name.c_str(), MAX_NAME);
 
   ED_undo_push(C, "Assign Attribute Name");
 }
 
-void node_geometry_add_attribute_search_button(const bContext *C,
+void node_geometry_add_attribute_search_button(const bContext *UNUSED(C),
                                                const bNodeTree *node_tree,
                                                const bNode *node,
                                                PointerRNA *socket_ptr,
                                                uiLayout *layout)
 {
-  const NodeUIStorage *ui_storage = BKE_node_tree_ui_storage_get_from_context(
-      C, *node_tree, *node);
-
-  if (ui_storage == nullptr) {
-    uiItemR(layout, socket_ptr, "default_value", 0, "", 0);
-    return;
-  }
-
-  const NodeTreeUIStorage *tree_ui_storage = node_tree->ui_storage;
-
   uiBlock *block = uiLayoutGetBlock(layout);
   uiBut *but = uiDefIconTextButR(block,
                                  UI_BTYPE_SEARCH_MENU,
@@ -181,10 +190,8 @@ void node_geometry_add_attribute_search_button(const bContext *C,
                                  0.0f,
                                  "");
 
-  AttributeSearchData *data = OBJECT_GUARDED_NEW(AttributeSearchData,
-                                                 {tree_ui_storage->dummy_info_for_search,
-                                                  *ui_storage,
-                                                  *static_cast<bNodeSocket *>(socket_ptr->data)});
+  AttributeSearchData *data = OBJECT_GUARDED_NEW(
+      AttributeSearchData, {node_tree, node, (bNodeSocket *)socket_ptr->data});
 
   UI_but_func_search_set_results_are_suggestions(but, true);
   UI_but_func_search_set_sep_string(but, MENU_SEP);
diff --git a/source/blender/editors/space_spreadsheet/CMakeLists.txt b/source/blender/editors/space_spreadsheet/CMakeLists.txt
index 1ea6593588a..9a06447b631 100644
--- a/source/blender/editors/space_spreadsheet/CMakeLists.txt
+++ b/source/blender/editors/space_spreadsheet/CMakeLists.txt
@@ -27,6 +27,7 @@ set(INC
   ../../gpu
   ../../makesdna
   ../../makesrna
+  ../../nodes
   ../../windowmanager
   ../../../../intern/glew-mx
   ../../../../intern/guardedalloc
diff --git a/source/blender/editors/space_spreadsheet/spreadsheet_data_source_geometry.cc b/source/blender/editors/space_spreadsheet/spreadsheet_data_source_geometry.cc
index f730f199ca4..44b17b8c391 100644
--- a/source/blender/editors/space_spreadsheet/spreadsheet_data_source_geometry.cc
+++ b/source/blender/editors/space_spreadsheet/spreadsheet_data_source_geometry.cc
@@ -31,11 +31,15 @@
 
 #include "ED_spreadsheet.h"
 
+#include "NOD_geometry_nodes_eval_log.hh"
+
 #include "bmesh.h"
 
 #include "spreadsheet_data_source_geometry.hh"
 #include "spreadsheet_intern.hh"
 
+namespace geo_log = blender::nodes::geometry_nodes_eval_log;
+
 namespace blender::ed::spreadsheet {
 
 void GeometryDataSource::foreach_default_column_ids(
@@ -438,13 +442,18 @@ GeometrySet spreadsheet_get_display_geometry_set(const SpaceSpreadsheet *sspread
         }
       }
       else {
-        if (object_eval->runtime.geometry_set_previews != nullptr) {
-          GHash *ghash = (GHash *)object_eval->runtime.geometry_set_previews;
-          const uint64_t key = ED_spreadsheet_context_path_hash(sspreadsheet);
-          GeometrySet *geometry_set_preview = (GeometrySet *)BLI_ghash_lookup_default(
-              ghash, POINTER_FROM_UINT(key), nullptr);
-          if (geometry_set_preview != nullptr) {
-            geometry_set = *geometry_set_preview;
+        const geo_log::NodeLog *node_log =
+            geo_log::ModifierLog::find_node_by_spreadsheet_editor_context(*sspreadsheet);
+        if (node_log != nullptr) {
+          for (const geo_log::SocketLog &input_log : node_log->input_logs()) {
+            if (const geo_log::GeometryValueLog *geo_value_log =
+                    dynamic_cast<const geo_log::GeometryValueLog *>(input_log.value())) {
+              const GeometrySet *full_geometry = geo_value_log->full_geometry();
+              if (full_geometry != nullptr) {
+                geometry_set = *full_geometry;
+                break;
+              }
+            }
           }
         }
       }