File: thmonitor.html

package info (click to toggle)
swi-prolog 7.2.3%2Bdfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 84,180 kB
  • ctags: 45,684
  • sloc: ansic: 330,358; perl: 268,104; sh: 6,795; java: 4,904; makefile: 4,561; cpp: 4,153; ruby: 1,594; yacc: 843; xml: 82; sed: 12; sql: 6
file content (329 lines) | stat: -rw-r--r-- 8,409 bytes parent folder | download
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html>
<head>
<title>SWI-Prolog 7.3.6 Reference Manual: Section 9.2</title><link rel="home" href="index.html">
<link rel="contents" href="Contents.html">
<link rel="index" href="DocIndex.html">
<link rel="summary" href="summary.html">
<link rel="previous" href="threadcreate.html">
<link rel="next" href="threadcom.html">

<style type="text/css">

/* Style sheet for SWI-Prolog latex2html
*/

dd.defbody
{ margin-bottom: 1em;
}

dt.pubdef, dt.multidef
{ color: #fff;
padding: 2px 10px 0px 10px;
margin-bottom: 5px;
font-size: 18px;
vertical-align: middle;
overflow: hidden;
}

dt.pubdef { background-color: #0c3d6e; }
dt.multidef { background-color: #ef9439; }

.bib dd
{ margin-bottom: 1em;
}

.bib dt
{ float: left;
margin-right: 1.3ex;
}

pre.code
{ margin-left: 1.5em;
margin-right: 1.5em;
border: 1px dotted;
padding-top: 5px;
padding-left: 5px;
padding-bottom: 5px;
background-color: #f8f8f8;
}

div.navigate
{ text-align: center;
background-color: #f0f0f0;
border: 1px dotted;
padding: 5px;
}

div.title
{ text-align: center;
padding-bottom: 1em;
font-size: 200%;
font-weight: bold;
}

div.author
{ text-align: center;
font-style: italic;
}

div.abstract
{ margin-top: 2em;
background-color: #f0f0f0;
border: 1px dotted;
padding: 5px;
margin-left: 10%; margin-right:10%;
}

div.abstract-title
{ text-align: center;
padding: 5px;
font-size: 120%;
font-weight: bold;
}

div.toc-h1
{ font-size: 200%;
font-weight: bold;
}

div.toc-h2
{ font-size: 120%;
font-weight: bold;
margin-left: 2em;
}

div.toc-h3
{ font-size: 100%;
font-weight: bold;
margin-left: 4em;
}

div.toc-h4
{ font-size: 100%;
margin-left: 6em;
}

span.sec-nr
{
}

span.sec-title
{
}

span.pred-ext
{ font-weight: bold;
}

span.pred-tag
{ float: right;
padding-top: 0.2em;
font-size: 80%;
font-style: italic;
color: #fff;
}

div.caption
{ width: 80%;
margin: auto;
text-align:center;
}

/* Footnotes */
.fn {
color: red;
font-size: 70%;
}

.fn-text, .fnp {
position: absolute;
top: auto;
left: 10%;
border: 1px solid #000;
box-shadow: 5px 5px 5px #888;
display: none;
background: #fff;
color: #000;
margin-top: 25px;
padding: 8px 12px;
font-size: larger;
}

sup:hover span.fn-text
{ display: block;
}

/* Lists */

dl.latex
{ margin-top: 1ex;
margin-bottom: 0.5ex;
}

dl.latex dl.latex dd.defbody
{ margin-bottom: 0.5ex;
}

/* PlDoc Tags */

dl.tags
{ font-size: 90%;
margin-left: 5ex;
margin-top: 1ex;
margin-bottom: 0.5ex;
}

dl.tags dt
{ margin-left: 0pt;
font-weight: bold;
}

dl.tags dd
{ margin-left: 3ex;
}

td.param
{ font-style: italic;
font-weight: bold;
}

/* Index */

dt.index-sep
{ font-weight: bold;
font-size: +1;
margin-top: 1ex;
}

/* Tables */

table.center
{ margin: auto;
}

table.latex
{ border-collapse:collapse;
}

table.latex tr
{ vertical-align: text-top;
}

table.latex td,th
{ padding: 2px 1em;
}

table.latex tr.hline td,th
{ border-top: 1px solid black;
}

table.frame-box
{ border: 2px solid black;
}

</style>
</head>
<body style="background:white">
<div class="navigate"><a class="nav" href="index.html"><img src="home.gif" alt="Home"></a>
<a class="nav" href="Contents.html"><img src="index.gif" alt="Contents"></a>
<a class="nav" href="DocIndex.html"><img src="yellow_pages.gif" alt="Index"></a>
<a class="nav" href="summary.html"><img src="info.gif" alt="Summary"></a>
<a class="nav" href="threadcreate.html"><img src="prev.gif" alt="Previous"></a>
<a class="nav" href="threadcom.html"><img src="next.gif" alt="Next"></a>
</div>
<h2 id="sec:thmonitor"><a id="sec:9.2"><span class="sec-nr">9.2</span> <span class="sec-title">Monitoring 
threads</span></a></h2>

<a id="sec:thmonitor"></a>

<p>Normal multithreaded applications should not need the predicates from 
this section because almost any usage of these predicates is unsafe. For 
example checking the existence of a thread before signalling it is of no 
use as it may vanish between the two calls. Catching exceptions using <a id="idx:catch3:1732"></a><a class="pred" href="exception.html#catch/3">catch/3</a> 
is the only safe way to deal with thread-existence errors.

<p>These predicates are provided for diagnosis and monitoring tasks. See 
also <a class="sec" href="thutil.html">section 9.5</a>, describing more 
high-level primitives.

<dl class="latex">
<dt class="pubdef"><a id="thread_property/2"><strong>thread_property</strong>(<var>?Id, 
?Property</var>)</a></dt>
<dd class="defbody">
True if thread <var>Id</var> has <var>Property</var>. Either or both 
arguments may be unbound, enumerating all relations on backtracking. 
Calling <a id="idx:threadproperty2:1733"></a><a class="pred" href="thmonitor.html#thread_property/2">thread_property/2</a> 
does not influence any thread. See also
<a id="idx:threadjoin2:1734"></a><a class="pred" href="threadcreate.html#thread_join/2">thread_join/2</a>. 
For threads that have an alias name, this name is returned in <var>Id</var> 
instead of the opaque thread identifier. Defined properties are:

<dl class="latex">
<dt><strong>alias</strong>(<var>Alias</var>)</dt>
<dd class="defbody">
<var>Alias</var> is the alias name of thread <var>Id</var>.
</dd>
<dt><strong>detached</strong>(<var>Boolean</var>)</dt>
<dd class="defbody">
Current detached status of the thread.
</dd>
<dt><strong>status</strong>(<var>Status</var>)</dt>
<dd class="defbody">
Current status of the thread. <var>Status</var> is one of:

<dl class="latex">
<dt><strong>running</strong></dt>
<dd class="defbody">
The thread is running. This is the initial status of a thread. Please 
note that threads waiting for something are considered running too.</dd>
<dt><strong>false</strong></dt>
<dd class="defbody">
The <var>Goal</var> of the thread has been completed and failed.</dd>
<dt><strong>true</strong></dt>
<dd class="defbody">
The <var>Goal</var> of the thread has been completed and succeeded.</dd>
<dt><strong>exited</strong>(<var>Term</var>)</dt>
<dd class="defbody">
The <var>Goal</var> of the thread has been terminated using <a id="idx:threadexit1:1735"></a><a class="pred" href="threadcreate.html#thread_exit/1">thread_exit/1</a> 
with <var>Term</var> as argument. If the underlying native thread has 
exited (using pthread_exit()) <var>Term</var> is unbound.</dd>
<dt><strong>exception</strong>(<var>Term</var>)</dt>
<dd class="defbody">
The <var>Goal</var> of the thread has been terminated due to an uncaught 
exception (see <a id="idx:throw1:1736"></a><a class="pred" href="exception.html#throw/1">throw/1</a> 
and <a id="idx:catch3:1737"></a><a class="pred" href="exception.html#catch/3">catch/3</a>).
</dd>
</dl>

</dd>
</dl>

<p>See also <a id="idx:threadstatistics3:1738"></a><a class="pred" href="thmonitor.html#thread_statistics/3">thread_statistics/3</a> 
to obtain resource usage information and
<a id="idx:messagequeueproperty2:1739"></a><a class="pred" href="threadcom.html#message_queue_property/2">message_queue_property/2</a> 
to get the number of queued messages for a thread.</dd>
<dt class="pubdef"><a id="thread_statistics/3"><strong>thread_statistics</strong>(<var>+Id, 
+Key, -Value</var>)</a></dt>
<dd class="defbody">
Obtains statistical information on thread <var>Id</var> as <a id="idx:statistics2:1740"></a><a class="pred" href="statistics.html#statistics/2">statistics/2</a> 
does in single-threaded applications. This call supports all keys of <a id="idx:statistics2:1741"></a><a class="pred" href="statistics.html#statistics/2">statistics/2</a>, 
although only stack sizes, <code>cputime</code>,
<code>inferences</code> and <code>epoch</code> yield different values 
for each thread.<sup class="fn">144<span class="fn-text">There is no 
portable interface to obtain thread-specific CPU time and some operating 
systems provide no access to this information at all. On such systems 
the total process CPU is returned. Thread CPU time is supported on 
MS-Windows, Linux and MacOSX.</span></sup></dd>
<dt class="pubdef"><a id="mutex_statistics/0"><strong>mutex_statistics</strong></a></dt>
<dd class="defbody">
Print usage statistics on internal mutexes and mutexes associated with 
dynamic predicates. For each mutex two numbers are printed: the number 
of times the mutex was acquired and the number of <em>collisions</em>: 
the number of times the calling thread has to wait for the mutex. 
Generally collision count is close to zero on single-CPU hardware.
</dd>
</dl>

<p></body></html>