Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix doxygen comments.
[simgrid.git] / src / msg / msg_io.c
index c00fb85..8d9fa63 100644 (file)
-/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012. The SimGrid Team.
- * All rights reserved.                                                                  */
+/* Copyright (c) 2004 - 2013. The SimGrid Team.
+ * All rights reserved.                                                       */
 
 /* This program is free software; you can redistribute it and/or modify it
- * under the terms of the license (GNU LGPL) which comes with this package.              */
+ * under the terms of the license (GNU LGPL) which comes with this package.   */
 
 #include "msg_private.h"
+#include "xbt/log.h"
 
-/** @addtogroup m_file_management
- *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="File" --> \endhtmlonly
- * (#m_file_t) and the functions for managing it.
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg,
+                                "Logging specific to MSG (io)");
+
+/** @addtogroup msg_file_management
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Files" --> \endhtmlonly
+ * (#msg_file_t) and the functions for managing it.
  *
- *  \see #m_file_t
+ *  \see #msg_file_t
  */
 
 /********************************* File **************************************/
+void __MSG_file_get_info(msg_file_t fd){
+  xbt_dynar_t info = simcall_file_get_info(fd->simdata->smx_file);
+  fd->info->content_type = xbt_dynar_pop_as(info, char *);
+  fd->info->storage_type = xbt_dynar_pop_as(info, char *);
+  fd->info->storageId = xbt_dynar_pop_as(info, char *);
+  fd->info->mount_point = xbt_dynar_pop_as(info, char *);
+  fd->info->size = xbt_dynar_pop_as(info, size_t);
+
+  xbt_dynar_free_container(&info);
+}
+
+/** \ingroup msg_file_management
+ *
+ * \brief Set the user data of a #msg_file_t.
+ *
+ * This functions checks whether some data has already been associated to \a file
+   or not and attach \a data to \a file if it is possible.
+ */
+msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
+{
+  SIMIX_file_set_data(fd->simdata->smx_file,data);
+
+  return MSG_OK;
+}
+
+/** \ingroup msg_file_management
+ *
+ * \brief Return the user data of a #msg_file_t.
+ *
+ * This functions checks whether \a file is a valid pointer or not and return
+   the user data associated to \a file if it is possible.
+ */
+void *MSG_file_get_data(msg_file_t fd)
+{
+  return SIMIX_file_get_data(fd->simdata->smx_file);
+}
 
-/** \ingroup m_file_management
- * \brief Read elements of a file
+/** \ingroup msg_file_management
+ * \brief Display information related to a file descriptor
  *
- * \param storage is the name where find the stream
- * \param ptr buffer to where the data is copied
- * \param size of each element
- * \param nmemb is the number of elements of data to read
- * \param stream to read
- * \return the number of items successfully read
+ * \param fd is a the file descriptor
  */
-size_t MSG_file_read(const char* storage, void* ptr, size_t size, size_t nmemb,  m_file_t stream)
+
+void MSG_file_dump (msg_file_t fd){
+//   THROW_UNIMPLEMENTED;
+  /* Update the cached information first */
+  __MSG_file_get_info(fd);
+  XBT_INFO("File Descriptor information:\n\t\tFull name: '%s'"
+      "\n\t\tSize: %zu\n\t\tMount point: '%s'\n\t\tStorage Id: '%s'"
+      "\n\t\tStorage Type: '%s'\n\t\tContent Type: '%s'",
+      fd->fullname, fd->info->size, fd->info->mount_point, fd->info->storageId,
+      fd->info->storage_type, fd->info->content_type);
+}
+
+/** \ingroup msg_file_management
+ * \brief Read a file
+ *
+ * \param size of the file to read
+ * \param fd is a the file descriptor
+ * \return the number of bytes successfully read
+ */
+size_t MSG_file_read(size_t size, msg_file_t fd)
 {
-  return simcall_file_read(storage, ptr, size, nmemb, (m_file_t)stream);
+  return simcall_file_read(size, fd->simdata->smx_file);
 }
 
-/** \ingroup m_file_management
- * \brief Write elements into a file
+/** \ingroup msg_file_management
+ * \brief Write into a file
  *
- * \param storage is the name where find the stream
- * \param ptr buffer from where the data is copied
- * \param size of each element
- * \param nmemb is the number of elements of data to write
- * \param stream to write
- * \return the number of items successfully write
+ * \param size of the file to write
+ * \param fd is a the file descriptor
+ * \return the number of bytes successfully write
  */
