tests: remove a non portable localtime test
[coreutils.git] / src / od.c
blob74f523c57fb83d773d1b8a4471073668452c9293
1 /* od -- dump files in octal and other formats
2 Copyright (C) 1992-2016 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 "error.h"
28 #include "ftoastr.h"
29 #include "quote.h"
30 #include "stat-size.h"
31 #include "xfreopen.h"
32 #include "xprintf.h"
33 #include "xstrtol.h"
35 /* The official name of this program (e.g., no 'g' prefix). */
36 #define PROGRAM_NAME "od"
38 #define AUTHORS proper_name ("Jim Meyering")
40 /* The default number of input bytes per output line. */
41 #define DEFAULT_BYTES_PER_BLOCK 16
43 #if HAVE_UNSIGNED_LONG_LONG_INT
44 typedef unsigned long long int unsigned_long_long_int;
45 #else
46 /* This is just a place-holder to avoid a few '#if' directives.
47 In this case, the type isn't actually used. */
48 typedef unsigned long int unsigned_long_long_int;
49 #endif
51 enum size_spec
53 NO_SIZE,
54 CHAR,
55 SHORT,
56 INT,
57 LONG,
58 LONG_LONG,
59 /* FIXME: add INTMAX support, too */
60 FLOAT_SINGLE,
61 FLOAT_DOUBLE,
62 FLOAT_LONG_DOUBLE,
63 N_SIZE_SPECS
66 enum output_format
68 SIGNED_DECIMAL,
69 UNSIGNED_DECIMAL,
70 OCTAL,
71 HEXADECIMAL,
72 FLOATING_POINT,
73 NAMED_CHARACTER,
74 CHARACTER
77 #define MAX_INTEGRAL_TYPE_SIZE sizeof (unsigned_long_long_int)
79 /* The maximum number of bytes needed for a format string, including
80 the trailing nul. Each format string expects a variable amount of
81 padding (guaranteed to be at least 1 plus the field width), then an
82 element that will be formatted in the field. */
83 enum
85 FMT_BYTES_ALLOCATED =
86 (sizeof "%*.99" - 1
87 + MAX (sizeof "ld",
88 MAX (sizeof PRIdMAX,
89 MAX (sizeof PRIoMAX,
90 MAX (sizeof PRIuMAX,
91 sizeof PRIxMAX)))))
94 /* Ensure that our choice for FMT_BYTES_ALLOCATED is reasonable. */
95 verify (MAX_INTEGRAL_TYPE_SIZE * CHAR_BIT / 3 <= 99);
97 /* Each output format specification (from '-t spec' or from
98 old-style options) is represented by one of these structures. */
99 struct tspec
101 enum output_format fmt;
102 enum size_spec size; /* Type of input object. */
103 /* FIELDS is the number of fields per line, BLANK is the number of
104 fields to leave blank. WIDTH is width of one field, excluding
105 leading space, and PAD is total pad to divide among FIELDS.
106 PAD is at least as large as FIELDS. */
107 void (*print_function) (size_t fields, size_t blank, void const *data,
108 char const *fmt, int width, int pad);
109 char fmt_string[FMT_BYTES_ALLOCATED]; /* Of the style "%*d". */
110 bool hexl_mode_trailer;
111 int field_width; /* Minimum width of a field, excluding leading space. */
112 int pad_width; /* Total padding to be divided among fields. */
115 /* Convert the number of 8-bit bytes of a binary representation to
116 the number of characters (digits + sign if the type is signed)
117 required to represent the same quantity in the specified base/type.
118 For example, a 32-bit (4-byte) quantity may require a field width
119 as wide as the following for these types:
120 11 unsigned octal
121 11 signed decimal
122 10 unsigned decimal
123 8 unsigned hexadecimal */
125 static unsigned int const bytes_to_oct_digits[] =
126 {0, 3, 6, 8, 11, 14, 16, 19, 22, 25, 27, 30, 32, 35, 38, 41, 43};
128 static unsigned int const bytes_to_signed_dec_digits[] =
129 {1, 4, 6, 8, 11, 13, 16, 18, 20, 23, 25, 28, 30, 33, 35, 37, 40};
131 static unsigned int const bytes_to_unsigned_dec_digits[] =
132 {0, 3, 5, 8, 10, 13, 15, 17, 20, 22, 25, 27, 29, 32, 34, 37, 39};
134 static unsigned int const bytes_to_hex_digits[] =
135 {0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32};
137 /* It'll be a while before we see integral types wider than 16 bytes,
138 but if/when it happens, this check will catch it. Without this check,
139 a wider type would provoke a buffer overrun. */
140 verify (MAX_INTEGRAL_TYPE_SIZE < ARRAY_CARDINALITY (bytes_to_hex_digits));
142 /* Make sure the other arrays have the same length. */
143 verify (sizeof bytes_to_oct_digits == sizeof bytes_to_signed_dec_digits);
144 verify (sizeof bytes_to_oct_digits == sizeof bytes_to_unsigned_dec_digits);
145 verify (sizeof bytes_to_oct_digits == sizeof bytes_to_hex_digits);
147 /* Convert enum size_spec to the size of the named type. */
148 static const int width_bytes[] =
151 sizeof (char),
152 sizeof (short int),
153 sizeof (int),
154 sizeof (long int),
155 sizeof (unsigned_long_long_int),
156 sizeof (float),
157 sizeof (double),
158 sizeof (long double)
161 /* Ensure that for each member of 'enum size_spec' there is an
162 initializer in the width_bytes array. */
163 verify (ARRAY_CARDINALITY (width_bytes) == N_SIZE_SPECS);
165 /* Names for some non-printing characters. */
166 static char const charname[33][4] =
168 "nul", "soh", "stx", "etx", "eot", "enq", "ack", "bel",
169 "bs", "ht", "nl", "vt", "ff", "cr", "so", "si",
170 "dle", "dc1", "dc2", "dc3", "dc4", "nak", "syn", "etb",
171 "can", "em", "sub", "esc", "fs", "gs", "rs", "us",
172 "sp"
175 /* Address base (8, 10 or 16). */
176 static int address_base;
178 /* The number of octal digits required to represent the largest
179 address value. */
180 #define MAX_ADDRESS_LENGTH \
181 ((sizeof (uintmax_t) * CHAR_BIT + CHAR_BIT - 1) / 3)
183 /* Width of a normal address. */
184 static int address_pad_len;
186 /* Minimum length when detecting --strings. */
187 static size_t string_min;
189 /* True when in --strings mode. */
190 static bool flag_dump_strings;
192 /* True if we should recognize the older non-option arguments
193 that specified at most one file and optional arguments specifying
194 offset and pseudo-start address. */
195 static bool traditional;
197 /* True if an old-style 'pseudo-address' was specified. */
198 static bool flag_pseudo_start;
200 /* The difference between the old-style pseudo starting address and
201 the number of bytes to skip. */
202 static uintmax_t pseudo_offset;
204 /* Function that accepts an address and an optional following char,
205 and prints the address and char to stdout. */
206 static void (*format_address) (uintmax_t, char);
208 /* The number of input bytes to skip before formatting and writing. */
209 static uintmax_t n_bytes_to_skip = 0;
211 /* When false, MAX_BYTES_TO_FORMAT and END_OFFSET are ignored, and all
212 input is formatted. */
213 static bool limit_bytes_to_format = false;
215 /* The maximum number of bytes that will be formatted. */
216 static uintmax_t max_bytes_to_format;
218 /* The offset of the first byte after the last byte to be formatted. */
219 static uintmax_t end_offset;
221 /* When true and two or more consecutive blocks are equal, format
222 only the first block and output an asterisk alone on the following
223 line to indicate that identical blocks have been elided. */
224 static bool abbreviate_duplicate_blocks = true;
226 /* An array of specs describing how to format each input block. */
227 static struct tspec *spec;
229 /* The number of format specs. */
230 static size_t n_specs;
232 /* The allocated length of SPEC. */
233 static size_t n_specs_allocated;
235 /* The number of input bytes formatted per output line. It must be
236 a multiple of the least common multiple of the sizes associated with
237 the specified output types. It should be as large as possible, but
238 no larger than 16 -- unless specified with the -w option. */
239 static size_t bytes_per_block;
241 /* Human-readable representation of *file_list (for error messages).
242 It differs from file_list[-1] only when file_list[-1] is "-". */
243 static char const *input_filename;
245 /* A NULL-terminated list of the file-arguments from the command line. */
246 static char const *const *file_list;
248 /* Initializer for file_list if no file-arguments
249 were specified on the command line. */
250 static char const *const default_file_list[] = {"-", NULL};
252 /* The input stream associated with the current file. */
253 static FILE *in_stream;
255 /* If true, at least one of the files we read was standard input. */
256 static bool have_read_stdin;
258 /* Map the size in bytes to a type identifier. */
259 static enum size_spec integral_type_size[MAX_INTEGRAL_TYPE_SIZE + 1];
261 #define MAX_FP_TYPE_SIZE sizeof (long double)
262 static enum size_spec fp_type_size[MAX_FP_TYPE_SIZE + 1];
264 #ifndef WORDS_BIGENDIAN
265 # define WORDS_BIGENDIAN 0
266 #endif
268 /* Use native endianess by default. */
269 static bool input_swap;
271 static char const short_options[] = "A:aBbcDdeFfHhIij:LlN:OoS:st:vw::Xx";
273 /* For long options that have no equivalent short option, use a
274 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
275 enum
277 TRADITIONAL_OPTION = CHAR_MAX + 1,
278 ENDIAN_OPTION,
281 enum endian_type
283 endian_little,
284 endian_big
287 static char const *const endian_args[] =
289 "little", "big", NULL
292 static enum endian_type const endian_types[] =
294 endian_little, endian_big
297 static struct option const long_options[] =
299 {"skip-bytes", required_argument, NULL, 'j'},
300 {"address-radix", required_argument, NULL, 'A'},
301 {"read-bytes", required_argument, NULL, 'N'},
302 {"format", required_argument, NULL, 't'},
303 {"output-duplicates", no_argument, NULL, 'v'},
304 {"strings", optional_argument, NULL, 'S'},
305 {"traditional", no_argument, NULL, TRADITIONAL_OPTION},
306 {"width", optional_argument, NULL, 'w'},
307 {"endian", required_argument, NULL, ENDIAN_OPTION },
309 {GETOPT_HELP_OPTION_DECL},
310 {GETOPT_VERSION_OPTION_DECL},
311 {NULL, 0, NULL, 0}
314 void
315 usage (int status)
317 if (status != EXIT_SUCCESS)
318 emit_try_help ();
319 else
321 printf (_("\
322 Usage: %s [OPTION]... [FILE]...\n\
323 or: %s [-abcdfilosx]... [FILE] [[+]OFFSET[.][b]]\n\
324 or: %s --traditional [OPTION]... [FILE] [[+]OFFSET[.][b] [+][LABEL][.][b]]\n\
326 program_name, program_name, program_name);
327 fputs (_("\n\
328 Write an unambiguous representation, octal bytes by default,\n\
329 of FILE to standard output. With more than one FILE argument,\n\
330 concatenate them in the listed order to form the input.\n\
331 "), stdout);
333 emit_stdin_note ();
335 fputs (_("\
337 If first and second call formats both apply, the second format is assumed\n\
338 if the last operand begins with + or (if there are 2 operands) a digit.\n\
339 An OFFSET operand means -j OFFSET. LABEL is the pseudo-address\n\
340 at first byte printed, incremented when dump is progressing.\n\
341 For OFFSET and LABEL, a 0x or 0X prefix indicates hexadecimal;\n\
342 suffixes may be . for octal and b for multiply by 512.\n\
343 "), stdout);
345 emit_mandatory_arg_note ();
347 fputs (_("\
348 -A, --address-radix=RADIX output format for file offsets; RADIX is one\n\
349 of [doxn], for Decimal, Octal, Hex or None\n\
350 --endian={big|little} swap input bytes according the specified order\n\
351 -j, --skip-bytes=BYTES skip BYTES input bytes first\n\
352 "), stdout);
353 fputs (_("\
354 -N, --read-bytes=BYTES limit dump to BYTES input bytes\n\
355 -S BYTES, --strings[=BYTES] output strings of at least BYTES graphic chars;\
357 3 is implied when BYTES is not specified\n\
358 -t, --format=TYPE select output format or formats\n\
359 -v, --output-duplicates do not use * to mark line suppression\n\
360 -w[BYTES], --width[=BYTES] output BYTES bytes per output line;\n\
361 32 is implied when BYTES is not specified\n\
362 --traditional accept arguments in third form above\n\
363 "), stdout);
364 fputs (HELP_OPTION_DESCRIPTION, stdout);
365 fputs (VERSION_OPTION_DESCRIPTION, stdout);
366 fputs (_("\
369 Traditional format specifications may be intermixed; they accumulate:\n\
370 -a same as -t a, select named characters, ignoring high-order bit\n\
371 -b same as -t o1, select octal bytes\n\
372 -c same as -t c, select printable characters or backslash escapes\n\
373 -d same as -t u2, select unsigned decimal 2-byte units\n\
374 "), stdout);
375 fputs (_("\
376 -f same as -t fF, select floats\n\
377 -i same as -t dI, select decimal ints\n\
378 -l same as -t dL, select decimal longs\n\
379 -o same as -t o2, select octal 2-byte units\n\
380 -s same as -t d2, select decimal 2-byte units\n\
381 -x same as -t x2, select hexadecimal 2-byte units\n\
382 "), stdout);
383 fputs (_("\
386 TYPE is made up of one or more of these specifications:\n\
387 a named character, ignoring high-order bit\n\
388 c printable character or backslash escape\n\
389 "), stdout);
390 fputs (_("\
391 d[SIZE] signed decimal, SIZE bytes per integer\n\
392 f[SIZE] floating point, SIZE bytes per integer\n\
393 o[SIZE] octal, SIZE bytes per integer\n\
394 u[SIZE] unsigned decimal, SIZE bytes per integer\n\
395 x[SIZE] hexadecimal, SIZE bytes per integer\n\
396 "), stdout);
397 fputs (_("\
399 SIZE is a number. For TYPE in [doux], SIZE may also be C for\n\
400 sizeof(char), S for sizeof(short), I for sizeof(int) or L for\n\
401 sizeof(long). If TYPE is f, SIZE may also be F for sizeof(float), D\n\
402 for sizeof(double) or L for sizeof(long double).\n\
403 "), stdout);
404 fputs (_("\
406 Adding a z suffix to any type displays printable characters at the end of\n\
407 each output line.\n\
408 "), stdout);
409 fputs (_("\
412 BYTES is hex with 0x or 0X prefix, and may have a multiplier suffix:\n\
413 b 512\n\
414 KB 1000\n\
415 K 1024\n\
416 MB 1000*1000\n\
417 M 1024*1024\n\
418 and so on for G, T, P, E, Z, Y.\n\
419 "), stdout);
420 emit_ancillary_info (PROGRAM_NAME);
422 exit (status);
425 /* Define the print functions. */
427 #define PRINT_FIELDS(N, T, FMT_STRING, ACTION) \
428 static void \
429 N (size_t fields, size_t blank, void const *block, \
430 char const *FMT_STRING, int width, int pad) \
432 T const *p = block; \
433 uintmax_t i; \
434 int pad_remaining = pad; \
435 for (i = fields; blank < i; i--) \
437 int next_pad = pad * (i - 1) / fields; \
438 int adjusted_width = pad_remaining - next_pad + width; \
439 T x; \
440 if (input_swap && sizeof (T) > 1) \
442 size_t j; \
443 union { \
444 T x; \
445 char b[sizeof (T)]; \
446 } u; \
447 for (j = 0; j < sizeof (T); j++) \
448 u.b[j] = ((const char *) p)[sizeof (T) - 1 - j]; \
449 x = u.x; \
451 else \
452 x = *p; \
453 p++; \
454 ACTION; \
455 pad_remaining = next_pad; \
459 #define PRINT_TYPE(N, T) \
460 PRINT_FIELDS (N, T, fmt_string, xprintf (fmt_string, adjusted_width, x))
462 #define PRINT_FLOATTYPE(N, T, FTOASTR, BUFSIZE) \
463 PRINT_FIELDS (N, T, fmt_string _GL_UNUSED, \
464 char buf[BUFSIZE]; \
465 FTOASTR (buf, sizeof buf, 0, 0, x); \
466 xprintf ("%*s", adjusted_width, buf))
468 PRINT_TYPE (print_s_char, signed char)
469 PRINT_TYPE (print_char, unsigned char)
470 PRINT_TYPE (print_s_short, short int)
471 PRINT_TYPE (print_short, unsigned short int)
472 PRINT_TYPE (print_int, unsigned int)
473 PRINT_TYPE (print_long, unsigned long int)
474 PRINT_TYPE (print_long_long, unsigned_long_long_int)
476 PRINT_FLOATTYPE (print_float, float, ftoastr, FLT_BUFSIZE_BOUND)
477 PRINT_FLOATTYPE (print_double, double, dtoastr, DBL_BUFSIZE_BOUND)
478 PRINT_FLOATTYPE (print_long_double, long double, ldtoastr, LDBL_BUFSIZE_BOUND)
480 #undef PRINT_TYPE
481 #undef PRINT_FLOATTYPE
483 static void
484 dump_hexl_mode_trailer (size_t n_bytes, const char *block)
486 size_t i;
487 fputs (" >", stdout);
488 for (i = n_bytes; i > 0; i--)
490 unsigned char c = *block++;
491 unsigned char c2 = (isprint (c) ? c : '.');
492 putchar (c2);
494 putchar ('<');
497 static void
498 print_named_ascii (size_t fields, size_t blank, void const *block,
499 const char *unused_fmt_string _GL_UNUSED,
500 int width, int pad)
502 unsigned char const *p = block;
503 uintmax_t i;
504 int pad_remaining = pad;
505 for (i = fields; blank < i; i--)
507 int next_pad = pad * (i - 1) / fields;
508 int masked_c = *p++ & 0x7f;
509 const char *s;
510 char buf[2];
512 if (masked_c == 127)
513 s = "del";
514 else if (masked_c <= 040)
515 s = charname[masked_c];
516 else
518 buf[0] = masked_c;
519 buf[1] = 0;
520 s = buf;
523 xprintf ("%*s", pad_remaining - next_pad + width, s);
524 pad_remaining = next_pad;
528 static void
529 print_ascii (size_t fields, size_t blank, void const *block,
530 const char *unused_fmt_string _GL_UNUSED, int width,
531 int pad)
533 unsigned char const *p = block;
534 uintmax_t i;
535 int pad_remaining = pad;
536 for (i = fields; blank < i; i--)
538 int next_pad = pad * (i - 1) / fields;
539 unsigned char c = *p++;
540 const char *s;
541 char buf[4];
543 switch (c)
545 case '\0':
546 s = "\\0";
547 break;
549 case '\a':
550 s = "\\a";
551 break;
553 case '\b':
554 s = "\\b";
555 break;
557 case '\f':
558 s = "\\f";
559 break;
561 case '\n':
562 s = "\\n";
563 break;
565 case '\r':
566 s = "\\r";
567 break;
569 case '\t':
570 s = "\\t";
571 break;
573 case '\v':
574 s = "\\v";
575 break;
577 default:
578 sprintf (buf, (isprint (c) ? "%c" : "%03o"), c);
579 s = buf;
582 xprintf ("%*s", pad_remaining - next_pad + width, s);
583 pad_remaining = next_pad;
587 /* Convert a null-terminated (possibly zero-length) string S to an
588 unsigned long integer value. If S points to a non-digit set *P to S,
589 *VAL to 0, and return true. Otherwise, accumulate the integer value of
590 the string of digits. If the string of digits represents a value
591 larger than ULONG_MAX, don't modify *VAL or *P and return false.
592 Otherwise, advance *P to the first non-digit after S, set *VAL to
593 the result of the conversion and return true. */
595 static bool
596 simple_strtoul (const char *s, const char **p, unsigned long int *val)
598 unsigned long int sum;
600 sum = 0;
601 while (ISDIGIT (*s))
603 int c = *s++ - '0';
604 if (sum > (ULONG_MAX - c) / 10)
605 return false;
606 sum = sum * 10 + c;
608 *p = s;
609 *val = sum;
610 return true;
613 /* If S points to a single valid modern od format string, put
614 a description of that format in *TSPEC, make *NEXT point at the
615 character following the just-decoded format (if *NEXT is non-NULL),
616 and return true. If S is not valid, don't modify *NEXT or *TSPEC,
617 give a diagnostic, and return false. For example, if S were
618 "d4afL" *NEXT would be set to "afL" and *TSPEC would be
620 fmt = SIGNED_DECIMAL;
621 size = INT or LONG; (whichever integral_type_size[4] resolves to)
622 print_function = print_int; (assuming size == INT)
623 field_width = 11;
624 fmt_string = "%*d";
626 pad_width is determined later, but is at least as large as the
627 number of fields printed per row.
628 S_ORIG is solely for reporting errors. It should be the full format
629 string argument.
632 static bool
633 decode_one_format (const char *s_orig, const char *s, const char **next,
634 struct tspec *tspec)
636 enum size_spec size_spec;
637 unsigned long int size;
638 enum output_format fmt;
639 void (*print_function) (size_t, size_t, void const *, char const *,
640 int, int);
641 const char *p;
642 char c;
643 int field_width;
645 assert (tspec != NULL);
647 switch (*s)
649 case 'd':
650 case 'o':
651 case 'u':
652 case 'x':
653 c = *s;
654 ++s;
655 switch (*s)
657 case 'C':
658 ++s;
659 size = sizeof (char);
660 break;
662 case 'S':
663 ++s;
664 size = sizeof (short int);
665 break;
667 case 'I':
668 ++s;
669 size = sizeof (int);
670 break;
672 case 'L':
673 ++s;
674 size = sizeof (long int);
675 break;
677 default:
678 if (! simple_strtoul (s, &p, &size))
680 /* The integer at P in S would overflow an unsigned long int.
681 A digit string that long is sufficiently odd looking
682 that the following diagnostic is sufficient. */
683 error (0, 0, _("invalid type string %s"), quote (s_orig));
684 return false;
686 if (p == s)
687 size = sizeof (int);
688 else
690 if (MAX_INTEGRAL_TYPE_SIZE < size
691 || integral_type_size[size] == NO_SIZE)
693 error (0, 0, _("invalid type string %s;\nthis system"
694 " doesn't provide a %lu-byte integral type"),
695 quote (s_orig), size);
696 return false;
698 s = p;
700 break;
703 #define ISPEC_TO_FORMAT(Spec, Min_format, Long_format, Max_format) \
704 ((Spec) == LONG_LONG ? (Max_format) \
705 : ((Spec) == LONG ? (Long_format) \
706 : (Min_format))) \
708 size_spec = integral_type_size[size];
710 switch (c)
712 case 'd':
713 fmt = SIGNED_DECIMAL;
714 field_width = bytes_to_signed_dec_digits[size];
715 sprintf (tspec->fmt_string, "%%*%s",
716 ISPEC_TO_FORMAT (size_spec, "d", "ld", PRIdMAX));
717 break;
719 case 'o':
720 fmt = OCTAL;
721 sprintf (tspec->fmt_string, "%%*.%d%s",
722 (field_width = bytes_to_oct_digits[size]),
723 ISPEC_TO_FORMAT (size_spec, "o", "lo", PRIoMAX));
724 break;
726 case 'u':
727 fmt = UNSIGNED_DECIMAL;
728 field_width = bytes_to_unsigned_dec_digits[size];
729 sprintf (tspec->fmt_string, "%%*%s",
730 ISPEC_TO_FORMAT (size_spec, "u", "lu", PRIuMAX));
731 break;
733 case 'x':
734 fmt = HEXADECIMAL;
735 sprintf (tspec->fmt_string, "%%*.%d%s",
736 (field_width = bytes_to_hex_digits[size]),
737 ISPEC_TO_FORMAT (size_spec, "x", "lx", PRIxMAX));
738 break;
740 default:
741 abort ();
744 assert (strlen (tspec->fmt_string) < FMT_BYTES_ALLOCATED);
746 switch (size_spec)
748 case CHAR:
749 print_function = (fmt == SIGNED_DECIMAL
750 ? print_s_char
751 : print_char);
752 break;
754 case SHORT:
755 print_function = (fmt == SIGNED_DECIMAL
756 ? print_s_short
757 : print_short);
758 break;
760 case INT:
761 print_function = print_int;
762 break;
764 case LONG:
765 print_function = print_long;
766 break;
768 case LONG_LONG:
769 print_function = print_long_long;
770 break;
772 default:
773 abort ();
775 break;
777 case 'f':
778 fmt = FLOATING_POINT;
779 ++s;
780 switch (*s)
782 case 'F':
783 ++s;
784 size = sizeof (float);
785 break;
787 case 'D':
788 ++s;
789 size = sizeof (double);
790 break;
792 case 'L':
793 ++s;
794 size = sizeof (long double);
795 break;
797 default:
798 if (! simple_strtoul (s, &p, &size))
800 /* The integer at P in S would overflow an unsigned long int.
801 A digit string that long is sufficiently odd looking
802 that the following diagnostic is sufficient. */
803 error (0, 0, _("invalid type string %s"), quote (s_orig));
804 return false;
806 if (p == s)
807 size = sizeof (double);
808 else
810 if (size > MAX_FP_TYPE_SIZE
811 || fp_type_size[size] == NO_SIZE)
813 error (0, 0,
814 _("invalid type string %s;\n"
815 "this system doesn't provide a %lu-byte"
816 " floating point type"),
817 quote (s_orig), size);
818 return false;
820 s = p;
822 break;
824 size_spec = fp_type_size[size];
827 struct lconv const *locale = localeconv ();
828 size_t decimal_point_len =
829 (locale->decimal_point[0] ? strlen (locale->decimal_point) : 1);
831 switch (size_spec)
833 case FLOAT_SINGLE:
834 print_function = print_float;
835 field_width = FLT_STRLEN_BOUND_L (decimal_point_len);
836 break;
838 case FLOAT_DOUBLE:
839 print_function = print_double;
840 field_width = DBL_STRLEN_BOUND_L (decimal_point_len);
841 break;
843 case FLOAT_LONG_DOUBLE:
844 print_function = print_long_double;
845 field_width = LDBL_STRLEN_BOUND_L (decimal_point_len);
846 break;
848 default:
849 abort ();
852 break;
855 case 'a':
856 ++s;
857 fmt = NAMED_CHARACTER;
858 size_spec = CHAR;
859 print_function = print_named_ascii;
860 field_width = 3;
861 break;
863 case 'c':
864 ++s;
865 fmt = CHARACTER;
866 size_spec = CHAR;
867 print_function = print_ascii;
868 field_width = 3;
869 break;
871 default:
872 error (0, 0, _("invalid character '%c' in type string %s"),
873 *s, quote (s_orig));
874 return false;
877 tspec->size = size_spec;
878 tspec->fmt = fmt;
879 tspec->print_function = print_function;
881 tspec->field_width = field_width;
882 tspec->hexl_mode_trailer = (*s == 'z');
883 if (tspec->hexl_mode_trailer)
884 s++;
886 if (next != NULL)
887 *next = s;
889 return true;
892 /* Given a list of one or more input filenames FILE_LIST, set the global
893 file pointer IN_STREAM and the global string INPUT_FILENAME to the
894 first one that can be successfully opened. Modify FILE_LIST to
895 reference the next filename in the list. A file name of "-" is
896 interpreted as standard input. If any file open fails, give an error
897 message and return false. */
899 static bool
900 open_next_file (void)
902 bool ok = true;
906 input_filename = *file_list;
907 if (input_filename == NULL)
908 return ok;
909 ++file_list;
911 if (STREQ (input_filename, "-"))
913 input_filename = _("standard input");
914 in_stream = stdin;
915 have_read_stdin = true;
916 if (O_BINARY && ! isatty (STDIN_FILENO))
917 xfreopen (NULL, "rb", stdin);
919 else
921 in_stream = fopen (input_filename, (O_BINARY ? "rb" : "r"));
922 if (in_stream == NULL)
924 error (0, errno, "%s", quotef (input_filename));
925 ok = false;
929 while (in_stream == NULL);
931 if (limit_bytes_to_format && !flag_dump_strings)
932 setvbuf (in_stream, NULL, _IONBF, 0);
934 return ok;
937 /* Test whether there have been errors on in_stream, and close it if
938 it is not standard input. Return false if there has been an error
939 on in_stream or stdout; return true otherwise. This function will
940 report more than one error only if both a read and a write error
941 have occurred. IN_ERRNO, if nonzero, is the error number
942 corresponding to the most recent action for IN_STREAM. */
944 static bool
945 check_and_close (int in_errno)
947 bool ok = true;
949 if (in_stream != NULL)
951 if (ferror (in_stream))
953 error (0, in_errno, _("%s: read error"), quotef (input_filename));
954 if (! STREQ (file_list[-1], "-"))
955 fclose (in_stream);
956 ok = false;
958 else if (! STREQ (file_list[-1], "-") && fclose (in_stream) != 0)
960 error (0, errno, "%s", quotef (input_filename));
961 ok = false;
964 in_stream = NULL;
967 if (ferror (stdout))
969 error (0, 0, _("write error"));
970 ok = false;
973 return ok;
976 /* Decode the modern od format string S. Append the decoded
977 representation to the global array SPEC, reallocating SPEC if
978 necessary. Return true if S is valid. */
980 static bool
981 decode_format_string (const char *s)
983 const char *s_orig = s;
984 assert (s != NULL);
986 while (*s != '\0')
988 const char *next;
990 if (n_specs_allocated <= n_specs)
991 spec = X2NREALLOC (spec, &n_specs_allocated);
993 if (! decode_one_format (s_orig, s, &next, &spec[n_specs]))
994 return false;
996 assert (s != next);
997 s = next;
998 ++n_specs;
1001 return true;
1004 /* Given a list of one or more input filenames FILE_LIST, set the global
1005 file pointer IN_STREAM to position N_SKIP in the concatenation of
1006 those files. If any file operation fails or if there are fewer than
1007 N_SKIP bytes in the combined input, give an error message and return
1008 false. When possible, use seek rather than read operations to
1009 advance IN_STREAM. */
1011 static bool
1012 skip (uintmax_t n_skip)
1014 bool ok = true;
1015 int in_errno = 0;
1017 if (n_skip == 0)
1018 return true;
1020 while (in_stream != NULL) /* EOF. */
1022 struct stat file_stats;
1024 /* First try seeking. For large offsets, this extra work is
1025 worthwhile. If the offset is below some threshold it may be
1026 more efficient to move the pointer by reading. There are two
1027 issues when trying to seek:
1028 - the file must be seekable.
1029 - before seeking to the specified position, make sure
1030 that the new position is in the current file.
1031 Try to do that by getting file's size using fstat.
1032 But that will work only for regular files. */
1034 if (fstat (fileno (in_stream), &file_stats) == 0)
1036 /* The st_size field is valid for regular files.
1037 If the number of bytes left to skip is larger than
1038 the size of the current file, we can decrement n_skip
1039 and go on to the next file. Skip this optimization also
1040 when st_size is no greater than the block size, because
1041 some kernels report nonsense small file sizes for
1042 proc-like file systems. */
1043 if (usable_st_size (&file_stats)
1044 && ST_BLKSIZE (file_stats) < file_stats.st_size)
1046 if ((uintmax_t) file_stats.st_size < n_skip)
1047 n_skip -= file_stats.st_size;
1048 else
1050 if (fseeko (in_stream, n_skip, SEEK_CUR) != 0)
1052 in_errno = errno;
1053 ok = false;
1055 n_skip = 0;
1059 /* If it's not a regular file with nonnegative size,
1060 or if it's so small that it might be in a proc-like file system,
1061 position the file pointer by reading. */
1063 else
1065 char buf[BUFSIZ];
1066 size_t n_bytes_read, n_bytes_to_read = BUFSIZ;
1068 while (0 < n_skip)
1070 if (n_skip < n_bytes_to_read)
1071 n_bytes_to_read = n_skip;
1072 n_bytes_read = fread (buf, 1, n_bytes_to_read, in_stream);
1073 n_skip -= n_bytes_read;
1074 if (n_bytes_read != n_bytes_to_read)
1076 if (ferror (in_stream))
1078 in_errno = errno;
1079 ok = false;
1080 n_skip = 0;
1081 break;
1083 if (feof (in_stream))
1084 break;
1089 if (n_skip == 0)
1090 break;
1093 else /* cannot fstat() file */
1095 error (0, errno, "%s", quotef (input_filename));
1096 ok = false;
1099 ok &= check_and_close (in_errno);
1101 ok &= open_next_file ();
1104 if (n_skip != 0)
1105 error (EXIT_FAILURE, 0, _("cannot skip past end of combined input"));
1107 return ok;
1110 static void
1111 format_address_none (uintmax_t address _GL_UNUSED,
1112 char c _GL_UNUSED)
1116 static void
1117 format_address_std (uintmax_t address, char c)
1119 char buf[MAX_ADDRESS_LENGTH + 2];
1120 char *p = buf + sizeof buf;
1121 char const *pbound;
1123 *--p = '\0';
1124 *--p = c;
1125 pbound = p - address_pad_len;
1127 /* Use a special case of the code for each base. This is measurably
1128 faster than generic code. */
1129 switch (address_base)
1131 case 8:
1133 *--p = '0' + (address & 7);
1134 while ((address >>= 3) != 0);
1135 break;
1137 case 10:
1139 *--p = '0' + (address % 10);
1140 while ((address /= 10) != 0);
1141 break;
1143 case 16:
1145 *--p = "0123456789abcdef"[address & 15];
1146 while ((address >>= 4) != 0);
1147 break;
1150 while (pbound < p)
1151 *--p = '0';
1153 fputs (p, stdout);
1156 static void
1157 format_address_paren (uintmax_t address, char c)
1159 putchar ('(');
1160 format_address_std (address, ')');
1161 if (c)
1162 putchar (c);
1165 static void
1166 format_address_label (uintmax_t address, char c)
1168 format_address_std (address, ' ');
1169 format_address_paren (address + pseudo_offset, c);
1172 /* Write N_BYTES bytes from CURR_BLOCK to standard output once for each
1173 of the N_SPEC format specs. CURRENT_OFFSET is the byte address of
1174 CURR_BLOCK in the concatenation of input files, and it is printed
1175 (optionally) only before the output line associated with the first
1176 format spec. When duplicate blocks are being abbreviated, the output
1177 for a sequence of identical input blocks is the output for the first
1178 block followed by an asterisk alone on a line. It is valid to compare
1179 the blocks PREV_BLOCK and CURR_BLOCK only when N_BYTES == BYTES_PER_BLOCK.
1180 That condition may be false only for the last input block. */
1182 static void
1183 write_block (uintmax_t current_offset, size_t n_bytes,
1184 const char *prev_block, const char *curr_block)
1186 static bool first = true;
1187 static bool prev_pair_equal = false;
1189 #define EQUAL_BLOCKS(b1, b2) (memcmp (b1, b2, bytes_per_block) == 0)
1191 if (abbreviate_duplicate_blocks
1192 && !first && n_bytes == bytes_per_block
1193 && EQUAL_BLOCKS (prev_block, curr_block))
1195 if (prev_pair_equal)
1197 /* The two preceding blocks were equal, and the current
1198 block is the same as the last one, so print nothing. */
1200 else
1202 printf ("*\n");
1203 prev_pair_equal = true;
1206 else
1208 size_t i;
1210 prev_pair_equal = false;
1211 for (i = 0; i < n_specs; i++)
1213 int datum_width = width_bytes[spec[i].size];
1214 int fields_per_block = bytes_per_block / datum_width;
1215 int blank_fields = (bytes_per_block - n_bytes) / datum_width;
1216 if (i == 0)
1217 format_address (current_offset, '\0');
1218 else
1219 printf ("%*s", address_pad_len, "");
1220 (*spec[i].print_function) (fields_per_block, blank_fields,
1221 curr_block, spec[i].fmt_string,
1222 spec[i].field_width, spec[i].pad_width);
1223 if (spec[i].hexl_mode_trailer)
1225 /* space-pad out to full line width, then dump the trailer */
1226 int field_width = spec[i].field_width;
1227 int pad_width = (spec[i].pad_width * blank_fields
1228 / fields_per_block);
1229 printf ("%*s", blank_fields * field_width + pad_width, "");
1230 dump_hexl_mode_trailer (n_bytes, curr_block);
1232 putchar ('\n');
1235 first = false;
1238 /* Read a single byte into *C from the concatenation of the input files
1239 named in the global array FILE_LIST. On the first call to this
1240 function, the global variable IN_STREAM is expected to be an open
1241 stream associated with the input file INPUT_FILENAME. If IN_STREAM
1242 is at end-of-file, close it and update the global variables IN_STREAM
1243 and INPUT_FILENAME so they correspond to the next file in the list.
1244 Then try to read a byte from the newly opened file. Repeat if
1245 necessary until EOF is reached for the last file in FILE_LIST, then
1246 set *C to EOF and return. Subsequent calls do likewise. Return
1247 true if successful. */
1249 static bool
1250 read_char (int *c)
1252 bool ok = true;
1254 *c = EOF;
1256 while (in_stream != NULL) /* EOF. */
1258 *c = fgetc (in_stream);
1260 if (*c != EOF)
1261 break;
1263 ok &= check_and_close (errno);
1265 ok &= open_next_file ();
1268 return ok;
1271 /* Read N bytes into BLOCK from the concatenation of the input files
1272 named in the global array FILE_LIST. On the first call to this
1273 function, the global variable IN_STREAM is expected to be an open
1274 stream associated with the input file INPUT_FILENAME. If all N
1275 bytes cannot be read from IN_STREAM, close IN_STREAM and update
1276 the global variables IN_STREAM and INPUT_FILENAME. Then try to
1277 read the remaining bytes from the newly opened file. Repeat if
1278 necessary until EOF is reached for the last file in FILE_LIST.
1279 On subsequent calls, don't modify BLOCK and return true. Set
1280 *N_BYTES_IN_BUFFER to the number of bytes read. If an error occurs,
1281 it will be detected through ferror when the stream is about to be
1282 closed. If there is an error, give a message but continue reading
1283 as usual and return false. Otherwise return true. */
1285 static bool
1286 read_block (size_t n, char *block, size_t *n_bytes_in_buffer)
1288 bool ok = true;
1290 assert (0 < n && n <= bytes_per_block);
1292 *n_bytes_in_buffer = 0;
1294 while (in_stream != NULL) /* EOF. */
1296 size_t n_needed;
1297 size_t n_read;
1299 n_needed = n - *n_bytes_in_buffer;
1300 n_read = fread (block + *n_bytes_in_buffer, 1, n_needed, in_stream);
1302 *n_bytes_in_buffer += n_read;
1304 if (n_read == n_needed)
1305 break;
1307 ok &= check_and_close (errno);
1309 ok &= open_next_file ();
1312 return ok;
1315 /* Return the least common multiple of the sizes associated
1316 with the format specs. */
1318 static int _GL_ATTRIBUTE_PURE
1319 get_lcm (void)
1321 size_t i;
1322 int l_c_m = 1;
1324 for (i = 0; i < n_specs; i++)
1325 l_c_m = lcm (l_c_m, width_bytes[spec[i].size]);
1326 return l_c_m;
1329 /* If S is a valid traditional offset specification with an optional
1330 leading '+' return true and set *OFFSET to the offset it denotes. */
1332 static bool
1333 parse_old_offset (const char *s, uintmax_t *offset)
1335 int radix;
1337 if (*s == '\0')
1338 return false;
1340 /* Skip over any leading '+'. */
1341 if (s[0] == '+')
1342 ++s;
1344 /* Determine the radix we'll use to interpret S. If there is a '.',
1345 it's decimal, otherwise, if the string begins with '0X'or '0x',
1346 it's hexadecimal, else octal. */
1347 if (strchr (s, '.') != NULL)
1348 radix = 10;
1349 else
1351 if (s[0] == '0' && (s[1] == 'x' || s[1] == 'X'))
1352 radix = 16;
1353 else
1354 radix = 8;
1357 return xstrtoumax (s, NULL, radix, offset, "Bb") == LONGINT_OK;
1360 /* Read a chunk of size BYTES_PER_BLOCK from the input files, write the
1361 formatted block to standard output, and repeat until the specified
1362 maximum number of bytes has been read or until all input has been
1363 processed. If the last block read is smaller than BYTES_PER_BLOCK
1364 and its size is not a multiple of the size associated with a format
1365 spec, extend the input block with zero bytes until its length is a
1366 multiple of all format spec sizes. Write the final block. Finally,
1367 write on a line by itself the offset of the byte after the last byte
1368 read. Accumulate return values from calls to read_block and
1369 check_and_close, and if any was false, return false.
1370 Otherwise, return true. */
1372 static bool
1373 dump (void)
1375 char *block[2];
1376 uintmax_t current_offset;
1377 bool idx = false;
1378 bool ok = true;
1379 size_t n_bytes_read;
1381 block[0] = xnmalloc (2, bytes_per_block);
1382 block[1] = block[0] + bytes_per_block;
1384 current_offset = n_bytes_to_skip;
1386 if (limit_bytes_to_format)
1388 while (1)
1390 size_t n_needed;
1391 if (current_offset >= end_offset)
1393 n_bytes_read = 0;
1394 break;
1396 n_needed = MIN (end_offset - current_offset,
1397 (uintmax_t) bytes_per_block);
1398 ok &= read_block (n_needed, block[idx], &n_bytes_read);
1399 if (n_bytes_read < bytes_per_block)
1400 break;
1401 assert (n_bytes_read == bytes_per_block);
1402 write_block (current_offset, n_bytes_read,
1403 block[!idx], block[idx]);
1404 current_offset += n_bytes_read;
1405 idx = !idx;
1408 else
1410 while (1)
1412 ok &= read_block (bytes_per_block, block[idx], &n_bytes_read);
1413 if (n_bytes_read < bytes_per_block)
1414 break;
1415 assert (n_bytes_read == bytes_per_block);
1416 write_block (current_offset, n_bytes_read,
1417 block[!idx], block[idx]);
1418 current_offset += n_bytes_read;
1419 idx = !idx;
1423 if (n_bytes_read > 0)
1425 int l_c_m;
1426 size_t bytes_to_write;
1428 l_c_m = get_lcm ();
1430 /* Ensure zero-byte padding up to the smallest multiple of l_c_m that
1431 is at least as large as n_bytes_read. */
1432 bytes_to_write = l_c_m * ((n_bytes_read + l_c_m - 1) / l_c_m);
1434 memset (block[idx] + n_bytes_read, 0, bytes_to_write - n_bytes_read);
1435 write_block (current_offset, n_bytes_read, block[!idx], block[idx]);
1436 current_offset += n_bytes_read;
1439 format_address (current_offset, '\n');
1441 if (limit_bytes_to_format && current_offset >= end_offset)
1442 ok &= check_and_close (0);
1444 free (block[0]);
1446 return ok;
1449 /* STRINGS mode. Find each "string constant" in the input.
1450 A string constant is a run of at least 'string_min' ASCII
1451 graphic (or formatting) characters terminated by a null.
1452 Based on a function written by Richard Stallman for a
1453 traditional version of od. Return true if successful. */
1455 static bool
1456 dump_strings (void)
1458 size_t bufsize = MAX (100, string_min);
1459 char *buf = xmalloc (bufsize);
1460 uintmax_t address = n_bytes_to_skip;
1461 bool ok = true;
1463 while (1)
1465 size_t i;
1466 int c;
1468 /* See if the next 'string_min' chars are all printing chars. */
1469 tryline:
1471 if (limit_bytes_to_format
1472 && (end_offset < string_min || end_offset - string_min <= address))
1473 break;
1475 for (i = 0; i < string_min; i++)
1477 ok &= read_char (&c);
1478 address++;
1479 if (c < 0)
1481 free (buf);
1482 return ok;
1484 if (! isprint (c))
1485 /* Found a non-printing. Try again starting with next char. */
1486 goto tryline;
1487 buf[i] = c;
1490 /* We found a run of 'string_min' printable characters.
1491 Now see if it is terminated with a null byte. */
1492 while (!limit_bytes_to_format || address < end_offset)
1494 if (i == bufsize)
1496 buf = X2REALLOC (buf, &bufsize);
1498 ok &= read_char (&c);
1499 address++;
1500 if (c < 0)
1502 free (buf);
1503 return ok;
1505 if (c == '\0')
1506 break; /* It is; print this string. */
1507 if (! isprint (c))
1508 goto tryline; /* It isn't; give up on this string. */
1509 buf[i++] = c; /* String continues; store it all. */
1512 /* If we get here, the string is all printable and null-terminated,
1513 so print it. It is all in 'buf' and 'i' is its length. */
1514 buf[i] = 0;
1515 format_address (address - i - 1, ' ');
1517 for (i = 0; (c = buf[i]); i++)
1519 switch (c)
1521 case '\a':
1522 fputs ("\\a", stdout);
1523 break;
1525 case '\b':
1526 fputs ("\\b", stdout);
1527 break;
1529 case '\f':
1530 fputs ("\\f", stdout);
1531 break;
1533 case '\n':
1534 fputs ("\\n", stdout);
1535 break;
1537 case '\r':
1538 fputs ("\\r", stdout);
1539 break;
1541 case '\t':
1542 fputs ("\\t", stdout);
1543 break;
1545 case '\v':
1546 fputs ("\\v", stdout);
1547 break;
1549 default:
1550 putc (c, stdout);
1553 putchar ('\n');
1556 /* We reach this point only if we search through
1557 (max_bytes_to_format - string_min) bytes before reaching EOF. */
1559 free (buf);
1561 ok &= check_and_close (0);
1562 return ok;
1566 main (int argc, char **argv)
1568 int n_files;
1569 size_t i;
1570 int l_c_m;
1571 size_t desired_width IF_LINT ( = 0);
1572 bool modern = false;
1573 bool width_specified = false;
1574 bool ok = true;
1575 size_t width_per_block = 0;
1576 static char const multipliers[] = "bEGKkMmPTYZ0";
1578 /* The old-style 'pseudo starting address' to be printed in parentheses
1579 after any true address. */
1580 uintmax_t pseudo_start IF_LINT ( = 0);
1582 initialize_main (&argc, &argv);
1583 set_program_name (argv[0]);
1584 setlocale (LC_ALL, "");
1585 bindtextdomain (PACKAGE, LOCALEDIR);
1586 textdomain (PACKAGE);
1588 atexit (close_stdout);
1590 for (i = 0; i <= MAX_INTEGRAL_TYPE_SIZE; i++)
1591 integral_type_size[i] = NO_SIZE;
1593 integral_type_size[sizeof (char)] = CHAR;
1594 integral_type_size[sizeof (short int)] = SHORT;
1595 integral_type_size[sizeof (int)] = INT;
1596 integral_type_size[sizeof (long int)] = LONG;
1597 #if HAVE_UNSIGNED_LONG_LONG_INT
1598 /* If 'long int' and 'long long int' have the same size, it's fine
1599 to overwrite the entry for 'long' with this one. */
1600 integral_type_size[sizeof (unsigned_long_long_int)] = LONG_LONG;
1601 #endif
1603 for (i = 0; i <= MAX_FP_TYPE_SIZE; i++)
1604 fp_type_size[i] = NO_SIZE;
1606 fp_type_size[sizeof (float)] = FLOAT_SINGLE;
1607 /* The array entry for 'double' is filled in after that for 'long double'
1608 so that if they are the same size, we avoid any overhead of
1609 long double computation in libc. */
1610 fp_type_size[sizeof (long double)] = FLOAT_LONG_DOUBLE;
1611 fp_type_size[sizeof (double)] = FLOAT_DOUBLE;
1613 n_specs = 0;
1614 n_specs_allocated = 0;
1615 spec = NULL;
1617 format_address = format_address_std;
1618 address_base = 8;
1619 address_pad_len = 7;
1620 flag_dump_strings = false;
1622 while (true)
1624 uintmax_t tmp;
1625 enum strtol_error s_err;
1626 int oi = -1;
1627 int c = getopt_long (argc, argv, short_options, long_options, &oi);
1628 if (c == -1)
1629 break;
1631 switch (c)
1633 case 'A':
1634 modern = true;
1635 switch (optarg[0])
1637 case 'd':
1638 format_address = format_address_std;
1639 address_base = 10;
1640 address_pad_len = 7;
1641 break;
1642 case 'o':
1643 format_address = format_address_std;
1644 address_base = 8;
1645 address_pad_len = 7;
1646 break;
1647 case 'x':
1648 format_address = format_address_std;
1649 address_base = 16;
1650 address_pad_len = 6;
1651 break;
1652 case 'n':
1653 format_address = format_address_none;
1654 address_pad_len = 0;
1655 break;
1656 default:
1657 error (EXIT_FAILURE, 0,
1658 _("invalid output address radix '%c';\
1659 it must be one character from [doxn]"),
1660 optarg[0]);
1661 break;
1663 break;
1665 case 'j':
1666 modern = true;
1667 s_err = xstrtoumax (optarg, NULL, 0, &n_bytes_to_skip, multipliers);
1668 if (s_err != LONGINT_OK)
1669 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1670 break;
1672 case 'N':
1673 modern = true;
1674 limit_bytes_to_format = true;
1676 s_err = xstrtoumax (optarg, NULL, 0, &max_bytes_to_format,
1677 multipliers);
1678 if (s_err != LONGINT_OK)
1679 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1680 break;
1682 case 'S':
1683 modern = true;
1684 if (optarg == NULL)
1685 string_min = 3;
1686 else
1688 s_err = xstrtoumax (optarg, NULL, 0, &tmp, multipliers);
1689 if (s_err != LONGINT_OK)
1690 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1692 /* The minimum string length may be no larger than SIZE_MAX,
1693 since we may allocate a buffer of this size. */
1694 if (SIZE_MAX < tmp)
1695 error (EXIT_FAILURE, 0, _("%s is too large"), quote (optarg));
1697 string_min = tmp;
1699 flag_dump_strings = true;
1700 break;
1702 case 't':
1703 modern = true;
1704 ok &= decode_format_string (optarg);
1705 break;
1707 case 'v':
1708 modern = true;
1709 abbreviate_duplicate_blocks = false;
1710 break;
1712 case TRADITIONAL_OPTION:
1713 traditional = true;
1714 break;
1716 case ENDIAN_OPTION:
1717 switch (XARGMATCH ("--endian", optarg, endian_args, endian_types))
1719 case endian_big:
1720 input_swap = ! WORDS_BIGENDIAN;
1721 break;
1722 case endian_little:
1723 input_swap = WORDS_BIGENDIAN;
1724 break;
1726 break;
1728 /* The next several cases map the traditional format
1729 specification options to the corresponding modern format
1730 specs. GNU od accepts any combination of old- and
1731 new-style options. Format specification options accumulate.
1732 The obsolescent and undocumented formats are compatible
1733 with FreeBSD 4.10 od. */
1735 #define CASE_OLD_ARG(old_char,new_string) \
1736 case old_char: \
1737 ok &= decode_format_string (new_string); \
1738 break
1740 CASE_OLD_ARG ('a', "a");
1741 CASE_OLD_ARG ('b', "o1");
1742 CASE_OLD_ARG ('c', "c");
1743 CASE_OLD_ARG ('D', "u4"); /* obsolescent and undocumented */
1744 CASE_OLD_ARG ('d', "u2");
1745 case 'F': /* obsolescent and undocumented alias */
1746 CASE_OLD_ARG ('e', "fD"); /* obsolescent and undocumented */
1747 CASE_OLD_ARG ('f', "fF");
1748 case 'X': /* obsolescent and undocumented alias */
1749 CASE_OLD_ARG ('H', "x4"); /* obsolescent and undocumented */
1750 CASE_OLD_ARG ('i', "dI");
1751 case 'I': case 'L': /* obsolescent and undocumented aliases */
1752 CASE_OLD_ARG ('l', "dL");
1753 CASE_OLD_ARG ('O', "o4"); /* obsolesent and undocumented */
1754 case 'B': /* obsolescent and undocumented alias */
1755 CASE_OLD_ARG ('o', "o2");
1756 CASE_OLD_ARG ('s', "d2");
1757 case 'h': /* obsolescent and undocumented alias */
1758 CASE_OLD_ARG ('x', "x2");
1760 #undef CASE_OLD_ARG
1762 case 'w':
1763 modern = true;
1764 width_specified = true;
1765 if (optarg == NULL)
1767 desired_width = 32;
1769 else
1771 uintmax_t w_tmp;
1772 s_err = xstrtoumax (optarg, NULL, 10, &w_tmp, "");
1773 if (s_err != LONGINT_OK)
1774 xstrtol_fatal (s_err, oi, c, long_options, optarg);
1775 if (SIZE_MAX < w_tmp)
1776 error (EXIT_FAILURE, 0, _("%s is too large"), quote (optarg));
1777 desired_width = w_tmp;
1779 break;
1781 case_GETOPT_HELP_CHAR;
1783 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1785 default:
1786 usage (EXIT_FAILURE);
1787 break;
1791 if (!ok)
1792 return EXIT_FAILURE;
1794 if (flag_dump_strings && n_specs > 0)
1795 error (EXIT_FAILURE, 0,
1796 _("no type may be specified when dumping strings"));
1798 n_files = argc - optind;
1800 /* If the --traditional option is used, there may be from
1801 0 to 3 remaining command line arguments; handle each case
1802 separately.
1803 od [file] [[+]offset[.][b] [[+]label[.][b]]]
1804 The offset and label have the same syntax.
1806 If --traditional is not given, and if no modern options are
1807 given, and if the offset begins with + or (if there are two
1808 operands) a digit, accept only this form, as per POSIX:
1809 od [file] [[+]offset[.][b]]
1812 if (!modern || traditional)
1814 uintmax_t o1;
1815 uintmax_t o2;
1817 switch (n_files)
1819 case 1:
1820 if ((traditional || argv[optind][0] == '+')
1821 && parse_old_offset (argv[optind], &o1))
1823 n_bytes_to_skip = o1;
1824 --n_files;
1825 ++argv;
1827 break;
1829 case 2:
1830 if ((traditional || argv[optind + 1][0] == '+'
1831 || ISDIGIT (argv[optind + 1][0]))
1832 && parse_old_offset (argv[optind + 1], &o2))
1834 if (traditional && parse_old_offset (argv[optind], &o1))
1836 n_bytes_to_skip = o1;
1837 flag_pseudo_start = true;
1838 pseudo_start = o2;
1839 argv += 2;
1840 n_files -= 2;
1842 else
1844 n_bytes_to_skip = o2;
1845 --n_files;
1846 argv[optind + 1] = argv[optind];
1847 ++argv;
1850 break;
1852 case 3:
1853 if (traditional
1854 && parse_old_offset (argv[optind + 1], &o1)
1855 && parse_old_offset (argv[optind + 2], &o2))
1857 n_bytes_to_skip = o1;
1858 flag_pseudo_start = true;
1859 pseudo_start = o2;
1860 argv[optind + 2] = argv[optind];
1861 argv += 2;
1862 n_files -= 2;
1864 break;
1867 if (traditional && 1 < n_files)
1869 error (0, 0, _("extra operand %s"), quote (argv[optind + 1]));
1870 error (0, 0, "%s",
1871 _("compatibility mode supports at most one file"));
1872 usage (EXIT_FAILURE);
1876 if (flag_pseudo_start)
1878 if (format_address == format_address_none)
1880 address_base = 8;
1881 address_pad_len = 7;
1882 format_address = format_address_paren;
1884 else
1885 format_address = format_address_label;
1888 if (limit_bytes_to_format)
1890 end_offset = n_bytes_to_skip + max_bytes_to_format;
1891 if (end_offset < n_bytes_to_skip)
1892 error (EXIT_FAILURE, 0, _("skip-bytes + read-bytes is too large"));
1895 if (n_specs == 0)
1896 decode_format_string ("oS");
1898 if (n_files > 0)
1900 /* Set the global pointer FILE_LIST so that it
1901 references the first file-argument on the command-line. */
1903 file_list = (char const *const *) &argv[optind];
1905 else
1907 /* No files were listed on the command line.
1908 Set the global pointer FILE_LIST so that it
1909 references the null-terminated list of one name: "-". */
1911 file_list = default_file_list;
1914 /* open the first input file */
1915 ok = open_next_file ();
1916 if (in_stream == NULL)
1917 goto cleanup;
1919 /* skip over any unwanted header bytes */
1920 ok &= skip (n_bytes_to_skip);
1921 if (in_stream == NULL)
1922 goto cleanup;
1924 pseudo_offset = (flag_pseudo_start ? pseudo_start - n_bytes_to_skip : 0);
1926 /* Compute output block length. */
1927 l_c_m = get_lcm ();
1929 if (width_specified)
1931 if (desired_width != 0 && desired_width % l_c_m == 0)
1932 bytes_per_block = desired_width;
1933 else
1935 error (0, 0, _("warning: invalid width %lu; using %d instead"),
1936 (unsigned long int) desired_width, l_c_m);
1937 bytes_per_block = l_c_m;
1940 else
1942 if (l_c_m < DEFAULT_BYTES_PER_BLOCK)
1943 bytes_per_block = l_c_m * (DEFAULT_BYTES_PER_BLOCK / l_c_m);
1944 else
1945 bytes_per_block = l_c_m;
1948 /* Compute padding necessary to align output block. */
1949 for (i = 0; i < n_specs; i++)
1951 int fields_per_block = bytes_per_block / width_bytes[spec[i].size];
1952 int block_width = (spec[i].field_width + 1) * fields_per_block;
1953 if (width_per_block < block_width)
1954 width_per_block = block_width;
1956 for (i = 0; i < n_specs; i++)
1958 int fields_per_block = bytes_per_block / width_bytes[spec[i].size];
1959 int block_width = spec[i].field_width * fields_per_block;
1960 spec[i].pad_width = width_per_block - block_width;
1963 #ifdef DEBUG
1964 printf ("lcm=%d, width_per_block=%"PRIuMAX"\n", l_c_m,
1965 (uintmax_t) width_per_block);
1966 for (i = 0; i < n_specs; i++)
1968 int fields_per_block = bytes_per_block / width_bytes[spec[i].size];
1969 assert (bytes_per_block % width_bytes[spec[i].size] == 0);
1970 assert (1 <= spec[i].pad_width / fields_per_block);
1971 printf ("%d: fmt=\"%s\" in_width=%d out_width=%d pad=%d\n",
1972 i, spec[i].fmt_string, width_bytes[spec[i].size],
1973 spec[i].field_width, spec[i].pad_width);
1975 #endif
1977 ok &= (flag_dump_strings ? dump_strings () : dump ());
1979 cleanup:
1981 if (have_read_stdin && fclose (stdin) == EOF)
1982 error (EXIT_FAILURE, errno, _("standard input"));
1984 return ok ? EXIT_SUCCESS : EXIT_FAILURE;