config: trim/improve item names and help texts.
[oweals/busybox.git] / coreutils / dd.c
index 30249707421f1268148b3503f777ef2be18f88c1..43545c01074f028f2b6a11c57dc506ff215a9d14 100644 (file)
@@ -2,60 +2,62 @@
 /*
  * Mini dd implementation for busybox
  *
- *
  * Copyright (C) 2000,2001  Matt Kraai
  *
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
-
 //config:config DD
-//config:      bool "dd"
+//config:      bool "dd (7.1 kb)"
 //config:      default y
 //config:      help
-//config:        dd copies a file (from standard input to standard output,
-//config:        by default) using specific input and output blocksizes,
-//config:        while optionally performing conversions on it.
+//config:      dd copies a file (from standard input to standard output,
+//config:      by default) using specific input and output blocksizes,
+//config:      while optionally performing conversions on it.
 //config:
 //config:config FEATURE_DD_SIGNAL_HANDLING
 //config:      bool "Enable signal handling for status reporting"
 //config:      default y
 //config:      depends on DD
 //config:      help
-//config:        Sending a SIGUSR1 signal to a running `dd' process makes it
-//config:        print to standard error the number of records read and written
-//config:        so far, then to resume copying.
+//config:      Sending a SIGUSR1 signal to a running `dd' process makes it
+//config:      print to standard error the number of records read and written
+//config:      so far, then to resume copying.
 //config:
-//config:        $ dd if=/dev/zero of=/dev/null &
-//config:        $ pid=$!; kill -USR1 $pid; sleep 1; kill $pid
-//config:        10899206+0 records in
-//config:        10899206+0 records out
+//config:      $ dd if=/dev/zero of=/dev/null &
+//config:      $ pid=$!; kill -USR1 $pid; sleep 1; kill $pid
+//config:      10899206+0 records in
+//config:      10899206+0 records out
 //config:
 //config:config FEATURE_DD_THIRD_STATUS_LINE
 //config:      bool "Enable the third status line upon signal"
 //config:      default y
 //config:      depends on DD && FEATURE_DD_SIGNAL_HANDLING
 //config:      help
-//config:        Displays a coreutils-like third status line with transferred bytes,
-//config:        elapsed time and speed.
+//config:      Displays a coreutils-like third status line with transferred bytes,
+//config:      elapsed time and speed.
 //config:
 //config:config FEATURE_DD_IBS_OBS
 //config:      bool "Enable ibs, obs and conv options"
 //config:      default y
 //config:      depends on DD
 //config:      help
-//config:        Enables support for writing a certain number of bytes in and out,
-//config:        at a time, and performing conversions on the data stream.
+//config:      Enable support for writing a certain number of bytes in and out,
+//config:      at a time, and performing conversions on the data stream.
 //config:
 //config:config FEATURE_DD_STATUS
 //config:      bool "Enable status display options"
 //config:      default y
 //config:      depends on DD
 //config:      help
-//config:        Enables support for status=noxfer/none option.
+//config:      Enable support for status=noxfer/none option.
+
+//applet:IF_DD(APPLET_NOEXEC(dd, dd, BB_DIR_BIN, BB_SUID_DROP, dd))
+
+//kbuild:lib-$(CONFIG_DD) += dd.o
 
 //usage:#define dd_trivial_usage
 //usage:       "[if=FILE] [of=FILE] " IF_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n"
-//usage:       "       [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
+//usage:       "       [seek=N]" IF_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync] [iflag=skip_bytes]")
 //usage:#define dd_full_usage "\n\n"
 //usage:       "Copy a file with converting and formatting\n"
 //usage:     "\n       if=FILE         Read from FILE instead of stdin"
@@ -76,6 +78,7 @@
 //usage:     "\n       conv=sync       Pad blocks with zeros"
 //usage:     "\n       conv=fsync      Physically write data out before finishing"
 //usage:     "\n       conv=swab       Swap every pair of bytes"
+//usage:     "\n       iflag=skip_bytes        skip=N is in bytes"
 //usage:       )
 //usage:       IF_FEATURE_DD_STATUS(
 //usage:     "\n       status=noxfer   Suppress rate output"
@@ -90,6 +93,7 @@
 //usage:       "4+0 records out\n"
 
 #include "libbb.h"
+#include "common_bufsiz.h"
 
 /* This is a NOEXEC applet. Be very careful! */
 
@@ -99,25 +103,6 @@ enum {
        ofd = STDOUT_FILENO,
 };
 
