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(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
101 int(*compar)(const void *, const void *));
102 XBT_PUBLIC(void *) xbt_dynar_to_array (xbt_dynar_t dynar);
105 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
111 XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
112 XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar);
113 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
114 XBT_PUBLIC(void) xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2);
117 /** @defgroup XBT_dynar_perl Perl-like use of dynars
123 XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, const void *src);
124 XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst);
125 XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar,
127 XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst);
128 XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar,
129 void_f_pvoid_t const op);
132 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
135 * Those functions do not retrieve the content, but only their address.
140 XBT_PUBLIC(void *) xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
141 const unsigned long idx);
142 XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar,
143 const unsigned long idx);
144 XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
146 XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
147 XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
150 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
153 * While the other functions use a memcpy to retrieve the content into the
154 * user provided area, those ones use a regular affectation. It only works
155 * for scalar values, but should be a little faster.
160 /** @brief Quick retrieval of scalar content
161 * @hideinitializer */
162 # define xbt_dynar_get_as(dynar,idx,type) \
163 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
164 /** @brief Quick setting of scalar content
165 * @hideinitializer */
166 # define xbt_dynar_set_as(dynar,idx,type,val) \
167 (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val
168 /** @brief Quick retrieval of scalar content
169 * @hideinitializer */
170 # define xbt_dynar_getlast_as(dynar,type) \
171 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
172 /** @brief Quick retrieval of scalar content
173 * @hideinitializer */
174 # define xbt_dynar_getfirst_as(dynar,type) \
175 (*(type*)xbt_dynar_get_ptr((dynar),0))
176 /** @brief Quick insertion of scalar content
177 * @hideinitializer */
178 # define xbt_dynar_insert_at_as(dynar,idx,type,value) \
179 *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
180 /** @brief Quick insertion of scalar content
181 * @hideinitializer */
182 # define xbt_dynar_push_as(dynar,type,value) \
183 *(type*)xbt_dynar_push_ptr(dynar)=value
184 /** @brief Quick removal of scalar content
185 * @hideinitializer */
186 # define xbt_dynar_pop_as(dynar,type) \
187 (*(type*)xbt_dynar_pop_ptr(dynar))
190 /** @defgroup XBT_dynar_cursor Cursors on dynar
193 * Cursors are used to iterate over the structure. Never add elements to the
194 * DynArr during the traversal. To remove elements, use the
195 * xbt_dynar_cursor_rm() function.
197 * Do not call these functions directly, but only the xbt_dynar_foreach macro.
199 * For synchronized dynars, the dynar will be locked during the whole
200 * loop and it will get unlocked automatically if you traverse all
201 * elements. If you want to break the loop before the end, make sure
202 * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
207 XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
208 unsigned int *const cursor);
209 XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
211 /* do not use this structure internals directly, but use the public interface
212 * This was made public to allow:
213 * - the inlining of the foreach elements
214 * - sending such beasts over the network
217 #include "xbt/synchro_core.h"
218 typedef struct xbt_dynar_s {
221 unsigned long elmsize;
223 void_f_pvoid_t free_f;
227 static XBT_INLINE void
228 _xbt_dynar_cursor_first(const xbt_dynar_t dynar,
229 unsigned int *const cursor)
231 /* don't test for dynar!=NULL. The segfault would tell us */
232 if (dynar->mutex) /* ie _dynar_lock(dynar) but not public */
233 xbt_mutex_acquire(dynar->mutex);
235 //XBT_DEBUG("Set cursor on %p to the first position", (void *) dynar);
239 static XBT_INLINE int
240 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
241 unsigned int idx, void *const dst)
244 if (idx >= dynar->used) {
245 //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar);
246 if (dynar->mutex) /* unlock */
247 xbt_mutex_release(dynar->mutex);
250 // XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx);
252 memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize,
260 /** @brief Iterates over the whole dynar.
262 * @param _dynar what to iterate over
263 * @param _cursor an integer used as cursor
267 * \note An example of usage:
272 xbt_dynar_foreach (dyn,cpt,str) {
273 printf("Seen %s\n",str);
277 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
278 for (_xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \
279 _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
285 #endif /* _XBT_DYNAR_H */