3 /* a generic DYNamic ARray implementation. */
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "portable.h" /* SIZEOF_MAX */
12 #include "xbt/sysdep.h"
14 #include "xbt/dynar.h"
15 #include <sys/types.h>
17 #include "xbt/dynar_private.h" /* type definition, which we share with the
18 code in charge of sending this across the net */
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(dynar,xbt,"Dynamic arrays");
23 #define __sanity_check_dynar(dynar) \
26 #define __sanity_check_idx(idx) \
27 xbt_assert1(idx >= 0, \
28 "dynar idx(=%d) < 0", \
30 #define __check_inbound_idx(dynar, idx) \
31 xbt_assert2(idx < dynar->used, \
32 "dynar is not that long. You asked %d, but it's only %lu long", \
33 (int) (idx), (unsigned long) dynar->used)
34 #define __check_sloppy_inbound_idx(dynar, idx) \
35 xbt_assert2(idx <= dynar->used, \
36 "dynar is not that long. You asked %d, but it's only %lu long", \
37 (int) (idx), (unsigned long) dynar->used)
38 #define __check_populated_dynar(dynar) \
39 xbt_assert1(dynar->used, \
40 "dynar %p contains nothing",(void*)dynar)
43 void _xbt_clear_mem(void * const ptr,
44 const unsigned long length) {
45 memset(ptr, 0, length);
50 _xbt_dynar_expand(xbt_dynar_t const dynar,
52 const unsigned long old_size = dynar->size;
55 char * const old_data = dynar->data;
57 const unsigned long elmsize = dynar->elmsize;
58 const unsigned long old_length = old_size*elmsize;
60 const unsigned long used = dynar->used;
61 const unsigned long used_length = used*elmsize;
63 const unsigned long new_size = nb > (2*(old_size+1)) ? nb : (2*(old_size+1));
64 const unsigned long new_length = new_size*elmsize;
65 char * const new_data = xbt_malloc0(elmsize*new_size);
67 DEBUG3("expend %p from %lu to %d elements", (void*)dynar, (unsigned long)old_size, nb);
70 memcpy(new_data, old_data, used_length);
71 _xbt_clear_mem(old_data, old_length);
75 _xbt_clear_mem(new_data + used_length, new_length - used_length);
77 dynar->size = new_size;
78 dynar->data = new_data;
84 _xbt_dynar_elm(const xbt_dynar_t dynar,
85 const unsigned long idx) {
86 char * const data = dynar->data;
87 const unsigned long elmsize = dynar->elmsize;
89 return data + idx*elmsize;
94 _xbt_dynar_get_elm(void * const dst,
95 const xbt_dynar_t dynar,
96 const unsigned long idx) {
97 void * const elm = _xbt_dynar_elm(dynar, idx);
98 const unsigned long elmsize = dynar->elmsize;
100 memcpy(dst, elm, elmsize);
105 _xbt_dynar_put_elm(const xbt_dynar_t dynar,
106 const unsigned long idx,
107 const void * const src) {
108 void * const elm = _xbt_dynar_elm(dynar, idx);
109 const unsigned long elmsize = dynar->elmsize;
111 memcpy(elm, src, elmsize);
115 xbt_dynar_dump(xbt_dynar_t dynar) {
116 INFO5("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
117 dynar->size, dynar->used, dynar->elmsize, dynar->data, dynar->free_f);
120 /** @brief Constructor
122 * \param elmsize size of each element in the dynar
123 * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
125 * Creates a new dynar. If a free_func is provided, the elements have to be
126 * pointer of pointer. That is to say that dynars can contain either base
127 * types (int, char, double, etc) or pointer of pointers (struct **).
130 xbt_dynar_new(const unsigned long elmsize,
131 void_f_pvoid_t * const free_f) {
133 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t,1);
137 dynar->elmsize = elmsize;
139 dynar->free_f = free_f;
144 /** @brief Destructor of the structure not touching to the content
146 * \param dynar poor victim
148 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content
149 * is not touched (the \a free_f function is not used)
152 xbt_dynar_free_container(xbt_dynar_t *dynar) {
153 if (dynar && *dynar) {
155 if ((*dynar)->data) {
156 _xbt_clear_mem((*dynar)->data, (*dynar)->size);
157 free((*dynar)->data);
160 _xbt_clear_mem(*dynar, sizeof(s_xbt_dynar_t));
167 /** @brief Frees the content and set the size to 0
169 * \param dynar who to squeeze
172 xbt_dynar_reset(xbt_dynar_t const dynar) {
174 __sanity_check_dynar(dynar);
176 DEBUG1("Reset the dynar %p",(void*)dynar);
178 xbt_dynar_map(dynar, dynar->free_f);
189 /** @brief Destructor
191 * \param dynar poor victim
193 * kilkil a dynar and its content
197 xbt_dynar_free(xbt_dynar_t * dynar) {
198 if (dynar && *dynar) {
199 xbt_dynar_reset(*dynar);
200 xbt_dynar_free_container(dynar);
204 /** @brief Count of dynar's elements
206 * \param dynar the dynar we want to mesure
209 xbt_dynar_length(const xbt_dynar_t dynar) {
210 return (dynar ? (unsigned long) dynar->used : (unsigned long)0);
213 /** @brief Retrieve a copy of the Nth element of a dynar.
215 * \param dynar information dealer
216 * \param idx index of the slot we want to retrive
217 * \param[out] dst where to put the result to.
220 xbt_dynar_get_cpy(const xbt_dynar_t dynar,
224 __sanity_check_dynar(dynar);
225 __sanity_check_idx(idx);
226 __check_inbound_idx(dynar, idx);
228 _xbt_dynar_get_elm(dst, dynar, idx);
231 /** @brief Retrieve a pointer to the Nth element of a dynar.
233 * \param dynar information dealer
234 * \param idx index of the slot we want to retrieve
235 * \return the \a idx-th element of \a dynar.
237 * \warning The returned value is the actual content of the dynar.
238 * Make a copy before fooling with it.
241 xbt_dynar_get_ptr(const xbt_dynar_t dynar,
244 __sanity_check_dynar(dynar);
245 __sanity_check_idx(idx);
246 __check_inbound_idx(dynar, idx);
248 return _xbt_dynar_elm(dynar, idx);
251 /** @brief Set the Nth element of a dynar (expended if needed). Previous value at this position is NOT freed
253 * \param dynar information dealer
254 * \param idx index of the slot we want to modify
255 * \param src What will be feeded to the dynar
257 * If you want to free the previous content, use xbt_dynar_replace().
260 xbt_dynar_set(xbt_dynar_t dynar,
262 const void * const src) {
264 __sanity_check_dynar(dynar);
265 __sanity_check_idx(idx);
267 _xbt_dynar_expand(dynar, idx+1);
269 if (idx >= dynar->used) {
273 _xbt_dynar_put_elm(dynar, idx, src);
276 /** @brief Set the Nth element of a dynar (expended if needed). Previous value is freed
282 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO
283 * free the previous value at this position. If you don't want to free the
284 * previous content, use xbt_dynar_set().
287 xbt_dynar_replace(xbt_dynar_t dynar,
289 const void * const object) {
291 __sanity_check_dynar(dynar);
292 __sanity_check_idx(idx);
294 if (idx < dynar->used && dynar->free_f) {
295 void * const old_object = _xbt_dynar_elm(dynar, idx);
297 dynar->free_f(old_object);
300 xbt_dynar_set(dynar, idx, object);
303 /** @brief Make room for a new element, and return a pointer to it
305 * You can then use regular affectation to set its value instead of relying
306 * on the slow memcpy. This is what xbt_dynar_insert_at_as() does.
309 xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
312 __sanity_check_dynar(dynar);
313 __sanity_check_idx(idx);
314 __check_sloppy_inbound_idx(dynar, idx);
317 const unsigned long old_used = dynar->used;
318 const unsigned long new_used = old_used + 1;
320 _xbt_dynar_expand(dynar, new_used);
323 const unsigned long nb_shift = old_used - idx;
326 memmove(_xbt_dynar_elm(dynar, idx+1),
327 _xbt_dynar_elm(dynar, idx),
328 nb_shift * dynar->elmsize);
331 dynar->used = new_used;
332 return _xbt_dynar_elm(dynar,idx);
336 /** @brief Set the Nth dynar's element, expending the dynar and sliding the previous values to the right
338 * Set the Nth element of a dynar, expanding the dynar if needed, and
339 * moving the previously existing value and all subsequent ones to one
340 * position right in the dynar.
343 xbt_dynar_insert_at(xbt_dynar_t const dynar,
345 const void * const src) {
347 /* checks done in xbt_dynar_insert_at_ptr */
348 memcpy(xbt_dynar_insert_at_ptr(dynar,idx),
353 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
355 * Get the Nth element of a dynar, removing it from the dynar and moving
356 * all subsequent values to one position left in the dynar.
359 xbt_dynar_remove_at(xbt_dynar_t const dynar,
361 void * const object) {
363 unsigned long nb_shift;
364 unsigned long offset;
366 __sanity_check_dynar(dynar);
367 __sanity_check_idx(idx);
368 __check_inbound_idx(dynar, idx);
371 _xbt_dynar_get_elm(object, dynar, idx);
372 } else if (dynar->free_f) {
373 char elm[SIZEOF_MAX];
374 _xbt_dynar_get_elm(elm, dynar, idx);
375 (*dynar->free_f)(elm);
378 nb_shift = dynar->used-1 - idx;
379 offset = nb_shift * dynar->elmsize;
381 memmove(_xbt_dynar_elm(dynar, idx),
382 _xbt_dynar_elm(dynar, idx+1),
388 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
390 * You can then use regular affectation to set its value instead of relying
391 * on the slow memcpy. This is what xbt_dynar_push_as() does.
394 xbt_dynar_push_ptr(xbt_dynar_t const dynar) {
395 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
398 /** @brief Add an element at the end of the dynar */
400 xbt_dynar_push(xbt_dynar_t const dynar,
401 const void * const src) {
402 /* sanity checks done by insert_at */
403 xbt_dynar_insert_at(dynar, dynar->used, src);
406 /** @brief Mark the last dynar's element as unused and return a pointer to it.
408 * You can then use regular affectation to set its value instead of relying
409 * on the slow memcpy. This is what xbt_dynar_pop_as() does.
412 xbt_dynar_pop_ptr(xbt_dynar_t const dynar) {
414 __check_populated_dynar(dynar);
415 DEBUG1("Pop %p",(void*)dynar);
417 return _xbt_dynar_elm(dynar,dynar->used);
420 /** @brief Get and remove the last element of the dynar */
422 xbt_dynar_pop(xbt_dynar_t const dynar,
425 /* sanity checks done by remove_at */
426 DEBUG1("Pop %p",(void*)dynar);
427 xbt_dynar_remove_at(dynar, dynar->used-1, dst);
430 /** @brief Add an element at the begining of the dynar.
432 * This is less efficient than xbt_dynar_push()
435 xbt_dynar_unshift(xbt_dynar_t const dynar,
436 const void * const src) {
438 /* sanity checks done by insert_at */
439 xbt_dynar_insert_at(dynar, 0, src);
442 /** @brief Get and remove the first element of the dynar.
444 * This is less efficient than xbt_dynar_pop()
447 xbt_dynar_shift(xbt_dynar_t const dynar,
450 /* sanity checks done by remove_at */
451 xbt_dynar_remove_at(dynar, 0, dst);
454 /** @brief Apply a function to each member of a dynar
456 * The mapped function may change the value of the element itself,
457 * but should not mess with the structure of the dynar.
460 xbt_dynar_map(const xbt_dynar_t dynar,
461 void_f_pvoid_t * const operator) {
463 __sanity_check_dynar(dynar);
466 char elm[SIZEOF_MAX];
467 const unsigned long used = dynar->used;
470 for (i = 0; i < used; i++) {
471 _xbt_dynar_get_elm(elm, dynar, i);
477 /** @brief Put the cursor at the begining of the dynar.
479 * Actually, the cursor is set one step before the begining, so that you
480 * can iterate over the dynar with a for loop.
483 xbt_dynar_cursor_first(const xbt_dynar_t dynar,
484 int * const cursor) {
486 DEBUG1("Set cursor on %p to the first position",(void*)dynar);
490 /** @brief Move the cursor to the next value */
492 xbt_dynar_cursor_step(const xbt_dynar_t dynar,
493 int * const cursor) {
498 /** @brief Get the data currently pointed by the cursor */
500 xbt_dynar_cursor_get(const xbt_dynar_t dynar,
504 __sanity_check_dynar(dynar);
507 const int idx = *cursor;
509 if (idx >= dynar->used) {
510 DEBUG1("Cursor on %p already on last elem",(void*)dynar);
513 DEBUG2("Cash out cursor on %p at %d",(void*)dynar,idx);
515 _xbt_dynar_get_elm(dst, dynar, idx);
521 /** @brief Removes and free the entry pointed by the cursor
523 * This function can be used while traversing without problem.
525 void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
526 int * const cursor) {
529 if (dynar->elmsize > sizeof(void*)) {
530 DEBUG0("Elements too big to fit into a pointer");
532 dst=xbt_malloc(dynar->elmsize);
533 xbt_dynar_remove_at(dynar,(*cursor)--,dst);
534 (dynar->free_f)(dst);
537 DEBUG0("Ok, we dont care about the element without free function");
538 xbt_dynar_remove_at(dynar,(*cursor)--,NULL);
542 xbt_dynar_remove_at(dynar,(*cursor)--,&dst);
544 (dynar->free_f)(dst);