Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
snake_casing file system plugin
[simgrid.git] / include / simgrid / plugins / file_system.h
index fd1ab19..1a5ea1c 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2017. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2017-2018. 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. */
@@ -9,33 +8,41 @@
 
 #include <simgrid/forward.h>
 #include <xbt/base.h>
+#include <xbt/dict.h>
+
+// C interface
+////////////////
+typedef sg_file_t msg_file_t; // MSG backwards compatibility
 
 SG_BEGIN_DECL()
+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(sg_file_t fd);
+
+XBT_PUBLIC const char* sg_file_get_name(sg_file_t fd);
+XBT_PUBLIC sg_size_t sg_file_get_size(sg_file_t fd);
+XBT_PUBLIC void sg_file_dump(sg_file_t fd);
+XBT_PUBLIC void* sg_file_get_data(sg_file_t fd);
+XBT_PUBLIC void sg_file_set_data(sg_file_t fd, void* data);
+XBT_PUBLIC void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin);
+XBT_PUBLIC sg_size_t sg_file_tell(sg_file_t fd);
+XBT_PUBLIC void sg_file_move(sg_file_t fd, const char* fullpath);
+XBT_PUBLIC void sg_file_unlink(sg_file_t fd);
+XBT_PUBLIC int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath);
+XBT_PUBLIC int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath);
+
+XBT_PUBLIC sg_size_t sg_storage_get_size_free(sg_storage_t st);
+XBT_PUBLIC sg_size_t sg_storage_get_size_used(sg_storage_t st);
+XBT_PUBLIC sg_size_t sg_storage_get_size(sg_storage_t st);
+XBT_PUBLIC xbt_dict_t sg_storage_get_content(sg_storage_t storage);
 
-XBT_PUBLIC(void) sg_storage_file_system_init();
-XBT_PUBLIC(sg_file_t) sg_file_open(const char* fullpath, void* data);
-XBT_PUBLIC(void) sg_file_close(sg_file_t fd);
-
-XBT_PUBLIC(const char*) sg_file_get_name(sg_file_t fd);
-XBT_PUBLIC(sg_size_t) sg_file_get_size(sg_file_t fd);
-XBT_PUBLIC(void) sg_file_dump(sg_file_t fd);
-XBT_PUBLIC(void*) sg_file_get_data(sg_file_t fd);
-XBT_PUBLIC(void) sg_file_set_data(sg_file_t fd, void* data);
-XBT_PUBLIC(void) sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin);
-XBT_PUBLIC(sg_size_t) sg_file_tell(sg_file_t fd);
-XBT_PUBLIC(void) sg_file_move(sg_file_t fd, const char* fullpath);
-XBT_PUBLIC(void) sg_file_unlink(sg_file_t fd);
-
-XBT_PUBLIC(void*) sg_storage_get_data(sg_storage_t storage);
-XBT_PUBLIC(void) sg_storage_set_data(sg_storage_t storage, void* data);
-XBT_PUBLIC(sg_size_t) sg_storage_get_size_free(sg_storage_t st);
-XBT_PUBLIC(sg_size_t) sg_storage_get_size_used(sg_storage_t st);
-XBT_PUBLIC(sg_size_t) sg_storage_get_size(sg_storage_t st);
-XBT_PUBLIC(xbt_dict_t) sg_storage_get_content(sg_storage_t storage);
-
-XBT_PUBLIC(xbt_dict_t) sg_host_get_storage_content(sg_host_t host);
+XBT_PUBLIC xbt_dict_t sg_host_get_storage_content(sg_host_t host);
 
 #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)
@@ -46,6 +53,8 @@ XBT_PUBLIC(xbt_dict_t) sg_host_get_storage_content(sg_host_t host);
 #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()
 #define MSG_storage_get_free_size(st) sg_storage_get_size_free(st)
@@ -57,4 +66,97 @@ XBT_PUBLIC(xbt_dict_t) sg_host_get_storage_content(sg_host_t host);
 
 SG_END_DECL()
 
+// C++ interface
+//////////////////
+
+#ifdef __cplusplus
+#include <xbt/Extendable.hpp>
+
+#include <map>
+#include <string>
+
+namespace simgrid {
+namespace s4u {
+
+/** @brief A simulated file
+ *
+ * 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 programatically, and must declare them from your platform file.
+ */
+class XBT_PUBLIC File {
+public:
+  File(std::string fullpath, void* userdata);
+  File(std::string fullpath, sg_host_t host, void* userdata);
+  ~File();
+
+  /** Retrieves the path to the file */
+  const char* get_path() { return fullpath_.c_str(); }
+
+  /** Simulates a local read action. Returns the size of data actually read */
+  sg_size_t read(sg_size_t size);
+
+  /** Simulates a write action. Returns the size of data actually written. */
+  sg_size_t write(sg_size_t size);
+
+  /** Allows to store user data on that host */
+  void set_userdata(void* data) { userdata_ = data; }
+  /** Retrieves the previously stored data */
+  void* get_userdata() { return userdata_; }
+
+  sg_size_t size();
+  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();                       /** Retrieves the current file position */
+
+  /** Rename a file. WARNING: It is forbidden to move the file to another mount point */
+  void move(std::string fullpath);
+  int remote_copy(sg_host_t host, const char* fullpath);
+  int remote_move(sg_host_t host, const char* fullpath);
+
+  int unlink(); /** Remove a file from the contents of a disk */
+  void dump();
+
+  int desc_id = 0;
+  Storage* local_storage_;
+  std::string mount_point_;
+
+private:
+  sg_size_t size_;
+  std::string path_;
+  std::string fullpath_;
+  sg_size_t current_position_ = SEEK_SET;
+  void* userdata_             = nullptr;
+};
+
+class XBT_PUBLIC FileSystemStorageExt {
+public:
+  static simgrid::xbt::Extension<Storage, FileSystemStorageExt> EXTENSION_ID;
+  explicit FileSystemStorageExt(Storage* ptr);
+  ~FileSystemStorageExt();
+  std::map<std::string, sg_size_t>* parse_content(std::string filename);
+  std::map<std::string, sg_size_t>* get_content() { return content_; }
+  sg_size_t get_size() { return size_; }
+  sg_size_t get_used_size() { return used_size_; }
+  void decr_used_size(sg_size_t size) { used_size_ -= size; }
+  void incr_used_size(sg_size_t size) { used_size_ += size; }
+
+private:
+  std::map<std::string, sg_size_t>* content_;
+  sg_size_t used_size_ = 0;
+  sg_size_t size_     = 0;
+};
+
+class XBT_PUBLIC FileDescriptorHostExt {
+public:
+  static simgrid::xbt::Extension<Host, FileDescriptorHostExt> EXTENSION_ID;
+  FileDescriptorHostExt() = default;
+  ~FileDescriptorHostExt() { delete file_descriptor_table; }
+  std::vector<int>* file_descriptor_table = nullptr; // Created lazily on need
+};
+} // namespace s4u
+} // namespace simgrid
+#endif
 #endif