1 // readsyms.cc -- read input file symbols for gold
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.
29 #include "dirsearch.h"
39 // If we fail to open the object, then we won't create an Add_symbols
40 // task. However, we still need to unblock the token, or else the
41 // link won't proceed to generate more error messages. We can only
42 // unblock tokens when the workqueue lock is held, so we need a dummy
43 // task to do that. The dummy task has to maintain the right sequence
44 // of blocks, so we need both this_blocker and next_blocker.
46 class Unblock_token : public Task
49 Unblock_token(Task_token* this_blocker, Task_token* next_blocker)
50 : this_blocker_(this_blocker), next_blocker_(next_blocker)
55 if (this->this_blocker_ != NULL)
56 delete this->this_blocker_;
62 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
63 return this->this_blocker_;
68 locks(Task_locker* tl)
69 { tl->add(this, this->next_blocker_); }
77 { return "Unblock_token"; }
80 Task_token* this_blocker_;
81 Task_token* next_blocker_;
84 // Class read_symbols.
86 Read_symbols::~Read_symbols()
88 // The this_blocker_ and next_blocker_ pointers are passed on to the
92 // Return whether a Read_symbols task is runnable. We can read an
93 // ordinary input file immediately. For an archive specified using
94 // -l, we have to wait until the search path is complete.
97 Read_symbols::is_runnable()
99 if (this->input_argument_->is_file()
100 && this->input_argument_->file().may_need_search()
101 && this->dirpath_->token()->is_blocked())
102 return this->dirpath_->token();
107 // Return a Task_locker for a Read_symbols task. We don't need any
111 Read_symbols::locks(Task_locker*)
115 // Run a Read_symbols task.
118 Read_symbols::run(Workqueue* workqueue)
120 // If we didn't queue a new task, then we need to explicitly unblock
122 if (!this->do_read_symbols(workqueue))
123 workqueue->queue_soon(new Unblock_token(this->this_blocker_,
124 this->next_blocker_));
127 // Open the file and read the symbols. Return true if a new task was
128 // queued, false if that could not happen due to some error.
131 Read_symbols::do_read_symbols(Workqueue* workqueue)
133 if (this->input_argument_->is_group())
135 gold_assert(this->input_group_ == NULL);
136 this->do_group(workqueue);
140 Input_file* input_file = new Input_file(&this->input_argument_->file());
141 if (!input_file->open(this->options_, *this->dirpath_, this))
144 // Read enough of the file to pick up the entire ELF header.
146 off_t filesize = input_file->file().filesize();
150 gold_error(_("%s: file is empty"),
151 input_file->file().filename().c_str());
155 int read_size = elfcpp::Elf_sizes<64>::ehdr_size;
156 if (filesize < read_size)
157 read_size = filesize;
159 const unsigned char* ehdr = input_file->file().get_view(0, 0, read_size,
164 static unsigned char elfmagic[4] =
166 elfcpp::ELFMAG0, elfcpp::ELFMAG1,
167 elfcpp::ELFMAG2, elfcpp::ELFMAG3
169 if (memcmp(ehdr, elfmagic, 4) == 0)
171 // This is an ELF object.
173 Object* obj = make_elf_object(input_file->filename(),
174 input_file, 0, ehdr, read_size);
178 Read_symbols_data* sd = new Read_symbols_data;
179 obj->read_symbols(sd);
181 // Opening the file locked it, so now we need to unlock it.
182 // We need to unlock it before queuing the Add_symbols task,
183 // because the workqueue doesn't know about our lock on the
184 // file. If we queue the Add_symbols task first, it will be
185 // stuck on the end of the file lock, but since the
186 // workqueue doesn't know about that lock, it will never
187 // release the Add_symbols task.
189 input_file->file().unlock(this);
191 // We use queue_next because everything is cached for this
192 // task to run right away if possible.
194 workqueue->queue_next(new Add_symbols(this->input_objects_,
195 this->symtab_, this->layout_,
198 this->next_blocker_));
204 if (read_size >= Archive::sarmag)
207 = memcmp(ehdr, Archive::armagt, Archive::sarmag) == 0;
209 || memcmp(ehdr, Archive::armag, Archive::sarmag) == 0)
211 // This is an archive.
212 Archive* arch = new Archive(this->input_argument_->file().name(),
213 input_file, is_thin_archive,
214 this->dirpath_, this);
217 // Unlock the archive so it can be used in the next task.
220 workqueue->queue_next(new Add_archive_symbols(this->symtab_,
222 this->input_objects_,
226 this->next_blocker_));
231 // Queue up a task to try to parse this file as a script. We use a
232 // separate task so that the script will be read in order with other
233 // objects named on the command line. Also so that we don't try to
234 // read multiple scripts simultaneously, which could lead to
235 // unpredictable changes to the General_options structure.
237 workqueue->queue_soon(new Read_script(this->options_,
241 this->input_objects_,
243 this->input_argument_,
246 this->next_blocker_));
250 // Handle a group. We need to walk through the arguments over and
251 // over until we don't see any new undefined symbols. We do this by
252 // setting off Read_symbols Tasks as usual, but recording the archive
253 // entries instead of deleting them. We also start a Finish_group
254 // Task which runs after we've read all the symbols. In that task we
255 // process the archives in a loop until we are done.
258 Read_symbols::do_group(Workqueue* workqueue)
260 Input_group* input_group = new Input_group();
262 const Input_file_group* group = this->input_argument_->group();
263 Task_token* this_blocker = this->this_blocker_;
265 for (Input_file_group::const_iterator p = group->begin();
269 const Input_argument* arg = &*p;
270 gold_assert(arg->is_file());
272 Task_token* next_blocker = new Task_token(true);
273 next_blocker->add_blocker();
274 workqueue->queue_soon(new Read_symbols(this->options_,
275 this->input_objects_,
276 this->symtab_, this->layout_,
277 this->dirpath_, arg, input_group,
278 this_blocker, next_blocker));
279 this_blocker = next_blocker;
282 const int saw_undefined = this->symtab_->saw_undefined();
283 workqueue->queue_soon(new Finish_group(this->input_objects_,
289 this->next_blocker_));
292 // Return a debugging name for a Read_symbols task.
295 Read_symbols::get_name() const
297 if (!this->input_argument_->is_group())
299 std::string ret("Read_symbols ");
300 if (this->input_argument_->file().is_lib())
302 ret += this->input_argument_->file().name();
306 std::string ret("Read_symbols group (");
307 bool add_space = false;
308 const Input_file_group* group = this->input_argument_->group();
309 for (Input_file_group::const_iterator p = group->begin();
315 ret += p->file().name();
321 // Class Add_symbols.
323 Add_symbols::~Add_symbols()
325 if (this->this_blocker_ != NULL)
326 delete this->this_blocker_;
327 // next_blocker_ is deleted by the task associated with the next
331 // We are blocked by this_blocker_. We block next_blocker_. We also
335 Add_symbols::is_runnable()
337 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
338 return this->this_blocker_;
339 if (this->object_->is_locked())
340 return this->object_->token();
345 Add_symbols::locks(Task_locker* tl)
347 tl->add(this, this->next_blocker_);
348 tl->add(this, this->object_->token());
351 // Add the symbols in the object to the symbol table.
354 Add_symbols::run(Workqueue*)
356 if (!this->input_objects_->add_object(this->object_))
358 // FIXME: We need to close the descriptor here.
359 delete this->object_;
363 this->object_->layout(this->symtab_, this->layout_, this->sd_);
364 this->object_->add_symbols(this->symtab_, this->sd_);
365 this->object_->release();
371 // Class Finish_group.
373 Finish_group::~Finish_group()
375 if (this->this_blocker_ != NULL)
376 delete this->this_blocker_;
377 // next_blocker_ is deleted by the task associated with the next
378 // input file following the group.
381 // We need to wait for THIS_BLOCKER_ and unblock NEXT_BLOCKER_.
384 Finish_group::is_runnable()
386 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
387 return this->this_blocker_;
392 Finish_group::locks(Task_locker* tl)
394 tl->add(this, this->next_blocker_);
397 // Loop over the archives until there are no new undefined symbols.
400 Finish_group::run(Workqueue*)
402 int saw_undefined = this->saw_undefined_;
403 while (saw_undefined != this->symtab_->saw_undefined())
405 saw_undefined = this->symtab_->saw_undefined();
407 for (Input_group::const_iterator p = this->input_group_->begin();
408 p != this->input_group_->end();
411 Task_lock_obj<Archive> tl(this, *p);
413 (*p)->add_symbols(this->symtab_, this->layout_,
414 this->input_objects_);
418 // Delete all the archives now that we no longer need them.
419 for (Input_group::const_iterator p = this->input_group_->begin();
420 p != this->input_group_->end();
423 delete this->input_group_;
428 Read_script::~Read_script()
430 if (this->this_blocker_ != NULL)
431 delete this->this_blocker_;
432 // next_blocker_ is deleted by the task associated with the next
436 // We are blocked by this_blocker_.
439 Read_script::is_runnable()
441 if (this->this_blocker_ != NULL && this->this_blocker_->is_blocked())
442 return this->this_blocker_;
446 // We don't unlock next_blocker_ here. If the script names any input
447 // files, then the last file will be responsible for unlocking it.
450 Read_script::locks(Task_locker*)
454 // Read the script, if it is a script.
457 Read_script::run(Workqueue* workqueue)
459 bool used_next_blocker;
460 if (!read_input_script(workqueue, this->options_, this->symtab_,
461 this->layout_, this->dirpath_, this->input_objects_,
462 this->input_group_, this->input_argument_,
463 this->input_file_, this->next_blocker_,
466 // Here we have to handle any other input file types we need.
467 gold_error(_("%s: not an object or archive"),
468 this->input_file_->file().filename().c_str());
471 if (!used_next_blocker)
473 // Queue up a task to unlock next_blocker. We can't just unlock
474 // it here, as we don't hold the workqueue lock.
475 workqueue->queue_soon(new Unblock_token(NULL, this->next_blocker_));
479 // Return a debugging name for a Read_script task.
482 Read_script::get_name() const
484 std::string ret("Read_script ");
485 if (this->input_argument_->file().is_lib())
487 ret += this->input_argument_->file().name();
491 } // End namespace gold.