1 # This shell script emits a C file. -*- C -*-
2 # It does some substitutions.
3 if [ -z "$MACHINE" ]; then
6 OUTPUT_ARCH=${ARCH}:${MACHINE}
9 /* This file is part of GLD, the Gnu Linker.
10 Copyright (C) 1995-2020 Free Software Foundation, Inc.
12 This file is part of the GNU Binutils.
14 This program is free software; you can redistribute it and/or modify
15 it under the terms of the GNU General Public License as published by
16 the Free Software Foundation; either version 3 of the License, or
17 (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU General Public License for more details.
24 You should have received a copy of the GNU General Public License
25 along with this program; if not, write to the Free Software
26 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
27 MA 02110-1301, USA. */
31 /* The original file generated returned different default scripts depending
32 on whether certain switches were set, but these switches pertain to the
33 Linux system and that particular version of coff. In the NT case, we
34 only determine if the subsystem is console or windows in order to select
35 the correct entry point by default. */
42 #include "libiberty.h"
43 #include "filenames.h"
54 #include "coff/internal.h"
55 #include "../bfd/libcoff.h"
57 #define TARGET_IS_${EMULATION_NAME}
59 static struct internal_extra_pe_aouthdr pe;
62 extern const char *output_filename;
65 gld_${EMULATION_NAME}_before_parse (void)
67 ldfile_set_output_arch ("${OUTPUT_ARCH}", bfd_arch_`echo ${ARCH} | sed -e 's/:.*//'`);
68 output_filename = "a.exe";
71 /* PE format extra command line options. */
73 /* Used for setting flags in the PE header. */
74 #define OPTION_BASE_FILE (300 + 1)
75 #define OPTION_DLL (OPTION_BASE_FILE + 1)
76 #define OPTION_FILE_ALIGNMENT (OPTION_DLL + 1)
77 #define OPTION_IMAGE_BASE (OPTION_FILE_ALIGNMENT + 1)
78 #define OPTION_MAJOR_IMAGE_VERSION (OPTION_IMAGE_BASE + 1)
79 #define OPTION_MAJOR_OS_VERSION (OPTION_MAJOR_IMAGE_VERSION + 1)
80 #define OPTION_MAJOR_SUBSYSTEM_VERSION (OPTION_MAJOR_OS_VERSION + 1)
81 #define OPTION_MINOR_IMAGE_VERSION (OPTION_MAJOR_SUBSYSTEM_VERSION + 1)
82 #define OPTION_MINOR_OS_VERSION (OPTION_MINOR_IMAGE_VERSION + 1)
83 #define OPTION_MINOR_SUBSYSTEM_VERSION (OPTION_MINOR_OS_VERSION + 1)
84 #define OPTION_SECTION_ALIGNMENT (OPTION_MINOR_SUBSYSTEM_VERSION + 1)
85 #define OPTION_STACK (OPTION_SECTION_ALIGNMENT + 1)
86 #define OPTION_SUBSYSTEM (OPTION_STACK + 1)
87 #define OPTION_HEAP (OPTION_SUBSYSTEM + 1)
90 gld${EMULATION_NAME}_add_options
91 (int ns ATTRIBUTE_UNUSED, char **shortopts ATTRIBUTE_UNUSED, int nl,
92 struct option **longopts, int nrl ATTRIBUTE_UNUSED,
93 struct option **really_longopts ATTRIBUTE_UNUSED)
95 static const struct option xtra_long[] = {
97 {"base-file", required_argument, NULL, OPTION_BASE_FILE},
98 {"dll", no_argument, NULL, OPTION_DLL},
99 {"file-alignment", required_argument, NULL, OPTION_FILE_ALIGNMENT},
100 {"heap", required_argument, NULL, OPTION_HEAP},
101 {"image-base", required_argument, NULL, OPTION_IMAGE_BASE},
102 {"major-image-version", required_argument, NULL, OPTION_MAJOR_IMAGE_VERSION},
103 {"major-os-version", required_argument, NULL, OPTION_MAJOR_OS_VERSION},
104 {"major-subsystem-version", required_argument, NULL, OPTION_MAJOR_SUBSYSTEM_VERSION},
105 {"minor-image-version", required_argument, NULL, OPTION_MINOR_IMAGE_VERSION},
106 {"minor-os-version", required_argument, NULL, OPTION_MINOR_OS_VERSION},
107 {"minor-subsystem-version", required_argument, NULL, OPTION_MINOR_SUBSYSTEM_VERSION},
108 {"section-alignment", required_argument, NULL, OPTION_SECTION_ALIGNMENT},
109 {"stack", required_argument, NULL, OPTION_STACK},
110 {"subsystem", required_argument, NULL, OPTION_SUBSYSTEM},
111 {NULL, no_argument, NULL, 0}
114 *longopts = (struct option *)
115 xrealloc (*longopts, nl * sizeof (struct option) + sizeof (xtra_long));
116 memcpy (*longopts + nl, &xtra_long, sizeof (xtra_long));
120 /* PE/WIN32; added routines to get the subsystem type, heap and/or stack
121 parameters which may be input from the command line */
131 #define D(field,symbol,def) {&pe.field,sizeof(pe.field), def, symbol,0}
133 static definfo init[] =
135 /* imagebase must be first */
136 #define IMAGEBASEOFF 0
137 D(ImageBase,"__image_base__", BEOS_EXE_IMAGE_BASE),
139 {&dll, sizeof(dll), 0, "__dll__", 0},
140 D(SectionAlignment,"__section_alignment__", PE_DEF_SECTION_ALIGNMENT),
141 D(FileAlignment,"__file_alignment__", PE_DEF_FILE_ALIGNMENT),
142 D(MajorOperatingSystemVersion,"__major_os_version__", 4),
143 D(MinorOperatingSystemVersion,"__minor_os_version__", 0),
144 D(MajorImageVersion,"__major_image_version__", 1),
145 D(MinorImageVersion,"__minor_image_version__", 0),
146 D(MajorSubsystemVersion,"__major_subsystem_version__", 4),
147 D(MinorSubsystemVersion,"__minor_subsystem_version__", 0),
148 D(Subsystem,"__subsystem__", 3),
149 D(SizeOfStackReserve,"__size_of_stack_reserve__", 0x2000000),
150 D(SizeOfStackCommit,"__size_of_stack_commit__", 0x1000),
151 D(SizeOfHeapReserve,"__size_of_heap_reserve__", 0x100000),
152 D(SizeOfHeapCommit,"__size_of_heap_commit__", 0x1000),
153 D(LoaderFlags,"__loader_flags__", 0x0),
154 { NULL, 0, 0, NULL, 0 }
159 set_pe_name (char *name, long val)
162 /* Find the name and set it. */
163 for (i = 0; init[i].ptr; i++)
165 if (strcmp (name, init[i].symbol) == 0)
177 set_pe_subsystem (void)
190 { "native", 1, "_NtProcessStartup" },
191 { "windows", 2, "_WinMainCRTStartup" },
192 { "wwindows", 2, "_wWinMainCRTStartup" },
193 { "console", 3, "_mainCRTStartup" },
194 { "wconsole", 3, "_wmainCRTStartup" },
195 { "posix", 7, "___PosixProcessStartup"},
199 sver = strchr (optarg, ':');
201 len = strlen (optarg);
207 set_pe_name ("__major_subsystem_version__",
208 strtoul (sver + 1, &end, 0));
210 set_pe_name ("__minor_subsystem_version__",
211 strtoul (end + 1, &end, 0));
213 einfo (_("%P: warning: bad version number in -subsystem option\n"));
216 for (i = 0; v[i].name; i++)
218 if (strncmp (optarg, v[i].name, len) == 0
219 && v[i].name[len] == '\0')
221 set_pe_name ("__subsystem__", v[i].value);
223 /* If the subsystem is windows, we use a different entry
225 lang_default_entry (v[i].entry);
230 einfo (_("%F%P: invalid subsystem type %s\n"), optarg);
235 set_pe_value (char *name)
238 set_pe_name (name, strtoul (optarg, &end, 0));
241 einfo (_("%F%P: invalid hex number for PE parameter '%s'\n"), optarg);
248 set_pe_stack_heap (char *resname, char *comname)
250 set_pe_value (resname);
254 set_pe_value (comname);
258 einfo (_("%F%P: strange hex info for PE parameter '%s'\n"), optarg);
264 gld${EMULATION_NAME}_handle_option (int optc)
271 case OPTION_BASE_FILE:
272 link_info.base_file = fopen (optarg, FOPEN_WB);
273 if (link_info.base_file == NULL)
274 einfo (_("%F%P: cannot open base file %s\n"), optarg);
279 set_pe_stack_heap ("__size_of_heap_reserve__", "__size_of_heap_commit__");
282 set_pe_stack_heap ("__size_of_stack_reserve__", "__size_of_stack_commit__");
284 case OPTION_SUBSYSTEM:
287 case OPTION_MAJOR_OS_VERSION:
288 set_pe_value ("__major_os_version__");
290 case OPTION_MINOR_OS_VERSION:
291 set_pe_value ("__minor_os_version__");
293 case OPTION_MAJOR_SUBSYSTEM_VERSION:
294 set_pe_value ("__major_subsystem_version__");
296 case OPTION_MINOR_SUBSYSTEM_VERSION:
297 set_pe_value ("__minor_subsystem_version__");
299 case OPTION_MAJOR_IMAGE_VERSION:
300 set_pe_value ("__major_image_version__");
302 case OPTION_MINOR_IMAGE_VERSION:
303 set_pe_value ("__minor_image_version__");
305 case OPTION_FILE_ALIGNMENT:
306 set_pe_value ("__file_alignment__");
308 case OPTION_SECTION_ALIGNMENT:
309 set_pe_value ("__section_alignment__");
312 set_pe_name ("__dll__", 1);
314 case OPTION_IMAGE_BASE:
315 set_pe_value ("__image_base__");
321 /* Assign values to the special symbols before the linker script is
325 gld_${EMULATION_NAME}_set_symbols (void)
327 /* Run through and invent symbols for all the
328 names and insert the defaults. */
331 if (!init[IMAGEBASEOFF].inited)
333 if (bfd_link_relocatable (&link_info))
334 init[IMAGEBASEOFF].value = 0;
335 else if (init[DLLOFF].value)
336 init[IMAGEBASEOFF].value = BEOS_DLL_IMAGE_BASE;
338 init[IMAGEBASEOFF].value = BEOS_EXE_IMAGE_BASE;
341 /* Don't do any symbol assignments if this is a relocatable link. */
342 if (bfd_link_relocatable (&link_info))
345 /* Glue the assignments into the abs section */
346 push_stat_ptr (&abs_output_section->children);
348 for (j = 0; init[j].ptr; j++)
350 long val = init[j].value;
351 lang_add_assignment (exp_assign (init[j].symbol, exp_intop (val),
353 if (init[j].size == sizeof(short))
354 *(short *)init[j].ptr = val;
355 else if (init[j].size == sizeof(int))
356 *(int *)init[j].ptr = val;
357 else if (init[j].size == sizeof(long))
358 *(long *)init[j].ptr = val;
359 /* This might be a long long or other special type. */
360 else if (init[j].size == sizeof(bfd_vma))
361 *(bfd_vma *)init[j].ptr = val;
364 /* Restore the pointer. */
367 if (pe.FileAlignment >
370 einfo (_("%P: warning, file alignment > section alignment\n"));
375 gld_${EMULATION_NAME}_after_open (void)
377 after_open_default ();
379 /* Pass the wacky PE command line options into the output bfd.
380 FIXME: This should be done via a function, rather than by
381 including an internal BFD header. */
382 if (!coff_data(link_info.output_bfd)->pe)
384 einfo (_("%F%P: PE operations on non PE file\n"));
387 pe_data(link_info.output_bfd)->pe_opthdr = pe;
388 pe_data(link_info.output_bfd)->dll = init[DLLOFF].value;
392 /* Callback functions for qsort in sort_sections. */
395 sort_by_file_name (const void *a, const void *b)
397 const lang_input_section_type *const *ra = a;
398 const lang_input_section_type *const *rb = b;
399 asection *sa = (*ra)->section;
400 asection *sb = (*rb)->section;
403 i = filename_cmp (sa->owner->my_archive->filename,
404 sb->owner->my_archive->filename);
408 i = filename_cmp (sa->owner->filename, sb->owner->filename);
411 /* the tail idata4/5 are the only ones without relocs to an
412 idata$6 section unless we are importing by ordinal,
413 so sort them to last to terminate the IAT
414 and HNT properly. if no reloc this one is import by ordinal
415 so we have to sort by section contents */
417 if (sa->reloc_count + sb->reloc_count != 0)
419 i = sa->reloc_count > sb->reloc_count ? -1 : 0;
423 return sa->reloc_count > sb->reloc_count ? 0 : 1;
427 /* don't sort .idata$6 or .idata$7 FIXME dlltool eliminate .idata$7 */
428 if ((strcmp (sa->name, ".idata$6") == 0))
431 if (!bfd_get_section_contents (sa->owner, sa, &a_sec, (file_ptr) 0,
432 (bfd_size_type) sizeof (a_sec)))
433 einfo (_("%F%P: %pB: can't read contents of section .idata: %E\n"),
436 if (!bfd_get_section_contents (sb->owner, sb, &b_sec, (file_ptr) 0,
437 (bfd_size_type) sizeof (b_sec)))
438 einfo (_("%F%P: %pB: can't read contents of section .idata: %E\n"),
441 i = a_sec < b_sec ? -1 : 0;
444 return a_sec < b_sec ? 0 : 1;
450 sort_by_section_name (const void *a, const void *b)
452 const lang_input_section_type *const *ra = a;
453 const lang_input_section_type *const *rb = b;
454 const char *sna = (*ra)->section->name;
455 const char *snb = (*rb)->section->name;
457 i = strcmp (sna, snb);
458 /* This is a hack to make .stab and .stabstr last, so we don't have
459 to fix strip/objcopy for .reloc sections.
460 FIXME stripping images with a .rsrc section still needs to be fixed. */
463 if ((CONST_STRNEQ (sna, ".stab"))
464 && (!CONST_STRNEQ (snb, ".stab")))
470 /* Subroutine of sort_sections to a contiguous subset of a list of sections.
471 NEXT_AFTER is the element after the last one to sort.
472 The result is a pointer to the last element's "next" pointer. */
474 static lang_statement_union_type **
475 sort_sections_1 (lang_statement_union_type **startptr,
476 lang_statement_union_type *next_after,
478 int (*sort_func) (const void *, const void *))
480 lang_statement_union_type **vec;
481 lang_statement_union_type *p;
483 lang_statement_union_type **ret;
488 vec = ((lang_statement_union_type **)
489 xmalloc (count * sizeof (lang_statement_union_type *)));
491 for (p = *startptr, i = 0; i < count; i++, p = p->header.next)
494 qsort (vec, count, sizeof (vec[0]), sort_func);
496 /* Fill in the next pointers again. */
498 for (i = 0; i < count - 1; i++)
499 vec[i]->header.next = vec[i + 1];
500 vec[i]->header.next = next_after;
501 ret = &vec[i]->header.next;
506 /* Sort the .idata\$foo input sections of archives into filename order.
507 The reason is so dlltool can arrange to have the pe dll import information
508 generated correctly - the head of the list goes into dh.o, the tail into
509 dt.o, and the guts into ds[nnnn].o. Note that this is only needed for the
511 FIXME: This may no longer be necessary with grouped sections. Instead of
512 sorting on dh.o, ds[nnnn].o, dt.o, one could, for example, have dh.o use
513 .idata\$4h, have ds[nnnn].o use .idata\$4s[nnnn], and have dt.o use .idata\$4t.
514 This would have to be elaborated upon to handle multiple dll's
515 [assuming such an eloboration is possible of course].
517 We also sort sections in '\$' wild statements. These are created by the
518 place_orphans routine to implement grouped sections. */
521 sort_sections (lang_statement_union_type *s)
523 for (; s ; s = s->header.next)
524 switch (s->header.type)
526 case lang_output_section_statement_enum:
527 sort_sections (s->output_section_statement.children.head);
529 case lang_wild_statement_enum:
531 lang_statement_union_type **p = &s->wild_statement.children.head;
532 struct wildcard_list *sec;
534 for (sec = s->wild_statement.section_list; sec; sec = sec->next)
536 /* Is this the .idata section? */
537 if (sec->spec.name != NULL
538 && CONST_STRNEQ (sec->spec.name, ".idata"))
540 /* Sort the children. We want to sort any objects in
541 the same archive. In order to handle the case of
542 including a single archive multiple times, we sort
543 all the children by archive name and then by object
544 name. After sorting them, we re-thread the pointer
549 lang_statement_union_type *start = *p;
550 if (start->header.type != lang_input_section_enum
551 || !start->input_section.section->owner->my_archive)
552 p = &(start->header.next);
555 lang_statement_union_type *end;
558 for (end = start, count = 0;
559 end && (end->header.type
560 == lang_input_section_enum);
561 end = end->header.next)
564 p = sort_sections_1 (p, end, count,
571 /* If this is a collection of grouped sections, sort them.
572 The linker script must explicitly mention "*(.foo\$)" or
573 "*(.foo\$*)". Don't sort them if \$ is not the last
574 character (not sure if this is really useful, but it
575 allows explicitly mentioning some \$ sections and letting
576 the linker handle the rest). */
577 if (sec->spec.name != NULL)
579 char *q = strchr (sec->spec.name, '\$');
583 || (q[1] == '*' && q[2] == '\0')))
585 lang_statement_union_type *end;
588 for (end = *p, count = 0; end; end = end->header.next)
590 if (end->header.type != lang_input_section_enum)
594 (void) sort_sections_1 (p, end, count,
595 sort_by_section_name);
608 gld_${EMULATION_NAME}_before_allocation (void)
610 #ifdef TARGET_IS_ppcpe
611 /* Here we rummage through the found bfds to collect toc information */
613 LANG_FOR_EACH_INPUT_STATEMENT (is)
615 if (!ppc_process_before_allocation(is->the_bfd, &link_info))
617 einfo (_("%P: errors encountered processing file %s\n"),
623 /* We have seen it all. Allocate it, and carry on */
624 ppc_allocate_toc_section (&link_info);
626 #ifdef TARGET_IS_armpe
627 /* FIXME: we should be able to set the size of the interworking stub
630 Here we rummage through the found bfds to collect glue
631 information. FIXME: should this be based on a command line
632 option? krk@cygnus.com */
634 LANG_FOR_EACH_INPUT_STATEMENT (is)
636 if (!arm_process_before_allocation (is->the_bfd, & link_info))
638 einfo (_("%P: errors encountered processing file %s\n"),
644 /* We have seen it all. Allocate it, and carry on */
645 arm_allocate_interworking_sections (& link_info);
646 #endif /* TARGET_IS_armpe */
647 #endif /* TARGET_IS_ppcpe */
649 sort_sections (stat_ptr->head);
651 before_allocation_default ();
654 /* Place an orphan section. We use this to put sections with a '\$' in them
655 into the right place. Any section with a '\$' in them (e.g. .text\$foo)
656 gets mapped to the output section with everything from the '\$' on stripped
658 See the Microsoft Portable Executable and Common Object File Format
659 Specification 4.1, section 4.2, Grouped Sections.
661 FIXME: This is now handled by the linker script using wildcards,
662 but I'm leaving this here in case we want to enable it for sections
663 which are not mentioned in the linker script. */
665 static lang_output_section_statement_type *
666 gld${EMULATION_NAME}_place_orphan (asection *s,
670 char *output_secname, *ps;
671 lang_output_section_statement_type *os;
672 lang_statement_union_type *l;
674 if ((s->flags & SEC_ALLOC) == 0)
677 /* Don't process grouped sections unless doing a final link.
678 If they're marked as COMDAT sections, we don't want .text\$foo to
679 end up in .text and then have .text disappear because it's marked
680 link-once-discard. */
681 if (bfd_link_relocatable (&link_info))
684 /* Everything from the '\$' on gets deleted so don't allow '\$' as the
686 if (*secname == '\$')
687 einfo (_("%F%P: section %s has '\$' as first character\n"), secname);
688 if (strchr (secname + 1, '\$') == NULL)
691 /* Look up the output section. The Microsoft specs say sections names in
692 image files never contain a '\$'. Fortunately, lang_..._lookup creates
693 the section if it doesn't exist. */
694 output_secname = xstrdup (secname);
695 ps = strchr (output_secname + 1, '\$');
697 os = lang_output_section_statement_lookup (output_secname, constraint, TRUE);
699 /* Find the '\$' wild statement for this section. We currently require the
700 linker script to explicitly mention "*(.foo\$)".
701 FIXME: ppcpe.sc has .CRT\$foo in the .rdata section. According to the
702 Microsoft docs this isn't correct so it's not (currently) handled. */
706 for (l = os->children.head; l; l = l->header.next)
707 if (l->header.type == lang_wild_statement_enum)
709 struct wildcard_list *sec;
711 for (sec = l->wild_statement.section_list; sec; sec = sec->next)
712 if (sec->spec.name && strcmp (sec->spec.name, output_secname) == 0)
719 einfo (_("%F%P: *(%s\$) missing from linker script\n"), output_secname);
721 /* Link the input section in and we're done for now.
722 The sections still have to be sorted, but that has to wait until
723 all such sections have been processed by us. The sorting is done by
725 lang_add_section (&l->wild_statement.children, s, NULL, os);
731 gld_${EMULATION_NAME}_get_script (int *isfile)
733 # Scripts compiled in.
734 # sed commands to quote an ld script as a C string.
735 sc="-f stringify.sed"
741 if (bfd_link_relocatable (&link_info) && config.build_constructors)
744 sed $sc ldscripts/${EMULATION_NAME}.xu >> e${EMULATION_NAME}.c
745 echo ' ; else if (bfd_link_relocatable (&link_info)) return' >> e${EMULATION_NAME}.c
746 sed $sc ldscripts/${EMULATION_NAME}.xr >> e${EMULATION_NAME}.c
747 echo ' ; else if (!config.text_read_only) return' >> e${EMULATION_NAME}.c
748 sed $sc ldscripts/${EMULATION_NAME}.xbn >> e${EMULATION_NAME}.c
749 echo ' ; else if (!config.magic_demand_paged) return' >> e${EMULATION_NAME}.c
750 sed $sc ldscripts/${EMULATION_NAME}.xn >> e${EMULATION_NAME}.c
751 echo ' ; else return' >> e${EMULATION_NAME}.c
752 sed $sc ldscripts/${EMULATION_NAME}.x >> e${EMULATION_NAME}.c
753 echo '; }' >> e${EMULATION_NAME}.c
758 struct ld_emulation_xfer_struct ld_${EMULATION_NAME}_emulation =
760 gld_${EMULATION_NAME}_before_parse,
764 gld_${EMULATION_NAME}_after_open,
765 after_check_relocs_default,
766 before_place_orphans_default,
767 after_allocation_default,
768 set_output_arch_default,
769 ldemul_default_target,
770 gld_${EMULATION_NAME}_before_allocation,
771 gld_${EMULATION_NAME}_get_script,
775 NULL, /* create output section statements */
776 NULL, /* open dynamic archive */
777 gld${EMULATION_NAME}_place_orphan,
778 gld_${EMULATION_NAME}_set_symbols,
779 NULL, /* parse_args */
780 gld${EMULATION_NAME}_add_options,
781 gld${EMULATION_NAME}_handle_option,
782 NULL, /* unrecognized file */
783 NULL, /* list options */
784 NULL, /* recognized file */
785 NULL, /* find_potential_libraries */
786 NULL, /* new_vers_pattern */
787 NULL, /* extra_map_file_text */
788 ${LDEMUL_EMIT_CTF_EARLY-NULL},
789 ${LDEMUL_EXAMINE_STRTAB_FOR_CTF-NULL}