gcc/fortran/trans.h

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