socket_usage_inference.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2024 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include <optional>
#include <regex>
 
#include "NOD_geometry_nodes_execute.hh"
#include "NOD_menu_value.hh"
#include "NOD_multi_function.hh"
#include "NOD_node_declaration.hh"
#include "NOD_node_in_compute_context.hh"
#include "NOD_socket_usage_inference.hh"
 
#include "DNA_anim_types.h"
#include "DNA_material_types.h"
#include "DNA_node_types.h"
 
#include "BKE_compute_context_cache.hh"
#include "BKE_compute_contexts.hh"
#include "BKE_node_legacy_types.hh"
#include "BKE_node_runtime.hh"
#include "BKE_type_conversions.hh"
 
#include "ANIM_action.hh"
#include "ANIM_action_iterators.hh"
 
#include "BLI_listbase.h"
#include "BLI_stack.hh"
 
namespace blender::nodes::socket_usage_inference {

class SocketUsageInferencerImpl {
 private:
  friend InputSocketUsageParams;
 
  bke::ComputeContextCache &compute_context_cache_;

  SocketValueInferencer &value_inferencer_;

  const bNodeTree &root_tree_;

  Stack<SocketInContext> usage_tasks_;

  Map<SocketInContext, bool> all_socket_usages_;

  Stack<SocketInContext> disabled_output_tasks_;

  Map<SocketInContext, bool> all_socket_disable_states_;

  bool ignore_top_level_node_muting_ = false;
 
 public:
  SocketUsageInferencer *owner_ = nullptr;
 
  SocketUsageInferencerImpl(const bNodeTree &tree,
                            SocketValueInferencer &value_inferencer,
                            bke::ComputeContextCache &compute_context_cache,
                            const bool ignore_top_level_node_muting)
      : compute_context_cache_(compute_context_cache),
        value_inferencer_(value_inferencer),
        root_tree_(tree),
        ignore_top_level_node_muting_(ignore_top_level_node_muting)
  {
    root_tree_.ensure_topology_cache();
    root_tree_.ensure_interface_cache();
  }
 
  void mark_top_level_node_outputs_as_used()
  {
    for (const bNode *node : root_tree_.all_nodes()) {
      if (node->is_group_input()) {
        /* Can skip these sockets, because they don't affect usage anyway, and there may be a lot
         * of them. See #144756. */
        continue;
      }
      for (const bNodeSocket *socket : node->output_sockets()) {
        all_socket_usages_.add_new({nullptr, socket}, true);
      }
    }
  }
 
  bool is_group_input_used(const int input_i)
  {
    for (const bNode *node : root_tree_.group_input_nodes()) {
      const bNodeSocket &socket = node->output_socket(input_i);
      if (!socket.is_directly_linked()) {
        continue;
      }
      const SocketInContext socket_ctx{nullptr, &socket};
      if (this->is_socket_used(socket_ctx)) {
        return true;
      }
    }
    return false;
  }
 
  bool is_socket_used(const SocketInContext &socket)
  {
    const std::optional<bool> is_used = all_socket_usages_.lookup_try(socket);
    if (is_used.has_value()) {
      return *is_used;
    }
    if (socket->is_output() && !socket->is_directly_linked()) {
      /* In this case we can return early because the socket can't be used if it's not linked. */
      return false;
    }
    if (socket->owner_tree().has_available_link_cycle()) {
      return false;
    }
 
    BLI_assert(usage_tasks_.is_empty());
    usage_tasks_.push(socket);
 
    while (!usage_tasks_.is_empty()) {
      const SocketInContext &socket = usage_tasks_.peek();
      this->usage_task(socket);
      if (&socket == &usage_tasks_.peek()) {
        /* The task is finished if it hasn't added any new task it depends on. */
        usage_tasks_.pop();
      }
    }
 
    return all_socket_usages_.lookup(socket);
  }
 
  InferenceValue get_socket_value(const SocketInContext &socket)
  {
    return value_inferencer_.get_socket_value(socket);
  }
 
  bool is_disabled_group_output(const int output_i)
  {
    const bNode *group_output_node = root_tree_.group_output_node();
    if (!group_output_node) {
      return true;
    }
    const SocketInContext socket{nullptr, &group_output_node->input_socket(output_i)};
    return this->is_disabled_output(socket);
  }
 
