2 * @brief mdb ID List header file.
4 * This file was originally part of back-bdb but has been
5 * modified for use in libmdb. Most of the macros defined
6 * in this file are unused, just left over from the original.
8 * This file is only used internally in libmdb and its definitions
9 * are not exposed publicly.
12 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
14 * Copyright 2000-2014 The OpenLDAP Foundation.
15 * All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted only as authorized by the OpenLDAP
21 * A copy of this license is available in the file LICENSE in the
22 * top-level directory of the distribution or, alternatively, at
23 * <http://www.OpenLDAP.org/license.html>.
35 /** @defgroup internal MDB Internals
39 /** @defgroup idls ID List Management
42 /** A generic unsigned ID number. These were entryIDs in back-bdb.
43 * Preferably it should have the same size as a pointer.
45 typedef size_t MDB_ID;
47 /** An IDL is an ID List, a sorted array of IDs. The first
48 * element of the array is a counter for how many actual
49 * IDs are in the list. In the original back-bdb code, IDLs are
50 * sorted in ascending order. For libmdb IDLs are sorted in
53 typedef MDB_ID *MDB_IDL;
55 /* IDL sizes - likely should be even bigger
56 * limiting factors: sizeof(ID), thread stack size
58 #define MDB_IDL_LOGN 16 /* DB_SIZE is 2^16, UM_SIZE is 2^17 */
59 #define MDB_IDL_DB_SIZE (1<<MDB_IDL_LOGN)
60 #define MDB_IDL_UM_SIZE (1<<(MDB_IDL_LOGN+1))
62 #define MDB_IDL_DB_MAX (MDB_IDL_DB_SIZE-1)
63 #define MDB_IDL_UM_MAX (MDB_IDL_UM_SIZE-1)
65 #define MDB_IDL_SIZEOF(ids) (((ids)[0]+1) * sizeof(MDB_ID))
66 #define MDB_IDL_IS_ZERO(ids) ( (ids)[0] == 0 )
67 #define MDB_IDL_CPY( dst, src ) (memcpy( dst, src, MDB_IDL_SIZEOF( src ) ))
68 #define MDB_IDL_FIRST( ids ) ( (ids)[1] )
69 #define MDB_IDL_LAST( ids ) ( (ids)[(ids)[0]] )
71 /** Append ID to IDL. The IDL must be big enough. */
72 #define mdb_midl_xappend(idl, id) do { \
73 MDB_ID *xidl = (idl), xlen = ++(xidl[0]); \
77 /** Search for an ID in an IDL.
78 * @param[in] ids The IDL to search.
79 * @param[in] id The ID to search for.
80 * @return The index of the first ID greater than or equal to \b id.
82 unsigned mdb_midl_search( MDB_IDL ids, MDB_ID id );
85 * Allocates memory for an IDL of the given size.
86 * @return IDL on success, NULL on failure.
88 MDB_IDL mdb_midl_alloc(int num);
91 * @param[in] ids The IDL to free.
93 void mdb_midl_free(MDB_IDL ids);
96 * Return the IDL to the default size if it has grown larger.
97 * @param[in,out] idp Address of the IDL to shrink.
98 * @return 0 on no change, non-zero if shrunk.
100 int mdb_midl_shrink(MDB_IDL *idp);
102 /** Make room for num additional elements in an IDL.
103 * @param[in,out] idp Address of the IDL.
104 * @param[in] num Number of elements to make room for.
105 * @return 0 on success, ENOMEM on failure.
107 int mdb_midl_need(MDB_IDL *idp, unsigned num);
109 /** Append an ID onto an IDL.
110 * @param[in,out] idp Address of the IDL to append to.
111 * @param[in] id The ID to append.
112 * @return 0 on success, ENOMEM if the IDL is too large.
114 int mdb_midl_append( MDB_IDL *idp, MDB_ID id );
116 /** Append an IDL onto an IDL.
117 * @param[in,out] idp Address of the IDL to append to.
118 * @param[in] app The IDL to append.
119 * @return 0 on success, ENOMEM if the IDL is too large.
121 int mdb_midl_append_list( MDB_IDL *idp, MDB_IDL app );
123 /** Append an ID range onto an IDL.
124 * @param[in,out] idp Address of the IDL to append to.
125 * @param[in] id The lowest ID to append.
126 * @param[in] n Number of IDs to append.
127 * @return 0 on success, ENOMEM if the IDL is too large.
129 int mdb_midl_append_range( MDB_IDL *idp, MDB_ID id, unsigned n );
132 * @param[in,out] ids The IDL to sort.
134 void mdb_midl_sort( MDB_IDL ids );
136 /** An ID2 is an ID/pointer pair.
138 typedef struct MDB_ID2 {
139 MDB_ID mid; /**< The ID */
140 void *mptr; /**< The pointer */
143 /** An ID2L is an ID2 List, a sorted array of ID2s.
144 * The first element's \b mid member is a count of how many actual
145 * elements are in the array. The \b mptr member of the first element is unused.
146 * The array is sorted in ascending order by \b mid.
148 typedef MDB_ID2 *MDB_ID2L;
150 /** Search for an ID in an ID2L.
151 * @param[in] ids The ID2L to search.
152 * @param[in] id The ID to search for.
153 * @return The index of the first ID2 whose \b mid member is greater than or equal to \b id.
155 unsigned mdb_mid2l_search( MDB_ID2L ids, MDB_ID id );
158 /** Insert an ID2 into a ID2L.
159 * @param[in,out] ids The ID2L to insert into.
160 * @param[in] id The ID2 to insert.
161 * @return 0 on success, -1 if the ID was already present in the ID2L.
163 int mdb_mid2l_insert( MDB_ID2L ids, MDB_ID2 *id );
165 /** Append an ID2 into a ID2L.
166 * @param[in,out] ids The ID2L to append into.
167 * @param[in] id The ID2 to append.
168 * @return 0 on success, -2 if the ID2L is too big.
170 int mdb_mid2l_append( MDB_ID2L ids, MDB_ID2 *id );
177 #endif /* _MDB_MIDL_H_ */