include/xbt/dynar.h

   1 /* dynar - a generic dynamic array                                          */
   2
   3 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   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. */
   8
   9 #ifndef _XBT_DYNAR_H
  10 #define _XBT_DYNAR_H
  11
  12 #include <string.h> /* memcpy */
  13
  14 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  15 #include "xbt/function_types.h"
  16
  17 SG_BEGIN_DECL()
  18
  19 /** @addtogroup XBT_dynar
  20   * @brief DynArr are dynamically sized vector which may contain any type of variables.
  21   *
  22   * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
  23   *
  24   * For performance concerns, the content of DynArr must be homogeneous (in
  25   * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
  26   * have to provide the function which will be used to free the content at
  27   * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
  28   *
  29   * \section XBT_dynar_exscal Example with scalar
  30   * \dontinclude dynar.c
  31   *
  32   * \skip Vars_decl
  33   * \skip dyn
  34   * \until iptr
  35   * \skip Populate_ints
  36   * \skip dyn
  37   * \until end_of_traversal
  38   * \skip shifting
  39   * \skip val
  40   * \until xbt_dynar_free
  41   *
  42   * \section XBT_dynar_exptr Example with pointed data
  43   *
  44   * \skip test_dynar_string
  45   * \skip dynar_t
  46   * \until s2
  47   * \skip Populate_str
  48   * \skip dyn
  49   * \until }
  50   * \skip macro
  51   * \until dynar_free
  52   * \skip end_of_doxygen
  53   * \until }
  54   *
  55   */
  56 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
  57  *  @ingroup XBT_dynar
  58  *
  59  *  @{
  60  */
  61    /** \brief Dynar data type (opaque type) */
  62      typedef struct xbt_dynar_s *xbt_dynar_t;
  63
  64
  65 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new(const unsigned long elm_size,
  66                                       void_f_pvoid_t const free_f);
  67 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new_sync(const unsigned long elm_size,
  68                                            void_f_pvoid_t const free_f);
  69 XBT_INLINE XBT_PUBLIC(void) xbt_dynar_free(xbt_dynar_t * dynar);
  70 XBT_PUBLIC(void) xbt_dynar_free_voidp(void *dynar);
  71 XBT_PUBLIC(void) xbt_dynar_free_container(xbt_dynar_t * dynar);
  72
  73 XBT_INLINE XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
  74 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
  75 XBT_PUBLIC(void) xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
  76
  77 XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar);
  78
  79 /** @} */
  80 /** @defgroup XBT_dynar_array Dynar as a regular array
  81  *  @ingroup XBT_dynar
  82  *
  83  *  @{
  84  */
  85
  86 XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar,
  87                                    const unsigned long idx, void *const dst);
  88
  89 XBT_PUBLIC(void) xbt_dynar_set(xbt_dynar_t dynar, const int idx,
  90                                const void *src);
  91 XBT_PUBLIC(void) xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx,
  92                                    const void *object);
  93
  94 XBT_PUBLIC(void) xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx,
  95                                      const void *src);
  96 XBT_PUBLIC(void) xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx,
  97                                      void *const dst);
  98
  99 XBT_PUBLIC(int) xbt_dynar_search(xbt_dynar_t const dynar, void *elem);
 100 XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
 101 XBT_PUBLIC(void) xbt_dynar_sort(xbt_dynar_t const dynar, int_f_cpvoid_cpvoid_t compar_fn);
 102
 103 /** @} */
 104 /** @defgroup XBT_dynar_perl Perl-like use of dynars
 105  *  @ingroup XBT_dynar
 106  *
 107  *  @{
 108  */
 109
 110 XBT_INLINE XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, const void *src);
 111 XBT_INLINE XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst);
 112 XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar, const void *src);
 113 XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst);
 114 XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar,
 115                                void_f_pvoid_t const op);
 116
 117 /** @} */
 118 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
 119  *  @ingroup XBT_dynar
 120  *
 121  *  Those functions do not retrieve the content, but only their address.
 122  *
 123  *  @{
 124  */
 125
 126 XBT_INLINE XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar,
 127                                      const unsigned long idx);
 128 XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
 129                                            const int idx);
 130 XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
 131 XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
 132
 133 /** @} */
 134 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
 135  *  @ingroup XBT_dynar
 136  *
 137  *  While the other functions use a memcpy to retrieve the content into the
 138  *  user provided area, those ones use a regular affectation. It only works
 139  *  for scalar values, but should be a little faster.
 140  *
 141  *  @{
 142  */
 143
 144   /** @brief Quick retrieval of scalar content
 145    *  @hideinitializer */
 146 #  define xbt_dynar_get_as(dynar,idx,type) \
 147           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
 148   /** @brief Quick retrieval of scalar content
 149    *  @hideinitializer */
 150 #  define xbt_dynar_getlast_as(dynar,type) \
 151           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
 152   /** @brief Quick retrieval of scalar content
 153    *  @hideinitializer */
 154 #  define xbt_dynar_getfirst_as(dynar,type) \
 155           (*(type*)xbt_dynar_get_ptr((dynar),0))
 156   /** @brief Quick insertion of scalar content
 157    *  @hideinitializer */
 158 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
 159           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
 160   /** @brief Quick insertion of scalar content
 161    *  @hideinitializer */
 162 #  define xbt_dynar_push_as(dynar,type,value) \
 163           *(type*)xbt_dynar_push_ptr(dynar)=value
 164   /** @brief Quick removal of scalar content
 165    *  @hideinitializer */
 166 #  define xbt_dynar_pop_as(dynar,type) \
 167            (*(type*)xbt_dynar_pop_ptr(dynar))
 168
 169 /** @} */
 170 /** @defgroup XBT_dynar_cursor Cursors on dynar
 171  *  @ingroup XBT_dynar
 172  *
 173  * Cursors are used to iterate over the structure. Never add elements to the
 174  * DynArr during the traversal. To remove elements, use the
 175  * xbt_dynar_cursor_rm() function.
 176  *
 177  * Do not call these functions directly, but only the xbt_dynar_foreach macro.
 178  *
 179  * For synchronized dynars, the dynar will be locked during the whole
 180  * loop and it will get unlocked automatically if you traverse all
 181  * elements. If you want to break the loop before the end, make sure
 182  * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
 183  *
 184  *  @{
 185  */
 186
 187 XBT_INLINE XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 188                                      unsigned int *const cursor);
 189 XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
 190
 191 /* do not use this structure internals directly, but use the public interface
 192  * This was made public to allow:
 193  *  - the inlining of the foreach elements
 194  *  - sending such beasts over the network
 195  */
 196
 197 #include "xbt/synchro_core.h"
 198 typedef struct xbt_dynar_s {
 199   unsigned long size;
 200   unsigned long used;
 201   unsigned long elmsize;
 202   void *data;
 203   void_f_pvoid_t free_f;
 204   xbt_mutex_t mutex;
 205 } s_xbt_dynar_t;
 206
 207 static XBT_INLINE void
 208 _xbt_dynar_cursor_first(const xbt_dynar_t dynar, unsigned int *const cursor)
 209 {
 210   /* don't test for dynar!=NULL. The segfault would tell us */
 211   if (dynar->mutex)  /* ie _dynar_lock(dynar) but not public */
 212     xbt_mutex_acquire(dynar->mutex);
 213
 214   //DEBUG1("Set cursor on %p to the first position", (void *) dynar);
 215   *cursor = 0;
 216 }
 217
 218 static XBT_INLINE int
 219 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
 220                       unsigned int idx, void *const dst)
 221 {
 222
 223   if (idx >= dynar->used) {
 224     //DEBUG1("Cursor on %p already on last elem", (void *) dynar);
 225     if (dynar->mutex) /* unlock */
 226       xbt_mutex_release(dynar->mutex);
 227     return FALSE;
 228   }
 229   //  DEBUG2("Cash out cursor on %p at %u", (void *) dynar, *idx);
 230
 231   memcpy(dst, ((char*)dynar->data) + idx * dynar->elmsize, dynar->elmsize);
 232
 233   return TRUE;
 234 }
 235
 236
 237
 238 /** @brief Iterates over the whole dynar.
 239  *
 240  *  @param _dynar what to iterate over
 241  *  @param _cursor an integer used as cursor
 242  *  @param _data
 243  *  @hideinitializer
 244  *
 245  * \note An example of usage:
 246  * \code
 247 xbt_dynar_t dyn;
 248 unsigned int cpt;
 249 string *str;
 250 xbt_dynar_foreach (dyn,cpt,str) {
 251   printf("Seen %s\n",str);
 252 }
 253 \endcode
 254  */
 255 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
 256        for (_xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
 257             _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
 258             (_cursor)++         )
 259
 260 /** @} */
 261
 262 SG_END_DECL()
 263 #endif /* _XBT_DYNAR_H */