1 /* backglue.c - backend glue routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2001-2003 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
18 * Functions to glue a bunch of other backends into a single tree.
19 * All of the glued backends must share a common suffix. E.g., you
20 * can glue o=foo and ou=bar,o=foo but you can't glue o=foo and o=bar.
22 * This uses the backend structures and routines extensively, but is
23 * not an actual backend of its own. To use it you must add a "subordinate"
24 * keyword to the configuration of other backends. Subordinates will
25 * automatically be connected to their parent backend.
27 * The purpose of these functions is to allow you to split a single database
28 * into pieces (for load balancing purposes, whatever) but still be able
29 * to treat it as a single database after it's been split. As such, each
30 * of the glued backends should have identical rootdn and rootpw.
32 * If you need more elaborate configuration, you probably should be using
41 #include <ac/string.h>
42 #include <ac/socket.h>
47 typedef struct gluenode {
52 typedef struct glueinfo {
60 static BackendDB *glueBack;
62 static slap_response glue_back_response;
64 /* Just like select_backend, but only for our backends */
71 glueinfo *gi = (glueinfo *) be->bd_info;
75 bv.bv_len = strlen(dn);
76 bv.bv_val = (char *) dn;
78 for (i = 0; i<gi->nodes; i++) {
79 if (dnIsSuffix(&bv, &gi->n[i].be->be_nsuffix[0])) {
86 /* This function will only be called in tool mode */
93 static int glueOpened = 0;
95 if (glueOpened) return 0;
99 /* If we were invoked in tool mode, open all the underlying backends */
100 if (slapMode & SLAP_TOOL_MODE) {
101 rc = backend_startup (NULL);
102 } /* other case is impossible */
106 /* This function will only be called in tool mode */
112 static int glueClosed = 0;
115 if (glueClosed) return 0;
119 if (slapMode & SLAP_TOOL_MODE) {
120 rc = backend_shutdown (NULL);
130 glueinfo *gi = (glueinfo *) be->bd_info;
131 static int glueOpened = 0;
134 if (glueOpened) return 0;
138 gi->bd.be_acl = be->be_acl;
140 if (gi->bd.bd_info->bi_db_open)
141 rc = gi->bd.bd_info->bi_db_open(&gi->bd);
151 glueinfo *gi = (glueinfo *) be->bd_info;
152 static int glueClosed = 0;
154 if (glueClosed) return 0;
158 /* Close the master */
159 if (gi->bd.bd_info->bi_db_close)
160 gi->bd.bd_info->bi_db_close( &gi->bd );
166 glue_back_db_destroy (
170 glueinfo *gi = (glueinfo *) be->bd_info;
172 if (gi->bd.bd_info->bi_db_destroy)
173 gi->bd.bd_info->bi_db_destroy( &gi->bd );
178 typedef struct glue_state {
189 glue_back_response ( Operation *op, SlapReply *rs )
191 glue_state *gs = op->o_callback->sc_private;
193 switch(rs->sr_type) {
195 if ( gs->is_slimit && rs->sr_nentries >= gs->slimit ) {
196 gs->err = LDAP_SIZELIMIT_EXCEEDED;
201 return SLAP_CB_CONTINUE;
204 if ( gs->is_slimit && rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
205 && rs->sr_nentries >= gs->slimit ) {
206 gs->err = LDAP_SIZELIMIT_EXCEEDED;
209 if (rs->sr_err == LDAP_SUCCESS || gs->err != LDAP_SUCCESS) {
210 gs->err = rs->sr_err;
212 if (gs->err == LDAP_SUCCESS && gs->matched) {
213 ch_free (gs->matched);
217 if (gs->err != LDAP_SUCCESS && rs->sr_matched) {
219 len = strlen (rs->sr_matched);
220 if (len > gs->matchlen) {
222 ch_free (gs->matched);
223 gs->matched = ch_strdup (rs->sr_matched);
231 for (i=0; rs->sr_ref[i].bv_val; i++);
235 new = ch_malloc ((i+1)*sizeof(struct berval));
237 new = ch_realloc(gs->refs,
238 (j+i+1)*sizeof(struct berval));
240 for (k=0; k<i; j++,k++) {
241 ber_dupbv( &new[j], &rs->sr_ref[k] );
243 new[j].bv_val = NULL;
252 glue_back_search ( Operation *op, SlapReply *rs )
254 BackendDB *b0 = op->o_bd;
255 glueinfo *gi = (glueinfo *) b0->bd_info;
258 glue_state gs = {0, 0, 0, 0, NULL, 0, NULL};
259 slap_callback cb = { NULL, glue_back_response, NULL, NULL };
260 int scope0, slimit0, tlimit0;
261 struct berval dn, ndn;
263 gs.is_slimit = ( op->ors_slimit > 0 );
267 cb.sc_next = op->o_callback;
269 if (op->ors_tlimit) {
270 stoptime = slap_get_time () + op->ors_tlimit;
273 switch (op->ors_scope) {
274 case LDAP_SCOPE_BASE:
275 op->o_bd = glue_back_select (b0, op->o_req_ndn.bv_val);
277 if (op->o_bd && op->o_bd->be_search) {
278 rs->sr_err = op->o_bd->be_search( op, rs );
280 send_ldap_error(op, rs, LDAP_UNWILLING_TO_PERFORM,
281 "No search target found");
285 case LDAP_SCOPE_ONELEVEL:
286 case LDAP_SCOPE_SUBTREE:
287 op->o_callback = &cb;
288 rs->sr_err = gs.err = LDAP_UNWILLING_TO_PERFORM;
289 scope0 = op->ors_scope;
290 if ( gs.is_slimit ) {
291 slimit0 = gs.slimit = op->ors_slimit;
293 tlimit0 = op->ors_tlimit;
298 * Execute in reverse order, most general first
300 for (i = gi->nodes-1; i >= 0; i--) {
301 if (!gi->n[i].be || !gi->n[i].be->be_search)
304 op->ors_tlimit = stoptime - slap_get_time ();
305 if (op->ors_tlimit <= 0) {
306 rs->sr_err = gs.err = LDAP_TIMELIMIT_EXCEEDED;
310 if ( gs.is_slimit ) {
311 op->ors_slimit = slimit0 - rs->sr_nentries;
312 if (op->ors_slimit < 0) {
313 rs->sr_err = gs.err = LDAP_SIZELIMIT_EXCEEDED;
324 op->o_bd = gi->n[i].be;
325 if (scope0 == LDAP_SCOPE_ONELEVEL &&
326 dn_match(&gi->n[i].pdn, &ndn))
328 op->ors_scope = LDAP_SCOPE_BASE;
329 op->o_req_dn = op->o_bd->be_suffix[0];
330 op->o_req_ndn = op->o_bd->be_nsuffix[0];
331 rs->sr_err = op->o_bd->be_search(op, rs);
333 } else if (scope0 == LDAP_SCOPE_SUBTREE &&
334 dnIsSuffix(&op->o_bd->be_nsuffix[0], &ndn))
336 op->o_req_dn = op->o_bd->be_suffix[0];
337 op->o_req_ndn = op->o_bd->be_nsuffix[0];
338 rs->sr_err = op->o_bd->be_search( op, rs );
340 } else if (dnIsSuffix(&ndn, &op->o_bd->be_nsuffix[0])) {
341 rs->sr_err = op->o_bd->be_search( op, rs );
347 * Add errors that should result in dropping
350 case LDAP_SIZELIMIT_EXCEEDED:
351 case LDAP_TIMELIMIT_EXCEEDED:
352 case LDAP_ADMINLIMIT_EXCEEDED:
360 op->ors_scope = scope0;
361 if ( gs.is_slimit ) {
362 op->ors_slimit = slimit0;
364 op->ors_tlimit = tlimit0;
370 op->o_callback = cb.sc_next;
372 rs->sr_matched = gs.matched;
373 rs->sr_ref = gs.refs;
375 send_ldap_result( op, rs );
382 ber_bvarray_free(gs.refs);
388 glue_tool_entry_open (
393 /* We don't know which backend to talk to yet, so just
394 * remember the mode and move on...
404 glue_tool_entry_close (
411 if (!glueBack->be_entry_close)
413 rc = glueBack->be_entry_close (glueBack);
419 glue_tool_entry_first (
423 glueinfo *gi = (glueinfo *) b0->bd_info;
426 /* If we're starting from scratch, start at the most general */
428 for (i = gi->nodes-1; i >= 0; i--) {
429 if (gi->n[i].be->be_entry_open &&
430 gi->n[i].be->be_entry_first) {
431 glueBack = gi->n[i].be;
437 if (!glueBack || glueBack->be_entry_open (glueBack, glueMode) != 0)
440 return glueBack->be_entry_first (glueBack);
444 glue_tool_entry_next (
448 glueinfo *gi = (glueinfo *) b0->bd_info;
452 if (!glueBack || !glueBack->be_entry_next)
455 rc = glueBack->be_entry_next (glueBack);
457 /* If we ran out of entries in one database, move on to the next */
459 glueBack->be_entry_close (glueBack);
460 for (i=0; i<gi->nodes; i++) {
461 if (gi->n[i].be == glueBack)
468 glueBack = gi->n[i-1].be;
469 rc = glue_tool_entry_first (b0);
476 glue_tool_entry_get (
481 if (!glueBack || !glueBack->be_entry_get)
484 return glueBack->be_entry_get (glueBack, id);
488 glue_tool_entry_put (
497 be = glue_back_select (b0, e->e_ndn);
498 if (!be->be_entry_put)
502 rc = be->be_entry_open (be, glueMode);
505 } else if (be != glueBack) {
506 /* If this entry belongs in a different branch than the
507 * previous one, close the current database and open the
510 glueBack->be_entry_close (glueBack);
511 rc = be->be_entry_open (be, glueMode);
516 return be->be_entry_put (be, e, text);
520 glue_tool_entry_reindex (
525 if (!glueBack || !glueBack->be_entry_reindex)
528 return glueBack->be_entry_reindex (glueBack, id);
536 glueinfo *gi = (glueinfo *) b0->bd_info;
539 /* just sync everyone */
540 for (i = 0; i<gi->nodes; i++)
541 if (gi->n[i].be->be_sync)
542 gi->n[i].be->be_sync (gi->n[i].be);
550 int cont = num_subordinates;
552 BackendInfo *bi = NULL;
555 /* While there are subordinate backends, search backwards through the
556 * backends and connect them to their superior.
558 for (i = nBackendDB - 1, b1=&backendDB[i]; cont && i>=0; b1--,i--) {
559 if (SLAP_GLUE_SUBORDINATE ( b1 ) ) {
560 /* The last database cannot be a subordinate of noone */
561 if (i == nBackendDB - 1) {
562 b1->be_flags ^= SLAP_BFLAG_GLUE_SUBORDINATE;
567 for (j = i-1, be=&backendDB[j]; j>=0; be--,j--) {
568 if ( ! SLAP_GLUE_SUBORDINATE( be ) ) {
571 /* We will only link it once */
572 if ( SLAP_GLUE_LINKED( be ) ) {
575 if (!dnIsSuffix(&be->be_nsuffix[0], &b1->be_nsuffix[0])) {
579 be->be_flags |= SLAP_BFLAG_GLUE_LINKED;
581 /* We create a copy of the superior's be
582 * structure, pointing to all of its original
583 * information. Then we replace elements of
584 * the superior's info with our own. The copy
585 * is used whenever we have operations to pass
586 * down to the real database.
588 b1->be_flags |= SLAP_BFLAG_GLUE_INSTANCE;
589 gi = (glueinfo *)ch_malloc(sizeof(glueinfo));
592 gi->bi = *b1->bd_info;
593 bi = (BackendInfo *)gi;
594 bi->bi_open = glue_back_open;
595 bi->bi_close = glue_back_close;
596 bi->bi_db_open = glue_back_db_open;
597 bi->bi_db_close = glue_back_db_close;
598 bi->bi_db_destroy = glue_back_db_destroy;
600 bi->bi_op_search = glue_back_search;
603 * hooks for slap tools
605 bi->bi_tool_entry_open = glue_tool_entry_open;
606 bi->bi_tool_entry_close = glue_tool_entry_close;
607 bi->bi_tool_entry_first = glue_tool_entry_first;
608 bi->bi_tool_entry_next = glue_tool_entry_next;
609 bi->bi_tool_entry_get = glue_tool_entry_get;
610 bi->bi_tool_entry_put = glue_tool_entry_put;
611 bi->bi_tool_entry_reindex = glue_tool_entry_reindex;
612 bi->bi_tool_sync = glue_tool_sync;
613 /* FIXME : will support later */
614 bi->bi_tool_dn2id_get = 0;
615 bi->bi_tool_id2entry_get = 0;
616 bi->bi_tool_entry_modify = 0;
618 gi = (glueinfo *)ch_realloc(gi,
620 gi->nodes * sizeof(gluenode));
622 gi->n[gi->nodes].be = be;
623 dnParent( &be->be_nsuffix[0], &gi->n[gi->nodes].pdn );
627 /* One more node for the master */
628 gi = (glueinfo *)ch_realloc(gi,
629 sizeof(glueinfo) + gi->nodes * sizeof(gluenode));
630 gi->n[gi->nodes].be = &gi->bd;
631 dnParent( &b1->be_nsuffix[0], &gi->n[gi->nodes].pdn );
633 b1->bd_info = (BackendInfo *)gi;
636 /* If there are any unresolved subordinates left, something is wrong */