[thirdparty/binutils-gdb.git] / ld / emultempl / mipself.em

# This shell script emits a C file. -*- C -*-
#   Copyright (C) 2004-2018 Free Software Foundation, Inc.
#
# This file is part of the GNU Binutils.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
# MA 02110-1301, USA.

fragment <<EOF

#include "ldctor.h"
#include "elf/mips.h"
#include "elfxx-mips.h"

#define is_mips_elf(bfd)				\
  (bfd_get_flavour (bfd) == bfd_target_elf_flavour	\
   && elf_tdata (bfd) != NULL				\
   && elf_object_id (bfd) == MIPS_ELF_DATA)

/* Fake input file for stubs.  */
static lang_input_statement_type *stub_file;
static bfd *stub_bfd;

static bfd_boolean insn32;
static bfd_boolean ignore_branch_isa;

static void
mips_after_parse (void)
{
  /* .gnu.hash and the MIPS ABI require .dynsym to be sorted in different
     ways.  .gnu.hash needs symbols to be grouped by hash code whereas the
     MIPS ABI requires a mapping between the GOT and the symbol table.  */
  if (link_info.emit_gnu_hash)
    {
      einfo (_("%X%P: .gnu.hash is incompatible with the MIPS ABI\n"));
      link_info.emit_hash = TRUE;
      link_info.emit_gnu_hash = FALSE;
    }
  gld${EMULATION_NAME}_after_parse ();
}

struct hook_stub_info
{
  lang_statement_list_type add;
  asection *input_section;
};

/* Traverse the linker tree to find the spot where the stub goes.  */

static bfd_boolean
hook_in_stub (struct hook_stub_info *info, lang_statement_union_type **lp)
{
  lang_statement_union_type *l;
  bfd_boolean ret;

  for (; (l = *lp) != NULL; lp = &l->header.next)
    {
      switch (l->header.type)
	{
	case lang_constructors_statement_enum:
	  ret = hook_in_stub (info, &constructor_list.head);
	  if (ret)
	    return ret;
	  break;

	case lang_output_section_statement_enum:
	  ret = hook_in_stub (info,
			      &l->output_section_statement.children.head);
	  if (ret)
	    return ret;
	  break;

	case lang_wild_statement_enum:
	  ret = hook_in_stub (info, &l->wild_statement.children.head);
	  if (ret)
	    return ret;
	  break;

	case lang_group_statement_enum:
	  ret = hook_in_stub (info, &l->group_statement.children.head);
	  if (ret)
	    return ret;
	  break;

	case lang_input_section_enum:
	  if (info->input_section == NULL
	      || l->input_section.section == info->input_section)
	    {
	      /* We've found our section.  Insert the stub immediately
		 before its associated input section.  */
	      *lp = info->add.head;
	      *(info->add.tail) = l;
	      return TRUE;
	    }
	  break;

	case lang_data_statement_enum:
	case lang_reloc_statement_enum:
	case lang_object_symbols_statement_enum:
	case lang_output_statement_enum:
	case lang_target_statement_enum:
	case lang_input_statement_enum:
	case lang_assignment_statement_enum:
	case lang_padding_statement_enum:
	case lang_address_statement_enum:
	case lang_fill_statement_enum:
	  break;

	default:
	  FAIL ();
	  break;
	}
    }
  return FALSE;
}

/* Create a new stub section called STUB_SEC_NAME and arrange for it to
   be linked in OUTPUT_SECTION.  The section should go at the beginning of
   OUTPUT_SECTION if INPUT_SECTION is null, otherwise it must go immediately
   before INPUT_SECTION.  */

