1 /* od -- dump files in octal and other formats
2 Copyright (C) 1992, 1995 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
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
18 /* Written by Jim Meyering. */
20 /* AIX requires this to be the first thing in the file. */
24 #define alloca __builtin_alloca
25 #else /* not __GNUC__ */
28 #else /* not HAVE_ALLOCA_H */
34 #endif /* not HAVE_ALLOCA_H */
35 #endif /* not __GNUC__ */
40 #include <sys/types.h>
46 #if defined(__GNUC__) || defined(STDC_HEADERS)
50 #ifdef HAVE_LONG_DOUBLE
51 typedef long double LONG_DOUBLE;
53 typedef double LONG_DOUBLE;
63 #define SCHAR_MIN (-128)
66 #define SHRT_MAX 32767
69 #define SHRT_MIN (-32768)
72 #define ULONG_MAX ((unsigned long) ~(unsigned long) 0)
75 /* FIXME: is there a way to do this without relying on the
76 `8 bits per byte' assumption? */
77 #define OFF_T_MAX (~((off_t)1 << (sizeof (off_t) * 8 - 1)))
80 #define STREQ(a,b) (strcmp((a), (b)) == 0)
83 #define MAX(a, b) ((a) > (b) ? (a) : (b))
87 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
90 /* The default number of input bytes per output line. */
91 #define DEFAULT_BYTES_PER_BLOCK 16
93 /* The number of decimal digits of precision in a float. */
98 /* The number of decimal digits of precision in a double. */
103 /* The number of decimal digits of precision in a long double. */
105 #define LDBL_DIG DBL_DIG
134 /* Each output format specification (from POSIX `-t spec' or from
135 old-style options) is represented by one of these structures. */
138 enum output_format fmt;
140 void (*print_function) ();
144 /* The name this program was run with. */
147 /* Convert the number of 8-bit bytes of a binary representation to
148 the number of characters (digits + sign if the type is signed)
149 required to represent the same quantity in the specified base/type.
150 For example, a 32-bit (4-byte) quantity may require a field width
151 as wide as the following for these types:
155 8 unsigned hexadecimal */
157 static const unsigned int bytes_to_oct_digits[] =
158 {0, 3, 6, 8, 11, 14, 16, 19, 22, 25, 27, 30, 32, 35, 38, 41, 43};
160 static const unsigned int bytes_to_signed_dec_digits[] =
161 {1, 4, 6, 8, 11, 13, 16, 18, 20, 23, 25, 28, 30, 33, 35, 37, 40};
163 static const unsigned int bytes_to_unsigned_dec_digits[] =
164 {0, 3, 5, 8, 10, 13, 15, 17, 20, 22, 25, 27, 29, 32, 34, 37, 39};
166 static const unsigned int bytes_to_hex_digits[] =
167 {0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32};
169 /* Convert enum size_spec to the size of the named type. */
170 static const int width_bytes[] =
182 /* Names for some non-printing characters. */
183 static const char *const charname[33] =
185 "nul", "soh", "stx", "etx", "eot", "enq", "ack", "bel",
186 "bs", "ht", "nl", "vt", "ff", "cr", "so", "si",
187 "dle", "dc1", "dc2", "dc3", "dc4", "nak", "syn", "etb",
188 "can", "em", "sub", "esc", "fs", "gs", "rs", "us",
192 /* A printf control string for printing a file offset. */
193 static const char *output_address_fmt_string;
195 /* FIXME: make this the number of octal digits in an unsigned long. */
196 #define MAX_ADDRESS_LENGTH 13
198 /* Space for a normal address, a space, a pseudo address, parentheses
199 around the pseudo address, and a trailing zero byte. */
200 static char address_fmt_buffer[2 * MAX_ADDRESS_LENGTH + 4];
201 static char address_pad[MAX_ADDRESS_LENGTH + 1];
203 static unsigned long int string_min;
204 static unsigned long int flag_dump_strings;
206 /* Non-zero if we should recognize the pre-POSIX non-option arguments
207 that specified at most one file and optional arguments specifying
208 offset and pseudo-start address. */
209 static int traditional;
211 /* Non-zero if an old-style `pseudo-address' was specified. */
212 static long int flag_pseudo_start;
214 /* The difference between the old-style pseudo starting address and
215 the number of bytes to skip. */
216 static long int pseudo_offset;
218 /* Function to format an address and optionally an additional parenthesized
219 pseudo-address; it returns the formatted string. */
220 static const char *(*format_address) (/* long unsigned int */);
222 /* The number of input bytes to skip before formatting and writing. */
223 static off_t n_bytes_to_skip = 0;
225 /* When non-zero, MAX_BYTES_TO_FORMAT is the maximum number of bytes
226 to be read and formatted. Otherwise all input is formatted. */
227 static int limit_bytes_to_format = 0;
229 /* The maximum number of bytes that will be formatted. This
230 value is used only when LIMIT_BYTES_TO_FORMAT is non-zero. */
231 static off_t max_bytes_to_format;
233 /* When non-zero and two or more consecutive blocks are equal, format
234 only the first block and output an asterisk alone on the following
235 line to indicate that identical blocks have been elided. */
236 static int abbreviate_duplicate_blocks = 1;
238 /* An array of specs describing how to format each input block. */
239 static struct tspec *spec;
241 /* The number of format specs. */
242 static unsigned int n_specs;
244 /* The allocated length of SPEC. */
245 static unsigned int n_specs_allocated;
247 /* The number of input bytes formatted per output line. It must be
248 a multiple of the least common multiple of the sizes associated with
249 the specified output types. It should be as large as possible, but
250 no larger than 16 -- unless specified with the -w option. */
251 static unsigned int bytes_per_block;
253 /* Human-readable representation of *file_list (for error messages).
254 It differs from *file_list only when *file_list is "-". */
255 static char const *input_filename;
257 /* A NULL-terminated list of the file-arguments from the command line.
258 If no file-arguments were specified, this variable is initialized
260 static char const *const *file_list;
262 /* The input stream associated with the current file. */
263 static FILE *in_stream;
265 /* If non-zero, at least one of the files we read was standard input. */
266 static int have_read_stdin;
268 #define LONGEST_INTEGRAL_TYPE long int
270 #define MAX_INTEGRAL_TYPE_SIZE sizeof(LONGEST_INTEGRAL_TYPE)
271 static enum size_spec integral_type_size[MAX_INTEGRAL_TYPE_SIZE + 1];
273 #define MAX_FP_TYPE_SIZE sizeof(LONG_DOUBLE)
274 static enum size_spec fp_type_size[MAX_FP_TYPE_SIZE + 1];
276 /* If non-zero, display usage information and exit. */
277 static int show_help;
279 /* If non-zero, print the version on standard output then exit. */
280 static int show_version;
282 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'},
291 /* non-POSIX options. */
292 {"strings", optional_argument, NULL, 's'},
293 {"traditional", no_argument, NULL, 'B'},
294 {"width", optional_argument, NULL, 'w'},
295 {"help", no_argument, &show_help, 1},
296 {"version", no_argument, &show_version, 1},
305 fprintf (stderr, "Try `%s --help' for more information.\n",
310 Usage: %s [OPTION]... [FILE]...\n\
311 or: %s --traditional [FILE] [[+]OFFSET [[+]LABEL]]\n\
313 program_name, program_name);
316 -A, --address-radix=RADIX decide how file offsets are printed\n\
317 -N, --read-bytes=BYTES limit dump to BYTES input bytes per file\n\
318 -j, --skip-bytes=BYTES skip BYTES input bytes first on each file\n\
319 -s, --strings[=BYTES] output strings of at least BYTES graphic chars\n\
320 -t, --format=TYPE select output format or formats\n\
321 -v, --output-duplicates do not use * to mark line suppression\n\
322 -w, --width[=BYTES] output BYTES bytes per output line\n\
323 --help display this help and exit\n\
324 --traditional accept arguments in pre-POSIX form\n\
325 --version output version information and exit\n\
327 Pre-POSIX format specifications may be intermixed, they accumulate:\n\
328 -a same as -t a, select named characters\n\
329 -b same as -t oC, select octal bytes\n\
330 -c same as -t c, select ASCII characters or backslash escapes\n\
331 -d same as -t u2, select unsigned decimal shorts\n\
332 -f same as -t fF, select floats\n\
333 -h same as -t x2, select hexadecimal shorts\n\
334 -i same as -t d2, select decimal shorts\n\
335 -l same as -t d4, select decimal longs\n\
336 -o same as -t o2, select octal shorts\n\
337 -x same as -t x2, select hexadecimal shorts\n\
341 For older syntax (second call format), OFFSET means -j OFFSET. LABEL\n\
342 is the pseudo-address at first byte printed, incremented when dump is\n\
343 progressing. For OFFSET and LABEL, a 0x or 0X prefix indicates\n\
344 hexadecimal, suffixes maybe . for octal and b multiply by 512.\n\
346 TYPE is made up of one or more of these specifications:\n\
349 c ASCII character or backslash escape\n\
350 d[SIZE] signed decimal, SIZE bytes per integer\n\
351 f[SIZE] floating point, SIZE bytes per integer\n\
352 o[SIZE] octal, SIZE bytes per integer\n\
353 u[SIZE] unsigned decimal, SIZE bytes per integer\n\
354 x[SIZE] hexadecimal, SIZE bytes per integer\n\
356 SIZE is a number. For TYPE in doux, SIZE may also be C for\n\
357 sizeof(char), S for sizeof(short), I for sizeof(int) or L for\n\
358 sizeof(long). If TYPE is f, SIZE may also be F for sizeof(float), D\n\
359 for sizeof(double) or L for sizeof(long double).\n\
361 RADIX is d for decimal, o for octal, x for hexadecimal or n for none.\n\
362 BYTES is hexadecimal with 0x or 0X prefix, it is multiplied by 512\n\
363 with b suffix, by 1024 with k and by 1048576 with m. -s without a\n\
364 number implies 3. -w without a number implies 32. By default, od\n\
365 uses -A o -t d2 -w 16. With no FILE, or when FILE is -, read standard\n\
372 /* Compute the greatest common denominator of U and V
373 using Euclid's algorithm. */
390 /* Compute the least common multiple of U and V. */
397 unsigned int t = gcd (u, v);
404 print_s_char (n_bytes, block, fmt_string)
405 long unsigned int n_bytes;
407 const char *fmt_string;
410 for (i = n_bytes; i > 0; i--)
412 int tmp = (unsigned) *(const unsigned char *) block;
414 tmp -= SCHAR_MAX - SCHAR_MIN + 1;
415 assert (tmp <= SCHAR_MAX);
416 printf (fmt_string, tmp, (i == 1 ? '\n' : ' '));
417 block += sizeof (unsigned char);
422 print_char (n_bytes, block, fmt_string)
423 long unsigned int n_bytes;
425 const char *fmt_string;
428 for (i = n_bytes; i > 0; i--)
430 unsigned int tmp = *(const unsigned char *) block;
431 printf (fmt_string, tmp, (i == 1 ? '\n' : ' '));
432 block += sizeof (unsigned char);
437 print_s_short (n_bytes, block, fmt_string)
438 long unsigned int n_bytes;
440 const char *fmt_string;
443 for (i = n_bytes / sizeof (unsigned short); i > 0; i--)
445 int tmp = (unsigned) *(const unsigned short *) block;
447 tmp -= SHRT_MAX - SHRT_MIN + 1;
448 assert (tmp <= SHRT_MAX);
449 printf (fmt_string, tmp, (i == 1 ? '\n' : ' '));
450 block += sizeof (unsigned short);
454 print_short (n_bytes, block, fmt_string)
455 long unsigned int n_bytes;
457 const char *fmt_string;
460 for (i = n_bytes / sizeof (unsigned short); i > 0; i--)
462 unsigned int tmp = *(const unsigned short *) block;
463 printf (fmt_string, tmp, (i == 1 ? '\n' : ' '));
464 block += sizeof (unsigned short);
469 print_int (n_bytes, block, fmt_string)
470 long unsigned int n_bytes;
472 const char *fmt_string;
475 for (i = n_bytes / sizeof (unsigned int); i > 0; i--)
477 unsigned int tmp = *(const unsigned int *) block;
478 printf (fmt_string, tmp, (i == 1 ? '\n' : ' '));
479 block += sizeof (unsigned int);
484 print_long (n_bytes, block, fmt_string)
485 long unsigned int n_bytes;
487 const char *fmt_string;
490 for (i = n_bytes / sizeof (unsigned long); i > 0; i--)
492 unsigned long tmp = *(const unsigned long *) block;
493 printf (fmt_string, tmp, (i == 1 ? '\n' : ' '));
494 block += sizeof (unsigned long);
499 print_float (n_bytes, block, fmt_string)
500 long unsigned int n_bytes;
502 const char *fmt_string;
505 for (i = n_bytes / sizeof (float); i > 0; i--)
507 float tmp = *(const float *) block;
508 printf (fmt_string, tmp, (i == 1 ? '\n' : ' '));
509 block += sizeof (float);
514 print_double (n_bytes, block, fmt_string)
515 long unsigned int n_bytes;
517 const char *fmt_string;
520 for (i = n_bytes / sizeof (double); i > 0; i--)
522 double tmp = *(const double *) block;
523 printf (fmt_string, tmp, (i == 1 ? '\n' : ' '));
524 block += sizeof (double);
528 #ifdef HAVE_LONG_DOUBLE
530 print_long_double (n_bytes, block, fmt_string)
531 long unsigned int n_bytes;
533 const char *fmt_string;
536 for (i = n_bytes / sizeof (LONG_DOUBLE); i > 0; i--)
538 LONG_DOUBLE tmp = *(const LONG_DOUBLE *) block;
539 printf (fmt_string, tmp, (i == 1 ? '\n' : ' '));
540 block += sizeof (LONG_DOUBLE);
547 print_named_ascii (n_bytes, block, unused_fmt_string)
548 long unsigned int n_bytes;
550 const char *unused_fmt_string;
553 for (i = n_bytes; i > 0; i--)
555 unsigned int c = *(const unsigned char *) block;
556 unsigned int masked_c = (0x7f & c);
562 else if (masked_c <= 040)
563 s = charname[masked_c];
566 sprintf (buf, " %c", masked_c);
570 printf ("%3s%c", s, (i == 1 ? '\n' : ' '));
571 block += sizeof (unsigned char);
576 print_ascii (n_bytes, block, unused_fmt_string)
577 long unsigned int n_bytes;
579 const char *unused_fmt_string;
582 for (i = n_bytes; i > 0; i--)
584 unsigned int c = *(const unsigned char *) block;
623 sprintf (buf, (ISPRINT (c) ? " %c" : "%03o"), c);
624 s = (const char *) buf;
627 printf ("%3s%c", s, (i == 1 ? '\n' : ' '));
628 block += sizeof (unsigned char);
632 /* Convert a null-terminated (possibly zero-length) string S to an
633 unsigned long integer value. If S points to a non-digit set *P to S,
634 *VAL to 0, and return 0. Otherwise, accumulate the integer value of
635 the string of digits. If the string of digits represents a value
636 larger than ULONG_MAX, don't modify *VAL or *P and return non-zero.
637 Otherwise, advance *P to the first non-digit after S, set *VAL to
638 the result of the conversion and return zero. */
641 simple_strtoul (s, p, val)
644 long unsigned int *val;
646 unsigned long int sum;
651 unsigned int c = *s++ - '0';
652 if (sum > (ULONG_MAX - c) / 10)
661 /* If S points to a single valid POSIX-style od format string, put a
662 description of that format in *TSPEC, make *NEXT point at the character
663 following the just-decoded format (if *NEXT is non-NULL), and return
664 zero. If S is not valid, don't modify *NEXT or *TSPEC and return
665 non-zero. For example, if S were "d4afL" *NEXT would be set to "afL"
668 fmt = SIGNED_DECIMAL;
669 size = INT or LONG; (whichever integral_type_size[4] resolves to)
670 print_function = print_int; (assuming size == INT)
671 fmt_string = "%011d%c";
676 decode_one_format (s, next, tspec)
681 enum size_spec size_spec;
682 unsigned long int size;
683 enum output_format fmt;
684 const char *pre_fmt_string;
686 void (*print_function) ();
690 assert (tspec != NULL);
704 size = sizeof (char);
709 size = sizeof (short);
719 size = sizeof (long int);
723 if (simple_strtoul (s, &p, &size) != 0)
729 if (size > MAX_INTEGRAL_TYPE_SIZE
730 || integral_type_size[size] == NO_SIZE)
737 #define FMT_BYTES_ALLOCATED 9
738 fmt_string = xmalloc (FMT_BYTES_ALLOCATED);
740 size_spec = integral_type_size[size];
745 fmt = SIGNED_DECIMAL;
746 sprintf (fmt_string, "%%%u%sd%%c",
747 bytes_to_signed_dec_digits[size],
748 (size_spec == LONG ? "l" : ""));
753 sprintf (fmt_string, "%%0%u%so%%c",
754 bytes_to_oct_digits[size],
755 (size_spec == LONG ? "l" : ""));
759 fmt = UNSIGNED_DECIMAL;
760 sprintf (fmt_string, "%%%u%su%%c",
761 bytes_to_unsigned_dec_digits[size],
762 (size_spec == LONG ? "l" : ""));
767 sprintf (fmt_string, "%%0%u%sx%%c",
768 bytes_to_hex_digits[size],
769 (size_spec == LONG ? "l" : ""));
776 assert (strlen (fmt_string) < FMT_BYTES_ALLOCATED);
781 print_function = (fmt == SIGNED_DECIMAL
787 print_function = (fmt == SIGNED_DECIMAL
793 print_function = print_int;
797 print_function = print_long;
806 fmt = FLOATING_POINT;
812 size = sizeof (float);
817 size = sizeof (double);
822 size = sizeof (LONG_DOUBLE);
826 if (simple_strtoul (s, &p, &size) != 0)
829 size = sizeof (double);
832 if (size > MAX_FP_TYPE_SIZE
833 || fp_type_size[size] == NO_SIZE)
839 size_spec = fp_type_size[size];
844 print_function = print_float;
845 /* Don't use %#e; not all systems support it. */
846 pre_fmt_string = "%%%d.%de%%c";
847 fmt_string = xmalloc (strlen (pre_fmt_string));
848 sprintf (fmt_string, pre_fmt_string,
849 FLT_DIG + 8, FLT_DIG);
853 print_function = print_double;
854 pre_fmt_string = "%%%d.%de%%c";
855 fmt_string = xmalloc (strlen (pre_fmt_string));
856 sprintf (fmt_string, pre_fmt_string,
857 DBL_DIG + 8, DBL_DIG);
860 #ifdef HAVE_LONG_DOUBLE
861 case FLOAT_LONG_DOUBLE:
862 print_function = print_long_double;
863 pre_fmt_string = "%%%d.%dle%%c";
864 fmt_string = xmalloc (strlen (pre_fmt_string));
865 sprintf (fmt_string, pre_fmt_string,
866 LDBL_DIG + 8, LDBL_DIG);
877 fmt = NAMED_CHARACTER;
880 print_function = print_named_ascii;
888 print_function = print_ascii;
895 tspec->size = size_spec;
897 tspec->print_function = print_function;
898 tspec->fmt_string = fmt_string;
906 /* Decode the POSIX-style od format string S. Append the decoded
907 representation to the global array SPEC, reallocating SPEC if
908 necessary. Return zero if S is valid, non-zero otherwise. */
911 decode_format_string (s)
921 if (decode_one_format (s, &next, &tspec))
927 if (n_specs >= n_specs_allocated)
929 n_specs_allocated = 1 + (3 * n_specs_allocated) / 2;
930 spec = (struct tspec *) xrealloc (spec, (n_specs_allocated
931 * sizeof (struct tspec)));
934 memcpy ((char *) &spec[n_specs], (char *) &tspec, sizeof (struct tspec));
941 /* Given a list of one or more input filenames FILE_LIST, set the global
942 file pointer IN_STREAM to position N_SKIP in the concatenation of
943 those files. If any file operation fails or if there are fewer than
944 N_SKIP bytes in the combined input, give an error message and return
945 non-zero. When possible, use seek- rather than read operations to
946 advance IN_STREAM. A file name of "-" is interpreted as standard
956 for ( /* empty */ ; *file_list != NULL; ++file_list)
958 struct stat file_stats;
961 if (STREQ (*file_list, "-"))
963 input_filename = "standard input";
969 input_filename = *file_list;
970 in_stream = fopen (input_filename, "r");
971 if (in_stream == NULL)
973 error (0, errno, "%s", input_filename);
982 /* First try using fseek. For large offsets, this extra work is
983 worthwhile. If the offset is below some threshold it may be
984 more efficient to move the pointer by reading. There are two
985 issues when trying to use fseek:
986 - the file must be seekable.
987 - before seeking to the specified position, make sure
988 that the new position is in the current file.
989 Try to do that by getting file's size using fstat().
990 But that will work only for regular files and dirs. */
992 if (fstat (fileno (in_stream), &file_stats))
994 error (0, errno, "%s", input_filename);
999 /* The st_size field is valid only for regular files and
1000 directories. FIXME: is the preceding true?
1001 If the number of bytes left to skip is at least as large as
1002 the size of the current file, we can decrement
1003 n_skip and go on to the next file. */
1004 if (S_ISREG (file_stats.st_mode) || S_ISDIR (file_stats.st_mode))
1006 if (n_skip >= file_stats.st_size)
1008 n_skip -= file_stats.st_size;
1009 if (in_stream != stdin && fclose (in_stream) == EOF)
1011 error (0, errno, "%s", input_filename);
1018 if (fseek (in_stream, n_skip, SEEK_SET) == 0)
1026 /* fseek didn't work or wasn't attempted; do it the slow way. */
1028 for (j = n_skip / BUFSIZ; j >= 0; j--)
1031 size_t n_bytes_to_read = (j > 0
1034 size_t n_bytes_read;
1035 n_bytes_read = fread (buf, 1, n_bytes_to_read, in_stream);
1036 n_skip -= n_bytes_read;
1037 if (n_bytes_read != n_bytes_to_read)
1046 error (2, 0, "cannot skip past end of combined input");
1052 format_address_none (address)
1053 long unsigned int address;
1059 format_address_std (address)
1060 long unsigned int address;
1062 const char *address_string;
1064 sprintf (address_fmt_buffer, output_address_fmt_string, address);
1065 address_string = address_fmt_buffer;
1066 return address_string;
1070 format_address_label (address)
1071 long unsigned int address;
1073 const char *address_string;
1074 assert (output_address_fmt_string != NULL);
1076 sprintf (address_fmt_buffer, output_address_fmt_string,
1077 address, address + pseudo_offset);
1078 address_string = address_fmt_buffer;
1079 return address_string;
1082 /* Write N_BYTES bytes from CURR_BLOCK to standard output once for each
1083 of the N_SPEC format specs. CURRENT_OFFSET is the byte address of
1084 CURR_BLOCK in the concatenation of input files, and it is printed
1085 (optionally) only before the output line associated with the first
1086 format spec. When duplicate blocks are being abbreviated, the output
1087 for a sequence of identical input blocks is the output for the first
1088 block followed by an asterisk alone on a line. It is valid to compare
1089 the blocks PREV_BLOCK and CURR_BLOCK only when N_BYTES == BYTES_PER_BLOCK.
1090 That condition may be false only for the last input block -- and then
1091 only when it has not been padded to length BYTES_PER_BLOCK. */
1094 write_block (current_offset, n_bytes, prev_block, curr_block)
1095 long unsigned int current_offset;
1096 long unsigned int n_bytes;
1097 const char *prev_block;
1098 const char *curr_block;
1100 static int first = 1;
1101 static int prev_pair_equal = 0;
1103 #define EQUAL_BLOCKS(b1, b2) (memcmp ((b1), (b2), bytes_per_block) == 0)
1105 if (abbreviate_duplicate_blocks
1106 && !first && n_bytes == bytes_per_block
1107 && EQUAL_BLOCKS (prev_block, curr_block))
1109 if (prev_pair_equal)
1111 /* The two preceding blocks were equal, and the current
1112 block is the same as the last one, so print nothing. */
1117 prev_pair_equal = 1;
1124 prev_pair_equal = 0;
1125 for (i = 0; i < n_specs; i++)
1127 printf ("%s ", (i == 0
1128 ? format_address (current_offset)
1130 (*spec[i].print_function) (n_bytes, curr_block, spec[i].fmt_string);
1136 /* Test whether there have been errors on in_stream, and close it if
1137 it is not standard input. Return non-zero if there has been an error
1138 on in_stream or stdout; return zero otherwise. This function will
1139 report more than one error only if both a read and a write error
1148 if (ferror (in_stream))
1150 error (0, errno, "%s", input_filename);
1151 if (in_stream != stdin)
1155 else if (in_stream != stdin && fclose (in_stream) == EOF)
1157 error (0, errno, "%s", input_filename);
1161 if (ferror (stdout))
1163 error (0, errno, "standard output");
1170 /* Read a single byte into *C from the concatenation of the input files
1171 named in the global array FILE_LIST. On the first call to this
1172 function, the global variable IN_STREAM is expected to be an open
1173 stream associated with the input file *FILE_LIST. If IN_STREAM is
1174 at end-of-file, close it and update the global variables IN_STREAM,
1175 FILE_LIST, and INPUT_FILENAME so they correspond to the next file in
1176 the list. Then try to read a byte from the newly opened file.
1177 Repeat if necessary until *FILE_LIST is NULL. When EOF is reached
1178 for the last file in FILE_LIST, set *C to EOF and return. Subsequent
1179 calls do likewise. The return value is non-zero if any errors
1180 occured, zero otherwise. */
1188 if (*file_list == NULL)
1197 *c = fgetc (in_stream);
1202 err |= check_and_close ();
1207 if (*file_list == NULL)
1210 if (STREQ (*file_list, "-"))
1212 input_filename = "standard input";
1214 have_read_stdin = 1;
1218 input_filename = *file_list;
1219 in_stream = fopen (input_filename, "r");
1220 if (in_stream == NULL)
1222 error (0, errno, "%s", input_filename);
1227 while (in_stream == NULL);
1231 /* Read N bytes into BLOCK from the concatenation of the input files
1232 named in the global array FILE_LIST. On the first call to this
1233 function, the global variable IN_STREAM is expected to be an open
1234 stream associated with the input file *FILE_LIST. On subsequent
1235 calls, if *FILE_LIST is NULL, don't modify BLOCK and return zero.
1236 If all N bytes cannot be read from IN_STREAM, close IN_STREAM and
1237 update the global variables IN_STREAM, FILE_LIST, and INPUT_FILENAME.
1238 Then try to read the remaining bytes from the newly opened file.
1239 Repeat if necessary until *FILE_LIST is NULL. Set *N_BYTES_IN_BUFFER
1240 to the number of bytes read. If an error occurs, it will be detected
1241 through ferror when the stream is about to be closed. If there is an
1242 error, give a message but continue reading as usual and return non-zero.
1243 Otherwise return zero. */
1246 read_block (n, block, n_bytes_in_buffer)
1249 size_t *n_bytes_in_buffer;
1253 assert (n > 0 && n <= bytes_per_block);
1255 *n_bytes_in_buffer = 0;
1260 if (*file_list == NULL)
1261 return 0; /* EOF. */
1269 n_needed = n - *n_bytes_in_buffer;
1270 n_read = fread (block + *n_bytes_in_buffer, 1, n_needed, in_stream);
1272 *n_bytes_in_buffer += n_read;
1274 if (n_read == n_needed)
1277 err |= check_and_close ();
1282 if (*file_list == NULL)
1285 if (STREQ (*file_list, "-"))
1287 input_filename = "standard input";
1289 have_read_stdin = 1;
1293 input_filename = *file_list;
1294 in_stream = fopen (input_filename, "r");
1295 if (in_stream == NULL)
1297 error (0, errno, "%s", input_filename);
1302 while (in_stream == NULL);
1306 /* Return the least common multiple of the sizes associated
1307 with the format specs. */
1315 for (i = 0; i < n_specs; i++)
1316 l_c_m = lcm (l_c_m, width_bytes[(int) spec[i].size]);
1320 /* If S is a valid pre-POSIX offset specification with an optional leading '+'
1321 return the offset it denotes. Otherwise, return -1. */
1324 parse_old_offset (s)
1329 enum strtol_error s_err;
1330 long unsigned int tmp;
1335 /* Skip over any leading '+'. */
1339 /* Determine the radix we'll use to interpret S. If there is a `.',
1340 it's decimal, otherwise, if the string begins with `0X'or `0x',
1341 it's hexadecimal, else octal. */
1342 if (strchr (s, '.') != NULL)
1346 if (s[0] == '0' && (s[1] == 'x' || s[1] == 'X'))
1352 s_err = xstrtoul (s, NULL, radix, &tmp, "Bb");
1353 if (s_err != LONGINT_OK)
1355 STRTOL_FAIL_WARN (s, "old-style offset", s_err);
1362 /* Read a chunk of size BYTES_PER_BLOCK from the input files, write the
1363 formatted block to standard output, and repeat until the specified
1364 maximum number of bytes has been read or until all input has been
1365 processed. If the last block read is smaller than BYTES_PER_BLOCK
1366 and its size is not a multiple of the size associated with a format
1367 spec, extend the input block with zero bytes until its length is a
1368 multiple of all format spec sizes. Write the final block. Finally,
1369 write on a line by itself the offset of the byte after the last byte
1370 read. Accumulate return values from calls to read_block and
1371 check_and_close, and if any was non-zero, return non-zero.
1372 Otherwise, return zero. */
1378 off_t current_offset;
1382 size_t n_bytes_read;
1384 #ifdef lint /* Suppress `used before initialized' warning. */
1388 block[0] = (char *) alloca (bytes_per_block);
1389 block[1] = (char *) alloca (bytes_per_block);
1391 current_offset = n_bytes_to_skip;
1395 if (limit_bytes_to_format)
1397 end_offset = n_bytes_to_skip + max_bytes_to_format;
1400 while (current_offset < end_offset)
1403 n_needed = MIN (end_offset - current_offset,
1404 (off_t) bytes_per_block);
1405 err |= read_block (n_needed, block[idx], &n_bytes_read);
1406 if (n_bytes_read < bytes_per_block)
1408 assert (n_bytes_read == bytes_per_block);
1409 write_block (current_offset, n_bytes_read,
1410 block[!idx], block[idx]);
1411 current_offset += n_bytes_read;
1419 err |= read_block (bytes_per_block, block[idx], &n_bytes_read);
1420 if (n_bytes_read < bytes_per_block)
1422 assert (n_bytes_read == bytes_per_block);
1423 write_block (current_offset, n_bytes_read,
1424 block[!idx], block[idx]);
1425 current_offset += n_bytes_read;
1430 if (n_bytes_read > 0)
1433 size_t bytes_to_write;
1437 /* Make bytes_to_write the smallest multiple of l_c_m that
1438 is at least as large as n_bytes_read. */
1439 bytes_to_write = l_c_m * (int) ((n_bytes_read + l_c_m - 1) / l_c_m);
1441 memset (block[idx] + n_bytes_read, 0, bytes_to_write - n_bytes_read);
1442 write_block (current_offset, bytes_to_write,
1443 block[!idx], block[idx]);
1444 current_offset += n_bytes_read;
1447 if (output_address_fmt_string != NULL)
1448 printf ("%s\n", format_address (current_offset));
1450 if (limit_bytes_to_format && current_offset > end_offset)
1451 err |= check_and_close ();
1456 /* STRINGS mode. Find each "string constant" in the input.
1457 A string constant is a run of at least `string_min' ASCII
1458 graphic (or formatting) characters terminated by a null.
1459 Based on a function written by Richard Stallman for a
1460 pre-POSIX version of od. Return non-zero if an error
1461 occurs. Otherwise, return zero. */
1466 size_t bufsize = MAX (100, string_min);
1467 char *buf = xmalloc (bufsize);
1468 off_t address = n_bytes_to_skip;
1477 /* See if the next `string_min' chars are all printing chars. */
1480 if (limit_bytes_to_format
1481 && address >= (n_bytes_to_skip + max_bytes_to_format - string_min))
1484 for (i = 0; i < string_min; i++)
1486 err |= read_char (&c);
1494 /* Found a non-printing. Try again starting with next char. */
1499 /* We found a run of `string_min' printable characters.
1500 Now see if it is terminated with a null byte. */
1501 while (!limit_bytes_to_format
1502 || address < n_bytes_to_skip + max_bytes_to_format)
1506 bufsize = 1 + 3 * bufsize / 2;
1507 buf = xrealloc (buf, bufsize);
1509 err |= read_char (&c);
1517 break; /* It is; print this string. */
1519 goto tryline; /* It isn't; give up on this string. */
1520 buf[i++] = c; /* String continues; store it all. */
1523 /* If we get here, the string is all printable and null-terminated,
1524 so print it. It is all in `buf' and `i' is its length. */
1526 if (output_address_fmt_string != NULL)
1528 printf ("%s ", format_address (address - i - 1));
1530 for (i = 0; (c = buf[i]); i++)
1535 fputs ("\\a", stdout);
1539 fputs ("\\b", stdout);
1543 fputs ("\\f", stdout);
1547 fputs ("\\n", stdout);
1551 fputs ("\\r", stdout);
1555 fputs ("\\t", stdout);
1559 fputs ("\\v", stdout);
1569 /* We reach this point only if we search through
1570 (max_bytes_to_format - string_min) bytes before reachine EOF. */
1574 err |= check_and_close ();
1587 unsigned int address_pad_len;
1588 unsigned long int desired_width;
1589 int width_specified = 0;
1592 /* The old-style `pseudo starting address' to be printed in parentheses
1593 after any true address. */
1594 long int pseudo_start;
1596 #ifdef lint /* Suppress `used before initialized' warning. */
1600 program_name = argv[0];
1603 for (i = 0; i <= MAX_INTEGRAL_TYPE_SIZE; i++)
1604 integral_type_size[i] = NO_SIZE;
1606 integral_type_size[sizeof (char)] = CHAR;
1607 integral_type_size[sizeof (short int)] = SHORT;
1608 integral_type_size[sizeof (int)] = INT;
1609 integral_type_size[sizeof (long int)] = LONG;
1611 for (i = 0; i <= MAX_FP_TYPE_SIZE; i++)
1612 fp_type_size[i] = NO_SIZE;
1614 fp_type_size[sizeof (float)] = FLOAT_SINGLE;
1615 /* The array entry for `double' is filled in after that for LONG_DOUBLE
1616 so that if `long double' is the same type or if long double isn't
1617 supported FLOAT_LONG_DOUBLE will never be used. */
1618 fp_type_size[sizeof (LONG_DOUBLE)] = FLOAT_LONG_DOUBLE;
1619 fp_type_size[sizeof (double)] = FLOAT_DOUBLE;
1622 n_specs_allocated = 5;
1623 spec = (struct tspec *) xmalloc (n_specs_allocated * sizeof (struct tspec));
1625 output_address_fmt_string = "%07o";
1626 format_address = format_address_std;
1627 address_pad_len = 7;
1628 flag_dump_strings = 0;
1630 while ((c = getopt_long (argc, argv, "abcdfhilos::xw::A:j:N:t:v",
1631 long_options, (int *) 0))
1634 unsigned long int tmp;
1635 enum strtol_error s_err;
1646 output_address_fmt_string = "%07d";
1647 format_address = format_address_std;
1648 address_pad_len = 7;
1651 output_address_fmt_string = "%07o";
1652 format_address = format_address_std;
1653 address_pad_len = 7;
1656 output_address_fmt_string = "%06x";
1657 format_address = format_address_std;
1658 address_pad_len = 6;
1661 output_address_fmt_string = NULL;
1662 format_address = format_address_none;
1663 address_pad_len = 0;
1667 "invalid output address radix `%c'; it must be one character from [doxn]",
1674 s_err = xstrtoul (optarg, NULL, 0, &tmp, "bkm");
1675 n_bytes_to_skip = tmp;
1676 if (s_err != LONGINT_OK)
1677 STRTOL_FATAL_ERROR (optarg, "skip argument", s_err);
1681 limit_bytes_to_format = 1;
1683 /* FIXME: if off_t is long long and that's an 8-byte type,
1684 use xstrtouq here. */
1685 s_err = xstrtoul (optarg, NULL, 0, &tmp, "bkm");
1686 max_bytes_to_format = tmp;
1687 if (s_err != LONGINT_OK)
1688 STRTOL_FATAL_ERROR (optarg, "limit argument", s_err);
1690 if (tmp > OFF_T_MAX)
1691 error (2, 0, "specified number of bytes `%s' is larger than \
1692 the maximum\nrepresentable value of type off_t", optarg);
1700 s_err = xstrtoul (optarg, NULL, 0, &string_min, "bkm");
1701 if (s_err != LONGINT_OK)
1702 STRTOL_FATAL_ERROR (optarg, "minimum string length", s_err);
1704 ++flag_dump_strings;
1708 if (decode_format_string (optarg))
1709 error (2, 0, "invalid type string `%s'", optarg);
1713 abbreviate_duplicate_blocks = 0;
1720 /* The next several cases map the old, pre-POSIX format
1721 specification options to the corresponding POSIX format
1722 specs. GNU od accepts any combination of old- and
1723 new-style options. Format specification options accumulate. */
1725 #define CASE_OLD_ARG(old_char,new_string) \
1729 tmp = decode_format_string (new_string); \
1730 assert (tmp == 0); \
1734 CASE_OLD_ARG ('a', "a");
1735 CASE_OLD_ARG ('b', "oC");
1736 CASE_OLD_ARG ('c', "c");
1737 CASE_OLD_ARG ('d', "u2");
1738 CASE_OLD_ARG ('f', "fF");
1739 CASE_OLD_ARG ('h', "x2");
1740 CASE_OLD_ARG ('i', "d2");
1741 CASE_OLD_ARG ('l', "d4");
1742 CASE_OLD_ARG ('o', "o2");
1743 CASE_OLD_ARG ('x', "x2");
1748 width_specified = 1;
1755 s_err = xstrtoul (optarg, NULL, 10, &desired_width, NULL);
1756 if (s_err != LONGINT_OK)
1757 STRTOL_FATAL_ERROR (optarg, "width specification", s_err);
1769 printf ("od - %s\n", version_string);
1776 if (flag_dump_strings && n_specs > 0)
1777 error (2, 0, "no type may be specified when dumping strings");
1779 n_files = argc - optind;
1781 /* If the --backward-compatible option is used, there may be from
1782 0 to 3 remaining command line arguments; handle each case
1784 od [file] [[+]offset[.][b] [[+]label[.][b]]]
1785 The offset and pseudo_start have the same syntax. */
1793 if ((offset = parse_old_offset (argv[optind])) >= 0)
1795 n_bytes_to_skip = offset;
1800 else if (n_files == 2)
1803 if ((o1 = parse_old_offset (argv[optind])) >= 0
1804 && (o2 = parse_old_offset (argv[optind + 1])) >= 0)
1806 n_bytes_to_skip = o1;
1807 flag_pseudo_start = 1;
1812 else if ((o2 = parse_old_offset (argv[optind + 1])) >= 0)
1814 n_bytes_to_skip = o2;
1816 argv[optind + 1] = argv[optind];
1822 "invalid second operand in compatibility mode `%s'",
1827 else if (n_files == 3)
1830 if ((o1 = parse_old_offset (argv[optind + 1])) >= 0
1831 && (o2 = parse_old_offset (argv[optind + 2])) >= 0)
1833 n_bytes_to_skip = o1;
1834 flag_pseudo_start = 1;
1836 argv[optind + 2] = argv[optind];
1843 "in compatibility mode the last 2 arguments must be offsets");
1850 "in compatibility mode there may be no more than 3 arguments");
1854 if (flag_pseudo_start)
1856 static char buf[10];
1858 if (output_address_fmt_string == NULL)
1860 output_address_fmt_string = "(%07o)";
1861 format_address = format_address_std;
1865 sprintf (buf, "%s (%s)",
1866 output_address_fmt_string,
1867 output_address_fmt_string);
1868 output_address_fmt_string = buf;
1869 format_address = format_address_label;
1874 assert (address_pad_len <= MAX_ADDRESS_LENGTH);
1875 for (i = 0; i < address_pad_len; i++)
1876 address_pad[i] = ' ';
1877 address_pad[address_pad_len] = '\0';
1881 int d_err = decode_one_format ("o2", NULL, &(spec[0]));
1883 assert (d_err == 0);
1888 file_list = (char const *const *) &argv[optind];
1891 /* If no files were listed on the command line, set up the
1892 global array FILE_LIST so that it contains the null-terminated
1893 list of one name: "-". */
1894 static char const *const default_file_list[] = {"-", NULL};
1896 file_list = default_file_list;
1899 err |= skip (n_bytes_to_skip);
1900 if (in_stream == NULL)
1903 pseudo_offset = (flag_pseudo_start ? pseudo_start - n_bytes_to_skip : 0);
1905 /* Compute output block length. */
1908 if (width_specified)
1910 if (desired_width != 0 && desired_width % l_c_m == 0)
1911 bytes_per_block = desired_width;
1914 error (0, 0, "warning: invalid width %lu; using %d instead",
1915 desired_width, l_c_m);
1916 bytes_per_block = l_c_m;
1921 if (l_c_m < DEFAULT_BYTES_PER_BLOCK)
1922 bytes_per_block = l_c_m * (int) (DEFAULT_BYTES_PER_BLOCK / l_c_m);
1924 bytes_per_block = l_c_m;
1928 for (i = 0; i < n_specs; i++)
1930 printf ("%d: fmt=\"%s\" width=%d\n",
1931 i, spec[i].fmt_string, width_bytes[spec[i].size]);
1935 err |= (flag_dump_strings ? dump_strings () : dump ());
1939 if (have_read_stdin && fclose (stdin) == EOF)
1940 error (2, errno, "standard input");
1942 if (fclose (stdout) == EOF)
1943 error (2, errno, "write error");