URL
https://opencores.org/ocsvn/openrisc/openrisc/trunk
Subversion Repositories openrisc
[/] [openrisc/] [trunk/] [gnu-old/] [gcc-4.2.2/] [libgomp/] [libgomp.info] - Rev 816
Compare with Previous | Blame | View Log
This is libgomp.info, produced by makeinfo version 4.8 from/scratch/mitchell/gcc-releases/gcc-4.2.2/gcc-4.2.2/libgomp/libgomp.texi.Copyright (C) 2006 Free Software Foundation, Inc.Permission is granted to copy, distribute and/or modify this documentunder the terms of the GNU Free Documentation License, Version 1.1 orany later version published by the Free Software Foundation; with theInvariant Sections being "GNU General Public License" and "Funding FreeSoftware", the Front-Cover texts being (a) (see below), and with theBack-Cover Texts being (b) (see below). A copy of the license isincluded in the section entitled "GNU Free Documentation License".(a) The FSF's Front-Cover Text is:A GNU Manual(b) The FSF's Back-Cover Text is:You have freedom to copy and modify this GNU Manual, like GNUsoftware. Copies published by the Free Software Foundation raisefunds for GNU development.INFO-DIR-SECTION GNU LibrariesSTART-INFO-DIR-ENTRY* libgomp: (libgomp). GNU OpenMP runtime libraryEND-INFO-DIR-ENTRYThis manual documents the GNU implementation of the OpenMP API formulti-platform shared-memory parallel programming in C/C++ and Fortran.Published by the Free Software Foundation 51 Franklin Street, FifthFloor Boston, MA 02110-1301 USACopyright (C) 2006 Free Software Foundation, Inc.Permission is granted to copy, distribute and/or modify this documentunder the terms of the GNU Free Documentation License, Version 1.1 orany later version published by the Free Software Foundation; with theInvariant Sections being "GNU General Public License" and "Funding FreeSoftware", the Front-Cover texts being (a) (see below), and with theBack-Cover Texts being (b) (see below). A copy of the license isincluded in the section entitled "GNU Free Documentation License".(a) The FSF's Front-Cover Text is:A GNU Manual(b) The FSF's Back-Cover Text is:You have freedom to copy and modify this GNU Manual, like GNUsoftware. Copies published by the Free Software Foundation raisefunds for GNU development.File: libgomp.info, Node: Top, Next: Enabling OpenMP, Up: (dir)Introduction************This manual documents the usage of libgomp, the GNU implementation ofthe OpenMP (http://www.openmp.org) Application Programming Interface(API) for multi-platform shared-memory parallel programming in C/C++and Fortran.* Menu:* Enabling OpenMP:: How to enable OpenMP for your applications.* Runtime Library Routines:: The OpenMP runtime application programminginterface.* Environment Variables:: Influencing runtime behavior with environmentvariables.* The libgomp ABI:: Notes on the external ABI presented by libgomp.* Reporting Bugs:: How to report bugs in GNU OpenMP.* Copying:: GNU general public license sayshow you can copy and share libgomp.* GNU Free Documentation License::How you can copy and share this manual.* Funding:: How to help assure continued work for freesoftware.* Index:: Index of this documentation.File: libgomp.info, Node: Enabling OpenMP, Next: Runtime Library Routines, Prev: Top, Up: Top1 Enabling OpenMP*****************To activate the OpenMP extensions for C/C++ and Fortran, thecompile-time flag `-fopenmp' must be specified. This enables the OpenMPdirective `#pragma omp' in C/C++ and `!$omp' directives in free form,`c$omp', `*$omp' and `!$omp' directives in fixed form, `!$' conditionalcompilation sentinels in free form and `c$', `*$' and `!$' sentinels infixed form, for Fortran. The flag also arranges for automatic linkingof the OpenMP runtime library (*Note Runtime Library Routines::).A complete description of all OpenMP directives accepted may befound in the OpenMP Application Program Interface(http://www.openmp.org) manual, version 2.5.File: libgomp.info, Node: Runtime Library Routines, Next: Environment Variables, Prev: Enabling OpenMP, Up: Top2 Runtime Library Routines**************************The runtime routines described here are defined by section 3 of theOpenMP specifications in version 2.5.Control threads, processors and the parallel environment.* Menu:* omp_get_dynamic:: Dynamic teams setting* omp_get_max_threads:: Maximum number of threads* omp_get_nested:: Nested parallel regions* omp_get_num_procs:: Number of processors online* omp_get_num_threads:: Size of the active team* omp_get_thread_num:: Current thread ID* omp_in_parallel:: Whether a parallel region is active* omp_set_dynamic:: Enable/disable dynamic teams* omp_set_nested:: Enable/disable nested parallel regions* omp_set_num_threads:: Set upper team size limitInitialize, set, test, unset and destroy simple and nested locks.* Menu:* omp_init_lock:: Initialize simple lock* omp_set_lock:: Wait for and set simple lock* omp_test_lock:: Test and set simple lock if available* omp_unset_lock:: Unset simple lock* omp_destroy_lock:: Destroy simple lock* omp_init_nest_lock:: Initialize nested lock* omp_set_nest_lock:: Wait for and set simple lock* omp_test_nest_lock:: Test and set nested lock if available* omp_unset_nest_lock:: Unset nested lock* omp_destroy_nest_lock:: Destroy nested lockPortable, thread-based, wall clock timer.* Menu:* omp_get_wtick:: Get timer precision.* omp_get_wtime:: Elapsed wall clock time.File: libgomp.info, Node: omp_get_dynamic, Next: omp_get_max_threads, Up: Runtime Library Routines2.1 `omp_get_dynamic' - Dynamic teams setting=============================================_Description_:This function returns `true' if enabled, `false' otherwise. Here,`true' and `false' represent their language-specific counterparts.The dynamic team setting may be initialized at startup by the`OMP_DYNAMIC' environment variable or at runtime using`omp_set_dynamic'. If undefined, dynamic adjustment is disabled bydefault._C/C++_:_Prototype_: `int omp_get_dynamic();'_Fortran_:_Interface_: `logical function omp_get_dynamic()'_See also_:*Note omp_set_dynamic::, *Note OMP_DYNAMIC::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.8.File: libgomp.info, Node: omp_get_max_threads, Next: omp_get_nested, Prev: omp_get_dynamic, Up: Runtime Library Routines2.2 `omp_get_max_threads' - Maximum number of threads=====================================================_Description_:Return the maximum number of threads used for parallel regionsthat do not use the clause `num_threads'._C/C++_:_Prototype_: `int omp_get_max_threads();'_Fortran_:_Interface_: `integer function omp_get_max_threads()'_See also_:*Note omp_set_num_threads::, *Note omp_set_dynamic::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.3.File: libgomp.info, Node: omp_get_nested, Next: omp_get_num_procs, Prev: omp_get_max_threads, Up: Runtime Library Routines2.3 `omp_get_nested' - Nested parallel regions==============================================_Description_:This function returns `true' if nested parallel regions areenabled, `false' otherwise. Here, `true' and `false' representtheir language-specific counterparts.Nested parallel regions may be initialized at startup by the`OMP_NESTED' environment variable or at runtime using`omp_set_nested'. If undefined, nested parallel regions aredisabled by default._C/C++_:_Prototype_: `int omp_get_nested();'_Fortran_:_Interface_: `integer function omp_get_nested()'_See also_:*Note omp_set_nested::, *Note OMP_NESTED::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section3.2.10.File: libgomp.info, Node: omp_get_num_procs, Next: omp_get_num_threads, Prev: omp_get_nested, Up: Runtime Library Routines2.4 `omp_get_num_procs' - Number of processors online=====================================================_Description_:Returns the number of processors online._C/C++_:_Prototype_: `int omp_get_num_procs();'_Fortran_:_Interface_: `integer function omp_get_num_procs()'_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.5.File: libgomp.info, Node: omp_get_num_threads, Next: omp_get_thread_num, Prev: omp_get_num_procs, Up: Runtime Library Routines2.5 `omp_get_num_threads' - Size of the active team===================================================_Description_:The number of threads in the current team. In a sequential sectionof the program `omp_get_num_threads' returns 1.The default team size may be initialized at startup by the`OMP_NUM_THREADS' environment variable. At runtime, the size ofthe current team may be set either by the `NUM_THREADS' clause orby `omp_set_num_threads'. If none of the above were used to definea specific value and `OMP_DYNAMIC' is disabled, one thread per CPUonline is used._C/C++_:_Prototype_: `int omp_get_num_threads();'_Fortran_:_Interface_: `integer function omp_get_num_threads()'_See also_:*Note omp_get_max_threads::, *Note omp_set_num_threads::, *NoteOMP_NUM_THREADS::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.2.File: libgomp.info, Node: omp_get_thread_num, Next: omp_in_parallel, Prev: omp_get_num_threads, Up: Runtime Library Routines2.6 `omp_get_thread_num' - Current thread ID============================================_Description_:Unique thread identification number. In a sequential parts of theprogram, `omp_get_thread_num' always returns 0. In parallelregions the return value varies from 0 to `omp_get_max_threads'-1inclusive. The return value of the master thread of a team isalways 0._C/C++_:_Prototype_: `int omp_get_thread_num();'_Fortran_:_Interface_: `integer function omp_get_thread_num()'_See also_:*Note omp_get_max_threads::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.4.File: libgomp.info, Node: omp_in_parallel, Next: omp_set_dynamic, Prev: omp_get_thread_num, Up: Runtime Library Routines2.7 `omp_in_parallel' - Whether a parallel region is active===========================================================_Description_:This function returns `true' if currently running in parallel,`false' otherwise. Here, `true' and `false' represent theirlanguage-specific counterparts._C/C++_:_Prototype_: `int omp_in_parallel();'_Fortran_:_Interface_: `logical function omp_in_parallel()'_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.6.File: libgomp.info, Node: omp_set_dynamic, Next: omp_set_nested, Prev: omp_in_parallel, Up: Runtime Library Routines2.8 `omp_set_dynamic' - Enable/disable dynamic teams====================================================_Description_:Enable or disable the dynamic adjustment of the number of threadswithin a team. The function takes the language-specific equivalentof `true' and `false', where `true' enables dynamic adjustment ofteam sizes and `false' disables it._C/C++_:_Prototype_: `void omp_set_dynamic(int);'_Fortran_:_Interface_: `subroutine omp_set_dynamic(set)'`integer, intent(in) :: set'_See also_:*Note OMP_DYNAMIC::, *Note omp_get_dynamic::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.7.File: libgomp.info, Node: omp_set_nested, Next: omp_set_num_threads, Prev: omp_set_dynamic, Up: Runtime Library Routines2.9 `omp_set_nested' - Enable/disable nested parallel regions=============================================================_Description_:Enable or disable nested parallel regions, i.e., whether teammembers are allowed to create new teams. The function takes thelanguage-specific equivalent of `true' and `false', where `true'enables dynamic adjustment of team sizes and `false' disables it._C/C++_:_Prototype_: `void omp_set_dynamic(int);'_Fortran_:_Interface_: `subroutine omp_set_dynamic(set)'`integer, intent(in) :: set'_See also_:*Note OMP_NESTED::, *Note omp_get_nested::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.9.File: libgomp.info, Node: omp_set_num_threads, Next: omp_init_lock, Prev: omp_set_nested, Up: Runtime Library Routines2.10 `omp_set_num_threads' - Set upper team size limit======================================================_Description_:Specifies the number of threads used by default in subsequentparallel sections, if those do not specify a `num_threads' clause.The argument of `omp_set_num_threads' shall be a positive integer._C/C++_:_Prototype_: `void omp_set_num_threads(int);'_Fortran_:_Interface_: `subroutine omp_set_num_threads(set)'`integer, intent(in) :: set'_See also_:*Note OMP_NUM_THREADS::, *Note omp_get_num_threads::, *Noteomp_get_max_threads::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.1.File: libgomp.info, Node: omp_init_lock, Next: omp_set_lock, Prev: omp_set_num_threads, Up: Runtime Library Routines2.11 `omp_init_lock' - Initialize simple lock=============================================_Description_:Initialize a simple lock. After initialization, the lock is in anunlocked state._C/C++_:_Prototype_: `void omp_init_lock(omp_lock_t *lock);'_Fortran_:_Interface_: `subroutine omp_init_lock(lock)'`integer(omp_lock_kind), intent(out) :: lock'_See also_:*Note omp_destroy_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.1.File: libgomp.info, Node: omp_set_lock, Next: omp_test_lock, Prev: omp_init_lock, Up: Runtime Library Routines2.12 `omp_set_lock' - Wait for and set simple lock==================================================_Description_:Before setting a simple lock, the lock variable must beinitialized by `omp_init_lock'. The calling thread is blockeduntil the lock is available. If the lock is already held by thecurrent thread, a deadlock occurs._C/C++_:_Prototype_: `void omp_set_lock(omp_lock_t *lock);'_Fortran_:_Interface_: `subroutine omp_set_lock(lock)'`integer(omp_lock_kind), intent(out) :: lock'_See also_:*Note omp_init_lock::, *Note omp_test_lock::, *Noteomp_unset_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.3.File: libgomp.info, Node: omp_test_lock, Next: omp_unset_lock, Prev: omp_set_lock, Up: Runtime Library Routines2.13 `omp_test_lock' - Test and set simple lock if available============================================================_Description_:Before setting a simple lock, the lock variable must beinitialized by `omp_init_lock'. Contrary to `omp_set_lock',`omp_test_lock' does not block if the lock is not available. Thisfunction returns `true' upon success,`false' otherwise. Here,`true' and `false' represent their language-specific counterparts._C/C++_:_Prototype_: `int omp_test_lock(omp_lock_t *lock);'_Fortran_:_Interface_: `subroutine omp_test_lock(lock)'`logical(omp_logical_kind) :: omp_test_lock'`integer(omp_lock_kind), intent(out) :: lock'_See also_:*Note omp_init_lock::, *Note omp_set_lock::, *Note omp_set_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.5.File: libgomp.info, Node: omp_unset_lock, Next: omp_destroy_lock, Prev: omp_test_lock, Up: Runtime Library Routines2.14 `omp_unset_lock' - Unset simple lock=========================================_Description_:A simple lock about to be unset must have been locked by`omp_set_lock' or `omp_test_lock' before. In addition, the lockmust be held by the thread calling `omp_unset_lock'. Then, thelock becomes unlocked. If one ore more threads attempted to setthe lock before, one of them is chosen to, again, set the lock foritself._C/C++_:_Prototype_: `void omp_unset_lock(omp_lock_t *lock);'_Fortran_:_Interface_: `subroutine omp_unset_lock(lock)'`integer(omp_lock_kind), intent(out) :: lock'_See also_:*Note omp_set_lock::, *Note omp_test_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.4.File: libgomp.info, Node: omp_destroy_lock, Next: omp_init_nest_lock, Prev: omp_unset_lock, Up: Runtime Library Routines2.15 `omp_destroy_lock' - Destroy simple lock=============================================_Description_:Destroy a simple lock. In order to be destroyed, a simple lockmust be in the unlocked state._C/C++_:_Prototype_: `void omp_destroy_lock(omp_lock_t *);'_Fortran_:_Interface_: `subroutine omp_destroy_lock(lock)'`integer(omp_lock_kind), intent(inout) :: lock'_See also_:*Note omp_init_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.2.File: libgomp.info, Node: omp_init_nest_lock, Next: omp_set_nest_lock, Prev: omp_destroy_lock, Up: Runtime Library Routines2.16 `omp_init_nest_lock' - Initialize nested lock==================================================_Description_:Initialize a nested lock. After initialization, the lock is in anunlocked state and the nesting count is set to zero._C/C++_:_Prototype_: `void omp_init_nest_lock(omp_nest_lock_t *lock);'_Fortran_:_Interface_: `subroutine omp_init_nest_lock(lock)'`integer(omp_nest_lock_kind), intent(out) :: lock'_See also_:*Note omp_destroy_nest_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.1.File: libgomp.info, Node: omp_set_nest_lock, Next: omp_test_nest_lock, Prev: omp_init_nest_lock, Up: Runtime Library Routines2.17 `omp_set_nest_lock' - Wait for and set simple lock=======================================================_Description_:Before setting a nested lock, the lock variable must beinitialized by `omp_init_nest_lock'. The calling thread is blockeduntil the lock is available. If the lock is already held by thecurrent thread, the nesting count for the lock in incremented._C/C++_:_Prototype_: `void omp_set_nest_lock(omp_nest_lock_t *lock);'_Fortran_:_Interface_: `subroutine omp_set_nest_lock(lock)'`integer(omp_nest_lock_kind), intent(out) :: lock'_See also_:*Note omp_init_nest_lock::, *Note omp_unset_nest_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.3.File: libgomp.info, Node: omp_test_nest_lock, Next: omp_unset_nest_lock, Prev: omp_set_nest_lock, Up: Runtime Library Routines2.18 `omp_test_nest_lock' - Test and set nested lock if available=================================================================_Description_:Before setting a nested lock, the lock variable must beinitialized by `omp_init_nest_lock'. Contrary to`omp_set_nest_lock', `omp_test_nest_lock' does not block if thelock is not available. If the lock is already held by the currentthread, the new nesting count is returned. Otherwise, the returnvalue equals zero._C/C++_:_Prototype_: `int omp_test_nest_lock(omp_nest_lock_t *lock);'_Fortran_:_Interface_: `integer function omp_test_nest_lock(lock)'`integer(omp_integer_kind) :: omp_test_nest_lock'`integer(omp_nest_lock_kind), intent(inout) :: lock'_See also_:*Note omp_init_lock::, *Note omp_set_lock::, *Note omp_set_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.5.File: libgomp.info, Node: omp_unset_nest_lock, Next: omp_destroy_nest_lock, Prev: omp_test_nest_lock, Up: Runtime Library Routines2.19 `omp_unset_nest_lock' - Unset nested lock==============================================_Description_:A nested lock about to be unset must have been locked by`omp_set_nested_lock' or `omp_test_nested_lock' before. Inaddition, the lock must be held by the thread calling`omp_unset_nested_lock'. If the nesting count drops to zero, thelock becomes unlocked. If one ore more threads attempted to setthe lock before, one of them is chosen to, again, set the lock foritself._C/C++_:_Prototype_: `void omp_unset_nest_lock(omp_nest_lock_t *lock);'_Fortran_:_Interface_: `subroutine omp_unset_nest_lock(lock)'`integer(omp_nest_lock_kind), intent(out) :: lock'_See also_:*Note omp_set_nest_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.4.File: libgomp.info, Node: omp_destroy_nest_lock, Next: omp_get_wtick, Prev: omp_unset_nest_lock, Up: Runtime Library Routines2.20 `omp_destroy_nest_lock' - Destroy nested lock==================================================_Description_:Destroy a nested lock. In order to be destroyed, a nested lockmust be in the unlocked state and its nesting count must equalzero._C/C++_:_Prototype_: `void omp_destroy_nest_lock(omp_nest_lock_t *);'_Fortran_:_Interface_: `subroutine omp_destroy_nest_lock(lock)'`integer(omp_nest_lock_kind), intent(inout) :: lock'_See also_:*Note omp_init_lock::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.2.File: libgomp.info, Node: omp_get_wtick, Next: omp_get_wtime, Prev: omp_destroy_nest_lock, Up: Runtime Library Routines2.21 `omp_get_wtick' - Get timer precision==========================================_Description_:Gets the timer precision, i.e., the number of seconds between twosuccessive clock ticks._C/C++_:_Prototype_: `double omp_get_wtick();'_Fortran_:_Interface_: `double precision function omp_get_wtick()'_See also_:*Note omp_get_wtime::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.4.2.File: libgomp.info, Node: omp_get_wtime, Prev: omp_get_wtick, Up: Runtime Library Routines2.22 `omp_get_wtime' - Elapsed wall clock time==============================================_Description_:Elapsed wall clock time in seconds. The time is measured perthread, no guarantee can bee made that two distinct threadsmeasure the same time. Time is measured from some "time in thepast". On POSIX compliant systems the seconds since the Epoch(00:00:00 UTC, January 1, 1970) are returned._C/C++_:_Prototype_: `double omp_get_wtime();'_Fortran_:_Interface_: `double precision function omp_get_wtime()'_See also_:*Note omp_get_wtick::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 3.4.1.File: libgomp.info, Node: Environment Variables, Next: The libgomp ABI, Prev: Runtime Library Routines, Up: Top3 Environment Variables***********************The variables `OMP_DYNAMIC', `OMP_NESTED', `OMP_NUM_THREADS' and`OMP_SCHEDULE' are defined by section 4 of the OpenMP specifications inversion 2.5, while `GOMP_CPU_AFFINITY' and `GOMP_STACKSIZE' are GNUextensions.* Menu:* OMP_DYNAMIC:: Dynamic adjustment of threads* OMP_NESTED:: Nested parallel regions* OMP_NUM_THREADS:: Specifies the number of threads to use* OMP_SCHEDULE:: How threads are scheduled* GOMP_CPU_AFFINITY:: Bind threads to specific CPUs* GOMP_STACKSIZE:: Set default thread stack sizeFile: libgomp.info, Node: OMP_DYNAMIC, Next: OMP_NESTED, Up: Environment Variables3.1 `OMP_DYNAMIC' - Dynamic adjustment of threads=================================================_Description_:Enable or disable the dynamic adjustment of the number of threadswithin a team. The value of this environment variable shall be`TRUE' or `FALSE'. If undefined, dynamic adjustment is disabled bydefault._See also_:*Note omp_set_dynamic::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 4.3File: libgomp.info, Node: OMP_NESTED, Next: OMP_NUM_THREADS, Prev: OMP_DYNAMIC, Up: Environment Variables3.2 `OMP_NESTED' - Nested parallel regions==========================================_Description_:Enable or disable nested parallel regions, i.e., whether teammembers are allowed to create new teams. The value of thisenvironment variable shall be `TRUE' or `FALSE'. If undefined,nested parallel regions are disabled by default._See also_:*Note omp_set_nested::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 4.4File: libgomp.info, Node: OMP_NUM_THREADS, Next: OMP_SCHEDULE, Prev: OMP_NESTED, Up: Environment Variables3.3 `OMP_NUM_THREADS' - Specifies the number of threads to use==============================================================_Description_:Specifies the default number of threads to use in parallelregions. The value of this variable shall be positive integer. Ifundefined one thread per CPU online is used._See also_:*Note omp_set_num_threads::_Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), section 4.2File: libgomp.info, Node: OMP_SCHEDULE, Next: GOMP_CPU_AFFINITY, Prev: OMP_NUM_THREADS, Up: Environment Variables3.4 `OMP_SCHEDULE' - How threads are scheduled==============================================_Description_:Allows to specify `schedule type' and `chunk size'. The value ofthe variable shall have the form: `type[,chunk]' where `type' isone of `static', `dynamic' or `guided'. The optional `chunk size'shall be a positive integer. If undefined, dynamic scheduling anda chunk size of 1 is used._Reference_:OpenMP specifications v2.5 (http://www.openmp.org/), sections2.5.1 and 4.1File: libgomp.info, Node: GOMP_CPU_AFFINITY, Next: GOMP_STACKSIZE, Prev: OMP_SCHEDULE, Up: Environment Variables3.5 `GOMP_CPU_AFFINITY' - Bind threads to specific CPUs=======================================================_Description_:A patch for this extension has been submitted, but was not yetapplied at the time of writing._Reference_:GCC Patches Mailinglist(http://gcc.gnu.org/ml/gcc-patches/2006-05/msg00982.html) GCCPatches Mailinglist(http://gcc.gnu.org/ml/gcc-patches/2006-05/msg01133.html)File: libgomp.info, Node: GOMP_STACKSIZE, Prev: GOMP_CPU_AFFINITY, Up: Environment Variables3.6 `GOMP_STACKSIZE' - Set default thread stack size====================================================_Description_:Set the default thread stack size in kilobytes. This is inopposition to `pthread_attr_setstacksize' which gets the number ofbytes as an argument. If the stacksize can not be set due tosystem constraints, an error is reported and the initial stacksizeis left unchanged. If undefined, the stack size is systemdependent._Reference_:GCC Patches Mailinglist(http://gcc.gnu.org/ml/gcc-patches/2006-06/msg00493.html), GCCPatches Mailinglist(http://gcc.gnu.org/ml/gcc-patches/2006-06/msg00496.html)File: libgomp.info, Node: The libgomp ABI, Next: Reporting Bugs, Prev: Environment Variables, Up: Top4 The libgomp ABI*****************The following sections present notes on the external ABI as presentedby libgomp. Only maintainers should need them.* Menu:* Implementing MASTER construct::* Implementing CRITICAL construct::* Implementing ATOMIC construct::* Implementing FLUSH construct::* Implementing BARRIER construct::* Implementing THREADPRIVATE construct::* Implementing PRIVATE clause::* Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses::* Implementing REDUCTION clause::* Implementing PARALLEL construct::* Implementing FOR construct::* Implementing ORDERED construct::* Implementing SECTIONS construct::* Implementing SINGLE construct::File: libgomp.info, Node: Implementing MASTER construct, Next: Implementing CRITICAL construct, Up: The libgomp ABI4.1 Implementing MASTER construct=================================if (omp_get_thread_num () == 0)blockAlternately, we generate two copies of the parallel subfunction andonly include this in the version run by the master thread. Surelythat's not worthwhile though...File: libgomp.info, Node: Implementing CRITICAL construct, Next: Implementing ATOMIC construct, Prev: Implementing MASTER construct, Up: The libgomp ABI4.2 Implementing CRITICAL construct===================================Without a specified name,void GOMP_critical_start (void);void GOMP_critical_end (void);so that we don't get COPY relocations from libgomp to the mainapplication.With a specified name, use omp_set_lock and omp_unset_lock with namebeing transformed into a variable declared likeomp_lock_t gomp_critical_user_<name> __attribute__((common))Ideally the ABI would specify that all zero is a valid unlockedstate, and so we wouldn't actually need to initialize this at startup.File: libgomp.info, Node: Implementing ATOMIC construct, Next: Implementing FLUSH construct, Prev: Implementing CRITICAL construct, Up: The libgomp ABI4.3 Implementing ATOMIC construct=================================The target should implement the `__sync' builtins.Failing that we could addvoid GOMP_atomic_enter (void)void GOMP_atomic_exit (void)which reuses the regular lock code, but with yet another lock objectprivate to the library.File: libgomp.info, Node: Implementing FLUSH construct, Next: Implementing BARRIER construct, Prev: Implementing ATOMIC construct, Up: The libgomp ABI4.4 Implementing FLUSH construct================================Expands to the `__sync_synchronize' builtin.File: libgomp.info, Node: Implementing BARRIER construct, Next: Implementing THREADPRIVATE construct, Prev: Implementing FLUSH construct, Up: The libgomp ABI4.5 Implementing BARRIER construct==================================void GOMP_barrier (void)File: libgomp.info, Node: Implementing THREADPRIVATE construct, Next: Implementing PRIVATE clause, Prev: Implementing BARRIER construct, Up: The libgomp ABI4.6 Implementing THREADPRIVATE construct========================================In _most_ cases we can map this directly to `__thread'. Except thatOMP allows constructors for C++ objects. We can either refuse tosupport this (how often is it used?) or we can implement something akinto .ctors.Even more ideally, this ctor feature is handled by extensions to themain pthreads library. Failing that, we can have a set of entry pointsto register ctor functions to be called.File: libgomp.info, Node: Implementing PRIVATE clause, Next: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Prev: Implementing THREADPRIVATE construct, Up: The libgomp ABI4.7 Implementing PRIVATE clause===============================In association with a PARALLEL, or within the lexical extent of aPARALLEL block, the variable becomes a local variable in the parallelsubfunction.In association with FOR or SECTIONS blocks, create a new automaticvariable within the current function. This preserves the semantic ofnew variable creation.File: libgomp.info, Node: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Next: Implementing REDUCTION clause, Prev: Implementing PRIVATE clause, Up: The libgomp ABI4.8 Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses========================================================================Seems simple enough for PARALLEL blocks. Create a private struct forcommunicating between parent and subfunction. In the parent, copy invalues for scalar and "small" structs; copy in addresses for othersTREE_ADDRESSABLE types. In the subfunction, copy the value into thelocal variable.Not clear at all what to do with bare FOR or SECTION blocks. Theonly thing I can figure is that we do something like#pragma omp for firstprivate(x) lastprivate(y)for (int i = 0; i < n; ++i)body;which becomes{int x = x, y;// for stuffif (i == n)y = y;}where the "x=x" and "y=y" assignments actually have different uidsfor the two variables, i.e. not something you could write directly inC. Presumably this only makes sense if the "outer" x and y are globalvariables.COPYPRIVATE would work the same way, except the structure broadcastwould have to happen via SINGLE machinery instead.File: libgomp.info, Node: Implementing REDUCTION clause, Next: Implementing PARALLEL construct, Prev: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Up: The libgomp ABI4.9 Implementing REDUCTION clause=================================The private struct mentioned in the previous section should have apointer to an array of the type of the variable, indexed by thethread's TEAM_ID. The thread stores its final value into the array,and after the barrier the master thread iterates over the array tocollect the values.File: libgomp.info, Node: Implementing PARALLEL construct, Next: Implementing FOR construct, Prev: Implementing REDUCTION clause, Up: The libgomp ABI4.10 Implementing PARALLEL construct====================================#pragma omp parallel{body;}becomesvoid subfunction (void *data){use data;body;}setup data;GOMP_parallel_start (subfunction, &data, num_threads);subfunction (&data);GOMP_parallel_end ();void GOMP_parallel_start (void (*fn)(void *), void *data, unsigned num_threads)The FN argument is the subfunction to be run in parallel.The DATA argument is a pointer to a structure used to communicatedata in and out of the subfunction, as discussed above with respect toFIRSTPRIVATE et al.The NUM_THREADS argument is 1 if an IF clause is present and false,or the value of the NUM_THREADS clause, if present, or 0.The function needs to create the appropriate number of threadsand/or launch them from the dock. It needs to create the teamstructure and assign team ids.void GOMP_parallel_end (void)Tears down the team and returns us to the previous`omp_in_parallel()' state.File: libgomp.info, Node: Implementing FOR construct, Next: Implementing ORDERED construct, Prev: Implementing PARALLEL construct, Up: The libgomp ABI4.11 Implementing FOR construct===============================#pragma omp parallel forfor (i = lb; i <= ub; i++)body;becomesvoid subfunction (void *data){long _s0, _e0;while (GOMP_loop_static_next (&_s0, &_e0)){long _e1 = _e0, i;for (i = _s0; i < _e1; i++)body;}GOMP_loop_end_nowait ();}GOMP_parallel_loop_static (subfunction, NULL, 0, lb, ub+1, 1, 0);subfunction (NULL);GOMP_parallel_end ();#pragma omp for schedule(runtime)for (i = 0; i < n; i++)body;becomes{long i, _s0, _e0;if (GOMP_loop_runtime_start (0, n, 1, &_s0, &_e0))do {long _e1 = _e0;for (i = _s0, i < _e0; i++)body;} while (GOMP_loop_runtime_next (&_s0, _&e0));GOMP_loop_end ();}Note that while it looks like there is trickyness to propagating anon-constant STEP, there isn't really. We're explicitly allowed toevaluate it as many times as we want, and any variables involved shouldautomatically be handled as PRIVATE or SHARED like any other variables.So the expression should remain evaluable in the subfunction. We canalso pull it into a local variable if we like, but since its supposedto remain unchanged, we can also not if we like.If we have SCHEDULE(STATIC), and no ORDERED, then we ought to beable to get away with no work-sharing context at all, since we cansimply perform the arithmetic directly in each thread to divide up theiterations. Which would mean that we wouldn't need to call any ofthese routines.There are separate routines for handling loops with an ORDEREDclause. Bookkeeping for that is non-trivial...File: libgomp.info, Node: Implementing ORDERED construct, Next: Implementing SECTIONS construct, Prev: Implementing FOR construct, Up: The libgomp ABI4.12 Implementing ORDERED construct===================================void GOMP_ordered_start (void)void GOMP_ordered_end (void)File: libgomp.info, Node: Implementing SECTIONS construct, Next: Implementing SINGLE construct, Prev: Implementing ORDERED construct, Up: The libgomp ABI4.13 Implementing SECTIONS construct====================================A block as#pragma omp sections{#pragma omp sectionstmt1;#pragma omp sectionstmt2;#pragma omp sectionstmt3;}becomesfor (i = GOMP_sections_start (3); i != 0; i = GOMP_sections_next ())switch (i){case 1:stmt1;break;case 2:stmt2;break;case 3:stmt3;break;}GOMP_barrier ();File: libgomp.info, Node: Implementing SINGLE construct, Prev: Implementing SECTIONS construct, Up: The libgomp ABI4.14 Implementing SINGLE construct==================================A block like#pragma omp single{body;}becomesif (GOMP_single_start ())body;GOMP_barrier ();while#pragma omp single copyprivate(x)body;becomesdatap = GOMP_single_copy_start ();if (datap == NULL){body;data.x = x;GOMP_single_copy_end (&data);}elsex = datap->x;GOMP_barrier ();File: libgomp.info, Node: Reporting Bugs, Next: Copying, Prev: The libgomp ABI, Up: Top5 Reporting Bugs****************Bugs in the GNU OpenMP implementation should be reported via bugzilla(http://gcc.gnu.org/bugzilla/). In all cases, please add "openmp" tothe keywords field in the bug report.File: libgomp.info, Node: Copying, Next: GNU Free Documentation License, Prev: Reporting Bugs, Up: TopGNU GENERAL PUBLIC LICENSE**************************Version 2, June 1991Copyright (C) 1989, 1991 Free Software Foundation, Inc.51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USAEveryone is permitted to copy and distribute verbatim copiesof this license document, but changing it is not allowed.Preamble========The licenses for most software are designed to take away your freedomto share and change it. By contrast, the GNU General Public License isintended to guarantee your freedom to share and change freesoftware--to make sure the software is free for all its users. ThisGeneral Public License applies to most of the Free SoftwareFoundation's software and to any other program whose authors commit tousing it. (Some other Free Software Foundation software is covered bythe GNU Library General Public License instead.) You can apply it toyour programs, too.When we speak of free software, we are referring to freedom, notprice. Our General Public Licenses are designed to make sure that youhave the freedom to distribute copies of free software (and charge forthis service if you wish), that you receive source code or can get itif you want it, that you can change the software or use pieces of it innew free programs; and that you know you can do these things.To protect your rights, we need to make restrictions that forbidanyone to deny you these rights or to ask you to surrender the rights.These restrictions translate to certain responsibilities for you if youdistribute copies of the software, or if you modify it.For example, if you distribute copies of such a program, whethergratis or for a fee, you must give the recipients all the rights thatyou have. You must make sure that they, too, receive or can get thesource code. And you must show them these terms so they know theirrights.We protect your rights with two steps: (1) copyright the software,and (2) offer you this license which gives you legal permission to copy,distribute and/or modify the software.Also, for each author's protection and ours, we want to make certainthat everyone understands that there is no warranty for this freesoftware. If the software is modified by someone else and passed on, wewant its recipients to know that what they have is not the original, sothat any problems introduced by others will not reflect on the originalauthors' reputations.Finally, any free program is threatened constantly by softwarepatents. We wish to avoid the danger that redistributors of a freeprogram will individually obtain patent licenses, in effect making theprogram proprietary. To prevent this, we have made it clear that anypatent must be licensed for everyone's free use or not licensed at all.The precise terms and conditions for copying, distribution andmodification follow.TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION0. This License applies to any program or other work which contains anotice placed by the copyright holder saying it may be distributedunder the terms of this General Public License. The "Program",below, refers to any such program or work, and a "work based onthe Program" means either the Program or any derivative work undercopyright law: that is to say, a work containing the Program or aportion of it, either verbatim or with modifications and/ortranslated into another language. (Hereinafter, translation isincluded without limitation in the term "modification".) Eachlicensee is addressed as "you".Activities other than copying, distribution and modification arenot covered by this License; they are outside its scope. The actof running the Program is not restricted, and the output from theProgram is covered only if its contents constitute a work based onthe Program (independent of having been made by running theProgram). Whether that is true depends on what the Program does.1. You may copy and distribute verbatim copies of the Program'ssource code as you receive it, in any medium, provided that youconspicuously and appropriately publish on each copy an appropriatecopyright notice and disclaimer of warranty; keep intact all thenotices that refer to this License and to the absence of anywarranty; and give any other recipients of the Program a copy ofthis License along with the Program.You may charge a fee for the physical act of transferring a copy,and you may at your option offer warranty protection in exchangefor a fee.2. You may modify your copy or copies of the Program or any portionof it, thus forming a work based on the Program, and copy anddistribute such modifications or work under the terms of Section 1above, provided that you also meet all of these conditions:a. You must cause the modified files to carry prominent noticesstating that you changed the files and the date of any change.b. You must cause any work that you distribute or publish, thatin whole or in part contains or is derived from the Programor any part thereof, to be licensed as a whole at no chargeto all third parties under the terms of this License.c. If the modified program normally reads commands interactivelywhen run, you must cause it, when started running for suchinteractive use in the most ordinary way, to print or displayan announcement including an appropriate copyright notice anda notice that there is no warranty (or else, saying that youprovide a warranty) and that users may redistribute theprogram under these conditions, and telling the user how toview a copy of this License. (Exception: if the Programitself is interactive but does not normally print such anannouncement, your work based on the Program is not requiredto print an announcement.)These requirements apply to the modified work as a whole. Ifidentifiable sections of that work are not derived from theProgram, and can be reasonably considered independent and separateworks in themselves, then this License, and its terms, do notapply to those sections when you distribute them as separateworks. But when you distribute the same sections as part of awhole which is a work based on the Program, the distribution ofthe whole must be on the terms of this License, whose permissionsfor other licensees extend to the entire whole, and thus to eachand every part regardless of who wrote it.Thus, it is not the intent of this section to claim rights orcontest your rights to work written entirely by you; rather, theintent is to exercise the right to control the distribution ofderivative or collective works based on the Program.In addition, mere aggregation of another work not based on theProgram with the Program (or with a work based on the Program) ona volume of a storage or distribution medium does not bring theother work under the scope of this License.3. You may copy and distribute the Program (or a work based on it,under Section 2) in object code or executable form under the termsof Sections 1 and 2 above provided that you also do one of thefollowing:a. Accompany it with the complete corresponding machine-readablesource code, which must be distributed under the terms ofSections 1 and 2 above on a medium customarily used forsoftware interchange; or,b. Accompany it with a written offer, valid for at least threeyears, to give any third party, for a charge no more than yourcost of physically performing source distribution, a completemachine-readable copy of the corresponding source code, to bedistributed under the terms of Sections 1 and 2 above on amedium customarily used for software interchange; or,c. Accompany it with the information you received as to the offerto distribute corresponding source code. (This alternative isallowed only for noncommercial distribution and only if youreceived the program in object code or executable form withsuch an offer, in accord with Subsection b above.)The source code for a work means the preferred form of the work formaking modifications to it. For an executable work, completesource code means all the source code for all modules it contains,plus any associated interface definition files, plus the scriptsused to control compilation and installation of the executable.However, as a special exception, the source code distributed neednot include anything that is normally distributed (in eithersource or binary form) with the major components (compiler,kernel, and so on) of the operating system on which the executableruns, unless that component itself accompanies the executable.If distribution of executable or object code is made by offeringaccess to copy from a designated place, then offering equivalentaccess to copy the source code from the same place counts asdistribution of the source code, even though third parties are notcompelled to copy the source along with the object code.4. You may not copy, modify, sublicense, or distribute the Programexcept as expressly provided under this License. Any attemptotherwise to copy, modify, sublicense or distribute the Program isvoid, and will automatically terminate your rights under thisLicense. However, parties who have received copies, or rights,from you under this License will not have their licensesterminated so long as such parties remain in full compliance.5. You are not required to accept this License, since you have notsigned it. However, nothing else grants you permission to modifyor distribute the Program or its derivative works. These actionsare prohibited by law if you do not accept this License.Therefore, by modifying or distributing the Program (or any workbased on the Program), you indicate your acceptance of thisLicense to do so, and all its terms and conditions for copying,distributing or modifying the Program or works based on it.6. Each time you redistribute the Program (or any work based on theProgram), the recipient automatically receives a license from theoriginal licensor to copy, distribute or modify the Programsubject to these terms and conditions. You may not impose anyfurther restrictions on the recipients' exercise of the rightsgranted herein. You are not responsible for enforcing complianceby third parties to this License.7. If, as a consequence of a court judgment or allegation of patentinfringement or for any other reason (not limited to patentissues), conditions are imposed on you (whether by court order,agreement or otherwise) that contradict the conditions of thisLicense, they do not excuse you from the conditions of thisLicense. If you cannot distribute so as to satisfy simultaneouslyyour obligations under this License and any other pertinentobligations, then as a consequence you may not distribute theProgram at all. For example, if a patent license would not permitroyalty-free redistribution of the Program by all those whoreceive copies directly or indirectly through you, then the onlyway you could satisfy both it and this License would be to refrainentirely from distribution of the Program.If any portion of this section is held invalid or unenforceableunder any particular circumstance, the balance of the section isintended to apply and the section as a whole is intended to applyin other circumstances.It is not the purpose of this section to induce you to infringe anypatents or other property right claims or to contest validity ofany such claims; this section has the sole purpose of protectingthe integrity of the free software distribution system, which isimplemented by public license practices. Many people have madegenerous contributions to the wide range of software distributedthrough that system in reliance on consistent application of thatsystem; it is up to the author/donor to decide if he or she iswilling to distribute software through any other system and alicensee cannot impose that choice.This section is intended to make thoroughly clear what is believedto be a consequence of the rest of this License.8. If the distribution and/or use of the Program is restricted incertain countries either by patents or by copyrighted interfaces,the original copyright holder who places the Program under thisLicense may add an explicit geographical distribution limitationexcluding those countries, so that distribution is permitted onlyin or among countries not thus excluded. In such case, thisLicense incorporates the limitation as if written in the body ofthis License.9. The Free Software Foundation may publish revised and/or newversions of the General Public License from time to time. Suchnew versions will be similar in spirit to the present version, butmay differ in detail to address new problems or concerns.Each version is given a distinguishing version number. If theProgram specifies a version number of this License which appliesto it and "any later version", you have the option of followingthe terms and conditions either of that version or of any laterversion published by the Free Software Foundation. If the Programdoes not specify a version number of this License, you may chooseany version ever published by the Free Software Foundation.10. If you wish to incorporate parts of the Program into other freeprograms whose distribution conditions are different, write to theauthor to ask for permission. For software which is copyrightedby the Free Software Foundation, write to the Free SoftwareFoundation; we sometimes make exceptions for this. Our decisionwill be guided by the two goals of preserving the free status ofall derivatives of our free software and of promoting the sharingand reuse of software generally.NO WARRANTY11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NOWARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLELAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHTHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUTWARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUTNOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY ANDFITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THEQUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THEPROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARYSERVICING, REPAIR OR CORRECTION.12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO INWRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAYMODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BELIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE ORINABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OFDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOUOR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANYOTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEENADVISED OF THE POSSIBILITY OF SUCH DAMAGES.END OF TERMS AND CONDITIONSAppendix: How to Apply These Terms to Your New Programs=======================================================If you develop a new program, and you want it to be of the greatestpossible use to the public, the best way to achieve this is to make itfree software which everyone can redistribute and change under theseterms.To do so, attach the following notices to the program. It is safestto attach them to the start of each source file to most effectivelyconvey the exclusion of warranty; and each file should have at leastthe "copyright" line and a pointer to where the full notice is found.ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.Copyright (C) YEAR NAME OF AUTHORThis program is free software; you can redistribute it and/or modifyit under the terms of the GNU General Public License as published bythe Free Software Foundation; either version 2 of the License, or(at your option) any later version.This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU General Public License for more details.You should have received a copy of the GNU General Public Licensealong with this program; if not, write to the Free SoftwareFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USAAlso add information on how to contact you by electronic and papermail.If the program is interactive, make it output a short notice likethis when it starts in an interactive mode:Gnomovision version 69, Copyright (C) YEAR NAME OF AUTHORGnomovision comes with ABSOLUTELY NO WARRANTY; for detailstype `show w'.This is free software, and you are welcome to redistribute itunder certain conditions; type `show c' for details.The hypothetical commands `show w' and `show c' should show theappropriate parts of the General Public License. Of course, thecommands you use may be called something other than `show w' and `showc'; they could even be mouse-clicks or menu items--whatever suits yourprogram.You should also get your employer (if you work as a programmer) oryour school, if any, to sign a "copyright disclaimer" for the program,if necessary. Here is a sample; alter the names:Yoyodyne, Inc., hereby disclaims all copyright interest in the program`Gnomovision' (which makes passes at compilers) written by James Hacker.SIGNATURE OF TY COON, 1 April 1989Ty Coon, President of ViceThis General Public License does not permit incorporating yourprogram into proprietary programs. If your program is a subroutinelibrary, you may consider it more useful to permit linking proprietaryapplications with the library. If this is what you want to do, use theGNU Library General Public License instead of this License.File: libgomp.info, Node: GNU Free Documentation License, Next: Funding, Prev: Copying, Up: TopGNU Free Documentation License******************************Version 1.2, November 2002Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USAEveryone is permitted to copy and distribute verbatim copiesof this license document, but changing it is not allowed.0. PREAMBLEThe purpose of this License is to make a manual, textbook, or otherfunctional and useful document "free" in the sense of freedom: toassure everyone the effective freedom to copy and redistribute it,with or without modifying it, either commercially ornoncommercially. Secondarily, this License preserves for theauthor and publisher a way to get credit for their work, while notbeing considered responsible for modifications made by others.This License is a kind of "copyleft", which means that derivativeworks of the document must themselves be free in the same sense.It complements the GNU General Public License, which is a copyleftlicense designed for free software.We have designed this License in order to use it for manuals forfree software, because free software needs free documentation: afree program should come with manuals providing the same freedomsthat the software does. But this License is not limited tosoftware manuals; it can be used for any textual work, regardlessof subject matter or whether it is published as a printed book.We recommend this License principally for works whose purpose isinstruction or reference.1. APPLICABILITY AND DEFINITIONSThis License applies to any manual or other work, in any medium,that contains a notice placed by the copyright holder saying itcan be distributed under the terms of this License. Such a noticegrants a world-wide, royalty-free license, unlimited in duration,to use that work under the conditions stated herein. The"Document", below, refers to any such manual or work. Any memberof the public is a licensee, and is addressed as "you". Youaccept the license if you copy, modify or distribute the work in away requiring permission under copyright law.A "Modified Version" of the Document means any work containing theDocument or a portion of it, either copied verbatim, or withmodifications and/or translated into another language.A "Secondary Section" is a named appendix or a front-matter sectionof the Document that deals exclusively with the relationship of thepublishers or authors of the Document to the Document's overallsubject (or to related matters) and contains nothing that couldfall directly within that overall subject. (Thus, if the Documentis in part a textbook of mathematics, a Secondary Section may notexplain any mathematics.) The relationship could be a matter ofhistorical connection with the subject or with related matters, orof legal, commercial, philosophical, ethical or political positionregarding them.The "Invariant Sections" are certain Secondary Sections whosetitles are designated, as being those of Invariant Sections, inthe notice that says that the Document is released under thisLicense. If a section does not fit the above definition ofSecondary then it is not allowed to be designated as Invariant.The Document may contain zero Invariant Sections. If the Documentdoes not identify any Invariant Sections then there are none.The "Cover Texts" are certain short passages of text that arelisted, as Front-Cover Texts or Back-Cover Texts, in the noticethat says that the Document is released under this License. AFront-Cover Text may be at most 5 words, and a Back-Cover Text maybe at most 25 words.A "Transparent" copy of the Document means a machine-readable copy,represented in a format whose specification is available to thegeneral public, that is suitable for revising the documentstraightforwardly with generic text editors or (for imagescomposed of pixels) generic paint programs or (for drawings) somewidely available drawing editor, and that is suitable for input totext formatters or for automatic translation to a variety offormats suitable for input to text formatters. A copy made in anotherwise Transparent file format whose markup, or absence ofmarkup, has been arranged to thwart or discourage subsequentmodification by readers is not Transparent. An image format isnot Transparent if used for any substantial amount of text. Acopy that is not "Transparent" is called "Opaque".Examples of suitable formats for Transparent copies include plainASCII without markup, Texinfo input format, LaTeX input format,SGML or XML using a publicly available DTD, andstandard-conforming simple HTML, PostScript or PDF designed forhuman modification. Examples of transparent image formats includePNG, XCF and JPG. Opaque formats include proprietary formats thatcan be read and edited only by proprietary word processors, SGML orXML for which the DTD and/or processing tools are not generallyavailable, and the machine-generated HTML, PostScript or PDFproduced by some word processors for output purposes only.The "Title Page" means, for a printed book, the title page itself,plus such following pages as are needed to hold, legibly, thematerial this License requires to appear in the title page. Forworks in formats which do not have any title page as such, "TitlePage" means the text near the most prominent appearance of thework's title, preceding the beginning of the body of the text.A section "Entitled XYZ" means a named subunit of the Documentwhose title either is precisely XYZ or contains XYZ in parenthesesfollowing text that translates XYZ in another language. (Here XYZstands for a specific section name mentioned below, such as"Acknowledgements", "Dedications", "Endorsements", or "History".)To "Preserve the Title" of such a section when you modify theDocument means that it remains a section "Entitled XYZ" accordingto this definition.The Document may include Warranty Disclaimers next to the noticewhich states that this License applies to the Document. TheseWarranty Disclaimers are considered to be included by reference inthis License, but only as regards disclaiming warranties: any otherimplication that these Warranty Disclaimers may have is void andhas no effect on the meaning of this License.2. VERBATIM COPYINGYou may copy and distribute the Document in any medium, eithercommercially or noncommercially, provided that this License, thecopyright notices, and the license notice saying this Licenseapplies to the Document are reproduced in all copies, and that youadd no other conditions whatsoever to those of this License. Youmay not use technical measures to obstruct or control the readingor further copying of the copies you make or distribute. However,you may accept compensation in exchange for copies. If youdistribute a large enough number of copies you must also followthe conditions in section 3.You may also lend copies, under the same conditions stated above,and you may publicly display copies.3. COPYING IN QUANTITYIf you publish printed copies (or copies in media that commonlyhave printed covers) of the Document, numbering more than 100, andthe Document's license notice requires Cover Texts, you mustenclose the copies in covers that carry, clearly and legibly, allthese Cover Texts: Front-Cover Texts on the front cover, andBack-Cover Texts on the back cover. Both covers must also clearlyand legibly identify you as the publisher of these copies. Thefront cover must present the full title with all words of thetitle equally prominent and visible. You may add other materialon the covers in addition. Copying with changes limited to thecovers, as long as they preserve the title of the Document andsatisfy these conditions, can be treated as verbatim copying inother respects.If the required texts for either cover are too voluminous to fitlegibly, you should put the first ones listed (as many as fitreasonably) on the actual cover, and continue the rest ontoadjacent pages.If you publish or distribute Opaque copies of the Documentnumbering more than 100, you must either include amachine-readable Transparent copy along with each Opaque copy, orstate in or with each Opaque copy a computer-network location fromwhich the general network-using public has access to downloadusing public-standard network protocols a complete Transparentcopy of the Document, free of added material. If you use thelatter option, you must take reasonably prudent steps, when youbegin distribution of Opaque copies in quantity, to ensure thatthis Transparent copy will remain thus accessible at the statedlocation until at least one year after the last time youdistribute an Opaque copy (directly or through your agents orretailers) of that edition to the public.It is requested, but not required, that you contact the authors ofthe Document well before redistributing any large number ofcopies, to give them a chance to provide you with an updatedversion of the Document.4. MODIFICATIONSYou may copy and distribute a Modified Version of the Documentunder the conditions of sections 2 and 3 above, provided that yourelease the Modified Version under precisely this License, withthe Modified Version filling the role of the Document, thuslicensing distribution and modification of the Modified Version towhoever possesses a copy of it. In addition, you must do thesethings in the Modified Version:A. Use in the Title Page (and on the covers, if any) a titledistinct from that of the Document, and from those ofprevious versions (which should, if there were any, be listedin the History section of the Document). You may use thesame title as a previous version if the original publisher ofthat version gives permission.B. List on the Title Page, as authors, one or more persons orentities responsible for authorship of the modifications inthe Modified Version, together with at least five of theprincipal authors of the Document (all of its principalauthors, if it has fewer than five), unless they release youfrom this requirement.C. State on the Title page the name of the publisher of theModified Version, as the publisher.D. Preserve all the copyright notices of the Document.E. Add an appropriate copyright notice for your modificationsadjacent to the other copyright notices.F. Include, immediately after the copyright notices, a licensenotice giving the public permission to use the ModifiedVersion under the terms of this License, in the form shown inthe Addendum below.G. Preserve in that license notice the full lists of InvariantSections and required Cover Texts given in the Document'slicense notice.H. Include an unaltered copy of this License.I. Preserve the section Entitled "History", Preserve its Title,and add to it an item stating at least the title, year, newauthors, and publisher of the Modified Version as given onthe Title Page. If there is no section Entitled "History" inthe Document, create one stating the title, year, authors,and publisher of the Document as given on its Title Page,then add an item describing the Modified Version as stated inthe previous sentence.J. Preserve the network location, if any, given in the Documentfor public access to a Transparent copy of the Document, andlikewise the network locations given in the Document forprevious versions it was based on. These may be placed inthe "History" section. You may omit a network location for awork that was published at least four years before theDocument itself, or if the original publisher of the versionit refers to gives permission.K. For any section Entitled "Acknowledgements" or "Dedications",Preserve the Title of the section, and preserve in thesection all the substance and tone of each of the contributoracknowledgements and/or dedications given therein.L. Preserve all the Invariant Sections of the Document,unaltered in their text and in their titles. Section numbersor the equivalent are not considered part of the sectiontitles.M. Delete any section Entitled "Endorsements". Such a sectionmay not be included in the Modified Version.N. Do not retitle any existing section to be Entitled"Endorsements" or to conflict in title with any InvariantSection.O. Preserve any Warranty Disclaimers.If the Modified Version includes new front-matter sections orappendices that qualify as Secondary Sections and contain nomaterial copied from the Document, you may at your optiondesignate some or all of these sections as invariant. To do this,add their titles to the list of Invariant Sections in the ModifiedVersion's license notice. These titles must be distinct from anyother section titles.You may add a section Entitled "Endorsements", provided it containsnothing but endorsements of your Modified Version by variousparties--for example, statements of peer review or that the texthas been approved by an organization as the authoritativedefinition of a standard.You may add a passage of up to five words as a Front-Cover Text,and a passage of up to 25 words as a Back-Cover Text, to the endof the list of Cover Texts in the Modified Version. Only onepassage of Front-Cover Text and one of Back-Cover Text may beadded by (or through arrangements made by) any one entity. If theDocument already includes a cover text for the same cover,previously added by you or by arrangement made by the same entityyou are acting on behalf of, you may not add another; but you mayreplace the old one, on explicit permission from the previouspublisher that added the old one.The author(s) and publisher(s) of the Document do not by thisLicense give permission to use their names for publicity for or toassert or imply endorsement of any Modified Version.5. COMBINING DOCUMENTSYou may combine the Document with other documents released underthis License, under the terms defined in section 4 above formodified versions, provided that you include in the combinationall of the Invariant Sections of all of the original documents,unmodified, and list them all as Invariant Sections of yourcombined work in its license notice, and that you preserve alltheir Warranty Disclaimers.The combined work need only contain one copy of this License, andmultiple identical Invariant Sections may be replaced with a singlecopy. If there are multiple Invariant Sections with the same namebut different contents, make the title of each such section uniqueby adding at the end of it, in parentheses, the name of theoriginal author or publisher of that section if known, or else aunique number. Make the same adjustment to the section titles inthe list of Invariant Sections in the license notice of thecombined work.In the combination, you must combine any sections Entitled"History" in the various original documents, forming one sectionEntitled "History"; likewise combine any sections Entitled"Acknowledgements", and any sections Entitled "Dedications". Youmust delete all sections Entitled "Endorsements."6. COLLECTIONS OF DOCUMENTSYou may make a collection consisting of the Document and otherdocuments released under this License, and replace the individualcopies of this License in the various documents with a single copythat is included in the collection, provided that you follow therules of this License for verbatim copying of each of thedocuments in all other respects.You may extract a single document from such a collection, anddistribute it individually under this License, provided you inserta copy of this License into the extracted document, and followthis License in all other respects regarding verbatim copying ofthat document.7. AGGREGATION WITH INDEPENDENT WORKSA compilation of the Document or its derivatives with otherseparate and independent documents or works, in or on a volume ofa storage or distribution medium, is called an "aggregate" if thecopyright resulting from the compilation is not used to limit thelegal rights of the compilation's users beyond what the individualworks permit. When the Document is included in an aggregate, thisLicense does not apply to the other works in the aggregate whichare not themselves derivative works of the Document.If the Cover Text requirement of section 3 is applicable to thesecopies of the Document, then if the Document is less than one halfof the entire aggregate, the Document's Cover Texts may be placedon covers that bracket the Document within the aggregate, or theelectronic equivalent of covers if the Document is in electronicform. Otherwise they must appear on printed covers that bracketthe whole aggregate.8. TRANSLATIONTranslation is considered a kind of modification, so you maydistribute translations of the Document under the terms of section4. Replacing Invariant Sections with translations requires specialpermission from their copyright holders, but you may includetranslations of some or all Invariant Sections in addition to theoriginal versions of these Invariant Sections. You may include atranslation of this License, and all the license notices in theDocument, and any Warranty Disclaimers, provided that you alsoinclude the original English version of this License and theoriginal versions of those notices and disclaimers. In case of adisagreement between the translation and the original version ofthis License or a notice or disclaimer, the original version willprevail.If a section in the Document is Entitled "Acknowledgements","Dedications", or "History", the requirement (section 4) toPreserve its Title (section 1) will typically require changing theactual title.9. TERMINATIONYou may not copy, modify, sublicense, or distribute the Documentexcept as expressly provided for under this License. Any otherattempt to copy, modify, sublicense or distribute the Document isvoid, and will automatically terminate your rights under thisLicense. However, parties who have received copies, or rights,from you under this License will not have their licensesterminated so long as such parties remain in full compliance.10. FUTURE REVISIONS OF THIS LICENSEThe Free Software Foundation may publish new, revised versions ofthe GNU Free Documentation License from time to time. Such newversions will be similar in spirit to the present version, but maydiffer in detail to address new problems or concerns. See`http://www.gnu.org/copyleft/'.Each version of the License is given a distinguishing versionnumber. If the Document specifies that a particular numberedversion of this License "or any later version" applies to it, youhave the option of following the terms and conditions either ofthat specified version or of any later version that has beenpublished (not as a draft) by the Free Software Foundation. Ifthe Document does not specify a version number of this License,you may choose any version ever published (not as a draft) by theFree Software Foundation.ADDENDUM: How to use this License for your documents====================================================To use this License in a document you have written, include a copy ofthe License in the document and put the following copyright and licensenotices just after the title page:Copyright (C) YEAR YOUR NAME.Permission is granted to copy, distribute and/or modify this documentunder the terms of the GNU Free Documentation License, Version 1.2or any later version published by the Free Software Foundation;with no Invariant Sections, no Front-Cover Texts, and no Back-CoverTexts. A copy of the license is included in the section entitled ``GNUFree Documentation License''.If you have Invariant Sections, Front-Cover Texts and Back-CoverTexts, replace the "with...Texts." line with this:with the Invariant Sections being LIST THEIR TITLES, withthe Front-Cover Texts being LIST, and with the Back-Cover Textsbeing LIST.If you have Invariant Sections without Cover Texts, or some othercombination of the three, merge those two alternatives to suit thesituation.If your document contains nontrivial examples of program code, werecommend releasing these examples in parallel under your choice offree software license, such as the GNU General Public License, topermit their use in free software.File: libgomp.info, Node: Funding, Next: Index, Prev: GNU Free Documentation License, Up: TopFunding Free Software*********************If you want to have more free software a few years from now, it makessense for you to help encourage people to contribute funds for itsdevelopment. The most effective approach known is to encouragecommercial redistributors to donate.Users of free software systems can boost the pace of development byencouraging for-a-fee distributors to donate part of their selling priceto free software developers--the Free Software Foundation, and others.The way to convince distributors to do this is to demand it andexpect it from them. So when you compare distributors, judge thempartly by how much they give to free software development. Showdistributors they must compete to be the one who gives the most.To make this approach work, you must insist on numbers that you cancompare, such as, "We will donate ten dollars to the Frobnitz projectfor each disk sold." Don't be satisfied with a vague promise, such as"A portion of the profits are donated," since it doesn't give a basisfor comparison.Even a precise fraction "of the profits from this disk" is not verymeaningful, since creative accounting and unrelated business decisionscan greatly alter what fraction of the sales price counts as profit.If the price you pay is $50, ten percent of the profit is probably lessthan a dollar; it might be a few cents, or nothing at all.Some redistributors do development work themselves. This is usefultoo; but to keep everyone honest, you need to inquire how much they do,and what kind. Some kinds of development make much more long-termdifference than others. For example, maintaining a separate version ofa program contributes very little; maintaining the standard version of aprogram for the whole community contributes much. Easy new portscontribute little, since someone else would surely do them; difficultports such as adding a new CPU to the GNU Compiler Collectioncontribute more; major new features or packages contribute the most.By establishing the idea that supporting further development is "theproper thing to do" when distributing free software for a fee, we canassure a steady flow of resources into making more free software.Copyright (C) 1994 Free Software Foundation, Inc.Verbatim copying and redistribution of this section is permittedwithout royalty; alteration is not permitted.File: libgomp.info, Node: Index, Prev: Funding, Up: TopIndex*****
