1 /* Copyright (c) 2004-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "msg_private.h"
10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg,
11 "Logging specific to MSG (io)");
13 /** @addtogroup msg_file_management
14 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Files" --> \endhtmlonly
15 * (#msg_file_t) and the functions for managing it.
21 /********************************* File **************************************/
22 void __MSG_file_get_info(msg_file_t fd){
24 msg_file_priv_t priv = MSG_file_priv(fd);
25 xbt_dynar_t info = simcall_file_get_info(priv->simdata->smx_file);
28 priv->content_type = xbt_dynar_pop_as(info, char *);
29 priv->storage_type = xbt_dynar_pop_as(info, char *);
30 priv->storageId = xbt_dynar_pop_as(info, char *);
31 priv->mount_point = xbt_dynar_pop_as(info, char *);
32 psize = xbt_dynar_pop_as(info, sg_size_t*);
35 xbt_dynar_free_container(&info);
38 /** \ingroup msg_file_management
40 * \brief Set the user data of a #msg_file_t.
42 * This functions checks whether some data has already been associated to \a file
43 or not and attach \a data to \a file if it is possible.
45 msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
47 msg_file_priv_t priv = MSG_file_priv(fd);
52 /** \ingroup msg_file_management
54 * \brief Return the user data of a #msg_file_t.
56 * This functions checks whether \a file is a valid pointer or not and return
57 the user data associated to \a file if it is possible.
59 void *MSG_file_get_data(msg_file_t fd)
61 msg_file_priv_t priv = MSG_file_priv(fd);
65 /** \ingroup msg_file_management
66 * \brief Display information related to a file descriptor
68 * \param fd is a the file descriptor
71 void MSG_file_dump (msg_file_t fd){
72 /* Update the cached information first */
73 __MSG_file_get_info(fd);
75 msg_file_priv_t priv = MSG_file_priv(fd);
76 XBT_INFO("File Descriptor information:\n"
77 "\t\tFull path: '%s'\n"
79 "\t\tMount point: '%s'\n"
80 "\t\tStorage Id: '%s'\n"
81 "\t\tStorage Type: '%s'\n"
82 "\t\tContent Type: '%s'\n"
83 "\t\tFile Descriptor Id: %d",
84 priv->fullpath, priv->size, priv->mount_point,
85 priv->storageId, priv->storage_type,
86 priv->content_type, priv->desc_id);
89 /** \ingroup msg_file_management
90 * \brief Read a file (local or remote)
92 * \param size of the file to read
93 * \param fd is a the file descriptor
94 * \return the number of bytes successfully read or -1 if an error occurred
96 sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size)
98 msg_file_priv_t file_priv = MSG_file_priv(fd);
101 /* Find the host where the file is physically located and read it */
102 msg_storage_t storage_src =(msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, file_priv->storageId);
103 msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
104 msg_host_t attached_host = MSG_host_by_name(storage_priv_src->hostname);
105 read_size = simcall_file_read(file_priv->simdata->smx_file, size, attached_host);
107 if(strcmp(storage_priv_src->hostname, MSG_host_get_name(MSG_host_self()))){
108 /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
109 XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", storage_priv_src->hostname, read_size);
110 msg_host_t *m_host_list = NULL;
111 m_host_list = (msg_host_t*) calloc(2, sizeof(msg_host_t));
113 m_host_list[0] = MSG_host_self();
114 m_host_list[1] = attached_host;
115 double flops_amount[] = { 0, 0 };
116 double bytes_amount[] = { 0, 0, (double)read_size, 0 };
118 msg_task_t task = MSG_parallel_task_create("file transfer for read", 2, m_host_list, flops_amount, bytes_amount, NULL);
119 msg_error_t transfer = MSG_parallel_task_execute(task);
120 MSG_task_destroy(task);
122 if(transfer != MSG_OK){
123 if (transfer == MSG_HOST_FAILURE)
124 XBT_WARN("Transfer error, %s remote host just turned off!", MSG_host_get_name(attached_host));
125 if (transfer == MSG_TASK_CANCELED)
126 XBT_WARN("Transfer error, task has been canceled!");
134 /** \ingroup msg_file_management
135 * \brief Write into a file (local or remote)
137 * \param size of the file to write
138 * \param fd is a the file descriptor
139 * \return the number of bytes successfully write or -1 if an error occurred
141 sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size)
143 msg_file_priv_t file_priv = MSG_file_priv(fd);
144 sg_size_t write_size, offset;
146 /* Find the host where the file is physically located (remote or local)*/
147 msg_storage_t storage_src =(msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, file_priv->storageId);
148 msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
149 msg_host_t attached_host = MSG_host_by_name(storage_priv_src->hostname);
151 if(strcmp(storage_priv_src->hostname, MSG_host_get_name(MSG_host_self()))){
152 /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
153 XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", storage_priv_src->hostname, size);
154 msg_host_t *m_host_list = NULL;
155 m_host_list = (msg_host_t*) calloc(2, sizeof(msg_host_t));
157 m_host_list[0] = MSG_host_self();
158 m_host_list[1] = attached_host;
159 double flops_amount[] = { 0, 0 };
160 double bytes_amount[] = { 0, (double)size, 0, 0 };
162 msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount, NULL);
163 msg_error_t transfer = MSG_parallel_task_execute(task);
164 MSG_task_destroy(task);
166 if(transfer != MSG_OK){
167 if (transfer == MSG_HOST_FAILURE)
168 XBT_WARN("Transfer error, %s remote host just turned off!", MSG_host_get_name(attached_host));
169 if (transfer == MSG_TASK_CANCELED)
170 XBT_WARN("Transfer error, task has been canceled!");
175 /* Write file on local or remote host */
176 offset = simcall_file_tell(file_priv->simdata->smx_file);
177 write_size = simcall_file_write(file_priv->simdata->smx_file, size, attached_host);
178 file_priv->size = offset+write_size;
183 /** \ingroup msg_file_management
184 * \brief Opens the file whose name is the string pointed to by path
186 * \param fullpath is the file location on the storage
187 * \param data user data to attach to the file
189 * \return An #msg_file_t associated to the file
191 msg_file_t MSG_file_open(const char* fullpath, void* data)
194 msg_file_priv_t priv = xbt_new(s_msg_file_priv_t, 1);
196 priv->fullpath = xbt_strdup(fullpath);
197 priv->simdata = xbt_new0(s_simdata_file_t,1);
198 priv->simdata->smx_file = simcall_file_open(fullpath, MSG_host_self());
199 priv->desc_id = __MSG_host_get_file_descriptor_id(MSG_host_self());
201 name = bprintf("%s:%s:%d", priv->fullpath, MSG_host_get_name(MSG_host_self()),
204 xbt_lib_set(file_lib, name, MSG_FILE_LEVEL, priv);
205 msg_file_t fd = (msg_file_t) xbt_lib_get_elm_or_null(file_lib, name);
206 __MSG_file_get_info(fd);
212 /** \ingroup msg_file_management
213 * \brief Close the file
215 * \param fd is the file to close
216 * \return 0 on success or 1 on error
218 int MSG_file_close(msg_file_t fd)
221 msg_file_priv_t priv = MSG_file_priv(fd);
223 xbt_free(priv->data);
225 int res = simcall_file_close(priv->simdata->smx_file, MSG_host_self());
226 name = bprintf("%s:%s:%d", priv->fullpath, MSG_host_get_name(MSG_host_self()),
228 __MSG_host_release_file_descriptor_id(MSG_host_self(), priv->desc_id);
229 xbt_lib_unset(file_lib, name, MSG_FILE_LEVEL, 1);
234 /** \ingroup msg_file_management
235 * \brief Unlink the file pointed by fd
237 * \param fd is the file descriptor (#msg_file_t)
238 * \return 0 on success or 1 on error
240 msg_error_t MSG_file_unlink(msg_file_t fd)
242 msg_file_priv_t file_priv = MSG_file_priv(fd);
243 /* Find the host where the file is physically located (remote or local)*/
244 msg_storage_t storage_src =
245 (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,
246 file_priv->storageId);
247 msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
248 msg_host_t attached_host = MSG_host_by_name(storage_priv_src->hostname);
249 int res = simcall_file_unlink(file_priv->simdata->smx_file, attached_host);
250 return (msg_error_t) res;
253 /** \ingroup msg_file_management
254 * \brief Return the size of a file
256 * \param fd is the file descriptor (#msg_file_t)
257 * \return the size of the file (as a #sg_size_t)
259 sg_size_t MSG_file_get_size(msg_file_t fd){
260 msg_file_priv_t priv = MSG_file_priv(fd);
261 return simcall_file_get_size(priv->simdata->smx_file);
265 * \ingroup msg_file_management
266 * \brief Set the file position indicator in the msg_file_t by adding offset bytes
267 * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
269 * \param fd : file object that identifies the stream
270 * \param offset : number of bytes to offset from origin
271 * \param origin : Position used as reference for the offset. It is specified by
272 * one of the following constants defined in \<stdio.h\> exclusively to be used as
273 * arguments for this function (SEEK_SET = beginning of file, SEEK_CUR = current
274 * position of the file pointer, SEEK_END = end of file)
276 * \return If successful, the function returns MSG_OK (=0). Otherwise, it returns
277 * MSG_TASK_CANCELED (=8).
280 msg_error_t MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin)
282 msg_file_priv_t priv = MSG_file_priv(fd);
283 return (msg_error_t) simcall_file_seek(priv->simdata->smx_file, offset, origin);
287 * \ingroup msg_file_management
288 * \brief Returns the current value of the position indicator of the file
290 * \param fd : file object that identifies the stream
291 * \return On success, the current value of the position indicator is returned.
294 sg_size_t MSG_file_tell(msg_file_t fd)
296 msg_file_priv_t priv = MSG_file_priv(fd);
297 return simcall_file_tell(priv->simdata->smx_file);
300 const char *MSG_file_get_name(msg_file_t fd) {
301 xbt_assert((fd != NULL), "Invalid parameters");
302 msg_file_priv_t priv = MSG_file_priv(fd);
303 return priv->fullpath;
307 * \ingroup msg_file_management
308 * \brief Move a file to another location on the *same mount point*.
311 msg_error_t MSG_file_move (msg_file_t fd, const char* fullpath)
313 msg_file_priv_t priv = MSG_file_priv(fd);
314 return (msg_error_t) simcall_file_move(priv->simdata->smx_file, fullpath);
318 * \ingroup msg_file_management
319 * \brief Copy a file to another location on a remote host.
320 * \param file : the file to move
321 * \param host : the remote host where the file has to be copied
322 * \param fullpath : the complete path destination on the remote host
323 * \return If successful, the function returns MSG_OK. Otherwise, it returns
326 msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpath)
328 msg_file_priv_t file_priv = MSG_file_priv(file);
331 /* Find the host where the file is physically located and read it */
332 msg_storage_t storage_src =(msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, file_priv->storageId);
333 msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
334 msg_host_t attached_host = MSG_host_by_name(storage_priv_src->hostname);
335 MSG_file_seek(file, 0, SEEK_SET);
336 read_size = simcall_file_read(file_priv->simdata->smx_file, file_priv->size, attached_host);
338 /* Find the real host destination where the file will be physically stored */
339 xbt_dict_cursor_t cursor = NULL;
340 char *mount_name, *storage_name, *file_mount_name, *host_name_dest;
341 msg_storage_t storage_dest = NULL;
342 msg_host_t host_dest;
343 size_t longest_prefix_length = 0;
345 xbt_dict_t storage_list = host->mountedStoragesAsDict();
346 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
347 file_mount_name = (char *) xbt_malloc ((strlen(mount_name)+1));
348 strncpy(file_mount_name,fullpath,strlen(mount_name)+1);
349 file_mount_name[strlen(mount_name)] = '\0';
351 if(!strcmp(file_mount_name,mount_name) && strlen(mount_name)>longest_prefix_length){
352 /* The current mount name is found in the full path and is bigger than the previous*/
353 longest_prefix_length = strlen(mount_name);
354 storage_dest = (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, storage_name);
356 free(file_mount_name);
358 xbt_dict_free(&storage_list);
360 if(longest_prefix_length>0){
361 /* Mount point found, retrieve the host the storage is attached to */
362 msg_storage_priv_t storage_dest_priv = MSG_storage_priv(storage_dest);
363 host_name_dest = (char*)storage_dest_priv->hostname;
364 host_dest = MSG_host_by_name(host_name_dest);
367 XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, sg_host_get_name(host));
368 return MSG_TASK_CANCELED;
371 XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, storage_priv_src->hostname, host_name_dest);
372 msg_host_t *m_host_list = NULL;
373 m_host_list = (msg_host_t*) calloc(2, sizeof(msg_host_t));
375 m_host_list[0] = attached_host;
376 m_host_list[1] = host_dest;
377 double flops_amount[] = { 0, 0 };
378 double bytes_amount[] = { 0, (double)read_size, 0, 0 };
380 msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount, NULL);
381 msg_error_t transfer = MSG_parallel_task_execute(task);
382 MSG_task_destroy(task);
384 if(transfer != MSG_OK){
385 if (transfer == MSG_HOST_FAILURE)
386 XBT_WARN("Transfer error, %s remote host just turned off!", host_name_dest);
387 if (transfer == MSG_TASK_CANCELED)
388 XBT_WARN("Transfer error, task has been canceled!");
390 return (msg_error_t) -1;
393 /* Create file on remote host, write it and close it */
394 smx_file_t smx_file = simcall_file_open(fullpath, host_dest);
395 simcall_file_write(smx_file, read_size, host_dest);
396 simcall_file_close(smx_file, host_dest);
402 * \ingroup msg_file_management
403 * \brief Move a file to another location on a remote host.
404 * \param file : the file to move
405 * \param host : the remote host where the file has to be moved
406 * \param fullpath : the complete path destination on the remote host
407 * \return If successful, the function returns MSG_OK. Otherwise, it returns
410 msg_error_t MSG_file_rmove (msg_file_t file, msg_host_t host, const char* fullpath)
412 msg_error_t res = MSG_file_rcopy(file, host, fullpath);
413 MSG_file_unlink(file);
418 * \brief Destroys a file (internal call only)
420 void __MSG_file_destroy(msg_file_priv_t file) {
421 xbt_free(file->fullpath);
422 xbt_free(file->simdata);
425 /********************************* Storage **************************************/
427 /** @addtogroup msg_storage_management
428 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Storages" --> \endhtmlonly
429 * (#msg_storage_t) and the functions for managing it.
433 msg_storage_t __MSG_storage_create(smx_storage_t storage)
435 const char *name = SIMIX_storage_get_name(storage);
436 const char *host = SIMIX_storage_get_host(storage);
437 msg_storage_priv_t storage_private = xbt_new0(s_msg_storage_priv_t, 1);
438 storage_private->hostname = host;
439 xbt_lib_set(storage_lib,name,MSG_STORAGE_LEVEL,storage_private);
440 return xbt_lib_get_elm_or_null(storage_lib, name);
444 * \brief Destroys a storage (internal call only)
446 void __MSG_storage_destroy(msg_storage_priv_t storage) {
451 /** \ingroup msg_storage_management
453 * \brief Returns the name of the #msg_storage_t.
455 * This functions checks whether a storage is a valid pointer or not and return its name.
457 const char *MSG_storage_get_name(msg_storage_t storage) {
458 xbt_assert((storage != NULL), "Invalid parameters");
459 return SIMIX_storage_get_name(storage);
462 /** \ingroup msg_storage_management
463 * \brief Returns the free space size of a storage element
464 * \param storage a storage
465 * \return the free space size of the storage element (as a #sg_size_t)
467 sg_size_t MSG_storage_get_free_size(msg_storage_t storage){
468 return simcall_storage_get_free_size(storage);
471 /** \ingroup msg_storage_management
472 * \brief Returns the used space size of a storage element
473 * \param storage a storage
474 * \return the used space size of the storage element (as a #sg_size_t)
476 sg_size_t MSG_storage_get_used_size(msg_storage_t storage){
477 return simcall_storage_get_used_size(storage);
480 /** \ingroup msg_storage_management
481 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
482 * \param storage a storage
483 * \return a dict containing the properties
485 xbt_dict_t MSG_storage_get_properties(msg_storage_t storage)
487 xbt_assert((storage != NULL), "Invalid parameters (storage is NULL)");
488 return (simcall_storage_get_properties(storage));
491 /** \ingroup msg_storage_management
492 * \brief Change the value of a given storage property
494 * \param storage a storage
495 * \param name a property name
496 * \param value what to change the property to
497 * \param free_ctn the freeing function to use to kill the value on need
499 void MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn) {
500 xbt_dict_set(MSG_storage_get_properties(storage), name, value,free_ctn);
503 /** \ingroup m_storage_management
504 * \brief Returns the value of a given storage property
506 * \param storage a storage
507 * \param name a property name
508 * \return value of a property (or NULL if property not set)
510 const char *MSG_storage_get_property_value(msg_storage_t storage, const char *name)
512 return (char*) xbt_dict_get_or_null(MSG_storage_get_properties(storage), name);
516 /** \ingroup msg_storage_management
517 * \brief Finds a msg_storage_t using its name.
518 * \param name the name of a storage
519 * \return the corresponding storage
521 msg_storage_t MSG_storage_get_by_name(const char *name)
523 return (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,name);
526 /** \ingroup msg_storage_management
527 * \brief Returns a dynar containing all the storage elements declared at a given point of time
530 xbt_dynar_t MSG_storages_as_dynar(void) {
532 xbt_lib_cursor_t cursor;
535 xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),NULL);
537 xbt_lib_foreach(storage_lib, cursor, key, data) {
538 if(xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), MSG_STORAGE_LEVEL) != NULL) {
539 xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
540 xbt_dynar_push(res, &elm);
546 /** \ingroup msg_storage_management
548 * \brief Set the user data of a #msg_storage_t.
549 * This functions checks whether some data has already been associated to \a storage
550 or not and attach \a data to \a storage if it is possible.
552 msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
554 msg_storage_priv_t priv = MSG_storage_priv(storage);
559 /** \ingroup m_host_management
561 * \brief Returns the user data of a #msg_storage_t.
563 * This functions checks whether \a storage is a valid pointer or not and returns
564 the user data associated to \a storage if it is possible.
566 void *MSG_storage_get_data(msg_storage_t storage)
568 xbt_assert((storage != NULL), "Invalid parameters");
569 msg_storage_priv_t priv = MSG_storage_priv(storage);
573 /** \ingroup msg_storage_management
575 * \brief Returns the content (file list) of a #msg_storage_t.
576 * \param storage a storage
577 * \return The content of this storage element as a dict (full path file => size)
579 xbt_dict_t MSG_storage_get_content(msg_storage_t storage)
581 return SIMIX_storage_get_content(storage);
584 /** \ingroup msg_storage_management
586 * \brief Returns the size of a #msg_storage_t.
587 * \param storage a storage
588 * \return The size of the storage
590 sg_size_t MSG_storage_get_size(msg_storage_t storage)
592 return SIMIX_storage_get_size(storage);
595 /** \ingroup msg_storage_management
597 * \brief Returns the host name the storage is attached to
599 * This functions checks whether a storage is a valid pointer or not and return its name.
601 const char *MSG_storage_get_host(msg_storage_t storage) {
602 xbt_assert((storage != NULL), "Invalid parameters");
603 msg_storage_priv_t priv = MSG_storage_priv(storage);
604 return priv->hostname;