1 /* dynar - a generic dynamic array */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include <string.h> /* memcpy */
14 #include "xbt/misc.h" /* SG_BEGIN_DECL */
15 #include "xbt/function_types.h"
19 /** @addtogroup XBT_dynar
20 * @brief DynArr are dynamically sized vector which may contain any type of variables.
22 * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
24 * For performance concerns, the content of DynArr must be homogeneous (in
25 * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
26 * have to provide the function which will be used to free the content at
27 * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
29 * \section XBT_dynar_exscal Example with scalar
30 * \dontinclude dynar.c
37 * \until end_of_traversal
40 * \until xbt_dynar_free
42 * \section XBT_dynar_exptr Example with pointed data
44 * \skip test_dynar_string
52 * \skip end_of_doxygen
56 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
61 /** \brief Dynar data type (opaque type) */
62 typedef struct xbt_dynar_s *xbt_dynar_t;
65 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new(const unsigned long elm_size,
66 void_f_pvoid_t const free_f);
67 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new_sync(const unsigned long elm_size,
68 void_f_pvoid_t const free_f);
69 XBT_INLINE XBT_PUBLIC(void) xbt_dynar_free(xbt_dynar_t * dynar);
70 XBT_PUBLIC(void) xbt_dynar_free_voidp(void *dynar);
71 XBT_PUBLIC(void) xbt_dynar_free_container(xbt_dynar_t * dynar);
73 XBT_INLINE XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t
75 XBT_INLINE XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar);
76 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
77 XBT_PUBLIC(void) xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
79 XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar);
82 /** @defgroup XBT_dynar_array Dynar as a regular array
88 XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar,
89 const unsigned long idx,
92 XBT_PUBLIC(void) xbt_dynar_set(xbt_dynar_t dynar, const int idx,
94 XBT_PUBLIC(void) xbt_dynar_replace(xbt_dynar_t dynar,
95 const unsigned long idx,
98 XBT_PUBLIC(void) xbt_dynar_insert_at(xbt_dynar_t const dynar,
99 const int idx, const void *src);
100 XBT_PUBLIC(void) xbt_dynar_remove_at(xbt_dynar_t const dynar,
101 const int idx, void *const dst);
103 XBT_PUBLIC(unsigned int) xbt_dynar_search(xbt_dynar_t const dynar,
105 XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
106 XBT_PUBLIC(void) xbt_dynar_sort(xbt_dynar_t const dynar,
107 int_f_cpvoid_cpvoid_t compar_fn);
110 /** @defgroup XBT_dynar_perl Perl-like use of dynars
116 XBT_INLINE XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar,
118 XBT_INLINE XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar,
120 XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar,
122 XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst);
123 XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar,
124 void_f_pvoid_t const op);
127 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
130 * Those functions do not retrieve the content, but only their address.
135 XBT_INLINE XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar,
136 const unsigned long idx);
137 XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
139 XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
140 XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
143 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
146 * While the other functions use a memcpy to retrieve the content into the
147 * user provided area, those ones use a regular affectation. It only works
148 * for scalar values, but should be a little faster.
153 /** @brief Quick retrieval of scalar content
154 * @hideinitializer */
155 # define xbt_dynar_get_as(dynar,idx,type) \
156 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
157 /** @brief Quick retrieval of scalar content
158 * @hideinitializer */
159 # define xbt_dynar_getlast_as(dynar,type) \
160 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
161 /** @brief Quick retrieval of scalar content
162 * @hideinitializer */
163 # define xbt_dynar_getfirst_as(dynar,type) \
164 (*(type*)xbt_dynar_get_ptr((dynar),0))
165 /** @brief Quick insertion of scalar content
166 * @hideinitializer */
167 # define xbt_dynar_insert_at_as(dynar,idx,type,value) \
168 *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
169 /** @brief Quick insertion of scalar content
170 * @hideinitializer */
171 # define xbt_dynar_push_as(dynar,type,value) \
172 *(type*)xbt_dynar_push_ptr(dynar)=value
173 /** @brief Quick removal of scalar content
174 * @hideinitializer */
175 # define xbt_dynar_pop_as(dynar,type) \
176 (*(type*)xbt_dynar_pop_ptr(dynar))
179 /** @defgroup XBT_dynar_cursor Cursors on dynar
182 * Cursors are used to iterate over the structure. Never add elements to the
183 * DynArr during the traversal. To remove elements, use the
184 * xbt_dynar_cursor_rm() function.
186 * Do not call these functions directly, but only the xbt_dynar_foreach macro.
188 * For synchronized dynars, the dynar will be locked during the whole
189 * loop and it will get unlocked automatically if you traverse all
190 * elements. If you want to break the loop before the end, make sure
191 * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
196 XBT_INLINE XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
199 XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
201 /* do not use this structure internals directly, but use the public interface
202 * This was made public to allow:
203 * - the inlining of the foreach elements
204 * - sending such beasts over the network
207 #include "xbt/synchro_core.h"
208 typedef struct xbt_dynar_s {
211 unsigned long elmsize;
213 void_f_pvoid_t free_f;
217 static XBT_INLINE void
218 _xbt_dynar_cursor_first(const xbt_dynar_t dynar,
219 unsigned int *const cursor)
221 /* don't test for dynar!=NULL. The segfault would tell us */
222 if (dynar->mutex) /* ie _dynar_lock(dynar) but not public */
223 xbt_mutex_acquire(dynar->mutex);
225 //DEBUG1("Set cursor on %p to the first position", (void *) dynar);
229 static XBT_INLINE int
230 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
231 unsigned int idx, void *const dst)
234 if (idx >= dynar->used) {
235 //DEBUG1("Cursor on %p already on last elem", (void *) dynar);
236 if (dynar->mutex) /* unlock */
237 xbt_mutex_release(dynar->mutex);
240 // DEBUG2("Cash out cursor on %p at %u", (void *) dynar, *idx);
242 memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize,
250 /** @brief Iterates over the whole dynar.
252 * @param _dynar what to iterate over
253 * @param _cursor an integer used as cursor
257 * \note An example of usage:
262 xbt_dynar_foreach (dyn,cpt,str) {
263 printf("Seen %s\n",str);
267 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
268 for (_xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \
269 _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
275 #endif /* _XBT_DYNAR_H */