StarPU Handbook - StarPU Basics
Loading...
Searching...
No Matches
starpu_data_interfaces.h File Reference
#include <starpu.h>
#include <cuda_runtime.h>
#include <hip/hip_runtime.h>

Go to the source code of this file.

Data Structures

struct  starpu_data_copy_methods
 
struct  starpu_data_interface_ops
 
struct  starpu_matrix_interface
 
struct  starpu_coo_interface
 
struct  starpu_block_interface
 
struct  starpu_tensor_interface
 
struct  starpu_ndim_interface
 
struct  starpu_vector_interface
 
struct  starpu_variable_interface
 
struct  starpu_csr_interface
 
struct  starpu_bcsr_interface
 
struct  starpu_multiformat_data_interface_ops
 
struct  starpu_multiformat_interface
 

Typedefs

typedef cudaStream_t starpu_cudaStream_t
 
typedef hipStream_t starpu_hipStream_t
 

Enumerations

enum  starpu_data_interface_id {
  STARPU_UNKNOWN_INTERFACE_ID , STARPU_MATRIX_INTERFACE_ID , STARPU_BLOCK_INTERFACE_ID , STARPU_VECTOR_INTERFACE_ID ,
  STARPU_CSR_INTERFACE_ID , STARPU_BCSR_INTERFACE_ID , STARPU_VARIABLE_INTERFACE_ID , STARPU_VOID_INTERFACE_ID ,
  STARPU_MULTIFORMAT_INTERFACE_ID , STARPU_COO_INTERFACE_ID , STARPU_TENSOR_INTERFACE_ID , STARPU_NDIM_INTERFACE_ID ,
  STARPU_MAX_INTERFACE_ID
}
 

Functions

Basic API
void starpu_data_register (starpu_data_handle_t *handleptr, int home_node, void *data_interface, struct starpu_data_interface_ops *ops)
 
void starpu_data_register_ops (struct starpu_data_interface_ops *ops)
 
void starpu_data_ptr_register (starpu_data_handle_t handle, unsigned node)
 
void starpu_data_register_same (starpu_data_handle_t *handledst, starpu_data_handle_t handlesrc)
 
void * starpu_data_handle_to_pointer (starpu_data_handle_t handle, unsigned node)
 
void * starpu_data_get_local_ptr (starpu_data_handle_t handle)
 
void * starpu_data_get_interface_on_node (starpu_data_handle_t handle, unsigned memory_node)
 
enum starpu_data_interface_id starpu_data_get_interface_id (starpu_data_handle_t handle)
 
int starpu_data_pack_node (starpu_data_handle_t handle, unsigned node, void **ptr, starpu_ssize_t *count)
 
int starpu_data_pack (starpu_data_handle_t handle, void **ptr, starpu_ssize_t *count)
 
int starpu_data_peek_node (starpu_data_handle_t handle, unsigned node, void *ptr, size_t count)
 
int starpu_data_peek (starpu_data_handle_t handle, void *ptr, size_t count)
 
int starpu_data_unpack_node (starpu_data_handle_t handle, unsigned node, void *ptr, size_t count)
 
int starpu_data_unpack (starpu_data_handle_t handle, void *ptr, size_t count)
 
size_t starpu_data_get_size (starpu_data_handle_t handle)
 
size_t starpu_data_get_alloc_size (starpu_data_handle_t handle)
 
starpu_ssize_t starpu_data_get_max_size (starpu_data_handle_t handle)
 
int starpu_data_get_home_node (starpu_data_handle_t handle)
 
void starpu_data_print (starpu_data_handle_t handle, unsigned node, FILE *stream)
 
int starpu_data_interface_get_next_id (void)
 
int starpu_interface_copy (uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t size, void *async_data)
 
int starpu_interface_copy2d (uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t blocksize, size_t numblocks, size_t ld_src, size_t ld_dst, void *async_data)
 
int starpu_interface_copy3d (uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t blocksize, size_t numblocks1, size_t ld1_src, size_t ld1_dst, size_t numblocks2, size_t ld2_src, size_t ld2_dst, void *async_data)
 
int starpu_interface_copy4d (uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t blocksize, size_t numblocks1, size_t ld1_src, size_t ld1_dst, size_t numblocks2, size_t ld2_src, size_t ld2_dst, size_t numblocks3, size_t ld3_src, size_t ld3_dst, void *async_data)
 
