X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/19bdb25835da6ee353675dfb995cf9ca886361b2..169693dfb10bef9cf59ecd8192ff7f355cbc031f:/include/xbt/dynar.h diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h index 5f1df3bb8a..1888388016 100644 --- a/include/xbt/dynar.h +++ b/include/xbt/dynar.h @@ -1,8 +1,7 @@ -/* $Id$ */ - /* dynar - a generic dynamic array */ -/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */ +/* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team. + * All rights reserved. */ /* 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. */ @@ -10,11 +9,17 @@ #ifndef _XBT_DYNAR_H #define _XBT_DYNAR_H -#include "xbt/misc.h" /* BEGIN_DECL */ +#include /* memcpy */ + +#include "xbt/misc.h" /* SG_BEGIN_DECL */ +#include "xbt/function_types.h" -BEGIN_DECL() +SG_BEGIN_DECL() -/** \addtogroup XBT_dynar +/** @addtogroup XBT_dynar + * @brief DynArr are dynamically sized vector which may contain any type of variables. + * + * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another. * * For performance concerns, the content of DynArr must be homogeneous (in * contrary to dictionnaries -- see the \ref XBT_dict section). You thus @@ -22,7 +27,7 @@ BEGIN_DECL() * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t). * * \section XBT_dynar_exscal Example with scalar - * \dontinclude dynar_int.c + * \dontinclude dynar.c * * \skip Vars_decl * \skip dyn @@ -35,80 +40,112 @@ BEGIN_DECL() * \until xbt_dynar_free * * \section XBT_dynar_exptr Example with pointed data - * \dontinclude dynar_string.c * - * \skip doxygen_first_cruft - * \skip f - * \until xbt_init + * \skip test_dynar_string + * \skip dynar_t + * \until s2 * \skip Populate_str * \skip dyn * \until } * \skip macro * \until dynar_free - * \skip xbt_exit + * \skip end_of_doxygen * \until } - * @{ + * */ - -/** @name 1. Constructor/destructor +/** @defgroup XBT_dynar_cons Dynar constructor and destructor + * @ingroup XBT_dynar + * * @{ */ /** \brief Dynar data type (opaque type) */ - typedef struct xbt_dynar_s *xbt_dynar_t; +typedef struct xbt_dynar_s *xbt_dynar_t; + - /** \brief Pointer to a function freeing a pointed data */ - typedef void (void_f_ppvoid_t)(void**); - /** \brief Pointer to a function freeing some data */ - typedef void (void_f_pvoid_t) (void*); +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_voidp(void *dynar); +XBT_PUBLIC(void) xbt_dynar_free_container(xbt_dynar_t * dynar); - xbt_dynar_t xbt_dynar_new(unsigned long elm_size, - void_f_pvoid_t *free_func); - void xbt_dynar_free(xbt_dynar_t *dynar); - 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); - unsigned long xbt_dynar_length(const xbt_dynar_t dynar); - void xbt_dynar_reset(xbt_dynar_t dynar); +XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar); -/** @name 2. regular array functions +/** @} */ +/** @defgroup XBT_dynar_array Dynar as a regular array + * @ingroup XBT_dynar + * * @{ */ - void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void *const dst); - - void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src); - void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object); +XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar, + const unsigned long idx, + void *const dst); - void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void *src); - void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void *object); +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, + const unsigned long idx, + const void *object); + +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(unsigned int) xbt_dynar_search(xbt_dynar_t const dynar, + void *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 *)); /** @} */ -/** @name 2. Perl-like functions +/** @defgroup XBT_dynar_perl Perl-like use of dynars + * @ingroup XBT_dynar + * * @{ */ - void xbt_dynar_push (xbt_dynar_t dynar, const void *src); - void xbt_dynar_pop (xbt_dynar_t dynar, void *const dst); - void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src); - void xbt_dynar_shift (xbt_dynar_t dynar, void *const dst); - void xbt_dynar_map (const xbt_dynar_t dynar, void_f_pvoid_t *operator); +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_unshift(xbt_dynar_t const dynar, + const void *src); +XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst); +XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar, + void_f_pvoid_t const op); /** @} */ -/** @name 3. Manipulating pointers to the content +/** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content + * @ingroup XBT_dynar * - * Those functions do not retrive the content, but only their address. + * Those functions do not retrieve the content, but only their address. * * @{ */ - void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx); - void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx); - void *xbt_dynar_push_ptr(xbt_dynar_t dynar); - void *xbt_dynar_pop_ptr(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_insert_at_ptr(xbt_dynar_t const dynar, + const int idx); +XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar); +XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar); /** @} */ -/** @name 4. Speed optimized functions for scalars +/** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars + * @ingroup XBT_dynar * - * While the other functions use a memcpy to retrive the content into the + * While the other functions use a memcpy to retrieve the content into the * user provided area, those ones use a regular affectation. It only works * for scalar values, but should be a little faster. * @@ -118,7 +155,19 @@ BEGIN_DECL() /** @brief Quick retrieval of scalar content * @hideinitializer */ # define xbt_dynar_get_as(dynar,idx,type) \ - *(type*)xbt_dynar_get_ptr(dynar,idx) + (*(type*)xbt_dynar_get_ptr((dynar),(idx))) +/** @brief Quick setting of scalar content + * @hideinitializer */ +# define xbt_dynar_set_as(dynar,idx,type,val) \ + (*(type*)xbt_dynar_get_ptr((dynar),(idx))) = val + /** @brief Quick retrieval of scalar content + * @hideinitializer */ +# define xbt_dynar_getlast_as(dynar,type) \ + (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1)) + /** @brief Quick retrieval of scalar content + * @hideinitializer */ +# define xbt_dynar_getfirst_as(dynar,type) \ + (*(type*)xbt_dynar_get_ptr((dynar),0)) /** @brief Quick insertion of scalar content * @hideinitializer */ # define xbt_dynar_insert_at_as(dynar,idx,type,value) \ @@ -127,27 +176,81 @@ BEGIN_DECL() * @hideinitializer */ # define xbt_dynar_push_as(dynar,type,value) \ *(type*)xbt_dynar_push_ptr(dynar)=value - /** @brief Quick insertion of scalar content + /** @brief Quick removal of scalar content * @hideinitializer */ # define xbt_dynar_pop_as(dynar,type) \ - *(type*)xbt_dynar_pop_ptr(dynar) + (*(type*)xbt_dynar_pop_ptr(dynar)) /** @} */ -/** @name 5. Cursors on DynArr +/** @defgroup XBT_dynar_cursor Cursors on dynar + * @ingroup XBT_dynar * * Cursors are used to iterate over the structure. Never add elements to the * DynArr during the traversal. To remove elements, use the - * xbt_dynar_cursor_rm() function + * 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; * * @{ */ - void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor); - void xbt_dynar_cursor_step (const xbt_dynar_t dynar, int *cursor); - int xbt_dynar_cursor_get (const xbt_dynar_t dynar, int *cursor, - void *whereto); - void xbt_dynar_cursor_rm(xbt_dynar_t dynar, - int *const cursor); +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); + +/* do not use this structure internals directly, but use the public interface + * This was made public to allow: + * - the inlining of the foreach elements + * - 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, + 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); + + //DEBUG1("Set cursor on %p to the first position", (void *) dynar); + *cursor = 0; +} + +static XBT_INLINE int +_xbt_dynar_cursor_get(const xbt_dynar_t dynar, + unsigned int idx, void *const dst) +{ + + if (idx >= dynar->used) { + //DEBUG1("Cursor on %p already on last elem", (void *) dynar); + if (dynar->mutex) /* unlock */ + xbt_mutex_release(dynar->mutex); + return FALSE; + } + // DEBUG2("Cash out cursor on %p at %u", (void *) dynar, *idx); + + memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, + dynar->elmsize); + + return TRUE; +} + /** @brief Iterates over the whole dynar. @@ -160,7 +263,7 @@ BEGIN_DECL() * \note An example of usage: * \code xbt_dynar_t dyn; -int cpt; +unsigned int cpt; string *str; xbt_dynar_foreach (dyn,cpt,str) { printf("Seen %s\n",str); @@ -168,12 +271,11 @@ xbt_dynar_foreach (dyn,cpt,str) { \endcode */ #define xbt_dynar_foreach(_dynar,_cursor,_data) \ - for (xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \ - xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \ - xbt_dynar_cursor_step(_dynar,&(_cursor)) ) + for (_xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \ + _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \ + (_cursor)++ ) +/** @} */ -END_DECL() - -/* @} */ -#endif /* _XBT_DYNAR_H */ +SG_END_DECL() +#endif /* _XBT_DYNAR_H */