source4/torture/raw/lockbench.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    locking benchmark
   5
   6    Copyright (C) Andrew Tridgell 2006
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "libcli/raw/libcliraw.h"
  24 #include "libcli/raw/raw_proto.h"
  25 #include "system/time.h"
  26 #include "system/filesys.h"
  27 #include "libcli/libcli.h"
  28 #include "torture/util.h"
  29 #include "lib/events/events.h"
  30 #include "lib/cmdline/popt_common.h"
  31 #include "libcli/composite/composite.h"
  32 #include "libcli/smb_composite/smb_composite.h"
  33 #include "libcli/resolve/resolve.h"
  34 #include "param/param.h"
  35 #include "torture/raw/proto.h"
  36
  37 #define BASEDIR "\\benchlock"
  38 #define FNAME BASEDIR "\\lock.dat"
  39
  40 static int nprocs;
  41 static int lock_failed;
  42 static int num_connected;
  43
  44 enum lock_stage {LOCK_INITIAL, LOCK_LOCK, LOCK_UNLOCK};
  45
  46 struct benchlock_state {
  47         struct torture_context *tctx;
  48         struct tevent_context *ev;
  49         struct smbcli_tree *tree;
  50         TALLOC_CTX *mem_ctx;
  51         int client_num;
  52         int fnum;
  53         enum lock_stage stage;
  54         int lock_offset;
  55         int unlock_offset;
  56         int count;
  57         int lastcount;
  58         struct smbcli_request *req;
  59         struct smb_composite_connect reconnect;
  60         struct tevent_timer *te;
  61
  62         /* these are used for reconnections */
  63         const char **dest_ports;
  64         const char *dest_host;
  65         const char *called_name;
  66         const char *service_type;
  67 };
  68
  69 static void lock_completion(struct smbcli_request *);
  70
  71 /*
  72   send the next lock request
  73 */
  74 static void lock_send(struct benchlock_state *state)
  75 {
  76         union smb_lock io;
  77         struct smb_lock_entry lock;
  78
  79         switch (state->stage) {
  80         case LOCK_INITIAL:
  81                 io.lockx.in.ulock_cnt = 0;
  82                 io.lockx.in.lock_cnt = 1;
  83                 state->lock_offset = 0;
  84                 state->unlock_offset = 0;
  85                 lock.offset = state->lock_offset;
  86                 break;
  87         case LOCK_LOCK:
  88                 io.lockx.in.ulock_cnt = 0;
  89                 io.lockx.in.lock_cnt = 1;
  90                 state->lock_offset = (state->lock_offset+1)%(nprocs+1);
  91                 lock.offset = state->lock_offset;
  92                 break;
  93         case LOCK_UNLOCK:
  94                 io.lockx.in.ulock_cnt = 1;
  95                 io.lockx.in.lock_cnt = 0;
  96                 lock.offset = state->unlock_offset;
  97                 state->unlock_offset = (state->unlock_offset+1)%(nprocs+1);
  98                 break;
  99         }
 100
 101         lock.count = 1;
 102         lock.pid = state->tree->session->pid;
 103
 104         io.lockx.level = RAW_LOCK_LOCKX;
 105         io.lockx.in.mode = LOCKING_ANDX_LARGE_FILES;
 106         io.lockx.in.timeout = 100000;
 107         io.lockx.in.locks = &lock;
 108         io.lockx.in.file.fnum = state->fnum;
 109
 110         state->req = smb_raw_lock_send(state->tree, &io);
 111         if (state->req == NULL) {
 112                 DEBUG(0,("Failed to setup lock\n"));
 113                 lock_failed++;
 114         }
 115         state->req->async.private_data = state;
 116         state->req->async.fn      = lock_completion;
 117 }
 118
 119 static void reopen_connection(struct tevent_context *ev, struct tevent_timer *te,
 120                               struct timeval t, void *private_data);
 121
 122
 123 static void reopen_file(struct tevent_context *ev, struct tevent_timer *te,
 124                                       struct timeval t, void *private_data)
 125 {
 126         struct benchlock_state *state = (struct benchlock_state *)private_data;
 127
 128         /* reestablish our open file */
 129         state->fnum = smbcli_open(state->tree, FNAME, O_RDWR|O_CREAT, DENY_NONE);
 130         if (state->fnum == -1) {
 131                 printf("Failed to open %s on connection %d\n", FNAME, state->client_num);
 132                 exit(1);
 133         }
 134
 135         num_connected++;
 136
 137         DEBUG(0,("reconnect to %s finished (%u connected)\n", state->dest_host,
 138                  num_connected));
 139
 140         state->stage = LOCK_INITIAL;
 141         lock_send(state);
 142 }
 143
 144 /*
 145   complete an async reconnect
 146  */
 147 static void reopen_connection_complete(struct composite_context *ctx)
 148 {
 149         struct benchlock_state *state = (struct benchlock_state *)ctx->async.private_data;
 150         NTSTATUS status;
 151         struct smb_composite_connect *io = &state->reconnect;
 152
 153         status = smb_composite_connect_recv(ctx, state->mem_ctx);
 154         if (!NT_STATUS_IS_OK(status)) {
 155                 talloc_free(state->te);
 156                 state->te = event_add_timed(state->ev, state->mem_ctx,
 157                                             timeval_current_ofs(1,0),
 158                                             reopen_connection, state);
 159                 return;
 160         }
 161
 162         talloc_free(state->tree);
 163         state->tree = io->out.tree;
 164
 165         /* do the reopen as a separate event */
 166         event_add_timed(state->ev, state->mem_ctx, timeval_zero(), reopen_file, state);
 167 }
 168
 169
 170
 171 /*
 172   reopen a connection
 173  */
 174 static void reopen_connection(struct tevent_context *ev, struct tevent_timer *te,
 175                               struct timeval t, void *private_data)
 176 {
 177         struct benchlock_state *state = (struct benchlock_state *)private_data;
 178         struct composite_context *ctx;
 179         struct smb_composite_connect *io = &state->reconnect;
 180         char *host, *share;
 181
 182         state->te = NULL;
 183
 184         if (!torture_get_conn_index(state->client_num, state->mem_ctx, state->tctx, &host, &share)) {
 185                 DEBUG(0,("Can't find host/share for reconnect?!\n"));
 186                 exit(1);
 187         }
 188
 189         io->in.dest_host    = state->dest_host;
 190         io->in.dest_ports   = state->dest_ports;
 191         io->in.gensec_settings = lpcfg_gensec_settings(state->mem_ctx, state->tctx->lp_ctx);
 192         io->in.socket_options = lpcfg_socket_options(state->tctx->lp_ctx);
 193         io->in.called_name  = state->called_name;
 194         io->in.service      = share;
 195         io->in.service_type = state->service_type;
 196         io->in.credentials  = cmdline_credentials;
 197         io->in.fallback_to_anonymous = false;
 198         io->in.workgroup    = lpcfg_workgroup(state->tctx->lp_ctx);
 199         lpcfg_smbcli_options(state->tctx->lp_ctx, &io->in.options);
 200         lpcfg_smbcli_session_options(state->tctx->lp_ctx, &io->in.session_options);
 201
 202         /* kill off the remnants of the old connection */
 203         talloc_free(state->tree);
 204         state->tree = NULL;
 205
 206         ctx = smb_composite_connect_send(io, state->mem_ctx,
 207                                          lpcfg_resolve_context(state->tctx->lp_ctx),
 208                                          state->ev);
 209         if (ctx == NULL) {
 210                 DEBUG(0,("Failed to setup async reconnect\n"));
 211                 exit(1);
 212         }
 213
 214         ctx->async.fn = reopen_connection_complete;
 215         ctx->async.private_data = state;
 216 }
 217
 218
 219 /*
 220   called when a lock completes
 221 */
 222 static void lock_completion(struct smbcli_request *req)
 223 {
 224         struct benchlock_state *state = (struct benchlock_state *)req->async.private_data;
 225         NTSTATUS status = smbcli_request_simple_recv(req);
 226         state->req = NULL;
 227         if (!NT_STATUS_IS_OK(status)) {
 228                 if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE) ||
 229                     NT_STATUS_EQUAL(status, NT_STATUS_LOCAL_DISCONNECT) ||
 230                     NT_STATUS_EQUAL(status, NT_STATUS_CONNECTION_RESET)) {
 231                         talloc_free(state->tree);
 232                         state->tree = NULL;
 233                         num_connected--;
 234                         DEBUG(0,("reopening connection to %s\n", state->dest_host));
 235                         talloc_free(state->te);
 236                         state->te = event_add_timed(state->ev, state->mem_ctx,
 237                                                     timeval_current_ofs(1,0),
 238                                                     reopen_connection, state);
 239                 } else {
 240                         DEBUG(0,("Lock failed - %s\n", nt_errstr(status)));
 241                         lock_failed++;
 242                 }
 243                 return;
 244         }
 245
 246         switch (state->stage) {
 247         case LOCK_INITIAL:
 248                 state->stage = LOCK_LOCK;
 249                 break;
 250         case LOCK_LOCK:
 251                 state->stage = LOCK_UNLOCK;
 252                 break;
 253         case LOCK_UNLOCK:
 254                 state->stage = LOCK_LOCK;
 255                 break;
 256         }
 257
 258         state->count++;
 259         lock_send(state);
 260 }
 261
 262
 263 static void echo_completion(struct smbcli_request *req)
 264 {
 265         struct benchlock_state *state = (struct benchlock_state *)req->async.private_data;
 266         NTSTATUS status = smbcli_request_simple_recv(req);
 267         if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE) ||
 268             NT_STATUS_EQUAL(status, NT_STATUS_LOCAL_DISCONNECT) ||
 269             NT_STATUS_EQUAL(status, NT_STATUS_CONNECTION_RESET)) {
 270                 talloc_free(state->tree);
 271                 state->tree = NULL;
 272                 num_connected--;
 273                 DEBUG(0,("reopening connection to %s\n", state->dest_host));
 274                 talloc_free(state->te);
 275                 state->te = event_add_timed(state->ev, state->mem_ctx,
 276                                             timeval_current_ofs(1,0),
 277                                             reopen_connection, state);
 278         }
 279 }
 280
 281 static void report_rate(struct tevent_context *ev, struct tevent_timer *te,
 282                         struct timeval t, void *private_data)
 283 {
 284         struct benchlock_state *state = talloc_get_type(private_data,
 285                                                         struct benchlock_state);
 286         int i;
 287         for (i=0;i<nprocs;i++) {
 288                 printf("%5u ", (unsigned)(state[i].count - state[i].lastcount));
 289                 state[i].lastcount = state[i].count;
 290         }
 291         printf("\r");
 292         fflush(stdout);
 293         event_add_timed(ev, state, timeval_current_ofs(1, 0), report_rate, state);
 294
 295         /* send an echo on each interface to ensure it stays alive - this helps
 296            with IP takeover */
 297         for (i=0;i<nprocs;i++) {
 298                 struct smb_echo p;
 299                 struct smbcli_request *req;
 300
 301                 if (!state[i].tree) {
 302                         continue;
 303                 }
 304
 305                 p.in.repeat_count = 1;
 306                 p.in.size = 0;
 307                 p.in.data = NULL;
 308                 req = smb_raw_echo_send(state[i].tree->session->transport, &p);
 309                 req->async.private_data = &state[i];
 310                 req->async.fn      = echo_completion;
 311         }
 312 }
 313
 314 /*
 315    benchmark locking calls
 316 */
 317 bool torture_bench_lock(struct torture_context *torture)
 318 {
 319         bool ret = true;
 320         TALLOC_CTX *mem_ctx = talloc_new(torture);
 321         int i, j;
 322         int timelimit = torture_setting_int(torture, "timelimit", 10);
 323         struct timeval tv;
 324         struct benchlock_state *state;
 325         int total = 0, minops=0;
 326         struct smbcli_state *cli;
 327         bool progress;
 328         off_t offset;
 329         int initial_locks = torture_setting_int(torture, "initial_locks", 0);
 330
 331         progress = torture_setting_bool(torture, "progress", true);
 332
 333         nprocs = torture_setting_int(torture, "nprocs", 4);
 334
 335         state = talloc_zero_array(mem_ctx, struct benchlock_state, nprocs);
 336
 337         printf("Opening %d connections\n", nprocs);
 338         for (i=0;i<nprocs;i++) {
 339                 state[i].tctx = torture;
 340                 state[i].mem_ctx = talloc_new(state);
 341                 state[i].client_num = i;
 342                 state[i].ev = torture->ev;
 343                 if (!torture_open_connection_ev(&cli, i, torture, torture->ev)) {
 344                         return false;
 345                 }
 346                 talloc_steal(mem_ctx, state);
 347                 state[i].tree = cli->tree;
 348                 state[i].dest_host = talloc_strdup(state[i].mem_ctx,
 349                                                    cli->tree->session->transport->socket->hostname);
 350                 state[i].dest_ports = talloc_array(state[i].mem_ctx,
 351                                                    const char *, 2);
 352                 state[i].dest_ports[0] = talloc_asprintf(state[i].dest_ports,
 353                                                          "%u",
 354                                                          cli->tree->session->transport->socket->port);
 355                 state[i].dest_ports[1] = NULL;
 356                 state[i].called_name  = talloc_strdup(state[i].mem_ctx,
 357                                                       cli->tree->session->transport->called.name);
 358                 state[i].service_type = talloc_strdup(state[i].mem_ctx,
 359                                                       cli->tree->device);
 360         }
 361
 362         num_connected = i;
 363
 364         if (!torture_setup_dir(cli, BASEDIR)) {
 365                 goto failed;
 366         }
 367
 368         for (i=0;i<nprocs;i++) {
 369                 state[i].fnum = smbcli_open(state[i].tree,
 370                                             FNAME,
 371                                             O_RDWR|O_CREAT, DENY_NONE);
 372                 if (state[i].fnum == -1) {
 373                         printf("Failed to open %s on connection %d\n", FNAME, i);
 374                         goto failed;
 375                 }
 376
 377                 /* Optionally, lock initial_locks for each proc beforehand. */
 378                 if (i == 0 && initial_locks > 0) {
 379                         printf("Initializing %d locks on each proc.\n",
 380                             initial_locks);
 381                 }
 382
 383                 for (j = 0; j < initial_locks; j++) {
 384                         offset = (0xFFFFFED8LLU * (i+2)) + j;
 385                         if (!NT_STATUS_IS_OK(smbcli_lock64(state[i].tree,
 386                             state[i].fnum, offset, 1, 0, WRITE_LOCK))) {
 387                                 printf("Failed initializing, lock=%d\n", j);
 388                                 goto failed;
 389                         }
 390                 }
 391
 392                 state[i].stage = LOCK_INITIAL;
 393                 lock_send(&state[i]);
 394         }
 395
 396         tv = timeval_current();
 397
 398         if (progress) {
 399                 event_add_timed(torture->ev, state, timeval_current_ofs(1, 0), report_rate, state);
 400         }
 401
 402         printf("Running for %d seconds\n", timelimit);
 403         while (timeval_elapsed(&tv) < timelimit) {
 404                 event_loop_once(torture->ev);
 405
 406                 if (lock_failed) {
 407                         DEBUG(0,("locking failed\n"));
 408                         goto failed;
 409                 }
 410         }
 411
 412         printf("%.2f ops/second\n", total/timeval_elapsed(&tv));
 413         minops = state[0].count;
 414         for (i=0;i<nprocs;i++) {
 415                 printf("[%d] %u ops\n", i, state[i].count);
 416                 if (state[i].count < minops) minops = state[i].count;
 417         }
 418         if (minops < 0.5*total/nprocs) {
 419                 printf("Failed: unbalanced locking\n");
 420                 goto failed;
 421         }
 422
 423         for (i=0;i<nprocs;i++) {
 424                 talloc_free(state[i].req);
 425                 smb_raw_exit(state[i].tree->session);
 426         }
 427
 428         smbcli_deltree(state[0].tree, BASEDIR);
 429         talloc_free(mem_ctx);
 430         printf("\n");
 431         return ret;
 432
 433 failed:
 434         smbcli_deltree(state[0].tree, BASEDIR);
 435         talloc_free(mem_ctx);
 436         return false;
 437 }