int starpu_interface_copynd (uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t elemsize, size_t ndim, uint32_t *nn, uint32_t *ldn_src, uint32_t *ldn_dst, void *async_data)
 
void starpu_interface_start_driver_copy_async (unsigned src_node, unsigned dst_node, double *start)
 
void starpu_interface_end_driver_copy_async (unsigned src_node, unsigned dst_node, double start)
 
void starpu_interface_data_copy (unsigned src_node, unsigned dst_node, size_t size)
 
uintptr_t starpu_malloc_on_node_flags (unsigned dst_node, size_t size, int flags)
 
uintptr_t starpu_malloc_on_node (unsigned dst_node, size_t size)
 
void starpu_free_on_node_flags (unsigned dst_node, uintptr_t addr, size_t size, int flags)
 
void starpu_free_on_node (unsigned dst_node, uintptr_t addr, size_t size)
 
void starpu_malloc_on_node_set_default_flags (unsigned node, int flags)
 
MAP API
uintptr_t starpu_interface_map (uintptr_t src, size_t src_offset, unsigned src_node, unsigned dst_node, size_t size, int *ret)
 
int starpu_interface_unmap (uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, unsigned dst_node, size_t size)
 
int starpu_interface_update_map (uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t size)
 

Accessing Matrix Data Interfaces

#define STARPU_MATRIX_GET_PTR(interface)
 
#define STARPU_MATRIX_GET_DEV_HANDLE(interface)
 
#define STARPU_MATRIX_GET_OFFSET(interface)
 
#define STARPU_MATRIX_GET_NX(interface)
 
#define STARPU_MATRIX_GET_NY(interface)
 
#define STARPU_MATRIX_GET_LD(interface)
 
#define STARPU_MATRIX_GET_ELEMSIZE(interface)
 
#define STARPU_MATRIX_GET_ALLOCSIZE(interface)
 
#define STARPU_MATRIX_SET_NX(interface, newnx)
 
#define STARPU_MATRIX_SET_NY(interface, newny)
 
#define STARPU_MATRIX_SET_LD(interface, newld)
 
struct starpu_data_interface_ops starpu_interface_matrix_ops
 
void starpu_matrix_data_register (starpu_data_handle_t *handle, int home_node, uintptr_t ptr, uint32_t ld, uint32_t nx, uint32_t ny, size_t elemsize)
 
void starpu_matrix_data_register_allocsize (starpu_data_handle_t *handle, int home_node, uintptr_t ptr, uint32_t ld, uint32_t nx, uint32_t ny, size_t elemsize, size_t allocsize)
 
void starpu_matrix_ptr_register (starpu_data_handle_t handle, unsigned node, uintptr_t ptr, uintptr_t dev_handle, size_t offset, uint32_t ld)
 
uint32_t starpu_matrix_get_nx (starpu_data_handle_t handle)
 
uint32_t starpu_matrix_get_ny (starpu_data_handle_t handle)
 
uint32_t starpu_matrix_get_local_ld (starpu_data_handle_t handle)
 
uintptr_t starpu_matrix_get_local_ptr (starpu_data_handle_t handle)
 
size_t starpu_matrix_get_elemsize (starpu_data_handle_t handle)
 
size_t starpu_matrix_get_allocsize (starpu_data_handle_t handle)
 

Accessing COO Data Interfaces

#define STARPU_COO_GET_COLUMNS(interface)
 
#define STARPU_COO_GET_COLUMNS_DEV_HANDLE(interface)
 
#define STARPU_COO_GET_ROWS(interface)
 
#define STARPU_COO_GET_ROWS_DEV_HANDLE(interface)
 
#define STARPU_COO_GET_VALUES(interface)
 
#define STARPU_COO_GET_VALUES_DEV_HANDLE(interface)
 
#define STARPU_COO_GET_OFFSET
 
#define STARPU_COO_GET_NX(interface)
 
#define STARPU_COO_GET_NY(interface)
 
#define STARPU_COO_GET_NVALUES(interface)
 
#define STARPU_COO_GET_ELEMSIZE(interface)
 
struct starpu_data_interface_ops starpu_interface_coo_ops
 
void starpu_coo_data_register (starpu_data_handle_t *handleptr, int home_node, uint32_t nx, uint32_t ny, uint32_t n_values, uint32_t *columns, uint32_t *rows, uintptr_t values, size_t elemsize)
 

