bin/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$";
  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 __P((const void *, const void *));
  58 static int      c_conv __P((const void *, const void *));
  59 static void     f_bs __P((char *));
  60 static void     f_cbs __P((char *));
  61 static void     f_conv __P((char *));
  62 static void     f_count __P((char *));
  63 static void     f_files __P((char *));
  64 static void     f_ibs __P((char *));
  65 static void     f_if __P((char *));
  66 static void     f_obs __P((char *));
  67 static void     f_of __P((char *));
  68 static void     f_seek __P((char *));
  69 static void     f_skip __P((char *));
  70 static quad_t   get_num __P((char *));
  71 static off_t    get_offset __P((char *));
  72
  73 static const struct arg {
  74         const char *name;
  75         void (*f) __P((char *));
  76         u_int set, noset;
  77 } args[] = {
  78         { "bs",         f_bs,           C_BS,    C_BS|C_IBS|C_OBS|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_BS|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_BS|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(argv)
 100         char **argv;
 101 {
 102         struct arg *ap, tmp;
 103         char *arg;
 104
 105         in.dbsz = out.dbsz = 512;
 106
 107         while ((oper = *++argv) != NULL) {
 108                 if ((oper = strdup(oper)) == NULL)
 109                         errx(1, "unable to allocate space for the argument \"%s\"", *argv);
 110                 if ((arg = strchr(oper, '=')) == NULL)
 111                         errx(1, "unknown operand %s", oper);
 112                 *arg++ = '\0';
 113                 if (!*arg)
 114                         errx(1, "no value specified for %s", oper);
 115                 tmp.name = oper;
 116                 if (!(ap = (struct arg *)bsearch(&tmp, args,
 117                     sizeof(args)/sizeof(struct arg), sizeof(struct arg),
 118                     c_arg)))
 119                         errx(1, "unknown operand %s", tmp.name);
 120                 if (ddflags & ap->noset)
 121                         errx(1, "%s: illegal argument combination or already set",
 122                             tmp.name);
 123                 ddflags |= ap->set;
 124                 ap->f(arg);
 125         }
 126
 127         /* Final sanity checks. */
 128
 129         if (ddflags & C_BS) {
 130                 /*
 131                  * Bs is turned off by any conversion -- we assume the user
 132                  * just wanted to set both the input and output block sizes
 133                  * and didn't want the bs semantics, so we don't warn.
 134                  */
 135                 if (ddflags & (C_BLOCK|C_LCASE|C_SWAB|C_UCASE|C_UNBLOCK))
 136                         ddflags &= ~C_BS;
 137
 138                 /* Bs supersedes ibs and obs. */
 139                 if (ddflags & C_BS && ddflags & (C_IBS|C_OBS))
 140                         warnx("bs supersedes ibs and obs");
 141         }
 142
 143         /*
 144          * Ascii/ebcdic and cbs implies block/unblock.
 145          * Block/unblock requires cbs and vice-versa.
 146          */
 147         if (ddflags & (C_BLOCK | C_UNBLOCK)) {
 148                 if (!(ddflags & C_CBS))
 149                         errx(1, "record operations require cbs");
 150                 if (cbsz == 0)
 151                         errx(1, "cbs cannot be zero");
 152                 cfunc = ddflags & C_BLOCK ? block : unblock;
 153         } else if (ddflags & C_CBS) {
 154                 if (ddflags & (C_ASCII | C_EBCDIC)) {
 155                         if (ddflags & C_ASCII) {
 156                                 ddflags |= C_UNBLOCK;
 157                                 cfunc = unblock;
 158                         } else {
 159                                 ddflags |= C_BLOCK;
 160                                 cfunc = block;
 161                         }
 162                 } else
 163                         errx(1, "cbs meaningless if not doing record operations");
 164         } else
 165                 cfunc = def;
 166
 167         /*
 168          * Bail out if the calculation of a file offset would overflow.
 169          */
 170         if (in.offset > QUAD_MAX / in.dbsz || out.offset > QUAD_MAX / out.dbsz)
 171                 errx(1, "seek offsets cannot be larger than %qd", QUAD_MAX);
 172 }
 173
 174 static int
 175 c_arg(a, b)
 176         const void *a, *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(arg)
 185         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(arg)
 197         char *arg;
 198 {
 199         quad_t res;
 200
 201         res = get_num(arg);
 202         if (res < 1 || res > SSIZE_MAX)
 203                 errx(1, "cbs must be between 1 and %d", SSIZE_MAX);
 204         cbsz = (size_t)res;
 205 }
 206
 207 static void
 208 f_count(arg)
 209         char *arg;
 210 {
 211
 212         cpy_cnt = get_num(arg);
 213         if (cpy_cnt < 0)
 214                 errx(1, "count cannot be negative");
 215         if (cpy_cnt == 0)
 216                 cpy_cnt = -1;
 217 }
 218
 219 static void
 220 f_files(arg)
 221         char *arg;
 222 {
 223
 224         files_cnt = get_num(arg);
 225         if (files_cnt < 1)
 226                 errx(1, "files must be between 1 and %qd", QUAD_MAX);
 227 }
 228
 229 static void
 230 f_ibs(arg)
 231         char *arg;
 232 {
 233         quad_t res;
 234
 235         if (!(ddflags & C_BS)) {
 236                 res = get_num(arg);
 237                 if (res < 1 || res > SSIZE_MAX)
 238                         errx(1, "ibs must be between 1 and %d", SSIZE_MAX);
 239                 in.dbsz = (size_t)res;
 240         }
 241 }
 242
 243 static void
 244 f_if(arg)
 245         char *arg;
 246 {
 247
 248         in.name = arg;
 249 }
 250
 251 static void
 252 f_obs(arg)
 253         char *arg;
 254 {
 255         quad_t res;
 256
 257         if (!(ddflags & C_BS)) {
 258                 res = get_num(arg);
 259                 if (res < 1 || res > SSIZE_MAX)
 260                         errx(1, "obs must be between 1 and %d", SSIZE_MAX);
 261                 out.dbsz = (size_t)res;
 262         }
 263 }
 264
 265 static void
 266 f_of(arg)
 267         char *arg;
 268 {
 269
 270         out.name = arg;
 271 }
 272
 273 static void
 274 f_seek(arg)
 275         char *arg;
 276 {
 277
 278         out.offset = get_offset(arg);
 279 }
 280
 281 static void
 282 f_skip(arg)
 283         char *arg;
 284 {
 285
 286         in.offset = get_offset(arg);
 287 }
 288
 289 static const struct conv {
 290         const char *name;
 291         u_int set, noset;
 292         const u_char *ctab;
 293 } clist[] = {
 294         { "ascii",      C_ASCII,        C_EBCDIC,       e2a_POSIX },
 295         { "block",      C_BLOCK,        C_UNBLOCK,      NULL },
 296         { "ebcdic",     C_EBCDIC,       C_ASCII,        a2e_POSIX },
 297         { "ibm",        C_EBCDIC,       C_ASCII,        a2ibm_POSIX },
 298         { "lcase",      C_LCASE,        C_UCASE,        NULL },
 299         { "noerror",    C_NOERROR,      0,              NULL },
 300         { "notrunc",    C_NOTRUNC,      0,              NULL },
 301         { "oldascii",   C_ASCII,        C_EBCDIC,       e2a_32V },
 302         { "oldebcdic",  C_EBCDIC,       C_ASCII,        a2e_32V },
 303         { "oldibm",     C_EBCDIC,       C_ASCII,        a2ibm_32V },
 304         { "osync",      C_OSYNC,        C_BS,           NULL },
 305         { "sparse",     C_SPARSE,       0,              NULL },
 306         { "swab",       C_SWAB,         0,              NULL },
 307         { "sync",       C_SYNC,         0,              NULL },
 308         { "ucase",      C_UCASE,        C_LCASE,        NULL },
 309         { "unblock",    C_UNBLOCK,      C_BLOCK,        NULL },
 310 };
 311
 312 static void
 313 f_conv(arg)
 314         char *arg;
 315 {
 316         struct conv *cp, tmp;
 317
 318         while (arg != NULL) {
 319                 tmp.name = strsep(&arg, ",");
 320                 cp = bsearch(&tmp, clist, sizeof(clist) / sizeof(struct conv),
 321                     sizeof(struct conv), c_conv);
 322                 if (cp == NULL)
 323                         errx(1, "unknown conversion %s", tmp.name);
 324                 if (ddflags & cp->noset)
 325                         errx(1, "%s: illegal conversion combination", tmp.name);
 326                 ddflags |= cp->set;
 327                 if (cp->ctab)
 328                         ctab = cp->ctab;
 329         }
 330 }
 331
 332 static int
 333 c_conv(a, b)
 334         const void *a, *b;
 335 {
 336
 337         return (strcmp(((const struct conv *)a)->name,
 338             ((const struct conv *)b)->name));
 339 }
 340
 341 /*
 342  * Convert an expression of the following forms to a quad_t.
 343  *      1) A positive decimal number.
 344  *      2) A positive decimal number followed by a b (mult by 512.)
 345  *      3) A positive decimal number followed by a k (mult by 1 << 10.)
 346  *      4) A positive decimal number followed by a m (mult by 1 << 20.)
 347  *      5) A positive decimal number followed by a g (mult by 1 << 30.)
 348  *      5) A positive decimal number followed by a w (mult by sizeof int.)
 349  *      6) Two or more positive decimal numbers (with/without [bkmgw])
 350  *         separated by x (also * for backwards compatibility), specifying
 351  *         the product of the indicated values.
 352  */
 353 static quad_t
 354 get_num(val)
 355         char *val;
 356 {
 357         quad_t num, t;
 358         char *expr;
 359
 360         errno = 0;
 361         num = strtoq(val, &expr, 0);
 362         if (errno != 0)                         /* Overflow or underflow. */
 363                 err(1, "%s", oper);
 364
 365         if (expr == val)                        /* No valid digits. */
 366                 errx(1, "%s: illegal numeric value", oper);
 367
 368         switch (*expr) {
 369         case 'b':
 370                 t = num;
 371                 num *= 512;
 372                 if (t > num)
 373                         goto erange;
 374                 ++expr;
 375                 break;
 376         case 'k':
 377                 t = num;
 378                 num *= 1 << 10;
 379                 if (t > num)
 380                         goto erange;
 381                 ++expr;
 382                 break;
 383         case 'm':
 384                 t = num;
 385                 num *= 1 << 20;
 386                 if (t > num)
 387                         goto erange;
 388                 ++expr;
 389                 break;
 390         case 'g':
 391                 t = num;
 392                 num *= 1 << 30;
 393                 if (t > num)
 394                         goto erange;
 395                 ++expr;
 396                 break;
 397         case 'w':
 398                 t = num;
 399                 num *= sizeof(int);
 400                 if (t > num)
 401                         goto erange;
 402                 ++expr;
 403                 break;
 404         }
 405
 406         switch (*expr) {
 407                 case '\0':
 408                         break;
 409                 case '*':                       /* Backward compatible. */
 410                 case 'x':
 411                         t = num;
 412                         num *= get_num(expr + 1);
 413                         if (t <= num)
 414                                 break;
 415 erange:
 416                         errx(1, "%s: %s", oper, strerror(ERANGE));
 417                 default:
 418                         errx(1, "%s: illegal numeric value", oper);
 419         }
 420         return (num);
 421 }
 422
 423 static off_t
 424 get_offset(val)
 425         char *val;
 426 {
 427         quad_t num;
 428
 429         num = get_num(val);
 430         if (num > QUAD_MAX || num < 0)          /* XXX quad_t != off_t */
 431                 errx(1, "%s: illegal offset", oper);    /* Too big/negative. */
 432         return ((off_t)num);
 433 }