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