1 /* Copyright (c) 2004-2017. 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 #include "simgrid/s4u/Host.hpp"
7 #include "src/msg/msg_private.h"
8 #include "src/surf/storage_interface.hpp"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg, "Logging specific to MSG (io)");
15 /** @addtogroup msg_file
16 * (#msg_file_t) and the functions for managing it.
21 /********************************* File **************************************/
22 void __MSG_file_get_info(msg_file_t fd){
24 xbt_dynar_t info = simcall_file_get_info(fd->simdata->smx_file);
27 fd->content_type = xbt_dynar_pop_as(info, char*);
28 fd->storage_type = xbt_dynar_pop_as(info, char*);
29 fd->storageId = xbt_dynar_pop_as(info, char*);
30 fd->mount_point = xbt_dynar_pop_as(info, char*);
31 psize = xbt_dynar_pop_as(info, sg_size_t*);
34 xbt_dynar_free_container(&info);
37 static int MSG_host_get_file_descriptor_id(msg_host_t host)
39 simgrid::MsgHostExt* priv = host->extension<simgrid::MsgHostExt>();
40 if (priv->file_descriptor_table == nullptr) {
41 priv->file_descriptor_table = new std::vector<int>(sg_storage_max_file_descriptors);
42 std::iota(priv->file_descriptor_table->rbegin(), priv->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
44 xbt_assert(!priv->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
45 int desc = priv->file_descriptor_table->back();
46 priv->file_descriptor_table->pop_back();
50 static void MSG_host_release_file_descriptor_id(msg_host_t host, int id)
52 host->extension<simgrid::MsgHostExt>()->file_descriptor_table->push_back(id);
57 * \brief Set the user data of a #msg_file_t.
59 * This functions attach \a data to \a file.
61 msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
69 * \brief Return the user data of a #msg_file_t.
71 * This functions checks whether \a file is a valid pointer and return the user data associated to \a file if possible.
73 void *MSG_file_get_data(msg_file_t fd)
79 * \brief Display information related to a file descriptor
81 * \param fd is a the file descriptor
83 void MSG_file_dump (msg_file_t fd){
84 /* Update the cached information first */
85 __MSG_file_get_info(fd);
87 XBT_INFO("File Descriptor information:\n"
88 "\t\tFull path: '%s'\n"
90 "\t\tMount point: '%s'\n"
91 "\t\tStorage Id: '%s'\n"
92 "\t\tStorage Type: '%s'\n"
93 "\t\tContent Type: '%s'\n"
94 "\t\tFile Descriptor Id: %d",
95 fd->fullpath, fd->size, fd->mount_point, fd->storageId, fd->storage_type, fd->content_type, fd->desc_id);
99 * \brief Read a file (local or remote)
101 * \param size of the file to read
102 * \param fd is a the file descriptor
103 * \return the number of bytes successfully read or -1 if an error occurred
105 sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size)
109 if (fd->size == 0) /* Nothing to read, return */
112 /* Find the host where the file is physically located and read it */
113 msg_storage_t storage_src = static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib, fd->storageId));
114 msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
115 msg_host_t attached_host = MSG_host_by_name(storage_priv_src->hostname);
116 read_size = simcall_file_read(fd->simdata->smx_file, size, attached_host);
118 if (strcmp(storage_priv_src->hostname, MSG_host_self()->cname())) {
119 /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
120 XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", storage_priv_src->hostname, read_size);
121 msg_host_t m_host_list[] = {MSG_host_self(), attached_host};
122 double flops_amount[] = {0, 0};
123 double bytes_amount[] = {0, 0, static_cast<double>(read_size), 0};
125 msg_task_t task = MSG_parallel_task_create("file transfer for read", 2, m_host_list, flops_amount, bytes_amount,
127 msg_error_t transfer = MSG_parallel_task_execute(task);
128 MSG_task_destroy(task);
130 if(transfer != MSG_OK){
131 if (transfer == MSG_HOST_FAILURE)
132 XBT_WARN("Transfer error, %s remote host just turned off!", attached_host->cname());
133 if (transfer == MSG_TASK_CANCELED)
134 XBT_WARN("Transfer error, task has been canceled!");
142 /** \ingroup msg_file
143 * \brief Write into a file (local or remote)
145 * \param size of the file to write
146 * \param fd is a the file descriptor
147 * \return the number of bytes successfully write or -1 if an error occurred
149 sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size)
151 if (size == 0) /* Nothing to write, return */
154 /* Find the host where the file is physically located (remote or local)*/
155 msg_storage_t storage_src = static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib, fd->storageId));
156 msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
157 msg_host_t attached_host = MSG_host_by_name(storage_priv_src->hostname);
159 if (strcmp(storage_priv_src->hostname, MSG_host_self()->cname())) {
160 /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
161 XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", storage_priv_src->hostname, size);
162 msg_host_t m_host_list[] = {MSG_host_self(), attached_host};
163 double flops_amount[] = {0, 0};
164 double bytes_amount[] = {0, static_cast<double>(size), 0, 0};
166 msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount,
168 msg_error_t transfer = MSG_parallel_task_execute(task);
169 MSG_task_destroy(task);
171 if(transfer != MSG_OK){
172 if (transfer == MSG_HOST_FAILURE)
173 XBT_WARN("Transfer error, %s remote host just turned off!", attached_host->cname());
174 if (transfer == MSG_TASK_CANCELED)
175 XBT_WARN("Transfer error, task has been canceled!");
180 /* Write file on local or remote host */
181 sg_size_t offset = simcall_file_tell(fd->simdata->smx_file);
182 sg_size_t write_size = simcall_file_write(fd->simdata->smx_file, size, attached_host);
183 fd->size = offset + write_size;
188 /** \ingroup msg_file
189 * \brief Opens the file whose name is the string pointed to by path
191 * \param fullpath is the file location on the storage
192 * \param data user data to attach to the file
194 * \return An #msg_file_t associated to the file
196 msg_file_t MSG_file_open(const char* fullpath, void* data)
198 msg_file_t fd = xbt_new(s_msg_file_priv_t, 1);
200 fd->fullpath = xbt_strdup(fullpath);
201 fd->simdata = xbt_new0(s_simdata_file_t, 1);
202 fd->simdata->smx_file = simcall_file_open(fullpath, MSG_host_self());
203 fd->desc_id = MSG_host_get_file_descriptor_id(MSG_host_self());
205 __MSG_file_get_info(fd);
210 /** \ingroup msg_file
211 * \brief Close the file
213 * \param fd is the file to close
214 * \return 0 on success or 1 on error
216 int MSG_file_close(msg_file_t fd)
221 int res = simcall_file_close(fd->simdata->smx_file, MSG_host_self());
222 MSG_host_release_file_descriptor_id(MSG_host_self(), fd->desc_id);
223 __MSG_file_destroy(fd);
228 /** \ingroup msg_file
229 * \brief Unlink the file pointed by fd
231 * \param fd is the file descriptor (#msg_file_t)
232 * \return 0 on success or 1 on error
234 msg_error_t MSG_file_unlink(msg_file_t fd)
236 /* Find the host where the file is physically located (remote or local)*/
237 msg_storage_t storage_src = static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib, fd->storageId));
238 msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
239 msg_host_t attached_host = MSG_host_by_name(storage_priv_src->hostname);
240 int res = simcall_file_unlink(fd->simdata->smx_file, attached_host);
241 __MSG_file_destroy(fd);
242 return static_cast<msg_error_t>(res);
245 /** \ingroup msg_file
246 * \brief Return the size of a file
248 * \param fd is the file descriptor (#msg_file_t)
249 * \return the size of the file (as a #sg_size_t)
251 sg_size_t MSG_file_get_size(msg_file_t fd){
252 return simcall_file_get_size(fd->simdata->smx_file);
257 * \brief Set the file position indicator in the msg_file_t by adding offset bytes
258 * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
260 * \param fd : file object that identifies the stream
261 * \param offset : number of bytes to offset from origin
262 * \param origin : Position used as reference for the offset. It is specified by one of the following constants defined
263 * in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
264 * SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
265 * \return If successful, the function returns MSG_OK (=0). Otherwise, it returns MSG_TASK_CANCELED (=8).
267 msg_error_t MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin)
269 return static_cast<msg_error_t>(simcall_file_seek(fd->simdata->smx_file, offset, origin));
274 * \brief Returns the current value of the position indicator of the file
276 * \param fd : file object that identifies the stream
277 * \return On success, the current value of the position indicator is returned.
280 sg_size_t MSG_file_tell(msg_file_t fd)
282 return simcall_file_tell(fd->simdata->smx_file);
285 const char *MSG_file_get_name(msg_file_t fd) {
286 xbt_assert((fd != nullptr), "Invalid parameters");
292 * \brief Move a file to another location on the *same mount point*.
295 msg_error_t MSG_file_move (msg_file_t fd, const char* fullpath)
297 return static_cast<msg_error_t>(simcall_file_move(fd->simdata->smx_file, fullpath));
302 * \brief Copy a file to another location on a remote host.
303 * \param file : the file to move
304 * \param host : the remote host where the file has to be copied
305 * \param fullpath : the complete path destination on the remote host
306 * \return If successful, the function returns MSG_OK. Otherwise, it returns MSG_TASK_CANCELED.
308 msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpath)
310 /* Find the host where the file is physically located and read it */
311 msg_storage_t storage_src = static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib, file->storageId));
312 msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
313 msg_host_t attached_host = MSG_host_by_name(storage_priv_src->hostname);
314 MSG_file_seek(file, 0, SEEK_SET);
315 sg_size_t read_size = simcall_file_read(file->simdata->smx_file, file->size, attached_host);
317 /* Find the real host destination where the file will be physically stored */
318 xbt_dict_cursor_t cursor = nullptr;
319 msg_storage_t storage_dest = nullptr;
320 msg_host_t host_dest;
321 size_t longest_prefix_length = 0;
323 xbt_dict_t storage_list = host->mountedStoragesAsDict();
326 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
327 char* file_mount_name = static_cast<char*>(xbt_malloc(strlen(mount_name) + 1));
328 strncpy(file_mount_name, fullpath, strlen(mount_name) + 1);
329 file_mount_name[strlen(mount_name)] = '\0';
331 if (!strcmp(file_mount_name, mount_name) && strlen(mount_name) > longest_prefix_length) {
332 /* The current mount name is found in the full path and is bigger than the previous*/
333 longest_prefix_length = strlen(mount_name);
334 storage_dest = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib, storage_name);
336 xbt_free(file_mount_name);
338 xbt_dict_free(&storage_list);
340 char* host_name_dest = nullptr;
341 if(longest_prefix_length>0){
342 /* Mount point found, retrieve the host the storage is attached to */
343 msg_storage_priv_t storage_dest_priv = MSG_storage_priv(storage_dest);
344 host_name_dest = (char*)storage_dest_priv->hostname;
345 host_dest = MSG_host_by_name(host_name_dest);
347 XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, host->cname());
348 return MSG_TASK_CANCELED;
351 XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, storage_priv_src->hostname,
353 msg_host_t m_host_list[] = {attached_host, host_dest};
354 double flops_amount[] = {0, 0};
355 double bytes_amount[] = {0, static_cast<double>(read_size), 0, 0};
358 MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount, nullptr);
359 msg_error_t transfer = MSG_parallel_task_execute(task);
360 MSG_task_destroy(task);
362 if(transfer != MSG_OK){
363 if (transfer == MSG_HOST_FAILURE)
364 XBT_WARN("Transfer error, %s remote host just turned off!", host_name_dest);
365 if (transfer == MSG_TASK_CANCELED)
366 XBT_WARN("Transfer error, task has been canceled!");
371 /* Create file on remote host, write it and close it */
372 smx_file_t smx_file = simcall_file_open(fullpath, host_dest);
373 simcall_file_write(smx_file, read_size, host_dest);
374 simcall_file_close(smx_file, host_dest);
380 * \brief Move a file to another location on a remote host.
381 * \param file : the file to move
382 * \param host : the remote host where the file has to be moved
383 * \param fullpath : the complete path destination on the remote host
384 * \return If successful, the function returns MSG_OK. Otherwise, it returns MSG_TASK_CANCELED.
386 msg_error_t MSG_file_rmove (msg_file_t file, msg_host_t host, const char* fullpath)
388 msg_error_t res = MSG_file_rcopy(file, host, fullpath);
389 MSG_file_unlink(file);
394 * \brief Destroys a file (internal call only)
396 void __MSG_file_destroy(msg_file_t file)
398 xbt_free(file->fullpath);
399 xbt_free(file->simdata);
403 /********************************* Storage **************************************/
404 /** @addtogroup msg_storage_management
405 * (#msg_storage_t) and the functions for managing it.
408 msg_storage_t __MSG_storage_create(smx_storage_t storage)
410 msg_storage_priv_t storage_private = xbt_new0(s_msg_storage_priv_t, 1);
412 storage_private->name = surf_storage_get_name(storage);
413 storage_private->hostname = surf_storage_get_host(storage);
414 storage_private->size = surf_storage_get_size(storage);
416 xbt_lib_set(storage_lib, storage_private->name, MSG_STORAGE_LEVEL, storage_private);
417 return xbt_lib_get_elm_or_null(storage_lib, storage_private->name);
421 * \brief Destroys a storage (internal call only)
423 void __MSG_storage_destroy(msg_storage_priv_t storage) {
427 /** \ingroup msg_storage_management
429 * \brief Returns the name of the #msg_storage_t.
431 * This functions checks whether a storage is a valid pointer or not and return its name.
433 const char *MSG_storage_get_name(msg_storage_t storage) {
434 xbt_assert((storage != nullptr), "Invalid parameters");
435 msg_storage_priv_t priv = MSG_storage_priv(storage);
439 /** \ingroup msg_storage_management
440 * \brief Returns the free space size of a storage element
441 * \param storage a storage
442 * \return the free space size of the storage element (as a #sg_size_t)
444 sg_size_t MSG_storage_get_free_size(msg_storage_t storage){
445 return simgrid::simix::kernelImmediate([storage] { return surf_storage_resource_priv(storage)->getFreeSize(); });
448 /** \ingroup msg_storage_management
449 * \brief Returns the used space size of a storage element
450 * \param storage a storage
451 * \return the used space size of the storage element (as a #sg_size_t)
453 sg_size_t MSG_storage_get_used_size(msg_storage_t storage){
454 return simgrid::simix::kernelImmediate([storage] { return surf_storage_resource_priv(storage)->getUsedSize(); });
457 /** \ingroup msg_storage_management
458 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
459 * \param storage a storage
460 * \return a dict containing the properties
462 xbt_dict_t MSG_storage_get_properties(msg_storage_t storage)
464 xbt_assert((storage != nullptr), "Invalid parameters (storage is nullptr)");
465 return (simcall_storage_get_properties(storage));
468 /** \ingroup msg_storage_management
469 * \brief Change the value of a given storage property
471 * \param storage a storage
472 * \param name a property name
473 * \param value what to change the property to
475 void MSG_storage_set_property_value(msg_storage_t storage, const char* name, char* value)
477 xbt_dict_set(MSG_storage_get_properties(storage), name, value, nullptr);
480 /** \ingroup m_storage_management
481 * \brief Returns the value of a given storage property
483 * \param storage a storage
484 * \param name a property name
485 * \return value of a property (or nullptr if property not set)
487 const char *MSG_storage_get_property_value(msg_storage_t storage, const char *name)
489 return static_cast<char*>(xbt_dict_get_or_null(MSG_storage_get_properties(storage), name));
492 /** \ingroup msg_storage_management
493 * \brief Finds a msg_storage_t using its name.
494 * \param name the name of a storage
495 * \return the corresponding storage
497 msg_storage_t MSG_storage_get_by_name(const char *name)
499 return static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib,name));
502 /** \ingroup msg_storage_management
503 * \brief Returns a dynar containing all the storage elements declared at a given point of time
505 xbt_dynar_t MSG_storages_as_dynar() {
506 xbt_lib_cursor_t cursor;
509 xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),nullptr);
511 xbt_lib_foreach(storage_lib, cursor, key, data) {
512 if(xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), MSG_STORAGE_LEVEL) != nullptr) {
513 xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
514 xbt_dynar_push(res, &elm);
520 /** \ingroup msg_storage_management
522 * \brief Set the user data of a #msg_storage_t.
523 * This functions attach \a data to \a storage if possible.
525 msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
527 msg_storage_priv_t priv = MSG_storage_priv(storage);
532 /** \ingroup m_host_management
534 * \brief Returns the user data of a #msg_storage_t.
536 * This functions checks whether \a storage is a valid pointer and returns its associate user data if possible.
538 void *MSG_storage_get_data(msg_storage_t storage)
540 xbt_assert((storage != nullptr), "Invalid parameters");
541 msg_storage_priv_t priv = MSG_storage_priv(storage);
545 /** \ingroup msg_storage_management
547 * \brief Returns the content (file list) of a #msg_storage_t.
548 * \param storage a storage
549 * \return The content of this storage element as a dict (full path file => size)
551 xbt_dict_t MSG_storage_get_content(msg_storage_t storage)
553 std::map<std::string, sg_size_t*>* content =
554 simgrid::simix::kernelImmediate([storage] { return surf_storage_resource_priv(storage)->getContent(); });
555 xbt_dict_t content_dict = xbt_dict_new_homogeneous(nullptr);
557 for (auto entry : *content) {
558 xbt_dict_set(content_dict, entry.first.c_str(), entry.second, nullptr);
563 /** \ingroup msg_storage_management
565 * \brief Returns the size of a #msg_storage_t.
566 * \param storage a storage
567 * \return The size of the storage
569 sg_size_t MSG_storage_get_size(msg_storage_t storage)
571 msg_storage_priv_t priv = MSG_storage_priv(storage);
575 /** \ingroup msg_storage_management
577 * \brief Returns the host name the storage is attached to
579 * This functions checks whether a storage is a valid pointer or not and return its name.
581 const char *MSG_storage_get_host(msg_storage_t storage) {
582 xbt_assert((storage != nullptr), "Invalid parameters");
583 msg_storage_priv_t priv = MSG_storage_priv(storage);
584 return priv->hostname;