Remove MSG. Its EOL was scheduled for 2020

[simgrid.git] / include / simgrid / plugins / file_system.h

diff --git a/include/simgrid/plugins/file_system.h b/include/simgrid/plugins/file_system.h
index dbb6d54..af744b0 100644 (file)
--- a/include/simgrid/plugins/file_system.h
+++ b/include/simgrid/plugins/file_system.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2017-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2017-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -27,7 +27,7 @@ XBT_PUBLIC void sg_storage_file_system_init();
 XBT_PUBLIC sg_file_t sg_file_open(const char* fullpath, void* data);
 XBT_PUBLIC sg_size_t sg_file_read(sg_file_t fd, sg_size_t size);
 XBT_PUBLIC sg_size_t sg_file_write(sg_file_t fd, sg_size_t size);
-XBT_PUBLIC void sg_file_close(const_sg_file_t fd);
+XBT_PUBLIC void sg_file_close(sg_file_t fd);
 
 XBT_PUBLIC const char* sg_file_get_name(const_sg_file_t fd);
 XBT_PUBLIC sg_size_t sg_file_get_size(const_sg_file_t fd);
@@ -46,30 +46,6 @@ XBT_PUBLIC sg_size_t sg_disk_get_size_used(const_sg_disk_t d);
 XBT_PUBLIC sg_size_t sg_disk_get_size(const_sg_disk_t d);
 XBT_PUBLIC const char* sg_disk_get_mount_point(const_sg_disk_t d);
 
-#if SIMGRID_HAVE_MSG
-
-typedef sg_file_t msg_file_t; // MSG backwards compatibility
-
-#define MSG_file_open(fullpath, data) sg_file_open((fullpath), (data))
-#define MSG_file_read(fd, size) sg_file_read((fd), (size))
-#define MSG_file_write(fd, size) sg_file_write((fd), (size))
-#define MSG_file_close(fd) sg_file_close(fd)
-#define MSG_file_get_name(fd) sg_file_get_name(fd)
-#define MSG_file_get_size(fd) sg_file_get_size(fd)
-#define MSG_file_dump(fd) sg_file_dump(fd)
-#define MSG_file_get_data(fd) sg_file_get_data(fd)
-#define MSG_file_set_data(fd, data) sg_file_set_data((fd), (data))
-#define MSG_file_seek(fd, offset, origin) sg_file_seek((fd), (offset), (origin))
-#define MSG_file_tell(fd) sg_file_tell(fd)
-#define MSG_file_move(fd, fullpath) sg_file_get_size((fd), (fullpath))
-#define MSG_file_unlink(fd) sg_file_unlink(fd)
-#define MSG_file_rcopy(file, host, fullpath) sg_file_rcopy((file), (host), (fullpath))
-#define MSG_file_rmove(file, host, fullpath) sg_file_rmove((file), (host), (fullpath))
-
-#define MSG_storage_file_system_init() sg_storage_file_system_init()
-
-#endif // SIMGRID_HAVE_MSG
-
 SG_END_DECL
 
 // C++ interface
@@ -84,7 +60,7 @@ extern template class XBT_PUBLIC xbt::Extendable<s4u::File>;
 namespace s4u {
 
 /** @brief A simulated file
- *  @addtogroup Plugin_filesystem
+ *  @ingroup plugin_filesystem
  *
  * Used to simulate the time it takes to access to a file, but does not really store any information.
  *
@@ -96,18 +72,23 @@ class XBT_PUBLIC File : public xbt::Extendable<File> {
   std::string fullpath_;
   sg_size_t current_position_ = SEEK_SET;
   int desc_id                 = 0;
-  Disk* local_disk_           = nullptr;
+  const Disk* local_disk_     = nullptr;
   std::string mount_point_;
 
-  Disk* find_local_disk_on(const Host* host);
+  const Disk* find_local_disk_on(const Host* host);
 
-public:
+protected:
   File(const std::string& fullpath, void* userdata);
   File(const std::string& fullpath, const_sg_host_t host, void* userdata);
   File(const File&) = delete;
   File& operator=(const File&) = delete;
   ~File();
 
+public:
+  static File* open(const std::string& fullpath, void* userdata);
+  static File* open(const std::string& fullpath, const_sg_host_t host, void* userdata);
+  void close();
+
   /** Retrieves the path to the file */
   const char* get_path() const { return fullpath_.c_str(); }
 
@@ -117,15 +98,11 @@ public:
   /** Simulates a write action. Returns the size of data actually written. */
   sg_size_t write(sg_size_t size, bool write_inside = false);
 
-  /** Allows to store user data on that host */
-  XBT_ATTRIB_DEPRECATED_v329("Please use set_data()") void set_userdata(void* data) { set_data(data); }
-  /** Retrieves the previously stored data */
-  XBT_ATTRIB_DEPRECATED_v329("Please use get_data()") void* get_userdata() { return get_data(); }
-
   sg_size_t size() const;
   void seek(sg_offset_t pos);             /** Sets the file head to the given position. */
   void seek(sg_offset_t pos, int origin); /** Sets the file head to the given position from a given origin. */
   sg_size_t tell() const;                 /** Retrieves the current file position */
+  void update_position(sg_offset_t);      /** set new position in file, grow it if necessary, and increased usage */
 
   /** Rename a file. WARNING: It is forbidden to move the file to another mount point */
   void move(const std::string& fullpath) const;
@@ -152,10 +129,7 @@ public:
   std::map<std::string, sg_size_t, std::less<>>* get_content() const { return content_.get(); }
   const char* get_mount_point() const { return mount_point_.c_str(); }
   const char* get_mount_point(s4u::Host* remote_host) { return remote_mount_points_[remote_host].c_str(); }
-  void add_remote_mount(Host* host, const std::string& mount_point)
-  {
-    remote_mount_points_.insert({host, mount_point});
-  }
+  void add_remote_mount(Host* host, const std::string& mount_point);
   sg_size_t get_size() const { return size_; }
   sg_size_t get_used_size() const { return used_size_; }
   void decr_used_size(sg_size_t size);