StarPU Handbook
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
starpu_disk.h
Go to the documentation of this file.
1 
2 /* StarPU --- Runtime system for heterogeneous multicore architectures.
3  *
4  * Copyright (C) 2013 Corentin Salingue
5  *
6  * StarPU is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or (at
9  * your option) any later version.
10  *
11  * StarPU is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14  *
15  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
16  */
17 
18 #ifndef __STARPU_DISK_H__
19 #define __STARPU_DISK_H__
20 
21 #include <sys/types.h>
22 #include <starpu_config.h>
23 
24 /* list of functions to use on disk */
26 {
27  void * (*plug) (void *parameter, starpu_ssize_t size);
28  void (*unplug) (void *base);
29 
30  int (*bandwidth) (unsigned node);
31 
32  void * (*alloc) (void *base, size_t size);
33  void (*free) (void *base, void *obj, size_t size);
34 
35  void * (*open) (void *base, void *pos, size_t size); /* open an existing file */
36  void (*close) (void *base, void *obj, size_t size);
37 
38  int (*read) (void *base, void *obj, void *buf, off_t offset, size_t size);
39  int (*write) (void *base, void *obj, const void *buf, off_t offset, size_t size);
40 
41  int (*full_read) (void * base, void * obj, void ** ptr, size_t * size);
42  int (*full_write) (void * base, void * obj, void * ptr, size_t size);
43 
44  void * (*async_write) (void *base, void *obj, void *buf, off_t offset, size_t size);
45  void * (*async_read) (void *base, void *obj, void *buf, off_t offset, size_t size);
46 
47  void * (*async_full_read) (void * base, void * obj, void ** ptr, size_t * size);
48  void * (*async_full_write) (void * base, void * obj, void * ptr, size_t size);
49 
50  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);
51  void (*wait_request) (void * async_channel);
52  int (*test_request) (void * async_channel);
53  void (*free_request)(void * async_channel);
54 
55  /* TODO: readv, writev, read2d, write2d, etc. */
56 };
57 
58 /* Posix functions to use disk memory */
63 
64 void starpu_disk_close(unsigned node, void *obj, size_t size);
65 
66 void *starpu_disk_open(unsigned node, void *pos, size_t size);
67 
68 int starpu_disk_register(struct starpu_disk_ops *func, void *parameter, starpu_ssize_t size);
69 
70 #endif /* __STARPU_DISK_H__ */
void(* free)(void *base, void *obj, size_t size)
Definition: starpu_disk.h:33
int(* read)(void *base, void *obj, void *buf, off_t offset, size_t size)
Definition: starpu_disk.h:38
void(* close)(void *base, void *obj, size_t size)
Definition: starpu_disk.h:36
void starpu_disk_close(unsigned node, void *obj, size_t size)
int(* bandwidth)(unsigned node)
Definition: starpu_disk.h:30
Definition: starpu_disk.h:25
int(* write)(void *base, void *obj, const void *buf, off_t offset, size_t size)
Definition: starpu_disk.h:39
struct starpu_disk_ops starpu_disk_leveldb_ops
void(* unplug)(void *base)
Definition: starpu_disk.h:28
struct starpu_disk_ops starpu_disk_unistd_o_direct_ops
void(* free_request)(void *async_channel)
Definition: starpu_disk.h:53
int(* full_write)(void *base, void *obj, void *ptr, size_t size)
Definition: starpu_disk.h:42
int(* test_request)(void *async_channel)
Definition: starpu_disk.h:52
struct starpu_disk_ops starpu_disk_unistd_ops
int(* full_read)(void *base, void *obj, void **ptr, size_t *size)
Definition: starpu_disk.h:41
void(* wait_request)(void *async_channel)
Definition: starpu_disk.h:51
struct starpu_disk_ops starpu_disk_stdio_ops
void * starpu_disk_open(unsigned node, void *pos, size_t size)