src/msg/msg_io.c

   1 /* Copyright (c) 2004 - 2013. 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
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg,
  11                                 "Logging specific to MSG (io)");
  12
  13 /** @addtogroup msg_file_management
  14  *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Files" --> \endhtmlonly
  15  * (#msg_file_t) and the functions for managing it.
  16  *
  17  *  \see #msg_file_t
  18  */
  19
  20 /********************************* File **************************************/
  21 void __MSG_file_get_info(msg_file_t fd){
  22   xbt_dynar_t info = simcall_file_get_info(fd->simdata->smx_file);
  23   fd->info->content_type = xbt_dynar_pop_as(info, char *);
  24   fd->info->storage_type = xbt_dynar_pop_as(info, char *);
  25   fd->info->storageId = xbt_dynar_pop_as(info, char *);
  26   fd->info->mount_point = xbt_dynar_pop_as(info, char *);
  27   fd->info->size = xbt_dynar_pop_as(info, size_t);
  28
  29   xbt_dynar_free_container(&info);
  30 }
  31
  32 /** \ingroup msg_file_management
  33  *
  34  * \brief Set the user data of a #msg_file_t.
  35  *
  36  * This functions checks whether some data has already been associated to \a file
  37    or not and attach \a data to \a file if it is possible.
  38  */
  39 msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
  40 {
  41   SIMIX_file_set_data(fd->simdata->smx_file,data);
  42
  43   return MSG_OK;
  44 }
  45
  46 /** \ingroup msg_file_management
  47  *
  48  * \brief Return the user data of a #msg_file_t.
  49  *
  50  * This functions checks whether \a file is a valid pointer or not and return
  51    the user data associated to \a file if it is possible.
  52  */
  53 void *MSG_file_get_data(msg_file_t fd)
  54 {
  55   return SIMIX_file_get_data(fd->simdata->smx_file);
  56 }
  57
  58 /** \ingroup msg_file_management
  59  * \brief Display information related to a file descriptor
  60  *
  61  * \param fd is a the file descriptor
  62  */
  63
  64 void MSG_file_dump (msg_file_t fd){
  65 //   THROW_UNIMPLEMENTED;
  66   /* Update the cached information first */
  67   __MSG_file_get_info(fd);
  68   XBT_INFO("File Descriptor information:\n\t\tFull name: '%s'"
  69       "\n\t\tSize: %zu\n\t\tMount point: '%s'\n\t\tStorage Id: '%s'"
  70       "\n\t\tStorage Type: '%s'\n\t\tContent Type: '%s'",
  71       fd->fullname, fd->info->size, fd->info->mount_point, fd->info->storageId,
  72       fd->info->storage_type, fd->info->content_type);
  73 }
  74
  75 /** \ingroup msg_file_management
  76  * \brief Read a file
  77  *
  78  * \param size of the file to read
  79  * \param fd is a the file descriptor
  80  * \return the number of bytes successfully read
  81  */
  82 size_t MSG_file_read(size_t size, msg_file_t fd)
  83 {
  84   return simcall_file_read(size, fd->simdata->smx_file);
  85 }
  86
  87 /** \ingroup msg_file_management
  88  * \brief Write into a file
  89  *
  90  * \param size of the file to write
  91  * \param fd is a the file descriptor
  92  * \return the number of bytes successfully write
  93  */
  94 size_t MSG_file_write(size_t size, msg_file_t fd)
  95 {
  96   return simcall_file_write(size, fd->simdata->smx_file);
  97 }
  98
  99 /** \ingroup msg_file_management
 100  * \brief Opens the file whose name is the string pointed to by path
 101  *
 102  * \param mount is the mount point where find the file is located
 103  * \param fullname is the file location on the storage
 104  * \param data user data to attach to the file
 105  *
 106  * \return An #msg_file_t associated to the file
 107  */
 108 msg_file_t MSG_file_open(const char* mount, const char* fullname, void* data)
 109 {
 110   msg_file_t file = xbt_new(s_msg_file_t,1);
 111   file->fullname = xbt_strdup(fullname);
 112   file->simdata = xbt_new0(s_simdata_file_t,1);
 113   file->info = xbt_new0(s_file_info_t,1);
 114   file->simdata->smx_file = simcall_file_open(mount, fullname);
 115   SIMIX_file_set_data(file->simdata->smx_file, data);
 116
 117   return file;
 118 }
 119
 120 /** \ingroup msg_file_management
 121  * \brief Close the file
 122  *
 123  * \param fd is the file to close
 124  * \return 0 on success or 1 on error
 125  */
 126 int MSG_file_close(msg_file_t fd)
 127 {
 128   int res = simcall_file_close(fd->simdata->smx_file);
 129   free(fd->fullname);
 130   xbt_free(fd->simdata);
 131   xbt_free(fd->info);
 132   xbt_free(fd);
 133   return res;
 134 }
 135
 136 /** \ingroup msg_file_management
 137  * \brief Unlink the file pointed by fd
 138  *
 139  * \param fd is the file descriptor (#msg_file_t)
 140  * \return 0 on success or 1 on error
 141  */
 142 int MSG_file_unlink(msg_file_t fd)
 143 {
 144   return simcall_file_unlink(fd->simdata->smx_file);
 145 }
 146
 147 /** \ingroup msg_file_management
 148  * \brief Return the size of a file
 149  *
 150  * \param fd is the file descriptor (#msg_file_t)
 151  * \return the size of the file (as a size_t)
 152  */
 153
 154 size_t MSG_file_get_size(msg_file_t fd){
 155   return simcall_file_get_size(fd->simdata->smx_file);
 156 }
 157
 158 /** \ingroup msg_file_management
 159  * \brief Search for file
 160  *
 161  * \param mount is the mount point where find the file is located
 162  * \param path the file regex to find
 163  * \return a xbt_dict_t of file where key is the name of file and the
 164  * value the msg_stat_t corresponding to the key
 165  */
 166 xbt_dict_t MSG_file_ls(const char *mount, const char *path)
 167 {
 168   xbt_assert(path,"You must set path");
 169   int size = strlen(path);
 170   if(size && path[size-1] != '/')
 171   {
 172     char *new_path = bprintf("%s/",path);
 173     XBT_DEBUG("Change '%s' for '%s'",path,new_path);
 174     xbt_dict_t dict = simcall_file_ls(mount, new_path);
 175     xbt_free(new_path);
 176     return dict;
 177   }
 178
 179   return simcall_file_ls(mount, path);
 180 }
 181
 182 /** \ingroup msg_storage_management
 183  * \brief Return the free space size of a storage element
 184  * \param the storage name (#char*)
 185  * \return the free space size of the storage element (as a size_t)
 186  */
 187 size_t MSG_storage_get_free_size(const char* name){
 188   return simcall_storage_get_free_size(name);
 189 }
 190
 191 /** \ingroup msg_storage_management
 192  * \brief Return the used space size of a storage element
 193  * \param the storage name (#char*)
 194  * \return the used space size of the storage element (as a size_t)
 195  */
 196 size_t MSG_storage_get_used_size(const char* name){
 197   return simcall_storage_get_used_size(name);
 198 }