xref: /dragonfly/bin/dd/args.c (revision 984263bc)
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. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by the University of
20  *	California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  */
37 
38 #ifndef lint
39 #if 0
40 static char sccsid[] = "@(#)args.c	8.3 (Berkeley) 4/2/94";
41 #endif
42 static const char rcsid[] =
43   "$FreeBSD: src/bin/dd/args.c,v 1.25.2.2 2001/01/23 14:20:03 asmodai Exp $";
44 #endif /* not lint */
45 
46 #include <sys/types.h>
47 
48 #include <err.h>
49 #include <errno.h>
50 #include <limits.h>
51 #include <stdlib.h>
52 #include <string.h>
53 
54 #include "dd.h"
55 #include "extern.h"
56 
57 static int	c_arg __P((const void *, const void *));
58 static int	c_conv __P((const void *, const void *));
59 static void	f_bs __P((char *));
60 static void	f_cbs __P((char *));
61 static void	f_conv __P((char *));
62 static void	f_count __P((char *));
63 static void	f_files __P((char *));
64 static void	f_ibs __P((char *));
65 static void	f_if __P((char *));
66 static void	f_obs __P((char *));
67 static void	f_of __P((char *));
68 static void	f_seek __P((char *));
69 static void	f_skip __P((char *));
70 static quad_t	get_num __P((char *));
71 static off_t	get_offset __P((char *));
72 
73 static const struct arg {
74 	const char *name;
75 	void (*f) __P((char *));
76 	u_int set, noset;
77 } args[] = {
78 	{ "bs",		f_bs,		C_BS,	 C_BS|C_IBS|C_OBS|C_OSYNC },
79 	{ "cbs",	f_cbs,		C_CBS,	 C_CBS },
80 	{ "conv",	f_conv,		0,	 0 },
81 	{ "count",	f_count,	C_COUNT, C_COUNT },
82 	{ "files",	f_files,	C_FILES, C_FILES },
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(argv)
100 	char **argv;
101 {
102 	struct arg *ap, tmp;
103 	char *arg;
104 
105 	in.dbsz = out.dbsz = 512;
106 
107 	while ((oper = *++argv) != NULL) {
108 		if ((oper = strdup(oper)) == NULL)
109 			errx(1, "unable to allocate space for the argument \"%s\"", *argv);
110 		if ((arg = strchr(oper, '=')) == NULL)
111 			errx(1, "unknown operand %s", oper);
112 		*arg++ = '\0';
113 		if (!*arg)
114 			errx(1, "no value specified for %s", oper);
115 		tmp.name = oper;
116 		if (!(ap = (struct arg *)bsearch(&tmp, args,
117 		    sizeof(args)/sizeof(struct arg), sizeof(struct arg),
118 		    c_arg)))
119 			errx(1, "unknown operand %s", tmp.name);
120 		if (ddflags & ap->noset)
121 			errx(1, "%s: illegal argument combination or already set",
122 			    tmp.name);
123 		ddflags |= ap->set;
124 		ap->f(arg);
125 	}
126 
127 	/* Final sanity checks. */
128 
129 	if (ddflags & C_BS) {
130 		/*
131 		 * Bs is turned off by any conversion -- we assume the user
132 		 * just wanted to set both the input and output block sizes
133 		 * and didn't want the bs semantics, so we don't warn.
134 		 */
135 		if (ddflags & (C_BLOCK | C_LCASE | C_SWAB | C_UCASE |
136 		    C_UNBLOCK))
137 			ddflags &= ~C_BS;
138 
139 		/* Bs supersedes ibs and obs. */
140 		if (ddflags & C_BS && ddflags & (C_IBS | C_OBS))
141 			warnx("bs supersedes ibs and obs");
142 	}
143 
144 	/*
145 	 * Ascii/ebcdic and cbs implies block/unblock.
146 	 * Block/unblock requires cbs and vice-versa.
147 	 */
148 	if (ddflags & (C_BLOCK | C_UNBLOCK)) {
149 		if (!(ddflags & C_CBS))
150 			errx(1, "record operations require cbs");
151 		if (cbsz == 0)
152 			errx(1, "cbs cannot be zero");
153 		cfunc = ddflags & C_BLOCK ? block : unblock;
154 	} else if (ddflags & C_CBS) {
155 		if (ddflags & (C_ASCII | C_EBCDIC)) {
156 			if (ddflags & C_ASCII) {
157 				ddflags |= C_UNBLOCK;
158 				cfunc = unblock;
159 			} else {
160 				ddflags |= C_BLOCK;
161 				cfunc = block;
162 			}
163 		} else
164 			errx(1, "cbs meaningless if not doing record operations");
165 	} else
166 		cfunc = def;
167 
168 	/*
169 	 * Bail out if the calculation of a file offset would overflow.
170 	 */
171 	if (in.offset > QUAD_MAX / in.dbsz || out.offset > QUAD_MAX / out.dbsz)
172 		errx(1, "seek offsets cannot be larger than %qd", QUAD_MAX);
173 }
174 
175 static int
176 c_arg(a, b)
177 	const void *a, *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(arg)
186 	char *arg;
187 {
188 	quad_t res;
189 
190 	res = get_num(arg);
191 	if (res < 1 || res > SSIZE_MAX)
192 		errx(1, "bs must be between 1 and %d", SSIZE_MAX);
193 	in.dbsz = out.dbsz = (size_t)res;
194 }
195 
196 static void
197 f_cbs(arg)
198 	char *arg;
199 {
200 	quad_t res;
201 
202 	res = get_num(arg);
203 	if (res < 1 || res > SSIZE_MAX)
204 		errx(1, "cbs must be between 1 and %d", SSIZE_MAX);
205 	cbsz = (size_t)res;
206 }
207 
208 static void
209 f_count(arg)
210 	char *arg;
211 {
212 
213 	cpy_cnt = get_num(arg);
214 	if (cpy_cnt < 0)
215 		errx(1, "count cannot be negative");
216 	if (cpy_cnt == 0)
217 		cpy_cnt = -1;
218 }
219 
220 static void
221 f_files(arg)
222 	char *arg;
223 {
224 
225 	files_cnt = get_num(arg);
226 	if (files_cnt < 1)
227 		errx(1, "files must be between 1 and %qd", QUAD_MAX);
228 }
229 
230 static void
231 f_ibs(arg)
232 	char *arg;
233 {
234 	quad_t res;
235 
236 	if (!(ddflags & C_BS)) {
237 		res = get_num(arg);
238 		if (res < 1 || res > SSIZE_MAX)
239 			errx(1, "ibs must be between 1 and %d", SSIZE_MAX);
240 		in.dbsz = (size_t)res;
241 	}
242 }
243 
244 static void
245 f_if(arg)
246 	char *arg;
247 {
248 
249 	in.name = arg;
250 }
251 
252 static void
253 f_obs(arg)
254 	char *arg;
255 {
256 	quad_t res;
257 
258 	if (!(ddflags & C_BS)) {
259 		res = get_num(arg);
260 		if (res < 1 || res > SSIZE_MAX)
261 			errx(1, "obs must be between 1 and %d", SSIZE_MAX);
262 		out.dbsz = (size_t)res;
263 	}
264 }
265 
266 static void
267 f_of(arg)
268 	char *arg;
269 {
270 
271 	out.name = arg;
272 }
273 
274 static void
275 f_seek(arg)
276 	char *arg;
277 {
278 
279 	out.offset = get_offset(arg);
280 }
281 
282 static void
283 f_skip(arg)
284 	char *arg;
285 {
286 
287 	in.offset = get_offset(arg);
288 }
289 
290 static const struct conv {
291 	const char *name;
292 	u_int set, noset;
293 	const u_char *ctab;
294 } clist[] = {
295 	{ "ascii",	C_ASCII,	C_EBCDIC,	e2a_POSIX },
296 	{ "block",	C_BLOCK,	C_UNBLOCK,	NULL },
297 	{ "ebcdic",	C_EBCDIC,	C_ASCII,	a2e_POSIX },
298 	{ "ibm",	C_EBCDIC,	C_ASCII,	a2ibm_POSIX },
299 	{ "lcase",	C_LCASE,	C_UCASE,	NULL },
300 	{ "noerror",	C_NOERROR,	0,		NULL },
301 	{ "notrunc",	C_NOTRUNC,	0,		NULL },
302 	{ "oldascii",	C_ASCII,	C_EBCDIC,	e2a_32V },
303 	{ "oldebcdic",	C_EBCDIC,	C_ASCII,	a2e_32V },
304 	{ "oldibm",	C_EBCDIC,	C_ASCII,	a2ibm_32V },
305 	{ "osync",	C_OSYNC,	C_BS,		NULL },
306 	{ "sparse",	C_SPARSE,	0,		NULL },
307 	{ "swab",	C_SWAB,		0,		NULL },
308 	{ "sync",	C_SYNC,		0,		NULL },
309 	{ "ucase",	C_UCASE,	C_LCASE,	NULL },
310 	{ "unblock",	C_UNBLOCK,	C_BLOCK,	NULL },
311 };
312 
313 static void
314 f_conv(arg)
315 	char *arg;
316 {
317 	struct conv *cp, tmp;
318 
319 	while (arg != NULL) {
320 		tmp.name = strsep(&arg, ",");
321 		cp = bsearch(&tmp, clist, sizeof(clist) / sizeof(struct conv),
322 		    sizeof(struct conv), c_conv);
323 		if (cp == NULL)
324 			errx(1, "unknown conversion %s", tmp.name);
325 		if (ddflags & cp->noset)
326 			errx(1, "%s: illegal conversion combination", tmp.name);
327 		ddflags |= cp->set;
328 		if (cp->ctab)
329 			ctab = cp->ctab;
330 	}
331 }
332 
333 static int
334 c_conv(a, b)
335 	const void *a, *b;
336 {
337 
338 	return (strcmp(((const struct conv *)a)->name,
339 	    ((const struct conv *)b)->name));
340 }
341 
342 /*
343  * Convert an expression of the following forms to a quad_t.
344  * 	1) A positive decimal number.
345  *	2) A positive decimal number followed by a b (mult by 512.)
346  *	3) A positive decimal number followed by a k (mult by 1 << 10.)
347  *	4) A positive decimal number followed by a m (mult by 1 << 20.)
348  *	5) A positive decimal number followed by a g (mult by 1 << 30.)
349  *	5) A positive decimal number followed by a w (mult by sizeof int.)
350  *	6) Two or more positive decimal numbers (with/without [bkmgw])
351  *	   separated by x (also * for backwards compatibility), specifying
352  *	   the product of the indicated values.
353  */
354 static quad_t
355 get_num(val)
356 	char *val;
357 {
358 	quad_t num, t;
359 	char *expr;
360 
361 	errno = 0;
362 	num = strtoq(val, &expr, 0);
363 	if (errno != 0)				/* Overflow or underflow. */
364 		err(1, "%s", oper);
365 
366 	if (expr == val)			/* No valid digits. */
367 		errx(1, "%s: illegal numeric value", oper);
368 
369 	switch (*expr) {
370 	case 'b':
371 		t = num;
372 		num *= 512;
373 		if (t > num)
374 			goto erange;
375 		++expr;
376 		break;
377 	case 'k':
378 		t = num;
379 		num *= 1 << 10;
380 		if (t > num)
381 			goto erange;
382 		++expr;
383 		break;
384 	case 'm':
385 		t = num;
386 		num *= 1 << 20;
387 		if (t > num)
388 			goto erange;
389 		++expr;
390 		break;
391 	case 'g':
392 		t = num;
393 		num *= 1 << 30;
394 		if (t > num)
395 			goto erange;
396 		++expr;
397 		break;
398 	case 'w':
399 		t = num;
400 		num *= sizeof(int);
401 		if (t > num)
402 			goto erange;
403 		++expr;
404 		break;
405 	}
406 
407 	switch (*expr) {
408 		case '\0':
409 			break;
410 		case '*':			/* Backward compatible. */
411 		case 'x':
412 			t = num;
413 			num *= get_num(expr + 1);
414 			if (t <= num)
415 				break;
416 erange:
417 			errx(1, "%s: %s", oper, strerror(ERANGE));
418 		default:
419 			errx(1, "%s: illegal numeric value", oper);
420 	}
421 	return (num);
422 }
423 
424 static off_t
425 get_offset(val)
426 	char *val;
427 {
428 	quad_t num;
429 
430 	num = get_num(val);
431 	if (num > QUAD_MAX)	/* XXX can't happen && quad_t != off_t */
432 		errx(1, "%s: illegal offset", oper);	/* Too big. */
433 	return ((off_t)num);
434 }
435