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

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