File: pvm_setopt.3

package info (click to toggle)
pvm 3.4beta7-4
  • links: PTS
  • area: main
  • in suites: slink
  • size: 5,256 kB
  • ctags: 5,938
  • sloc: ansic: 66,147; makefile: 1,446; fortran: 631; sh: 424; csh: 70; asm: 37
file content (213 lines) | stat: -rw-r--r-- 7,042 bytes parent folder | download | duplicates (5)
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
.\" $Id: pvm_setopt.3,v 1.1 1996/09/23 22:06:17 pvmsrc Exp $
.TH SETOPT 3PVM "4 April, 1994" "" "PVM Version 3.4"
.SH NAME
pvm_setopt \- Sets libpvm options.

.SH SYNOPSIS
.nf
.ft B
C	int oldval = pvm_setopt( int what, int val )
.br

Fortran	call pvmfsetopt( what, val, oldval )
.fi

.SH PARAMETERS
.IP what 0.8i
Integer defining what to set.  One of:
.nf
PvmRoute            1    Message routing policy
PvmDebugMask        2    Libpvm debug mask
PvmAutoErr          3    Auto error reporting
PvmOutputTid        4    Stdout destination for children
PvmOutputCode       5    Output message tag
PvmTraceTid         6    Trace data destination for children
PvmTraceCode        7    Trace message tag
PvmFragSize         8    Message fragment size
PvmResvTids         9    Allow messages to reserved tags and TIDs
PvmSelfOutputTid   10    Stdout destination
PvmSelfOutputCode  11    Output message tag
PvmSelfTraceTid    12    Trace data destination
PvmSelfTraceCode   13    Trace message tag
PvmShowTids        14    pvm_catchout prints task ids with output
PvmPollType        15    Message wait policy (shared memory)
PvmPollTime        16    Message spinwait duration
.fi
.br
.IP val
Integer specifying new setting of option.
Predefined values for \fIPvmRoute\fR are:
.nf
PvmDontRoute        1    Don't request or grant connections
PvmAllowDirect      2    (Default) Don't request but allow
PvmRouteDirect      3    Request and allow connections
.fi
.br
.IP oldval
Integer returning the previous setting of the option.

