]> git.sur5r.net Git - openldap/blobdiff - libraries/liblmdb/midl.h
ITS#7971 mdb_txn_renew0(): Fix new readers slots.
[openldap] / libraries / liblmdb / midl.h
index 9ce7133c6e9f2f3cebf4000d6384dfbfd63b28b6..2331e7839847d0629bfaea95981aa59d8866e187 100644 (file)
@@ -1,5 +1,5 @@
 /**    @file midl.h
- *     @brief mdb ID List header file.
+ *     @brief LMDB ID List header file.
  *
  *     This file was originally part of back-bdb but has been
  *     modified for use in libmdb. Most of the macros defined
@@ -11,7 +11,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  *
- * Copyright 2000-2013 The OpenLDAP Foundation.
+ * Copyright 2000-2015 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 extern "C" {
 #endif
 
-/** @defgroup internal MDB Internals
+/** @defgroup internal LMDB Internals
  *     @{
  */
 
 /** @defgroup idls     ID List Management
  *     @{
  */
-       /** A generic ID number. These were entryIDs in back-bdb.
+       /** A generic unsigned ID number. These were entryIDs in back-bdb.
         *      Preferably it should have the same size as a pointer.
         */
 typedef size_t MDB_ID;
@@ -68,20 +68,21 @@ typedef MDB_ID *MDB_IDL;
 #define MDB_IDL_FIRST( ids )   ( (ids)[1] )
 #define MDB_IDL_LAST( ids )            ( (ids)[(ids)[0]] )
 
+       /** Current max length of an #mdb_midl_alloc()ed IDL */
+#define MDB_IDL_ALLOCLEN( ids )        ( (ids)[-1] )
+
        /** 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)
 
-#if 0  /* superseded by append/sort */
-       /** Insert an ID into an IDL.
-        * @param[in,out] ids   The IDL to insert into.
-        * @param[in] id        The ID to insert.
-        * @return      0 on success, -1 if ID was already present, -2 on error.
+       /** 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.
         */
-int mdb_midl_insert( MDB_IDL ids, MDB_ID id );
-#endif
+unsigned mdb_midl_search( MDB_IDL ids, MDB_ID id );
 
        /** Allocate an IDL.
         * Allocates memory for an IDL of the given size.
@@ -97,9 +98,8 @@ void mdb_midl_free(MDB_IDL ids);
        /** 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.
-        * @return      0 on no change, non-zero if shrunk.
         */
-int mdb_midl_shrink(MDB_IDL *idp);
+void mdb_midl_shrink(MDB_IDL *idp);
 
        /** Make room for num additional elements in an IDL.
         * @param[in,out] idp   Address of the IDL.
@@ -130,6 +130,12 @@ int mdb_midl_append_list( MDB_IDL *idp, MDB_IDL app );
         */
 int mdb_midl_append_range( MDB_IDL *idp, MDB_ID id, unsigned n );
 
+       /** 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 );
+
        /** Sort an IDL.
         * @param[in,out] ids   The IDL to sort.
         */