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
,
77 COMMAND_TABLE cmd_table
[] = {
78 {"create", CMD_CREATE_TDB
},
79 {"open", CMD_OPEN_TDB
},
80 {"transaction_start", CMD_TRANSACTION_START
},
81 {"transaction_commit", CMD_TRANSACTION_COMMIT
},
82 {"transaction_cancel", CMD_TRANSACTION_CANCEL
},
85 {"insert", CMD_INSERT
},
87 {"storehex", CMD_STOREHEX
},
91 {"hexkeys", CMD_HEXKEYS
},
92 {"delete", CMD_DELETE
},
93 {"list", CMD_LIST_HASH_FREE
},
94 {"free", CMD_LIST_FREE
},
95 {"freelist_size", CMD_FREELIST_SIZE
},
103 {"check", CMD_CHECK
},
107 {"repack", CMD_REPACK
},
111 struct timeval tp1
,tp2
;
113 static void _start_timer(void)
115 gettimeofday(&tp1
,NULL
);
118 static double _end_timer(void)
120 gettimeofday(&tp2
,NULL
);
121 return((tp2
.tv_sec
- tp1
.tv_sec
) +
122 (tp2
.tv_usec
- tp1
.tv_usec
)*1.0e-6);
125 #ifdef PRINTF_ATTRIBUTE
126 static void tdb_log_open(struct tdb_context
*tdb
, enum tdb_debug_level level
,
127 const char *format
, ...) PRINTF_ATTRIBUTE(3,4);
129 static void tdb_log_open(struct tdb_context
*tdb
, enum tdb_debug_level level
,
130 const char *format
, ...)
132 const char *mutex_msg
=
133 "Can use mutexes only with MUTEX_LOCKING or NOLOCK\n";
137 p
= strstr(format
, mutex_msg
);
140 * Yes, this is a hack, but we don't want to see this
141 * message on first open, but we want to see
147 va_start(ap
, format
);
148 vfprintf(stderr
, format
, ap
);
152 #ifdef PRINTF_ATTRIBUTE
153 static void tdb_log(struct tdb_context
*tdb
, enum tdb_debug_level level
, const char *format
, ...) PRINTF_ATTRIBUTE(3,4);
155 static void tdb_log(struct tdb_context
*tdb
, enum tdb_debug_level level
, const char *format
, ...)
159 va_start(ap
, format
);
160 vfprintf(stderr
, format
, ap
);
164 /* a tdb tool for manipulating a tdb database */
166 static TDB_CONTEXT
*tdb
;
168 static int print_rec(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
);
169 static int print_key(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
);
170 static int print_hexkey(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
);
172 static void print_asc(const char *buf
,int len
)
176 /* We're probably printing ASCII strings so don't try to display
177 the trailing NULL character. */
179 if (buf
[len
- 1] == 0)
183 printf("%c",isprint(buf
[i
])?buf
[i
]:'.');
186 static void print_data(const char *buf
,int len
)
192 printf("%02X ",(int)((unsigned char)buf
[i
]));
194 if (i
%8 == 0) printf(" ");
196 print_asc(&buf
[i
-16],8); printf(" ");
197 print_asc(&buf
[i
-8],8); printf("\n");
198 if (i
<len
) printf("[%03X] ",i
);
206 if (n
>8) printf(" ");
207 while (n
--) printf(" ");
211 print_asc(&buf
[i
-(i
%16)],n
); printf(" ");
213 if (n
>0) print_asc(&buf
[i
-n
],n
);
218 static void help(void)
222 " create dbname : create a database\n"
223 " open dbname : open an existing database\n"
224 " transaction_start : start a transaction\n"
225 " transaction_commit : commit a transaction\n"
226 " transaction_cancel : cancel a transaction\n"
227 " erase : erase the database\n"
228 " dump : dump the database as strings\n"
229 " keys : dump the database keys as strings\n"
230 " hexkeys : dump the database keys as hex values\n"
231 " info : print summary info about the database\n"
232 " insert key data : insert a record\n"
233 " move key file : move a record to a destination tdb\n"
234 " storehex key data : store a record (replace), key/value in hex format\n"
235 " store key data : store a record (replace)\n"
236 " show key : show a record by key\n"
237 " delete key : delete a record by key\n"
238 " list : print the database hash table and freelist\n"
239 " free : print the database freelist\n"
240 " freelist_size : print the number of records in the freelist\n"
241 " check : check the integrity of an opened database\n"
242 " repack : repack the database\n"
243 " speed : perform speed tests on the database\n"
244 " ! command : execute system command\n"
245 " 1 | first : print the first record\n"
246 " n | next : print the next record\n"
247 " q | quit : terminate\n"
248 " \\n : repeat 'next' command\n"
252 static void terror(const char *why
)
257 static void create_tdb(const char *tdbname
)
259 struct tdb_logging_context log_ctx
= { NULL
, NULL
};
260 log_ctx
.log_fn
= tdb_log
;
262 if (tdb
) tdb_close(tdb
);
263 tdb
= tdb_open_ex(tdbname
, 0,
265 (disable_mmap
?TDB_NOMMAP
:0) |
266 (_disable_lock
?TDB_NOLOCK
:0),
267 O_RDWR
| O_CREAT
| O_TRUNC
, 0600, &log_ctx
, NULL
);
269 printf("Could not create %s: %s\n", tdbname
, strerror(errno
));
273 static void open_tdb(const char *tdbname
)
275 struct tdb_logging_context log_ctx
= { NULL
, NULL
};
276 log_ctx
.log_fn
= tdb_log_open
;
278 if (tdb
) tdb_close(tdb
);
279 tdb
= tdb_open_ex(tdbname
, 0,
280 (disable_mmap
?TDB_NOMMAP
:0) |
281 (_disable_lock
?TDB_NOLOCK
:0),
285 log_ctx
.log_fn
= tdb_log
;
287 tdb_set_logging_function(tdb
, &log_ctx
);
290 if ((tdb
== NULL
) && (errno
== EINVAL
)) {
292 * Retry NOLOCK and readonly. There we want to see all
295 tdb
= tdb_open_ex(tdbname
, 0,
296 (disable_mmap
?TDB_NOMMAP
:0) |TDB_NOLOCK
,
302 printf("Could not open %s: %s\n", tdbname
, strerror(errno
));
306 static void insert_tdb(char *keyname
, size_t keylen
, char* data
, size_t datalen
)
310 if ((keyname
== NULL
) || (keylen
== 0)) {
315 key
.dptr
= (unsigned char *)keyname
;
317 dbuf
.dptr
= (unsigned char *)data
;
318 dbuf
.dsize
= datalen
;
320 if (tdb_store(tdb
, key
, dbuf
, TDB_INSERT
) != 0) {
321 terror("insert failed");
325 static void store_tdb(char *keyname
, size_t keylen
, char* data
, size_t datalen
)
329 if ((keyname
== NULL
) || (keylen
== 0)) {
334 if ((data
== NULL
) || (datalen
== 0)) {
339 key
.dptr
= (unsigned char *)keyname
;
341 dbuf
.dptr
= (unsigned char *)data
;
342 dbuf
.dsize
= datalen
;
344 printf("Storing key:\n");
345 print_rec(tdb
, key
, dbuf
, NULL
);
347 if (tdb_store(tdb
, key
, dbuf
, TDB_REPLACE
) != 0) {
348 terror("store failed");
352 static bool parse_hex(const char *src
, size_t srclen
, uint8_t *dst
)
356 if ((srclen
% 2) != 0) {
361 bool ok
= hex_byte(src
, dst
);
372 static void store_hex_tdb(char *keystr
, size_t keylen
,
373 char *datastr
, size_t datalen
)
375 if ((keystr
== NULL
) || (keylen
== 0)) {
379 if ((datastr
== NULL
) || (datalen
== 0)) {
385 uint8_t keybuf
[keylen
/2];
386 TDB_DATA key
= { .dptr
= keybuf
, .dsize
= sizeof(keybuf
) };
387 uint8_t databuf
[datalen
/2];
388 TDB_DATA data
= { .dptr
= databuf
, .dsize
= sizeof(databuf
) };
391 ok
= parse_hex(keystr
, keylen
, keybuf
);
393 terror("need hex key");
396 ok
= parse_hex(datastr
, datalen
, databuf
);
398 terror("need hex data");
402 printf("storing key/data:\n");
403 print_data((char *)key
.dptr
, key
.dsize
);
404 print_data((char *)data
.dptr
, data
.dsize
);
406 if (tdb_store(tdb
, key
, data
, TDB_REPLACE
) != 0) {
407 terror("store failed");
412 static void show_tdb(char *keyname
, size_t keylen
)
416 if ((keyname
== NULL
) || (keylen
== 0)) {
421 key
.dptr
= (unsigned char *)keyname
;
424 dbuf
= tdb_fetch(tdb
, key
);
426 terror("fetch failed");
430 print_rec(tdb
, key
, dbuf
, NULL
);
437 static void delete_tdb(char *keyname
, size_t keylen
)
441 if ((keyname
== NULL
) || (keylen
== 0)) {
446 key
.dptr
= (unsigned char *)keyname
;
449 if (tdb_delete(tdb
, key
) != 0) {
450 terror("delete failed");
454 static void move_rec(char *keyname
, size_t keylen
, char* tdbname
)
457 TDB_CONTEXT
*dst_tdb
;
459 if ((keyname
== NULL
) || (keylen
== 0)) {
465 terror("need destination tdb name");
469 key
.dptr
= (unsigned char *)keyname
;
472 dbuf
= tdb_fetch(tdb
, key
);
474 terror("fetch failed");
478 print_rec(tdb
, key
, dbuf
, NULL
);
480 dst_tdb
= tdb_open(tdbname
, 0, 0, O_RDWR
, 0600);
482 terror("unable to open destination tdb");
486 if (tdb_store( dst_tdb
, key
, dbuf
, TDB_REPLACE
) != 0) {
487 terror("failed to move record");
490 printf("record moved\n");
492 tdb_close( dst_tdb
);
497 static int print_rec(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
)
499 printf("\nkey %d bytes\n", (int)key
.dsize
);
500 print_asc((const char *)key
.dptr
, key
.dsize
);
501 printf("\ndata %d bytes\n", (int)dbuf
.dsize
);
502 print_data((const char *)dbuf
.dptr
, dbuf
.dsize
);
506 static int print_key(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
)
508 printf("key %d bytes: ", (int)key
.dsize
);
509 print_asc((const char *)key
.dptr
, key
.dsize
);
514 static int print_hexkey(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
)
516 printf("key %d bytes\n", (int)key
.dsize
);
517 print_data((const char *)key
.dptr
, key
.dsize
);
522 static int total_bytes
;
524 static int traverse_fn(TDB_CONTEXT
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
, void *state
)
526 total_bytes
+= dbuf
.dsize
;
530 static void info_tdb(void)
532 char *summary
= tdb_summary(tdb
);
535 printf("Error = %s\n", tdb_errorstr(tdb
));
537 printf("%s", summary
);
542 static void speed_tdb(const char *tlimit
)
544 const char *str
= "store test", *str2
= "transaction test";
545 unsigned timelimit
= tlimit
?atoi(tlimit
):0;
548 if (timelimit
== 0) timelimit
= 5;
551 printf("Testing store speed for %u seconds\n", timelimit
);
554 long int r
= random();
556 key
.dptr
= discard_const_p(uint8_t, str
);
557 key
.dsize
= strlen((char *)key
.dptr
);
558 dbuf
.dptr
= (uint8_t *) &r
;
559 dbuf
.dsize
= sizeof(r
);
560 tdb_store(tdb
, key
, dbuf
, TDB_REPLACE
);
563 } while (t
< timelimit
);
564 printf("%10.3f ops/sec\n", ops
/t
);
567 printf("Testing fetch speed for %u seconds\n", timelimit
);
571 key
.dptr
= discard_const_p(uint8_t, str
);
572 key
.dsize
= strlen((char *)key
.dptr
);
576 } while (t
< timelimit
);
577 printf("%10.3f ops/sec\n", ops
/t
);
580 printf("Testing transaction speed for %u seconds\n", timelimit
);
583 long int r
= random();
585 key
.dptr
= discard_const_p(uint8_t, str2
);
586 key
.dsize
= strlen((char *)key
.dptr
);
587 dbuf
.dptr
= (uint8_t *) &r
;
588 dbuf
.dsize
= sizeof(r
);
589 tdb_transaction_start(tdb
);
590 tdb_store(tdb
, key
, dbuf
, TDB_REPLACE
);
591 tdb_transaction_commit(tdb
);
594 } while (t
< timelimit
);
595 printf("%10.3f ops/sec\n", ops
/t
);
598 printf("Testing traverse speed for %u seconds\n", timelimit
);
601 tdb_traverse(tdb
, traverse_fn
, NULL
);
604 } while (t
< timelimit
);
605 printf("%10.3f ops/sec\n", ops
/t
);
608 static void toggle_mmap(void)
610 disable_mmap
= !disable_mmap
;
612 printf("mmap is disabled\n");
614 printf("mmap is enabled\n");
618 static char *tdb_getline(const char *prompt
)
620 static char thisline
[1024];
622 fputs(prompt
, stdout
);
624 p
= fgets(thisline
, sizeof(thisline
)-1, stdin
);
625 if (p
) p
= strchr(p
, '\n');
627 return p
?thisline
:NULL
;
630 static void first_record(TDB_CONTEXT
*the_tdb
, TDB_DATA
*pkey
)
633 *pkey
= tdb_firstkey(the_tdb
);
635 dbuf
= tdb_fetch(the_tdb
, *pkey
);
636 if (!dbuf
.dptr
) terror("fetch failed");
638 print_rec(the_tdb
, *pkey
, dbuf
, NULL
);
642 static void next_record(TDB_CONTEXT
*the_tdb
, TDB_DATA
*pkey
)
645 *pkey
= tdb_nextkey(the_tdb
, *pkey
);
647 dbuf
= tdb_fetch(the_tdb
, *pkey
);
649 terror("fetch failed");
651 print_rec(the_tdb
, *pkey
, dbuf
, NULL
);
654 static int count(TDB_DATA key
, TDB_DATA data
, void *private_data
)
656 (*(unsigned int *)private_data
)++;
660 static void check_db(TDB_CONTEXT
*the_tdb
)
664 printf("Error: No database opened!\n");
665 else if (tdb_check(the_tdb
, count
, &tdbcount
) == -1)
666 printf("Integrity check for the opened database failed.\n");
668 printf("Database integrity is OK and has %d records.\n",
672 static int do_command(void)
674 COMMAND_TABLE
*ctp
= cmd_table
;
675 enum commands mycmd
= CMD_HELP
;
678 if (cmdname
!= NULL
) {
679 if (strlen(cmdname
) == 0) {
683 cmd_len
= strlen(ctp
->name
);
684 if (strncmp(ctp
->name
,cmdname
,cmd_len
) == 0) {
704 if (system(arg1
) == -1) {
705 terror("system() call failed\n");
711 /* all the rest require a open database */
714 terror("database not open");
719 case CMD_TRANSACTION_START
:
721 tdb_transaction_start(tdb
);
723 case CMD_TRANSACTION_COMMIT
:
725 tdb_transaction_commit(tdb
);
731 case CMD_TRANSACTION_CANCEL
:
733 tdb_transaction_cancel(tdb
);
741 tdb_traverse(tdb
, print_rec
, NULL
);
745 insert_tdb(arg1
, arg1len
,arg2
,arg2len
);
749 move_rec(arg1
,arg1len
,arg2
);
753 store_tdb(arg1
,arg1len
,arg2
,arg2len
);
757 store_hex_tdb(arg1
,arg1len
,arg2
,arg2len
);
761 show_tdb(arg1
, arg1len
);
764 tdb_traverse(tdb
, print_key
, NULL
);
767 tdb_traverse(tdb
, print_hexkey
, NULL
);
771 delete_tdb(arg1
,arg1len
);
773 case CMD_LIST_HASH_FREE
:
777 tdb_printfreelist(tdb
);
779 case CMD_FREELIST_SIZE
: {
782 size
= tdb_freelist_size(tdb
);
784 printf("Error getting freelist size.\n");
786 printf("freelist size: %d\n", size
);
802 first_record(tdb
, &iterate_kbuf
);
806 next_record(tdb
, &iterate_kbuf
);
819 * unhandled commands. cases included here to avoid compiler
829 static char *tdb_convert_string(char *instring
, size_t *sizep
)
835 outp
= inp
= instring
;
840 if (*inp
&& strchr("0123456789abcdefABCDEF",(int)*inp
)) {
843 if (*inp
&& strchr("0123456789abcdefABCDEF",(int)*inp
)) {
847 *outp
++ = (char)strtol((const char *)temp
,NULL
,16);
860 int main(int argc
, char *argv
[])
868 if (argv
[1] && (strcmp(argv
[1], "-l") == 0)) {
886 /* Interactive mode */
887 while ((cmdname
= tdb_getline("tdb> "))) {
889 if ((arg1
= strchr((const char *)cmdname
,' ')) != NULL
) {
897 if ((*arg2
++ == '\\') && (*arg2
== ' ')) {
902 if (arg1
) arg1
= tdb_convert_string(arg1
,&arg1len
);
903 if (arg2
) arg2
= tdb_convert_string(arg2
,&arg2len
);
904 if (do_command()) break;
908 arg2
= tdb_convert_string(argv
[4],&arg2len
);
911 arg1
= tdb_convert_string(argv
[3],&arg1len
);
921 if (tdb
) tdb_close(tdb
);