Add UCX Plugin Gtests

Add a plugin gtest infrastructure to test baackend plugin local xfer,
remote xfer, progress and notification handling.
Add ucx plugin gtests on top of the plugin infrastructure.

Author: glevnv

meson.build

@@ -123,7 +123,8 @@ if get_option('buildtype') == 'debug'
     run_command('truncate', '-s 0', plugfile, check: true)
 endif
 
-nixl_inc_dirs = include_directories('src/api/cpp', 'src/infra', 'src/core')
+nixl_inc_dirs = include_directories('src/api/cpp', 'src/api/cpp/backend', 'src/infra', 'src/core')
+ucx_inc_dirs = include_directories('src/plugins/ucx')
 utils_inc_dirs = include_directories('src/utils')
 
 subdir('src')

test/gtest/meson.build

@@ -23,6 +23,7 @@ if not gtest_dep.found()
 endif
 
 subdir('mocks')
+subdir('plugins')
 
 plugin_dirs_arg = '--tests_plugin_dirs=' + mocks_dep.get_variable('path')
 

test/gtest/plugins/memory_handler.h

@@ -0,0 +1,123 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef __MEMORY_HANDLER_H
+#define __MEMORY_HANDLER_H
+
+template<nixl_mem_t MemType> struct MemoryHandler {
+    static void *
+    allocate(size_t len, int devId = 0) {
+        std::cerr << "Unsupported memory type!" << std::endl;
+        assert(0);
+    }
+
+    static void
+    deallocate(void *addr, int devId = 0) {
+        std::cerr << "Unsupported memory type!" << std::endl;
+        assert(0);
+    }
+
+    static void
+    set(void *addr, char byte, size_t size, int devId = 0) {
+        std::cerr << "Unsupported memory type!" << std::endl;
+        assert(0);
+    }
+
+    static void *
+    getPtr(void *addr, size_t len) {
+        std::cerr << "Unsupported memory type!" << std::endl;
+        assert(0);
+    }
+
+    static void
+    releasePtr(void *addr) {
+        std::cerr << "Unsupported memory type!" << std::endl;
+        assert(0);
+    }
+};
+
+template<> struct MemoryHandler<DRAM_SEG> {
+    static void *
+    allocate(size_t len, int devId = 0) {
+        return new char[len];
+    }
+
+    static void
+    deallocate(void *addr, int devId = 0) {
+        delete[] static_cast<char *>(addr);
+    }
+
+    static void
+    set(void *addr, char byte, size_t size, int devId = 0) {
+        memset(addr, byte, size);
+    }
+
+    static void *
+    getPtr(void *addr, size_t len) {
+        return addr;
+    }
+
+    static void
+    releasePtr(void *addr) {
+        // No-op for host memory
+    }
+};
+
+#ifdef HAVE_CUDA
+template<> struct MemoryHandler<VRAM_SEG> {
+    static void *
+    allocate(size_t len, int devId = 0) {
+        CUcontext ctx;
+        CUdevice dev;
+        bool is_dev;
+        void *ptr;
+        checkCudaError(cudaSetDevice(devId), "Failed to set device");
+        checkCudaError(cudaMalloc(&ptr, len), "Failed to allocate CUDA buffer");
+        if (cudaQueryAddr(ptr, is_dev, dev, ctx)) {
+            std::cerr << "Failed to query CUDA addr: " << std::hex << ptr << " dev=" << std::dec
+                      << dev << " ctx=" << std::hex << ctx << std::dec << std::endl;
+            assert(0);
+        }
+
+        return ptr;
+    }
+
+    static void
+    deallocate(void *addr, int devId = 0) {
+        checkCudaError(cudaSetDevice(devId), "Failed to set device");
+        checkCudaError(cudaFree(addr), "Failed to free CUDA buffer");
+    }
+
+    static void
+    set(void *addr, char byte, size_t size, int devId = 0) {
+        checkCudaError(cudaSetDevice(devId), "Failed to set device");
+        checkCudaError(cudaMemset(addr, byte, size), "Failed to memset");
+    }
+
+    static void *
+    getPtr(void *addr, size_t len) {
+        void *ptr = new char[len];
+        checkCudaError(cudaMemcpy(ptr, addr, len, cudaMemcpyDeviceToHost), "Failed to memcpy");
+        return ptr;
+    }
+
+    static void
+    releasePtr(void *addr) {
+        delete[] static_cast<char *>(addr);
+    }
+};
+#endif // HAVE_CUDA
+#endif // __MEMORY_HANDLER_H

test/gtest/plugins/meson.build

@@ -0,0 +1,65 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+gtest_dep = dependency('gtest', version : '>=1.11.0', required : false)
+absl_strings_dep = abseil_proj.get_variable('absl_strings_dep')
+absl_time_dep = abseil_proj.get_variable('absl_time_dep')
+
+if not gtest_dep.found()
+    message('GTest not found, skipping gtest build')
+    subdir_done()
+endif
+
+if cuda_dep.found()
+    cuda_dependencies = [cuda_dep]
+else
+    cuda_dependencies = []
+endif
+
+cpp_flags = []
+
+if get_option('test_all_plugins')
+  cpp_flags+='-DTEST_ALL_PLUGINS'
+endif
+
+# for loading plugins from build directory
+cpp_flags += '-DBUILD_DIR="' + meson.project_build_root() + '"'
+
+plugins_test_exe = executable('ucx_plugins_gtest',
+    sources : ['../main.cpp', 'ucx_plugin.cpp', 'plugin_test.cpp'],
+    include_directories: [nixl_inc_dirs, utils_inc_dirs, ucx_inc_dirs, '.'],
+    cpp_args : cpp_flags,
+    dependencies : [nixl_dep, cuda_dep, gtest_dep, absl_strings_dep, absl_time_dep, ucx_backend_interface, ucx_dep],
+    link_with: [nixl_build_lib, ucx_backend_lib],
+    install : true
+)
+
+test('plugins_gtest', plugins_test_exe)
+
+if get_option('b_sanitize').split(',').contains('thread')
+    test_env = environment()
+    test_env.set('TSAN_OPTIONS', 'halt_on_error=1')
+    test_env.set('NIXL_PLUGIN_DIR', mocks_dep.get_variable('path'))
+
+    mt_test_exe = executable('mt_test',
+        sources : ['main.cpp', 'multi_threading.cpp'],
+        include_directories: [nixl_inc_dirs, utils_inc_dirs],
+        cpp_args : cpp_flags,
+        dependencies : [nixl_dep, nixl_infra, cuda_dep, gtest_dep],
+        link_with: [nixl_build_lib],
+    )
+
+    test('mt_test', mt_test_exe, is_parallel: false, env: test_env)
+endif