]> git.sur5r.net Git - openldap/blob - servers/slapd/backglue.c
21b7e52ae126dc92be3a7783b5bc548371c7726b
[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                         if (get_no_subordinate_glue(op) && btmp != b1)
351                                 continue;
352
353                         if (tlimit0 != SLAP_NO_LIMIT) {
354                                 op->o_time = slap_get_time();
355                                 op->ors_tlimit = stoptime - op->o_time;
356                                 if (op->ors_tlimit <= 0) {
357                                         rs->sr_err = gs.err = LDAP_TIMELIMIT_EXCEEDED;
358                                         break;
359                                 }
360                         }
361                         rs->sr_err = 0;
362                         /*
363                          * check for abandon 
364                          */
365                         if (op->o_abandon) {
366                                 goto end_of_loop;
367                         }
368                         op->o_bd = btmp;
369
370                         assert( op->o_bd->be_suffix != NULL );
371                         assert( op->o_bd->be_nsuffix != NULL );
372                         
373                         if (scope0 == LDAP_SCOPE_ONELEVEL && 
374                                 dn_match(pdn, &ndn))
375                         {
376                                 op->ors_scope = LDAP_SCOPE_BASE;
377                                 op->o_req_dn = op->o_bd->be_suffix[0];
378                                 op->o_req_ndn = op->o_bd->be_nsuffix[0];
379                                 rs->sr_err = op->o_bd->be_search(op, rs);
380                                 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
381                                         gs.err = LDAP_SUCCESS;
382                                 }
383                                 op->ors_scope = LDAP_SCOPE_ONELEVEL;
384                                 op->o_req_dn = dn;
385                                 op->o_req_ndn = ndn;
386
387                         } else if (scope0 == LDAP_SCOPE_SUBTREE &&
388                                 dn_match(&op->o_bd->be_nsuffix[0], &ndn))
389                         {
390                                 rs->sr_err = glue_sub_search( op, rs, b0, on );
391
392                         } else if (scope0 == LDAP_SCOPE_SUBTREE &&
393                                 dnIsSuffix(&op->o_bd->be_nsuffix[0], &ndn))
394                         {
395                                 op->o_req_dn = op->o_bd->be_suffix[0];
396                                 op->o_req_ndn = op->o_bd->be_nsuffix[0];
397                                 rs->sr_err = glue_sub_search( op, rs, b0, on );
398                                 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
399                                         gs.err = LDAP_SUCCESS;
400                                 }
401                                 op->o_req_dn = dn;
402                                 op->o_req_ndn = ndn;
403
404                         } else if (dnIsSuffix(&ndn, &op->o_bd->be_nsuffix[0])) {
405                                 rs->sr_err = glue_sub_search( op, rs, b0, on );
406                         }
407
408                         switch ( gs.err ) {
409
410                         /*
411                          * Add errors that should result in dropping
412                          * the search
413                          */
414                         case LDAP_SIZELIMIT_EXCEEDED:
415                         case LDAP_TIMELIMIT_EXCEEDED:
416                         case LDAP_ADMINLIMIT_EXCEEDED:
417                         case LDAP_NO_SUCH_OBJECT:
418 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
419                         case LDAP_X_CANNOT_CHAIN:
420 #endif /* LDAP_CONTROL_X_CHAINING_BEHAVIOR */
421                                 goto end_of_loop;
422                         
423                         default:
424                                 break;
425                         }
426                 }
427 end_of_loop:;
428                 op->ors_scope = scope0;
429                 op->ors_tlimit = tlimit0;
430                 op->o_time = starttime;
431                 op->o_req_dn = dn;
432                 op->o_req_ndn = ndn;
433
434                 break;
435         }
436         if ( op->o_abandon ) {
437                 rs->sr_err = SLAPD_ABANDON;
438         } else {
439                 op->o_callback = cb.sc_next;
440                 rs->sr_err = gs.err;
441                 rs->sr_matched = gs.matched;
442                 rs->sr_ref = gs.refs;
443                 rs->sr_ctrls = gs.ctrls;
444
445                 send_ldap_result( op, rs );
446         }
447
448         op->o_bd = b0;
449         op->o_bd->bd_info = bi0;
450         if (gs.matched)
451                 free (gs.matched);
452         if (gs.refs)
453                 ber_bvarray_free(gs.refs);
454         if (gs.ctrls) {
455                 for (i = gs.nctrls; --i >= 0; ) {
456                         if (!BER_BVISNULL( &gs.ctrls[i]->ldctl_value ))
457                                 free(gs.ctrls[i]->ldctl_value.bv_val);
458                         free(gs.ctrls[i]);
459                 }
460                 free(gs.ctrls);
461         }
462         return rs->sr_err;
463 }
464
465 static BackendDB toolDB;
466
467 static int
468 glue_tool_entry_open (
469         BackendDB *b0,
470         int mode
471 )
472 {
473         slap_overinfo   *oi = (slap_overinfo *)b0->bd_info;
474
475         /* We don't know which backend to talk to yet, so just
476          * remember the mode and move on...
477          */
478
479         glueMode = mode;
480         glueBack = NULL;
481         toolDB = *b0;
482         toolDB.bd_info = oi->oi_orig;
483
484         return 0;
485 }
486
487 static int
488 glue_tool_entry_close (
489         BackendDB *b0
490 )
491 {
492         int rc = 0;
493
494         if (glueBack) {
495                 if (!glueBack->be_entry_close)
496                         return 0;
497                 rc = glueBack->be_entry_close (glueBack);
498         }
499         return rc;
500 }
501
502 static slap_overinst *
503 glue_tool_inst(
504         BackendInfo *bi
505 )
506 {
507         slap_overinfo   *oi = (slap_overinfo *)bi;
508         slap_overinst   *on;
509
510         for ( on = oi->oi_list; on; on=on->on_next ) {
511                 if ( !strcmp( on->on_bi.bi_type, glue.on_bi.bi_type ))
512                         return on;
513         }
514         return NULL;
515 }
516
517 /* This function will only be called in tool mode */
518 static int
519 glue_open (
520         BackendInfo *bi
521 )
522 {
523         slap_overinst *on = glue_tool_inst( bi );
524         glueinfo                *gi = on->on_bi.bi_private;
525         static int glueOpened = 0;
526         int i, j, same, bsame = 0, rc = 0;
527
528         if (glueOpened) return 0;
529
530         glueOpened = 1;
531
532         /* If we were invoked in tool mode, open all the underlying backends */
533         if (slapMode & SLAP_TOOL_MODE) {
534                 for (i = 0; i<gi->gi_nodes; i++) {
535                         same = 0;
536                         /* Same bi_open as our main backend? */
537                         if ( gi->gi_n[i].gn_be->bd_info->bi_open ==
538                                 on->on_info->oi_orig->bi_open )
539                                 bsame = 1;
540
541                         /* Loop thru the bd_info's and make sure we only
542                          * invoke their bi_open functions once each.
543                          */
544                         for ( j = 0; j<i; j++ ) {
545                                 if ( gi->gi_n[i].gn_be->bd_info->bi_open ==
546                                         gi->gi_n[j].gn_be->bd_info->bi_open ) {
547                                         same = 1;
548                                         break;
549                                 }
550                         }
551                         /* OK, it's unique and non-NULL, call it. */
552                         if ( !same && gi->gi_n[i].gn_be->bd_info->bi_open )
553                                 rc = gi->gi_n[i].gn_be->bd_info->bi_open(
554                                         gi->gi_n[i].gn_be->bd_info );
555                         /* Let backend.c take care of the rest of startup */
556                         if ( !rc )
557                                 rc = backend_startup_one( gi->gi_n[i].gn_be );
558                         if ( rc ) break;
559                 }
560                 if ( !rc && !bsame && on->on_info->oi_orig->bi_open )
561                         rc = on->on_info->oi_orig->bi_open( on->on_info->oi_orig );
562
563         } /* other case is impossible */
564         return rc;
565 }
566
567 /* This function will only be called in tool mode */
568 static int
569 glue_close (
570         BackendInfo *bi
571 )
572 {
573         static int glueClosed = 0;
574         int rc = 0;
575
576         if (glueClosed) return 0;
577
578         glueClosed = 1;
579
580         if (slapMode & SLAP_TOOL_MODE) {
581                 rc = backend_shutdown( NULL );
582         }
583         return rc;
584 }
585
586 static int
587 glue_entry_release_rw (
588         Operation *op,
589         Entry *e,
590         int rw
591 )
592 {
593         BackendDB *b0, b2;
594         int rc = -1;
595
596         b0 = op->o_bd;
597         b2 = *op->o_bd;
598         b2.bd_info = (BackendInfo *)glue_tool_inst( op->o_bd->bd_info );
599         op->o_bd = glue_back_select (&b2, &e->e_nname);
600
601         if ( op->o_bd->be_release ) {
602                 rc = op->o_bd->be_release( op, e, rw );
603
604         } else {
605                 /* FIXME: mimic be_entry_release_rw
606                  * when no be_release() available */
607                 /* free entry */
608                 entry_free( e );
609                 rc = 0;
610         }
611         op->o_bd = b0;
612         return rc;
613 }
614
615 static ID
616 glue_tool_entry_first (
617         BackendDB *b0
618 )
619 {
620         slap_overinst   *on = glue_tool_inst( b0->bd_info );
621         glueinfo                *gi = on->on_bi.bi_private;
622         int i;
623
624         /* If we're starting from scratch, start at the most general */
625         if (!glueBack) {
626                 if ( toolDB.be_entry_open && toolDB.be_entry_first ) {
627                         glueBack = &toolDB;
628                 } else {
629                         for (i = gi->gi_nodes-1; i >= 0; i--) {
630                                 if (gi->gi_n[i].gn_be->be_entry_open &&
631                                         gi->gi_n[i].gn_be->be_entry_first) {
632                                                 glueBack = gi->gi_n[i].gn_be;
633                                         break;
634                                 }
635                         }
636                 }
637         }
638         if (!glueBack || !glueBack->be_entry_open || !glueBack->be_entry_first ||
639                 glueBack->be_entry_open (glueBack, glueMode) != 0)
640                 return NOID;
641
642         return glueBack->be_entry_first (glueBack);
643 }
644
645 static ID
646 glue_tool_entry_next (
647         BackendDB *b0
648 )
649 {
650         slap_overinst   *on = glue_tool_inst( b0->bd_info );
651         glueinfo                *gi = on->on_bi.bi_private;
652         int i;
653         ID rc;
654
655         if (!glueBack || !glueBack->be_entry_next)
656                 return NOID;
657
658         rc = glueBack->be_entry_next (glueBack);
659
660         /* If we ran out of entries in one database, move on to the next */
661         while (rc == NOID) {
662                 if ( glueBack && glueBack->be_entry_close )
663                         glueBack->be_entry_close (glueBack);
664                 for (i=0; i<gi->gi_nodes; i++) {
665                         if (gi->gi_n[i].gn_be == glueBack)
666                                 break;
667                 }
668                 if (i == 0) {
669                         glueBack = NULL;
670                         break;
671                 } else {
672                         glueBack = gi->gi_n[i-1].gn_be;
673                         rc = glue_tool_entry_first (b0);
674                 }
675         }
676         return rc;
677 }
678
679 static Entry *
680 glue_tool_entry_get (
681         BackendDB *b0,
682         ID id
683 )
684 {
685         if (!glueBack || !glueBack->be_entry_get)
686                 return NULL;
687
688         return glueBack->be_entry_get (glueBack, id);
689 }
690
691 static ID
692 glue_tool_entry_put (
693         BackendDB *b0,
694         Entry *e,
695         struct berval *text
696 )
697 {
698         BackendDB *be, b2;
699         int rc = -1;
700
701         b2 = *b0;
702         b2.bd_info = (BackendInfo *)glue_tool_inst( b0->bd_info );
703         be = glue_back_select (&b2, &e->e_nname);
704         if ( be == &b2 ) be = &toolDB;
705
706         if (!be->be_entry_put)
707                 return NOID;
708
709         if (!glueBack) {
710                 if ( be->be_entry_open ) {
711                         rc = be->be_entry_open (be, glueMode);
712                 }
713                 if (rc != 0) {
714                         return NOID;
715                 }
716         } else if (be != glueBack) {
717                 /* If this entry belongs in a different branch than the
718                  * previous one, close the current database and open the
719                  * new one.
720                  */
721                 if ( glueBack->be_entry_close ) {
722                         glueBack->be_entry_close (glueBack);
723                 }
724                 if ( be->be_entry_open ) {
725                         rc = be->be_entry_open (be, glueMode);
726                 }
727                 if (rc != 0) {
728                         return NOID;
729                 }
730         }
731         glueBack = be;
732         return be->be_entry_put (be, e, text);
733 }
734
735 static int
736 glue_tool_entry_reindex (
737         BackendDB *b0,
738         ID id
739 )
740 {
741         if (!glueBack || !glueBack->be_entry_reindex)
742                 return -1;
743
744         return glueBack->be_entry_reindex (glueBack, id);
745 }
746
747 static int
748 glue_tool_sync (
749         BackendDB *b0
750 )
751 {
752         slap_overinst   *on = glue_tool_inst( b0->bd_info );
753         glueinfo                *gi = on->on_bi.bi_private;
754         BackendInfo             *bi = b0->bd_info;
755         int i;
756
757         /* just sync everyone */
758         for (i = 0; i<gi->gi_nodes; i++)
759                 if (gi->gi_n[i].gn_be->be_sync)
760                         gi->gi_n[i].gn_be->be_sync (gi->gi_n[i].gn_be);
761         b0->bd_info = on->on_info->oi_orig;
762         if ( b0->be_sync )
763                 b0->be_sync( b0 );
764         b0->bd_info = bi;
765         return 0;
766 }
767
768 static int
769 glue_db_init(
770         BackendDB *be
771 )
772 {
773         slap_overinst   *on = (slap_overinst *)be->bd_info;
774         slap_overinfo   *oi = on->on_info;
775         BackendInfo     *bi = oi->oi_orig;
776         glueinfo *gi;
777
778         gi = ch_calloc( 1, sizeof(glueinfo));
779         on->on_bi.bi_private = gi;
780         dnParent( be->be_nsuffix, &gi->gi_pdn );
781
782         /* Currently the overlay framework doesn't handle these entry points
783          * but we need them....
784          */
785         oi->oi_bi.bi_open = glue_open;
786         oi->oi_bi.bi_close = glue_close;
787
788         oi->oi_bi.bi_entry_release_rw = glue_entry_release_rw;
789
790         /* Only advertise these if the root DB supports them */
791         if ( bi->bi_tool_entry_open )
792                 oi->oi_bi.bi_tool_entry_open = glue_tool_entry_open;
793         if ( bi->bi_tool_entry_close )
794                 oi->oi_bi.bi_tool_entry_close = glue_tool_entry_close;
795         if ( bi->bi_tool_entry_first )
796                 oi->oi_bi.bi_tool_entry_first = glue_tool_entry_first;
797         if ( bi->bi_tool_entry_next )
798                 oi->oi_bi.bi_tool_entry_next = glue_tool_entry_next;
799         if ( bi->bi_tool_entry_get )
800                 oi->oi_bi.bi_tool_entry_get = glue_tool_entry_get;
801         if ( bi->bi_tool_entry_put )
802                 oi->oi_bi.bi_tool_entry_put = glue_tool_entry_put;
803         if ( bi->bi_tool_entry_reindex )
804                 oi->oi_bi.bi_tool_entry_reindex = glue_tool_entry_reindex;
805         if ( bi->bi_tool_sync )
806                 oi->oi_bi.bi_tool_sync = glue_tool_sync;
807
808         /*FIXME : need to add support */
809         oi->oi_bi.bi_tool_dn2id_get = 0;
810         oi->oi_bi.bi_tool_id2entry_get = 0;
811         oi->oi_bi.bi_tool_entry_modify = 0;
812
813         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_INSTANCE;
814
815         return 0;
816 }
817
818 static int
819 glue_db_destroy (
820         BackendDB *be
821 )
822 {
823         slap_overinst   *on = (slap_overinst *)be->bd_info;
824         glueinfo                *gi = (glueinfo *)on->on_bi.bi_private;
825
826         free (gi);
827         return SLAP_CB_CONTINUE;
828 }
829
830 static int
831 glue_db_close( 
832         BackendDB *be
833 )
834 {
835         slap_overinst   *on = (slap_overinst *)be->bd_info;
836
837         on->on_info->oi_bi.bi_db_close = 0;
838         return 0;
839 }
840
841 int
842 glue_sub_del( BackendDB *b0 )
843 {
844         BackendDB *be;
845         int rc = 0;
846
847         /* Find the top backend for this subordinate */
848         be = b0;
849         while ( (be=LDAP_STAILQ_NEXT( be, be_next )) != NULL ) {
850                 slap_overinfo *oi;
851                 slap_overinst *on;
852                 glueinfo *gi;
853                 int i;
854
855                 if ( SLAP_GLUE_SUBORDINATE( be ))
856                         continue;
857                 if ( !SLAP_GLUE_INSTANCE( be ))
858                         continue;
859                 if ( !dnIsSuffix( &b0->be_nsuffix[0], &be->be_nsuffix[0] ))
860                         continue;
861
862                 /* OK, got the right backend, find the overlay */
863                 oi = (slap_overinfo *)be->bd_info;
864                 for ( on=oi->oi_list; on; on=on->on_next ) {
865                         if ( on->on_bi.bi_type == glue.on_bi.bi_type )
866                                 break;
867                 }
868                 assert( on != NULL );
869                 gi = on->on_bi.bi_private;
870                 for ( i=0; i < gi->gi_nodes; i++ ) {
871                         if ( gi->gi_n[i].gn_be == b0 ) {
872                                 int j;
873
874                                 for (j=i+1; j < gi->gi_nodes; j++)
875                                         gi->gi_n[j-1] = gi->gi_n[j];
876
877                                 gi->gi_nodes--;
878                         }
879                 }
880         }
881         if ( be == NULL )
882                 rc = LDAP_NO_SUCH_OBJECT;
883
884         return rc;
885 }
886
887 typedef struct glue_Addrec {
888         struct glue_Addrec *ga_next;
889         BackendDB *ga_be;
890 } glue_Addrec;
891
892 /* List of added subordinates */
893 static glue_Addrec *ga_list;
894
895 /* Attach all the subordinate backends to their superior */
896 int
897 glue_sub_attach()
898 {
899         glue_Addrec *ga, *gnext = NULL;
900         int rc = 0;
901
902         /* For all the subordinate backends */
903         for ( ga=ga_list; ga != NULL; ga = gnext ) {
904                 BackendDB *be;
905
906                 gnext = ga->ga_next;
907
908                 /* Find the top backend for this subordinate */
909                 be = ga->ga_be;
910                 while ( (be=LDAP_STAILQ_NEXT( be, be_next )) != NULL ) {
911                         slap_overinfo *oi;
912                         slap_overinst *on;
913                         glueinfo *gi;
914
915                         if ( SLAP_GLUE_SUBORDINATE( be ))
916                                 continue;
917                         if ( !dnIsSuffix( &ga->ga_be->be_nsuffix[0], &be->be_nsuffix[0] ))
918                                 continue;
919
920                         /* If it's not already configured, set up the overlay */
921                         if ( !SLAP_GLUE_INSTANCE( be )) {
922                                 rc = overlay_config( be, glue.on_bi.bi_type );
923                                 if ( rc )
924                                         break;
925                         }
926                         /* Find the overlay instance */
927                         oi = (slap_overinfo *)be->bd_info;
928                         for ( on=oi->oi_list; on; on=on->on_next ) {
929                                 if ( on->on_bi.bi_type == glue.on_bi.bi_type )
930                                         break;
931                         }
932                         assert( on != NULL );
933                         gi = on->on_bi.bi_private;
934                         gi = (glueinfo *)ch_realloc( gi, sizeof(glueinfo) +
935                                 gi->gi_nodes * sizeof(gluenode));
936                         gi->gi_n[gi->gi_nodes].gn_be = ga->ga_be;
937                         dnParent( &ga->ga_be->be_nsuffix[0],
938                                 &gi->gi_n[gi->gi_nodes].gn_pdn );
939                         gi->gi_nodes++;
940                         on->on_bi.bi_private = gi;
941                         break;
942                 }
943                 if ( !be ) {
944                         Debug( LDAP_DEBUG_ANY, "glue: no superior found for sub %s!\n",
945                                 ga->ga_be->be_suffix[0].bv_val, 0, 0 );
946                         rc = LDAP_NO_SUCH_OBJECT;
947                 }
948                 ch_free( ga );
949                 if ( rc ) break;
950         }
951
952         ga_list = gnext;
953
954         return rc;
955 }
956
957 int
958 glue_sub_add( BackendDB *be, int advert, int online )
959 {
960         glue_Addrec *ga;
961         int rc = 0;
962
963         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_SUBORDINATE;
964         if ( advert )
965                 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLUE_ADVERTISE;
966
967         ga = ch_malloc( sizeof( glue_Addrec ));
968         ga->ga_next = ga_list;
969         ga->ga_be = be;
970         ga_list = ga;
971
972         if ( online )
973                 rc = glue_sub_attach();
974
975         return rc;
976 }
977
978 int
979 glue_sub_init()
980 {
981         glue.on_bi.bi_type = "glue";
982
983         glue.on_bi.bi_db_init = glue_db_init;
984         glue.on_bi.bi_db_close = glue_db_close;
985         glue.on_bi.bi_db_destroy = glue_db_destroy;
986
987         glue.on_bi.bi_op_search = glue_op_search;
988         glue.on_bi.bi_op_modify = glue_op_func;
989         glue.on_bi.bi_op_modrdn = glue_op_func;
990         glue.on_bi.bi_op_add = glue_op_func;
991         glue.on_bi.bi_op_delete = glue_op_func;
992
993         glue.on_bi.bi_chk_referrals = glue_chk_referrals;
994         glue.on_bi.bi_chk_controls = glue_chk_controls;
995
996         return overlay_register( &glue );
997 }