1 /* script-c.h -- C interface for linker scripts in gold. */
3 /* Copyright 2006, 2007, 2008 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 /* A constraint for whether to use a particular output section
67 enum Section_constraint
71 /* Only if all input sections are read-only. */
72 CONSTRAINT_ONLY_IF_RO
,
73 /* Only if at least input section is writable. */
74 CONSTRAINT_ONLY_IF_RW
,
75 /* Special constraint. */
79 /* The information we store for an output section header in the bison
82 struct Parser_output_section_header
84 /* The address. This may be NULL. */
85 Expression_ptr address
;
86 /* The load address, from the AT specifier. This may be NULL. */
87 Expression_ptr load_address
;
88 /* The alignment, from the ALIGN specifier. This may be NULL. */
90 /* The input section alignment, from the SUBALIGN specifier. This
92 Expression_ptr subalign
;
93 /* A constraint on this output section. */
94 enum Section_constraint constraint
;
97 /* We keep vectors of strings. In order to manage this in both C and
98 C++, we use a pointer to a vector. This assumes that all pointers
102 typedef std::vector
<std::string
> String_list
;
103 typedef String_list
* String_list_ptr
;
105 typedef void* String_list_ptr
;
108 /* The information we store for an output section trailer in the bison
111 struct Parser_output_section_trailer
113 /* The fill value. This may be NULL. */
115 /* The program segments this section should go into. This may be
117 String_list_ptr phdrs
;
120 /* The different sorts we can find in a linker script. */
125 SORT_WILDCARD_BY_NAME
,
126 SORT_WILDCARD_BY_ALIGNMENT
,
127 SORT_WILDCARD_BY_NAME_BY_ALIGNMENT
,
128 SORT_WILDCARD_BY_ALIGNMENT_BY_NAME
131 /* The information we build for a single wildcard specification. */
133 struct Wildcard_section
135 /* The wildcard spec itself. */
136 struct Parser_string name
;
137 /* How the entries should be sorted. */
138 enum Sort_wildcard sort
;
141 /* A vector of Wildcard_section entries. */
144 typedef std::vector
<Wildcard_section
> String_sort_list
;
145 typedef String_sort_list
* String_sort_list_ptr
;
147 typedef void* String_sort_list_ptr
;
150 /* A list of wildcard specifications, which may include EXCLUDE_FILE
153 struct Wildcard_sections
155 /* Wildcard specs. */
156 String_sort_list_ptr sections
;
158 String_list_ptr exclude
;
161 /* A complete input section specification. */
163 struct Input_section_spec
166 struct Wildcard_section file
;
167 /* The list of sections. */
168 struct Wildcard_sections input_sections
;
171 /* Information for a program header. */
175 /* A boolean value: whether to include the file header. */
176 int includes_filehdr
;
177 /* A boolean value: whether to include the program headers. */
179 /* A boolean value: whether the flags field is valid. */
181 /* The value to use for the flags. */
183 /* The load address. */
184 Expression_ptr load_address
;
187 struct Version_dependency_list
;
188 struct Version_expression_list
;
195 /* The bison parser definitions. */
197 #include "yyscript.h"
199 /* The bison parser function. */
202 yyparse(void* closure
);
204 /* Called by the bison parser skeleton to return the next token. */
207 yylex(YYSTYPE
*, void* closure
);
209 /* Called by the bison parser skeleton to report an error. */
212 yyerror(void* closure
, const char*);
214 /* Called by the bison parser to add an external symbol (a symbol in
215 an EXTERN declaration) to the link. */
218 script_add_extern(void* closure
, const char*, size_t);
220 /* Called by the bison parser to add a file to the link. */
223 script_add_file(void* closure
, const char*, size_t);
225 /* Called by the bison parser to start and stop a group. */
228 script_start_group(void* closure
);
230 script_end_group(void* closure
);
232 /* Called by the bison parser to start and end an AS_NEEDED list. */
235 script_start_as_needed(void* closure
);
237 script_end_as_needed(void* closure
);
239 /* Called by the bison parser to set the entry symbol. */
242 script_set_entry(void* closure
, const char*, size_t);
244 /* Called by the bison parser to set whether to define common symbols. */
247 script_set_common_allocation(void* closure
, int);
249 /* Called by the bison parser to parse an OPTION. */
252 script_parse_option(void* closure
, const char*, size_t);
254 /* Called by the bison parser to handle OUTPUT_FORMAT. This return 0
255 if the parse should be aborted. */
258 script_check_output_format(void* closure
, const char*, size_t,
259 const char*, size_t, const char*, size_t);
261 /* Called by the bison parser to handle TARGET. */
263 script_set_target(void* closure
, const char*, size_t);
265 /* Called by the bison parser to handle SEARCH_DIR. */
268 script_add_search_dir(void* closure
, const char*, size_t);
270 /* Called by the bison parser to push the lexer into expression
274 script_push_lex_into_expression_mode(void* closure
);
276 /* Called by the bison parser to push the lexer into version
280 script_push_lex_into_version_mode(void* closure
);
282 /* Called by the bison parser to pop the lexer mode. */
285 script_pop_lex_mode(void* closure
);
287 /* Called by the bison parser to set a symbol to a value. PROVIDE is
288 non-zero if the symbol should be provided--only defined if there is
289 an undefined reference. HIDDEN is non-zero if the symbol should be
293 script_set_symbol(void* closure
, const char*, size_t, Expression_ptr
,
294 int provide
, int hidden
);
296 /* Called by the bison parser to add an assertion. */
299 script_add_assertion(void* closure
, Expression_ptr
, const char* message
,
302 /* Called by the bison parser to start a SECTIONS clause. */
305 script_start_sections(void* closure
);
307 /* Called by the bison parser to finish a SECTIONS clause. */
310 script_finish_sections(void* closure
);
312 /* Called by the bison parser to start handling input section
313 specifications for an output section. */
316 script_start_output_section(void* closure
, const char* name
, size_t namelen
,
317 const struct Parser_output_section_header
*);
319 /* Called by the bison parser when done handling input section
320 specifications for an output section. */
323 script_finish_output_section(void* closure
,
324 const struct Parser_output_section_trailer
*);
326 /* Called by the bison parser to handle a data statement (LONG, BYTE,
327 etc.) in an output section. */
330 script_add_data(void* closure
, int data_token
, Expression_ptr val
);
332 /* Called by the bison parser to set the fill value in an output
336 script_add_fill(void* closure
, Expression_ptr val
);
338 /* Called by the bison parser to add an input section specification to
339 an output section. The KEEP parameter is non-zero if this is
340 within a KEEP clause, meaning that the garbage collector should not
344 script_add_input_section(void* closure
, const struct Input_section_spec
*,
347 /* Create a new list of string and sort entries. */
349 extern String_sort_list_ptr
350 script_new_string_sort_list(const struct Wildcard_section
*);
352 /* Add an entry to a list of string and sort entries. */
354 extern String_sort_list_ptr
355 script_string_sort_list_add(String_sort_list_ptr
,
356 const struct Wildcard_section
*);
358 /* Create a new list of strings. */
360 extern String_list_ptr
361 script_new_string_list(const char*, size_t);
363 /* Add an element to a list of strings. */
365 extern String_list_ptr
366 script_string_list_push_back(String_list_ptr
, const char*, size_t);
368 /* Concatenate two string lists. */
370 extern String_list_ptr
371 script_string_list_append(String_list_ptr
, String_list_ptr
);
373 /* Define a new program header. */
376 script_add_phdr(void* closure
, const char* name
, size_t namelen
,
377 unsigned int type
, const struct Phdr_info
*);
379 /* Convert a program header string to a type. */
382 script_phdr_string_to_type(void* closure
, const char*, size_t);
384 /* Handle DATA_SEGMENT_ALIGN and DATA_SEGMENT_RELRO_END. */
387 script_data_segment_align(void* closure
);
390 script_data_segment_relro_end(void* closure
);
392 /* Record the fact that a SEGMENT_START expression is seen. */
395 script_saw_segment_start_expression(void* closure
);
397 /* Called by the bison parser for expressions. */
399 extern Expression_ptr
400 script_exp_unary_minus(Expression_ptr
);
401 extern Expression_ptr
402 script_exp_unary_logical_not(Expression_ptr
);
403 extern Expression_ptr
404 script_exp_unary_bitwise_not(Expression_ptr
);
405 extern Expression_ptr
406 script_exp_binary_mult(Expression_ptr
, Expression_ptr
);
407 extern Expression_ptr
408 script_exp_binary_div(Expression_ptr
, Expression_ptr
);
409 extern Expression_ptr
410 script_exp_binary_mod(Expression_ptr
, Expression_ptr
);
411 extern Expression_ptr
412 script_exp_binary_add(Expression_ptr
, Expression_ptr
);
413 extern Expression_ptr
414 script_exp_binary_sub(Expression_ptr
, Expression_ptr
);
415 extern Expression_ptr
416 script_exp_binary_lshift(Expression_ptr
, Expression_ptr
);
417 extern Expression_ptr
418 script_exp_binary_rshift(Expression_ptr
, Expression_ptr
);
419 extern Expression_ptr
420 script_exp_binary_eq(Expression_ptr
, Expression_ptr
);
421 extern Expression_ptr
422 script_exp_binary_ne(Expression_ptr
, Expression_ptr
);
423 extern Expression_ptr
424 script_exp_binary_le(Expression_ptr
, Expression_ptr
);
425 extern Expression_ptr
426 script_exp_binary_ge(Expression_ptr
, Expression_ptr
);
427 extern Expression_ptr
428 script_exp_binary_lt(Expression_ptr
, Expression_ptr
);
429 extern Expression_ptr
430 script_exp_binary_gt(Expression_ptr
, Expression_ptr
);
431 extern Expression_ptr
432 script_exp_binary_bitwise_and(Expression_ptr
, Expression_ptr
);
433 extern Expression_ptr
434 script_exp_binary_bitwise_xor(Expression_ptr
, Expression_ptr
);
435 extern Expression_ptr
436 script_exp_binary_bitwise_or(Expression_ptr
, Expression_ptr
);
437 extern Expression_ptr
438 script_exp_binary_logical_and(Expression_ptr
, Expression_ptr
);
439 extern Expression_ptr
440 script_exp_binary_logical_or(Expression_ptr
, Expression_ptr
);
441 extern Expression_ptr
442 script_exp_trinary_cond(Expression_ptr
, Expression_ptr
, Expression_ptr
);
443 extern Expression_ptr
444 script_exp_integer(uint64_t);
445 extern Expression_ptr
446 script_exp_string(const char*, size_t);
447 extern Expression_ptr
448 script_exp_function_max(Expression_ptr
, Expression_ptr
);
449 extern Expression_ptr
450 script_exp_function_min(Expression_ptr
, Expression_ptr
);
451 extern Expression_ptr
452 script_exp_function_defined(const char*, size_t);
453 extern Expression_ptr
454 script_exp_function_sizeof_headers(void);
455 extern Expression_ptr
456 script_exp_function_alignof(const char*, size_t);
457 extern Expression_ptr
458 script_exp_function_sizeof(const char*, size_t);
459 extern Expression_ptr
460 script_exp_function_addr(const char*, size_t);
461 extern Expression_ptr
462 script_exp_function_loadaddr(const char*, size_t);
463 extern Expression_ptr
464 script_exp_function_origin(const char*, size_t);
465 extern Expression_ptr
466 script_exp_function_length(const char*, size_t);
467 extern Expression_ptr
468 script_exp_function_constant(const char*, size_t);
469 extern Expression_ptr
470 script_exp_function_absolute(Expression_ptr
);
471 extern Expression_ptr
472 script_exp_function_align(Expression_ptr
, Expression_ptr
);
473 extern Expression_ptr
474 script_exp_function_data_segment_align(Expression_ptr
, Expression_ptr
);
475 extern Expression_ptr
476 script_exp_function_data_segment_relro_end(Expression_ptr
, Expression_ptr
);
477 extern Expression_ptr
478 script_exp_function_data_segment_end(Expression_ptr
);
479 extern Expression_ptr
480 script_exp_function_segment_start(const char*, size_t, Expression_ptr
);
481 extern Expression_ptr
482 script_exp_function_assert(Expression_ptr
, const char*, size_t);
485 script_register_vers_node(void* closure
,
488 struct Version_tree
*,
489 struct Version_dependency_list
*);
491 extern struct Version_dependency_list
*
492 script_add_vers_depend(void* closure
,
493 struct Version_dependency_list
*existing_dependencies
,
494 const char *depend_to_add
, int deplen
);
496 extern struct Version_expression_list
*
497 script_new_vers_pattern(void* closure
,
498 struct Version_expression_list
*,
499 const char *, int, int);
501 extern struct Version_expression_list
*
502 script_merge_expressions(struct Version_expression_list
*a
,
503 struct Version_expression_list
*b
);
505 extern struct Version_tree
*
506 script_new_vers_node(void* closure
,
507 struct Version_expression_list
*global
,
508 struct Version_expression_list
*local
);
511 version_script_push_lang(void* closure
, const char* lang
, int langlen
);
514 version_script_pop_lang(void* closure
);
521 } // End namespace gold.
524 #endif /* !defined(GOLD_SCRIPT_C_H) */