stat: adjust the printing of SELinux context
[coreutils/ericb.git] / src / dd.c
blobb6643e2e11cf6cea37970cee405d0a0c232494bc
1 /* dd -- convert a file while copying it.
2 Copyright (C) 1985, 1990-1991, 1995-2010 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17 /* Written by Paul Rubin, David MacKenzie, and Stuart Kemp. */
19 #include <config.h>
21 #define SWAB_ALIGN_OFFSET 2
23 #include <sys/types.h>
24 #include <signal.h>
25 #include <getopt.h>
27 #include "system.h"
28 #include "close-stream.h"
29 #include "error.h"
30 #include "fadvise.h"
31 #include "fd-reopen.h"
32 #include "gethrxtime.h"
33 #include "human.h"
34 #include "long-options.h"
35 #include "quote.h"
36 #include "quotearg.h"
37 #include "xstrtol.h"
38 #include "xtime.h"
40 static void process_signals (void);
42 /* The official name of this program (e.g., no `g' prefix). */
43 #define PROGRAM_NAME "dd"
45 #define AUTHORS \
46 proper_name ("Paul Rubin"), \
47 proper_name ("David MacKenzie"), \
48 proper_name ("Stuart Kemp")
50 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
51 present. SA_NODEFER and SA_RESETHAND are XSI extensions. */
52 #ifndef SA_NOCLDSTOP
53 # define SA_NOCLDSTOP 0
54 # define sigprocmask(How, Set, Oset) /* empty */
55 # define sigset_t int
56 # if ! HAVE_SIGINTERRUPT
57 # define siginterrupt(sig, flag) /* empty */
58 # endif
59 #endif
61 #ifndef SIGINFO
62 # define SIGINFO SIGUSR1
63 #endif
65 /* This may belong in GNULIB's fcntl module instead.
66 Define O_CIO to 0 if it is not supported by this OS. */
67 #ifndef O_CIO
68 # define O_CIO 0
69 #endif
71 #if ! HAVE_FDATASYNC
72 # define fdatasync(fd) (errno = ENOSYS, -1)
73 #endif
75 #define output_char(c) \
76 do \
77 { \
78 obuf[oc++] = (c); \
79 if (oc >= output_blocksize) \
80 write_output (); \
81 } \
82 while (0)
84 /* Default input and output blocksize. */
85 #define DEFAULT_BLOCKSIZE 512
87 /* How many bytes to add to the input and output block sizes before invoking
88 malloc. See dd_copy for details. INPUT_BLOCK_SLOP must be no less than
89 OUTPUT_BLOCK_SLOP. */
90 #define INPUT_BLOCK_SLOP (2 * SWAB_ALIGN_OFFSET + 2 * page_size - 1)
91 #define OUTPUT_BLOCK_SLOP (page_size - 1)
93 /* Maximum blocksize for the given SLOP.
94 Keep it smaller than SIZE_MAX - SLOP, so that we can
95 allocate buffers that size. Keep it smaller than SSIZE_MAX, for
96 the benefit of system calls like "read". And keep it smaller than
97 OFF_T_MAX, for the benefit of the large-offset seek code. */
98 #define MAX_BLOCKSIZE(slop) MIN (SIZE_MAX - (slop), MIN (SSIZE_MAX, OFF_T_MAX))
100 /* Conversions bit masks. */
101 enum
103 C_ASCII = 01,
105 C_EBCDIC = 02,
106 C_IBM = 04,
107 C_BLOCK = 010,
108 C_UNBLOCK = 020,
109 C_LCASE = 040,
110 C_UCASE = 0100,
111 C_SWAB = 0200,
112 C_NOERROR = 0400,
113 C_NOTRUNC = 01000,
114 C_SYNC = 02000,
116 /* Use separate input and output buffers, and combine partial
117 input blocks. */
118 C_TWOBUFS = 04000,
120 C_NOCREAT = 010000,
121 C_EXCL = 020000,
122 C_FDATASYNC = 040000,
123 C_FSYNC = 0100000
126 /* Status bit masks. */
127 enum
129 STATUS_NOXFER = 01
132 /* The name of the input file, or NULL for the standard input. */
133 static char const *input_file = NULL;
135 /* The name of the output file, or NULL for the standard output. */
136 static char const *output_file = NULL;
138 /* The page size on this host. */
139 static size_t page_size;
141 /* The number of bytes in which atomic reads are done. */
142 static size_t input_blocksize = 0;
144 /* The number of bytes in which atomic writes are done. */
145 static size_t output_blocksize = 0;
147 /* Conversion buffer size, in bytes. 0 prevents conversions. */
148 static size_t conversion_blocksize = 0;
150 /* Skip this many records of `input_blocksize' bytes before input. */
151 static uintmax_t skip_records = 0;
153 /* Skip this many records of `output_blocksize' bytes before output. */
154 static uintmax_t seek_records = 0;
156 /* Copy only this many records. The default is effectively infinity. */
157 static uintmax_t max_records = (uintmax_t) -1;
159 /* Bit vector of conversions to apply. */
160 static int conversions_mask = 0;
162 /* Open flags for the input and output files. */
163 static int input_flags = 0;
164 static int output_flags = 0;
166 /* Status flags for what is printed to stderr. */
167 static int status_flags = 0;
169 /* If nonzero, filter characters through the translation table. */
170 static bool translation_needed = false;
172 /* Number of partial blocks written. */
173 static uintmax_t w_partial = 0;
175 /* Number of full blocks written. */
176 static uintmax_t w_full = 0;
178 /* Number of partial blocks read. */
179 static uintmax_t r_partial = 0;
181 /* Number of full blocks read. */
182 static uintmax_t r_full = 0;
184 /* Number of bytes written. */
185 static uintmax_t w_bytes = 0;
187 /* Time that dd started. */
188 static xtime_t start_time;
190 /* True if input is seekable. */
191 static bool input_seekable;
193 /* Error number corresponding to initial attempt to lseek input.
194 If ESPIPE, do not issue any more diagnostics about it. */
195 static int input_seek_errno;
197 /* File offset of the input, in bytes, along with a flag recording
198 whether it overflowed. */
199 static uintmax_t input_offset;
200 static bool input_offset_overflow;
202 /* Records truncated by conv=block. */
203 static uintmax_t r_truncate = 0;
205 /* Output representation of newline and space characters.
206 They change if we're converting to EBCDIC. */
207 static char newline_character = '\n';
208 static char space_character = ' ';
210 /* Output buffer. */
211 static char *obuf;
213 /* Current index into `obuf'. */
214 static size_t oc = 0;
216 /* Index into current line, for `conv=block' and `conv=unblock'. */
217 static size_t col = 0;
219 /* The set of signals that are caught. */
220 static sigset_t caught_signals;
222 /* If nonzero, the value of the pending fatal signal. */
223 static sig_atomic_t volatile interrupt_signal;
225 /* A count of the number of pending info signals that have been received. */
226 static sig_atomic_t volatile info_signal_count;
228 /* Function used for read (to handle iflag=fullblock parameter). */
229 static ssize_t (*iread_fnc) (int fd, char *buf, size_t size);
231 /* A longest symbol in the struct symbol_values tables below. */
232 #define LONGEST_SYMBOL "fdatasync"
234 /* A symbol and the corresponding integer value. */
235 struct symbol_value
237 char symbol[sizeof LONGEST_SYMBOL];
238 int value;
241 /* Conversion symbols, for conv="...". */
242 static struct symbol_value const conversions[] =
244 {"ascii", C_ASCII | C_TWOBUFS}, /* EBCDIC to ASCII. */
245 {"ebcdic", C_EBCDIC | C_TWOBUFS}, /* ASCII to EBCDIC. */
246 {"ibm", C_IBM | C_TWOBUFS}, /* Slightly different ASCII to EBCDIC. */
247 {"block", C_BLOCK | C_TWOBUFS}, /* Variable to fixed length records. */
248 {"unblock", C_UNBLOCK | C_TWOBUFS}, /* Fixed to variable length records. */
249 {"lcase", C_LCASE | C_TWOBUFS}, /* Translate upper to lower case. */
250 {"ucase", C_UCASE | C_TWOBUFS}, /* Translate lower to upper case. */
251 {"swab", C_SWAB | C_TWOBUFS}, /* Swap bytes of input. */
252 {"noerror", C_NOERROR}, /* Ignore i/o errors. */
253 {"nocreat", C_NOCREAT}, /* Do not create output file. */
254 {"excl", C_EXCL}, /* Fail if the output file already exists. */
255 {"notrunc", C_NOTRUNC}, /* Do not truncate output file. */
256 {"sync", C_SYNC}, /* Pad input records to ibs with NULs. */
257 {"fdatasync", C_FDATASYNC}, /* Synchronize output data before finishing. */
258 {"fsync", C_FSYNC}, /* Also synchronize output metadata. */
259 {"", 0}
262 enum
264 /* Compute a value that's bitwise disjoint from the union
265 of all O_ values. */
266 v = ~(0
267 | O_APPEND
268 | O_BINARY
269 | O_CIO
270 | O_DIRECT
271 | O_DIRECTORY
272 | O_DSYNC
273 | O_NOATIME
274 | O_NOCTTY
275 | O_NOFOLLOW
276 | O_NOLINKS
277 | O_NONBLOCK
278 | O_SYNC
279 | O_TEXT
281 /* Use its lowest bit. */
282 O_FULLBLOCK = v ^ (v & (v - 1))
285 /* Ensure that we got something. */
286 verify (O_FULLBLOCK != 0);
288 #define MULTIPLE_BITS_SET(i) (((i) & ((i) - 1)) != 0)
290 /* Ensure that this is a single-bit value. */
291 verify ( ! MULTIPLE_BITS_SET (O_FULLBLOCK));
293 /* Flags, for iflag="..." and oflag="...". */
294 static struct symbol_value const flags[] =
296 {"append", O_APPEND},
297 {"binary", O_BINARY},
298 {"cio", O_CIO},
299 {"direct", O_DIRECT},
300 {"directory", O_DIRECTORY},
301 {"dsync", O_DSYNC},
302 {"noatime", O_NOATIME},
303 {"noctty", O_NOCTTY},
304 {"nofollow", HAVE_WORKING_O_NOFOLLOW ? O_NOFOLLOW : 0},
305 {"nolinks", O_NOLINKS},
306 {"nonblock", O_NONBLOCK},
307 {"sync", O_SYNC},
308 {"text", O_TEXT},
309 {"fullblock", O_FULLBLOCK}, /* Accumulate full blocks from input. */
310 {"", 0}
313 /* Status, for status="...". */
314 static struct symbol_value const statuses[] =
316 {"noxfer", STATUS_NOXFER},
317 {"", 0}
320 /* Translation table formed by applying successive transformations. */
321 static unsigned char trans_table[256];
323 static char const ascii_to_ebcdic[] =
325 '\000', '\001', '\002', '\003', '\067', '\055', '\056', '\057',
326 '\026', '\005', '\045', '\013', '\014', '\015', '\016', '\017',
327 '\020', '\021', '\022', '\023', '\074', '\075', '\062', '\046',
328 '\030', '\031', '\077', '\047', '\034', '\035', '\036', '\037',
329 '\100', '\117', '\177', '\173', '\133', '\154', '\120', '\175',
330 '\115', '\135', '\134', '\116', '\153', '\140', '\113', '\141',
331 '\360', '\361', '\362', '\363', '\364', '\365', '\366', '\367',
332 '\370', '\371', '\172', '\136', '\114', '\176', '\156', '\157',
333 '\174', '\301', '\302', '\303', '\304', '\305', '\306', '\307',
334 '\310', '\311', '\321', '\322', '\323', '\324', '\325', '\326',
335 '\327', '\330', '\331', '\342', '\343', '\344', '\345', '\346',
336 '\347', '\350', '\351', '\112', '\340', '\132', '\137', '\155',
337 '\171', '\201', '\202', '\203', '\204', '\205', '\206', '\207',
338 '\210', '\211', '\221', '\222', '\223', '\224', '\225', '\226',
339 '\227', '\230', '\231', '\242', '\243', '\244', '\245', '\246',
340 '\247', '\250', '\251', '\300', '\152', '\320', '\241', '\007',
341 '\040', '\041', '\042', '\043', '\044', '\025', '\006', '\027',
342 '\050', '\051', '\052', '\053', '\054', '\011', '\012', '\033',
343 '\060', '\061', '\032', '\063', '\064', '\065', '\066', '\010',
344 '\070', '\071', '\072', '\073', '\004', '\024', '\076', '\341',
345 '\101', '\102', '\103', '\104', '\105', '\106', '\107', '\110',
346 '\111', '\121', '\122', '\123', '\124', '\125', '\126', '\127',
347 '\130', '\131', '\142', '\143', '\144', '\145', '\146', '\147',
348 '\150', '\151', '\160', '\161', '\162', '\163', '\164', '\165',
349 '\166', '\167', '\170', '\200', '\212', '\213', '\214', '\215',
350 '\216', '\217', '\220', '\232', '\233', '\234', '\235', '\236',
351 '\237', '\240', '\252', '\253', '\254', '\255', '\256', '\257',
352 '\260', '\261', '\262', '\263', '\264', '\265', '\266', '\267',
353 '\270', '\271', '\272', '\273', '\274', '\275', '\276', '\277',
354 '\312', '\313', '\314', '\315', '\316', '\317', '\332', '\333',
355 '\334', '\335', '\336', '\337', '\352', '\353', '\354', '\355',
356 '\356', '\357', '\372', '\373', '\374', '\375', '\376', '\377'
359 static char const ascii_to_ibm[] =
361 '\000', '\001', '\002', '\003', '\067', '\055', '\056', '\057',
362 '\026', '\005', '\045', '\013', '\014', '\015', '\016', '\017',
363 '\020', '\021', '\022', '\023', '\074', '\075', '\062', '\046',
364 '\030', '\031', '\077', '\047', '\034', '\035', '\036', '\037',
365 '\100', '\132', '\177', '\173', '\133', '\154', '\120', '\175',
366 '\115', '\135', '\134', '\116', '\153', '\140', '\113', '\141',
367 '\360', '\361', '\362', '\363', '\364', '\365', '\366', '\367',
368 '\370', '\371', '\172', '\136', '\114', '\176', '\156', '\157',
369 '\174', '\301', '\302', '\303', '\304', '\305', '\306', '\307',
370 '\310', '\311', '\321', '\322', '\323', '\324', '\325', '\326',
371 '\327', '\330', '\331', '\342', '\343', '\344', '\345', '\346',
372 '\347', '\350', '\351', '\255', '\340', '\275', '\137', '\155',
373 '\171', '\201', '\202', '\203', '\204', '\205', '\206', '\207',
374 '\210', '\211', '\221', '\222', '\223', '\224', '\225', '\226',
375 '\227', '\230', '\231', '\242', '\243', '\244', '\245', '\246',
376 '\247', '\250', '\251', '\300', '\117', '\320', '\241', '\007',
377 '\040', '\041', '\042', '\043', '\044', '\025', '\006', '\027',
378 '\050', '\051', '\052', '\053', '\054', '\011', '\012', '\033',
379 '\060', '\061', '\032', '\063', '\064', '\065', '\066', '\010',
380 '\070', '\071', '\072', '\073', '\004', '\024', '\076', '\341',
381 '\101', '\102', '\103', '\104', '\105', '\106', '\107', '\110',
382 '\111', '\121', '\122', '\123', '\124', '\125', '\126', '\127',
383 '\130', '\131', '\142', '\143', '\144', '\145', '\146', '\147',
384 '\150', '\151', '\160', '\161', '\162', '\163', '\164', '\165',
385 '\166', '\167', '\170', '\200', '\212', '\213', '\214', '\215',
386 '\216', '\217', '\220', '\232', '\233', '\234', '\235', '\236',
387 '\237', '\240', '\252', '\253', '\254', '\255', '\256', '\257',
388 '\260', '\261', '\262', '\263', '\264', '\265', '\266', '\267',
389 '\270', '\271', '\272', '\273', '\274', '\275', '\276', '\277',
390 '\312', '\313', '\314', '\315', '\316', '\317', '\332', '\333',
391 '\334', '\335', '\336', '\337', '\352', '\353', '\354', '\355',
392 '\356', '\357', '\372', '\373', '\374', '\375', '\376', '\377'
395 static char const ebcdic_to_ascii[] =
397 '\000', '\001', '\002', '\003', '\234', '\011', '\206', '\177',
398 '\227', '\215', '\216', '\013', '\014', '\015', '\016', '\017',
399 '\020', '\021', '\022', '\023', '\235', '\205', '\010', '\207',
400 '\030', '\031', '\222', '\217', '\034', '\035', '\036', '\037',
401 '\200', '\201', '\202', '\203', '\204', '\012', '\027', '\033',
402 '\210', '\211', '\212', '\213', '\214', '\005', '\006', '\007',
403 '\220', '\221', '\026', '\223', '\224', '\225', '\226', '\004',
404 '\230', '\231', '\232', '\233', '\024', '\025', '\236', '\032',
405 '\040', '\240', '\241', '\242', '\243', '\244', '\245', '\246',
406 '\247', '\250', '\133', '\056', '\074', '\050', '\053', '\041',
407 '\046', '\251', '\252', '\253', '\254', '\255', '\256', '\257',
408 '\260', '\261', '\135', '\044', '\052', '\051', '\073', '\136',
409 '\055', '\057', '\262', '\263', '\264', '\265', '\266', '\267',
410 '\270', '\271', '\174', '\054', '\045', '\137', '\076', '\077',
411 '\272', '\273', '\274', '\275', '\276', '\277', '\300', '\301',
412 '\302', '\140', '\072', '\043', '\100', '\047', '\075', '\042',
413 '\303', '\141', '\142', '\143', '\144', '\145', '\146', '\147',
414 '\150', '\151', '\304', '\305', '\306', '\307', '\310', '\311',
415 '\312', '\152', '\153', '\154', '\155', '\156', '\157', '\160',
416 '\161', '\162', '\313', '\314', '\315', '\316', '\317', '\320',
417 '\321', '\176', '\163', '\164', '\165', '\166', '\167', '\170',
418 '\171', '\172', '\322', '\323', '\324', '\325', '\326', '\327',
419 '\330', '\331', '\332', '\333', '\334', '\335', '\336', '\337',
420 '\340', '\341', '\342', '\343', '\344', '\345', '\346', '\347',
421 '\173', '\101', '\102', '\103', '\104', '\105', '\106', '\107',
422 '\110', '\111', '\350', '\351', '\352', '\353', '\354', '\355',
423 '\175', '\112', '\113', '\114', '\115', '\116', '\117', '\120',
424 '\121', '\122', '\356', '\357', '\360', '\361', '\362', '\363',
425 '\134', '\237', '\123', '\124', '\125', '\126', '\127', '\130',
426 '\131', '\132', '\364', '\365', '\366', '\367', '\370', '\371',
427 '\060', '\061', '\062', '\063', '\064', '\065', '\066', '\067',
428 '\070', '\071', '\372', '\373', '\374', '\375', '\376', '\377'
431 /* True if we need to close the standard output *stream*. */
432 static bool close_stdout_required = true;
434 /* The only reason to close the standard output *stream* is if
435 parse_long_options fails (as it does for --help or --version).
436 In any other case, dd uses only the STDOUT_FILENO file descriptor,
437 and the "cleanup" function calls "close (STDOUT_FILENO)".
438 Closing the file descriptor and then letting the usual atexit-run
439 close_stdout function call "fclose (stdout)" would result in a
440 harmless failure of the close syscall (with errno EBADF).
441 This function serves solely to avoid the unnecessary close_stdout
442 call, once parse_long_options has succeeded.
443 Meanwhile, we guarantee that the standard error stream is flushed,
444 by inlining the last half of close_stdout as needed. */
445 static void
446 maybe_close_stdout (void)
448 if (close_stdout_required)
449 close_stdout ();
450 else if (close_stream (stderr) != 0)
451 _exit (EXIT_FAILURE);
454 void
455 usage (int status)
457 if (status != EXIT_SUCCESS)
458 fprintf (stderr, _("Try `%s --help' for more information.\n"),
459 program_name);
460 else
462 printf (_("\
463 Usage: %s [OPERAND]...\n\
464 or: %s OPTION\n\
466 program_name, program_name);
467 fputs (_("\
468 Copy a file, converting and formatting according to the operands.\n\
470 bs=BYTES read and write BYTES bytes at a time (also see ibs=,obs=)\n\
471 cbs=BYTES convert BYTES bytes at a time\n\
472 conv=CONVS convert the file as per the comma separated symbol list\n\
473 count=BLOCKS copy only BLOCKS input blocks\n\
474 ibs=BYTES read BYTES bytes at a time (default: 512)\n\
475 "), stdout);
476 fputs (_("\
477 if=FILE read from FILE instead of stdin\n\
478 iflag=FLAGS read as per the comma separated symbol list\n\
479 obs=BYTES write BYTES bytes at a time (default: 512)\n\
480 of=FILE write to FILE instead of stdout\n\
481 oflag=FLAGS write as per the comma separated symbol list\n\
482 seek=BLOCKS skip BLOCKS obs-sized blocks at start of output\n\
483 skip=BLOCKS skip BLOCKS ibs-sized blocks at start of input\n\
484 status=noxfer suppress transfer statistics\n\
485 "), stdout);
486 fputs (_("\
488 BLOCKS and BYTES may be followed by the following multiplicative suffixes:\n\
489 c =1, w =2, b =512, kB =1000, K =1024, MB =1000*1000, M =1024*1024, xM =M\n\
490 GB =1000*1000*1000, G =1024*1024*1024, and so on for T, P, E, Z, Y.\n\
492 Each CONV symbol may be:\n\
494 "), stdout);
495 fputs (_("\
496 ascii from EBCDIC to ASCII\n\
497 ebcdic from ASCII to EBCDIC\n\
498 ibm from ASCII to alternate EBCDIC\n\
499 block pad newline-terminated records with spaces to cbs-size\n\
500 unblock replace trailing spaces in cbs-size records with newline\n\
501 lcase change upper case to lower case\n\
502 "), stdout);
503 fputs (_("\
504 nocreat do not create the output file\n\
505 excl fail if the output file already exists\n\
506 notrunc do not truncate the output file\n\
507 ucase change lower case to upper case\n\
508 swab swap every pair of input bytes\n\
509 "), stdout);
510 fputs (_("\
511 noerror continue after read errors\n\
512 sync pad every input block with NULs to ibs-size; when used\n\
513 with block or unblock, pad with spaces rather than NULs\n\
514 fdatasync physically write output file data before finishing\n\
515 fsync likewise, but also write metadata\n\
516 "), stdout);
517 fputs (_("\
519 Each FLAG symbol may be:\n\
521 append append mode (makes sense only for output; conv=notrunc suggested)\n\
522 "), stdout);
523 if (O_CIO)
524 fputs (_(" cio use concurrent I/O for data\n"), stdout);
525 if (O_DIRECT)
526 fputs (_(" direct use direct I/O for data\n"), stdout);
527 if (O_DIRECTORY)
528 fputs (_(" directory fail unless a directory\n"), stdout);
529 if (O_DSYNC)
530 fputs (_(" dsync use synchronized I/O for data\n"), stdout);
531 if (O_SYNC)
532 fputs (_(" sync likewise, but also for metadata\n"), stdout);
533 fputs (_(" fullblock accumulate full blocks of input (iflag only)\n"),
534 stdout);
535 if (O_NONBLOCK)
536 fputs (_(" nonblock use non-blocking I/O\n"), stdout);
537 if (O_NOATIME)
538 fputs (_(" noatime do not update access time\n"), stdout);
539 if (O_NOCTTY)
540 fputs (_(" noctty do not assign controlling terminal from file\n"),
541 stdout);
542 if (HAVE_WORKING_O_NOFOLLOW)
543 fputs (_(" nofollow do not follow symlinks\n"), stdout);
544 if (O_NOLINKS)
545 fputs (_(" nolinks fail if multiply-linked\n"), stdout);
546 if (O_BINARY)
547 fputs (_(" binary use binary I/O for data\n"), stdout);
548 if (O_TEXT)
549 fputs (_(" text use text I/O for data\n"), stdout);
552 char const *siginfo_name = (SIGINFO == SIGUSR1 ? "USR1" : "INFO");
553 printf (_("\
555 Sending a %s signal to a running `dd' process makes it\n\
556 print I/O statistics to standard error and then resume copying.\n\
558 $ dd if=/dev/zero of=/dev/null& pid=$!\n\
559 $ kill -%s $pid; sleep 1; kill $pid\n\
560 18335302+0 records in\n\
561 18335302+0 records out\n\
562 9387674624 bytes (9.4 GB) copied, 34.6279 seconds, 271 MB/s\n\
564 Options are:\n\
567 siginfo_name, siginfo_name);
570 fputs (HELP_OPTION_DESCRIPTION, stdout);
571 fputs (VERSION_OPTION_DESCRIPTION, stdout);
572 emit_ancillary_info ();
574 exit (status);
577 static void
578 translate_charset (char const *new_trans)
580 int i;
582 for (i = 0; i < 256; i++)
583 trans_table[i] = new_trans[trans_table[i]];
584 translation_needed = true;
587 /* Return true if I has more than one bit set. I must be nonnegative. */
589 static inline bool
590 multiple_bits_set (int i)
592 return MULTIPLE_BITS_SET (i);
595 /* Print transfer statistics. */
597 static void
598 print_stats (void)
600 xtime_t now = gethrxtime ();
601 char hbuf[LONGEST_HUMAN_READABLE + 1];
602 int human_opts =
603 (human_autoscale | human_round_to_nearest
604 | human_space_before_unit | human_SI | human_B);
605 double delta_s;
606 char const *bytes_per_second;
608 fprintf (stderr,
609 _("%"PRIuMAX"+%"PRIuMAX" records in\n"
610 "%"PRIuMAX"+%"PRIuMAX" records out\n"),
611 r_full, r_partial, w_full, w_partial);
613 if (r_truncate != 0)
614 fprintf (stderr,
615 ngettext ("%"PRIuMAX" truncated record\n",
616 "%"PRIuMAX" truncated records\n",
617 select_plural (r_truncate)),
618 r_truncate);
620 if (status_flags & STATUS_NOXFER)
621 return;
623 /* Use integer arithmetic to compute the transfer rate,
624 since that makes it easy to use SI abbreviations. */
626 fprintf (stderr,
627 ngettext ("%"PRIuMAX" byte (%s) copied",
628 "%"PRIuMAX" bytes (%s) copied",
629 select_plural (w_bytes)),
630 w_bytes,
631 human_readable (w_bytes, hbuf, human_opts, 1, 1));
633 if (start_time < now)
635 double XTIME_PRECISIONe0 = XTIME_PRECISION;
636 uintmax_t delta_xtime = now;
637 delta_xtime -= start_time;
638 delta_s = delta_xtime / XTIME_PRECISIONe0;
639 bytes_per_second = human_readable (w_bytes, hbuf, human_opts,
640 XTIME_PRECISION, delta_xtime);
642 else
644 delta_s = 0;
645 bytes_per_second = _("Infinity B");
648 /* TRANSLATORS: The two instances of "s" in this string are the SI
649 symbol "s" (meaning second), and should not be translated.
651 This format used to be:
653 ngettext (", %g second, %s/s\n", ", %g seconds, %s/s\n", delta_s == 1)
655 but that was incorrect for languages like Polish. To fix this
656 bug we now use SI symbols even though they're a bit more
657 confusing in English. */
658 fprintf (stderr, _(", %g s, %s/s\n"), delta_s, bytes_per_second);
661 static void
662 cleanup (void)
664 if (close (STDIN_FILENO) < 0)
665 error (EXIT_FAILURE, errno,
666 _("closing input file %s"), quote (input_file));
668 /* Don't remove this call to close, even though close_stdout
669 closes standard output. This close is necessary when cleanup
670 is called as part of a signal handler. */
671 if (close (STDOUT_FILENO) < 0)
672 error (EXIT_FAILURE, errno,
673 _("closing output file %s"), quote (output_file));
676 static void ATTRIBUTE_NORETURN
677 quit (int code)
679 cleanup ();
680 print_stats ();
681 process_signals ();
682 exit (code);
685 /* An ordinary signal was received; arrange for the program to exit. */
687 static void
688 interrupt_handler (int sig)
690 if (! SA_RESETHAND)
691 signal (sig, SIG_DFL);
692 interrupt_signal = sig;
695 /* An info signal was received; arrange for the program to print status. */
697 static void
698 siginfo_handler (int sig)
700 if (! SA_NOCLDSTOP)
701 signal (sig, siginfo_handler);
702 info_signal_count++;
705 /* Install the signal handlers. */
707 static void
708 install_signal_handlers (void)
710 bool catch_siginfo = ! (SIGINFO == SIGUSR1 && getenv ("POSIXLY_CORRECT"));
712 #if SA_NOCLDSTOP
714 struct sigaction act;
715 sigemptyset (&caught_signals);
716 if (catch_siginfo)
718 sigaction (SIGINFO, NULL, &act);
719 if (act.sa_handler != SIG_IGN)
720 sigaddset (&caught_signals, SIGINFO);
722 sigaction (SIGINT, NULL, &act);
723 if (act.sa_handler != SIG_IGN)
724 sigaddset (&caught_signals, SIGINT);
725 act.sa_mask = caught_signals;
727 if (sigismember (&caught_signals, SIGINFO))
729 act.sa_handler = siginfo_handler;
730 act.sa_flags = 0;
731 sigaction (SIGINFO, &act, NULL);
734 if (sigismember (&caught_signals, SIGINT))
736 /* POSIX 1003.1-2001 says SA_RESETHAND implies SA_NODEFER,
737 but this is not true on Solaris 8 at least. It doesn't
738 hurt to use SA_NODEFER here, so leave it in. */
739 act.sa_handler = interrupt_handler;
740 act.sa_flags = SA_NODEFER | SA_RESETHAND;
741 sigaction (SIGINT, &act, NULL);
744 #else
746 if (catch_siginfo && signal (SIGINFO, SIG_IGN) != SIG_IGN)
748 signal (SIGINFO, siginfo_handler);
749 siginterrupt (SIGINFO, 1);
751 if (signal (SIGINT, SIG_IGN) != SIG_IGN)
753 signal (SIGINT, interrupt_handler);
754 siginterrupt (SIGINT, 1);
756 #endif
759 /* Process any pending signals. If signals are caught, this function
760 should be called periodically. Ideally there should never be an
761 unbounded amount of time when signals are not being processed. */
763 static void
764 process_signals (void)
766 while (interrupt_signal || info_signal_count)
768 int interrupt;
769 int infos;
770 sigset_t oldset;
772 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
774 /* Reload interrupt_signal and info_signal_count, in case a new
775 signal was handled before sigprocmask took effect. */
776 interrupt = interrupt_signal;
777 infos = info_signal_count;
779 if (infos)
780 info_signal_count = infos - 1;
782 sigprocmask (SIG_SETMASK, &oldset, NULL);
784 if (interrupt)
785 cleanup ();
786 print_stats ();
787 if (interrupt)
788 raise (interrupt);
792 /* Read from FD into the buffer BUF of size SIZE, processing any
793 signals that arrive before bytes are read. Return the number of
794 bytes read if successful, -1 (setting errno) on failure. */
796 static ssize_t
797 iread (int fd, char *buf, size_t size)
799 while (true)
801 ssize_t nread;
802 process_signals ();
803 nread = read (fd, buf, size);
804 if (! (nread < 0 && errno == EINTR))
805 return nread;
809 /* Wrapper around iread function to accumulate full blocks. */
810 static ssize_t
811 iread_fullblock (int fd, char *buf, size_t size)
813 ssize_t nread = 0;
815 while (0 < size)
817 ssize_t ncurr = iread (fd, buf, size);
818 if (ncurr < 0)
819 return ncurr;
820 if (ncurr == 0)
821 break;
822 nread += ncurr;
823 buf += ncurr;
824 size -= ncurr;
827 return nread;
830 /* Write to FD the buffer BUF of size SIZE, processing any signals
831 that arrive. Return the number of bytes written, setting errno if
832 this is less than SIZE. Keep trying if there are partial
833 writes. */
835 static size_t
836 iwrite (int fd, char const *buf, size_t size)
838 size_t total_written = 0;
840 if ((output_flags & O_DIRECT) && size < output_blocksize)
842 int old_flags = fcntl (STDOUT_FILENO, F_GETFL);
843 if (fcntl (STDOUT_FILENO, F_SETFL, old_flags & ~O_DIRECT) != 0)
844 error (0, errno, _("failed to turn off O_DIRECT: %s"),
845 quote (output_file));
847 /* Since we have just turned off O_DIRECT for the final write,
848 here we try to preserve some of its semantics. First, use
849 posix_fadvise to tell the system not to pollute the buffer
850 cache with this data. Don't bother to diagnose lseek or
851 posix_fadvise failure. */
852 off_t off = lseek (STDOUT_FILENO, 0, SEEK_CUR);
853 if (0 <= off)
854 fdadvise (STDOUT_FILENO, off, 0, FADVISE_DONTNEED);
856 /* Attempt to ensure that that final block is committed
857 to disk as quickly as possible. */
858 conversions_mask |= C_FSYNC;
861 while (total_written < size)
863 ssize_t nwritten;
864 process_signals ();
865 nwritten = write (fd, buf + total_written, size - total_written);
866 if (nwritten < 0)
868 if (errno != EINTR)
869 break;
871 else if (nwritten == 0)
873 /* Some buggy drivers return 0 when one tries to write beyond
874 a device's end. (Example: Linux kernel 1.2.13 on /dev/fd0.)
875 Set errno to ENOSPC so they get a sensible diagnostic. */
876 errno = ENOSPC;
877 break;
879 else
880 total_written += nwritten;
883 return total_written;
886 /* Write, then empty, the output buffer `obuf'. */
888 static void
889 write_output (void)
891 size_t nwritten = iwrite (STDOUT_FILENO, obuf, output_blocksize);
892 w_bytes += nwritten;
893 if (nwritten != output_blocksize)
895 error (0, errno, _("writing to %s"), quote (output_file));
896 if (nwritten != 0)
897 w_partial++;
898 quit (EXIT_FAILURE);
900 else
901 w_full++;
902 oc = 0;
905 /* Return true if STR is of the form "PATTERN" or "PATTERNDELIM...". */
907 static bool
908 operand_matches (char const *str, char const *pattern, char delim)
910 while (*pattern)
911 if (*str++ != *pattern++)
912 return false;
913 return !*str || *str == delim;
916 /* Interpret one "conv=..." or similar operand STR according to the
917 symbols in TABLE, returning the flags specified. If the operand
918 cannot be parsed, use ERROR_MSGID to generate a diagnostic. */
920 static int
921 parse_symbols (char const *str, struct symbol_value const *table,
922 char const *error_msgid)
924 int value = 0;
926 while (true)
928 char const *strcomma = strchr (str, ',');
929 struct symbol_value const *entry;
931 for (entry = table;
932 ! (operand_matches (str, entry->symbol, ',') && entry->value);
933 entry++)
935 if (! entry->symbol[0])
937 size_t slen = strcomma ? strcomma - str : strlen (str);
938 error (0, 0, "%s: %s", _(error_msgid),
939 quotearg_n_style_mem (0, locale_quoting_style, str, slen));
940 usage (EXIT_FAILURE);
944 value |= entry->value;
945 if (!strcomma)
946 break;
947 str = strcomma + 1;
950 return value;
953 /* Return the value of STR, interpreted as a non-negative decimal integer,
954 optionally multiplied by various values.
955 Set *INVALID if STR does not represent a number in this format. */
957 static uintmax_t
958 parse_integer (const char *str, bool *invalid)
960 uintmax_t n;
961 char *suffix;
962 enum strtol_error e = xstrtoumax (str, &suffix, 10, &n, "bcEGkKMPTwYZ0");
964 if (e == LONGINT_INVALID_SUFFIX_CHAR && *suffix == 'x')
966 uintmax_t multiplier = parse_integer (suffix + 1, invalid);
968 if (multiplier != 0 && n * multiplier / multiplier != n)
970 *invalid = true;
971 return 0;
974 n *= multiplier;
976 else if (e != LONGINT_OK)
978 *invalid = true;
979 return 0;
982 return n;
985 /* OPERAND is of the form "X=...". Return true if X is NAME. */
987 static bool
988 operand_is (char const *operand, char const *name)
990 return operand_matches (operand, name, '=');
993 static void
994 scanargs (int argc, char *const *argv)
996 int i;
997 size_t blocksize = 0;
999 for (i = optind; i < argc; i++)
1001 char const *name = argv[i];
1002 char const *val = strchr (name, '=');
1004 if (val == NULL)
1006 error (0, 0, _("unrecognized operand %s"), quote (name));
1007 usage (EXIT_FAILURE);
1009 val++;
1011 if (operand_is (name, "if"))
1012 input_file = val;
1013 else if (operand_is (name, "of"))
1014 output_file = val;
1015 else if (operand_is (name, "conv"))
1016 conversions_mask |= parse_symbols (val, conversions,
1017 N_("invalid conversion"));
1018 else if (operand_is (name, "iflag"))
1019 input_flags |= parse_symbols (val, flags,
1020 N_("invalid input flag"));
1021 else if (operand_is (name, "oflag"))
1022 output_flags |= parse_symbols (val, flags,
1023 N_("invalid output flag"));
1024 else if (operand_is (name, "status"))
1025 status_flags |= parse_symbols (val, statuses,
1026 N_("invalid status flag"));
1027 else
1029 bool invalid = false;
1030 uintmax_t n = parse_integer (val, &invalid);
1032 if (operand_is (name, "ibs"))
1034 invalid |= ! (0 < n && n <= MAX_BLOCKSIZE (INPUT_BLOCK_SLOP));
1035 input_blocksize = n;
1037 else if (operand_is (name, "obs"))
1039 invalid |= ! (0 < n && n <= MAX_BLOCKSIZE (OUTPUT_BLOCK_SLOP));
1040 output_blocksize = n;
1042 else if (operand_is (name, "bs"))
1044 invalid |= ! (0 < n && n <= MAX_BLOCKSIZE (INPUT_BLOCK_SLOP));
1045 blocksize = n;
1047 else if (operand_is (name, "cbs"))
1049 invalid |= ! (0 < n && n <= SIZE_MAX);
1050 conversion_blocksize = n;
1052 else if (operand_is (name, "skip"))
1053 skip_records = n;
1054 else if (operand_is (name, "seek"))
1055 seek_records = n;
1056 else if (operand_is (name, "count"))
1057 max_records = n;
1058 else
1060 error (0, 0, _("unrecognized operand %s"), quote (name));
1061 usage (EXIT_FAILURE);
1064 if (invalid)
1065 error (EXIT_FAILURE, 0, _("invalid number %s"), quote (val));
1069 if (blocksize)
1070 input_blocksize = output_blocksize = blocksize;
1071 else
1073 /* POSIX says dd aggregates short reads into
1074 output_blocksize if bs= is not specified. */
1075 conversions_mask |= C_TWOBUFS;
1078 if (input_blocksize == 0)
1079 input_blocksize = DEFAULT_BLOCKSIZE;
1080 if (output_blocksize == 0)
1081 output_blocksize = DEFAULT_BLOCKSIZE;
1082 if (conversion_blocksize == 0)
1083 conversions_mask &= ~(C_BLOCK | C_UNBLOCK);
1085 if (input_flags & (O_DSYNC | O_SYNC))
1086 input_flags |= O_RSYNC;
1088 if (output_flags & O_FULLBLOCK)
1090 error (0, 0, "%s: %s", _("invalid output flag"), "'fullblock'");
1091 usage (EXIT_FAILURE);
1093 iread_fnc = ((input_flags & O_FULLBLOCK)
1094 ? iread_fullblock
1095 : iread);
1096 input_flags &= ~O_FULLBLOCK;
1098 if (multiple_bits_set (conversions_mask & (C_ASCII | C_EBCDIC | C_IBM)))
1099 error (EXIT_FAILURE, 0, _("cannot combine any two of {ascii,ebcdic,ibm}"));
1100 if (multiple_bits_set (conversions_mask & (C_BLOCK | C_UNBLOCK)))
1101 error (EXIT_FAILURE, 0, _("cannot combine block and unblock"));
1102 if (multiple_bits_set (conversions_mask & (C_LCASE | C_UCASE)))
1103 error (EXIT_FAILURE, 0, _("cannot combine lcase and ucase"));
1104 if (multiple_bits_set (conversions_mask & (C_EXCL | C_NOCREAT)))
1105 error (EXIT_FAILURE, 0, _("cannot combine excl and nocreat"));
1108 /* Fix up translation table. */
1110 static void
1111 apply_translations (void)
1113 int i;
1115 if (conversions_mask & C_ASCII)
1116 translate_charset (ebcdic_to_ascii);
1118 if (conversions_mask & C_UCASE)
1120 for (i = 0; i < 256; i++)
1121 trans_table[i] = toupper (trans_table[i]);
1122 translation_needed = true;
1124 else if (conversions_mask & C_LCASE)
1126 for (i = 0; i < 256; i++)
1127 trans_table[i] = tolower (trans_table[i]);
1128 translation_needed = true;
1131 if (conversions_mask & C_EBCDIC)
1133 translate_charset (ascii_to_ebcdic);
1134 newline_character = ascii_to_ebcdic['\n'];
1135 space_character = ascii_to_ebcdic[' '];
1137 else if (conversions_mask & C_IBM)
1139 translate_charset (ascii_to_ibm);
1140 newline_character = ascii_to_ibm['\n'];
1141 space_character = ascii_to_ibm[' '];
1145 /* Apply the character-set translations specified by the user
1146 to the NREAD bytes in BUF. */
1148 static void
1149 translate_buffer (char *buf, size_t nread)
1151 char *cp;
1152 size_t i;
1154 for (i = nread, cp = buf; i; i--, cp++)
1155 *cp = trans_table[to_uchar (*cp)];
1158 /* If true, the last char from the previous call to `swab_buffer'
1159 is saved in `saved_char'. */
1160 static bool char_is_saved = false;
1162 /* Odd char from previous call. */
1163 static char saved_char;
1165 /* Swap NREAD bytes in BUF, plus possibly an initial char from the
1166 previous call. If NREAD is odd, save the last char for the
1167 next call. Return the new start of the BUF buffer. */
1169 static char *
1170 swab_buffer (char *buf, size_t *nread)
1172 char *bufstart = buf;
1173 char *cp;
1174 size_t i;
1176 /* Is a char left from last time? */
1177 if (char_is_saved)
1179 *--bufstart = saved_char;
1180 (*nread)++;
1181 char_is_saved = false;
1184 if (*nread & 1)
1186 /* An odd number of chars are in the buffer. */
1187 saved_char = bufstart[--*nread];
1188 char_is_saved = true;
1191 /* Do the byte-swapping by moving every second character two
1192 positions toward the end, working from the end of the buffer
1193 toward the beginning. This way we only move half of the data. */
1195 cp = bufstart + *nread; /* Start one char past the last. */
1196 for (i = *nread / 2; i; i--, cp -= 2)
1197 *cp = *(cp - 2);
1199 return ++bufstart;
1202 /* Add OFFSET to the input offset, setting the overflow flag if
1203 necessary. */
1205 static void
1206 advance_input_offset (uintmax_t offset)
1208 input_offset += offset;
1209 if (input_offset < offset)
1210 input_offset_overflow = true;
1213 /* This is a wrapper for lseek. It detects and warns about a kernel
1214 bug that makes lseek a no-op for tape devices, even though the kernel
1215 lseek return value suggests that the function succeeded.
1217 The parameters are the same as those of the lseek function, but
1218 with the addition of FILENAME, the name of the file associated with
1219 descriptor FDESC. The file name is used solely in the warning that's
1220 printed when the bug is detected. Return the same value that lseek
1221 would have returned, but when the lseek bug is detected, return -1
1222 to indicate that lseek failed.
1224 The offending behavior has been confirmed with an Exabyte SCSI tape
1225 drive accessed via /dev/nst0 on both Linux 2.2.17 and 2.4.16 kernels. */
1227 #ifdef __linux__
1229 # include <sys/mtio.h>
1231 # define MT_SAME_POSITION(P, Q) \
1232 ((P).mt_resid == (Q).mt_resid \
1233 && (P).mt_fileno == (Q).mt_fileno \
1234 && (P).mt_blkno == (Q).mt_blkno)
1236 static off_t
1237 skip_via_lseek (char const *filename, int fdesc, off_t offset, int whence)
1239 struct mtget s1;
1240 struct mtget s2;
1241 bool got_original_tape_position = (ioctl (fdesc, MTIOCGET, &s1) == 0);
1242 /* known bad device type */
1243 /* && s.mt_type == MT_ISSCSI2 */
1245 off_t new_position = lseek (fdesc, offset, whence);
1246 if (0 <= new_position
1247 && got_original_tape_position
1248 && ioctl (fdesc, MTIOCGET, &s2) == 0
1249 && MT_SAME_POSITION (s1, s2))
1251 error (0, 0, _("warning: working around lseek kernel bug for file (%s)\n\
1252 of mt_type=0x%0lx -- see <sys/mtio.h> for the list of types"),
1253 filename, s2.mt_type);
1254 errno = 0;
1255 new_position = -1;
1258 return new_position;
1260 #else
1261 # define skip_via_lseek(Filename, Fd, Offset, Whence) lseek (Fd, Offset, Whence)
1262 #endif
1264 /* Throw away RECORDS blocks of BLOCKSIZE bytes on file descriptor FDESC,
1265 which is open with read permission for FILE. Store up to BLOCKSIZE
1266 bytes of the data at a time in BUF, if necessary. RECORDS must be
1267 nonzero. If fdesc is STDIN_FILENO, advance the input offset.
1268 Return the number of records remaining, i.e., that were not skipped
1269 because EOF was reached. */
1271 static uintmax_t
1272 skip (int fdesc, char const *file, uintmax_t records, size_t blocksize,
1273 char *buf)
1275 uintmax_t offset = records * blocksize;
1277 /* Try lseek and if an error indicates it was an inappropriate operation --
1278 or if the file offset is not representable as an off_t --
1279 fall back on using read. */
1281 errno = 0;
1282 if (records <= OFF_T_MAX / blocksize
1283 && 0 <= skip_via_lseek (file, fdesc, offset, SEEK_CUR))
1285 if (fdesc == STDIN_FILENO)
1287 struct stat st;
1288 if (fstat (STDIN_FILENO, &st) != 0)
1289 error (EXIT_FAILURE, errno, _("cannot fstat %s"), quote (file));
1290 if (S_ISREG (st.st_mode) && st.st_size < (input_offset + offset))
1292 /* When skipping past EOF, return the number of _full_ blocks
1293 * that are not skipped, and set offset to EOF, so the caller
1294 * can determine the requested skip was not satisfied. */
1295 records = ( offset - st.st_size ) / blocksize;
1296 offset = st.st_size - input_offset;
1298 else
1299 records = 0;
1300 advance_input_offset (offset);
1302 else
1303 records = 0;
1304 return records;
1306 else
1308 int lseek_errno = errno;
1310 /* The seek request may have failed above if it was too big
1311 (> device size, > max file size, etc.)
1312 Or it may not have been done at all (> OFF_T_MAX).
1313 Therefore try to seek to the end of the file,
1314 to avoid redundant reading. */
1315 if ((skip_via_lseek (file, fdesc, 0, SEEK_END)) >= 0)
1317 /* File is seekable, and we're at the end of it, and
1318 size <= OFF_T_MAX. So there's no point using read to advance. */
1320 if (!lseek_errno)
1322 /* The original seek was not attempted as offset > OFF_T_MAX.
1323 We should error for write as can't get to the desired
1324 location, even if OFF_T_MAX < max file size.
1325 For read we're not going to read any data anyway,
1326 so we should error for consistency.
1327 It would be nice to not error for /dev/{zero,null}
1328 for any offset, but that's not a significant issue. */
1329 lseek_errno = EOVERFLOW;
1332 if (fdesc == STDIN_FILENO)
1333 error (0, lseek_errno, _("%s: cannot skip"), quote (file));
1334 else
1335 error (0, lseek_errno, _("%s: cannot seek"), quote (file));
1336 /* If the file has a specific size and we've asked
1337 to skip/seek beyond the max allowable, then quit. */
1338 quit (EXIT_FAILURE);
1340 /* else file_size && offset > OFF_T_MAX or file ! seekable */
1344 ssize_t nread = iread_fnc (fdesc, buf, blocksize);
1345 if (nread < 0)
1347 if (fdesc == STDIN_FILENO)
1349 error (0, errno, _("reading %s"), quote (file));
1350 if (conversions_mask & C_NOERROR)
1352 print_stats ();
1353 continue;
1356 else
1357 error (0, lseek_errno, _("%s: cannot seek"), quote (file));
1358 quit (EXIT_FAILURE);
1361 if (nread == 0)
1362 break;
1363 if (fdesc == STDIN_FILENO)
1364 advance_input_offset (nread);
1366 while (--records != 0);
1368 return records;
1372 /* Advance the input by NBYTES if possible, after a read error.
1373 The input file offset may or may not have advanced after the failed
1374 read; adjust it to point just after the bad record regardless.
1375 Return true if successful, or if the input is already known to not
1376 be seekable. */
1378 static bool
1379 advance_input_after_read_error (size_t nbytes)
1381 if (! input_seekable)
1383 if (input_seek_errno == ESPIPE)
1384 return true;
1385 errno = input_seek_errno;
1387 else
1389 off_t offset;
1390 advance_input_offset (nbytes);
1391 input_offset_overflow |= (OFF_T_MAX < input_offset);
1392 if (input_offset_overflow)
1394 error (0, 0, _("offset overflow while reading file %s"),
1395 quote (input_file));
1396 return false;
1398 offset = lseek (STDIN_FILENO, 0, SEEK_CUR);
1399 if (0 <= offset)
1401 off_t diff;
1402 if (offset == input_offset)
1403 return true;
1404 diff = input_offset - offset;
1405 if (! (0 <= diff && diff <= nbytes))
1406 error (0, 0, _("warning: invalid file offset after failed read"));
1407 if (0 <= skip_via_lseek (input_file, STDIN_FILENO, diff, SEEK_CUR))
1408 return true;
1409 if (errno == 0)
1410 error (0, 0, _("cannot work around kernel bug after all"));
1414 error (0, errno, _("%s: cannot seek"), quote (input_file));
1415 return false;
1418 /* Copy NREAD bytes of BUF, with no conversions. */
1420 static void
1421 copy_simple (char const *buf, size_t nread)
1423 const char *start = buf; /* First uncopied char in BUF. */
1427 size_t nfree = MIN (nread, output_blocksize - oc);
1429 memcpy (obuf + oc, start, nfree);
1431 nread -= nfree; /* Update the number of bytes left to copy. */
1432 start += nfree;
1433 oc += nfree;
1434 if (oc >= output_blocksize)
1435 write_output ();
1437 while (nread != 0);
1440 /* Copy NREAD bytes of BUF, doing conv=block
1441 (pad newline-terminated records to `conversion_blocksize',
1442 replacing the newline with trailing spaces). */
1444 static void
1445 copy_with_block (char const *buf, size_t nread)
1447 size_t i;
1449 for (i = nread; i; i--, buf++)
1451 if (*buf == newline_character)
1453 if (col < conversion_blocksize)
1455 size_t j;
1456 for (j = col; j < conversion_blocksize; j++)
1457 output_char (space_character);
1459 col = 0;
1461 else
1463 if (col == conversion_blocksize)
1464 r_truncate++;
1465 else if (col < conversion_blocksize)
1466 output_char (*buf);
1467 col++;
1472 /* Copy NREAD bytes of BUF, doing conv=unblock
1473 (replace trailing spaces in `conversion_blocksize'-sized records
1474 with a newline). */
1476 static void
1477 copy_with_unblock (char const *buf, size_t nread)
1479 size_t i;
1480 char c;
1481 static size_t pending_spaces = 0;
1483 for (i = 0; i < nread; i++)
1485 c = buf[i];
1487 if (col++ >= conversion_blocksize)
1489 col = pending_spaces = 0; /* Wipe out any pending spaces. */
1490 i--; /* Push the char back; get it later. */
1491 output_char (newline_character);
1493 else if (c == space_character)
1494 pending_spaces++;
1495 else
1497 /* `c' is the character after a run of spaces that were not
1498 at the end of the conversion buffer. Output them. */
1499 while (pending_spaces)
1501 output_char (space_character);
1502 --pending_spaces;
1504 output_char (c);
1509 /* Set the file descriptor flags for FD that correspond to the nonzero bits
1510 in ADD_FLAGS. The file's name is NAME. */
1512 static void
1513 set_fd_flags (int fd, int add_flags, char const *name)
1515 /* Ignore file creation flags that are no-ops on file descriptors. */
1516 add_flags &= ~ (O_NOCTTY | O_NOFOLLOW);
1518 if (add_flags)
1520 int old_flags = fcntl (fd, F_GETFL);
1521 int new_flags = old_flags | add_flags;
1522 bool ok = true;
1523 if (old_flags < 0)
1524 ok = false;
1525 else if (old_flags != new_flags)
1527 if (new_flags & (O_DIRECTORY | O_NOLINKS))
1529 /* NEW_FLAGS contains at least one file creation flag that
1530 requires some checking of the open file descriptor. */
1531 struct stat st;
1532 if (fstat (fd, &st) != 0)
1533 ok = false;
1534 else if ((new_flags & O_DIRECTORY) && ! S_ISDIR (st.st_mode))
1536 errno = ENOTDIR;
1537 ok = false;
1539 else if ((new_flags & O_NOLINKS) && 1 < st.st_nlink)
1541 errno = EMLINK;
1542 ok = false;
1544 new_flags &= ~ (O_DIRECTORY | O_NOLINKS);
1547 if (ok && old_flags != new_flags
1548 && fcntl (fd, F_SETFL, new_flags) == -1)
1549 ok = false;
1552 if (!ok)
1553 error (EXIT_FAILURE, errno, _("setting flags for %s"), quote (name));
1557 static char *
1558 human_size (size_t n)
1560 static char hbuf[LONGEST_HUMAN_READABLE + 1];
1561 int human_opts =
1562 (human_autoscale | human_round_to_nearest | human_base_1024
1563 | human_space_before_unit | human_SI | human_B);
1564 return human_readable (n, hbuf, human_opts, 1, 1);
1567 /* The main loop. */
1569 static int
1570 dd_copy (void)
1572 char *ibuf, *bufstart; /* Input buffer. */
1573 /* These are declared static so that even though we don't free the
1574 buffers, valgrind will recognize that there is no "real" leak. */
1575 static char *real_buf; /* real buffer address before alignment */
1576 static char *real_obuf;
1577 ssize_t nread; /* Bytes read in the current block. */
1579 /* If nonzero, then the previously read block was partial and
1580 PARTREAD was its size. */
1581 size_t partread = 0;
1583 int exit_status = EXIT_SUCCESS;
1584 size_t n_bytes_read;
1586 /* Leave at least one extra byte at the beginning and end of `ibuf'
1587 for conv=swab, but keep the buffer address even. But some peculiar
1588 device drivers work only with word-aligned buffers, so leave an
1589 extra two bytes. */
1591 /* Some devices require alignment on a sector or page boundary
1592 (e.g. character disk devices). Align the input buffer to a
1593 page boundary to cover all bases. Note that due to the swab
1594 algorithm, we must have at least one byte in the page before
1595 the input buffer; thus we allocate 2 pages of slop in the
1596 real buffer. 8k above the blocksize shouldn't bother anyone.
1598 The page alignment is necessary on any Linux kernel that supports
1599 either the SGI raw I/O patch or Steven Tweedies raw I/O patch.
1600 It is necessary when accessing raw (i.e. character special) disk
1601 devices on Unixware or other SVR4-derived system. */
1603 real_buf = malloc (input_blocksize + INPUT_BLOCK_SLOP);
1604 if (!real_buf)
1605 error (EXIT_FAILURE, 0,
1606 _("memory exhausted by input buffer of size %zu bytes (%s)"),
1607 input_blocksize, human_size (input_blocksize));
1609 ibuf = real_buf;
1610 ibuf += SWAB_ALIGN_OFFSET; /* allow space for swab */
1612 ibuf = ptr_align (ibuf, page_size);
1614 if (conversions_mask & C_TWOBUFS)
1616 /* Page-align the output buffer, too. */
1617 real_obuf = malloc (output_blocksize + OUTPUT_BLOCK_SLOP);
1618 if (!real_obuf)
1619 error (EXIT_FAILURE, 0,
1620 _("memory exhausted by output buffer of size %zu bytes (%s)"),
1621 output_blocksize, human_size (output_blocksize));
1622 obuf = ptr_align (real_obuf, page_size);
1624 else
1626 real_obuf = NULL;
1627 obuf = ibuf;
1630 if (skip_records != 0)
1632 uintmax_t us_bytes = input_offset + (skip_records * input_blocksize);
1633 uintmax_t us_blocks = skip (STDIN_FILENO, input_file,
1634 skip_records, input_blocksize, ibuf);
1635 us_bytes -= input_offset;
1637 /* POSIX doesn't say what to do when dd detects it has been
1638 asked to skip past EOF, so I assume it's non-fatal.
1639 There are 3 reasons why there might be unskipped blocks/bytes:
1640 1. file is too small
1641 2. pipe has not enough data
1642 3. short reads */
1643 if (us_blocks || (!input_offset_overflow && us_bytes))
1645 error (0, 0,
1646 _("%s: cannot skip to specified offset"), quote (input_file));
1650 if (seek_records != 0)
1652 uintmax_t write_records = skip (STDOUT_FILENO, output_file,
1653 seek_records, output_blocksize, obuf);
1655 if (write_records != 0)
1657 memset (obuf, 0, output_blocksize);
1660 if (iwrite (STDOUT_FILENO, obuf, output_blocksize)
1661 != output_blocksize)
1663 error (0, errno, _("writing to %s"), quote (output_file));
1664 quit (EXIT_FAILURE);
1666 while (--write_records != 0);
1670 if (max_records == 0)
1671 return exit_status;
1673 while (1)
1675 if (r_partial + r_full >= max_records)
1676 break;
1678 /* Zero the buffer before reading, so that if we get a read error,
1679 whatever data we are able to read is followed by zeros.
1680 This minimizes data loss. */
1681 if ((conversions_mask & C_SYNC) && (conversions_mask & C_NOERROR))
1682 memset (ibuf,
1683 (conversions_mask & (C_BLOCK | C_UNBLOCK)) ? ' ' : '\0',
1684 input_blocksize);
1686 nread = iread_fnc (STDIN_FILENO, ibuf, input_blocksize);
1688 if (nread == 0)
1689 break; /* EOF. */
1691 if (nread < 0)
1693 error (0, errno, _("reading %s"), quote (input_file));
1694 if (conversions_mask & C_NOERROR)
1696 print_stats ();
1697 /* Seek past the bad block if possible. */
1698 if (!advance_input_after_read_error (input_blocksize - partread))
1700 exit_status = EXIT_FAILURE;
1702 /* Suppress duplicate diagnostics. */
1703 input_seekable = false;
1704 input_seek_errno = ESPIPE;
1706 if ((conversions_mask & C_SYNC) && !partread)
1707 /* Replace the missing input with null bytes and
1708 proceed normally. */
1709 nread = 0;
1710 else
1711 continue;
1713 else
1715 /* Write any partial block. */
1716 exit_status = EXIT_FAILURE;
1717 break;
1721 n_bytes_read = nread;
1722 advance_input_offset (nread);
1724 if (n_bytes_read < input_blocksize)
1726 r_partial++;
1727 partread = n_bytes_read;
1728 if (conversions_mask & C_SYNC)
1730 if (!(conversions_mask & C_NOERROR))
1731 /* If C_NOERROR, we zeroed the block before reading. */
1732 memset (ibuf + n_bytes_read,
1733 (conversions_mask & (C_BLOCK | C_UNBLOCK)) ? ' ' : '\0',
1734 input_blocksize - n_bytes_read);
1735 n_bytes_read = input_blocksize;
1738 else
1740 r_full++;
1741 partread = 0;
1744 if (ibuf == obuf) /* If not C_TWOBUFS. */
1746 size_t nwritten = iwrite (STDOUT_FILENO, obuf, n_bytes_read);
1747 w_bytes += nwritten;
1748 if (nwritten != n_bytes_read)
1750 error (0, errno, _("writing %s"), quote (output_file));
1751 return EXIT_FAILURE;
1753 else if (n_bytes_read == input_blocksize)
1754 w_full++;
1755 else
1756 w_partial++;
1757 continue;
1760 /* Do any translations on the whole buffer at once. */
1762 if (translation_needed)
1763 translate_buffer (ibuf, n_bytes_read);
1765 if (conversions_mask & C_SWAB)
1766 bufstart = swab_buffer (ibuf, &n_bytes_read);
1767 else
1768 bufstart = ibuf;
1770 if (conversions_mask & C_BLOCK)
1771 copy_with_block (bufstart, n_bytes_read);
1772 else if (conversions_mask & C_UNBLOCK)
1773 copy_with_unblock (bufstart, n_bytes_read);
1774 else
1775 copy_simple (bufstart, n_bytes_read);
1778 /* If we have a char left as a result of conv=swab, output it. */
1779 if (char_is_saved)
1781 if (conversions_mask & C_BLOCK)
1782 copy_with_block (&saved_char, 1);
1783 else if (conversions_mask & C_UNBLOCK)
1784 copy_with_unblock (&saved_char, 1);
1785 else
1786 output_char (saved_char);
1789 if ((conversions_mask & C_BLOCK) && col > 0)
1791 /* If the final input line didn't end with a '\n', pad
1792 the output block to `conversion_blocksize' chars. */
1793 size_t i;
1794 for (i = col; i < conversion_blocksize; i++)
1795 output_char (space_character);
1798 if (col && (conversions_mask & C_UNBLOCK))
1800 /* If there was any output, add a final '\n'. */
1801 output_char (newline_character);
1804 /* Write out the last block. */
1805 if (oc != 0)
1807 size_t nwritten = iwrite (STDOUT_FILENO, obuf, oc);
1808 w_bytes += nwritten;
1809 if (nwritten != 0)
1810 w_partial++;
1811 if (nwritten != oc)
1813 error (0, errno, _("writing %s"), quote (output_file));
1814 return EXIT_FAILURE;
1818 if ((conversions_mask & C_FDATASYNC) && fdatasync (STDOUT_FILENO) != 0)
1820 if (errno != ENOSYS && errno != EINVAL)
1822 error (0, errno, _("fdatasync failed for %s"), quote (output_file));
1823 exit_status = EXIT_FAILURE;
1825 conversions_mask |= C_FSYNC;
1828 if (conversions_mask & C_FSYNC)
1829 while (fsync (STDOUT_FILENO) != 0)
1830 if (errno != EINTR)
1832 error (0, errno, _("fsync failed for %s"), quote (output_file));
1833 return EXIT_FAILURE;
1836 return exit_status;
1840 main (int argc, char **argv)
1842 int i;
1843 int exit_status;
1844 off_t offset;
1846 install_signal_handlers ();
1848 initialize_main (&argc, &argv);
1849 set_program_name (argv[0]);
1850 setlocale (LC_ALL, "");
1851 bindtextdomain (PACKAGE, LOCALEDIR);
1852 textdomain (PACKAGE);
1854 /* Arrange to close stdout if parse_long_options exits. */
1855 atexit (maybe_close_stdout);
1857 page_size = getpagesize ();
1859 parse_long_options (argc, argv, PROGRAM_NAME, PACKAGE, Version,
1860 usage, AUTHORS, (char const *) NULL);
1861 close_stdout_required = false;
1863 if (getopt_long (argc, argv, "", NULL, NULL) != -1)
1864 usage (EXIT_FAILURE);
1866 /* Initialize translation table to identity translation. */
1867 for (i = 0; i < 256; i++)
1868 trans_table[i] = i;
1870 /* Decode arguments. */
1871 scanargs (argc, argv);
1873 apply_translations ();
1875 if (input_file == NULL)
1877 input_file = _("standard input");
1878 set_fd_flags (STDIN_FILENO, input_flags, input_file);
1880 else
1882 if (fd_reopen (STDIN_FILENO, input_file, O_RDONLY | input_flags, 0) < 0)
1883 error (EXIT_FAILURE, errno, _("opening %s"), quote (input_file));
1886 offset = lseek (STDIN_FILENO, 0, SEEK_CUR);
1887 input_seekable = (0 <= offset);
1888 input_offset = MAX (0, offset);
1889 input_seek_errno = errno;
1891 if (output_file == NULL)
1893 output_file = _("standard output");
1894 set_fd_flags (STDOUT_FILENO, output_flags, output_file);
1896 else
1898 mode_t perms = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH;
1899 int opts
1900 = (output_flags
1901 | (conversions_mask & C_NOCREAT ? 0 : O_CREAT)
1902 | (conversions_mask & C_EXCL ? O_EXCL : 0)
1903 | (seek_records || (conversions_mask & C_NOTRUNC) ? 0 : O_TRUNC));
1905 /* Open the output file with *read* access only if we might
1906 need to read to satisfy a `seek=' request. If we can't read
1907 the file, go ahead with write-only access; it might work. */
1908 if ((! seek_records
1909 || fd_reopen (STDOUT_FILENO, output_file, O_RDWR | opts, perms) < 0)
1910 && (fd_reopen (STDOUT_FILENO, output_file, O_WRONLY | opts, perms)
1911 < 0))
1912 error (EXIT_FAILURE, errno, _("opening %s"), quote (output_file));
1914 if (seek_records != 0 && !(conversions_mask & C_NOTRUNC))
1916 uintmax_t size = seek_records * output_blocksize;
1917 unsigned long int obs = output_blocksize;
1919 if (OFF_T_MAX / output_blocksize < seek_records)
1920 error (EXIT_FAILURE, 0,
1921 _("offset too large: "
1922 "cannot truncate to a length of seek=%"PRIuMAX""
1923 " (%lu-byte) blocks"),
1924 seek_records, obs);
1926 if (ftruncate (STDOUT_FILENO, size) != 0)
1928 /* Complain only when ftruncate fails on a regular file, a
1929 directory, or a shared memory object, as POSIX 1003.1-2004
1930 specifies ftruncate's behavior only for these file types.
1931 For example, do not complain when Linux kernel 2.4 ftruncate
1932 fails on /dev/fd0. */
1933 int ftruncate_errno = errno;
1934 struct stat stdout_stat;
1935 if (fstat (STDOUT_FILENO, &stdout_stat) != 0)
1936 error (EXIT_FAILURE, errno, _("cannot fstat %s"),
1937 quote (output_file));
1938 if (S_ISREG (stdout_stat.st_mode)
1939 || S_ISDIR (stdout_stat.st_mode)
1940 || S_TYPEISSHM (&stdout_stat))
1941 error (EXIT_FAILURE, ftruncate_errno,
1942 _("failed to truncate to %"PRIuMAX" bytes in output file %s"),
1943 size, quote (output_file));
1948 start_time = gethrxtime ();
1950 exit_status = dd_copy ();
1952 quit (exit_status);