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

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