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-2021 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 36 /* Explicitly specified loop axes. */ 37 OLF_DIM_BASE = 5, 38 OLF_DIM_GANG = 1u << (OLF_DIM_BASE + GOMP_DIM_GANG), 39 OLF_DIM_WORKER = 1u << (OLF_DIM_BASE + GOMP_DIM_WORKER), 40 OLF_DIM_VECTOR = 1u << (OLF_DIM_BASE + GOMP_DIM_VECTOR), 41 42 OLF_MAX = OLF_DIM_BASE + GOMP_DIM_MAX 43 }; 44 45 /* A structure holding the elements of: 46 for (V = N1; V cond N2; V += STEP) [...] 47 or for non-rectangular loops: 48 for (V = M1 * W + N1; V cond M2 * W + N2; V += STEP; 49 where W is V of the OUTER-th loop (e.g. for OUTER 1 it is the 50 the index of the immediately surrounding loop). 51 NON_RECT_REFERENCED is true for loops referenced by loops 52 with non-NULL M1 or M2. */ 53 54 struct omp_for_data_loop 55 { 56 tree v, n1, n2, step, m1, m2; 57 enum tree_code cond_code; 58 int outer; 59 bool non_rect_referenced; 60 }; 61 62 /* A structure describing the main elements of a parallel loop. */ 63 64 struct omp_for_data 65 { 66 struct omp_for_data_loop loop; 67 tree chunk_size; 68 gomp_for *for_stmt; 69 tree pre, iter_type; 70 tree tiling; /* Tiling values (if non null). */ 71 int collapse; /* Collapsed loops, 1 for a non-collapsed loop. */ 72 int ordered; 73 int first_nonrect, last_nonrect; 74 bool have_nowait, have_ordered, simd_schedule, have_reductemp; 75 bool have_pointer_condtemp, have_scantemp, have_nonctrl_scantemp; 76 bool non_rect; 77 int lastprivate_conditional; 78 unsigned char sched_modifiers; 79 enum omp_clause_schedule_kind sched_kind; 80 struct omp_for_data_loop *loops; 81 /* The following are relevant only for non-rectangular loops 82 where only a single loop depends on an outer loop iterator. */ 83 tree first_inner_iterations; /* Number of iterations of the inner 84 loop with the first outer iterator 85 (or adjn1, if that is non-NULL). */ 86 tree factor; /* (m2 - m1) * outer_step / inner_step. */ 87 /* Adjusted n1 of the outer loop in such loop nests (if needed). */ 88 tree adjn1; 89 }; 90 91 #define OACC_FN_ATTRIB "oacc function" 92 93 extern tree omp_find_clause (tree clauses, enum omp_clause_code kind); 94 extern bool omp_is_allocatable_or_ptr (tree decl); 95 extern tree omp_check_optional_argument (tree decl, bool for_present_check); 96 extern bool omp_is_reference (tree decl); 97 extern void omp_adjust_for_condition (location_t loc, enum tree_code *cond_code, 98 tree *n2, tree v, tree step); 99 extern tree omp_get_for_step_from_incr (location_t loc, tree incr); 100 extern void omp_extract_for_data (gomp_for *for_stmt, struct omp_for_data *fd, 101 struct omp_for_data_loop *loops); 102 extern gimple *omp_build_barrier (tree lhs); 103 extern tree find_combined_omp_for (tree *, int *, void *); 104 extern poly_uint64 omp_max_vf (void); 105 extern int omp_max_simt_vf (void); 106 extern int omp_constructor_traits_to_codes (tree, enum tree_code *); 107 extern int omp_context_selector_matches (tree); 108 extern int omp_context_selector_set_compare (const char *, tree, tree); 109 extern tree omp_get_context_selector (tree, const char *, const char *); 110 extern tree omp_resolve_declare_variant (tree); 111 extern tree oacc_launch_pack (unsigned code, tree device, unsigned op); 112 extern tree oacc_replace_fn_attrib_attr (tree attribs, tree dims); 113 extern void oacc_replace_fn_attrib (tree fn, tree dims); 114 extern void oacc_set_fn_attrib (tree fn, tree clauses, vec<tree> *args); 115 extern int oacc_verify_routine_clauses (tree, tree *, location_t, 116 const char *); 117 extern tree oacc_build_routine_dims (tree clauses); 118 extern tree oacc_get_fn_attrib (tree fn); 119 extern bool offloading_function_p (tree fn); 120 extern int oacc_get_fn_dim_size (tree fn, int axis); 121 extern int oacc_get_ifn_dim_arg (const gimple *stmt); 122 123 enum omp_requires { 124 OMP_REQUIRES_ATOMIC_DEFAULT_MEM_ORDER = 0xf, 125 OMP_REQUIRES_UNIFIED_ADDRESS = 0x10, 126 OMP_REQUIRES_UNIFIED_SHARED_MEMORY = 0x20, 127 OMP_REQUIRES_DYNAMIC_ALLOCATORS = 0x40, 128 OMP_REQUIRES_REVERSE_OFFLOAD = 0x80, 129 OMP_REQUIRES_ATOMIC_DEFAULT_MEM_ORDER_USED = 0x100, 130 OMP_REQUIRES_TARGET_USED = 0x200 131 }; 132 133 extern GTY(()) enum omp_requires omp_requires_mask; 134 135 #endif /* GCC_OMP_GENERAL_H */ 136