dd/args.c

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