File: shmem_finalize.3.rst

package info (click to toggle)
openmpi 5.0.8-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 201,692 kB
  • sloc: ansic: 613,078; makefile: 42,351; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (51 lines) | stat: -rw-r--r-- 1,422 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
.. _shmem_finalize:


shmem_finalize
==============

.. include_body

:ref:`shmem_finalize` - A collective operation that releases resources used by
the OpenSHMEM library. This only terminates the Open-SHMEM portion of a
program, not the entire program.


SYNOPSIS
--------

C or C++:

.. code-block:: c++

   #include <mpp/shmem.h>

   void shmem_finalize(void)

Fortran:

.. code-block:: fortran

   include 'mpp/shmem.fh'
   CALL SHMEM_FINALIZE


DESCRIPTION
-----------

:ref:`shmem_finalize` is a collective operation that ends the OpenSHMEM portion
of a program previously initialized by :ref:`shmem_init` and releases resources
used by the OpenSHMEM library. This collective operation requires all
PEs to participate in the call. There is an implicit global barrier in
:ref:`shmem_finalize` so that pending communication is completed, and no
resources can be released until all PEs have entered :ref:`shmem_finalize`.
:ref:`shmem_finalize` must be the last OpenSHMEM library call encountered in
the OpenSHMEM portion of a program. A call to :ref:`shmem_finalize` will
release any resources initialized by a corresponding call to :ref:`shmem_init`.
All processes and threads that represent the PEs will still exist after
the call to :ref:`shmem_finalize` returns, but they will no longer have access
to any resources that have been released.


.. seealso::
   *intro_shmem*\ (3) *shmem_my_pe*\ (3) *shmem_init*\ (3)