Commit | Line | Data |
---|---|---|
dbe717ef ILT |
1 | /* script-c.h -- C interface for linker scripts in gold. */ |
2 | ||
e5756efb | 3 | /* Copyright 2006, 2007, 2008 Free Software Foundation, Inc. |
6cb15b7f ILT |
4 | Written by Ian Lance Taylor <iant@google.com>. |
5 | ||
6 | This file is part of gold. | |
7 | ||
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. | |
12 | ||
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. | |
17 | ||
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. */ | |
22 | ||
dbe717ef ILT |
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. */ | |
25 | ||
26 | #ifndef GOLD_SCRIPT_C_H | |
27 | #define GOLD_SCRIPT_C_H | |
28 | ||
29 | #ifdef __cplusplus | |
494e05f4 ILT |
30 | #include <vector> |
31 | #include <string> | |
32 | #endif | |
33 | ||
34 | #ifdef __cplusplus | |
35 | ||
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. | |
39 | ||
40 | namespace gold | |
41 | { | |
dbe717ef ILT |
42 | #endif |
43 | ||
e5756efb ILT |
44 | /* A string value for the bison parser. */ |
45 | ||
46 | struct Parser_string | |
47 | { | |
48 | const char* value; | |
49 | size_t length; | |
50 | }; | |
51 | ||
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 | |
55 | alike. */ | |
56 | ||
57 | #ifdef __cplusplus | |
e5756efb | 58 | class Expression; |
494e05f4 | 59 | typedef Expression* Expression_ptr; |
e5756efb ILT |
60 | #else |
61 | typedef void* Expression_ptr; | |
62 | #endif | |
63 | ||
3802b2dd ILT |
64 | /* A constraint for whether to use a particular output section |
65 | definition. */ | |
66 | ||
67 | enum Section_constraint | |
68 | { | |
69 | /* No constraint. */ | |
70 | CONSTRAINT_NONE, | |
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. */ | |
76 | CONSTRAINT_SPECIAL | |
77 | }; | |
78 | ||
494e05f4 ILT |
79 | /* The information we store for an output section header in the bison |
80 | parser. */ | |
81 | ||
82 | struct Parser_output_section_header | |
83 | { | |
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. */ | |
89 | Expression_ptr align; | |
90 | /* The input section alignment, from the SUBALIGN specifier. This | |
91 | may be NULL. */ | |
92 | Expression_ptr subalign; | |
3802b2dd ILT |
93 | /* A constraint on this output section. */ |
94 | enum Section_constraint constraint; | |
494e05f4 ILT |
95 | }; |
96 | ||
494e05f4 ILT |
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 | |
99 | look the same. */ | |
100 | ||
101 | #ifdef __cplusplus | |
102 | typedef std::vector<std::string> String_list; | |
103 | typedef String_list* String_list_ptr; | |
104 | #else | |
105 | typedef void* String_list_ptr; | |
106 | #endif | |
107 | ||
1c4f3631 ILT |
108 | /* The information we store for an output section trailer in the bison |
109 | parser. */ | |
110 | ||
111 | struct Parser_output_section_trailer | |
112 | { | |
113 | /* The fill value. This may be NULL. */ | |
114 | Expression_ptr fill; | |
115 | /* The program segments this section should go into. This may be | |
116 | NULL. */ | |
117 | String_list_ptr phdrs; | |
118 | }; | |
119 | ||
494e05f4 ILT |
120 | /* The different sorts we can find in a linker script. */ |
121 | ||
122 | enum Sort_wildcard | |
123 | { | |
124 | SORT_WILDCARD_NONE, | |
125 | SORT_WILDCARD_BY_NAME, | |
126 | SORT_WILDCARD_BY_ALIGNMENT, | |
127 | SORT_WILDCARD_BY_NAME_BY_ALIGNMENT, | |
128 | SORT_WILDCARD_BY_ALIGNMENT_BY_NAME | |
129 | }; | |
130 | ||
131 | /* The information we build for a single wildcard specification. */ | |
132 | ||
133 | struct Wildcard_section | |
134 | { | |
135 | /* The wildcard spec itself. */ | |
136 | struct Parser_string name; | |
137 | /* How the entries should be sorted. */ | |
138 | enum Sort_wildcard sort; | |
139 | }; | |
140 | ||
141 | /* A vector of Wildcard_section entries. */ | |
142 | ||
143 | #ifdef __cplusplus | |
144 | typedef std::vector<Wildcard_section> String_sort_list; | |
145 | typedef String_sort_list* String_sort_list_ptr; | |
146 | #else | |
147 | typedef void* String_sort_list_ptr; | |
148 | #endif | |
149 | ||
150 | /* A list of wildcard specifications, which may include EXCLUDE_FILE | |
151 | clauses. */ | |
152 | ||
153 | struct Wildcard_sections | |
154 | { | |
155 | /* Wildcard specs. */ | |
156 | String_sort_list_ptr sections; | |
157 | /* Exclusions. */ | |
158 | String_list_ptr exclude; | |
159 | }; | |
160 | ||
161 | /* A complete input section specification. */ | |
162 | ||
163 | struct Input_section_spec | |
164 | { | |
165 | /* The file name. */ | |
166 | struct Wildcard_section file; | |
167 | /* The list of sections. */ | |
168 | struct Wildcard_sections input_sections; | |
169 | }; | |
170 | ||
1c4f3631 ILT |
171 | /* Information for a program header. */ |
172 | ||
173 | struct Phdr_info | |
174 | { | |
175 | /* A boolean value: whether to include the file header. */ | |
176 | int includes_filehdr; | |
177 | /* A boolean value: whether to include the program headers. */ | |
178 | int includes_phdrs; | |
179 | /* A boolean value: whether the flags field is valid. */ | |
180 | int is_flags_valid; | |
181 | /* The value to use for the flags. */ | |
182 | unsigned int flags; | |
183 | /* The load address. */ | |
184 | Expression_ptr load_address; | |
185 | }; | |
186 | ||
494e05f4 ILT |
187 | struct Version_dependency_list; |
188 | struct Version_expression_list; | |
189 | struct Version_tree; | |
190 | ||
191 | #ifdef __cplusplus | |
192 | extern "C" { | |
193 | #endif | |
194 | ||
e5756efb ILT |
195 | /* The bison parser definitions. */ |
196 | ||
dbe717ef ILT |
197 | #include "yyscript.h" |
198 | ||
199 | /* The bison parser function. */ | |
200 | ||
201 | extern int | |
202 | yyparse(void* closure); | |
203 | ||
204 | /* Called by the bison parser skeleton to return the next token. */ | |
205 | ||
206 | extern int | |
207 | yylex(YYSTYPE*, void* closure); | |
208 | ||
209 | /* Called by the bison parser skeleton to report an error. */ | |
210 | ||
211 | extern void | |
212 | yyerror(void* closure, const char*); | |
213 | ||
214 | /* Called by the bison parser to add a file to the link. */ | |
215 | ||
216 | extern void | |
e5756efb | 217 | script_add_file(void* closure, const char*, size_t); |
dbe717ef ILT |
218 | |
219 | /* Called by the bison parser to start and stop a group. */ | |
220 | ||
221 | extern void | |
222 | script_start_group(void* closure); | |
223 | extern void | |
224 | script_end_group(void* closure); | |
225 | ||
226 | /* Called by the bison parser to start and end an AS_NEEDED list. */ | |
227 | ||
228 | extern void | |
229 | script_start_as_needed(void* closure); | |
230 | extern void | |
231 | script_end_as_needed(void* closure); | |
232 | ||
d391083d ILT |
233 | /* Called by the bison parser to set the entry symbol. */ |
234 | ||
235 | extern void | |
e5756efb | 236 | script_set_entry(void* closure, const char*, size_t); |
d391083d | 237 | |
195e7dc6 | 238 | /* Called by the bison parser to parse an OPTION. */ |
e5756efb ILT |
239 | |
240 | extern void | |
241 | script_parse_option(void* closure, const char*, size_t); | |
242 | ||
3802b2dd ILT |
243 | /* Called by the bison parser to handle SEARCH_DIR. */ |
244 | ||
245 | extern void | |
246 | script_add_search_dir(void* closure, const char*, size_t); | |
247 | ||
e5756efb ILT |
248 | /* Called by the bison parser to push the lexer into expression |
249 | mode. */ | |
250 | ||
251 | extern void | |
252 | script_push_lex_into_expression_mode(void* closure); | |
253 | ||
09124467 ILT |
254 | /* Called by the bison parser to push the lexer into version |
255 | mode. */ | |
256 | ||
257 | extern void | |
258 | script_push_lex_into_version_mode(void* closure); | |
259 | ||
e5756efb ILT |
260 | /* Called by the bison parser to pop the lexer mode. */ |
261 | ||
262 | extern void | |
263 | script_pop_lex_mode(void* closure); | |
264 | ||
265 | /* Called by the bison parser to set a symbol to a value. PROVIDE is | |
266 | non-zero if the symbol should be provided--only defined if there is | |
267 | an undefined reference. HIDDEN is non-zero if the symbol should be | |
268 | hidden. */ | |
269 | ||
195e7dc6 | 270 | extern void |
e5756efb ILT |
271 | script_set_symbol(void* closure, const char*, size_t, Expression_ptr, |
272 | int provide, int hidden); | |
273 | ||
494e05f4 ILT |
274 | /* Called by the bison parser to add an assertion. */ |
275 | ||
276 | extern void | |
277 | script_add_assertion(void* closure, Expression_ptr, const char* message, | |
278 | size_t messagelen); | |
279 | ||
280 | /* Called by the bison parser to start a SECTIONS clause. */ | |
281 | ||
282 | extern void | |
283 | script_start_sections(void* closure); | |
284 | ||
285 | /* Called by the bison parser to finish a SECTIONS clause. */ | |
286 | ||
287 | extern void | |
288 | script_finish_sections(void* closure); | |
289 | ||
290 | /* Called by the bison parser to start handling input section | |
291 | specifications for an output section. */ | |
292 | ||
293 | extern void | |
294 | script_start_output_section(void* closure, const char* name, size_t namelen, | |
295 | const struct Parser_output_section_header*); | |
296 | ||
297 | /* Called by the bison parser when done handling input section | |
298 | specifications for an output section. */ | |
299 | ||
300 | extern void | |
301 | script_finish_output_section(void* closure, | |
302 | const struct Parser_output_section_trailer*); | |
303 | ||
304 | /* Called by the bison parser to handle a data statement (LONG, BYTE, | |
305 | etc.) in an output section. */ | |
306 | ||
307 | extern void | |
308 | script_add_data(void* closure, int data_token, Expression_ptr val); | |
309 | ||
310 | /* Called by the bison parser to set the fill value in an output | |
311 | section. */ | |
312 | ||
313 | extern void | |
314 | script_add_fill(void* closure, Expression_ptr val); | |
315 | ||
316 | /* Called by the bison parser to add an input section specification to | |
317 | an output section. The KEEP parameter is non-zero if this is | |
318 | within a KEEP clause, meaning that the garbage collector should not | |
319 | discard it. */ | |
320 | ||
321 | extern void | |
322 | script_add_input_section(void* closure, const struct Input_section_spec*, | |
323 | int keep); | |
324 | ||
325 | /* Create a new list of string and sort entries. */ | |
326 | ||
327 | extern String_sort_list_ptr | |
328 | script_new_string_sort_list(const struct Wildcard_section*); | |
329 | ||
330 | /* Add an entry to a list of string and sort entries. */ | |
331 | ||
332 | extern String_sort_list_ptr | |
333 | script_string_sort_list_add(String_sort_list_ptr, | |
334 | const struct Wildcard_section*); | |
335 | ||
336 | /* Create a new list of strings. */ | |
337 | ||
338 | extern String_list_ptr | |
339 | script_new_string_list(const char*, size_t); | |
340 | ||
341 | /* Add an element to a list of strings. */ | |
342 | ||
343 | extern String_list_ptr | |
344 | script_string_list_push_back(String_list_ptr, const char*, size_t); | |
345 | ||
346 | /* Concatenate two string lists. */ | |
347 | ||
348 | extern String_list_ptr | |
349 | script_string_list_append(String_list_ptr, String_list_ptr); | |
350 | ||
1c4f3631 ILT |
351 | /* Define a new program header. */ |
352 | ||
353 | extern void | |
354 | script_add_phdr(void* closure, const char* name, size_t namelen, | |
355 | unsigned int type, const struct Phdr_info*); | |
356 | ||
357 | /* Convert a program header string to a type. */ | |
358 | ||
359 | extern unsigned int | |
360 | script_phdr_string_to_type(void* closure, const char*, size_t); | |
361 | ||
e5756efb ILT |
362 | /* Called by the bison parser for expressions. */ |
363 | ||
364 | extern Expression_ptr | |
365 | script_exp_unary_minus(Expression_ptr); | |
366 | extern Expression_ptr | |
367 | script_exp_unary_logical_not(Expression_ptr); | |
368 | extern Expression_ptr | |
369 | script_exp_unary_bitwise_not(Expression_ptr); | |
370 | extern Expression_ptr | |
371 | script_exp_binary_mult(Expression_ptr, Expression_ptr); | |
372 | extern Expression_ptr | |
373 | script_exp_binary_div(Expression_ptr, Expression_ptr); | |
374 | extern Expression_ptr | |
375 | script_exp_binary_mod(Expression_ptr, Expression_ptr); | |
376 | extern Expression_ptr | |
377 | script_exp_binary_add(Expression_ptr, Expression_ptr); | |
378 | extern Expression_ptr | |
379 | script_exp_binary_sub(Expression_ptr, Expression_ptr); | |
380 | extern Expression_ptr | |
381 | script_exp_binary_lshift(Expression_ptr, Expression_ptr); | |
382 | extern Expression_ptr | |
383 | script_exp_binary_rshift(Expression_ptr, Expression_ptr); | |
384 | extern Expression_ptr | |
385 | script_exp_binary_eq(Expression_ptr, Expression_ptr); | |
386 | extern Expression_ptr | |
387 | script_exp_binary_ne(Expression_ptr, Expression_ptr); | |
388 | extern Expression_ptr | |
389 | script_exp_binary_le(Expression_ptr, Expression_ptr); | |
390 | extern Expression_ptr | |
391 | script_exp_binary_ge(Expression_ptr, Expression_ptr); | |
392 | extern Expression_ptr | |
393 | script_exp_binary_lt(Expression_ptr, Expression_ptr); | |
394 | extern Expression_ptr | |
395 | script_exp_binary_gt(Expression_ptr, Expression_ptr); | |
396 | extern Expression_ptr | |
397 | script_exp_binary_bitwise_and(Expression_ptr, Expression_ptr); | |
398 | extern Expression_ptr | |
399 | script_exp_binary_bitwise_xor(Expression_ptr, Expression_ptr); | |
400 | extern Expression_ptr | |
401 | script_exp_binary_bitwise_or(Expression_ptr, Expression_ptr); | |
402 | extern Expression_ptr | |
403 | script_exp_binary_logical_and(Expression_ptr, Expression_ptr); | |
404 | extern Expression_ptr | |
405 | script_exp_binary_logical_or(Expression_ptr, Expression_ptr); | |
406 | extern Expression_ptr | |
407 | script_exp_trinary_cond(Expression_ptr, Expression_ptr, Expression_ptr); | |
408 | extern Expression_ptr | |
409 | script_exp_integer(uint64_t); | |
410 | extern Expression_ptr | |
411 | script_exp_string(const char*, size_t); | |
412 | extern Expression_ptr | |
413 | script_exp_function_max(Expression_ptr, Expression_ptr); | |
414 | extern Expression_ptr | |
415 | script_exp_function_min(Expression_ptr, Expression_ptr); | |
416 | extern Expression_ptr | |
417 | script_exp_function_defined(const char*, size_t); | |
418 | extern Expression_ptr | |
494e05f4 | 419 | script_exp_function_sizeof_headers(void); |
e5756efb ILT |
420 | extern Expression_ptr |
421 | script_exp_function_alignof(const char*, size_t); | |
422 | extern Expression_ptr | |
423 | script_exp_function_sizeof(const char*, size_t); | |
424 | extern Expression_ptr | |
425 | script_exp_function_addr(const char*, size_t); | |
426 | extern Expression_ptr | |
427 | script_exp_function_loadaddr(const char*, size_t); | |
428 | extern Expression_ptr | |
429 | script_exp_function_origin(const char*, size_t); | |
430 | extern Expression_ptr | |
431 | script_exp_function_length(const char*, size_t); | |
432 | extern Expression_ptr | |
433 | script_exp_function_constant(const char*, size_t); | |
434 | extern Expression_ptr | |
435 | script_exp_function_absolute(Expression_ptr); | |
436 | extern Expression_ptr | |
437 | script_exp_function_align(Expression_ptr, Expression_ptr); | |
438 | extern Expression_ptr | |
439 | script_exp_function_data_segment_align(Expression_ptr, Expression_ptr); | |
440 | extern Expression_ptr | |
441 | script_exp_function_data_segment_relro_end(Expression_ptr, Expression_ptr); | |
442 | extern Expression_ptr | |
443 | script_exp_function_data_segment_end(Expression_ptr); | |
444 | extern Expression_ptr | |
445 | script_exp_function_segment_start(const char*, size_t, Expression_ptr); | |
446 | extern Expression_ptr | |
447 | script_exp_function_assert(Expression_ptr, const char*, size_t); | |
195e7dc6 | 448 | |
09124467 ILT |
449 | extern void |
450 | script_register_vers_node(void* closure, | |
451 | const char* tag, | |
452 | int taglen, | |
453 | struct Version_tree *, | |
454 | struct Version_dependency_list *); | |
455 | ||
456 | extern struct Version_dependency_list * | |
457 | script_add_vers_depend(void* closure, | |
458 | struct Version_dependency_list *existing_dependencies, | |
459 | const char *depend_to_add, int deplen); | |
460 | ||
461 | extern struct Version_expression_list * | |
462 | script_new_vers_pattern(void* closure, | |
463 | struct Version_expression_list *, | |
10600224 ILT |
464 | const char *, int, int); |
465 | ||
466 | extern struct Version_expression_list * | |
467 | script_merge_expressions(struct Version_expression_list *a, | |
468 | struct Version_expression_list *b); | |
09124467 ILT |
469 | |
470 | extern struct Version_tree * | |
471 | script_new_vers_node(void* closure, | |
472 | struct Version_expression_list *global, | |
473 | struct Version_expression_list *local); | |
474 | ||
475 | extern void | |
476 | version_script_push_lang(void* closure, const char* lang, int langlen); | |
477 | ||
478 | extern void | |
479 | version_script_pop_lang(void* closure); | |
480 | ||
dbe717ef | 481 | #ifdef __cplusplus |
494e05f4 ILT |
482 | } // End extern "C" |
483 | #endif | |
484 | ||
485 | #ifdef __cplusplus | |
486 | } // End namespace gold. | |
dbe717ef ILT |
487 | #endif |
488 | ||
489 | #endif /* !defined(GOLD_SCRIPT_C_H) */ |