Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use XBT_PULIC_CLASS here too
[simgrid.git] / src / plugins / file_system / FileSystem.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 "simgrid/plugins/file_system.h"
10 #include <xbt/Extendable.hpp>
11 #include <xbt/base.h>
12
13 #include <simgrid/simix.h>
14 #include <string>
15
16 namespace simgrid {
17 namespace s4u {
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(std::string fullpath, void* userdata);
31   File(std::string fullpath, sg_host_t host, void* userdata);
32   ~File();
33
34   /** Retrieves the path to the file */
35   const char* getPath() { return fullpath_.c_str(); }
36
37   /** Simulates a local read action. Returns the size of data actually read */
38   sg_size_t read(sg_size_t size);
39
40   /** Simulates a write action. Returns the size of data actually written. */
41   sg_size_t write(sg_size_t size);
42
43   /** Allows to store user data on that host */
44   void setUserdata(void* data) { userdata_ = data; }
45   /** Retrieves the previously stored data */
46   void* getUserdata() { return userdata_; }
47
48   sg_size_t size();
49   void seek(sg_offset_t pos);             /** Sets the file head to the given position. */
50   void seek(sg_offset_t pos, int origin); /** Sets the file head to the given position from a given origin. */
51   sg_size_t tell();                       /** Retrieves the current file position */
52
53   /** Rename a file. WARNING: It is forbidden to move the file to another mount point */
54   void move(std::string fullpath);
55   int remoteCopy(sg_host_t host, const char* fullpath);
56   int remoteMove(sg_host_t host, const char* fullpath);
57
58   int unlink(); /** Remove a file from the contents of a disk */
59   void dump();
60
61   int desc_id = 0;
62   Storage* localStorage;
63   std::string mount_point_;
64
65 private:
66   sg_size_t size_;
67   std::string path_;
68   std::string fullpath_;
69   sg_size_t current_position_ = SEEK_SET;
70   void* userdata_             = nullptr;
71 };
72
73 XBT_PUBLIC_CLASS FileSystemStorageExt {
74 public:
75   static simgrid::xbt::Extension<Storage, FileSystemStorageExt> EXTENSION_ID;
76   explicit FileSystemStorageExt(Storage* ptr);
77   ~FileSystemStorageExt();
78   std::map<std::string, sg_size_t>* parseContent(std::string filename);
79   std::map<std::string, sg_size_t>* getContent() { return content_; }
80   sg_size_t getSize() { return size_; }
81   sg_size_t getUsedSize() { return usedSize_; }
82   void decrUsedSize(sg_size_t size) { usedSize_ -= size; }
83   void incrUsedSize(sg_size_t size) { usedSize_ += size; }
84 private:
85   std::map<std::string, sg_size_t>* content_;
86   sg_size_t usedSize_ = 0;
87   sg_size_t size_     = 0;
88 };
89
90 XBT_PUBLIC_CLASS FileDescriptorHostExt
91 {
92 public:
93   static simgrid::xbt::Extension<Host, FileDescriptorHostExt> EXTENSION_ID;
94   FileDescriptorHostExt() = default;
95   ~FileDescriptorHostExt() { delete file_descriptor_table; }
96   std::vector<int>* file_descriptor_table = nullptr; // Created lazily on need
97 };
98 }
99 } // namespace simgrid::s4u
100
101 #endif /* SIMGRID_S4U_HOST_HPP */