-size_t MSG_file_write(const char* storage, const void* ptr, size_t size, size_t nmemb, m_file_t stream)
+size_t MSG_file_write(size_t size, msg_file_t fd)
 {
-  return simcall_file_write(storage, ptr, size, nmemb, (m_file_t)stream);
+  return simcall_file_write(size, fd->simdata->smx_file);
 }
 
-/** \ingroup m_file_management
+/** \ingroup msg_file_management
  * \brief Opens the file whose name is the string pointed to by path
  *
- * \param storage is the name where find the file to open
- * \param path is the file location on the storage
- * \param mode points to a string beginning with one of the following sequences (Additional characters may follow these sequences.):
- *      r      Open text file for reading.  The stream is positioned at the beginning of the file.
- *      r+     Open for reading and writing.  The stream is positioned at the beginning of the file.
- *      w      Truncate file to zero length or create text file for writing.  The stream is positioned at the beginning of the file.
- *      w+     Open for reading and writing.  The file is created if it does not exist, otherwise it is truncated.  The stream is positioned at the beginā€
- *             ning of the file.
- *      a      Open for appending (writing at end of file).  The file is created if it does not exist.  The stream is positioned at the end of the file.
- *      a+     Open for reading and appending (writing at end of file).  The file is created if it does not exist.  The initial file position for  reading
- *             is at the beginning of the file, but output is always appended to the end of the file.
- *
- * \return An #m_file_t associated to the file
- */
-m_file_t MSG_file_open(const char* storage, const char* path, const char* mode)
+ * \param mount is the mount point where find the file is located
+ * \param fullname is the file location on the storage
+ * \param data user data to attach to the file
+ *
+ * \return An #msg_file_t associated to the file
+ */
+msg_file_t MSG_file_open(const char* mount, const char* fullname, void* data)
 {
-  return (m_file_t) simcall_file_open(storage, path, mode);
+  msg_file_t file = xbt_new(s_msg_file_t,1);
+  file->fullname = xbt_strdup(fullname);
+  file->simdata = xbt_new0(s_simdata_file_t,1);
+  file->info = xbt_new0(s_file_info_t,1);
+  file->simdata->smx_file = simcall_file_open(mount, fullname);
+  SIMIX_file_set_data(file->simdata->smx_file, data);
+  return file;
 }
 
-/** \ingroup m_file_management
+/** \ingroup msg_file_management
  * \brief Close the file
  *
- * \param storage is the name where find the stream
- * \param fp is the file to close
+ * \param fd is the file to close
  * \return 0 on success or 1 on error
  */
-int MSG_file_close(const char* storage, m_file_t fp)
+int MSG_file_close(msg_file_t fd)
 {
-  return simcall_file_close(storage, (m_file_t)fp);
+  int res = simcall_file_close(fd->simdata->smx_file);
+  free(fd->fullname);
+  xbt_free(fd->simdata);
+  xbt_free(fd->info);
+  xbt_free(fd);
+  return res;
 }
 
-/** \ingroup m_file_management
- * \brief Stats the file pointed by fd
+/** \ingroup msg_file_management
+ * \brief Unlink the file pointed by fd
  *
- * \param storage is the name where find the stream
- * \param fd is the file descriptor
- * \param buf is the return structure with informations
+ * \param fd is the file descriptor (#msg_file_t)
  * \return 0 on success or 1 on error
  */
-int MSG_file_stat(const char* storage, int fd, void* buf)
+int MSG_file_unlink(msg_file_t fd)
 {
-  return simcall_file_stat(storage, fd, buf);
+  return simcall_file_unlink(fd->simdata->smx_file);
+}
+
+/** \ingroup msg_file_management
+ * \brief Return the size of a file
+ *
+ * \param fd is the file descriptor (#msg_file_t)
+ * \return the size of the file (as a size_t)
+ */
+
+size_t MSG_file_get_size(msg_file_t fd){
+  return simcall_file_get_size(fd->simdata->smx_file);
 }