  bool is_disabled_output(const SocketInContext &socket)
  {
    const std::optional<bool> is_disabled = all_socket_disable_states_.lookup_try(socket);
    if (is_disabled.has_value()) {
      return *is_disabled;
    }
    if (socket->owner_tree().has_available_link_cycle()) {
      return true;
    }
    BLI_assert(disabled_output_tasks_.is_empty());
    disabled_output_tasks_.push(socket);
 
    while (!disabled_output_tasks_.is_empty()) {
      const SocketInContext &socket = disabled_output_tasks_.peek();
      this->disabled_output_task(socket);
      if (&socket == &disabled_output_tasks_.peek()) {
        /* The task is finished if it hasn't added any new task it depends on. */
        disabled_output_tasks_.pop();
      }
    }
    return all_socket_disable_states_.lookup(socket);
  }
 
 private:
  void usage_task(const SocketInContext &socket)
  {
    if (all_socket_usages_.contains(socket)) {
      return;
    }
    const bNode &node = socket->owner_node();
    if (!socket->is_available()) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
    if (node.is_undefined() && !node.is_custom_group()) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
    if (socket->is_input()) {
      this->usage_task__input(socket);
    }
    else {
      this->usage_task__output(socket);
    }
  }
 
  void usage_task__input(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
 
    if (node->is_muted()) {
      const bool is_top_level = socket.context == nullptr;
      if (!this->ignore_top_level_node_muting_ || !is_top_level) {
        this->usage_task__input__muted_node(socket);
        return;
      }
    }
 
    switch (node->type_legacy) {
      case NODE_GROUP:
      case NODE_CUSTOM_GROUP: {
        this->usage_task__input__group_node(socket);
        break;
      }
      case NODE_GROUP_OUTPUT: {
        this->usage_task__input__group_output_node(socket);
        break;
      }
      case GEO_NODE_SWITCH: {
        this->usage_task__input__generic_switch(
            socket, switch_node_inference_utils::is_socket_selected__switch);
        break;
      }
      case GEO_NODE_INDEX_SWITCH: {
        this->usage_task__input__generic_switch(
            socket, switch_node_inference_utils::is_socket_selected__index_switch);
        break;
      }
      case GEO_NODE_MENU_SWITCH: {
        if (socket->index() == 0) {
          this->usage_task__input__fallback(socket);
        }
        else {
          this->usage_task__input__generic_switch(
              socket, switch_node_inference_utils::is_socket_selected__menu_switch);
        }
        break;
      }
      case SH_NODE_MIX: {
        this->usage_task__input__generic_switch(
            socket, switch_node_inference_utils::is_socket_selected__mix_node);
        break;
      }
      case SH_NODE_MIX_SHADER: {
        this->usage_task__input__generic_switch(
            socket, switch_node_inference_utils::is_socket_selected__shader_mix_node);
        break;
      }
      case GEO_NODE_SIMULATION_INPUT: {
        this->usage_task__input__simulation_input_node(socket);
        break;
      }
      case GEO_NODE_REPEAT_INPUT: {
        this->usage_task__input__repeat_input_node(socket);
        break;
      }
      case GEO_NODE_FOREACH_GEOMETRY_ELEMENT_INPUT: {
        this->usage_task__input__foreach_element_input_node(socket);
        break;
      }
      case GEO_NODE_FOREACH_GEOMETRY_ELEMENT_OUTPUT: {
        this->usage_task__input__foreach_element_output_node(socket);
        break;
      }
      case GEO_NODE_CAPTURE_ATTRIBUTE: {
        this->usage_task__input__capture_attribute_node(socket);
        break;
      }
      case SH_NODE_OUTPUT_AOV:
      case SH_NODE_OUTPUT_LIGHT:
      case SH_NODE_OUTPUT_WORLD:
      case SH_NODE_OUTPUT_LINESTYLE:
      case SH_NODE_OUTPUT_MATERIAL:
      case CMP_NODE_OUTPUT_FILE:
      case TEX_NODE_OUTPUT: {
        this->usage_task__input__output_node(socket);
        break;
      }
      default: {
        if (node->is_type("NodeEnableOutput")) {
          this->usage_task__input__enable_output(socket);
          break;
        }
        this->usage_task__input__fallback(socket);
        break;
      }
    }
  }
 
  void usage_task__input__output_node(const SocketInContext &socket)
  {
    all_socket_usages_.add_new(socket, true);
  }

