binutils-gdb/gold/fileread.h
Cary Coutant cdc29364d1 * archive.cc (Archive::include_member): Adjust call to
report_object.
	(Add_archive_symbols::run): Track argument serial numbers.
	(Lib_group::include_member): Likewise.
	(Add_lib_group_symbols::run): Adjust call to report_archive_begin.
	* archive.h (Incremental_archive_entry::Archive_member):
	Initialize arg_serial_.
	(Archive_member::arg_serial_): New data member.
	* dynobj.cc (Dynobj::Dynobj): Allow input_file_ to be NULL.
	(Sized_dynobj::do_add_symbols): Track symbols when doing an
	incremental link.
	(Sized_dynobj::do_for_all_local_got_entries): New function.
	* dynobj.h: (Sized_dynobj::do_for_all_local_got_entries): New
	function.
	* fileread.cc (get_mtime): New function.
	* fileread.h (get_mtime): New function.
	* gold.cc (queue_initial_tasks): Check for incremental update.
	(process_incremental_input): New function.
	(queue_middle_tasks): Don't force valid target for incremental
	update.
	* incremental-dump.cc (find_input_containing_global): Adjust
	size of symbol info entry.
	(dump_incremental_inputs): Dump argument serial number and
	in_system_directory flag; bias shndx by 1; print symbol names
	when dumping per-file symbol lists; use new symbol info readers.
	* incremental.cc
	(Output_section_incremental_inputs:update_data_size): New function.
	(Sized_incremental_binary::setup_readers): Setup input readers
	for each input file; build maps for files added from libraries
	and scripts.
	(Sized_incremental_binary::check_input_args): New function.
	(Sized_incremental_binary::do_check_inputs): Build map of argument
	serial numbers to input arguments.
	(Sized_incremental_binary::do_file_has_changed): Rename
	do_file_is_unchanged to this; compare file modification times.
	(Sized_incremental_binary::do_init_layout): New function.
	(Sized_incremental_binary::do_reserve_layout): New function.
	(Sized_incremental_binary::do_get_input_reader): Remove.
	(Sized_incremental_binary::get_symtab_view): New function.
	(Incremental_checker::can_incrementally_link_output_file): Remove.
	(Incremental_inputs::report_command_line): Exclude --debug options.
	(Incremental_inputs::report_archive_begin): Add parameter; track
	argument serial numbers; don't put input file entry for archive
	before archive members.
	(Incremental_inputs::report_archive_end): Put input file entry
	for archive after archive members.
	(Incremental_inputs::report_object): Add parameter; track argument
	serial numbers and in_system_directory flag.
	(Incremental_inputs::report_script): Add parameter; track argument
	serial numbers.
	(Output_section_incremental_inputs::set_final_data_size): Adjust
	size of symbol info entry; check for forwarding symbols.
	(Output_section_incremental_inputs::write_input_files): Write
	in_system_directory flag and argument serial number.
	(Output_section_incremental_inputs::write_info_blocks): Map section
	indices between incremental info and original input file; store
	input section index for each symbol.
	(class Local_got_offset_visitor): Derive from Got_offset_list::Visitor;
	change operator() to visit().
	(class Global_got_offset_visitor): Likewise.
	(class Global_symbol_visitor_got_plt):
	(Output_section_incremental_inputs::write_got_plt): Use new visitor
	classes.
	(Sized_incr_relobj::Sized_incr_relobj): New constructor.
	(Sized_incr_relobj::do_read_symbols): New function.
	(Sized_incr_relobj::do_layout): New function.
	(Sized_incr_relobj::do_layout_deferred_sections): New function.
	(Sized_incr_relobj::do_add_symbols): New function.
	(Sized_incr_relobj::do_should_include_member): New function.
	(Sized_incr_relobj::do_for_all_global_symbols): New function.
	(Sized_incr_relobj::do_for_all_local_got_entries): New function.
	(Sized_incr_relobj::do_section_size): New function.
	(Sized_incr_relobj::do_section_name): New function.
	(Sized_incr_relobj::do_section_contents): New function.
	(Sized_incr_relobj::do_section_flags): New function.
	(Sized_incr_relobj::do_section_entsize): New function.
	(Sized_incr_relobj::do_section_address): New function.
	(Sized_incr_relobj::do_section_type): New function.
	(Sized_incr_relobj::do_section_link): New function.
	(Sized_incr_relobj::do_section_info): New function.
	(Sized_incr_relobj::do_section_addralign): New function.
	(Sized_incr_relobj::do_initialize_xindex): New function.
	(Sized_incr_relobj::do_get_global_symbol_counts): New function.
	(Sized_incr_relobj::do_read_relocs): New function.
	(Sized_incr_relobj::do_gc_process_relocs): New function.
	(Sized_incr_relobj::do_scan_relocs): New function.
	(Sized_incr_relobj::do_count_local_symbols): New function.
	(Sized_incr_relobj::do_finalize_local_symbols): New function.
	(Sized_incr_relobj::do_set_local_dynsym_indexes): New function.
	(Sized_incr_relobj::do_set_local_dynsym_offset): New function.
	(Sized_incr_relobj::do_relocate): New function.
	(Sized_incr_relobj::do_set_section_offset): New function.
	(Sized_incr_dynobj::Sized_incr_dynobj): New function.
	(Sized_incr_dynobj::do_read_symbols): New function.
	(Sized_incr_dynobj::do_layout): New function.
	(Sized_incr_dynobj::do_add_symbols): New function.
	(Sized_incr_dynobj::do_should_include_member): New function.
	(Sized_incr_dynobj::do_for_all_global_symbols): New function.
	(Sized_incr_dynobj::do_for_all_local_got_entries): New function.
	(Sized_incr_dynobj::do_section_size): New function.
	(Sized_incr_dynobj::do_section_name): New function.
	(Sized_incr_dynobj::do_section_contents): New function.
	(Sized_incr_dynobj::do_section_flags): New function.
	(Sized_incr_dynobj::do_section_entsize): New function.
	(Sized_incr_dynobj::do_section_address): New function.
	(Sized_incr_dynobj::do_section_type): New function.
	(Sized_incr_dynobj::do_section_link): New function.
	(Sized_incr_dynobj::do_section_info): New function.
	(Sized_incr_dynobj::do_section_addralign): New function.
	(Sized_incr_dynobj::do_initialize_xindex): New function.
	(Sized_incr_dynobj::do_get_global_symbol_counts): New function.
	(make_sized_incremental_object): New function.
	(Incremental_library::copy_unused_symbols): New function.
	(Incremental_library::do_for_all_unused_symbols): New function.
	* incremental.h (enum Incremental_input_flags): New type.
	(class Incremental_checker): Remove.
	(Incremental_input_entry::Incremental_input_entry): Add argument
	serial number.
	(Incremental_input_entry::arg_serial): New function.
	(Incremental_input_entry::set_is_in_system_directory): New function.
	(Incremental_input_entry::is_in_system_directory): New function.
	(Incremental_input_entry::arg_serial_): New data member.
	(Incremental_input_entry::is_in_system_directory_): New data member.
	(class Script_info): Move here from script.h.
	(Script_info::Script_info): Add filename parameter.
	(Script_info::filename): New function.
	(Script_info::filename_): New data member.
	(Incremental_script_entry::Incremental_script_entry): Add argument
	serial number.
	(Incremental_object_entry::Incremental_object_entry): Likewise.
	(Incremental_object_entry::add_input_section): Build list of input
	sections with map to original shndx.
	(Incremental_object_entry::get_input_section_index): New function.
	(Incremental_object_entry::shndx_): New data member.
	(Incremental_object_entry::name_key_): Rename; adjust all refs.
	(Incremental_object_entry::sh_size_): Rename; adjust all refs.
	(Incremental_archive_entry::Incremental_archive_entry): Add argument
	serial number.
	(Incremental_inputs::report_archive_begin): Likewise.
	(Incremental_inputs::report_object): Likewise.
	(Incremental_inputs::report_script): Likewise.
	(class Incremental_global_symbol_reader): New class.
	(Incremental_input_entry_reader::Incremental_input_entry_reader): Read
	and store flags and input file type.
	(Incremental_input_entry_reader::arg_serial): New function.
	(Incremental_input_entry_reader::type): Extract type from flags.
	(Incremental_input_entry_reader::is_in_system_directory): New function.
	(Incremental_input_entry_reader::get_input_section_count): Call
	accessor function for type.
	(Incremental_input_entry_reader::get_symbol_offset): Call accessor
	function for type; adjust size of global symbol entry.
	(Incremental_input_entry_reader::get_global_symbol_count): Call
	accessor function for type.
	(Incremental_input_entry_reader::get_object_count): Likewise.
	(Incremental_input_entry_reader::get_object_offset): Likewise.
	(Incremental_input_entry_reader::get_member_count): Likewise.
	(Incremental_input_entry_reader::get_unused_symbol_count): Likewise.
	(Incremental_input_entry_reader::get_member_offset): Likewise.
	(Incremental_input_entry_reader::get_unused_symbol): Likewise.
	(Incremental_input_entry_reader::Global_symbol_info): Remove.
	(Incremental_input_entry_reader::get_global_symbol_info): Remove.
	(Incremental_input_entry_reader::get_global_symbol_reader): New
	function.
	(Incremental_input_entry_reader::get_output_symbol_index): New
	function.
	(Incremental_input_entry_reader::type_): Remove.
	(Incremental_input_entry_reader::flags_): New data member.
	(Incremental_inputs_reader::input_file_offset): New function.
	(Incremental_inputs_reader::input_file_index): New function.
	(Incremental_inputs_reader::input_file): Call input_file_offset.
	(Incremental_inputs_reader::input_file_at_offset): New function.
	(Incremental_relocs_reader::get_r_type): Reformat.
	(Incremental_relocs_reader::get_r_shndx): Reformat.
	(Incremental_relocs_reader::get_r_offset): Reformat.
	(Incremental_relocs_reader::data): New function.
	(Incremental_binary::Incremental_binary): Initialize new data members.
	(Incremental_binary::check_inputs): Add cmdline parameter.
	(Incremental_binary::file_is_unchanged): Remove.
	(Input_reader::arg_serial): New function.
	(Input_reader::get_unused_symbol_count): New function.
	(Input_reader::get_unused_symbol): New function.
	(Input_reader::do_arg_serial): New function.
	(Input_reader::do_get_unused_symbol_count): New function.
	(Input_reader::do_get_unused_symbol): New function.
	(Incremental_binary::input_file_count): New function.
	(Incremental_binary::get_input_reader): Change signature to use
	index instead of filename.
	(Incremental_binary::file_has_changed): New function.
	(Incremental_binary::get_input_argument): New function.
	(Incremental_binary::get_library): New function.
	(Incremental_binary::get_script_info): New function.
	(Incremental_binary::init_layout): New function.
	(Incremental_binary::reserve_layout): New function.
	(Incremental_binary::output_file): New function.
	(Incremental_binary::do_check_inputs): New function.
	(Incremental_binary::do_file_is_unchanged): Remove.
	(Incremental_binary::do_file_has_changed): New function.
	(Incremental_binary::do_init_layout): New function.
	(Incremental_binary::do_reserve_layout): New function.
	(Incremental_binary::do_input_file_count): New function.
	(Incremental_binary::do_get_input_reader): Change signature.
	(Incremental_binary::input_args_map_): New data member.
	(Incremental_binary::library_map_): New data member.
	(Incremental_binary::script_map_): New data member.
	(Sized_incremental_binary::Sized_incremental_binary): Initialize
	new data members.
	(Sized_incremental_binary::output_section): New function.
	(Sized_incremental_binary::inputs_reader): Add const.
	(Sized_incremental_binary::symtab_reader): Add const.
	(Sized_incremental_binary::relocs_reader): Add const.
	(Sized_incremental_binary::got_plt_reader): Add const.
	(Sized_incremental_binary::get_symtab_view): New function.
	(Sized_incremental_binary::Inputs_reader): New typedef.
	(Sized_incremental_binary::Input_entry_reader): New typedef.
	(Sized_incremental_binary::do_check_inputs): Add cmdline parameter.
	(Sized_incremental_binary::do_file_is_unchanged): Remove.
	(Sized_incremental_binary::do_file_has_changed): New function.
	(Sized_incremental_binary::do_init_layout): New function.
	(Sized_incremental_binary::do_reserve_layout): New function.
	(Sized_input_reader::Inputs_reader): Remove.
	(Sized_input_reader::Input_entry_reader): Remove.
	(Sized_input_reader::do_arg_serial): New function.
	(Sized_input_reader::do_get_unused_symbol_count): New function.
	(Sized_input_reader::do_get_unused_symbol): New function.
	(Sized_incremental_binary::do_input_file_count): New function.
	(Sized_incremental_binary::do_get_input_reader): Change signature;
	use index instead of filename.
	(Sized_incremental_binary::section_map_): New data member.
	(Sized_incremental_binary::input_entry_readers_): New data member.
	(class Sized_incr_relobj): New class.
	(class Sized_incr_dynobj): New class.
	(make_sized_incremental_object): New function.
	(class Incremental_library): New class.
	* layout.cc (Free_list::num_lists): New static data member.
	(Free_list::num_nodes): New static data member.
	(Free_list::num_removes): New static data member.
	(Free_list::num_remove_visits): New static data member.
	(Free_list::num_allocates): New static data member.
	(Free_list::num_allocate_visits): New static data member.
	(Free_list::init): New function.
	(Free_list::remove): New function.
	(Free_list::allocate): New function.
	(Free_list::dump): New function.
	(Free_list::print_stats): New function.
	(Layout_task_runner::run): Resize output file for incremental updates.
	(Layout::Layout): Initialize new data members.
	(Layout::set_incremental_base): New function.
	(Layout::init_fixed_output_section): New function.
	(Layout::layout_eh_frame): Do not build .eh_frame_hdr section for
	incremental updates.
	(Layout::create_gold_note): Do not create gold note section for
	incremental updates.
	(Layout::set_segment_offsets): Do not recalculate RELRO alignment
	for incremental updates.
	(Layout::set_section_offsets): For incremental updates, allocate space
	from free list.
	(Layout::create_symtab_sections): Layout with offsets relative to
	start of section; for incremental updates, allocate space from free
	list.
	(Layout::create_shdrs): For incremental updates, allocate space from
	free list.
	(Layout::finish_dynamic_section): For incremental updates, do not
	check --as-needed (fixed in subsequent patch).
	* layout.h (class Free_list): New class.
	(Layout::set_incremental_base): New function.
	(Layout::incremental_base): New function.
	(Layout::init_fixed_output_section): New function.
	(Layout::allocate): New function.
	(Layout::incremental_base_): New data member.
	(Layout::free_list_): New data member.
	* main.cc (main): Print Free_list statistics.
	* object.cc (Relobj::finalize_incremental_relocs): Add
	clear_counts parameter; clear counts only when clear_counts is set.
	(Sized_relobj::Sized_relobj): Initialize new base class.
	(Sized_relobj::do_layout): Don't report special sections.
	(Sized_relobj::do_for_all_local_got_entries): New function.
	(Sized_relobj::write_local_symbols): Add symtab_off parameter; add
	symtab_off to all symbol table offsets.
	(Sized_relobj::do_get_global_symbol_counts): Add typename keyword.
	* object.h (class Got_offset_list): Move to top of file.
	(Object::Object): Allow case where input_file == NULL.
	(Object::~Object): Likewise.
	(Object::input_file): Assert that input_file != NULL.
	(Object::lock): Allow case where input_file == NULL.
	(Object::unlock): Likewise.
	(Object::is_locked): Likewise.
	(Object::token): Likewise.
	(Object::release): Likewise.
	(Object::is_incremental): New function.
	(Object::get_mtime): New function.
	(Object::for_all_local_got_entries): New function.
	(Object::clear_view_cache_marks): Allow case where input_file == NULL.
	(Object::set_is_in_system_directory): New function.
	(Object::is_in_system_directory): New function.
	(Object::do_is_incremental): New function.
	(Object::do_get_mtime): New function.
	(Object::do_for_all_local_got_entries): New function.
	(Object::is_in_system_directory_): New data member.
	(Relobj::finalize_incremental_relocs): Add clear_counts parameter.
	(class Sized_relobj_base): New class.
	(class Sized_relobj): Derive from Sized_relobj_base.
	(class Sized_relobj::Symbols): Redeclare from base class.
	(class Sized_relobj::local_got_offset_list): Remove.
	(class Sized_relobj::Output_sections): Redeclare from base class.
	(class Sized_relobj::do_for_all_local_got_entries): New function.
	(class Sized_relobj::write_local_symbols): Add offset parameter.
	(class Sized_relobj::local_symbol_offset_): Update comment.
	(class Sized_relobj::local_dynsym_offset_): Update comment.
	* options.cc (Input_arguments::add_file): Remove const.
	* options.h (Input_file_argument::Input_file_argument):
	Initialize arg_serial_ (all constructors).
	(Input_file_argument::set_arg_serial): New function.
	(Input_file_argument::arg_serial): New function.
	(Input_file_argument::arg_serial_): New data member.
	(Input_arguments::Input_arguments): Initialize file_count_.
	(Input_arguments::add_file): Remove const.
	(Input_arguments::number_of_input_files): New function.
	(Input_arguments::file_count_): New data member.
	(Command_line::number_of_input_files): Call
	Input_arguments::number_of_input_files.
	* output.cc (Output_segment_headers::Output_segment_headers):
	Set current size.
	(Output_section::Input_section::current_data_size): New function.
	(Output_section::Output_section): Initialize new data members.
	(Output_section::add_input_section): Don't do merge sections for
	an incremental link; allocate space from free list for an
	incremental update.
	(Output_section::add_output_section_data): Allocate space from
	free list for an incremental update.
	(Output_section::update_data_size): New function.
	(Output_section::set_fixed_layout): New function.
	(Output_section::reserve): New function.
	(Output_segment::set_section_addresses): Remove const.
	(Output_segment::set_section_list_addresses): Remove const; allocate
	space from free list for an incremental update.
	(Output_segment::set_offset): Adjust size of RELRO segment for an
	incremental update.
	* output.h (Output_data::current_data_size): Move here from
	child classes.
	(Output_data::pre_finalize_data_size): New function.
	(Output_data::update_data_size): New function.
	(Output_section_headers::update_data_size): new function.
	(Output_section_data_build::current_data_size): Move to Output_data.
	(Output_data_strtab::update_data_size): New function.
	(Output_section::current_data_size): Move to Output_data.
	(Output_section::set_fixed_layout): New function.
	(Output_section::has_fixed_layout): New function.
	(Output_section::reserve): New function.
	(Output_section::update_data_size): New function.
	(Output_section::has_fixed_layout_): New data member.
	(Output_section::free_list_): New data member.
	(Output_segment::set_section_addresses): Remove const.
	(Output_segment::set_section_list_addresses): Remove const.
	* plugin.cc (Sized_pluginobj::do_for_all_local_got_entries):
	New function.
	* plugin.h (Sized_pluginobj::do_for_all_local_got_entries):
	New function.
	* readsyms.cc (Read_symbols::do_read_symbols): Add library
	parameter when calling Add_symbols constructor; store argument
	serial number for members of a lib group.
	(Add_symbols::locks): Allow case where token == NULL.
	(Add_symbols::run): Report libraries denoted by --start-lib/--end-lib.
	(Read_member::~Read_member): New function.
	(Read_member::is_runnable): New function.
	(Read_member::locks): New function.
	(Read_member::run): New function.
	(Check_script::~Check_script): New function.
	(Check_script::is_runnable): New function.
	(Check_script::locks): New function.
	(Check_script::run): New function.
	(Check_library::~Check_library): New function.
	(Check_library::is_runnable): New function.
	(Check_library::locks): New function.
	(Check_library::run): New function.
	* readsyms.h (Add_symbols::Add_symbols): Add library parameter.
	(Add_symbols::library_): New data member.
	(class Read_member): New class.
	(class Check_script): New class.
	(class Check_library): New class.
	* reloc.cc (Read_relocs::is_runnable): Allow case where
	token == NULL.
	(Read_relocs::locks): Likewise.
	(Scan_relocs::locks): Likewise.
	(Relocate_task::locks): Likewise.
	(Sized_relobj::do_scan_relocs): Tell finalize_incremental_relocs
	to clear counters.
	(Sized_relobj::incremental_relocs_scan): Fix comment.
	(Sized_relobj::do_relocate): Pass output file offset to
	write_local_symbols.
	(Sized_relobj::incremental_relocs_write_reltype): Use reloc_size
	from class declaration.
	* script.cc (read_input_script): Allocate Script_info; pass
	argument serial number to report_script.
	* script.h (class Script_info): Move to incremental.h.
	* symtab.cc (Symbol_table::add_from_incrobj): New function.
	* symtab.h (Symbol_table::add_from_incrobj): New function.
	(Symbol_table::set_file_offset): New function.
