1 /* od -- dump files in octal and other formats
2 Copyright (C) 92, 1995-2001 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>
31 /* The official name of this program (e.g., no `g' prefix). */
32 #define PROGRAM_NAME "od"
34 #define AUTHORS "Jim Meyering"
36 #if defined(__GNUC__) || defined(STDC_HEADERS)
40 #ifdef HAVE_LONG_DOUBLE
41 typedef long double LONG_DOUBLE
;
43 typedef double LONG_DOUBLE
;
50 /* The default number of input bytes per output line. */
51 #define DEFAULT_BYTES_PER_BLOCK 16
53 /* The number of decimal digits of precision in a float. */
58 /* The number of decimal digits of precision in a double. */
63 /* The number of decimal digits of precision in a long double. */
65 # define LDBL_DIG DBL_DIG
76 /* FIXME: add INTMAX support, too */
93 /* Each output format specification (from POSIX `-t spec' or from
94 old-style options) is represented by one of these structures. */
97 enum output_format fmt
;
99 void (*print_function
) ();
101 int hexl_mode_trailer
;
105 /* The name this program was run with. */
108 /* Convert the number of 8-bit bytes of a binary representation to
109 the number of characters (digits + sign if the type is signed)
110 required to represent the same quantity in the specified base/type.
111 For example, a 32-bit (4-byte) quantity may require a field width
112 as wide as the following for these types:
116 8 unsigned hexadecimal */
118 static const unsigned int bytes_to_oct_digits
[] =
119 {0, 3, 6, 8, 11, 14, 16, 19, 22, 25, 27, 30, 32, 35, 38, 41, 43};
121 static const unsigned int bytes_to_signed_dec_digits
[] =
122 {1, 4, 6, 8, 11, 13, 16, 18, 20, 23, 25, 28, 30, 33, 35, 37, 40};
124 static const unsigned int bytes_to_unsigned_dec_digits
[] =
125 {0, 3, 5, 8, 10, 13, 15, 17, 20, 22, 25, 27, 29, 32, 34, 37, 39};
127 static const unsigned int bytes_to_hex_digits
[] =
128 {0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32};
130 /* Convert enum size_spec to the size of the named type. */
131 static const int width_bytes
[] =
143 /* Names for some non-printing characters. */
144 static const char *const charname
[33] =
146 "nul", "soh", "stx", "etx", "eot", "enq", "ack", "bel",
147 "bs", "ht", "nl", "vt", "ff", "cr", "so", "si",
148 "dle", "dc1", "dc2", "dc3", "dc4", "nak", "syn", "etb",
149 "can", "em", "sub", "esc", "fs", "gs", "rs", "us",
153 /* Address base (8, 10 or 16). */
154 static int address_base
;
156 /* The number of octal digits required to represent the largest off_t value. */
157 #define MAX_ADDRESS_LENGTH \
158 ((sizeof (off_t) * CHAR_BIT + CHAR_BIT - 1) / 3)
160 /* Width of a normal address. */
161 static int address_pad_len
;
163 static size_t string_min
;
164 static int flag_dump_strings
;
166 /* Non-zero if we should recognize the pre-POSIX non-option arguments
167 that specified at most one file and optional arguments specifying
168 offset and pseudo-start address. */
169 static int traditional
;
171 /* Non-zero if an old-style `pseudo-address' was specified. */
172 static int flag_pseudo_start
;
174 /* The difference between the old-style pseudo starting address and
175 the number of bytes to skip. */
176 static off_t pseudo_offset
;
178 /* Function that accepts an address and an optional following char,
179 and prints the address and char to stdout. */
180 static void (*format_address
) PARAMS ((off_t
, char));
182 /* The number of input bytes to skip before formatting and writing. */
183 static off_t n_bytes_to_skip
= 0;
185 /* When nonzero, MAX_BYTES_TO_FORMAT is the maximum number of bytes
186 to be read and formatted. Otherwise all input is formatted. */
187 static int limit_bytes_to_format
= 0;
189 /* The maximum number of bytes that will be formatted. This
190 value is used only when LIMIT_BYTES_TO_FORMAT is nonzero. */
191 static off_t max_bytes_to_format
;
193 /* When nonzero and two or more consecutive blocks are equal, format
194 only the first block and output an asterisk alone on the following
195 line to indicate that identical blocks have been elided. */
196 static int abbreviate_duplicate_blocks
= 1;
198 /* An array of specs describing how to format each input block. */
199 static struct tspec
*spec
;
201 /* The number of format specs. */
202 static size_t n_specs
;
204 /* The allocated length of SPEC. */
205 static size_t n_specs_allocated
;
207 /* The number of input bytes formatted per output line. It must be
208 a multiple of the least common multiple of the sizes associated with
209 the specified output types. It should be as large as possible, but
210 no larger than 16 -- unless specified with the -w option. */
211 static size_t bytes_per_block
;
213 /* Human-readable representation of *file_list (for error messages).
214 It differs from *file_list only when *file_list is "-". */
215 static char const *input_filename
;
217 /* A NULL-terminated list of the file-arguments from the command line.
218 If no file-arguments were specified, this variable is initialized
220 static char const *const *file_list
;
222 /* The input stream associated with the current file. */
223 static FILE *in_stream
;
225 /* If nonzero, at least one of the files we read was standard input. */
226 static int have_read_stdin
;
228 #if HAVE_UNSIGNED_LONG_LONG
229 typedef unsigned long long ulonglong_t
;
231 /* This is just a place-holder to avoid a few `#if' directives.
232 In this case, the type isn't actually used. */
233 typedef unsigned long int ulonglong_t
;
236 #define MAX_INTEGRAL_TYPE_SIZE sizeof (ulonglong_t)
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 static struct option
const long_options
[] =
245 {"skip-bytes", required_argument
, NULL
, 'j'},
246 {"address-radix", required_argument
, NULL
, 'A'},
247 {"read-bytes", required_argument
, NULL
, 'N'},
248 {"format", required_argument
, NULL
, 't'},
249 {"output-duplicates", no_argument
, NULL
, 'v'},
251 /* non-POSIX options. */
252 {"strings", optional_argument
, NULL
, 's'},
253 {"traditional", no_argument
, NULL
, 'B'},
254 {"width", optional_argument
, NULL
, 'w'},
256 {GETOPT_HELP_OPTION_DECL
},
257 {GETOPT_VERSION_OPTION_DECL
},
265 fprintf (stderr
, _("Try `%s --help' for more information.\n"),
270 Usage: %s [OPTION]... [FILE]...\n\
271 or: %s --traditional [FILE] [[+]OFFSET [[+]LABEL]]\n\
273 program_name
, program_name
);
275 Write an unambiguous representation, octal bytes by default, of FILE\n\
276 to standard output. With no FILE, or when FILE is -, read standard input.\n\
278 -A, --address-radix=RADIX decide how file offsets are printed\n\
279 -j, --skip-bytes=BYTES skip BYTES input bytes first on each file\n\
280 -N, --read-bytes=BYTES limit dump to BYTES input bytes per file\n\
281 -s, --strings[=BYTES] output strings of at least BYTES graphic chars\n\
282 -t, --format=TYPE select output format or formats\n\
283 -v, --output-duplicates do not use * to mark line suppression\n\
284 -w, --width[=BYTES] output BYTES bytes per output line\n\
285 --traditional accept arguments in pre-POSIX form\n\
286 --help display this help and exit\n\
287 --version output version information and exit\n\
289 Pre-POSIX format specifications may be intermixed, they accumulate:\n\
290 -a same as -t a, select named characters\n\
291 -b same as -t oC, select octal bytes\n\
292 -c same as -t c, select ASCII characters or backslash escapes\n\
293 -d same as -t u2, select unsigned decimal shorts\n\
294 -f same as -t fF, select floats\n\
295 -h same as -t x2, select hexadecimal shorts\n\
296 -i same as -t d2, select decimal shorts\n\
297 -l same as -t d4, select decimal longs\n\
298 -o same as -t o2, select octal shorts\n\
299 -x same as -t x2, select hexadecimal shorts\n\
303 For older syntax (second call format), OFFSET means -j OFFSET. LABEL\n\
304 is the pseudo-address at first byte printed, incremented when dump is\n\
305 progressing. For OFFSET and LABEL, a 0x or 0X prefix indicates\n\
306 hexadecimal, suffixes maybe . for octal and b multiply by 512.\n\
308 TYPE is made up of one or more of these specifications:\n\
311 c ASCII character or backslash escape\n\
312 d[SIZE] signed decimal, SIZE bytes per integer\n\
313 f[SIZE] floating point, SIZE bytes per integer\n\
314 o[SIZE] octal, SIZE bytes per integer\n\
315 u[SIZE] unsigned decimal, SIZE bytes per integer\n\
316 x[SIZE] hexadecimal, SIZE bytes per integer\n\
318 SIZE is a number. For TYPE in doux, SIZE may also be C for\n\
319 sizeof(char), S for sizeof(short), I for sizeof(int) or L for\n\
320 sizeof(long). If TYPE is f, SIZE may also be F for sizeof(float), D\n\
321 for sizeof(double) or L for sizeof(long double).\n\
323 RADIX is d for decimal, o for octal, x for hexadecimal or n for none.\n\
324 BYTES is hexadecimal with 0x or 0X prefix, it is multiplied by 512\n\
325 with b suffix, by 1024 with k and by 1048576 with m. Adding a z suffix to\n\
326 any type adds a display of printable characters to the end of each line\n\
327 of output. -s without a number implies 3. -w without a number implies 32.\n\
328 By default, od uses -A o -t d2 -w 16.\n\
330 puts (_("\nReport bugs to <bug-textutils@gnu.org>."));
332 exit (status
== 0 ? EXIT_SUCCESS
: EXIT_FAILURE
);
335 /* Compute the greatest common denominator of U and V
336 using Euclid's algorithm. */
339 gcd (unsigned int u
, unsigned int v
)
351 /* Compute the least common multiple of U and V. */
354 lcm (unsigned int u
, unsigned int v
)
356 unsigned int t
= gcd (u
, v
);
363 print_s_char (off_t n_bytes
, const char *block
, const char *fmt_string
)
366 for (i
= n_bytes
; i
> 0; i
--)
368 int tmp
= (unsigned) *(const unsigned char *) block
;
370 tmp
-= SCHAR_MAX
- SCHAR_MIN
+ 1;
371 assert (tmp
<= SCHAR_MAX
);
372 printf (fmt_string
, tmp
);
373 block
+= sizeof (unsigned char);
378 print_char (off_t n_bytes
, const char *block
, const char *fmt_string
)
381 for (i
= n_bytes
; i
> 0; i
--)
383 unsigned int tmp
= *(const unsigned char *) block
;
384 printf (fmt_string
, tmp
);
385 block
+= sizeof (unsigned char);
390 print_s_short (off_t n_bytes
, const char *block
, const char *fmt_string
)
393 for (i
= n_bytes
/ sizeof (unsigned short); i
> 0; i
--)
395 int tmp
= (unsigned) *(const unsigned short *) block
;
397 tmp
-= SHRT_MAX
- SHRT_MIN
+ 1;
398 assert (tmp
<= SHRT_MAX
);
399 printf (fmt_string
, tmp
);
400 block
+= sizeof (unsigned short);
405 print_short (off_t n_bytes
, const char *block
, const char *fmt_string
)
408 for (i
= n_bytes
/ sizeof (unsigned short); i
> 0; i
--)
410 unsigned int tmp
= *(const unsigned short *) block
;
411 printf (fmt_string
, tmp
);
412 block
+= sizeof (unsigned short);
417 print_int (off_t n_bytes
, const char *block
, const char *fmt_string
)
420 for (i
= n_bytes
/ sizeof (unsigned int); i
> 0; i
--)
422 unsigned int tmp
= *(const unsigned int *) block
;
423 printf (fmt_string
, tmp
);
424 block
+= sizeof (unsigned int);
429 print_long (off_t n_bytes
, const char *block
, const char *fmt_string
)
432 for (i
= n_bytes
/ sizeof (unsigned long); i
> 0; i
--)
434 unsigned long tmp
= *(const unsigned long *) block
;
435 printf (fmt_string
, tmp
);
436 block
+= sizeof (unsigned long);
441 print_long_long (off_t n_bytes
, const char *block
, const char *fmt_string
)
444 for (i
= n_bytes
/ sizeof (ulonglong_t
); i
> 0; i
--)
446 ulonglong_t tmp
= *(const ulonglong_t
*) block
;
447 printf (fmt_string
, tmp
);
448 block
+= sizeof (ulonglong_t
);
453 print_float (off_t n_bytes
, const char *block
, 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 (off_t n_bytes
, const char *block
, const char *fmt_string
)
468 for (i
= n_bytes
/ sizeof (double); i
> 0; i
--)
470 double tmp
= *(const double *) block
;
471 printf (fmt_string
, tmp
);
472 block
+= sizeof (double);
476 #ifdef HAVE_LONG_DOUBLE
478 print_long_double (off_t n_bytes
, const char *block
, const char *fmt_string
)
481 for (i
= n_bytes
/ sizeof (LONG_DOUBLE
); i
> 0; i
--)
483 LONG_DOUBLE tmp
= *(const LONG_DOUBLE
*) block
;
484 printf (fmt_string
, tmp
);
485 block
+= sizeof (LONG_DOUBLE
);
492 dump_hexl_mode_trailer (off_t n_bytes
, const char *block
)
495 fputs (" >", stdout
);
496 for (i
= n_bytes
; i
> 0; i
--)
498 unsigned int c
= *(const unsigned char *) block
;
499 unsigned int c2
= (ISPRINT(c
) ? c
: '.');
501 block
+= sizeof (unsigned char);
507 print_named_ascii (off_t n_bytes
, const char *block
,
508 const char *unused_fmt_string ATTRIBUTE_UNUSED
)
511 for (i
= n_bytes
; i
> 0; i
--)
513 unsigned int c
= *(const unsigned char *) block
;
514 unsigned int masked_c
= (0x7f & c
);
520 else if (masked_c
<= 040)
521 s
= charname
[masked_c
];
524 sprintf (buf
, " %c", masked_c
);
529 block
+= sizeof (unsigned char);
534 print_ascii (off_t n_bytes
, const char *block
,
535 const char *unused_fmt_string ATTRIBUTE_UNUSED
)
538 for (i
= n_bytes
; i
> 0; i
--)
540 unsigned int c
= *(const unsigned char *) block
;
579 sprintf (buf
, (ISPRINT (c
) ? " %c" : "%03o"), c
);
580 s
= (const char *) buf
;
584 block
+= sizeof (unsigned char);
588 /* Convert a null-terminated (possibly zero-length) string S to an
589 unsigned long integer value. If S points to a non-digit set *P to S,
590 *VAL to 0, and return 0. Otherwise, accumulate the integer value of
591 the string of digits. If the string of digits represents a value
592 larger than ULONG_MAX, don't modify *VAL or *P and return nonzero.
593 Otherwise, advance *P to the first non-digit after S, set *VAL to
594 the result of the conversion and return zero. */
597 simple_strtoul (const char *s
, const char **p
, long unsigned int *val
)
599 unsigned long int sum
;
604 unsigned int c
= *s
++ - '0';
605 if (sum
> (ULONG_MAX
- c
) / 10)
614 /* If S points to a single valid POSIX-style od format string, put
615 a description of that format in *TSPEC, make *NEXT point at the
616 character following the just-decoded format (if *NEXT is non-NULL),
617 and return zero. If S is not valid, don't modify *NEXT or *TSPEC,
618 give a diagnostic, and return nonzero. For example, if S were
619 "d4afL" *NEXT would be set to "afL" and *TSPEC would be
621 fmt = SIGNED_DECIMAL;
622 size = INT or LONG; (whichever integral_type_size[4] resolves to)
623 print_function = print_int; (assuming size == INT)
624 fmt_string = "%011d%c";
626 S_ORIG is solely for reporting errors. It should be the full format
631 decode_one_format (const char *s_orig
, const char *s
, const char **next
,
634 enum size_spec size_spec
;
635 unsigned long int size
;
636 enum output_format fmt
;
637 const char *pre_fmt_string
;
639 void (*print_function
) PARAMS ((off_t
, const char *, const char *));
642 unsigned int field_width
= 0;
644 assert (tspec
!= NULL
);
658 size
= sizeof (char);
663 size
= sizeof (short);
673 size
= sizeof (long int);
677 if (simple_strtoul (s
, &p
, &size
) != 0)
679 /* The integer at P in S would overflow an unsigned long.
680 A digit string that long is sufficiently odd looking
681 that the following diagnostic is sufficient. */
682 error (0, 0, _("invalid type string `%s'"), s_orig
);
689 if (MAX_INTEGRAL_TYPE_SIZE
< size
690 || integral_type_size
[size
] == NO_SIZE
)
692 error (0, 0, _("invalid type string `%s';\n\
693 this system doesn't provide a %lu-byte integral type"), s_orig
, size
);
701 #define FMT_BYTES_ALLOCATED 9
702 fmt_string
= xmalloc (FMT_BYTES_ALLOCATED
);
704 size_spec
= integral_type_size
[size
];
709 fmt
= SIGNED_DECIMAL
;
710 sprintf (fmt_string
, " %%%u%sd",
711 (field_width
= bytes_to_signed_dec_digits
[size
]),
712 (size_spec
== LONG
? "l"
713 : (size_spec
== LONG_LONG
? "ll"
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
;
767 print_function
= print_long_long
;
776 fmt
= FLOATING_POINT
;
782 size
= sizeof (float);
787 size
= sizeof (double);
792 size
= sizeof (LONG_DOUBLE
);
796 if (simple_strtoul (s
, &p
, &size
) != 0)
798 /* The integer at P in S would overflow an unsigned long.
799 A digit string that long is sufficiently odd looking
800 that the following diagnostic is sufficient. */
801 error (0, 0, _("invalid type string `%s'"), s_orig
);
805 size
= sizeof (double);
808 if (size
> MAX_FP_TYPE_SIZE
809 || fp_type_size
[size
] == NO_SIZE
)
811 error (0, 0, _("invalid type string `%s';\n\
812 this system doesn't provide a %lu-byte floating point type"), s_orig
, size
);
819 size_spec
= fp_type_size
[size
];
824 print_function
= print_float
;
825 /* Don't use %#e; not all systems support it. */
826 pre_fmt_string
= " %%%d.%de";
827 fmt_string
= xmalloc (strlen (pre_fmt_string
));
828 sprintf (fmt_string
, pre_fmt_string
,
829 (field_width
= FLT_DIG
+ 8), FLT_DIG
);
833 print_function
= print_double
;
834 pre_fmt_string
= " %%%d.%de";
835 fmt_string
= xmalloc (strlen (pre_fmt_string
));
836 sprintf (fmt_string
, pre_fmt_string
,
837 (field_width
= DBL_DIG
+ 8), DBL_DIG
);
840 #ifdef HAVE_LONG_DOUBLE
841 case FLOAT_LONG_DOUBLE
:
842 print_function
= print_long_double
;
843 pre_fmt_string
= " %%%d.%dLe";
844 fmt_string
= xmalloc (strlen (pre_fmt_string
));
845 sprintf (fmt_string
, pre_fmt_string
,
846 (field_width
= LDBL_DIG
+ 8), LDBL_DIG
);
857 fmt
= NAMED_CHARACTER
;
860 print_function
= print_named_ascii
;
869 print_function
= print_ascii
;
874 error (0, 0, _("invalid character `%c' in type string `%s'"),
879 tspec
->size
= size_spec
;
881 tspec
->print_function
= print_function
;
882 tspec
->fmt_string
= fmt_string
;
884 tspec
->field_width
= field_width
;
885 tspec
->hexl_mode_trailer
= (*s
== 'z');
886 if (tspec
->hexl_mode_trailer
)
895 /* Decode the POSIX-style od format string S. Append the decoded
896 representation to the global array SPEC, reallocating SPEC if
897 necessary. Return zero if S is valid, nonzero otherwise. */
900 decode_format_string (const char *s
)
902 const char *s_orig
= s
;
910 if (decode_one_format (s_orig
, s
, &next
, &tspec
))
916 if (n_specs
>= n_specs_allocated
)
918 n_specs_allocated
= 1 + (3 * n_specs_allocated
) / 2;
919 spec
= (struct tspec
*) xrealloc ((char *) spec
,
921 * sizeof (struct tspec
)));
924 memcpy ((char *) &spec
[n_specs
], (char *) &tspec
,
925 sizeof (struct tspec
));
932 /* Given a list of one or more input filenames FILE_LIST, set the global
933 file pointer IN_STREAM to position N_SKIP in the concatenation of
934 those files. If any file operation fails or if there are fewer than
935 N_SKIP bytes in the combined input, give an error message and return
936 nonzero. When possible, use seek- rather than read operations to
937 advance IN_STREAM. A file name of "-" is interpreted as standard
946 for ( /* empty */ ; *file_list
!= NULL
; ++file_list
)
948 struct stat file_stats
;
951 if (STREQ (*file_list
, "-"))
953 input_filename
= _("standard input");
959 input_filename
= *file_list
;
960 in_stream
= fopen (input_filename
, "r");
961 if (in_stream
== NULL
)
963 error (0, errno
, "%s", input_filename
);
968 SET_BINARY (fileno (in_stream
));
973 /* First try seeking. For large offsets, this extra work is
974 worthwhile. If the offset is below some threshold it may be
975 more efficient to move the pointer by reading. There are two
976 issues when trying to seek:
977 - the file must be seekable.
978 - before seeking to the specified position, make sure
979 that the new position is in the current file.
980 Try to do that by getting file's size using fstat.
981 But that will work only for regular files. */
983 if (fstat (fileno (in_stream
), &file_stats
))
985 error (0, errno
, "%s", input_filename
);
990 /* The st_size field is valid only for regular files
991 (and for symbolic links, which cannot occur here).
992 If the number of bytes left to skip is at least as large as
993 the size of the current file, we can decrement
994 n_skip and go on to the next file. */
995 if (S_ISREG (file_stats
.st_mode
))
997 if (file_stats
.st_size
<= n_skip
)
999 n_skip
-= file_stats
.st_size
;
1000 if (in_stream
!= stdin
&& fclose (in_stream
) == EOF
)
1002 error (0, errno
, "%s", input_filename
);
1009 if (0 <= lseek (fileno (in_stream
), n_skip
, SEEK_CUR
))
1017 /* Seek didn't work or wasn't attempted; position the file pointer
1020 for (j
= n_skip
/ BUFSIZ
; 0 <= j
; j
--)
1023 size_t n_bytes_to_read
= (0 < j
1026 size_t n_bytes_read
;
1027 n_bytes_read
= fread (buf
, 1, n_bytes_to_read
, in_stream
);
1028 n_skip
-= n_bytes_read
;
1029 if (n_bytes_read
!= n_bytes_to_read
)
1038 error (EXIT_FAILURE
, 0, _("cannot skip past end of combined input"));
1044 format_address_none (off_t address ATTRIBUTE_UNUSED
, char c ATTRIBUTE_UNUSED
)
1049 format_address_std (off_t address
, char c
)
1051 char buf
[MAX_ADDRESS_LENGTH
+ 2];
1052 char *p
= buf
+ sizeof buf
;
1057 pbound
= p
- address_pad_len
;
1059 /* Use a special case of the code for each base. This is measurably
1060 faster than generic code. */
1061 switch (address_base
)
1065 *--p
= '0' + (address
& 7);
1066 while ((address
>>= 3) != 0);
1071 *--p
= '0' + (address
% 10);
1072 while ((address
/= 10) != 0);
1077 *--p
= "0123456789abcdef"[address
& 15];
1078 while ((address
>>= 4) != 0);
1089 format_address_paren (off_t address
, char c
)
1092 format_address_std (address
, ')');
1097 format_address_label (off_t address
, char c
)
1099 format_address_std (address
, ' ');
1100 format_address_paren (address
+ pseudo_offset
, c
);
1103 /* Write N_BYTES bytes from CURR_BLOCK to standard output once for each
1104 of the N_SPEC format specs. CURRENT_OFFSET is the byte address of
1105 CURR_BLOCK in the concatenation of input files, and it is printed
1106 (optionally) only before the output line associated with the first
1107 format spec. When duplicate blocks are being abbreviated, the output
1108 for a sequence of identical input blocks is the output for the first
1109 block followed by an asterisk alone on a line. It is valid to compare
1110 the blocks PREV_BLOCK and CURR_BLOCK only when N_BYTES == BYTES_PER_BLOCK.
1111 That condition may be false only for the last input block -- and then
1112 only when it has not been padded to length BYTES_PER_BLOCK. */
1115 write_block (off_t current_offset
, off_t n_bytes
,
1116 const char *prev_block
, const char *curr_block
)
1118 static int first
= 1;
1119 static int prev_pair_equal
= 0;
1121 #define EQUAL_BLOCKS(b1, b2) (memcmp ((b1), (b2), bytes_per_block) == 0)
1123 if (abbreviate_duplicate_blocks
1124 && !first
&& n_bytes
== bytes_per_block
1125 && EQUAL_BLOCKS (prev_block
, curr_block
))
1127 if (prev_pair_equal
)
1129 /* The two preceding blocks were equal, and the current
1130 block is the same as the last one, so print nothing. */
1135 prev_pair_equal
= 1;
1142 prev_pair_equal
= 0;
1143 for (i
= 0; i
< n_specs
; i
++)
1146 format_address (current_offset
, '\0');
1148 printf ("%*s", address_pad_len
, "");
1149 (*spec
[i
].print_function
) (n_bytes
, curr_block
, spec
[i
].fmt_string
);
1150 if (spec
[i
].hexl_mode_trailer
)
1152 /* space-pad out to full line width, then dump the trailer */
1153 int datum_width
= width_bytes
[spec
[i
].size
];
1154 int blank_fields
= (bytes_per_block
- n_bytes
) / datum_width
;
1155 int field_width
= spec
[i
].field_width
+ 1;
1156 printf ("%*s", blank_fields
* field_width
, "");
1157 dump_hexl_mode_trailer (n_bytes
, curr_block
);
1165 /* Test whether there have been errors on in_stream, and close it if
1166 it is not standard input. Return nonzero if there has been an error
1167 on in_stream or stdout; return zero otherwise. This function will
1168 report more than one error only if both a read and a write error
1172 check_and_close (void)
1177 if (ferror (in_stream
))
1179 error (0, errno
, "%s", input_filename
);
1180 if (in_stream
!= stdin
)
1184 else if (in_stream
!= stdin
&& fclose (in_stream
) == EOF
)
1186 error (0, errno
, "%s", input_filename
);
1190 if (ferror (stdout
))
1192 error (0, errno
, _("standard output"));
1199 /* Read a single byte into *C from the concatenation of the input files
1200 named in the global array FILE_LIST. On the first call to this
1201 function, the global variable IN_STREAM is expected to be an open
1202 stream associated with the input file *FILE_LIST. If IN_STREAM is
1203 at end-of-file, close it and update the global variables IN_STREAM,
1204 FILE_LIST, and INPUT_FILENAME so they correspond to the next file in
1205 the list. Then try to read a byte from the newly opened file.
1206 Repeat if necessary until *FILE_LIST is NULL. When EOF is reached
1207 for the last file in FILE_LIST, set *C to EOF and return. Subsequent
1208 calls do likewise. The return value is nonzero if any errors
1209 occured, zero otherwise. */
1216 if (*file_list
== NULL
)
1225 *c
= fgetc (in_stream
);
1230 err
|= check_and_close ();
1235 if (*file_list
== NULL
)
1238 if (STREQ (*file_list
, "-"))
1240 input_filename
= _("standard input");
1242 have_read_stdin
= 1;
1246 input_filename
= *file_list
;
1247 in_stream
= fopen (input_filename
, "r");
1248 if (in_stream
== NULL
)
1250 error (0, errno
, "%s", input_filename
);
1254 SET_BINARY (fileno (in_stream
));
1256 while (in_stream
== NULL
);
1260 /* Read N bytes into BLOCK from the concatenation of the input files
1261 named in the global array FILE_LIST. On the first call to this
1262 function, the global variable IN_STREAM is expected to be an open
1263 stream associated with the input file *FILE_LIST. On subsequent
1264 calls, if *FILE_LIST is NULL, don't modify BLOCK and return zero.
1265 If all N bytes cannot be read from IN_STREAM, close IN_STREAM and
1266 update the global variables IN_STREAM, FILE_LIST, and INPUT_FILENAME.
1267 Then try to read the remaining bytes from the newly opened file.
1268 Repeat if necessary until *FILE_LIST is NULL. Set *N_BYTES_IN_BUFFER
1269 to the number of bytes read. If an error occurs, it will be detected
1270 through ferror when the stream is about to be closed. If there is an
1271 error, give a message but continue reading as usual and return nonzero.
1272 Otherwise return zero. */
1275 read_block (size_t n
, char *block
, size_t *n_bytes_in_buffer
)
1279 assert (0 < n
&& n
<= bytes_per_block
);
1281 *n_bytes_in_buffer
= 0;
1286 if (*file_list
== NULL
)
1287 return 0; /* EOF. */
1295 n_needed
= n
- *n_bytes_in_buffer
;
1296 n_read
= fread (block
+ *n_bytes_in_buffer
, 1, n_needed
, in_stream
);
1298 *n_bytes_in_buffer
+= n_read
;
1300 if (n_read
== n_needed
)
1303 err
|= check_and_close ();
1308 if (*file_list
== NULL
)
1311 if (STREQ (*file_list
, "-"))
1313 input_filename
= _("standard input");
1315 have_read_stdin
= 1;
1319 input_filename
= *file_list
;
1320 in_stream
= fopen (input_filename
, "r");
1321 if (in_stream
== NULL
)
1323 error (0, errno
, "%s", input_filename
);
1327 SET_BINARY (fileno (in_stream
));
1329 while (in_stream
== NULL
);
1333 /* Return the least common multiple of the sizes associated
1334 with the format specs. */
1342 for (i
= 0; i
< n_specs
; i
++)
1343 l_c_m
= lcm (l_c_m
, width_bytes
[(int) spec
[i
].size
]);
1347 /* If S is a valid pre-POSIX offset specification with an optional leading '+'
1348 return the offset it denotes. Otherwise, return -1. */
1351 parse_old_offset (const char *s
)
1355 enum strtol_error s_err
;
1361 /* Skip over any leading '+'. */
1365 /* Determine the radix we'll use to interpret S. If there is a `.',
1366 it's decimal, otherwise, if the string begins with `0X'or `0x',
1367 it's hexadecimal, else octal. */
1368 if (strchr (s
, '.') != NULL
)
1372 if (s
[0] == '0' && (s
[1] == 'x' || s
[1] == 'X'))
1378 s_err
= xstrtoumax (s
, NULL
, radix
, &tmp
, "Bb");
1379 if (s_err
!= LONGINT_OK
)
1381 STRTOL_FAIL_WARN (s
, _("old-style offset"), s_err
);
1384 if (OFF_T_MAX
< tmp
)
1385 error (EXIT_FAILURE
, 0,
1386 _("%s is larger than the maximum file size on this system"), s
);
1391 /* Read a chunk of size BYTES_PER_BLOCK from the input files, write the
1392 formatted block to standard output, and repeat until the specified
1393 maximum number of bytes has been read or until all input has been
1394 processed. If the last block read is smaller than BYTES_PER_BLOCK
1395 and its size is not a multiple of the size associated with a format
1396 spec, extend the input block with zero bytes until its length is a
1397 multiple of all format spec sizes. Write the final block. Finally,
1398 write on a line by itself the offset of the byte after the last byte
1399 read. Accumulate return values from calls to read_block and
1400 check_and_close, and if any was nonzero, return nonzero.
1401 Otherwise, return zero. */
1407 off_t current_offset
;
1408 off_t end_offset
IF_LINT (= 0);
1411 size_t n_bytes_read
;
1413 block
[0] = (char *) alloca (bytes_per_block
);
1414 block
[1] = (char *) alloca (bytes_per_block
);
1416 current_offset
= n_bytes_to_skip
;
1420 if (limit_bytes_to_format
)
1422 end_offset
= n_bytes_to_skip
+ max_bytes_to_format
;
1427 if (current_offset
>= end_offset
)
1432 n_needed
= MIN (end_offset
- current_offset
,
1433 (off_t
) bytes_per_block
);
1434 err
|= read_block (n_needed
, block
[idx
], &n_bytes_read
);
1435 if (n_bytes_read
< bytes_per_block
)
1437 assert (n_bytes_read
== bytes_per_block
);
1438 write_block (current_offset
, n_bytes_read
,
1439 block
[!idx
], block
[idx
]);
1440 current_offset
+= n_bytes_read
;
1448 err
|= read_block (bytes_per_block
, block
[idx
], &n_bytes_read
);
1449 if (n_bytes_read
< bytes_per_block
)
1451 assert (n_bytes_read
== bytes_per_block
);
1452 write_block (current_offset
, n_bytes_read
,
1453 block
[!idx
], block
[idx
]);
1454 current_offset
+= n_bytes_read
;
1459 if (n_bytes_read
> 0)
1462 size_t bytes_to_write
;
1466 /* Make bytes_to_write the smallest multiple of l_c_m that
1467 is at least as large as n_bytes_read. */
1468 bytes_to_write
= l_c_m
* ((n_bytes_read
+ l_c_m
- 1) / l_c_m
);
1470 memset (block
[idx
] + n_bytes_read
, 0, bytes_to_write
- n_bytes_read
);
1471 write_block (current_offset
, bytes_to_write
,
1472 block
[!idx
], block
[idx
]);
1473 current_offset
+= n_bytes_read
;
1476 format_address (current_offset
, '\n');
1478 if (limit_bytes_to_format
&& current_offset
> end_offset
)
1479 err
|= check_and_close ();
1484 /* STRINGS mode. Find each "string constant" in the input.
1485 A string constant is a run of at least `string_min' ASCII
1486 graphic (or formatting) characters terminated by a null.
1487 Based on a function written by Richard Stallman for a
1488 pre-POSIX version of od. Return nonzero if an error
1489 occurs. Otherwise, return zero. */
1494 size_t bufsize
= MAX (100, string_min
);
1495 char *buf
= xmalloc (bufsize
);
1496 off_t address
= n_bytes_to_skip
;
1505 /* See if the next `string_min' chars are all printing chars. */
1508 if (limit_bytes_to_format
1509 && address
>= (n_bytes_to_skip
+ max_bytes_to_format
- string_min
))
1512 for (i
= 0; i
< string_min
; i
++)
1514 err
|= read_char (&c
);
1522 /* Found a non-printing. Try again starting with next char. */
1527 /* We found a run of `string_min' printable characters.
1528 Now see if it is terminated with a null byte. */
1529 while (!limit_bytes_to_format
1530 || address
< n_bytes_to_skip
+ max_bytes_to_format
)
1534 bufsize
= 1 + 3 * bufsize
/ 2;
1535 buf
= xrealloc (buf
, bufsize
);
1537 err
|= read_char (&c
);
1545 break; /* It is; print this string. */
1547 goto tryline
; /* It isn't; give up on this string. */
1548 buf
[i
++] = c
; /* String continues; store it all. */
1551 /* If we get here, the string is all printable and null-terminated,
1552 so print it. It is all in `buf' and `i' is its length. */
1554 format_address (address
- i
- 1, ' ');
1556 for (i
= 0; (c
= buf
[i
]); i
++)
1561 fputs ("\\a", stdout
);
1565 fputs ("\\b", stdout
);
1569 fputs ("\\f", stdout
);
1573 fputs ("\\n", stdout
);
1577 fputs ("\\r", stdout
);
1581 fputs ("\\t", stdout
);
1585 fputs ("\\v", stdout
);
1595 /* We reach this point only if we search through
1596 (max_bytes_to_format - string_min) bytes before reachine EOF. */
1600 err
|= check_and_close ();
1605 main (int argc
, char **argv
)
1611 size_t desired_width
IF_LINT (= 0);
1612 int width_specified
= 0;
1613 int n_failed_decodes
= 0;
1616 /* The old-style `pseudo starting address' to be printed in parentheses
1617 after any true address. */
1618 off_t pseudo_start
IF_LINT (= 0);
1620 program_name
= argv
[0];
1621 setlocale (LC_ALL
, "");
1622 bindtextdomain (PACKAGE
, LOCALEDIR
);
1623 textdomain (PACKAGE
);
1625 atexit (close_stdout
);
1629 for (i
= 0; i
<= MAX_INTEGRAL_TYPE_SIZE
; i
++)
1630 integral_type_size
[i
] = NO_SIZE
;
1632 integral_type_size
[sizeof (char)] = CHAR
;
1633 integral_type_size
[sizeof (short int)] = SHORT
;
1634 integral_type_size
[sizeof (int)] = INT
;
1635 integral_type_size
[sizeof (long int)] = LONG
;
1636 #if HAVE_UNSIGNED_LONG_LONG
1637 integral_type_size
[sizeof (ulonglong_t
)] = LONG_LONG
;
1640 for (i
= 0; i
<= MAX_FP_TYPE_SIZE
; i
++)
1641 fp_type_size
[i
] = NO_SIZE
;
1643 fp_type_size
[sizeof (float)] = FLOAT_SINGLE
;
1644 /* The array entry for `double' is filled in after that for LONG_DOUBLE
1645 so that if `long double' is the same type or if long double isn't
1646 supported FLOAT_LONG_DOUBLE will never be used. */
1647 fp_type_size
[sizeof (LONG_DOUBLE
)] = FLOAT_LONG_DOUBLE
;
1648 fp_type_size
[sizeof (double)] = FLOAT_DOUBLE
;
1651 n_specs_allocated
= 5;
1652 spec
= (struct tspec
*) xmalloc (n_specs_allocated
* sizeof (struct tspec
));
1654 format_address
= format_address_std
;
1656 address_pad_len
= 7;
1657 flag_dump_strings
= 0;
1659 while ((c
= getopt_long (argc
, argv
, "abcdfhilos::xw::A:j:N:t:v",
1660 long_options
, NULL
)) != -1)
1663 enum strtol_error s_err
;
1674 format_address
= format_address_std
;
1676 address_pad_len
= 7;
1679 format_address
= format_address_std
;
1681 address_pad_len
= 7;
1684 format_address
= format_address_std
;
1686 address_pad_len
= 6;
1689 format_address
= format_address_none
;
1690 address_pad_len
= 0;
1693 error (EXIT_FAILURE
, 0,
1694 _("invalid output address radix `%c'; \
1695 it must be one character from [doxn]"),
1702 s_err
= xstrtoumax (optarg
, NULL
, 0, &tmp
, "bkm");
1703 n_bytes_to_skip
= tmp
;
1704 if (s_err
!= LONGINT_OK
)
1705 STRTOL_FATAL_ERROR (optarg
, _("skip argument"), s_err
);
1709 limit_bytes_to_format
= 1;
1711 s_err
= xstrtoumax (optarg
, NULL
, 0, &tmp
, "bkm");
1712 max_bytes_to_format
= tmp
;
1713 if (s_err
!= LONGINT_OK
)
1714 STRTOL_FATAL_ERROR (optarg
, _("limit argument"), s_err
);
1716 if (OFF_T_MAX
< tmp
)
1717 error (EXIT_FAILURE
, 0,
1718 _("%s is larger than the maximum file size on this system"),
1727 s_err
= xstrtoumax (optarg
, NULL
, 0, &tmp
, "bkm");
1728 if (s_err
!= LONGINT_OK
)
1729 STRTOL_FATAL_ERROR (optarg
, _("minimum string length"), s_err
);
1731 /* The minimum string length may be no larger than SIZE_MAX,
1732 since we may allocate a buffer of this size. */
1734 error (EXIT_FAILURE
, 0, _("%s is too large"), optarg
);
1738 flag_dump_strings
= 1;
1742 if (decode_format_string (optarg
))
1747 abbreviate_duplicate_blocks
= 0;
1754 /* The next several cases map the old, pre-POSIX format
1755 specification options to the corresponding POSIX format
1756 specs. GNU od accepts any combination of old- and
1757 new-style options. Format specification options accumulate. */
1759 #define CASE_OLD_ARG(old_char,new_string) \
1762 if (decode_format_string (new_string)) \
1763 ++n_failed_decodes; \
1767 CASE_OLD_ARG ('a', "a");
1768 CASE_OLD_ARG ('b', "oC");
1769 CASE_OLD_ARG ('c', "c");
1770 CASE_OLD_ARG ('d', "u2");
1771 CASE_OLD_ARG ('f', "fF");
1772 CASE_OLD_ARG ('h', "x2");
1773 CASE_OLD_ARG ('i', "d2");
1774 CASE_OLD_ARG ('l', "d4");
1775 CASE_OLD_ARG ('o', "o2");
1776 CASE_OLD_ARG ('x', "x2");
1781 width_specified
= 1;
1789 s_err
= xstrtoumax (optarg
, NULL
, 10, &w_tmp
, "");
1790 if (s_err
!= LONGINT_OK
)
1791 STRTOL_FATAL_ERROR (optarg
, _("width specification"), s_err
);
1792 if (SIZE_MAX
< w_tmp
)
1793 error (EXIT_FAILURE
, 0, _("%s is too large"), optarg
);
1794 desired_width
= w_tmp
;
1798 case_GETOPT_HELP_CHAR
;
1800 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
1808 if (n_failed_decodes
> 0)
1809 exit (EXIT_FAILURE
);
1811 if (flag_dump_strings
&& n_specs
> 0)
1812 error (EXIT_FAILURE
, 0,
1813 _("no type may be specified when dumping strings"));
1815 n_files
= argc
- optind
;
1817 /* If the --backward-compatible option is used, there may be from
1818 0 to 3 remaining command line arguments; handle each case
1820 od [file] [[+]offset[.][b] [[+]label[.][b]]]
1821 The offset and pseudo_start have the same syntax. */
1829 if ((offset
= parse_old_offset (argv
[optind
])) >= 0)
1831 n_bytes_to_skip
= offset
;
1836 else if (n_files
== 2)
1839 if ((o1
= parse_old_offset (argv
[optind
])) >= 0
1840 && (o2
= parse_old_offset (argv
[optind
+ 1])) >= 0)
1842 n_bytes_to_skip
= o1
;
1843 flag_pseudo_start
= 1;
1848 else if ((o2
= parse_old_offset (argv
[optind
+ 1])) >= 0)
1850 n_bytes_to_skip
= o2
;
1852 argv
[optind
+ 1] = argv
[optind
];
1858 _("invalid second operand in compatibility mode `%s'"),
1863 else if (n_files
== 3)
1866 if ((o1
= parse_old_offset (argv
[optind
+ 1])) >= 0
1867 && (o2
= parse_old_offset (argv
[optind
+ 2])) >= 0)
1869 n_bytes_to_skip
= o1
;
1870 flag_pseudo_start
= 1;
1872 argv
[optind
+ 2] = argv
[optind
];
1879 _("in compatibility mode, the last two arguments must be offsets"));
1883 else if (n_files
> 3)
1886 _("compatibility mode supports at most three arguments"));
1890 if (flag_pseudo_start
)
1892 if (format_address
== format_address_none
)
1895 address_pad_len
= 7;
1896 format_address
= format_address_paren
;
1899 format_address
= format_address_label
;
1905 if (decode_one_format ("o2", "o2", NULL
, &(spec
[0])))
1907 /* This happens on Cray systems that don't have a 2-byte
1909 exit (EXIT_FAILURE
);
1916 file_list
= (char const *const *) &argv
[optind
];
1919 /* If no files were listed on the command line, set up the
1920 global array FILE_LIST so that it contains the null-terminated
1921 list of one name: "-". */
1922 static char const *const default_file_list
[] = {"-", NULL
};
1924 file_list
= default_file_list
;
1927 err
|= skip (n_bytes_to_skip
);
1928 if (in_stream
== NULL
)
1931 pseudo_offset
= (flag_pseudo_start
? pseudo_start
- n_bytes_to_skip
: 0);
1933 /* Compute output block length. */
1936 if (width_specified
)
1938 if (desired_width
!= 0 && desired_width
% l_c_m
== 0)
1939 bytes_per_block
= desired_width
;
1942 error (0, 0, _("warning: invalid width %lu; using %d instead"),
1943 (unsigned long) desired_width
, l_c_m
);
1944 bytes_per_block
= l_c_m
;
1949 if (l_c_m
< DEFAULT_BYTES_PER_BLOCK
)
1950 bytes_per_block
= l_c_m
* (DEFAULT_BYTES_PER_BLOCK
/ l_c_m
);
1952 bytes_per_block
= l_c_m
;
1956 for (i
= 0; i
< n_specs
; i
++)
1958 printf (_("%d: fmt=\"%s\" width=%d\n"),
1959 i
, spec
[i
].fmt_string
, width_bytes
[spec
[i
].size
]);
1963 err
|= (flag_dump_strings
? dump_strings () : dump ());
1967 if (have_read_stdin
&& fclose (stdin
) == EOF
)
1968 error (EXIT_FAILURE
, errno
, _("standard input"));
1970 exit (err
== 0 ? EXIT_SUCCESS
: EXIT_FAILURE
);