1 // readsyms.cc -- read input file symbols for gold
3 // Copyright 2006, 2007, 2008, 2009, 2010, 2011 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"
37 #include "incremental.h"
42 // If we fail to open the object, then we won't create an Add_symbols
43 // task. However, we still need to unblock the token, or else the
44 // link won't proceed to generate more error messages. We can only
45 // unblock tokens when the workqueue lock is held, so we need a dummy
46 // task to do that. The dummy task has to maintain the right sequence
47 // of blocks, so we need both this_blocker and next_blocker.
49 class Unblock_token
: public Task
52 Unblock_token(Task_token
* this_blocker
, Task_token
* next_blocker
)
53 : this_blocker_(this_blocker
), next_blocker_(next_blocker
)
58 if (this->this_blocker_
!= NULL
)
59 delete this->this_blocker_
;
65 if (this->this_blocker_
!= NULL
&& this->this_blocker_
->is_blocked())
66 return this->this_blocker_
;
71 locks(Task_locker
* tl
)
72 { tl
->add(this, this->next_blocker_
); }
80 { return "Unblock_token"; }
83 Task_token
* this_blocker_
;
84 Task_token
* next_blocker_
;
87 // Class read_symbols.
89 Read_symbols::~Read_symbols()
91 // The this_blocker_ and next_blocker_ pointers are passed on to the
95 // If appropriate, issue a warning about skipping an incompatible
99 Read_symbols::incompatible_warning(const Input_argument
* input_argument
,
100 const Input_file
* input_file
)
102 if (parameters
->options().warn_search_mismatch())
103 gold_warning("skipping incompatible %s while searching for %s",
104 input_file
->filename().c_str(),
105 input_argument
->file().name());
108 // Requeue a Read_symbols task to search for the next object with the
112 Read_symbols::requeue(Workqueue
* workqueue
, Input_objects
* input_objects
,
113 Symbol_table
* symtab
, Layout
* layout
, Dirsearch
* dirpath
,
114 int dirindex
, Mapfile
* mapfile
,
115 const Input_argument
* input_argument
,
116 Input_group
* input_group
, Task_token
* next_blocker
)
118 // Bump the directory search index.
121 // We don't need to worry about this_blocker, since we already
122 // reached it. However, we are removing the blocker on next_blocker
123 // because the calling task is completing. So we need to add a new
124 // blocker. Since next_blocker may be shared by several tasks, we
125 // need to increment the count with the workqueue lock held.
126 workqueue
->add_blocker(next_blocker
);
128 workqueue
->queue(new Read_symbols(input_objects
, symtab
, layout
, dirpath
,
129 dirindex
, mapfile
, input_argument
,
130 input_group
, NULL
, NULL
, next_blocker
));
133 // Return whether a Read_symbols task is runnable. We can read an
134 // ordinary input file immediately. For an archive specified using
135 // -l, we have to wait until the search path is complete.
138 Read_symbols::is_runnable()
140 if (this->input_argument_
->is_file()
141 && this->input_argument_
->file().may_need_search()
142 && this->dirpath_
->token()->is_blocked())
143 return this->dirpath_
->token();
148 // Return a Task_locker for a Read_symbols task. We don't need any
152 Read_symbols::locks(Task_locker
* tl
)
154 if (this->member_
!= NULL
)
155 tl
->add(this, this->next_blocker_
);
158 // Run a Read_symbols task.
161 Read_symbols::run(Workqueue
* workqueue
)
163 // If we didn't queue a new task, then we need to explicitly unblock
165 if (!this->do_read_symbols(workqueue
))
166 workqueue
->queue_soon(new Unblock_token(this->this_blocker_
,
167 this->next_blocker_
));
170 // Handle a whole lib group. Other than collecting statistics, this just
171 // mimics what we do for regular object files in the command line.
174 Read_symbols::do_whole_lib_group(Workqueue
* workqueue
)
176 const Input_file_lib
* lib_group
= this->input_argument_
->lib();
178 ++Lib_group::total_lib_groups
;
180 Task_token
* this_blocker
= this->this_blocker_
;
181 for (Input_file_lib::const_iterator i
= lib_group
->begin();
182 i
!= lib_group
->end();
185 ++Lib_group::total_members
;
186 ++Lib_group::total_members_loaded
;
188 const Input_argument
* arg
= &*i
;
190 Task_token
* next_blocker
;
191 if (i
!= lib_group
->end() - 1)
193 next_blocker
= new Task_token(true);
194 next_blocker
->add_blocker();
197 next_blocker
= this->next_blocker_
;
199 workqueue
->queue_soon(new Read_symbols(this->input_objects_
,
200 this->symtab_
, this->layout_
,
201 this->dirpath_
, this->dirindex_
,
202 this->mapfile_
, arg
, NULL
,
203 NULL
, this_blocker
, next_blocker
));
204 this_blocker
= next_blocker
;
210 // Handle a lib group. We set Read_symbols Tasks as usual, but have them
211 // just record the symbol data instead of adding the objects. We also start
212 // a Add_lib_group_symbols Task which runs after we've read all the symbols.
213 // In that task we process the members in a loop until we are done.
216 Read_symbols::do_lib_group(Workqueue
* workqueue
)
218 const Input_file_lib
* lib_group
= this->input_argument_
->lib();
220 if (lib_group
->options().whole_archive())
221 return this->do_whole_lib_group(workqueue
);
223 Lib_group
* lib
= new Lib_group(lib_group
, this);
225 Add_lib_group_symbols
* add_lib_group_symbols
=
226 new Add_lib_group_symbols(this->symtab_
, this->layout_
,
227 this->input_objects_
,
228 lib
, this->next_blocker_
);
231 Task_token
* next_blocker
= new Task_token(true);
233 for (Input_file_lib::const_iterator i
= lib_group
->begin();
234 i
!= lib_group
->end();
237 const Input_argument
* arg
= &*i
;
238 Archive_member
* m
= lib
->get_member(j
);
240 next_blocker
->add_blocker();
242 // Since this Read_symbols will not create an Add_symbols,
243 // just pass NULL as this_blocker.
244 workqueue
->queue_soon(new Read_symbols(this->input_objects_
,
245 this->symtab_
, this->layout_
,
246 this->dirpath_
, this->dirindex_
,
247 this->mapfile_
, arg
, NULL
,
248 m
, NULL
, next_blocker
));
251 add_lib_group_symbols
->set_blocker(next_blocker
, this->this_blocker_
);
252 workqueue
->queue_soon(add_lib_group_symbols
);
257 // Open the file and read the symbols. Return true if a new task was
258 // queued, false if that could not happen due to some error.
261 Read_symbols::do_read_symbols(Workqueue
* workqueue
)
263 if (this->input_argument_
->is_group())
265 gold_assert(this->input_group_
== NULL
);
266 this->do_group(workqueue
);
270 if (this->input_argument_
->is_lib())
271 return this->do_lib_group(workqueue
);
273 Input_file
* input_file
= new Input_file(&this->input_argument_
->file());
274 if (!input_file
->open(*this->dirpath_
, this, &this->dirindex_
))
277 // Read enough of the file to pick up the entire ELF header.
279 off_t filesize
= input_file
->file().filesize();
283 gold_error(_("%s: file is empty"),
284 input_file
->file().filename().c_str());
288 const unsigned char* ehdr
;
290 bool is_elf
= is_elf_object(input_file
, 0, &ehdr
, &read_size
);
292 if (read_size
>= Archive::sarmag
)
295 = memcmp(ehdr
, Archive::armagt
, Archive::sarmag
) == 0;
297 || memcmp(ehdr
, Archive::armag
, Archive::sarmag
) == 0)
299 // This is an archive.
300 Archive
* arch
= new Archive(this->input_argument_
->file().name(),
301 input_file
, is_thin_archive
,
302 this->dirpath_
, this);
305 // Unlock the archive so it can be used in the next task.
308 workqueue
->queue_next(new Add_archive_symbols(this->symtab_
,
310 this->input_objects_
,
314 this->input_argument_
,
318 this->next_blocker_
));
323 if (parameters
->options().has_plugins())
325 Pluginobj
* obj
= parameters
->options().plugins()->claim_file(input_file
,
329 // The input file was claimed by a plugin, and its symbols
330 // have been provided by the plugin.
332 // We are done with the file at this point, so unlock it.
335 if (this->member_
!= NULL
)
337 this->member_
->sd_
= NULL
;
338 this->member_
->obj_
= obj
;
342 workqueue
->queue_next(new Add_symbols(this->input_objects_
,
348 this->input_argument_
,
353 this->next_blocker_
));
360 // This is an ELF object.
362 bool unconfigured
= false;
363 bool* punconfigured
= (input_file
->will_search_for()
366 Object
* obj
= make_elf_object(input_file
->filename(),
367 input_file
, 0, ehdr
, read_size
,
373 Read_symbols::incompatible_warning(this->input_argument_
,
375 input_file
->file().release();
376 input_file
->file().unlock(this);
379 return this->do_read_symbols(workqueue
);
384 Read_symbols_data
* sd
= new Read_symbols_data
;
385 obj
->read_symbols(sd
);
387 // Opening the file locked it, so now we need to unlock it. We
388 // need to unlock it before queuing the Add_symbols task,
389 // because the workqueue doesn't know about our lock on the
390 // file. If we queue the Add_symbols task first, it will be
391 // stuck on the end of the file lock, but since the workqueue
392 // doesn't know about that lock, it will never release the
395 input_file
->file().unlock(this);
397 if (this->member_
!= NULL
)
399 this->member_
->sd_
= sd
;
400 this->member_
->obj_
= obj
;
401 this->member_
->arg_serial_
=
402 this->input_argument_
->file().arg_serial();
406 // We use queue_next because everything is cached for this
407 // task to run right away if possible.
409 workqueue
->queue_next(new Add_symbols(this->input_objects_
,
410 this->symtab_
, this->layout_
,
414 this->input_argument_
,
419 this->next_blocker_
));
424 // Queue up a task to try to parse this file as a script. We use a
425 // separate task so that the script will be read in order with other
426 // objects named on the command line. Also so that we don't try to
427 // read multiple scripts simultaneously, which could lead to
428 // unpredictable changes to the General_options structure.
430 workqueue
->queue_soon(new Read_script(this->symtab_
,
434 this->input_objects_
,
437 this->input_argument_
,
440 this->next_blocker_
));
444 // Handle a group. We need to walk through the arguments over and
445 // over until we don't see any new undefined symbols. We do this by
446 // setting off Read_symbols Tasks as usual, but recording the archive
447 // entries instead of deleting them. We also start a Finish_group
448 // Task which runs after we've read all the symbols. In that task we
449 // process the archives in a loop until we are done.
452 Read_symbols::do_group(Workqueue
* workqueue
)
454 Input_group
* input_group
= new Input_group();
456 const Input_file_group
* group
= this->input_argument_
->group();
457 Task_token
* this_blocker
= this->this_blocker_
;
459 Finish_group
* finish_group
= new Finish_group(this->input_objects_
,
464 this->next_blocker_
);
466 Task_token
* next_blocker
= new Task_token(true);
467 next_blocker
->add_blocker();
468 workqueue
->queue_soon(new Start_group(this->symtab_
, finish_group
,
469 this_blocker
, next_blocker
));
470 this_blocker
= next_blocker
;
472 for (Input_file_group::const_iterator p
= group
->begin();
476 const Input_argument
* arg
= &*p
;
477 gold_assert(arg
->is_file());
479 next_blocker
= new Task_token(true);
480 next_blocker
->add_blocker();
481 workqueue
->queue_soon(new Read_symbols(this->input_objects_
,
482 this->symtab_
, this->layout_
,
483 this->dirpath_
, this->dirindex_
,
484 this->mapfile_
, arg
, input_group
,
485 NULL
, this_blocker
, next_blocker
));
486 this_blocker
= next_blocker
;
489 finish_group
->set_blocker(this_blocker
);
491 workqueue
->queue_soon(finish_group
);
494 // Return a debugging name for a Read_symbols task.
497 Read_symbols::get_name() const
499 if (this->input_argument_
->is_group())
501 std::string
ret("Read_symbols group (");
502 bool add_space
= false;
503 const Input_file_group
* group
= this->input_argument_
->group();
504 for (Input_file_group::const_iterator p
= group
->begin();
510 ret
+= p
->file().name();
515 else if (this->input_argument_
->is_lib())
517 std::string
ret("Read_symbols lib (");
518 bool add_space
= false;
519 const Input_file_lib
* lib
= this->input_argument_
->lib();
520 for (Input_file_lib::const_iterator p
= lib
->begin();
526 ret
+= p
->file().name();
533 std::string
ret("Read_symbols ");
534 if (this->input_argument_
->file().is_lib())
536 else if (this->input_argument_
->file().is_searched_file())
538 ret
+= this->input_argument_
->file().name();
543 // Class Add_symbols.
545 Add_symbols::~Add_symbols()
547 if (this->this_blocker_
!= NULL
)
548 delete this->this_blocker_
;
549 // next_blocker_ is deleted by the task associated with the next
553 // We are blocked by this_blocker_. We block next_blocker_. We also
557 Add_symbols::is_runnable()
559 if (this->this_blocker_
!= NULL
&& this->this_blocker_
->is_blocked())
560 return this->this_blocker_
;
561 if (this->object_
->is_locked())
562 return this->object_
->token();
567 Add_symbols::locks(Task_locker
* tl
)
569 tl
->add(this, this->next_blocker_
);
570 Task_token
* token
= this->object_
->token();
572 tl
->add(this, token
);
575 // Add the symbols in the object to the symbol table.
578 Add_symbols::run(Workqueue
*)
580 Pluginobj
* pluginobj
= this->object_
->pluginobj();
581 if (pluginobj
!= NULL
)
583 this->object_
->add_symbols(this->symtab_
, this->sd_
, this->layout_
);
587 if (!this->input_objects_
->add_object(this->object_
))
589 gold_assert(this->sd_
!= NULL
);
592 this->object_
->release();
593 delete this->object_
;
597 Incremental_inputs
* incremental_inputs
=
598 this->layout_
->incremental_inputs();
599 if (incremental_inputs
!= NULL
)
601 if (this->library_
!= NULL
&& !this->library_
->is_reported())
603 Incremental_binary
* ibase
= this->layout_
->incremental_base();
604 gold_assert(ibase
!= NULL
);
605 unsigned int lib_serial
= this->library_
->arg_serial();
606 unsigned int lib_index
= this->library_
->input_file_index();
607 Script_info
* lib_script_info
= ibase
->get_script_info(lib_index
);
608 incremental_inputs
->report_archive_begin(this->library_
,
612 unsigned int arg_serial
= this->input_argument_
->file().arg_serial();
613 Script_info
* script_info
= this->input_argument_
->script_info();
614 incremental_inputs
->report_object(this->object_
, arg_serial
,
615 this->library_
, script_info
);
617 this->object_
->layout(this->symtab_
, this->layout_
, this->sd_
);
618 this->object_
->add_symbols(this->symtab_
, this->sd_
, this->layout_
);
621 this->object_
->release();
625 // Class Read_member.
627 Read_member::~Read_member()
629 if (this->this_blocker_
!= NULL
)
630 delete this->this_blocker_
;
631 // next_blocker_ is deleted by the task associated with the next
635 // Return whether a Read_member task is runnable.
638 Read_member::is_runnable()
640 if (this->this_blocker_
!= NULL
&& this->this_blocker_
->is_blocked())
641 return this->this_blocker_
;
646 Read_member::locks(Task_locker
* tl
)
648 tl
->add(this, this->next_blocker_
);
651 // Run a Read_member task.
654 Read_member::run(Workqueue
*)
656 // This task doesn't need to do anything for now. The Read_symbols task
657 // that is queued for the archive library will cause the archive to be
658 // processed from scratch.
661 // Class Check_script.
663 Check_script::~Check_script()
665 if (this->this_blocker_
!= NULL
)
666 delete this->this_blocker_
;
667 // next_blocker_ is deleted by the task associated with the next
671 // Return whether a Check_script task is runnable.
674 Check_script::is_runnable()
676 if (this->this_blocker_
!= NULL
&& this->this_blocker_
->is_blocked())
677 return this->this_blocker_
;
682 Check_script::locks(Task_locker
* tl
)
684 tl
->add(this, this->next_blocker_
);
687 // Run a Check_script task.
690 Check_script::run(Workqueue
*)
692 Incremental_inputs
* incremental_inputs
= this->layout_
->incremental_inputs();
693 gold_assert(incremental_inputs
!= NULL
);
694 unsigned int arg_serial
= this->input_reader_
->arg_serial();
695 Script_info
* script_info
=
696 this->ibase_
->get_script_info(this->input_file_index_
);
697 Timespec mtime
= this->input_reader_
->get_mtime();
698 incremental_inputs
->report_script(script_info
, arg_serial
, mtime
);
701 // Class Check_library.
703 Check_library::~Check_library()
705 if (this->this_blocker_
!= NULL
)
706 delete this->this_blocker_
;
707 // next_blocker_ is deleted by the task associated with the next
711 // Return whether a Check_library task is runnable.
714 Check_library::is_runnable()
716 if (this->this_blocker_
!= NULL
&& this->this_blocker_
->is_blocked())
717 return this->this_blocker_
;
722 Check_library::locks(Task_locker
* tl
)
724 tl
->add(this, this->next_blocker_
);
727 // Run a Check_library task.
730 Check_library::run(Workqueue
*)
732 Incremental_inputs
* incremental_inputs
= this->layout_
->incremental_inputs();
733 gold_assert(incremental_inputs
!= NULL
);
734 Incremental_library
* lib
= this->ibase_
->get_library(this->input_file_index_
);
735 gold_assert(lib
!= NULL
);
736 lib
->copy_unused_symbols();
737 // FIXME: Check that unused symbols remain unused.
738 if (!lib
->is_reported())
740 unsigned int lib_serial
= lib
->arg_serial();
741 unsigned int lib_index
= lib
->input_file_index();
742 Script_info
* script_info
= this->ibase_
->get_script_info(lib_index
);
743 incremental_inputs
->report_archive_begin(lib
, lib_serial
, script_info
);
745 incremental_inputs
->report_archive_end(lib
);
748 // Class Input_group.
750 // When we delete an Input_group we can delete the archive
753 Input_group::~Input_group()
755 for (Input_group::const_iterator p
= this->begin();
761 // Class Start_group.
763 Start_group::~Start_group()
765 if (this->this_blocker_
!= NULL
)
766 delete this->this_blocker_
;
767 // next_blocker_ is deleted by the task associated with the first
768 // file in the group.
771 // We need to wait for THIS_BLOCKER_ and unblock NEXT_BLOCKER_.
774 Start_group::is_runnable()
776 if (this->this_blocker_
!= NULL
&& this->this_blocker_
->is_blocked())
777 return this->this_blocker_
;
782 Start_group::locks(Task_locker
* tl
)
784 tl
->add(this, this->next_blocker_
);
787 // Store the number of undefined symbols we see now.
790 Start_group::run(Workqueue
*)
792 this->finish_group_
->set_saw_undefined(this->symtab_
->saw_undefined());
795 // Class Finish_group.
797 Finish_group::~Finish_group()
799 if (this->this_blocker_
!= NULL
)
800 delete this->this_blocker_
;
801 // next_blocker_ is deleted by the task associated with the next
802 // input file following the group.
805 // We need to wait for THIS_BLOCKER_ and unblock NEXT_BLOCKER_.
808 Finish_group::is_runnable()
810 if (this->this_blocker_
!= NULL
&& this->this_blocker_
->is_blocked())
811 return this->this_blocker_
;
816 Finish_group::locks(Task_locker
* tl
)
818 tl
->add(this, this->next_blocker_
);
821 // Loop over the archives until there are no new undefined symbols.
824 Finish_group::run(Workqueue
*)
826 size_t saw_undefined
= this->saw_undefined_
;
827 while (saw_undefined
!= this->symtab_
->saw_undefined())
829 saw_undefined
= this->symtab_
->saw_undefined();
831 for (Input_group::const_iterator p
= this->input_group_
->begin();
832 p
!= this->input_group_
->end();
835 Task_lock_obj
<Archive
> tl(this, *p
);
837 (*p
)->add_symbols(this->symtab_
, this->layout_
,
838 this->input_objects_
, this->mapfile_
);
842 // Now that we're done with the archives, record the incremental
843 // layout information.
844 for (Input_group::const_iterator p
= this->input_group_
->begin();
845 p
!= this->input_group_
->end();
848 // For an incremental link, finish recording the layout information.
849 Incremental_inputs
* incremental_inputs
=
850 this->layout_
->incremental_inputs();
851 if (incremental_inputs
!= NULL
)
852 incremental_inputs
->report_archive_end(*p
);
855 if (parameters
->options().has_plugins())
856 parameters
->options().plugins()->save_input_group(this->input_group_
);
858 delete this->input_group_
;
863 Read_script::~Read_script()
865 if (this->this_blocker_
!= NULL
)
866 delete this->this_blocker_
;
867 // next_blocker_ is deleted by the task associated with the next
871 // We are blocked by this_blocker_.
874 Read_script::is_runnable()
876 if (this->this_blocker_
!= NULL
&& this->this_blocker_
->is_blocked())
877 return this->this_blocker_
;
881 // We don't unlock next_blocker_ here. If the script names any input
882 // files, then the last file will be responsible for unlocking it.
885 Read_script::locks(Task_locker
*)
889 // Read the script, if it is a script.
892 Read_script::run(Workqueue
* workqueue
)
894 bool used_next_blocker
;
895 if (!read_input_script(workqueue
, this->symtab_
, this->layout_
,
896 this->dirpath_
, this->dirindex_
, this->input_objects_
,
897 this->mapfile_
, this->input_group_
,
898 this->input_argument_
, this->input_file_
,
899 this->next_blocker_
, &used_next_blocker
))
901 // Here we have to handle any other input file types we need.
902 gold_error(_("%s: not an object or archive"),
903 this->input_file_
->file().filename().c_str());
906 if (!used_next_blocker
)
908 // Queue up a task to unlock next_blocker. We can't just unlock
909 // it here, as we don't hold the workqueue lock.
910 workqueue
->queue_soon(new Unblock_token(NULL
, this->next_blocker_
));
914 // Return a debugging name for a Read_script task.
917 Read_script::get_name() const
919 std::string
ret("Read_script ");
920 if (this->input_argument_
->file().is_lib())
922 else if (this->input_argument_
->file().is_searched_file())
924 ret
+= this->input_argument_
->file().name();
928 } // End namespace gold.
This page took 0.059057 seconds and 4 git commands to generate.