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         LDAP_UNWILLING_TO_PERFORM,      /* compare */
 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         LDAP_SUCCESS                    /* aux_chk_controls */
 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         op->o_bd = be;
 300         op->o_callback = cb.sc_next;
 301         return rc;
 302 }
 303
 304 static int
 305 over_op_bind( Operation *op, SlapReply *rs )
 306 {
 307         return over_op_func( op, rs, op_bind );
 308 }
 309
 310 static int
 311 over_op_unbind( Operation *op, SlapReply *rs )
 312 {
 313         return over_op_func( op, rs, op_unbind );
 314 }
 315
 316 static int
 317 over_op_search( Operation *op, SlapReply *rs )
 318 {
 319         return over_op_func( op, rs, op_search );
 320 }
 321
 322 static int
 323 over_op_compare( Operation *op, SlapReply *rs )
 324 {
 325         return over_op_func( op, rs, op_compare );
 326 }
 327
 328 static int
 329 over_op_modify( Operation *op, SlapReply *rs )
 330 {
 331         return over_op_func( op, rs, op_modify );
 332 }
 333
 334 static int
 335 over_op_modrdn( Operation *op, SlapReply *rs )
 336 {
 337         return over_op_func( op, rs, op_modrdn );
 338 }
 339
 340 static int
 341 over_op_add( Operation *op, SlapReply *rs )
 342 {
 343         return over_op_func( op, rs, op_add );
 344 }
 345
 346 static int
 347 over_op_delete( Operation *op, SlapReply *rs )
 348 {
 349         return over_op_func( op, rs, op_delete );
 350 }
 351
 352 static int
 353 over_op_abandon( Operation *op, SlapReply *rs )
 354 {
 355         return over_op_func( op, rs, op_abandon );
 356 }
 357
 358 static int
 359 over_op_cancel( Operation *op, SlapReply *rs )
 360 {
 361         return over_op_func( op, rs, op_cancel );
 362 }
 363
 364 static int
 365 over_op_extended( Operation *op, SlapReply *rs )
 366 {
 367         return over_op_func( op, rs, op_extended );
 368 }
 369
 370 static int
 371 over_aux_operational( Operation *op, SlapReply *rs )
 372 {
 373         return over_op_func( op, rs, op_aux_operational );
 374 }
 375
 376 static int
 377 over_aux_chk_referrals( Operation *op, SlapReply *rs )
 378 {
 379         return over_op_func( op, rs, op_aux_chk_referrals );
 380 }
 381
 382 static int
 383 over_aux_chk_controls( Operation *op, SlapReply *rs )
 384 {
 385         return over_op_func( op, rs, op_aux_chk_controls );
 386 }
 387
 388 int
 389 overlay_register(
 390         slap_overinst *on
 391 )
 392 {
 393         on->on_next = overlays;
 394         overlays = on;
 395         return 0;
 396 }
 397
 398 /*
 399  * iterator on registered overlays; overlay_next( NULL ) returns the first
 400  * overlay; * subsequent calls with the previously returned value allow to
 401  * iterate * over the entire list; returns NULL when no more overlays are
 402  * registered.
 403  */
 404
 405 slap_overinst *
 406 overlay_next(
 407         slap_overinst *on
 408 )
 409 {
 410         if ( on == NULL ) {
 411                 return overlays;
 412         }
 413
 414         return on->on_next;
 415 }
 416
 417 /*
 418  * returns a specific registered overlay based on the type; NULL if not
 419  * registered.
 420  */
 421
 422 slap_overinst *
 423 overlay_find( const char *over_type )
 424 {
 425         slap_overinst *on = overlays;
 426
 427         assert( over_type );
 428
 429         for ( ; on; on = on->on_next ) {
 430                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
 431                         break;
 432                 }
 433         }
 434
 435         return on;
 436 }
 437
 438 static const char overtype[] = "over";
 439
 440 /*
 441  * returns TRUE (1) if the database is actually an overlay instance;
 442  * FALSE (0) otherwise.
 443  */
 444
 445 int
 446 overlay_is_over( BackendDB *be )
 447 {
 448         return be->bd_info->bi_type == overtype;
 449 }
 450
 451 /*
 452  * returns TRUE (1) if the given database is actually an overlay
 453  * instance and, somewhere in the list, contains the requested overlay;
 454  * FALSE (0) otherwise.
 455  */
 456
 457 int
 458 overlay_is_inst( BackendDB *be, const char *over_type )
 459 {
 460         slap_overinst   *on;
 461
 462         assert( be );
 463
 464         if ( !overlay_is_over( be ) ) {
 465                 return 0;
 466         }
 467
 468         on = ((slap_overinfo *)be->bd_info->bi_private)->oi_list;
 469         for ( ; on; on = on->on_next ) {
 470                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
 471                         return 1;
 472                 }
 473         }
 474
 475         return 0;
 476 }
 477
 478 int
 479 overlay_register_control( BackendDB *be, const char *oid )
 480 {
 481         int             rc = 0;
 482         int             gotit = 0;
 483         int             cid;
 484
 485         if ( slap_find_control_id( oid, &cid ) == LDAP_CONTROL_NOT_FOUND ) {
 486                 return -1;
 487         }
 488
 489         if ( SLAP_DBFLAGS( be ) & SLAP_DBFLAG_GLOBAL_OVERLAY ) {
 490                 int     i;
 491
 492                 /* add to all backends... */
 493                 for ( i = 0; i < nBackendDB; i++ ) {
 494                         BackendDB       *bd = &backendDB[i];
 495
 496                         if ( be == bd ) {
 497                                 gotit = 1;
 498                         }
 499
 500                         bd->be_ctrls[ cid ] = 1;
 501                 }
 502
 503         }
 504
 505         if ( rc == 0 && !gotit ) {
 506                 be->be_ctrls[ cid ] = 1;
 507         }
 508
 509         return rc;
 510 }
 511
 512 /* add an overlay to a particular backend. */
 513 int
 514 overlay_config( BackendDB *be, const char *ov )
 515 {
 516         slap_overinst *on = NULL, *on2 = NULL;
 517         slap_overinfo *oi = NULL;
 518         BackendInfo *bi = NULL;
 519
 520         on = overlay_find( ov );
 521         if ( !on ) {
 522                 Debug( LDAP_DEBUG_ANY, "overlay \"%s\" not found\n", ov, 0, 0 );
 523                 return 1;
 524         }
 525
 526         /* If this is the first overlay on this backend, set up the
 527          * overlay info structure
 528          */
 529         if ( !overlay_is_over( be ) ) {
 530                 oi = ch_malloc( sizeof( slap_overinfo ) );
 531                 oi->oi_orig = be->bd_info;
 532                 oi->oi_bi = *be->bd_info;
 533
 534                 /* NOTE: the first time a global overlay is configured,
 535                  * frontendDB gets this flag; it is used later by overlays
 536                  * to determine if they're stacked on top of the frontendDB */
 537                 if ( oi->oi_orig == frontendDB->bd_info ) {
 538                         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLOBAL_OVERLAY;
 539                 }
 540
 541                 /* Save a pointer to ourself in bi_private.
 542                  */
 543                 oi->oi_bi.bi_private = oi;
 544                 oi->oi_list = NULL;
 545                 bi = (BackendInfo *)oi;
 546
 547                 bi->bi_type = (char *)overtype;
 548
 549                 bi->bi_db_config = over_db_config;
 550                 bi->bi_db_open = over_db_open;
 551                 bi->bi_db_close = over_db_close;
 552                 bi->bi_db_destroy = over_db_destroy;
 553
 554                 bi->bi_op_bind = over_op_bind;
 555                 bi->bi_op_unbind = over_op_unbind;
 556                 bi->bi_op_search = over_op_search;
 557                 bi->bi_op_compare = over_op_compare;
 558                 bi->bi_op_modify = over_op_modify;
 559                 bi->bi_op_modrdn = over_op_modrdn;
 560                 bi->bi_op_add = over_op_add;
 561                 bi->bi_op_delete = over_op_delete;
 562                 bi->bi_op_abandon = over_op_abandon;
 563                 bi->bi_op_cancel = over_op_cancel;
 564
 565                 bi->bi_extended = over_op_extended;
 566
 567                 /*
 568                  * this is fine because it has the same
 569                  * args of the operations; we need to rework
 570                  * all the hooks to share the same args
 571                  * of the operations...
 572                  */
 573                 bi->bi_operational = over_aux_operational;
 574                 bi->bi_chk_referrals = over_aux_chk_referrals;
 575                 bi->bi_chk_controls = over_aux_chk_controls;
 576
 577                 be->bd_info = bi;
 578
 579         } else {
 580                 if ( overlay_is_inst( be, ov ) ) {
 581                         Debug( LDAP_DEBUG_ANY, "overlay_config(): "
 582                                         "warning, overlay \"%s\" "
 583                                         "already in list\n", ov, 0, 0 );
 584                 }
 585
 586                 oi = be->bd_info->bi_private;
 587         }
 588
 589         /* Insert new overlay on head of list. Overlays are executed
 590          * in reverse of config order...
 591          */
 592         on2 = ch_calloc( 1, sizeof(slap_overinst) );
 593         *on2 = *on;
 594         on2->on_info = oi;
 595         on2->on_next = oi->oi_list;
 596         oi->oi_list = on2;
 597
 598         /* Any initialization needed? */
 599         if ( on->on_bi.bi_db_init ) {
 600                 be->bd_info = (BackendInfo *)on2;
 601                 on2->on_bi.bi_db_init( be );
 602                 be->bd_info = (BackendInfo *)oi;
 603         }
 604
 605         return 0;
 606 }
 607