1 /* idl.c - ldap id list handling routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2004 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
20 #include <ac/string.h>
25 #define IDL_MAX(x,y) ( x > y ? x : y )
26 #define IDL_MIN(x,y) ( x < y ? x : y )
28 #define IDL_CMP(x,y) ( x < y ? -1 : ( x > y ? 1 : 0 ) )
30 #define IDL_LRU_DELETE( bdb, e ) do { \
31 if ( e->idl_lru_prev != NULL ) { \
32 e->idl_lru_prev->idl_lru_next = e->idl_lru_next; \
34 bdb->bi_idl_lru_head = e->idl_lru_next; \
36 if ( e->idl_lru_next != NULL ) { \
37 e->idl_lru_next->idl_lru_prev = e->idl_lru_prev; \
39 bdb->bi_idl_lru_tail = e->idl_lru_prev; \
43 #define IDL_LRU_ADD( bdb, e ) do { \
44 e->idl_lru_next = bdb->bi_idl_lru_head; \
45 if ( e->idl_lru_next != NULL ) { \
46 e->idl_lru_next->idl_lru_prev = (e); \
48 (bdb)->bi_idl_lru_head = (e); \
49 e->idl_lru_prev = NULL; \
50 if ( (bdb)->bi_idl_lru_tail == NULL ) { \
51 (bdb)->bi_idl_lru_tail = (e); \
56 bdb_idl_entry_cmp( const void *v_idl1, const void *v_idl2 )
58 const bdb_idl_cache_entry_t *idl1 = v_idl1, *idl2 = v_idl2;
61 if ((rc = SLAP_PTRCMP( idl1->db, idl2->db ))) return rc;
62 if ((rc = idl1->kstr.bv_len - idl2->kstr.bv_len )) return rc;
63 return ( memcmp ( idl1->kstr.bv_val, idl2->kstr.bv_val , idl1->kstr.bv_len ) );
67 static void idl_check( ID *ids )
69 if( BDB_IDL_IS_RANGE( ids ) ) {
70 assert( BDB_IDL_RANGE_FIRST(ids) <= BDB_IDL_RANGE_LAST(ids) );
73 for( i=1; i < ids[0]; i++ ) {
74 assert( ids[i+1] > ids[i] );
80 static void idl_dump( ID *ids )
82 if( BDB_IDL_IS_RANGE( ids ) ) {
83 Debug( LDAP_DEBUG_ANY,
84 "IDL: range ( %ld - %ld )\n",
85 (long) BDB_IDL_RANGE_FIRST( ids ),
86 (long) BDB_IDL_RANGE_LAST( ids ) );
90 Debug( LDAP_DEBUG_ANY, "IDL: size %ld", (long) ids[0], 0, 0 );
92 for( i=1; i<=ids[0]; i++ ) {
94 Debug( LDAP_DEBUG_ANY, "\n", 0, 0, 0 );
96 Debug( LDAP_DEBUG_ANY, " %02lx", (long) ids[i], 0, 0 );
99 Debug( LDAP_DEBUG_ANY, "\n", 0, 0, 0 );
104 #endif /* IDL_DEBUG > 1 */
105 #endif /* IDL_DEBUG > 0 */
107 unsigned bdb_idl_search( ID *ids, ID id )
109 #define IDL_BINARY_SEARCH 1
110 #ifdef IDL_BINARY_SEARCH
112 * binary search of id in ids
113 * if found, returns position of id
114 * if not found, returns first postion greater than id
127 cursor = base + pivot;
128 val = IDL_CMP( id, ids[cursor + 1] );
133 } else if ( val > 0 ) {
149 /* (reverse) linear search */
156 for( i=ids[0]; i; i-- ) {
166 int bdb_idl_insert( ID *ids, ID id )
171 Debug( LDAP_DEBUG_ANY, "insert: %04lx at %d\n", (long) id, x, 0 );
177 if (BDB_IDL_IS_RANGE( ids )) {
178 /* if already in range, treat as a dup */
179 if (id >= BDB_IDL_FIRST(ids) && id <= BDB_IDL_LAST(ids))
181 if (id < BDB_IDL_FIRST(ids))
183 else if (id > BDB_IDL_LAST(ids))
188 x = bdb_idl_search( ids, id );
196 if ( x <= ids[0] && ids[x] == id ) {
201 if ( ++ids[0] >= BDB_IDL_DB_MAX ) {
204 ids[2] = ids[ids[0]-1];
205 } else if ( ids[ids[0]-1] < id ) {
208 ids[2] = ids[ids[0]-1];
214 AC_MEMCPY( &ids[x+1], &ids[x], (ids[0]-x) * sizeof(ID) );
228 static int idl_delete( ID *ids, ID id )
230 unsigned x = bdb_idl_search( ids, id );
233 Debug( LDAP_DEBUG_ANY, "delete: %04lx at %d\n", (long) id, x, 0 );
246 if( x > ids[0] || ids[x] != id ) {
250 } else if ( --ids[0] == 0 ) {
256 AC_MEMCPY( &ids[x], &ids[x+1], (1+ids[0]-x) * sizeof(ID) );
274 if ( key->size == sizeof( ID ) ) {
275 unsigned char *c = key->data;
276 sprintf( buf, "[%02x%02x%02x%02x]", c[0], c[1], c[2], c[3] );
283 /* Find a db/key pair in the IDL cache. If ids is non-NULL,
284 * copy the cached IDL into it, otherwise just return the status.
288 struct bdb_info *bdb,
293 bdb_idl_cache_entry_t idl_tmp;
294 bdb_idl_cache_entry_t *matched_idl_entry;
296 DBT2bv( key, &idl_tmp.kstr );
298 ldap_pvt_thread_rdwr_rlock( &bdb->bi_idl_tree_rwlock );
299 matched_idl_entry = avl_find( bdb->bi_idl_tree, &idl_tmp,
301 if ( matched_idl_entry != NULL ) {
302 if ( matched_idl_entry->idl && ids )
303 BDB_IDL_CPY( ids, matched_idl_entry->idl );
304 ldap_pvt_thread_rdwr_runlock( &bdb->bi_idl_tree_rwlock );
305 ldap_pvt_thread_mutex_lock( &bdb->bi_idl_tree_lrulock );
306 IDL_LRU_DELETE( bdb, matched_idl_entry );
307 IDL_LRU_ADD( bdb, matched_idl_entry );
308 ldap_pvt_thread_mutex_unlock( &bdb->bi_idl_tree_lrulock );
309 if ( matched_idl_entry->idl )
314 ldap_pvt_thread_rdwr_runlock( &bdb->bi_idl_tree_rwlock );
316 return LDAP_NO_SUCH_OBJECT;
321 struct bdb_info *bdb,
327 bdb_idl_cache_entry_t idl_tmp;
328 bdb_idl_cache_entry_t *ee;
330 DBT2bv( key, &idl_tmp.kstr );
332 ee = (bdb_idl_cache_entry_t *) ch_malloc(
333 sizeof( bdb_idl_cache_entry_t ) );
335 if ( rc == DB_NOTFOUND) {
338 ee->idl = (ID*) ch_malloc( BDB_IDL_SIZEOF ( ids ) );
339 BDB_IDL_CPY( ee->idl, ids );
341 ee->idl_lru_prev = NULL;
342 ee->idl_lru_next = NULL;
343 ber_dupbv( &ee->kstr, &idl_tmp.kstr );
344 ldap_pvt_thread_rdwr_wlock( &bdb->bi_idl_tree_rwlock );
345 if ( avl_insert( &bdb->bi_idl_tree, (caddr_t) ee,
346 bdb_idl_entry_cmp, avl_dup_error ))
348 ch_free( ee->kstr.bv_val );
351 ldap_pvt_thread_rdwr_wunlock( &bdb->bi_idl_tree_rwlock );
354 ldap_pvt_thread_mutex_lock( &bdb->bi_idl_tree_lrulock );
355 IDL_LRU_ADD( bdb, ee );
356 if ( ++bdb->bi_idl_cache_size > bdb->bi_idl_cache_max_size ) {
358 while ( bdb->bi_idl_lru_tail != NULL && i < 10 ) {
359 ee = bdb->bi_idl_lru_tail;
360 if ( avl_delete( &bdb->bi_idl_tree, (caddr_t) ee,
361 bdb_idl_entry_cmp ) == NULL ) {
362 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_cache_put: "
363 "AVL delete failed\n",
366 IDL_LRU_DELETE( bdb, ee );
368 --bdb->bi_idl_cache_size;
369 ch_free( ee->kstr.bv_val );
375 ldap_pvt_thread_mutex_unlock( &bdb->bi_idl_tree_lrulock );
376 ldap_pvt_thread_rdwr_wunlock( &bdb->bi_idl_tree_rwlock );
381 struct bdb_info *bdb,
385 bdb_idl_cache_entry_t *matched_idl_entry, idl_tmp;
386 DBT2bv( key, &idl_tmp.kstr );
388 ldap_pvt_thread_rdwr_wlock( &bdb->bi_idl_tree_rwlock );
389 matched_idl_entry = avl_find( bdb->bi_idl_tree, &idl_tmp,
391 if ( matched_idl_entry != NULL ) {
392 if ( avl_delete( &bdb->bi_idl_tree, (caddr_t) matched_idl_entry,
393 bdb_idl_entry_cmp ) == NULL ) {
394 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_cache_del: "
395 "AVL delete failed\n",
398 --bdb->bi_idl_cache_size;
399 ldap_pvt_thread_mutex_lock( &bdb->bi_idl_tree_lrulock );
400 IDL_LRU_DELETE( bdb, matched_idl_entry );
401 ldap_pvt_thread_mutex_unlock( &bdb->bi_idl_tree_lrulock );
402 free( matched_idl_entry->kstr.bv_val );
403 if ( matched_idl_entry->idl )
404 free( matched_idl_entry->idl );
405 free( matched_idl_entry );
407 ldap_pvt_thread_rdwr_wunlock( &bdb->bi_idl_tree_rwlock );
418 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
426 int flags = bdb->bi_db_opflags | DB_MULTIPLE;
428 /* If using BerkeleyDB 4.0, the buf must be large enough to
429 * grab the entire IDL in one get(), otherwise BDB will leak
430 * resources on subsequent get's. We can safely call get()
431 * twice - once for the data, and once to get the DB_NOTFOUND
432 * result meaning there's no more data. See ITS#2040 for details.
433 * This bug is fixed in BDB 4.1 so a smaller buffer will work if
434 * stack space is too limited.
436 * configure now requires Berkeley DB 4.1.
438 #if (DB_VERSION_MAJOR == 4) && (DB_VERSION_MINOR == 0)
439 # define BDB_ENOUGH 5
441 # define BDB_ENOUGH 1
443 ID buf[BDB_IDL_DB_SIZE*BDB_ENOUGH];
447 Debug( LDAP_DEBUG_ARGS,
448 "bdb_idl_fetch_key: %s\n",
449 bdb_show_key( key, keybuf ), 0, 0 );
451 assert( ids != NULL );
453 if ( bdb->bi_idl_cache_size ) {
454 rc = bdb_idl_cache_get( bdb, db, key, ids );
455 if ( rc != LDAP_NO_SUCH_OBJECT ) return rc;
461 data.ulen = sizeof(buf);
462 data.flags = DB_DBT_USERMEM;
464 if ( tid ) flags |= DB_RMW;
466 rc = db->cursor( db, tid, &cursor, bdb->bi_db_opflags );
468 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_fetch_key: "
469 "cursor failed: %s (%d)\n", db_strerror(rc), rc, 0 );
473 rc = cursor->c_get( cursor, key, &data, flags | DB_SET );
479 DB_MULTIPLE_INIT( ptr, &data );
481 DB_MULTIPLE_NEXT(ptr, &data, j, len);
484 AC_MEMCPY( i, j, sizeof(ID) );
487 rc = cursor->c_get( cursor, key, &data, flags | DB_NEXT_DUP );
489 if ( rc == DB_NOTFOUND ) rc = 0;
491 /* On disk, a range is denoted by 0 in the first element */
493 if (ids[0] != BDB_IDL_RANGE_SIZE) {
494 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_fetch_key: "
495 "range size mismatch: expected %d, got %ld\n",
496 BDB_IDL_RANGE_SIZE, ids[0], 0 );
497 cursor->c_close( cursor );
500 BDB_IDL_RANGE( ids, ids[2], ids[3] );
502 data.size = BDB_IDL_SIZEOF(ids);
505 rc2 = cursor->c_close( cursor );
507 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_fetch_key: "
508 "close failed: %s (%d)\n", db_strerror(rc2), rc2, 0 );
512 if( rc == DB_NOTFOUND ) {
515 } else if( rc != 0 ) {
516 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_fetch_key: "
517 "get failed: %s (%d)\n",
518 db_strerror(rc), rc, 0 );
521 } else if ( data.size == 0 || data.size % sizeof( ID ) ) {
522 /* size not multiple of ID size */
523 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_fetch_key: "
524 "odd size: expected %ld multiple, got %ld\n",
525 (long) sizeof( ID ), (long) data.size, 0 );
528 } else if ( data.size != BDB_IDL_SIZEOF(ids) ) {
530 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_fetch_key: "
531 "get size mismatch: expected %ld, got %ld\n",
532 (long) ((1 + ids[0]) * sizeof( ID )), (long) data.size, 0 );
536 if ( bdb->bi_idl_cache_max_size ) {
537 bdb_idl_cache_put( bdb, db, key, ids, rc );
552 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
561 Debug( LDAP_DEBUG_ARGS,
562 "bdb_idl_insert_key: %lx %s\n",
563 (long) id, bdb_show_key( key, buf ), 0 );
566 assert( id != NOID );
568 if ( bdb->bi_idl_cache_size ) {
569 bdb_idl_cache_del( bdb, db, key );
573 data.size = sizeof( ID );
574 data.ulen = data.size;
575 data.flags = DB_DBT_USERMEM;
577 rc = db->cursor( db, tid, &cursor, bdb->bi_db_opflags );
579 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_insert_key: "
580 "cursor failed: %s (%d)\n", db_strerror(rc), rc, 0 );
584 /* Fetch the first data item for this key, to see if it
585 * exists and if it's a range.
587 rc = cursor->c_get( cursor, key, &data, DB_SET | DB_RMW );
591 /* not a range, count the number of items */
593 rc = cursor->c_count( cursor, &count, 0 );
598 if ( count >= BDB_IDL_DB_MAX ) {
599 /* No room, convert to a range */
602 key2.dlen = key2.ulen;
603 key2.flags |= DB_DBT_PARTIAL;
607 rc = cursor->c_get( cursor, &key2, &data, DB_NEXT_NODUP );
608 if ( rc != 0 && rc != DB_NOTFOUND ) {
609 err = "c_get next_nodup";
612 if ( rc == DB_NOTFOUND ) {
613 rc = cursor->c_get( cursor, key, &data, DB_LAST );
619 rc = cursor->c_get( cursor, key, &data, DB_PREV );
629 rc = db->del( db, tid, key, 0 );
636 rc = cursor->c_put( cursor, key, &data, DB_KEYFIRST );
642 rc = cursor->c_put( cursor, key, &data, DB_KEYLAST );
648 rc = cursor->c_put( cursor, key, &data, DB_KEYLAST );
654 /* There's room, just store it */
658 /* It's a range, see if we need to rewrite
663 rc = cursor->c_get( cursor, key, &data, DB_NEXT_DUP );
670 rc = cursor->c_get( cursor, key, &data, DB_NEXT_DUP );
676 if ( id < lo || id > hi ) {
677 /* Delete the current lo/hi */
678 rc = cursor->c_del( cursor, 0 );
684 rc = cursor->c_put( cursor, key, &data, DB_KEYFIRST );
691 } else if ( rc == DB_NOTFOUND ) {
692 put1: data.data = &id;
693 rc = cursor->c_put( cursor, key, &data, DB_NODUPDATA );
694 /* Don't worry if it's already there */
695 if ( rc != 0 && rc != DB_KEYEXIST ) {
700 /* initial c_get failed, nothing was done */
702 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_insert_key: "
703 "%s failed: %s (%d)\n", err, db_strerror(rc), rc );
704 cursor->c_close( cursor );
707 rc = cursor->c_close( cursor );
709 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_insert_key: "
710 "c_close failed: %s (%d)\n",
711 db_strerror(rc), rc, 0 );
724 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
733 Debug( LDAP_DEBUG_ARGS,
734 "bdb_idl_delete_key: %lx %s\n",
735 (long) id, bdb_show_key( key, buf ), 0 );
737 assert( id != NOID );
739 if ( bdb->bi_idl_cache_max_size ) {
740 bdb_idl_cache_del( bdb, db, key );
745 data.size = sizeof( id );
746 data.ulen = data.size;
747 data.flags = DB_DBT_USERMEM;
749 rc = db->cursor( db, tid, &cursor, bdb->bi_db_opflags );
751 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_delete_key: "
752 "cursor failed: %s (%d)\n", db_strerror(rc), rc, 0 );
755 /* Fetch the first data item for this key, to see if it
756 * exists and if it's a range.
758 rc = cursor->c_get( cursor, key, &data, DB_SET | DB_RMW );
762 /* Not a range, just delete it */
764 /* position to correct item */
766 rc = cursor->c_get( cursor, key, &data,
767 DB_GET_BOTH | DB_RMW );
773 rc = cursor->c_del( cursor, 0 );
779 /* It's a range, see if we need to rewrite
783 rc = cursor->c_get( cursor, key, &data, DB_NEXT_DUP );
789 rc = cursor->c_get( cursor, key, &data, DB_NEXT_DUP );
794 if ( id == lo || id == hi ) {
798 } else if ( id == hi ) {
803 /* The range has collapsed... */
804 rc = db->del( db, tid, key, 0 );
811 /* reposition on lo slot */
813 cursor->c_get( cursor, key, &data, DB_PREV );
816 rc = cursor->c_del( cursor, 0 );
824 rc = cursor->c_put( cursor, key, &data, DB_KEYFIRST );
833 /* initial c_get failed, nothing was done */
835 if ( rc != DB_NOTFOUND ) {
836 Debug( LDAP_DEBUG_ANY, "=> bdb_idl_delete_key: "
837 "%s failed: %s (%d)\n", err, db_strerror(rc), rc );
839 cursor->c_close( cursor );
842 rc = cursor->c_close( cursor );
844 Debug( LDAP_DEBUG_ANY,
845 "=> bdb_idl_delete_key: c_close failed: %s (%d)\n",
846 db_strerror(rc), rc, 0 );
854 * idl_intersection - return a = a intersection b
857 bdb_idl_intersection(
863 ID cursora = 0, cursorb = 0, cursorc;
866 if ( BDB_IDL_IS_ZERO( a ) || BDB_IDL_IS_ZERO( b ) ) {
871 idmin = IDL_MAX( BDB_IDL_FIRST(a), BDB_IDL_FIRST(b) );
872 idmax = IDL_MIN( BDB_IDL_LAST(a), BDB_IDL_LAST(b) );
873 if ( idmin > idmax ) {
876 } else if ( idmin == idmax ) {
882 if ( BDB_IDL_IS_RANGE( a ) ) {
883 if ( BDB_IDL_IS_RANGE(b) ) {
884 /* If both are ranges, just shrink the boundaries */
889 /* Else swap so that b is the range, a is a list */
897 /* If a range completely covers the list, the result is
898 * just the list. If idmin to idmax is contiguous, just
899 * turn it into a range.
901 if ( BDB_IDL_IS_RANGE( b )
902 && BDB_IDL_FIRST( b ) <= BDB_IDL_FIRST( a )
903 && BDB_IDL_LAST( b ) >= BDB_IDL_LAST( a ) ) {
904 if (idmax - idmin + 1 == a[0])
913 /* Fine, do the intersection one element at a time.
914 * First advance to idmin in both IDLs.
916 cursora = cursorb = idmin;
917 ida = bdb_idl_first( a, &cursora );
918 idb = bdb_idl_first( b, &cursorb );
921 while( ida <= idmax || idb <= idmax ) {
924 ida = bdb_idl_next( a, &cursora );
925 idb = bdb_idl_next( b, &cursorb );
926 } else if ( ida < idb ) {
927 ida = bdb_idl_next( a, &cursora );
929 idb = bdb_idl_next( b, &cursorb );
942 * idl_union - return a = a union b
950 ID cursora = 0, cursorb = 0, cursorc;
952 if ( BDB_IDL_IS_ZERO( b ) ) {
956 if ( BDB_IDL_IS_ZERO( a ) ) {
961 if ( BDB_IDL_IS_RANGE( a ) || BDB_IDL_IS_RANGE(b) ) {
962 over: ida = IDL_MIN( BDB_IDL_FIRST(a), BDB_IDL_FIRST(b) );
963 idb = IDL_MAX( BDB_IDL_LAST(a), BDB_IDL_LAST(b) );
970 ida = bdb_idl_first( a, &cursora );
971 idb = bdb_idl_first( b, &cursorb );
975 /* The distinct elements of a are cat'd to b */
976 while( ida != NOID || idb != NOID ) {
978 if( ++cursorc > BDB_IDL_UM_MAX ) {
982 ida = bdb_idl_next( a, &cursora );
986 ida = bdb_idl_next( a, &cursora );
987 idb = bdb_idl_next( b, &cursorb );
991 /* b is copied back to a in sorted order */
996 while (cursorb <= b[0] || cursorc <= a[0]) {
1001 if (cursorb <= b[0] && b[cursorb] < idb)
1002 a[cursora++] = b[cursorb++];
1015 * bdb_idl_notin - return a intersection ~b (or a minus b)
1024 ID cursora = 0, cursorb = 0;
1026 if( BDB_IDL_IS_ZERO( a ) ||
1027 BDB_IDL_IS_ZERO( b ) ||
1028 BDB_IDL_IS_RANGE( b ) )
1030 BDB_IDL_CPY( ids, a );
1034 if( BDB_IDL_IS_RANGE( a ) ) {
1035 BDB_IDL_CPY( ids, a );
1039 ida = bdb_idl_first( a, &cursora ),
1040 idb = bdb_idl_first( b, &cursorb );
1044 while( ida != NOID ) {
1045 if ( idb == NOID ) {
1046 /* we could shortcut this */
1047 ids[++ids[0]] = ida;
1048 ida = bdb_idl_next( a, &cursora );
1050 } else if ( ida < idb ) {
1051 ids[++ids[0]] = ida;
1052 ida = bdb_idl_next( a, &cursora );
1054 } else if ( ida > idb ) {
1055 idb = bdb_idl_next( b, &cursorb );
1058 ida = bdb_idl_next( a, &cursora );
1059 idb = bdb_idl_next( b, &cursorb );
1067 ID bdb_idl_first( ID *ids, ID *cursor )
1071 if ( ids[0] == 0 ) {
1076 if ( BDB_IDL_IS_RANGE( ids ) ) {
1077 if( *cursor < ids[1] ) {
1086 pos = bdb_idl_search( ids, *cursor );
1088 if( pos > ids[0] ) {
1096 ID bdb_idl_next( ID *ids, ID *cursor )
1098 if ( BDB_IDL_IS_RANGE( ids ) ) {
1099 if( ids[2] < ++(*cursor) ) {
1105 if ( ++(*cursor) <= ids[0] ) {
1106 return ids[*cursor];