  void usage_task__input__generic_switch(
      const SocketInContext &socket,
      const FunctionRef<bool(const SocketInContext &socket, const InferenceValue &condition)>
          is_selected_socket)
  {
    const NodeInContext node = socket.owner_node();
    BLI_assert(node->input_sockets().size() >= 1);
    BLI_assert(node->output_sockets().size() >= 1);
 
    if (socket->type == SOCK_CUSTOM && STREQ(socket->idname, "NodeSocketVirtual")) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
    const SocketInContext output_socket{socket.context,
                                        get_first_available_bsocket(node->output_sockets())};
    const std::optional<bool> output_is_used = all_socket_usages_.lookup_try(output_socket);
    if (!output_is_used.has_value()) {
      this->push_usage_task(output_socket);
      return;
    }
    if (!*output_is_used) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
    const SocketInContext condition_socket{socket.context,
                                           get_first_available_bsocket(node->input_sockets())};
    if (socket == condition_socket) {
      all_socket_usages_.add_new(socket, true);
      return;
    }
    const InferenceValue condition_value = this->get_socket_value(condition_socket);
    if (condition_value.is_unknown()) {
      /* The exact condition value is unknown, so any input may be used. */
      all_socket_usages_.add_new(socket, true);
      return;
    }
    const bool is_used = is_selected_socket(socket, condition_value);
    all_socket_usages_.add_new(socket, is_used);
  }
 
  void usage_task__input__group_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    const bNodeTree *group = reinterpret_cast<const bNodeTree *>(node->id);
    if (!group || ID_MISSING(&group->id)) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
    group->ensure_topology_cache();
    if (group->has_available_link_cycle()) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
 
    /* The group node input is used if any of the matching group inputs within the group is
     * used. */
    const ComputeContext &group_context = compute_context_cache_.for_group_node(
        socket.context, node->identifier, &node->owner_tree());
    Vector<const bNodeSocket *> dependent_sockets;
    for (const bNode *group_input_node : group->group_input_nodes()) {
      const bNodeSocket &group_input_socket = group_input_node->output_socket(socket->index());
      if (group_input_socket.is_directly_linked()) {
        /* Skip unlinked group inputs to avoid further unnecessary processing of them further down
         * the line. */
        dependent_sockets.append(&group_input_socket);
      }
    }
    this->usage_task__with_dependent_sockets(socket, dependent_sockets, {}, &group_context);
  }
 
  void usage_task__input__group_output_node(const SocketInContext &socket)
  {
    const int output_i = socket->index();
    if (socket.context == nullptr) {
      /* This is a final output which is always used. */
      all_socket_usages_.add_new(socket, true);
      return;
    }
    /* The group output node is used if the matching output of the parent group node is used. */
    const bke::GroupNodeComputeContext &group_context =
        *static_cast<const bke::GroupNodeComputeContext *>(socket.context);
    const bNodeSocket &group_node_output = group_context.node()->output_socket(output_i);
    this->usage_task__with_dependent_sockets(
        socket, {&group_node_output}, {}, group_context.parent());
  }
 
  void usage_task__output(const SocketInContext &socket)
  {
    /* An output socket is used if any of the sockets it is connected to is used. */
    Vector<const bNodeSocket *> dependent_sockets;
    for (const bNodeLink *link : socket->directly_linked_links()) {
      if (link->is_used()) {
        dependent_sockets.append(link->tosock);
      }
    }
    this->usage_task__with_dependent_sockets(socket, dependent_sockets, {}, socket.context);
  }
 
  void usage_task__input__simulation_input_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    const bNodeTree &tree = socket->owner_tree();
 
