]> git.sesse.net Git - bcachefs-tools-debian/blobdiff - libbcachefs/darray.h
Update bcachefs sources to 2a6125decb43 bcachefs: bch_sb_field_downgrade
[bcachefs-tools-debian] / libbcachefs / darray.h
index daf872ff0559e378552d1669912f2bcced481d8a..d867ee620bc1f041e0a3c67fb8eba3ad28560285 100644 (file)
-/*
- * Copyright (C) 2011 Joseph Adams <joeyadams3.14159@gmail.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
-
-#ifndef CCAN_DARRAY_H
-#define CCAN_DARRAY_H
-
-#include <stdlib.h>
-#include <string.h>
-#include "config.h"
+/* SPDX-License-Identifier: GPL-2.0 */
+#ifndef _BCACHEFS_DARRAY_H
+#define _BCACHEFS_DARRAY_H
 
 /*
- * SYNOPSIS
- *
- * Life cycle of a darray (dynamically-allocated array):
- *
- *     darray(int) a = darray_new();
- *     darray_free(a);
- *
- *     struct {darray(int) a;} foo;
- *     darray_init(foo.a);
- *     darray_free(foo.a);
- *
- * Typedefs for darrays of common types:
- *
- *     darray_char, darray_schar, darray_uchar
- *     darray_short, darray_int, darray_long
- *     darray_ushort, darray_uint, darray_ulong
- *
- * Access:
- *
- *     T      darray_item(darray(T) arr, size_t index);
- *     size_t darray_size(darray(T) arr);
- *     size_t darray_alloc(darray(T) arr);
- *     bool   darray_empty(darray(T) arr);
- *
- * Insertion (single item):
- *
- *     void   darray_append(darray(T) arr, T item);
- *     void   darray_prepend(darray(T) arr, T item);
- *     void   darray_push(darray(T) arr, T item); // same as darray_append
- *
- * Insertion (multiple items):
- *
- *     void   darray_append_items(darray(T) arr, T *items, size_t count);
- *     void   darray_prepend_items(darray(T) arr, T *items, size_t count);
- *
- *     void   darray_appends(darray(T) arr, [T item, [...]]);
- *     void   darray_prepends(darray(T) arr, [T item, [...]]);
- *
- *     // Same functionality as above, but does not require typeof.
- *     void   darray_appends_t(darray(T) arr, #T, [T item, [...]]);
- *     void   darray_prepends_t(darray(T) arr, #T, [T item, [...]]);
- *
- * Removal:
- *
- *     T      darray_pop(darray(T) arr | darray_size(arr) != 0);
- *     T*     darray_pop_check(darray(T*) arr);
- *     void   darray_remove(darray(T) arr, size_t index);
- *
- * Replacement:
- *
- *     void   darray_from_items(darray(T) arr, T *items, size_t count);
- *     void   darray_from_c(darray(T) arr, T c_array[N]);
- *
- * String buffer:
- *
- *     void   darray_append_string(darray(char) arr, const char *str);
- *     void   darray_append_lit(darray(char) arr, char stringLiteral[N+1]);
- *
- *     void   darray_prepend_string(darray(char) arr, const char *str);
- *     void   darray_prepend_lit(darray(char) arr, char stringLiteral[N+1]);
- *
- *     void   darray_from_string(darray(T) arr, const char *str);
- *     void   darray_from_lit(darray(char) arr, char stringLiteral[N+1]);
- *
- * Size management:
- *
- *     void   darray_resize(darray(T) arr, size_t newSize);
- *     void   darray_resize0(darray(T) arr, size_t newSize);
- *
- *     void   darray_realloc(darray(T) arr, size_t newAlloc);
- *     void   darray_growalloc(darray(T) arr, size_t newAlloc);
- *
- *     void   darray_make_room(darray(T) arr, size_t room);
+ * Dynamic arrays:
  *
- * Traversal:
- *
- *     darray_foreach(T *&i, darray(T) arr) {...}
- *     darray_foreach_reverse(T *&i, darray(T) arr) {...}
- *
- * Except for darray_foreach, darray_foreach_reverse, and darray_remove,
- * all macros evaluate their non-darray arguments only once.
+ * Inspired by CCAN's darray
  */
 
