xref: /freebsd/bin/dd/position.c (revision 97759ccc715c4b365432c16d763c50eecfcb1100)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1991, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  *
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.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
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.
22  *
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
33  * SUCH DAMAGE.
34  */
35 
36 #ifndef lint
37 #endif /* not lint */
38 #include <sys/cdefs.h>
39 #include <sys/types.h>
40 #include <sys/mtio.h>
41 
42 #include <err.h>
43 #include <errno.h>
44 #include <inttypes.h>
45 #include <limits.h>
46 #include <signal.h>
47 #include <unistd.h>
48 
49 #include "dd.h"
50 #include "extern.h"
51 
52 static off_t
53 seek_offset(IO *io)
54 {
55 	off_t n;
56 	size_t sz;
57 
58 	n = io->offset;
59 	sz = io->dbsz;
60 
61 	_Static_assert(sizeof(io->offset) == sizeof(int64_t), "64-bit off_t");
62 
63 	/*
64 	 * If the lseek offset will be negative, verify that this is a special
65 	 * device file.  Some such files (e.g. /dev/kmem) permit "negative"
66 	 * offsets.
67 	 *
68 	 * Bail out if the calculation of a file offset would overflow.
69 	 */
70 	if ((io->flags & ISCHR) == 0 && (n < 0 || n > OFF_MAX / (ssize_t)sz))
71 		errx(1, "seek offsets cannot be larger than %jd",
72 		    (intmax_t)OFF_MAX);
73 	else if ((io->flags & ISCHR) != 0 && (uint64_t)n > UINT64_MAX / sz)
74 		errx(1, "seek offsets cannot be larger than %ju",
75 		    (uintmax_t)UINT64_MAX);
76 
77 	return ((off_t)( (uint64_t)n * sz ));
78 }
79 
80 /*
81  * Position input/output data streams before starting the copy.  Device type
82  * dependent.  Seekable devices use lseek, and the rest position by reading.
83  * Seeking past the end of file can cause null blocks to be written to the
84  * output.
85  */
86 void
87 pos_in(void)
88 {
89 	off_t cnt;
90 	int warned;
91 	ssize_t nr;
92 	size_t bcnt;
93 
94 	/* If known to be seekable, try to seek on it. */
95 	if (in.flags & ISSEEK) {
96 		errno = 0;
97 		if (lseek(in.fd, seek_offset(&in), SEEK_CUR) == -1 &&
98 		    errno != 0)
99 			err(1, "%s", in.name);
100 		return;
101 	}
102 
103 	/* Don't try to read a really weird amount (like negative). */
104 	if (in.offset < 0)
105 		errx(1, "%s: illegal offset", "iseek/skip");
106 
107 	/*
108 	 * Read the data.  If a pipe, read until satisfy the number of bytes
109 	 * being skipped.  No differentiation for reading complete and partial
110 	 * blocks for other devices.
111 	 */
112 	for (bcnt = in.dbsz, cnt = in.offset, warned = 0; cnt;) {
113 		if ((nr = read(in.fd, in.db, bcnt)) > 0) {
114 			if (in.flags & ISPIPE) {
115 				if (!(bcnt -= nr)) {
116 					bcnt = in.dbsz;
117 					--cnt;
118 				}
119 			} else
120 				--cnt;
121 			if (need_summary)
122 				summary();
123 			if (need_progress)
124 				progress();
125 			continue;
126 		}
127 
128 		if (nr == 0) {
129 			if (files_cnt > 1) {
130 				--files_cnt;
131 				continue;
132 			}
133 			errx(1, "skip reached end of input");
134 		}
135 
136 		/*
137 		 * Input error -- either EOF with no more files, or I/O error.
138 		 * If noerror not set die.  POSIX requires that the warning
139 		 * message be followed by an I/O display.
140 		 */
141 		if (ddflags & C_NOERROR) {
142 			if (!warned) {
143 				warn("%s", in.name);
144 				warned = 1;
145 				summary();
146 			}
147 			continue;
148 		}
149 		err(1, "%s", in.name);
150 	}
151 }
152 
153 void
154 pos_out(void)
155 {
156 	struct mtop t_op;
157 	off_t cnt;
158 	ssize_t n;
159 
160 	/*
161 	 * If not a tape, try seeking on the file.  Seeking on a pipe is
162 	 * going to fail, but don't protect the user -- they shouldn't
163 	 * have specified the seek operand.
164 	 */
165 	if (out.flags & (ISSEEK | ISPIPE)) {
166 		errno = 0;
167 		if (lseek(out.fd, seek_offset(&out), SEEK_CUR) == -1 &&
168 		    errno != 0)
169 			err(1, "%s", out.name);
170 		return;
171 	}
172 
173 	/* Don't try to read a really weird amount (like negative). */
174 	if (out.offset < 0)
175 		errx(1, "%s: illegal offset", "oseek/seek");
176 
177 	/* If no read access, try using mtio. */
178 	if (out.flags & NOREAD) {
179 		t_op.mt_op = MTFSR;
180 		t_op.mt_count = out.offset;
181 
182 		if (ioctl(out.fd, MTIOCTOP, &t_op) == -1)
183 			err(1, "%s", out.name);
184 		return;
185 	}
186 
187 	/* Read it. */
188 	for (cnt = 0; cnt < out.offset; ++cnt) {
189 		before_io();
190 		n = read(out.fd, out.db, out.dbsz);
191 		after_io();
192 		if (n > 0)
193 			continue;
194 		if (n == -1)
195 			err(1, "%s", out.name);
196 
197 		/*
198 		 * If reach EOF, fill with NUL characters; first, back up over
199 		 * the EOF mark.  Note, cnt has not yet been incremented, so
200 		 * the EOF read does not count as a seek'd block.
201 		 */
202 		t_op.mt_op = MTBSR;
203 		t_op.mt_count = 1;
204 		if (ioctl(out.fd, MTIOCTOP, &t_op) == -1)
205 			err(1, "%s", out.name);
206 
207 		while (cnt++ < out.offset) {
208 			before_io();
209 			n = write(out.fd, out.db, out.dbsz);
210 			after_io();
211 			if (n == -1)
212 				err(1, "%s", out.name);
213 			if (n != out.dbsz)
214 				errx(1, "%s: write failure", out.name);
215 		}
216 		break;
217 	}
218 }
219