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, it is multiplied by 512\n\
387 with b suffix, by 1024 with k and by 1048576 with m. Adding a z suffix to\n\
388 any type adds a display of printable characters to the end of each line\n\
392 --string without a number implies 3. --width without a number\n\
393 implies 32. By default, od uses -A o -t d2 -w16.\n\
395 printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
400 /* Define the print functions. */
403 print_s_char (size_t n_bytes, void const *block, char const *fmt_string)
405 signed char const *p = block;
407 for (i = n_bytes / sizeof *p; i != 0; i--)
408 printf (fmt_string, *p++);
412 print_char (size_t n_bytes, void const *block, char const *fmt_string)
414 unsigned char const *p = block;
416 for (i = n_bytes / sizeof *p; i != 0; i--)
417 printf (fmt_string, *p++);
421 print_s_short (size_t n_bytes, void const *block, char const *fmt_string)
423 short int const *p = block;
425 for (i = n_bytes / sizeof *p; i != 0; i--)
426 printf (fmt_string, *p++);
430 print_short (size_t n_bytes, void const *block, char const *fmt_string)
432 unsigned short int const *p = block;
434 for (i = n_bytes / sizeof *p; i != 0; i--)
435 printf (fmt_string, *p++);
439 print_int (size_t n_bytes, void const *block, char const *fmt_string)
441 unsigned int const *p = block;
443 for (i = n_bytes / sizeof *p; i != 0; i--)
444 printf (fmt_string, *p++);
448 print_long (size_t n_bytes, void const *block, char const *fmt_string)
450 unsigned long int const *p = block;
452 for (i = n_bytes / sizeof *p; i != 0; i--)
453 printf (fmt_string, *p++);
457 print_long_long (size_t n_bytes, void const *block, char const *fmt_string)
459 unsigned_long_long_int const *p = block;
461 for (i = n_bytes / sizeof *p; i != 0; i--)
462 printf (fmt_string, *p++);
466 print_float (size_t n_bytes, void const *block, char const *fmt_string)
468 float const *p = block;
470 for (i = n_bytes / sizeof *p; i != 0; i--)
471 printf (fmt_string, *p++);
475 print_double (size_t n_bytes, void const *block, char const *fmt_string)
477 double const *p = block;
479 for (i = n_bytes / sizeof *p; i != 0; i--)
480 printf (fmt_string, *p++);
483 #ifdef HAVE_LONG_DOUBLE
485 print_long_double (size_t n_bytes, void const *block, char const *fmt_string)
487 long double const *p = block;
489 for (i = n_bytes / sizeof *p; i != 0; i--)
490 printf (fmt_string, *p++);
495 dump_hexl_mode_trailer (size_t n_bytes, const char *block)
498 fputs (" >", stdout);
499 for (i = n_bytes; i > 0; i--)
501 unsigned char c = *block++;
502 unsigned char c2 = (isprint (c) ? c : '.');
509 print_named_ascii (size_t n_bytes, void const *block,
510 const char *unused_fmt_string ATTRIBUTE_UNUSED)
512 unsigned char const *p = block;
514 for (i = n_bytes; i > 0; i--)
516 int masked_c = *p++ & 0x7f;
522 else if (masked_c <= 040)
523 s = charname[masked_c];
526 sprintf (buf, " %c", masked_c);
535 print_ascii (size_t n_bytes, void const *block,
536 const char *unused_fmt_string ATTRIBUTE_UNUSED)
538 unsigned char const *p = block;
540 for (i = n_bytes; i > 0; i--)
542 unsigned char c = *p++;
581 sprintf (buf, (isprint (c) ? " %c" : "%03o"), c);
589 /* Convert a null-terminated (possibly zero-length) string S to an
590 unsigned long integer value. If S points to a non-digit set *P to S,
591 *VAL to 0, and return true. Otherwise, accumulate the integer value of
592 the string of digits. If the string of digits represents a value
593 larger than ULONG_MAX, don't modify *VAL or *P and return false.
594 Otherwise, advance *P to the first non-digit after S, set *VAL to
595 the result of the conversion and return true. */
598 simple_strtoul (const char *s, const char **p, unsigned long int *val)
600 unsigned long int sum;
606 if (sum > (ULONG_MAX - c) / 10)
615 /* If S points to a single valid modern od format string, put
616 a description of that format in *TSPEC, make *NEXT point at the
617 character following the just-decoded format (if *NEXT is non-NULL),
618 and return true. If S is not valid, don't modify *NEXT or *TSPEC,
619 give a diagnostic, and return false. For example, if S were
620 "d4afL" *NEXT would be set to "afL" and *TSPEC would be
622 fmt = SIGNED_DECIMAL;
623 size = INT or LONG; (whichever integral_type_size[4] resolves to)
624 print_function = print_int; (assuming size == INT)
625 fmt_string = "%011d%c";
627 S_ORIG is solely for reporting errors. It should be the full format
632 decode_one_format (const char *s_orig, const char *s, const char **next,
635 enum size_spec size_spec;
636 unsigned long int size;
637 enum output_format fmt;
638 const char *pre_fmt_string;
639 void (*print_function) (size_t, void const *, char const *);
645 assert (tspec != NULL);
659 size = sizeof (char);
664 size = sizeof (short int);
674 size = sizeof (long int);
678 if (! simple_strtoul (s, &p, &size))
680 /* The integer at P in S would overflow an unsigned long int.
681 A digit string that long is sufficiently odd looking
682 that the following diagnostic is sufficient. */
683 error (0, 0, _("invalid type string %s"), quote (s_orig));
690 if (MAX_INTEGRAL_TYPE_SIZE < size
691 || integral_type_size[size] == NO_SIZE)
693 error (0, 0, _("invalid type string %s;\n\
694 this system doesn't provide a %lu-byte integral type"), quote (s_orig), size);
702 #define ISPEC_TO_FORMAT(Spec, Min_format, Long_format, Max_format) \
703 ((Spec) == LONG_LONG ? (Max_format) \
704 : ((Spec) == LONG ? (Long_format) \
707 size_spec = integral_type_size[size];
712 fmt = SIGNED_DECIMAL;
713 sprintf (tspec->fmt_string, " %%%d%s",
714 (field_width = bytes_to_signed_dec_digits[size]),
715 ISPEC_TO_FORMAT (size_spec, "d", "ld", PRIdMAX));
720 sprintf (tspec->fmt_string, " %%0%d%s",
721 (field_width = bytes_to_oct_digits[size]),
722 ISPEC_TO_FORMAT (size_spec, "o", "lo", PRIoMAX));
726 fmt = UNSIGNED_DECIMAL;
727 sprintf (tspec->fmt_string, " %%%d%s",
728 (field_width = bytes_to_unsigned_dec_digits[size]),
729 ISPEC_TO_FORMAT (size_spec, "u", "lu", PRIuMAX));
734 sprintf (tspec->fmt_string, " %%0%d%s",
735 (field_width = bytes_to_hex_digits[size]),
736 ISPEC_TO_FORMAT (size_spec, "x", "lx", PRIxMAX));
743 assert (strlen (tspec->fmt_string) < FMT_BYTES_ALLOCATED);
748 print_function = (fmt == SIGNED_DECIMAL
754 print_function = (fmt == SIGNED_DECIMAL
760 print_function = print_int;
764 print_function = print_long;
768 print_function = print_long_long;
777 fmt = FLOATING_POINT;
783 size = sizeof (float);
788 size = sizeof (double);
793 size = sizeof (LONG_DOUBLE);
797 if (! simple_strtoul (s, &p, &size))
799 /* The integer at P in S would overflow an unsigned long int.
800 A digit string that long is sufficiently odd looking
801 that the following diagnostic is sufficient. */
802 error (0, 0, _("invalid type string %s"), quote (s_orig));
806 size = sizeof (double);
809 if (size > MAX_FP_TYPE_SIZE
810 || fp_type_size[size] == NO_SIZE)
812 error (0, 0, _("invalid type string %s;\n\
813 this system doesn't provide a %lu-byte floating point type"),
814 quote (s_orig), size);
821 size_spec = fp_type_size[size];
826 print_function = print_float;
827 /* Don't use %#e; not all systems support it. */
828 pre_fmt_string = " %%%d.%de";
833 print_function = print_double;
834 pre_fmt_string = " %%%d.%de";
838 #ifdef HAVE_LONG_DOUBLE
839 case FLOAT_LONG_DOUBLE:
840 print_function = print_long_double;
841 pre_fmt_string = " %%%d.%dLe";
842 precision = LDBL_DIG;
850 field_width = precision + 8;
851 sprintf (tspec->fmt_string, pre_fmt_string, field_width, precision);
856 fmt = NAMED_CHARACTER;
858 print_function = print_named_ascii;
866 print_function = print_ascii;
871 error (0, 0, _("invalid character `%c' in type string %s"),
876 tspec->size = size_spec;
878 tspec->print_function = print_function;
880 tspec->field_width = field_width;
881 tspec->hexl_mode_trailer = (*s == 'z');
882 if (tspec->hexl_mode_trailer)
891 /* Given a list of one or more input filenames FILE_LIST, set the global
892 file pointer IN_STREAM and the global string INPUT_FILENAME to the
893 first one that can be successfully opened. Modify FILE_LIST to
894 reference the next filename in the list. A file name of "-" is
895 interpreted as standard input. If any file open fails, give an error
896 message and return false. */
899 open_next_file (void)
905 input_filename = *file_list;
906 if (input_filename == NULL)
910 if (STREQ (input_filename, "-"))
912 input_filename = _("standard input");
914 have_read_stdin = true;
915 if (O_BINARY && ! isatty (STDIN_FILENO))
916 freopen (NULL, "rb", stdin);
920 in_stream = fopen (input_filename, (O_BINARY ? "rb" : "r"));
921 if (in_stream == NULL)
923 error (0, errno, "%s", input_filename);
928 while (in_stream == NULL);
930 if (limit_bytes_to_format & !flag_dump_strings)
931 setvbuf (in_stream, NULL, _IONBF, 0);
936 /* Test whether there have been errors on in_stream, and close it if
937 it is not standard input. Return false if there has been an error
938 on in_stream or stdout; return true otherwise. This function will
939 report more than one error only if both a read and a write error
940 have occurred. IN_ERRNO, if nonzero, is the error number
941 corresponding to the most recent action for IN_STREAM. */
944 check_and_close (int in_errno)
948 if (in_stream != NULL)
950 if (ferror (in_stream))
952 error (0, in_errno, _("%s: read error"), input_filename);
953 if (! STREQ (file_list[-1], "-"))
957 else if (! STREQ (file_list[-1], "-") && fclose (in_stream) != 0)
959 error (0, errno, "%s", input_filename);
968 error (0, 0, _("write error"));
975 /* Decode the modern od format string S. Append the decoded
976 representation to the global array SPEC, reallocating SPEC if
977 necessary. Return true if S is valid. */
980 decode_format_string (const char *s)
982 const char *s_orig = s;
989 if (n_specs_allocated <= n_specs)
990 spec = X2NREALLOC (spec, &n_specs_allocated);
992 if (! decode_one_format (s_orig, s, &next, &spec[n_specs]))
1003 /* Given a list of one or more input filenames FILE_LIST, set the global
1004 file pointer IN_STREAM to position N_SKIP in the concatenation of
1005 those files. If any file operation fails or if there are fewer than
1006 N_SKIP bytes in the combined input, give an error message and return
1007 false. When possible, use seek rather than read operations to
1008 advance IN_STREAM. */
1011 skip (uintmax_t n_skip)
1019 while (in_stream != NULL) /* EOF. */
1021 struct stat file_stats;
1023 /* First try seeking. For large offsets, this extra work is
1024 worthwhile. If the offset is below some threshold it may be
1025 more efficient to move the pointer by reading. There are two
1026 issues when trying to seek:
1027 - the file must be seekable.
1028 - before seeking to the specified position, make sure
1029 that the new position is in the current file.
1030 Try to do that by getting file's size using fstat.
1031 But that will work only for regular files. */
1033 if (fstat (fileno (in_stream), &file_stats) == 0)
1035 /* The st_size field is valid only for regular files
1036 (and for symbolic links, which cannot occur here).
1037 If the number of bytes left to skip is at least
1038 as large as the size of the current file, we can
1039 decrement n_skip and go on to the next file. */
1041 if (S_ISREG (file_stats.st_mode) && 0 <= file_stats.st_size)
1043 if ((uintmax_t) file_stats.st_size <= n_skip)
1044 n_skip -= file_stats.st_size;
1047 if (fseeko (in_stream, n_skip, SEEK_CUR) != 0)
1056 /* If it's not a regular file with nonnegative size,
1057 position the file pointer by reading. */
1062 size_t n_bytes_read, n_bytes_to_read = BUFSIZ;
1066 if (n_skip < n_bytes_to_read)
1067 n_bytes_to_read = n_skip;
1068 n_bytes_read = fread (buf, 1, n_bytes_to_read, in_stream);
1069 n_skip -= n_bytes_read;
1070 if (n_bytes_read != n_bytes_to_read)
1084 else /* cannot fstat() file */
1086 error (0, errno, "%s", input_filename);
1090 ok &= check_and_close (in_errno);
1092 ok &= open_next_file ();
1096 error (EXIT_FAILURE, 0, _("cannot skip past end of combined input"));
1102 format_address_none (uintmax_t address ATTRIBUTE_UNUSED, char c ATTRIBUTE_UNUSED)
1107 format_address_std (uintmax_t address, char c)
1109 char buf[MAX_ADDRESS_LENGTH + 2];
1110 char *p = buf + sizeof buf;
1115 pbound = p - address_pad_len;
1117 /* Use a special case of the code for each base. This is measurably
1118 faster than generic code. */
1119 switch (address_base)
1123 *--p = '0' + (address & 7);
1124 while ((address >>= 3) != 0);
1129 *--p = '0' + (address % 10);
1130 while ((address /= 10) != 0);
1135 *--p = "0123456789abcdef"[address & 15];
1136 while ((address >>= 4) != 0);
1147 format_address_paren (uintmax_t address, char c)
1150 format_address_std (address, ')');
1156 format_address_label (uintmax_t address, char c)
1158 format_address_std (address, ' ');
1159 format_address_paren (address + pseudo_offset, c);
1162 /* Write N_BYTES bytes from CURR_BLOCK to standard output once for each
1163 of the N_SPEC format specs. CURRENT_OFFSET is the byte address of
1164 CURR_BLOCK in the concatenation of input files, and it is printed
1165 (optionally) only before the output line associated with the first
1166 format spec. When duplicate blocks are being abbreviated, the output
1167 for a sequence of identical input blocks is the output for the first
1168 block followed by an asterisk alone on a line. It is valid to compare
1169 the blocks PREV_BLOCK and CURR_BLOCK only when N_BYTES == BYTES_PER_BLOCK.
1170 That condition may be false only for the last input block -- and then
1171 only when it has not been padded to length BYTES_PER_BLOCK. */
1174 write_block (uintmax_t current_offset, size_t n_bytes,
1175 const char *prev_block, const char *curr_block)
1177 static bool first = true;
1178 static bool prev_pair_equal = false;
1180 #define EQUAL_BLOCKS(b1, b2) (memcmp (b1, b2, bytes_per_block) == 0)
1182 if (abbreviate_duplicate_blocks
1183 && !first && n_bytes == bytes_per_block
1184 && EQUAL_BLOCKS (prev_block, curr_block))
1186 if (prev_pair_equal)
1188 /* The two preceding blocks were equal, and the current
1189 block is the same as the last one, so print nothing. */
1194 prev_pair_equal = true;
1201 prev_pair_equal = false;
1202 for (i = 0; i < n_specs; i++)
1205 format_address (current_offset, '\0');
1207 printf ("%*s", address_pad_len, "");
1208 (*spec[i].print_function) (n_bytes, curr_block, spec[i].fmt_string);
1209 if (spec[i].hexl_mode_trailer)
1211 /* space-pad out to full line width, then dump the trailer */
1212 int datum_width = width_bytes[spec[i].size];
1213 int blank_fields = (bytes_per_block - n_bytes) / datum_width;
1214 int field_width = spec[i].field_width + 1;
1215 printf ("%*s", blank_fields * field_width, "");
1216 dump_hexl_mode_trailer (n_bytes, curr_block);
1224 /* Read a single byte into *C from the concatenation of the input files
1225 named in the global array FILE_LIST. On the first call to this
1226 function, the global variable IN_STREAM is expected to be an open
1227 stream associated with the input file INPUT_FILENAME. If IN_STREAM
1228 is at end-of-file, close it and update the global variables IN_STREAM
1229 and INPUT_FILENAME so they correspond to the next file in the list.
1230 Then try to read a byte from the newly opened file. Repeat if
1231 necessary until EOF is reached for the last file in FILE_LIST, then
1232 set *C to EOF and return. Subsequent calls do likewise. Return
1233 true if successful. */
1242 while (in_stream != NULL) /* EOF. */
1244 *c = fgetc (in_stream);
1249 ok &= check_and_close (errno);
1251 ok &= open_next_file ();
1257 /* Read N bytes into BLOCK from the concatenation of the input files
1258 named in the global array FILE_LIST. On the first call to this
1259 function, the global variable IN_STREAM is expected to be an open
1260 stream associated with the input file INPUT_FILENAME. If all N
1261 bytes cannot be read from IN_STREAM, close IN_STREAM and update
1262 the global variables IN_STREAM and INPUT_FILENAME. Then try to
1263 read the remaining bytes from the newly opened file. Repeat if
1264 necessary until EOF is reached for the last file in FILE_LIST.
1265 On subsequent calls, don't modify BLOCK and return true. Set
1266 *N_BYTES_IN_BUFFER to the number of bytes read. If an error occurs,
1267 it will be detected through ferror when the stream is about to be
1268 closed. If there is an error, give a message but continue reading
1269 as usual and return false. Otherwise return true. */
1272 read_block (size_t n, char *block, size_t *n_bytes_in_buffer)
1276 assert (0 < n && n <= bytes_per_block);
1278 *n_bytes_in_buffer = 0;
1283 while (in_stream != NULL) /* EOF. */
1288 n_needed = n - *n_bytes_in_buffer;
1289 n_read = fread (block + *n_bytes_in_buffer, 1, n_needed, in_stream);
1291 *n_bytes_in_buffer += n_read;
1293 if (n_read == n_needed)
1296 ok &= check_and_close (errno);
1298 ok &= open_next_file ();
1304 /* Return the least common multiple of the sizes associated
1305 with the format specs. */
1313 for (i = 0; i < n_specs; i++)
1314 l_c_m = lcm (l_c_m, width_bytes[spec[i].size]);
1318 /* If S is a valid traditional offset specification with an optional
1319 leading '+' return true and set *OFFSET to the offset it denotes. */
1322 parse_old_offset (const char *s, uintmax_t *offset)
1329 /* Skip over any leading '+'. */
1333 /* Determine the radix we'll use to interpret S. If there is a `.',
1334 it's decimal, otherwise, if the string begins with `0X'or `0x',
1335 it's hexadecimal, else octal. */
1336 if (strchr (s, '.') != NULL)
1340 if (s[0] == '0' && (s[1] == 'x' || s[1] == 'X'))
1346 return xstrtoumax (s, NULL, radix, offset, "Bb") == LONGINT_OK;
1349 /* Read a chunk of size BYTES_PER_BLOCK from the input files, write the
1350 formatted block to standard output, and repeat until the specified
1351 maximum number of bytes has been read or until all input has been
1352 processed. If the last block read is smaller than BYTES_PER_BLOCK
1353 and its size is not a multiple of the size associated with a format
1354 spec, extend the input block with zero bytes until its length is a
1355 multiple of all format spec sizes. Write the final block. Finally,
1356 write on a line by itself the offset of the byte after the last byte
1357 read. Accumulate return values from calls to read_block and
1358 check_and_close, and if any was false, return false.
1359 Otherwise, return true. */
1365 uintmax_t current_offset;
1368 size_t n_bytes_read;
1370 block[0] = xnmalloc (2, bytes_per_block);
1371 block[1] = block[0] + bytes_per_block;
1373 current_offset = n_bytes_to_skip;
1375 if (limit_bytes_to_format)
1380 if (current_offset >= end_offset)
1385 n_needed = MIN (end_offset - current_offset,
1386 (uintmax_t) bytes_per_block);
1387 ok &= read_block (n_needed, block[idx], &n_bytes_read);
1388 if (n_bytes_read < bytes_per_block)
1390 assert (n_bytes_read == bytes_per_block);
1391 write_block (current_offset, n_bytes_read,
1392 block[!idx], block[idx]);
1393 current_offset += n_bytes_read;
1401 ok &= read_block (bytes_per_block, block[idx], &n_bytes_read);
1402 if (n_bytes_read < bytes_per_block)
1404 assert (n_bytes_read == bytes_per_block);
1405 write_block (current_offset, n_bytes_read,
1406 block[!idx], block[idx]);
1407 current_offset += n_bytes_read;
1412 if (n_bytes_read > 0)
1415 size_t bytes_to_write;
1419 /* Make bytes_to_write the smallest multiple of l_c_m that
1420 is at least as large as n_bytes_read. */
1421 bytes_to_write = l_c_m * ((n_bytes_read + l_c_m - 1) / l_c_m);
1423 memset (block[idx] + n_bytes_read, 0, bytes_to_write - n_bytes_read);
1424 write_block (current_offset, bytes_to_write,
1425 block[!idx], block[idx]);
1426 current_offset += n_bytes_read;
1429 format_address (current_offset, '\n');
1431 if (limit_bytes_to_format && current_offset >= end_offset)
1432 ok &= check_and_close (0);
1439 /* STRINGS mode. Find each "string constant" in the input.
1440 A string constant is a run of at least `string_min' ASCII
1441 graphic (or formatting) characters terminated by a null.
1442 Based on a function written by Richard Stallman for a
1443 traditional version of od. Return true if successful. */
1448 size_t bufsize = MAX (100, string_min);
1449 char *buf = xmalloc (bufsize);
1450 uintmax_t address = n_bytes_to_skip;
1458 /* See if the next `string_min' chars are all printing chars. */
1461 if (limit_bytes_to_format
1462 && (end_offset < string_min || end_offset - string_min <= address))
1465 for (i = 0; i < string_min; i++)
1467 ok &= read_char (&c);
1475 /* Found a non-printing. Try again starting with next char. */
1480 /* We found a run of `string_min' printable characters.
1481 Now see if it is terminated with a null byte. */
1482 while (!limit_bytes_to_format || address < end_offset)
1486 buf = X2REALLOC (buf, &bufsize);
1488 ok &= read_char (&c);
1496 break; /* It is; print this string. */
1498 goto tryline; /* It isn't; give up on this string. */
1499 buf[i++] = c; /* String continues; store it all. */
1502 /* If we get here, the string is all printable and null-terminated,
1503 so print it. It is all in `buf' and `i' is its length. */
1505 format_address (address - i - 1, ' ');
1507 for (i = 0; (c = buf[i]); i++)
1512 fputs ("\\a", stdout);
1516 fputs ("\\b", stdout);
1520 fputs ("\\f", stdout);
1524 fputs ("\\n", stdout);
1528 fputs ("\\r", stdout);
1532 fputs ("\\t", stdout);
1536 fputs ("\\v", stdout);
1546 /* We reach this point only if we search through
1547 (max_bytes_to_format - string_min) bytes before reaching EOF. */
1551 ok &= check_and_close (0);
1556 main (int argc, char **argv)
1562 size_t desired_width IF_LINT (= 0);
1563 bool modern = false;
1564 bool width_specified = false;
1567 /* The old-style `pseudo starting address' to be printed in parentheses
1568 after any true address. */
1569 uintmax_t pseudo_start IF_LINT (= 0);
1571 initialize_main (&argc, &argv);
1572 program_name = argv[0];
1573 setlocale (LC_ALL, "");
1574 bindtextdomain (PACKAGE, LOCALEDIR);
1575 textdomain (PACKAGE);
1577 atexit (close_stdout);
1579 for (i = 0; i <= MAX_INTEGRAL_TYPE_SIZE; i++)
1580 integral_type_size[i] = NO_SIZE;
1582 integral_type_size[sizeof (char)] = CHAR;
1583 integral_type_size[sizeof (short int)] = SHORT;
1584 integral_type_size[sizeof (int)] = INT;
1585 integral_type_size[sizeof (long int)] = LONG;
1586 #if HAVE_UNSIGNED_LONG_LONG_INT
1587 /* If `long int' and `long long int' have the same size, it's fine
1588 to overwrite the entry for `long' with this one. */
1589 integral_type_size[sizeof (unsigned_long_long_int)] = LONG_LONG;
1592 for (i = 0; i <= MAX_FP_TYPE_SIZE; i++)
1593 fp_type_size[i] = NO_SIZE;
1595 fp_type_size[sizeof (float)] = FLOAT_SINGLE;
1596 /* The array entry for `double' is filled in after that for LONG_DOUBLE
1597 so that if `long double' is the same type or if long double isn't
1598 supported FLOAT_LONG_DOUBLE will never be used. */
1599 fp_type_size[sizeof (LONG_DOUBLE)] = FLOAT_LONG_DOUBLE;
1600 fp_type_size[sizeof (double)] = FLOAT_DOUBLE;
1603 n_specs_allocated = 0;
1606 format_address = format_address_std;
1608 address_pad_len = 7;
1609 flag_dump_strings = false;
1611 while ((c = getopt_long (argc, argv, short_options, long_options, NULL))
1615 enum strtol_error s_err;
1624 format_address = format_address_std;
1626 address_pad_len = 7;
1629 format_address = format_address_std;
1631 address_pad_len = 7;
1634 format_address = format_address_std;
1636 address_pad_len = 6;
1639 format_address = format_address_none;
1640 address_pad_len = 0;
1643 error (EXIT_FAILURE, 0,
1644 _("invalid output address radix `%c'; \
1645 it must be one character from [doxn]"),
1653 s_err = xstrtoumax (optarg, NULL, 0, &n_bytes_to_skip, "bkm");
1654 if (s_err != LONGINT_OK)
1655 STRTOL_FATAL_ERROR (optarg, _("skip argument"), s_err);
1660 limit_bytes_to_format = true;
1662 s_err = xstrtoumax (optarg, NULL, 0, &max_bytes_to_format, "bkm");
1663 if (s_err != LONGINT_OK)
1664 STRTOL_FATAL_ERROR (optarg, _("limit argument"), s_err);
1673 s_err = xstrtoumax (optarg, NULL, 0, &tmp, "bkm");
1674 if (s_err != LONGINT_OK)
1675 STRTOL_FATAL_ERROR (optarg, _("minimum string length"), s_err);
1677 /* The minimum string length may be no larger than SIZE_MAX,
1678 since we may allocate a buffer of this size. */
1680 error (EXIT_FAILURE, 0, _("%s is too large"), optarg);
1684 flag_dump_strings = true;
1689 ok &= decode_format_string (optarg);
1694 abbreviate_duplicate_blocks = false;
1697 case TRADITIONAL_OPTION:
1701 /* The next several cases map the traditional format
1702 specification options to the corresponding modern format
1703 specs. GNU od accepts any combination of old- and
1704 new-style options. Format specification options accumulate.
1705 The obsolescent and undocumented formats are compatible
1706 with FreeBSD 4.10 od. */
1708 #define CASE_OLD_ARG(old_char,new_string) \
1710 ok &= decode_format_string (new_string); \
1713 CASE_OLD_ARG ('a', "a");
1714 CASE_OLD_ARG ('b', "o1");
1715 CASE_OLD_ARG ('c', "c");
1716 CASE_OLD_ARG ('D', "u4"); /* obsolescent and undocumented */
1717 CASE_OLD_ARG ('d', "u2");
1718 case 'F': /* obsolescent and undocumented alias */
1719 CASE_OLD_ARG ('e', "fD"); /* obsolescent and undocumented */
1720 CASE_OLD_ARG ('f', "fF");
1721 case 'X': /* obsolescent and undocumented alias */
1722 CASE_OLD_ARG ('H', "x4"); /* obsolescent and undocumented */
1723 CASE_OLD_ARG ('i', "dI");
1724 case 'I': case 'L': /* obsolescent and undocumented aliases */
1725 CASE_OLD_ARG ('l', "dL");
1726 CASE_OLD_ARG ('O', "o4"); /* obsolesent and undocumented */
1727 case 'B': /* obsolescent and undocumented alias */
1728 CASE_OLD_ARG ('o', "o2");
1729 CASE_OLD_ARG ('s', "d2");
1730 case 'h': /* obsolescent and undocumented alias */
1731 CASE_OLD_ARG ('x', "x2");
1737 width_specified = true;
1745 s_err = xstrtoumax (optarg, NULL, 10, &w_tmp, "");
1746 if (s_err != LONGINT_OK)
1747 STRTOL_FATAL_ERROR (optarg, _("width specification"), s_err);
1748 if (SIZE_MAX < w_tmp)
1749 error (EXIT_FAILURE, 0, _("%s is too large"), optarg);
1750 desired_width = w_tmp;
1754 case_GETOPT_HELP_CHAR;
1756 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1759 usage (EXIT_FAILURE);
1765 exit (EXIT_FAILURE);
1767 if (flag_dump_strings && n_specs > 0)
1768 error (EXIT_FAILURE, 0,
1769 _("no type may be specified when dumping strings"));
1771 n_files = argc - optind;
1773 /* If the --traditional option is used, there may be from
1774 0 to 3 remaining command line arguments; handle each case
1776 od [file] [[+]offset[.][b] [[+]label[.][b]]]
1777 The offset and label have the same syntax.
1779 If --traditional is not given, and if no modern options are
1780 given, and if the offset begins with + or (if there are two
1781 operands) a digit, accept only this form, as per POSIX:
1782 od [file] [[+]offset[.][b]]
1785 if (!modern | traditional)
1793 if ((traditional || argv[optind][0] == '+')
1794 && parse_old_offset (argv[optind], &o1))
1796 n_bytes_to_skip = o1;
1803 if ((traditional || argv[optind + 1][0] == '+'
1804 || ISDIGIT (argv[optind + 1][0]))
1805 && parse_old_offset (argv[optind + 1], &o2))
1807 if (traditional && parse_old_offset (argv[optind], &o1))
1809 n_bytes_to_skip = o1;
1810 flag_pseudo_start = true;
1817 n_bytes_to_skip = o2;
1819 argv[optind + 1] = argv[optind];
1827 && parse_old_offset (argv[optind + 1], &o1)
1828 && parse_old_offset (argv[optind + 2], &o2))
1830 n_bytes_to_skip = o1;
1831 flag_pseudo_start = true;
1833 argv[optind + 2] = argv[optind];
1840 if (traditional && 1 < n_files)
1842 error (0, 0, _("extra operand %s"), quote (argv[optind + 1]));
1843 error (0, 0, "%s\n",
1844 _("Compatibility mode supports at most one file."));
1845 usage (EXIT_FAILURE);
1849 if (flag_pseudo_start)
1851 if (format_address == format_address_none)
1854 address_pad_len = 7;
1855 format_address = format_address_paren;
1858 format_address = format_address_label;
1861 if (limit_bytes_to_format)
1863 end_offset = n_bytes_to_skip + max_bytes_to_format;
1864 if (end_offset < n_bytes_to_skip)
1865 error (EXIT_FAILURE, 0, _("skip-bytes + read-bytes is too large"));
1869 decode_format_string ("oS");
1873 /* Set the global pointer FILE_LIST so that it
1874 references the first file-argument on the command-line. */
1876 file_list = (char const *const *) &argv[optind];
1880 /* No files were listed on the command line.
1881 Set the global pointer FILE_LIST so that it
1882 references the null-terminated list of one name: "-". */
1884 file_list = default_file_list;
1887 /* open the first input file */
1888 ok = open_next_file ();
1889 if (in_stream == NULL)
1892 /* skip over any unwanted header bytes */
1893 ok &= skip (n_bytes_to_skip);
1894 if (in_stream == NULL)
1897 pseudo_offset = (flag_pseudo_start ? pseudo_start - n_bytes_to_skip : 0);
1899 /* Compute output block length. */
1902 if (width_specified)
1904 if (desired_width != 0 && desired_width % l_c_m == 0)
1905 bytes_per_block = desired_width;
1908 error (0, 0, _("warning: invalid width %lu; using %d instead"),
1909 (unsigned long int) desired_width, l_c_m);
1910 bytes_per_block = l_c_m;
1915 if (l_c_m < DEFAULT_BYTES_PER_BLOCK)
1916 bytes_per_block = l_c_m * (DEFAULT_BYTES_PER_BLOCK / l_c_m);
1918 bytes_per_block = l_c_m;
1922 for (i = 0; i < n_specs; i++)
1924 printf (_("%d: fmt=\"%s\" width=%d\n"),
1925 i, spec[i].fmt_string, width_bytes[spec[i].size]);
1929 ok &= (flag_dump_strings ? dump_strings () : dump ());
1933 if (have_read_stdin && fclose (stdin) == EOF)
1934 error (EXIT_FAILURE, errno, _("standard input"));
1936 exit (ok ? EXIT_SUCCESS : EXIT_FAILURE);