git.sur5r.net Git - openldap/blob - servers/slapd/back-monitor/init.c

   1 /* init.c - initialize monitor backend */
   2 /*
   3  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
   4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   5  */
   6 /*
   7  * Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
   8  *
   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.
  12  *
  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:
  16  *
  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
  19  *    flaws in it.
  20  *
  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.
  24  *
  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
  29  *    alterations.
  30  *
  31  * 4. This notice may not be removed or altered.
  32  */
  33
  34 #include "portable.h"
  35
  36 #include <stdio.h>
  37 #include <ac/string.h>
  38
  39 #include "slap.h"
  40 #include "back-monitor.h"
  41
  42 /*
  43  * used by many functions to add description to entries
  44  */
  45 AttributeDescription *monitor_ad_desc = NULL;
  46 BackendDB *be_monitor = NULL;
  47
  48 /*
  49  * subsystem data
  50  */
  51 struct monitorsubsys monitor_subsys[] = {
  52         {
  53                 SLAPD_MONITOR_LISTENER, SLAPD_MONITOR_LISTENER_NAME,
  54                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
  55                 MONITOR_F_PERSISTENT_CH,
  56                 monitor_subsys_listener_init,
  57                 NULL,   /* update */
  58                 NULL,   /* create */
  59                 NULL    /* modify */
  60         }, {
  61                 SLAPD_MONITOR_DATABASE, SLAPD_MONITOR_DATABASE_NAME,
  62                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
  63                 MONITOR_F_PERSISTENT_CH,
  64                 monitor_subsys_database_init,
  65                 NULL,   /* update */
  66                 NULL,   /* create */
  67                 NULL    /* modify */
  68         }, {
  69                 SLAPD_MONITOR_BACKEND, SLAPD_MONITOR_BACKEND_NAME,
  70                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
  71                 MONITOR_F_PERSISTENT_CH,
  72                 monitor_subsys_backend_init,
  73                 NULL,   /* update */
  74                 NULL,   /* create */
  75                 NULL    /* modify */
  76         }, {
  77                 SLAPD_MONITOR_THREAD, SLAPD_MONITOR_THREAD_NAME,
  78                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
  79                 MONITOR_F_NONE,
  80                 monitor_subsys_thread_init,
  81                 monitor_subsys_thread_update,
  82                 NULL,   /* create */
  83                 NULL    /* modify */
  84         }, {
  85                 SLAPD_MONITOR_SASL, SLAPD_MONITOR_SASL_NAME,
  86                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
  87                 MONITOR_F_NONE,
  88                 NULL,   /* init */
  89                 NULL,   /* update */
  90                 NULL,   /* create */
  91                 NULL    /* modify */
  92         }, {
  93                 SLAPD_MONITOR_TLS, SLAPD_MONITOR_TLS_NAME,
  94                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
  95                 MONITOR_F_NONE,
  96                 NULL,   /* init */
  97                 NULL,   /* update */
  98                 NULL,   /* create */
  99                 NULL    /* modify */
 100         }, {
 101                 SLAPD_MONITOR_CONN, SLAPD_MONITOR_CONN_NAME,
 102                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
 103                 MONITOR_F_VOLATILE_CH,
 104                 monitor_subsys_conn_init,
 105                 monitor_subsys_conn_update,
 106                 monitor_subsys_conn_create,
 107                 NULL    /* modify */
 108         }, {
 109                 SLAPD_MONITOR_READW, SLAPD_MONITOR_READW_NAME,
 110                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
 111                 MONITOR_F_NONE,
 112                 NULL,   /* init */
 113                 monitor_subsys_readw_update,
 114                 NULL,   /* create */
 115                 NULL    /* modify */
 116         }, {
 117                 SLAPD_MONITOR_WRITEW, SLAPD_MONITOR_WRITEW_NAME,
 118                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
 119                 MONITOR_F_NONE,
 120                 NULL,   /* init */
 121                 monitor_subsys_writew_update,
 122                 NULL,   /* create */
 123                 NULL    /* modify */
 124         }, {
 125                 SLAPD_MONITOR_LOG, SLAPD_MONITOR_LOG_NAME,
 126                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
 127                 MONITOR_F_NONE,
 128                 monitor_subsys_log_init,
 129                 NULL,   /* update */
 130                 NULL,   /* create */
 131                 monitor_subsys_log_modify
 132         }, {
 133                 SLAPD_MONITOR_OPS, SLAPD_MONITOR_OPS_NAME,
 134                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
 135                 MONITOR_F_PERSISTENT_CH,
 136                 monitor_subsys_ops_init,
 137                 monitor_subsys_ops_update,
 138                 NULL,   /* create */
 139                 NULL,   /* modify */
 140         }, {
 141                 SLAPD_MONITOR_SENT, SLAPD_MONITOR_SENT_NAME,
 142                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
 143                 MONITOR_F_PERSISTENT_CH,
 144                 monitor_subsys_sent_init,
 145                 monitor_subsys_sent_update,
 146                 NULL,   /* create */
 147                 NULL,   /* modify */
 148         }, {
 149                 SLAPD_MONITOR_TIME, SLAPD_MONITOR_TIME_NAME,
 150                 { 0L, NULL }, { 0L, NULL }, { 0L, NULL },
 151                 MONITOR_F_PERSISTENT_CH,
 152                 monitor_subsys_time_init,
 153                 monitor_subsys_time_update,
 154                 NULL,   /* create */
 155                 NULL,   /* modify */
 156         }, { -1, NULL }
 157 };
 158
 159 int
 160 monitor_back_initialize(
 161         BackendInfo     *bi
 162 )
 163 {
 164         static char *controls[] = {
 165                 LDAP_CONTROL_MANAGEDSAIT,
 166                 NULL
 167         };
 168
 169         bi->bi_controls = controls;
 170
 171         bi->bi_init = 0;
 172         bi->bi_open = monitor_back_open;
 173         bi->bi_config = monitor_back_config;
 174         bi->bi_close = 0;
 175         bi->bi_destroy = 0;
 176
 177         bi->bi_db_init = monitor_back_db_init;
 178         bi->bi_db_config = monitor_back_db_config;
 179         bi->bi_db_open = 0;
 180         bi->bi_db_close = 0;
 181         bi->bi_db_destroy = monitor_back_db_destroy;
 182
 183         bi->bi_op_bind = monitor_back_bind;
 184         bi->bi_op_unbind = 0;
 185         bi->bi_op_search = monitor_back_search;
 186         bi->bi_op_compare = monitor_back_compare;
 187         bi->bi_op_modify = monitor_back_modify;
 188         bi->bi_op_modrdn = 0;
 189         bi->bi_op_add = 0;
 190         bi->bi_op_delete = 0;
 191         bi->bi_op_abandon = 0;
 192
 193         bi->bi_extended = 0;
 194
 195         bi->bi_entry_release_rw = 0;
 196         bi->bi_acl_group = 0;
 197         bi->bi_acl_attribute = 0;
 198         bi->bi_chk_referrals = 0;
 199         bi->bi_operational = monitor_back_operational;
 200
 201         /*
 202          * hooks for slap tools
 203          */
 204         bi->bi_tool_entry_open = 0;
 205         bi->bi_tool_entry_close = 0;
 206         bi->bi_tool_entry_first = 0;
 207         bi->bi_tool_entry_next = 0;
 208         bi->bi_tool_entry_get = 0;
 209         bi->bi_tool_entry_put = 0;
 210         bi->bi_tool_entry_reindex = 0;
 211         bi->bi_tool_sync = 0;
 212
 213         bi->bi_connection_init = 0;
 214         bi->bi_connection_destroy = 0;
 215
 216         return 0;
 217 }
 218
 219 int
 220 monitor_back_db_init(
 221         BackendDB       *be
 222 )
 223 {
 224         struct monitorinfo      *mi;
 225         Entry                   *e, *e_tmp;
 226         struct monitorentrypriv *mp;
 227         int                     i, rc;
 228         char                    buf[1024], *end_of_line;
 229         struct berval           dn, *ndn;
 230         const char              *text;
 231         struct berval           bv[2];
 232
 233         /*
 234          * database monitor can be defined once only
 235          */
 236         if ( be_monitor ) {
 237 #ifdef NEW_LOGGING
 238                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 239                         "only one monitor backend is allowed\n" ));
 240 #else
 241                 Debug( LDAP_DEBUG_ANY,
 242                         "only one monitor backend is allowed\n%s%s%s",
 243                         "", "", "" );
 244 #endif
 245                 return( -1 );
 246         }
 247         be_monitor = be;
 248
 249         /* indicate system schema supported */
 250         be->be_flags |= SLAP_BFLAG_MONITOR;
 251
 252         ndn = NULL;
 253         dn.bv_val = SLAPD_MONITOR_DN;
 254         dn.bv_len = sizeof( SLAPD_MONITOR_DN ) - 1;
 255
 256         rc = dnNormalize( NULL, &dn, &ndn );
 257         if( rc != LDAP_SUCCESS ) {
 258 #ifdef NEW_LOGGING
 259                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 260                         "monitor DN \"" SLAPD_MONITOR_DN "\" backend is allowed\n" ));
 261 #else
 262                 Debug( LDAP_DEBUG_ANY,
 263                         "monitor DN \"" SLAPD_MONITOR_DN "\" backend is allowed\n",
 264                         0, 0, 0 );
 265 #endif
 266                 return -1;
 267         }
 268
 269         ber_bvecadd( &be->be_suffix, ber_dupbv( NULL, &dn ) );
 270         ber_bvecadd( &be->be_nsuffix, ndn );
 271
 272         mi = ( struct monitorinfo * )ch_calloc( sizeof( struct monitorinfo ), 1 );
 273         ldap_pvt_thread_mutex_init( &mi->mi_cache_mutex );
 274
 275         if ( slap_str2ad( "description", &monitor_ad_desc, &text ) ) {
 276 #ifdef NEW_LOGGING
 277                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 278                         "monitor_back_db_init: %s\n", text ));
 279 #else
 280                 Debug( LDAP_DEBUG_ANY,
 281                         "monitor_subsys_backend_init: %s\n%s%s",
 282                         text, "", "" );
 283 #endif
 284                 return( -1 );
 285         }
 286
 287         /*
 288          * Create all the subsystem specific entries
 289          */
 290         e_tmp = NULL;
 291         for ( i = 0; monitor_subsys[ i ].mss_name != NULL; i++ ) {
 292                 int             len = strlen( monitor_subsys[ i ].mss_name );
 293                 struct berval   dn;
 294                 int             rc;
 295
 296                 dn.bv_len = len + sizeof( "cn=" ) - 1;
 297                 dn.bv_val = ch_calloc( sizeof( char ), dn.bv_len + 1 );
 298                 strcpy( dn.bv_val, "cn=" );
 299                 strcat( dn.bv_val, monitor_subsys[ i ].mss_name );
 300                 rc = dnPretty2( NULL, &dn, &monitor_subsys[ i ].mss_rdn );
 301                 free( dn.bv_val );
 302                 if ( rc != LDAP_SUCCESS ) {
 303 #ifdef NEW_LOGGING
 304                         LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 305                                 "monitor RDN \"%s\" is invalid\n",
 306                                 dn.bv_val ));
 307 #else
 308                         Debug( LDAP_DEBUG_ANY,
 309                                 "monitor RDN \"%s\" is invalid\n",
 310                                 dn.bv_val, 0, 0 );
 311 #endif
 312                         return( -1 );
 313                 }
 314
 315                 dn.bv_len += sizeof( SLAPD_MONITOR_DN ); /* 1 for the , */
 316                 dn.bv_val = ch_malloc( dn.bv_len + 1 );
 317                 strcpy( dn.bv_val , monitor_subsys[ i ].mss_rdn.bv_val );
 318                 strcat( dn.bv_val, "," SLAPD_MONITOR_DN );
 319                 rc = dnPrettyNormal( NULL, &dn, &monitor_subsys[ i ].mss_dn,
 320                         &monitor_subsys[ i ].mss_ndn );
 321                 free( dn.bv_val );
 322                 if ( rc != LDAP_SUCCESS ) {
 323 #ifdef NEW_LOGGING
 324                         LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 325                                 "monitor DN \"%s\" is invalid\n",
 326                                 dn.bv_val ));
 327 #else
 328                         Debug( LDAP_DEBUG_ANY,
 329                                 "monitor DN \"%s\" is invalid\n",
 330                                 dn.bv_val, 0, 0 );
 331 #endif
 332                         return( -1 );
 333                 }
 334
 335                 snprintf( buf, sizeof( buf ),
 336                                 "dn: %s\n"
 337                                 SLAPD_MONITOR_OBJECTCLASSES
 338                                 "cn: %s\n",
 339                                 monitor_subsys[ i ].mss_dn.bv_val,
 340                                 monitor_subsys[ i ].mss_name );
 341
 342                 e = str2entry( buf );
 343
 344                 if ( e == NULL) {
 345 #ifdef NEW_LOGGING
 346                         LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 347                                 "unable to create '%s' entry\n",
 348                                 monitor_subsys[ i ].mss_dn.bv_val ));
 349 #else
 350                         Debug( LDAP_DEBUG_ANY,
 351                                 "unable to create '%s' entry\n",
 352                                 monitor_subsys[ i ].mss_dn.bv_val, 0, 0 );
 353 #endif
 354                         return( -1 );
 355                 }
 356
 357                 mp = ( struct monitorentrypriv * )ch_calloc( sizeof( struct monitorentrypriv ), 1 );
 358                 e->e_private = ( void * )mp;
 359                 mp->mp_info = &monitor_subsys[ i ];
 360                 mp->mp_children = NULL;
 361                 mp->mp_next = e_tmp;
 362                 mp->mp_flags = monitor_subsys[ i ].mss_flags;
 363
 364                 if ( monitor_cache_add( mi, e ) ) {
 365 #ifdef NEW_LOGGING
 366                         LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 367                                 "unable to add entry '%s' to cache\n",
 368                                 monitor_subsys[ i ].mss_dn.bv_val ));
 369 #else
 370                         Debug( LDAP_DEBUG_ANY,
 371                                 "unable to add entry '%s' to cache\n",
 372                                 monitor_subsys[ i ].mss_dn.bv_val, 0, 0 );
 373 #endif
 374                         return -1;
 375                 }
 376
 377                 e_tmp = e;
 378         }
 379
 380         /*
 381          * creates the "cn=Monitor" entry
 382          */
 383         snprintf( buf, sizeof( buf ),
 384                         "dn: " SLAPD_MONITOR_DN "\n"
 385                         "objectClass: top\n"
 386                         "objectClass: monitor\n"
 387                         "objectClass: extensibleObject\n"
 388                         "structuralObjectClass: monitor\n"
 389                         "cn: Monitor" );
 390
 391         e = str2entry( buf );
 392         if ( e == NULL) {
 393 #ifdef NEW_LOGGING
 394                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 395                         "unable to create '%s' entry\n",
 396                         SLAPD_MONITOR_DN ));
 397 #else
 398                 Debug( LDAP_DEBUG_ANY,
 399                         "unable to create '%s' entry\n%s%s",
 400                         SLAPD_MONITOR_DN, "", "" );
 401 #endif
 402                 return( -1 );
 403         }
 404         bv[1].bv_val = NULL;
 405         bv[0].bv_val = (char *) Versionstr;
 406         end_of_line = strchr( Versionstr, '\n' );
 407         if ( end_of_line ) {
 408                 bv[0].bv_len = end_of_line - Versionstr;
 409         } else {
 410                 bv[0].bv_len = strlen( Versionstr );
 411         }
 412         if ( attr_merge( e, monitor_ad_desc, bv ) ) {
 413 #ifdef NEW_LOGGING
 414                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 415                         "unable to add description to '%s' entry\n",
 416                         SLAPD_MONITOR_DN ));
 417 #else
 418                 Debug( LDAP_DEBUG_ANY,
 419                         "unable to add description to '%s' entry\n%s%s",
 420                         SLAPD_MONITOR_DN, "", "" );
 421 #endif
 422                 return( -1 );
 423         }
 424
 425         mp = ( struct monitorentrypriv * )ch_calloc( sizeof( struct monitorentrypriv ), 1 );
 426         e->e_private = ( void * )mp;
 427
 428         mp->mp_info = NULL;
 429         mp->mp_children = e_tmp;
 430         mp->mp_next = NULL;
 431
 432         if ( monitor_cache_add( mi, e ) ) {
 433 #ifdef NEW_LOGGING
 434                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 435                         "unable to add entry '%s' to cache\n",
 436                         SLAPD_MONITOR_DN ));
 437 #else
 438                 Debug( LDAP_DEBUG_ANY,
 439                         "unable to add entry '%s' to cache\n%s%s",
 440                         SLAPD_MONITOR_DN, "", "" );
 441 #endif
 442                 return -1;
 443         }
 444
 445         be->be_private = mi;
 446
 447         return 0;
 448 }
 449
 450 int
 451 monitor_back_open(
 452         BackendInfo     *bi
 453 )
 454 {
 455         BackendDB               *be;
 456         struct monitorsubsys    *ms;
 457         struct berval dn = { sizeof(SLAPD_MONITOR_DN)-1, SLAPD_MONITOR_DN };
 458         struct berval ndn;
 459         int rc;
 460
 461         /*
 462          * adds the monitor backend
 463          */
 464         rc = dnNormalize2( NULL, &dn, &ndn );
 465         if( rc != LDAP_SUCCESS ) {
 466 #ifdef NEW_LOGGING
 467                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 468                         "monitor DN \"" SLAPD_MONITOR_DN "\" is invalid\n" ));
 469 #else
 470                 Debug( LDAP_DEBUG_ANY,
 471                         "monitor DN \"" SLAPD_MONITOR_DN "\" is invalid\n",
 472                         0, 0, 0 );
 473 #endif
 474                 return( -1 );
 475         }
 476
 477         be = select_backend( &ndn , 0, 0 );
 478         free( ndn.bv_val );
 479
 480         if ( be == NULL ) {
 481 #ifdef NEW_LOGGING
 482                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 483                         "unable to get monitor backend\n" ));
 484 #else
 485                 Debug( LDAP_DEBUG_ANY,
 486                         "unable to get monitor backend\n", 0, 0, 0 );
 487 #endif
 488                 return( -1 );
 489         }
 490
 491         for ( ms = monitor_subsys; ms->mss_name != NULL; ms++ ) {
 492                 if ( ms->mss_init && ( *ms->mss_init )( be ) ) {
 493                         return( -1 );
 494                 }
 495         }
 496
 497         return( 0 );
 498 }
 499
 500 int
 501 monitor_back_config(
 502         BackendInfo     *bi,
 503         const char      *fname,
 504         int             lineno,
 505         int             argc,
 506         char            **argv
 507 )
 508 {
 509         /*
 510          * eventually, will hold backend specific configuration parameters
 511          */
 512         return 0;
 513 }
 514
 515 int
 516 monitor_back_db_config(
 517         Backend     *be,
 518         const char  *fname,
 519         int         lineno,
 520         int         argc,
 521         char        **argv
 522 )
 523 {
 524 #ifdef NEW_LOGGING
 525         LDAP_LOG(( "config", LDAP_LEVEL_INFO,
 526                 "line %d of file '%s' will be ignored\n", lineno, fname ));
 527 #else
 528         Debug( LDAP_DEBUG_CONFIG,
 529                 "line %d of file '%s' will be ignored\n%s", lineno, fname, "" );
 530 #endif
 531         return( 0 );
 532 }
 533
 534 int
 535 monitor_back_db_destroy(
 536         BackendDB       *be
 537 )
 538 {
 539         /*
 540          * FIXME: destroys all the data
 541          */
 542         return 0;
 543 }
 544