contrib/openmp/runtime/src/include/50/omp.h.var

   1 /*
   2  * include/50/omp.h.var
   3  */
   4
   5
   6 //===----------------------------------------------------------------------===//
   7 //
   8 //                     The LLVM Compiler Infrastructure
   9 //
  10 // This file is dual licensed under the MIT and the University of Illinois Open
  11 // Source Licenses. See LICENSE.txt for details.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15
  16 #ifndef __OMP_H
  17 #   define __OMP_H
  18
  19 #   define KMP_VERSION_MAJOR    @LIBOMP_VERSION_MAJOR@
  20 #   define KMP_VERSION_MINOR    @LIBOMP_VERSION_MINOR@
  21 #   define KMP_VERSION_BUILD    @LIBOMP_VERSION_BUILD@
  22 #   define KMP_BUILD_DATE       "@LIBOMP_BUILD_DATE@"
  23
  24 #   ifdef __cplusplus
  25     extern "C" {
  26 #   endif
  27
  28 #   define omp_set_affinity_format   ompc_set_affinity_format
  29 #   define omp_get_affinity_format   ompc_get_affinity_format
  30 #   define omp_display_affinity      ompc_display_affinity
  31 #   define omp_capture_affinity      ompc_capture_affinity
  32
  33 #   if defined(_WIN32)
  34 #       define __KAI_KMPC_CONVENTION __cdecl
  35 #       ifndef __KMP_IMP
  36 #           define __KMP_IMP __declspec(dllimport)
  37 #       endif
  38 #   else
  39 #       define __KAI_KMPC_CONVENTION
  40 #       ifndef __KMP_IMP
  41 #           define __KMP_IMP
  42 #       endif
  43 #   endif
  44
  45     /* schedule kind constants */
  46     typedef enum omp_sched_t {
  47         omp_sched_static  = 1,
  48         omp_sched_dynamic = 2,
  49         omp_sched_guided  = 3,
  50         omp_sched_auto    = 4
  51     } omp_sched_t;
  52
  53     /* set API functions */
  54     extern void   __KAI_KMPC_CONVENTION  omp_set_num_threads (int);
  55     extern void   __KAI_KMPC_CONVENTION  omp_set_dynamic     (int);
  56     extern void   __KAI_KMPC_CONVENTION  omp_set_nested      (int);
  57     extern void   __KAI_KMPC_CONVENTION  omp_set_max_active_levels (int);
  58     extern void   __KAI_KMPC_CONVENTION  omp_set_schedule          (omp_sched_t, int);
  59
  60     /* query API functions */
  61     extern int    __KAI_KMPC_CONVENTION  omp_get_num_threads  (void);
  62     extern int    __KAI_KMPC_CONVENTION  omp_get_dynamic      (void);
  63     extern int    __KAI_KMPC_CONVENTION  omp_get_nested       (void);
  64     extern int    __KAI_KMPC_CONVENTION  omp_get_max_threads  (void);
  65     extern int    __KAI_KMPC_CONVENTION  omp_get_thread_num   (void);
  66     extern int    __KAI_KMPC_CONVENTION  omp_get_num_procs    (void);
  67     extern int    __KAI_KMPC_CONVENTION  omp_in_parallel      (void);
  68     extern int    __KAI_KMPC_CONVENTION  omp_in_final         (void);
  69     extern int    __KAI_KMPC_CONVENTION  omp_get_active_level        (void);
  70     extern int    __KAI_KMPC_CONVENTION  omp_get_level               (void);
  71     extern int    __KAI_KMPC_CONVENTION  omp_get_ancestor_thread_num (int);
  72     extern int    __KAI_KMPC_CONVENTION  omp_get_team_size           (int);
  73     extern int    __KAI_KMPC_CONVENTION  omp_get_thread_limit        (void);
  74     extern int    __KAI_KMPC_CONVENTION  omp_get_max_active_levels   (void);
  75     extern void   __KAI_KMPC_CONVENTION  omp_get_schedule            (omp_sched_t *, int *);
  76     extern int    __KAI_KMPC_CONVENTION  omp_get_max_task_priority   (void);
  77
  78     /* lock API functions */
  79     typedef struct omp_lock_t {
  80         void * _lk;
  81     } omp_lock_t;
  82
  83     extern void   __KAI_KMPC_CONVENTION  omp_init_lock    (omp_lock_t *);
  84     extern void   __KAI_KMPC_CONVENTION  omp_set_lock     (omp_lock_t *);
  85     extern void   __KAI_KMPC_CONVENTION  omp_unset_lock   (omp_lock_t *);
  86     extern void   __KAI_KMPC_CONVENTION  omp_destroy_lock (omp_lock_t *);
  87     extern int    __KAI_KMPC_CONVENTION  omp_test_lock    (omp_lock_t *);
  88
  89     /* nested lock API functions */
  90     typedef struct omp_nest_lock_t {
  91         void * _lk;
  92     } omp_nest_lock_t;
  93
  94     extern void   __KAI_KMPC_CONVENTION  omp_init_nest_lock    (omp_nest_lock_t *);
  95     extern void   __KAI_KMPC_CONVENTION  omp_set_nest_lock     (omp_nest_lock_t *);
  96     extern void   __KAI_KMPC_CONVENTION  omp_unset_nest_lock   (omp_nest_lock_t *);
  97     extern void   __KAI_KMPC_CONVENTION  omp_destroy_nest_lock (omp_nest_lock_t *);
  98     extern int    __KAI_KMPC_CONVENTION  omp_test_nest_lock    (omp_nest_lock_t *);
  99
 100     /* OpenMP 5.0  Synchronization hints*/
 101     typedef enum omp_sync_hint_t {
 102         omp_sync_hint_none           = 0,
 103         omp_lock_hint_none           = omp_sync_hint_none,
 104         omp_sync_hint_uncontended    = 1,
 105         omp_lock_hint_uncontended    = omp_sync_hint_uncontended,
 106         omp_sync_hint_contended      = (1<<1),
 107         omp_lock_hint_contended      = omp_sync_hint_contended,
 108         omp_sync_hint_nonspeculative = (1<<2),
 109         omp_lock_hint_nonspeculative = omp_sync_hint_nonspeculative,
 110         omp_sync_hint_speculative    = (1<<3),
 111         omp_lock_hint_speculative    = omp_sync_hint_speculative,
 112         kmp_lock_hint_hle            = (1<<16),
 113         kmp_lock_hint_rtm            = (1<<17),
 114         kmp_lock_hint_adaptive       = (1<<18)
 115     } omp_sync_hint_t;
 116
 117     /* lock hint type for dynamic user lock */
 118     typedef omp_sync_hint_t omp_lock_hint_t;
 119
 120     /* hinted lock initializers */
 121     extern void __KAI_KMPC_CONVENTION omp_init_lock_with_hint(omp_lock_t *, omp_lock_hint_t);
 122     extern void __KAI_KMPC_CONVENTION omp_init_nest_lock_with_hint(omp_nest_lock_t *, omp_lock_hint_t);
 123
 124     /* time API functions */
 125     extern double __KAI_KMPC_CONVENTION  omp_get_wtime (void);
 126     extern double __KAI_KMPC_CONVENTION  omp_get_wtick (void);
 127
 128     /* OpenMP 4.0 */
 129     extern int  __KAI_KMPC_CONVENTION  omp_get_default_device (void);
 130     extern void __KAI_KMPC_CONVENTION  omp_set_default_device (int);
 131     extern int  __KAI_KMPC_CONVENTION  omp_is_initial_device (void);
 132     extern int  __KAI_KMPC_CONVENTION  omp_get_num_devices (void);
 133     extern int  __KAI_KMPC_CONVENTION  omp_get_num_teams (void);
 134     extern int  __KAI_KMPC_CONVENTION  omp_get_team_num (void);
 135     extern int  __KAI_KMPC_CONVENTION  omp_get_cancellation (void);
 136
 137 #   include <stdlib.h>
 138     /* OpenMP 4.5 */
 139     extern int   __KAI_KMPC_CONVENTION  omp_get_initial_device (void);
 140     extern void* __KAI_KMPC_CONVENTION  omp_target_alloc(size_t, int);
 141     extern void  __KAI_KMPC_CONVENTION  omp_target_free(void *, int);
 142     extern int   __KAI_KMPC_CONVENTION  omp_target_is_present(void *, int);
 143     extern int   __KAI_KMPC_CONVENTION  omp_target_memcpy(void *, void *, size_t, size_t, size_t, int, int);
 144     extern int   __KAI_KMPC_CONVENTION  omp_target_memcpy_rect(void *, void *, size_t, int, const size_t *,
 145                                             const size_t *, const size_t *, const size_t *, const size_t *, int, int);
 146     extern int   __KAI_KMPC_CONVENTION  omp_target_associate_ptr(void *, void *, size_t, size_t, int);
 147     extern int   __KAI_KMPC_CONVENTION  omp_target_disassociate_ptr(void *, int);
 148
 149     /* OpenMP 5.0 */
 150     extern int   __KAI_KMPC_CONVENTION  omp_get_device_num (void);
 151
 152     /* kmp API functions */
 153     extern int    __KAI_KMPC_CONVENTION  kmp_get_stacksize          (void);
 154     extern void   __KAI_KMPC_CONVENTION  kmp_set_stacksize          (int);
 155     extern size_t __KAI_KMPC_CONVENTION  kmp_get_stacksize_s        (void);
 156     extern void   __KAI_KMPC_CONVENTION  kmp_set_stacksize_s        (size_t);
 157     extern int    __KAI_KMPC_CONVENTION  kmp_get_blocktime          (void);
 158     extern int    __KAI_KMPC_CONVENTION  kmp_get_library            (void);
 159     extern void   __KAI_KMPC_CONVENTION  kmp_set_blocktime          (int);
 160     extern void   __KAI_KMPC_CONVENTION  kmp_set_library            (int);
 161     extern void   __KAI_KMPC_CONVENTION  kmp_set_library_serial     (void);
 162     extern void   __KAI_KMPC_CONVENTION  kmp_set_library_turnaround (void);
 163     extern void   __KAI_KMPC_CONVENTION  kmp_set_library_throughput (void);
 164     extern void   __KAI_KMPC_CONVENTION  kmp_set_defaults           (char const *);
 165     extern void   __KAI_KMPC_CONVENTION  kmp_set_disp_num_buffers   (int);
 166
 167     /* Intel affinity API */
 168     typedef void * kmp_affinity_mask_t;
 169
 170     extern int    __KAI_KMPC_CONVENTION  kmp_set_affinity             (kmp_affinity_mask_t *);
 171     extern int    __KAI_KMPC_CONVENTION  kmp_get_affinity             (kmp_affinity_mask_t *);
 172     extern int    __KAI_KMPC_CONVENTION  kmp_get_affinity_max_proc    (void);
 173     extern void   __KAI_KMPC_CONVENTION  kmp_create_affinity_mask     (kmp_affinity_mask_t *);
 174     extern void   __KAI_KMPC_CONVENTION  kmp_destroy_affinity_mask    (kmp_affinity_mask_t *);
 175     extern int    __KAI_KMPC_CONVENTION  kmp_set_affinity_mask_proc   (int, kmp_affinity_mask_t *);
 176     extern int    __KAI_KMPC_CONVENTION  kmp_unset_affinity_mask_proc (int, kmp_affinity_mask_t *);
 177     extern int    __KAI_KMPC_CONVENTION  kmp_get_affinity_mask_proc   (int, kmp_affinity_mask_t *);
 178
 179     /* OpenMP 4.0 affinity API */
 180     typedef enum omp_proc_bind_t {
 181         omp_proc_bind_false = 0,
 182         omp_proc_bind_true = 1,
 183         omp_proc_bind_master = 2,
 184         omp_proc_bind_close = 3,
 185         omp_proc_bind_spread = 4
 186     } omp_proc_bind_t;
 187
 188     extern omp_proc_bind_t __KAI_KMPC_CONVENTION omp_get_proc_bind (void);
 189
 190     /* OpenMP 4.5 affinity API */
 191     extern int  __KAI_KMPC_CONVENTION omp_get_num_places (void);
 192     extern int  __KAI_KMPC_CONVENTION omp_get_place_num_procs (int);
 193     extern void __KAI_KMPC_CONVENTION omp_get_place_proc_ids (int, int *);
 194     extern int  __KAI_KMPC_CONVENTION omp_get_place_num (void);
 195     extern int  __KAI_KMPC_CONVENTION omp_get_partition_num_places (void);
 196     extern void __KAI_KMPC_CONVENTION omp_get_partition_place_nums (int *);
 197
 198     extern void * __KAI_KMPC_CONVENTION  kmp_malloc  (size_t);
 199     extern void * __KAI_KMPC_CONVENTION  kmp_aligned_malloc  (size_t, size_t);
 200     extern void * __KAI_KMPC_CONVENTION  kmp_calloc  (size_t, size_t);
 201     extern void * __KAI_KMPC_CONVENTION  kmp_realloc (void *, size_t);
 202     extern void   __KAI_KMPC_CONVENTION  kmp_free    (void *);
 203
 204     extern void   __KAI_KMPC_CONVENTION  kmp_set_warnings_on(void);
 205     extern void   __KAI_KMPC_CONVENTION  kmp_set_warnings_off(void);
 206
 207     /* OpenMP 5.0 Tool Control */
 208     typedef enum omp_control_tool_result_t {
 209         omp_control_tool_notool = -2,
 210         omp_control_tool_nocallback = -1,
 211         omp_control_tool_success = 0,
 212         omp_control_tool_ignored = 1
 213     } omp_control_tool_result_t;
 214
 215     typedef enum omp_control_tool_t {
 216         omp_control_tool_start = 1,
 217         omp_control_tool_pause = 2,
 218         omp_control_tool_flush = 3,
 219         omp_control_tool_end = 4
 220     } omp_control_tool_t;
 221
 222     extern int __KAI_KMPC_CONVENTION omp_control_tool(int, int, void*);
 223
 224     /* OpenMP 5.0 Memory Management */
 225     typedef void *omp_allocator_t;
 226     extern __KMP_IMP const omp_allocator_t *OMP_NULL_ALLOCATOR;
 227     extern __KMP_IMP const omp_allocator_t *omp_default_mem_alloc;
 228     extern __KMP_IMP const omp_allocator_t *omp_large_cap_mem_alloc;
 229     extern __KMP_IMP const omp_allocator_t *omp_const_mem_alloc;
 230     extern __KMP_IMP const omp_allocator_t *omp_high_bw_mem_alloc;
 231     extern __KMP_IMP const omp_allocator_t *omp_low_lat_mem_alloc;
 232     extern __KMP_IMP const omp_allocator_t *omp_cgroup_mem_alloc;
 233     extern __KMP_IMP const omp_allocator_t *omp_pteam_mem_alloc;
 234     extern __KMP_IMP const omp_allocator_t *omp_thread_mem_alloc;
 235
 236     extern void __KAI_KMPC_CONVENTION omp_set_default_allocator(const omp_allocator_t *);
 237     extern const omp_allocator_t * __KAI_KMPC_CONVENTION omp_get_default_allocator(void);
 238 #ifdef __cplusplus
 239     extern void *__KAI_KMPC_CONVENTION omp_alloc(size_t size, const omp_allocator_t *allocator = OMP_NULL_ALLOCATOR);
 240     extern void __KAI_KMPC_CONVENTION omp_free(void * ptr, const omp_allocator_t *allocator = OMP_NULL_ALLOCATOR);
 241 #else
 242     extern void *__KAI_KMPC_CONVENTION omp_alloc(size_t size, const omp_allocator_t *allocator);
 243     extern void __KAI_KMPC_CONVENTION omp_free(void *ptr, const omp_allocator_t *allocator);
 244 #endif
 245
 246     /* OpenMP 5.0 Affinity Format */
 247     extern void __KAI_KMPC_CONVENTION omp_set_affinity_format(char const *);
 248     extern size_t __KAI_KMPC_CONVENTION omp_get_affinity_format(char *, size_t);
 249     extern void __KAI_KMPC_CONVENTION omp_display_affinity(char const *);
 250     extern size_t __KAI_KMPC_CONVENTION omp_capture_affinity(char *, size_t, char const *);
 251
 252 #   undef __KAI_KMPC_CONVENTION
 253 #   undef __KMP_IMP
 254
 255     /* Warning:
 256        The following typedefs are not standard, deprecated and will be removed in a future release.
 257     */
 258     typedef int     omp_int_t;
 259     typedef double  omp_wtime_t;
 260
 261 #   ifdef __cplusplus
 262     }
 263 #   endif
 264
 265 #endif /* __OMP_H */