-/*** Life cycle ***/
-
-#define darray(type) struct {type *item; size_t size; size_t alloc;}
-
-#define darray_new() {0,0,0}
-#define darray_init(arr) do {(arr).item=0; (arr).size=0; (arr).alloc=0;} while(0)
-#define darray_free(arr) do {kfree((arr).item);} while(0)
-
-
-
-/*** Access ***/
-
-#define darray_item(arr, i) ((arr).item[i])
-#define darray_size(arr)    ((arr).size)
-#define darray_alloc(arr)   ((arr).alloc)
-#define darray_empty(arr)   ((arr).size == 0)
-
-
-/*** Insertion (single item) ***/
-
-#define darray_append(arr, ...) do { \
-               darray_resize(arr, (arr).size+1); \
-               (arr).item[(arr).size-1] = (__VA_ARGS__); \
-       } while(0)
-#define darray_prepend(arr, ...) do { \
-               darray_resize(arr, (arr).size+1); \
-               memmove((arr).item+1, (arr).item, ((arr).size-1)*sizeof(*(arr).item)); \
-               (arr).item[0] = (__VA_ARGS__); \
-       } while(0)
-#define darray_push(arr, ...) darray_append(arr, __VA_ARGS__)
-
-
-/*** Insertion (multiple items) ***/
-
-#define darray_append_items(arr, items, count) do { \
-               size_t __count = (count), __oldSize = (arr).size; \
-               darray_resize(arr, __oldSize + __count); \
-               memcpy((arr).item + __oldSize, items, __count * sizeof(*(arr).item)); \
-       } while(0)
-
-#define darray_prepend_items(arr, items, count) do { \
-               size_t __count = (count), __oldSize = (arr).size; \
-               darray_resize(arr, __count + __oldSize); \
-               memmove((arr).item + __count, (arr).item, __oldSize * sizeof(*(arr).item)); \
-               memcpy((arr).item, items, __count * sizeof(*(arr).item)); \
-       } while(0)
-
-#if HAVE_TYPEOF
-#define darray_appends(arr, ...) darray_appends_t(arr, typeof((*(arr).item)), __VA_ARGS__)
-#define darray_prepends(arr, ...) darray_prepends_t(arr, typeof((*(arr).item)), __VA_ARGS__)
-#endif
+#include <linux/slab.h>
 
-#define darray_appends_t(arr, type, ...) do { \
-               type __src[] = {__VA_ARGS__}; \
-               darray_append_items(arr, __src, sizeof(__src)/sizeof(*__src)); \
-       } while(0)
-#define darray_prepends_t(arr, type, ...) do { \
-               type __src[] = {__VA_ARGS__}; \
-               darray_prepend_items(arr, __src, sizeof(__src)/sizeof(*__src)); \
-       } while(0)
-
-
-/*** Removal ***/
-
-/* Warning: Do not call darray_pop on an empty darray. */
-#define darray_pop(arr) ((arr).item[--(arr).size])
-#define darray_pop_check(arr) ((arr).size ? darray_pop(arr) : NULL)
-/* Warning, slow: Requires copying all elements after removed item. */
-#define darray_remove(arr, index) do { \
-       if (index < arr.size-1)    \
-               memmove(&(arr).item[index], &(arr).item[index+1], ((arr).size-1-i)*sizeof(*(arr).item)); \
-       (arr).size--;  \
-       } while(0)
-
-
-/*** Replacement ***/
+#define DARRAY_PREALLOCATED(_type, _nr)                                        \
+struct {                                                               \
+       size_t nr, size;                                                \
+       _type *data;                                                    \
+       _type preallocated[_nr];                                        \
+}
 
