File: shmem_global_exit.3in

package info (click to toggle)
openmpi 3.1.3-11
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 118,572 kB
  • sloc: ansic: 628,972; f90: 17,993; makefile: 13,761; sh: 7,051; java: 6,360; perl: 3,215; cpp: 2,225; python: 1,350; lex: 988; fortran: 52; tcl: 12
file content (47 lines) | stat: -rw-r--r-- 1,501 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
.\" -*- nroff -*-
.\" Copyright (c) 2015      University of Houston.  All rights reserved.
.\" Copyright (c) 2015      Mellanox Technologies, Inc.
.\" $COPYRIGHT$
.de Vb
.ft CW
.nf
..
.de Ve
.ft R

.fi
..
.TH "SHMEM\\_GLOBAL\\_EXIT" "3" "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME

shmem_global_exit
\- A routine that allows any PE to force termination of an entire program.
.SH SYNOPSIS

C or C++:
.Vb
#include <mpp/shmem.h>
void shmem_global_exit(int status);
.Ve
Fortran:
.Vb
include 'mpp/shmem.fh'
INTEGER STATUS
CALL SHMEM_GLOBAL_EXIT(status)
.Ve
.SH DESCRIPTION

shmem_global_exit()
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 shmem_global_exit, it results in
the immediate notification to all PEs to terminate. 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 shmem_global_exit, then the exit status returned to the environment shall be one of the values
passed to shmem_global_exit as the status argument. There is no return to the caller of shmem_global_exit;
control is returned from the OpenSHMEM program to the execution environment for all PEs.
.SH SEE ALSO

\fIintro_shmem\fP(3),
\fIshmem_my_pe\fP(3),
\fIshmem_init\fP(3)