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