1 /* od -- dump files in octal and other formats
2 Copyright (C) 92, 95, 96, 1997, 1998 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18 /* Written by Jim Meyering. */
25 #include <sys/types.h>
30 #if defined(__GNUC__) || defined(STDC_HEADERS)
34 #ifdef HAVE_LONG_DOUBLE
35 typedef long double LONG_DOUBLE
;
37 typedef double LONG_DOUBLE
;
45 # define MAX(a, b) ((a) > (b) ? (a) : (b))
49 # define MIN(a,b) (((a) < (b)) ? (a) : (b))
52 /* The default number of input bytes per output line. */
53 #define DEFAULT_BYTES_PER_BLOCK 16
55 /* The number of decimal digits of precision in a float. */
60 /* The number of decimal digits of precision in a double. */
65 /* The number of decimal digits of precision in a long double. */
67 # define LDBL_DIG DBL_DIG
72 # define fseeko(Stream, Offset, Whence) (-1)
98 /* Each output format specification (from POSIX `-t spec' or from
99 old-style options) is represented by one of these structures. */
102 enum output_format fmt
;
104 void (*print_function
) ();
106 int hexl_mode_trailer
;
110 /* The name this program was run with. */
113 /* Convert the number of 8-bit bytes of a binary representation to
114 the number of characters (digits + sign if the type is signed)
115 required to represent the same quantity in the specified base/type.
116 For example, a 32-bit (4-byte) quantity may require a field width
117 as wide as the following for these types:
121 8 unsigned hexadecimal */
123 static const unsigned int bytes_to_oct_digits
[] =
124 {0, 3, 6, 8, 11, 14, 16, 19, 22, 25, 27, 30, 32, 35, 38, 41, 43};
126 static const unsigned int bytes_to_signed_dec_digits
[] =
127 {1, 4, 6, 8, 11, 13, 16, 18, 20, 23, 25, 28, 30, 33, 35, 37, 40};
129 static const unsigned int bytes_to_unsigned_dec_digits
[] =
130 {0, 3, 5, 8, 10, 13, 15, 17, 20, 22, 25, 27, 29, 32, 34, 37, 39};
132 static const unsigned int bytes_to_hex_digits
[] =
133 {0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32};
135 /* Convert enum size_spec to the size of the named type. */
136 static const int width_bytes
[] =
148 /* Names for some non-printing characters. */
149 static const char *const charname
[33] =
151 "nul", "soh", "stx", "etx", "eot", "enq", "ack", "bel",
152 "bs", "ht", "nl", "vt", "ff", "cr", "so", "si",
153 "dle", "dc1", "dc2", "dc3", "dc4", "nak", "syn", "etb",
154 "can", "em", "sub", "esc", "fs", "gs", "rs", "us",
158 /* A printf control string for printing a file offset. */
159 static const char *output_address_fmt_string
;
161 /* FIXME: make this the number of octal digits in an unsigned long. */
162 #define MAX_ADDRESS_LENGTH 13
164 /* Space for a normal address, a space, a pseudo address, parentheses
165 around the pseudo address, and a trailing zero byte. */
166 static char address_fmt_buffer
[2 * MAX_ADDRESS_LENGTH
+ 4];
167 static char address_pad
[MAX_ADDRESS_LENGTH
+ 1];
169 static unsigned long int string_min
;
170 static unsigned long int flag_dump_strings
;
172 /* Non-zero if we should recognize the pre-POSIX non-option arguments
173 that specified at most one file and optional arguments specifying
174 offset and pseudo-start address. */
175 static int traditional
;
177 /* Non-zero if an old-style `pseudo-address' was specified. */
178 static long int flag_pseudo_start
;
180 /* The difference between the old-style pseudo starting address and
181 the number of bytes to skip. */
182 static long int pseudo_offset
;
184 /* Function to format an address and optionally an additional parenthesized
185 pseudo-address; it returns the formatted string. */
186 static const char *(*format_address
) PARAMS ((long unsigned int));
188 /* The number of input bytes to skip before formatting and writing. */
189 static off_t n_bytes_to_skip
= 0;
191 /* When nonzero, MAX_BYTES_TO_FORMAT is the maximum number of bytes
192 to be read and formatted. Otherwise all input is formatted. */
193 static int limit_bytes_to_format
= 0;
195 /* The maximum number of bytes that will be formatted. This
196 value is used only when LIMIT_BYTES_TO_FORMAT is nonzero. */
197 static off_t max_bytes_to_format
;
199 /* When nonzero and two or more consecutive blocks are equal, format
200 only the first block and output an asterisk alone on the following
201 line to indicate that identical blocks have been elided. */
202 static int abbreviate_duplicate_blocks
= 1;
204 /* An array of specs describing how to format each input block. */
205 static struct tspec
*spec
;
207 /* The number of format specs. */
208 static unsigned int n_specs
;
210 /* The allocated length of SPEC. */
211 static unsigned int n_specs_allocated
;
213 /* The number of input bytes formatted per output line. It must be
214 a multiple of the least common multiple of the sizes associated with
215 the specified output types. It should be as large as possible, but
216 no larger than 16 -- unless specified with the -w option. */
217 static unsigned int bytes_per_block
;
219 /* Human-readable representation of *file_list (for error messages).
220 It differs from *file_list only when *file_list is "-". */
221 static char const *input_filename
;
223 /* A NULL-terminated list of the file-arguments from the command line.
224 If no file-arguments were specified, this variable is initialized
226 static char const *const *file_list
;
228 /* The input stream associated with the current file. */
229 static FILE *in_stream
;
231 /* If nonzero, at least one of the files we read was standard input. */
232 static int have_read_stdin
;
234 #define LONGEST_INTEGRAL_TYPE long int
236 #define MAX_INTEGRAL_TYPE_SIZE sizeof(LONGEST_INTEGRAL_TYPE)
237 static enum size_spec integral_type_size
[MAX_INTEGRAL_TYPE_SIZE
+ 1];
239 #define MAX_FP_TYPE_SIZE sizeof(LONG_DOUBLE)
240 static enum size_spec fp_type_size
[MAX_FP_TYPE_SIZE
+ 1];
242 /* If nonzero, display usage information and exit. */
243 static int show_help
;
245 /* If nonzero, print the version on standard output then exit. */
246 static int show_version
;
248 static struct option
const long_options
[] =
251 {"skip-bytes", required_argument
, NULL
, 'j'},
252 {"address-radix", required_argument
, NULL
, 'A'},
253 {"read-bytes", required_argument
, NULL
, 'N'},
254 {"format", required_argument
, NULL
, 't'},
255 {"output-duplicates", no_argument
, NULL
, 'v'},
257 /* non-POSIX options. */
258 {"strings", optional_argument
, NULL
, 's'},
259 {"traditional", no_argument
, NULL
, 'B'},
260 {"width", optional_argument
, NULL
, 'w'},
261 {"help", no_argument
, &show_help
, 1},
262 {"version", no_argument
, &show_version
, 1},
270 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
275 Usage: %s [OPTION]... [FILE]...\n\
276 or: %s --traditional [FILE] [[+]OFFSET [[+]LABEL]]\n\
278 program_name
, program_name
);
280 Write an unambiguous representation, octal bytes by default, of FILE\n\
281 to standard output. With no FILE, or when FILE is -, read standard input.\n\
283 -A, --address-radix=RADIX decide how file offsets are printed\n\
284 -j, --skip-bytes=BYTES skip BYTES input bytes first on each file\n\
285 -N, --read-bytes=BYTES limit dump to BYTES input bytes per file\n\
286 -s, --strings[=BYTES] output strings of at least BYTES graphic chars\n\
287 -t, --format=TYPE select output format or formats\n\
288 -v, --output-duplicates do not use * to mark line suppression\n\
289 -w, --width[=BYTES] output BYTES bytes per output line\n\
290 --traditional accept arguments in pre-POSIX form\n\
291 --help display this help and exit\n\
292 --version output version information and exit\n\
294 Pre-POSIX format specifications may be intermixed, they accumulate:\n\
295 -a same as -t a, select named characters\n\
296 -b same as -t oC, select octal bytes\n\
297 -c same as -t c, select ASCII characters or backslash escapes\n\
298 -d same as -t u2, select unsigned decimal shorts\n\
299 -f same as -t fF, select floats\n\
300 -h same as -t x2, select hexadecimal shorts\n\
301 -i same as -t d2, select decimal shorts\n\
302 -l same as -t d4, select decimal longs\n\
303 -o same as -t o2, select octal shorts\n\
304 -x same as -t x2, select hexadecimal shorts\n\
308 For older syntax (second call format), OFFSET means -j OFFSET. LABEL\n\
309 is the pseudo-address at first byte printed, incremented when dump is\n\
310 progressing. For OFFSET and LABEL, a 0x or 0X prefix indicates\n\
311 hexadecimal, suffixes maybe . for octal and b multiply by 512.\n\
313 TYPE is made up of one or more of these specifications:\n\
316 c ASCII character or backslash escape\n\
317 d[SIZE] signed decimal, SIZE bytes per integer\n\
318 f[SIZE] floating point, SIZE bytes per integer\n\
319 o[SIZE] octal, SIZE bytes per integer\n\
320 u[SIZE] unsigned decimal, SIZE bytes per integer\n\
321 x[SIZE] hexadecimal, SIZE bytes per integer\n\
323 SIZE is a number. For TYPE in doux, SIZE may also be C for\n\
324 sizeof(char), S for sizeof(short), I for sizeof(int) or L for\n\
325 sizeof(long). If TYPE is f, SIZE may also be F for sizeof(float), D\n\
326 for sizeof(double) or L for sizeof(long double).\n\
328 RADIX is d for decimal, o for octal, x for hexadecimal or n for none.\n\
329 BYTES is hexadecimal with 0x or 0X prefix, it is multiplied by 512\n\
330 with b suffix, by 1024 with k and by 1048576 with m. Adding a z suffix to\n\
331 any type adds a display of printable characters to the end of each line\n\
332 of output. -s without a number implies 3. -w without a number implies 32.\n\
333 By default, od uses -A o -t d2 -w 16.\n\
335 puts (_("\nReport bugs to <bug-textutils@gnu.org>."));
337 exit (status
== 0 ? EXIT_SUCCESS
: EXIT_FAILURE
);
340 /* Compute the greatest common denominator of U and V
341 using Euclid's algorithm. */
344 gcd (unsigned int u
, unsigned int v
)
356 /* Compute the least common multiple of U and V. */
359 lcm (unsigned int u
, unsigned int v
)
361 unsigned int t
= gcd (u
, v
);
368 print_s_char (long unsigned int n_bytes
, const char *block
,
369 const char *fmt_string
)
372 for (i
= n_bytes
; i
> 0; i
--)
374 int tmp
= (unsigned) *(const unsigned char *) block
;
376 tmp
-= SCHAR_MAX
- SCHAR_MIN
+ 1;
377 assert (tmp
<= SCHAR_MAX
);
378 printf (fmt_string
, tmp
);
379 block
+= sizeof (unsigned char);
384 print_char (long unsigned int n_bytes
, const char *block
,
385 const char *fmt_string
)
388 for (i
= n_bytes
; i
> 0; i
--)
390 unsigned int tmp
= *(const unsigned char *) block
;
391 printf (fmt_string
, tmp
);
392 block
+= sizeof (unsigned char);
397 print_s_short (long unsigned int n_bytes
, const char *block
,
398 const char *fmt_string
)
401 for (i
= n_bytes
/ sizeof (unsigned short); i
> 0; i
--)
403 int tmp
= (unsigned) *(const unsigned short *) block
;
405 tmp
-= SHRT_MAX
- SHRT_MIN
+ 1;
406 assert (tmp
<= SHRT_MAX
);
407 printf (fmt_string
, tmp
);
408 block
+= sizeof (unsigned short);
413 print_short (long unsigned int n_bytes
, const char *block
,
414 const char *fmt_string
)
417 for (i
= n_bytes
/ sizeof (unsigned short); i
> 0; i
--)
419 unsigned int tmp
= *(const unsigned short *) block
;
420 printf (fmt_string
, tmp
);
421 block
+= sizeof (unsigned short);
426 print_int (long unsigned int n_bytes
, const char *block
,
427 const char *fmt_string
)
430 for (i
= n_bytes
/ sizeof (unsigned int); i
> 0; i
--)
432 unsigned int tmp
= *(const unsigned int *) block
;
433 printf (fmt_string
, tmp
);
434 block
+= sizeof (unsigned int);
439 print_long (long unsigned int n_bytes
, const char *block
,
440 const char *fmt_string
)
443 for (i
= n_bytes
/ sizeof (unsigned long); i
> 0; i
--)
445 unsigned long tmp
= *(const unsigned long *) block
;
446 printf (fmt_string
, tmp
);
447 block
+= sizeof (unsigned long);
452 print_float (long unsigned int n_bytes
, const char *block
,
453 const char *fmt_string
)
456 for (i
= n_bytes
/ sizeof (float); i
> 0; i
--)
458 float tmp
= *(const float *) block
;
459 printf (fmt_string
, tmp
);
460 block
+= sizeof (float);
465 print_double (long unsigned int n_bytes
, const char *block
,
466 const char *fmt_string
)
469 for (i
= n_bytes
/ sizeof (double); i
> 0; i
--)
471 double tmp
= *(const double *) block
;
472 printf (fmt_string
, tmp
);
473 block
+= sizeof (double);
477 #ifdef HAVE_LONG_DOUBLE
479 print_long_double (long unsigned int n_bytes
, const char *block
,
480 const char *fmt_string
)
483 for (i
= n_bytes
/ sizeof (LONG_DOUBLE
); i
> 0; i
--)
485 LONG_DOUBLE tmp
= *(const LONG_DOUBLE
*) block
;
486 printf (fmt_string
, tmp
);
487 block
+= sizeof (LONG_DOUBLE
);
494 dump_hexl_mode_trailer (long unsigned int n_bytes
, const char *block
)
497 fputs (" >", stdout
);
498 for (i
= n_bytes
; i
> 0; i
--)
500 unsigned int c
= *(const unsigned char *) block
;
501 unsigned int c2
= (ISPRINT(c
) ? c
: '.');
503 block
+= sizeof (unsigned char);
509 print_named_ascii (long unsigned int n_bytes
, const char *block
,
510 const char *unused_fmt_string
)
513 for (i
= n_bytes
; i
> 0; i
--)
515 unsigned int c
= *(const unsigned char *) block
;
516 unsigned int masked_c
= (0x7f & c
);
522 else if (masked_c
<= 040)
523 s
= charname
[masked_c
];
526 sprintf (buf
, " %c", masked_c
);
531 block
+= sizeof (unsigned char);
536 print_ascii (long unsigned int n_bytes
, const char *block
,
537 const char *unused_fmt_string
)
540 for (i
= n_bytes
; i
> 0; i
--)
542 unsigned int c
= *(const unsigned char *) block
;
581 sprintf (buf
, (ISPRINT (c
) ? " %c" : "%03o"), c
);
582 s
= (const char *) buf
;
586 block
+= sizeof (unsigned char);
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 0. 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 nonzero.
595 Otherwise, advance *P to the first non-digit after S, set *VAL to
596 the result of the conversion and return zero. */
599 simple_strtoul (const char *s
, const char **p
, long unsigned int *val
)
601 unsigned long int sum
;
606 unsigned int c
= *s
++ - '0';
607 if (sum
> (ULONG_MAX
- c
) / 10)
616 /* If S points to a single valid POSIX-style 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 zero. If S is not valid, don't modify *NEXT or *TSPEC,
620 give a diagnostic, and return nonzero. 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
;
641 void (*print_function
) ();
644 unsigned int field_width
= 0;
646 assert (tspec
!= NULL
);
660 size
= sizeof (char);
665 size
= sizeof (short);
675 size
= sizeof (long int);
679 if (simple_strtoul (s
, &p
, &size
) != 0)
681 /* The integer at P in S would overflow an unsigned long.
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'"), s_orig
);
691 if (size
> MAX_INTEGRAL_TYPE_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"), s_orig
, size
);
703 #define FMT_BYTES_ALLOCATED 9
704 fmt_string
= xmalloc (FMT_BYTES_ALLOCATED
);
706 size_spec
= integral_type_size
[size
];
711 fmt
= SIGNED_DECIMAL
;
712 sprintf (fmt_string
, " %%%u%sd",
713 (field_width
= bytes_to_signed_dec_digits
[size
]),
714 (size_spec
== LONG
? "l" : ""));
719 sprintf (fmt_string
, " %%0%u%so",
720 (field_width
= bytes_to_oct_digits
[size
]),
721 (size_spec
== LONG
? "l" : ""));
725 fmt
= UNSIGNED_DECIMAL
;
726 sprintf (fmt_string
, " %%%u%su",
727 (field_width
= bytes_to_unsigned_dec_digits
[size
]),
728 (size_spec
== LONG
? "l" : ""));
733 sprintf (fmt_string
, " %%0%u%sx",
734 (field_width
= bytes_to_hex_digits
[size
]),
735 (size_spec
== LONG
? "l" : ""));
742 assert (strlen (fmt_string
) < FMT_BYTES_ALLOCATED
);
747 print_function
= (fmt
== SIGNED_DECIMAL
753 print_function
= (fmt
== SIGNED_DECIMAL
759 print_function
= print_int
;
763 print_function
= print_long
;
772 fmt
= FLOATING_POINT
;
778 size
= sizeof (float);
783 size
= sizeof (double);
788 size
= sizeof (LONG_DOUBLE
);
792 if (simple_strtoul (s
, &p
, &size
) != 0)
794 /* The integer at P in S would overflow an unsigned long.
795 A digit string that long is sufficiently odd looking
796 that the following diagnostic is sufficient. */
797 error (0, 0, _("invalid type string `%s'"), s_orig
);
801 size
= sizeof (double);
804 if (size
> MAX_FP_TYPE_SIZE
805 || fp_type_size
[size
] == NO_SIZE
)
807 error (0, 0, _("invalid type string `%s';\n\
808 this system doesn't provide a %lu-byte floating point type"), s_orig
, size
);
815 size_spec
= fp_type_size
[size
];
820 print_function
= print_float
;
821 /* Don't use %#e; not all systems support it. */
822 pre_fmt_string
= " %%%d.%de";
823 fmt_string
= xmalloc (strlen (pre_fmt_string
));
824 sprintf (fmt_string
, pre_fmt_string
,
825 (field_width
= FLT_DIG
+ 8), FLT_DIG
);
829 print_function
= print_double
;
830 pre_fmt_string
= " %%%d.%de";
831 fmt_string
= xmalloc (strlen (pre_fmt_string
));
832 sprintf (fmt_string
, pre_fmt_string
,
833 (field_width
= DBL_DIG
+ 8), DBL_DIG
);
836 #ifdef HAVE_LONG_DOUBLE
837 case FLOAT_LONG_DOUBLE
:
838 print_function
= print_long_double
;
839 pre_fmt_string
= " %%%d.%dLe";
840 fmt_string
= xmalloc (strlen (pre_fmt_string
));
841 sprintf (fmt_string
, pre_fmt_string
,
842 (field_width
= LDBL_DIG
+ 8), LDBL_DIG
);
853 fmt
= NAMED_CHARACTER
;
856 print_function
= print_named_ascii
;
865 print_function
= print_ascii
;
870 error (0, 0, _("invalid character `%c' in type string `%s'"),
875 tspec
->size
= size_spec
;
877 tspec
->print_function
= print_function
;
878 tspec
->fmt_string
= fmt_string
;
880 tspec
->field_width
= field_width
;
881 tspec
->hexl_mode_trailer
= (*s
== 'z');
882 if (tspec
->hexl_mode_trailer
)
891 /* Decode the POSIX-style od format string S. Append the decoded
892 representation to the global array SPEC, reallocating SPEC if
893 necessary. Return zero if S is valid, nonzero otherwise. */
896 decode_format_string (const char *s
)
898 const char *s_orig
= s
;
906 if (decode_one_format (s_orig
, s
, &next
, &tspec
))
912 if (n_specs
>= n_specs_allocated
)
914 n_specs_allocated
= 1 + (3 * n_specs_allocated
) / 2;
915 spec
= (struct tspec
*) xrealloc ((char *) spec
,
917 * sizeof (struct tspec
)));
920 memcpy ((char *) &spec
[n_specs
], (char *) &tspec
,
921 sizeof (struct tspec
));
928 /* Given a list of one or more input filenames FILE_LIST, set the global
929 file pointer IN_STREAM to position N_SKIP in the concatenation of
930 those files. If any file operation fails or if there are fewer than
931 N_SKIP bytes in the combined input, give an error message and return
932 nonzero. When possible, use seek- rather than read operations to
933 advance IN_STREAM. A file name of "-" is interpreted as standard
942 for ( /* empty */ ; *file_list
!= NULL
; ++file_list
)
944 struct stat file_stats
;
947 if (STREQ (*file_list
, "-"))
949 input_filename
= _("standard input");
955 input_filename
= *file_list
;
956 in_stream
= fopen (input_filename
, "r");
957 if (in_stream
== NULL
)
959 error (0, errno
, "%s", input_filename
);
964 SET_BINARY (fileno (in_stream
));
969 /* First try using fseek. For large offsets, this extra work is
970 worthwhile. If the offset is below some threshold it may be
971 more efficient to move the pointer by reading. There are two
972 issues when trying to use fseek:
973 - the file must be seekable.
974 - before seeking to the specified position, make sure
975 that the new position is in the current file.
976 Try to do that by getting file's size using fstat().
977 But that will work only for regular files and dirs. */
979 if (fstat (fileno (in_stream
), &file_stats
))
981 error (0, errno
, "%s", input_filename
);
986 /* The st_size field is valid only for regular files and
987 directories. FIXME: is the preceding true?
988 If the number of bytes left to skip is at least as large as
989 the size of the current file, we can decrement
990 n_skip and go on to the next file. */
991 if (S_ISREG (file_stats
.st_mode
) || S_ISDIR (file_stats
.st_mode
))
993 if (n_skip
>= file_stats
.st_size
)
995 n_skip
-= file_stats
.st_size
;
996 if (in_stream
!= stdin
&& fclose (in_stream
) == EOF
)
998 error (0, errno
, "%s", input_filename
);
1005 /* Try fseeko if available, fseek otherwise. */
1006 if (fseeko (in_stream
, n_skip
, SEEK_SET
) == 0
1007 || (n_skip
<= LONG_MAX
1008 && fseek (in_stream
, (long) n_skip
, SEEK_SET
) == 0))
1016 /* Seek didn't work or wasn't attempted; position the file pointer
1019 for (j
= n_skip
/ BUFSIZ
; j
>= 0; j
--)
1022 size_t n_bytes_to_read
= (j
> 0
1025 size_t n_bytes_read
;
1026 n_bytes_read
= fread (buf
, 1, n_bytes_to_read
, in_stream
);
1027 n_skip
-= n_bytes_read
;
1028 if (n_bytes_read
!= n_bytes_to_read
)
1037 error (EXIT_FAILURE
, 0, _("cannot skip past end of combined input"));
1043 format_address_none (long unsigned int address
)
1049 format_address_std (long unsigned int address
)
1051 const char *address_string
;
1053 sprintf (address_fmt_buffer
, output_address_fmt_string
, address
);
1054 address_string
= address_fmt_buffer
;
1055 return address_string
;
1059 format_address_label (long unsigned int address
)
1061 const char *address_string
;
1062 assert (output_address_fmt_string
!= NULL
);
1064 sprintf (address_fmt_buffer
, output_address_fmt_string
,
1065 address
, address
+ pseudo_offset
);
1066 address_string
= address_fmt_buffer
;
1067 return address_string
;
1070 /* Write N_BYTES bytes from CURR_BLOCK to standard output once for each
1071 of the N_SPEC format specs. CURRENT_OFFSET is the byte address of
1072 CURR_BLOCK in the concatenation of input files, and it is printed
1073 (optionally) only before the output line associated with the first
1074 format spec. When duplicate blocks are being abbreviated, the output
1075 for a sequence of identical input blocks is the output for the first
1076 block followed by an asterisk alone on a line. It is valid to compare
1077 the blocks PREV_BLOCK and CURR_BLOCK only when N_BYTES == BYTES_PER_BLOCK.
1078 That condition may be false only for the last input block -- and then
1079 only when it has not been padded to length BYTES_PER_BLOCK. */
1082 write_block (long unsigned int current_offset
, long unsigned int n_bytes
,
1083 const char *prev_block
, const char *curr_block
)
1085 static int first
= 1;
1086 static int prev_pair_equal
= 0;
1088 #define EQUAL_BLOCKS(b1, b2) (memcmp ((b1), (b2), bytes_per_block) == 0)
1090 if (abbreviate_duplicate_blocks
1091 && !first
&& n_bytes
== bytes_per_block
1092 && EQUAL_BLOCKS (prev_block
, curr_block
))
1094 if (prev_pair_equal
)
1096 /* The two preceding blocks were equal, and the current
1097 block is the same as the last one, so print nothing. */
1102 prev_pair_equal
= 1;
1109 prev_pair_equal
= 0;
1110 for (i
= 0; i
< n_specs
; i
++)
1112 const char *addr_or_pad
= (i
== 0
1113 ? format_address (current_offset
)
1116 fputs (addr_or_pad
, stdout
);
1117 (*spec
[i
].print_function
) (n_bytes
, curr_block
, spec
[i
].fmt_string
);
1118 if (spec
[i
].hexl_mode_trailer
)
1120 /* space-pad out to full line width, then dump the trailer */
1121 int datum_width
= width_bytes
[spec
[i
].size
];
1122 int blank_fields
= (bytes_per_block
- n_bytes
) / datum_width
;
1123 int field_width
= spec
[i
].field_width
+ 1;
1124 printf ("%*s", blank_fields
* field_width
, "");
1125 dump_hexl_mode_trailer (n_bytes
, curr_block
);
1133 /* Test whether there have been errors on in_stream, and close it if
1134 it is not standard input. Return nonzero if there has been an error
1135 on in_stream or stdout; return zero otherwise. This function will
1136 report more than one error only if both a read and a write error
1140 check_and_close (void)
1145 if (ferror (in_stream
))
1147 error (0, errno
, "%s", input_filename
);
1148 if (in_stream
!= stdin
)
1152 else if (in_stream
!= stdin
&& fclose (in_stream
) == EOF
)
1154 error (0, errno
, "%s", input_filename
);
1158 if (ferror (stdout
))
1160 error (0, errno
, _("standard output"));
1167 /* Read a single byte into *C from the concatenation of the input files
1168 named in the global array FILE_LIST. On the first call to this
1169 function, the global variable IN_STREAM is expected to be an open
1170 stream associated with the input file *FILE_LIST. If IN_STREAM is
1171 at end-of-file, close it and update the global variables IN_STREAM,
1172 FILE_LIST, and INPUT_FILENAME so they correspond to the next file in
1173 the list. Then try to read a byte from the newly opened file.
1174 Repeat if necessary until *FILE_LIST is NULL. When EOF is reached
1175 for the last file in FILE_LIST, set *C to EOF and return. Subsequent
1176 calls do likewise. The return value is nonzero if any errors
1177 occured, zero otherwise. */
1184 if (*file_list
== NULL
)
1193 *c
= fgetc (in_stream
);
1198 err
|= check_and_close ();
1203 if (*file_list
== NULL
)
1206 if (STREQ (*file_list
, "-"))
1208 input_filename
= _("standard input");
1210 have_read_stdin
= 1;
1214 input_filename
= *file_list
;
1215 in_stream
= fopen (input_filename
, "r");
1216 if (in_stream
== NULL
)
1218 error (0, errno
, "%s", input_filename
);
1222 SET_BINARY (fileno (in_stream
));
1224 while (in_stream
== NULL
);
1228 /* Read N bytes into BLOCK from the concatenation of the input files
1229 named in the global array FILE_LIST. On the first call to this
1230 function, the global variable IN_STREAM is expected to be an open
1231 stream associated with the input file *FILE_LIST. On subsequent
1232 calls, if *FILE_LIST is NULL, don't modify BLOCK and return zero.
1233 If all N bytes cannot be read from IN_STREAM, close IN_STREAM and
1234 update the global variables IN_STREAM, FILE_LIST, and INPUT_FILENAME.
1235 Then try to read the remaining bytes from the newly opened file.
1236 Repeat if necessary until *FILE_LIST is NULL. Set *N_BYTES_IN_BUFFER
1237 to the number of bytes read. If an error occurs, it will be detected
1238 through ferror when the stream is about to be closed. If there is an
1239 error, give a message but continue reading as usual and return nonzero.
1240 Otherwise return zero. */
1243 read_block (size_t n
, char *block
, size_t *n_bytes_in_buffer
)
1247 assert (n
> 0 && n
<= bytes_per_block
);
1249 *n_bytes_in_buffer
= 0;
1254 if (*file_list
== NULL
)
1255 return 0; /* EOF. */
1263 n_needed
= n
- *n_bytes_in_buffer
;
1264 n_read
= fread (block
+ *n_bytes_in_buffer
, 1, n_needed
, in_stream
);
1266 *n_bytes_in_buffer
+= n_read
;
1268 if (n_read
== n_needed
)
1271 err
|= check_and_close ();
1276 if (*file_list
== NULL
)
1279 if (STREQ (*file_list
, "-"))
1281 input_filename
= _("standard input");
1283 have_read_stdin
= 1;
1287 input_filename
= *file_list
;
1288 in_stream
= fopen (input_filename
, "r");
1289 if (in_stream
== NULL
)
1291 error (0, errno
, "%s", input_filename
);
1295 SET_BINARY (fileno (in_stream
));
1297 while (in_stream
== NULL
);
1301 /* Return the least common multiple of the sizes associated
1302 with the format specs. */
1310 for (i
= 0; i
< n_specs
; i
++)
1311 l_c_m
= lcm (l_c_m
, width_bytes
[(int) spec
[i
].size
]);
1315 /* If S is a valid pre-POSIX offset specification with an optional leading '+'
1316 return the offset it denotes. Otherwise, return -1. */
1319 parse_old_offset (const char *s
)
1323 enum strtol_error s_err
;
1324 long unsigned int tmp
;
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 s_err
= xstrtoul (s
, NULL
, radix
, &tmp
, "Bb");
1347 if (s_err
!= LONGINT_OK
)
1349 STRTOL_FAIL_WARN (s
, _("old-style offset"), s_err
);
1356 /* Read a chunk of size BYTES_PER_BLOCK from the input files, write the
1357 formatted block to standard output, and repeat until the specified
1358 maximum number of bytes has been read or until all input has been
1359 processed. If the last block read is smaller than BYTES_PER_BLOCK
1360 and its size is not a multiple of the size associated with a format
1361 spec, extend the input block with zero bytes until its length is a
1362 multiple of all format spec sizes. Write the final block. Finally,
1363 write on a line by itself the offset of the byte after the last byte
1364 read. Accumulate return values from calls to read_block and
1365 check_and_close, and if any was nonzero, return nonzero.
1366 Otherwise, return zero. */
1372 off_t current_offset
;
1376 size_t n_bytes_read
;
1378 #ifdef lint /* Suppress `used before initialized' warning. */
1382 block
[0] = (char *) alloca (bytes_per_block
);
1383 block
[1] = (char *) alloca (bytes_per_block
);
1385 current_offset
= n_bytes_to_skip
;
1389 if (limit_bytes_to_format
)
1391 end_offset
= n_bytes_to_skip
+ max_bytes_to_format
;
1396 if (current_offset
>= end_offset
)
1401 n_needed
= MIN (end_offset
- current_offset
,
1402 (off_t
) bytes_per_block
);
1403 err
|= read_block (n_needed
, block
[idx
], &n_bytes_read
);
1404 if (n_bytes_read
< bytes_per_block
)
1406 assert (n_bytes_read
== bytes_per_block
);
1407 write_block (current_offset
, n_bytes_read
,
1408 block
[!idx
], block
[idx
]);
1409 current_offset
+= n_bytes_read
;
1417 err
|= read_block (bytes_per_block
, block
[idx
], &n_bytes_read
);
1418 if (n_bytes_read
< bytes_per_block
)
1420 assert (n_bytes_read
== bytes_per_block
);
1421 write_block (current_offset
, n_bytes_read
,
1422 block
[!idx
], block
[idx
]);
1423 current_offset
+= n_bytes_read
;
1428 if (n_bytes_read
> 0)
1431 size_t bytes_to_write
;
1435 /* Make bytes_to_write the smallest multiple of l_c_m that
1436 is at least as large as n_bytes_read. */
1437 bytes_to_write
= l_c_m
* (int) ((n_bytes_read
+ l_c_m
- 1) / l_c_m
);
1439 memset (block
[idx
] + n_bytes_read
, 0, bytes_to_write
- n_bytes_read
);
1440 write_block (current_offset
, bytes_to_write
,
1441 block
[!idx
], block
[idx
]);
1442 current_offset
+= n_bytes_read
;
1445 if (output_address_fmt_string
!= NULL
)
1446 printf ("%s\n", format_address (current_offset
));
1448 if (limit_bytes_to_format
&& current_offset
> end_offset
)
1449 err
|= check_and_close ();
1454 /* STRINGS mode. Find each "string constant" in the input.
1455 A string constant is a run of at least `string_min' ASCII
1456 graphic (or formatting) characters terminated by a null.
1457 Based on a function written by Richard Stallman for a
1458 pre-POSIX version of od. Return nonzero if an error
1459 occurs. Otherwise, return zero. */
1464 size_t bufsize
= MAX (100, string_min
);
1465 char *buf
= xmalloc (bufsize
);
1466 off_t address
= n_bytes_to_skip
;
1475 /* See if the next `string_min' chars are all printing chars. */
1478 if (limit_bytes_to_format
1479 && address
>= (n_bytes_to_skip
+ max_bytes_to_format
-
1480 (off_t
) string_min
))
1483 for (i
= 0; i
< string_min
; i
++)
1485 err
|= read_char (&c
);
1493 /* Found a non-printing. Try again starting with next char. */
1498 /* We found a run of `string_min' printable characters.
1499 Now see if it is terminated with a null byte. */
1500 while (!limit_bytes_to_format
1501 || address
< n_bytes_to_skip
+ max_bytes_to_format
)
1505 bufsize
= 1 + 3 * bufsize
/ 2;
1506 buf
= xrealloc (buf
, bufsize
);
1508 err
|= read_char (&c
);
1516 break; /* It is; print this string. */
1518 goto tryline
; /* It isn't; give up on this string. */
1519 buf
[i
++] = c
; /* String continues; store it all. */
1522 /* If we get here, the string is all printable and null-terminated,
1523 so print it. It is all in `buf' and `i' is its length. */
1525 if (output_address_fmt_string
!= NULL
)
1527 printf ("%s ", format_address (address
- i
- 1));
1529 for (i
= 0; (c
= buf
[i
]); i
++)
1534 fputs ("\\a", stdout
);
1538 fputs ("\\b", stdout
);
1542 fputs ("\\f", stdout
);
1546 fputs ("\\n", stdout
);
1550 fputs ("\\r", stdout
);
1554 fputs ("\\t", stdout
);
1558 fputs ("\\v", stdout
);
1568 /* We reach this point only if we search through
1569 (max_bytes_to_format - string_min) bytes before reachine EOF. */
1573 err
|= check_and_close ();
1578 main (int argc
, char **argv
)
1584 unsigned int address_pad_len
;
1585 unsigned long int desired_width
;
1586 int width_specified
= 0;
1587 int n_failed_decodes
= 0;
1590 /* The old-style `pseudo starting address' to be printed in parentheses
1591 after any true address. */
1592 long int pseudo_start
;
1594 #ifdef lint /* Suppress `used before initialized' warning. */
1598 program_name
= argv
[0];
1599 setlocale (LC_ALL
, "");
1600 bindtextdomain (PACKAGE
, LOCALEDIR
);
1601 textdomain (PACKAGE
);
1605 for (i
= 0; i
<= MAX_INTEGRAL_TYPE_SIZE
; i
++)
1606 integral_type_size
[i
] = NO_SIZE
;
1608 integral_type_size
[sizeof (char)] = CHAR
;
1609 integral_type_size
[sizeof (short int)] = SHORT
;
1610 integral_type_size
[sizeof (int)] = INT
;
1611 integral_type_size
[sizeof (long int)] = LONG
;
1613 for (i
= 0; i
<= MAX_FP_TYPE_SIZE
; i
++)
1614 fp_type_size
[i
] = NO_SIZE
;
1616 fp_type_size
[sizeof (float)] = FLOAT_SINGLE
;
1617 /* The array entry for `double' is filled in after that for LONG_DOUBLE
1618 so that if `long double' is the same type or if long double isn't
1619 supported FLOAT_LONG_DOUBLE will never be used. */
1620 fp_type_size
[sizeof (LONG_DOUBLE
)] = FLOAT_LONG_DOUBLE
;
1621 fp_type_size
[sizeof (double)] = FLOAT_DOUBLE
;
1624 n_specs_allocated
= 5;
1625 spec
= (struct tspec
*) xmalloc (n_specs_allocated
* sizeof (struct tspec
));
1627 output_address_fmt_string
= "%07o";
1628 format_address
= format_address_std
;
1629 address_pad_len
= 7;
1630 flag_dump_strings
= 0;
1632 while ((c
= getopt_long (argc
, argv
, "abcdfhilos::xw::A:j:N:t:v",
1633 long_options
, NULL
)) != -1)
1635 unsigned long int tmp
;
1636 enum strtol_error s_err
;
1647 output_address_fmt_string
= "%07d";
1648 format_address
= format_address_std
;
1649 address_pad_len
= 7;
1652 output_address_fmt_string
= "%07o";
1653 format_address
= format_address_std
;
1654 address_pad_len
= 7;
1657 output_address_fmt_string
= "%06x";
1658 format_address
= format_address_std
;
1659 address_pad_len
= 6;
1662 output_address_fmt_string
= NULL
;
1663 format_address
= format_address_none
;
1664 address_pad_len
= 0;
1667 error (EXIT_FAILURE
, 0,
1668 _("invalid output address radix `%c'; \
1669 it must be one character from [doxn]"),
1676 s_err
= xstrtoul (optarg
, NULL
, 0, &tmp
, "bkm");
1677 n_bytes_to_skip
= tmp
;
1678 if (s_err
!= LONGINT_OK
)
1679 STRTOL_FATAL_ERROR (optarg
, _("skip argument"), s_err
);
1683 limit_bytes_to_format
= 1;
1685 /* FIXME: if off_t is long long and that's an 8-byte type,
1686 use xstrtouq here. */
1687 s_err
= xstrtoul (optarg
, NULL
, 0, &tmp
, "bkm");
1688 max_bytes_to_format
= tmp
;
1689 if (s_err
!= LONGINT_OK
)
1690 STRTOL_FATAL_ERROR (optarg
, _("limit argument"), s_err
);
1693 error (EXIT_FAILURE
, 0,
1694 _("specified number of bytes `%s' is larger than \
1695 the maximum\nrepresentable value of type `long'"), optarg
);
1703 s_err
= xstrtoul (optarg
, NULL
, 0, &string_min
, "bkm");
1704 if (s_err
!= LONGINT_OK
)
1705 STRTOL_FATAL_ERROR (optarg
, _("minimum string length"), s_err
);
1707 ++flag_dump_strings
;
1711 if (decode_format_string (optarg
))
1716 abbreviate_duplicate_blocks
= 0;
1723 /* The next several cases map the old, pre-POSIX format
1724 specification options to the corresponding POSIX format
1725 specs. GNU od accepts any combination of old- and
1726 new-style options. Format specification options accumulate. */
1728 #define CASE_OLD_ARG(old_char,new_string) \
1731 if (decode_format_string (new_string)) \
1732 ++n_failed_decodes; \
1736 CASE_OLD_ARG ('a', "a");
1737 CASE_OLD_ARG ('b', "oC");
1738 CASE_OLD_ARG ('c', "c");
1739 CASE_OLD_ARG ('d', "u2");
1740 CASE_OLD_ARG ('f', "fF");
1741 CASE_OLD_ARG ('h', "x2");
1742 CASE_OLD_ARG ('i', "d2");
1743 CASE_OLD_ARG ('l', "d4");
1744 CASE_OLD_ARG ('o', "o2");
1745 CASE_OLD_ARG ('x', "x2");
1750 width_specified
= 1;
1757 s_err
= xstrtoul (optarg
, NULL
, 10, &desired_width
, "");
1758 if (s_err
!= LONGINT_OK
)
1759 STRTOL_FATAL_ERROR (optarg
, _("width specification"), s_err
);
1769 if (n_failed_decodes
> 0)
1770 exit (EXIT_FAILURE
);
1774 printf ("od (%s) %s\n", GNU_PACKAGE
, VERSION
);
1775 exit (EXIT_SUCCESS
);
1781 if (flag_dump_strings
&& n_specs
> 0)
1782 error (EXIT_FAILURE
, 0,
1783 _("no type may be specified when dumping strings"));
1785 n_files
= argc
- optind
;
1787 /* If the --backward-compatible option is used, there may be from
1788 0 to 3 remaining command line arguments; handle each case
1790 od [file] [[+]offset[.][b] [[+]label[.][b]]]
1791 The offset and pseudo_start have the same syntax. */
1799 if ((offset
= parse_old_offset (argv
[optind
])) >= 0)
1801 n_bytes_to_skip
= offset
;
1806 else if (n_files
== 2)
1809 if ((o1
= parse_old_offset (argv
[optind
])) >= 0
1810 && (o2
= parse_old_offset (argv
[optind
+ 1])) >= 0)
1812 n_bytes_to_skip
= o1
;
1813 flag_pseudo_start
= 1;
1818 else if ((o2
= parse_old_offset (argv
[optind
+ 1])) >= 0)
1820 n_bytes_to_skip
= o2
;
1822 argv
[optind
+ 1] = argv
[optind
];
1828 _("invalid second operand in compatibility mode `%s'"),
1833 else if (n_files
== 3)
1836 if ((o1
= parse_old_offset (argv
[optind
+ 1])) >= 0
1837 && (o2
= parse_old_offset (argv
[optind
+ 2])) >= 0)
1839 n_bytes_to_skip
= o1
;
1840 flag_pseudo_start
= 1;
1842 argv
[optind
+ 2] = argv
[optind
];
1849 _("in compatibility mode, the last two arguments must be offsets"));
1853 else if (n_files
> 3)
1856 _("compatibility mode supports at most three arguments"));
1860 if (flag_pseudo_start
)
1862 static char buf
[10];
1864 if (output_address_fmt_string
== NULL
)
1866 output_address_fmt_string
= "(%07o)";
1867 format_address
= format_address_std
;
1871 sprintf (buf
, "%s (%s)",
1872 output_address_fmt_string
,
1873 output_address_fmt_string
);
1874 output_address_fmt_string
= buf
;
1875 format_address
= format_address_label
;
1880 assert (address_pad_len
<= MAX_ADDRESS_LENGTH
);
1881 for (i
= 0; i
< address_pad_len
; i
++)
1882 address_pad
[i
] = ' ';
1883 address_pad
[address_pad_len
] = '\0';
1887 if (decode_one_format ("o2", "o2", NULL
, &(spec
[0])))
1889 /* This happens on Cray systems that don't have a 2-byte
1891 exit (EXIT_FAILURE
);
1898 file_list
= (char const *const *) &argv
[optind
];
1901 /* If no files were listed on the command line, set up the
1902 global array FILE_LIST so that it contains the null-terminated
1903 list of one name: "-". */
1904 static char const *const default_file_list
[] = {"-", NULL
};
1906 file_list
= default_file_list
;
1909 err
|= skip (n_bytes_to_skip
);
1910 if (in_stream
== NULL
)
1913 pseudo_offset
= (flag_pseudo_start
? pseudo_start
- n_bytes_to_skip
: 0);
1915 /* Compute output block length. */
1918 if (width_specified
)
1920 if (desired_width
!= 0 && desired_width
% l_c_m
== 0)
1921 bytes_per_block
= desired_width
;
1924 error (0, 0, _("warning: invalid width %lu; using %d instead"),
1925 desired_width
, l_c_m
);
1926 bytes_per_block
= l_c_m
;
1931 if (l_c_m
< DEFAULT_BYTES_PER_BLOCK
)
1932 bytes_per_block
= l_c_m
* (int) (DEFAULT_BYTES_PER_BLOCK
/ l_c_m
);
1934 bytes_per_block
= l_c_m
;
1938 for (i
= 0; i
< n_specs
; i
++)
1940 printf (_("%d: fmt=\"%s\" width=%d\n"),
1941 i
, spec
[i
].fmt_string
, width_bytes
[spec
[i
].size
]);
1945 err
|= (flag_dump_strings
? dump_strings () : dump ());
1949 if (have_read_stdin
&& fclose (stdin
) == EOF
)
1950 error (EXIT_FAILURE
, errno
, _("standard input"));
1952 if (fclose (stdout
) == EOF
)
1953 error (EXIT_FAILURE
, errno
, _("write error"));
1955 exit (err
== 0 ? EXIT_SUCCESS
: EXIT_FAILURE
);