1 /* backover.c - backend overlay routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2003-2005 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
17 /* Functions to overlay other modules over a backend. */
23 #include <ac/string.h>
24 #include <ac/socket.h>
29 static slap_overinst *overlays;
31 enum db_which { db_open = 0, db_close, db_destroy };
39 slap_overinfo *oi = be->bd_info->bi_private;
40 slap_overinst *on = oi->oi_list;
41 BackendInfo *bi_orig = be->bd_info;
45 func = &oi->oi_orig->bi_db_open;
47 be->bd_info = oi->oi_orig;
48 rc = func[which]( be );
51 for (; on && rc == 0; on=on->on_next) {
52 be->bd_info = &on->on_bi;
53 func = &on->on_bi.bi_db_open;
55 rc = func[which]( be );
58 be->bd_info = bi_orig;
71 slap_overinfo *oi = be->bd_info->bi_private;
72 slap_overinst *on = oi->oi_list;
73 BackendInfo *bi_orig = be->bd_info;
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,
81 if ( be->bd_info != oi->oi_orig ) {
83 slap_overinst *on2, **onp;
87 /* a database added an overlay;
88 * work it around... */
89 assert( overlay_is_over( be ) );
91 oi2 = ( slap_overinfo * )be->bd_info->bi_private;
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
98 be2.bd_info = (BackendInfo *)oi;
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 );
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 */
119 ch_free( be->bd_info );
122 be->bd_info = (BackendInfo *)oi;
123 if ( rc != SLAP_CONF_UNKNOWN ) return rc;
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,
131 if ( rc != SLAP_CONF_UNKNOWN ) break;
134 be->bd_info = bi_orig;
143 return over_db_func( be, db_open );
151 slap_overinfo *oi = be->bd_info->bi_private;
152 slap_overinst *on = oi->oi_list;
153 BackendInfo *bi_orig = be->bd_info;
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 );
163 if ( oi->oi_orig->bi_db_close ) {
164 be->bd_info = oi->oi_orig;
165 rc = be->bd_info->bi_db_close( be );
168 be->bd_info = bi_orig;
177 slap_overinfo *oi = be->bd_info->bi_private;
178 slap_overinst *on = oi->oi_list, *next;
181 rc = over_db_func( be, db_destroy );
183 for (next = on->on_next; on; on=next) {
192 over_back_response ( Operation *op, SlapReply *rs )
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;
199 db.be_flags |= SLAP_DBFLAG_OVERLAY;
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;
225 op_aux_chk_referrals,
231 * default return code in case of missing backend function
232 * and overlay stack returning SLAP_CB_CONTINUE
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 */
261 BackendDB *be = op->o_bd, db;
262 slap_callback cb = {NULL, over_back_response, NULL, NULL};
263 int rc = SLAP_CB_CONTINUE;
265 /* FIXME: used to happen for instance during abandon
266 * when global overlays are used... */
267 assert( op->o_bd != NULL );
269 oi = op->o_bd->bd_info->bi_private;
272 if ( !SLAP_ISOVERLAY( op->o_bd )) {
274 db.be_flags |= SLAP_DBFLAG_OVERLAY;
277 cb.sc_next = op->o_callback;
279 op->o_callback = &cb;
281 for (; on; on=on->on_next ) {
282 func = &on->on_bi.bi_op_bind;
284 op->o_bd->bd_info = (BackendInfo *)on;
285 rc = func[which]( op, rs );
286 if ( rc != SLAP_CB_CONTINUE ) break;
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 );
295 /* should not fall thru this far without anything happening... */
296 if ( rc == SLAP_CB_CONTINUE ) {
300 op->o_callback = cb.sc_next;
305 over_op_bind( Operation *op, SlapReply *rs )
307 return over_op_func( op, rs, op_bind );
311 over_op_unbind( Operation *op, SlapReply *rs )
313 return over_op_func( op, rs, op_unbind );
317 over_op_search( Operation *op, SlapReply *rs )
319 return over_op_func( op, rs, op_search );
323 over_op_compare( Operation *op, SlapReply *rs )
325 return over_op_func( op, rs, op_compare );
329 over_op_modify( Operation *op, SlapReply *rs )
331 return over_op_func( op, rs, op_modify );
335 over_op_modrdn( Operation *op, SlapReply *rs )
337 return over_op_func( op, rs, op_modrdn );
341 over_op_add( Operation *op, SlapReply *rs )
343 return over_op_func( op, rs, op_add );
347 over_op_delete( Operation *op, SlapReply *rs )
349 return over_op_func( op, rs, op_delete );
353 over_op_abandon( Operation *op, SlapReply *rs )
355 return over_op_func( op, rs, op_abandon );
359 over_op_cancel( Operation *op, SlapReply *rs )
361 return over_op_func( op, rs, op_cancel );
365 over_op_extended( Operation *op, SlapReply *rs )
367 return over_op_func( op, rs, op_extended );
371 over_aux_operational( Operation *op, SlapReply *rs )
373 return over_op_func( op, rs, op_aux_operational );
377 over_aux_chk_referrals( Operation *op, SlapReply *rs )
379 return over_op_func( op, rs, op_aux_chk_referrals );
383 over_aux_chk_controls( Operation *op, SlapReply *rs )
385 return over_op_func( op, rs, op_aux_chk_controls );
389 over_connection_destroy(
397 int rc = SLAP_CB_CONTINUE;
399 /* FIXME: used to happen for instance during abandon
400 * when global overlays are used... */
401 assert( bd != NULL );
403 oi = bd->bd_info->bi_private;
406 if ( !SLAP_ISOVERLAY( bd )) {
408 db.be_flags |= SLAP_DBFLAG_OVERLAY;
412 for (; on; on=on->on_next ) {
413 if ( on->on_bi.bi_connection_destroy ) {
414 bd->bd_info = (BackendInfo *)on;
415 rc = on->on_bi.bi_connection_destroy( bd, conn );
416 if ( rc != SLAP_CB_CONTINUE ) break;
420 if ( oi->oi_orig->bi_connection_destroy && rc == SLAP_CB_CONTINUE ) {
421 bd->bd_info = oi->oi_orig;
422 rc = oi->oi_orig->bi_connection_destroy( bd, conn );
424 /* should not fall thru this far without anything happening... */
425 if ( rc == SLAP_CB_CONTINUE ) {
426 rc = LDAP_UNWILLING_TO_PERFORM;
437 on->on_next = overlays;
443 * iterator on registered overlays; overlay_next( NULL ) returns the first
444 * overlay; * subsequent calls with the previously returned value allow to
445 * iterate * over the entire list; returns NULL when no more overlays are
462 * returns a specific registered overlay based on the type; NULL if not
467 overlay_find( const char *over_type )
469 slap_overinst *on = overlays;
473 for ( ; on; on = on->on_next ) {
474 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
482 static const char overtype[] = "over";
485 * returns TRUE (1) if the database is actually an overlay instance;
486 * FALSE (0) otherwise.
490 overlay_is_over( BackendDB *be )
492 return be->bd_info->bi_type == overtype;
496 * returns TRUE (1) if the given database is actually an overlay
497 * instance and, somewhere in the list, contains the requested overlay;
498 * FALSE (0) otherwise.
502 overlay_is_inst( BackendDB *be, const char *over_type )
508 if ( !overlay_is_over( be ) ) {
512 on = ((slap_overinfo *)be->bd_info->bi_private)->oi_list;
513 for ( ; on; on = on->on_next ) {
514 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
523 overlay_register_control( BackendDB *be, const char *oid )
529 if ( slap_find_control_id( oid, &cid ) == LDAP_CONTROL_NOT_FOUND ) {
533 if ( SLAP_DBFLAGS( be ) & SLAP_DBFLAG_GLOBAL_OVERLAY ) {
536 /* add to all backends... */
537 for ( i = 0; i < nBackendDB; i++ ) {
538 BackendDB *bd = &backendDB[i];
544 bd->be_ctrls[ cid ] = 1;
545 bd->be_ctrls[ SLAP_MAX_CIDS ] = 1;
550 if ( rc == 0 && !gotit ) {
551 be->be_ctrls[ cid ] = 1;
552 be->be_ctrls[ SLAP_MAX_CIDS ] = 1;
558 /* add an overlay to a particular backend. */
560 overlay_config( BackendDB *be, const char *ov )
562 slap_overinst *on = NULL, *on2 = NULL;
563 slap_overinfo *oi = NULL;
564 BackendInfo *bi = NULL;
566 on = overlay_find( ov );
568 Debug( LDAP_DEBUG_ANY, "overlay \"%s\" not found\n", ov, 0, 0 );
572 /* If this is the first overlay on this backend, set up the
573 * overlay info structure
575 if ( !overlay_is_over( be ) ) {
576 oi = ch_malloc( sizeof( slap_overinfo ) );
577 oi->oi_orig = be->bd_info;
578 oi->oi_bi = *be->bd_info;
580 /* NOTE: the first time a global overlay is configured,
581 * frontendDB gets this flag; it is used later by overlays
582 * to determine if they're stacked on top of the frontendDB */
583 if ( oi->oi_orig == frontendDB->bd_info ) {
584 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLOBAL_OVERLAY;
587 /* Save a pointer to ourself in bi_private.
589 oi->oi_bi.bi_private = oi;
591 bi = (BackendInfo *)oi;
593 bi->bi_type = (char *)overtype;
595 bi->bi_db_config = over_db_config;
596 bi->bi_db_open = over_db_open;
597 bi->bi_db_close = over_db_close;
598 bi->bi_db_destroy = over_db_destroy;
600 bi->bi_op_bind = over_op_bind;
601 bi->bi_op_unbind = over_op_unbind;
602 bi->bi_op_search = over_op_search;
603 bi->bi_op_compare = over_op_compare;
604 bi->bi_op_modify = over_op_modify;
605 bi->bi_op_modrdn = over_op_modrdn;
606 bi->bi_op_add = over_op_add;
607 bi->bi_op_delete = over_op_delete;
608 bi->bi_op_abandon = over_op_abandon;
609 bi->bi_op_cancel = over_op_cancel;
611 bi->bi_extended = over_op_extended;
614 * this is fine because it has the same
615 * args of the operations; we need to rework
616 * all the hooks to share the same args
617 * of the operations...
619 bi->bi_operational = over_aux_operational;
620 bi->bi_chk_referrals = over_aux_chk_referrals;
621 bi->bi_chk_controls = over_aux_chk_controls;
623 bi->bi_connection_destroy = over_connection_destroy;
628 if ( overlay_is_inst( be, ov ) ) {
629 Debug( LDAP_DEBUG_ANY, "overlay_config(): "
630 "warning, overlay \"%s\" "
631 "already in list\n", ov, 0, 0 );
634 oi = be->bd_info->bi_private;
637 /* Insert new overlay on head of list. Overlays are executed
638 * in reverse of config order...
640 on2 = ch_calloc( 1, sizeof(slap_overinst) );
643 on2->on_next = oi->oi_list;
646 /* Any initialization needed? */
647 if ( on->on_bi.bi_db_init ) {
648 be->bd_info = (BackendInfo *)on2;
649 on2->on_bi.bi_db_init( be );
650 be->bd_info = (BackendInfo *)oi;