1 /* Header for code translation functions 2 Copyright (C) 2002-2016 Free Software Foundation, Inc. 3 Contributed by Paul Brook 4 5 This file is part of GCC. 6 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 3, or (at your option) any later 10 version. 11 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 15 for more details. 16 17 You should have received a copy of the GNU General Public License 18 along with GCC; see the file COPYING3. If not see 19 <http://www.gnu.org/licenses/>. */ 20 21 #ifndef GFC_TRANS_H 22 #define GFC_TRANS_H 23 24 #include "predict.h" /* For enum br_predictor and PRED_*. */ 25 26 /* Mangled symbols take the form __module__name. */ 27 #define GFC_MAX_MANGLED_SYMBOL_LEN (GFC_MAX_SYMBOL_LEN*2+4) 28 29 /* Struct for holding a block of statements. It should be treated as an 30 opaque entity and not modified directly. This allows us to change the 31 underlying representation of statement lists. */ 32 typedef struct 33 { 34 tree head; 35 unsigned int has_scope:1; 36 } 37 stmtblock_t; 38 39 /* a simplified expression */ 40 typedef struct gfc_se 41 { 42 /* Code blocks to be executed before and after using the value. */ 43 stmtblock_t pre; 44 stmtblock_t post; 45 46 /* the result of the expression */ 47 tree expr; 48 49 /* The length of a character string value. */ 50 tree string_length; 51 52 /* When expr is a reference to a class object, store its vptr access 53 here. */ 54 tree class_vptr; 55 56 /* If set gfc_conv_variable will return an expression for the array 57 descriptor. When set, want_pointer should also be set. 58 If not set scalarizing variables will be substituted. */ 59 unsigned descriptor_only:1; 60 61 /* When this is set gfc_conv_expr returns the address of a variable. Only 62 applies to EXPR_VARIABLE nodes. 63 Also used by gfc_conv_array_parameter. When set this indicates a pointer 64 to the descriptor should be returned, rather than the descriptor itself. 65 */ 66 unsigned want_pointer:1; 67 68 /* An array function call returning without a temporary. Also used for array 69 pointer assignments. */ 70 unsigned direct_byref:1; 71 72 /* If direct_byref is set, do work out the descriptor as in that case but 73 do still create a new descriptor variable instead of using an 74 existing one. This is useful for special pointer assignments like 75 rank remapping where we have to process the descriptor before 76 assigning to final one. */ 77 unsigned byref_noassign:1; 78 79 /* Ignore absent optional arguments. Used for some intrinsics. */ 80 unsigned ignore_optional:1; 81 82 /* When this is set the data and offset fields of the returned descriptor 83 are NULL. Used by intrinsic size. */ 84 unsigned data_not_needed:1; 85 86 /* If set, gfc_conv_procedure_call does not put byref calls into se->pre. */ 87 unsigned no_function_call:1; 88 89 /* If set, we will force the creation of a temporary. Useful to disable 90 non-copying procedure argument passing optimizations, when some function 91 args alias. */ 92 unsigned force_tmp:1; 93 94 /* Unconditionally calculate offset for array segments and constant 95 arrays in gfc_conv_expr_descriptor. */ 96 unsigned use_offset:1; 97 98 unsigned want_coarray:1; 99 100 /* Scalarization parameters. */ 101 struct gfc_se *parent; 102 struct gfc_ss *ss; 103 struct gfc_loopinfo *loop; 104 } 105 gfc_se; 106 107 108 /* Denotes different types of coarray. 109 Please keep in sync with libgfortran/caf/libcaf.h. */ 110 enum gfc_coarray_type 111 { 112 GFC_CAF_COARRAY_STATIC, 113 GFC_CAF_COARRAY_ALLOC, 114 GFC_CAF_LOCK_STATIC, 115 GFC_CAF_LOCK_ALLOC, 116 GFC_CAF_CRITICAL, 117 GFC_CAF_EVENT_STATIC, 118 GFC_CAF_EVENT_ALLOC 119 }; 120 121 122 /* The array-specific scalarization information. The array members of 123 this struct are indexed by actual array index, and thus can be sparse. */ 124 125 typedef struct gfc_array_info 126 { 127 mpz_t *shape; 128 129 /* The ref that holds information on this section. */ 130 gfc_ref *ref; 131 /* The descriptor of this array. */ 132 tree descriptor; 133 /* holds the pointer to the data array. */ 134 tree data; 135 /* To move some of the array index calculation out of the innermost loop. */ 136 tree offset; 137 tree saved_offset; 138 tree stride0; 139 /* Holds the SS for a subscript. Indexed by actual dimension. */ 140 struct gfc_ss *subscript[GFC_MAX_DIMENSIONS]; 141 142 /* stride and delta are used to access this inside a scalarization loop. 143 start is used in the calculation of these. Indexed by scalarizer 144 dimension. */ 145 tree start[GFC_MAX_DIMENSIONS]; 146 tree end[GFC_MAX_DIMENSIONS]; 147 tree stride[GFC_MAX_DIMENSIONS]; 148 tree delta[GFC_MAX_DIMENSIONS]; 149 } 150 gfc_array_info; 151 152 enum gfc_ss_type 153 { 154 /* A scalar value. This will be evaluated before entering the 155 scalarization loop. */ 156 GFC_SS_SCALAR, 157 158 /* Like GFC_SS_SCALAR it evaluates the expression outside the 159 loop. Is always evaluated as a reference to the temporary, unless 160 temporary evaluation can result in a NULL pointer dereferencing (case of 161 optional arguments). Used for elemental function arguments. */ 162 GFC_SS_REFERENCE, 163 164 /* An array section. Scalarization indices will be substituted during 165 expression translation. */ 166 GFC_SS_SECTION, 167 168 /* A non-elemental function call returning an array. The call is executed 169 before entering the scalarization loop, storing the result in a 170 temporary. This temporary is then used inside the scalarization loop. 171 Simple assignments, e.g. a(:) = fn(), are handled without a temporary 172 as a special case. */ 173 GFC_SS_FUNCTION, 174 175 /* An array constructor. The current implementation is sub-optimal in 176 many cases. It allocated a temporary, assigns the values to it, then 177 uses this temporary inside the scalarization loop. */ 178 GFC_SS_CONSTRUCTOR, 179 180 /* A vector subscript. The vector's descriptor is cached in the 181 "descriptor" field of the associated gfc_ss_info. */ 182 GFC_SS_VECTOR, 183 184 /* A temporary array allocated by the scalarizer. Its rank can be less 185 than that of the assignment expression. */ 186 GFC_SS_TEMP, 187 188 /* An intrinsic function call. Many intrinsic functions which map directly 189 to library calls are created as GFC_SS_FUNCTION nodes. */ 190 GFC_SS_INTRINSIC, 191 192 /* A component of a derived type. */ 193 GFC_SS_COMPONENT 194 }; 195 196 197 typedef struct gfc_ss_info 198 { 199 int refcount; 200 gfc_ss_type type; 201 gfc_expr *expr; 202 tree string_length; 203 204 union 205 { 206 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */ 207 struct 208 { 209 /* If the scalar is passed as actual argument to an (elemental) procedure, 210 this is the symbol of the corresponding dummy argument. */ 211 gfc_symbol *dummy_arg; 212 tree value; 213 /* Tells that the scalar is a reference to a variable that might 214 be present on the lhs, so that we should evaluate the value 215 itself before the loop, not just the reference. */ 216 unsigned needs_temporary:1; 217 } 218 scalar; 219 220 /* GFC_SS_TEMP. */ 221 struct 222 { 223 tree type; 224 } 225 temp; 226 227 /* All other types. */ 228 gfc_array_info array; 229 } 230 data; 231 232 /* This is used by assignments requiring temporaries. The bits specify which 233 loops the terms appear in. This will be 1 for the RHS expressions, 234 2 for the LHS expressions, and 3(=1|2) for the temporary. */ 235 unsigned useflags:2; 236 237 /* Suppresses precalculation of scalars in WHERE assignments. */ 238 unsigned where:1; 239 240 /* This set for an elemental function that contains expressions for 241 external arrays, thereby triggering creation of a temporary. */ 242 unsigned array_outer_dependency:1; 243 244 /* Tells whether the SS is for an actual argument which can be a NULL 245 reference. In other words, the associated dummy argument is OPTIONAL. 246 Used to handle elemental procedures. */ 247 bool can_be_null_ref; 248 } 249 gfc_ss_info; 250 251 #define gfc_get_ss_info() XCNEW (gfc_ss_info) 252 253 254 /* Scalarization State chain. Created by walking an expression tree before 255 creating the scalarization loops. Then passed as part of a gfc_se structure 256 to translate the expression inside the loop. Note that these chains are 257 terminated by gfc_ss_terminator, not NULL. A NULL pointer in a gfc_se 258 indicates to gfc_conv_* that this is a scalar expression. 259 SS structures can only belong to a single loopinfo. They must be added 260 otherwise they will not get freed. */ 261 262 typedef struct gfc_ss 263 { 264 gfc_ss_info *info; 265 266 int dimen; 267 /* Translation from loop dimensions to actual array dimensions. 268 actual_dim = dim[loop_dim] */ 269 int dim[GFC_MAX_DIMENSIONS]; 270 271 /* All the SS in a loop and linked through loop_chain. The SS for an 272 expression are linked by the next pointer. */ 273 struct gfc_ss *loop_chain; 274 struct gfc_ss *next; 275 276 /* Non-null if the ss is part of a nested loop. */ 277 struct gfc_ss *parent; 278 279 /* If the evaluation of an expression requires a nested loop (for example 280 if the sum intrinsic is evaluated inline), this points to the nested 281 loop's gfc_ss. */ 282 struct gfc_ss *nested_ss; 283 284 /* The loop this gfc_ss is in. */ 285 struct gfc_loopinfo *loop; 286 287 unsigned is_alloc_lhs:1; 288 } 289 gfc_ss; 290 #define gfc_get_ss() XCNEW (gfc_ss) 291 292 /* The contents of this aren't actually used. A NULL SS chain indicates a 293 scalar expression, so this pointer is used to terminate SS chains. */ 294 extern gfc_ss * const gfc_ss_terminator; 295 296 /* Holds information about an expression while it is being scalarized. */ 297 typedef struct gfc_loopinfo 298 { 299 stmtblock_t pre; 300 stmtblock_t post; 301 302 int dimen; 303 304 /* All the SS involved with this loop. */ 305 gfc_ss *ss; 306 /* The SS describing the temporary used in an assignment. */ 307 gfc_ss *temp_ss; 308 309 /* Non-null if this loop is nested in another one. */ 310 struct gfc_loopinfo *parent; 311 312 /* Chain of nested loops. */ 313 struct gfc_loopinfo *nested, *next; 314 315 /* The scalarization loop index variables. */ 316 tree loopvar[GFC_MAX_DIMENSIONS]; 317 318 /* The bounds of the scalarization loops. */ 319 tree from[GFC_MAX_DIMENSIONS]; 320 tree to[GFC_MAX_DIMENSIONS]; 321 gfc_ss *specloop[GFC_MAX_DIMENSIONS]; 322 323 /* The code member contains the code for the body of the next outer loop. */ 324 stmtblock_t code[GFC_MAX_DIMENSIONS]; 325 326 /* Order in which the dimensions should be looped, innermost first. */ 327 int order[GFC_MAX_DIMENSIONS]; 328 329 /* Enum to control loop reversal. */ 330 gfc_reverse reverse[GFC_MAX_DIMENSIONS]; 331 332 /* The number of dimensions for which a temporary is used. */ 333 int temp_dim; 334 335 /* If set we don't need the loop variables. */ 336 unsigned array_parameter:1; 337 } 338 gfc_loopinfo; 339 340 #define gfc_get_loopinfo() XCNEW (gfc_loopinfo) 341 342 /* Information about a symbol that has been shadowed by a temporary. */ 343 typedef struct 344 { 345 symbol_attribute attr; 346 tree decl; 347 } 348 gfc_saved_var; 349 350 351 /* Store information about a block of code together with special 352 initialization and clean-up code. This can be used to incrementally add 353 init and cleanup, and in the end put everything together to a 354 try-finally expression. */ 355 typedef struct 356 { 357 tree init; 358 tree cleanup; 359 tree code; 360 } 361 gfc_wrapped_block; 362 363 /* Class API functions. */ 364 tree gfc_class_set_static_fields (tree, tree, tree); 365 tree gfc_class_data_get (tree); 366 tree gfc_class_vptr_get (tree); 367 tree gfc_class_len_get (tree); 368 tree gfc_class_len_or_zero_get (tree); 369 gfc_expr * gfc_find_and_cut_at_last_class_ref (gfc_expr *); 370 /* Get an accessor to the class' vtab's * field, when a class handle is 371 available. */ 372 tree gfc_class_vtab_hash_get (tree); 373 tree gfc_class_vtab_size_get (tree); 374 tree gfc_class_vtab_extends_get (tree); 375 tree gfc_class_vtab_def_init_get (tree); 376 tree gfc_class_vtab_copy_get (tree); 377 tree gfc_class_vtab_final_get (tree); 378 /* Get an accessor to the vtab's * field, when a vptr handle is present. */ 379 tree gfc_vtpr_hash_get (tree); 380 tree gfc_vptr_size_get (tree); 381 tree gfc_vptr_extends_get (tree); 382 tree gfc_vptr_def_init_get (tree); 383 tree gfc_vptr_copy_get (tree); 384 tree gfc_vptr_final_get (tree); 385 void gfc_reset_vptr (stmtblock_t *, gfc_expr *); 386 void gfc_reset_len (stmtblock_t *, gfc_expr *); 387 tree gfc_get_vptr_from_expr (tree); 388 tree gfc_get_class_array_ref (tree, tree, tree); 389 tree gfc_copy_class_to_class (tree, tree, tree, bool); 390 bool gfc_add_finalizer_call (stmtblock_t *, gfc_expr *); 391 bool gfc_add_comp_finalizer_call (stmtblock_t *, tree, gfc_component *, bool); 392 393 void gfc_conv_derived_to_class (gfc_se *, gfc_expr *, gfc_typespec, tree, bool, 394 bool); 395 void gfc_conv_class_to_class (gfc_se *, gfc_expr *, gfc_typespec, bool, bool, 396 bool, bool); 397 398 /* Initialize an init/cleanup block. */ 399 void gfc_start_wrapped_block (gfc_wrapped_block* block, tree code); 400 /* Add a pair of init/cleanup code to the block. Each one might be a 401 NULL_TREE if not required. */ 402 void gfc_add_init_cleanup (gfc_wrapped_block* block, tree init, tree cleanup); 403 /* Finalize the block, that is, create a single expression encapsulating the 404 original code together with init and clean-up code. */ 405 tree gfc_finish_wrapped_block (gfc_wrapped_block* block); 406 407 408 /* Advance the SS chain to the next term. */ 409 void gfc_advance_se_ss_chain (gfc_se *); 410 411 /* Call this to initialize a gfc_se structure before use 412 first parameter is structure to initialize, second is 413 parent to get scalarization data from, or NULL. */ 414 void gfc_init_se (gfc_se *, gfc_se *); 415 416 /* Create an artificial variable decl and add it to the current scope. */ 417 tree gfc_create_var (tree, const char *); 418 /* Like above but doesn't add it to the current scope. */ 419 tree gfc_create_var_np (tree, const char *); 420 421 /* Store the result of an expression in a temp variable so it can be used 422 repeatedly even if the original changes */ 423 void gfc_make_safe_expr (gfc_se * se); 424 425 /* Makes sure se is suitable for passing as a function string parameter. */ 426 void gfc_conv_string_parameter (gfc_se * se); 427 428 /* Compare two strings. */ 429 tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code); 430 431 /* When using the gfc_conv_* make sure you understand what they do, i.e. 432 when a POST chain may be created, and what the returned expression may be 433 used for. Note that character strings have special handling. This 434 should not be a problem as most statements/operations only deal with 435 numeric/logical types. See the implementations in trans-expr.c 436 for details of the individual functions. */ 437 438 void gfc_conv_expr (gfc_se * se, gfc_expr * expr); 439 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr); 440 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr); 441 void gfc_conv_expr_reference (gfc_se * se, gfc_expr *); 442 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree); 443 444 tree gfc_conv_scalar_to_descriptor (gfc_se *, tree, symbol_attribute); 445 446 447 /* trans-expr.c */ 448 void gfc_conv_scalar_char_value (gfc_symbol *sym, gfc_se *se, gfc_expr **expr); 449 tree gfc_string_to_single_character (tree len, tree str, int kind); 450 tree gfc_get_tree_for_caf_expr (gfc_expr *); 451 void gfc_get_caf_token_offset (tree *, tree *, tree, tree, gfc_expr *); 452 tree gfc_caf_get_image_index (stmtblock_t *, gfc_expr *, tree); 453 454 /* Find the decl containing the auxiliary variables for assigned variables. */ 455 void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr); 456 /* If the value is not constant, Create a temporary and copy the value. */ 457 tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *); 458 tree gfc_evaluate_now (tree, stmtblock_t *); 459 460 /* Find the appropriate variant of a math intrinsic. */ 461 tree gfc_builtin_decl_for_float_kind (enum built_in_function, int); 462 463 tree size_of_string_in_bytes (int, tree); 464 465 /* Intrinsic procedure handling. */ 466 tree gfc_conv_intrinsic_subroutine (gfc_code *); 467 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *); 468 bool gfc_conv_ieee_arithmetic_function (gfc_se *, gfc_expr *); 469 tree gfc_save_fp_state (stmtblock_t *); 470 void gfc_restore_fp_state (stmtblock_t *, tree); 471 472 bool gfc_expr_is_variable (gfc_expr *); 473 474 /* Does an intrinsic map directly to an external library call 475 This is true for array-returning intrinsics, unless 476 gfc_inline_intrinsic_function_p returns true. */ 477 int gfc_is_intrinsic_libcall (gfc_expr *); 478 479 /* Used to call ordinary functions/subroutines 480 and procedure pointer components. */ 481 int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *, 482 gfc_expr *, vec<tree, va_gc> *); 483 484 void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool); 485 486 /* Generate code for a scalar assignment. */ 487 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool); 488 489 /* Translate COMMON blocks. */ 490 void gfc_trans_common (gfc_namespace *); 491 492 /* Translate a derived type constructor. */ 493 void gfc_conv_structure (gfc_se *, gfc_expr *, int); 494 495 /* Return an expression which determines if a dummy parameter is present. */ 496 tree gfc_conv_expr_present (gfc_symbol *); 497 /* Convert a missing, dummy argument into a null or zero. */ 498 void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int); 499 500 /* Generate code to allocate a string temporary. */ 501 tree gfc_conv_string_tmp (gfc_se *, tree, tree); 502 /* Get the string length variable belonging to an expression. */ 503 tree gfc_get_expr_charlen (gfc_expr *); 504 /* Initialize a string length variable. */ 505 void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *); 506 /* Ensure type sizes can be gimplified. */ 507 void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *); 508 509 /* Add an expression to the end of a block. */ 510 void gfc_add_expr_to_block (stmtblock_t *, tree); 511 /* Add an expression to the beginning of a block. */ 512 void gfc_prepend_expr_to_block (stmtblock_t *, tree); 513 /* Add a block to the end of a block. */ 514 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *); 515 /* Add a MODIFY_EXPR to a block. */ 516 void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree); 517 void gfc_add_modify (stmtblock_t *, tree, tree); 518 519 /* Initialize a statement block. */ 520 void gfc_init_block (stmtblock_t *); 521 /* Start a new statement block. Like gfc_init_block but also starts a new 522 variable scope. */ 523 void gfc_start_block (stmtblock_t *); 524 /* Finish a statement block. Also closes the scope if the block was created 525 with gfc_start_block. */ 526 tree gfc_finish_block (stmtblock_t *); 527 /* Merge the scope of a block with its parent. */ 528 void gfc_merge_block_scope (stmtblock_t * block); 529 530 /* Return the backend label decl. */ 531 tree gfc_get_label_decl (gfc_st_label *); 532 533 /* Return the decl for an external function. */ 534 tree gfc_get_extern_function_decl (gfc_symbol *); 535 536 /* Return the decl for a function. */ 537 tree gfc_get_function_decl (gfc_symbol *); 538 539 /* Build an ADDR_EXPR. */ 540 tree gfc_build_addr_expr (tree, tree); 541 542 /* Build an ARRAY_REF. */ 543 tree gfc_build_array_ref (tree, tree, tree, tree vptr = NULL_TREE); 544 545 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */ 546 tree gfc_build_label_decl (tree); 547 548 /* Return the decl used to hold the function return value. 549 Do not use if the function has an explicit result variable. */ 550 tree gfc_get_fake_result_decl (gfc_symbol *, int); 551 552 /* Add a decl to the binding level for the current function. */ 553 void gfc_add_decl_to_function (tree); 554 555 /* Make prototypes for runtime library functions. */ 556 void gfc_build_builtin_function_decls (void); 557 558 /* Set the backend source location of a decl. */ 559 void gfc_set_decl_location (tree, locus *); 560 561 /* Get a module symbol backend_decl if possible. */ 562 bool gfc_get_module_backend_decl (gfc_symbol *); 563 564 /* Return the variable decl for a symbol. */ 565 tree gfc_get_symbol_decl (gfc_symbol *); 566 567 /* Build a static initializer. */ 568 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool, bool); 569 570 /* Assign a default initializer to a derived type. */ 571 void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool); 572 573 /* Substitute a temporary variable in place of the real one. */ 574 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *); 575 576 /* Restore the original variable. */ 577 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *); 578 579 /* Setting a decl assembler name, mangling it according to target rules 580 (like Windows @NN decorations). */ 581 void gfc_set_decl_assembler_name (tree, tree); 582 583 /* Returns true if a variable of specified size should go on the stack. */ 584 int gfc_can_put_var_on_stack (tree); 585 586 /* Set GFC_DECL_SCALAR_* on decl from sym if needed. */ 587 void gfc_finish_decl_attrs (tree, symbol_attribute *); 588 589 /* Allocate the lang-specific part of a decl node. */ 590 void gfc_allocate_lang_decl (tree); 591 592 /* Advance along a TREE_CHAIN. */ 593 tree gfc_advance_chain (tree, int); 594 595 /* Create a decl for a function. */ 596 void gfc_create_function_decl (gfc_namespace *, bool); 597 /* Generate the code for a function. */ 598 void gfc_generate_function_code (gfc_namespace *); 599 /* Output a BLOCK DATA program unit. */ 600 void gfc_generate_block_data (gfc_namespace *); 601 /* Output a decl for a module variable. */ 602 void gfc_generate_module_vars (gfc_namespace *); 603 /* Get the appropriate return statement for a procedure. */ 604 tree gfc_generate_return (void); 605 606 struct module_decl_hasher : ggc_ptr_hash<tree_node> 607 { 608 typedef const char *compare_type; 609 610 static hashval_t hash (tree); 611 static bool equal (tree, const char *); 612 }; 613 614 struct GTY((for_user)) module_htab_entry { 615 const char *name; 616 tree namespace_decl; 617 hash_table<module_decl_hasher> *GTY (()) decls; 618 }; 619 620 struct module_htab_entry *gfc_find_module (const char *); 621 void gfc_module_add_decl (struct module_htab_entry *, tree); 622 623 /* Get and set the current location. */ 624 void gfc_save_backend_locus (locus *); 625 void gfc_set_backend_locus (locus *); 626 void gfc_restore_backend_locus (locus *); 627 628 /* Handle static constructor functions. */ 629 extern GTY(()) tree gfc_static_ctors; 630 void gfc_generate_constructors (void); 631 632 /* Get the string length of an array constructor. */ 633 bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *); 634 635 /* Mark a condition as likely or unlikely. */ 636 tree gfc_likely (tree, enum br_predictor); 637 tree gfc_unlikely (tree, enum br_predictor); 638 639 /* Return the string length of a deferred character length component. */ 640 bool gfc_deferred_strlen (gfc_component *, tree *); 641 642 /* Generate a runtime error call. */ 643 tree gfc_trans_runtime_error (bool, locus*, const char*, ...); 644 645 /* Generate a runtime warning/error check. */ 646 void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *, 647 const char *, ...); 648 649 /* Generate a runtime check for same string length. */ 650 void gfc_trans_same_strlen_check (const char*, locus*, tree, tree, 651 stmtblock_t*); 652 653 /* Generate a call to free(). */ 654 tree gfc_call_free (tree); 655 656 /* Allocate memory after performing a few checks. */ 657 tree gfc_call_malloc (stmtblock_t *, tree, tree); 658 659 /* Build a memcpy call. */ 660 tree gfc_build_memcpy_call (tree, tree, tree); 661 662 /* Allocate memory for allocatable variables, with optional status variable. */ 663 void gfc_allocate_allocatable (stmtblock_t*, tree, tree, tree, tree, 664 tree, tree, tree, gfc_expr*); 665 666 /* Allocate memory, with optional status variable. */ 667 void gfc_allocate_using_malloc (stmtblock_t *, tree, tree, tree); 668 669 /* Generate code to deallocate an array. */ 670 tree gfc_deallocate_with_status (tree, tree, tree, tree, tree, bool, 671 gfc_expr *, bool); 672 tree gfc_deallocate_scalar_with_status (tree, tree, bool, gfc_expr*, gfc_typespec); 673 674 /* Generate code to call realloc(). */ 675 tree gfc_call_realloc (stmtblock_t *, tree, tree); 676 677 /* Assign a derived type constructor to a variable. */ 678 tree gfc_trans_structure_assign (tree, gfc_expr *, bool); 679 680 /* Generate code for an assignment, includes scalarization. */ 681 tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool); 682 683 /* Generate code for a pointer assignment. */ 684 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *); 685 686 /* Initialize function decls for library functions. */ 687 void gfc_build_intrinsic_lib_fndecls (void); 688 /* Create function decls for IO library functions. */ 689 void gfc_build_io_library_fndecls (void); 690 /* Build a function decl for a library function. */ 691 tree gfc_build_library_function_decl (tree, tree, int, ...); 692 tree gfc_build_library_function_decl_with_spec (tree name, const char *spec, 693 tree rettype, int nargs, ...); 694 695 /* Process the local variable decls of a block construct. */ 696 void gfc_process_block_locals (gfc_namespace*); 697 698 /* Output initialization/clean-up code that was deferred. */ 699 void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *); 700 701 /* In f95-lang.c. */ 702 tree pushdecl (tree); 703 tree pushdecl_top_level (tree); 704 void pushlevel (void); 705 tree poplevel (int, int); 706 tree getdecls (void); 707 708 /* In trans-types.c. */ 709 struct array_descr_info; 710 bool gfc_get_array_descr_info (const_tree, struct array_descr_info *); 711 712 /* In trans-openmp.c */ 713 bool gfc_omp_privatize_by_reference (const_tree); 714 enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree); 715 tree gfc_omp_report_decl (tree); 716 tree gfc_omp_clause_default_ctor (tree, tree, tree); 717 tree gfc_omp_clause_copy_ctor (tree, tree, tree); 718 tree gfc_omp_clause_assign_op (tree, tree, tree); 719 tree gfc_omp_clause_linear_ctor (tree, tree, tree, tree); 720 tree gfc_omp_clause_dtor (tree, tree); 721 void gfc_omp_finish_clause (tree, gimple_seq *); 722 bool gfc_omp_disregard_value_expr (tree, bool); 723 bool gfc_omp_private_debug_clause (tree, bool); 724 bool gfc_omp_private_outer_ref (tree); 725 struct gimplify_omp_ctx; 726 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree); 727 728 /* Runtime library function decls. */ 729 extern GTY(()) tree gfor_fndecl_pause_numeric; 730 extern GTY(()) tree gfor_fndecl_pause_string; 731 extern GTY(()) tree gfor_fndecl_stop_numeric; 732 extern GTY(()) tree gfor_fndecl_stop_numeric_f08; 733 extern GTY(()) tree gfor_fndecl_stop_string; 734 extern GTY(()) tree gfor_fndecl_error_stop_numeric; 735 extern GTY(()) tree gfor_fndecl_error_stop_string; 736 extern GTY(()) tree gfor_fndecl_runtime_error; 737 extern GTY(()) tree gfor_fndecl_runtime_error_at; 738 extern GTY(()) tree gfor_fndecl_runtime_warning_at; 739 extern GTY(()) tree gfor_fndecl_os_error; 740 extern GTY(()) tree gfor_fndecl_generate_error; 741 extern GTY(()) tree gfor_fndecl_set_fpe; 742 extern GTY(()) tree gfor_fndecl_set_options; 743 extern GTY(()) tree gfor_fndecl_ttynam; 744 extern GTY(()) tree gfor_fndecl_ctime; 745 extern GTY(()) tree gfor_fndecl_fdate; 746 extern GTY(()) tree gfor_fndecl_in_pack; 747 extern GTY(()) tree gfor_fndecl_in_unpack; 748 extern GTY(()) tree gfor_fndecl_associated; 749 extern GTY(()) tree gfor_fndecl_system_clock4; 750 extern GTY(()) tree gfor_fndecl_system_clock8; 751 752 753 /* Coarray run-time library function decls. */ 754 extern GTY(()) tree gfor_fndecl_caf_init; 755 extern GTY(()) tree gfor_fndecl_caf_finalize; 756 extern GTY(()) tree gfor_fndecl_caf_this_image; 757 extern GTY(()) tree gfor_fndecl_caf_num_images; 758 extern GTY(()) tree gfor_fndecl_caf_register; 759 extern GTY(()) tree gfor_fndecl_caf_deregister; 760 extern GTY(()) tree gfor_fndecl_caf_get; 761 extern GTY(()) tree gfor_fndecl_caf_send; 762 extern GTY(()) tree gfor_fndecl_caf_sendget; 763 extern GTY(()) tree gfor_fndecl_caf_sync_all; 764 extern GTY(()) tree gfor_fndecl_caf_sync_memory; 765 extern GTY(()) tree gfor_fndecl_caf_sync_images; 766 extern GTY(()) tree gfor_fndecl_caf_stop_numeric; 767 extern GTY(()) tree gfor_fndecl_caf_stop_str; 768 extern GTY(()) tree gfor_fndecl_caf_error_stop; 769 extern GTY(()) tree gfor_fndecl_caf_error_stop_str; 770 extern GTY(()) tree gfor_fndecl_caf_atomic_def; 771 extern GTY(()) tree gfor_fndecl_caf_atomic_ref; 772 extern GTY(()) tree gfor_fndecl_caf_atomic_cas; 773 extern GTY(()) tree gfor_fndecl_caf_atomic_op; 774 extern GTY(()) tree gfor_fndecl_caf_lock; 775 extern GTY(()) tree gfor_fndecl_caf_unlock; 776 extern GTY(()) tree gfor_fndecl_caf_event_post; 777 extern GTY(()) tree gfor_fndecl_caf_event_wait; 778 extern GTY(()) tree gfor_fndecl_caf_event_query; 779 extern GTY(()) tree gfor_fndecl_co_broadcast; 780 extern GTY(()) tree gfor_fndecl_co_max; 781 extern GTY(()) tree gfor_fndecl_co_min; 782 extern GTY(()) tree gfor_fndecl_co_reduce; 783 extern GTY(()) tree gfor_fndecl_co_sum; 784 785 786 /* Math functions. Many other math functions are handled in 787 trans-intrinsic.c. */ 788 789 typedef struct GTY(()) gfc_powdecl_list { 790 tree integer; 791 tree real; 792 tree cmplx; 793 } 794 gfc_powdecl_list; 795 796 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3]; 797 extern GTY(()) tree gfor_fndecl_math_ishftc4; 798 extern GTY(()) tree gfor_fndecl_math_ishftc8; 799 extern GTY(()) tree gfor_fndecl_math_ishftc16; 800 801 /* BLAS functions. */ 802 extern GTY(()) tree gfor_fndecl_sgemm; 803 extern GTY(()) tree gfor_fndecl_dgemm; 804 extern GTY(()) tree gfor_fndecl_cgemm; 805 extern GTY(()) tree gfor_fndecl_zgemm; 806 807 /* String functions. */ 808 extern GTY(()) tree gfor_fndecl_compare_string; 809 extern GTY(()) tree gfor_fndecl_concat_string; 810 extern GTY(()) tree gfor_fndecl_string_len_trim; 811 extern GTY(()) tree gfor_fndecl_string_index; 812 extern GTY(()) tree gfor_fndecl_string_scan; 813 extern GTY(()) tree gfor_fndecl_string_verify; 814 extern GTY(()) tree gfor_fndecl_string_trim; 815 extern GTY(()) tree gfor_fndecl_string_minmax; 816 extern GTY(()) tree gfor_fndecl_adjustl; 817 extern GTY(()) tree gfor_fndecl_adjustr; 818 extern GTY(()) tree gfor_fndecl_select_string; 819 extern GTY(()) tree gfor_fndecl_compare_string_char4; 820 extern GTY(()) tree gfor_fndecl_concat_string_char4; 821 extern GTY(()) tree gfor_fndecl_string_len_trim_char4; 822 extern GTY(()) tree gfor_fndecl_string_index_char4; 823 extern GTY(()) tree gfor_fndecl_string_scan_char4; 824 extern GTY(()) tree gfor_fndecl_string_verify_char4; 825 extern GTY(()) tree gfor_fndecl_string_trim_char4; 826 extern GTY(()) tree gfor_fndecl_string_minmax_char4; 827 extern GTY(()) tree gfor_fndecl_adjustl_char4; 828 extern GTY(()) tree gfor_fndecl_adjustr_char4; 829 extern GTY(()) tree gfor_fndecl_select_string_char4; 830 831 /* Conversion between character kinds. */ 832 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4; 833 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1; 834 835 /* Other misc. runtime library functions. */ 836 extern GTY(()) tree gfor_fndecl_size0; 837 extern GTY(()) tree gfor_fndecl_size1; 838 extern GTY(()) tree gfor_fndecl_iargc; 839 840 /* Implemented in Fortran. */ 841 extern GTY(()) tree gfor_fndecl_sc_kind; 842 extern GTY(()) tree gfor_fndecl_si_kind; 843 extern GTY(()) tree gfor_fndecl_sr_kind; 844 845 /* IEEE-related. */ 846 extern GTY(()) tree gfor_fndecl_ieee_procedure_entry; 847 extern GTY(()) tree gfor_fndecl_ieee_procedure_exit; 848 849 850 /* True if node is an integer constant. */ 851 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST) 852 853 /* gfortran-specific declaration information, the _CONT versions denote 854 arrays with CONTIGUOUS attribute. */ 855 856 enum gfc_array_kind 857 { 858 GFC_ARRAY_UNKNOWN, 859 GFC_ARRAY_ASSUMED_SHAPE, 860 GFC_ARRAY_ASSUMED_SHAPE_CONT, 861 GFC_ARRAY_ASSUMED_RANK, 862 GFC_ARRAY_ASSUMED_RANK_CONT, 863 GFC_ARRAY_ALLOCATABLE, 864 GFC_ARRAY_POINTER, 865 GFC_ARRAY_POINTER_CONT 866 }; 867 868 /* Array types only. */ 869 struct GTY(()) lang_type { 870 int rank, corank; 871 enum gfc_array_kind akind; 872 tree lbound[GFC_MAX_DIMENSIONS]; 873 tree ubound[GFC_MAX_DIMENSIONS]; 874 tree stride[GFC_MAX_DIMENSIONS]; 875 tree size; 876 tree offset; 877 tree dtype; 878 tree dataptr_type; 879 tree span; 880 tree base_decl[2]; 881 tree nonrestricted_type; 882 tree caf_token; 883 tree caf_offset; 884 }; 885 886 struct GTY(()) lang_decl { 887 /* Dummy variables. */ 888 tree saved_descriptor; 889 /* Assigned integer nodes. Stringlength is the IO format string's length. 890 Addr is the address of the string or the target label. Stringlength is 891 initialized to -2 and assigned to -1 when addr is assigned to the 892 address of target label. */ 893 tree stringlen; 894 tree addr; 895 tree span; 896 /* For assumed-shape coarrays. */ 897 tree token, caf_offset; 898 unsigned int scalar_allocatable : 1; 899 unsigned int scalar_pointer : 1; 900 }; 901 902 903 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr 904 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen 905 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span 906 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token 907 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset 908 #define GFC_DECL_SAVED_DESCRIPTOR(node) \ 909 (DECL_LANG_SPECIFIC(node)->saved_descriptor) 910 #define GFC_DECL_SCALAR_ALLOCATABLE(node) \ 911 (DECL_LANG_SPECIFIC (node)->scalar_allocatable) 912 #define GFC_DECL_SCALAR_POINTER(node) \ 913 (DECL_LANG_SPECIFIC (node)->scalar_pointer) 914 #define GFC_DECL_GET_SCALAR_ALLOCATABLE(node) \ 915 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_ALLOCATABLE (node) : 0) 916 #define GFC_DECL_GET_SCALAR_POINTER(node) \ 917 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_POINTER (node) : 0) 918 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node) 919 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node) 920 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node) 921 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node) 922 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node) 923 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node) 924 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node) 925 #define GFC_DECL_ASSOCIATE_VAR_P(node) DECL_LANG_FLAG_7(node) 926 #define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node) 927 928 /* An array descriptor. */ 929 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node) 930 /* An array without a descriptor. */ 931 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node) 932 /* Fortran CLASS type. */ 933 #define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node) 934 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and 935 descriptorless array types. */ 936 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \ 937 (TYPE_LANG_SPECIFIC(node)->lbound[dim]) 938 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \ 939 (TYPE_LANG_SPECIFIC(node)->ubound[dim]) 940 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \ 941 (TYPE_LANG_SPECIFIC(node)->stride[dim]) 942 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank) 943 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank) 944 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token) 945 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset) 946 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size) 947 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset) 948 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind) 949 /* Code should use gfc_get_dtype instead of accessing this directly. It may 950 not be known when the type is created. */ 951 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype) 952 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \ 953 (TYPE_LANG_SPECIFIC(node)->dataptr_type) 954 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span) 955 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \ 956 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)]) 957 958 959 /* Build an expression with void type. */ 960 #define build1_v(code, arg) \ 961 fold_build1_loc (input_location, code, void_type_node, arg) 962 #define build2_v(code, arg1, arg2) \ 963 fold_build2_loc (input_location, code, void_type_node, arg1, arg2) 964 #define build3_v(code, arg1, arg2, arg3) \ 965 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3) 966 #define build4_v(code, arg1, arg2, arg3, arg4) \ 967 build4_loc (input_location, code, void_type_node, arg1, arg2, \ 968 arg3, arg4) 969 970 /* This group of functions allows a caller to evaluate an expression from 971 the callee's interface. It establishes a mapping between the interface's 972 dummy arguments and the caller's actual arguments, then applies that 973 mapping to a given gfc_expr. 974 975 You can initialize a mapping structure like so: 976 977 gfc_interface_mapping mapping; 978 ... 979 gfc_init_interface_mapping (&mapping); 980 981 You should then evaluate each actual argument into a temporary 982 gfc_se structure, here called "se", and map the result to the 983 dummy argument's symbol, here called "sym": 984 985 gfc_add_interface_mapping (&mapping, sym, &se); 986 987 After adding all mappings, you should call: 988 989 gfc_finish_interface_mapping (&mapping, pre, post); 990 991 where "pre" and "post" are statement blocks for initialization 992 and finalization code respectively. You can then evaluate an 993 interface expression "expr" as follows: 994 995 gfc_apply_interface_mapping (&mapping, se, expr); 996 997 Once you've evaluated all expressions, you should free 998 the mapping structure with: 999 1000 gfc_free_interface_mapping (&mapping); */ 1001 1002 1003 /* This structure represents a mapping from OLD to NEW, where OLD is a 1004 dummy argument symbol and NEW is a symbol that represents the value 1005 of an actual argument. Mappings are linked together using NEXT 1006 (in no particular order). */ 1007 typedef struct gfc_interface_sym_mapping 1008 { 1009 struct gfc_interface_sym_mapping *next; 1010 gfc_symbol *old; 1011 gfc_symtree *new_sym; 1012 gfc_expr *expr; 1013 } 1014 gfc_interface_sym_mapping; 1015 1016 1017 /* This structure is used by callers to evaluate an expression from 1018 a callee's interface. */ 1019 typedef struct gfc_interface_mapping 1020 { 1021 /* Maps the interface's dummy arguments to the values that the caller 1022 is passing. The whole list is owned by this gfc_interface_mapping. */ 1023 gfc_interface_sym_mapping *syms; 1024 1025 /* A list of gfc_charlens that were needed when creating copies of 1026 expressions. The whole list is owned by this gfc_interface_mapping. */ 1027 gfc_charlen *charlens; 1028 } 1029 gfc_interface_mapping; 1030 1031 void gfc_init_interface_mapping (gfc_interface_mapping *); 1032 void gfc_free_interface_mapping (gfc_interface_mapping *); 1033 void gfc_add_interface_mapping (gfc_interface_mapping *, 1034 gfc_symbol *, gfc_se *, gfc_expr *); 1035 void gfc_finish_interface_mapping (gfc_interface_mapping *, 1036 stmtblock_t *, stmtblock_t *); 1037 void gfc_apply_interface_mapping (gfc_interface_mapping *, 1038 gfc_se *, gfc_expr *); 1039 1040 1041 /* Standard error messages used in all the trans-*.c files. */ 1042 extern const char gfc_msg_fault[]; 1043 extern const char gfc_msg_wrong_return[]; 1044 1045 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */ 1046 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare 1047 construct is not workshared. */ 1048 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt 1049 to create parallel loops. */ 1050 #define OMPWS_SCALARIZER_BODY 8 /* Set if handling body of potential 1051 parallel loop. */ 1052 #define OMPWS_NOWAIT 16 /* Use NOWAIT on OMP_FOR. */ 1053 extern int ompws_flags; 1054 1055 #endif /* GFC_TRANS_H */ 1056