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/sysdep.h"
15 #include <sys/types.h>
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dyn, xbt, "Dynamic arrays");
19 static inline void _sanity_check_dynar(xbt_dynar_t dynar)
21 xbt_assert(dynar, "dynar is nullptr");
24 static inline void _sanity_check_idx(int idx)
26 xbt_assert(idx >= 0, "dynar idx(=%d) < 0", idx);
29 static inline void _check_inbound_idx(xbt_dynar_t dynar, int idx)
31 if (idx < 0 || idx >= static_cast<int>(dynar->used)) {
32 THROWF(bound_error, idx, "dynar is not that long. You asked %d, but it's only %lu long",
33 idx, static_cast<unsigned long>(dynar->used));
37 static inline void _check_populated_dynar(xbt_dynar_t dynar)
39 if (dynar->used == 0) {
40 THROWF(bound_error, 0, "dynar %p is empty", dynar);
44 static inline void _xbt_dynar_resize(xbt_dynar_t dynar, unsigned long new_size)
46 if (new_size != dynar->size) {
47 dynar->size = new_size;
48 dynar->data = xbt_realloc(dynar->data, new_size * dynar->elmsize);
52 static inline void _xbt_dynar_expand(xbt_dynar_t const dynar, const unsigned long nb)
54 const unsigned long old_size = dynar->size;
57 const unsigned long expand = 2 * (old_size + 1);
58 _xbt_dynar_resize(dynar, (nb > expand ? nb : expand));
59 XBT_DEBUG("expand %p from %lu to %lu elements", dynar, old_size, dynar->size);
63 static inline void *_xbt_dynar_elm(const xbt_dynar_t dynar, const unsigned long idx)
65 char *const data = (char *) dynar->data;
66 const unsigned long elmsize = dynar->elmsize;
68 return data + idx * elmsize;
71 static inline void _xbt_dynar_get_elm(void *const dst, const xbt_dynar_t dynar, const unsigned long idx)
73 void *const elm = _xbt_dynar_elm(dynar, idx);
75 memcpy(dst, elm, dynar->elmsize);
78 void xbt_dynar_dump(xbt_dynar_t dynar)
80 XBT_INFO("Dynar dump: size=%lu; used=%lu; elmsize=%lu; data=%p; free_f=%p",
81 dynar->size, dynar->used, dynar->elmsize, dynar->data, dynar->free_f);
84 /** @brief Constructor
86 * @param elmsize size of each element in the dynar
87 * @param free_f function to call each time we want to get rid of an element (or nullptr if nothing to do).
89 * Creates a new dynar. If a free_func is provided, the elements have to be pointer of pointer. That is to say that
90 * dynars can contain either base types (int, char, double, etc) or pointer of pointers (struct **).
92 xbt_dynar_t xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t const free_f)
94 xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
98 dynar->elmsize = elmsize;
99 dynar->data = nullptr;
100 dynar->free_f = free_f;
105 /** @brief Initialize a dynar structure that was not malloc'ed
106 * This can be useful to keep temporary dynars on the stack
108 void xbt_dynar_init(xbt_dynar_t dynar, const unsigned long elmsize, void_f_pvoid_t const free_f)
112 dynar->elmsize = elmsize;
113 dynar->data = nullptr;
114 dynar->free_f = free_f;
117 /** @brief Destroy a dynar that was created with xbt_dynar_init */
118 void xbt_dynar_free_data(xbt_dynar_t dynar)
120 xbt_dynar_reset(dynar);
122 xbt_free(dynar->data);
125 /** @brief Destructor of the structure not touching to the content
127 * @param dynar poor victim
129 * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content is not touched (the @a free_f function
132 void xbt_dynar_free_container(xbt_dynar_t* dynar)
134 if (dynar && *dynar) {
135 xbt_dynar_t d = *dynar;
142 /** @brief Frees the content and set the size to 0
144 * @param dynar who to squeeze
146 void xbt_dynar_reset(xbt_dynar_t const dynar)
148 _sanity_check_dynar(dynar);
150 XBT_CDEBUG(xbt_dyn, "Reset the dynar %p", (void *) dynar);
152 xbt_dynar_map(dynar, dynar->free_f);
157 /** @brief Merge dynar d2 into d1
159 * @param d1 dynar to keep
160 * @param d2 dynar to merge into d1. This dynar is free at end.
162 void xbt_dynar_merge(xbt_dynar_t* d1, xbt_dynar_t* d2)
164 if((*d1)->elmsize != (*d2)->elmsize)
165 xbt_die("Element size must are not equal");
167 const unsigned long elmsize = (*d1)->elmsize;
169 void *ptr = _xbt_dynar_elm((*d2), 0);
170 _xbt_dynar_resize(*d1, (*d1)->size + (*d2)->size);
171 void *elm = _xbt_dynar_elm((*d1), (*d1)->used);
173 memcpy(elm, ptr, ((*d2)->size)*elmsize);
174 (*d1)->used += (*d2)->used;
180 * @brief Shrink the dynar by removing empty slots at the end of the internal array
181 * @param dynar a dynar
182 * @param empty_slots_wanted number of empty slots you want to keep at the end of the internal array for further
185 * Reduces the internal array size of the dynar to the number of elements plus @a empty_slots_wanted.
186 * After removing elements from the dynar, you can call this function to make the dynar use less memory.
187 * Set @a empty_slots_wanted to zero to reduce the dynar internal array as much as possible.
188 * Note that if @a empty_slots_wanted is greater than the array size, the internal array is expanded instead of shrunk.
190 void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
192 _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
195 /** @brief Destructor
197 * @param dynar poor victim
199 * kilkil a dynar and its content
201 void xbt_dynar_free(xbt_dynar_t* dynar)
203 if (dynar && *dynar) {
204 xbt_dynar_reset(*dynar);
205 xbt_dynar_free_container(dynar);
209 /** @brief free a dynar passed as void* (handy to store dynar in dynars or dict) */
210 void xbt_dynar_free_voidp(void* d)
212 xbt_dynar_t dynar = (xbt_dynar_t)d;
213 xbt_dynar_free(&dynar);
216 /** @brief Count of dynar's elements
218 * @param dynar the dynar we want to mesure
220 unsigned long xbt_dynar_length(const xbt_dynar_t dynar)
222 return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
225 /**@brief check if a dynar is empty
227 *@param dynar the dynat we want to check
229 int xbt_dynar_is_empty(const xbt_dynar_t dynar)
231 return (xbt_dynar_length(dynar) == 0);
234 /** @brief Retrieve a copy of the Nth element of a dynar.
236 * @param dynar information dealer
237 * @param idx index of the slot we want to retrieve
238 * @param[out] dst where to put the result to.
240 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void* const dst)
242 _sanity_check_dynar(dynar);
243 _check_inbound_idx(dynar, idx);
245 _xbt_dynar_get_elm(dst, dynar, idx);
248 /** @brief Retrieve a pointer to the Nth element of a dynar.
250 * @param dynar information dealer
251 * @param idx index of the slot we want to retrieve
252 * @return the @a idx-th element of @a dynar.
254 * @warning The returned value is the actual content of the dynar.
255 * Make a copy before fooling with it.
257 void* xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx)
260 _sanity_check_dynar(dynar);
261 _check_inbound_idx(dynar, idx);
263 res = _xbt_dynar_elm(dynar, idx);
267 void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx)
269 _sanity_check_dynar(dynar);
271 if (idx >= dynar->used) {
272 _xbt_dynar_expand(dynar, idx + 1);
273 if (idx > dynar->used) {
274 memset(_xbt_dynar_elm(dynar, dynar->used), 0, (idx - dynar->used) * dynar->elmsize);
276 dynar->used = idx + 1;
278 return _xbt_dynar_elm(dynar, idx);
281 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value at this position is NOT freed
283 * @param dynar information dealer
284 * @param idx index of the slot we want to modify
285 * @param src What will be feeded to the dynar
287 * If you want to free the previous content, use xbt_dynar_replace().
289 void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void* const src)
291 memcpy(xbt_dynar_set_at_ptr(dynar, idx), src, dynar->elmsize);
294 /** @brief Set the Nth element of a dynar (expanded if needed). Previous value is freed
300 * Set the Nth element of a dynar, expanding the dynar if needed, AND DO free the previous value at this position. If
301 * you don't want to free the previous content, use xbt_dynar_set().
303 void xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void* const object)
305 _sanity_check_dynar(dynar);
307 if (idx < dynar->used && dynar->free_f) {
308 void *const old_object = _xbt_dynar_elm(dynar, idx);
310 dynar->free_f(old_object);
313 xbt_dynar_set(dynar, idx, object);
316 /** @brief Make room for a new element, and return a pointer to it
318 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
319 * xbt_dynar_insert_at_as() does.
321 void* xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx)
324 unsigned long old_used;
325 unsigned long new_used;
328 _sanity_check_dynar(dynar);
329 _sanity_check_idx(idx);
331 old_used = dynar->used;
332 new_used = old_used + 1;
334 _xbt_dynar_expand(dynar, new_used);
336 nb_shift = old_used - idx;
339 memmove(_xbt_dynar_elm(dynar, idx + 1), _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
342 dynar->used = new_used;
343 res = _xbt_dynar_elm(dynar, idx);
347 /** @brief Set the Nth dynar's element, expanding the dynar and sliding the previous values to the right
349 * Set the Nth element of a dynar, expanding the dynar if needed, and moving the previously existing value and all
350 * subsequent ones to one position right in the dynar.
352 void xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void* const src)
354 /* checks done in xbt_dynar_insert_at_ptr */
355 memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
358 /** @brief Remove the Nth dynar's element, sliding the previous values to the left
360 * Get the Nth element of a dynar, removing it from the dynar and moving all subsequent values to one position left in
363 * If the object argument of this function is a non-null pointer, the removed element is copied to this address. If not,
364 * the element is freed using the free_f function passed at dynar creation.
366 void xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void* const object)
368 _sanity_check_dynar(dynar);
369 _check_inbound_idx(dynar, idx);
372 _xbt_dynar_get_elm(object, dynar, idx);
373 } else if (dynar->free_f) {
374 dynar->free_f(_xbt_dynar_elm(dynar, idx));
377 unsigned long nb_shift = dynar->used - 1 - idx;
380 unsigned long offset = nb_shift * dynar->elmsize;
381 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + 1), offset);
387 /** @brief Remove a slice of the dynar, sliding the rest of the values to the left
389 * This function removes an n-sized slice that starts at element idx. It is equivalent to xbt_dynar_remove_at with a
390 * nullptr object argument if n equals to 1.
392 * Each of the removed elements is freed using the free_f function passed at dynar creation.
394 void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx)
399 _sanity_check_dynar(dynar);
400 _check_inbound_idx(dynar, idx);
401 _check_inbound_idx(dynar, idx + n - 1);
404 for (unsigned long cur = idx; cur < idx + n; cur++) {
405 dynar->free_f(_xbt_dynar_elm(dynar, cur));
409 unsigned long nb_shift = dynar->used - n - idx;
412 unsigned long offset = nb_shift * dynar->elmsize;
413 memmove(_xbt_dynar_elm(dynar, idx), _xbt_dynar_elm(dynar, idx + n), offset);
419 /** @brief Returns the position of the element in the dynar
421 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function compares the
422 * pointer value, not what's pointed. The only solution to search for a pointed value is then to write the foreach loop
425 * signed int position = -1;
426 * xbt_dynar_foreach(dynar, iter, elem) {
427 * if (not memcmp(elem, searched_element, sizeof(*elem))) {
434 * Raises not_found_error if not found. If you have less than 2 millions elements, you probably want to use
435 * #xbt_dynar_search_or_negative() instead, so that you don't have to TRY/CATCH on element not found.
437 unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void* const elem)
441 for (it = 0; it < dynar->used; it++)
442 if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
446 THROWF(not_found_error, 0, "Element %p not part of dynar %p", elem, dynar);
449 /** @brief Returns the position of the element in the dynar (or -1 if not found)
451 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
452 * what you want. Check the documentation of xbt_dynar_search() for more info.
454 * Note that usually, the dynar indices are unsigned integers. If you have more than 2 million elements in your dynar,
455 * this very function will not work (but the other will).
457 signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void* const elem)
461 for (it = 0; it < dynar->used; it++)
462 if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
469 /** @brief Returns a boolean indicating whether the element is part of the dynar
471 * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
472 * what you want. Check the documentation of xbt_dynar_search() for more info.
474 int xbt_dynar_member(xbt_dynar_t const dynar, void* const elem)
478 for (it = 0; it < dynar->used; it++)
479 if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
486 /** @brief Make room at the end of the dynar for a new element, and return a pointer to it.
488 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
489 * xbt_dynar_push_as() does.
491 void* xbt_dynar_push_ptr(xbt_dynar_t const dynar)
493 return xbt_dynar_insert_at_ptr(dynar, dynar->used);
496 /** @brief Add an element at the end of the dynar */
497 void xbt_dynar_push(xbt_dynar_t const dynar, const void* const src)
499 /* checks done in xbt_dynar_insert_at_ptr */
500 memcpy(xbt_dynar_insert_at_ptr(dynar, dynar->used), src, dynar->elmsize);
503 /** @brief Mark the last dynar's element as unused and return a pointer to it.
505 * You can then use regular affectation to set its value instead of relying on the slow memcpy. This is what
506 * xbt_dynar_pop_as() does.
508 void* xbt_dynar_pop_ptr(xbt_dynar_t const dynar)
510 _check_populated_dynar(dynar);
511 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
513 return _xbt_dynar_elm(dynar, dynar->used);
516 /** @brief Get and remove the last element of the dynar */
517 void xbt_dynar_pop(xbt_dynar_t const dynar, void* const dst)
519 /* sanity checks done by remove_at */
520 XBT_CDEBUG(xbt_dyn, "Pop %p", (void *) dynar);
521 xbt_dynar_remove_at(dynar, dynar->used - 1, dst);
524 /** @brief Add an element at the begining of the dynar.
526 * This is less efficient than xbt_dynar_push()
528 void xbt_dynar_unshift(xbt_dynar_t const dynar, const void* const src)
530 /* sanity checks done by insert_at */
531 xbt_dynar_insert_at(dynar, 0, src);
534 /** @brief Get and remove the first element of the dynar.
536 * This is less efficient than xbt_dynar_pop()
538 void xbt_dynar_shift(xbt_dynar_t const dynar, void* const dst)
540 /* sanity checks done by remove_at */
541 xbt_dynar_remove_at(dynar, 0, dst);
544 /** @brief Apply a function to each member of a dynar
546 * The mapped function may change the value of the element itself, but should not mess with the structure of the dynar.
548 void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op)
550 char *const data = (char *) dynar->data;
551 const unsigned long elmsize = dynar->elmsize;
552 const unsigned long used = dynar->used;
555 _sanity_check_dynar(dynar);
557 for (i = 0; i < used; i++) {
558 char* elm = (char*) data + i * elmsize;
563 /** @brief Removes and free the entry pointed by the cursor
565 * This function can be used while traversing without problem.
567 void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* const cursor)
569 xbt_dynar_remove_at(dynar, *cursor, nullptr);
573 /** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
575 * This function simply apply the classical qsort(3) function to the data stored in the dynar.
576 * You should thus refer to the libc documentation, or to some online tutorial on how to write
577 * a comparison function. Here is a quick example if you have integers in your dynar:
580 * int cmpfunc (const void * a, const void * b) {
581 * int intA = *(int*)a;
582 * int intB = *(int*)b;
583 * return intA - intB;
587 * and now to sort a dynar of MSG hosts depending on their speed:
589 * int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
590 * MSG_host_t hostA = *(MSG_host_t*)a;
591 * MSG_host_t hostB = *(MSG_host_t*)b;
592 * return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
596 * @param dynar the dynar to sort
597 * @param compar_fn comparison function of type (int (compar_fn*) (const void*) (const void*)).
599 void xbt_dynar_sort(xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn)
601 if (dynar->data != nullptr)
602 qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
605 static int strcmp_voidp(const void *pa, const void *pb) {
606 return strcmp(*(const char **)pa, *(const char **)pb);
609 /** @brief Sorts a dynar of strings (ie, char* data) */
610 xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar)
612 xbt_dynar_sort(dynar, strcmp_voidp);
613 return dynar; // to enable functional uses
616 /** @brief Transform a dynar into a nullptr terminated array.
618 * @param dynar the dynar to transform
619 * @return pointer to the first element of the array
621 * Note: The dynar won't be usable afterwards.
623 void* xbt_dynar_to_array(xbt_dynar_t dynar)
626 xbt_dynar_shrink(dynar, 1);
627 memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
633 /** @brief Compare two dynars
635 * @param d1 first dynar to compare
636 * @param d2 second dynar to compare
637 * @param compar function to use to compare elements
638 * @return 0 if d1 and d2 are equal and 1 if not equal
640 * d1 and d2 should be dynars of pointers. The compar function takes two elements and returns 0 when they are
641 * considered equal, and a value different of zero when they are considered different. Finally, d2 is destroyed
644 int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int (*compar)(const void*, const void*))
648 if ((not d1) && (not d2))
650 if ((not d1) || (not d2)) {
651 XBT_DEBUG("nullptr dynar d1=%p d2=%p",d1,d2);
655 if((d1->elmsize)!=(d2->elmsize)) {
656 XBT_DEBUG("Size of elmsize d1=%lu d2=%lu",d1->elmsize,d2->elmsize);
660 if(xbt_dynar_length(d1) != xbt_dynar_length(d2)) {
661 XBT_DEBUG("Size of dynar d1=%lu d2=%lu",xbt_dynar_length(d1),xbt_dynar_length(d2));
666 size = xbt_dynar_length(d1);
667 for(i=0;i<size;i++) {
668 void *data1 = xbt_dynar_get_as(d1, i, void *);
669 void *data2 = xbt_dynar_get_as(d2, i, void *);
670 XBT_DEBUG("link[%d] d1=%p d2=%p",i,data1,data2);
671 if(compar(data1,data2)){