sort: pacify GCC 12 false positive
[coreutils.git] / src / od.c
blobadb32388684021b6775d24d47d45615614e0e556
1 /* od -- dump files in octal and other formats
2 Copyright (C) 1992-2022 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 3 of the License, or
7 (at your option) any later version.
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, see <https://www.gnu.org/licenses/>. */
17 /* Written by Jim Meyering. */
19 #include <config.h>
21 #include <stdio.h>
22 #include <assert.h>
23 #include <getopt.h>
24 #include <sys/types.h>
25 #include "system.h"
26 #include "argmatch.h"
27 #include "die.h"
28 #include "error.h"
29 #include "ftoastr.h"
30 #include "quote.h"
31 #include "stat-size.h"
32 #include "xbinary-io.h"
33 #include "xprintf.h"
34 #include "xstrtol.h"
35 #include "xstrtol-error.h"
37 /* The official name of this program (e.g., no 'g' prefix). */
38 #define PROGRAM_NAME "od"
40 #define AUTHORS proper_name ("Jim Meyering")
42 /* The default number of input bytes per output line. */
43 #define DEFAULT_BYTES_PER_BLOCK 16
45 #if HAVE_UNSIGNED_LONG_LONG_INT
46 typedef unsigned long long int unsigned_long_long_int;
47 #else
48 /* This is just a place-holder to avoid a few '#if' directives.
49 In this case, the type isn't actually used. */
50 typedef unsigned long int unsigned_long_long_int;
51 #endif
53 enum size_spec
55 NO_SIZE,
56 CHAR,
57 SHORT,
58 INT,
59 LONG,
60 LONG_LONG,
61 /* FIXME: add INTMAX support, too */
62 FLOAT_SINGLE,
63 FLOAT_DOUBLE,
64 FLOAT_LONG_DOUBLE,
65 N_SIZE_SPECS
68 enum output_format
70 SIGNED_DECIMAL,
71 UNSIGNED_DECIMAL,
72 OCTAL,
73 HEXADECIMAL,
74 FLOATING_POINT,
75 NAMED_CHARACTER,
76 CHARACTER
79 #define MAX_INTEGRAL_TYPE_SIZE sizeof (unsigned_long_long_int)
81 /* The maximum number of bytes needed for a format string, including
82 the trailing nul. Each format string expects a variable amount of
83 padding (guaranteed to be at least 1 plus the field width), then an
84 element that will be formatted in the field. */
85 enum
87 FMT_BYTES_ALLOCATED =
88 (sizeof "%*.99" - 1
89 + MAX (sizeof "ld",
90 MAX (sizeof PRIdMAX,
91 MAX (sizeof PRIoMAX,
92 MAX (sizeof PRIuMAX,
93 sizeof PRIxMAX)))))
96 /* Ensure that our choice for FMT_BYTES_ALLOCATED is reasonable. */
97 verify (MAX_INTEGRAL_TYPE_SIZE * CHAR_BIT / 3 <= 99);
99 /* Each output format specification (from '-t spec' or from
100 old-style options) is represented by one of these structures. */
101 struct tspec
103 enum output_format fmt;
104 enum size_spec size; /* Type of input object. */
105 /* FIELDS is the number of fields per line, BLANK is the number of
106 fields to leave blank. WIDTH is width of one field, excluding
107 leading space, and PAD is total pad to divide among FIELDS.
108 PAD is at least as large as FIELDS. */
109 void (*print_function) (size_t fields, size_t blank, void const *data,
110 char const *fmt, int width, int pad);
111 char fmt_string[FMT_BYTES_ALLOCATED]; /* Of the style "%*d". */
112 bool hexl_mode_trailer;
113 int field_width; /* Minimum width of a field, excluding leading space. */
114 int pad_width; /* Total padding to be divided among fields. */
117 /* Convert the number of 8-bit bytes of a binary representation to
118 the number of characters (digits + sign if the type is signed)
119 required to represent the same quantity in the specified base/type.
120 For example, a 32-bit (4-byte) quantity may require a field width
121 as wide as the following for these types:
122 11 unsigned octal
123 11 signed decimal
124 10 unsigned decimal
125 8 unsigned hexadecimal */
127 static unsigned int const bytes_to_oct_digits[] =
128 {0, 3, 6, 8, 11, 14, 16, 19, 22, 25, 27, 30, 32, 35, 38, 41, 43};
130 static unsigned int const bytes_to_signed_dec_digits[] =
131 {1, 4, 6, 8, 11, 13, 16, 18, 20, 23, 25, 28, 30, 33, 35, 37, 40};
133 static unsigned int const bytes_to_unsigned_dec_digits[] =
134 {0, 3, 5, 8, 10, 13, 15, 17, 20, 22, 25, 27, 29, 32, 34, 37, 39};
136 static unsigned int const bytes_to_hex_digits[] =
137 {0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32};
139 /* It'll be a while before we see integral types wider than 16 bytes,
140 but if/when it happens, this check will catch it. Without this check,
141 a wider type would provoke a buffer overrun. */
142 verify (MAX_INTEGRAL_TYPE_SIZE < ARRAY_CARDINALITY (bytes_to_hex_digits));
144 /* Make sure the other arrays have the same length. */
145 verify (sizeof bytes_to_oct_digits == sizeof bytes_to_signed_dec_digits);
146 verify (sizeof bytes_to_oct_digits == sizeof bytes_to_unsigned_dec_digits);
147 verify (sizeof bytes_to_oct_digits == sizeof bytes_to_hex_digits);
149 /* Convert enum size_spec to the size of the named type. */
150 static const int width_bytes[] =
153 sizeof (char),
154 sizeof (short int),
155 sizeof (int),
156 sizeof (long int),
157 sizeof (unsigned_long_long_int),
158 sizeof (float),
159 sizeof (double),
160 sizeof (long double)
163 /* Ensure that for each member of 'enum size_spec' there is an
164 initializer in the width_bytes array. */
165 verify (ARRAY_CARDINALITY (width_bytes) == N_SIZE_SPECS);
167 /* Names for some non-printing characters. */
168 static char const charname[33][4] =
170 "nul", "soh", "stx", "etx", "eot", "enq", "ack", "bel",
171 "bs", "ht", "nl", "vt", "ff", "cr", "so", "si",
172 "dle", "dc1", "dc2", "dc3", "dc4", "nak", "syn", "etb",
173 "can", "em", "sub", "esc", "fs", "gs", "rs", "us",
174 "sp"
177 /* Address base (8, 10 or 16). */
178 static int address_base;
180 /* The number of octal digits required to represent the largest
181 address value. */
182 #define MAX_ADDRESS_LENGTH \
183 ((sizeof (uintmax_t) * CHAR_BIT + CHAR_BIT - 1) / 3)
185 /* Width of a normal address. */
186 static int address_pad_len;
188 /* Minimum length when detecting --strings. */
189 static size_t string_min;
191 /* True when in --strings mode. */
192 static bool flag_dump_strings;
194 /* True if we should recognize the older non-option arguments
195 that specified at most one file and optional arguments specifying
196 offset and pseudo-start address. */
197 static bool traditional;
199 /* True if an old-style 'pseudo-address' was specified. */
200 static bool flag_pseudo_start;
202 /* The difference between the old-style pseudo starting address and
203 the number of bytes to skip. */
204 static uintmax_t pseudo_offset;
206 /* Function that accepts an address and an optional following char,
207 and prints the address and char to stdout. */
208 static void (*format_address) (uintmax_t, char);
210 /* The number of input bytes to skip before formatting and writing. */
211 static uintmax_t n_bytes_to_skip = 0;
213 /* When false, MAX_BYTES_TO_FORMAT and END_OFFSET are ignored, and all
214 input is formatted. */
215 static bool limit_bytes_to_format = false;
217 /* The maximum number of bytes that will be formatted. */
218 static uintmax_t max_bytes_to_format;
220 /* The offset of the first byte after the last byte to be formatted. */
221 static uintmax_t end_offset;
223 /* When true and two or more consecutive blocks are equal, format
224 only the first block and output an asterisk alone on the following
225 line to indicate that identical blocks have been elided. */
226 static bool abbreviate_duplicate_blocks = true;
228 /* An array of specs describing how to format each input block. */
229 static struct tspec *spec;
231 /* The number of format specs. */
232 static size_t n_specs;
234 /* The allocated length of SPEC. */
235 static size_t n_specs_allocated;
237 /* The number of input bytes formatted per output line. It must be
238 a multiple of the least common multiple of the sizes associated with
239 the specified output types. It should be as large as possible, but
240 no larger than 16 -- unless specified with the -w option. */
241 static size_t bytes_per_block;
243 /* Human-readable representation of *file_list (for error messages).
244 It differs from file_list[-1] only when file_list[-1] is "-". */
245 static char const *input_filename;
247 /* A NULL-terminated list of the file-arguments from the command line. */
248 static char const *const *file_list;
250 /* Initializer for file_list if no file-arguments
251 were specified on the command line. */
252 static char const *const default_file_list[] = {"-", NULL};
254 /* The input stream associated with the current file. */
255 static FILE *in_stream;
257 /* If true, at least one of the files we read was standard input. */
258 static bool have_read_stdin;
260 /* Map the size in bytes to a type identifier. */
261 static enum size_spec integral_type_size[MAX_INTEGRAL_TYPE_SIZE + 1];
263 #define MAX_FP_TYPE_SIZE sizeof (long double)
264 static enum size_spec fp_type_size[MAX_FP_TYPE_SIZE + 1];
266 #ifndef WORDS_BIGENDIAN
267 # define WORDS_BIGENDIAN 0
268 #endif
270 /* Use native endianess by default. */
271 static bool input_swap;
273 static char const short_options[] = "A:aBbcDdeFfHhIij:LlN:OoS:st:vw::Xx";
275 /* For long options that have no equivalent short option, use a
276 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
277 enum
279 TRADITIONAL_OPTION = CHAR_MAX + 1,
280 ENDIAN_OPTION,
283 enum endian_type
285 endian_little,
286 endian_big
289 static char const *const endian_args[] =
291 "little", "big", NULL
294 static enum endian_type const endian_types[] =
296 endian_little, endian_big
299 static struct option const long_options[] =
301 {"skip-bytes", required_argument, NULL, 'j'},
302 {"address-radix", required_argument, NULL, 'A'},
303 {"read-bytes", required_argument, NULL, 'N'},
304 {"format", required_argument, NULL, 't'},
305 {"output-duplicates", no_argument, NULL, 'v'},
306 {"strings", optional_argument, NULL, 'S'},
307 {"traditional", no_argument, NULL, TRADITIONAL_OPTION},
308 {"width", optional_argument, NULL, 'w'},
309 {"endian", required_argument, NULL, ENDIAN_OPTION },
311 {GETOPT_HELP_OPTION_DECL},
312 {GETOPT_VERSION_OPTION_DECL},
313 {NULL, 0, NULL, 0}
316 void
317 usage (int status)
319 if (status != EXIT_SUCCESS)
320 emit_try_help ();
321 else
323 printf (_("\
324 Usage: %s [OPTION]... [FILE]...\n\
325 or: %s [-abcdfilosx]... [FILE] [[+]OFFSET[.][b]]\n\
326 or: %s --traditional [OPTION]... [FILE] [[+]OFFSET[.][b] [+][LABEL][.][b]]\n\
328 program_name, program_name, program_name);
329 fputs (_("\n\
330 Write an unambiguous representation, octal bytes by default,\n\
331 of FILE to standard output. With more than one FILE argument,\n\
332 concatenate them in the listed order to form the input.\n\
333 "), stdout);
335 emit_stdin_note ();
337 fputs (_("\
339 If first and second call formats both apply, the second format is assumed\n\
340 if the last operand begins with + or (if there are 2 operands) a digit.\n\
341 An OFFSET operand means -j OFFSET. LABEL is the pseudo-address\n\
342 at first byte printed, incremented when dump is progressing.\n\
343 For OFFSET and LABEL, a 0x or 0X prefix indicates hexadecimal;\n\
344 suffixes may be . for octal and b for multiply by 512.\n\
345 "), stdout);
347 emit_mandatory_arg_note ();
349 fputs (_("\
350 -A, --address-radix=RADIX output format for file offsets; RADIX is one\n\
351 of [doxn], for Decimal, Octal, Hex or None\n\
352 --endian={big|little} swap input bytes according the specified order\n\
353 -j, --skip-bytes=BYTES skip BYTES input bytes first\n\
354 "), stdout);
355 fputs (_("\
356 -N, --read-bytes=BYTES limit dump to BYTES input bytes\n\
357 -S BYTES, --strings[=BYTES] output strings of at least BYTES graphic chars;\
359 3 is implied when BYTES is not specified\n\
360 -t, --format=TYPE select output format or formats\n\
361 -v, --output-duplicates do not use * to mark line suppression\n\
362 -w[BYTES], --width[=BYTES] output BYTES bytes per output line;\n\
363 32 is implied when BYTES is not specified\n\
364 --traditional accept arguments in third form above\n\
365 "), stdout);
366 fputs (HELP_OPTION_DESCRIPTION, stdout);
367 fputs (VERSION_OPTION_DESCRIPTION, stdout);
368 fputs (_("\
371 Traditional format specifications may be intermixed; they accumulate:\n\
372 -a same as -t a, select named characters, ignoring high-order bit\n\
373 -b same as -t o1, select octal bytes\n\
374 -c same as -t c, select printable characters or backslash escapes\n\
375 -d same as -t u2, select unsigned decimal 2-byte units\n\
376 "), stdout);
377 fputs (_("\
378 -f same as -t fF, select floats\n\
379 -i same as -t dI, select decimal ints\n\
380 -l same as -t dL, select decimal longs\n\
381 -o same as -t o2, select octal 2-byte units\n\
382 -s same as -t d2, select decimal 2-byte units\n\
383 -x same as -t x2, select hexadecimal 2-byte units\n\
384 "), stdout);
385 fputs (_("\
388 TYPE is made up of one or more of these specifications:\n\
389 a named character, ignoring high-order bit\n\
390 c printable character or backslash escape\n\
391 "), stdout);
392 fputs (_("\
393 d[SIZE] signed decimal, SIZE bytes per integer\n\
394 f[SIZE] floating point, SIZE bytes per float\n\
395 o[SIZE] octal, SIZE bytes per integer\n\
396 u[SIZE] unsigned decimal, SIZE bytes per integer\n\
397 x[SIZE] hexadecimal, SIZE bytes per integer\n\
398 "), stdout);
399 fputs (_("\
401 SIZE is a number. For TYPE in [doux], SIZE may also be C for\n\
402 sizeof(char), S for sizeof(short), I for sizeof(int) or L for\n\
403 sizeof(long). If TYPE is f, SIZE may also be F for sizeof(float), D\n\
404 for sizeof(double) or L for sizeof(long double).\n\
405 "), stdout);
406 fputs (_("\
408 Adding a z suffix to any type displays printable characters at the end of\n\
409 each output line.\n\
410 "), stdout);
411 fputs (_("\
414 BYTES is hex with 0x or 0X prefix, and may have a multiplier suffix:\n\
415 b 512\n\
416 KB 1000\n\
417 K 1024\n\
418 MB 1000*1000\n\
419 M 1024*1024\n\
420 and so on for G, T, P, E, Z, Y.\n\
421 Binary prefixes can be used, too: KiB=K, MiB=M, and so on.\n\
422 "), stdout);
423 emit_ancillary_info (PROGRAM_NAME);
425 exit (status);
428 /* Define the print functions. */
430 #define PRINT_FIELDS(N, T, FMT_STRING_DECL, ACTION) \
431 static void \
432 N (size_t fields, size_t blank, void const *block, \
433 FMT_STRING_DECL, int width, int pad) \
435 T const *p = block; \
436 uintmax_t i; \
437 int pad_remaining = pad; \
438 for (i = fields; blank < i; i--) \
440 int next_pad = pad * (i - 1) / fields; \
441 int adjusted_width = pad_remaining - next_pad + width; \
442 T x; \
443 if (input_swap && sizeof (T) > 1) \
445 size_t j; \
446 union { \
447 T x; \
448 char b[sizeof (T)]; \
449 } u; \
450 for (j = 0; j < sizeof (T); j++) \
451 u.b[j] = ((char const *) p)[sizeof (T) - 1 - j]; \
452 x = u.x; \
454 else \
455 x = *p; \
456 p++; \
457 ACTION; \
458 pad_remaining = next_pad; \
462 #define PRINT_TYPE(N, T) \
463 PRINT_FIELDS (N, T, char const *fmt_string, \
464 xprintf (fmt_string, adjusted_width, x))
466 #define PRINT_FLOATTYPE(N, T, FTOASTR, BUFSIZE) \
467 PRINT_FIELDS (N, T, MAYBE_UNUSED char const *fmt_string, \
468 char buf[BUFSIZE]; \
469 FTOASTR (buf, sizeof buf, 0, 0, x); \
470 xprintf ("%*s", adjusted_width, buf))
472 PRINT_TYPE (print_s_char, signed char)
473 PRINT_TYPE (print_char, unsigned char)
474 PRINT_TYPE (print_s_short, short int)
475 PRINT_TYPE (print_short, unsigned short int)
476 PRINT_TYPE (print_int, unsigned int)
477 PRINT_TYPE (print_long, unsigned long int)
478 PRINT_TYPE (print_long_long, unsigned_long_long_int)
480 PRINT_FLOATTYPE (print_float, float, ftoastr, FLT_BUFSIZE_BOUND)
481 PRINT_FLOATTYPE (print_double, double, dtoastr, DBL_BUFSIZE_BOUND)
482 PRINT_FLOATTYPE (print_long_double, long double, ldtoastr, LDBL_BUFSIZE_BOUND)
484 #undef PRINT_TYPE
485 #undef PRINT_FLOATTYPE
487 static void
488 dump_hexl_mode_trailer (size_t n_bytes, char const *block)
490 fputs (" >", stdout);
491 for (size_t i = n_bytes; i > 0; i--)
493 unsigned char c = *block++;
494 unsigned char c2 = (isprint (c) ? c : '.');
495 putchar (c2);
497 putchar ('<');
500 static void
501 print_named_ascii (size_t fields, size_t blank, void const *block,
502 MAYBE_UNUSED char const *unused_fmt_string,
503 int width, int pad)
505 unsigned char const *p = block;
506 uintmax_t i;
507 int pad_remaining = pad;
508 for (i = fields; blank < i; i--)
510 int next_pad = pad * (i - 1) / fields;
511 int masked_c = *p++ & 0x7f;
512 char const *s;
513 char buf[2];
515 if (masked_c == 127)
516 s = "del";
517 else if (masked_c <= 040)
518 s = charname[masked_c];
519 else
521 buf[0] = masked_c;
522 buf[1] = 0;
523 s = buf;
526 xprintf ("%*s", pad_remaining - next_pad + width, s);
527 pad_remaining = next_pad;
531 static void
532 print_ascii (size_t fields, size_t blank, void const *block,
533 MAYBE_UNUSED char const *unused_fmt_string, int width,
534 int pad)
536 unsigned char const *p = block;
537 uintmax_t i;
538 int pad_remaining = pad;
539 for (i = fields; blank < i; i--)
541 int next_pad = pad * (i - 1) / fields;
542 unsigned char c = *p++;
543 char const *s;
544 char buf[4];
546 switch (c)
548 case '\0':
549 s = "\\0";
550 break;
552 case '\a':
553 s = "\\a";
554 break;
556 case '\b':
557 s = "\\b";
558 break;
560 case '\f':
561 s = "\\f";
562 break;
564 case '\n':
565 s = "\\n";
566 break;
568 case '\r':
569 s = "\\r";
570 break;
572 case '\t':
573 s = "\\t";
574 break;
576 case '\v':
577 s = "\\v";
578 break;
580 default:
581 sprintf (buf, (isprint (c) ? "%c" : "%03o"), c);
582 s = buf;
585 xprintf ("%*s", pad_remaining - next_pad + width, s);
586 pad_remaining = next_pad;
590 /* Convert a null-terminated (possibly zero-length) string S to an
591 unsigned long integer value. If S points to a non-digit set *P to S,
592 *VAL to 0, and return true. Otherwise, accumulate the integer value of
593 the string of digits. If the string of digits represents a value
594 larger than ULONG_MAX, don't modify *VAL or *P and return false.
595 Otherwise, advance *P to the first non-digit after S, set *VAL to
596 the result of the conversion and return true. */
598 static bool
599 simple_strtoul (char const *s, char const **p, unsigned long int *val)
601 unsigned long int sum;
603 sum = 0;
604 while (ISDIGIT (*s))
606 int c = *s++ - '0';
607 if (sum > (ULONG_MAX - c) / 10)
608 return false;
609 sum = sum * 10 + c;
611 *p = s;
612 *val = sum;
613 return true;
616 /* If S points to a single valid modern od format string, put
617 a description of that format in *TSPEC, make *NEXT point at the
618 character following the just-decoded format (if *NEXT is non-NULL),
619 and return true. If S is not valid, don't modify *NEXT or *TSPEC,
620 give a diagnostic, and return false. For example, if S were
621 "d4afL" *NEXT would be set to "afL" and *TSPEC would be
623 fmt = SIGNED_DECIMAL;
624 size = INT or LONG; (whichever integral_type_size[4] resolves to)
625 print_function = print_int; (assuming size == INT)
626 field_width = 11;
627 fmt_string = "%*d";
629 pad_width is determined later, but is at least as large as the
630 number of fields printed per row.
631 S_ORIG is solely for reporting errors. It should be the full format
632 string argument.
635 static bool
636 decode_one_format (char const *s_orig, char const *s, char const **next,
637 struct tspec *tspec)
639 enum size_spec size_spec;
640 unsigned long int size;
641 enum output_format fmt;
642 void (*print_function) (size_t, size_t, void const *, char const *,
643 int, int);
644 char const *p;
645 char c;
646 int field_width;
648 assert (tspec != NULL);
650 switch (*s)
652 case 'd':
653 case 'o':
654 case 'u':
655 case 'x':
656 c = *s;
657 ++s;
658 switch (*s)
660 case 'C':
661 ++s;
662 size = sizeof (char);
663 break;
665 case 'S':
666 ++s;
667 size = sizeof (short int);
668 break;
670 case 'I':
671 ++s;
672 size = sizeof (int);
673 break;
675 case 'L':
676 ++s;
677 size = sizeof (long int);
678 break;
680 default:
681 if (! simple_strtoul (s, &p, &size))
683 /* The integer at P in S would overflow an unsigned long int.
684 A digit string that long is sufficiently odd looking
685 that the following diagnostic is sufficient. */
686 error (0, 0, _("invalid type string %s"), quote (s_orig));
687 return false;
689 if (p == s)
690 size = sizeof (int);
691 else
693 if (MAX_INTEGRAL_TYPE_SIZE < size
694 || integral_type_size[size] == NO_SIZE)
696 error (0, 0, _("invalid type string %s;\nthis system"
697 " doesn't provide a %lu-byte integral type"),
698 quote (s_orig), size);
699 return false;
701 s = p;
703 break;
706 #define ISPEC_TO_FORMAT(Spec, Min_format, Long_format, Max_format) \
707 ((Spec) == LONG_LONG ? (Max_format) \
708 : ((Spec) == LONG ? (Long_format) \
709 : (Min_format))) \
711 size_spec = integral_type_size[size];
713 switch (c)
715 case 'd':
716 fmt = SIGNED_DECIMAL;
717 field_width = bytes_to_signed_dec_digits[size];
718 sprintf (tspec->fmt_string, "%%*%s",
719 ISPEC_TO_FORMAT (size_spec, "d", "ld", PRIdMAX));
720 break;
722 case 'o':
723 fmt = OCTAL;
724 sprintf (tspec->fmt_string, "%%*.%d%s",
725 (field_width = bytes_to_oct_digits[size]),
726 ISPEC_TO_FORMAT (size_spec, "o", "lo", PRIoMAX));
727 break;
729 case 'u':
730 fmt = UNSIGNED_DECIMAL;
731 field_width = bytes_to_unsigned_dec_digits[size];
732 sprintf (tspec->fmt_string, "%%*%s",
733 ISPEC_TO_FORMAT (size_spec, "u", "lu", PRIuMAX));
734 break;
736 case 'x':
737 fmt = HEXADECIMAL;
738 sprintf (tspec->fmt_string, "%%*.%d%s",
739 (field_width = bytes_to_hex_digits[size]),
740 ISPEC_TO_FORMAT (size_spec, "x", "lx", PRIxMAX));
741 break;
743 default:
744 abort ();
747 assert (strlen (tspec->fmt_string) < FMT_BYTES_ALLOCATED);
749 switch (size_spec)
751 case CHAR:
752 print_function = (fmt == SIGNED_DECIMAL
753 ? print_s_char
754 : print_char);
755 break;
757 case SHORT:
758 print_function = (fmt == SIGNED_DECIMAL
759 ? print_s_short
760 : print_short);
761 break;
763 case INT:
764 print_function = print_int;
765 break;
767 case LONG:
768 print_function = print_long;
769 break;
771 case LONG_LONG:
772 print_function = print_long_long;
773 break;
775 default:
776 abort ();
778 break;
780 case 'f':
781 fmt = FLOATING_POINT;
782 ++s;
783 switch (*s)
785 case 'F':
786 ++s;
787 size = sizeof (float);
788 break;
790 case 'D':
791 ++s;
792 size = sizeof (double);
793 break;
795 case 'L':
796 ++s;
797 size = sizeof (long double);
798 break;
800 default:
801 if (! simple_strtoul (s, &p, &size))
803 /* The integer at P in S would overflow an unsigned long int.
804 A digit string that long is sufficiently odd looking
805 that the following diagnostic is sufficient. */
806 error (0, 0, _("invalid type string %s"), quote (s_orig));
807 return false;
809 if (p == s)
810 size = sizeof (double);
811 else
813 if (size > MAX_FP_TYPE_SIZE
814 || fp_type_size[size] == NO_SIZE)
816 error (0, 0,
817 _("invalid type string %s;\n"
818 "this system doesn't provide a %lu-byte"
819 " floating point type"),
820 quote (s_orig), size);
821 return false;
823 s = p;
825 break;
827 size_spec = fp_type_size[size];
830 struct lconv const *locale = localeconv ();
831 size_t decimal_point_len =
832 (locale->decimal_point[0] ? strlen (locale->decimal_point) : 1);
834 switch (size_spec)
836 case FLOAT_SINGLE:
837 print_function = print_float;
838 field_width = FLT_STRLEN_BOUND_L (decimal_point_len);
839 break;
841 case FLOAT_DOUBLE:
842 print_function = print_double;
843 field_width = DBL_STRLEN_BOUND_L (decimal_point_len);
844 break;
846 case FLOAT_LONG_DOUBLE:
847 print_function = print_long_double;
848 field_width = LDBL_STRLEN_BOUND_L (decimal_point_len);
849 break;
851 default:
852 abort ();
855 break;
858 case 'a':
859 ++s;
860 fmt = NAMED_CHARACTER;
861 size_spec = CHAR;
862 print_function = print_named_ascii;
863 field_width = 3;
864 break;
866 case 'c':
867 ++s;
868 fmt = CHARACTER;
869 size_spec = CHAR;
870 print_function = print_ascii;
871 field_width = 3;
872 break;
874 default:
875 error (0, 0, _("invalid character '%c' in type string %s"),
876 *s, quote (s_orig));
877 return false;
880 tspec->size = size_spec;
881 tspec->fmt = fmt;
882 tspec->print_function = print_function;
884 tspec->field_width = field_width;
885 tspec->hexl_mode_trailer = (*s == 'z');
886 if (tspec->hexl_mode_trailer)
887 s++;
889 if (next != NULL)
890 *next = s;
892 return true;
895 /* Given a list of one or more input filenames FILE_LIST, set the global
896 file pointer IN_STREAM and the global string INPUT_FILENAME to the
897 first one that can be successfully opened. Modify FILE_LIST to
898 reference the next filename in the list. A file name of "-" is
899 interpreted as standard input. If any file open fails, give an error
900 message and return false. */
902 static bool
903 open_next_file (void)
905 bool ok = true;
909 input_filename = *file_list;
910 if (input_filename == NULL)
911 return ok;
912 ++file_list;
914 if (STREQ (input_filename, "-"))
916 input_filename = _("standard input");
917 in_stream = stdin;
918 have_read_stdin = true;
919 xset_binary_mode (STDIN_FILENO, O_BINARY);
921 else
923 in_stream = fopen (input_filename, (O_BINARY ? "rb" : "r"));
924 if (in_stream == NULL)
926 error (0, errno, "%s", quotef (input_filename));
927 ok = false;
931 while (in_stream == NULL);
933 if (limit_bytes_to_format && !flag_dump_strings)
934 setvbuf (in_stream, NULL, _IONBF, 0);
936 return ok;
939 /* Test whether there have been errors on in_stream, and close it if
940 it is not standard input. Return false if there has been an error
941 on in_stream or stdout; return true otherwise. This function will
942 report more than one error only if both a read and a write error
943 have occurred. IN_ERRNO, if nonzero, is the error number
944 corresponding to the most recent action for IN_STREAM. */
946 static bool
947 check_and_close (int in_errno)
949 bool ok = true;
951 if (in_stream != NULL)
953 if (!ferror (in_stream))
954 in_errno = 0;
955 if (STREQ (file_list[-1], "-"))
956 clearerr (in_stream);
957 else if (fclose (in_stream) != 0 && !in_errno)
958 in_errno = errno;
959 if (in_errno)
961 error (0, in_errno, "%s", quotef (input_filename));
962 ok = false;
965 in_stream = NULL;
968 if (ferror (stdout))
970 error (0, 0, _("write error"));
971 ok = false;
974 return ok;
977 /* Decode the modern od format string S. Append the decoded
978 representation to the global array SPEC, reallocating SPEC if
979 necessary. Return true if S is valid. */
981 static bool
982 decode_format_string (char const *s)
984 char const *s_orig = s;
985 assert (s != NULL);
987 while (*s != '\0')
989 char const *next;
991 if (n_specs_allocated <= n_specs)
992 spec = X2NREALLOC (spec, &n_specs_allocated);
994 if (! decode_one_format (s_orig, s, &next, &spec[n_specs]))
995 return false;
997 assert (s != next);
998 s = next;
999 ++n_specs;
1002 return true;
1005 /* Given a list of one or more input filenames FILE_LIST, set the global
1006 file pointer IN_STREAM to position N_SKIP in the concatenation of
1007 those files. If any file operation fails or if there are fewer than
1008 N_SKIP bytes in the combined input, give an error message and return
1009 false. When possible, use seek rather than read operations to
1010 advance IN_STREAM. */
1012 static bool
1013 skip (uintmax_t n_skip)
1015 bool ok = true;
1016 int in_errno = 0;
1018 if (n_skip == 0)
1019 return true;
1021 while (in_stream != NULL) /* EOF. */
1023 struct stat file_stats;
1025 /* First try seeking. For large offsets, this extra work is
1026 worthwhile. If the offset is below some threshold it may be
1027 more efficient to move the pointer by reading. There are two
1028 issues when trying to seek:
1029 - the file must be seekable.
1030 - before seeking to the specified position, make sure
1031 that the new position is in the current file.
1032 Try to do that by getting file's size using fstat.
1033 But that will work only for regular files. */
1035 if (fstat (fileno (in_stream), &file_stats) == 0)
1037 bool usable_size = usable_st_size (&file_stats);
1039 /* The st_size field is valid for regular files.
1040 If the number of bytes left to skip is larger than
1041 the size of the current file, we can decrement n_skip
1042 and go on to the next file. Skip this optimization also
1043 when st_size is no greater than the block size, because
1044 some kernels report nonsense small file sizes for
1045 proc-like file systems. */
1046 if (usable_size && ST_BLKSIZE (file_stats) < file_stats.st_size)
1048 if ((uintmax_t) file_stats.st_size < n_skip)
1049 n_skip -= file_stats.st_size;
1050 else
1052 if (fseeko (in_stream, n_skip, SEEK_CUR) != 0)
1054 in_errno = errno;
1055 ok = false;
1057 n_skip = 0;
1061 else if (!usable_size && fseeko (in_stream, n_skip, SEEK_CUR) == 0)
1062 n_skip = 0;
1064 /* If it's not a regular file with nonnegative size,
1065 or if it's so small that it might be in a proc-like file system,
1066 position the file pointer by reading. */
1068 else
1070 char buf[BUFSIZ];
1071 size_t n_bytes_read, n_bytes_to_read = BUFSIZ;
1073 while (0 < n_skip)
1075 if (n_skip < n_bytes_to_read)
1076 n_bytes_to_read = n_skip;
1077 n_bytes_read = fread (buf, 1, n_bytes_to_read, in_stream);
1078 n_skip -= n_bytes_read;
1079 if (n_bytes_read != n_bytes_to_read)
1081 if (ferror (in_stream))
1083 in_errno = errno;
1084 ok = false;
1085 n_skip = 0;
1086 break;
1088 if (feof (in_stream))
1089 break;
1094 if (n_skip == 0)
1095 break;
1098 else /* cannot fstat() file */
1100 error (0, errno, "%s", quotef (input_filename));
1101 ok = false;
1104 ok &= check_and_close (in_errno);
1106 ok &= open_next_file ();
1109 if (n_skip != 0)
1110 die (EXIT_FAILURE, 0, _("cannot skip past end of combined input"));
1112 return ok;
1115 static void
1116 format_address_none (MAYBE_UNUSED uintmax_t address,
1117 MAYBE_UNUSED char c)
1121 static void
1122 format_address_std (uintmax_t address, char c)
1124 char buf[MAX_ADDRESS_LENGTH + 2];
1125 char *p = buf + sizeof buf;
1126 char const *pbound;
1128 *--p = '\0';
1129 *--p = c;
1130 pbound = p - address_pad_len;
1132 /* Use a special case of the code for each base. This is measurably
1133 faster than generic code. */
1134 switch (address_base)
1136 case 8:
1138 *--p = '0' + (address & 7);
1139 while ((address >>= 3) != 0);
1140 break;
1142 case 10:
1144 *--p = '0' + (address % 10);
1145 while ((address /= 10) != 0);
1146 break;
1148 case 16:
1150 *--p = "0123456789abcdef"[address & 15];
1151 while ((address >>= 4) != 0);
1152 break;
1155 while (pbound < p)
1156 *--p = '0';
1158 fputs (p, stdout);
1161 static void
1162 format_address_paren (uintmax_t address, char c)
1164 putchar ('(');
1165 format_address_std (address, ')');
1166 if (c)
1167 putchar (c);
1170 static void
1171 format_address_label (uintmax_t address, char c)
1173 format_address_std (address, ' ');
1174 format_address_paren (address + pseudo_offset, c);
1177 /* Write N_BYTES bytes from CURR_BLOCK to standard output once for each
1178 of the N_SPEC format specs. CURRENT_OFFSET is the byte address of
1179 CURR_BLOCK in the concatenation of input files, and it is printed
1180 (optionally) only before the output line associated with the first
1181 format spec. When duplicate blocks are being abbreviated, the output
1182 for a sequence of identical input blocks is the output for the first
1183 block followed by an asterisk alone on a line. It is valid to compare
1184 the blocks PREV_BLOCK and CURR_BLOCK only when N_BYTES == BYTES_PER_BLOCK.
1185 That condition may be false only for the last input block. */
1187 static void
1188 write_block (uintmax_t current_offset, size_t n_bytes,
1189 char const *prev_block, char const *curr_block)
1191 static bool first = true;
1192 static bool prev_pair_equal = false;
1194 #define EQUAL_BLOCKS(b1, b2) (memcmp (b1, b2, bytes_per_block) == 0)
1196 if (abbreviate_duplicate_blocks
1197 && !first && n_bytes == bytes_per_block
1198 && EQUAL_BLOCKS (prev_block, curr_block))
1200 if (prev_pair_equal)
1202 /* The two preceding blocks were equal, and the current
1203 block is the same as the last one, so print nothing. */
1205 else
1207 printf ("*\n");
1208 prev_pair_equal = true;
1211 else
1213 prev_pair_equal = false;
1214 for (size_t i = 0; i < n_specs; i++)
1216 int datum_width = width_bytes[spec[i].size];
1217 int fields_per_block = bytes_per_block / datum_width;
1218 int blank_fields = (bytes_per_block - n_bytes) / datum_width;
1219 if (i == 0)
1220 format_address (current_offset, '\0');
1221 else
1222 printf ("%*s", address_pad_len, "");
1223 (*spec[i].print_function) (fields_per_block, blank_fields,
1224 curr_block, spec[i].fmt_string,
1225 spec[i].field_width, spec[i].pad_width);
1226 if (spec[i].hexl_mode_trailer)
1228 /* space-pad out to full line width, then dump the trailer */
1229 int field_width = spec[i].field_width;
1230 int pad_width = (spec[i].pad_width * blank_fields
1231 / fields_per_block);
1232 printf ("%*s", blank_fields * field_width + pad_width, "");
1233 dump_hexl_mode_trailer (n_bytes, curr_block);
1235 putchar ('\n');
1238 first = false;
1241 /* Read a single byte into *C from the concatenation of the input files
1242 named in the global array FILE_LIST. On the first call to this
1243 function, the global variable IN_STREAM is expected to be an open
1244 stream associated with the input file INPUT_FILENAME. If IN_STREAM
1245 is at end-of-file, close it and update the global variables IN_STREAM
1246 and INPUT_FILENAME so they correspond to the next file in the list.
1247 Then try to read a byte from the newly opened file. Repeat if
1248 necessary until EOF is reached for the last file in FILE_LIST, then
1249 set *C to EOF and return. Subsequent calls do likewise. Return
1250 true if successful. */
1252 static bool
1253 read_char (int *c)
1255 bool ok = true;
1257 *c = EOF;
1259 while (in_stream != NULL) /* EOF. */
1261 *c = fgetc (in_stream);
1263 if (*c != EOF)
1264 break;
1266 ok &= check_and_close (errno);
1268 ok &= open_next_file ();
1271 return ok;
1274 /* Read N bytes into BLOCK from the concatenation of the input files
1275 named in the global array FILE_LIST. On the first call to this
1276 function, the global variable IN_STREAM is expected to be an open
1277 stream associated with the input file INPUT_FILENAME. If all N
1278 bytes cannot be read from IN_STREAM, close IN_STREAM and update
1279 the global variables IN_STREAM and INPUT_FILENAME. Then try to
1280 read the remaining bytes from the newly opened file. Repeat if
1281 necessary until EOF is reached for the last file in FILE_LIST.
1282 On subsequent calls, don't modify BLOCK and return true. Set
1283 *N_BYTES_IN_BUFFER to the number of bytes read. If an error occurs,
1284 it will be detected through ferror when the stream is about to be
1285 closed. If there is an error, give a message but continue reading
1286 as usual and return false. Otherwise return true. */
1288 static bool
1289 read_block (size_t n, char *block, size_t *n_bytes_in_buffer)
1291 bool ok = true;
1293 assert (0 < n && n <= bytes_per_block);
1295 *n_bytes_in_buffer = 0;
1297 while (in_stream != NULL) /* EOF. */
1299 size_t n_needed;
1300 size_t n_read;
1302 n_needed = n - *n_bytes_in_buffer;
1303 n_read = fread (block + *n_bytes_in_buffer, 1, n_needed, in_stream);
1305 *n_bytes_in_buffer += n_read;
1307 if (n_read == n_needed)
1308 break;
1310 ok &= check_and_close (errno);
1312 ok &= open_next_file ();
1315 return ok;
1318 /* Return the least common multiple of the sizes associated
1319 with the format specs. */
1321 ATTRIBUTE_PURE
1322 static int
1323 get_lcm (void)
1325 int l_c_m = 1;
1327 for (size_t i = 0; i < n_specs; i++)
1328 l_c_m = lcm (l_c_m, width_bytes[spec[i].size]);
1329 return l_c_m;
1332 /* If S is a valid traditional offset specification with an optional
1333 leading '+' return true and set *OFFSET to the offset it denotes. */
1335 static bool
1336 parse_old_offset (char const *s, uintmax_t *offset)
1338 int radix;
1340 if (*s == '\0')
1341 return false;
1343 /* Skip over any leading '+'. */
1344 if (s[0] == '+')
1345 ++s;
1347 /* Determine the radix we'll use to interpret S. If there is a '.',
1348 it's decimal, otherwise, if the string begins with '0X'or '0x',
1349 it's hexadecimal, else octal. */
1350 if (strchr (s, '.') != NULL)
1351 radix = 10;
1352 else
1354 if (s[0] == '0' && (s[1] == 'x' || s[1] == 'X'))
1355 radix = 16;
1356 else
1357 radix = 8;
1360 return xstrtoumax (s, NULL, radix, offset, "Bb") == LONGINT_OK;
1363 /* Read a chunk of size BYTES_PER_BLOCK from the input files, write the
1364 formatted block to standard output, and repeat until the specified
1365 maximum number of bytes has been read or until all input has been
1366 processed. If the last block read is smaller than BYTES_PER_BLOCK
1367 and its size is not a multiple of the size associated with a format
1368 spec, extend the input block with zero bytes until its length is a
1369 multiple of all format spec sizes. Write the final block. Finally,
1370 write on a line by itself the offset of the byte after the last byte
1371 read. Accumulate return values from calls to read_block and
1372 check_and_close, and if any was false, return false.
1373 Otherwise, return true. */
1375 static bool
1376 dump (void)
1378 char *block[2];
1379 uintmax_t current_offset;
1380 bool idx = false;
1381 bool ok = true;
1382 size_t n_bytes_read;
1384 block[0] = xnmalloc (2, bytes_per_block);
1385 block[1] = block[0] + bytes_per_block;
1387 current_offset = n_bytes_to_skip;
1389 if (limit_bytes_to_format)
1391 while (true)
1393 size_t n_needed;
1394 if (current_offset >= end_offset)
1396 n_bytes_read = 0;
1397 break;
1399 n_needed = MIN (end_offset - current_offset,
1400 (uintmax_t) bytes_per_block);
1401 ok &= read_block (n_needed, block[idx], &n_bytes_read);
1402 if (n_bytes_read < bytes_per_block)
1403 break;
1404 assert (n_bytes_read == bytes_per_block);
1405 write_block (current_offset, n_bytes_read,
1406 block[!idx], block[idx]);
1407 current_offset += n_bytes_read;
1408 idx = !idx;
1411 else
1413 while (true)
1415 ok &= read_block (bytes_per_block, block[idx], &n_bytes_read);
1416 if (n_bytes_read < bytes_per_block)
1417 break;
1418 assert (n_bytes_read == bytes_per_block);
1419 write_block (current_offset, n_bytes_read,
1420 block[!idx], block[idx]);
1421 current_offset += n_bytes_read;
1422 idx = !idx;
1426 if (n_bytes_read > 0)
1428 int l_c_m;
1429 size_t bytes_to_write;
1431 l_c_m = get_lcm ();
1433 /* Ensure zero-byte padding up to the smallest multiple of l_c_m that
1434 is at least as large as n_bytes_read. */
1435 bytes_to_write = l_c_m * ((n_bytes_read + l_c_m - 1) / l_c_m);
1437 memset (block[idx] + n_bytes_read, 0, bytes_to_write - n_bytes_read);
1438 write_block (current_offset, n_bytes_read, block[!idx], block[idx]);
1439 current_offset += n_bytes_read;
1442 format_address (current_offset, '\n');
1444 if (limit_bytes_to_format && current_offset >= end_offset)
1445 ok &= check_and_close (0);
1447 free (block[0]);
1449 return ok;
1452 /* STRINGS mode. Find each "string constant" in the input.
1453 A string constant is a run of at least 'string_min' ASCII
1454 graphic (or formatting) characters terminated by a null.
1455 Based on a function written by Richard Stallman for a
1456 traditional version of od. Return true if successful. */
1458 static bool
1459 dump_strings (void)
1461 size_t bufsize = MAX (100, string_min);
1462 char *buf = xmalloc (bufsize);
1463 uintmax_t address = n_bytes_to_skip;
1464 bool ok = true;
1466 while (true)
1468 size_t i;
1469 int c;
1471 /* See if the next 'string_min' chars are all printing chars. */
1472 tryline:
1474 if (limit_bytes_to_format
1475 && (end_offset < string_min || end_offset - string_min <= address))
1476 break;
1478 for (i = 0; i < string_min; i++)
1480 ok &= read_char (&c);
1481 address++;
1482 if (c < 0)
1484 free (buf);
1485 return ok;
1487 if (! isprint (c))
1488 /* Found a non-printing. Try again starting with next char. */
1489 goto tryline;
1490 buf[i] = c;
1493 /* We found a run of 'string_min' printable characters.
1494 Now see if it is terminated with a null byte. */
1495 while (!limit_bytes_to_format || address < end_offset)
1497 if (i == bufsize)
1499 buf = X2REALLOC (buf, &bufsize);
1501 ok &= read_char (&c);
1502 address++;
1503 if (c < 0)
1505 free (buf);
1506 return ok;
1508 if (c == '\0')
1509 break; /* It is; print this string. */
1510 if (! isprint (c))
1511 goto tryline; /* It isn't; give up on this string. */
1512 buf[i++] = c; /* String continues; store it all. */
1515 /* If we get here, the string is all printable and null-terminated,
1516 so print it. It is all in 'buf' and 'i' is its length. */
1517 buf[i] = 0;
1518 format_address (address - i - 1, ' ');
1520 for (i = 0; (c = buf[i]); i++)
1522 switch (c)
1524 case '\a':
1525 fputs ("\\a", stdout);
1526 break;
1528 case '\b':
1529 fputs ("\\b", stdout);
1530 break;
1532 case '\f':
1533 fputs ("\\f", stdout);
1534 break;
1536 case '\n':
1537 fputs ("\\n", stdout);
1538 break;
1540 case '\r':
1541 fputs ("\\r", stdout);
1542 break;
1544 case '\t':
1545 fputs ("\\t", stdout);
1546 break;
1548 case '\v':
1549 fputs ("\\v", stdout);
1550 break;
1552 default:
1553 putc (c, stdout);
1556 putchar ('\n');
1559 /* We reach this point only if we search through
1560 (max_bytes_to_format - string_min) bytes before reaching EOF. */
1562 free (buf);
1564 ok &= check_and_close (0);
1565 return ok;
1569 main (int argc, char **argv)
1571 int n_files;
1572 size_t i;
1573 int l_c_m;
1574 size_t desired_width IF_LINT ( = 0);
1575 bool modern = false;
1576 bool width_specified = false;
1577 bool ok = true;
1578 size_t width_per_block = 0;
1579 static char const multipliers[] = "bEGKkMmPTYZ0";
1581 /* The old-style 'pseudo starting address' to be printed in parentheses
1582 after any true address. */
1583 uintmax_t pseudo_start IF_LINT ( = 0);
1585 initialize_main (&argc, &argv);
1586 set_program_name (argv[0]);
1587 setlocale (LC_ALL, "");
1588 bindtextdomain (PACKAGE, LOCALEDIR);
1589 textdomain (PACKAGE);
1591 atexit (close_stdout);
1593 for (i = 0; i <= MAX_INTEGRAL_TYPE_SIZE; i++)
1594 integral_type_size[i] = NO_SIZE;
1596 integral_type_size[sizeof (char)] = CHAR;
1597 integral_type_size[sizeof (short int)] = SHORT;
1598 integral_type_size[sizeof (int)] = INT;
1599 integral_type_size[sizeof (long int)] = LONG;
1600 #if HAVE_UNSIGNED_LONG_LONG_INT
1601 /* If 'long int' and 'long long int' have the same size, it's fine
1602 to overwrite the entry for 'long' with this one. */
1603 integral_type_size[sizeof (unsigned_long_long_int)] = LONG_LONG;
1604 #endif
1606 for (i = 0; i <= MAX_FP_TYPE_SIZE; i++)
1607 fp_type_size[i] = NO_SIZE;
1609 fp_type_size[sizeof (float)] = FLOAT_SINGLE;
1610 /* The array entry for 'double' is filled in after that for 'long double'
1611 so that if they are the same size, we avoid any overhead of
1612 long double computation in libc. */
1613 fp_type_size[sizeof (long double)] = FLOAT_LONG_DOUBLE;
1614 fp_type_size[sizeof (double)] = FLOAT_DOUBLE;
1616 n_specs = 0;
1617 n_specs_allocated = 0;
1618 spec = NULL;
1620 format_address = format_address_std;
1621 address_base = 8;
1622 address_pad_len = 7;
1623 flag_dump_strings = false;
1625 while (true)
1627 uintmax_t tmp;
1628 enum strtol_error s_err;
1629 int oi = -1;
1630 int c = getopt_long (argc, argv, short_options, long_options, &oi);
1631 if (c == -1)
1632 break;
1634 switch (c)
1636 case 'A':
1637 modern = true;
1638 switch (optarg[0])
1640 case 'd':
1641 format_address = format_address_std;
1642 address_base = 10;
1643 address_pad_len = 7;
1644 break;
1645 case 'o':
1646 format_address = format_address_std;
1647 address_base = 8;
1648 address_pad_len = 7;
1649 break;
1650 case 'x':
1651 format_address = format_address_std;
1652 address_base = 16;
1653 address_pad_len = 6;
1654 break;
1655 case 'n':
1656 format_address = format_address_none;
1657 address_pad_len = 0;
1658 break;
1659 default:
1660 die (EXIT_FAILURE, 0,
1661 _("invalid output address radix '%c';\
1662 it must be one character from [doxn]"),
1663 optarg[0]);
1664 break;
1666 break;
1668 case 'j':
1669 modern = true;
1670 s_err = xstrtoumax (optarg, NULL, 0, &n_bytes_to_skip, multipliers);
1671 if (s_err != LONGINT_OK)
1672 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1673 break;
1675 case 'N':
1676 modern = true;
1677 limit_bytes_to_format = true;
1679 s_err = xstrtoumax (optarg, NULL, 0, &max_bytes_to_format,
1680 multipliers);
1681 if (s_err != LONGINT_OK)
1682 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1683 break;
1685 case 'S':
1686 modern = true;
1687 if (optarg == NULL)
1688 string_min = 3;
1689 else
1691 s_err = xstrtoumax (optarg, NULL, 0, &tmp, multipliers);
1692 if (s_err != LONGINT_OK)
1693 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1695 /* The minimum string length may be no larger than SIZE_MAX,
1696 since we may allocate a buffer of this size. */
1697 if (SIZE_MAX < tmp)
1698 die (EXIT_FAILURE, 0, _("%s is too large"), quote (optarg));
1700 string_min = tmp;
1702 flag_dump_strings = true;
1703 break;
1705 case 't':
1706 modern = true;
1707 ok &= decode_format_string (optarg);
1708 break;
1710 case 'v':
1711 modern = true;
1712 abbreviate_duplicate_blocks = false;
1713 break;
1715 case TRADITIONAL_OPTION:
1716 traditional = true;
1717 break;
1719 case ENDIAN_OPTION:
1720 switch (XARGMATCH ("--endian", optarg, endian_args, endian_types))
1722 case endian_big:
1723 input_swap = ! WORDS_BIGENDIAN;
1724 break;
1725 case endian_little:
1726 input_swap = WORDS_BIGENDIAN;
1727 break;
1729 break;
1731 /* The next several cases map the traditional format
1732 specification options to the corresponding modern format
1733 specs. GNU od accepts any combination of old- and
1734 new-style options. Format specification options accumulate.
1735 The obsolescent and undocumented formats are compatible
1736 with FreeBSD 4.10 od. */
1738 #define CASE_OLD_ARG(old_char,new_string) \
1739 case old_char: \
1740 ok &= decode_format_string (new_string); \
1741 break
1743 CASE_OLD_ARG ('a', "a");
1744 CASE_OLD_ARG ('b', "o1");
1745 CASE_OLD_ARG ('c', "c");
1746 CASE_OLD_ARG ('D', "u4"); /* obsolescent and undocumented */
1747 CASE_OLD_ARG ('d', "u2");
1748 case 'F': /* obsolescent and undocumented alias */
1749 CASE_OLD_ARG ('e', "fD"); /* obsolescent and undocumented */
1750 CASE_OLD_ARG ('f', "fF");
1751 case 'X': /* obsolescent and undocumented alias */
1752 CASE_OLD_ARG ('H', "x4"); /* obsolescent and undocumented */
1753 CASE_OLD_ARG ('i', "dI");
1754 case 'I': case 'L': /* obsolescent and undocumented aliases */
1755 CASE_OLD_ARG ('l', "dL");
1756 CASE_OLD_ARG ('O', "o4"); /* obsolesent and undocumented */
1757 case 'B': /* obsolescent and undocumented alias */
1758 CASE_OLD_ARG ('o', "o2");
1759 CASE_OLD_ARG ('s', "d2");
1760 case 'h': /* obsolescent and undocumented alias */
1761 CASE_OLD_ARG ('x', "x2");
1763 #undef CASE_OLD_ARG
1765 case 'w':
1766 modern = true;
1767 width_specified = true;
1768 if (optarg == NULL)
1770 desired_width = 32;
1772 else
1774 uintmax_t w_tmp;
1775 s_err = xstrtoumax (optarg, NULL, 10, &w_tmp, "");
1776 if (s_err != LONGINT_OK)
1777 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1778 if (SIZE_MAX < w_tmp)
1779 die (EXIT_FAILURE, 0, _("%s is too large"), quote (optarg));
1780 desired_width = w_tmp;
1782 break;
1784 case_GETOPT_HELP_CHAR;
1786 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1788 default:
1789 usage (EXIT_FAILURE);
1790 break;
1794 if (!ok)
1795 return EXIT_FAILURE;
1797 if (flag_dump_strings && n_specs > 0)
1798 die (EXIT_FAILURE, 0,
1799 _("no type may be specified when dumping strings"));
1801 n_files = argc - optind;
1803 /* If the --traditional option is used, there may be from
1804 0 to 3 remaining command line arguments; handle each case
1805 separately.
1806 od [file] [[+]offset[.][b] [[+]label[.][b]]]
1807 The offset and label have the same syntax.
1809 If --traditional is not given, and if no modern options are
1810 given, and if the offset begins with + or (if there are two
1811 operands) a digit, accept only this form, as per POSIX:
1812 od [file] [[+]offset[.][b]]
1815 if (!modern || traditional)
1817 uintmax_t o1;
1818 uintmax_t o2;
1820 switch (n_files)
1822 case 1:
1823 if ((traditional || argv[optind][0] == '+')
1824 && parse_old_offset (argv[optind], &o1))
1826 n_bytes_to_skip = o1;
1827 --n_files;
1828 ++argv;
1830 break;
1832 case 2:
1833 if ((traditional || argv[optind + 1][0] == '+'
1834 || ISDIGIT (argv[optind + 1][0]))
1835 && parse_old_offset (argv[optind + 1], &o2))
1837 if (traditional && parse_old_offset (argv[optind], &o1))
1839 n_bytes_to_skip = o1;
1840 flag_pseudo_start = true;
1841 pseudo_start = o2;
1842 argv += 2;
1843 n_files -= 2;
1845 else
1847 n_bytes_to_skip = o2;
1848 --n_files;
1849 argv[optind + 1] = argv[optind];
1850 ++argv;
1853 break;
1855 case 3:
1856 if (traditional
1857 && parse_old_offset (argv[optind + 1], &o1)
1858 && parse_old_offset (argv[optind + 2], &o2))
1860 n_bytes_to_skip = o1;
1861 flag_pseudo_start = true;
1862 pseudo_start = o2;
1863 argv[optind + 2] = argv[optind];
1864 argv += 2;
1865 n_files -= 2;
1867 break;
1870 if (traditional && 1 < n_files)
1872 error (0, 0, _("extra operand %s"), quote (argv[optind + 1]));
1873 error (0, 0, "%s",
1874 _("compatibility mode supports at most one file"));
1875 usage (EXIT_FAILURE);
1879 if (flag_pseudo_start)
1881 if (format_address == format_address_none)
1883 address_base = 8;
1884 address_pad_len = 7;
1885 format_address = format_address_paren;
1887 else
1888 format_address = format_address_label;
1891 if (limit_bytes_to_format)
1893 end_offset = n_bytes_to_skip + max_bytes_to_format;
1894 if (end_offset < n_bytes_to_skip)
1895 die (EXIT_FAILURE, 0, _("skip-bytes + read-bytes is too large"));
1898 if (n_specs == 0)
1899 decode_format_string ("oS");
1901 if (n_files > 0)
1903 /* Set the global pointer FILE_LIST so that it
1904 references the first file-argument on the command-line. */
1906 file_list = (char const *const *) &argv[optind];
1908 else
1910 /* No files were listed on the command line.
1911 Set the global pointer FILE_LIST so that it
1912 references the null-terminated list of one name: "-". */
1914 file_list = default_file_list;
1917 /* open the first input file */
1918 ok = open_next_file ();
1919 if (in_stream == NULL)
1920 goto cleanup;
1922 /* skip over any unwanted header bytes */
1923 ok &= skip (n_bytes_to_skip);
1924 if (in_stream == NULL)
1925 goto cleanup;
1927 pseudo_offset = (flag_pseudo_start ? pseudo_start - n_bytes_to_skip : 0);
1929 /* Compute output block length. */
1930 l_c_m = get_lcm ();
1932 if (width_specified)
1934 if (desired_width != 0 && desired_width % l_c_m == 0)
1935 bytes_per_block = desired_width;
1936 else
1938 error (0, 0, _("warning: invalid width %lu; using %d instead"),
1939 (unsigned long int) desired_width, l_c_m);
1940 bytes_per_block = l_c_m;
1943 else
1945 if (l_c_m < DEFAULT_BYTES_PER_BLOCK)
1946 bytes_per_block = l_c_m * (DEFAULT_BYTES_PER_BLOCK / l_c_m);
1947 else
1948 bytes_per_block = l_c_m;
1951 /* Compute padding necessary to align output block. */
1952 for (i = 0; i < n_specs; i++)
1954 int fields_per_block = bytes_per_block / width_bytes[spec[i].size];
1955 int block_width = (spec[i].field_width + 1) * fields_per_block;
1956 if (width_per_block < block_width)
1957 width_per_block = block_width;
1959 for (i = 0; i < n_specs; i++)
1961 int fields_per_block = bytes_per_block / width_bytes[spec[i].size];
1962 int block_width = spec[i].field_width * fields_per_block;
1963 spec[i].pad_width = width_per_block - block_width;
1966 #ifdef DEBUG
1967 printf ("lcm=%d, width_per_block=%"PRIuMAX"\n", l_c_m,
1968 (uintmax_t) width_per_block);
1969 for (i = 0; i < n_specs; i++)
1971 int fields_per_block = bytes_per_block / width_bytes[spec[i].size];
1972 assert (bytes_per_block % width_bytes[spec[i].size] == 0);
1973 assert (1 <= spec[i].pad_width / fields_per_block);
1974 printf ("%d: fmt=\"%s\" in_width=%d out_width=%d pad=%d\n",
1975 i, spec[i].fmt_string, width_bytes[spec[i].size],
1976 spec[i].field_width, spec[i].pad_width);
1978 #endif
1980 ok &= (flag_dump_strings ? dump_strings () : dump ());
1982 cleanup:
1984 if (have_read_stdin && fclose (stdin) == EOF)
1985 die (EXIT_FAILURE, errno, _("standard input"));
1987 return ok ? EXIT_SUCCESS : EXIT_FAILURE;