bin/dd/args.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1991, 1993, 1994
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Keith Muller of the University of California, San Diego and Lance
   9  * Visser of Convex Computer Corporation.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 #ifndef lint
  37 #if 0
  38 static char sccsid[] = "@(#)args.c      8.3 (Berkeley) 4/2/94";
  39 #endif
  40 #endif /* not lint */
  41 #include <sys/cdefs.h>
  42 __FBSDID("$FreeBSD$");
  43
  44 #include <sys/types.h>
  45
  46 #include <ctype.h>
  47 #include <err.h>
  48 #include <errno.h>
  49 #include <inttypes.h>
  50 #include <limits.h>
  51 #include <signal.h>
  52 #include <stdlib.h>
  53 #include <string.h>
  54
  55 #include "dd.h"
  56 #include "extern.h"
  57
  58 static int      c_arg(const void *, const void *);
  59 static int      c_conv(const void *, const void *);
  60 static void     f_bs(char *);
  61 static void     f_cbs(char *);
  62 static void     f_conv(char *);
  63 static void     f_count(char *);
  64 static void     f_files(char *);
  65 static void     f_fillchar(char *);
  66 static void     f_ibs(char *);
  67 static void     f_if(char *);
  68 static void     f_obs(char *);
  69 static void     f_of(char *);
  70 static void     f_seek(char *);
  71 static void     f_skip(char *);
  72 static void     f_speed(char *);
  73 static void     f_status(char *);
  74 static uintmax_t get_num(const char *);
  75 static off_t    get_off_t(const char *);
  76
  77 static const struct arg {
  78         const char *name;
  79         void (*f)(char *);
  80         u_int set, noset;
  81 } args[] = {
  82         { "bs",         f_bs,           C_BS,    C_BS|C_IBS|C_OBS|C_OSYNC },
  83         { "cbs",        f_cbs,          C_CBS,   C_CBS },
  84         { "conv",       f_conv,         0,       0 },
  85         { "count",      f_count,        C_COUNT, C_COUNT },
  86         { "files",      f_files,        C_FILES, C_FILES },
  87         { "fillchar",   f_fillchar,     C_FILL,  C_FILL },
  88         { "ibs",        f_ibs,          C_IBS,   C_BS|C_IBS },
  89         { "if",         f_if,           C_IF,    C_IF },
  90         { "iseek",      f_skip,         C_SKIP,  C_SKIP },
  91         { "obs",        f_obs,          C_OBS,   C_BS|C_OBS },
  92         { "of",         f_of,           C_OF,    C_OF },
  93         { "oseek",      f_seek,         C_SEEK,  C_SEEK },
  94         { "seek",       f_seek,         C_SEEK,  C_SEEK },
  95         { "skip",       f_skip,         C_SKIP,  C_SKIP },
  96         { "speed",      f_speed,        0,       0 },
  97         { "status",     f_status,       C_STATUS,C_STATUS },
  98 };
  99
 100 static char *oper;
 101
 102 /*
 103  * args -- parse JCL syntax of dd.
 104  */
 105 void
 106 jcl(char **argv)
 107 {
 108         struct arg *ap, tmp;
 109         char *arg;
 110
 111         in.dbsz = out.dbsz = 512;
 112
 113         while ((oper = *++argv) != NULL) {
 114                 if ((oper = strdup(oper)) == NULL)
 115                         errx(1, "unable to allocate space for the argument \"%s\"", *argv);
 116                 if ((arg = strchr(oper, '=')) == NULL)
 117                         errx(1, "unknown operand %s", oper);
 118                 *arg++ = '\0';
 119                 if (!*arg)
 120                         errx(1, "no value specified for %s", oper);
 121                 tmp.name = oper;
 122                 if (!(ap = (struct arg *)bsearch(&tmp, args,
 123                     sizeof(args)/sizeof(struct arg), sizeof(struct arg),
 124                     c_arg)))
 125                         errx(1, "unknown operand %s", tmp.name);
 126                 if (ddflags & ap->noset)
 127                         errx(1, "%s: illegal argument combination or already set",
 128                             tmp.name);
 129                 ddflags |= ap->set;
 130                 ap->f(arg);
 131         }
 132
 133         /* Final sanity checks. */
 134
 135         if (ddflags & C_BS) {
 136                 /*
 137                  * Bs is turned off by any conversion -- we assume the user
 138                  * just wanted to set both the input and output block sizes
 139                  * and didn't want the bs semantics, so we don't warn.
 140                  */
 141                 if (ddflags & (C_BLOCK | C_LCASE | C_SWAB | C_UCASE |
 142                     C_UNBLOCK))
 143                         ddflags &= ~C_BS;
 144
 145                 /* Bs supersedes ibs and obs. */
 146                 if (ddflags & C_BS && ddflags & (C_IBS | C_OBS))
 147                         warnx("bs supersedes ibs and obs");
 148         }
 149
 150         /*
 151          * Ascii/ebcdic and cbs implies block/unblock.
 152          * Block/unblock requires cbs and vice-versa.
 153          */
 154         if (ddflags & (C_BLOCK | C_UNBLOCK)) {
 155                 if (!(ddflags & C_CBS))
 156                         errx(1, "record operations require cbs");
 157                 if (cbsz == 0)
 158                         errx(1, "cbs cannot be zero");
 159                 cfunc = ddflags & C_BLOCK ? block : unblock;
 160         } else if (ddflags & C_CBS) {
 161                 if (ddflags & (C_ASCII | C_EBCDIC)) {
 162                         if (ddflags & C_ASCII) {
 163                                 ddflags |= C_UNBLOCK;
 164                                 cfunc = unblock;
 165                         } else {
 166                                 ddflags |= C_BLOCK;
 167                                 cfunc = block;
 168                         }
 169                 } else
 170                         errx(1, "cbs meaningless if not doing record operations");
 171         } else
 172                 cfunc = def;
 173 }
 174
 175 static int
 176 c_arg(const void *a, const void *b)
 177 {
 178
 179         return (strcmp(((const struct arg *)a)->name,
 180             ((const struct arg *)b)->name));
 181 }
 182
 183 static void
 184 f_bs(char *arg)
 185 {
 186         uintmax_t res;
 187
 188         res = get_num(arg);
 189         if (res < 1 || res > SSIZE_MAX)
 190                 errx(1, "bs must be between 1 and %zd", (ssize_t)SSIZE_MAX);
 191         in.dbsz = out.dbsz = (size_t)res;
 192 }
 193
 194 static void
 195 f_cbs(char *arg)
 196 {
 197         uintmax_t res;
 198
 199         res = get_num(arg);
 200         if (res < 1 || res > SSIZE_MAX)
 201                 errx(1, "cbs must be between 1 and %zd", (ssize_t)SSIZE_MAX);
 202         cbsz = (size_t)res;
 203 }
 204
 205 static void
 206 f_count(char *arg)
 207 {
 208         uintmax_t res;
 209
 210         res = get_num(arg);
 211         if (res == UINTMAX_MAX)
 212                 errc(1, ERANGE, "%s", oper);
 213         if (res == 0)
 214                 cpy_cnt = UINTMAX_MAX;
 215         else
 216                 cpy_cnt = res;
 217 }
 218
 219 static void
 220 f_files(char *arg)
 221 {
 222
 223         files_cnt = get_num(arg);
 224         if (files_cnt < 1)
 225                 errx(1, "files must be between 1 and %zu", SIZE_MAX);
 226 }
 227
 228 static void
 229 f_fillchar(char *arg)
 230 {
 231
 232         if (strlen(arg) != 1)
 233                 errx(1, "need exactly one fill char");
 234
 235         fill_char = arg[0];
 236 }
 237
 238 static void
 239 f_ibs(char *arg)
 240 {
 241         uintmax_t res;
 242
 243         if (!(ddflags & C_BS)) {
 244                 res = get_num(arg);
 245                 if (res < 1 || res > SSIZE_MAX)
 246                         errx(1, "ibs must be between 1 and %zd",
 247                             (ssize_t)SSIZE_MAX);
 248                 in.dbsz = (size_t)res;
 249         }
 250 }
 251
 252 static void
 253 f_if(char *arg)
 254 {
 255
 256         in.name = arg;
 257 }
 258
 259 static void
 260 f_obs(char *arg)
 261 {
 262         uintmax_t res;
 263
 264         if (!(ddflags & C_BS)) {
 265                 res = get_num(arg);
 266                 if (res < 1 || res > SSIZE_MAX)
 267                         errx(1, "obs must be between 1 and %zd",
 268                             (ssize_t)SSIZE_MAX);
 269                 out.dbsz = (size_t)res;
 270         }
 271 }
 272
 273 static void
 274 f_of(char *arg)
 275 {
 276
 277         out.name = arg;
 278 }
 279
 280 static void
 281 f_seek(char *arg)
 282 {
 283
 284         out.offset = get_off_t(arg);
 285 }
 286
 287 static void
 288 f_skip(char *arg)
 289 {
 290
 291         in.offset = get_off_t(arg);
 292 }
 293
 294 static void
 295 f_speed(char *arg)
 296 {
 297
 298         speed = get_num(arg);
 299 }
 300
 301 static void
 302 f_status(char *arg)
 303 {
 304
 305         if (strcmp(arg, "none") == 0)
 306                 ddflags |= C_NOINFO;
 307         else if (strcmp(arg, "noxfer") == 0)
 308                 ddflags |= C_NOXFER;
 309         else if (strcmp(arg, "progress") == 0)
 310                 ddflags |= C_PROGRESS;
 311         else
 312                 errx(1, "unknown status %s", arg);
 313 }
 314
 315 static const struct conv {
 316         const char *name;
 317         u_int set, noset;
 318         const u_char *ctab;
 319 } clist[] = {
 320         { "ascii",      C_ASCII,        C_EBCDIC,       e2a_POSIX },
 321         { "block",      C_BLOCK,        C_UNBLOCK,      NULL },
 322         { "ebcdic",     C_EBCDIC,       C_ASCII,        a2e_POSIX },
 323         { "fsync",      C_FSYNC,        0,              NULL },
 324         { "ibm",        C_EBCDIC,       C_ASCII,        a2ibm_POSIX },
 325         { "lcase",      C_LCASE,        C_UCASE,        NULL },
 326         { "noerror",    C_NOERROR,      0,              NULL },
 327         { "notrunc",    C_NOTRUNC,      0,              NULL },
 328         { "oldascii",   C_ASCII,        C_EBCDIC,       e2a_32V },
 329         { "oldebcdic",  C_EBCDIC,       C_ASCII,        a2e_32V },
 330         { "oldibm",     C_EBCDIC,       C_ASCII,        a2ibm_32V },
 331         { "osync",      C_OSYNC,        C_BS,           NULL },
 332         { "pareven",    C_PAREVEN,      C_PARODD|C_PARSET|C_PARNONE, NULL},
 333         { "parnone",    C_PARNONE,      C_PARODD|C_PARSET|C_PAREVEN, NULL},
 334         { "parodd",     C_PARODD,       C_PAREVEN|C_PARSET|C_PARNONE, NULL},
 335         { "parset",     C_PARSET,       C_PARODD|C_PAREVEN|C_PARNONE, NULL},
 336         { "sparse",     C_SPARSE,       0,              NULL },
 337         { "swab",       C_SWAB,         0,              NULL },
 338         { "sync",       C_SYNC,         0,              NULL },
 339         { "ucase",      C_UCASE,        C_LCASE,        NULL },
 340         { "unblock",    C_UNBLOCK,      C_BLOCK,        NULL },
 341 };
 342
 343 static void
 344 f_conv(char *arg)
 345 {
 346         struct conv *cp, tmp;
 347
 348         while (arg != NULL) {
 349                 tmp.name = strsep(&arg, ",");
 350                 cp = bsearch(&tmp, clist, sizeof(clist) / sizeof(struct conv),
 351                     sizeof(struct conv), c_conv);
 352                 if (cp == NULL)
 353                         errx(1, "unknown conversion %s", tmp.name);
 354                 if (ddflags & cp->noset)
 355                         errx(1, "%s: illegal conversion combination", tmp.name);
 356                 ddflags |= cp->set;
 357                 if (cp->ctab)
 358                         ctab = cp->ctab;
 359         }
 360 }
 361
 362 static int
 363 c_conv(const void *a, const void *b)
 364 {
 365
 366         return (strcmp(((const struct conv *)a)->name,
 367             ((const struct conv *)b)->name));
 368 }
 369
 370 static intmax_t
 371 postfix_to_mult(const char expr)
 372 {
 373         intmax_t mult;
 374
 375         mult = 0;
 376         switch (expr) {
 377         case 'B':
 378         case 'b':
 379                 mult = 512;
 380                 break;
 381         case 'K':
 382         case 'k':
 383                 mult = 1 << 10;
 384                 break;
 385         case 'M':
 386         case 'm':
 387                 mult = 1 << 20;
 388                 break;
 389         case 'G':
 390         case 'g':
 391                 mult = 1 << 30;
 392                 break;
 393         case 'T':
 394         case 't':
 395                 mult = (uintmax_t)1 << 40;
 396                 break;
 397         case 'P':
 398         case 'p':
 399                 mult = (uintmax_t)1 << 50;
 400                 break;
 401         case 'W':
 402         case 'w':
 403                 mult = sizeof(int);
 404                 break;
 405         }
 406
 407         return (mult);
 408 }
 409
 410 /*
 411  * Convert an expression of the following forms to a uintmax_t.
 412  *      1) A positive decimal number.
 413  *      2) A positive decimal number followed by a 'b' or 'B' (mult by 512).
 414  *      3) A positive decimal number followed by a 'k' or 'K' (mult by 1 << 10).
 415  *      4) A positive decimal number followed by a 'm' or 'M' (mult by 1 << 20).
 416  *      5) A positive decimal number followed by a 'g' or 'G' (mult by 1 << 30).
 417  *      6) A positive decimal number followed by a 't' or 'T' (mult by 1 << 40).
 418  *      7) A positive decimal number followed by a 'p' or 'P' (mult by 1 << 50).
 419  *      8) A positive decimal number followed by a 'w' or 'W' (mult by sizeof int).
 420  *      9) Two or more positive decimal numbers (with/without [BbKkMmGgWw])
 421  *         separated by 'x' or 'X' (also '*' for backwards compatibility),
 422  *         specifying the product of the indicated values.
 423  */
 424 static uintmax_t
 425 get_num(const char *val)
 426 {
 427         uintmax_t num, mult, prevnum;
 428         char *expr;
 429
 430         errno = 0;
 431         num = strtoumax(val, &expr, 0);
 432         if (expr == val)                        /* No valid digits. */
 433                 errx(1, "%s: invalid numeric value", oper);
 434         if (errno != 0)
 435                 err(1, "%s", oper);
 436
 437         mult = postfix_to_mult(*expr);
 438
 439         if (mult != 0) {
 440                 prevnum = num;
 441                 num *= mult;
 442                 /* Check for overflow. */
 443                 if (num / mult != prevnum)
 444                         goto erange;
 445                 expr++;
 446         }
 447
 448         switch (*expr) {
 449                 case '\0':
 450                         break;
 451                 case '*':                       /* Backward compatible. */
 452                 case 'X':
 453                 case 'x':
 454                         mult = get_num(expr + 1);
 455                         prevnum = num;
 456                         num *= mult;
 457                         if (num / mult == prevnum)
 458                                 break;
 459 erange:
 460                         errx(1, "%s: %s", oper, strerror(ERANGE));
 461                 default:
 462                         errx(1, "%s: illegal numeric value", oper);
 463         }
 464         return (num);
 465 }
 466
 467 /*
 468  * Convert an expression of the following forms to an off_t.  This is the
 469  * same as get_num(), but it uses signed numbers.
 470  *
 471  * The major problem here is that an off_t may not necessarily be a intmax_t.
 472  */
 473 static off_t
 474 get_off_t(const char *val)
 475 {
 476         intmax_t num, mult, prevnum;
 477         char *expr;
 478
 479         errno = 0;
 480         num = strtoimax(val, &expr, 0);
 481         if (expr == val)                        /* No valid digits. */
 482                 errx(1, "%s: invalid numeric value", oper);
 483         if (errno != 0)
 484                 err(1, "%s", oper);
 485
 486         mult = postfix_to_mult(*expr);
 487
 488         if (mult != 0) {
 489                 prevnum = num;
 490                 num *= mult;
 491                 /* Check for overflow. */
 492                 if ((prevnum > 0) != (num > 0) || num / mult != prevnum)
 493                         goto erange;
 494                 expr++;
 495         }
 496
 497         switch (*expr) {
 498                 case '\0':
 499                         break;
 500                 case '*':                       /* Backward compatible. */
 501                 case 'X':
 502                 case 'x':
 503                         mult = (intmax_t)get_off_t(expr + 1);
 504                         prevnum = num;
 505                         num *= mult;
 506                         if ((prevnum > 0) == (num > 0) && num / mult == prevnum)
 507                                 break;
 508 erange:
 509                         errx(1, "%s: %s", oper, strerror(ERANGE));
 510                 default:
 511                         errx(1, "%s: illegal numeric value", oper);
 512         }
 513         return (num);
 514 }