1 /* a generic DYNamic ARray implementation. */
3 /* Copyright (c) 2004-2019. 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. */
10 #include "simgrid/Exception.hpp"
14 #include "xbt/string.hpp"
15 #include "xbt/sysdep.h"
16 #include <sys/types.h>
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
20 static inline void _sanity_check_dynar(xbt_dynar_t dynar)
22 xbt_assert(dynar, "dynar is nullptr");
25 static inline void _sanity_check_idx(int idx)
27 xbt_assert(idx >= 0, "dynar idx(=%d) < 0", idx);
30 static inline void _check_inbound_idx(xbt_dynar_t dynar, int idx)
32 if (idx < 0 || idx >= static_cast<int>(dynar->used)) {
33 throw std::out_of_range(simgrid::xbt::string_printf("dynar is not that long. You asked %d, but it's only %lu long",
34 idx, static_cast<unsigned long>(dynar->used)));
38 static inline void _check_populated_dynar(xbt_dynar_t dynar)
40 if (dynar->used == 0) {
41 throw std::out_of_range(simgrid::xbt::string_printf("dynar %p is empty", dynar));
45 static inline void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
47 if (new_size != dynar->size) {
48 dynar->size = new_size;
49 dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
53 static inline void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
55 const unsigned long old_size = dynar->size;
58 const unsigned long expand = 2 * (old_size + 1);
59 _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
60 XBT_DEBUG("expand %p from %lu to %lu elements", dynar, old_size, dynar->size);
64 static inline void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
66 char *const data = (char *) dynar->data;
67 const unsigned long elmsize = dynar->elmsize;
69 return data + idx * elmsize;
72 static inline void _xbt_dynar_get_elm(void *const dst, const xbt_dynar_t dynar, const unsigned long idx)
74 void *const elm = _xbt_dynar_elm(dynar, idx);
76 memcpy(dst, elm, dynar->elmsize);
79 void xbt_dynar_dump(xbt_dynar_t dynar)
81 XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
82 dynar->size, dynar->used, dynar->elmsize, dynar->data, dynar->free_f);
85 /** @brief Constructor
87 * @param elmsize size of each element in the dynar
88 * @param free_f function to call each time we want to get rid of an element (or nullptr if nothing to do).
90 * Creates a new dynar. If a free_func is provided, the elements have to be pointer of pointer. That is to say that
91 * dynars can contain either base types (int, char, double, etc) or pointer of pointers (struct **).
93 xbt_dynar_t xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
95 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
99 dynar->elmsize = elmsize;
100 dynar->data = nullptr;
101 dynar->free_f = free_f;
106 /** @brief Initialize a dynar structure that was not malloc'ed
107 * This can be useful to keep temporary dynars on the stack
109 void xbt_dynar_init(xbt_dynar_t dynar, const unsigned long elmsize, void_f_pvoid_t const free_f)
113 dynar->elmsize = elmsize;
114 dynar->data = nullptr;
115 dynar->free_f = free_f;
118 /** @brief Destroy a dynar that was created with xbt_dynar_init */
119 void xbt_dynar_free_data(xbt_dynar_t dynar)
121 xbt_dynar_reset(dynar);
123 xbt_free(dynar->data);
126 /** @brief Destructor of the structure not touching to the content
128 * @param dynar poor victim
130 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content is not touched (the @a free_f function
133 void xbt_dynar_free_container(xbt_dynar_t* dynar)
135 if (dynar && *dynar) {
136 xbt_dynar_t d = *dynar;
143 /** @brief Frees the content and set the size to 0
145 * @param dynar who to squeeze
147 void xbt_dynar_reset(xbt_dynar_t const dynar)
149 _sanity_check_dynar(dynar);
151 XBT_CDEBUG(xbt_dyn, "Reset the dynar %p", (void *) dynar);
153 xbt_dynar_map(dynar, dynar->free_f);
158 /** @brief Merge dynar d2 into d1
160 * @param d1 dynar to keep
161 * @param d2 dynar to merge into d1. This dynar is free at end.
163 void xbt_dynar_merge(xbt_dynar_t* d1, xbt_dynar_t* d2)
165 if((*d1)->elmsize != (*d2)->elmsize)
166 xbt_die("Element size must are not equal");
168 const unsigned long elmsize = (*d1)->elmsize;
170 void *ptr = _xbt_dynar_elm((*d2), 0);
171 _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
172 void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
174 memcpy(elm, ptr, ((*d2)->size)*elmsize);
175 (*d1)->used += (*d2)->used;
181 * @brief Shrink the dynar by removing empty slots at the end of the internal array
182 * @param dynar a dynar
183 * @param empty_slots_wanted number of empty slots you want to keep at the end of the internal array for further
186 * Reduces the internal array size of the dynar to the number of elements plus @a empty_slots_wanted.
187 * After removing elements from the dynar, you can call this function to make the dynar use less memory.
188 * Set @a empty_slots_wanted to zero to reduce the dynar internal array as much as possible.
189 * Note that if @a empty_slots_wanted is greater than the array size, the internal array is expanded instead of shrunk.
191 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
193 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
196 /** @brief Destructor
198 * @param dynar poor victim
200 * kilkil a dynar and its content
202 void xbt_dynar_free(xbt_dynar_t* dynar)
204 if (dynar && *dynar) {
205 xbt_dynar_reset(*dynar);
206 xbt_dynar_free_container(dynar);
210 /** @brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
211 void xbt_dynar_free_voidp(void* d)
213 xbt_dynar_t dynar = (xbt_dynar_t)d;
214 xbt_dynar_free(&dynar);
217 /** @brief Count of dynar's elements
219 * @param dynar the dynar we want to mesure
221 unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
223 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
226 /**@brief check if a dynar is empty
228 *@param dynar the dynat we want to check
230 int xbt_dynar_is_empty(const xbt_dynar_t dynar)
232 return (xbt_dynar_length(dynar) == 0);
235 /** @brief Retrieve a copy of the Nth element of a dynar.
237 * @param dynar information dealer
238 * @param idx index of the slot we want to retrieve
239 * @param[out] dst where to put the result to.
241 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void* const dst)
243 _sanity_check_dynar(dynar);
244 _check_inbound_idx(dynar, idx);
246 _xbt_dynar_get_elm(dst, dynar, idx);
249 /** @brief Retrieve a pointer to the Nth element of a dynar.
251 * @param dynar information dealer
252 * @param idx index of the slot we want to retrieve
253 * @return the @a idx-th element of @a dynar.
255 * @warning The returned value is the actual content of the dynar.
256 * Make a copy before fooling with it.
258 void* xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx)
261 _sanity_check_dynar(dynar);
262 _check_inbound_idx(dynar, idx);
264 res = _xbt_dynar_elm(dynar, idx);
268 void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx)
270 _sanity_check_dynar(dynar);
272 if (idx >= dynar->used) {
273 _xbt_dynar_expand(dynar, idx + 1);
274 if (idx > dynar->used) {
275 memset(_xbt_dynar_elm(dynar, dynar->used), 0, (idx - dynar->used) * dynar->elmsize);
277 dynar->used = idx + 1;
279 return _xbt_dynar_elm(dynar, idx);
282 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
284 * @param dynar information dealer
285 * @param idx index of the slot we want to modify
286 * @param src What will be feeded to the dynar
288 * If you want to free the previous content, use xbt_dynar_replace().
290 void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void* const src)
292 memcpy(xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
295 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
301 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO free the previous value at this position. If
302 * you don't want to free the previous content, use xbt_dynar_set().
304 void xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void* const object)
306 _sanity_check_dynar(dynar);
308 if (idx < dynar->used && dynar->free_f) {
309 void *const old_object = _xbt_dynar_elm(dynar, idx);
311 dynar->free_f(old_object);
314 xbt_dynar_set(dynar, idx, object);
317 /** @brief Make room for a new element, and return a pointer to it
319 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
320 * xbt_dynar_insert_at_as() does.
322 void* xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
325 unsigned long old_used;
326 unsigned long new_used;
329 _sanity_check_dynar(dynar);
330 _sanity_check_idx(idx);
332 old_used = dynar->used;
333 new_used = old_used + 1;
335 _xbt_dynar_expand(dynar, new_used);
337 nb_shift = old_used - idx;
340 memmove(_xbt_dynar_elm(dynar, idx + 1), _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
343 dynar->used = new_used;
344 res = _xbt_dynar_elm(dynar, idx);
348 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
350 * Set the Nth element of a dynar, expanding the dynar if needed, and moving the previously existing value and all
351 * subsequent ones to one position right in the dynar.
353 void xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void* const src)
355 /* checks done in xbt_dynar_insert_at_ptr */
356 memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
359 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
361 * Get the Nth element of a dynar, removing it from the dynar and moving all subsequent values to one position left in
364 * If the object argument of this function is a non-null pointer, the removed element is copied to this address. If not,
365 * the element is freed using the free_f function passed at dynar creation.
367 void xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void* const object)
369 _sanity_check_dynar(dynar);
370 _check_inbound_idx(dynar, idx);
373 _xbt_dynar_get_elm(object, dynar, idx);
374 } else if (dynar->free_f) {
375 dynar->free_f(_xbt_dynar_elm(dynar, idx));
378 unsigned long nb_shift = dynar->used - 1 - idx;
381 unsigned long offset = nb_shift * dynar->elmsize;
382 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
388 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
390 * This function removes an n-sized slice that starts at element idx. It is equivalent to xbt_dynar_remove_at with a
391 * nullptr object argument if n equals to 1.
393 * Each of the removed elements is freed using the free_f function passed at dynar creation.
395 void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx)
400 _sanity_check_dynar(dynar);
401 _check_inbound_idx(dynar, idx);
402 _check_inbound_idx(dynar, idx + n - 1);
405 for (unsigned long cur = idx; cur < idx + n; cur++) {
406 dynar->free_f(_xbt_dynar_elm(dynar, cur));
410 unsigned long nb_shift = dynar->used - n - idx;
413 unsigned long offset = nb_shift * dynar->elmsize;
414 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n), offset);
420 /** @brief Returns the position of the element in the dynar
422 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function compares the
423 * pointer value, not what's pointed. The only solution to search for a pointed value is then to write the foreach loop
426 * signed int position = -1;
427 * xbt_dynar_foreach(dynar, iter, elem) {
428 * if (not memcmp(elem, searched_element, sizeof(*elem))) {
435 * Raises std::out_of_range if not found. If you have less than 2 millions elements, you probably want to use
436 * #xbt_dynar_search_or_negative() instead, so that you don't have to try/catch on element not found.
438 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void* const elem)
442 for (it = 0; it < dynar->used; it++)
443 if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
447 throw std::out_of_range(simgrid::xbt::string_printf("Element %p not part of dynar %p", elem, dynar));
450 /** @brief Returns the position of the element in the dynar (or -1 if not found)
452 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
453 * what you want. Check the documentation of xbt_dynar_search() for more info.
455 * Note that usually, the dynar indices are unsigned integers. If you have more than 2 million elements in your dynar,
456 * this very function will not work (but the other will).
458 signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void* const elem)
462 for (it = 0; it < dynar->used; it++)
463 if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
470 /** @brief Returns a boolean indicating whether the element is part of the dynar
472 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
473 * what you want. Check the documentation of xbt_dynar_search() for more info.
475 int xbt_dynar_member(xbt_dynar_t const dynar, void* const elem)
479 for (it = 0; it < dynar->used; it++)
480 if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
487 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
489 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
490 * xbt_dynar_push_as() does.
492 void* xbt_dynar_push_ptr(xbt_dynar_t const dynar)
494 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
497 /** @brief Add an element at the end of the dynar */
498 void xbt_dynar_push(xbt_dynar_t const dynar, const void* const src)
500 /* checks done in xbt_dynar_insert_at_ptr */
501 memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
504 /** @brief Mark the last dynar's element as unused and return a pointer to it.
506 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
507 * xbt_dynar_pop_as() does.
509 void* xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
511 _check_populated_dynar(dynar);
512 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
514 return _xbt_dynar_elm(dynar, dynar->used);
517 /** @brief Get and remove the last element of the dynar */
518 void xbt_dynar_pop(xbt_dynar_t const dynar, void* const dst)
520 /* sanity checks done by remove_at */
521 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
522 xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
525 /** @brief Add an element at the begining of the dynar.
527 * This is less efficient than xbt_dynar_push()
529 void xbt_dynar_unshift(xbt_dynar_t const dynar, const void* const src)
531 /* sanity checks done by insert_at */
532 xbt_dynar_insert_at(dynar, 0, src);
535 /** @brief Get and remove the first element of the dynar.
537 * This is less efficient than xbt_dynar_pop()
539 void xbt_dynar_shift(xbt_dynar_t const dynar, void* const dst)
541 /* sanity checks done by remove_at */
542 xbt_dynar_remove_at(dynar, 0, dst);
545 /** @brief Apply a function to each member of a dynar
547 * The mapped function may change the value of the element itself, but should not mess with the structure of the dynar.
549 void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
551 char *const data = (char *) dynar->data;
552 const unsigned long elmsize = dynar->elmsize;
553 const unsigned long used = dynar->used;
556 _sanity_check_dynar(dynar);
558 for (i = 0; i < used; i++) {
559 char* elm = (char*) data + i * elmsize;
564 /** @brief Removes and free the entry pointed by the cursor
566 * This function can be used while traversing without problem.
568 void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* const cursor)
570 xbt_dynar_remove_at(dynar, *cursor, nullptr);
574 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
576 * This function simply apply the classical qsort(3) function to the data stored in the dynar.
577 * You should thus refer to the libc documentation, or to some online tutorial on how to write
578 * a comparison function. Here is a quick example if you have integers in your dynar:
581 * int cmpfunc (const void * a, const void * b) {
582 * int intA = *(int*)a;
583 * int intB = *(int*)b;
584 * return intA - intB;
588 * and now to sort a dynar of MSG hosts depending on their speed:
590 * int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
591 * MSG_host_t hostA = *(MSG_host_t*)a;
592 * MSG_host_t hostB = *(MSG_host_t*)b;
593 * return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
597 * @param dynar the dynar to sort
598 * @param compar_fn comparison function of type (int (compar_fn*) (const void*) (const void*)).
600 void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn)
602 if (dynar->data != nullptr)
603 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
606 /** @brief Transform a dynar into a nullptr terminated array.
608 * @param dynar the dynar to transform
609 * @return pointer to the first element of the array
611 * Note: The dynar won't be usable afterwards.
613 void* xbt_dynar_to_array(xbt_dynar_t dynar)
616 xbt_dynar_shrink(dynar, 1);
617 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
623 /** @brief Compare two dynars
625 * @param d1 first dynar to compare
626 * @param d2 second dynar to compare
627 * @param compar function to use to compare elements
628 * @return 0 if d1 and d2 are equal and 1 if not equal
630 * d1 and d2 should be dynars of pointers. The compar function takes two elements and returns 0 when they are
631 * considered equal, and a value different of zero when they are considered different. Finally, d2 is destroyed
634 int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int (*compar)(const void*, const void*))
638 if ((not d1) && (not d2))
640 if ((not d1) || (not d2)) {
641 XBT_DEBUG("nullptr dynar d1=%p d2=%p",d1,d2);
645 if((d1->elmsize)!=(d2->elmsize)) {
646 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
650 if(xbt_dynar_length(d1) != xbt_dynar_length(d2)) {
651 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
656 size = xbt_dynar_length(d1);
657 for(i=0;i<size;i++) {
658 void *data1 = xbt_dynar_get_as(d1, i, void *);
659 void *data2 = xbt_dynar_get_as(d2, i, void *);
660 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
661 if(compar(data1,data2)){