static asection *
mips_add_stub_section (const char *stub_sec_name, asection *input_section,
		       asection *output_section)
{
  asection *stub_sec;
  flagword flags;
  lang_output_section_statement_type *os;
  struct hook_stub_info info;

  /* PR 12845: If the input section has been garbage collected it will
     not have its output section set to *ABS*.  */
  if (bfd_is_abs_section (output_section))
    return NULL;

  /* Create the stub file, if we haven't already.  */
  if (stub_file == NULL)
    {
      stub_file = lang_add_input_file ("linker stubs",
				       lang_input_file_is_fake_enum,
				       NULL);
      stub_bfd = bfd_create ("linker stubs", link_info.output_bfd);
      if (stub_bfd == NULL
	  || !bfd_set_arch_mach (stub_bfd,
				 bfd_get_arch (link_info.output_bfd),
				 bfd_get_mach (link_info.output_bfd)))
	{
	  einfo (_("%F%P: can not create BFD %E\n"));
	  return NULL;
	}
      stub_bfd->flags |= BFD_LINKER_CREATED;
      stub_file->the_bfd = stub_bfd;
      ldlang_add_file (stub_file);
    }

  /* Create the section.  */
  stub_sec = bfd_make_section_anyway (stub_bfd, stub_sec_name);
  if (stub_sec == NULL)
    goto err_ret;

  /* Set the flags.  */
  flags = (SEC_ALLOC | SEC_LOAD | SEC_READONLY | SEC_CODE
	   | SEC_HAS_CONTENTS | SEC_IN_MEMORY | SEC_KEEP);
  if (!bfd_set_section_flags (stub_bfd, stub_sec, flags))
    goto err_ret;

  os = lang_output_section_get (output_section);

  /* Initialize a statement list that contains only the new statement.  */
  lang_list_init (&info.add);
  lang_add_section (&info.add, stub_sec, NULL, os);
  if (info.add.head == NULL)
    goto err_ret;

  /* Insert the new statement in the appropriate place.  */
  info.input_section = input_section;
  if (hook_in_stub (&info, &os->children.head))
    return stub_sec;

 err_ret:
  einfo (_("%X%P: can not make stub section: %E\n"));
  return NULL;
}

/* This is called before the input files are opened.  */

static void
mips_create_output_section_statements (void)
{
  struct elf_link_hash_table *htab;

  htab = elf_hash_table (&link_info);
  if (is_elf_hash_table (htab) && is_mips_elf (link_info.output_bfd))
    _bfd_mips_elf_linker_flags (&link_info, insn32, ignore_branch_isa);

  if (is_mips_elf (link_info.output_bfd))
    _bfd_mips_elf_init_stubs (&link_info, mips_add_stub_section);
}

/* This is called after we have merged the private data of the input bfds.  */

static void
mips_before_allocation (void)
{
  if (is_mips_elf (link_info.output_bfd))
    {
      flagword flags;

      flags = elf_elfheader (link_info.output_bfd)->e_flags;
      if (!bfd_link_pic (&link_info)
	  && !link_info.nocopyreloc
	  && (flags & (EF_MIPS_PIC | EF_MIPS_CPIC)) == EF_MIPS_CPIC)
	_bfd_mips_elf_use_plts_and_copy_relocs (&link_info);
    }

  gld${EMULATION_NAME}_before_allocation ();
}

/* Avoid processing the fake stub_file in vercheck, stat_needed and
   check_needed routines.  */

static void (*real_func) (lang_input_statement_type *);

static void mips_for_each_input_file_wrapper (lang_input_statement_type *l)
{
  if (l != stub_file)
    (*real_func) (l);
}

static void
mips_lang_for_each_input_file (void (*func) (lang_input_statement_type *))
{
  real_func = func;
  lang_for_each_input_file (&mips_for_each_input_file_wrapper);
}

#define lang_for_each_input_file mips_lang_for_each_input_file

EOF

# Define some shell vars to insert bits of code into the standard elf
# parse_args and list_options functions.
#
PARSE_AND_LIST_PROLOGUE='
enum
  {
    OPTION_INSN32 = 301,
    OPTION_NO_INSN32,
    OPTION_IGNORE_BRANCH_ISA,
    OPTION_NO_IGNORE_BRANCH_ISA
  };
'

PARSE_AND_LIST_LONGOPTS='
  { "insn32", no_argument, NULL, OPTION_INSN32 },
  { "no-insn32", no_argument, NULL, OPTION_NO_INSN32 },
  { "ignore-branch-isa", no_argument, NULL, OPTION_IGNORE_BRANCH_ISA },
  { "no-ignore-branch-isa", no_argument, NULL, OPTION_NO_IGNORE_BRANCH_ISA },
'

PARSE_AND_LIST_OPTIONS='
  fprintf (file, _("\
  --insn32                    Only generate 32-bit microMIPS instructions\n"
		   ));
  fprintf (file, _("\
  --no-insn32                 Generate all microMIPS instructions\n"
		   ));
  fprintf (file, _("\
  --ignore-branch-isa         Accept invalid branch relocations requiring\n\
                              an ISA mode switch\n"
		   ));
  fprintf (file, _("\
  --no-ignore-branch-isa      Reject invalid branch relocations requiring\n\
                              an ISA mode switch\n"
		   ));
