Just refactoring to remove some line (hopefully)

.github/workflows/presubmit.yml

@@ -234,7 +234,7 @@ jobs:
         make -C backends/cuda tracer_cuda.c cuda_library.rb btx_cuda_model.yaml libcuda.la
         make -C backends/cuda tracer_cudart.c libcudart.la
         make -C backends/ze tracer_ze.c ze_library.rb btx_ze_model.yaml libze_loader.la
-        make -C backends/opencl libOpenCL.la
+        make -C backends/opencl opencl_model.yaml btx_cl_model.yaml libOpenCL.la
         make -C backends/cxi cxi_sampling.tp
         make -C backends/itt tracer_itt.c itt_library.rb btx_itt_model.yaml libittnotify.la
         make -C backends/opencl opencl_profiling.tp

.gitignore

@@ -24,3 +24,4 @@ m4
 aclocal.m4
 configure
 Makefile.in
+__pycache__

backends/cuda/Makefile.am

@@ -121,32 +121,35 @@ ML_CUDA_FILES = \
 	$(srcdir)/cuda_meta_parameters.yaml \
 	$(srcdir)/cuda_exports_meta_parameters.yaml
 
-ML_CUDART_FILES = \
-	$(srcdir)/cudart_meta_parameters.yaml
-
-EXTRA_DIST += $(ML_CUDA_FILES) $(ML_CUDART_FILES)
+EXTRA_DIST += $(ML_CUDA_FILES)
 
 CUDA_MODEL = \
 	$(srcdir)/cuda_model.rb \
 	$(ML_CUDA_FILES) \
 	$(srcdir)/cuda_events.yaml \
 	$(CUDA_EXTRACTED) \
+	$(top_srcdir)/utils/api_model.rb \
 	$(top_srcdir)/utils/yaml_ast.rb \
 	$(top_srcdir)/utils/yaml_ast_lttng.rb \
 	$(top_srcdir)/utils/meta_parameters.rb \
 	$(top_srcdir)/utils/LTTng.rb \
 	$(top_srcdir)/utils/command.rb \
+	$(top_srcdir)/utils/command_index.rb \
+	$(top_srcdir)/utils/meta_parameter_spec.rb \
 	$(srcdir)/cuda.h.include \
 	cuda_exports.h.include
 
 CUDART_MODEL = \
 	$(srcdir)/cudart_model.rb \
-	$(ML_CUDART_FILES) \
 	$(CUDART_EXTRACTED) \
+	$(top_srcdir)/utils/api_model.rb \
 	$(top_srcdir)/utils/yaml_ast.rb \
 	$(top_srcdir)/utils/yaml_ast_lttng.rb \
 	$(top_srcdir)/utils/meta_parameters.rb \
 	$(top_srcdir)/utils/LTTng.rb \
+	$(top_srcdir)/utils/command.rb \
+	$(top_srcdir)/utils/command_index.rb \
+	$(top_srcdir)/utils/meta_parameter_spec.rb \
 	$(srcdir)/cudart.h.include
 
 btx_cuda_model.yaml: $(srcdir)/gen_babeltrace_cuda_model.rb $(CUDA_LIB_GEN) $(CUDA_MODEL)
@@ -306,6 +309,8 @@ install-data-hook:
 
 CUDA_LIB_GEN = \
 	$(top_srcdir)/utils/gen_babeltrace_model_helper.rb \
+	$(top_srcdir)/utils/api_model.rb \
+	$(top_srcdir)/utils/type_registry.rb \
 	$(top_srcdir)/utils/gen_library_base.rb \
 	$(srcdir)/gen_cuda_library_base.rb \
 	$(top_srcdir)/utils/gen_probe_base.rb

backends/cuda/cuda_model.rb

@@ -1,36 +1,34 @@
 require 'yaml'
 require 'pp'
 require 'set'
+require_relative '../../utils/api_model'
 require_relative '../../utils/yaml_ast_lttng'
 require_relative '../../utils/LTTng'
 require_relative '../../utils/command'
 require_relative '../../utils/meta_parameters'
 
 SRC_DIR = ENV['SRC_DIR'] || '.'
 
-RESULT_NAME = 'cuResult'
+# CUdeviceptr is a device address carried in an integer, so it reads as hex
+# rather than as a decimal that means nothing to anyone.
+cuda_api = ApiModel.load_file('cuda_api.yaml', hex_ints: ['CUdeviceptr'])
+cuda_exports_api = ApiModel.load_file('cuda_exports_api.yaml')
 
