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>
60 #include <capsicum_helpers.h>
77 static void dd_close(void);
78 static void dd_in(void);
79 static void getfdtype(IO *);
80 static void setup(void);
82 IO in, out; /* input/output state */
83 STAT st; /* statistics */
84 void (*cfunc)(void); /* conversion function */
85 uintmax_t cpy_cnt; /* # of blocks to copy */
86 static off_t pending = 0; /* pending seek if sparse */
87 uint64_t ddflags = 0; /* conversion options */
88 size_t cbsz; /* conversion block size */
89 uintmax_t files_cnt = 1; /* # of files to copy */
90 const u_char *ctab; /* conversion table */
91 char fill_char; /* Character to fill with if defined */
92 size_t speed = 0; /* maximum speed, in bytes per second */
93 volatile sig_atomic_t need_summary;
94 volatile sig_atomic_t need_progress;
95 volatile sig_atomic_t kill_signal;
98 main(int argc __unused, char *argv[])
100 struct itimerval itv = { { 1, 0 }, { 1, 0 } }; /* SIGALARM every second, if needed */
102 (void)siginterrupt(SIGINT, 1);
103 (void)signal(SIGINT, terminate);
105 (void)setlocale(LC_CTYPE, "");
109 caph_cache_catpages();
110 if (caph_enter() < 0)
111 err(1, "unable to enter capability mode");
113 (void)signal(SIGINFO, siginfo_handler);
114 if (ddflags & C_PROGRESS) {
115 (void)signal(SIGALRM, sigalarm_handler);
116 setitimer(ITIMER_REAL, &itv, NULL);
126 * Some devices such as cfi(4) may perform significant amounts
127 * of work when a write descriptor is closed. Close the out
128 * descriptor explicitly so that the summary handler (called
129 * from an atexit() hook) includes this work.
131 if (close(out.fd) == -1 && errno != EINTR)
141 i = c ^ (c >> 1) ^ (c >> 2) ^ (c >> 3) ^
142 (c >> 4) ^ (c >> 5) ^ (c >> 6) ^ (c >> 7);
152 unsigned long cmds[] = { FIODTYPE, MTIOCTOP };
154 if (in.name == NULL) {
156 in.fd = STDIN_FILENO;
159 if (ddflags & C_IDIRECT)
162 in.fd = open(in.name, O_RDONLY | iflags, 0);
165 err(1, "%s", in.name);
170 cap_rights_init(&rights, CAP_READ, CAP_SEEK);
171 if (caph_rights_limit(in.fd, &rights) == -1)
172 err(1, "unable to limit capability rights");
174 if (files_cnt > 1 && !(in.flags & ISTAPE))
175 errx(1, "files is not supported for non-tape devices");
177 cap_rights_set(&rights, CAP_FTRUNCATE, CAP_IOCTL, CAP_WRITE);
178 if (ddflags & (C_FDATASYNC | C_FSYNC))
179 cap_rights_set(&rights, CAP_FSYNC);
180 if (out.name == NULL) {
181 /* No way to check for read access here. */
182 out.fd = STDOUT_FILENO;
184 if (ddflags & C_OFSYNC) {
185 oflags = fcntl(out.fd, F_GETFL);
187 err(1, "unable to get fd flags for stdout");
189 if (fcntl(out.fd, F_SETFL, oflags) == -1)
190 err(1, "unable to set fd flags for stdout");
194 if (!(ddflags & (C_SEEK | C_NOTRUNC)))
196 if (ddflags & C_OFSYNC)
198 if (ddflags & C_ODIRECT)
201 out.fd = open(out.name, O_RDWR | oflags, DEFFILEMODE);
204 * May not have read access, so try again with write only.
205 * Without read we may have a problem if output also does
209 out.fd = open(out.name, O_WRONLY | oflags, DEFFILEMODE);
212 cap_rights_clear(&rights, CAP_READ);
215 err(1, "%s", out.name);
220 if (caph_rights_limit(out.fd, &rights) == -1)
221 err(1, "unable to limit capability rights");
222 if (caph_ioctls_limit(out.fd, cmds, nitems(cmds)) == -1)
223 err(1, "unable to limit capability rights");
225 if (in.fd != STDIN_FILENO && out.fd != STDIN_FILENO) {
226 if (caph_limit_stdin() == -1)
227 err(1, "unable to limit capability rights");
230 if (in.fd != STDOUT_FILENO && out.fd != STDOUT_FILENO) {
231 if (caph_limit_stdout() == -1)
232 err(1, "unable to limit capability rights");
235 if (in.fd != STDERR_FILENO && out.fd != STDERR_FILENO) {
236 if (caph_limit_stderr() == -1)
237 err(1, "unable to limit capability rights");
241 * Allocate space for the input and output buffers. If not doing
242 * record oriented I/O, only need a single buffer.
244 if (!(ddflags & (C_BLOCK | C_UNBLOCK))) {
245 if ((in.db = malloc((size_t)out.dbsz + in.dbsz - 1)) == NULL)
246 err(1, "input buffer");
248 } else if ((in.db = malloc(MAX((size_t)in.dbsz, cbsz) + cbsz)) == NULL ||
249 (out.db = malloc(out.dbsz + cbsz)) == NULL)
250 err(1, "output buffer");
252 /* dbp is the first free position in each buffer. */
256 /* Position the input/output streams. */
263 * Truncate the output file. If it fails on a type of output file
264 * that it should _not_ fail on, error out.
266 if ((ddflags & (C_OF | C_SEEK | C_NOTRUNC)) == (C_OF | C_SEEK) &&
268 if (ftruncate(out.fd, out.offset * out.dbsz) == -1)
269 err(1, "truncating %s", out.name);
271 if (ddflags & (C_LCASE | C_UCASE | C_ASCII | C_EBCDIC | C_PARITY)) {
273 for (cnt = 0; cnt <= 0377; ++cnt)
274 casetab[cnt] = ctab[cnt];
276 for (cnt = 0; cnt <= 0377; ++cnt)
279 if ((ddflags & C_PARITY) && !(ddflags & C_ASCII)) {
281 * If the input is not EBCDIC, and we do parity
282 * processing, strip input parity.
284 for (cnt = 200; cnt <= 0377; ++cnt)
285 casetab[cnt] = casetab[cnt & 0x7f];
287 if (ddflags & C_LCASE) {
288 for (cnt = 0; cnt <= 0377; ++cnt)
289 casetab[cnt] = tolower(casetab[cnt]);
290 } else if (ddflags & C_UCASE) {
291 for (cnt = 0; cnt <= 0377; ++cnt)
292 casetab[cnt] = toupper(casetab[cnt]);
294 if ((ddflags & C_PARITY)) {
296 * This should strictly speaking be a no-op, but I
297 * wonder what funny LANG settings could get us.
299 for (cnt = 0; cnt <= 0377; ++cnt)
300 casetab[cnt] = casetab[cnt] & 0x7f;
302 if ((ddflags & C_PARSET)) {
303 for (cnt = 0; cnt <= 0377; ++cnt)
304 casetab[cnt] = casetab[cnt] | 0x80;
306 if ((ddflags & C_PAREVEN)) {
307 for (cnt = 0; cnt <= 0377; ++cnt)
308 if (parity(casetab[cnt]))
309 casetab[cnt] = casetab[cnt] | 0x80;
311 if ((ddflags & C_PARODD)) {
312 for (cnt = 0; cnt <= 0377; ++cnt)
313 if (!parity(casetab[cnt]))
314 casetab[cnt] = casetab[cnt] | 0x80;
320 if (clock_gettime(CLOCK_MONOTONIC, &st.start))
321 err(1, "clock_gettime");
330 if (fstat(io->fd, &sb) == -1)
331 err(1, "%s", io->name);
332 if (S_ISREG(sb.st_mode))
333 io->flags |= ISTRUNC;
334 if (S_ISCHR(sb.st_mode) || S_ISBLK(sb.st_mode)) {
335 if (ioctl(io->fd, FIODTYPE, &type) == -1) {
336 err(1, "%s", io->name);
340 else if (type & (D_DISK | D_MEM))
342 if (S_ISCHR(sb.st_mode) && (type & D_TAPE) == 0)
348 if (lseek(io->fd, (off_t)0, SEEK_CUR) == -1 && errno == ESPIPE)
355 * Limit the speed by adding a delay before every block read.
356 * The delay (t_usleep) is equal to the time computed from block
357 * size and the specified speed limit (t_target) minus the time
358 * spent on actual read and write operations (t_io).
363 static double t_prev, t_usleep;
364 double t_now, t_io, t_target;
366 t_now = secs_elapsed();
367 t_io = t_now - t_prev - t_usleep;
368 t_target = (double)in.dbsz / (double)speed;
369 t_usleep = t_target - t_io;
371 usleep(t_usleep * 1000000);
378 swapbytes(void *v, size_t len)
380 unsigned char *p = v;
399 case -1: /* count=0 was specified */
404 if (st.in_full + st.in_part >= (uintmax_t)cpy_cnt)
413 * Zero the buffer first if sync; if doing block operations,
416 if (ddflags & C_SYNC) {
417 if (ddflags & C_FILL)
418 memset(in.dbp, fill_char, in.dbsz);
419 else if (ddflags & (C_BLOCK | C_UNBLOCK))
420 memset(in.dbp, ' ', in.dbsz);
422 memset(in.dbp, 0, in.dbsz);
428 n = read(in.fd, in.dbp + in.dbrcnt, in.dbsz - in.dbrcnt);
432 if (n == 0 && in.dbrcnt == 0)
438 * If noerror not specified, die. POSIX requires that
439 * the warning message be followed by an I/O display.
441 if (!(ddflags & C_NOERROR))
442 err(1, "%s", in.name);
447 * If it's a seekable file descriptor, seek past the
448 * error. If your OS doesn't do the right thing for
449 * raw disks this section should be modified to re-read
450 * in sector size chunks.
452 if (in.flags & ISSEEK &&
453 lseek(in.fd, (off_t)in.dbsz, SEEK_CUR))
456 /* If sync not specified, omit block and continue. */
457 if (!(ddflags & C_SYNC))
461 /* If conv=sync, use the entire block. */
462 if (ddflags & C_SYNC)
465 /* Count the bytes read for this block. */
468 /* Count the number of full and partial blocks. */
469 if (in.dbrcnt == in.dbsz)
471 else if (ddflags & C_IFULLBLOCK && n != 0)
472 goto fill; /* these don't count */
476 /* Count the total bytes read for this file. */
477 in.dbcnt += in.dbrcnt;
480 * POSIX states that if bs is set and no other conversions
481 * than noerror, notrunc or sync are specified, the block
482 * is output without buffering as it is read.
484 if ((ddflags & ~(C_NOERROR | C_NOTRUNC | C_SYNC)) == C_BS) {
485 out.dbcnt = in.dbcnt;
491 if (ddflags & C_SWAB) {
492 if ((n = in.dbrcnt) & 1) {
496 swapbytes(in.dbp, (size_t)n);
499 /* Advance to the next block. */
510 * Clean up any remaining I/O and flush output. If necessary, the output file
518 else if (cfunc == block)
520 else if (cfunc == unblock)
522 if (ddflags & C_OSYNC && out.dbcnt && out.dbcnt < out.dbsz) {
523 if (ddflags & C_FILL)
524 memset(out.dbp, fill_char, out.dbsz - out.dbcnt);
525 else if (ddflags & (C_BLOCK | C_UNBLOCK))
526 memset(out.dbp, ' ', out.dbsz - out.dbcnt);
528 memset(out.dbp, 0, out.dbsz - out.dbcnt);
529 out.dbcnt = out.dbsz;
531 if (out.dbcnt || pending)
535 * If the file ends with a hole, ftruncate it to extend its size
536 * up to the end of the hole (without having to write any data).
538 if (out.seek_offset > 0 && (out.flags & ISTRUNC)) {
539 if (ftruncate(out.fd, out.seek_offset) == -1)
540 err(1, "truncating %s", out.name);
543 if (ddflags & C_FSYNC) {
544 if (fsync(out.fd) == -1)
545 err(1, "fsyncing %s", out.name);
546 } else if (ddflags & C_FDATASYNC) {
547 if (fdatasync(out.fd) == -1)
548 err(1, "fdatasyncing %s", out.name);
562 * Write one or more blocks out. The common case is writing a full
563 * output block in a single write; increment the full block stats.
564 * Otherwise, we're into partial block writes. If a partial write,
565 * and it's a character device, just warn. If a tape device, quit.
567 * The partial writes represent two cases. 1: Where the input block
568 * was less than expected so the output block was less than expected.
569 * 2: Where the input block was the right size but we were forced to
570 * write the block in multiple chunks. The original versions of dd(1)
571 * never wrote a block in more than a single write, so the latter case
574 * One special case is if we're forced to do the write -- in that case
575 * we play games with the buffer size, and it's usually a partial write.
580 * If force, first try to write all pending data, else try to write
581 * just one block. Subsequently always write data one full block at
584 for (n = force ? out.dbcnt : out.dbsz;; n = out.dbsz) {
588 if (ddflags & C_SPARSE) {
589 /* Is buffer sparse? */
590 sparse = BISZERO(outp, cnt);
592 if (sparse && !force) {
598 * Seek past hole. Note that we need to record the
599 * reached offset, because we might have no more data
600 * to write, in which case we'll need to call
601 * ftruncate to extend the file size.
603 out.seek_offset = lseek(out.fd, pending, SEEK_CUR);
604 if (out.seek_offset == -1)
605 err(2, "%s: seek error creating sparse file",
611 nw = write(out.fd, outp, cnt);
621 errx(1, "%s: end of device", out.name);
623 err(1, "%s", out.name);
630 if ((size_t)nw == n && n == (size_t)out.dbsz)
635 if ((size_t) nw != cnt) {
636 if (out.flags & ISTAPE)
637 errx(1, "%s: short write on tape device",
639 if (out.flags & ISCHR && !warned) {
641 warnx("%s: short write on character device",
649 if ((out.dbcnt -= n) < out.dbsz)
653 /* Reassemble the output block. */
655 (void)memmove(out.db, out.dbp - out.dbcnt, out.dbcnt);
656 out.dbp = out.db + out.dbcnt;