libgomp/omp.h.in

   1 /* Copyright (C) 2005-2015 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 #ifdef __cplusplus
  66 extern "C" {
  67 # define __GOMP_NOTHROW throw ()
  68 #else
  69 # define __GOMP_NOTHROW __attribute__((__nothrow__))
  70 #endif
  71
  72 extern void omp_set_num_threads (int) __GOMP_NOTHROW;
  73 extern int omp_get_num_threads (void) __GOMP_NOTHROW;
  74 extern int omp_get_max_threads (void) __GOMP_NOTHROW;
  75 extern int omp_get_thread_num (void) __GOMP_NOTHROW;
  76 extern int omp_get_num_procs (void) __GOMP_NOTHROW;
  77
  78 extern int omp_in_parallel (void) __GOMP_NOTHROW;
  79
  80 extern void omp_set_dynamic (int) __GOMP_NOTHROW;
  81 extern int omp_get_dynamic (void) __GOMP_NOTHROW;
  82
  83 extern void omp_set_nested (int) __GOMP_NOTHROW;
  84 extern int omp_get_nested (void) __GOMP_NOTHROW;
  85
  86 extern void omp_init_lock (omp_lock_t *) __GOMP_NOTHROW;
  87 extern void omp_destroy_lock (omp_lock_t *) __GOMP_NOTHROW;
  88 extern void omp_set_lock (omp_lock_t *) __GOMP_NOTHROW;
  89 extern void omp_unset_lock (omp_lock_t *) __GOMP_NOTHROW;
  90 extern int omp_test_lock (omp_lock_t *) __GOMP_NOTHROW;
  91
  92 extern void omp_init_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  93 extern void omp_destroy_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  94 extern void omp_set_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  95 extern void omp_unset_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  96 extern int omp_test_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  97
  98 extern double omp_get_wtime (void) __GOMP_NOTHROW;
  99 extern double omp_get_wtick (void) __GOMP_NOTHROW;
 100
 101 extern void omp_set_schedule (omp_sched_t, int) __GOMP_NOTHROW;
 102 extern void omp_get_schedule (omp_sched_t *, int *) __GOMP_NOTHROW;
 103 extern int omp_get_thread_limit (void) __GOMP_NOTHROW;
 104 extern void omp_set_max_active_levels (int) __GOMP_NOTHROW;
 105 extern int omp_get_max_active_levels (void) __GOMP_NOTHROW;
 106 extern int omp_get_level (void) __GOMP_NOTHROW;
 107 extern int omp_get_ancestor_thread_num (int) __GOMP_NOTHROW;
 108 extern int omp_get_team_size (int) __GOMP_NOTHROW;
 109 extern int omp_get_active_level (void) __GOMP_NOTHROW;
 110
 111 extern int omp_in_final (void) __GOMP_NOTHROW;
 112
 113 extern int omp_get_cancellation (void) __GOMP_NOTHROW;
 114 extern omp_proc_bind_t omp_get_proc_bind (void) __GOMP_NOTHROW;
 115
 116 extern void omp_set_default_device (int) __GOMP_NOTHROW;
 117 extern int omp_get_default_device (void) __GOMP_NOTHROW;
 118 extern int omp_get_num_devices (void) __GOMP_NOTHROW;
 119 extern int omp_get_num_teams (void) __GOMP_NOTHROW;
 120 extern int omp_get_team_num (void) __GOMP_NOTHROW;
 121
 122 extern int omp_is_initial_device (void) __GOMP_NOTHROW;
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128 #endif /* _OMP_H */