binutils-gdb/ld/emultempl
Nick Alcock 1ff6de0312 bfd, ld: add CTF section linking
This is quite complicated because the CTF section's contents depend on
the final contents of the symtab and strtab, because it has two sections
whose contents are shuffled to be in 1:1 correspondence with the symtab,
and an internal strtab that gets deduplicated against the ELF strtab
(with offsets adjusted to point into the ELF strtab instead).  It is
also compressed if large enough, so its size depends on its contents!

So we cannot construct it as early as most sections: we cannot even
*begin* construction until after the symtab and strtab are finalized.
Thankfully there is already one section treated similarly: compressed
debugging sections: the only differences are that compressed debugging
sections have extra handling to deal with their changing name if
compressed (CTF sections are always called ".ctf" for now, though we
have reserved ".ctf.*" against future use), and that compressed
debugging sections have previously-uncompressed content which has to be
stashed away for later compression, while CTF sections have no content
at all until we generate it (very late).

BFD also cannot do the link itself: libctf knows how to do it, and BFD
cannot call libctf directly because libctf already depends on bfd for
file I/O.  So we have to use a pair of callbacks, one, examine_strtab,
which allows a caller to examine the symtab and strtab after
finalization (called from elf_link_swap_symbols_out(), right before the
symtabs are written, and after the strtab has been finalized), and one
which actually does the emission (called emit_ctf simply because it is
grouped with a bunch of section-specific late-emission function calls at
the bottom of bfd_elf_final_link, and a section-specific name seems best
for that).  emit_ctf is actually called *twice*: once from lang_process
if the emulation suggests that this bfd target does not examine the
symtab or strtab, and once via a bfd callback if it does.  (This means
that non-ELF targets still get CTF emitted, even though the late CTF
emission stage is never called for them).

v2: merged with non-ELF support patch: slight commit message
    adjustments.
v3: do not spend time merging CTF, or crash, if the CTF section is
    explicitly discarded.  Do not try to merge or compress CTF unless
    linking.
v4: add CTF_COMPRESSION_THRESHOLD.  Annul the freed input ctf_file_t's
    after writeout: set SEC_IN_MEMORY on the output contents so a future
    bfd enhancement knows it could free it.  Add SEC_LINKER_CREATED |
    SEC_KEEP to avoid having to add .ctf to the linker script.  Drop
    now-unnecessary ldlang.h-level elf-bfd.h include and hackery around
    it.  Adapt to elf32.em->elf.em and elf-generic.em->ldelf*.c
    changes.
v5: fix tabdamage.  Drop #inclusions in .h files: include in .c files,
    .em files, and use struct forwards instead.  Use bfd_section_is_ctf
    inline function rather than SECTION_IS_CTF macro.  Move a few
    comments.

	* Makefile.def (dependencies): all-ld depends on all-libctf.
	* Makefile.in: Regenerated.

include/
	* bfdlink.h (elf_strtab_hash): New forward.
	(elf_sym_strtab): Likewise.
	(struct bfd_link_callbacks <examine_strtab>): New.
	(struct bfd_link_callbacks <emit_ctf>): Likewise.

bfd/
	* elf-bfd.h (bfd_section_is_ctf): New inline function.
	* elf.c (special_sections_c): Add ".ctf".
	(assign_file_positions_for_non_load_sections): Note that
	compressed debugging sections etc are not assigned here.  Treat
	CTF sections like SEC_ELF_COMPRESS sections when is_linker_output:
	sh_offset -1.
	(assign_file_positions_except_relocs): Likewise.
	(find_section_in_list): Note that debugging and CTF sections, as
	well as reloc sections, are assigned later.
	(_bfd_elf_assign_file_positions_for_non_load): CTF sections get
	their size and contents updated.
	(_bfd_elf_set_section_contents): Skip CTF sections: unlike
	compressed sections, they have no uncompressed content to copy at
	this stage.
	* elflink.c (elf_link_swap_symbols_out): Call the examine_strtab
	callback right before the strtab is written out.
	(bfd_elf_final_link): Don't cache the section contents of CTF
	sections: they are not populated yet.  Call the emit_ctf callback
	right at the end, after all the symbols and strings are flushed
	out.

