contrib/binutils/bfd/format.c

   1 /* Generic BFD support for file formats.
   2    Copyright (C) 1990, 91, 92, 93, 94 Free Software Foundation, Inc.
   3    Written by Cygnus Support.
   4
   5 This file is part of BFD, the Binary File Descriptor library.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20
  21 /*
  22 SECTION
  23         File formats
  24
  25         A format is a BFD concept of high level file contents type. The
  26         formats supported by BFD are:
  27
  28         o <<bfd_object>>
  29
  30         The BFD may contain data, symbols, relocations and debug info.
  31
  32         o <<bfd_archive>>
  33
  34         The BFD contains other BFDs and an optional index.
  35
  36         o <<bfd_core>>
  37
  38         The BFD contains the result of an executable core dump.
  39
  40
  41 */
  42
  43 #include "bfd.h"
  44 #include "sysdep.h"
  45 #include "libbfd.h"
  46
  47 /* IMPORT from targets.c.  */
  48 extern const size_t _bfd_target_vector_entries;
  49
  50 /*
  51 FUNCTION
  52         bfd_check_format
  53
  54 SYNOPSIS
  55         boolean bfd_check_format(bfd *abfd, bfd_format format);
  56
  57 DESCRIPTION
  58         Verify if the file attached to the BFD @var{abfd} is compatible
  59         with the format @var{format} (i.e., one of <<bfd_object>>,
  60         <<bfd_archive>> or <<bfd_core>>).
  61
  62         If the BFD has been set to a specific target before the
  63         call, only the named target and format combination is
  64         checked. If the target has not been set, or has been set to
  65         <<default>>, then all the known target backends is
  66         interrogated to determine a match.  If the default target
  67         matches, it is used.  If not, exactly one target must recognize
  68         the file, or an error results.
  69
  70         The function returns <<true>> on success, otherwise <<false>>
  71         with one of the following error codes:
  72
  73         o <<bfd_error_invalid_operation>> -
  74         if <<format>> is not one of <<bfd_object>>, <<bfd_archive>> or
  75         <<bfd_core>>.
  76
  77         o <<bfd_error_system_call>> -
  78         if an error occured during a read - even some file mismatches
  79         can cause bfd_error_system_calls.
  80
  81         o <<file_not_recognised>> -
  82         none of the backends recognised the file format.
  83
  84         o <<bfd_error_file_ambiguously_recognized>> -
  85         more than one backend recognised the file format.
  86 */
  87
  88 boolean
  89 bfd_check_format (abfd, format)
  90      bfd *abfd;
  91      bfd_format format;
  92 {
  93   return bfd_check_format_matches (abfd, format, NULL);
  94 }
  95
  96 /*
  97 FUNCTION
  98         bfd_check_format_matches
  99
 100 SYNOPSIS
 101         boolean bfd_check_format_matches(bfd *abfd, bfd_format format, char ***matching);
 102
 103 DESCRIPTION
 104         Like <<bfd_check_format>>, except when it returns false with
 105         <<bfd_errno>> set to <<bfd_error_file_ambiguously_recognized>>.  In that
 106         case, if @var{matching} is not NULL, it will be filled in with
 107         a NULL-terminated list of the names of the formats that matched,
 108         allocated with <<malloc>>.
 109         Then the user may choose a format and try again.
 110
 111         When done with the list that @var{matching} points to, the caller
 112         should free it.
 113 */
 114
 115 boolean
 116 bfd_check_format_matches (abfd, format, matching)
 117      bfd *abfd;
 118      bfd_format format;
 119      char ***matching;
 120 {
 121   const bfd_target * const *target, *save_targ, *right_targ;
 122   char **matching_vector = NULL;
 123   int match_count;
 124
 125   if (!bfd_read_p (abfd) ||
 126       ((int)(abfd->format) < (int)bfd_unknown) ||
 127       ((int)(abfd->format) >= (int)bfd_type_end)) {
 128     bfd_set_error (bfd_error_invalid_operation);
 129     return false;
 130   }
 131
 132   if (abfd->format != bfd_unknown)
 133     return (abfd->format == format)? true: false;
 134
 135
 136   /* Since the target type was defaulted, check them
 137      all in the hope that one will be uniquely recognized.  */
 138
 139   save_targ = abfd->xvec;
 140   match_count = 0;
 141   if (matching)
 142     {
 143       matching_vector =
 144         (char **) bfd_malloc (sizeof (char *) *
 145                               (_bfd_target_vector_entries + 1));
 146       if (!matching_vector)
 147         return false;
 148       matching_vector[0] = NULL;
 149       *matching = matching_vector;
 150     }
 151   right_targ = 0;
 152
 153
 154   /* presume the answer is yes */
 155   abfd->format = format;
 156
 157   /* If the target type was explicitly specified, just check that target.  */
 158
 159   if (!abfd->target_defaulted) {
 160     if (bfd_seek (abfd, (file_ptr)0, SEEK_SET) != 0)    /* rewind! */
 161       return false;
 162     right_targ = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
 163     if (right_targ) {
 164       abfd->xvec = right_targ;          /* Set the target as returned */
 165       if (matching)
 166         free (matching_vector);
 167       return true;                      /* File position has moved, BTW */
 168     }
 169   }
 170
 171   for (target = bfd_target_vector; *target != NULL; target++) {
 172     extern const bfd_target binary_vec;
 173     const bfd_target *temp;
 174
 175     if (*target == &binary_vec)
 176       continue;
 177
 178     abfd->xvec = *target;       /* Change BFD's target temporarily */
 179     if (bfd_seek (abfd, (file_ptr)0, SEEK_SET) != 0)
 180       return false;
 181     /* If _bfd_check_format neglects to set bfd_error, assume bfd_error_wrong_format.
 182        We didn't used to even pay any attention to bfd_error, so I suspect
 183        that some _bfd_check_format might have this problem.  */
 184     bfd_set_error (bfd_error_wrong_format);
 185     temp = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
 186     if (temp) {                         /* This format checks out as ok! */
 187       right_targ = temp;
 188       if (matching)
 189         {
 190           matching_vector[match_count] = temp->name;
 191           matching_vector[match_count + 1] = NULL;
 192         }
 193       match_count++;
 194       /* If this is the default target, accept it, even if other targets
 195          might match.  People who want those other targets have to set
 196          the GNUTARGET variable.  */
 197       if (temp == bfd_default_vector[0])
 198         {
 199           if (matching)
 200             {
 201               matching_vector[0] = temp->name;
 202               matching_vector[1] = NULL;
 203             }
 204           match_count = 1;
 205           break;
 206         }
 207 #ifdef GNU960
 208       /* Big- and little-endian b.out archives look the same, but it doesn't
 209        * matter: there is no difference in their headers, and member file byte
 210        * orders will (I hope) be handled appropriately by bfd.  Ditto for big
 211        * and little coff archives.  And the 4 coff/b.out object formats are
 212        * unambiguous.  So accept the first match we find.
 213        */
 214       break;
 215 #endif
 216     } else if (bfd_get_error () != bfd_error_wrong_format) {
 217       abfd->xvec = save_targ;
 218       abfd->format = bfd_unknown;
 219       if (matching && bfd_get_error () != bfd_error_file_ambiguously_recognized)
 220         free (matching_vector);
 221       return false;
 222     }
 223   }
 224
 225   if (match_count == 1) {
 226     abfd->xvec = right_targ;            /* Change BFD's target permanently */
 227     if (matching)
 228       free (matching_vector);
 229     return true;                        /* File position has moved, BTW */
 230   }
 231
 232   abfd->xvec = save_targ;               /* Restore original target type */
 233   abfd->format = bfd_unknown;           /* Restore original format */
 234   if (match_count == 0)
 235     {
 236       bfd_set_error (bfd_error_file_not_recognized);
 237       if (matching)
 238         free (matching_vector);
 239     }
 240   else
 241     bfd_set_error (bfd_error_file_ambiguously_recognized);
 242   return false;
 243 }
 244
 245 /*
 246 FUNCTION
 247         bfd_set_format
 248
 249 SYNOPSIS
 250         boolean bfd_set_format(bfd *abfd, bfd_format format);
 251
 252 DESCRIPTION
 253         This function sets the file format of the BFD @var{abfd} to the
 254         format @var{format}. If the target set in the BFD does not
 255         support the format requested, the format is invalid, or the BFD
 256         is not open for writing, then an error occurs.
 257
 258 */
 259
 260 boolean
 261 bfd_set_format (abfd, format)
 262      bfd *abfd;
 263      bfd_format format;
 264 {
 265
 266   if (bfd_read_p (abfd) ||
 267       ((int)abfd->format < (int)bfd_unknown) ||
 268       ((int)abfd->format >= (int)bfd_type_end)) {
 269     bfd_set_error (bfd_error_invalid_operation);
 270     return false;
 271   }
 272
 273   if (abfd->format != bfd_unknown)
 274     return (abfd->format == format) ? true:false;
 275
 276   /* presume the answer is yes */
 277   abfd->format = format;
 278
 279   if (!BFD_SEND_FMT (abfd, _bfd_set_format, (abfd))) {
 280     abfd->format = bfd_unknown;
 281     return false;
 282   }
 283
 284   return true;
 285 }
 286
 287
 288 /*
 289 FUNCTION
 290         bfd_format_string
 291
 292 SYNOPSIS
 293         CONST char *bfd_format_string(bfd_format format);
 294
 295 DESCRIPTION
 296         Return a pointer to a const string
 297         <<invalid>>, <<object>>, <<archive>>, <<core>>, or <<unknown>>,
 298         depending upon the value of @var{format}.
 299 */
 300
 301 CONST char *
 302 bfd_format_string (format)
 303      bfd_format format;
 304 {
 305   if (((int)format <(int) bfd_unknown)
 306       || ((int)format >=(int) bfd_type_end))
 307     return "invalid";
 308
 309   switch (format) {
 310   case bfd_object:
 311     return "object";            /* linker/assember/compiler output */
 312   case bfd_archive:
 313     return "archive";           /* object archive file */
 314   case bfd_core:
 315     return "core";              /* core dump */
 316   default:
 317     return "unknown";
 318   }
 319 }