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   * Note that if you use dynars to store pointed data, the
  56   * xbt_dynar_search(), xbt_dynar_search_or_negative() and
  57   * xbt_dynar_member() won't be for you. Instead of comparing
  58   * your pointed elements, they compare the pointer to them. See
  59   * the documentation of xbt_dynar_search() for more info.
  60   *
  61   */
  62 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
  63  *  @ingroup XBT_dynar
  64  *
  65  *  @{
  66  */
  67    /** \brief Dynar data type (opaque type) */
  68 typedef struct xbt_dynar_s *xbt_dynar_t;
  69
  70
  71 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new(const unsigned long elm_size,
  72                                       void_f_pvoid_t const free_f);
  73 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new_sync(const unsigned long elm_size,
  74                                            void_f_pvoid_t const free_f);
  75 XBT_PUBLIC(void) xbt_dynar_free(xbt_dynar_t * dynar);
  76 XBT_PUBLIC(void) xbt_dynar_free_voidp(void *dynar);
  77 XBT_PUBLIC(void) xbt_dynar_free_container(xbt_dynar_t * dynar);
  78 XBT_PUBLIC(void) xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
  79 XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar);
  80
  81 /** @} */
  82 /** @defgroup XBT_dynar_array Dynar as a regular array
  83  *  @ingroup XBT_dynar
  84  *
  85  *  @{
  86  */
  87
  88 XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar,
  89                                    const unsigned long idx,
  90                                    void *const dst);
  91 XBT_PUBLIC(void) xbt_dynar_set(xbt_dynar_t dynar, const int idx,
  92                                const void *src);
  93 XBT_PUBLIC(void) xbt_dynar_replace(xbt_dynar_t dynar,
  94                                    const unsigned long idx,
  95                                    const void *object);
  96
  97 XBT_PUBLIC(void) xbt_dynar_insert_at(xbt_dynar_t const dynar,
  98                                      const int idx, const void *src);
  99 XBT_PUBLIC(void) xbt_dynar_remove_at(xbt_dynar_t const dynar,
 100                                      const int idx, void *const dst);
 101 XBT_PUBLIC(void) xbt_dynar_remove_n_at(xbt_dynar_t const dynar,
 102                                      const unsigned int n, const int idx);
 103
 104
 105 XBT_PUBLIC(unsigned int) xbt_dynar_search(xbt_dynar_t const dynar, void *elem);
 106 XBT_PUBLIC(signed int) xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem);
 107 XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
 108 XBT_PUBLIC(void) xbt_dynar_sort(xbt_dynar_t const dynar,
 109                                 int_f_cpvoid_cpvoid_t compar_fn);
 110 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
 111     int_f_pvoid_t color);
 112 XBT_PUBLIC(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
 113                                   int(*compar)(const void *, const void *));
 114 XBT_PUBLIC(void *) xbt_dynar_to_array (xbt_dynar_t dynar);
 115
 116 /** @} */
 117 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
 118  *  @ingroup XBT_dynar
 119  *
 120  *  @{
 121  */
 122
 123 XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
 124 XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar);
 125 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
 126 XBT_PUBLIC(void) xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2);
 127
 128 /** @} */
 129 /** @defgroup XBT_dynar_perl Perl-like use of dynars
 130  *  @ingroup XBT_dynar
 131  *
 132  *  @{
 133  */
 134
 135 XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, const void *src);
 136 XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst);
 137 XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar,
 138                                    const void *src);
 139 XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst);
 140 XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar,
 141                                void_f_pvoid_t const op);
 142
 143 /** @} */
 144 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
 145  *  @ingroup XBT_dynar
 146  *
 147  *  Those functions do not retrieve the content, but only their address.
 148  *
 149  *  @{
 150  */
 151
 152 XBT_PUBLIC(void *) xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
 153                                         const unsigned long idx);
 154 XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar,
 155                                      const unsigned long idx);
 156 XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
 157                                            const int idx);
 158 XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
 159 XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
 160
 161 /** @} */
 162 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
 163  *  @ingroup XBT_dynar
 164  *
 165  *  While the other functions use a memcpy to retrieve the content into the
 166  *  user provided area, those ones use a regular affectation. It only works
 167  *  for scalar values, but should be a little faster.
 168  *
 169  *  @{
 170  */
 171
 172   /** @brief Quick retrieval of scalar content
 173    *  @hideinitializer */
 174 #  define xbt_dynar_get_as(dynar,idx,type) \
 175           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
 176 /** @brief Quick setting of scalar content
 177  *  @hideinitializer */
 178 #  define xbt_dynar_set_as(dynar,idx,type,val) \
 179          (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val
 180   /** @brief Quick retrieval of scalar content
 181    *  @hideinitializer */
 182 #  define xbt_dynar_getlast_as(dynar,type) \
 183           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
 184   /** @brief Quick retrieval of scalar content
 185    *  @hideinitializer */
 186 #  define xbt_dynar_getfirst_as(dynar,type) \
 187           (*(type*)xbt_dynar_get_ptr((dynar),0))
 188   /** @brief Quick insertion of scalar content
 189    *  @hideinitializer */
 190 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
 191           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
 192   /** @brief Quick insertion of scalar content
 193    *  @hideinitializer */
 194 #  define xbt_dynar_push_as(dynar,type,value) \
 195           *(type*)xbt_dynar_push_ptr(dynar)=value
 196   /** @brief Quick removal of scalar content
 197    *  @hideinitializer */
 198 #  define xbt_dynar_pop_as(dynar,type) \
 199            (*(type*)xbt_dynar_pop_ptr(dynar))
 200
 201 /** @} */
 202 /** @defgroup XBT_dynar_cursor Cursors on dynar
 203  *  @ingroup XBT_dynar
 204  *
 205  * Cursors are used to iterate over the structure. Never add elements to the
 206  * DynArr during the traversal. To remove elements, use the
 207  * xbt_dynar_cursor_rm() function.
 208  *
 209  * Do not call these functions directly, but only the xbt_dynar_foreach macro.
 210  *
 211  * For synchronized dynars, the dynar will be locked during the whole
 212  * loop and it will get unlocked automatically if you traverse all
 213  * elements. If you want to break the loop before the end, make sure
 214  * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
 215  *
 216  *  @{
 217  */
 218
 219 XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 220                                      unsigned int *const cursor);
 221 XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
 222
 223 /* do not use this structure internals directly, but use the public interface
 224  * This was made public to allow:
 225  *  - the inlining of the foreach elements
 226  *  - sending such beasts over the network
 227  */
 228
 229 #include "xbt/synchro_core.h"
 230 typedef struct xbt_dynar_s {
 231   unsigned long size;
 232   unsigned long used;
 233   unsigned long elmsize;
 234   void *data;
 235   void_f_pvoid_t free_f;
 236 } s_xbt_dynar_t;
 237
 238 static XBT_INLINE void
 239 _xbt_dynar_cursor_first(const xbt_dynar_t dynar _XBT_GNUC_UNUSED,
 240                         unsigned int *const cursor)
 241 {
 242   /* iterating over a NULL dynar is a no-op (but we don't want to have uninitialized counters) */
 243
 244   //XBT_DEBUG("Set cursor on %p to the first position", (void *) dynar);
 245   *cursor = 0;
 246 }
 247
 248 static XBT_INLINE int
 249 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
 250                       unsigned int idx, void *const dst)
 251 {
 252   if (!dynar) /* iterating over a NULL dynar is a no-op */
 253     return FALSE;
 254
 255   if (idx >= dynar->used) {
 256     //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar);
 257     return FALSE;
 258   }
 259   //  XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx);
 260
 261   memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize,
 262          dynar->elmsize);
 263
 264   return TRUE;
 265 }
 266
 267
 268
 269 /** @brief Iterates over the whole dynar.
 270  *
 271  *  @param _dynar what to iterate over
 272  *  @param _cursor an integer used as cursor
 273  *  @param _data
 274  *  @hideinitializer
 275  *
 276  * Here is an example of usage:
 277  * \code
 278 xbt_dynar_t dyn;
 279 unsigned int cpt;
 280 string *str;
 281 xbt_dynar_foreach (dyn,cpt,str) {
 282   printf("Seen %s\n",str);
 283 }
 284 \endcode
 285  *
 286  * Note that underneath, that's a simple for loop with no real black
 287  * magic involved. It's perfectly safe to interrupt a foreach with a
 288  * break or a return statement.
 289  */
 290 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
 291        for (_xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
 292       _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
 293             (_cursor)++         )
 294
 295 /** @} */
 296
 297 SG_END_DECL()
 298 #endif                          /* _XBT_DYNAR_H */