1 /* backglue.c - backend glue routines */
4 * Copyright 2001-2002 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
9 * Functions to glue a bunch of other backends into a single tree.
10 * All of the glued backends must share a common suffix. E.g., you
11 * can glue o=foo and ou=bar,o=foo but you can't glue o=foo and o=bar.
13 * This uses the backend structures and routines extensively, but is
14 * not an actual backend of its own. To use it you must add a "subordinate"
15 * keyword to the configuration of other backends. Subordinates will
16 * automatically be connected to their parent backend.
18 * The purpose of these functions is to allow you to split a single database
19 * into pieces (for load balancing purposes, whatever) but still be able
20 * to treat it as a single database after it's been split. As such, each
21 * of the glued backends should have identical rootdn and rootpw.
23 * If you need more elaborate configuration, you probably should be using
32 #include <ac/socket.h>
37 typedef struct gluenode {
42 typedef struct glueinfo {
49 static BackendDB *glueBack;
51 /* Just like select_backend, but only for our backends */
58 glueinfo *gi = (glueinfo *) be->be_private;
62 bv.bv_len = strlen(dn);
63 bv.bv_val = (char *) dn;
65 for (i = 0; i<gi->nodes; i++) {
66 if (dnIsSuffix(&bv, gi->n[i].be->be_nsuffix[0])) {
73 /* This function will only be called in tool mode */
80 static int glueOpened = 0;
82 if (glueOpened) return 0;
86 /* If we were invoked in tool mode, open all the underlying backends */
87 if (slapMode & SLAP_TOOL_MODE) {
88 rc = backend_startup (NULL);
89 } /* other case is impossible */
93 /* This function will only be called in tool mode */
99 static int glueClosed = 0;
102 if (glueClosed) return 0;
106 if (slapMode & SLAP_TOOL_MODE) {
107 rc = backend_shutdown (NULL);
117 glueinfo *gi = (glueinfo *)be->be_private;
118 static int glueOpened = 0;
121 if (glueOpened) return 0;
125 gi->be->be_acl = be->be_acl;
127 if (gi->be->bd_info->bi_db_open)
128 rc = gi->be->bd_info->bi_db_open(gi->be);
138 glueinfo *gi = (glueinfo *)be->be_private;
139 static int glueClosed = 0;
141 if (glueClosed) return 0;
145 /* Close the master */
146 if (gi->be->bd_info->bi_db_close)
147 gi->be->bd_info->bi_db_close( gi->be );
153 glue_back_db_destroy (
157 glueinfo *gi = (glueinfo *)be->be_private;
159 if (gi->be->bd_info->bi_db_destroy)
160 gi->be->bd_info->bi_db_destroy( gi->be );
166 typedef struct glue_state {
173 slap_callback *prevcb;
187 struct berval *resdata,
188 struct berval *sasldata,
192 glue_state *gs = op->o_callback->sc_private;
194 if (err == LDAP_SUCCESS || gs->err != LDAP_SUCCESS)
196 if (gs->err == LDAP_SUCCESS && gs->matched) {
200 if (gs->err != LDAP_SUCCESS && matched) {
202 len = strlen (matched);
203 if (len > gs->matchlen) {
206 gs->matched = ch_strdup (matched);
214 for (i=0; ref[i].bv_val; i++);
218 new = ch_malloc ((i+1)*sizeof(struct berval));
220 new = ch_realloc(gs->refs,
221 (j+i+1)*sizeof(struct berval));
223 for (k=0; k<i; j++,k++) {
224 ber_dupbv( &new[j], &ref[k] );
226 new[j].bv_val = NULL;
244 glue_state *gs = op->o_callback->sc_private;
246 gs->nentries += nentries;
247 glue_back_response (c, op, 0, 0, err, matched, text, refs,
248 NULL, NULL, NULL, ctrls);
252 glue_back_sendentry (
262 slap_callback *tmp = op->o_callback;
263 glue_state *gs = tmp->sc_private;
266 op->o_callback = gs->prevcb;
267 if (op->o_callback && op->o_callback->sc_sendentry) {
268 rc = op->o_callback->sc_sendentry(be, c, op, e, an, ao, ctrls);
270 rc = send_search_entry(be, c, op, e, an, ao, ctrls);
272 op->o_callback = tmp;
288 struct berval *filterstr,
289 AttributeName *attrs,
293 glueinfo *gi = (glueinfo *)b0->be_private;
295 int i, rc, t2limit = 0, s2limit = 0;
299 slap_callback cb = {glue_back_response, glue_back_sresult,
300 glue_back_sendentry, &gs};
302 gs.prevcb = op->o_callback;
305 stoptime = slap_get_time () + tlimit;
309 case LDAP_SCOPE_BASE:
310 be = glue_back_select (b0, ndn->bv_val);
312 if (be && be->be_search) {
313 rc = be->be_search (be, conn, op, dn, ndn, scope,
314 deref, slimit, tlimit, filter, filterstr,
317 rc = LDAP_UNWILLING_TO_PERFORM;
318 send_ldap_result (conn, op, rc, NULL,
319 "No search target found", NULL, NULL);
323 case LDAP_SCOPE_ONELEVEL:
324 case LDAP_SCOPE_SUBTREE:
325 op->o_callback = &cb;
328 * Execute in reverse order, most general first
330 for (i = gi->nodes-1; i >= 0; i--) {
331 if (!gi->n[i].be || !gi->n[i].be->be_search)
334 t2limit = stoptime - slap_get_time ();
339 s2limit = slimit - gs.nentries;
346 ldap_pvt_thread_mutex_lock (&op->o_abandonmutex);
348 ldap_pvt_thread_mutex_unlock (&op->o_abandonmutex);
354 if (scope == LDAP_SCOPE_ONELEVEL &&
355 !strcmp (gi->n[i].pdn, ndn->bv_val)) {
356 rc = be->be_search (be, conn, op,
357 be->be_suffix[0], be->be_nsuffix[0],
358 LDAP_SCOPE_BASE, deref,
359 s2limit, t2limit, filter, filterstr,
362 } else if (scope == LDAP_SCOPE_SUBTREE &&
363 dnIsSuffix(be->be_nsuffix[0], ndn)) {
364 rc = be->be_search (be, conn, op,
365 be->be_suffix[0], be->be_nsuffix[0],
367 s2limit, t2limit, filter, filterstr,
370 } else if (dnIsSuffix(&bv, be->be_nsuffix[0])) {
371 rc = be->be_search (be, conn, op, dn, ndn,
373 s2limit, t2limit, filter, filterstr,
379 op->o_callback = gs.prevcb;
381 send_search_result (conn, op, gs.err, gs.matched, NULL,
382 gs.refs, NULL, gs.nentries);
388 ber_bvarray_free(gs.refs);
407 be = glue_back_select (b0, ndn->bv_val);
409 if (be && be->be_bind) {
410 conn->c_authz_backend = be;
411 rc = be->be_bind (be, conn, op, dn, ndn, method, cred, edn);
413 rc = LDAP_UNWILLING_TO_PERFORM;
414 send_ldap_result (conn, op, rc, NULL, "No bind target found",
427 AttributeAssertion *ava
433 be = glue_back_select (b0, ndn->bv_val);
435 if (be && be->be_compare) {
436 rc = be->be_compare (be, conn, op, dn, ndn, ava);
438 rc = LDAP_UNWILLING_TO_PERFORM;
439 send_ldap_result (conn, op, rc, NULL, "No compare target found",
458 be = glue_back_select (b0, ndn->bv_val);
460 if (be && be->be_modify) {
461 rc = be->be_modify (be, conn, op, dn, ndn, mod);
463 rc = LDAP_UNWILLING_TO_PERFORM;
464 send_ldap_result (conn, op, rc, NULL,
465 "No modify target found", NULL, NULL);
477 struct berval *newrdn,
478 struct berval *nnewrdn,
480 struct berval *newsup,
481 struct berval *nnewsup
487 be = glue_back_select (b0, ndn->bv_val);
489 if (be && be->be_modrdn) {
490 rc = be->be_modrdn (be, conn, op, dn, ndn,
491 newrdn, nnewrdn, del, newsup, nnewsup );
493 rc = LDAP_UNWILLING_TO_PERFORM;
494 send_ldap_result (conn, op, rc, NULL,
495 "No modrdn target found", NULL, NULL);
511 be = glue_back_select (b0, e->e_ndn);
513 if (be && be->be_add) {
514 rc = be->be_add (be, conn, op, e);
516 rc = LDAP_UNWILLING_TO_PERFORM;
517 send_ldap_result (conn, op, rc, NULL, "No add target found",
535 be = glue_back_select (b0, ndn->bv_val);
537 if (be && be->be_delete) {
538 rc = be->be_delete (be, conn, op, dn, ndn);
540 rc = LDAP_UNWILLING_TO_PERFORM;
541 send_ldap_result (conn, op, rc, NULL, "No delete target found",
548 glue_back_release_rw (
559 be = glue_back_select (b0, e->e_ndn);
561 if (be && be->be_release) {
562 rc = be->be_release (be, conn, op, e, rw);
579 AttributeDescription * ad
585 be = glue_back_select (b0, ndn->bv_val);
587 if (be && be->be_group) {
588 rc = be->be_group (be, conn, op, target, ndn, ondn, oc, ad);
590 rc = LDAP_UNWILLING_TO_PERFORM;
596 glue_back_attribute (
602 AttributeDescription *ad,
609 be = glue_back_select (b0, ndn->bv_val);
611 if (be && be->be_attribute) {
612 rc = be->be_attribute (be, conn, op, target, ndn, ad, vals);
614 rc = LDAP_UNWILLING_TO_PERFORM;
620 glue_back_referrals (
632 be = glue_back_select (b0, ndn->bv_val);
634 if (be && be->be_chk_referrals) {
635 rc = be->be_chk_referrals (be, conn, op, dn, ndn, text);
643 glue_tool_entry_open (
648 /* We don't know which backend to talk to yet, so just
649 * remember the mode and move on...
659 glue_tool_entry_close (
666 if (!glueBack->be_entry_close)
668 rc = glueBack->be_entry_close (glueBack);
674 glue_tool_entry_first (
678 glueinfo *gi = (glueinfo *) b0->be_private;
681 /* If we're starting from scratch, start at the most general */
683 for (i = gi->nodes-1; i >= 0; i--) {
684 if (gi->n[i].be->be_entry_open &&
685 gi->n[i].be->be_entry_first) {
686 glueBack = gi->n[i].be;
692 if (!glueBack || glueBack->be_entry_open (glueBack, glueMode) != 0)
695 return glueBack->be_entry_first (glueBack);
699 glue_tool_entry_next (
703 glueinfo *gi = (glueinfo *) b0->be_private;
707 if (!glueBack || !glueBack->be_entry_next)
710 rc = glueBack->be_entry_next (glueBack);
712 /* If we ran out of entries in one database, move on to the next */
714 glueBack->be_entry_close (glueBack);
715 for (i=0; i<gi->nodes; i++) {
716 if (gi->n[i].be == glueBack)
723 glueBack = gi->n[i-1].be;
724 rc = glue_tool_entry_first (b0);
731 glue_tool_entry_get (
736 if (!glueBack || !glueBack->be_entry_get)
739 return glueBack->be_entry_get (glueBack, id);
743 glue_tool_entry_put (
752 be = glue_back_select (b0, e->e_ndn);
753 if (!be->be_entry_put)
757 rc = be->be_entry_open (be, glueMode);
760 } else if (be != glueBack) {
761 /* If this entry belongs in a different branch than the
762 * previous one, close the current database and open the
765 glueBack->be_entry_close (glueBack);
766 rc = be->be_entry_open (be, glueMode);
771 return be->be_entry_put (be, e, text);
775 glue_tool_entry_reindex (
780 if (!glueBack || !glueBack->be_entry_reindex)
783 return glueBack->be_entry_reindex (glueBack, id);
791 glueinfo *gi = (glueinfo *) b0->be_private;
794 /* just sync everyone */
795 for (i = 0; i<gi->nodes; i++)
796 if (gi->n[i].be->be_sync)
797 gi->n[i].be->be_sync (gi->n[i].be);
805 int cont = num_subordinates;
810 /* While there are subordinate backends, search backwards through the
811 * backends and connect them to their superior.
813 for (i = nBackendDB - 1, b1=&backendDB[i]; cont && i>=0; b1--,i--) {
814 if (b1->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE) {
815 /* The last database cannot be a subordinate of noone */
816 if (i == nBackendDB - 1) {
817 b1->be_flags ^= SLAP_BFLAG_GLUE_SUBORDINATE;
822 for (j = i-1, be=&backendDB[j]; j>=0; be--,j--) {
823 if (!(be->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)) {
826 /* We will only link it once */
827 if (be->be_flags & SLAP_BFLAG_GLUE_LINKED) {
830 if (!dnIsSuffix(be->be_nsuffix[0], b1->be_nsuffix[0])) {
834 be->be_flags |= SLAP_BFLAG_GLUE_LINKED;
836 /* We create a copy of the superior's be
837 * structure, pointing to all of its original
838 * information. Then we replace elements of
839 * the superior's info with our own. The copy
840 * is used whenever we have operations to pass
841 * down to the real database.
843 b1->be_flags |= SLAP_BFLAG_GLUE_INSTANCE;
844 gi = (glueinfo *)ch_malloc(sizeof(glueinfo));
845 gi->be = (BackendDB *)ch_malloc(
846 sizeof(BackendDB) + sizeof(BackendInfo));
847 bi = (BackendInfo *)(gi->be+1);
851 bi->bi_open = glue_back_open;
852 bi->bi_close = glue_back_close;
853 bi->bi_db_open = glue_back_db_open;
854 bi->bi_db_close = glue_back_db_close;
855 bi->bi_db_destroy = glue_back_db_destroy;
857 bi->bi_op_bind = glue_back_bind;
858 bi->bi_op_search = glue_back_search;
859 bi->bi_op_compare = glue_back_compare;
860 bi->bi_op_modify = glue_back_modify;
861 bi->bi_op_modrdn = glue_back_modrdn;
862 bi->bi_op_add = glue_back_add;
863 bi->bi_op_delete = glue_back_delete;
865 bi->bi_entry_release_rw = glue_back_release_rw;
866 bi->bi_acl_group = glue_back_group;
867 bi->bi_acl_attribute = glue_back_attribute;
868 bi->bi_chk_referrals = glue_back_referrals;
871 * hooks for slap tools
873 bi->bi_tool_entry_open = glue_tool_entry_open;
874 bi->bi_tool_entry_close = glue_tool_entry_close;
875 bi->bi_tool_entry_first = glue_tool_entry_first;
876 bi->bi_tool_entry_next = glue_tool_entry_next;
877 bi->bi_tool_entry_get = glue_tool_entry_get;
878 bi->bi_tool_entry_put = glue_tool_entry_put;
879 bi->bi_tool_entry_reindex = glue_tool_entry_reindex;
880 bi->bi_tool_sync = glue_tool_sync;
882 gi = (glueinfo *)ch_realloc(gi,
884 gi->nodes * sizeof(gluenode));
886 gi->n[gi->nodes].be = be;
887 gi->n[gi->nodes].pdn = dn_parent(NULL,
888 be->be_nsuffix[0]->bv_val);
892 /* One more node for the master */
893 gi = (glueinfo *)ch_realloc(gi,
894 sizeof(glueinfo) + gi->nodes * sizeof(gluenode));
895 gi->n[gi->nodes].be = gi->be;
896 gi->n[gi->nodes].pdn = dn_parent(NULL,
897 b1->be_nsuffix[0]->bv_val);
903 /* If there are any unresolved subordinates left, something is wrong */