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-2015,2017 CNRS
4  * Copyright (C) 2013 Inria
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 
26 /* list of functions to use on disk */
28 {
29  void * (*plug) (void *parameter, starpu_ssize_t size);
30  void (*unplug) (void *base);
31 
32  int (*bandwidth) (unsigned node, void *base);
33 
34  void * (*alloc) (void *base, size_t size);
35  void (*free) (void *base, void *obj, size_t size);
36 
37  void * (*open) (void *base, void *pos, size_t size); /* open an existing file */
38  void (*close) (void *base, void *obj, size_t size);
39 
40  int (*read) (void *base, void *obj, void *buf, off_t offset, size_t size);
41  int (*write) (void *base, void *obj, const void *buf, off_t offset, size_t size);
42 
43  int (*full_read) (void * base, void * obj, void ** ptr, size_t * size);
44  int (*full_write) (void * base, void * obj, void * ptr, size_t size);
45 
46  void * (*async_write) (void *base, void *obj, void *buf, off_t offset, size_t size);
47  void * (*async_read) (void *base, void *obj, void *buf, off_t offset, size_t size);
48 
49  void * (*async_full_read) (void * base, void * obj, void ** ptr, size_t * size);
50  void * (*async_full_write) (void * base, void * obj, void * ptr, size_t size);
51 
52  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);
53  void (*wait_request) (void * async_channel);
54  int (*test_request) (void * async_channel);
55  void (*free_request)(void * async_channel);
56 
57  /* TODO: readv, writev, read2d, write2d, etc. */
58 };
59 
60 /* Posix functions to use disk memory */
65 
66 void starpu_disk_close(unsigned node, void *obj, size_t size);
67 
68 void *starpu_disk_open(unsigned node, void *pos, size_t size);
69 
70 int starpu_disk_register(struct starpu_disk_ops *func, void *parameter, starpu_ssize_t size);
71 
72 #define STARPU_DISK_SIZE_MIN (16*1024*1024)
73 
74 extern int starpu_disk_swap_node;
75 
76 #endif /* __STARPU_DISK_H__ */
void(* free)(void *base, void *obj, size_t size)
Definition: starpu_disk.h:35
int starpu_disk_swap_node
int(* read)(void *base, void *obj, void *buf, off_t offset, size_t size)
Definition: starpu_disk.h:40
void(* close)(void *base, void *obj, size_t size)
Definition: starpu_disk.h:38
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)
Definition: starpu_disk.h:27
int(* bandwidth)(unsigned node, void *base)
Definition: starpu_disk.h:32
int(* write)(void *base, void *obj, const void *buf, off_t offset, size_t size)
Definition: starpu_disk.h:41
struct starpu_disk_ops starpu_disk_leveldb_ops
void(* unplug)(void *base)
Definition: starpu_disk.h:30
struct starpu_disk_ops starpu_disk_unistd_o_direct_ops
void(* free_request)(void *async_channel)
Definition: starpu_disk.h:55
int(* full_write)(void *base, void *obj, void *ptr, size_t size)
Definition: starpu_disk.h:44
int(* test_request)(void *async_channel)
Definition: starpu_disk.h:54
struct starpu_disk_ops starpu_disk_unistd_ops
int(* full_read)(void *base, void *obj, void **ptr, size_t *size)
Definition: starpu_disk.h:43
void(* wait_request)(void *async_channel)
Definition: starpu_disk.h:53
struct starpu_disk_ops starpu_disk_stdio_ops
void * starpu_disk_open(unsigned node, void *pos, size_t size)