-#define darray_from_items(arr, items, count) do {size_t __count = (count); darray_resize(arr, __count); memcpy((arr).item, items, __count*sizeof(*(arr).item));} while(0)
-#define darray_from_c(arr, c_array) darray_from_items(arr, c_array, sizeof(c_array)/sizeof(*(c_array)))
+#define DARRAY(_type) DARRAY_PREALLOCATED(_type, 0)
 
+typedef DARRAY(char)   darray_char;
+typedef DARRAY(char *) darray_str;
 
-/*** Size management ***/
+int __bch2_darray_resize(darray_char *, size_t, size_t, gfp_t);
 
-#define darray_resize(arr, newSize) darray_growalloc(arr, (arr).size = (newSize))
-#define darray_resize0(arr, newSize) do { \
-               size_t __oldSize = (arr).size, __newSize = (newSize); \
-               (arr).size = __newSize; \
-               if (__newSize > __oldSize) { \
-                       darray_growalloc(arr, __newSize); \
-                       memset(&(arr).item[__oldSize], 0, (__newSize - __oldSize) * sizeof(*(arr).item)); \
-               } \
-       } while(0)
+static inline int __darray_resize(darray_char *d, size_t element_size,
+                                 size_t new_size, gfp_t gfp)
+{
+       return unlikely(new_size > d->size)
+               ? __bch2_darray_resize(d, element_size, new_size, gfp)
+               : 0;
+}
 
-#define darray_realloc(arr, newAlloc) do { \
-               (arr).item = realloc((arr).item, ((arr).alloc = (newAlloc)) * sizeof(*(arr).item)); \
-       } while(0)
-#define darray_growalloc(arr, need) do { \
-               size_t __need = (need); \
-               if (__need > (arr).alloc) \
-                       darray_realloc(arr, darray_next_alloc((arr).alloc, __need)); \
-       } while(0)
+#define darray_resize_gfp(_d, _new_size, _gfp)                         \
+       unlikely(__darray_resize((darray_char *) (_d), sizeof((_d)->data[0]), (_new_size), _gfp))
 
-#if HAVE_STATEMENT_EXPR==1
-#define darray_make_room(arr, room) ({size_t newAlloc = (arr).size+(room); if ((arr).alloc<newAlloc) darray_realloc(arr, newAlloc); (arr).item+(arr).size; })
-#endif
+#define darray_resize(_d, _new_size)                                   \
+       darray_resize_gfp(_d, _new_size, GFP_KERNEL)
 
-static inline size_t darray_next_alloc(size_t alloc, size_t need)
+static inline int __darray_make_room(darray_char *d, size_t t_size, size_t more, gfp_t gfp)
 {
-       return roundup_pow_of_two(alloc + need);
+       return __darray_resize(d, t_size, d->nr + more, gfp);
 }
 
+#define darray_make_room_gfp(_d, _more, _gfp)                          \
+       __darray_make_room((darray_char *) (_d), sizeof((_d)->data[0]), (_more), _gfp)
 
-/*** Traversal ***/
+#define darray_make_room(_d, _more)                                    \
+       darray_make_room_gfp(_d, _more, GFP_KERNEL)
 
-/*
- * darray_foreach(T *&i, darray(T) arr) {...}
- *
- * Traverse a darray.  `i` must be declared in advance as a pointer to an item.
- */
-#define darray_foreach(i, arr) \
-       for ((i) = &(arr).item[0]; (i) < &(arr).item[(arr).size]; (i)++)
-
-/*
- * darray_foreach_reverse(T *&i, darray(T) arr) {...}
- *
- * Like darray_foreach, but traverse in reverse order.
- */
-#define darray_foreach_reverse(i, arr) \
-       for ((i) = &(arr).item[(arr).size]; (i)-- > &(arr).item[0]; )
+#define darray_room(_d)                ((_d).size - (_d).nr)
 
+#define darray_top(_d)         ((_d).data[(_d).nr])
 
