OSDN Git Service

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