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 {
184 slap_callback *prevcb;
188 glue_back_response ( Operation *op, SlapReply *rs )
190 glue_state *gs = op->o_callback->sc_private;
191 slap_callback *tmp = op->o_callback;
193 switch(rs->sr_type) {
196 op->o_callback = gs->prevcb;
197 if (op->o_callback && op->o_callback->sc_response) {
198 rs->sr_err = op->o_callback->sc_response( op, rs );
199 } else rs->sr_err = SLAP_CB_CONTINUE;
200 op->o_callback = tmp;
204 if (rs->sr_err == LDAP_SUCCESS || gs->err != LDAP_SUCCESS)
205 gs->err = rs->sr_err;
206 if (gs->err == LDAP_SUCCESS && gs->matched) {
207 ch_free (gs->matched);
211 if (gs->err != LDAP_SUCCESS && rs->sr_matched) {
213 len = strlen (rs->sr_matched);
214 if (len > gs->matchlen) {
216 ch_free (gs->matched);
217 gs->matched = ch_strdup (rs->sr_matched);
225 for (i=0; rs->sr_ref[i].bv_val; i++);
229 new = ch_malloc ((i+1)*sizeof(struct berval));
231 new = ch_realloc(gs->refs,
232 (j+i+1)*sizeof(struct berval));
234 for (k=0; k<i; j++,k++) {
235 ber_dupbv( &new[j], &rs->sr_ref[k] );
237 new[j].bv_val = NULL;
246 glue_back_search ( Operation *op, SlapReply *rs )
248 BackendDB *b0 = op->o_bd;
249 glueinfo *gi = (glueinfo *) b0->bd_info;
252 glue_state gs = {0, 0, NULL, 0, NULL, NULL};
253 slap_callback cb = { glue_back_response, NULL };
254 int scope0, slimit0, tlimit0;
255 struct berval dn, ndn;
259 gs.prevcb = op->o_callback;
261 if (op->ors_tlimit) {
262 stoptime = slap_get_time () + op->ors_tlimit;
265 switch (op->ors_scope) {
266 case LDAP_SCOPE_BASE:
267 op->o_bd = glue_back_select (b0, op->o_req_ndn.bv_val);
269 if (op->o_bd && op->o_bd->be_search) {
270 rs->sr_err = op->o_bd->be_search( op, rs );
272 send_ldap_error(op, rs, LDAP_UNWILLING_TO_PERFORM,
273 "No search target found");
277 case LDAP_SCOPE_ONELEVEL:
278 case LDAP_SCOPE_SUBTREE:
279 op->o_callback = &cb;
280 rs->sr_err = gs.err = LDAP_UNWILLING_TO_PERFORM;
281 scope0 = op->ors_scope;
282 slimit0 = op->ors_slimit;
283 tlimit0 = op->ors_tlimit;
288 * Execute in reverse order, most general first
290 for (i = gi->nodes-1; i >= 0; i--) {
291 if (!gi->n[i].be || !gi->n[i].be->be_search)
294 op->ors_tlimit = stoptime - slap_get_time ();
295 if (op->ors_tlimit <= 0) {
296 rs->sr_err = gs.err = LDAP_TIMELIMIT_EXCEEDED;
301 op->ors_slimit = slimit0 - rs->sr_nentries;
302 if (op->ors_slimit <= 0) {
303 rs->sr_err = gs.err = LDAP_SIZELIMIT_EXCEEDED;
314 op->o_bd = gi->n[i].be;
315 if (scope0 == LDAP_SCOPE_ONELEVEL &&
316 dn_match(&gi->n[i].pdn, &ndn)) {
317 op->ors_scope = LDAP_SCOPE_BASE;
318 op->o_req_dn = op->o_bd->be_suffix[0];
319 op->o_req_ndn = op->o_bd->be_nsuffix[0];
320 rs->sr_err = op->o_bd->be_search(op, rs);
322 } else if (scope0 == LDAP_SCOPE_SUBTREE &&
323 dnIsSuffix(&op->o_bd->be_nsuffix[0], &ndn)) {
324 op->o_req_dn = op->o_bd->be_suffix[0];
325 op->o_req_ndn = op->o_bd->be_nsuffix[0];
326 rs->sr_err = op->o_bd->be_search( op, rs );
328 } else if (dnIsSuffix(&ndn, &op->o_bd->be_nsuffix[0])) {
329 rs->sr_err = op->o_bd->be_search( op, rs );
335 * Add errors that should result in dropping
338 case LDAP_SIZELIMIT_EXCEEDED:
339 case LDAP_TIMELIMIT_EXCEEDED:
340 case LDAP_ADMINLIMIT_EXCEEDED:
348 op->ors_scope = scope0;
349 op->ors_slimit = slimit0;
350 op->ors_tlimit = tlimit0;
356 op->o_callback = gs.prevcb;
358 rs->sr_matched = gs.matched;
359 rs->sr_ref = gs.refs;
361 send_ldap_result( op, rs );
368 ber_bvarray_free(gs.refs);
374 glue_tool_entry_open (
379 /* We don't know which backend to talk to yet, so just
380 * remember the mode and move on...
390 glue_tool_entry_close (
397 if (!glueBack->be_entry_close)
399 rc = glueBack->be_entry_close (glueBack);
405 glue_tool_entry_first (
409 glueinfo *gi = (glueinfo *) b0->bd_info;
412 /* If we're starting from scratch, start at the most general */
414 for (i = gi->nodes-1; i >= 0; i--) {
415 if (gi->n[i].be->be_entry_open &&
416 gi->n[i].be->be_entry_first) {
417 glueBack = gi->n[i].be;
423 if (!glueBack || glueBack->be_entry_open (glueBack, glueMode) != 0)
426 return glueBack->be_entry_first (glueBack);
430 glue_tool_entry_next (
434 glueinfo *gi = (glueinfo *) b0->bd_info;
438 if (!glueBack || !glueBack->be_entry_next)
441 rc = glueBack->be_entry_next (glueBack);
443 /* If we ran out of entries in one database, move on to the next */
445 glueBack->be_entry_close (glueBack);
446 for (i=0; i<gi->nodes; i++) {
447 if (gi->n[i].be == glueBack)
454 glueBack = gi->n[i-1].be;
455 rc = glue_tool_entry_first (b0);
462 glue_tool_entry_get (
467 if (!glueBack || !glueBack->be_entry_get)
470 return glueBack->be_entry_get (glueBack, id);
474 glue_tool_entry_put (
483 be = glue_back_select (b0, e->e_ndn);
484 if (!be->be_entry_put)
488 rc = be->be_entry_open (be, glueMode);
491 } else if (be != glueBack) {
492 /* If this entry belongs in a different branch than the
493 * previous one, close the current database and open the
496 glueBack->be_entry_close (glueBack);
497 rc = be->be_entry_open (be, glueMode);
502 return be->be_entry_put (be, e, text);
506 glue_tool_entry_reindex (
511 if (!glueBack || !glueBack->be_entry_reindex)
514 return glueBack->be_entry_reindex (glueBack, id);
522 glueinfo *gi = (glueinfo *) b0->bd_info;
525 /* just sync everyone */
526 for (i = 0; i<gi->nodes; i++)
527 if (gi->n[i].be->be_sync)
528 gi->n[i].be->be_sync (gi->n[i].be);
536 int cont = num_subordinates;
538 BackendInfo *bi = NULL;
541 /* While there are subordinate backends, search backwards through the
542 * backends and connect them to their superior.
544 for (i = nBackendDB - 1, b1=&backendDB[i]; cont && i>=0; b1--,i--) {
545 if (SLAP_GLUE_SUBORDINATE ( b1 ) ) {
546 /* The last database cannot be a subordinate of noone */
547 if (i == nBackendDB - 1) {
548 b1->be_flags ^= SLAP_BFLAG_GLUE_SUBORDINATE;
553 for (j = i-1, be=&backendDB[j]; j>=0; be--,j--) {
554 if ( ! SLAP_GLUE_SUBORDINATE( be ) ) {
557 /* We will only link it once */
558 if ( SLAP_GLUE_LINKED( be ) ) {
561 if (!dnIsSuffix(&be->be_nsuffix[0], &b1->be_nsuffix[0])) {
565 be->be_flags |= SLAP_BFLAG_GLUE_LINKED;
567 /* We create a copy of the superior's be
568 * structure, pointing to all of its original
569 * information. Then we replace elements of
570 * the superior's info with our own. The copy
571 * is used whenever we have operations to pass
572 * down to the real database.
574 b1->be_flags |= SLAP_BFLAG_GLUE_INSTANCE;
575 gi = (glueinfo *)ch_malloc(sizeof(glueinfo));
578 gi->bi = *b1->bd_info;
579 bi = (BackendInfo *)gi;
580 bi->bi_open = glue_back_open;
581 bi->bi_close = glue_back_close;
582 bi->bi_db_open = glue_back_db_open;
583 bi->bi_db_close = glue_back_db_close;
584 bi->bi_db_destroy = glue_back_db_destroy;
586 bi->bi_op_search = glue_back_search;
589 * hooks for slap tools
591 bi->bi_tool_entry_open = glue_tool_entry_open;
592 bi->bi_tool_entry_close = glue_tool_entry_close;
593 bi->bi_tool_entry_first = glue_tool_entry_first;
594 bi->bi_tool_entry_next = glue_tool_entry_next;
595 bi->bi_tool_entry_get = glue_tool_entry_get;
596 bi->bi_tool_entry_put = glue_tool_entry_put;
597 bi->bi_tool_entry_reindex = glue_tool_entry_reindex;
598 bi->bi_tool_sync = glue_tool_sync;
599 /* FIXME : will support later */
600 bi->bi_tool_dn2id_get = 0;
601 bi->bi_tool_id2entry_get = 0;
602 bi->bi_tool_entry_modify = 0;
604 gi = (glueinfo *)ch_realloc(gi,
606 gi->nodes * sizeof(gluenode));
608 gi->n[gi->nodes].be = be;
609 dnParent( &be->be_nsuffix[0], &gi->n[gi->nodes].pdn );
613 /* One more node for the master */
614 gi = (glueinfo *)ch_realloc(gi,
615 sizeof(glueinfo) + gi->nodes * sizeof(gluenode));
616 gi->n[gi->nodes].be = &gi->bd;
617 dnParent( &b1->be_nsuffix[0], &gi->n[gi->nodes].pdn );
619 b1->bd_info = (BackendInfo *)gi;
622 /* If there are any unresolved subordinates left, something is wrong */