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