1 // archive.cc -- archive support for gold
3 // Copyright 2006, 2007, 2008, 2009 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.
29 #include "libiberty.h"
30 #include "filenames.h"
45 // The header of an entry in the archive. This is all readable text,
46 // padded with spaces where necesary. If the contents of an archive
47 // are all text file, the entire archive is readable.
49 struct Archive::Archive_header
53 // The file modification time.
55 // The user's UID in decimal.
57 // The user's GID in decimal.
59 // The file mode in octal.
61 // The file size in decimal.
63 // The final magic code.
67 // Class Archive static variables.
68 unsigned int Archive::total_archives
;
69 unsigned int Archive::total_members
;
70 unsigned int Archive::total_members_loaded
;
74 const char Archive::armag
[sarmag
] =
76 '!', '<', 'a', 'r', 'c', 'h', '>', '\n'
79 const char Archive::armagt
[sarmag
] =
81 '!', '<', 't', 'h', 'i', 'n', '>', '\n'
84 const char Archive::arfmag
[2] = { '`', '\n' };
86 // Set up the archive: read the symbol map and the extended name
92 // We need to ignore empty archives.
93 if (this->input_file_
->file().filesize() == sarmag
)
96 // The first member of the archive should be the symbol table.
97 std::string armap_name
;
98 section_size_type armap_size
=
99 convert_to_section_size_type(this->read_header(sarmag
, false,
102 if (armap_name
.empty())
104 this->read_armap(sarmag
+ sizeof(Archive_header
), armap_size
);
105 off
= sarmag
+ sizeof(Archive_header
) + armap_size
;
107 else if (!this->input_file_
->options().whole_archive())
108 gold_error(_("%s: no archive symbol table (run ranlib)"),
109 this->name().c_str());
111 // See if there is an extended name table. We cache these views
112 // because it is likely that we will want to read the following
113 // header in the add_symbols routine.
117 section_size_type extended_size
=
118 convert_to_section_size_type(this->read_header(off
, true, &xname
, NULL
));
121 const unsigned char* p
= this->get_view(off
+ sizeof(Archive_header
),
122 extended_size
, false, true);
123 const char* px
= reinterpret_cast<const char*>(p
);
124 this->extended_names_
.assign(px
, extended_size
);
126 bool preread_syms
= (parameters
->options().threads()
127 && parameters
->options().preread_archive_symbols());
128 #ifndef ENABLE_THREADS
129 preread_syms
= false;
131 if (parameters
->options().has_plugins())
132 preread_syms
= false;
135 this->read_all_symbols();
138 // Unlock any nested archives.
141 Archive::unlock_nested_archives()
143 for (Nested_archive_table::iterator p
= this->nested_archives_
.begin();
144 p
!= this->nested_archives_
.end();
147 p
->second
->unlock(this->task_
);
151 // Read the archive symbol map.
154 Archive::read_armap(off_t start
, section_size_type size
)
156 // To count the total number of archive members, we'll just count
157 // the number of times the file offset changes. Since most archives
158 // group the symbols in the armap by object, this ought to give us
159 // an accurate count.
160 off_t last_seen_offset
= -1;
162 // Read in the entire armap.
163 const unsigned char* p
= this->get_view(start
, size
, true, false);
165 // Numbers in the armap are always big-endian.
166 const elfcpp::Elf_Word
* pword
= reinterpret_cast<const elfcpp::Elf_Word
*>(p
);
167 unsigned int nsyms
= elfcpp::Swap
<32, true>::readval(pword
);
170 // Note that the addition is in units of sizeof(elfcpp::Elf_Word).
171 const char* pnames
= reinterpret_cast<const char*>(pword
+ nsyms
);
172 section_size_type names_size
=
173 reinterpret_cast<const char*>(p
) + size
- pnames
;
174 this->armap_names_
.assign(pnames
, names_size
);
176 this->armap_
.resize(nsyms
);
178 section_offset_type name_offset
= 0;
179 for (unsigned int i
= 0; i
< nsyms
; ++i
)
181 this->armap_
[i
].name_offset
= name_offset
;
182 this->armap_
[i
].file_offset
= elfcpp::Swap
<32, true>::readval(pword
);
183 name_offset
+= strlen(pnames
+ name_offset
) + 1;
185 if (this->armap_
[i
].file_offset
!= last_seen_offset
)
187 last_seen_offset
= this->armap_
[i
].file_offset
;
188 ++this->num_members_
;
192 if (static_cast<section_size_type
>(name_offset
) > names_size
)
193 gold_error(_("%s: bad archive symbol table names"),
194 this->name().c_str());
196 // This array keeps track of which symbols are for archive elements
197 // which we have already included in the link.
198 this->armap_checked_
.resize(nsyms
);
201 // Read the header of an archive member at OFF. Fail if something
202 // goes wrong. Return the size of the member. Set *PNAME to the name
206 Archive::read_header(off_t off
, bool cache
, std::string
* pname
,
209 const unsigned char* p
= this->get_view(off
, sizeof(Archive_header
), true,
211 const Archive_header
* hdr
= reinterpret_cast<const Archive_header
*>(p
);
212 return this->interpret_header(hdr
, off
, pname
, nested_off
);
215 // Interpret the header of HDR, the header of the archive member at
216 // file offset OFF. Fail if something goes wrong. Return the size of
217 // the member. Set *PNAME to the name of the member.
220 Archive::interpret_header(const Archive_header
* hdr
, off_t off
,
221 std::string
* pname
, off_t
* nested_off
) const
223 if (memcmp(hdr
->ar_fmag
, arfmag
, sizeof arfmag
) != 0)
225 gold_error(_("%s: malformed archive header at %zu"),
226 this->name().c_str(), static_cast<size_t>(off
));
227 return this->input_file_
->file().filesize() - off
;
230 const int size_string_size
= sizeof hdr
->ar_size
;
231 char size_string
[size_string_size
+ 1];
232 memcpy(size_string
, hdr
->ar_size
, size_string_size
);
233 char* ps
= size_string
+ size_string_size
;
234 while (ps
[-1] == ' ')
240 off_t member_size
= strtol(size_string
, &end
, 10);
243 || (member_size
== LONG_MAX
&& errno
== ERANGE
))
245 gold_error(_("%s: malformed archive header size at %zu"),
246 this->name().c_str(), static_cast<size_t>(off
));
247 return this->input_file_
->file().filesize() - off
;
250 if (hdr
->ar_name
[0] != '/')
252 const char* name_end
= strchr(hdr
->ar_name
, '/');
254 || name_end
- hdr
->ar_name
>= static_cast<int>(sizeof hdr
->ar_name
))
256 gold_error(_("%s: malformed archive header name at %zu"),
257 this->name().c_str(), static_cast<size_t>(off
));
258 return this->input_file_
->file().filesize() - off
;
260 pname
->assign(hdr
->ar_name
, name_end
- hdr
->ar_name
);
261 if (nested_off
!= NULL
)
264 else if (hdr
->ar_name
[1] == ' ')
266 // This is the symbol table.
269 else if (hdr
->ar_name
[1] == '/')
271 // This is the extended name table.
272 pname
->assign(1, '/');
277 long x
= strtol(hdr
->ar_name
+ 1, &end
, 10);
280 y
= strtol(end
+ 1, &end
, 10);
283 || (x
== LONG_MAX
&& errno
== ERANGE
)
284 || static_cast<size_t>(x
) >= this->extended_names_
.size())
286 gold_error(_("%s: bad extended name index at %zu"),
287 this->name().c_str(), static_cast<size_t>(off
));
288 return this->input_file_
->file().filesize() - off
;
291 const char* name
= this->extended_names_
.data() + x
;
292 const char* name_end
= strchr(name
, '\n');
293 if (static_cast<size_t>(name_end
- name
) > this->extended_names_
.size()
294 || name_end
[-1] != '/')
296 gold_error(_("%s: bad extended name entry at header %zu"),
297 this->name().c_str(), static_cast<size_t>(off
));
298 return this->input_file_
->file().filesize() - off
;
300 pname
->assign(name
, name_end
- 1 - name
);
301 if (nested_off
!= NULL
)
308 // An archive member iterator.
310 class Archive::const_iterator
313 // The header of an archive member. This is what this iterator
317 // The name of the member.
319 // The file offset of the member.
321 // The file offset of a nested archive member.
323 // The size of the member.
327 const_iterator(Archive
* archive
, off_t off
)
328 : archive_(archive
), off_(off
)
329 { this->read_next_header(); }
333 { return this->header_
; }
337 { return &this->header_
; }
342 if (this->off_
== this->archive_
->file().filesize())
344 this->off_
+= sizeof(Archive_header
);
345 if (!this->archive_
->is_thin_archive())
346 this->off_
+= this->header_
.size
;
347 if ((this->off_
& 1) != 0)
349 this->read_next_header();
356 const_iterator ret
= *this;
362 operator==(const const_iterator p
) const
363 { return this->off_
== p
->off
; }
366 operator!=(const const_iterator p
) const
367 { return this->off_
!= p
->off
; }
373 // The underlying archive.
375 // The current offset in the file.
377 // The current archive header.
381 // Read the next archive header.
384 Archive::const_iterator::read_next_header()
386 off_t filesize
= this->archive_
->file().filesize();
389 if (filesize
- this->off_
< static_cast<off_t
>(sizeof(Archive_header
)))
391 if (filesize
!= this->off_
)
393 gold_error(_("%s: short archive header at %zu"),
394 this->archive_
->filename().c_str(),
395 static_cast<size_t>(this->off_
));
396 this->off_
= filesize
;
398 this->header_
.off
= filesize
;
402 unsigned char buf
[sizeof(Archive_header
)];
403 this->archive_
->file().read(this->off_
, sizeof(Archive_header
), buf
);
405 const Archive_header
* hdr
= reinterpret_cast<const Archive_header
*>(buf
);
407 this->archive_
->interpret_header(hdr
, this->off_
, &this->header_
.name
,
408 &this->header_
.nested_off
);
409 this->header_
.off
= this->off_
;
411 // Skip special members.
412 if (!this->header_
.name
.empty() && this->header_
.name
!= "/")
415 this->off_
+= sizeof(Archive_header
) + this->header_
.size
;
416 if ((this->off_
& 1) != 0)
423 Archive::const_iterator
426 return Archive::const_iterator(this, sarmag
);
431 Archive::const_iterator
434 return Archive::const_iterator(this, this->input_file_
->file().filesize());
437 // Get the file and offset for an archive member, which may be an
438 // external member of a thin archive. Set *INPUT_FILE to the
439 // file containing the actual member, *MEMOFF to the offset
440 // within that file (0 if not a nested archive), and *MEMBER_NAME
441 // to the name of the archive member. Return TRUE on success.
444 Archive::get_file_and_offset(off_t off
, Input_file
** input_file
, off_t
* memoff
,
445 off_t
* memsize
, std::string
* member_name
)
449 *memsize
= this->read_header(off
, false, member_name
, &nested_off
);
451 *input_file
= this->input_file_
;
452 *memoff
= off
+ static_cast<off_t
>(sizeof(Archive_header
));
454 if (!this->is_thin_archive_
)
457 // Adjust a relative pathname so that it is relative
458 // to the directory containing the archive.
459 if (!IS_ABSOLUTE_PATH(member_name
->c_str()))
461 const char* arch_path
= this->filename().c_str();
462 const char* basename
= lbasename(arch_path
);
463 if (basename
> arch_path
)
464 member_name
->replace(0, 0,
465 this->filename().substr(0, basename
- arch_path
));
470 // This is a member of a nested archive. Open the containing
471 // archive if we don't already have it open, then do a recursive
472 // call to include the member from that archive.
474 Nested_archive_table::const_iterator p
=
475 this->nested_archives_
.find(*member_name
);
476 if (p
!= this->nested_archives_
.end())
480 Input_file_argument
* input_file_arg
=
481 new Input_file_argument(member_name
->c_str(), false, "", false,
482 parameters
->options());
483 *input_file
= new Input_file(input_file_arg
);
485 if (!(*input_file
)->open(*this->dirpath_
, this->task_
, &dummy
))
487 arch
= new Archive(*member_name
, *input_file
, false, this->dirpath_
,
490 std::pair
<Nested_archive_table::iterator
, bool> ins
=
491 this->nested_archives_
.insert(std::make_pair(*member_name
, arch
));
492 gold_assert(ins
.second
);
494 return arch
->get_file_and_offset(nested_off
, input_file
, memoff
,
495 memsize
, member_name
);
498 // This is an external member of a thin archive. Open the
499 // file as a regular relocatable object file.
500 Input_file_argument
* input_file_arg
=
501 new Input_file_argument(member_name
->c_str(), false, "", false,
502 this->input_file_
->options());
503 *input_file
= new Input_file(input_file_arg
);
505 if (!(*input_file
)->open(*this->dirpath_
, this->task_
, &dummy
))
509 *memsize
= (*input_file
)->file().filesize();
513 // Return an ELF object for the member at offset OFF. If the ELF
514 // object has an unsupported target type, set *PUNCONFIGURED to true
518 Archive::get_elf_object_for_member(off_t off
, bool* punconfigured
)
520 *punconfigured
= false;
522 Input_file
* input_file
;
525 std::string member_name
;
526 if (!this->get_file_and_offset(off
, &input_file
, &memoff
, &memsize
,
530 if (parameters
->options().has_plugins())
532 Object
* obj
= parameters
->options().plugins()->claim_file(input_file
,
537 // The input file was claimed by a plugin, and its symbols
538 // have been provided by the plugin.
543 off_t filesize
= input_file
->file().filesize();
544 int read_size
= elfcpp::Elf_sizes
<64>::ehdr_size
;
545 if (filesize
- memoff
< read_size
)
546 read_size
= filesize
- memoff
;
550 gold_error(_("%s: member at %zu is not an ELF object"),
551 this->name().c_str(), static_cast<size_t>(off
));
555 const unsigned char* ehdr
= input_file
->file().get_view(memoff
, 0, read_size
,
558 static unsigned char elfmagic
[4] =
560 elfcpp::ELFMAG0
, elfcpp::ELFMAG1
,
561 elfcpp::ELFMAG2
, elfcpp::ELFMAG3
563 if (memcmp(ehdr
, elfmagic
, 4) != 0)
565 gold_error(_("%s: member at %zu is not an ELF object"),
566 this->name().c_str(), static_cast<size_t>(off
));
570 return make_elf_object((std::string(this->input_file_
->filename())
571 + "(" + member_name
+ ")"),
572 input_file
, memoff
, ehdr
, read_size
,
576 // Read the symbols from all the archive members in the link.
579 Archive::read_all_symbols()
581 for (Archive::const_iterator p
= this->begin();
584 this->read_symbols(p
->off
);
587 // Read the symbols from an archive member in the link. OFF is the file
588 // offset of the member header.
591 Archive::read_symbols(off_t off
)
594 Object
* obj
= this->get_elf_object_for_member(off
, &dummy
);
599 Read_symbols_data
* sd
= new Read_symbols_data
;
600 obj
->read_symbols(sd
);
601 Archive_member
member(obj
, sd
);
602 this->members_
[off
] = member
;
605 // Select members from the archive and add them to the link. We walk
606 // through the elements in the archive map, and look each one up in
607 // the symbol table. If it exists as a strong undefined symbol, we
608 // pull in the corresponding element. We have to do this in a loop,
609 // since pulling in one element may create new undefined symbols which
610 // may be satisfied by other objects in the archive. Return true in
611 // the normal case, false if the first member we tried to add from
612 // this archive had an incompatible target.
615 Archive::add_symbols(Symbol_table
* symtab
, Layout
* layout
,
616 Input_objects
* input_objects
, Mapfile
* mapfile
)
618 ++Archive::total_archives
;
620 if (this->input_file_
->options().whole_archive())
621 return this->include_all_members(symtab
, layout
, input_objects
,
624 Archive::total_members
+= this->num_members_
;
626 input_objects
->archive_start(this);
628 const size_t armap_size
= this->armap_
.size();
630 // This is a quick optimization, since we usually see many symbols
631 // in a row with the same offset. last_seen_offset holds the last
632 // offset we saw that was present in the seen_offsets_ set.
633 off_t last_seen_offset
= -1;
635 // Track which symbols in the symbol table we've already found to be
639 size_t tmpbuflen
= 0;
640 bool added_new_object
;
643 added_new_object
= false;
644 for (size_t i
= 0; i
< armap_size
; ++i
)
646 if (this->armap_checked_
[i
])
648 if (this->armap_
[i
].file_offset
== last_seen_offset
)
650 this->armap_checked_
[i
] = true;
653 if (this->seen_offsets_
.find(this->armap_
[i
].file_offset
)
654 != this->seen_offsets_
.end())
656 this->armap_checked_
[i
] = true;
657 last_seen_offset
= this->armap_
[i
].file_offset
;
661 const char* sym_name
= (this->armap_names_
.data()
662 + this->armap_
[i
].name_offset
);
664 // In an object file, and therefore in an archive map, an
665 // '@' in the name separates the symbol name from the
666 // version name. If there are two '@' characters, this is
667 // the default version.
668 const char* ver
= strchr(sym_name
, '@');
672 size_t symlen
= ver
- sym_name
;
673 if (symlen
+ 1 > tmpbuflen
)
675 tmpbuf
= static_cast<char*>(realloc(tmpbuf
, symlen
+ 1));
676 tmpbuflen
= symlen
+ 1;
678 memcpy(tmpbuf
, sym_name
, symlen
);
679 tmpbuf
[symlen
] = '\0';
690 Symbol
* sym
= symtab
->lookup(sym_name
, ver
);
693 || !sym
->is_undefined()
694 || sym
->binding() == elfcpp::STB_WEAK
))
695 sym
= symtab
->lookup(sym_name
, NULL
);
699 // Check whether the symbol was named in a -u option.
700 if (!parameters
->options().is_undefined(sym_name
))
703 else if (!sym
->is_undefined())
705 this->armap_checked_
[i
] = true;
708 else if (sym
->binding() == elfcpp::STB_WEAK
)
711 // We want to include this object in the link.
712 last_seen_offset
= this->armap_
[i
].file_offset
;
713 this->seen_offsets_
.insert(last_seen_offset
);
714 this->armap_checked_
[i
] = true;
722 if (!this->include_member(symtab
, layout
, input_objects
,
723 last_seen_offset
, mapfile
, sym
,
731 added_new_object
= true;
734 while (added_new_object
);
739 input_objects
->archive_stop(this);
744 // Include all the archive members in the link. This is for --whole-archive.
747 Archive::include_all_members(Symbol_table
* symtab
, Layout
* layout
,
748 Input_objects
* input_objects
, Mapfile
* mapfile
)
750 input_objects
->archive_start(this);
752 if (this->members_
.size() > 0)
754 std::map
<off_t
, Archive_member
>::const_iterator p
;
755 for (p
= this->members_
.begin();
756 p
!= this->members_
.end();
759 if (!this->include_member(symtab
, layout
, input_objects
, p
->first
,
760 mapfile
, NULL
, "--whole-archive"))
762 ++Archive::total_members
;
767 for (Archive::const_iterator p
= this->begin();
771 if (!this->include_member(symtab
, layout
, input_objects
, p
->off
,
772 mapfile
, NULL
, "--whole-archive"))
774 ++Archive::total_members
;
778 input_objects
->archive_stop(this);
783 // Return the number of members in the archive. This is only used for
787 Archive::count_members()
790 for (Archive::const_iterator p
= this->begin();
797 // Include an archive member in the link. OFF is the file offset of
798 // the member header. WHY is the reason we are including this member.
799 // Return true if we added the member or if we had an error, return
800 // false if this was the first member we tried to add from this
801 // archive and it had an incompatible format.
804 Archive::include_member(Symbol_table
* symtab
, Layout
* layout
,
805 Input_objects
* input_objects
, off_t off
,
806 Mapfile
* mapfile
, Symbol
* sym
, const char* why
)
808 ++Archive::total_members_loaded
;
810 std::map
<off_t
, Archive_member
>::const_iterator p
= this->members_
.find(off
);
811 if (p
!= this->members_
.end())
813 Object
*obj
= p
->second
.obj_
;
815 if (!this->included_member_
816 && this->searched_for()
817 && !parameters
->is_compatible_target(obj
->target()))
820 Read_symbols_data
*sd
= p
->second
.sd_
;
822 mapfile
->report_include_archive_member(obj
->name(), sym
, why
);
823 if (input_objects
->add_object(obj
))
825 obj
->layout(symtab
, layout
, sd
);
826 obj
->add_symbols(symtab
, sd
, layout
);
827 this->included_member_
= true;
834 Object
* obj
= this->get_elf_object_for_member(off
, &unconfigured
);
836 if (!this->included_member_
837 && this->searched_for()
840 : !parameters
->is_compatible_target(obj
->target())))
851 mapfile
->report_include_archive_member(obj
->name(), sym
, why
);
853 Pluginobj
* pluginobj
= obj
->pluginobj();
854 if (pluginobj
!= NULL
)
856 pluginobj
->add_symbols(symtab
, NULL
, layout
);
857 this->included_member_
= true;
861 if (!input_objects
->add_object(obj
))
865 Read_symbols_data sd
;
866 obj
->read_symbols(&sd
);
867 obj
->layout(symtab
, layout
, &sd
);
868 obj
->add_symbols(symtab
, &sd
, layout
);
870 // If this is an external member of a thin archive, unlock the file
871 // for the next task.
872 if (obj
->offset() == 0)
873 obj
->unlock(this->task_
);
875 this->included_member_
= true;
881 // Print statistical information to stderr. This is used for --stats.
884 Archive::print_stats()
886 fprintf(stderr
, _("%s: archive libraries: %u\n"),
887 program_name
, Archive::total_archives
);
888 fprintf(stderr
, _("%s: total archive members: %u\n"),
889 program_name
, Archive::total_members
);
890 fprintf(stderr
, _("%s: loaded archive members: %u\n"),
891 program_name
, Archive::total_members_loaded
);
894 // Add_archive_symbols methods.
896 Add_archive_symbols::~Add_archive_symbols()
898 if (this->this_blocker_
!= NULL
)
899 delete this->this_blocker_
;
900 // next_blocker_ is deleted by the task associated with the next
904 // Return whether we can add the archive symbols. We are blocked by
905 // this_blocker_. We block next_blocker_. We also lock the file.
908 Add_archive_symbols::is_runnable()
910 if (this->this_blocker_
!= NULL
&& this->this_blocker_
->is_blocked())
911 return this->this_blocker_
;
916 Add_archive_symbols::locks(Task_locker
* tl
)
918 tl
->add(this, this->next_blocker_
);
919 tl
->add(this, this->archive_
->token());
923 Add_archive_symbols::run(Workqueue
* workqueue
)
925 bool added
= this->archive_
->add_symbols(this->symtab_
, this->layout_
,
926 this->input_objects_
,
928 this->archive_
->unlock_nested_archives();
930 this->archive_
->release();
931 this->archive_
->clear_uncached_views();
935 // This archive holds object files which are incompatible with
937 Read_symbols::incompatible_warning(this->input_argument_
,
938 this->archive_
->input_file());
939 Read_symbols::requeue(workqueue
, this->input_objects_
, this->symtab_
,
940 this->layout_
, this->dirpath_
, this->dirindex_
,
941 this->mapfile_
, this->input_argument_
,
942 this->input_group_
, this->next_blocker_
);
943 delete this->archive_
;
947 if (this->input_group_
!= NULL
)
948 this->input_group_
->add_archive(this->archive_
);
951 // We no longer need to know about this archive.
952 delete this->archive_
;
953 this->archive_
= NULL
;
957 } // End namespace gold.