1 // archive.h -- archive support for gold -*- C++ -*-
3 // Copyright 2006, 2007 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
29 #include "workqueue.h"
40 // This class represents an archive--generally a libNAME.a file.
41 // Archives have a symbol table and a list of objects.
46 Archive(const std::string
& name
, Input_file
* input_file
)
47 : name_(name
), input_file_(input_file
), armap_(), extended_names_()
50 // The length of the magic string at the start of an archive.
51 static const int sarmag
= 8;
53 // The magic string at the start of an archive.
54 static const char armag
[sarmag
];
56 // The string expected at the end of an archive member header.
57 static const char arfmag
[2];
59 // The name of the object.
62 { return this->name_
; }
64 // Set up the archive: read the symbol map.
68 // Get a reference to the underlying file.
71 { return this->input_file_
->file(); }
73 // Lock the underlying file.
76 { this->input_file_
->file().lock(); }
78 // Unlock the underlying file.
81 { this->input_file_
->file().unlock(); }
83 // Return whether the underlying file is locked.
86 { return this->input_file_
->file().is_locked(); }
88 // Select members from the archive as needed and add them to the
91 add_symbols(Symbol_table
*, Layout
*, Input_objects
*);
94 Archive(const Archive
&);
95 Archive
& operator=(const Archive
&);
97 struct Archive_header
;
99 // Get a view into the underlying file.
101 get_view(off_t start
, off_t size
, off_t
* pbytes
= NULL
)
102 { return this->input_file_
->file().get_view(start
, size
, pbytes
); }
104 // Read the archive symbol map.
106 read_armap(off_t start
, off_t size
);
108 // Read an archive member header at OFF. Return the size of the
109 // member, and set *PNAME to the name.
111 read_header(off_t off
, std::string
* pname
);
113 // Interpret an archive header HDR at OFF. Return the size of the
114 // member, and set *PNAME to the name.
116 interpret_header(const Archive_header
* hdr
, off_t off
, std::string
* pname
);
118 // Include all the archive members in the link.
120 include_all_members(Symbol_table
*, Layout
*, Input_objects
*);
122 // Include an archive member in the link.
124 include_member(Symbol_table
*, Layout
*, Input_objects
*, off_t off
);
126 // An entry in the archive map of symbols to object files.
131 // The offset to the file.
135 // A simple hash code for off_t values.
139 size_t operator()(off_t val
) const
140 { return static_cast<size_t>(val
); }
143 // Name of object as printed to user.
145 // For reading the file.
146 Input_file
* input_file_
;
148 std::vector
<Armap_entry
> armap_
;
149 // The extended name table.
150 std::string extended_names_
;
151 // Track which symbols in the archive map are for elements which are
152 // defined or which have already been included in the link.
153 std::vector
<bool> armap_checked_
;
154 // Track which elements have been included by offset.
155 Unordered_set
<off_t
, Seen_hash
> seen_offsets_
;
158 // This class is used to read an archive and pick out the desired
159 // elements and add them to the link.
161 class Add_archive_symbols
: public Task
164 Add_archive_symbols(Symbol_table
* symtab
, Layout
* layout
,
165 Input_objects
* input_objects
,
166 Archive
* archive
, Input_group
* input_group
,
167 Task_token
* this_blocker
,
168 Task_token
* next_blocker
)
169 : symtab_(symtab
), layout_(layout
), input_objects_(input_objects
),
170 archive_(archive
), input_group_(input_group
),
171 this_blocker_(this_blocker
), next_blocker_(next_blocker
)
174 ~Add_archive_symbols();
176 // The standard Task methods.
179 is_runnable(Workqueue
*);
188 class Add_archive_symbols_locker
;
190 Symbol_table
* symtab_
;
192 Input_objects
* input_objects_
;
194 Input_group
* input_group_
;
195 Task_token
* this_blocker_
;
196 Task_token
* next_blocker_
;
199 } // End namespace gold.
201 #endif // !defined(GOLD_ARCHIVE_H)