1 /* Copyright (c) 2017-2023. 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/config.h>
10 #include <simgrid/forward.h>
15 #include <xbt/Extendable.hpp>
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(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);
58 extern template class XBT_PUBLIC xbt::Extendable<s4u::File>;
62 /** @brief A simulated file
63 * @ingroup plugin_filesystem
65 * Used to simulate the time it takes to access to a file, but does not really store any information.
67 * They are located on @ref simgrid::s4u::Disk that are accessed from a given @ref simgrid::s4u::Host
69 class XBT_PUBLIC File : public xbt::Extendable<File> {
72 std::string fullpath_;
73 sg_size_t current_position_ = SEEK_SET;
75 const Disk* local_disk_ = nullptr;
76 std::string mount_point_;
78 const Disk* find_local_disk_on(const Host* host);
81 File(const std::string& fullpath, void* userdata);
82 File(const std::string& fullpath, const_sg_host_t host, void* userdata);
83 File(const File&) = delete;
84 File& operator=(const File&) = delete;
88 static File* open(const std::string& fullpath, void* userdata);
89 static File* open(const std::string& fullpath, const_sg_host_t host, void* userdata);
92 /** Retrieves the path to the file */
93 const char* get_path() const { return fullpath_.c_str(); }
95 /** Simulates a local read action. Returns the size of data actually read */
96 sg_size_t read(sg_size_t size);
98 /** Simulates a write action. Returns the size of data actually written. */
99 sg_size_t write(sg_size_t size, bool write_inside = false);
101 sg_size_t size() const;
102 void seek(sg_offset_t pos); /** Sets the file head to the given position. */
103 void seek(sg_offset_t pos, int origin); /** Sets the file head to the given position from a given origin. */
104 sg_size_t tell() const; /** Retrieves the current file position */
105 void update_position(sg_offset_t); /** set new position in file, grow it if necessary, and increased usage */
107 /** Rename a file. WARNING: It is forbidden to move the file to another mount point */
108 void move(const std::string& fullpath) const;
109 int remote_copy(sg_host_t host, const std::string& fullpath);
110 int remote_move(sg_host_t host, const std::string& fullpath);
112 int unlink() const; /** Remove a file from the contents of a disk */
116 class XBT_PUBLIC FileSystemDiskExt {
117 std::unique_ptr<std::map<std::string, sg_size_t, std::less<>>> content_;
118 std::map<Host*, std::string> remote_mount_points_;
119 std::string mount_point_;
120 sg_size_t used_size_ = 0;
121 sg_size_t size_ = static_cast<sg_size_t>(500 * 1024) * 1024 * 1024;
124 static simgrid::xbt::Extension<Disk, FileSystemDiskExt> EXTENSION_ID;
125 explicit FileSystemDiskExt(const Disk* ptr);
126 FileSystemDiskExt(const FileSystemDiskExt&) = delete;
127 FileSystemDiskExt& operator=(const FileSystemDiskExt&) = delete;
128 std::map<std::string, sg_size_t, std::less<>>* parse_content(const std::string& filename);
129 std::map<std::string, sg_size_t, std::less<>>* get_content() const { return content_.get(); }
130 const char* get_mount_point() const { return mount_point_.c_str(); }
131 const char* get_mount_point(s4u::Host* remote_host) { return remote_mount_points_[remote_host].c_str(); }
132 void add_remote_mount(Host* host, const std::string& mount_point);
133 sg_size_t get_size() const { return size_; }
134 sg_size_t get_used_size() const { return used_size_; }
135 void decr_used_size(sg_size_t size);
136 void incr_used_size(sg_size_t size);
139 class XBT_PUBLIC FileDescriptorHostExt {
141 static simgrid::xbt::Extension<Host, FileDescriptorHostExt> EXTENSION_ID;
142 FileDescriptorHostExt() = default;
143 FileDescriptorHostExt(const FileDescriptorHostExt&) = delete;
144 FileDescriptorHostExt& operator=(const FileDescriptorHostExt&) = delete;
145 std::unique_ptr<std::vector<int>> file_descriptor_table = nullptr; // Created lazily on need
148 } // namespace simgrid