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

   1 /* backover.c - backend overlay routines */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2003-2005 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 /* Functions to overlay other modules over a backend. */
  18
  19 #include "portable.h"
  20
  21 #include <stdio.h>
  22
  23 #include <ac/string.h>
  24 #include <ac/socket.h>
  25
  26 #define SLAPD_TOOLS
  27 #include "slap.h"
  28
  29 static slap_overinst *overlays;
  30
  31 enum db_which { db_open = 0, db_close, db_destroy };
  32
  33 static int
  34 over_db_func(
  35         BackendDB *be,
  36         enum db_which which
  37 )
  38 {
  39         slap_overinfo *oi = be->bd_info->bi_private;
  40         slap_overinst *on = oi->oi_list;
  41         BackendInfo *bi_orig = be->bd_info;
  42         BI_db_open **func;
  43         int rc = 0;
  44
  45         func = &oi->oi_orig->bi_db_open;
  46         if ( func[which] ) {
  47                 be->bd_info = oi->oi_orig;
  48                 rc = func[which]( be );
  49         }
  50
  51         for (; on && rc == 0; on=on->on_next) {
  52                 be->bd_info = &on->on_bi;
  53                 func = &on->on_bi.bi_db_open;
  54                 if (func[which]) {
  55                         rc = func[which]( be );
  56                 }
  57         }
  58         be->bd_info = bi_orig;
  59         return rc;
  60 }
  61
  62 static int
  63 over_db_config(
  64         BackendDB *be,
  65         const char *fname,
  66         int lineno,
  67         int argc,
  68         char **argv
  69 )
  70 {
  71         slap_overinfo *oi = be->bd_info->bi_private;
  72         slap_overinst *on = oi->oi_list;
  73         BackendInfo *bi_orig = be->bd_info;
  74         int rc = 0;
  75
  76         if ( oi->oi_orig->bi_db_config ) {
  77                 be->bd_info = oi->oi_orig;
  78                 rc = oi->oi_orig->bi_db_config( be, fname, lineno,
  79                         argc, argv );
  80
  81                 if ( be->bd_info != oi->oi_orig ) {
  82                         slap_overinfo   *oi2;
  83                         slap_overinst   *on2, **onp;
  84                         BackendDB       be2 = *be;
  85                         int             i;
  86
  87                         /* a database added an overlay;
  88                          * work it around... */
  89                         assert( overlay_is_over( be ) );
  90
  91                         oi2 = ( slap_overinfo * )be->bd_info->bi_private;
  92                         on2 = oi2->oi_list;
  93
  94                         /* need to put a uniqueness check here as well;
  95                          * note that in principle there could be more than
  96                          * one overlay as a result of multiple calls to
  97                          * overlay_config() */
  98                         be2.bd_info = (BackendInfo *)oi;
  99
 100                         for ( i = 0, onp = &on2; *onp; i++, onp = &(*onp)->on_next ) {
 101                                 if ( overlay_is_inst( &be2, (*onp)->on_bi.bi_type ) ) {
 102                                         Debug( LDAP_DEBUG_ANY, "over_db_config(): "
 103                                                         "warning, freshly added "
 104                                                         "overlay #%d \"%s\" is already in list\n",
 105                                                         i, (*onp)->on_bi.bi_type, 0 );
 106
 107                                         /* NOTE: if the overlay already exists,
 108                                          * there is no way to merge the results
 109                                          * of the configuration that may have
 110                                          * occurred during bi_db_config(); we
 111                                          * just issue a warning, and the
 112                                          * administrator should deal with this */
 113                                 }
 114                         }
 115                         *onp = oi->oi_list;
 116
 117                         oi->oi_list = on2;
 118
 119                         ch_free( be->bd_info );
 120                 }
 121
 122                 be->bd_info = (BackendInfo *)oi;
 123                 if ( rc != SLAP_CONF_UNKNOWN ) return rc;
 124         }
 125
 126         for (; on; on=on->on_next) {
 127                 if (on->on_bi.bi_db_config) {
 128                         be->bd_info = &on->on_bi;
 129                         rc = on->on_bi.bi_db_config( be, fname, lineno,
 130                                 argc, argv );
 131                         if ( rc != SLAP_CONF_UNKNOWN ) break;
 132                 }
 133         }
 134         be->bd_info = bi_orig;
 135         return rc;
 136 }
 137
 138 static int
 139 over_db_open(
 140         BackendDB *be
 141 )
 142 {
 143         return over_db_func( be, db_open );
 144 }
 145
 146 static int
 147 over_db_close(
 148         BackendDB *be
 149 )
 150 {
 151         slap_overinfo *oi = be->bd_info->bi_private;
 152         slap_overinst *on = oi->oi_list;
 153         BackendInfo *bi_orig = be->bd_info;
 154         int rc = 0;
 155
 156         for (; on && rc == 0; on=on->on_next) {
 157                 be->bd_info = &on->on_bi;
 158                 if ( be->bd_info->bi_db_close ) {
 159                         rc = be->bd_info->bi_db_close( be );
 160                 }
 161         }
 162
 163         if ( oi->oi_orig->bi_db_close ) {
 164                 be->bd_info = oi->oi_orig;
 165                 rc = be->bd_info->bi_db_close( be );
 166         }
 167
 168         be->bd_info = bi_orig;
 169         return rc;
 170 }
 171
 172 static int
 173 over_db_destroy(
 174         BackendDB *be
 175 )
 176 {
 177         slap_overinfo *oi = be->bd_info->bi_private;
 178         slap_overinst *on = oi->oi_list, *next;
 179         int rc;
 180
 181         rc = over_db_func( be, db_destroy );
 182
 183         for (next = on->on_next; on; on=next) {
 184                 next = on->on_next;
 185                 free( on );
 186         }
 187         free( oi );
 188         return rc;
 189 }
 190
 191 static int
 192 over_back_response ( Operation *op, SlapReply *rs )
 193 {
 194         slap_overinfo *oi = op->o_callback->sc_private;
 195         slap_overinst *on = oi->oi_list;
 196         int rc = SLAP_CB_CONTINUE;
 197         BackendDB *be = op->o_bd, db = *op->o_bd;
 198
 199         db.be_flags |= SLAP_DBFLAG_OVERLAY;
 200         op->o_bd = &db;
 201         for (; on; on=on->on_next ) {
 202                 if ( on->on_response ) {
 203                         db.bd_info = (BackendInfo *)on;
 204                         rc = on->on_response( op, rs );
 205                         if ( rc != SLAP_CB_CONTINUE ) break;
 206                 }
 207         }
 208         op->o_bd = be;
 209         return rc;
 210 }
 211
 212 enum op_which {
 213         op_bind = 0,
 214         op_unbind,
 215         op_search,
 216         op_compare,
 217         op_modify,
 218         op_modrdn,
 219         op_add,
 220         op_delete,
 221         op_abandon,
 222         op_cancel,
 223         op_extended,
 224         op_aux_operational,
 225         op_aux_chk_referrals,
 226         op_aux_chk_controls,
 227         op_last
 228 };
 229
 230 /*
 231  * default return code in case of missing backend function
 232  * and overlay stack returning SLAP_CB_CONTINUE
 233  */
 234 static int op_rc[] = {
 235         LDAP_UNWILLING_TO_PERFORM,      /* bind */
 236         LDAP_UNWILLING_TO_PERFORM,      /* unbind */
 237         LDAP_UNWILLING_TO_PERFORM,      /* search */
 238         SLAP_CB_CONTINUE,               /* compare; pass to frontend */
 239         LDAP_UNWILLING_TO_PERFORM,      /* modify */
 240         LDAP_UNWILLING_TO_PERFORM,      /* modrdn */
 241         LDAP_UNWILLING_TO_PERFORM,      /* add */
 242         LDAP_UNWILLING_TO_PERFORM,      /* delete */
 243         LDAP_UNWILLING_TO_PERFORM,      /* abandon */
 244         LDAP_UNWILLING_TO_PERFORM,      /* cancel */
 245         LDAP_UNWILLING_TO_PERFORM,      /* extended */
 246         LDAP_SUCCESS,                   /* aux_operational */
 247         LDAP_SUCCESS,                   /* aux_chk_referrals */
 248         SLAP_CB_CONTINUE                /* aux_chk_controls; pass to frontend */
 249 };
 250
 251 static int
 252 over_op_func(
 253         Operation *op,
 254         SlapReply *rs,
 255         enum op_which which
 256 )
 257 {
 258         slap_overinfo *oi;
 259         slap_overinst *on;
 260         BI_op_bind **func;
 261         BackendDB *be = op->o_bd, db;
 262         slap_callback cb = {NULL, over_back_response, NULL, NULL};
 263         int rc = SLAP_CB_CONTINUE;
 264
 265         /* FIXME: used to happen for instance during abandon
 266          * when global overlays are used... */
 267         assert( op->o_bd != NULL );
 268
 269         oi = op->o_bd->bd_info->bi_private;
 270         on = oi->oi_list;
 271
 272         if ( !SLAP_ISOVERLAY( op->o_bd )) {
 273                 db = *op->o_bd;
 274                 db.be_flags |= SLAP_DBFLAG_OVERLAY;
 275                 op->o_bd = &db;
 276         }
 277         cb.sc_next = op->o_callback;
 278         cb.sc_private = oi;
 279         op->o_callback = &cb;
 280
 281         for (; on; on=on->on_next ) {
 282                 func = &on->on_bi.bi_op_bind;
 283                 if ( func[which] ) {
 284                         op->o_bd->bd_info = (BackendInfo *)on;
 285                         rc = func[which]( op, rs );
 286                         if ( rc != SLAP_CB_CONTINUE ) break;
 287                 }
 288         }
 289
 290         func = &oi->oi_orig->bi_op_bind;
 291         if ( func[which] && rc == SLAP_CB_CONTINUE ) {
 292                 op->o_bd->bd_info = oi->oi_orig;
 293                 rc = func[which]( op, rs );
 294         }
 295         /* should not fall thru this far without anything happening... */
 296         if ( rc == SLAP_CB_CONTINUE ) {
 297                 rc = op_rc[ which ];
 298         }
 299
 300         /* The underlying backend didn't handle the request, make sure
 301          * overlay cleanup is processed.
 302          */
 303         if ( rc == LDAP_UNWILLING_TO_PERFORM ) {
 304                 slap_callback *sc_next;
 305                 for ( ; op->o_callback && op->o_callback != cb.sc_next;
 306                         op->o_callback = sc_next ) {
 307                         sc_next = op->o_callback->sc_next;
 308                         if ( op->o_callback->sc_cleanup ) {
 309                                 op->o_callback->sc_cleanup( op, rs );
 310                         }
 311                 }
 312         }
 313         op->o_bd = be;
 314         op->o_callback = cb.sc_next;
 315         return rc;
 316 }
 317
 318 static int
 319 over_op_bind( Operation *op, SlapReply *rs )
 320 {
 321         return over_op_func( op, rs, op_bind );
 322 }
 323
 324 static int
 325 over_op_unbind( Operation *op, SlapReply *rs )
 326 {
 327         return over_op_func( op, rs, op_unbind );
 328 }
 329
 330 static int
 331 over_op_search( Operation *op, SlapReply *rs )
 332 {
 333         return over_op_func( op, rs, op_search );
 334 }
 335
 336 static int
 337 over_op_compare( Operation *op, SlapReply *rs )
 338 {
 339         return over_op_func( op, rs, op_compare );
 340 }
 341
 342 static int
 343 over_op_modify( Operation *op, SlapReply *rs )
 344 {
 345         return over_op_func( op, rs, op_modify );
 346 }
 347
 348 static int
 349 over_op_modrdn( Operation *op, SlapReply *rs )
 350 {
 351         return over_op_func( op, rs, op_modrdn );
 352 }
 353
 354 static int
 355 over_op_add( Operation *op, SlapReply *rs )
 356 {
 357         return over_op_func( op, rs, op_add );
 358 }
 359
 360 static int
 361 over_op_delete( Operation *op, SlapReply *rs )
 362 {
 363         return over_op_func( op, rs, op_delete );
 364 }
 365
 366 static int
 367 over_op_abandon( Operation *op, SlapReply *rs )
 368 {
 369         return over_op_func( op, rs, op_abandon );
 370 }
 371
 372 static int
 373 over_op_cancel( Operation *op, SlapReply *rs )
 374 {
 375         return over_op_func( op, rs, op_cancel );
 376 }
 377
 378 static int
 379 over_op_extended( Operation *op, SlapReply *rs )
 380 {
 381         return over_op_func( op, rs, op_extended );
 382 }
 383
 384 static int
 385 over_aux_operational( Operation *op, SlapReply *rs )
 386 {
 387         return over_op_func( op, rs, op_aux_operational );
 388 }
 389
 390 static int
 391 over_aux_chk_referrals( Operation *op, SlapReply *rs )
 392 {
 393         return over_op_func( op, rs, op_aux_chk_referrals );
 394 }
 395
 396 static int
 397 over_aux_chk_controls( Operation *op, SlapReply *rs )
 398 {
 399         return over_op_func( op, rs, op_aux_chk_controls );
 400 }
 401
 402 static int
 403 over_connection_destroy(
 404         BackendDB       *bd,
 405         Connection      *conn
 406 )
 407 {
 408         slap_overinfo *oi;
 409         slap_overinst *on;
 410         BackendDB db;
 411         int rc = SLAP_CB_CONTINUE;
 412
 413         /* FIXME: used to happen for instance during abandon
 414          * when global overlays are used... */
 415         assert( bd != NULL );
 416
 417         oi = bd->bd_info->bi_private;
 418         on = oi->oi_list;
 419
 420         if ( !SLAP_ISOVERLAY( bd )) {
 421                 db = *bd;
 422                 db.be_flags |= SLAP_DBFLAG_OVERLAY;
 423                 bd = &db;
 424         }
 425
 426         for (; on; on=on->on_next ) {
 427                 if ( on->on_bi.bi_connection_destroy ) {
 428                         bd->bd_info = (BackendInfo *)on;
 429                         rc = on->on_bi.bi_connection_destroy( bd, conn );
 430                         if ( rc != SLAP_CB_CONTINUE ) break;
 431                 }
 432         }
 433
 434         if ( oi->oi_orig->bi_connection_destroy && rc == SLAP_CB_CONTINUE ) {
 435                 bd->bd_info = oi->oi_orig;
 436                 rc = oi->oi_orig->bi_connection_destroy( bd, conn );
 437         }
 438         /* should not fall thru this far without anything happening... */
 439         if ( rc == SLAP_CB_CONTINUE ) {
 440                 rc = LDAP_UNWILLING_TO_PERFORM;
 441         }
 442
 443         return rc;
 444 }
 445
 446 int
 447 overlay_register(
 448         slap_overinst *on
 449 )
 450 {
 451         on->on_next = overlays;
 452         overlays = on;
 453         return 0;
 454 }
 455
 456 /*
 457  * iterator on registered overlays; overlay_next( NULL ) returns the first
 458  * overlay; * subsequent calls with the previously returned value allow to
 459  * iterate * over the entire list; returns NULL when no more overlays are
 460  * registered.
 461  */
 462
 463 slap_overinst *
 464 overlay_next(
 465         slap_overinst *on
 466 )
 467 {
 468         if ( on == NULL ) {
 469                 return overlays;
 470         }
 471
 472         return on->on_next;
 473 }
 474
 475 /*
 476  * returns a specific registered overlay based on the type; NULL if not
 477  * registered.
 478  */
 479
 480 slap_overinst *
 481 overlay_find( const char *over_type )
 482 {
 483         slap_overinst *on = overlays;
 484
 485         assert( over_type );
 486
 487         for ( ; on; on = on->on_next ) {
 488                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
 489                         break;
 490                 }
 491         }
 492
 493         return on;
 494 }
 495
 496 static const char overtype[] = "over";
 497
 498 /*
 499  * returns TRUE (1) if the database is actually an overlay instance;
 500  * FALSE (0) otherwise.
 501  */
 502
 503 int
 504 overlay_is_over( BackendDB *be )
 505 {
 506         return be->bd_info->bi_type == overtype;
 507 }
 508
 509 /*
 510  * returns TRUE (1) if the given database is actually an overlay
 511  * instance and, somewhere in the list, contains the requested overlay;
 512  * FALSE (0) otherwise.
 513  */
 514
 515 int
 516 overlay_is_inst( BackendDB *be, const char *over_type )
 517 {
 518         slap_overinst   *on;
 519
 520         assert( be );
 521
 522         if ( !overlay_is_over( be ) ) {
 523                 return 0;
 524         }
 525
 526         on = ((slap_overinfo *)be->bd_info->bi_private)->oi_list;
 527         for ( ; on; on = on->on_next ) {
 528                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
 529                         return 1;
 530                 }
 531         }
 532
 533         return 0;
 534 }
 535
 536 int
 537 overlay_register_control( BackendDB *be, const char *oid )
 538 {
 539         int             rc = 0;
 540         int             gotit = 0;
 541         int             cid;
 542
 543         if ( slap_find_control_id( oid, &cid ) == LDAP_CONTROL_NOT_FOUND ) {
 544                 return -1;
 545         }
 546
 547         if ( SLAP_DBFLAGS( be ) & SLAP_DBFLAG_GLOBAL_OVERLAY ) {
 548                 int     i;
 549
 550                 /* add to all backends... */
 551                 for ( i = 0; i < nBackendDB; i++ ) {
 552                         BackendDB       *bd = &backendDB[i];
 553
 554                         if ( be == bd ) {
 555                                 gotit = 1;
 556                         }
 557
 558                         bd->be_ctrls[ cid ] = 1;
 559                         bd->be_ctrls[ SLAP_MAX_CIDS ] = 1;
 560                 }
 561
 562         }
 563
 564         if ( rc == 0 && !gotit ) {
 565                 be->be_ctrls[ cid ] = 1;
 566                 be->be_ctrls[ SLAP_MAX_CIDS ] = 1;
 567         }
 568
 569         return rc;
 570 }
 571
 572 /* add an overlay to a particular backend. */
 573 int
 574 overlay_config( BackendDB *be, const char *ov )
 575 {
 576         slap_overinst *on = NULL, *on2 = NULL;
 577         slap_overinfo *oi = NULL;
 578         BackendInfo *bi = NULL;
 579
 580         on = overlay_find( ov );
 581         if ( !on ) {
 582                 Debug( LDAP_DEBUG_ANY, "overlay \"%s\" not found\n", ov, 0, 0 );
 583                 return 1;
 584         }
 585
 586         /* If this is the first overlay on this backend, set up the
 587          * overlay info structure
 588          */
 589         if ( !overlay_is_over( be ) ) {
 590                 oi = ch_malloc( sizeof( slap_overinfo ) );
 591                 oi->oi_orig = be->bd_info;
 592                 oi->oi_bi = *be->bd_info;
 593
 594                 /* NOTE: the first time a global overlay is configured,
 595                  * frontendDB gets this flag; it is used later by overlays
 596                  * to determine if they're stacked on top of the frontendDB */
 597                 if ( oi->oi_orig == frontendDB->bd_info ) {
 598                         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLOBAL_OVERLAY;
 599                 }
 600
 601                 /* Save a pointer to ourself in bi_private.
 602                  */
 603                 oi->oi_bi.bi_private = oi;
 604                 oi->oi_list = NULL;
 605                 bi = (BackendInfo *)oi;
 606
 607                 bi->bi_type = (char *)overtype;
 608
 609                 bi->bi_db_config = over_db_config;
 610                 bi->bi_db_open = over_db_open;
 611                 bi->bi_db_close = over_db_close;
 612                 bi->bi_db_destroy = over_db_destroy;
 613
 614                 bi->bi_op_bind = over_op_bind;
 615                 bi->bi_op_unbind = over_op_unbind;
 616                 bi->bi_op_search = over_op_search;
 617                 bi->bi_op_compare = over_op_compare;
 618                 bi->bi_op_modify = over_op_modify;
 619                 bi->bi_op_modrdn = over_op_modrdn;
 620                 bi->bi_op_add = over_op_add;
 621                 bi->bi_op_delete = over_op_delete;
 622                 bi->bi_op_abandon = over_op_abandon;
 623                 bi->bi_op_cancel = over_op_cancel;
 624
 625                 bi->bi_extended = over_op_extended;
 626
 627                 /*
 628                  * this is fine because it has the same
 629                  * args of the operations; we need to rework
 630                  * all the hooks to share the same args
 631                  * of the operations...
 632                  */
 633                 bi->bi_operational = over_aux_operational;
 634                 bi->bi_chk_referrals = over_aux_chk_referrals;
 635                 bi->bi_chk_controls = over_aux_chk_controls;
 636
 637                 bi->bi_connection_destroy = over_connection_destroy;
 638
 639                 be->bd_info = bi;
 640
 641         } else {
 642                 if ( overlay_is_inst( be, ov ) ) {
 643                         Debug( LDAP_DEBUG_ANY, "overlay_config(): "
 644                                         "warning, overlay \"%s\" "
 645                                         "already in list\n", ov, 0, 0 );
 646                 }
 647
 648                 oi = be->bd_info->bi_private;
 649         }
 650
 651         /* Insert new overlay on head of list. Overlays are executed
 652          * in reverse of config order...
 653          */
 654         on2 = ch_calloc( 1, sizeof(slap_overinst) );
 655         *on2 = *on;
 656         on2->on_info = oi;
 657         on2->on_next = oi->oi_list;
 658         oi->oi_list = on2;
 659
 660         /* Any initialization needed? */
 661         if ( on->on_bi.bi_db_init ) {
 662                 be->bd_info = (BackendInfo *)on2;
 663                 on2->on_bi.bi_db_init( be );
 664                 be->bd_info = (BackendInfo *)oi;
 665         }
 666
 667         return 0;
 668 }
 669