]> git.sur5r.net Git - openldap/blob - servers/slapd/back-mdb/config.c
52c789e01c0c6add85c2c8d545e61deb7d8d241a
[openldap] / servers / slapd / back-mdb / config.c
1 /* config.c - mdb backend configuration file routine */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 2000-2011 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/ctype.h>
21 #include <ac/string.h>
22 #include <ac/errno.h>
23
24 #include "back-mdb.h"
25
26 #include "config.h"
27
28 #include "lutil.h"
29 #include "ldap_rq.h"
30
31 static ConfigDriver mdb_cf_gen;
32
33 enum {
34         MDB_CHKPT = 1,
35         MDB_DIRECTORY,
36         MDB_DBNOSYNC,
37         MDB_INDEX,
38         MDB_MAXSIZE,
39         MDB_MODE,
40         MDB_SSTACK,
41 };
42
43 static ConfigTable mdbcfg[] = {
44         { "directory", "dir", 2, 2, 0, ARG_STRING|ARG_MAGIC|MDB_DIRECTORY,
45                 mdb_cf_gen, "( OLcfgDbAt:0.1 NAME 'olcDbDirectory' "
46                         "DESC 'Directory for database content' "
47                         "EQUALITY caseIgnoreMatch "
48                         "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
49         { "checkpoint", "kbyte> <min", 3, 3, 0, ARG_MAGIC|MDB_CHKPT,
50                 mdb_cf_gen, "( OLcfgDbAt:1.2 NAME 'olcDbCheckpoint' "
51                         "DESC 'Database checkpoint interval in kbytes and minutes' "
52                         "SYNTAX OMsDirectoryString SINGLE-VALUE )",NULL, NULL },
53         { "dbnosync", NULL, 1, 2, 0, ARG_ON_OFF|ARG_MAGIC|MDB_DBNOSYNC,
54                 mdb_cf_gen, "( OLcfgDbAt:1.4 NAME 'olcDbNoSync' "
55                         "DESC 'Disable synchronous database writes' "
56                         "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
57         { "index", "attr> <[pres,eq,approx,sub]", 2, 3, 0, ARG_MAGIC|MDB_INDEX,
58                 mdb_cf_gen, "( OLcfgDbAt:0.2 NAME 'olcDbIndex' "
59                 "DESC 'Attribute index parameters' "
60                 "EQUALITY caseIgnoreMatch "
61                 "SYNTAX OMsDirectoryString )", NULL, NULL },
62         { "maxsize", "size", 2, 2, 0, ARG_ULONG|ARG_MAGIC|MDB_MAXSIZE,
63                 mdb_cf_gen, "( OLcfgDbAt:12.1 NAME 'olcDbMaxSize' "
64                 "DESC 'Maximum size of DB in bytes' "
65                 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
66         { "mode", "mode", 2, 2, 0, ARG_MAGIC|MDB_MODE,
67                 mdb_cf_gen, "( OLcfgDbAt:0.3 NAME 'olcDbMode' "
68                 "DESC 'Unix permissions of database files' "
69                 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
70         { "searchstack", "depth", 2, 2, 0, ARG_INT|ARG_MAGIC|MDB_SSTACK,
71                 mdb_cf_gen, "( OLcfgDbAt:1.9 NAME 'olcDbSearchStack' "
72                 "DESC 'Depth of search stack in IDLs' "
73                 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
74         { NULL, NULL, 0, 0, 0, ARG_IGNORED,
75                 NULL, NULL, NULL, NULL }
76 };
77
78 static ConfigOCs mdbocs[] = {
79         {
80                 "( OLcfgDbOc:12.1 "
81                 "NAME 'olcMdbConfig' "
82                 "DESC 'MDB backend configuration' "
83                 "SUP olcDatabaseConfig "
84                 "MUST olcDbDirectory "
85                 "MAY ( olcDbCheckpoint $ "
86                 "olcDbNoSync $ olcDbIndex $ olcDbMaxsize $ "
87                 "olcDbMode $ olcDbSearchStack ) )",
88                         Cft_Database, mdbcfg },
89         { NULL, 0, NULL }
90 };
91
92 /* perform periodic syncs */
93 static void *
94 mdb_checkpoint( void *ctx, void *arg )
95 {
96         struct re_s *rtask = arg;
97         struct mdb_info *mdb = rtask->arg;
98         
99         mdb_env_sync( mdb->mi_dbenv, 0 );
100         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
101         ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
102         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
103         return NULL;
104 }
105
106 /* reindex entries on the fly */
107 static void *
108 mdb_online_index( void *ctx, void *arg )
109 {
110 #if 0
111         struct re_s *rtask = arg;
112         BackendDB *be = rtask->arg;
113         struct mdb_info *mdb = be->be_private;
114
115         Connection conn = {0};
116         OperationBuffer opbuf;
117         Operation *op;
118
119         DBC *curs;
120         DBT key, data;
121         DB_TXN *txn;
122         DB_LOCK lock;
123         ID id, nid;
124         EntryInfo *ei;
125         int rc, getnext = 1;
126         int i;
127
128         connection_fake_init( &conn, &opbuf, ctx );
129         op = &opbuf.ob_op;
130
131         op->o_bd = be;
132
133         DBTzero( &key );
134         DBTzero( &data );
135         
136         id = 1;
137         key.data = &nid;
138         key.size = key.ulen = sizeof(ID);
139         key.flags = DB_DBT_USERMEM;
140
141         data.flags = DB_DBT_USERMEM | DB_DBT_PARTIAL;
142         data.dlen = data.ulen = 0;
143
144         while ( 1 ) {
145                 if ( slapd_shutdown )
146                         break;
147
148                 rc = TXN_BEGIN( mdb->bi_dbenv, NULL, &txn, mdb->bi_db_opflags );
149                 if ( rc ) 
150                         break;
151                 if ( getnext ) {
152                         getnext = 0;
153                         MDB_ID2DISK( id, &nid );
154                         rc = mdb->bi_id2entry->bdi_db->cursor(
155                                 mdb->bi_id2entry->bdi_db, txn, &curs, mdb->bi_db_opflags );
156                         if ( rc ) {
157                                 TXN_ABORT( txn );
158                                 break;
159                         }
160                         rc = curs->c_get( curs, &key, &data, DB_SET_RANGE );
161                         curs->c_close( curs );
162                         if ( rc ) {
163                                 TXN_ABORT( txn );
164                                 if ( rc == DB_NOTFOUND )
165                                         rc = 0;
166                                 if ( rc == DB_LOCK_DEADLOCK ) {
167                                         ldap_pvt_thread_yield();
168                                         continue;
169                                 }
170                                 break;
171                         }
172                         MDB_DISK2ID( &nid, &id );
173                 }
174
175                 ei = NULL;
176                 rc = mdb_cache_find_id( op, txn, id, &ei, 0, &lock );
177                 if ( rc ) {
178                         TXN_ABORT( txn );
179                         if ( rc == DB_LOCK_DEADLOCK ) {
180                                 ldap_pvt_thread_yield();
181                                 continue;
182                         }
183                         if ( rc == DB_NOTFOUND ) {
184                                 id++;
185                                 getnext = 1;
186                                 continue;
187                         }
188                         break;
189                 }
190                 if ( ei->bei_e ) {
191                         rc = mdb_index_entry( op, txn, MDB_INDEX_UPDATE_OP, ei->bei_e );
192                         if ( rc == DB_LOCK_DEADLOCK ) {
193                                 TXN_ABORT( txn );
194                                 ldap_pvt_thread_yield();
195                                 continue;
196                         }
197                         if ( rc == 0 ) {
198                                 rc = TXN_COMMIT( txn, 0 );
199                                 txn = NULL;
200                         }
201                         if ( rc )
202                                 break;
203                 }
204                 id++;
205                 getnext = 1;
206         }
207
208         for ( i = 0; i < mdb->bi_nattrs; i++ ) {
209                 if ( mdb->bi_attrs[ i ]->ai_indexmask & MDB_INDEX_DELETING
210                         || mdb->bi_attrs[ i ]->ai_newmask == 0 )
211                 {
212                         continue;
213                 }
214                 mdb->bi_attrs[ i ]->ai_indexmask = mdb->bi_attrs[ i ]->ai_newmask;
215                 mdb->bi_attrs[ i ]->ai_newmask = 0;
216         }
217
218         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
219         ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
220         mdb->bi_index_task = NULL;
221         ldap_pvt_runqueue_remove( &slapd_rq, rtask );
222         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
223
224 #endif
225         return NULL;
226 }
227
228 /* Cleanup loose ends after Modify completes */
229 static int
230 mdb_cf_cleanup( ConfigArgs *c )
231 {
232         struct mdb_info *mdb = c->be->be_private;
233         int rc = 0;
234
235         if ( mdb->mi_flags & MDB_DEL_INDEX ) {
236                 mdb_attr_flush( mdb );
237                 mdb->mi_flags ^= MDB_DEL_INDEX;
238         }
239         
240         if ( mdb->mi_flags & MDB_RE_OPEN ) {
241                 mdb->mi_flags ^= MDB_RE_OPEN;
242                 rc = c->be->bd_info->bi_db_close( c->be, &c->reply );
243                 if ( rc == 0 )
244                         rc = c->be->bd_info->bi_db_open( c->be, &c->reply );
245                 /* If this fails, we need to restart */
246                 if ( rc ) {
247                         slapd_shutdown = 2;
248                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
249                                 "failed to reopen database, rc=%d", rc );
250                         Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_cf_cleanup)
251                                 ": %s\n", c->cr_msg, 0, 0 );
252                         rc = LDAP_OTHER;
253                 }
254         }
255         return rc;
256 }
257
258 static int
259 mdb_cf_gen( ConfigArgs *c )
260 {
261         struct mdb_info *mdb = c->be->be_private;
262         int rc;
263
264         if ( c->op == SLAP_CONFIG_EMIT ) {
265                 rc = 0;
266                 switch( c->type ) {
267                 case MDB_MODE: {
268                         char buf[64];
269                         struct berval bv;
270                         bv.bv_len = snprintf( buf, sizeof(buf), "0%o", mdb->mi_dbenv_mode );
271                         if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
272                                 bv.bv_val = buf;
273                                 value_add_one( &c->rvalue_vals, &bv );
274                         } else {
275                                 rc = 1;
276                         }
277                         } break;
278
279                 case MDB_CHKPT:
280                         if ( mdb->mi_txn_cp ) {
281                                 char buf[64];
282                                 struct berval bv;
283                                 bv.bv_len = snprintf( buf, sizeof(buf), "%ld %ld",
284                                         (long) mdb->mi_txn_cp_kbyte, (long) mdb->mi_txn_cp_min );
285                                 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
286                                         bv.bv_val = buf;
287                                         value_add_one( &c->rvalue_vals, &bv );
288                                 } else {
289                                         rc = 1;
290                                 }
291                         } else {
292                                 rc = 1;
293                         }
294                         break;
295
296                 case MDB_DIRECTORY:
297                         if ( mdb->mi_dbenv_home ) {
298                                 c->value_string = ch_strdup( mdb->mi_dbenv_home );
299                         } else {
300                                 rc = 1;
301                         }
302                         break;
303
304                 case MDB_DBNOSYNC:
305                         if ( mdb->mi_dbenv_flags & MDB_NOSYNC )
306                                 c->value_int = 1;
307                         break;
308                         
309                 case MDB_INDEX:
310                         mdb_attr_index_unparse( mdb, &c->rvalue_vals );
311                         if ( !c->rvalue_vals ) rc = 1;
312                         break;
313
314                 case MDB_SSTACK:
315                         c->value_int = mdb->mi_search_stack_depth;
316                         break;
317
318                 case MDB_MAXSIZE:
319                         c->value_ulong = mdb->mi_mapsize;
320                         break;
321                 }
322                 return rc;
323         } else if ( c->op == LDAP_MOD_DELETE ) {
324                 rc = 0;
325                 switch( c->type ) {
326                 case MDB_MODE:
327 #if 0
328                         /* FIXME: does it make any sense to change the mode,
329                          * if we don't exec a chmod()? */
330                         mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
331                         break;
332 #endif
333
334                 /* single-valued no-ops */
335                 case MDB_SSTACK:
336                 case MDB_MAXSIZE:
337                         break;
338
339                 case MDB_CHKPT:
340                         if ( mdb->mi_txn_cp_task ) {
341                                 struct re_s *re = mdb->mi_txn_cp_task;
342                                 mdb->mi_txn_cp_task = NULL;
343                                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
344                                 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
345                                         ldap_pvt_runqueue_stoptask( &slapd_rq, re );
346                                 ldap_pvt_runqueue_remove( &slapd_rq, re );
347                                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
348                         }
349                         mdb->mi_txn_cp = 0;
350                         break;
351                 case MDB_DIRECTORY:
352                         mdb->mi_flags |= MDB_RE_OPEN;
353                         ch_free( mdb->mi_dbenv_home );
354                         mdb->mi_dbenv_home = NULL;
355                         c->cleanup = mdb_cf_cleanup;
356                         ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
357                         break;
358                 case MDB_DBNOSYNC:
359                         mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
360                         break;
361                 case MDB_INDEX:
362                         if ( c->valx == -1 ) {
363                                 int i;
364
365                                 /* delete all (FIXME) */
366                                 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
367                                         mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
368                                 }
369                                 mdb->mi_flags |= MDB_DEL_INDEX;
370                                 c->cleanup = mdb_cf_cleanup;
371
372                         } else {
373                                 struct berval bv, def = BER_BVC("default");
374                                 char *ptr;
375
376                                 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
377
378                                 bv.bv_val = c->line;
379                                 bv.bv_len = ptr - bv.bv_val;
380                                 if ( bvmatch( &bv, &def )) {
381                                         mdb->mi_defaultmask = 0;
382
383                                 } else {
384                                         int i;
385                                         char **attrs;
386                                         char sep;
387
388                                         sep = bv.bv_val[ bv.bv_len ];
389                                         bv.bv_val[ bv.bv_len ] = '\0';
390                                         attrs = ldap_str2charray( bv.bv_val, "," );
391
392                                         for ( i = 0; attrs[ i ]; i++ ) {
393                                                 AttributeDescription *ad = NULL;
394                                                 const char *text;
395                                                 AttrInfo *ai;
396
397                                                 slap_str2ad( attrs[ i ], &ad, &text );
398                                                 /* if we got here... */
399                                                 assert( ad != NULL );
400
401                                                 ai = mdb_attr_mask( mdb, ad );
402                                                 /* if we got here... */
403                                                 assert( ai != NULL );
404
405                                                 ai->ai_indexmask |= MDB_INDEX_DELETING;
406                                                 mdb->mi_flags |= MDB_DEL_INDEX;
407                                                 c->cleanup = mdb_cf_cleanup;
408                                         }
409
410                                         bv.bv_val[ bv.bv_len ] = sep;
411                                         ldap_charray_free( attrs );
412                                 }
413                         }
414                         break;
415                 }
416                 return rc;
417         }
418
419         switch( c->type ) {
420         case MDB_MODE:
421                 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
422                         long mode;
423                         char *next;
424                         errno = 0;
425                         mode = strtol( c->argv[1], &next, 0 );
426                         if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
427                                 fprintf( stderr, "%s: "
428                                         "unable to parse mode=\"%s\".\n",
429                                         c->log, c->argv[1] );
430                                 return 1;
431                         }
432                         mdb->mi_dbenv_mode = mode;
433
434                 } else {
435                         char *m = c->argv[1];
436                         int who, what, mode = 0;
437
438                         if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
439                                 return 1;
440                         }
441
442                         if ( m[0] != '-' ) {
443                                 return 1;
444                         }
445
446                         m++;
447                         for ( who = 0; who < 3; who++ ) {
448                                 for ( what = 0; what < 3; what++, m++ ) {
449                                         if ( m[0] == '-' ) {
450                                                 continue;
451                                         } else if ( m[0] != "rwx"[what] ) {
452                                                 return 1;
453                                         }
454                                         mode += ((1 << (2 - what)) << 3*(2 - who));
455                                 }
456                         }
457                         mdb->mi_dbenv_mode = mode;
458                 }
459                 break;
460         case MDB_CHKPT: {
461                 long    l;
462                 mdb->mi_txn_cp = 1;
463                 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
464                         fprintf( stderr, "%s: "
465                                 "invalid kbyte \"%s\" in \"checkpoint\".\n",
466                                 c->log, c->argv[1] );
467                         return 1;
468                 }
469                 mdb->mi_txn_cp_kbyte = l;
470                 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
471                         fprintf( stderr, "%s: "
472                                 "invalid minutes \"%s\" in \"checkpoint\".\n",
473                                 c->log, c->argv[2] );
474                         return 1;
475                 }
476                 mdb->mi_txn_cp_min = l;
477                 /* If we're in server mode and time-based checkpointing is enabled,
478                  * submit a task to perform periodic checkpoints.
479                  */
480                 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
481                         struct re_s *re = mdb->mi_txn_cp_task;
482                         if ( re ) {
483                                 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
484                         } else {
485                                 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
486                                         fprintf( stderr, "%s: "
487                                                 "\"checkpoint\" must occur after \"suffix\".\n",
488                                                 c->log );
489                                         return 1;
490                                 }
491                                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
492                                 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
493                                         mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
494                                         LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
495                                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
496                         }
497                 }
498                 } break;
499
500         case MDB_DIRECTORY: {
501                 FILE *f;
502                 char *ptr, *testpath;
503                 int len;
504
505                 len = strlen( c->value_string );
506                 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
507                 ptr = lutil_strcopy( testpath, c->value_string );
508                 *ptr++ = LDAP_DIRSEP[0];
509                 strcpy( ptr, "DUMMY" );
510                 f = fopen( testpath, "w" );
511                 if ( f ) {
512                         fclose( f );
513                         unlink( testpath );
514                 }
515                 ch_free( testpath );
516                 if ( !f ) {
517                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
518                                 c->log, strerror( errno ));
519                         Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
520                         return -1;
521                 }
522
523                 if ( mdb->mi_dbenv_home )
524                         ch_free( mdb->mi_dbenv_home );
525                 mdb->mi_dbenv_home = c->value_string;
526
527                 }
528                 break;
529
530         case MDB_DBNOSYNC:
531                 if ( c->value_int )
532                         mdb->mi_dbenv_flags |= MDB_NOSYNC;
533                 else
534                         mdb->mi_dbenv_flags ^= MDB_NOSYNC;
535                 if ( mdb->mi_flags & MDB_IS_OPEN ) {
536                         mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
537                                 c->value_int );
538                 }
539                 break;
540
541         case MDB_INDEX:
542                 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
543                         c->argc - 1, &c->argv[1], &c->reply);
544
545                 if( rc != LDAP_SUCCESS ) return 1;
546                 if (( mdb->mi_flags & MDB_IS_OPEN ) && !mdb->mi_index_task ) {
547                         /* Start the task as soon as we finish here. Set a long
548                          * interval (10 hours) so that it only gets scheduled once.
549                          */
550                         if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
551                                 fprintf( stderr, "%s: "
552                                         "\"index\" must occur after \"suffix\".\n",
553                                         c->log );
554                                 return 1;
555                         }
556                         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
557                         mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
558                                 mdb_online_index, c->be,
559                                 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
560                         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
561                 }
562                 break;
563
564         case MDB_SSTACK:
565                 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
566                         fprintf( stderr,
567                 "%s: depth %d too small, using %d\n",
568                         c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
569                         c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
570                 }
571                 mdb->mi_search_stack_depth = c->value_int;
572                 break;
573
574         case MDB_MAXSIZE:
575                 mdb->mi_mapsize = c->value_ulong;
576                 if ( mdb->mi_flags & MDB_IS_OPEN )
577                         mdb->mi_flags |= MDB_RE_OPEN;
578                 break;
579
580         }
581         return 0;
582 }
583
584 int mdb_back_init_cf( BackendInfo *bi )
585 {
586         int rc;
587         bi->bi_cf_ocs = mdbocs;
588
589         rc = config_register_schema( mdbcfg, mdbocs );
590         if ( rc ) return rc;
591         return 0;
592 }