1 /* Copyright (c) 2017-2020. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_PLUGINS_FILE_SYSTEM_H_
7 #define SIMGRID_PLUGINS_FILE_SYSTEM_H_
9 #include <simgrid/forward.h>
14 #include <xbt/Extendable.hpp>
23 typedef sg_file_t msg_file_t; // MSG backwards compatibility
26 XBT_PUBLIC void sg_storage_file_system_init();
27 XBT_PUBLIC sg_file_t sg_file_open(const char* fullpath, void* data);
28 XBT_PUBLIC sg_size_t sg_file_read(sg_file_t fd, sg_size_t size);
29 XBT_PUBLIC sg_size_t sg_file_write(sg_file_t fd, sg_size_t size);
30 XBT_PUBLIC void sg_file_close(const_sg_file_t fd);
32 XBT_PUBLIC const char* sg_file_get_name(const_sg_file_t fd);
33 XBT_PUBLIC sg_size_t sg_file_get_size(const_sg_file_t fd);
34 XBT_PUBLIC void sg_file_dump(const_sg_file_t fd);
35 XBT_PUBLIC void* sg_file_get_data(const_sg_file_t fd);
36 XBT_PUBLIC void sg_file_set_data(sg_file_t fd, void* data);
37 XBT_PUBLIC void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin);
38 XBT_PUBLIC sg_size_t sg_file_tell(const_sg_file_t fd);
39 XBT_PUBLIC void sg_file_move(const_sg_file_t fd, const char* fullpath);
40 XBT_PUBLIC void sg_file_unlink(sg_file_t fd);
41 XBT_PUBLIC int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath);
42 XBT_PUBLIC int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath);
44 XBT_PUBLIC sg_size_t sg_disk_get_size_free(const_sg_disk_t d);
45 XBT_PUBLIC sg_size_t sg_disk_get_size_used(const_sg_disk_t d);
46 XBT_PUBLIC sg_size_t sg_disk_get_size(const_sg_disk_t d);
47 XBT_PUBLIC const char* sg_disk_get_mount_point(const_sg_disk_t d);
49 XBT_PUBLIC sg_size_t sg_storage_get_size_free(const_sg_storage_t st);
50 XBT_PUBLIC sg_size_t sg_storage_get_size_used(const_sg_storage_t st);
51 XBT_PUBLIC sg_size_t sg_storage_get_size(const_sg_storage_t st);
52 XBT_PUBLIC xbt_dict_t sg_storage_get_content(const_sg_storage_t storage);
54 XBT_PUBLIC xbt_dict_t sg_host_get_storage_content(sg_host_t host);
56 #define MSG_file_open(fullpath, data) sg_file_open((fullpath), (data))
57 #define MSG_file_read(fd, size) sg_file_read((fd), (size))
58 #define MSG_file_write(fd, size) sg_file_write((fd), (size))
59 #define MSG_file_close(fd) sg_file_close(fd)
60 #define MSG_file_get_name(fd) sg_file_get_name(fd)
61 #define MSG_file_get_size(fd) sg_file_get_size(fd)
62 #define MSG_file_dump(fd) sg_file_dump(fd)
63 #define MSG_file_get_data(fd) sg_file_get_data(fd)
64 #define MSG_file_set_data(fd, data) sg_file_set_data((fd), (data))
65 #define MSG_file_seek(fd, offset, origin) sg_file_seek((fd), (offset), (origin))
66 #define MSG_file_tell(fd) sg_file_tell(fd)
67 #define MSG_file_move(fd, fullpath) sg_file_get_size((fd), (fullpath))
68 #define MSG_file_unlink(fd) sg_file_unlink(fd)
69 #define MSG_file_rcopy(file, host, fullpath) sg_file_rcopy((file), (host), (fullpath))
70 #define MSG_file_rmove(file, host, fullpath) sg_file_rmove((file), (host), (fullpath))
72 #define MSG_storage_file_system_init() sg_storage_file_system_init()
73 #define MSG_storage_get_free_size(st) sg_storage_get_size_free(st)
74 #define MSG_storage_get_used_size(st) sg_storage_get_size_used(st)
75 #define MSG_storage_get_size(st) sg_storage_get_size(st)
76 #define MSG_storage_get_content(st) sg_storage_get_content(st)
78 #define MSG_host_get_storage_content(st) sg_host_get_storage_content(st)
89 extern template class XBT_PUBLIC xbt::Extendable<s4u::File>;
93 /** @brief A simulated file
94 * @addtogroup Plugin_filesystem
96 * Used to simulate the time it takes to access to a file, but does not really store any information.
98 * They are located on @ref simgrid::s4u::Storage that are accessed from a given @ref simgrid::s4u::Host through
100 * For now, you cannot change the mountpoints programmatically, and must declare them from your platform file.
102 class XBT_PUBLIC File : public xbt::Extendable<File> {
105 std::string fullpath_;
106 sg_size_t current_position_ = SEEK_SET;
108 Disk* local_disk_ = nullptr;
109 Storage* local_storage_ = nullptr;
110 std::string mount_point_;
112 Storage* find_local_storage_on(Host* host);
113 Disk* find_local_disk_on(const Host* host);
114 sg_size_t write_on_storage(sg_size_t size, bool write_inside);
115 sg_size_t write_on_disk(sg_size_t size, bool write_inside);
118 File(const std::string& fullpath, void* userdata);
119 File(const std::string& fullpath, sg_host_t host, void* userdata);
120 File(const File&) = delete;
121 File& operator=(const File&) = delete;
124 /** Retrieves the path to the file */
125 const char* get_path() const { return fullpath_.c_str(); }
127 /** Simulates a local read action. Returns the size of data actually read */
128 sg_size_t read(sg_size_t size);
130 /** Simulates a write action. Returns the size of data actually written. */
131 sg_size_t write(sg_size_t size, bool write_inside = false);
133 /** Allows to store user data on that host */
134 XBT_ATTRIB_DEPRECATED_v329("Please use set_data()") void set_userdata(void* data) { set_data(data); }
135 /** Retrieves the previously stored data */
136 XBT_ATTRIB_DEPRECATED_v329("Please use get_data()") void* get_userdata() { return get_data(); }
138 sg_size_t size() const;
139 void seek(sg_offset_t pos); /** Sets the file head to the given position. */
140 void seek(sg_offset_t pos, int origin); /** Sets the file head to the given position from a given origin. */
141 sg_size_t tell() const; /** Retrieves the current file position */
143 /** Rename a file. WARNING: It is forbidden to move the file to another mount point */
144 void move(const std::string& fullpath) const;
145 int remote_copy(sg_host_t host, const std::string& fullpath);
146 int remote_move(sg_host_t host, const std::string& fullpath);
148 int unlink() const; /** Remove a file from the contents of a disk */
152 class XBT_PUBLIC FileSystemDiskExt {
153 std::unique_ptr<std::map<std::string, sg_size_t>> content_;
154 std::map<Host*, std::string> remote_mount_points_;
155 std::string mount_point_;
156 sg_size_t used_size_ = 0;
157 sg_size_t size_ = static_cast<sg_size_t>(500 * 1024) * 1024 * 1024;
160 static simgrid::xbt::Extension<Disk, FileSystemDiskExt> EXTENSION_ID;
161 explicit FileSystemDiskExt(const Disk* ptr);
162 FileSystemDiskExt(const FileSystemDiskExt&) = delete;
163 FileSystemDiskExt& operator=(const FileSystemDiskExt&) = delete;
164 std::map<std::string, sg_size_t>* parse_content(const std::string& filename);
165 std::map<std::string, sg_size_t>* get_content() const { return content_.get(); }
166 const char* get_mount_point() const { return mount_point_.c_str(); }
167 const char* get_mount_point(s4u::Host* remote_host) { return remote_mount_points_[remote_host].c_str(); }
168 void add_remote_mount(Host* host, const std::string& mount_point)
170 remote_mount_points_.insert({host, mount_point});
172 sg_size_t get_size() const { return size_; }
173 sg_size_t get_used_size() const { return used_size_; }
174 void decr_used_size(sg_size_t size);
175 void incr_used_size(sg_size_t size);
178 class XBT_PUBLIC FileSystemStorageExt {
179 std::unique_ptr<std::map<std::string, sg_size_t>> content_;
180 sg_size_t used_size_ = 0;
184 static simgrid::xbt::Extension<Storage, FileSystemStorageExt> EXTENSION_ID;
185 explicit FileSystemStorageExt(const Storage* ptr);
186 FileSystemStorageExt(const FileSystemStorageExt&) = delete;
187 FileSystemStorageExt& operator=(const FileSystemStorageExt&) = delete;
188 std::map<std::string, sg_size_t>* parse_content(const std::string& filename);
189 std::map<std::string, sg_size_t>* get_content() { return content_.get(); }
190 sg_size_t get_size() const { return size_; }
191 sg_size_t get_used_size() const { return used_size_; }
192 void decr_used_size(sg_size_t size);
193 void incr_used_size(sg_size_t size);
196 class XBT_PUBLIC FileDescriptorHostExt {
198 static simgrid::xbt::Extension<Host, FileDescriptorHostExt> EXTENSION_ID;
199 FileDescriptorHostExt() = default;
200 FileDescriptorHostExt(const FileDescriptorHostExt&) = delete;
201 FileDescriptorHostExt& operator=(const FileDescriptorHostExt&) = delete;
202 std::unique_ptr<std::vector<int>> file_descriptor_table = nullptr; // Created lazily on need
205 } // namespace simgrid