rocm-systems/projects/clr/rocclr/include/vdi_agent_amd.h

/* Copyright (c) 2010 - 2021 Advanced Micro Devices, Inc.

 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 _VDI_AGENT_AMD_H
#define _VDI_AGENT_AMD_H

#include <CL/cl.h>
#include "amdocl/cl_icd_amd.h"
#include <stdint.h>

#define cl_amd_agent 1

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef const struct _vdi_agent vdi_agent;

#define VDI_AGENT_VERSION_1_0 100

/* Context Callbacks */

typedef void(CL_CALLBACK* acContextCreate_fn)(vdi_agent* /* agent */, cl_context /* context */);

typedef void(CL_CALLBACK* acContextFree_fn)(vdi_agent* /* agent */, cl_context /* context */);

/* Command Queue Callbacks */

typedef void(CL_CALLBACK* acCommandQueueCreate_fn)(vdi_agent* /* agent */,
                                                   cl_command_queue /* queue */);

typedef void(CL_CALLBACK* acCommandQueueFree_fn)(vdi_agent* /* agent */,
                                                 cl_command_queue /* queue */);

/* Event Callbacks */

typedef void(CL_CALLBACK* acEventCreate_fn)(vdi_agent* /* agent */, cl_event /* event */,
                                            cl_command_type /* type */);

typedef void(CL_CALLBACK* acEventFree_fn)(vdi_agent* /* agent */, cl_event /* event */);

typedef void(CL_CALLBACK* acEventStatusChanged_fn)(vdi_agent* /* agent */, cl_event /* event */,
                                                   int32_t /* execution_status */,
                                                   int64_t /* epoch_time_stamp */);

/* Memory Object Callbacks */

typedef void(CL_CALLBACK* acMemObjectCreate_fn)(vdi_agent* /* agent */, cl_mem /* memobj */);

typedef void(CL_CALLBACK* acMemObjectFree_fn)(vdi_agent* /* agent */, cl_mem /* memobj */);

typedef void(CL_CALLBACK* acMemObjectAcquired_fn)(vdi_agent* /* agent */, cl_mem /* memobj */,
                                                  cl_device_id /* device */,
                                                  int64_t /* elapsed_time */);

/* Sampler Callbacks */

typedef void(CL_CALLBACK* acSamplerCreate_fn)(vdi_agent* /* agent */, cl_sampler /* sampler */);

typedef void(CL_CALLBACK* acSamplerFree_fn)(vdi_agent* /* agent */, cl_sampler /* sampler */);

/* Program Callbacks */

typedef void(CL_CALLBACK* acProgramCreate_fn)(vdi_agent* /* agent */, cl_program /* program */);

typedef void(CL_CALLBACK* acProgramFree_fn)(vdi_agent* /* agent */, cl_program /* program */);

typedef void(CL_CALLBACK* acProgramBuild_fn)(vdi_agent* /* agent */, cl_program /* program */);

/* Kernel Callbacks */

typedef void(CL_CALLBACK* acKernelCreate_fn)(vdi_agent* /* agent */, cl_kernel /* kernel */);

typedef void(CL_CALLBACK* acKernelFree_fn)(vdi_agent* /* agent */, cl_kernel /* kernel */);

typedef void(CL_CALLBACK* acKernelSetArg_fn)(vdi_agent* /* agent */, cl_kernel /* kernel */,
                                             int32_t /* arg_index */, size_t /* size */,
                                             const void* /* value_ptr */);

typedef struct _vdi_agent_callbacks {
  /* Context Callbacks */
  acContextCreate_fn ContextCreate;
  acContextFree_fn ContextFree;

  /* Command Queue Callbacks */
  acCommandQueueCreate_fn CommandQueueCreate;
  acCommandQueueFree_fn CommandQueueFree;

  /* Event Callbacks */
  acEventCreate_fn EventCreate;
  acEventFree_fn EventFree;
  acEventStatusChanged_fn EventStatusChanged;

  /* Memory Object Callbacks */
  acMemObjectCreate_fn MemObjectCreate;
  acMemObjectFree_fn MemObjectFree;
  acMemObjectAcquired_fn MemObjectAcquired;

  /* Sampler Callbacks */
  acSamplerCreate_fn SamplerCreate;
  acSamplerFree_fn SamplerFree;

  /* Program Callbacks */
  acProgramCreate_fn ProgramCreate;
  acProgramFree_fn ProgramFree;
  acProgramBuild_fn ProgramBuild;

  /* Kernel Callbacks */
  acKernelCreate_fn KernelCreate;
  acKernelFree_fn KernelFree;
  acKernelSetArg_fn KernelSetArg;

} vdi_agent_callbacks;

typedef uint32_t vdi_agent_capability_action;

#define VDI_AGENT_ADD_CAPABILITIES 0x0
#define VDI_AGENT_RELINQUISH_CAPABILITIES 0x1

typedef struct _vdi_agent_capabilities {
  uint64_t canGenerateContextEvents : 1;
  uint64_t canGenerateCommandQueueEvents : 1;
  uint64_t canGenerateEventEvents : 1;
  uint64_t canGenerateMemObjectEvents : 1;
  uint64_t canGenerateSamplerEvents : 1;
  uint64_t canGenerateProgramEvents : 1;
  uint64_t canGenerateKernelEvents : 1;

} vdi_agent_capabilities;

struct _vdi_agent {
  int32_t(CL_API_CALL* GetVersionNumber)(vdi_agent* /* agent */, int32_t* /* version_ret */);

  int32_t(CL_API_CALL* GetPlatform)(vdi_agent* /* agent */, cl_platform_id* /* platform_id_ret */);

  int32_t(CL_API_CALL* GetTime)(vdi_agent* /* agent */, int64_t* /* time_nanos */);

  int32_t(CL_API_CALL* SetCallbacks)(vdi_agent* /* agent */,
                                     const vdi_agent_callbacks* /* callbacks */, size_t /* size */);


  int32_t(CL_API_CALL* GetPotentialCapabilities)(vdi_agent* /* agent */,
                                                 vdi_agent_capabilities* /* capabilities */);

  int32_t(CL_API_CALL* GetCapabilities)(vdi_agent* /* agent */,
                                        vdi_agent_capabilities* /* capabilities */);

  int32_t(CL_API_CALL* SetCapabilities)(vdi_agent* /* agent */,
                                        const vdi_agent_capabilities* /* capabilities */,
                                        vdi_agent_capability_action /* action */);


  int32_t(CL_API_CALL* GetICDDispatchTable)(vdi_agent* /* agent */,
                                            cl_icd_dispatch_table* /* table */, size_t /* size */);

  int32_t(CL_API_CALL* SetICDDispatchTable)(vdi_agent* /* agent */,
                                            const cl_icd_dispatch_table* /* table */,
                                            size_t /* size */);

  /* add Kernel/Program helper functions, etc... */
};

extern int32_t CL_CALLBACK vdiAgent_OnLoad(vdi_agent* /* agent */);

extern void CL_CALLBACK vdiAgent_OnUnload(vdi_agent* /* agent */);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _VDI_AGENT_AMD_H */