Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
2cf7bb5cd4594cdd74cff775e780704f86acf5e1
[simgrid.git] / src / msg / msg_io.c
1 /* Copyright (c) 2004-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "msg_private.h"
8 #include "xbt/log.h"
9 #include "msg_mailbox.h"
10
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg,
12                                 "Logging specific to MSG (io)");
13
14 /** @addtogroup msg_file_management
15  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Files" --> \endhtmlonly
16  * (#msg_file_t) and the functions for managing it.
17  *
18  *  \see #msg_file_t
19  */
20
21 /********************************* File **************************************/
22 void __MSG_file_get_info(msg_file_t fd){
23
24   msg_file_priv_t priv = MSG_file_priv(fd);
25   xbt_dynar_t info = simcall_file_get_info(priv->simdata->smx_file);
26   sg_size_t *psize;
27
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*);
33   priv->size = *psize;
34   xbt_free(psize);
35   xbt_dynar_free_container(&info);
36 }
37
38 /** \ingroup msg_file_management
39  *
40  * \brief Set the user data of a #msg_file_t.
41  *
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.
44  */
45 msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
46 {
47   msg_file_priv_t priv = MSG_file_priv(fd);
48   priv->data = data;
49   return MSG_OK;
50 }
51
52 /** \ingroup msg_file_management
53  *
54  * \brief Return the user data of a #msg_file_t.
55  *
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.
58  */
59 void *MSG_file_get_data(msg_file_t fd)
60 {
61   msg_file_priv_t priv = MSG_file_priv(fd);
62   return priv->data;
63 }
64
65 /** \ingroup msg_file_management
66  * \brief Display information related to a file descriptor
67  *
68  * \param fd is a the file descriptor
69  */
70
71 void MSG_file_dump (msg_file_t fd){
72   /* Update the cached information first */
73   __MSG_file_get_info(fd);
74
75   msg_file_priv_t priv = MSG_file_priv(fd);
76   XBT_INFO("File Descriptor information:\n"
77            "\t\tFull path: '%s'\n"
78            "\t\tSize: %llu\n"
79            "\t\tMount point: '%s'\n"
80            "\t\tStorage Id: '%s'\n"
81            "\t\tStorage Type: '%s'\n"
82            "\t\tContent Type: '%s'",
83            priv->fullpath, priv->size, priv->mount_point,
84            priv->storageId, priv->storage_type,
85            priv->content_type);
86 }
87
88 /** \ingroup msg_file_management
89  * \brief Read a file (local or remote)
90  *
91  * \param size of the file to read
92  * \param fd is a the file descriptor
93  * \return the number of bytes successfully read or -1 if an error occurred
94  */
95 sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size)
96 {
97   msg_file_priv_t file_priv = MSG_file_priv(fd);
98   sg_size_t read_size;
99
100   /* Find the host where the file is physically located and read it */
101   msg_storage_t storage_src =(msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, file_priv->storageId);
102   msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
103   msg_host_t attached_host = MSG_get_host_by_name(storage_priv_src->hostname);
104   read_size = simcall_file_read(file_priv->simdata->smx_file, size, attached_host);
105
106   if(strcmp(storage_priv_src->hostname, MSG_host_get_name(MSG_host_self()))){
107     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
108     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", storage_priv_src->hostname, read_size);
109     msg_host_t *m_host_list = NULL;
110     m_host_list = calloc(2, sizeof(msg_host_t));
111
112     m_host_list[0] = MSG_host_self();
113     m_host_list[1] = attached_host;
114     double computation_amount[] = { 0, 0 };
115     double communication_amount[] = { 0, 0, (double)read_size, 0 };
116
117     msg_task_t task = MSG_parallel_task_create("file transfer for read", 2, m_host_list, computation_amount, communication_amount, NULL);
118     msg_error_t transfer = MSG_parallel_task_execute(task);
119     MSG_task_destroy(task);
120     free(m_host_list);
121     if(transfer != MSG_OK){
122       if (transfer == MSG_HOST_FAILURE)
123         XBT_WARN("Transfer error, %s remote host just turned off!", MSG_host_get_name(attached_host));
124       if (transfer == MSG_TASK_CANCELED)
125         XBT_WARN("Transfer error, task has been canceled!");
126
127       return -1;
128     }
129   }
130   return read_size;
131 }
132
133 /** \ingroup msg_file_management
134  * \brief Write into a file (local or remote)
135  *
136  * \param size of the file to write
137  * \param fd is a the file descriptor
138  * \return the number of bytes successfully write or -1 if an error occurred
139  */
140 sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size)
141 {
142   msg_file_priv_t file_priv = MSG_file_priv(fd);
143   sg_size_t write_size, offset;
144
145   /* Find the host where the file is physically located (remote or local)*/
146   msg_storage_t storage_src =(msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, file_priv->storageId);
147   msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
148   msg_host_t attached_host = MSG_get_host_by_name(storage_priv_src->hostname);
149
150   if(strcmp(storage_priv_src->hostname, MSG_host_get_name(MSG_host_self()))){
151     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
152     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", storage_priv_src->hostname, size);
153     msg_host_t *m_host_list = NULL;
154     m_host_list = calloc(2, sizeof(msg_host_t));
155
156     m_host_list[0] = MSG_host_self();
157     m_host_list[1] = attached_host;
158     double computation_amount[] = { 0, 0 };
159     double communication_amount[] = { 0, (double)size, 0, 0 };
160
161     msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, computation_amount, communication_amount, NULL);
162     msg_error_t transfer = MSG_parallel_task_execute(task);
163     MSG_task_destroy(task);
164     free(m_host_list);
165     if(transfer != MSG_OK){
166       if (transfer == MSG_HOST_FAILURE)
167         XBT_WARN("Transfer error, %s remote host just turned off!", MSG_host_get_name(attached_host));
168       if (transfer == MSG_TASK_CANCELED)
169         XBT_WARN("Transfer error, task has been canceled!");
170
171       return -1;
172     }
173   }
174   /* Write file on local or remote host */
175   offset = simcall_file_tell(file_priv->simdata->smx_file);
176   write_size = simcall_file_write(file_priv->simdata->smx_file, size, attached_host);
177   file_priv->size = offset+write_size;
178
179   return write_size;
180 }
181
182 /** \ingroup msg_file_management
183  * \brief Opens the file whose name is the string pointed to by path
184  *
185  * \param fullpath is the file location on the storage
186  * \param data user data to attach to the file
187  *
188  * \return An #msg_file_t associated to the file
189  */
190 msg_file_t MSG_file_open(const char* fullpath, void* data)
191 {
192   char *name;
193   msg_file_priv_t priv = xbt_new(s_msg_file_priv_t, 1);
194   priv->data = data;
195   priv->fullpath = xbt_strdup(fullpath);
196   priv->simdata = xbt_new0(s_simdata_file_t,1);
197   priv->simdata->smx_file = simcall_file_open(fullpath, MSG_host_self());
198   name = bprintf("%s:%i:%s",MSG_host_get_name(MSG_host_self()),MSG_process_self_PID(),fullpath);
199   xbt_lib_set(file_lib, name, MSG_FILE_LEVEL, priv);
200   msg_file_t fd = (msg_file_t) xbt_lib_get_elm_or_null(file_lib, name);
201   __MSG_file_get_info(fd);
202   xbt_free(name);
203   return fd;
204 }
205
206 /** \ingroup msg_file_management
207  * \brief Close the file
208  *
209  * \param fd is the file to close
210  * \return 0 on success or 1 on error
211  */
212 int MSG_file_close(msg_file_t fd)
213 {
214   char *name;
215   msg_file_priv_t priv = MSG_file_priv(fd);
216   if (priv->data)
217     xbt_free(priv->data);
218
219   int res = simcall_file_close(priv->simdata->smx_file, MSG_host_self());
220   name = bprintf("%s:%i:%s",MSG_host_get_name(MSG_host_self()),MSG_process_self_PID(),priv->fullpath);
221   xbt_lib_unset(file_lib, name, MSG_FILE_LEVEL, 1);
222   xbt_free(name);
223   return res;
224 }
225
226 /** \ingroup msg_file_management
227  * \brief Unlink the file pointed by fd
228  *
229  * \param fd is the file descriptor (#msg_file_t)
230  * \return 0 on success or 1 on error
231  */
232 msg_error_t MSG_file_unlink(msg_file_t fd)
233 {
234   msg_file_priv_t file_priv = MSG_file_priv(fd);
235   /* Find the host where the file is physically located (remote or local)*/
236   msg_storage_t storage_src =
237       (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,
238                                               file_priv->storageId);
239   msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
240   msg_host_t attached_host = MSG_get_host_by_name(storage_priv_src->hostname);
241   int res = simcall_file_unlink(file_priv->simdata->smx_file, attached_host);
242   return res;
243 }
244
245 /** \ingroup msg_file_management
246  * \brief Return the size of a file
247  *
248  * \param fd is the file descriptor (#msg_file_t)
249  * \return the size of the file (as a #sg_size_t)
250  */
251 sg_size_t MSG_file_get_size(msg_file_t fd){
252   msg_file_priv_t priv = MSG_file_priv(fd);
253   return simcall_file_get_size(priv->simdata->smx_file);
254 }
255
256 /**
257  * \ingroup msg_file_management
258  * \brief Set the file position indicator in the msg_file_t by adding offset bytes
259  * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
260  *
261  * \param fd : file object that identifies the stream
262  * \param offset : number of bytes to offset from origin
263  * \param origin : Position used as reference for the offset. It is specified by
264  * one of the following constants defined in \<stdio.h\> exclusively to be used as
265  * arguments for this function (SEEK_SET = beginning of file, SEEK_CUR = current
266  * position of the file pointer, SEEK_END = end of file)
267  *
268  * \return If successful, the function returns MSG_OK (=0). Otherwise, it returns
269  * MSG_TASK_CANCELED (=8).
270  *
271  */
272 msg_error_t MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin)
273 {
274   msg_file_priv_t priv = MSG_file_priv(fd);
275   return simcall_file_seek(priv->simdata->smx_file, offset, origin);
276 }
277
278 /**
279  * \ingroup msg_file_management
280  * \brief Returns the current value of the position indicator of the file
281  *
282  * \param fd : file object that identifies the stream
283  * \return On success, the current value of the position indicator is returned.
284  *
285  */
286 sg_size_t MSG_file_tell(msg_file_t fd)
287 {
288   msg_file_priv_t priv = MSG_file_priv(fd);
289   return simcall_file_tell(priv->simdata->smx_file);
290 }
291
292 const char *MSG_file_get_name(msg_file_t fd) {
293   xbt_assert((fd != NULL), "Invalid parameters");
294   msg_file_priv_t priv = MSG_file_priv(fd);
295   return priv->fullpath;
296 }
297
298 /**
299  * \ingroup msg_file_management
300  * \brief Move a file to another location on the *same mount point*.
301  *
302  */
303 msg_error_t MSG_file_move (msg_file_t fd, const char* fullpath)
304 {
305   msg_file_priv_t priv = MSG_file_priv(fd);
306   return simcall_file_move(priv->simdata->smx_file, fullpath);
307 }
308
309 /**
310  * \ingroup msg_file_management
311  * \brief Copy a file to another location on a remote host.
312  * \param file : the file to move
313  * \param host : the remote host where the file has to be copied
314  * \param fullpath : the complete path destination on the remote host
315  * \return If successful, the function returns MSG_OK. Otherwise, it returns
316  * MSG_TASK_CANCELED.
317  */
318 msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpath)
319 {
320   msg_file_priv_t file_priv = MSG_file_priv(file);
321   sg_size_t read_size;
322
323   /* Find the host where the file is physically located and read it */
324   msg_storage_t storage_src =(msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, file_priv->storageId);
325   msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
326   msg_host_t attached_host = MSG_get_host_by_name(storage_priv_src->hostname);
327   MSG_file_seek(file, 0, SEEK_SET);
328   read_size = simcall_file_read(file_priv->simdata->smx_file, file_priv->size, attached_host);
329
330   /* Find the real host destination where the file will be physically stored */
331   xbt_dict_cursor_t cursor = NULL;
332   char *mount_name, *storage_name, *file_mount_name, *host_name_dest;
333   msg_storage_t storage_dest = NULL;
334   msg_host_t host_dest;
335   size_t longest_prefix_length = 0;
336
337   xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
338   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
339     file_mount_name = (char *) xbt_malloc ((strlen(mount_name)+1));
340     strncpy(file_mount_name,fullpath,strlen(mount_name)+1);
341     file_mount_name[strlen(mount_name)] = '\0';
342
343     if(!strcmp(file_mount_name,mount_name) && strlen(mount_name)>longest_prefix_length){
344       /* The current mount name is found in the full path and is bigger than the previous*/
345       longest_prefix_length = strlen(mount_name);
346       storage_dest = (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, storage_name);
347     }
348     free(file_mount_name);
349   }
350   xbt_dict_free(&storage_list);
351
352   if(longest_prefix_length>0){
353     /* Mount point found, retrieve the host the storage is attached to */
354     msg_storage_priv_t storage_dest_priv = MSG_storage_priv(storage_dest);
355     host_name_dest = (char*)storage_dest_priv->hostname;
356     host_dest = MSG_get_host_by_name(host_name_dest);
357
358   }else{
359     XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, SIMIX_host_get_name(host));
360     return MSG_TASK_CANCELED;
361   }
362
363   XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, storage_priv_src->hostname, host_name_dest);
364   msg_host_t *m_host_list = NULL;
365   m_host_list = calloc(2, sizeof(msg_host_t));
366
367   m_host_list[0] = attached_host;
368   m_host_list[1] = host_dest;
369   double computation_amount[] = { 0, 0 };
370   double communication_amount[] = { 0, (double)read_size, 0, 0 };
371
372   msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, computation_amount, communication_amount, NULL);
373   msg_error_t transfer = MSG_parallel_task_execute(task);
374   MSG_task_destroy(task);
375   free(m_host_list);
376   if(transfer != MSG_OK){
377     if (transfer == MSG_HOST_FAILURE)
378       XBT_WARN("Transfer error, %s remote host just turned off!", host_name_dest);
379     if (transfer == MSG_TASK_CANCELED)
380       XBT_WARN("Transfer error, task has been canceled!");
381
382     return -1;
383   }
384
385   /* Create file on remote host, write it and close it */
386   smx_file_t smx_file = simcall_file_open(fullpath, host_dest);
387   simcall_file_write(smx_file, read_size, host_dest);
388   simcall_file_close(smx_file, host_dest);
389   return MSG_OK;
390
391 }
392
393 /**
394  * \ingroup msg_file_management
395  * \brief Move a file to another location on a remote host.
396  * \param file : the file to move
397  * \param host : the remote host where the file has to be moved
398  * \param fullpath : the complete path destination on the remote host
399  * \return If successful, the function returns MSG_OK. Otherwise, it returns
400  * MSG_TASK_CANCELED.
401  */
402 msg_error_t MSG_file_rmove (msg_file_t file, msg_host_t host, const char* fullpath)
403 {
404   msg_error_t res = MSG_file_rcopy(file, host, fullpath);
405   MSG_file_unlink(file);
406   return res;
407 }
408
409 /**
410  * \brief Destroys a file (internal call only)
411  */
412 void __MSG_file_destroy(msg_file_priv_t file) {
413   xbt_free(file->fullpath);
414   xbt_free(file->simdata);
415   xbt_free(file);
416 }
417 /********************************* Storage **************************************/
418
419 /** @addtogroup msg_storage_management
420  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Storages" --> \endhtmlonly
421  * (#msg_storage_t) and the functions for managing it.
422  *
423  */
424
425 msg_storage_t __MSG_storage_create(smx_storage_t storage)
426 {
427   const char *name = SIMIX_storage_get_name(storage);
428   const char *host = SIMIX_storage_get_host(storage);
429   msg_storage_priv_t storage_private = xbt_new0(s_msg_storage_priv_t, 1);
430   storage_private->hostname = host;
431   xbt_lib_set(storage_lib,name,MSG_STORAGE_LEVEL,storage_private);
432   return xbt_lib_get_elm_or_null(storage_lib, name);
433 }
434
435 /**
436  * \brief Destroys a storage (internal call only)
437  */
438 void __MSG_storage_destroy(msg_storage_priv_t storage) {
439   free(storage);
440 }
441
442
443 /** \ingroup msg_storage_management
444  *
445  * \brief Returns the name of the #msg_storage_t.
446  *
447  * This functions checks whether a storage is a valid pointer or not and return its name.
448  */
449 const char *MSG_storage_get_name(msg_storage_t storage) {
450   xbt_assert((storage != NULL), "Invalid parameters");
451   return SIMIX_storage_get_name(storage);
452 }
453
454 /** \ingroup msg_storage_management
455  * \brief Returns the free space size of a storage element
456  * \param storage a storage
457  * \return the free space size of the storage element (as a #sg_size_t)
458  */
459 sg_size_t MSG_storage_get_free_size(msg_storage_t storage){
460   return simcall_storage_get_free_size(storage);
461 }
462
463 /** \ingroup msg_storage_management
464  * \brief Returns the used space size of a storage element
465  * \param storage a storage
466  * \return the used space size of the storage element (as a #sg_size_t)
467  */
468 sg_size_t MSG_storage_get_used_size(msg_storage_t storage){
469   return simcall_storage_get_used_size(storage);
470 }
471
472 /** \ingroup msg_storage_management
473  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
474  * \param storage a storage
475  * \return a dict containing the properties
476  */
477 xbt_dict_t MSG_storage_get_properties(msg_storage_t storage)
478 {
479   xbt_assert((storage != NULL), "Invalid parameters (storage is NULL)");
480   return (simcall_storage_get_properties(storage));
481 }
482
483 /** \ingroup msg_storage_management
484  * \brief Change the value of a given storage property
485  *
486  * \param storage a storage
487  * \param name a property name
488  * \param value what to change the property to
489  * \param free_ctn the freeing function to use to kill the value on need
490  */
491 void MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn) {
492   xbt_dict_set(MSG_storage_get_properties(storage), name, value,free_ctn);
493 }
494
495 /** \ingroup msg_storage_management
496  * \brief Finds a msg_storage_t using its name.
497  * \param name the name of a storage
498  * \return the corresponding storage
499  */
500 msg_storage_t MSG_storage_get_by_name(const char *name)
501 {
502   return (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,name);
503 }
504
505 /** \ingroup msg_storage_management
506  * \brief Returns a dynar containing all the storage elements declared at a given point of time
507  *
508  */
509 xbt_dynar_t MSG_storages_as_dynar(void) {
510
511   xbt_lib_cursor_t cursor;
512   char *key;
513   void **data;
514   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),NULL);
515
516   xbt_lib_foreach(storage_lib, cursor, key, data) {
517           if(xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), MSG_STORAGE_LEVEL) != NULL) {
518       xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
519       xbt_dynar_push(res, &elm);
520     }
521   }
522   return res;
523 }
524
525 /** \ingroup msg_storage_management
526  *
527  * \brief Set the user data of a #msg_storage_t.
528  * This functions checks whether some data has already been associated to \a storage
529    or not and attach \a data to \a storage if it is possible.
530  */
531 msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
532 {
533   msg_storage_priv_t priv = MSG_storage_priv(storage);
534   priv->data = data;
535   return MSG_OK;
536 }
537
538 /** \ingroup msg_host_management
539  *
540  * \brief Returns the user data of a #msg_storage_t.
541  *
542  * This functions checks whether \a storage is a valid pointer or not and returns
543    the user data associated to \a storage if it is possible.
544  */
545 void *MSG_storage_get_data(msg_storage_t storage)
546 {
547   xbt_assert((storage != NULL), "Invalid parameters");
548   msg_storage_priv_t priv = MSG_storage_priv(storage);
549   return priv->data;
550 }
551
552 /** \ingroup msg_storage_management
553  *
554  * \brief Returns the content (file list) of a #msg_storage_t.
555  * \param storage a storage
556  * \return The content of this storage element as a dict (full path file => size)
557  */
558 xbt_dict_t MSG_storage_get_content(msg_storage_t storage)
559 {
560   return SIMIX_storage_get_content(storage);
561 }
562
563 /** \ingroup msg_storage_management
564  *
565  * \brief Returns the size of a #msg_storage_t.
566  * \param storage a storage
567  * \return The size of the storage
568  */
569 sg_size_t MSG_storage_get_size(msg_storage_t storage)
570 {
571   return SIMIX_storage_get_size(storage);
572 }
573
574 /** \ingroup msg_storage_management
575  *
576  * \brief Returns the host name the storage is attached to
577  *
578  * This functions checks whether a storage is a valid pointer or not and return its name.
579  */
580 const char *MSG_storage_get_host(msg_storage_t storage) {
581   xbt_assert((storage != NULL), "Invalid parameters");
582   msg_storage_priv_t priv = MSG_storage_priv(storage);
583   return priv->hostname;
584 }