-/* Array --- dynamic & flexible arrays.
- Copyright (C) 1995, 1996 Markus Armbruster
- All rights reserved. */
+/*
+ * This file is part of libFirm.
+ * Copyright (C) 2012 University of Karlsruhe.
+ */
-#ifdef HAVE_CONFIG_H
-# include <config.h>
-#endif
+/**
+ * @file
+ * @brief Array --- dynamic & flexible arrays.
+ * @author Markus Armbruster
+ */
+
+#include "config.h"
#include <stdlib.h>
-#include "array.h"
+
+#include "array_t.h"
+#include "util.h"
+#include "xmalloc.h"
/* Undefine the macros to get the functions instead, cf tmalloc.c. */
#undef xmalloc
#undef xstrdup
#undef xfree
+/**
+ * An empty dynamic array descriptor.
+ */
+ir_arr_descr arr_mt_descr = { ARR_D_MAGIC, 0, 0, { { 0 } } };
-_arr_descr arr_mt_descr
+void ir_verify_arr(const void *arr)
+{
#ifndef NDEBUG
- = { ARR_D_MAGIC }
+ ir_arr_descr *descr = ARR_DESCR(arr);
+ assert(descr->magic == ARR_D_MAGIC || descr->magic == ARR_A_MAGIC
+ || descr->magic == ARR_F_MAGIC);
+ assert(descr->magic != ARR_F_MAGIC || descr->allocated >= descr->nelts);
+#else
+ (void) arr;
#endif
-;
+}
-void *
-_new_arr_d (struct obstack *obstack, int nelts, size_t elts_size)
+/**
+ * Creates a dynamic array on a obstack.
+ *
+ * @param obstack An struct obstack * were the data will be allocated
+ * @param nelts The number of elements
+ * @param elts_size The size of the array elements.
+ *
+ * @return A pointer to the dynamic array (can be used as a pointer to the
+ * first element of this array).
+ *
+ * @remark Helper function, use NEW_ARR_D() instead.
+ */
+void *ir_new_arr_d(struct obstack *obstack, size_t nelts, size_t elts_size)
{
- _arr_descr *new;
+ ir_arr_descr *dp;
- assert (obstack && (nelts >= 0));
+ assert(obstack);
- new = obstack_alloc (obstack, _ARR_ELTS_OFFS+elts_size);
- _ARR_SET_DBGINF (new, ARR_D_MAGIC, elts_size/nelts);
- new->u.obstack = obstack;
- new->nelts = nelts;
- return new->v.elts;
+ dp = (ir_arr_descr*)obstack_alloc(obstack, ARR_ELTS_OFFS + elts_size);
+ ARR_SET_DBGINF(dp, ARR_D_MAGIC);
+ dp->allocated = dp->nelts = nelts;
+ return dp->elts;
}
-
-void *
-_new_arr_f (int nelts, size_t elts_size)
+/**
+ * Creates a flexible array.
+ *
+ * @param nelts The number of elements
+ * @param elts_size The size of the array elements.
+ *
+ * @return A pointer to the flexible array (can be used as a pointer to the
+ * first element of this array).
+ *
+ * @remark Helper function, use NEW_ARR_F() instead.
+ */
+void *ir_new_arr_f(size_t nelts, size_t elts_size)
{
- _arr_descr *new;
+ ir_arr_descr *newa;
- assert (nelts >= 0);
- new = xmalloc (_ARR_ELTS_OFFS+elts_size);
- _ARR_SET_DBGINF (new, ARR_F_MAGIC, nelts ? elts_size/nelts : 0);
- new->u.allocated = new->nelts = nelts;
- return new->v.elts;
+ newa = (ir_arr_descr*)xmalloc(ARR_ELTS_OFFS+elts_size);
+ ARR_SET_DBGINF(newa, ARR_F_MAGIC);
+ newa->allocated = newa->nelts = nelts;
+ return newa->elts;
}
-
-void
-_del_arr_f (void *elts)
+/**
+ * Delete a flexible array.
+ *
+ * @param elts The flexible array (pointer to the first element).
+ *
+ * @remark Helper function, use DEL_ARR_F() instead.
+ */
+void ir_del_arr_f(void *elts)
{
- _arr_descr *dp = _ARR_DESCR (elts);
+ ir_arr_descr *dp = ARR_DESCR (elts);
- ARR_VRFY (elts);
- assert (dp->cookie == ARR_F_MAGIC);
+ ARR_VRFY(elts);
+ assert(dp->magic == ARR_F_MAGIC);
#ifndef NDEBUG
- dp->cookie = 0xdeadbeef;
+ dp->magic = 0xdeadbeef;
#endif
- free (dp);
+ free(dp);
}
-
-void *
-_arr_setlen (void *elts, int nelts, size_t elts_size)
+/**
+ * Resize a flexible array, always reallocate data.
+ *
+ * @param elts The flexible array (pointer to the first element).
+ * @param nelts The new number of elements.
+ * @param elts_size The size of the array elements.
+ *
+ * @return A resized flexible array, possibly other address than
+ * elts.
+ *
+ * @remark Helper function, use ARR_SETLEN() instead.
+ */
+void *ir_arr_setlen (void *elts, size_t nelts, size_t elts_size)
{
- _arr_descr *dp = _ARR_DESCR (elts);
+ ir_arr_descr *dp = ARR_DESCR (elts);
- assert ((dp->cookie == ARR_F_MAGIC) && (nelts >= 0));
- ARR_VRFY (elts);
- assert (!dp->eltsize || !nelts || (dp->eltsize == elts_size/nelts));
+ assert(dp->magic == ARR_F_MAGIC);
+ ARR_VRFY(elts);
- dp = xrealloc (dp, _ARR_ELTS_OFFS+elts_size);
- dp->u.allocated = dp->nelts = nelts;
+ dp = (ir_arr_descr*) xrealloc(dp, ARR_ELTS_OFFS+elts_size);
+ dp->allocated = dp->nelts = nelts;
- return dp->v.elts;
+ return dp->elts;
}
+/**
+ * Resize a flexible array, allocate more data if needed but do NOT
+ * reduce.
+ *
+ * @param elts The flexible array (pointer to the first element).
+ * @param nelts The new number of elements.
+ * @param eltsize The size of the array elements.
+ *
+ * @return A resized flexible array, possibly other address than
+ * elts.
+ *
+ * @remark Helper function, use ARR_RESIZE() instead.
+ */
+void *ir_arr_resize(void *elts, size_t nelts, size_t eltsize)
+{
+ ir_arr_descr *dp = ARR_DESCR(elts);
+ size_t n;
-void *
-_arr_resize (void *elts, int nelts, size_t eltsize)
+ assert(dp->magic == ARR_F_MAGIC);
+ ARR_VRFY(elts);
+
+ /* @@@ lots of resizes for small nelts */
+ n = MAX(1, dp->allocated);
+ while (nelts > n) n <<= 1;
+ while (3*nelts < n) n >>= 1;
+ assert(n >= nelts);
+
+ if (n != dp->allocated) {
+ dp = (ir_arr_descr*) xrealloc(dp, ARR_ELTS_OFFS+eltsize*n);
+ dp->allocated = n;
+ }
+ dp->nelts = nelts;
+
+ return dp->elts;
+}
+
+#ifdef DEBUG_libfirm
+/* forward declarations to avoid warnings */
+size_t array_len(const void *arr);
+ir_arr_descr *array_descr(const void *arr);
+
+/**
+ * This function returns the length of a flexible array.
+ * Do NOT use is in code, use ARR_LEN() macro!
+ * This function is intended to be called from a debugger.
+ */
+size_t array_len(const void *arr)
{
- _arr_descr *dp = _ARR_DESCR (elts);
- int n;
-
- assert ((dp->cookie == ARR_F_MAGIC) && (nelts >= 0));
- ARR_VRFY (elts);
- assert (dp->eltsize ? dp->eltsize == eltsize : (dp->eltsize = eltsize, 1));
-
- /* @@@ lots of resizes for small nelts */
- n = MAX (1, dp->u.allocated);
- while (nelts > n) n <<= 1;
- while (3*nelts < n) n >>= 1;
- assert (n >= nelts);
-
- if (n != dp->u.allocated) {
- dp = xrealloc (dp, _ARR_ELTS_OFFS+eltsize*n);
- dp->u.allocated = n;
-#if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
- } else {
- tmalloc_tag = NULL;
-#endif
- }
- dp->nelts = nelts;
+ return ARR_LEN(arr);
+}
- return dp->v.elts;
+/**
+ * This function returns the array descriptor of a flexible array.
+ * Do NOT use is in code!.
+ * This function is intended to be called from a debugger.
+ */
+ir_arr_descr *array_descr(const void *arr)
+{
+ if (! arr)
+ return NULL;
+ return ARR_DESCR(arr);
}
+#endif /* DEBUG_libfirm */
projects / libfirm / blobdiff