1 // fileread.cc -- read files for gold
3 // Copyright 2006, 2007, 2008, 2009, 2010 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.
32 #include "filenames.h"
35 #include "parameters.h"
37 #include "dirsearch.h"
40 #include "descriptors.h"
41 #include "gold-threads.h"
45 struct iovec
{ void* iov_base
; size_t iov_len
};
47 readv(int, const iovec
*, int)
56 // Class File_read::View.
58 File_read::View::~View()
60 gold_assert(!this->is_locked());
61 switch (this->data_ownership_
)
63 case DATA_ALLOCATED_ARRAY
:
67 if (::munmap(const_cast<unsigned char*>(this->data_
), this->size_
) != 0)
68 gold_warning(_("munmap failed: %s"), strerror(errno
));
69 File_read::current_mapped_bytes
-= this->size_
;
79 File_read::View::lock()
85 File_read::View::unlock()
87 gold_assert(this->lock_count_
> 0);
92 File_read::View::is_locked()
94 return this->lock_count_
> 0;
99 // A lock for the File_read static variables.
100 static Lock
* file_counts_lock
= NULL
;
101 static Initialize_lock
file_counts_initialize_lock(&file_counts_lock
);
103 // The File_read static variables.
104 unsigned long long File_read::total_mapped_bytes
;
105 unsigned long long File_read::current_mapped_bytes
;
106 unsigned long long File_read::maximum_mapped_bytes
;
108 File_read::~File_read()
110 gold_assert(this->token_
.is_writable());
111 if (this->is_descriptor_opened_
)
113 release_descriptor(this->descriptor_
, true);
114 this->descriptor_
= -1;
115 this->is_descriptor_opened_
= false;
118 this->clear_views(true);
119 if (this->whole_file_view_
)
120 delete this->whole_file_view_
;
126 File_read::open(const Task
* task
, const std::string
& name
)
128 gold_assert(this->token_
.is_writable()
129 && this->descriptor_
< 0
130 && !this->is_descriptor_opened_
131 && this->name_
.empty());
134 this->descriptor_
= open_descriptor(-1, this->name_
.c_str(),
137 if (this->descriptor_
>= 0)
139 this->is_descriptor_opened_
= true;
141 if (::fstat(this->descriptor_
, &s
) < 0)
142 gold_error(_("%s: fstat failed: %s"),
143 this->name_
.c_str(), strerror(errno
));
144 this->size_
= s
.st_size
;
145 gold_debug(DEBUG_FILES
, "Attempt to open %s succeeded",
146 this->name_
.c_str());
148 // Options may not yet be ready e.g. when reading a version
149 // script. We then default to --no-keep-files-mapped.
150 if (parameters
->options_valid()
151 && parameters
->options().keep_files_mapped())
153 const unsigned char* contents
= static_cast<const unsigned char*>(
154 ::mmap(NULL
, this->size_
, PROT_READ
, MAP_PRIVATE
,
155 this->descriptor_
, 0));
156 if (contents
== MAP_FAILED
)
157 gold_fatal(_("%s: mmap failed: %s"), this->filename().c_str(),
159 this->whole_file_view_
= new View(0, this->size_
, contents
, 0, false,
161 this->mapped_bytes_
+= this->size_
;
164 this->token_
.add_writer(task
);
167 return this->descriptor_
>= 0;
170 // Open the file with the contents in memory.
173 File_read::open(const Task
* task
, const std::string
& name
,
174 const unsigned char* contents
, off_t size
)
176 gold_assert(this->token_
.is_writable()
177 && this->descriptor_
< 0
178 && !this->is_descriptor_opened_
179 && this->name_
.empty());
181 this->whole_file_view_
= new View(0, size
, contents
, 0, false,
182 View::DATA_NOT_OWNED
);
184 this->token_
.add_writer(task
);
188 // Reopen a descriptor if necessary.
191 File_read::reopen_descriptor()
193 if (!this->is_descriptor_opened_
)
195 this->descriptor_
= open_descriptor(this->descriptor_
,
198 if (this->descriptor_
< 0)
199 gold_fatal(_("could not reopen file %s"), this->name_
.c_str());
200 this->is_descriptor_opened_
= true;
204 // Release the file. This is called when we are done with the file in
210 gold_assert(this->is_locked());
212 if (!parameters
->options_valid() || parameters
->options().stats())
214 file_counts_initialize_lock
.initialize();
215 Hold_optional_lock
hl(file_counts_lock
);
216 File_read::total_mapped_bytes
+= this->mapped_bytes_
;
217 File_read::current_mapped_bytes
+= this->mapped_bytes_
;
218 if (File_read::current_mapped_bytes
> File_read::maximum_mapped_bytes
)
219 File_read::maximum_mapped_bytes
= File_read::current_mapped_bytes
;
222 this->mapped_bytes_
= 0;
224 // Only clear views if there is only one attached object. Otherwise
225 // we waste time trying to clear cached archive views. Similarly
226 // for releasing the descriptor.
227 if (this->object_count_
<= 1)
229 this->clear_views(false);
230 if (this->is_descriptor_opened_
)
232 release_descriptor(this->descriptor_
, false);
233 this->is_descriptor_opened_
= false;
237 this->released_
= true;
243 File_read::lock(const Task
* task
)
245 gold_assert(this->released_
);
246 this->token_
.add_writer(task
);
247 this->released_
= false;
253 File_read::unlock(const Task
* task
)
256 this->token_
.remove_writer(task
);
259 // Return whether the file is locked.
262 File_read::is_locked() const
264 if (!this->token_
.is_writable())
266 // The file is not locked, so it should have been released.
267 gold_assert(this->released_
);
271 // See if we have a view which covers the file starting at START for
272 // SIZE bytes. Return a pointer to the View if found, NULL if not.
273 // If BYTESHIFT is not -1U, the returned View must have the specified
274 // byte shift; otherwise, it may have any byte shift. If VSHIFTED is
275 // not NULL, this sets *VSHIFTED to a view which would have worked if
276 // not for the requested BYTESHIFT.
278 inline File_read::View
*
279 File_read::find_view(off_t start
, section_size_type size
,
280 unsigned int byteshift
, File_read::View
** vshifted
) const
282 if (vshifted
!= NULL
)
285 // If we have the whole file mmapped, and the alignment is right,
287 if (this->whole_file_view_
)
288 if (byteshift
== -1U || byteshift
== 0)
289 return this->whole_file_view_
;
291 off_t page
= File_read::page_offset(start
);
293 unsigned int bszero
= 0;
294 Views::const_iterator p
= this->views_
.upper_bound(std::make_pair(page
- 1,
297 while (p
!= this->views_
.end() && p
->first
.first
<= page
)
299 if (p
->second
->start() <= start
300 && (p
->second
->start() + static_cast<off_t
>(p
->second
->size())
301 >= start
+ static_cast<off_t
>(size
)))
303 if (byteshift
== -1U || byteshift
== p
->second
->byteshift())
305 p
->second
->set_accessed();
309 if (vshifted
!= NULL
&& *vshifted
== NULL
)
310 *vshifted
= p
->second
;
319 // Read SIZE bytes from the file starting at offset START. Read into
323 File_read::do_read(off_t start
, section_size_type size
, void* p
)
326 if (this->whole_file_view_
!= NULL
)
328 bytes
= this->size_
- start
;
329 if (static_cast<section_size_type
>(bytes
) >= size
)
331 memcpy(p
, this->whole_file_view_
->data() + start
, size
);
337 this->reopen_descriptor();
338 bytes
= ::pread(this->descriptor_
, p
, size
, start
);
339 if (static_cast<section_size_type
>(bytes
) == size
)
344 gold_fatal(_("%s: pread failed: %s"),
345 this->filename().c_str(), strerror(errno
));
350 gold_fatal(_("%s: file too short: read only %lld of %lld bytes at %lld"),
351 this->filename().c_str(),
352 static_cast<long long>(bytes
),
353 static_cast<long long>(size
),
354 static_cast<long long>(start
));
357 // Read data from the file.
360 File_read::read(off_t start
, section_size_type size
, void* p
)
362 const File_read::View
* pv
= this->find_view(start
, size
, -1U, NULL
);
365 memcpy(p
, pv
->data() + (start
- pv
->start() + pv
->byteshift()), size
);
369 this->do_read(start
, size
, p
);
372 // Add a new view. There may already be an existing view at this
373 // offset. If there is, the new view will be larger, and should
374 // replace the old view.
377 File_read::add_view(File_read::View
* v
)
379 std::pair
<Views::iterator
, bool> ins
=
380 this->views_
.insert(std::make_pair(std::make_pair(v
->start(),
386 // There was an existing view at this offset. It must not be large
387 // enough. We can't delete it here, since something might be using
388 // it; we put it on a list to be deleted when the file is unlocked.
389 File_read::View
* vold
= ins
.first
->second
;
390 gold_assert(vold
->size() < v
->size());
391 if (vold
->should_cache())
396 this->saved_views_
.push_back(vold
);
398 ins
.first
->second
= v
;
401 // Make a new view with a specified byteshift, reading the data from
405 File_read::make_view(off_t start
, section_size_type size
,
406 unsigned int byteshift
, bool cache
)
408 gold_assert(size
> 0);
410 // Check that start and end of the view are within the file.
411 if (start
> this->size_
412 || (static_cast<unsigned long long>(size
)
413 > static_cast<unsigned long long>(this->size_
- start
)))
414 gold_fatal(_("%s: attempt to map %lld bytes at offset %lld exceeds "
415 "size of file; the file may be corrupt"),
416 this->filename().c_str(),
417 static_cast<long long>(size
),
418 static_cast<long long>(start
));
420 off_t poff
= File_read::page_offset(start
);
422 section_size_type psize
= File_read::pages(size
+ (start
- poff
));
424 if (poff
+ static_cast<off_t
>(psize
) >= this->size_
)
426 psize
= this->size_
- poff
;
427 gold_assert(psize
>= size
);
431 if (this->whole_file_view_
!= NULL
|| byteshift
!= 0)
433 unsigned char* p
= new unsigned char[psize
+ byteshift
];
434 memset(p
, 0, byteshift
);
435 this->do_read(poff
, psize
, p
+ byteshift
);
436 v
= new File_read::View(poff
, psize
, p
, byteshift
, cache
,
437 View::DATA_ALLOCATED_ARRAY
);
441 this->reopen_descriptor();
442 void* p
= ::mmap(NULL
, psize
, PROT_READ
, MAP_PRIVATE
,
443 this->descriptor_
, poff
);
445 gold_fatal(_("%s: mmap offset %lld size %lld failed: %s"),
446 this->filename().c_str(),
447 static_cast<long long>(poff
),
448 static_cast<long long>(psize
),
451 this->mapped_bytes_
+= psize
;
453 const unsigned char* pbytes
= static_cast<const unsigned char*>(p
);
454 v
= new File_read::View(poff
, psize
, pbytes
, 0, cache
,
463 // Find a View or make a new one, shifted as required by the file
464 // offset OFFSET and ALIGNED.
467 File_read::find_or_make_view(off_t offset
, off_t start
,
468 section_size_type size
, bool aligned
, bool cache
)
470 unsigned int byteshift
;
475 unsigned int target_size
= (!parameters
->target_valid()
477 : parameters
->target().get_size());
478 byteshift
= offset
& ((target_size
/ 8) - 1);
480 // Set BYTESHIFT to the number of dummy bytes which must be
481 // inserted before the data in order for this data to be
484 byteshift
= (target_size
/ 8) - byteshift
;
487 // Try to find a View with the required BYTESHIFT.
488 File_read::View
* vshifted
;
489 File_read::View
* v
= this->find_view(offset
+ start
, size
,
490 aligned
? byteshift
: -1U,
499 // If VSHIFTED is not NULL, then it has the data we need, but with
500 // the wrong byteshift.
504 gold_assert(aligned
);
506 unsigned char* pbytes
= new unsigned char[v
->size() + byteshift
];
507 memset(pbytes
, 0, byteshift
);
508 memcpy(pbytes
+ byteshift
, v
->data() + v
->byteshift(), v
->size());
510 File_read::View
* shifted_view
=
511 new File_read::View(v
->start(), v
->size(), pbytes
, byteshift
,
512 cache
, View::DATA_ALLOCATED_ARRAY
);
514 this->add_view(shifted_view
);
518 // Make a new view. If we don't need an aligned view, use a
519 // byteshift of 0, so that we can use mmap.
520 return this->make_view(offset
+ start
, size
,
521 aligned
? byteshift
: 0,
525 // Get a view into the file.
528 File_read::get_view(off_t offset
, off_t start
, section_size_type size
,
529 bool aligned
, bool cache
)
531 File_read::View
* pv
= this->find_or_make_view(offset
, start
, size
,
533 return pv
->data() + (offset
+ start
- pv
->start() + pv
->byteshift());
537 File_read::get_lasting_view(off_t offset
, off_t start
, section_size_type size
,
538 bool aligned
, bool cache
)
540 File_read::View
* pv
= this->find_or_make_view(offset
, start
, size
,
543 return new File_view(*this, pv
,
545 + (offset
+ start
- pv
->start() + pv
->byteshift())));
548 // Use readv to read COUNT entries from RM starting at START. BASE
549 // must be added to all file offsets in RM.
552 File_read::do_readv(off_t base
, const Read_multiple
& rm
, size_t start
,
555 unsigned char discard
[File_read::page_size
];
556 iovec iov
[File_read::max_readv_entries
* 2];
557 size_t iov_index
= 0;
559 off_t first_offset
= rm
[start
].file_offset
;
560 off_t last_offset
= first_offset
;
562 for (size_t i
= 0; i
< count
; ++i
)
564 const Read_multiple_entry
& i_entry(rm
[start
+ i
]);
566 if (i_entry
.file_offset
> last_offset
)
568 size_t skip
= i_entry
.file_offset
- last_offset
;
569 gold_assert(skip
<= sizeof discard
);
571 iov
[iov_index
].iov_base
= discard
;
572 iov
[iov_index
].iov_len
= skip
;
578 iov
[iov_index
].iov_base
= i_entry
.buffer
;
579 iov
[iov_index
].iov_len
= i_entry
.size
;
582 want
+= i_entry
.size
;
584 last_offset
= i_entry
.file_offset
+ i_entry
.size
;
587 this->reopen_descriptor();
589 gold_assert(iov_index
< sizeof iov
/ sizeof iov
[0]);
591 if (::lseek(this->descriptor_
, base
+ first_offset
, SEEK_SET
) < 0)
592 gold_fatal(_("%s: lseek failed: %s"),
593 this->filename().c_str(), strerror(errno
));
595 ssize_t got
= ::readv(this->descriptor_
, iov
, iov_index
);
598 gold_fatal(_("%s: readv failed: %s"),
599 this->filename().c_str(), strerror(errno
));
601 gold_fatal(_("%s: file too short: read only %zd of %zd bytes at %lld"),
602 this->filename().c_str(),
603 got
, want
, static_cast<long long>(base
+ first_offset
));
606 // Read several pieces of data from the file.
609 File_read::read_multiple(off_t base
, const Read_multiple
& rm
)
611 size_t count
= rm
.size();
615 // Find up to MAX_READV_ENTRIES consecutive entries which are
616 // less than one page apart.
617 const Read_multiple_entry
& i_entry(rm
[i
]);
618 off_t i_off
= i_entry
.file_offset
;
619 off_t end_off
= i_off
+ i_entry
.size
;
621 for (j
= i
+ 1; j
< count
; ++j
)
623 if (j
- i
>= File_read::max_readv_entries
)
625 const Read_multiple_entry
& j_entry(rm
[j
]);
626 off_t j_off
= j_entry
.file_offset
;
627 gold_assert(j_off
>= end_off
);
628 off_t j_end_off
= j_off
+ j_entry
.size
;
629 if (j_end_off
- end_off
>= File_read::page_size
)
635 this->read(base
+ i_off
, i_entry
.size
, i_entry
.buffer
);
638 File_read::View
* view
= this->find_view(base
+ i_off
,
642 this->do_readv(base
, rm
, i
, j
- i
);
645 const unsigned char* v
= (view
->data()
646 + (base
+ i_off
- view
->start()
647 + view
->byteshift()));
648 for (size_t k
= i
; k
< j
; ++k
)
650 const Read_multiple_entry
& k_entry(rm
[k
]);
651 gold_assert((convert_to_section_size_type(k_entry
.file_offset
654 <= convert_to_section_size_type(end_off
656 memcpy(k_entry
.buffer
,
657 v
+ (k_entry
.file_offset
- i_off
),
667 // Mark all views as no longer cached.
670 File_read::clear_view_cache_marks()
672 // Just ignore this if there are multiple objects associated with
673 // the file. Otherwise we will wind up uncaching and freeing some
674 // views for other objects.
675 if (this->object_count_
> 1)
678 for (Views::iterator p
= this->views_
.begin();
679 p
!= this->views_
.end();
681 p
->second
->clear_cache();
682 for (Saved_views::iterator p
= this->saved_views_
.begin();
683 p
!= this->saved_views_
.end();
688 // Remove all the file views. For a file which has multiple
689 // associated objects (i.e., an archive), we keep accessed views
690 // around until next time, in the hopes that they will be useful for
694 File_read::clear_views(bool destroying
)
696 Views::iterator p
= this->views_
.begin();
697 while (p
!= this->views_
.end())
700 if (p
->second
->is_locked())
701 should_delete
= false;
703 should_delete
= true;
704 else if (p
->second
->should_cache())
705 should_delete
= false;
706 else if (this->object_count_
> 1 && p
->second
->accessed())
707 should_delete
= false;
709 should_delete
= true;
715 // map::erase invalidates only the iterator to the deleted
717 Views::iterator pe
= p
;
719 this->views_
.erase(pe
);
723 gold_assert(!destroying
);
724 p
->second
->clear_accessed();
729 Saved_views::iterator q
= this->saved_views_
.begin();
730 while (q
!= this->saved_views_
.end())
732 if (!(*q
)->is_locked())
735 q
= this->saved_views_
.erase(q
);
739 gold_assert(!destroying
);
745 // Print statistical information to stderr. This is used for --stats.
748 File_read::print_stats()
750 fprintf(stderr
, _("%s: total bytes mapped for read: %llu\n"),
751 program_name
, File_read::total_mapped_bytes
);
752 fprintf(stderr
, _("%s: maximum bytes mapped for read at one time: %llu\n"),
753 program_name
, File_read::maximum_mapped_bytes
);
758 File_view::~File_view()
760 gold_assert(this->file_
.is_locked());
761 this->view_
->unlock();
766 // Create a file for testing.
768 Input_file::Input_file(const Task
* task
, const char* name
,
769 const unsigned char* contents
, off_t size
)
772 this->input_argument_
=
773 new Input_file_argument(name
, Input_file_argument::INPUT_FILE_TYPE_FILE
,
774 "", false, Position_dependent_options());
775 bool ok
= this->file_
.open(task
, name
, contents
, size
);
779 // Return the position dependent options in force for this file.
781 const Position_dependent_options
&
782 Input_file::options() const
784 return this->input_argument_
->options();
787 // Return the name given by the user. For -lc this will return "c".
790 Input_file::name() const
792 return this->input_argument_
->name();
795 // Return whether this file is in a system directory.
798 Input_file::is_in_system_directory() const
800 if (this->is_in_sysroot())
802 return parameters
->options().is_in_system_directory(this->filename());
805 // Return whether we are only reading symbols.
808 Input_file::just_symbols() const
810 return this->input_argument_
->just_symbols();
813 // Return whether this is a file that we will search for in the list
817 Input_file::will_search_for() const
819 return (!IS_ABSOLUTE_PATH(this->input_argument_
->name())
820 && (this->input_argument_
->is_lib()
821 || this->input_argument_
->is_searched_file()
822 || this->input_argument_
->extra_search_path() != NULL
));
825 // Return the file last modification time. Calls gold_fatal if the stat
826 // system call failed.
829 File_read::get_mtime()
831 struct stat file_stat
;
832 this->reopen_descriptor();
834 if (fstat(this->descriptor_
, &file_stat
) < 0)
835 gold_fatal(_("%s: stat failed: %s"), this->name_
.c_str(),
837 #ifdef HAVE_STAT_ST_MTIM
838 return Timespec(file_stat
.st_mtim
.tv_sec
, file_stat
.st_mtim
.tv_nsec
);
840 return Timespec(file_stat
.st_mtime
, 0);
846 // If the filename is not absolute, we assume it is in the current
847 // directory *except* when:
848 // A) input_argument_->is_lib() is true;
849 // B) input_argument_->is_searched_file() is true; or
850 // C) input_argument_->extra_search_path() is not empty.
851 // In each, we look in extra_search_path + library_path to find
852 // the file location, rather than the current directory.
855 Input_file::open(const Dirsearch
& dirpath
, const Task
* task
, int *pindex
)
859 // Case 1: name is an absolute file, just try to open it
860 // Case 2: name is relative but is_lib is false, is_searched_file is false,
861 // and extra_search_path is empty
862 if (IS_ABSOLUTE_PATH(this->input_argument_
->name())
863 || (!this->input_argument_
->is_lib()
864 && !this->input_argument_
->is_searched_file()
865 && this->input_argument_
->extra_search_path() == NULL
))
867 name
= this->input_argument_
->name();
868 this->found_name_
= name
;
870 // Case 3: is_lib is true or is_searched_file is true
871 else if (this->input_argument_
->is_lib()
872 || this->input_argument_
->is_searched_file())
874 // We don't yet support extra_search_path with -l.
875 gold_assert(this->input_argument_
->extra_search_path() == NULL
);
877 if (this->input_argument_
->is_lib())
880 n1
+= this->input_argument_
->name();
881 if (parameters
->options().is_static()
882 || !this->input_argument_
->options().Bdynamic())
891 n1
= this->input_argument_
->name();
892 name
= dirpath
.find(n1
, n2
, &this->is_in_sysroot_
, pindex
);
895 gold_error(_("cannot find %s%s"),
896 this->input_argument_
->is_lib() ? "-l" : "",
897 this->input_argument_
->name());
900 if (n2
.empty() || name
[name
.length() - 1] == 'o')
901 this->found_name_
= n1
;
903 this->found_name_
= n2
;
905 // Case 4: extra_search_path is not empty
908 gold_assert(this->input_argument_
->extra_search_path() != NULL
);
910 // First, check extra_search_path.
911 name
= this->input_argument_
->extra_search_path();
912 if (!IS_DIR_SEPARATOR (name
[name
.length() - 1]))
914 name
+= this->input_argument_
->name();
915 struct stat dummy_stat
;
916 if (*pindex
> 0 || ::stat(name
.c_str(), &dummy_stat
) < 0)
918 // extra_search_path failed, so check the normal search-path.
922 name
= dirpath
.find(this->input_argument_
->name(), "",
923 &this->is_in_sysroot_
, &index
);
926 gold_error(_("cannot find %s"),
927 this->input_argument_
->name());
932 this->found_name_
= this->input_argument_
->name();
935 // Now that we've figured out where the file lives, try to open it.
937 General_options::Object_format format
=
938 this->input_argument_
->options().format_enum();
940 if (format
== General_options::OBJECT_FORMAT_ELF
)
941 ok
= this->file_
.open(task
, name
);
944 gold_assert(format
== General_options::OBJECT_FORMAT_BINARY
);
945 ok
= this->open_binary(task
, name
);
950 gold_error(_("cannot open %s: %s"),
951 name
.c_str(), strerror(errno
));
958 // Open a file for --format binary.
961 Input_file::open_binary(const Task
* task
, const std::string
& name
)
963 // In order to open a binary file, we need machine code, size, and
964 // endianness. We may not have a valid target at this point, in
965 // which case we use the default target.
966 parameters_force_valid_target();
967 const Target
& target(parameters
->target());
969 Binary_to_elf
binary_to_elf(target
.machine_code(),
971 target
.is_big_endian(),
973 if (!binary_to_elf
.convert(task
))
975 return this->file_
.open(task
, name
, binary_to_elf
.converted_data_leak(),
976 binary_to_elf
.converted_size());
979 } // End namespace gold.