Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix doxygen warnings.
[simgrid.git] / src / msg / msg_io.c
index 34bf54f..d0b77c5 100644 (file)
@@ -1,8 +1,8 @@
-/* Copyright (c) 2004 - 2013. The SimGrid Team.
- * All rights reserved.                                                       */
+/* Copyright (c) 2004-2014. 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,7 +11,7 @@ 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
@@ -19,13 +19,18 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg,
 
 /********************************* 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);
 
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  xbt_dynar_t info = simcall_file_get_info(priv->simdata->smx_file);
+  sg_size_t *psize;
+
+  priv->content_type = xbt_dynar_pop_as(info, char *);
+  priv->storage_type = xbt_dynar_pop_as(info, char *);
+  priv->storageId = xbt_dynar_pop_as(info, char *);
+  priv->mount_point = xbt_dynar_pop_as(info, char *);
+  psize = xbt_dynar_pop_as(info, sg_size_t*);
+  priv->size = *psize;
+  xbt_free(psize);
   xbt_dynar_free_container(&info);
 }
 
@@ -38,8 +43,8 @@ void __MSG_file_get_info(msg_file_t fd){
  */
 msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
 {
-  SIMIX_file_set_data(fd->simdata->smx_file,data);
-
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  priv->data = data;
   return MSG_OK;
 }
 
@@ -52,7 +57,8 @@ msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
  */
 void *MSG_file_get_data(msg_file_t fd)
 {
-  return SIMIX_file_get_data(fd->simdata->smx_file);
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  return priv->data;
 }
 
 /** \ingroup msg_file_management
@@ -62,14 +68,20 @@ void *MSG_file_get_data(msg_file_t fd)
  */
 
 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);
+
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  XBT_INFO("File Descriptor information:\n"
+           "\t\tFull name: '%s'\n"
+           "\t\tSize: %llu\n"
+           "\t\tMount point: '%s'\n"
+           "\t\tStorage Id: '%s'\n"
+           "\t\tStorage Type: '%s'\n"
+           "\t\tContent Type: '%s'",
+           priv->fullname, priv->size, priv->mount_point,
+           priv->storageId, priv->storage_type,
+           priv->content_type);
 }
 
 /** \ingroup msg_file_management
@@ -79,9 +91,10 @@ void MSG_file_dump (msg_file_t fd){
  * \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)
+sg_size_t MSG_file_read(msg_file_t fd, sg_size_t size)
 {
-  return simcall_file_read(size, fd->simdata->smx_file);
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  return simcall_file_read(priv->simdata->smx_file, size);
 }
 
 /** \ingroup msg_file_management
@@ -91,9 +104,10 @@ size_t MSG_file_read(size_t size, msg_file_t fd)
  * \param fd is a the file descriptor
  * \return the number of bytes successfully write
  */
-size_t MSG_file_write(size_t size, msg_file_t fd)
+sg_size_t MSG_file_write(msg_file_t fd, sg_size_t size)
 {
-  return simcall_file_write(size, fd->simdata->smx_file);
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  return simcall_file_write(priv->simdata->smx_file, size);
 }
 
 /** \ingroup msg_file_management
@@ -105,16 +119,24 @@ size_t MSG_file_write(size_t size, msg_file_t fd)
  *
  * \return An #msg_file_t associated to the file
  */
-msg_file_t MSG_file_open(const char* mount, const char* fullname, void* data)
+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->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);
+  msg_file_priv_t priv = xbt_new(s_msg_file_priv_t, 1);
+  priv->data = data;
+  priv->fullname = xbt_strdup(fullname);
+  priv->simdata = xbt_new0(s_simdata_file_t,1);
+  priv->simdata->smx_file = simcall_file_open(mount, fullname);
+  xbt_lib_set(file_lib, fullname, MSG_FILE_LEVEL, priv);
+  return (msg_file_t) xbt_lib_get_elm_or_null(file_lib, fullname);
+}
 
-  return file;
+/**
+ * \brief Frees private data of a file (internal call only)
+ */
+void __MSG_file_priv_free(msg_file_priv_t priv)
+{
+  xbt_free(&priv->simdata->smx_file);
+  free(priv);
 }
 
 /** \ingroup msg_file_management
@@ -125,11 +147,9 @@ msg_file_t MSG_file_open(const char* mount, const char* fullname, void* data)
  */
 int MSG_file_close(msg_file_t fd)
 {
-  int res = simcall_file_close(fd->simdata->smx_file);
-  free(fd->fullname);
-  xbt_free(fd->simdata);
-  xbt_free(fd->info);
-  xbt_free(fd);
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  int res = simcall_file_close(priv->simdata->smx_file);
+  xbt_lib_unset(file_lib, priv->fullname, MSG_FILE_LEVEL, 1);
   return res;
 }
 
@@ -141,18 +161,20 @@ int MSG_file_close(msg_file_t fd)
  */
 int MSG_file_unlink(msg_file_t fd)
 {
-  return simcall_file_unlink(fd->simdata->smx_file);
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  int res = simcall_file_unlink(priv->simdata->smx_file);
+  return res;
 }
 
 /** \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)
+ * \return the size of the file (as a #sg_size_t)
  */
