git.sur5r.net Git - openldap/blob - servers/slapd/backglue.c

   1 /* backglue.c - backend glue routines */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 2001-2003 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 /*
   9  * Functions to glue a bunch of other backends into a single tree.
  10  * All of the glued backends must share a common suffix. E.g., you
  11  * can glue o=foo and ou=bar,o=foo but you can't glue o=foo and o=bar.
  12  *
  13  * This uses the backend structures and routines extensively, but is
  14  * not an actual backend of its own. To use it you must add a "subordinate"
  15  * keyword to the configuration of other backends. Subordinates will
  16  * automatically be connected to their parent backend.
  17  *
  18  * The purpose of these functions is to allow you to split a single database
  19  * into pieces (for load balancing purposes, whatever) but still be able
  20  * to treat it as a single database after it's been split. As such, each
  21  * of the glued backends should have identical rootdn and rootpw.
  22  *
  23  * If you need more elaborate configuration, you probably should be using
  24  * back-meta instead.
  25  *  -- Howard Chu
  26  */
  27
  28 #include "portable.h"
  29
  30 #include <stdio.h>
  31
  32 #include <ac/string.h>
  33 #include <ac/socket.h>
  34
  35 #define SLAPD_TOOLS
  36 #include "slap.h"
  37
  38 typedef struct gluenode {
  39         BackendDB *be;
  40         struct berval pdn;
  41 } gluenode;
  42
  43 typedef struct glueinfo {
  44         BackendInfo bi;
  45         BackendDB bd;
  46         int nodes;
  47         gluenode n[1];
  48 } glueinfo;
  49
  50 static int glueMode;
  51 static BackendDB *glueBack;
  52
  53 /* Just like select_backend, but only for our backends */
  54 static BackendDB *
  55 glue_back_select (
  56         BackendDB *be,
  57         const char *dn
  58 )
  59 {
  60         glueinfo *gi = (glueinfo *) be->bd_info;
  61         struct berval bv;
  62         int i;
  63
  64         bv.bv_len = strlen(dn);
  65         bv.bv_val = (char *) dn;
  66
  67         for (i = 0; i<gi->nodes; i++) {
  68                 if (dnIsSuffix(&bv, &gi->n[i].be->be_nsuffix[0])) {
  69                         return gi->n[i].be;
  70                 }
  71         }
  72         return NULL;
  73 }
  74
  75 /* This function will only be called in tool mode */
  76 static int
  77 glue_back_open (
  78         BackendInfo *bi
  79 )
  80 {
  81         int rc = 0;
  82         static int glueOpened = 0;
  83
  84         if (glueOpened) return 0;
  85
  86         glueOpened = 1;
  87
  88         /* If we were invoked in tool mode, open all the underlying backends */
  89         if (slapMode & SLAP_TOOL_MODE) {
  90                 rc = backend_startup (NULL);
  91         } /* other case is impossible */
  92         return rc;
  93 }
  94
  95 /* This function will only be called in tool mode */
  96 static int
  97 glue_back_close (
  98         BackendInfo *bi
  99 )
 100 {
 101         static int glueClosed = 0;
 102         int rc = 0;
 103
 104         if (glueClosed) return 0;
 105
 106         glueClosed = 1;
 107
 108         if (slapMode & SLAP_TOOL_MODE) {
 109                 rc = backend_shutdown (NULL);
 110         }
 111         return rc;
 112 }
 113
 114 static int
 115 glue_back_db_open (
 116         BackendDB *be
 117 )
 118 {
 119         glueinfo *gi = (glueinfo *) be->bd_info;
 120         static int glueOpened = 0;
 121         int rc = 0;
 122
 123         if (glueOpened) return 0;
 124
 125         glueOpened = 1;
 126
 127         gi->bd.be_acl = be->be_acl;
 128
 129         if (gi->bd.bd_info->bi_db_open)
 130                 rc = gi->bd.bd_info->bi_db_open(&gi->bd);
 131
 132         return rc;
 133 }
 134
 135 static int
 136 glue_back_db_close (
 137         BackendDB *be
 138 )
 139 {
 140         glueinfo *gi = (glueinfo *) be->bd_info;
 141         static int glueClosed = 0;
 142
 143         if (glueClosed) return 0;
 144
 145         glueClosed = 1;
 146
 147         /* Close the master */
 148         if (gi->bd.bd_info->bi_db_close)
 149                 gi->bd.bd_info->bi_db_close( &gi->bd );
 150
 151         return 0;
 152 }
 153
 154 static int
 155 glue_back_db_destroy (
 156         BackendDB *be
 157 )
 158 {
 159         glueinfo *gi = (glueinfo *) be->bd_info;
 160
 161         if (gi->bd.bd_info->bi_db_destroy)
 162                 gi->bd.bd_info->bi_db_destroy( &gi->bd );
 163         free (gi);
 164         return 0;
 165 }
 166
 167 typedef struct glue_state {
 168         int err;
 169         int nentries;
 170         int matchlen;
 171         char *matched;
 172         int nrefs;
 173         BerVarray refs;
 174         slap_callback *prevcb;
 175 } glue_state;
 176
 177 static void
 178 glue_back_response (
 179         Connection *conn,
 180         Operation *op,
 181         ber_tag_t tag,
 182         ber_int_t msgid,
 183         ber_int_t err,
 184         const char *matched,
 185         const char *text,
 186         BerVarray ref,
 187         const char *resoid,
 188         struct berval *resdata,
 189         struct berval *sasldata,
 190         LDAPControl **ctrls
 191 )
 192 {
 193         glue_state *gs = op->o_callback->sc_private;
 194
 195         if (err == LDAP_SUCCESS || gs->err != LDAP_SUCCESS)
 196                 gs->err = err;
 197         if (gs->err == LDAP_SUCCESS && gs->matched) {
 198                 free (gs->matched);
 199                 gs->matched = NULL;
 200                 gs->matchlen = 0;
 201         }
 202         if (gs->err != LDAP_SUCCESS && matched) {
 203                 int len;
 204                 len = strlen (matched);
 205                 if (len > gs->matchlen) {
 206                         if (gs->matched)
 207                                 free (gs->matched);
 208                         gs->matched = ch_strdup (matched);
 209                         gs->matchlen = len;
 210                 }
 211         }
 212         if (ref) {
 213                 int i, j, k;
 214                 BerVarray new;
 215
 216                 for (i=0; ref[i].bv_val; i++);
 217
 218                 j = gs->nrefs;
 219                 if (!j) {
 220                         new = ch_malloc ((i+1)*sizeof(struct berval));
 221                 } else {
 222                         new = ch_realloc(gs->refs,
 223                                 (j+i+1)*sizeof(struct berval));
 224                 }
 225                 for (k=0; k<i; j++,k++) {
 226                         ber_dupbv( &new[j], &ref[k] );
 227                 }
 228                 new[j].bv_val = NULL;
 229                 gs->nrefs = j;
 230                 gs->refs = new;
 231         }
 232 }
 233
 234 static void
 235 glue_back_sresult (
 236         Connection *c,
 237         Operation *op,
 238         ber_int_t err,
 239         const char *matched,
 240         const char *text,
 241         BerVarray refs,
 242         LDAPControl **ctrls,
 243         int nentries
 244 )
 245 {
 246         glue_state *gs = op->o_callback->sc_private;
 247
 248         gs->nentries += nentries;
 249         glue_back_response (c, op, 0, 0, err, matched, text, refs,
 250                             NULL, NULL, NULL, ctrls);
 251 }
 252
 253 static int
 254 glue_back_sendentry (
 255         BackendDB *be,
 256         Connection *c,
 257         Operation *op,
 258         Entry *e,
 259         AttributeName *an,
 260         int ao,
 261         LDAPControl **ctrls
 262 )
 263 {
 264         slap_callback *tmp = op->o_callback;
 265         glue_state *gs = tmp->sc_private;
 266         int rc;
 267
 268         op->o_callback = gs->prevcb;
 269         if (op->o_callback && op->o_callback->sc_sendentry) {
 270                 rc = op->o_callback->sc_sendentry(be, c, op, e, an, ao, ctrls);
 271         } else {
 272                 rc = send_search_entry(be, c, op, e, an, ao, ctrls);
 273         }
 274         op->o_callback = tmp;
 275         return rc;
 276 }
 277
 278 static int
 279 glue_back_search (
 280         BackendDB *b0,
 281         Connection *conn,
 282         Operation *op,
 283         struct berval *dn,
 284         struct berval *ndn,
 285         int scope,
 286         int deref,
 287         int slimit,
 288         int tlimit,
 289         Filter *filter,
 290         struct berval *filterstr,
 291         AttributeName *attrs,
 292         int attrsonly
 293 )
 294 {
 295         glueinfo *gi = (glueinfo *) b0->bd_info;
 296         BackendDB *be;
 297         int i, rc = 0, t2limit = 0, s2limit = 0;
 298         long stoptime = 0;
 299         glue_state gs = {0, 0, 0, NULL, 0, NULL, NULL};
 300         slap_callback cb;
 301
 302         cb.sc_response = glue_back_response;
 303         cb.sc_sresult = glue_back_sresult;
 304         cb.sc_sendentry = glue_back_sendentry;
 305         cb.sc_private = &gs;
 306
 307         gs.prevcb = op->o_callback;
 308
 309         if (tlimit) {
 310                 stoptime = slap_get_time () + tlimit;
 311         }
 312
 313         switch (scope) {
 314         case LDAP_SCOPE_BASE:
 315                 be = glue_back_select (b0, ndn->bv_val);
 316
 317                 if (be && be->be_search) {
 318                         rc = be->be_search (be, conn, op, dn, ndn, scope,
 319                                    deref, slimit, tlimit, filter, filterstr,
 320                                             attrs, attrsonly);
 321                 } else {
 322                         rc = LDAP_UNWILLING_TO_PERFORM;
 323                         send_ldap_result (conn, op, rc, NULL,
 324                                       "No search target found", NULL, NULL);
 325                 }
 326                 return rc;
 327
 328         case LDAP_SCOPE_ONELEVEL:
 329         case LDAP_SCOPE_SUBTREE:
 330                 op->o_callback = &cb;
 331                 rc = gs.err = LDAP_UNWILLING_TO_PERFORM;
 332
 333                 /*
 334                  * Execute in reverse order, most general first
 335                  */
 336                 for (i = gi->nodes-1; i >= 0; i--) {
 337                         if (!gi->n[i].be || !gi->n[i].be->be_search)
 338                                 continue;
 339                         if (tlimit) {
 340                                 t2limit = stoptime - slap_get_time ();
 341                                 if (t2limit <= 0) {
 342                                         rc = gs.err = LDAP_TIMELIMIT_EXCEEDED;
 343                                         break;
 344                                 }
 345                         }
 346                         if (slimit) {
 347                                 s2limit = slimit - gs.nentries;
 348                                 if (s2limit <= 0) {
 349                                         rc = gs.err = LDAP_SIZELIMIT_EXCEEDED;
 350                                         break;
 351                                 }
 352                         }
 353                         rc = 0;
 354                         /*
 355                          * check for abandon
 356                          */
 357                         if (op->o_abandon) {
 358                                 goto done;
 359                         }
 360                         be = gi->n[i].be;
 361                         if (scope == LDAP_SCOPE_ONELEVEL &&
 362                                 dn_match(&gi->n[i].pdn, ndn)) {
 363                                 rc = be->be_search (be, conn, op,
 364                                         &be->be_suffix[0], &be->be_nsuffix[0],
 365                                         LDAP_SCOPE_BASE, deref,
 366                                         s2limit, t2limit, filter, filterstr,
 367                                         attrs, attrsonly);
 368
 369                         } else if (scope == LDAP_SCOPE_SUBTREE &&
 370                                 dnIsSuffix(&be->be_nsuffix[0], ndn)) {
 371                                 rc = be->be_search (be, conn, op,
 372                                         &be->be_suffix[0], &be->be_nsuffix[0],
 373                                         scope, deref,
 374                                         s2limit, t2limit, filter, filterstr,
 375                                         attrs, attrsonly);
 376
 377                         } else if (dnIsSuffix(ndn, &be->be_nsuffix[0])) {
 378                                 rc = be->be_search (be, conn, op, dn, ndn,
 379                                         scope, deref,
 380                                         s2limit, t2limit, filter, filterstr,
 381                                         attrs, attrsonly);
 382                         }
 383                 }
 384                 break;
 385         }
 386         op->o_callback = gs.prevcb;
 387
 388         send_search_result (conn, op, gs.err, gs.matched, NULL,
 389                 gs.refs, NULL, gs.nentries);
 390
 391 done:
 392         if (gs.matched)
 393                 free (gs.matched);
 394         if (gs.refs)
 395                 ber_bvarray_free(gs.refs);
 396         return rc;
 397 }
 398
 399
 400 static int
 401 glue_tool_entry_open (
 402         BackendDB *b0,
 403         int mode
 404 )
 405 {
 406         /* We don't know which backend to talk to yet, so just
 407          * remember the mode and move on...
 408          */
 409
 410         glueMode = mode;
 411         glueBack = NULL;
 412
 413         return 0;
 414 }
 415
 416 static int
 417 glue_tool_entry_close (
 418         BackendDB *b0
 419 )
 420 {
 421         int rc = 0;
 422
 423         if (glueBack) {
 424                 if (!glueBack->be_entry_close)
 425                         return 0;
 426                 rc = glueBack->be_entry_close (glueBack);
 427         }
 428         return rc;
 429 }
 430
 431 static ID
 432 glue_tool_entry_first (
 433         BackendDB *b0
 434 )
 435 {
 436         glueinfo *gi = (glueinfo *) b0->bd_info;
 437         int i;
 438
 439         /* If we're starting from scratch, start at the most general */
 440         if (!glueBack) {
 441                 for (i = gi->nodes-1; i >= 0; i--) {
 442                         if (gi->n[i].be->be_entry_open &&
 443                             gi->n[i].be->be_entry_first) {
 444                                 glueBack = gi->n[i].be;
 445                                 break;
 446                         }
 447                 }
 448
 449         }
 450         if (!glueBack || glueBack->be_entry_open (glueBack, glueMode) != 0)
 451                 return NOID;
 452
 453         return glueBack->be_entry_first (glueBack);
 454 }
 455
 456 static ID
 457 glue_tool_entry_next (
 458         BackendDB *b0
 459 )
 460 {
 461         glueinfo *gi = (glueinfo *) b0->bd_info;
 462         int i;
 463         ID rc;
 464
 465         if (!glueBack || !glueBack->be_entry_next)
 466                 return NOID;
 467
 468         rc = glueBack->be_entry_next (glueBack);
 469
 470         /* If we ran out of entries in one database, move on to the next */
 471         if (rc == NOID) {
 472                 glueBack->be_entry_close (glueBack);
 473                 for (i=0; i<gi->nodes; i++) {
 474                         if (gi->n[i].be == glueBack)
 475                                 break;
 476                 }
 477                 if (i == 0) {
 478                         glueBack = NULL;
 479                         rc = NOID;
 480                 } else {
 481                         glueBack = gi->n[i-1].be;
 482                         rc = glue_tool_entry_first (b0);
 483                 }
 484         }
 485         return rc;
 486 }
 487
 488 static Entry *
 489 glue_tool_entry_get (
 490         BackendDB *b0,
 491         ID id
 492 )
 493 {
 494         if (!glueBack || !glueBack->be_entry_get)
 495                 return NULL;
 496
 497         return glueBack->be_entry_get (glueBack, id);
 498 }
 499
 500 static ID
 501 glue_tool_entry_put (
 502         BackendDB *b0,
 503         Entry *e,
 504         struct berval *text
 505 )
 506 {
 507         BackendDB *be;
 508         int rc;
 509
 510         be = glue_back_select (b0, e->e_ndn);
 511         if (!be->be_entry_put)
 512                 return NOID;
 513
 514         if (!glueBack) {
 515                 rc = be->be_entry_open (be, glueMode);
 516                 if (rc != 0)
 517                         return NOID;
 518         } else if (be != glueBack) {
 519                 /* If this entry belongs in a different branch than the
 520                  * previous one, close the current database and open the
 521                  * new one.
 522                  */
 523                 glueBack->be_entry_close (glueBack);
 524                 rc = be->be_entry_open (be, glueMode);
 525                 if (rc != 0)
 526                         return NOID;
 527         }
 528         glueBack = be;
 529         return be->be_entry_put (be, e, text);
 530 }
 531
 532 static int
 533 glue_tool_entry_reindex (
 534         BackendDB *b0,
 535         ID id
 536 )
 537 {
 538         if (!glueBack || !glueBack->be_entry_reindex)
 539                 return -1;
 540
 541         return glueBack->be_entry_reindex (glueBack, id);
 542 }
 543
 544 static int
 545 glue_tool_sync (
 546         BackendDB *b0
 547 )
 548 {
 549         glueinfo *gi = (glueinfo *) b0->bd_info;
 550         int i;
 551
 552         /* just sync everyone */
 553         for (i = 0; i<gi->nodes; i++)
 554                 if (gi->n[i].be->be_sync)
 555                         gi->n[i].be->be_sync (gi->n[i].be);
 556         return 0;
 557 }
 558
 559 int
 560 glue_sub_init( )
 561 {
 562         int i, j;
 563         int cont = num_subordinates;
 564         BackendDB *b1, *be;
 565         BackendInfo *bi = NULL;
 566         glueinfo *gi;
 567
 568         /* While there are subordinate backends, search backwards through the
 569          * backends and connect them to their superior.
 570          */
 571         for (i = nBackendDB - 1, b1=&backendDB[i]; cont && i>=0; b1--,i--) {
 572                 if (b1->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE) {
 573                         /* The last database cannot be a subordinate of noone */
 574                         if (i == nBackendDB - 1) {
 575                                 b1->be_flags ^= SLAP_BFLAG_GLUE_SUBORDINATE;
 576                         }
 577                         continue;
 578                 }
 579                 gi = NULL;
 580                 for (j = i-1, be=&backendDB[j]; j>=0; be--,j--) {
 581                         if (!(be->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE)) {
 582                                 continue;
 583                         }
 584                         /* We will only link it once */
 585                         if (be->be_flags & SLAP_BFLAG_GLUE_LINKED) {
 586                                 continue;
 587                         }
 588                         if (!dnIsSuffix(&be->be_nsuffix[0], &b1->be_nsuffix[0])) {
 589                                 continue;
 590                         }
 591                         cont--;
 592                         be->be_flags |= SLAP_BFLAG_GLUE_LINKED;
 593                         if (gi == NULL) {
 594                                 /* We create a copy of the superior's be
 595                                  * structure, pointing to all of its original
 596                                  * information. Then we replace elements of
 597                                  * the superior's info with our own. The copy
 598                                  * is used whenever we have operations to pass
 599                                  * down to the real database.
 600                                  */
 601                                 b1->be_flags |= SLAP_BFLAG_GLUE_INSTANCE;
 602                                 gi = (glueinfo *)ch_malloc(sizeof(glueinfo));
 603                                 gi->nodes = 0;
 604                                 gi->bd = *b1;
 605                                 gi->bi = *b1->bd_info;
 606                                 bi = (BackendInfo *)gi;
 607                                 bi->bi_open = glue_back_open;
 608                                 bi->bi_close = glue_back_close;
 609                                 bi->bi_db_open = glue_back_db_open;
 610                                 bi->bi_db_close = glue_back_db_close;
 611                                 bi->bi_db_destroy = glue_back_db_destroy;
 612
 613                                 bi->bi_op_search = glue_back_search;
 614
 615                                 /*
 616                                  * hooks for slap tools
 617                                  */
 618                                 bi->bi_tool_entry_open = glue_tool_entry_open;
 619                                 bi->bi_tool_entry_close = glue_tool_entry_close;
 620                                 bi->bi_tool_entry_first = glue_tool_entry_first;
 621                                 bi->bi_tool_entry_next = glue_tool_entry_next;
 622                                 bi->bi_tool_entry_get = glue_tool_entry_get;
 623                                 bi->bi_tool_entry_put = glue_tool_entry_put;
 624                                 bi->bi_tool_entry_reindex = glue_tool_entry_reindex;
 625                                 bi->bi_tool_sync = glue_tool_sync;
 626                         } else {
 627                                 gi = (glueinfo *)ch_realloc(gi,
 628                                         sizeof(glueinfo) +
 629                                         gi->nodes * sizeof(gluenode));
 630                         }
 631                         gi->n[gi->nodes].be = be;
 632                         dnParent( &be->be_nsuffix[0], &gi->n[gi->nodes].pdn );
 633                         gi->nodes++;
 634                 }
 635                 if (gi) {
 636                         /* One more node for the master */
 637                         gi = (glueinfo *)ch_realloc(gi,
 638                                 sizeof(glueinfo) + gi->nodes * sizeof(gluenode));
 639                         gi->n[gi->nodes].be = &gi->bd;
 640                         dnParent( &b1->be_nsuffix[0], &gi->n[gi->nodes].pdn );
 641                         gi->nodes++;
 642                         b1->bd_info = bi;
 643                 }
 644         }
 645         /* If there are any unresolved subordinates left, something is wrong */
 646         return cont;
 647 }