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