1 /* dn2id.c - routines to deal with the dn2id index */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include <ac/string.h>
24 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
25 DB *db = bdb->bi_dn2id->bdi_db;
30 Debug( LDAP_DEBUG_TRACE, "=> bdb_dn2id_add( \"%s\", 0x%08lx )\n",
31 e->e_ndn, (long) e->e_id, 0 );
32 assert( e->e_id != NOID );
35 key.size = e->e_nname.bv_len + 2;
36 buf = ch_malloc( key.size );
38 buf[0] = DN_BASE_PREFIX;
40 AC_MEMCPY( ptr, e->e_ndn, key.size - 1 );
43 data.data = (char *) &e->e_id;
44 data.size = sizeof( e->e_id );
46 /* store it -- don't override */
47 rc = db->put( db, txn, &key, &data, DB_NOOVERWRITE );
49 Debug( LDAP_DEBUG_ANY, "=> bdb_dn2id_add: put failed: %s %d\n",
50 db_strerror(rc), rc, 0 );
54 if( !be_issuffix( be, ptr )) {
55 buf[0] = DN_SUBTREE_PREFIX;
56 rc = bdb_idl_insert_key( be, db, txn, &key, e->e_id );
58 Debug( LDAP_DEBUG_ANY,
59 "=> bdb_dn2id_add: subtree (%s) insert failed: %d\n",
65 pdn = dn_parent( be, ptr );
68 key.size -= pdn - ptr;
69 pdn[-1] = DN_ONE_PREFIX;
72 rc = bdb_idl_insert_key( be, db, txn, &key, e->e_id );
75 Debug( LDAP_DEBUG_ANY,
76 "=> bdb_dn2id_add: parent (%s) insert failed: %d\n",
82 while( pdn != NULL ) {
83 if ( be_issuffix( be, pdn ))
85 pdn[-1] = DN_SUBTREE_PREFIX;
87 rc = bdb_idl_insert_key( be, db, txn, &key, e->e_id );
90 Debug( LDAP_DEBUG_ANY,
91 "=> bdb_dn2id_add: subtree (%s) insert failed: %d\n",
96 pdn = dn_parent( be, pdn );
97 key.size -= pdn - ptr;
103 Debug( LDAP_DEBUG_TRACE, "<= bdb_dn2id_add: %d\n", rc, 0, 0 );
114 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
115 DB *db = bdb->bi_dn2id->bdi_db;
120 Debug( LDAP_DEBUG_TRACE, "=> bdb_dn2id_delete( \"%s\", 0x%08lx )\n",
121 e->e_ndn, e->e_id, 0 );
124 key.size = e->e_nname.bv_len + 2;
125 buf = ch_malloc( key.size );
127 key.flags = DB_DBT_USERMEM;
128 buf[0] = DN_BASE_PREFIX;
130 AC_MEMCPY( ptr, e->e_ndn, key.size - 1 );
133 rc = db->del( db, txn, &key, 0 );
135 Debug( LDAP_DEBUG_ANY, "=> bdb_dn2id_delete: delete failed: %s %d\n",
136 db_strerror(rc), rc, 0 );
140 if( !be_issuffix( be, ptr )) {
141 buf[0] = DN_SUBTREE_PREFIX;
142 rc = bdb_idl_delete_key( be, db, txn, &key, e->e_id );
144 Debug( LDAP_DEBUG_ANY,
145 "=> bdb_dn2id_delete: subtree (%s) delete failed: %d\n",
151 pdn = dn_parent( be, ptr );
154 key.size -= pdn - ptr;
155 pdn[-1] = DN_ONE_PREFIX;
158 rc = bdb_idl_delete_key( be, db, txn, &key, e->e_id );
161 Debug( LDAP_DEBUG_ANY,
162 "=> bdb_dn2id_delete: parent (%s) delete failed: %d\n",
168 while( pdn != NULL ) {
169 if ( be_issuffix( be, pdn ))
172 pdn[-1] = DN_SUBTREE_PREFIX;
174 rc = bdb_idl_delete_key( be, db, txn, &key, e->e_id );
176 Debug( LDAP_DEBUG_ANY,
177 "=> bdb_dn2id_delete: subtree (%s) delete failed: %d\n",
182 pdn = dn_parent( be, pdn );
183 key.size -= pdn - ptr;
189 Debug( LDAP_DEBUG_TRACE, "<= bdb_dn2id_delete %d\n", rc, 0, 0 );
202 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
203 DB *db = bdb->bi_dn2id->bdi_db;
205 Debug( LDAP_DEBUG_TRACE, "=> bdb_dn2id( \"%s\" )\n", dn, 0, 0 );
208 key.size = strlen( dn ) + 2;
209 key.data = ch_malloc( key.size );
210 ((char *)key.data)[0] = DN_BASE_PREFIX;
211 AC_MEMCPY( &((char *)key.data)[1], dn, key.size - 1 );
216 data.ulen = sizeof(ID);
217 data.flags = DB_DBT_USERMEM;
220 rc = db->get( db, txn, &key, &data, bdb->bi_db_opflags );
223 Debug( LDAP_DEBUG_TRACE, "<= bdb_dn2id: get failed: %s (%d)\n",
224 db_strerror( rc ), rc, 0 );
226 Debug( LDAP_DEBUG_TRACE, "<= bdb_dn2id: got id=0x%08lx\n",
244 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
245 DB *db = bdb->bi_dn2id->bdi_db;
248 Debug( LDAP_DEBUG_TRACE, "=> bdb_dn2id_matched( \"%s\" )\n", dn, 0, 0 );
251 key.size = strlen( dn ) + 2;
252 key.data = ch_malloc( key.size );
253 ((char *)key.data)[0] = DN_BASE_PREFIX;
258 data.ulen = sizeof(ID);
259 data.flags = DB_DBT_USERMEM;
264 AC_MEMCPY( &((char *)key.data)[1], dn, key.size - 1 );
269 rc = db->get( db, txn, &key, &data, bdb->bi_db_opflags );
271 if( rc == DB_NOTFOUND ) {
272 char *pdn = dn_parent( be, dn );
274 if( pdn == NULL || *pdn == '\0' ) {
275 Debug( LDAP_DEBUG_TRACE,
276 "<= bdb_dn2id_matched: no match\n",
282 key.size = strlen( dn ) + 2;
284 } else if ( rc == 0 ) {
285 if( data.size != sizeof( ID ) ) {
286 Debug( LDAP_DEBUG_ANY,
287 "<= bdb_dn2id_matched: get size mismatch: "
288 "expected %ld, got %ld\n",
289 (long) sizeof(ID), (long) data.size, 0 );
293 *matchedDN = (char *) dn;
296 Debug( LDAP_DEBUG_TRACE,
297 "<= bdb_dn2id_matched: id=0x%08lx: %s %s\n",
298 (long) *id, *matchedDN == NULL ? "entry" : "matched", dn );
302 Debug( LDAP_DEBUG_ANY,
303 "<= bdb_dn2id_matched: get failed: %s (%d)\n",
304 db_strerror(rc), rc, 0 );
321 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
322 DB *db = bdb->bi_dn2id->bdi_db;
325 Debug( LDAP_DEBUG_TRACE, "=> bdb_dn2id_children( %s )\n",
329 key.size = strlen( dn ) + 2;
330 key.data = ch_malloc( key.size );
331 ((char *)key.data)[0] = DN_ONE_PREFIX;
332 AC_MEMCPY( &((char *)key.data)[1], dn, key.size - 1 );
334 /* we actually could do a empty get... */
337 data.ulen = sizeof(id);
338 data.flags = DB_DBT_USERMEM;
340 data.dlen = sizeof(id);
342 rc = db->get( db, txn, &key, &data, bdb->bi_db_opflags );
344 Debug( LDAP_DEBUG_TRACE, "<= bdb_dn2id_children( %s ): %schildren (%d)\n",
346 rc == 0 ? "" : ( rc == DB_NOTFOUND ? "no " :
347 db_strerror(rc) ), rc );
361 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
362 DB *db = bdb->bi_dn2id->bdi_db;
364 Debug( LDAP_DEBUG_TRACE, "=> bdb_dn2idl( \"%s\" )\n", dn, 0, 0 );
366 if (prefix == DN_SUBTREE_PREFIX && be_issuffix(be, dn))
368 BDB_IDL_ALL(bdb, ids);
373 key.size = strlen( dn ) + 2;
374 key.data = ch_malloc( key.size );
375 ((char *)key.data)[0] = prefix;
376 AC_MEMCPY( &((char *)key.data)[1], dn, key.size - 1 );
378 rc = bdb_idl_fetch_key( be, db, NULL, &key, ids );
381 Debug( LDAP_DEBUG_TRACE,
382 "<= bdb_dn2idl: get failed: %s (%d)\n",
383 db_strerror( rc ), rc, 0 );
386 Debug( LDAP_DEBUG_TRACE,
387 "<= bdb_dn2idl: id=%ld first=%ld last=%ld\n",
389 (long) BDB_IDL_FIRST( ids ), (long) BDB_IDL_LAST( ids ) );
397 /* Experimental management routines for a hierarchically structured backend.
399 * Unsupported! Use at your own risk!
401 * Instead of a dn2id database, we use an id2parent database. Each entry in
402 * this database is a struct diskNode, containing the ID of the node's parent
403 * and the RDN of the node.
405 typedef struct diskNode {
411 /* In bdb_db_open() we call bdb_build_tree() which reads the entire id2parent
412 * database into memory (into an AVL tree). Next we iterate through each node
413 * of this tree, connecting each child to its parent. The nodes in this AVL
414 * tree are a struct idNode. The immediate (Onelevel) children of a node are
415 * referenced in the i_kids AVL tree. With this arrangement, there is no need
416 * to maintain the DN_ONE_PREFIX or DN_SUBTREE_PREFIX database keys. Note that
417 * the DN of an entry is constructed by walking up the list of i_parent
418 * pointers, so no full DN is stored on disk anywhere. This makes modrdn
419 * extremely efficient, even when operating on a populated subtree.
421 * The idNode tree is searched directly from the root when performing id to
422 * entry lookups. The tree is traversed using the i_kids subtrees when
423 * performing dn to id lookups.
425 typedef struct idNode {
427 struct idNode *i_parent;
430 ldap_pvt_thread_rdwr_t i_kids_rdwr;
433 /* strcopy is like strcpy except it returns a pointer to the trailing NUL of
434 * the result string. This allows fast construction of catenated strings
435 * without the overhead of strlen/strcat.
446 while (*a++ = *b++) ;
450 /* The main AVL tree is sorted in ID order. The i_kids AVL trees are
451 * sorted in lexical order. These are the various helper routines used
452 * for the searches and sorts.
469 return strcmp(nrdn, n->i_rdn->nrdn.bv_val);
478 return a->i_id - b->i_id;
487 return strcmp(a->i_rdn->nrdn.bv_val, b->i_rdn->nrdn.bv_val);
490 idNode * bdb_find_id_node(
495 return avl_find(tree, (const void *)id, (AVL_CMP)node_find_cmp);
498 idNode * bdb_find_rdn_node(
503 return avl_find(tree, (const void *)nrdn, (AVL_CMP)node_frdn_cmp);
506 /* This function links a node into its parent's i_kids tree. */
514 if (a->i_rdn->parent == 0)
516 a->i_parent = bdb_find_id_node(a->i_rdn->parent, tree);
519 ldap_pvt_thread_rdwr_wlock(&a->i_parent->i_kids_rdwr);
520 rc = avl_insert( &a->i_parent->i_kids, (caddr_t) a,
521 (AVL_CMP)node_rdn_cmp, (AVL_DUP) avl_dup_error );
522 ldap_pvt_thread_rdwr_wunlock(&a->i_parent->i_kids_rdwr);
526 /* This function adds a node into the main AVL tree */
527 idNode *bdb_add_node(
535 node = (idNode *)ch_malloc(sizeof(idNode));
537 node->i_parent = NULL;
539 node->i_rdn = (diskNode *)d;
540 node->i_rdn->rdn.bv_val += (long)d;
541 node->i_rdn->nrdn.bv_val += (long)d;
542 ldap_pvt_thread_rdwr_init(&node->i_kids_rdwr);
543 avl_insert( &bdb->bi_tree, (caddr_t) node,
544 (AVL_CMP)node_add_cmp, (AVL_DUP) avl_dup_error );
546 bdb->bi_troot = node;
550 /* This function initializes the trees at startup time. */
555 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
565 rc = bdb->bi_id2parent->bdi_db->cursor(
566 bdb->bi_id2parent->bdi_db, NULL, &cursor,
567 bdb->bi_db_opflags );
572 /* When be_suffix is turned into struct berval or LDAPDN
573 * life will get a lot easier... Since no DNs live on disk, we
574 * need to operate on the be_suffix to fully qualify our DNs.
575 * We need to know how many components are in the suffix DN,
576 * so we can tell where the suffix ends and our nodes begin.
578 * Note that this code always uses be_suffix[0], so defining
579 * multiple suffixes for a single backend won't work!
581 bdb->bi_sufflen = be->be_suffix[0]->bv_len;
583 rdns = ldap_explode_dn(be->be_nsuffix[0]->bv_val, 0);
584 for (i=0; rdns[i]; i++);
590 key.data = (char *)&id;
591 key.ulen = sizeof( id );
592 key.flags = DB_DBT_USERMEM;
593 data.flags = DB_DBT_MALLOC;
595 while (cursor->c_get( cursor, &key, &data, DB_NEXT ) == 0) {
596 bdb_add_node( id, data.data, bdb );
598 cursor->c_close( cursor );
600 rc = avl_apply(bdb->bi_tree, (AVL_APPLY)bdb_insert_kid, bdb->bi_tree,
606 /* This function constructs a full DN for a given id. We really should
607 * be passing idNodes directly, to save some effort...
615 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
620 ldap_pvt_thread_rdwr_rlock(&bdb->bi_tree_rdwr);
621 o = bdb_find_id_node(id, bdb->bi_tree);
622 rlen = bdb->bi_sufflen + 1;
623 nrlen = be->be_nsuffix[0]->bv_len + 1;
624 for (n = o; n; n=n->i_parent) {
625 rlen += n->i_rdn->rdn.bv_len + 1;
626 nrlen += n->i_rdn->nrdn.bv_len + 1;
628 e->e_dn = ch_malloc(rlen + nrlen);
629 e->e_ndn = e->e_dn + rlen;
632 for (n = o; n; n=n->i_parent) {
633 ptr = bdb_strcopy(ptr, n->i_rdn->rdn.bv_val);
635 nptr = bdb_strcopy(nptr, n->i_rdn->nrdn.bv_val);
638 ldap_pvt_thread_rdwr_runlock(&bdb->bi_tree_rdwr);
642 strcpy(ptr, be->be_suffix[0]->bv_val);
643 strcpy(nptr, be->be_nsuffix[0]->bv_val);
655 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
658 DB *db = bdb->bi_id2parent->bdi_db;
662 nrlen = dn_rdnlen( be, e->e_ndn );
664 rlen = dn_rdnlen( be, e->e_dn );
669 d = ch_malloc(sizeof(diskNode) + rlen + nrlen + 2);
670 d->rdn.bv_len = rlen;
671 d->nrdn.bv_len = nrlen;
672 d->rdn.bv_val = (char *)(d+1);
673 d->nrdn.bv_val = d->rdn.bv_val + rlen + 1;
674 strncpy(d->rdn.bv_val, e->e_dn, rlen);
675 d->rdn.bv_val[rlen] = '\0';
676 strncpy(d->nrdn.bv_val, e->e_ndn, nrlen);
677 d->nrdn.bv_val[nrlen] = '\0';
678 d->rdn.bv_val -= (long)d;
679 d->nrdn.bv_val -= (long)d;
682 bdb_dn2id(be, txn, pdn, &d->parent);
690 key.size = sizeof(ID);
691 key.flags = DB_DBT_USERMEM;
694 data.size = sizeof(diskNode) + rlen + nrlen + 2;
695 data.flags = DB_DBT_USERMEM;
697 rc = db->put( db, txn, &key, &data, DB_NOOVERWRITE );
700 ldap_pvt_thread_rdwr_wlock(&bdb->bi_tree_rdwr);
701 n = bdb_add_node( e->e_id, data.data, bdb);
702 ldap_pvt_thread_rdwr_wunlock(&bdb->bi_tree_rdwr);
705 ldap_pvt_thread_rdwr_rlock(&bdb->bi_tree_rdwr);
706 bdb_insert_kid(n, bdb->bi_tree);
707 ldap_pvt_thread_rdwr_runlock(&bdb->bi_tree_rdwr);
722 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
725 DB *db = bdb->bi_id2parent->bdi_db;
729 key.size = sizeof(e->e_id);
732 rc = db->del( db, txn, &key, 0);
734 ldap_pvt_thread_rdwr_wlock(&bdb->bi_tree_rdwr);
735 n = avl_delete(&bdb->bi_tree, (void *)e->e_id, (AVL_CMP)node_find_cmp);
738 ldap_pvt_thread_rdwr_wlock(&n->i_parent->i_kids_rdwr);
739 avl_delete(&n->i_parent->i_kids, n->i_rdn->nrdn.bv_val,
740 (AVL_CMP)node_frdn_cmp);
741 ldap_pvt_thread_rdwr_wunlock(&n->i_parent->i_kids_rdwr);
744 ldap_pvt_thread_rdwr_destroy(&n->i_kids_rdwr);
748 bdb->bi_troot = NULL;
749 ldap_pvt_thread_rdwr_wunlock(&bdb->bi_tree_rdwr);
762 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
771 if (be_issuffix(be, in)) {
776 rdns = ldap_explode_dn(in, 0);
777 for (i=0; rdns[i]; i++);
782 ldap_pvt_thread_rdwr_rlock(&bdb->bi_tree_rdwr);
783 for (--i; i>=0; i--) {
784 ldap_pvt_thread_rdwr_rlock(&p->i_kids_rdwr);
785 n = bdb_find_rdn_node(rdns[i], p->i_kids);
786 ldap_pvt_thread_rdwr_runlock(&p->i_kids_rdwr);
790 ldap_pvt_thread_rdwr_runlock(&bdb->bi_tree_rdwr);
794 } else if (matchedDN) {
798 for (j=i; rdns[j]; j++)
799 len += strlen(rdns[j]) + 1;
800 ptr = ch_malloc(len);
802 for (;rdns[i]; i++) {
803 ptr = bdb_strcopy(ptr, rdns[i]);
808 return n ? 0 : DB_NOTFOUND;
818 return bdb_dn2id_matched(be, txn, dn, id, NULL);
828 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
832 rc = bdb_dn2id(be, txn, dn, &id);
836 ldap_pvt_thread_rdwr_rlock(&bdb->bi_tree_rdwr);
837 n = bdb_find_id_node(id, bdb->bi_tree);
838 ldap_pvt_thread_rdwr_runlock(&bdb->bi_tree_rdwr);
846 /* Since we don't store IDLs for onelevel or subtree, we have to construct
847 * them on the fly... Perhaps the i_kids tree ought to just be an IDL?
855 return bdb_idl_insert(ids, n->i_id);
866 rc = bdb_idl_insert(ids, n->i_id);
868 ldap_pvt_thread_rdwr_rlock(&n->i_kids_rdwr);
869 rc = avl_apply(n->i_kids, (AVL_APPLY)insert_sub, ids, -1,
871 ldap_pvt_thread_rdwr_runlock(&n->i_kids_rdwr);
883 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
888 if (prefix == DN_SUBTREE_PREFIX && be_issuffix(be, dn)) {
889 BDB_IDL_ALL(bdb, ids);
893 rc = bdb_dn2id(be, NULL, dn, &id);
896 ldap_pvt_thread_rdwr_rlock(&bdb->bi_tree_rdwr);
897 n = bdb_find_id_node(id, bdb->bi_tree);
898 ldap_pvt_thread_rdwr_runlock(&bdb->bi_tree_rdwr);
901 ldap_pvt_thread_rdwr_rlock(&n->i_kids_rdwr);
902 if (prefix == DN_ONE_PREFIX) {
903 rc = avl_apply(n->i_kids, (AVL_APPLY)insert_one, ids, -1,
906 rc = avl_apply(n->i_kids, (AVL_APPLY)insert_sub, ids, -1,
909 ldap_pvt_thread_rdwr_runlock(&n->i_kids_rdwr);
912 #endif /* BDB_HIER */