1 /* script-c.h -- C interface for linker scripts in gold. */
3 /* Copyright (C) 2006-2015 Free Software Foundation, Inc.
4 Written by Ian Lance Taylor <iant@google.com>.
6 This file is part of gold.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 MA 02110-1301, USA. */
23 /* This file exists so that both the bison parser and script.cc can
24 include it, so that they can communicate back and forth. */
26 #ifndef GOLD_SCRIPT_C_H
27 #define GOLD_SCRIPT_C_H
36 // For the C++ code we declare the various supporting structures in
37 // the gold namespace. For the C code we declare it at the top level.
38 // The namespace level should not affect the layout of the structure.
44 /* A string value for the bison parser. */
52 /* The expression functions deal with pointers to Expression objects.
53 Since the bison parser generates C code, this is a hack to keep the
54 C++ code type safe. This hacks assumes that all pointers look
59 typedef Expression* Expression_ptr;
61 typedef void* Expression_ptr;
64 /* Script_section type. */
65 enum Script_section_type
67 /* No section type. */
68 SCRIPT_SECTION_TYPE_NONE,
69 SCRIPT_SECTION_TYPE_NOLOAD,
70 SCRIPT_SECTION_TYPE_DSECT,
71 SCRIPT_SECTION_TYPE_COPY,
72 SCRIPT_SECTION_TYPE_INFO,
73 SCRIPT_SECTION_TYPE_OVERLAY
76 /* A constraint for whether to use a particular output section
79 enum Section_constraint
83 /* Only if all input sections are read-only. */
84 CONSTRAINT_ONLY_IF_RO,
85 /* Only if at least input section is writable. */
86 CONSTRAINT_ONLY_IF_RW,
87 /* Special constraint. */
91 /* The information we store for an output section header in the bison
94 struct Parser_output_section_header
96 /* The address. This may be NULL. */
97 Expression_ptr address;
98 /* Section type. May be NULL string. */
99 enum Script_section_type section_type;
100 /* The load address, from the AT specifier. This may be NULL. */
101 Expression_ptr load_address;
102 /* The alignment, from the ALIGN specifier. This may be NULL. */
103 Expression_ptr align;
104 /* The input section alignment, from the SUBALIGN specifier. This
106 Expression_ptr subalign;
107 /* A constraint on this output section. */
108 enum Section_constraint constraint;
111 /* We keep vectors of strings. In order to manage this in both C and
112 C++, we use a pointer to a vector. This assumes that all pointers
116 typedef std::vector<std::string> String_list;
117 typedef String_list* String_list_ptr;
119 typedef void* String_list_ptr;
122 /* The information we store for an output section trailer in the bison
125 struct Parser_output_section_trailer
127 /* The fill value. This may be NULL. */
129 /* The program segments this section should go into. This may be
131 String_list_ptr phdrs;
134 /* The different sorts we can find in a linker script. */
139 SORT_WILDCARD_BY_NAME,
140 SORT_WILDCARD_BY_ALIGNMENT,
141 SORT_WILDCARD_BY_NAME_BY_ALIGNMENT,
142 SORT_WILDCARD_BY_ALIGNMENT_BY_NAME
145 /* The information we build for a single wildcard specification. */
147 struct Wildcard_section
149 /* The wildcard spec itself. */
150 struct Parser_string name;
151 /* How the entries should be sorted. */
152 enum Sort_wildcard sort;
155 /* A vector of Wildcard_section entries. */
158 typedef std::vector<Wildcard_section> String_sort_list;
159 typedef String_sort_list* String_sort_list_ptr;
161 typedef void* String_sort_list_ptr;
164 /* A list of wildcard specifications, which may include EXCLUDE_FILE
167 struct Wildcard_sections
169 /* Wildcard specs. */
170 String_sort_list_ptr sections;
172 String_list_ptr exclude;
175 /* A complete input section specification. */
177 struct Input_section_spec
180 struct Wildcard_section file;
181 /* The list of sections. */
182 struct Wildcard_sections input_sections;
185 /* Information for a program header. */
189 /* A boolean value: whether to include the file header. */
190 int includes_filehdr;
191 /* A boolean value: whether to include the program headers. */
193 /* A boolean value: whether the flags field is valid. */
195 /* The value to use for the flags. */
197 /* The load address. */
198 Expression_ptr load_address;
201 struct Version_dependency_list;
202 struct Version_expression_list;
209 /* The bison parser definitions. */
211 #include "yyscript.h"
213 /* The bison parser function. */
216 yyparse(void* closure);
218 /* Called by the bison parser skeleton to return the next token. */
221 yylex(YYSTYPE*, void* closure);
223 /* Called by the bison parser skeleton to report an error. */
226 yyerror(void* closure, const char*);
228 /* Called by the bison parser to add an external symbol (a symbol in
229 an EXTERN declaration) to the link. */
232 script_add_extern(void* closure, const char*, size_t);
234 /* Called by the bison parser to add a file to the link. */
237 script_add_file(void* closure, const char*, size_t);
239 /* Called by the bison parser to add a library to the link. */
242 script_add_library(void* closure, const char*, size_t);
244 /* Called by the bison parser to start and stop a group. */
247 script_start_group(void* closure);
249 script_end_group(void* closure);
251 /* Called by the bison parser to start and end an AS_NEEDED list. */
254 script_start_as_needed(void* closure);
256 script_end_as_needed(void* closure);
258 /* Called by the bison parser to set the entry symbol. */
261 script_set_entry(void* closure, const char*, size_t);
263 /* Called by the bison parser to set whether to define common symbols. */
266 script_set_common_allocation(void* closure, int);
268 /* Called by the bison parser to parse an OPTION. */
271 script_parse_option(void* closure, const char*, size_t);
273 /* Called by the bison parser to handle OUTPUT_FORMAT. This return 0
274 if the parse should be aborted. */
277 script_check_output_format(void* closure, const char*, size_t,
278 const char*, size_t, const char*, size_t);
280 /* Called by the bison parser to handle TARGET. */
282 script_set_target(void* closure, const char*, size_t);
284 /* Called by the bison parser to handle SEARCH_DIR. */
287 script_add_search_dir(void* closure, const char*, size_t);
289 /* Called by the bison parser to push the lexer into expression
293 script_push_lex_into_expression_mode(void* closure);
295 /* Called by the bison parser to push the lexer into version
299 script_push_lex_into_version_mode(void* closure);
301 /* Called by the bison parser to pop the lexer mode. */
304 script_pop_lex_mode(void* closure);
306 /* Called by the bison parser to get the value of a symbol. This is
307 called for a reference to a symbol, but is not called for something
308 like "sym += 10". Uses of the special symbol "." can just call
309 script_exp_string. */
311 extern Expression_ptr
312 script_symbol(void* closure, const char*, size_t);
314 /* Called by the bison parser to set a symbol to a value. PROVIDE is
315 non-zero if the symbol should be provided--only defined if there is
316 an undefined reference. HIDDEN is non-zero if the symbol should be
320 script_set_symbol(void* closure, const char*, size_t, Expression_ptr,
321 int provide, int hidden);
323 /* Called by the bison parser to add an assertion. */
326 script_add_assertion(void* closure, Expression_ptr, const char* message,
329 /* Called by the bison parser to start a SECTIONS clause. */
332 script_start_sections(void* closure);
334 /* Called by the bison parser to finish a SECTIONS clause. */
337 script_finish_sections(void* closure);
339 /* Called by the bison parser to start handling input section
340 specifications for an output section. */
343 script_start_output_section(void* closure, const char* name, size_t namelen,
344 const struct Parser_output_section_header*);
346 /* Called by the bison parser when done handling input section
347 specifications for an output section. */
350 script_finish_output_section(void* closure,
351 const struct Parser_output_section_trailer*);
353 /* Called by the bison parser to handle a data statement (LONG, BYTE,
354 etc.) in an output section. */
357 script_add_data(void* closure, int data_token, Expression_ptr val);
359 /* Called by the bison parser to set the fill value in an output
363 script_add_fill(void* closure, Expression_ptr val);
365 /* Called by the bison parser to add an input section specification to
366 an output section. The KEEP parameter is non-zero if this is
367 within a KEEP clause, meaning that the garbage collector should not
371 script_add_input_section(void* closure, const struct Input_section_spec*,
374 /* Create a new list of string and sort entries. */
376 extern String_sort_list_ptr
377 script_new_string_sort_list(const struct Wildcard_section*);
379 /* Add an entry to a list of string and sort entries. */
381 extern String_sort_list_ptr
382 script_string_sort_list_add(String_sort_list_ptr,
383 const struct Wildcard_section*);
385 /* Create a new list of strings. */
387 extern String_list_ptr
388 script_new_string_list(const char*, size_t);
390 /* Add an element to a list of strings. */
392 extern String_list_ptr
393 script_string_list_push_back(String_list_ptr, const char*, size_t);
395 /* Concatenate two string lists. */
397 extern String_list_ptr
398 script_string_list_append(String_list_ptr, String_list_ptr);
400 /* Define a new program header. */
403 script_add_phdr(void* closure, const char* name, size_t namelen,
404 unsigned int type, const struct Phdr_info*);
406 /* Convert a program header string to a type. */
409 script_phdr_string_to_type(void* closure, const char*, size_t);
411 /* Handle DATA_SEGMENT_ALIGN and DATA_SEGMENT_RELRO_END. */
414 script_data_segment_align(void* closure);
417 script_data_segment_relro_end(void* closure);
419 /* Record the fact that a SEGMENT_START expression is seen. */
422 script_saw_segment_start_expression(void* closure);
424 /* Called by the bison parser for MEMORY regions. */
427 script_add_memory(void*, const char*, size_t, unsigned int,
428 Expression_ptr, Expression_ptr);
431 script_parse_memory_attr(void*, const char*, size_t, int);
434 script_set_section_region(void*, const char*, size_t, int);
437 script_include_directive(void *, const char*, size_t);
439 /* Called by the bison parser for expressions. */
441 extern Expression_ptr
442 script_exp_unary_minus(Expression_ptr);
443 extern Expression_ptr
444 script_exp_unary_logical_not(Expression_ptr);
445 extern Expression_ptr
446 script_exp_unary_bitwise_not(Expression_ptr);
447 extern Expression_ptr
448 script_exp_binary_mult(Expression_ptr, Expression_ptr);
449 extern Expression_ptr
450 script_exp_binary_div(Expression_ptr, Expression_ptr);
451 extern Expression_ptr
452 script_exp_binary_mod(Expression_ptr, Expression_ptr);
453 extern Expression_ptr
454 script_exp_binary_add(Expression_ptr, Expression_ptr);
455 extern Expression_ptr
456 script_exp_binary_sub(Expression_ptr, Expression_ptr);
457 extern Expression_ptr
458 script_exp_binary_lshift(Expression_ptr, Expression_ptr);
459 extern Expression_ptr
460 script_exp_binary_rshift(Expression_ptr, Expression_ptr);
461 extern Expression_ptr
462 script_exp_binary_eq(Expression_ptr, Expression_ptr);
463 extern Expression_ptr
464 script_exp_binary_ne(Expression_ptr, Expression_ptr);
465 extern Expression_ptr
466 script_exp_binary_le(Expression_ptr, Expression_ptr);
467 extern Expression_ptr
468 script_exp_binary_ge(Expression_ptr, Expression_ptr);
469 extern Expression_ptr
470 script_exp_binary_lt(Expression_ptr, Expression_ptr);
471 extern Expression_ptr
472 script_exp_binary_gt(Expression_ptr, Expression_ptr);
473 extern Expression_ptr
474 script_exp_binary_bitwise_and(Expression_ptr, Expression_ptr);
475 extern Expression_ptr
476 script_exp_binary_bitwise_xor(Expression_ptr, Expression_ptr);
477 extern Expression_ptr
478 script_exp_binary_bitwise_or(Expression_ptr, Expression_ptr);
479 extern Expression_ptr
480 script_exp_binary_logical_and(Expression_ptr, Expression_ptr);
481 extern Expression_ptr
482 script_exp_binary_logical_or(Expression_ptr, Expression_ptr);
483 extern Expression_ptr
484 script_exp_trinary_cond(Expression_ptr, Expression_ptr, Expression_ptr);
485 extern Expression_ptr
486 script_exp_integer(uint64_t);
487 extern Expression_ptr
488 script_exp_string(const char*, size_t);
489 extern Expression_ptr
490 script_exp_function_max(Expression_ptr, Expression_ptr);
491 extern Expression_ptr
492 script_exp_function_min(Expression_ptr, Expression_ptr);
493 extern Expression_ptr
494 script_exp_function_defined(const char*, size_t);
495 extern Expression_ptr
496 script_exp_function_sizeof_headers(void);
497 extern Expression_ptr
498 script_exp_function_alignof(const char*, size_t);
499 extern Expression_ptr
500 script_exp_function_sizeof(const char*, size_t);
501 extern Expression_ptr
502 script_exp_function_addr(const char*, size_t);
503 extern Expression_ptr
504 script_exp_function_loadaddr(const char*, size_t);
505 extern Expression_ptr
506 script_exp_function_origin(void*, const char*, size_t);
507 extern Expression_ptr
508 script_exp_function_length(void*, const char*, size_t);
509 extern Expression_ptr
510 script_exp_function_constant(const char*, size_t);
511 extern Expression_ptr
512 script_exp_function_absolute(Expression_ptr);
513 extern Expression_ptr
514 script_exp_function_align(Expression_ptr, Expression_ptr);
515 extern Expression_ptr
516 script_exp_function_data_segment_align(Expression_ptr, Expression_ptr);
517 extern Expression_ptr
518 script_exp_function_data_segment_relro_end(Expression_ptr, Expression_ptr);
519 extern Expression_ptr
520 script_exp_function_data_segment_end(Expression_ptr);
521 extern Expression_ptr
522 script_exp_function_segment_start(const char*, size_t, Expression_ptr);
523 extern Expression_ptr
524 script_exp_function_assert(Expression_ptr, const char*, size_t);
527 script_register_vers_node(void* closure,
530 struct Version_tree*,
531 struct Version_dependency_list*);
533 extern struct Version_dependency_list*
534 script_add_vers_depend(void* closure,
535 struct Version_dependency_list* existing_dependencies,
536 const char* depend_to_add, int deplen);
538 extern struct Version_expression_list*
539 script_new_vers_pattern(void* closure,
540 struct Version_expression_list*,
541 const char*, int, int);
543 extern struct Version_expression_list*
544 script_merge_expressions(struct Version_expression_list* a,
545 struct Version_expression_list* b);
547 extern struct Version_tree*
548 script_new_vers_node(void* closure,
549 struct Version_expression_list* global,
550 struct Version_expression_list* local);
553 version_script_push_lang(void* closure, const char* lang, int langlen);
556 version_script_pop_lang(void* closure);
563 } // End namespace gold.
566 #endif /* !defined(GOLD_SCRIPT_C_H) */