ld/
	* ldlang.h: (struct lang_input_statement_struct): Add the_ctf.
	(struct elf_sym_strtab): Add forward.
	(struct elf_strtab_hash): Likewise.
	(ldlang_ctf_apply_strsym): Declare.
	(ldlang_write_ctf_late): Likewise.
	* ldemul.h (ldemul_emit_ctf_early): New.
	(ldemul_examine_strtab_for_ctf): Likewise.
	(ld_emulation_xfer_type) <emit_ctf_early>: Likewise.
	(ld_emulation_xfer_type) <examine_strtab_for_ctf>: Likewise.
	* ldemul.c (ldemul_emit_ctf_early): New.
	(ldemul_examine_strtab_for_ctf): Likewise.
	* ldlang.c: Include ctf-api.h.
	(CTF_COMPRESSION_THRESHOLD): New.
	(ctf_output): New. Initialized in...
	(ldlang_open_ctf): ... this new function.  Open all the CTF
	sections in the input files: mark them non-loaded and empty
	so as not to copy their contents to the output, but linker-created
	so the section gets created in the target.
	(ldlang_merge_ctf): New, merge types via ctf_link_add_ctf and
	ctf_link.
	(ldlang_ctf_apply_strsym): New, an examine_strtab callback: wrap
	ldemul_examine_strtab_for_ctf.
	(lang_write_ctf): New, write out the CTF section.
	(ldlang_write_ctf_late): New, late call via bfd's emit_ctf hook.
	(lang_process): Call ldlang_open_ctf, ldlang_merge_ctf, and
	lang_write_ctf.
	* ldmain.c (link_callbacks): Add ldlang_ctf_apply_strsym,
	ldlang_write_ctf_late.
	* emultempl/aix.em: Add ctf-api.h.
	* emultempl/armcoff.em: Likewise.
	* emultempl/beos.em: Likewise.
	* emultempl/elf.em: Likewise.
	* emultempl/generic.em: Likewise.
	* emultempl/linux.em: Likewise.
	* emultempl/msp430.em: Likewise.
	* emultempl/pe.em: Likewise.
	* emultempl/pep.em: Likewise.
	* emultempl/ticoff.em: Likewise.
	* emultempl/vanilla.em: Likewise.
	* ldcref.c: Likewise.
	* ldctor.c: Likewise.
	* ldelf.c: Likewise.
	* ldelfgen.c: Likewise.
	* ldemul.c: Likewise.
	* ldexp.c: Likewise.
	* ldfile.c: Likewise.
	* ldgram.c: Likewise.
	* ldlex.l: Likewise.
	* ldmain.c: Likewise.
	* ldmisc.c: Likewise.
	* ldver.c: Likewise.
	* ldwrite.c: Likewise.
	* lexsup.c: Likewise.
	* mri.c: Likewise.
	* pe-dll.c: Likewise.
	* plugin.c: Likewise.

	* ldelfgen.c (ldelf_emit_ctf_early): New.
	(ldelf_examine_strtab_for_ctf): tell libctf about the symtab and
	strtab.
	(struct ctf_strsym_iter_cb_arg): New, state to do so.
	(ldelf_ctf_strtab_iter_cb): New: tell libctf about
	each string in the strtab in turn.
	(ldelf_ctf_symbols_iter_cb): New, tell libctf
	about each symbol in the symtab in turn.
	* ldelfgen.h (struct elf_sym_strtab): Add forward.
	(struct elf_strtab_hash): Likewise.
	(struct ctf_file): Likewise.
	(ldelf_emit_ctf_early): Declare.
	(ldelf_examine_strtab_for_ctf): Likewise.
	* emultempl/elf-generic.em (LDEMUL_EMIT_CTF_EARLY): Set it.
	(LDEMUL_EXAMINE_STRTAB_FOR_CTF): Likewise.
	* emultempl/aix.em (ld_${EMULATION_NAME}_emulation): Add
	emit_ctf_early and examine_strtab_for_ctf, NULL by default.
	* emultempl/armcoff.em (ld_${EMULATION_NAME}_emulation): Likewise.
	* emultempl/beos.em (ld_${EMULATION_NAME}_emulation): Likewise.
	* emultempl/elf.em (ld_${EMULATION_NAME}_emulation): Likewise.
	* emultempl/generic.em (ld_${EMULATION_NAME}_emulation): Likewise.
	* emultempl/linux.em (ld_${EMULATION_NAME}_emulation): Likewise.
	* emultempl/msp430.em (ld_${EMULATION_NAME}_emulation): Likewise.
	* emultempl/pe.em (ld_${EMULATION_NAME}_emulation): Likewise.
	* emultempl/pep.em (ld_${EMULATION_NAME}_emulation): Likewise.
	* emultempl/ticoff.em (ld_${EMULATION_NAME}_emulation): Likewise.
	* emultempl/vanilla.em (ld_vanilla_emulation): Likewise.

	* Makefile.am: Pull in libctf (and zlib, a transitive requirement
	for compressed CTF section emission).  Pass it on to DejaGNU.
	* configure.ac: Add AM_ZLIB.
	* aclocal.m4: Added zlib.m4.
	* Makefile.in: Regenerated.
	* testsuite/ld-bootstrap/bootstrap.exp: Use it when relinking ld.
