2003-09-12 Andrew Cagney <cagney@redhat.com>
[binutils-gdb.git] / binutils / strings.c
index aea9934cf39f92bbaafd81f1bccf1be0aa2ef039..b5e88d058638d1ae5b7b634655c3ffe12cab8043 100644 (file)
@@ -1,5 +1,6 @@
 /* strings -- print the strings of printable characters in files
-   Copyright (C) 1993 Free Software Foundation, Inc.
+   Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
+   2002 Free Software Foundation, Inc.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -13,7 +14,8 @@
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
+   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+   02111-1307, USA.  */
 \f
 /* Usage: strings [options] file...
 
    -o          Like -to.  (Some other implementations have -o like -to,
                others like -td.  We chose one arbitrarily.)
 
+   --encoding={s,S,b,l,B,L}
+   -e {s,S,b,l,B,L}
+               Select character encoding: 7-bit-character, 8-bit-character,
+               bigendian 16-bit, littleendian 16-bit, bigendian 32-bit,
+               littleendian 32-bit.
+
+   --target=BFDNAME
+               Specify a non-default object file format.
+
    --help
    -h          Print the usage message on the standard output.
 
    Written by Richard Stallman <rms@gnu.ai.mit.edu>
    and David MacKenzie <djm@gnu.ai.mit.edu>.  */
 
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+#include "bfd.h"
 #include <stdio.h>
-#include <getopt.h>
-#include <ctype.h>
+#include "getopt.h"
 #include <errno.h>
-#include <bfd.h>
-
-#ifdef isascii
-#define isgraphic(c) (isascii (c) && isprint (c))
+#include "bucomm.h"
+#include "libiberty.h"
+#include "safe-ctype.h"
+
+/* Some platforms need to put stdin into binary mode, to read
+    binary files.  */
+#ifdef HAVE_SETMODE
+#ifndef O_BINARY
+#ifdef _O_BINARY
+#define O_BINARY _O_BINARY
+#define setmode _setmode
 #else
-#define isgraphic(c) (isprint (c))
+#define O_BINARY 0
+#endif
+#endif
+#if O_BINARY
+#include <io.h>
+#define SET_BINARY(f) do { if (!isatty (f)) setmode (f,O_BINARY); } while (0)
+#endif
 #endif
 
+#define STRING_ISGRAPHIC(c) \
+      (   (c) >= 0 \
+       && (c) <= 255 \
+       && ((c) == '\t' || ISPRINT (c) || (encoding == 'S' && (c) > 127)))
+
 #ifndef errno
 extern int errno;
 #endif
 
 /* The BFD section flags that identify an initialized data section.  */
-#define DATA_FLAGS (SEC_ALLOC | SEC_LOAD | SEC_DATA | SEC_HAS_CONTENTS)
+#define DATA_FLAGS (SEC_ALLOC | SEC_LOAD | SEC_HAS_CONTENTS)
+
+#ifdef HAVE_FOPEN64
+typedef off64_t file_off;
+#define file_open(s,m) fopen64(s, m)
+#else
+typedef off_t file_off;
+#define file_open(s,m) fopen(s, m)
+#endif
 
 /* Radix for printing addresses (must be 8, 10 or 16).  */
 static int address_radix;
@@ -71,23 +111,24 @@ static int address_radix;
 /* Minimum length of sequence of graphic chars to trigger output.  */
 static int string_min;
 
-/* true means print address within file for each string.  */
-static boolean print_addresses;
+/* TRUE means print address within file for each string.  */
+static bfd_boolean print_addresses;
 
-/* true means print filename for each string.  */
-static boolean print_filenames;
+/* TRUE means print filename for each string.  */
+static bfd_boolean print_filenames;
 
-/* true means for object files scan only the data section.  */
-static boolean datasection_only;
+/* TRUE means for object files scan only the data section.  */
+static bfd_boolean datasection_only;
 
