1 /* init.c - initialize monitor backend */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2001-2011 The OpenLDAP Foundation.
6 * Portions Copyright 2001-2003 Pierangelo Masarati.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Pierangelo Masarati for inclusion
19 * in OpenLDAP Software.
25 #include <ac/string.h>
31 #include "back-monitor.h"
35 #undef INTEGRATE_CORE_SCHEMA
38 * used by many functions to add description to entries
40 * WARNING: be_monitor may change as new databases are added,
41 * so it should not be used outside monitor_back_db_init()
42 * until monitor_back_db_open is called.
44 BackendDB *be_monitor;
46 static struct monitor_subsys_t **monitor_subsys;
47 static int monitor_subsys_opened;
48 static monitor_info_t monitor_info;
49 static const monitor_extra_t monitor_extra = {
50 monitor_back_is_configured,
51 monitor_back_get_subsys,
52 monitor_back_get_subsys_by_dn,
54 monitor_back_register_subsys,
55 monitor_back_register_backend,
56 monitor_back_register_database,
57 monitor_back_register_overlay_info,
58 monitor_back_register_overlay,
59 monitor_back_register_entry,
60 monitor_back_register_entry_parent,
61 monitor_back_register_entry_attrs,
62 monitor_back_register_entry_callback,
64 monitor_back_unregister_entry,
65 monitor_back_unregister_entry_parent,
66 monitor_back_unregister_entry_attrs,
67 monitor_back_unregister_entry_callback
74 * the known subsystems are added to the subsystems
75 * array at backend initialization; other subsystems
76 * may be added by calling monitor_back_register_subsys()
77 * before the database is opened (e.g. by other backends
78 * or by overlays or modules).
80 static struct monitor_subsys_t known_monitor_subsys[] = {
82 SLAPD_MONITOR_BACKEND_NAME,
83 BER_BVNULL, BER_BVNULL, BER_BVNULL,
84 { BER_BVC( "This subsystem contains information about available backends." ),
86 MONITOR_F_PERSISTENT_CH,
87 monitor_subsys_backend_init,
93 SLAPD_MONITOR_CONN_NAME,
94 BER_BVNULL, BER_BVNULL, BER_BVNULL,
95 { BER_BVC( "This subsystem contains information about connections." ),
97 MONITOR_F_VOLATILE_CH,
98 monitor_subsys_conn_init,
104 SLAPD_MONITOR_DATABASE_NAME,
105 BER_BVNULL, BER_BVNULL, BER_BVNULL,
106 { BER_BVC( "This subsystem contains information about configured databases." ),
108 MONITOR_F_PERSISTENT_CH,
109 monitor_subsys_database_init,
115 SLAPD_MONITOR_LISTENER_NAME,
116 BER_BVNULL, BER_BVNULL, BER_BVNULL,
117 { BER_BVC( "This subsystem contains information about active listeners." ),
119 MONITOR_F_PERSISTENT_CH,
120 monitor_subsys_listener_init,
126 SLAPD_MONITOR_LOG_NAME,
127 BER_BVNULL, BER_BVNULL, BER_BVNULL,
128 { BER_BVC( "This subsystem contains information about logging." ),
129 BER_BVC( "Set the attribute \"managedInfo\" to the desired log levels." ),
132 monitor_subsys_log_init,
138 SLAPD_MONITOR_OPS_NAME,
139 BER_BVNULL, BER_BVNULL, BER_BVNULL,
140 { BER_BVC( "This subsystem contains information about performed operations." ),
142 MONITOR_F_PERSISTENT_CH,
143 monitor_subsys_ops_init,
149 SLAPD_MONITOR_OVERLAY_NAME,
150 BER_BVNULL, BER_BVNULL, BER_BVNULL,
151 { BER_BVC( "This subsystem contains information about available overlays." ),
153 MONITOR_F_PERSISTENT_CH,
154 monitor_subsys_overlay_init,
160 SLAPD_MONITOR_SASL_NAME,
161 BER_BVNULL, BER_BVNULL, BER_BVNULL,
162 { BER_BVC( "This subsystem contains information about SASL." ),
171 SLAPD_MONITOR_SENT_NAME,
172 BER_BVNULL, BER_BVNULL, BER_BVNULL,
173 { BER_BVC( "This subsystem contains statistics." ),
175 MONITOR_F_PERSISTENT_CH,
176 monitor_subsys_sent_init,
182 SLAPD_MONITOR_THREAD_NAME,
183 BER_BVNULL, BER_BVNULL, BER_BVNULL,
184 { BER_BVC( "This subsystem contains information about threads." ),
186 MONITOR_F_PERSISTENT_CH,
187 monitor_subsys_thread_init,
193 SLAPD_MONITOR_TIME_NAME,
194 BER_BVNULL, BER_BVNULL, BER_BVNULL,
195 { BER_BVC( "This subsystem contains information about time." ),
197 MONITOR_F_PERSISTENT_CH,
198 monitor_subsys_time_init,
204 SLAPD_MONITOR_TLS_NAME,
205 BER_BVNULL, BER_BVNULL, BER_BVNULL,
206 { BER_BVC( "This subsystem contains information about TLS." ),
215 SLAPD_MONITOR_RWW_NAME,
216 BER_BVNULL, BER_BVNULL, BER_BVNULL,
217 { BER_BVC( "This subsystem contains information about read/write waiters." ),
219 MONITOR_F_PERSISTENT_CH,
220 monitor_subsys_rww_init,
229 monitor_subsys_is_opened( void )
231 return monitor_subsys_opened;
235 monitor_back_register_subsys(
236 monitor_subsys_t *ms )
240 if ( monitor_subsys ) {
241 for ( ; monitor_subsys[ i ] != NULL; i++ )
242 /* just count'em */ ;
245 monitor_subsys = ch_realloc( monitor_subsys,
246 ( 2 + i ) * sizeof( monitor_subsys_t * ) );
248 if ( monitor_subsys == NULL ) {
252 monitor_subsys[ i ] = ms;
253 monitor_subsys[ i + 1 ] = NULL;
255 /* if a subsystem is registered __AFTER__ subsystem
256 * initialization (depending on the sequence the databases
257 * are listed in slapd.conf), init it */
258 if ( monitor_subsys_is_opened() ) {
260 /* FIXME: this should only be possible
261 * if be_monitor is already initialized */
262 assert( be_monitor != NULL );
264 if ( ms->mss_open && ( *ms->mss_open )( be_monitor, ms ) ) {
268 ms->mss_flags |= MONITOR_F_OPENED;
287 typedef struct entry_limbo_t {
291 slap_overinst *el_on;
294 struct berval *el_ndn;
295 struct berval el_nbase;
297 struct berval el_filter;
298 monitor_callback_t *el_cb;
299 monitor_subsys_t *el_mss;
300 unsigned long el_flags;
301 struct entry_limbo_t *el_next;
305 monitor_back_is_configured( void )
307 return be_monitor != NULL;
311 monitor_back_register_backend(
318 monitor_back_register_overlay_info(
325 monitor_back_register_backend_limbo(
332 monitor_back_register_database_limbo(
334 struct berval *ndn_out )
336 entry_limbo_t **elpp, el = { 0 };
339 if ( be_monitor == NULL ) {
340 Debug( LDAP_DEBUG_ANY,
341 "monitor_back_register_database_limbo: "
342 "monitor database not configured.\n",
347 mi = ( monitor_info_t * )be_monitor->be_private;
350 el.el_type = LIMBO_DATABASE;
352 el.el_be = be->bd_self;
355 for ( elpp = &mi->mi_entry_limbo;
357 elpp = &(*elpp)->el_next )
360 *elpp = (entry_limbo_t *)ch_malloc( sizeof( entry_limbo_t ) );
369 monitor_back_register_overlay_info_limbo(
376 monitor_back_register_overlay_limbo(
378 struct slap_overinst *on,
379 struct berval *ndn_out )
381 entry_limbo_t **elpp, el = { 0 };
384 if ( be_monitor == NULL ) {
385 Debug( LDAP_DEBUG_ANY,
386 "monitor_back_register_overlay_limbo: "
387 "monitor database not configured.\n",
392 mi = ( monitor_info_t * )be_monitor->be_private;
395 el.el_type = LIMBO_OVERLAY;
397 el.el_be = be->bd_self;
401 for ( elpp = &mi->mi_entry_limbo;
403 elpp = &(*elpp)->el_next )
406 *elpp = (entry_limbo_t *)ch_malloc( sizeof( entry_limbo_t ) );
415 monitor_back_register_entry(
417 monitor_callback_t *cb,
418 monitor_subsys_t *mss,
419 unsigned long flags )
423 if ( be_monitor == NULL ) {
424 Debug( LDAP_DEBUG_ANY,
425 "monitor_back_register_entry(\"%s\"): "
426 "monitor database not configured.\n",
427 e->e_name.bv_val, 0, 0 );
431 mi = ( monitor_info_t * )be_monitor->be_private;
433 assert( mi != NULL );
435 assert( e->e_private == NULL );
437 if ( monitor_subsys_is_opened() ) {
438 Entry *e_parent = NULL,
441 struct berval pdn = BER_BVNULL;
442 monitor_entry_t *mp = NULL,
446 if ( monitor_cache_get( mi, &e->e_nname, &e_parent ) == 0 ) {
448 Debug( LDAP_DEBUG_ANY,
449 "monitor_back_register_entry(\"%s\"): "
451 e->e_name.bv_val, 0, 0 );
452 monitor_cache_release( mi, e_parent );
456 dnParent( &e->e_nname, &pdn );
457 if ( monitor_cache_get( mi, &pdn, &e_parent ) != 0 ) {
458 /* parent does not exist */
459 Debug( LDAP_DEBUG_ANY,
460 "monitor_back_register_entry(\"%s\"): "
461 "parent \"%s\" not found\n",
462 e->e_name.bv_val, pdn.bv_val, 0 );
466 assert( e_parent->e_private != NULL );
467 mp_parent = ( monitor_entry_t * )e_parent->e_private;
469 if ( mp_parent->mp_flags & MONITOR_F_VOLATILE ) {
470 /* entry is volatile; cannot append children */
471 Debug( LDAP_DEBUG_ANY,
472 "monitor_back_register_entry(\"%s\"): "
473 "parent \"%s\" is volatile\n",
474 e->e_name.bv_val, e_parent->e_name.bv_val, 0 );
479 mp = monitor_entrypriv_create();
481 Debug( LDAP_DEBUG_ANY,
482 "monitor_back_register_entry(\"%s\"): "
483 "monitor_entrypriv_create() failed\n",
484 e->e_name.bv_val, 0, 0 );
489 e_new = entry_dup( e );
490 if ( e_new == NULL ) {
491 Debug( LDAP_DEBUG_ANY,
492 "monitor_back_register_entry(\"%s\"): "
493 "entry_dup() failed\n",
494 e->e_name.bv_val, 0, 0 );
499 e_new->e_private = ( void * )mp;
502 mp->mp_flags = flags;
505 mp->mp_info = mp_parent->mp_info;
506 mp->mp_flags = mp_parent->mp_flags | MONITOR_F_SUB;
510 ep = &mp_parent->mp_children;
512 mp_parent = ( monitor_entry_t * )(*ep)->e_private;
513 ep = &mp_parent->mp_next;
517 if ( monitor_cache_add( mi, e_new ) ) {
518 Debug( LDAP_DEBUG_ANY,
519 "monitor_back_register_entry(\"%s\"): "
520 "unable to add entry\n",
521 e->e_name.bv_val, 0, 0 );
532 e_new->e_private = NULL;
538 monitor_cache_release( mi, e_parent );
542 entry_limbo_t **elpp, el = { 0 };
544 el.el_type = LIMBO_ENTRY;
546 el.el_e = entry_dup( e );
547 if ( el.el_e == NULL ) {
548 Debug( LDAP_DEBUG_ANY,
549 "monitor_back_register_entry(\"%s\"): "
550 "entry_dup() failed\n",
551 e->e_name.bv_val, 0, 0 );
559 for ( elpp = &mi->mi_entry_limbo;
561 elpp = &(*elpp)->el_next )
564 *elpp = (entry_limbo_t *)ch_malloc( sizeof( entry_limbo_t ) );
565 if ( *elpp == NULL ) {
566 el.el_e->e_private = NULL;
567 entry_free( el.el_e );
579 monitor_back_register_entry_parent(
581 monitor_callback_t *cb,
582 monitor_subsys_t *mss,
584 struct berval *nbase,
586 struct berval *filter )
589 struct berval ndn = BER_BVNULL;
591 if ( be_monitor == NULL ) {
592 Debug( LDAP_DEBUG_ANY,
593 "monitor_back_register_entry_parent(base=\"%s\" scope=%s filter=\"%s\"): "
594 "monitor database not configured.\n",
595 BER_BVISNULL( nbase ) ? "" : nbase->bv_val,
596 ldap_pvt_scope2str( scope ),
597 BER_BVISNULL( filter ) ? "" : filter->bv_val );
601 mi = ( monitor_info_t * )be_monitor->be_private;
603 assert( mi != NULL );
605 assert( e->e_private == NULL );
607 if ( BER_BVISNULL( filter ) ) {
609 Debug( LDAP_DEBUG_ANY,
610 "monitor_back_register_entry_parent(\"\"): "
611 "need a valid filter\n",
616 if ( monitor_subsys_is_opened() ) {
617 Entry *e_parent = NULL,
620 struct berval e_name = BER_BVNULL,
621 e_nname = BER_BVNULL;
622 monitor_entry_t *mp = NULL,
626 if ( monitor_search2ndn( nbase, scope, filter, &ndn ) ) {
627 /* entry does not exist */
628 Debug( LDAP_DEBUG_ANY,
629 "monitor_back_register_entry_parent(\"\"): "
630 "base=\"%s\" scope=%s filter=\"%s\": "
631 "unable to find entry\n",
632 nbase->bv_val ? nbase->bv_val : "\"\"",
633 ldap_pvt_scope2str( scope ),
638 if ( monitor_cache_get( mi, &ndn, &e_parent ) != 0 ) {
639 /* entry does not exist */
640 Debug( LDAP_DEBUG_ANY,
641 "monitor_back_register_entry_parent(\"%s\"): "
642 "parent entry does not exist\n",
648 assert( e_parent->e_private != NULL );
649 mp_parent = ( monitor_entry_t * )e_parent->e_private;
651 if ( mp_parent->mp_flags & MONITOR_F_VOLATILE ) {
652 /* entry is volatile; cannot append callback */
653 Debug( LDAP_DEBUG_ANY,
654 "monitor_back_register_entry_parent(\"%s\"): "
655 "entry is volatile\n",
656 e_parent->e_name.bv_val, 0, 0 );
661 build_new_dn( &e_name, &e_parent->e_name, &e->e_name, NULL );
662 build_new_dn( &e_nname, &e_parent->e_nname, &e->e_nname, NULL );
664 if ( monitor_cache_get( mi, &e_nname, &e_new ) == 0 ) {
665 /* entry already exists */
666 Debug( LDAP_DEBUG_ANY,
667 "monitor_back_register_entry_parent(\"%s\"): "
668 "entry already exists\n",
669 e_name.bv_val, 0, 0 );
670 monitor_cache_release( mi, e_new );
676 mp = monitor_entrypriv_create();
678 Debug( LDAP_DEBUG_ANY,
679 "monitor_back_register_entry_parent(\"%s\"): "
680 "monitor_entrypriv_create() failed\n",
681 e->e_name.bv_val, 0, 0 );
686 e_new = entry_dup( e );
687 if ( e_new == NULL ) {
688 Debug( LDAP_DEBUG_ANY,
689 "monitor_back_register_entry(\"%s\"): "
690 "entry_dup() failed\n",
691 e->e_name.bv_val, 0, 0 );
695 ch_free( e_new->e_name.bv_val );
696 ch_free( e_new->e_nname.bv_val );
697 e_new->e_name = e_name;
698 e_new->e_nname = e_nname;
700 e_new->e_private = ( void * )mp;
703 mp->mp_flags = flags;
706 mp->mp_info = mp_parent->mp_info;
707 mp->mp_flags = mp_parent->mp_flags | MONITOR_F_SUB;
711 ep = &mp_parent->mp_children;
713 mp_parent = ( monitor_entry_t * )(*ep)->e_private;
714 ep = &mp_parent->mp_next;
718 if ( monitor_cache_add( mi, e_new ) ) {
719 Debug( LDAP_DEBUG_ANY,
720 "monitor_back_register_entry(\"%s\"): "
721 "unable to add entry\n",
722 e->e_name.bv_val, 0, 0 );
728 if ( !BER_BVISNULL( &ndn ) ) {
729 ch_free( ndn.bv_val );
737 e_new->e_private = NULL;
743 monitor_cache_release( mi, e_parent );
747 entry_limbo_t **elpp = NULL, el = { 0 };
749 el.el_type = LIMBO_ENTRY_PARENT;
751 el.el_e = entry_dup( e );
752 if ( el.el_e == NULL ) {
753 Debug( LDAP_DEBUG_ANY,
754 "monitor_back_register_entry(\"%s\"): "
755 "entry_dup() failed\n",
756 e->e_name.bv_val, 0, 0 );
760 if ( !BER_BVISNULL( nbase ) ) {
761 ber_dupbv( &el.el_nbase, nbase );
765 if ( !BER_BVISNULL( filter ) ) {
766 ber_dupbv( &el.el_filter, filter );
773 for ( elpp = &mi->mi_entry_limbo;
775 elpp = &(*elpp)->el_next )
778 *elpp = (entry_limbo_t *)ch_malloc( sizeof( entry_limbo_t ) );
779 if ( *elpp == NULL ) {
784 if ( *elpp != NULL ) {
789 if ( !BER_BVISNULL( &el.el_filter ) ) {
790 ch_free( el.el_filter.bv_val );
792 if ( !BER_BVISNULL( &el.el_nbase ) ) {
793 ch_free( el.el_nbase.bv_val );
795 entry_free( el.el_e );
804 monitor_search2ndn_cb( Operation *op, SlapReply *rs )
806 if ( rs->sr_type == REP_SEARCH ) {
807 struct berval *ndn = op->o_callback->sc_private;
809 if ( !BER_BVISNULL( ndn ) ) {
810 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
811 ch_free( ndn->bv_val );
816 ber_dupbv( ndn, &rs->sr_entry->e_nname );
824 struct berval *nbase,
826 struct berval *filter,
829 Connection conn = { 0 };
830 OperationBuffer opbuf;
833 SlapReply rs = { REP_RESULT };
834 slap_callback cb = { NULL, monitor_search2ndn_cb, NULL, NULL };
839 if ( be_monitor == NULL ) {
843 thrctx = ldap_pvt_thread_pool_context();
844 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
847 op->o_tag = LDAP_REQ_SEARCH;
849 /* use global malloc for now */
850 if ( op->o_tmpmemctx ) {
851 op->o_tmpmemctx = NULL;
853 op->o_tmpmfuncs = &ch_mfuncs;
855 op->o_bd = be_monitor;
856 if ( nbase == NULL || BER_BVISNULL( nbase ) ) {
857 ber_dupbv_x( &op->o_req_dn, &op->o_bd->be_suffix[ 0 ],
859 ber_dupbv_x( &op->o_req_ndn, &op->o_bd->be_nsuffix[ 0 ],
863 if ( dnPrettyNormal( NULL, nbase, &op->o_req_dn, &op->o_req_ndn,
864 op->o_tmpmemctx ) ) {
869 op->o_callback = &cb;
870 cb.sc_private = (void *)ndn;
872 op->ors_scope = scope;
873 op->ors_filter = str2filter_x( op, filter->bv_val );
874 if ( op->ors_filter == NULL ) {
878 ber_dupbv_x( &op->ors_filterstr, filter, op->o_tmpmemctx );
879 op->ors_attrs = slap_anlist_no_attrs;
880 op->ors_attrsonly = 0;
881 op->ors_tlimit = SLAP_NO_LIMIT;
883 op->ors_limit = NULL;
884 op->ors_deref = LDAP_DEREF_NEVER;
887 op->o_managedsait = SLAP_CONTROL_NONCRITICAL;
889 op->o_dn = be_monitor->be_rootdn;
890 op->o_ndn = be_monitor->be_rootndn;
892 rc = op->o_bd->be_search( op, &rs );
895 if ( op->ors_filter != NULL ) {
896 filter_free_x( op, op->ors_filter, 1 );
898 if ( !BER_BVISNULL( &op->ors_filterstr ) ) {
899 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
901 if ( !BER_BVISNULL( &op->o_req_dn ) ) {
902 op->o_tmpfree( op->o_req_dn.bv_val, op->o_tmpmemctx );
904 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
905 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
912 switch ( rs.sr_err ) {
914 if ( BER_BVISNULL( ndn ) ) {
919 case LDAP_SIZELIMIT_EXCEEDED:
921 if ( !BER_BVISNULL( ndn ) ) {
922 ber_memfree( ndn->bv_val );
933 monitor_back_register_entry_attrs(
934 struct berval *ndn_in,
936 monitor_callback_t *cb,
937 struct berval *nbase,
939 struct berval *filter )
942 struct berval ndn = BER_BVNULL;
943 char *fname = ( a == NULL ? "callback" : "attrs" );
945 if ( be_monitor == NULL ) {
946 char buf[ SLAP_TEXT_BUFLEN ];
948 snprintf( buf, sizeof( buf ),
949 "monitor_back_register_entry_%s(base=\"%s\" scope=%s filter=\"%s\"): "
950 "monitor database not configured.\n",
952 BER_BVISNULL( nbase ) ? "" : nbase->bv_val,
953 ldap_pvt_scope2str( scope ),
954 BER_BVISNULL( filter ) ? "" : filter->bv_val );
955 Debug( LDAP_DEBUG_ANY, "%s\n", buf, 0, 0 );
960 mi = ( monitor_info_t * )be_monitor->be_private;
962 assert( mi != NULL );
964 if ( ndn_in != NULL ) {
968 if ( a == NULL && cb == NULL ) {
973 if ( ( ndn_in == NULL || BER_BVISNULL( &ndn ) )
974 && BER_BVISNULL( filter ) )
977 Debug( LDAP_DEBUG_ANY,
978 "monitor_back_register_entry_%s(\"\"): "
979 "need a valid filter\n",
984 if ( monitor_subsys_is_opened() ) {
986 Attribute **atp = NULL;
987 monitor_entry_t *mp = NULL;
988 monitor_callback_t **mcp = NULL;
992 if ( BER_BVISNULL( &ndn ) ) {
993 if ( monitor_search2ndn( nbase, scope, filter, &ndn ) ) {
994 char buf[ SLAP_TEXT_BUFLEN ];
996 snprintf( buf, sizeof( buf ),
997 "monitor_back_register_entry_%s(\"\"): "
998 "base=\"%s\" scope=%s filter=\"%s\": "
999 "unable to find entry\n",
1001 nbase->bv_val ? nbase->bv_val : "\"\"",
1002 ldap_pvt_scope2str( scope ),
1005 /* entry does not exist */
1006 Debug( LDAP_DEBUG_ANY, "%s\n", buf, 0, 0 );
1013 if ( monitor_cache_get( mi, &ndn, &e ) != 0 ) {
1014 /* entry does not exist */
1015 Debug( LDAP_DEBUG_ANY,
1016 "monitor_back_register_entry_%s(\"%s\"): "
1017 "entry does not exist\n",
1018 fname, ndn.bv_val, 0 );
1023 assert( e->e_private != NULL );
1024 mp = ( monitor_entry_t * )e->e_private;
1026 if ( mp->mp_flags & MONITOR_F_VOLATILE ) {
1027 /* entry is volatile; cannot append callback */
1028 Debug( LDAP_DEBUG_ANY,
1029 "monitor_back_register_entry_%s(\"%s\"): "
1030 "entry is volatile\n",
1031 fname, e->e_name.bv_val, 0 );
1037 for ( atp = &e->e_attrs; *atp; atp = &(*atp)->a_next )
1038 /* just get to last */ ;
1040 for ( ; a != NULL; a = a->a_next ) {
1041 assert( a->a_desc != NULL );
1042 assert( a->a_vals != NULL );
1044 if ( attr_find( e->e_attrs, a->a_desc ) ) {
1045 attr_merge( e, a->a_desc, a->a_vals,
1046 a->a_nvals == a->a_vals ? NULL : a->a_nvals );
1049 *atp = attr_dup( a );
1050 if ( *atp == NULL ) {
1051 Debug( LDAP_DEBUG_ANY,
1052 "monitor_back_register_entry_%s(\"%s\"): "
1053 "attr_dup() failed\n",
1054 fname, e->e_name.bv_val, 0 );
1058 atp = &(*atp)->a_next;
1064 for ( mcp = &mp->mp_cb; *mcp; mcp = &(*mcp)->mc_next )
1067 /* NOTE: we do not clear cb->mc_next, so this function
1068 * can be used to append a list of callbacks */
1074 if ( atp && *atp ) {
1081 ber_memfree( ndn.bv_val );
1085 monitor_cache_release( mi, e );
1089 entry_limbo_t **elpp, el = { 0 };
1091 el.el_type = LIMBO_ATTRS;
1093 if ( !BER_BVISNULL( nbase ) ) {
1094 ber_dupbv( &el.el_nbase, nbase);
1096 el.el_scope = scope;
1097 if ( !BER_BVISNULL( filter ) ) {
1098 ber_dupbv( &el.el_filter, filter );
1101 el.el_a = attrs_dup( a );
1104 for ( elpp = &mi->mi_entry_limbo;
1106 elpp = &(*elpp)->el_next )
1109 *elpp = (entry_limbo_t *)ch_malloc( sizeof( entry_limbo_t ) );
1110 if ( *elpp == NULL ) {
1111 el.el_e->e_private = NULL;
1112 entry_free( el.el_e );
1116 if ( *elpp != NULL ) {
1121 if ( !BER_BVISNULL( &el.el_filter ) ) {
1122 ch_free( el.el_filter.bv_val );
1124 if ( el.el_a != NULL ) {
1125 attrs_free( el.el_a );
1127 if ( !BER_BVISNULL( &el.el_nbase ) ) {
1128 ch_free( &el.el_nbase.bv_val );
1138 monitor_back_register_entry_callback(
1140 monitor_callback_t *cb,
1141 struct berval *nbase,
1143 struct berval *filter )
1145 return monitor_back_register_entry_attrs( ndn, NULL, cb,
1146 nbase, scope, filter );
1150 * TODO: add corresponding calls to remove installed callbacks, entries
1151 * and so, in case the entity that installed them is removed (e.g. a
1152 * database, via back-config)
1155 monitor_back_unregister_entry(
1156 struct berval *ndn )
1160 if ( be_monitor == NULL ) {
1161 Debug( LDAP_DEBUG_ANY,
1162 "monitor_back_unregister_entry(\"%s\"): "
1163 "monitor database not configured.\n",
1164 ndn->bv_val, 0, 0 );
1169 /* entry will be regularly freed, and resources released
1170 * according to callbacks */
1171 if ( slapd_shutdown ) {
1175 mi = ( monitor_info_t * )be_monitor->be_private;
1177 assert( mi != NULL );
1179 if ( monitor_subsys_is_opened() ) {
1181 monitor_entry_t *mp = NULL;
1182 monitor_callback_t *cb = NULL;
1184 if ( monitor_cache_remove( mi, ndn, &e ) != 0 ) {
1185 /* entry does not exist */
1186 Debug( LDAP_DEBUG_ANY,
1187 "monitor_back_unregister_entry(\"%s\"): "
1188 "entry removal failed.\n",
1189 ndn->bv_val, 0, 0 );
1193 mp = (monitor_entry_t *)e->e_private;
1194 assert( mp != NULL );
1196 for ( cb = mp->mp_cb; cb != NULL; ) {
1197 monitor_callback_t *next = cb->mc_next;
1199 if ( cb->mc_free ) {
1200 (void)cb->mc_free( e, &cb->mc_private );
1208 e->e_private = NULL;
1212 entry_limbo_t **elpp;
1214 for ( elpp = &mi->mi_entry_limbo;
1216 elpp = &(*elpp)->el_next )
1218 entry_limbo_t *elp = *elpp;
1220 if ( elp->el_type == LIMBO_ENTRY
1221 && dn_match( ndn, &elp->el_e->e_nname ) )
1223 monitor_callback_t *cb, *next;
1225 for ( cb = elp->el_cb; cb; cb = next ) {
1226 /* FIXME: call callbacks? */
1228 if ( cb->mc_dispose ) {
1229 cb->mc_dispose( &cb->mc_private );
1233 assert( elp->el_e != NULL );
1234 elp->el_e->e_private = NULL;
1235 entry_free( elp->el_e );
1236 *elpp = elp->el_next;
1243 if ( elpp != NULL ) {
1244 /* not found! where did it go? */
1253 monitor_back_unregister_entry_parent(
1254 struct berval *nrdn,
1255 monitor_callback_t *target_cb,
1256 struct berval *nbase,
1258 struct berval *filter )
1261 struct berval ndn = BER_BVNULL;
1263 if ( be_monitor == NULL ) {
1264 Debug( LDAP_DEBUG_ANY,
1265 "monitor_back_unregister_entry_parent(base=\"%s\" scope=%s filter=\"%s\"): "
1266 "monitor database not configured.\n",
1267 BER_BVISNULL( nbase ) ? "" : nbase->bv_val,
1268 ldap_pvt_scope2str( scope ),
1269 BER_BVISNULL( filter ) ? "" : filter->bv_val );
1274 /* entry will be regularly freed, and resources released
1275 * according to callbacks */
1276 if ( slapd_shutdown ) {
1280 mi = ( monitor_info_t * )be_monitor->be_private;
1282 assert( mi != NULL );
1284 if ( ( nrdn == NULL || BER_BVISNULL( nrdn ) )
1285 && BER_BVISNULL( filter ) )
1288 Debug( LDAP_DEBUG_ANY,
1289 "monitor_back_unregister_entry_parent(\"\"): "
1290 "need a valid filter\n",
1295 if ( monitor_subsys_is_opened() ) {
1297 monitor_entry_t *mp = NULL;
1299 if ( monitor_search2ndn( nbase, scope, filter, &ndn ) ) {
1300 /* entry does not exist */
1301 Debug( LDAP_DEBUG_ANY,
1302 "monitor_back_unregister_entry_parent(\"\"): "
1303 "base=\"%s\" scope=%s filter=\"%s\": "
1304 "unable to find entry\n",
1305 nbase->bv_val ? nbase->bv_val : "\"\"",
1306 ldap_pvt_scope2str( scope ),
1311 if ( monitor_cache_remove( mi, &ndn, &e ) != 0 ) {
1312 /* entry does not exist */
1313 Debug( LDAP_DEBUG_ANY,
1314 "monitor_back_unregister_entry(\"%s\"): "
1315 "entry removal failed.\n",
1317 ber_memfree( ndn.bv_val );
1320 ber_memfree( ndn.bv_val );
1322 mp = (monitor_entry_t *)e->e_private;
1323 assert( mp != NULL );
1325 if ( target_cb != NULL ) {
1326 monitor_callback_t **cbp;
1328 for ( cbp = &mp->mp_cb; *cbp != NULL; cbp = &(*cbp)->mc_next ) {
1329 if ( *cbp == target_cb ) {
1330 if ( (*cbp)->mc_free ) {
1331 (void)(*cbp)->mc_free( e, &(*cbp)->mc_private );
1333 *cbp = (*cbp)->mc_next;
1334 ch_free( target_cb );
1342 e->e_private = NULL;
1346 entry_limbo_t **elpp;
1348 for ( elpp = &mi->mi_entry_limbo;
1350 elpp = &(*elpp)->el_next )
1352 entry_limbo_t *elp = *elpp;
1354 if ( elp->el_type == LIMBO_ENTRY_PARENT
1355 && dn_match( nrdn, &elp->el_e->e_nname )
1356 && dn_match( nbase, &elp->el_nbase )
1357 && scope == elp->el_scope
1358 && bvmatch( filter, &elp->el_filter ) )
1360 monitor_callback_t *cb, *next;
1362 for ( cb = elp->el_cb; cb; cb = next ) {
1363 /* FIXME: call callbacks? */
1365 if ( cb->mc_dispose ) {
1366 cb->mc_dispose( &cb->mc_private );
1370 assert( elp->el_e != NULL );
1371 elp->el_e->e_private = NULL;
1372 entry_free( elp->el_e );
1373 if ( !BER_BVISNULL( &elp->el_nbase ) ) {
1374 ch_free( elp->el_nbase.bv_val );
1376 if ( !BER_BVISNULL( &elp->el_filter ) ) {
1377 ch_free( elp->el_filter.bv_val );
1379 *elpp = elp->el_next;
1386 if ( elpp != NULL ) {
1387 /* not found! where did it go? */
1396 monitor_back_unregister_entry_attrs(
1397 struct berval *ndn_in,
1398 Attribute *target_a,
1399 monitor_callback_t *target_cb,
1400 struct berval *nbase,
1402 struct berval *filter )
1405 struct berval ndn = BER_BVNULL;
1406 char *fname = ( target_a == NULL ? "callback" : "attrs" );
1408 if ( be_monitor == NULL ) {
1409 char buf[ SLAP_TEXT_BUFLEN ];
1411 snprintf( buf, sizeof( buf ),
1412 "monitor_back_unregister_entry_%s(base=\"%s\" scope=%s filter=\"%s\"): "
1413 "monitor database not configured.\n",
1415 BER_BVISNULL( nbase ) ? "" : nbase->bv_val,
1416 ldap_pvt_scope2str( scope ),
1417 BER_BVISNULL( filter ) ? "" : filter->bv_val );
1418 Debug( LDAP_DEBUG_ANY, "%s\n", buf, 0, 0 );
1423 /* entry will be regularly freed, and resources released
1424 * according to callbacks */
1425 if ( slapd_shutdown ) {
1429 mi = ( monitor_info_t * )be_monitor->be_private;
1431 assert( mi != NULL );
1433 if ( ndn_in != NULL ) {
1437 if ( target_a == NULL && target_cb == NULL ) {
1442 if ( ( ndn_in == NULL || BER_BVISNULL( &ndn ) )
1443 && BER_BVISNULL( filter ) )
1446 Debug( LDAP_DEBUG_ANY,
1447 "monitor_back_unregister_entry_%s(\"\"): "
1448 "need a valid filter\n",
1453 if ( monitor_subsys_is_opened() ) {
1455 monitor_entry_t *mp = NULL;
1458 if ( BER_BVISNULL( &ndn ) ) {
1459 if ( monitor_search2ndn( nbase, scope, filter, &ndn ) ) {
1460 char buf[ SLAP_TEXT_BUFLEN ];
1462 snprintf( buf, sizeof( buf ),
1463 "monitor_back_unregister_entry_%s(\"\"): "
1464 "base=\"%s\" scope=%d filter=\"%s\": "
1465 "unable to find entry\n",
1467 nbase->bv_val ? nbase->bv_val : "\"\"",
1468 scope, filter->bv_val );
1470 /* entry does not exist */
1471 Debug( LDAP_DEBUG_ANY, "%s\n", buf, 0, 0 );
1478 if ( monitor_cache_get( mi, &ndn, &e ) != 0 ) {
1479 /* entry does not exist */
1480 Debug( LDAP_DEBUG_ANY,
1481 "monitor_back_unregister_entry(\"%s\"): "
1482 "entry removal failed.\n",
1487 mp = (monitor_entry_t *)e->e_private;
1488 assert( mp != NULL );
1490 if ( target_cb != NULL ) {
1491 monitor_callback_t **cbp;
1493 for ( cbp = &mp->mp_cb; *cbp != NULL; cbp = &(*cbp)->mc_next ) {
1494 if ( *cbp == target_cb ) {
1495 if ( (*cbp)->mc_free ) {
1496 (void)(*cbp)->mc_free( e, &(*cbp)->mc_private );
1498 *cbp = (*cbp)->mc_next;
1499 ch_free( target_cb );
1505 if ( target_a != NULL ) {
1508 for ( a = target_a; a != NULL; a = a->a_next ) {
1509 Modification mod = { 0 };
1511 char textbuf[ SLAP_TEXT_BUFLEN ];
1513 mod.sm_op = LDAP_MOD_DELETE;
1514 mod.sm_desc = a->a_desc;
1515 mod.sm_values = a->a_vals;
1516 mod.sm_nvalues = a->a_nvals;
1518 (void)modify_delete_values( e, &mod, 1,
1519 &text, textbuf, sizeof( textbuf ) );
1524 ber_memfree( ndn.bv_val );
1527 monitor_cache_release( mi, e );
1530 entry_limbo_t **elpp;
1532 for ( elpp = &mi->mi_entry_limbo;
1534 elpp = &(*elpp)->el_next )
1536 entry_limbo_t *elp = *elpp;
1538 if ( elp->el_type == LIMBO_ATTRS
1539 && dn_match( nbase, &elp->el_nbase )
1540 && scope == elp->el_scope
1541 && bvmatch( filter, &elp->el_filter ) )
1543 monitor_callback_t *cb, *next;
1545 for ( cb = elp->el_cb; cb; cb = next ) {
1546 /* FIXME: call callbacks? */
1548 if ( cb->mc_dispose ) {
1549 cb->mc_dispose( &cb->mc_private );
1553 assert( elp->el_e == NULL );
1554 if ( elp->el_a != NULL ) {
1555 attrs_free( elp->el_a );
1557 if ( !BER_BVISNULL( &elp->el_nbase ) ) {
1558 ch_free( elp->el_nbase.bv_val );
1560 if ( !BER_BVISNULL( &elp->el_filter ) ) {
1561 ch_free( elp->el_filter.bv_val );
1563 *elpp = elp->el_next;
1570 if ( elpp != NULL ) {
1571 /* not found! where did it go? */
1580 monitor_back_unregister_entry_callback(
1582 monitor_callback_t *cb,
1583 struct berval *nbase,
1585 struct berval *filter )
1587 /* TODO: lookup entry (by ndn, if not NULL, and/or by callback);
1588 * unregister the callback; if a is not null, unregister the
1589 * given attrs. In any case, call cb->cb_free */
1590 return monitor_back_unregister_entry_attrs( ndn,
1591 NULL, cb, nbase, scope, filter );
1595 monitor_back_get_subsys( const char *name )
1597 if ( monitor_subsys != NULL ) {
1600 for ( i = 0; monitor_subsys[ i ] != NULL; i++ ) {
1601 if ( strcasecmp( monitor_subsys[ i ]->mss_name, name ) == 0 ) {
1602 return monitor_subsys[ i ];
1611 monitor_back_get_subsys_by_dn(
1615 if ( monitor_subsys != NULL ) {
1619 for ( i = 0; monitor_subsys[ i ] != NULL; i++ ) {
1620 if ( dnIsSuffix( ndn, &monitor_subsys[ i ]->mss_ndn ) ) {
1621 return monitor_subsys[ i ];
1626 for ( i = 0; monitor_subsys[ i ] != NULL; i++ ) {
1627 if ( dn_match( ndn, &monitor_subsys[ i ]->mss_ndn ) ) {
1628 return monitor_subsys[ i ];
1638 monitor_back_initialize(
1641 static char *controls[] = {
1642 LDAP_CONTROL_MANAGEDSAIT,
1646 static ConfigTable monitorcfg[] = {
1647 { NULL, NULL, 0, 0, 0, ARG_IGNORED,
1648 NULL, NULL, NULL, NULL }
1651 static ConfigOCs monitorocs[] = {
1652 { "( OLcfgDbOc:4.1 "
1653 "NAME 'olcMonitorConfig' "
1654 "DESC 'Monitor backend configuration' "
1655 "SUP olcDatabaseConfig "
1657 Cft_Database, monitorcfg },
1666 { "( 1.3.6.1.4.1.4203.666.3.16.1 "
1668 "DESC 'OpenLDAP system monitoring' "
1669 "SUP top STRUCTURAL "
1678 ") )", SLAP_OC_OPERATIONAL|SLAP_OC_HIDE,
1679 offsetof(monitor_info_t, mi_oc_monitor) },
1680 { "( 1.3.6.1.4.1.4203.666.3.16.2 "
1681 "NAME 'monitorServer' "
1682 "DESC 'Server monitoring root entry' "
1683 "SUP monitor STRUCTURAL )", SLAP_OC_OPERATIONAL|SLAP_OC_HIDE,
1684 offsetof(monitor_info_t, mi_oc_monitorServer) },
1685 { "( 1.3.6.1.4.1.4203.666.3.16.3 "
1686 "NAME 'monitorContainer' "
1687 "DESC 'monitor container class' "
1688 "SUP monitor STRUCTURAL )", SLAP_OC_OPERATIONAL|SLAP_OC_HIDE,
1689 offsetof(monitor_info_t, mi_oc_monitorContainer) },
1690 { "( 1.3.6.1.4.1.4203.666.3.16.4 "
1691 "NAME 'monitorCounterObject' "
1692 "DESC 'monitor counter class' "
1693 "SUP monitor STRUCTURAL )", SLAP_OC_OPERATIONAL|SLAP_OC_HIDE,
1694 offsetof(monitor_info_t, mi_oc_monitorCounterObject) },
1695 { "( 1.3.6.1.4.1.4203.666.3.16.5 "
1696 "NAME 'monitorOperation' "
1697 "DESC 'monitor operation class' "
1698 "SUP monitor STRUCTURAL )", SLAP_OC_OPERATIONAL|SLAP_OC_HIDE,
1699 offsetof(monitor_info_t, mi_oc_monitorOperation) },
1700 { "( 1.3.6.1.4.1.4203.666.3.16.6 "
1701 "NAME 'monitorConnection' "
1702 "DESC 'monitor connection class' "
1703 "SUP monitor STRUCTURAL )", SLAP_OC_OPERATIONAL|SLAP_OC_HIDE,
1704 offsetof(monitor_info_t, mi_oc_monitorConnection) },
1705 { "( 1.3.6.1.4.1.4203.666.3.16.7 "
1706 "NAME 'managedObject' "
1707 "DESC 'monitor managed entity class' "
1708 "SUP monitor STRUCTURAL )", SLAP_OC_OPERATIONAL|SLAP_OC_HIDE,
1709 offsetof(monitor_info_t, mi_oc_managedObject) },
1710 { "( 1.3.6.1.4.1.4203.666.3.16.8 "
1711 "NAME 'monitoredObject' "
1712 "DESC 'monitor monitored entity class' "
1713 "SUP monitor STRUCTURAL )", SLAP_OC_OPERATIONAL|SLAP_OC_HIDE,
1714 offsetof(monitor_info_t, mi_oc_monitoredObject) },
1717 { "( 1.3.6.1.4.1.4203.666.1.55.1 "
1718 "NAME 'monitoredInfo' "
1719 "DESC 'monitored info' "
1721 "EQUALITY caseIgnoreMatch "
1722 "SUBSTR caseIgnoreSubstringsMatch "
1723 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15{32768} "
1724 "NO-USER-MODIFICATION "
1725 "USAGE dSAOperation )", SLAP_AT_HIDE,
1726 offsetof(monitor_info_t, mi_ad_monitoredInfo) },
1727 { "( 1.3.6.1.4.1.4203.666.1.55.2 "
1728 "NAME 'managedInfo' "
1729 "DESC 'monitor managed info' "
1730 "SUP name )", SLAP_AT_HIDE,
1731 offsetof(monitor_info_t, mi_ad_managedInfo) },
1732 { "( 1.3.6.1.4.1.4203.666.1.55.3 "
1733 "NAME 'monitorCounter' "
1734 "DESC 'monitor counter' "
1735 "EQUALITY integerMatch "
1736 "ORDERING integerOrderingMatch "
1737 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
1738 "NO-USER-MODIFICATION "
1739 "USAGE dSAOperation )", SLAP_AT_HIDE,
1740 offsetof(monitor_info_t, mi_ad_monitorCounter) },
1741 { "( 1.3.6.1.4.1.4203.666.1.55.4 "
1742 "NAME 'monitorOpCompleted' "
1743 "DESC 'monitor completed operations' "
1744 "SUP monitorCounter "
1745 "NO-USER-MODIFICATION "
1746 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1747 offsetof(monitor_info_t, mi_ad_monitorOpCompleted) },
1748 { "( 1.3.6.1.4.1.4203.666.1.55.5 "
1749 "NAME 'monitorOpInitiated' "
1750 "DESC 'monitor initiated operations' "
1751 "SUP monitorCounter "
1752 "NO-USER-MODIFICATION "
1753 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1754 offsetof(monitor_info_t, mi_ad_monitorOpInitiated) },
1755 { "( 1.3.6.1.4.1.4203.666.1.55.6 "
1756 "NAME 'monitorConnectionNumber' "
1757 "DESC 'monitor connection number' "
1758 "SUP monitorCounter "
1759 "NO-USER-MODIFICATION "
1760 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1761 offsetof(monitor_info_t, mi_ad_monitorConnectionNumber) },
1762 { "( 1.3.6.1.4.1.4203.666.1.55.7 "
1763 "NAME 'monitorConnectionAuthzDN' "
1764 "DESC 'monitor connection authorization DN' "
1765 /* "SUP distinguishedName " */
1766 "EQUALITY distinguishedNameMatch "
1767 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.12 "
1768 "NO-USER-MODIFICATION "
1769 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1770 offsetof(monitor_info_t, mi_ad_monitorConnectionAuthzDN) },
1771 { "( 1.3.6.1.4.1.4203.666.1.55.8 "
1772 "NAME 'monitorConnectionLocalAddress' "
1773 "DESC 'monitor connection local address' "
1774 "SUP monitoredInfo "
1775 "NO-USER-MODIFICATION "
1776 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1777 offsetof(monitor_info_t, mi_ad_monitorConnectionLocalAddress) },
1778 { "( 1.3.6.1.4.1.4203.666.1.55.9 "
1779 "NAME 'monitorConnectionPeerAddress' "
1780 "DESC 'monitor connection peer address' "
1781 "SUP monitoredInfo "
1782 "NO-USER-MODIFICATION "
1783 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1784 offsetof(monitor_info_t, mi_ad_monitorConnectionPeerAddress) },
1785 { "( 1.3.6.1.4.1.4203.666.1.55.10 "
1786 "NAME 'monitorTimestamp' "
1787 "DESC 'monitor timestamp' "
1788 "EQUALITY generalizedTimeMatch "
1789 "ORDERING generalizedTimeOrderingMatch "
1790 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.24 "
1792 "NO-USER-MODIFICATION "
1793 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1794 offsetof(monitor_info_t, mi_ad_monitorTimestamp) },
1795 { "( 1.3.6.1.4.1.4203.666.1.55.11 "
1796 "NAME 'monitorOverlay' "
1797 "DESC 'name of overlays defined for a given database' "
1798 "SUP monitoredInfo "
1799 "NO-USER-MODIFICATION "
1800 "USAGE dSAOperation )", SLAP_AT_HIDE,
1801 offsetof(monitor_info_t, mi_ad_monitorOverlay) },
1802 { "( 1.3.6.1.4.1.4203.666.1.55.12 "
1804 "DESC 'read/write status of a given database' "
1805 "EQUALITY booleanMatch "
1806 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.7 "
1808 "USAGE dSAOperation )", SLAP_AT_HIDE,
1809 offsetof(monitor_info_t, mi_ad_readOnly) },
1810 { "( 1.3.6.1.4.1.4203.666.1.55.13 "
1811 "NAME 'restrictedOperation' "
1812 "DESC 'name of restricted operation for a given database' "
1813 "SUP managedInfo )", SLAP_AT_HIDE,
1814 offsetof(monitor_info_t, mi_ad_restrictedOperation ) },
1815 { "( 1.3.6.1.4.1.4203.666.1.55.14 "
1816 "NAME 'monitorConnectionProtocol' "
1817 "DESC 'monitor connection protocol' "
1818 "SUP monitoredInfo "
1819 "NO-USER-MODIFICATION "
1820 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1821 offsetof(monitor_info_t, mi_ad_monitorConnectionProtocol) },
1822 { "( 1.3.6.1.4.1.4203.666.1.55.15 "
1823 "NAME 'monitorConnectionOpsReceived' "
1824 "DESC 'monitor number of operations received by the connection' "
1825 "SUP monitorCounter "
1826 "NO-USER-MODIFICATION "
1827 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1828 offsetof(monitor_info_t, mi_ad_monitorConnectionOpsReceived) },
1829 { "( 1.3.6.1.4.1.4203.666.1.55.16 "
1830 "NAME 'monitorConnectionOpsExecuting' "
1831 "DESC 'monitor number of operations in execution within the connection' "
1832 "SUP monitorCounter "
1833 "NO-USER-MODIFICATION "
1834 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1835 offsetof(monitor_info_t, mi_ad_monitorConnectionOpsExecuting) },
1836 { "( 1.3.6.1.4.1.4203.666.1.55.17 "
1837 "NAME 'monitorConnectionOpsPending' "
1838 "DESC 'monitor number of pending operations within the connection' "
1839 "SUP monitorCounter "
1840 "NO-USER-MODIFICATION "
1841 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1842 offsetof(monitor_info_t, mi_ad_monitorConnectionOpsPending) },
1843 { "( 1.3.6.1.4.1.4203.666.1.55.18 "
1844 "NAME 'monitorConnectionOpsCompleted' "
1845 "DESC 'monitor number of operations completed within the connection' "
1846 "SUP monitorCounter "
1847 "NO-USER-MODIFICATION "
1848 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1849 offsetof(monitor_info_t, mi_ad_monitorConnectionOpsCompleted) },
1850 { "( 1.3.6.1.4.1.4203.666.1.55.19 "
1851 "NAME 'monitorConnectionGet' "
1852 "DESC 'number of times connection_get() was called so far' "
1853 "SUP monitorCounter "
1854 "NO-USER-MODIFICATION "
1855 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1856 offsetof(monitor_info_t, mi_ad_monitorConnectionGet) },
1857 { "( 1.3.6.1.4.1.4203.666.1.55.20 "
1858 "NAME 'monitorConnectionRead' "
1859 "DESC 'number of times connection_read() was called so far' "
1860 "SUP monitorCounter "
1861 "NO-USER-MODIFICATION "
1862 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1863 offsetof(monitor_info_t, mi_ad_monitorConnectionRead) },
1864 { "( 1.3.6.1.4.1.4203.666.1.55.21 "
1865 "NAME 'monitorConnectionWrite' "
1866 "DESC 'number of times connection_write() was called so far' "
1867 "SUP monitorCounter "
1868 "NO-USER-MODIFICATION "
1869 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1870 offsetof(monitor_info_t, mi_ad_monitorConnectionWrite) },
1871 { "( 1.3.6.1.4.1.4203.666.1.55.22 "
1872 "NAME 'monitorConnectionMask' "
1873 "DESC 'monitor connection mask' "
1874 "SUP monitoredInfo "
1875 "NO-USER-MODIFICATION "
1876 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1877 offsetof(monitor_info_t, mi_ad_monitorConnectionMask) },
1878 { "( 1.3.6.1.4.1.4203.666.1.55.23 "
1879 "NAME 'monitorConnectionListener' "
1880 "DESC 'monitor connection listener' "
1881 "SUP monitoredInfo "
1882 "NO-USER-MODIFICATION "
1883 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1884 offsetof(monitor_info_t, mi_ad_monitorConnectionListener) },
1885 { "( 1.3.6.1.4.1.4203.666.1.55.24 "
1886 "NAME 'monitorConnectionPeerDomain' "
1887 "DESC 'monitor connection peer domain' "
1888 "SUP monitoredInfo "
1889 "NO-USER-MODIFICATION "
1890 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1891 offsetof(monitor_info_t, mi_ad_monitorConnectionPeerDomain) },
1892 { "( 1.3.6.1.4.1.4203.666.1.55.25 "
1893 "NAME 'monitorConnectionStartTime' "
1894 "DESC 'monitor connection start time' "
1895 "SUP monitorTimestamp "
1897 "NO-USER-MODIFICATION "
1898 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1899 offsetof(monitor_info_t, mi_ad_monitorConnectionStartTime) },
1900 { "( 1.3.6.1.4.1.4203.666.1.55.26 "
1901 "NAME 'monitorConnectionActivityTime' "
1902 "DESC 'monitor connection activity time' "
1903 "SUP monitorTimestamp "
1905 "NO-USER-MODIFICATION "
1906 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1907 offsetof(monitor_info_t, mi_ad_monitorConnectionActivityTime) },
1908 { "( 1.3.6.1.4.1.4203.666.1.55.27 "
1909 "NAME 'monitorIsShadow' "
1910 "DESC 'TRUE if the database is shadow' "
1911 "EQUALITY booleanMatch "
1912 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.7 "
1914 "USAGE dSAOperation )", SLAP_AT_HIDE,
1915 offsetof(monitor_info_t, mi_ad_monitorIsShadow) },
1916 { "( 1.3.6.1.4.1.4203.666.1.55.28 "
1917 "NAME 'monitorUpdateRef' "
1918 "DESC 'update referral for shadow databases' "
1919 "SUP monitoredInfo "
1921 "USAGE dSAOperation )", SLAP_AT_HIDE,
1922 offsetof(monitor_info_t, mi_ad_monitorUpdateRef) },
1923 { "( 1.3.6.1.4.1.4203.666.1.55.29 "
1924 "NAME 'monitorRuntimeConfig' "
1925 "DESC 'TRUE if component allows runtime configuration' "
1926 "EQUALITY booleanMatch "
1927 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.7 "
1929 "USAGE dSAOperation )", SLAP_AT_HIDE,
1930 offsetof(monitor_info_t, mi_ad_monitorRuntimeConfig) },
1931 { "( 1.3.6.1.4.1.4203.666.1.55.30 "
1932 "NAME 'monitorSuperiorDN' "
1933 "DESC 'monitor superior DN' "
1934 /* "SUP distinguishedName " */
1935 "EQUALITY distinguishedNameMatch "
1936 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.12 "
1937 "NO-USER-MODIFICATION "
1938 "USAGE dSAOperation )", SLAP_AT_FINAL|SLAP_AT_HIDE,
1939 offsetof(monitor_info_t, mi_ad_monitorSuperiorDN) },
1947 { "olmAttributes", "1.3.6.1.4.1.4203.666.1.55" },
1948 { "olmSubSystemAttributes", "olmAttributes:0" },
1949 { "olmGenericAttributes", "olmSubSystemAttributes:0" },
1950 { "olmDatabaseAttributes", "olmSubSystemAttributes:1" },
1952 /* for example, back-bdb specific attrs
1953 * are in "olmDatabaseAttributes:1"
1955 * NOTE: developers, please record here OID assignments
1956 * for other modules */
1958 { "olmObjectClasses", "1.3.6.1.4.1.4203.666.3.16" },
1959 { "olmSubSystemObjectClasses", "olmObjectClasses:0" },
1960 { "olmGenericObjectClasses", "olmSubSystemObjectClasses:0" },
1961 { "olmDatabaseObjectClasses", "olmSubSystemObjectClasses:1" },
1963 /* for example, back-bdb specific objectClasses
1964 * are in "olmDatabaseObjectClasses:1"
1966 * NOTE: developers, please record here OID assignments
1967 * for other modules */
1973 monitor_info_t *mi = &monitor_info;
1977 argv[ 0 ] = "monitor";
1982 for ( i = 0; s_oid[ i ].name; i++ ) {
1983 argv[ 1 ] = s_oid[ i ].name;
1984 argv[ 2 ] = s_oid[ i ].oid;
1986 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
1987 Debug( LDAP_DEBUG_ANY,
1988 "monitor_back_initialize: unable to add "
1989 "objectIdentifier \"%s=%s\"\n",
1990 s_oid[ i ].name, s_oid[ i ].oid, 0 );
1995 /* schema integration */
1996 for ( i = 0; mat[ i ].schema; i++ ) {
1998 AttributeDescription **ad =
1999 ((AttributeDescription **)&(((char *)mi)[ mat[ i ].offset ]));
2002 code = register_at( mat[ i ].schema, ad, 0 );
2005 Debug( LDAP_DEBUG_ANY,
2006 "monitor_back_db_init: register_at failed\n", 0, 0, 0 );
2009 (*ad)->ad_type->sat_flags |= mat[ i ].flags;
2012 for ( i = 0; moc[ i ].schema; i++ ) {
2015 ((ObjectClass **)&(((char *)mi)[ moc[ i ].offset ]));
2017 code = register_oc( moc[ i ].schema, Oc, 0 );
2019 Debug( LDAP_DEBUG_ANY,
2020 "monitor_back_db_init: register_oc failed\n", 0, 0, 0 );
2023 (*Oc)->soc_flags |= moc[ i ].flags;
2026 bi->bi_controls = controls;
2030 bi->bi_config = monitor_back_config;
2034 bi->bi_db_init = monitor_back_db_init;
2036 bi->bi_db_config = monitor_back_db_config;
2038 bi->bi_db_open = monitor_back_db_open;
2039 bi->bi_db_close = 0;
2040 bi->bi_db_destroy = monitor_back_db_destroy;
2042 bi->bi_op_bind = monitor_back_bind;
2043 bi->bi_op_unbind = 0;
2044 bi->bi_op_search = monitor_back_search;
2045 bi->bi_op_compare = monitor_back_compare;
2046 bi->bi_op_modify = monitor_back_modify;
2047 bi->bi_op_modrdn = 0;
2049 bi->bi_op_delete = 0;
2050 bi->bi_op_abandon = 0;
2052 bi->bi_extended = 0;
2054 bi->bi_entry_release_rw = 0;
2055 bi->bi_chk_referrals = 0;
2056 bi->bi_operational = monitor_back_operational;
2059 * hooks for slap tools
2061 bi->bi_tool_entry_open = 0;
2062 bi->bi_tool_entry_close = 0;
2063 bi->bi_tool_entry_first = 0;
2064 bi->bi_tool_entry_first_x = 0;
2065 bi->bi_tool_entry_next = 0;
2066 bi->bi_tool_entry_get = 0;
2067 bi->bi_tool_entry_put = 0;
2068 bi->bi_tool_entry_reindex = 0;
2069 bi->bi_tool_sync = 0;
2070 bi->bi_tool_dn2id_get = 0;
2071 bi->bi_tool_entry_modify = 0;
2073 bi->bi_connection_init = 0;
2074 bi->bi_connection_destroy = 0;
2076 bi->bi_extra = (void *)&monitor_extra;
2079 * configuration objectClasses (fake)
2081 bi->bi_cf_ocs = monitorocs;
2083 rc = config_register_schema( monitorcfg, monitorocs );
2092 monitor_back_db_init(
2097 struct berval dn = BER_BVC( SLAPD_MONITOR_DN ),
2102 monitor_subsys_t *ms;
2105 * database monitor can be defined once only
2107 if ( be_monitor != NULL ) {
2109 snprintf(c->msg, sizeof(c->msg),"only one monitor database allowed");
2118 for ( ms = known_monitor_subsys; ms->mss_name != NULL; ms++ ) {
2119 if ( monitor_back_register_subsys( ms ) ) {
2124 /* indicate system schema supported */
2125 SLAP_BFLAGS(be) |= SLAP_BFLAG_MONITOR;
2127 rc = dnPrettyNormal( NULL, &dn, &pdn, &ndn, NULL );
2128 if( rc != LDAP_SUCCESS ) {
2129 Debug( LDAP_DEBUG_ANY,
2130 "unable to normalize/pretty monitor DN \"%s\" (%d)\n",
2135 ber_bvarray_add( &be->be_suffix, &pdn );
2136 ber_bvarray_add( &be->be_nsuffix, &ndn );
2138 /* NOTE: only one monitor database is allowed,
2139 * so we use static storage */
2140 ldap_pvt_thread_mutex_init( &monitor_info.mi_cache_mutex );
2142 be->be_private = &monitor_info;
2144 be2 = select_backend( &ndn, 0 );
2146 char *type = be2->bd_info->bi_type;
2148 if ( overlay_is_over( be2 ) ) {
2149 slap_overinfo *oi = (slap_overinfo *)be2->bd_info->bi_private;
2150 type = oi->oi_orig->bi_type;
2154 snprintf(c->msg, sizeof(c->msg),
2155 "\"monitor\" database serving namingContext \"%s\" "
2156 "is hidden by \"%s\" database serving namingContext \"%s\".\n",
2157 pdn.bv_val, type, be2->be_nsuffix[ 0 ].bv_val );
2166 monitor_back_destroy_limbo_entry(
2171 entry_free( el->el_e );
2174 attrs_free( el->el_a );
2176 if ( !BER_BVISNULL( &el->el_nbase ) ) {
2177 ber_memfree( el->el_nbase.bv_val );
2179 if ( !BER_BVISNULL( &el->el_filter ) ) {
2180 ber_memfree( el->el_filter.bv_val );
2183 /* NOTE: callbacks are not copied; so only free them
2184 * if disposing of */
2185 if ( el->el_cb && dispose != 0 ) {
2186 monitor_callback_t *next;
2188 for ( ; el->el_cb; el->el_cb = next ) {
2189 next = el->el_cb->mc_next;
2190 if ( el->el_cb->mc_dispose ) {
2191 el->el_cb->mc_dispose( &el->el_cb->mc_private );
2193 ch_free( el->el_cb );
2201 monitor_back_db_open(
2205 monitor_info_t *mi = (monitor_info_t *)be->be_private;
2206 struct monitor_subsys_t **ms;
2207 Entry *e, **ep, *root;
2208 monitor_entry_t *mp;
2210 struct berval bv, rdn = BER_BVC(SLAPD_MONITOR_DN);
2212 static char tmbuf[ LDAP_LUTIL_GENTIME_BUFSIZE ];
2213 struct berval desc[] = {
2214 BER_BVC("This subtree contains monitoring/managing objects."),
2215 BER_BVC("This object contains information about this server."),
2216 BER_BVC("Most of the information is held in operational"
2217 " attributes, which must be explicitly requested."),
2222 assert( be_monitor != NULL );
2223 if ( be != be_monitor ) {
2230 ldap_pvt_gmtime( &starttime, &tms );
2231 lutil_gentime( tmbuf, sizeof(tmbuf), &tms );
2233 mi->mi_startTime.bv_val = tmbuf;
2234 mi->mi_startTime.bv_len = strlen( tmbuf );
2236 if ( BER_BVISEMPTY( &be->be_rootdn ) ) {
2237 BER_BVSTR( &mi->mi_creatorsName, SLAPD_ANONYMOUS );
2238 BER_BVSTR( &mi->mi_ncreatorsName, SLAPD_ANONYMOUS );
2240 mi->mi_creatorsName = be->be_rootdn;
2241 mi->mi_ncreatorsName = be->be_rootndn;
2245 * creates the "cn=Monitor" entry
2247 e = monitor_entry_stub( NULL, NULL, &rdn, mi->mi_oc_monitorServer, mi,
2251 Debug( LDAP_DEBUG_ANY,
2252 "unable to create \"%s\" entry\n",
2253 SLAPD_MONITOR_DN, 0, 0 );
2257 attr_merge_normalize( e, slap_schema.si_ad_description, desc, NULL );
2259 bv.bv_val = strchr( (char *) Versionstr, '$' );
2260 if ( bv.bv_val != NULL ) {
2264 for ( ; bv.bv_val[ 0 ] == ' '; bv.bv_val++ )
2267 end = strchr( bv.bv_val, '$' );
2268 if ( end != NULL ) {
2271 for ( ; end > bv.bv_val && end[ 0 ] == ' '; end-- )
2276 bv.bv_len = end - bv.bv_val;
2279 bv.bv_len = strlen( bv.bv_val );
2282 if ( attr_merge_normalize_one( e, mi->mi_ad_monitoredInfo,
2284 Debug( LDAP_DEBUG_ANY,
2285 "unable to add monitoredInfo to \"%s\" entry\n",
2286 SLAPD_MONITOR_DN, 0, 0 );
2291 mp = monitor_entrypriv_create();
2295 e->e_private = ( void * )mp;
2296 ep = &mp->mp_children;
2298 if ( monitor_cache_add( mi, e ) ) {
2299 Debug( LDAP_DEBUG_ANY,
2300 "unable to add entry \"%s\" to cache\n",
2301 SLAPD_MONITOR_DN, 0, 0 );
2307 * Create all the subsystem specific entries
2309 for ( i = 0; monitor_subsys[ i ] != NULL; i++ ) {
2310 int len = strlen( monitor_subsys[ i ]->mss_name );
2314 dn.bv_len = len + sizeof( "cn=" ) - 1;
2315 dn.bv_val = ch_calloc( sizeof( char ), dn.bv_len + 1 );
2316 strcpy( dn.bv_val, "cn=" );
2317 strcat( dn.bv_val, monitor_subsys[ i ]->mss_name );
2318 rc = dnPretty( NULL, &dn, &monitor_subsys[ i ]->mss_rdn, NULL );
2320 if ( rc != LDAP_SUCCESS ) {
2321 Debug( LDAP_DEBUG_ANY,
2322 "monitor RDN \"%s\" is invalid\n",
2327 e = monitor_entry_stub( &root->e_name, &root->e_nname,
2328 &monitor_subsys[ i ]->mss_rdn, mi->mi_oc_monitorContainer, mi,
2332 Debug( LDAP_DEBUG_ANY,
2333 "unable to create \"%s\" entry\n",
2334 monitor_subsys[ i ]->mss_dn.bv_val, 0, 0 );
2337 monitor_subsys[i]->mss_dn = e->e_name;
2338 monitor_subsys[i]->mss_ndn = e->e_nname;
2340 if ( !BER_BVISNULL( &monitor_subsys[ i ]->mss_desc[ 0 ] ) ) {
2341 attr_merge_normalize( e, slap_schema.si_ad_description,
2342 monitor_subsys[ i ]->mss_desc, NULL );
2345 mp = monitor_entrypriv_create();
2349 e->e_private = ( void * )mp;
2350 mp->mp_info = monitor_subsys[ i ];
2351 mp->mp_flags = monitor_subsys[ i ]->mss_flags;
2353 if ( monitor_cache_add( mi, e ) ) {
2354 Debug( LDAP_DEBUG_ANY,
2355 "unable to add entry \"%s\" to cache\n",
2356 monitor_subsys[ i ]->mss_dn.bv_val, 0, 0 );
2364 assert( be != NULL );
2366 be->be_private = mi;
2369 * opens the monitor backend subsystems
2371 for ( ms = monitor_subsys; ms[ 0 ] != NULL; ms++ ) {
2372 if ( ms[ 0 ]->mss_open && ms[ 0 ]->mss_open( be, ms[ 0 ] ) ) {
2375 ms[ 0 ]->mss_flags |= MONITOR_F_OPENED;
2378 monitor_subsys_opened = 1;
2380 if ( mi->mi_entry_limbo ) {
2381 entry_limbo_t *el = mi->mi_entry_limbo;
2387 switch ( el->el_type ) {
2389 rc = monitor_back_register_entry(
2396 case LIMBO_ENTRY_PARENT:
2397 rc = monitor_back_register_entry_parent(
2409 rc = monitor_back_register_entry_attrs(
2419 rc = monitor_back_register_entry_callback(
2428 rc = monitor_back_register_backend( el->el_bi );
2431 case LIMBO_DATABASE:
2432 rc = monitor_back_register_database( el->el_be, el->el_ndn );
2435 case LIMBO_OVERLAY_INFO:
2436 rc = monitor_back_register_overlay_info( el->el_on );
2440 rc = monitor_back_register_overlay( el->el_be, el->el_on, el->el_ndn );
2449 monitor_back_destroy_limbo_entry( tmp, rc );
2452 /* try all, but report error at end */
2457 mi->mi_entry_limbo = NULL;
2464 monitor_back_config(
2472 * eventually, will hold backend specific configuration parameters
2474 return SLAP_CONF_UNKNOWN;
2479 monitor_back_db_config(
2486 monitor_info_t *mi = ( monitor_info_t * )be->be_private;
2489 * eventually, will hold database specific configuration parameters
2491 return SLAP_CONF_UNKNOWN;
2496 monitor_back_db_destroy(
2500 monitor_info_t *mi = ( monitor_info_t * )be->be_private;
2507 * FIXME: destroys all the data
2509 /* NOTE: mi points to static storage; don't free it */
2511 (void)monitor_cache_destroy( mi );
2513 if ( monitor_subsys ) {
2516 for ( i = 0; monitor_subsys[ i ] != NULL; i++ ) {
2517 if ( monitor_subsys[ i ]->mss_destroy ) {
2518 monitor_subsys[ i ]->mss_destroy( be, monitor_subsys[ i ] );
2521 if ( !BER_BVISNULL( &monitor_subsys[ i ]->mss_rdn ) ) {
2522 ch_free( monitor_subsys[ i ]->mss_rdn.bv_val );
2526 ch_free( monitor_subsys );
2529 if ( mi->mi_entry_limbo ) {
2530 entry_limbo_t *el = mi->mi_entry_limbo;
2533 entry_limbo_t *tmp = el;
2535 monitor_back_destroy_limbo_entry( tmp, 1 );
2539 ldap_pvt_thread_mutex_destroy( &monitor_info.mi_cache_mutex );
2541 be->be_private = NULL;
2546 #if SLAPD_MONITOR == SLAPD_MOD_DYNAMIC
2548 /* conditionally define the init_module() function */
2549 SLAP_BACKEND_INIT_MODULE( monitor )
2551 #endif /* SLAPD_MONITOR == SLAPD_MOD_DYNAMIC */