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