binutils/elfcomm.h

   1 /* elfcomm.h -- include file of common code for ELF format file.
   2    Copyright (C) 2010-2021 Free Software Foundation, Inc.
   3
   4    Originally developed by Eric Youngdale <eric@andante.jic.com>
   5    Modifications by Nick Clifton <nickc@redhat.com>
   6
   7    This file is part of GNU Binutils.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
  22    02110-1301, USA.  */
  23 \f
  24 #ifndef _ELFCOMM_H
  25 #define _ELFCOMM_H
  26
  27 #include "aout/ar.h"
  28
  29 extern void error (const char *, ...) ATTRIBUTE_PRINTF_1;
  30 extern void warn (const char *, ...) ATTRIBUTE_PRINTF_1;
  31
  32 typedef unsigned HOST_WIDEST_INT elf_vma;
  33
  34 extern void (*byte_put) (unsigned char *, elf_vma, int);
  35 extern void byte_put_little_endian (unsigned char *, elf_vma, int);
  36 extern void byte_put_big_endian (unsigned char *, elf_vma, int);
  37
  38 extern elf_vma (*byte_get) (const unsigned char *, int);
  39 extern elf_vma byte_get_signed (const unsigned char *, int);
  40 extern elf_vma byte_get_little_endian (const unsigned char *, int);
  41 extern elf_vma byte_get_big_endian (const unsigned char *, int);
  42 extern void byte_get_64 (const unsigned char *, elf_vma *, elf_vma *);
  43
  44 #define BYTE_PUT(field, val)    byte_put (field, val, sizeof (field))
  45 #define BYTE_GET(field)         byte_get (field, sizeof (field))
  46 #define BYTE_GET_SIGNED(field)  byte_get_signed (field, sizeof (field))
  47
  48 /* This is just a bit of syntatic sugar.  */
  49 #define streq(a,b)        (strcmp ((a), (b)) == 0)
  50
  51 /* Structure to hold information about an archive file.  */
  52
  53 struct archive_info
  54 {
  55   char * file_name;                     /* Archive file name.  */
  56   FILE * file;                          /* Open file descriptor.  */
  57   elf_vma index_num;                    /* Number of symbols in table.  */
  58   elf_vma * index_array;                /* The array of member offsets.  */
  59   char * sym_table;                     /* The symbol table.  */
  60   unsigned long sym_size;               /* Size of the symbol table.  */
  61   char * longnames;                     /* The long file names table.  */
  62   unsigned long longnames_size;         /* Size of the long file names table.  */
  63   unsigned long nested_member_origin;   /* Origin in the nested archive of the current member.  */
  64   unsigned long next_arhdr_offset;      /* Offset of the next archive header.  */
  65   int is_thin_archive;                  /* 1 if this is a thin archive.  */
  66   int uses_64bit_indices;               /* 1 if the index table uses 64bit entries.  */
  67   struct ar_hdr arhdr;                  /* Current archive header.  */
  68 };
  69
  70 /* Return the path name for a proxy entry in a thin archive.  */
  71 extern char *adjust_relative_path (const char *, const char *, unsigned long);
  72
  73 /* Read the symbol table and long-name table from an archive.  */
  74 extern int setup_archive (struct archive_info *, const char *, FILE *,
  75                           off_t, int, int);
  76
  77 /* Open and setup a nested archive, if not already open.  */
  78 extern int setup_nested_archive (struct archive_info *, const char *);
  79
  80 /* Release the memory used for the archive information.  */
  81 extern void release_archive (struct archive_info *);
  82
  83 /* Get the name of an archive member from the current archive header.  */
  84
  85 extern char *get_archive_member_name (struct archive_info *,
  86                                       struct archive_info *);
  87
  88 /* Get the name of an archive member at a given offset within an
  89    archive.  */
  90
  91 extern char *get_archive_member_name_at (struct archive_info *,
  92                                          unsigned long,
  93                                          struct archive_info *);
  94
  95 /* Construct a string showing the name of the archive member, qualified
  96    with the name of the containing archive file.  */
  97
  98 extern char *make_qualified_name (struct archive_info *,
  99                                   struct archive_info *,
 100                                   const char *);
 101
 102 #endif /* _ELFCOMM_H */