2 Unix SMB/CIFS implementation.
3 Samba database functions
4 Copyright (C) Andrew Tridgell 1999-2000
5 Copyright (C) Paul `Rusty' Russell 2000
6 Copyright (C) Jeremy Allison 2000
7 Copyright (C) Andrew Esh 2001
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "system/locale.h"
25 #include "system/time.h"
26 #include "system/filesys.h"
27 #include "system/wait.h"
30 static int do_command(void);
33 size_t arg1len
, arg2len
;
36 TDB_DATA iterate_kbuf
;
38 static int disable_mmap
;
39 static int disable_lock
;
44 CMD_TRANSACTION_START
,
45 CMD_TRANSACTION_COMMIT
,
46 CMD_TRANSACTION_CANCEL
,
75 COMMAND_TABLE cmd_table
[] = {
76 {"create", CMD_CREATE_TDB
},
77 {"open", CMD_OPEN_TDB
},
78 {"transaction_start", CMD_TRANSACTION_START
},
79 {"transaction_commit", CMD_TRANSACTION_COMMIT
},
80 {"transaction_cancel", CMD_TRANSACTION_CANCEL
},
83 {"insert", CMD_INSERT
},
88 {"hexkeys", CMD_HEXKEYS
},
89 {"delete", CMD_DELETE
},
90 {"list", CMD_LIST_HASH_FREE
},
91 {"free", CMD_LIST_FREE
},
103 {"repack", CMD_REPACK
},
107 struct timeval tp1
,tp2
;
109 static void _start_timer(void)
111 gettimeofday(&tp1
,NULL
);
114 static double _end_timer(void)
116 gettimeofday(&tp2
,NULL
);
117 return((tp2
.tv_sec
- tp1
.tv_sec
) +
118 (tp2
.tv_usec
- tp1
.tv_usec
)*1.0e-6);
121 #ifdef PRINTF_ATTRIBUTE
122 static void tdb_log_open(struct tdb_context
*tdb
, enum tdb_debug_level level
,
123 const char *format
, ...) PRINTF_ATTRIBUTE(3,4);
125 static void tdb_log_open(struct tdb_context
*tdb
, enum tdb_debug_level level
,
126 const char *format
, ...)
128 const char *mutex_msg
=
129 "Can use mutexes only with MUTEX_LOCKING or NOLOCK\n";
133 p
= strstr(format
, mutex_msg
);
136 * Yes, this is a hack, but we don't want to see this
137 * message on first open, but we want to see
143 va_start(ap
, format
);
144 vfprintf(stderr
, format
, ap
);
148 #ifdef PRINTF_ATTRIBUTE
149 static void tdb_log(struct tdb_context
*tdb
, enum tdb_debug_level level
, const char *format
, ...) PRINTF_ATTRIBUTE(3,4);
151 static void tdb_log(struct tdb_context
*tdb
, enum tdb_debug_level level
, const char *format
, ...)
155 va_start(ap
, format
);
156 vfprintf(stderr
, format
, ap
);
160 /* a tdb tool for manipulating a tdb database */
162 static TDB_CONTEXT
*tdb
;
164 static int print_rec(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
);
165 static int print_key(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
);
166 static int print_hexkey(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
);
168 static void print_asc(const char *buf
,int len
)
172 /* We're probably printing ASCII strings so don't try to display
173 the trailing NULL character. */
175 if (buf
[len
- 1] == 0)
179 printf("%c",isprint(buf
[i
])?buf
[i
]:'.');
182 static void print_data(const char *buf
,int len
)
188 printf("%02X ",(int)((unsigned char)buf
[i
]));
190 if (i
%8 == 0) printf(" ");
192 print_asc(&buf
[i
-16],8); printf(" ");
193 print_asc(&buf
[i
-8],8); printf("\n");
194 if (i
<len
) printf("[%03X] ",i
);
202 if (n
>8) printf(" ");
203 while (n
--) printf(" ");
207 print_asc(&buf
[i
-(i
%16)],n
); printf(" ");
209 if (n
>0) print_asc(&buf
[i
-n
],n
);
214 static void help(void)
218 " create dbname : create a database\n"
219 " open dbname : open an existing database\n"
220 " transaction_start : start a transaction\n"
221 " transaction_commit : commit a transaction\n"
222 " transaction_cancel : cancel a transaction\n"
223 " erase : erase the database\n"
224 " dump : dump the database as strings\n"
225 " keys : dump the database keys as strings\n"
226 " hexkeys : dump the database keys as hex values\n"
227 " info : print summary info about the database\n"
228 " insert key data : insert a record\n"
229 " move key file : move a record to a destination tdb\n"
230 " store key data : store a record (replace)\n"
231 " show key : show a record by key\n"
232 " delete key : delete a record by key\n"
233 " list : print the database hash table and freelist\n"
234 " free : print the database freelist\n"
235 " check : check the integrity of an opened database\n"
236 " repack : repack the database\n"
237 " speed : perform speed tests on the database\n"
238 " ! command : execute system command\n"
239 " 1 | first : print the first record\n"
240 " n | next : print the next record\n"
241 " q | quit : terminate\n"
242 " \\n : repeat 'next' command\n"
246 static void terror(const char *why
)
251 static void create_tdb(const char *tdbname
)
253 struct tdb_logging_context log_ctx
= { NULL
, NULL
};
254 log_ctx
.log_fn
= tdb_log
;
256 if (tdb
) tdb_close(tdb
);
257 tdb
= tdb_open_ex(tdbname
, 0,
259 (disable_mmap
?TDB_NOMMAP
:0) |
260 (disable_lock
?TDB_NOLOCK
:0),
261 O_RDWR
| O_CREAT
| O_TRUNC
, 0600, &log_ctx
, NULL
);
263 printf("Could not create %s: %s\n", tdbname
, strerror(errno
));
267 static void open_tdb(const char *tdbname
)
269 struct tdb_logging_context log_ctx
= { NULL
, NULL
};
270 log_ctx
.log_fn
= tdb_log_open
;
272 if (tdb
) tdb_close(tdb
);
273 tdb
= tdb_open_ex(tdbname
, 0,
274 (disable_mmap
?TDB_NOMMAP
:0) |
275 (disable_lock
?TDB_NOLOCK
:0),
279 log_ctx
.log_fn
= tdb_log
;
281 tdb_set_logging_function(tdb
, &log_ctx
);
284 if ((tdb
== NULL
) && (errno
== EINVAL
)) {
286 * Retry NOLOCK and readonly. There we want to see all
289 tdb
= tdb_open_ex(tdbname
, 0,
290 (disable_mmap
?TDB_NOMMAP
:0) |TDB_NOLOCK
,
296 printf("Could not open %s: %s\n", tdbname
, strerror(errno
));
300 static void insert_tdb(char *keyname
, size_t keylen
, char* data
, size_t datalen
)
304 if ((keyname
== NULL
) || (keylen
== 0)) {
309 key
.dptr
= (unsigned char *)keyname
;
311 dbuf
.dptr
= (unsigned char *)data
;
312 dbuf
.dsize
= datalen
;
314 if (tdb_store(tdb
, key
, dbuf
, TDB_INSERT
) != 0) {
315 terror("insert failed");
319 static void store_tdb(char *keyname
, size_t keylen
, char* data
, size_t datalen
)
323 if ((keyname
== NULL
) || (keylen
== 0)) {
328 if ((data
== NULL
) || (datalen
== 0)) {
333 key
.dptr
= (unsigned char *)keyname
;
335 dbuf
.dptr
= (unsigned char *)data
;
336 dbuf
.dsize
= datalen
;
338 printf("Storing key:\n");
339 print_rec(tdb
, key
, dbuf
, NULL
);
341 if (tdb_store(tdb
, key
, dbuf
, TDB_REPLACE
) != 0) {
342 terror("store failed");
346 static void show_tdb(char *keyname
, size_t keylen
)
350 if ((keyname
== NULL
) || (keylen
== 0)) {
355 key
.dptr
= (unsigned char *)keyname
;
358 dbuf
= tdb_fetch(tdb
, key
);
360 terror("fetch failed");
364 print_rec(tdb
, key
, dbuf
, NULL
);
371 static void delete_tdb(char *keyname
, size_t keylen
)
375 if ((keyname
== NULL
) || (keylen
== 0)) {
380 key
.dptr
= (unsigned char *)keyname
;
383 if (tdb_delete(tdb
, key
) != 0) {
384 terror("delete failed");
388 static void move_rec(char *keyname
, size_t keylen
, char* tdbname
)
391 TDB_CONTEXT
*dst_tdb
;
393 if ((keyname
== NULL
) || (keylen
== 0)) {
399 terror("need destination tdb name");
403 key
.dptr
= (unsigned char *)keyname
;
406 dbuf
= tdb_fetch(tdb
, key
);
408 terror("fetch failed");
412 print_rec(tdb
, key
, dbuf
, NULL
);
414 dst_tdb
= tdb_open(tdbname
, 0, 0, O_RDWR
, 0600);
416 terror("unable to open destination tdb");
420 if (tdb_store( dst_tdb
, key
, dbuf
, TDB_REPLACE
) != 0) {
421 terror("failed to move record");
424 printf("record moved\n");
426 tdb_close( dst_tdb
);
431 static int print_rec(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
)
433 printf("\nkey %d bytes\n", (int)key
.dsize
);
434 print_asc((const char *)key
.dptr
, key
.dsize
);
435 printf("\ndata %d bytes\n", (int)dbuf
.dsize
);
436 print_data((const char *)dbuf
.dptr
, dbuf
.dsize
);
440 static int print_key(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
)
442 printf("key %d bytes: ", (int)key
.dsize
);
443 print_asc((const char *)key
.dptr
, key
.dsize
);
448 static int print_hexkey(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
)
450 printf("key %d bytes\n", (int)key
.dsize
);
451 print_data((const char *)key
.dptr
, key
.dsize
);
456 static int total_bytes
;
458 static int traverse_fn(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
)
460 total_bytes
+= dbuf
.dsize
;
464 static void info_tdb(void)
466 char *summary
= tdb_summary(tdb
);
469 printf("Error = %s\n", tdb_errorstr(tdb
));
471 printf("%s", summary
);
476 static void speed_tdb(const char *tlimit
)
478 const char *str
= "store test", *str2
= "transaction test";
479 unsigned timelimit
= tlimit
?atoi(tlimit
):0;
482 if (timelimit
== 0) timelimit
= 5;
485 printf("Testing store speed for %u seconds\n", timelimit
);
488 long int r
= random();
490 key
.dptr
= discard_const_p(uint8_t, str
);
491 key
.dsize
= strlen((char *)key
.dptr
);
492 dbuf
.dptr
= (uint8_t *) &r
;
493 dbuf
.dsize
= sizeof(r
);
494 tdb_store(tdb
, key
, dbuf
, TDB_REPLACE
);
497 } while (t
< timelimit
);
498 printf("%10.3f ops/sec\n", ops
/t
);
501 printf("Testing fetch speed for %u seconds\n", timelimit
);
505 key
.dptr
= discard_const_p(uint8_t, str
);
506 key
.dsize
= strlen((char *)key
.dptr
);
510 } while (t
< timelimit
);
511 printf("%10.3f ops/sec\n", ops
/t
);
514 printf("Testing transaction speed for %u seconds\n", timelimit
);
517 long int r
= random();
519 key
.dptr
= discard_const_p(uint8_t, str2
);
520 key
.dsize
= strlen((char *)key
.dptr
);
521 dbuf
.dptr
= (uint8_t *) &r
;
522 dbuf
.dsize
= sizeof(r
);
523 tdb_transaction_start(tdb
);
524 tdb_store(tdb
, key
, dbuf
, TDB_REPLACE
);
525 tdb_transaction_commit(tdb
);
528 } while (t
< timelimit
);
529 printf("%10.3f ops/sec\n", ops
/t
);
532 printf("Testing traverse speed for %u seconds\n", timelimit
);
535 tdb_traverse(tdb
, traverse_fn
, NULL
);
538 } while (t
< timelimit
);
539 printf("%10.3f ops/sec\n", ops
/t
);
542 static void toggle_mmap(void)
544 disable_mmap
= !disable_mmap
;
546 printf("mmap is disabled\n");
548 printf("mmap is enabled\n");
552 static char *tdb_getline(const char *prompt
)
554 static char thisline
[1024];
556 fputs(prompt
, stdout
);
558 p
= fgets(thisline
, sizeof(thisline
)-1, stdin
);
559 if (p
) p
= strchr(p
, '\n');
561 return p
?thisline
:NULL
;
564 static int do_delete_fn(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
,
567 return tdb_delete(the_tdb
, key
);
570 static void first_record(TDB_CONTEXT
*the_tdb
, TDB_DATA
*pkey
)
573 *pkey
= tdb_firstkey(the_tdb
);
575 dbuf
= tdb_fetch(the_tdb
, *pkey
);
576 if (!dbuf
.dptr
) terror("fetch failed");
578 print_rec(the_tdb
, *pkey
, dbuf
, NULL
);
582 static void next_record(TDB_CONTEXT
*the_tdb
, TDB_DATA
*pkey
)
585 *pkey
= tdb_nextkey(the_tdb
, *pkey
);
587 dbuf
= tdb_fetch(the_tdb
, *pkey
);
589 terror("fetch failed");
591 print_rec(the_tdb
, *pkey
, dbuf
, NULL
);
594 static int count(TDB_DATA key
, TDB_DATA data
, void *private_data
)
596 (*(unsigned int *)private_data
)++;
600 static void check_db(TDB_CONTEXT
*the_tdb
)
604 printf("Error: No database opened!\n");
605 else if (tdb_check(the_tdb
, count
, &tdbcount
) == -1)
606 printf("Integrity check for the opened database failed.\n");
608 printf("Database integrity is OK and has %d records.\n",
612 static int do_command(void)
614 COMMAND_TABLE
*ctp
= cmd_table
;
615 enum commands mycmd
= CMD_HELP
;
618 if (cmdname
&& strlen(cmdname
) == 0) {
622 cmd_len
= strlen(ctp
->name
);
623 if (strncmp(ctp
->name
,cmdname
,cmd_len
) == 0) {
642 if (system(arg1
) == -1) {
643 terror("system() call failed\n");
649 /* all the rest require a open database */
652 terror("database not open");
657 case CMD_TRANSACTION_START
:
659 tdb_transaction_start(tdb
);
661 case CMD_TRANSACTION_COMMIT
:
663 tdb_transaction_commit(tdb
);
669 case CMD_TRANSACTION_CANCEL
:
671 tdb_transaction_cancel(tdb
);
675 tdb_traverse(tdb
, do_delete_fn
, NULL
);
679 tdb_traverse(tdb
, print_rec
, NULL
);
683 insert_tdb(arg1
, arg1len
,arg2
,arg2len
);
687 move_rec(arg1
,arg1len
,arg2
);
691 store_tdb(arg1
,arg1len
,arg2
,arg2len
);
695 show_tdb(arg1
, arg1len
);
698 tdb_traverse(tdb
, print_key
, NULL
);
701 tdb_traverse(tdb
, print_hexkey
, NULL
);
705 delete_tdb(arg1
,arg1len
);
707 case CMD_LIST_HASH_FREE
:
711 tdb_printfreelist(tdb
);
724 first_record(tdb
, &iterate_kbuf
);
728 next_record(tdb
, &iterate_kbuf
);
741 * unhandled commands. cases included here to avoid compiler
751 static char *tdb_convert_string(char *instring
, size_t *sizep
)
757 outp
= inp
= instring
;
762 if (*inp
&& strchr("0123456789abcdefABCDEF",(int)*inp
)) {
765 if (*inp
&& strchr("0123456789abcdefABCDEF",(int)*inp
)) {
769 *outp
++ = (char)strtol((const char *)temp
,NULL
,16);
782 int main(int argc
, char *argv
[])
790 if (argv
[1] && (strcmp(argv
[1], "-l") == 0)) {
808 /* Interactive mode */
809 while ((cmdname
= tdb_getline("tdb> "))) {
811 if ((arg1
= strchr((const char *)cmdname
,' ')) != NULL
) {
819 if ((*arg2
++ == '\\') && (*arg2
== ' ')) {
824 if (arg1
) arg1
= tdb_convert_string(arg1
,&arg1len
);
825 if (arg2
) arg2
= tdb_convert_string(arg2
,&arg2len
);
826 if (do_command()) break;
830 arg2
= tdb_convert_string(argv
[4],&arg2len
);
832 arg1
= tdb_convert_string(argv
[3],&arg1len
);
840 if (tdb
) tdb_close(tdb
);