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