midl.h 5.58 KB
Newer Older
1
/**	@file midl.h
Howard Chu's avatar
Howard Chu committed
2
 *	@brief LMDB ID List header file.
3
4
5
6
7
8
9
10
 *
 *	This file was originally part of back-bdb but has been
 *	modified for use in libmdb. Most of the macros defined
 *	in this file are unused, just left over from the original.
 *
 *	This file is only used internally in libmdb and its definitions
 *	are not exposed publicly.
 */
Howard Chu's avatar
Howard Chu committed
11
12
13
/* $OpenLDAP$ */
/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
 *
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
14
15
 * Copyright 2000-2020 The OpenLDAP Foundation.
 * Portions Copyright 2001-2020 Howard Chu, Symas Corp.
Howard Chu's avatar
Howard Chu committed
16
17
18
19
20
21
22
23
24
25
26
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted only as authorized by the OpenLDAP
 * Public License.
 *
 * A copy of this license is available in the file LICENSE in the
 * top-level directory of the distribution or, alternatively, at
 * <http://www.OpenLDAP.org/license.html>.
 */

Howard Chu's avatar
Howard Chu committed
27
28
#ifndef _MDB_MIDL_H_
#define _MDB_MIDL_H_
Howard Chu's avatar
Howard Chu committed
29

30
31
#include <stddef.h>

32
33
34
35
#ifdef __cplusplus
extern "C" {
#endif

Howard Chu's avatar
Howard Chu committed
36
/** @defgroup internal	LMDB Internals
37
38
 *	@{
 */
39

40
41
42
/** @defgroup idls	ID List Management
 *	@{
 */
43
	/** A generic unsigned ID number. These were entryIDs in back-bdb.
44
	 *	Preferably it should have the same size as a pointer.
45
	 */
46
typedef size_t MDB_ID;
47
48
49
50
51
52
53

	/** An IDL is an ID List, a sorted array of IDs. The first
	 * element of the array is a counter for how many actual
	 * IDs are in the list. In the original back-bdb code, IDLs are
	 * sorted in ascending order. For libmdb IDLs are sorted in
	 * descending order.
	 */
54
typedef MDB_ID *MDB_IDL;
55

Howard Chu's avatar
Howard Chu committed
56
57
58
59
60
61
62
63
64
65
/* IDL sizes - likely should be even bigger
 *   limiting factors: sizeof(ID), thread stack size
 */
#define	MDB_IDL_LOGN	16	/* DB_SIZE is 2^16, UM_SIZE is 2^17 */
#define MDB_IDL_DB_SIZE		(1<<MDB_IDL_LOGN)
#define MDB_IDL_UM_SIZE		(1<<(MDB_IDL_LOGN+1))

#define MDB_IDL_DB_MAX		(MDB_IDL_DB_SIZE-1)
#define MDB_IDL_UM_MAX		(MDB_IDL_UM_SIZE-1)

66
#define MDB_IDL_SIZEOF(ids)		(((ids)[0]+1) * sizeof(MDB_ID))
Howard Chu's avatar
Howard Chu committed
67
#define MDB_IDL_IS_ZERO(ids) ( (ids)[0] == 0 )
Howard Chu's avatar
Howard Chu committed
68
#define MDB_IDL_CPY( dst, src ) (memcpy( dst, src, MDB_IDL_SIZEOF( src ) ))
69
#define MDB_IDL_FIRST( ids )	( (ids)[1] )
70
#define MDB_IDL_LAST( ids )		( (ids)[(ids)[0]] )
Howard Chu's avatar
Howard Chu committed
71

72
73
74
	/** Current max length of an #mdb_midl_alloc()ed IDL */
#define MDB_IDL_ALLOCLEN( ids )	( (ids)[-1] )

Hallvard Furuseth's avatar
Hallvard Furuseth committed
75
76
77
78
79
80
	/** Append ID to IDL. The IDL must be big enough. */
#define mdb_midl_xappend(idl, id) do { \
		MDB_ID *xidl = (idl), xlen = ++(xidl[0]); \
		xidl[xlen] = (id); \
	} while (0)

Howard Chu's avatar
Howard Chu committed
81
82
83
84
	/** Search for an ID in an IDL.
	 * @param[in] ids	The IDL to search.
	 * @param[in] id	The ID to search for.
	 * @return	The index of the first ID greater than or equal to \b id.
85
	 */
Howard Chu's avatar
Howard Chu committed
86
unsigned mdb_midl_search( MDB_IDL ids, MDB_ID id );
87

Howard Chu's avatar
Howard Chu committed
88
	/** Allocate an IDL.
89
	 * Allocates memory for an IDL of the given size.
Howard Chu's avatar
Howard Chu committed
90
91
	 * @return	IDL on success, NULL on failure.
	 */
