src/msg/msg_io.cpp

   1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/s4u/File.hpp"
   7 #include "simgrid/s4u/Host.hpp"
   8 #include "simgrid/s4u/Storage.hpp"
   9 #include "src/msg/msg_private.h"
  10 #include <numeric>
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg, "Logging specific to MSG (io)");
  13
  14 SG_BEGIN_DECL()
  15
  16 /** @addtogroup msg_file
  17  * (#msg_file_t) and the functions for managing it.
  18  *
  19  *  \see #msg_file_t
  20  */
  21
  22 static int MSG_host_get_file_descriptor_id(msg_host_t host)
  23 {
  24   simgrid::MsgHostExt* priv = host->extension<simgrid::MsgHostExt>();
  25   if (priv->file_descriptor_table == nullptr) {
  26     priv->file_descriptor_table = new std::vector<int>(sg_storage_max_file_descriptors);
  27     std::iota(priv->file_descriptor_table->rbegin(), priv->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
  28   }
  29   xbt_assert(not priv->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
  30   int desc = priv->file_descriptor_table->back();
  31   priv->file_descriptor_table->pop_back();
  32   return desc;
  33 }
  34
  35 static void MSG_host_release_file_descriptor_id(msg_host_t host, int id)
  36 {
  37   host->extension<simgrid::MsgHostExt>()->file_descriptor_table->push_back(id);
  38 }
  39
  40 /** \ingroup msg_file
  41  *
  42  * \brief Set the user data of a #msg_file_t.
  43  *
  44  * This functions attach \a data to \a file.
  45  */
  46 msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
  47 {
  48   fd->setUserdata(data);
  49   return MSG_OK;
  50 }
  51
  52 /** \ingroup msg_file
  53  *
  54  * \brief Return the user data of a #msg_file_t.
  55  *
  56  * This functions checks whether \a file is a valid pointer and return the user data associated to \a file if possible.
  57  */
  58 void* MSG_file_get_data(msg_file_t fd)
  59 {
  60   return fd->getUserdata();
  61 }
  62
  63 /** \ingroup msg_file
  64  * \brief Display information related to a file descriptor
  65  *
  66  * \param fd is a the file descriptor
  67  */
  68 void MSG_file_dump (msg_file_t fd){
  69   XBT_INFO("File Descriptor information:\n"
  70            "\t\tFull path: '%s'\n"
  71            "\t\tSize: %llu\n"
  72            "\t\tMount point: '%s'\n"
  73            "\t\tStorage Id: '%s'\n"
  74            "\t\tStorage Type: '%s'\n"
  75            "\t\tFile Descriptor Id: %d",
  76            fd->getPath(), fd->size(), fd->mount_point.c_str(), fd->storageId, fd->storage_type, fd->desc_id);
  77 }
  78
  79 /** \ingroup msg_file
  80  * \brief Read a file (local or remote)
  81  *
  82  * \param size of the file to read
  83  * \param fd is a the file descriptor
  84  * \return the number of bytes successfully read or -1 if an error occurred
  85  */
  86 sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size)
  87 {
  88   sg_size_t read_size;
  89
  90   if (fd->size() == 0) /* Nothing to read, return */
  91     return 0;
  92
  93   /* Find the host where the file is physically located and read it */
  94   msg_storage_t storage_src           = simgrid::s4u::Storage::byName(fd->storageId);
  95   msg_host_t attached_host            = storage_src->getHost();
  96   read_size                           = fd->read(size); // TODO re-add attached_host
  97
  98   if (strcmp(attached_host->getCname(), MSG_host_self()->getCname())) {
  99     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 100     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", attached_host->getCname(), read_size);
 101     msg_host_t m_host_list[] = {MSG_host_self(), attached_host};
 102     double flops_amount[]    = {0, 0};
 103     double bytes_amount[]    = {0, 0, static_cast<double>(read_size), 0};
 104
 105     msg_task_t task = MSG_parallel_task_create("file transfer for read", 2, m_host_list, flops_amount, bytes_amount,
 106                       nullptr);
 107     msg_error_t transfer = MSG_parallel_task_execute(task);
 108     MSG_task_destroy(task);
 109
 110     if(transfer != MSG_OK){
 111       if (transfer == MSG_HOST_FAILURE)
 112         XBT_WARN("Transfer error, %s remote host just turned off!", attached_host->getCname());
 113       if (transfer == MSG_TASK_CANCELED)
 114         XBT_WARN("Transfer error, task has been canceled!");
 115
 116       return -1;
 117     }
 118   }
 119   return read_size;
 120 }
 121
 122 /** \ingroup msg_file
 123  * \brief Write into a file (local or remote)
 124  *
 125  * \param size of the file to write
 126  * \param fd is a the file descriptor
 127  * \return the number of bytes successfully write or -1 if an error occurred
 128  */
 129 sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size)
 130 {
 131   if (size == 0) /* Nothing to write, return */
 132     return 0;
 133
 134   /* Find the host where the file is physically located (remote or local)*/
 135   msg_storage_t storage_src = simgrid::s4u::Storage::byName(fd->storageId);
 136   msg_host_t attached_host  = storage_src->getHost();
 137
 138   if (strcmp(attached_host->getCname(), MSG_host_self()->getCname())) {
 139     /* the file is hosted on a remote host, initiate a communication between src and dest hosts for data transfer */
 140     XBT_DEBUG("File is on %s remote host, initiate data transfer of %llu bytes.", attached_host->getCname(), size);
 141     msg_host_t m_host_list[] = {MSG_host_self(), attached_host};
 142     double flops_amount[]    = {0, 0};
 143     double bytes_amount[]    = {0, static_cast<double>(size), 0, 0};
 144
 145     msg_task_t task = MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount,
 146                                                nullptr);
 147     msg_error_t transfer = MSG_parallel_task_execute(task);
 148     MSG_task_destroy(task);
 149
 150     if(transfer != MSG_OK){
 151       if (transfer == MSG_HOST_FAILURE)
 152         XBT_WARN("Transfer error, %s remote host just turned off!", attached_host->getCname());
 153       if (transfer == MSG_TASK_CANCELED)
 154         XBT_WARN("Transfer error, task has been canceled!");
 155
 156       return -1;
 157     }
 158   }
 159   /* Write file on local or remote host */
 160   // sg_size_t offset     = fd->tell();
 161   sg_size_t write_size = fd->write(size); // TODO readd attached_host
 162
 163   return write_size;
 164 }
 165
 166 /** \ingroup msg_file
 167  * \brief Opens the file whose name is the string pointed to by path
 168  *
 169  * \param fullpath is the file location on the storage
 170  * \param data user data to attach to the file
 171  *
 172  * \return An #msg_file_t associated to the file
 173  */
 174 msg_file_t MSG_file_open(const char* fullpath, void* data)
 175 {
 176   msg_file_t fd         = new simgrid::s4u::File(fullpath, MSG_host_self());
 177   fd->desc_id           = MSG_host_get_file_descriptor_id(MSG_host_self());
 178   return fd;
 179 }
 180
 181 /** \ingroup msg_file
 182  * \brief Close the file
 183  *
 184  * \param fd is the file to close
 185  * \return 0 on success or 1 on error
 186  */
 187 int MSG_file_close(msg_file_t fd)
 188 {
 189   MSG_host_release_file_descriptor_id(MSG_host_self(), fd->desc_id);
 190   delete fd;
 191
 192   return MSG_OK;
 193 }
 194
 195 /** \ingroup msg_file
 196  * \brief Unlink the file pointed by fd
 197  *
 198  * \param fd is the file descriptor (#msg_file_t)
 199  * \return 0 on success or 1 on error
 200  */
 201 msg_error_t MSG_file_unlink(msg_file_t fd)
 202 {
 203   fd->unlink();
 204   delete fd;
 205   return MSG_OK;
 206 }
 207
 208 /** \ingroup msg_file
 209  * \brief Return the size of a file
 210  *
 211  * \param fd is the file descriptor (#msg_file_t)
 212  * \return the size of the file (as a #sg_size_t)
 213  */
 214 sg_size_t MSG_file_get_size(msg_file_t fd)
 215 {
 216   return fd->size();
 217 }
 218
 219 /**
 220  * \ingroup msg_file
 221  * \brief Set the file position indicator in the msg_file_t by adding offset bytes
 222  * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
 223  *
 224  * \param fd : file object that identifies the stream
 225  * \param offset : number of bytes to offset from origin
 226  * \param origin : Position used as reference for the offset. It is specified by one of the following constants defined
 227  *                 in \<stdio.h\> exclusively to be used as arguments for this function (SEEK_SET = beginning of file,
 228  *                 SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
 229  * \return If successful, the function returns MSG_OK (=0). Otherwise, it returns MSG_TASK_CANCELED (=8).
 230  */
 231 msg_error_t MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin)
 232 {
 233   fd->seek(offset, origin);
 234   return MSG_OK;
 235 }
 236
 237 /**
 238  * \ingroup msg_file
 239  * \brief Returns the current value of the position indicator of the file
 240  *
 241  * \param fd : file object that identifies the stream
 242  * \return On success, the current value of the position indicator is returned.
 243  *
 244  */
 245 sg_size_t MSG_file_tell(msg_file_t fd)
 246 {
 247   return fd->tell();
 248 }
 249
 250 const char *MSG_file_get_name(msg_file_t fd) {
 251   xbt_assert((fd != nullptr), "Invalid parameters");
 252   return fd->getPath();
 253 }
 254
 255 /**
 256  * \ingroup msg_file
 257  * \brief Move a file to another location on the *same mount point*.
 258  *
 259  */
 260 msg_error_t MSG_file_move (msg_file_t fd, const char* fullpath)
 261 {
 262   fd->move(fullpath);
 263   return MSG_OK;
 264 }
 265
 266 /**
 267  * \ingroup msg_file
 268  * \brief Copy a file to another location on a remote host.
 269  * \param file : the file to move
 270  * \param host : the remote host where the file has to be copied
 271  * \param fullpath : the complete path destination on the remote host
 272  * \return If successful, the function returns MSG_OK. Otherwise, it returns MSG_TASK_CANCELED.
 273  */
 274 msg_error_t MSG_file_rcopy (msg_file_t file, msg_host_t host, const char* fullpath)
 275 {
 276   /* Find the host where the file is physically located and read it */
 277   msg_storage_t storage_src = simgrid::s4u::Storage::byName(file->storageId);
 278   msg_host_t src_host       = storage_src->getHost();
 279   MSG_file_seek(file, 0, SEEK_SET);
 280   sg_size_t read_size = file->read(file->size());
 281
 282   /* Find the host that owns the storage where the file has to be copied */
 283   msg_storage_t storage_dest = nullptr;
 284   msg_host_t dst_host;
 285   size_t longest_prefix_length = 0;
 286
 287   for (auto elm : host->getMountedStorages()) {
 288     std::string mount_point = std::string(fullpath).substr(0, elm.first.size());
 289     if (mount_point == elm.first && elm.first.length() > longest_prefix_length) {
 290       /* The current mount name is found in the full path and is bigger than the previous*/
 291       longest_prefix_length = elm.first.length();
 292       storage_dest          = elm.second;
 293     }
 294   }
 295
 296   if (storage_dest != nullptr) {
 297     /* Mount point found, retrieve the host the storage is attached to */
 298     dst_host = storage_dest->getHost();
 299   }else{
 300     XBT_WARN("Can't find mount point for '%s' on destination host '%s'", fullpath, host->getCname());
 301     return MSG_TASK_CANCELED;
 302   }
 303
 304   XBT_DEBUG("Initiate data transfer of %llu bytes between %s and %s.", read_size, src_host->getCname(),
 305             storage_dest->getHost()->getCname());
 306   msg_host_t m_host_list[] = {src_host, dst_host};
 307   double flops_amount[]    = {0, 0};
 308   double bytes_amount[]    = {0, static_cast<double>(read_size), 0, 0};
 309
 310   msg_task_t task =
 311       MSG_parallel_task_create("file transfer for write", 2, m_host_list, flops_amount, bytes_amount, nullptr);
 312   msg_error_t err = MSG_parallel_task_execute(task);
 313   MSG_task_destroy(task);
 314
 315   if (err != MSG_OK) {
 316     if (err == MSG_HOST_FAILURE)
 317       XBT_WARN("Transfer error, %s remote host just turned off!", storage_dest->getHost()->getCname());
 318     if (err == MSG_TASK_CANCELED)
 319       XBT_WARN("Transfer error, task has been canceled!");
 320
 321     return err;
 322   }
 323
 324   /* Create file on remote host, write it and close it */
 325   msg_file_t fd = new simgrid::s4u::File(fullpath, dst_host, nullptr);
 326   fd->write(read_size);
 327   delete fd;
 328   return MSG_OK;
 329 }
 330
 331 /**
 332  * \ingroup msg_file
 333  * \brief Move a file to another location on a remote host.
 334  * \param file : the file to move
 335  * \param host : the remote host where the file has to be moved
 336  * \param fullpath : the complete path destination on the remote host
 337  * \return If successful, the function returns MSG_OK. Otherwise, it returns MSG_TASK_CANCELED.
 338  */
 339 msg_error_t MSG_file_rmove (msg_file_t file, msg_host_t host, const char* fullpath)
 340 {
 341   msg_error_t res = MSG_file_rcopy(file, host, fullpath);
 342   MSG_file_unlink(file);
 343   return res;
 344 }
 345
 346 /********************************* Storage **************************************/
 347 /** @addtogroup msg_storage_management
 348  * (#msg_storage_t) and the functions for managing it.
 349  */
 350
 351 /** \ingroup msg_storage_management
 352  *
 353  * \brief Returns the name of the #msg_storage_t.
 354  *
 355  * This functions checks whether a storage is a valid pointer or not and return its name.
 356  */
 357 const char* MSG_storage_get_name(msg_storage_t storage)
 358 {
 359   xbt_assert((storage != nullptr), "Invalid parameters");
 360   return storage->getName();
 361 }
 362
 363 /** \ingroup msg_storage_management
 364  * \brief Returns the free space size of a storage element
 365  * \param storage a storage
 366  * \return the free space size of the storage element (as a #sg_size_t)
 367  */
 368 sg_size_t MSG_storage_get_free_size(msg_storage_t storage)
 369 {
 370   return storage->getSizeFree();
 371 }
 372
 373 /** \ingroup msg_storage_management
 374  * \brief Returns the used space size of a storage element
 375  * \param storage a storage
 376  * \return the used space size of the storage element (as a #sg_size_t)
 377  */
 378 sg_size_t MSG_storage_get_used_size(msg_storage_t storage)
 379 {
 380   return storage->getSizeUsed();
 381 }
 382
 383 /** \ingroup msg_storage_management
 384  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
 385  * \param storage a storage
 386  * \return a dict containing the properties
 387  */
 388 xbt_dict_t MSG_storage_get_properties(msg_storage_t storage)
 389 {
 390   xbt_assert((storage != nullptr), "Invalid parameters (storage is nullptr)");
 391   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 392   std::map<std::string, std::string>* props = storage->getProperties();
 393   if (props == nullptr)
 394     return nullptr;
 395   for (auto elm : *props) {
 396     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 397   }
 398   return as_dict;
 399 }
 400
 401 /** \ingroup msg_storage_management
 402  * \brief Change the value of a given storage property
 403  *
 404  * \param storage a storage
 405  * \param name a property name
 406  * \param value what to change the property to
 407  */
 408 void MSG_storage_set_property_value(msg_storage_t storage, const char* name, char* value)
 409 {
 410   storage->setProperty(name, value);
 411 }
 412
 413 /** \ingroup m_storage_management
 414  * \brief Returns the value of a given storage property
 415  *
 416  * \param storage a storage
 417  * \param name a property name
 418  * \return value of a property (or nullptr if property not set)
 419  */
 420 const char *MSG_storage_get_property_value(msg_storage_t storage, const char *name)
 421 {
 422   return storage->getProperty(name);
 423 }
 424
 425 /** \ingroup msg_storage_management
 426  * \brief Finds a msg_storage_t using its name.
 427  * \param name the name of a storage
 428  * \return the corresponding storage
 429  */
 430 msg_storage_t MSG_storage_get_by_name(const char *name)
 431 {
 432   return simgrid::s4u::Storage::byName(name);
 433 }
 434
 435 /** \ingroup msg_storage_management
 436  * \brief Returns a dynar containing all the storage elements declared at a given point of time
 437  */
 438 xbt_dynar_t MSG_storages_as_dynar()
 439 {
 440   std::map<std::string, simgrid::s4u::Storage*>* storage_map = simgrid::s4u::allStorages();
 441   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),nullptr);
 442   for (auto s : *storage_map)
 443     xbt_dynar_push(res, &(s.second));
 444   delete storage_map;
 445   return res;
 446 }
 447
 448 /** \ingroup msg_storage_management
 449  *
 450  * \brief Set the user data of a #msg_storage_t.
 451  * This functions attach \a data to \a storage if possible.
 452  */
 453 msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
 454 {
 455   storage->setUserdata(data);
 456   return MSG_OK;
 457 }
 458
 459 /** \ingroup m_host_management
 460  *
 461  * \brief Returns the user data of a #msg_storage_t.
 462  *
 463  * This functions checks whether \a storage is a valid pointer and returns its associate user data if possible.
 464  */
 465 void *MSG_storage_get_data(msg_storage_t storage)
 466 {
 467   xbt_assert((storage != nullptr), "Invalid parameters");
 468   return storage->getUserdata();
 469 }
 470
 471 /** \ingroup msg_storage_management
 472  *
 473  * \brief Returns the content (file list) of a #msg_storage_t.
 474  * \param storage a storage
 475  * \return The content of this storage element as a dict (full path file => size)
 476  */
 477 xbt_dict_t MSG_storage_get_content(msg_storage_t storage)
 478 {
 479   std::map<std::string, sg_size_t>* content = storage->getContent();
 480   xbt_dict_t content_as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 481
 482   for (auto entry : *content) {
 483     sg_size_t* psize = static_cast<sg_size_t*>(malloc(sizeof(sg_size_t)));
 484     *psize           = entry.second;
 485     xbt_dict_set(content_as_dict, entry.first.c_str(), psize, nullptr);
 486   }
 487   return content_as_dict;
 488 }
 489
 490 /** \ingroup msg_storage_management
 491  *
 492  * \brief Returns the size of a #msg_storage_t.
 493  * \param storage a storage
 494  * \return The size of the storage
 495  */
 496 sg_size_t MSG_storage_get_size(msg_storage_t storage)
 497 {
 498   return storage->getSize();
 499 }
 500
 501 /** \ingroup msg_storage_management
 502  *
 503  * \brief Returns the host name the storage is attached to
 504  *
 505  * This functions checks whether a storage is a valid pointer or not and return its name.
 506  */
 507 const char* MSG_storage_get_host(msg_storage_t storage)
 508 {
 509   xbt_assert((storage != nullptr), "Invalid parameters");
 510   return storage->getHost()->getCname();
 511 }
 512
 513 SG_END_DECL()