File: shmem_udcflush.3

package info (click to toggle)
openmpi 5.0.8-4
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 201,684 kB
  • sloc: ansic: 613,078; makefile: 42,353; 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 (119 lines) | stat: -rw-r--r-- 3,086 bytes parent folder | download | duplicates (3)
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
.\" Man page generated from reStructuredText.
.
.TH "SHMEM_UDCFLUSH" "3" "May 30, 2025" "" "Open MPI"
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
\fI\%shmem_clear_cache_inv\fP(3), \fI\%shmem_set_cache_inv\fP(3),
\fI\%shmem_set_cache_line_inv\fP(3), \fI\%shmem_udcflush\fP(3),
\fI\%shmem_udcflush_line\fP(3) \- Controls data cache utilities
.SH SYNOPSIS
.sp
C or C++:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#include <mpp/shmem.h>

void shmem_clear_cache_inv(void)
void shmem_clear_cache_line_inv(void *target)
void shmem_set_cache_inv(void)
void shmem_set_cache_line_inv(void *target)
void shmem_udcflush(void)
void shmem_udcflush_line(void *target)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Fortran:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
INCLUDE "mpp/shmem.fh"

CALL SHMEM_CLEAR_CACHE_INV
CALL SHMEM_CLEAR_CACHE_LINE_INV(target)
CALL SHMEM_SET_CACHE_INV
CALL SHMEM_SET_CACHE_LINE_INV(target)

CALL SHMEM_UDCFLUSH
CALL SHMEM_UDCFLUSH_LINE(target)
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
The following argument is passed to the cache line control routines:
.INDENT 0.0
.TP
.B target
A data object that is local to the processing element (PE). target
can be of any noncharacter type. If you are using Fortran, it can be
of any kind.
.UNINDENT
.sp
\fI\%shmem_clear_cache_inv\fP disables automatic cache coherency mode
previously enabled by \fI\%shmem_set_cache_inv\fP or \fI\%shmem_set_cache_line_inv\fP\&.
.sp
\fI\%shmem_clear_cache_line_inv\fP disables automatic cache coherency mode
for the cache line associated with the address of \fBtarget\fP only.
.sp
\fI\%shmem_set_cache_inv\fP enables the OpenSHMEM API to automatically
decide the best strategy for cache coherency.
.sp
\fI\%shmem_set_cache_line_inv\fP enables automatic cache coherency mode for
the cache line associated with the address of \fBtarget\fP only.
.sp
\fI\%shmem_clear_cache_inv\fP disables automatic cache coherency mode
previously enabled by \fI\%shmem_set_cache_inv\fP or \fI\%shmem_set_cache_line_inv\fP\&.
.sp
\fI\%shmem_udcflush\fP makes the entire user data cache coherent.
.sp
\fI\%shmem_udcflush_line\fP makes coherent the cache line that corresponds
with the address specified by target.
.SH NOTES
.sp
These routines have been retained for improved backward compatibility
with legacy architectures.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fIintro_shmem\fP(3) \fIshmem_put\fP(3) \fIshmem_swap\fP(3)
.UNINDENT
.UNINDENT
.SH COPYRIGHT
2003-2025, The Open MPI Community
.\" Generated by docutils manpage writer.
.