-/* true if we found an initialized data section in the current file.  */
-static boolean got_a_section;
+/* TRUE if we found an initialized data section in the current file.  */
+static bfd_boolean got_a_section;
 
-/* Opened to /dev/null for reading from a BFD.  */
-static FILE *devnull;
+/* The BFD object file format.  */
+static char *target;
 
-extern char *program_name;
-extern char *program_version;
+/* The character encoding format.  */
+static char encoding;
+static int encoding_bytes;
 
 static struct option long_options[] =
 {
@@ -95,69 +136,87 @@ static struct option long_options[] =
   {"print-file-name", no_argument, NULL, 'f'},
   {"bytes", required_argument, NULL, 'n'},
   {"radix", required_argument, NULL, 't'},
+  {"encoding", required_argument, NULL, 'e'},
+  {"target", required_argument, NULL, 'T'},
   {"help", no_argument, NULL, 'h'},
   {"version", no_argument, NULL, 'v'},
   {NULL, 0, NULL, 0}
 };
 
-char *xmalloc ();
-char *xrealloc ();
-
-static boolean strings_file ();
-static int integer_arg ();
-static void dump_strings ();
-static void usage ();
+static void strings_a_section
+  PARAMS ((bfd *, asection *, PTR));
+static bfd_boolean strings_object_file
+  PARAMS ((const char *));
+static bfd_boolean strings_file
+  PARAMS ((char *file));
+static int integer_arg
+  PARAMS ((char *s));
+static void print_strings
+  PARAMS ((const char *, FILE *, file_off, int, int, char *));
+static void usage
+  PARAMS ((FILE *, int));
+static long get_char
+  PARAMS ((FILE *, file_off *, int *, char **));
 \f
