Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
unlink can be a remote operation too.
[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[2048];
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   sprintf(name, "%s:%s",MSG_host_get_name(MSG_host_self()),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
203   return fd;
204 }
205
206 /**
207  * \brief Frees private data of a file (internal call only)
208  */
209 void __MSG_file_priv_free(msg_file_priv_t priv)
210 {
211   xbt_free(&priv->simdata->smx_file);
212   free(priv);
213 }
214
215 /** \ingroup msg_file_management
216  * \brief Close the file
217  *
218  * \param fd is the file to close
219  * \return 0 on success or 1 on error
220  */
221 int MSG_file_close(msg_file_t fd)
222 {
223   char name[2048];
224   msg_file_priv_t priv = MSG_file_priv(fd);
225   int res = simcall_file_close(priv->simdata->smx_file, MSG_host_self());
226   sprintf(name, "%s:%s",MSG_host_get_name(MSG_host_self()),priv->fullpath);
227   xbt_lib_unset(file_lib, name, MSG_FILE_LEVEL, 1);
228   return res;
229 }
230
231 /** \ingroup msg_file_management
232  * \brief Unlink the file pointed by fd
233  *
234  * \param fd is the file descriptor (#msg_file_t)
235  * \return 0 on success or 1 on error
236  */
237 msg_error_t MSG_file_unlink(msg_file_t fd)
238 {
239   msg_file_priv_t file_priv = MSG_file_priv(fd);
240   /* Find the host where the file is physically located (remote or local)*/
241   msg_storage_t storage_src =
242       (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,
243                                               file_priv->storageId);
244   msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
245   msg_host_t attached_host = MSG_get_host_by_name(storage_priv_src->hostname);
246   int res = simcall_file_unlink(file_priv->simdata->smx_file, attached_host);
247   return res;
248 }
249
250 /** \ingroup msg_file_management
251  * \brief Return the size of a file
252  *
253  * \param fd is the file descriptor (#msg_file_t)
254  * \return the size of the file (as a #sg_size_t)
255  */
256 sg_size_t MSG_file_get_size(msg_file_t fd){
257   msg_file_priv_t priv = MSG_file_priv(fd);
258   return simcall_file_get_size(priv->simdata->smx_file);
259 }
260
261 /**
262  * \ingroup msg_file_management
263  * \brief Set the file position indicator in the msg_file_t by adding offset bytes
264  * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
265  *
266  * \param fd : file object that identifies the stream
267  * \param offset : number of bytes to offset from origin
268  * \param origin : Position used as reference for the offset. It is specified by
269  * one of the following constants defined in \<stdio.h\> exclusively to be used as
270  * arguments for this function (SEEK_SET = beginning of file, SEEK_CUR = current
271  * position of the file pointer, SEEK_END = end of file)
272  *
273  * \return If successful, the function returns MSG_OK (=0). Otherwise, it returns
274  * MSG_TASK_CANCELED (=8).
275  *
276  */
277 msg_error_t MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin)
278 {
279   msg_file_priv_t priv = MSG_file_priv(fd);
280   return simcall_file_seek(priv->simdata->smx_file, offset, origin);
281 }
282
283 /**
284  * \ingroup msg_file_management
285  * \brief Returns the current value of the position indicator of the file
286  *
287  * \param fd : file object that identifies the stream
288  * \return On success, the current value of the position indicator is returned.
289  *
290  */
291 sg_size_t MSG_file_tell(msg_file_t fd)
292 {
293   msg_file_priv_t priv = MSG_file_priv(fd);
294   return simcall_file_tell(priv->simdata->smx_file);
295 }
296
297 const char *MSG_file_get_name(msg_file_t fd) {
298   xbt_assert((fd != NULL), "Invalid parameters");
299   msg_file_priv_t priv = MSG_file_priv(fd);
300   return priv->fullpath;
301 }
302
303 /**
304  * \ingroup msg_file_management
305  * \brief Move a file to another location on the *same mount point*.
306  *
307  */
308 msg_error_t MSG_file_move (msg_file_t fd, const char* fullpath)
309 {
310   msg_file_priv_t priv = MSG_file_priv(fd);
311   return simcall_file_move(priv->simdata->smx_file, fullpath);
312 }
313
314 /**
315  * \ingroup msg_file_management
316  * \brief Copy a file to another location on a remote host.
317  * \param file : the file to move
318  * \param host : the remote host where the file has to be copied
319  * \param fullpath : the complete path destination on the remote host
320  * \return If successful, the function returns MSG_OK. Otherwise, it returns
321  * MSG_TASK_CANCELED.
322  */
323 msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpath)
324 {
325   msg_file_priv_t file_priv = MSG_file_priv(file);
326   sg_size_t read_size;
327
328   /* Find the host where the file is physically located and read it */
329   msg_storage_t storage_src =(msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, file_priv->storageId);
330   msg_storage_priv_t storage_priv_src = MSG_storage_priv(storage_src);
331   msg_host_t attached_host = MSG_get_host_by_name(storage_priv_src->hostname);
332   MSG_file_seek(file, 0, SEEK_SET);
333   read_size = simcall_file_read(file_priv->simdata->smx_file, file_priv->size, attached_host);
334
335   /* Find the real host destination where the file will be physically stored */
336   xbt_dict_cursor_t cursor = NULL;
337   char *mount_name, *storage_name, *file_mount_name, *host_name_dest;
338   msg_storage_t storage_dest = NULL;
339   msg_host_t host_dest;
340   size_t longest_prefix_length = 0;
341
342   xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
343   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
344     file_mount_name = (char *) xbt_malloc ((strlen(mount_name)+1));
345     strncpy(file_mount_name,fullpath,strlen(mount_name)+1);
346     file_mount_name[strlen(mount_name)] = '\0';
347
348     if(!strcmp(file_mount_name,mount_name) && strlen(mount_name)>longest_prefix_length){
349       /* The current mount name is found in the full path and is bigger than the previous*/
350       longest_prefix_length = strlen(mount_name);
351       storage_dest = (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib, storage_name);
352     }
353     free(file_mount_name);
354   }
355   xbt_dict_free(&storage_list);
356
357   if(longest_prefix_length>0){
358     /* Mount point found, retrieve the host the storage is attached to */
359     msg_storage_priv_t storage_dest_priv = MSG_storage_priv(storage_dest);
360     host_name_dest = (char*)storage_dest_priv->hostname;
361     host_dest = MSG_get_host_by_name(host_name_dest);
362
363   }else{
364     XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, SIMIX_host_get_name(host));
365     return MSG_TASK_CANCELED;
366   }
367
368   XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, storage_priv_src->hostname, host_name_dest);
369   msg_host_t *m_host_list = NULL;
370   m_host_list = calloc(2, sizeof(msg_host_t));
371
372   m_host_list[0] = attached_host;
373   m_host_list[1] = host_dest;
374   double computation_amount[] = { 0, 0 };
375   double communication_amount[] = { 0, (double)read_size, 0, 0 };
376
377   msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, computation_amount, communication_amount, NULL);
378   msg_error_t transfer = MSG_parallel_task_execute(task);
379   MSG_task_destroy(task);
380   free(m_host_list);
381   if(transfer != MSG_OK){
382     if (transfer == MSG_HOST_FAILURE)
383       XBT_WARN("Transfer error, %s remote host just turned off!", host_name_dest);
384     if (transfer == MSG_TASK_CANCELED)
385       XBT_WARN("Transfer error, task has been canceled!");
386
387     return -1;
388   }
389
390   /* Create file on remote host, write it and close it */
391   smx_file_t smx_file = simcall_file_open(fullpath, host_dest);
392   simcall_file_write(smx_file, read_size, host_dest);
393   simcall_file_close(smx_file, host_dest);
394   return MSG_OK;
395
396 }
397
398 /**
399  * \ingroup msg_file_management
400  * \brief Move a file to another location on a remote host.
401  * \param file : the file to move
402  * \param host : the remote host where the file has to be moved
403  * \param fullpath : the complete path destination on the remote host
404  * \return If successful, the function returns MSG_OK. Otherwise, it returns
405  * MSG_TASK_CANCELED.
406  */
407 msg_error_t MSG_file_rmove (msg_file_t file, msg_host_t host, const char* fullpath)
408 {
409   msg_error_t res = MSG_file_rcopy(file, host, fullpath);
410   MSG_file_unlink(file);
411   return res;
412 }
413
414 /**
415  * \brief Destroys a file (internal call only)
416  */
417 void __MSG_file_destroy(msg_file_priv_t file) {
418   xbt_free(file->fullpath);
419   xbt_free(file->simdata);
420   xbt_free(file);
421 }
422 /********************************* Storage **************************************/
423
424 /** @addtogroup msg_storage_management
425  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Storages" --> \endhtmlonly
426  * (#msg_storage_t) and the functions for managing it.
427  *
428  */
429
430 msg_storage_t __MSG_storage_create(smx_storage_t storage)
431 {
432   const char *name = SIMIX_storage_get_name(storage);
433   const char *host = SIMIX_storage_get_host(storage);
434   msg_storage_priv_t storage_private = xbt_new0(s_msg_storage_priv_t, 1);
435   storage_private->hostname = host;
436   xbt_lib_set(storage_lib,name,MSG_STORAGE_LEVEL,storage_private);
437   return xbt_lib_get_elm_or_null(storage_lib, name);
438 }
439
440 /**
441  * \brief Destroys a storage (internal call only)
442  */
443 void __MSG_storage_destroy(msg_storage_priv_t storage) {
444   free(storage);
445 }
446
447
448 /** \ingroup msg_storage_management
449  *
450  * \brief Returns the name of the #msg_storage_t.
451  *
452  * This functions checks whether a storage is a valid pointer or not and return its name.
453  */
454 const char *MSG_storage_get_name(msg_storage_t storage) {
455   xbt_assert((storage != NULL), "Invalid parameters");
456   return SIMIX_storage_get_name(storage);
457 }
458
459 /** \ingroup msg_storage_management
460  * \brief Returns the free space size of a storage element
461  * \param storage a storage
462  * \return the free space size of the storage element (as a #sg_size_t)
463  */
464 sg_size_t MSG_storage_get_free_size(msg_storage_t storage){
465   return simcall_storage_get_free_size(storage);
466 }
467
468 /** \ingroup msg_storage_management
469  * \brief Returns the used space size of a storage element
470  * \param storage a storage
471  * \return the used space size of the storage element (as a #sg_size_t)
472  */
473 sg_size_t MSG_storage_get_used_size(msg_storage_t storage){
474   return simcall_storage_get_used_size(storage);
475 }
476
477 /** \ingroup msg_storage_management
478  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
479  * \param storage a storage
480  * \return a dict containing the properties
481  */
482 xbt_dict_t MSG_storage_get_properties(msg_storage_t storage)
483 {
484   xbt_assert((storage != NULL), "Invalid parameters (storage is NULL)");
485   return (simcall_storage_get_properties(storage));
486 }
487
488 /** \ingroup msg_storage_management
489  * \brief Change the value of a given storage property
490  *
491  * \param storage a storage
492  * \param name a property name
493  * \param value what to change the property to
494  * \param free_ctn the freeing function to use to kill the value on need
495  */
496 void MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn) {
497   xbt_dict_set(MSG_storage_get_properties(storage), name, value,free_ctn);
498 }
499
500 /** \ingroup msg_storage_management
501  * \brief Finds a msg_storage_t using its name.
502  * \param name the name of a storage
503  * \return the corresponding storage
504  */
505 msg_storage_t MSG_storage_get_by_name(const char *name)
506 {
507   return (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,name);
508 }
509
510 /** \ingroup msg_storage_management
511  * \brief Returns a dynar containing all the storage elements declared at a given point of time
512  *
513  */
514 xbt_dynar_t MSG_storages_as_dynar(void) {
515
516   xbt_lib_cursor_t cursor;
517   char *key;
518   void **data;
519   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),NULL);
520
521   xbt_lib_foreach(storage_lib, cursor, key, data) {
522           if(xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), MSG_STORAGE_LEVEL) != NULL) {
523       xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
524       xbt_dynar_push(res, &elm);
525     }
526   }
527   return res;
528 }
529
530 /** \ingroup msg_storage_management
531  *
532  * \brief Set the user data of a #msg_storage_t.
533  * This functions checks whether some data has already been associated to \a storage
534    or not and attach \a data to \a storage if it is possible.
535  */
536 msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
537 {
538   msg_storage_priv_t priv = MSG_storage_priv(storage);
539   priv->data = data;
540   return MSG_OK;
541 }
542
543 /** \ingroup msg_host_management
544  *
545  * \brief Returns the user data of a #msg_storage_t.
546  *
547  * This functions checks whether \a storage is a valid pointer or not and returns
548    the user data associated to \a storage if it is possible.
549  */
550 void *MSG_storage_get_data(msg_storage_t storage)
551 {
552   xbt_assert((storage != NULL), "Invalid parameters");
553   msg_storage_priv_t priv = MSG_storage_priv(storage);
554   return priv->data;
555 }
556
557 /** \ingroup msg_storage_management
558  *
559  * \brief Returns the content (file list) of a #msg_storage_t.
560  * \param storage a storage
561  * \return The content of this storage element as a dict (full path file => size)
562  */
563 xbt_dict_t MSG_storage_get_content(msg_storage_t storage)
564 {
565   return SIMIX_storage_get_content(storage);
566 }
567
568 /** \ingroup msg_storage_management
569  *
570  * \brief Returns the size of a #msg_storage_t.
571  * \param storage a storage
572  * \return The size of the storage
573  */
574 sg_size_t MSG_storage_get_size(msg_storage_t storage)
575 {
576   return SIMIX_storage_get_size(storage);
577 }
578
579 /** \ingroup msg_storage_management
580  *
581  * \brief Returns the host name the storage is attached to
582  *
583  * This functions checks whether a storage is a valid pointer or not and return its name.
584  */
585 const char *MSG_storage_get_host(msg_storage_t storage) {
586   xbt_assert((storage != NULL), "Invalid parameters");
587   msg_storage_priv_t priv = MSG_storage_priv(storage);
588   return priv->hostname;
589 }