binutils/elfcomm.h

   1 /* elfcomm.h -- include file of common code for ELF format file.
   2    Copyright (C) 2010-2024 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 extern void inform (const char *, ...) ATTRIBUTE_PRINTF_1;
  32
  33 extern void (*byte_put) (unsigned char *, uint64_t, unsigned int);
  34 extern void byte_put_little_endian (unsigned char *, uint64_t, unsigned int);
  35 extern void byte_put_big_endian (unsigned char *, uint64_t, unsigned int);
  36
  37 extern uint64_t (*byte_get) (const unsigned char *, unsigned int);
  38 extern uint64_t byte_get_signed (const unsigned char *, unsigned int);
  39 extern uint64_t byte_get_little_endian (const unsigned char *, unsigned int);
  40 extern uint64_t byte_get_big_endian (const unsigned char *, unsigned int);
  41
  42 #define BYTE_PUT(field, val)    byte_put (field, val, sizeof (field))
  43 #define BYTE_GET(field)         byte_get (field, sizeof (field))
  44 #define BYTE_GET_SIGNED(field)  byte_get_signed (field, sizeof (field))
  45
  46 /* This is just a bit of syntatic sugar.  */
  47 #define streq(a,b)        (strcmp ((a), (b)) == 0)
  48
  49 /* Structure to hold information about an archive file.  */
  50
  51 struct archive_info
  52 {
  53   char *file_name;               /* Archive file name.  */
  54   FILE *file;                    /* Open file descriptor.  */
  55   uint64_t index_num;            /* Number of symbols in table.  */
  56   uint64_t *index_array;         /* The array of member offsets.  */
  57   char *sym_table;               /* The symbol table.  */
  58   uint64_t sym_size;             /* Size of the symbol table.  */
  59   char *longnames;               /* The long file names table.  */
  60   uint64_t longnames_size;       /* Size of the long file names table.  */
  61   uint64_t nested_member_origin; /* Origin in the nested archive of the current member.  */
  62   uint64_t next_arhdr_offset;    /* Offset of the next archive header.  */
  63   int is_thin_archive;           /* 1 if this is a thin archive.  */
  64   int uses_64bit_indices;        /* 1 if the index table uses 64bit entries.  */
  65   struct ar_hdr arhdr;           /* Current archive header.  */
  66 };
  67
  68 /* Return the path name for a proxy entry in a thin archive.  */
  69 extern char *adjust_relative_path (const char *, const char *, unsigned long);
  70
  71 /* Read the symbol table and long-name table from an archive.  */
  72 extern int setup_archive (struct archive_info *, const char *, FILE *,
  73                           off_t, int, int);
  74
  75 /* Open and setup a nested archive, if not already open.  */
  76 extern int setup_nested_archive (struct archive_info *, const char *);
  77
  78 /* Release the memory used for the archive information.  */
  79 extern void release_archive (struct archive_info *);
  80
  81 /* Get the name of an archive member from the current archive header.  */
  82
  83 extern char *get_archive_member_name (struct archive_info *,
  84                                       struct archive_info *);
  85
  86 /* Get the name of an archive member at a given offset within an
  87    archive.  */
  88
  89 extern char *get_archive_member_name_at (struct archive_info *,
  90                                          unsigned long,
  91                                          struct archive_info *);
  92
  93 /* Construct a string showing the name of the archive member, qualified
  94    with the name of the containing archive file.  */
  95
  96 extern char *make_qualified_name (struct archive_info *,
  97                                   struct archive_info *,
  98                                   const char *);
  99
 100 #endif /* _ELFCOMM_H */