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