OSDN Git Service

7f9e997f83b493824afa9e547ab0bbe2b65f7ea5
[pf3gnuchains/gcc-fork.git] / gcc / fortran / trans.h
1 /* Header for code translation functions
2    Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
3    Contributed by Paul Brook
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING.  If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.  */
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 expresson */
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   /* Ignore absent optional arguments.  Used for some intrinsics.  */
68   unsigned ignore_optional:1;
69
70   /* Scalarization parameters.  */
71   struct gfc_se *parent;
72   struct gfc_ss *ss;
73   struct gfc_loopinfo *loop;
74 }
75 gfc_se;
76
77
78 /* Scalarisation State chain.  Created by walking an expression tree before
79    creating the scalarization loops. Then passed as part of a gfc_se structure
80    to translate the expression inside the loop.  Note that these chains are
81    terminated by gfc_se_terminator, not NULL.  A NULL pointer in a gfc_se
82    indicates to gfc_conv_* that this is a scalar expression.
83    Note that some member arrays correspond to scalarizer rank and others
84    are the variable rank.  */
85
86 typedef struct gfc_ss_info
87 {
88   int dimen;
89   /* The ref that holds information on this section.  */
90   gfc_ref *ref;
91   /* The descriptor of this array.  */
92   tree descriptor;
93   /* holds the pointer to the data array.  */
94   tree data;
95   /* To move some of the array index calculation out of the innermost loop.  */
96   tree offset;
97   tree saved_offset;
98   tree stride0;
99   /* Holds the SS for a subscript.  Indexed by actual dimension.  */
100   struct gfc_ss *subscript[GFC_MAX_DIMENSIONS];
101
102   /* stride and delta are used to access this inside a scalarization loop.
103      start is used in the calculation of these.  Indexed by scalarizer
104      dimension.  */
105   tree start[GFC_MAX_DIMENSIONS];
106   tree stride[GFC_MAX_DIMENSIONS];
107   tree delta[GFC_MAX_DIMENSIONS];
108
109   /* Translation from scalariser dimensions to actual dimensions.
110      actual = dim[scalarizer]  */
111   int dim[GFC_MAX_DIMENSIONS];
112 }
113 gfc_ss_info;
114
115 typedef enum
116 {
117   /* A scalar value.  This will be evaluated before entering the
118      scalarization loop.  */
119   GFC_SS_SCALAR,
120
121   /* Like GFC_SS_SCALAR except it evaluates a pointer the the expression.
122      Used for elemental function parameters.  */
123   GFC_SS_REFERENCE,
124
125   /* An array section.  Scalarization indices will be substituted during
126      expression translation.  */
127   GFC_SS_SECTION,
128
129   /* A non-elemental function call returning an array.  The call is executed
130      before entering the scalarization loop, storing the result in a
131      temporary.  This temporary is then used inside the scalarization loop.
132      Simple assignments, eg. a(:) = fn() are handles without a temporary
133      as a special case.  */
134   GFC_SS_FUNCTION,
135
136   /* An array constructor.  The current implementation is sub-optimal in
137      many cases.  It allocated a temporary, assigns the values to it, then
138      uses this temporary inside the scalarization loop.  */
139   GFC_SS_CONSTRUCTOR,
140
141   /* A vector subscript.  Only used as the SS chain for a subscript.
142      Similar int format to a GFC_SS_SECTION.  */
143   GFC_SS_VECTOR,
144
145   /* A temporary array allocated by the scalarizer.  Its rank can be less
146      than that of the assignment expression.  */
147   GFC_SS_TEMP,
148
149   /* An intrinsic function call.  Many intrinsic functions which map directly
150      to library calls are created as GFC_SS_FUNCTION nodes.  */
151   GFC_SS_INTRINSIC,
152   
153   /* A component of a derived type.  */
154   GFC_SS_COMPONENT
155 }
156 gfc_ss_type;
157
158 /* SS structures can only belong to a single loopinfo.  They must be added
159    otherwise they will not get freed.  */
160 typedef struct gfc_ss
161 {
162   gfc_ss_type type;
163   gfc_expr *expr;
164   mpz_t *shape;
165   union
166   {
167     /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE.  */
168     struct
169     {
170       tree expr;
171       tree string_length;
172     }
173     scalar;
174
175     /* GFC_SS_TEMP.  */
176     struct
177     {
178       /* The rank of the temporary.  May be less than the rank of the
179          assigned expression.  */
180       int dimen;
181       tree type;
182       tree string_length;
183     }
184     temp;
185     /* All other types.  */
186     gfc_ss_info info;
187   }
188   data;
189
190   /* All the SS in a loop and linked through loop_chain.  The SS for an
191      expression are linked by the next pointer.  */
192   struct gfc_ss *loop_chain;
193   struct gfc_ss *next;
194
195   /* This is used by assignments requiring teporaries. The bits specify which
196      loops the terms appear in.  This will be 1 for the RHS expressions,
197      2 for the LHS expressions, and 3(=1|2) for the temporary.  */
198   unsigned useflags:2;
199 }
200 gfc_ss;
201 #define gfc_get_ss() gfc_getmem(sizeof(gfc_ss))
202
203 /* The contents of this aren't actualy used.  A NULL SS chain indicates a
204    scalar expression, so this pointer is used to terminate SS chains.  */
205 extern gfc_ss * const gfc_ss_terminator;
206
207 /* Holds information about an expression while it is being scalarized.  */
208 typedef struct gfc_loopinfo
209 {
210   stmtblock_t pre;
211   stmtblock_t post;
212
213   int dimen;
214
215   /* All the SS involved with this loop.  */
216   gfc_ss *ss;
217   /* The SS describing the teporary used in an assignment.  */
218   gfc_ss *temp_ss;
219
220   /* The scalarization loop index variables.  */
221   tree loopvar[GFC_MAX_DIMENSIONS];
222
223   /* The bounds of the scalarization loops.  */
224   tree from[GFC_MAX_DIMENSIONS];
225   tree to[GFC_MAX_DIMENSIONS];
226   gfc_ss *specloop[GFC_MAX_DIMENSIONS];
227
228   /* The code member contains the code for the body of the next outer loop.  */
229   stmtblock_t code[GFC_MAX_DIMENSIONS];
230
231   /* Order in which the dimensions should be looped, innermost first.  */
232   int order[GFC_MAX_DIMENSIONS];
233
234   /* The number of dimensions for which a temporary is used.  */
235   int temp_dim;
236
237   /* If set we don't need the loop variables.  */
238   unsigned array_parameter:1;
239 }
240 gfc_loopinfo;
241
242
243 /* Information about a symbol that has been shadowed by a temporary.  */
244 typedef struct
245 {
246   symbol_attribute attr;
247   tree decl;
248 }
249 gfc_saved_var;
250
251
252 /* Advance the SS chain to the next term.  */
253 void gfc_advance_se_ss_chain (gfc_se *);
254
255 /* Call this to initialise a gfc_se structure before use
256    first parameter is structure to initialise, second is
257    parent to get scalarization data from, or NULL.  */
258 void gfc_init_se (gfc_se *, gfc_se *);
259
260 /* Create an artificial variable decl and add it to the current scope.  */
261 tree gfc_create_var (tree, const char *);
262 /* Like above but doesn't add it to the current scope.  */
263 tree gfc_create_var_np (tree, const char *);
264
265 /* Store the result of an expression in a temp variable so it can be used
266    repeatedly even if the original changes */
267 void gfc_make_safe_expr (gfc_se * se);
268
269 /* Makes sure se is suitable for passing as a function string parameter.  */
270 void gfc_conv_string_parameter (gfc_se * se);
271
272 /* Add an item to the end of TREE_LIST.  */
273 tree gfc_chainon_list (tree, tree);
274
275 /* When using the gfc_conv_* make sure you understand what they do, ie.
276    when a POST chain may be created, and what the retured expression may be
277    used for.  Note that character strings have special handling.  This
278    should not be a problem as most statements/operations only deal with
279    numeric/logical types.  */
280
281 /* Entry point for expression translation.  */
282 void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
283 /* Like gfc_conv_expr, but the POST block is guaranteed to be empty for
284    numeric expressions.  */
285 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
286 /* Like gfc_conv_expr_val, but the value is also suitable for use in the lhs of
287    an assignment.  */
288 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
289 /* Converts an expression so that it can be passed be reference.  */
290 void gfc_conv_expr_reference (gfc_se * se, gfc_expr *);
291 /* Equivalent to convert(type, gfc_conv_expr_val(se, expr)).  */
292 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
293 /* If the value is not constant, Create a temporary and copy the value.  */
294 tree gfc_evaluate_now (tree, stmtblock_t *);
295
296 /* Intrinsic function handling.  */
297 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
298
299 /* Does an intrinsic map directly to an external library call.  */
300 int gfc_is_intrinsic_libcall (gfc_expr *);
301
302 /* Also used to CALL subroutines.  */
303 void gfc_conv_function_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *);
304 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
305
306 /* Generate code for a scalar assignment.  */
307 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, bt);
308
309 /* Translate COMMON blocks.  */
310 void gfc_trans_common (gfc_namespace *);
311
312 /* Translate a derived type constructor. */
313 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
314
315 /* Return an expression which determines if a dummy parameter is present.  */
316 tree gfc_conv_expr_present (gfc_symbol *);
317
318 /* Generate code to allocate a string temporary.  */
319 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
320 /* Initialize a string length variable.  */
321 void gfc_trans_init_string_length (gfc_charlen *, stmtblock_t *);
322
323 /* Add an expression to the end of a block.  */
324 void gfc_add_expr_to_block (stmtblock_t *, tree);
325 /* Add a block to the end of a block.  */
326 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
327 /* Add a MODIFY_EXPR to a block.  */
328 void gfc_add_modify_expr (stmtblock_t *, tree, tree);
329
330 /* Initialize a statement block.  */
331 void gfc_init_block (stmtblock_t *);
332 /* Start a new satement block.  Like gfc_init_block but also starts a new
333    variable scope.  */
334 void gfc_start_block (stmtblock_t *);
335 /* Finish a statement block.  Also closes the scope if the block was created
336    with gfc_start_block.  */
337 tree gfc_finish_block (stmtblock_t *);
338 /* Merge the scope of a block with its parent.  */
339 void gfc_merge_block_scope (stmtblock_t * block);
340
341 /* Return the backend label decl.  */
342 tree gfc_get_label_decl (gfc_st_label *);
343
344 /* Return the decl for an external function.  */
345 tree gfc_get_extern_function_decl (gfc_symbol *);
346
347 /* Return the decl for a function.  */
348 tree gfc_get_function_decl (gfc_symbol *);
349
350 /* Build a CALL_EXPR.  */
351 tree gfc_build_function_call (tree, tree);
352
353 /* Build an ADDR_EXPR.  */
354 tree gfc_build_addr_expr (tree, tree);
355
356 /* Build an INDIRECT_REF.  */
357 tree gfc_build_indirect_ref (tree);
358
359 /* Build an ARRAY_REF.  */
360 tree gfc_build_array_ref (tree, tree);
361
362 /* Creates an label.  Decl is artificial if label_id == NULL_TREE.  */
363 tree gfc_build_label_decl (tree);
364
365 /* Return the decl used to hold the function return value.
366    Do not use if the function has an explicit result variable.  */
367 tree gfc_get_fake_result_decl (gfc_symbol *);
368
369 /* Get the return label for the current function.  */
370 tree gfc_get_return_label (void);
371
372 /* Add a decl to the binding level for the current function.  */
373 void gfc_add_decl_to_function (tree);
374
375 /* Make prototypes for runtime library functions.  */
376 void gfc_build_builtin_function_decls (void);
377
378 /* Return the variable decl for a symbol.  */
379 tree gfc_get_symbol_decl (gfc_symbol *);
380
381 /* Build a static initializer.  */
382 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool);
383
384 /* Substitute a temporary variable in place of the real one.  */
385 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
386
387 /* Restore the original variable.  */
388 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
389
390 /* Allocate the lang-spcific part of a decl node.  */
391 void gfc_allocate_lang_decl (tree);
392
393 /* Advance along a TREE_CHAIN.  */
394 tree gfc_advance_chain (tree, int);
395
396 /* Create a decl for a function.  */
397 void gfc_build_function_decl (gfc_symbol *);
398 /* Generate the code for a function.  */
399 void gfc_generate_function_code (gfc_namespace *);
400 /* Output a decl for a module variable.  */
401 void gfc_generate_module_vars (gfc_namespace *);
402
403 /* Get and set the current location.  */
404 void gfc_set_backend_locus (locus *);
405 void gfc_get_backend_locus (locus *);
406
407 /* Handle static constructor functions.  */
408 extern GTY(()) tree gfc_static_ctors;
409 void gfc_generate_constructors (void);
410
411 /* Generate a runtime error check.  */
412 void gfc_trans_runtime_check (tree, tree, stmtblock_t *);
413
414 /* Generate code for an assigment, includes scalarization.  */
415 tree gfc_trans_assignment (gfc_expr *, gfc_expr *);
416
417 /* Generate code for an pointer assignment.  */
418 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
419
420 /* Initialize function decls for library functions.  */
421 void gfc_build_intrinsic_lib_fndecls (void);
422 /* Create function decls for IO library functions.  */
423 void gfc_build_io_library_fndecls (void);
424 /* Build a function decl for a library function.  */
425 tree gfc_build_library_function_decl (tree, tree, int, ...);
426
427 /* somewhere! */
428 tree pushdecl (tree);
429 tree pushdecl_top_level (tree);
430 void pushlevel (int);
431 tree poplevel (int, int, int);
432 tree getdecls (void);
433 tree gfc_truthvalue_conversion (tree);
434 tree builtin_function (const char *, tree, int, enum built_in_class,
435                        const char *, tree);
436
437 /* Runtime library function decls.  */
438 extern GTY(()) tree gfor_fndecl_internal_malloc;
439 extern GTY(()) tree gfor_fndecl_internal_malloc64;
440 extern GTY(()) tree gfor_fndecl_internal_free;
441 extern GTY(()) tree gfor_fndecl_allocate;
442 extern GTY(()) tree gfor_fndecl_allocate64;
443 extern GTY(()) tree gfor_fndecl_deallocate;
444 extern GTY(()) tree gfor_fndecl_pause_numeric;
445 extern GTY(()) tree gfor_fndecl_pause_string;
446 extern GTY(()) tree gfor_fndecl_stop_numeric;
447 extern GTY(()) tree gfor_fndecl_stop_string;
448 extern GTY(()) tree gfor_fndecl_select_string;
449 extern GTY(()) tree gfor_fndecl_runtime_error;
450 extern GTY(()) tree gfor_fndecl_in_pack;
451 extern GTY(()) tree gfor_fndecl_in_unpack;
452 extern GTY(()) tree gfor_fndecl_associated;
453
454 /* Math functions.  Many other math functions are handled in
455    trans-intrinsic.c.  */
456
457 typedef struct gfc_powdecl_list GTY(())
458 {
459   tree integer;
460   tree real;
461   tree cmplx;
462 }
463 gfc_powdecl_list;
464
465 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[3][2];
466 extern GTY(()) tree gfor_fndecl_math_cpowf;
467 extern GTY(()) tree gfor_fndecl_math_cpow;
468 extern GTY(()) tree gfor_fndecl_math_ishftc4;
469 extern GTY(()) tree gfor_fndecl_math_ishftc8;
470 extern GTY(()) tree gfor_fndecl_math_exponent4;
471 extern GTY(()) tree gfor_fndecl_math_exponent8;
472
473 /* String functions.  */
474 extern GTY(()) tree gfor_fndecl_copy_string;
475 extern GTY(()) tree gfor_fndecl_compare_string;
476 extern GTY(()) tree gfor_fndecl_concat_string;
477 extern GTY(()) tree gfor_fndecl_string_len_trim;
478 extern GTY(()) tree gfor_fndecl_string_index;
479 extern GTY(()) tree gfor_fndecl_string_scan;
480 extern GTY(()) tree gfor_fndecl_string_verify;
481 extern GTY(()) tree gfor_fndecl_string_trim;
482 extern GTY(()) tree gfor_fndecl_string_repeat;
483 extern GTY(()) tree gfor_fndecl_adjustl;
484 extern GTY(()) tree gfor_fndecl_adjustr;
485
486 /* Other misc. runtime library functions.  */
487 extern GTY(()) tree gfor_fndecl_size0;
488 extern GTY(()) tree gfor_fndecl_size1;
489 extern GTY(()) tree gfor_fndecl_iargc;
490
491 /* Implemented in FORTRAN.  */
492 extern GTY(()) tree gfor_fndecl_si_kind;
493 extern GTY(()) tree gfor_fndecl_sr_kind;
494
495
496 /* True if node is an integer constant.  */
497 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
498
499 /* G95-specific declaration information.  */
500
501 /* Array types only.  */
502 struct lang_type                GTY(())
503 {
504   int rank;
505   tree lbound[GFC_MAX_DIMENSIONS];
506   tree ubound[GFC_MAX_DIMENSIONS];
507   tree stride[GFC_MAX_DIMENSIONS];
508   tree size;
509   tree offset;
510   tree dtype;
511   tree dataptr_type;
512 };
513
514 struct lang_decl                GTY(())
515 {
516   /* Dummy variables.  */
517   tree saved_descriptor;
518   /* Assigned integer nodes.  Stringlength is the IO format string's length.
519      Addr is the address of the string or the target label. Stringlength is
520      initialized to -2 and assiged to -1 when addr is assigned to the
521      address of target label.  */
522   tree stringlen;
523   tree addr;
524 };
525
526
527 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
528 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
529 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
530   (DECL_LANG_SPECIFIC(node)->saved_descriptor)
531 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
532 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
533 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
534
535 /* An array descriptor.  */
536 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
537 /* An array without a descriptor.  */
538 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
539 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
540    descriptorless array types.  */
541 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
542   (TYPE_LANG_SPECIFIC(node)->lbound[dim])
543 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
544   (TYPE_LANG_SPECIFIC(node)->ubound[dim])
545 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
546   (TYPE_LANG_SPECIFIC(node)->stride[dim])
547 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
548 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
549 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
550 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
551 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
552   (TYPE_LANG_SPECIFIC(node)->dataptr_type)
553
554 /* I changed this from sorry(...) because it should not return.  */
555 /* TODO: Remove gfc_todo_error before releasing version 1.0.  */
556 #define gfc_todo_error(args...) fatal_error("gfc_todo: Not Implemented: " args)
557
558 /* Build an expression with void type.  */
559 #define build1_v(code, arg) build(code, void_type_node, arg)
560 #define build_v(code, args...) build(code, void_type_node, args)
561
562 /* flag for alternative return labels.  */
563 extern int has_alternate_specifier;  /* for caller */
564 #endif /* GFC_TRANS_H */