1 /* monitor.c - monitor bdb backend */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2007 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>.
20 #include <ac/string.h>
21 #include <ac/unistd.h>
22 #include <ac/stdlib.h>
28 #include "../back-monitor/back-monitor.h"
32 static ObjectClass *oc_olmBDBDatabase;
34 static AttributeDescription *ad_olmBDBEntryCache,
35 *ad_olmBDBDNCache, *ad_olmBDBIDLCache,
38 #ifdef BDB_MONITOR_IDX
40 bdb_monitor_idx_entry_add(
44 static AttributeDescription *ad_olmBDBNotIndexed;
45 #endif /* BDB_MONITOR_IDX */
48 * NOTE: there's some confusion in monitor OID arc;
49 * by now, let's consider:
51 * Subsystems monitor attributes 1.3.6.1.4.1.4203.666.1.55.0
52 * Databases monitor attributes 1.3.6.1.4.1.4203.666.1.55.0.1
53 * BDB database monitor attributes 1.3.6.1.4.1.4203.666.1.55.0.1.1
55 * Subsystems monitor objectclasses 1.3.6.1.4.1.4203.666.3.16.0
56 * Databases monitor objectclasses 1.3.6.1.4.1.4203.666.3.16.0.1
57 * BDB database monitor objectclasses 1.3.6.1.4.1.4203.666.3.16.0.1.1
64 { "olmBDBAttributes", "olmDatabaseAttributes:1" },
65 { "olmBDBObjectClasses", "olmDatabaseObjectClasses:1" },
72 AttributeDescription **ad;
74 { "( olmBDBAttributes:1 "
75 "NAME ( 'olmBDBEntryCache' ) "
76 "DESC 'Number of items in Entry Cache' "
78 "NO-USER-MODIFICATION "
79 "USAGE dSAOperation )",
80 &ad_olmBDBEntryCache },
82 { "( olmBDBAttributes:2 "
83 "NAME ( 'olmBDBDNCache' ) "
84 "DESC 'Number of items in DN Cache' "
86 "NO-USER-MODIFICATION "
87 "USAGE dSAOperation )",
90 { "( olmBDBAttributes:3 "
91 "NAME ( 'olmBDBIDLCache' ) "
92 "DESC 'Number of items in IDL Cache' "
94 "NO-USER-MODIFICATION "
95 "USAGE dSAOperation )",
98 { "( olmBDBAttributes:4 "
99 "NAME ( 'olmDbDirectory' ) "
100 "DESC 'Path name of the directory "
101 "where the database environment resides' "
103 "NO-USER-MODIFICATION "
104 "USAGE dSAOperation )",
105 &ad_olmDbDirectory },
107 #ifdef BDB_MONITOR_IDX
108 { "( olmBDBAttributes:5 "
109 "NAME ( 'olmBDBNotIndexed' ) "
110 "DESC 'Missing indexes resulting from candidate selection' "
112 "NO-USER-MODIFICATION "
113 "USAGE dSAOperation )",
114 &ad_olmBDBNotIndexed },
115 #endif /* BDB_MONITOR_IDX */
124 /* augments an existing object, so it must be AUXILIARY
125 * FIXME: derive from some ABSTRACT "monitoredEntity"? */
126 { "( olmBDBObjectClasses:1 "
127 "NAME ( 'olmBDBDatabase' ) "
134 #ifdef BDB_MONITOR_IDX
135 "$ olmBDBNotIndexed "
136 #endif /* BDB_MONITOR_IDX */
138 &oc_olmBDBDatabase },
150 struct bdb_info *bdb = (struct bdb_info *) priv;
156 assert( ad_olmBDBEntryCache != NULL );
158 a = attr_find( e->e_attrs, ad_olmBDBEntryCache );
161 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", bdb->bi_cache.c_cursize );
162 ber_bvreplace( &a->a_vals[ 0 ], &bv );
164 a = attr_find( e->e_attrs, ad_olmBDBDNCache );
166 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", bdb->bi_cache.c_eiused );
167 ber_bvreplace( &a->a_vals[ 0 ], &bv );
169 a = attr_find( e->e_attrs, ad_olmBDBIDLCache );
171 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", bdb->bi_idl_cache_size );
172 ber_bvreplace( &a->a_vals[ 0 ], &bv );
174 #ifdef BDB_MONITOR_IDX
175 bdb_monitor_idx_entry_add( bdb, e );
176 #endif /* BDB_MONITOR_IDX */
178 return SLAP_CB_CONTINUE;
181 #if 0 /* uncomment if required */
189 return SLAP_CB_CONTINUE;
198 struct berval values[ 2 ];
199 Modification mod = { 0 };
202 char textbuf[ SLAP_TEXT_BUFLEN ];
206 /* NOTE: if slap_shutdown != 0, priv might have already been freed */
209 /* Remove objectClass */
210 mod.sm_op = LDAP_MOD_DELETE;
211 mod.sm_desc = slap_schema.si_ad_objectClass;
212 mod.sm_values = values;
213 values[ 0 ] = oc_olmBDBDatabase->soc_cname;
214 BER_BVZERO( &values[ 1 ] );
216 rc = modify_delete_values( e, &mod, 1, &text,
217 textbuf, sizeof( textbuf ) );
218 /* don't care too much about return code... */
221 for ( i = 0; s_at[ i ].desc != NULL; i++ ) {
222 mod.sm_desc = *s_at[ i ].ad;
223 mod.sm_values = NULL;
224 rc = modify_delete_values( e, &mod, 1, &text,
225 textbuf, sizeof( textbuf ) );
226 /* don't care too much about return code... */
229 return SLAP_CB_CONTINUE;
232 #define bdb_monitor_initialize BDB_SYMBOL(monitor_initialize)
235 * call from within bdb_initialize()
238 bdb_monitor_initialize( void )
244 static int bdb_monitor_initialized = 0;
246 if ( backend_info( "monitor" ) == NULL ) {
250 if ( bdb_monitor_initialized++ ) {
254 /* register schema here */
256 argv[ 0 ] = "back-bdb/back-hdb monitor";
261 for ( i = 0; s_oid[ i ].name; i++ ) {
263 argv[ 1 ] = s_oid[ i ].name;
264 argv[ 2 ] = s_oid[ i ].oid;
266 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
267 Debug( LDAP_DEBUG_ANY,
268 "bdb_monitor_initialize: unable to add "
269 "objectIdentifier \"%s=%s\"\n",
270 s_oid[ i ].name, s_oid[ i ].oid, 0 );
275 for ( i = 0; s_at[ i ].desc != NULL; i++ ) {
276 code = register_at( s_at[ i ].desc, s_at[ i ].ad, 1 );
277 if ( code != LDAP_SUCCESS ) {
278 Debug( LDAP_DEBUG_ANY,
279 "bdb_monitor_initialize: register_at failed\n",
282 (*s_at[ i ].ad)->ad_type->sat_flags |= SLAP_AT_HIDE;
285 for ( i = 0; s_oc[ i ].desc != NULL; i++ ) {
286 code = register_oc( s_oc[ i ].desc, s_oc[ i ].oc, 1 );
287 if ( code != LDAP_SUCCESS ) {
288 Debug( LDAP_DEBUG_ANY,
289 "bdb_monitor_initialize: register_oc failed\n",
292 (*s_oc[ i ].oc)->soc_flags |= SLAP_OC_HIDE;
299 * call from within bdb_db_init()
302 bdb_monitor_db_init( BackendDB *be )
304 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
306 if ( SLAP_GLUE_SUBORDINATE( be ) ) {
310 if ( bdb_monitor_initialize() == LDAP_SUCCESS ) {
311 /* monitoring in back-bdb is on by default */
312 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
315 #ifdef BDB_MONITOR_IDX
317 ldap_pvt_thread_mutex_init( &bdb->bi_idx_mutex );
318 #endif /* BDB_MONITOR_IDX */
324 * call from within bdb_db_open()
327 bdb_monitor_db_open( BackendDB *be )
329 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
331 monitor_callback_t *cb = NULL;
334 monitor_extra_t *mbe;
335 struct berval dummy = BER_BVC("");
337 if ( !SLAP_DBMONITORING( be ) ) {
341 if ( SLAP_GLUE_SUBORDINATE( be ) ) {
345 mi = backend_info( "monitor" );
346 if ( !mi || !mi->bi_extra ) {
347 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
352 /* don't bother if monitor is not configured */
353 if ( !mbe->is_configured() ) {
354 static int warning = 0;
356 if ( warning++ == 0 ) {
357 Debug( LDAP_DEBUG_ANY, "bdb_monitor_open: "
358 "monitoring disabled; "
359 "configure monitor database to enable\n",
366 /* alloc as many as required (plus 1 for objectClass) */
367 a = attrs_alloc( 1 + 4 );
373 a->a_desc = slap_schema.si_ad_objectClass;
374 attr_valadd( a, &oc_olmBDBDatabase->soc_cname, NULL, 1 );
378 struct berval bv = BER_BVC( "0" );
380 next->a_desc = ad_olmBDBEntryCache;
381 attr_valadd( next, &bv, NULL, 1 );
384 next->a_desc = ad_olmBDBDNCache;
385 attr_valadd( next, &bv, NULL, 1 );
388 next->a_desc = ad_olmBDBIDLCache;
389 attr_valadd( next, &bv, NULL, 1 );
394 struct berval bv, nbv;
395 ber_len_t pathlen = 0, len = 0;
396 char path[ PATH_MAX ] = { '\0' };
397 char *fname = bdb->bi_dbenv_home,
400 len = strlen( fname );
401 if ( fname[ 0 ] != '/' ) {
402 /* get full path name */
403 getcwd( path, sizeof( path ) );
404 pathlen = strlen( path );
406 if ( fname[ 0 ] == '.' && fname[ 1 ] == '/' ) {
412 bv.bv_len = pathlen + STRLENOF( "/" ) + len;
413 ptr = bv.bv_val = ch_malloc( bv.bv_len + STRLENOF( "/" ) + 1 );
415 ptr = lutil_strncopy( ptr, path, pathlen );
419 ptr = lutil_strncopy( ptr, fname, len );
420 if ( ptr[ -1 ] != '/' ) {
426 attr_normalize_one( ad_olmDbDirectory, &bv, &nbv, NULL );
428 next->a_desc = ad_olmDbDirectory;
429 next->a_vals = ch_calloc( sizeof( struct berval ), 2 );
430 next->a_vals[ 0 ] = bv;
433 if ( BER_BVISNULL( &nbv ) ) {
434 next->a_nvals = next->a_vals;
437 next->a_nvals = ch_calloc( sizeof( struct berval ), 2 );
438 next->a_nvals[ 0 ] = nbv;
444 cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
445 cb->mc_update = bdb_monitor_update;
446 #if 0 /* uncomment if required */
447 cb->mc_modify = bdb_monitor_modify;
449 cb->mc_free = bdb_monitor_free;
450 cb->mc_private = (void *)bdb;
452 /* make sure the database is registered; then add monitor attributes */
453 rc = mbe->register_database( be, &bdb->bi_monitor.bdm_ndn );
455 rc = mbe->register_entry_attrs( &bdb->bi_monitor.bdm_ndn, a, cb,
472 /* store for cleanup */
473 bdb->bi_monitor.bdm_cb = (void *)cb;
475 /* we don't need to keep track of the attributes, because
476 * bdb_monitor_free() takes care of everything */
485 * call from within bdb_db_close()
488 bdb_monitor_db_close( BackendDB *be )
490 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
492 if ( SLAP_GLUE_SUBORDINATE( be ) ) {
496 if ( !BER_BVISNULL( &bdb->bi_monitor.bdm_ndn ) ) {
497 BackendInfo *mi = backend_info( "monitor" );
498 monitor_extra_t *mbe;
500 if ( mi && &mi->bi_extra ) {
502 mbe->unregister_entry_callback( &bdb->bi_monitor.bdm_ndn,
503 (monitor_callback_t *)bdb->bi_monitor.bdm_cb,
507 memset( &bdb->bi_monitor, 0, sizeof( bdb->bi_monitor ) );
514 * call from within bdb_db_destroy()
517 bdb_monitor_db_destroy( BackendDB *be )
519 if ( SLAP_GLUE_SUBORDINATE( be ) ) {
523 #ifdef BDB_MONITOR_IDX
525 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
527 /* TODO: free tree */
528 ldap_pvt_thread_mutex_destroy( &bdb->bi_idx_mutex );
529 avl_free( bdb->bi_idx, ch_free );
531 #endif /* BDB_MONITOR_IDX */
536 #ifdef BDB_MONITOR_IDX
538 #define BDB_MONITOR_IDX_TYPES (4)
540 typedef struct monitor_idx_t monitor_idx_t;
542 struct monitor_idx_t {
543 AttributeDescription *idx_ad;
544 unsigned long idx_count[BDB_MONITOR_IDX_TYPES];
548 bdb_monitor_bitmask2key( slap_mask_t bitmask )
552 for ( key = 0; key < 8*sizeof(slap_mask_t) && !( bitmask & 0x1U ); key++ ) {
559 static struct berval idxbv[] = {
560 BER_BVC( "present=" ),
561 BER_BVC( "equality=" ),
562 BER_BVC( "approx=" ),
563 BER_BVC( "substr=" ),
568 bdb_monitor_idx2len( monitor_idx_t *idx )
573 for ( i = 0; i < BDB_MONITOR_IDX_TYPES; i++ ) {
574 if ( idx->idx_count[ i ] != 0 ) {
575 len += idxbv[i].bv_len;
583 monitor_idx_cmp( const void *p1, const void *p2 )
585 const monitor_idx_t *idx1 = (const monitor_idx_t *)p1;
586 const monitor_idx_t *idx2 = (const monitor_idx_t *)p2;
588 return SLAP_PTRCMP( idx1->idx_ad, idx2->idx_ad );
592 monitor_idx_dup( void *p1, void *p2 )
594 monitor_idx_t *idx1 = (monitor_idx_t *)p1;
595 monitor_idx_t *idx2 = (monitor_idx_t *)p2;
597 return SLAP_PTRCMP( idx1->idx_ad, idx2->idx_ad ) == 0 ? -1 : 0;
602 struct bdb_info *bdb,
603 AttributeDescription *desc,
606 monitor_idx_t idx_dummy = { 0 },
610 idx_dummy.idx_ad = desc;
611 key = bdb_monitor_bitmask2key( type ) - 1;
612 if ( key >= BDB_MONITOR_IDX_TYPES ) {
613 /* invalid index type */
617 ldap_pvt_thread_mutex_lock( &bdb->bi_idx_mutex );
619 idx = (monitor_idx_t *)avl_find( bdb->bi_idx,
620 (caddr_t)&idx_dummy, monitor_idx_cmp );
622 idx = (monitor_idx_t *)ch_calloc( sizeof( monitor_idx_t ), 1 );
624 idx->idx_count[ key ] = 1;
626 switch ( avl_insert( &bdb->bi_idx, (caddr_t)idx,
627 monitor_idx_cmp, monitor_idx_dup ) )
638 idx->idx_count[ key ]++;
641 ldap_pvt_thread_mutex_unlock( &bdb->bi_idx_mutex );
647 bdb_monitor_idx_apply( void *v_idx, void *v_valp )
649 monitor_idx_t *idx = (monitor_idx_t *)v_idx;
650 BerVarray *valp = (BerVarray *)v_valp;
654 char count_buf[ BDB_MONITOR_IDX_TYPES ][ SLAP_TEXT_BUFLEN ];
655 ber_len_t count_len[ BDB_MONITOR_IDX_TYPES ],
659 idx_len = bdb_monitor_idx2len( idx );
662 for ( i = 0; i < BDB_MONITOR_IDX_TYPES; i++ ) {
663 if ( idx->idx_count[ i ] == 0 ) {
667 count_len[ i ] = snprintf( count_buf[ i ],
668 sizeof( count_buf[ i ] ), "%lu", idx->idx_count[ i ] );
669 bv.bv_len += count_len[ i ];
673 bv.bv_len += idx->idx_ad->ad_cname.bv_len
676 ptr = bv.bv_val = ch_malloc( bv.bv_len + 1 );
677 ptr = lutil_strcopy( ptr, idx->idx_ad->ad_cname.bv_val );
678 for ( i = 0; i < BDB_MONITOR_IDX_TYPES; i++ ) {
679 if ( idx->idx_count[ i ] == 0 ) {
685 ptr = lutil_strcopy( ptr, idxbv[ i ].bv_val );
686 ptr = lutil_strcopy( ptr, count_buf[ i ] );
689 ber_bvarray_add( valp, &bv );
695 bdb_monitor_idx_entry_add(
696 struct bdb_info *bdb,
699 BerVarray vals = NULL;
702 a = attr_find( e->e_attrs, ad_olmBDBNotIndexed );
704 ldap_pvt_thread_mutex_lock( &bdb->bi_idx_mutex );
706 avl_apply( bdb->bi_idx, bdb_monitor_idx_apply,
707 &vals, -1, AVL_INORDER );
709 ldap_pvt_thread_mutex_unlock( &bdb->bi_idx_mutex );
711 if ( vals != NULL ) {
713 assert( a->a_nvals == a->a_vals );
715 ber_bvarray_free( a->a_vals );
720 for ( ap = &e->e_attrs; *ap != NULL; ap = &(*ap)->a_next )
722 *ap = attr_alloc( ad_olmBDBNotIndexed );
726 a->a_nvals = a->a_vals;
732 #endif /* BDB_MONITOR_IDX */