2011-04-12 00:44:48 +00:00

608 lines
17 KiB
C++

// fileread.h -- read files for gold -*- C++ -*-
// Copyright 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
// Written by Ian Lance Taylor <iant@google.com>.
// This file is part of gold.
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
// MA 02110-1301, USA.
// Classes used to read data from binary input files.
#ifndef GOLD_FILEREAD_H
#define GOLD_FILEREAD_H
#include <list>
#include <map>
#include <string>
#include <vector>
#include "token.h"
namespace gold
{
// Since not all system supports stat.st_mtim and struct timespec,
// we define our own structure and fill the nanoseconds if we can.
struct Timespec
{
Timespec()
: seconds(0), nanoseconds(0)
{ }
Timespec(time_t a_seconds, int a_nanoseconds)
: seconds(a_seconds), nanoseconds(a_nanoseconds)
{ }
time_t seconds;
int nanoseconds;
};
// Get the last modified time of an unopened file. Returns false if the
// file does not exist.
bool
get_mtime(const char* filename, Timespec* mtime);
class Position_dependent_options;
class Input_file_argument;
class Dirsearch;
class File_view;
// File_read manages a file descriptor and mappings for a file we are
// reading.
class File_read
{
public:
File_read()
: name_(), descriptor_(-1), is_descriptor_opened_(false), object_count_(0),
size_(0), token_(false), views_(), saved_views_(), mapped_bytes_(0),
released_(true), whole_file_view_(NULL)
{ }
~File_read();
// Open a file.
bool
open(const Task*, const std::string& name);
// Pretend to open the file, but provide the file contents. No
// actual file system activity will occur. This is used for
// testing.
bool
open(const Task*, const std::string& name, const unsigned char* contents,
off_t size);
// Return the file name.
const std::string&
filename() const
{ return this->name_; }
// Add an object associated with a file.
void
add_object()
{ ++this->object_count_; }
// Remove an object associated with a file.
void
remove_object()
{ --this->object_count_; }
// Lock the file for exclusive access within a particular Task::run
// execution. This routine may only be called when the workqueue
// lock is held.
void
lock(const Task* t);
// Unlock the file.
void
unlock(const Task* t);
// Test whether the object is locked.
bool
is_locked() const;
// Return the token, so that the task can be queued.
Task_token*
token()
{ return &this->token_; }
// Release the file. This indicates that we aren't going to do
// anything further with it until it is unlocked. This is used
// because a Task which locks the file never calls either lock or
// unlock; it just locks the token. The basic rule is that a Task
// which locks a file via the Task::locks interface must explicitly
// call release() when it is done. This is not necessary for code
// which calls unlock() on the file.
void
release();
// Return the size of the file.
off_t
filesize() const
{ return this->size_; }
// Return a view into the file starting at file offset START for
// SIZE bytes. OFFSET is the offset into the input file for the
// file we are reading; this is zero for a normal object file,
// non-zero for an object file in an archive. ALIGNED is true if
// the data must be naturally aligned; this only matters when OFFSET
// is not zero. The pointer will remain valid until the File_read
// is unlocked. It is an error if we can not read enough data from
// the file. The CACHE parameter is a hint as to whether it will be
// useful to cache this data for later accesses--i.e., later calls
// to get_view, read, or get_lasting_view which retrieve the same
// data.
const unsigned char*
get_view(off_t offset, off_t start, section_size_type size, bool aligned,
bool cache);
// Read data from the file into the buffer P starting at file offset
// START for SIZE bytes.
void
read(off_t start, section_size_type size, void* p);
// Return a lasting view into the file starting at file offset START
// for SIZE bytes. This is allocated with new, and the caller is
// responsible for deleting it when done. The data associated with
// this view will remain valid until the view is deleted. It is an
// error if we can not read enough data from the file. The OFFSET,
// ALIGNED and CACHE parameters are as in get_view.
File_view*
get_lasting_view(off_t offset, off_t start, section_size_type size,
bool aligned, bool cache);
// Mark all views as no longer cached.
void
clear_view_cache_marks();
// Discard all uncached views. This is normally done by release(),
// but not for objects in archives. FIXME: This is a complicated
// interface, and it would be nice to have something more automatic.
void
clear_uncached_views()
{ this->clear_views(CLEAR_VIEWS_ARCHIVE); }
// A struct used to do a multiple read.
struct Read_multiple_entry
{
// The file offset of the data to read.
off_t file_offset;
// The amount of data to read.
section_size_type size;
// The buffer where the data should be placed.
unsigned char* buffer;
Read_multiple_entry(off_t o, section_size_type s, unsigned char* b)
: file_offset(o), size(s), buffer(b)
{ }
};
typedef std::vector<Read_multiple_entry> Read_multiple;
// Read a bunch of data from the file into various different
// locations. The vector must be sorted by ascending file_offset.
// BASE is a base offset to be added to all the offsets in the
// vector.
void
read_multiple(off_t base, const Read_multiple&);
// Dump statistical information to stderr.
static void
print_stats();
// Return the open file descriptor (for plugins).
int
descriptor()
{
this->reopen_descriptor();
return this->descriptor_;
}
// Return the file last modification time. Calls gold_fatal if the stat
// system call failed.
Timespec
get_mtime();
private:
// Control for what views to clear.
enum Clear_views_mode
{
// Clear uncached views not used by an archive.
CLEAR_VIEWS_NORMAL,
// Clear all uncached views (including in an archive).
CLEAR_VIEWS_ARCHIVE,
// Clear all views (i.e., we're destroying the file).
CLEAR_VIEWS_ALL
};
// This class may not be copied.
File_read(const File_read&);
File_read& operator=(const File_read&);
// Total bytes mapped into memory during the link if --stats.
static unsigned long long total_mapped_bytes;
// Current number of bytes mapped into memory during the link if
// --stats.
static unsigned long long current_mapped_bytes;
// High water mark of bytes mapped into memory during the link if
// --stats.
static unsigned long long maximum_mapped_bytes;
// A view into the file.
class View
{
public:
// Specifies how to dispose the data on destruction of the view.
enum Data_ownership
{
// Data owned by File object - nothing done in destructor.
DATA_NOT_OWNED,
// Data allocated with new[] and owned by this object - should
// use delete[].
DATA_ALLOCATED_ARRAY,
// Data mmapped and owned by this object - should munmap.
DATA_MMAPPED
};
View(off_t start, section_size_type size, const unsigned char* data,
unsigned int byteshift, bool cache, Data_ownership data_ownership)
: start_(start), size_(size), data_(data), lock_count_(0),
byteshift_(byteshift), cache_(cache), data_ownership_(data_ownership),
accessed_(true)
{ }
~View();
off_t
start() const
{ return this->start_; }
section_size_type
size() const
{ return this->size_; }
const unsigned char*
data() const
{ return this->data_; }
void
lock();
void
unlock();
bool
is_locked();
unsigned int
byteshift() const
{ return this->byteshift_; }
void
set_cache()
{ this->cache_ = true; }
void
clear_cache()
{ this->cache_ = false; }
bool
should_cache() const
{ return this->cache_; }
void
set_accessed()
{ this->accessed_ = true; }
void
clear_accessed()
{ this->accessed_= false; }
bool
accessed() const
{ return this->accessed_; }
// Returns TRUE if this view contains permanent data -- e.g., data that
// was supplied by the owner of the File object.
bool
is_permanent_view() const
{ return this->data_ownership_ == DATA_NOT_OWNED; }
private:
View(const View&);
View& operator=(const View&);
// The file offset of the start of the view.
off_t start_;
// The size of the view.
section_size_type size_;
// A pointer to the actual bytes.
const unsigned char* data_;
// The number of locks on this view.
int lock_count_;
// The number of bytes that the view is shifted relative to the
// underlying file. This is used to align data. This is normally
// zero, except possibly for an object in an archive.
unsigned int byteshift_;
// Whether the view is cached.
bool cache_;
// Whether the view is mapped into memory. If not, data_ points
// to memory allocated using new[].
Data_ownership data_ownership_;
// Whether the view has been accessed recently.
bool accessed_;
};
friend class View;
friend class File_view;
// The type of a mapping from page start and byte shift to views.
typedef std::map<std::pair<off_t, unsigned int>, View*> Views;
// A simple list of Views.
typedef std::list<View*> Saved_views;
// Open the descriptor if necessary.
void
reopen_descriptor();
// Find a view into the file.
View*
find_view(off_t start, section_size_type size, unsigned int byteshift,
View** vshifted) const;
// Read data from the file into a buffer.
void
do_read(off_t start, section_size_type size, void* p);
// Add a view.
void
add_view(View*);
// Make a view into the file.
View*
make_view(off_t start, section_size_type size, unsigned int byteshift,
bool cache);
// Find or make a view into the file.
View*
find_or_make_view(off_t offset, off_t start, section_size_type size,
bool aligned, bool cache);
// Clear the file views.
void
clear_views(Clear_views_mode);
// The size of a file page for buffering data.
static const off_t page_size = 8192;
// Given a file offset, return the page offset.
static off_t
page_offset(off_t file_offset)
{ return file_offset & ~ (page_size - 1); }
// Given a file size, return the size to read integral pages.
static off_t
pages(off_t file_size)
{ return (file_size + (page_size - 1)) & ~ (page_size - 1); }
// The maximum number of entries we will pass to ::readv.
static const size_t max_readv_entries = 128;
// Use readv to read data.
void
do_readv(off_t base, const Read_multiple&, size_t start, size_t count);
// File name.
std::string name_;
// File descriptor.
int descriptor_;
// Whether we have regained the descriptor after releasing the file.
bool is_descriptor_opened_;
// The number of objects associated with this file. This will be
// more than 1 in the case of an archive.
int object_count_;
// File size.
off_t size_;
// A token used to lock the file.
Task_token token_;
// Buffered views into the file.
Views views_;
// List of views which were locked but had to be removed from views_
// because they were not large enough.
Saved_views saved_views_;
// Total amount of space mapped into memory. This is only changed
// while the file is locked. When we unlock the file, we transfer
// the total to total_mapped_bytes, and reset this to zero.
size_t mapped_bytes_;
// Whether the file was released.
bool released_;
// A view containing the whole file. May be NULL if we mmap only
// the relevant parts of the file. Not NULL if:
// - Flag --mmap_whole_files is set (default on 64-bit hosts).
// - The contents was specified in the constructor. Used only for
// testing purposes).
View* whole_file_view_;
};
// A view of file data that persists even when the file is unlocked.
// Callers should destroy these when no longer required. These are
// obtained form File_read::get_lasting_view. They may only be
// destroyed when the underlying File_read is locked.
class File_view
{
public:
// This may only be called when the underlying File_read is locked.
~File_view();
// Return a pointer to the data associated with this view.
const unsigned char*
data() const
{ return this->data_; }
private:
File_view(const File_view&);
File_view& operator=(const File_view&);
friend class File_read;
// Callers have to get these via File_read::get_lasting_view.
File_view(File_read& file, File_read::View* view, const unsigned char* data)
: file_(file), view_(view), data_(data)
{ }
File_read& file_;
File_read::View* view_;
const unsigned char* data_;
};
// All the information we hold for a single input file. This can be
// an object file, a shared library, or an archive.
class Input_file
{
public:
enum Format
{
FORMAT_NONE,
FORMAT_ELF,
FORMAT_BINARY
};
Input_file(const Input_file_argument* input_argument)
: input_argument_(input_argument), found_name_(), file_(),
is_in_sysroot_(false), format_(FORMAT_NONE)
{ }
// Create an input file with the contents already provided. This is
// only used for testing. With this path, don't call the open
// method.
Input_file(const Task*, const char* name, const unsigned char* contents,
off_t size);
// Return the command line argument.
const Input_file_argument*
input_file_argument() const
{ return this->input_argument_; }
// Return whether this is a file that we will search for in the list
// of directories.
bool
will_search_for() const;
// Open the file. If the open fails, this will report an error and
// return false. If there is a search, it starts at directory
// *PINDEX. *PINDEX should be initialized to zero. It may be
// restarted to find the next file with a matching name by
// incrementing the result and calling this again.
bool
open(const Dirsearch&, const Task*, int* pindex);
// Return the name given by the user. For -lc this will return "c".
const char*
name() const;
// Return the file name. For -lc this will return something like
// "/usr/lib/libc.so".
const std::string&
filename() const
{ return this->file_.filename(); }
// Return the name under which we found the file, corresponding to
// the command line. For -lc this will return something like
// "libc.so".
const std::string&
found_name() const
{ return this->found_name_; }
// Return the position dependent options.
const Position_dependent_options&
options() const;
// Return the file.
File_read&
file()
{ return this->file_; }
const File_read&
file() const
{ return this->file_; }
// Whether we found the file in a directory in the system root.
bool
is_in_sysroot() const
{ return this->is_in_sysroot_; }
// Whether this file is in a system directory.
bool
is_in_system_directory() const;
// Return whether this file is to be read only for its symbols.
bool
just_symbols() const;
// Return the format of the unconverted input file.
Format
format() const
{ return this->format_; }
// Try to find a file in the extra search dirs. Returns true on success.
static bool
try_extra_search_path(int* pindex,
const Input_file_argument* input_argument,
std::string filename, std::string* found_name,
std::string* namep);
// Find the actual file.
static bool
find_file(const Dirsearch& dirpath, int* pindex,
const Input_file_argument* input_argument,
bool* is_in_sysroot,
std::string* found_name, std::string* namep);
private:
Input_file(const Input_file&);
Input_file& operator=(const Input_file&);
// Open a binary file.
bool
open_binary(const Task* task, const std::string& name);
// The argument from the command line.
const Input_file_argument* input_argument_;
// The name under which we opened the file. This is like the name
// on the command line, but -lc turns into libc.so (or whatever).
// It only includes the full path if the path was on the command
// line.
std::string found_name_;
// The file after we open it.
File_read file_;
// Whether we found the file in a directory in the system root.
bool is_in_sysroot_;
// Format of unconverted input file.
Format format_;
};
} // end namespace gold
#endif // !defined(GOLD_FILEREAD_H)