Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
snake_casing file system plugin
[simgrid.git] / include / simgrid / plugins / file_system.h
1 /* Copyright (c) 2017-2018. 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_PLUGINS_FILE_SYSTEM_H_
7 #define SIMGRID_PLUGINS_FILE_SYSTEM_H_
8
9 #include <simgrid/forward.h>
10 #include <xbt/base.h>
11 #include <xbt/dict.h>
12
13 // C interface
14 ////////////////
15 typedef sg_file_t msg_file_t; // MSG backwards compatibility
16
17 SG_BEGIN_DECL()
18 XBT_PUBLIC void sg_storage_file_system_init();
19 XBT_PUBLIC sg_file_t sg_file_open(const char* fullpath, void* data);
20 XBT_PUBLIC sg_size_t sg_file_read(sg_file_t fd, sg_size_t size);
21 XBT_PUBLIC sg_size_t sg_file_write(sg_file_t fd, sg_size_t size);
22 XBT_PUBLIC void sg_file_close(sg_file_t fd);
23
24 XBT_PUBLIC const char* sg_file_get_name(sg_file_t fd);
25 XBT_PUBLIC sg_size_t sg_file_get_size(sg_file_t fd);
26 XBT_PUBLIC void sg_file_dump(sg_file_t fd);
27 XBT_PUBLIC void* sg_file_get_data(sg_file_t fd);
28 XBT_PUBLIC void sg_file_set_data(sg_file_t fd, void* data);
29 XBT_PUBLIC void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin);
30 XBT_PUBLIC sg_size_t sg_file_tell(sg_file_t fd);
31 XBT_PUBLIC void sg_file_move(sg_file_t fd, const char* fullpath);
32 XBT_PUBLIC void sg_file_unlink(sg_file_t fd);
33 XBT_PUBLIC int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath);
34 XBT_PUBLIC int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath);
35
36 XBT_PUBLIC sg_size_t sg_storage_get_size_free(sg_storage_t st);
37 XBT_PUBLIC sg_size_t sg_storage_get_size_used(sg_storage_t st);
38 XBT_PUBLIC sg_size_t sg_storage_get_size(sg_storage_t st);
39 XBT_PUBLIC xbt_dict_t sg_storage_get_content(sg_storage_t storage);
40
41 XBT_PUBLIC xbt_dict_t sg_host_get_storage_content(sg_host_t host);
42
43 #define MSG_file_open(fullpath, data) sg_file_open(fullpath, data)
44 #define MSG_file_read(fd, size) sg_file_read(fd, size)
45 #define MSG_file_write(fd, size) sg_file_write(fd, size)
46 #define MSG_file_close(fd) sg_file_close(fd)
47 #define MSG_file_get_name(fd) sg_file_get_name(fd)
48 #define MSG_file_get_size(fd) sg_file_get_size(fd)
49 #define MSG_file_dump(fd) sg_file_dump(fd)
50 #define MSG_file_get_data(fd) sg_file_get_data(fd)
51 #define MSG_file_set_data(fd, data) sg_file_set_data(fd, data)
52 #define MSG_file_seek(fd, offset, origin) sg_file_seek(fd, offset, origin)
53 #define MSG_file_tell(fd) sg_file_tell(fd)
54 #define MSG_file_move(fd, fullpath) sg_file_get_size(fd, fullpath)
55 #define MSG_file_unlink(fd) sg_file_unlink(fd)
56 #define MSG_file_rcopy(file, host, fullpath) sg_file_rcopy(file, host, fullpath)
57 #define MSG_file_rmove(file, host, fullpath) sg_file_rmove(file, host, fullpath)
58
59 #define MSG_storage_file_system_init() sg_storage_file_system_init()
60 #define MSG_storage_get_free_size(st) sg_storage_get_size_free(st)
61 #define MSG_storage_get_used_size(st) sg_storage_get_size_used(st)
62 #define MSG_storage_get_size(st) sg_storage_get_size(st)
63 #define MSG_storage_get_content(st) sg_storage_get_content(st)
64
65 #define MSG_host_get_storage_content(st) sg_host_get_storage_content(st)
66
67 SG_END_DECL()
68
69 // C++ interface
70 //////////////////
71
72 #ifdef __cplusplus
73 #include <xbt/Extendable.hpp>
74
75 #include <map>
76 #include <string>
77
78 namespace simgrid {
79 namespace s4u {
80
81 /** @brief A simulated file
82  *
83  * Used to simulate the time it takes to access to a file, but does not really store any information.
84  *
85  * They are located on @ref simgrid::s4u::Storage that are accessed from a given @ref simgrid::s4u::Host through
86  * mountpoints.
87  * For now, you cannot change the mountpoints programatically, and must declare them from your platform file.
88  */
89 class XBT_PUBLIC File {
90 public:
91   File(std::string fullpath, void* userdata);
92   File(std::string fullpath, sg_host_t host, void* userdata);
93   ~File();
94
95   /** Retrieves the path to the file */
96   const char* get_path() { return fullpath_.c_str(); }
97
98   /** Simulates a local read action. Returns the size of data actually read */
99   sg_size_t read(sg_size_t size);
100
101   /** Simulates a write action. Returns the size of data actually written. */
102   sg_size_t write(sg_size_t size);
103
104   /** Allows to store user data on that host */
105   void set_userdata(void* data) { userdata_ = data; }
106   /** Retrieves the previously stored data */
107   void* get_userdata() { return userdata_; }
108
109   sg_size_t size();
110   void seek(sg_offset_t pos);             /** Sets the file head to the given position. */
111   void seek(sg_offset_t pos, int origin); /** Sets the file head to the given position from a given origin. */
112   sg_size_t tell();                       /** Retrieves the current file position */
113
114   /** Rename a file. WARNING: It is forbidden to move the file to another mount point */
115   void move(std::string fullpath);
116   int remote_copy(sg_host_t host, const char* fullpath);
117   int remote_move(sg_host_t host, const char* fullpath);
118
119   int unlink(); /** Remove a file from the contents of a disk */
120   void dump();
121
122   int desc_id = 0;
123   Storage* local_storage_;
124   std::string mount_point_;
125
126 private:
127   sg_size_t size_;
128   std::string path_;
129   std::string fullpath_;
130   sg_size_t current_position_ = SEEK_SET;
131   void* userdata_             = nullptr;
132 };
133
134 class XBT_PUBLIC FileSystemStorageExt {
135 public:
136   static simgrid::xbt::Extension<Storage, FileSystemStorageExt> EXTENSION_ID;
137   explicit FileSystemStorageExt(Storage* ptr);
138   ~FileSystemStorageExt();
139   std::map<std::string, sg_size_t>* parse_content(std::string filename);
140   std::map<std::string, sg_size_t>* get_content() { return content_; }
141   sg_size_t get_size() { return size_; }
142   sg_size_t get_used_size() { return used_size_; }
143   void decr_used_size(sg_size_t size) { used_size_ -= size; }
144   void incr_used_size(sg_size_t size) { used_size_ += size; }
145
146 private:
147   std::map<std::string, sg_size_t>* content_;
148   sg_size_t used_size_ = 0;
149   sg_size_t size_     = 0;
150 };
151
152 class XBT_PUBLIC FileDescriptorHostExt {
153 public:
154   static simgrid::xbt::Extension<Host, FileDescriptorHostExt> EXTENSION_ID;
155   FileDescriptorHostExt() = default;
156   ~FileDescriptorHostExt() { delete file_descriptor_table; }
157   std::vector<int>* file_descriptor_table = nullptr; // Created lazily on need
158 };
159 } // namespace s4u
160 } // namespace simgrid
161 #endif
162 #endif