]> git.sur5r.net Git - openldap/blob - libraries/libmdb/midl.h
Begin reimplementing basic ops as cursor ops
[openldap] / libraries / libmdb / midl.h
1 /**     @file midl.h
2  *      @brief ldap bdb back-end ID List header file.
3  *
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.
7  *
8  *      This file is only used internally in libmdb and its definitions
9  *      are not exposed publicly.
10  */
11 /* $OpenLDAP$ */
12 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
13  *
14  * Copyright 2000-2011 The OpenLDAP Foundation.
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted only as authorized by the OpenLDAP
19  * Public License.
20  *
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>.
24  */
25
26 #ifndef _MDB_MIDL_H_
27 #define _MDB_MIDL_H_
28
29 /** @defgroup internal  MDB Internals
30  *      @{
31  */
32         /**     ULONG should be the largest integer type supported on a machine.
33          * It should be equal to the size of a pointer.
34          */
35 #define ULONG           unsigned long
36 /** @defgroup idls      ID List Management
37  *      @{
38  */
39         /** A generic ID number. These were entryIDs in back-bdb.
40          */
41 typedef ULONG ID;
42
43         /** An IDL is an ID List, a sorted array of IDs. The first
44          * element of the array is a counter for how many actual
45          * IDs are in the list. In the original back-bdb code, IDLs are
46          * sorted in ascending order. For libmdb IDLs are sorted in
47          * descending order.
48          */
49 typedef ID *IDL;
50
51 #define NOID    (~(ID)0)
52
53 /* IDL sizes - likely should be even bigger
54  *   limiting factors: sizeof(ID), thread stack size
55  */
56 #define MDB_IDL_LOGN    16      /* DB_SIZE is 2^16, UM_SIZE is 2^17 */
57 #define MDB_IDL_DB_SIZE         (1<<MDB_IDL_LOGN)
58 #define MDB_IDL_UM_SIZE         (1<<(MDB_IDL_LOGN+1))
59 #define MDB_IDL_UM_SIZEOF       (MDB_IDL_UM_SIZE * sizeof(ID))
60
61 #define MDB_IDL_DB_MAX          (MDB_IDL_DB_SIZE-1)
62
63 #define MDB_IDL_UM_MAX          (MDB_IDL_UM_SIZE-1)
64
65 #define MDB_IDL_IS_RANGE(ids)   ((ids)[0] == NOID)
66 #define MDB_IDL_RANGE_SIZE              (3)
67 #define MDB_IDL_RANGE_SIZEOF    (MDB_IDL_RANGE_SIZE * sizeof(ID))
68 #define MDB_IDL_SIZEOF(ids)             ((MDB_IDL_IS_RANGE(ids) \
69         ? MDB_IDL_RANGE_SIZE : ((ids)[0]+1)) * sizeof(ID))
70
71 #define MDB_IDL_RANGE_FIRST(ids)        ((ids)[1])
72 #define MDB_IDL_RANGE_LAST(ids)         ((ids)[2])
73
74 #define MDB_IDL_RANGE( ids, f, l ) \
75         do { \
76                 (ids)[0] = NOID; \
77                 (ids)[1] = (f);  \
78                 (ids)[2] = (l);  \
79         } while(0)
80
81 #define MDB_IDL_ZERO(ids) \
82         do { \
83                 (ids)[0] = 0; \
84                 (ids)[1] = 0; \
85                 (ids)[2] = 0; \
86         } while(0)
87
88 #define MDB_IDL_IS_ZERO(ids) ( (ids)[0] == 0 )
89 #define MDB_IDL_IS_ALL( range, ids ) ( (ids)[0] == NOID \
90         && (ids)[1] <= (range)[1] && (range)[2] <= (ids)[2] )
91
92 #define MDB_IDL_CPY( dst, src ) (memcpy( dst, src, MDB_IDL_SIZEOF( src ) ))
93
94 #define MDB_IDL_ID( bdb, ids, id ) MDB_IDL_RANGE( ids, id, ((bdb)->bi_lastid) )
95 #define MDB_IDL_ALL( bdb, ids ) MDB_IDL_RANGE( ids, 1, ((bdb)->bi_lastid) )
96
97 #define MDB_IDL_FIRST( ids )    ( (ids)[1] )
98 #define MDB_IDL_LAST( ids )             ( MDB_IDL_IS_RANGE(ids) \
99         ? (ids)[2] : (ids)[(ids)[0]] )
100
101 #define MDB_IDL_N( ids )                ( MDB_IDL_IS_RANGE(ids) \
102         ? ((ids)[2]-(ids)[1])+1 : (ids)[0] )
103
104         /** Insert an ID into an IDL.
105          * @param[in,out] ids   The IDL to insert into.
106          * @param[in] id        The ID to insert.
107          * @return      0 on success, -1 if the ID was already present in the IDL.
108          */
109 int mdb_midl_insert( IDL ids, ID id );
110
111         /** An ID2 is an ID/pointer pair.
112          */
113 typedef struct ID2 {
114         ID mid;                 /**< The ID */
115         void *mptr;             /**< The pointer */
116 } ID2;
117
118         /** An ID2L is an ID2 List, a sorted array of ID2s.
119          * The first element's \b mid member is a count of how many actual
120          * elements are in the array. The \b mptr member of the first element is unused.
121          * The array is sorted in ascending order by \b mid.
122          */
123 typedef ID2 *ID2L;
124
125         /** Search for an ID in an ID2L.
126          * @param[in] ids       The ID2L to search.
127          * @param[in] id        The ID to search for.
128          * @return      The index of the first ID2 whose \b mid member is greater than or equal to \b id.
129          */
130 unsigned mdb_mid2l_search( ID2L ids, ID id );
131
132
133         /** Insert an ID2 into a ID2L.
134          * @param[in,out] ids   The ID2L to insert into.
135          * @param[in] id        The ID2 to insert.
136          * @return      0 on success, -1 if the ID was already present in the MIDL2.
137          */
138 int mdb_mid2l_insert( ID2L ids, ID2 *id );
139
140 /** @} */
141 /** @} */
142 #endif  /* _MDB_MIDL_H_ */