'

PARSE_AND_LIST_ARGS_CASES='
    case OPTION_INSN32:
      insn32 = TRUE;
      break;

    case OPTION_NO_INSN32:
      insn32 = FALSE;
      break;

    case OPTION_IGNORE_BRANCH_ISA:
      ignore_branch_isa = TRUE;
      break;

    case OPTION_NO_IGNORE_BRANCH_ISA:
      ignore_branch_isa = FALSE;
      break;
'

LDEMUL_AFTER_PARSE=mips_after_parse
LDEMUL_BEFORE_ALLOCATION=mips_before_allocation
LDEMUL_CREATE_OUTPUT_SECTION_STATEMENTS=mips_create_output_section_statements
Commit	Line	Data
73934d31	1	# This shell script emits a C file. -- C --
219d1afa	2	# Copyright (C) 2004-2018 Free Software Foundation, Inc.
73934d31	3	#
f96b4a7b	4	# This file is part of the GNU Binutils.
73934d31 RS	5	#
	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
f96b4a7b	8	# the Free Software Foundation; either version 3 of the License, or
73934d31 RS	9	# (at your option) any later version.
	10	#
	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.
	15	#
	16	# You should have received a copy of the GNU General Public License
f96b4a7b NC	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.
73934d31	20
92b93329	21	fragment <<EOF
861fb55a DJ	22
	23	#include "ldctor.h"
	24	#include "elf/mips.h"
	25	#include "elfxx-mips.h"
	26
	27	#define is_mips_elf(bfd) \
	28	(bfd_get_flavour (bfd) == bfd_target_elf_flavour \
	29	&& elf_tdata (bfd) != NULL \
4dfe6ac6	30	&& elf_object_id (bfd) == MIPS_ELF_DATA)
861fb55a DJ	31
	32	/* Fake input file for stubs. */
	33	static lang_input_statement_type *stub_file;
	34	static bfd *stub_bfd;
	35
