1 /* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_FILE_HPP
7 #define SIMGRID_S4U_FILE_HPP
12 #include <simgrid/simix.h>
20 /** @brief A simulated file
22 * Used to simulate the time it takes to access to a file, but does not really store any information.
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.
27 XBT_PUBLIC_CLASS File {
29 File(const char *fullpath, void* userdata);
32 /** Retrieves the path to the file */
33 const char *path() { return path_;}
35 /** Simulates a read action. Returns the size of data actually read
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.
40 sg_size_t read(sg_size_t size);
41 /** Simulates a write action. Returns the size of data actually written.
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.
46 sg_size_t write(sg_size_t size);
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_;}
53 /** Retrieve the datasize */
56 /** Sets the file head to the given position. */
57 void seek(sg_size_t pos);
58 /** Retrieves the current file position */
63 * WARNING: It is forbidden to move the file to another mount point */
64 void move(const char*fullpath);
66 /** Remove a file from disk */
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);
76 smx_file_t pimpl_ = nullptr;
77 const char *path_ = nullptr;
78 void *userdata_ = nullptr;
81 }} // namespace simgrid::s4u
83 #endif /* SIMGRID_S4U_HOST_HPP */