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