-static const struct suffix_mult dd_suffixes[] = {
-       { "c", 1 },
-       { "w", 2 },
-       { "b", 512 },
-       { "kB", 1000 },
-       { "kD", 1000 },
-       { "k", 1024 },
-       { "K", 1024 },  /* compat with coreutils dd (it also accepts KB and KD, TODO?) */
-       { "MB", 1000000 },
-       { "MD", 1000000 },
-       { "M", 1024*1024 },
-       { "GB", 1000000000 },
-       { "GD", 1000000000 },
-       { "G", 1024*1024*1024 },
-       /* "D" suffix for decimal is not in coreutils manpage, looks like it's deprecated */
-       /* coreutils also understands TPEZY suffixes for tera- and so on, with B suffix for decimal */
-       { "", 0 }
-};
-
 struct globals {
        off_t out_full, out_part, in_full, in_part;
 #if ENABLE_FEATURE_DD_THIRD_STATUS_LINE
@@ -126,8 +111,9 @@ struct globals {
 #endif
        int flags;
 } FIX_ALIASING;
-#define G (*(struct globals*)&bb_common_bufsiz1)
+#define G (*(struct globals*)bb_common_bufsiz1)
 #define INIT_G() do { \
+       setup_common_bufsiz(); \
        /* we have to zero it out because of NOEXEC */ \
        memset(&G, 0, sizeof(G)); \
 } while (0)
@@ -141,11 +127,14 @@ enum {
        FLAG_FSYNC   = (1 << 3) * ENABLE_FEATURE_DD_IBS_OBS,
        FLAG_SWAB    = (1 << 4) * ENABLE_FEATURE_DD_IBS_OBS,
        /* end of conv flags */
-       FLAG_TWOBUFS = (1 << 5) * ENABLE_FEATURE_DD_IBS_OBS,
-       FLAG_COUNT   = 1 << 6,
-       FLAG_STATUS  = 1 << 7,
-       FLAG_STATUS_NONE = 1 << 7,
-       FLAG_STATUS_NOXFER = 1 << 8,
+       /* start of input flags */
+       FLAG_IFLAG_SHIFT = 5,
+       FLAG_SKIP_BYTES = (1 << 5) * ENABLE_FEATURE_DD_IBS_OBS,
+       /* end of input flags */
+       FLAG_TWOBUFS = (1 << 6) * ENABLE_FEATURE_DD_IBS_OBS,
+       FLAG_COUNT   = 1 << 7,
+       FLAG_STATUS_NONE = 1 << 8,
+       FLAG_STATUS_NOXFER = 1 << 9,
 };
 
 static void dd_output_status(int UNUSED_PARAM cur_signal)
