1/* elfcomm.h -- include file of common code for ELF format file.
2   Copyright (C) 2010-2017 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
24#ifndef _ELFCOMM_H
25#define _ELFCOMM_H
26
27#include "aout/ar.h"
28
29void error (const char *, ...) ATTRIBUTE_PRINTF_1;
30void warn (const char *, ...) ATTRIBUTE_PRINTF_1;
31
32typedef unsigned HOST_WIDEST_INT elf_vma;
33
34extern void (*byte_put) (unsigned char *, elf_vma, int);
35extern void byte_put_little_endian (unsigned char *, elf_vma, int);
36extern void byte_put_big_endian (unsigned char *, elf_vma, int);
37
38extern elf_vma (*byte_get) (unsigned char *, int);
39extern elf_vma byte_get_signed (unsigned char *, int);
40extern elf_vma byte_get_little_endian (unsigned char *, int);
41extern elf_vma byte_get_big_endian (unsigned char *, int);
42extern void byte_get_64 (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#define strneq(a,b,n)	  (strncmp ((a), (b), (n)) == 0)
51#define const_strneq(a,b) (strncmp ((a), (b), sizeof (b) - 1) == 0)
52
53/* Structure to hold information about an archive file.  */
54
55struct archive_info
56{
57  char * file_name;                     /* Archive file name.  */
58  FILE * file;                          /* Open file descriptor.  */
59  elf_vma index_num;                    /* Number of symbols in table.  */
60  elf_vma * index_array;                /* The array of member offsets.  */
61  char * sym_table;                     /* The symbol table.  */
62  unsigned long sym_size;               /* Size of the symbol table.  */
63  char * longnames;                     /* The long file names table.  */
64  unsigned long longnames_size;         /* Size of the long file names table.  */
65  unsigned long nested_member_origin;   /* Origin in the nested archive of the current member.  */
66  unsigned long next_arhdr_offset;      /* Offset of the next archive header.  */
67  bfd_boolean is_thin_archive;          /* TRUE if this is a thin archive.  */
68  bfd_boolean uses_64bit_indicies;      /* TRUE if the index table uses 64bit entries.  */
69  struct ar_hdr arhdr;                  /* Current archive header.  */
70};
71
72/* Return the path name for a proxy entry in a thin archive.  */
73extern char *adjust_relative_path (const char *, const char *, unsigned long);
74
75/* Read the symbol table and long-name table from an archive.  */
76extern int setup_archive (struct archive_info *, const char *, FILE *,
77			  bfd_boolean, bfd_boolean);
78
79/* Open and setup a nested archive, if not already open.  */
80extern int setup_nested_archive (struct archive_info *, const char *);
81
82/* Release the memory used for the archive information.  */
83extern void release_archive (struct archive_info *);
84
85/* Get the name of an archive member from the current archive header.  */
86
87extern char *get_archive_member_name (struct archive_info *,
88				      struct archive_info *);
89
90/* Get the name of an archive member at a given offset within an
91   archive.  */
92
93extern char *get_archive_member_name_at (struct archive_info *,
94					 unsigned long,
95					 struct archive_info *);
96
97/* Construct a string showing the name of the archive member, qualified
98   with the name of the containing archive file.  */
99
100extern char *make_qualified_name (struct archive_info *,
101				  struct archive_info *,
102				  const char *);
103
104#endif /* _ELFCOMM_H */
105