-void
+int main
+  PARAMS ((int, char **));
+
+int
 main (argc, argv)
      int argc;
      char **argv;
 {
   int optc;
   int exit_status = 0;
-  boolean files_given = false; /* false if any files were given.  */
+  bfd_boolean files_given = FALSE;
+
+#if defined (HAVE_SETLOCALE)
+  setlocale (LC_ALL, "");
+#endif
+  bindtextdomain (PACKAGE, LOCALEDIR);
+  textdomain (PACKAGE);
 
   program_name = argv[0];
+  xmalloc_set_program_name (program_name);
   string_min = -1;
-  print_addresses = false;
-  print_filenames = false;
-  datasection_only = true;
+  print_addresses = FALSE;
+  print_filenames = FALSE;
+  datasection_only = TRUE;
+  target = NULL;
+  encoding = 's';
 
-  while ((optc = getopt_long (argc, argv, "afhn:ot:v0123456789",
+  while ((optc = getopt_long (argc, argv, "afhHn:ot:e:Vv0123456789",
                              long_options, (int *) 0)) != EOF)
     {
       switch (optc)
        {
        case 'a':
-         datasection_only = false;
+         datasection_only = FALSE;
          break;
 
        case 'f':
-         print_filenames = true;
+         print_filenames = TRUE;
          break;
 
+       case 'H':
        case 'h':
-         usage (stdout);
-         exit (0);
+         usage (stdout, 0);
 
        case 'n':
          string_min = integer_arg (optarg);
          if (string_min < 1)
-           {
-             fprintf (stderr, "%s: invalid number %s\n", program_name, optarg);
-             exit (1);
-           }
+           fatal (_("invalid number %s"), optarg);
          break;
 
        case 'o':
-         print_addresses = true;
+         print_addresses = TRUE;
          address_radix = 8;
          break;
 
        case 't':
-         print_addresses = true;
+         print_addresses = TRUE;
          if (optarg[1] != '\0')
-           usage ();
+           usage (stderr, 1);
          switch (optarg[0])
            {
            case 'o':
@@ -173,20 +232,31 @@ main (argc, argv)
              break;
 
            default:
-             usage ();
+             usage (stderr, 1);
            }
          break;
 
+       case 'T':
+         target = optarg;
+         break;
+
+       case 'e':
+         if (optarg[1] != '\0')
+           usage (stderr, 1);
+         encoding = optarg[0];
+         break;
+
+       case 'V':
        case 'v':
-         printf ("%s version %s\n", program_name, program_version);
-         exit (0);
+         print_version ("strings");
+         break;
 
        case '?':
-         usage (stderr);
+         usage (stderr, 1);
 
        default:
          if (string_min < 0)
-           string_min = optc;
+           string_min = optc - '0';
          else
            string_min = string_min * 10 + optc - '0';
          break;
@@ -196,97 +266,122 @@ main (argc, argv)
   if (string_min < 0)
     string_min = 4;
 
-  bfd_init ();
-  devnull = fopen ("/dev/null", "r");
-  if (devnull == NULL)
+  switch (encoding)
     {
-      fprintf (stderr, "%s: ", program_name);
-      perror ("/dev/null");
-      exit (1);
+    case 'S':
+    case 's':
+      encoding_bytes = 1;
+      break;
+    case 'b':
+    case 'l':
+      encoding_bytes = 2;
+      break;
+    case 'B':
+    case 'L':
+      encoding_bytes = 4;
+      break;
+    default:
+      usage (stderr, 1);
     }
 
-  for (; optind < argc; ++optind)
+  bfd_init ();
+  set_default_bfd_target ();
+
+  if (optind >= argc)
     {
-      if (!strcmp (argv[optind], "-"))
-       datasection_only = false;
-      else
+      datasection_only = FALSE;
+#ifdef SET_BINARY
+      SET_BINARY (fileno (stdin));
+#endif
+      print_strings ("{standard input}", stdin, 0, 0, 0, (char *) NULL);
+      files_given = TRUE;
+    }
+  else
+    {
+      for (; optind < argc; ++optind)
        {
-         files_given = true;
-         exit_status |= (strings_file (argv[optind]) == false);
+         if (strcmp (argv[optind], "-") == 0)
+           datasection_only = FALSE;
+         else
+           {
+             files_given = TRUE;
+             exit_status |= strings_file (argv[optind]) == FALSE;
+           }
        }
     }
 
-  if (files_given == false)
-    usage (stderr);
+  if (!files_given)
+    usage (stderr, 1);
 
-  exit (exit_status);
+  return (exit_status);
 }
 \f
-/* Scan the sections of the file ABFD, whose printable name is FILE.
-   If any of them contain initialized data,
-   set `got_a_section' and print the strings in them.  */
+/* Scan section SECT of the file ABFD, whose printable name is FILE.
+   If it contains initialized data,
+   set `got_a_section' and print the strings in it.  */
 
 static void
-strings_a_section (abfd, sect, file)
+strings_a_section (abfd, sect, filearg)
      bfd *abfd;
      asection *sect;
-     PTR file;
+     PTR filearg;
 {
+  const char *file = (const char *) filearg;
+
   if ((sect->flags & DATA_FLAGS) == DATA_FLAGS)
     {
       bfd_size_type sz = bfd_get_section_size_before_reloc (sect);
       PTR mem = xmalloc (sz);
+
       if (bfd_get_section_contents (abfd, sect, mem, (file_ptr) 0, sz))
        {
-         got_a_section = true;
-         dump_strings (file, devnull, sect->filepos, 0, sz, mem);
+         got_a_section = TRUE;
+         print_strings (file, (FILE *) NULL, sect->filepos, 0, sz, mem);
        }
       free (mem);
     }
 }
 
-/* Print the strings in the initialized data section of FILE.
-   Return true if successful,
-   false if not (such as if FILE is not an object file).  */
+/* Scan all of the sections in FILE, and print the strings
+   in the initialized data section(s).
+
+   Return TRUE if successful,
+   FALSE if not (such as if FILE is not an object file).  */
 
-static boolean
+static bfd_boolean
 strings_object_file (file)
-     char *file;
+     const char *file;
 {
-  bfd *abfd = bfd_openr (file, NULL);
+  bfd *abfd = bfd_openr (file, target);
 
   if (abfd == NULL)
+    /* Treat the file as a non-object file.  */
+    return FALSE;
+
+  /* This call is mainly for its side effect of reading in the sections.
+     We follow the traditional behavior of `strings' in that we don't
+     complain if we don't recognize a file to be an object file.  */
+  if (!bfd_check_format (abfd, bfd_object))
     {
-      if (bfd_error != system_call_error)
-       {
-         /* Out of memory, or an invalid target is specified by the
-            GNUTARGET environment variable.  */
-         fprintf (stderr, "%s: ", program_name);
-         bfd_perror (file);
-       }
-      return false;
+      bfd_close (abfd);
+      return FALSE;
     }
 
-  /* For some reason, without this call, the BFD has no sections.
-     This call is only for the side effect of reading in the sections.  */
-  bfd_check_format (abfd, bfd_object);
-
-  got_a_section = false;
-  bfd_map_over_sections (abfd, strings_a_section, file);
+  got_a_section = FALSE;
+  bfd_map_over_sections (abfd, strings_a_section, (PTR) file);
 
   if (!bfd_close (abfd))
     {
-      fprintf (stderr, "%s: ", program_name);
-      bfd_perror (file);
-      return false;
+      bfd_nonfatal (file);
+      return FALSE;
     }
 
   return got_a_section;
 }
 
-/* Print the strings in FILE.  Return true if ok, false if an error occurs.  */
+/* Print the strings in FILE.  Return TRUE if ok, FALSE if an error occurs.  */
 
-static boolean
+static bfd_boolean
 strings_file (file)
      char *file;
 {
@@ -298,25 +393,98 @@ strings_file (file)
     {
       FILE *stream;
 
-      stream = fopen (file, "r");
+      stream = file_open (file, FOPEN_RB);
       if (stream == NULL)
        {
          fprintf (stderr, "%s: ", program_name);
          perror (file);
-         return false;
+         return FALSE;
        }
 
-      dump_strings (file, stream, (file_ptr) 0, 0, 0, (char *) 0);
+      print_strings (file, stream, (file_off) 0, 0, 0, (char *) 0);
 
       if (fclose (stream) == EOF)
        {
          fprintf (stderr, "%s: ", program_name);
          perror (file);
-         return false;
+         return FALSE;
        }
     }
 
-  return true;
+  return TRUE;
+}
+\f
+/* Read the next character, return EOF if none available.
+   Assume that STREAM is positioned so that the next byte read
+   is at address ADDRESS in the file.
+
+   If STREAM is NULL, do not read from it.
+   The caller can supply a buffer of characters
+   to be processed before the data in STREAM.
+   MAGIC is the address of the buffer and
+   MAGICCOUNT is how many characters are in it.  */
+
+static long
+get_char (stream, address, magiccount, magic)
+     FILE *stream;
+     file_off *address;
+     int *magiccount;
+     char **magic;
+{
+  int c, i;
+  long r = EOF;
+  unsigned char buf[4];
+
+  for (i = 0; i < encoding_bytes; i++)
+    {
+      if (*magiccount)
+       {
+         (*magiccount)--;
+         c = *(*magic)++;
+       }
+      else
+       {
+         if (stream == NULL)
+           return EOF;
+#ifdef HAVE_GETC_UNLOCKED
+         c = getc_unlocked (stream);
+#else
+         c = getc (stream);
+#endif
+         if (c == EOF)
+           return EOF;
+       }
+
+      (*address)++;
+      buf[i] = c;
+    }
+
+  switch (encoding)
+    {
+    case 'S':
+    case 's':
+      r = buf[0];
+      break;
+    case 'b':
+      r = (buf[0] << 8) | buf[1];
+      break;
+    case 'l':
+      r = buf[0] | (buf[1] << 8);
+      break;
+    case 'B':
+      r = ((long) buf[0] << 24) | ((long) buf[1] << 16) |
+       ((long) buf[2] << 8) | buf[3];
+      break;
+    case 'L':
+      r = buf[0] | ((long) buf[1] << 8) | ((long) buf[2] << 16) |
+       ((long) buf[3] << 24);
+      break;
+    }
+
+  if (r == EOF)
+    return 0;
+
+  return r;
 }
 \f
 /* Find the strings in file FILENAME, read from STREAM.
@@ -324,123 +492,113 @@ strings_file (file)
    is at address ADDRESS in the file.
    Stop reading at address STOP_POINT in the file, if nonzero.
 
-   Optionally the caller can supply a buffer of characters
+   If STREAM is NULL, do not read from it.
+   The caller can supply a buffer of characters
    to be processed before the data in STREAM.
    MAGIC is the address of the buffer and
    MAGICCOUNT is how many characters are in it.
    Those characters come at address ADDRESS and the data in STREAM follow.  */
 
 static void
-dump_strings (filename, stream, address, stop_point, magiccount, magic)
-     char *filename;
+print_strings (filename, stream, address, stop_point, magiccount, magic)
+     const char *filename;
      FILE *stream;
-     file_ptr address;
+     file_off address;
      int stop_point;
      int magiccount;
      char *magic;
 {
-  int bufsize = 100;
-  char *buf = (char *) xmalloc (bufsize);
+  char *buf = (char *) xmalloc (sizeof (char) * (string_min + 1));
 
   while (1)
     {
+      file_off start;
       int i;
-      int c;
+      long c;
 
       /* See if the next `string_min' chars are all graphic chars.  */
     tryline:
       if (stop_point && address >= stop_point)
        break;
+      start = address;
       for (i = 0; i < string_min; i++)
        {
-         if (magiccount)
-           {
-             magiccount--;
-             c = *magic++;
-           }
-         else
-           {
-             c = getc (stream);
-             if (c < 0)
-               return;
-           }
-         address++;
-         if (!isgraphic (c))
+         c = get_char (stream, &address, &magiccount, &magic);
+         if (c == EOF)
+           return;
+         if (! STRING_ISGRAPHIC (c))
            /* Found a non-graphic.  Try again starting with next char.  */
            goto tryline;
          buf[i] = c;
        }
 
-      /* We found a run of `string_min' graphic characters.
-        Now see if it is terminated with a NUL byte or a newline.   */
-      while (1)
-       {
-         if (i == bufsize)
-           {
-             bufsize *= 2;
-             buf = (char *) xrealloc (buf, bufsize);
-           }
-         if (magiccount)
-           {
-             magiccount--;
-             c = *magic++;
-           }
-         else
-           {
-             c = getc (stream);
-             if (c < 0)
-               return;
-           }
-         address++;
-         if (c == '\0' || c == '\n')
-           break;              /* It is; print this string.  */
-         if (!isgraphic (c))
-           goto tryline;       /* It isn't; give up on this string.  */
-         buf[i++] = c;         /* The string continues; store it all.  */
-       }
+      /* We found a run of `string_min' graphic characters.  Print up
+         to the next non-graphic character.  */
 
-      /* If we get here, the string is all graphics and properly terminated,
-        so print it.  It is all in `buf' and `i' is its length.  */
-      buf[i] = '\0';
       if (print_filenames)
        printf ("%s: ", filename);
       if (print_addresses)
        switch (address_radix)
          {
          case 8:
-           printf ("%7lo ", address - i - 1);
+#if __STDC_VERSION__ >= 199901L || (defined(__GNUC__) && __GNUC__ >= 2)
+           if (sizeof (start) > sizeof (long))
+             printf ("%7Lo ", (unsigned long long) start);
+           else
+#else
+# if !BFD_HOST_64BIT_LONG
+           if (start != (unsigned long) start)
+             printf ("++%7lo ", (unsigned long) start);
+           else
+# endif
+#endif
+             printf ("%7lo ", (unsigned long) start);
            break;
 
          case 10:
-           printf ("%7ld ", address - i - 1);
+#if __STDC_VERSION__ >= 199901L || (defined(__GNUC__) && __GNUC__ >= 2)
+           if (sizeof (start) > sizeof (long))
+             printf ("%7Ld ", (unsigned long long) start);
+           else
+#else
+# if !BFD_HOST_64BIT_LONG
+           if (start != (unsigned long) start)
+             printf ("++%7ld ", (unsigned long) start);
+           else
+# endif
+#endif
+             printf ("%7ld ", (long) start);
            break;
 
          case 16:
-           printf ("%7lx ", address - i - 1);
+#if __STDC_VERSION__ >= 199901L || (defined(__GNUC__) && __GNUC__ >= 2)
+           if (sizeof (start) > sizeof (long))
+             printf ("%7Lx ", (unsigned long long) start);
+           else
+#else
+# if !BFD_HOST_64BIT_LONG
+           if (start != (unsigned long) start)
+             printf ("%lx%8.8lx ", start >> 32, start & 0xffffffff);
+           else
+# endif
+#endif
+             printf ("%7lx ", (unsigned long) start);
            break;
          }
 
-      for (i = 0; (c = buf[i]) != '\0'; i++)
-       switch (c)
-         {
-         case '\n':
-           printf ("\\n");
-           break;
-         case '\t':
-           printf ("\\t");
-           break;
-         case '\f':
-           printf ("\\f");
-           break;
-         case '\b':
-           printf ("\\b");
+      buf[i] = '\0';
+      fputs (buf, stdout);
+
+      while (1)
+       {
+         c = get_char (stream, &address, &magiccount, &magic);
+         if (c == EOF)
            break;
-         case '\r':
-           printf ("\\r");
+         if (! STRING_ISGRAPHIC (c))
            break;
-         default:
-           putchar (c);
-         }
+         putchar (c);
+       }
+
       putchar ('\n');
     }
 }
@@ -486,21 +644,32 @@ integer_arg (s)
     p--;
 
   if (*p)
-    {
-      fprintf (stderr, "%s: invalid integer argument %s\n", program_name, s);
-      exit (1);
-    }
+    fatal (_("invalid integer argument %s"), s);
+
   return value;
 }
 
 static void
-usage (stream)
+usage (stream, status)
      FILE *stream;
+     int status;
 {
-  fprintf (stream, "\
-Usage: %s [-afhov] [-n min-len] [-min-len] [-t {o,x,d}] [-]\n\
-       [--all] [--print-file-name] [--bytes=min-len] [--radix={o,x,d}]\n\
-       [--help] [--version] file...\n",
-          program_name);
-  exit (1);
+  fprintf (stream, _("Usage: %s [option(s)] [file(s)]\n"), program_name);
+  fprintf (stream, _(" Display printable strings in [file(s)] (stdin by default)\n"));
+  fprintf (stream, _(" The options are:\n\
+  -a - --all                Scan the entire file, not just the data section\n\
+  -f --print-file-name      Print the name of the file before each string\n\
+  -n --bytes=[number]       Locate & print any NUL-terminated sequence of at\n\
+  -<number>                 least [number] characters (default 4).\n\
+  -t --radix={o,x,d}        Print the location of the string in base 8, 10 or 16\n\
+  -o                        An alias for --radix=o\n\
+  -T --target=<BFDNAME>     Specify the binary file format\n\
+  -e --encoding={s,S,b,l,B,L} Select character size and endianness:\n\
+                            s = 7-bit, S = 8-bit, {b,l} = 16-bit, {B,L} = 32-bit\n\
+  -h --help                 Display this information\n\
+  -v --version              Print the program's version number\n"));
+  list_supported_targets (program_name, stream);
+  if (status == 0)
+    fprintf (stream, _("Report bugs to %s\n"), REPORT_BUGS_TO);
+  exit (status);
 }