1 /* This file is part of the Intel(R) Cilk(TM) Plus support
2 This file contains the builtin functions for Array
4 Copyright (C) 2013-2015 Free Software Foundation, Inc.
5 Contributed by Balaji V. Iyer <balaji.v.iyer@intel.com>,
8 This file is part of GCC.
10 GCC is free software; you can redistribute it and/or modify it
11 under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3, or (at your option)
15 GCC is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with GCC; see the file COPYING3. If not see
22 <http://www.gnu.org/licenses/>. */
26 #include "coretypes.h"
30 #include "langhooks.h"
31 #include "tree-iterator.h"
32 #include "c-family/c-common.h"
33 #include "diagnostic-core.h"
35 /* Returns true if the function call in FNDECL is __sec_implicit_index. */
38 is_sec_implicit_index_fn (tree fndecl
)
43 if (TREE_CODE (fndecl
) == ADDR_EXPR
)
44 fndecl
= TREE_OPERAND (fndecl
, 0);
47 (TREE_CODE (fndecl
) == FUNCTION_DECL
48 && DECL_BUILT_IN_CLASS (fndecl
) == BUILT_IN_NORMAL
49 && DECL_FUNCTION_CODE (fndecl
) == BUILT_IN_CILKPLUS_SEC_IMPLICIT_INDEX
);
52 /* Returns the first and only argument for FN, which should be a
53 sec_implicit_index function. FN's location in the source file is as
54 indicated by LOCATION. The argument to FN must be a constant integer
55 expression, otherwise returns -1. */
58 extract_sec_implicit_index_arg (location_t location
, tree fn
)
61 HOST_WIDE_INT return_int
= 0;
63 if (TREE_CODE (fn
) == CALL_EXPR
)
65 fn_arg
= CALL_EXPR_ARG (fn
, 0);
66 if (TREE_CODE (fn_arg
) == INTEGER_CST
)
67 return_int
= int_cst_value (fn_arg
);
70 /* If the location is unknown, and if fn has a location, then use that
71 information so that the user has a better idea where the error
73 if (location
== UNKNOWN_LOCATION
&& EXPR_HAS_LOCATION (fn
))
74 location
= EXPR_LOCATION (fn
);
75 error_at (location
, "__sec_implicit_index parameter must be an "
76 "integer constant expression");
83 /* Returns true if there is a length mismatch among exprssions that are at the
84 same dimension and one the same side of the equal sign. The Array notation
85 lengths (LIST->LENGTH) is passed in as a 2D vector of trees. */
88 length_mismatch_in_expr_p (location_t loc
, vec
<vec
<an_parts
> >list
)
91 tree length
= NULL_TREE
;
93 size_t x
= list
.length ();
94 size_t y
= list
[0].length ();
96 for (jj
= 0; jj
< y
; jj
++)
99 for (ii
= 0; ii
< x
; ii
++)
102 length
= list
[ii
][jj
].length
;
103 else if (TREE_CODE (length
) == INTEGER_CST
)
105 /* If length is a INTEGER, and list[ii][jj] is an integer then
106 check if they are equal. If they are not equal then return
108 if (TREE_CODE (list
[ii
][jj
].length
) == INTEGER_CST
109 && !tree_int_cst_equal (list
[ii
][jj
].length
, length
))
111 error_at (loc
, "length mismatch in expression");
116 /* We set the length node as the current node just in case it turns
117 out to be an integer. */
118 length
= list
[ii
][jj
].length
;
124 /* Given an FNDECL of type FUNCTION_DECL or ADDR_EXPR, return the corresponding
125 BUILT_IN_CILKPLUS_SEC_REDUCE_* being called. If none, return
128 enum built_in_function
129 is_cilkplus_reduce_builtin (tree fndecl
)
132 return BUILT_IN_NONE
;
133 if (TREE_CODE (fndecl
) == ADDR_EXPR
)
134 fndecl
= TREE_OPERAND (fndecl
, 0);
136 if (TREE_CODE (fndecl
) == FUNCTION_DECL
137 && DECL_BUILT_IN_CLASS (fndecl
) == BUILT_IN_NORMAL
)
138 switch (DECL_FUNCTION_CODE (fndecl
))
140 case BUILT_IN_CILKPLUS_SEC_REDUCE_ADD
:
141 case BUILT_IN_CILKPLUS_SEC_REDUCE_MUL
:
142 case BUILT_IN_CILKPLUS_SEC_REDUCE_ALL_ZERO
:
143 case BUILT_IN_CILKPLUS_SEC_REDUCE_ANY_ZERO
:
144 case BUILT_IN_CILKPLUS_SEC_REDUCE_MAX
:
145 case BUILT_IN_CILKPLUS_SEC_REDUCE_MIN
:
146 case BUILT_IN_CILKPLUS_SEC_REDUCE_MIN_IND
:
147 case BUILT_IN_CILKPLUS_SEC_REDUCE_MAX_IND
:
148 case BUILT_IN_CILKPLUS_SEC_REDUCE_ANY_NONZERO
:
149 case BUILT_IN_CILKPLUS_SEC_REDUCE_ALL_NONZERO
:
150 case BUILT_IN_CILKPLUS_SEC_REDUCE
:
151 case BUILT_IN_CILKPLUS_SEC_REDUCE_MUTATING
:
152 return DECL_FUNCTION_CODE (fndecl
);
157 return BUILT_IN_NONE
;
160 /* This function will recurse into EXPR finding any
161 ARRAY_NOTATION_EXPRs and calculate the overall rank of EXPR,
162 storing it in *RANK. LOC is the location of the original expression.
164 ORIG_EXPR is the original expression used to display if any rank
165 mismatch errors are found.
167 Upon entry, *RANK must be either 0, or the rank of a parent
168 expression that must have the same rank as the one being
169 calculated. It is illegal to have multiple array notation with different
170 rank in the same expression (see examples below for clarification).
172 If there were any rank mismatches while calculating the rank, an
173 error will be issued, and FALSE will be returned. Otherwise, TRUE
176 If IGNORE_BUILTIN_FN is TRUE, ignore array notation specific
177 built-in functions (__sec_reduce_*, etc).
179 Here are some examples of array notations and their rank:
190 D[5][0:10:2] 1 (since D[5] is considered "scalar")
194 F[:][:][:] + E[:] + 5 + X RANKMISMATCH-ERROR since rank (E[:]) = 1 and
195 rank (F[:][:][:]) = 3. They must be equal
196 or have a rank of zero.
197 F[:][5][10] + E[:] * 5 + *Y 1
201 func (B[:][:][:][:]) 4
204 func2 (A[:], B[:][:][:][:]) RANKMISMATCH-ERROR -- Since Rank (A[:]) = 1
205 and Rank (B[:][:][:][:]) = 4
207 A[:] + func (B[:][:][:][:]) RANKMISMATCH-ERROR
208 func2 (A[:], B[:]) + func (A) 1
213 find_rank (location_t loc
, tree orig_expr
, tree expr
, bool ignore_builtin_fn
,
217 size_t ii
= 0, current_rank
= 0;
219 if (TREE_CODE (expr
) == ARRAY_NOTATION_REF
)
224 if (TREE_CODE (ii_tree
) == ARRAY_NOTATION_REF
)
227 ii_tree
= ARRAY_NOTATION_ARRAY (ii_tree
);
229 else if (handled_component_p (ii_tree
)
230 || INDIRECT_REF_P (ii_tree
))
231 ii_tree
= TREE_OPERAND (ii_tree
, 0);
232 else if (TREE_CODE (ii_tree
) == PARM_DECL
239 /* In this case, all the expressions this function has encountered thus
240 far have been scalars or expressions with zero rank. Please see
241 header comment for examples of such expression. */
242 *rank
= current_rank
;
243 else if (*rank
!= current_rank
)
245 /* In this case, find rank is being recursed through a set of
246 expression of the form A <OPERATION> B, where A and B both have
247 array notations in them and the rank of A is not equal to rank of
249 A simple example of such case is the following: X[:] + Y[:][:] */
250 *rank
= current_rank
;
254 else if (TREE_CODE (expr
) == STATEMENT_LIST
)
256 tree_stmt_iterator ii_tsi
;
257 for (ii_tsi
= tsi_start (expr
); !tsi_end_p (ii_tsi
);
259 if (!find_rank (loc
, orig_expr
, *tsi_stmt_ptr (ii_tsi
),
260 ignore_builtin_fn
, rank
))
265 if (TREE_CODE (expr
) == CALL_EXPR
)
267 tree func_name
= CALL_EXPR_FN (expr
);
268 tree prev_arg
= NULL_TREE
, arg
;
269 call_expr_arg_iterator iter
;
270 size_t prev_rank
= 0;
271 if (TREE_CODE (func_name
) == ADDR_EXPR
)
272 if (!ignore_builtin_fn
)
273 if (is_cilkplus_reduce_builtin (func_name
))
274 /* If it is a built-in function, then we know it returns a
277 if (!find_rank (loc
, orig_expr
, func_name
, ignore_builtin_fn
, rank
))
279 FOR_EACH_CALL_EXPR_ARG (arg
, iter
, expr
)
281 if (!find_rank (loc
, orig_expr
, arg
, ignore_builtin_fn
, rank
))
283 if (prev_arg
&& EXPR_HAS_LOCATION (prev_arg
)
284 && prev_rank
!= *rank
)
285 error_at (EXPR_LOCATION (prev_arg
),
286 "rank mismatch between %qE and %qE", prev_arg
,
288 else if (prev_arg
&& prev_rank
!= *rank
)
289 /* Here the original expression is printed as a "heads-up"
290 to the programmer. This is because since there is no
291 location information for the offending argument, the
292 error could be in some internally generated code that is
293 not visible for the programmer. Thus, the correct fix
294 may lie in the original expression. */
295 error_at (loc
, "rank mismatch in expression %qE",
305 tree prev_arg
= NULL_TREE
;
306 for (ii
= 0; ii
< TREE_CODE_LENGTH (TREE_CODE (expr
)); ii
++)
308 if (TREE_OPERAND (expr
, ii
)
309 && !find_rank (loc
, orig_expr
, TREE_OPERAND (expr
, ii
),
310 ignore_builtin_fn
, rank
))
312 if (prev_arg
&& EXPR_HAS_LOCATION (prev_arg
))
313 error_at (EXPR_LOCATION (prev_arg
),
314 "rank mismatch between %qE and %qE", prev_arg
,
315 TREE_OPERAND (expr
, ii
));
318 prev_arg
= TREE_OPERAND (expr
, ii
);
325 /* Extracts all array notations in NODE and stores them in ARRAY_LIST. If
326 IGNORE_BUILTIN_FN is set, then array notations inside array notation
327 specific built-in functions are ignored. The NODE can be constants,
328 VAR_DECL, PARM_DECLS, STATEMENT_LISTS or full expressions. */
331 extract_array_notation_exprs (tree node
, bool ignore_builtin_fn
,
332 vec
<tree
, va_gc
> **array_list
)
338 if (TREE_CODE (node
) == ARRAY_NOTATION_REF
)
340 vec_safe_push (*array_list
, node
);
343 if (TREE_CODE (node
) == DECL_EXPR
)
345 tree x
= DECL_EXPR_DECL (node
);
346 if (DECL_INITIAL (x
))
347 extract_array_notation_exprs (DECL_INITIAL (x
),
351 else if (TREE_CODE (node
) == STATEMENT_LIST
)
353 tree_stmt_iterator ii_tsi
;
354 for (ii_tsi
= tsi_start (node
); !tsi_end_p (ii_tsi
); tsi_next (&ii_tsi
))
355 extract_array_notation_exprs (*tsi_stmt_ptr (ii_tsi
),
356 ignore_builtin_fn
, array_list
);
358 else if (TREE_CODE (node
) == CALL_EXPR
)
361 call_expr_arg_iterator iter
;
362 if (is_cilkplus_reduce_builtin (CALL_EXPR_FN (node
)))
364 if (ignore_builtin_fn
)
368 vec_safe_push (*array_list
, node
);
372 if (is_sec_implicit_index_fn (CALL_EXPR_FN (node
)))
374 vec_safe_push (*array_list
, node
);
377 /* This will extract array notations in function pointers. */
378 extract_array_notation_exprs (CALL_EXPR_FN (node
), ignore_builtin_fn
,
380 FOR_EACH_CALL_EXPR_ARG (arg
, iter
, node
)
381 extract_array_notation_exprs (arg
, ignore_builtin_fn
, array_list
);
384 for (ii
= 0; ii
< TREE_CODE_LENGTH (TREE_CODE (node
)); ii
++)
385 if (TREE_OPERAND (node
, ii
))
386 extract_array_notation_exprs (TREE_OPERAND (node
, ii
),
387 ignore_builtin_fn
, array_list
);
391 /* LIST contains all the array notations found in *ORIG and ARRAY_OPERAND
392 contains the expanded ARRAY_REF. E.g., if LIST[<some_index>] contains
393 an array_notation expression, then ARRAY_OPERAND[<some_index>] contains its
394 expansion. If *ORIG matches LIST[<some_index>] then *ORIG is set to
395 ARRAY_OPERAND[<some_index>]. This function recursively steps through
396 all the sub-trees of *ORIG, if it is larger than a single
397 ARRAY_NOTATION_REF. */
400 replace_array_notations (tree
*orig
, bool ignore_builtin_fn
,
401 vec
<tree
, va_gc
> *list
,
402 vec
<tree
, va_gc
> *array_operand
)
405 extern tree
build_c_cast (location_t
, tree
, tree
);
406 tree node
= NULL_TREE
, node_replacement
= NULL_TREE
;
408 if (vec_safe_length (list
) == 0)
411 if (TREE_CODE (*orig
) == ARRAY_NOTATION_REF
)
413 for (ii
= 0; vec_safe_iterate (list
, ii
, &node
); ii
++)
416 node_replacement
= (*array_operand
)[ii
];
417 *orig
= node_replacement
;
420 else if (TREE_CODE (*orig
) == STATEMENT_LIST
)
422 tree_stmt_iterator ii_tsi
;
423 for (ii_tsi
= tsi_start (*orig
); !tsi_end_p (ii_tsi
); tsi_next (&ii_tsi
))
424 replace_array_notations (tsi_stmt_ptr (ii_tsi
), ignore_builtin_fn
, list
,
427 else if (TREE_CODE (*orig
) == CALL_EXPR
)
430 call_expr_arg_iterator iter
;
431 if (is_cilkplus_reduce_builtin (CALL_EXPR_FN (*orig
)))
433 if (!ignore_builtin_fn
)
435 for (ii
= 0; vec_safe_iterate (list
, ii
, &node
); ii
++)
438 node_replacement
= (*array_operand
)[ii
];
439 *orig
= node_replacement
;
444 if (is_sec_implicit_index_fn (CALL_EXPR_FN (*orig
)))
446 for (ii
= 0; vec_safe_iterate (list
, ii
, &node
); ii
++)
449 node_replacement
= (*array_operand
)[ii
];
450 *orig
= build_c_cast (EXPR_LOCATION (*orig
),
451 TREE_TYPE (*orig
), node_replacement
);
455 /* Fixes array notations in array notations in function pointers. */
456 replace_array_notations (&CALL_EXPR_FN (*orig
), ignore_builtin_fn
, list
,
459 FOR_EACH_CALL_EXPR_ARG (arg
, iter
, *orig
)
461 replace_array_notations (&arg
, ignore_builtin_fn
, list
,
463 CALL_EXPR_ARG (*orig
, ii
) = arg
;
469 for (ii
= 0; ii
< (size_t) TREE_CODE_LENGTH (TREE_CODE (*orig
)); ii
++)
470 if (TREE_OPERAND (*orig
, ii
))
471 replace_array_notations (&TREE_OPERAND (*orig
, ii
), ignore_builtin_fn
,
472 list
, array_operand
);
477 /* Callback for walk_tree. Find all the scalar expressions in *TP and push
478 them in DATA struct, typecasted to (void *). If *WALK_SUBTREES is set to 0
479 then do not go into the *TP's subtrees. Since this function steps through
480 all the subtrees, *TP and TP can be NULL_TREE and NULL, respectively. The
481 function returns NULL_TREE unconditionally. */
484 find_inv_trees (tree
*tp
, int *walk_subtrees
, void *data
)
486 struct inv_list
*i_list
= (struct inv_list
*) data
;
491 if (TREE_CONSTANT (*tp
))
492 return NULL_TREE
; /* No need to save constant to a variable. */
493 if (TREE_CODE (*tp
) != COMPOUND_EXPR
&& !contains_array_notation_expr (*tp
))
495 vec_safe_push (i_list
->list_values
, *tp
);
498 else if (TREE_CODE (*tp
) == ARRAY_NOTATION_REF
499 || TREE_CODE (*tp
) == ARRAY_REF
500 || TREE_CODE (*tp
) == CALL_EXPR
)
501 /* No need to step through the internals of array notation. */
507 /* This function is used by C and C++ front-ends. In C++, additional
508 tree codes such as TARGET_EXPR must be eliminated. These codes are
509 passed into additional_tcodes and are walked through and checked. */
510 for (ii
= 0; ii
< vec_safe_length (i_list
->additional_tcodes
); ii
++)
511 if (TREE_CODE (*tp
) == (*(i_list
->additional_tcodes
))[ii
])
517 /* Callback for walk_tree. Replace all the scalar expressions in *TP with the
518 appropriate replacement stored in the struct *DATA (typecasted to void*).
519 The subtrees are not touched if *WALK_SUBTREES is set to zero. */
522 replace_inv_trees (tree
*tp
, int *walk_subtrees
, void *data
)
526 struct inv_list
*i_list
= (struct inv_list
*) data
;
528 if (vec_safe_length (i_list
->list_values
))
530 for (ii
= 0; vec_safe_iterate (i_list
->list_values
, ii
, &t
); ii
++)
531 if (simple_cst_equal (*tp
, t
) == 1)
533 vec_safe_iterate (i_list
->replacement
, ii
, &r
);
534 gcc_assert (r
!= NULL_TREE
);
544 /* Returns true if EXPR or any of its subtrees contain ARRAY_NOTATION_EXPR
548 contains_array_notation_expr (tree expr
)
550 vec
<tree
, va_gc
> *array_list
= NULL
;
554 if (TREE_CODE (expr
) == FUNCTION_DECL
)
555 if (is_cilkplus_reduce_builtin (expr
))
558 extract_array_notation_exprs (expr
, false, &array_list
);
559 if (vec_safe_length (array_list
) == 0)
565 /* This function will check if OP is a CALL_EXPR that is a built-in array
566 notation function. If so, then we will return its type to be the type of
567 the array notation inside. */
570 find_correct_array_notation_type (tree op
)
572 tree fn_arg
, return_type
= NULL_TREE
;
576 return_type
= TREE_TYPE (op
); /* This is the default case. */
577 if (TREE_CODE (op
) == CALL_EXPR
)
578 if (is_cilkplus_reduce_builtin (CALL_EXPR_FN (op
)))
580 fn_arg
= CALL_EXPR_ARG (op
, 0);
582 return_type
= TREE_TYPE (fn_arg
);
588 /* Extracts all the array notation triplet information from LIST and stores
589 them in the following fields of the 2-D array NODE(size x rank):
590 START, LENGTH and STRIDE, holding the starting index, length, and stride,
591 respectively. In addition, it also sets two bool fields, IS_VECTOR and
592 COUNT_DOWN, in NODE indicating whether a certain value at a certain field
593 is a vector and if the array is accessed from high to low. */
596 cilkplus_extract_an_triplets (vec
<tree
, va_gc
> *list
, size_t size
, size_t rank
,
597 vec
<vec
<struct cilkplus_an_parts
> > *node
)
599 vec
<vec
<tree
> > array_exprs
= vNULL
;
601 node
->safe_grow_cleared (size
);
602 array_exprs
.safe_grow_cleared (size
);
605 for (size_t ii
= 0; ii
< size
; ii
++)
607 (*node
)[ii
].safe_grow_cleared (rank
);
608 array_exprs
[ii
].safe_grow_cleared (rank
);
610 for (size_t ii
= 0; ii
< size
; ii
++)
613 tree ii_tree
= (*list
)[ii
];
616 if (TREE_CODE (ii_tree
) == ARRAY_NOTATION_REF
)
618 array_exprs
[ii
][jj
] = ii_tree
;
620 ii_tree
= ARRAY_NOTATION_ARRAY (ii_tree
);
622 else if (TREE_CODE (ii_tree
) == ARRAY_REF
)
623 ii_tree
= TREE_OPERAND (ii_tree
, 0);
628 for (size_t ii
= 0; ii
< size
; ii
++)
629 if (TREE_CODE ((*list
)[ii
]) == ARRAY_NOTATION_REF
)
630 for (size_t jj
= 0; jj
< rank
; jj
++)
632 tree ii_tree
= array_exprs
[ii
][jj
];
633 (*node
)[ii
][jj
].is_vector
= true;
634 (*node
)[ii
][jj
].value
= ARRAY_NOTATION_ARRAY (ii_tree
);
635 (*node
)[ii
][jj
].start
= ARRAY_NOTATION_START (ii_tree
);
636 (*node
)[ii
][jj
].length
=
637 fold_build1 (CONVERT_EXPR
, integer_type_node
,
638 ARRAY_NOTATION_LENGTH (ii_tree
));
639 (*node
)[ii
][jj
].stride
=
640 fold_build1 (CONVERT_EXPR
, integer_type_node
,
641 ARRAY_NOTATION_STRIDE (ii_tree
));
645 /* Replaces all the __sec_implicit_arg functions in LIST with the induction
646 variable stored in VAR at the appropriate location pointed by the
647 __sec_implicit_arg's first parameter. Emits an error if the parameter is
648 not between 0 and RANK. */
651 fix_sec_implicit_args (location_t loc
, vec
<tree
, va_gc
> *list
,
652 vec
<an_loop_parts
> an_loop_info
, size_t rank
,
655 vec
<tree
, va_gc
> *array_operand
= NULL
;
656 for (size_t ii
= 0; ii
< vec_safe_length (list
); ii
++)
657 if (TREE_CODE ((*list
)[ii
]) == CALL_EXPR
658 && is_sec_implicit_index_fn (CALL_EXPR_FN ((*list
)[ii
])))
660 int idx
= extract_sec_implicit_index_arg (loc
, (*list
)[ii
]);
662 /* In this case, the returning function would have emitted an
663 error thus it is not necessary to do so again. */
665 else if (idx
< (int) rank
)
666 vec_safe_push (array_operand
, an_loop_info
[idx
].var
);
669 error_at (loc
, "__sec_implicit_index argument %d must be "
670 "less than the rank of %qE", idx
, orig_stmt
);
675 /* Save the existing value into the array operand. */
676 vec_safe_push (array_operand
, (*list
)[ii
]);
677 return array_operand
;