1 /* dd -- convert a file while copying it.
2 Copyright (C) 85, 90, 91, 1995-2009 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. */
21 #define SWAB_ALIGN_OFFSET 2
23 #include <sys/types.h>
28 #include "close-stream.h"
30 #include "fd-reopen.h"
31 #include "gethrxtime.h"
33 #include "ignore-value.h"
34 #include "long-options.h"
40 static void process_signals (void);
42 /* The official name of this program (e.g., no `g' prefix). */
43 #define PROGRAM_NAME "dd"
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. */
53 # define SA_NOCLDSTOP 0
54 # define sigprocmask(How, Set, Oset) /* empty */
56 # if ! HAVE_SIGINTERRUPT
57 # define siginterrupt(sig, flag) /* empty */
64 # define SA_RESETHAND 0
68 # define SIGINFO SIGUSR1
71 /* This may belong in GNULIB's fcntl module instead.
72 Define O_CIO to 0 if it is not supported by this OS. */
78 # define fdatasync(fd) (errno = ENOSYS, -1)
81 #define output_char(c) \
85 if (oc >= output_blocksize) \
90 /* Default input and output blocksize. */
91 #define DEFAULT_BLOCKSIZE 512
93 /* How many bytes to add to the input and output block sizes before invoking
94 malloc. See dd_copy for details. INPUT_BLOCK_SLOP must be no less than
96 #define INPUT_BLOCK_SLOP (2 * SWAB_ALIGN_OFFSET + 2 * page_size - 1)
97 #define OUTPUT_BLOCK_SLOP (page_size - 1)
99 /* Maximum blocksize for the given SLOP.
100 Keep it smaller than SIZE_MAX - SLOP, so that we can
101 allocate buffers that size. Keep it smaller than SSIZE_MAX, for
102 the benefit of system calls like "read". And keep it smaller than
103 OFF_T_MAX, for the benefit of the large-offset seek code. */
104 #define MAX_BLOCKSIZE(slop) MIN (SIZE_MAX - (slop), MIN (SSIZE_MAX, OFF_T_MAX))
106 /* Conversions bit masks. */
122 /* Use separate input and output buffers, and combine partial
128 C_FDATASYNC
= 040000,
132 /* Status bit masks. */
138 /* The name of the input file, or NULL for the standard input. */
139 static char const *input_file
= NULL
;
141 /* The name of the output file, or NULL for the standard output. */
142 static char const *output_file
= NULL
;
144 /* The page size on this host. */
145 static size_t page_size
;
147 /* The number of bytes in which atomic reads are done. */
148 static size_t input_blocksize
= 0;
150 /* The number of bytes in which atomic writes are done. */
151 static size_t output_blocksize
= 0;
153 /* Conversion buffer size, in bytes. 0 prevents conversions. */
154 static size_t conversion_blocksize
= 0;
156 /* Skip this many records of `input_blocksize' bytes before input. */
157 static uintmax_t skip_records
= 0;
159 /* Skip this many records of `output_blocksize' bytes before output. */
160 static uintmax_t seek_records
= 0;
162 /* Copy only this many records. The default is effectively infinity. */
163 static uintmax_t max_records
= (uintmax_t) -1;
165 /* Bit vector of conversions to apply. */
166 static int conversions_mask
= 0;
168 /* Open flags for the input and output files. */
169 static int input_flags
= 0;
170 static int output_flags
= 0;
172 /* Status flags for what is printed to stderr. */
173 static int status_flags
= 0;
175 /* If nonzero, filter characters through the translation table. */
176 static bool translation_needed
= false;
178 /* Number of partial blocks written. */
179 static uintmax_t w_partial
= 0;
181 /* Number of full blocks written. */
182 static uintmax_t w_full
= 0;
184 /* Number of partial blocks read. */
185 static uintmax_t r_partial
= 0;
187 /* Number of full blocks read. */
188 static uintmax_t r_full
= 0;
190 /* Number of bytes written. */
191 static uintmax_t w_bytes
= 0;
193 /* Time that dd started. */
194 static xtime_t start_time
;
196 /* True if input is seekable. */
197 static bool input_seekable
;
199 /* Error number corresponding to initial attempt to lseek input.
200 If ESPIPE, do not issue any more diagnostics about it. */
201 static int input_seek_errno
;
203 /* File offset of the input, in bytes, along with a flag recording
204 whether it overflowed. */
205 static uintmax_t input_offset
;
206 static bool input_offset_overflow
;
208 /* Records truncated by conv=block. */
209 static uintmax_t r_truncate
= 0;
211 /* Output representation of newline and space characters.
212 They change if we're converting to EBCDIC. */
213 static char newline_character
= '\n';
214 static char space_character
= ' ';
219 /* Current index into `obuf'. */
220 static size_t oc
= 0;
222 /* Index into current line, for `conv=block' and `conv=unblock'. */
223 static size_t col
= 0;
225 /* The set of signals that are caught. */
226 static sigset_t caught_signals
;
228 /* If nonzero, the value of the pending fatal signal. */
229 static sig_atomic_t volatile interrupt_signal
;
231 /* A count of the number of pending info signals that have been received. */
232 static sig_atomic_t volatile info_signal_count
;
234 /* Function used for read (to handle iflag=fullblock parameter). */
235 static ssize_t (*iread_fnc
) (int fd
, char *buf
, size_t size
);
237 /* A longest symbol in the struct symbol_values tables below. */
238 #define LONGEST_SYMBOL "fdatasync"
240 /* A symbol and the corresponding integer value. */
243 char symbol
[sizeof LONGEST_SYMBOL
];
247 /* Conversion symbols, for conv="...". */
248 static struct symbol_value
const conversions
[] =
250 {"ascii", C_ASCII
| C_TWOBUFS
}, /* EBCDIC to ASCII. */
251 {"ebcdic", C_EBCDIC
| C_TWOBUFS
}, /* ASCII to EBCDIC. */
252 {"ibm", C_IBM
| C_TWOBUFS
}, /* Slightly different ASCII to EBCDIC. */
253 {"block", C_BLOCK
| C_TWOBUFS
}, /* Variable to fixed length records. */
254 {"unblock", C_UNBLOCK
| C_TWOBUFS
}, /* Fixed to variable length records. */
255 {"lcase", C_LCASE
| C_TWOBUFS
}, /* Translate upper to lower case. */
256 {"ucase", C_UCASE
| C_TWOBUFS
}, /* Translate lower to upper case. */
257 {"swab", C_SWAB
| C_TWOBUFS
}, /* Swap bytes of input. */
258 {"noerror", C_NOERROR
}, /* Ignore i/o errors. */
259 {"nocreat", C_NOCREAT
}, /* Do not create output file. */
260 {"excl", C_EXCL
}, /* Fail if the output file already exists. */
261 {"notrunc", C_NOTRUNC
}, /* Do not truncate output file. */
262 {"sync", C_SYNC
}, /* Pad input records to ibs with NULs. */
263 {"fdatasync", C_FDATASYNC
}, /* Synchronize output data before finishing. */
264 {"fsync", C_FSYNC
}, /* Also synchronize output metadata. */
270 /* Compute a value that's bitwise disjoint from the union
287 /* Use its lowest bit. */
288 O_FULLBLOCK
= v
^ (v
& (v
- 1))
291 /* Ensure that we got something. */
292 verify (O_FULLBLOCK
!= 0);
294 #define MULTIPLE_BITS_SET(i) (((i) & ((i) - 1)) != 0)
296 /* Ensure that this is a single-bit value. */
297 verify ( ! MULTIPLE_BITS_SET (O_FULLBLOCK
));
299 /* Flags, for iflag="..." and oflag="...". */
300 static struct symbol_value
const flags
[] =
302 {"append", O_APPEND
},
303 {"binary", O_BINARY
},
305 {"direct", O_DIRECT
},
306 {"directory", O_DIRECTORY
},
308 {"noatime", O_NOATIME
},
309 {"noctty", O_NOCTTY
},
310 {"nofollow", HAVE_WORKING_O_NOFOLLOW
? O_NOFOLLOW
: 0},
311 {"nolinks", O_NOLINKS
},
312 {"nonblock", O_NONBLOCK
},
315 {"fullblock", O_FULLBLOCK
}, /* Accumulate full blocks from input. */
319 /* Status, for status="...". */
320 static struct symbol_value
const statuses
[] =
322 {"noxfer", STATUS_NOXFER
},
326 /* Translation table formed by applying successive transformations. */
327 static unsigned char trans_table
[256];
329 static char const ascii_to_ebcdic
[] =
331 '\000', '\001', '\002', '\003', '\067', '\055', '\056', '\057',
332 '\026', '\005', '\045', '\013', '\014', '\015', '\016', '\017',
333 '\020', '\021', '\022', '\023', '\074', '\075', '\062', '\046',
334 '\030', '\031', '\077', '\047', '\034', '\035', '\036', '\037',
335 '\100', '\117', '\177', '\173', '\133', '\154', '\120', '\175',
336 '\115', '\135', '\134', '\116', '\153', '\140', '\113', '\141',
337 '\360', '\361', '\362', '\363', '\364', '\365', '\366', '\367',
338 '\370', '\371', '\172', '\136', '\114', '\176', '\156', '\157',
339 '\174', '\301', '\302', '\303', '\304', '\305', '\306', '\307',
340 '\310', '\311', '\321', '\322', '\323', '\324', '\325', '\326',
341 '\327', '\330', '\331', '\342', '\343', '\344', '\345', '\346',
342 '\347', '\350', '\351', '\112', '\340', '\132', '\137', '\155',
343 '\171', '\201', '\202', '\203', '\204', '\205', '\206', '\207',
344 '\210', '\211', '\221', '\222', '\223', '\224', '\225', '\226',
345 '\227', '\230', '\231', '\242', '\243', '\244', '\245', '\246',
346 '\247', '\250', '\251', '\300', '\152', '\320', '\241', '\007',
347 '\040', '\041', '\042', '\043', '\044', '\025', '\006', '\027',
348 '\050', '\051', '\052', '\053', '\054', '\011', '\012', '\033',
349 '\060', '\061', '\032', '\063', '\064', '\065', '\066', '\010',
350 '\070', '\071', '\072', '\073', '\004', '\024', '\076', '\341',
351 '\101', '\102', '\103', '\104', '\105', '\106', '\107', '\110',
352 '\111', '\121', '\122', '\123', '\124', '\125', '\126', '\127',
353 '\130', '\131', '\142', '\143', '\144', '\145', '\146', '\147',
354 '\150', '\151', '\160', '\161', '\162', '\163', '\164', '\165',
355 '\166', '\167', '\170', '\200', '\212', '\213', '\214', '\215',
356 '\216', '\217', '\220', '\232', '\233', '\234', '\235', '\236',
357 '\237', '\240', '\252', '\253', '\254', '\255', '\256', '\257',
358 '\260', '\261', '\262', '\263', '\264', '\265', '\266', '\267',
359 '\270', '\271', '\272', '\273', '\274', '\275', '\276', '\277',
360 '\312', '\313', '\314', '\315', '\316', '\317', '\332', '\333',
361 '\334', '\335', '\336', '\337', '\352', '\353', '\354', '\355',
362 '\356', '\357', '\372', '\373', '\374', '\375', '\376', '\377'
365 static char const ascii_to_ibm
[] =
367 '\000', '\001', '\002', '\003', '\067', '\055', '\056', '\057',
368 '\026', '\005', '\045', '\013', '\014', '\015', '\016', '\017',
369 '\020', '\021', '\022', '\023', '\074', '\075', '\062', '\046',
370 '\030', '\031', '\077', '\047', '\034', '\035', '\036', '\037',
371 '\100', '\132', '\177', '\173', '\133', '\154', '\120', '\175',
372 '\115', '\135', '\134', '\116', '\153', '\140', '\113', '\141',
373 '\360', '\361', '\362', '\363', '\364', '\365', '\366', '\367',
374 '\370', '\371', '\172', '\136', '\114', '\176', '\156', '\157',
375 '\174', '\301', '\302', '\303', '\304', '\305', '\306', '\307',
376 '\310', '\311', '\321', '\322', '\323', '\324', '\325', '\326',
377 '\327', '\330', '\331', '\342', '\343', '\344', '\345', '\346',
378 '\347', '\350', '\351', '\255', '\340', '\275', '\137', '\155',
379 '\171', '\201', '\202', '\203', '\204', '\205', '\206', '\207',
380 '\210', '\211', '\221', '\222', '\223', '\224', '\225', '\226',
381 '\227', '\230', '\231', '\242', '\243', '\244', '\245', '\246',
382 '\247', '\250', '\251', '\300', '\117', '\320', '\241', '\007',
383 '\040', '\041', '\042', '\043', '\044', '\025', '\006', '\027',
384 '\050', '\051', '\052', '\053', '\054', '\011', '\012', '\033',
385 '\060', '\061', '\032', '\063', '\064', '\065', '\066', '\010',
386 '\070', '\071', '\072', '\073', '\004', '\024', '\076', '\341',
387 '\101', '\102', '\103', '\104', '\105', '\106', '\107', '\110',
388 '\111', '\121', '\122', '\123', '\124', '\125', '\126', '\127',
389 '\130', '\131', '\142', '\143', '\144', '\145', '\146', '\147',
390 '\150', '\151', '\160', '\161', '\162', '\163', '\164', '\165',
391 '\166', '\167', '\170', '\200', '\212', '\213', '\214', '\215',
392 '\216', '\217', '\220', '\232', '\233', '\234', '\235', '\236',
393 '\237', '\240', '\252', '\253', '\254', '\255', '\256', '\257',
394 '\260', '\261', '\262', '\263', '\264', '\265', '\266', '\267',
395 '\270', '\271', '\272', '\273', '\274', '\275', '\276', '\277',
396 '\312', '\313', '\314', '\315', '\316', '\317', '\332', '\333',
397 '\334', '\335', '\336', '\337', '\352', '\353', '\354', '\355',
398 '\356', '\357', '\372', '\373', '\374', '\375', '\376', '\377'
401 static char const ebcdic_to_ascii
[] =
403 '\000', '\001', '\002', '\003', '\234', '\011', '\206', '\177',
404 '\227', '\215', '\216', '\013', '\014', '\015', '\016', '\017',
405 '\020', '\021', '\022', '\023', '\235', '\205', '\010', '\207',
406 '\030', '\031', '\222', '\217', '\034', '\035', '\036', '\037',
407 '\200', '\201', '\202', '\203', '\204', '\012', '\027', '\033',
408 '\210', '\211', '\212', '\213', '\214', '\005', '\006', '\007',
409 '\220', '\221', '\026', '\223', '\224', '\225', '\226', '\004',
410 '\230', '\231', '\232', '\233', '\024', '\025', '\236', '\032',
411 '\040', '\240', '\241', '\242', '\243', '\244', '\245', '\246',
412 '\247', '\250', '\133', '\056', '\074', '\050', '\053', '\041',
413 '\046', '\251', '\252', '\253', '\254', '\255', '\256', '\257',
414 '\260', '\261', '\135', '\044', '\052', '\051', '\073', '\136',
415 '\055', '\057', '\262', '\263', '\264', '\265', '\266', '\267',
416 '\270', '\271', '\174', '\054', '\045', '\137', '\076', '\077',
417 '\272', '\273', '\274', '\275', '\276', '\277', '\300', '\301',
418 '\302', '\140', '\072', '\043', '\100', '\047', '\075', '\042',
419 '\303', '\141', '\142', '\143', '\144', '\145', '\146', '\147',
420 '\150', '\151', '\304', '\305', '\306', '\307', '\310', '\311',
421 '\312', '\152', '\153', '\154', '\155', '\156', '\157', '\160',
422 '\161', '\162', '\313', '\314', '\315', '\316', '\317', '\320',
423 '\321', '\176', '\163', '\164', '\165', '\166', '\167', '\170',
424 '\171', '\172', '\322', '\323', '\324', '\325', '\326', '\327',
425 '\330', '\331', '\332', '\333', '\334', '\335', '\336', '\337',
426 '\340', '\341', '\342', '\343', '\344', '\345', '\346', '\347',
427 '\173', '\101', '\102', '\103', '\104', '\105', '\106', '\107',
428 '\110', '\111', '\350', '\351', '\352', '\353', '\354', '\355',
429 '\175', '\112', '\113', '\114', '\115', '\116', '\117', '\120',
430 '\121', '\122', '\356', '\357', '\360', '\361', '\362', '\363',
431 '\134', '\237', '\123', '\124', '\125', '\126', '\127', '\130',
432 '\131', '\132', '\364', '\365', '\366', '\367', '\370', '\371',
433 '\060', '\061', '\062', '\063', '\064', '\065', '\066', '\067',
434 '\070', '\071', '\372', '\373', '\374', '\375', '\376', '\377'
437 /* True if we need to close the standard output *stream*. */
438 static bool close_stdout_required
= true;
440 /* The only reason to close the standard output *stream* is if
441 parse_long_options fails (as it does for --help or --version).
442 In any other case, dd uses only the STDOUT_FILENO file descriptor,
443 and the "cleanup" function calls "close (STDOUT_FILENO)".
444 Closing the file descriptor and then letting the usual atexit-run
445 close_stdout function call "fclose (stdout)" would result in a
446 harmless failure of the close syscall (with errno EBADF).
447 This function serves solely to avoid the unnecessary close_stdout
448 call, once parse_long_options has succeeded.
449 Meanwhile, we guarantee that the standard error stream is flushed,
450 by inlining the last half of close_stdout as needed. */
452 maybe_close_stdout (void)
454 if (close_stdout_required
)
456 else if (close_stream (stderr
) != 0)
457 _exit (EXIT_FAILURE
);
463 if (status
!= EXIT_SUCCESS
)
464 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
469 Usage: %s [OPERAND]...\n\
472 program_name
, program_name
);
474 Copy a file, converting and formatting according to the operands.\n\
476 bs=BYTES read and write BYTES bytes at a time (also see ibs=,obs=)\n\
477 cbs=BYTES convert BYTES bytes at a time\n\
478 conv=CONVS convert the file as per the comma separated symbol list\n\
479 count=BLOCKS copy only BLOCKS input blocks\n\
480 ibs=BYTES read BYTES bytes at a time (default: 512)\n\
483 if=FILE read from FILE instead of stdin\n\
484 iflag=FLAGS read as per the comma separated symbol list\n\
485 obs=BYTES write BYTES bytes at a time (default: 512)\n\
486 of=FILE write to FILE instead of stdout\n\
487 oflag=FLAGS write as per the comma separated symbol list\n\
488 seek=BLOCKS skip BLOCKS obs-sized blocks at start of output\n\
489 skip=BLOCKS skip BLOCKS ibs-sized blocks at start of input\n\
490 status=noxfer suppress transfer statistics\n\
494 BLOCKS and BYTES may be followed by the following multiplicative suffixes:\n\
495 c =1, w =2, b =512, kB =1000, K =1024, MB =1000*1000, M =1024*1024, xM =M\n\
496 GB =1000*1000*1000, G =1024*1024*1024, and so on for T, P, E, Z, Y.\n\
498 Each CONV symbol may be:\n\
502 ascii from EBCDIC to ASCII\n\
503 ebcdic from ASCII to EBCDIC\n\
504 ibm from ASCII to alternate EBCDIC\n\
505 block pad newline-terminated records with spaces to cbs-size\n\
506 unblock replace trailing spaces in cbs-size records with newline\n\
507 lcase change upper case to lower case\n\
510 nocreat do not create the output file\n\
511 excl fail if the output file already exists\n\
512 notrunc do not truncate the output file\n\
513 ucase change lower case to upper case\n\
514 swab swap every pair of input bytes\n\
517 noerror continue after read errors\n\
518 sync pad every input block with NULs to ibs-size; when used\n\
519 with block or unblock, pad with spaces rather than NULs\n\
520 fdatasync physically write output file data before finishing\n\
521 fsync likewise, but also write metadata\n\
525 Each FLAG symbol may be:\n\
527 append append mode (makes sense only for output; conv=notrunc suggested)\n\
530 fputs (_(" cio use concurrent I/O for data\n"), stdout
);
532 fputs (_(" direct use direct I/O for data\n"), stdout
);
534 fputs (_(" directory fail unless a directory\n"), stdout
);
536 fputs (_(" dsync use synchronized I/O for data\n"), stdout
);
538 fputs (_(" sync likewise, but also for metadata\n"), stdout
);
539 fputs (_(" fullblock accumulate full blocks of input (iflag only)\n"),
542 fputs (_(" nonblock use non-blocking I/O\n"), stdout
);
544 fputs (_(" noatime do not update access time\n"), stdout
);
546 fputs (_(" noctty do not assign controlling terminal from file\n"),
548 if (HAVE_WORKING_O_NOFOLLOW
)
549 fputs (_(" nofollow do not follow symlinks\n"), stdout
);
551 fputs (_(" nolinks fail if multiply-linked\n"), stdout
);
553 fputs (_(" binary use binary I/O for data\n"), stdout
);
555 fputs (_(" text use text I/O for data\n"), stdout
);
558 char const *siginfo_name
= (SIGINFO
== SIGUSR1
? "USR1" : "INFO");
561 Sending a %s signal to a running `dd' process makes it\n\
562 print I/O statistics to standard error and then resume copying.\n\
564 $ dd if=/dev/zero of=/dev/null& pid=$!\n\
565 $ kill -%s $pid; sleep 1; kill $pid\n\
566 18335302+0 records in\n\
567 18335302+0 records out\n\
568 9387674624 bytes (9.4 GB) copied, 34.6279 seconds, 271 MB/s\n\
573 siginfo_name
, siginfo_name
);
576 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
577 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
578 emit_bug_reporting_address ();
584 translate_charset (char const *new_trans
)
588 for (i
= 0; i
< 256; i
++)
589 trans_table
[i
] = new_trans
[trans_table
[i
]];
590 translation_needed
= true;
593 /* Return true if I has more than one bit set. I must be nonnegative. */
596 multiple_bits_set (int i
)
598 return MULTIPLE_BITS_SET (i
);
601 /* Print transfer statistics. */
606 xtime_t now
= gethrxtime ();
607 char hbuf
[LONGEST_HUMAN_READABLE
+ 1];
609 (human_autoscale
| human_round_to_nearest
610 | human_space_before_unit
| human_SI
| human_B
);
612 char const *bytes_per_second
;
615 _("%"PRIuMAX
"+%"PRIuMAX
" records in\n"
616 "%"PRIuMAX
"+%"PRIuMAX
" records out\n"),
617 r_full
, r_partial
, w_full
, w_partial
);
621 ngettext ("%"PRIuMAX
" truncated record\n",
622 "%"PRIuMAX
" truncated records\n",
623 select_plural (r_truncate
)),
626 if (status_flags
& STATUS_NOXFER
)
629 /* Use integer arithmetic to compute the transfer rate,
630 since that makes it easy to use SI abbreviations. */
633 ngettext ("%"PRIuMAX
" byte (%s) copied",
634 "%"PRIuMAX
" bytes (%s) copied",
635 select_plural (w_bytes
)),
637 human_readable (w_bytes
, hbuf
, human_opts
, 1, 1));
639 if (start_time
< now
)
641 double XTIME_PRECISIONe0
= XTIME_PRECISION
;
642 uintmax_t delta_xtime
= now
;
643 delta_xtime
-= start_time
;
644 delta_s
= delta_xtime
/ XTIME_PRECISIONe0
;
645 bytes_per_second
= human_readable (w_bytes
, hbuf
, human_opts
,
646 XTIME_PRECISION
, delta_xtime
);
651 bytes_per_second
= _("Infinity B");
654 /* TRANSLATORS: The two instances of "s" in this string are the SI
655 symbol "s" (meaning second), and should not be translated.
657 This format used to be:
659 ngettext (", %g second, %s/s\n", ", %g seconds, %s/s\n", delta_s == 1)
661 but that was incorrect for languages like Polish. To fix this
662 bug we now use SI symbols even though they're a bit more
663 confusing in English. */
664 fprintf (stderr
, _(", %g s, %s/s\n"), delta_s
, bytes_per_second
);
670 if (close (STDIN_FILENO
) < 0)
671 error (EXIT_FAILURE
, errno
,
672 _("closing input file %s"), quote (input_file
));
674 /* Don't remove this call to close, even though close_stdout
675 closes standard output. This close is necessary when cleanup
676 is called as part of a signal handler. */
677 if (close (STDOUT_FILENO
) < 0)
678 error (EXIT_FAILURE
, errno
,
679 _("closing output file %s"), quote (output_file
));
682 static void ATTRIBUTE_NORETURN
691 /* An ordinary signal was received; arrange for the program to exit. */
694 interrupt_handler (int sig
)
697 signal (sig
, SIG_DFL
);
698 interrupt_signal
= sig
;
701 /* An info signal was received; arrange for the program to print status. */
704 siginfo_handler (int sig
)
707 signal (sig
, siginfo_handler
);
711 /* Install the signal handlers. */
714 install_signal_handlers (void)
716 bool catch_siginfo
= ! (SIGINFO
== SIGUSR1
&& getenv ("POSIXLY_CORRECT"));
720 struct sigaction act
;
721 sigemptyset (&caught_signals
);
724 sigaction (SIGINFO
, NULL
, &act
);
725 if (act
.sa_handler
!= SIG_IGN
)
726 sigaddset (&caught_signals
, SIGINFO
);
728 sigaction (SIGINT
, NULL
, &act
);
729 if (act
.sa_handler
!= SIG_IGN
)
730 sigaddset (&caught_signals
, SIGINT
);
731 act
.sa_mask
= caught_signals
;
733 if (sigismember (&caught_signals
, SIGINFO
))
735 act
.sa_handler
= siginfo_handler
;
737 sigaction (SIGINFO
, &act
, NULL
);
740 if (sigismember (&caught_signals
, SIGINT
))
742 /* POSIX 1003.1-2001 says SA_RESETHAND implies SA_NODEFER,
743 but this is not true on Solaris 8 at least. It doesn't
744 hurt to use SA_NODEFER here, so leave it in. */
745 act
.sa_handler
= interrupt_handler
;
746 act
.sa_flags
= SA_NODEFER
| SA_RESETHAND
;
747 sigaction (SIGINT
, &act
, NULL
);
752 if (catch_siginfo
&& signal (SIGINFO
, SIG_IGN
) != SIG_IGN
)
754 signal (SIGINFO
, siginfo_handler
);
755 siginterrupt (SIGINFO
, 1);
757 if (signal (SIGINT
, SIG_IGN
) != SIG_IGN
)
759 signal (SIGINT
, interrupt_handler
);
760 siginterrupt (SIGINT
, 1);
765 /* Process any pending signals. If signals are caught, this function
766 should be called periodically. Ideally there should never be an
767 unbounded amount of time when signals are not being processed. */
770 process_signals (void)
772 while (interrupt_signal
| info_signal_count
)
778 sigprocmask (SIG_BLOCK
, &caught_signals
, &oldset
);
780 /* Reload interrupt_signal and info_signal_count, in case a new
781 signal was handled before sigprocmask took effect. */
782 interrupt
= interrupt_signal
;
783 infos
= info_signal_count
;
786 info_signal_count
= infos
- 1;
788 sigprocmask (SIG_SETMASK
, &oldset
, NULL
);
798 /* Read from FD into the buffer BUF of size SIZE, processing any
799 signals that arrive before bytes are read. Return the number of
800 bytes read if successful, -1 (setting errno) on failure. */
803 iread (int fd
, char *buf
, size_t size
)
809 nread
= read (fd
, buf
, size
);
810 if (! (nread
< 0 && errno
== EINTR
))
815 /* Wrapper around iread function to accumulate full blocks. */
817 iread_fullblock (int fd
, char *buf
, size_t size
)
823 ssize_t ncurr
= iread (fd
, buf
, size
);
836 /* Write to FD the buffer BUF of size SIZE, processing any signals
837 that arrive. Return the number of bytes written, setting errno if
838 this is less than SIZE. Keep trying if there are partial
842 iwrite (int fd
, char const *buf
, size_t size
)
844 size_t total_written
= 0;
846 if ((output_flags
& O_DIRECT
) && size
< output_blocksize
)
848 int old_flags
= fcntl (STDOUT_FILENO
, F_GETFL
);
849 if (fcntl (STDOUT_FILENO
, F_SETFL
, old_flags
& ~O_DIRECT
) != 0)
850 error (0, errno
, _("failed to turn off O_DIRECT: %s"),
851 quote (output_file
));
853 /* Since we have just turned off O_DIRECT for the final write,
854 here we try to preserve some of its semantics. First, use
855 posix_fadvise to tell the system not to pollute the buffer
856 cache with this data. Don't bother to diagnose lseek or
857 posix_fadvise failure. */
858 #ifdef POSIX_FADV_DONTNEED
859 off_t off
= lseek (STDOUT_FILENO
, 0, SEEK_CUR
);
861 ignore_value (posix_fadvise (STDOUT_FILENO
,
862 off
, 0, POSIX_FADV_DONTNEED
));
865 /* Attempt to ensure that that final block is committed
866 to disk as quickly as possible. */
867 conversions_mask
|= C_FSYNC
;
870 while (total_written
< size
)
874 nwritten
= write (fd
, buf
+ total_written
, size
- total_written
);
880 else if (nwritten
== 0)
882 /* Some buggy drivers return 0 when one tries to write beyond
883 a device's end. (Example: Linux kernel 1.2.13 on /dev/fd0.)
884 Set errno to ENOSPC so they get a sensible diagnostic. */
889 total_written
+= nwritten
;
892 return total_written
;
895 /* Write, then empty, the output buffer `obuf'. */
900 size_t nwritten
= iwrite (STDOUT_FILENO
, obuf
, output_blocksize
);
902 if (nwritten
!= output_blocksize
)
904 error (0, errno
, _("writing to %s"), quote (output_file
));
914 /* Return true if STR is of the form "PATTERN" or "PATTERNDELIM...". */
917 operand_matches (char const *str
, char const *pattern
, char delim
)
920 if (*str
++ != *pattern
++)
922 return !*str
|| *str
== delim
;
925 /* Interpret one "conv=..." or similar operand STR according to the
926 symbols in TABLE, returning the flags specified. If the operand
927 cannot be parsed, use ERROR_MSGID to generate a diagnostic. */
930 parse_symbols (char const *str
, struct symbol_value
const *table
,
931 char const *error_msgid
)
937 char const *strcomma
= strchr (str
, ',');
938 struct symbol_value
const *entry
;
941 ! (operand_matches (str
, entry
->symbol
, ',') && entry
->value
);
944 if (! entry
->symbol
[0])
946 size_t slen
= strcomma
? strcomma
- str
: strlen (str
);
947 error (0, 0, "%s: %s", _(error_msgid
),
948 quotearg_n_style_mem (0, locale_quoting_style
, str
, slen
));
949 usage (EXIT_FAILURE
);
953 value
|= entry
->value
;
962 /* Return the value of STR, interpreted as a non-negative decimal integer,
963 optionally multiplied by various values.
964 Set *INVALID if STR does not represent a number in this format. */
967 parse_integer (const char *str
, bool *invalid
)
971 enum strtol_error e
= xstrtoumax (str
, &suffix
, 10, &n
, "bcEGkKMPTwYZ0");
973 if (e
== LONGINT_INVALID_SUFFIX_CHAR
&& *suffix
== 'x')
975 uintmax_t multiplier
= parse_integer (suffix
+ 1, invalid
);
977 if (multiplier
!= 0 && n
* multiplier
/ multiplier
!= n
)
985 else if (e
!= LONGINT_OK
)
994 /* OPERAND is of the form "X=...". Return true if X is NAME. */
997 operand_is (char const *operand
, char const *name
)
999 return operand_matches (operand
, name
, '=');
1003 scanargs (int argc
, char *const *argv
)
1006 size_t blocksize
= 0;
1008 for (i
= optind
; i
< argc
; i
++)
1010 char const *name
= argv
[i
];
1011 char const *val
= strchr (name
, '=');
1015 error (0, 0, _("unrecognized operand %s"), quote (name
));
1016 usage (EXIT_FAILURE
);
1020 if (operand_is (name
, "if"))
1022 else if (operand_is (name
, "of"))
1024 else if (operand_is (name
, "conv"))
1025 conversions_mask
|= parse_symbols (val
, conversions
,
1026 N_("invalid conversion"));
1027 else if (operand_is (name
, "iflag"))
1028 input_flags
|= parse_symbols (val
, flags
,
1029 N_("invalid input flag"));
1030 else if (operand_is (name
, "oflag"))
1031 output_flags
|= parse_symbols (val
, flags
,
1032 N_("invalid output flag"));
1033 else if (operand_is (name
, "status"))
1034 status_flags
|= parse_symbols (val
, statuses
,
1035 N_("invalid status flag"));
1038 bool invalid
= false;
1039 uintmax_t n
= parse_integer (val
, &invalid
);
1041 if (operand_is (name
, "ibs"))
1043 invalid
|= ! (0 < n
&& n
<= MAX_BLOCKSIZE (INPUT_BLOCK_SLOP
));
1044 input_blocksize
= n
;
1046 else if (operand_is (name
, "obs"))
1048 invalid
|= ! (0 < n
&& n
<= MAX_BLOCKSIZE (OUTPUT_BLOCK_SLOP
));
1049 output_blocksize
= n
;
1051 else if (operand_is (name
, "bs"))
1053 invalid
|= ! (0 < n
&& n
<= MAX_BLOCKSIZE (INPUT_BLOCK_SLOP
));
1056 else if (operand_is (name
, "cbs"))
1058 invalid
|= ! (0 < n
&& n
<= SIZE_MAX
);
1059 conversion_blocksize
= n
;
1061 else if (operand_is (name
, "skip"))
1063 else if (operand_is (name
, "seek"))
1065 else if (operand_is (name
, "count"))
1069 error (0, 0, _("unrecognized operand %s"), quote (name
));
1070 usage (EXIT_FAILURE
);
1074 error (EXIT_FAILURE
, 0, _("invalid number %s"), quote (val
));
1079 input_blocksize
= output_blocksize
= blocksize
;
1082 /* POSIX says dd aggregates short reads into
1083 output_blocksize if bs= is not specified. */
1084 conversions_mask
|= C_TWOBUFS
;
1087 if (input_blocksize
== 0)
1088 input_blocksize
= DEFAULT_BLOCKSIZE
;
1089 if (output_blocksize
== 0)
1090 output_blocksize
= DEFAULT_BLOCKSIZE
;
1091 if (conversion_blocksize
== 0)
1092 conversions_mask
&= ~(C_BLOCK
| C_UNBLOCK
);
1094 if (input_flags
& (O_DSYNC
| O_SYNC
))
1095 input_flags
|= O_RSYNC
;
1097 if (output_flags
& O_FULLBLOCK
)
1099 error (0, 0, "%s: %s", _("invalid output flag"), "'fullblock'");
1100 usage (EXIT_FAILURE
);
1102 iread_fnc
= ((input_flags
& O_FULLBLOCK
)
1105 input_flags
&= ~O_FULLBLOCK
;
1107 if (multiple_bits_set (conversions_mask
& (C_ASCII
| C_EBCDIC
| C_IBM
)))
1108 error (EXIT_FAILURE
, 0, _("cannot combine any two of {ascii,ebcdic,ibm}"));
1109 if (multiple_bits_set (conversions_mask
& (C_BLOCK
| C_UNBLOCK
)))
1110 error (EXIT_FAILURE
, 0, _("cannot combine block and unblock"));
1111 if (multiple_bits_set (conversions_mask
& (C_LCASE
| C_UCASE
)))
1112 error (EXIT_FAILURE
, 0, _("cannot combine lcase and ucase"));
1113 if (multiple_bits_set (conversions_mask
& (C_EXCL
| C_NOCREAT
)))
1114 error (EXIT_FAILURE
, 0, _("cannot combine excl and nocreat"));
1117 /* Fix up translation table. */
1120 apply_translations (void)
1124 if (conversions_mask
& C_ASCII
)
1125 translate_charset (ebcdic_to_ascii
);
1127 if (conversions_mask
& C_UCASE
)
1129 for (i
= 0; i
< 256; i
++)
1130 trans_table
[i
] = toupper (trans_table
[i
]);
1131 translation_needed
= true;
1133 else if (conversions_mask
& C_LCASE
)
1135 for (i
= 0; i
< 256; i
++)
1136 trans_table
[i
] = tolower (trans_table
[i
]);
1137 translation_needed
= true;
1140 if (conversions_mask
& C_EBCDIC
)
1142 translate_charset (ascii_to_ebcdic
);
1143 newline_character
= ascii_to_ebcdic
['\n'];
1144 space_character
= ascii_to_ebcdic
[' '];
1146 else if (conversions_mask
& C_IBM
)
1148 translate_charset (ascii_to_ibm
);
1149 newline_character
= ascii_to_ibm
['\n'];
1150 space_character
= ascii_to_ibm
[' '];
1154 /* Apply the character-set translations specified by the user
1155 to the NREAD bytes in BUF. */
1158 translate_buffer (char *buf
, size_t nread
)
1163 for (i
= nread
, cp
= buf
; i
; i
--, cp
++)
1164 *cp
= trans_table
[to_uchar (*cp
)];
1167 /* If true, the last char from the previous call to `swab_buffer'
1168 is saved in `saved_char'. */
1169 static bool char_is_saved
= false;
1171 /* Odd char from previous call. */
1172 static char saved_char
;
1174 /* Swap NREAD bytes in BUF, plus possibly an initial char from the
1175 previous call. If NREAD is odd, save the last char for the
1176 next call. Return the new start of the BUF buffer. */
1179 swab_buffer (char *buf
, size_t *nread
)
1181 char *bufstart
= buf
;
1185 /* Is a char left from last time? */
1188 *--bufstart
= saved_char
;
1190 char_is_saved
= false;
1195 /* An odd number of chars are in the buffer. */
1196 saved_char
= bufstart
[--*nread
];
1197 char_is_saved
= true;
1200 /* Do the byte-swapping by moving every second character two
1201 positions toward the end, working from the end of the buffer
1202 toward the beginning. This way we only move half of the data. */
1204 cp
= bufstart
+ *nread
; /* Start one char past the last. */
1205 for (i
= *nread
/ 2; i
; i
--, cp
-= 2)
1211 /* Add OFFSET to the input offset, setting the overflow flag if
1215 advance_input_offset (uintmax_t offset
)
1217 input_offset
+= offset
;
1218 if (input_offset
< offset
)
1219 input_offset_overflow
= true;
1222 /* This is a wrapper for lseek. It detects and warns about a kernel
1223 bug that makes lseek a no-op for tape devices, even though the kernel
1224 lseek return value suggests that the function succeeded.
1226 The parameters are the same as those of the lseek function, but
1227 with the addition of FILENAME, the name of the file associated with
1228 descriptor FDESC. The file name is used solely in the warning that's
1229 printed when the bug is detected. Return the same value that lseek
1230 would have returned, but when the lseek bug is detected, return -1
1231 to indicate that lseek failed.
1233 The offending behavior has been confirmed with an Exabyte SCSI tape
1234 drive accessed via /dev/nst0 on both Linux 2.2.17 and 2.4.16 kernels. */
1238 # include <sys/mtio.h>
1240 # define MT_SAME_POSITION(P, Q) \
1241 ((P).mt_resid == (Q).mt_resid \
1242 && (P).mt_fileno == (Q).mt_fileno \
1243 && (P).mt_blkno == (Q).mt_blkno)
1246 skip_via_lseek (char const *filename
, int fdesc
, off_t offset
, int whence
)
1250 bool got_original_tape_position
= (ioctl (fdesc
, MTIOCGET
, &s1
) == 0);
1251 /* known bad device type */
1252 /* && s.mt_type == MT_ISSCSI2 */
1254 off_t new_position
= lseek (fdesc
, offset
, whence
);
1255 if (0 <= new_position
1256 && got_original_tape_position
1257 && ioctl (fdesc
, MTIOCGET
, &s2
) == 0
1258 && MT_SAME_POSITION (s1
, s2
))
1260 error (0, 0, _("warning: working around lseek kernel bug for file (%s)\n\
1261 of mt_type=0x%0lx -- see <sys/mtio.h> for the list of types"),
1262 filename
, s2
.mt_type
);
1267 return new_position
;
1270 # define skip_via_lseek(Filename, Fd, Offset, Whence) lseek (Fd, Offset, Whence)
1273 /* Throw away RECORDS blocks of BLOCKSIZE bytes on file descriptor FDESC,
1274 which is open with read permission for FILE. Store up to BLOCKSIZE
1275 bytes of the data at a time in BUF, if necessary. RECORDS must be
1276 nonzero. If fdesc is STDIN_FILENO, advance the input offset.
1277 Return the number of records remaining, i.e., that were not skipped
1278 because EOF was reached. */
1281 skip (int fdesc
, char const *file
, uintmax_t records
, size_t blocksize
,
1284 uintmax_t offset
= records
* blocksize
;
1286 /* Try lseek and if an error indicates it was an inappropriate operation --
1287 or if the file offset is not representable as an off_t --
1288 fall back on using read. */
1291 if (records
<= OFF_T_MAX
/ blocksize
1292 && 0 <= skip_via_lseek (file
, fdesc
, offset
, SEEK_CUR
))
1294 if (fdesc
== STDIN_FILENO
)
1297 if (fstat (STDIN_FILENO
, &st
) != 0)
1298 error (EXIT_FAILURE
, errno
, _("cannot fstat %s"), quote (file
));
1299 if (S_ISREG (st
.st_mode
) && st
.st_size
< (input_offset
+ offset
))
1301 /* When skipping past EOF, return the number of _full_ blocks
1302 * that are not skipped, and set offset to EOF, so the caller
1303 * can determine the requested skip was not satisfied. */
1304 records
= ( offset
- st
.st_size
) / blocksize
;
1305 offset
= st
.st_size
- input_offset
;
1309 advance_input_offset (offset
);
1317 int lseek_errno
= errno
;
1320 /* The seek request may have failed above if it was too big
1321 (> device size, > max file size, etc.)
1322 Or it may not have been done at all (> OFF_T_MAX).
1323 Therefore try to seek to the end of the file,
1324 to avoid redundant reading. */
1325 if ((soffset
= skip_via_lseek (file
, fdesc
, 0, SEEK_END
)) >= 0)
1327 /* File is seekable, and we're at the end of it, and
1328 size <= OFF_T_MAX. So there's no point using read to advance. */
1332 /* The original seek was not attempted as offset > OFF_T_MAX.
1333 We should error for write as can't get to the desired
1334 location, even if OFF_T_MAX < max file size.
1335 For read we're not going to read any data anyway,
1336 so we should error for consistency.
1337 It would be nice to not error for /dev/{zero,null}
1338 for any offset, but that's not a significant issue. */
1339 lseek_errno
= EOVERFLOW
;
1342 if (fdesc
== STDIN_FILENO
)
1343 error (0, lseek_errno
, _("%s: cannot skip"), quote (file
));
1345 error (0, lseek_errno
, _("%s: cannot seek"), quote (file
));
1346 /* If the file has a specific size and we've asked
1347 to skip/seek beyond the max allowable, then quit. */
1348 quit (EXIT_FAILURE
);
1350 /* else file_size && offset > OFF_T_MAX or file ! seekable */
1354 ssize_t nread
= iread_fnc (fdesc
, buf
, blocksize
);
1357 if (fdesc
== STDIN_FILENO
)
1359 error (0, errno
, _("reading %s"), quote (file
));
1360 if (conversions_mask
& C_NOERROR
)
1367 error (0, lseek_errno
, _("%s: cannot seek"), quote (file
));
1368 quit (EXIT_FAILURE
);
1373 if (fdesc
== STDIN_FILENO
)
1374 advance_input_offset (nread
);
1376 while (--records
!= 0);
1382 /* Advance the input by NBYTES if possible, after a read error.
1383 The input file offset may or may not have advanced after the failed
1384 read; adjust it to point just after the bad record regardless.
1385 Return true if successful, or if the input is already known to not
1389 advance_input_after_read_error (size_t nbytes
)
1391 if (! input_seekable
)
1393 if (input_seek_errno
== ESPIPE
)
1395 errno
= input_seek_errno
;
1400 advance_input_offset (nbytes
);
1401 input_offset_overflow
|= (OFF_T_MAX
< input_offset
);
1402 if (input_offset_overflow
)
1404 error (0, 0, _("offset overflow while reading file %s"),
1405 quote (input_file
));
1408 offset
= lseek (STDIN_FILENO
, 0, SEEK_CUR
);
1412 if (offset
== input_offset
)
1414 diff
= input_offset
- offset
;
1415 if (! (0 <= diff
&& diff
<= nbytes
))
1416 error (0, 0, _("warning: invalid file offset after failed read"));
1417 if (0 <= skip_via_lseek (input_file
, STDIN_FILENO
, diff
, SEEK_CUR
))
1420 error (0, 0, _("cannot work around kernel bug after all"));
1424 error (0, errno
, _("%s: cannot seek"), quote (input_file
));
1428 /* Copy NREAD bytes of BUF, with no conversions. */
1431 copy_simple (char const *buf
, size_t nread
)
1433 const char *start
= buf
; /* First uncopied char in BUF. */
1437 size_t nfree
= MIN (nread
, output_blocksize
- oc
);
1439 memcpy (obuf
+ oc
, start
, nfree
);
1441 nread
-= nfree
; /* Update the number of bytes left to copy. */
1444 if (oc
>= output_blocksize
)
1450 /* Copy NREAD bytes of BUF, doing conv=block
1451 (pad newline-terminated records to `conversion_blocksize',
1452 replacing the newline with trailing spaces). */
1455 copy_with_block (char const *buf
, size_t nread
)
1459 for (i
= nread
; i
; i
--, buf
++)
1461 if (*buf
== newline_character
)
1463 if (col
< conversion_blocksize
)
1466 for (j
= col
; j
< conversion_blocksize
; j
++)
1467 output_char (space_character
);
1473 if (col
== conversion_blocksize
)
1475 else if (col
< conversion_blocksize
)
1482 /* Copy NREAD bytes of BUF, doing conv=unblock
1483 (replace trailing spaces in `conversion_blocksize'-sized records
1487 copy_with_unblock (char const *buf
, size_t nread
)
1491 static size_t pending_spaces
= 0;
1493 for (i
= 0; i
< nread
; i
++)
1497 if (col
++ >= conversion_blocksize
)
1499 col
= pending_spaces
= 0; /* Wipe out any pending spaces. */
1500 i
--; /* Push the char back; get it later. */
1501 output_char (newline_character
);
1503 else if (c
== space_character
)
1507 /* `c' is the character after a run of spaces that were not
1508 at the end of the conversion buffer. Output them. */
1509 while (pending_spaces
)
1511 output_char (space_character
);
1519 /* Set the file descriptor flags for FD that correspond to the nonzero bits
1520 in ADD_FLAGS. The file's name is NAME. */
1523 set_fd_flags (int fd
, int add_flags
, char const *name
)
1525 /* Ignore file creation flags that are no-ops on file descriptors. */
1526 add_flags
&= ~ (O_NOCTTY
| O_NOFOLLOW
);
1530 int old_flags
= fcntl (fd
, F_GETFL
);
1531 int new_flags
= old_flags
| add_flags
;
1535 else if (old_flags
!= new_flags
)
1537 if (new_flags
& (O_DIRECTORY
| O_NOLINKS
))
1539 /* NEW_FLAGS contains at least one file creation flag that
1540 requires some checking of the open file descriptor. */
1542 if (fstat (fd
, &st
) != 0)
1544 else if ((new_flags
& O_DIRECTORY
) && ! S_ISDIR (st
.st_mode
))
1549 else if ((new_flags
& O_NOLINKS
) && 1 < st
.st_nlink
)
1554 new_flags
&= ~ (O_DIRECTORY
| O_NOLINKS
);
1557 if (ok
&& old_flags
!= new_flags
1558 && fcntl (fd
, F_SETFL
, new_flags
) == -1)
1563 error (EXIT_FAILURE
, errno
, _("setting flags for %s"), quote (name
));
1567 /* The main loop. */
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
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
= xmalloc (input_blocksize
+ INPUT_BLOCK_SLOP
);
1605 ibuf
+= SWAB_ALIGN_OFFSET
; /* allow space for swab */
1607 ibuf
= ptr_align (ibuf
, page_size
);
1609 if (conversions_mask
& C_TWOBUFS
)
1611 /* Page-align the output buffer, too. */
1612 real_obuf
= xmalloc (output_blocksize
+ OUTPUT_BLOCK_SLOP
);
1613 obuf
= ptr_align (real_obuf
, page_size
);
1621 if (skip_records
!= 0)
1623 uintmax_t us_bytes
= input_offset
+ (skip_records
* input_blocksize
);
1624 uintmax_t us_blocks
= skip (STDIN_FILENO
, input_file
,
1625 skip_records
, input_blocksize
, ibuf
);
1626 us_bytes
-= input_offset
;
1628 /* POSIX doesn't say what to do when dd detects it has been
1629 asked to skip past EOF, so I assume it's non-fatal.
1630 There are 3 reasons why there might be unskipped blocks/bytes:
1631 1. file is too small
1632 2. pipe has not enough data
1634 if (us_blocks
|| (!input_offset_overflow
&& us_bytes
))
1637 _("%s: cannot skip to specified offset"), quote (input_file
));
1641 if (seek_records
!= 0)
1643 uintmax_t write_records
= skip (STDOUT_FILENO
, output_file
,
1644 seek_records
, output_blocksize
, obuf
);
1646 if (write_records
!= 0)
1648 memset (obuf
, 0, output_blocksize
);
1651 if (iwrite (STDOUT_FILENO
, obuf
, output_blocksize
)
1652 != output_blocksize
)
1654 error (0, errno
, _("writing to %s"), quote (output_file
));
1655 quit (EXIT_FAILURE
);
1657 while (--write_records
!= 0);
1661 if (max_records
== 0)
1666 if (r_partial
+ r_full
>= max_records
)
1669 /* Zero the buffer before reading, so that if we get a read error,
1670 whatever data we are able to read is followed by zeros.
1671 This minimizes data loss. */
1672 if ((conversions_mask
& C_SYNC
) && (conversions_mask
& C_NOERROR
))
1674 (conversions_mask
& (C_BLOCK
| C_UNBLOCK
)) ? ' ' : '\0',
1677 nread
= iread_fnc (STDIN_FILENO
, ibuf
, input_blocksize
);
1684 error (0, errno
, _("reading %s"), quote (input_file
));
1685 if (conversions_mask
& C_NOERROR
)
1688 /* Seek past the bad block if possible. */
1689 if (!advance_input_after_read_error (input_blocksize
- partread
))
1691 exit_status
= EXIT_FAILURE
;
1693 /* Suppress duplicate diagnostics. */
1694 input_seekable
= false;
1695 input_seek_errno
= ESPIPE
;
1697 if ((conversions_mask
& C_SYNC
) && !partread
)
1698 /* Replace the missing input with null bytes and
1699 proceed normally. */
1706 /* Write any partial block. */
1707 exit_status
= EXIT_FAILURE
;
1712 n_bytes_read
= nread
;
1713 advance_input_offset (nread
);
1715 if (n_bytes_read
< input_blocksize
)
1718 partread
= n_bytes_read
;
1719 if (conversions_mask
& C_SYNC
)
1721 if (!(conversions_mask
& C_NOERROR
))
1722 /* If C_NOERROR, we zeroed the block before reading. */
1723 memset (ibuf
+ n_bytes_read
,
1724 (conversions_mask
& (C_BLOCK
| C_UNBLOCK
)) ? ' ' : '\0',
1725 input_blocksize
- n_bytes_read
);
1726 n_bytes_read
= input_blocksize
;
1735 if (ibuf
== obuf
) /* If not C_TWOBUFS. */
1737 size_t nwritten
= iwrite (STDOUT_FILENO
, obuf
, n_bytes_read
);
1738 w_bytes
+= nwritten
;
1739 if (nwritten
!= n_bytes_read
)
1741 error (0, errno
, _("writing %s"), quote (output_file
));
1742 return EXIT_FAILURE
;
1744 else if (n_bytes_read
== input_blocksize
)
1751 /* Do any translations on the whole buffer at once. */
1753 if (translation_needed
)
1754 translate_buffer (ibuf
, n_bytes_read
);
1756 if (conversions_mask
& C_SWAB
)
1757 bufstart
= swab_buffer (ibuf
, &n_bytes_read
);
1761 if (conversions_mask
& C_BLOCK
)
1762 copy_with_block (bufstart
, n_bytes_read
);
1763 else if (conversions_mask
& C_UNBLOCK
)
1764 copy_with_unblock (bufstart
, n_bytes_read
);
1766 copy_simple (bufstart
, n_bytes_read
);
1769 /* If we have a char left as a result of conv=swab, output it. */
1772 if (conversions_mask
& C_BLOCK
)
1773 copy_with_block (&saved_char
, 1);
1774 else if (conversions_mask
& C_UNBLOCK
)
1775 copy_with_unblock (&saved_char
, 1);
1777 output_char (saved_char
);
1780 if ((conversions_mask
& C_BLOCK
) && col
> 0)
1782 /* If the final input line didn't end with a '\n', pad
1783 the output block to `conversion_blocksize' chars. */
1785 for (i
= col
; i
< conversion_blocksize
; i
++)
1786 output_char (space_character
);
1789 if ((conversions_mask
& C_UNBLOCK
) && col
== conversion_blocksize
)
1790 /* Add a final '\n' if there are exactly `conversion_blocksize'
1791 characters in the final record. */
1792 output_char (newline_character
);
1794 /* Write out the last block. */
1797 size_t nwritten
= iwrite (STDOUT_FILENO
, obuf
, oc
);
1798 w_bytes
+= nwritten
;
1803 error (0, errno
, _("writing %s"), quote (output_file
));
1804 return EXIT_FAILURE
;
1808 if ((conversions_mask
& C_FDATASYNC
) && fdatasync (STDOUT_FILENO
) != 0)
1810 if (errno
!= ENOSYS
&& errno
!= EINVAL
)
1812 error (0, errno
, _("fdatasync failed for %s"), quote (output_file
));
1813 exit_status
= EXIT_FAILURE
;
1815 conversions_mask
|= C_FSYNC
;
1818 if (conversions_mask
& C_FSYNC
)
1819 while (fsync (STDOUT_FILENO
) != 0)
1822 error (0, errno
, _("fsync failed for %s"), quote (output_file
));
1823 return EXIT_FAILURE
;
1830 main (int argc
, char **argv
)
1836 install_signal_handlers ();
1838 initialize_main (&argc
, &argv
);
1839 set_program_name (argv
[0]);
1840 setlocale (LC_ALL
, "");
1841 bindtextdomain (PACKAGE
, LOCALEDIR
);
1842 textdomain (PACKAGE
);
1844 /* Arrange to close stdout if parse_long_options exits. */
1845 atexit (maybe_close_stdout
);
1847 page_size
= getpagesize ();
1849 parse_long_options (argc
, argv
, PROGRAM_NAME
, PACKAGE
, Version
,
1850 usage
, AUTHORS
, (char const *) NULL
);
1851 close_stdout_required
= false;
1853 if (getopt_long (argc
, argv
, "", NULL
, NULL
) != -1)
1854 usage (EXIT_FAILURE
);
1856 /* Initialize translation table to identity translation. */
1857 for (i
= 0; i
< 256; i
++)
1860 /* Decode arguments. */
1861 scanargs (argc
, argv
);
1863 apply_translations ();
1865 if (input_file
== NULL
)
1867 input_file
= _("standard input");
1868 set_fd_flags (STDIN_FILENO
, input_flags
, input_file
);
1872 if (fd_reopen (STDIN_FILENO
, input_file
, O_RDONLY
| input_flags
, 0) < 0)
1873 error (EXIT_FAILURE
, errno
, _("opening %s"), quote (input_file
));
1876 offset
= lseek (STDIN_FILENO
, 0, SEEK_CUR
);
1877 input_seekable
= (0 <= offset
);
1878 input_offset
= MAX(0, offset
);
1879 input_seek_errno
= errno
;
1881 if (output_file
== NULL
)
1883 output_file
= _("standard output");
1884 set_fd_flags (STDOUT_FILENO
, output_flags
, output_file
);
1888 mode_t perms
= S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
;
1891 | (conversions_mask
& C_NOCREAT
? 0 : O_CREAT
)
1892 | (conversions_mask
& C_EXCL
? O_EXCL
: 0)
1893 | (seek_records
|| (conversions_mask
& C_NOTRUNC
) ? 0 : O_TRUNC
));
1895 /* Open the output file with *read* access only if we might
1896 need to read to satisfy a `seek=' request. If we can't read
1897 the file, go ahead with write-only access; it might work. */
1899 || fd_reopen (STDOUT_FILENO
, output_file
, O_RDWR
| opts
, perms
) < 0)
1900 && (fd_reopen (STDOUT_FILENO
, output_file
, O_WRONLY
| opts
, perms
)
1902 error (EXIT_FAILURE
, errno
, _("opening %s"), quote (output_file
));
1904 if (seek_records
!= 0 && !(conversions_mask
& C_NOTRUNC
))
1906 uintmax_t size
= seek_records
* output_blocksize
;
1907 unsigned long int obs
= output_blocksize
;
1909 if (OFF_T_MAX
/ output_blocksize
< seek_records
)
1910 error (EXIT_FAILURE
, 0,
1911 _("offset too large: "
1912 "cannot truncate to a length of seek=%"PRIuMAX
""
1913 " (%lu-byte) blocks"),
1916 if (ftruncate (STDOUT_FILENO
, size
) != 0)
1918 /* Complain only when ftruncate fails on a regular file, a
1919 directory, or a shared memory object, as POSIX 1003.1-2004
1920 specifies ftruncate's behavior only for these file types.
1921 For example, do not complain when Linux kernel 2.4 ftruncate
1922 fails on /dev/fd0. */
1923 int ftruncate_errno
= errno
;
1924 struct stat stdout_stat
;
1925 if (fstat (STDOUT_FILENO
, &stdout_stat
) != 0)
1926 error (EXIT_FAILURE
, errno
, _("cannot fstat %s"),
1927 quote (output_file
));
1928 if (S_ISREG (stdout_stat
.st_mode
)
1929 || S_ISDIR (stdout_stat
.st_mode
)
1930 || S_TYPEISSHM (&stdout_stat
))
1931 error (EXIT_FAILURE
, ftruncate_errno
,
1932 _("failed to truncate to %"PRIuMAX
" bytes in output file %s"),
1933 size
, quote (output_file
));
1938 start_time
= gethrxtime ();
1940 exit_status
= dd_copy ();