Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix doxygen comments.
[simgrid.git] / 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 void __MSG_file_get_info(msg_file_t fd){
22   xbt_dynar_t info = simcall_file_get_info(fd->simdata->smx_file);
23   fd->info->content_type = xbt_dynar_pop_as(info, char *);
24   fd->info->storage_type = xbt_dynar_pop_as(info, char *);
25   fd->info->storageId = xbt_dynar_pop_as(info, char *);
26   fd->info->mount_point = xbt_dynar_pop_as(info, char *);
27   fd->info->size = xbt_dynar_pop_as(info, size_t);
28
29   xbt_dynar_free_container(&info);
30 }
31
32 /** \ingroup msg_file_management
33  *
34  * \brief Set the user data of a #msg_file_t.
35  *
36  * This functions checks whether some data has already been associated to \a file
37    or not and attach \a data to \a file if it is possible.
38  */
39 msg_error_t MSG_file_set_data(msg_file_t fd, void *data)
40 {
41   SIMIX_file_set_data(fd->simdata->smx_file,data);
42
43   return MSG_OK;
44 }
45
46 /** \ingroup msg_file_management
47  *
48  * \brief Return the user data of a #msg_file_t.
49  *
50  * This functions checks whether \a file is a valid pointer or not and return
51    the user data associated to \a file if it is possible.
52  */
53 void *MSG_file_get_data(msg_file_t fd)
54 {
55   return SIMIX_file_get_data(fd->simdata->smx_file);
56 }
57
58 /** \ingroup msg_file_management
59  * \brief Display information related to a file descriptor
60  *
61  * \param fd is a the file descriptor
62  */
63
64 void MSG_file_dump (msg_file_t fd){
65 //   THROW_UNIMPLEMENTED;
66   /* Update the cached information first */
67   __MSG_file_get_info(fd);
68   XBT_INFO("File Descriptor information:\n\t\tFull name: '%s'"
69       "\n\t\tSize: %zu\n\t\tMount point: '%s'\n\t\tStorage Id: '%s'"
70       "\n\t\tStorage Type: '%s'\n\t\tContent Type: '%s'",
71       fd->fullname, fd->info->size, fd->info->mount_point, fd->info->storageId,
72       fd->info->storage_type, fd->info->content_type);
73 }
74
75 /** \ingroup msg_file_management
76  * \brief Read a file
77  *
78  * \param size of the file to read
79  * \param fd is a the file descriptor
80  * \return the number of bytes successfully read
81  */
82 size_t MSG_file_read(size_t size, msg_file_t fd)
83 {
84   return simcall_file_read(size, fd->simdata->smx_file);
85 }
86
87 /** \ingroup msg_file_management
88  * \brief Write into a file
89  *
90  * \param size of the file to write
91  * \param fd is a the file descriptor
92  * \return the number of bytes successfully write
93  */
94 size_t MSG_file_write(size_t size, msg_file_t fd)
95 {
96   return simcall_file_write(size, fd->simdata->smx_file);
97 }
98
99 /** \ingroup msg_file_management
100  * \brief Opens the file whose name is the string pointed to by path
101  *
102  * \param mount is the mount point where find the file is located
103  * \param fullname is the file location on the storage
104  * \param data user data to attach to the file
105  *
106  * \return An #msg_file_t associated to the file
107  */
108 msg_file_t MSG_file_open(const char* mount, const char* fullname, void* data)
109 {
110   msg_file_t file = xbt_new(s_msg_file_t,1);
111   file->fullname = xbt_strdup(fullname);
112   file->simdata = xbt_new0(s_simdata_file_t,1);
113   file->info = xbt_new0(s_file_info_t,1);
114   file->simdata->smx_file = simcall_file_open(mount, fullname);
115   SIMIX_file_set_data(file->simdata->smx_file, data);
116   return file;
117 }
118
119 /** \ingroup msg_file_management
120  * \brief Close the file
121  *
122  * \param fd is the file to close
123  * \return 0 on success or 1 on error
124  */
125 int MSG_file_close(msg_file_t fd)
126 {
127   int res = simcall_file_close(fd->simdata->smx_file);
128   free(fd->fullname);
129   xbt_free(fd->simdata);
130   xbt_free(fd->info);
131   xbt_free(fd);
132   return res;
133 }
134
135 /** \ingroup msg_file_management
136  * \brief Unlink the file pointed by fd
137  *
138  * \param fd is the file descriptor (#msg_file_t)
139  * \return 0 on success or 1 on error
140  */
141 int MSG_file_unlink(msg_file_t fd)
142 {
143   return simcall_file_unlink(fd->simdata->smx_file);
144 }
145
146 /** \ingroup msg_file_management
147  * \brief Return the size of a file
148  *
149  * \param fd is the file descriptor (#msg_file_t)
150  * \return the size of the file (as a size_t)
151  */
152
153 size_t MSG_file_get_size(msg_file_t fd){
154   return simcall_file_get_size(fd->simdata->smx_file);
155 }
156
157 /** \ingroup msg_file_management
158  * \brief Search for file
159  *
160  * \param mount is the mount point where find the file is located
161  * \param path the file regex to find
162  * \return a xbt_dict_t of file where key is the name of file and the
163  * value the msg_stat_t corresponding to the key
164  */
165 xbt_dict_t MSG_file_ls(const char *mount, const char *path)
166 {
167   xbt_assert(path,"You must set path");
168   int size = strlen(path);
169   if(size && path[size-1] != '/')
170   {
171     char *new_path = bprintf("%s/",path);
172     XBT_DEBUG("Change '%s' for '%s'",path,new_path);
173     xbt_dict_t dict = simcall_file_ls(mount, new_path);
174     xbt_free(new_path);
175     return dict;
176   }
177
178   return simcall_file_ls(mount, path);
179 }
180
181 /********************************* Storage **************************************/
182
183 /** @addtogroup msg_storage_management
184  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Storages" --> \endhtmlonly
185  * (#msg_storage_t) and the functions for managing it.
186  *
187  */
188
189
190 /* TODO: PV: to comment */
191 msg_storage_t __MSG_storage_create(smx_storage_t storage)
192 {
193   const char *name = SIMIX_storage_get_name(storage);
194   xbt_lib_set(storage_lib,name,MSG_HOST_LEVEL,storage);
195   return xbt_lib_get_elm_or_null(storage_lib, name);
196 }
197
198 /*
199  * \brief Destroys a storage (internal call only)
200  */
201 void __MSG_storage_destroy(msg_storage_priv_t storage) {
202
203   free(storage);
204 }
205
206 /** \ingroup msg_storage_management
207  *
208  * \brief Returns the name of the #msg_storage_t.
209  *
210  * This functions checks whether a storage is a valid pointer or not and return its name.
211  */
212 const char *MSG_storage_get_name(msg_storage_t storage) {
213   return SIMIX_storage_get_name(storage);
214 }
215
216 /** \ingroup msg_storage_management
217  * \brief Returns the free space size of a storage element
218  * \param name the name of a storage
219  * \return the free space size of the storage element (as a size_t)
220  */
221 size_t MSG_storage_get_free_size(const char* name){
222   return simcall_storage_get_free_size(name);
223 }
224
225 /** \ingroup msg_storage_management
226  * \brief Returns the used space size of a storage element
227  * \param name the name of a storage
228  * \return the used space size of the storage element (as a size_t)
229  */
230 size_t MSG_storage_get_used_size(const char* name){
231   return simcall_storage_get_used_size(name);
232 }
233
234 /** \ingroup msg_storage_management
235  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
236  * \param storage a storage
237  * \return a dict containing the properties
238  */
239 xbt_dict_t MSG_storage_get_properties(msg_storage_t storage)
240 {
241   xbt_assert((storage != NULL), "Invalid parameters (storage is NULL)");
242   return (simcall_storage_get_properties(storage));
243 }
244
245 /** \ingroup msg_storage_management
246  * \brief Finds a msg_storage_t using its name.
247  * \param name the name of a storage
248  * \return the corresponding storage
249  */
250 msg_storage_t MSG_storage_get_by_name(const char *name)
251 {
252   return (msg_storage_t) xbt_lib_get_elm_or_null(storage_lib,name);
253 }
254
255 /** \ingroup msg_storage_management
256  * \brief Returns a dynar containing all the storage elements declared at a given point of time
257  *
258  */
259 xbt_dynar_t MSG_storages_as_dynar(void) {
260
261   xbt_lib_cursor_t cursor;
262   char *key;
263   void **data;
264   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_storage_t),NULL);
265
266   xbt_lib_foreach(storage_lib, cursor, key, data) {
267     if(routing_get_network_element_type(key) == MSG_STORAGE_LEVEL) {
268       xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
269       xbt_dynar_push(res, &elm);
270     }
271   }
272
273   return res;
274 }
275
276 /** \ingroup msg_storage_management
277  *
278  * \brief Set the user data of a #msg_storage_t.
279  * This functions checks whether some data has already been associated to \a storage
280    or not and attach \a data to \a storage if it is possible.
281  */
282 msg_error_t MSG_storage_set_data(msg_storage_t storage, void *data)
283 {
284   SIMIX_storage_set_data(storage,data);
285
286   return MSG_OK;
287 }
288
289 /** \ingroup msg_host_management
290  *
291  * \brief Returns the user data of a #msg_storage_t.
292  *
293  * This functions checks whether \a storage is a valid pointer or not and return
294    the user data associated to \a storage if it is possible.
295  */
296 void *MSG_storage_get_data(msg_storage_t storage)
297 {
298   return SIMIX_storage_get_data(storage);
299 }
300