File: shmem_finalize.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,525 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\\_FINALIZE" "3" "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME

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.
.SH SYNOPSIS

C or C++:
.Vb
#include <mpp/shmem.h>
void shmem_finalize(void);
.Ve
Fortran:
.Vb
include 'mpp/shmem.fh'
CALL SHMEM_FINALIZE
.Ve
.SH DESCRIPTION

shmem_finalize
is a collective operation that ends the OpenSHMEM portion of a program previously initialized
by 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 shmem_finalize so that pending
communication is completed, and no resources can be released until all PEs have entered shmem_finalize.
shmem_finalize must be the last OpenSHMEM library call encountered in the OpenSHMEM portion of
a program. A call to shmem_finalize will release any resources initialized by a corresponding call to
shmem_init. All processes and threads that represent the PEs will still exist after the call to shmem_finalize
returns, but they will no longer have access to any resources that have been released.
.SH SEE ALSO

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