StarPU Handbook
starpu_disk.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2013,2017 Inria
4  * Copyright (C) 2013,2014,2017,2019 CNRS
5  * Copyright (C) 2013,2014,2017 Université de Bordeaux
6  * Copyright (C) 2013 Corentin Salingue
7  *
8  * StarPU is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or (at
11  * your option) any later version.
12  *
13  * StarPU is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  *
17  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
18  */
19 
20 #ifndef __STARPU_DISK_H__
21 #define __STARPU_DISK_H__
22 
23 #include <sys/types.h>
24 #include <starpu_config.h>
25 
35 {
40  void * (*plug) (void *parameter, starpu_ssize_t size);
44  void (*unplug) (void *base);
45 
50  int (*bandwidth) (unsigned node, void *base);
51 
55  void * (*alloc) (void *base, size_t size);
56 
60  void (*free) (void *base, void *obj, size_t size);
61 
65  void * (*open) (void *base, void *pos, size_t size);
69  void (*close) (void *base, void *obj, size_t size);
70 
75  int (*read) (void *base, void *obj, void *buf, off_t offset, size_t size);
79  int (*write) (void *base, void *obj, const void *buf, off_t offset, size_t size);
80 
84  int (*full_read) (void * base, void * obj, void ** ptr, size_t * size, unsigned dst_node);
89  int (*full_write) (void * base, void * obj, void * ptr, size_t size);
90 
96  void * (*async_write) (void *base, void *obj, void *buf, off_t offset, size_t size);
102  void * (*async_read) (void *base, void *obj, void *buf, off_t offset, size_t size);
103 
107  void * (*async_full_read) (void * base, void * obj, void ** ptr, size_t * size, unsigned dst_node);
112  void * (*async_full_write) (void * base, void * obj, void * ptr, size_t size);
113 
120  void * (*copy) (void *base_src, void* obj_src, off_t offset_src, void *base_dst, void* obj_dst, off_t offset_dst, size_t size);
121 
126  void (*wait_request) (void * async_channel);
131  int (*test_request) (void * async_channel);
132 
136  void (*free_request)(void * async_channel);
137 
138  /* TODO: readv, writev, read2d, write2d, etc. */
139 };
140 
149 
160 
167 
176 
182 
186 void starpu_disk_close(unsigned node, void *obj, size_t size);
187 
194 void *starpu_disk_open(unsigned node, void *pos, size_t size);
195 
206 int starpu_disk_register(struct starpu_disk_ops *func, void *parameter, starpu_ssize_t size);
207 
212 #define STARPU_DISK_SIZE_MIN (16*1024*1024)
213 
218 extern int starpu_disk_swap_node;
219 
222 #endif /* __STARPU_DISK_H__ */
int starpu_disk_swap_node
int(* full_write)(void *base, void *obj, void *ptr, size_t size)
Definition: starpu_disk.h:89
void * starpu_disk_open(unsigned node, void *pos, size_t size)
int(* full_read)(void *base, void *obj, void **ptr, size_t *size, unsigned dst_node)
Definition: starpu_disk.h:84
struct starpu_disk_ops starpu_disk_stdio_ops
int(* read)(void *base, void *obj, void *buf, off_t offset, size_t size)
Definition: starpu_disk.h:75
struct starpu_disk_ops starpu_disk_unistd_o_direct_ops
void starpu_disk_close(unsigned node, void *obj, size_t size)
int starpu_disk_register(struct starpu_disk_ops *func, void *parameter, starpu_ssize_t size)
void(* free)(void *base, void *obj, size_t size)
Definition: starpu_disk.h:60
void(* close)(void *base, void *obj, size_t size)
Definition: starpu_disk.h:69
Definition: starpu_disk.h:34
struct starpu_disk_ops starpu_disk_hdf5_ops
int(* test_request)(void *async_channel)
Definition: starpu_disk.h:131
struct starpu_disk_ops starpu_disk_unistd_ops
int(* write)(void *base, void *obj, const void *buf, off_t offset, size_t size)
Definition: starpu_disk.h:79
void(* wait_request)(void *async_channel)
Definition: starpu_disk.h:126
struct starpu_disk_ops starpu_disk_leveldb_ops
void(* free_request)(void *async_channel)
Definition: starpu_disk.h:136
int(* bandwidth)(unsigned node, void *base)
Definition: starpu_disk.h:50
void(* unplug)(void *base)
Definition: starpu_disk.h:44