-
-size_t MSG_file_get_size(msg_file_t fd){
-  return simcall_file_get_size(fd->simdata->smx_file);
+sg_size_t MSG_file_get_size(msg_file_t fd){
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  return simcall_file_get_size(priv->simdata->smx_file);
 }
 
 /** \ingroup msg_file_management
@@ -179,23 +201,105 @@ xbt_dict_t MSG_file_ls(const char *mount, const char *path)
   return simcall_file_ls(mount, path);
 }
 
+/**
+ * \ingroup msg_file_management
+ * \brief Set the file position indicator in the msg_file_t by adding offset bytes
+ * to the position specified by origin (either SEEK_SET, SEEK_CUR, or SEEK_END).
+ *
+ * \param fd : file object that identifies the stream
+ * \param offset : number of bytes to offset from origin
+ * \param origin : Position used as reference for the offset. It is specified by
+ * one of the following constants defined in \<stdio.h\> exclusively to be used as
+ * arguments for this function (SEEK_SET = beginning of file, SEEK_CUR = current
+ * position of the file pointer, SEEK_END = end of file)
+ *
+ * \return If successful, the function returns MSG_OK (=0). Otherwise, it returns
+ * MSG_TASK_CANCELED (=8).
+ *
+ */
+msg_error_t MSG_file_seek(msg_file_t fd, sg_size_t offset, int origin)
+{
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  return simcall_file_seek(priv->simdata->smx_file, offset, origin);
+}
+
+/**
+ * \ingroup msg_file_management
+ * \brief Returns the current value of the position indicator of the file
+ *
+ * \param fd : file object that identifies the stream
+ * \return On success, the current value of the position indicator is returned.
+ *
+ */
+sg_size_t MSG_file_tell(msg_file_t fd)
+{
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  return simcall_file_tell(priv->simdata->smx_file);
+}
+
+const char *MSG_file_get_name(msg_file_t fd) {
+  xbt_assert((fd != NULL), "Invalid parameters");
+  msg_file_priv_t priv = MSG_file_priv(fd);
+  return priv->fullname;
+}
+
+
+/*
+ * \brief Destroys a file (internal call only)
+ */
+void __MSG_file_destroy(msg_file_priv_t file) {
+  xbt_free(file);
+}
 /********************************* Storage **************************************/
 
+/** @addtogroup msg_storage_management
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Storages" --> \endhtmlonly
+ * (#msg_storage_t) and the functions for managing it.
+ *
+ */
+
+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 Return the free space size of a storage element
- * \param the storage name (#char*)
- * \return the free space size of the storage element (as a size_t)
+ * \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 #sg_size_t)
  */
-size_t MSG_storage_get_free_size(const char* name){
+sg_size_t MSG_storage_get_free_size(const char* name){
   return simcall_storage_get_free_size(name);
 }
 
 /** \ingroup msg_storage_management
- * \brief Return the used space size of a storage element
- * \param the storage name (#char*)
- * \return the used space size of the storage element (as a size_t)
+ * \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 #sg_size_t)
  */
-size_t MSG_storage_get_used_size(const char* name){
+sg_size_t MSG_storage_get_used_size(const char* name){
   return simcall_storage_get_used_size(name);
 }
 
@@ -207,36 +311,113 @@ size_t MSG_storage_get_used_size(const char* name){
 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));
+}
 
-  xbt_die( "Not implemented yet");
-  return xbt_dict_new();
-  //return (simcall_host_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.
+ * \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(host_lib,name);
+  return (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,name);
 }
 
 /** \ingroup msg_storage_management
- * \brief Return a dynar containing all the storages declared at a given point of time
+ * \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(host_lib, cursor, key, data) {
-    if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
+  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
+ * \return The content of this storage element as a dict (full path file => size)
+ */
+xbt_dict_t MSG_storage_get_content(msg_storage_t storage)
+{
+  return SIMIX_storage_get_content(storage);
+}
+
+sg_size_t MSG_storage_get_size(msg_storage_t storage)
+{
+  return SIMIX_storage_get_size(storage);
+}
+
+/**
+ * \ingroup msg_storage_management
+ *
+ * \brief Rename the file in the contents of its associated storage.
+ */
+msg_error_t MSG_storage_file_rename(msg_storage_t storage, const char* src,  const char* dest)
+{
+  simcall_storage_file_rename(storage, src, dest);
+  return MSG_OK;
+}
+
+/**
+ * \ingroup msg_storage_management
+ * \brief Move a file to another location. Depending on the values of dest, dest, mount,
+ * and fullname, this move can be local or remote and, within a host, on the same
+ * mounted disk or between mounted disks.
+ *
+ */
+msg_error_t MSG_storage_file_move (msg_file_t fd, msg_host_t dest, char* mount, char* fullname)
+{
+  THROW_UNIMPLEMENTED;
+  return MSG_OK;
+}