Logo AND Algorithmique Numérique Distribuée

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