1 /* Header for code translation functions
2 Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
3 Contributed by Paul Brook
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
25 /* Mangled symbols take the form __module__name. */
26 #define GFC_MAX_MANGLED_SYMBOL_LEN (GFC_MAX_SYMBOL_LEN*2+4)
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. */
34 unsigned int has_scope:1;
38 /* a simplified expression */
41 /* Code blocks to be executed before and after using the value. */
45 /* the result of the expression */
48 /* The length of a character string value. */
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;
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.
61 unsigned want_pointer:1;
63 /* An array function call returning without a temporary. Also used for array
64 pointer assignments. */
65 unsigned direct_byref:1;
67 /* Ignore absent optional arguments. Used for some intrinsics. */
68 unsigned ignore_optional:1;
70 /* Scalarization parameters. */
71 struct gfc_se *parent;
73 struct gfc_loopinfo *loop;
78 /* Scalarisation State chain. Created by walking an expression tree before
79 creating the scalarization loops. Then passed as part of a gfc_se structure
80 to translate the expression inside the loop. Note that these chains are
81 terminated by gfc_se_terminator, not NULL. A NULL pointer in a gfc_se
82 indicates to gfc_conv_* that this is a scalar expression.
83 Note that some member arrays correspond to scalarizer rank and others
84 are the variable rank. */
86 typedef struct gfc_ss_info
89 /* The ref that holds information on this section. */
91 /* The descriptor of this array. */
93 /* holds the pointer to the data array. */
95 /* To move some of the array index calculation out of the innermost loop. */
99 /* Holds the SS for a subscript. Indexed by actual dimension. */
100 struct gfc_ss *subscript[GFC_MAX_DIMENSIONS];
102 /* stride and delta are used to access this inside a scalarization loop.
103 start is used in the calculation of these. Indexed by scalarizer
105 tree start[GFC_MAX_DIMENSIONS];
106 tree stride[GFC_MAX_DIMENSIONS];
107 tree delta[GFC_MAX_DIMENSIONS];
109 /* Translation from scalariser dimensions to actual dimensions.
110 actual = dim[scalarizer] */
111 int dim[GFC_MAX_DIMENSIONS];
117 /* A scalar value. This will be evaluated before entering the
118 scalarization loop. */
121 /* Like GFC_SS_SCALAR except it evaluates a pointer the the expression.
122 Used for elemental function parameters. */
125 /* An array section. Scalarization indices will be substituted during
126 expression translation. */
129 /* A non-elemental function call returning an array. The call is executed
130 before entering the scalarization loop, storing the result in a
131 temporary. This temporary is then used inside the scalarization loop.
132 Simple assignments, eg. a(:) = fn() are handles without a temporary
133 as a special case. */
136 /* An array constructor. The current implementation is sub-optimal in
137 many cases. It allocated a temporary, assigns the values to it, then
138 uses this temporary inside the scalarization loop. */
141 /* A vector subscript. Only used as the SS chain for a subscript.
142 Similar int format to a GFC_SS_SECTION. */
145 /* A temporary array allocated by the scalarizer. Its rank can be less
146 than that of the assignment expression. */
149 /* An intrinsic function call. Many intrinsic functions which map directly
150 to library calls are created as GFC_SS_FUNCTION nodes. */
153 /* A component of a derived type. */
158 /* SS structures can only belong to a single loopinfo. They must be added
159 otherwise they will not get freed. */
160 typedef struct gfc_ss
168 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
178 /* The rank of the temporary. May be less than the rank of the
179 assigned expression. */
184 /* All other types. */
189 /* All the SS in a loop and linked through loop_chain. The SS for an
190 expression are linked by the next pointer. */
191 struct gfc_ss *loop_chain;
194 /* This is used by assignments requiring teporaries. The bits specify which
195 loops the terms appear in. This will be 1 for the RHS expressions,
196 2 for the LHS expressions, and 3(=1|2) for the temporary. */
200 #define gfc_get_ss() gfc_getmem(sizeof(gfc_ss))
202 /* The contents of this aren't actually used. A NULL SS chain indicates a
203 scalar expression, so this pointer is used to terminate SS chains. */
204 extern gfc_ss * const gfc_ss_terminator;
206 /* Holds information about an expression while it is being scalarized. */
207 typedef struct gfc_loopinfo
214 /* All the SS involved with this loop. */
216 /* The SS describing the teporary used in an assignment. */
219 /* The scalarization loop index variables. */
220 tree loopvar[GFC_MAX_DIMENSIONS];
222 /* The bounds of the scalarization loops. */
223 tree from[GFC_MAX_DIMENSIONS];
224 tree to[GFC_MAX_DIMENSIONS];
225 gfc_ss *specloop[GFC_MAX_DIMENSIONS];
227 /* The code member contains the code for the body of the next outer loop. */
228 stmtblock_t code[GFC_MAX_DIMENSIONS];
230 /* Order in which the dimensions should be looped, innermost first. */
231 int order[GFC_MAX_DIMENSIONS];
233 /* The number of dimensions for which a temporary is used. */
236 /* If set we don't need the loop variables. */
237 unsigned array_parameter:1;
242 /* Information about a symbol that has been shadowed by a temporary. */
245 symbol_attribute attr;
251 /* Advance the SS chain to the next term. */
252 void gfc_advance_se_ss_chain (gfc_se *);
254 /* Call this to initialise a gfc_se structure before use
255 first parameter is structure to initialise, second is
256 parent to get scalarization data from, or NULL. */
257 void gfc_init_se (gfc_se *, gfc_se *);
259 /* Create an artificial variable decl and add it to the current scope. */
260 tree gfc_create_var (tree, const char *);
261 /* Like above but doesn't add it to the current scope. */
262 tree gfc_create_var_np (tree, const char *);
264 /* Store the result of an expression in a temp variable so it can be used
265 repeatedly even if the original changes */
266 void gfc_make_safe_expr (gfc_se * se);
268 /* Makes sure se is suitable for passing as a function string parameter. */
269 void gfc_conv_string_parameter (gfc_se * se);
271 /* Add an item to the end of TREE_LIST. */
272 tree gfc_chainon_list (tree, tree);
274 /* When using the gfc_conv_* make sure you understand what they do, i.e.
275 when a POST chain may be created, and what the retured expression may be
276 used for. Note that character strings have special handling. This
277 should not be a problem as most statements/operations only deal with
278 numeric/logical types. */
280 /* Entry point for expression translation. */
281 void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
282 /* Like gfc_conv_expr, but the POST block is guaranteed to be empty for
283 numeric expressions. */
284 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
285 /* Like gfc_conv_expr_val, but the value is also suitable for use in the lhs of
287 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
288 /* Converts an expression so that it can be passed be reference. */
289 void gfc_conv_expr_reference (gfc_se * se, gfc_expr *);
290 /* Equivalent to convert(type, gfc_conv_expr_val(se, expr)). */
291 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
292 /* If the value is not constant, Create a temporary and copy the value. */
293 tree gfc_evaluate_now (tree, stmtblock_t *);
295 /* Intrinsic function handling. */
296 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
298 /* Does an intrinsic map directly to an external library call. */
299 int gfc_is_intrinsic_libcall (gfc_expr *);
301 /* Also used to CALL subroutines. */
302 void gfc_conv_function_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *);
303 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
305 /* Generate code for a scalar assignment. */
306 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, bt);
308 /* Translate COMMON blocks. */
309 void gfc_trans_common (gfc_namespace *);
311 /* Translate a derived type constructor. */
312 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
314 /* Return an expression which determines if a dummy parameter is present. */
315 tree gfc_conv_expr_present (gfc_symbol *);
317 /* Generate code to allocate a string temporary. */
318 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
319 /* Get the string length variable belonging to an expression. */
320 tree gfc_get_expr_charlen (gfc_expr *);
321 /* Initialize a string length variable. */
322 void gfc_trans_init_string_length (gfc_charlen *, stmtblock_t *);
324 /* Add an expression to the end of a block. */
325 void gfc_add_expr_to_block (stmtblock_t *, tree);
326 /* Add a block to the end of a block. */
327 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
328 /* Add a MODIFY_EXPR to a block. */
329 void gfc_add_modify_expr (stmtblock_t *, tree, tree);
331 /* Initialize a statement block. */
332 void gfc_init_block (stmtblock_t *);
333 /* Start a new satement block. Like gfc_init_block but also starts a new
335 void gfc_start_block (stmtblock_t *);
336 /* Finish a statement block. Also closes the scope if the block was created
337 with gfc_start_block. */
338 tree gfc_finish_block (stmtblock_t *);
339 /* Merge the scope of a block with its parent. */
340 void gfc_merge_block_scope (stmtblock_t * block);
342 /* Return the backend label decl. */
343 tree gfc_get_label_decl (gfc_st_label *);
345 /* Return the decl for an external function. */
346 tree gfc_get_extern_function_decl (gfc_symbol *);
348 /* Return the decl for a function. */
349 tree gfc_get_function_decl (gfc_symbol *);
351 /* Build a CALL_EXPR. */
352 tree gfc_build_function_call (tree, tree);
354 /* Build an ADDR_EXPR. */
355 tree gfc_build_addr_expr (tree, tree);
357 /* Build an INDIRECT_REF. */
358 tree gfc_build_indirect_ref (tree);
360 /* Build an ARRAY_REF. */
361 tree gfc_build_array_ref (tree, tree);
363 /* Creates an label. Decl is artificial if label_id == NULL_TREE. */
364 tree gfc_build_label_decl (tree);
366 /* Return the decl used to hold the function return value.
367 Do not use if the function has an explicit result variable. */
368 tree gfc_get_fake_result_decl (gfc_symbol *);
370 /* Get the return label for the current function. */
371 tree gfc_get_return_label (void);
373 /* Add a decl to the binding level for the current function. */
374 void gfc_add_decl_to_function (tree);
376 /* Make prototypes for runtime library functions. */
377 void gfc_build_builtin_function_decls (void);
379 /* Set the backend source location of a decl. */
380 void gfc_set_decl_location (tree, locus *);
382 /* Return the variable decl for a symbol. */
383 tree gfc_get_symbol_decl (gfc_symbol *);
385 /* Build a static initializer. */
386 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool);
388 /* Substitute a temporary variable in place of the real one. */
389 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
391 /* Restore the original variable. */
392 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
394 /* Allocate the lang-spcific part of a decl node. */
395 void gfc_allocate_lang_decl (tree);
397 /* Advance along a TREE_CHAIN. */
398 tree gfc_advance_chain (tree, int);
400 /* Create a decl for a function. */
401 void gfc_create_function_decl (gfc_namespace *);
402 /* Generate the code for a function. */
403 void gfc_generate_function_code (gfc_namespace *);
404 /* Output a BLOCK DATA program unit. */
405 void gfc_generate_block_data (gfc_namespace *);
406 /* Output a decl for a module variable. */
407 void gfc_generate_module_vars (gfc_namespace *);
409 /* Get and set the current location. */
410 void gfc_set_backend_locus (locus *);
411 void gfc_get_backend_locus (locus *);
413 /* Handle static constructor functions. */
414 extern GTY(()) tree gfc_static_ctors;
415 void gfc_generate_constructors (void);
417 /* Generate a runtime error check. */
418 void gfc_trans_runtime_check (tree, tree, stmtblock_t *);
420 /* Generate code for an assignment, includes scalarization. */
421 tree gfc_trans_assignment (gfc_expr *, gfc_expr *);
423 /* Generate code for an pointer assignment. */
424 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
426 /* Initialize function decls for library functions. */
427 void gfc_build_intrinsic_lib_fndecls (void);
428 /* Create function decls for IO library functions. */
429 void gfc_build_io_library_fndecls (void);
430 /* Build a function decl for a library function. */
431 tree gfc_build_library_function_decl (tree, tree, int, ...);
434 tree pushdecl (tree);
435 tree pushdecl_top_level (tree);
436 void pushlevel (int);
437 tree poplevel (int, int, int);
438 tree getdecls (void);
439 tree gfc_truthvalue_conversion (tree);
440 tree builtin_function (const char *, tree, int, enum built_in_class,
443 /* Runtime library function decls. */
444 extern GTY(()) tree gfor_fndecl_internal_malloc;
445 extern GTY(()) tree gfor_fndecl_internal_malloc64;
446 extern GTY(()) tree gfor_fndecl_internal_free;
447 extern GTY(()) tree gfor_fndecl_allocate;
448 extern GTY(()) tree gfor_fndecl_allocate64;
449 extern GTY(()) tree gfor_fndecl_deallocate;
450 extern GTY(()) tree gfor_fndecl_pause_numeric;
451 extern GTY(()) tree gfor_fndecl_pause_string;
452 extern GTY(()) tree gfor_fndecl_stop_numeric;
453 extern GTY(()) tree gfor_fndecl_stop_string;
454 extern GTY(()) tree gfor_fndecl_select_string;
455 extern GTY(()) tree gfor_fndecl_runtime_error;
456 extern GTY(()) tree gfor_fndecl_in_pack;
457 extern GTY(()) tree gfor_fndecl_in_unpack;
458 extern GTY(()) tree gfor_fndecl_associated;
460 /* Math functions. Many other math functions are handled in
461 trans-intrinsic.c. */
463 typedef struct gfc_powdecl_list GTY(())
471 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[3][2];
472 extern GTY(()) tree gfor_fndecl_math_cpowf;
473 extern GTY(()) tree gfor_fndecl_math_cpow;
474 extern GTY(()) tree gfor_fndecl_math_ishftc4;
475 extern GTY(()) tree gfor_fndecl_math_ishftc8;
476 extern GTY(()) tree gfor_fndecl_math_exponent4;
477 extern GTY(()) tree gfor_fndecl_math_exponent8;
479 /* String functions. */
480 extern GTY(()) tree gfor_fndecl_copy_string;
481 extern GTY(()) tree gfor_fndecl_compare_string;
482 extern GTY(()) tree gfor_fndecl_concat_string;
483 extern GTY(()) tree gfor_fndecl_string_len_trim;
484 extern GTY(()) tree gfor_fndecl_string_index;
485 extern GTY(()) tree gfor_fndecl_string_scan;
486 extern GTY(()) tree gfor_fndecl_string_verify;
487 extern GTY(()) tree gfor_fndecl_string_trim;
488 extern GTY(()) tree gfor_fndecl_string_repeat;
489 extern GTY(()) tree gfor_fndecl_adjustl;
490 extern GTY(()) tree gfor_fndecl_adjustr;
492 /* Other misc. runtime library functions. */
493 extern GTY(()) tree gfor_fndecl_size0;
494 extern GTY(()) tree gfor_fndecl_size1;
495 extern GTY(()) tree gfor_fndecl_iargc;
497 /* Implemented in FORTRAN. */
498 extern GTY(()) tree gfor_fndecl_si_kind;
499 extern GTY(()) tree gfor_fndecl_sr_kind;
502 /* True if node is an integer constant. */
503 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
505 /* G95-specific declaration information. */
507 /* Array types only. */
508 struct lang_type GTY(())
511 tree lbound[GFC_MAX_DIMENSIONS];
512 tree ubound[GFC_MAX_DIMENSIONS];
513 tree stride[GFC_MAX_DIMENSIONS];
520 struct lang_decl GTY(())
522 /* Dummy variables. */
523 tree saved_descriptor;
524 /* Assigned integer nodes. Stringlength is the IO format string's length.
525 Addr is the address of the string or the target label. Stringlength is
526 initialized to -2 and assigned to -1 when addr is assigned to the
527 address of target label. */
533 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
534 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
535 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
536 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
537 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
538 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
539 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
541 /* An array descriptor. */
542 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
543 /* An array without a descriptor. */
544 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
545 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
546 descriptorless array types. */
547 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
548 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
549 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
550 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
551 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
552 (TYPE_LANG_SPECIFIC(node)->stride[dim])
553 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
554 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
555 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
556 /* Code should use gfc_get_dtype instead of accesig this directly. It may
557 not be known when the type is created. */
558 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
559 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
560 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
562 /* I changed this from sorry(...) because it should not return. */
563 /* TODO: Remove gfc_todo_error before releasing version 1.0. */
564 #define gfc_todo_error(args...) fatal_error("gfc_todo: Not Implemented: " args)
566 /* Build an expression with void type. */
567 #define build1_v(code, arg) build(code, void_type_node, arg)
568 #define build2_v(code, arg1, arg2) build2(code, void_type_node, \
570 #define build3_v(code, arg1, arg2, arg3) build3(code, void_type_node, \
573 /* flag for alternative return labels. */
574 extern int has_alternate_specifier; /* for caller */
575 #endif /* GFC_TRANS_H */