Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mimic host behavior, works better this way
[simgrid.git] / src / msg / msg_io.c
index 61d6f09..99ac05b 100644 (file)
@@ -1,8 +1,8 @@
-/* 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"
@@ -11,65 +11,108 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg,
                                 "Logging specific to MSG (io)");
 
 /** @addtogroup msg_file_management
- *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Files" --> \endhtmlonly
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Files" --> \endhtmlonly
  * (#msg_file_t) and the functions for managing it.
  *
  *  \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 msg_file_management
+ * \brief Display information related to a file descriptor
+ *
+ * \param fd is a the file descriptor
+ */
+
+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 elements of a file
+ * \brief Read a file
  *
- * \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 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(void* ptr, size_t size, size_t nmemb,  msg_file_t stream)
+size_t MSG_file_read(size_t size, msg_file_t fd)
 {
-  return simcall_file_read(ptr, size, nmemb, stream->simdata->smx_file);
+  return simcall_file_read(size, fd->simdata->smx_file);
 }
 
 /** \ingroup msg_file_management
- * \brief Write elements into a file
+ * \brief Write into a file
  *
- * \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 void* ptr, size_t size, size_t nmemb, msg_file_t stream)
+size_t MSG_file_write(size_t size, msg_file_t fd)
 {
-  return simcall_file_write(ptr, size, nmemb, stream->simdata->smx_file);
+  return simcall_file_write(size, fd->simdata->smx_file);
 }
 
 /** \ingroup msg_file_management
  * \brief Opens the file whose name is the string pointed to by path
  *
  * \param mount is the mount point where find the file is located
- * \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
- *             beginning 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.
+ * \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* path, const char* mode)
+msg_file_t MSG_file_open(const char* mount, const char* fullname, void* data)
 {
   msg_file_t file = xbt_new(s_msg_file_t,1);
-  file->name = strdup(path);
+  file->fullname = xbt_strdup(fullname);
   file->simdata = xbt_new0(s_simdata_file_t,1);
-  file->simdata->smx_file = simcall_file_open(mount, path, mode);
+  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;
 }
 
@@ -82,8 +125,9 @@ msg_file_t MSG_file_open(const char* mount, const char* path, const char* mode)
 int MSG_file_close(msg_file_t fd)
 {
   int res = simcall_file_close(fd->simdata->smx_file);
-  free(fd->name);
+  free(fd->fullname);
   xbt_free(fd->simdata);
+  xbt_free(fd->info);
   xbt_free(fd);
   return res;
 }
@@ -96,11 +140,7 @@ int MSG_file_close(msg_file_t fd)
  */
 int MSG_file_unlink(msg_file_t fd)
 {
-  int res = simcall_file_unlink(fd->simdata->smx_file);
-  free(fd->name);
-  xbt_free(fd->simdata);
-  xbt_free(fd);
-  return res;
+  return simcall_file_unlink(fd->simdata->smx_file);
 }
 
 /** \ingroup msg_file_management
@@ -137,3 +177,147 @@ xbt_dict_t MSG_file_ls(const char *mount, const char *path)
 
   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);
+  msg_storage_priv_t storage_private = xbt_new0(s_msg_storage_priv_t, 1);
+  xbt_lib_set(storage_lib,name,MSG_STORAGE_LEVEL,storage_private);
+  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) {
+  xbt_assert((storage != NULL), "Invalid parameters");
+  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 Change the value of a given storage property
+ *
+ * \param storage a storage
+ * \param name a property name
+ * \param value what to change the property to
+ * \param free_ctn the freeing function to use to kill the value on need
+ */
+void MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn) {
+  xbt_dict_set(MSG_storage_get_properties(storage), name, value,free_ctn);
+}
+
+/** \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 returns
+   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);
+}
+
+/** \ingroup msg_storage_management
+ *
+ * \brief Returns the content (file list) of a #msg_storage_t.
+ * \param storage a storage
+ */
+xbt_dict_t MSG_storage_get_content(msg_storage_t storage)
+{
+       return SIMIX_storage_get_content(storage);
+}