1 /* ELF program property support.
2 Copyright (C) 2017-2020 Free Software Foundation, Inc.
4 This file is part of BFD, the Binary File Descriptor library.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
19 MA 02110-1301, USA. */
21 /* GNU program property draft is at:
23 https://github.com/hjl-tools/linux-abi/wiki/property-draft.pdf
31 /* Get a property, allocate a new one if needed. */
34 _bfd_elf_get_property (bfd
*abfd
, unsigned int type
, unsigned int datasz
)
36 elf_property_list
*p
, **lastp
;
38 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
40 /* Never should happen. */
44 /* Keep the property list in order of type. */
45 lastp
= &elf_properties (abfd
);
46 for (p
= *lastp
; p
; p
= p
->next
)
48 /* Reuse the existing entry. */
49 if (type
== p
->property
.pr_type
)
51 if (datasz
> p
->property
.pr_datasz
)
53 /* This can happen when mixing 32-bit and 64-bit objects. */
54 p
->property
.pr_datasz
= datasz
;
58 else if (type
< p
->property
.pr_type
)
62 p
= (elf_property_list
*) bfd_alloc (abfd
, sizeof (*p
));
65 _bfd_error_handler (_("%pB: out of memory in _bfd_elf_get_property"),
69 memset (p
, 0, sizeof (*p
));
70 p
->property
.pr_type
= type
;
71 p
->property
.pr_datasz
= datasz
;
77 /* Parse GNU properties. */
80 _bfd_elf_parse_gnu_properties (bfd
*abfd
, Elf_Internal_Note
*note
)
82 const struct elf_backend_data
*bed
= get_elf_backend_data (abfd
);
83 unsigned int align_size
= bed
->s
->elfclass
== ELFCLASS64
? 8 : 4;
84 bfd_byte
*ptr
= (bfd_byte
*) note
->descdata
;
85 bfd_byte
*ptr_end
= ptr
+ note
->descsz
;
87 if (note
->descsz
< 8 || (note
->descsz
% align_size
) != 0)
91 (_("warning: %pB: corrupt GNU_PROPERTY_TYPE (%ld) size: %#lx"),
92 abfd
, note
->type
, note
->descsz
);
96 while (ptr
!= ptr_end
)
102 if ((size_t) (ptr_end
- ptr
) < 8)
105 type
= bfd_h_get_32 (abfd
, ptr
);
106 datasz
= bfd_h_get_32 (abfd
, ptr
+ 4);
109 if (datasz
> (size_t) (ptr_end
- ptr
))
112 (_("warning: %pB: corrupt GNU_PROPERTY_TYPE (%ld) type (0x%x) datasz: 0x%x"),
113 abfd
, note
->type
, type
, datasz
);
114 /* Clear all properties. */
115 elf_properties (abfd
) = NULL
;
119 if (type
>= GNU_PROPERTY_LOPROC
)
121 if (bed
->elf_machine_code
== EM_NONE
)
123 /* Ignore processor-specific properties with generic ELF
124 target vector. They should be handled by the matching
125 ELF target vector. */
128 else if (type
< GNU_PROPERTY_LOUSER
129 && bed
->parse_gnu_properties
)
131 enum elf_property_kind kind
132 = bed
->parse_gnu_properties (abfd
, type
, ptr
, datasz
);
133 if (kind
== property_corrupt
)
135 /* Clear all properties. */
136 elf_properties (abfd
) = NULL
;
139 else if (kind
!= property_ignored
)
147 case GNU_PROPERTY_STACK_SIZE
:
148 if (datasz
!= align_size
)
151 (_("warning: %pB: corrupt stack size: 0x%x"),
153 /* Clear all properties. */
154 elf_properties (abfd
) = NULL
;
157 prop
= _bfd_elf_get_property (abfd
, type
, datasz
);
159 prop
->u
.number
= bfd_h_get_64 (abfd
, ptr
);
161 prop
->u
.number
= bfd_h_get_32 (abfd
, ptr
);
162 prop
->pr_kind
= property_number
;
165 case GNU_PROPERTY_NO_COPY_ON_PROTECTED
:
169 (_("warning: %pB: corrupt no copy on protected size: 0x%x"),
171 /* Clear all properties. */
172 elf_properties (abfd
) = NULL
;
175 prop
= _bfd_elf_get_property (abfd
, type
, datasz
);
176 elf_has_no_copy_on_protected (abfd
) = TRUE
;
177 prop
->pr_kind
= property_number
;
186 (_("warning: %pB: unsupported GNU_PROPERTY_TYPE (%ld) type: 0x%x"),
187 abfd
, note
->type
, type
);
190 ptr
+= (datasz
+ (align_size
- 1)) & ~ (align_size
- 1);
196 /* Merge GNU property BPROP with APROP. If APROP isn't NULL, return TRUE
197 if APROP is updated. Otherwise, return TRUE if BPROP should be merged
201 elf_merge_gnu_properties (struct bfd_link_info
*info
, bfd
*abfd
, bfd
*bbfd
,
202 elf_property
*aprop
, elf_property
*bprop
)
204 const struct elf_backend_data
*bed
= get_elf_backend_data (abfd
);
205 unsigned int pr_type
= aprop
!= NULL
? aprop
->pr_type
: bprop
->pr_type
;
207 if (bed
->merge_gnu_properties
!= NULL
208 && pr_type
>= GNU_PROPERTY_LOPROC
209 && pr_type
< GNU_PROPERTY_LOUSER
)
210 return bed
->merge_gnu_properties (info
, abfd
, bbfd
, aprop
, bprop
);
214 case GNU_PROPERTY_STACK_SIZE
:
215 if (aprop
!= NULL
&& bprop
!= NULL
)
217 if (bprop
->u
.number
> aprop
->u
.number
)
219 aprop
->u
.number
= bprop
->u
.number
;
226 case GNU_PROPERTY_NO_COPY_ON_PROTECTED
:
227 /* Return TRUE if APROP is NULL to indicate that BPROP should
229 return aprop
== NULL
;
232 /* Never should happen. */
239 /* Return the property of TYPE on *LISTP and remove it from *LISTP if RM is
240 true. Return NULL if not found. */
242 static elf_property
*
243 elf_find_and_remove_property (elf_property_list
**listp
,
244 unsigned int type
, bfd_boolean rm
)
246 elf_property_list
*list
;
248 for (list
= *listp
; list
; list
= list
->next
)
250 if (type
== list
->property
.pr_type
)
252 /* Remove this property. */
255 return &list
->property
;
257 else if (type
< list
->property
.pr_type
)
265 /* Merge GNU property list *LISTP in ABFD with FIRST_PBFD. */
268 elf_merge_gnu_property_list (struct bfd_link_info
*info
, bfd
*first_pbfd
,
269 bfd
*abfd
, elf_property_list
**listp
)
271 elf_property_list
*p
, **lastp
;
273 bfd_boolean number_p
;
276 /* Merge each GNU property in FIRST_PBFD with the one on *LISTP. */
277 lastp
= &elf_properties (first_pbfd
);
278 for (p
= *lastp
; p
; p
= p
->next
)
279 if (p
->property
.pr_kind
!= property_remove
)
281 if (p
->property
.pr_kind
== property_number
)
284 number
= p
->property
.u
.number
;
288 pr
= elf_find_and_remove_property (listp
, p
->property
.pr_type
,
290 /* Pass NULL to elf_merge_gnu_properties for the property which
292 elf_merge_gnu_properties (info
, first_pbfd
, abfd
, &p
->property
, pr
);
293 if (p
->property
.pr_kind
== property_remove
)
295 if (info
->has_map_file
)
300 info
->callbacks
->minfo
301 (_("Removed property %W to merge %pB (0x%v) "
303 (bfd_vma
) p
->property
.pr_type
, first_pbfd
,
304 number
, abfd
, pr
->u
.number
);
306 info
->callbacks
->minfo
307 (_("Removed property %W to merge %pB (0x%v) "
308 "and %pB (not found)\n"),
309 (bfd_vma
) p
->property
.pr_type
, first_pbfd
,
315 info
->callbacks
->minfo
316 (_("Removed property %W to merge %pB and %pB\n"),
317 (bfd_vma
) p
->property
.pr_type
, first_pbfd
, abfd
);
319 info
->callbacks
->minfo
320 (_("Removed property %W to merge %pB and %pB "
322 (bfd_vma
) p
->property
.pr_type
, first_pbfd
, abfd
);
326 /* Remove this property. */
334 if (p
->property
.u
.number
!= number
335 || p
->property
.u
.number
!= pr
->u
.number
)
336 info
->callbacks
->minfo
337 (_("Updated property %W (0x%v) to merge %pB (0x%v) "
339 (bfd_vma
) p
->property
.pr_type
, p
->property
.u
.number
,
340 first_pbfd
, number
, abfd
, pr
->u
.number
);
344 if (p
->property
.u
.number
!= number
)
345 info
->callbacks
->minfo
346 (_("Updated property %W (%v) to merge %pB (0x%v) "
347 "and %pB (not found)\n"),
348 (bfd_vma
) p
->property
.pr_type
, p
->property
.u
.number
,
349 first_pbfd
, number
, abfd
);
355 /* Merge the remaining properties on *LISTP with FIRST_PBFD. */
356 for (p
= *listp
; p
!= NULL
; p
= p
->next
)
358 if (p
->property
.pr_kind
== property_number
)
361 number
= p
->property
.u
.number
;
366 if (elf_merge_gnu_properties (info
, first_pbfd
, abfd
, NULL
, &p
->property
))
368 if (p
->property
.pr_type
== GNU_PROPERTY_NO_COPY_ON_PROTECTED
)
369 elf_has_no_copy_on_protected (first_pbfd
) = TRUE
;
371 pr
= _bfd_elf_get_property (first_pbfd
, p
->property
.pr_type
,
372 p
->property
.pr_datasz
);
373 /* It must be a new property. */
374 if (pr
->pr_kind
!= property_unknown
)
376 /* Add a new property. */
381 pr
= elf_find_and_remove_property (&elf_properties (first_pbfd
),
387 info
->callbacks
->minfo
388 (_("Removed property %W to merge %pB (not found) and "
390 (bfd_vma
) p
->property
.pr_type
, first_pbfd
, abfd
,
393 info
->callbacks
->minfo
394 (_("Removed property %W to merge %pB and %pB\n"),
395 (bfd_vma
) p
->property
.pr_type
, first_pbfd
, abfd
);
397 else if (pr
->pr_kind
!= property_remove
)
403 /* Get GNU property section size. */
406 elf_get_gnu_property_section_size (elf_property_list
*list
,
407 unsigned int align_size
)
412 /* Compute the output section size. */
413 descsz
= offsetof (Elf_External_Note
, name
[sizeof "GNU"]);
414 descsz
= (descsz
+ 3) & -(unsigned int) 4;
416 for (; list
!= NULL
; list
= list
->next
)
419 /* Check if this property should be skipped. */
420 if (list
->property
.pr_kind
== property_remove
)
422 /* There are 4 byte type + 4 byte datasz for each property. */
423 if (list
->property
.pr_type
== GNU_PROPERTY_STACK_SIZE
)
426 datasz
= list
->property
.pr_datasz
;
427 size
+= 4 + 4 + datasz
;
428 /* Align each property. */
429 size
= (size
+ (align_size
- 1)) & ~(align_size
- 1);
435 /* Write GNU properties. */
438 elf_write_gnu_properties (bfd
*abfd
, bfd_byte
*contents
,
439 elf_property_list
*list
, unsigned int size
,
440 unsigned int align_size
)
444 Elf_External_Note
*e_note
;
446 e_note
= (Elf_External_Note
*) contents
;
447 descsz
= offsetof (Elf_External_Note
, name
[sizeof "GNU"]);
448 descsz
= (descsz
+ 3) & -(unsigned int) 4;
449 bfd_h_put_32 (abfd
, sizeof "GNU", &e_note
->namesz
);
450 bfd_h_put_32 (abfd
, size
- descsz
, &e_note
->descsz
);
451 bfd_h_put_32 (abfd
, NT_GNU_PROPERTY_TYPE_0
, &e_note
->type
);
452 memcpy (e_note
->name
, "GNU", sizeof "GNU");
455 for (; list
!= NULL
; list
= list
->next
)
457 /* Check if this property should be skipped. */
458 if (list
->property
.pr_kind
== property_remove
)
460 /* There are 4 byte type + 4 byte datasz for each property. */
461 if (list
->property
.pr_type
== GNU_PROPERTY_STACK_SIZE
)
464 datasz
= list
->property
.pr_datasz
;
465 bfd_h_put_32 (abfd
, list
->property
.pr_type
, contents
+ size
);
466 bfd_h_put_32 (abfd
, datasz
, contents
+ size
+ 4);
469 /* Write out property value. */
470 switch (list
->property
.pr_kind
)
472 case property_number
:
476 /* Never should happen. */
483 bfd_h_put_32 (abfd
, list
->property
.u
.number
,
488 bfd_h_put_64 (abfd
, list
->property
.u
.number
,
495 /* Never should happen. */
500 /* Align each property. */
501 size
= (size
+ (align_size
- 1)) & ~ (align_size
- 1);
505 /* Set up GNU properties. Return the first relocatable ELF input with
506 GNU properties if found. Otherwise, return NULL. */
509 _bfd_elf_link_setup_gnu_properties (struct bfd_link_info
*info
)
511 bfd
*abfd
, *first_pbfd
= NULL
;
512 elf_property_list
*list
;
514 bfd_boolean has_properties
= FALSE
;
515 const struct elf_backend_data
*bed
516 = get_elf_backend_data (info
->output_bfd
);
517 unsigned int elfclass
= bed
->s
->elfclass
;
518 int elf_machine_code
= bed
->elf_machine_code
;
520 /* Find the first relocatable ELF input with GNU properties. */
521 for (abfd
= info
->input_bfds
; abfd
!= NULL
; abfd
= abfd
->link
.next
)
522 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
523 && (abfd
->flags
& DYNAMIC
) == 0
524 && elf_properties (abfd
) != NULL
)
526 has_properties
= TRUE
;
528 /* Ignore GNU properties from ELF objects with different machine
529 code or class. Also skip objects without a GNU_PROPERTY note
531 if ((elf_machine_code
532 == get_elf_backend_data (abfd
)->elf_machine_code
)
534 == get_elf_backend_data (abfd
)->s
->elfclass
)
535 && bfd_get_section_by_name (abfd
,
536 NOTE_GNU_PROPERTY_SECTION_NAME
) != NULL
539 /* Keep .note.gnu.property section in FIRST_PBFD. */
545 /* Do nothing if there is no .note.gnu.property section. */
549 /* Merge .note.gnu.property sections. */
550 info
->callbacks
->minfo (_("\n"));
551 info
->callbacks
->minfo (_("Merging program properties\n"));
552 info
->callbacks
->minfo (_("\n"));
554 for (abfd
= info
->input_bfds
; abfd
!= NULL
; abfd
= abfd
->link
.next
)
555 if (abfd
!= first_pbfd
556 && (abfd
->flags
& (DYNAMIC
| BFD_PLUGIN
| BFD_LINKER_CREATED
)) == 0)
558 elf_property_list
*null_ptr
= NULL
;
559 elf_property_list
**listp
= &null_ptr
;
561 /* Merge .note.gnu.property section in relocatable ELF input. */
562 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
564 list
= elf_properties (abfd
);
566 /* Ignore GNU properties from ELF objects with different
570 == get_elf_backend_data (abfd
)->elf_machine_code
))
571 listp
= &elf_properties (abfd
);
576 /* Merge properties with FIRST_PBFD. FIRST_PBFD can be NULL
577 when all properties are from ELF objects with different
578 machine code or class. */
579 if (first_pbfd
!= NULL
)
580 elf_merge_gnu_property_list (info
, first_pbfd
, abfd
, listp
);
584 /* Discard the .note.gnu.property section in this bfd. */
585 sec
= bfd_get_section_by_name (abfd
,
586 NOTE_GNU_PROPERTY_SECTION_NAME
);
588 sec
->output_section
= bfd_abs_section_ptr
;
592 /* Rewrite .note.gnu.property section so that GNU properties are
593 always sorted by type even if input GNU properties aren't sorted. */
594 if (first_pbfd
!= NULL
)
598 unsigned int align_size
= elfclass
== ELFCLASS64
? 8 : 4;
600 sec
= bfd_get_section_by_name (first_pbfd
,
601 NOTE_GNU_PROPERTY_SECTION_NAME
);
602 BFD_ASSERT (sec
!= NULL
);
604 /* Update stack size in .note.gnu.property with -z stack-size=N
606 if (info
->stacksize
> 0)
609 bfd_vma stacksize
= info
->stacksize
;
611 p
= _bfd_elf_get_property (first_pbfd
, GNU_PROPERTY_STACK_SIZE
,
613 if (p
->pr_kind
== property_unknown
)
615 /* Create GNU_PROPERTY_STACK_SIZE. */
616 p
->u
.number
= stacksize
;
617 p
->pr_kind
= property_number
;
619 else if (stacksize
> p
->u
.number
)
620 p
->u
.number
= stacksize
;
622 else if (elf_properties (first_pbfd
) == NULL
)
624 /* Discard .note.gnu.property section if all properties have
626 sec
->output_section
= bfd_abs_section_ptr
;
630 /* Fix up GNU properties. */
631 if (bed
->fixup_gnu_properties
)
632 bed
->fixup_gnu_properties (info
, &elf_properties (first_pbfd
));
634 if (elf_properties (first_pbfd
) == NULL
)
636 /* Discard .note.gnu.property section if all properties have
638 sec
->output_section
= bfd_abs_section_ptr
;
642 /* Compute the section size. */
643 list
= elf_properties (first_pbfd
);
644 size
= elf_get_gnu_property_section_size (list
, align_size
);
646 /* Update .note.gnu.property section now. */
648 contents
= (bfd_byte
*) bfd_zalloc (first_pbfd
, size
);
650 elf_write_gnu_properties (first_pbfd
, contents
, list
, size
,
653 /* Cache the section contents for elf_link_input_bfd. */
654 elf_section_data (sec
)->this_hdr
.contents
= contents
;
656 /* If GNU_PROPERTY_NO_COPY_ON_PROTECTED is set, protected data
657 symbol is defined in the shared object. */
658 if (elf_has_no_copy_on_protected (first_pbfd
))
659 info
->extern_protected_data
= FALSE
;
665 /* Convert GNU property size. */
668 _bfd_elf_convert_gnu_property_size (bfd
*ibfd
, bfd
*obfd
)
670 unsigned int align_size
;
671 const struct elf_backend_data
*bed
;
672 elf_property_list
*list
= elf_properties (ibfd
);
674 bed
= get_elf_backend_data (obfd
);
675 align_size
= bed
->s
->elfclass
== ELFCLASS64
? 8 : 4;
677 /* Get the output .note.gnu.property section size. */
678 return elf_get_gnu_property_section_size (list
, align_size
);
681 /* Convert GNU properties. */
684 _bfd_elf_convert_gnu_properties (bfd
*ibfd
, asection
*isec
,
685 bfd
*obfd
, bfd_byte
**ptr
,
686 bfd_size_type
*ptr_size
)
690 unsigned int align_shift
;
691 const struct elf_backend_data
*bed
;
692 elf_property_list
*list
= elf_properties (ibfd
);
694 bed
= get_elf_backend_data (obfd
);
695 align_shift
= bed
->s
->elfclass
== ELFCLASS64
? 3 : 2;
697 /* Get the output .note.gnu.property section size. */
698 size
= bfd_section_size (isec
->output_section
);
700 /* Update the output .note.gnu.property section alignment. */
701 bfd_set_section_alignment (isec
->output_section
, align_shift
);
703 if (size
> bfd_section_size (isec
))
705 contents
= (bfd_byte
*) bfd_malloc (size
);
706 if (contents
== NULL
)
716 /* Generate the output .note.gnu.property section. */
717 elf_write_gnu_properties (ibfd
, contents
, list
, size
, 1 << align_shift
);