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