xref: /netbsd-src/external/gpl3/gcc/dist/gcc/omp-general.h (revision b1e838363e3c6fc78a55519254d99869742dd33c)
1 /* General types and functions that are uselful for processing of OpenMP,
2    OpenACC and similar directivers at various stages of compilation.
3 
4    Copyright (C) 2005-2022 Free Software Foundation, Inc.
5 
6 This file is part of GCC.
7 
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.
12 
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.
17 
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/>.  */
21 
22 #ifndef GCC_OMP_GENERAL_H
23 #define GCC_OMP_GENERAL_H
24 
25 #include "gomp-constants.h"
26 
27 /*  Flags for an OpenACC loop.  */
28 
29 enum oacc_loop_flags {
30   OLF_SEQ	= 1u << 0,  /* Explicitly sequential  */
31   OLF_AUTO	= 1u << 1,	/* Compiler chooses axes.  */
32   OLF_INDEPENDENT = 1u << 2,	/* Iterations are known independent.  */
33   OLF_GANG_STATIC = 1u << 3,	/* Gang partitioning is static (has op). */
34   OLF_TILE	= 1u << 4,	/* Tiled loop. */
35   OLF_REDUCTION = 1u << 5,	/* Reduction loop.  */
36 
37   /* Explicitly specified loop axes.  */
38   OLF_DIM_BASE = 6,
39   OLF_DIM_GANG   = 1u << (OLF_DIM_BASE + GOMP_DIM_GANG),
40   OLF_DIM_WORKER = 1u << (OLF_DIM_BASE + GOMP_DIM_WORKER),
41   OLF_DIM_VECTOR = 1u << (OLF_DIM_BASE + GOMP_DIM_VECTOR),
42 
43   OLF_MAX = OLF_DIM_BASE + GOMP_DIM_MAX
44 };
45 
46 /* A structure holding the elements of:
47    for (V = N1; V cond N2; V += STEP) [...]
48    or for non-rectangular loops:
49    for (V = M1 * W + N1; V cond M2 * W + N2; V += STEP;
50    where W is V of the OUTER-th loop (e.g. for OUTER 1 it is the
51    the index of the immediately surrounding loop).
52    NON_RECT_REFERENCED is true for loops referenced by loops
53    with non-NULL M1 or M2.  */
54 
55 struct omp_for_data_loop
56 {
57   tree v, n1, n2, step, m1, m2;
58   enum tree_code cond_code;
59   int outer;
60   bool non_rect_referenced;
61 };
62 
63 /* A structure describing the main elements of a parallel loop.  */
64 
65 struct omp_for_data
66 {
67   struct omp_for_data_loop loop;
68   tree chunk_size;
69   gomp_for *for_stmt;
70   tree pre, iter_type;
71   tree tiling;  /* Tiling values (if non null).  */
72   int collapse;  /* Collapsed loops, 1 for a non-collapsed loop.  */
73   int ordered;
74   int first_nonrect, last_nonrect;
75   bool have_nowait, have_ordered, simd_schedule, have_reductemp;
76   bool have_pointer_condtemp, have_scantemp, have_nonctrl_scantemp;
77   bool non_rect;
78   int lastprivate_conditional;
79   unsigned char sched_modifiers;
80   enum omp_clause_schedule_kind sched_kind;
81   struct omp_for_data_loop *loops;
82   /* The following are relevant only for non-rectangular loops
83      where only a single loop depends on an outer loop iterator.  */
84   tree first_inner_iterations; /* Number of iterations of the inner
85 				  loop with the first outer iterator
86 				  (or adjn1, if that is non-NULL).  */
87   tree factor; /* (m2 - m1) * outer_step / inner_step.  */
88   /* Adjusted n1 of the outer loop in such loop nests (if needed).  */
89   tree adjn1;
90 };
91 
92 #define OACC_FN_ATTRIB "oacc function"
93 
94 extern tree omp_find_clause (tree clauses, enum omp_clause_code kind);
95 extern bool omp_is_allocatable_or_ptr (tree decl);
96 extern tree omp_check_optional_argument (tree decl, bool for_present_check);
97 extern bool omp_privatize_by_reference (tree decl);
98 extern void omp_adjust_for_condition (location_t loc, enum tree_code *cond_code,
99 				      tree *n2, tree v, tree step);
100 extern tree omp_get_for_step_from_incr (location_t loc, tree incr);
101 extern void omp_extract_for_data (gomp_for *for_stmt, struct omp_for_data *fd,
102 				  struct omp_for_data_loop *loops);
103 extern gimple *omp_build_barrier (tree lhs);
104 extern tree find_combined_omp_for (tree *, int *, void *);
105 extern poly_uint64 omp_max_vf (void);
106 extern int omp_max_simt_vf (void);
107 extern int omp_constructor_traits_to_codes (tree, enum tree_code *);
108 extern tree omp_check_context_selector (location_t loc, tree ctx);
109 extern void omp_mark_declare_variant (location_t loc, tree variant,
110 				      tree construct);
111 extern int omp_context_selector_matches (tree);
112 extern int omp_context_selector_set_compare (const char *, tree, tree);
113 extern tree omp_get_context_selector (tree, const char *, const char *);
114 extern tree omp_resolve_declare_variant (tree);
115 extern tree oacc_launch_pack (unsigned code, tree device, unsigned op);
116 extern tree oacc_replace_fn_attrib_attr (tree attribs, tree dims);
117 extern void oacc_replace_fn_attrib (tree fn, tree dims);
118 extern void oacc_set_fn_attrib (tree fn, tree clauses, vec<tree> *args);
119 extern int oacc_verify_routine_clauses (tree, tree *, location_t,
120 					const char *);
121 extern tree oacc_build_routine_dims (tree clauses);
122 extern tree oacc_get_fn_attrib (tree fn);
123 extern bool offloading_function_p (tree fn);
124 extern int oacc_get_fn_dim_size (tree fn, int axis);
125 extern int oacc_get_ifn_dim_arg (const gimple *stmt);
126 
127 enum omp_requires {
128   OMP_REQUIRES_ATOMIC_DEFAULT_MEM_ORDER = 0xf,
129   OMP_REQUIRES_UNIFIED_ADDRESS = 0x10,
130   OMP_REQUIRES_UNIFIED_SHARED_MEMORY = 0x20,
131   OMP_REQUIRES_DYNAMIC_ALLOCATORS = 0x40,
132   OMP_REQUIRES_REVERSE_OFFLOAD = 0x80,
133   OMP_REQUIRES_ATOMIC_DEFAULT_MEM_ORDER_USED = 0x100,
134   OMP_REQUIRES_TARGET_USED = 0x200
135 };
136 
137 extern GTY(()) enum omp_requires omp_requires_mask;
138 
139 static inline dump_flags_t
get_openacc_privatization_dump_flags()140 get_openacc_privatization_dump_flags ()
141 {
142   dump_flags_t l_dump_flags = MSG_NOTE;
143 
144   /* For '--param=openacc-privatization=quiet', diagnostics only go to dump
145      files.  */
146   if (param_openacc_privatization == OPENACC_PRIVATIZATION_QUIET)
147     l_dump_flags |= MSG_PRIORITY_INTERNALS;
148 
149   return l_dump_flags;
150 }
151 
152 extern tree omp_build_component_ref (tree obj, tree field);
153 
154 #endif /* GCC_OMP_GENERAL_H */
155