]>
Commit | Line | Data |
---|---|---|
6de9cd9a | 1 | /* Header for code translation functions |
60386f50 | 2 | Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 |
34d01e1d | 3 | Free Software Foundation, Inc. |
6de9cd9a DN |
4 | Contributed by Paul Brook |
5 | ||
9fc4d79b | 6 | This file is part of GCC. |
6de9cd9a | 7 | |
9fc4d79b TS |
8 | GCC is free software; you can redistribute it and/or modify it under |
9 | the terms of the GNU General Public License as published by the Free | |
d234d788 | 10 | Software Foundation; either version 3, or (at your option) any later |
9fc4d79b | 11 | version. |
6de9cd9a | 12 | |
9fc4d79b TS |
13 | GCC is distributed in the hope that it will be useful, but WITHOUT ANY |
14 | WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
15 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
16 | for more details. | |
6de9cd9a DN |
17 | |
18 | You should have received a copy of the GNU General Public License | |
d234d788 NC |
19 | along with GCC; see the file COPYING3. If not see |
20 | <http://www.gnu.org/licenses/>. */ | |
6de9cd9a DN |
21 | |
22 | #ifndef GFC_TRANS_H | |
23 | #define GFC_TRANS_H | |
24 | ||
25 | /* Mangled symbols take the form __module__name. */ | |
26 | #define GFC_MAX_MANGLED_SYMBOL_LEN (GFC_MAX_SYMBOL_LEN*2+4) | |
27 | ||
28 | /* Struct for holding a block of statements. It should be treated as an | |
29 | opaque entity and not modified directly. This allows us to change the | |
30 | underlying representation of statement lists. */ | |
31 | typedef struct | |
32 | { | |
33 | tree head; | |
b40410b9 | 34 | unsigned int has_scope:1; |
6de9cd9a DN |
35 | } |
36 | stmtblock_t; | |
37 | ||
1f2959f0 | 38 | /* a simplified expression */ |
6de9cd9a DN |
39 | typedef struct gfc_se |
40 | { | |
41 | /* Code blocks to be executed before and after using the value. */ | |
42 | stmtblock_t pre; | |
43 | stmtblock_t post; | |
44 | ||
45 | /* the result of the expression */ | |
46 | tree expr; | |
47 | ||
48 | /* The length of a character string value. */ | |
49 | tree string_length; | |
50 | ||
51 | /* If set gfc_conv_variable will return an expression for the array | |
52 | descriptor. When set, want_pointer should also be set. | |
53 | If not set scalarizing variables will be substituted. */ | |
54 | unsigned descriptor_only:1; | |
55 | ||
56 | /* When this is set gfc_conv_expr returns the address of a variable. Only | |
57 | applies to EXPR_VARIABLE nodes. | |
58 | Also used by gfc_conv_array_parameter. When set this indicates a pointer | |
59 | to the descriptor should be returned, rather than the descriptor itself. | |
60 | */ | |
61 | unsigned want_pointer:1; | |
62 | ||
63 | /* An array function call returning without a temporary. Also used for array | |
64 | pointer assignments. */ | |
65 | unsigned direct_byref:1; | |
66 | ||
99d821c0 DK |
67 | /* If direct_byref is set, do work out the descriptor as in that case but |
68 | do still create a new descriptor variable instead of using an | |
69 | existing one. This is useful for special pointer assignments like | |
70 | rank remapping where we have to process the descriptor before | |
71 | assigning to final one. */ | |
72 | unsigned byref_noassign:1; | |
73 | ||
6de9cd9a DN |
74 | /* Ignore absent optional arguments. Used for some intrinsics. */ |
75 | unsigned ignore_optional:1; | |
76 | ||
ad5dd90d PT |
77 | /* When this is set the data and offset fields of the returned descriptor |
78 | are NULL. Used by intrinsic size. */ | |
79 | unsigned data_not_needed:1; | |
80 | ||
713485cc | 81 | /* If set, gfc_conv_procedure_call does not put byref calls into se->pre. */ |
0ee8e250 PT |
82 | unsigned no_function_call:1; |
83 | ||
0b4f2770 MM |
84 | /* If set, we will force the creation of a temporary. Useful to disable |
85 | non-copying procedure argument passing optimizations, when some function | |
86 | args alias. */ | |
87 | unsigned force_tmp:1; | |
88 | ||
23c3d0f9 MM |
89 | unsigned want_coarray:1; |
90 | ||
6de9cd9a DN |
91 | /* Scalarization parameters. */ |
92 | struct gfc_se *parent; | |
93 | struct gfc_ss *ss; | |
94 | struct gfc_loopinfo *loop; | |
95 | } | |
96 | gfc_se; | |
97 | ||
98 | ||
ea6363a3 DC |
99 | /* Denotes different types of coarray. |
100 | Please keep in sync with libgfortran/caf/libcaf.h. */ | |
101 | typedef enum | |
102 | { | |
103 | GFC_CAF_COARRAY_STATIC, | |
104 | GFC_CAF_COARRAY_ALLOC, | |
105 | GFC_CAF_LOCK, | |
106 | GFC_CAF_LOCK_COMP | |
107 | } | |
108 | gfc_coarray_type; | |
109 | ||
110 | ||
6d63e468 MM |
111 | /* The array-specific scalarization informations. The array members of |
112 | this struct are indexed by actual array index, and thus can be sparse. */ | |
6de9cd9a | 113 | |
6d63e468 | 114 | typedef struct gfc_array_info |
6de9cd9a | 115 | { |
08dcec61 MM |
116 | mpz_t *shape; |
117 | ||
6de9cd9a DN |
118 | /* The ref that holds information on this section. */ |
119 | gfc_ref *ref; | |
120 | /* The descriptor of this array. */ | |
121 | tree descriptor; | |
122 | /* holds the pointer to the data array. */ | |
123 | tree data; | |
124 | /* To move some of the array index calculation out of the innermost loop. */ | |
125 | tree offset; | |
126 | tree saved_offset; | |
127 | tree stride0; | |
128 | /* Holds the SS for a subscript. Indexed by actual dimension. */ | |
129 | struct gfc_ss *subscript[GFC_MAX_DIMENSIONS]; | |
130 | ||
131 | /* stride and delta are used to access this inside a scalarization loop. | |
132 | start is used in the calculation of these. Indexed by scalarizer | |
133 | dimension. */ | |
134 | tree start[GFC_MAX_DIMENSIONS]; | |
8424e0d8 | 135 | tree end[GFC_MAX_DIMENSIONS]; |
6de9cd9a DN |
136 | tree stride[GFC_MAX_DIMENSIONS]; |
137 | tree delta[GFC_MAX_DIMENSIONS]; | |
6de9cd9a | 138 | } |
6d63e468 | 139 | gfc_array_info; |
6de9cd9a DN |
140 | |
141 | typedef enum | |
142 | { | |
143 | /* A scalar value. This will be evaluated before entering the | |
144 | scalarization loop. */ | |
145 | GFC_SS_SCALAR, | |
146 | ||
991b4da1 PT |
147 | /* Like GFC_SS_SCALAR it evaluates the expression outside the |
148 | loop. Is always evaluated as a reference to the temporary. | |
149 | Used for elemental function arguments. */ | |
6de9cd9a DN |
150 | GFC_SS_REFERENCE, |
151 | ||
152 | /* An array section. Scalarization indices will be substituted during | |
153 | expression translation. */ | |
154 | GFC_SS_SECTION, | |
155 | ||
156 | /* A non-elemental function call returning an array. The call is executed | |
157 | before entering the scalarization loop, storing the result in a | |
158 | temporary. This temporary is then used inside the scalarization loop. | |
df2fba9e | 159 | Simple assignments, e.g. a(:) = fn(), are handled without a temporary |
6de9cd9a DN |
160 | as a special case. */ |
161 | GFC_SS_FUNCTION, | |
162 | ||
163 | /* An array constructor. The current implementation is sub-optimal in | |
164 | many cases. It allocated a temporary, assigns the values to it, then | |
165 | uses this temporary inside the scalarization loop. */ | |
166 | GFC_SS_CONSTRUCTOR, | |
167 | ||
7a70c12d RS |
168 | /* A vector subscript. The vector's descriptor is cached in the |
169 | "descriptor" field of the associated gfc_ss_info. */ | |
6de9cd9a DN |
170 | GFC_SS_VECTOR, |
171 | ||
172 | /* A temporary array allocated by the scalarizer. Its rank can be less | |
173 | than that of the assignment expression. */ | |
174 | GFC_SS_TEMP, | |
175 | ||
176 | /* An intrinsic function call. Many intrinsic functions which map directly | |
177 | to library calls are created as GFC_SS_FUNCTION nodes. */ | |
e9cfef64 PB |
178 | GFC_SS_INTRINSIC, |
179 | ||
180 | /* A component of a derived type. */ | |
181 | GFC_SS_COMPONENT | |
6de9cd9a DN |
182 | } |
183 | gfc_ss_type; | |
184 | ||
6d63e468 | 185 | |
bcc4d4e0 MM |
186 | typedef struct gfc_ss_info |
187 | { | |
188 | gfc_ss_type type; | |
f98cfd3c | 189 | gfc_expr *expr; |
a0add3be | 190 | tree string_length; |
99dd5a29 MM |
191 | |
192 | union | |
193 | { | |
194 | /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */ | |
195 | struct | |
196 | { | |
197 | tree value; | |
198 | } | |
199 | scalar; | |
961e73ac MM |
200 | |
201 | /* GFC_SS_TEMP. */ | |
202 | struct | |
203 | { | |
204 | tree type; | |
205 | } | |
206 | temp; | |
99dd5a29 MM |
207 | } |
208 | data; | |
bcc4d4e0 MM |
209 | } |
210 | gfc_ss_info; | |
211 | ||
212 | #define gfc_get_ss_info() XCNEW (gfc_ss_info) | |
213 | ||
214 | ||
6d63e468 MM |
215 | /* Scalarization State chain. Created by walking an expression tree before |
216 | creating the scalarization loops. Then passed as part of a gfc_se structure | |
217 | to translate the expression inside the loop. Note that these chains are | |
218 | terminated by gfc_ss_terminator, not NULL. A NULL pointer in a gfc_se | |
219 | indicates to gfc_conv_* that this is a scalar expression. | |
220 | SS structures can only belong to a single loopinfo. They must be added | |
6de9cd9a | 221 | otherwise they will not get freed. */ |
6d63e468 | 222 | |
6de9cd9a DN |
223 | typedef struct gfc_ss |
224 | { | |
bcc4d4e0 MM |
225 | gfc_ss_info *info; |
226 | ||
6de9cd9a DN |
227 | union |
228 | { | |
6de9cd9a | 229 | /* All other types. */ |
6d63e468 | 230 | gfc_array_info info; |
6de9cd9a DN |
231 | } |
232 | data; | |
233 | ||
cb4b9eae MM |
234 | int dimen; |
235 | /* Translation from loop dimensions to actual array dimensions. | |
236 | actual_dim = dim[loop_dim] */ | |
237 | int dim[GFC_MAX_DIMENSIONS]; | |
238 | ||
6de9cd9a DN |
239 | /* All the SS in a loop and linked through loop_chain. The SS for an |
240 | expression are linked by the next pointer. */ | |
241 | struct gfc_ss *loop_chain; | |
242 | struct gfc_ss *next; | |
243 | ||
e7dc5b4f | 244 | /* This is used by assignments requiring temporaries. The bits specify which |
6de9cd9a | 245 | loops the terms appear in. This will be 1 for the RHS expressions, |
ae772c2d PT |
246 | 2 for the LHS expressions, and 3(=1|2) for the temporary. The bit |
247 | 'where' suppresses precalculation of scalars in WHERE assignments. */ | |
597553ab | 248 | unsigned useflags:2, where:1, is_alloc_lhs:1; |
6de9cd9a DN |
249 | } |
250 | gfc_ss; | |
ece3f663 | 251 | #define gfc_get_ss() XCNEW (gfc_ss) |
6de9cd9a | 252 | |
1f2959f0 | 253 | /* The contents of this aren't actually used. A NULL SS chain indicates a |
6de9cd9a DN |
254 | scalar expression, so this pointer is used to terminate SS chains. */ |
255 | extern gfc_ss * const gfc_ss_terminator; | |
256 | ||
257 | /* Holds information about an expression while it is being scalarized. */ | |
258 | typedef struct gfc_loopinfo | |
259 | { | |
260 | stmtblock_t pre; | |
261 | stmtblock_t post; | |
262 | ||
c6d741b8 | 263 | int dimen; |
6de9cd9a DN |
264 | |
265 | /* All the SS involved with this loop. */ | |
266 | gfc_ss *ss; | |
e7dc5b4f | 267 | /* The SS describing the temporary used in an assignment. */ |
6de9cd9a DN |
268 | gfc_ss *temp_ss; |
269 | ||
270 | /* The scalarization loop index variables. */ | |
271 | tree loopvar[GFC_MAX_DIMENSIONS]; | |
272 | ||
273 | /* The bounds of the scalarization loops. */ | |
274 | tree from[GFC_MAX_DIMENSIONS]; | |
275 | tree to[GFC_MAX_DIMENSIONS]; | |
276 | gfc_ss *specloop[GFC_MAX_DIMENSIONS]; | |
277 | ||
278 | /* The code member contains the code for the body of the next outer loop. */ | |
279 | stmtblock_t code[GFC_MAX_DIMENSIONS]; | |
280 | ||
281 | /* Order in which the dimensions should be looped, innermost first. */ | |
282 | int order[GFC_MAX_DIMENSIONS]; | |
283 | ||
3d03ead0 PT |
284 | /* Enum to control loop reversal. */ |
285 | gfc_reverse reverse[GFC_MAX_DIMENSIONS]; | |
286 | ||
6de9cd9a DN |
287 | /* The number of dimensions for which a temporary is used. */ |
288 | int temp_dim; | |
289 | ||
290 | /* If set we don't need the loop variables. */ | |
291 | unsigned array_parameter:1; | |
292 | } | |
293 | gfc_loopinfo; | |
294 | ||
7b5b57b7 PB |
295 | |
296 | /* Information about a symbol that has been shadowed by a temporary. */ | |
297 | typedef struct | |
298 | { | |
299 | symbol_attribute attr; | |
300 | tree decl; | |
301 | } | |
302 | gfc_saved_var; | |
303 | ||
304 | ||
0019d498 DK |
305 | /* Store information about a block of code together with special |
306 | initialization and clean-up code. This can be used to incrementally add | |
307 | init and cleanup, and in the end put everything together to a | |
308 | try-finally expression. */ | |
309 | typedef struct | |
310 | { | |
311 | tree init; | |
312 | tree cleanup; | |
313 | tree code; | |
314 | } | |
315 | gfc_wrapped_block; | |
316 | ||
317 | ||
318 | /* Initialize an init/cleanup block. */ | |
319 | void gfc_start_wrapped_block (gfc_wrapped_block* block, tree code); | |
320 | /* Add a pair of init/cleanup code to the block. Each one might be a | |
321 | NULL_TREE if not required. */ | |
322 | void gfc_add_init_cleanup (gfc_wrapped_block* block, tree init, tree cleanup); | |
323 | /* Finalize the block, that is, create a single expression encapsulating the | |
324 | original code together with init and clean-up code. */ | |
325 | tree gfc_finish_wrapped_block (gfc_wrapped_block* block); | |
326 | ||
327 | ||
6de9cd9a DN |
328 | /* Advance the SS chain to the next term. */ |
329 | void gfc_advance_se_ss_chain (gfc_se *); | |
330 | ||
aa9c57ec KH |
331 | /* Call this to initialize a gfc_se structure before use |
332 | first parameter is structure to initialize, second is | |
6de9cd9a DN |
333 | parent to get scalarization data from, or NULL. */ |
334 | void gfc_init_se (gfc_se *, gfc_se *); | |
335 | ||
336 | /* Create an artificial variable decl and add it to the current scope. */ | |
337 | tree gfc_create_var (tree, const char *); | |
338 | /* Like above but doesn't add it to the current scope. */ | |
339 | tree gfc_create_var_np (tree, const char *); | |
340 | ||
341 | /* Store the result of an expression in a temp variable so it can be used | |
342 | repeatedly even if the original changes */ | |
343 | void gfc_make_safe_expr (gfc_se * se); | |
344 | ||
345 | /* Makes sure se is suitable for passing as a function string parameter. */ | |
346 | void gfc_conv_string_parameter (gfc_se * se); | |
347 | ||
0a821a92 | 348 | /* Compare two strings. */ |
23b10420 | 349 | tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code); |
0a821a92 | 350 | |
13795658 | 351 | /* When using the gfc_conv_* make sure you understand what they do, i.e. |
69de3b83 | 352 | when a POST chain may be created, and what the returned expression may be |
6de9cd9a DN |
353 | used for. Note that character strings have special handling. This |
354 | should not be a problem as most statements/operations only deal with | |
a4f5cd44 PB |
355 | numeric/logical types. See the implementations in trans-expr.c |
356 | for details of the individual functions. */ | |
6de9cd9a | 357 | |
6de9cd9a | 358 | void gfc_conv_expr (gfc_se * se, gfc_expr * expr); |
6de9cd9a | 359 | void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr); |
6de9cd9a | 360 | void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr); |
6de9cd9a | 361 | void gfc_conv_expr_reference (gfc_se * se, gfc_expr *); |
6de9cd9a | 362 | void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree); |
a4f5cd44 | 363 | |
e032c2a1 CR |
364 | /* trans-expr.c */ |
365 | void gfc_conv_scalar_char_value (gfc_symbol *sym, gfc_se *se, gfc_expr **expr); | |
d2886bc7 | 366 | tree gfc_string_to_single_character (tree len, tree str, int kind); |
e032c2a1 | 367 | |
ce2df7c6 FW |
368 | /* Find the decl containing the auxiliary variables for assigned variables. */ |
369 | void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr); | |
6de9cd9a | 370 | /* If the value is not constant, Create a temporary and copy the value. */ |
55bd9c35 | 371 | tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *); |
6de9cd9a DN |
372 | tree gfc_evaluate_now (tree, stmtblock_t *); |
373 | ||
166d08bd FXC |
374 | /* Find the appropriate variant of a math intrinsic. */ |
375 | tree gfc_builtin_decl_for_float_kind (enum built_in_function, int); | |
376 | ||
da661a58 TB |
377 | /* Intrinsic procedure handling. */ |
378 | tree gfc_conv_intrinsic_subroutine (gfc_code *); | |
6de9cd9a DN |
379 | void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *); |
380 | ||
712efae1 MM |
381 | /* Is the intrinsic expanded inline. */ |
382 | bool gfc_inline_intrinsic_function_p (gfc_expr *); | |
383 | ||
384 | /* Does an intrinsic map directly to an external library call | |
385 | This is true for array-returning intrinsics, unless | |
386 | gfc_inline_intrinsic_function_p returns true. */ | |
6de9cd9a | 387 | int gfc_is_intrinsic_libcall (gfc_expr *); |
b2a5eb75 | 388 | |
713485cc JW |
389 | /* Used to call ordinary functions/subroutines |
390 | and procedure pointer components. */ | |
391 | int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *, | |
989ea525 | 392 | gfc_expr *, VEC(tree,gc) *); |
d4feb3d3 | 393 | |
430f2d1f | 394 | void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool); |
d4feb3d3 | 395 | |
6de9cd9a DN |
396 | /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */ |
397 | ||
398 | /* Generate code for a scalar assignment. */ | |
2b56d6a4 TB |
399 | tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool, |
400 | bool); | |
6de9cd9a DN |
401 | |
402 | /* Translate COMMON blocks. */ | |
403 | void gfc_trans_common (gfc_namespace *); | |
404 | ||
f7b529fa | 405 | /* Translate a derived type constructor. */ |
6de9cd9a DN |
406 | void gfc_conv_structure (gfc_se *, gfc_expr *, int); |
407 | ||
408 | /* Return an expression which determines if a dummy parameter is present. */ | |
409 | tree gfc_conv_expr_present (gfc_symbol *); | |
e15e9be3 | 410 | /* Convert a missing, dummy argument into a null or zero. */ |
be9c3c6e | 411 | void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int); |
6de9cd9a DN |
412 | |
413 | /* Generate code to allocate a string temporary. */ | |
414 | tree gfc_conv_string_tmp (gfc_se *, tree, tree); | |
ca2940c3 TS |
415 | /* Get the string length variable belonging to an expression. */ |
416 | tree gfc_get_expr_charlen (gfc_expr *); | |
6de9cd9a | 417 | /* Initialize a string length variable. */ |
4b7f8314 | 418 | void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *); |
417ab240 JJ |
419 | /* Ensure type sizes can be gimplified. */ |
420 | void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *); | |
6de9cd9a DN |
421 | |
422 | /* Add an expression to the end of a block. */ | |
423 | void gfc_add_expr_to_block (stmtblock_t *, tree); | |
46b2c440 MM |
424 | /* Add an expression to the beginning of a block. */ |
425 | void gfc_prepend_expr_to_block (stmtblock_t *, tree); | |
6de9cd9a DN |
426 | /* Add a block to the end of a block. */ |
427 | void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *); | |
726a989a | 428 | /* Add a MODIFY_EXPR to a block. */ |
55bd9c35 | 429 | void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree); |
726a989a | 430 | void gfc_add_modify (stmtblock_t *, tree, tree); |
6de9cd9a DN |
431 | |
432 | /* Initialize a statement block. */ | |
433 | void gfc_init_block (stmtblock_t *); | |
69de3b83 | 434 | /* Start a new statement block. Like gfc_init_block but also starts a new |
6de9cd9a DN |
435 | variable scope. */ |
436 | void gfc_start_block (stmtblock_t *); | |
437 | /* Finish a statement block. Also closes the scope if the block was created | |
438 | with gfc_start_block. */ | |
439 | tree gfc_finish_block (stmtblock_t *); | |
440 | /* Merge the scope of a block with its parent. */ | |
441 | void gfc_merge_block_scope (stmtblock_t * block); | |
442 | ||
443 | /* Return the backend label decl. */ | |
444 | tree gfc_get_label_decl (gfc_st_label *); | |
445 | ||
446 | /* Return the decl for an external function. */ | |
447 | tree gfc_get_extern_function_decl (gfc_symbol *); | |
448 | ||
449 | /* Return the decl for a function. */ | |
450 | tree gfc_get_function_decl (gfc_symbol *); | |
451 | ||
6de9cd9a DN |
452 | /* Build an ADDR_EXPR. */ |
453 | tree gfc_build_addr_expr (tree, tree); | |
454 | ||
6de9cd9a | 455 | /* Build an ARRAY_REF. */ |
1d6b7f39 | 456 | tree gfc_build_array_ref (tree, tree, tree); |
6de9cd9a | 457 | |
49de9e73 | 458 | /* Creates a label. Decl is artificial if label_id == NULL_TREE. */ |
6de9cd9a DN |
459 | tree gfc_build_label_decl (tree); |
460 | ||
461 | /* Return the decl used to hold the function return value. | |
462 | Do not use if the function has an explicit result variable. */ | |
5f20c93a | 463 | tree gfc_get_fake_result_decl (gfc_symbol *, int); |
6de9cd9a | 464 | |
6de9cd9a DN |
465 | /* Add a decl to the binding level for the current function. */ |
466 | void gfc_add_decl_to_function (tree); | |
467 | ||
468 | /* Make prototypes for runtime library functions. */ | |
469 | void gfc_build_builtin_function_decls (void); | |
470 | ||
c8cc8542 PB |
471 | /* Set the backend source location of a decl. */ |
472 | void gfc_set_decl_location (tree, locus *); | |
473 | ||
0101807c PT |
474 | /* Get a module symbol backend_decl if possible. */ |
475 | bool gfc_get_module_backend_decl (gfc_symbol *); | |
476 | ||
6de9cd9a DN |
477 | /* Return the variable decl for a symbol. */ |
478 | tree gfc_get_symbol_decl (gfc_symbol *); | |
479 | ||
597073ac | 480 | /* Build a static initializer. */ |
1d0134b3 | 481 | tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool, bool); |
597073ac | 482 | |
f40eccb0 | 483 | /* Assign a default initializer to a derived type. */ |
0019d498 | 484 | void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool); |
f40eccb0 | 485 | |
7b5b57b7 PB |
486 | /* Substitute a temporary variable in place of the real one. */ |
487 | void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *); | |
488 | ||
489 | /* Restore the original variable. */ | |
490 | void gfc_restore_sym (gfc_symbol *, gfc_saved_var *); | |
491 | ||
43ce5e52 FXC |
492 | /* Setting a decl assembler name, mangling it according to target rules |
493 | (like Windows @NN decorations). */ | |
494 | void gfc_set_decl_assembler_name (tree, tree); | |
495 | ||
bae88af6 TS |
496 | /* Returns true if a variable of specified size should go on the stack. */ |
497 | int gfc_can_put_var_on_stack (tree); | |
498 | ||
69de3b83 | 499 | /* Allocate the lang-specific part of a decl node. */ |
6de9cd9a DN |
500 | void gfc_allocate_lang_decl (tree); |
501 | ||
502 | /* Advance along a TREE_CHAIN. */ | |
503 | tree gfc_advance_chain (tree, int); | |
504 | ||
505 | /* Create a decl for a function. */ | |
fb55ca75 | 506 | void gfc_create_function_decl (gfc_namespace *, bool); |
6de9cd9a DN |
507 | /* Generate the code for a function. */ |
508 | void gfc_generate_function_code (gfc_namespace *); | |
0de4325e TS |
509 | /* Output a BLOCK DATA program unit. */ |
510 | void gfc_generate_block_data (gfc_namespace *); | |
6de9cd9a DN |
511 | /* Output a decl for a module variable. */ |
512 | void gfc_generate_module_vars (gfc_namespace *); | |
d74d8807 DK |
513 | /* Get the appropriate return statement for a procedure. */ |
514 | tree gfc_generate_return (void); | |
6de9cd9a | 515 | |
d1b38208 | 516 | struct GTY(()) module_htab_entry { |
a64f5186 JJ |
517 | const char *name; |
518 | tree namespace_decl; | |
519 | htab_t GTY ((param_is (union tree_node))) decls; | |
520 | }; | |
521 | ||
522 | struct module_htab_entry *gfc_find_module (const char *); | |
523 | void gfc_module_add_decl (struct module_htab_entry *, tree); | |
524 | ||
6de9cd9a | 525 | /* Get and set the current location. */ |
363aab21 | 526 | void gfc_save_backend_locus (locus *); |
6de9cd9a | 527 | void gfc_set_backend_locus (locus *); |
363aab21 | 528 | void gfc_restore_backend_locus (locus *); |
6de9cd9a DN |
529 | |
530 | /* Handle static constructor functions. */ | |
531 | extern GTY(()) tree gfc_static_ctors; | |
532 | void gfc_generate_constructors (void); | |
533 | ||
636da744 | 534 | /* Get the string length of an array constructor. */ |
b7e75771 | 535 | bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *); |
636da744 | 536 | |
4f13e17f DC |
537 | /* Mark a condition as likely or unlikely. */ |
538 | tree gfc_likely (tree); | |
5af07930 TB |
539 | tree gfc_unlikely (tree); |
540 | ||
f25a62a5 DK |
541 | /* Generate a runtime error call. */ |
542 | tree gfc_trans_runtime_error (bool, locus*, const char*, ...); | |
f25a62a5 | 543 | |
0d52899f TB |
544 | /* Generate a runtime warning/error check. */ |
545 | void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *, | |
546 | const char *, ...); | |
6de9cd9a | 547 | |
fb5bc08b DK |
548 | /* Generate a runtime check for same string length. */ |
549 | void gfc_trans_same_strlen_check (const char*, locus*, tree, tree, | |
550 | stmtblock_t*); | |
551 | ||
1529b8d9 FXC |
552 | /* Generate a call to free() after checking that its arg is non-NULL. */ |
553 | tree gfc_call_free (tree); | |
554 | ||
555 | /* Allocate memory after performing a few checks. */ | |
556 | tree gfc_call_malloc (stmtblock_t *, tree, tree); | |
557 | ||
12f681a0 DK |
558 | /* Build a memcpy call. */ |
559 | tree gfc_build_memcpy_call (tree, tree, tree); | |
560 | ||
ea6363a3 | 561 | /* Allocate memory for allocatable variables, with optional status variable. */ |
979d4598 | 562 | void gfc_allocate_allocatable (stmtblock_t*, tree, tree, tree, |
8f992d64 | 563 | tree, tree, tree, gfc_expr*); |
4376b7cf FXC |
564 | |
565 | /* Allocate memory, with optional status variable. */ | |
4f13e17f | 566 | void gfc_allocate_using_malloc (stmtblock_t *, tree, tree, tree); |
4376b7cf FXC |
567 | |
568 | /* Generate code to deallocate an array. */ | |
f25a62a5 | 569 | tree gfc_deallocate_with_status (tree, tree, bool, gfc_expr*); |
2c807128 | 570 | tree gfc_deallocate_scalar_with_status (tree, tree, bool, gfc_expr*, gfc_typespec); |
4376b7cf FXC |
571 | |
572 | /* Generate code to call realloc(). */ | |
573 | tree gfc_call_realloc (stmtblock_t *, tree, tree); | |
574 | ||
1f2959f0 | 575 | /* Generate code for an assignment, includes scalarization. */ |
2b56d6a4 | 576 | tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool); |
6de9cd9a | 577 | |
49de9e73 | 578 | /* Generate code for a pointer assignment. */ |
6de9cd9a DN |
579 | tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *); |
580 | ||
581 | /* Initialize function decls for library functions. */ | |
582 | void gfc_build_intrinsic_lib_fndecls (void); | |
583 | /* Create function decls for IO library functions. */ | |
f96d606f | 584 | void gfc_trans_io_runtime_check (tree, tree, int, const char *, stmtblock_t *); |
6de9cd9a DN |
585 | void gfc_build_io_library_fndecls (void); |
586 | /* Build a function decl for a library function. */ | |
587 | tree gfc_build_library_function_decl (tree, tree, int, ...); | |
3f34855a TB |
588 | tree gfc_build_library_function_decl_with_spec (tree name, const char *spec, |
589 | tree rettype, int nargs, ...); | |
6de9cd9a | 590 | |
9abe5e56 | 591 | /* Process the local variable decls of a block construct. */ |
6312ef45 | 592 | void gfc_process_block_locals (gfc_namespace*); |
9abe5e56 DK |
593 | |
594 | /* Output initialization/clean-up code that was deferred. */ | |
d74d8807 | 595 | void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *); |
9abe5e56 | 596 | |
fb55ca75 | 597 | /* In f95-lang.c. */ |
6de9cd9a DN |
598 | tree pushdecl (tree); |
599 | tree pushdecl_top_level (tree); | |
600 | void pushlevel (int); | |
601 | tree poplevel (int, int, int); | |
602 | tree getdecls (void); | |
603 | tree gfc_truthvalue_conversion (tree); | |
c79efc4d | 604 | tree gfc_builtin_function (tree); |
fb55ca75 TB |
605 | |
606 | /* In trans-types.c. */ | |
fad0afd7 JJ |
607 | struct array_descr_info; |
608 | bool gfc_get_array_descr_info (const_tree, struct array_descr_info *); | |
6de9cd9a | 609 | |
6c7a4dfd | 610 | /* In trans-openmp.c */ |
58f9752a | 611 | bool gfc_omp_privatize_by_reference (const_tree); |
6c7a4dfd | 612 | enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree); |
79943d19 | 613 | tree gfc_omp_report_decl (tree); |
a68ab351 JJ |
614 | tree gfc_omp_clause_default_ctor (tree, tree, tree); |
615 | tree gfc_omp_clause_copy_ctor (tree, tree, tree); | |
616 | tree gfc_omp_clause_assign_op (tree, tree, tree); | |
617 | tree gfc_omp_clause_dtor (tree, tree); | |
6c7a4dfd JJ |
618 | bool gfc_omp_disregard_value_expr (tree, bool); |
619 | bool gfc_omp_private_debug_clause (tree, bool); | |
a68ab351 | 620 | bool gfc_omp_private_outer_ref (tree); |
6c7a4dfd JJ |
621 | struct gimplify_omp_ctx; |
622 | void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree); | |
623 | ||
6de9cd9a | 624 | /* Runtime library function decls. */ |
6de9cd9a DN |
625 | extern GTY(()) tree gfor_fndecl_pause_numeric; |
626 | extern GTY(()) tree gfor_fndecl_pause_string; | |
627 | extern GTY(()) tree gfor_fndecl_stop_numeric; | |
cea59ace | 628 | extern GTY(()) tree gfor_fndecl_stop_numeric_f08; |
6de9cd9a | 629 | extern GTY(()) tree gfor_fndecl_stop_string; |
6d1b0f92 | 630 | extern GTY(()) tree gfor_fndecl_error_stop_numeric; |
d0a4a61c | 631 | extern GTY(()) tree gfor_fndecl_error_stop_string; |
6de9cd9a | 632 | extern GTY(()) tree gfor_fndecl_runtime_error; |
f96d606f | 633 | extern GTY(()) tree gfor_fndecl_runtime_error_at; |
0d52899f | 634 | extern GTY(()) tree gfor_fndecl_runtime_warning_at; |
1529b8d9 | 635 | extern GTY(()) tree gfor_fndecl_os_error; |
f96d606f | 636 | extern GTY(()) tree gfor_fndecl_generate_error; |
944b8b35 | 637 | extern GTY(()) tree gfor_fndecl_set_fpe; |
68d2e027 | 638 | extern GTY(()) tree gfor_fndecl_set_options; |
25fc05eb | 639 | extern GTY(()) tree gfor_fndecl_ttynam; |
35059811 FXC |
640 | extern GTY(()) tree gfor_fndecl_ctime; |
641 | extern GTY(()) tree gfor_fndecl_fdate; | |
6de9cd9a DN |
642 | extern GTY(()) tree gfor_fndecl_in_pack; |
643 | extern GTY(()) tree gfor_fndecl_in_unpack; | |
644 | extern GTY(()) tree gfor_fndecl_associated; | |
645 | ||
60386f50 TB |
646 | |
647 | /* Coarray run-time library function decls. */ | |
648 | extern GTY(()) tree gfor_fndecl_caf_init; | |
649 | extern GTY(()) tree gfor_fndecl_caf_finalize; | |
b8ff4e88 | 650 | extern GTY(()) tree gfor_fndecl_caf_register; |
60386f50 TB |
651 | extern GTY(()) tree gfor_fndecl_caf_critical; |
652 | extern GTY(()) tree gfor_fndecl_caf_end_critical; | |
653 | extern GTY(()) tree gfor_fndecl_caf_sync_all; | |
654 | extern GTY(()) tree gfor_fndecl_caf_sync_images; | |
655 | extern GTY(()) tree gfor_fndecl_caf_error_stop; | |
656 | extern GTY(()) tree gfor_fndecl_caf_error_stop_str; | |
657 | ||
658 | /* Coarray global variables for num_images/this_image. */ | |
659 | extern GTY(()) tree gfort_gvar_caf_num_images; | |
660 | extern GTY(()) tree gfort_gvar_caf_this_image; | |
661 | ||
662 | ||
6de9cd9a DN |
663 | /* Math functions. Many other math functions are handled in |
664 | trans-intrinsic.c. */ | |
5b200ac2 | 665 | |
d1b38208 | 666 | typedef struct GTY(()) gfc_powdecl_list { |
5b200ac2 FW |
667 | tree integer; |
668 | tree real; | |
669 | tree cmplx; | |
670 | } | |
671 | gfc_powdecl_list; | |
672 | ||
644cb69f | 673 | extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3]; |
6de9cd9a DN |
674 | extern GTY(()) tree gfor_fndecl_math_ishftc4; |
675 | extern GTY(()) tree gfor_fndecl_math_ishftc8; | |
644cb69f | 676 | extern GTY(()) tree gfor_fndecl_math_ishftc16; |
6de9cd9a | 677 | |
5a0aad31 FXC |
678 | /* BLAS functions. */ |
679 | extern GTY(()) tree gfor_fndecl_sgemm; | |
680 | extern GTY(()) tree gfor_fndecl_dgemm; | |
681 | extern GTY(()) tree gfor_fndecl_cgemm; | |
682 | extern GTY(()) tree gfor_fndecl_zgemm; | |
683 | ||
6de9cd9a | 684 | /* String functions. */ |
6de9cd9a DN |
685 | extern GTY(()) tree gfor_fndecl_compare_string; |
686 | extern GTY(()) tree gfor_fndecl_concat_string; | |
687 | extern GTY(()) tree gfor_fndecl_string_len_trim; | |
688 | extern GTY(()) tree gfor_fndecl_string_index; | |
689 | extern GTY(()) tree gfor_fndecl_string_scan; | |
690 | extern GTY(()) tree gfor_fndecl_string_verify; | |
691 | extern GTY(()) tree gfor_fndecl_string_trim; | |
2263c775 | 692 | extern GTY(()) tree gfor_fndecl_string_minmax; |
6de9cd9a DN |
693 | extern GTY(()) tree gfor_fndecl_adjustl; |
694 | extern GTY(()) tree gfor_fndecl_adjustr; | |
d393bbd7 | 695 | extern GTY(()) tree gfor_fndecl_select_string; |
374929b2 FXC |
696 | extern GTY(()) tree gfor_fndecl_compare_string_char4; |
697 | extern GTY(()) tree gfor_fndecl_concat_string_char4; | |
698 | extern GTY(()) tree gfor_fndecl_string_len_trim_char4; | |
699 | extern GTY(()) tree gfor_fndecl_string_index_char4; | |
700 | extern GTY(()) tree gfor_fndecl_string_scan_char4; | |
701 | extern GTY(()) tree gfor_fndecl_string_verify_char4; | |
702 | extern GTY(()) tree gfor_fndecl_string_trim_char4; | |
703 | extern GTY(()) tree gfor_fndecl_string_minmax_char4; | |
704 | extern GTY(()) tree gfor_fndecl_adjustl_char4; | |
705 | extern GTY(()) tree gfor_fndecl_adjustr_char4; | |
d393bbd7 FXC |
706 | extern GTY(()) tree gfor_fndecl_select_string_char4; |
707 | ||
708 | /* Conversion between character kinds. */ | |
709 | extern GTY(()) tree gfor_fndecl_convert_char1_to_char4; | |
710 | extern GTY(()) tree gfor_fndecl_convert_char4_to_char1; | |
6de9cd9a DN |
711 | |
712 | /* Other misc. runtime library functions. */ | |
713 | extern GTY(()) tree gfor_fndecl_size0; | |
714 | extern GTY(()) tree gfor_fndecl_size1; | |
b41b2534 | 715 | extern GTY(()) tree gfor_fndecl_iargc; |
6de9cd9a | 716 | |
a39fafac FXC |
717 | /* Implemented in Fortran. */ |
718 | extern GTY(()) tree gfor_fndecl_sc_kind; | |
6de9cd9a DN |
719 | extern GTY(()) tree gfor_fndecl_si_kind; |
720 | extern GTY(()) tree gfor_fndecl_sr_kind; | |
721 | ||
722 | ||
723 | /* True if node is an integer constant. */ | |
724 | #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST) | |
725 | ||
fe4e525c TB |
726 | /* gfortran-specific declaration information, the _CONT versions denote |
727 | arrays with CONTIGUOUS attribute. */ | |
6de9cd9a | 728 | |
fad0afd7 JJ |
729 | enum gfc_array_kind |
730 | { | |
731 | GFC_ARRAY_UNKNOWN, | |
732 | GFC_ARRAY_ASSUMED_SHAPE, | |
fe4e525c | 733 | GFC_ARRAY_ASSUMED_SHAPE_CONT, |
fad0afd7 | 734 | GFC_ARRAY_ALLOCATABLE, |
fe4e525c TB |
735 | GFC_ARRAY_POINTER, |
736 | GFC_ARRAY_POINTER_CONT | |
fad0afd7 JJ |
737 | }; |
738 | ||
6de9cd9a | 739 | /* Array types only. */ |
a9429e29 LB |
740 | /* FIXME: the variable_size annotation here is needed because these types are |
741 | variable-sized in some other frontends. Due to gengtype deficiency the GTY | |
742 | options of such types have to agree across all frontends. */ | |
743 | struct GTY((variable_size)) lang_type { | |
a3935ffc | 744 | int rank, corank; |
fad0afd7 | 745 | enum gfc_array_kind akind; |
6de9cd9a DN |
746 | tree lbound[GFC_MAX_DIMENSIONS]; |
747 | tree ubound[GFC_MAX_DIMENSIONS]; | |
748 | tree stride[GFC_MAX_DIMENSIONS]; | |
749 | tree size; | |
750 | tree offset; | |
751 | tree dtype; | |
752 | tree dataptr_type; | |
de870512 | 753 | tree span; |
d560566a | 754 | tree base_decl[2]; |
b3c1b8a1 | 755 | tree nonrestricted_type; |
b8ff4e88 | 756 | tree caf_token; |
0c53708e | 757 | tree caf_offset; |
6de9cd9a DN |
758 | }; |
759 | ||
a9429e29 | 760 | struct GTY((variable_size)) lang_decl { |
6de9cd9a DN |
761 | /* Dummy variables. */ |
762 | tree saved_descriptor; | |
763 | /* Assigned integer nodes. Stringlength is the IO format string's length. | |
764 | Addr is the address of the string or the target label. Stringlength is | |
1f2959f0 | 765 | initialized to -2 and assigned to -1 when addr is assigned to the |
6de9cd9a DN |
766 | address of target label. */ |
767 | tree stringlen; | |
768 | tree addr; | |
1d6b7f39 | 769 | tree span; |
aa13dc3c TB |
770 | /* For assumed-shape coarrays. */ |
771 | tree token, caf_offset; | |
6de9cd9a DN |
772 | }; |
773 | ||
774 | ||
775 | #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr | |
776 | #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen | |
1d6b7f39 | 777 | #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span |
aa13dc3c TB |
778 | #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token |
779 | #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset | |
6de9cd9a DN |
780 | #define GFC_DECL_SAVED_DESCRIPTOR(node) \ |
781 | (DECL_LANG_SPECIFIC(node)->saved_descriptor) | |
782 | #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node) | |
783 | #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node) | |
784 | #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node) | |
6c7a4dfd JJ |
785 | #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node) |
786 | #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node) | |
787 | #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node) | |
1d6b7f39 | 788 | #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node) |
6de9cd9a DN |
789 | |
790 | /* An array descriptor. */ | |
791 | #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node) | |
792 | /* An array without a descriptor. */ | |
793 | #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node) | |
e1c82219 JJ |
794 | /* Fortran POINTER type. */ |
795 | #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node) | |
6de9cd9a DN |
796 | /* The GFC_TYPE_ARRAY_* members are present in both descriptor and |
797 | descriptorless array types. */ | |
798 | #define GFC_TYPE_ARRAY_LBOUND(node, dim) \ | |
799 | (TYPE_LANG_SPECIFIC(node)->lbound[dim]) | |
800 | #define GFC_TYPE_ARRAY_UBOUND(node, dim) \ | |
801 | (TYPE_LANG_SPECIFIC(node)->ubound[dim]) | |
802 | #define GFC_TYPE_ARRAY_STRIDE(node, dim) \ | |
803 | (TYPE_LANG_SPECIFIC(node)->stride[dim]) | |
804 | #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank) | |
a3935ffc | 805 | #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank) |
b8ff4e88 | 806 | #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token) |
0c53708e | 807 | #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset) |
6de9cd9a DN |
808 | #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size) |
809 | #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset) | |
fad0afd7 | 810 | #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind) |
df2fba9e | 811 | /* Code should use gfc_get_dtype instead of accessing this directly. It may |
40b026d8 | 812 | not be known when the type is created. */ |
6de9cd9a DN |
813 | #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype) |
814 | #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \ | |
815 | (TYPE_LANG_SPECIFIC(node)->dataptr_type) | |
de870512 | 816 | #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span) |
d560566a AO |
817 | #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \ |
818 | (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)]) | |
6de9cd9a | 819 | |
5d44e5c8 | 820 | |
6de9cd9a | 821 | /* Build an expression with void type. */ |
5d44e5c8 TB |
822 | #define build1_v(code, arg) \ |
823 | fold_build1_loc (input_location, code, void_type_node, arg) | |
824 | #define build2_v(code, arg1, arg2) \ | |
825 | fold_build2_loc (input_location, code, void_type_node, arg1, arg2) | |
826 | #define build3_v(code, arg1, arg2, arg3) \ | |
827 | fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3) | |
828 | #define build4_v(code, arg1, arg2, arg3, arg4) \ | |
829 | build4_loc (input_location, code, void_type_node, arg1, arg2, \ | |
830 | arg3, arg4) | |
62ab4a54 RS |
831 | |
832 | /* This group of functions allows a caller to evaluate an expression from | |
833 | the callee's interface. It establishes a mapping between the interface's | |
834 | dummy arguments and the caller's actual arguments, then applies that | |
835 | mapping to a given gfc_expr. | |
836 | ||
837 | You can initialize a mapping structure like so: | |
838 | ||
839 | gfc_interface_mapping mapping; | |
840 | ... | |
841 | gfc_init_interface_mapping (&mapping); | |
842 | ||
843 | You should then evaluate each actual argument into a temporary | |
844 | gfc_se structure, here called "se", and map the result to the | |
845 | dummy argument's symbol, here called "sym": | |
846 | ||
847 | gfc_add_interface_mapping (&mapping, sym, &se); | |
848 | ||
849 | After adding all mappings, you should call: | |
850 | ||
851 | gfc_finish_interface_mapping (&mapping, pre, post); | |
852 | ||
853 | where "pre" and "post" are statement blocks for initialization | |
854 | and finalization code respectively. You can then evaluate an | |
855 | interface expression "expr" as follows: | |
856 | ||
857 | gfc_apply_interface_mapping (&mapping, se, expr); | |
858 | ||
859 | Once you've evaluated all expressions, you should free | |
860 | the mapping structure with: | |
861 | ||
862 | gfc_free_interface_mapping (&mapping); */ | |
863 | ||
864 | ||
865 | /* This structure represents a mapping from OLD to NEW, where OLD is a | |
866 | dummy argument symbol and NEW is a symbol that represents the value | |
867 | of an actual argument. Mappings are linked together using NEXT | |
868 | (in no particular order). */ | |
869 | typedef struct gfc_interface_sym_mapping | |
870 | { | |
871 | struct gfc_interface_sym_mapping *next; | |
872 | gfc_symbol *old; | |
7b901ac4 | 873 | gfc_symtree *new_sym; |
0a164a3c | 874 | gfc_expr *expr; |
62ab4a54 RS |
875 | } |
876 | gfc_interface_sym_mapping; | |
877 | ||
878 | ||
879 | /* This structure is used by callers to evaluate an expression from | |
880 | a callee's interface. */ | |
881 | typedef struct gfc_interface_mapping | |
882 | { | |
883 | /* Maps the interface's dummy arguments to the values that the caller | |
884 | is passing. The whole list is owned by this gfc_interface_mapping. */ | |
885 | gfc_interface_sym_mapping *syms; | |
886 | ||
887 | /* A list of gfc_charlens that were needed when creating copies of | |
888 | expressions. The whole list is owned by this gfc_interface_mapping. */ | |
889 | gfc_charlen *charlens; | |
890 | } | |
891 | gfc_interface_mapping; | |
892 | ||
893 | void gfc_init_interface_mapping (gfc_interface_mapping *); | |
894 | void gfc_free_interface_mapping (gfc_interface_mapping *); | |
895 | void gfc_add_interface_mapping (gfc_interface_mapping *, | |
0a164a3c | 896 | gfc_symbol *, gfc_se *, gfc_expr *); |
62ab4a54 RS |
897 | void gfc_finish_interface_mapping (gfc_interface_mapping *, |
898 | stmtblock_t *, stmtblock_t *); | |
899 | void gfc_apply_interface_mapping (gfc_interface_mapping *, | |
900 | gfc_se *, gfc_expr *); | |
901 | ||
dd18a33b FXC |
902 | |
903 | /* Standard error messages used in all the trans-*.c files. */ | |
7e49f965 TS |
904 | extern const char gfc_msg_fault[]; |
905 | extern const char gfc_msg_wrong_return[]; | |
dd18a33b | 906 | |
34d01e1d VL |
907 | #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */ |
908 | #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare | |
909 | construct is not workshared. */ | |
910 | #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt | |
911 | to create parallel loops. */ | |
912 | #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */ | |
913 | extern int ompws_flags; | |
dd18a33b | 914 | |
6de9cd9a | 915 | #endif /* GFC_TRANS_H */ |