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