Logo AND Algorithmique Numérique Distribuée

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