1 /* od -- dump files in octal and other formats
2 Copyright (C) 92, 1995-2006 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 2, or (at your option)
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, write to the Free Software Foundation,
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
18 /* Written by Jim Meyering. */
25 #include <sys/types.h>
31 /* The official name of this program (e.g., no `g' prefix). */
32 #define PROGRAM_NAME "od"
34 #define AUTHORS "Jim Meyering"
38 #ifdef HAVE_LONG_DOUBLE
39 typedef long double LONG_DOUBLE
;
41 typedef double LONG_DOUBLE
;
44 /* The default number of input bytes per output line. */
45 #define DEFAULT_BYTES_PER_BLOCK 16
47 /* The number of decimal digits of precision in a float. */
52 /* The number of decimal digits of precision in a double. */
57 /* The number of decimal digits of precision in a long double. */
59 # define LDBL_DIG DBL_DIG
62 #if HAVE_UNSIGNED_LONG_LONG_INT
63 typedef unsigned long long int unsigned_long_long_int
;
65 /* This is just a place-holder to avoid a few `#if' directives.
66 In this case, the type isn't actually used. */
67 typedef unsigned long int unsigned_long_long_int
;
78 /* FIXME: add INTMAX support, too */
96 /* The maximum number of bytes needed for a format string,
97 including the trailing null. */
100 FMT_BYTES_ALLOCATED
=
101 MAX ((sizeof " %0" - 1 + INT_STRLEN_BOUND (int)
107 sizeof " %.Le" + 2 * INT_STRLEN_BOUND (int))
110 /* Each output format specification (from `-t spec' or from
111 old-style options) is represented by one of these structures. */
114 enum output_format fmt
;
116 void (*print_function
) (size_t, void const *, char const *);
117 char fmt_string
[FMT_BYTES_ALLOCATED
];
118 bool hexl_mode_trailer
;
122 /* The name this program was run with. */
125 /* Convert the number of 8-bit bytes of a binary representation to
126 the number of characters (digits + sign if the type is signed)
127 required to represent the same quantity in the specified base/type.
128 For example, a 32-bit (4-byte) quantity may require a field width
129 as wide as the following for these types:
133 8 unsigned hexadecimal */
135 static unsigned int const bytes_to_oct_digits
[] =
136 {0, 3, 6, 8, 11, 14, 16, 19, 22, 25, 27, 30, 32, 35, 38, 41, 43};
138 static unsigned int const bytes_to_signed_dec_digits
[] =
139 {1, 4, 6, 8, 11, 13, 16, 18, 20, 23, 25, 28, 30, 33, 35, 37, 40};
141 static unsigned int const bytes_to_unsigned_dec_digits
[] =
142 {0, 3, 5, 8, 10, 13, 15, 17, 20, 22, 25, 27, 29, 32, 34, 37, 39};
144 static unsigned int const bytes_to_hex_digits
[] =
145 {0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32};
147 #define MAX_INTEGRAL_TYPE_SIZE sizeof (unsigned_long_long_int)
149 /* It'll be a while before we see integral types wider than 16 bytes,
150 but if/when it happens, this check will catch it. Without this check,
151 a wider type would provoke a buffer overrun. */
152 verify (MAX_INTEGRAL_TYPE_SIZE
153 < sizeof bytes_to_hex_digits
/ sizeof *bytes_to_hex_digits
);
155 /* Make sure the other arrays have the same length. */
156 verify (sizeof bytes_to_oct_digits
== sizeof bytes_to_signed_dec_digits
);
157 verify (sizeof bytes_to_oct_digits
== sizeof bytes_to_unsigned_dec_digits
);
158 verify (sizeof bytes_to_oct_digits
== sizeof bytes_to_hex_digits
);
160 /* Convert enum size_spec to the size of the named type. */
161 static const int width_bytes
[] =
168 sizeof (unsigned_long_long_int
),
174 /* Ensure that for each member of `enum size_spec' there is an
175 initializer in the width_bytes array. */
176 verify (sizeof width_bytes
/ sizeof width_bytes
[0] == N_SIZE_SPECS
);
178 /* Names for some non-printing characters. */
179 static const char *const charname
[33] =
181 "nul", "soh", "stx", "etx", "eot", "enq", "ack", "bel",
182 "bs", "ht", "nl", "vt", "ff", "cr", "so", "si",
183 "dle", "dc1", "dc2", "dc3", "dc4", "nak", "syn", "etb",
184 "can", "em", "sub", "esc", "fs", "gs", "rs", "us",
188 /* Address base (8, 10 or 16). */
189 static int address_base
;
191 /* The number of octal digits required to represent the largest
193 #define MAX_ADDRESS_LENGTH \
194 ((sizeof (uintmax_t) * CHAR_BIT + CHAR_BIT - 1) / 3)
196 /* Width of a normal address. */
197 static int address_pad_len
;
199 static size_t string_min
;
200 static bool flag_dump_strings
;
202 /* True if we should recognize the older non-option arguments
203 that specified at most one file and optional arguments specifying
204 offset and pseudo-start address. */
205 static bool traditional
;
207 /* True if an old-style `pseudo-address' was specified. */
208 static bool flag_pseudo_start
;
210 /* The difference between the old-style pseudo starting address and
211 the number of bytes to skip. */
212 static uintmax_t pseudo_offset
;
214 /* Function that accepts an address and an optional following char,
215 and prints the address and char to stdout. */
216 static void (*format_address
) (uintmax_t, char);
218 /* The number of input bytes to skip before formatting and writing. */
219 static uintmax_t n_bytes_to_skip
= 0;
221 /* When false, MAX_BYTES_TO_FORMAT and END_OFFSET are ignored, and all
222 input is formatted. */
223 static bool limit_bytes_to_format
= false;
225 /* The maximum number of bytes that will be formatted. */
226 static uintmax_t max_bytes_to_format
;
228 /* The offset of the first byte after the last byte to be formatted. */
229 static uintmax_t end_offset
;
231 /* When true and two or more consecutive blocks are equal, format
232 only the first block and output an asterisk alone on the following
233 line to indicate that identical blocks have been elided. */
234 static bool abbreviate_duplicate_blocks
= true;
236 /* An array of specs describing how to format each input block. */
237 static struct tspec
*spec
;
239 /* The number of format specs. */
240 static size_t n_specs
;
242 /* The allocated length of SPEC. */
243 static size_t n_specs_allocated
;
245 /* The number of input bytes formatted per output line. It must be
246 a multiple of the least common multiple of the sizes associated with
247 the specified output types. It should be as large as possible, but
248 no larger than 16 -- unless specified with the -w option. */
249 static size_t bytes_per_block
;
251 /* Human-readable representation of *file_list (for error messages).
252 It differs from file_list[-1] only when file_list[-1] is "-". */
253 static char const *input_filename
;
255 /* A NULL-terminated list of the file-arguments from the command line. */
256 static char const *const *file_list
;
258 /* Initializer for file_list if no file-arguments
259 were specified on the command line. */
260 static char const *const default_file_list
[] = {"-", NULL
};
262 /* The input stream associated with the current file. */
263 static FILE *in_stream
;
265 /* If true, at least one of the files we read was standard input. */
266 static bool have_read_stdin
;
268 /* Map the size in bytes to a type identifier. */
269 static enum size_spec integral_type_size
[MAX_INTEGRAL_TYPE_SIZE
+ 1];
271 #define MAX_FP_TYPE_SIZE sizeof (LONG_DOUBLE)
272 static enum size_spec fp_type_size
[MAX_FP_TYPE_SIZE
+ 1];
274 static char const short_options
[] = "A:aBbcDdeFfHhIij:LlN:OoS:st:vw::Xx";
276 /* For long options that have no equivalent short option, use a
277 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
280 TRADITIONAL_OPTION
= CHAR_MAX
+ 1
283 static struct option
const long_options
[] =
285 {"skip-bytes", required_argument
, NULL
, 'j'},
286 {"address-radix", required_argument
, NULL
, 'A'},
287 {"read-bytes", required_argument
, NULL
, 'N'},
288 {"format", required_argument
, NULL
, 't'},
289 {"output-duplicates", no_argument
, NULL
, 'v'},
290 {"strings", optional_argument
, NULL
, 'S'},
291 {"traditional", no_argument
, NULL
, TRADITIONAL_OPTION
},
292 {"width", optional_argument
, NULL
, 'w'},
294 {GETOPT_HELP_OPTION_DECL
},
295 {GETOPT_VERSION_OPTION_DECL
},
302 if (status
!= EXIT_SUCCESS
)
303 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
308 Usage: %s [OPTION]... [FILE]...\n\
309 or: %s [-abcdfilosx]... [FILE] [[+]OFFSET[.][b]]\n\
310 or: %s --traditional [OPTION]... [FILE] [[+]OFFSET[.][b] [+][LABEL][.][b]]\n\
312 program_name
, program_name
, program_name
);
314 Write an unambiguous representation, octal bytes by default,\n\
315 of FILE to standard output. With more than one FILE argument,\n\
316 concatenate them in the listed order to form the input.\n\
317 With no FILE, or when FILE is -, read standard input.\n\
321 All arguments to long options are mandatory for short options.\n\
324 -A, --address-radix=RADIX decide how file offsets are printed\n\
325 -j, --skip-bytes=BYTES skip BYTES input bytes first\n\
328 -N, --read-bytes=BYTES limit dump to BYTES input bytes\n\
329 -S, --strings[=BYTES] output strings of at least BYTES graphic chars\n\
330 -t, --format=TYPE select output format or formats\n\
331 -v, --output-duplicates do not use * to mark line suppression\n\
332 -w, --width[=BYTES] output BYTES bytes per output line\n\
333 --traditional accept arguments in traditional form\n\
335 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
336 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
339 Traditional format specifications may be intermixed; they accumulate:\n\
340 -a same as -t a, select named characters, ignoring high-order bit\n\
341 -b same as -t o1, select octal bytes\n\
342 -c same as -t c, select ASCII characters or backslash escapes\n\
343 -d same as -t u2, select unsigned decimal 2-byte units\n\
346 -f same as -t fF, select floats\n\
347 -i same as -t dI, select decimal ints\n\
348 -l same as -t dL, select decimal longs\n\
349 -o same as -t o2, select octal 2-byte units\n\
350 -s same as -t d2, select decimal 2-byte units\n\
351 -x same as -t x2, select hexadecimal 2-byte units\n\
355 If first and second call formats both apply, the second format is assumed\n\
356 if the last operand begins with + or (if there are 2 operands) a digit.\n\
357 An OFFSET operand means -j OFFSET. LABEL is the pseudo-address\n\
358 at first byte printed, incremented when dump is progressing.\n\
359 For OFFSET and LABEL, a 0x or 0X prefix indicates hexadecimal;\n\
360 suffixes may be . for octal and b for multiply by 512.\n\
364 TYPE is made up of one or more of these specifications:\n\
366 a named character, ignoring high-order bit\n\
367 c ASCII character or backslash escape\n\
370 d[SIZE] signed decimal, SIZE bytes per integer\n\
371 f[SIZE] floating point, SIZE bytes per integer\n\
372 o[SIZE] octal, SIZE bytes per integer\n\
373 u[SIZE] unsigned decimal, SIZE bytes per integer\n\
374 x[SIZE] hexadecimal, SIZE bytes per integer\n\
378 SIZE is a number. For TYPE in doux, SIZE may also be C for\n\
379 sizeof(char), S for sizeof(short), I for sizeof(int) or L for\n\
380 sizeof(long). If TYPE is f, SIZE may also be F for sizeof(float), D\n\
381 for sizeof(double) or L for sizeof(long double).\n\
385 RADIX is d for decimal, o for octal, x for hexadecimal or n for none.\n\
386 BYTES is hexadecimal with 0x or 0X prefix, and may have a multiplier suffix:\n\
387 b 512, kB 1000, K 1024, MB 1000*1000, M 1024*1024,\n\
388 GB 1000*1000*1000, G 1024*1024*1024, and so on for T, P, E, Z, Y.\n\
389 Adding a z suffix to any type displays printable characters at the end of each\n\
393 --string without a number implies 3. --width without a number\n\
394 implies 32. By default, od uses -A o -t d2 -w16.\n\
396 emit_bug_reporting_address ();
401 /* Define the print functions. */
404 print_s_char (size_t n_bytes
, void const *block
, char const *fmt_string
)
406 signed char const *p
= block
;
408 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
409 printf (fmt_string
, *p
++);
413 print_char (size_t n_bytes
, void const *block
, char const *fmt_string
)
415 unsigned char const *p
= block
;
417 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
418 printf (fmt_string
, *p
++);
422 print_s_short (size_t n_bytes
, void const *block
, char const *fmt_string
)
424 short int const *p
= block
;
426 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
427 printf (fmt_string
, *p
++);
431 print_short (size_t n_bytes
, void const *block
, char const *fmt_string
)
433 unsigned short int const *p
= block
;
435 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
436 printf (fmt_string
, *p
++);
440 print_int (size_t n_bytes
, void const *block
, char const *fmt_string
)
442 unsigned int const *p
= block
;
444 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
445 printf (fmt_string
, *p
++);
449 print_long (size_t n_bytes
, void const *block
, char const *fmt_string
)
451 unsigned long int const *p
= block
;
453 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
454 printf (fmt_string
, *p
++);
458 print_long_long (size_t n_bytes
, void const *block
, char const *fmt_string
)
460 unsigned_long_long_int
const *p
= block
;
462 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
463 printf (fmt_string
, *p
++);
467 print_float (size_t n_bytes
, void const *block
, char const *fmt_string
)
469 float const *p
= block
;
471 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
472 printf (fmt_string
, *p
++);
476 print_double (size_t n_bytes
, void const *block
, char const *fmt_string
)
478 double const *p
= block
;
480 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
481 printf (fmt_string
, *p
++);
484 #ifdef HAVE_LONG_DOUBLE
486 print_long_double (size_t n_bytes
, void const *block
, char const *fmt_string
)
488 long double const *p
= block
;
490 for (i
= n_bytes
/ sizeof *p
; i
!= 0; i
--)
491 printf (fmt_string
, *p
++);
496 dump_hexl_mode_trailer (size_t n_bytes
, const char *block
)
499 fputs (" >", stdout
);
500 for (i
= n_bytes
; i
> 0; i
--)
502 unsigned char c
= *block
++;
503 unsigned char c2
= (isprint (c
) ? c
: '.');
510 print_named_ascii (size_t n_bytes
, void const *block
,
511 const char *unused_fmt_string ATTRIBUTE_UNUSED
)
513 unsigned char const *p
= block
;
515 for (i
= n_bytes
; i
> 0; i
--)
517 int masked_c
= *p
++ & 0x7f;
523 else if (masked_c
<= 040)
524 s
= charname
[masked_c
];
527 sprintf (buf
, " %c", masked_c
);
536 print_ascii (size_t n_bytes
, void const *block
,
537 const char *unused_fmt_string ATTRIBUTE_UNUSED
)
539 unsigned char const *p
= block
;
541 for (i
= n_bytes
; i
> 0; i
--)
543 unsigned char c
= *p
++;
582 sprintf (buf
, (isprint (c
) ? " %c" : "%03o"), c
);
590 /* Convert a null-terminated (possibly zero-length) string S to an
591 unsigned long integer value. If S points to a non-digit set *P to S,
592 *VAL to 0, and return true. Otherwise, accumulate the integer value of
593 the string of digits. If the string of digits represents a value
594 larger than ULONG_MAX, don't modify *VAL or *P and return false.
595 Otherwise, advance *P to the first non-digit after S, set *VAL to
596 the result of the conversion and return true. */
599 simple_strtoul (const char *s
, const char **p
, unsigned long int *val
)
601 unsigned long int sum
;
607 if (sum
> (ULONG_MAX
- c
) / 10)
616 /* If S points to a single valid modern od format string, put
617 a description of that format in *TSPEC, make *NEXT point at the
618 character following the just-decoded format (if *NEXT is non-NULL),
619 and return true. If S is not valid, don't modify *NEXT or *TSPEC,
620 give a diagnostic, and return false. For example, if S were
621 "d4afL" *NEXT would be set to "afL" and *TSPEC would be
623 fmt = SIGNED_DECIMAL;
624 size = INT or LONG; (whichever integral_type_size[4] resolves to)
625 print_function = print_int; (assuming size == INT)
626 fmt_string = "%011d%c";
628 S_ORIG is solely for reporting errors. It should be the full format
633 decode_one_format (const char *s_orig
, const char *s
, const char **next
,
636 enum size_spec size_spec
;
637 unsigned long int size
;
638 enum output_format fmt
;
639 const char *pre_fmt_string
;
640 void (*print_function
) (size_t, void const *, char const *);
646 assert (tspec
!= NULL
);
660 size
= sizeof (char);
665 size
= sizeof (short int);
675 size
= sizeof (long int);
679 if (! simple_strtoul (s
, &p
, &size
))
681 /* The integer at P in S would overflow an unsigned long int.
682 A digit string that long is sufficiently odd looking
683 that the following diagnostic is sufficient. */
684 error (0, 0, _("invalid type string %s"), quote (s_orig
));
691 if (MAX_INTEGRAL_TYPE_SIZE
< size
692 || integral_type_size
[size
] == NO_SIZE
)
694 error (0, 0, _("invalid type string %s;\n\
695 this system doesn't provide a %lu-byte integral type"), quote (s_orig
), size
);
703 #define ISPEC_TO_FORMAT(Spec, Min_format, Long_format, Max_format) \
704 ((Spec) == LONG_LONG ? (Max_format) \
705 : ((Spec) == LONG ? (Long_format) \
708 size_spec = integral_type_size[size];
713 fmt
= SIGNED_DECIMAL
;
714 sprintf (tspec
->fmt_string
, " %%%d%s",
715 (field_width
= bytes_to_signed_dec_digits
[size
]),
716 ISPEC_TO_FORMAT (size_spec
, "d", "ld", PRIdMAX
));
721 sprintf (tspec
->fmt_string
, " %%0%d%s",
722 (field_width
= bytes_to_oct_digits
[size
]),
723 ISPEC_TO_FORMAT (size_spec
, "o", "lo", PRIoMAX
));
727 fmt
= UNSIGNED_DECIMAL
;
728 sprintf (tspec
->fmt_string
, " %%%d%s",
729 (field_width
= bytes_to_unsigned_dec_digits
[size
]),
730 ISPEC_TO_FORMAT (size_spec
, "u", "lu", PRIuMAX
));
735 sprintf (tspec
->fmt_string
, " %%0%d%s",
736 (field_width
= bytes_to_hex_digits
[size
]),
737 ISPEC_TO_FORMAT (size_spec
, "x", "lx", PRIxMAX
));
744 assert (strlen (tspec
->fmt_string
) < FMT_BYTES_ALLOCATED
);
749 print_function
= (fmt
== SIGNED_DECIMAL
755 print_function
= (fmt
== SIGNED_DECIMAL
761 print_function
= print_int
;
765 print_function
= print_long
;
769 print_function
= print_long_long
;
778 fmt
= FLOATING_POINT
;
784 size
= sizeof (float);
789 size
= sizeof (double);
794 size
= sizeof (LONG_DOUBLE
);
798 if (! simple_strtoul (s
, &p
, &size
))
800 /* The integer at P in S would overflow an unsigned long int.
801 A digit string that long is sufficiently odd looking
802 that the following diagnostic is sufficient. */
803 error (0, 0, _("invalid type string %s"), quote (s_orig
));
807 size
= sizeof (double);
810 if (size
> MAX_FP_TYPE_SIZE
811 || fp_type_size
[size
] == NO_SIZE
)
813 error (0, 0, _("invalid type string %s;\n\
814 this system doesn't provide a %lu-byte floating point type"),
815 quote (s_orig
), size
);
822 size_spec
= fp_type_size
[size
];
827 print_function
= print_float
;
828 /* Don't use %#e; not all systems support it. */
829 pre_fmt_string
= " %%%d.%de";
834 print_function
= print_double
;
835 pre_fmt_string
= " %%%d.%de";
839 #ifdef HAVE_LONG_DOUBLE
840 case FLOAT_LONG_DOUBLE
:
841 print_function
= print_long_double
;
842 pre_fmt_string
= " %%%d.%dLe";
843 precision
= LDBL_DIG
;
851 field_width
= precision
+ 8;
852 sprintf (tspec
->fmt_string
, pre_fmt_string
, field_width
, precision
);
857 fmt
= NAMED_CHARACTER
;
859 print_function
= print_named_ascii
;
867 print_function
= print_ascii
;
872 error (0, 0, _("invalid character `%c' in type string %s"),
877 tspec
->size
= size_spec
;
879 tspec
->print_function
= print_function
;
881 tspec
->field_width
= field_width
;
882 tspec
->hexl_mode_trailer
= (*s
== 'z');
883 if (tspec
->hexl_mode_trailer
)
892 /* Given a list of one or more input filenames FILE_LIST, set the global
893 file pointer IN_STREAM and the global string INPUT_FILENAME to the
894 first one that can be successfully opened. Modify FILE_LIST to
895 reference the next filename in the list. A file name of "-" is
896 interpreted as standard input. If any file open fails, give an error
897 message and return false. */
900 open_next_file (void)
906 input_filename
= *file_list
;
907 if (input_filename
== NULL
)
911 if (STREQ (input_filename
, "-"))
913 input_filename
= _("standard input");
915 have_read_stdin
= true;
916 if (O_BINARY
&& ! isatty (STDIN_FILENO
))
917 freopen (NULL
, "rb", stdin
);
921 in_stream
= fopen (input_filename
, (O_BINARY
? "rb" : "r"));
922 if (in_stream
== NULL
)
924 error (0, errno
, "%s", input_filename
);
929 while (in_stream
== NULL
);
931 if (limit_bytes_to_format
& !flag_dump_strings
)
932 setvbuf (in_stream
, NULL
, _IONBF
, 0);
937 /* Test whether there have been errors on in_stream, and close it if
938 it is not standard input. Return false if there has been an error
939 on in_stream or stdout; return true otherwise. This function will
940 report more than one error only if both a read and a write error
941 have occurred. IN_ERRNO, if nonzero, is the error number
942 corresponding to the most recent action for IN_STREAM. */
945 check_and_close (int in_errno
)
949 if (in_stream
!= NULL
)
951 if (ferror (in_stream
))
953 error (0, in_errno
, _("%s: read error"), input_filename
);
954 if (! STREQ (file_list
[-1], "-"))
958 else if (! STREQ (file_list
[-1], "-") && fclose (in_stream
) != 0)
960 error (0, errno
, "%s", input_filename
);
969 error (0, 0, _("write error"));
976 /* Decode the modern od format string S. Append the decoded
977 representation to the global array SPEC, reallocating SPEC if
978 necessary. Return true if S is valid. */
981 decode_format_string (const char *s
)
983 const char *s_orig
= s
;
990 if (n_specs_allocated
<= n_specs
)
991 spec
= X2NREALLOC (spec
, &n_specs_allocated
);
993 if (! decode_one_format (s_orig
, s
, &next
, &spec
[n_specs
]))
1004 /* Given a list of one or more input filenames FILE_LIST, set the global
1005 file pointer IN_STREAM to position N_SKIP in the concatenation of
1006 those files. If any file operation fails or if there are fewer than
1007 N_SKIP bytes in the combined input, give an error message and return
1008 false. When possible, use seek rather than read operations to
1009 advance IN_STREAM. */
1012 skip (uintmax_t n_skip
)
1020 while (in_stream
!= NULL
) /* EOF. */
1022 struct stat file_stats
;
1024 /* First try seeking. For large offsets, this extra work is
1025 worthwhile. If the offset is below some threshold it may be
1026 more efficient to move the pointer by reading. There are two
1027 issues when trying to seek:
1028 - the file must be seekable.
1029 - before seeking to the specified position, make sure
1030 that the new position is in the current file.
1031 Try to do that by getting file's size using fstat.
1032 But that will work only for regular files. */
1034 if (fstat (fileno (in_stream
), &file_stats
) == 0)
1036 /* The st_size field is valid only for regular files
1037 (and for symbolic links, which cannot occur here).
1038 If the number of bytes left to skip is at least
1039 as large as the size of the current file, we can
1040 decrement n_skip and go on to the next file. */
1042 if (S_ISREG (file_stats
.st_mode
) && 0 <= file_stats
.st_size
)
1044 if ((uintmax_t) file_stats
.st_size
<= n_skip
)
1045 n_skip
-= file_stats
.st_size
;
1048 if (fseeko (in_stream
, n_skip
, SEEK_CUR
) != 0)
1057 /* If it's not a regular file with nonnegative size,
1058 position the file pointer by reading. */
1063 size_t n_bytes_read
, n_bytes_to_read
= BUFSIZ
;
1067 if (n_skip
< n_bytes_to_read
)
1068 n_bytes_to_read
= n_skip
;
1069 n_bytes_read
= fread (buf
, 1, n_bytes_to_read
, in_stream
);
1070 n_skip
-= n_bytes_read
;
1071 if (n_bytes_read
!= n_bytes_to_read
)
1085 else /* cannot fstat() file */
1087 error (0, errno
, "%s", input_filename
);
1091 ok
&= check_and_close (in_errno
);
1093 ok
&= open_next_file ();
1097 error (EXIT_FAILURE
, 0, _("cannot skip past end of combined input"));
1103 format_address_none (uintmax_t address ATTRIBUTE_UNUSED
, char c ATTRIBUTE_UNUSED
)
1108 format_address_std (uintmax_t address
, char c
)
1110 char buf
[MAX_ADDRESS_LENGTH
+ 2];
1111 char *p
= buf
+ sizeof buf
;
1116 pbound
= p
- address_pad_len
;
1118 /* Use a special case of the code for each base. This is measurably
1119 faster than generic code. */
1120 switch (address_base
)
1124 *--p
= '0' + (address
& 7);
1125 while ((address
>>= 3) != 0);
1130 *--p
= '0' + (address
% 10);
1131 while ((address
/= 10) != 0);
1136 *--p
= "0123456789abcdef"[address
& 15];
1137 while ((address
>>= 4) != 0);
1148 format_address_paren (uintmax_t address
, char c
)
1151 format_address_std (address
, ')');
1157 format_address_label (uintmax_t address
, char c
)
1159 format_address_std (address
, ' ');
1160 format_address_paren (address
+ pseudo_offset
, c
);
1163 /* Write N_BYTES bytes from CURR_BLOCK to standard output once for each
1164 of the N_SPEC format specs. CURRENT_OFFSET is the byte address of
1165 CURR_BLOCK in the concatenation of input files, and it is printed
1166 (optionally) only before the output line associated with the first
1167 format spec. When duplicate blocks are being abbreviated, the output
1168 for a sequence of identical input blocks is the output for the first
1169 block followed by an asterisk alone on a line. It is valid to compare
1170 the blocks PREV_BLOCK and CURR_BLOCK only when N_BYTES == BYTES_PER_BLOCK.
1171 That condition may be false only for the last input block -- and then
1172 only when it has not been padded to length BYTES_PER_BLOCK. */
1175 write_block (uintmax_t current_offset
, size_t n_bytes
,
1176 const char *prev_block
, const char *curr_block
)
1178 static bool first
= true;
1179 static bool prev_pair_equal
= false;
1181 #define EQUAL_BLOCKS(b1, b2) (memcmp (b1, b2, bytes_per_block) == 0)
1183 if (abbreviate_duplicate_blocks
1184 && !first
&& n_bytes
== bytes_per_block
1185 && EQUAL_BLOCKS (prev_block
, curr_block
))
1187 if (prev_pair_equal
)
1189 /* The two preceding blocks were equal, and the current
1190 block is the same as the last one, so print nothing. */
1195 prev_pair_equal
= true;
1202 prev_pair_equal
= false;
1203 for (i
= 0; i
< n_specs
; i
++)
1206 format_address (current_offset
, '\0');
1208 printf ("%*s", address_pad_len
, "");
1209 (*spec
[i
].print_function
) (n_bytes
, curr_block
, spec
[i
].fmt_string
);
1210 if (spec
[i
].hexl_mode_trailer
)
1212 /* space-pad out to full line width, then dump the trailer */
1213 int datum_width
= width_bytes
[spec
[i
].size
];
1214 int blank_fields
= (bytes_per_block
- n_bytes
) / datum_width
;
1215 int field_width
= spec
[i
].field_width
+ 1;
1216 printf ("%*s", blank_fields
* field_width
, "");
1217 dump_hexl_mode_trailer (n_bytes
, curr_block
);
1225 /* Read a single byte into *C from the concatenation of the input files
1226 named in the global array FILE_LIST. On the first call to this
1227 function, the global variable IN_STREAM is expected to be an open
1228 stream associated with the input file INPUT_FILENAME. If IN_STREAM
1229 is at end-of-file, close it and update the global variables IN_STREAM
1230 and INPUT_FILENAME so they correspond to the next file in the list.
1231 Then try to read a byte from the newly opened file. Repeat if
1232 necessary until EOF is reached for the last file in FILE_LIST, then
1233 set *C to EOF and return. Subsequent calls do likewise. Return
1234 true if successful. */
1243 while (in_stream
!= NULL
) /* EOF. */
1245 *c
= fgetc (in_stream
);
1250 ok
&= check_and_close (errno
);
1252 ok
&= open_next_file ();
1258 /* Read N bytes into BLOCK from the concatenation of the input files
1259 named in the global array FILE_LIST. On the first call to this
1260 function, the global variable IN_STREAM is expected to be an open
1261 stream associated with the input file INPUT_FILENAME. If all N
1262 bytes cannot be read from IN_STREAM, close IN_STREAM and update
1263 the global variables IN_STREAM and INPUT_FILENAME. Then try to
1264 read the remaining bytes from the newly opened file. Repeat if
1265 necessary until EOF is reached for the last file in FILE_LIST.
1266 On subsequent calls, don't modify BLOCK and return true. Set
1267 *N_BYTES_IN_BUFFER to the number of bytes read. If an error occurs,
1268 it will be detected through ferror when the stream is about to be
1269 closed. If there is an error, give a message but continue reading
1270 as usual and return false. Otherwise return true. */
1273 read_block (size_t n
, char *block
, size_t *n_bytes_in_buffer
)
1277 assert (0 < n
&& n
<= bytes_per_block
);
1279 *n_bytes_in_buffer
= 0;
1284 while (in_stream
!= NULL
) /* EOF. */
1289 n_needed
= n
- *n_bytes_in_buffer
;
1290 n_read
= fread (block
+ *n_bytes_in_buffer
, 1, n_needed
, in_stream
);
1292 *n_bytes_in_buffer
+= n_read
;
1294 if (n_read
== n_needed
)
1297 ok
&= check_and_close (errno
);
1299 ok
&= open_next_file ();
1305 /* Return the least common multiple of the sizes associated
1306 with the format specs. */
1314 for (i
= 0; i
< n_specs
; i
++)
1315 l_c_m
= lcm (l_c_m
, width_bytes
[spec
[i
].size
]);
1319 /* If S is a valid traditional offset specification with an optional
1320 leading '+' return true and set *OFFSET to the offset it denotes. */
1323 parse_old_offset (const char *s
, uintmax_t *offset
)
1330 /* Skip over any leading '+'. */
1334 /* Determine the radix we'll use to interpret S. If there is a `.',
1335 it's decimal, otherwise, if the string begins with `0X'or `0x',
1336 it's hexadecimal, else octal. */
1337 if (strchr (s
, '.') != NULL
)
1341 if (s
[0] == '0' && (s
[1] == 'x' || s
[1] == 'X'))
1347 return xstrtoumax (s
, NULL
, radix
, offset
, "Bb") == LONGINT_OK
;
1350 /* Read a chunk of size BYTES_PER_BLOCK from the input files, write the
1351 formatted block to standard output, and repeat until the specified
1352 maximum number of bytes has been read or until all input has been
1353 processed. If the last block read is smaller than BYTES_PER_BLOCK
1354 and its size is not a multiple of the size associated with a format
1355 spec, extend the input block with zero bytes until its length is a
1356 multiple of all format spec sizes. Write the final block. Finally,
1357 write on a line by itself the offset of the byte after the last byte
1358 read. Accumulate return values from calls to read_block and
1359 check_and_close, and if any was false, return false.
1360 Otherwise, return true. */
1366 uintmax_t current_offset
;
1369 size_t n_bytes_read
;
1371 block
[0] = xnmalloc (2, bytes_per_block
);
1372 block
[1] = block
[0] + bytes_per_block
;
1374 current_offset
= n_bytes_to_skip
;
1376 if (limit_bytes_to_format
)
1381 if (current_offset
>= end_offset
)
1386 n_needed
= MIN (end_offset
- current_offset
,
1387 (uintmax_t) bytes_per_block
);
1388 ok
&= read_block (n_needed
, block
[idx
], &n_bytes_read
);
1389 if (n_bytes_read
< bytes_per_block
)
1391 assert (n_bytes_read
== bytes_per_block
);
1392 write_block (current_offset
, n_bytes_read
,
1393 block
[!idx
], block
[idx
]);
1394 current_offset
+= n_bytes_read
;
1402 ok
&= read_block (bytes_per_block
, block
[idx
], &n_bytes_read
);
1403 if (n_bytes_read
< bytes_per_block
)
1405 assert (n_bytes_read
== bytes_per_block
);
1406 write_block (current_offset
, n_bytes_read
,
1407 block
[!idx
], block
[idx
]);
1408 current_offset
+= n_bytes_read
;
1413 if (n_bytes_read
> 0)
1416 size_t bytes_to_write
;
1420 /* Make bytes_to_write the smallest multiple of l_c_m that
1421 is at least as large as n_bytes_read. */
1422 bytes_to_write
= l_c_m
* ((n_bytes_read
+ l_c_m
- 1) / l_c_m
);
1424 memset (block
[idx
] + n_bytes_read
, 0, bytes_to_write
- n_bytes_read
);
1425 write_block (current_offset
, bytes_to_write
,
1426 block
[!idx
], block
[idx
]);
1427 current_offset
+= n_bytes_read
;
1430 format_address (current_offset
, '\n');
1432 if (limit_bytes_to_format
&& current_offset
>= end_offset
)
1433 ok
&= check_and_close (0);
1440 /* STRINGS mode. Find each "string constant" in the input.
1441 A string constant is a run of at least `string_min' ASCII
1442 graphic (or formatting) characters terminated by a null.
1443 Based on a function written by Richard Stallman for a
1444 traditional version of od. Return true if successful. */
1449 size_t bufsize
= MAX (100, string_min
);
1450 char *buf
= xmalloc (bufsize
);
1451 uintmax_t address
= n_bytes_to_skip
;
1459 /* See if the next `string_min' chars are all printing chars. */
1462 if (limit_bytes_to_format
1463 && (end_offset
< string_min
|| end_offset
- string_min
<= address
))
1466 for (i
= 0; i
< string_min
; i
++)
1468 ok
&= read_char (&c
);
1476 /* Found a non-printing. Try again starting with next char. */
1481 /* We found a run of `string_min' printable characters.
1482 Now see if it is terminated with a null byte. */
1483 while (!limit_bytes_to_format
|| address
< end_offset
)
1487 buf
= X2REALLOC (buf
, &bufsize
);
1489 ok
&= read_char (&c
);
1497 break; /* It is; print this string. */
1499 goto tryline
; /* It isn't; give up on this string. */
1500 buf
[i
++] = c
; /* String continues; store it all. */
1503 /* If we get here, the string is all printable and null-terminated,
1504 so print it. It is all in `buf' and `i' is its length. */
1506 format_address (address
- i
- 1, ' ');
1508 for (i
= 0; (c
= buf
[i
]); i
++)
1513 fputs ("\\a", stdout
);
1517 fputs ("\\b", stdout
);
1521 fputs ("\\f", stdout
);
1525 fputs ("\\n", stdout
);
1529 fputs ("\\r", stdout
);
1533 fputs ("\\t", stdout
);
1537 fputs ("\\v", stdout
);
1547 /* We reach this point only if we search through
1548 (max_bytes_to_format - string_min) bytes before reaching EOF. */
1552 ok
&= check_and_close (0);
1557 main (int argc
, char **argv
)
1563 size_t desired_width
IF_LINT (= 0);
1564 bool modern
= false;
1565 bool width_specified
= false;
1567 static char const multipliers
[] = "bEGKkMmPTYZ0";
1569 /* The old-style `pseudo starting address' to be printed in parentheses
1570 after any true address. */
1571 uintmax_t pseudo_start
IF_LINT (= 0);
1573 initialize_main (&argc
, &argv
);
1574 program_name
= argv
[0];
1575 setlocale (LC_ALL
, "");
1576 bindtextdomain (PACKAGE
, LOCALEDIR
);
1577 textdomain (PACKAGE
);
1579 atexit (close_stdout
);
1581 for (i
= 0; i
<= MAX_INTEGRAL_TYPE_SIZE
; i
++)
1582 integral_type_size
[i
] = NO_SIZE
;
1584 integral_type_size
[sizeof (char)] = CHAR
;
1585 integral_type_size
[sizeof (short int)] = SHORT
;
1586 integral_type_size
[sizeof (int)] = INT
;
1587 integral_type_size
[sizeof (long int)] = LONG
;
1588 #if HAVE_UNSIGNED_LONG_LONG_INT
1589 /* If `long int' and `long long int' have the same size, it's fine
1590 to overwrite the entry for `long' with this one. */
1591 integral_type_size
[sizeof (unsigned_long_long_int
)] = LONG_LONG
;
1594 for (i
= 0; i
<= MAX_FP_TYPE_SIZE
; i
++)
1595 fp_type_size
[i
] = NO_SIZE
;
1597 fp_type_size
[sizeof (float)] = FLOAT_SINGLE
;
1598 /* The array entry for `double' is filled in after that for LONG_DOUBLE
1599 so that if `long double' is the same type or if long double isn't
1600 supported FLOAT_LONG_DOUBLE will never be used. */
1601 fp_type_size
[sizeof (LONG_DOUBLE
)] = FLOAT_LONG_DOUBLE
;
1602 fp_type_size
[sizeof (double)] = FLOAT_DOUBLE
;
1605 n_specs_allocated
= 0;
1608 format_address
= format_address_std
;
1610 address_pad_len
= 7;
1611 flag_dump_strings
= false;
1613 while ((c
= getopt_long (argc
, argv
, short_options
, long_options
, NULL
))
1617 enum strtol_error s_err
;
1626 format_address
= format_address_std
;
1628 address_pad_len
= 7;
1631 format_address
= format_address_std
;
1633 address_pad_len
= 7;
1636 format_address
= format_address_std
;
1638 address_pad_len
= 6;
1641 format_address
= format_address_none
;
1642 address_pad_len
= 0;
1645 error (EXIT_FAILURE
, 0,
1646 _("invalid output address radix `%c'; \
1647 it must be one character from [doxn]"),
1655 s_err
= xstrtoumax (optarg
, NULL
, 0, &n_bytes_to_skip
, multipliers
);
1656 if (s_err
!= LONGINT_OK
)
1657 STRTOL_FATAL_ERROR (optarg
, _("skip argument"), s_err
);
1662 limit_bytes_to_format
= true;
1664 s_err
= xstrtoumax (optarg
, NULL
, 0, &max_bytes_to_format
,
1666 if (s_err
!= LONGINT_OK
)
1667 STRTOL_FATAL_ERROR (optarg
, _("limit argument"), s_err
);
1676 s_err
= xstrtoumax (optarg
, NULL
, 0, &tmp
, multipliers
);
1677 if (s_err
!= LONGINT_OK
)
1678 STRTOL_FATAL_ERROR (optarg
, _("minimum string length"), s_err
);
1680 /* The minimum string length may be no larger than SIZE_MAX,
1681 since we may allocate a buffer of this size. */
1683 error (EXIT_FAILURE
, 0, _("%s is too large"), optarg
);
1687 flag_dump_strings
= true;
1692 ok
&= decode_format_string (optarg
);
1697 abbreviate_duplicate_blocks
= false;
1700 case TRADITIONAL_OPTION
:
1704 /* The next several cases map the traditional format
1705 specification options to the corresponding modern format
1706 specs. GNU od accepts any combination of old- and
1707 new-style options. Format specification options accumulate.
1708 The obsolescent and undocumented formats are compatible
1709 with FreeBSD 4.10 od. */
1711 #define CASE_OLD_ARG(old_char,new_string) \
1713 ok &= decode_format_string (new_string); \
1716 CASE_OLD_ARG ('a', "a");
1717 CASE_OLD_ARG ('b', "o1");
1718 CASE_OLD_ARG ('c', "c");
1719 CASE_OLD_ARG ('D', "u4"); /* obsolescent and undocumented */
1720 CASE_OLD_ARG ('d', "u2");
1721 case 'F': /* obsolescent and undocumented alias */
1722 CASE_OLD_ARG ('e', "fD"); /* obsolescent and undocumented */
1723 CASE_OLD_ARG ('f', "fF");
1724 case 'X': /* obsolescent and undocumented alias */
1725 CASE_OLD_ARG ('H', "x4"); /* obsolescent and undocumented */
1726 CASE_OLD_ARG ('i', "dI");
1727 case 'I': case 'L': /* obsolescent and undocumented aliases */
1728 CASE_OLD_ARG ('l', "dL");
1729 CASE_OLD_ARG ('O', "o4"); /* obsolesent and undocumented */
1730 case 'B': /* obsolescent and undocumented alias */
1731 CASE_OLD_ARG ('o', "o2");
1732 CASE_OLD_ARG ('s', "d2");
1733 case 'h': /* obsolescent and undocumented alias */
1734 CASE_OLD_ARG ('x', "x2");
1740 width_specified
= true;
1748 s_err
= xstrtoumax (optarg
, NULL
, 10, &w_tmp
, "");
1749 if (s_err
!= LONGINT_OK
)
1750 STRTOL_FATAL_ERROR (optarg
, _("width specification"), s_err
);
1751 if (SIZE_MAX
< w_tmp
)
1752 error (EXIT_FAILURE
, 0, _("%s is too large"), optarg
);
1753 desired_width
= w_tmp
;
1757 case_GETOPT_HELP_CHAR
;
1759 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
1762 usage (EXIT_FAILURE
);
1768 exit (EXIT_FAILURE
);
1770 if (flag_dump_strings
&& n_specs
> 0)
1771 error (EXIT_FAILURE
, 0,
1772 _("no type may be specified when dumping strings"));
1774 n_files
= argc
- optind
;
1776 /* If the --traditional option is used, there may be from
1777 0 to 3 remaining command line arguments; handle each case
1779 od [file] [[+]offset[.][b] [[+]label[.][b]]]
1780 The offset and label have the same syntax.
1782 If --traditional is not given, and if no modern options are
1783 given, and if the offset begins with + or (if there are two
1784 operands) a digit, accept only this form, as per POSIX:
1785 od [file] [[+]offset[.][b]]
1788 if (!modern
| traditional
)
1796 if ((traditional
|| argv
[optind
][0] == '+')
1797 && parse_old_offset (argv
[optind
], &o1
))
1799 n_bytes_to_skip
= o1
;
1806 if ((traditional
|| argv
[optind
+ 1][0] == '+'
1807 || ISDIGIT (argv
[optind
+ 1][0]))
1808 && parse_old_offset (argv
[optind
+ 1], &o2
))
1810 if (traditional
&& parse_old_offset (argv
[optind
], &o1
))
1812 n_bytes_to_skip
= o1
;
1813 flag_pseudo_start
= true;
1820 n_bytes_to_skip
= o2
;
1822 argv
[optind
+ 1] = argv
[optind
];
1830 && parse_old_offset (argv
[optind
+ 1], &o1
)
1831 && parse_old_offset (argv
[optind
+ 2], &o2
))
1833 n_bytes_to_skip
= o1
;
1834 flag_pseudo_start
= true;
1836 argv
[optind
+ 2] = argv
[optind
];
1843 if (traditional
&& 1 < n_files
)
1845 error (0, 0, _("extra operand %s"), quote (argv
[optind
+ 1]));
1846 error (0, 0, "%s\n",
1847 _("Compatibility mode supports at most one file."));
1848 usage (EXIT_FAILURE
);
1852 if (flag_pseudo_start
)
1854 if (format_address
== format_address_none
)
1857 address_pad_len
= 7;
1858 format_address
= format_address_paren
;
1861 format_address
= format_address_label
;
1864 if (limit_bytes_to_format
)
1866 end_offset
= n_bytes_to_skip
+ max_bytes_to_format
;
1867 if (end_offset
< n_bytes_to_skip
)
1868 error (EXIT_FAILURE
, 0, _("skip-bytes + read-bytes is too large"));
1872 decode_format_string ("oS");
1876 /* Set the global pointer FILE_LIST so that it
1877 references the first file-argument on the command-line. */
1879 file_list
= (char const *const *) &argv
[optind
];
1883 /* No files were listed on the command line.
1884 Set the global pointer FILE_LIST so that it
1885 references the null-terminated list of one name: "-". */
1887 file_list
= default_file_list
;
1890 /* open the first input file */
1891 ok
= open_next_file ();
1892 if (in_stream
== NULL
)
1895 /* skip over any unwanted header bytes */
1896 ok
&= skip (n_bytes_to_skip
);
1897 if (in_stream
== NULL
)
1900 pseudo_offset
= (flag_pseudo_start
? pseudo_start
- n_bytes_to_skip
: 0);
1902 /* Compute output block length. */
1905 if (width_specified
)
1907 if (desired_width
!= 0 && desired_width
% l_c_m
== 0)
1908 bytes_per_block
= desired_width
;
1911 error (0, 0, _("warning: invalid width %lu; using %d instead"),
1912 (unsigned long int) desired_width
, l_c_m
);
1913 bytes_per_block
= l_c_m
;
1918 if (l_c_m
< DEFAULT_BYTES_PER_BLOCK
)
1919 bytes_per_block
= l_c_m
* (DEFAULT_BYTES_PER_BLOCK
/ l_c_m
);
1921 bytes_per_block
= l_c_m
;
1925 for (i
= 0; i
< n_specs
; i
++)
1927 printf (_("%d: fmt=\"%s\" width=%d\n"),
1928 i
, spec
[i
].fmt_string
, width_bytes
[spec
[i
].size
]);
1932 ok
&= (flag_dump_strings
? dump_strings () : dump ());
1936 if (have_read_stdin
&& fclose (stdin
) == EOF
)
1937 error (EXIT_FAILURE
, errno
, _("standard input"));
1939 exit (ok
? EXIT_SUCCESS
: EXIT_FAILURE
);