-$cuda_api_versions_yaml = YAML.load_file('cuda_api_versions.yaml')
-$cuda_api_yaml = YAML.load_file('cuda_api.yaml')
-$cuda_exports_api_yaml = YAML.load_file('cuda_exports_api.yaml')
+# The driver and its export tables are traced as one API: an export-table
+# typedef can name a driver struct, so they have to be classified together.
+API = cuda_api + cuda_exports_api
 
-$cuda_api = YAMLCAst.from_yaml_ast($cuda_api_yaml)
-$cuda_exports_api = YAMLCAst.from_yaml_ast($cuda_exports_api_yaml)
+gen_ffi_type_map(API.types, API.type_classes)
 
-cuda_funcs_e = $cuda_api['functions']
-cuda_exports_funcs_e = $cuda_exports_api['functions']
-
-cuda_types_e = $cuda_api['typedefs']
-cuda_exports_type_e = $cuda_exports_api['typedefs']
-
-typedefs = cuda_types_e + cuda_exports_type_e
-structs = $cuda_api['structs'] + $cuda_exports_api['structs']
-
-find_all_types(typedefs)
-gen_struct_map(typedefs, structs)
-gen_ffi_type_map(typedefs)
-
-HEX_INT_TYPES.push('CUdeviceptr')
+CONTEXT = BackendContext.new(
+  result_name: 'cuResult',
+  # cuda's pointers start at a _uninit trampoline that calls _init_tracer(), so
+  # no function is singled out as the initializer and Command#init? is never
+  # asked.
+  init_functions: nil,
+  struct_map: API.struct_map,
+  type_classes: API.type_classes
+)
 
 class TracepointParameter
   attr_reader :name, :type, :init, :after
@@ -81,33 +79,19 @@ def initialize(command, name)
   end
 end
 
-$cuda_meta_parameters = YAML.load_file(File.join(SRC_DIR, 'cuda_meta_parameters.yaml'))
-$cuda_meta_parameters['meta_parameters'].each do |func, list|
-  list.each do |type, *args|
-    register_meta_parameter func, Kernel.const_get(type), *args
-  end
-end
-$cuda_exports_meta_parameters = YAML.load_file(File.join(SRC_DIR, 'cuda_exports_meta_parameters.yaml'))
-$cuda_exports_meta_parameters['meta_parameters'].each do |func, list|
-  list.each do |type, *args|
-    register_meta_parameter func, Kernel.const_get(type), *args
-  end
-end
-
-$cuda_commands = cuda_funcs_e.collect do |func|
-  Command.new(func)
-end
+meta_parameters = load_meta_parameters('cuda_meta_parameters.yaml', 'cuda_exports_meta_parameters.yaml')
 
-$cuda_exports_commands = cuda_exports_funcs_e.collect do |func|
-  Command.new(func)
-end
+# The driver and its export tables are one API but two LTTng providers, so the
+# commands are grouped by the provider that will carry them.
+COMMANDS = CommandIndex.new(
+  { lttng_ust_cuda: cuda_api.functions, lttng_ust_cuda_exports: cuda_exports_api.functions }.transform_values do |funcs|
+    funcs.collect { |func| Command.new(func, context: CONTEXT, meta_parameters: meta_parameters[func.name]) }
+  end
+)
 
-def upper_snake_case(str)
-  str.gsub(/([A-Z][A-Z0-9]*)/, '_\1').upcase
-end
+check_meta_parameters(meta_parameters, COMMANDS)
 
-CUDA_POINTER_NAMES = ($cuda_commands +
-                      $cuda_exports_commands).collect do |c|
+CUDA_POINTER_NAMES = COMMANDS.collect do |c|
   [c, upper_snake_case(c.pointer_name)]
 end.to_h
 
@@ -119,7 +103,7 @@ def upper_snake_case(str)
    cuLaunchKernel_ptsz
    cuLaunchKernelEx
    cuLaunchKernelEx_ptsz].each do |m|
-  register_prologue m, dump_args
+  COMMANDS.add_prologue m, dump_args
 end
 
 dump_args = <<EOF
@@ -128,7 +112,7 @@ def upper_snake_case(str)
 
 %w[cuLaunchCooperativeKernel
    cuLaunchCooperativeKernel_ptsz].each do |m|
-  register_prologue m, dump_args
+  COMMANDS.add_prologue m, dump_args
 end
 
 dump_args = <<EOF
