Merge branch 'master' of ssh://git.samba.org/data/git/samba
[jra/samba/.git] / source3 / torture / locktest.c
1 /* 
2    Unix SMB/CIFS implementation.
3    randomised byte range lock tester
4    Copyright (C) Andrew Tridgell 1999
5    
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.
10    
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.
15    
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/>.
18 */
19
20 #include "includes.h"
21
22 static fstring password[2];
23 static fstring username[2];
24 static int got_user;
25 static int got_pass;
26 static bool use_kerberos;
27 static int numops = 1000;
28 static bool showall;
29 static bool analyze;
30 static bool hide_unlock_fails;
31 static bool use_oplocks;
32 static unsigned lock_range = 100;
33 static unsigned lock_base = 0;
34 static unsigned min_length = 0;
35 static bool exact_error_codes;
36 static bool zero_zero;
37
38 extern char *optarg;
39 extern int optind;
40
41 #define FILENAME "\\locktest.dat"
42
43 #define READ_PCT 50
44 #define LOCK_PCT 45
45 #define UNLOCK_PCT 70
46 #define RANGE_MULTIPLE 1
47 #define NSERVERS 2
48 #define NCONNECTIONS 2
49 #define NFILES 2
50 #define LOCK_TIMEOUT 0
51
52 #define NASTY_POSIX_LOCK_HACK 0
53
54 enum lock_op {OP_LOCK, OP_UNLOCK, OP_REOPEN};
55
56 static const char *lock_op_type(int op)
57 {
58         if (op == WRITE_LOCK) return "write";
59         else if (op == READ_LOCK) return "read";
60         else return "other";
61 }
62
63 static const char *lock_op_name(enum lock_op op)
64 {
65         if (op == OP_LOCK) return "lock";
66         else if (op == OP_UNLOCK) return "unlock";
67         else return "reopen";
68 }
69
70 struct record {
71         enum lock_op lock_op;
72         enum brl_type lock_type;
73         char conn, f;
74         uint64_t start, len;
75         char needed;
76 };
77
78 #define PRESETS 0
79
80 #if PRESETS
81 static struct record preset[] = {
82 {OP_LOCK, WRITE_LOCK, 0, 0, 2, 0, 1},
83 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
84 {OP_LOCK, WRITE_LOCK, 0, 0, 3, 0, 1},
85 {OP_UNLOCK, 0       , 0, 0, 2, 0, 1},
86 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
87
88 {OP_LOCK, READ_LOCK, 0, 0, 2, 0, 1},
89 {OP_LOCK, READ_LOCK, 0, 0, 1, 1, 1},
90 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
91 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
92
93 {OP_LOCK, READ_LOCK, 0, 0, 2, 0, 1},
94 {OP_LOCK, WRITE_LOCK, 0, 0, 3, 1, 1},
95 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
96 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
97
98 {OP_LOCK, READ_LOCK, 0, 0, 2, 0, 1},
99 {OP_LOCK, WRITE_LOCK, 0, 0, 1, 1, 1},
100 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
101 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
102
103 {OP_LOCK, WRITE_LOCK, 0, 0, 2, 0, 1},
104 {OP_LOCK, READ_LOCK, 0, 0, 1, 1, 1},
105 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
106 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
107
108 {OP_LOCK, WRITE_LOCK, 0, 0, 2, 0, 1},
109 {OP_LOCK, READ_LOCK, 0, 0, 3, 1, 1},
110 {OP_LOCK, WRITE_LOCK, 0, 0, 0, 0, 1},
111 {OP_REOPEN, 0, 0, 0, 0, 0, 1},
112
113 };
114 #endif
115
116 static struct record *recorded;
117
118 static void print_brl(struct file_id id,
119                         struct server_id pid, 
120                         enum brl_type lock_type,
121                         enum brl_flavour lock_flav,
122                         br_off start,
123                         br_off size,
124                         void *private_data)
125 {
126 #if NASTY_POSIX_LOCK_HACK
127         {
128                 static SMB_INO_T lastino;
129
130                 if (lastino != ino) {
131                         char *cmd;
132                         if (asprintf(&cmd,
133                                  "egrep POSIX.*%u /proc/locks", (int)ino) > 0) {
134                                 system(cmd);
135                                 SAFE_FREE(cmd);
136                         }
137                 }
138                 lastino = ino;
139         }
140 #endif
141
142         printf("%s   %s    %s  %.0f:%.0f(%.0f)\n", 
143                procid_str_static(&pid), file_id_string_tos(&id),
144                lock_type==READ_LOCK?"R":"W",
145                (double)start, (double)start+size-1,(double)size);
146
147 }
148
149
150 static void show_locks(void)
151 {
152         brl_forall(print_brl, NULL);
153         /* system("cat /proc/locks"); */
154 }
155
156
157 /***************************************************** 
158 return a connection to a server
159 *******************************************************/
160 static struct cli_state *connect_one(char *share, int snum)
161 {
162         struct cli_state *c;
163         struct nmb_name called, calling;
164         char *server_n;
165         fstring server;
166         struct sockaddr_storage ss;
167         fstring myname;
168         static int count;
169         NTSTATUS status;
170
171         fstrcpy(server,share+2);
172         share = strchr_m(server,'\\');
173         if (!share) return NULL;
174         *share = 0;
175         share++;
176
177         server_n = server;
178
179         zero_sockaddr(&ss);
180
181         slprintf(myname,sizeof(myname), "lock-%lu-%u", (unsigned long)getpid(), count++);
182
183         make_nmb_name(&calling, myname, 0x0);
184         make_nmb_name(&called , server, 0x20);
185
186  again:
187         zero_sockaddr(&ss);
188
189         /* have to open a new connection */
190         if (!(c=cli_initialise())) {
191                 DEBUG(0,("Connection to %s failed\n", server_n));
192                 return NULL;
193         }
194
195         status = cli_connect(c, server_n, &ss);
196         if (!NT_STATUS_IS_OK(status)) {
197                 DEBUG(0,("Connection to %s failed. Error %s\n", server_n, nt_errstr(status) ));
198                 return NULL;
199         }
200
201         c->use_kerberos = use_kerberos;
202
203         if (!cli_session_request(c, &calling, &called)) {
204                 DEBUG(0,("session request to %s failed\n", called.name));
205                 cli_shutdown(c);
206                 if (strcmp(called.name, "*SMBSERVER")) {
207                         make_nmb_name(&called , "*SMBSERVER", 0x20);
208                         goto again;
209                 }
210                 return NULL;
211         }
212
213         DEBUG(4,(" session request ok\n"));
214
215         status = cli_negprot(c);
216         if (!NT_STATUS_IS_OK(status)) {
217                 DEBUG(0, ("protocol negotiation failed: %s\n",
218                           nt_errstr(status)));
219                 cli_shutdown(c);
220                 return NULL;
221         }
222
223         if (!got_pass) {
224                 char *pass = getpass("Password: ");
225                 if (pass) {
226                         fstrcpy(password[0], pass);
227                         fstrcpy(password[1], pass);
228                 }
229         }
230
231         if (got_pass == 1) {
232                 fstrcpy(password[1], password[0]);
233                 fstrcpy(username[1], username[0]);
234         }
235
236         if (!NT_STATUS_IS_OK(cli_session_setup(c, username[snum], 
237                                                password[snum],
238                                                strlen(password[snum]),
239                                                password[snum],
240                                                strlen(password[snum]),
241                                                lp_workgroup()))) {
242                 DEBUG(0,("session setup failed: %s\n", cli_errstr(c)));
243                 return NULL;
244         }
245
246         /*
247          * These next two lines are needed to emulate
248          * old client behaviour for people who have
249          * scripts based on client output.
250          * QUESTION ? Do we want to have a 'client compatibility
251          * mode to turn these on/off ? JRA.
252          */
253
254         if (*c->server_domain || *c->server_os || *c->server_type)
255                 DEBUG(1,("Domain=[%s] OS=[%s] Server=[%s]\n",
256                         c->server_domain,c->server_os,c->server_type));
257         
258         DEBUG(4,(" session setup ok\n"));
259
260         if (!cli_send_tconX(c, share, "?????",
261                             password[snum], strlen(password[snum])+1)) {
262                 DEBUG(0,("tree connect failed: %s\n", cli_errstr(c)));
263                 cli_shutdown(c);
264                 return NULL;
265         }
266
267         DEBUG(4,(" tconx ok\n"));
268
269         c->use_oplocks = use_oplocks;
270
271         return c;
272 }
273
274
275 static void reconnect(struct cli_state *cli[NSERVERS][NCONNECTIONS], int fnum[NSERVERS][NCONNECTIONS][NFILES],
276                       char *share[NSERVERS])
277 {
278         int server, conn, f;
279
280         for (server=0;server<NSERVERS;server++)
281         for (conn=0;conn<NCONNECTIONS;conn++) {
282                 if (cli[server][conn]) {
283                         for (f=0;f<NFILES;f++) {
284                                 if (fnum[server][conn][f] != -1) {
285                                         cli_close(cli[server][conn], fnum[server][conn][f]);
286                                         fnum[server][conn][f] = -1;
287                                 }
288                         }
289                         cli_ulogoff(cli[server][conn]);
290                         cli_shutdown(cli[server][conn]);
291                 }
292                 cli[server][conn] = connect_one(share[server], server);
293                 if (!cli[server][conn]) {
294                         DEBUG(0,("Failed to connect to %s\n", share[server]));
295                         exit(1);
296                 }
297         }
298 }
299
300
301
302 static bool test_one(struct cli_state *cli[NSERVERS][NCONNECTIONS], 
303                      int fnum[NSERVERS][NCONNECTIONS][NFILES],
304                      struct record *rec)
305 {
306         unsigned conn = rec->conn;
307         unsigned f = rec->f;
308         uint64_t start = rec->start;
309         uint64_t len = rec->len;
310         enum brl_type op = rec->lock_type;
311         int server;
312         bool ret[NSERVERS];
313         NTSTATUS status[NSERVERS];
314
315         switch (rec->lock_op) {
316         case OP_LOCK:
317                 /* set a lock */
318                 for (server=0;server<NSERVERS;server++) {
319                         ret[server] = cli_lock64(cli[server][conn], 
320                                                  fnum[server][conn][f],
321                                                  start, len, LOCK_TIMEOUT, op);
322                         status[server] = cli_nt_error(cli[server][conn]);
323                         if (!exact_error_codes && 
324                             NT_STATUS_EQUAL(status[server], 
325                                             NT_STATUS_FILE_LOCK_CONFLICT)) {
326                                 status[server] = NT_STATUS_LOCK_NOT_GRANTED;
327                         }
328                 }
329                 if (showall || !NT_STATUS_EQUAL(status[0],status[1])) {
330                         printf("lock   conn=%u f=%u range=%.0f(%.0f) op=%s -> %s:%s\n",
331                                conn, f, 
332                                (double)start, (double)len,
333                                op==READ_LOCK?"READ_LOCK":"WRITE_LOCK",
334                                nt_errstr(status[0]), nt_errstr(status[1]));
335                 }
336                 if (showall || !NT_STATUS_EQUAL(status[0],status[1])) show_locks();
337                 if (!NT_STATUS_EQUAL(status[0],status[1])) return False;
338                 break;
339                 
340         case OP_UNLOCK:
341                 /* unset a lock */
342                 for (server=0;server<NSERVERS;server++) {
343                         ret[server] = cli_unlock64(cli[server][conn], 
344                                                    fnum[server][conn][f],
345                                                    start, len);
346                         status[server] = cli_nt_error(cli[server][conn]);
347                 }
348                 if (showall || 
349                     (!hide_unlock_fails && !NT_STATUS_EQUAL(status[0],status[1]))) {
350                         printf("unlock conn=%u f=%u range=%.0f(%.0f)       -> %s:%s\n",
351                                conn, f, 
352                                (double)start, (double)len,
353                                nt_errstr(status[0]), nt_errstr(status[1]));
354                 }
355                 if (showall || !NT_STATUS_EQUAL(status[0],status[1])) show_locks();
356                 if (!hide_unlock_fails && !NT_STATUS_EQUAL(status[0],status[1])) 
357                         return False;
358                 break;
359
360         case OP_REOPEN:
361                 /* reopen the file */
362                 for (server=0;server<NSERVERS;server++) {
363                         cli_close(cli[server][conn], fnum[server][conn][f]);
364                         fnum[server][conn][f] = -1;
365                 }
366                 for (server=0;server<NSERVERS;server++) {
367                         fnum[server][conn][f] = cli_open(cli[server][conn], FILENAME,
368                                                          O_RDWR|O_CREAT,
369                                                          DENY_NONE);
370                         if (fnum[server][conn][f] == -1) {
371                                 printf("failed to reopen on share%d\n", server);
372                                 return False;
373                         }
374                 }
375                 if (showall) {
376                         printf("reopen conn=%u f=%u\n",
377                                conn, f);
378                         show_locks();
379                 }
380                 break;
381         }
382
383         return True;
384 }
385
386 static void close_files(struct cli_state *cli[NSERVERS][NCONNECTIONS], 
387                         int fnum[NSERVERS][NCONNECTIONS][NFILES])
388 {
389         int server, conn, f; 
390
391         for (server=0;server<NSERVERS;server++)
392         for (conn=0;conn<NCONNECTIONS;conn++)
393         for (f=0;f<NFILES;f++) {
394                 if (fnum[server][conn][f] != -1) {
395                         cli_close(cli[server][conn], fnum[server][conn][f]);
396                         fnum[server][conn][f] = -1;
397                 }
398         }
399         for (server=0;server<NSERVERS;server++) {
400                 cli_unlink(cli[server][0], FILENAME);
401         }
402 }
403
404 static void open_files(struct cli_state *cli[NSERVERS][NCONNECTIONS], 
405                        int fnum[NSERVERS][NCONNECTIONS][NFILES])
406 {
407         int server, conn, f; 
408
409         for (server=0;server<NSERVERS;server++)
410         for (conn=0;conn<NCONNECTIONS;conn++)
411         for (f=0;f<NFILES;f++) {
412                 fnum[server][conn][f] = cli_open(cli[server][conn], FILENAME,
413                                                  O_RDWR|O_CREAT,
414                                                  DENY_NONE);
415                 if (fnum[server][conn][f] == -1) {
416                         fprintf(stderr,"Failed to open fnum[%u][%u][%u]\n",
417                                 server, conn, f);
418                         exit(1);
419                 }
420         }
421 }
422
423
424 static int retest(struct cli_state *cli[NSERVERS][NCONNECTIONS], 
425                    int fnum[NSERVERS][NCONNECTIONS][NFILES],
426                    int n)
427 {
428         int i;
429         printf("testing %u ...\n", n);
430         for (i=0; i<n; i++) {
431                 if (i && i % 100 == 0) {
432                         printf("%u\n", i);
433                 }
434
435                 if (recorded[i].needed &&
436                     !test_one(cli, fnum, &recorded[i])) return i;
437         }
438         return n;
439 }
440
441
442 /* each server has two connections open to it. Each connection has two file
443    descriptors open on the file - 8 file descriptors in total 
444
445    we then do random locking ops in tamdem on the 4 fnums from each
446    server and ensure that the results match
447  */
448 static void test_locks(char *share[NSERVERS])
449 {
450         struct cli_state *cli[NSERVERS][NCONNECTIONS];
451         int fnum[NSERVERS][NCONNECTIONS][NFILES];
452         int n, i, n1, skip, r1, r2; 
453
454         ZERO_STRUCT(fnum);
455         ZERO_STRUCT(cli);
456
457         recorded = SMB_MALLOC_ARRAY(struct record, numops);
458
459         for (n=0; n<numops; n++) {
460 #if PRESETS
461                 if (n < sizeof(preset) / sizeof(preset[0])) {
462                         recorded[n] = preset[n];
463                 } else {
464 #endif
465                         recorded[n].conn = random() % NCONNECTIONS;
466                         recorded[n].f = random() % NFILES;
467                         recorded[n].start = lock_base + ((unsigned)random() % (lock_range-1));
468                         recorded[n].len =  min_length +
469                                 random() % (lock_range-(recorded[n].start-lock_base));
470                         recorded[n].start *= RANGE_MULTIPLE;
471                         recorded[n].len *= RANGE_MULTIPLE;
472                         r1 = random() % 100;
473                         r2 = random() % 100;
474                         if (r1 < READ_PCT) {
475                                 recorded[n].lock_type = READ_LOCK;
476                         } else {
477                                 recorded[n].lock_type = WRITE_LOCK;
478                         }
479                         if (r2 < LOCK_PCT) {
480                                 recorded[n].lock_op = OP_LOCK;
481                         } else if (r2 < UNLOCK_PCT) {
482                                 recorded[n].lock_op = OP_UNLOCK;
483                         } else {
484                                 recorded[n].lock_op = OP_REOPEN;
485                         }
486                         recorded[n].needed = True;
487                         if (!zero_zero && recorded[n].start==0 && recorded[n].len==0) {
488                                 recorded[n].len = 1;
489                         }
490 #if PRESETS
491                 }
492 #endif
493         }
494
495         reconnect(cli, fnum, share);
496         open_files(cli, fnum);
497         n = retest(cli, fnum, numops);
498
499         if (n == numops || !analyze) return;
500         n++;
501
502         skip = n/2;
503
504         while (1) {
505                 n1 = n;
506
507                 close_files(cli, fnum);
508                 reconnect(cli, fnum, share);
509                 open_files(cli, fnum);
510
511                 for (i=0;i<n-skip;i+=skip) {
512                         int m, j;
513                         printf("excluding %d-%d\n", i, i+skip-1);
514                         for (j=i;j<i+skip;j++) {
515                                 recorded[j].needed = False;
516                         }
517
518                         close_files(cli, fnum);
519                         open_files(cli, fnum);
520
521                         m = retest(cli, fnum, n);
522                         if (m == n) {
523                                 for (j=i;j<i+skip;j++) {
524                                         recorded[j].needed = True;
525                                 }
526                         } else {
527                                 if (i+(skip-1) < m) {
528                                         memmove(&recorded[i], &recorded[i+skip],
529                                                 (m-(i+skip-1))*sizeof(recorded[0]));
530                                 }
531                                 n = m-(skip-1);
532                                 i--;
533                         }
534                 }
535
536                 if (skip > 1) {
537                         skip = skip/2;
538                         printf("skip=%d\n", skip);
539                         continue;
540                 }
541
542                 if (n1 == n) break;
543         }
544
545         close_files(cli, fnum);
546         reconnect(cli, fnum, share);
547         open_files(cli, fnum);
548         showall = True;
549         n1 = retest(cli, fnum, n);
550         if (n1 != n-1) {
551                 printf("ERROR - inconsistent result (%u %u)\n", n1, n);
552         }
553         close_files(cli, fnum);
554
555         for (i=0;i<n;i++) {
556                 printf("{%s, %s, conn = %u, file = %u, start = %.0f, len = %.0f, %u},\n",
557                        lock_op_name(recorded[i].lock_op),
558                        lock_op_type(recorded[i].lock_type),
559                        recorded[i].conn,
560                        recorded[i].f,
561                        (double)recorded[i].start,
562                        (double)recorded[i].len,
563                        recorded[i].needed);
564         }       
565 }
566
567
568
569 static void usage(void)
570 {
571         printf(
572 "Usage:\n\
573   locktest //server1/share1 //server2/share2 [options..]\n\
574   options:\n\
575         -U user%%pass        (may be specified twice)\n\
576         -k               use kerberos\n\
577         -s seed\n\
578         -o numops\n\
579         -u          hide unlock fails\n\
580         -a          (show all ops)\n\
581         -A          analyse for minimal ops\n\
582         -O          use oplocks\n\
583         -E          enable exact error code checking\n\
584         -Z          enable the zero/zero lock\n\
585         -R range    set lock range\n\
586         -B base     set lock base\n\
587         -M min      set min lock length\n\
588 ");
589 }
590
591 /****************************************************************************
592   main program
593 ****************************************************************************/
594  int main(int argc,char *argv[])
595 {
596         char *share[NSERVERS];
597         int opt;
598         char *p;
599         int seed, server;
600
601         setlinebuf(stdout);
602
603         load_case_tables();
604
605         dbf = x_stderr;
606
607         if (argc < 3 || argv[1][0] == '-') {
608                 usage();
609                 exit(1);
610         }
611
612         setup_logging(argv[0],True);
613
614         for (server=0;server<NSERVERS;server++) {
615                 share[server] = argv[1+server];
616                 all_string_sub(share[server],"/","\\",0);
617         }
618
619         argc -= NSERVERS;
620         argv += NSERVERS;
621
622         lp_load(get_dyn_CONFIGFILE(),True,False,False,True);
623         load_interfaces();
624
625         if (getenv("USER")) {
626                 fstrcpy(username[0],getenv("USER"));
627                 fstrcpy(username[1],getenv("USER"));
628         }
629
630         seed = time(NULL);
631
632         while ((opt = getopt(argc, argv, "U:s:ho:aAW:OkR:B:M:EZ")) != EOF) {
633                 switch (opt) {
634                 case 'k':
635 #ifdef HAVE_KRB5
636                         use_kerberos = True;
637 #else
638                         d_printf("No kerberos support compiled in\n");
639                         exit(1);
640 #endif
641                         break;
642                 case 'U':
643                         got_user = 1;
644                         if (got_pass == 2) {
645                                 d_printf("Max of 2 usernames\n");
646                                 exit(1);
647                         }
648                         fstrcpy(username[got_pass],optarg);
649                         p = strchr_m(username[got_pass],'%');
650                         if (p) {
651                                 *p = 0;
652                                 fstrcpy(password[got_pass], p+1);
653                                 got_pass++;
654                         }
655                         break;
656                 case 'R':
657                         lock_range = strtol(optarg, NULL, 0);
658                         break;
659                 case 'B':
660                         lock_base = strtol(optarg, NULL, 0);
661                         break;
662                 case 'M':
663                         min_length = strtol(optarg, NULL, 0);
664                         break;
665                 case 's':
666                         seed = atoi(optarg);
667                         break;
668                 case 'u':
669                         hide_unlock_fails = True;
670                         break;
671                 case 'o':
672                         numops = atoi(optarg);
673                         break;
674                 case 'O':
675                         use_oplocks = True;
676                         break;
677                 case 'a':
678                         showall = True;
679                         break;
680                 case 'A':
681                         analyze = True;
682                         break;
683                 case 'Z':
684                         zero_zero = True;
685                         break;
686                 case 'E':
687                         exact_error_codes = True;
688                         break;
689                 case 'h':
690                         usage();
691                         exit(1);
692                 default:
693                         printf("Unknown option %c (%d)\n", (char)opt, opt);
694                         exit(1);
695                 }
696         }
697
698         if(use_kerberos && !got_user) got_pass = True;
699
700         argc -= optind;
701         argv += optind;
702
703         DEBUG(0,("seed=%u\n", seed));
704         srandom(seed);
705
706         test_locks(share);
707
708         return(0);
709 }