File: shmem_global_exit.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,391 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_global_exit:


shmem_global_exit
=================

.. include_body

:ref:`shmem_global_exit` - A routine that allows any PE to force termination of
an entire program.


SYNOPSIS
--------

C or C++:

.. code-block:: c++

   #include <mpp/shmem.h>

   void shmem_global_exit(int status)

Fortran:

.. code-block:: fortran

   include 'mpp/shmem.fh'
   INTEGER STATUS
   CALL SHMEM_GLOBAL_EXIT(status)


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

shmem_global_exit() :ref:`shmem_global_exit` is a non-collective routine that
allows any one PE to force termination of an Open- SHMEM program for all
PEs, passing an exit status to the execution environment. This routine
terminates the entire program, not just the OpenSHMEM portion. When any
PE calls :ref:`shmem_global_exit`, it results in the immediate notification to
all PEs to terminate. :ref:`shmem_global_exit` flushes I/O and releases
resources in accordance with C/C++/Fortran language requirements for
normal program termination. If more than one PE calls :ref:`shmem_global_exit`,
then the exit status returned to the environment shall be one of the
values passed to :ref:`shmem_global_exit` as the status argument. There is no
return to the caller of :ref:`shmem_global_exit`; control is returned from the
OpenSHMEM program to the execution environment for all PEs.


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