rocm-systems/dxcore_loader.h

/*
 * Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved.
 *
 * 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.
 */

#ifndef LIBROCDXG_DXCORE_LOADER_H
#define LIBROCDXG_DXCORE_LOADER_H

#include "impl/wddm/types.h"
#include <dlfcn.h>
#include <mutex>

#define DXCORE_CALL(function_name)  wsl::thunk::dxcore::DxcoreLoader::Instance().pfn_##function_name

namespace wsl {
namespace thunk {
namespace dxcore {

/**
 * @brief DxcoreLoader class for dynamic loading of libdxcore.so
 * 
 * This class provides a singleton loader for the DXCore library, allowing
 * optional loading based on environment variable LIBROCDXG_ENABLE_DXCORE.
 * Supported values: "1", "true", "yes" (case-sensitive).
 * If not set or invalid, fallback to stub implementations.
 * 
 * Thread-safe initialization using std::call_once.
 */

// Macro definitions mimicking HSAKMT design
#define DXCORE_DEF(function_name)   PFN##function_name
#define DXCORE_PFN(function_name)   pfn_##function_name

class DxcoreLoader {
public:
    // D3DKMT function type definitions
    typedef NTSTATUS (DXCORE_DEF(D3DKMTCreateAllocation2))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTDestroyAllocation2))(void *args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTMapGpuVirtualAddress))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTReserveGpuVirtualAddress))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTFreeGpuVirtualAddress))(void *args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTCreateDevice))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTDestroyDevice))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTEnumAdapters2))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTQueryAdapterInfo))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTCreateContextVirtual))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTDestroyContext))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTSubmitCommand))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTCreateSynchronizationObject2))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTDestroySynchronizationObject))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTQueryStatistics))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTEscape))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTLock2))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTUnlock2))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTCreatePagingQueue))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTDestroyPagingQueue))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTWaitForSynchronizationObjectFromGpu))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTSignalSynchronizationObjectFromGpu))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTWaitForSynchronizationObjectFromCpu))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTQueryClockCalibration))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTMakeResident))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTEvict))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTShareObjects))(size_t num_allocations, WinResourceHandle* resource, OBJECT_ATTRIBUTES* obj_attr, uint32_t flags, void** nt_handle);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTQueryResourceInfoFromNtHandle))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTOpenResourceFromNtHandle))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTCreateHwQueue))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTDestroyHwQueue))(void* args);
    typedef NTSTATUS (DXCORE_DEF(D3DKMTSubmitCommandToHwQueue))(void* args);

    static DxcoreLoader& Instance() {
        static DxcoreLoader* instance = new DxcoreLoader();
        return (*instance);
    }

    bool Initialize();
    void Shutdown();
    bool IsLoaded() const { return dxcore_handle_ != nullptr; }

    // Function pointer declarations
    DXCORE_DEF(D3DKMTCreateAllocation2)* DXCORE_PFN(D3DKMTCreateAllocation2);
    DXCORE_DEF(D3DKMTDestroyAllocation2)* DXCORE_PFN(D3DKMTDestroyAllocation2);
    DXCORE_DEF(D3DKMTMapGpuVirtualAddress)* DXCORE_PFN(D3DKMTMapGpuVirtualAddress);
    DXCORE_DEF(D3DKMTReserveGpuVirtualAddress)* DXCORE_PFN(D3DKMTReserveGpuVirtualAddress);
    DXCORE_DEF(D3DKMTFreeGpuVirtualAddress)* DXCORE_PFN(D3DKMTFreeGpuVirtualAddress);
    DXCORE_DEF(D3DKMTCreateDevice)* DXCORE_PFN(D3DKMTCreateDevice);
    DXCORE_DEF(D3DKMTDestroyDevice)* DXCORE_PFN(D3DKMTDestroyDevice);
    DXCORE_DEF(D3DKMTEnumAdapters2)* DXCORE_PFN(D3DKMTEnumAdapters2);
    DXCORE_DEF(D3DKMTQueryAdapterInfo)* DXCORE_PFN(D3DKMTQueryAdapterInfo);
    DXCORE_DEF(D3DKMTCreateContextVirtual)* DXCORE_PFN(D3DKMTCreateContextVirtual);
    DXCORE_DEF(D3DKMTDestroyContext)* DXCORE_PFN(D3DKMTDestroyContext);
    DXCORE_DEF(D3DKMTSubmitCommand)* DXCORE_PFN(D3DKMTSubmitCommand);
    DXCORE_DEF(D3DKMTCreateSynchronizationObject2)* DXCORE_PFN(D3DKMTCreateSynchronizationObject2);
    DXCORE_DEF(D3DKMTDestroySynchronizationObject)* DXCORE_PFN(D3DKMTDestroySynchronizationObject);
    DXCORE_DEF(D3DKMTQueryStatistics)* DXCORE_PFN(D3DKMTQueryStatistics);
    DXCORE_DEF(D3DKMTEscape)* DXCORE_PFN(D3DKMTEscape);
    DXCORE_DEF(D3DKMTLock2)* DXCORE_PFN(D3DKMTLock2);
    DXCORE_DEF(D3DKMTUnlock2)* DXCORE_PFN(D3DKMTUnlock2);
    DXCORE_DEF(D3DKMTCreatePagingQueue)* DXCORE_PFN(D3DKMTCreatePagingQueue);
    DXCORE_DEF(D3DKMTDestroyPagingQueue)* DXCORE_PFN(D3DKMTDestroyPagingQueue);
    DXCORE_DEF(D3DKMTWaitForSynchronizationObjectFromGpu)* DXCORE_PFN(D3DKMTWaitForSynchronizationObjectFromGpu);
    DXCORE_DEF(D3DKMTSignalSynchronizationObjectFromGpu)* DXCORE_PFN(D3DKMTSignalSynchronizationObjectFromGpu);
    DXCORE_DEF(D3DKMTWaitForSynchronizationObjectFromCpu)* DXCORE_PFN(D3DKMTWaitForSynchronizationObjectFromCpu);
    DXCORE_DEF(D3DKMTQueryClockCalibration)* DXCORE_PFN(D3DKMTQueryClockCalibration);
    DXCORE_DEF(D3DKMTMakeResident)* DXCORE_PFN(D3DKMTMakeResident);
    DXCORE_DEF(D3DKMTEvict)* DXCORE_PFN(D3DKMTEvict);
    DXCORE_DEF(D3DKMTShareObjects)* DXCORE_PFN(D3DKMTShareObjects);
    DXCORE_DEF(D3DKMTQueryResourceInfoFromNtHandle)* DXCORE_PFN(D3DKMTQueryResourceInfoFromNtHandle);
    DXCORE_DEF(D3DKMTOpenResourceFromNtHandle)* DXCORE_PFN(D3DKMTOpenResourceFromNtHandle);
    DXCORE_DEF(D3DKMTCreateHwQueue)* DXCORE_PFN(D3DKMTCreateHwQueue);
    DXCORE_DEF(D3DKMTDestroyHwQueue)* DXCORE_PFN(D3DKMTDestroyHwQueue);
    DXCORE_DEF(D3DKMTSubmitCommandToHwQueue)* DXCORE_PFN(D3DKMTSubmitCommandToHwQueue);

private:
    DxcoreLoader();
    ~DxcoreLoader();

    bool LoadDxcoreApis();

    void* dxcore_handle_;
    std::once_flag init_flag_;  // For thread-safe initialization

    // Disable copy
    DxcoreLoader(const DxcoreLoader&) = delete;
    DxcoreLoader& operator=(const DxcoreLoader&) = delete;
};

} // namespace dxcore
} // namespace thunk
} // namespace wsl

#endif // LIBROCDXG_DXCORE_LOADER_H