@@ -222,18 +211,47 @@ static bool write_and_stats(const void *buf, size_t len, size_t obs,
 # define XATOU_SFX xatoul_sfx
 #endif
 
+#if ENABLE_FEATURE_DD_IBS_OBS
+static int parse_comma_flags(char *val, const char *words, const char *error_in)
+{
+       int flags = 0;
+       while (1) {
+               int n;
+               char *arg;
+               /* find ',', replace them with NUL so we can use val for
+                * index_in_strings() without copying.
+                * We rely on val being non-null, else strchr would fault.
+                */
+               arg = strchr(val, ',');
+               if (arg)
+                       *arg = '\0';
+               n = index_in_strings(words, val);
+               if (n < 0)
+                       bb_error_msg_and_die(bb_msg_invalid_arg_to, val, error_in);
+               flags |= (1 << n);
+               if (!arg) /* no ',' left, so this was the last specifier */
+                       break;
+               *arg = ','; /* to preserve ps listing */
+               val = arg + 1; /* skip this keyword and ',' */
+       }
+       return flags;
+}
+#endif
+
 int dd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 int dd_main(int argc UNUSED_PARAM, char **argv)
 {
        static const char keywords[] ALIGN1 =
                "bs\0""count\0""seek\0""skip\0""if\0""of\0"IF_FEATURE_DD_STATUS("status\0")
 #if ENABLE_FEATURE_DD_IBS_OBS
-               "ibs\0""obs\0""conv\0"
+               "ibs\0""obs\0""conv\0""iflag\0"
 #endif
                ;
 #if ENABLE_FEATURE_DD_IBS_OBS
        static const char conv_words[] ALIGN1 =
                "notrunc\0""sync\0""noerror\0""fsync\0""swab\0";
+       static const char iflag_words[] ALIGN1 =
+               "skip_bytes\0";
 #endif
 #if ENABLE_FEATURE_DD_STATUS
        static const char status_words[] ALIGN1 =
@@ -251,6 +269,7 @@ int dd_main(int argc UNUSED_PARAM, char **argv)
                OP_ibs,
                OP_obs,
                OP_conv,
+               OP_iflag,
                /* Must be in the same order as FLAG_XXX! */
                OP_conv_notrunc = 0,
                OP_conv_sync,
@@ -270,6 +289,7 @@ int dd_main(int argc UNUSED_PARAM, char **argv)
        //ibm           from ASCII to alternate EBCDIC
        /* Partially implemented: */
        //swab          swap every pair of input bytes: will abort on non-even reads
+               OP_iflag_skip_bytes,
 #endif
        };
        smallint exitcode = EXIT_FAILURE;
@@ -326,52 +346,39 @@ int dd_main(int argc UNUSED_PARAM, char **argv)
 #if ENABLE_FEATURE_DD_IBS_OBS
                if (what == OP_ibs) {
                        /* Must fit into positive ssize_t */
-                       ibs = xatoul_range_sfx(val, 1, ((size_t)-1L)/2, dd_suffixes);
+                       ibs = xatoul_range_sfx(val, 1, ((size_t)-1L)/2, cwbkMG_suffixes);
                        /*continue;*/
                }
                if (what == OP_obs) {
-                       obs = xatoul_range_sfx(val, 1, ((size_t)-1L)/2, dd_suffixes);
+                       obs = xatoul_range_sfx(val, 1, ((size_t)-1L)/2, cwbkMG_suffixes);
                        /*continue;*/
                }
                if (what == OP_conv) {
-                       while (1) {
-                               int n;
-                               /* find ',', replace them with NUL so we can use val for
-                                * index_in_strings() without copying.
-                                * We rely on val being non-null, else strchr would fault.
-                                */
-                               arg = strchr(val, ',');
-                               if (arg)
-                                       *arg = '\0';
-                               n = index_in_strings(conv_words, val);
-                               if (n < 0)
-                                       bb_error_msg_and_die(bb_msg_invalid_arg, val, "conv");
-                               G.flags |= (1 << n);
-                               if (!arg) /* no ',' left, so this was the last specifier */
-                                       break;
-                               /* *arg = ','; - to preserve ps listing? */
-                               val = arg + 1; /* skip this keyword and ',' */
-                       }
+                       G.flags |= parse_comma_flags(val, conv_words, "conv");
+                       /*continue;*/
+               }
+               if (what == OP_iflag) {
+                       G.flags |= parse_comma_flags(val, iflag_words, "iflag") << FLAG_IFLAG_SHIFT;
                        /*continue;*/
                }
 #endif
                if (what == OP_bs) {
-                       ibs = xatoul_range_sfx(val, 1, ((size_t)-1L)/2, dd_suffixes);
+                       ibs = xatoul_range_sfx(val, 1, ((size_t)-1L)/2, cwbkMG_suffixes);
                        obs = ibs;
                        /*continue;*/
                }
                /* These can be large: */
                if (what == OP_count) {
                        G.flags |= FLAG_COUNT;
-                       count = XATOU_SFX(val, dd_suffixes);
+                       count = XATOU_SFX(val, cwbkMG_suffixes);
                        /*continue;*/
                }
                if (what == OP_seek) {
-                       seek = XATOU_SFX(val, dd_suffixes);
+                       seek = XATOU_SFX(val, cwbkMG_suffixes);
                        /*continue;*/
                }
                if (what == OP_skip) {
-                       skip = XATOU_SFX(val, dd_suffixes);
+                       skip = XATOU_SFX(val, cwbkMG_suffixes);
                        /*continue;*/
                }
                if (what == OP_if) {
@@ -387,8 +394,8 @@ int dd_main(int argc UNUSED_PARAM, char **argv)
                        int n;
                        n = index_in_strings(status_words, val);
                        if (n < 0)
-                               bb_error_msg_and_die(bb_msg_invalid_arg, val, "status");
-                       G.flags |= FLAG_STATUS << n;
+                               bb_error_msg_and_die(bb_msg_invalid_arg_to, val, "status");
+                       G.flags |= FLAG_STATUS_NONE << n;
                        /*continue;*/
                }
 #endif
@@ -440,9 +447,10 @@ int dd_main(int argc UNUSED_PARAM, char **argv)
                outfile = bb_msg_standard_output;
        }
        if (skip) {
-               if (lseek(ifd, skip * ibs, SEEK_CUR) < 0) {
+               size_t blocksz = (G.flags & FLAG_SKIP_BYTES) ? 1 : ibs;
+               if (lseek(ifd, skip * blocksz, SEEK_CUR) < 0) {
                        do {
-                               ssize_t n = safe_read(ifd, ibuf, ibs);
+                               ssize_t n = safe_read(ifd, ibuf, blocksz);
                                if (n < 0)
                                        goto die_infile;
                                if (n == 0)
@@ -523,11 +531,11 @@ int dd_main(int argc UNUSED_PARAM, char **argv)
                        if (write_and_stats(ibuf, n, obs, outfile))
                                goto out_status;
                }
+       }
 
-               if (G.flags & FLAG_FSYNC) {
-                       if (fsync(ofd) < 0)
-                               goto die_outfile;
-               }
+       if (G.flags & FLAG_FSYNC) {
+               if (fsync(ofd) < 0)
+                       goto die_outfile;
        }
 
        if (ENABLE_FEATURE_DD_IBS_OBS && oc) {