gold/archive.h

   1 // archive.h -- archive support for gold      -*- C++ -*-
   2
   3 // Copyright 2006, 2007, 2008 Free Software Foundation, Inc.
   4 // Written by Ian Lance Taylor <iant@google.com>.
   5
   6 // This file is part of gold.
   7
   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.
  12
  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.
  17
  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.
  22
  23 #ifndef GOLD_ARCHIVE_H
  24 #define GOLD_ARCHIVE_H
  25
  26 #include <string>
  27 #include <vector>
  28
  29 #include "workqueue.h"
  30
  31 namespace gold
  32 {
  33
  34 class Task;
  35 class Input_file;
  36 class Input_objects;
  37 class Input_group;
  38 class Layout;
  39 class Symbol_table;
  40
  41 // This class represents an archive--generally a libNAME.a file.
  42 // Archives have a symbol table and a list of objects.
  43
  44 class Archive
  45 {
  46  public:
  47   Archive(const std::string& name, Input_file* input_file,
  48           bool is_thin_archive, Dirsearch* dirpath, Task* task)
  49     : name_(name), input_file_(input_file), armap_(), armap_names_(),
  50       extended_names_(), armap_checked_(), seen_offsets_(),
  51       is_thin_archive_(is_thin_archive), dirpath_(dirpath), task_(task)
  52   { }
  53
  54   // The length of the magic string at the start of an archive.
  55   static const int sarmag = 8;
  56
  57   // The magic string at the start of an archive.
  58   static const char armag[sarmag];
  59   static const char armagt[sarmag];
  60
  61   // The string expected at the end of an archive member header.
  62   static const char arfmag[2];
  63
  64   // The name of the object.
  65   const std::string&
  66   name() const
  67   { return this->name_; }
  68
  69   // Set up the archive: read the symbol map.
  70   void
  71   setup();
  72
  73   // Get a reference to the underlying file.
  74   File_read&
  75   file()
  76   { return this->input_file_->file(); }
  77
  78   // Lock the underlying file.
  79   void
  80   lock(const Task* t)
  81   { this->input_file_->file().lock(t); }
  82
  83   // Unlock the underlying file.
  84   void
  85   unlock(const Task* t)
  86   { this->input_file_->file().unlock(t); }
  87
  88   // Return whether the underlying file is locked.
  89   bool
  90   is_locked() const
  91   { return this->input_file_->file().is_locked(); }
  92
  93   // Return the token, so that the task can be queued.
  94   Task_token*
  95   token()
  96   { return this->input_file_->file().token(); }
  97
  98   // Release the underlying file.
  99   void
 100   release()
 101   { this->input_file_->file().release(); }
 102
 103   // Unlock any nested archives.
 104   void
 105   unlock_nested_archives();
 106
 107   // Select members from the archive as needed and add them to the
 108   // link.
 109   void
 110   add_symbols(Symbol_table*, Layout*, Input_objects*);
 111
 112  private:
 113   Archive(const Archive&);
 114   Archive& operator=(const Archive&);
 115
 116   struct Archive_header;
 117
 118   // Get a view into the underlying file.
 119   const unsigned char*
 120   get_view(off_t start, section_size_type size, bool cache)
 121   { return this->input_file_->file().get_view(start, size, cache); }
 122
 123   // Read the archive symbol map.
 124   void
 125   read_armap(off_t start, section_size_type size);
 126
 127   // Read an archive member header at OFF.  CACHE is whether to cache
 128   // the file view.  Return the size of the member, and set *PNAME to
 129   // the name.
 130   off_t
 131   read_header(off_t off, bool cache, std::string* pname, off_t* nested_off);
 132
 133   // Interpret an archive header HDR at OFF.  Return the size of the
 134   // member, and set *PNAME to the name.
 135   off_t
 136   interpret_header(const Archive_header* hdr, off_t off, std::string* pname,
 137                    off_t* nested_off);
 138
 139   // Include all the archive members in the link.
 140   void
 141   include_all_members(Symbol_table*, Layout*, Input_objects*);
 142
 143   // Include an archive member in the link.
 144   void
 145   include_member(Symbol_table*, Layout*, Input_objects*, off_t off);
 146
 147   // An entry in the archive map of symbols to object files.
 148   struct Armap_entry
 149   {
 150     // The offset to the symbol name in armap_names_.
 151     off_t name_offset;
 152     // The file offset to the object in the archive.
 153     off_t file_offset;
 154   };
 155
 156   // A simple hash code for off_t values.
 157   class Seen_hash
 158   {
 159    public:
 160     size_t operator()(off_t val) const
 161     { return static_cast<size_t>(val); }
 162   };
 163
 164   // For keeping track of open nested archives in a thin archive file.
 165   typedef Unordered_map<std::string, Archive*> Nested_archive_table;
 166
 167   // Name of object as printed to user.
 168   std::string name_;
 169   // For reading the file.
 170   Input_file* input_file_;
 171   // The archive map.
 172   std::vector<Armap_entry> armap_;
 173   // The names in the archive map.
 174   std::string armap_names_;
 175   // The extended name table.
 176   std::string extended_names_;
 177   // Track which symbols in the archive map are for elements which are
 178   // defined or which have already been included in the link.
 179   std::vector<bool> armap_checked_;
 180   // Track which elements have been included by offset.
 181   Unordered_set<off_t, Seen_hash> seen_offsets_;
 182   // True if this is a thin archive.
 183   const bool is_thin_archive_;
 184   // Table of nested archives, indexed by filename.
 185   Nested_archive_table nested_archives_;
 186   // The directory search path.
 187   Dirsearch* dirpath_;
 188   // The task reading this archive.
 189   Task *task_;
 190 };
 191
 192 // This class is used to read an archive and pick out the desired
 193 // elements and add them to the link.
 194
 195 class Add_archive_symbols : public Task
 196 {
 197  public:
 198   Add_archive_symbols(Symbol_table* symtab, Layout* layout,
 199                       Input_objects* input_objects,
 200                       Archive* archive, Input_group* input_group,
 201                       Task_token* this_blocker,
 202                       Task_token* next_blocker)
 203     : symtab_(symtab), layout_(layout), input_objects_(input_objects),
 204       archive_(archive), input_group_(input_group),
 205       this_blocker_(this_blocker), next_blocker_(next_blocker)
 206   { }
 207
 208   ~Add_archive_symbols();
 209
 210   // The standard Task methods.
 211
 212   Task_token*
 213   is_runnable();
 214
 215   void
 216   locks(Task_locker*);
 217
 218   void
 219   run(Workqueue*);
 220
 221   std::string
 222   get_name() const
 223   {
 224     if (this->archive_ == NULL)
 225       return "Add_archive_symbols";
 226     return "Add_archive_symbols " + this->archive_->file().filename();
 227   }
 228
 229  private:
 230   Symbol_table* symtab_;
 231   Layout* layout_;
 232   Input_objects* input_objects_;
 233   Archive* archive_;
 234   Input_group* input_group_;
 235   Task_token* this_blocker_;
 236   Task_token* next_blocker_;
 237 };
 238
 239 } // End namespace gold.
 240
 241 #endif // !defined(GOLD_ARCHIVE_H)