2019-10-03 17:04:56 +01:00
..
README Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
aarch64elf.em aarch64 bfd.h tidy 2019-09-23 10:27:21 +09:30
aix.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
alphaelf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
arclinux.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
armcoff.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
armelf.em arm bfd.h tidy 2019-09-23 10:27:21 +09:30
astring.sed * emultempl/ostring.sed: Rename from stringify.sed. 1999-08-06 22:46:03 +00:00
avrelf.em Silence a build-time warning about constant comparisons when building with clang, 2019-09-25 14:34:23 +01:00
beos.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
bfin.em bfin bfd.h tidy 2019-09-23 10:27:21 +09:30
cr16elf.em cr16 bfd.h tidy 2019-09-23 10:27:21 +09:30
crxelf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
cskyelf.em csky bfd.h tidy 2019-09-23 10:27:20 +09:30
elf-generic.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
elf-x86.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
elf.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
epiphanyelf_4x4.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
genelf.em Move elf32.em and elf-generic.em functions 2019-09-11 13:44:22 +09:30
generic.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
hppaelf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
ia64elf.em ia64 bfd.h tidy 2019-09-23 10:27:21 +09:30
irix.em elf bfd.h tidy 2019-09-23 10:27:22 +09:30
linux.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
m68hc1xelf.em bfd_section_* macros 2019-09-19 09:40:13 +09:30
m68kelf.em m68k bfd.h tidy 2019-09-23 10:27:22 +09:30
metagelf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
mipself.em bfd_section_* macros 2019-09-19 09:40:13 +09:30
mmix-elfnmmo.em bfd_section_* macros 2019-09-19 09:40:13 +09:30
mmixelf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
mmo.em bfd macro conversion to inline functions 2019-09-20 18:04:02 +09:30
msp430.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
nds32elf.em Move elf32.em and elf-generic.em functions 2019-09-11 13:44:22 +09:30
needrelax.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
netbsd.em Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
nios2elf.em bfd_section_* macros 2019-09-19 09:40:13 +09:30
ostring.sed * emultempl/ostring.sed: Rename from stringify.sed. 1999-08-06 22:46:03 +00:00
pe.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
pep.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
ppc32elf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
ppc64elf.em bfd macro conversion to inline functions 2019-09-20 18:04:02 +09:30
pruelf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
riscvelf.em Move elf32.em and elf-generic.em functions 2019-09-11 13:44:22 +09:30
rxelf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
s390.em Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
scoreelf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
solaris2-x86.em x86: Move x86-specific linker options to elf_linker_x86_params 2019-04-06 07:25:31 -07:00
solaris2.em Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
spu_icache.S bfd/ 2009-03-17 12:46:19 +00:00
spu_icache.o_c Regenerate spu overlay and icache manager files 2014-11-04 22:36:13 +10:30
spu_ovl.S Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30
spu_ovl.o_c Regenerate spu_ovl.o_c 2016-10-15 12:53:57 +10:30
spuelf.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
tic6xdsbt.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
ticoff.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
v850elf.em v850 bfd.h tidy 2019-09-23 10:27:20 +09:30
vanilla.em bfd, ld: add CTF section linking 2019-10-03 17:04:56 +01:00
vms.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
vxworks.em Rename elf32.em to elf.em 2019-09-11 13:45:18 +09:30
xtensaelf.em bfd macro conversion to inline functions, section 2019-09-20 18:04:03 +09:30
z80.em Update year range in copyright notice of binutils files 2019-01-01 22:06:53 +10:30

README

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

The files in this directory are sourced by genscripts.sh, after
setting some variables to substitute in, to produce
C source files that contain jump tables for each emulation.

Copyright (C) 2012-2019 Free Software Foundation, Inc.

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.