gcc/fortran/trans.h

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