1 // archive.h -- archive support for gold -*- C++ -*-
3 // Copyright 2006, 2007, 2008 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
6 // This file is part of gold.
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
23 #ifndef GOLD_ARCHIVE_H
24 #define GOLD_ARCHIVE_H
30 #include "workqueue.h"
43 class Read_symbols_data
;
45 // This class represents an archive--generally a libNAME.a file.
46 // Archives have a symbol table and a list of objects.
51 Archive(const std::string
& name
, Input_file
* input_file
,
52 bool is_thin_archive
, Dirsearch
* dirpath
, Task
* task
)
53 : name_(name
), input_file_(input_file
), armap_(), armap_names_(),
54 extended_names_(), armap_checked_(), seen_offsets_(), members_(),
55 is_thin_archive_(is_thin_archive
), included_member_(false),
56 nested_archives_(), dirpath_(dirpath
), task_(task
), num_members_(0)
59 // The length of the magic string at the start of an archive.
60 static const int sarmag
= 8;
62 // The magic string at the start of an archive.
63 static const char armag
[sarmag
];
64 static const char armagt
[sarmag
];
66 // The string expected at the end of an archive member header.
67 static const char arfmag
[2];
69 // The name of the object. This is the name used on the command
70 // line; e.g., if "-lgcc" is on the command line, this will be
74 { return this->name_
; }
79 { return this->input_file_
; }
84 { return this->input_file_
->filename(); }
86 // Set up the archive: read the symbol map.
90 // Get a reference to the underlying file.
93 { return this->input_file_
->file(); }
97 { return this->input_file_
->file(); }
99 // Lock the underlying file.
102 { this->input_file_
->file().lock(t
); }
104 // Unlock the underlying file.
106 unlock(const Task
* t
)
107 { this->input_file_
->file().unlock(t
); }
109 // Return whether the underlying file is locked.
112 { return this->input_file_
->file().is_locked(); }
114 // Return the token, so that the task can be queued.
117 { return this->input_file_
->file().token(); }
119 // Release the underlying file.
122 { this->input_file_
->file().release(); }
124 // Clear uncached views in the underlying file.
126 clear_uncached_views()
127 { this->input_file_
->file().clear_uncached_views(); }
129 // Whether this is a thin archive.
131 is_thin_archive() const
132 { return this->is_thin_archive_
; }
134 // Unlock any nested archives.
136 unlock_nested_archives();
138 // Select members from the archive as needed and add them to the
141 add_symbols(Symbol_table
*, Layout
*, Input_objects
*, Mapfile
*);
143 // Dump statistical information to stderr.
147 // Return the number of members in the archive.
152 Archive(const Archive
&);
153 Archive
& operator=(const Archive
&);
155 struct Archive_header
;
157 // Total number of archives seen.
158 static unsigned int total_archives
;
159 // Total number of archive members seen.
160 static unsigned int total_members
;
161 // Number of archive members loaded.
162 static unsigned int total_members_loaded
;
164 // Get a view into the underlying file.
166 get_view(off_t start
, section_size_type size
, bool aligned
, bool cache
)
167 { return this->input_file_
->file().get_view(0, start
, size
, aligned
, cache
); }
169 // Read the archive symbol map.
171 read_armap(off_t start
, section_size_type size
);
173 // Read an archive member header at OFF. CACHE is whether to cache
174 // the file view. Return the size of the member, and set *PNAME to
177 read_header(off_t off
, bool cache
, std::string
* pname
, off_t
* nested_off
);
179 // Interpret an archive header HDR at OFF. Return the size of the
180 // member, and set *PNAME to the name.
182 interpret_header(const Archive_header
* hdr
, off_t off
, std::string
* pname
,
183 off_t
* nested_off
) const;
185 // Get the file and offset for an archive member, which may be an
186 // external member of a thin archive. Set *INPUT_FILE to the
187 // file containing the actual member, *MEMOFF to the offset
188 // within that file (0 if not a nested archive), and *MEMBER_NAME
189 // to the name of the archive member. Return TRUE on success.
191 get_file_and_offset(off_t off
, Input_file
** input_file
, off_t
* memoff
,
192 off_t
* memsize
, std::string
* member_name
);
194 // Return an ELF object for the member at offset OFF.
196 get_elf_object_for_member(off_t off
, bool*);
198 // Read the symbols from all the archive members in the link.
202 // Read the symbols from an archive member in the link. OFF is the file
203 // offset of the member header.
205 read_symbols(off_t off
);
207 // Include all the archive members in the link.
209 include_all_members(Symbol_table
*, Layout
*, Input_objects
*, Mapfile
*);
211 // Include an archive member in the link.
213 include_member(Symbol_table
*, Layout
*, Input_objects
*, off_t off
,
214 Mapfile
*, Symbol
*, const char* why
);
216 // Return whether we found this archive by searching a directory.
219 { return this->input_file_
->will_search_for(); }
221 // Iterate over archive members.
222 class const_iterator
;
230 friend class const_iterator
;
232 // An entry in the archive map of symbols to object files.
235 // The offset to the symbol name in armap_names_.
237 // The file offset to the object in the archive.
241 // An entry in the archive map of offsets to members.
242 struct Archive_member
245 : obj_(NULL
), sd_(NULL
)
247 Archive_member(Object
* obj
, Read_symbols_data
* sd
)
252 // The data to pass from read_symbols() to add_symbols().
253 Read_symbols_data
* sd_
;
256 // A simple hash code for off_t values.
260 size_t operator()(off_t val
) const
261 { return static_cast<size_t>(val
); }
264 // For keeping track of open nested archives in a thin archive file.
265 typedef Unordered_map
<std::string
, Archive
*> Nested_archive_table
;
267 // Name of object as printed to user.
269 // For reading the file.
270 Input_file
* input_file_
;
272 std::vector
<Armap_entry
> armap_
;
273 // The names in the archive map.
274 std::string armap_names_
;
275 // The extended name table.
276 std::string extended_names_
;
277 // Track which symbols in the archive map are for elements which are
278 // defined or which have already been included in the link.
279 std::vector
<bool> armap_checked_
;
280 // Track which elements have been included by offset.
281 Unordered_set
<off_t
, Seen_hash
> seen_offsets_
;
282 // Table of objects whose symbols have been pre-read.
283 std::map
<off_t
, Archive_member
> members_
;
284 // True if this is a thin archive.
285 const bool is_thin_archive_
;
286 // True if we have included at least one object from this archive.
287 bool included_member_
;
288 // Table of nested archives, indexed by filename.
289 Nested_archive_table nested_archives_
;
290 // The directory search path.
292 // The task reading this archive.
294 // Number of members in this archive;
295 unsigned int num_members_
;
298 // This class is used to read an archive and pick out the desired
299 // elements and add them to the link.
301 class Add_archive_symbols
: public Task
304 Add_archive_symbols(Symbol_table
* symtab
, Layout
* layout
,
305 Input_objects
* input_objects
, Dirsearch
* dirpath
,
306 int dirindex
, Mapfile
* mapfile
,
307 const Input_argument
* input_argument
,
308 Archive
* archive
, Input_group
* input_group
,
309 Task_token
* this_blocker
,
310 Task_token
* next_blocker
)
311 : symtab_(symtab
), layout_(layout
), input_objects_(input_objects
),
312 dirpath_(dirpath
), dirindex_(dirindex
), mapfile_(mapfile
),
313 input_argument_(input_argument
), archive_(archive
),
314 input_group_(input_group
), this_blocker_(this_blocker
),
315 next_blocker_(next_blocker
)
318 ~Add_archive_symbols();
320 // The standard Task methods.
334 if (this->archive_
== NULL
)
335 return "Add_archive_symbols";
336 return "Add_archive_symbols " + this->archive_
->file().filename();
340 Symbol_table
* symtab_
;
342 Input_objects
* input_objects_
;
346 const Input_argument
* input_argument_
;
348 Input_group
* input_group_
;
349 Task_token
* this_blocker_
;
350 Task_token
* next_blocker_
;
353 } // End namespace gold.
355 #endif // !defined(GOLD_ARCHIVE_H)