@@ -139,18 +123,18 @@ def upper_snake_case(str)
 
 %w[cuGraphAddKernelNode
    cuGraphExecKernelNodeSetParams].each do |m|
-  register_prologue m, dump_args
+  COMMANDS.add_prologue m, dump_args
 end
 
-register_prologue 'cuLaunchCooperativeKernelMultiDevice', <<EOF
+COMMANDS.add_prologue 'cuLaunchCooperativeKernelMultiDevice', <<EOF
   if (launchParamsList) {
     for( unsigned int _i = 0; _i < numDevices; _i++) {
       _dump_kernel_args(launchParamsList[_i].function, launchParamsList[_i].kernelParams, NULL);
     }
   }
 EOF
 
-register_epilogue 'cuGraphKernelNodeGetParams', <<EOF
+COMMANDS.add_epilogue 'cuGraphKernelNodeGetParams', <<EOF
   if (_retval == CUDA_SUCCESS && nodeParams) {
     _dump_kernel_args(nodeParams->func, nodeParams->kernelParams, nodeParams->extra);
   }
@@ -192,7 +176,7 @@ def upper_snake_case(str)
 
 stream_commands = []
 no_stream_commands = []
-mem_commands = $cuda_commands.select { |c| c.name.match(/cuMemcpy|cuMemset/) }
+mem_commands = COMMANDS.groups[:lttng_ust_cuda].select { |c| c.name.match(/cuMemcpy|cuMemset/) }
 mem_stream_commands = mem_commands.select { |c| c.name.match(/Async/) }
 mem_no_stream_commands = mem_commands - mem_stream_commands
 stream_commands += mem_stream_commands.collect(&:name)
@@ -221,39 +205,39 @@ def upper_snake_case(str)
 ]
 
 stream_commands.each do |m|
-  register_prologue m, profiling_start_stream
-  register_epilogue m, profiling_stop_stream
+  COMMANDS.add_prologue m, profiling_start_stream
+  COMMANDS.add_epilogue m, profiling_stop_stream
 end
 
 no_stream_commands.each do |m|
-  register_prologue m, profiling_start_no_stream
-  register_epilogue m, profiling_stop_no_stream
+  COMMANDS.add_prologue m, profiling_start_no_stream
+  COMMANDS.add_epilogue m, profiling_stop_no_stream
 end
 
 config_commands.each do |m|
-  register_prologue m, profiling_start_config
-  register_epilogue m, profiling_stop_config
+  COMMANDS.add_prologue m, profiling_start_config
+  COMMANDS.add_epilogue m, profiling_stop_config
 end
 
 # if a context is to be destroyed we must attempt to get profiling event results
 %w[cuCtxDestroy
    cuCtxDestroy_v2].each do |m|
-  register_prologue m, <<EOF
+  COMMANDS.add_prologue m, <<EOF
   if (ctx) {
     _context_event_cleanup(ctx);
   }
 EOF
 end
 
-register_epilogue 'cuDevicePrimaryCtxRetain', <<EOF
+COMMANDS.add_epilogue 'cuDevicePrimaryCtxRetain', <<EOF
   if (_do_profile && _retval == CUDA_SUCCESS && *pctx) {
     _primary_context_retain(dev, *pctx);
   }
 EOF
 
 %w[cuDevicePrimaryCtxRelease_v2
    cuDevicePrimaryCtxRelease].each do |m|
-  register_prologue m, <<EOF
+  COMMANDS.add_prologue m, <<EOF
   if (_do_profile) {
     _primary_context_release(dev);
   }
@@ -262,29 +246,31 @@ def upper_snake_case(str)
 
 %w[cuDevicePrimaryCtxReset_v2
    cuDevicePrimaryCtxReset].each do |m|
-  register_prologue m, <<EOF
+  COMMANDS.add_prologue m, <<EOF
   if (_do_profile) {
     _primary_context_reset(dev);
   }
 EOF
 end
 
 # Export tracing
-register_epilogue 'cuGetExportTable', <<EOF
+COMMANDS.add_epilogue 'cuGetExportTable', <<EOF
   if (_do_trace_export_tables && _retval == CUDA_SUCCESS) {
     const void *tmp = _wrap_and_cache_export_table(*ppExportTable, pExportTableId);
     *ppExportTable = tmp;
   }
 EOF
 
-register_epilogue 'cuInit', <<EOF
+COMMANDS.add_epilogue 'cuInit', <<EOF
   if (_retval == CUDA_SUCCESS) {
     _init_cuda();
   }
 EOF
 
 # cuGetProcAddress*
