xref: /netbsd-src/external/gpl3/gcc/dist/gcc/fortran/trans-array.h (revision b1e838363e3c6fc78a55519254d99869742dd33c)
1 /* Header for array handling functions
2    Copyright (C) 2002-2022 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_tree_array_size (stmtblock_t *, tree, gfc_expr *, tree);
43 
44 tree gfc_full_array_size (stmtblock_t *, tree, int);
45 
46 tree gfc_duplicate_allocatable (tree, tree, tree, int, tree);
47 
48 tree gfc_copy_allocatable_data (tree dest, tree src, tree type, int rank);
49 
50 tree gfc_duplicate_allocatable_nocopy (tree, tree, tree, int);
51 
52 bool gfc_caf_is_dealloc_only (int);
53 
54 tree gfc_nullify_alloc_comp (gfc_symbol *, tree, int, int cm = 0);
55 
56 tree gfc_deallocate_alloc_comp (gfc_symbol *, tree, int, int cm = 0);
57 tree gfc_bcast_alloc_comp (gfc_symbol *, gfc_expr *, int, tree,
58 			   tree, tree, tree);
59 tree gfc_deallocate_alloc_comp_no_caf (gfc_symbol *, tree, int);
60 tree gfc_reassign_alloc_comp_caf (gfc_symbol *, tree, tree);
61 
62 tree gfc_copy_alloc_comp (gfc_symbol *, tree, tree, int, int);
63 
64 tree gfc_copy_only_alloc_comp (gfc_symbol *, tree, tree, int);
65 
66 tree gfc_allocate_pdt_comp (gfc_symbol *, tree, int, gfc_actual_arglist *);
67 tree gfc_deallocate_pdt_comp (gfc_symbol *, tree, int);
68 tree gfc_check_pdt_dummy (gfc_symbol *, tree, int, gfc_actual_arglist *);
69 
70 tree gfc_alloc_allocatable_for_assignment (gfc_loopinfo*, gfc_expr*, gfc_expr*);
71 
72 /* Add initialization for class descriptors  */
73 void gfc_trans_class_array (gfc_symbol *, gfc_wrapped_block *);
74 /* Add initialization for deferred arrays.  */
75 void gfc_trans_deferred_array (gfc_symbol *, gfc_wrapped_block *);
76 /* Generate an initializer for a static pointer or allocatable array.  */
77 void gfc_trans_static_array_pointer (gfc_symbol *);
78 
79 /* Get the procedure interface for a function call.  */
80 gfc_symbol *gfc_get_proc_ifc_for_expr (gfc_expr *);
81 /* Get the intrinsic symbol for an intrinsic function call.  */
82 gfc_intrinsic_sym *gfc_get_intrinsic_for_expr (gfc_expr *);
83 /* Generate scalarization information for an expression.  */
84 gfc_ss *gfc_walk_expr (gfc_expr *);
85 /* Workhorse for gfc_walk_expr.  */
86 gfc_ss *gfc_walk_subexpr (gfc_ss *, gfc_expr *);
87 /* Workhorse for gfc_walk_variable_expr.  */
88 gfc_ss *gfc_walk_array_ref (gfc_ss *, gfc_expr *, gfc_ref * ref);
89 /* Walk the arguments of an elemental function.  */
90 gfc_ss *gfc_walk_elemental_function_args (gfc_ss *, gfc_actual_arglist *,
91 					  gfc_intrinsic_sym *,
92 					  gfc_ss_type);
93 /* Walk an intrinsic function.  */
94 gfc_ss *gfc_walk_intrinsic_function (gfc_ss *, gfc_expr *,
95 				     gfc_intrinsic_sym *);
96 /* Reverse the order of an SS chain.  */
97 gfc_ss *gfc_reverse_ss (gfc_ss *);
98 
99 /* Free the SS associated with a loop.  */
100 void gfc_cleanup_loop (gfc_loopinfo *);
101 /* Associate a SS chain with a loop.  */
102 void gfc_add_ss_to_loop (gfc_loopinfo *, gfc_ss *);
103 /* Mark a SS chain as used in this loop.  */
104 void gfc_mark_ss_chain_used (gfc_ss *, unsigned);
105 /* Free a gfc_ss chain.  */
106 void gfc_free_ss_chain (gfc_ss *);
107 /* Free a single gfc_ss element.  */
108 void gfc_free_ss (gfc_ss *);
109 /* Allocate a new array type ss.  */
110 gfc_ss *gfc_get_array_ss (gfc_ss *, gfc_expr *, int, gfc_ss_type);
111 /* Allocate a new temporary type ss.  */
112 gfc_ss *gfc_get_temp_ss (tree, tree, int);
113 /* Allocate a new scalar type ss.  */
114 gfc_ss *gfc_get_scalar_ss (gfc_ss *, gfc_expr *);
115 
116 bool gfc_scalar_elemental_arg_saved_as_reference (gfc_ss_info *);
117 
118 /* Calculates the lower bound and stride of array sections.  */
119 void gfc_conv_ss_startstride (gfc_loopinfo *);
120 
121 void gfc_init_loopinfo (gfc_loopinfo *);
122 void gfc_copy_loopinfo_to_se (gfc_se *, gfc_loopinfo *);
123 
124 /* Marks the start of a scalarized expression, and declares loop variables.  */
125 void gfc_start_scalarized_body (gfc_loopinfo *, stmtblock_t *);
126 /* Generates the actual loops for a scalarized expression.  */
127 void gfc_trans_scalarizing_loops (gfc_loopinfo *, stmtblock_t *);
128 /* Mark the end of the main loop body and the start of the copying loop.  */
129 void gfc_trans_scalarized_loop_boundary (gfc_loopinfo *, stmtblock_t *);
130 /* Initialize the scalarization loop parameters.  */
131 void gfc_conv_loop_setup (gfc_loopinfo *, locus *);
132 /* Set each array's delta.  */
133 void gfc_set_delta (gfc_loopinfo *);
134 /* Resolve array assignment dependencies.  */
135 void gfc_conv_resolve_dependencies (gfc_loopinfo *, gfc_ss *, gfc_ss *);
136 /* Build a null array descriptor constructor.  */
137 tree gfc_build_null_descriptor (tree);
138 
139 /* Get a single array element.  */
140 void gfc_conv_array_ref (gfc_se *, gfc_array_ref *, gfc_expr *, locus *);
141 /* Translate a reference to a temporary array.  */
142 void gfc_conv_tmp_array_ref (gfc_se * se);
143 
144 /* Calculate the overall offset, including subreferences.  */
145 void gfc_get_dataptr_offset (stmtblock_t*, tree, tree, tree, bool, gfc_expr*);
146 /* Obtain the span of an array.  */
147 tree gfc_get_array_span (tree, gfc_expr *);
148 /* Evaluate an array expression.  */
149 void gfc_conv_expr_descriptor (gfc_se *, gfc_expr *);
150 /* Convert an array for passing as an actual function parameter.  */
151 void gfc_conv_array_parameter (gfc_se *, gfc_expr *, bool,
152 			       const gfc_symbol *, const char *, tree *);
153 
154 /* These work with both descriptors and descriptorless arrays.  */
155 tree gfc_conv_array_data (tree);
156 tree gfc_conv_array_offset (tree);
157 /* Return either an INT_CST or an expression for that part of the descriptor.  */
158 tree gfc_conv_array_stride (tree, int);
159 tree gfc_conv_array_lbound (tree, int);
160 tree gfc_conv_array_ubound (tree, int);
161 
162 /* Set (co)bounds of an array.  */
163 tree gfc_trans_array_bounds (tree, gfc_symbol *, tree *, stmtblock_t *);
164 void gfc_trans_array_cobounds (tree, stmtblock_t *, const gfc_symbol *);
165 
166 /* Build expressions for accessing components of an array descriptor.  */
167 void gfc_get_descriptor_offsets_for_info (const_tree, tree *, tree *, tree *, tree *,
168 					  tree *, tree *, tree *, tree *);
169 
170 tree gfc_conv_descriptor_data_get (tree);
171 tree gfc_conv_descriptor_data_addr (tree);
172 tree gfc_conv_descriptor_offset_get (tree);
173 tree gfc_conv_descriptor_span_get (tree);
174 tree gfc_conv_descriptor_dtype (tree);
175 tree gfc_conv_descriptor_rank (tree);
176 tree gfc_conv_descriptor_elem_len (tree);
177 tree gfc_conv_descriptor_attribute (tree);
178 tree gfc_conv_descriptor_type (tree);
179 tree gfc_get_descriptor_dimension (tree);
180 tree gfc_conv_descriptor_stride_get (tree, tree);
181 tree gfc_conv_descriptor_lbound_get (tree, tree);
182 tree gfc_conv_descriptor_ubound_get (tree, tree);
183 tree gfc_conv_descriptor_token (tree);
184 
185 void gfc_conv_descriptor_data_set (stmtblock_t *, tree, tree);
186 void gfc_conv_descriptor_offset_set (stmtblock_t *, tree, tree);
187 void gfc_conv_descriptor_span_set (stmtblock_t *, tree, tree);
188 void gfc_conv_descriptor_stride_set (stmtblock_t *, tree, tree, tree);
189 void gfc_conv_descriptor_lbound_set (stmtblock_t *, tree, tree, tree);
190 void gfc_conv_descriptor_ubound_set (stmtblock_t *, tree, tree, tree);
191 
192 /* CFI descriptor.  */
193 tree gfc_get_cfi_desc_base_addr (tree);
194 tree gfc_get_cfi_desc_elem_len (tree);
195 tree gfc_get_cfi_desc_version (tree);
196 tree gfc_get_cfi_desc_rank (tree);
197 tree gfc_get_cfi_desc_type (tree);
198 tree gfc_get_cfi_desc_attribute (tree);
199 tree gfc_get_cfi_dim_lbound (tree, tree);
200 tree gfc_get_cfi_dim_extent (tree, tree);
201 tree gfc_get_cfi_dim_sm (tree, tree);
202 
203 
204 /* Shift lower bound of descriptor, updating ubound and offset.  */
205 void gfc_conv_shift_descriptor_lbound (stmtblock_t*, tree, int, tree);
206 
207 /* Add pre-loop scalarization code for intrinsic functions which require
208    special handling.  */
209 void gfc_add_intrinsic_ss_code (gfc_loopinfo *, gfc_ss *);
210 
211 /* Functions for constant array constructor processing.  */
212 unsigned HOST_WIDE_INT gfc_constant_array_constructor_p (gfc_constructor_base);
213 tree gfc_build_constant_array_constructor (gfc_expr *, tree);
214 
215 /* Copy a string from src to dest.  */
216 void gfc_trans_string_copy (stmtblock_t *, tree, tree, int, tree, tree, int);
217 
218 /* Calculate extent / size of an array.  */
219 tree gfc_conv_array_extent_dim (tree, tree, tree*);
220 tree gfc_conv_descriptor_size (tree, int);
221 tree gfc_conv_descriptor_cosize (tree, int, int);
222