    const NodeGeometrySimulationInput &storage = *static_cast<const NodeGeometrySimulationInput *>(
        node->storage);
    const bNode *sim_output_node = tree.node_by_id(storage.output_node_id);
    if (!sim_output_node) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
    /* Simulation inputs are also used when any of the simulation outputs are used. */
    Vector<const bNodeSocket *, 16> dependent_sockets;
    dependent_sockets.extend(node->output_sockets());
    dependent_sockets.extend(sim_output_node->output_sockets());
    this->usage_task__with_dependent_sockets(socket, dependent_sockets, {}, socket.context);
  }
 
  void usage_task__input__repeat_input_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    const bNodeTree &tree = socket->owner_tree();
 
    const NodeGeometryRepeatInput &storage = *static_cast<const NodeGeometryRepeatInput *>(
        node->storage);
    const bNode *repeat_output_node = tree.node_by_id(storage.output_node_id);
    if (!repeat_output_node) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
    /* Assume that all repeat inputs are used when any of the outputs are used. This check could
     * become more precise in the future if necessary. */
    Vector<const bNodeSocket *, 16> dependent_sockets;
    dependent_sockets.extend(node->output_sockets());
    dependent_sockets.extend(repeat_output_node->output_sockets());
    this->usage_task__with_dependent_sockets(socket, dependent_sockets, {}, socket.context);
  }
 
  void usage_task__input__foreach_element_output_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    this->usage_task__with_dependent_sockets(
        socket, {node->output_by_identifier(socket->identifier)}, {}, socket.context);
  }
 
  void usage_task__input__capture_attribute_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    this->usage_task__with_dependent_sockets(
        socket, {&node->output_socket(socket->index())}, {}, socket.context);
  }
 
  void usage_task__input__enable_output(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    const SocketInContext enable_socket = node.input_socket(0);
    const SocketInContext output_socket = node.output_socket(0);
    if (socket == enable_socket) {
      this->usage_task__with_dependent_sockets(socket, {&*output_socket}, {}, socket.context);
    }
    else {
      this->usage_task__with_dependent_sockets(
          socket, {&*output_socket}, {&*enable_socket}, socket.context);
    }
  }
 
  void usage_task__input__fallback(const SocketInContext &socket)
  {
    const SocketDeclaration *socket_decl = socket->runtime->declaration;
    if (!socket_decl) {
      all_socket_usages_.add_new(socket, true);
      return;
    }
    if (!socket_decl->usage_inference_fn) {
      this->usage_task__with_dependent_sockets(
          socket, socket->owner_node().output_sockets(), {}, socket.context);
      return;
    }
    InputSocketUsageParams params{
        *owner_, socket.context, socket->owner_tree(), socket->owner_node(), *socket};
    const std::optional<bool> is_used = (*socket_decl->usage_inference_fn)(params);
    if (!is_used.has_value()) {
      /* Some value was requested, come back later when that value is available. */
      return;
    }
    all_socket_usages_.add_new(socket, *is_used);
  }
 
  void usage_task__input__foreach_element_input_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    const bNodeTree &tree = socket->owner_tree();
 
    const NodeGeometryForeachGeometryElementInput &storage =
        *static_cast<const NodeGeometryForeachGeometryElementInput *>(node->storage);
    const bNode *foreach_output_node = tree.node_by_id(storage.output_node_id);
    if (!foreach_output_node) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
    Vector<const bNodeSocket *, 16> dependent_sockets;
    if (StringRef(socket->identifier).startswith("Input_")) {
      dependent_sockets.append(node->output_by_identifier(socket->identifier));
    }
    else {
      /* The geometry and selection inputs are used whenever any of the zone outputs is used. */
      dependent_sockets.extend(node->output_sockets());
      dependent_sockets.extend(foreach_output_node->output_sockets());
    }
    this->usage_task__with_dependent_sockets(socket, dependent_sockets, {}, socket.context);
  }
 
  void usage_task__input__muted_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    Vector<const bNodeSocket *> dependent_sockets;
    for (const bNodeLink &internal_link : node->internal_links()) {
      if (internal_link.fromsock != socket.socket) {
        continue;
      }
      dependent_sockets.append(internal_link.tosock);
    }
    this->usage_task__with_dependent_sockets(socket, dependent_sockets, {}, socket.context);
  }

  void usage_task__with_dependent_sockets(const SocketInContext &socket,
                                          const Span<const bNodeSocket *> dependent_outputs,
                                          const Span<const bNodeSocket *> condition_inputs,
                                          const ComputeContext *dependent_socket_context)
  {
    /* Check if any of the dependent outputs are used. */
    SocketInContext next_unknown_socket;
    bool any_output_used = false;
    for (const bNodeSocket *dependent_socket_ptr : dependent_outputs) {
      const SocketInContext dependent_socket{dependent_socket_context, dependent_socket_ptr};
      const std::optional<bool> is_used = all_socket_usages_.lookup_try(dependent_socket);
      if (!is_used.has_value()) {
        if (dependent_socket_ptr->is_output() && !dependent_socket_ptr->is_directly_linked()) {
          continue;
        }
        if (!next_unknown_socket) {
          next_unknown_socket = dependent_socket;
          continue;
        }
      }
      if (is_used.value_or(false)) {
        any_output_used = true;
        break;
      }
    }
    if (next_unknown_socket) {
      /* Create a task that checks if the next dependent socket is used. Intentionally only create
       * a task for the very next one and not for all, because that could potentially trigger a lot
       * of unnecessary evaluations. */
      this->push_usage_task(next_unknown_socket);
      return;
    }
    if (!any_output_used) {
      all_socket_usages_.add_new(socket, false);
      return;
    }
    bool all_condition_inputs_true = true;
    for (const bNodeSocket *condition_input_ptr : condition_inputs) {
      const SocketInContext condition_input{dependent_socket_context, condition_input_ptr};
      const InferenceValue condition_value = this->get_socket_value(condition_input);
      if (!condition_value.is_primitive_value()) {
        /* The condition is not known, so it may be true. */
        continue;
      }
      BLI_assert(condition_input_ptr->type == SOCK_BOOLEAN);
      if (!condition_value.get_primitive<bool>()) {
        all_condition_inputs_true = false;
        break;
      }
    }
    all_socket_usages_.add_new(socket, all_condition_inputs_true);
  }
 
  void push_usage_task(const SocketInContext &socket)
  {
    usage_tasks_.push(socket);
  }
 
  void disabled_output_task(const SocketInContext &socket)
  {
    if (all_socket_disable_states_.contains(socket)) {
      return;
    }
    const bNode &node = socket->owner_node();
    if (!socket->is_available()) {
      all_socket_disable_states_.add_new(socket, true);
      return;
    }
    if (node.is_undefined() && !node.is_custom_group()) {
      all_socket_disable_states_.add_new(socket, true);
      return;
    }
    if (socket->is_input()) {
      this->disabled_output_task__input(socket);
    }
    else {
      this->disabled_output_task__output(socket);
    }
  }
 
  void disabled_output_task__input(const SocketInContext &socket)
  {
    const Span<const bNodeLink *> links = socket->directly_linked_links();
    const bNodeLink *single_link = links.size() == 1 && links[0]->is_used() ? links[0] : nullptr;
    if (links.size() != 1 || !links[0]->is_used()) {
      /* The socket is not linked, thus it is not disabled. */
      all_socket_disable_states_.add_new(socket, false);
      return;
    }
    const SocketInContext origin_socket{socket.context, single_link->fromsock};
    this->disabled_output_task__with_origin_socket(socket, origin_socket);
  }
 
  void disabled_output_task__output(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    if (node->is_muted()) {
      const bool is_top_level = socket.context == nullptr;
      if (!this->ignore_top_level_node_muting_ || !is_top_level) {
        this->disabled_output_task__output__muted_node(socket);
        return;
      }
    }
 
    switch (node->type_legacy) {
      case NODE_GROUP:
      case NODE_CUSTOM_GROUP: {
        this->disabled_output_task__output__group_node(socket);
        break;
      }
      case NODE_REROUTE: {
        this->disabled_output_task__with_origin_socket(socket, node.input_socket(0));
        break;
      }
      default: {
        if (node->is_type("NodeEnableOutput")) {
          this->disabled_output_task__output__enable_output_node(socket);
          break;
        }
        /* By default, all output sockets are enabled unless they are explicitly disabled by some
         * rule above. */
        all_socket_disable_states_.add_new(socket, false);
        break;
      }
    }
  }
 
  void disabled_output_task__output__muted_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    for (const bNodeLink &internal_link : node->internal_links()) {
      if (internal_link.tosock != socket.socket) {
        continue;
      }
      this->disabled_output_task__with_origin_socket(socket,
                                                     {socket.context, internal_link.fromsock});
      return;
    }
    all_socket_disable_states_.add_new(socket, false);
  }
 
  void disabled_output_task__output__group_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    const bNodeTree *group = reinterpret_cast<const bNodeTree *>(node->id);
    if (!group || ID_MISSING(&group->id)) {
      all_socket_disable_states_.add_new(socket, false);
      return;
    }
    group->ensure_topology_cache();
    if (group->has_available_link_cycle()) {
      all_socket_disable_states_.add_new(socket, false);
      return;
    }
    const bNode *group_output_node = group->group_output_node();
    if (!group_output_node) {
      all_socket_disable_states_.add_new(socket, false);
      return;
    }
    const ComputeContext &group_context = compute_context_cache_.for_group_node(
        socket.context, node->identifier, &node->owner_tree());
    const SocketInContext origin_socket{&group_context,
                                        &group_output_node->input_socket(socket->index())};
    this->disabled_output_task__with_origin_socket(socket, origin_socket);
  }
 
  void disabled_output_task__output__enable_output_node(const SocketInContext &socket)
  {
    const NodeInContext node = socket.owner_node();
    const SocketInContext enable_socket = node.input_socket(0);
    const InferenceValue enable_value = this->get_socket_value(enable_socket);
    const std::optional<bool> is_enabled_opt = enable_value.get_if_primitive<bool>();
    const bool is_enabled = is_enabled_opt.value_or(true);
    all_socket_disable_states_.add_new(socket, !is_enabled);
  }
 
  void disabled_output_task__with_origin_socket(const SocketInContext &socket,
                                                const SocketInContext &origin_socket)
  {
    const std::optional<bool> is_disabled = all_socket_disable_states_.lookup_try(origin_socket);
    if (is_disabled.has_value()) {
      all_socket_disable_states_.add_new(socket, *is_disabled);
      return;
    }
    this->push_disabled_output_task(origin_socket);
  }
 
  void push_disabled_output_task(const SocketInContext &socket)
  {
    disabled_output_tasks_.push(socket);
  }
 
  static const bNodeSocket *get_first_available_bsocket(const Span<const bNodeSocket *> sockets)
  {
    for (const bNodeSocket *socket : sockets) {
      if (socket->is_available()) {
        return socket;
      }
    }
    return nullptr;
  }
};
 
