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
  22 /** \ingroup msg_file_management
  23  * \brief Read elements of a file
  24  *
  25  * \param ptr buffer to where the data is copied
  26  * \param size of each element
  27  * \param nmemb is the number of elements of data to read
  28  * \param fd is a the file descriptor
  29  * \return the number of items successfully read
  30  */
  31 size_t MSG_file_read(void* ptr, size_t size, size_t nmemb, msg_file_t fd)
  32 {
  33   return simcall_file_read(ptr, size, nmemb, fd->simdata->smx_file);
  34 }
  35
  36 /** \ingroup msg_file_management
  37  * \brief Write elements into a file
  38  *
  39  * \param ptr buffer from where the data is copied
  40  * \param size of each element
  41  * \param nmemb is the number of elements of data to write
  42  * \param fd is a the file descriptor
  43  * \return the number of items successfully write
  44  */
  45 size_t MSG_file_write(const void* ptr, size_t size, size_t nmemb, msg_file_t fd)
  46 {
  47   return simcall_file_write(ptr, size, nmemb, fd->simdata->smx_file);
  48 }
  49
  50 /** \ingroup msg_file_management
  51  * \brief Opens the file whose name is the string pointed to by path
  52  *
  53  * \param mount is the mount point where find the file is located
  54  * \param path is the file location on the storage
  55  *
  56  * \return An #msg_file_t associated to the file
  57  */
  58 msg_file_t MSG_file_open(const char* mount, const char* path)
  59 {
  60   msg_file_t file = xbt_new(s_msg_file_t,1);
  61   file->name = xbt_strdup(path);
  62   file->simdata = xbt_new0(s_simdata_file_t,1);
  63   file->simdata->smx_file = simcall_file_open(mount, path);
  64   return file;
  65 }
  66
  67 /** \ingroup msg_file_management
  68  * \brief Close the file
  69  *
  70  * \param fd is the file to close
  71  * \return 0 on success or 1 on error
  72  */
  73 int MSG_file_close(msg_file_t fd)
  74 {
  75   int res = simcall_file_close(fd->simdata->smx_file);
  76   free(fd->name);
  77   xbt_free(fd->simdata);
  78   xbt_free(fd);
  79   return res;
  80 }
  81
  82 /** \ingroup msg_file_management
  83  * \brief Unlink the file pointed by fd
  84  *
  85  * \param fd is the file descriptor (#msg_file_t)
  86  * \return 0 on success or 1 on error
  87  */
  88 int MSG_file_unlink(msg_file_t fd)
  89 {
  90   return simcall_file_unlink(fd->simdata->smx_file);
  91 }
  92
  93 /** \ingroup msg_file_management
  94  * \brief Return the size of a file
  95  *
  96  * \param fd is the file descriptor (#msg_file_t)
  97  * \return the size of the file (as a size_t)
  98  */
  99
 100 size_t MSG_file_get_size(msg_file_t fd){
 101   return simcall_file_get_size(fd->simdata->smx_file);
 102 }
 103
 104 /** \ingroup msg_file_management
 105  * \brief Search for file
 106  *
 107  * \param mount is the mount point where find the file is located
 108  * \param path the file regex to find
 109  * \return a xbt_dict_t of file where key is the name of file and the
 110  * value the msg_stat_t corresponding to the key
 111  */
 112 xbt_dict_t MSG_file_ls(const char *mount, const char *path)
 113 {
 114   xbt_assert(path,"You must set path");
 115   int size = strlen(path);
 116   if(size && path[size-1] != '/')
 117   {
 118     char *new_path = bprintf("%s/",path);
 119     XBT_DEBUG("Change '%s' for '%s'",path,new_path);
 120     xbt_dict_t dict = simcall_file_ls(mount, new_path);
 121     xbt_free(new_path);
 122     return dict;
 123   }
 124
 125   return simcall_file_ls(mount, path);
 126 }