File: shmem_putmem_nbi.3.rst.txt

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 (174 lines) | stat: -rw-r--r-- 4,659 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
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
.. _shmem_putmem_nbi:


shmem_putmem_nbi
================

.. include_body

:ref:`shmem_putmem_nbi`\ (3), :ref:`shmem_char_put_nbi`\ (3),
:ref:`shmem_short_put_nbi`\ (3), :ref:`shmem_int_put_nbi`\ (3),
:ref:`shmem_long_put_nbi`\ (3), :ref:`shmem_longlong_put_nbi`\ (3),
:ref:`shmem_float_put_nbi`\ (3), :ref:`shmem_double_put_nbi`\ (3),
:ref:`shmem_longdouble_put_nbi`\ (3), :ref:`shmem_put8_nbi`\ (3),
:ref:`shmem_put16_nbi`\ (3), :ref:`shmem_put32_nbi`\ (3), :ref:`shmem_put64_nbi`\ (3),
:ref:`shmem_put128_nbi`\ (3), - The nonblocking put routines provide a method
for copying data from a contiguous local data object to a data object on
a specified PE.


SYNOPSIS
--------

C or C++:

.. code-block:: c++

   #include <mpp/shmem.h>

   void shmem_putmem_nbi(void *dest, const void *source,
     size_t nelems, int pe)

   void shmem_char_put(char *dest, const char *source,
     size_t nelems, int pe)

   void shmem_short_put(short *dest, const short *source,
     size_t nelems, int pe)

   void shmem_int_put(int *dest, const int *source,
     size_t nelems, int pe)

   void shmem_long_put(long *dest, const long *source,
     size_t nelems, int pe)

   void shmem_longlong_put(long long *dest, const long long *source,
     size_t nelems, int pe)

   void shmem_float_put(float *dest, const float *source,
     size_t nelems, int pe)

   void shmem_double_put(double *dest, const double *source,
     size_t nelems, int pe)

   void shmem_longdouble_put(long double *dest, const long double *source,
     size_t nelems, int pe)

   void shmem_put8(void *dest, const void *source,
     size_t nelems, int pe)

   void shmem_put16(void *dest, const void *source,
     size_t nelems, int pe)

   void shmem_put32(void *dest, const void *source,
     size_t nelems, int pe)

   void shmem_put64(void *dest, const void *source,
     size_t nelems, int pe)

   void shmem_put128(void *dest, const void *source,
     size_t nelems, int pe)

Fortran:

.. code-block:: fortran

   INCLUDE "mpp/shmem.fh"

   INTEGER nelems, pe

   CALL SHMEM_PUTMEM_NBI(dest, source, nelems, pe)

   CALL SHMEM_CHARACTER_PUT_NBI(dest, source, nelems, pe)

   CALL SHMEM_COMPLEX_PUT_NBI(dest, source, nelems, pe)

   CALL SHMEM_DOUBLE_PUT_NBI(dest, source, nelems, pe)

   CALL SHMEM_INTEGER_PUT_NBI(dest, source, nelems, pe)

   CALL SHMEM_LOGICAL_PUT_NBI(dest, source, nelems, pe)

   CALL SHMEM_REAL_PUT_NBI(dest, source, nelems, pe)

   CALL SHMEM_PUT4_NBI(dest, source, nelems, pe)

   CALL SHMEM_PUT8_NBI(dest, source, nelems, pe)

   CALL SHMEM_PUT32_NBI(dest, source, nelems, pe)

   CALL SHMEM_PUT64_NBI(dest, source, nelems, pe)

   CALL SHMEM_PUT128_NBI(dest, source, nelems, pe)


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

The routines return after posting the operation. The operation is
considered complete after a subsequent call to :ref:`shmem_quiet`. At the
completion of :ref:`shmem_quiet`, the data has been copied into the dest array
on the destination PE. The delivery of data words into the data object
on the destination PE may occur in any order. Furthermore, two
successive put routines may deliver data out of order unless a call to
:ref:`shmem_fence` is introduced between the two calls.

The arguments are as follows:

dest
   Data object to be updated on the remote PE. This data object must be
   remotely accessible.

source
   Data object containing the data to be copied.

nelems
   Number of elements in the dest and source arrays. nelems must be of
   type size_t for C. If you are using Fortran, it must be a constant,
   variable, or array element of default integer type.

pe
   PE number of the remote PE. pe must be of type integer. If you are
   using Fortran, it must be a constant, variable, or array element of
   default integer type.

If you are using Fortran, data types must be of default size. For
example, a real variable must be declared as REAL, REAL*4, or
REAL(KIND=4).


NOTES
-----

See *intro_shmem*\ (3) for a definition of the term remotely accessible.


EXAMPLES
--------

Consider this simple example for C.

.. code-block:: c

   #include <stdio.h>
   #include <mpp/shmem.h>

   main()
   {
     long source[10] = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
     static long target[10];
     shmem_init();

     if (shmem_my_pe() == 0) {
       /* put 10 words into target on PE 1 */
       shmem_long_put_nbi(target, source, 10, 1);
       shmem_quiet();
     }
     shmem_barrier_all();  /* sync sender and receiver */
     if (shmem_my_pe() == 1)
       shmem_udcflush();  /* not required on Altix systems */
     printf("target[0] on PE %d is %d\n", shmem_my_pe(), target[0]);
   }


.. seealso::
   *intro_shmem*\ (3) *shmem_quiet*\ (3)