This is libgomp.info, produced by makeinfo version 4.8 from
|
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.
|
/scratch/mitchell/gcc-releases/gcc-4.2.2/gcc-4.2.2/libgomp/libgomp.texi.
|
|
|
Copyright (C) 2006 Free Software Foundation, Inc.
|
Copyright (C) 2006 Free Software Foundation, Inc.
|
|
|
Permission is granted to copy, distribute and/or modify this document
|
Permission is granted to copy, distribute and/or modify this document
|
under the terms of the GNU Free Documentation License, Version 1.1 or
|
under the terms of the GNU Free Documentation License, Version 1.1 or
|
any later version published by the Free Software Foundation; with the
|
any later version published by the Free Software Foundation; with the
|
Invariant Sections being "GNU General Public License" and "Funding Free
|
Invariant Sections being "GNU General Public License" and "Funding Free
|
Software", the Front-Cover texts being (a) (see below), and with the
|
Software", the Front-Cover texts being (a) (see below), and with the
|
Back-Cover Texts being (b) (see below). A copy of the license is
|
Back-Cover Texts being (b) (see below). A copy of the license is
|
included in the section entitled "GNU Free Documentation License".
|
included in the section entitled "GNU Free Documentation License".
|
|
|
(a) The FSF's Front-Cover Text is:
|
(a) The FSF's Front-Cover Text is:
|
|
|
A GNU Manual
|
A GNU Manual
|
|
|
(b) The FSF's Back-Cover Text is:
|
(b) The FSF's Back-Cover Text is:
|
|
|
You have freedom to copy and modify this GNU Manual, like GNU
|
You have freedom to copy and modify this GNU Manual, like GNU
|
software. Copies published by the Free Software Foundation raise
|
software. Copies published by the Free Software Foundation raise
|
funds for GNU development.
|
funds for GNU development.
|
|
|
INFO-DIR-SECTION GNU Libraries
|
INFO-DIR-SECTION GNU Libraries
|
START-INFO-DIR-ENTRY
|
START-INFO-DIR-ENTRY
|
* libgomp: (libgomp). GNU OpenMP runtime library
|
* libgomp: (libgomp). GNU OpenMP runtime library
|
END-INFO-DIR-ENTRY
|
END-INFO-DIR-ENTRY
|
|
|
This manual documents the GNU implementation of the OpenMP API for
|
This manual documents the GNU implementation of the OpenMP API for
|
multi-platform shared-memory parallel programming in C/C++ and Fortran.
|
multi-platform shared-memory parallel programming in C/C++ and Fortran.
|
|
|
Published by the Free Software Foundation 51 Franklin Street, Fifth
|
Published by the Free Software Foundation 51 Franklin Street, Fifth
|
Floor Boston, MA 02110-1301 USA
|
Floor Boston, MA 02110-1301 USA
|
|
|
Copyright (C) 2006 Free Software Foundation, Inc.
|
Copyright (C) 2006 Free Software Foundation, Inc.
|
|
|
Permission is granted to copy, distribute and/or modify this document
|
Permission is granted to copy, distribute and/or modify this document
|
under the terms of the GNU Free Documentation License, Version 1.1 or
|
under the terms of the GNU Free Documentation License, Version 1.1 or
|
any later version published by the Free Software Foundation; with the
|
any later version published by the Free Software Foundation; with the
|
Invariant Sections being "GNU General Public License" and "Funding Free
|
Invariant Sections being "GNU General Public License" and "Funding Free
|
Software", the Front-Cover texts being (a) (see below), and with the
|
Software", the Front-Cover texts being (a) (see below), and with the
|
Back-Cover Texts being (b) (see below). A copy of the license is
|
Back-Cover Texts being (b) (see below). A copy of the license is
|
included in the section entitled "GNU Free Documentation License".
|
included in the section entitled "GNU Free Documentation License".
|
|
|
(a) The FSF's Front-Cover Text is:
|
(a) The FSF's Front-Cover Text is:
|
|
|
A GNU Manual
|
A GNU Manual
|
|
|
(b) The FSF's Back-Cover Text is:
|
(b) The FSF's Back-Cover Text is:
|
|
|
You have freedom to copy and modify this GNU Manual, like GNU
|
You have freedom to copy and modify this GNU Manual, like GNU
|
software. Copies published by the Free Software Foundation raise
|
software. Copies published by the Free Software Foundation raise
|
funds for GNU development.
|
funds for GNU development.
|
|
|
|
|
File: libgomp.info, Node: Top, Next: Enabling OpenMP, Up: (dir)
|
File: libgomp.info, Node: Top, Next: Enabling OpenMP, Up: (dir)
|
|
|
Introduction
|
Introduction
|
************
|
************
|
|
|
This manual documents the usage of libgomp, the GNU implementation of
|
This manual documents the usage of libgomp, the GNU implementation of
|
the OpenMP (http://www.openmp.org) Application Programming Interface
|
the OpenMP (http://www.openmp.org) Application Programming Interface
|
(API) for multi-platform shared-memory parallel programming in C/C++
|
(API) for multi-platform shared-memory parallel programming in C/C++
|
and Fortran.
|
and Fortran.
|
|
|
* Menu:
|
* Menu:
|
|
|
* Enabling OpenMP:: How to enable OpenMP for your applications.
|
* Enabling OpenMP:: How to enable OpenMP for your applications.
|
* Runtime Library Routines:: The OpenMP runtime application programming
|
* Runtime Library Routines:: The OpenMP runtime application programming
|
interface.
|
interface.
|
* Environment Variables:: Influencing runtime behavior with environment
|
* Environment Variables:: Influencing runtime behavior with environment
|
variables.
|
variables.
|
* The libgomp ABI:: Notes on the external ABI presented by libgomp.
|
* The libgomp ABI:: Notes on the external ABI presented by libgomp.
|
* Reporting Bugs:: How to report bugs in GNU OpenMP.
|
* Reporting Bugs:: How to report bugs in GNU OpenMP.
|
* Copying:: GNU general public license says
|
* Copying:: GNU general public license says
|
how you can copy and share libgomp.
|
how you can copy and share libgomp.
|
* GNU Free Documentation License::
|
* GNU Free Documentation License::
|
How you can copy and share this manual.
|
How you can copy and share this manual.
|
* Funding:: How to help assure continued work for free
|
* Funding:: How to help assure continued work for free
|
software.
|
software.
|
* Index:: Index of this documentation.
|
* Index:: Index of this documentation.
|
|
|
|
|
File: libgomp.info, Node: Enabling OpenMP, Next: Runtime Library Routines, Prev: Top, Up: Top
|
File: libgomp.info, Node: Enabling OpenMP, Next: Runtime Library Routines, Prev: Top, Up: Top
|
|
|
1 Enabling OpenMP
|
1 Enabling OpenMP
|
*****************
|
*****************
|
|
|
To activate the OpenMP extensions for C/C++ and Fortran, the
|
To activate the OpenMP extensions for C/C++ and Fortran, the
|
compile-time flag `-fopenmp' must be specified. This enables the OpenMP
|
compile-time flag `-fopenmp' must be specified. This enables the OpenMP
|
directive `#pragma omp' in C/C++ and `!$omp' directives in free form,
|
directive `#pragma omp' in C/C++ and `!$omp' directives in free form,
|
`c$omp', `*$omp' and `!$omp' directives in fixed form, `!$' conditional
|
`c$omp', `*$omp' and `!$omp' directives in fixed form, `!$' conditional
|
compilation sentinels in free form and `c$', `*$' and `!$' sentinels in
|
compilation sentinels in free form and `c$', `*$' and `!$' sentinels in
|
fixed form, for Fortran. The flag also arranges for automatic linking
|
fixed form, for Fortran. The flag also arranges for automatic linking
|
of the OpenMP runtime library (*Note Runtime Library Routines::).
|
of the OpenMP runtime library (*Note Runtime Library Routines::).
|
|
|
A complete description of all OpenMP directives accepted may be
|
A complete description of all OpenMP directives accepted may be
|
found in the OpenMP Application Program Interface
|
found in the OpenMP Application Program Interface
|
(http://www.openmp.org) manual, version 2.5.
|
(http://www.openmp.org) manual, version 2.5.
|
|
|
|
|
File: libgomp.info, Node: Runtime Library Routines, Next: Environment Variables, Prev: Enabling OpenMP, Up: Top
|
File: libgomp.info, Node: Runtime Library Routines, Next: Environment Variables, Prev: Enabling OpenMP, Up: Top
|
|
|
2 Runtime Library Routines
|
2 Runtime Library Routines
|
**************************
|
**************************
|
|
|
The runtime routines described here are defined by section 3 of the
|
The runtime routines described here are defined by section 3 of the
|
OpenMP specifications in version 2.5.
|
OpenMP specifications in version 2.5.
|
|
|
Control threads, processors and the parallel environment.
|
Control threads, processors and the parallel environment.
|
|
|
* Menu:
|
* Menu:
|
|
|
* omp_get_dynamic:: Dynamic teams setting
|
* omp_get_dynamic:: Dynamic teams setting
|
* omp_get_max_threads:: Maximum number of threads
|
* omp_get_max_threads:: Maximum number of threads
|
* omp_get_nested:: Nested parallel regions
|
* omp_get_nested:: Nested parallel regions
|
* omp_get_num_procs:: Number of processors online
|
* omp_get_num_procs:: Number of processors online
|
* omp_get_num_threads:: Size of the active team
|
* omp_get_num_threads:: Size of the active team
|
* omp_get_thread_num:: Current thread ID
|
* omp_get_thread_num:: Current thread ID
|
* omp_in_parallel:: Whether a parallel region is active
|
* omp_in_parallel:: Whether a parallel region is active
|
* omp_set_dynamic:: Enable/disable dynamic teams
|
* omp_set_dynamic:: Enable/disable dynamic teams
|
* omp_set_nested:: Enable/disable nested parallel regions
|
* omp_set_nested:: Enable/disable nested parallel regions
|
* omp_set_num_threads:: Set upper team size limit
|
* omp_set_num_threads:: Set upper team size limit
|
|
|
Initialize, set, test, unset and destroy simple and nested locks.
|
Initialize, set, test, unset and destroy simple and nested locks.
|
|
|
* Menu:
|
* Menu:
|
|
|
* omp_init_lock:: Initialize simple lock
|
* omp_init_lock:: Initialize simple lock
|
* omp_set_lock:: Wait for and set simple lock
|
* omp_set_lock:: Wait for and set simple lock
|
* omp_test_lock:: Test and set simple lock if available
|
* omp_test_lock:: Test and set simple lock if available
|
* omp_unset_lock:: Unset simple lock
|
* omp_unset_lock:: Unset simple lock
|
* omp_destroy_lock:: Destroy simple lock
|
* omp_destroy_lock:: Destroy simple lock
|
* omp_init_nest_lock:: Initialize nested lock
|
* omp_init_nest_lock:: Initialize nested lock
|
* omp_set_nest_lock:: Wait for and set simple lock
|
* omp_set_nest_lock:: Wait for and set simple lock
|
* omp_test_nest_lock:: Test and set nested lock if available
|
* omp_test_nest_lock:: Test and set nested lock if available
|
* omp_unset_nest_lock:: Unset nested lock
|
* omp_unset_nest_lock:: Unset nested lock
|
* omp_destroy_nest_lock:: Destroy nested lock
|
* omp_destroy_nest_lock:: Destroy nested lock
|
|
|
Portable, thread-based, wall clock timer.
|
Portable, thread-based, wall clock timer.
|
|
|
* Menu:
|
* Menu:
|
|
|
* omp_get_wtick:: Get timer precision.
|
* omp_get_wtick:: Get timer precision.
|
* omp_get_wtime:: Elapsed wall clock time.
|
* omp_get_wtime:: Elapsed wall clock time.
|
|
|
|
|
File: libgomp.info, Node: omp_get_dynamic, Next: omp_get_max_threads, Up: Runtime Library Routines
|
File: libgomp.info, Node: omp_get_dynamic, Next: omp_get_max_threads, Up: Runtime Library Routines
|
|
|
2.1 `omp_get_dynamic' - Dynamic teams setting
|
2.1 `omp_get_dynamic' - Dynamic teams setting
|
=============================================
|
=============================================
|
|
|
_Description_:
|
_Description_:
|
This function returns `true' if enabled, `false' otherwise. Here,
|
This function returns `true' if enabled, `false' otherwise. Here,
|
`true' and `false' represent their language-specific counterparts.
|
`true' and `false' represent their language-specific counterparts.
|
|
|
The dynamic team setting may be initialized at startup by the
|
The dynamic team setting may be initialized at startup by the
|
`OMP_DYNAMIC' environment variable or at runtime using
|
`OMP_DYNAMIC' environment variable or at runtime using
|
`omp_set_dynamic'. If undefined, dynamic adjustment is disabled by
|
`omp_set_dynamic'. If undefined, dynamic adjustment is disabled by
|
default.
|
default.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `int omp_get_dynamic();'
|
_Prototype_: `int omp_get_dynamic();'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `logical function omp_get_dynamic()'
|
_Interface_: `logical function omp_get_dynamic()'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_set_dynamic::, *Note OMP_DYNAMIC::
|
*Note omp_set_dynamic::, *Note OMP_DYNAMIC::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.8.
|
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 Routines
|
File: libgomp.info, Node: omp_get_max_threads, Next: omp_get_nested, Prev: omp_get_dynamic, Up: Runtime Library Routines
|
|
|
2.2 `omp_get_max_threads' - Maximum number of threads
|
2.2 `omp_get_max_threads' - Maximum number of threads
|
=====================================================
|
=====================================================
|
|
|
_Description_:
|
_Description_:
|
Return the maximum number of threads used for parallel regions
|
Return the maximum number of threads used for parallel regions
|
that do not use the clause `num_threads'.
|
that do not use the clause `num_threads'.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `int omp_get_max_threads();'
|
_Prototype_: `int omp_get_max_threads();'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `integer function omp_get_max_threads()'
|
_Interface_: `integer function omp_get_max_threads()'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_set_num_threads::, *Note omp_set_dynamic::
|
*Note omp_set_num_threads::, *Note omp_set_dynamic::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.3.
|
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 Routines
|
File: libgomp.info, Node: omp_get_nested, Next: omp_get_num_procs, Prev: omp_get_max_threads, Up: Runtime Library Routines
|
|
|
2.3 `omp_get_nested' - Nested parallel regions
|
2.3 `omp_get_nested' - Nested parallel regions
|
==============================================
|
==============================================
|
|
|
_Description_:
|
_Description_:
|
This function returns `true' if nested parallel regions are
|
This function returns `true' if nested parallel regions are
|
enabled, `false' otherwise. Here, `true' and `false' represent
|
enabled, `false' otherwise. Here, `true' and `false' represent
|
their language-specific counterparts.
|
their language-specific counterparts.
|
|
|
Nested parallel regions may be initialized at startup by the
|
Nested parallel regions may be initialized at startup by the
|
`OMP_NESTED' environment variable or at runtime using
|
`OMP_NESTED' environment variable or at runtime using
|
`omp_set_nested'. If undefined, nested parallel regions are
|
`omp_set_nested'. If undefined, nested parallel regions are
|
disabled by default.
|
disabled by default.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `int omp_get_nested();'
|
_Prototype_: `int omp_get_nested();'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `integer function omp_get_nested()'
|
_Interface_: `integer function omp_get_nested()'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_set_nested::, *Note OMP_NESTED::
|
*Note omp_set_nested::, *Note OMP_NESTED::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section
|
OpenMP specifications v2.5 (http://www.openmp.org/), section
|
3.2.10.
|
3.2.10.
|
|
|
|
|
File: libgomp.info, Node: omp_get_num_procs, Next: omp_get_num_threads, Prev: omp_get_nested, Up: Runtime Library Routines
|
File: libgomp.info, Node: omp_get_num_procs, Next: omp_get_num_threads, Prev: omp_get_nested, Up: Runtime Library Routines
|
|
|
2.4 `omp_get_num_procs' - Number of processors online
|
2.4 `omp_get_num_procs' - Number of processors online
|
=====================================================
|
=====================================================
|
|
|
_Description_:
|
_Description_:
|
Returns the number of processors online.
|
Returns the number of processors online.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `int omp_get_num_procs();'
|
_Prototype_: `int omp_get_num_procs();'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `integer function omp_get_num_procs()'
|
_Interface_: `integer function omp_get_num_procs()'
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.5.
|
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 Routines
|
File: libgomp.info, Node: omp_get_num_threads, Next: omp_get_thread_num, Prev: omp_get_num_procs, Up: Runtime Library Routines
|
|
|
2.5 `omp_get_num_threads' - Size of the active team
|
2.5 `omp_get_num_threads' - Size of the active team
|
===================================================
|
===================================================
|
|
|
_Description_:
|
_Description_:
|
The number of threads in the current team. In a sequential section
|
The number of threads in the current team. In a sequential section
|
of the program `omp_get_num_threads' returns 1.
|
of the program `omp_get_num_threads' returns 1.
|
|
|
The default team size may be initialized at startup by the
|
The default team size may be initialized at startup by the
|
`OMP_NUM_THREADS' environment variable. At runtime, the size of
|
`OMP_NUM_THREADS' environment variable. At runtime, the size of
|
the current team may be set either by the `NUM_THREADS' clause or
|
the current team may be set either by the `NUM_THREADS' clause or
|
by `omp_set_num_threads'. If none of the above were used to define
|
by `omp_set_num_threads'. If none of the above were used to define
|
a specific value and `OMP_DYNAMIC' is disabled, one thread per CPU
|
a specific value and `OMP_DYNAMIC' is disabled, one thread per CPU
|
online is used.
|
online is used.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `int omp_get_num_threads();'
|
_Prototype_: `int omp_get_num_threads();'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `integer function omp_get_num_threads()'
|
_Interface_: `integer function omp_get_num_threads()'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_get_max_threads::, *Note omp_set_num_threads::, *Note
|
*Note omp_get_max_threads::, *Note omp_set_num_threads::, *Note
|
OMP_NUM_THREADS::
|
OMP_NUM_THREADS::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.2.
|
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 Routines
|
File: libgomp.info, Node: omp_get_thread_num, Next: omp_in_parallel, Prev: omp_get_num_threads, Up: Runtime Library Routines
|
|
|
2.6 `omp_get_thread_num' - Current thread ID
|
2.6 `omp_get_thread_num' - Current thread ID
|
============================================
|
============================================
|
|
|
_Description_:
|
_Description_:
|
Unique thread identification number. In a sequential parts of the
|
Unique thread identification number. In a sequential parts of the
|
program, `omp_get_thread_num' always returns 0. In parallel
|
program, `omp_get_thread_num' always returns 0. In parallel
|
regions the return value varies from 0 to `omp_get_max_threads'-1
|
regions the return value varies from 0 to `omp_get_max_threads'-1
|
inclusive. The return value of the master thread of a team is
|
inclusive. The return value of the master thread of a team is
|
always 0.
|
always 0.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `int omp_get_thread_num();'
|
_Prototype_: `int omp_get_thread_num();'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `integer function omp_get_thread_num()'
|
_Interface_: `integer function omp_get_thread_num()'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_get_max_threads::
|
*Note omp_get_max_threads::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.4.
|
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 Routines
|
File: libgomp.info, Node: omp_in_parallel, Next: omp_set_dynamic, Prev: omp_get_thread_num, Up: Runtime Library Routines
|
|
|
2.7 `omp_in_parallel' - Whether a parallel region is active
|
2.7 `omp_in_parallel' - Whether a parallel region is active
|
===========================================================
|
===========================================================
|
|
|
_Description_:
|
_Description_:
|
This function returns `true' if currently running in parallel,
|
This function returns `true' if currently running in parallel,
|
`false' otherwise. Here, `true' and `false' represent their
|
`false' otherwise. Here, `true' and `false' represent their
|
language-specific counterparts.
|
language-specific counterparts.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `int omp_in_parallel();'
|
_Prototype_: `int omp_in_parallel();'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `logical function omp_in_parallel()'
|
_Interface_: `logical function omp_in_parallel()'
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.6.
|
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 Routines
|
File: libgomp.info, Node: omp_set_dynamic, Next: omp_set_nested, Prev: omp_in_parallel, Up: Runtime Library Routines
|
|
|
2.8 `omp_set_dynamic' - Enable/disable dynamic teams
|
2.8 `omp_set_dynamic' - Enable/disable dynamic teams
|
====================================================
|
====================================================
|
|
|
_Description_:
|
_Description_:
|
Enable or disable the dynamic adjustment of the number of threads
|
Enable or disable the dynamic adjustment of the number of threads
|
within a team. The function takes the language-specific equivalent
|
within a team. The function takes the language-specific equivalent
|
of `true' and `false', where `true' enables dynamic adjustment of
|
of `true' and `false', where `true' enables dynamic adjustment of
|
team sizes and `false' disables it.
|
team sizes and `false' disables it.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_set_dynamic(int);'
|
_Prototype_: `void omp_set_dynamic(int);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_set_dynamic(set)'
|
_Interface_: `subroutine omp_set_dynamic(set)'
|
`integer, intent(in) :: set'
|
`integer, intent(in) :: set'
|
|
|
_See also_:
|
_See also_:
|
*Note OMP_DYNAMIC::, *Note omp_get_dynamic::
|
*Note OMP_DYNAMIC::, *Note omp_get_dynamic::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.7.
|
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 Routines
|
File: libgomp.info, Node: omp_set_nested, Next: omp_set_num_threads, Prev: omp_set_dynamic, Up: Runtime Library Routines
|
|
|
2.9 `omp_set_nested' - Enable/disable nested parallel regions
|
2.9 `omp_set_nested' - Enable/disable nested parallel regions
|
=============================================================
|
=============================================================
|
|
|
_Description_:
|
_Description_:
|
Enable or disable nested parallel regions, i.e., whether team
|
Enable or disable nested parallel regions, i.e., whether team
|
members are allowed to create new teams. The function takes the
|
members are allowed to create new teams. The function takes the
|
language-specific equivalent of `true' and `false', where `true'
|
language-specific equivalent of `true' and `false', where `true'
|
enables dynamic adjustment of team sizes and `false' disables it.
|
enables dynamic adjustment of team sizes and `false' disables it.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_set_dynamic(int);'
|
_Prototype_: `void omp_set_dynamic(int);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_set_dynamic(set)'
|
_Interface_: `subroutine omp_set_dynamic(set)'
|
`integer, intent(in) :: set'
|
`integer, intent(in) :: set'
|
|
|
_See also_:
|
_See also_:
|
*Note OMP_NESTED::, *Note omp_get_nested::
|
*Note OMP_NESTED::, *Note omp_get_nested::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.9.
|
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 Routines
|
File: libgomp.info, Node: omp_set_num_threads, Next: omp_init_lock, Prev: omp_set_nested, Up: Runtime Library Routines
|
|
|
2.10 `omp_set_num_threads' - Set upper team size limit
|
2.10 `omp_set_num_threads' - Set upper team size limit
|
======================================================
|
======================================================
|
|
|
_Description_:
|
_Description_:
|
Specifies the number of threads used by default in subsequent
|
Specifies the number of threads used by default in subsequent
|
parallel sections, if those do not specify a `num_threads' clause.
|
parallel sections, if those do not specify a `num_threads' clause.
|
The argument of `omp_set_num_threads' shall be a positive integer.
|
The argument of `omp_set_num_threads' shall be a positive integer.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_set_num_threads(int);'
|
_Prototype_: `void omp_set_num_threads(int);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_set_num_threads(set)'
|
_Interface_: `subroutine omp_set_num_threads(set)'
|
`integer, intent(in) :: set'
|
`integer, intent(in) :: set'
|
|
|
_See also_:
|
_See also_:
|
*Note OMP_NUM_THREADS::, *Note omp_get_num_threads::, *Note
|
*Note OMP_NUM_THREADS::, *Note omp_get_num_threads::, *Note
|
omp_get_max_threads::
|
omp_get_max_threads::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.2.1.
|
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 Routines
|
File: libgomp.info, Node: omp_init_lock, Next: omp_set_lock, Prev: omp_set_num_threads, Up: Runtime Library Routines
|
|
|
2.11 `omp_init_lock' - Initialize simple lock
|
2.11 `omp_init_lock' - Initialize simple lock
|
=============================================
|
=============================================
|
|
|
_Description_:
|
_Description_:
|
Initialize a simple lock. After initialization, the lock is in an
|
Initialize a simple lock. After initialization, the lock is in an
|
unlocked state.
|
unlocked state.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_init_lock(omp_lock_t *lock);'
|
_Prototype_: `void omp_init_lock(omp_lock_t *lock);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_init_lock(lock)'
|
_Interface_: `subroutine omp_init_lock(lock)'
|
`integer(omp_lock_kind), intent(out) :: lock'
|
`integer(omp_lock_kind), intent(out) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_destroy_lock::
|
*Note omp_destroy_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.1.
|
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 Routines
|
File: libgomp.info, Node: omp_set_lock, Next: omp_test_lock, Prev: omp_init_lock, Up: Runtime Library Routines
|
|
|
2.12 `omp_set_lock' - Wait for and set simple lock
|
2.12 `omp_set_lock' - Wait for and set simple lock
|
==================================================
|
==================================================
|
|
|
_Description_:
|
_Description_:
|
Before setting a simple lock, the lock variable must be
|
Before setting a simple lock, the lock variable must be
|
initialized by `omp_init_lock'. The calling thread is blocked
|
initialized by `omp_init_lock'. The calling thread is blocked
|
until the lock is available. If the lock is already held by the
|
until the lock is available. If the lock is already held by the
|
current thread, a deadlock occurs.
|
current thread, a deadlock occurs.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_set_lock(omp_lock_t *lock);'
|
_Prototype_: `void omp_set_lock(omp_lock_t *lock);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_set_lock(lock)'
|
_Interface_: `subroutine omp_set_lock(lock)'
|
`integer(omp_lock_kind), intent(out) :: lock'
|
`integer(omp_lock_kind), intent(out) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_init_lock::, *Note omp_test_lock::, *Note
|
*Note omp_init_lock::, *Note omp_test_lock::, *Note
|
omp_unset_lock::
|
omp_unset_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.3.
|
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 Routines
|
File: libgomp.info, Node: omp_test_lock, Next: omp_unset_lock, Prev: omp_set_lock, Up: Runtime Library Routines
|
|
|
2.13 `omp_test_lock' - Test and set simple lock if available
|
2.13 `omp_test_lock' - Test and set simple lock if available
|
============================================================
|
============================================================
|
|
|
_Description_:
|
_Description_:
|
Before setting a simple lock, the lock variable must be
|
Before setting a simple lock, the lock variable must be
|
initialized by `omp_init_lock'. Contrary to `omp_set_lock',
|
initialized by `omp_init_lock'. Contrary to `omp_set_lock',
|
`omp_test_lock' does not block if the lock is not available. This
|
`omp_test_lock' does not block if the lock is not available. This
|
function returns `true' upon success,`false' otherwise. Here,
|
function returns `true' upon success,`false' otherwise. Here,
|
`true' and `false' represent their language-specific counterparts.
|
`true' and `false' represent their language-specific counterparts.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `int omp_test_lock(omp_lock_t *lock);'
|
_Prototype_: `int omp_test_lock(omp_lock_t *lock);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_test_lock(lock)'
|
_Interface_: `subroutine omp_test_lock(lock)'
|
`logical(omp_logical_kind) :: omp_test_lock'
|
`logical(omp_logical_kind) :: omp_test_lock'
|
`integer(omp_lock_kind), intent(out) :: lock'
|
`integer(omp_lock_kind), intent(out) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_init_lock::, *Note omp_set_lock::, *Note omp_set_lock::
|
*Note omp_init_lock::, *Note omp_set_lock::, *Note omp_set_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.5.
|
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 Routines
|
File: libgomp.info, Node: omp_unset_lock, Next: omp_destroy_lock, Prev: omp_test_lock, Up: Runtime Library Routines
|
|
|
2.14 `omp_unset_lock' - Unset simple lock
|
2.14 `omp_unset_lock' - Unset simple lock
|
=========================================
|
=========================================
|
|
|
_Description_:
|
_Description_:
|
A simple lock about to be unset must have been locked by
|
A simple lock about to be unset must have been locked by
|
`omp_set_lock' or `omp_test_lock' before. In addition, the lock
|
`omp_set_lock' or `omp_test_lock' before. In addition, the lock
|
must be held by the thread calling `omp_unset_lock'. Then, the
|
must be held by the thread calling `omp_unset_lock'. Then, the
|
lock becomes unlocked. If one ore more threads attempted to set
|
lock becomes unlocked. If one ore more threads attempted to set
|
the lock before, one of them is chosen to, again, set the lock for
|
the lock before, one of them is chosen to, again, set the lock for
|
itself.
|
itself.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_unset_lock(omp_lock_t *lock);'
|
_Prototype_: `void omp_unset_lock(omp_lock_t *lock);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_unset_lock(lock)'
|
_Interface_: `subroutine omp_unset_lock(lock)'
|
`integer(omp_lock_kind), intent(out) :: lock'
|
`integer(omp_lock_kind), intent(out) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_set_lock::, *Note omp_test_lock::
|
*Note omp_set_lock::, *Note omp_test_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.4.
|
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 Routines
|
File: libgomp.info, Node: omp_destroy_lock, Next: omp_init_nest_lock, Prev: omp_unset_lock, Up: Runtime Library Routines
|
|
|
2.15 `omp_destroy_lock' - Destroy simple lock
|
2.15 `omp_destroy_lock' - Destroy simple lock
|
=============================================
|
=============================================
|
|
|
_Description_:
|
_Description_:
|
Destroy a simple lock. In order to be destroyed, a simple lock
|
Destroy a simple lock. In order to be destroyed, a simple lock
|
must be in the unlocked state.
|
must be in the unlocked state.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_destroy_lock(omp_lock_t *);'
|
_Prototype_: `void omp_destroy_lock(omp_lock_t *);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_destroy_lock(lock)'
|
_Interface_: `subroutine omp_destroy_lock(lock)'
|
`integer(omp_lock_kind), intent(inout) :: lock'
|
`integer(omp_lock_kind), intent(inout) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_init_lock::
|
*Note omp_init_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.2.
|
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 Routines
|
File: libgomp.info, Node: omp_init_nest_lock, Next: omp_set_nest_lock, Prev: omp_destroy_lock, Up: Runtime Library Routines
|
|
|
2.16 `omp_init_nest_lock' - Initialize nested lock
|
2.16 `omp_init_nest_lock' - Initialize nested lock
|
==================================================
|
==================================================
|
|
|
_Description_:
|
_Description_:
|
Initialize a nested lock. After initialization, the lock is in an
|
Initialize a nested lock. After initialization, the lock is in an
|
unlocked state and the nesting count is set to zero.
|
unlocked state and the nesting count is set to zero.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_init_nest_lock(omp_nest_lock_t *lock);'
|
_Prototype_: `void omp_init_nest_lock(omp_nest_lock_t *lock);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_init_nest_lock(lock)'
|
_Interface_: `subroutine omp_init_nest_lock(lock)'
|
`integer(omp_nest_lock_kind), intent(out) :: lock'
|
`integer(omp_nest_lock_kind), intent(out) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_destroy_nest_lock::
|
*Note omp_destroy_nest_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.1.
|
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 Routines
|
File: libgomp.info, Node: omp_set_nest_lock, Next: omp_test_nest_lock, Prev: omp_init_nest_lock, Up: Runtime Library Routines
|
|
|
2.17 `omp_set_nest_lock' - Wait for and set simple lock
|
2.17 `omp_set_nest_lock' - Wait for and set simple lock
|
=======================================================
|
=======================================================
|
|
|
_Description_:
|
_Description_:
|
Before setting a nested lock, the lock variable must be
|
Before setting a nested lock, the lock variable must be
|
initialized by `omp_init_nest_lock'. The calling thread is blocked
|
initialized by `omp_init_nest_lock'. The calling thread is blocked
|
until the lock is available. If the lock is already held by the
|
until the lock is available. If the lock is already held by the
|
current thread, the nesting count for the lock in incremented.
|
current thread, the nesting count for the lock in incremented.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_set_nest_lock(omp_nest_lock_t *lock);'
|
_Prototype_: `void omp_set_nest_lock(omp_nest_lock_t *lock);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_set_nest_lock(lock)'
|
_Interface_: `subroutine omp_set_nest_lock(lock)'
|
`integer(omp_nest_lock_kind), intent(out) :: lock'
|
`integer(omp_nest_lock_kind), intent(out) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_init_nest_lock::, *Note omp_unset_nest_lock::
|
*Note omp_init_nest_lock::, *Note omp_unset_nest_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.3.
|
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 Routines
|
File: libgomp.info, Node: omp_test_nest_lock, Next: omp_unset_nest_lock, Prev: omp_set_nest_lock, Up: Runtime Library Routines
|
|
|
2.18 `omp_test_nest_lock' - Test and set nested lock if available
|
2.18 `omp_test_nest_lock' - Test and set nested lock if available
|
=================================================================
|
=================================================================
|
|
|
_Description_:
|
_Description_:
|
Before setting a nested lock, the lock variable must be
|
Before setting a nested lock, the lock variable must be
|
initialized by `omp_init_nest_lock'. Contrary to
|
initialized by `omp_init_nest_lock'. Contrary to
|
`omp_set_nest_lock', `omp_test_nest_lock' does not block if the
|
`omp_set_nest_lock', `omp_test_nest_lock' does not block if the
|
lock is not available. If the lock is already held by the current
|
lock is not available. If the lock is already held by the current
|
thread, the new nesting count is returned. Otherwise, the return
|
thread, the new nesting count is returned. Otherwise, the return
|
value equals zero.
|
value equals zero.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `int omp_test_nest_lock(omp_nest_lock_t *lock);'
|
_Prototype_: `int omp_test_nest_lock(omp_nest_lock_t *lock);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `integer function omp_test_nest_lock(lock)'
|
_Interface_: `integer function omp_test_nest_lock(lock)'
|
`integer(omp_integer_kind) :: omp_test_nest_lock'
|
`integer(omp_integer_kind) :: omp_test_nest_lock'
|
`integer(omp_nest_lock_kind), intent(inout) :: lock'
|
`integer(omp_nest_lock_kind), intent(inout) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_init_lock::, *Note omp_set_lock::, *Note omp_set_lock::
|
*Note omp_init_lock::, *Note omp_set_lock::, *Note omp_set_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.5.
|
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 Routines
|
File: libgomp.info, Node: omp_unset_nest_lock, Next: omp_destroy_nest_lock, Prev: omp_test_nest_lock, Up: Runtime Library Routines
|
|
|
2.19 `omp_unset_nest_lock' - Unset nested lock
|
2.19 `omp_unset_nest_lock' - Unset nested lock
|
==============================================
|
==============================================
|
|
|
_Description_:
|
_Description_:
|
A nested lock about to be unset must have been locked by
|
A nested lock about to be unset must have been locked by
|
`omp_set_nested_lock' or `omp_test_nested_lock' before. In
|
`omp_set_nested_lock' or `omp_test_nested_lock' before. In
|
addition, the lock must be held by the thread calling
|
addition, the lock must be held by the thread calling
|
`omp_unset_nested_lock'. If the nesting count drops to zero, the
|
`omp_unset_nested_lock'. If the nesting count drops to zero, the
|
lock becomes unlocked. If one ore more threads attempted to set
|
lock becomes unlocked. If one ore more threads attempted to set
|
the lock before, one of them is chosen to, again, set the lock for
|
the lock before, one of them is chosen to, again, set the lock for
|
itself.
|
itself.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_unset_nest_lock(omp_nest_lock_t *lock);'
|
_Prototype_: `void omp_unset_nest_lock(omp_nest_lock_t *lock);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_unset_nest_lock(lock)'
|
_Interface_: `subroutine omp_unset_nest_lock(lock)'
|
`integer(omp_nest_lock_kind), intent(out) :: lock'
|
`integer(omp_nest_lock_kind), intent(out) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_set_nest_lock::
|
*Note omp_set_nest_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.4.
|
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 Routines
|
File: libgomp.info, Node: omp_destroy_nest_lock, Next: omp_get_wtick, Prev: omp_unset_nest_lock, Up: Runtime Library Routines
|
|
|
2.20 `omp_destroy_nest_lock' - Destroy nested lock
|
2.20 `omp_destroy_nest_lock' - Destroy nested lock
|
==================================================
|
==================================================
|
|
|
_Description_:
|
_Description_:
|
Destroy a nested lock. In order to be destroyed, a nested lock
|
Destroy a nested lock. In order to be destroyed, a nested lock
|
must be in the unlocked state and its nesting count must equal
|
must be in the unlocked state and its nesting count must equal
|
zero.
|
zero.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `void omp_destroy_nest_lock(omp_nest_lock_t *);'
|
_Prototype_: `void omp_destroy_nest_lock(omp_nest_lock_t *);'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `subroutine omp_destroy_nest_lock(lock)'
|
_Interface_: `subroutine omp_destroy_nest_lock(lock)'
|
`integer(omp_nest_lock_kind), intent(inout) :: lock'
|
`integer(omp_nest_lock_kind), intent(inout) :: lock'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_init_lock::
|
*Note omp_init_lock::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.3.2.
|
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 Routines
|
File: libgomp.info, Node: omp_get_wtick, Next: omp_get_wtime, Prev: omp_destroy_nest_lock, Up: Runtime Library Routines
|
|
|
2.21 `omp_get_wtick' - Get timer precision
|
2.21 `omp_get_wtick' - Get timer precision
|
==========================================
|
==========================================
|
|
|
_Description_:
|
_Description_:
|
Gets the timer precision, i.e., the number of seconds between two
|
Gets the timer precision, i.e., the number of seconds between two
|
successive clock ticks.
|
successive clock ticks.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `double omp_get_wtick();'
|
_Prototype_: `double omp_get_wtick();'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `double precision function omp_get_wtick()'
|
_Interface_: `double precision function omp_get_wtick()'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_get_wtime::
|
*Note omp_get_wtime::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.4.2.
|
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 Routines
|
File: libgomp.info, Node: omp_get_wtime, Prev: omp_get_wtick, Up: Runtime Library Routines
|
|
|
2.22 `omp_get_wtime' - Elapsed wall clock time
|
2.22 `omp_get_wtime' - Elapsed wall clock time
|
==============================================
|
==============================================
|
|
|
_Description_:
|
_Description_:
|
Elapsed wall clock time in seconds. The time is measured per
|
Elapsed wall clock time in seconds. The time is measured per
|
thread, no guarantee can bee made that two distinct threads
|
thread, no guarantee can bee made that two distinct threads
|
measure the same time. Time is measured from some "time in the
|
measure the same time. Time is measured from some "time in the
|
past". On POSIX compliant systems the seconds since the Epoch
|
past". On POSIX compliant systems the seconds since the Epoch
|
(00:00:00 UTC, January 1, 1970) are returned.
|
(00:00:00 UTC, January 1, 1970) are returned.
|
|
|
_C/C++_:
|
_C/C++_:
|
_Prototype_: `double omp_get_wtime();'
|
_Prototype_: `double omp_get_wtime();'
|
|
|
_Fortran_:
|
_Fortran_:
|
_Interface_: `double precision function omp_get_wtime()'
|
_Interface_: `double precision function omp_get_wtime()'
|
|
|
_See also_:
|
_See also_:
|
*Note omp_get_wtick::
|
*Note omp_get_wtick::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 3.4.1.
|
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: Top
|
File: libgomp.info, Node: Environment Variables, Next: The libgomp ABI, Prev: Runtime Library Routines, Up: Top
|
|
|
3 Environment Variables
|
3 Environment Variables
|
***********************
|
***********************
|
|
|
The variables `OMP_DYNAMIC', `OMP_NESTED', `OMP_NUM_THREADS' and
|
The variables `OMP_DYNAMIC', `OMP_NESTED', `OMP_NUM_THREADS' and
|
`OMP_SCHEDULE' are defined by section 4 of the OpenMP specifications in
|
`OMP_SCHEDULE' are defined by section 4 of the OpenMP specifications in
|
version 2.5, while `GOMP_CPU_AFFINITY' and `GOMP_STACKSIZE' are GNU
|
version 2.5, while `GOMP_CPU_AFFINITY' and `GOMP_STACKSIZE' are GNU
|
extensions.
|
extensions.
|
|
|
* Menu:
|
* Menu:
|
|
|
* OMP_DYNAMIC:: Dynamic adjustment of threads
|
* OMP_DYNAMIC:: Dynamic adjustment of threads
|
* OMP_NESTED:: Nested parallel regions
|
* OMP_NESTED:: Nested parallel regions
|
* OMP_NUM_THREADS:: Specifies the number of threads to use
|
* OMP_NUM_THREADS:: Specifies the number of threads to use
|
* OMP_SCHEDULE:: How threads are scheduled
|
* OMP_SCHEDULE:: How threads are scheduled
|
* GOMP_CPU_AFFINITY:: Bind threads to specific CPUs
|
* GOMP_CPU_AFFINITY:: Bind threads to specific CPUs
|
* GOMP_STACKSIZE:: Set default thread stack size
|
* GOMP_STACKSIZE:: Set default thread stack size
|
|
|
|
|
File: libgomp.info, Node: OMP_DYNAMIC, Next: OMP_NESTED, Up: Environment Variables
|
File: libgomp.info, Node: OMP_DYNAMIC, Next: OMP_NESTED, Up: Environment Variables
|
|
|
3.1 `OMP_DYNAMIC' - Dynamic adjustment of threads
|
3.1 `OMP_DYNAMIC' - Dynamic adjustment of threads
|
=================================================
|
=================================================
|
|
|
_Description_:
|
_Description_:
|
Enable or disable the dynamic adjustment of the number of threads
|
Enable or disable the dynamic adjustment of the number of threads
|
within a team. The value of this environment variable shall be
|
within a team. The value of this environment variable shall be
|
`TRUE' or `FALSE'. If undefined, dynamic adjustment is disabled by
|
`TRUE' or `FALSE'. If undefined, dynamic adjustment is disabled by
|
default.
|
default.
|
|
|
_See also_:
|
_See also_:
|
*Note omp_set_dynamic::
|
*Note omp_set_dynamic::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 4.3
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 4.3
|
|
|
|
|
File: libgomp.info, Node: OMP_NESTED, Next: OMP_NUM_THREADS, Prev: OMP_DYNAMIC, Up: Environment Variables
|
File: libgomp.info, Node: OMP_NESTED, Next: OMP_NUM_THREADS, Prev: OMP_DYNAMIC, Up: Environment Variables
|
|
|
3.2 `OMP_NESTED' - Nested parallel regions
|
3.2 `OMP_NESTED' - Nested parallel regions
|
==========================================
|
==========================================
|
|
|
_Description_:
|
_Description_:
|
Enable or disable nested parallel regions, i.e., whether team
|
Enable or disable nested parallel regions, i.e., whether team
|
members are allowed to create new teams. The value of this
|
members are allowed to create new teams. The value of this
|
environment variable shall be `TRUE' or `FALSE'. If undefined,
|
environment variable shall be `TRUE' or `FALSE'. If undefined,
|
nested parallel regions are disabled by default.
|
nested parallel regions are disabled by default.
|
|
|
_See also_:
|
_See also_:
|
*Note omp_set_nested::
|
*Note omp_set_nested::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 4.4
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 4.4
|
|
|
|
|
File: libgomp.info, Node: OMP_NUM_THREADS, Next: OMP_SCHEDULE, Prev: OMP_NESTED, Up: Environment Variables
|
File: libgomp.info, Node: OMP_NUM_THREADS, Next: OMP_SCHEDULE, Prev: OMP_NESTED, Up: Environment Variables
|
|
|
3.3 `OMP_NUM_THREADS' - Specifies the number of threads to use
|
3.3 `OMP_NUM_THREADS' - Specifies the number of threads to use
|
==============================================================
|
==============================================================
|
|
|
_Description_:
|
_Description_:
|
Specifies the default number of threads to use in parallel
|
Specifies the default number of threads to use in parallel
|
regions. The value of this variable shall be positive integer. If
|
regions. The value of this variable shall be positive integer. If
|
undefined one thread per CPU online is used.
|
undefined one thread per CPU online is used.
|
|
|
_See also_:
|
_See also_:
|
*Note omp_set_num_threads::
|
*Note omp_set_num_threads::
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 4.2
|
OpenMP specifications v2.5 (http://www.openmp.org/), section 4.2
|
|
|
|
|
File: libgomp.info, Node: OMP_SCHEDULE, Next: GOMP_CPU_AFFINITY, Prev: OMP_NUM_THREADS, Up: Environment Variables
|
File: libgomp.info, Node: OMP_SCHEDULE, Next: GOMP_CPU_AFFINITY, Prev: OMP_NUM_THREADS, Up: Environment Variables
|
|
|
3.4 `OMP_SCHEDULE' - How threads are scheduled
|
3.4 `OMP_SCHEDULE' - How threads are scheduled
|
==============================================
|
==============================================
|
|
|
_Description_:
|
_Description_:
|
Allows to specify `schedule type' and `chunk size'. The value of
|
Allows to specify `schedule type' and `chunk size'. The value of
|
the variable shall have the form: `type[,chunk]' where `type' is
|
the variable shall have the form: `type[,chunk]' where `type' is
|
one of `static', `dynamic' or `guided'. The optional `chunk size'
|
one of `static', `dynamic' or `guided'. The optional `chunk size'
|
shall be a positive integer. If undefined, dynamic scheduling and
|
shall be a positive integer. If undefined, dynamic scheduling and
|
a chunk size of 1 is used.
|
a chunk size of 1 is used.
|
|
|
_Reference_:
|
_Reference_:
|
OpenMP specifications v2.5 (http://www.openmp.org/), sections
|
OpenMP specifications v2.5 (http://www.openmp.org/), sections
|
2.5.1 and 4.1
|
2.5.1 and 4.1
|
|
|
|
|
File: libgomp.info, Node: GOMP_CPU_AFFINITY, Next: GOMP_STACKSIZE, Prev: OMP_SCHEDULE, Up: Environment Variables
|
File: libgomp.info, Node: GOMP_CPU_AFFINITY, Next: GOMP_STACKSIZE, Prev: OMP_SCHEDULE, Up: Environment Variables
|
|
|
3.5 `GOMP_CPU_AFFINITY' - Bind threads to specific CPUs
|
3.5 `GOMP_CPU_AFFINITY' - Bind threads to specific CPUs
|
=======================================================
|
=======================================================
|
|
|
_Description_:
|
_Description_:
|
A patch for this extension has been submitted, but was not yet
|
A patch for this extension has been submitted, but was not yet
|
applied at the time of writing.
|
applied at the time of writing.
|
|
|
_Reference_:
|
_Reference_:
|
GCC Patches Mailinglist
|
GCC Patches Mailinglist
|
(http://gcc.gnu.org/ml/gcc-patches/2006-05/msg00982.html) GCC
|
(http://gcc.gnu.org/ml/gcc-patches/2006-05/msg00982.html) GCC
|
Patches Mailinglist
|
Patches Mailinglist
|
(http://gcc.gnu.org/ml/gcc-patches/2006-05/msg01133.html)
|
(http://gcc.gnu.org/ml/gcc-patches/2006-05/msg01133.html)
|
|
|
|
|
File: libgomp.info, Node: GOMP_STACKSIZE, Prev: GOMP_CPU_AFFINITY, Up: Environment Variables
|
File: libgomp.info, Node: GOMP_STACKSIZE, Prev: GOMP_CPU_AFFINITY, Up: Environment Variables
|
|
|
3.6 `GOMP_STACKSIZE' - Set default thread stack size
|
3.6 `GOMP_STACKSIZE' - Set default thread stack size
|
====================================================
|
====================================================
|
|
|
_Description_:
|
_Description_:
|
Set the default thread stack size in kilobytes. This is in
|
Set the default thread stack size in kilobytes. This is in
|
opposition to `pthread_attr_setstacksize' which gets the number of
|
opposition to `pthread_attr_setstacksize' which gets the number of
|
bytes as an argument. If the stacksize can not be set due to
|
bytes as an argument. If the stacksize can not be set due to
|
system constraints, an error is reported and the initial stacksize
|
system constraints, an error is reported and the initial stacksize
|
is left unchanged. If undefined, the stack size is system
|
is left unchanged. If undefined, the stack size is system
|
dependent.
|
dependent.
|
|
|
_Reference_:
|
_Reference_:
|
GCC Patches Mailinglist
|
GCC Patches Mailinglist
|
(http://gcc.gnu.org/ml/gcc-patches/2006-06/msg00493.html), GCC
|
(http://gcc.gnu.org/ml/gcc-patches/2006-06/msg00493.html), GCC
|
Patches Mailinglist
|
Patches Mailinglist
|
(http://gcc.gnu.org/ml/gcc-patches/2006-06/msg00496.html)
|
(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: Top
|
File: libgomp.info, Node: The libgomp ABI, Next: Reporting Bugs, Prev: Environment Variables, Up: Top
|
|
|
4 The libgomp ABI
|
4 The libgomp ABI
|
*****************
|
*****************
|
|
|
The following sections present notes on the external ABI as presented
|
The following sections present notes on the external ABI as presented
|
by libgomp. Only maintainers should need them.
|
by libgomp. Only maintainers should need them.
|
|
|
* Menu:
|
* Menu:
|
|
|
* Implementing MASTER construct::
|
* Implementing MASTER construct::
|
* Implementing CRITICAL construct::
|
* Implementing CRITICAL construct::
|
* Implementing ATOMIC construct::
|
* Implementing ATOMIC construct::
|
* Implementing FLUSH construct::
|
* Implementing FLUSH construct::
|
* Implementing BARRIER construct::
|
* Implementing BARRIER construct::
|
* Implementing THREADPRIVATE construct::
|
* Implementing THREADPRIVATE construct::
|
* Implementing PRIVATE clause::
|
* Implementing PRIVATE clause::
|
* Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses::
|
* Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses::
|
* Implementing REDUCTION clause::
|
* Implementing REDUCTION clause::
|
* Implementing PARALLEL construct::
|
* Implementing PARALLEL construct::
|
* Implementing FOR construct::
|
* Implementing FOR construct::
|
* Implementing ORDERED construct::
|
* Implementing ORDERED construct::
|
* Implementing SECTIONS construct::
|
* Implementing SECTIONS construct::
|
* Implementing SINGLE construct::
|
* Implementing SINGLE construct::
|
|
|
|
|
File: libgomp.info, Node: Implementing MASTER construct, Next: Implementing CRITICAL construct, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing MASTER construct, Next: Implementing CRITICAL construct, Up: The libgomp ABI
|
|
|
4.1 Implementing MASTER construct
|
4.1 Implementing MASTER construct
|
=================================
|
=================================
|
|
|
if (omp_get_thread_num () == 0)
|
if (omp_get_thread_num () == 0)
|
block
|
block
|
|
|
Alternately, we generate two copies of the parallel subfunction and
|
Alternately, we generate two copies of the parallel subfunction and
|
only include this in the version run by the master thread. Surely
|
only include this in the version run by the master thread. Surely
|
that's not worthwhile though...
|
that's not worthwhile though...
|
|
|
|
|
File: libgomp.info, Node: Implementing CRITICAL construct, Next: Implementing ATOMIC construct, Prev: Implementing MASTER construct, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing CRITICAL construct, Next: Implementing ATOMIC construct, Prev: Implementing MASTER construct, Up: The libgomp ABI
|
|
|
4.2 Implementing CRITICAL construct
|
4.2 Implementing CRITICAL construct
|
===================================
|
===================================
|
|
|
Without a specified name,
|
Without a specified name,
|
|
|
void GOMP_critical_start (void);
|
void GOMP_critical_start (void);
|
void GOMP_critical_end (void);
|
void GOMP_critical_end (void);
|
|
|
so that we don't get COPY relocations from libgomp to the main
|
so that we don't get COPY relocations from libgomp to the main
|
application.
|
application.
|
|
|
With a specified name, use omp_set_lock and omp_unset_lock with name
|
With a specified name, use omp_set_lock and omp_unset_lock with name
|
being transformed into a variable declared like
|
being transformed into a variable declared like
|
|
|
omp_lock_t gomp_critical_user_ __attribute__((common))
|
omp_lock_t gomp_critical_user_ __attribute__((common))
|
|
|
Ideally the ABI would specify that all zero is a valid unlocked
|
Ideally the ABI would specify that all zero is a valid unlocked
|
state, and so we wouldn't actually need to initialize this at startup.
|
state, 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 ABI
|
File: libgomp.info, Node: Implementing ATOMIC construct, Next: Implementing FLUSH construct, Prev: Implementing CRITICAL construct, Up: The libgomp ABI
|
|
|
4.3 Implementing ATOMIC construct
|
4.3 Implementing ATOMIC construct
|
=================================
|
=================================
|
|
|
The target should implement the `__sync' builtins.
|
The target should implement the `__sync' builtins.
|
|
|
Failing that we could add
|
Failing that we could add
|
|
|
void GOMP_atomic_enter (void)
|
void GOMP_atomic_enter (void)
|
void GOMP_atomic_exit (void)
|
void GOMP_atomic_exit (void)
|
|
|
which reuses the regular lock code, but with yet another lock object
|
which reuses the regular lock code, but with yet another lock object
|
private to the library.
|
private to the library.
|
|
|
|
|
File: libgomp.info, Node: Implementing FLUSH construct, Next: Implementing BARRIER construct, Prev: Implementing ATOMIC construct, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing FLUSH construct, Next: Implementing BARRIER construct, Prev: Implementing ATOMIC construct, Up: The libgomp ABI
|
|
|
4.4 Implementing FLUSH construct
|
4.4 Implementing FLUSH construct
|
================================
|
================================
|
|
|
Expands to the `__sync_synchronize' builtin.
|
Expands to the `__sync_synchronize' builtin.
|
|
|
|
|
File: libgomp.info, Node: Implementing BARRIER construct, Next: Implementing THREADPRIVATE construct, Prev: Implementing FLUSH construct, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing BARRIER construct, Next: Implementing THREADPRIVATE construct, Prev: Implementing FLUSH construct, Up: The libgomp ABI
|
|
|
4.5 Implementing BARRIER construct
|
4.5 Implementing BARRIER construct
|
==================================
|
==================================
|
|
|
void GOMP_barrier (void)
|
void GOMP_barrier (void)
|
|
|
|
|
File: libgomp.info, Node: Implementing THREADPRIVATE construct, Next: Implementing PRIVATE clause, Prev: Implementing BARRIER construct, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing THREADPRIVATE construct, Next: Implementing PRIVATE clause, Prev: Implementing BARRIER construct, Up: The libgomp ABI
|
|
|
4.6 Implementing THREADPRIVATE construct
|
4.6 Implementing THREADPRIVATE construct
|
========================================
|
========================================
|
|
|
In _most_ cases we can map this directly to `__thread'. Except that
|
In _most_ cases we can map this directly to `__thread'. Except that
|
OMP allows constructors for C++ objects. We can either refuse to
|
OMP allows constructors for C++ objects. We can either refuse to
|
support this (how often is it used?) or we can implement something akin
|
support this (how often is it used?) or we can implement something akin
|
to .ctors.
|
to .ctors.
|
|
|
Even more ideally, this ctor feature is handled by extensions to the
|
Even more ideally, this ctor feature is handled by extensions to the
|
main pthreads library. Failing that, we can have a set of entry points
|
main pthreads library. Failing that, we can have a set of entry points
|
to register ctor functions to be called.
|
to 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 ABI
|
File: libgomp.info, Node: Implementing PRIVATE clause, Next: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Prev: Implementing THREADPRIVATE construct, Up: The libgomp ABI
|
|
|
4.7 Implementing PRIVATE clause
|
4.7 Implementing PRIVATE clause
|
===============================
|
===============================
|
|
|
In association with a PARALLEL, or within the lexical extent of a
|
In association with a PARALLEL, or within the lexical extent of a
|
PARALLEL block, the variable becomes a local variable in the parallel
|
PARALLEL block, the variable becomes a local variable in the parallel
|
subfunction.
|
subfunction.
|
|
|
In association with FOR or SECTIONS blocks, create a new automatic
|
In association with FOR or SECTIONS blocks, create a new automatic
|
variable within the current function. This preserves the semantic of
|
variable within the current function. This preserves the semantic of
|
new variable creation.
|
new variable creation.
|
|
|
|
|
File: libgomp.info, Node: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Next: Implementing REDUCTION clause, Prev: Implementing PRIVATE clause, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Next: Implementing REDUCTION clause, Prev: Implementing PRIVATE clause, Up: The libgomp ABI
|
|
|
4.8 Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses
|
4.8 Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses
|
========================================================================
|
========================================================================
|
|
|
Seems simple enough for PARALLEL blocks. Create a private struct for
|
Seems simple enough for PARALLEL blocks. Create a private struct for
|
communicating between parent and subfunction. In the parent, copy in
|
communicating between parent and subfunction. In the parent, copy in
|
values for scalar and "small" structs; copy in addresses for others
|
values for scalar and "small" structs; copy in addresses for others
|
TREE_ADDRESSABLE types. In the subfunction, copy the value into the
|
TREE_ADDRESSABLE types. In the subfunction, copy the value into the
|
local variable.
|
local variable.
|
|
|
Not clear at all what to do with bare FOR or SECTION blocks. The
|
Not clear at all what to do with bare FOR or SECTION blocks. The
|
only thing I can figure is that we do something like
|
only thing I can figure is that we do something like
|
|
|
#pragma omp for firstprivate(x) lastprivate(y)
|
#pragma omp for firstprivate(x) lastprivate(y)
|
for (int i = 0; i < n; ++i)
|
for (int i = 0; i < n; ++i)
|
body;
|
body;
|
|
|
which becomes
|
which becomes
|
|
|
{
|
{
|
int x = x, y;
|
int x = x, y;
|
|
|
// for stuff
|
// for stuff
|
|
|
if (i == n)
|
if (i == n)
|
y = y;
|
y = y;
|
}
|
}
|
|
|
where the "x=x" and "y=y" assignments actually have different uids
|
where the "x=x" and "y=y" assignments actually have different uids
|
for the two variables, i.e. not something you could write directly in
|
for the two variables, i.e. not something you could write directly in
|
C. Presumably this only makes sense if the "outer" x and y are global
|
C. Presumably this only makes sense if the "outer" x and y are global
|
variables.
|
variables.
|
|
|
COPYPRIVATE would work the same way, except the structure broadcast
|
COPYPRIVATE would work the same way, except the structure broadcast
|
would have to happen via SINGLE machinery instead.
|
would 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 ABI
|
File: libgomp.info, Node: Implementing REDUCTION clause, Next: Implementing PARALLEL construct, Prev: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses, Up: The libgomp ABI
|
|
|
4.9 Implementing REDUCTION clause
|
4.9 Implementing REDUCTION clause
|
=================================
|
=================================
|
|
|
The private struct mentioned in the previous section should have a
|
The private struct mentioned in the previous section should have a
|
pointer to an array of the type of the variable, indexed by the
|
pointer to an array of the type of the variable, indexed by the
|
thread's TEAM_ID. The thread stores its final value into the array,
|
thread's TEAM_ID. The thread stores its final value into the array,
|
and after the barrier the master thread iterates over the array to
|
and after the barrier the master thread iterates over the array to
|
collect the values.
|
collect the values.
|
|
|
|
|
File: libgomp.info, Node: Implementing PARALLEL construct, Next: Implementing FOR construct, Prev: Implementing REDUCTION clause, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing PARALLEL construct, Next: Implementing FOR construct, Prev: Implementing REDUCTION clause, Up: The libgomp ABI
|
|
|
4.10 Implementing PARALLEL construct
|
4.10 Implementing PARALLEL construct
|
====================================
|
====================================
|
|
|
#pragma omp parallel
|
#pragma omp parallel
|
{
|
{
|
body;
|
body;
|
}
|
}
|
|
|
becomes
|
becomes
|
|
|
void subfunction (void *data)
|
void subfunction (void *data)
|
{
|
{
|
use data;
|
use data;
|
body;
|
body;
|
}
|
}
|
|
|
setup data;
|
setup data;
|
GOMP_parallel_start (subfunction, &data, num_threads);
|
GOMP_parallel_start (subfunction, &data, num_threads);
|
subfunction (&data);
|
subfunction (&data);
|
GOMP_parallel_end ();
|
GOMP_parallel_end ();
|
|
|
void GOMP_parallel_start (void (*fn)(void *), void *data, unsigned num_threads)
|
void GOMP_parallel_start (void (*fn)(void *), void *data, unsigned num_threads)
|
|
|
The FN argument is the subfunction to be run in parallel.
|
The FN argument is the subfunction to be run in parallel.
|
|
|
The DATA argument is a pointer to a structure used to communicate
|
The DATA argument is a pointer to a structure used to communicate
|
data in and out of the subfunction, as discussed above with respect to
|
data in and out of the subfunction, as discussed above with respect to
|
FIRSTPRIVATE et al.
|
FIRSTPRIVATE et al.
|
|
|
The NUM_THREADS argument is 1 if an IF clause is present and false,
|
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.
|
or the value of the NUM_THREADS clause, if present, or 0.
|
|
|
The function needs to create the appropriate number of threads
|
The function needs to create the appropriate number of threads
|
and/or launch them from the dock. It needs to create the team
|
and/or launch them from the dock. It needs to create the team
|
structure and assign team ids.
|
structure and assign team ids.
|
|
|
void GOMP_parallel_end (void)
|
void GOMP_parallel_end (void)
|
|
|
Tears down the team and returns us to the previous
|
Tears down the team and returns us to the previous
|
`omp_in_parallel()' state.
|
`omp_in_parallel()' state.
|
|
|
|
|
File: libgomp.info, Node: Implementing FOR construct, Next: Implementing ORDERED construct, Prev: Implementing PARALLEL construct, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing FOR construct, Next: Implementing ORDERED construct, Prev: Implementing PARALLEL construct, Up: The libgomp ABI
|
|
|
4.11 Implementing FOR construct
|
4.11 Implementing FOR construct
|
===============================
|
===============================
|
|
|
#pragma omp parallel for
|
#pragma omp parallel for
|
for (i = lb; i <= ub; i++)
|
for (i = lb; i <= ub; i++)
|
body;
|
body;
|
|
|
becomes
|
becomes
|
|
|
void subfunction (void *data)
|
void subfunction (void *data)
|
{
|
{
|
long _s0, _e0;
|
long _s0, _e0;
|
while (GOMP_loop_static_next (&_s0, &_e0))
|
while (GOMP_loop_static_next (&_s0, &_e0))
|
{
|
{
|
long _e1 = _e0, i;
|
long _e1 = _e0, i;
|
for (i = _s0; i < _e1; i++)
|
for (i = _s0; i < _e1; i++)
|
body;
|
body;
|
}
|
}
|
GOMP_loop_end_nowait ();
|
GOMP_loop_end_nowait ();
|
}
|
}
|
|
|
GOMP_parallel_loop_static (subfunction, NULL, 0, lb, ub+1, 1, 0);
|
GOMP_parallel_loop_static (subfunction, NULL, 0, lb, ub+1, 1, 0);
|
subfunction (NULL);
|
subfunction (NULL);
|
GOMP_parallel_end ();
|
GOMP_parallel_end ();
|
|
|
#pragma omp for schedule(runtime)
|
#pragma omp for schedule(runtime)
|
for (i = 0; i < n; i++)
|
for (i = 0; i < n; i++)
|
body;
|
body;
|
|
|
becomes
|
becomes
|
|
|
{
|
{
|
long i, _s0, _e0;
|
long i, _s0, _e0;
|
if (GOMP_loop_runtime_start (0, n, 1, &_s0, &_e0))
|
if (GOMP_loop_runtime_start (0, n, 1, &_s0, &_e0))
|
do {
|
do {
|
long _e1 = _e0;
|
long _e1 = _e0;
|
for (i = _s0, i < _e0; i++)
|
for (i = _s0, i < _e0; i++)
|
body;
|
body;
|
} while (GOMP_loop_runtime_next (&_s0, _&e0));
|
} while (GOMP_loop_runtime_next (&_s0, _&e0));
|
GOMP_loop_end ();
|
GOMP_loop_end ();
|
}
|
}
|
|
|
Note that while it looks like there is trickyness to propagating a
|
Note that while it looks like there is trickyness to propagating a
|
non-constant STEP, there isn't really. We're explicitly allowed to
|
non-constant STEP, there isn't really. We're explicitly allowed to
|
evaluate it as many times as we want, and any variables involved should
|
evaluate it as many times as we want, and any variables involved should
|
automatically be handled as PRIVATE or SHARED like any other variables.
|
automatically be handled as PRIVATE or SHARED like any other variables.
|
So the expression should remain evaluable in the subfunction. We can
|
So the expression should remain evaluable in the subfunction. We can
|
also pull it into a local variable if we like, but since its supposed
|
also pull it into a local variable if we like, but since its supposed
|
to remain unchanged, we can also not if we like.
|
to remain unchanged, we can also not if we like.
|
|
|
If we have SCHEDULE(STATIC), and no ORDERED, then we ought to be
|
If we have SCHEDULE(STATIC), and no ORDERED, then we ought to be
|
able to get away with no work-sharing context at all, since we can
|
able to get away with no work-sharing context at all, since we can
|
simply perform the arithmetic directly in each thread to divide up the
|
simply perform the arithmetic directly in each thread to divide up the
|
iterations. Which would mean that we wouldn't need to call any of
|
iterations. Which would mean that we wouldn't need to call any of
|
these routines.
|
these routines.
|
|
|
There are separate routines for handling loops with an ORDERED
|
There are separate routines for handling loops with an ORDERED
|
clause. Bookkeeping for that is non-trivial...
|
clause. Bookkeeping for that is non-trivial...
|
|
|
|
|
File: libgomp.info, Node: Implementing ORDERED construct, Next: Implementing SECTIONS construct, Prev: Implementing FOR construct, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing ORDERED construct, Next: Implementing SECTIONS construct, Prev: Implementing FOR construct, Up: The libgomp ABI
|
|
|
4.12 Implementing ORDERED construct
|
4.12 Implementing ORDERED construct
|
===================================
|
===================================
|
|
|
void GOMP_ordered_start (void)
|
void GOMP_ordered_start (void)
|
void GOMP_ordered_end (void)
|
void GOMP_ordered_end (void)
|
|
|
|
|
File: libgomp.info, Node: Implementing SECTIONS construct, Next: Implementing SINGLE construct, Prev: Implementing ORDERED construct, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing SECTIONS construct, Next: Implementing SINGLE construct, Prev: Implementing ORDERED construct, Up: The libgomp ABI
|
|
|
4.13 Implementing SECTIONS construct
|
4.13 Implementing SECTIONS construct
|
====================================
|
====================================
|
|
|
A block as
|
A block as
|
|
|
#pragma omp sections
|
#pragma omp sections
|
{
|
{
|
#pragma omp section
|
#pragma omp section
|
stmt1;
|
stmt1;
|
#pragma omp section
|
#pragma omp section
|
stmt2;
|
stmt2;
|
#pragma omp section
|
#pragma omp section
|
stmt3;
|
stmt3;
|
}
|
}
|
|
|
becomes
|
becomes
|
|
|
for (i = GOMP_sections_start (3); i != 0; i = GOMP_sections_next ())
|
for (i = GOMP_sections_start (3); i != 0; i = GOMP_sections_next ())
|
switch (i)
|
switch (i)
|
{
|
{
|
case 1:
|
case 1:
|
stmt1;
|
stmt1;
|
break;
|
break;
|
case 2:
|
case 2:
|
stmt2;
|
stmt2;
|
break;
|
break;
|
case 3:
|
case 3:
|
stmt3;
|
stmt3;
|
break;
|
break;
|
}
|
}
|
GOMP_barrier ();
|
GOMP_barrier ();
|
|
|
|
|
File: libgomp.info, Node: Implementing SINGLE construct, Prev: Implementing SECTIONS construct, Up: The libgomp ABI
|
File: libgomp.info, Node: Implementing SINGLE construct, Prev: Implementing SECTIONS construct, Up: The libgomp ABI
|
|
|
4.14 Implementing SINGLE construct
|
4.14 Implementing SINGLE construct
|
==================================
|
==================================
|
|
|
A block like
|
A block like
|
|
|
#pragma omp single
|
#pragma omp single
|
{
|
{
|
body;
|
body;
|
}
|
}
|
|
|
becomes
|
becomes
|
|
|
if (GOMP_single_start ())
|
if (GOMP_single_start ())
|
body;
|
body;
|
GOMP_barrier ();
|
GOMP_barrier ();
|
|
|
while
|
while
|
|
|
#pragma omp single copyprivate(x)
|
#pragma omp single copyprivate(x)
|
body;
|
body;
|
|
|
becomes
|
becomes
|
|
|
datap = GOMP_single_copy_start ();
|
datap = GOMP_single_copy_start ();
|
if (datap == NULL)
|
if (datap == NULL)
|
{
|
{
|
body;
|
body;
|
data.x = x;
|
data.x = x;
|
GOMP_single_copy_end (&data);
|
GOMP_single_copy_end (&data);
|
}
|
}
|
else
|
else
|
x = datap->x;
|
x = datap->x;
|
GOMP_barrier ();
|
GOMP_barrier ();
|
|
|
|
|
File: libgomp.info, Node: Reporting Bugs, Next: Copying, Prev: The libgomp ABI, Up: Top
|
File: libgomp.info, Node: Reporting Bugs, Next: Copying, Prev: The libgomp ABI, Up: Top
|
|
|
5 Reporting Bugs
|
5 Reporting Bugs
|
****************
|
****************
|
|
|
Bugs in the GNU OpenMP implementation should be reported via bugzilla
|
Bugs in the GNU OpenMP implementation should be reported via bugzilla
|
(http://gcc.gnu.org/bugzilla/). In all cases, please add "openmp" to
|
(http://gcc.gnu.org/bugzilla/). In all cases, please add "openmp" to
|
the keywords field in the bug report.
|
the keywords field in the bug report.
|
|
|
|
|
File: libgomp.info, Node: Copying, Next: GNU Free Documentation License, Prev: Reporting Bugs, Up: Top
|
File: libgomp.info, Node: Copying, Next: GNU Free Documentation License, Prev: Reporting Bugs, Up: Top
|
|
|
GNU GENERAL PUBLIC LICENSE
|
GNU GENERAL PUBLIC LICENSE
|
**************************
|
**************************
|
|
|
Version 2, June 1991
|
Version 2, June 1991
|
|
|
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
Everyone is permitted to copy and distribute verbatim copies
|
Everyone is permitted to copy and distribute verbatim copies
|
of this license document, but changing it is not allowed.
|
of this license document, but changing it is not allowed.
|
|
|
Preamble
|
Preamble
|
========
|
========
|
|
|
The licenses for most software are designed to take away your freedom
|
The licenses for most software are designed to take away your freedom
|
to share and change it. By contrast, the GNU General Public License is
|
to share and change it. By contrast, the GNU General Public License is
|
intended to guarantee your freedom to share and change free
|
intended to guarantee your freedom to share and change free
|
software--to make sure the software is free for all its users. This
|
software--to make sure the software is free for all its users. This
|
General Public License applies to most of the Free Software
|
General Public License applies to most of the Free Software
|
Foundation's software and to any other program whose authors commit to
|
Foundation's software and to any other program whose authors commit to
|
using it. (Some other Free Software Foundation software is covered by
|
using it. (Some other Free Software Foundation software is covered by
|
the GNU Library General Public License instead.) You can apply it to
|
the GNU Library General Public License instead.) You can apply it to
|
your programs, too.
|
your programs, too.
|
|
|
When we speak of free software, we are referring to freedom, not
|
When we speak of free software, we are referring to freedom, not
|
price. Our General Public Licenses are designed to make sure that you
|
price. Our General Public Licenses are designed to make sure that you
|
have the freedom to distribute copies of free software (and charge for
|
have the freedom to distribute copies of free software (and charge for
|
this service if you wish), that you receive source code or can get it
|
this service if you wish), that you receive source code or can get it
|
if you want it, that you can change the software or use pieces of it in
|
if you want it, that you can change the software or use pieces of it in
|
new free programs; and that you know you can do these things.
|
new free programs; and that you know you can do these things.
|
|
|
To protect your rights, we need to make restrictions that forbid
|
To protect your rights, we need to make restrictions that forbid
|
anyone to deny you these rights or to ask you to surrender the rights.
|
anyone to deny you these rights or to ask you to surrender the rights.
|
These restrictions translate to certain responsibilities for you if you
|
These restrictions translate to certain responsibilities for you if you
|
distribute copies of the software, or if you modify it.
|
distribute copies of the software, or if you modify it.
|
|
|
For example, if you distribute copies of such a program, whether
|
For example, if you distribute copies of such a program, whether
|
gratis or for a fee, you must give the recipients all the rights that
|
gratis or for a fee, you must give the recipients all the rights that
|
you have. You must make sure that they, too, receive or can get the
|
you have. You must make sure that they, too, receive or can get the
|
source code. And you must show them these terms so they know their
|
source code. And you must show them these terms so they know their
|
rights.
|
rights.
|
|
|
We protect your rights with two steps: (1) copyright the software,
|
We protect your rights with two steps: (1) copyright the software,
|
and (2) offer you this license which gives you legal permission to copy,
|
and (2) offer you this license which gives you legal permission to copy,
|
distribute and/or modify the software.
|
distribute and/or modify the software.
|
|
|
Also, for each author's protection and ours, we want to make certain
|
Also, for each author's protection and ours, we want to make certain
|
that everyone understands that there is no warranty for this free
|
that everyone understands that there is no warranty for this free
|
software. If the software is modified by someone else and passed on, we
|
software. If the software is modified by someone else and passed on, we
|
want its recipients to know that what they have is not the original, so
|
want its recipients to know that what they have is not the original, so
|
that any problems introduced by others will not reflect on the original
|
that any problems introduced by others will not reflect on the original
|
authors' reputations.
|
authors' reputations.
|
|
|
Finally, any free program is threatened constantly by software
|
Finally, any free program is threatened constantly by software
|
patents. We wish to avoid the danger that redistributors of a free
|
patents. We wish to avoid the danger that redistributors of a free
|
program will individually obtain patent licenses, in effect making the
|
program will individually obtain patent licenses, in effect making the
|
program proprietary. To prevent this, we have made it clear that any
|
program proprietary. To prevent this, we have made it clear that any
|
patent must be licensed for everyone's free use or not licensed at all.
|
patent must be licensed for everyone's free use or not licensed at all.
|
|
|
The precise terms and conditions for copying, distribution and
|
The precise terms and conditions for copying, distribution and
|
modification follow.
|
modification follow.
|
|
|
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
0. This License applies to any program or other work which contains a
|
0. This License applies to any program or other work which contains a
|
notice placed by the copyright holder saying it may be distributed
|
notice placed by the copyright holder saying it may be distributed
|
under the terms of this General Public License. The "Program",
|
under the terms of this General Public License. The "Program",
|
below, refers to any such program or work, and a "work based on
|
below, refers to any such program or work, and a "work based on
|
the Program" means either the Program or any derivative work under
|
the Program" means either the Program or any derivative work under
|
copyright law: that is to say, a work containing the Program or a
|
copyright law: that is to say, a work containing the Program or a
|
portion of it, either verbatim or with modifications and/or
|
portion of it, either verbatim or with modifications and/or
|
translated into another language. (Hereinafter, translation is
|
translated into another language. (Hereinafter, translation is
|
included without limitation in the term "modification".) Each
|
included without limitation in the term "modification".) Each
|
licensee is addressed as "you".
|
licensee is addressed as "you".
|
|
|
Activities other than copying, distribution and modification are
|
Activities other than copying, distribution and modification are
|
not covered by this License; they are outside its scope. The act
|
not covered by this License; they are outside its scope. The act
|
of running the Program is not restricted, and the output from the
|
of running the Program is not restricted, and the output from the
|
Program is covered only if its contents constitute a work based on
|
Program is covered only if its contents constitute a work based on
|
the Program (independent of having been made by running the
|
the Program (independent of having been made by running the
|
Program). Whether that is true depends on what the Program does.
|
Program). Whether that is true depends on what the Program does.
|
|
|
1. You may copy and distribute verbatim copies of the Program's
|
1. You may copy and distribute verbatim copies of the Program's
|
source code as you receive it, in any medium, provided that you
|
source code as you receive it, in any medium, provided that you
|
conspicuously and appropriately publish on each copy an appropriate
|
conspicuously and appropriately publish on each copy an appropriate
|
copyright notice and disclaimer of warranty; keep intact all the
|
copyright notice and disclaimer of warranty; keep intact all the
|
notices that refer to this License and to the absence of any
|
notices that refer to this License and to the absence of any
|
warranty; and give any other recipients of the Program a copy of
|
warranty; and give any other recipients of the Program a copy of
|
this License along with the Program.
|
this License along with the Program.
|
|
|
You may charge a fee for the physical act of transferring a copy,
|
You may charge a fee for the physical act of transferring a copy,
|
and you may at your option offer warranty protection in exchange
|
and you may at your option offer warranty protection in exchange
|
for a fee.
|
for a fee.
|
|
|
2. You may modify your copy or copies of the Program or any portion
|
2. You may modify your copy or copies of the Program or any portion
|
of it, thus forming a work based on the Program, and copy and
|
of it, thus forming a work based on the Program, and copy and
|
distribute such modifications or work under the terms of Section 1
|
distribute such modifications or work under the terms of Section 1
|
above, provided that you also meet all of these conditions:
|
above, provided that you also meet all of these conditions:
|
|
|
a. You must cause the modified files to carry prominent notices
|
a. You must cause the modified files to carry prominent notices
|
stating that you changed the files and the date of any change.
|
stating that you changed the files and the date of any change.
|
|
|
b. You must cause any work that you distribute or publish, that
|
b. You must cause any work that you distribute or publish, that
|
in whole or in part contains or is derived from the Program
|
in whole or in part contains or is derived from the Program
|
or any part thereof, to be licensed as a whole at no charge
|
or any part thereof, to be licensed as a whole at no charge
|
to all third parties under the terms of this License.
|
to all third parties under the terms of this License.
|
|
|
c. If the modified program normally reads commands interactively
|
c. If the modified program normally reads commands interactively
|
when run, you must cause it, when started running for such
|
when run, you must cause it, when started running for such
|
interactive use in the most ordinary way, to print or display
|
interactive use in the most ordinary way, to print or display
|
an announcement including an appropriate copyright notice and
|
an announcement including an appropriate copyright notice and
|
a notice that there is no warranty (or else, saying that you
|
a notice that there is no warranty (or else, saying that you
|
provide a warranty) and that users may redistribute the
|
provide a warranty) and that users may redistribute the
|
program under these conditions, and telling the user how to
|
program under these conditions, and telling the user how to
|
view a copy of this License. (Exception: if the Program
|
view a copy of this License. (Exception: if the Program
|
itself is interactive but does not normally print such an
|
itself is interactive but does not normally print such an
|
announcement, your work based on the Program is not required
|
announcement, your work based on the Program is not required
|
to print an announcement.)
|
to print an announcement.)
|
|
|
These requirements apply to the modified work as a whole. If
|
These requirements apply to the modified work as a whole. If
|
identifiable sections of that work are not derived from the
|
identifiable sections of that work are not derived from the
|
Program, and can be reasonably considered independent and separate
|
Program, and can be reasonably considered independent and separate
|
works in themselves, then this License, and its terms, do not
|
works in themselves, then this License, and its terms, do not
|
apply to those sections when you distribute them as separate
|
apply to those sections when you distribute them as separate
|
works. But when you distribute the same sections as part of a
|
works. But when you distribute the same sections as part of a
|
whole which is a work based on the Program, the distribution of
|
whole which is a work based on the Program, the distribution of
|
the whole must be on the terms of this License, whose permissions
|
the whole must be on the terms of this License, whose permissions
|
for other licensees extend to the entire whole, and thus to each
|
for other licensees extend to the entire whole, and thus to each
|
and every part regardless of who wrote it.
|
and every part regardless of who wrote it.
|
|
|
Thus, it is not the intent of this section to claim rights or
|
Thus, it is not the intent of this section to claim rights or
|
contest your rights to work written entirely by you; rather, the
|
contest your rights to work written entirely by you; rather, the
|
intent is to exercise the right to control the distribution of
|
intent is to exercise the right to control the distribution of
|
derivative or collective works based on the Program.
|
derivative or collective works based on the Program.
|
|
|
In addition, mere aggregation of another work not based on the
|
In addition, mere aggregation of another work not based on the
|
Program with the Program (or with a work based on the Program) on
|
Program with the Program (or with a work based on the Program) on
|
a volume of a storage or distribution medium does not bring the
|
a volume of a storage or distribution medium does not bring the
|
other work under the scope of this License.
|
other work under the scope of this License.
|
|
|
3. You may copy and distribute the Program (or a work based on it,
|
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 terms
|
under Section 2) in object code or executable form under the terms
|
of Sections 1 and 2 above provided that you also do one of the
|
of Sections 1 and 2 above provided that you also do one of the
|
following:
|
following:
|
|
|
a. Accompany it with the complete corresponding machine-readable
|
a. Accompany it with the complete corresponding machine-readable
|
source code, which must be distributed under the terms of
|
source code, which must be distributed under the terms of
|
Sections 1 and 2 above on a medium customarily used for
|
Sections 1 and 2 above on a medium customarily used for
|
software interchange; or,
|
software interchange; or,
|
|
|
b. Accompany it with a written offer, valid for at least three
|
b. Accompany it with a written offer, valid for at least three
|
years, to give any third party, for a charge no more than your
|
years, to give any third party, for a charge no more than your
|
cost of physically performing source distribution, a complete
|
cost of physically performing source distribution, a complete
|
machine-readable copy of the corresponding source code, to be
|
machine-readable copy of the corresponding source code, to be
|
distributed under the terms of Sections 1 and 2 above on a
|
distributed under the terms of Sections 1 and 2 above on a
|
medium customarily used for software interchange; or,
|
medium customarily used for software interchange; or,
|
|
|
c. Accompany it with the information you received as to the offer
|
c. Accompany it with the information you received as to the offer
|
to distribute corresponding source code. (This alternative is
|
to distribute corresponding source code. (This alternative is
|
allowed only for noncommercial distribution and only if you
|
allowed only for noncommercial distribution and only if you
|
received the program in object code or executable form with
|
received the program in object code or executable form with
|
such an offer, in accord with Subsection b above.)
|
such an offer, in accord with Subsection b above.)
|
|
|
The source code for a work means the preferred form of the work for
|
The source code for a work means the preferred form of the work for
|
making modifications to it. For an executable work, complete
|
making modifications to it. For an executable work, complete
|
source code means all the source code for all modules it contains,
|
source code means all the source code for all modules it contains,
|
plus any associated interface definition files, plus the scripts
|
plus any associated interface definition files, plus the scripts
|
used to control compilation and installation of the executable.
|
used to control compilation and installation of the executable.
|
However, as a special exception, the source code distributed need
|
However, as a special exception, the source code distributed need
|
not include anything that is normally distributed (in either
|
not include anything that is normally distributed (in either
|
source or binary form) with the major components (compiler,
|
source or binary form) with the major components (compiler,
|
kernel, and so on) of the operating system on which the executable
|
kernel, and so on) of the operating system on which the executable
|
runs, unless that component itself accompanies the executable.
|
runs, unless that component itself accompanies the executable.
|
|
|
If distribution of executable or object code is made by offering
|
If distribution of executable or object code is made by offering
|
access to copy from a designated place, then offering equivalent
|
access to copy from a designated place, then offering equivalent
|
access to copy the source code from the same place counts as
|
access to copy the source code from the same place counts as
|
distribution of the source code, even though third parties are not
|
distribution of the source code, even though third parties are not
|
compelled to copy the source along with the object code.
|
compelled to copy the source along with the object code.
|
|
|
4. You may not copy, modify, sublicense, or distribute the Program
|
4. You may not copy, modify, sublicense, or distribute the Program
|
except as expressly provided under this License. Any attempt
|
except as expressly provided under this License. Any attempt
|
otherwise to copy, modify, sublicense or distribute the Program is
|
otherwise to copy, modify, sublicense or distribute the Program is
|
void, and will automatically terminate your rights under this
|
void, and will automatically terminate your rights under this
|
License. However, parties who have received copies, or rights,
|
License. However, parties who have received copies, or rights,
|
from you under this License will not have their licenses
|
from you under this License will not have their licenses
|
terminated so long as such parties remain in full compliance.
|
terminated so long as such parties remain in full compliance.
|
|
|
5. You are not required to accept this License, since you have not
|
5. You are not required to accept this License, since you have not
|
signed it. However, nothing else grants you permission to modify
|
signed it. However, nothing else grants you permission to modify
|
or distribute the Program or its derivative works. These actions
|
or distribute the Program or its derivative works. These actions
|
are prohibited by law if you do not accept this License.
|
are prohibited by law if you do not accept this License.
|
Therefore, by modifying or distributing the Program (or any work
|
Therefore, by modifying or distributing the Program (or any work
|
based on the Program), you indicate your acceptance of this
|
based on the Program), you indicate your acceptance of this
|
License to do so, and all its terms and conditions for copying,
|
License to do so, and all its terms and conditions for copying,
|
distributing or modifying the Program or works based on it.
|
distributing or modifying the Program or works based on it.
|
|
|
6. Each time you redistribute the Program (or any work based on the
|
6. Each time you redistribute the Program (or any work based on the
|
Program), the recipient automatically receives a license from the
|
Program), the recipient automatically receives a license from the
|
original licensor to copy, distribute or modify the Program
|
original licensor to copy, distribute or modify the Program
|
subject to these terms and conditions. You may not impose any
|
subject to these terms and conditions. You may not impose any
|
further restrictions on the recipients' exercise of the rights
|
further restrictions on the recipients' exercise of the rights
|
granted herein. You are not responsible for enforcing compliance
|
granted herein. You are not responsible for enforcing compliance
|
by third parties to this License.
|
by third parties to this License.
|
|
|
7. If, as a consequence of a court judgment or allegation of patent
|
7. If, as a consequence of a court judgment or allegation of patent
|
infringement or for any other reason (not limited to patent
|
infringement or for any other reason (not limited to patent
|
issues), conditions are imposed on you (whether by court order,
|
issues), conditions are imposed on you (whether by court order,
|
agreement or otherwise) that contradict the conditions of this
|
agreement or otherwise) that contradict the conditions of this
|
License, they do not excuse you from the conditions of this
|
License, they do not excuse you from the conditions of this
|
License. If you cannot distribute so as to satisfy simultaneously
|
License. If you cannot distribute so as to satisfy simultaneously
|
your obligations under this License and any other pertinent
|
your obligations under this License and any other pertinent
|
obligations, then as a consequence you may not distribute the
|
obligations, then as a consequence you may not distribute the
|
Program at all. For example, if a patent license would not permit
|
Program at all. For example, if a patent license would not permit
|
royalty-free redistribution of the Program by all those who
|
royalty-free redistribution of the Program by all those who
|
receive copies directly or indirectly through you, then the only
|
receive copies directly or indirectly through you, then the only
|
way you could satisfy both it and this License would be to refrain
|
way you could satisfy both it and this License would be to refrain
|
entirely from distribution of the Program.
|
entirely from distribution of the Program.
|
|
|
If any portion of this section is held invalid or unenforceable
|
If any portion of this section is held invalid or unenforceable
|
under any particular circumstance, the balance of the section is
|
under any particular circumstance, the balance of the section is
|
intended to apply and the section as a whole is intended to apply
|
intended to apply and the section as a whole is intended to apply
|
in other circumstances.
|
in other circumstances.
|
|
|
It is not the purpose of this section to induce you to infringe any
|
It is not the purpose of this section to induce you to infringe any
|
patents or other property right claims or to contest validity of
|
patents or other property right claims or to contest validity of
|
any such claims; this section has the sole purpose of protecting
|
any such claims; this section has the sole purpose of protecting
|
the integrity of the free software distribution system, which is
|
the integrity of the free software distribution system, which is
|
implemented by public license practices. Many people have made
|
implemented by public license practices. Many people have made
|
generous contributions to the wide range of software distributed
|
generous contributions to the wide range of software distributed
|
through that system in reliance on consistent application of that
|
through that system in reliance on consistent application of that
|
system; it is up to the author/donor to decide if he or she is
|
system; it is up to the author/donor to decide if he or she is
|
willing to distribute software through any other system and a
|
willing to distribute software through any other system and a
|
licensee cannot impose that choice.
|
licensee cannot impose that choice.
|
|
|
This section is intended to make thoroughly clear what is believed
|
This section is intended to make thoroughly clear what is believed
|
to be a consequence of the rest of this License.
|
to be a consequence of the rest of this License.
|
|
|
8. If the distribution and/or use of the Program is restricted in
|
8. If the distribution and/or use of the Program is restricted in
|
certain countries either by patents or by copyrighted interfaces,
|
certain countries either by patents or by copyrighted interfaces,
|
the original copyright holder who places the Program under this
|
the original copyright holder who places the Program under this
|
License may add an explicit geographical distribution limitation
|
License may add an explicit geographical distribution limitation
|
excluding those countries, so that distribution is permitted only
|
excluding those countries, so that distribution is permitted only
|
in or among countries not thus excluded. In such case, this
|
in or among countries not thus excluded. In such case, this
|
License incorporates the limitation as if written in the body of
|
License incorporates the limitation as if written in the body of
|
this License.
|
this License.
|
|
|
9. The Free Software Foundation may publish revised and/or new
|
9. The Free Software Foundation may publish revised and/or new
|
versions of the General Public License from time to time. Such
|
versions of the General Public License from time to time. Such
|
new versions will be similar in spirit to the present version, but
|
new versions will be similar in spirit to the present version, but
|
may differ in detail to address new problems or concerns.
|
may differ in detail to address new problems or concerns.
|
|
|
Each version is given a distinguishing version number. If the
|
Each version is given a distinguishing version number. If the
|
Program specifies a version number of this License which applies
|
Program specifies a version number of this License which applies
|
to it and "any later version", you have the option of following
|
to it and "any later version", you have the option of following
|
the terms and conditions either of that version or of any later
|
the terms and conditions either of that version or of any later
|
version published by the Free Software Foundation. If the Program
|
version published by the Free Software Foundation. If the Program
|
does not specify a version number of this License, you may choose
|
does not specify a version number of this License, you may choose
|
any version ever published by the Free Software Foundation.
|
any version ever published by the Free Software Foundation.
|
|
|
10. If you wish to incorporate parts of the Program into other free
|
10. If you wish to incorporate parts of the Program into other free
|
programs whose distribution conditions are different, write to the
|
programs whose distribution conditions are different, write to the
|
author to ask for permission. For software which is copyrighted
|
author to ask for permission. For software which is copyrighted
|
by the Free Software Foundation, write to the Free Software
|
by the Free Software Foundation, write to the Free Software
|
Foundation; we sometimes make exceptions for this. Our decision
|
Foundation; we sometimes make exceptions for this. Our decision
|
will be guided by the two goals of preserving the free status of
|
will be guided by the two goals of preserving the free status of
|
all derivatives of our free software and of promoting the sharing
|
all derivatives of our free software and of promoting the sharing
|
and reuse of software generally.
|
and reuse of software generally.
|
|
|
NO WARRANTY
|
NO WARRANTY
|
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
|
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
|
WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
|
WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
|
LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
|
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
|
NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
|
FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
|
QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
|
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
|
SERVICING, REPAIR OR CORRECTION.
|
SERVICING, REPAIR OR CORRECTION.
|
|
|
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
|
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
|
MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
|
MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
|
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
|
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
|
INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
|
INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
|
INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
|
OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
|
OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
|
OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
|
OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
|
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
|
|
END OF TERMS AND CONDITIONS
|
END OF TERMS AND CONDITIONS
|
Appendix: How to Apply These Terms to Your New Programs
|
Appendix: How to Apply These Terms to Your New Programs
|
=======================================================
|
=======================================================
|
|
|
If you develop a new program, and you want it to be of the greatest
|
If you develop a new program, and you want it to be of the greatest
|
possible use to the public, the best way to achieve this is to make it
|
possible use to the public, the best way to achieve this is to make it
|
free software which everyone can redistribute and change under these
|
free software which everyone can redistribute and change under these
|
terms.
|
terms.
|
|
|
To do so, attach the following notices to the program. It is safest
|
To do so, attach the following notices to the program. It is safest
|
to attach them to the start of each source file to most effectively
|
to attach them to the start of each source file to most effectively
|
convey the exclusion of warranty; and each file should have at least
|
convey the exclusion of warranty; and each file should have at least
|
the "copyright" line and a pointer to where the full notice is found.
|
the "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.
|
ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
|
Copyright (C) YEAR NAME OF AUTHOR
|
Copyright (C) YEAR NAME OF AUTHOR
|
|
|
This program is free software; you can redistribute it and/or modify
|
This program is free software; you can redistribute it and/or modify
|
it under the terms of the GNU General Public License as published by
|
it under the terms of the GNU General Public License as published by
|
the Free Software Foundation; either version 2 of the License, or
|
the Free Software Foundation; either version 2 of the License, or
|
(at your option) any later version.
|
(at your option) any later version.
|
|
|
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with this program; if not, write to the Free Software
|
along with this program; if not, write to the Free Software
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
Also add information on how to contact you by electronic and paper
|
Also add information on how to contact you by electronic and paper
|
mail.
|
mail.
|
|
|
If the program is interactive, make it output a short notice like
|
If the program is interactive, make it output a short notice like
|
this when it starts in an interactive mode:
|
this when it starts in an interactive mode:
|
|
|
Gnomovision version 69, Copyright (C) YEAR NAME OF AUTHOR
|
Gnomovision version 69, Copyright (C) YEAR NAME OF AUTHOR
|
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
|
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
|
type `show w'.
|
type `show w'.
|
This is free software, and you are welcome to redistribute it
|
This is free software, and you are welcome to redistribute it
|
under certain conditions; type `show c' for details.
|
under certain conditions; type `show c' for details.
|
|
|
The hypothetical commands `show w' and `show c' should show the
|
The hypothetical commands `show w' and `show c' should show the
|
appropriate parts of the General Public License. Of course, the
|
appropriate parts of the General Public License. Of course, the
|
commands you use may be called something other than `show w' and `show
|
commands you use may be called something other than `show w' and `show
|
c'; they could even be mouse-clicks or menu items--whatever suits your
|
c'; they could even be mouse-clicks or menu items--whatever suits your
|
program.
|
program.
|
|
|
You should also get your employer (if you work as a programmer) or
|
You should also get your employer (if you work as a programmer) or
|
your school, if any, to sign a "copyright disclaimer" for the program,
|
your school, if any, to sign a "copyright disclaimer" for the program,
|
if necessary. Here is a sample; alter the names:
|
if necessary. Here is a sample; alter the names:
|
|
|
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
|
|
SIGNATURE OF TY COON, 1 April 1989
|
SIGNATURE OF TY COON, 1 April 1989
|
Ty Coon, President of Vice
|
Ty Coon, President of Vice
|
|
|
This General Public License does not permit incorporating your
|
This General Public License does not permit incorporating your
|
program into proprietary programs. If your program is a subroutine
|
program into proprietary programs. If your program is a subroutine
|
library, you may consider it more useful to permit linking proprietary
|
library, you may consider it more useful to permit linking proprietary
|
applications with the library. If this is what you want to do, use the
|
applications with the library. If this is what you want to do, use the
|
GNU Library General Public License instead of this License.
|
GNU Library General Public License instead of this License.
|
|
|
|
|
File: libgomp.info, Node: GNU Free Documentation License, Next: Funding, Prev: Copying, Up: Top
|
File: libgomp.info, Node: GNU Free Documentation License, Next: Funding, Prev: Copying, Up: Top
|
|
|
GNU Free Documentation License
|
GNU Free Documentation License
|
******************************
|
******************************
|
|
|
Version 1.2, November 2002
|
Version 1.2, November 2002
|
|
|
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
|
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
Everyone is permitted to copy and distribute verbatim copies
|
Everyone is permitted to copy and distribute verbatim copies
|
of this license document, but changing it is not allowed.
|
of this license document, but changing it is not allowed.
|
|
|
0. PREAMBLE
|
0. PREAMBLE
|
|
|
The purpose of this License is to make a manual, textbook, or other
|
The purpose of this License is to make a manual, textbook, or other
|
functional and useful document "free" in the sense of freedom: to
|
functional and useful document "free" in the sense of freedom: to
|
assure everyone the effective freedom to copy and redistribute it,
|
assure everyone the effective freedom to copy and redistribute it,
|
with or without modifying it, either commercially or
|
with or without modifying it, either commercially or
|
noncommercially. Secondarily, this License preserves for the
|
noncommercially. Secondarily, this License preserves for the
|
author and publisher a way to get credit for their work, while not
|
author and publisher a way to get credit for their work, while not
|
being considered responsible for modifications made by others.
|
being considered responsible for modifications made by others.
|
|
|
This License is a kind of "copyleft", which means that derivative
|
This License is a kind of "copyleft", which means that derivative
|
works of the document must themselves be free in the same sense.
|
works of the document must themselves be free in the same sense.
|
It complements the GNU General Public License, which is a copyleft
|
It complements the GNU General Public License, which is a copyleft
|
license designed for free software.
|
license designed for free software.
|
|
|
We have designed this License in order to use it for manuals for
|
We have designed this License in order to use it for manuals for
|
free software, because free software needs free documentation: a
|
free software, because free software needs free documentation: a
|
free program should come with manuals providing the same freedoms
|
free program should come with manuals providing the same freedoms
|
that the software does. But this License is not limited to
|
that the software does. But this License is not limited to
|
software manuals; it can be used for any textual work, regardless
|
software manuals; it can be used for any textual work, regardless
|
of subject matter or whether it is published as a printed book.
|
of subject matter or whether it is published as a printed book.
|
We recommend this License principally for works whose purpose is
|
We recommend this License principally for works whose purpose is
|
instruction or reference.
|
instruction or reference.
|
|
|
1. APPLICABILITY AND DEFINITIONS
|
1. APPLICABILITY AND DEFINITIONS
|
|
|
This License applies to any manual or other work, in any medium,
|
This License applies to any manual or other work, in any medium,
|
that contains a notice placed by the copyright holder saying it
|
that contains a notice placed by the copyright holder saying it
|
can be distributed under the terms of this License. Such a notice
|
can be distributed under the terms of this License. Such a notice
|
grants a world-wide, royalty-free license, unlimited in duration,
|
grants a world-wide, royalty-free license, unlimited in duration,
|
to use that work under the conditions stated herein. The
|
to use that work under the conditions stated herein. The
|
"Document", below, refers to any such manual or work. Any member
|
"Document", below, refers to any such manual or work. Any member
|
of the public is a licensee, and is addressed as "you". You
|
of the public is a licensee, and is addressed as "you". You
|
accept the license if you copy, modify or distribute the work in a
|
accept the license if you copy, modify or distribute the work in a
|
way requiring permission under copyright law.
|
way requiring permission under copyright law.
|
|
|
A "Modified Version" of the Document means any work containing the
|
A "Modified Version" of the Document means any work containing the
|
Document or a portion of it, either copied verbatim, or with
|
Document or a portion of it, either copied verbatim, or with
|
modifications and/or translated into another language.
|
modifications and/or translated into another language.
|
|
|
A "Secondary Section" is a named appendix or a front-matter section
|
A "Secondary Section" is a named appendix or a front-matter section
|
of the Document that deals exclusively with the relationship of the
|
of the Document that deals exclusively with the relationship of the
|
publishers or authors of the Document to the Document's overall
|
publishers or authors of the Document to the Document's overall
|
subject (or to related matters) and contains nothing that could
|
subject (or to related matters) and contains nothing that could
|
fall directly within that overall subject. (Thus, if the Document
|
fall directly within that overall subject. (Thus, if the Document
|
is in part a textbook of mathematics, a Secondary Section may not
|
is in part a textbook of mathematics, a Secondary Section may not
|
explain any mathematics.) The relationship could be a matter of
|
explain any mathematics.) The relationship could be a matter of
|
historical connection with the subject or with related matters, or
|
historical connection with the subject or with related matters, or
|
of legal, commercial, philosophical, ethical or political position
|
of legal, commercial, philosophical, ethical or political position
|
regarding them.
|
regarding them.
|
|
|
The "Invariant Sections" are certain Secondary Sections whose
|
The "Invariant Sections" are certain Secondary Sections whose
|
titles are designated, as being those of Invariant Sections, in
|
titles are designated, as being those of Invariant Sections, in
|
the notice that says that the Document is released under this
|
the notice that says that the Document is released under this
|
License. If a section does not fit the above definition of
|
License. If a section does not fit the above definition of
|
Secondary then it is not allowed to be designated as Invariant.
|
Secondary then it is not allowed to be designated as Invariant.
|
The Document may contain zero Invariant Sections. If the Document
|
The Document may contain zero Invariant Sections. If the Document
|
does not identify any Invariant Sections then there are none.
|
does not identify any Invariant Sections then there are none.
|
|
|
The "Cover Texts" are certain short passages of text that are
|
The "Cover Texts" are certain short passages of text that are
|
listed, as Front-Cover Texts or Back-Cover Texts, in the notice
|
listed, as Front-Cover Texts or Back-Cover Texts, in the notice
|
that says that the Document is released under this License. A
|
that says that the Document is released under this License. A
|
Front-Cover Text may be at most 5 words, and a Back-Cover Text may
|
Front-Cover Text may be at most 5 words, and a Back-Cover Text may
|
be at most 25 words.
|
be at most 25 words.
|
|
|
A "Transparent" copy of the Document means a machine-readable copy,
|
A "Transparent" copy of the Document means a machine-readable copy,
|
represented in a format whose specification is available to the
|
represented in a format whose specification is available to the
|
general public, that is suitable for revising the document
|
general public, that is suitable for revising the document
|
straightforwardly with generic text editors or (for images
|
straightforwardly with generic text editors or (for images
|
composed of pixels) generic paint programs or (for drawings) some
|
composed of pixels) generic paint programs or (for drawings) some
|
widely available drawing editor, and that is suitable for input to
|
widely available drawing editor, and that is suitable for input to
|
text formatters or for automatic translation to a variety of
|
text formatters or for automatic translation to a variety of
|
formats suitable for input to text formatters. A copy made in an
|
formats suitable for input to text formatters. A copy made in an
|
otherwise Transparent file format whose markup, or absence of
|
otherwise Transparent file format whose markup, or absence of
|
markup, has been arranged to thwart or discourage subsequent
|
markup, has been arranged to thwart or discourage subsequent
|
modification by readers is not Transparent. An image format is
|
modification by readers is not Transparent. An image format is
|
not Transparent if used for any substantial amount of text. A
|
not Transparent if used for any substantial amount of text. A
|
copy that is not "Transparent" is called "Opaque".
|
copy that is not "Transparent" is called "Opaque".
|
|
|
Examples of suitable formats for Transparent copies include plain
|
Examples of suitable formats for Transparent copies include plain
|
ASCII without markup, Texinfo input format, LaTeX input format,
|
ASCII without markup, Texinfo input format, LaTeX input format,
|
SGML or XML using a publicly available DTD, and
|
SGML or XML using a publicly available DTD, and
|
standard-conforming simple HTML, PostScript or PDF designed for
|
standard-conforming simple HTML, PostScript or PDF designed for
|
human modification. Examples of transparent image formats include
|
human modification. Examples of transparent image formats include
|
PNG, XCF and JPG. Opaque formats include proprietary formats that
|
PNG, XCF and JPG. Opaque formats include proprietary formats that
|
can be read and edited only by proprietary word processors, SGML or
|
can be read and edited only by proprietary word processors, SGML or
|
XML for which the DTD and/or processing tools are not generally
|
XML for which the DTD and/or processing tools are not generally
|
available, and the machine-generated HTML, PostScript or PDF
|
available, and the machine-generated HTML, PostScript or PDF
|
produced by some word processors for output purposes only.
|
produced by some word processors for output purposes only.
|
|
|
The "Title Page" means, for a printed book, the title page itself,
|
The "Title Page" means, for a printed book, the title page itself,
|
plus such following pages as are needed to hold, legibly, the
|
plus such following pages as are needed to hold, legibly, the
|
material this License requires to appear in the title page. For
|
material this License requires to appear in the title page. For
|
works in formats which do not have any title page as such, "Title
|
works in formats which do not have any title page as such, "Title
|
Page" means the text near the most prominent appearance of the
|
Page" means the text near the most prominent appearance of the
|
work's title, preceding the beginning of the body of the text.
|
work's title, preceding the beginning of the body of the text.
|
|
|
A section "Entitled XYZ" means a named subunit of the Document
|
A section "Entitled XYZ" means a named subunit of the Document
|
whose title either is precisely XYZ or contains XYZ in parentheses
|
whose title either is precisely XYZ or contains XYZ in parentheses
|
following text that translates XYZ in another language. (Here XYZ
|
following text that translates XYZ in another language. (Here XYZ
|
stands for a specific section name mentioned below, such as
|
stands for a specific section name mentioned below, such as
|
"Acknowledgements", "Dedications", "Endorsements", or "History".)
|
"Acknowledgements", "Dedications", "Endorsements", or "History".)
|
To "Preserve the Title" of such a section when you modify the
|
To "Preserve the Title" of such a section when you modify the
|
Document means that it remains a section "Entitled XYZ" according
|
Document means that it remains a section "Entitled XYZ" according
|
to this definition.
|
to this definition.
|
|
|
The Document may include Warranty Disclaimers next to the notice
|
The Document may include Warranty Disclaimers next to the notice
|
which states that this License applies to the Document. These
|
which states that this License applies to the Document. These
|
Warranty Disclaimers are considered to be included by reference in
|
Warranty Disclaimers are considered to be included by reference in
|
this License, but only as regards disclaiming warranties: any other
|
this License, but only as regards disclaiming warranties: any other
|
implication that these Warranty Disclaimers may have is void and
|
implication that these Warranty Disclaimers may have is void and
|
has no effect on the meaning of this License.
|
has no effect on the meaning of this License.
|
|
|
2. VERBATIM COPYING
|
2. VERBATIM COPYING
|
|
|
You may copy and distribute the Document in any medium, either
|
You may copy and distribute the Document in any medium, either
|
commercially or noncommercially, provided that this License, the
|
commercially or noncommercially, provided that this License, the
|
copyright notices, and the license notice saying this License
|
copyright notices, and the license notice saying this License
|
applies to the Document are reproduced in all copies, and that you
|
applies to the Document are reproduced in all copies, and that you
|
add no other conditions whatsoever to those of this License. You
|
add no other conditions whatsoever to those of this License. You
|
may not use technical measures to obstruct or control the reading
|
may not use technical measures to obstruct or control the reading
|
or further copying of the copies you make or distribute. However,
|
or further copying of the copies you make or distribute. However,
|
you may accept compensation in exchange for copies. If you
|
you may accept compensation in exchange for copies. If you
|
distribute a large enough number of copies you must also follow
|
distribute a large enough number of copies you must also follow
|
the conditions in section 3.
|
the conditions in section 3.
|
|
|
You may also lend copies, under the same conditions stated above,
|
You may also lend copies, under the same conditions stated above,
|
and you may publicly display copies.
|
and you may publicly display copies.
|
|
|
3. COPYING IN QUANTITY
|
3. COPYING IN QUANTITY
|
|
|
If you publish printed copies (or copies in media that commonly
|
If you publish printed copies (or copies in media that commonly
|
have printed covers) of the Document, numbering more than 100, and
|
have printed covers) of the Document, numbering more than 100, and
|
the Document's license notice requires Cover Texts, you must
|
the Document's license notice requires Cover Texts, you must
|
enclose the copies in covers that carry, clearly and legibly, all
|
enclose the copies in covers that carry, clearly and legibly, all
|
these Cover Texts: Front-Cover Texts on the front cover, and
|
these Cover Texts: Front-Cover Texts on the front cover, and
|
Back-Cover Texts on the back cover. Both covers must also clearly
|
Back-Cover Texts on the back cover. Both covers must also clearly
|
and legibly identify you as the publisher of these copies. The
|
and legibly identify you as the publisher of these copies. The
|
front cover must present the full title with all words of the
|
front cover must present the full title with all words of the
|
title equally prominent and visible. You may add other material
|
title equally prominent and visible. You may add other material
|
on the covers in addition. Copying with changes limited to the
|
on the covers in addition. Copying with changes limited to the
|
covers, as long as they preserve the title of the Document and
|
covers, as long as they preserve the title of the Document and
|
satisfy these conditions, can be treated as verbatim copying in
|
satisfy these conditions, can be treated as verbatim copying in
|
other respects.
|
other respects.
|
|
|
If the required texts for either cover are too voluminous to fit
|
If the required texts for either cover are too voluminous to fit
|
legibly, you should put the first ones listed (as many as fit
|
legibly, you should put the first ones listed (as many as fit
|
reasonably) on the actual cover, and continue the rest onto
|
reasonably) on the actual cover, and continue the rest onto
|
adjacent pages.
|
adjacent pages.
|
|
|
If you publish or distribute Opaque copies of the Document
|
If you publish or distribute Opaque copies of the Document
|
numbering more than 100, you must either include a
|
numbering more than 100, you must either include a
|
machine-readable Transparent copy along with each Opaque copy, or
|
machine-readable Transparent copy along with each Opaque copy, or
|
state in or with each Opaque copy a computer-network location from
|
state in or with each Opaque copy a computer-network location from
|
which the general network-using public has access to download
|
which the general network-using public has access to download
|
using public-standard network protocols a complete Transparent
|
using public-standard network protocols a complete Transparent
|
copy of the Document, free of added material. If you use the
|
copy of the Document, free of added material. If you use the
|
latter option, you must take reasonably prudent steps, when you
|
latter option, you must take reasonably prudent steps, when you
|
begin distribution of Opaque copies in quantity, to ensure that
|
begin distribution of Opaque copies in quantity, to ensure that
|
this Transparent copy will remain thus accessible at the stated
|
this Transparent copy will remain thus accessible at the stated
|
location until at least one year after the last time you
|
location until at least one year after the last time you
|
distribute an Opaque copy (directly or through your agents or
|
distribute an Opaque copy (directly or through your agents or
|
retailers) of that edition to the public.
|
retailers) of that edition to the public.
|
|
|
It is requested, but not required, that you contact the authors of
|
It is requested, but not required, that you contact the authors of
|
the Document well before redistributing any large number of
|
the Document well before redistributing any large number of
|
copies, to give them a chance to provide you with an updated
|
copies, to give them a chance to provide you with an updated
|
version of the Document.
|
version of the Document.
|
|
|
4. MODIFICATIONS
|
4. MODIFICATIONS
|
|
|
You may copy and distribute a Modified Version of the Document
|
You may copy and distribute a Modified Version of the Document
|
under the conditions of sections 2 and 3 above, provided that you
|
under the conditions of sections 2 and 3 above, provided that you
|
release the Modified Version under precisely this License, with
|
release the Modified Version under precisely this License, with
|
the Modified Version filling the role of the Document, thus
|
the Modified Version filling the role of the Document, thus
|
licensing distribution and modification of the Modified Version to
|
licensing distribution and modification of the Modified Version to
|
whoever possesses a copy of it. In addition, you must do these
|
whoever possesses a copy of it. In addition, you must do these
|
things in the Modified Version:
|
things in the Modified Version:
|
|
|
A. Use in the Title Page (and on the covers, if any) a title
|
A. Use in the Title Page (and on the covers, if any) a title
|
distinct from that of the Document, and from those of
|
distinct from that of the Document, and from those of
|
previous versions (which should, if there were any, be listed
|
previous versions (which should, if there were any, be listed
|
in the History section of the Document). You may use the
|
in the History section of the Document). You may use the
|
same title as a previous version if the original publisher of
|
same title as a previous version if the original publisher of
|
that version gives permission.
|
that version gives permission.
|
|
|
B. List on the Title Page, as authors, one or more persons or
|
B. List on the Title Page, as authors, one or more persons or
|
entities responsible for authorship of the modifications in
|
entities responsible for authorship of the modifications in
|
the Modified Version, together with at least five of the
|
the Modified Version, together with at least five of the
|
principal authors of the Document (all of its principal
|
principal authors of the Document (all of its principal
|
authors, if it has fewer than five), unless they release you
|
authors, if it has fewer than five), unless they release you
|
from this requirement.
|
from this requirement.
|
|
|
C. State on the Title page the name of the publisher of the
|
C. State on the Title page the name of the publisher of the
|
Modified Version, as the publisher.
|
Modified Version, as the publisher.
|
|
|
D. Preserve all the copyright notices of the Document.
|
D. Preserve all the copyright notices of the Document.
|
|
|
E. Add an appropriate copyright notice for your modifications
|
E. Add an appropriate copyright notice for your modifications
|
adjacent to the other copyright notices.
|
adjacent to the other copyright notices.
|
|
|
F. Include, immediately after the copyright notices, a license
|
F. Include, immediately after the copyright notices, a license
|
notice giving the public permission to use the Modified
|
notice giving the public permission to use the Modified
|
Version under the terms of this License, in the form shown in
|
Version under the terms of this License, in the form shown in
|
the Addendum below.
|
the Addendum below.
|
|
|
G. Preserve in that license notice the full lists of Invariant
|
G. Preserve in that license notice the full lists of Invariant
|
Sections and required Cover Texts given in the Document's
|
Sections and required Cover Texts given in the Document's
|
license notice.
|
license notice.
|
|
|
H. Include an unaltered copy of this License.
|
H. Include an unaltered copy of this License.
|
|
|
I. Preserve the section Entitled "History", Preserve its Title,
|
I. Preserve the section Entitled "History", Preserve its Title,
|
and add to it an item stating at least the title, year, new
|
and add to it an item stating at least the title, year, new
|
authors, and publisher of the Modified Version as given on
|
authors, and publisher of the Modified Version as given on
|
the Title Page. If there is no section Entitled "History" in
|
the Title Page. If there is no section Entitled "History" in
|
the Document, create one stating the title, year, authors,
|
the Document, create one stating the title, year, authors,
|
and publisher of the Document as given on its Title Page,
|
and publisher of the Document as given on its Title Page,
|
then add an item describing the Modified Version as stated in
|
then add an item describing the Modified Version as stated in
|
the previous sentence.
|
the previous sentence.
|
|
|
J. Preserve the network location, if any, given in the Document
|
J. Preserve the network location, if any, given in the Document
|
for public access to a Transparent copy of the Document, and
|
for public access to a Transparent copy of the Document, and
|
likewise the network locations given in the Document for
|
likewise the network locations given in the Document for
|
previous versions it was based on. These may be placed in
|
previous versions it was based on. These may be placed in
|
the "History" section. You may omit a network location for a
|
the "History" section. You may omit a network location for a
|
work that was published at least four years before the
|
work that was published at least four years before the
|
Document itself, or if the original publisher of the version
|
Document itself, or if the original publisher of the version
|
it refers to gives permission.
|
it refers to gives permission.
|
|
|
K. For any section Entitled "Acknowledgements" or "Dedications",
|
K. For any section Entitled "Acknowledgements" or "Dedications",
|
Preserve the Title of the section, and preserve in the
|
Preserve the Title of the section, and preserve in the
|
section all the substance and tone of each of the contributor
|
section all the substance and tone of each of the contributor
|
acknowledgements and/or dedications given therein.
|
acknowledgements and/or dedications given therein.
|
|
|
L. Preserve all the Invariant Sections of the Document,
|
L. Preserve all the Invariant Sections of the Document,
|
unaltered in their text and in their titles. Section numbers
|
unaltered in their text and in their titles. Section numbers
|
or the equivalent are not considered part of the section
|
or the equivalent are not considered part of the section
|
titles.
|
titles.
|
|
|
M. Delete any section Entitled "Endorsements". Such a section
|
M. Delete any section Entitled "Endorsements". Such a section
|
may not be included in the Modified Version.
|
may not be included in the Modified Version.
|
|
|
N. Do not retitle any existing section to be Entitled
|
N. Do not retitle any existing section to be Entitled
|
"Endorsements" or to conflict in title with any Invariant
|
"Endorsements" or to conflict in title with any Invariant
|
Section.
|
Section.
|
|
|
O. Preserve any Warranty Disclaimers.
|
O. Preserve any Warranty Disclaimers.
|
|
|
If the Modified Version includes new front-matter sections or
|
If the Modified Version includes new front-matter sections or
|
appendices that qualify as Secondary Sections and contain no
|
appendices that qualify as Secondary Sections and contain no
|
material copied from the Document, you may at your option
|
material copied from the Document, you may at your option
|
designate some or all of these sections as invariant. To do this,
|
designate some or all of these sections as invariant. To do this,
|
add their titles to the list of Invariant Sections in the Modified
|
add their titles to the list of Invariant Sections in the Modified
|
Version's license notice. These titles must be distinct from any
|
Version's license notice. These titles must be distinct from any
|
other section titles.
|
other section titles.
|
|
|
You may add a section Entitled "Endorsements", provided it contains
|
You may add a section Entitled "Endorsements", provided it contains
|
nothing but endorsements of your Modified Version by various
|
nothing but endorsements of your Modified Version by various
|
parties--for example, statements of peer review or that the text
|
parties--for example, statements of peer review or that the text
|
has been approved by an organization as the authoritative
|
has been approved by an organization as the authoritative
|
definition of a standard.
|
definition of a standard.
|
|
|
You may add a passage of up to five words as a Front-Cover Text,
|
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 end
|
and a passage of up to 25 words as a Back-Cover Text, to the end
|
of the list of Cover Texts in the Modified Version. Only one
|
of the list of Cover Texts in the Modified Version. Only one
|
passage of Front-Cover Text and one of Back-Cover Text may be
|
passage of Front-Cover Text and one of Back-Cover Text may be
|
added by (or through arrangements made by) any one entity. If the
|
added by (or through arrangements made by) any one entity. If the
|
Document already includes a cover text for the same cover,
|
Document already includes a cover text for the same cover,
|
previously added by you or by arrangement made by the same entity
|
previously added by you or by arrangement made by the same entity
|
you are acting on behalf of, you may not add another; but you may
|
you are acting on behalf of, you may not add another; but you may
|
replace the old one, on explicit permission from the previous
|
replace the old one, on explicit permission from the previous
|
publisher that added the old one.
|
publisher that added the old one.
|
|
|
The author(s) and publisher(s) of the Document do not by this
|
The author(s) and publisher(s) of the Document do not by this
|
License give permission to use their names for publicity for or to
|
License give permission to use their names for publicity for or to
|
assert or imply endorsement of any Modified Version.
|
assert or imply endorsement of any Modified Version.
|
|
|
5. COMBINING DOCUMENTS
|
5. COMBINING DOCUMENTS
|
|
|
You may combine the Document with other documents released under
|
You may combine the Document with other documents released under
|
this License, under the terms defined in section 4 above for
|
this License, under the terms defined in section 4 above for
|
modified versions, provided that you include in the combination
|
modified versions, provided that you include in the combination
|
all of the Invariant Sections of all of the original documents,
|
all of the Invariant Sections of all of the original documents,
|
unmodified, and list them all as Invariant Sections of your
|
unmodified, and list them all as Invariant Sections of your
|
combined work in its license notice, and that you preserve all
|
combined work in its license notice, and that you preserve all
|
their Warranty Disclaimers.
|
their Warranty Disclaimers.
|
|
|
The combined work need only contain one copy of this License, and
|
The combined work need only contain one copy of this License, and
|
multiple identical Invariant Sections may be replaced with a single
|
multiple identical Invariant Sections may be replaced with a single
|
copy. If there are multiple Invariant Sections with the same name
|
copy. If there are multiple Invariant Sections with the same name
|
but different contents, make the title of each such section unique
|
but different contents, make the title of each such section unique
|
by adding at the end of it, in parentheses, the name of the
|
by adding at the end of it, in parentheses, the name of the
|
original author or publisher of that section if known, or else a
|
original author or publisher of that section if known, or else a
|
unique number. Make the same adjustment to the section titles in
|
unique number. Make the same adjustment to the section titles in
|
the list of Invariant Sections in the license notice of the
|
the list of Invariant Sections in the license notice of the
|
combined work.
|
combined work.
|
|
|
In the combination, you must combine any sections Entitled
|
In the combination, you must combine any sections Entitled
|
"History" in the various original documents, forming one section
|
"History" in the various original documents, forming one section
|
Entitled "History"; likewise combine any sections Entitled
|
Entitled "History"; likewise combine any sections Entitled
|
"Acknowledgements", and any sections Entitled "Dedications". You
|
"Acknowledgements", and any sections Entitled "Dedications". You
|
must delete all sections Entitled "Endorsements."
|
must delete all sections Entitled "Endorsements."
|
|
|
6. COLLECTIONS OF DOCUMENTS
|
6. COLLECTIONS OF DOCUMENTS
|
|
|
You may make a collection consisting of the Document and other
|
You may make a collection consisting of the Document and other
|
documents released under this License, and replace the individual
|
documents released under this License, and replace the individual
|
copies of this License in the various documents with a single copy
|
copies of this License in the various documents with a single copy
|
that is included in the collection, provided that you follow the
|
that is included in the collection, provided that you follow the
|
rules of this License for verbatim copying of each of the
|
rules of this License for verbatim copying of each of the
|
documents in all other respects.
|
documents in all other respects.
|
|
|
You may extract a single document from such a collection, and
|
You may extract a single document from such a collection, and
|
distribute it individually under this License, provided you insert
|
distribute it individually under this License, provided you insert
|
a copy of this License into the extracted document, and follow
|
a copy of this License into the extracted document, and follow
|
this License in all other respects regarding verbatim copying of
|
this License in all other respects regarding verbatim copying of
|
that document.
|
that document.
|
|
|
7. AGGREGATION WITH INDEPENDENT WORKS
|
7. AGGREGATION WITH INDEPENDENT WORKS
|
|
|
A compilation of the Document or its derivatives with other
|
A compilation of the Document or its derivatives with other
|
separate and independent documents or works, in or on a volume of
|
separate and independent documents or works, in or on a volume of
|
a storage or distribution medium, is called an "aggregate" if the
|
a storage or distribution medium, is called an "aggregate" if the
|
copyright resulting from the compilation is not used to limit the
|
copyright resulting from the compilation is not used to limit the
|
legal rights of the compilation's users beyond what the individual
|
legal rights of the compilation's users beyond what the individual
|
works permit. When the Document is included in an aggregate, this
|
works permit. When the Document is included in an aggregate, this
|
License does not apply to the other works in the aggregate which
|
License does not apply to the other works in the aggregate which
|
are not themselves derivative works of the Document.
|
are not themselves derivative works of the Document.
|
|
|
If the Cover Text requirement of section 3 is applicable to these
|
If the Cover Text requirement of section 3 is applicable to these
|
copies of the Document, then if the Document is less than one half
|
copies of the Document, then if the Document is less than one half
|
of the entire aggregate, the Document's Cover Texts may be placed
|
of the entire aggregate, the Document's Cover Texts may be placed
|
on covers that bracket the Document within the aggregate, or the
|
on covers that bracket the Document within the aggregate, or the
|
electronic equivalent of covers if the Document is in electronic
|
electronic equivalent of covers if the Document is in electronic
|
form. Otherwise they must appear on printed covers that bracket
|
form. Otherwise they must appear on printed covers that bracket
|
the whole aggregate.
|
the whole aggregate.
|
|
|
8. TRANSLATION
|
8. TRANSLATION
|
|
|
Translation is considered a kind of modification, so you may
|
Translation is considered a kind of modification, so you may
|
distribute translations of the Document under the terms of section
|
distribute translations of the Document under the terms of section
|
4. Replacing Invariant Sections with translations requires special
|
4. Replacing Invariant Sections with translations requires special
|
permission from their copyright holders, but you may include
|
permission from their copyright holders, but you may include
|
translations of some or all Invariant Sections in addition to the
|
translations of some or all Invariant Sections in addition to the
|
original versions of these Invariant Sections. You may include a
|
original versions of these Invariant Sections. You may include a
|
translation of this License, and all the license notices in the
|
translation of this License, and all the license notices in the
|
Document, and any Warranty Disclaimers, provided that you also
|
Document, and any Warranty Disclaimers, provided that you also
|
include the original English version of this License and the
|
include the original English version of this License and the
|
original versions of those notices and disclaimers. In case of a
|
original versions of those notices and disclaimers. In case of a
|
disagreement between the translation and the original version of
|
disagreement between the translation and the original version of
|
this License or a notice or disclaimer, the original version will
|
this License or a notice or disclaimer, the original version will
|
prevail.
|
prevail.
|
|
|
If a section in the Document is Entitled "Acknowledgements",
|
If a section in the Document is Entitled "Acknowledgements",
|
"Dedications", or "History", the requirement (section 4) to
|
"Dedications", or "History", the requirement (section 4) to
|
Preserve its Title (section 1) will typically require changing the
|
Preserve its Title (section 1) will typically require changing the
|
actual title.
|
actual title.
|
|
|
9. TERMINATION
|
9. TERMINATION
|
|
|
You may not copy, modify, sublicense, or distribute the Document
|
You may not copy, modify, sublicense, or distribute the Document
|
except as expressly provided for under this License. Any other
|
except as expressly provided for under this License. Any other
|
attempt to copy, modify, sublicense or distribute the Document is
|
attempt to copy, modify, sublicense or distribute the Document is
|
void, and will automatically terminate your rights under this
|
void, and will automatically terminate your rights under this
|
License. However, parties who have received copies, or rights,
|
License. However, parties who have received copies, or rights,
|
from you under this License will not have their licenses
|
from you under this License will not have their licenses
|
terminated so long as such parties remain in full compliance.
|
terminated so long as such parties remain in full compliance.
|
|
|
10. FUTURE REVISIONS OF THIS LICENSE
|
10. FUTURE REVISIONS OF THIS LICENSE
|
|
|
The Free Software Foundation may publish new, revised versions of
|
The Free Software Foundation may publish new, revised versions of
|
the GNU Free Documentation License from time to time. Such new
|
the GNU Free Documentation License from time to time. Such new
|
versions will be similar in spirit to the present version, but may
|
versions will be similar in spirit to the present version, but may
|
differ in detail to address new problems or concerns. See
|
differ in detail to address new problems or concerns. See
|
`http://www.gnu.org/copyleft/'.
|
`http://www.gnu.org/copyleft/'.
|
|
|
Each version of the License is given a distinguishing version
|
Each version of the License is given a distinguishing version
|
number. If the Document specifies that a particular numbered
|
number. If the Document specifies that a particular numbered
|
version of this License "or any later version" applies to it, you
|
version of this License "or any later version" applies to it, you
|
have the option of following the terms and conditions either of
|
have the option of following the terms and conditions either of
|
that specified version or of any later version that has been
|
that specified version or of any later version that has been
|
published (not as a draft) by the Free Software Foundation. If
|
published (not as a draft) by the Free Software Foundation. If
|
the Document does not specify a version number of this License,
|
the Document does not specify a version number of this License,
|
you may choose any version ever published (not as a draft) by the
|
you may choose any version ever published (not as a draft) by the
|
Free Software Foundation.
|
Free Software Foundation.
|
|
|
ADDENDUM: How to use this License for your documents
|
ADDENDUM: How to use this License for your documents
|
====================================================
|
====================================================
|
|
|
To use this License in a document you have written, include a copy of
|
To use this License in a document you have written, include a copy of
|
the License in the document and put the following copyright and license
|
the License in the document and put the following copyright and license
|
notices just after the title page:
|
notices just after the title page:
|
|
|
Copyright (C) YEAR YOUR NAME.
|
Copyright (C) YEAR YOUR NAME.
|
Permission is granted to copy, distribute and/or modify this document
|
Permission is granted to copy, distribute and/or modify this document
|
under the terms of the GNU Free Documentation License, Version 1.2
|
under the terms of the GNU Free Documentation License, Version 1.2
|
or any later version published by the Free Software Foundation;
|
or any later version published by the Free Software Foundation;
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
Texts. A copy of the license is included in the section entitled ``GNU
|
Texts. A copy of the license is included in the section entitled ``GNU
|
Free Documentation License''.
|
Free Documentation License''.
|
|
|
If you have Invariant Sections, Front-Cover Texts and Back-Cover
|
If you have Invariant Sections, Front-Cover Texts and Back-Cover
|
Texts, replace the "with...Texts." line with this:
|
Texts, replace the "with...Texts." line with this:
|
|
|
with the Invariant Sections being LIST THEIR TITLES, with
|
with the Invariant Sections being LIST THEIR TITLES, with
|
the Front-Cover Texts being LIST, and with the Back-Cover Texts
|
the Front-Cover Texts being LIST, and with the Back-Cover Texts
|
being LIST.
|
being LIST.
|
|
|
If you have Invariant Sections without Cover Texts, or some other
|
If you have Invariant Sections without Cover Texts, or some other
|
combination of the three, merge those two alternatives to suit the
|
combination of the three, merge those two alternatives to suit the
|
situation.
|
situation.
|
|
|
If your document contains nontrivial examples of program code, we
|
If your document contains nontrivial examples of program code, we
|
recommend releasing these examples in parallel under your choice of
|
recommend releasing these examples in parallel under your choice of
|
free software license, such as the GNU General Public License, to
|
free software license, such as the GNU General Public License, to
|
permit their use in free software.
|
permit their use in free software.
|
|
|
|
|
File: libgomp.info, Node: Funding, Next: Index, Prev: GNU Free Documentation License, Up: Top
|
File: libgomp.info, Node: Funding, Next: Index, Prev: GNU Free Documentation License, Up: Top
|
|
|
Funding Free Software
|
Funding Free Software
|
*********************
|
*********************
|
|
|
If you want to have more free software a few years from now, it makes
|
If you want to have more free software a few years from now, it makes
|
sense for you to help encourage people to contribute funds for its
|
sense for you to help encourage people to contribute funds for its
|
development. The most effective approach known is to encourage
|
development. The most effective approach known is to encourage
|
commercial redistributors to donate.
|
commercial redistributors to donate.
|
|
|
Users of free software systems can boost the pace of development by
|
Users of free software systems can boost the pace of development by
|
encouraging for-a-fee distributors to donate part of their selling price
|
encouraging for-a-fee distributors to donate part of their selling price
|
to free software developers--the Free Software Foundation, and others.
|
to free software developers--the Free Software Foundation, and others.
|
|
|
The way to convince distributors to do this is to demand it and
|
The way to convince distributors to do this is to demand it and
|
expect it from them. So when you compare distributors, judge them
|
expect it from them. So when you compare distributors, judge them
|
partly by how much they give to free software development. Show
|
partly by how much they give to free software development. Show
|
distributors they must compete to be the one who gives the most.
|
distributors they must compete to be the one who gives the most.
|
|
|
To make this approach work, you must insist on numbers that you can
|
To make this approach work, you must insist on numbers that you can
|
compare, such as, "We will donate ten dollars to the Frobnitz project
|
compare, such as, "We will donate ten dollars to the Frobnitz project
|
for each disk sold." Don't be satisfied with a vague promise, such as
|
for 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 basis
|
"A portion of the profits are donated," since it doesn't give a basis
|
for comparison.
|
for comparison.
|
|
|
Even a precise fraction "of the profits from this disk" is not very
|
Even a precise fraction "of the profits from this disk" is not very
|
meaningful, since creative accounting and unrelated business decisions
|
meaningful, since creative accounting and unrelated business decisions
|
can greatly alter what fraction of the sales price counts as profit.
|
can 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 less
|
If the price you pay is $50, ten percent of the profit is probably less
|
than a dollar; it might be a few cents, or nothing at all.
|
than a dollar; it might be a few cents, or nothing at all.
|
|
|
Some redistributors do development work themselves. This is useful
|
Some redistributors do development work themselves. This is useful
|
too; but to keep everyone honest, you need to inquire how much they do,
|
too; but to keep everyone honest, you need to inquire how much they do,
|
and what kind. Some kinds of development make much more long-term
|
and what kind. Some kinds of development make much more long-term
|
difference than others. For example, maintaining a separate version of
|
difference than others. For example, maintaining a separate version of
|
a program contributes very little; maintaining the standard version of a
|
a program contributes very little; maintaining the standard version of a
|
program for the whole community contributes much. Easy new ports
|
program for the whole community contributes much. Easy new ports
|
contribute little, since someone else would surely do them; difficult
|
contribute little, since someone else would surely do them; difficult
|
ports such as adding a new CPU to the GNU Compiler Collection
|
ports such as adding a new CPU to the GNU Compiler Collection
|
contribute more; major new features or packages contribute the most.
|
contribute more; major new features or packages contribute the most.
|
|
|
By establishing the idea that supporting further development is "the
|
By establishing the idea that supporting further development is "the
|
proper thing to do" when distributing free software for a fee, we can
|
proper thing to do" when distributing free software for a fee, we can
|
assure a steady flow of resources into making more free software.
|
assure a steady flow of resources into making more free software.
|
|
|
Copyright (C) 1994 Free Software Foundation, Inc.
|
Copyright (C) 1994 Free Software Foundation, Inc.
|
Verbatim copying and redistribution of this section is permitted
|
Verbatim copying and redistribution of this section is permitted
|
without royalty; alteration is not permitted.
|
without royalty; alteration is not permitted.
|
|
|
|
|
File: libgomp.info, Node: Index, Prev: Funding, Up: Top
|
File: libgomp.info, Node: Index, Prev: Funding, Up: Top
|
|
|
Index
|
Index
|
*****
|
*****
|
|
|
[index ]
|
[index ]
|
* Menu:
|
* Menu:
|
|
|
* Environment Variable <1>: GOMP_STACKSIZE. (line 6)
|
* Environment Variable <1>: GOMP_STACKSIZE. (line 6)
|
* Environment Variable <2>: GOMP_CPU_AFFINITY. (line 6)
|
* Environment Variable <2>: GOMP_CPU_AFFINITY. (line 6)
|
* Environment Variable <3>: OMP_SCHEDULE. (line 6)
|
* Environment Variable <3>: OMP_SCHEDULE. (line 6)
|
* Environment Variable <4>: OMP_NUM_THREADS. (line 6)
|
* Environment Variable <4>: OMP_NUM_THREADS. (line 6)
|
* Environment Variable <5>: OMP_NESTED. (line 6)
|
* Environment Variable <5>: OMP_NESTED. (line 6)
|
* Environment Variable: OMP_DYNAMIC. (line 6)
|
* Environment Variable: OMP_DYNAMIC. (line 6)
|
* FDL, GNU Free Documentation License: GNU Free Documentation License.
|
* FDL, GNU Free Documentation License: GNU Free Documentation License.
|
(line 6)
|
(line 6)
|
* Implementation specific setting <1>: GOMP_STACKSIZE. (line 6)
|
* Implementation specific setting <1>: GOMP_STACKSIZE. (line 6)
|
* Implementation specific setting <2>: OMP_SCHEDULE. (line 6)
|
* Implementation specific setting <2>: OMP_SCHEDULE. (line 6)
|
* Implementation specific setting <3>: OMP_NUM_THREADS. (line 6)
|
* Implementation specific setting <3>: OMP_NUM_THREADS. (line 6)
|
* Implementation specific setting <4>: OMP_NESTED. (line 6)
|
* Implementation specific setting <4>: OMP_NESTED. (line 6)
|
* Implementation specific setting: OMP_DYNAMIC. (line 6)
|
* Implementation specific setting: OMP_DYNAMIC. (line 6)
|
* Introduction: Top. (line 6)
|
* Introduction: Top. (line 6)
|
|
|
|
|
|
|
Tag Table:
|
Tag Table:
|
Node: Top2111
|
Node: Top2111
|
Node: Enabling OpenMP3305
|
Node: Enabling OpenMP3305
|
Node: Runtime Library Routines4090
|
Node: Runtime Library Routines4090
|
Node: omp_get_dynamic5791
|
Node: omp_get_dynamic5791
|
Node: omp_get_max_threads6635
|
Node: omp_get_max_threads6635
|
Node: omp_get_nested7291
|
Node: omp_get_nested7291
|
Node: omp_get_num_procs8199
|
Node: omp_get_num_procs8199
|
Node: omp_get_num_threads8713
|
Node: omp_get_num_threads8713
|
Node: omp_get_thread_num9785
|
Node: omp_get_thread_num9785
|
Node: omp_in_parallel10574
|
Node: omp_in_parallel10574
|
Node: omp_set_dynamic11218
|
Node: omp_set_dynamic11218
|
Node: omp_set_nested12041
|
Node: omp_set_nested12041
|
Node: omp_set_num_threads12906
|
Node: omp_set_num_threads12906
|
Node: omp_init_lock13741
|
Node: omp_init_lock13741
|
Node: omp_set_lock14394
|
Node: omp_set_lock14394
|
Node: omp_test_lock15243
|
Node: omp_test_lock15243
|
Node: omp_unset_lock16269
|
Node: omp_unset_lock16269
|
Node: omp_destroy_lock17195
|
Node: omp_destroy_lock17195
|
Node: omp_init_nest_lock17865
|
Node: omp_init_nest_lock17865
|
Node: omp_set_nest_lock18597
|
Node: omp_set_nest_lock18597
|
Node: omp_test_nest_lock19506
|
Node: omp_test_nest_lock19506
|
Node: omp_unset_nest_lock20604
|
Node: omp_unset_nest_lock20604
|
Node: omp_destroy_nest_lock21613
|
Node: omp_destroy_nest_lock21613
|
Node: omp_get_wtick22361
|
Node: omp_get_wtick22361
|
Node: omp_get_wtime22948
|
Node: omp_get_wtime22948
|
Node: Environment Variables23731
|
Node: Environment Variables23731
|
Node: OMP_DYNAMIC24444
|
Node: OMP_DYNAMIC24444
|
Node: OMP_NESTED25001
|
Node: OMP_NESTED25001
|
Node: OMP_NUM_THREADS25595
|
Node: OMP_NUM_THREADS25595
|
Node: OMP_SCHEDULE26167
|
Node: OMP_SCHEDULE26167
|
Node: GOMP_CPU_AFFINITY26815
|
Node: GOMP_CPU_AFFINITY26815
|
Node: GOMP_STACKSIZE27367
|
Node: GOMP_STACKSIZE27367
|
Node: The libgomp ABI28141
|
Node: The libgomp ABI28141
|
Node: Implementing MASTER construct28939
|
Node: Implementing MASTER construct28939
|
Node: Implementing CRITICAL construct29352
|
Node: Implementing CRITICAL construct29352
|
Node: Implementing ATOMIC construct30100
|
Node: Implementing ATOMIC construct30100
|
Node: Implementing FLUSH construct30581
|
Node: Implementing FLUSH construct30581
|
Node: Implementing BARRIER construct30852
|
Node: Implementing BARRIER construct30852
|
Node: Implementing THREADPRIVATE construct31121
|
Node: Implementing THREADPRIVATE construct31121
|
Node: Implementing PRIVATE clause31773
|
Node: Implementing PRIVATE clause31773
|
Node: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses32354
|
Node: Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses32354
|
Node: Implementing REDUCTION clause33669
|
Node: Implementing REDUCTION clause33669
|
Node: Implementing PARALLEL construct34225
|
Node: Implementing PARALLEL construct34225
|
Node: Implementing FOR construct35482
|
Node: Implementing FOR construct35482
|
Node: Implementing ORDERED construct37480
|
Node: Implementing ORDERED construct37480
|
Node: Implementing SECTIONS construct37786
|
Node: Implementing SECTIONS construct37786
|
Node: Implementing SINGLE construct38552
|
Node: Implementing SINGLE construct38552
|
Node: Reporting Bugs39214
|
Node: Reporting Bugs39214
|
Node: Copying39522
|
Node: Copying39522
|
Node: GNU Free Documentation License58732
|
Node: GNU Free Documentation License58732
|
Node: Funding81143
|
Node: Funding81143
|
Node: Index83660
|
Node: Index83660
|
|
|
End Tag Table
|
End Tag Table
|
|
|
