Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
6c4ccd0ce70f2e4d43de32cc191056e5515b431c
[simgrid.git] / include / simgrid / s4u / file.hpp
1 /* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef SIMGRID_S4U_FILE_HPP
7 #define SIMGRID_S4U_FILE_HPP
8
9 #include <boost/unordered_map.hpp>
10 #include <vector>
11
12 #include <xbt/base.h>
13 #include <simgrid/simix.h>
14
15 namespace simgrid {
16 namespace s4u {
17
18 class Actor;
19 class Storage;
20
21 /** @brief A simulated file
22  *
23  * Used to simulate the time it takes to access to a file, but does not really store any information.
24  *
25  * They are located on @link{simgrid::s4u::Storage}, that are accessed from a given @link{simgrid::s4u::Host} through mountpoints.
26  * For now, you cannot change the mountpoints programatically, and must declare them from your platform file.
27  */
28 XBT_PUBLIC_CLASS File {
29 public:
30         File(const char *fullpath, void* userdata);
31         ~File();
32 private:
33         smx_file_t p_inferior;
34         const char *p_path;
35
36 public:
37         /** Retrieves the path to the file */
38         const char *path() { return p_path;}
39 public:
40         /** Simulates a read action. Returns the size of data actually read
41          *
42          *  FIXME: reading from a remotely mounted disk is not implemented yet. Any storage is considered as local, and no network communication ever occur.
43          */
44         sg_size_t read(sg_size_t size);
45         /** Simulates a write action. Returns the size of data actually written.
46          *
47          *  FIXME: reading from a remotely mounted disk is not implemented yet. Any storage is considered as local, and no network communication ever occur.
48          */
49         sg_size_t write(sg_size_t size);
50
51         /** Allows to store user data on that host */
52         void set_userdata(void *data) {p_userdata = data;}
53         /** Retrieves the previously stored data */
54         void* userdata() {return p_userdata;}
55 private:
56         void *p_userdata=NULL;
57
58 public:
59         /** Retrieve the datasize */
60         sg_size_t size();
61
62         /** Sets the file head to the given position. */
63         void seek(sg_size_t pos);
64         /** Retrieves the current file position */
65         sg_size_t tell();
66
67         /** Rename a file
68          *
69          * WARNING: It is forbidden to move the file to another mount point */
70         void move(const char*fullpath);
71
72         /** Remove a file from disk */
73         void unlink();
74
75         /* FIXME: add these to the S4U API:
76         XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t file);
77         XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
78         XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
79         */
80
81 };
82
83 }} // namespace simgrid::s4u
84
85 #endif /* SIMGRID_S4U_HOST_HPP */