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>
76 static void dd_close(void);
77 static void dd_in(void);
78 static void getfdtype(IO *);
79 static void setup(void);
81 IO in, out; /* input/output state */
82 STAT st; /* statistics */
83 void (*cfunc)(void); /* conversion function */
84 uintmax_t cpy_cnt; /* # of blocks to copy */
85 static off_t pending = 0; /* pending seek if sparse */
86 u_int ddflags = 0; /* conversion options */
87 size_t cbsz; /* conversion block size */
88 uintmax_t files_cnt = 1; /* # of files to copy */
89 const u_char *ctab; /* conversion table */
90 char fill_char; /* Character to fill with if defined */
91 size_t speed = 0; /* maximum speed, in bytes per second */
92 volatile sig_atomic_t need_summary;
93 volatile sig_atomic_t need_progress;
96 main(int argc __unused, char *argv[])
98 struct itimerval itv = { { 1, 0 }, { 1, 0 } }; /* SIGALARM every second, if needed */
100 (void)setlocale(LC_CTYPE, "");
104 caph_cache_catpages();
105 if (caph_enter() < 0)
106 err(1, "unable to enter capability mode");
108 (void)signal(SIGINFO, siginfo_handler);
109 if (ddflags & C_PROGRESS) {
110 (void)signal(SIGALRM, sigalarm_handler);
111 setitimer(ITIMER_REAL, &itv, NULL);
113 (void)signal(SIGINT, terminate);
122 * Some devices such as cfi(4) may perform significant amounts
123 * of work when a write descriptor is closed. Close the out
124 * descriptor explicitly so that the summary handler (called
125 * from an atexit() hook) includes this work.
136 i = c ^ (c >> 1) ^ (c >> 2) ^ (c >> 3) ^
137 (c >> 4) ^ (c >> 5) ^ (c >> 6) ^ (c >> 7);
146 unsigned long cmds[] = { FIODTYPE, MTIOCTOP };
148 if (in.name == NULL) {
150 in.fd = STDIN_FILENO;
152 in.fd = open(in.name, O_RDONLY, 0);
154 err(1, "%s", in.name);
159 cap_rights_init(&rights, CAP_READ, CAP_SEEK);
160 if (cap_rights_limit(in.fd, &rights) == -1 && errno != ENOSYS)
161 err(1, "unable to limit capability rights");
163 if (files_cnt > 1 && !(in.flags & ISTAPE))
164 errx(1, "files is not supported for non-tape devices");
166 cap_rights_set(&rights, CAP_FTRUNCATE, CAP_IOCTL, CAP_WRITE);
167 if (out.name == NULL) {
168 /* No way to check for read access here. */
169 out.fd = STDOUT_FILENO;
173 (O_CREAT | (ddflags & (C_SEEK | C_NOTRUNC) ? 0 : O_TRUNC))
174 out.fd = open(out.name, O_RDWR | OFLAGS, DEFFILEMODE);
176 * May not have read access, so try again with write only.
177 * Without read we may have a problem if output also does
181 out.fd = open(out.name, O_WRONLY | OFLAGS, DEFFILEMODE);
183 cap_rights_clear(&rights, CAP_READ);
186 err(1, "%s", out.name);
191 if (cap_rights_limit(out.fd, &rights) == -1 && errno != ENOSYS)
192 err(1, "unable to limit capability rights");
193 if (cap_ioctls_limit(out.fd, cmds, nitems(cmds)) == -1 &&
195 err(1, "unable to limit capability rights");
197 if (in.fd != STDIN_FILENO && out.fd != STDIN_FILENO) {
198 if (caph_limit_stdin() == -1)
199 err(1, "unable to limit capability rights");
202 if (in.fd != STDOUT_FILENO && out.fd != STDOUT_FILENO) {
203 if (caph_limit_stdout() == -1)
204 err(1, "unable to limit capability rights");
207 if (in.fd != STDERR_FILENO && out.fd != STDERR_FILENO) {
208 if (caph_limit_stderr() == -1)
209 err(1, "unable to limit capability rights");
213 * Allocate space for the input and output buffers. If not doing
214 * record oriented I/O, only need a single buffer.
216 if (!(ddflags & (C_BLOCK | C_UNBLOCK))) {
217 if ((in.db = malloc((size_t)out.dbsz + in.dbsz - 1)) == NULL)
218 err(1, "input buffer");
220 } else if ((in.db = malloc(MAX((size_t)in.dbsz, cbsz) + cbsz)) == NULL ||
221 (out.db = malloc(out.dbsz + cbsz)) == NULL)
222 err(1, "output buffer");
224 /* dbp is the first free position in each buffer. */
228 /* Position the input/output streams. */
235 * Truncate the output file. If it fails on a type of output file
236 * that it should _not_ fail on, error out.
238 if ((ddflags & (C_OF | C_SEEK | C_NOTRUNC)) == (C_OF | C_SEEK) &&
240 if (ftruncate(out.fd, out.offset * out.dbsz) == -1)
241 err(1, "truncating %s", out.name);
243 if (ddflags & (C_LCASE | C_UCASE | C_ASCII | C_EBCDIC | C_PARITY)) {
245 for (cnt = 0; cnt <= 0377; ++cnt)
246 casetab[cnt] = ctab[cnt];
248 for (cnt = 0; cnt <= 0377; ++cnt)
251 if ((ddflags & C_PARITY) && !(ddflags & C_ASCII)) {
253 * If the input is not EBCDIC, and we do parity
254 * processing, strip input parity.
256 for (cnt = 200; cnt <= 0377; ++cnt)
257 casetab[cnt] = casetab[cnt & 0x7f];
259 if (ddflags & C_LCASE) {
260 for (cnt = 0; cnt <= 0377; ++cnt)
261 casetab[cnt] = tolower(casetab[cnt]);
262 } else if (ddflags & C_UCASE) {
263 for (cnt = 0; cnt <= 0377; ++cnt)
264 casetab[cnt] = toupper(casetab[cnt]);
266 if ((ddflags & C_PARITY)) {
268 * This should strictly speaking be a no-op, but I
269 * wonder what funny LANG settings could get us.
271 for (cnt = 0; cnt <= 0377; ++cnt)
272 casetab[cnt] = casetab[cnt] & 0x7f;
274 if ((ddflags & C_PARSET)) {
275 for (cnt = 0; cnt <= 0377; ++cnt)
276 casetab[cnt] = casetab[cnt] | 0x80;
278 if ((ddflags & C_PAREVEN)) {
279 for (cnt = 0; cnt <= 0377; ++cnt)
280 if (parity(casetab[cnt]))
281 casetab[cnt] = casetab[cnt] | 0x80;
283 if ((ddflags & C_PARODD)) {
284 for (cnt = 0; cnt <= 0377; ++cnt)
285 if (!parity(casetab[cnt]))
286 casetab[cnt] = casetab[cnt] | 0x80;
292 if (clock_gettime(CLOCK_MONOTONIC, &st.start))
293 err(1, "clock_gettime");
302 if (fstat(io->fd, &sb) == -1)
303 err(1, "%s", io->name);
304 if (S_ISREG(sb.st_mode))
305 io->flags |= ISTRUNC;
306 if (S_ISCHR(sb.st_mode) || S_ISBLK(sb.st_mode)) {
307 if (ioctl(io->fd, FIODTYPE, &type) == -1) {
308 err(1, "%s", io->name);
312 else if (type & (D_DISK | D_MEM))
314 if (S_ISCHR(sb.st_mode) && (type & D_TAPE) == 0)
320 if (lseek(io->fd, (off_t)0, SEEK_CUR) == -1 && errno == ESPIPE)
327 * Limit the speed by adding a delay before every block read.
328 * The delay (t_usleep) is equal to the time computed from block
329 * size and the specified speed limit (t_target) minus the time
330 * spent on actual read and write operations (t_io).
335 static double t_prev, t_usleep;
336 double t_now, t_io, t_target;
338 t_now = secs_elapsed();
339 t_io = t_now - t_prev - t_usleep;
340 t_target = (double)in.dbsz / (double)speed;
341 t_usleep = t_target - t_io;
343 usleep(t_usleep * 1000000);
350 swapbytes(void *v, size_t len)
352 unsigned char *p = v;
371 case -1: /* count=0 was specified */
376 if (st.in_full + st.in_part >= (uintmax_t)cpy_cnt)
385 * Zero the buffer first if sync; if doing block operations,
388 if (ddflags & C_SYNC) {
389 if (ddflags & C_FILL)
390 memset(in.dbp, fill_char, in.dbsz);
391 else if (ddflags & (C_BLOCK | C_UNBLOCK))
392 memset(in.dbp, ' ', in.dbsz);
394 memset(in.dbp, 0, in.dbsz);
397 n = read(in.fd, in.dbp, in.dbsz);
406 * If noerror not specified, die. POSIX requires that
407 * the warning message be followed by an I/O display.
409 if (!(ddflags & C_NOERROR))
410 err(1, "%s", in.name);
415 * If it's a seekable file descriptor, seek past the
416 * error. If your OS doesn't do the right thing for
417 * raw disks this section should be modified to re-read
418 * in sector size chunks.
420 if (in.flags & ISSEEK &&
421 lseek(in.fd, (off_t)in.dbsz, SEEK_CUR))
424 /* If sync not specified, omit block and continue. */
425 if (!(ddflags & C_SYNC))
428 /* Read errors count as full blocks. */
429 in.dbcnt += in.dbrcnt = in.dbsz;
432 /* Handle full input blocks. */
433 } else if ((size_t)n == (size_t)in.dbsz) {
434 in.dbcnt += in.dbrcnt = n;
437 /* Handle partial input blocks. */
439 /* If sync, use the entire block. */
440 if (ddflags & C_SYNC)
441 in.dbcnt += in.dbrcnt = in.dbsz;
443 in.dbcnt += in.dbrcnt = n;
448 * POSIX states that if bs is set and no other conversions
449 * than noerror, notrunc or sync are specified, the block
450 * is output without buffering as it is read.
452 if ((ddflags & ~(C_NOERROR | C_NOTRUNC | C_SYNC)) == C_BS) {
453 out.dbcnt = in.dbcnt;
459 if (ddflags & C_SWAB) {
460 if ((n = in.dbrcnt) & 1) {
464 swapbytes(in.dbp, (size_t)n);
477 * Clean up any remaining I/O and flush output. If necessary, the output file
485 else if (cfunc == block)
487 else if (cfunc == unblock)
489 if (ddflags & C_OSYNC && out.dbcnt && out.dbcnt < out.dbsz) {
490 if (ddflags & C_FILL)
491 memset(out.dbp, fill_char, out.dbsz - out.dbcnt);
492 else if (ddflags & (C_BLOCK | C_UNBLOCK))
493 memset(out.dbp, ' ', out.dbsz - out.dbcnt);
495 memset(out.dbp, 0, out.dbsz - out.dbcnt);
496 out.dbcnt = out.dbsz;
498 if (out.dbcnt || pending)
502 * If the file ends with a hole, ftruncate it to extend its size
503 * up to the end of the hole (without having to write any data).
505 if (out.seek_offset > 0 && (out.flags & ISTRUNC)) {
506 if (ftruncate(out.fd, out.seek_offset) == -1)
507 err(1, "truncating %s", out.name);
521 * Write one or more blocks out. The common case is writing a full
522 * output block in a single write; increment the full block stats.
523 * Otherwise, we're into partial block writes. If a partial write,
524 * and it's a character device, just warn. If a tape device, quit.
526 * The partial writes represent two cases. 1: Where the input block
527 * was less than expected so the output block was less than expected.
528 * 2: Where the input block was the right size but we were forced to
529 * write the block in multiple chunks. The original versions of dd(1)
530 * never wrote a block in more than a single write, so the latter case
533 * One special case is if we're forced to do the write -- in that case
534 * we play games with the buffer size, and it's usually a partial write.
539 * If force, first try to write all pending data, else try to write
540 * just one block. Subsequently always write data one full block at
543 for (n = force ? out.dbcnt : out.dbsz;; n = out.dbsz) {
547 if (ddflags & C_SPARSE) {
548 sparse = 1; /* Is buffer sparse? */
549 for (i = 0; i < cnt; i++)
555 if (sparse && !force) {
561 * Seek past hole. Note that we need to record the
562 * reached offset, because we might have no more data
563 * to write, in which case we'll need to call
564 * ftruncate to extend the file size.
566 out.seek_offset = lseek(out.fd, pending, SEEK_CUR);
567 if (out.seek_offset == -1)
568 err(2, "%s: seek error creating sparse file",
573 nw = write(out.fd, outp, cnt);
582 errx(1, "%s: end of device", out.name);
584 err(1, "%s", out.name);
591 if ((size_t)nw == n && n == (size_t)out.dbsz)
596 if ((size_t) nw != cnt) {
597 if (out.flags & ISTAPE)
598 errx(1, "%s: short write on tape device",
600 if (out.flags & ISCHR && !warned) {
602 warnx("%s: short write on character device",
610 if ((out.dbcnt -= n) < out.dbsz)
614 /* Reassemble the output block. */
616 (void)memmove(out.db, out.dbp - out.dbcnt, out.dbcnt);
617 out.dbp = out.db + out.dbcnt;