Block Data Interface

#define STARPU_BLOCK_GET_PTR(interface)
 
#define STARPU_BLOCK_GET_DEV_HANDLE(interface)
 
#define STARPU_BLOCK_GET_OFFSET(interface)
 
#define STARPU_BLOCK_GET_NX(interface)
 
#define STARPU_BLOCK_GET_NY(interface)
 
#define STARPU_BLOCK_GET_NZ(interface)
 
#define STARPU_BLOCK_GET_LDY(interface)
 
#define STARPU_BLOCK_GET_LDZ(interface)
 
#define STARPU_BLOCK_GET_ELEMSIZE(interface)
 
struct starpu_data_interface_ops starpu_interface_block_ops
 
void starpu_block_data_register (starpu_data_handle_t *handle, int home_node, uintptr_t ptr, uint32_t ldy, uint32_t ldz, uint32_t nx, uint32_t ny, uint32_t nz, size_t elemsize)
 
void starpu_block_ptr_register (starpu_data_handle_t handle, unsigned node, uintptr_t ptr, uintptr_t dev_handle, size_t offset, uint32_t ldy, uint32_t ldz)
 
uint32_t starpu_block_get_nx (starpu_data_handle_t handle)
 
uint32_t starpu_block_get_ny (starpu_data_handle_t handle)
 
uint32_t starpu_block_get_nz (starpu_data_handle_t handle)
 
uint32_t starpu_block_get_local_ldy (starpu_data_handle_t handle)
 
uint32_t starpu_block_get_local_ldz (starpu_data_handle_t handle)
 
uintptr_t starpu_block_get_local_ptr (starpu_data_handle_t handle)
 
size_t starpu_block_get_elemsize (starpu_data_handle_t handle)
 

Tensor Data Interface

#define STARPU_TENSOR_GET_PTR(interface)
 
#define STARPU_TENSOR_GET_DEV_HANDLE(interface)
 
#define STARPU_TENSOR_GET_OFFSET(interface)
 
#define STARPU_TENSOR_GET_NX(interface)
 
#define STARPU_TENSOR_GET_NY(interface)
 
#define STARPU_TENSOR_GET_NZ(interface)
 
#define STARPU_TENSOR_GET_NT(interface)
 
#define STARPU_TENSOR_GET_LDY(interface)
 
#define STARPU_TENSOR_GET_LDZ(interface)
 
#define STARPU_TENSOR_GET_LDT(interface)
 
#define STARPU_TENSOR_GET_ELEMSIZE(interface)
 
struct starpu_data_interface_ops starpu_interface_tensor_ops
 
void starpu_tensor_data_register (starpu_data_handle_t *handle, int home_node, uintptr_t ptr, uint32_t ldy, uint32_t ldz, uint32_t ldt, uint32_t nx, uint32_t ny, uint32_t nz, uint32_t nt, size_t elemsize)
 
void starpu_tensor_ptr_register (starpu_data_handle_t handle, unsigned node, uintptr_t ptr, uintptr_t dev_handle, size_t offset, uint32_t ldy, uint32_t ldz, uint32_t ldt)
 
uint32_t starpu_tensor_get_nx (starpu_data_handle_t handle)
 
uint32_t starpu_tensor_get_ny (starpu_data_handle_t handle)
 
uint32_t starpu_tensor_get_nz (starpu_data_handle_t handle)
 
uint32_t starpu_tensor_get_nt (starpu_data_handle_t handle)
 
uint32_t starpu_tensor_get_local_ldy (starpu_data_handle_t handle)
 
uint32_t starpu_tensor_get_local_ldz (starpu_data_handle_t handle)
 
uint32_t starpu_tensor_get_local_ldt (starpu_data_handle_t handle)
 
uintptr_t starpu_tensor_get_local_ptr (starpu_data_handle_t handle)
 
size_t starpu_tensor_get_elemsize (starpu_data_handle_t handle)
 

Ndim Array Data Interface

#define STARPU_NDIM_GET_PTR(interface)
 
#define STARPU_NDIM_GET_DEV_HANDLE(interface)
 
#define STARPU_NDIM_GET_OFFSET(interface)
 
#define STARPU_NDIM_GET_NN(interface)
 
#define STARPU_NDIM_GET_LDN(interface)
 
