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(signed int) xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem);
98 XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
99 XBT_PUBLIC(void) xbt_dynar_sort(xbt_dynar_t const dynar,
100 int_f_cpvoid_cpvoid_t compar_fn);
101 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
102 int_f_pvoid_t color);
103 XBT_PUBLIC(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
104 int(*compar)(const void *, const void *));
105 XBT_PUBLIC(void *) xbt_dynar_to_array (xbt_dynar_t dynar);
108 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
114 XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
115 XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar);
116 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
117 XBT_PUBLIC(void) xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2);
120 /** @defgroup XBT_dynar_perl Perl-like use of dynars
126 XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, const void *src);
127 XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst);
128 XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar,
130 XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst);
131 XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar,
132 void_f_pvoid_t const op);
135 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
138 * Those functions do not retrieve the content, but only their address.
143 XBT_PUBLIC(void *) xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
144 const unsigned long idx);
145 XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar,
146 const unsigned long idx);
147 XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
149 XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
150 XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
153 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
156 * While the other functions use a memcpy to retrieve the content into the
157 * user provided area, those ones use a regular affectation. It only works
158 * for scalar values, but should be a little faster.
163 /** @brief Quick retrieval of scalar content
164 * @hideinitializer */
165 # define xbt_dynar_get_as(dynar,idx,type) \
166 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
167 /** @brief Quick setting of scalar content
168 * @hideinitializer */
169 # define xbt_dynar_set_as(dynar,idx,type,val) \
170 (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val
171 /** @brief Quick retrieval of scalar content
172 * @hideinitializer */
173 # define xbt_dynar_getlast_as(dynar,type) \
174 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
175 /** @brief Quick retrieval of scalar content
176 * @hideinitializer */
177 # define xbt_dynar_getfirst_as(dynar,type) \
178 (*(type*)xbt_dynar_get_ptr((dynar),0))
179 /** @brief Quick insertion of scalar content
180 * @hideinitializer */
181 # define xbt_dynar_insert_at_as(dynar,idx,type,value) \
182 *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
183 /** @brief Quick insertion of scalar content
184 * @hideinitializer */
185 # define xbt_dynar_push_as(dynar,type,value) \
186 *(type*)xbt_dynar_push_ptr(dynar)=value
187 /** @brief Quick removal of scalar content
188 * @hideinitializer */
189 # define xbt_dynar_pop_as(dynar,type) \
190 (*(type*)xbt_dynar_pop_ptr(dynar))
193 /** @defgroup XBT_dynar_cursor Cursors on dynar
196 * Cursors are used to iterate over the structure. Never add elements to the
197 * DynArr during the traversal. To remove elements, use the
198 * xbt_dynar_cursor_rm() function.
200 * Do not call these functions directly, but only the xbt_dynar_foreach macro.
202 * For synchronized dynars, the dynar will be locked during the whole
203 * loop and it will get unlocked automatically if you traverse all
204 * elements. If you want to break the loop before the end, make sure
205 * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
210 XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
211 unsigned int *const cursor);
212 XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
214 /* do not use this structure internals directly, but use the public interface
215 * This was made public to allow:
216 * - the inlining of the foreach elements
217 * - sending such beasts over the network
220 #include "xbt/synchro_core.h"
221 typedef struct xbt_dynar_s {
224 unsigned long elmsize;
226 void_f_pvoid_t free_f;
230 static XBT_INLINE void
231 _xbt_dynar_cursor_first(const xbt_dynar_t dynar,
232 unsigned int *const cursor)
234 /* iterating over a NULL dynar is a no-op (but we don't want to have uninitialized counters) */
235 if (dynar && dynar->mutex) /* ie _dynar_lock(dynar) but not public */
236 xbt_mutex_acquire(dynar->mutex);
238 //XBT_DEBUG("Set cursor on %p to the first position", (void *) dynar);
242 static XBT_INLINE int
243 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
244 unsigned int idx, void *const dst)
246 if (!dynar) /* iterating over a NULL dynar is a no-op */
249 if (idx >= dynar->used) {
250 //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar);
251 if (dynar->mutex) /* unlock */
252 xbt_mutex_release(dynar->mutex);
255 // XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx);
257 memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize,
265 /** @brief Iterates over the whole dynar.
267 * @param _dynar what to iterate over
268 * @param _cursor an integer used as cursor
272 * \note An example of usage:
277 xbt_dynar_foreach (dyn,cpt,str) {
278 printf("Seen %s\n",str);
282 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
283 for (_xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \
284 _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
290 #endif /* _XBT_DYNAR_H */