2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1991, 1993, 1994
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Keith Muller of the University of California, San Diego and Lance
9 * Visser of Convex Computer Corporation.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 static char const copyright[] =
39 "@(#) Copyright (c) 1991, 1993, 1994\n\
40 The Regents of the University of California. All rights reserved.\n";
44 static char sccsid[] = "@(#)dd.c 8.5 (Berkeley) 4/2/94";
47 #include <sys/cdefs.h>
48 __FBSDID("$FreeBSD$");
50 #include <sys/param.h>
52 #include <sys/capsicum.h>
54 #include <sys/disklabel.h>
55 #include <sys/filio.h>
59 #include <capsicum_helpers.h>
75 static void dd_close(void);
76 static void dd_in(void);
77 static void getfdtype(IO *);
78 static void setup(void);
80 IO in, out; /* input/output state */
81 STAT st; /* statistics */
82 void (*cfunc)(void); /* conversion function */
83 uintmax_t cpy_cnt; /* # of blocks to copy */
84 static off_t pending = 0; /* pending seek if sparse */
85 u_int ddflags = 0; /* conversion options */
86 size_t cbsz; /* conversion block size */
87 uintmax_t files_cnt = 1; /* # of files to copy */
88 const u_char *ctab; /* conversion table */
89 char fill_char; /* Character to fill with if defined */
90 size_t speed = 0; /* maximum speed, in bytes per second */
91 volatile sig_atomic_t need_summary;
94 main(int argc __unused, char *argv[])
96 (void)setlocale(LC_CTYPE, "");
100 caph_cache_catpages();
101 if (cap_enter() == -1 && errno != ENOSYS)
102 err(1, "unable to enter capability mode");
104 (void)signal(SIGINFO, siginfo_handler);
105 (void)signal(SIGINT, terminate);
114 * Some devices such as cfi(4) may perform significant amounts
115 * of work when a write descriptor is closed. Close the out
116 * descriptor explicitly so that the summary handler (called
117 * from an atexit() hook) includes this work.
128 i = c ^ (c >> 1) ^ (c >> 2) ^ (c >> 3) ^
129 (c >> 4) ^ (c >> 5) ^ (c >> 6) ^ (c >> 7);
138 unsigned long cmds[] = { FIODTYPE, MTIOCTOP };
140 if (in.name == NULL) {
142 in.fd = STDIN_FILENO;
144 in.fd = open(in.name, O_RDONLY, 0);
146 err(1, "%s", in.name);
151 cap_rights_init(&rights, CAP_READ, CAP_SEEK);
152 if (cap_rights_limit(in.fd, &rights) == -1 && errno != ENOSYS)
153 err(1, "unable to limit capability rights");
155 if (files_cnt > 1 && !(in.flags & ISTAPE))
156 errx(1, "files is not supported for non-tape devices");
158 cap_rights_set(&rights, CAP_FTRUNCATE, CAP_IOCTL, CAP_WRITE);
159 if (out.name == NULL) {
160 /* No way to check for read access here. */
161 out.fd = STDOUT_FILENO;
165 (O_CREAT | (ddflags & (C_SEEK | C_NOTRUNC) ? 0 : O_TRUNC))
166 out.fd = open(out.name, O_RDWR | OFLAGS, DEFFILEMODE);
168 * May not have read access, so try again with write only.
169 * Without read we may have a problem if output also does
173 out.fd = open(out.name, O_WRONLY | OFLAGS, DEFFILEMODE);
175 cap_rights_clear(&rights, CAP_READ);
178 err(1, "%s", out.name);
183 if (cap_rights_limit(out.fd, &rights) == -1 && errno != ENOSYS)
184 err(1, "unable to limit capability rights");
185 if (cap_ioctls_limit(out.fd, cmds, nitems(cmds)) == -1 &&
187 err(1, "unable to limit capability rights");
189 if (in.fd != STDIN_FILENO && out.fd != STDIN_FILENO) {
190 if (caph_limit_stdin() == -1)
191 err(1, "unable to limit capability rights");
194 if (in.fd != STDOUT_FILENO && out.fd != STDOUT_FILENO) {
195 if (caph_limit_stdout() == -1)
196 err(1, "unable to limit capability rights");
199 if (in.fd != STDERR_FILENO && out.fd != STDERR_FILENO) {
200 if (caph_limit_stderr() == -1)
201 err(1, "unable to limit capability rights");
205 * Allocate space for the input and output buffers. If not doing
206 * record oriented I/O, only need a single buffer.
208 if (!(ddflags & (C_BLOCK | C_UNBLOCK))) {
209 if ((in.db = malloc((size_t)out.dbsz + in.dbsz - 1)) == NULL)
210 err(1, "input buffer");
212 } else if ((in.db = malloc(MAX((size_t)in.dbsz, cbsz) + cbsz)) == NULL ||
213 (out.db = malloc(out.dbsz + cbsz)) == NULL)
214 err(1, "output buffer");
216 /* dbp is the first free position in each buffer. */
220 /* Position the input/output streams. */
227 * Truncate the output file. If it fails on a type of output file
228 * that it should _not_ fail on, error out.
230 if ((ddflags & (C_OF | C_SEEK | C_NOTRUNC)) == (C_OF | C_SEEK) &&
232 if (ftruncate(out.fd, out.offset * out.dbsz) == -1)
233 err(1, "truncating %s", out.name);
235 if (ddflags & (C_LCASE | C_UCASE | C_ASCII | C_EBCDIC | C_PARITY)) {
237 for (cnt = 0; cnt <= 0377; ++cnt)
238 casetab[cnt] = ctab[cnt];
240 for (cnt = 0; cnt <= 0377; ++cnt)
243 if ((ddflags & C_PARITY) && !(ddflags & C_ASCII)) {
245 * If the input is not EBCDIC, and we do parity
246 * processing, strip input parity.
248 for (cnt = 200; cnt <= 0377; ++cnt)
249 casetab[cnt] = casetab[cnt & 0x7f];
251 if (ddflags & C_LCASE) {
252 for (cnt = 0; cnt <= 0377; ++cnt)
253 casetab[cnt] = tolower(casetab[cnt]);
254 } else if (ddflags & C_UCASE) {
255 for (cnt = 0; cnt <= 0377; ++cnt)
256 casetab[cnt] = toupper(casetab[cnt]);
258 if ((ddflags & C_PARITY)) {
260 * This should strictly speaking be a no-op, but I
261 * wonder what funny LANG settings could get us.
263 for (cnt = 0; cnt <= 0377; ++cnt)
264 casetab[cnt] = casetab[cnt] & 0x7f;
266 if ((ddflags & C_PARSET)) {
267 for (cnt = 0; cnt <= 0377; ++cnt)
268 casetab[cnt] = casetab[cnt] | 0x80;
270 if ((ddflags & C_PAREVEN)) {
271 for (cnt = 0; cnt <= 0377; ++cnt)
272 if (parity(casetab[cnt]))
273 casetab[cnt] = casetab[cnt] | 0x80;
275 if ((ddflags & C_PARODD)) {
276 for (cnt = 0; cnt <= 0377; ++cnt)
277 if (!parity(casetab[cnt]))
278 casetab[cnt] = casetab[cnt] | 0x80;
284 if (clock_gettime(CLOCK_MONOTONIC, &st.start))
285 err(1, "clock_gettime");
294 if (fstat(io->fd, &sb) == -1)
295 err(1, "%s", io->name);
296 if (S_ISREG(sb.st_mode))
297 io->flags |= ISTRUNC;
298 if (S_ISCHR(sb.st_mode) || S_ISBLK(sb.st_mode)) {
299 if (ioctl(io->fd, FIODTYPE, &type) == -1) {
300 err(1, "%s", io->name);
304 else if (type & (D_DISK | D_MEM))
306 if (S_ISCHR(sb.st_mode) && (type & D_TAPE) == 0)
312 if (lseek(io->fd, (off_t)0, SEEK_CUR) == -1 && errno == ESPIPE)
319 * Limit the speed by adding a delay before every block read.
320 * The delay (t_usleep) is equal to the time computed from block
321 * size and the specified speed limit (t_target) minus the time
322 * spent on actual read and write operations (t_io).
327 static double t_prev, t_usleep;
328 double t_now, t_io, t_target;
330 t_now = secs_elapsed();
331 t_io = t_now - t_prev - t_usleep;
332 t_target = (double)in.dbsz / (double)speed;
333 t_usleep = t_target - t_io;
335 usleep(t_usleep * 1000000);
342 swapbytes(void *v, size_t len)
344 unsigned char *p = v;
363 case -1: /* count=0 was specified */
368 if (st.in_full + st.in_part >= (uintmax_t)cpy_cnt)
377 * Zero the buffer first if sync; if doing block operations,
380 if (ddflags & C_SYNC) {
381 if (ddflags & C_FILL)
382 memset(in.dbp, fill_char, in.dbsz);
383 else if (ddflags & (C_BLOCK | C_UNBLOCK))
384 memset(in.dbp, ' ', in.dbsz);
386 memset(in.dbp, 0, in.dbsz);
389 n = read(in.fd, in.dbp, in.dbsz);
398 * If noerror not specified, die. POSIX requires that
399 * the warning message be followed by an I/O display.
401 if (!(ddflags & C_NOERROR))
402 err(1, "%s", in.name);
407 * If it's a seekable file descriptor, seek past the
408 * error. If your OS doesn't do the right thing for
409 * raw disks this section should be modified to re-read
410 * in sector size chunks.
412 if (in.flags & ISSEEK &&
413 lseek(in.fd, (off_t)in.dbsz, SEEK_CUR))
416 /* If sync not specified, omit block and continue. */
417 if (!(ddflags & C_SYNC))
420 /* Read errors count as full blocks. */
421 in.dbcnt += in.dbrcnt = in.dbsz;
424 /* Handle full input blocks. */
425 } else if ((size_t)n == (size_t)in.dbsz) {
426 in.dbcnt += in.dbrcnt = n;
429 /* Handle partial input blocks. */
431 /* If sync, use the entire block. */
432 if (ddflags & C_SYNC)
433 in.dbcnt += in.dbrcnt = in.dbsz;
435 in.dbcnt += in.dbrcnt = n;
440 * POSIX states that if bs is set and no other conversions
441 * than noerror, notrunc or sync are specified, the block
442 * is output without buffering as it is read.
444 if ((ddflags & ~(C_NOERROR | C_NOTRUNC | C_SYNC)) == C_BS) {
445 out.dbcnt = in.dbcnt;
451 if (ddflags & C_SWAB) {
452 if ((n = in.dbrcnt) & 1) {
456 swapbytes(in.dbp, (size_t)n);
468 * Clean up any remaining I/O and flush output. If necessary, the output file
476 else if (cfunc == block)
478 else if (cfunc == unblock)
480 if (ddflags & C_OSYNC && out.dbcnt && out.dbcnt < out.dbsz) {
481 if (ddflags & C_FILL)
482 memset(out.dbp, fill_char, out.dbsz - out.dbcnt);
483 else if (ddflags & (C_BLOCK | C_UNBLOCK))
484 memset(out.dbp, ' ', out.dbsz - out.dbcnt);
486 memset(out.dbp, 0, out.dbsz - out.dbcnt);
487 out.dbcnt = out.dbsz;
489 if (out.dbcnt || pending)
493 * If the file ends with a hole, ftruncate it to extend its size
494 * up to the end of the hole (without having to write any data).
496 if (out.seek_offset > 0 && (out.flags & ISTRUNC)) {
497 if (ftruncate(out.fd, out.seek_offset) == -1)
498 err(1, "truncating %s", out.name);
512 * Write one or more blocks out. The common case is writing a full
513 * output block in a single write; increment the full block stats.
514 * Otherwise, we're into partial block writes. If a partial write,
515 * and it's a character device, just warn. If a tape device, quit.
517 * The partial writes represent two cases. 1: Where the input block
518 * was less than expected so the output block was less than expected.
519 * 2: Where the input block was the right size but we were forced to
520 * write the block in multiple chunks. The original versions of dd(1)
521 * never wrote a block in more than a single write, so the latter case
524 * One special case is if we're forced to do the write -- in that case
525 * we play games with the buffer size, and it's usually a partial write.
530 * If force, first try to write all pending data, else try to write
531 * just one block. Subsequently always write data one full block at
534 for (n = force ? out.dbcnt : out.dbsz;; n = out.dbsz) {
538 if (ddflags & C_SPARSE) {
539 sparse = 1; /* Is buffer sparse? */
540 for (i = 0; i < cnt; i++)
546 if (sparse && !force) {
552 * Seek past hole. Note that we need to record the
553 * reached offset, because we might have no more data
554 * to write, in which case we'll need to call
555 * ftruncate to extend the file size.
557 out.seek_offset = lseek(out.fd, pending, SEEK_CUR);
558 if (out.seek_offset == -1)
559 err(2, "%s: seek error creating sparse file",
564 nw = write(out.fd, outp, cnt);
573 errx(1, "%s: end of device", out.name);
575 err(1, "%s", out.name);
582 if ((size_t)nw == n && n == (size_t)out.dbsz)
587 if ((size_t) nw != cnt) {
588 if (out.flags & ISTAPE)
589 errx(1, "%s: short write on tape device",
591 if (out.flags & ISCHR && !warned) {
593 warnx("%s: short write on character device",
601 if ((out.dbcnt -= n) < out.dbsz)
605 /* Reassemble the output block. */
607 (void)memmove(out.db, out.dbp - out.dbcnt, out.dbcnt);
608 out.dbp = out.db + out.dbcnt;