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_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);
72 XBT_PUBLIC(void) xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
73 XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar);
76 /** @defgroup XBT_dynar_array Dynar as a regular array
82 XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar,
83 const unsigned long idx,
85 XBT_PUBLIC(void) xbt_dynar_set(xbt_dynar_t dynar, const int idx,
87 XBT_PUBLIC(void) xbt_dynar_replace(xbt_dynar_t dynar,
88 const unsigned long idx,
91 XBT_PUBLIC(void) xbt_dynar_insert_at(xbt_dynar_t const dynar,
92 const int idx, const void *src);
93 XBT_PUBLIC(void) xbt_dynar_remove_at(xbt_dynar_t const dynar,
94 const int idx, void *const dst);
96 XBT_PUBLIC(unsigned int) xbt_dynar_search(xbt_dynar_t const dynar, void *elem);
97 XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
98 XBT_PUBLIC(void) xbt_dynar_sort(xbt_dynar_t const dynar,
99 int_f_cpvoid_cpvoid_t compar_fn);
100 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
101 int_f_pvoid_t color);
102 XBT_PUBLIC(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
103 int(*compar)(const void *, const void *));
104 XBT_PUBLIC(void *) xbt_dynar_to_array (xbt_dynar_t dynar);
107 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
113 XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
114 XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar);
115 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
116 XBT_PUBLIC(void) xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2);
119 /** @defgroup XBT_dynar_perl Perl-like use of dynars
125 XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, const void *src);
126 XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst);
127 XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar,
129 XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst);
130 XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar,
131 void_f_pvoid_t const op);
134 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
137 * Those functions do not retrieve the content, but only their address.
142 XBT_PUBLIC(void *) xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
143 const unsigned long idx);
144 XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar,
145 const unsigned long idx);
146 XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
148 XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
149 XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
152 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
155 * While the other functions use a memcpy to retrieve the content into the
156 * user provided area, those ones use a regular affectation. It only works
157 * for scalar values, but should be a little faster.
162 /** @brief Quick retrieval of scalar content
163 * @hideinitializer */
164 # define xbt_dynar_get_as(dynar,idx,type) \
165 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
166 /** @brief Quick setting of scalar content
167 * @hideinitializer */
168 # define xbt_dynar_set_as(dynar,idx,type,val) \
169 (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val
170 /** @brief Quick retrieval of scalar content
171 * @hideinitializer */
172 # define xbt_dynar_getlast_as(dynar,type) \
173 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
174 /** @brief Quick retrieval of scalar content
175 * @hideinitializer */
176 # define xbt_dynar_getfirst_as(dynar,type) \
177 (*(type*)xbt_dynar_get_ptr((dynar),0))
178 /** @brief Quick insertion of scalar content
179 * @hideinitializer */
180 # define xbt_dynar_insert_at_as(dynar,idx,type,value) \
181 *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
182 /** @brief Quick insertion of scalar content
183 * @hideinitializer */
184 # define xbt_dynar_push_as(dynar,type,value) \
185 *(type*)xbt_dynar_push_ptr(dynar)=value
186 /** @brief Quick removal of scalar content
187 * @hideinitializer */
188 # define xbt_dynar_pop_as(dynar,type) \
189 (*(type*)xbt_dynar_pop_ptr(dynar))
192 /** @defgroup XBT_dynar_cursor Cursors on dynar
195 * Cursors are used to iterate over the structure. Never add elements to the
196 * DynArr during the traversal. To remove elements, use the
197 * xbt_dynar_cursor_rm() function.
199 * Do not call these functions directly, but only the xbt_dynar_foreach macro.
201 * For synchronized dynars, the dynar will be locked during the whole
202 * loop and it will get unlocked automatically if you traverse all
203 * elements. If you want to break the loop before the end, make sure
204 * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
209 XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
210 unsigned int *const cursor);
211 XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
213 /* do not use this structure internals directly, but use the public interface
214 * This was made public to allow:
215 * - the inlining of the foreach elements
216 * - sending such beasts over the network
219 #include "xbt/synchro_core.h"
220 typedef struct xbt_dynar_s {
223 unsigned long elmsize;
225 void_f_pvoid_t free_f;
229 static XBT_INLINE void
230 _xbt_dynar_cursor_first(const xbt_dynar_t dynar,
231 unsigned int *const cursor)
233 /* don't test for dynar!=NULL. The segfault would tell us */
234 if (dynar->mutex) /* ie _dynar_lock(dynar) but not public */
235 xbt_mutex_acquire(dynar->mutex);
237 //XBT_DEBUG("Set cursor on %p to the first position", (void *) dynar);
241 static XBT_INLINE int
242 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
243 unsigned int idx, void *const dst)
246 if (idx >= dynar->used) {
247 //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar);
248 if (dynar->mutex) /* unlock */
249 xbt_mutex_release(dynar->mutex);
252 // XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx);
254 memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize,
262 /** @brief Iterates over the whole dynar.
264 * @param _dynar what to iterate over
265 * @param _cursor an integer used as cursor
269 * \note An example of usage:
274 xbt_dynar_foreach (dyn,cpt,str) {
275 printf("Seen %s\n",str);
279 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
280 for (_xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \
281 _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
287 #endif /* _XBT_DYNAR_H */