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