-#endif /* CCAN_DARRAY_H */
+#define darray_push_gfp(_d, _item, _gfp)                               \
+({                                                                     \
+       int _ret = darray_make_room_gfp((_d), 1, _gfp);                 \
+                                                                       \
+       if (!_ret)                                                      \
+               (_d)->data[(_d)->nr++] = (_item);                       \
+       _ret;                                                           \
+})
 
-/*
+#define darray_push(_d, _item) darray_push_gfp(_d, _item, GFP_KERNEL)
 
-darray_growalloc(arr, newAlloc) sees if the darray can currently hold newAlloc items;
-       if not, it increases the alloc to satisfy this requirement, allocating slack
-       space to avoid having to reallocate for every size increment.
+#define darray_pop(_d)         ((_d)->data[--(_d)->nr])
 
-darray_from_string(arr, str) copies a string to an darray_char.
+#define darray_first(_d)       ((_d).data[0])
+#define darray_last(_d)                ((_d).data[(_d).nr - 1])
 
-darray_push(arr, item) pushes an item to the end of the darray.
-darray_pop(arr) pops it back out.  Be sure there is at least one item in the darray before calling.
-darray_pop_check(arr) does the same as darray_pop, but returns NULL if there are no more items left in the darray.
+#define darray_insert_item(_d, pos, _item)                             \
+({                                                                     \
+       size_t _pos = (pos);                                            \
+       int _ret = darray_make_room((_d), 1);                           \
+                                                                       \
+       if (!_ret)                                                      \
+               array_insert_item((_d)->data, (_d)->nr, _pos, (_item)); \
+       _ret;                                                           \
+})
 
-darray_make_room(arr, room) ensures there's 'room' elements of space after the end of the darray, and it returns a pointer to this space.
-Currently requires HAVE_STATEMENT_EXPR, but I plan to remove this dependency by creating an inline function.
+#define darray_remove_item(_d, _pos)                                   \
+       array_remove_item((_d)->data, (_d)->nr, (_pos) - (_d)->data)
 
-The following require HAVE_TYPEOF==1 :
+#define __darray_for_each(_d, _i)                                              \
+       for ((_i) = (_d).data; _i < (_d).data + (_d).nr; _i++)
 
-darray_appends(arr, item0, item1...) appends a collection of comma-delimited items to the darray.
-darray_prepends(arr, item0, item1...) prepends a collection of comma-delimited items to the darray.\
+#define darray_for_each(_d, _i)                                                \
+       for (typeof(&(_d).data[0]) _i = (_d).data; _i < (_d).data + (_d).nr; _i++)
 
+#define darray_for_each_reverse(_d, _i)                                        \
+       for (typeof(&(_d).data[0]) _i = (_d).data + (_d).nr - 1; _i >= (_d).data; --_i)
 
-Examples:
+#define darray_init(_d)                                                        \
+do {                                                                   \
+       (_d)->nr = 0;                                                   \
+       (_d)->size = ARRAY_SIZE((_d)->preallocated);                    \
+       (_d)->data = (_d)->size ? (_d)->preallocated : NULL;            \
+} while (0)
 
-       darray(int)  arr;
-       int        *i;
-       
-       darray_appends(arr, 0,1,2,3,4);
-       darray_appends(arr, -5,-4,-3,-2,-1);
-       darray_foreach(i, arr)
-               printf("%d ", *i);
-       printf("\n");
-       
-       darray_free(arr);
-       
+#define darray_exit(_d)                                                        \
+do {                                                                   \
+       if (!ARRAY_SIZE((_d)->preallocated) ||                          \
+           (_d)->data != (_d)->preallocated)                           \
+               kvfree((_d)->data);                                     \
+       darray_init(_d);                                                \
+} while (0)
 
-       typedef struct {int n,d;} Fraction;
-       darray(Fraction) fractions;
-       Fraction        *i;
-       
-       darray_appends(fractions, {3,4}, {3,5}, {2,1});
-       darray_foreach(i, fractions)
-               printf("%d/%d\n", i->n, i->d);
-       
-       darray_free(fractions);
-*/
+#endif /* _BCACHEFS_DARRAY_H */