92
MDB_IDL mdb_midl_alloc(int num);
Howard Chu's avatar
Howard Chu committed
93
94
95
96

	/** Free an IDL.
	 * @param[in] ids	The IDL to free.
	 */
97
void mdb_midl_free(MDB_IDL ids);
Howard Chu's avatar
Howard Chu committed
98
99
100
101
102

	/** Shrink an IDL.
	 * Return the IDL to the default size if it has grown larger.
	 * @param[in,out] idp	Address of the IDL to shrink.
	 */
103
void mdb_midl_shrink(MDB_IDL *idp);
Howard Chu's avatar
Howard Chu committed
104

Hallvard Furuseth's avatar
Hallvard Furuseth committed
105
106
107
108
	/** Make room for num additional elements in an IDL.
	 * @param[in,out] idp	Address of the IDL.
	 * @param[in] num	Number of elements to make room for.
	 * @return	0 on success, ENOMEM on failure.
109
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
110
int mdb_midl_need(MDB_IDL *idp, unsigned num);
111

112
	/** Append an ID onto an IDL.
Howard Chu's avatar
Howard Chu committed
113
	 * @param[in,out] idp	Address of the IDL to append to.
114
	 * @param[in] id	The ID to append.
Hallvard Furuseth's avatar
Hallvard Furuseth committed
115
	 * @return	0 on success, ENOMEM if the IDL is too large.
116
	 */
117
int mdb_midl_append( MDB_IDL *idp, MDB_ID id );
118

119
120
121
	/** Append an IDL onto an IDL.
	 * @param[in,out] idp	Address of the IDL to append to.
	 * @param[in] app	The IDL to append.
Hallvard Furuseth's avatar
Hallvard Furuseth committed
122
	 * @return	0 on success, ENOMEM if the IDL is too large.
123
	 */
124
int mdb_midl_append_list( MDB_IDL *idp, MDB_IDL app );
125

Hallvard Furuseth's avatar
Hallvard Furuseth committed
126
127
128
129
130
131
132
133
	/** Append an ID range onto an IDL.
	 * @param[in,out] idp	Address of the IDL to append to.
	 * @param[in] id	The lowest ID to append.
	 * @param[in] n		Number of IDs to append.
	 * @return	0 on success, ENOMEM if the IDL is too large.
	 */
int mdb_midl_append_range( MDB_IDL *idp, MDB_ID id, unsigned n );

134
135
136
137
138
139
	/** Merge an IDL onto an IDL. The destination IDL must be big enough.
	 * @param[in] idl	The IDL to merge into.
	 * @param[in] merge	The IDL to merge.
	 */
void mdb_midl_xmerge( MDB_IDL idl, MDB_IDL merge );

140
141
142
	/** Sort an IDL.
	 * @param[in,out] ids	The IDL to sort.
	 */
143
void mdb_midl_sort( MDB_IDL ids );
144

145
146
	/** An ID2 is an ID/pointer pair.
	 */
147
148
typedef struct MDB_ID2 {
	MDB_ID mid;		/**< The ID */
149
	void *mptr;		/**< The pointer */
150
} MDB_ID2;
151
152
153
154
155
156

	/** An ID2L is an ID2 List, a sorted array of ID2s.
	 * The first element's \b mid member is a count of how many actual
	 * elements are in the array. The \b mptr member of the first element is unused.
	 * The array is sorted in ascending order by \b mid.
	 */
157
typedef MDB_ID2 *MDB_ID2L;
158
159
160
161
162
163

	/** Search for an ID in an ID2L.
	 * @param[in] ids	The ID2L to search.
	 * @param[in] id	The ID to search for.
	 * @return	The index of the first ID2 whose \b mid member is greater than or equal to \b id.
	 */
164
unsigned mdb_mid2l_search( MDB_ID2L ids, MDB_ID id );
165
166
167
168
169


	/** Insert an ID2 into a ID2L.
	 * @param[in,out] ids	The ID2L to insert into.
	 * @param[in] id	The ID2 to insert.
Howard Chu's avatar
Howard Chu committed
170
	 * @return	0 on success, -1 if the ID was already present in the ID2L.
171
	 */
172
int mdb_mid2l_insert( MDB_ID2L ids, MDB_ID2 *id );
173

174
175
176
177
178
179
180
	/** Append an ID2 into a ID2L.
	 * @param[in,out] ids	The ID2L to append into.
	 * @param[in] id	The ID2 to append.
	 * @return	0 on success, -2 if the ID2L is too big.
	 */
int mdb_mid2l_append( MDB_ID2L ids, MDB_ID2 *id );

181
182
/** @} */
/** @} */
183
184
185
#ifdef __cplusplus
}
#endif
Howard Chu's avatar
Howard Chu committed
186
#endif	/* _MDB_MIDL_H_ */