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;
301 cb.sc_response = glue_back_response;
302 cb.sc_sresult = glue_back_sresult;
303 cb.sc_sendentry = glue_back_sendentry;
306 gs.prevcb = op->o_callback;
309 stoptime = slap_get_time () + tlimit;
313 case LDAP_SCOPE_BASE:
314 be = glue_back_select (b0, ndn->bv_val);
316 if (be && be->be_search) {
317 rc = be->be_search (be, conn, op, dn, ndn, scope,
318 deref, slimit, tlimit, filter, filterstr,
321 rc = LDAP_UNWILLING_TO_PERFORM;
322 send_ldap_result (conn, op, rc, NULL,
323 "No search target found", NULL, NULL);
327 case LDAP_SCOPE_ONELEVEL:
328 case LDAP_SCOPE_SUBTREE:
329 op->o_callback = &cb;
330 rc = gs.err = LDAP_UNWILLING_TO_PERFORM;
333 * Execute in reverse order, most general first
335 for (i = gi->nodes-1; i >= 0; i--) {
336 if (!gi->n[i].be || !gi->n[i].be->be_search)
339 t2limit = stoptime - slap_get_time ();
341 rc = gs.err = LDAP_TIMELIMIT_EXCEEDED;
346 s2limit = slimit - gs.nentries;
348 rc = gs.err = LDAP_SIZELIMIT_EXCEEDED;
355 ldap_pvt_thread_mutex_lock (&op->o_abandonmutex);
357 ldap_pvt_thread_mutex_unlock (&op->o_abandonmutex);
363 if (scope == LDAP_SCOPE_ONELEVEL &&
364 dn_match(&gi->n[i].pdn, ndn)) {
365 rc = be->be_search (be, conn, op,
366 be->be_suffix[0], be->be_nsuffix[0],
367 LDAP_SCOPE_BASE, deref,
368 s2limit, t2limit, filter, filterstr,
371 } else if (scope == LDAP_SCOPE_SUBTREE &&
372 dnIsSuffix(be->be_nsuffix[0], ndn)) {
373 rc = be->be_search (be, conn, op,
374 be->be_suffix[0], be->be_nsuffix[0],
376 s2limit, t2limit, filter, filterstr,
379 } else if (dnIsSuffix(&bv, be->be_nsuffix[0])) {
380 rc = be->be_search (be, conn, op, dn, ndn,
382 s2limit, t2limit, filter, filterstr,
388 op->o_callback = gs.prevcb;
390 send_search_result (conn, op, gs.err, gs.matched, NULL,
391 gs.refs, NULL, gs.nentries);
397 ber_bvarray_free(gs.refs);
416 be = glue_back_select (b0, ndn->bv_val);
418 if (be && be->be_bind) {
419 conn->c_authz_backend = be;
420 rc = be->be_bind (be, conn, op, dn, ndn, method, cred, edn);
422 rc = LDAP_UNWILLING_TO_PERFORM;
423 send_ldap_result (conn, op, rc, NULL, "No bind target found",
436 AttributeAssertion *ava
442 be = glue_back_select (b0, ndn->bv_val);
444 if (be && be->be_compare) {
445 rc = be->be_compare (be, conn, op, dn, ndn, ava);
447 rc = LDAP_UNWILLING_TO_PERFORM;
448 send_ldap_result (conn, op, rc, NULL, "No compare target found",
467 be = glue_back_select (b0, ndn->bv_val);
469 if (be && be->be_modify) {
470 rc = be->be_modify (be, conn, op, dn, ndn, mod);
472 rc = LDAP_UNWILLING_TO_PERFORM;
473 send_ldap_result (conn, op, rc, NULL,
474 "No modify target found", NULL, NULL);
486 struct berval *newrdn,
487 struct berval *nnewrdn,
489 struct berval *newsup,
490 struct berval *nnewsup
496 be = glue_back_select (b0, ndn->bv_val);
498 if (be && be->be_modrdn) {
499 rc = be->be_modrdn (be, conn, op, dn, ndn,
500 newrdn, nnewrdn, del, newsup, nnewsup );
502 rc = LDAP_UNWILLING_TO_PERFORM;
503 send_ldap_result (conn, op, rc, NULL,
504 "No modrdn target found", NULL, NULL);
520 be = glue_back_select (b0, e->e_ndn);
522 if (be && be->be_add) {
523 rc = be->be_add (be, conn, op, e);
525 rc = LDAP_UNWILLING_TO_PERFORM;
526 send_ldap_result (conn, op, rc, NULL, "No add target found",
544 be = glue_back_select (b0, ndn->bv_val);
546 if (be && be->be_delete) {
547 rc = be->be_delete (be, conn, op, dn, ndn);
549 rc = LDAP_UNWILLING_TO_PERFORM;
550 send_ldap_result (conn, op, rc, NULL, "No delete target found",
557 glue_back_release_rw (
568 be = glue_back_select (b0, e->e_ndn);
570 if (be && be->be_release) {
571 rc = be->be_release (be, conn, op, e, rw);
588 AttributeDescription * ad
594 be = glue_back_select (b0, ndn->bv_val);
596 if (be && be->be_group) {
597 rc = be->be_group (be, conn, op, target, ndn, ondn, oc, ad);
599 rc = LDAP_UNWILLING_TO_PERFORM;
605 glue_back_attribute (
611 AttributeDescription *ad,
618 be = glue_back_select (b0, ndn->bv_val);
620 if (be && be->be_attribute) {
621 rc = be->be_attribute (be, conn, op, target, ndn, ad, vals);
623 rc = LDAP_UNWILLING_TO_PERFORM;
629 glue_back_referrals (
641 be = glue_back_select (b0, ndn->bv_val);
643 if (be && be->be_chk_referrals) {
644 rc = be->be_chk_referrals (be, conn, op, dn, ndn, text);
652 glue_tool_entry_open (
657 /* We don't know which backend to talk to yet, so just
658 * remember the mode and move on...
668 glue_tool_entry_close (
675 if (!glueBack->be_entry_close)
677 rc = glueBack->be_entry_close (glueBack);
683 glue_tool_entry_first (
687 glueinfo *gi = (glueinfo *) b0->be_private;
690 /* If we're starting from scratch, start at the most general */
692 for (i = gi->nodes-1; i >= 0; i--) {
693 if (gi->n[i].be->be_entry_open &&
694 gi->n[i].be->be_entry_first) {
695 glueBack = gi->n[i].be;
701 if (!glueBack || glueBack->be_entry_open (glueBack, glueMode) != 0)
704 return glueBack->be_entry_first (glueBack);
708 glue_tool_entry_next (
712 glueinfo *gi = (glueinfo *) b0->be_private;
716 if (!glueBack || !glueBack->be_entry_next)
719 rc = glueBack->be_entry_next (glueBack);
721 /* If we ran out of entries in one database, move on to the next */
723 glueBack->be_entry_close (glueBack);
724 for (i=0; i<gi->nodes; i++) {
725 if (gi->n[i].be == glueBack)
732 glueBack = gi->n[i-1].be;
733 rc = glue_tool_entry_first (b0);
740 glue_tool_entry_get (
745 if (!glueBack || !glueBack->be_entry_get)
748 return glueBack->be_entry_get (glueBack, id);
752 glue_tool_entry_put (
761 be = glue_back_select (b0, e->e_ndn);
762 if (!be->be_entry_put)
766 rc = be->be_entry_open (be, glueMode);
769 } else if (be != glueBack) {
770 /* If this entry belongs in a different branch than the
771 * previous one, close the current database and open the
774 glueBack->be_entry_close (glueBack);
775 rc = be->be_entry_open (be, glueMode);
780 return be->be_entry_put (be, e, text);
784 glue_tool_entry_reindex (
789 if (!glueBack || !glueBack->be_entry_reindex)
792 return glueBack->be_entry_reindex (glueBack, id);
800 glueinfo *gi = (glueinfo *) b0->be_private;
803 /* just sync everyone */
804 for (i = 0; i<gi->nodes; i++)
805 if (gi->n[i].be->be_sync)
806 gi->n[i].be->be_sync (gi->n[i].be);
814 int cont = num_subordinates;
819 /* While there are subordinate backends, search backwards through the
820 * backends and connect them to their superior.
822 for (i = nBackendDB - 1, b1=&backendDB[i]; cont && i>=0; b1--,i--) {
823 if (b1->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE) {
824 /* The last database cannot be a subordinate of noone */
825 if (i == nBackendDB - 1) {
826 b1->be_flags ^= SLAP_BFLAG_GLUE_SUBORDINATE;
831 for (j = i-1, be=&backendDB[j]; j>=0; be--,j--) {
832 if (!(be->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)) {
835 /* We will only link it once */
836 if (be->be_flags & SLAP_BFLAG_GLUE_LINKED) {
839 if (!dnIsSuffix(be->be_nsuffix[0], b1->be_nsuffix[0])) {
843 be->be_flags |= SLAP_BFLAG_GLUE_LINKED;
845 /* We create a copy of the superior's be
846 * structure, pointing to all of its original
847 * information. Then we replace elements of
848 * the superior's info with our own. The copy
849 * is used whenever we have operations to pass
850 * down to the real database.
852 b1->be_flags |= SLAP_BFLAG_GLUE_INSTANCE;
853 gi = (glueinfo *)ch_malloc(sizeof(glueinfo));
854 gi->be = (BackendDB *)ch_malloc(
855 sizeof(BackendDB) + sizeof(BackendInfo));
856 bi = (BackendInfo *)(gi->be+1);
860 bi->bi_open = glue_back_open;
861 bi->bi_close = glue_back_close;
862 bi->bi_db_open = glue_back_db_open;
863 bi->bi_db_close = glue_back_db_close;
864 bi->bi_db_destroy = glue_back_db_destroy;
866 bi->bi_op_bind = glue_back_bind;
867 bi->bi_op_search = glue_back_search;
868 bi->bi_op_compare = glue_back_compare;
869 bi->bi_op_modify = glue_back_modify;
870 bi->bi_op_modrdn = glue_back_modrdn;
871 bi->bi_op_add = glue_back_add;
872 bi->bi_op_delete = glue_back_delete;
874 bi->bi_entry_release_rw = glue_back_release_rw;
875 bi->bi_acl_group = glue_back_group;
876 bi->bi_acl_attribute = glue_back_attribute;
877 bi->bi_chk_referrals = glue_back_referrals;
880 * hooks for slap tools
882 bi->bi_tool_entry_open = glue_tool_entry_open;
883 bi->bi_tool_entry_close = glue_tool_entry_close;
884 bi->bi_tool_entry_first = glue_tool_entry_first;
885 bi->bi_tool_entry_next = glue_tool_entry_next;
886 bi->bi_tool_entry_get = glue_tool_entry_get;
887 bi->bi_tool_entry_put = glue_tool_entry_put;
888 bi->bi_tool_entry_reindex = glue_tool_entry_reindex;
889 bi->bi_tool_sync = glue_tool_sync;
891 gi = (glueinfo *)ch_realloc(gi,
893 gi->nodes * sizeof(gluenode));
895 gi->n[gi->nodes].be = be;
896 dnParent( be->be_nsuffix[0], &gi->n[gi->nodes].pdn );
900 /* One more node for the master */
901 gi = (glueinfo *)ch_realloc(gi,
902 sizeof(glueinfo) + gi->nodes * sizeof(gluenode));
903 gi->n[gi->nodes].be = gi->be;
904 dnParent( b1->be_nsuffix[0], &gi->n[gi->nodes].pdn );
910 /* If there are any unresolved subordinates left, something is wrong */