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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DbEnv::lock_stat()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="lock.html" title="Chapter 7. The DbLock Handle" />
<link rel="prev" href="lockput.html" title="DbEnv::lock_put()" />
<link rel="next" href="lockstat_print.html" title="DbEnv::lock_stat_print()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::lock_stat()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="lockput.html">Prev</a> </td>
<th width="60%" align="center">Chapter 7.
The DbLock Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="lockstat_print.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="lockstat"></a>DbEnv::lock_stat()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbEnv::lock_stat(DB_LOCK_STAT **statp, u_int32_t flags); </pre>
<p>
The <code class="methodname">DbEnv::lock_stat()</code> method returns the locking subsystem
statistics.
</p>
<p>
The <code class="methodname">DbEnv::lock_stat()</code> method creates a statistical structure of
type DB_LOCK_STAT and copies a pointer to it into a user-specified
memory location.
</p>
<p>
Statistical structures are stored in allocated memory. If
application-specific allocation routines have been declared (see
<a class="xref" href="envset_alloc.html" title="DbEnv::set_alloc()">DbEnv::set_alloc()</a>
for more information), they are used to allocate the memory;
otherwise, the standard C library <span class="bold"><strong>malloc</strong></span>(3) is used. The caller is responsible
for deallocating the memory. To deallocate the memory, free the
memory reference; references inside the returned memory need not be
individually freed.
</p>
<p>
The following DB_LOCK_STAT fields will be filled in:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<span class="bold"><strong>u_int32_t st_cur_maxid;</strong></span>
</p>
<p>
The current maximum unused locker ID.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_hash_len;</strong></span>
</p>
<p>
Maximum length of a lock hash bucket.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_id;</strong></span>
</p>
<p>
The last allocated locker ID.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_initlocks;</strong></span>
</p>
<p>
The initial number of locks allocated in the lock
table.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_initlockers;</strong></span>
</p>
<p>
The initial number of lockers allocated in the lock
table.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_initobjects;</strong></span>
</p>
<p>
The initial number of lock objects allocated in the lock
table.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_lock_nowait;</strong></span>
</p>
<p>
The number of lock requests not immediately available due to
conflicts, for which the thread of control did not wait.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_lock_wait;</strong></span>
</p>
<p>
The number of lock requests not immediately available due to
conflicts, for which the thread of control waited.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_lockers_nowait;</strong></span>
</p>
<p>
The number of requests to allocate or deallocate a locker for which
the thread of control did not wait.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_lockers_wait;</strong></span>
</p>
<p>
The number of requests to allocate or deallocate a locker for which
the thread of control waited.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_lockers;</strong></span>
</p>
<p>
The current number of lockers allocated in the lock table.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_locks;</strong></span>
</p>
<p>
The current number of locks allocated in the lock table.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_locksteals;</strong></span>
</p>
<p>
The maximum number of locks stolen by an empty partition.
</p>
</li>
<li>
<p>
<span class="bold"><strong>db_timeout_t st_locktimeout;</strong></span>
</p>
<p>
Lock timeout value.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_maxhlocks;</strong></span>
</p>
<p>
The maximum number of locks in any hash bucket at any one time.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_maxhobjects;</strong></span>
</p>
<p>
The maximum number of objects in any hash bucket at any one time.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_maxlockers;</strong></span>
</p>
<p>
The maximum number of lockers possible.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_maxlocks;</strong></span>
</p>
<p>
The maximum number of locks possible.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_maxlsteals;</strong></span>
</p>
<p>
The maximum number of lock steals for any one partition.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_maxnlockers;</strong></span>
</p>
<p>
The maximum number of lockers at any one time.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_maxnobjects;</strong></span>
</p>
<p>
The maximum number of lock objects at any one time. Note that if there
is more than one partition this is the sum of the maximum across all
partitions.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_maxnlocks;</strong></span>
</p>
<p>
The maximum number of locks at any one time. Note that if there is
more than one partition, this is the sum of the maximum across all
partitions.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_maxobjects;</strong></span>
</p>
<p>
The maximum number of lock objects possible.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_maxosteals;</strong></span>
</p>
<p>
The maximum number of object steals for any one partition.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_ndeadlocks;</strong></span>
</p>
<p>
The number of deadlocks.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_ndowngrade;</strong></span>
</p>
<p>
The total number of locks downgraded.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_nlockers;</strong></span>
</p>
<p>
The number of current lockers.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_nlocks;</strong></span>
</p>
<p>
The number of current locks.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_nlocktimeouts;</strong></span>
</p>
<p>
The number of lock requests that have timed out.
</p>
</li>
<li>
<p>
<span class="bold"><strong>int st_nmodes;</strong></span>
</p>
<p>
The number of lock modes.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_nobjects;</strong></span>
</p>
<p>
The number of current lock objects.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_nreleases;</strong></span>
</p>
<p>
The total number of locks released.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_nrequests;</strong></span>
</p>
<p>
The total number of locks requested.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_ntxntimeouts;</strong></span>
</p>
<p>
The number of transactions that have timed out. This value is also a
component of <span class="bold"><strong>st_ndeadlocks</strong></span>, the total
number of deadlocks detected.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_nupgrade;</strong></span>
</p>
<p>
The total number of locks upgraded.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_objects;</strong></span>
</p>
<p>
The current number of lock objects allocated in the lock
table.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_objectsteals;</strong></span>
</p>
<p>
The maximum number of objects stolen by an empty partition.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_objs_nowait;</strong></span>
</p>
<p>
The number of requests to allocate or deallocate an object for which
the thread of control did not wait.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_objs_wait;</strong></span>
</p>
<p>
The number of requests to allocate or deallocate an object for which
the thread of control waited.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_part_max_nowait;</strong></span>
</p>
<p>
The number of times that a thread of control was able to obtain any
one lock partition mutex without waiting.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_part_max_wait;</strong></span>
</p>
<p>
The maximum number of times that a thread of control was forced to
wait before obtaining any one lock partition mutex.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_part_nowait;</strong></span>
</p>
<p>
The number of times that a thread of control was able to obtain the
lock partition mutex without waiting.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_part_wait;</strong></span>
</p>
<p>
The number of times that a thread of control was forced to wait before
obtaining the lock partition mutex.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_partitions;</strong></span>
</p>
<p>
The number of lock table partitions.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_region_nowait;</strong></span>
</p>
<p>
The number of times that a thread of control was able to obtain the
lock region mutex without waiting.
</p>
</li>
<li>
<p>
<span class="bold"><strong>uintmax_t st_region_wait;</strong></span>
</p>
<p>
The number of times that a thread of control was forced to wait before
obtaining the lock region mutex.
</p>
</li>
<li>
<p>
<span class="bold"><strong>roff_t st_regsize;</strong></span>
</p>
<p>
The region size, in bytes.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int32_t st_tablesize;</strong></span>
</p>
<p>
The size of the object hash table.
</p>
</li>
<li>
<p>
<span class="bold"><strong>db_timeout_t st_txntimeout;</strong></span>
</p>
<p>
Transaction timeout value.
</p>
</li>
</ul>
</div>
<p>
The <code class="methodname">DbEnv::lock_stat()</code> method may not be called before the
<a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> method is called.
</p>
<p>
The <code class="methodname">DbEnv::lock_stat()</code> method returns a non-zero error value on
failure and 0 on success.
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp8109680"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp8109528"></a>statp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>statp</strong></span> parameter references memory
into which a pointer to the allocated statistics structure is copied.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp8153976"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to 0
or the following value:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="stat_DB_STAT_CLEAR"></a>
<code class="literal">DB_STAT_CLEAR</code>
</p>
<p>
Reset statistics after returning their values.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp8158904"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::lock_stat()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp8166216"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp8164920"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>,
<a class="link" href="lock.html" title="Chapter 7. The DbLock Handle">DbLock</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp8167512"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="lockput.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="lock.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="lockstat_print.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::lock_put() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::lock_stat_print()</td>
</tr>
</table>
</div>
</body>
</html>
|