SocketUsageInferencer::SocketUsageInferencer(const bNodeTree &tree,
                                             ResourceScope &scope,
                                             SocketValueInferencer &value_inferencer,
                                             bke::ComputeContextCache &compute_context_cache,
                                             const bool ignore_top_level_node_muting)
    : impl_(scope.construct<SocketUsageInferencerImpl>(
          tree, value_inferencer, compute_context_cache, ignore_top_level_node_muting))
{
  impl_.owner_ = this;
}
 
static bool input_may_affect_visibility(const bNodeTreeInterfaceSocket &socket)
{
  return socket.socket_type == StringRef("NodeSocketMenu");
}
 
static bool input_may_affect_visibility(const bNodeSocket &socket)
{
  return socket.type == SOCK_MENU;
}
 
Array<SocketUsage> infer_all_sockets_usage(const bNodeTree &tree)
{
  tree.ensure_topology_cache();
  const Span<const bNodeSocket *> all_input_sockets = tree.all_input_sockets();
  const Span<const bNodeSocket *> all_output_sockets = tree.all_output_sockets();
  Array<SocketUsage> all_usages(tree.all_sockets().size());
 
  if (tree.has_available_link_cycle()) {
    return all_usages;
  }
 
  ResourceScope scope;
  bke::ComputeContextCache compute_context_cache;
 
  const bool ignore_top_level_node_muting = true;
 
  {
    /* Find actual socket usages. */
    SocketValueInferencer value_inferencer{tree, scope, compute_context_cache};
    SocketUsageInferencer usage_inferencer{
        tree, scope, value_inferencer, compute_context_cache, ignore_top_level_node_muting};
    usage_inferencer.mark_top_level_node_outputs_as_used();
    for (const bNodeSocket *socket : all_input_sockets) {
      all_usages[socket->index_in_tree()].is_used = usage_inferencer.is_socket_used(
          {nullptr, socket});
    }
  }
 
  /* Find input sockets that should be hidden. */
  Array<bool> only_controllers_used(all_input_sockets.size(), NoInitialization{});
  Array<bool> all_ignored_inputs(all_input_sockets.size(), true);
  threading::parallel_for(all_input_sockets.index_range(), 1024, [&](const IndexRange range) {
    for (const int i : range) {
      const bNodeSocket &socket = *all_input_sockets[i];
      only_controllers_used[i] = !input_may_affect_visibility(socket);
    }
  });
  SocketValueInferencer value_inferencer_all_unknown{
      tree, scope, compute_context_cache, nullptr, all_ignored_inputs};
  SocketUsageInferencer usage_inferencer_all_unknown{tree,
                                                     scope,
                                                     value_inferencer_all_unknown,
                                                     compute_context_cache,
                                                     ignore_top_level_node_muting};
  SocketValueInferencer value_inferencer_only_controllers{
      tree, scope, compute_context_cache, nullptr, only_controllers_used};
  SocketUsageInferencer usage_inferencer_only_controllers{tree,
                                                          scope,
                                                          value_inferencer_only_controllers,
                                                          compute_context_cache,
                                                          ignore_top_level_node_muting};
  usage_inferencer_all_unknown.mark_top_level_node_outputs_as_used();
  usage_inferencer_only_controllers.mark_top_level_node_outputs_as_used();
  for (const bNodeSocket *socket : all_input_sockets) {
    SocketUsage &usage = all_usages[socket->index_in_tree()];
    if (usage.is_used) {
      /* Used inputs are always visible. */
      continue;
    }
    const SocketInContext socket_ctx{nullptr, socket};
    if (usage_inferencer_only_controllers.is_socket_used(socket_ctx)) {
      /* The input should be visible if it's used if only visibility-controlling inputs are
       * considered. */
      continue;
    }
    if (!usage_inferencer_all_unknown.is_socket_used(socket_ctx)) {
      /* The input should be visible if it's never used, regardless of any inputs. Its usage does
       * not depend on any visibility-controlling input. */
      continue;
    }
    usage.is_visible = false;
  }
  for (const bNodeSocket *socket : all_output_sockets) {
    const bNode &node = socket->owner_node();
    if (node.is_group_input()) {
      continue;
    }
    const SocketInContext socket_ctx{nullptr, socket};
    if (usage_inferencer_only_controllers.is_disabled_output(socket_ctx)) {
      SocketUsage &usage = all_usages[socket->index_in_tree()];
      usage.is_visible = false;
    }
  }
 
  return all_usages;
}
 
