Merge branch 'wifi_rate_zero' into 'master'

[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 e90f849..78a0924 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-2022. 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);
@@ -67,12 +67,6 @@ typedef sg_file_t msg_file_t; // MSG backwards compatibility
 #define MSG_file_rmove(file, host, fullpath) sg_file_rmove((file), (host), (fullpath))
 
 #define MSG_storage_file_system_init() sg_storage_file_system_init()
-#define MSG_storage_get_free_size(st) sg_storage_get_size_free(st)
-#define MSG_storage_get_used_size(st) sg_storage_get_size_used(st)
-#define MSG_storage_get_size(st) sg_storage_get_size(st)
-#define MSG_storage_get_content(st) sg_storage_get_content(st)
-
-#define MSG_host_get_storage_content(st) sg_host_get_storage_content(st)
 
 #endif // SIMGRID_HAVE_MSG
 
@@ -90,13 +84,11 @@ 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.
  *
- * They are located on @ref simgrid::s4u::Storage that are accessed from a given @ref simgrid::s4u::Host through
- * mountpoints.
- * For now, you cannot change the mountpoints programmatically, and must declare them from your platform file.
+ * They are located on @ref simgrid::s4u::Disk that are accessed from a given @ref simgrid::s4u::Host
  */
 class XBT_PUBLIC File : public xbt::Extendable<File> {
   sg_size_t size_ = 0;
@@ -104,18 +96,21 @@ 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:
   File(const std::string& fullpath, void* userdata);
-  File(const std::string& fullpath, sg_host_t host, void* userdata);
+  File(const std::string& fullpath, const_sg_host_t host, void* userdata);
   File(const File&) = delete;
   File& operator=(const File&) = delete;
   ~File();
 
+  static File* open(const std::string& fullpath, void* userdata);
+  void close() { delete this; };
+
   /** Retrieves the path to the file */
   const char* get_path() const { return fullpath_.c_str(); }
 
@@ -125,11 +120,6 @@ 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. */