Logo AND Algorithmique Numérique Distribuée

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