dd.c revision 51212 
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
39static char const copyright[] =
40"@(#) Copyright (c) 1991, 1993, 1994\n\
41	The Regents of the University of California.  All rights reserved.\n";
42#endif /* not lint */
43
44#ifndef lint
45#if 0
46static char sccsid[] = "@(#)dd.c	8.5 (Berkeley) 4/2/94";
47#endif
48static const char rcsid[] =
49  "$FreeBSD: head/bin/dd/dd.c 51212 1999-09-12 18:56:12Z green $";
50#endif /* not lint */
51
52#include <sys/param.h>
53#include <sys/stat.h>
54#include <sys/conf.h>
55#include <sys/diskslice.h>
56#include <sys/filio.h>
57#include <sys/mtio.h>
58
59#include <ctype.h>
60#include <err.h>
61#include <errno.h>
62#include <fcntl.h>
63#include <locale.h>
64#include <stdio.h>
65#include <stdlib.h>
66#include <string.h>
67#include <unistd.h>
68
69#include "dd.h"
70#include "extern.h"
71
72static void dd_close __P((void));
73static void dd_in __P((void));
74static void getfdtype __P((IO *));
75static void setup __P((void));
76
77IO	in, out;		/* input/output state */
78STAT	st;			/* statistics */
79void	(*cfunc) __P((void));	/* conversion function */
80quad_t	cpy_cnt;		/* # of blocks to copy */
81off_t	pending = 0;		/* pending seek if sparse */
82u_int	ddflags;		/* conversion options */
83size_t	cbsz;			/* conversion block size */
84quad_t	files_cnt = 1;		/* # of files to copy */
85const u_char	*ctab;			/* conversion table */
86
87int
88main(argc, argv)
89	int argc;
90	char *argv[];
91{
92	(void)setlocale(LC_CTYPE, "");
93	jcl(argv);
94	setup();
95
96	(void)signal(SIGINFO, summaryx);
97	(void)signal(SIGINT, terminate);
98
99	atexit(summary);
100
101	while (files_cnt--)
102		dd_in();
103
104	dd_close();
105	exit(0);
106}
107
108static void
109setup()
110{
111	u_int cnt;
112	struct timeval tv;
113
114	if (in.name == NULL) {
115		in.name = "stdin";
116		in.fd = STDIN_FILENO;
117	} else {
118		in.fd = open(in.name, O_RDONLY, 0);
119		if (in.fd == -1)
120			err(1, "%s", in.name);
121	}
122
123	getfdtype(&in);
124
125	if (files_cnt > 1 && !(in.flags & ISTAPE))
126		errx(1, "files is not supported for non-tape devices");
127
128	if (out.name == NULL) {
129		/* No way to check for read access here. */
130		out.fd = STDOUT_FILENO;
131		out.name = "stdout";
132	} else {
133#define	OFLAGS \
134    (O_CREAT | (ddflags & (C_SEEK | C_NOTRUNC) ? 0 : O_TRUNC))
135		out.fd = open(out.name, O_RDWR | OFLAGS, DEFFILEMODE);
136		/*
137		 * May not have read access, so try again with write only.
138		 * Without read we may have a problem if output also does
139		 * not support seeks.
140		 */
141		if (out.fd == -1) {
142			out.fd = open(out.name, O_WRONLY | OFLAGS, DEFFILEMODE);
143			out.flags |= NOREAD;
144		}
145		if (out.fd == -1)
146			err(1, "%s", out.name);
147	}
148
149	getfdtype(&out);
150
151	/*
152	 * Allocate space for the input and output buffers.  If not doing
153	 * record oriented I/O, only need a single buffer.
154	 */
155	if (!(ddflags & (C_BLOCK|C_UNBLOCK))) {
156		if ((in.db = malloc(out.dbsz + in.dbsz - 1)) == NULL)
157			err(1, "input buffer");
158		out.db = in.db;
159	} else if ((in.db = malloc(MAX(in.dbsz, cbsz) + cbsz)) == NULL ||
160	    (out.db = malloc(out.dbsz + cbsz)) == NULL)
161		err(1, "output buffer");
162	in.dbp = in.db;
163	out.dbp = out.db;
164
165	/* Position the input/output streams. */
166	if (in.offset)
167		pos_in();
168	if (out.offset)
169		pos_out();
170
171	/*
172	 * Truncate the output file; ignore errors because it fails on some
173	 * kinds of output files, tapes, for example.
174	 */
175	if ((ddflags & (C_OF | C_SEEK | C_NOTRUNC)) == (C_OF | C_SEEK))
176		(void)ftruncate(out.fd, out.offset * out.dbsz);
177
178	/*
179	 * If converting case at the same time as another conversion, build a
180	 * table that does both at once.  If just converting case, use the
181	 * built-in tables.
182	 */
183	if (ddflags & (C_LCASE|C_UCASE)) {
184		if (ddflags & (C_ASCII|C_EBCDIC)) {
185			if (ddflags & C_LCASE) {
186				for (cnt = 0; cnt <= 0377; ++cnt)
187					casetab[cnt] = tolower(ctab[cnt]);
188			} else {
189				for (cnt = 0; cnt <= 0377; ++cnt)
190					casetab[cnt] = toupper(ctab[cnt]);
191			}
192		} else {
193			if (ddflags & C_LCASE) {
194				for (cnt = 0; cnt <= 0377; ++cnt)
195					casetab[cnt] = tolower(cnt);
196			} else {
197				for (cnt = 0; cnt <= 0377; ++cnt)
198					casetab[cnt] = toupper(cnt);
199			}
200		}
201		ctab = casetab;
202	}
203
204	(void)gettimeofday(&tv, (struct timezone *)NULL);
205	st.start = tv.tv_sec + tv.tv_usec * 1e-6;
206}
207
208static void
209getfdtype(io)
210	IO *io;
211{
212	struct stat sb;
213	int type;
214
215	if (fstat(io->fd, &sb) == -1)
216		err(1, "%s", io->name);
217	if (S_ISCHR(sb.st_mode) || S_ISBLK(sb.st_mode)) {
218		if (ioctl(io->fd, FIODTYPE, &type) == -1) {
219			warn("%s", io->name);
220			if (S_ISCHR(sb.st_mode))
221				io->flags |= ISCHR;
222		} else {
223			if (type & D_TAPE)
224				io->flags |= ISTAPE;
225			else if (type & (D_DISK | D_MEM))
226				io->flags |= ISSEEK;
227			if (S_ISCHR(sb.st_mode) && (type & D_TAPE) == 0)
228				io->flags |= ISCHR;
229		}
230	} else if (!S_ISREG(sb.st_mode))
231		io->flags |= ISPIPE;
232}
233
234static void
235dd_in()
236{
237	ssize_t n;
238
239	for (;;) {
240		if (cpy_cnt && (st.in_full + st.in_part) >= cpy_cnt)
241			return;
242
243		/*
244		 * Zero the buffer first if sync; if doing block operations,
245		 * use spaces.
246		 */
247		if (ddflags & C_SYNC) {
248			if (ddflags & (C_BLOCK|C_UNBLOCK))
249				memset(in.dbp, ' ', in.dbsz);
250			else
251				memset(in.dbp, 0, in.dbsz);
252		}
253
254		n = read(in.fd, in.dbp, in.dbsz);
255		if (n == 0) {
256			in.dbrcnt = 0;
257			return;
258		}
259
260		/* Read error. */
261		if (n == -1) {
262			/*
263			 * If noerror not specified, die.  POSIX requires that
264			 * the warning message be followed by an I/O display.
265			 */
266			if (!(ddflags & C_NOERROR))
267				err(1, "%s", in.name);
268			warn("%s", in.name);
269			summary();
270
271			/*
272			 * If it's not a tape drive or a pipe, seek past the
273			 * error.  If your OS doesn't do the right thing for
274			 * raw disks this section should be modified to re-read
275			 * in sector size chunks.
276			 */
277			if (!(in.flags & (ISPIPE|ISTAPE)) &&
278			    lseek(in.fd, (off_t)in.dbsz, SEEK_CUR))
279				warn("%s", in.name);
280
281			/* If sync not specified, omit block and continue. */
282			if (!(ddflags & C_SYNC))
283				continue;
284
285			/* Read errors count as full blocks. */
286			in.dbcnt += in.dbrcnt = in.dbsz;
287			++st.in_full;
288
289		/* Handle full input blocks. */
290		} else if (n == in.dbsz) {
291			in.dbcnt += in.dbrcnt = n;
292			++st.in_full;
293
294		/* Handle partial input blocks. */
295		} else {
296			/* If sync, use the entire block. */
297			if (ddflags & C_SYNC)
298				in.dbcnt += in.dbrcnt = in.dbsz;
299			else
300				in.dbcnt += in.dbrcnt = n;
301			++st.in_part;
302		}
303
304		/*
305		 * POSIX states that if bs is set and no other conversions
306		 * than noerror, notrunc or sync are specified, the block
307		 * is output without buffering as it is read.
308		 */
309		if (ddflags & C_BS) {
310			out.dbcnt = in.dbcnt;
311			dd_out(1);
312			in.dbcnt = 0;
313			continue;
314		}
315
316		if (ddflags & C_SWAB) {
317			if ((n = in.dbrcnt) & 1) {
318				++st.swab;
319				--n;
320			}
321			swab(in.dbp, in.dbp, n);
322		}
323
324		in.dbp += in.dbrcnt;
325		(*cfunc)();
326	}
327}
328
329/*
330 * Clea nup any remaining I/O and flush output.  If necessary, the output file
331 * is truncated.
332 */
333static void
334dd_close()
335{
336	if (cfunc == def)
337		def_close();
338	else if (cfunc == block)
339		block_close();
340	else if (cfunc == unblock)
341		unblock_close();
342	if (ddflags & C_OSYNC && out.dbcnt && out.dbcnt < out.dbsz) {
343		if (ddflags & (C_BLOCK|C_UNBLOCK))
344			memset(out.dbp, ' ', out.dbsz - out.dbcnt);
345		else
346			memset(out.dbp, 0, out.dbsz - out.dbcnt);
347		out.dbcnt = out.dbsz;
348	}
349	if (out.dbcnt || pending)
350		dd_out(1);
351}
352
353void
354dd_out(force)
355	int force;
356{
357	u_char *outp;
358	size_t cnt, i, n;
359	ssize_t nw;
360	static int warned;
361	int sparse;
362
363	/*
364	 * Write one or more blocks out.  The common case is writing a full
365	 * output block in a single write; increment the full block stats.
366	 * Otherwise, we're into partial block writes.  If a partial write,
367	 * and it's a character device, just warn.  If a tape device, quit.
368	 *
369	 * The partial writes represent two cases.  1: Where the input block
370	 * was less than expected so the output block was less than expected.
371	 * 2: Where the input block was the right size but we were forced to
372	 * write the block in multiple chunks.  The original versions of dd(1)
373	 * never wrote a block in more than a single write, so the latter case
374	 * never happened.
375	 *
376	 * One special case is if we're forced to do the write -- in that case
377	 * we play games with the buffer size, and it's usually a partial write.
378	 */
379	outp = out.db;
380	for (n = force ? out.dbcnt : out.dbsz;; n = out.dbsz) {
381		for (cnt = n;; cnt -= nw) {
382			sparse = 0;
383			if (ddflags & C_SPARSE) {
384				sparse = 1;	/* Is buffer sparse? */
385				for (i = 0; i < cnt; i++)
386					if (outp[i] != 0) {
387						sparse = 0;
388						break;
389					}
390			}
391			if (sparse && !force) {
392				pending += cnt;
393				nw = cnt;
394			} else {
395				if (pending != 0) {
396					if (force)
397						pending--;
398					if (lseek(out.fd, pending, SEEK_CUR) ==
399					    -1)
400						err(2, "%s: seek error creating sparse file",
401						    out.name);
402					if (force)
403						write(out.fd, outp, 1);
404					pending = 0;
405				}
406				if (cnt)
407					nw = write(out.fd, outp, cnt);
408				else
409					return;
410			}
411
412			if (nw <= 0) {
413				if (nw == 0)
414					errx(1, "%s: end of device", out.name);
415				if (errno != EINTR)
416					err(1, "%s", out.name);
417				nw = 0;
418			}
419			outp += nw;
420			st.bytes += nw;
421			if (nw == n) {
422				if (n != out.dbsz)
423					++st.out_part;
424				else
425					++st.out_full;
426				break;
427			}
428			++st.out_part;
429			if (nw == cnt)
430				break;
431			if (out.flags & ISCHR && !warned) {
432				warned = 1;
433				warnx("%s: short write on character device",
434				    out.name);
435			}
436			if (out.flags & ISTAPE)
437				errx(1, "%s: short write on tape device", out.name);
438		}
439		if ((out.dbcnt -= n) < out.dbsz)
440			break;
441	}
442
443	/* Reassemble the output block. */
444	if (out.dbcnt)
445		(void)memmove(out.db, out.dbp - out.dbcnt, out.dbcnt);
446	out.dbp = out.db + out.dbcnt;
447}
448