xref: /netbsd-src/external/gpl3/gcc/dist/gcc/fortran/trans-array.h (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /* Header for array handling functions
2    Copyright (C) 2002-2019 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 3, 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 COPYING3.  If not see
19 <http://www.gnu.org/licenses/>.  */
20 
21 /* Generate code to initialize and allocate an array.  Statements are added to
22    se, which should contain an expression for the array descriptor.  */
23 bool gfc_array_allocate (gfc_se *, gfc_expr *, tree, tree, tree, tree,
24 			 tree, tree *, gfc_expr *, tree, bool);
25 
26 /* Allow the bounds of a loop to be set from a callee's array spec.  */
27 void gfc_set_loop_bounds_from_array_spec (gfc_interface_mapping *,
28 					  gfc_se *, gfc_array_spec *);
29 
30 /* Generate code to create a temporary array.  */
31 tree gfc_trans_create_temp_array (stmtblock_t *, stmtblock_t *, gfc_ss *,
32 				  tree, tree, bool, bool, bool, locus *);
33 
34 /* Generate function entry code for allocation of compiler allocated array
35    variables.  */
36 void gfc_trans_auto_array_allocation (tree, gfc_symbol *, gfc_wrapped_block *);
37 /* Generate entry and exit code for dummy array parameters.  */
38 void gfc_trans_dummy_array_bias (gfc_symbol *, tree, gfc_wrapped_block *);
39 /* Generate entry and exit code for g77 calling convention arrays.  */
40 void gfc_trans_g77_array (gfc_symbol *, gfc_wrapped_block *);
41 
42 tree gfc_full_array_size (stmtblock_t *, tree, int);
43 
44 tree gfc_duplicate_allocatable (tree, tree, tree, int, tree);
45 
46 tree gfc_copy_allocatable_data (tree dest, tree src, tree type, int rank);
47 
48 tree gfc_duplicate_allocatable_nocopy (tree, tree, tree, int);
49 
50 bool gfc_caf_is_dealloc_only (int);
51 
52 tree gfc_nullify_alloc_comp (gfc_symbol *, tree, int, int cm = 0);
53 
54 tree gfc_deallocate_alloc_comp (gfc_symbol *, tree, int, int cm = 0);
55 tree gfc_deallocate_alloc_comp_no_caf (gfc_symbol *, tree, int);
56 tree gfc_reassign_alloc_comp_caf (gfc_symbol *, tree, tree);
57 
58 tree gfc_copy_alloc_comp (gfc_symbol *, tree, tree, int, int);
59 
60 tree gfc_copy_only_alloc_comp (gfc_symbol *, tree, tree, int);
61 
62 tree gfc_allocate_pdt_comp (gfc_symbol *, tree, int, gfc_actual_arglist *);
63 tree gfc_deallocate_pdt_comp (gfc_symbol *, tree, int);
64 tree gfc_check_pdt_dummy (gfc_symbol *, tree, int, gfc_actual_arglist *);
65 
66 tree gfc_alloc_allocatable_for_assignment (gfc_loopinfo*, gfc_expr*, gfc_expr*);
67 
68 /* Add initialization for deferred arrays.  */
69 void gfc_trans_deferred_array (gfc_symbol *, gfc_wrapped_block *);
70 /* Generate an initializer for a static pointer or allocatable array.  */
71 void gfc_trans_static_array_pointer (gfc_symbol *);
72 
73 /* Get the procedure interface for a function call.  */
74 gfc_symbol *gfc_get_proc_ifc_for_expr (gfc_expr *);
75 /* Generate scalarization information for an expression.  */
76 gfc_ss *gfc_walk_expr (gfc_expr *);
77 /* Workhorse for gfc_walk_expr.  */
78 gfc_ss *gfc_walk_subexpr (gfc_ss *, gfc_expr *);
79 /* Workhorse for gfc_walk_variable_expr.  */
80 gfc_ss *gfc_walk_array_ref (gfc_ss *, gfc_expr *, gfc_ref * ref);
81 /* Walk the arguments of an elemental function.  */
82 gfc_ss *gfc_walk_elemental_function_args (gfc_ss *, gfc_actual_arglist *,
83 					  gfc_symbol *, gfc_ss_type);
84 /* Walk an intrinsic function.  */
85 gfc_ss *gfc_walk_intrinsic_function (gfc_ss *, gfc_expr *,
86 				     gfc_intrinsic_sym *);
87 /* Reverse the order of an SS chain.  */
88 gfc_ss *gfc_reverse_ss (gfc_ss *);
89 
90 /* Free the SS associated with a loop.  */
91 void gfc_cleanup_loop (gfc_loopinfo *);
92 /* Associate a SS chain with a loop.  */
93 void gfc_add_ss_to_loop (gfc_loopinfo *, gfc_ss *);
94 /* Mark a SS chain as used in this loop.  */
95 void gfc_mark_ss_chain_used (gfc_ss *, unsigned);
96 /* Free a gfc_ss chain.  */
97 void gfc_free_ss_chain (gfc_ss *);
98 /* Free a single gfc_ss element.  */
99 void gfc_free_ss (gfc_ss *);
100 /* Allocate a new array type ss.  */
101 gfc_ss *gfc_get_array_ss (gfc_ss *, gfc_expr *, int, gfc_ss_type);
102 /* Allocate a new temporary type ss.  */
103 gfc_ss *gfc_get_temp_ss (tree, tree, int);
104 /* Allocate a new scalar type ss.  */
105 gfc_ss *gfc_get_scalar_ss (gfc_ss *, gfc_expr *);
106 
107 bool gfc_scalar_elemental_arg_saved_as_reference (gfc_ss_info *);
108 
109 /* Calculates the lower bound and stride of array sections.  */
110 void gfc_conv_ss_startstride (gfc_loopinfo *);
111 
112 void gfc_init_loopinfo (gfc_loopinfo *);
113 void gfc_copy_loopinfo_to_se (gfc_se *, gfc_loopinfo *);
114 
115 /* Marks the start of a scalarized expression, and declares loop variables.  */
116 void gfc_start_scalarized_body (gfc_loopinfo *, stmtblock_t *);
117 /* Generates one actual loop for a scalarized expression.  */
118 void  gfc_trans_scalarized_loop_end (gfc_loopinfo *, int, stmtblock_t *);
119 /* Generates the actual loops for a scalarized expression.  */
120 void gfc_trans_scalarizing_loops (gfc_loopinfo *, stmtblock_t *);
121 /* Mark the end of the main loop body and the start of the copying loop.  */
122 void gfc_trans_scalarized_loop_boundary (gfc_loopinfo *, stmtblock_t *);
123 /* Initialize the scalarization loop parameters.  */
124 void gfc_conv_loop_setup (gfc_loopinfo *, locus *);
125 /* Set each array's delta.  */
126 void gfc_set_delta (gfc_loopinfo *);
127 /* Resolve array assignment dependencies.  */
128 void gfc_conv_resolve_dependencies (gfc_loopinfo *, gfc_ss *, gfc_ss *);
129 /* Build a null array descriptor constructor.  */
130 tree gfc_build_null_descriptor (tree);
131 
132 /* Get a single array element.  */
133 void gfc_conv_array_ref (gfc_se *, gfc_array_ref *, gfc_expr *, locus *);
134 /* Translate a reference to a temporary array.  */
135 void gfc_conv_tmp_array_ref (gfc_se * se);
136 /* Translate a reference to an array temporary.  */
137 void gfc_conv_tmp_ref (gfc_se *);
138 
139 /* Calculate the overall offset, including subreferences.  */
140 void gfc_get_dataptr_offset (stmtblock_t*, tree, tree, tree, bool, gfc_expr*);
141 /* Obtain the span of an array.  */
142 tree gfc_get_array_span (tree, gfc_expr *);
143 /* Evaluate an array expression.  */
144 void gfc_conv_expr_descriptor (gfc_se *, gfc_expr *);
145 /* Convert an array for passing as an actual function parameter.  */
146 void gfc_conv_array_parameter (gfc_se *, gfc_expr *, bool,
147 			       const gfc_symbol *, const char *, tree *);
148 /* Evaluate and transpose a matrix expression.  */
149 void gfc_conv_array_transpose (gfc_se *, gfc_expr *);
150 
151 /* These work with both descriptors and descriptorless arrays.  */
152 tree gfc_conv_array_data (tree);
153 tree gfc_conv_array_offset (tree);
154 /* Return either an INT_CST or an expression for that part of the descriptor.  */
155 tree gfc_conv_array_stride (tree, int);
156 tree gfc_conv_array_lbound (tree, int);
157 tree gfc_conv_array_ubound (tree, int);
158 
159 /* Set cobounds of an array.  */
160 void gfc_trans_array_cobounds (tree, stmtblock_t *, const gfc_symbol *);
161 
162 /* Build expressions for accessing components of an array descriptor.  */
163 void gfc_get_descriptor_offsets_for_info (const_tree, tree *, tree *, tree *, tree *,
164 					  tree *, tree *, tree *, tree *);
165 
166 tree gfc_conv_descriptor_data_get (tree);
167 tree gfc_conv_descriptor_data_addr (tree);
168 tree gfc_conv_descriptor_offset_get (tree);
169 tree gfc_conv_descriptor_span_get (tree);
170 tree gfc_conv_descriptor_dtype (tree);
171 tree gfc_conv_descriptor_rank (tree);
172 tree gfc_conv_descriptor_elem_len (tree);
173 tree gfc_conv_descriptor_attribute (tree);
174 tree gfc_get_descriptor_dimension (tree);
175 tree gfc_conv_descriptor_stride_get (tree, tree);
176 tree gfc_conv_descriptor_lbound_get (tree, tree);
177 tree gfc_conv_descriptor_ubound_get (tree, tree);
178 tree gfc_conv_descriptor_token (tree);
179 
180 void gfc_conv_descriptor_data_set (stmtblock_t *, tree, tree);
181 void gfc_conv_descriptor_offset_set (stmtblock_t *, tree, tree);
182 void gfc_conv_descriptor_span_set (stmtblock_t *, tree, tree);
183 void gfc_conv_descriptor_stride_set (stmtblock_t *, tree, tree, tree);
184 void gfc_conv_descriptor_lbound_set (stmtblock_t *, tree, tree, tree);
185 void gfc_conv_descriptor_ubound_set (stmtblock_t *, tree, tree, tree);
186 
187 /* Shift lower bound of descriptor, updating ubound and offset.  */
188 void gfc_conv_shift_descriptor_lbound (stmtblock_t*, tree, int, tree);
189 
190 /* Add pre-loop scalarization code for intrinsic functions which require
191    special handling.  */
192 void gfc_add_intrinsic_ss_code (gfc_loopinfo *, gfc_ss *);
193 
194 /* Functions for constant array constructor processing.  */
195 unsigned HOST_WIDE_INT gfc_constant_array_constructor_p (gfc_constructor_base);
196 tree gfc_build_constant_array_constructor (gfc_expr *, tree);
197 
198 /* Copy a string from src to dest.  */
199 void gfc_trans_string_copy (stmtblock_t *, tree, tree, int, tree, tree, int);
200 
201 /* Calculate extent / size of an array.  */
202 tree gfc_conv_array_extent_dim (tree, tree, tree*);
203 tree gfc_conv_descriptor_size (tree, int);
204 tree gfc_conv_descriptor_cosize (tree, int, int);
205