libgomp/omp.h.in

   1 /* Copyright (C) 2005-2018 Free Software Foundation, Inc.
   2    Contributed by Richard Henderson <rth@redhat.com>.
   3
   4    This file is part of the GNU Offloading and Multi Processing Library
   5    (libgomp).
   6
   7    Libgomp is free software; you can redistribute it and/or modify it
   8    under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3, or (at your option)
  10    any later version.
  11
  12    Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
  13    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  15    more details.
  16
  17    Under Section 7 of GPL version 3, you are granted additional
  18    permissions described in the GCC Runtime Library Exception, version
  19    3.1, as published by the Free Software Foundation.
  20
  21    You should have received a copy of the GNU General Public License and
  22    a copy of the GCC Runtime Library Exception along with this program;
  23    see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  24    <http://www.gnu.org/licenses/>.  */
  25
  26 #ifndef _OMP_H
  27 #define _OMP_H 1
  28
  29 #ifndef _LIBGOMP_OMP_LOCK_DEFINED
  30 #define _LIBGOMP_OMP_LOCK_DEFINED 1
  31 /* These two structures get edited by the libgomp build process to
  32    reflect the shape of the two types.  Their internals are private
  33    to the library.  */
  34
  35 typedef struct
  36 {
  37   unsigned char _x[@OMP_LOCK_SIZE@]
  38     __attribute__((__aligned__(@OMP_LOCK_ALIGN@)));
  39 } omp_lock_t;
  40
  41 typedef struct
  42 {
  43   unsigned char _x[@OMP_NEST_LOCK_SIZE@]
  44     __attribute__((__aligned__(@OMP_NEST_LOCK_ALIGN@)));
  45 } omp_nest_lock_t;
  46 #endif
  47
  48 typedef enum omp_sched_t
  49 {
  50   omp_sched_static = 1,
  51   omp_sched_dynamic = 2,
  52   omp_sched_guided = 3,
  53   omp_sched_auto = 4
  54 } omp_sched_t;
  55
  56 typedef enum omp_proc_bind_t
  57 {
  58   omp_proc_bind_false = 0,
  59   omp_proc_bind_true = 1,
  60   omp_proc_bind_master = 2,
  61   omp_proc_bind_close = 3,
  62   omp_proc_bind_spread = 4
  63 } omp_proc_bind_t;
  64
  65 typedef enum omp_lock_hint_t
  66 {
  67   omp_lock_hint_none = 0,
  68   omp_lock_hint_uncontended = 1,
  69   omp_lock_hint_contended = 2,
  70   omp_lock_hint_nonspeculative = 4,
  71   omp_lock_hint_speculative = 8,
  72 } omp_lock_hint_t;
  73
  74 #ifdef __cplusplus
  75 extern "C" {
  76 # define __GOMP_NOTHROW throw ()
  77 #else
  78 # define __GOMP_NOTHROW __attribute__((__nothrow__))
  79 #endif
  80
  81 extern void omp_set_num_threads (int) __GOMP_NOTHROW;
  82 extern int omp_get_num_threads (void) __GOMP_NOTHROW;
  83 extern int omp_get_max_threads (void) __GOMP_NOTHROW;
  84 extern int omp_get_thread_num (void) __GOMP_NOTHROW;
  85 extern int omp_get_num_procs (void) __GOMP_NOTHROW;
  86
  87 extern int omp_in_parallel (void) __GOMP_NOTHROW;
  88
  89 extern void omp_set_dynamic (int) __GOMP_NOTHROW;
  90 extern int omp_get_dynamic (void) __GOMP_NOTHROW;
  91
  92 extern void omp_set_nested (int) __GOMP_NOTHROW;
  93 extern int omp_get_nested (void) __GOMP_NOTHROW;
  94
  95 extern void omp_init_lock (omp_lock_t *) __GOMP_NOTHROW;
  96 extern void omp_init_lock_with_hint (omp_lock_t *, omp_lock_hint_t)
  97   __GOMP_NOTHROW;
  98 extern void omp_destroy_lock (omp_lock_t *) __GOMP_NOTHROW;
  99 extern void omp_set_lock (omp_lock_t *) __GOMP_NOTHROW;
 100 extern void omp_unset_lock (omp_lock_t *) __GOMP_NOTHROW;
 101 extern int omp_test_lock (omp_lock_t *) __GOMP_NOTHROW;
 102
 103 extern void omp_init_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
 104 extern void omp_init_nest_lock_with_hint (omp_lock_t *, omp_lock_hint_t)
 105   __GOMP_NOTHROW;
 106 extern void omp_destroy_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
 107 extern void omp_set_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
 108 extern void omp_unset_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
 109 extern int omp_test_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
 110
 111 extern double omp_get_wtime (void) __GOMP_NOTHROW;
 112 extern double omp_get_wtick (void) __GOMP_NOTHROW;
 113
 114 extern void omp_set_schedule (omp_sched_t, int) __GOMP_NOTHROW;
 115 extern void omp_get_schedule (omp_sched_t *, int *) __GOMP_NOTHROW;
 116 extern int omp_get_thread_limit (void) __GOMP_NOTHROW;
 117 extern void omp_set_max_active_levels (int) __GOMP_NOTHROW;
 118 extern int omp_get_max_active_levels (void) __GOMP_NOTHROW;
 119 extern int omp_get_level (void) __GOMP_NOTHROW;
 120 extern int omp_get_ancestor_thread_num (int) __GOMP_NOTHROW;
 121 extern int omp_get_team_size (int) __GOMP_NOTHROW;
 122 extern int omp_get_active_level (void) __GOMP_NOTHROW;
 123
 124 extern int omp_in_final (void) __GOMP_NOTHROW;
 125
 126 extern int omp_get_cancellation (void) __GOMP_NOTHROW;
 127 extern omp_proc_bind_t omp_get_proc_bind (void) __GOMP_NOTHROW;
 128 extern int omp_get_num_places (void) __GOMP_NOTHROW;
 129 extern int omp_get_place_num_procs (int) __GOMP_NOTHROW;
 130 extern void omp_get_place_proc_ids (int, int *) __GOMP_NOTHROW;
 131 extern int omp_get_place_num (void) __GOMP_NOTHROW;
 132 extern int omp_get_partition_num_places (void) __GOMP_NOTHROW;
 133 extern void omp_get_partition_place_nums (int *) __GOMP_NOTHROW;
 134
 135 extern void omp_set_default_device (int) __GOMP_NOTHROW;
 136 extern int omp_get_default_device (void) __GOMP_NOTHROW;
 137 extern int omp_get_num_devices (void) __GOMP_NOTHROW;
 138 extern int omp_get_num_teams (void) __GOMP_NOTHROW;
 139 extern int omp_get_team_num (void) __GOMP_NOTHROW;
 140
 141 extern int omp_is_initial_device (void) __GOMP_NOTHROW;
 142 extern int omp_get_initial_device (void) __GOMP_NOTHROW;
 143 extern int omp_get_max_task_priority (void) __GOMP_NOTHROW;
 144
 145 extern void *omp_target_alloc (__SIZE_TYPE__, int) __GOMP_NOTHROW;
 146 extern void omp_target_free (void *, int) __GOMP_NOTHROW;
 147 extern int omp_target_is_present (void *, int) __GOMP_NOTHROW;
 148 extern int omp_target_memcpy (void *, void *, __SIZE_TYPE__, __SIZE_TYPE__,
 149                               __SIZE_TYPE__, int, int) __GOMP_NOTHROW;
 150 extern int omp_target_memcpy_rect (void *, void *, __SIZE_TYPE__, int,
 151                                    const __SIZE_TYPE__ *,
 152                                    const __SIZE_TYPE__ *,
 153                                    const __SIZE_TYPE__ *,
 154                                    const __SIZE_TYPE__ *,
 155                                    const __SIZE_TYPE__ *, int, int)
 156   __GOMP_NOTHROW;
 157 extern int omp_target_associate_ptr (void *, void *, __SIZE_TYPE__,
 158                                      __SIZE_TYPE__, int) __GOMP_NOTHROW;
 159 extern int omp_target_disassociate_ptr (void *, int) __GOMP_NOTHROW;
 160
 161 #ifdef __cplusplus
 162 }
 163 #endif
 164
 165 #endif /* _OMP_H */