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-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 /* 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_last
 227 };
 228
 229 /*
 230  * default return code in case of missing backend function
 231  * and overlay stack returning SLAP_CB_CONTINUE
 232  */
 233 static int op_rc[] = {
 234         LDAP_UNWILLING_TO_PERFORM,      /* bind */
 235         LDAP_UNWILLING_TO_PERFORM,      /* unbind */
 236         LDAP_UNWILLING_TO_PERFORM,      /* search */
 237         LDAP_UNWILLING_TO_PERFORM,      /* compare */
 238         LDAP_UNWILLING_TO_PERFORM,      /* modify */
 239         LDAP_UNWILLING_TO_PERFORM,      /* modrdn */
 240         LDAP_UNWILLING_TO_PERFORM,      /* add */
 241         LDAP_UNWILLING_TO_PERFORM,      /* delete */
 242         LDAP_UNWILLING_TO_PERFORM,      /* abandon */
 243         LDAP_UNWILLING_TO_PERFORM,      /* cancel */
 244         LDAP_UNWILLING_TO_PERFORM,      /* extended */
 245         LDAP_SUCCESS,                   /* aux_operational */
 246         LDAP_SUCCESS                    /* aux_chk_referrals */
 247 };
 248
 249 static int
 250 over_op_func(
 251         Operation *op,
 252         SlapReply *rs,
 253         enum op_which which
 254 )
 255 {
 256         slap_overinfo *oi;
 257         slap_overinst *on;
 258         BI_op_bind **func;
 259         BackendDB *be = op->o_bd, db;
 260         slap_callback cb = {NULL, over_back_response, NULL, NULL};
 261         int rc = SLAP_CB_CONTINUE;
 262
 263         if ( op->o_bd == NULL ) {
 264                 /* FIXME: happens for instance during abandon... */
 265                 return 0;
 266         }
 267
 268         oi = op->o_bd->bd_info->bi_private;
 269         on = oi->oi_list;
 270
 271         if ( !SLAP_ISOVERLAY( op->o_bd )) {
 272                 db = *op->o_bd;
 273                 db.be_flags |= SLAP_DBFLAG_OVERLAY;
 274                 op->o_bd = &db;
 275         }
 276         cb.sc_next = op->o_callback;
 277         cb.sc_private = oi;
 278         op->o_callback = &cb;
 279
 280         for (; on; on=on->on_next ) {
 281                 func = &on->on_bi.bi_op_bind;
 282                 if ( func[which] ) {
 283                         db.bd_info = (BackendInfo *)on;
 284                         rc = func[which]( op, rs );
 285                         if ( rc != SLAP_CB_CONTINUE ) break;
 286                 }
 287         }
 288
 289         func = &oi->oi_orig->bi_op_bind;
 290         if ( func[which] && rc == SLAP_CB_CONTINUE ) {
 291                 db.bd_info = oi->oi_orig;
 292                 rc = func[which]( op, rs );
 293         }
 294         /* should not fall thru this far without anything happening... */
 295         if ( rc == SLAP_CB_CONTINUE ) {
 296                 rc = op_rc[ which ];
 297         }
 298         op->o_bd = be;
 299         op->o_callback = cb.sc_next;
 300         return rc;
 301 }
 302
 303 static int
 304 over_op_bind( Operation *op, SlapReply *rs )
 305 {
 306         return over_op_func( op, rs, op_bind );
 307 }
 308
 309 static int
 310 over_op_unbind( Operation *op, SlapReply *rs )
 311 {
 312         return over_op_func( op, rs, op_unbind );
 313 }
 314
 315 static int
 316 over_op_search( Operation *op, SlapReply *rs )
 317 {
 318         return over_op_func( op, rs, op_search );
 319 }
 320
 321 static int
 322 over_op_compare( Operation *op, SlapReply *rs )
 323 {
 324         return over_op_func( op, rs, op_compare );
 325 }
 326
 327 static int
 328 over_op_modify( Operation *op, SlapReply *rs )
 329 {
 330         return over_op_func( op, rs, op_modify );
 331 }
 332
 333 static int
 334 over_op_modrdn( Operation *op, SlapReply *rs )
 335 {
 336         return over_op_func( op, rs, op_modrdn );
 337 }
 338
 339 static int
 340 over_op_add( Operation *op, SlapReply *rs )
 341 {
 342         return over_op_func( op, rs, op_add );
 343 }
 344
 345 static int
 346 over_op_delete( Operation *op, SlapReply *rs )
 347 {
 348         return over_op_func( op, rs, op_delete );
 349 }
 350
 351 static int
 352 over_op_abandon( Operation *op, SlapReply *rs )
 353 {
 354         return over_op_func( op, rs, op_abandon );
 355 }
 356
 357 static int
 358 over_op_cancel( Operation *op, SlapReply *rs )
 359 {
 360         return over_op_func( op, rs, op_cancel );
 361 }
 362
 363 static int
 364 over_op_extended( Operation *op, SlapReply *rs )
 365 {
 366         return over_op_func( op, rs, op_extended );
 367 }
 368
 369 static int
 370 over_aux_operational( Operation *op, SlapReply *rs )
 371 {
 372         return over_op_func( op, rs, op_aux_operational );
 373 }
 374
 375 static int
 376 over_aux_chk_referrals( Operation *op, SlapReply *rs )
 377 {
 378         return over_op_func( op, rs, op_aux_chk_referrals );
 379 }
 380
 381 int
 382 overlay_register(
 383         slap_overinst *on
 384 )
 385 {
 386         on->on_next = overlays;
 387         overlays = on;
 388         return 0;
 389 }
 390
 391 /*
 392  * iterator on registered overlays; overlay_next( NULL ) returns the first
 393  * overlay; * subsequent calls with the previously returned value allow to
 394  * iterate * over the entire list; returns NULL when no more overlays are
 395  * registered.
 396  */
 397
 398 slap_overinst *
 399 overlay_next(
 400         slap_overinst *on
 401 )
 402 {
 403         if ( on == NULL ) {
 404                 return overlays;
 405         }
 406
 407         return on->on_next;
 408 }
 409
 410 /*
 411  * returns a specific registered overlay based on the type; NULL if not
 412  * registered.
 413  */
 414
 415 slap_overinst *
 416 overlay_find( const char *over_type )
 417 {
 418         slap_overinst *on = overlays;
 419
 420         assert( over_type );
 421
 422         for ( ; on; on = on->on_next ) {
 423                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
 424                         break;
 425                 }
 426         }
 427
 428         return on;
 429 }
 430
 431 static const char overtype[] = "over";
 432
 433 /*
 434  * returns TRUE (1) if the database is actually an overlay instance;
 435  * FALSE (0) otherwise.
 436  */
 437
 438 int
 439 overlay_is_over( BackendDB *be )
 440 {
 441         return be->bd_info->bi_type == overtype;
 442 }
 443
 444 /*
 445  * returns TRUE (1) if the given database is actually an overlay
 446  * instance and, somewhere in the list, contains the requested overlay;
 447  * FALSE (0) otherwise.
 448  */
 449
 450 int
 451 overlay_is_inst( BackendDB *be, const char *over_type )
 452 {
 453         slap_overinst   *on;
 454
 455         assert( be );
 456
 457         if ( !overlay_is_over( be ) ) {
 458                 return 0;
 459         }
 460
 461         on = ((slap_overinfo *)be->bd_info->bi_private)->oi_list;
 462         for ( ; on; on = on->on_next ) {
 463                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
 464                         return 1;
 465                 }
 466         }
 467
 468         return 0;
 469 }
 470
 471 /* add an overlay to a particular backend. */
 472 int
 473 overlay_config( BackendDB *be, const char *ov )
 474 {
 475         slap_overinst *on = NULL, *on2 = NULL;
 476         slap_overinfo *oi = NULL;
 477         BackendInfo *bi = NULL;
 478
 479         on = overlay_find( ov );
 480         if ( !on ) {
 481                 Debug( LDAP_DEBUG_ANY, "overlay \"%s\" not found\n", ov, 0, 0 );
 482                 return 1;
 483         }
 484
 485         /* If this is the first overlay on this backend, set up the
 486          * overlay info structure
 487          */
 488         if ( !overlay_is_over( be ) ) {
 489                 oi = ch_malloc( sizeof( slap_overinfo ) );
 490                 oi->oi_orig = be->bd_info;
 491                 oi->oi_bi = *be->bd_info;
 492
 493                 /* Save a pointer to ourself in bi_private.
 494                  */
 495                 oi->oi_bi.bi_private = oi;
 496                 oi->oi_list = NULL;
 497                 bi = (BackendInfo *)oi;
 498
 499                 bi->bi_type = (char *)overtype;
 500
 501                 bi->bi_db_config = over_db_config;
 502                 bi->bi_db_open = over_db_open;
 503                 bi->bi_db_close = over_db_close;
 504                 bi->bi_db_destroy = over_db_destroy;
 505
 506                 bi->bi_op_bind = over_op_bind;
 507                 bi->bi_op_unbind = over_op_unbind;
 508                 bi->bi_op_search = over_op_search;
 509                 bi->bi_op_compare = over_op_compare;
 510                 bi->bi_op_modify = over_op_modify;
 511                 bi->bi_op_modrdn = over_op_modrdn;
 512                 bi->bi_op_add = over_op_add;
 513                 bi->bi_op_delete = over_op_delete;
 514                 bi->bi_op_abandon = over_op_abandon;
 515                 bi->bi_op_cancel = over_op_cancel;
 516
 517                 bi->bi_extended = over_op_extended;
 518
 519                 /*
 520                  * this is fine because it has the same
 521                  * args of the operations; we need to rework
 522                  * all the hooks to share the same args
 523                  * of the operations...
 524                  */
 525                 bi->bi_operational = over_aux_operational;
 526                 bi->bi_chk_referrals = over_aux_chk_referrals;
 527
 528                 be->bd_info = bi;
 529
 530         } else {
 531                 if ( overlay_is_inst( be, ov ) ) {
 532                         Debug( LDAP_DEBUG_ANY, "overlay_config(): "
 533                                         "warning, overlay \"%s\" "
 534                                         "already in list\n", ov, 0, 0 );
 535                 }
 536
 537                 oi = be->bd_info->bi_private;
 538         }
 539
 540         /* Insert new overlay on head of list. Overlays are executed
 541          * in reverse of config order...
 542          */
 543         on2 = ch_calloc( 1, sizeof(slap_overinst) );
 544         *on2 = *on;
 545         on2->on_info = oi;
 546         on2->on_next = oi->oi_list;
 547         oi->oi_list = on2;
 548
 549         /* Any initialization needed? */
 550         if ( on->on_bi.bi_db_init ) {
 551                 be->bd_info = (BackendInfo *)on2;
 552                 on2->on_bi.bi_db_init( be );
 553                 be->bd_info = (BackendInfo *)oi;
 554         }
 555
 556         return 0;
 557 }
 558