CMake Dependency Validation & Reporting

cmake/DependencyRequirements.cmake

@@ -0,0 +1,45 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023-present NVIDIA CORPORATION & AFFILIATES.
+# All rights reserved.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# ==============================================================================
+# nvFuser Dependency Requirements
+# ==============================================================================
+#
+# This file centralizes all dependency requirement metadata for nvFuser.
+# Each requirement entry contains:
+# - VERSION_MIN: Minimum version required (can be empty for "any version")
+# - OPTIONAL: TRUE/FALSE (default FALSE)
+# - COMPONENTS: Components required (for find_package, semicolon-separated)
+#
+# ==============================================================================
+
+# Ninja
+set(NVFUSER_REQUIREMENT_Ninja_OPTIONAL "TRUE")
+
+# Compiler (GCC or Clang)
+set(NVFUSER_REQUIREMENT_GNU_VERSION_MIN "13.1")
+set(NVFUSER_REQUIREMENT_Clang_VERSION_MIN "19")
+
+# Python
+set(NVFUSER_REQUIREMENT_Python_VERSION_MIN "3.10")
+set(NVFUSER_REQUIREMENT_Python_COMPONENTS "Interpreter;Development.Module")
+
+# Torch
+set(NVFUSER_REQUIREMENT_Torch_VERSION_MIN "2.9")
+
+# pybind11
+set(NVFUSER_REQUIREMENT_pybind11_VERSION_MIN "3.0")
+
+# CUDAToolkit
+set(NVFUSER_REQUIREMENT_CUDAToolkit_VERSION_MIN "12.6")
+set(NVFUSER_REQUIREMENT_CUDAToolkit_COMPONENTS "Cupti;cuda_driver")
+
+# LLVM
+set(NVFUSER_REQUIREMENT_LLVM_VERSION_MIN "18.1")
+
+# NVMMH
+set(NVFUSER_REQUIREMENT_NVMMH_OPTIONAL "TRUE")
+
+# Git Submodules (required for build)
+# No version requirement - just checks if submodules are initialized

cmake/DependencyUtilities.cmake

@@ -0,0 +1,139 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023-present NVIDIA CORPORATION & AFFILIATES.
+# All rights reserved.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# ==============================================================================
+# nvFuser Dependency Utilities
+# ==============================================================================
+#
+# This file provides utilities for dependency status tracking and reporting.
+# Dependency metadata is defined in DependencyRequirements.cmake
+# Individual dependency handlers are in cmake/deps/
+#
+# ==============================================================================
+
+# --------------------------
+# Conditionally add REQUIRED to find_package calls
+# --------------------------
+
+# When dependency report is enabled, we don't use REQUIRED so we can collect
+# all failures and show a comprehensive Python report.
+# When disabled, we use REQUIRED for immediate failure with standard CMake errors.
+if(NVFUSER_ENABLE_DEPENDENCY_REPORT)
+  set(MAYBE_REQUIRED "")
+else()
+  set(MAYBE_REQUIRED "REQUIRED")
+endif()
+
+# --------------------------
+# Status Tracking for JSON Export
+# --------------------------
+
+# Set dependency status based on found state and version check
+macro(set_dependency_report_status name)
+  set(optional "${NVFUSER_REQUIREMENT_${name}_OPTIONAL}")
+
+  if(${name}_FOUND)
+    # Check version compatibility
+    set(min_version "${NVFUSER_REQUIREMENT_${name}_VERSION_MIN}")
+    set(version "${${name}_VERSION}")
+
+    if(DEFINED min_version AND NOT "${min_version}" STREQUAL "")
+      if("${version}" VERSION_GREATER_EQUAL "${min_version}")
+        set(NVFUSER_REQUIREMENT_${name}_STATUS "SUCCESS")
+      else()
+        set(NVFUSER_REQUIREMENT_${name}_STATUS "INCOMPATIBLE")
+        # Mark dependencies as failed if this is a required dependency
+        if(NOT optional)
+          set(NVFUSER_DEPENDENCIES_OK FALSE)
+        endif()
+      endif()
+    else()
+      set(NVFUSER_REQUIREMENT_${name}_STATUS "SUCCESS")
+    endif()
+  else()
+    set(NVFUSER_REQUIREMENT_${name}_STATUS "NOT_FOUND")
+    # Mark dependencies as failed if this is a required dependency
+    if(NOT optional)
+      set(NVFUSER_DEPENDENCIES_OK FALSE)
+    endif()
+  endif()
+endmacro()
+
+# --------------------------
+# Python Export for Dependency Reporting
+# --------------------------
+
+function(export_dependency_json output_file)
+  # Get all CMake variables
+  get_cmake_property(all_vars VARIABLES)
+
+  # Write JSON file with flat variable dict
+  file(WRITE "${output_file}" "{\n")
+  file(APPEND "${output_file}" "  \"cmake_vars\": {\n")
+
+  # Export all variables (sorted for consistency)
+  list(SORT all_vars)
+  list(LENGTH all_vars var_count)
+  set(var_index 0)
+  foreach(var ${all_vars})
+    set(value "${${var}}")
+    # Escape for JSON strings
+    string(REPLACE "\\" "\\\\" value "${value}")
+    string(REPLACE "\"" "\\\"" value "${value}")
+    string(REPLACE "\n" "\\n" value "${value}")
+    string(REPLACE "\t" "\\t" value "${value}")
+    string(REPLACE "\r" "\\r" value "${value}")
+
+    # Add comma if not last item
+    math(EXPR var_index "${var_index} + 1")
+    if(var_index LESS var_count)
+      file(APPEND "${output_file}" "    \"${var}\": \"${value}\",\n")
+    else()
+      file(APPEND "${output_file}" "    \"${var}\": \"${value}\"\n")
+    endif()
+  endforeach()
+
+  file(APPEND "${output_file}" "  }\n")
+  file(APPEND "${output_file}" "}\n")
+endfunction()
+
+# --------------------------
+# Report Dependencies (Python-based with fallback)
+# --------------------------
+
+macro(report_dependencies)
+  # Export dependency data to JSON with error handling
+  set(json_file "${CMAKE_BINARY_DIR}/nvfuser_dependencies.json")
+  export_dependency_json("${json_file}")
+  if(NOT EXISTS "${json_file}")
+    message(WARNING "Failed to export dependency data to ${json_file} - skipping enhanced dependency report")
+  else()
+
+    # Try to use Python script for enhanced reporting
+    set(python_script "${CMAKE_SOURCE_DIR}/python/tools/check_dependencies.py")
+
+    if(NOT EXISTS "${python_script}")
+      message(WARNING "Python reporting script not found: ${python_script}")
+    elseif(NOT DEFINED Python_EXECUTABLE OR NOT Python_FOUND)
+      message(WARNING "Python is not available - skipping enhanced dependency report")
+    else()
+      # Run Python reporting script
+      execute_process(
+        COMMAND ${Python_EXECUTABLE} ${python_script} ${json_file}
+        RESULT_VARIABLE python_result
+        OUTPUT_VARIABLE python_output
+        ERROR_VARIABLE python_error
+      )
+
+      if(NOT python_result EQUAL 0)
+        message(WARNING "Python reporting failed (${python_result}): ${python_error} To reproduce: ${Python_EXECUTABLE} ${python_script} ${json_file}")
+      else()
+        # Display Python output
+        message("${python_output}")
+      endif()
+    endif()
+
+  endif()
+
+endmacro()

