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