HalideRuntimeD3D12Compute.h

Go to the documentation of this file.

#ifndef HALIDE_HALIDERUNTIMED3D12COMPUTE_H
#define HALIDE_HALIDERUNTIMED3D12COMPUTE_H
 
// Don't include HalideRuntime.h if the contents of it were already pasted into a generated header above this one
#ifndef HALIDE_HALIDERUNTIME_H
 
#include "HalideRuntime.h"
 
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/** \file
 *  Routines specific to the Halide Direct3D 12 Compute runtime.
 */
 
extern const struct halide_device_interface_t *halide_d3d12compute_device_interface();
 
/** These are forward declared here to allow clients to override the
 *  Halide Direct3D 12 Compute runtime. Do not call them. */
// @{
extern int halide_d3d12compute_initialize_kernels(void *user_context, void **state_ptr,
                                                  const char *src, int size);
 
extern int halide_d3d12compute_run(void *user_context,
                                   void *state_ptr,
                                   const char *entry_name,
                                   int blocksX, int blocksY, int blocksZ,
                                   int threadsX, int threadsY, int threadsZ,
                                   int shared_mem_bytes,
                                   struct halide_type_t arg_types[], void *args[], int8_t arg_is_buffer[]);
extern void halide_d3d12compute_finalize_kernels(void *user_context, void *state_ptr);
// @}
 
/** Set the underlying ID3D12Resource for a halide_buffer_t. The memory backing
 * the resource should be managed by the caller (via a default/device heap) and
 * must be large enough to cover the extent of the halide_buffer_t. The device
 * field of the halide_buffer_t must be NULL when this routine is called. This
 * call can fail due to running out of memory or if an invalid D3D12 resource is
 * passed. The device and host dirty bits are left unmodified. */
extern int halide_d3d12compute_wrap_buffer(void *user_context, struct halide_buffer_t *buf, uint64_t d3d12_resource);
 
/** Disconnect a halide_buffer_t from the ID3D12Resource it was previously
 * wrapped around. Should only be called for a halide_buffer_t that
 * halide_d3d12compute_wrap_buffer was previously called on. Frees any
 * storage associated with the binding of the halide_buffer_t and the
 * buffer, but does not free the ID3D12Resource. The dev field of the
 * halide_buffer_t will be NULL on return.
 */
extern int halide_d3d12compute_detach_buffer(void *user_context, struct halide_buffer_t *buf);
 
/** Return the underlying ID3D12Resource for a halide_buffer_t. This resource
 * must be valid on an D3D12 device, unless halide_buffer_t has no associated
 * resource. If there is no device memory (device field is NULL), returns 0.
 */
extern uintptr_t halide_d3d12compute_get_buffer(void *user_context, struct halide_buffer_t *buf);
 
struct halide_d3d12compute_device;
struct halide_d3d12compute_command_queue;
 
/** This prototype is exported as applications will typically need to
 * replace it to get Halide filters to execute on the same device and
 * command queue used for other purposes. The halide_d3d12compute_device is an
 * ID3D12Device and halide_d3d12compute_command_queue is an ID3D12CommandQueue.
 * No reference counting is done by Halide on these objects. They must remain
 * valid until all off the following are true:
 * - A balancing halide_d3d12compute_release_context has occurred for each
 *     halide_d3d12compute_acquire_context which returned the device/queue
 * - All Halide filters using the context information have completed
 * - All halide_buffer_t objects on the device have had
 *     halide_device_free called or have been detached via
 *     halide_d3d12compute_detach_buffer.
 * - halide_device_release has been called on the interface returned from
 *     halide_d3d12compute_device_interface(). (This releases the programs on the context.)
 */
extern int halide_d3d12compute_acquire_context(void *user_context, struct halide_d3d12compute_device **device_ret,
                                               struct halide_d3d12compute_command_queue **queue_ret, bool create);
 
/** This call balances each successful halide_d3d12compute_acquire_context call.
 * If halide_d3d12compute_acquire_context is replaced, this routine must be replaced
 * as well.
 */
extern int halide_d3d12compute_release_context(void *user_context);
 
#ifdef __cplusplus
}  // End extern "C"
#endif
 
#endif  // HALIDE_HALIDERUNTIMED3D12COMPUTE_H