1 /* backglue.c - backend glue routines */
4 * Copyright 2001-2003 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/string.h>
33 #include <ac/socket.h>
38 typedef struct gluenode {
43 typedef struct glueinfo {
51 static BackendDB *glueBack;
53 static slap_response glue_back_response;
54 static slap_sresult glue_back_sresult;
55 static slap_sendentry glue_back_sendentry;
56 static slap_sendreference glue_back_sendreference;
58 /* Just like select_backend, but only for our backends */
65 glueinfo *gi = (glueinfo *) be->bd_info;
69 bv.bv_len = strlen(dn);
70 bv.bv_val = (char *) dn;
72 for (i = 0; i<gi->nodes; i++) {
73 if (dnIsSuffix(&bv, &gi->n[i].be->be_nsuffix[0])) {
80 /* This function will only be called in tool mode */
87 static int glueOpened = 0;
89 if (glueOpened) return 0;
93 /* If we were invoked in tool mode, open all the underlying backends */
94 if (slapMode & SLAP_TOOL_MODE) {
95 rc = backend_startup (NULL);
96 } /* other case is impossible */
100 /* This function will only be called in tool mode */
106 static int glueClosed = 0;
109 if (glueClosed) return 0;
113 if (slapMode & SLAP_TOOL_MODE) {
114 rc = backend_shutdown (NULL);
124 glueinfo *gi = (glueinfo *) be->bd_info;
125 static int glueOpened = 0;
128 if (glueOpened) return 0;
132 gi->bd.be_acl = be->be_acl;
134 if (gi->bd.bd_info->bi_db_open)
135 rc = gi->bd.bd_info->bi_db_open(&gi->bd);
145 glueinfo *gi = (glueinfo *) be->bd_info;
146 static int glueClosed = 0;
148 if (glueClosed) return 0;
152 /* Close the master */
153 if (gi->bd.bd_info->bi_db_close)
154 gi->bd.bd_info->bi_db_close( &gi->bd );
160 glue_back_db_destroy (
164 glueinfo *gi = (glueinfo *) be->bd_info;
166 if (gi->bd.bd_info->bi_db_destroy)
167 gi->bd.bd_info->bi_db_destroy( &gi->bd );
172 typedef struct glue_state {
179 slap_callback *prevcb;
183 glue_back_response ( Operation *op, SlapReply *rs )
185 glue_state *gs = op->o_callback->sc_private;
187 if (rs->sr_err == LDAP_SUCCESS || gs->err != LDAP_SUCCESS)
188 gs->err = rs->sr_err;
189 if (gs->err == LDAP_SUCCESS && gs->matched) {
190 ch_free (gs->matched);
194 if (gs->err != LDAP_SUCCESS && rs->sr_matched) {
196 len = strlen (rs->sr_matched);
197 if (len > gs->matchlen) {
199 ch_free (gs->matched);
200 gs->matched = ch_strdup (rs->sr_matched);
208 for (i=0; rs->sr_ref[i].bv_val; i++);
212 new = ch_malloc ((i+1)*sizeof(struct berval));
214 new = ch_realloc(gs->refs,
215 (j+i+1)*sizeof(struct berval));
217 for (k=0; k<i; j++,k++) {
218 ber_dupbv( &new[j], &rs->sr_ref[k] );
220 new[j].bv_val = NULL;
227 glue_back_sresult ( Operation *op, SlapReply *rs )
229 glue_state *gs = op->o_callback->sc_private;
231 gs->nentries += rs->sr_nentries;
232 glue_back_response( op, rs );
236 glue_back_sendentry ( Operation *op, SlapReply *rs )
238 slap_callback *tmp = op->o_callback;
239 glue_state *gs = tmp->sc_private;
241 op->o_callback = gs->prevcb;
242 if (op->o_callback && op->o_callback->sc_sendentry) {
243 rs->sr_err = op->o_callback->sc_sendentry(op, rs);
245 rs->sr_err = send_search_entry(op, rs);
247 op->o_callback = tmp;
252 glue_back_sendreference ( Operation *op, SlapReply *rs )
254 slap_callback *tmp = op->o_callback;
255 glue_state *gs = tmp->sc_private;
257 op->o_callback = gs->prevcb;
258 if (op->o_callback && op->o_callback->sc_sendreference) {
259 rs->sr_err = op->o_callback->sc_sendreference( op, rs );
261 rs->sr_err = send_search_reference( op, rs );
263 op->o_callback = tmp;
268 glue_back_search ( Operation *op, SlapReply *rs )
270 BackendDB *b0 = op->o_bd;
271 glueinfo *gi = (glueinfo *) b0->bd_info;
274 glue_state gs = {0, 0, 0, NULL, 0, NULL, NULL};
276 int scope0, slimit0, tlimit0;
277 struct berval dn, ndn;
279 cb.sc_response = glue_back_response;
280 cb.sc_sresult = glue_back_sresult;
281 cb.sc_sendentry = glue_back_sendentry;
282 cb.sc_sendreference = glue_back_sendreference;
285 gs.prevcb = op->o_callback;
287 if (op->oq_search.rs_tlimit) {
288 stoptime = slap_get_time () + op->oq_search.rs_tlimit;
291 switch (op->oq_search.rs_scope) {
292 case LDAP_SCOPE_BASE:
293 op->o_bd = glue_back_select (b0, op->o_req_ndn.bv_val);
295 if (op->o_bd && op->o_bd->be_search) {
296 rs->sr_err = op->o_bd->be_search( op, rs );
298 send_ldap_error(op, rs, LDAP_UNWILLING_TO_PERFORM,
299 "No search target found");
303 case LDAP_SCOPE_ONELEVEL:
304 case LDAP_SCOPE_SUBTREE:
305 op->o_callback = &cb;
306 rs->sr_err = gs.err = LDAP_UNWILLING_TO_PERFORM;
307 scope0 = op->oq_search.rs_scope;
308 slimit0 = op->oq_search.rs_slimit;
309 tlimit0 = op->oq_search.rs_tlimit;
314 * Execute in reverse order, most general first
316 for (i = gi->nodes-1; i >= 0; i--) {
317 if (!gi->n[i].be || !gi->n[i].be->be_search)
320 op->oq_search.rs_tlimit = stoptime - slap_get_time ();
321 if (op->oq_search.rs_tlimit <= 0) {
322 rs->sr_err = gs.err = LDAP_TIMELIMIT_EXCEEDED;
327 op->oq_search.rs_slimit = slimit0 - gs.nentries;
328 if (op->oq_search.rs_slimit <= 0) {
329 rs->sr_err = gs.err = LDAP_SIZELIMIT_EXCEEDED;
340 op->o_bd = gi->n[i].be;
341 if (scope0 == LDAP_SCOPE_ONELEVEL &&
342 dn_match(&gi->n[i].pdn, &ndn)) {
343 op->oq_search.rs_scope = LDAP_SCOPE_BASE;
344 op->o_req_dn = op->o_bd->be_suffix[0];
345 op->o_req_ndn = op->o_bd->be_nsuffix[0];
346 rs->sr_err = op->o_bd->be_search(op, rs);
348 } else if (scope0 == LDAP_SCOPE_SUBTREE &&
349 dnIsSuffix(&op->o_bd->be_nsuffix[0], &ndn)) {
350 op->o_req_dn = op->o_bd->be_suffix[0];
351 op->o_req_ndn = op->o_bd->be_nsuffix[0];
352 rs->sr_err = op->o_bd->be_search( op, rs );
354 } else if (dnIsSuffix(&ndn, &op->o_bd->be_nsuffix[0])) {
355 rs->sr_err = op->o_bd->be_search( op, rs );
361 * Add errors that should result in dropping
364 case LDAP_SIZELIMIT_EXCEEDED:
365 case LDAP_TIMELIMIT_EXCEEDED:
366 case LDAP_ADMINLIMIT_EXCEEDED:
374 op->oq_search.rs_scope = scope0;
375 op->oq_search.rs_slimit = slimit0;
376 op->oq_search.rs_tlimit = tlimit0;
382 op->o_callback = gs.prevcb;
384 rs->sr_matched = gs.matched;
385 rs->sr_ref = gs.refs;
386 rs->sr_nentries = gs.nentries;
388 send_search_result( op, rs );
395 ber_bvarray_free(gs.refs);
401 glue_tool_entry_open (
406 /* We don't know which backend to talk to yet, so just
407 * remember the mode and move on...
417 glue_tool_entry_close (
424 if (!glueBack->be_entry_close)
426 rc = glueBack->be_entry_close (glueBack);
432 glue_tool_entry_first (
436 glueinfo *gi = (glueinfo *) b0->bd_info;
439 /* If we're starting from scratch, start at the most general */
441 for (i = gi->nodes-1; i >= 0; i--) {
442 if (gi->n[i].be->be_entry_open &&
443 gi->n[i].be->be_entry_first) {
444 glueBack = gi->n[i].be;
450 if (!glueBack || glueBack->be_entry_open (glueBack, glueMode) != 0)
453 return glueBack->be_entry_first (glueBack);
457 glue_tool_entry_next (
461 glueinfo *gi = (glueinfo *) b0->bd_info;
465 if (!glueBack || !glueBack->be_entry_next)
468 rc = glueBack->be_entry_next (glueBack);
470 /* If we ran out of entries in one database, move on to the next */
472 glueBack->be_entry_close (glueBack);
473 for (i=0; i<gi->nodes; i++) {
474 if (gi->n[i].be == glueBack)
481 glueBack = gi->n[i-1].be;
482 rc = glue_tool_entry_first (b0);
489 glue_tool_entry_get (
494 if (!glueBack || !glueBack->be_entry_get)
497 return glueBack->be_entry_get (glueBack, id);
501 glue_tool_entry_put (
510 be = glue_back_select (b0, e->e_ndn);
511 if (!be->be_entry_put)
515 rc = be->be_entry_open (be, glueMode);
518 } else if (be != glueBack) {
519 /* If this entry belongs in a different branch than the
520 * previous one, close the current database and open the
523 glueBack->be_entry_close (glueBack);
524 rc = be->be_entry_open (be, glueMode);
529 return be->be_entry_put (be, e, text);
533 glue_tool_entry_reindex (
538 if (!glueBack || !glueBack->be_entry_reindex)
541 return glueBack->be_entry_reindex (glueBack, id);
549 glueinfo *gi = (glueinfo *) b0->bd_info;
552 /* just sync everyone */
553 for (i = 0; i<gi->nodes; i++)
554 if (gi->n[i].be->be_sync)
555 gi->n[i].be->be_sync (gi->n[i].be);
563 int cont = num_subordinates;
565 BackendInfo *bi = NULL;
568 /* While there are subordinate backends, search backwards through the
569 * backends and connect them to their superior.
571 for (i = nBackendDB - 1, b1=&backendDB[i]; cont && i>=0; b1--,i--) {
572 if (SLAP_GLUE_SUBORDINATE ( b1 ) ) {
573 /* The last database cannot be a subordinate of noone */
574 if (i == nBackendDB - 1) {
575 b1->be_flags ^= SLAP_BFLAG_GLUE_SUBORDINATE;
580 for (j = i-1, be=&backendDB[j]; j>=0; be--,j--) {
581 if ( ! SLAP_GLUE_SUBORDINATE( be ) ) {
584 /* We will only link it once */
585 if ( SLAP_GLUE_LINKED( be ) ) {
588 if (!dnIsSuffix(&be->be_nsuffix[0], &b1->be_nsuffix[0])) {
592 be->be_flags |= SLAP_BFLAG_GLUE_LINKED;
594 /* We create a copy of the superior's be
595 * structure, pointing to all of its original
596 * information. Then we replace elements of
597 * the superior's info with our own. The copy
598 * is used whenever we have operations to pass
599 * down to the real database.
601 b1->be_flags |= SLAP_BFLAG_GLUE_INSTANCE;
602 gi = (glueinfo *)ch_malloc(sizeof(glueinfo));
605 gi->bi = *b1->bd_info;
606 bi = (BackendInfo *)gi;
607 bi->bi_open = glue_back_open;
608 bi->bi_close = glue_back_close;
609 bi->bi_db_open = glue_back_db_open;
610 bi->bi_db_close = glue_back_db_close;
611 bi->bi_db_destroy = glue_back_db_destroy;
613 bi->bi_op_search = glue_back_search;
616 * hooks for slap tools
618 bi->bi_tool_entry_open = glue_tool_entry_open;
619 bi->bi_tool_entry_close = glue_tool_entry_close;
620 bi->bi_tool_entry_first = glue_tool_entry_first;
621 bi->bi_tool_entry_next = glue_tool_entry_next;
622 bi->bi_tool_entry_get = glue_tool_entry_get;
623 bi->bi_tool_entry_put = glue_tool_entry_put;
624 bi->bi_tool_entry_reindex = glue_tool_entry_reindex;
625 bi->bi_tool_sync = glue_tool_sync;
627 gi = (glueinfo *)ch_realloc(gi,
629 gi->nodes * sizeof(gluenode));
631 gi->n[gi->nodes].be = be;
632 dnParent( &be->be_nsuffix[0], &gi->n[gi->nodes].pdn );
636 /* One more node for the master */
637 gi = (glueinfo *)ch_realloc(gi,
638 sizeof(glueinfo) + gi->nodes * sizeof(gluenode));
639 gi->n[gi->nodes].be = &gi->bd;
640 dnParent( &b1->be_nsuffix[0], &gi->n[gi->nodes].pdn );
645 /* If there are any unresolved subordinates left, something is wrong */