2 Copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007
3 Free Software Foundation, Inc.
4 Written by Jakub Jelinek <jakub@redhat.com>.
6 This file is part of BFD, the Binary File Descriptor library.
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. */
24 /* This file contains support for merging duplicate entities within sections,
25 as used in ELF SHF_MERGE. */
31 #include "libiberty.h"
33 struct sec_merge_sec_info;
35 /* An entry in the section merge hash table. */
37 struct sec_merge_hash_entry
39 struct bfd_hash_entry root;
40 /* Length of this entry. This includes the zero terminator. */
42 /* Start of this string needs to be aligned to
43 alignment octets (not 1 << align). */
44 unsigned int alignment;
47 /* Index within the merged section. */
49 /* Entry this is a suffix of (if alignment is 0). */
50 struct sec_merge_hash_entry *suffix;
52 /* Which section is it in. */
53 struct sec_merge_sec_info *secinfo;
54 /* Next entity in the hash table. */
55 struct sec_merge_hash_entry *next;
58 /* The section merge hash table. */
62 struct bfd_hash_table table;
63 /* Next available index. */
65 /* First entity in the SEC_MERGE sections of this type. */
66 struct sec_merge_hash_entry *first;
67 /* Last entity in the SEC_MERGE sections of this type. */
68 struct sec_merge_hash_entry *last;
71 /* Are entries fixed size or zero terminated strings? */
77 /* Chain of sec_merge_infos. */
78 struct sec_merge_info *next;
79 /* Chain of sec_merge_sec_infos. */
80 struct sec_merge_sec_info *chain;
81 /* A hash table used to hold section content. */
82 struct sec_merge_hash *htab;
85 struct sec_merge_sec_info
87 /* Chain of sec_merge_sec_infos. */
88 struct sec_merge_sec_info *next;
89 /* The corresponding section. */
91 /* Pointer to merge_info pointing to us. */
93 /* A hash table used to hold section content. */
94 struct sec_merge_hash *htab;
95 /* First string in this section. */
96 struct sec_merge_hash_entry *first_str;
97 /* Original section content. */
98 unsigned char contents[1];
102 /* Routine to create an entry in a section merge hashtab. */
104 static struct bfd_hash_entry *
105 sec_merge_hash_newfunc (struct bfd_hash_entry *entry,
106 struct bfd_hash_table *table, const char *string)
108 /* Allocate the structure if it has not already been allocated by a
111 entry = bfd_hash_allocate (table, sizeof (struct sec_merge_hash_entry));
115 /* Call the allocation method of the superclass. */
116 entry = bfd_hash_newfunc (entry, table, string);
120 /* Initialize the local fields. */
121 struct sec_merge_hash_entry *ret = (struct sec_merge_hash_entry *) entry;
123 ret->u.suffix = NULL;
132 /* Look up an entry in a section merge hash table. */
134 static struct sec_merge_hash_entry *
135 sec_merge_hash_lookup (struct sec_merge_hash *table, const char *string,
136 const unsigned char *sec_end,
137 unsigned int alignment, bfd_boolean create)
139 register const unsigned char *s;
140 register unsigned long hash;
141 register unsigned int c;
142 struct sec_merge_hash_entry *hashp;
148 s = (const unsigned char *) string;
151 if (table->entsize == 1)
153 while ((c = *s++) != '\0')
155 hash += c + (c << 17);
158 if (sec_end && s >= sec_end)
161 hash += len + (len << 17);
167 if (sec_end && s + table->entsize > sec_end)
169 for (i = 0; i < table->entsize; ++i)
172 if (i == table->entsize)
174 for (i = 0; i < table->entsize; ++i)
177 hash += c + (c << 17);
182 hash += len + (len << 17);
183 len *= table->entsize;
186 len += table->entsize;
190 for (i = 0; i < table->entsize; ++i)
193 hash += c + (c << 17);
196 len = table->entsize;
199 index = hash % table->table.size;
200 for (hashp = (struct sec_merge_hash_entry *) table->table.table[index];
202 hashp = (struct sec_merge_hash_entry *) hashp->root.next)
204 if (hashp->root.hash == hash
206 && memcmp (hashp->root.string, string, len) == 0)
208 /* If the string we found does not have at least the required
209 alignment, we need to insert another copy. */
210 if (hashp->alignment < alignment)
214 /* Mark the less aligned copy as deleted. */
216 hashp->alignment = 0;
227 hashp = ((struct sec_merge_hash_entry *)
228 bfd_hash_insert (&table->table, string, hash));
232 hashp->alignment = alignment;
236 /* Create a new hash table. */
238 static struct sec_merge_hash *
239 sec_merge_init (unsigned int entsize, bfd_boolean strings)
241 struct sec_merge_hash *table;
243 table = bfd_malloc (sizeof (struct sec_merge_hash));
247 if (! bfd_hash_table_init_n (&table->table, sec_merge_hash_newfunc,
248 sizeof (struct sec_merge_hash_entry), 16699))
257 table->entsize = entsize;
258 table->strings = strings;
263 /* Get the index of an entity in a hash table, adding it if it is not
266 static struct sec_merge_hash_entry *
267 sec_merge_add (struct sec_merge_hash *tab, const char *str,
268 unsigned int alignment, struct sec_merge_sec_info *secinfo)
270 register struct sec_merge_hash_entry *entry;
272 entry = sec_merge_hash_lookup (tab, str,
273 secinfo->contents + secinfo->sec->size,
278 if (entry->secinfo == NULL)
281 entry->secinfo = secinfo;
282 if (tab->first == NULL)
285 tab->last->next = entry;
293 sec_merge_emit (bfd *abfd, struct sec_merge_hash_entry *entry)
295 struct sec_merge_sec_info *secinfo = entry->secinfo;
296 asection *sec = secinfo->sec;
298 bfd_size_type off = 0;
299 int alignment_power = sec->output_section->alignment_power;
303 pad = bfd_zmalloc ((bfd_size_type) 1 << alignment_power);
308 for (; entry != NULL && entry->secinfo == secinfo; entry = entry->next)
313 len = -off & (entry->alignment - 1);
316 if (bfd_bwrite (pad, len, abfd) != len)
321 str = entry->root.string;
324 if (bfd_bwrite (str, len, abfd) != len)
330 /* Trailing alignment needed? */
331 off = sec->size - off;
333 && bfd_bwrite (pad, off, abfd) != off)
346 /* Register a SEC_MERGE section as a candidate for merging.
347 This function is called for all non-dynamic SEC_MERGE input sections. */
350 _bfd_add_merge_section (bfd *abfd, void **psinfo, asection *sec,
353 struct sec_merge_info *sinfo;
354 struct sec_merge_sec_info *secinfo;
358 if ((abfd->flags & DYNAMIC) != 0
359 || (sec->flags & SEC_MERGE) == 0)
363 || (sec->flags & SEC_EXCLUDE) != 0
364 || sec->entsize == 0)
367 if ((sec->flags & SEC_RELOC) != 0)
369 /* We aren't prepared to handle relocations in merged sections. */
373 align = sec->alignment_power;
374 if ((sec->entsize < (unsigned) 1 << align
375 && ((sec->entsize & (sec->entsize - 1))
376 || !(sec->flags & SEC_STRINGS)))
377 || (sec->entsize > (unsigned) 1 << align
378 && (sec->entsize & (((unsigned) 1 << align) - 1))))
380 /* Sanity check. If string character size is smaller than
381 alignment, then we require character size to be a power
382 of 2, otherwise character size must be integer multiple
383 of alignment. For non-string constants, alignment must
384 be smaller than or equal to entity size and entity size
385 must be integer multiple of alignment. */
389 for (sinfo = (struct sec_merge_info *) *psinfo; sinfo; sinfo = sinfo->next)
390 if ((secinfo = sinfo->chain)
391 && ! ((secinfo->sec->flags ^ sec->flags) & (SEC_MERGE | SEC_STRINGS))
392 && secinfo->sec->entsize == sec->entsize
393 && secinfo->sec->alignment_power == sec->alignment_power
394 && secinfo->sec->output_section == sec->output_section)
399 /* Initialize the information we need to keep track of. */
400 sinfo = bfd_alloc (abfd, sizeof (struct sec_merge_info));
403 sinfo->next = (struct sec_merge_info *) *psinfo;
406 sinfo->htab = sec_merge_init (sec->entsize, (sec->flags & SEC_STRINGS));
407 if (sinfo->htab == NULL)
411 /* Read the section from abfd. */
413 amt = sizeof (struct sec_merge_sec_info) + sec->size - 1;
414 *psecinfo = bfd_alloc (abfd, amt);
415 if (*psecinfo == NULL)
418 secinfo = (struct sec_merge_sec_info *) *psecinfo;
421 secinfo->next = sinfo->chain->next;
422 sinfo->chain->next = secinfo;
425 secinfo->next = secinfo;
426 sinfo->chain = secinfo;
428 secinfo->psecinfo = psecinfo;
429 secinfo->htab = sinfo->htab;
430 secinfo->first_str = NULL;
432 sec->rawsize = sec->size;
433 if (! bfd_get_section_contents (sec->owner, sec, secinfo->contents,
444 /* Record one section into the hash table. */
446 record_section (bfd *abfd,
447 struct sec_merge_info *sinfo,
448 struct sec_merge_sec_info *secinfo)
450 asection *sec = secinfo->sec;
451 struct sec_merge_hash_entry *entry;
453 unsigned char *p, *end;
454 bfd_vma mask, eltalign;
455 unsigned int align, i;
457 align = sec->alignment_power;
458 end = secinfo->contents + sec->size;
460 mask = ((bfd_vma) 1 << align) - 1;
461 if (sec->flags & SEC_STRINGS)
463 for (p = secinfo->contents; p < end; )
465 eltalign = p - secinfo->contents;
466 eltalign = ((eltalign ^ (eltalign - 1)) + 1) >> 1;
467 if (!eltalign || eltalign > mask)
469 entry = sec_merge_add (sinfo->htab, (char *) p, (unsigned) eltalign,
474 if (sec->entsize == 1)
476 while (p < end && *p == 0)
478 if (!nul && !((p - secinfo->contents) & mask))
481 entry = sec_merge_add (sinfo->htab, "",
482 (unsigned) mask + 1, secinfo);
493 for (i = 0; i < sec->entsize; i++)
496 if (i != sec->entsize)
498 if (!nul && !((p - secinfo->contents) & mask))
501 entry = sec_merge_add (sinfo->htab, (char *) p,
502 (unsigned) mask + 1, secinfo);
513 for (p = secinfo->contents; p < end; p += sec->entsize)
515 entry = sec_merge_add (sinfo->htab, (char *) p, 1, secinfo);
524 if (bfd_get_error () != bfd_error_no_memory)
525 (*_bfd_error_handler)
526 (_("%B: unterminated string in section `%A' marked for merging"),
528 for (secinfo = sinfo->chain; secinfo; secinfo = secinfo->next)
529 *secinfo->psecinfo = NULL;
534 strrevcmp (const void *a, const void *b)
536 struct sec_merge_hash_entry *A = *(struct sec_merge_hash_entry **) a;
537 struct sec_merge_hash_entry *B = *(struct sec_merge_hash_entry **) b;
538 unsigned int lenA = A->len;
539 unsigned int lenB = B->len;
540 const unsigned char *s = (const unsigned char *) A->root.string + lenA - 1;
541 const unsigned char *t = (const unsigned char *) B->root.string + lenB - 1;
542 int l = lenA < lenB ? lenA : lenB;
547 return (int) *s - (int) *t;
555 /* Like strrevcmp, but for the case where all strings have the same
556 alignment > entsize. */
559 strrevcmp_align (const void *a, const void *b)
561 struct sec_merge_hash_entry *A = *(struct sec_merge_hash_entry **) a;
562 struct sec_merge_hash_entry *B = *(struct sec_merge_hash_entry **) b;
563 unsigned int lenA = A->len;
564 unsigned int lenB = B->len;
565 const unsigned char *s = (const unsigned char *) A->root.string + lenA - 1;
566 const unsigned char *t = (const unsigned char *) B->root.string + lenB - 1;
567 int l = lenA < lenB ? lenA : lenB;
568 int tail_align = (lenA & (A->alignment - 1)) - (lenB & (A->alignment - 1));
576 return (int) *s - (int) *t;
585 is_suffix (const struct sec_merge_hash_entry *A,
586 const struct sec_merge_hash_entry *B)
588 if (A->len <= B->len)
589 /* B cannot be a suffix of A unless A is equal to B, which is guaranteed
590 not to be equal by the hash table. */
593 return memcmp (A->root.string + (A->len - B->len),
594 B->root.string, B->len) == 0;
597 /* This is a helper function for _bfd_merge_sections. It attempts to
598 merge strings matching suffixes of longer strings. */
600 merge_strings (struct sec_merge_info *sinfo)
602 struct sec_merge_hash_entry **array, **a, *e;
603 struct sec_merge_sec_info *secinfo;
604 bfd_size_type size, amt;
605 unsigned int alignment = 0;
607 /* Now sort the strings */
608 amt = sinfo->htab->size * sizeof (struct sec_merge_hash_entry *);
609 array = bfd_malloc (amt);
613 for (e = sinfo->htab->first, a = array; e; e = e->next)
617 /* Adjust the length to not include the zero terminator. */
618 e->len -= sinfo->htab->entsize;
619 if (alignment != e->alignment)
622 alignment = e->alignment;
624 alignment = (unsigned) -1;
628 sinfo->htab->size = a - array;
629 if (sinfo->htab->size != 0)
631 qsort (array, (size_t) sinfo->htab->size,
632 sizeof (struct sec_merge_hash_entry *),
633 (alignment != (unsigned) -1 && alignment > sinfo->htab->entsize
634 ? strrevcmp_align : strrevcmp));
636 /* Loop over the sorted array and merge suffixes */
638 e->len += sinfo->htab->entsize;
641 struct sec_merge_hash_entry *cmp = *a;
643 cmp->len += sinfo->htab->entsize;
644 if (e->alignment >= cmp->alignment
645 && !((e->len - cmp->len) & (cmp->alignment - 1))
646 && is_suffix (e, cmp))
660 /* Now assign positions to the strings we want to keep. */
662 secinfo = sinfo->htab->first->secinfo;
663 for (e = sinfo->htab->first; e; e = e->next)
665 if (e->secinfo != secinfo)
667 secinfo->sec->size = size;
668 secinfo = e->secinfo;
672 if (e->secinfo->first_str == NULL)
674 e->secinfo->first_str = e;
677 size = (size + e->alignment - 1) & ~((bfd_vma) e->alignment - 1);
682 secinfo->sec->size = size;
683 if (secinfo->sec->alignment_power != 0)
685 bfd_size_type align = (bfd_size_type) 1 << secinfo->sec->alignment_power;
686 secinfo->sec->size = (secinfo->sec->size + align - 1) & -align;
689 /* And now adjust the rest, removing them from the chain (but not hashtable)
691 for (a = &sinfo->htab->first, e = *a; e; e = e->next)
699 e->secinfo = e->u.suffix->secinfo;
700 e->alignment = e->u.suffix->alignment;
701 e->u.index = e->u.suffix->u.index + (e->u.suffix->len - e->len);
706 /* This function is called once after all SEC_MERGE sections are registered
707 with _bfd_merge_section. */
710 _bfd_merge_sections (bfd *abfd,
711 struct bfd_link_info *info ATTRIBUTE_UNUSED,
713 void (*remove_hook) (bfd *, asection *))
715 struct sec_merge_info *sinfo;
717 for (sinfo = (struct sec_merge_info *) xsinfo; sinfo; sinfo = sinfo->next)
719 struct sec_merge_sec_info * secinfo;
724 /* Move sinfo->chain to head of the chain, terminate it. */
725 secinfo = sinfo->chain;
726 sinfo->chain = secinfo->next;
727 secinfo->next = NULL;
729 /* Record the sections into the hash table. */
730 for (secinfo = sinfo->chain; secinfo; secinfo = secinfo->next)
731 if (secinfo->sec->flags & SEC_EXCLUDE)
733 *secinfo->psecinfo = NULL;
735 (*remove_hook) (abfd, secinfo->sec);
737 else if (! record_section (abfd, sinfo, secinfo))
743 if (sinfo->htab->first == NULL)
746 if (sinfo->htab->strings)
747 merge_strings (sinfo);
750 struct sec_merge_hash_entry *e;
751 bfd_size_type size = 0;
753 /* Things are much simpler for non-strings.
754 Just assign them slots in the section. */
756 for (e = sinfo->htab->first; e; e = e->next)
758 if (e->secinfo->first_str == NULL)
761 secinfo->sec->size = size;
762 e->secinfo->first_str = e;
765 size = (size + e->alignment - 1)
766 & ~((bfd_vma) e->alignment - 1);
769 secinfo = e->secinfo;
771 secinfo->sec->size = size;
774 /* Finally remove all input sections which have not made it into
775 the hash table at all. */
776 for (secinfo = sinfo->chain; secinfo; secinfo = secinfo->next)
777 if (secinfo->first_str == NULL)
778 secinfo->sec->flags |= SEC_EXCLUDE | SEC_KEEP;
784 /* Write out the merged section. */
787 _bfd_write_merged_section (bfd *output_bfd, asection *sec, void *psecinfo)
789 struct sec_merge_sec_info *secinfo;
792 secinfo = (struct sec_merge_sec_info *) psecinfo;
797 if (secinfo->first_str == NULL)
800 pos = sec->output_section->filepos + sec->output_offset;
801 if (bfd_seek (output_bfd, pos, SEEK_SET) != 0)
804 if (! sec_merge_emit (output_bfd, secinfo->first_str))
810 /* Adjust an address in the SEC_MERGE section. Given OFFSET within
811 *PSEC, this returns the new offset in the adjusted SEC_MERGE
812 section and writes the new section back into *PSEC. */
815 _bfd_merged_section_offset (bfd *output_bfd ATTRIBUTE_UNUSED, asection **psec,
816 void *psecinfo, bfd_vma offset)
818 struct sec_merge_sec_info *secinfo;
819 struct sec_merge_hash_entry *entry;
821 asection *sec = *psec;
823 secinfo = (struct sec_merge_sec_info *) psecinfo;
828 if (offset >= sec->rawsize)
830 if (offset > sec->rawsize)
832 (*_bfd_error_handler)
833 (_("%s: access beyond end of merged section (%ld)"),
834 bfd_get_filename (sec->owner), (long) offset);
836 return secinfo->first_str ? sec->size : 0;
839 if (secinfo->htab->strings)
841 if (sec->entsize == 1)
843 p = secinfo->contents + offset - 1;
844 while (p >= secinfo->contents && *p)
850 p = secinfo->contents + (offset / sec->entsize) * sec->entsize;
852 while (p >= secinfo->contents)
856 for (i = 0; i < sec->entsize; ++i)
859 if (i == sec->entsize)
868 p = secinfo->contents + (offset / sec->entsize) * sec->entsize;
870 entry = sec_merge_hash_lookup (secinfo->htab, (char *) p, NULL, 0, FALSE);
873 if (! secinfo->htab->strings)
875 /* This should only happen if somebody points into the padding
876 after a NUL character but before next entity. */
879 if (! secinfo->htab->first)
881 entry = secinfo->htab->first;
882 p = (secinfo->contents + (offset / sec->entsize + 1) * sec->entsize
886 *psec = entry->secinfo->sec;
887 return entry->u.index + (secinfo->contents + offset - p);