libgomp/omp.h.in

   1 /* Copyright (C) 2005, 2007, 2008 Free Software Foundation, Inc.
   2    Contributed by Richard Henderson <rth@redhat.com>.
   3
   4    This file is part of the GNU OpenMP Library (libgomp).
   5
   6    Libgomp is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU Lesser General Public License as published by
   8    the Free Software Foundation; either version 2.1 of the License, or
   9    (at your option) any later version.
  10
  11    Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
  12    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13    FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
  14    more details.
  15
  16    You should have received a copy of the GNU Lesser General Public License
  17    along with libgomp; see the file COPYING.LIB.  If not, write to the
  18    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  19    MA 02110-1301, USA.  */
  20
  21 /* As a special exception, if you link this library with other files, some
  22    of which are compiled with GCC, to produce an executable, this library
  23    does not by itself cause the resulting executable to be covered by the
  24    GNU General Public License.  This exception does not however invalidate
  25    any other reasons why the executable file might be covered by the GNU
  26    General Public License.  */
  27
  28 #ifndef OMP_H
  29 #define OMP_H 1
  30
  31 #ifndef _LIBGOMP_OMP_LOCK_DEFINED
  32 #define _LIBGOMP_OMP_LOCK_DEFINED 1
  33 /* These two structures get edited by the libgomp build process to
  34    reflect the shape of the two types.  Their internals are private
  35    to the library.  */
  36
  37 typedef struct
  38 {
  39   unsigned char _x[@OMP_LOCK_SIZE@]
  40     __attribute__((__aligned__(@OMP_LOCK_ALIGN@)));
  41 } omp_lock_t;
  42
  43 typedef struct
  44 {
  45   unsigned char _x[@OMP_NEST_LOCK_SIZE@]
  46     __attribute__((__aligned__(@OMP_NEST_LOCK_ALIGN@)));
  47 } omp_nest_lock_t;
  48 #endif
  49
  50 typedef enum omp_sched_t
  51 {
  52   omp_sched_static = 1,
  53   omp_sched_dynamic = 2,
  54   omp_sched_guided = 3,
  55   omp_sched_auto = 4
  56 } omp_sched_t;
  57
  58 #ifdef __cplusplus
  59 extern "C" {
  60 # define __GOMP_NOTHROW throw ()
  61 #else
  62 # define __GOMP_NOTHROW __attribute__((__nothrow__))
  63 #endif
  64
  65 extern void omp_set_num_threads (int) __GOMP_NOTHROW;
  66 extern int omp_get_num_threads (void) __GOMP_NOTHROW;
  67 extern int omp_get_max_threads (void) __GOMP_NOTHROW;
  68 extern int omp_get_thread_num (void) __GOMP_NOTHROW;
  69 extern int omp_get_num_procs (void) __GOMP_NOTHROW;
  70
  71 extern int omp_in_parallel (void) __GOMP_NOTHROW;
  72
  73 extern void omp_set_dynamic (int) __GOMP_NOTHROW;
  74 extern int omp_get_dynamic (void) __GOMP_NOTHROW;
  75
  76 extern void omp_set_nested (int) __GOMP_NOTHROW;
  77 extern int omp_get_nested (void) __GOMP_NOTHROW;
  78
  79 extern void omp_init_lock (omp_lock_t *) __GOMP_NOTHROW;
  80 extern void omp_destroy_lock (omp_lock_t *) __GOMP_NOTHROW;
  81 extern void omp_set_lock (omp_lock_t *) __GOMP_NOTHROW;
  82 extern void omp_unset_lock (omp_lock_t *) __GOMP_NOTHROW;
  83 extern int omp_test_lock (omp_lock_t *) __GOMP_NOTHROW;
  84
  85 extern void omp_init_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  86 extern void omp_destroy_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  87 extern void omp_set_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  88 extern void omp_unset_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  89 extern int omp_test_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
  90
  91 extern double omp_get_wtime (void) __GOMP_NOTHROW;
  92 extern double omp_get_wtick (void) __GOMP_NOTHROW;
  93
  94 void omp_set_schedule (omp_sched_t, int) __GOMP_NOTHROW;
  95 void omp_get_schedule (omp_sched_t *, int *) __GOMP_NOTHROW;
  96 int omp_get_thread_limit (void) __GOMP_NOTHROW;
  97 void omp_set_max_active_levels (int) __GOMP_NOTHROW;
  98 int omp_get_max_active_levels (void) __GOMP_NOTHROW;
  99 int omp_get_level (void) __GOMP_NOTHROW;
 100 int omp_get_ancestor_thread_num (int) __GOMP_NOTHROW;
 101 int omp_get_team_size (int) __GOMP_NOTHROW;
 102 int omp_get_active_level (void) __GOMP_NOTHROW;
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif /* OMP_H */