#define STARPU_NDIM_GET_NDIM(interface)
 
#define STARPU_NDIM_GET_ELEMSIZE(interface)
 
struct starpu_data_interface_ops starpu_interface_ndim_ops
 
void starpu_ndim_data_register (starpu_data_handle_t *handleptr, int home_node, uintptr_t ptr, uint32_t *ldn, uint32_t *nn, size_t ndim, size_t elemsize)
 
void starpu_ndim_ptr_register (starpu_data_handle_t handle, unsigned node, uintptr_t ptr, uintptr_t dev_handle, size_t offset, uint32_t *ldn)
 
uint32_t * starpu_ndim_get_nn (starpu_data_handle_t handle)
 
uint32_t starpu_ndim_get_ni (starpu_data_handle_t handle, size_t i)
 
uint32_t * starpu_ndim_get_local_ldn (starpu_data_handle_t handle)
 
uint32_t starpu_ndim_get_local_ldi (starpu_data_handle_t handle, size_t i)
 
uintptr_t starpu_ndim_get_local_ptr (starpu_data_handle_t handle)
 
size_t starpu_ndim_get_ndim (starpu_data_handle_t handle)
 
size_t starpu_ndim_get_elemsize (starpu_data_handle_t handle)
 

Vector Data Interface

#define STARPU_VECTOR_GET_PTR(interface)
 
#define STARPU_VECTOR_GET_DEV_HANDLE(interface)
 
#define STARPU_VECTOR_GET_OFFSET(interface)
 
#define STARPU_VECTOR_GET_NX(interface)
 
#define STARPU_VECTOR_GET_ELEMSIZE(interface)
 
#define STARPU_VECTOR_GET_ALLOCSIZE(interface)
 
#define STARPU_VECTOR_GET_SLICE_BASE(interface)
 
#define STARPU_VECTOR_SET_NX(interface, newnx)
 
struct starpu_data_interface_ops starpu_interface_vector_ops
 
void starpu_vector_data_register (starpu_data_handle_t *handle, int home_node, uintptr_t ptr, uint32_t nx, size_t elemsize)
 
void starpu_vector_data_register_allocsize (starpu_data_handle_t *handle, int home_node, uintptr_t ptr, uint32_t nx, size_t elemsize, size_t allocsize)
 
void starpu_vector_ptr_register (starpu_data_handle_t handle, unsigned node, uintptr_t ptr, uintptr_t dev_handle, size_t offset)
 
uint32_t starpu_vector_get_nx (starpu_data_handle_t handle)
 
size_t starpu_vector_get_elemsize (starpu_data_handle_t handle)
 
size_t starpu_vector_get_allocsize (starpu_data_handle_t handle)
 
uintptr_t starpu_vector_get_local_ptr (starpu_data_handle_t handle)
 

Variable Data Interface

#define STARPU_VARIABLE_GET_PTR(interface)
 
#define STARPU_VARIABLE_GET_OFFSET(interface)
 
#define STARPU_VARIABLE_GET_ELEMSIZE(interface)
 
#define STARPU_VARIABLE_GET_DEV_HANDLE(interface)
 
struct starpu_data_interface_ops starpu_interface_variable_ops
 
void starpu_variable_data_register (starpu_data_handle_t *handle, int home_node, uintptr_t ptr, size_t size)
 
void starpu_variable_ptr_register (starpu_data_handle_t handle, unsigned node, uintptr_t ptr, uintptr_t dev_handle, size_t offset)
 
size_t starpu_variable_get_elemsize (starpu_data_handle_t handle)
 
uintptr_t starpu_variable_get_local_ptr (starpu_data_handle_t handle)
 

CSR Data Interface

#define STARPU_CSR_GET_NNZ(interface)
 
#define STARPU_CSR_GET_NROW(interface)
 
#define STARPU_CSR_GET_NZVAL(interface)
 
#define STARPU_CSR_GET_NZVAL_DEV_HANDLE(interface)
 
#define STARPU_CSR_GET_COLIND(interface)
 
#define STARPU_CSR_GET_RAM_COLIND(interface)
 
#define STARPU_CSR_GET_COLIND_DEV_HANDLE(interface)
 
#define STARPU_CSR_GET_ROWPTR(interface)
 
#define STARPU_CSR_GET_RAM_ROWPTR(interface)
 
