proxy: tree-sitter to collect metadata

In cases when the underlying ocl lib does not
provide metadata, use tree sitter to parse the
kernel source and extract the metadata from that.
Uses code generated from:
https://github.com/lefp/tree-sitter-opencl.

Author: RABijl

CMakeLists.txt

@@ -1767,7 +1767,12 @@ if(ENABLE_PROXY_DEVICE)
     set(RENAME_POCL OFF )
   endif()
 
-
+  find_library(TSLIB tree-sitter)
+  set(HAVE_TREE_SITTER OFF)
+  if(TSLIB)
+    set(HAVE_TREE_SITTER ON)
+    message("-- FOUND tree sitter library")
+  endif()
 
   set(BUILD_PROXY 1)
 

config.h.in.cmake

@@ -112,6 +112,8 @@
 
 #cmakedefine HAVE_OPENCV
 
+#cmakedefine01 HAVE_TREE_SITTER
+
 #cmakedefine HAVE_OCL_ICD
 #cmakedefine HAVE_OCL_ICD_30_COMPATIBLE
 

lib/CL/devices/CMakeLists.txt

@@ -125,6 +125,12 @@ if(ENABLE_TCE)
 endif()
 
 if(ENABLE_PROXY_DEVICE)
+  if(HAVE_TREE_SITTER)
+    add_subdirectory("tree_sitter")
+    list(APPEND POCL_DEVICES_LINK_LIST pocl_tree_sitter_utils tree-sitter)
+    set(POCL_DEVICES_OBJS "${POCL_DEVICES_OBJS}"
+            "$<TARGET_OBJECTS:pocl_tree_sitter_utils>")
+  endif ()
   add_subdirectory("proxy")
   set(POCL_DEVICES_OBJS "${POCL_DEVICES_OBJS}"
     "$<TARGET_OBJECTS:pocl-devices-proxy>")
@@ -226,6 +232,10 @@ if(HAVE_OPENCV)
   target_link_libraries("pocl-devices" PRIVATE opencv_dnn)
 endif ()
 
+if(HAVE_TREE_SITTER)
+  target_link_libraries("pocl-devices" PRIVATE tree-sitter)
+endif()
+
 set(POCL_DEVICES_OBJS "${POCL_DEVICES_OBJS}"
     "$<TARGET_OBJECTS:pocl-devices>")
 harden("pocl-devices")

lib/CL/devices/proxy/CMakeLists.txt

@@ -25,6 +25,10 @@
 
 add_pocl_device_library("pocl-devices-proxy" pocl_proxy.hpp pocl_proxy.cpp)
 
+if(HAVE_TREE_SITTER)
+    target_link_libraries("pocl-devices-proxy" PRIVATE pocl_tree_sitter_utils)
+endif()
+
 if(PROXY_USE_LIBOPENCL_STUB)
 
     set(STUB_SOURCES libopencl_stub/openclstub.c libopencl_stub/openclstub.h libopencl_stub/rename_stub.h)

lib/CL/devices/proxy/libopencl_stub/openclstub.c