-command_names = $cuda_commands.collect(&:name).to_set
+# Not an api.yaml: a plain name -> suffix -> versions map, used only here.
+api_versions = YAML.load_file('cuda_api_versions.yaml')
+command_names = COMMANDS.groups[:lttng_ust_cuda].collect(&:name).to_set
 pt_condition = '((flags & CU_GET_PROC_ADDRESS_PER_THREAD_DEFAULT_STREAM) && !(flags & CU_GET_PROC_ADDRESS_LEGACY_STREAM))'
 normal_condition = '((flags & CU_GET_PROC_ADDRESS_LEGACY_STREAM) || !(flags & CU_GET_PROC_ADDRESS_PER_THREAD_DEFAULT_STREAM))'
 
@@ -296,7 +282,7 @@ def upper_snake_case(str)
     fprintf(stderr, "THAPI: CUDA version %d is unsupported, could not wrap %s symbol\\n", cudaVersion, symbol);
   } else if (_retval == CUDA_SUCCESS && pfn && *pfn) {
 EOF
-  str << $cuda_api_versions_yaml.map { |name, suffixes|
+  str << api_versions.map { |name, suffixes|
     suffixes.map { |suffix, versions|
       versions.map.with_index { |version, i|
         fullname = "#{name}#{"_v#{versions.size - i}" if versions.size - i > 1}#{suffix}"
@@ -313,20 +299,11 @@ def upper_snake_case(str)
   }.flatten.join(<<EOF)
     else
 EOF
-  #  str << $cuda_commands.collect { |c|
-  #    <<EOF
-  #    if (tracepoint_enabled(lttng_ust_cuda, #{c.name}_#{START}) && strcmp(symbol, "#{c.name}") == 0) {
-  #      wrap_#{c.name}(pfn);
-  #    }
-  # EOF
-  #  }.join(<<EOF)
-  #    else
-  # EOF
   str << <<EOF
   }
 EOF
 
-  register_epilogue method, str
+  COMMANDS.add_epilogue method, str
 }
 
 register_proc_callbacks.call('cuGetProcAddress')

backends/cuda/cudart_model.rb

@@ -1,44 +1,30 @@
 require 'yaml'
 require 'pp'
+require_relative '../../utils/api_model'
 require_relative '../../utils/yaml_ast_lttng'
 require_relative '../../utils/LTTng'
 require_relative '../../utils/command'
 require_relative '../../utils/meta_parameters'
 
 SRC_DIR = ENV['SRC_DIR'] || '.'
 
-RESULT_NAME = 'cudaResult'
+API = ApiModel.load_file('cudart_api.yaml')
 
-$cudart_api_yaml = YAML.load_file('cudart_api.yaml')
+gen_ffi_type_map(API.types, API.type_classes)
 
-$cudart_api = YAMLCAst.from_yaml_ast($cudart_api_yaml)
+CONTEXT = BackendContext.new(
+  result_name: 'cudaResult',
+  # gen_cudart.rb calls _init_tracer() from every wrapper, so no function is
+  # singled out as the initializer and Command#init? is never asked.
+  init_functions: nil,
+  struct_map: API.struct_map,
+  type_classes: API.type_classes
+)
 
-funcs = $cudart_api['functions']
-typedefs = $cudart_api['typedefs']
-structs = $cudart_api['structs']
+COMMANDS = CommandIndex.new(lttng_ust_cudart: API.functions.collect do |func|
+  Command.new(func, context: CONTEXT)
+end)
 
-find_all_types(typedefs)
-gen_struct_map(typedefs, structs)
-gen_ffi_type_map(typedefs)
-
-# Currently ignored by gen_cudart.rb
-INIT_FUNCTIONS = /.*/
-
-$cudart_meta_parameters = YAML.load_file(File.join(SRC_DIR, 'cudart_meta_parameters.yaml'))
-$cudart_meta_parameters['meta_parameters'].each do |func, list|
-  list.each do |type, *args|
-    register_meta_parameter func, Kernel.const_get(type), *args
-  end
-end
-
-$cudart_commands = funcs.collect do |func|
-  Command.new(func)
-end
-
-def upper_snake_case(str)
-  str.gsub(/([A-Z][A-Z0-9]*)/, '_\1').upcase
-end
-
-CUDART_POINTER_NAMES = $cudart_commands.collect do |c|
+CUDART_POINTER_NAMES = COMMANDS.collect do |c|
   [c, upper_snake_case(c.pointer_name)]
 end.to_h