2 * @brief ldap bdb back-end 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-2012 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>.
31 /** @defgroup internal MDB Internals
35 /** @defgroup idls ID List Management
38 /** A generic ID number. These were entryIDs in back-bdb.
39 * It should be the largest integer type supported on a machine.
40 * It should be equal to the size of a pointer.
44 /** An IDL is an ID List, a sorted array of IDs. The first
45 * element of the array is a counter for how many actual
46 * IDs are in the list. In the original back-bdb code, IDLs are
47 * sorted in ascending order. For libmdb IDLs are sorted in
54 /* IDL sizes - likely should be even bigger
55 * limiting factors: sizeof(ID), thread stack size
57 #define MDB_IDL_LOGN 16 /* DB_SIZE is 2^16, UM_SIZE is 2^17 */
58 #define MDB_IDL_DB_SIZE (1<<MDB_IDL_LOGN)
59 #define MDB_IDL_UM_SIZE (1<<(MDB_IDL_LOGN+1))
60 #define MDB_IDL_UM_SIZEOF (MDB_IDL_UM_SIZE * sizeof(ID))
62 #define MDB_IDL_DB_MAX (MDB_IDL_DB_SIZE-1)
64 #define MDB_IDL_UM_MAX (MDB_IDL_UM_SIZE-1)
66 #define MDB_IDL_IS_RANGE(ids) ((ids)[0] == NOID)
67 #define MDB_IDL_RANGE_SIZE (3)
68 #define MDB_IDL_RANGE_SIZEOF (MDB_IDL_RANGE_SIZE * sizeof(ID))
69 #define MDB_IDL_SIZEOF(ids) ((MDB_IDL_IS_RANGE(ids) \
70 ? MDB_IDL_RANGE_SIZE : ((ids)[0]+1)) * sizeof(ID))
72 #define MDB_IDL_RANGE_FIRST(ids) ((ids)[1])
73 #define MDB_IDL_RANGE_LAST(ids) ((ids)[2])
75 #define MDB_IDL_RANGE( ids, f, l ) \
82 #define MDB_IDL_ZERO(ids) \
89 #define MDB_IDL_IS_ZERO(ids) ( (ids)[0] == 0 )
90 #define MDB_IDL_IS_ALL( range, ids ) ( (ids)[0] == NOID \
91 && (ids)[1] <= (range)[1] && (range)[2] <= (ids)[2] )
93 #define MDB_IDL_CPY( dst, src ) (memcpy( dst, src, MDB_IDL_SIZEOF( src ) ))
95 #define MDB_IDL_ID( bdb, ids, id ) MDB_IDL_RANGE( ids, id, ((bdb)->bi_lastid) )
96 #define MDB_IDL_ALL( bdb, ids ) MDB_IDL_RANGE( ids, 1, ((bdb)->bi_lastid) )
98 #define MDB_IDL_FIRST( ids ) ( (ids)[1] )
99 #define MDB_IDL_LAST( ids ) ( MDB_IDL_IS_RANGE(ids) \
100 ? (ids)[2] : (ids)[(ids)[0]] )
102 #define MDB_IDL_N( ids ) ( MDB_IDL_IS_RANGE(ids) \
103 ? ((ids)[2]-(ids)[1])+1 : (ids)[0] )
105 #if 0 /* superseded by append/sort */
106 /** Insert an ID into an IDL.
107 * @param[in,out] ids The IDL to insert into.
108 * @param[in] id The ID to insert.
109 * @return 0 on success, -1 if the ID was already present in the IDL.
111 int mdb_midl_insert( IDL ids, ID id );
115 * Allocates memory for an IDL of a default size.
116 * @return IDL on success, NULL on failure.
118 IDL mdb_midl_alloc();
121 * @param[in] ids The IDL to free.
123 void mdb_midl_free(IDL ids);
126 * Return the IDL to the default size if it has grown larger.
127 * @param[in,out] idp Address of the IDL to shrink.
128 * @return 0 on no change, non-zero if shrunk.
130 int mdb_midl_shrink(IDL *idp);
132 /** Append an ID onto an IDL.
133 * @param[in,out] idp Address of the IDL to append to.
134 * @param[in] id The ID to append.
135 * @return 0 on success, -1 if the IDL is too large.
137 int mdb_midl_append( IDL *idp, ID id );
139 /** Append an IDL onto an IDL.
140 * @param[in,out] idp Address of the IDL to append to.
141 * @param[in] app The IDL to append.
142 * @return 0 on success, -1 if the IDL is too large.
144 int mdb_midl_append_list( IDL *idp, IDL app );
147 * @param[in,out] ids The IDL to sort.
149 void mdb_midl_sort( IDL ids );
151 /** An ID2 is an ID/pointer pair.
154 ID mid; /**< The ID */
155 void *mptr; /**< The pointer */
158 /** An ID2L is an ID2 List, a sorted array of ID2s.
159 * The first element's \b mid member is a count of how many actual
160 * elements are in the array. The \b mptr member of the first element is unused.
161 * The array is sorted in ascending order by \b mid.
165 /** Search for an ID in an ID2L.
166 * @param[in] ids The ID2L to search.
167 * @param[in] id The ID to search for.
168 * @return The index of the first ID2 whose \b mid member is greater than or equal to \b id.
170 unsigned mdb_mid2l_search( ID2L ids, ID id );
173 /** Insert an ID2 into a ID2L.
174 * @param[in,out] ids The ID2L to insert into.
175 * @param[in] id The ID2 to insert.
176 * @return 0 on success, -1 if the ID was already present in the ID2L.
178 int mdb_mid2l_insert( ID2L ids, ID2 *id );
182 #endif /* _MDB_MIDL_H_ */