libgomp/doc/openmp-runtime-library-routines.rst

   1 ..
   2   Copyright 1988-2022 Free Software Foundation, Inc.
   3   This is part of the GCC manual.
   4   For copying conditions, see the copyright.rst file.
   5
   6 .. _runtime-library-routines:
   7
   8 OpenMP Runtime Library Routines
   9 -------------------------------
  10
  11 The runtime routines described here are defined by Section 3 of the OpenMP
  12 specification in version 4.5.  The routines are structured in following
  13 three parts:
  14
  15 Control threads, processors and the parallel environment.  They have C
  16 linkage, and do not throw exceptions.
  17
  18 .. toctree::
  19   :maxdepth: 2
  20
  21   openmp-runtime-library-routines/ompgetactivelevel
  22   openmp-runtime-library-routines/ompgetancestorthreadnum
  23   openmp-runtime-library-routines/ompgetcancellation
  24   openmp-runtime-library-routines/ompgetdefaultdevice
  25   openmp-runtime-library-routines/ompgetdevicenum
  26   openmp-runtime-library-routines/ompgetdynamic
  27   openmp-runtime-library-routines/ompgetinitialdevice
  28   openmp-runtime-library-routines/ompgetlevel
  29   openmp-runtime-library-routines/ompgetmaxactivelevels
  30   openmp-runtime-library-routines/ompgetmaxtaskpriority
  31   openmp-runtime-library-routines/ompgetmaxteams
  32   openmp-runtime-library-routines/ompgetmaxthreads
  33   openmp-runtime-library-routines/ompgetnested
  34   openmp-runtime-library-routines/ompgetnumdevices
  35   openmp-runtime-library-routines/ompgetnumprocs
  36   openmp-runtime-library-routines/ompgetnumteams
  37   openmp-runtime-library-routines/ompgetnumthreads
  38   openmp-runtime-library-routines/ompgetprocbind
  39   openmp-runtime-library-routines/ompgetschedule
  40   openmp-runtime-library-routines/ompgetsupportedactivelevels
  41   openmp-runtime-library-routines/ompgetteamnum
  42   openmp-runtime-library-routines/ompgetteamsize
  43   openmp-runtime-library-routines/ompgetteamsthreadlimit
  44   openmp-runtime-library-routines/ompgetthreadlimit
  45   openmp-runtime-library-routines/ompgetthreadnum
  46   openmp-runtime-library-routines/ompinparallel
  47   openmp-runtime-library-routines/ompinfinal
  48   openmp-runtime-library-routines/ompisinitialdevice
  49   openmp-runtime-library-routines/ompsetdefaultdevice
  50   openmp-runtime-library-routines/ompsetdynamic
  51   openmp-runtime-library-routines/ompsetmaxactivelevels
  52   openmp-runtime-library-routines/ompsetnested
  53   openmp-runtime-library-routines/ompsetnumteams
  54   openmp-runtime-library-routines/ompsetnumthreads
  55   openmp-runtime-library-routines/ompsetschedule
  56   openmp-runtime-library-routines/ompsetteamsthreadlimit
  57
  58 Initialize, set, test, unset and destroy simple and nested locks.
  59
  60 .. toctree::
  61   :maxdepth: 2
  62
  63   openmp-runtime-library-routines/ompinitlock
  64   openmp-runtime-library-routines/ompsetlock
  65   openmp-runtime-library-routines/omptestlock
  66   openmp-runtime-library-routines/ompunsetlock
  67   openmp-runtime-library-routines/ompdestroylock
  68   openmp-runtime-library-routines/ompinitnestlock
  69   openmp-runtime-library-routines/ompsetnestlock
  70   openmp-runtime-library-routines/omptestnestlock
  71   openmp-runtime-library-routines/ompunsetnestlock
  72   openmp-runtime-library-routines/ompdestroynestlock
  73
  74 Portable, thread-based, wall clock timer.
  75
  76 .. toctree::
  77   :maxdepth: 2
  78
  79   openmp-runtime-library-routines/ompgetwtick
  80   openmp-runtime-library-routines/ompgetwtime
  81
  82 Support for event objects.
  83
  84 .. toctree::
  85   :maxdepth: 2
  86
  87   openmp-runtime-library-routines/ompfulfillevent