+
+/** \ingroup msg_file_management
+ * \brief Search for file
+ *
+ * \param mount is the mount point where find the file is located
+ * \param path the file regex to find
+ * \return a xbt_dict_t of file where key is the name of file and the
+ * value the msg_stat_t corresponding to the key
+ */
+xbt_dict_t MSG_file_ls(const char *mount, const char *path)
+{
+  xbt_assert(path,"You must set path");
+  int size = strlen(path);
+  if(size && path[size-1] != '/')
+  {
+    char *new_path = bprintf("%s/",path);
+    XBT_DEBUG("Change '%s' for '%s'",path,new_path);
+    xbt_dict_t dict = simcall_file_ls(mount, new_path);
+    xbt_free(new_path);
+    return dict;
+  }
+
+  return simcall_file_ls(mount, path);
+}
+
+/********************************* Storage **************************************/
+
+/** @addtogroup msg_storage_management
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Storages" --> \endhtmlonly
+ * (#msg_storage_t) and the functions for managing it.
+ *
+ */
+
+
+/* TODO: PV: to comment */
+msg_storage_t __MSG_storage_create(smx_storage_t storage)
+{
+  const char *name = SIMIX_storage_get_name(storage);
+  xbt_lib_set(storage_lib,name,MSG_HOST_LEVEL,storage);
+  return xbt_lib_get_elm_or_null(storage_lib, name);
+}
+
+/*
+ * \brief Destroys a storage (internal call only)
+ */
+void __MSG_storage_destroy(msg_storage_priv_t storage) {
+
+  free(storage);
+}
+
+/** \ingroup msg_storage_management
+ *
+ * \brief Returns the name of the #msg_storage_t.
+ *
+ * This functions checks whether a storage is a valid pointer or not and return its name.
+ */
+const char *MSG_storage_get_name(msg_storage_t storage) {
+  return SIMIX_storage_get_name(storage);
+}
+
+/** \ingroup msg_storage_management
+ * \brief Returns the free space size of a storage element
+ * \param name the name of a storage
+ * \return the free space size of the storage element (as a size_t)
+ */
+size_t MSG_storage_get_free_size(const char* name){
+  return simcall_storage_get_free_size(name);
+}
+
+/** \ingroup msg_storage_management
+ * \brief Returns the used space size of a storage element
+ * \param name the name of a storage
+ * \return the used space size of the storage element (as a size_t)
+ */
+size_t MSG_storage_get_used_size(const char* name){
+  return simcall_storage_get_used_size(name);
+}
+
+/** \ingroup msg_storage_management
+ * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
+ * \param storage a storage
+ * \return a dict containing the properties
+ */
+xbt_dict_t MSG_storage_get_properties(msg_storage_t storage)
+{
+  xbt_assert((storage != NULL), "Invalid parameters (storage is NULL)");
+  return (simcall_storage_get_properties(storage));
+}
+
+/** \ingroup msg_storage_management
+ * \brief Finds a msg_storage_t using its name.
+ * \param name the name of a storage
+ * \return the corresponding storage
+ */
+msg_storage_t MSG_storage_get_by_name(const char *name)
+{
+  return (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,name);
+}
+
+/** \ingroup msg_storage_management
+ * \brief Returns a dynar containing all the storage elements declared at a given point of time
+ *
+ */
+xbt_dynar_t MSG_storages_as_dynar(void) {
+
+  xbt_lib_cursor_t cursor;
+  char *key;
+  void **data;
+  xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),NULL);
+
+  xbt_lib_foreach(storage_lib, cursor, key, data) {
+    if(routing_get_network_element_type(key) == MSG_STORAGE_LEVEL) {
+      xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
+      xbt_dynar_push(res, &elm);
+    }
+  }
+
+  return res;
+}
+
+/** \ingroup msg_storage_management
+ *
+ * \brief Set the user data of a #msg_storage_t.
+ * This functions checks whether some data has already been associated to \a storage
+   or not and attach \a data to \a storage if it is possible.
+ */
+msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
+{
+  SIMIX_storage_set_data(storage,data);
+
+  return MSG_OK;
+}
+
+/** \ingroup msg_host_management
+ *
+ * \brief Returns the user data of a #msg_storage_t.
+ *
+ * This functions checks whether \a storage is a valid pointer or not and return
+   the user data associated to \a storage if it is possible.
+ */
+void *MSG_storage_get_data(msg_storage_t storage)
+{
+  return SIMIX_storage_get_data(storage);
+}
+