include/simgrid/s4u/File.hpp

   1 /* Copyright (c) 2006-2015. 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_S4U_FILE_HPP
   7 #define SIMGRID_S4U_FILE_HPP
   8
   9 #include <xbt/base.h>
  10
  11 #include "src/surf/StorageImpl.hpp"
  12 #include <simgrid/simix.h>
  13
  14 namespace simgrid {
  15 namespace s4u {
  16
  17 class Storage;
  18
  19 /** @brief A simulated file
  20  *
  21  * Used to simulate the time it takes to access to a file, but does not really store any information.
  22  *
  23  * They are located on @ref simgrid::s4u::Storage that are accessed from a given @ref simgrid::s4u::Host through
  24  * mountpoints.
  25  * For now, you cannot change the mountpoints programatically, and must declare them from your platform file.
  26  */
  27 XBT_PUBLIC_CLASS File
  28 {
  29 public:
  30   File(const char* fullpath, void* userdata);
  31   ~File();
  32
  33   /** Retrieves the path to the file */
  34   const char* path() { return path_; }
  35
  36   /** Simulates a read action. Returns the size of data actually read
  37    *
  38    *  FIXME: reading from a remotely mounted disk is not implemented yet.
  39    *  Any storage is considered as local, and no network communication ever occur.
  40    */
  41   sg_size_t read(sg_size_t size);
  42   /** Simulates a write action. Returns the size of data actually written.
  43    *
  44    *  FIXME: reading from a remotely mounted disk is not implemented yet.
  45    *  Any storage is considered as local, and no network communication ever occur.
  46    */
  47   sg_size_t write(sg_size_t size);
  48
  49   /** Allows to store user data on that host */
  50   void setUserdata(void* data) { userdata_ = data; }
  51   /** Retrieves the previously stored data */
  52   void* userdata() { return userdata_; }
  53
  54   /** Retrieve the datasize */
  55   sg_size_t size();
  56
  57   /** Sets the file head to the given position. */
  58   void seek(sg_size_t pos);
  59   /** Retrieves the current file position */
  60   sg_size_t tell();
  61
  62   /** Rename a file
  63    *
  64    * WARNING: It is forbidden to move the file to another mount point */
  65   void move(const char* fullpath);
  66
  67   /** Remove a file from disk */
  68   void unlink();
  69
  70   /* FIXME: add these to the S4U API:
  71   XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t file);
  72   XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
  73   XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
  74   */
  75   char* storage_type;
  76   char* storageId;
  77   char* mount_point;
  78   int desc_id = 0;
  79
  80 private:
  81   smx_file_t pimpl_ = nullptr;
  82   const char* path_ = nullptr;
  83   void* userdata_   = nullptr;
  84 };
  85 }
  86 } // namespace simgrid::s4u
  87
  88 #endif /* SIMGRID_S4U_HOST_HPP */