Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
MSG_file_open/close now are in the plugin
[simgrid.git] / src / plugins / file_system / s4u_FileSystem.cpp
1 /* Copyright (c) 2015-2017. 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 #include "xbt/log.h"
7
8 #include "simgrid/s4u/Host.hpp"
9 #include "simgrid/s4u/Storage.hpp"
10 #include "simgrid/simix.hpp"
11 #include "src/plugins/file_system/FileSystem.hpp"
12 #include "src/surf/HostImpl.hpp"
13
14 #include <algorithm>
15 #include <boost/algorithm/string.hpp>
16 #include <boost/algorithm/string/join.hpp>
17 #include <boost/algorithm/string/split.hpp>
18 #include <fstream>
19
20 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_file, "S4U files");
21 int sg_storage_max_file_descriptors = 1024;
22
23 namespace simgrid {
24 namespace s4u {
25 simgrid::xbt::Extension<Storage, FileSystemStorageExt> FileSystemStorageExt::EXTENSION_ID;
26 simgrid::xbt::Extension<Host, FileDescriptorHostExt> FileDescriptorHostExt::EXTENSION_ID;
27
28 File::File(std::string fullpath, void* userdata) : File(fullpath, Host::current(), userdata){};
29
30 File::File(std::string fullpath, sg_host_t host, void* userdata) : fullpath_(fullpath), userdata_(userdata)
31 {
32   // this cannot fail because we get a xbt_die if the mountpoint does not exist
33   Storage* st                  = nullptr;
34   size_t longest_prefix_length = 0;
35   XBT_DEBUG("Search for storage name for '%s' on '%s'", fullpath.c_str(), host->getCname());
36
37   for (auto const& mnt : host->getMountedStorages()) {
38     XBT_DEBUG("See '%s'", mnt.first.c_str());
39     mount_point_ = fullpath.substr(0, mnt.first.length());
40
41     if (mount_point_ == mnt.first && mnt.first.length() > longest_prefix_length) {
42       /* The current mount name is found in the full path and is bigger than the previous*/
43       longest_prefix_length = mnt.first.length();
44       st                    = mnt.second;
45     }
46   }
47   if (longest_prefix_length > 0) { /* Mount point found, split fullpath into mount_name and path+filename*/
48     mount_point_ = fullpath.substr(0, longest_prefix_length);
49     path_        = fullpath.substr(longest_prefix_length, fullpath.length());
50   } else
51     xbt_die("Can't find mount point for '%s' on '%s'", fullpath.c_str(), host->getCname());
52
53   localStorage = st;
54
55   // assign a file descriptor id to the newly opened File
56   FileDescriptorHostExt* ext = host->extension<simgrid::s4u::FileDescriptorHostExt>();
57   if (ext->file_descriptor_table == nullptr) {
58     ext->file_descriptor_table = new std::vector<int>(sg_storage_max_file_descriptors);
59     std::iota(ext->file_descriptor_table->rbegin(), ext->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
60   }
61   xbt_assert(not ext->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
62   desc_id = ext->file_descriptor_table->back();
63   ext->file_descriptor_table->pop_back();
64
65   XBT_DEBUG("\tOpen file '%s'", path_.c_str());
66   std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
67   // if file does not exist create an empty file
68   auto sz = content->find(path_);
69   if (sz != content->end()) {
70     size_ = sz->second;
71   } else {
72     size_ = 0;
73     content->insert({path_, size_});
74     XBT_DEBUG("File '%s' was not found, file created.", path_.c_str());
75   }
76 }
77
78 File::~File()
79 {
80   Host::current()->extension<simgrid::s4u::FileDescriptorHostExt>()->file_descriptor_table->push_back(desc_id);
81 }
82
83 void File::dump()
84 {
85   XBT_INFO("File Descriptor information:\n"
86            "\t\tFull path: '%s'\n"
87            "\t\tSize: %llu\n"
88            "\t\tMount point: '%s'\n"
89            "\t\tStorage Id: '%s'\n"
90            "\t\tStorage Type: '%s'\n"
91            "\t\tFile Descriptor Id: %d",
92            getPath(), size_, mount_point_.c_str(), localStorage->getCname(), localStorage->getType(), desc_id);
93 }
94
95 sg_size_t File::read(sg_size_t size)
96 {
97   XBT_DEBUG("READ %s on disk '%s'", getPath(), localStorage->getCname());
98   // if the current position is close to the end of the file, we may not be able to read the requested size
99   sg_size_t read_size = localStorage->read(std::min(size, size_ - current_position_));
100   current_position_ += read_size;
101   return read_size;
102 }
103
104 sg_size_t File::write(sg_size_t size)
105 {
106   XBT_DEBUG("WRITE %s on disk '%s'. size '%llu/%llu'", getPath(), localStorage->getCname(), size, size_);
107   // If the storage is full before even starting to write
108   if (sg_storage_get_size_used(localStorage) >= sg_storage_get_size(localStorage))
109     return 0;
110   /* Substract the part of the file that might disappear from the used sized on the storage element */
111   localStorage->extension<FileSystemStorageExt>()->decrUsedSize(size_ - current_position_);
112
113   sg_size_t write_size = localStorage->write(size);
114   localStorage->extension<FileSystemStorageExt>()->incrUsedSize(write_size);
115
116   current_position_ += write_size;
117   size_ = current_position_;
118   std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
119
120   content->erase(path_);
121   content->insert({path_, size_});
122
123   return write_size;
124 }
125
126 sg_size_t File::size()
127 {
128   return size_;
129 }
130
131 void File::seek(sg_offset_t offset)
132 {
133   current_position_ = offset;
134 }
135
136 void File::seek(sg_offset_t offset, int origin)
137 {
138   switch (origin) {
139     case SEEK_SET:
140       current_position_ = offset;
141       break;
142     case SEEK_CUR:
143       current_position_ += offset;
144       break;
145     case SEEK_END:
146       current_position_ = size_ + offset;
147       break;
148     default:
149       break;
150   }
151 }
152
153 sg_size_t File::tell()
154 {
155   return current_position_;
156 }
157
158 void File::move(std::string fullpath)
159 {
160   /* Check if the new full path is on the same mount point */
161   if (not strncmp(mount_point_.c_str(), fullpath.c_str(), mount_point_.length())) {
162     std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
163     auto sz = content->find(path_);
164     if (sz != content->end()) { // src file exists
165       sg_size_t new_size = sz->second;
166       content->erase(path_);
167       std::string path = fullpath.substr(mount_point_.length(), fullpath.length());
168       content->insert({path.c_str(), new_size});
169       XBT_DEBUG("Move file from %s to %s, size '%llu'", path_.c_str(), fullpath.c_str(), new_size);
170     } else {
171       XBT_WARN("File %s doesn't exist", path_.c_str());
172     }
173   } else {
174     XBT_WARN("New full path %s is not on the same mount point: %s.", fullpath.c_str(), mount_point_.c_str());
175   }
176 }
177
178 int File::unlink()
179 {
180   /* Check if the file is on local storage */
181   std::map<std::string, sg_size_t>* content = localStorage->extension<FileSystemStorageExt>()->getContent();
182
183   if (content->find(path_) == content->end()) {
184     XBT_WARN("File %s is not on disk %s. Impossible to unlink", path_.c_str(), localStorage->getCname());
185     return -1;
186   } else {
187     XBT_DEBUG("UNLINK %s on disk '%s'", path_.c_str(), localStorage->getCname());
188     localStorage->extension<FileSystemStorageExt>()->decrUsedSize(size_);
189
190     // Remove the file from storage
191     content->erase(fullpath_);
192
193     return 0;
194   }
195 }
196
197 FileSystemStorageExt::FileSystemStorageExt(simgrid::s4u::Storage* ptr)
198 {
199   content_ = parseContent(ptr->getImpl()->content_name);
200   size_    = ptr->getImpl()->size_;
201 }
202
203 FileSystemStorageExt::~FileSystemStorageExt()
204 {
205   delete content_;
206 }
207
208 std::map<std::string, sg_size_t>* FileSystemStorageExt::parseContent(std::string filename)
209 {
210   if (filename.empty())
211     return nullptr;
212
213   std::map<std::string, sg_size_t>* parse_content = new std::map<std::string, sg_size_t>();
214
215   std::ifstream* fs = surf_ifsopen(filename);
216
217   std::string line;
218   std::vector<std::string> tokens;
219   do {
220     std::getline(*fs, line);
221     boost::trim(line);
222     if (line.length() > 0) {
223       boost::split(tokens, line, boost::is_any_of(" \t"), boost::token_compress_on);
224       xbt_assert(tokens.size() == 2, "Parse error in %s: %s", filename.c_str(), line.c_str());
225       sg_size_t size = std::stoull(tokens.at(1));
226
227       usedSize_ += size;
228       parse_content->insert({tokens.front(), size});
229     }
230   } while (not fs->eof());
231   delete fs;
232   return parse_content;
233 }
234 }
235 }
236
237 using simgrid::s4u::FileSystemStorageExt;
238 using simgrid::s4u::FileDescriptorHostExt;
239
240 static void onStorageCreation(simgrid::s4u::Storage& st)
241 {
242   st.extension_set(new FileSystemStorageExt(&st));
243 }
244
245 static void onStorageDestruction(simgrid::s4u::Storage& st)
246 {
247   delete st.extension<FileSystemStorageExt>();
248 }
249
250 static void onHostCreation(simgrid::s4u::Host& host)
251 {
252   host.extension_set<FileDescriptorHostExt>(new FileDescriptorHostExt());
253 }
254
255 /* **************************** Public interface *************************** */
256 SG_BEGIN_DECL()
257
258 void sg_storage_file_system_init()
259 {
260   if (not FileSystemStorageExt::EXTENSION_ID.valid()) {
261     FileSystemStorageExt::EXTENSION_ID = simgrid::s4u::Storage::extension_create<FileSystemStorageExt>();
262     simgrid::s4u::Storage::onCreation.connect(&onStorageCreation);
263     simgrid::s4u::Storage::onDestruction.connect(&onStorageDestruction);
264   }
265
266   if (not FileDescriptorHostExt::EXTENSION_ID.valid()) {
267     FileDescriptorHostExt::EXTENSION_ID = simgrid::s4u::Host::extension_create<FileDescriptorHostExt>();
268     simgrid::s4u::Host::onCreation.connect(&onHostCreation);
269   }
270 }
271
272 sg_file_t sg_file_open(const char* fullpath, void* data)
273 {
274   return new simgrid::s4u::File(fullpath, data);
275 }
276
277 void sg_file_close(sg_file_t fd)
278 {
279   delete fd;
280 }
281
282 const char* sg_file_get_name(sg_file_t fd)
283 {
284   xbt_assert((fd != nullptr), "Invalid file descriptor");
285   return fd->getPath();
286 }
287
288 sg_size_t sg_file_get_size(sg_file_t fd)
289 {
290   return fd->size();
291 }
292
293 void sg_file_dump(sg_file_t fd)
294 {
295   fd->dump();
296 }
297
298 void* sg_file_get_data(sg_file_t fd)
299 {
300   return fd->getUserdata();
301 }
302
303 void sg_file_set_data(sg_file_t fd, void* data)
304 {
305   fd->setUserdata(data);
306 }
307
308 /**
309  * \brief Set the file position indicator in the msg_file_t by adding offset bytes
310  * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
311  *
312  * \param fd : file object that identifies the stream
313  * \param offset : number of bytes to offset from origin
314  * \param origin : Position used as reference for the offset. It is specified by one of the following constants defined
315  *                 in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
316  *                 SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
317  */
318 void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin)
319 {
320   fd->seek(offset, origin);
321 }
322
323 sg_size_t sg_file_tell(sg_file_t fd)
324 {
325   return fd->tell();
326 }
327
328 void sg_file_move(sg_file_t fd, const char* fullpath)
329 {
330   fd->move(fullpath);
331 }
332
333 void sg_file_unlink(sg_file_t fd)
334 {
335   fd->unlink();
336   delete fd;
337 }
338
339 sg_size_t sg_storage_get_size_free(sg_storage_t st)
340 {
341   return st->extension<FileSystemStorageExt>()->getSize() - st->extension<FileSystemStorageExt>()->getUsedSize();
342 }
343
344 sg_size_t sg_storage_get_size_used(sg_storage_t st)
345 {
346   return st->extension<FileSystemStorageExt>()->getUsedSize();
347 }
348
349 sg_size_t sg_storage_get_size(sg_storage_t st)
350 {
351   return st->extension<FileSystemStorageExt>()->getSize();
352 }
353
354 xbt_dict_t sg_storage_get_content(sg_storage_t storage)
355 {
356   std::map<std::string, sg_size_t>* content = storage->extension<simgrid::s4u::FileSystemStorageExt>()->getContent();
357   // Note: ::operator delete is ok here (no destructor called) since the dict elements are of POD type sg_size_t.
358   xbt_dict_t content_as_dict = xbt_dict_new_homogeneous(::operator delete);
359
360   for (auto const& entry : *content) {
361     sg_size_t* psize = new sg_size_t;
362     *psize           = entry.second;
363     xbt_dict_set(content_as_dict, entry.first.c_str(), psize, nullptr);
364   }
365   return content_as_dict;
366 }
367
368 xbt_dict_t sg_host_get_storage_content(sg_host_t host)
369 {
370   xbt_assert((host != nullptr), "Invalid parameters");
371   xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
372   for (auto const& elm : host->getMountedStorages())
373     xbt_dict_set(contents, elm.first.c_str(), sg_storage_get_content(elm.second), nullptr);
374
375   return contents;
376 }
377
378 SG_END_DECL()