* emultempl/spuelf.em (spu_elf_relink): Correct --no-auto-overlay arg.
[binutils-gdb.git] / ld / emultempl / spuelf.em
1 # This shell script emits a C file. -*- C -*-
2 # Copyright 2006, 2007, 2008 Free Software Foundation, Inc.
3 #
4 # This file is part of the GNU Binutils.
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
8 # the Free Software Foundation; either version 3 of the License, or
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
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.
20 #
21
22 # This file is sourced from elf32.em, and defines extra spu specific
23 # features.
24 #
25 fragment <<EOF
26 #include "ldctor.h"
27 #include "elf32-spu.h"
28
29 /* Non-zero if no overlay processing should be done. */
30 static int no_overlays = 0;
31
32 /* Non-zero if we want stubs on all calls out of overlay regions. */
33 static int non_overlay_stubs = 0;
34
35 /* Whether to emit symbols for stubs. */
36 static int emit_stub_syms = 0;
37
38 /* Non-zero to perform stack space analysis. */
39 static int stack_analysis = 0;
40
41 /* Whether to emit symbols with stack requirements for each function. */
42 static int emit_stack_syms = 0;
43
44 /* Range of valid addresses for loadable sections. */
45 static bfd_vma local_store_lo = 0;
46 static bfd_vma local_store_hi = 0x3ffff;
47
48 /* Control --auto-overlay feature. */
49 static int auto_overlay = 0;
50 static char *auto_overlay_file = 0;
51 static unsigned int auto_overlay_fixed = 0;
52 static unsigned int auto_overlay_reserved = 0;
53 int my_argc;
54 char **my_argv;
55
56 static const char ovl_mgr[] = {
57 EOF
58
59 ../binutils/bin2c < ${srcdir}/emultempl/spu_ovl.o >> e${EMULATION_NAME}.c
60
61 fragment <<EOF
62 };
63
64 static const struct _ovl_stream ovl_mgr_stream = {
65 ovl_mgr,
66 ovl_mgr + sizeof (ovl_mgr)
67 };
68
69
70 static int
71 is_spu_target (void)
72 {
73 extern const bfd_target bfd_elf32_spu_vec;
74
75 return link_info.output_bfd->xvec == &bfd_elf32_spu_vec;
76 }
77
78 /* Create our note section. */
79
80 static void
81 spu_after_open (void)
82 {
83 if (is_spu_target ()
84 && !link_info.relocatable
85 && link_info.input_bfds != NULL
86 && !spu_elf_create_sections (&link_info,
87 stack_analysis, emit_stack_syms))
88 einfo ("%X%P: can not create note section: %E\n");
89
90 gld${EMULATION_NAME}_after_open ();
91 }
92
93 /* If O is NULL, add section S at the end of output section OUTPUT_NAME.
94 If O is not NULL, add section S at the beginning of output section O.
95
96 Really, we should be duplicating ldlang.c map_input_to_output_sections
97 logic here, ie. using the linker script to find where the section
98 goes. That's rather a lot of code, and we don't want to run
99 map_input_to_output_sections again because most sections are already
100 mapped. So cheat, and put the section in a fixed place, ignoring any
101 attempt via a linker script to put .stub, .ovtab, and built-in
102 overlay manager code somewhere else. */
103
104 static void
105 spu_place_special_section (asection *s, asection *o, const char *output_name)
106 {
107 lang_output_section_statement_type *os;
108
109 os = lang_output_section_find (o != NULL ? o->name : output_name);
110 if (os == NULL)
111 {
112 const char *save = s->name;
113 s->name = output_name;
114 gld${EMULATION_NAME}_place_orphan (s);
115 s->name = save;
116 }
117 else if (o != NULL && os->children.head != NULL)
118 {
119 lang_statement_list_type add;
120
121 lang_list_init (&add);
122 lang_add_section (&add, s, os);
123 *add.tail = os->children.head;
124 os->children.head = add.head;
125 }
126 else
127 lang_add_section (&os->children, s, os);
128
129 s->output_section->size += s->size;
130 }
131
132 /* Load built-in overlay manager, and tweak overlay section alignment. */
133
134 static void
135 spu_elf_load_ovl_mgr (void)
136 {
137 lang_output_section_statement_type *os;
138 struct elf_link_hash_entry *h;
139
140 h = elf_link_hash_lookup (elf_hash_table (&link_info),
141 "__ovly_load", FALSE, FALSE, FALSE);
142
143 if (h != NULL
144 && (h->root.type == bfd_link_hash_defined
145 || h->root.type == bfd_link_hash_defweak)
146 && h->def_regular)
147 {
148 /* User supplied __ovly_load. */
149 }
150 else if (ovl_mgr_stream.start == ovl_mgr_stream.end)
151 einfo ("%F%P: no built-in overlay manager\n");
152 else
153 {
154 lang_input_statement_type *ovl_is;
155
156 ovl_is = lang_add_input_file ("builtin ovl_mgr",
157 lang_input_file_is_file_enum,
158 NULL);
159
160 if (!spu_elf_open_builtin_lib (&ovl_is->the_bfd, &ovl_mgr_stream))
161 einfo ("%X%P: can not open built-in overlay manager: %E\n");
162 else
163 {
164 asection *in;
165
166 if (!load_symbols (ovl_is, NULL))
167 einfo ("%X%P: can not load built-in overlay manager: %E\n");
168
169 /* Map overlay manager sections to output sections. */
170 for (in = ovl_is->the_bfd->sections; in != NULL; in = in->next)
171 if ((in->flags & (SEC_ALLOC | SEC_LOAD))
172 == (SEC_ALLOC | SEC_LOAD))
173 spu_place_special_section (in, NULL, ".text");
174 }
175 }
176
177 /* Ensure alignment of overlay sections is sufficient. */
178 for (os = &lang_output_section_statement.head->output_section_statement;
179 os != NULL;
180 os = os->next)
181 if (os->bfd_section != NULL
182 && spu_elf_section_data (os->bfd_section) != NULL
183 && spu_elf_section_data (os->bfd_section)->u.o.ovl_index != 0)
184 {
185 if (os->bfd_section->alignment_power < 4)
186 os->bfd_section->alignment_power = 4;
187
188 /* Also ensure size rounds up. */
189 os->block_value = 16;
190 }
191 }
192
193 /* Go find if we need to do anything special for overlays. */
194
195 static void
196 spu_before_allocation (void)
197 {
198 if (is_spu_target ()
199 && !link_info.relocatable
200 && !no_overlays)
201 {
202 /* Size the sections. This is premature, but we need to know the
203 rough layout so that overlays can be found. */
204 expld.phase = lang_mark_phase_enum;
205 expld.dataseg.phase = exp_dataseg_none;
206 one_lang_size_sections_pass (NULL, TRUE);
207
208 /* Find overlays by inspecting section vmas. */
209 if (spu_elf_find_overlays (&link_info))
210 {
211 int ret;
212
213 if (auto_overlay != 0)
214 {
215 einfo ("%P: --auto-overlay ignored with user overlay script\n");
216 auto_overlay = 0;
217 }
218
219 ret = spu_elf_size_stubs (&link_info,
220 spu_place_special_section,
221 non_overlay_stubs);
222 if (ret == 0)
223 einfo ("%X%P: can not size overlay stubs: %E\n");
224 else if (ret == 2)
225 spu_elf_load_ovl_mgr ();
226 }
227
228 /* We must not cache anything from the preliminary sizing. */
229 lang_reset_memory_regions ();
230 }
231
232 gld${EMULATION_NAME}_before_allocation ();
233 }
234
235 struct tflist {
236 struct tflist *next;
237 char name[9];
238 };
239
240 static struct tflist *tmp_file_list;
241
242 static void clean_tmp (void)
243 {
244 for (; tmp_file_list != NULL; tmp_file_list = tmp_file_list->next)
245 unlink (tmp_file_list->name);
246 }
247
248 static int
249 new_tmp_file (char **fname)
250 {
251 struct tflist *tf;
252 int fd;
253
254 if (tmp_file_list == NULL)
255 atexit (clean_tmp);
256 tf = xmalloc (sizeof (*tf));
257 tf->next = tmp_file_list;
258 tmp_file_list = tf;
259 memcpy (tf->name, "ldXXXXXX", sizeof (tf->name));
260 *fname = tf->name;
261 #ifdef HAVE_MKSTEMP
262 fd = mkstemp (*fname);
263 #else
264 *fname = mktemp (*fname);
265 if (*fname == NULL)
266 return -1;
267 fd = open (fname, O_RDWR | O_CREAT | O_EXCL, 0600);
268 #endif
269 return fd;
270 }
271
272 static FILE *
273 spu_elf_open_overlay_script (void)
274 {
275 FILE *script = NULL;
276
277 if (auto_overlay_file == NULL)
278 {
279 int fd = new_tmp_file (&auto_overlay_file);
280 if (fd == -1)
281 goto file_err;
282 script = fdopen (fd, "w");
283 }
284 else
285 script = fopen (auto_overlay_file, "w");
286
287 if (script == NULL)
288 {
289 file_err:
290 einfo ("%F%P: can not open script: %E\n");
291 }
292 return script;
293 }
294
295 static void
296 spu_elf_relink (void)
297 {
298 char **argv = xmalloc ((my_argc + 4) * sizeof (*argv));
299
300 memcpy (argv, my_argv, my_argc * sizeof (*argv));
301 argv[my_argc++] = "--no-auto-overlay";
302 if (tmp_file_list->name == auto_overlay_file)
303 argv[my_argc - 1] = concat (argv[my_argc - 1], "=",
304 auto_overlay_file, (const char *) NULL);
305 argv[my_argc++] = "-T";
306 argv[my_argc++] = auto_overlay_file;
307 argv[my_argc] = 0;
308 execvp (argv[0], (char *const *) argv);
309 perror (argv[0]);
310 _exit (127);
311 }
312
313 /* Final emulation specific call. */
314
315 static void
316 gld${EMULATION_NAME}_finish (void)
317 {
318 int need_laying_out;
319
320 need_laying_out = bfd_elf_discard_info (link_info.output_bfd, &link_info);
321
322 gld${EMULATION_NAME}_map_segments (need_laying_out);
323
324 if (is_spu_target ())
325 {
326 if (local_store_lo < local_store_hi)
327 {
328 asection *s;
329
330 s = spu_elf_check_vma (&link_info, auto_overlay,
331 local_store_lo, local_store_hi,
332 auto_overlay_fixed, auto_overlay_reserved,
333 spu_elf_load_ovl_mgr,
334 spu_elf_open_overlay_script,
335 spu_elf_relink);
336 if (s != NULL && !auto_overlay)
337 einfo ("%X%P: %A exceeds local store range\n", s);
338 }
339 else if (auto_overlay)
340 einfo ("%P: --auto-overlay ignored with zero local store range\n");
341
342 if (!spu_elf_build_stubs (&link_info,
343 emit_stub_syms || link_info.emitrelocations))
344 einfo ("%X%P: can not build overlay stubs: %E\n");
345 }
346
347 finish_default ();
348 }
349
350 static char *
351 gld${EMULATION_NAME}_choose_target (int argc, char *argv[])
352 {
353 my_argc = argc;
354 my_argv = argv;
355 return ldemul_default_target (argc, argv);
356 }
357
358 EOF
359
360 if grep -q 'ld_elf.*ppc.*_emulation' ldemul-list.h; then
361 fragment <<EOF
362 #include "filenames.h"
363 #include <fcntl.h>
364 #include <sys/wait.h>
365
366 static const char *
367 base_name (const char *path)
368 {
369 const char *file = strrchr (path, '/');
370 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
371 {
372 char *bslash = strrchr (path, '\\\\');
373
374 if (file == NULL || (bslash != NULL && bslash > file))
375 file = bslash;
376 if (file == NULL
377 && path[0] != '\0'
378 && path[1] == ':')
379 file = path + 1;
380 }
381 #endif
382 if (file == NULL)
383 file = path;
384 else
385 ++file;
386 return file;
387 }
388
389 /* This function is called when building a ppc32 or ppc64 executable
390 to handle embedded spu images. */
391 extern bfd_boolean embedded_spu_file (lang_input_statement_type *, const char *);
392
393 bfd_boolean
394 embedded_spu_file (lang_input_statement_type *entry, const char *flags)
395 {
396 const char *cmd[6];
397 const char *sym;
398 char *handle, *p;
399 char *oname;
400 int fd;
401 pid_t pid;
402 int status;
403 union lang_statement_union **old_stat_tail;
404 union lang_statement_union **old_file_tail;
405 union lang_statement_union *new_ent;
406 lang_input_statement_type *search;
407
408 if (entry->the_bfd->format != bfd_object
409 || strcmp (entry->the_bfd->xvec->name, "elf32-spu") != 0
410 || (entry->the_bfd->tdata.elf_obj_data->elf_header->e_type != ET_EXEC
411 && entry->the_bfd->tdata.elf_obj_data->elf_header->e_type != ET_DYN))
412 return FALSE;
413
414 /* Use the filename as the symbol marking the program handle struct. */
415 sym = base_name (entry->the_bfd->filename);
416
417 handle = xstrdup (sym);
418 for (p = handle; *p; ++p)
419 if (!(ISALNUM (*p) || *p == '$' || *p == '.'))
420 *p = '_';
421
422 fd = new_tmp_file (&oname);
423 if (fd == -1)
424 return FALSE;
425 close (fd);
426
427 for (search = (lang_input_statement_type *) input_file_chain.head;
428 search != NULL;
429 search = (lang_input_statement_type *) search->next_real_file)
430 if (search->filename != NULL)
431 {
432 const char *infile = base_name (search->filename);
433
434 if (strncmp (infile, "crtbegin", 8) == 0)
435 {
436 if (infile[8] == 'S')
437 flags = concat (flags, " -fPIC", (const char *) NULL);
438 else if (infile[8] == 'T')
439 flags = concat (flags, " -fpie", (const char *) NULL);
440 break;
441 }
442 }
443
444 /* Use fork() and exec() rather than system() so that we don't
445 need to worry about quoting args. */
446 cmd[0] = EMBEDSPU;
447 cmd[1] = flags;
448 cmd[2] = handle;
449 cmd[3] = entry->the_bfd->filename;
450 cmd[4] = oname;
451 cmd[5] = NULL;
452 if (trace_file_tries)
453 {
454 info_msg (_("running: %s \"%s\" \"%s\" \"%s\" \"%s\"\n"),
455 cmd[0], cmd[1], cmd[2], cmd[3], cmd[4]);
456 fflush (stdout);
457 }
458
459 pid = fork ();
460 if (pid == -1)
461 return FALSE;
462 if (pid == 0)
463 {
464 execvp (cmd[0], (char *const *) cmd);
465 if (strcmp ("embedspu", EMBEDSPU) != 0)
466 {
467 cmd[0] = "embedspu";
468 execvp (cmd[0], (char *const *) cmd);
469 }
470 perror (cmd[0]);
471 _exit (127);
472 }
473 #ifdef HAVE_WAITPID
474 #define WAITFOR(PID, STAT) waitpid (PID, STAT, 0)
475 #else
476 #define WAITFOR(PID, STAT) wait (STAT)
477 #endif
478 if (WAITFOR (pid, &status) != pid
479 || !WIFEXITED (status)
480 || WEXITSTATUS (status) != 0)
481 return FALSE;
482 #undef WAITFOR
483
484 old_stat_tail = stat_ptr->tail;
485 old_file_tail = input_file_chain.tail;
486 if (lang_add_input_file (oname, lang_input_file_is_file_enum, NULL) == NULL)
487 return FALSE;
488
489 /* lang_add_input_file put the new list entry at the end of the statement
490 and input file lists. Move it to just after the current entry. */
491 new_ent = *old_stat_tail;
492 *old_stat_tail = NULL;
493 stat_ptr->tail = old_stat_tail;
494 *old_file_tail = NULL;
495 input_file_chain.tail = old_file_tail;
496 new_ent->header.next = entry->header.next;
497 entry->header.next = new_ent;
498 new_ent->input_statement.next_real_file = entry->next_real_file;
499 entry->next_real_file = new_ent;
500
501 /* Ensure bfd sections are excluded from the output. */
502 bfd_section_list_clear (entry->the_bfd);
503 entry->loaded = TRUE;
504 return TRUE;
505 }
506
507 EOF
508 fi
509
510 # Define some shell vars to insert bits of code into the standard elf
511 # parse_args and list_options functions.
512 #
513 PARSE_AND_LIST_PROLOGUE='
514 #define OPTION_SPU_PLUGIN 301
515 #define OPTION_SPU_NO_OVERLAYS (OPTION_SPU_PLUGIN + 1)
516 #define OPTION_SPU_STUB_SYMS (OPTION_SPU_NO_OVERLAYS + 1)
517 #define OPTION_SPU_NON_OVERLAY_STUBS (OPTION_SPU_STUB_SYMS + 1)
518 #define OPTION_SPU_LOCAL_STORE (OPTION_SPU_NON_OVERLAY_STUBS + 1)
519 #define OPTION_SPU_STACK_ANALYSIS (OPTION_SPU_LOCAL_STORE + 1)
520 #define OPTION_SPU_STACK_SYMS (OPTION_SPU_STACK_ANALYSIS + 1)
521 #define OPTION_SPU_AUTO_OVERLAY (OPTION_SPU_STACK_SYMS + 1)
522 #define OPTION_SPU_AUTO_RELINK (OPTION_SPU_AUTO_OVERLAY + 1)
523 #define OPTION_SPU_OVERLAY_RODATA (OPTION_SPU_AUTO_RELINK + 1)
524 #define OPTION_SPU_FIXED_SPACE (OPTION_SPU_OVERLAY_RODATA + 1)
525 #define OPTION_SPU_RESERVED_SPACE (OPTION_SPU_FIXED_SPACE + 1)
526 #define OPTION_SPU_NO_AUTO_OVERLAY (OPTION_SPU_RESERVED_SPACE + 1)
527 '
528
529 PARSE_AND_LIST_LONGOPTS='
530 { "plugin", no_argument, NULL, OPTION_SPU_PLUGIN },
531 { "no-overlays", no_argument, NULL, OPTION_SPU_NO_OVERLAYS },
532 { "emit-stub-syms", no_argument, NULL, OPTION_SPU_STUB_SYMS },
533 { "extra-overlay-stubs", no_argument, NULL, OPTION_SPU_NON_OVERLAY_STUBS },
534 { "local-store", required_argument, NULL, OPTION_SPU_LOCAL_STORE },
535 { "stack-analysis", no_argument, NULL, OPTION_SPU_STACK_ANALYSIS },
536 { "emit-stack-syms", no_argument, NULL, OPTION_SPU_STACK_SYMS },
537 { "auto-overlay", optional_argument, NULL, OPTION_SPU_AUTO_OVERLAY },
538 { "auto-relink", no_argument, NULL, OPTION_SPU_AUTO_RELINK },
539 { "overlay-rodata", no_argument, NULL, OPTION_SPU_OVERLAY_RODATA },
540 { "fixed-space", required_argument, NULL, OPTION_SPU_FIXED_SPACE },
541 { "reserved-space", required_argument, NULL, OPTION_SPU_RESERVED_SPACE },
542 { "no-auto-overlay", optional_argument, NULL, OPTION_SPU_NO_AUTO_OVERLAY },
543 '
544
545 PARSE_AND_LIST_OPTIONS='
546 fprintf (file, _("\
547 --plugin Make SPU plugin.\n\
548 --no-overlays No overlay handling.\n\
549 --emit-stub-syms Add symbols on overlay call stubs.\n\
550 --extra-overlay-stubs Add stubs on all calls out of overlay regions.\n\
551 --local-store=lo:hi Valid address range.\n\
552 --stack-analysis Estimate maximum stack requirement.\n\
553 --emit-stack-syms Add sym giving stack needed for each func.\n\
554 --auto-overlay [=filename] Create an overlay script in filename if\n\
555 executable does not fit in local store.\n\
556 --auto-relink Rerun linker using auto-overlay script.\n\
557 --overlay-rodata Place read-only data with associated function\n\
558 code in overlays.\n\
559 --fixed-space=bytes Local store for non-overlay code and data.\n\
560 --reserved-space=bytes Local store for stack and heap.\n"
561 ));
562 '
563
564 PARSE_AND_LIST_ARGS_CASES='
565 case OPTION_SPU_PLUGIN:
566 spu_elf_plugin (1);
567 break;
568
569 case OPTION_SPU_NO_OVERLAYS:
570 no_overlays = 1;
571 break;
572
573 case OPTION_SPU_STUB_SYMS:
574 emit_stub_syms = 1;
575 break;
576
577 case OPTION_SPU_NON_OVERLAY_STUBS:
578 non_overlay_stubs = 1;
579 break;
580
581 case OPTION_SPU_LOCAL_STORE:
582 {
583 char *end;
584 local_store_lo = strtoul (optarg, &end, 0);
585 if (*end == '\'':'\'')
586 {
587 local_store_hi = strtoul (end + 1, &end, 0);
588 if (*end == 0)
589 break;
590 }
591 einfo (_("%P%F: invalid --local-store address range `%s'\''\n"), optarg);
592 }
593 break;
594
595 case OPTION_SPU_STACK_ANALYSIS:
596 stack_analysis = 1;
597 break;
598
599 case OPTION_SPU_STACK_SYMS:
600 emit_stack_syms = 1;
601 break;
602
603 case OPTION_SPU_AUTO_OVERLAY:
604 auto_overlay |= 1;
605 if (optarg != NULL)
606 {
607 auto_overlay_file = optarg;
608 break;
609 }
610 /* Fall thru */
611
612 case OPTION_SPU_AUTO_RELINK:
613 auto_overlay |= 2;
614 break;
615
616 case OPTION_SPU_OVERLAY_RODATA:
617 auto_overlay |= 4;
618 break;
619
620 case OPTION_SPU_FIXED_SPACE:
621 {
622 char *end;
623 auto_overlay_fixed = strtoul (optarg, &end, 0);
624 if (*end != 0)
625 einfo (_("%P%F: invalid --fixed-space value `%s'\''\n"), optarg);
626 }
627 break;
628
629 case OPTION_SPU_RESERVED_SPACE:
630 {
631 char *end;
632 auto_overlay_reserved = strtoul (optarg, &end, 0);
633 if (*end != 0)
634 einfo (_("%P%F: invalid --reserved-space value `%s'\''\n"), optarg);
635 }
636 break;
637
638 case OPTION_SPU_NO_AUTO_OVERLAY:
639 auto_overlay = 0;
640 if (optarg != NULL)
641 {
642 struct tflist *tf;
643 size_t len;
644
645 if (tmp_file_list == NULL)
646 atexit (clean_tmp);
647
648 len = strlen (optarg) + 1;
649 tf = xmalloc (sizeof (*tf) - sizeof (tf->name) + len);
650 memcpy (tf->name, optarg, len);
651 tf->next = tmp_file_list;
652 tmp_file_list = tf;
653 break;
654 }
655 break;
656 '
657
658 LDEMUL_AFTER_OPEN=spu_after_open
659 LDEMUL_BEFORE_ALLOCATION=spu_before_allocation
660 LDEMUL_FINISH=gld${EMULATION_NAME}_finish
661 LDEMUL_CHOOSE_TARGET=gld${EMULATION_NAME}_choose_target