2010-03-19 Doug Kwan <dougkwan@google.com>
[external/binutils.git] / gold / stringpool.cc
1 // stringpool.cc -- a string pool for gold
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 #include "gold.h"
24
25 #include <cstring>
26 #include <algorithm>
27 #include <vector>
28
29 #include "output.h"
30 #include "parameters.h"
31 #include "stringpool.h"
32
33 namespace gold
34 {
35
36 template<typename Stringpool_char>
37 Stringpool_template<Stringpool_char>::Stringpool_template()
38   : string_set_(), key_to_offset_(), strings_(), strtab_size_(0),
39     zero_null_(true), optimize_(false), offset_(sizeof(Stringpool_char))
40 {
41   if (parameters->options_valid() && parameters->options().optimize() >= 2)
42     this->optimize_ = true;
43 }
44
45 template<typename Stringpool_char>
46 void
47 Stringpool_template<Stringpool_char>::clear()
48 {
49   for (typename std::list<Stringdata*>::iterator p = this->strings_.begin();
50        p != this->strings_.end();
51        ++p)
52     delete[] reinterpret_cast<char*>(*p);
53   this->strings_.clear();
54   this->key_to_offset_.clear();
55   this->string_set_.clear();
56 }
57
58 template<typename Stringpool_char>
59 Stringpool_template<Stringpool_char>::~Stringpool_template()
60 {
61   this->clear();
62 }
63
64 // Resize the internal hashtable with the expectation we'll get n new
65 // elements.  Note that the hashtable constructor takes a "number of
66 // buckets you'd like," rather than "number of elements you'd like,"
67 // but that's the best we can do.
68
69 template<typename Stringpool_char>
70 void
71 Stringpool_template<Stringpool_char>::reserve(unsigned int n)
72 {
73   this->key_to_offset_.reserve(n);
74
75 #if defined(HAVE_TR1_UNORDERED_MAP)
76   // rehash() implementation is broken in gcc 4.0.3's stl
77   //this->string_set_.rehash(this->string_set_.size() + n);
78   //return;
79 #elif defined(HAVE_EXT_HASH_MAP)
80   this->string_set_.resize(this->string_set_.size() + n);
81   return;
82 #endif
83
84   // This is the generic "reserve" code, if no #ifdef above triggers.
85   String_set_type new_string_set(this->string_set_.size() + n);
86   new_string_set.insert(this->string_set_.begin(), this->string_set_.end());
87   this->string_set_.swap(new_string_set);
88 }
89
90 // Return the length of a string of arbitrary character type.
91
92 template<typename Stringpool_char>
93 size_t
94 Stringpool_template<Stringpool_char>::string_length(const Stringpool_char* p)
95 {
96   size_t len = 0;
97   for (; *p != 0; ++p)
98     ++len;
99   return len;
100 }
101
102 // Specialize string_length for char.  Maybe we could just use
103 // std::char_traits<>::length?
104
105 template<>
106 inline size_t
107 Stringpool_template<char>::string_length(const char* p)
108 {
109   return strlen(p);
110 }
111
112 // Compare two strings of arbitrary character type for equality.
113
114 template<typename Stringpool_char>
115 bool
116 Stringpool_template<Stringpool_char>::string_equal(const Stringpool_char* s1,
117                                                    const Stringpool_char* s2)
118 {
119   while (*s1 != 0)
120     if (*s1++ != *s2++)
121       return false;
122   return *s2 == 0;
123 }
124
125 // Specialize string_equal for char.
126
127 template<>
128 inline bool
129 Stringpool_template<char>::string_equal(const char* s1, const char* s2)
130 {
131   return strcmp(s1, s2) == 0;
132 }
133
134 // Equality comparison function for the hash table.
135
136 template<typename Stringpool_char>
137 inline bool
138 Stringpool_template<Stringpool_char>::Stringpool_eq::operator()(
139     const Hashkey& h1,
140     const Hashkey& h2) const
141 {
142   return (h1.hash_code == h2.hash_code
143           && h1.length == h2.length
144           && (h1.string == h2.string
145               || memcmp(h1.string, h2.string,
146                         h1.length * sizeof(Stringpool_char)) == 0));
147 }
148
149 // Hash function.  The length is in characters, not bytes.
150
151 template<typename Stringpool_char>
152 size_t
153 Stringpool_template<Stringpool_char>::string_hash(const Stringpool_char* s,
154                                                   size_t length)
155 {
156   return gold::string_hash<Stringpool_char>(s, length);
157 }
158
159 // Add the string S to the list of canonical strings.  Return a
160 // pointer to the canonical string.  If PKEY is not NULL, set *PKEY to
161 // the key.  LENGTH is the length of S in characters.  Note that S may
162 // not be NUL terminated.
163
164 template<typename Stringpool_char>
165 const Stringpool_char*
166 Stringpool_template<Stringpool_char>::add_string(const Stringpool_char* s,
167                                                  size_t len)
168 {
169   // We are in trouble if we've already computed the string offsets.
170   gold_assert(this->strtab_size_ == 0);
171
172   // The size we allocate for a new Stringdata.
173   const size_t buffer_size = 1000;
174   // The amount we multiply the Stringdata index when calculating the
175   // key.
176   const size_t key_mult = 1024;
177   gold_assert(key_mult >= buffer_size);
178
179   // Convert len to the number of bytes we need to allocate, including
180   // the null character.
181   len = (len + 1) * sizeof(Stringpool_char);
182
183   size_t alc;
184   bool front = true;
185   if (len > buffer_size)
186     {
187       alc = sizeof(Stringdata) + len;
188       front = false;
189     }
190   else if (this->strings_.empty())
191     alc = sizeof(Stringdata) + buffer_size;
192   else
193     {
194       Stringdata *psd = this->strings_.front();
195       if (len > psd->alc - psd->len)
196         alc = sizeof(Stringdata) + buffer_size;
197       else
198         {
199           char* ret = psd->data + psd->len;
200           memcpy(ret, s, len - sizeof(Stringpool_char));
201           memset(ret + len - sizeof(Stringpool_char), 0,
202                  sizeof(Stringpool_char));
203
204           psd->len += len;
205
206           return reinterpret_cast<const Stringpool_char*>(ret);
207         }
208     }
209
210   Stringdata *psd = reinterpret_cast<Stringdata*>(new char[alc]);
211   psd->alc = alc - sizeof(Stringdata);
212   memcpy(psd->data, s, len - sizeof(Stringpool_char));
213   memset(psd->data + len - sizeof(Stringpool_char), 0,
214          sizeof(Stringpool_char));
215   psd->len = len;
216
217   if (front)
218     this->strings_.push_front(psd);
219   else
220     this->strings_.push_back(psd);
221
222   return reinterpret_cast<const Stringpool_char*>(psd->data);
223 }
224
225 // Add a string to a string pool.
226
227 template<typename Stringpool_char>
228 const Stringpool_char*
229 Stringpool_template<Stringpool_char>::add(const Stringpool_char* s, bool copy,
230                                           Key* pkey)
231 {
232   return this->add_with_length(s, string_length(s), copy, pkey);
233 }
234
235 // Add a new key offset entry.
236
237 template<typename Stringpool_char>
238 void
239 Stringpool_template<Stringpool_char>::new_key_offset(size_t length)
240 {
241   section_offset_type offset;
242   if (this->zero_null_ && length == 0)
243     offset = 0;
244   else
245     {
246       offset = this->offset_;
247       this->offset_ += (length + 1) * sizeof(Stringpool_char);
248     }
249   this->key_to_offset_.push_back(offset);
250 }
251
252 template<typename Stringpool_char>
253 const Stringpool_char*
254 Stringpool_template<Stringpool_char>::add_with_length(const Stringpool_char* s,
255                                                       size_t length,
256                                                       bool copy,
257                                                       Key* pkey)
258 {
259   typedef std::pair<typename String_set_type::iterator, bool> Insert_type;
260
261   // We add 1 so that 0 is always invalid.
262   const Key k = this->key_to_offset_.size() + 1;
263
264   if (!copy)
265     {
266       // When we don't need to copy the string, we can call insert
267       // directly.
268
269       std::pair<Hashkey, Hashval> element(Hashkey(s, length), k);
270
271       Insert_type ins = this->string_set_.insert(element);
272
273       typename String_set_type::const_iterator p = ins.first;
274
275       if (ins.second)
276         {
277           // We just added the string.  The key value has now been
278           // used.
279           this->new_key_offset(length);
280         }
281       else
282         {
283           gold_assert(k != p->second);
284         }
285
286       if (pkey != NULL)
287         *pkey = p->second;
288       return p->first.string;
289     }
290
291   // When we have to copy the string, we look it up twice in the hash
292   // table.  The problem is that we can't insert S before we
293   // canonicalize it by copying it into the canonical list. The hash
294   // code will only be computed once.
295
296   Hashkey hk(s, length);
297   typename String_set_type::const_iterator p = this->string_set_.find(hk);
298   if (p != this->string_set_.end())
299     {
300       if (pkey != NULL)
301         *pkey = p->second;
302       return p->first.string;
303     }
304
305   this->new_key_offset(length);
306
307   hk.string = this->add_string(s, length);
308   // The contents of the string stay the same, so we don't need to
309   // adjust hk.hash_code or hk.length.
310
311   std::pair<Hashkey, Hashval> element(hk, k);
312
313   Insert_type ins = this->string_set_.insert(element);
314   gold_assert(ins.second);
315
316   if (pkey != NULL)
317     *pkey = k;
318   return hk.string;
319 }
320
321 template<typename Stringpool_char>
322 const Stringpool_char*
323 Stringpool_template<Stringpool_char>::find(const Stringpool_char* s,
324                                            Key* pkey) const
325 {
326   Hashkey hk(s);
327   typename String_set_type::const_iterator p = this->string_set_.find(hk);
328   if (p == this->string_set_.end())
329     return NULL;
330
331   if (pkey != NULL)
332     *pkey = p->second;
333
334   return p->first.string;
335 }
336
337 // Comparison routine used when sorting into an ELF strtab.  We want
338 // to sort this so that when one string is a suffix of another, we
339 // always see the shorter string immediately after the longer string.
340 // For example, we want to see these strings in this order:
341 //   abcd
342 //   cd
343 //   d
344 // When strings are not suffixes, we don't care what order they are
345 // in, but we need to ensure that suffixes wind up next to each other.
346 // So we do a reversed lexicographic sort on the reversed string.
347
348 template<typename Stringpool_char>
349 bool
350 Stringpool_template<Stringpool_char>::Stringpool_sort_comparison::operator()(
351   const Stringpool_sort_info& sort_info1,
352   const Stringpool_sort_info& sort_info2) const
353 {
354   const Hashkey& h1(sort_info1->first);
355   const Hashkey& h2(sort_info2->first);
356   const Stringpool_char* s1 = h1.string;
357   const Stringpool_char* s2 = h2.string;
358   const size_t len1 = h1.length;
359   const size_t len2 = h2.length;
360   const size_t minlen = len1 < len2 ? len1 : len2;
361   const Stringpool_char* p1 = s1 + len1 - 1;
362   const Stringpool_char* p2 = s2 + len2 - 1;
363   for (size_t i = minlen; i > 0; --i, --p1, --p2)
364     {
365       if (*p1 != *p2)
366         return *p1 > *p2;
367     }
368   return len1 > len2;
369 }
370
371 // Return whether s1 is a suffix of s2.
372
373 template<typename Stringpool_char>
374 bool
375 Stringpool_template<Stringpool_char>::is_suffix(const Stringpool_char* s1,
376                                                 size_t len1,
377                                                 const Stringpool_char* s2,
378                                                 size_t len2)
379 {
380   if (len1 > len2)
381     return false;
382   return memcmp(s1, s2 + len2 - len1, len1 * sizeof(Stringpool_char)) == 0;
383 }
384
385 // Turn the stringpool into an ELF strtab: determine the offsets of
386 // each string in the table.
387
388 template<typename Stringpool_char>
389 void
390 Stringpool_template<Stringpool_char>::set_string_offsets()
391 {
392   if (this->strtab_size_ != 0)
393     {
394       // We've already computed the offsets.
395       return;
396     }
397
398   const size_t charsize = sizeof(Stringpool_char);
399
400   // Offset 0 may be reserved for the empty string.
401   section_offset_type offset = this->zero_null_ ? charsize : 0;
402
403   // Sorting to find suffixes can take over 25% of the total CPU time
404   // used by the linker.  Since it's merely an optimization to reduce
405   // the strtab size, and gives a relatively small benefit (it's
406   // typically rare for a symbol to be a suffix of another), we only
407   // take the time to sort when the user asks for heavy optimization.
408   if (!this->optimize_)
409     {
410       // If we are not optimizing, the offsets are already assigned.
411       offset = this->offset_;
412     }
413   else
414     {
415       size_t count = this->string_set_.size();
416
417       std::vector<Stringpool_sort_info> v;
418       v.reserve(count);
419
420       for (typename String_set_type::iterator p = this->string_set_.begin();
421            p != this->string_set_.end();
422            ++p)
423         v.push_back(Stringpool_sort_info(p));
424
425       std::sort(v.begin(), v.end(), Stringpool_sort_comparison());
426
427       section_offset_type last_offset = -1;
428       for (typename std::vector<Stringpool_sort_info>::iterator last = v.end(),
429              curr = v.begin();
430            curr != v.end();
431            last = curr++)
432         {
433           section_offset_type this_offset;
434           if (this->zero_null_ && (*curr)->first.string[0] == 0)
435             this_offset = 0;
436           else if (last != v.end()
437                    && is_suffix((*curr)->first.string,
438                                 (*curr)->first.length,
439                                 (*last)->first.string,
440                                 (*last)->first.length))
441             this_offset = (last_offset
442                            + (((*last)->first.length - (*curr)->first.length)
443                               * charsize));
444           else
445             {
446               this_offset = offset;
447               offset += ((*curr)->first.length + 1) * charsize;
448             }
449           this->key_to_offset_[(*curr)->second - 1] = this_offset;
450           last_offset = this_offset;
451         }
452     }
453
454   this->strtab_size_ = offset;
455 }
456
457 // Get the offset of a string in the ELF strtab.  The string must
458 // exist.
459
460 template<typename Stringpool_char>
461 section_offset_type
462 Stringpool_template<Stringpool_char>::get_offset(const Stringpool_char* s)
463   const
464 {
465   return this->get_offset_with_length(s, string_length(s));
466 }
467
468 template<typename Stringpool_char>
469 section_offset_type
470 Stringpool_template<Stringpool_char>::get_offset_with_length(
471     const Stringpool_char* s,
472     size_t length) const
473 {
474   gold_assert(this->strtab_size_ != 0);
475   Hashkey hk(s, length);
476   typename String_set_type::const_iterator p = this->string_set_.find(hk);
477   if (p != this->string_set_.end())
478     return this->key_to_offset_[p->second - 1];
479   gold_unreachable();
480 }
481
482 // Write the ELF strtab into the buffer.
483
484 template<typename Stringpool_char>
485 void
486 Stringpool_template<Stringpool_char>::write_to_buffer(
487     unsigned char* buffer,
488     section_size_type bufsize)
489 {
490   gold_assert(this->strtab_size_ != 0);
491   gold_assert(bufsize >= this->strtab_size_);
492   if (this->zero_null_)
493     buffer[0] = '\0';
494   for (typename String_set_type::const_iterator p = this->string_set_.begin();
495        p != this->string_set_.end();
496        ++p)
497     {
498       const int len = (p->first.length + 1) * sizeof(Stringpool_char);
499       const section_offset_type offset = this->key_to_offset_[p->second - 1];
500       gold_assert(static_cast<section_size_type>(offset) + len
501                   <= this->strtab_size_);
502       memcpy(buffer + offset, p->first.string, len);
503     }
504 }
505
506 // Write the ELF strtab into the output file at the specified offset.
507
508 template<typename Stringpool_char>
509 void
510 Stringpool_template<Stringpool_char>::write(Output_file* of, off_t offset)
511 {
512   gold_assert(this->strtab_size_ != 0);
513   unsigned char* view = of->get_output_view(offset, this->strtab_size_);
514   this->write_to_buffer(view, this->strtab_size_);
515   of->write_output_view(offset, this->strtab_size_, view);
516 }
517
518 // Print statistical information to stderr.  This is used for --stats.
519
520 template<typename Stringpool_char>
521 void
522 Stringpool_template<Stringpool_char>::print_stats(const char* name) const
523 {
524 #if defined(HAVE_TR1_UNORDERED_MAP) || defined(HAVE_EXT_HASH_MAP)
525   fprintf(stderr, _("%s: %s entries: %zu; buckets: %zu\n"),
526           program_name, name, this->string_set_.size(),
527           this->string_set_.bucket_count());
528 #else
529   fprintf(stderr, _("%s: %s entries: %zu\n"),
530           program_name, name, this->table_.size());
531 #endif
532   fprintf(stderr, _("%s: %s Stringdata structures: %zu\n"),
533           program_name, name, this->strings_.size());
534 }
535
536 // Instantiate the templates we need.
537
538 template
539 class Stringpool_template<char>;
540
541 template
542 class Stringpool_template<uint16_t>;
543
544 template
545 class Stringpool_template<uint32_t>;
546
547 } // End namespace gold.