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
 142         if (gi->bd.bd_info->bi_db_open)
 143                 rc = gi->bd.bd_info->bi_db_open(&gi->bd);
 144
 145         return rc;
 146 }
 147
 148 static int
 149 glue_back_db_close (
 150         BackendDB *be
 151 )
 152 {
 153         glueinfo *gi = (glueinfo *) be->bd_info;
 154         static int glueClosed = 0;
 155
 156         if (glueClosed) return 0;
 157
 158         glueClosed = 1;
 159
 160         /* Close the master */
 161         if (gi->bd.bd_info->bi_db_close)
 162                 gi->bd.bd_info->bi_db_close( &gi->bd );
 163
 164         return 0;
 165 }
 166
 167 static int
 168 glue_back_db_destroy (
 169         BackendDB *be
 170 )
 171 {
 172         glueinfo *gi = (glueinfo *) be->bd_info;
 173
 174         if (gi->bd.bd_info->bi_db_destroy)
 175                 gi->bd.bd_info->bi_db_destroy( &gi->bd );
 176         free (gi);
 177         return 0;
 178 }
 179
 180 typedef struct glue_state {
 181         int err;
 182         int slimit;
 183         int matchlen;
 184         char *matched;
 185         int nrefs;
 186         BerVarray refs;
 187 } glue_state;
 188
 189 static int
 190 glue_back_response ( Operation *op, SlapReply *rs )
 191 {
 192         glue_state *gs = op->o_callback->sc_private;
 193
 194         switch(rs->sr_type) {
 195         case REP_SEARCH:
 196                 if ( gs->slimit && rs->sr_nentries >= gs->slimit ) {
 197                         rs->sr_err = gs->err = LDAP_SIZELIMIT_EXCEEDED;
 198                         return -1;
 199                 }
 200                 /* fallthru */
 201         case REP_SEARCHREF:
 202                 return SLAP_CB_CONTINUE;
 203
 204         default:
 205                 if (rs->sr_err == LDAP_SUCCESS ||
 206                         rs->sr_err == LDAP_SIZELIMIT_EXCEEDED ||
 207                         rs->sr_err == LDAP_TIMELIMIT_EXCEEDED ||
 208                         rs->sr_err == LDAP_ADMINLIMIT_EXCEEDED ||
 209                                 gs->err != LDAP_SUCCESS)
 210                         gs->err = rs->sr_err;
 211                 if (gs->err == LDAP_SUCCESS && gs->matched) {
 212                         ch_free (gs->matched);
 213                         gs->matched = NULL;
 214                         gs->matchlen = 0;
 215                 }
 216                 if (gs->err != LDAP_SUCCESS && rs->sr_matched) {
 217                         int len;
 218                         len = strlen (rs->sr_matched);
 219                         if (len > gs->matchlen) {
 220                                 if (gs->matched)
 221                                         ch_free (gs->matched);
 222                                 gs->matched = ch_strdup (rs->sr_matched);
 223                                 gs->matchlen = len;
 224                         }
 225                 }
 226                 if (rs->sr_ref) {
 227                         int i, j, k;
 228                         BerVarray new;
 229
 230                         for (i=0; rs->sr_ref[i].bv_val; i++);
 231
 232                         j = gs->nrefs;
 233                         if (!j) {
 234                                 new = ch_malloc ((i+1)*sizeof(struct berval));
 235                         } else {
 236                                 new = ch_realloc(gs->refs,
 237                                         (j+i+1)*sizeof(struct berval));
 238                         }
 239                         for (k=0; k<i; j++,k++) {
 240                                 ber_dupbv( &new[j], &rs->sr_ref[k] );
 241                         }
 242                         new[j].bv_val = NULL;
 243                         gs->nrefs = j;
 244                         gs->refs = new;
 245                 }
 246         }
 247         return 0;
 248 }
 249
 250 static int
 251 glue_back_search ( Operation *op, SlapReply *rs )
 252 {
 253         BackendDB *b0 = op->o_bd;
 254         glueinfo *gi = (glueinfo *) b0->bd_info;
 255         int i;
 256         long stoptime = 0;
 257         glue_state gs = {0, 0, 0, NULL, 0, NULL};
 258         slap_callback cb = { NULL, glue_back_response, NULL, NULL };
 259         int scope0, slimit0, tlimit0;
 260         struct berval dn, ndn;
 261
 262         cb.sc_private = &gs;
 263
 264         cb.sc_next = op->o_callback;
 265
 266         if (op->ors_tlimit) {
 267                 stoptime = slap_get_time () + op->ors_tlimit;
 268         }
 269
 270         switch (op->ors_scope) {
 271         case LDAP_SCOPE_BASE:
 272                 op->o_bd = glue_back_select (b0, op->o_req_ndn.bv_val);
 273
 274                 if (op->o_bd && op->o_bd->be_search) {
 275                         rs->sr_err = op->o_bd->be_search( op, rs );
 276                 } else {
 277                         send_ldap_error(op, rs, LDAP_UNWILLING_TO_PERFORM,
 278                                       "No search target found");
 279                 }
 280                 return rs->sr_err;
 281
 282         case LDAP_SCOPE_ONELEVEL:
 283         case LDAP_SCOPE_SUBTREE:
 284 #ifdef LDAP_SCOPE_SUBORDINATE
 285         case LDAP_SCOPE_SUBORDINATE: /* FIXME */
 286 #endif
 287                 op->o_callback = &cb;
 288                 rs->sr_err = gs.err = LDAP_UNWILLING_TO_PERFORM;
 289                 scope0 = op->ors_scope;
 290                 slimit0 = gs.slimit = op->ors_slimit;
 291                 tlimit0 = op->ors_tlimit;
 292                 dn = op->o_req_dn;
 293                 ndn = op->o_req_ndn;
 294
 295                 /*
 296                  * Execute in reverse order, most general first
 297                  */
 298                 for (i = gi->nodes-1; i >= 0; i--) {
 299                         if (!gi->n[i].be || !gi->n[i].be->be_search)
 300                                 continue;
 301                         if (tlimit0) {
 302                                 op->ors_tlimit = stoptime - slap_get_time ();
 303                                 if (op->ors_tlimit <= 0) {
 304                                         rs->sr_err = gs.err = LDAP_TIMELIMIT_EXCEEDED;
 305                                         break;
 306                                 }
 307                         }
 308                         if (slimit0) {
 309                                 op->ors_slimit = slimit0 - rs->sr_nentries;
 310                                 if (op->ors_slimit < 0) {
 311                                         rs->sr_err = gs.err = LDAP_SIZELIMIT_EXCEEDED;
 312                                         break;
 313                                 }
 314                         }
 315                         rs->sr_err = 0;
 316                         /*
 317                          * check for abandon
 318                          */
 319                         if (op->o_abandon) {
 320                                 goto end_of_loop;
 321                         }
 322                         op->o_bd = gi->n[i].be;
 323
 324                         assert( op->o_bd->be_suffix );
 325                         assert( op->o_bd->be_nsuffix );
 326
 327                         if (scope0 == LDAP_SCOPE_ONELEVEL &&
 328                                 dn_match(&gi->n[i].pdn, &ndn))
 329                         {
 330                                 op->ors_scope = LDAP_SCOPE_BASE;
 331                                 op->o_req_dn = op->o_bd->be_suffix[0];
 332                                 op->o_req_ndn = op->o_bd->be_nsuffix[0];
 333                                 rs->sr_err = op->o_bd->be_search(op, rs);
 334
 335                         } else if (scope0 == LDAP_SCOPE_SUBTREE &&
 336                                 dnIsSuffix(&op->o_bd->be_nsuffix[0], &ndn))
 337                         {
 338                                 op->o_req_dn = op->o_bd->be_suffix[0];
 339                                 op->o_req_ndn = op->o_bd->be_nsuffix[0];
 340                                 rs->sr_err = op->o_bd->be_search( op, rs );
 341
 342                         } else if (dnIsSuffix(&ndn, &op->o_bd->be_nsuffix[0])) {
 343                                 rs->sr_err = op->o_bd->be_search( op, rs );
 344                         }
 345
 346                         switch ( gs.err ) {
 347
 348                         /*
 349                          * Add errors that should result in dropping
 350                          * the search
 351                          */
 352                         case LDAP_SIZELIMIT_EXCEEDED:
 353                         case LDAP_TIMELIMIT_EXCEEDED:
 354                         case LDAP_ADMINLIMIT_EXCEEDED:
 355                                 goto end_of_loop;
 356
 357                         default:
 358                                 break;
 359                         }
 360                 }
 361 end_of_loop:;
 362                 op->ors_scope = scope0;
 363                 op->ors_slimit = slimit0;
 364                 op->ors_tlimit = tlimit0;
 365                 op->o_req_dn = dn;
 366                 op->o_req_ndn = ndn;
 367
 368                 break;
 369         }
 370         if ( !op->o_abandon ) {
 371                 op->o_callback = cb.sc_next;
 372                 rs->sr_err = gs.err;
 373                 rs->sr_matched = gs.matched;
 374                 rs->sr_ref = gs.refs;
 375
 376                 send_ldap_result( op, rs );
 377         }
 378
 379         op->o_bd = b0;
 380         if (gs.matched)
 381                 free (gs.matched);
 382         if (gs.refs)
 383                 ber_bvarray_free(gs.refs);
 384         return rs->sr_err;
 385 }
 386
 387
 388 static int
 389 glue_tool_entry_open (
 390         BackendDB *b0,
 391         int mode
 392 )
 393 {
 394         /* We don't know which backend to talk to yet, so just
 395          * remember the mode and move on...
 396          */
 397
 398         glueMode = mode;
 399         glueBack = NULL;
 400
 401         return 0;
 402 }
 403
 404 static int
 405 glue_tool_entry_close (
 406         BackendDB *b0
 407 )
 408 {
 409         int rc = 0;
 410
 411         if (glueBack) {
 412                 if (!glueBack->be_entry_close)
 413                         return 0;
 414                 rc = glueBack->be_entry_close (glueBack);
 415         }
 416         return rc;
 417 }
 418
 419 static ID
 420 glue_tool_entry_first (
 421         BackendDB *b0
 422 )
 423 {
 424         glueinfo *gi = (glueinfo *) b0->bd_info;
 425         int i;
 426
 427         /* If we're starting from scratch, start at the most general */
 428         if (!glueBack) {
 429                 for (i = gi->nodes-1; i >= 0; i--) {
 430                         if (gi->n[i].be->be_entry_open &&
 431                             gi->n[i].be->be_entry_first) {
 432                                 glueBack = gi->n[i].be;
 433                                 break;
 434                         }
 435                 }
 436
 437         }
 438         if (!glueBack || !glueBack->be_entry_open || !glueBack->be_entry_first ||
 439                 glueBack->be_entry_open (glueBack, glueMode) != 0)
 440                 return NOID;
 441
 442         return glueBack->be_entry_first (glueBack);
 443 }
 444
 445 static ID
 446 glue_tool_entry_next (
 447         BackendDB *b0
 448 )
 449 {
 450         glueinfo *gi = (glueinfo *) b0->bd_info;
 451         int i;
 452         ID rc;
 453
 454         if (!glueBack || !glueBack->be_entry_next)
 455                 return NOID;
 456
 457         rc = glueBack->be_entry_next (glueBack);
 458
 459         /* If we ran out of entries in one database, move on to the next */
 460         while (rc == NOID) {
 461                 if ( glueBack && glueBack->be_entry_close )
 462                         glueBack->be_entry_close (glueBack);
 463                 for (i=0; i<gi->nodes; i++) {
 464                         if (gi->n[i].be == glueBack)
 465                                 break;
 466                 }
 467                 if (i == 0) {
 468                         glueBack = NULL;
 469                         break;
 470                 } else {
 471                         glueBack = gi->n[i-1].be;
 472                         rc = glue_tool_entry_first (b0);
 473                 }
 474         }
 475         return rc;
 476 }
 477
 478 static Entry *
 479 glue_tool_entry_get (
 480         BackendDB *b0,
 481         ID id
 482 )
 483 {
 484         if (!glueBack || !glueBack->be_entry_get)
 485                 return NULL;
 486
 487         return glueBack->be_entry_get (glueBack, id);
 488 }
 489
 490 static ID
 491 glue_tool_entry_put (
 492         BackendDB *b0,
 493         Entry *e,
 494         struct berval *text
 495 )
 496 {
 497         BackendDB *be;
 498         int rc;
 499
 500         be = glue_back_select (b0, e->e_ndn);
 501         if (!be->be_entry_put)
 502                 return NOID;
 503
 504         if (!glueBack) {
 505                 rc = be->be_entry_open (be, glueMode);
 506                 if (rc != 0)
 507                         return NOID;
 508         } else if (be != glueBack) {
 509                 /* If this entry belongs in a different branch than the
 510                  * previous one, close the current database and open the
 511                  * new one.
 512                  */
 513                 glueBack->be_entry_close (glueBack);
 514                 rc = be->be_entry_open (be, glueMode);
 515                 if (rc != 0)
 516                         return NOID;
 517         }
 518         glueBack = be;
 519         return be->be_entry_put (be, e, text);
 520 }
 521
 522 static int
 523 glue_tool_entry_reindex (
 524         BackendDB *b0,
 525         ID id
 526 )
 527 {
 528         if (!glueBack || !glueBack->be_entry_reindex)
 529                 return -1;
 530
 531         return glueBack->be_entry_reindex (glueBack, id);
 532 }
 533
 534 static int
 535 glue_tool_sync (
 536         BackendDB *b0
 537 )
 538 {
 539         glueinfo *gi = (glueinfo *) b0->bd_info;
 540         int i;
 541
 542         /* just sync everyone */
 543         for (i = 0; i<gi->nodes; i++)
 544                 if (gi->n[i].be->be_sync)
 545                         gi->n[i].be->be_sync (gi->n[i].be);
 546         return 0;
 547 }
 548
 549 int
 550 glue_sub_init( )
 551 {
 552         int i, j;
 553         int cont = num_subordinates;
 554         BackendDB *b1, *be;
 555         BackendInfo *bi = NULL;
 556         glueinfo *gi;
 557
 558         /* While there are subordinate backends, search backwards through the
 559          * backends and connect them to their superior.
 560          */
 561         for (i = nBackendDB - 1, b1=&backendDB[i]; cont && i>=0; b1--,i--) {
 562                 if (SLAP_GLUE_SUBORDINATE ( b1 ) ) {
 563                         /* The last database cannot be a subordinate of noone */
 564                         if (i == nBackendDB - 1) {
 565                                 SLAP_DBFLAGS(b1) ^= SLAP_DBFLAG_GLUE_SUBORDINATE;
 566                         }
 567                         continue;
 568                 }
 569                 gi = NULL;
 570                 for (j = i-1, be=&backendDB[j]; j>=0; be--,j--) {
 571                         if ( ! SLAP_GLUE_SUBORDINATE( be ) ) {
 572                                 continue;
 573                         }
 574                         /* We will only link it once */
 575                         if ( SLAP_GLUE_LINKED( be ) ) {
 576                                 continue;
 577                         }
 578                         assert( be->be_nsuffix );
 579                         assert( b1->be_nsuffix );
 580                         if (!dnIsSuffix(&be->be_nsuffix[0], &b1->be_nsuffix[0])) {
 581                                 continue;
 582                         }
 583                         cont--;
 584                         SLAP_DBFLAGS(be) |= SLAP_DBFLAG_GLUE_LINKED;
 585                         if (gi == NULL) {
 586                                 /* We create a copy of the superior's be
 587                                  * structure, pointing to all of its original
 588                                  * information. Then we replace elements of
 589                                  * the superior's info with our own. The copy
 590                                  * is used whenever we have operations to pass
 591                                  * down to the real database.
 592                                  */
 593                                 SLAP_DBFLAGS(b1) |= SLAP_DBFLAG_GLUE_INSTANCE;
 594                                 gi = (glueinfo *)ch_malloc(sizeof(glueinfo));
 595                                 gi->nodes = 0;
 596                                 gi->bd = *b1;
 597                                 gi->bi = *b1->bd_info;
 598                                 bi = (BackendInfo *)gi;
 599                                 bi->bi_open = glue_back_open;
 600                                 bi->bi_close = glue_back_close;
 601                                 bi->bi_db_open = glue_back_db_open;
 602                                 bi->bi_db_close = glue_back_db_close;
 603                                 bi->bi_db_destroy = glue_back_db_destroy;
 604
 605                                 bi->bi_op_search = glue_back_search;
 606
 607                                 /*
 608                                  * hooks for slap tools
 609                                  */
 610                                 bi->bi_tool_entry_open = glue_tool_entry_open;
 611                                 bi->bi_tool_entry_close = glue_tool_entry_close;
 612                                 bi->bi_tool_entry_first = glue_tool_entry_first;
 613                                 bi->bi_tool_entry_next = glue_tool_entry_next;
 614                                 bi->bi_tool_entry_get = glue_tool_entry_get;
 615                                 bi->bi_tool_entry_put = glue_tool_entry_put;
 616                                 bi->bi_tool_entry_reindex = glue_tool_entry_reindex;
 617                                 bi->bi_tool_sync = glue_tool_sync;
 618                                 /* FIXME : will support later */
 619                                 bi->bi_tool_dn2id_get = 0;
 620                                 bi->bi_tool_id2entry_get = 0;
 621                                 bi->bi_tool_entry_modify = 0;
 622                         } else {
 623                                 gi = (glueinfo *)ch_realloc(gi,
 624                                         sizeof(glueinfo) +
 625                                         gi->nodes * sizeof(gluenode));
 626                         }
 627                         gi->n[gi->nodes].be = be;
 628                         dnParent( &be->be_nsuffix[0], &gi->n[gi->nodes].pdn );
 629                         gi->nodes++;
 630                 }
 631                 if (gi) {
 632                         /* One more node for the master */
 633                         gi = (glueinfo *)ch_realloc(gi,
 634                                 sizeof(glueinfo) + gi->nodes * sizeof(gluenode));
 635                         gi->n[gi->nodes].be = &gi->bd;
 636                         dnParent( &b1->be_nsuffix[0], &gi->n[gi->nodes].pdn );
 637                         gi->nodes++;
 638                         b1->bd_info = (BackendInfo *)gi;
 639                 }
 640         }
 641         /* If there are any unresolved subordinates left, something is wrong */
 642         return cont;
 643 }