xref: /freebsd/bin/dd/args.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
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 #include <sys/param.h>
43 
44 #include <ctype.h>
45 #include <err.h>
46 #include <errno.h>
47 #include <inttypes.h>
48 #include <limits.h>
49 #include <signal.h>
50 #include <stdlib.h>
51 #include <string.h>
52 
53 #include "dd.h"
54 #include "extern.h"
55 
56 static int	c_arg(const void *, const void *);
57 static int	c_conv(const void *, const void *);
58 static int	c_iflag(const void *, const void *);
59 static int	c_oflag(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_iflag(char *);
69 static void	f_obs(char *);
70 static void	f_of(char *);
71 static void	f_oflag(char *);
72 static void	f_seek(char *);
73 static void	f_skip(char *);
74 static void	f_speed(char *);
75 static void	f_status(char *);
76 static uintmax_t get_num(const char *);
77 static off_t	get_off_t(const char *);
78 
79 static const struct arg {
80 	const char *name;
81 	void (*f)(char *);
82 	uint64_t set, noset;
83 } args[] = {
84 	{ "bs",		f_bs,		C_BS,	 C_BS|C_IBS|C_OBS|C_OSYNC },
85 	{ "cbs",	f_cbs,		C_CBS,	 C_CBS },
86 	{ "conv",	f_conv,		0,	 0 },
87 	{ "count",	f_count,	C_COUNT, C_COUNT },
88 	{ "files",	f_files,	C_FILES, C_FILES },
89 	{ "fillchar",	f_fillchar,	C_FILL,	 C_FILL },
90 	{ "ibs",	f_ibs,		C_IBS,	 C_BS|C_IBS },
91 	{ "if",		f_if,		C_IF,	 C_IF },
92 	{ "iflag",	f_iflag,	0,	 0 },
93 	{ "iseek",	f_skip,		C_SKIP,	 C_SKIP },
94 	{ "obs",	f_obs,		C_OBS,	 C_BS|C_OBS },
95 	{ "of",		f_of,		C_OF,	 C_OF },
96 	{ "oflag",	f_oflag,	0,	 0 },
97 	{ "oseek",	f_seek,		C_SEEK,	 C_SEEK },
98 	{ "seek",	f_seek,		C_SEEK,	 C_SEEK },
99 	{ "skip",	f_skip,		C_SKIP,	 C_SKIP },
100 	{ "speed",	f_speed,	0,	 0 },
101 	{ "status",	f_status,	C_STATUS,C_STATUS },
102 };
103 
104 static char *oper;
105 
106 /*
107  * args -- parse JCL syntax of dd.
108  */
109 void
110 jcl(char **argv)
111 {
112 	struct arg *ap, tmp;
113 	char *arg;
114 
115 	in.dbsz = out.dbsz = 512;
116 
117 	while ((oper = *++argv) != NULL) {
118 		if ((oper = strdup(oper)) == NULL)
119 			errx(1, "unable to allocate space for the argument \"%s\"", *argv);
120 		if ((arg = strchr(oper, '=')) == NULL)
121 			errx(1, "unknown operand %s", oper);
122 		*arg++ = '\0';
123 		if (!*arg)
124 			errx(1, "no value specified for %s", oper);
125 		tmp.name = oper;
126 		if (!(ap = (struct arg *)bsearch(&tmp, args,
127 		    sizeof(args)/sizeof(struct arg), sizeof(struct arg),
128 		    c_arg)))
129 			errx(1, "unknown operand %s", tmp.name);
130 		if (ddflags & ap->noset)
131 			errx(1, "%s: illegal argument combination or already set",
132 			    tmp.name);
133 		ddflags |= ap->set;
134 		ap->f(arg);
135 	}
136 
137 	/* Final sanity checks. */
138 
139 	if (ddflags & C_BS) {
140 		/*
141 		 * Bs is turned off by any conversion -- we assume the user
142 		 * just wanted to set both the input and output block sizes
143 		 * and didn't want the bs semantics, so we don't warn.
144 		 */
145 		if (ddflags & (C_BLOCK | C_LCASE | C_SWAB | C_UCASE |
146 		    C_UNBLOCK))
147 			ddflags &= ~C_BS;
148 
149 		/* Bs supersedes ibs and obs. */
150 		if (ddflags & C_BS && ddflags & (C_IBS | C_OBS))
151 			warnx("bs supersedes ibs and obs");
152 	}
153 
154 	/*
155 	 * Ascii/ebcdic and cbs implies block/unblock.
156 	 * Block/unblock requires cbs and vice-versa.
157 	 */
158 	if (ddflags & (C_BLOCK | C_UNBLOCK)) {
159 		if (!(ddflags & C_CBS))
160 			errx(1, "record operations require cbs");
161 		if (cbsz == 0)
162 			errx(1, "cbs cannot be zero");
163 		cfunc = ddflags & C_BLOCK ? block : unblock;
164 	} else if (ddflags & C_CBS) {
165 		if (ddflags & (C_ASCII | C_EBCDIC)) {
166 			if (ddflags & C_ASCII) {
167 				ddflags |= C_UNBLOCK;
168 				cfunc = unblock;
169 			} else {
170 				ddflags |= C_BLOCK;
171 				cfunc = block;
172 			}
173 		} else
174 			errx(1, "cbs meaningless if not doing record operations");
175 	} else
176 		cfunc = def;
177 }
178 
179 static int
180 c_arg(const void *a, const void *b)
181 {
182 
183 	return (strcmp(((const struct arg *)a)->name,
184 	    ((const struct arg *)b)->name));
185 }
186 
187 static void
188 f_bs(char *arg)
189 {
190 	uintmax_t res;
191 
192 	res = get_num(arg);
193 	if (res < 1 || res > SSIZE_MAX)
194 		errx(1, "bs must be between 1 and %zd", (ssize_t)SSIZE_MAX);
195 	in.dbsz = out.dbsz = (size_t)res;
196 }
197 
198 static void
199 f_cbs(char *arg)
200 {
201 	uintmax_t res;
202 
203 	res = get_num(arg);
204 	if (res < 1 || res > SSIZE_MAX)
205 		errx(1, "cbs must be between 1 and %zd", (ssize_t)SSIZE_MAX);
206 	cbsz = (size_t)res;
207 }
208 
209 static void
210 f_count(char *arg)
211 {
212 	uintmax_t res;
213 
214 	res = get_num(arg);
215 	if (res == UINTMAX_MAX)
216 		errc(1, ERANGE, "%s", oper);
217 	if (res == 0)
218 		cpy_cnt = UINTMAX_MAX;
219 	else
220 		cpy_cnt = res;
221 }
222 
223 static void
224 f_files(char *arg)
225 {
226 
227 	files_cnt = get_num(arg);
228 	if (files_cnt < 1)
229 		errx(1, "files must be between 1 and %zu", SIZE_MAX);
230 }
231 
232 static void
233 f_fillchar(char *arg)
234 {
235 
236 	if (strlen(arg) != 1)
237 		errx(1, "need exactly one fill char");
238 
239 	fill_char = arg[0];
240 }
241 
242 static void
243 f_ibs(char *arg)
244 {
245 	uintmax_t res;
246 
247 	if (!(ddflags & C_BS)) {
248 		res = get_num(arg);
249 		if (res < 1 || res > SSIZE_MAX)
250 			errx(1, "ibs must be between 1 and %zd",
251 			    (ssize_t)SSIZE_MAX);
252 		in.dbsz = (size_t)res;
253 	}
254 }
255 
256 static void
257 f_if(char *arg)
258 {
259 
260 	in.name = arg;
261 }
262 
263 static const struct iflag {
264 	const char *name;
265 	uint64_t set, noset;
266 } ilist[] = {
267 	{ "direct",	C_IDIRECT,	0 },
268 	{ "fullblock",	C_IFULLBLOCK,	C_SYNC },
269 };
270 
271 static void
272 f_iflag(char *arg)
273 {
274 	struct iflag *ip, tmp;
275 
276 	while (arg != NULL) {
277 		tmp.name = strsep(&arg, ",");
278 		ip = bsearch(&tmp, ilist, nitems(ilist), sizeof(struct iflag),
279 		    c_iflag);
280 		if (ip == NULL)
281 			errx(1, "unknown iflag %s", tmp.name);
282 		if (ddflags & ip->noset)
283 			errx(1, "%s: illegal conversion combination", tmp.name);
284 		ddflags |= ip->set;
285 	}
286 }
287 
288 static int
289 c_iflag(const void *a, const void *b)
290 {
291 
292 	return (strcmp(((const struct iflag *)a)->name,
293 	    ((const struct iflag *)b)->name));
294 }
295 
296 static void
297 f_obs(char *arg)
298 {
299 	uintmax_t res;
300 
301 	if (!(ddflags & C_BS)) {
302 		res = get_num(arg);
303 		if (res < 1 || res > SSIZE_MAX)
304 			errx(1, "obs must be between 1 and %zd",
305 			    (ssize_t)SSIZE_MAX);
306 		out.dbsz = (size_t)res;
307 	}
308 }
309 
310 static void
311 f_of(char *arg)
312 {
313 
314 	out.name = arg;
315 }
316 
317 static void
318 f_seek(char *arg)
319 {
320 
321 	out.offset = get_off_t(arg);
322 }
323 
324 static void
325 f_skip(char *arg)
326 {
327 
328 	in.offset = get_off_t(arg);
329 }
330 
331 static void
332 f_speed(char *arg)
333 {
334 
335 	speed = get_num(arg);
336 }
337 
338 static void
339 f_status(char *arg)
340 {
341 
342 	if (strcmp(arg, "none") == 0)
343 		ddflags |= C_NOINFO;
344 	else if (strcmp(arg, "noxfer") == 0)
345 		ddflags |= C_NOXFER;
346 	else if (strcmp(arg, "progress") == 0)
347 		ddflags |= C_PROGRESS;
348 	else
349 		errx(1, "unknown status %s", arg);
350 }
351 
352 static const struct conv {
353 	const char *name;
354 	uint64_t set, noset;
355 	const u_char *ctab;
356 } clist[] = {
357 	{ "ascii",	C_ASCII,	C_EBCDIC,	e2a_POSIX },
358 	{ "block",	C_BLOCK,	C_UNBLOCK,	NULL },
359 	{ "ebcdic",	C_EBCDIC,	C_ASCII,	a2e_POSIX },
360 	{ "fdatasync",	C_FDATASYNC,	0,		NULL },
361 	{ "fsync",	C_FSYNC,	0,		NULL },
362 	{ "ibm",	C_EBCDIC,	C_ASCII,	a2ibm_POSIX },
363 	{ "lcase",	C_LCASE,	C_UCASE,	NULL },
364 	{ "noerror",	C_NOERROR,	0,		NULL },
365 	{ "notrunc",	C_NOTRUNC,	0,		NULL },
366 	{ "oldascii",	C_ASCII,	C_EBCDIC,	e2a_32V },
367 	{ "oldebcdic",	C_EBCDIC,	C_ASCII,	a2e_32V },
368 	{ "oldibm",	C_EBCDIC,	C_ASCII,	a2ibm_32V },
369 	{ "osync",	C_OSYNC,	C_BS,		NULL },
370 	{ "pareven",	C_PAREVEN,	C_PARODD|C_PARSET|C_PARNONE, NULL},
371 	{ "parnone",	C_PARNONE,	C_PARODD|C_PARSET|C_PAREVEN, NULL},
372 	{ "parodd",	C_PARODD,	C_PAREVEN|C_PARSET|C_PARNONE, NULL},
373 	{ "parset",	C_PARSET,	C_PARODD|C_PAREVEN|C_PARNONE, NULL},
374 	{ "sparse",	C_SPARSE,	0,		NULL },
375 	{ "swab",	C_SWAB,		0,		NULL },
376 	{ "sync",	C_SYNC,		C_IFULLBLOCK,	NULL },
377 	{ "ucase",	C_UCASE,	C_LCASE,	NULL },
378 	{ "unblock",	C_UNBLOCK,	C_BLOCK,	NULL },
379 };
380 
381 static void
382 f_conv(char *arg)
383 {
384 	struct conv *cp, tmp;
385 
386 	while (arg != NULL) {
387 		tmp.name = strsep(&arg, ",");
388 		cp = bsearch(&tmp, clist, nitems(clist), sizeof(struct conv),
389 		    c_conv);
390 		if (cp == NULL)
391 			errx(1, "unknown conversion %s", tmp.name);
392 		if (ddflags & cp->noset)
393 			errx(1, "%s: illegal conversion combination", tmp.name);
394 		ddflags |= cp->set;
395 		if (cp->ctab)
396 			ctab = cp->ctab;
397 	}
398 }
399 
400 static int
401 c_conv(const void *a, const void *b)
402 {
403 
404 	return (strcmp(((const struct conv *)a)->name,
405 	    ((const struct conv *)b)->name));
406 }
407 
408 static const struct oflag {
409 	const char *name;
410 	uint64_t set;
411 } olist[] = {
412 	{ "direct",	C_ODIRECT },
413 	{ "fsync",	C_OFSYNC },
414 	{ "sync",	C_OFSYNC },
415 };
416 
417 static void
418 f_oflag(char *arg)
419 {
420 	struct oflag *op, tmp;
421 
422 	while (arg != NULL) {
423 		tmp.name = strsep(&arg, ",");
424 		op = bsearch(&tmp, olist, nitems(olist), sizeof(struct oflag),
425 		    c_oflag);
426 		if (op == NULL)
427 			errx(1, "unknown open flag %s", tmp.name);
428 		ddflags |= op->set;
429 	}
430 }
431 
432 static int
433 c_oflag(const void *a, const void *b)
434 {
435 
436 	return (strcmp(((const struct oflag *)a)->name,
437 	    ((const struct oflag *)b)->name));
438 }
439 
440 static intmax_t
441 postfix_to_mult(const char expr)
442 {
443 	intmax_t mult;
444 
445 	mult = 0;
446 	switch (expr) {
447 	case 'B':
448 	case 'b':
449 		mult = 512;
450 		break;
451 	case 'K':
452 	case 'k':
453 		mult = 1 << 10;
454 		break;
455 	case 'M':
456 	case 'm':
457 		mult = 1 << 20;
458 		break;
459 	case 'G':
460 	case 'g':
461 		mult = 1 << 30;
462 		break;
463 	case 'T':
464 	case 't':
465 		mult = (uintmax_t)1 << 40;
466 		break;
467 	case 'P':
468 	case 'p':
469 		mult = (uintmax_t)1 << 50;
470 		break;
471 	case 'W':
472 	case 'w':
473 		mult = sizeof(int);
474 		break;
475 	}
476 
477 	return (mult);
478 }
479 
480 /*
481  * Convert an expression of the following forms to a uintmax_t.
482  * 	1) A positive decimal number.
483  *	2) A positive decimal number followed by a 'b' or 'B' (mult by 512).
484  *	3) A positive decimal number followed by a 'k' or 'K' (mult by 1 << 10).
485  *	4) A positive decimal number followed by a 'm' or 'M' (mult by 1 << 20).
486  *	5) A positive decimal number followed by a 'g' or 'G' (mult by 1 << 30).
487  *	6) A positive decimal number followed by a 't' or 'T' (mult by 1 << 40).
488  *	7) A positive decimal number followed by a 'p' or 'P' (mult by 1 << 50).
489  *	8) A positive decimal number followed by a 'w' or 'W' (mult by sizeof int).
490  *	9) Two or more positive decimal numbers (with/without [BbKkMmGgWw])
491  *	   separated by 'x' or 'X' (also '*' for backwards compatibility),
492  *	   specifying the product of the indicated values.
493  */
494 static uintmax_t
495 get_num(const char *val)
496 {
497 	uintmax_t num, mult, prevnum;
498 	char *expr;
499 
500 	errno = 0;
501 	num = strtoumax(val, &expr, 0);
502 	if (expr == val)			/* No valid digits. */
503 		errx(1, "%s: invalid numeric value", oper);
504 	if (errno != 0)
505 		err(1, "%s", oper);
506 
507 	mult = postfix_to_mult(*expr);
508 
509 	if (mult != 0) {
510 		prevnum = num;
511 		num *= mult;
512 		/* Check for overflow. */
513 		if (num / mult != prevnum)
514 			goto erange;
515 		expr++;
516 	}
517 
518 	switch (*expr) {
519 		case '\0':
520 			break;
521 		case '*':			/* Backward compatible. */
522 		case 'X':
523 		case 'x':
524 			mult = get_num(expr + 1);
525 			prevnum = num;
526 			num *= mult;
527 			if (num / mult == prevnum)
528 				break;
529 erange:
530 			errx(1, "%s: %s", oper, strerror(ERANGE));
531 		default:
532 			errx(1, "%s: illegal numeric value", oper);
533 	}
534 	return (num);
535 }
536 
537 /*
538  * Convert an expression of the following forms to an off_t.  This is the
539  * same as get_num(), but it uses signed numbers.
540  *
541  * The major problem here is that an off_t may not necessarily be a intmax_t.
542  */
543 static off_t
544 get_off_t(const char *val)
545 {
546 	intmax_t num, mult, prevnum;
547 	char *expr;
548 
549 	errno = 0;
550 	num = strtoimax(val, &expr, 0);
551 	if (expr == val)			/* No valid digits. */
552 		errx(1, "%s: invalid numeric value", oper);
553 	if (errno != 0)
554 		err(1, "%s", oper);
555 
556 	mult = postfix_to_mult(*expr);
557 
558 	if (mult != 0) {
559 		prevnum = num;
560 		num *= mult;
561 		/* Check for overflow. */
562 		if ((prevnum > 0) != (num > 0) || num / mult != prevnum)
563 			goto erange;
564 		expr++;
565 	}
566 
567 	switch (*expr) {
568 		case '\0':
569 			break;
570 		case '*':			/* Backward compatible. */
571 		case 'X':
572 		case 'x':
573 			mult = (intmax_t)get_off_t(expr + 1);
574 			prevnum = num;
575 			num *= mult;
576 			if ((prevnum > 0) == (num > 0) && num / mult == prevnum)
577 				break;
578 erange:
579 			errx(1, "%s: %s", oper, strerror(ERANGE));
580 		default:
581 			errx(1, "%s: illegal numeric value", oper);
582 	}
583 	return (num);
584 }
585