include/simgrid/plugins/file_system.h

   1 /* Copyright (c) 2017-2021. 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/config.h>
  10 #include <simgrid/forward.h>
  11 #include <xbt/base.h>
  12 #include <xbt/dict.h>
  13
  14 #ifdef __cplusplus
  15 #include <xbt/Extendable.hpp>
  16
  17 #include <map>
  18 #include <memory>
  19 #include <string>
  20 #endif /* C++ */
  21
  22 // C interface
  23 ////////////////
  24
  25 SG_BEGIN_DECL
  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);
  31
  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);
  43
  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);
  48
  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);
  53
  54 XBT_PUBLIC xbt_dict_t sg_host_get_storage_content(sg_host_t host);
  55
  56 #if SIMGRID_HAVE_MSG
  57
  58 typedef sg_file_t msg_file_t; // MSG backwards compatibility
  59
  60 #define MSG_file_open(fullpath, data) sg_file_open((fullpath), (data))
  61 #define MSG_file_read(fd, size) sg_file_read((fd), (size))
  62 #define MSG_file_write(fd, size) sg_file_write((fd), (size))
  63 #define MSG_file_close(fd) sg_file_close(fd)
  64 #define MSG_file_get_name(fd) sg_file_get_name(fd)
  65 #define MSG_file_get_size(fd) sg_file_get_size(fd)
  66 #define MSG_file_dump(fd) sg_file_dump(fd)
  67 #define MSG_file_get_data(fd) sg_file_get_data(fd)
  68 #define MSG_file_set_data(fd, data) sg_file_set_data((fd), (data))
  69 #define MSG_file_seek(fd, offset, origin) sg_file_seek((fd), (offset), (origin))
  70 #define MSG_file_tell(fd) sg_file_tell(fd)
  71 #define MSG_file_move(fd, fullpath) sg_file_get_size((fd), (fullpath))
  72 #define MSG_file_unlink(fd) sg_file_unlink(fd)
  73 #define MSG_file_rcopy(file, host, fullpath) sg_file_rcopy((file), (host), (fullpath))
  74 #define MSG_file_rmove(file, host, fullpath) sg_file_rmove((file), (host), (fullpath))
  75
  76 #define MSG_storage_file_system_init() sg_storage_file_system_init()
  77 #define MSG_storage_get_free_size(st) sg_storage_get_size_free(st)
  78 #define MSG_storage_get_used_size(st) sg_storage_get_size_used(st)
  79 #define MSG_storage_get_size(st) sg_storage_get_size(st)
  80 #define MSG_storage_get_content(st) sg_storage_get_content(st)
  81
  82 #define MSG_host_get_storage_content(st) sg_host_get_storage_content(st)
  83
  84 #endif // SIMGRID_HAVE_MSG
  85
  86 SG_END_DECL
  87
  88 // C++ interface
  89 //////////////////
  90
  91 #ifdef __cplusplus
  92
  93 namespace simgrid {
  94
  95 extern template class XBT_PUBLIC xbt::Extendable<s4u::File>;
  96
  97 namespace s4u {
  98
  99 /** @brief A simulated file
 100  *  @addtogroup Plugin_filesystem
 101  *
 102  * Used to simulate the time it takes to access to a file, but does not really store any information.
 103  *
 104  * They are located on @ref simgrid::s4u::Storage that are accessed from a given @ref simgrid::s4u::Host through
 105  * mountpoints.
 106  * For now, you cannot change the mountpoints programmatically, and must declare them from your platform file.
 107  */
 108 class XBT_PUBLIC File : public xbt::Extendable<File> {
 109   sg_size_t size_ = 0;
 110   std::string path_;
 111   std::string fullpath_;
 112   sg_size_t current_position_ = SEEK_SET;
 113   int desc_id                 = 0;
 114   Disk* local_disk_           = nullptr;
 115   Storage* local_storage_     = nullptr;
 116   std::string mount_point_;
 117
 118   Storage* find_local_storage_on(Host* host);
 119   Disk* find_local_disk_on(const Host* host);
 120   sg_size_t write_on_storage(sg_size_t size, bool write_inside);
 121   sg_size_t write_on_disk(sg_size_t size, bool write_inside);
 122
 123 public:
 124   File(const std::string& fullpath, void* userdata);
 125   File(const std::string& fullpath, sg_host_t host, void* userdata);
 126   File(const File&) = delete;
 127   File& operator=(const File&) = delete;
 128   ~File();
 129
 130   /** Retrieves the path to the file */
 131   const char* get_path() const { return fullpath_.c_str(); }
 132
 133   /** Simulates a local read action. Returns the size of data actually read */
 134   sg_size_t read(sg_size_t size);
 135
 136   /** Simulates a write action. Returns the size of data actually written. */
 137   sg_size_t write(sg_size_t size, bool write_inside = false);
 138
 139   /** Allows to store user data on that host */
 140   XBT_ATTRIB_DEPRECATED_v329("Please use set_data()") void set_userdata(void* data) { set_data(data); }
 141   /** Retrieves the previously stored data */
 142   XBT_ATTRIB_DEPRECATED_v329("Please use get_data()") void* get_userdata() { return get_data(); }
 143
 144   sg_size_t size() const;
 145   void seek(sg_offset_t pos);             /** Sets the file head to the given position. */
 146   void seek(sg_offset_t pos, int origin); /** Sets the file head to the given position from a given origin. */
 147   sg_size_t tell() const;                 /** Retrieves the current file position */
 148
 149   /** Rename a file. WARNING: It is forbidden to move the file to another mount point */
 150   void move(const std::string& fullpath) const;
 151   int remote_copy(sg_host_t host, const std::string& fullpath);
 152   int remote_move(sg_host_t host, const std::string& fullpath);
 153
 154   int unlink() const; /** Remove a file from the contents of a disk */
 155   void dump() const;
 156 };
 157
 158 class XBT_PUBLIC FileSystemDiskExt {
 159   std::unique_ptr<std::map<std::string, sg_size_t, std::less<>>> content_;
 160   std::map<Host*, std::string> remote_mount_points_;
 161   std::string mount_point_;
 162   sg_size_t used_size_ = 0;
 163   sg_size_t size_      = static_cast<sg_size_t>(500 * 1024) * 1024 * 1024;
 164
 165 public:
 166   static simgrid::xbt::Extension<Disk, FileSystemDiskExt> EXTENSION_ID;
 167   explicit FileSystemDiskExt(const Disk* ptr);
 168   FileSystemDiskExt(const FileSystemDiskExt&) = delete;
 169   FileSystemDiskExt& operator=(const FileSystemDiskExt&) = delete;
 170   std::map<std::string, sg_size_t, std::less<>>* parse_content(const std::string& filename);
 171   std::map<std::string, sg_size_t, std::less<>>* get_content() const { return content_.get(); }
 172   const char* get_mount_point() const { return mount_point_.c_str(); }
 173   const char* get_mount_point(s4u::Host* remote_host) { return remote_mount_points_[remote_host].c_str(); }
 174   void add_remote_mount(Host* host, const std::string& mount_point)
 175   {
 176     remote_mount_points_.insert({host, mount_point});
 177   }
 178   sg_size_t get_size() const { return size_; }
 179   sg_size_t get_used_size() const { return used_size_; }
 180   void decr_used_size(sg_size_t size);
 181   void incr_used_size(sg_size_t size);
 182 };
 183
 184 class XBT_PUBLIC FileSystemStorageExt {
 185   std::unique_ptr<std::map<std::string, sg_size_t, std::less<>>> content_;
 186   sg_size_t used_size_ = 0;
 187   sg_size_t size_      = 0;
 188
 189 public:
 190   static simgrid::xbt::Extension<Storage, FileSystemStorageExt> EXTENSION_ID;
 191   explicit FileSystemStorageExt(const Storage* ptr);
 192   FileSystemStorageExt(const FileSystemStorageExt&) = delete;
 193   FileSystemStorageExt& operator=(const FileSystemStorageExt&) = delete;
 194   std::map<std::string, sg_size_t, std::less<>>* parse_content(const std::string& filename);
 195   std::map<std::string, sg_size_t, std::less<>>* get_content() { return content_.get(); }
 196   sg_size_t get_size() const { return size_; }
 197   sg_size_t get_used_size() const { return used_size_; }
 198   void decr_used_size(sg_size_t size);
 199   void incr_used_size(sg_size_t size);
 200 };
 201
 202 class XBT_PUBLIC FileDescriptorHostExt {
 203 public:
 204   static simgrid::xbt::Extension<Host, FileDescriptorHostExt> EXTENSION_ID;
 205   FileDescriptorHostExt() = default;
 206   FileDescriptorHostExt(const FileDescriptorHostExt&) = delete;
 207   FileDescriptorHostExt& operator=(const FileDescriptorHostExt&) = delete;
 208   std::unique_ptr<std::vector<int>> file_descriptor_table        = nullptr; // Created lazily on need
 209 };
 210 } // namespace s4u
 211 } // namespace simgrid
 212 #endif
 213 #endif