maint: update all copyright year number ranges
[coreutils.git] / src / od.c
blob04736bf8f22577700e5164577857d6a28e85720f
1 /* od -- dump files in octal and other formats
2 Copyright (C) 1992-2017 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 <http://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 "xfreopen.h"
33 #include "xprintf.h"
34 #include "xstrtol.h"
36 /* The official name of this program (e.g., no 'g' prefix). */
37 #define PROGRAM_NAME "od"
39 #define AUTHORS proper_name ("Jim Meyering")
41 /* The default number of input bytes per output line. */
42 #define DEFAULT_BYTES_PER_BLOCK 16
44 #if HAVE_UNSIGNED_LONG_LONG_INT
45 typedef unsigned long long int unsigned_long_long_int;
46 #else
47 /* This is just a place-holder to avoid a few '#if' directives.
48 In this case, the type isn't actually used. */
49 typedef unsigned long int unsigned_long_long_int;
50 #endif
52 enum size_spec
54 NO_SIZE,
55 CHAR,
56 SHORT,
57 INT,
58 LONG,
59 LONG_LONG,
60 /* FIXME: add INTMAX support, too */
61 FLOAT_SINGLE,
62 FLOAT_DOUBLE,
63 FLOAT_LONG_DOUBLE,
64 N_SIZE_SPECS
67 enum output_format
69 SIGNED_DECIMAL,
70 UNSIGNED_DECIMAL,
71 OCTAL,
72 HEXADECIMAL,
73 FLOATING_POINT,
74 NAMED_CHARACTER,
75 CHARACTER
78 #define MAX_INTEGRAL_TYPE_SIZE sizeof (unsigned_long_long_int)
80 /* The maximum number of bytes needed for a format string, including
81 the trailing nul. Each format string expects a variable amount of
82 padding (guaranteed to be at least 1 plus the field width), then an
83 element that will be formatted in the field. */
84 enum
86 FMT_BYTES_ALLOCATED =
87 (sizeof "%*.99" - 1
88 + MAX (sizeof "ld",
89 MAX (sizeof PRIdMAX,
90 MAX (sizeof PRIoMAX,
91 MAX (sizeof PRIuMAX,
92 sizeof PRIxMAX)))))
95 /* Ensure that our choice for FMT_BYTES_ALLOCATED is reasonable. */
96 verify (MAX_INTEGRAL_TYPE_SIZE * CHAR_BIT / 3 <= 99);
98 /* Each output format specification (from '-t spec' or from
99 old-style options) is represented by one of these structures. */
100 struct tspec
102 enum output_format fmt;
103 enum size_spec size; /* Type of input object. */
104 /* FIELDS is the number of fields per line, BLANK is the number of
105 fields to leave blank. WIDTH is width of one field, excluding
106 leading space, and PAD is total pad to divide among FIELDS.
107 PAD is at least as large as FIELDS. */
108 void (*print_function) (size_t fields, size_t blank, void const *data,
109 char const *fmt, int width, int pad);
110 char fmt_string[FMT_BYTES_ALLOCATED]; /* Of the style "%*d". */
111 bool hexl_mode_trailer;
112 int field_width; /* Minimum width of a field, excluding leading space. */
113 int pad_width; /* Total padding to be divided among fields. */
116 /* Convert the number of 8-bit bytes of a binary representation to
117 the number of characters (digits + sign if the type is signed)
118 required to represent the same quantity in the specified base/type.
119 For example, a 32-bit (4-byte) quantity may require a field width
120 as wide as the following for these types:
121 11 unsigned octal
122 11 signed decimal
123 10 unsigned decimal
124 8 unsigned hexadecimal */
126 static unsigned int const bytes_to_oct_digits[] =
127 {0, 3, 6, 8, 11, 14, 16, 19, 22, 25, 27, 30, 32, 35, 38, 41, 43};
129 static unsigned int const bytes_to_signed_dec_digits[] =
130 {1, 4, 6, 8, 11, 13, 16, 18, 20, 23, 25, 28, 30, 33, 35, 37, 40};
132 static unsigned int const bytes_to_unsigned_dec_digits[] =
133 {0, 3, 5, 8, 10, 13, 15, 17, 20, 22, 25, 27, 29, 32, 34, 37, 39};
135 static unsigned int const bytes_to_hex_digits[] =
136 {0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32};
138 /* It'll be a while before we see integral types wider than 16 bytes,
139 but if/when it happens, this check will catch it. Without this check,
140 a wider type would provoke a buffer overrun. */
141 verify (MAX_INTEGRAL_TYPE_SIZE < ARRAY_CARDINALITY (bytes_to_hex_digits));
143 /* Make sure the other arrays have the same length. */
144 verify (sizeof bytes_to_oct_digits == sizeof bytes_to_signed_dec_digits);
145 verify (sizeof bytes_to_oct_digits == sizeof bytes_to_unsigned_dec_digits);
146 verify (sizeof bytes_to_oct_digits == sizeof bytes_to_hex_digits);
148 /* Convert enum size_spec to the size of the named type. */
149 static const int width_bytes[] =
152 sizeof (char),
153 sizeof (short int),
154 sizeof (int),
155 sizeof (long int),
156 sizeof (unsigned_long_long_int),
157 sizeof (float),
158 sizeof (double),
159 sizeof (long double)
162 /* Ensure that for each member of 'enum size_spec' there is an
163 initializer in the width_bytes array. */
164 verify (ARRAY_CARDINALITY (width_bytes) == N_SIZE_SPECS);
166 /* Names for some non-printing characters. */
167 static char const charname[33][4] =
169 "nul", "soh", "stx", "etx", "eot", "enq", "ack", "bel",
170 "bs", "ht", "nl", "vt", "ff", "cr", "so", "si",
171 "dle", "dc1", "dc2", "dc3", "dc4", "nak", "syn", "etb",
172 "can", "em", "sub", "esc", "fs", "gs", "rs", "us",
173 "sp"
176 /* Address base (8, 10 or 16). */
177 static int address_base;
179 /* The number of octal digits required to represent the largest
180 address value. */
181 #define MAX_ADDRESS_LENGTH \
182 ((sizeof (uintmax_t) * CHAR_BIT + CHAR_BIT - 1) / 3)
184 /* Width of a normal address. */
185 static int address_pad_len;
187 /* Minimum length when detecting --strings. */
188 static size_t string_min;
190 /* True when in --strings mode. */
191 static bool flag_dump_strings;
193 /* True if we should recognize the older non-option arguments
194 that specified at most one file and optional arguments specifying
195 offset and pseudo-start address. */
196 static bool traditional;
198 /* True if an old-style 'pseudo-address' was specified. */
199 static bool flag_pseudo_start;
201 /* The difference between the old-style pseudo starting address and
202 the number of bytes to skip. */
203 static uintmax_t pseudo_offset;
205 /* Function that accepts an address and an optional following char,
206 and prints the address and char to stdout. */
207 static void (*format_address) (uintmax_t, char);
209 /* The number of input bytes to skip before formatting and writing. */
210 static uintmax_t n_bytes_to_skip = 0;
212 /* When false, MAX_BYTES_TO_FORMAT and END_OFFSET are ignored, and all
213 input is formatted. */
214 static bool limit_bytes_to_format = false;
216 /* The maximum number of bytes that will be formatted. */
217 static uintmax_t max_bytes_to_format;
219 /* The offset of the first byte after the last byte to be formatted. */
220 static uintmax_t end_offset;
222 /* When true and two or more consecutive blocks are equal, format
223 only the first block and output an asterisk alone on the following
224 line to indicate that identical blocks have been elided. */
225 static bool abbreviate_duplicate_blocks = true;
227 /* An array of specs describing how to format each input block. */
228 static struct tspec *spec;
230 /* The number of format specs. */
231 static size_t n_specs;
233 /* The allocated length of SPEC. */
234 static size_t n_specs_allocated;
236 /* The number of input bytes formatted per output line. It must be
237 a multiple of the least common multiple of the sizes associated with
238 the specified output types. It should be as large as possible, but
239 no larger than 16 -- unless specified with the -w option. */
240 static size_t bytes_per_block;
242 /* Human-readable representation of *file_list (for error messages).
243 It differs from file_list[-1] only when file_list[-1] is "-". */
244 static char const *input_filename;
246 /* A NULL-terminated list of the file-arguments from the command line. */
247 static char const *const *file_list;
249 /* Initializer for file_list if no file-arguments
250 were specified on the command line. */
251 static char const *const default_file_list[] = {"-", NULL};
253 /* The input stream associated with the current file. */
254 static FILE *in_stream;
256 /* If true, at least one of the files we read was standard input. */
257 static bool have_read_stdin;
259 /* Map the size in bytes to a type identifier. */
260 static enum size_spec integral_type_size[MAX_INTEGRAL_TYPE_SIZE + 1];
262 #define MAX_FP_TYPE_SIZE sizeof (long double)
263 static enum size_spec fp_type_size[MAX_FP_TYPE_SIZE + 1];
265 #ifndef WORDS_BIGENDIAN
266 # define WORDS_BIGENDIAN 0
267 #endif
269 /* Use native endianess by default. */
270 static bool input_swap;
272 static char const short_options[] = "A:aBbcDdeFfHhIij:LlN:OoS:st:vw::Xx";
274 /* For long options that have no equivalent short option, use a
275 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
276 enum
278 TRADITIONAL_OPTION = CHAR_MAX + 1,
279 ENDIAN_OPTION,
282 enum endian_type
284 endian_little,
285 endian_big
288 static char const *const endian_args[] =
290 "little", "big", NULL
293 static enum endian_type const endian_types[] =
295 endian_little, endian_big
298 static struct option const long_options[] =
300 {"skip-bytes", required_argument, NULL, 'j'},
301 {"address-radix", required_argument, NULL, 'A'},
302 {"read-bytes", required_argument, NULL, 'N'},
303 {"format", required_argument, NULL, 't'},
304 {"output-duplicates", no_argument, NULL, 'v'},
305 {"strings", optional_argument, NULL, 'S'},
306 {"traditional", no_argument, NULL, TRADITIONAL_OPTION},
307 {"width", optional_argument, NULL, 'w'},
308 {"endian", required_argument, NULL, ENDIAN_OPTION },
310 {GETOPT_HELP_OPTION_DECL},
311 {GETOPT_VERSION_OPTION_DECL},
312 {NULL, 0, NULL, 0}
315 void
316 usage (int status)
318 if (status != EXIT_SUCCESS)
319 emit_try_help ();
320 else
322 printf (_("\
323 Usage: %s [OPTION]... [FILE]...\n\
324 or: %s [-abcdfilosx]... [FILE] [[+]OFFSET[.][b]]\n\
325 or: %s --traditional [OPTION]... [FILE] [[+]OFFSET[.][b] [+][LABEL][.][b]]\n\
327 program_name, program_name, program_name);
328 fputs (_("\n\
329 Write an unambiguous representation, octal bytes by default,\n\
330 of FILE to standard output. With more than one FILE argument,\n\
331 concatenate them in the listed order to form the input.\n\
332 "), stdout);
334 emit_stdin_note ();
336 fputs (_("\
338 If first and second call formats both apply, the second format is assumed\n\
339 if the last operand begins with + or (if there are 2 operands) a digit.\n\
340 An OFFSET operand means -j OFFSET. LABEL is the pseudo-address\n\
341 at first byte printed, incremented when dump is progressing.\n\
342 For OFFSET and LABEL, a 0x or 0X prefix indicates hexadecimal;\n\
343 suffixes may be . for octal and b for multiply by 512.\n\
344 "), stdout);
346 emit_mandatory_arg_note ();
348 fputs (_("\
349 -A, --address-radix=RADIX output format for file offsets; RADIX is one\n\
350 of [doxn], for Decimal, Octal, Hex or None\n\
351 --endian={big|little} swap input bytes according the specified order\n\
352 -j, --skip-bytes=BYTES skip BYTES input bytes first\n\
353 "), stdout);
354 fputs (_("\
355 -N, --read-bytes=BYTES limit dump to BYTES input bytes\n\
356 -S BYTES, --strings[=BYTES] output strings of at least BYTES graphic chars;\
358 3 is implied when BYTES is not specified\n\
359 -t, --format=TYPE select output format or formats\n\
360 -v, --output-duplicates do not use * to mark line suppression\n\
361 -w[BYTES], --width[=BYTES] output BYTES bytes per output line;\n\
362 32 is implied when BYTES is not specified\n\
363 --traditional accept arguments in third form above\n\
364 "), stdout);
365 fputs (HELP_OPTION_DESCRIPTION, stdout);
366 fputs (VERSION_OPTION_DESCRIPTION, stdout);
367 fputs (_("\
370 Traditional format specifications may be intermixed; they accumulate:\n\
371 -a same as -t a, select named characters, ignoring high-order bit\n\
372 -b same as -t o1, select octal bytes\n\
373 -c same as -t c, select printable characters or backslash escapes\n\
374 -d same as -t u2, select unsigned decimal 2-byte units\n\
375 "), stdout);
376 fputs (_("\
377 -f same as -t fF, select floats\n\
378 -i same as -t dI, select decimal ints\n\
379 -l same as -t dL, select decimal longs\n\
380 -o same as -t o2, select octal 2-byte units\n\
381 -s same as -t d2, select decimal 2-byte units\n\
382 -x same as -t x2, select hexadecimal 2-byte units\n\
383 "), stdout);
384 fputs (_("\
387 TYPE is made up of one or more of these specifications:\n\
388 a named character, ignoring high-order bit\n\
389 c printable character or backslash escape\n\
390 "), stdout);
391 fputs (_("\
392 d[SIZE] signed decimal, SIZE bytes per integer\n\
393 f[SIZE] floating point, SIZE bytes per float\n\
394 o[SIZE] octal, SIZE bytes per integer\n\
395 u[SIZE] unsigned decimal, SIZE bytes per integer\n\
396 x[SIZE] hexadecimal, SIZE bytes per integer\n\
397 "), stdout);
398 fputs (_("\
400 SIZE is a number. For TYPE in [doux], SIZE may also be C for\n\
401 sizeof(char), S for sizeof(short), I for sizeof(int) or L for\n\
402 sizeof(long). If TYPE is f, SIZE may also be F for sizeof(float), D\n\
403 for sizeof(double) or L for sizeof(long double).\n\
404 "), stdout);
405 fputs (_("\
407 Adding a z suffix to any type displays printable characters at the end of\n\
408 each output line.\n\
409 "), stdout);
410 fputs (_("\
413 BYTES is hex with 0x or 0X prefix, and may have a multiplier suffix:\n\
414 b 512\n\
415 KB 1000\n\
416 K 1024\n\
417 MB 1000*1000\n\
418 M 1024*1024\n\
419 and so on for G, T, P, E, Z, Y.\n\
420 "), stdout);
421 emit_ancillary_info (PROGRAM_NAME);
423 exit (status);
426 /* Define the print functions. */
428 #define PRINT_FIELDS(N, T, FMT_STRING, ACTION) \
429 static void \
430 N (size_t fields, size_t blank, void const *block, \
431 char const *FMT_STRING, int width, int pad) \
433 T const *p = block; \
434 uintmax_t i; \
435 int pad_remaining = pad; \
436 for (i = fields; blank < i; i--) \
438 int next_pad = pad * (i - 1) / fields; \
439 int adjusted_width = pad_remaining - next_pad + width; \
440 T x; \
441 if (input_swap && sizeof (T) > 1) \
443 size_t j; \
444 union { \
445 T x; \
446 char b[sizeof (T)]; \
447 } u; \
448 for (j = 0; j < sizeof (T); j++) \
449 u.b[j] = ((const char *) p)[sizeof (T) - 1 - j]; \
450 x = u.x; \
452 else \
453 x = *p; \
454 p++; \
455 ACTION; \
456 pad_remaining = next_pad; \
460 #define PRINT_TYPE(N, T) \
461 PRINT_FIELDS (N, T, fmt_string, xprintf (fmt_string, adjusted_width, x))
463 #define PRINT_FLOATTYPE(N, T, FTOASTR, BUFSIZE) \
464 PRINT_FIELDS (N, T, fmt_string _GL_UNUSED, \
465 char buf[BUFSIZE]; \
466 FTOASTR (buf, sizeof buf, 0, 0, x); \
467 xprintf ("%*s", adjusted_width, buf))
469 PRINT_TYPE (print_s_char, signed char)
470 PRINT_TYPE (print_char, unsigned char)
471 PRINT_TYPE (print_s_short, short int)
472 PRINT_TYPE (print_short, unsigned short int)
473 PRINT_TYPE (print_int, unsigned int)
474 PRINT_TYPE (print_long, unsigned long int)
475 PRINT_TYPE (print_long_long, unsigned_long_long_int)
477 PRINT_FLOATTYPE (print_float, float, ftoastr, FLT_BUFSIZE_BOUND)
478 PRINT_FLOATTYPE (print_double, double, dtoastr, DBL_BUFSIZE_BOUND)
479 PRINT_FLOATTYPE (print_long_double, long double, ldtoastr, LDBL_BUFSIZE_BOUND)
481 #undef PRINT_TYPE
482 #undef PRINT_FLOATTYPE
484 static void
485 dump_hexl_mode_trailer (size_t n_bytes, const char *block)
487 size_t i;
488 fputs (" >", stdout);
489 for (i = n_bytes; i > 0; i--)
491 unsigned char c = *block++;
492 unsigned char c2 = (isprint (c) ? c : '.');
493 putchar (c2);
495 putchar ('<');
498 static void
499 print_named_ascii (size_t fields, size_t blank, void const *block,
500 const char *unused_fmt_string _GL_UNUSED,
501 int width, int pad)
503 unsigned char const *p = block;
504 uintmax_t i;
505 int pad_remaining = pad;
506 for (i = fields; blank < i; i--)
508 int next_pad = pad * (i - 1) / fields;
509 int masked_c = *p++ & 0x7f;
510 const char *s;
511 char buf[2];
513 if (masked_c == 127)
514 s = "del";
515 else if (masked_c <= 040)
516 s = charname[masked_c];
517 else
519 buf[0] = masked_c;
520 buf[1] = 0;
521 s = buf;
524 xprintf ("%*s", pad_remaining - next_pad + width, s);
525 pad_remaining = next_pad;
529 static void
530 print_ascii (size_t fields, size_t blank, void const *block,
531 const char *unused_fmt_string _GL_UNUSED, int width,
532 int pad)
534 unsigned char const *p = block;
535 uintmax_t i;
536 int pad_remaining = pad;
537 for (i = fields; blank < i; i--)
539 int next_pad = pad * (i - 1) / fields;
540 unsigned char c = *p++;
541 const char *s;
542 char buf[4];
544 switch (c)
546 case '\0':
547 s = "\\0";
548 break;
550 case '\a':
551 s = "\\a";
552 break;
554 case '\b':
555 s = "\\b";
556 break;
558 case '\f':
559 s = "\\f";
560 break;
562 case '\n':
563 s = "\\n";
564 break;
566 case '\r':
567 s = "\\r";
568 break;
570 case '\t':
571 s = "\\t";
572 break;
574 case '\v':
575 s = "\\v";
576 break;
578 default:
579 sprintf (buf, (isprint (c) ? "%c" : "%03o"), c);
580 s = buf;
583 xprintf ("%*s", pad_remaining - next_pad + width, s);
584 pad_remaining = next_pad;
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 true. 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 false.
593 Otherwise, advance *P to the first non-digit after S, set *VAL to
594 the result of the conversion and return true. */
596 static bool
597 simple_strtoul (const char *s, const char **p, unsigned long int *val)
599 unsigned long int sum;
601 sum = 0;
602 while (ISDIGIT (*s))
604 int c = *s++ - '0';
605 if (sum > (ULONG_MAX - c) / 10)
606 return false;
607 sum = sum * 10 + c;
609 *p = s;
610 *val = sum;
611 return true;
614 /* If S points to a single valid modern 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 true. If S is not valid, don't modify *NEXT or *TSPEC,
618 give a diagnostic, and return false. 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 field_width = 11;
625 fmt_string = "%*d";
627 pad_width is determined later, but is at least as large as the
628 number of fields printed per row.
629 S_ORIG is solely for reporting errors. It should be the full format
630 string argument.
633 static bool
634 decode_one_format (const char *s_orig, const char *s, const char **next,
635 struct tspec *tspec)
637 enum size_spec size_spec;
638 unsigned long int size;
639 enum output_format fmt;
640 void (*print_function) (size_t, size_t, void const *, char const *,
641 int, int);
642 const char *p;
643 char c;
644 int field_width;
646 assert (tspec != NULL);
648 switch (*s)
650 case 'd':
651 case 'o':
652 case 'u':
653 case 'x':
654 c = *s;
655 ++s;
656 switch (*s)
658 case 'C':
659 ++s;
660 size = sizeof (char);
661 break;
663 case 'S':
664 ++s;
665 size = sizeof (short int);
666 break;
668 case 'I':
669 ++s;
670 size = sizeof (int);
671 break;
673 case 'L':
674 ++s;
675 size = sizeof (long int);
676 break;
678 default:
679 if (! simple_strtoul (s, &p, &size))
681 /* The integer at P in S would overflow an unsigned long int.
682 A digit string that long is sufficiently odd looking
683 that the following diagnostic is sufficient. */
684 error (0, 0, _("invalid type string %s"), quote (s_orig));
685 return false;
687 if (p == s)
688 size = sizeof (int);
689 else
691 if (MAX_INTEGRAL_TYPE_SIZE < size
692 || integral_type_size[size] == NO_SIZE)
694 error (0, 0, _("invalid type string %s;\nthis system"
695 " doesn't provide a %lu-byte integral type"),
696 quote (s_orig), size);
697 return false;
699 s = p;
701 break;
704 #define ISPEC_TO_FORMAT(Spec, Min_format, Long_format, Max_format) \
705 ((Spec) == LONG_LONG ? (Max_format) \
706 : ((Spec) == LONG ? (Long_format) \
707 : (Min_format))) \
709 size_spec = integral_type_size[size];
711 switch (c)
713 case 'd':
714 fmt = SIGNED_DECIMAL;
715 field_width = bytes_to_signed_dec_digits[size];
716 sprintf (tspec->fmt_string, "%%*%s",
717 ISPEC_TO_FORMAT (size_spec, "d", "ld", PRIdMAX));
718 break;
720 case 'o':
721 fmt = OCTAL;
722 sprintf (tspec->fmt_string, "%%*.%d%s",
723 (field_width = bytes_to_oct_digits[size]),
724 ISPEC_TO_FORMAT (size_spec, "o", "lo", PRIoMAX));
725 break;
727 case 'u':
728 fmt = UNSIGNED_DECIMAL;
729 field_width = bytes_to_unsigned_dec_digits[size];
730 sprintf (tspec->fmt_string, "%%*%s",
731 ISPEC_TO_FORMAT (size_spec, "u", "lu", PRIuMAX));
732 break;
734 case 'x':
735 fmt = HEXADECIMAL;
736 sprintf (tspec->fmt_string, "%%*.%d%s",
737 (field_width = bytes_to_hex_digits[size]),
738 ISPEC_TO_FORMAT (size_spec, "x", "lx", PRIxMAX));
739 break;
741 default:
742 abort ();
745 assert (strlen (tspec->fmt_string) < FMT_BYTES_ALLOCATED);
747 switch (size_spec)
749 case CHAR:
750 print_function = (fmt == SIGNED_DECIMAL
751 ? print_s_char
752 : print_char);
753 break;
755 case SHORT:
756 print_function = (fmt == SIGNED_DECIMAL
757 ? print_s_short
758 : print_short);
759 break;
761 case INT:
762 print_function = print_int;
763 break;
765 case LONG:
766 print_function = print_long;
767 break;
769 case LONG_LONG:
770 print_function = print_long_long;
771 break;
773 default:
774 abort ();
776 break;
778 case 'f':
779 fmt = FLOATING_POINT;
780 ++s;
781 switch (*s)
783 case 'F':
784 ++s;
785 size = sizeof (float);
786 break;
788 case 'D':
789 ++s;
790 size = sizeof (double);
791 break;
793 case 'L':
794 ++s;
795 size = sizeof (long double);
796 break;
798 default:
799 if (! simple_strtoul (s, &p, &size))
801 /* The integer at P in S would overflow an unsigned long int.
802 A digit string that long is sufficiently odd looking
803 that the following diagnostic is sufficient. */
804 error (0, 0, _("invalid type string %s"), quote (s_orig));
805 return false;
807 if (p == s)
808 size = sizeof (double);
809 else
811 if (size > MAX_FP_TYPE_SIZE
812 || fp_type_size[size] == NO_SIZE)
814 error (0, 0,
815 _("invalid type string %s;\n"
816 "this system doesn't provide a %lu-byte"
817 " floating point type"),
818 quote (s_orig), size);
819 return false;
821 s = p;
823 break;
825 size_spec = fp_type_size[size];
828 struct lconv const *locale = localeconv ();
829 size_t decimal_point_len =
830 (locale->decimal_point[0] ? strlen (locale->decimal_point) : 1);
832 switch (size_spec)
834 case FLOAT_SINGLE:
835 print_function = print_float;
836 field_width = FLT_STRLEN_BOUND_L (decimal_point_len);
837 break;
839 case FLOAT_DOUBLE:
840 print_function = print_double;
841 field_width = DBL_STRLEN_BOUND_L (decimal_point_len);
842 break;
844 case FLOAT_LONG_DOUBLE:
845 print_function = print_long_double;
846 field_width = LDBL_STRLEN_BOUND_L (decimal_point_len);
847 break;
849 default:
850 abort ();
853 break;
856 case 'a':
857 ++s;
858 fmt = NAMED_CHARACTER;
859 size_spec = CHAR;
860 print_function = print_named_ascii;
861 field_width = 3;
862 break;
864 case 'c':
865 ++s;
866 fmt = CHARACTER;
867 size_spec = CHAR;
868 print_function = print_ascii;
869 field_width = 3;
870 break;
872 default:
873 error (0, 0, _("invalid character '%c' in type string %s"),
874 *s, quote (s_orig));
875 return false;
878 tspec->size = size_spec;
879 tspec->fmt = fmt;
880 tspec->print_function = print_function;
882 tspec->field_width = field_width;
883 tspec->hexl_mode_trailer = (*s == 'z');
884 if (tspec->hexl_mode_trailer)
885 s++;
887 if (next != NULL)
888 *next = s;
890 return true;
893 /* Given a list of one or more input filenames FILE_LIST, set the global
894 file pointer IN_STREAM and the global string INPUT_FILENAME to the
895 first one that can be successfully opened. Modify FILE_LIST to
896 reference the next filename in the list. A file name of "-" is
897 interpreted as standard input. If any file open fails, give an error
898 message and return false. */
900 static bool
901 open_next_file (void)
903 bool ok = true;
907 input_filename = *file_list;
908 if (input_filename == NULL)
909 return ok;
910 ++file_list;
912 if (STREQ (input_filename, "-"))
914 input_filename = _("standard input");
915 in_stream = stdin;
916 have_read_stdin = true;
917 if (O_BINARY && ! isatty (STDIN_FILENO))
918 xfreopen (NULL, "rb", stdin);
920 else
922 in_stream = fopen (input_filename, (O_BINARY ? "rb" : "r"));
923 if (in_stream == NULL)
925 error (0, errno, "%s", quotef (input_filename));
926 ok = false;
930 while (in_stream == NULL);
932 if (limit_bytes_to_format && !flag_dump_strings)
933 setvbuf (in_stream, NULL, _IONBF, 0);
935 return ok;
938 /* Test whether there have been errors on in_stream, and close it if
939 it is not standard input. Return false if there has been an error
940 on in_stream or stdout; return true otherwise. This function will
941 report more than one error only if both a read and a write error
942 have occurred. IN_ERRNO, if nonzero, is the error number
943 corresponding to the most recent action for IN_STREAM. */
945 static bool
946 check_and_close (int in_errno)
948 bool ok = true;
950 if (in_stream != NULL)
952 if (ferror (in_stream))
954 error (0, in_errno, _("%s: read error"), quotef (input_filename));
955 if (! STREQ (file_list[-1], "-"))
956 fclose (in_stream);
957 ok = false;
959 else if (! STREQ (file_list[-1], "-") && fclose (in_stream) != 0)
961 error (0, 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 (const char *s)
984 const char *s_orig = s;
985 assert (s != NULL);
987 while (*s != '\0')
989 const char *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 /* The st_size field is valid for regular files.
1038 If the number of bytes left to skip is larger than
1039 the size of the current file, we can decrement n_skip
1040 and go on to the next file. Skip this optimization also
1041 when st_size is no greater than the block size, because
1042 some kernels report nonsense small file sizes for
1043 proc-like file systems. */
1044 if (usable_st_size (&file_stats)
1045 && ST_BLKSIZE (file_stats) < file_stats.st_size)
1047 if ((uintmax_t) file_stats.st_size < n_skip)
1048 n_skip -= file_stats.st_size;
1049 else
1051 if (fseeko (in_stream, n_skip, SEEK_CUR) != 0)
1053 in_errno = errno;
1054 ok = false;
1056 n_skip = 0;
1060 /* If it's not a regular file with nonnegative size,
1061 or if it's so small that it might be in a proc-like file system,
1062 position the file pointer by reading. */
1064 else
1066 char buf[BUFSIZ];
1067 size_t n_bytes_read, n_bytes_to_read = BUFSIZ;
1069 while (0 < n_skip)
1071 if (n_skip < n_bytes_to_read)
1072 n_bytes_to_read = n_skip;
1073 n_bytes_read = fread (buf, 1, n_bytes_to_read, in_stream);
1074 n_skip -= n_bytes_read;
1075 if (n_bytes_read != n_bytes_to_read)
1077 if (ferror (in_stream))
1079 in_errno = errno;
1080 ok = false;
1081 n_skip = 0;
1082 break;
1084 if (feof (in_stream))
1085 break;
1090 if (n_skip == 0)
1091 break;
1094 else /* cannot fstat() file */
1096 error (0, errno, "%s", quotef (input_filename));
1097 ok = false;
1100 ok &= check_and_close (in_errno);
1102 ok &= open_next_file ();
1105 if (n_skip != 0)
1106 die (EXIT_FAILURE, 0, _("cannot skip past end of combined input"));
1108 return ok;
1111 static void
1112 format_address_none (uintmax_t address _GL_UNUSED,
1113 char c _GL_UNUSED)
1117 static void
1118 format_address_std (uintmax_t address, char c)
1120 char buf[MAX_ADDRESS_LENGTH + 2];
1121 char *p = buf + sizeof buf;
1122 char const *pbound;
1124 *--p = '\0';
1125 *--p = c;
1126 pbound = p - address_pad_len;
1128 /* Use a special case of the code for each base. This is measurably
1129 faster than generic code. */
1130 switch (address_base)
1132 case 8:
1134 *--p = '0' + (address & 7);
1135 while ((address >>= 3) != 0);
1136 break;
1138 case 10:
1140 *--p = '0' + (address % 10);
1141 while ((address /= 10) != 0);
1142 break;
1144 case 16:
1146 *--p = "0123456789abcdef"[address & 15];
1147 while ((address >>= 4) != 0);
1148 break;
1151 while (pbound < p)
1152 *--p = '0';
1154 fputs (p, stdout);
1157 static void
1158 format_address_paren (uintmax_t address, char c)
1160 putchar ('(');
1161 format_address_std (address, ')');
1162 if (c)
1163 putchar (c);
1166 static void
1167 format_address_label (uintmax_t address, char c)
1169 format_address_std (address, ' ');
1170 format_address_paren (address + pseudo_offset, c);
1173 /* Write N_BYTES bytes from CURR_BLOCK to standard output once for each
1174 of the N_SPEC format specs. CURRENT_OFFSET is the byte address of
1175 CURR_BLOCK in the concatenation of input files, and it is printed
1176 (optionally) only before the output line associated with the first
1177 format spec. When duplicate blocks are being abbreviated, the output
1178 for a sequence of identical input blocks is the output for the first
1179 block followed by an asterisk alone on a line. It is valid to compare
1180 the blocks PREV_BLOCK and CURR_BLOCK only when N_BYTES == BYTES_PER_BLOCK.
1181 That condition may be false only for the last input block. */
1183 static void
1184 write_block (uintmax_t current_offset, size_t n_bytes,
1185 const char *prev_block, const char *curr_block)
1187 static bool first = true;
1188 static bool prev_pair_equal = false;
1190 #define EQUAL_BLOCKS(b1, b2) (memcmp (b1, b2, bytes_per_block) == 0)
1192 if (abbreviate_duplicate_blocks
1193 && !first && n_bytes == bytes_per_block
1194 && EQUAL_BLOCKS (prev_block, curr_block))
1196 if (prev_pair_equal)
1198 /* The two preceding blocks were equal, and the current
1199 block is the same as the last one, so print nothing. */
1201 else
1203 printf ("*\n");
1204 prev_pair_equal = true;
1207 else
1209 size_t i;
1211 prev_pair_equal = false;
1212 for (i = 0; i < n_specs; i++)
1214 int datum_width = width_bytes[spec[i].size];
1215 int fields_per_block = bytes_per_block / datum_width;
1216 int blank_fields = (bytes_per_block - n_bytes) / datum_width;
1217 if (i == 0)
1218 format_address (current_offset, '\0');
1219 else
1220 printf ("%*s", address_pad_len, "");
1221 (*spec[i].print_function) (fields_per_block, blank_fields,
1222 curr_block, spec[i].fmt_string,
1223 spec[i].field_width, spec[i].pad_width);
1224 if (spec[i].hexl_mode_trailer)
1226 /* space-pad out to full line width, then dump the trailer */
1227 int field_width = spec[i].field_width;
1228 int pad_width = (spec[i].pad_width * blank_fields
1229 / fields_per_block);
1230 printf ("%*s", blank_fields * field_width + pad_width, "");
1231 dump_hexl_mode_trailer (n_bytes, curr_block);
1233 putchar ('\n');
1236 first = false;
1239 /* Read a single byte into *C from the concatenation of the input files
1240 named in the global array FILE_LIST. On the first call to this
1241 function, the global variable IN_STREAM is expected to be an open
1242 stream associated with the input file INPUT_FILENAME. If IN_STREAM
1243 is at end-of-file, close it and update the global variables IN_STREAM
1244 and INPUT_FILENAME so they correspond to the next file in the list.
1245 Then try to read a byte from the newly opened file. Repeat if
1246 necessary until EOF is reached for the last file in FILE_LIST, then
1247 set *C to EOF and return. Subsequent calls do likewise. Return
1248 true if successful. */
1250 static bool
1251 read_char (int *c)
1253 bool ok = true;
1255 *c = EOF;
1257 while (in_stream != NULL) /* EOF. */
1259 *c = fgetc (in_stream);
1261 if (*c != EOF)
1262 break;
1264 ok &= check_and_close (errno);
1266 ok &= open_next_file ();
1269 return ok;
1272 /* Read N bytes into BLOCK from the concatenation of the input files
1273 named in the global array FILE_LIST. On the first call to this
1274 function, the global variable IN_STREAM is expected to be an open
1275 stream associated with the input file INPUT_FILENAME. If all N
1276 bytes cannot be read from IN_STREAM, close IN_STREAM and update
1277 the global variables IN_STREAM and INPUT_FILENAME. Then try to
1278 read the remaining bytes from the newly opened file. Repeat if
1279 necessary until EOF is reached for the last file in FILE_LIST.
1280 On subsequent calls, don't modify BLOCK and return true. Set
1281 *N_BYTES_IN_BUFFER to the number of bytes read. If an error occurs,
1282 it will be detected through ferror when the stream is about to be
1283 closed. If there is an error, give a message but continue reading
1284 as usual and return false. Otherwise return true. */
1286 static bool
1287 read_block (size_t n, char *block, size_t *n_bytes_in_buffer)
1289 bool ok = true;
1291 assert (0 < n && n <= bytes_per_block);
1293 *n_bytes_in_buffer = 0;
1295 while (in_stream != NULL) /* EOF. */
1297 size_t n_needed;
1298 size_t n_read;
1300 n_needed = n - *n_bytes_in_buffer;
1301 n_read = fread (block + *n_bytes_in_buffer, 1, n_needed, in_stream);
1303 *n_bytes_in_buffer += n_read;
1305 if (n_read == n_needed)
1306 break;
1308 ok &= check_and_close (errno);
1310 ok &= open_next_file ();
1313 return ok;
1316 /* Return the least common multiple of the sizes associated
1317 with the format specs. */
1319 static int _GL_ATTRIBUTE_PURE
1320 get_lcm (void)
1322 size_t i;
1323 int l_c_m = 1;
1325 for (i = 0; i < n_specs; i++)
1326 l_c_m = lcm (l_c_m, width_bytes[spec[i].size]);
1327 return l_c_m;
1330 /* If S is a valid traditional offset specification with an optional
1331 leading '+' return true and set *OFFSET to the offset it denotes. */
1333 static bool
1334 parse_old_offset (const char *s, uintmax_t *offset)
1336 int radix;
1338 if (*s == '\0')
1339 return false;
1341 /* Skip over any leading '+'. */
1342 if (s[0] == '+')
1343 ++s;
1345 /* Determine the radix we'll use to interpret S. If there is a '.',
1346 it's decimal, otherwise, if the string begins with '0X'or '0x',
1347 it's hexadecimal, else octal. */
1348 if (strchr (s, '.') != NULL)
1349 radix = 10;
1350 else
1352 if (s[0] == '0' && (s[1] == 'x' || s[1] == 'X'))
1353 radix = 16;
1354 else
1355 radix = 8;
1358 return xstrtoumax (s, NULL, radix, offset, "Bb") == LONGINT_OK;
1361 /* Read a chunk of size BYTES_PER_BLOCK from the input files, write the
1362 formatted block to standard output, and repeat until the specified
1363 maximum number of bytes has been read or until all input has been
1364 processed. If the last block read is smaller than BYTES_PER_BLOCK
1365 and its size is not a multiple of the size associated with a format
1366 spec, extend the input block with zero bytes until its length is a
1367 multiple of all format spec sizes. Write the final block. Finally,
1368 write on a line by itself the offset of the byte after the last byte
1369 read. Accumulate return values from calls to read_block and
1370 check_and_close, and if any was false, return false.
1371 Otherwise, return true. */
1373 static bool
1374 dump (void)
1376 char *block[2];
1377 uintmax_t current_offset;
1378 bool idx = false;
1379 bool ok = true;
1380 size_t n_bytes_read;
1382 block[0] = xnmalloc (2, bytes_per_block);
1383 block[1] = block[0] + bytes_per_block;
1385 current_offset = n_bytes_to_skip;
1387 if (limit_bytes_to_format)
1389 while (1)
1391 size_t n_needed;
1392 if (current_offset >= end_offset)
1394 n_bytes_read = 0;
1395 break;
1397 n_needed = MIN (end_offset - current_offset,
1398 (uintmax_t) bytes_per_block);
1399 ok &= read_block (n_needed, block[idx], &n_bytes_read);
1400 if (n_bytes_read < bytes_per_block)
1401 break;
1402 assert (n_bytes_read == bytes_per_block);
1403 write_block (current_offset, n_bytes_read,
1404 block[!idx], block[idx]);
1405 current_offset += n_bytes_read;
1406 idx = !idx;
1409 else
1411 while (1)
1413 ok &= read_block (bytes_per_block, block[idx], &n_bytes_read);
1414 if (n_bytes_read < bytes_per_block)
1415 break;
1416 assert (n_bytes_read == bytes_per_block);
1417 write_block (current_offset, n_bytes_read,
1418 block[!idx], block[idx]);
1419 current_offset += n_bytes_read;
1420 idx = !idx;
1424 if (n_bytes_read > 0)
1426 int l_c_m;
1427 size_t bytes_to_write;
1429 l_c_m = get_lcm ();
1431 /* Ensure zero-byte padding up to the smallest multiple of l_c_m that
1432 is at least as large as n_bytes_read. */
1433 bytes_to_write = l_c_m * ((n_bytes_read + l_c_m - 1) / l_c_m);
1435 memset (block[idx] + n_bytes_read, 0, bytes_to_write - n_bytes_read);
1436 write_block (current_offset, n_bytes_read, block[!idx], block[idx]);
1437 current_offset += n_bytes_read;
1440 format_address (current_offset, '\n');
1442 if (limit_bytes_to_format && current_offset >= end_offset)
1443 ok &= check_and_close (0);
1445 free (block[0]);
1447 return ok;
1450 /* STRINGS mode. Find each "string constant" in the input.
1451 A string constant is a run of at least 'string_min' ASCII
1452 graphic (or formatting) characters terminated by a null.
1453 Based on a function written by Richard Stallman for a
1454 traditional version of od. Return true if successful. */
1456 static bool
1457 dump_strings (void)
1459 size_t bufsize = MAX (100, string_min);
1460 char *buf = xmalloc (bufsize);
1461 uintmax_t address = n_bytes_to_skip;
1462 bool ok = true;
1464 while (1)
1466 size_t i;
1467 int c;
1469 /* See if the next 'string_min' chars are all printing chars. */
1470 tryline:
1472 if (limit_bytes_to_format
1473 && (end_offset < string_min || end_offset - string_min <= address))
1474 break;
1476 for (i = 0; i < string_min; i++)
1478 ok &= read_char (&c);
1479 address++;
1480 if (c < 0)
1482 free (buf);
1483 return ok;
1485 if (! isprint (c))
1486 /* Found a non-printing. Try again starting with next char. */
1487 goto tryline;
1488 buf[i] = c;
1491 /* We found a run of 'string_min' printable characters.
1492 Now see if it is terminated with a null byte. */
1493 while (!limit_bytes_to_format || address < end_offset)
1495 if (i == bufsize)
1497 buf = X2REALLOC (buf, &bufsize);
1499 ok &= read_char (&c);
1500 address++;
1501 if (c < 0)
1503 free (buf);
1504 return ok;
1506 if (c == '\0')
1507 break; /* It is; print this string. */
1508 if (! isprint (c))
1509 goto tryline; /* It isn't; give up on this string. */
1510 buf[i++] = c; /* String continues; store it all. */
1513 /* If we get here, the string is all printable and null-terminated,
1514 so print it. It is all in 'buf' and 'i' is its length. */
1515 buf[i] = 0;
1516 format_address (address - i - 1, ' ');
1518 for (i = 0; (c = buf[i]); i++)
1520 switch (c)
1522 case '\a':
1523 fputs ("\\a", stdout);
1524 break;
1526 case '\b':
1527 fputs ("\\b", stdout);
1528 break;
1530 case '\f':
1531 fputs ("\\f", stdout);
1532 break;
1534 case '\n':
1535 fputs ("\\n", stdout);
1536 break;
1538 case '\r':
1539 fputs ("\\r", stdout);
1540 break;
1542 case '\t':
1543 fputs ("\\t", stdout);
1544 break;
1546 case '\v':
1547 fputs ("\\v", stdout);
1548 break;
1550 default:
1551 putc (c, stdout);
1554 putchar ('\n');
1557 /* We reach this point only if we search through
1558 (max_bytes_to_format - string_min) bytes before reaching EOF. */
1560 free (buf);
1562 ok &= check_and_close (0);
1563 return ok;
1567 main (int argc, char **argv)
1569 int n_files;
1570 size_t i;
1571 int l_c_m;
1572 size_t desired_width IF_LINT ( = 0);
1573 bool modern = false;
1574 bool width_specified = false;
1575 bool ok = true;
1576 size_t width_per_block = 0;
1577 static char const multipliers[] = "bEGKkMmPTYZ0";
1579 /* The old-style 'pseudo starting address' to be printed in parentheses
1580 after any true address. */
1581 uintmax_t pseudo_start IF_LINT ( = 0);
1583 initialize_main (&argc, &argv);
1584 set_program_name (argv[0]);
1585 setlocale (LC_ALL, "");
1586 bindtextdomain (PACKAGE, LOCALEDIR);
1587 textdomain (PACKAGE);
1589 atexit (close_stdout);
1591 for (i = 0; i <= MAX_INTEGRAL_TYPE_SIZE; i++)
1592 integral_type_size[i] = NO_SIZE;
1594 integral_type_size[sizeof (char)] = CHAR;
1595 integral_type_size[sizeof (short int)] = SHORT;
1596 integral_type_size[sizeof (int)] = INT;
1597 integral_type_size[sizeof (long int)] = LONG;
1598 #if HAVE_UNSIGNED_LONG_LONG_INT
1599 /* If 'long int' and 'long long int' have the same size, it's fine
1600 to overwrite the entry for 'long' with this one. */
1601 integral_type_size[sizeof (unsigned_long_long_int)] = LONG_LONG;
1602 #endif
1604 for (i = 0; i <= MAX_FP_TYPE_SIZE; i++)
1605 fp_type_size[i] = NO_SIZE;
1607 fp_type_size[sizeof (float)] = FLOAT_SINGLE;
1608 /* The array entry for 'double' is filled in after that for 'long double'
1609 so that if they are the same size, we avoid any overhead of
1610 long double computation in libc. */
1611 fp_type_size[sizeof (long double)] = FLOAT_LONG_DOUBLE;
1612 fp_type_size[sizeof (double)] = FLOAT_DOUBLE;
1614 n_specs = 0;
1615 n_specs_allocated = 0;
1616 spec = NULL;
1618 format_address = format_address_std;
1619 address_base = 8;
1620 address_pad_len = 7;
1621 flag_dump_strings = false;
1623 while (true)
1625 uintmax_t tmp;
1626 enum strtol_error s_err;
1627 int oi = -1;
1628 int c = getopt_long (argc, argv, short_options, long_options, &oi);
1629 if (c == -1)
1630 break;
1632 switch (c)
1634 case 'A':
1635 modern = true;
1636 switch (optarg[0])
1638 case 'd':
1639 format_address = format_address_std;
1640 address_base = 10;
1641 address_pad_len = 7;
1642 break;
1643 case 'o':
1644 format_address = format_address_std;
1645 address_base = 8;
1646 address_pad_len = 7;
1647 break;
1648 case 'x':
1649 format_address = format_address_std;
1650 address_base = 16;
1651 address_pad_len = 6;
1652 break;
1653 case 'n':
1654 format_address = format_address_none;
1655 address_pad_len = 0;
1656 break;
1657 default:
1658 die (EXIT_FAILURE, 0,
1659 _("invalid output address radix '%c';\
1660 it must be one character from [doxn]"),
1661 optarg[0]);
1662 break;
1664 break;
1666 case 'j':
1667 modern = true;
1668 s_err = xstrtoumax (optarg, NULL, 0, &n_bytes_to_skip, multipliers);
1669 if (s_err != LONGINT_OK)
1670 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1671 break;
1673 case 'N':
1674 modern = true;
1675 limit_bytes_to_format = true;
1677 s_err = xstrtoumax (optarg, NULL, 0, &max_bytes_to_format,
1678 multipliers);
1679 if (s_err != LONGINT_OK)
1680 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1681 break;
1683 case 'S':
1684 modern = true;
1685 if (optarg == NULL)
1686 string_min = 3;
1687 else
1689 s_err = xstrtoumax (optarg, NULL, 0, &tmp, multipliers);
1690 if (s_err != LONGINT_OK)
1691 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1693 /* The minimum string length may be no larger than SIZE_MAX,
1694 since we may allocate a buffer of this size. */
1695 if (SIZE_MAX < tmp)
1696 die (EXIT_FAILURE, 0, _("%s is too large"), quote (optarg));
1698 string_min = tmp;
1700 flag_dump_strings = true;
1701 break;
1703 case 't':
1704 modern = true;
1705 ok &= decode_format_string (optarg);
1706 break;
1708 case 'v':
1709 modern = true;
1710 abbreviate_duplicate_blocks = false;
1711 break;
1713 case TRADITIONAL_OPTION:
1714 traditional = true;
1715 break;
1717 case ENDIAN_OPTION:
1718 switch (XARGMATCH ("--endian", optarg, endian_args, endian_types))
1720 case endian_big:
1721 input_swap = ! WORDS_BIGENDIAN;
1722 break;
1723 case endian_little:
1724 input_swap = WORDS_BIGENDIAN;
1725 break;
1727 break;
1729 /* The next several cases map the traditional format
1730 specification options to the corresponding modern format
1731 specs. GNU od accepts any combination of old- and
1732 new-style options. Format specification options accumulate.
1733 The obsolescent and undocumented formats are compatible
1734 with FreeBSD 4.10 od. */
1736 #define CASE_OLD_ARG(old_char,new_string) \
1737 case old_char: \
1738 ok &= decode_format_string (new_string); \
1739 break
1741 CASE_OLD_ARG ('a', "a");
1742 CASE_OLD_ARG ('b', "o1");
1743 CASE_OLD_ARG ('c', "c");
1744 CASE_OLD_ARG ('D', "u4"); /* obsolescent and undocumented */
1745 CASE_OLD_ARG ('d', "u2");
1746 case 'F': /* obsolescent and undocumented alias */
1747 CASE_OLD_ARG ('e', "fD"); /* obsolescent and undocumented */
1748 CASE_OLD_ARG ('f', "fF");
1749 case 'X': /* obsolescent and undocumented alias */
1750 CASE_OLD_ARG ('H', "x4"); /* obsolescent and undocumented */
1751 CASE_OLD_ARG ('i', "dI");
1752 case 'I': case 'L': /* obsolescent and undocumented aliases */
1753 CASE_OLD_ARG ('l', "dL");
1754 CASE_OLD_ARG ('O', "o4"); /* obsolesent and undocumented */
1755 case 'B': /* obsolescent and undocumented alias */
1756 CASE_OLD_ARG ('o', "o2");
1757 CASE_OLD_ARG ('s', "d2");
1758 case 'h': /* obsolescent and undocumented alias */
1759 CASE_OLD_ARG ('x', "x2");
1761 #undef CASE_OLD_ARG
1763 case 'w':
1764 modern = true;
1765 width_specified = true;
1766 if (optarg == NULL)
1768 desired_width = 32;
1770 else
1772 uintmax_t w_tmp;
1773 s_err = xstrtoumax (optarg, NULL, 10, &w_tmp, "");
1774 if (s_err != LONGINT_OK)
1775 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1776 if (SIZE_MAX < w_tmp)
1777 die (EXIT_FAILURE, 0, _("%s is too large"), quote (optarg));
1778 desired_width = w_tmp;
1780 break;
1782 case_GETOPT_HELP_CHAR;
1784 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1786 default:
1787 usage (EXIT_FAILURE);
1788 break;
1792 if (!ok)
1793 return EXIT_FAILURE;
1795 if (flag_dump_strings && n_specs > 0)
1796 die (EXIT_FAILURE, 0,
1797 _("no type may be specified when dumping strings"));
1799 n_files = argc - optind;
1801 /* If the --traditional option is used, there may be from
1802 0 to 3 remaining command line arguments; handle each case
1803 separately.
1804 od [file] [[+]offset[.][b] [[+]label[.][b]]]
1805 The offset and label have the same syntax.
1807 If --traditional is not given, and if no modern options are
1808 given, and if the offset begins with + or (if there are two
1809 operands) a digit, accept only this form, as per POSIX:
1810 od [file] [[+]offset[.][b]]
1813 if (!modern || traditional)
1815 uintmax_t o1;
1816 uintmax_t o2;
1818 switch (n_files)
1820 case 1:
1821 if ((traditional || argv[optind][0] == '+')
1822 && parse_old_offset (argv[optind], &o1))
1824 n_bytes_to_skip = o1;
1825 --n_files;
1826 ++argv;
1828 break;
1830 case 2:
1831 if ((traditional || argv[optind + 1][0] == '+'
1832 || ISDIGIT (argv[optind + 1][0]))
1833 && parse_old_offset (argv[optind + 1], &o2))
1835 if (traditional && parse_old_offset (argv[optind], &o1))
1837 n_bytes_to_skip = o1;
1838 flag_pseudo_start = true;
1839 pseudo_start = o2;
1840 argv += 2;
1841 n_files -= 2;
1843 else
1845 n_bytes_to_skip = o2;
1846 --n_files;
1847 argv[optind + 1] = argv[optind];
1848 ++argv;
1851 break;
1853 case 3:
1854 if (traditional
1855 && parse_old_offset (argv[optind + 1], &o1)
1856 && parse_old_offset (argv[optind + 2], &o2))
1858 n_bytes_to_skip = o1;
1859 flag_pseudo_start = true;
1860 pseudo_start = o2;
1861 argv[optind + 2] = argv[optind];
1862 argv += 2;
1863 n_files -= 2;
1865 break;
1868 if (traditional && 1 < n_files)
1870 error (0, 0, _("extra operand %s"), quote (argv[optind + 1]));
1871 error (0, 0, "%s",
1872 _("compatibility mode supports at most one file"));
1873 usage (EXIT_FAILURE);
1877 if (flag_pseudo_start)
1879 if (format_address == format_address_none)
1881 address_base = 8;
1882 address_pad_len = 7;
1883 format_address = format_address_paren;
1885 else
1886 format_address = format_address_label;
1889 if (limit_bytes_to_format)
1891 end_offset = n_bytes_to_skip + max_bytes_to_format;
1892 if (end_offset < n_bytes_to_skip)
1893 die (EXIT_FAILURE, 0, _("skip-bytes + read-bytes is too large"));
1896 if (n_specs == 0)
1897 decode_format_string ("oS");
1899 if (n_files > 0)
1901 /* Set the global pointer FILE_LIST so that it
1902 references the first file-argument on the command-line. */
1904 file_list = (char const *const *) &argv[optind];
1906 else
1908 /* No files were listed on the command line.
1909 Set the global pointer FILE_LIST so that it
1910 references the null-terminated list of one name: "-". */
1912 file_list = default_file_list;
1915 /* open the first input file */
1916 ok = open_next_file ();
1917 if (in_stream == NULL)
1918 goto cleanup;
1920 /* skip over any unwanted header bytes */
1921 ok &= skip (n_bytes_to_skip);
1922 if (in_stream == NULL)
1923 goto cleanup;
1925 pseudo_offset = (flag_pseudo_start ? pseudo_start - n_bytes_to_skip : 0);
1927 /* Compute output block length. */
1928 l_c_m = get_lcm ();
1930 if (width_specified)
1932 if (desired_width != 0 && desired_width % l_c_m == 0)
1933 bytes_per_block = desired_width;
1934 else
1936 error (0, 0, _("warning: invalid width %lu; using %d instead"),
1937 (unsigned long int) desired_width, l_c_m);
1938 bytes_per_block = l_c_m;
1941 else
1943 if (l_c_m < DEFAULT_BYTES_PER_BLOCK)
1944 bytes_per_block = l_c_m * (DEFAULT_BYTES_PER_BLOCK / l_c_m);
1945 else
1946 bytes_per_block = l_c_m;
1949 /* Compute padding necessary to align output block. */
1950 for (i = 0; i < n_specs; i++)
1952 int fields_per_block = bytes_per_block / width_bytes[spec[i].size];
1953 int block_width = (spec[i].field_width + 1) * fields_per_block;
1954 if (width_per_block < block_width)
1955 width_per_block = block_width;
1957 for (i = 0; i < n_specs; i++)
1959 int fields_per_block = bytes_per_block / width_bytes[spec[i].size];
1960 int block_width = spec[i].field_width * fields_per_block;
1961 spec[i].pad_width = width_per_block - block_width;
1964 #ifdef DEBUG
1965 printf ("lcm=%d, width_per_block=%"PRIuMAX"\n", l_c_m,
1966 (uintmax_t) width_per_block);
1967 for (i = 0; i < n_specs; i++)
1969 int fields_per_block = bytes_per_block / width_bytes[spec[i].size];
1970 assert (bytes_per_block % width_bytes[spec[i].size] == 0);
1971 assert (1 <= spec[i].pad_width / fields_per_block);
1972 printf ("%d: fmt=\"%s\" in_width=%d out_width=%d pad=%d\n",
1973 i, spec[i].fmt_string, width_bytes[spec[i].size],
1974 spec[i].field_width, spec[i].pad_width);
1976 #endif
1978 ok &= (flag_dump_strings ? dump_strings () : dump ());
1980 cleanup:
1982 if (have_read_stdin && fclose (stdin) == EOF)
1983 die (EXIT_FAILURE, errno, _("standard input"));
1985 return ok ? EXIT_SUCCESS : EXIT_FAILURE;