source/client/cifsdd.c

   1 /*
   2    CIFSDD - dd for SMB.
   3    Main program, argument handling and block copying.
   4
   5    Copyright (C) James Peach 2005-2006
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "includes.h"
  22 #include "system/filesys.h"
  23 #include "auth/gensec/gensec.h"
  24 #include "lib/cmdline/popt_common.h"
  25 #include "libcli/resolve/resolve.h"
  26 #include "libcli/raw/libcliraw.h"
  27
  28 #include "cifsdd.h"
  29 #include "param/param.h"
  30
  31 const char * const PROGNAME = "cifsdd";
  32
  33 #define SYNTAX_EXIT_CODE         1      /* Invokation syntax or logic error. */
  34 #define EOM_EXIT_CODE            9      /* Out of memory error. */
  35 #define FILESYS_EXIT_CODE       10      /* File manipulation error. */
  36 #define IOERROR_EXIT_CODE       11      /* Error during IO phase. */
  37
  38 struct  dd_stats_record dd_stats;
  39
  40 static int dd_sigint;
  41 static int dd_sigusr1;
  42
  43 static void dd_handle_signal(int sig)
  44 {
  45         switch (sig)
  46         {
  47                 case SIGINT:
  48                         ++dd_sigint;
  49                         break;
  50                 case SIGUSR1:
  51                         ++dd_sigusr1;
  52                         break;
  53                 default:
  54                         break;
  55         }
  56 }
  57
  58 /* ------------------------------------------------------------------------- */
  59 /* Argument handling.                                                        */
  60 /* ------------------------------------------------------------------------- */
  61
  62 static const char * argtype_str(enum argtype arg_type)
  63 {
  64         static const struct {
  65                 enum argtype arg_type;
  66                 const char * arg_name;
  67         } names [] =
  68         {
  69                 { ARG_NUMERIC, "COUNT" },
  70                 { ARG_SIZE, "SIZE" },
  71                 { ARG_PATHNAME, "FILE" },
  72                 { ARG_BOOL, "BOOLEAN" },
  73         };
  74
  75         int i;
  76
  77         for (i = 0; i < ARRAY_SIZE(names); ++i) {
  78                 if (arg_type == names[i].arg_type) {
  79                         return(names[i].arg_name);
  80                 }
  81         }
  82
  83         return("<unknown>");
  84 }
  85
  86 static struct argdef args[] =
  87 {
  88         { "bs", ARG_SIZE,       "force ibs and obs to SIZE bytes" },
  89         { "ibs", ARG_SIZE,      "read SIZE bytes at a time" },
  90         { "obs", ARG_SIZE,      "write SIZE bytes at a time" },
  91
  92         { "count", ARG_NUMERIC, "copy COUNT input blocks" },
  93         { "seek",ARG_NUMERIC,   "skip COUNT blocks at start of output" },
  94         { "skip",ARG_NUMERIC,   "skip COUNT blocks at start of input" },
  95
  96         { "if", ARG_PATHNAME,   "read input from FILE" },
  97         { "of", ARG_PATHNAME,   "write output to FILE" },
  98
  99         { "direct", ARG_BOOL,   "use direct I/O if non-zero" },
 100         { "sync", ARG_BOOL,     "use synchronous writes if non-zero" },
 101         { "oplock", ARG_BOOL,   "take oplocks on the input and output files" },
 102
 103 /* FIXME: We should support using iflags and oflags for setting oplock and I/O
 104  * options. This would make us compatible with GNU dd.
 105  */
 106 };
 107
 108 static struct argdef * find_named_arg(const char * arg)
 109 {
 110         int i;
 111
 112         for (i = 0; i < ARRAY_SIZE(args); ++i) {
 113                 if (strwicmp(arg, args[i].arg_name) == 0) {
 114                         return(&args[i]);
 115                 }
 116         }
 117
 118         return(NULL);
 119 }
 120
 121 int set_arg_argv(const char * argv)
 122 {
 123         struct argdef * arg;
 124
 125         char *  name;
 126         char *  val;
 127
 128         if ((name = strdup(argv)) == NULL) {
 129                 return(0);
 130         }
 131
 132         if ((val = strchr(name, '=')) == NULL) {
 133                 fprintf(stderr, "%s: malformed argument \"%s\"\n",
 134                                 PROGNAME, argv);
 135                 goto fail;
 136         }
 137
 138         *val = '\0';
 139         val++;
 140
 141         if ((arg = find_named_arg(name)) == NULL) {
 142                 fprintf(stderr, "%s: ignoring unknown argument \"%s\"\n",
 143                                 PROGNAME, name);
 144                 goto fail;
 145         }
 146
 147         /* Found a matching name; convert the variable argument. */
 148         switch (arg->arg_type) {
 149                 case ARG_NUMERIC:
 150                         if (!conv_str_u64(val, &arg->arg_val.nval)) {
 151                                 goto fail;
 152                         }
 153                         break;
 154                 case ARG_SIZE:
 155                         if (!conv_str_size(val, &arg->arg_val.nval)) {
 156                                 goto fail;
 157                         }
 158                         break;
 159                 case ARG_BOOL:
 160                         if (!conv_str_bool(val, &arg->arg_val.bval)) {
 161                                 goto fail;
 162                         }
 163                         break;
 164                 case ARG_PATHNAME:
 165                         if (!(arg->arg_val.pval = strdup(val))) {
 166                                 goto fail;
 167                         }
 168                         break;
 169                 default:
 170                         fprintf(stderr, "%s: argument \"%s\" is of "
 171                                 "unknown type\n", PROGNAME, name);
 172                         goto fail;
 173         }
 174
 175         free(name);
 176         return(1);
 177
 178 fail:
 179         free(name);
 180         return(0);
 181 }
 182
 183 void set_arg_val(const char * name, ...)
 184 {
 185         va_list         ap;
 186         struct argdef * arg;
 187
 188         va_start(ap, name);
 189         if ((arg = find_named_arg(name)) == NULL) {
 190                 goto fail;
 191         }
 192
 193         /* Found a matching name; convert the variable argument. */
 194         switch (arg->arg_type) {
 195                 case ARG_NUMERIC:
 196                 case ARG_SIZE:
 197                         arg->arg_val.nval = va_arg(ap, uint64_t);
 198                         break;
 199                 case ARG_BOOL:
 200                         arg->arg_val.bval = va_arg(ap, int);
 201                         break;
 202                 case ARG_PATHNAME:
 203                         arg->arg_val.pval = va_arg(ap, char *);
 204                         if (arg->arg_val.pval) {
 205                                 arg->arg_val.pval = strdup(arg->arg_val.pval);
 206                         }
 207                         break;
 208                 default:
 209                         fprintf(stderr, "%s: argument \"%s\" is of "
 210                                 "unknown type\n", PROGNAME, name);
 211                         goto fail;
 212         }
 213
 214         va_end(ap);
 215         return;
 216
 217 fail:
 218         fprintf(stderr, "%s: ignoring unknown argument \"%s\"\n",
 219                         PROGNAME, name);
 220         va_end(ap);
 221         return;
 222 }
 223
 224 bool check_arg_bool(const char * name)
 225 {
 226         struct argdef * arg;
 227
 228         if ((arg = find_named_arg(name)) &&
 229             (arg->arg_type == ARG_BOOL)) {
 230                 return(arg->arg_val.bval);
 231         }
 232
 233         DEBUG(0, ("invalid argument name: %s", name));
 234         SMB_ASSERT(0);
 235         return(false);
 236 }
 237
 238 uint64_t check_arg_numeric(const char * name)
 239 {
 240         struct argdef * arg;
 241
 242         if ((arg = find_named_arg(name)) &&
 243             (arg->arg_type == ARG_NUMERIC || arg->arg_type == ARG_SIZE)) {
 244                 return(arg->arg_val.nval);
 245         }
 246
 247         DEBUG(0, ("invalid argument name: %s", name));
 248         SMB_ASSERT(0);
 249         return(-1);
 250 }
 251
 252 const char * check_arg_pathname(const char * name)
 253 {
 254         struct argdef * arg;
 255
 256         if ((arg = find_named_arg(name)) &&
 257             (arg->arg_type == ARG_PATHNAME)) {
 258                 return(arg->arg_val.pval);
 259         }
 260
 261         DEBUG(0, ("invalid argument name: %s", name));
 262         SMB_ASSERT(0);
 263         return(NULL);
 264 }
 265
 266 static void dump_args(void)
 267 {
 268         int i;
 269
 270         DEBUG(10, ("dumping argument values:\n"));
 271         for (i = 0; i < ARRAY_SIZE(args); ++i) {
 272                 switch (args[i].arg_type) {
 273                         case ARG_NUMERIC:
 274                         case ARG_SIZE:
 275                                 DEBUG(10, ("\t%s=%llu\n", args[i].arg_name,
 276                                         (unsigned long long)args[i].arg_val.nval));
 277                                 break;
 278                         case ARG_BOOL:
 279                                 DEBUG(10, ("\t%s=%s\n", args[i].arg_name,
 280                                         args[i].arg_val.bval ? "yes" : "no"));
 281                                 break;
 282                         case ARG_PATHNAME:
 283                                 DEBUG(10, ("\t%s=%s\n", args[i].arg_name,
 284                                         args[i].arg_val.pval ?
 285                                                 args[i].arg_val.pval :
 286                                                 "(NULL)"));
 287                                 break;
 288                         default:
 289                                 SMB_ASSERT(0);
 290                 }
 291         }
 292 }
 293
 294 static void cifsdd_help_message(poptContext pctx,
 295                 enum poptCallbackReason preason,
 296                 struct poptOption * poption,
 297                 const char * parg,
 298                 void * pdata)
 299 {
 300         static const char notes[] =
 301 "FILE can be a local filename or a UNC path of the form //server/share/path.\n";
 302
 303         char prefix[24];
 304         int i;
 305
 306         if (poption->shortName != '?') {
 307                 poptPrintUsage(pctx, stdout, 0);
 308                 fprintf(stdout, "        [dd options]\n");
 309                 exit(0);
 310         }
 311
 312         poptPrintHelp(pctx, stdout, 0);
 313         fprintf(stdout, "\nCIFS dd options:\n");
 314
 315         for (i = 0; i < ARRAY_SIZE(args); ++i) {
 316                 if (args[i].arg_name == NULL) {
 317                         break;
 318                 }
 319
 320                 snprintf(prefix, sizeof(prefix), "%s=%-*s",
 321                         args[i].arg_name,
 322                         (int)(sizeof(prefix) - strlen(args[i].arg_name) - 2),
 323                         argtype_str(args[i].arg_type));
 324                 prefix[sizeof(prefix) - 1] = '\0';
 325                 fprintf(stdout, "  %s%s\n", prefix, args[i].arg_help);
 326         }
 327
 328         fprintf(stdout, "\n%s\n", notes);
 329         exit(0);
 330 }
 331
 332 /* ------------------------------------------------------------------------- */
 333 /* Main block copying routine.                                               */
 334 /* ------------------------------------------------------------------------- */
 335
 336 static void print_transfer_stats(void)
 337 {
 338         if (DEBUGLEVEL > 0) {
 339                 printf("%llu+%llu records in (%llu bytes)\n"
 340                         "%llu+%llu records out (%llu bytes)\n",
 341                         (unsigned long long)dd_stats.in.fblocks,
 342                         (unsigned long long)dd_stats.in.pblocks,
 343                         (unsigned long long)dd_stats.in.bytes,
 344                         (unsigned long long)dd_stats.out.fblocks,
 345                         (unsigned long long)dd_stats.out.pblocks,
 346                         (unsigned long long)dd_stats.out.bytes);
 347         } else {
 348                 printf("%llu+%llu records in\n%llu+%llu records out\n",
 349                                 (unsigned long long)dd_stats.in.fblocks,
 350                                 (unsigned long long)dd_stats.in.pblocks,
 351                                 (unsigned long long)dd_stats.out.fblocks,
 352                                 (unsigned long long)dd_stats.out.pblocks);
 353         }
 354 }
 355
 356 static struct dd_iohandle * open_file(struct resolve_context *resolve_ctx,
 357                                       const char * which, const char **ports,
 358                                       struct smbcli_options *smb_options)
 359 {
 360         int                     options = 0;
 361         const char *            path = NULL;
 362         struct dd_iohandle *    handle = NULL;
 363
 364         if (check_arg_bool("direct")) {
 365                 options |= DD_DIRECT_IO;
 366         }
 367
 368         if (check_arg_bool("sync")) {
 369                 options |= DD_SYNC_IO;
 370         }
 371
 372         if (check_arg_bool("oplock")) {
 373                 options |= DD_OPLOCK;
 374         }
 375
 376         if (strcmp(which, "if") == 0) {
 377                 path = check_arg_pathname("if");
 378                 handle = dd_open_path(resolve_ctx, path, ports,
 379                                       check_arg_numeric("ibs"), options,
 380                                       smb_options);
 381         } else if (strcmp(which, "of") == 0) {
 382                 options |= DD_WRITE;
 383                 path = check_arg_pathname("of");
 384                 handle = dd_open_path(resolve_ctx, path, ports,
 385                                       check_arg_numeric("obs"), options,
 386                                       smb_options);
 387         } else {
 388                 SMB_ASSERT(0);
 389                 return(NULL);
 390         }
 391
 392         if (!handle) {
 393                 fprintf(stderr, "%s: failed to open %s\n", PROGNAME, path);
 394         }
 395
 396         return(handle);
 397 }
 398
 399 static int copy_files(struct loadparm_context *lp_ctx)
 400 {
 401         uint8_t *       iobuf;  /* IO buffer. */
 402         uint64_t        iomax;  /* Size of the IO buffer. */
 403         uint64_t        data_size; /* Amount of data in the IO buffer. */
 404
 405         uint64_t        ibs;
 406         uint64_t        obs;
 407         uint64_t        count;
 408
 409         struct dd_iohandle *    ifile;
 410         struct dd_iohandle *    ofile;
 411
 412         struct smbcli_options options;
 413
 414         ibs = check_arg_numeric("ibs");
 415         obs = check_arg_numeric("obs");
 416         count = check_arg_numeric("count");
 417
 418         lp_smbcli_options(lp_ctx, &options);
 419
 420         /* Allocate IO buffer. We need more than the max IO size because we
 421          * could accumulate a remainder if ibs and obs don't match.
 422          */
 423         iomax = 2 * MAX(ibs, obs);
 424         if ((iobuf = malloc_array_p(uint8_t, iomax)) == NULL) {
 425                 fprintf(stderr,
 426                         "%s: failed to allocate IO buffer of %llu bytes\n",
 427                         PROGNAME, (unsigned long long)iomax);
 428                 return(EOM_EXIT_CODE);
 429         }
 430
 431         options.max_xmit = MAX(ibs, obs);
 432
 433         DEBUG(4, ("IO buffer size is %llu, max xmit is %d\n",
 434                         (unsigned long long)iomax, options.max_xmit));
 435
 436         if (!(ifile = open_file(lp_resolve_context(lp_ctx), "if",
 437                                 lp_smb_ports(lp_ctx), &options))) {
 438                 return(FILESYS_EXIT_CODE);
 439         }
 440
 441         if (!(ofile = open_file(lp_resolve_context(lp_ctx), "of",
 442                                 lp_smb_ports(lp_ctx), &options))) {
 443                 return(FILESYS_EXIT_CODE);
 444         }
 445
 446         /* Seek the files to their respective starting points. */
 447         ifile->io_seek(ifile, check_arg_numeric("skip") * ibs);
 448         ofile->io_seek(ofile, check_arg_numeric("seek") * obs);
 449
 450         DEBUG(4, ("max xmit was negotiated to be %d\n", options.max_xmit));
 451
 452         for (data_size = 0;;) {
 453
 454                 /* Handle signals. We are somewhat compatible with GNU dd.
 455                  * SIGINT makes us stop, but still print transfer statistics.
 456                  * SIGUSR1 makes us print transfer statistics but we continue
 457                  * copying.
 458                  */
 459                 if (dd_sigint) {
 460                         break;
 461                 }
 462
 463                 if (dd_sigusr1) {
 464                         print_transfer_stats();
 465                         dd_sigusr1 = 0;
 466                 }
 467
 468                 if (ifile->io_flags & DD_END_OF_FILE) {
 469                         DEBUG(4, ("flushing %llu bytes at EOF\n",
 470                                         (unsigned long long)data_size));
 471                         while (data_size > 0) {
 472                                 if (!dd_flush_block(ofile, iobuf,
 473                                                         &data_size, obs)) {
 474                                         return(IOERROR_EXIT_CODE);
 475                                 }
 476                         }
 477                         goto done;
 478                 }
 479
 480                 /* Try and read enough blocks of ibs bytes to be able write
 481                  * out one of obs bytes.
 482                  */
 483                 if (!dd_fill_block(ifile, iobuf, &data_size, obs, ibs)) {
 484                         return(IOERROR_EXIT_CODE);
 485                 }
 486
 487                 if (data_size == 0) {
 488                         /* Done. */
 489                         SMB_ASSERT(ifile->io_flags & DD_END_OF_FILE);
 490                 }
 491
 492                 /* Stop reading when we hit the block count. */
 493                 if (dd_stats.in.bytes >= (ibs * count)) {
 494                         ifile->io_flags |= DD_END_OF_FILE;
 495                 }
 496
 497                 /* If we wanted to be a legitimate dd, we would do character
 498                  * conversions and other shenanigans here.
 499                  */
 500
 501                 /* Flush what we read in units of obs bytes. We want to have
 502                  * at least obs bytes in the IO buffer but might not if the
 503                  * file is too small.
 504                  */
 505                 if (data_size &&
 506                     !dd_flush_block(ofile, iobuf, &data_size, obs)) {
 507                         return(IOERROR_EXIT_CODE);
 508                 }
 509         }
 510
 511 done:
 512         print_transfer_stats();
 513         return(0);
 514 }
 515
 516 /* ------------------------------------------------------------------------- */
 517 /* Main.                                                                     */
 518 /* ------------------------------------------------------------------------- */
 519
 520 struct poptOption cifsddHelpOptions[] = {
 521   { NULL, '\0', POPT_ARG_CALLBACK, (void *)&cifsdd_help_message, '\0', NULL, NULL },
 522   { "help", '?', 0, NULL, '?', "Show this help message", NULL },
 523   { "usage", '\0', 0, NULL, 'u', "Display brief usage message", NULL },
 524   { NULL }
 525 } ;
 526
 527 int main(int argc, const char ** argv)
 528 {
 529         int i;
 530         const char ** dd_args;
 531
 532         poptContext pctx;
 533         struct poptOption poptions[] = {
 534                 /* POPT_AUTOHELP */
 535                 { NULL, '\0', POPT_ARG_INCLUDE_TABLE, cifsddHelpOptions,
 536                         0, "Help options:", NULL },
 537                 POPT_COMMON_SAMBA
 538                 POPT_COMMON_CONNECTION
 539                 POPT_COMMON_CREDENTIALS
 540                 POPT_COMMON_VERSION
 541                 { NULL }
 542         };
 543
 544         /* Block sizes. */
 545         set_arg_val("bs", (uint64_t)4096);
 546         set_arg_val("ibs", (uint64_t)4096);
 547         set_arg_val("obs", (uint64_t)4096);
 548         /* Block counts. */
 549         set_arg_val("count", (uint64_t)-1);
 550         set_arg_val("seek", (uint64_t)0);
 551         set_arg_val("seek", (uint64_t)0);
 552         /* Files. */
 553         set_arg_val("if", NULL);
 554         set_arg_val("of", NULL);
 555         /* Options. */
 556         set_arg_val("direct", false);
 557         set_arg_val("sync", false);
 558         set_arg_val("oplock", false);
 559
 560         pctx = poptGetContext(PROGNAME, argc, argv, poptions, 0);
 561         while ((i = poptGetNextOpt(pctx)) != -1) {
 562                 ;
 563         }
 564
 565         for (dd_args = poptGetArgs(pctx); dd_args && *dd_args; ++dd_args) {
 566
 567                 if (!set_arg_argv(*dd_args)) {
 568                         fprintf(stderr, "%s: invalid option: %s\n",
 569                                         PROGNAME, *dd_args);
 570                         exit(SYNTAX_EXIT_CODE);
 571                 }
 572
 573                 /* "bs" has the side-effect of setting "ibs" and "obs". */
 574                 if (strncmp(*dd_args, "bs=", 3) == 0) {
 575                         uint64_t bs = check_arg_numeric("bs");
 576                         set_arg_val("ibs", bs);
 577                         set_arg_val("obs", bs);
 578                 }
 579         }
 580
 581         gensec_init(cmdline_lp_ctx);
 582         dump_args();
 583
 584         if (check_arg_numeric("ibs") == 0 || check_arg_numeric("ibs") == 0) {
 585                 fprintf(stderr, "%s: block sizes must be greater that zero\n",
 586                                 PROGNAME);
 587                 exit(SYNTAX_EXIT_CODE);
 588         }
 589
 590         if (check_arg_pathname("if") == NULL) {
 591                 fprintf(stderr, "%s: missing input filename\n", PROGNAME);
 592                 exit(SYNTAX_EXIT_CODE);
 593         }
 594
 595         if (check_arg_pathname("of") == NULL) {
 596                 fprintf(stderr, "%s: missing output filename\n", PROGNAME);
 597                 exit(SYNTAX_EXIT_CODE);
 598         }
 599
 600         CatchSignal(SIGINT, dd_handle_signal);
 601         CatchSignal(SIGUSR1, dd_handle_signal);
 602         return(copy_files(cmdline_lp_ctx));
 603 }
 604
 605 /* vim: set sw=8 sts=8 ts=8 tw=79 : */