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->bd_info+1);
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->bd_info+1);
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->bd_info+1);
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->bd_info+1);
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->bd_info+1);
295 int i, rc = 0, t2limit = 0, s2limit = 0;
300 cb.sc_response = glue_back_response;
301 cb.sc_sresult = glue_back_sresult;
302 cb.sc_sendentry = glue_back_sendentry;
305 gs.prevcb = op->o_callback;
308 stoptime = slap_get_time () + tlimit;
312 case LDAP_SCOPE_BASE:
313 be = glue_back_select (b0, ndn->bv_val);
315 if (be && be->be_search) {
316 rc = be->be_search (be, conn, op, dn, ndn, scope,
317 deref, slimit, tlimit, filter, filterstr,
320 rc = LDAP_UNWILLING_TO_PERFORM;
321 send_ldap_result (conn, op, rc, NULL,
322 "No search target found", NULL, NULL);
326 case LDAP_SCOPE_ONELEVEL:
327 case LDAP_SCOPE_SUBTREE:
328 op->o_callback = &cb;
329 rc = gs.err = LDAP_UNWILLING_TO_PERFORM;
332 * Execute in reverse order, most general first
334 for (i = gi->nodes-1; i >= 0; i--) {
335 if (!gi->n[i].be || !gi->n[i].be->be_search)
338 t2limit = stoptime - slap_get_time ();
340 rc = gs.err = LDAP_TIMELIMIT_EXCEEDED;
345 s2limit = slimit - gs.nentries;
347 rc = gs.err = LDAP_SIZELIMIT_EXCEEDED;
359 if (scope == LDAP_SCOPE_ONELEVEL &&
360 dn_match(&gi->n[i].pdn, ndn)) {
361 rc = be->be_search (be, conn, op,
362 &be->be_suffix[0], &be->be_nsuffix[0],
363 LDAP_SCOPE_BASE, deref,
364 s2limit, t2limit, filter, filterstr,
367 } else if (scope == LDAP_SCOPE_SUBTREE &&
368 dnIsSuffix(&be->be_nsuffix[0], ndn)) {
369 rc = be->be_search (be, conn, op,
370 &be->be_suffix[0], &be->be_nsuffix[0],
372 s2limit, t2limit, filter, filterstr,
375 } else if (dnIsSuffix(ndn, &be->be_nsuffix[0])) {
376 rc = be->be_search (be, conn, op, dn, ndn,
378 s2limit, t2limit, filter, filterstr,
384 op->o_callback = gs.prevcb;
386 send_search_result (conn, op, gs.err, gs.matched, NULL,
387 gs.refs, NULL, gs.nentries);
393 ber_bvarray_free(gs.refs);
399 glue_tool_entry_open (
404 /* We don't know which backend to talk to yet, so just
405 * remember the mode and move on...
415 glue_tool_entry_close (
422 if (!glueBack->be_entry_close)
424 rc = glueBack->be_entry_close (glueBack);
430 glue_tool_entry_first (
434 glueinfo *gi = *(glueinfo **) (b0->bd_info+1);
437 /* If we're starting from scratch, start at the most general */
439 for (i = gi->nodes-1; i >= 0; i--) {
440 if (gi->n[i].be->be_entry_open &&
441 gi->n[i].be->be_entry_first) {
442 glueBack = gi->n[i].be;
448 if (!glueBack || glueBack->be_entry_open (glueBack, glueMode) != 0)
451 return glueBack->be_entry_first (glueBack);
455 glue_tool_entry_next (
459 glueinfo *gi = *(glueinfo **) (b0->bd_info+1);
463 if (!glueBack || !glueBack->be_entry_next)
466 rc = glueBack->be_entry_next (glueBack);
468 /* If we ran out of entries in one database, move on to the next */
470 glueBack->be_entry_close (glueBack);
471 for (i=0; i<gi->nodes; i++) {
472 if (gi->n[i].be == glueBack)
479 glueBack = gi->n[i-1].be;
480 rc = glue_tool_entry_first (b0);
487 glue_tool_entry_get (
492 if (!glueBack || !glueBack->be_entry_get)
495 return glueBack->be_entry_get (glueBack, id);
499 glue_tool_entry_put (
508 be = glue_back_select (b0, e->e_ndn);
509 if (!be->be_entry_put)
513 rc = be->be_entry_open (be, glueMode);
516 } else if (be != glueBack) {
517 /* If this entry belongs in a different branch than the
518 * previous one, close the current database and open the
521 glueBack->be_entry_close (glueBack);
522 rc = be->be_entry_open (be, glueMode);
527 return be->be_entry_put (be, e, text);
531 glue_tool_entry_reindex (
536 if (!glueBack || !glueBack->be_entry_reindex)
539 return glueBack->be_entry_reindex (glueBack, id);
547 glueinfo *gi = *(glueinfo **) (b0->bd_info+1);
550 /* just sync everyone */
551 for (i = 0; i<gi->nodes; i++)
552 if (gi->n[i].be->be_sync)
553 gi->n[i].be->be_sync (gi->n[i].be);
561 int cont = num_subordinates;
563 BackendInfo *bi = NULL;
566 /* While there are subordinate backends, search backwards through the
567 * backends and connect them to their superior.
569 for (i = nBackendDB - 1, b1=&backendDB[i]; cont && i>=0; b1--,i--) {
570 if (b1->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE) {
571 /* The last database cannot be a subordinate of noone */
572 if (i == nBackendDB - 1) {
573 b1->be_flags ^= SLAP_BFLAG_GLUE_SUBORDINATE;
578 for (j = i-1, be=&backendDB[j]; j>=0; be--,j--) {
579 if (!(be->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)) {
582 /* We will only link it once */
583 if (be->be_flags & SLAP_BFLAG_GLUE_LINKED) {
586 if (!dnIsSuffix(&be->be_nsuffix[0], &b1->be_nsuffix[0])) {
590 be->be_flags |= SLAP_BFLAG_GLUE_LINKED;
592 /* We create a copy of the superior's be
593 * structure, pointing to all of its original
594 * information. Then we replace elements of
595 * the superior's info with our own. The copy
596 * is used whenever we have operations to pass
597 * down to the real database.
599 b1->be_flags |= SLAP_BFLAG_GLUE_INSTANCE;
600 gi = (glueinfo *)ch_malloc(sizeof(glueinfo));
602 /* Space for a copy of the backend, our
603 * own backendInfo structure, and a pointer
606 gi->be = (BackendDB *)ch_malloc(
607 sizeof(BackendDB) + sizeof(BackendInfo) +
608 sizeof(glueinfo *) );
609 bi = (BackendInfo *)(gi->be+1);
613 bi->bi_open = glue_back_open;
614 bi->bi_close = glue_back_close;
615 bi->bi_db_open = glue_back_db_open;
616 bi->bi_db_close = glue_back_db_close;
617 bi->bi_db_destroy = glue_back_db_destroy;
619 bi->bi_op_search = glue_back_search;
622 * hooks for slap tools
624 bi->bi_tool_entry_open = glue_tool_entry_open;
625 bi->bi_tool_entry_close = glue_tool_entry_close;
626 bi->bi_tool_entry_first = glue_tool_entry_first;
627 bi->bi_tool_entry_next = glue_tool_entry_next;
628 bi->bi_tool_entry_get = glue_tool_entry_get;
629 bi->bi_tool_entry_put = glue_tool_entry_put;
630 bi->bi_tool_entry_reindex = glue_tool_entry_reindex;
631 bi->bi_tool_sync = glue_tool_sync;
633 gi = (glueinfo *)ch_realloc(gi,
635 gi->nodes * sizeof(gluenode));
637 gi->n[gi->nodes].be = be;
638 dnParent( &be->be_nsuffix[0], &gi->n[gi->nodes].pdn );
642 /* One more node for the master */
643 gi = (glueinfo *)ch_realloc(gi,
644 sizeof(glueinfo) + gi->nodes * sizeof(gluenode));
645 gi->n[gi->nodes].be = gi->be;
646 dnParent( &b1->be_nsuffix[0], &gi->n[gi->nodes].pdn );
649 /* Save a pointer to our private info. Don't use
650 * be_private or bi_private, to avoid having to fix
651 * that up before calling the real backend.
653 *(glueinfo **)(bi+1) = gi;
656 /* If there are any unresolved subordinates left, something is wrong */