s3/docs: Remove reference to nonexistent file.
[Samba/gbeck.git] / source4 / torture / locktest.c
blob12be00f29882b682dee0dda9018e9ce793fb71f9
1 /*
2 Unix SMB/CIFS implementation.
3 randomised byte range lock tester
4 Copyright (C) Andrew Tridgell 1999
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #include "includes.h"
21 #include "lib/cmdline/popt_common.h"
22 #include "lib/events/events.h"
23 #include "system/filesys.h"
24 #include "system/time.h"
25 #include "auth/credentials/credentials.h"
26 #include "auth/gensec/gensec.h"
27 #include "libcli/libcli.h"
28 #include "param/param.h"
29 #include "libcli/resolve/resolve.h"
31 static int numops = 1000;
32 static int showall;
33 static int analyze;
34 static int hide_unlock_fails;
35 static int use_oplocks;
36 static uint_t lock_range = 100;
37 static uint_t lock_base = 0;
38 static uint_t min_length = 0;
39 static int exact_error_codes;
40 static int zero_zero;
42 #define FILENAME "\\locktest.dat"
44 #define READ_PCT 50
45 #define LOCK_PCT 45
46 #define UNLOCK_PCT 70
47 #define RANGE_MULTIPLE 1
48 #define NSERVERS 2
49 #define NCONNECTIONS 2
50 #define NFILES 2
51 #define LOCK_TIMEOUT 0
53 static struct cli_credentials *servers[NSERVERS];
55 enum lock_op {OP_LOCK, OP_UNLOCK, OP_REOPEN};
57 struct record {
58 enum lock_op lock_op;
59 enum brl_type lock_type;
60 char conn, f;
61 uint64_t start, len;
62 char needed;
63 uint16_t pid;
66 #define PRESETS 0
68 #if PRESETS
69 static struct record preset[] = {
70 {OP_LOCK, WRITE_LOCK, 0, 0, 2, 0, 1},
71 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
72 {OP_LOCK, WRITE_LOCK, 0, 0, 3, 0, 1},
73 {OP_UNLOCK, 0 , 0, 0, 2, 0, 1},
74 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
76 {OP_LOCK, READ_LOCK, 0, 0, 2, 0, 1},
77 {OP_LOCK, READ_LOCK, 0, 0, 1, 1, 1},
78 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
79 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
81 {OP_LOCK, READ_LOCK, 0, 0, 2, 0, 1},
82 {OP_LOCK, WRITE_LOCK, 0, 0, 3, 1, 1},
83 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
84 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
86 {OP_LOCK, READ_LOCK, 0, 0, 2, 0, 1},
87 {OP_LOCK, WRITE_LOCK, 0, 0, 1, 1, 1},
88 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
89 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
91 {OP_LOCK, WRITE_LOCK, 0, 0, 2, 0, 1},
92 {OP_LOCK, READ_LOCK, 0, 0, 1, 1, 1},
93 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
94 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
96 {OP_LOCK, WRITE_LOCK, 0, 0, 2, 0, 1},
97 {OP_LOCK, READ_LOCK, 0, 0, 3, 1, 1},
98 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
99 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
102 #endif
104 static struct record *recorded;
106 /*****************************************************
107 return a connection to a server
108 *******************************************************/
109 static struct smbcli_state *connect_one(struct tevent_context *ev,
110 struct loadparm_context *lp_ctx,
111 TALLOC_CTX *mem_ctx,
112 char *share, int snum, int conn)
114 struct smbcli_state *c;
115 char *server, *myname;
116 NTSTATUS status;
117 int retries = 10;
118 struct smbcli_options options;
119 struct smbcli_session_options session_options;
121 lp_smbcli_options(lp_ctx, &options);
122 lp_smbcli_session_options(lp_ctx, &session_options);
124 printf("connect_one(%s, %d, %d)\n", share, snum, conn);
126 server = talloc_strdup(mem_ctx, share+2);
127 share = strchr_m(server,'\\');
128 if (!share) return NULL;
129 *share = 0;
130 share++;
132 if (snum == 0) {
133 char **unc_list = NULL;
134 int num_unc_names;
135 const char *p;
136 p = lp_parm_string(lp_ctx, NULL, "torture", "unclist");
137 if (p) {
138 char *h, *s;
139 unc_list = file_lines_load(p, &num_unc_names, 0, NULL);
140 if (!unc_list || num_unc_names <= 0) {
141 printf("Failed to load unc names list from '%s'\n", p);
142 exit(1);
145 if (!smbcli_parse_unc(unc_list[conn % num_unc_names],
146 NULL, &h, &s)) {
147 printf("Failed to parse UNC name %s\n",
148 unc_list[conn % num_unc_names]);
149 exit(1);
151 server = talloc_strdup(mem_ctx, h);
152 share = talloc_strdup(mem_ctx, s);
157 myname = talloc_asprintf(mem_ctx, "lock-%u-%u", getpid(), snum);
158 cli_credentials_set_workstation(servers[snum], myname, CRED_SPECIFIED);
160 do {
161 printf("\\\\%s\\%s\n", server, share);
162 status = smbcli_full_connection(NULL, &c,
163 server,
164 lp_smb_ports(lp_ctx),
165 share, NULL,
166 lp_socket_options(lp_ctx),
167 servers[snum],
168 lp_resolve_context(lp_ctx),
169 ev, &options, &session_options,
170 lp_iconv_convenience(lp_ctx),
171 lp_gensec_settings(mem_ctx, lp_ctx));
172 if (!NT_STATUS_IS_OK(status)) {
173 sleep(2);
175 } while (!NT_STATUS_IS_OK(status) && retries--);
177 if (!NT_STATUS_IS_OK(status)) {
178 return NULL;
181 return c;
185 static void reconnect(struct tevent_context *ev,
186 struct loadparm_context *lp_ctx,
187 TALLOC_CTX *mem_ctx,
188 struct smbcli_state *cli[NSERVERS][NCONNECTIONS], int fnum[NSERVERS][NCONNECTIONS][NFILES],
189 char *share[NSERVERS])
191 int server, conn, f;
193 for (server=0;server<NSERVERS;server++)
194 for (conn=0;conn<NCONNECTIONS;conn++) {
195 if (cli[server][conn]) {
196 for (f=0;f<NFILES;f++) {
197 if (fnum[server][conn][f] != -1) {
198 smbcli_close(cli[server][conn]->tree, fnum[server][conn][f]);
199 fnum[server][conn][f] = -1;
202 talloc_free(cli[server][conn]);
204 cli[server][conn] = connect_one(ev, lp_ctx, mem_ctx, share[server],
205 server, conn);
206 if (!cli[server][conn]) {
207 DEBUG(0,("Failed to connect to %s\n", share[server]));
208 exit(1);
215 static bool test_one(struct smbcli_state *cli[NSERVERS][NCONNECTIONS],
216 int fnum[NSERVERS][NCONNECTIONS][NFILES],
217 struct record *rec)
219 uint_t conn = rec->conn;
220 uint_t f = rec->f;
221 uint64_t start = rec->start;
222 uint64_t len = rec->len;
223 enum brl_type op = rec->lock_type;
224 int server;
225 bool ret[NSERVERS];
226 NTSTATUS status[NSERVERS];
228 switch (rec->lock_op) {
229 case OP_LOCK:
230 /* set a lock */
231 for (server=0;server<NSERVERS;server++) {
232 NTSTATUS res;
233 struct smbcli_tree *tree=cli[server][conn]->tree;
234 int fn=fnum[server][conn][f];
236 if (!(tree->session->transport->negotiate.capabilities & CAP_LARGE_FILES)) {
237 res=smbcli_lock(tree, fn, start, len, LOCK_TIMEOUT, rec->lock_op);
238 } else {
239 union smb_lock parms;
240 int ltype;
241 struct smb_lock_entry lock[1];
243 parms.lockx.level = RAW_LOCK_LOCKX;
244 parms.lockx.in.file.fnum = fn;
246 ltype = (rec->lock_op == READ_LOCK? 1 : 0);
247 ltype |= LOCKING_ANDX_LARGE_FILES;
248 parms.lockx.in.mode = ltype;
249 parms.lockx.in.timeout = LOCK_TIMEOUT;
250 parms.lockx.in.ulock_cnt = 0;
251 parms.lockx.in.lock_cnt = 1;
252 lock[0].pid = rec->pid;
253 lock[0].offset = start;
254 lock[0].count = len;
255 parms.lockx.in.locks = &lock[0];
257 res = smb_raw_lock(tree, &parms);
260 ret[server] = NT_STATUS_IS_OK(res);
261 status[server] = smbcli_nt_error(cli[server][conn]->tree);
262 if (!exact_error_codes &&
263 NT_STATUS_EQUAL(status[server],
264 NT_STATUS_FILE_LOCK_CONFLICT)) {
265 status[server] = NT_STATUS_LOCK_NOT_GRANTED;
268 if (showall || !NT_STATUS_EQUAL(status[0],status[1])) {
269 printf("lock conn=%u f=%u range=%.0f(%.0f) op=%s -> %s:%s\n",
270 conn, f,
271 (double)start, (double)len,
272 op==READ_LOCK?"READ_LOCK":"WRITE_LOCK",
273 nt_errstr(status[0]), nt_errstr(status[1]));
275 if (!NT_STATUS_EQUAL(status[0],status[1])) return false;
276 break;
278 case OP_UNLOCK:
279 /* unset a lock */
280 for (server=0;server<NSERVERS;server++) {
281 NTSTATUS res;
282 struct smbcli_tree *tree=cli[server][conn]->tree;
283 int fn=fnum[server][conn][f];
286 if (!(tree->session->transport->negotiate.capabilities & CAP_LARGE_FILES)) {
287 res=smbcli_unlock(tree, fn, start, len);
288 } else {
289 union smb_lock parms;
290 struct smb_lock_entry lock[1];
292 parms.lockx.level = RAW_LOCK_LOCKX;
293 parms.lockx.in.file.fnum = fn;
294 parms.lockx.in.mode = LOCKING_ANDX_LARGE_FILES;
295 parms.lockx.in.timeout = 0;
296 parms.lockx.in.ulock_cnt = 1;
297 parms.lockx.in.lock_cnt = 0;
298 lock[0].pid = rec->pid;
299 lock[0].count = len;
300 lock[0].offset = start;
301 parms.lockx.in.locks = &lock[0];
303 res = smb_raw_lock(tree, &parms);
306 ret[server] = NT_STATUS_IS_OK(res);
307 status[server] = smbcli_nt_error(cli[server][conn]->tree);
309 if (showall ||
310 (!hide_unlock_fails && !NT_STATUS_EQUAL(status[0],status[1]))) {
311 printf("unlock conn=%u f=%u range=%.0f(%.0f) -> %s:%s\n",
312 conn, f,
313 (double)start, (double)len,
314 nt_errstr(status[0]), nt_errstr(status[1]));
316 if (!hide_unlock_fails && !NT_STATUS_EQUAL(status[0],status[1]))
317 return false;
318 break;
320 case OP_REOPEN:
321 /* reopen the file */
322 for (server=0;server<NSERVERS;server++) {
323 smbcli_close(cli[server][conn]->tree, fnum[server][conn][f]);
324 fnum[server][conn][f] = -1;
326 for (server=0;server<NSERVERS;server++) {
327 fnum[server][conn][f] = smbcli_open(cli[server][conn]->tree, FILENAME,
328 O_RDWR|O_CREAT,
329 DENY_NONE);
330 if (fnum[server][conn][f] == -1) {
331 printf("failed to reopen on share%d\n", server);
332 return false;
335 if (showall) {
336 printf("reopen conn=%u f=%u\n",
337 conn, f);
339 break;
342 return true;
345 static void close_files(struct smbcli_state *cli[NSERVERS][NCONNECTIONS],
346 int fnum[NSERVERS][NCONNECTIONS][NFILES])
348 int server, conn, f;
350 for (server=0;server<NSERVERS;server++)
351 for (conn=0;conn<NCONNECTIONS;conn++)
352 for (f=0;f<NFILES;f++) {
353 if (fnum[server][conn][f] != -1) {
354 smbcli_close(cli[server][conn]->tree, fnum[server][conn][f]);
355 fnum[server][conn][f] = -1;
358 for (server=0;server<NSERVERS;server++) {
359 smbcli_unlink(cli[server][0]->tree, FILENAME);
363 static void open_files(struct smbcli_state *cli[NSERVERS][NCONNECTIONS],
364 int fnum[NSERVERS][NCONNECTIONS][NFILES])
366 int server, conn, f;
368 for (server=0;server<NSERVERS;server++)
369 for (conn=0;conn<NCONNECTIONS;conn++)
370 for (f=0;f<NFILES;f++) {
371 fnum[server][conn][f] = smbcli_open(cli[server][conn]->tree, FILENAME,
372 O_RDWR|O_CREAT,
373 DENY_NONE);
374 if (fnum[server][conn][f] == -1) {
375 fprintf(stderr,"Failed to open fnum[%u][%u][%u]\n",
376 server, conn, f);
377 exit(1);
383 static int retest(struct smbcli_state *cli[NSERVERS][NCONNECTIONS],
384 int fnum[NSERVERS][NCONNECTIONS][NFILES],
385 int n)
387 int i;
388 printf("testing %u ...\n", n);
389 for (i=0; i<n; i++) {
390 if (i && i % 100 == 0) {
391 printf("%u\n", i);
394 if (recorded[i].needed &&
395 !test_one(cli, fnum, &recorded[i])) return i;
397 return n;
401 /* each server has two connections open to it. Each connection has two file
402 descriptors open on the file - 8 file descriptors in total
404 we then do random locking ops in tamdem on the 4 fnums from each
405 server and ensure that the results match
407 static int test_locks(struct tevent_context *ev,
408 struct loadparm_context *lp_ctx,
409 TALLOC_CTX *mem_ctx,
410 char *share[NSERVERS])
412 struct smbcli_state *cli[NSERVERS][NCONNECTIONS];
413 int fnum[NSERVERS][NCONNECTIONS][NFILES];
414 int n, i, n1, skip, r1, r2;
416 ZERO_STRUCT(fnum);
417 ZERO_STRUCT(cli);
419 recorded = malloc_array_p(struct record, numops);
421 for (n=0; n<numops; n++) {
422 #if PRESETS
423 if (n < sizeof(preset) / sizeof(preset[0])) {
424 recorded[n] = preset[n];
425 } else {
426 #endif
427 recorded[n].conn = random() % NCONNECTIONS;
428 recorded[n].f = random() % NFILES;
429 recorded[n].start = lock_base + ((uint_t)random() % (lock_range-1));
430 recorded[n].len = min_length +
431 random() % (lock_range-(recorded[n].start-lock_base));
432 recorded[n].start *= RANGE_MULTIPLE;
433 recorded[n].len *= RANGE_MULTIPLE;
434 recorded[n].pid = random()%3;
435 if (recorded[n].pid == 2) {
436 recorded[n].pid = 0xFFFF; /* see if its magic */
438 r1 = random() % 100;
439 r2 = random() % 100;
440 if (r1 < READ_PCT) {
441 recorded[n].lock_type = READ_LOCK;
442 } else {
443 recorded[n].lock_type = WRITE_LOCK;
445 if (r2 < LOCK_PCT) {
446 recorded[n].lock_op = OP_LOCK;
447 } else if (r2 < UNLOCK_PCT) {
448 recorded[n].lock_op = OP_UNLOCK;
449 } else {
450 recorded[n].lock_op = OP_REOPEN;
452 recorded[n].needed = true;
453 if (!zero_zero && recorded[n].start==0 && recorded[n].len==0) {
454 recorded[n].len = 1;
456 #if PRESETS
458 #endif
461 reconnect(ev, lp_ctx, mem_ctx, cli, fnum, share);
462 open_files(cli, fnum);
463 n = retest(cli, fnum, numops);
465 if (n == numops || !analyze) {
466 if (n != numops) {
467 return 1;
469 return 0;
471 n++;
473 skip = n/2;
475 while (1) {
476 n1 = n;
478 close_files(cli, fnum);
479 reconnect(ev, lp_ctx, mem_ctx, cli, fnum, share);
480 open_files(cli, fnum);
482 for (i=0;i<n-skip;i+=skip) {
483 int m, j;
484 printf("excluding %d-%d\n", i, i+skip-1);
485 for (j=i;j<i+skip;j++) {
486 recorded[j].needed = false;
489 close_files(cli, fnum);
490 open_files(cli, fnum);
492 m = retest(cli, fnum, n);
493 if (m == n) {
494 for (j=i;j<i+skip;j++) {
495 recorded[j].needed = true;
497 } else {
498 if (i+(skip-1) < m) {
499 memmove(&recorded[i], &recorded[i+skip],
500 (m-(i+skip-1))*sizeof(recorded[0]));
502 n = m-(skip-1);
503 i--;
507 if (skip > 1) {
508 skip = skip/2;
509 printf("skip=%d\n", skip);
510 continue;
513 if (n1 == n) break;
516 close_files(cli, fnum);
517 reconnect(ev, lp_ctx, mem_ctx, cli, fnum, share);
518 open_files(cli, fnum);
519 showall = true;
520 n1 = retest(cli, fnum, n);
521 if (n1 != n-1) {
522 printf("ERROR - inconsistent result (%u %u)\n", n1, n);
524 close_files(cli, fnum);
526 for (i=0;i<n;i++) {
527 printf("{%d, %d, %u, %u, %.0f, %.0f, %u},\n",
528 recorded[i].lock_op,
529 recorded[i].lock_type,
530 recorded[i].conn,
531 recorded[i].f,
532 (double)recorded[i].start,
533 (double)recorded[i].len,
534 recorded[i].needed);
537 return 1;
542 static void usage(poptContext pc)
544 printf("Usage:\n\tlocktest //server1/share1 //server2/share2 [options..]\n");
545 poptPrintUsage(pc, stdout, 0);
548 /****************************************************************************
549 main program
550 ****************************************************************************/
551 int main(int argc,char *argv[])
553 char *share[NSERVERS];
554 int opt;
555 int seed, server;
556 int username_count=0;
557 struct tevent_context *ev;
558 struct loadparm_context *lp_ctx;
559 poptContext pc;
560 int argc_new, i;
561 char **argv_new;
562 enum {OPT_UNCLIST=1000};
563 struct poptOption long_options[] = {
564 POPT_AUTOHELP
565 {"seed", 0, POPT_ARG_INT, &seed, 0, "Seed to use for randomizer", NULL},
566 {"num-ops", 0, POPT_ARG_INT, &numops, 0, "num ops", NULL},
567 {"lockrange", 0, POPT_ARG_INT, &lock_range,0, "locking range", NULL},
568 {"lockbase", 0, POPT_ARG_INT, &lock_base, 0, "locking base", NULL},
569 {"minlength", 0, POPT_ARG_INT, &min_length,0, "min lock length", NULL},
570 {"hidefails", 0, POPT_ARG_NONE, &hide_unlock_fails,0,"hide unlock fails", NULL},
571 {"oplocks", 0, POPT_ARG_NONE, &use_oplocks,0, "use oplocks", NULL},
572 {"showall", 0, POPT_ARG_NONE, &showall, 0, "display all operations", NULL},
573 {"analyse", 0, POPT_ARG_NONE, &analyze, 0, "do backtrack analysis", NULL},
574 {"zerozero", 0, POPT_ARG_NONE, &zero_zero, 0, "do zero/zero lock", NULL},
575 {"exacterrors", 0, POPT_ARG_NONE, &exact_error_codes,0,"use exact error codes", NULL},
576 {"unclist", 0, POPT_ARG_STRING, NULL, OPT_UNCLIST, "unclist", NULL},
577 { "user", 'U', POPT_ARG_STRING, NULL, 'U', "Set the network username", "[DOMAIN/]USERNAME[%PASSWORD]" },
578 POPT_COMMON_SAMBA
579 POPT_COMMON_CONNECTION
580 POPT_COMMON_CREDENTIALS
581 POPT_COMMON_VERSION
582 { NULL }
585 setlinebuf(stdout);
586 seed = time(NULL);
588 pc = poptGetContext("locktest", argc, (const char **) argv, long_options,
589 POPT_CONTEXT_KEEP_FIRST);
591 poptSetOtherOptionHelp(pc, "<unc1> <unc2>");
593 lp_ctx = cmdline_lp_ctx;
594 servers[0] = cli_credentials_init(talloc_autofree_context());
595 servers[1] = cli_credentials_init(talloc_autofree_context());
596 cli_credentials_guess(servers[0], lp_ctx);
597 cli_credentials_guess(servers[1], lp_ctx);
599 while((opt = poptGetNextOpt(pc)) != -1) {
600 switch (opt) {
601 case OPT_UNCLIST:
602 lp_set_cmdline(cmdline_lp_ctx, "torture:unclist", poptGetOptArg(pc));
603 break;
604 case 'U':
605 if (username_count == 2) {
606 usage(pc);
607 exit(1);
609 cli_credentials_parse_string(servers[username_count], poptGetOptArg(pc), CRED_SPECIFIED);
610 username_count++;
611 break;
615 argv_new = discard_const_p(char *, poptGetArgs(pc));
616 argc_new = argc;
617 for (i=0; i<argc; i++) {
618 if (argv_new[i] == NULL) {
619 argc_new = i;
620 break;
624 if (!(argc_new >= 3)) {
625 usage(pc);
626 exit(1);
629 setup_logging("locktest", DEBUG_STDOUT);
631 for (server=0;server<NSERVERS;server++) {
632 share[server] = argv_new[1+server];
633 all_string_sub(share[server],"/","\\",0);
636 lp_ctx = cmdline_lp_ctx;
638 if (username_count == 0) {
639 usage(pc);
640 return -1;
642 if (username_count == 1) {
643 servers[1] = servers[0];
646 ev = s4_event_context_init(talloc_autofree_context());
648 gensec_init(lp_ctx);
650 DEBUG(0,("seed=%u base=%d range=%d min_length=%d\n",
651 seed, lock_base, lock_range, min_length));
652 srandom(seed);
654 return test_locks(ev, lp_ctx, NULL, share);