.SH DESCRIPTION
The routine
.I pvm_setopt
is a general purpose function used to set
miscellaneous options in the PVM library.
\fIWhat\fR is one of:
.sp
.IP PvmRoute
Advises PVM on whether
to set up direct task-to-task links
.I PvmRouteDirect
(using TCP) for all subsequent communication.
Once a link is established it persists until the application finishes.
If a direct link can not be established because one of the two tasks
has requested
.I PvmDontRoute
or because adequate resources aren't available,
then the default route through the PVM daemons is used.
On multiprocessors such as Intel Paragon this option is ignored
because the communication between tasks on these machines
always uses the native protocol for direct communication.
pvm_setopt can be called multiple times to selectively establish
direct links,
but is typically set only once near the beginning of each task.
.I PvmAllowDirect
is the default route setting.
This setting on task A allows other tasks to set up direct links to A.
Once a direct link is established between tasks
both tasks will use it for sending messages.
.sp
.IP PvmDebugMask
When debugging is turned on, PVM will log detailed information
about its operations and progress on its \fIstderr\fR stream.
\fIval\fR is the debugging level.
Default is not to print any debug information.
.PP
.IP PvmAutoErr
When an error results from a libpvm function call
and \fIPvmAutoErr\fR is set to 1 (the default),
an error message is automatically printed on \fIstderr\fR.
A setting of 0 disables this.
A setting of 2 causes the library to terminate the task by calling exit()
after printing the error message.
A setting of 3 causes the library to abort
after printing the error message.
.sp
.IP PvmOutputTid
Sets the \fIstdout\fR destination for children tasks
(spawned after the call to pvm_setopt).
Everything printed on the standard output of
tasks spawned by the calling task is
packed into messages and sent to the destination.
\fIval\fR is the TID of a PVM task.
Setting PvmOutputTid to
0 redirects stdout to the master pvmd,
which writes to the log file /tmp/pvml.<uid>
The default setting is inherited from the parent task,
else is 0.
.sp
.IP PvmOutputCode
Sets the message tag for standard output messages.
Should only be set when a task has \fIPvmOutputTid\fR set to itself.
.sp
.IP PvmTraceTid
Sets the trace data message destination for children tasks
(spawned after the call to pvm_setopt).
Libpvm trace data is sent as messages to the destination.
\fIval\fR is the TID of a PVM task.
Setting PvmTraceTid to 0
discards trace data.
The default setting is inherited from the parent task,
else is 0.
.sp
.IP PvmTraceCode
Sets the message tag for trace data messages.
Should only be set when a task has \fIPvmTraceTid\fR set to itself.
.sp
.IP PvmFragSize
\fIVal\fR specifies the message fragment size in bytes.
Default value varies with host architecture.
.sp
.IP PvmResvTids
A \fIval\fR of 1 enables the task to send messages with reserved
tags and to non-task destinations.
The default (0) causes libpvm to generate a \fIPvmBadParam\fR error
when a reserved identifier is specified.
.sp
.IP PvmSelfOutputTid
Sets the \fIstdout\fR destination for the task.
Everything printed on \fIstdout\fR
is
packed into messages and sent to the destination.
Note:
this only works for spawned tasks,
because the pvmd doesn't get the output from tasks started by other
means.
\fIval\fR is the TID of a PVM task.
Setting PvmSelfOutputTid to
0 redirects stdout to the master pvmd,
which writes to the log file /tmp/pvml.<uid>.
The default setting is inherited from the parent task,
else is 0.
Setting either PvmSelfOutputTid
or PvmSelfOutputCode
also causes both \fIPvmOutputTid\fR
and \fIPvmOutputCode\fR to take
on the values of PvmSelfOutputTid and PvmSelfOutputCode,
respectively.
.sp
.IP PvmSelfOutputCode
Sets the message tag for standard output messages.
.sp
.IP PvmSelfTraceTid
Sets the trace data message destination for the task.
Libpvm trace data is sent as messages to the destination.
\fIval\fR is the TID of a PVM task.
Setting PvmSelfTraceTid to 0
discards trace data.
The default setting is inherited from the parent task,
else is 0.
Setting either PvmSelfTraceTid
or PvmSelfTraceCode
also causes both \fIPvmTraceTid\fR
and \fIPvmTraceCode\fR to take
on the values of PvmSelfTraceTid and PvmSelfTraceCode,
respectively.
.sp
.IP PvmSelfTraceCode
Sets the message tag for trace data messages.
.sp
.IP PvmShowTids
If true (nonzero), \fIpvm_catchout\fR tags each line of output printed
by a child task with the task id.
Otherwise, output is exactly as printed.
.sp
.IP PvmPollType
Sets the message wait policy when using shared-memory message transport.
Setting PvmPollType to PvmPollConstant
causes the application to spin on its message queue waiting for a message.
Setting PvmPollType to PvmPollSleep causes the application to poll the message
queue for messages PvmPollTime times before pending on the semaphore.
.sp
.IP PvmPollTime
Sets the poll count for applications checking their message queue before they
pend on the semaphore.  This option is ignored if PvmPollType is set to
PvmPollConstant.
.PP
pvm_setopt returns the previous value of the option.
If an error occurs,
the PVM error code is returned in place of the option value.

.SH EXAMPLES
.nf
C:
	oldval = pvm_setopt( PvmRoute, PvmRouteDirect );
Fortran:
	CALL PVMFSETOPT( PVMAUTOERR, 1, OLDVAL )

.SH ERRORS
This error condition can be returned
.IP PvmBadParam
giving an invalid value.
.PP
.SH SEE ALSO
pvm_getopt(3PVM)