xref: /freebsd/bin/dd/args.c (revision 2f513db7)
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/param.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 int	c_iflag(const void *, const void *);
61 static int	c_oflag(const void *, const void *);
62 static void	f_bs(char *);
63 static void	f_cbs(char *);
64 static void	f_conv(char *);
65 static void	f_count(char *);
66 static void	f_files(char *);
67 static void	f_fillchar(char *);
68 static void	f_ibs(char *);
69 static void	f_if(char *);
70 static void	f_iflag(char *);
71 static void	f_obs(char *);
72 static void	f_of(char *);
73 static void	f_oflag(char *);
74 static void	f_seek(char *);
75 static void	f_skip(char *);
76 static void	f_speed(char *);
77 static void	f_status(char *);
78 static uintmax_t get_num(const char *);
79 static off_t	get_off_t(const char *);
80 
81 static const struct arg {
82 	const char *name;
83 	void (*f)(char *);
84 	uint64_t set, noset;
85 } args[] = {
86 	{ "bs",		f_bs,		C_BS,	 C_BS|C_IBS|C_OBS|C_OSYNC },
87 	{ "cbs",	f_cbs,		C_CBS,	 C_CBS },
88 	{ "conv",	f_conv,		0,	 0 },
89 	{ "count",	f_count,	C_COUNT, C_COUNT },
90 	{ "files",	f_files,	C_FILES, C_FILES },
91 	{ "fillchar",	f_fillchar,	C_FILL,	 C_FILL },
92 	{ "ibs",	f_ibs,		C_IBS,	 C_BS|C_IBS },
93 	{ "if",		f_if,		C_IF,	 C_IF },
94 	{ "iflag",	f_iflag,	0,	 0 },
95 	{ "iseek",	f_skip,		C_SKIP,	 C_SKIP },
96 	{ "obs",	f_obs,		C_OBS,	 C_BS|C_OBS },
97 	{ "of",		f_of,		C_OF,	 C_OF },
98 	{ "oflag",	f_oflag,	0,	 0 },
99 	{ "oseek",	f_seek,		C_SEEK,	 C_SEEK },
100 	{ "seek",	f_seek,		C_SEEK,	 C_SEEK },
101 	{ "skip",	f_skip,		C_SKIP,	 C_SKIP },
102 	{ "speed",	f_speed,	0,	 0 },
103 	{ "status",	f_status,	C_STATUS,C_STATUS },
104 };
105 
106 static char *oper;
107 
108 /*
109  * args -- parse JCL syntax of dd.
110  */
111 void
112 jcl(char **argv)
113 {
114 	struct arg *ap, tmp;
115 	char *arg;
116 
117 	in.dbsz = out.dbsz = 512;
118 
119 	while ((oper = *++argv) != NULL) {
120 		if ((oper = strdup(oper)) == NULL)
121 			errx(1, "unable to allocate space for the argument \"%s\"", *argv);
122 		if ((arg = strchr(oper, '=')) == NULL)
123 			errx(1, "unknown operand %s", oper);
124 		*arg++ = '\0';
125 		if (!*arg)
126 			errx(1, "no value specified for %s", oper);
127 		tmp.name = oper;
128 		if (!(ap = (struct arg *)bsearch(&tmp, args,
129 		    sizeof(args)/sizeof(struct arg), sizeof(struct arg),
130 		    c_arg)))
131 			errx(1, "unknown operand %s", tmp.name);
132 		if (ddflags & ap->noset)
133 			errx(1, "%s: illegal argument combination or already set",
134 			    tmp.name);
135 		ddflags |= ap->set;
136 		ap->f(arg);
137 	}
138 
139 	/* Final sanity checks. */
140 
141 	if (ddflags & C_BS) {
142 		/*
143 		 * Bs is turned off by any conversion -- we assume the user
144 		 * just wanted to set both the input and output block sizes
145 		 * and didn't want the bs semantics, so we don't warn.
146 		 */
147 		if (ddflags & (C_BLOCK | C_LCASE | C_SWAB | C_UCASE |
148 		    C_UNBLOCK))
149 			ddflags &= ~C_BS;
150 
151 		/* Bs supersedes ibs and obs. */
152 		if (ddflags & C_BS && ddflags & (C_IBS | C_OBS))
153 			warnx("bs supersedes ibs and obs");
154 	}
155 
156 	/*
157 	 * Ascii/ebcdic and cbs implies block/unblock.
158 	 * Block/unblock requires cbs and vice-versa.
159 	 */
160 	if (ddflags & (C_BLOCK | C_UNBLOCK)) {
161 		if (!(ddflags & C_CBS))
162 			errx(1, "record operations require cbs");
163 		if (cbsz == 0)
164 			errx(1, "cbs cannot be zero");
165 		cfunc = ddflags & C_BLOCK ? block : unblock;
166 	} else if (ddflags & C_CBS) {
167 		if (ddflags & (C_ASCII | C_EBCDIC)) {
168 			if (ddflags & C_ASCII) {
169 				ddflags |= C_UNBLOCK;
170 				cfunc = unblock;
171 			} else {
172 				ddflags |= C_BLOCK;
173 				cfunc = block;
174 			}
175 		} else
176 			errx(1, "cbs meaningless if not doing record operations");
177 	} else
178 		cfunc = def;
179 }
180 
181 static int
182 c_arg(const void *a, const void *b)
183 {
184 
185 	return (strcmp(((const struct arg *)a)->name,
186 	    ((const struct arg *)b)->name));
187 }
188 
189 static void
190 f_bs(char *arg)
191 {
192 	uintmax_t res;
193 
194 	res = get_num(arg);
195 	if (res < 1 || res > SSIZE_MAX)
196 		errx(1, "bs must be between 1 and %zd", (ssize_t)SSIZE_MAX);
197 	in.dbsz = out.dbsz = (size_t)res;
198 }
199 
200 static void
201 f_cbs(char *arg)
202 {
203 	uintmax_t res;
204 
205 	res = get_num(arg);
206 	if (res < 1 || res > SSIZE_MAX)
207 		errx(1, "cbs must be between 1 and %zd", (ssize_t)SSIZE_MAX);
208 	cbsz = (size_t)res;
209 }
210 
211 static void
212 f_count(char *arg)
213 {
214 	uintmax_t res;
215 
216 	res = get_num(arg);
217 	if (res == UINTMAX_MAX)
218 		errc(1, ERANGE, "%s", oper);
219 	if (res == 0)
220 		cpy_cnt = UINTMAX_MAX;
221 	else
222 		cpy_cnt = res;
223 }
224 
225 static void
226 f_files(char *arg)
227 {
228 
229 	files_cnt = get_num(arg);
230 	if (files_cnt < 1)
231 		errx(1, "files must be between 1 and %zu", SIZE_MAX);
232 }
233 
234 static void
235 f_fillchar(char *arg)
236 {
237 
238 	if (strlen(arg) != 1)
239 		errx(1, "need exactly one fill char");
240 
241 	fill_char = arg[0];
242 }
243 
244 static void
245 f_ibs(char *arg)
246 {
247 	uintmax_t res;
248 
249 	if (!(ddflags & C_BS)) {
250 		res = get_num(arg);
251 		if (res < 1 || res > SSIZE_MAX)
252 			errx(1, "ibs must be between 1 and %zd",
253 			    (ssize_t)SSIZE_MAX);
254 		in.dbsz = (size_t)res;
255 	}
256 }
257 
258 static void
259 f_if(char *arg)
260 {
261 
262 	in.name = arg;
263 }
264 
265 static const struct iflag {
266 	const char *name;
267 	uint64_t set, noset;
268 } ilist[] = {
269 	{ "fullblock",	C_IFULLBLOCK,	C_SYNC },
270 };
271 
272 static void
273 f_iflag(char *arg)
274 {
275 	struct iflag *ip, tmp;
276 
277 	while (arg != NULL) {
278 		tmp.name = strsep(&arg, ",");
279 		ip = bsearch(&tmp, ilist, nitems(ilist), sizeof(struct iflag),
280 		    c_iflag);
281 		if (ip == NULL)
282 			errx(1, "unknown iflag %s", tmp.name);
283 		if (ddflags & ip->noset)
284 			errx(1, "%s: illegal conversion combination", tmp.name);
285 		ddflags |= ip->set;
286 	}
287 }
288 
289 static int
290 c_iflag(const void *a, const void *b)
291 {
292 
293 	return (strcmp(((const struct iflag *)a)->name,
294 	    ((const struct iflag *)b)->name));
295 }
296 
297 static void
298 f_obs(char *arg)
299 {
300 	uintmax_t res;
301 
302 	if (!(ddflags & C_BS)) {
303 		res = get_num(arg);
304 		if (res < 1 || res > SSIZE_MAX)
305 			errx(1, "obs must be between 1 and %zd",
306 			    (ssize_t)SSIZE_MAX);
307 		out.dbsz = (size_t)res;
308 	}
309 }
310 
311 static void
312 f_of(char *arg)
313 {
314 
315 	out.name = arg;
316 }
317 
318 static void
319 f_seek(char *arg)
320 {
321 
322 	out.offset = get_off_t(arg);
323 }
324 
325 static void
326 f_skip(char *arg)
327 {
328 
329 	in.offset = get_off_t(arg);
330 }
331 
332 static void
333 f_speed(char *arg)
334 {
335 
336 	speed = get_num(arg);
337 }
338 
339 static void
340 f_status(char *arg)
341 {
342 
343 	if (strcmp(arg, "none") == 0)
344 		ddflags |= C_NOINFO;
345 	else if (strcmp(arg, "noxfer") == 0)
346 		ddflags |= C_NOXFER;
347 	else if (strcmp(arg, "progress") == 0)
348 		ddflags |= C_PROGRESS;
349 	else
350 		errx(1, "unknown status %s", arg);
351 }
352 
353 static const struct conv {
354 	const char *name;
355 	uint64_t set, noset;
356 	const u_char *ctab;
357 } clist[] = {
358 	{ "ascii",	C_ASCII,	C_EBCDIC,	e2a_POSIX },
359 	{ "block",	C_BLOCK,	C_UNBLOCK,	NULL },
360 	{ "ebcdic",	C_EBCDIC,	C_ASCII,	a2e_POSIX },
361 	{ "fdatasync",	C_FDATASYNC,	0,		NULL },
362 	{ "fsync",	C_FSYNC,	0,		NULL },
363 	{ "ibm",	C_EBCDIC,	C_ASCII,	a2ibm_POSIX },
364 	{ "lcase",	C_LCASE,	C_UCASE,	NULL },
365 	{ "noerror",	C_NOERROR,	0,		NULL },
366 	{ "notrunc",	C_NOTRUNC,	0,		NULL },
367 	{ "oldascii",	C_ASCII,	C_EBCDIC,	e2a_32V },
368 	{ "oldebcdic",	C_EBCDIC,	C_ASCII,	a2e_32V },
369 	{ "oldibm",	C_EBCDIC,	C_ASCII,	a2ibm_32V },
370 	{ "osync",	C_OSYNC,	C_BS,		NULL },
371 	{ "pareven",	C_PAREVEN,	C_PARODD|C_PARSET|C_PARNONE, NULL},
372 	{ "parnone",	C_PARNONE,	C_PARODD|C_PARSET|C_PAREVEN, NULL},
373 	{ "parodd",	C_PARODD,	C_PAREVEN|C_PARSET|C_PARNONE, NULL},
374 	{ "parset",	C_PARSET,	C_PARODD|C_PAREVEN|C_PARNONE, NULL},
375 	{ "sparse",	C_SPARSE,	0,		NULL },
376 	{ "swab",	C_SWAB,		0,		NULL },
377 	{ "sync",	C_SYNC,		C_IFULLBLOCK,	NULL },
378 	{ "ucase",	C_UCASE,	C_LCASE,	NULL },
379 	{ "unblock",	C_UNBLOCK,	C_BLOCK,	NULL },
380 };
381 
382 static void
383 f_conv(char *arg)
384 {
385 	struct conv *cp, tmp;
386 
387 	while (arg != NULL) {
388 		tmp.name = strsep(&arg, ",");
389 		cp = bsearch(&tmp, clist, nitems(clist), sizeof(struct conv),
390 		    c_conv);
391 		if (cp == NULL)
392 			errx(1, "unknown conversion %s", tmp.name);
393 		if (ddflags & cp->noset)
394 			errx(1, "%s: illegal conversion combination", tmp.name);
395 		ddflags |= cp->set;
396 		if (cp->ctab)
397 			ctab = cp->ctab;
398 	}
399 }
400 
401 static int
402 c_conv(const void *a, const void *b)
403 {
404 
405 	return (strcmp(((const struct conv *)a)->name,
406 	    ((const struct conv *)b)->name));
407 }
408 
409 static const struct oflag {
410 	const char *name;
411 	uint64_t set;
412 } olist[] = {
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