@@ -82,7 +82,6 @@ static int
 open_libopencl_so ()
 {
   char *path = NULL, *str = NULL;
-  int i;
 
   if ((str = getenv ("LIBOPENCL_SO_PATH")) && access_file (str))
     {
@@ -103,7 +102,8 @@ open_libopencl_so ()
 
   if (!path)
     {
-      for (i = 0; i < (sizeof (default_so_paths) / sizeof (char *)); i++)
+      for (size_t i = 0; i < (sizeof (default_so_paths) / sizeof (char *));
+           i++)
         {
           if (access_file (default_so_paths[i]))
             {

lib/CL/devices/proxy/pocl_proxy.cpp

@@ -58,6 +58,13 @@
 #error This driver cannot be built when pocl is to be linked against ICD
 #endif
 
+#ifndef HAVE_TREE_SITTER
+#define HAVE_TREE_SITTER 0
+#endif
+#if HAVE_TREE_SITTER
+#include "pocl_tree_sitter_utils.h"
+#endif
+
 /*****************************************************************************/
 
 typedef struct proxy_platform_data_s
@@ -983,6 +990,120 @@ static int get_kernel_metadata(pocl_kernel_metadata_t *meta,
     return CL_SUCCESS;
 }
 
+#if HAVE_TREE_SITTER
+///
+/// Use tree sitter to populate metadata from the kernel source string.
+///
+/// \param source [in]: String of kernel source.
+/// \param meta [out]: Populated with metadata of kernel.
+/// \param num_devices [in]: device count.
+/// \param device [in]: used to populate metadata.
+/// \param kernel [in]: kernel to get metadata about.
+/// \return CL_SUCCESS or a CL error.
+static int proxy_map_source_to_metadata(const char *source,
+                                        pocl_kernel_metadata_t *meta,
+                                        cl_uint num_devices,
+                                        cl_device_id device, cl_kernel kernel) {
+
+  char string_value[POCL_MAX_PATHNAME_LENGTH];
+  int err;
+  size_t size;
+
+  assert(meta->data == nullptr);
+  meta->data = (void **)calloc(num_devices, sizeof(void *));
+  meta->has_arg_metadata = (-1);
+
+  err = clGetKernelInfo(kernel, CL_KERNEL_FUNCTION_NAME, 0, nullptr, &size);
+  if (err != CL_SUCCESS || size == 0) {
+    POCL_MSG_PRINT_PROXY("Could not get kernel name.\n");
+    return err;
+  }
+  assert(size < POCL_MAX_PATHNAME_LENGTH);
+
+  err = clGetKernelInfo(kernel, CL_KERNEL_FUNCTION_NAME, size, string_value,
+                        nullptr);
+  if (err != CL_SUCCESS) {
+    POCL_MSG_PRINT_PROXY("Could not copy kernel name.\n");
+    return err;
+  }
+  meta->name = (char *)malloc(size);
+  memcpy(meta->name, string_value, size);
+
+  err = get_kernel_info(meta, device, kernel);
+  if (err != CL_SUCCESS) {
+    POCL_MSG_PRINT_PROXY("Could not get kernel info.\n");
+    return err;
+  }
+
+  cl_uint num_args;
+
+  err = clGetKernelInfo(kernel, CL_KERNEL_NUM_ARGS, sizeof(num_args), &num_args,
+                        nullptr);
+  if (err != CL_SUCCESS) {
+    POCL_MSG_PRINT_PROXY("Could not get number of kernel args.\n");
+    return err;
+  }
+
+  if (num_args == 0) {
+    meta->arg_info = nullptr;
+    meta->num_args = 0;
+    return CL_SUCCESS;
+  }
+
+  assert(num_args < 10000);
+
+  meta->num_args = num_args;
+  meta->arg_info =
+      (pocl_argument_info *)calloc(num_args, sizeof(pocl_argument_info));
+
+  char empty_buffer[MAX_TESTED_ARG_SIZE];
+
+  TSParser *parser = ts_parser_new();
+  ts_parser_set_language(parser, tree_sitter_opencl());
+  TSTree *tree =
+      ts_parser_parse_string(parser, nullptr, source, strlen(source));
+  TSNode root_node = ts_tree_root_node(tree);
+
+  int32_t status = 0;
+  TSNode kernel_node =
+      pocl_ts_find_kernel_params(source, root_node, meta->name, &status);
+  uint32_t child_count;
+  if (status != CL_SUCCESS) {
+    err = CL_KERNEL_ARG_INFO_NOT_AVAILABLE;
+    POCL_MSG_WARN("Could not find kernel name in source.\n");
+    goto TS_ERROR;
+  }
+  POCL_PRINT_TS_NODE(source, kernel_node);
+  child_count = ts_node_named_child_count(kernel_node);
+  assert(num_args == child_count);
+
+  TSNode child;
+  for (cl_uint i = 0; i < num_args; ++i) {
+    pocl_argument_info *pi = &meta->arg_info[i];
+    child = ts_node_named_child(kernel_node, i);
+    err = pocl_ts_map_node_to_arg_info(source, child, pi);
+    if (err != CL_SUCCESS) {
+      POCL_MSG_WARN("Failed to parse %s arg %d.\n", meta->name, i);
+      goto TS_ERROR;
+    }
+
+    POCL_MSG_PRINT_PROXY("KERNEL %s ARGUMENT %u NAME %s "
+                         "TYPENAME %s TYPE %u SIZE %u\n",
+                         meta->name, i, pi->name, pi->type_name, pi->type,
+                         pi->type_size);
+  }
+
+  ts_tree_delete(tree);
+  ts_parser_delete(parser);
+  return CL_SUCCESS;
+
+TS_ERROR:
+  ts_tree_delete(tree);
+  ts_parser_delete(parser);
+  return err;
+}
+#endif
+
 static void
 set_build_log (cl_device_id proxy_dev, cl_program program,
                cl_program proxy_prog, unsigned device_i)
@@ -1401,8 +1522,8 @@ pocl_proxy_setup_metadata (cl_device_id device, cl_program program,
   cl_program proxy_prog = (cl_program)program->data[program_device_i];
 
   // Return if there is no metadata and we are not building using a binary.
-  if (!(d->backend->provides_metadata ||
-      (d->backend->supports_il && program->program_il_size > 0)))
+  if (!(d->backend->provides_metadata || HAVE_TREE_SITTER ||
+        (d->backend->supports_il && program->program_il_size > 0)))
     return 0;
 
   assert(program->kernel_meta == NULL);
@@ -1471,8 +1592,9 @@ pocl_proxy_setup_metadata (cl_device_id device, cl_program program,
       index++;
     }
 
-  } else {
+  } else if (d->backend->provides_metadata) {
     for (cl_uint i = 0; i < num_kernels; ++i) {
+
       err = get_kernel_metadata(p + i, program->num_devices, proxy_prog,
                                 d->device_id, kernels[i]);
       if (err != CL_SUCCESS) {
@@ -1483,7 +1605,21 @@ pocl_proxy_setup_metadata (cl_device_id device, cl_program program,
       err = clReleaseKernel(kernels[i]);
       assert(err == CL_SUCCESS);
     }
-  }
+  } else if (HAVE_TREE_SITTER) {
+    for (cl_uint i = 0; i < num_kernels; i++) {
+
+      err = proxy_map_source_to_metadata(program->source, p + i,
+                                         program->num_devices, d->device_id,
+                                         kernels[i]);
+      if (err != CL_SUCCESS) {
+        POCL_MSG_WARN("Failed to kernel metadata for index %d.\n", i);
+        return 0;
+      }
+
+      err = clReleaseKernel(kernels[i]);
+    }
+  } else
+    return 0;
 
   program->kernel_meta = p;
 

lib/CL/devices/tree_sitter/CMakeLists.txt

@@ -0,0 +1,43 @@
+#=============================================================================
+#   CMake build system files
+#
+#   Copyright (c) 2014-2024 pocl developers
+#
+#   Permission is hereby granted, free of charge, to any person obtaining a copy
+#   of this software and associated documentation files (the "Software"), to deal
+#   in the Software without restriction, including without limitation the rights
+#   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#   copies of the Software, and to permit persons to whom the Software is
+#   furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#   THE SOFTWARE.
+#
+#=============================================================================
+include(ExternalProject)
+
+find_program(TREE_SITTER_CLI tree-sitter DOC "Tree-sitter CLI" REQUIRED)
+
+set(EXTERNAL_INSTALL_LOCATION ${CMAKE_BINARY_DIR}/external)
+ExternalProject_Add(tree_sitter
+        GIT_REPOSITORY https://github.com/lefp/tree-sitter-opencl.git
+        # Generate Cmake config
+        PATCH_COMMAND ${TREE_SITTER_CLI} init
+        CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=${EXTERNAL_INSTALL_LOCATION} -DBUILD_SHARED_LIBS=OFF
+)
+
+add_library(pocl_tree_sitter_utils OBJECT pocl_tree_sitter_utils.c
+        pocl_tree_sitter_utils.h)
+target_include_directories(pocl_tree_sitter_utils PUBLIC ${CMAKE_CURRENT_SOURCE_DIR} ${EXTERNAL_INSTALL_LOCATION}/include)
+target_link_directories(pocl_tree_sitter_utils PUBLIC ${EXTERNAL_INSTALL_LOCATION}/lib)
+add_dependencies(pocl_tree_sitter_utils tree_sitter)
+
+target_link_libraries(pocl_tree_sitter_utils PUBLIC tree-sitter-opencl ${TSLIB})