Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Fix cleanup of info->types
[simgrid.git] / src / msg / msg_io.c
index fcb8f76..0037056 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"
@@ -160,7 +160,7 @@ int MSG_file_unlink(msg_file_t fd)
  * \brief Return the size of a file
  *
  * \param fd is the file descriptor (#msg_file_t)
- * \return the size of the file (as a sg_size_t)
+ * \return the size of the file (as a #sg_size_t)
  */
 sg_size_t MSG_file_get_size(msg_file_t fd){
   return simcall_file_get_size(fd->simdata->smx_file);
@@ -191,15 +191,41 @@ xbt_dict_t MSG_file_ls(const char *mount, const char *path)
 }
 
 /*
- * Set the file position indicator in the msg_file_t by adding offset bytes
- * to the position specified by whence (either SEEK_SET, SEEK_CUR, or SEEK_END).
+ * \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 <cstdio> 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 whence)
+msg_error_t MSG_file_seek(msg_file_t fd, sg_size_t offset, int origin)
 {
-  THROW_UNIMPLEMENTED;
-  return MSG_OK;
+  //THROW_UNIMPLEMENTED;
+  return simcall_file_seek(fd->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)
+{
+  return simcall_file_tell(fd->simdata->smx_file);
 }
 
+
 /********************************* Storage **************************************/
 
 /** @addtogroup msg_storage_management
@@ -238,7 +264,7 @@ const char *MSG_storage_get_name(msg_storage_t 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 sg_size_t)
+ * \return the free space size of the storage element (as a #sg_size_t)
  */
 sg_size_t MSG_storage_get_free_size(const char* name){
   return simcall_storage_get_free_size(name);
@@ -247,7 +273,7 @@ sg_size_t MSG_storage_get_free_size(const char* 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 sg_size_t)
+ * \return the used space size of the storage element (as a #sg_size_t)
  */
 sg_size_t MSG_storage_get_used_size(const char* name){
   return simcall_storage_get_used_size(name);
@@ -349,7 +375,9 @@ sg_size_t MSG_storage_get_size(msg_storage_t storage)
 }
 
 /*
- * Rename the file in the contents of its associated 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)
 {
@@ -358,7 +386,8 @@ msg_error_t MSG_storage_file_rename(msg_storage_t storage, const char* src,  con
 }
 
 /*
- * Move a file to another location. Depending on the values of dest, dest, mount,
+ * \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.
  *