833794fc	36	static bfd_boolean insn32;
8b10b0b3	37	static bfd_boolean ignore_branch_isa;
833794fc	38
73934d31 RS	39	static void
	40	mips_after_parse (void)
	41	{
	42	/* .gnu.hash and the MIPS ABI require .dynsym to be sorted in different
	43	ways. .gnu.hash needs symbols to be grouped by hash code whereas the
	44	MIPS ABI requires a mapping between the GOT and the symbol table. */
	45	if (link_info.emit_gnu_hash)
	46	{
d003af55	47	einfo (_("%X%P: .gnu.hash is incompatible with the MIPS ABI\n"));
73934d31 RS	48	link_info.emit_hash = TRUE;
	49	link_info.emit_gnu_hash = FALSE;
	50	}
5fe2850d	51	gld${EMULATION_NAME}_after_parse ();
73934d31	52	}
861fb55a DJ	53
	54	struct hook_stub_info
	55	{
	56	lang_statement_list_type add;
	57	asection *input_section;
	58	};
	59
	60	/* Traverse the linker tree to find the spot where the stub goes. */
	61
	62	static bfd_boolean
	63	hook_in_stub (struct hook_stub_info info, lang_statement_union_type *lp)
	64	{
	65	lang_statement_union_type *l;
	66	bfd_boolean ret;
	67
	68	for (; (l = *lp) != NULL; lp = &l->header.next)
	69	{
	70	switch (l->header.type)
	71	{
	72	case lang_constructors_statement_enum:
	73	ret = hook_in_stub (info, &constructor_list.head);
	74	if (ret)
	75	return ret;
	76	break;
	77
	78	case lang_output_section_statement_enum:
	79	ret = hook_in_stub (info,
	80	&l->output_section_statement.children.head);
	81	if (ret)
	82	return ret;
	83	break;
	84
	85	case lang_wild_statement_enum:
	86	ret = hook_in_stub (info, &l->wild_statement.children.head);
	87	if (ret)
	88	return ret;
	89	break;
	90
	91	case lang_group_statement_enum:
	92	ret = hook_in_stub (info, &l->group_statement.children.head);
	93	if (ret)
	94	return ret;
	95	break;
	96
	97	case lang_input_section_enum:
	98	if (info->input_section == NULL
	99	\|\| l->input_section.section == info->input_section)
	100	{
	101	/* We've found our section. Insert the stub immediately
	102	before its associated input section. */
	103	*lp = info->add.head;
	104	*(info->add.tail) = l;
	105	return TRUE;
	106	}
	107	break;
	108
	109	case lang_data_statement_enum:
	110	case lang_reloc_statement_enum:
	111	case lang_object_symbols_statement_enum:
	112	case lang_output_statement_enum:
	113	case lang_target_statement_enum:
	114	case lang_input_statement_enum:
	115	case lang_assignment_statement_enum:
	116	case lang_padding_statement_enum:
117	case lang_address_statement_enum:
118	case lang_fill_statement_enum:
119	break;
120
121	default:
122	FAIL ();
123	break;
124	}
125	}
126	return FALSE;
127	}
128
129	/* Create a new stub section called STUB_SEC_NAME and arrange for it to
130	be linked in OUTPUT_SECTION. The section should go at the beginning of
131	OUTPUT_SECTION if INPUT_SECTION is null, otherwise it must go immediately
132	before INPUT_SECTION. */
133
134	static asection *
135	mips_add_stub_section (const char stub_sec_name, asection input_section,
136	asection *output_section)
137	{
138	asection *stub_sec;
139	flagword flags;
861fb55a DJ	140	lang_output_section_statement_type *os;
	141	struct hook_stub_info info;
	142
ba85c43e NC	143	/* PR 12845: If the input section has been garbage collected it will
	144	not have its output section set to ABS. */
	145	if (bfd_is_abs_section (output_section))
	146	return NULL;
	147
861fb55a DJ	148	/* Create the stub file, if we haven't already. */
	149	if (stub_file == NULL)
	150	{
	151	stub_file = lang_add_input_file ("linker stubs",
	152	lang_input_file_is_fake_enum,
	153	NULL);
	154	stub_bfd = bfd_create ("linker stubs", link_info.output_bfd);
	155	if (stub_bfd == NULL
	156	\|\| !bfd_set_arch_mach (stub_bfd,
	157	bfd_get_arch (link_info.output_bfd),
	158	bfd_get_mach (link_info.output_bfd)))
	159	{
d003af55	160	einfo (_("%F%P: can not create BFD %E\n"));
861fb55a DJ	161	return NULL;
	162	}
	163	stub_bfd->flags \|= BFD_LINKER_CREATED;
	164	stub_file->the_bfd = stub_bfd;
	165	ldlang_add_file (stub_file);
	166	}
	167
	168	/* Create the section. */
	169	stub_sec = bfd_make_section_anyway (stub_bfd, stub_sec_name);
	170	if (stub_sec == NULL)
	171	goto err_ret;
	172
	173	/* Set the flags. */
	174	flags = (SEC_ALLOC \| SEC_LOAD \| SEC_READONLY \| SEC_CODE
	175	\| SEC_HAS_CONTENTS \| SEC_IN_MEMORY \| SEC_KEEP);
	176	if (!bfd_set_section_flags (stub_bfd, stub_sec, flags))
	177	goto err_ret;
	178
24ef1aa7	179	os = lang_output_section_get (output_section);
861fb55a DJ	180
	181	/* Initialize a statement list that contains only the new statement. */
	182	lang_list_init (&info.add);
b9c361e0	183	lang_add_section (&info.add, stub_sec, NULL, os);
861fb55a DJ	184	if (info.add.head == NULL)
	185	goto err_ret;
	186
	187	/* Insert the new statement in the appropriate place. */
	188	info.input_section = input_section;
	189	if (hook_in_stub (&info, &os->children.head))
	190	return stub_sec;
	191
	192	err_ret:
d003af55	193	einfo (_("%X%P: can not make stub section: %E\n"));
861fb55a DJ	194	return NULL;
	195	}
	196
	197	/* This is called before the input files are opened. */
	198
	199	static void
	200	mips_create_output_section_statements (void)
	201	{
833794fc MR	202	struct elf_link_hash_table *htab;
	203
	204	htab = elf_hash_table (&link_info);
	205	if (is_elf_hash_table (htab) && is_mips_elf (link_info.output_bfd))
8b10b0b3	206	_bfd_mips_elf_linker_flags (&link_info, insn32, ignore_branch_isa);
833794fc	207
861fb55a DJ	208	if (is_mips_elf (link_info.output_bfd))
	209	_bfd_mips_elf_init_stubs (&link_info, mips_add_stub_section);
	210	}
	211
	212	/* This is called after we have merged the private data of the input bfds. */
	213
	214	static void
	215	mips_before_allocation (void)
	216	{
e54cb31a MR	217	if (is_mips_elf (link_info.output_bfd))
	218	{
	219	flagword flags;
861fb55a	220
e54cb31a MR	221	flags = elf_elfheader (link_info.output_bfd)->e_flags;
	222	if (!bfd_link_pic (&link_info)
	223	&& !link_info.nocopyreloc
	224	&& (flags & (EF_MIPS_PIC \| EF_MIPS_CPIC)) == EF_MIPS_CPIC)
	225	_bfd_mips_elf_use_plts_and_copy_relocs (&link_info);
	226	}
861fb55a DJ	227
	228	gld${EMULATION_NAME}_before_allocation ();
	229	}
	230
	231	/* Avoid processing the fake stub_file in vercheck, stat_needed and
	232	check_needed routines. */
	233
	234	static void (real_func) (lang_input_statement_type );
	235
	236	static void mips_for_each_input_file_wrapper (lang_input_statement_type *l)
	237	{
	238	if (l != stub_file)
	239	(*real_func) (l);
	240	}
	241
	242	static void
	243	mips_lang_for_each_input_file (void (func) (lang_input_statement_type ))
	244	{
	245	real_func = func;
	246	lang_for_each_input_file (&mips_for_each_input_file_wrapper);
	247	}
	248
	249	#define lang_for_each_input_file mips_lang_for_each_input_file
	250
