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 = 0, 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;
360 if (scope == LDAP_SCOPE_ONELEVEL &&
361 dn_match(&gi->n[i].pdn, ndn)) {
362 rc = be->be_search (be, conn, op,
363 &be->be_suffix[0], &be->be_nsuffix[0],
364 LDAP_SCOPE_BASE, deref,
365 s2limit, t2limit, filter, filterstr,
368 } else if (scope == LDAP_SCOPE_SUBTREE &&
369 dnIsSuffix(&be->be_nsuffix[0], ndn)) {
370 rc = be->be_search (be, conn, op,
371 &be->be_suffix[0], &be->be_nsuffix[0],
373 s2limit, t2limit, filter, filterstr,
376 } else if (dnIsSuffix(&bv, &be->be_nsuffix[0])) {
377 rc = be->be_search (be, conn, op, dn, ndn,
379 s2limit, t2limit, filter, filterstr,
385 op->o_callback = gs.prevcb;
387 send_search_result (conn, op, gs.err, gs.matched, NULL,
388 gs.refs, NULL, gs.nentries);
394 ber_bvarray_free(gs.refs);
413 be = glue_back_select (b0, ndn->bv_val);
415 if (be && be->be_bind) {
416 conn->c_authz_backend = be;
417 rc = be->be_bind (be, conn, op, dn, ndn, method, cred, edn);
419 rc = LDAP_UNWILLING_TO_PERFORM;
420 send_ldap_result (conn, op, rc, NULL, "No bind target found",
433 AttributeAssertion *ava
439 be = glue_back_select (b0, ndn->bv_val);
441 if (be && be->be_compare) {
442 rc = be->be_compare (be, conn, op, dn, ndn, ava);
444 rc = LDAP_UNWILLING_TO_PERFORM;
445 send_ldap_result (conn, op, rc, NULL, "No compare target found",
464 be = glue_back_select (b0, ndn->bv_val);
466 if (be && be->be_modify) {
467 rc = be->be_modify (be, conn, op, dn, ndn, mod);
469 rc = LDAP_UNWILLING_TO_PERFORM;
470 send_ldap_result (conn, op, rc, NULL,
471 "No modify target found", NULL, NULL);
483 struct berval *newrdn,
484 struct berval *nnewrdn,
486 struct berval *newsup,
487 struct berval *nnewsup
493 be = glue_back_select (b0, ndn->bv_val);
495 if (be && be->be_modrdn) {
496 rc = be->be_modrdn (be, conn, op, dn, ndn,
497 newrdn, nnewrdn, del, newsup, nnewsup );
499 rc = LDAP_UNWILLING_TO_PERFORM;
500 send_ldap_result (conn, op, rc, NULL,
501 "No modrdn target found", NULL, NULL);
517 be = glue_back_select (b0, e->e_ndn);
519 if (be && be->be_add) {
520 rc = be->be_add (be, conn, op, e);
522 rc = LDAP_UNWILLING_TO_PERFORM;
523 send_ldap_result (conn, op, rc, NULL, "No add target found",
541 be = glue_back_select (b0, ndn->bv_val);
543 if (be && be->be_delete) {
544 rc = be->be_delete (be, conn, op, dn, ndn);
546 rc = LDAP_UNWILLING_TO_PERFORM;
547 send_ldap_result (conn, op, rc, NULL, "No delete target found",
554 glue_back_release_rw (
565 be = glue_back_select (b0, e->e_ndn);
567 if (be && be->be_release) {
568 rc = be->be_release (be, conn, op, e, rw);
585 AttributeDescription * ad
591 be = glue_back_select (b0, ndn->bv_val);
593 if (be && be->be_group) {
594 rc = be->be_group (be, conn, op, target, ndn, ondn, oc, ad);
596 rc = LDAP_UNWILLING_TO_PERFORM;
602 glue_back_attribute (
608 AttributeDescription *ad,
615 be = glue_back_select (b0, ndn->bv_val);
617 if (be && be->be_attribute) {
618 rc = be->be_attribute (be, conn, op, target, ndn, ad, vals);
620 rc = LDAP_UNWILLING_TO_PERFORM;
626 glue_back_referrals (
638 be = glue_back_select (b0, ndn->bv_val);
640 if (be && be->be_chk_referrals) {
641 rc = be->be_chk_referrals (be, conn, op, dn, ndn, text);
649 glue_tool_entry_open (
654 /* We don't know which backend to talk to yet, so just
655 * remember the mode and move on...
665 glue_tool_entry_close (
672 if (!glueBack->be_entry_close)
674 rc = glueBack->be_entry_close (glueBack);
680 glue_tool_entry_first (
684 glueinfo *gi = (glueinfo *) b0->be_private;
687 /* If we're starting from scratch, start at the most general */
689 for (i = gi->nodes-1; i >= 0; i--) {
690 if (gi->n[i].be->be_entry_open &&
691 gi->n[i].be->be_entry_first) {
692 glueBack = gi->n[i].be;
698 if (!glueBack || glueBack->be_entry_open (glueBack, glueMode) != 0)
701 return glueBack->be_entry_first (glueBack);
705 glue_tool_entry_next (
709 glueinfo *gi = (glueinfo *) b0->be_private;
713 if (!glueBack || !glueBack->be_entry_next)
716 rc = glueBack->be_entry_next (glueBack);
718 /* If we ran out of entries in one database, move on to the next */
720 glueBack->be_entry_close (glueBack);
721 for (i=0; i<gi->nodes; i++) {
722 if (gi->n[i].be == glueBack)
729 glueBack = gi->n[i-1].be;
730 rc = glue_tool_entry_first (b0);
737 glue_tool_entry_get (
742 if (!glueBack || !glueBack->be_entry_get)
745 return glueBack->be_entry_get (glueBack, id);
749 glue_tool_entry_put (
758 be = glue_back_select (b0, e->e_ndn);
759 if (!be->be_entry_put)
763 rc = be->be_entry_open (be, glueMode);
766 } else if (be != glueBack) {
767 /* If this entry belongs in a different branch than the
768 * previous one, close the current database and open the
771 glueBack->be_entry_close (glueBack);
772 rc = be->be_entry_open (be, glueMode);
777 return be->be_entry_put (be, e, text);
781 glue_tool_entry_reindex (
786 if (!glueBack || !glueBack->be_entry_reindex)
789 return glueBack->be_entry_reindex (glueBack, id);
797 glueinfo *gi = (glueinfo *) b0->be_private;
800 /* just sync everyone */
801 for (i = 0; i<gi->nodes; i++)
802 if (gi->n[i].be->be_sync)
803 gi->n[i].be->be_sync (gi->n[i].be);
811 int cont = num_subordinates;
813 BackendInfo *bi = NULL;
816 /* While there are subordinate backends, search backwards through the
817 * backends and connect them to their superior.
819 for (i = nBackendDB - 1, b1=&backendDB[i]; cont && i>=0; b1--,i--) {
820 if (b1->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE) {
821 /* The last database cannot be a subordinate of noone */
822 if (i == nBackendDB - 1) {
823 b1->be_flags ^= SLAP_BFLAG_GLUE_SUBORDINATE;
828 for (j = i-1, be=&backendDB[j]; j>=0; be--,j--) {
829 if (!(be->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)) {
832 /* We will only link it once */
833 if (be->be_flags & SLAP_BFLAG_GLUE_LINKED) {
836 if (!dnIsSuffix(&be->be_nsuffix[0], &b1->be_nsuffix[0])) {
840 be->be_flags |= SLAP_BFLAG_GLUE_LINKED;
842 /* We create a copy of the superior's be
843 * structure, pointing to all of its original
844 * information. Then we replace elements of
845 * the superior's info with our own. The copy
846 * is used whenever we have operations to pass
847 * down to the real database.
849 b1->be_flags |= SLAP_BFLAG_GLUE_INSTANCE;
850 gi = (glueinfo *)ch_malloc(sizeof(glueinfo));
851 gi->be = (BackendDB *)ch_malloc(
852 sizeof(BackendDB) + sizeof(BackendInfo));
853 bi = (BackendInfo *)(gi->be+1);
857 bi->bi_open = glue_back_open;
858 bi->bi_close = glue_back_close;
859 bi->bi_db_open = glue_back_db_open;
860 bi->bi_db_close = glue_back_db_close;
861 bi->bi_db_destroy = glue_back_db_destroy;
863 bi->bi_op_bind = glue_back_bind;
864 bi->bi_op_search = glue_back_search;
865 bi->bi_op_compare = glue_back_compare;
866 bi->bi_op_modify = glue_back_modify;
867 bi->bi_op_modrdn = glue_back_modrdn;
868 bi->bi_op_add = glue_back_add;
869 bi->bi_op_delete = glue_back_delete;
871 bi->bi_entry_release_rw = glue_back_release_rw;
872 bi->bi_acl_group = glue_back_group;
873 bi->bi_acl_attribute = glue_back_attribute;
874 bi->bi_chk_referrals = glue_back_referrals;
877 * hooks for slap tools
879 bi->bi_tool_entry_open = glue_tool_entry_open;
880 bi->bi_tool_entry_close = glue_tool_entry_close;
881 bi->bi_tool_entry_first = glue_tool_entry_first;
882 bi->bi_tool_entry_next = glue_tool_entry_next;
883 bi->bi_tool_entry_get = glue_tool_entry_get;
884 bi->bi_tool_entry_put = glue_tool_entry_put;
885 bi->bi_tool_entry_reindex = glue_tool_entry_reindex;
886 bi->bi_tool_sync = glue_tool_sync;
888 gi = (glueinfo *)ch_realloc(gi,
890 gi->nodes * sizeof(gluenode));
892 gi->n[gi->nodes].be = be;
893 dnParent( &be->be_nsuffix[0], &gi->n[gi->nodes].pdn );
897 /* One more node for the master */
898 gi = (glueinfo *)ch_realloc(gi,
899 sizeof(glueinfo) + gi->nodes * sizeof(gluenode));
900 gi->n[gi->nodes].be = gi->be;
901 dnParent( &b1->be_nsuffix[0], &gi->n[gi->nodes].pdn );
907 /* If there are any unresolved subordinates left, something is wrong */