#define STARPU_CSR_GET_ROWPTR_DEV_HANDLE(interface)
 
#define STARPU_CSR_GET_OFFSET
 
#define STARPU_CSR_GET_FIRSTENTRY(interface)
 
#define STARPU_CSR_GET_ELEMSIZE(interface)
 
struct starpu_data_interface_ops starpu_interface_csr_ops
 
void starpu_csr_data_register (starpu_data_handle_t *handle, int home_node, uint32_t nnz, uint32_t nrow, uintptr_t nzval, uint32_t *colind, uint32_t *rowptr, uint32_t firstentry, size_t elemsize)
 
uint32_t starpu_csr_get_nnz (starpu_data_handle_t handle)
 
uint32_t starpu_csr_get_nrow (starpu_data_handle_t handle)
 
uint32_t starpu_csr_get_firstentry (starpu_data_handle_t handle)
 
uintptr_t starpu_csr_get_local_nzval (starpu_data_handle_t handle)
 
uint32_t * starpu_csr_get_local_colind (starpu_data_handle_t handle)
 
uint32_t * starpu_csr_get_local_rowptr (starpu_data_handle_t handle)
 
size_t starpu_csr_get_elemsize (starpu_data_handle_t handle)
 

BCSR Data Interface

#define STARPU_BCSR_GET_NNZ(interface)
 
#define STARPU_BCSR_GET_NROW(interface)
 
#define STARPU_BCSR_GET_NZVAL(interface)
 
#define STARPU_BCSR_GET_NZVAL_DEV_HANDLE(interface)
 
#define STARPU_BCSR_GET_COLIND(interface)
 
#define STARPU_BCSR_GET_RAM_COLIND(interface)
 
#define STARPU_BCSR_GET_COLIND_DEV_HANDLE(interface)
 
#define STARPU_BCSR_GET_ROWPTR(interface)
 
#define STARPU_BCSR_GET_RAM_ROWPTR(interface)
 
#define STARPU_BCSR_GET_ROWPTR_DEV_HANDLE(interface)
 
#define STARPU_BCSR_GET_FIRSTENTRY(interface)
 
#define STARPU_BCSR_GET_R(interface)
 
#define STARPU_BCSR_GET_C(interface)
 
#define STARPU_BCSR_GET_ELEMSIZE(interface)
 
#define STARPU_BCSR_GET_OFFSET
 
struct starpu_data_interface_ops starpu_interface_bcsr_ops
 
void starpu_bcsr_data_register (starpu_data_handle_t *handle, int home_node, uint32_t nnz, uint32_t nrow, uintptr_t nzval, uint32_t *colind, uint32_t *rowptr, uint32_t firstentry, uint32_t r, uint32_t c, size_t elemsize)
 
uint32_t starpu_bcsr_get_nnz (starpu_data_handle_t handle)
 
uint32_t starpu_bcsr_get_nrow (starpu_data_handle_t handle)
 
uint32_t starpu_bcsr_get_firstentry (starpu_data_handle_t handle)
 
uintptr_t starpu_bcsr_get_local_nzval (starpu_data_handle_t handle)
 
uint32_t * starpu_bcsr_get_local_colind (starpu_data_handle_t handle)
 
uint32_t * starpu_bcsr_get_local_rowptr (starpu_data_handle_t handle)
 
uint32_t starpu_bcsr_get_r (starpu_data_handle_t handle)
 
uint32_t starpu_bcsr_get_c (starpu_data_handle_t handle)
 
size_t starpu_bcsr_get_elemsize (starpu_data_handle_t handle)
 

Multiformat Data Interface

#define STARPU_MULTIFORMAT_GET_CPU_PTR(interface)
 
#define STARPU_MULTIFORMAT_GET_CUDA_PTR(interface)
 
#define STARPU_MULTIFORMAT_GET_HIP_PTR(interface)
 
#define STARPU_MULTIFORMAT_GET_OPENCL_PTR(interface)
 
#define STARPU_MULTIFORMAT_GET_NX(interface)
 
void starpu_multiformat_data_register (starpu_data_handle_t *handle, int home_node, void *ptr, uint32_t nobjects, struct starpu_multiformat_data_interface_ops *format_ops)
 

Void Data Interface

struct starpu_data_interface_ops starpu_interface_void_ops
 
void starpu_void_data_register (starpu_data_handle_t *handle)