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