cmake/LogCapture.cmake

@@ -0,0 +1,90 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023-present NVIDIA CORPORATION & AFFILIATES.
+# All rights reserved.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# ==============================================================================
+# nvFuser Log Capture Utilities
+# ==============================================================================
+
+# Global switch to control logging behavior
+set(LOG_CAPTURE_MODE FALSE CACHE INTERNAL "")
+set(GLOBAL_LOG_BUFFER "" CACHE INTERNAL "")
+
+# 1. Override message() ONCE for the whole project.
+#    This acts as a "Gatekeeper" for BOTH capture and suppression.
+function(message)
+  # Handle empty lines
+  if(NOT ARGV)
+    if(LOG_CAPTURE_MODE)
+      # Store empty line marker when capturing
+      set_property(GLOBAL APPEND PROPERTY GLOBAL_LOG_BUFFER "EMPTY_LINE")
+    elseif(NOT SUPPRESS_MESSAGE_OUTPUT)
+      # Print empty line when not suppressing
+      _message("")
+    endif()
+    return()
+  endif()
+
+  # Get the message type (STATUS, WARNING, FATAL_ERROR, etc.)
+  list(GET ARGV 0 type)
+
+  # Pass through FATAL_ERROR and SEND_ERROR immediately (Fail Fast)
+  if(type STREQUAL "FATAL_ERROR" OR type STREQUAL "SEND_ERROR")
+    _message(${ARGV})
+    return()
+  endif()
+
+  # Logic: Capture, Suppress, or Print?
+  if(LOG_CAPTURE_MODE)
+    # CAPTURE MODE: Store type and content separately
+    # Remove the type from ARGV to get just the content
+    set(_argv_copy ${ARGV})
+    list(REMOVE_AT _argv_copy 0)
+    string(JOIN " " msg_content ${_argv_copy})
+    # Use a delimiter (<<<DELIM>>>) to separate type from content
+    set_property(GLOBAL APPEND PROPERTY GLOBAL_LOG_BUFFER "${type}<<<DELIM>>>${msg_content}")
+  elseif(SUPPRESS_MESSAGE_OUTPUT)
+    # SUPPRESS MODE: Block all non-critical messages (already handled errors above)
+    # Do nothing
+  else()
+    # NORMAL MODE: Pass through to internal CMake message
+    _message(${ARGV})
+  endif()
+endfunction()
+
+# 2. Macros to control the switch
+macro(start_capture)
+  set(LOG_CAPTURE_MODE TRUE)
+  set_property(GLOBAL PROPERTY GLOBAL_LOG_BUFFER "") # Clear buffer
+endmacro()
+
+macro(stop_capture target_var)
+  set(LOG_CAPTURE_MODE FALSE)
+  # Move global buffer to user variable
+  get_property(_logs GLOBAL PROPERTY GLOBAL_LOG_BUFFER)
+  set(${target_var} "${_logs}")
+endmacro()
+
+# 3. Helper to print the logs later
+function(dump_captured_logs log_list)
+  foreach(entry ${log_list})
+    if("${entry}" STREQUAL "EMPTY_LINE")
+      _message("")
+    else()
+      # Split "TYPE|||CONTENT"
+      # Split "TYPE<<<DELIM>>>CONTENT"
+      string(FIND "${entry}" "<<<DELIM>>>" pos)
+      if(pos EQUAL -1)
+        message(WARNING "Log entry missing delimiter: ${entry}")
+        continue()
+      endif()
+      string(SUBSTRING "${entry}" 0 ${pos} type)
+      math(EXPR content_start "${pos} + 11")
+      string(SUBSTRING "${entry}" ${content_start} -1 content)
+
+      # Print using the original type (STATUS, WARNING, etc.)
+      # This preserves color and formatting!
+      _message(${type} "${content}")
+    endif()
+  endforeach()
+endfunction()