void infer_group_interface_usage(const bNodeTree &group,
                                 const Span<InferenceValue> group_input_values,
                                 const MutableSpan<SocketUsage> r_input_usages,
                                 const std::optional<MutableSpan<SocketUsage>> r_output_usages)
{
  SocketUsage default_usage;
  default_usage.is_used = false;
  default_usage.is_visible = true;
  r_input_usages.fill(default_usage);
  if (r_output_usages) {
    r_output_usages->fill({true, true});
  }
 
  ResourceScope scope;
  bke::ComputeContextCache compute_context_cache;
 
  {
    /* Detect actually used inputs. */
    const auto get_input_value = [&](const int group_input_i) {
      return group_input_values[group_input_i];
    };
    SocketValueInferencer value_inferencer{group, scope, compute_context_cache, get_input_value};
    SocketUsageInferencer usage_inferencer{group, scope, value_inferencer, compute_context_cache};
    for (const int i : group.interface_inputs().index_range()) {
      r_input_usages[i].is_used |= usage_inferencer.is_group_input_used(i);
    }
  }
  bool visibility_controlling_input_exists = false;
  for (const int i : group.interface_inputs().index_range()) {
    const bNodeTreeInterfaceSocket &io_socket = *group.interface_inputs()[i];
    if (input_may_affect_visibility(io_socket)) {
      visibility_controlling_input_exists = true;
    }
  }
  if (!visibility_controlling_input_exists) {
    /* If there is no visibility controller inputs, all inputs are always visible. */
    return;
  }
  SocketValueInferencer value_inferencer_all_unknown{group, scope, compute_context_cache};
  SocketUsageInferencer usage_inferencer_all_unknown{
      group, scope, value_inferencer_all_unknown, compute_context_cache};
  const auto get_only_controllers_input_value = [&](const int group_input_i) {
    const bNodeTreeInterfaceSocket &io_socket = *group.interface_inputs()[group_input_i];
    if (input_may_affect_visibility(io_socket)) {
      return group_input_values[group_input_i];
    }
    return InferenceValue::Unknown();
  };
  SocketValueInferencer value_inferencer_only_controllers{
      group, scope, compute_context_cache, get_only_controllers_input_value};
  SocketUsageInferencer usage_inferencer_only_controllers{
      group, scope, value_inferencer_only_controllers, compute_context_cache};
  for (const int i : group.interface_inputs().index_range()) {
    if (r_input_usages[i].is_used) {
      /* Used inputs are always visible. */
      continue;
    }
    if (usage_inferencer_only_controllers.is_group_input_used(i)) {
      /* The input should be visible if it's used if only visibility-controlling inputs are
       * considered. */
      continue;
    }
    if (!usage_inferencer_all_unknown.is_group_input_used(i)) {
      /* The input should be visible if it's never used, regardless of any inputs. Its usage does
       * not depend on any visibility-controlling input. */
      continue;
    }
    r_input_usages[i].is_visible = false;
  }
  if (r_output_usages) {
    for (const int i : group.interface_outputs().index_range()) {
      if (usage_inferencer_only_controllers.is_disabled_group_output(i)) {
        SocketUsage &usage = (*r_output_usages)[i];
        usage.is_used = false;
        usage.is_visible = false;
      }
    }
  }
}
 
