1 /* backglue.c - backend glue */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2001-2006 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.
33 #include <ac/string.h>
34 #include <ac/socket.h>
39 typedef struct gluenode {
44 typedef struct glueinfo {
50 static slap_overinst glue;
53 static BackendDB *glueBack;
55 static slap_response glue_op_response;
57 /* Just like select_backend, but only for our backends */
64 slap_overinst *on = (slap_overinst *)be->bd_info;
65 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
68 for (i = 0; i<gi->gi_nodes; i++) {
69 assert( gi->gi_n[i].gn_be->be_nsuffix != NULL );
71 if (dnIsSuffix(dn, &gi->gi_n[i].gn_be->be_nsuffix[0])) {
72 return gi->gi_n[i].gn_be;
75 be->bd_info = on->on_info->oi_orig;
80 typedef struct glue_state {
91 glue_op_response ( Operation *op, SlapReply *rs )
93 glue_state *gs = op->o_callback->sc_private;
98 case REP_INTERMEDIATE:
99 return SLAP_CB_CONTINUE;
102 if (rs->sr_err == LDAP_SUCCESS ||
103 rs->sr_err == LDAP_SIZELIMIT_EXCEEDED ||
104 rs->sr_err == LDAP_TIMELIMIT_EXCEEDED ||
105 rs->sr_err == LDAP_ADMINLIMIT_EXCEEDED ||
106 rs->sr_err == LDAP_NO_SUCH_OBJECT ||
107 gs->err != LDAP_SUCCESS)
108 gs->err = rs->sr_err;
109 if (gs->err == LDAP_SUCCESS && gs->matched) {
110 ch_free (gs->matched);
114 if (gs->err != LDAP_SUCCESS && rs->sr_matched) {
116 len = strlen (rs->sr_matched);
117 if (len > gs->matchlen) {
119 ch_free (gs->matched);
120 gs->matched = ch_strdup (rs->sr_matched);
128 for (i=0; rs->sr_ref[i].bv_val; i++);
132 new = ch_malloc ((i+1)*sizeof(struct berval));
134 new = ch_realloc(gs->refs,
135 (j+i+1)*sizeof(struct berval));
137 for (k=0; k<i; j++,k++) {
138 ber_dupbv( &new[j], &rs->sr_ref[k] );
140 new[j].bv_val = NULL;
146 LDAPControl **newctrls;
148 for (i=0; rs->sr_ctrls[i]; i++);
152 newctrls = ch_malloc((i+1)*sizeof(LDAPControl *));
154 newctrls = ch_realloc(gs->ctrls,
155 (j+i+1)*sizeof(LDAPControl *));
157 for (k=0; k<i; j++,k++) {
158 newctrls[j] = ch_malloc(sizeof(LDAPControl));
159 *newctrls[j] = *rs->sr_ctrls[k];
160 if ( !BER_BVISNULL( &rs->sr_ctrls[k]->ldctl_value ))
161 ber_dupbv( &newctrls[j]->ldctl_value,
162 &rs->sr_ctrls[k]->ldctl_value );
166 gs->ctrls = newctrls;
173 glue_op_func ( Operation *op, SlapReply *rs )
175 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
176 BackendDB *b0 = op->o_bd;
177 BackendInfo *bi0 = op->o_bd->bd_info;
179 slap_operation_t which = op_bind;
182 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
184 /* If we're on the master backend, let overlay framework handle it */
185 if ( op->o_bd == b0 )
186 return SLAP_CB_CONTINUE;
188 b0->bd_info = on->on_info->oi_orig;
191 case LDAP_REQ_ADD: which = op_add; break;
192 case LDAP_REQ_DELETE: which = op_delete; break;
193 case LDAP_REQ_MODIFY: which = op_modify; break;
194 case LDAP_REQ_MODRDN: which = op_modrdn; break;
195 default: assert( 0 ); break;
198 func = &op->o_bd->bd_info->bi_op_bind;
200 rc = func[which]( op, rs );
202 rc = SLAP_CB_CONTINUE;
205 op->o_bd->bd_info = bi0;
210 glue_chk_referrals ( Operation *op, SlapReply *rs )
212 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
213 BackendDB *b0 = op->o_bd;
214 BackendInfo *bi0 = op->o_bd->bd_info;
217 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
218 if ( op->o_bd == b0 )
219 return SLAP_CB_CONTINUE;
221 b0->bd_info = on->on_info->oi_orig;
223 if ( op->o_bd->bd_info->bi_chk_referrals )
224 rc = ( *op->o_bd->bd_info->bi_chk_referrals )( op, rs );
226 rc = SLAP_CB_CONTINUE;
229 op->o_bd->bd_info = bi0;
234 glue_chk_controls ( Operation *op, SlapReply *rs )
236 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
237 BackendDB *b0 = op->o_bd;
238 BackendInfo *bi0 = op->o_bd->bd_info;
239 int rc = SLAP_CB_CONTINUE;
241 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
242 if ( op->o_bd == b0 )
243 return SLAP_CB_CONTINUE;
245 b0->bd_info = on->on_info->oi_orig;
247 /* if the subordinate database has overlays, the bi_chk_controls()
248 * hook is actually over_aux_chk_controls(); in case it actually
249 * wraps a missing hok, we need to mimic the behavior
250 * of the frontend applied to that database */
251 if ( op->o_bd->bd_info->bi_chk_controls ) {
252 rc = ( *op->o_bd->bd_info->bi_chk_controls )( op, rs );
256 if ( rc == SLAP_CB_CONTINUE ) {
257 rc = backend_check_controls( op, rs );
261 op->o_bd->bd_info = bi0;
266 glue_sub_search( Operation *op, SlapReply *rs, BackendDB *b0,
269 /* Process any overlays on the master backend */
270 if ( op->o_bd == b0 && on->on_next ) {
271 BackendInfo *bi = op->o_bd->bd_info;
272 int rc = SLAP_CB_CONTINUE;
273 for ( on=on->on_next; on; on=on->on_next ) {
274 op->o_bd->bd_info = (BackendInfo *)on;
275 if ( on->on_bi.bi_op_search ) {
276 rc = on->on_bi.bi_op_search( op, rs );
277 if ( rc != SLAP_CB_CONTINUE )
281 op->o_bd->bd_info = bi;
282 if ( rc != SLAP_CB_CONTINUE )
285 return op->o_bd->be_search( op, rs );
289 glue_op_search ( Operation *op, SlapReply *rs )
291 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
292 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
293 BackendDB *b0 = op->o_bd;
294 BackendDB *b1 = NULL, *btmp;
295 BackendInfo *bi0 = op->o_bd->bd_info;
297 long stoptime = 0, starttime;
298 glue_state gs = {NULL, NULL, NULL, 0, 0, 0, 0};
299 slap_callback cb = { NULL, glue_op_response, NULL, NULL };
301 struct berval dn, ndn, *pdn;
305 cb.sc_next = op->o_callback;
307 starttime = op->o_time;
308 stoptime = slap_get_time () + op->ors_tlimit;
310 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
311 b0->bd_info = on->on_info->oi_orig;
313 switch (op->ors_scope) {
314 case LDAP_SCOPE_BASE:
315 if ( op->o_bd == b0 )
316 return SLAP_CB_CONTINUE;
318 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
319 if (op->o_bd && op->o_bd->be_search) {
320 rs->sr_err = op->o_bd->be_search( op, rs );
324 case LDAP_SCOPE_ONELEVEL:
325 case LDAP_SCOPE_SUBTREE:
326 case LDAP_SCOPE_SUBORDINATE: /* FIXME */
327 op->o_callback = &cb;
328 rs->sr_err = gs.err = LDAP_UNWILLING_TO_PERFORM;
329 scope0 = op->ors_scope;
330 tlimit0 = op->ors_tlimit;
336 * Execute in reverse order, most general first
338 for (i = gi->gi_nodes; i >= 0; i--) {
339 if ( i == gi->gi_nodes ) {
343 btmp = gi->gi_n[i].gn_be;
344 pdn = &gi->gi_n[i].gn_pdn;
346 if (!btmp || !btmp->be_search)
348 if (!dnIsSuffix(&btmp->be_nsuffix[0], &b1->be_nsuffix[0]))
350 if (tlimit0 != SLAP_NO_LIMIT) {
351 op->o_time = slap_get_time();
352 op->ors_tlimit = stoptime - op->o_time;
353 if (op->ors_tlimit <= 0) {
354 rs->sr_err = gs.err = LDAP_TIMELIMIT_EXCEEDED;
367 assert( op->o_bd->be_suffix != NULL );
368 assert( op->o_bd->be_nsuffix != NULL );
370 if (scope0 == LDAP_SCOPE_ONELEVEL &&
373 op->ors_scope = LDAP_SCOPE_BASE;
374 op->o_req_dn = op->o_bd->be_suffix[0];
375 op->o_req_ndn = op->o_bd->be_nsuffix[0];
376 rs->sr_err = op->o_bd->be_search(op, rs);
377 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
378 gs.err = LDAP_SUCCESS;
381 } else if (scope0 == LDAP_SCOPE_SUBTREE &&
382 dn_match(&op->o_bd->be_nsuffix[0], &ndn))
384 rs->sr_err = glue_sub_search( op, rs, b0, on );
386 } else if (scope0 == LDAP_SCOPE_SUBTREE &&
387 dnIsSuffix(&op->o_bd->be_nsuffix[0], &ndn))
389 op->o_req_dn = op->o_bd->be_suffix[0];
390 op->o_req_ndn = op->o_bd->be_nsuffix[0];
391 rs->sr_err = glue_sub_search( op, rs, b0, on );
392 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
393 gs.err = LDAP_SUCCESS;
398 } else if (dnIsSuffix(&ndn, &op->o_bd->be_nsuffix[0])) {
399 rs->sr_err = glue_sub_search( op, rs, b0, on );
405 * Add errors that should result in dropping
408 case LDAP_SIZELIMIT_EXCEEDED:
409 case LDAP_TIMELIMIT_EXCEEDED:
410 case LDAP_ADMINLIMIT_EXCEEDED:
411 case LDAP_NO_SUCH_OBJECT:
412 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
413 case LDAP_X_CANNOT_CHAIN:
414 #endif /* LDAP_CONTROL_X_CHAINING_BEHAVIOR */
422 op->ors_scope = scope0;
423 op->ors_tlimit = tlimit0;
424 op->o_time = starttime;
430 if ( op->o_abandon ) {
431 rs->sr_err = SLAPD_ABANDON;
433 op->o_callback = cb.sc_next;
435 rs->sr_matched = gs.matched;
436 rs->sr_ref = gs.refs;
437 rs->sr_ctrls = gs.ctrls;
439 send_ldap_result( op, rs );
443 op->o_bd->bd_info = bi0;
447 ber_bvarray_free(gs.refs);
449 for (i = gs.nctrls; --i >= 0; ) {
450 if (!BER_BVISNULL( &gs.ctrls[i]->ldctl_value ))
451 free(gs.ctrls[i]->ldctl_value.bv_val);
459 static BackendDB toolDB;
462 glue_tool_entry_open (
467 slap_overinfo *oi = (slap_overinfo *)b0->bd_info;
469 /* We don't know which backend to talk to yet, so just
470 * remember the mode and move on...
476 toolDB.bd_info = oi->oi_orig;
482 glue_tool_entry_close (
489 if (!glueBack->be_entry_close)
491 rc = glueBack->be_entry_close (glueBack);
496 static slap_overinst *
501 slap_overinfo *oi = (slap_overinfo *)bi;
504 for ( on = oi->oi_list; on; on=on->on_next ) {
505 if ( !strcmp( on->on_bi.bi_type, glue.on_bi.bi_type ))
511 /* This function will only be called in tool mode */
517 slap_overinst *on = glue_tool_inst( bi );
518 glueinfo *gi = on->on_bi.bi_private;
519 static int glueOpened = 0;
520 int i, j, same, bsame = 0, rc = 0;
522 if (glueOpened) return 0;
526 /* If we were invoked in tool mode, open all the underlying backends */
527 if (slapMode & SLAP_TOOL_MODE) {
528 for (i = 0; i<gi->gi_nodes; i++) {
530 /* Same bi_open as our main backend? */
531 if ( gi->gi_n[i].gn_be->bd_info->bi_open ==
532 on->on_info->oi_orig->bi_open )
535 /* Loop thru the bd_info's and make sure we only
536 * invoke their bi_open functions once each.
538 for ( j = 0; j<i; j++ ) {
539 if ( gi->gi_n[i].gn_be->bd_info->bi_open ==
540 gi->gi_n[j].gn_be->bd_info->bi_open ) {
545 /* OK, it's unique and non-NULL, call it. */
546 if ( !same && gi->gi_n[i].gn_be->bd_info->bi_open )
547 rc = gi->gi_n[i].gn_be->bd_info->bi_open(
548 gi->gi_n[i].gn_be->bd_info );
549 /* Let backend.c take care of the rest of startup */
551 rc = backend_startup_one( gi->gi_n[i].gn_be );
554 if ( !rc && !bsame && on->on_info->oi_orig->bi_open )
555 rc = on->on_info->oi_orig->bi_open( on->on_info->oi_orig );
557 } /* other case is impossible */
561 /* This function will only be called in tool mode */
567 static int glueClosed = 0;
570 if (glueClosed) return 0;
574 if (slapMode & SLAP_TOOL_MODE) {
575 rc = backend_shutdown( NULL );
581 glue_entry_release_rw (
592 b2.bd_info = (BackendInfo *)glue_tool_inst( op->o_bd->bd_info );
593 op->o_bd = glue_back_select (&b2, &e->e_nname);
595 if ( op->o_bd->be_release ) {
596 rc = op->o_bd->be_release( op, e, rw );
599 /* FIXME: mimic be_entry_release_rw
600 * when no be_release() available */
610 glue_tool_entry_first (
614 slap_overinst *on = glue_tool_inst( b0->bd_info );
615 glueinfo *gi = on->on_bi.bi_private;
618 /* If we're starting from scratch, start at the most general */
620 if ( toolDB.be_entry_open && toolDB.be_entry_first ) {
623 for (i = gi->gi_nodes-1; i >= 0; i--) {
624 if (gi->gi_n[i].gn_be->be_entry_open &&
625 gi->gi_n[i].gn_be->be_entry_first) {
626 glueBack = gi->gi_n[i].gn_be;
632 if (!glueBack || !glueBack->be_entry_open || !glueBack->be_entry_first ||
633 glueBack->be_entry_open (glueBack, glueMode) != 0)
636 return glueBack->be_entry_first (glueBack);
640 glue_tool_entry_next (
644 slap_overinst *on = glue_tool_inst( b0->bd_info );
645 glueinfo *gi = on->on_bi.bi_private;
649 if (!glueBack || !glueBack->be_entry_next)
652 rc = glueBack->be_entry_next (glueBack);
654 /* If we ran out of entries in one database, move on to the next */
656 if ( glueBack && glueBack->be_entry_close )
657 glueBack->be_entry_close (glueBack);
658 for (i=0; i<gi->gi_nodes; i++) {
659 if (gi->gi_n[i].gn_be == glueBack)
666 glueBack = gi->gi_n[i-1].gn_be;
667 rc = glue_tool_entry_first (b0);
674 glue_tool_entry_get (
679 if (!glueBack || !glueBack->be_entry_get)
682 return glueBack->be_entry_get (glueBack, id);
686 glue_tool_entry_put (
696 b2.bd_info = (BackendInfo *)glue_tool_inst( b0->bd_info );
697 be = glue_back_select (&b2, &e->e_nname);
698 if ( be == &b2 ) be = &toolDB;
700 if (!be->be_entry_put)
704 if ( be->be_entry_open ) {
705 rc = be->be_entry_open (be, glueMode);
710 } else if (be != glueBack) {
711 /* If this entry belongs in a different branch than the
712 * previous one, close the current database and open the
715 if ( glueBack->be_entry_close ) {
716 glueBack->be_entry_close (glueBack);
718 if ( be->be_entry_open ) {
719 rc = be->be_entry_open (be, glueMode);
726 return be->be_entry_put (be, e, text);
730 glue_tool_entry_reindex (
735 if (!glueBack || !glueBack->be_entry_reindex)
738 return glueBack->be_entry_reindex (glueBack, id);
746 slap_overinst *on = glue_tool_inst( b0->bd_info );
747 glueinfo *gi = on->on_bi.bi_private;
748 BackendInfo *bi = b0->bd_info;
751 /* just sync everyone */
752 for (i = 0; i<gi->gi_nodes; i++)
753 if (gi->gi_n[i].gn_be->be_sync)
754 gi->gi_n[i].gn_be->be_sync (gi->gi_n[i].gn_be);
755 b0->bd_info = on->on_info->oi_orig;
767 slap_overinst *on = (slap_overinst *)be->bd_info;
768 slap_overinfo *oi = on->on_info;
769 BackendInfo *bi = oi->oi_orig;
772 gi = ch_calloc( 1, sizeof(glueinfo));
773 on->on_bi.bi_private = gi;
774 dnParent( be->be_nsuffix, &gi->gi_pdn );
776 /* Currently the overlay framework doesn't handle these entry points
777 * but we need them....
779 oi->oi_bi.bi_open = glue_open;
780 oi->oi_bi.bi_close = glue_close;
782 oi->oi_bi.bi_entry_release_rw = glue_entry_release_rw;
784 /* Only advertise these if the root DB supports them */
785 if ( bi->bi_tool_entry_open )
786 oi->oi_bi.bi_tool_entry_open = glue_tool_entry_open;
787 if ( bi->bi_tool_entry_close )
788 oi->oi_bi.bi_tool_entry_close = glue_tool_entry_close;
789 if ( bi->bi_tool_entry_first )
790 oi->oi_bi.bi_tool_entry_first = glue_tool_entry_first;
791 if ( bi->bi_tool_entry_next )
792 oi->oi_bi.bi_tool_entry_next = glue_tool_entry_next;
793 if ( bi->bi_tool_entry_get )
794 oi->oi_bi.bi_tool_entry_get = glue_tool_entry_get;
795 if ( bi->bi_tool_entry_put )
796 oi->oi_bi.bi_tool_entry_put = glue_tool_entry_put;
797 if ( bi->bi_tool_entry_reindex )
798 oi->oi_bi.bi_tool_entry_reindex = glue_tool_entry_reindex;
799 if ( bi->bi_tool_sync )
800 oi->oi_bi.bi_tool_sync = glue_tool_sync;
802 /*FIXME : need to add support */
803 oi->oi_bi.bi_tool_dn2id_get = 0;
804 oi->oi_bi.bi_tool_id2entry_get = 0;
805 oi->oi_bi.bi_tool_entry_modify = 0;
807 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_INSTANCE;
817 slap_overinst *on = (slap_overinst *)be->bd_info;
818 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
821 return SLAP_CB_CONTINUE;
829 slap_overinst *on = (slap_overinst *)be->bd_info;
831 on->on_info->oi_bi.bi_db_close = 0;
836 glue_sub_del( BackendDB *b0 )
841 /* Find the top backend for this subordinate */
843 while ( (be=LDAP_STAILQ_NEXT( be, be_next )) != NULL ) {
849 if ( SLAP_GLUE_SUBORDINATE( be ))
851 if ( !SLAP_GLUE_INSTANCE( be ))
853 if ( !dnIsSuffix( &b0->be_nsuffix[0], &be->be_nsuffix[0] ))
856 /* OK, got the right backend, find the overlay */
857 oi = (slap_overinfo *)be->bd_info;
858 for ( on=oi->oi_list; on; on=on->on_next ) {
859 if ( on->on_bi.bi_type == glue.on_bi.bi_type )
862 assert( on != NULL );
863 gi = on->on_bi.bi_private;
864 for ( i=0; i < gi->gi_nodes; i++ ) {
865 if ( gi->gi_n[i].gn_be == b0 ) {
868 for (j=i+1; j < gi->gi_nodes; j++)
869 gi->gi_n[j-1] = gi->gi_n[j];
876 rc = LDAP_NO_SUCH_OBJECT;
881 typedef struct glue_Addrec {
882 struct glue_Addrec *ga_next;
886 /* List of added subordinates */
887 static glue_Addrec *ga_list;
889 /* Attach all the subordinate backends to their superior */
893 glue_Addrec *ga, *gnext = NULL;
896 /* For all the subordinate backends */
897 for ( ga=ga_list; ga != NULL; ga = gnext ) {
902 /* Find the top backend for this subordinate */
904 while ( (be=LDAP_STAILQ_NEXT( be, be_next )) != NULL ) {
909 if ( SLAP_GLUE_SUBORDINATE( be ))
911 if ( !dnIsSuffix( &ga->ga_be->be_nsuffix[0], &be->be_nsuffix[0] ))
914 /* If it's not already configured, set up the overlay */
915 if ( !SLAP_GLUE_INSTANCE( be )) {
916 rc = overlay_config( be, glue.on_bi.bi_type );
920 /* Find the overlay instance */
921 oi = (slap_overinfo *)be->bd_info;
922 for ( on=oi->oi_list; on; on=on->on_next ) {
923 if ( on->on_bi.bi_type == glue.on_bi.bi_type )
926 assert( on != NULL );
927 gi = on->on_bi.bi_private;
928 gi = (glueinfo *)ch_realloc( gi, sizeof(glueinfo) +
929 gi->gi_nodes * sizeof(gluenode));
930 gi->gi_n[gi->gi_nodes].gn_be = ga->ga_be;
931 dnParent( &ga->ga_be->be_nsuffix[0],
932 &gi->gi_n[gi->gi_nodes].gn_pdn );
934 on->on_bi.bi_private = gi;
938 Debug( LDAP_DEBUG_ANY, "glue: no superior found for sub %s!\n",
939 ga->ga_be->be_suffix[0].bv_val, 0, 0 );
940 rc = LDAP_NO_SUCH_OBJECT;
952 glue_sub_add( BackendDB *be, int advert, int online )
957 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_SUBORDINATE;
959 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_ADVERTISE;
961 ga = ch_malloc( sizeof( glue_Addrec ));
962 ga->ga_next = ga_list;
967 rc = glue_sub_attach();
975 glue.on_bi.bi_type = "glue";
977 glue.on_bi.bi_db_init = glue_db_init;
978 glue.on_bi.bi_db_close = glue_db_close;
979 glue.on_bi.bi_db_destroy = glue_db_destroy;
981 glue.on_bi.bi_op_search = glue_op_search;
982 glue.on_bi.bi_op_modify = glue_op_func;
983 glue.on_bi.bi_op_modrdn = glue_op_func;
984 glue.on_bi.bi_op_add = glue_op_func;
985 glue.on_bi.bi_op_delete = glue_op_func;
987 glue.on_bi.bi_chk_referrals = glue_chk_referrals;
988 glue.on_bi.bi_chk_controls = glue_chk_controls;
990 return overlay_register( &glue );