1 /* init.c - initialize monitor backend */
3 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
9 * This work has beed deveolped for the OpenLDAP Foundation
10 * in the hope that it may be useful to the Open Source community,
11 * but WITHOUT ANY WARRANTY.
13 * Permission is granted to anyone to use this software for any purpose
14 * on any computer system, and to alter it and redistribute it, subject
15 * to the following restrictions:
17 * 1. The author and SysNet s.n.c. are not responsible for the consequences
18 * of use of this software, no matter how awful, even if they arise from
21 * 2. The origin of this software must not be misrepresented, either by
22 * explicit claim or by omission. Since few users ever read sources,
23 * credits should appear in the documentation.
25 * 3. Altered versions must be plainly marked as such, and must not be
26 * misrepresented as being the original software. Since few users
27 * ever read sources, credits should appear in the documentation.
28 * SysNet s.n.c. cannot be responsible for the consequences of the
31 * 4. This notice may not be removed or altered.
37 #include <ac/string.h>
41 #include "back-monitor.h"
44 * used by many functions to add description to entries
46 AttributeDescription *monitor_ad_desc = NULL;
47 BackendDB *be_monitor = NULL;
52 struct monitorsubsys monitor_subsys[] = {
54 SLAPD_MONITOR_LISTENER, SLAPD_MONITOR_LISTENER_NAME,
55 BER_BVNULL, BER_BVNULL, BER_BVNULL,
56 MONITOR_F_PERSISTENT_CH,
57 monitor_subsys_listener_init,
62 SLAPD_MONITOR_DATABASE, SLAPD_MONITOR_DATABASE_NAME,
63 BER_BVNULL, BER_BVNULL, BER_BVNULL,
64 MONITOR_F_PERSISTENT_CH,
65 monitor_subsys_database_init,
70 SLAPD_MONITOR_BACKEND, SLAPD_MONITOR_BACKEND_NAME,
71 BER_BVNULL, BER_BVNULL, BER_BVNULL,
72 MONITOR_F_PERSISTENT_CH,
73 monitor_subsys_backend_init,
78 SLAPD_MONITOR_THREAD, SLAPD_MONITOR_THREAD_NAME,
79 BER_BVNULL, BER_BVNULL, BER_BVNULL,
81 monitor_subsys_thread_init,
82 monitor_subsys_thread_update,
86 SLAPD_MONITOR_SASL, SLAPD_MONITOR_SASL_NAME,
87 BER_BVNULL, BER_BVNULL, BER_BVNULL,
94 SLAPD_MONITOR_TLS, SLAPD_MONITOR_TLS_NAME,
95 BER_BVNULL, BER_BVNULL, BER_BVNULL,
102 SLAPD_MONITOR_CONN, SLAPD_MONITOR_CONN_NAME,
103 BER_BVNULL, BER_BVNULL, BER_BVNULL,
104 MONITOR_F_VOLATILE_CH,
105 monitor_subsys_conn_init,
106 monitor_subsys_conn_update,
107 monitor_subsys_conn_create,
110 SLAPD_MONITOR_READW, SLAPD_MONITOR_READW_NAME,
111 BER_BVNULL, BER_BVNULL, BER_BVNULL,
114 monitor_subsys_readw_update,
118 SLAPD_MONITOR_WRITEW, SLAPD_MONITOR_WRITEW_NAME,
119 BER_BVNULL, BER_BVNULL, BER_BVNULL,
122 monitor_subsys_writew_update,
126 SLAPD_MONITOR_LOG, SLAPD_MONITOR_LOG_NAME,
127 BER_BVNULL, BER_BVNULL, BER_BVNULL,
129 monitor_subsys_log_init,
132 monitor_subsys_log_modify
134 SLAPD_MONITOR_OPS, SLAPD_MONITOR_OPS_NAME,
135 BER_BVNULL, BER_BVNULL, BER_BVNULL,
136 MONITOR_F_PERSISTENT_CH,
137 monitor_subsys_ops_init,
138 monitor_subsys_ops_update,
142 SLAPD_MONITOR_SENT, SLAPD_MONITOR_SENT_NAME,
143 BER_BVNULL, BER_BVNULL, BER_BVNULL,
144 MONITOR_F_PERSISTENT_CH,
145 monitor_subsys_sent_init,
146 monitor_subsys_sent_update,
150 SLAPD_MONITOR_TIME, SLAPD_MONITOR_TIME_NAME,
151 BER_BVNULL, BER_BVNULL, BER_BVNULL,
152 MONITOR_F_PERSISTENT_CH,
153 monitor_subsys_time_init,
154 monitor_subsys_time_update,
160 #ifdef SLAPD_MONITOR_DYNAMIC
163 back_monitor_LTX_init_module( int argc, char *argv[] )
167 memset( &bi, '\0', sizeof(bi) );
168 bi.bi_type = "monitor";
169 bi.bi_init = monitor_back_initialize;
174 #endif /* SLAPD_MONITOR_DYNAMIC */
177 monitor_back_initialize(
181 static char *controls[] = {
182 LDAP_CONTROL_MANAGEDSAIT,
183 LDAP_CONTROL_VALUESRETURNFILTER,
187 bi->bi_controls = controls;
191 bi->bi_config = monitor_back_config;
195 bi->bi_db_init = monitor_back_db_init;
196 bi->bi_db_config = monitor_back_db_config;
197 bi->bi_db_open = monitor_back_db_open;
199 bi->bi_db_destroy = monitor_back_db_destroy;
201 bi->bi_op_bind = monitor_back_bind;
202 bi->bi_op_unbind = 0;
203 bi->bi_op_search = monitor_back_search;
204 bi->bi_op_compare = monitor_back_compare;
205 bi->bi_op_modify = monitor_back_modify;
206 bi->bi_op_modrdn = 0;
208 bi->bi_op_delete = 0;
209 bi->bi_op_abandon = 0;
213 bi->bi_entry_release_rw = 0;
214 bi->bi_chk_referrals = 0;
215 bi->bi_operational = monitor_back_operational;
218 * hooks for slap tools
220 bi->bi_tool_entry_open = 0;
221 bi->bi_tool_entry_close = 0;
222 bi->bi_tool_entry_first = 0;
223 bi->bi_tool_entry_next = 0;
224 bi->bi_tool_entry_get = 0;
225 bi->bi_tool_entry_put = 0;
226 bi->bi_tool_entry_reindex = 0;
227 bi->bi_tool_sync = 0;
229 bi->bi_connection_init = 0;
230 bi->bi_connection_destroy = 0;
236 monitor_back_db_init(
240 struct monitorinfo *mi;
242 struct monitorentrypriv *mp;
244 char buf[1024], *end_of_line;
245 struct berval dn, ndn;
253 { "monitorServer", "( 1.3.6.1.4.1.4203.666.XXX "
254 "NAME 'monitorServer' "
255 "DESC 'Server monitoring root entry' "
256 "SUP monitor STRUCTURAL)",
257 offsetof(struct monitorinfo, monitor_oc_monitorServer) },
258 { "monitorContainer", "( 1.3.6.1.4.1.4203.666.XXX "
259 "NAME 'monitorContainer' "
260 "DESC 'monitor container class' "
261 "SUP monitor STRUCTURAL)",
262 offsetof(struct monitorinfo, monitor_oc_monitorContainer) },
263 { "monitorCounter", "( 1.3.6.1.4.1.4203.666.XXX "
264 "NAME 'monitorCounter' "
265 "DESC 'monitor counter class' "
266 "SUP monitor STRUCTURAL)",
267 offsetof(struct monitorinfo, monitor_oc_monitorCounter) },
268 { "monitorOperation", "( 1.3.6.1.4.1.4203.666.XXX "
269 "NAME 'monitorOperation' "
270 "DESC 'monitor operation class' "
271 "SUP monitor STRUCTURAL)",
272 offsetof(struct monitorinfo, monitor_oc_monitorOperation) },
273 { "monitorConnection", "( 1.3.6.1.4.1.4203.666.XXX "
274 "NAME 'monitorConnection' "
275 "DESC 'monitor connection class' "
276 "SUP monitor STRUCTURAL)",
277 offsetof(struct monitorinfo, monitor_oc_monitorConnection) },
278 { "managedObject", "( 1.3.6.1.4.1.4203.666.XXX "
279 "NAME 'managedObject' "
280 "DESC 'monitor managed entity class' "
281 "SUP monitor STRUCTURAL)",
282 offsetof(struct monitorinfo, monitor_oc_managedObject) },
283 { "monitoredObject", "( 1.3.6.1.4.1.4203.666.XXX "
284 "NAME 'monitoredObject' "
285 "DESC 'monitor monitored entity class' "
286 "SUP monitor STRUCTURAL)",
287 offsetof(struct monitorinfo, monitor_oc_monitoredObject) },
290 { "monitoredInfo", "( 1.3.6.1.4.1.4203.666.XXX"
291 "NAME 'monitoredInfo' "
292 "DESC 'monitored info' "
294 "NO-USER-MODIFICATION )",
295 offsetof(struct monitorinfo, monitor_ad_monitoredInfo) },
296 { "managedInfo", "( 1.3.6.1.4.1.4203.666.XXX"
297 "NAME 'managedInfo' "
298 "DESC 'monitor managed info' "
300 offsetof(struct monitorinfo, monitor_ad_managedInfo) },
301 { "monitorCounter", "( 1.3.6.1.4.1.4203.666.XXX"
302 "NAME 'monitorCounter' "
303 "DESC 'monitor counter' "
304 "EQUALITY integerMatch "
305 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
306 "NO-USER-MODIFICATION )",
307 offsetof(struct monitorinfo, monitor_ad_monitorCounter) },
308 { "monitorOpCompleted", "( 1.3.6.1.4.1.4203.666.XXX"
309 "NAME 'monitorOpCompleted' "
310 "DESC 'monitor completed operations' "
311 "SUP monitorCounter )",
312 offsetof(struct monitorinfo, monitor_ad_monitorOpCompleted) },
313 { "monitorOpInitiated", "( 1.3.6.1.4.1.4203.666.XXX"
314 "NAME 'monitorOpInitiated' "
315 "DESC 'monitor initiated operations' "
316 "SUP monitorCounter )",
317 offsetof(struct monitorinfo, monitor_ad_monitorOpInitiated) },
318 { "monitorConnectionNumber", "( 1.3.6.1.4.1.4203.666.XXX"
319 "NAME 'monitorConnectionNumber' "
320 "DESC 'monitor connection number' "
321 "SUP monitorCounter )",
322 offsetof(struct monitorinfo, monitor_ad_monitorConnectionNumber) },
323 { "monitorConnectionAuthzDN", "( 1.3.6.1.4.1.4203.666.XXX"
324 "NAME 'monitorConnectionAuthzDN' "
325 "DESC 'monitor connection authorization DN' "
326 "SUP distinguishedName "
327 "NO-USER-MODIFICATION )",
328 offsetof(struct monitorinfo, monitor_ad_monitorConnectionAuthzDN) },
329 { "monitorConnectionLocalAddress", "( 1.3.6.1.4.1.4203.666.XXX"
330 "NAME 'monitorConnectionLocalAddress' "
331 "DESC 'monitor connection local address' "
332 "SUP monitoredInfo)",
333 offsetof(struct monitorinfo, monitor_ad_monitorConnectionLocalAddress) },
334 { "monitorConnectionPeerAddress", "( 1.3.6.1.4.1.4203.666.XXX"
335 "NAME 'monitorConnectionPeerAddress' "
336 "DESC 'monitor connection peer address' "
337 "SUP monitoredInfo)",
338 offsetof(struct monitorinfo, monitor_ad_monitorConnectionPeerAddress) },
343 * database monitor can be defined once only
347 LDAP_LOG( OPERATION, CRIT,
348 "only one monitor backend is allowed\n", 0, 0, 0);
350 Debug( LDAP_DEBUG_ANY,
351 "only one monitor backend is allowed\n", 0, 0, 0 );
357 /* indicate system schema supported */
358 be->be_flags |= SLAP_BFLAG_MONITOR;
360 dn.bv_val = SLAPD_MONITOR_DN;
361 dn.bv_len = sizeof( SLAPD_MONITOR_DN ) - 1;
363 rc = dnNormalize2( NULL, &dn, &ndn, NULL );
364 if( rc != LDAP_SUCCESS ) {
366 LDAP_LOG( OPERATION, CRIT,
367 "unable to normalize monitor DN \"" SLAPD_MONITOR_DN
370 Debug( LDAP_DEBUG_ANY,
371 "unable to normalize monitor DN \"" SLAPD_MONITOR_DN
377 ber_dupbv( &bv, &dn );
378 ber_bvarray_add( &be->be_suffix, &bv );
379 ber_bvarray_add( &be->be_nsuffix, &ndn );
381 mi = ( struct monitorinfo * )ch_calloc( sizeof( struct monitorinfo ), 1 );
386 ldap_pvt_thread_mutex_init( &mi->mi_cache_mutex );
388 for ( i = 0; moc[i].name; i++ ) {
394 oc = ldap_str2objectclass(moc[i].schema, &code, &err,
395 LDAP_SCHEMA_ALLOW_ALL );
398 LDAP_LOG( OPERATION, CRIT,
399 "unable to parse monitor objectclass '%s' "
400 "(%s before %s)\n" , moc[i].name,
401 ldap_scherr2str(code), err );
403 Debug( LDAP_DEBUG_ANY,
404 "unable to parse monitor objectclass '%s' "
405 "(%s before %s)\n" , moc[i].name,
406 ldap_scherr2str(code), err );
411 if ( oc->oc_oid == NULL ) {
413 LDAP_LOG( OPERATION, CRIT,
414 "objectclass '%s' has no OID\n" ,
417 Debug( LDAP_DEBUG_ANY,
418 "objectclass '%s' has no OID\n" ,
424 code = oc_add(oc,1,&err);
427 LDAP_LOG( OPERATION, CRIT,
428 "objectclass '%s' (%s before %s)\n" ,
429 moc[i].name, scherr2str(code), err );
431 Debug( LDAP_DEBUG_ANY,
432 "objectclass '%s' (%s before %s)\n" ,
433 moc[i].name, scherr2str(code), err );
440 Oc = oc_find( moc[i].name );
445 ((ObjectClass **)&(((char *)mi)[moc[i].offset]))[0] = Oc;
448 for ( i = 0; mat[i].name; i++ ) {
449 LDAPAttributeType *at;
452 AttributeDescription **ad;
454 at = ldap_str2attributetype( mat[i].schema, &code,
455 &err, LDAP_SCHEMA_ALLOW_ALL );
460 if ( at->at_oid == NULL ) {
464 /* operational attributes should be defined internally
465 if ( at->at_usage ) {
466 fprintf( stderr, "%s: line %d: attribute type \"%s\" is operational\n",
467 fname, lineno, at->at_oid );
471 code = at_add(at,&err);
477 ad = ((AttributeDescription **)&(((char *)mi)[mat[i].offset]));
479 if ( slap_str2ad( mat[i].name, ad, &text ) ) {
481 LDAP_LOG( OPERATION, CRIT,
482 "monitor_back_db_init: %s\n", text, 0, 0 );
484 Debug( LDAP_DEBUG_ANY,
485 "monitor_subsys_backend_init: %s\n%s%s",
492 if ( slap_str2ad( "description", &mi->monitor_ad_description, &text ) ) {
494 LDAP_LOG( OPERATION, CRIT,
495 "monitor_back_db_init: %s\n", text, 0, 0 );
497 Debug( LDAP_DEBUG_ANY,
498 "monitor_subsys_backend_init: %s\n%s%s",
505 * Create all the subsystem specific entries
508 for ( i = 0; monitor_subsys[ i ].mss_name != NULL; i++ ) {
509 int len = strlen( monitor_subsys[ i ].mss_name );
513 dn.bv_len = len + sizeof( "cn=" ) - 1;
514 dn.bv_val = ch_calloc( sizeof( char ), dn.bv_len + 1 );
515 strcpy( dn.bv_val, "cn=" );
516 strcat( dn.bv_val, monitor_subsys[ i ].mss_name );
517 rc = dnPretty2( NULL, &dn, &monitor_subsys[ i ].mss_rdn, NULL );
519 if ( rc != LDAP_SUCCESS ) {
521 LDAP_LOG( OPERATION, CRIT,
522 "monitor RDN \"%s\" is invalid\n",
525 Debug( LDAP_DEBUG_ANY,
526 "monitor RDN \"%s\" is invalid\n",
532 dn.bv_len += sizeof( SLAPD_MONITOR_DN ); /* 1 for the , */
533 dn.bv_val = ch_malloc( dn.bv_len + 1 );
534 strcpy( dn.bv_val , monitor_subsys[ i ].mss_rdn.bv_val );
535 strcat( dn.bv_val, "," SLAPD_MONITOR_DN );
536 rc = dnPrettyNormal( NULL, &dn, &monitor_subsys[ i ].mss_dn,
537 &monitor_subsys[ i ].mss_ndn, NULL );
539 if ( rc != LDAP_SUCCESS ) {
541 LDAP_LOG( OPERATION, CRIT,
542 "monitor DN \"%s\" is invalid\n",
545 Debug( LDAP_DEBUG_ANY,
546 "monitor DN \"%s\" is invalid\n",
552 snprintf( buf, sizeof( buf ),
554 SLAPD_MONITOR_OBJECTCLASSES
556 monitor_subsys[ i ].mss_dn.bv_val,
557 monitor_subsys[ i ].mss_name );
559 e = str2entry( buf );
563 LDAP_LOG( OPERATION, CRIT,
564 "unable to create '%s' entry\n",
565 monitor_subsys[ i ].mss_dn.bv_val, 0, 0 );
567 Debug( LDAP_DEBUG_ANY,
568 "unable to create '%s' entry\n",
569 monitor_subsys[ i ].mss_dn.bv_val, 0, 0 );
574 mp = ( struct monitorentrypriv * )ch_calloc( sizeof( struct monitorentrypriv ), 1 );
575 e->e_private = ( void * )mp;
576 mp->mp_info = &monitor_subsys[ i ];
577 mp->mp_children = NULL;
579 mp->mp_flags = monitor_subsys[ i ].mss_flags;
581 if ( monitor_cache_add( mi, e ) ) {
583 LDAP_LOG( OPERATION, CRIT,
584 "unable to add entry '%s' to cache\n",
585 monitor_subsys[ i ].mss_dn.bv_val, 0, 0 );
587 Debug( LDAP_DEBUG_ANY,
588 "unable to add entry '%s' to cache\n",
589 monitor_subsys[ i ].mss_dn.bv_val, 0, 0 );
598 * creates the "cn=Monitor" entry
600 snprintf( buf, sizeof( buf ),
601 "dn: " SLAPD_MONITOR_DN "\n"
603 "objectClass: monitor\n"
604 "objectClass: extensibleObject\n"
605 "structuralObjectClass: monitor\n"
608 e = str2entry( buf );
611 LDAP_LOG( OPERATION, CRIT,
612 "unable to create '%s' entry\n",
613 SLAPD_MONITOR_DN, 0, 0 );
615 Debug( LDAP_DEBUG_ANY,
616 "unable to create '%s' entry\n%s%s",
617 SLAPD_MONITOR_DN, "", "" );
621 bv.bv_val = (char *) Versionstr;
622 end_of_line = strchr( Versionstr, '\n' );
624 bv.bv_len = end_of_line - Versionstr;
626 bv.bv_len = strlen( Versionstr );
628 if ( attr_merge_normalize_one( e, monitor_ad_desc, &bv, NULL ) ) {
630 LDAP_LOG( OPERATION, CRIT,
631 "unable to add description to '%s' entry\n",
632 SLAPD_MONITOR_DN, 0, 0 );
634 Debug( LDAP_DEBUG_ANY,
635 "unable to add description to '%s' entry\n%s%s",
636 SLAPD_MONITOR_DN, "", "" );
641 mp = ( struct monitorentrypriv * )ch_calloc( sizeof( struct monitorentrypriv ), 1 );
642 e->e_private = ( void * )mp;
645 mp->mp_children = e_tmp;
648 if ( monitor_cache_add( mi, e ) ) {
650 LDAP_LOG( OPERATION, CRIT,
651 "unable to add entry '%s' to cache\n",
652 SLAPD_MONITOR_DN, 0, 0 );
654 Debug( LDAP_DEBUG_ANY,
655 "unable to add entry '%s' to cache\n%s%s",
656 SLAPD_MONITOR_DN, "", "" );
667 monitor_back_db_open(
671 struct monitorsubsys *ms;
676 * opens the monitor backend
678 for ( ms = monitor_subsys; ms->mss_name != NULL; ms++ ) {
679 if ( ms->mss_init && ( *ms->mss_init )( be ) ) {
697 * eventually, will hold backend specific configuration parameters
703 monitor_back_db_config(
712 * eventually, will hold database specific configuration parameters
715 LDAP_LOG( CONFIG, INFO,
716 "line %d of file '%s' will be ignored\n", lineno, fname, 0 );
718 Debug( LDAP_DEBUG_CONFIG,
719 "line %d of file '%s' will be ignored\n%s", lineno, fname, "" );
725 monitor_back_db_destroy(
730 * FIXME: destroys all the data