]> git.sur5r.net Git - openldap/blob - servers/slapd/backglue.c
83cab67b52446097e66db54cf2e0449faeaf14c2
[openldap] / servers / slapd / backglue.c
1 /* backglue.c - backend glue */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 2001-2006 The OpenLDAP Foundation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted only as authorized by the OpenLDAP
10  * Public License.
11  *
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>.
15  */
16
17 /*
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.
21  *
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.
26  *  -- Howard Chu
27  */
28
29 #include "portable.h"
30
31 #include <stdio.h>
32
33 #include <ac/string.h>
34 #include <ac/socket.h>
35
36 #define SLAPD_TOOLS
37 #include "slap.h"
38
39 typedef struct gluenode {
40         BackendDB *gn_be;
41         struct berval gn_pdn;
42 } gluenode;
43
44 typedef struct glueinfo {
45         int gi_nodes;
46         struct berval gi_pdn;
47         gluenode gi_n[1];
48 } glueinfo;
49
50 static slap_overinst    glue;
51
52 static int glueMode;
53 static BackendDB *glueBack;
54
55 static slap_response glue_op_response;
56
57 /* Just like select_backend, but only for our backends */
58 static BackendDB *
59 glue_back_select (
60         BackendDB *be,
61         struct berval *dn
62 )
63 {
64         slap_overinst   *on = (slap_overinst *)be->bd_info;
65         glueinfo                *gi = (glueinfo *)on->on_bi.bi_private;
66         int i;
67
68         for (i = gi->gi_nodes-1; i >= 0; i--) {
69                 assert( gi->gi_n[i].gn_be->be_nsuffix != NULL );
70
71                 if (dnIsSuffix(dn, &gi->gi_n[i].gn_be->be_nsuffix[0])) {
72                         return gi->gi_n[i].gn_be;
73                 }
74         }
75         be->bd_info = on->on_info->oi_orig;
76         return be;
77 }
78
79
80 typedef struct glue_state {
81         char *matched;
82         BerVarray refs;
83         LDAPControl **ctrls;
84         int err;
85         int matchlen;
86         int nrefs;
87         int nctrls;
88 } glue_state;
89
90 static int
91 glue_op_response ( Operation *op, SlapReply *rs )
92 {
93         glue_state *gs = op->o_callback->sc_private;
94
95         switch(rs->sr_type) {
96         case REP_SEARCH:
97         case REP_SEARCHREF:
98         case REP_INTERMEDIATE:
99                 return SLAP_CB_CONTINUE;
100
101         default:
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);
111                         gs->matched = NULL;
112                         gs->matchlen = 0;
113                 }
114                 if (gs->err != LDAP_SUCCESS && rs->sr_matched) {
115                         int len;
116                         len = strlen (rs->sr_matched);
117                         if (len > gs->matchlen) {
118                                 if (gs->matched)
119                                         ch_free (gs->matched);
120                                 gs->matched = ch_strdup (rs->sr_matched);
121                                 gs->matchlen = len;
122                         }
123                 }
124                 if (rs->sr_ref) {
125                         int i, j, k;
126                         BerVarray new;
127
128                         for (i=0; rs->sr_ref[i].bv_val; i++);
129
130                         j = gs->nrefs;
131                         if (!j) {
132                                 new = ch_malloc ((i+1)*sizeof(struct berval));
133                         } else {
134                                 new = ch_realloc(gs->refs,
135                                         (j+i+1)*sizeof(struct berval));
136                         }
137                         for (k=0; k<i; j++,k++) {
138                                 ber_dupbv( &new[j], &rs->sr_ref[k] );
139                         }
140                         new[j].bv_val = NULL;
141                         gs->nrefs = j;
142                         gs->refs = new;
143                 }
144                 if (rs->sr_ctrls) {
145                         int i, j, k;
146                         LDAPControl **newctrls;
147
148                         for (i=0; rs->sr_ctrls[i]; i++);
149
150                         j = gs->nctrls;
151                         if (!j) {
152                                 newctrls = ch_malloc((i+1)*sizeof(LDAPControl *));
153                         } else {
154                                 newctrls = ch_realloc(gs->ctrls,
155                                         (j+i+1)*sizeof(LDAPControl *));
156                         }
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 );
163                         }
164                         newctrls[j] = NULL;
165                         gs->nctrls = j;
166                         gs->ctrls = newctrls;
167                 }
168         }
169         return 0;
170 }
171
172 static int
173 glue_op_func ( Operation *op, SlapReply *rs )
174 {
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;
178         BI_op_modify **func;
179         slap_operation_t which = op_bind;
180         int rc;
181
182         op->o_bd = glue_back_select (b0, &op->o_req_ndn);
183
184         /* If we're on the master backend, let overlay framework handle it */
185         if ( op->o_bd == b0 )
186                 return SLAP_CB_CONTINUE;
187
188         b0->bd_info = on->on_info->oi_orig;
189
190         switch(op->o_tag) {
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;
196         }
197
198         func = &op->o_bd->bd_info->bi_op_bind;
199         if ( func[which] )
200                 rc = func[which]( op, rs );
201         else
202                 rc = SLAP_CB_CONTINUE;
203
204         op->o_bd = b0;
205         op->o_bd->bd_info = bi0;
206         return rc;
207 }
208
209 static int
210 glue_chk_referrals ( Operation *op, SlapReply *rs )
211 {
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;
215         int rc;
216
217         op->o_bd = glue_back_select (b0, &op->o_req_ndn);
218         if ( op->o_bd == b0 )
219                 return SLAP_CB_CONTINUE;
220
221         b0->bd_info = on->on_info->oi_orig;
222
223         if ( op->o_bd->bd_info->bi_chk_referrals )
224                 rc = ( *op->o_bd->bd_info->bi_chk_referrals )( op, rs );
225         else
226                 rc = SLAP_CB_CONTINUE;
227
228         op->o_bd = b0;
229         op->o_bd->bd_info = bi0;
230         return rc;
231 }
232
233 static int
234 glue_chk_controls ( Operation *op, SlapReply *rs )
235 {
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;
240
241         op->o_bd = glue_back_select (b0, &op->o_req_ndn);
242         if ( op->o_bd == b0 )
243                 return SLAP_CB_CONTINUE;
244
245         b0->bd_info = on->on_info->oi_orig;
246
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 );
253         }
254
255         
256         if ( rc == SLAP_CB_CONTINUE ) {
257                 rc = backend_check_controls( op, rs );
258         }
259
260         op->o_bd = b0;
261         op->o_bd->bd_info = bi0;
262         return rc;
263 }
264
265 static int
266 glue_sub_search( Operation *op, SlapReply *rs, BackendDB *b0,
267         slap_overinst *on )
268 {
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 )
278                                         break;
279                         }
280                 }
281                 op->o_bd->bd_info = bi;
282                 if ( rc != SLAP_CB_CONTINUE )
283                         return rc;
284         }
285         return op->o_bd->be_search( op, rs );
286 }
287
288 static int
289 glue_op_search ( Operation *op, SlapReply *rs )
290 {
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;
296         int i;
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 };
300         int scope0, tlimit0;
301         struct berval dn, ndn, *pdn;
302
303         cb.sc_private = &gs;
304
305         cb.sc_next = op->o_callback;
306
307         starttime = op->o_time;
308         stoptime = slap_get_time () + op->ors_tlimit;
309
310         op->o_bd = glue_back_select (b0, &op->o_req_ndn);
311         b0->bd_info = on->on_info->oi_orig;
312
313         switch (op->ors_scope) {
314         case LDAP_SCOPE_BASE:
315                 if ( op->o_bd == b0 )
316                         return SLAP_CB_CONTINUE;
317
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 );
321                 }
322                 return rs->sr_err;
323
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;
331                 dn = op->o_req_dn;
332                 ndn = op->o_req_ndn;
333                 b1 = op->o_bd;
334
335                 /*
336                  * Execute in reverse order, most specific first 
337                  */
338                 for (i = gi->gi_nodes; i >= 0; i--) {
339                         if ( i == gi->gi_nodes ) {
340                                 btmp = b0;
341                                 pdn = &gi->gi_pdn;
342                         } else {
343                                 btmp = gi->gi_n[i].gn_be;
344                                 pdn = &gi->gi_n[i].gn_pdn;
345                         }
346                         if (!btmp || !btmp->be_search)
347                                 continue;
348                         if (!dnIsSuffix(&btmp->be_nsuffix[0], &b1->be_nsuffix[0]))
349                                 continue;
350
351                         if (tlimit0 != SLAP_NO_LIMIT) {
352                                 op->o_time = slap_get_time();
353                                 op->ors_tlimit = stoptime - op->o_time;
354                                 if (op->ors_tlimit <= 0) {
355                                         rs->sr_err = gs.err = LDAP_TIMELIMIT_EXCEEDED;
356                                         break;
357                                 }
358                         }
359                         rs->sr_err = 0;
360                         /*
361                          * check for abandon 
362                          */
363                         if (op->o_abandon) {
364                                 goto end_of_loop;
365                         }
366                         op->o_bd = btmp;
367
368                         assert( op->o_bd->be_suffix != NULL );
369                         assert( op->o_bd->be_nsuffix != NULL );
370                         
371                         if (scope0 == LDAP_SCOPE_ONELEVEL && 
372                                 dn_match(pdn, &ndn))
373                         {
374                                 op->ors_scope = LDAP_SCOPE_BASE;
375                                 op->o_req_dn = op->o_bd->be_suffix[0];
376                                 op->o_req_ndn = op->o_bd->be_nsuffix[0];
377                                 rs->sr_err = op->o_bd->be_search(op, rs);
378                                 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
379                                         gs.err = LDAP_SUCCESS;
380                                 }
381
382                         } else if (scope0 == LDAP_SCOPE_SUBTREE &&
383                                 dn_match(&op->o_bd->be_nsuffix[0], &ndn))
384                         {
385                                 rs->sr_err = glue_sub_search( op, rs, b0, on );
386
387                         } else if (scope0 == LDAP_SCOPE_SUBTREE &&
388                                 dnIsSuffix(&op->o_bd->be_nsuffix[0], &ndn))
389                         {
390                                 op->o_req_dn = op->o_bd->be_suffix[0];
391                                 op->o_req_ndn = op->o_bd->be_nsuffix[0];
392                                 rs->sr_err = glue_sub_search( op, rs, b0, on );
393                                 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
394                                         gs.err = LDAP_SUCCESS;
395                                 }
396                                 op->o_req_dn = dn;
397                                 op->o_req_ndn = ndn;
398
399                         } else if (dnIsSuffix(&ndn, &op->o_bd->be_nsuffix[0])) {
400                                 rs->sr_err = glue_sub_search( op, rs, b0, on );
401                         }
402
403                         switch ( gs.err ) {
404
405                         /*
406                          * Add errors that should result in dropping
407                          * the search
408                          */
409                         case LDAP_SIZELIMIT_EXCEEDED:
410                         case LDAP_TIMELIMIT_EXCEEDED:
411                         case LDAP_ADMINLIMIT_EXCEEDED:
412                         case LDAP_NO_SUCH_OBJECT:
413 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
414                         case LDAP_X_CANNOT_CHAIN:
415 #endif /* LDAP_CONTROL_X_CHAINING_BEHAVIOR */
416                                 goto end_of_loop;
417                         
418                         default:
419                                 break;
420                         }
421                 }
422 end_of_loop:;
423                 op->ors_scope = scope0;
424                 op->ors_tlimit = tlimit0;
425                 op->o_time = starttime;
426                 op->o_req_dn = dn;
427                 op->o_req_ndn = ndn;
428
429                 break;
430         }
431         if ( op->o_abandon ) {
432                 rs->sr_err = SLAPD_ABANDON;
433         } else {
434                 op->o_callback = cb.sc_next;
435                 rs->sr_err = gs.err;
436                 rs->sr_matched = gs.matched;
437                 rs->sr_ref = gs.refs;
438                 rs->sr_ctrls = gs.ctrls;
439
440                 send_ldap_result( op, rs );
441         }
442
443         op->o_bd = b0;
444         op->o_bd->bd_info = bi0;
445         if (gs.matched)
446                 free (gs.matched);
447         if (gs.refs)
448                 ber_bvarray_free(gs.refs);
449         if (gs.ctrls) {
450                 for (i = gs.nctrls; --i >= 0; ) {
451                         if (!BER_BVISNULL( &gs.ctrls[i]->ldctl_value ))
452                                 free(gs.ctrls[i]->ldctl_value.bv_val);
453                         free(gs.ctrls[i]);
454                 }
455                 free(gs.ctrls);
456         }
457         return rs->sr_err;
458 }
459
460 static BackendDB toolDB;
461
462 static int
463 glue_tool_entry_open (
464         BackendDB *b0,
465         int mode
466 )
467 {
468         slap_overinfo   *oi = (slap_overinfo *)b0->bd_info;
469
470         /* We don't know which backend to talk to yet, so just
471          * remember the mode and move on...
472          */
473
474         glueMode = mode;
475         glueBack = NULL;
476         toolDB = *b0;
477         toolDB.bd_info = oi->oi_orig;
478
479         return 0;
480 }
481
482 static int
483 glue_tool_entry_close (
484         BackendDB *b0
485 )
486 {
487         int rc = 0;
488
489         if (glueBack) {
490                 if (!glueBack->be_entry_close)
491                         return 0;
492                 rc = glueBack->be_entry_close (glueBack);
493         }
494         return rc;
495 }
496
497 static slap_overinst *
498 glue_tool_inst(
499         BackendInfo *bi
500 )
501 {
502         slap_overinfo   *oi = (slap_overinfo *)bi;
503         slap_overinst   *on;
504
505         for ( on = oi->oi_list; on; on=on->on_next ) {
506                 if ( !strcmp( on->on_bi.bi_type, glue.on_bi.bi_type ))
507                         return on;
508         }
509         return NULL;
510 }
511
512 /* This function will only be called in tool mode */
513 static int
514 glue_open (
515         BackendInfo *bi
516 )
517 {
518         slap_overinst *on = glue_tool_inst( bi );
519         glueinfo                *gi = on->on_bi.bi_private;
520         static int glueOpened = 0;
521         int i, j, same, bsame = 0, rc = 0;
522
523         if (glueOpened) return 0;
524
525         glueOpened = 1;
526
527         /* If we were invoked in tool mode, open all the underlying backends */
528         if (slapMode & SLAP_TOOL_MODE) {
529                 for (i = 0; i<gi->gi_nodes; i++) {
530                         same = 0;
531                         /* Same bi_open as our main backend? */
532                         if ( gi->gi_n[i].gn_be->bd_info->bi_open ==
533                                 on->on_info->oi_orig->bi_open )
534                                 bsame = 1;
535
536                         /* Loop thru the bd_info's and make sure we only
537                          * invoke their bi_open functions once each.
538                          */
539                         for ( j = 0; j<i; j++ ) {
540                                 if ( gi->gi_n[i].gn_be->bd_info->bi_open ==
541                                         gi->gi_n[j].gn_be->bd_info->bi_open ) {
542                                         same = 1;
543                                         break;
544                                 }
545                         }
546                         /* OK, it's unique and non-NULL, call it. */
547                         if ( !same && gi->gi_n[i].gn_be->bd_info->bi_open )
548                                 rc = gi->gi_n[i].gn_be->bd_info->bi_open(
549                                         gi->gi_n[i].gn_be->bd_info );
550                         /* Let backend.c take care of the rest of startup */
551                         if ( !rc )
552                                 rc = backend_startup_one( gi->gi_n[i].gn_be );
553                         if ( rc ) break;
554                 }
555                 if ( !rc && !bsame && on->on_info->oi_orig->bi_open )
556                         rc = on->on_info->oi_orig->bi_open( on->on_info->oi_orig );
557
558         } /* other case is impossible */
559         return rc;
560 }
561
562 /* This function will only be called in tool mode */
563 static int
564 glue_close (
565         BackendInfo *bi
566 )
567 {
568         static int glueClosed = 0;
569         int rc = 0;
570
571         if (glueClosed) return 0;
572
573         glueClosed = 1;
574
575         if (slapMode & SLAP_TOOL_MODE) {
576                 rc = backend_shutdown( NULL );
577         }
578         return rc;
579 }
580
581 static int
582 glue_entry_release_rw (
583         Operation *op,
584         Entry *e,
585         int rw
586 )
587 {
588         BackendDB *b0, b2;
589         int rc = -1;
590
591         b0 = op->o_bd;
592         b2 = *op->o_bd;
593         b2.bd_info = (BackendInfo *)glue_tool_inst( op->o_bd->bd_info );
594         op->o_bd = glue_back_select (&b2, &e->e_nname);
595
596         if ( op->o_bd->be_release ) {
597                 rc = op->o_bd->be_release( op, e, rw );
598
599         } else {
600                 /* FIXME: mimic be_entry_release_rw
601                  * when no be_release() available */
602                 /* free entry */
603                 entry_free( e );
604                 rc = 0;
605         }
606         op->o_bd = b0;
607         return rc;
608 }
609
610 static ID
611 glue_tool_entry_first (
612         BackendDB *b0
613 )
614 {
615         slap_overinst   *on = glue_tool_inst( b0->bd_info );
616         glueinfo                *gi = on->on_bi.bi_private;
617         int i;
618
619         /* If we're starting from scratch, start at the most general */
620         if (!glueBack) {
621                 if ( toolDB.be_entry_open && toolDB.be_entry_first ) {
622                         glueBack = &toolDB;
623                 } else {
624                         for (i = gi->gi_nodes-1; i >= 0; i--) {
625                                 if (gi->gi_n[i].gn_be->be_entry_open &&
626                                         gi->gi_n[i].gn_be->be_entry_first) {
627                                                 glueBack = gi->gi_n[i].gn_be;
628                                         break;
629                                 }
630                         }
631                 }
632         }
633         if (!glueBack || !glueBack->be_entry_open || !glueBack->be_entry_first ||
634                 glueBack->be_entry_open (glueBack, glueMode) != 0)
635                 return NOID;
636
637         return glueBack->be_entry_first (glueBack);
638 }
639
640 static ID
641 glue_tool_entry_next (
642         BackendDB *b0
643 )
644 {
645         slap_overinst   *on = glue_tool_inst( b0->bd_info );
646         glueinfo                *gi = on->on_bi.bi_private;
647         int i;
648         ID rc;
649
650         if (!glueBack || !glueBack->be_entry_next)
651                 return NOID;
652
653         rc = glueBack->be_entry_next (glueBack);
654
655         /* If we ran out of entries in one database, move on to the next */
656         while (rc == NOID) {
657                 if ( glueBack && glueBack->be_entry_close )
658                         glueBack->be_entry_close (glueBack);
659                 for (i=0; i<gi->gi_nodes; i++) {
660                         if (gi->gi_n[i].gn_be == glueBack)
661                                 break;
662                 }
663                 if (i == 0) {
664                         glueBack = NULL;
665                         break;
666                 } else {
667                         glueBack = gi->gi_n[i-1].gn_be;
668                         rc = glue_tool_entry_first (b0);
669                 }
670         }
671         return rc;
672 }
673
674 static Entry *
675 glue_tool_entry_get (
676         BackendDB *b0,
677         ID id
678 )
679 {
680         if (!glueBack || !glueBack->be_entry_get)
681                 return NULL;
682
683         return glueBack->be_entry_get (glueBack, id);
684 }
685
686 static ID
687 glue_tool_entry_put (
688         BackendDB *b0,
689         Entry *e,
690         struct berval *text
691 )
692 {
693         BackendDB *be, b2;
694         int rc = -1;
695
696         b2 = *b0;
697         b2.bd_info = (BackendInfo *)glue_tool_inst( b0->bd_info );
698         be = glue_back_select (&b2, &e->e_nname);
699         if ( be == &b2 ) be = &toolDB;
700
701         if (!be->be_entry_put)
702                 return NOID;
703
704         if (!glueBack) {
705                 if ( be->be_entry_open ) {
706                         rc = be->be_entry_open (be, glueMode);
707                 }
708                 if (rc != 0) {
709                         return NOID;
710                 }
711         } else if (be != glueBack) {
712                 /* If this entry belongs in a different branch than the
713                  * previous one, close the current database and open the
714                  * new one.
715                  */
716                 if ( glueBack->be_entry_close ) {
717                         glueBack->be_entry_close (glueBack);
718                 }
719                 if ( be->be_entry_open ) {
720                         rc = be->be_entry_open (be, glueMode);
721                 }
722                 if (rc != 0) {
723                         return NOID;
724                 }
725         }
726         glueBack = be;
727         return be->be_entry_put (be, e, text);
728 }
729
730 static int
731 glue_tool_entry_reindex (
732         BackendDB *b0,
733         ID id
734 )
735 {
736         if (!glueBack || !glueBack->be_entry_reindex)
737                 return -1;
738
739         return glueBack->be_entry_reindex (glueBack, id);
740 }
741
742 static int
743 glue_tool_sync (
744         BackendDB *b0
745 )
746 {
747         slap_overinst   *on = glue_tool_inst( b0->bd_info );
748         glueinfo                *gi = on->on_bi.bi_private;
749         BackendInfo             *bi = b0->bd_info;
750         int i;
751
752         /* just sync everyone */
753         for (i = 0; i<gi->gi_nodes; i++)
754                 if (gi->gi_n[i].gn_be->be_sync)
755                         gi->gi_n[i].gn_be->be_sync (gi->gi_n[i].gn_be);
756         b0->bd_info = on->on_info->oi_orig;
757         if ( b0->be_sync )
758                 b0->be_sync( b0 );
759         b0->bd_info = bi;
760         return 0;
761 }
762
763 static int
764 glue_db_init(
765         BackendDB *be
766 )
767 {
768         slap_overinst   *on = (slap_overinst *)be->bd_info;
769         slap_overinfo   *oi = on->on_info;
770         BackendInfo     *bi = oi->oi_orig;
771         glueinfo *gi;
772
773         gi = ch_calloc( 1, sizeof(glueinfo));
774         on->on_bi.bi_private = gi;
775         dnParent( be->be_nsuffix, &gi->gi_pdn );
776
777         /* Currently the overlay framework doesn't handle these entry points
778          * but we need them....
779          */
780         oi->oi_bi.bi_open = glue_open;
781         oi->oi_bi.bi_close = glue_close;
782
783         oi->oi_bi.bi_entry_release_rw = glue_entry_release_rw;
784
785         /* Only advertise these if the root DB supports them */
786         if ( bi->bi_tool_entry_open )
787                 oi->oi_bi.bi_tool_entry_open = glue_tool_entry_open;
788         if ( bi->bi_tool_entry_close )
789                 oi->oi_bi.bi_tool_entry_close = glue_tool_entry_close;
790         if ( bi->bi_tool_entry_first )
791                 oi->oi_bi.bi_tool_entry_first = glue_tool_entry_first;
792         if ( bi->bi_tool_entry_next )
793                 oi->oi_bi.bi_tool_entry_next = glue_tool_entry_next;
794         if ( bi->bi_tool_entry_get )
795                 oi->oi_bi.bi_tool_entry_get = glue_tool_entry_get;
796         if ( bi->bi_tool_entry_put )
797                 oi->oi_bi.bi_tool_entry_put = glue_tool_entry_put;
798         if ( bi->bi_tool_entry_reindex )
799                 oi->oi_bi.bi_tool_entry_reindex = glue_tool_entry_reindex;
800         if ( bi->bi_tool_sync )
801                 oi->oi_bi.bi_tool_sync = glue_tool_sync;
802
803         /*FIXME : need to add support */
804         oi->oi_bi.bi_tool_dn2id_get = 0;
805         oi->oi_bi.bi_tool_id2entry_get = 0;
806         oi->oi_bi.bi_tool_entry_modify = 0;
807
808         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_INSTANCE;
809
810         return 0;
811 }
812
813 static int
814 glue_db_destroy (
815         BackendDB *be
816 )
817 {
818         slap_overinst   *on = (slap_overinst *)be->bd_info;
819         glueinfo                *gi = (glueinfo *)on->on_bi.bi_private;
820
821         free (gi);
822         return SLAP_CB_CONTINUE;
823 }
824
825 static int
826 glue_db_close( 
827         BackendDB *be
828 )
829 {
830         slap_overinst   *on = (slap_overinst *)be->bd_info;
831
832         on->on_info->oi_bi.bi_db_close = 0;
833         return 0;
834 }
835
836 int
837 glue_sub_del( BackendDB *b0 )
838 {
839         BackendDB *be;
840         int rc = 0;
841
842         /* Find the top backend for this subordinate */
843         be = b0;
844         while ( (be=LDAP_STAILQ_NEXT( be, be_next )) != NULL ) {
845                 slap_overinfo *oi;
846                 slap_overinst *on;
847                 glueinfo *gi;
848                 int i;
849
850                 if ( SLAP_GLUE_SUBORDINATE( be ))
851                         continue;
852                 if ( !SLAP_GLUE_INSTANCE( be ))
853                         continue;
854                 if ( !dnIsSuffix( &b0->be_nsuffix[0], &be->be_nsuffix[0] ))
855                         continue;
856
857                 /* OK, got the right backend, find the overlay */
858                 oi = (slap_overinfo *)be->bd_info;
859                 for ( on=oi->oi_list; on; on=on->on_next ) {
860                         if ( on->on_bi.bi_type == glue.on_bi.bi_type )
861                                 break;
862                 }
863                 assert( on != NULL );
864                 gi = on->on_bi.bi_private;
865                 for ( i=0; i < gi->gi_nodes; i++ ) {
866                         if ( gi->gi_n[i].gn_be == b0 ) {
867                                 int j;
868
869                                 for (j=i+1; j < gi->gi_nodes; j++)
870                                         gi->gi_n[j-1] = gi->gi_n[j];
871
872                                 gi->gi_nodes--;
873                         }
874                 }
875         }
876         if ( be == NULL )
877                 rc = LDAP_NO_SUCH_OBJECT;
878
879         return rc;
880 }
881
882 typedef struct glue_Addrec {
883         struct glue_Addrec *ga_next;
884         BackendDB *ga_be;
885 } glue_Addrec;
886
887 /* List of added subordinates */
888 static glue_Addrec *ga_list;
889
890 /* Attach all the subordinate backends to their superior */
891 int
892 glue_sub_attach()
893 {
894         glue_Addrec *ga, *gnext = NULL;
895         int rc = 0;
896
897         /* For all the subordinate backends */
898         for ( ga=ga_list; ga != NULL; ga = gnext ) {
899                 BackendDB *be;
900
901                 gnext = ga->ga_next;
902
903                 /* Find the top backend for this subordinate */
904                 be = ga->ga_be;
905                 while ( (be=LDAP_STAILQ_NEXT( be, be_next )) != NULL ) {
906                         slap_overinfo *oi;
907                         slap_overinst *on;
908                         glueinfo *gi;
909
910                         if ( SLAP_GLUE_SUBORDINATE( be ))
911                                 continue;
912                         if ( !dnIsSuffix( &ga->ga_be->be_nsuffix[0], &be->be_nsuffix[0] ))
913                                 continue;
914
915                         /* If it's not already configured, set up the overlay */
916                         if ( !SLAP_GLUE_INSTANCE( be )) {
917                                 rc = overlay_config( be, glue.on_bi.bi_type );
918                                 if ( rc )
919                                         break;
920                         }
921                         /* Find the overlay instance */
922                         oi = (slap_overinfo *)be->bd_info;
923                         for ( on=oi->oi_list; on; on=on->on_next ) {
924                                 if ( on->on_bi.bi_type == glue.on_bi.bi_type )
925                                         break;
926                         }
927                         assert( on != NULL );
928                         gi = on->on_bi.bi_private;
929                         gi = (glueinfo *)ch_realloc( gi, sizeof(glueinfo) +
930                                 gi->gi_nodes * sizeof(gluenode));
931                         gi->gi_n[gi->gi_nodes].gn_be = ga->ga_be;
932                         dnParent( &ga->ga_be->be_nsuffix[0],
933                                 &gi->gi_n[gi->gi_nodes].gn_pdn );
934                         gi->gi_nodes++;
935                         on->on_bi.bi_private = gi;
936                         break;
937                 }
938                 if ( !be ) {
939                         Debug( LDAP_DEBUG_ANY, "glue: no superior found for sub %s!\n",
940                                 ga->ga_be->be_suffix[0].bv_val, 0, 0 );
941                         rc = LDAP_NO_SUCH_OBJECT;
942                 }
943                 ch_free( ga );
944                 if ( rc ) break;
945         }
946
947         ga_list = gnext;
948
949         return rc;
950 }
951
952 int
953 glue_sub_add( BackendDB *be, int advert, int online )
954 {
955         glue_Addrec *ga;
956         int rc = 0;
957
958         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_SUBORDINATE;
959         if ( advert )
960                 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_ADVERTISE;
961
962         ga = ch_malloc( sizeof( glue_Addrec ));
963         ga->ga_next = ga_list;
964         ga->ga_be = be;
965         ga_list = ga;
966
967         if ( online )
968                 rc = glue_sub_attach();
969
970         return rc;
971 }
972
973 int
974 glue_sub_init()
975 {
976         glue.on_bi.bi_type = "glue";
977
978         glue.on_bi.bi_db_init = glue_db_init;
979         glue.on_bi.bi_db_close = glue_db_close;
980         glue.on_bi.bi_db_destroy = glue_db_destroy;
981
982         glue.on_bi.bi_op_search = glue_op_search;
983         glue.on_bi.bi_op_modify = glue_op_func;
984         glue.on_bi.bi_op_modrdn = glue_op_func;
985         glue.on_bi.bi_op_add = glue_op_func;
986         glue.on_bi.bi_op_delete = glue_op_func;
987
988         glue.on_bi.bi_chk_referrals = glue_chk_referrals;
989         glue.on_bi.bi_chk_controls = glue_chk_controls;
990
991         return overlay_register( &glue );
992 }