-/* $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. */
#ifndef _XBT_DYNAR_H
#define _XBT_DYNAR_H
-#include "xbt/misc.h" /* SG_BEGIN_DECL */
+#include <string.h> /* memcpy */
+
+#include "xbt/misc.h" /* SG_BEGIN_DECL */
#include "xbt/function_types.h"
SG_BEGIN_DECL()
*
* \section XBT_dynar_exptr Example with pointed data
*
- * \skip doxygen_string_cruft
- * \skip function
+ * \skip test_dynar_string
+ * \skip dynar_t
* \until s2
* \skip Populate_str
* \skip dyn
* \until }
*
*/
-
/** @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;
+
+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_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_PUBLIC(void) xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
+XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar);
+
+/** @} */
+/** @defgroup XBT_dynar_array Dynar as a regular array
+ * @ingroup XBT_dynar
+ *
+ * @{
+ */
- 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_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_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,
+ const unsigned long idx,
+ const void *object);
- XBT_PUBLIC(unsigned long) xbt_dynar_length(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_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_dump(xbt_dynar_t dynar);
+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_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_array Dynar as a regular array
+/** @defgroup XBT_dynar_misc Dynar miscellaneous functions
* @ingroup XBT_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, const unsigned long idx, const void *object);
+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_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(int) xbt_dynar_search(xbt_dynar_t const dynar, void *elem);
- XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
/** @} */
/** @defgroup XBT_dynar_perl Perl-like use of dynars
* @ingroup XBT_dynar
* @{
*/
- 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);
- XBT_PUBLIC(void) xbt_dynar_map (const xbt_dynar_t dynar, void_f_pvoid_t const op);
+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);
+XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar,
+ void_f_pvoid_t const op);
/** @} */
/** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
* @{
*/
- 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);
+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);
+XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
/** @} */
/** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
* @hideinitializer */
# define xbt_dynar_get_as(dynar,idx,type) \
(*(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_set_at_ptr((dynar),(idx))) = val
/** @brief Quick retrieval of scalar content
* @hideinitializer */
# define xbt_dynar_getlast_as(dynar,type) \
* @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))
* @{
*/
- XBT_PUBLIC(void) _xbt_dynar_cursor_first (const xbt_dynar_t dynar, unsigned int * const cursor);
- XBT_PUBLIC(void) _xbt_dynar_cursor_step (const xbt_dynar_t dynar, unsigned int * const cursor);
- XBT_PUBLIC(int) _xbt_dynar_cursor_get (const xbt_dynar_t dynar, unsigned int * const cursor,
- void *whereto);
- 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);
+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);
+
+ //XBT_DEBUG("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) {
+ //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar);
+ if (dynar->mutex) /* unlock */
+ xbt_mutex_release(dynar->mutex);
+ return FALSE;
+ }
+ // XBT_DEBUG("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.
*
*/
#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)) )
+ _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
+ (_cursor)++ )
/** @} */
SG_END_DECL()
-
-#endif /* _XBT_DYNAR_H */
+#endif /* _XBT_DYNAR_H */
