Avoid no-stack-protector-attr fails on hppa*-*-*.
[official-gcc.git] / gcc / omp-oacc-kernels-decompose.cc
blobc624e26be88a14ef7caf0bfdccd1aaf5c3ad67a7
1 /* Decompose OpenACC 'kernels' constructs into parts, a sequence of compute
2 constructs
4 Copyright (C) 2020-2021 Free Software Foundation, Inc.
6 This file is part of GCC.
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.
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.
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/>. */
22 #include "config.h"
23 #include "system.h"
24 #include "coretypes.h"
25 #include "backend.h"
26 #include "target.h"
27 #include "tree.h"
28 #include "langhooks.h"
29 #include "gimple.h"
30 #include "tree-pass.h"
31 #include "cgraph.h"
32 #include "fold-const.h"
33 #include "gimplify.h"
34 #include "gimple-iterator.h"
35 #include "gimple-walk.h"
36 #include "gomp-constants.h"
37 #include "omp-general.h"
38 #include "diagnostic-core.h"
41 /* This preprocessing pass is run immediately before lower_omp. It decomposes
42 OpenACC 'kernels' constructs into parts, a sequence of compute constructs.
44 The translation is as follows:
45 - The entire 'kernels' region is turned into a 'data' region with clauses
46 taken from the 'kernels' region. New 'create' clauses are added for all
47 variables declared at the top level in the kernels region.
48 - Any loop nests annotated with an OpenACC 'loop' directive are wrapped in
49 a new compute construct.
50 - 'loop' directives without an explicit 'independent' or 'seq' clause
51 get an 'auto' clause added; other clauses are preserved on the loop
52 or moved to the new surrounding compute construct, as applicable.
53 - Any sequences of other code (non-loops, non-OpenACC 'loop's) are wrapped
54 in new "gang-single" compute construct: 'worker'/'vector' parallelism is
55 preserved, but 'num_gangs (1)' is enforced.
56 - Both points above only apply at the topmost level in the region, that
57 is, the transformation does not introduce new compute constructs inside
58 nested statement bodies. In particular, this means that a
59 gang-parallelizable loop inside an 'if' statement is made "gang-single".
60 - In order to make the host wait only once for the whole region instead
61 of once per device kernel launch, the new compute constructs are
62 annotated 'async'. Unless the original 'kernels' construct already was
63 marked 'async', the entire region ends with a 'wait' directive. If the
64 original 'kernels' construct was marked 'async', the synthesized 'async'
65 clauses use the original 'kernels' construct's 'async' argument
66 (possibly implicit).
70 /*TODO Things are conceptually wrong here: 'loop' clauses may be hidden behind
71 'device_type', so we have to defer a lot of processing until we're in the
72 offloading compilation. "Fortunately", GCC doesn't support the OpenACC
73 'device_type' clause yet, so we get away that. */
76 /* Helper function for decompose_kernels_region_body. If STMT contains a
77 "top-level" OMP_FOR statement, returns a pointer to that statement;
78 returns NULL otherwise.
80 A "top-level" OMP_FOR statement is one that is possibly accompanied by
81 small snippets of setup code. Specifically, this function accepts an
82 OMP_FOR possibly wrapped in a singleton bind and a singleton try
83 statement to allow for a local loop variable, but not an OMP_FOR
84 statement nested in any other constructs. Alternatively, it accepts a
85 non-singleton bind containing only assignments and then an OMP_FOR
86 statement at the very end. The former style can be generated by the C
87 frontend, the latter by the Fortran frontend. */
89 static gimple *
90 top_level_omp_for_in_stmt (gimple *stmt)
92 if (gimple_code (stmt) == GIMPLE_OMP_FOR)
93 return stmt;
95 if (gimple_code (stmt) == GIMPLE_BIND)
97 gimple_seq body = gimple_bind_body (as_a <gbind *> (stmt));
98 if (gimple_seq_singleton_p (body))
100 /* Accept an OMP_FOR statement, or a try statement containing only
101 a single OMP_FOR. */
102 gimple *maybe_for_or_try = gimple_seq_first_stmt (body);
103 if (gimple_code (maybe_for_or_try) == GIMPLE_OMP_FOR)
104 return maybe_for_or_try;
105 else if (gimple_code (maybe_for_or_try) == GIMPLE_TRY)
107 gimple_seq try_body = gimple_try_eval (maybe_for_or_try);
108 if (!gimple_seq_singleton_p (try_body))
109 return NULL;
110 gimple *maybe_omp_for_stmt = gimple_seq_first_stmt (try_body);
111 if (gimple_code (maybe_omp_for_stmt) == GIMPLE_OMP_FOR)
112 return maybe_omp_for_stmt;
115 else
117 gimple_stmt_iterator gsi;
118 /* Accept only a block of optional assignments followed by an
119 OMP_FOR at the end. No other kinds of statements allowed. */
120 for (gsi = gsi_start (body); !gsi_end_p (gsi); gsi_next (&gsi))
122 gimple *body_stmt = gsi_stmt (gsi);
123 if (gimple_code (body_stmt) == GIMPLE_ASSIGN)
124 continue;
125 else if (gimple_code (body_stmt) == GIMPLE_OMP_FOR
126 && gsi_one_before_end_p (gsi))
127 return body_stmt;
128 else
129 return NULL;
134 return NULL;
137 /* Helper for adjust_region_code: evaluate the statement at GSI_P. */
139 static tree
140 adjust_region_code_walk_stmt_fn (gimple_stmt_iterator *gsi_p,
141 bool *handled_ops_p,
142 struct walk_stmt_info *wi)
144 int *region_code = (int *) wi->info;
146 gimple *stmt = gsi_stmt (*gsi_p);
147 switch (gimple_code (stmt))
149 case GIMPLE_OMP_FOR:
151 tree clauses = gimple_omp_for_clauses (stmt);
152 if (omp_find_clause (clauses, OMP_CLAUSE_INDEPENDENT))
154 /* Explicit 'independent' clause. */
155 /* Keep going; recurse into loop body. */
156 break;
158 else if (omp_find_clause (clauses, OMP_CLAUSE_SEQ))
160 /* Explicit 'seq' clause. */
161 /* We'll "parallelize" if at some level a loop construct has been
162 marked up by the user as unparallelizable ('seq' clause; we'll
163 respect that in the later processing). Given that the user has
164 explicitly marked it up, this loop construct cannot be
165 performance-critical, and in this case it's also fine to
166 "parallelize" instead of "gang-single", because any outer or
167 inner loops may still exploit the available parallelism. */
168 /* Keep going; recurse into loop body. */
169 break;
171 else
173 /* Explicit or implicit 'auto' clause. */
174 /* The user would like this loop analyzed ('auto' clause) and
175 typically parallelized, but we don't have available yet the
176 compiler logic to analyze this, so can't parallelize it here, so
177 we'd very likely be running into a performance problem if we
178 were to execute this unparallelized, thus forward the whole loop
179 nest to 'parloops'. */
180 *region_code = GF_OMP_TARGET_KIND_OACC_KERNELS;
181 /* Terminate: final decision for this region. */
182 *handled_ops_p = true;
183 return integer_zero_node;
185 gcc_unreachable ();
188 case GIMPLE_COND:
189 case GIMPLE_GOTO:
190 case GIMPLE_SWITCH:
191 case GIMPLE_ASM:
192 case GIMPLE_TRANSACTION:
193 case GIMPLE_RETURN:
194 /* Statement that might constitute some looping/control flow pattern. */
195 /* The user would like this code analyzed (implicit inside a 'kernels'
196 region) and typically parallelized, but we don't have available yet
197 the compiler logic to analyze this, so can't parallelize it here, so
198 we'd very likely be running into a performance problem if we were to
199 execute this unparallelized, thus forward the whole thing to
200 'parloops'. */
201 *region_code = GF_OMP_TARGET_KIND_OACC_KERNELS;
202 /* Terminate: final decision for this region. */
203 *handled_ops_p = true;
204 return integer_zero_node;
206 default:
207 /* Keep going. */
208 break;
211 return NULL;
214 /* Adjust the REGION_CODE for the region in GS. */
216 static void
217 adjust_region_code (gimple_seq gs, int *region_code)
219 struct walk_stmt_info wi;
220 memset (&wi, 0, sizeof (wi));
221 wi.info = region_code;
222 walk_gimple_seq (gs, adjust_region_code_walk_stmt_fn, NULL, &wi);
225 /* Helper function for make_loops_gang_single for walking the tree. If the
226 statement indicated by GSI_P is an OpenACC for loop with a gang clause,
227 issue a warning and remove the clause. */
229 static tree
230 visit_loops_in_gang_single_region (gimple_stmt_iterator *gsi_p,
231 bool *handled_ops_p,
232 struct walk_stmt_info *)
234 *handled_ops_p = false;
236 gimple *stmt = gsi_stmt (*gsi_p);
237 switch (gimple_code (stmt))
239 case GIMPLE_OMP_FOR:
240 /*TODO Given the current 'adjust_region_code' algorithm, this is
241 actually... */
242 gcc_unreachable ();
245 tree clauses = gimple_omp_for_clauses (stmt);
246 tree prev_clause = NULL;
247 for (tree clause = clauses; clause; clause = OMP_CLAUSE_CHAIN (clause))
249 if (OMP_CLAUSE_CODE (clause) == OMP_CLAUSE_GANG)
251 /* It makes no sense to have a 'gang' clause in a "gang-single"
252 region, so warn and remove it. */
253 warning_at (gimple_location (stmt), 0,
254 "conditionally executed loop in %<kernels%> region"
255 " will be executed by a single gang;"
256 " ignoring %<gang%> clause");
257 if (prev_clause != NULL)
258 OMP_CLAUSE_CHAIN (prev_clause) = OMP_CLAUSE_CHAIN (clause);
259 else
260 clauses = OMP_CLAUSE_CHAIN (clause);
262 break;
264 prev_clause = clause;
266 gimple_omp_for_set_clauses (stmt, clauses);
268 /* No need to recurse into nested statements; no loop nested inside
269 this loop can be gang-partitioned. */
270 sorry ("%<gang%> loop in %<gang-single%> region");
271 *handled_ops_p = true;
272 break;
274 default:
275 break;
278 return NULL;
281 /* Visit all nested OpenACC loops in the sequence indicated by GS. This
282 statement is expected to be inside a gang-single region. Issue a warning
283 for any loops inside it that have gang clauses and remove the clauses. */
285 static void
286 make_loops_gang_single (gimple_seq gs)
288 struct walk_stmt_info wi;
289 memset (&wi, 0, sizeof (wi));
290 walk_gimple_seq (gs, visit_loops_in_gang_single_region, NULL, &wi);
293 /* Construct a "gang-single" compute construct at LOC containing the STMTS.
294 Annotate with CLAUSES, which must not contain a 'num_gangs' clause, and an
295 additional 'num_gangs (1)' clause to force "gang-single" execution. */
297 static gimple *
298 make_region_seq (location_t loc, gimple_seq stmts,
299 tree num_gangs_clause,
300 tree num_workers_clause,
301 tree vector_length_clause,
302 tree clauses)
304 /* This correctly unshares the entire clause chain rooted here. */
305 clauses = unshare_expr (clauses);
307 dump_user_location_t loc_stmts_first = gimple_seq_first (stmts);
309 /* Figure out the region code for this region. */
310 /* Optimistic default: assume "setup code", no looping; thus not
311 performance-critical. */
312 int region_code = GF_OMP_TARGET_KIND_OACC_PARALLEL_KERNELS_GANG_SINGLE;
313 adjust_region_code (stmts, &region_code);
315 if (region_code == GF_OMP_TARGET_KIND_OACC_PARALLEL_KERNELS_GANG_SINGLE)
317 if (dump_enabled_p ())
318 /*TODO MSG_MISSED_OPTIMIZATION? */
319 dump_printf_loc (MSG_NOTE, loc_stmts_first,
320 "beginning %<gang-single%> part"
321 " in OpenACC %<kernels%> region\n");
323 /* Synthesize a 'num_gangs (1)' clause. */
324 tree gang_single_clause = build_omp_clause (loc, OMP_CLAUSE_NUM_GANGS);
325 OMP_CLAUSE_OPERAND (gang_single_clause, 0) = integer_one_node;
326 OMP_CLAUSE_CHAIN (gang_single_clause) = clauses;
327 clauses = gang_single_clause;
329 /* Remove and issue warnings about gang clauses on any OpenACC
330 loops nested inside this sequentially executed statement. */
331 make_loops_gang_single (stmts);
333 else if (region_code == GF_OMP_TARGET_KIND_OACC_KERNELS)
335 if (dump_enabled_p ())
336 dump_printf_loc (MSG_NOTE, loc_stmts_first,
337 "beginning %<parloops%> part"
338 " in OpenACC %<kernels%> region\n");
340 /* As we're transforming a 'GF_OMP_TARGET_KIND_OACC_KERNELS' into another
341 'GF_OMP_TARGET_KIND_OACC_KERNELS', this isn't doing any of the clauses
342 mangling that 'make_region_loop_nest' is doing. */
343 /* Re-assemble the clauses stripped off earlier. */
344 if (num_gangs_clause != NULL)
346 tree c = unshare_expr (num_gangs_clause);
347 OMP_CLAUSE_CHAIN (c) = clauses;
348 clauses = c;
350 if (num_workers_clause != NULL)
352 tree c = unshare_expr (num_workers_clause);
353 OMP_CLAUSE_CHAIN (c) = clauses;
354 clauses = c;
356 if (vector_length_clause != NULL)
358 tree c = unshare_expr (vector_length_clause);
359 OMP_CLAUSE_CHAIN (c) = clauses;
360 clauses = c;
363 else
364 gcc_unreachable ();
366 /* Build the gang-single region. */
367 gimple *single_region = gimple_build_omp_target (NULL, region_code, clauses);
368 gimple_set_location (single_region, loc);
369 gbind *single_body = gimple_build_bind (NULL, stmts, make_node (BLOCK));
370 gimple_omp_set_body (single_region, single_body);
372 return single_region;
375 /* Helper function for make_region_loop_nest. Adds a 'num_gangs'
376 ('num_workers', 'vector_length') clause to the given CLAUSES, either the one
377 from the parent compute construct (PARENT_CLAUSE) or a new one based on the
378 loop's own LOOP_CLAUSE ('gang (num: N)' or similar for 'worker' or 'vector'
379 clauses) with the given CLAUSE_CODE. Does nothing if neither PARENT_CLAUSE
380 nor LOOP_CLAUSE exist. Returns the new clauses. */
382 static tree
383 add_parent_or_loop_num_clause (tree parent_clause, tree loop_clause,
384 omp_clause_code clause_code, tree clauses)
386 if (parent_clause != NULL)
388 tree num_clause = unshare_expr (parent_clause);
389 OMP_CLAUSE_CHAIN (num_clause) = clauses;
390 clauses = num_clause;
392 else if (loop_clause != NULL)
394 /* The kernels region does not have a 'num_gangs' clause, but the loop
395 itself had a 'gang (num: N)' clause. Honor it by adding a
396 'num_gangs (N)' clause on the compute construct. */
397 tree num = OMP_CLAUSE_OPERAND (loop_clause, 0);
398 tree new_num_clause
399 = build_omp_clause (OMP_CLAUSE_LOCATION (loop_clause), clause_code);
400 OMP_CLAUSE_OPERAND (new_num_clause, 0) = num;
401 OMP_CLAUSE_CHAIN (new_num_clause) = clauses;
402 clauses = new_num_clause;
404 return clauses;
407 /* Helper for make_region_loop_nest, looking for 'worker (num: N)' or 'vector
408 (length: N)' clauses in nested loops. Removes the argument, transferring it
409 to the enclosing compute construct (via WI->INFO). If arguments within the
410 same loop nest conflict, emits a warning.
412 This function also decides whether to add an 'auto' clause on each of these
413 nested loops. */
415 struct adjust_nested_loop_clauses_wi_info
417 tree *loop_gang_clause_ptr;
418 tree *loop_worker_clause_ptr;
419 tree *loop_vector_clause_ptr;
422 static tree
423 adjust_nested_loop_clauses (gimple_stmt_iterator *gsi_p, bool *,
424 struct walk_stmt_info *wi)
426 struct adjust_nested_loop_clauses_wi_info *wi_info
427 = (struct adjust_nested_loop_clauses_wi_info *) wi->info;
428 gimple *stmt = gsi_stmt (*gsi_p);
430 if (gimple_code (stmt) == GIMPLE_OMP_FOR)
432 bool add_auto_clause = true;
433 tree loop_clauses = gimple_omp_for_clauses (stmt);
434 tree loop_clause = loop_clauses;
435 for (; loop_clause; loop_clause = OMP_CLAUSE_CHAIN (loop_clause))
437 tree *outer_clause_ptr = NULL;
438 switch (OMP_CLAUSE_CODE (loop_clause))
440 case OMP_CLAUSE_GANG:
441 outer_clause_ptr = wi_info->loop_gang_clause_ptr;
442 break;
443 case OMP_CLAUSE_WORKER:
444 outer_clause_ptr = wi_info->loop_worker_clause_ptr;
445 break;
446 case OMP_CLAUSE_VECTOR:
447 outer_clause_ptr = wi_info->loop_vector_clause_ptr;
448 break;
449 case OMP_CLAUSE_SEQ:
450 case OMP_CLAUSE_INDEPENDENT:
451 case OMP_CLAUSE_AUTO:
452 add_auto_clause = false;
453 default:
454 break;
456 if (outer_clause_ptr != NULL)
458 if (OMP_CLAUSE_OPERAND (loop_clause, 0) != NULL
459 && *outer_clause_ptr == NULL)
461 /* Transfer the clause to the enclosing compute construct and
462 remove the numerical argument from the 'loop'. */
463 *outer_clause_ptr = unshare_expr (loop_clause);
464 OMP_CLAUSE_OPERAND (loop_clause, 0) = NULL;
466 else if (OMP_CLAUSE_OPERAND (loop_clause, 0) != NULL &&
467 OMP_CLAUSE_OPERAND (*outer_clause_ptr, 0) != NULL)
469 /* See if both of these are the same constant. If they
470 aren't, emit a warning. */
471 tree old_op = OMP_CLAUSE_OPERAND (*outer_clause_ptr, 0);
472 tree new_op = OMP_CLAUSE_OPERAND (loop_clause, 0);
473 if (!(cst_and_fits_in_hwi (old_op) &&
474 cst_and_fits_in_hwi (new_op) &&
475 int_cst_value (old_op) == int_cst_value (new_op)))
477 const char *clause_name
478 = omp_clause_code_name[OMP_CLAUSE_CODE (loop_clause)];
479 error_at (gimple_location (stmt),
480 "cannot honor conflicting %qs clause",
481 clause_name);
482 inform (OMP_CLAUSE_LOCATION (*outer_clause_ptr),
483 "location of the previous clause"
484 " in the same loop nest");
486 OMP_CLAUSE_OPERAND (loop_clause, 0) = NULL;
490 if (add_auto_clause)
492 tree auto_clause
493 = build_omp_clause (gimple_location (stmt), OMP_CLAUSE_AUTO);
494 OMP_CLAUSE_CHAIN (auto_clause) = loop_clauses;
495 gimple_omp_for_set_clauses (stmt, auto_clause);
499 return NULL;
502 /* Helper for make_region_loop_nest. Transform OpenACC 'kernels'/'loop'
503 construct clauses into OpenACC 'parallel'/'loop' construct ones. */
505 static tree
506 transform_kernels_loop_clauses (gimple *omp_for,
507 tree num_gangs_clause,
508 tree num_workers_clause,
509 tree vector_length_clause,
510 tree clauses)
512 /* If this loop in a kernels region does not have an explicit 'seq',
513 'independent', or 'auto' clause, we must give it an explicit 'auto'
514 clause.
515 We also check for 'gang (num: N)' clauses. These must not appear in
516 kernels regions that have their own 'num_gangs' clause. Otherwise, they
517 must be converted and put on the region; similarly for 'worker' and
518 'vector' clauses. */
519 bool add_auto_clause = true;
520 tree loop_gang_clause = NULL, loop_worker_clause = NULL,
521 loop_vector_clause = NULL;
522 tree loop_clauses = gimple_omp_for_clauses (omp_for);
523 for (tree loop_clause = loop_clauses;
524 loop_clause;
525 loop_clause = OMP_CLAUSE_CHAIN (loop_clause))
527 bool found_num_clause = false;
528 tree *clause_ptr, clause_to_check;
529 switch (OMP_CLAUSE_CODE (loop_clause))
531 case OMP_CLAUSE_GANG:
532 found_num_clause = true;
533 clause_ptr = &loop_gang_clause;
534 clause_to_check = num_gangs_clause;
535 break;
536 case OMP_CLAUSE_WORKER:
537 found_num_clause = true;
538 clause_ptr = &loop_worker_clause;
539 clause_to_check = num_workers_clause;
540 break;
541 case OMP_CLAUSE_VECTOR:
542 found_num_clause = true;
543 clause_ptr = &loop_vector_clause;
544 clause_to_check = vector_length_clause;
545 break;
546 case OMP_CLAUSE_INDEPENDENT:
547 case OMP_CLAUSE_SEQ:
548 case OMP_CLAUSE_AUTO:
549 add_auto_clause = false;
550 default:
551 break;
553 if (found_num_clause && OMP_CLAUSE_OPERAND (loop_clause, 0) != NULL)
555 if (clause_to_check)
557 const char *clause_name
558 = omp_clause_code_name[OMP_CLAUSE_CODE (loop_clause)];
559 const char *parent_clause_name
560 = omp_clause_code_name[OMP_CLAUSE_CODE (clause_to_check)];
561 error_at (OMP_CLAUSE_LOCATION (loop_clause),
562 "argument not permitted on %qs clause"
563 " in OpenACC %<kernels%> region with a %qs clause",
564 clause_name, parent_clause_name);
565 inform (OMP_CLAUSE_LOCATION (clause_to_check),
566 "location of OpenACC %<kernels%>");
568 /* Copy the 'gang (N)'/'worker (N)'/'vector (N)' clause to the
569 enclosing compute construct. */
570 *clause_ptr = unshare_expr (loop_clause);
571 OMP_CLAUSE_CHAIN (*clause_ptr) = NULL;
572 /* Leave a 'gang'/'worker'/'vector' clause on the 'loop', but without
573 argument. */
574 OMP_CLAUSE_OPERAND (loop_clause, 0) = NULL;
577 if (add_auto_clause)
579 tree auto_clause = build_omp_clause (gimple_location (omp_for),
580 OMP_CLAUSE_AUTO);
581 OMP_CLAUSE_CHAIN (auto_clause) = loop_clauses;
582 loop_clauses = auto_clause;
584 gimple_omp_for_set_clauses (omp_for, loop_clauses);
585 /* We must also recurse into the loop; it might contain nested loops having
586 their own 'worker (num: W)' or 'vector (length: V)' clauses. Turn these
587 into 'worker'/'vector' clauses on the compute construct. */
588 struct walk_stmt_info wi;
589 memset (&wi, 0, sizeof (wi));
590 struct adjust_nested_loop_clauses_wi_info wi_info;
591 wi_info.loop_gang_clause_ptr = &loop_gang_clause;
592 wi_info.loop_worker_clause_ptr = &loop_worker_clause;
593 wi_info.loop_vector_clause_ptr = &loop_vector_clause;
594 wi.info = &wi_info;
595 gimple *body = gimple_omp_body (omp_for);
596 walk_gimple_seq (body, adjust_nested_loop_clauses, NULL, &wi);
597 /* Check if there were conflicting numbers of workers or vector length. */
598 if (loop_gang_clause != NULL &&
599 OMP_CLAUSE_OPERAND (loop_gang_clause, 0) == NULL)
600 loop_gang_clause = NULL;
601 if (loop_worker_clause != NULL &&
602 OMP_CLAUSE_OPERAND (loop_worker_clause, 0) == NULL)
603 loop_worker_clause = NULL;
604 if (loop_vector_clause != NULL &&
605 OMP_CLAUSE_OPERAND (loop_vector_clause, 0) == NULL)
606 vector_length_clause = NULL;
608 /* If the kernels region had 'num_gangs', 'num_worker', 'vector_length'
609 clauses, add these to this new compute construct. */
610 clauses
611 = add_parent_or_loop_num_clause (num_gangs_clause, loop_gang_clause,
612 OMP_CLAUSE_NUM_GANGS, clauses);
613 clauses
614 = add_parent_or_loop_num_clause (num_workers_clause, loop_worker_clause,
615 OMP_CLAUSE_NUM_WORKERS, clauses);
616 clauses
617 = add_parent_or_loop_num_clause (vector_length_clause, loop_vector_clause,
618 OMP_CLAUSE_VECTOR_LENGTH, clauses);
620 return clauses;
623 /* Construct a possibly gang-parallel compute construct containing the STMT,
624 which must be identical to, or a bind containing, the loop OMP_FOR.
626 The NUM_GANGS_CLAUSE, NUM_WORKERS_CLAUSE, and VECTOR_LENGTH_CLAUSE are
627 optional clauses from the original kernels region and must not be contained
628 in the other CLAUSES. The newly created compute construct is annotated with
629 the optional NUM_GANGS_CLAUSE as well as the other CLAUSES. If there is no
630 NUM_GANGS_CLAUSE but the loop has a 'gang (num: N)' clause, that is
631 converted to a 'num_gangs (N)' clause on the new compute construct, and
632 similarly for 'worker' and 'vector' clauses.
634 The outermost loop gets an 'auto' clause unless there already is an
635 'seq'/'independent'/'auto' clause. Nested loops inside OMP_FOR are treated
636 similarly by the adjust_nested_loop_clauses function. */
638 static gimple *
639 make_region_loop_nest (gimple *omp_for, gimple_seq stmts,
640 tree num_gangs_clause,
641 tree num_workers_clause,
642 tree vector_length_clause,
643 tree clauses)
645 /* This correctly unshares the entire clause chain rooted here. */
646 clauses = unshare_expr (clauses);
648 /* Figure out the region code for this region. */
649 /* Optimistic default: assume that the loop nest is parallelizable
650 (essentially, no GIMPLE_OMP_FOR with (explicit or implicit) 'auto' clause,
651 and no un-annotated loops). */
652 int region_code = GF_OMP_TARGET_KIND_OACC_PARALLEL_KERNELS_PARALLELIZED;
653 adjust_region_code (stmts, &region_code);
655 if (region_code == GF_OMP_TARGET_KIND_OACC_PARALLEL_KERNELS_PARALLELIZED)
657 if (dump_enabled_p ())
658 /* This is not MSG_OPTIMIZED_LOCATIONS, as we're just doing what the
659 user asked us to. */
660 dump_printf_loc (MSG_NOTE, omp_for,
661 "parallelized loop nest"
662 " in OpenACC %<kernels%> region\n");
664 clauses = transform_kernels_loop_clauses (omp_for,
665 num_gangs_clause,
666 num_workers_clause,
667 vector_length_clause,
668 clauses);
670 else if (region_code == GF_OMP_TARGET_KIND_OACC_KERNELS)
672 if (dump_enabled_p ())
673 dump_printf_loc (MSG_NOTE, omp_for,
674 "forwarded loop nest"
675 " in OpenACC %<kernels%> region"
676 " to %<parloops%> for analysis\n");
678 /* We're transforming one 'GF_OMP_TARGET_KIND_OACC_KERNELS' into another
679 'GF_OMP_TARGET_KIND_OACC_KERNELS', so don't have to
680 'transform_kernels_loop_clauses'. */
681 /* Re-assemble the clauses stripped off earlier. */
682 clauses
683 = add_parent_or_loop_num_clause (num_gangs_clause, NULL,
684 OMP_CLAUSE_NUM_GANGS, clauses);
685 clauses
686 = add_parent_or_loop_num_clause (num_workers_clause, NULL,
687 OMP_CLAUSE_NUM_WORKERS, clauses);
688 clauses
689 = add_parent_or_loop_num_clause (vector_length_clause, NULL,
690 OMP_CLAUSE_VECTOR_LENGTH, clauses);
692 else
693 gcc_unreachable ();
695 gimple *parallel_body_bind
696 = gimple_build_bind (NULL, stmts, make_node (BLOCK));
697 gimple *parallel_region
698 = gimple_build_omp_target (parallel_body_bind, region_code, clauses);
699 gimple_set_location (parallel_region, gimple_location (omp_for));
701 return parallel_region;
704 /* Eliminate any binds directly inside BIND by adding their statements to
705 BIND (i.e., modifying it in place), excluding binds that hold only an
706 OMP_FOR loop and associated setup/cleanup code. Recurse into binds but
707 not other statements. Return a chain of the local variables of eliminated
708 binds, i.e., the local variables found in nested binds. If
709 INCLUDE_TOPLEVEL_VARS is true, this also includes the variables belonging
710 to BIND itself. */
712 static tree
713 flatten_binds (gbind *bind, bool include_toplevel_vars = false)
715 tree vars = NULL, last_var = NULL;
717 if (include_toplevel_vars)
719 vars = gimple_bind_vars (bind);
720 last_var = vars;
723 gimple_seq new_body = NULL;
724 gimple_seq body_sequence = gimple_bind_body (bind);
725 gimple_stmt_iterator gsi, gsi_n;
726 for (gsi = gsi_start (body_sequence); !gsi_end_p (gsi); gsi = gsi_n)
728 /* Advance the iterator here because otherwise it would be invalidated
729 by moving statements below. */
730 gsi_n = gsi;
731 gsi_next (&gsi_n);
733 gimple *stmt = gsi_stmt (gsi);
734 /* Flatten bind statements, except the ones that contain only an
735 OpenACC for loop. */
736 if (gimple_code (stmt) == GIMPLE_BIND
737 && !top_level_omp_for_in_stmt (stmt))
739 gbind *inner_bind = as_a <gbind *> (stmt);
740 /* Flatten recursively, and collect all variables. */
741 tree inner_vars = flatten_binds (inner_bind, true);
742 gimple_seq inner_sequence = gimple_bind_body (inner_bind);
743 if (flag_checking)
745 for (gimple_stmt_iterator inner_gsi = gsi_start (inner_sequence);
746 !gsi_end_p (inner_gsi);
747 gsi_next (&inner_gsi))
749 gimple *inner_stmt = gsi_stmt (inner_gsi);
750 gcc_assert (gimple_code (inner_stmt) != GIMPLE_BIND
751 || top_level_omp_for_in_stmt (inner_stmt));
754 gimple_seq_add_seq (&new_body, inner_sequence);
755 /* Find the last variable; we will append others to it. */
756 while (last_var != NULL && TREE_CHAIN (last_var) != NULL)
757 last_var = TREE_CHAIN (last_var);
758 if (last_var != NULL)
760 TREE_CHAIN (last_var) = inner_vars;
761 last_var = inner_vars;
763 else
765 vars = inner_vars;
766 last_var = vars;
769 else
770 gimple_seq_add_stmt (&new_body, stmt);
773 /* Put the possibly transformed body back into the bind. */
774 gimple_bind_set_body (bind, new_body);
775 return vars;
778 /* Helper function for places where we construct data regions. Wraps the BODY
779 inside a try-finally construct at LOC that calls __builtin_GOACC_data_end
780 in its cleanup block. Returns this try statement. */
782 static gimple *
783 make_data_region_try_statement (location_t loc, gimple *body)
785 tree data_end_fn = builtin_decl_explicit (BUILT_IN_GOACC_DATA_END);
786 gimple *call = gimple_build_call (data_end_fn, 0);
787 gimple_seq cleanup = NULL;
788 gimple_seq_add_stmt (&cleanup, call);
789 gimple *try_stmt = gimple_build_try (body, cleanup, GIMPLE_TRY_FINALLY);
790 gimple_set_location (body, loc);
791 return try_stmt;
794 /* If INNER_BIND_VARS holds variables, build an OpenACC data region with
795 location LOC containing BODY and having 'create (var)' clauses for each
796 variable. If INNER_CLEANUP is present, add a try-finally statement with
797 this cleanup code in the finally block. Return the new data region, or
798 the original BODY if no data region was needed. */
800 static gimple *
801 maybe_build_inner_data_region (location_t loc, gimple *body,
802 tree inner_bind_vars, gimple *inner_cleanup)
804 /* Is this an instantiation of a template? (In this case, we don't care what
805 the generic decl is - just whether the function decl has one.) */
806 bool generic_inst_p
807 = (lang_hooks.decls.get_generic_function_decl (current_function_decl)
808 != NULL);
810 /* Build data 'create (var)' clauses for these local variables.
811 Below we will add these to a data region enclosing the entire body
812 of the decomposed kernels region. */
813 tree prev_mapped_var = NULL, next = NULL, artificial_vars = NULL,
814 inner_data_clauses = NULL;
815 for (tree v = inner_bind_vars; v; v = next)
817 next = TREE_CHAIN (v);
818 if (DECL_ARTIFICIAL (v)
819 || TREE_CODE (v) == CONST_DECL
820 || generic_inst_p)
822 /* If this is an artificial temporary, it need not be mapped. We
823 move its declaration into the bind inside the data region.
824 Also avoid mapping variables if we are inside a template
825 instantiation; the code does not contain all the copies to
826 temporaries that would make this legal. */
827 TREE_CHAIN (v) = artificial_vars;
828 artificial_vars = v;
829 if (prev_mapped_var != NULL)
830 TREE_CHAIN (prev_mapped_var) = next;
831 else
832 inner_bind_vars = next;
834 else
836 /* Otherwise, build the map clause. */
837 tree new_clause = build_omp_clause (loc, OMP_CLAUSE_MAP);
838 OMP_CLAUSE_SET_MAP_KIND (new_clause, GOMP_MAP_ALLOC);
839 OMP_CLAUSE_DECL (new_clause) = v;
840 OMP_CLAUSE_SIZE (new_clause) = DECL_SIZE_UNIT (v);
841 OMP_CLAUSE_CHAIN (new_clause) = inner_data_clauses;
842 inner_data_clauses = new_clause;
844 prev_mapped_var = v;
848 if (artificial_vars)
849 body = gimple_build_bind (artificial_vars, body, make_node (BLOCK));
851 /* If we determined above that there are variables that need to be created
852 on the device, construct a data region for them and wrap the body
853 inside that. */
854 if (inner_data_clauses != NULL)
856 gcc_assert (inner_bind_vars != NULL);
857 gimple *inner_data_region
858 = gimple_build_omp_target (NULL, GF_OMP_TARGET_KIND_OACC_DATA_KERNELS,
859 inner_data_clauses);
860 gimple_set_location (inner_data_region, loc);
861 /* Make sure __builtin_GOACC_data_end is called at the end. */
862 gimple *try_stmt = make_data_region_try_statement (loc, body);
863 gimple_omp_set_body (inner_data_region, try_stmt);
864 gimple *bind_body;
865 if (inner_cleanup != NULL)
866 /* Clobber all the inner variables that need to be clobbered. */
867 bind_body = gimple_build_try (inner_data_region, inner_cleanup,
868 GIMPLE_TRY_FINALLY);
869 else
870 bind_body = inner_data_region;
871 body = gimple_build_bind (inner_bind_vars, bind_body, make_node (BLOCK));
874 return body;
877 /* Helper function of decompose_kernels_region_body. The statements in
878 REGION_BODY are expected to be decomposed parts; add an 'async' clause to
879 each. Also add a 'wait' directive at the end of the sequence. */
881 static void
882 add_async_clauses_and_wait (location_t loc, gimple_seq *region_body)
884 tree default_async_queue
885 = build_int_cst (integer_type_node, GOMP_ASYNC_NOVAL);
886 for (gimple_stmt_iterator gsi = gsi_start (*region_body);
887 !gsi_end_p (gsi);
888 gsi_next (&gsi))
890 gimple *stmt = gsi_stmt (gsi);
891 tree target_clauses = gimple_omp_target_clauses (stmt);
892 tree new_async_clause = build_omp_clause (loc, OMP_CLAUSE_ASYNC);
893 OMP_CLAUSE_OPERAND (new_async_clause, 0) = default_async_queue;
894 OMP_CLAUSE_CHAIN (new_async_clause) = target_clauses;
895 target_clauses = new_async_clause;
896 gimple_omp_target_set_clauses (as_a <gomp_target *> (stmt),
897 target_clauses);
899 /* A '#pragma acc wait' is just a call 'GOACC_wait (acc_async_sync, 0)'. */
900 tree wait_fn = builtin_decl_explicit (BUILT_IN_GOACC_WAIT);
901 tree sync_arg = build_int_cst (integer_type_node, GOMP_ASYNC_SYNC);
902 gimple *wait_call = gimple_build_call (wait_fn, 2,
903 sync_arg, integer_zero_node);
904 gimple_set_location (wait_call, loc);
905 gimple_seq_add_stmt (region_body, wait_call);
908 /* Auxiliary analysis of the body of a kernels region, to determine for each
909 OpenACC loop whether it is control-dependent (i.e., not necessarily
910 executed every time the kernels region is entered) or not.
911 We say that a loop is control-dependent if there is some cond, switch, or
912 goto statement that jumps over it, forwards or backwards. For example,
913 if the loop is controlled by an if statement, then a jump to the true
914 block, the false block, or from one of those blocks to the control flow
915 join point will necessarily jump over the loop.
916 This analysis implements an ad-hoc union-find data structure classifying
917 statements into "control-flow regions" as follows: Most statements are in
918 the same region as their predecessor, except that each OpenACC loop is in
919 a region of its own, and each OpenACC loop's successor starts a new
920 region. We then unite the regions of any statements linked by jumps,
921 placing any cond, switch, or goto statement in the same region as its
922 target label(s).
923 In the end, control dependence of OpenACC loops can be determined by
924 comparing their immediate predecessor and successor statements' regions.
925 A jump crosses the loop if and only if the predecessor and successor are
926 in the same region. (If there is no predecessor or successor, the loop
927 is executed unconditionally.)
928 The methods in this class identify statements by their index in the
929 kernels region's body. */
931 class control_flow_regions
933 public:
934 /* Initialize an instance and pre-compute the control-flow region
935 information for the statement sequence SEQ. */
936 control_flow_regions (gimple_seq seq);
938 /* Return true if the statement with the given index IDX in the analyzed
939 statement sequence is an unconditionally executed OpenACC loop. */
940 bool is_unconditional_oacc_for_loop (size_t idx);
942 private:
943 /* Find the region representative for the statement identified by index
944 STMT_IDX. */
945 size_t find_rep (size_t stmt_idx);
947 /* Union the regions containing the statements represented by
948 representatives A and B. */
949 void union_reps (size_t a, size_t b);
951 /* Helper for the constructor. Performs the actual computation of the
952 control-flow regions in the statement sequence SEQ. */
953 void compute_regions (gimple_seq seq);
955 /* The mapping from statement indices to region representatives. */
956 vec <size_t> representatives;
958 /* A cache mapping statement indices to a flag indicating whether the
959 statement is a top level OpenACC for loop. */
960 vec <bool> omp_for_loops;
963 control_flow_regions::control_flow_regions (gimple_seq seq)
965 representatives.create (1);
966 omp_for_loops.create (1);
967 compute_regions (seq);
970 bool
971 control_flow_regions::is_unconditional_oacc_for_loop (size_t idx)
973 if (idx == 0 || idx == representatives.length () - 1)
974 /* The first or last statement in the kernels region. This means that
975 there is no room before or after it for a jump or a label. Thus
976 there cannot be a jump across it, so it is unconditional. */
977 return true;
978 /* Otherwise, the loop is unconditional if the statements before and after
979 it are in different control flow regions. Scan forward and backward,
980 skipping over neighboring OpenACC for loops, to find these preceding
981 statements. */
982 size_t prev_index = idx - 1;
983 while (prev_index > 0 && omp_for_loops [prev_index] == true)
984 prev_index--;
985 /* If all preceding statements are also OpenACC loops, all of these are
986 unconditional. */
987 if (prev_index == 0)
988 return true;
989 size_t succ_index = idx + 1;
990 while (succ_index < omp_for_loops.length ()
991 && omp_for_loops [succ_index] == true)
992 succ_index++;
993 /* If all following statements are also OpenACC loops, all of these are
994 unconditional. */
995 if (succ_index == omp_for_loops.length ())
996 return true;
997 return (find_rep (prev_index) != find_rep (succ_index));
1000 size_t
1001 control_flow_regions::find_rep (size_t stmt_idx)
1003 size_t rep = stmt_idx, aux = stmt_idx;
1004 /* Find the root representative of this statement. */
1005 while (representatives[rep] != rep)
1006 rep = representatives[rep];
1007 /* Compress the path from the original statement to the representative. */
1008 while (representatives[aux] != rep)
1010 size_t tmp = representatives[aux];
1011 representatives[aux] = rep;
1012 aux = tmp;
1014 return rep;
1017 void
1018 control_flow_regions::union_reps (size_t a, size_t b)
1020 a = find_rep (a);
1021 b = find_rep (b);
1022 representatives[b] = a;
1025 void
1026 control_flow_regions::compute_regions (gimple_seq seq)
1028 hash_map <gimple *, size_t> control_flow_reps;
1029 hash_map <tree, size_t> label_reps;
1030 size_t current_region = 0, idx = 0;
1032 /* In a first pass, assign an initial region to each statement. Except in
1033 the case of OpenACC loops, each statement simply gets the same region
1034 representative as its predecessor. */
1035 for (gimple_stmt_iterator gsi = gsi_start (seq);
1036 !gsi_end_p (gsi);
1037 gsi_next (&gsi))
1039 gimple *stmt = gsi_stmt (gsi);
1040 gimple *omp_for = top_level_omp_for_in_stmt (stmt);
1041 omp_for_loops.safe_push (omp_for != NULL);
1042 if (omp_for != NULL)
1044 /* Assign a new region to this loop and to its successor. */
1045 current_region = idx;
1046 representatives.safe_push (current_region);
1047 current_region++;
1049 else
1051 representatives.safe_push (current_region);
1052 /* Remember any jumps and labels for the second pass below. */
1053 if (gimple_code (stmt) == GIMPLE_COND
1054 || gimple_code (stmt) == GIMPLE_SWITCH
1055 || gimple_code (stmt) == GIMPLE_GOTO)
1056 control_flow_reps.put (stmt, current_region);
1057 else if (gimple_code (stmt) == GIMPLE_LABEL)
1058 label_reps.put (gimple_label_label (as_a <glabel *> (stmt)),
1059 current_region);
1061 idx++;
1063 gcc_assert (representatives.length () == omp_for_loops.length ());
1065 /* Revisit all the control flow statements and union the region of each
1066 cond, switch, or goto statement with the target labels' regions. */
1067 for (hash_map <gimple *, size_t>::iterator it = control_flow_reps.begin ();
1068 it != control_flow_reps.end ();
1069 ++it)
1071 gimple *stmt = (*it).first;
1072 size_t stmt_rep = (*it).second;
1073 switch (gimple_code (stmt))
1075 tree label;
1076 unsigned int n;
1078 case GIMPLE_COND:
1079 label = gimple_cond_true_label (as_a <gcond *> (stmt));
1080 union_reps (stmt_rep, *label_reps.get (label));
1081 label = gimple_cond_false_label (as_a <gcond *> (stmt));
1082 union_reps (stmt_rep, *label_reps.get (label));
1083 break;
1085 case GIMPLE_SWITCH:
1086 n = gimple_switch_num_labels (as_a <gswitch *> (stmt));
1087 for (unsigned int i = 0; i < n; i++)
1089 tree switch_case
1090 = gimple_switch_label (as_a <gswitch *> (stmt), i);
1091 label = CASE_LABEL (switch_case);
1092 union_reps (stmt_rep, *label_reps.get (label));
1094 break;
1096 case GIMPLE_GOTO:
1097 label = gimple_goto_dest (stmt);
1098 union_reps (stmt_rep, *label_reps.get (label));
1099 break;
1101 default:
1102 gcc_unreachable ();
1107 /* Decompose the body of the KERNELS_REGION, which was originally annotated
1108 with the KERNELS_CLAUSES, into a series of compute constructs. */
1110 static gimple *
1111 decompose_kernels_region_body (gimple *kernels_region, tree kernels_clauses)
1113 location_t loc = gimple_location (kernels_region);
1115 /* The kernels clauses will be propagated to the child clauses unmodified,
1116 except that the 'num_gangs', 'num_workers', and 'vector_length' clauses
1117 will only be added to loop regions. The other regions are "gang-single"
1118 and get an explicit 'num_gangs (1)' clause. So separate out the
1119 'num_gangs', 'num_workers', and 'vector_length' clauses here.
1120 Also check for the presence of an 'async' clause but do not remove it from
1121 the 'kernels' clauses. */
1122 tree num_gangs_clause = NULL, num_workers_clause = NULL,
1123 vector_length_clause = NULL;
1124 tree async_clause = NULL;
1125 tree prev_clause = NULL, next_clause = NULL;
1126 tree parallel_clauses = kernels_clauses;
1127 for (tree c = parallel_clauses; c; c = next_clause)
1129 /* Preserve this here, as we might NULL it later. */
1130 next_clause = OMP_CLAUSE_CHAIN (c);
1132 if (OMP_CLAUSE_CODE (c) == OMP_CLAUSE_NUM_GANGS
1133 || OMP_CLAUSE_CODE (c) == OMP_CLAUSE_NUM_WORKERS
1134 || OMP_CLAUSE_CODE (c) == OMP_CLAUSE_VECTOR_LENGTH)
1136 /* Cut this clause out of the chain. */
1137 if (prev_clause != NULL)
1138 OMP_CLAUSE_CHAIN (prev_clause) = OMP_CLAUSE_CHAIN (c);
1139 else
1140 kernels_clauses = OMP_CLAUSE_CHAIN (c);
1141 OMP_CLAUSE_CHAIN (c) = NULL;
1142 switch (OMP_CLAUSE_CODE (c))
1144 case OMP_CLAUSE_NUM_GANGS:
1145 num_gangs_clause = c;
1146 break;
1147 case OMP_CLAUSE_NUM_WORKERS:
1148 num_workers_clause = c;
1149 break;
1150 case OMP_CLAUSE_VECTOR_LENGTH:
1151 vector_length_clause = c;
1152 break;
1153 default:
1154 gcc_unreachable ();
1157 else
1158 prev_clause = c;
1159 if (OMP_CLAUSE_CODE (c) == OMP_CLAUSE_ASYNC)
1160 async_clause = c;
1163 gimple *kernels_body = gimple_omp_body (kernels_region);
1164 gbind *kernels_bind = as_a <gbind *> (kernels_body);
1166 /* The body of the region may contain other nested binds declaring inner
1167 local variables. Collapse all these binds into one to ensure that we
1168 have a single sequence of statements to iterate over; also, collect all
1169 inner variables. */
1170 tree inner_bind_vars = flatten_binds (kernels_bind);
1171 gimple_seq body_sequence = gimple_bind_body (kernels_bind);
1173 /* All these inner variables will get allocated on the device (below, by
1174 calling maybe_build_inner_data_region). Here we create 'present'
1175 clauses for them and add these clauses to the list of clauses to be
1176 attached to each inner compute construct. */
1177 tree present_clauses = kernels_clauses;
1178 for (tree var = inner_bind_vars; var; var = TREE_CHAIN (var))
1180 if (!DECL_ARTIFICIAL (var) && TREE_CODE (var) != CONST_DECL)
1182 tree present_clause = build_omp_clause (loc, OMP_CLAUSE_MAP);
1183 OMP_CLAUSE_SET_MAP_KIND (present_clause, GOMP_MAP_FORCE_PRESENT);
1184 OMP_CLAUSE_DECL (present_clause) = var;
1185 OMP_CLAUSE_SIZE (present_clause) = DECL_SIZE_UNIT (var);
1186 OMP_CLAUSE_CHAIN (present_clause) = present_clauses;
1187 present_clauses = present_clause;
1190 kernels_clauses = present_clauses;
1192 /* In addition to nested binds, the "real" body of the region may be
1193 nested inside a try-finally block. Find its cleanup block, which
1194 contains code to clobber the local variables that must be clobbered. */
1195 gimple *inner_cleanup = NULL;
1196 if (body_sequence != NULL && gimple_code (body_sequence) == GIMPLE_TRY)
1198 if (gimple_seq_singleton_p (body_sequence))
1200 /* The try statement is the only thing inside the bind. */
1201 inner_cleanup = gimple_try_cleanup (body_sequence);
1202 body_sequence = gimple_try_eval (body_sequence);
1204 else
1206 /* The bind's body starts with a try statement, but it is followed
1207 by other things. */
1208 gimple_stmt_iterator gsi = gsi_start (body_sequence);
1209 gimple *try_stmt = gsi_stmt (gsi);
1210 inner_cleanup = gimple_try_cleanup (try_stmt);
1211 gimple *try_body = gimple_try_eval (try_stmt);
1213 gsi_remove (&gsi, false);
1214 /* Now gsi indicates the sequence of statements after the try
1215 statement in the bind. Append the statement in the try body and
1216 the trailing statements from gsi. */
1217 gsi_insert_seq_before (&gsi, try_body, GSI_CONTINUE_LINKING);
1218 body_sequence = gsi_stmt (gsi);
1222 /* This sequence will collect all the top-level statements in the body of
1223 the data region we are about to construct. */
1224 gimple_seq region_body = NULL;
1225 /* This sequence will collect consecutive statements to be put into a
1226 gang-single region. */
1227 gimple_seq gang_single_seq = NULL;
1228 /* Flag recording whether the gang_single_seq only contains copies to
1229 local variables. These may be loop setup code that should not be
1230 separated from the loop. */
1231 bool only_simple_assignments = true;
1233 /* Precompute the control flow region information to determine whether an
1234 OpenACC loop is executed conditionally or unconditionally. */
1235 control_flow_regions cf_regions (body_sequence);
1237 /* Iterate over the statements in the kernels region's body. */
1238 size_t idx = 0;
1239 gimple_stmt_iterator gsi, gsi_n;
1240 for (gsi = gsi_start (body_sequence); !gsi_end_p (gsi); gsi = gsi_n, idx++)
1242 /* Advance the iterator here because otherwise it would be invalidated
1243 by moving statements below. */
1244 gsi_n = gsi;
1245 gsi_next (&gsi_n);
1247 gimple *stmt = gsi_stmt (gsi);
1248 gimple *omp_for = top_level_omp_for_in_stmt (stmt);
1249 bool is_unconditional_oacc_for_loop = false;
1250 if (omp_for != NULL)
1251 is_unconditional_oacc_for_loop
1252 = cf_regions.is_unconditional_oacc_for_loop (idx);
1253 if (omp_for != NULL
1254 && is_unconditional_oacc_for_loop)
1256 /* This is an OMP for statement, put it into a separate region.
1257 But first, construct a gang-single region containing any
1258 complex sequential statements we may have seen. */
1259 if (gang_single_seq != NULL && !only_simple_assignments)
1261 gimple *single_region
1262 = make_region_seq (loc, gang_single_seq,
1263 num_gangs_clause,
1264 num_workers_clause,
1265 vector_length_clause,
1266 kernels_clauses);
1267 gimple_seq_add_stmt (&region_body, single_region);
1269 else if (gang_single_seq != NULL && only_simple_assignments)
1271 /* There is a sequence of sequential statements preceding this
1272 loop, but they are all simple assignments. This is
1273 probably setup code for the loop; in particular, Fortran DO
1274 loops are preceded by code to copy the loop limit variable
1275 to a temporary. Group this code together with the loop
1276 itself. */
1277 gimple_seq_add_stmt (&gang_single_seq, stmt);
1278 stmt = gimple_build_bind (NULL, gang_single_seq,
1279 make_node (BLOCK));
1281 gang_single_seq = NULL;
1282 only_simple_assignments = true;
1284 gimple_seq parallel_seq = NULL;
1285 gimple_seq_add_stmt (&parallel_seq, stmt);
1286 gimple *parallel_region
1287 = make_region_loop_nest (omp_for, parallel_seq,
1288 num_gangs_clause,
1289 num_workers_clause,
1290 vector_length_clause,
1291 kernels_clauses);
1292 gimple_seq_add_stmt (&region_body, parallel_region);
1294 else
1296 if (omp_for != NULL)
1298 gcc_checking_assert (!is_unconditional_oacc_for_loop);
1299 if (dump_enabled_p ())
1300 dump_printf_loc (MSG_MISSED_OPTIMIZATION, omp_for,
1301 "unparallelized loop nest"
1302 " in OpenACC %<kernels%> region:"
1303 " it's executed conditionally\n");
1306 /* This is not an unconditional OMP for statement, so it will be
1307 put into a gang-single region. */
1308 gimple_seq_add_stmt (&gang_single_seq, stmt);
1309 /* Is this a simple assignment? We call it simple if it is an
1310 assignment to an artificial local variable. This captures
1311 Fortran loop setup code computing loop bounds and offsets. */
1312 bool is_simple_assignment
1313 = (gimple_code (stmt) == GIMPLE_ASSIGN
1314 && TREE_CODE (gimple_assign_lhs (stmt)) == VAR_DECL
1315 && DECL_ARTIFICIAL (gimple_assign_lhs (stmt)));
1316 if (!is_simple_assignment)
1317 only_simple_assignments = false;
1321 /* If we did not emit a new region, and are not going to emit one now
1322 (that is, the original region was empty), prepare to emit a dummy so as
1323 to preserve the original construct, which other processing (at least
1324 test cases) depend on. */
1325 if (region_body == NULL && gang_single_seq == NULL)
1327 gimple *stmt = gimple_build_nop ();
1328 gimple_set_location (stmt, loc);
1329 gimple_seq_add_stmt (&gang_single_seq, stmt);
1332 /* Gather up any remaining gang-single statements. */
1333 if (gang_single_seq != NULL)
1335 gimple *single_region
1336 = make_region_seq (loc, gang_single_seq,
1337 num_gangs_clause,
1338 num_workers_clause,
1339 vector_length_clause,
1340 kernels_clauses);
1341 gimple_seq_add_stmt (&region_body, single_region);
1344 /* We want to launch these kernels asynchronously. If the original
1345 kernels region had an async clause, this is done automatically because
1346 that async clause was copied to the individual regions we created.
1347 Otherwise, add an async clause to each newly created region, as well as
1348 a wait directive at the end. */
1349 if (async_clause == NULL)
1350 add_async_clauses_and_wait (loc, &region_body);
1352 tree kernels_locals = gimple_bind_vars (as_a <gbind *> (kernels_body));
1353 gimple *body = gimple_build_bind (kernels_locals, region_body,
1354 make_node (BLOCK));
1356 /* If we found variables declared in nested scopes, build a data region to
1357 map them to the device. */
1358 body = maybe_build_inner_data_region (loc, body, inner_bind_vars,
1359 inner_cleanup);
1361 return body;
1364 /* Decompose one OpenACC 'kernels' construct into an OpenACC 'data' construct
1365 containing the original OpenACC 'kernels' construct's region cut up into a
1366 sequence of compute constructs. */
1368 static gimple *
1369 omp_oacc_kernels_decompose_1 (gimple *kernels_stmt)
1371 gcc_checking_assert (gimple_omp_target_kind (kernels_stmt)
1372 == GF_OMP_TARGET_KIND_OACC_KERNELS);
1373 location_t loc = gimple_location (kernels_stmt);
1375 /* Collect the data clauses of the OpenACC 'kernels' directive and create a
1376 new OpenACC 'data' construct with those clauses. */
1377 tree kernels_clauses = gimple_omp_target_clauses (kernels_stmt);
1378 tree data_clauses = NULL;
1379 for (tree c = kernels_clauses; c; c = OMP_CLAUSE_CHAIN (c))
1381 /* Certain clauses are copied to the enclosing OpenACC 'data'. Other
1382 clauses remain on the OpenACC 'kernels'. */
1383 if (OMP_CLAUSE_CODE (c) == OMP_CLAUSE_MAP)
1385 tree decl = OMP_CLAUSE_DECL (c);
1386 HOST_WIDE_INT map_kind = OMP_CLAUSE_MAP_KIND (c);
1387 switch (map_kind)
1389 default:
1390 if (map_kind == GOMP_MAP_ALLOC
1391 && integer_zerop (OMP_CLAUSE_SIZE (c)))
1392 /* ??? This is an alloc clause for mapping a pointer whose
1393 target is already mapped. We leave these on the inner
1394 compute constructs because moving them to the outer data
1395 region causes runtime errors. */
1396 break;
1398 /* For non-artificial variables, and for non-declaration
1399 expressions like A[0:n], copy the clause to the data
1400 region. */
1401 if ((DECL_P (decl) && !DECL_ARTIFICIAL (decl))
1402 || !DECL_P (decl))
1404 tree new_clause = build_omp_clause (OMP_CLAUSE_LOCATION (c),
1405 OMP_CLAUSE_MAP);
1406 OMP_CLAUSE_SET_MAP_KIND (new_clause, map_kind);
1407 /* This must be unshared here to avoid "incorrect sharing
1408 of tree nodes" errors from verify_gimple. */
1409 OMP_CLAUSE_DECL (new_clause) = unshare_expr (decl);
1410 OMP_CLAUSE_SIZE (new_clause) = OMP_CLAUSE_SIZE (c);
1411 OMP_CLAUSE_CHAIN (new_clause) = data_clauses;
1412 data_clauses = new_clause;
1414 /* Now that this data is mapped, turn the data clause on the
1415 inner OpenACC 'kernels' into a 'present' clause. */
1416 OMP_CLAUSE_SET_MAP_KIND (c, GOMP_MAP_FORCE_PRESENT);
1418 break;
1420 case GOMP_MAP_POINTER:
1421 case GOMP_MAP_TO_PSET:
1422 case GOMP_MAP_FORCE_TOFROM:
1423 case GOMP_MAP_FIRSTPRIVATE_POINTER:
1424 case GOMP_MAP_FIRSTPRIVATE_REFERENCE:
1425 /* ??? Copying these map kinds leads to internal compiler
1426 errors in later passes. */
1427 break;
1430 else if (OMP_CLAUSE_CODE (c) == OMP_CLAUSE_IF)
1432 /* If there is an 'if' clause, it must be duplicated to the
1433 enclosing data region. Temporarily remove the if clause's
1434 chain to avoid copying it. */
1435 tree saved_chain = OMP_CLAUSE_CHAIN (c);
1436 OMP_CLAUSE_CHAIN (c) = NULL;
1437 tree new_if_clause = unshare_expr (c);
1438 OMP_CLAUSE_CHAIN (c) = saved_chain;
1439 OMP_CLAUSE_CHAIN (new_if_clause) = data_clauses;
1440 data_clauses = new_if_clause;
1443 /* Restore the original order of the clauses. */
1444 data_clauses = nreverse (data_clauses);
1446 gimple *data_region
1447 = gimple_build_omp_target (NULL, GF_OMP_TARGET_KIND_OACC_DATA_KERNELS,
1448 data_clauses);
1449 gimple_set_location (data_region, loc);
1451 /* Transform the body of the kernels region into a sequence of compute
1452 constructs. */
1453 gimple *body = decompose_kernels_region_body (kernels_stmt,
1454 kernels_clauses);
1456 /* Put the transformed pieces together. The entire body of the region is
1457 wrapped in a try-finally statement that calls __builtin_GOACC_data_end
1458 for cleanup. */
1459 gimple *try_stmt = make_data_region_try_statement (loc, body);
1460 gimple_omp_set_body (data_region, try_stmt);
1462 return data_region;
1466 /* Decompose OpenACC 'kernels' constructs in the current function. */
1468 static tree
1469 omp_oacc_kernels_decompose_callback_stmt (gimple_stmt_iterator *gsi_p,
1470 bool *handled_ops_p,
1471 struct walk_stmt_info *)
1473 gimple *stmt = gsi_stmt (*gsi_p);
1475 if ((gimple_code (stmt) == GIMPLE_OMP_TARGET)
1476 && gimple_omp_target_kind (stmt) == GF_OMP_TARGET_KIND_OACC_KERNELS)
1478 gimple *stmt_new = omp_oacc_kernels_decompose_1 (stmt);
1479 gsi_replace (gsi_p, stmt_new, false);
1480 *handled_ops_p = true;
1482 else
1483 *handled_ops_p = false;
1485 return NULL;
1488 static unsigned int
1489 omp_oacc_kernels_decompose (void)
1491 gimple_seq body = gimple_body (current_function_decl);
1493 struct walk_stmt_info wi;
1494 memset (&wi, 0, sizeof (wi));
1495 walk_gimple_seq_mod (&body, omp_oacc_kernels_decompose_callback_stmt, NULL,
1496 &wi);
1498 gimple_set_body (current_function_decl, body);
1500 return 0;
1504 namespace {
1506 const pass_data pass_data_omp_oacc_kernels_decompose =
1508 GIMPLE_PASS, /* type */
1509 "omp_oacc_kernels_decompose", /* name */
1510 OPTGROUP_OMP, /* optinfo_flags */
1511 TV_NONE, /* tv_id */
1512 PROP_gimple_any, /* properties_required */
1513 0, /* properties_provided */
1514 0, /* properties_destroyed */
1515 0, /* todo_flags_start */
1516 0, /* todo_flags_finish */
1519 class pass_omp_oacc_kernels_decompose : public gimple_opt_pass
1521 public:
1522 pass_omp_oacc_kernels_decompose (gcc::context *ctxt)
1523 : gimple_opt_pass (pass_data_omp_oacc_kernels_decompose, ctxt)
1526 /* opt_pass methods: */
1527 virtual bool gate (function *)
1529 return (flag_openacc
1530 && flag_openacc_kernels == OPENACC_KERNELS_DECOMPOSE);
1532 virtual unsigned int execute (function *)
1534 return omp_oacc_kernels_decompose ();
1537 }; // class pass_omp_oacc_kernels_decompose
1539 } // anon namespace
1541 gimple_opt_pass *
1542 make_pass_omp_oacc_kernels_decompose (gcc::context *ctxt)
1544 return new pass_omp_oacc_kernels_decompose (ctxt);