X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f738ba3162349f5c5e9f87840049391a3928fff8..3e8755b31f40edd05eb6679b4c5571083020545a:/src/xbt/dynar.c diff --git a/src/xbt/dynar.c b/src/xbt/dynar.c index 2594b5dc20..4fa31105c1 100644 --- a/src/xbt/dynar.c +++ b/src/xbt/dynar.c @@ -8,77 +8,77 @@ /* This program is free software; you can redistribute it and/or modify it under the terms of the license (GNU LGPL) which comes with this package. */ -#include "gras_private.h" +#include "xbt/misc.h" +#include "xbt/sysdep.h" +#include "xbt/log.h" +#include "xbt/error.h" +#include "xbt/dynar.h" #include -GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(dynar,gros,"Dynamic arrays"); +XBT_LOG_NEW_DEFAULT_SUBCATEGORY(dynar,xbt,"Dynamic arrays"); -struct gras_dynar_s { - size_t size; - size_t used; - size_t elmsize; +typedef struct xbt_dynar_s { + unsigned long size; + unsigned long used; + unsigned long elmsize; void *data; - void_f_pvoid_t *free; -}; + void_f_pvoid_t *free_f; +} s_xbt_dynar_t; #define __sanity_check_dynar(dynar) \ - gras_assert0(dynar, \ + xbt_assert0(dynar, \ "dynar is NULL") #define __sanity_check_idx(idx) \ - gras_assert1(idx >= 0, \ + xbt_assert1(idx >= 0, \ "dynar idx(=%d) < 0", \ (int) (idx)) #define __check_inbound_idx(dynar, idx) \ - gras_assert2(idx < dynar->used, \ + xbt_assert2(idx < dynar->used, \ "dynar is not that long. You asked %d, but it's only %lu long", \ (int) (idx), (unsigned long) dynar->used) #define __check_sloppy_inbound_idx(dynar, idx) \ - gras_assert2(idx <= dynar->used, \ + xbt_assert2(idx <= dynar->used, \ "dynar is not that long. You asked %d, but it's only %lu long", \ (int) (idx), (unsigned long) dynar->used) #define __check_populated_dynar(dynar) \ - gras_assert1(dynar->used, \ - "dynar %p contains nothing",dynar) + xbt_assert1(dynar->used, \ + "dynar %p contains nothing",(void*)dynar) - -static inline -void -_gras_clear_mem(void * const ptr, - const size_t length) { +static _XBT_INLINE +void _xbt_clear_mem(void * const ptr, + const unsigned long length) { memset(ptr, 0, length); } -static inline -gras_error_t -_gras_dynar_expand(gras_dynar_t * const dynar, - const int nb) { - gras_error_t errcode = no_error; - const size_t old_size = dynar->size; +static _XBT_INLINE +xbt_error_t +_xbt_dynar_expand(xbt_dynar_t const dynar, + const int nb) { + xbt_error_t errcode = no_error; + const unsigned long old_size = dynar->size; if (nb > old_size) { char * const old_data = dynar->data; - const size_t elmsize = dynar->elmsize; - const size_t old_length = old_size*elmsize; + const unsigned long elmsize = dynar->elmsize; + const unsigned long old_length = old_size*elmsize; - const size_t used = dynar->used; - const size_t used_length = used*elmsize; + const unsigned long used = dynar->used; + const unsigned long used_length = used*elmsize; - const size_t new_size = nb > (2*(old_size+1)) ? nb : (2*(old_size+1)); - const size_t new_length = new_size*elmsize; - char * const new_data = gras_malloc0(elmsize*new_size); + const unsigned long new_size = nb > (2*(old_size+1)) ? nb : (2*(old_size+1)); + const unsigned long new_length = new_size*elmsize; + char * const new_data = xbt_malloc0(elmsize*new_size); - DEBUG3("expend %p from %lu to %d elements", dynar, (unsigned long)old_size, nb); - if (!new_data) - RAISE_MALLOC; + DEBUG3("expend %p from %lu to %d elements", (void*)dynar, (unsigned long)old_size, nb); if (old_data) { memcpy(new_data, old_data, used_length); - _gras_clear_mem(old_data, old_length); - gras_free(old_data); + _xbt_clear_mem(old_data, old_length); + xbt_free(old_data); } - _gras_clear_mem(new_data + used_length, new_length - used_length); + _xbt_clear_mem(new_data + used_length, new_length - used_length); dynar->size = new_size; dynar->data = new_data; @@ -87,112 +87,103 @@ _gras_dynar_expand(gras_dynar_t * const dynar, return errcode; } -static inline +static _XBT_INLINE void * -_gras_dynar_elm(const gras_dynar_t * const dynar, - const size_t idx) { +_xbt_dynar_elm(const xbt_dynar_t dynar, + const unsigned long idx) { char * const data = dynar->data; - const size_t elmsize = dynar->elmsize; + const unsigned long elmsize = dynar->elmsize; return data + idx*elmsize; } -static inline +static _XBT_INLINE void -_gras_dynar_get_elm(void * const dst, - const gras_dynar_t * const dynar, - const size_t idx) { - void * const elm = _gras_dynar_elm(dynar, idx); - const size_t elmsize = dynar->elmsize; +_xbt_dynar_get_elm(void * const dst, + const xbt_dynar_t dynar, + const unsigned long idx) { + void * const elm = _xbt_dynar_elm(dynar, idx); + const unsigned long elmsize = dynar->elmsize; memcpy(dst, elm, elmsize); } -static inline +static _XBT_INLINE void -_gras_dynar_put_elm(const gras_dynar_t * const dynar, - const size_t idx, - const void * const src) { - void * const elm = _gras_dynar_elm(dynar, idx); - const size_t elmsize = dynar->elmsize; +_xbt_dynar_put_elm(const xbt_dynar_t dynar, + const unsigned long idx, + const void * const src) { + void * const elm = _xbt_dynar_elm(dynar, idx); + const unsigned long elmsize = dynar->elmsize; memcpy(elm, src, elmsize); } /** - * gras_dynar_new: - * @whereto: pointer to where the dynar should be created + * xbt_dynar_new: * @elm_size: size of each element in the dynar * @free_func: function to call each time we want to get rid of an element (or NULL if nothing to do). - * @Returns: malloc_error or no_error * * Creates a new dynar. If a free_func is provided, the elements have to be * pointer of pointer. That is to say that dynars can contain either base * types (int, char, double, etc) or pointer of pointers (struct **). */ -gras_error_t -gras_dynar_new(gras_dynar_t ** const p_dynar, - const size_t elmsize, - void_f_pvoid_t * const free_func) { - gras_error_t errcode = no_error; - gras_dynar_t *dynar = NULL; - - if (!(dynar = gras_new0(gras_dynar_t,1))) - RAISE_MALLOC; +xbt_dynar_t +xbt_dynar_new(const unsigned long elmsize, + void_f_pvoid_t * const free_f) { + + xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t,1); dynar->size = 0; dynar->used = 0; dynar->elmsize = elmsize; dynar->data = NULL; - dynar->free = free_func; + dynar->free_f = free_f; - *p_dynar = dynar; - - return errcode; + return dynar; } /** - * gras_dynar_free_container: + * xbt_dynar_free_container: * @dynar: poor victim * * kilkil a dynar BUT NOT its content. Ie, the array is freed, but not what * its contain points to. */ void -gras_dynar_free_container(gras_dynar_t * const dynar) { - if (dynar) { +xbt_dynar_free_container(xbt_dynar_t *dynar) { + if (dynar && *dynar) { - if (dynar->data) { - _gras_clear_mem(dynar->data, dynar->size); - gras_free(dynar->data); + if ((*dynar)->data) { + _xbt_clear_mem((*dynar)->data, (*dynar)->size); + xbt_free((*dynar)->data); } - _gras_clear_mem(dynar, sizeof(gras_dynar_t)); + _xbt_clear_mem(*dynar, sizeof(s_xbt_dynar_t)); - gras_free(dynar); + xbt_free(*dynar); + *dynar=NULL; } } /** - * gras_dynar_reset: + * xbt_dynar_reset: * @dynar: who to squeeze * * Frees the content and set the size to 0 */ void -gras_dynar_reset(gras_dynar_t * const dynar) { +xbt_dynar_reset(xbt_dynar_t const dynar) { __sanity_check_dynar(dynar); - DEBUG1("Reset the dynar %p",dynar); - if (dynar->free) { - gras_dynar_map(dynar, dynar->free); + DEBUG1("Reset the dynar %p",(void*)dynar); + if (dynar->free_f) { + xbt_dynar_map(dynar, dynar->free_f); } - if (dynar->data) { - _gras_clear_mem(dynar->data, dynar->size); - gras_free(dynar->data); - } + if (dynar->data) + xbt_free(dynar->data); dynar->size = 0; dynar->used = 0; @@ -200,33 +191,53 @@ gras_dynar_reset(gras_dynar_t * const dynar) { } /** - * gras_dynar_free: + * xbt_dynar_free: * @dynar: poor victim * * kilkil a dynar and its content */ void -gras_dynar_free(gras_dynar_t * const dynar) { - if (dynar) { - gras_dynar_reset(dynar); - gras_dynar_free_container(dynar); +xbt_dynar_free(xbt_dynar_t * dynar) { + if (dynar && *dynar) { + xbt_dynar_reset(*dynar); + xbt_dynar_free_container(dynar); } } /** - * gras_dynar_length: + * xbt_dynar_length: * @dynar: the dynar we want to mesure * * Returns the count of elements in a dynar */ unsigned long -gras_dynar_length(const gras_dynar_t * const dynar) { +xbt_dynar_length(const xbt_dynar_t dynar) { return (dynar ? (unsigned long) dynar->used : (unsigned long)0); } /** - * gras_dynar_get: + * xbt_dynar_get_cpy: + * @dynar: information dealer + * @idx: index of the slot we want to retrive + * @dst: where to pu the result to. + * + * Retrieve a copy of the Nth element of a dynar. + */ +void +xbt_dynar_get_cpy(const xbt_dynar_t dynar, + const int idx, + void * const dst) { + + __sanity_check_dynar(dynar); + __sanity_check_idx(idx); + __check_inbound_idx(dynar, idx); + + _xbt_dynar_get_elm(dst, dynar, idx); +} + +/** + * xbt_dynar_get_ptr: * @dynar: information dealer * @idx: index of the slot we want to retrive * @dst: where to pu the result to. @@ -234,128 +245,129 @@ gras_dynar_length(const gras_dynar_t * const dynar) { * Retrieve the Nth element of a dynar. Warning, the returned value is the actual content of * the dynar. Make a copy before fooling with it. */ -void -gras_dynar_get(const gras_dynar_t * const dynar, - const int idx, - void * const dst) { +void* +xbt_dynar_get_ptr(const xbt_dynar_t dynar, + const int idx) { __sanity_check_dynar(dynar); __sanity_check_idx(idx); __check_inbound_idx(dynar, idx); - _gras_dynar_get_elm(dst, dynar, idx); + return _xbt_dynar_elm(dynar, idx); } /** - * gras_dynar_set: + * xbt_dynar_set: * @dynar: * @idx: * @src: What will be feeded to the dynar - * @Returns: malloc_error or no_error * * Set the Nth element of a dynar, expanding the dynar if needed, BUT NOT freeing * the previous value at this position. If you want to free the previous content, - * use gras_dynar_remplace(). + * use xbt_dynar_replace(). */ -gras_error_t -gras_dynar_set(gras_dynar_t * const dynar, +void +xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void * const src) { - gras_error_t errcode = no_error; __sanity_check_dynar(dynar); __sanity_check_idx(idx); - TRY(_gras_dynar_expand(dynar, idx+1)); + _xbt_dynar_expand(dynar, idx+1); if (idx >= dynar->used) { dynar->used = idx+1; } - _gras_dynar_put_elm(dynar, idx, src); - - return errcode; + _xbt_dynar_put_elm(dynar, idx, src); } /** - * gras_dynar_remplace: + * xbt_dynar_replace: * @dynar: * @idx: * @object: - * @Returns: malloc_error or no_error * * Set the Nth element of a dynar, expanding the dynar if needed, AND DO * free the previous value at this position. If you don't want to free the - * previous content, use gras_dynar_set(). + * previous content, use xbt_dynar_set(). */ -gras_error_t -gras_dynar_remplace(gras_dynar_t * const dynar, - const int idx, - const void * const object) { - gras_error_t errcode = no_error; +void +xbt_dynar_replace(xbt_dynar_t dynar, + const int idx, + const void * const object) { __sanity_check_dynar(dynar); __sanity_check_idx(idx); - if (idx < dynar->used && dynar->free) { - void * const old_object = _gras_dynar_elm(dynar, idx); + if (idx < dynar->used && dynar->free_f) { + void * const old_object = _xbt_dynar_elm(dynar, idx); - dynar->free(old_object); + dynar->free_f(old_object); } - errcode = gras_dynar_set(dynar, idx, object); - - return errcode; + xbt_dynar_set(dynar, idx, object); } /** - * gras_dynar_insert_at: - * @dynar: - * @idx: - * @src: What will be feeded to the dynar - * @Returns: malloc_error or no_error - * - * Set the Nth element of a dynar, expanding the dynar if needed, and - * moving the previously existing value and all subsequent ones to one - * position right in the dynar. + * xbt_dynar_insert_at_ptr: + * + * Make room for a new element in the dynar, and return a pointer to + * its position. You can then use regular affectation to set its value + * instead of relying on the slow memcpy */ -gras_error_t -gras_dynar_insert_at(gras_dynar_t * const dynar, - const int idx, - const void * const src) { - gras_error_t errcode = no_error; - +void * +xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, + const int idx) { + __sanity_check_dynar(dynar); __sanity_check_idx(idx); __check_sloppy_inbound_idx(dynar, idx); { - const size_t old_used = dynar->used; - const size_t new_used = old_used + 1; + const unsigned long old_used = dynar->used; + const unsigned long new_used = old_used + 1; - TRY(_gras_dynar_expand(dynar, new_used)); + _xbt_dynar_expand(dynar, new_used); { - const size_t nb_shift = old_used - idx; - const size_t elmsize = dynar->elmsize; - - const size_t offset = nb_shift*elmsize; + const unsigned long nb_shift = old_used - idx; - void * const elm_src = _gras_dynar_elm(dynar, idx); - void * const elm_dst = _gras_dynar_elm(dynar, idx+1); - - memmove(elm_dst, elm_src, offset); + if (nb_shift) + memmove(_xbt_dynar_elm(dynar, idx+1), + _xbt_dynar_elm(dynar, idx), + nb_shift * dynar->elmsize); } - _gras_dynar_put_elm(dynar, idx, src); dynar->used = new_used; + return _xbt_dynar_elm(dynar,idx); } +} - return errcode; +/** + * xbt_dynar_insert_at: + * @dynar: + * @idx: + * @src: What will be feeded to the dynar + * + * Set the Nth element of a dynar, expanding the dynar if needed, and + * moving the previously existing value and all subsequent ones to one + * position right in the dynar. + */ +void +xbt_dynar_insert_at(xbt_dynar_t const dynar, + const int idx, + const void * const src) { + + /* checks done in xbt_dynar_insert_at_ptr */ + memcpy(xbt_dynar_insert_at_ptr(dynar,idx), + src, + dynar->elmsize); } /** - * gras_dynar_remove_at: + * xbt_dynar_remove_at: * @dynar: * @idx: * @object: @@ -364,7 +376,7 @@ gras_dynar_insert_at(gras_dynar_t * const dynar, * all subsequent values to one position left in the dynar. */ void -gras_dynar_remove_at(gras_dynar_t * const dynar, +xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void * const object) { @@ -373,19 +385,19 @@ gras_dynar_remove_at(gras_dynar_t * const dynar, __check_inbound_idx(dynar, idx); if (object) - _gras_dynar_get_elm(object, dynar, idx); + _xbt_dynar_get_elm(object, dynar, idx); { - const size_t old_used = dynar->used; - const size_t new_used = old_used - 1; + const unsigned long old_used = dynar->used; + const unsigned long new_used = old_used - 1; - const size_t nb_shift = old_used-1 - idx; - const size_t elmsize = dynar->elmsize; + const unsigned long nb_shift = old_used-1 - idx; + const unsigned long elmsize = dynar->elmsize; - const size_t offset = nb_shift*elmsize; + const unsigned long offset = nb_shift*elmsize; - void * const elm_src = _gras_dynar_elm(dynar, idx+1); - void * const elm_dst = _gras_dynar_elm(dynar, idx); + void * const elm_src = _xbt_dynar_elm(dynar, idx+1); + void * const elm_dst = _xbt_dynar_elm(dynar, idx); memmove(elm_dst, elm_src, offset); @@ -394,71 +406,95 @@ gras_dynar_remove_at(gras_dynar_t * const dynar, } /** - * gras_dynar_push: + * xbt_dynar_push_ptr: + * + * Make room at the end of the dynar for a new element, and return a pointer to it + */ +void * +xbt_dynar_push_ptr(xbt_dynar_t const dynar) { + return xbt_dynar_insert_at_ptr(dynar, dynar->used); +} + +/** + * xbt_dynar_push: * @dynar: * @src: - * @Returns: malloc_error or no_error * * Add an element at the end of the dynar */ -gras_error_t -gras_dynar_push(gras_dynar_t * const dynar, +void +xbt_dynar_push(xbt_dynar_t const dynar, const void * const src) { - __sanity_check_dynar(dynar); - return gras_dynar_insert_at(dynar, dynar->used, src); + /* sanity checks done by insert_at */ + xbt_dynar_insert_at(dynar, dynar->used, src); } /** - * gras_dynar_pop: + * xbt_dynar_pop_ptr: + * @dynar: + * @dst: + * + * Make the last element of the dynar as unused and return a pointer to it. + */ +void * +xbt_dynar_pop_ptr(xbt_dynar_t const dynar) { + + __check_populated_dynar(dynar); + DEBUG1("Pop %p",(void*)dynar); + dynar->used--; + return _xbt_dynar_elm(dynar,dynar->used); +} + +/** + * xbt_dynar_pop: * @dynar: * @dst: * * Get and remove the last element of the dynar */ void -gras_dynar_pop(gras_dynar_t * const dynar, +xbt_dynar_pop(xbt_dynar_t const dynar, void * const dst) { - __sanity_check_dynar(dynar); - __check_populated_dynar(dynar); - DEBUG1("Pop %p",dynar); - gras_dynar_remove_at(dynar, dynar->used-1, dst); + + /* sanity checks done by remove_at */ + DEBUG1("Pop %p",(void*)dynar); + xbt_dynar_remove_at(dynar, dynar->used-1, dst); } /** - * gras_dynar_unshift: + * xbt_dynar_unshift: * @dynar: * @src: - * @Returns: malloc_error or no_error * * Add an element at the begining of the dynar (rather long, Use - * gras_dynar_push() when possible) + * xbt_dynar_push() when possible) */ -gras_error_t -gras_dynar_unshift(gras_dynar_t * const dynar, +void +xbt_dynar_unshift(xbt_dynar_t const dynar, const void * const src) { - __sanity_check_dynar(dynar); - return gras_dynar_insert_at(dynar, 0, src); + + /* sanity checks done by insert_at */ + xbt_dynar_insert_at(dynar, 0, src); } /** - * gras_dynar_shift: + * xbt_dynar_shift: * @dynar: * @dst: * * Get and remove the first element of the dynar (rather long, Use - * gras_dynar_pop() when possible) + * xbt_dynar_pop() when possible) */ void -gras_dynar_shift(gras_dynar_t * const dynar, +xbt_dynar_shift(xbt_dynar_t const dynar, void * const dst) { - __sanity_check_dynar(dynar); - __check_populated_dynar(dynar); - gras_dynar_remove_at(dynar, 0, dst); + /* sanity checks done by remove_at */ + xbt_dynar_remove_at(dynar, 0, dst); } /** - * gras_dynar_map: + * xbt_dynar_map: * @dynar: * @operator: * @@ -466,25 +502,25 @@ gras_dynar_shift(gras_dynar_t * const dynar, * value of the element itself, but should not mess with the dynar). */ void -gras_dynar_map(const gras_dynar_t * const dynar, +xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t * const operator) { __sanity_check_dynar(dynar); { char elm[64]; - const size_t used = dynar->used; - size_t i = 0; + const unsigned long used = dynar->used; + unsigned long i = 0; for (i = 0; i < used; i++) { - _gras_dynar_get_elm(elm, dynar, i); + _xbt_dynar_get_elm(elm, dynar, i); operator(elm); } } } /** - * gras_dynar_first: + * xbt_dynar_cursor_first: * * Put the cursor at the begining of the dynar. (actually, one step before * the begining, so that you can iterate over the dynar with a for loop). @@ -495,34 +531,32 @@ gras_dynar_map(const gras_dynar_t * const dynar, * */ void -gras_dynar_cursor_first(const gras_dynar_t * const dynar, - int * const cursor) { +xbt_dynar_cursor_first(const xbt_dynar_t dynar, + int * const cursor) { - __sanity_check_dynar(dynar); - DEBUG1("Set cursor on %p to the first position",dynar); + DEBUG1("Set cursor on %p to the first position",(void*)dynar); *cursor = 0; } /** - * gras_dynar_cursor_step: + * xbt_dynar_cursor_step: * * Move the cursor to the next value (and return true), or return false. */ void -gras_dynar_cursor_step(const gras_dynar_t * const dynar, - int * const cursor) { +xbt_dynar_cursor_step(const xbt_dynar_t dynar, + int * const cursor) { - __sanity_check_dynar(dynar); (*cursor)++; } /** - * gras_dynar_cursor_get: + * xbt_dynar_cursor_get: * * Get the current value of the cursor */ int -gras_dynar_cursor_get(const gras_dynar_t * const dynar, +xbt_dynar_cursor_get(const xbt_dynar_t dynar, int * const cursor, void * const dst) { @@ -532,43 +566,43 @@ gras_dynar_cursor_get(const gras_dynar_t * const dynar, const int idx = *cursor; if (idx >= dynar->used) { - DEBUG1("Cursor on %p already on last elem",dynar); + DEBUG1("Cursor on %p already on last elem",(void*)dynar); return FALSE; } - DEBUG2("Cash out cursor on %p at %d",dynar,idx); + DEBUG2("Cash out cursor on %p at %d",(void*)dynar,idx); - _gras_dynar_get_elm(dst, dynar, idx); + _xbt_dynar_get_elm(dst, dynar, idx); } return TRUE; } /** - * gras_dynar_cursor_rm: + * xbt_dynar_cursor_rm: * @dynar: * @cursor: * * Remove (free) the entry pointed by the cursor, for use in the middle of a foreach */ -void gras_dynar_cursor_rm(gras_dynar_t * dynar, +void xbt_dynar_cursor_rm(xbt_dynar_t dynar, int * const cursor) { void *dst; if (dynar->elmsize > sizeof(void*)) { DEBUG0("Elements too big to fit into a pointer"); - if (dynar->free) { - dst=gras_malloc(dynar->elmsize); - gras_dynar_remove_at(dynar,(*cursor)--,dst); - (dynar->free)(dst); - gras_free(dst); + if (dynar->free_f) { + dst=xbt_malloc(dynar->elmsize); + xbt_dynar_remove_at(dynar,(*cursor)--,dst); + (dynar->free_f)(dst); + xbt_free(dst); } else { - DEBUG0("Ok, we dont care about the element when no free function"); - gras_dynar_remove_at(dynar,(*cursor)--,NULL); + DEBUG0("Ok, we dont care about the element without free function"); + xbt_dynar_remove_at(dynar,(*cursor)--,NULL); } } else { - gras_dynar_remove_at(dynar,(*cursor)--,&dst); - if (dynar->free) - (dynar->free)(dst); + xbt_dynar_remove_at(dynar,(*cursor)--,&dst); + if (dynar->free_f) + (dynar->free_f)(dst); } }