X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/169693dfb10bef9cf59ecd8192ff7f355cbc031f..de8cfa17c0e30bf9dccf0b0c9ecaff7858926f04:/include/xbt/dynar.h diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h index 1888388016..4ca03cc365 100644 --- a/include/xbt/dynar.h +++ b/include/xbt/dynar.h @@ -1,6 +1,6 @@ /* dynar - a generic dynamic array */ -/* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team. +/* Copyright (c) 2004-2007, 2009-2015. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it @@ -11,7 +11,7 @@ #include /* memcpy */ -#include "xbt/misc.h" /* SG_BEGIN_DECL */ +#include "xbt/base.h" /* SG_BEGIN_DECL */ #include "xbt/function_types.h" SG_BEGIN_DECL() @@ -52,6 +52,12 @@ SG_BEGIN_DECL() * \skip end_of_doxygen * \until } * + * Note that if you use dynars to store pointed data, the + * xbt_dynar_search(), xbt_dynar_search_or_negative() and + * xbt_dynar_member() won't be for you. Instead of comparing + * your pointed elements, they compare the pointer to them. See + * the documentation of xbt_dynar_search() for more info. + * */ /** @defgroup XBT_dynar_cons Dynar constructor and destructor * @ingroup XBT_dynar @@ -64,18 +70,10 @@ typedef struct xbt_dynar_s *xbt_dynar_t; XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t const free_f); -XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new_sync(const unsigned long elm_size, - void_f_pvoid_t const free_f); -XBT_INLINE XBT_PUBLIC(void) xbt_dynar_free(xbt_dynar_t * dynar); +XBT_PUBLIC(void) xbt_dynar_free(xbt_dynar_t * dynar); XBT_PUBLIC(void) xbt_dynar_free_voidp(void *dynar); XBT_PUBLIC(void) xbt_dynar_free_container(xbt_dynar_t * dynar); - -XBT_INLINE XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t - dynar); -XBT_INLINE XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar); -XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar); XBT_PUBLIC(void) xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots); - XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar); /** @} */ @@ -88,7 +86,6 @@ XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar); XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void *const dst); - XBT_PUBLIC(void) xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void *src); XBT_PUBLIC(void) xbt_dynar_replace(xbt_dynar_t dynar, @@ -99,14 +96,32 @@ XBT_PUBLIC(void) xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void *src); XBT_PUBLIC(void) xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void *const dst); +XBT_PUBLIC(void) xbt_dynar_remove_n_at(xbt_dynar_t const dynar, + const unsigned int n, const int idx); -XBT_PUBLIC(unsigned int) xbt_dynar_search(xbt_dynar_t const dynar, - void *elem); + +XBT_PUBLIC(unsigned int) xbt_dynar_search(xbt_dynar_t const dynar, void *elem); +XBT_PUBLIC(signed int) xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem); XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem); XBT_PUBLIC(void) xbt_dynar_sort(xbt_dynar_t const dynar, int_f_cpvoid_cpvoid_t compar_fn); -XBT_INLINE XBT_PUBLIC(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, - int(*compar)(const void *, const void *)); +XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar, + int_f_pvoid_t color); +XBT_PUBLIC(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, + int(*compar)(const void *, const void *)); +XBT_PUBLIC(void *) xbt_dynar_to_array (xbt_dynar_t dynar); + +/** @} */ +/** @defgroup XBT_dynar_misc Dynar miscellaneous functions + * @ingroup XBT_dynar + * + * @{ + */ + +XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar); +XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar); +XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar); +XBT_PUBLIC(void) xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2); /** @} */ /** @defgroup XBT_dynar_perl Perl-like use of dynars @@ -115,10 +130,8 @@ XBT_INLINE XBT_PUBLIC(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, * @{ */ -XBT_INLINE XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, - const void *src); -XBT_INLINE XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, - void *const dst); +XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, const void *src); +XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst); XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar, const void *src); XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst); @@ -134,8 +147,10 @@ XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar, * @{ */ -XBT_INLINE XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar, - const unsigned long idx); +XBT_PUBLIC(void *) xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, + const unsigned long idx); +XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar, + const unsigned long idx); XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx); XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar); @@ -159,7 +174,7 @@ XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar); /** @brief Quick setting of scalar content * @hideinitializer */ # define xbt_dynar_set_as(dynar,idx,type,val) \ - (*(type*)xbt_dynar_get_ptr((dynar),(idx))) = val + (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val /** @brief Quick retrieval of scalar content * @hideinitializer */ # define xbt_dynar_getlast_as(dynar,type) \ @@ -189,20 +204,14 @@ XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar); * DynArr during the traversal. To remove elements, use the * xbt_dynar_cursor_rm() function. * - * Do not call these functions directly, but only the xbt_dynar_foreach macro. - * - * For synchronized dynars, the dynar will be locked during the whole - * loop and it will get unlocked automatically if you traverse all - * elements. If you want to break the loop before the end, make sure - * to call xbt_dynar_cursor_unlock() before the break; + * Do not call these function directly, but only within the xbt_dynar_foreach + * macro. * * @{ */ -XBT_INLINE XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar, - unsigned int *const - cursor); -XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar); +XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar, + unsigned int *const cursor); /* do not use this structure internals directly, but use the public interface * This was made public to allow: @@ -210,25 +219,21 @@ XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar); * - sending such beasts over the network */ -#include "xbt/synchro_core.h" typedef struct xbt_dynar_s { unsigned long size; unsigned long used; unsigned long elmsize; void *data; void_f_pvoid_t free_f; - xbt_mutex_t mutex; } s_xbt_dynar_t; static XBT_INLINE void -_xbt_dynar_cursor_first(const xbt_dynar_t dynar, +_xbt_dynar_cursor_first(const xbt_dynar_t dynar _XBT_GNUC_UNUSED, unsigned int *const cursor) { - /* don't test for dynar!=NULL. The segfault would tell us */ - if (dynar->mutex) /* ie _dynar_lock(dynar) but not public */ - xbt_mutex_acquire(dynar->mutex); + /* iterating over a NULL dynar is a no-op (but we don't want to have uninitialized counters) */ - //DEBUG1("Set cursor on %p to the first position", (void *) dynar); + //XBT_DEBUG("Set cursor on %p to the first position", (void *) dynar); *cursor = 0; } @@ -236,14 +241,14 @@ static XBT_INLINE int _xbt_dynar_cursor_get(const xbt_dynar_t dynar, unsigned int idx, void *const dst) { + if (!dynar) /* iterating over a NULL dynar is a no-op */ + return FALSE; if (idx >= dynar->used) { - //DEBUG1("Cursor on %p already on last elem", (void *) dynar); - if (dynar->mutex) /* unlock */ - xbt_mutex_release(dynar->mutex); + //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar); return FALSE; } - // DEBUG2("Cash out cursor on %p at %u", (void *) dynar, *idx); + // XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx); memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize); @@ -260,7 +265,7 @@ _xbt_dynar_cursor_get(const xbt_dynar_t dynar, * @param _data * @hideinitializer * - * \note An example of usage: + * Here is an example of usage: * \code xbt_dynar_t dyn; unsigned int cpt; @@ -269,12 +274,27 @@ xbt_dynar_foreach (dyn,cpt,str) { printf("Seen %s\n",str); } \endcode + * + * Note that underneath, that's a simple for loop with no real black + * magic involved. It's perfectly safe to interrupt a foreach with a + * break or a return statement. */ #define xbt_dynar_foreach(_dynar,_cursor,_data) \ for (_xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \ - _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \ + _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \ (_cursor)++ ) +#ifndef __cplusplus +#define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \ + for (_xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \ + (_ptr = _cursor < _dynar->used ? xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \ + (_cursor)++ ) +#else +#define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \ + for (_xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \ + (_ptr = _cursor < _dynar->used ? (decltype(_ptr)) xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \ + (_cursor)++ ) +#endif /** @} */ SG_END_DECL()