73934d31 RS	251	EOF
73934d31 RS	252
833794fc MR	253	# Define some shell vars to insert bits of code into the standard elf
	254	# parse_args and list_options functions.
	255	#
	256	PARSE_AND_LIST_PROLOGUE='
2f2da8fd MR	257	enum
	258	{
	259	OPTION_INSN32 = 301,
8b10b0b3 MR	260	OPTION_NO_INSN32,
	261	OPTION_IGNORE_BRANCH_ISA,
	262	OPTION_NO_IGNORE_BRANCH_ISA
2f2da8fd	263	};
833794fc MR	264	'
	265
	266	PARSE_AND_LIST_LONGOPTS='
	267	{ "insn32", no_argument, NULL, OPTION_INSN32 },
	268	{ "no-insn32", no_argument, NULL, OPTION_NO_INSN32 },
8b10b0b3 MR	269	{ "ignore-branch-isa", no_argument, NULL, OPTION_IGNORE_BRANCH_ISA },
8b10b0b3 MR	270	{ "no-ignore-branch-isa", no_argument, NULL, OPTION_NO_IGNORE_BRANCH_ISA },
833794fc MR	271	'
	272
	273	PARSE_AND_LIST_OPTIONS='
	274	fprintf (file, _("\
	275	--insn32 Only generate 32-bit microMIPS instructions\n"
	276	));
	277	fprintf (file, _("\
	278	--no-insn32 Generate all microMIPS instructions\n"
	279	));
8b10b0b3 MR	280	fprintf (file, _("\
	281	--ignore-branch-isa Accept invalid branch relocations requiring\n\
	282	an ISA mode switch\n"
	283	));
	284	fprintf (file, _("\
	285	--no-ignore-branch-isa Reject invalid branch relocations requiring\n\
	286	an ISA mode switch\n"
	287	));
833794fc MR	288	'
	289
	290	PARSE_AND_LIST_ARGS_CASES='
	291	case OPTION_INSN32:
	292	insn32 = TRUE;
	293	break;
	294
	295	case OPTION_NO_INSN32:
	296	insn32 = FALSE;
	297	break;
8b10b0b3 MR	298
	299	case OPTION_IGNORE_BRANCH_ISA:
	300	ignore_branch_isa = TRUE;
	301	break;
	302
	303	case OPTION_NO_IGNORE_BRANCH_ISA:
	304	ignore_branch_isa = FALSE;
	305	break;
833794fc MR	306	'
833794fc MR	307
73934d31	308	LDEMUL_AFTER_PARSE=mips_after_parse
861fb55a DJ	309	LDEMUL_BEFORE_ALLOCATION=mips_before_allocation
861fb55a DJ	310	LDEMUL_CREATE_OUTPUT_SECTION_STATEMENTS=mips_create_output_section_statements