1 /* backglue.c - backend glue */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2001-2011 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>
41 typedef struct gluenode {
46 typedef struct glueinfo {
52 static slap_overinst glue;
55 static BackendDB *glueBack;
56 static BackendDB glueBackDone;
57 #define GLUEBACK_DONE (&glueBackDone)
59 static slap_overinst * glue_tool_inst( BackendInfo *bi);
61 static slap_response glue_op_response;
63 /* Just like select_backend, but only for our backends */
70 slap_overinst *on = (slap_overinst *)be->bd_info;
71 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
74 for (i = gi->gi_nodes-1; i >= 0; i--) {
75 assert( gi->gi_n[i].gn_be->be_nsuffix != NULL );
77 if (dnIsSuffix(dn, &gi->gi_n[i].gn_be->be_nsuffix[0])) {
78 return gi->gi_n[i].gn_be;
81 be->bd_info = on->on_info->oi_orig;
86 typedef struct glue_state {
97 glue_op_cleanup( Operation *op, SlapReply *rs )
99 /* This is not a final result */
100 if (rs->sr_type == REP_RESULT )
101 rs->sr_type = REP_GLUE_RESULT;
102 return SLAP_CB_CONTINUE;
106 glue_op_response ( Operation *op, SlapReply *rs )
108 glue_state *gs = op->o_callback->sc_private;
110 switch(rs->sr_type) {
113 case REP_INTERMEDIATE:
114 return SLAP_CB_CONTINUE;
117 if (rs->sr_err == LDAP_SUCCESS ||
118 rs->sr_err == LDAP_SIZELIMIT_EXCEEDED ||
119 rs->sr_err == LDAP_TIMELIMIT_EXCEEDED ||
120 rs->sr_err == LDAP_ADMINLIMIT_EXCEEDED ||
121 rs->sr_err == LDAP_NO_SUCH_OBJECT ||
122 gs->err != LDAP_SUCCESS)
123 gs->err = rs->sr_err;
124 if (gs->err == LDAP_SUCCESS && gs->matched) {
125 ch_free (gs->matched);
129 if (gs->err != LDAP_SUCCESS && rs->sr_matched) {
131 len = strlen (rs->sr_matched);
132 if (len > gs->matchlen) {
134 ch_free (gs->matched);
135 gs->matched = ch_strdup (rs->sr_matched);
143 for (i=0; rs->sr_ref[i].bv_val; i++);
147 new = ch_malloc ((i+1)*sizeof(struct berval));
149 new = ch_realloc(gs->refs,
150 (j+i+1)*sizeof(struct berval));
152 for (k=0; k<i; j++,k++) {
153 ber_dupbv( &new[j], &rs->sr_ref[k] );
155 new[j].bv_val = NULL;
161 LDAPControl **newctrls;
163 for (i=0; rs->sr_ctrls[i]; i++);
167 newctrls = op->o_tmpalloc((i+1)*sizeof(LDAPControl *),
170 /* Forget old pagedResults response if we're sending
173 if ( get_pagedresults( op ) > SLAP_CONTROL_IGNORED ) {
175 for ( k=0; k<i; k++ ) {
176 if ( !strcmp(rs->sr_ctrls[k]->ldctl_oid,
177 LDAP_CONTROL_PAGEDRESULTS )) {
183 for ( k=0; k<j; k++ ) {
184 if ( !strcmp(gs->ctrls[k]->ldctl_oid,
185 LDAP_CONTROL_PAGEDRESULTS ))
187 op->o_tmpfree(gs->ctrls[k], op->o_tmpmemctx);
188 gs->ctrls[k] = gs->ctrls[--j];
195 newctrls = op->o_tmprealloc(gs->ctrls,
196 (j+i+1)*sizeof(LDAPControl *), op->o_tmpmemctx);
198 for (k=0; k<i; j++,k++) {
199 ber_len_t oidlen = strlen( rs->sr_ctrls[k]->ldctl_oid );
200 newctrls[j] = op->o_tmpalloc(sizeof(LDAPControl) + oidlen + 1 + rs->sr_ctrls[k]->ldctl_value.bv_len + 1,
202 newctrls[j]->ldctl_iscritical = rs->sr_ctrls[k]->ldctl_iscritical;
203 newctrls[j]->ldctl_oid = (char *)&newctrls[j][1];
204 lutil_strcopy( newctrls[j]->ldctl_oid, rs->sr_ctrls[k]->ldctl_oid );
205 if ( !BER_BVISNULL( &rs->sr_ctrls[k]->ldctl_value ) ) {
206 newctrls[j]->ldctl_value.bv_val = &newctrls[j]->ldctl_oid[oidlen + 1];
207 newctrls[j]->ldctl_value.bv_len = rs->sr_ctrls[k]->ldctl_value.bv_len;
208 lutil_memcopy( newctrls[j]->ldctl_value.bv_val,
209 rs->sr_ctrls[k]->ldctl_value.bv_val,
210 rs->sr_ctrls[k]->ldctl_value.bv_len + 1 );
212 BER_BVZERO( &newctrls[j]->ldctl_value );
217 gs->ctrls = newctrls;
224 glue_op_func ( Operation *op, SlapReply *rs )
226 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
227 BackendDB *b0 = op->o_bd;
228 BackendInfo *bi0 = op->o_bd->bd_info;
230 slap_operation_t which = op_bind;
233 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
235 /* If we're on the master backend, let overlay framework handle it */
236 if ( op->o_bd == b0 )
237 return SLAP_CB_CONTINUE;
239 b0->bd_info = on->on_info->oi_orig;
242 case LDAP_REQ_ADD: which = op_add; break;
243 case LDAP_REQ_DELETE: which = op_delete; break;
244 case LDAP_REQ_MODIFY: which = op_modify; break;
245 case LDAP_REQ_MODRDN: which = op_modrdn; break;
246 case LDAP_REQ_EXTENDED: which = op_extended; break;
247 default: assert( 0 ); break;
250 func = &op->o_bd->bd_info->bi_op_bind;
252 rc = func[which]( op, rs );
257 op->o_bd->bd_info = bi0;
262 glue_response ( Operation *op, SlapReply *rs )
264 BackendDB *be = op->o_bd;
265 be = glue_back_select (op->o_bd, &op->o_req_ndn);
267 /* If we're on the master backend, let overlay framework handle it.
268 * Otherwise, bail out.
270 return ( op->o_bd == be ) ? SLAP_CB_CONTINUE : SLAP_CB_BYPASS;
274 glue_chk_referrals ( Operation *op, SlapReply *rs )
276 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
277 BackendDB *b0 = op->o_bd;
278 BackendInfo *bi0 = op->o_bd->bd_info;
281 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
282 if ( op->o_bd == b0 )
283 return SLAP_CB_CONTINUE;
285 b0->bd_info = on->on_info->oi_orig;
287 if ( op->o_bd->bd_info->bi_chk_referrals )
288 rc = ( *op->o_bd->bd_info->bi_chk_referrals )( op, rs );
290 rc = SLAP_CB_CONTINUE;
293 op->o_bd->bd_info = bi0;
298 glue_chk_controls ( Operation *op, SlapReply *rs )
300 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
301 BackendDB *b0 = op->o_bd;
302 BackendInfo *bi0 = op->o_bd->bd_info;
303 int rc = SLAP_CB_CONTINUE;
305 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
306 if ( op->o_bd == b0 )
307 return SLAP_CB_CONTINUE;
309 b0->bd_info = on->on_info->oi_orig;
311 /* if the subordinate database has overlays, the bi_chk_controls()
312 * hook is actually over_aux_chk_controls(); in case it actually
313 * wraps a missing hok, we need to mimic the behavior
314 * of the frontend applied to that database */
315 if ( op->o_bd->bd_info->bi_chk_controls ) {
316 rc = ( *op->o_bd->bd_info->bi_chk_controls )( op, rs );
320 if ( rc == SLAP_CB_CONTINUE ) {
321 rc = backend_check_controls( op, rs );
325 op->o_bd->bd_info = bi0;
329 /* ITS#4615 - overlays configured above the glue overlay should be
330 * invoked for the entire glued tree. Overlays configured below the
331 * glue overlay should only be invoked on the master backend.
332 * So, if we're searching on any subordinates, we need to force the
333 * current overlay chain to stop processing, without stopping the
334 * overall callback flow.
337 glue_sub_search( Operation *op, SlapReply *rs, BackendDB *b0,
340 /* Process any overlays on the master backend */
341 if ( op->o_bd == b0 && on->on_next ) {
342 BackendInfo *bi = op->o_bd->bd_info;
343 int rc = SLAP_CB_CONTINUE;
344 for ( on=on->on_next; on; on=on->on_next ) {
345 op->o_bd->bd_info = (BackendInfo *)on;
346 if ( on->on_bi.bi_op_search ) {
347 rc = on->on_bi.bi_op_search( op, rs );
348 if ( rc != SLAP_CB_CONTINUE )
352 op->o_bd->bd_info = bi;
353 if ( rc != SLAP_CB_CONTINUE )
356 return op->o_bd->be_search( op, rs );
359 static const ID glueID = NOID;
360 static const struct berval gluecookie = { sizeof( glueID ), (char *)&glueID };
363 glue_op_search ( Operation *op, SlapReply *rs )
365 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
366 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
367 BackendDB *b0 = op->o_bd;
368 BackendDB *b1 = NULL, *btmp;
369 BackendInfo *bi0 = op->o_bd->bd_info;
371 long stoptime = 0, starttime;
372 glue_state gs = {NULL, NULL, NULL, 0, 0, 0, 0};
373 slap_callback cb = { NULL, glue_op_response, glue_op_cleanup, NULL };
375 struct berval dn, ndn, *pdn;
379 cb.sc_next = op->o_callback;
381 starttime = op->o_time;
382 stoptime = slap_get_time () + op->ors_tlimit;
384 /* reset dummy cookie used to keep paged results going across databases */
385 if ( get_pagedresults( op ) > SLAP_CONTROL_IGNORED
386 && bvmatch( &((PagedResultsState *)op->o_pagedresults_state)->ps_cookieval, &gluecookie ) )
388 PagedResultsState *ps = op->o_pagedresults_state;
389 BerElementBuffer berbuf;
390 BerElement *ber = (BerElement *)&berbuf;
391 struct berval cookie = BER_BVC(""), value;
394 for (c = 0; op->o_ctrls[c] != NULL; c++) {
395 if (strcmp(op->o_ctrls[c]->ldctl_oid, LDAP_CONTROL_PAGEDRESULTS) == 0)
399 assert( op->o_ctrls[c] != NULL );
401 ber_init2( ber, NULL, LBER_USE_DER );
402 ber_printf( ber, "{iO}", ps->ps_size, &cookie );
403 ber_flatten2( ber, &value, 0 );
404 assert( op->o_ctrls[c]->ldctl_value.bv_len >= value.bv_len );
405 op->o_ctrls[c]->ldctl_value.bv_len = value.bv_len;
406 lutil_memcopy( op->o_ctrls[c]->ldctl_value.bv_val,
407 value.bv_val, value.bv_len );
410 ps->ps_cookie = (PagedResultsCookie)0;
411 BER_BVZERO( &ps->ps_cookieval );
414 op->o_bd = glue_back_select (b0, &op->o_req_ndn);
415 b0->bd_info = on->on_info->oi_orig;
417 switch (op->ors_scope) {
418 case LDAP_SCOPE_BASE:
419 if ( op->o_bd == b0 )
420 return SLAP_CB_CONTINUE;
422 if (op->o_bd && op->o_bd->be_search) {
423 rs->sr_err = op->o_bd->be_search( op, rs );
425 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
429 case LDAP_SCOPE_ONELEVEL:
430 case LDAP_SCOPE_SUBTREE:
431 case LDAP_SCOPE_SUBORDINATE: /* FIXME */
432 op->o_callback = &cb;
433 rs->sr_err = gs.err = LDAP_UNWILLING_TO_PERFORM;
434 scope0 = op->ors_scope;
435 tlimit0 = op->ors_tlimit;
441 * Execute in reverse order, most specific first
443 for (i = gi->gi_nodes; i >= 0; i--) {
444 if ( i == gi->gi_nodes ) {
448 btmp = gi->gi_n[i].gn_be;
449 pdn = &gi->gi_n[i].gn_pdn;
451 if (!btmp || !btmp->be_search)
453 if (!dnIsSuffix(&btmp->be_nsuffix[0], &b1->be_nsuffix[0]))
455 if (get_no_subordinate_glue(op) && btmp != b1)
457 /* If we remembered which backend we were on before,
458 * skip down to it now
460 if ( get_pagedresults( op ) > SLAP_CONTROL_IGNORED &&
461 op->o_conn->c_pagedresults_state.ps_be &&
462 op->o_conn->c_pagedresults_state.ps_be != btmp )
465 if (tlimit0 != SLAP_NO_LIMIT) {
466 op->o_time = slap_get_time();
467 op->ors_tlimit = stoptime - op->o_time;
468 if (op->ors_tlimit <= 0) {
469 rs->sr_err = gs.err = LDAP_TIMELIMIT_EXCEEDED;
482 assert( op->o_bd->be_suffix != NULL );
483 assert( op->o_bd->be_nsuffix != NULL );
485 if (scope0 == LDAP_SCOPE_ONELEVEL &&
488 struct berval mdn, mndn;
489 op->ors_scope = LDAP_SCOPE_BASE;
490 mdn = op->o_req_dn = op->o_bd->be_suffix[0];
491 mndn = op->o_req_ndn = op->o_bd->be_nsuffix[0];
492 rs->sr_err = op->o_bd->be_search(op, rs);
493 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
494 gs.err = LDAP_SUCCESS;
496 op->ors_scope = LDAP_SCOPE_ONELEVEL;
497 if ( op->o_req_dn.bv_val == mdn.bv_val )
499 if ( op->o_req_ndn.bv_val == mndn.bv_val )
502 } else if (scope0 == LDAP_SCOPE_SUBTREE &&
503 dn_match(&op->o_bd->be_nsuffix[0], &ndn))
505 rs->sr_err = glue_sub_search( op, rs, b0, on );
507 } else if (scope0 == LDAP_SCOPE_SUBTREE &&
508 dnIsSuffix(&op->o_bd->be_nsuffix[0], &ndn))
510 struct berval mdn, mndn;
511 mdn = op->o_req_dn = op->o_bd->be_suffix[0];
512 mndn = op->o_req_ndn = op->o_bd->be_nsuffix[0];
513 rs->sr_err = glue_sub_search( op, rs, b0, on );
514 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
515 gs.err = LDAP_SUCCESS;
517 if ( op->o_req_dn.bv_val == mdn.bv_val )
519 if ( op->o_req_ndn.bv_val == mndn.bv_val )
522 } else if (dnIsSuffix(&ndn, &op->o_bd->be_nsuffix[0])) {
523 rs->sr_err = glue_sub_search( op, rs, b0, on );
529 * Add errors that should result in dropping
532 case LDAP_SIZELIMIT_EXCEEDED:
533 case LDAP_TIMELIMIT_EXCEEDED:
534 case LDAP_ADMINLIMIT_EXCEEDED:
535 case LDAP_NO_SUCH_OBJECT:
536 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
537 case LDAP_X_CANNOT_CHAIN:
538 #endif /* LDAP_CONTROL_X_CHAINING_BEHAVIOR */
542 if ( get_pagedresults( op ) > SLAP_CONTROL_IGNORED ) {
543 PagedResultsState *ps = op->o_pagedresults_state;
545 /* Assume this backend can be forgotten now */
546 op->o_conn->c_pagedresults_state.ps_be = NULL;
548 /* If we have a full page, exit the loop. We may
549 * need to remember this backend so we can continue
550 * from here on a subsequent request.
552 if ( rs->sr_nentries >= ps->ps_size ) {
553 PagedResultsState *cps = &op->o_conn->c_pagedresults_state;
555 /* Don't bother to remember the first backend.
556 * Only remember the last one if there's more state left.
558 if ( op->o_bd != b0 &&
559 ( cps->ps_cookie != NOID
560 || !BER_BVISNULL( &cps->ps_cookieval )
561 || op->o_bd != gi->gi_n[0].gn_be ) )
563 op->o_conn->c_pagedresults_state.ps_be = op->o_bd;
566 /* Check whether the cookie is empty,
567 * and give remaining databases a chance
569 if ( op->o_bd != gi->gi_n[0].gn_be || cps->ps_cookie == NOID ) {
572 for ( c = 0; gs.ctrls[c] != NULL; c++ ) {
573 if ( strcmp( gs.ctrls[c]->ldctl_oid, LDAP_CONTROL_PAGEDRESULTS ) == 0 ) {
578 if ( gs.ctrls[c] != NULL ) {
579 BerElementBuffer berbuf;
580 BerElement *ber = (BerElement *)&berbuf;
583 struct berval cookie, value;
585 ber_init2( ber, &gs.ctrls[c]->ldctl_value, LBER_USE_DER );
587 tag = ber_scanf( ber, "{im}", &size, &cookie );
588 assert( tag != LBER_ERROR );
590 if ( BER_BVISEMPTY( &cookie ) && op->o_bd != gi->gi_n[0].gn_be ) {
591 /* delete old, create new cookie with NOID */
592 PagedResultsCookie respcookie = (PagedResultsCookie)NOID;
593 ber_len_t oidlen = strlen( gs.ctrls[c]->ldctl_oid );
594 LDAPControl *newctrl;
596 /* it's next database's turn */
598 op->o_conn->c_pagedresults_state.ps_be = gi->gi_n[gi->gi_nodes - 1].gn_be;
601 op->o_conn->c_pagedresults_state.ps_be = gi->gi_n[(i > 0 ? i - 1: 0)].gn_be;
604 cookie.bv_val = (char *)&respcookie;
605 cookie.bv_len = sizeof( PagedResultsCookie );
607 ber_init2( ber, NULL, LBER_USE_DER );
608 ber_printf( ber, "{iO}", 0, &cookie );
609 ber_flatten2( ber, &value, 0 );
611 newctrl = op->o_tmprealloc( gs.ctrls[c],
612 sizeof(LDAPControl) + oidlen + 1 + value.bv_len + 1,
614 newctrl->ldctl_iscritical = gs.ctrls[c]->ldctl_iscritical;
615 newctrl->ldctl_oid = (char *)&newctrl[1];
616 lutil_strcopy( newctrl->ldctl_oid, gs.ctrls[c]->ldctl_oid );
617 newctrl->ldctl_value.bv_len = value.bv_len;
618 lutil_memcopy( newctrl->ldctl_value.bv_val,
619 value.bv_val, value.bv_len );
621 gs.ctrls[c] = newctrl;
625 } else if ( !BER_BVISEMPTY( &cookie ) && op->o_bd != b0 ) {
626 /* if cookie not empty, it's again this database's turn */
627 op->o_conn->c_pagedresults_state.ps_be = op->o_bd;
635 /* This backend has run out of entries, but more responses
636 * can fit in the page. Fake a reset of the state so the
637 * next backend will start up properly. Only back-[bh]db
638 * and back-sql look at this state info.
640 ps->ps_cookie = (PagedResultsCookie)0;
641 BER_BVZERO( &ps->ps_cookieval );
644 /* change the size of the page in the request
645 * that will be propagated, and reset the cookie */
646 BerElementBuffer berbuf;
647 BerElement *ber = (BerElement *)&berbuf;
648 int size = ps->ps_size - rs->sr_nentries;
649 struct berval cookie = BER_BVC(""), value;
652 for (c = 0; op->o_ctrls[c] != NULL; c++) {
653 if (strcmp(op->o_ctrls[c]->ldctl_oid, LDAP_CONTROL_PAGEDRESULTS) == 0)
657 assert( op->o_ctrls[c] != NULL );
659 ber_init2( ber, NULL, LBER_USE_DER );
660 ber_printf( ber, "{iO}", size, &cookie );
661 ber_flatten2( ber, &value, 0 );
662 assert( op->o_ctrls[c]->ldctl_value.bv_len >= value.bv_len );
663 op->o_ctrls[c]->ldctl_value.bv_len = value.bv_len;
664 lutil_memcopy( op->o_ctrls[c]->ldctl_value.bv_val,
665 value.bv_val, value.bv_len );
675 op->ors_scope = scope0;
676 op->ors_tlimit = tlimit0;
677 op->o_time = starttime;
682 op->o_callback = cb.sc_next;
683 if ( op->o_abandon ) {
684 rs->sr_err = SLAPD_ABANDON;
687 rs->sr_matched = gs.matched;
688 rs->sr_ref = gs.refs;
690 rs->sr_ctrls = gs.ctrls;
692 send_ldap_result( op, rs );
695 op->o_bd->bd_info = bi0;
699 ber_bvarray_free(gs.refs);
701 for (i = gs.nctrls; --i >= 0; ) {
702 op->o_tmpfree(gs.ctrls[i], op->o_tmpmemctx);
704 op->o_tmpfree(gs.ctrls, op->o_tmpmemctx);
709 static BackendDB toolDB;
712 glue_tool_entry_open (
717 slap_overinfo *oi = (slap_overinfo *)b0->bd_info;
719 /* We don't know which backend to talk to yet, so just
720 * remember the mode and move on...
726 toolDB.bd_info = oi->oi_orig;
730 slap_overinst *on = glue_tool_inst( b0->bd_info );
731 glueinfo *gi = on->on_bi.bi_private;
734 for (i = 0; i < gi->gi_nodes; i++) {
738 dnParent( &gi->gi_n[i].gn_be->be_nsuffix[0], &pdn );
739 bd = select_backend( &pdn, 0 );
744 if ( overlay_is_over( bd ) ) {
745 slap_overinfo *oi = (slap_overinfo *)bd->bd_info;
747 db.bd_info = oi->oi_orig;
751 if ( !bd->bd_info->bi_tool_dn2id_get
752 || !bd->bd_info->bi_tool_entry_open
753 || !bd->bd_info->bi_tool_entry_close )
758 bd->bd_info->bi_tool_entry_open( bd, 0 );
759 id = bd->bd_info->bi_tool_dn2id_get( bd, &gi->gi_n[i].gn_be->be_nsuffix[0] );
760 bd->bd_info->bi_tool_entry_close( bd );
762 Debug( LDAP_DEBUG_ANY,
763 "glue_tool_entry_open: subordinate database suffix entry DN=\"%s\" also present in superior database rooted at DN=\"%s\"\n",
764 gi->gi_n[i].gn_be->be_suffix[0].bv_val, bd->be_suffix[0].bv_val, 0 );
775 glue_tool_entry_close (
781 if (glueBack && glueBack != GLUEBACK_DONE) {
782 if (!glueBack->be_entry_close)
784 rc = glueBack->be_entry_close (glueBack);
789 static slap_overinst *
794 slap_overinfo *oi = (slap_overinfo *)bi;
797 for ( on = oi->oi_list; on; on=on->on_next ) {
798 if ( !strcmp( on->on_bi.bi_type, glue.on_bi.bi_type ))
804 /* This function will only be called in tool mode */
810 slap_overinst *on = glue_tool_inst( bi );
811 glueinfo *gi = on->on_bi.bi_private;
812 static int glueOpened = 0;
813 int i, j, same, bsame = 0, rc = 0;
814 ConfigReply cr = {0};
816 if (glueOpened) return 0;
820 /* If we were invoked in tool mode, open all the underlying backends */
821 if (slapMode & SLAP_TOOL_MODE) {
822 for (i = 0; i<gi->gi_nodes; i++) {
824 /* Same bi_open as our main backend? */
825 if ( gi->gi_n[i].gn_be->bd_info->bi_open ==
826 on->on_info->oi_orig->bi_open )
829 /* Loop thru the bd_info's and make sure we only
830 * invoke their bi_open functions once each.
832 for ( j = 0; j<i; j++ ) {
833 if ( gi->gi_n[i].gn_be->bd_info->bi_open ==
834 gi->gi_n[j].gn_be->bd_info->bi_open ) {
839 /* OK, it's unique and non-NULL, call it. */
840 if ( !same && gi->gi_n[i].gn_be->bd_info->bi_open )
841 rc = gi->gi_n[i].gn_be->bd_info->bi_open(
842 gi->gi_n[i].gn_be->bd_info );
843 /* Let backend.c take care of the rest of startup */
845 rc = backend_startup_one( gi->gi_n[i].gn_be, &cr );
848 if ( !rc && !bsame && on->on_info->oi_orig->bi_open )
849 rc = on->on_info->oi_orig->bi_open( on->on_info->oi_orig );
851 } /* other case is impossible */
855 /* This function will only be called in tool mode */
861 static int glueClosed = 0;
864 if (glueClosed) return 0;
868 if (slapMode & SLAP_TOOL_MODE) {
869 rc = backend_shutdown( NULL );
879 AttributeDescription *ad,
884 BackendDB *b0 = op->o_bd;
885 op->o_bd = glue_back_select( b0, dn );
887 if ( op->o_bd->be_fetch ) {
888 rc = op->o_bd->be_fetch( op, dn, oc, ad, rw, e );
890 rc = LDAP_UNWILLING_TO_PERFORM;
897 glue_entry_release_rw (
903 BackendDB *b0 = op->o_bd;
906 op->o_bd = glue_back_select (b0, &e->e_nname);
908 if ( op->o_bd->be_release ) {
909 rc = op->o_bd->be_release( op, e, rw );
912 /* FIXME: mimic be_entry_release_rw
913 * when no be_release() available */
922 static struct berval *glue_base;
923 static int glue_scope;
924 static Filter *glue_filter;
927 glue_tool_entry_first (
931 slap_overinst *on = glue_tool_inst( b0->bd_info );
932 glueinfo *gi = on->on_bi.bi_private;
936 /* If we're starting from scratch, start at the most general */
938 if ( toolDB.be_entry_open && toolDB.be_entry_first ) {
941 for (i = gi->gi_nodes-1; i >= 0; i--) {
942 if (gi->gi_n[i].gn_be->be_entry_open &&
943 gi->gi_n[i].gn_be->be_entry_first) {
944 glueBack = gi->gi_n[i].gn_be;
950 if (!glueBack || !glueBack->be_entry_open || !glueBack->be_entry_first ||
951 glueBack->be_entry_open (glueBack, glueMode) != 0)
954 rc = glueBack->be_entry_first (glueBack);
955 while ( rc == NOID ) {
956 if ( glueBack && glueBack->be_entry_close )
957 glueBack->be_entry_close (glueBack);
958 for (i=0; i<gi->gi_nodes; i++) {
959 if (gi->gi_n[i].gn_be == glueBack)
963 glueBack = GLUEBACK_DONE;
966 glueBack = gi->gi_n[i-1].gn_be;
967 rc = glue_tool_entry_first (b0);
968 if ( glueBack == GLUEBACK_DONE ) {
977 glue_tool_entry_first_x (
984 slap_overinst *on = glue_tool_inst( b0->bd_info );
985 glueinfo *gi = on->on_bi.bi_private;
993 /* If we're starting from scratch, start at the most general */
995 if ( toolDB.be_entry_open && toolDB.be_entry_first_x ) {
998 for (i = gi->gi_nodes-1; i >= 0; i--) {
999 if (gi->gi_n[i].gn_be->be_entry_open &&
1000 gi->gi_n[i].gn_be->be_entry_first_x)
1002 glueBack = gi->gi_n[i].gn_be;
1008 if (!glueBack || !glueBack->be_entry_open || !glueBack->be_entry_first_x ||
1009 glueBack->be_entry_open (glueBack, glueMode) != 0)
1012 rc = glueBack->be_entry_first_x (glueBack,
1013 glue_base, glue_scope, glue_filter);
1014 while ( rc == NOID ) {
1015 if ( glueBack && glueBack->be_entry_close )
1016 glueBack->be_entry_close (glueBack);
1017 for (i=0; i<gi->gi_nodes; i++) {
1018 if (gi->gi_n[i].gn_be == glueBack)
1022 glueBack = GLUEBACK_DONE;
1025 glueBack = gi->gi_n[i-1].gn_be;
1026 rc = glue_tool_entry_first_x (b0,
1027 glue_base, glue_scope, glue_filter);
1028 if ( glueBack == GLUEBACK_DONE ) {
1037 glue_tool_entry_next (
1041 slap_overinst *on = glue_tool_inst( b0->bd_info );
1042 glueinfo *gi = on->on_bi.bi_private;
1046 if (!glueBack || !glueBack->be_entry_next)
1049 rc = glueBack->be_entry_next (glueBack);
1051 /* If we ran out of entries in one database, move on to the next */
1052 while (rc == NOID) {
1053 if ( glueBack && glueBack->be_entry_close )
1054 glueBack->be_entry_close (glueBack);
1055 for (i=0; i<gi->gi_nodes; i++) {
1056 if (gi->gi_n[i].gn_be == glueBack)
1060 glueBack = GLUEBACK_DONE;
1063 glueBack = gi->gi_n[i-1].gn_be;
1064 if ( glue_base || glue_filter ) {
1065 /* using entry_first_x() */
1066 rc = glue_tool_entry_first_x (b0,
1067 glue_base, glue_scope, glue_filter);
1070 /* using entry_first() */
1071 rc = glue_tool_entry_first (b0);
1073 if ( glueBack == GLUEBACK_DONE ) {
1082 glue_tool_dn2id_get (
1091 b2.bd_info = (BackendInfo *)glue_tool_inst( b0->bd_info );
1092 be = glue_back_select (&b2, dn);
1093 if ( be == &b2 ) be = &toolDB;
1095 if (!be->be_dn2id_get)
1099 if ( be->be_entry_open ) {
1100 rc = be->be_entry_open (be, glueMode);
1105 } else if (be != glueBack) {
1106 /* If this entry belongs in a different branch than the
1107 * previous one, close the current database and open the
1110 if ( glueBack->be_entry_close ) {
1111 glueBack->be_entry_close (glueBack);
1113 if ( be->be_entry_open ) {
1114 rc = be->be_entry_open (be, glueMode);
1121 return be->be_dn2id_get (be, dn);
1125 glue_tool_entry_get (
1130 if (!glueBack || !glueBack->be_entry_get)
1133 return glueBack->be_entry_get (glueBack, id);
1137 glue_tool_entry_put (
1147 b2.bd_info = (BackendInfo *)glue_tool_inst( b0->bd_info );
1148 be = glue_back_select (&b2, &e->e_nname);
1149 if ( be == &b2 ) be = &toolDB;
1151 if (!be->be_entry_put)
1155 if ( be->be_entry_open ) {
1156 rc = be->be_entry_open (be, glueMode);
1161 } else if (be != glueBack) {
1162 /* If this entry belongs in a different branch than the
1163 * previous one, close the current database and open the
1166 if ( glueBack->be_entry_close ) {
1167 glueBack->be_entry_close (glueBack);
1169 if ( be->be_entry_open ) {
1170 rc = be->be_entry_open (be, glueMode);
1177 return be->be_entry_put (be, e, text);
1181 glue_tool_entry_modify (
1187 if (!glueBack || !glueBack->be_entry_modify)
1190 return glueBack->be_entry_modify (glueBack, e, text);
1194 glue_tool_entry_reindex (
1197 AttributeDescription **adv
1200 if (!glueBack || !glueBack->be_entry_reindex)
1203 return glueBack->be_entry_reindex (glueBack, id, adv);
1211 slap_overinst *on = glue_tool_inst( b0->bd_info );
1212 glueinfo *gi = on->on_bi.bi_private;
1213 BackendInfo *bi = b0->bd_info;
1216 /* just sync everyone */
1217 for (i = 0; i<gi->gi_nodes; i++)
1218 if (gi->gi_n[i].gn_be->be_sync)
1219 gi->gi_n[i].gn_be->be_sync (gi->gi_n[i].gn_be);
1220 b0->bd_info = on->on_info->oi_orig;
1227 typedef struct glue_Addrec {
1228 struct glue_Addrec *ga_next;
1232 /* List of added subordinates */
1233 static glue_Addrec *ga_list;
1234 static int ga_adding;
1242 slap_overinst *on = (slap_overinst *)be->bd_info;
1243 slap_overinfo *oi = on->on_info;
1244 BackendInfo *bi = oi->oi_orig;
1247 if ( SLAP_GLUE_SUBORDINATE( be )) {
1248 Debug( LDAP_DEBUG_ANY, "glue: backend %s is already subordinate, "
1249 "cannot have glue overlay!\n",
1250 be->be_suffix[0].bv_val, 0, 0 );
1254 gi = ch_calloc( 1, sizeof(glueinfo));
1255 on->on_bi.bi_private = gi;
1256 dnParent( be->be_nsuffix, &gi->gi_pdn );
1258 /* Currently the overlay framework doesn't handle these entry points
1259 * but we need them....
1261 oi->oi_bi.bi_open = glue_open;
1262 oi->oi_bi.bi_close = glue_close;
1264 /* Only advertise these if the root DB supports them */
1265 if ( bi->bi_tool_entry_open )
1266 oi->oi_bi.bi_tool_entry_open = glue_tool_entry_open;
1267 if ( bi->bi_tool_entry_close )
1268 oi->oi_bi.bi_tool_entry_close = glue_tool_entry_close;
1269 if ( bi->bi_tool_entry_first )
1270 oi->oi_bi.bi_tool_entry_first = glue_tool_entry_first;
1271 /* FIXME: check whether all support bi_tool_entry_first_x() ? */
1272 if ( bi->bi_tool_entry_first_x )
1273 oi->oi_bi.bi_tool_entry_first_x = glue_tool_entry_first_x;
1274 if ( bi->bi_tool_entry_next )
1275 oi->oi_bi.bi_tool_entry_next = glue_tool_entry_next;
1276 if ( bi->bi_tool_entry_get )
1277 oi->oi_bi.bi_tool_entry_get = glue_tool_entry_get;
1278 if ( bi->bi_tool_dn2id_get )
1279 oi->oi_bi.bi_tool_dn2id_get = glue_tool_dn2id_get;
1280 if ( bi->bi_tool_entry_put )
1281 oi->oi_bi.bi_tool_entry_put = glue_tool_entry_put;
1282 if ( bi->bi_tool_entry_reindex )
1283 oi->oi_bi.bi_tool_entry_reindex = glue_tool_entry_reindex;
1284 if ( bi->bi_tool_entry_modify )
1285 oi->oi_bi.bi_tool_entry_modify = glue_tool_entry_modify;
1286 if ( bi->bi_tool_sync )
1287 oi->oi_bi.bi_tool_sync = glue_tool_sync;
1289 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_INSTANCE;
1292 be->bd_info = (BackendInfo *)oi;
1293 glue_sub_attach( 1 );
1305 slap_overinst *on = (slap_overinst *)be->bd_info;
1306 glueinfo *gi = (glueinfo *)on->on_bi.bi_private;
1309 return SLAP_CB_CONTINUE;
1318 slap_overinst *on = (slap_overinst *)be->bd_info;
1320 on->on_info->oi_bi.bi_db_close = 0;
1325 glue_sub_del( BackendDB *b0 )
1330 /* Find the top backend for this subordinate */
1332 while ( (be=LDAP_STAILQ_NEXT( be, be_next )) != NULL ) {
1338 if ( SLAP_GLUE_SUBORDINATE( be ))
1340 if ( !SLAP_GLUE_INSTANCE( be ))
1342 if ( !dnIsSuffix( &b0->be_nsuffix[0], &be->be_nsuffix[0] ))
1345 /* OK, got the right backend, find the overlay */
1346 oi = (slap_overinfo *)be->bd_info;
1347 for ( on=oi->oi_list; on; on=on->on_next ) {
1348 if ( on->on_bi.bi_type == glue.on_bi.bi_type )
1351 assert( on != NULL );
1352 gi = on->on_bi.bi_private;
1353 for ( i=0; i < gi->gi_nodes; i++ ) {
1354 if ( gi->gi_n[i].gn_be == b0 ) {
1357 for (j=i+1; j < gi->gi_nodes; j++)
1358 gi->gi_n[j-1] = gi->gi_n[j];
1365 rc = LDAP_NO_SUCH_OBJECT;
1371 /* Attach all the subordinate backends to their superior */
1373 glue_sub_attach( int online )
1375 glue_Addrec *ga, *gnext = NULL;
1383 /* For all the subordinate backends */
1384 for ( ga=ga_list; ga != NULL; ga = gnext ) {
1387 gnext = ga->ga_next;
1389 /* Find the top backend for this subordinate */
1391 while ( (be=LDAP_STAILQ_NEXT( be, be_next )) != NULL ) {
1396 if ( SLAP_GLUE_SUBORDINATE( be ))
1398 if ( !dnIsSuffix( &ga->ga_be->be_nsuffix[0], &be->be_nsuffix[0] ))
1401 /* If it's not already configured, set up the overlay */
1402 if ( !SLAP_GLUE_INSTANCE( be )) {
1403 rc = overlay_config( be, glue.on_bi.bi_type, -1, NULL, NULL);
1407 /* Find the overlay instance */
1408 oi = (slap_overinfo *)be->bd_info;
1409 for ( on=oi->oi_list; on; on=on->on_next ) {
1410 if ( on->on_bi.bi_type == glue.on_bi.bi_type )
1413 assert( on != NULL );
1414 gi = on->on_bi.bi_private;
1415 gi = (glueinfo *)ch_realloc( gi, sizeof(glueinfo) +
1416 gi->gi_nodes * sizeof(gluenode));
1417 gi->gi_n[gi->gi_nodes].gn_be = ga->ga_be;
1418 dnParent( &ga->ga_be->be_nsuffix[0],
1419 &gi->gi_n[gi->gi_nodes].gn_pdn );
1421 on->on_bi.bi_private = gi;
1422 ga->ga_be->be_flags |= SLAP_DBFLAG_GLUE_LINKED;
1426 Debug( LDAP_DEBUG_ANY, "glue: no superior found for sub %s!\n",
1427 ga->ga_be->be_suffix[0].bv_val, 0, 0 );
1428 /* allow this for now, assume a superior will
1436 rc = LDAP_NO_SUCH_OBJECT;
1450 glue_sub_add( BackendDB *be, int advert, int online )
1455 if ( overlay_is_inst( be, "glue" )) {
1456 Debug( LDAP_DEBUG_ANY, "glue: backend %s already has glue overlay, "
1457 "cannot be a subordinate!\n",
1458 be->be_suffix[0].bv_val, 0, 0 );
1461 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_SUBORDINATE;
1463 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_ADVERTISE;
1465 ga = ch_malloc( sizeof( glue_Addrec ));
1466 ga->ga_next = ga_list;
1471 rc = glue_sub_attach( online );
1477 glue_access_allowed(
1480 AttributeDescription *desc,
1482 slap_access_t access,
1483 AccessControlState *state,
1484 slap_mask_t *maskp )
1486 BackendDB *b0, *be = glue_back_select( op->o_bd, &e->e_nname );
1489 if ( be == NULL || be == op->o_bd || be->bd_info->bi_access_allowed == NULL )
1490 return SLAP_CB_CONTINUE;
1494 rc = be->bd_info->bi_access_allowed ( op, e, desc, val, access, state, maskp );
1502 glue.on_bi.bi_type = "glue";
1504 glue.on_bi.bi_db_init = glue_db_init;
1505 glue.on_bi.bi_db_close = glue_db_close;
1506 glue.on_bi.bi_db_destroy = glue_db_destroy;
1508 glue.on_bi.bi_op_search = glue_op_search;
1509 glue.on_bi.bi_op_modify = glue_op_func;
1510 glue.on_bi.bi_op_modrdn = glue_op_func;
1511 glue.on_bi.bi_op_add = glue_op_func;
1512 glue.on_bi.bi_op_delete = glue_op_func;
1513 glue.on_bi.bi_extended = glue_op_func;
1515 glue.on_bi.bi_chk_referrals = glue_chk_referrals;
1516 glue.on_bi.bi_chk_controls = glue_chk_controls;
1517 glue.on_bi.bi_entry_get_rw = glue_entry_get_rw;
1518 glue.on_bi.bi_entry_release_rw = glue_entry_release_rw;
1519 glue.on_bi.bi_access_allowed = glue_access_allowed;
1521 glue.on_response = glue_response;
1523 return overlay_register( &glue );