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