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_NONE,
 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_NONE,
 144                 monitor_subsys_sent_init,
 145                 monitor_subsys_sent_update,
 146                 NULL,   /* create */
 147                 NULL,   /* modify */
 148         }, { -1, NULL }
 149 };
 150
 151 int
 152 monitor_back_initialize(
 153         BackendInfo     *bi
 154 )
 155 {
 156         static char *controls[] = {
 157                 LDAP_CONTROL_MANAGEDSAIT,
 158                 NULL
 159         };
 160
 161         bi->bi_controls = controls;
 162
 163         bi->bi_init = 0;
 164         bi->bi_open = monitor_back_open;
 165         bi->bi_config = monitor_back_config;
 166         bi->bi_close = 0;
 167         bi->bi_destroy = 0;
 168
 169         bi->bi_db_init = monitor_back_db_init;
 170         bi->bi_db_config = monitor_back_db_config;
 171         bi->bi_db_open = 0;
 172         bi->bi_db_close = 0;
 173         bi->bi_db_destroy = monitor_back_db_destroy;
 174
 175         bi->bi_op_bind = monitor_back_bind;
 176         bi->bi_op_unbind = 0;
 177         bi->bi_op_search = monitor_back_search;
 178         bi->bi_op_compare = monitor_back_compare;
 179         bi->bi_op_modify = monitor_back_modify;
 180         bi->bi_op_modrdn = 0;
 181         bi->bi_op_add = 0;
 182         bi->bi_op_delete = 0;
 183         bi->bi_op_abandon = 0;
 184
 185         bi->bi_extended = 0;
 186
 187         bi->bi_entry_release_rw = 0;
 188         bi->bi_acl_group = 0;
 189         bi->bi_acl_attribute = 0;
 190         bi->bi_chk_referrals = 0;
 191         bi->bi_operational = monitor_back_operational;
 192
 193         /*
 194          * hooks for slap tools
 195          */
 196         bi->bi_tool_entry_open = 0;
 197         bi->bi_tool_entry_close = 0;
 198         bi->bi_tool_entry_first = 0;
 199         bi->bi_tool_entry_next = 0;
 200         bi->bi_tool_entry_get = 0;
 201         bi->bi_tool_entry_put = 0;
 202         bi->bi_tool_entry_reindex = 0;
 203         bi->bi_tool_sync = 0;
 204
 205         bi->bi_connection_init = 0;
 206         bi->bi_connection_destroy = 0;
 207
 208         return 0;
 209 }
 210
 211 int
 212 monitor_back_db_init(
 213         BackendDB       *be
 214 )
 215 {
 216         struct monitorinfo      *mi;
 217         Entry                   *e, *e_tmp;
 218         struct monitorentrypriv *mp;
 219         int                     i, rc;
 220         char                    buf[1024], *end_of_line;
 221         struct berval           dn, *ndn;
 222         const char              *text;
 223         struct berval           bv[2];
 224
 225         /*
 226          * database monitor can be defined once only
 227          */
 228         if ( be_monitor ) {
 229 #ifdef NEW_LOGGING
 230                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 231                         "only one monitor backend is allowed\n" ));
 232 #else
 233                 Debug( LDAP_DEBUG_ANY,
 234                         "only one monitor backend is allowed\n%s%s%s",
 235                         "", "", "" );
 236 #endif
 237                 return( -1 );
 238         }
 239         be_monitor = be;
 240
 241         /* indicate system schema supported */
 242         be->be_flags |= SLAP_BFLAG_MONITOR;
 243
 244         ndn = NULL;
 245         dn.bv_val = SLAPD_MONITOR_DN;
 246         dn.bv_len = sizeof( SLAPD_MONITOR_DN ) - 1;
 247
 248         rc = dnNormalize( NULL, &dn, &ndn );
 249         if( rc != LDAP_SUCCESS ) {
 250 #ifdef NEW_LOGGING
 251                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 252                         "monitor DN \"" SLAPD_MONITOR_DN "\" backend is allowed\n" ));
 253 #else
 254                 Debug( LDAP_DEBUG_ANY,
 255                         "monitor DN \"" SLAPD_MONITOR_DN "\" backend is allowed\n",
 256                         0, 0, 0 );
 257 #endif
 258                 return -1;
 259         }
 260
 261         ber_bvecadd( &be->be_suffix, ber_dupbv( NULL, &dn ) );
 262         ber_bvecadd( &be->be_nsuffix, ndn );
 263
 264         mi = ( struct monitorinfo * )ch_calloc( sizeof( struct monitorinfo ), 1 );
 265         ldap_pvt_thread_mutex_init( &mi->mi_cache_mutex );
 266
 267         if ( slap_str2ad( "description", &monitor_ad_desc, &text ) ) {
 268 #ifdef NEW_LOGGING
 269                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 270                         "monitor_back_db_init: %s\n", text ));
 271 #else
 272                 Debug( LDAP_DEBUG_ANY,
 273                         "monitor_subsys_backend_init: %s\n%s%s",
 274                         text, "", "" );
 275 #endif
 276                 return( -1 );
 277         }
 278
 279         /*
 280          * Create all the subsystem specific entries
 281          */
 282         e_tmp = NULL;
 283         for ( i = 0; monitor_subsys[ i ].mss_name != NULL; i++ ) {
 284                 int             len = strlen( monitor_subsys[ i ].mss_name );
 285                 struct berval   dn;
 286                 int             rc;
 287
 288                 dn.bv_len = len + sizeof( "cn=" ) - 1;
 289                 dn.bv_val = ch_calloc( sizeof( char ), dn.bv_len + 1 );
 290                 strcpy( dn.bv_val, "cn=" );
 291                 strcat( dn.bv_val, monitor_subsys[ i ].mss_name );
 292                 rc = dnPretty2( NULL, &dn, &monitor_subsys[ i ].mss_rdn );
 293                 free( dn.bv_val );
 294                 if ( rc != LDAP_SUCCESS ) {
 295 #ifdef NEW_LOGGING
 296                         LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 297                                 "monitor RDN \"%s\" is invalid\n",
 298                                 dn.bv_val ));
 299 #else
 300                         Debug( LDAP_DEBUG_ANY,
 301                                 "monitor RDN \"%s\" is invalid\n",
 302                                 dn.bv_val, 0, 0 );
 303 #endif
 304                         return( -1 );
 305                 }
 306
 307                 dn.bv_len += sizeof( SLAPD_MONITOR_DN ); /* 1 for the , */
 308                 dn.bv_val = ch_malloc( dn.bv_len + 1 );
 309                 strcpy( dn.bv_val , monitor_subsys[ i ].mss_rdn.bv_val );
 310                 strcat( dn.bv_val, "," SLAPD_MONITOR_DN );
 311                 rc = dnPrettyNormal( NULL, &dn, &monitor_subsys[ i ].mss_dn,
 312                         &monitor_subsys[ i ].mss_ndn );
 313                 free( dn.bv_val );
 314                 if ( rc != LDAP_SUCCESS ) {
 315 #ifdef NEW_LOGGING
 316                         LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 317                                 "monitor DN \"%s\" is invalid\n",
 318                                 dn.bv_val ));
 319 #else
 320                         Debug( LDAP_DEBUG_ANY,
 321                                 "monitor DN \"%s\" is invalid\n",
 322                                 dn.bv_val, 0, 0 );
 323 #endif
 324                         return( -1 );
 325                 }
 326
 327                 snprintf( buf, sizeof( buf ),
 328                                 "dn: %s\n"
 329                                 SLAPD_MONITOR_OBJECTCLASSES
 330                                 "cn: %s\n",
 331                                 monitor_subsys[ i ].mss_dn.bv_val,
 332                                 monitor_subsys[ i ].mss_name );
 333
 334                 e = str2entry( buf );
 335
 336                 if ( e == NULL) {
 337 #ifdef NEW_LOGGING
 338                         LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 339                                 "unable to create '%s' entry\n",
 340                                 monitor_subsys[ i ].mss_dn.bv_val ));
 341 #else
 342                         Debug( LDAP_DEBUG_ANY,
 343                                 "unable to create '%s' entry\n",
 344                                 monitor_subsys[ i ].mss_dn.bv_val, 0, 0 );
 345 #endif
 346                         return( -1 );
 347                 }
 348
 349                 mp = ( struct monitorentrypriv * )ch_calloc( sizeof( struct monitorentrypriv ), 1 );
 350                 e->e_private = ( void * )mp;
 351                 mp->mp_info = &monitor_subsys[ i ];
 352                 mp->mp_children = NULL;
 353                 mp->mp_next = e_tmp;
 354                 mp->mp_flags = monitor_subsys[ i ].mss_flags;
 355
 356                 if ( monitor_cache_add( mi, e ) ) {
 357 #ifdef NEW_LOGGING
 358                         LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 359                                 "unable to add entry '%s' to cache\n",
 360                                 monitor_subsys[ i ].mss_dn.bv_val ));
 361 #else
 362                         Debug( LDAP_DEBUG_ANY,
 363                                 "unable to add entry '%s' to cache\n",
 364                                 monitor_subsys[ i ].mss_dn.bv_val, 0, 0 );
 365 #endif
 366                         return -1;
 367                 }
 368
 369                 e_tmp = e;
 370         }
 371
 372         /*
 373          * creates the "cn=Monitor" entry
 374          */
 375         snprintf( buf, sizeof( buf ),
 376                         "dn: " SLAPD_MONITOR_DN "\n"
 377                         "objectClass: top\n"
 378                         "objectClass: monitor\n"
 379                         "objectClass: extensibleObject\n"
 380                         "structuralObjectClass: monitor\n"
 381                         "cn: Monitor" );
 382
 383         e = str2entry( buf );
 384         if ( e == NULL) {
 385 #ifdef NEW_LOGGING
 386                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 387                         "unable to create '%s' entry\n",
 388                         SLAPD_MONITOR_DN ));
 389 #else
 390                 Debug( LDAP_DEBUG_ANY,
 391                         "unable to create '%s' entry\n%s%s",
 392                         SLAPD_MONITOR_DN, "", "" );
 393 #endif
 394                 return( -1 );
 395         }
 396         bv[1].bv_val = NULL;
 397         bv[0].bv_val = (char *) Versionstr;
 398         end_of_line = strchr( Versionstr, '\n' );
 399         if ( end_of_line ) {
 400                 bv[0].bv_len = end_of_line - Versionstr;
 401         } else {
 402                 bv[0].bv_len = strlen( Versionstr );
 403         }
 404         if ( attr_merge( e, monitor_ad_desc, bv ) ) {
 405 #ifdef NEW_LOGGING
 406                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 407                         "unable to add description to '%s' entry\n",
 408                         SLAPD_MONITOR_DN ));
 409 #else
 410                 Debug( LDAP_DEBUG_ANY,
 411                         "unable to add description to '%s' entry\n%s%s",
 412                         SLAPD_MONITOR_DN, "", "" );
 413 #endif
 414                 return( -1 );
 415         }
 416
 417         mp = ( struct monitorentrypriv * )ch_calloc( sizeof( struct monitorentrypriv ), 1 );
 418         e->e_private = ( void * )mp;
 419
 420         mp->mp_info = NULL;
 421         mp->mp_children = e_tmp;
 422         mp->mp_next = NULL;
 423
 424         if ( monitor_cache_add( mi, e ) ) {
 425 #ifdef NEW_LOGGING
 426                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 427                         "unable to add entry '%s' to cache\n",
 428                         SLAPD_MONITOR_DN ));
 429 #else
 430                 Debug( LDAP_DEBUG_ANY,
 431                         "unable to add entry '%s' to cache\n%s%s",
 432                         SLAPD_MONITOR_DN, "", "" );
 433 #endif
 434                 return -1;
 435         }
 436
 437         be->be_private = mi;
 438
 439         return 0;
 440 }
 441
 442 int
 443 monitor_back_open(
 444         BackendInfo     *bi
 445 )
 446 {
 447         BackendDB               *be;
 448         struct monitorsubsys    *ms;
 449         struct berval dn = { sizeof(SLAPD_MONITOR_DN)-1, SLAPD_MONITOR_DN };
 450         struct berval ndn;
 451         int rc;
 452
 453         /*
 454          * adds the monitor backend
 455          */
 456         rc = dnNormalize2( NULL, &dn, &ndn );
 457         if( rc != LDAP_SUCCESS ) {
 458 #ifdef NEW_LOGGING
 459                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 460                         "monitor DN \"" SLAPD_MONITOR_DN "\" is invalid\n" ));
 461 #else
 462                 Debug( LDAP_DEBUG_ANY,
 463                         "monitor DN \"" SLAPD_MONITOR_DN "\" is invalid\n",
 464                         0, 0, 0 );
 465 #endif
 466                 return( -1 );
 467         }
 468
 469         be = select_backend( &ndn , 0, 0 );
 470         free( ndn.bv_val );
 471
 472         if ( be == NULL ) {
 473 #ifdef NEW_LOGGING
 474                 LDAP_LOG(( "operation", LDAP_LEVEL_CRIT,
 475                         "unable to get monitor backend\n" ));
 476 #else
 477                 Debug( LDAP_DEBUG_ANY,
 478                         "unable to get monitor backend\n", 0, 0, 0 );
 479 #endif
 480                 return( -1 );
 481         }
 482
 483         for ( ms = monitor_subsys; ms->mss_name != NULL; ms++ ) {
 484                 if ( ms->mss_init && ( *ms->mss_init )( be ) ) {
 485                         return( -1 );
 486                 }
 487         }
 488
 489         return( 0 );
 490 }
 491
 492 int
 493 monitor_back_config(
 494         BackendInfo     *bi,
 495         const char      *fname,
 496         int             lineno,
 497         int             argc,
 498         char            **argv
 499 )
 500 {
 501         /*
 502          * eventually, will hold backend specific configuration parameters
 503          */
 504         return 0;
 505 }
 506
 507 int
 508 monitor_back_db_config(
 509         Backend     *be,
 510         const char  *fname,
 511         int         lineno,
 512         int         argc,
 513         char        **argv
 514 )
 515 {
 516 #ifdef NEW_LOGGING
 517         LDAP_LOG(( "config", LDAP_DEBUG_NOTICE,
 518                 "line %d of file '%s' will be ignored\n", lineno, fname ));
 519 #else
 520         Debug( LDAP_DEBUG_CONFIG,
 521                 "line %d of file '%s' will be ignored\n%s", lineno, fname, "" );
 522 #endif
 523         return( 0 );
 524 }
 525
 526 int
 527 monitor_back_db_destroy(
 528         BackendDB       *be
 529 )
 530 {
 531         /*
 532          * FIXME: destroys all the data
 533          */
 534         return 0;
 535 }
 536