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

   1 /* monitor.c - monitor mdb backend */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2017 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16
  17 #include "portable.h"
  18
  19 #include <stdio.h>
  20 #include <ac/string.h>
  21 #include <ac/unistd.h>
  22 #include <ac/stdlib.h>
  23 #include <ac/errno.h>
  24 #include <sys/stat.h>
  25 #include "lutil.h"
  26 #include "back-mdb.h"
  27
  28 #include "../back-monitor/back-monitor.h"
  29
  30 #include "config.h"
  31
  32 static ObjectClass              *oc_olmMDBDatabase;
  33
  34 static AttributeDescription *ad_olmDbDirectory;
  35
  36 #ifdef MDB_MONITOR_IDX
  37 static int
  38 mdb_monitor_idx_entry_add(
  39         struct mdb_info *mdb,
  40         Entry           *e );
  41
  42 static AttributeDescription     *ad_olmDbNotIndexed;
  43 #endif /* MDB_MONITOR_IDX */
  44
  45 /*
  46  * NOTE: there's some confusion in monitor OID arc;
  47  * by now, let's consider:
  48  *
  49  * Subsystems monitor attributes        1.3.6.1.4.1.4203.666.1.55.0
  50  * Databases monitor attributes         1.3.6.1.4.1.4203.666.1.55.0.1
  51  * MDB database monitor attributes      1.3.6.1.4.1.4203.666.1.55.0.1.3
  52  *
  53  * Subsystems monitor objectclasses     1.3.6.1.4.1.4203.666.3.16.0
  54  * Databases monitor objectclasses      1.3.6.1.4.1.4203.666.3.16.0.1
  55  * MDB database monitor objectclasses   1.3.6.1.4.1.4203.666.3.16.0.1.3
  56  */
  57
  58 static struct {
  59         char                    *name;
  60         char                    *oid;
  61 }               s_oid[] = {
  62         { "olmMDBAttributes",                   "olmDatabaseAttributes:1" },
  63         { "olmMDBObjectClasses",                "olmDatabaseObjectClasses:1" },
  64
  65         { NULL }
  66 };
  67
  68 static struct {
  69         char                    *desc;
  70         AttributeDescription    **ad;
  71 }               s_at[] = {
  72         { "( olmDatabaseAttributes:1 "
  73                 "NAME ( 'olmDbDirectory' ) "
  74                 "DESC 'Path name of the directory "
  75                         "where the database environment resides' "
  76                 "SUP monitoredInfo "
  77                 "NO-USER-MODIFICATION "
  78                 "USAGE dSAOperation )",
  79                 &ad_olmDbDirectory },
  80
  81 #ifdef MDB_MONITOR_IDX
  82         { "( olmDatabaseAttributes:2 "
  83                 "NAME ( 'olmDbNotIndexed' ) "
  84                 "DESC 'Missing indexes resulting from candidate selection' "
  85                 "SUP monitoredInfo "
  86                 "NO-USER-MODIFICATION "
  87                 "USAGE dSAOperation )",
  88                 &ad_olmDbNotIndexed },
  89 #endif /* MDB_MONITOR_IDX */
  90
  91         { NULL }
  92 };
  93
  94 static struct {
  95         char            *desc;
  96         ObjectClass     **oc;
  97 }               s_oc[] = {
  98         /* augments an existing object, so it must be AUXILIARY
  99          * FIXME: derive from some ABSTRACT "monitoredEntity"? */
 100         { "( olmMDBObjectClasses:2 "
 101                 "NAME ( 'olmMDBDatabase' ) "
 102                 "SUP top AUXILIARY "
 103                 "MAY ( "
 104                         "olmDbDirectory "
 105 #ifdef MDB_MONITOR_IDX
 106                         "$ olmDbNotIndexed "
 107 #endif /* MDB_MONITOR_IDX */
 108                         ") )",
 109                 &oc_olmMDBDatabase },
 110
 111         { NULL }
 112 };
 113
 114 static int
 115 mdb_monitor_update(
 116         Operation       *op,
 117         SlapReply       *rs,
 118         Entry           *e,
 119         void            *priv )
 120 {
 121 #ifdef MDB_MONITOR_IDX
 122         struct mdb_info         *mdb = (struct mdb_info *) priv;
 123
 124         mdb_monitor_idx_entry_add( mdb, e );
 125 #endif /* MDB_MONITOR_IDX */
 126
 127         return SLAP_CB_CONTINUE;
 128 }
 129
 130 #if 0   /* uncomment if required */
 131 static int
 132 mdb_monitor_modify(
 133         Operation       *op,
 134         SlapReply       *rs,
 135         Entry           *e,
 136         void            *priv )
 137 {
 138         return SLAP_CB_CONTINUE;
 139 }
 140 #endif
 141
 142 static int
 143 mdb_monitor_free(
 144         Entry           *e,
 145         void            **priv )
 146 {
 147         struct berval   values[ 2 ];
 148         Modification    mod = { 0 };
 149
 150         const char      *text;
 151         char            textbuf[ SLAP_TEXT_BUFLEN ];
 152
 153         int             i, rc;
 154
 155         /* NOTE: if slap_shutdown != 0, priv might have already been freed */
 156         *priv = NULL;
 157
 158         /* Remove objectClass */
 159         mod.sm_op = LDAP_MOD_DELETE;
 160         mod.sm_desc = slap_schema.si_ad_objectClass;
 161         mod.sm_values = values;
 162         mod.sm_numvals = 1;
 163         values[ 0 ] = oc_olmMDBDatabase->soc_cname;
 164         BER_BVZERO( &values[ 1 ] );
 165
 166         rc = modify_delete_values( e, &mod, 1, &text,
 167                 textbuf, sizeof( textbuf ) );
 168         /* don't care too much about return code... */
 169
 170         /* remove attrs */
 171         mod.sm_values = NULL;
 172         mod.sm_numvals = 0;
 173         for ( i = 0; s_at[ i ].desc != NULL; i++ ) {
 174                 mod.sm_desc = *s_at[ i ].ad;
 175                 rc = modify_delete_values( e, &mod, 1, &text,
 176                         textbuf, sizeof( textbuf ) );
 177                 /* don't care too much about return code... */
 178         }
 179
 180         return SLAP_CB_CONTINUE;
 181 }
 182
 183 /*
 184  * call from within mdb_initialize()
 185  */
 186 static int
 187 mdb_monitor_initialize( void )
 188 {
 189         int             i, code;
 190         ConfigArgs c;
 191         char    *argv[ 3 ];
 192
 193         static int      mdb_monitor_initialized = 0;
 194
 195         /* set to 0 when successfully initialized; otherwise, remember failure */
 196         static int      mdb_monitor_initialized_failure = 1;
 197
 198         if ( mdb_monitor_initialized++ ) {
 199                 return mdb_monitor_initialized_failure;
 200         }
 201
 202         if ( backend_info( "monitor" ) == NULL ) {
 203                 return -1;
 204         }
 205
 206         /* register schema here */
 207
 208         argv[ 0 ] = "back-mdb monitor";
 209         c.argv = argv;
 210         c.argc = 3;
 211         c.fname = argv[0];
 212
 213         for ( i = 0; s_oid[ i ].name; i++ ) {
 214                 c.lineno = i;
 215                 argv[ 1 ] = s_oid[ i ].name;
 216                 argv[ 2 ] = s_oid[ i ].oid;
 217
 218                 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
 219                         Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_monitor_initialize)
 220                                 ": unable to add "
 221                                 "objectIdentifier \"%s=%s\"\n",
 222                                 s_oid[ i ].name, s_oid[ i ].oid, 0 );
 223                         return 2;
 224                 }
 225         }
 226
 227         for ( i = 0; s_at[ i ].desc != NULL; i++ ) {
 228                 code = register_at( s_at[ i ].desc, s_at[ i ].ad, 1 );
 229                 if ( code != LDAP_SUCCESS ) {
 230                         Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_monitor_initialize)
 231                                 ": register_at failed for attributeType (%s)\n",
 232                                 s_at[ i ].desc, 0, 0 );
 233                         return 3;
 234
 235                 } else {
 236                         (*s_at[ i ].ad)->ad_type->sat_flags |= SLAP_AT_HIDE;
 237                 }
 238         }
 239
 240         for ( i = 0; s_oc[ i ].desc != NULL; i++ ) {
 241                 code = register_oc( s_oc[ i ].desc, s_oc[ i ].oc, 1 );
 242                 if ( code != LDAP_SUCCESS ) {
 243                         Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_monitor_initialize)
 244                                 ": register_oc failed for objectClass (%s)\n",
 245                                 s_oc[ i ].desc, 0, 0 );
 246                         return 4;
 247
 248                 } else {
 249                         (*s_oc[ i ].oc)->soc_flags |= SLAP_OC_HIDE;
 250                 }
 251         }
 252
 253         return ( mdb_monitor_initialized_failure = LDAP_SUCCESS );
 254 }
 255
 256 /*
 257  * call from within mdb_db_init()
 258  */
 259 int
 260 mdb_monitor_db_init( BackendDB *be )
 261 {
 262 #ifdef MDB_MONITOR_IDX
 263         struct mdb_info         *mdb = (struct mdb_info *) be->be_private;
 264 #endif /* MDB_MONITOR_IDX */
 265
 266         if ( mdb_monitor_initialize() == LDAP_SUCCESS ) {
 267                 /* monitoring in back-mdb is on by default */
 268                 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
 269         }
 270
 271 #ifdef MDB_MONITOR_IDX
 272         mdb->mi_idx = NULL;
 273         ldap_pvt_thread_mutex_init( &mdb->mi_idx_mutex );
 274 #endif /* MDB_MONITOR_IDX */
 275
 276         return 0;
 277 }
 278
 279 /*
 280  * call from within mdb_db_open()
 281  */
 282 int
 283 mdb_monitor_db_open( BackendDB *be )
 284 {
 285         struct mdb_info         *mdb = (struct mdb_info *) be->be_private;
 286         Attribute               *a, *next;
 287         monitor_callback_t      *cb = NULL;
 288         int                     rc = 0;
 289         BackendInfo             *mi;
 290         monitor_extra_t         *mbe;
 291
 292         if ( !SLAP_DBMONITORING( be ) ) {
 293                 return 0;
 294         }
 295
 296         mi = backend_info( "monitor" );
 297         if ( !mi || !mi->bi_extra ) {
 298                 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
 299                 return 0;
 300         }
 301         mbe = mi->bi_extra;
 302
 303         /* don't bother if monitor is not configured */
 304         if ( !mbe->is_configured() ) {
 305                 static int warning = 0;
 306
 307                 if ( warning++ == 0 ) {
 308                         Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_monitor_db_open)
 309                                 ": monitoring disabled; "
 310                                 "configure monitor database to enable\n",
 311                                 0, 0, 0 );
 312                 }
 313
 314                 return 0;
 315         }
 316
 317         /* alloc as many as required (plus 1 for objectClass) */
 318         a = attrs_alloc( 1 + 1 );
 319         if ( a == NULL ) {
 320                 rc = 1;
 321                 goto cleanup;
 322         }
 323
 324         a->a_desc = slap_schema.si_ad_objectClass;
 325         attr_valadd( a, &oc_olmMDBDatabase->soc_cname, NULL, 1 );
 326         next = a->a_next;
 327
 328         {
 329                 struct berval   bv, nbv;
 330                 ber_len_t       pathlen = 0, len = 0;
 331                 char            path[ MAXPATHLEN ] = { '\0' };
 332                 char            *fname = mdb->mi_dbenv_home,
 333                                 *ptr;
 334
 335                 len = strlen( fname );
 336                 if ( fname[ 0 ] != '/' ) {
 337                         /* get full path name */
 338                         getcwd( path, sizeof( path ) );
 339                         pathlen = strlen( path );
 340
 341                         if ( fname[ 0 ] == '.' && fname[ 1 ] == '/' ) {
 342                                 fname += 2;
 343                                 len -= 2;
 344                         }
 345                 }
 346
 347                 bv.bv_len = pathlen + STRLENOF( "/" ) + len;
 348                 ptr = bv.bv_val = ch_malloc( bv.bv_len + STRLENOF( "/" ) + 1 );
 349                 if ( pathlen ) {
 350                         ptr = lutil_strncopy( ptr, path, pathlen );
 351                         ptr[ 0 ] = '/';
 352                         ptr++;
 353                 }
 354                 ptr = lutil_strncopy( ptr, fname, len );
 355                 if ( ptr[ -1 ] != '/' ) {
 356                         ptr[ 0 ] = '/';
 357                         ptr++;
 358                 }
 359                 ptr[ 0 ] = '\0';
 360
 361                 attr_normalize_one( ad_olmDbDirectory, &bv, &nbv, NULL );
 362
 363                 next->a_desc = ad_olmDbDirectory;
 364                 next->a_vals = ch_calloc( sizeof( struct berval ), 2 );
 365                 next->a_vals[ 0 ] = bv;
 366                 next->a_numvals = 1;
 367
 368                 if ( BER_BVISNULL( &nbv ) ) {
 369                         next->a_nvals = next->a_vals;
 370
 371                 } else {
 372                         next->a_nvals = ch_calloc( sizeof( struct berval ), 2 );
 373                         next->a_nvals[ 0 ] = nbv;
 374                 }
 375
 376                 next = next->a_next;
 377         }
 378
 379         cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
 380         cb->mc_update = mdb_monitor_update;
 381 #if 0   /* uncomment if required */
 382         cb->mc_modify = mdb_monitor_modify;
 383 #endif
 384         cb->mc_free = mdb_monitor_free;
 385         cb->mc_private = (void *)mdb;
 386
 387         /* make sure the database is registered; then add monitor attributes */
 388         rc = mbe->register_database( be, &mdb->mi_monitor.mdm_ndn );
 389         if ( rc == 0 ) {
 390                 rc = mbe->register_entry_attrs( &mdb->mi_monitor.mdm_ndn, a, cb,
 391                         NULL, -1, NULL );
 392         }
 393
 394 cleanup:;
 395         if ( rc != 0 ) {
 396                 if ( cb != NULL ) {
 397                         ch_free( cb );
 398                         cb = NULL;
 399                 }
 400
 401                 if ( a != NULL ) {
 402                         attrs_free( a );
 403                         a = NULL;
 404                 }
 405         }
 406
 407         /* store for cleanup */
 408         mdb->mi_monitor.mdm_cb = (void *)cb;
 409
 410         /* we don't need to keep track of the attributes, because
 411          * mdb_monitor_free() takes care of everything */
 412         if ( a != NULL ) {
 413                 attrs_free( a );
 414         }
 415
 416         return rc;
 417 }
 418
 419 /*
 420  * call from within mdb_db_close()
 421  */
 422 int
 423 mdb_monitor_db_close( BackendDB *be )
 424 {
 425         struct mdb_info         *mdb = (struct mdb_info *) be->be_private;
 426
 427         if ( !BER_BVISNULL( &mdb->mi_monitor.mdm_ndn ) ) {
 428                 BackendInfo             *mi = backend_info( "monitor" );
 429                 monitor_extra_t         *mbe;
 430
 431                 if ( mi && &mi->bi_extra ) {
 432                         mbe = mi->bi_extra;
 433                         mbe->unregister_entry_callback( &mdb->mi_monitor.mdm_ndn,
 434                                 (monitor_callback_t *)mdb->mi_monitor.mdm_cb,
 435                                 NULL, 0, NULL );
 436                 }
 437
 438                 memset( &mdb->mi_monitor, 0, sizeof( mdb->mi_monitor ) );
 439         }
 440
 441         return 0;
 442 }
 443
 444 /*
 445  * call from within mdb_db_destroy()
 446  */
 447 int
 448 mdb_monitor_db_destroy( BackendDB *be )
 449 {
 450 #ifdef MDB_MONITOR_IDX
 451         struct mdb_info         *mdb = (struct mdb_info *) be->be_private;
 452
 453         /* TODO: free tree */
 454         ldap_pvt_thread_mutex_destroy( &mdb->mi_idx_mutex );
 455         avl_free( mdb->mi_idx, ch_free );
 456 #endif /* MDB_MONITOR_IDX */
 457
 458         return 0;
 459 }
 460
 461 #ifdef MDB_MONITOR_IDX
 462
 463 #define MDB_MONITOR_IDX_TYPES   (4)
 464
 465 typedef struct monitor_idx_t monitor_idx_t;
 466
 467 struct monitor_idx_t {
 468         AttributeDescription    *idx_ad;
 469         unsigned long           idx_count[MDB_MONITOR_IDX_TYPES];
 470 };
 471
 472 static int
 473 mdb_monitor_bitmask2key( slap_mask_t bitmask )
 474 {
 475         int     key;
 476
 477         for ( key = 0; key < 8 * (int)sizeof(slap_mask_t) && !( bitmask & 0x1U );
 478                         key++ )
 479                 bitmask >>= 1;
 480
 481         return key;
 482 }
 483
 484 static struct berval idxbv[] = {
 485         BER_BVC( "present=" ),
 486         BER_BVC( "equality=" ),
 487         BER_BVC( "approx=" ),
 488         BER_BVC( "substr=" ),
 489         BER_BVNULL
 490 };
 491
 492 static ber_len_t
 493 mdb_monitor_idx2len( monitor_idx_t *idx )
 494 {
 495         int             i;
 496         ber_len_t       len = 0;
 497
 498         for ( i = 0; i < MDB_MONITOR_IDX_TYPES; i++ ) {
 499                 if ( idx->idx_count[ i ] != 0 ) {
 500                         len += idxbv[i].bv_len;
 501                 }
 502         }
 503
 504         return len;
 505 }
 506
 507 static int
 508 monitor_idx_cmp( const void *p1, const void *p2 )
 509 {
 510         const monitor_idx_t     *idx1 = (const monitor_idx_t *)p1;
 511         const monitor_idx_t     *idx2 = (const monitor_idx_t *)p2;
 512
 513         return SLAP_PTRCMP( idx1->idx_ad, idx2->idx_ad );
 514 }
 515
 516 static int
 517 monitor_idx_dup( void *p1, void *p2 )
 518 {
 519         monitor_idx_t   *idx1 = (monitor_idx_t *)p1;
 520         monitor_idx_t   *idx2 = (monitor_idx_t *)p2;
 521
 522         return SLAP_PTRCMP( idx1->idx_ad, idx2->idx_ad ) == 0 ? -1 : 0;
 523 }
 524
 525 int
 526 mdb_monitor_idx_add(
 527         struct mdb_info         *mdb,
 528         AttributeDescription    *desc,
 529         slap_mask_t             type )
 530 {
 531         monitor_idx_t           idx_dummy = { 0 },
 532                                 *idx;
 533         int                     rc = 0, key;
 534
 535         idx_dummy.idx_ad = desc;
 536         key = mdb_monitor_bitmask2key( type ) - 1;
 537         if ( key >= MDB_MONITOR_IDX_TYPES ) {
 538                 /* invalid index type */
 539                 return -1;
 540         }
 541
 542         ldap_pvt_thread_mutex_lock( &mdb->mi_idx_mutex );
 543
 544         idx = (monitor_idx_t *)avl_find( mdb->mi_idx,
 545                 (caddr_t)&idx_dummy, monitor_idx_cmp );
 546         if ( idx == NULL ) {
 547                 idx = (monitor_idx_t *)ch_calloc( sizeof( monitor_idx_t ), 1 );
 548                 idx->idx_ad = desc;
 549                 idx->idx_count[ key ] = 1;
 550
 551                 switch ( avl_insert( &mdb->mi_idx, (caddr_t)idx,
 552                         monitor_idx_cmp, monitor_idx_dup ) )
 553                 {
 554                 case 0:
 555                         break;
 556
 557                 default:
 558                         ch_free( idx );
 559                         rc = -1;
 560                 }
 561
 562         } else {
 563                 idx->idx_count[ key ]++;
 564         }
 565
 566         ldap_pvt_thread_mutex_unlock( &mdb->mi_idx_mutex );
 567
 568         return rc;
 569 }
 570
 571 static int
 572 mdb_monitor_idx_apply( void *v_idx, void *v_valp )
 573 {
 574         monitor_idx_t   *idx = (monitor_idx_t *)v_idx;
 575         BerVarray       *valp = (BerVarray *)v_valp;
 576
 577         struct berval   bv;
 578         char            *ptr;
 579         char            count_buf[ MDB_MONITOR_IDX_TYPES ][ SLAP_TEXT_BUFLEN ];
 580         ber_len_t       count_len[ MDB_MONITOR_IDX_TYPES ],
 581                         idx_len;
 582         int             i, num = 0;
 583
 584         idx_len = mdb_monitor_idx2len( idx );
 585
 586         bv.bv_len = 0;
 587         for ( i = 0; i < MDB_MONITOR_IDX_TYPES; i++ ) {
 588                 if ( idx->idx_count[ i ] == 0 ) {
 589                         continue;
 590                 }
 591
 592                 count_len[ i ] = snprintf( count_buf[ i ],
 593                         sizeof( count_buf[ i ] ), "%lu", idx->idx_count[ i ] );
 594                 bv.bv_len += count_len[ i ];
 595                 num++;
 596         }
 597
 598         bv.bv_len += idx->idx_ad->ad_cname.bv_len
 599                 + num
 600                 + idx_len;
 601         ptr = bv.bv_val = ch_malloc( bv.bv_len + 1 );
 602         ptr = lutil_strcopy( ptr, idx->idx_ad->ad_cname.bv_val );
 603         for ( i = 0; i < MDB_MONITOR_IDX_TYPES; i++ ) {
 604                 if ( idx->idx_count[ i ] == 0 ) {
 605                         continue;
 606                 }
 607
 608                 ptr[ 0 ] = '#';
 609                 ++ptr;
 610                 ptr = lutil_strcopy( ptr, idxbv[ i ].bv_val );
 611                 ptr = lutil_strcopy( ptr, count_buf[ i ] );
 612         }
 613
 614         ber_bvarray_add( valp, &bv );
 615
 616         return 0;
 617 }
 618
 619 static int
 620 mdb_monitor_idx_entry_add(
 621         struct mdb_info *mdb,
 622         Entry           *e )
 623 {
 624         BerVarray       vals = NULL;
 625         Attribute       *a;
 626
 627         a = attr_find( e->e_attrs, ad_olmDbNotIndexed );
 628
 629         ldap_pvt_thread_mutex_lock( &mdb->mi_idx_mutex );
 630
 631         avl_apply( mdb->mi_idx, mdb_monitor_idx_apply,
 632                 &vals, -1, AVL_INORDER );
 633
 634         ldap_pvt_thread_mutex_unlock( &mdb->mi_idx_mutex );
 635
 636         if ( vals != NULL ) {
 637                 if ( a != NULL ) {
 638                         assert( a->a_nvals == a->a_vals );
 639
 640                         ber_bvarray_free( a->a_vals );
 641
 642                 } else {
 643                         Attribute       **ap;
 644
 645                         for ( ap = &e->e_attrs; *ap != NULL; ap = &(*ap)->a_next )
 646                                 ;
 647                         *ap = attr_alloc( ad_olmDbNotIndexed );
 648                         a = *ap;
 649                 }
 650                 a->a_vals = vals;
 651                 a->a_nvals = a->a_vals;
 652         }
 653
 654         return 0;
 655 }
 656
 657 #endif /* MDB_MONITOR_IDX */