coreutils/dd.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini dd implementation for busybox
   4  *
   5  *
   6  * Copyright (C) 2000,2001  Matt Kraai
   7  *
   8  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   9  */
  10
  11 //usage:#define dd_trivial_usage
  12 //usage:       "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n"
  13 //usage:       "        [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
  14 //usage:#define dd_full_usage "\n\n"
  15 //usage:       "Copy a file with converting and formatting\n"
  16 //usage:     "\n        if=FILE         Read from FILE instead of stdin"
  17 //usage:     "\n        of=FILE         Write to FILE instead of stdout"
  18 //usage:     "\n        bs=N            Read and write N bytes at a time"
  19 //usage:        IF_FEATURE_DD_IBS_OBS(
  20 //usage:     "\n        ibs=N           Read N bytes at a time"
  21 //usage:        )
  22 //usage:        IF_FEATURE_DD_IBS_OBS(
  23 //usage:     "\n        obs=N           Write N bytes at a time"
  24 //usage:        )
  25 //usage:     "\n        count=N         Copy only N input blocks"
  26 //usage:     "\n        skip=N          Skip N input blocks"
  27 //usage:     "\n        seek=N          Skip N output blocks"
  28 //usage:        IF_FEATURE_DD_IBS_OBS(
  29 //usage:     "\n        conv=notrunc    Don't truncate output file"
  30 //usage:     "\n        conv=noerror    Continue after read errors"
  31 //usage:     "\n        conv=sync       Pad blocks with zeros"
  32 //usage:     "\n        conv=fsync      Physically write data out before finishing"
  33 //usage:     "\n        conv=swab       Swap every pair of bytes"
  34 //usage:        )
  35 //usage:     "\n"
  36 //usage:     "\nN may be suffixed by c (1), w (2), b (512), kD (1000), k (1024), MD, M, GD, G"
  37 //usage:
  38 //usage:#define dd_example_usage
  39 //usage:       "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n"
  40 //usage:       "4+0 records in\n"
  41 //usage:       "4+0 records out\n"
  42
  43 #include "libbb.h"
  44
  45 /* This is a NOEXEC applet. Be very careful! */
  46
  47
  48 enum {
  49         ifd = STDIN_FILENO,
  50         ofd = STDOUT_FILENO,
  51 };
  52
  53 static const struct suffix_mult dd_suffixes[] = {
  54         { "c", 1 },
  55         { "w", 2 },
  56         { "b", 512 },
  57         { "kD", 1000 },
  58         { "k", 1024 },
  59         { "K", 1024 },  /* compat with coreutils dd */
  60         { "MD", 1000000 },
  61         { "M", 1048576 },
  62         { "GD", 1000000000 },
  63         { "G", 1073741824 },
  64         { "", 0 }
  65 };
  66
  67 struct globals {
  68         off_t out_full, out_part, in_full, in_part;
  69 #if ENABLE_FEATURE_DD_THIRD_STATUS_LINE
  70         unsigned long long total_bytes;
  71         unsigned long long begin_time_us;
  72 #endif
  73 } FIX_ALIASING;
  74 #define G (*(struct globals*)&bb_common_bufsiz1)
  75 #define INIT_G() do { \
  76         /* we have to zero it out because of NOEXEC */ \
  77         memset(&G, 0, sizeof(G)); \
  78 } while (0)
  79
  80
  81 static void dd_output_status(int UNUSED_PARAM cur_signal)
  82 {
  83 #if ENABLE_FEATURE_DD_THIRD_STATUS_LINE
  84         double seconds;
  85         unsigned long long bytes_sec;
  86         unsigned long long now_us = monotonic_us(); /* before fprintf */
  87 #endif
  88
  89         /* Deliberately using %u, not %d */
  90         fprintf(stderr, "%"OFF_FMT"u+%"OFF_FMT"u records in\n"
  91                         "%"OFF_FMT"u+%"OFF_FMT"u records out\n",
  92                         G.in_full, G.in_part,
  93                         G.out_full, G.out_part);
  94
  95 #if ENABLE_FEATURE_DD_THIRD_STATUS_LINE
  96         fprintf(stderr, "%llu bytes (%sB) copied, ",
  97                         G.total_bytes,
  98                         /* show fractional digit, use suffixes */
  99                         make_human_readable_str(G.total_bytes, 1, 0)
 100         );
 101         /* Corner cases:
 102          * ./busybox dd </dev/null >/dev/null
 103          * ./busybox dd bs=1M count=2000 </dev/zero >/dev/null
 104          * (echo DONE) | ./busybox dd >/dev/null
 105          * (sleep 1; echo DONE) | ./busybox dd >/dev/null
 106          */
 107         seconds = (now_us - G.begin_time_us) / 1000000.0;
 108         bytes_sec = G.total_bytes / seconds;
 109         fprintf(stderr, "%f seconds, %sB/s\n",
 110                         seconds,
 111                         /* show fractional digit, use suffixes */
 112                         make_human_readable_str(bytes_sec, 1, 0)
 113         );
 114 #endif
 115 }
 116
 117 static ssize_t full_write_or_warn(const void *buf, size_t len,
 118         const char *const filename)
 119 {
 120         ssize_t n = full_write(ofd, buf, len);
 121         if (n < 0)
 122                 bb_perror_msg("writing '%s'", filename);
 123         return n;
 124 }
 125
 126 static bool write_and_stats(const void *buf, size_t len, size_t obs,
 127         const char *filename)
 128 {
 129         ssize_t n = full_write_or_warn(buf, len, filename);
 130         if (n < 0)
 131                 return 1;
 132         if ((size_t)n == obs)
 133                 G.out_full++;
 134         else if (n) /* > 0 */
 135                 G.out_part++;
 136 #if ENABLE_FEATURE_DD_THIRD_STATUS_LINE
 137         G.total_bytes += n;
 138 #endif
 139         return 0;
 140 }
 141
 142 #if ENABLE_LFS
 143 # define XATOU_SFX xatoull_sfx
 144 #else
 145 # define XATOU_SFX xatoul_sfx
 146 #endif
 147
 148 int dd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 149 int dd_main(int argc UNUSED_PARAM, char **argv)
 150 {
 151         enum {
 152                 /* Must be in the same order as OP_conv_XXX! */
 153                 /* (see "flags |= (1 << what)" below) */
 154                 FLAG_NOTRUNC = (1 << 0) * ENABLE_FEATURE_DD_IBS_OBS,
 155                 FLAG_SYNC    = (1 << 1) * ENABLE_FEATURE_DD_IBS_OBS,
 156                 FLAG_NOERROR = (1 << 2) * ENABLE_FEATURE_DD_IBS_OBS,
 157                 FLAG_FSYNC   = (1 << 3) * ENABLE_FEATURE_DD_IBS_OBS,
 158                 FLAG_SWAB    = (1 << 4) * ENABLE_FEATURE_DD_IBS_OBS,
 159                 /* end of conv flags */
 160                 FLAG_TWOBUFS = (1 << 5) * ENABLE_FEATURE_DD_IBS_OBS,
 161                 FLAG_COUNT   = 1 << 6,
 162         };
 163         static const char keywords[] ALIGN1 =
 164                 "bs\0""count\0""seek\0""skip\0""if\0""of\0"
 165 #if ENABLE_FEATURE_DD_IBS_OBS
 166                 "ibs\0""obs\0""conv\0"
 167 #endif
 168                 ;
 169 #if ENABLE_FEATURE_DD_IBS_OBS
 170         static const char conv_words[] ALIGN1 =
 171                 "notrunc\0""sync\0""noerror\0""fsync\0""swab\0";
 172 #endif
 173         enum {
 174                 OP_bs = 0,
 175                 OP_count,
 176                 OP_seek,
 177                 OP_skip,
 178                 OP_if,
 179                 OP_of,
 180 #if ENABLE_FEATURE_DD_IBS_OBS
 181                 OP_ibs,
 182                 OP_obs,
 183                 OP_conv,
 184                 /* Must be in the same order as FLAG_XXX! */
 185                 OP_conv_notrunc = 0,
 186                 OP_conv_sync,
 187                 OP_conv_noerror,
 188                 OP_conv_fsync,
 189                 OP_conv_swab,
 190         /* Unimplemented conv=XXX: */
 191         //nocreat       do not create the output file
 192         //excl          fail if the output file already exists
 193         //fdatasync     physically write output file data before finishing
 194         //lcase         change upper case to lower case
 195         //ucase         change lower case to upper case
 196         //block         pad newline-terminated records with spaces to cbs-size
 197         //unblock       replace trailing spaces in cbs-size records with newline
 198         //ascii         from EBCDIC to ASCII
 199         //ebcdic        from ASCII to EBCDIC
 200         //ibm           from ASCII to alternate EBCDIC
 201         /* Partially implemented: */
 202         //swab          swap every pair of input bytes: will abort on non-even reads
 203 #endif
 204         };
 205         smallint exitcode = EXIT_FAILURE;
 206         size_t ibs = 512, obs = 512;
 207         int i;
 208         char *ibuf, *obuf;
 209         /* And these are all zeroed at once! */
 210         struct {
 211                 int flags;
 212                 size_t oc;
 213                 ssize_t prev_read_size; /* for detecting swab failure */
 214                 off_t count;
 215                 off_t seek, skip;
 216                 const char *infile, *outfile;
 217         } Z;
 218 #define flags   (Z.flags  )
 219 #define oc      (Z.oc     )
 220 #define prev_read_size (Z.prev_read_size)
 221 #define count   (Z.count  )
 222 #define seek    (Z.seek   )
 223 #define skip    (Z.skip   )
 224 #define infile  (Z.infile )
 225 #define outfile (Z.outfile)
 226
 227         memset(&Z, 0, sizeof(Z));
 228         INIT_G();
 229         //fflush_all(); - is this needed because of NOEXEC?
 230
 231         for (i = 1; argv[i]; i++) {
 232                 int what;
 233                 char *val;
 234                 char *arg = argv[i];
 235
 236 #if ENABLE_DESKTOP
 237                 /* "dd --". NB: coreutils 6.9 will complain if they see
 238                  * more than one of them. We wouldn't. */
 239                 if (arg[0] == '-' && arg[1] == '-' && arg[2] == '\0')
 240                         continue;
 241 #endif
 242                 val = strchr(arg, '=');
 243                 if (val == NULL)
 244                         bb_show_usage();
 245                 *val = '\0';
 246                 what = index_in_strings(keywords, arg);
 247                 if (what < 0)
 248                         bb_show_usage();
 249                 /* *val = '='; - to preserve ps listing? */
 250                 val++;
 251 #if ENABLE_FEATURE_DD_IBS_OBS
 252                 if (what == OP_ibs) {
 253                         /* Must fit into positive ssize_t */
 254                         ibs = xatoul_range_sfx(val, 1, ((size_t)-1L)/2, dd_suffixes);
 255                         /*continue;*/
 256                 }
 257                 if (what == OP_obs) {
 258                         obs = xatoul_range_sfx(val, 1, ((size_t)-1L)/2, dd_suffixes);
 259                         /*continue;*/
 260                 }
 261                 if (what == OP_conv) {
 262                         while (1) {
 263                                 /* find ',', replace them with NUL so we can use val for
 264                                  * index_in_strings() without copying.
 265                                  * We rely on val being non-null, else strchr would fault.
 266                                  */
 267                                 arg = strchr(val, ',');
 268                                 if (arg)
 269                                         *arg = '\0';
 270                                 what = index_in_strings(conv_words, val);
 271                                 if (what < 0)
 272                                         bb_error_msg_and_die(bb_msg_invalid_arg, val, "conv");
 273                                 flags |= (1 << what);
 274                                 if (!arg) /* no ',' left, so this was the last specifier */
 275                                         break;
 276                                 /* *arg = ','; - to preserve ps listing? */
 277                                 val = arg + 1; /* skip this keyword and ',' */
 278                         }
 279                         continue; /* we trashed 'what', can't fall through */
 280                 }
 281 #endif
 282                 if (what == OP_bs) {
 283                         ibs = obs = xatoul_range_sfx(val, 1, ((size_t)-1L)/2, dd_suffixes);
 284                         /*continue;*/
 285                 }
 286                 /* These can be large: */
 287                 if (what == OP_count) {
 288                         flags |= FLAG_COUNT;
 289                         count = XATOU_SFX(val, dd_suffixes);
 290                         /*continue;*/
 291                 }
 292                 if (what == OP_seek) {
 293                         seek = XATOU_SFX(val, dd_suffixes);
 294                         /*continue;*/
 295                 }
 296                 if (what == OP_skip) {
 297                         skip = XATOU_SFX(val, dd_suffixes);
 298                         /*continue;*/
 299                 }
 300                 if (what == OP_if) {
 301                         infile = val;
 302                         /*continue;*/
 303                 }
 304                 if (what == OP_of) {
 305                         outfile = val;
 306                         /*continue;*/
 307                 }
 308         } /* end of "for (argv[i])" */
 309
 310 //XXX:FIXME for huge ibs or obs, malloc'ing them isn't the brightest idea ever
 311         ibuf = obuf = xmalloc(ibs);
 312         if (ibs != obs) {
 313                 flags |= FLAG_TWOBUFS;
 314                 obuf = xmalloc(obs);
 315         }
 316
 317 #if ENABLE_FEATURE_DD_SIGNAL_HANDLING
 318         signal_SA_RESTART_empty_mask(SIGUSR1, dd_output_status);
 319 #endif
 320 #if ENABLE_FEATURE_DD_THIRD_STATUS_LINE
 321         G.begin_time_us = monotonic_us();
 322 #endif
 323
 324         if (infile != NULL)
 325                 xmove_fd(xopen(infile, O_RDONLY), ifd);
 326         else {
 327                 infile = bb_msg_standard_input;
 328         }
 329         if (outfile != NULL) {
 330                 int oflag = O_WRONLY | O_CREAT;
 331
 332                 if (!seek && !(flags & FLAG_NOTRUNC))
 333                         oflag |= O_TRUNC;
 334
 335                 xmove_fd(xopen(outfile, oflag), ofd);
 336
 337                 if (seek && !(flags & FLAG_NOTRUNC)) {
 338                         if (ftruncate(ofd, seek * obs) < 0) {
 339                                 struct stat st;
 340
 341                                 if (fstat(ofd, &st) < 0
 342                                  || S_ISREG(st.st_mode)
 343                                  || S_ISDIR(st.st_mode)
 344                                 ) {
 345                                         goto die_outfile;
 346                                 }
 347                         }
 348                 }
 349         } else {
 350                 outfile = bb_msg_standard_output;
 351         }
 352         if (skip) {
 353                 if (lseek(ifd, skip * ibs, SEEK_CUR) < 0) {
 354                         while (skip-- > 0) {
 355                                 ssize_t n = safe_read(ifd, ibuf, ibs);
 356                                 if (n < 0)
 357                                         goto die_infile;
 358                                 if (n == 0)
 359                                         break;
 360                         }
 361                 }
 362         }
 363         if (seek) {
 364                 if (lseek(ofd, seek * obs, SEEK_CUR) < 0)
 365                         goto die_outfile;
 366         }
 367
 368         while (!(flags & FLAG_COUNT) || (G.in_full + G.in_part != count)) {
 369                 ssize_t n;
 370
 371                 n = safe_read(ifd, ibuf, ibs);
 372                 if (n == 0)
 373                         break;
 374                 if (n < 0) {
 375                         /* "Bad block" */
 376                         if (!(flags & FLAG_NOERROR))
 377                                 goto die_infile;
 378                         bb_simple_perror_msg(infile);
 379                         /* GNU dd with conv=noerror skips over bad blocks */
 380                         xlseek(ifd, ibs, SEEK_CUR);
 381                         /* conv=noerror,sync writes NULs,
 382                          * conv=noerror just ignores input bad blocks */
 383                         n = 0;
 384                 }
 385                 if (flags & FLAG_SWAB) {
 386                         uint16_t *p16, *end;
 387
 388                         /* Our code allows only last read to be odd-sized */
 389                         if (prev_read_size & 1)
 390                                 bb_error_msg_and_die("can't swab %lu byte buffer",
 391                                                 (unsigned long)prev_read_size);
 392                         prev_read_size = n;
 393
 394                         /*
 395                          * If n is odd, last byte is not swapped:
 396                          *  echo -n "qwe" | dd conv=swab
 397                          * prints "wqe".
 398                          * The code does not handle correctly odd-sized reads
 399                          * in the *middle* of the input. FIXME.
 400                          */
 401                         p16 = (void*) ibuf;
 402                         end = (void*) (ibuf + (n & ~(ssize_t)1));
 403                         while (p16 < end) {
 404                                 *p16 = bswap_16(*p16);
 405                                 p16++;
 406                         }
 407                 }
 408                 if ((size_t)n == ibs)
 409                         G.in_full++;
 410                 else {
 411                         G.in_part++;
 412                         if (flags & FLAG_SYNC) {
 413                                 memset(ibuf + n, 0, ibs - n);
 414                                 n = ibs;
 415                         }
 416                 }
 417                 if (flags & FLAG_TWOBUFS) {
 418                         char *tmp = ibuf;
 419                         while (n) {
 420                                 size_t d = obs - oc;
 421
 422                                 if (d > (size_t)n)
 423                                         d = n;
 424                                 memcpy(obuf + oc, tmp, d);
 425                                 n -= d;
 426                                 tmp += d;
 427                                 oc += d;
 428                                 if (oc == obs) {
 429                                         if (write_and_stats(obuf, obs, obs, outfile))
 430                                                 goto out_status;
 431                                         oc = 0;
 432                                 }
 433                         }
 434                 } else if (write_and_stats(ibuf, n, obs, outfile))
 435                         goto out_status;
 436
 437                 if (flags & FLAG_FSYNC) {
 438                         if (fsync(ofd) < 0)
 439                                 goto die_outfile;
 440                 }
 441         }
 442
 443         if (ENABLE_FEATURE_DD_IBS_OBS && oc) {
 444                 ssize_t w = full_write_or_warn(obuf, oc, outfile);
 445                 if (w < 0) goto out_status;
 446                 if (w > 0) G.out_part++;
 447         }
 448         if (close(ifd) < 0) {
 449  die_infile:
 450                 bb_simple_perror_msg_and_die(infile);
 451         }
 452
 453         if (close(ofd) < 0) {
 454  die_outfile:
 455                 bb_simple_perror_msg_and_die(outfile);
 456         }
 457
 458         exitcode = EXIT_SUCCESS;
 459  out_status:
 460         dd_output_status(0);
 461
 462         if (ENABLE_FEATURE_CLEAN_UP) {
 463                 free(obuf);
 464                 if (flags & FLAG_TWOBUFS)
 465                         free(ibuf);
 466         }
 467
 468         return exitcode;
 469 }