void infer_group_interface_inputs_usage(const bNodeTree &group,
                                        Span<const bNodeSocket *> input_sockets,
                                        MutableSpan<SocketUsage> r_input_usages)
{
  BLI_assert(group.interface_inputs().size() == input_sockets.size());
 
  AlignedBuffer<1024, 8> allocator_buffer;
  ResourceScope scope;
  scope.allocator().provide_buffer(allocator_buffer);
 
  Array<InferenceValue> input_values(input_sockets.size(), InferenceValue::Unknown());
  for (const int i : input_sockets.index_range()) {
    const bNodeSocket &socket = *input_sockets[i];
    if (socket.is_directly_linked()) {
      continue;
    }
 
    const bke::bNodeSocketType &stype = *socket.typeinfo;
    const CPPType *base_type = stype.base_cpp_type;
    if (base_type == nullptr) {
      continue;
    }
    void *value = scope.allocate_owned(*base_type);
    stype.get_base_cpp_value(socket.default_value, value);
    input_values[i] = InferenceValue::from_primitive(value);
  }
 
  infer_group_interface_usage(group, input_values, r_input_usages, {});  // TODO
}
 
void infer_group_interface_usage(const bNodeTree &group,
                                 const IDProperty *properties,
                                 MutableSpan<SocketUsage> r_input_usages,
                                 std::optional<MutableSpan<SocketUsage>> r_output_usages)
{
  ResourceScope scope;
  const Vector<InferenceValue> group_input_values =
      nodes::get_geometry_nodes_input_inference_values(group, properties, scope);
  nodes::socket_usage_inference::infer_group_interface_usage(
      group, group_input_values, r_input_usages, r_output_usages);
}
 
