1 /* glue.c - backend glue overlay */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2001-2005 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 * The purpose of these functions is to allow you to split a single database
23 * into pieces (for load balancing purposes, whatever) but still be able
24 * to treat it as a single database after it's been split. As such, each
25 * of the glued backends should have identical rootdn.
31 #ifdef SLAPD_OVER_GLUE
35 #include <ac/string.h>
36 #include <ac/socket.h>
41 typedef struct gluenode {
48 typedef struct glueinfo {
54 static slap_overinst glue;
57 static BackendDB *glueBack;
59 static slap_response glue_op_response;
61 /* Just like select_backend, but only for our backends */
68 slap_overinst *on = (slap_overinst *)be->bd_info;
69 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
72 for (i = 0; i<gi->gi_nodes; i++) {
73 assert( gi->gi_n[i].gn_be->be_nsuffix );
75 if (dnIsSuffix(dn, &gi->gi_n[i].gn_be->be_nsuffix[0])) {
76 return gi->gi_n[i].gn_be;
79 be->bd_info = on->on_info->oi_orig;
84 typedef struct glue_state {
94 glue_op_response ( Operation *op, SlapReply *rs )
96 glue_state *gs = op->o_callback->sc_private;
100 if ( gs->slimit != SLAP_NO_LIMIT
101 && rs->sr_nentries >= gs->slimit )
103 rs->sr_err = gs->err = LDAP_SIZELIMIT_EXCEEDED;
108 return SLAP_CB_CONTINUE;
111 if (rs->sr_err == LDAP_SUCCESS ||
112 rs->sr_err == LDAP_SIZELIMIT_EXCEEDED ||
113 rs->sr_err == LDAP_TIMELIMIT_EXCEEDED ||
114 rs->sr_err == LDAP_ADMINLIMIT_EXCEEDED ||
115 rs->sr_err == LDAP_NO_SUCH_OBJECT ||
116 gs->err != LDAP_SUCCESS)
117 gs->err = rs->sr_err;
118 if (gs->err == LDAP_SUCCESS && gs->matched) {
119 ch_free (gs->matched);
123 if (gs->err != LDAP_SUCCESS && rs->sr_matched) {
125 len = strlen (rs->sr_matched);
126 if (len > gs->matchlen) {
128 ch_free (gs->matched);
129 gs->matched = ch_strdup (rs->sr_matched);
137 for (i=0; rs->sr_ref[i].bv_val; i++);
141 new = ch_malloc ((i+1)*sizeof(struct berval));
143 new = ch_realloc(gs->refs,
144 (j+i+1)*sizeof(struct berval));
146 for (k=0; k<i; j++,k++) {
147 ber_dupbv( &new[j], &rs->sr_ref[k] );
149 new[j].bv_val = NULL;
165 glue_op_func ( Operation *op, SlapReply *rs )
167 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
168 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
169 BackendDB *b0 = op->o_bd;
170 BackendInfo *bi0 = op->o_bd->bd_info;
172 enum glue_which which;
175 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
176 b0->bd_info = on->on_info->oi_orig;
179 case LDAP_REQ_ADD: which = op_add; break;
180 case LDAP_REQ_DELETE: which = op_delete; break;
181 case LDAP_REQ_MODIFY: which = op_modify; break;
182 case LDAP_REQ_MODRDN: which = op_modrdn; break;
185 func = &op->o_bd->bd_info->bi_op_modify;
187 rc = func[which]( op, rs );
189 rc = SLAP_CB_CONTINUE;
192 op->o_bd->bd_info = bi0;
197 glue_op_search ( Operation *op, SlapReply *rs )
199 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
200 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
201 BackendDB *b0 = op->o_bd;
202 BackendDB *b1 = NULL, *btmp;
203 BackendInfo *bi0 = op->o_bd->bd_info;
206 glue_state gs = {0, 0, 0, NULL, 0, NULL};
207 slap_callback cb = { NULL, glue_op_response, NULL, NULL };
208 int scope0, slimit0, tlimit0;
209 struct berval dn, ndn, *pdn;
213 cb.sc_next = op->o_callback;
215 stoptime = slap_get_time () + op->ors_tlimit;
217 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
218 b0->bd_info = on->on_info->oi_orig;
220 switch (op->ors_scope) {
221 case LDAP_SCOPE_BASE:
222 return SLAP_CB_CONTINUE;
224 case LDAP_SCOPE_ONELEVEL:
225 case LDAP_SCOPE_SUBTREE:
226 #ifdef LDAP_SCOPE_SUBORDINATE
227 case LDAP_SCOPE_SUBORDINATE: /* FIXME */
232 if (op->o_bd && op->o_bd->be_search) {
233 rs->sr_err = op->o_bd->be_search( op, rs );
235 send_ldap_error(op, rs, LDAP_UNWILLING_TO_PERFORM,
236 "No search target found");
242 op->o_callback = &cb;
243 rs->sr_err = gs.err = LDAP_UNWILLING_TO_PERFORM;
244 scope0 = op->ors_scope;
245 slimit0 = gs.slimit = op->ors_slimit;
246 tlimit0 = op->ors_tlimit;
252 * Execute in reverse order, most general first
254 for (i = gi->gi_nodes; i >= 0; i--) {
255 if ( i == gi->gi_nodes ) {
259 btmp = gi->gi_n[i].gn_be;
260 pdn = &gi->gi_n[i].gn_pdn;
262 if (!btmp || !btmp->be_search)
264 if (!dnIsSuffix(&btmp->be_nsuffix[0], &b1->be_nsuffix[0]))
266 if (tlimit0 != SLAP_NO_LIMIT) {
267 op->ors_tlimit = stoptime - slap_get_time ();
268 if (op->ors_tlimit <= 0) {
269 rs->sr_err = gs.err = LDAP_TIMELIMIT_EXCEEDED;
273 if (slimit0 != SLAP_NO_LIMIT) {
274 op->ors_slimit = slimit0 - rs->sr_nentries;
275 if (op->ors_slimit < 0) {
276 rs->sr_err = gs.err = LDAP_SIZELIMIT_EXCEEDED;
289 assert( op->o_bd->be_suffix );
290 assert( op->o_bd->be_nsuffix );
292 if (scope0 == LDAP_SCOPE_ONELEVEL &&
295 op->ors_scope = LDAP_SCOPE_BASE;
296 op->o_req_dn = op->o_bd->be_suffix[0];
297 op->o_req_ndn = op->o_bd->be_nsuffix[0];
298 rs->sr_err = op->o_bd->be_search(op, rs);
300 } else if (scope0 == LDAP_SCOPE_SUBTREE &&
301 dn_match(&op->o_bd->be_nsuffix[0], &ndn))
303 rs->sr_err = op->o_bd->be_search( op, rs );
305 } else if (scope0 == LDAP_SCOPE_SUBTREE &&
306 dnIsSuffix(&op->o_bd->be_nsuffix[0], &ndn))
308 op->o_req_dn = op->o_bd->be_suffix[0];
309 op->o_req_ndn = op->o_bd->be_nsuffix[0];
310 rs->sr_err = op->o_bd->be_search( op, rs );
311 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
312 gs.err = LDAP_SUCCESS;
315 } else if (dnIsSuffix(&ndn, &op->o_bd->be_nsuffix[0])) {
316 rs->sr_err = op->o_bd->be_search( op, rs );
322 * Add errors that should result in dropping
325 case LDAP_SIZELIMIT_EXCEEDED:
326 case LDAP_TIMELIMIT_EXCEEDED:
327 case LDAP_ADMINLIMIT_EXCEEDED:
328 case LDAP_NO_SUCH_OBJECT:
336 op->ors_scope = scope0;
337 op->ors_slimit = slimit0;
338 op->ors_tlimit = tlimit0;
344 if ( !op->o_abandon ) {
345 op->o_callback = cb.sc_next;
347 rs->sr_matched = gs.matched;
348 rs->sr_ref = gs.refs;
350 send_ldap_result( op, rs );
354 op->o_bd->bd_info = bi0;
358 ber_bvarray_free(gs.refs);
362 static BackendDB toolDB;
365 glue_tool_entry_open (
370 slap_overinfo *oi = (slap_overinfo *)b0->bd_info;
372 /* We don't know which backend to talk to yet, so just
373 * remember the mode and move on...
379 toolDB.bd_info = oi->oi_orig;
385 glue_tool_entry_close (
392 if (!glueBack->be_entry_close)
394 rc = glueBack->be_entry_close (glueBack);
399 static slap_overinst *
404 slap_overinfo *oi = (slap_overinfo *)bi;
407 for ( on = oi->oi_list; on; on=on->on_next ) {
408 if ( !strcmp( on->on_bi.bi_type, glue.on_bi.bi_type ))
414 /* This function will only be called in tool mode */
420 slap_overinst *on = glue_tool_inst( bi );
421 glueinfo *gi = on->on_bi.bi_private;
422 static int glueOpened = 0;
425 if (glueOpened) return 0;
429 /* If we were invoked in tool mode, open all the underlying backends */
430 if (slapMode & SLAP_TOOL_MODE) {
431 rc = backend_startup( NULL );
432 } /* other case is impossible */
436 /* This function will only be called in tool mode */
442 slap_overinst *on = glue_tool_inst( bi );
443 glueinfo *gi = on->on_bi.bi_private;
444 static int glueClosed = 0;
447 if (glueClosed) return 0;
451 if (slapMode & SLAP_TOOL_MODE) {
452 rc = backend_shutdown( NULL );
458 glue_entry_release_rw (
469 b2.bd_info = (BackendInfo *)glue_tool_inst( op->o_bd->bd_info );
470 op->o_bd = glue_back_select (&b2, &e->e_nname);
472 rc = op->o_bd->be_release( op, e, rw );
478 glue_tool_entry_first (
482 slap_overinst *on = glue_tool_inst( b0->bd_info );
483 glueinfo *gi = on->on_bi.bi_private;
486 /* If we're starting from scratch, start at the most general */
488 if ( toolDB.be_entry_open && toolDB.be_entry_first ) {
491 for (i = gi->gi_nodes-1; i >= 0; i--) {
492 if (gi->gi_n[i].gn_be->be_entry_open &&
493 gi->gi_n[i].gn_be->be_entry_first) {
494 glueBack = gi->gi_n[i].gn_be;
500 if (!glueBack || !glueBack->be_entry_open || !glueBack->be_entry_first ||
501 glueBack->be_entry_open (glueBack, glueMode) != 0)
504 return glueBack->be_entry_first (glueBack);
508 glue_tool_entry_next (
512 slap_overinst *on = glue_tool_inst( b0->bd_info );
513 glueinfo *gi = on->on_bi.bi_private;
517 if (!glueBack || !glueBack->be_entry_next)
520 rc = glueBack->be_entry_next (glueBack);
522 /* If we ran out of entries in one database, move on to the next */
524 if ( glueBack && glueBack->be_entry_close )
525 glueBack->be_entry_close (glueBack);
526 for (i=0; i<gi->gi_nodes; i++) {
527 if (gi->gi_n[i].gn_be == glueBack)
534 glueBack = gi->gi_n[i-1].gn_be;
535 rc = glue_tool_entry_first (b0);
542 glue_tool_entry_get (
547 if (!glueBack || !glueBack->be_entry_get)
550 return glueBack->be_entry_get (glueBack, id);
554 glue_tool_entry_put (
564 b2.bd_info = (BackendInfo *)glue_tool_inst( b0->bd_info );
565 be = glue_back_select (&b2, &e->e_nname);
566 if ( be == &b2 ) be = &toolDB;
568 if (!be->be_entry_put)
572 rc = be->be_entry_open (be, glueMode);
575 } else if (be != glueBack) {
576 /* If this entry belongs in a different branch than the
577 * previous one, close the current database and open the
580 glueBack->be_entry_close (glueBack);
581 rc = be->be_entry_open (be, glueMode);
586 return be->be_entry_put (be, e, text);
590 glue_tool_entry_reindex (
595 if (!glueBack || !glueBack->be_entry_reindex)
598 return glueBack->be_entry_reindex (glueBack, id);
606 slap_overinst *on = glue_tool_inst( b0->bd_info );
607 glueinfo *gi = on->on_bi.bi_private;
608 BackendInfo *bi = b0->bd_info;
611 /* just sync everyone */
612 for (i = 0; i<gi->gi_nodes; i++)
613 if (gi->gi_n[i].gn_be->be_sync)
614 gi->gi_n[i].gn_be->be_sync (gi->gi_n[i].gn_be);
615 b0->bd_info = on->on_info->oi_orig;
627 slap_overinst *on = (slap_overinst *)be->bd_info;
628 slap_overinfo *oi = on->on_info;
631 gi = ch_calloc( 1, sizeof(glueinfo));
632 on->on_bi.bi_private = gi;
633 dnParent( be->be_nsuffix, &gi->gi_pdn );
635 /* Currently the overlay framework doesn't handle these entry points
636 * but we need them....
638 oi->oi_bi.bi_open = glue_open;
639 oi->oi_bi.bi_close = glue_close;
641 oi->oi_bi.bi_entry_release_rw = glue_entry_release_rw;
643 oi->oi_bi.bi_tool_entry_open = glue_tool_entry_open;
644 oi->oi_bi.bi_tool_entry_close = glue_tool_entry_close;
645 oi->oi_bi.bi_tool_entry_first = glue_tool_entry_first;
646 oi->oi_bi.bi_tool_entry_next = glue_tool_entry_next;
647 oi->oi_bi.bi_tool_entry_get = glue_tool_entry_get;
648 oi->oi_bi.bi_tool_entry_put = glue_tool_entry_put;
649 oi->oi_bi.bi_tool_entry_reindex = glue_tool_entry_reindex;
650 oi->oi_bi.bi_tool_sync = glue_tool_sync;
652 /*FIXME : need to add support */
653 oi->oi_bi.bi_tool_dn2id_get = 0;
654 oi->oi_bi.bi_tool_id2entry_get = 0;
655 oi->oi_bi.bi_tool_entry_modify = 0;
665 slap_overinst *on = (slap_overinst *)be->bd_info;
666 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
669 return SLAP_CB_CONTINUE;
677 slap_overinst *on = (slap_overinst *)be->bd_info;
678 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
681 for ( i=0; i<gi->gi_nodes; i++ ) {
682 gi->gi_n[i].gn_be = backendDB + gi->gi_n[i].gn_bx;
692 slap_overinst *on = (slap_overinst *)be->bd_info;
694 on->on_info->oi_bi.bi_db_close = NULL;
707 slap_overinst *on = (slap_overinst *)be->bd_info;
708 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
710 if ( strcasecmp( argv[0], "glue-sub" ) == 0 ) {
713 struct berval bv, dn;
717 fprintf( stderr, "%s: line %d: too few arguments in "
718 "\"glue-sub <suffixDN> [async]\"\n", fname, lineno );
722 if ( strcasecmp( argv[2], "async" )) {
723 fprintf( stderr, "%s: line %d: unrecognized option "
724 "\"%s\" ignored.\n", fname, lineno, argv[2] );
729 ber_str2bv( argv[1], 0, 0, &bv );
730 if ( dnNormalize( 0, NULL, NULL, &bv, &dn, NULL )) {
731 fprintf( stderr, "invalid suffixDN \"%s\"\n", argv[1] );
734 b2 = select_backend( &dn, 0, 1 );
736 fprintf( stderr, "%s: line %d: unknown suffix \"%s\"\n",
737 fname, lineno, argv[1] );
740 SLAP_DBFLAGS(b2) |= SLAP_DBFLAG_GLUE_SUBORDINATE;
741 gi = (glueinfo *)ch_realloc( gi, sizeof(glueinfo) +
742 gi->gi_nodes * sizeof(gluenode));
743 gi->gi_n[gi->gi_nodes].gn_bx = b2 - backendDB;
744 dnParent( &b2->be_nsuffix[0], &gi->gi_n[gi->gi_nodes].gn_pdn );
745 gi->gi_n[gi->gi_nodes].gn_async = async;
747 on->on_bi.bi_private = gi;
750 return SLAP_CONF_UNKNOWN;
756 glue.on_bi.bi_type = "glue";
758 glue.on_bi.bi_db_init = glue_db_init;
759 glue.on_bi.bi_db_config = glue_db_config;
760 glue.on_bi.bi_db_open = glue_db_open;
761 glue.on_bi.bi_db_close = glue_db_close;
762 glue.on_bi.bi_db_destroy = glue_db_destroy;
764 glue.on_bi.bi_op_search = glue_op_search;
765 glue.on_bi.bi_op_modify = glue_op_func;
766 glue.on_bi.bi_op_modrdn = glue_op_func;
767 glue.on_bi.bi_op_add = glue_op_func;
768 glue.on_bi.bi_op_delete = glue_op_func;
770 return overlay_register( &glue );
773 #if SLAPD_OVER_GLUE == SLAPD_MOD_DYNAMIC
775 init_module( int argc, char *argv[] )
779 #endif /* SLAPD_OVER_GLUE == SLAPD_MOD_DYNAMIC */
781 #endif /* defined(SLAPD_OVER_GLUE */