1 /* backover.c - backend overlay routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2003-2004 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 return over_db_func( be, db_close );
159 slap_overinfo *oi = be->bd_info->bi_private;
160 slap_overinst *on = oi->oi_list, *next;
163 rc = over_db_func( be, db_destroy );
165 for (next = on->on_next; on; on=next) {
174 over_back_response ( Operation *op, SlapReply *rs )
176 slap_overinfo *oi = op->o_callback->sc_private;
177 slap_overinst *on = oi->oi_list;
178 int rc = SLAP_CB_CONTINUE;
179 BackendDB *be = op->o_bd, db = *op->o_bd;
182 for (; on; on=on->on_next ) {
183 if ( on->on_response ) {
184 db.bd_info = (BackendInfo *)on;
185 rc = on->on_response( op, rs );
186 if ( rc != SLAP_CB_CONTINUE ) break;
206 op_aux_chk_referrals,
211 * default return code in case of missing backend function
212 * and overlay stack returning SLAP_CB_CONTINUE
214 static int op_rc[] = {
215 LDAP_UNWILLING_TO_PERFORM, /* bind */
216 LDAP_UNWILLING_TO_PERFORM, /* unbind */
217 LDAP_UNWILLING_TO_PERFORM, /* search */
218 LDAP_UNWILLING_TO_PERFORM, /* compare */
219 LDAP_UNWILLING_TO_PERFORM, /* modify */
220 LDAP_UNWILLING_TO_PERFORM, /* modrdn */
221 LDAP_UNWILLING_TO_PERFORM, /* add */
222 LDAP_UNWILLING_TO_PERFORM, /* delete */
223 LDAP_UNWILLING_TO_PERFORM, /* abandon */
224 LDAP_UNWILLING_TO_PERFORM, /* cancel */
225 LDAP_UNWILLING_TO_PERFORM, /* extended */
226 LDAP_SUCCESS, /* aux_operational */
227 LDAP_SUCCESS /* aux_chk_referrals */
237 slap_overinfo *oi = op->o_bd->bd_info->bi_private;
238 slap_overinst *on = oi->oi_list;
240 BackendDB *be = op->o_bd, db = *op->o_bd;
241 slap_callback cb = {NULL, over_back_response, NULL, NULL};
242 int rc = SLAP_CB_CONTINUE;
245 cb.sc_next = op->o_callback;
247 op->o_callback = &cb;
249 for (; on; on=on->on_next ) {
250 func = &on->on_bi.bi_op_bind;
252 db.bd_info = (BackendInfo *)on;
253 rc = func[which]( op, rs );
254 if ( rc != SLAP_CB_CONTINUE ) break;
258 func = &oi->oi_orig->bi_op_bind;
259 if ( func[which] && rc == SLAP_CB_CONTINUE ) {
260 db.bd_info = oi->oi_orig;
261 rc = func[which]( op, rs );
263 /* should not fall thru this far without anything happening... */
264 if ( rc == SLAP_CB_CONTINUE ) {
268 op->o_callback = cb.sc_next;
273 over_op_bind( Operation *op, SlapReply *rs )
275 return over_op_func( op, rs, op_bind );
279 over_op_unbind( Operation *op, SlapReply *rs )
281 return over_op_func( op, rs, op_unbind );
285 over_op_search( Operation *op, SlapReply *rs )
287 return over_op_func( op, rs, op_search );
291 over_op_compare( Operation *op, SlapReply *rs )
293 return over_op_func( op, rs, op_compare );
297 over_op_modify( Operation *op, SlapReply *rs )
299 return over_op_func( op, rs, op_modify );
303 over_op_modrdn( Operation *op, SlapReply *rs )
305 return over_op_func( op, rs, op_modrdn );
309 over_op_add( Operation *op, SlapReply *rs )
311 return over_op_func( op, rs, op_add );
315 over_op_delete( Operation *op, SlapReply *rs )
317 return over_op_func( op, rs, op_delete );
321 over_op_abandon( Operation *op, SlapReply *rs )
323 return over_op_func( op, rs, op_abandon );
327 over_op_cancel( Operation *op, SlapReply *rs )
329 return over_op_func( op, rs, op_cancel );
333 over_op_extended( Operation *op, SlapReply *rs )
335 return over_op_func( op, rs, op_extended );
339 over_aux_operational( Operation *op, SlapReply *rs )
341 return over_op_func( op, rs, op_aux_operational );
345 over_aux_chk_referrals( Operation *op, SlapReply *rs )
347 return over_op_func( op, rs, op_aux_chk_referrals );
355 on->on_next = overlays;
361 * iterator on registered overlays; overlay_next( NULL ) returns the first
362 * overlay; * subsequent calls with the previously returned value allow to
363 * iterate * over the entire list; returns NULL when no more overlays are
380 * returns a specific registered overlay based on the type; NULL if not
385 overlay_find( const char *over_type )
387 slap_overinst *on = overlays;
391 for ( ; on; on = on->on_next ) {
392 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
400 static const char overtype[] = "over";
403 * returns TRUE (1) if the database is actually an overlay instance;
404 * FALSE (0) otherwise.
408 overlay_is_over( BackendDB *be )
410 return be->bd_info->bi_type == overtype;
414 * returns TRUE (1) if the given database is actually an overlay
415 * instance and, somewhere in the list, contains the requested overlay;
416 * FALSE (0) otherwise.
420 overlay_is_inst( BackendDB *be, const char *over_type )
426 if ( !overlay_is_over( be ) ) {
430 on = ((slap_overinfo *)be->bd_info->bi_private)->oi_list;
431 for ( ; on; on = on->on_next ) {
432 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
440 /* add an overlay to a particular backend. */
442 overlay_config( BackendDB *be, const char *ov )
444 slap_overinst *on = NULL, *on2 = NULL;
445 slap_overinfo *oi = NULL;
446 BackendInfo *bi = NULL;
448 on = overlay_find( ov );
450 Debug( LDAP_DEBUG_ANY, "overlay \"%s\" not found\n", ov, 0, 0 );
454 /* If this is the first overlay on this backend, set up the
455 * overlay info structure
457 if ( !overlay_is_over( be ) ) {
458 oi = ch_malloc( sizeof( slap_overinfo ) );
459 oi->oi_orig = be->bd_info;
460 oi->oi_bi = *be->bd_info;
462 /* Save a pointer to ourself in bi_private.
463 * This allows us to keep working in conjunction
466 oi->oi_bi.bi_private = oi;
468 bi = (BackendInfo *)oi;
470 bi->bi_type = (char *)overtype;
472 bi->bi_db_config = over_db_config;
473 bi->bi_db_open = over_db_open;
474 bi->bi_db_close = over_db_close;
475 bi->bi_db_destroy = over_db_destroy;
477 bi->bi_op_bind = over_op_bind;
478 bi->bi_op_unbind = over_op_unbind;
479 bi->bi_op_search = over_op_search;
480 bi->bi_op_compare = over_op_compare;
481 bi->bi_op_modify = over_op_modify;
482 bi->bi_op_modrdn = over_op_modrdn;
483 bi->bi_op_add = over_op_add;
484 bi->bi_op_delete = over_op_delete;
485 bi->bi_op_abandon = over_op_abandon;
486 bi->bi_op_cancel = over_op_cancel;
488 bi->bi_extended = over_op_extended;
491 * this is fine because it has the same
492 * args of the operations; we need to rework
493 * all the hooks to share the same args
494 * of the operations...
496 bi->bi_operational = over_aux_operational;
497 bi->bi_chk_referrals = over_aux_chk_referrals;
502 if ( overlay_is_inst( be, ov ) ) {
503 Debug( LDAP_DEBUG_ANY, "overlay_config(): "
504 "warning, overlay \"%s\" "
505 "already in list\n", ov, 0, 0 );
508 oi = be->bd_info->bi_private;
511 /* Insert new overlay on head of list. Overlays are executed
512 * in reverse of config order...
514 on2 = ch_calloc( 1, sizeof(slap_overinst) );
517 on2->on_next = oi->oi_list;
520 /* Any initialization needed? */
521 if ( on->on_bi.bi_db_init ) {
522 be->bd_info = (BackendInfo *)on2;
523 on2->on_bi.bi_db_init( be );
524 be->bd_info = (BackendInfo *)oi;