InputSocketUsageParams::InputSocketUsageParams(SocketUsageInferencer &inferencer,
                                               const ComputeContext *compute_context,
                                               const bNodeTree &tree,
                                               const bNode &node,
                                               const bNodeSocket &socket)
    : inferencer_(inferencer),
      compute_context_(compute_context),
      tree(tree),
      node(node),
      socket(socket)
{
}
 
InferenceValue InputSocketUsageParams::get_input(const StringRef identifier) const
{
  const SocketInContext input_socket{compute_context_, this->node.input_by_identifier(identifier)};
  return inferencer_.impl_.get_socket_value(input_socket);
}
 
std::optional<bool> InputSocketUsageParams::any_output_is_used() const
{
  const bNodeSocket *first_missing = nullptr;
  for (const bNodeSocket *output_socket : this->node.output_sockets()) {
    if (const std::optional<bool> is_used = inferencer_.impl_.all_socket_usages_.lookup_try(
            {compute_context_, output_socket}))
    {
      if (*is_used) {
        return true;
      }
    }
    else {
      first_missing = output_socket;
    }
  }
  if (first_missing) {
    inferencer_.impl_.push_usage_task({compute_context_, first_missing});
    return std::nullopt;
  }
  return false;
}
 
bool InputSocketUsageParams::menu_input_may_be(const StringRef identifier,
                                               const int enum_value) const
{
  BLI_assert(this->node.input_by_identifier(identifier)->type == SOCK_MENU);
  const InferenceValue value = this->get_input(identifier);
  if (!value.is_primitive_value()) {
    /* The value is unknown, so it may be the requested enum value. */
    return true;
  }
  return value.get_primitive<MenuValue>().value == enum_value;
}
 
void SocketUsageInferencer::mark_top_level_node_outputs_as_used()
{
  impl_.mark_top_level_node_outputs_as_used();
}
 
bool SocketUsageInferencer::is_group_input_used(const int input_i)
{
  return impl_.is_group_input_used(input_i);
}
 
bool SocketUsageInferencer::is_socket_used(const SocketInContext &socket)
{
  return impl_.is_socket_used(socket);
}
 
bool SocketUsageInferencer::is_disabled_group_output(const int output_i)
{
  return impl_.is_disabled_group_output(output_i);
}
 
bool SocketUsageInferencer::is_disabled_output(const SocketInContext &socket)
{
  return impl_.is_disabled_output(socket);
}
 
}  // namespace blender::nodes::socket_usage_inference