head 1.2; access; symbols RPM_4_2_1:1.1.1.5 RPM_4_2:1.1.1.5 RPM_4_1_1:1.1.1.5 RPM_4_1:1.1.1.4 RPM_4_0_5:1.1.1.3 RPM_4_0_4:1.1.1.2 RPM_4_0_3:1.1.1.1 RPM:1.1.1; locks; strict; comment @# @; 1.2 date 2008.01.02.09.53.28; author rse; state dead; branches; next 1.1; commitid z4cpSiAhOCXk5PLs; 1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches; next 1.1.1.2; 1.1.1.2 date 2002.01.08.00.30.09; author rse; state Exp; branches; next 1.1.1.3; 1.1.1.3 date 2003.01.18.13.48.59; author rse; state Exp; branches; next 1.1.1.4; 1.1.1.4 date 2001.12.06.00.08.05; author rse; state Exp; branches; next 1.1.1.5; 1.1.1.5 date 2003.01.18.14.04.57; author rse; state Exp; branches; next ; desc @@ 1.2 log @remove the ancient RPM 4.2.1 source tree copy @ text @ Berkeley DB: DbEnv::lock_stat

DbEnv::lock_stat

APIRef

#include <db_cxx.h>

int DbEnv::lock_stat(DB_LOCK_STAT **statp);

Description

The DbEnv::lock_stat method creates a statistical structure and copies a pointer to it into a user-specified memory location.

Statistical structures are created in allocated memory. If application-specific allocation routines have been declared (see DbEnv::set_alloc for more information), they are used to allocate the memory; otherwise, the library function malloc(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.

The lock region statistics are stored in a structure of type DB_LOCK_STAT. The following DB_LOCK_STAT fields will be filled in:

u_int32_t st_lastid;
The last allocated lock ID.
u_int32_t st_nmodes;
The number of lock modes.
u_int32_t st_maxlocks;
The maximum number of locks possible.
u_int32_t st_maxlockers;
The maximum number of lockers possible.
u_int32_t st_maxobjects;
The maximum number of objects possible.
u_int32_t st_nlocks;
The number of current locks.
u_int32_t st_maxnlocks;
The maximum number of locks at any one time.
u_int32_t st_nlockers;
The number of current lockers.
u_int32_t st_maxnlockers;
The maximum number of lockers at any one time.
u_int32_t st_nobjects;
The number of current objects.
u_int32_t st_maxnobjects;
The maximum number of objects at any one time.
u_int32_t st_nrequests;
The total number of locks requested.
u_int32_t st_nreleases;
The total number of locks released.
u_int32_t st_nnowaits;
The total number of lock requests that failed because DB_LOCK_NOWAIT was set.
u_int32_t st_nconflicts;
The total number of locks not immediately available due to conflicts.
u_int32_t st_ndeadlocks;
The number of deadlocks detected.
u_int32_t st_regsize;
The size of the region.
u_int32_t st_region_wait;
The number of times that a thread of control was forced to wait before obtaining the region lock.
u_int32_t st_region_nowait;
The number of times that a thread of control was able to obtain the region lock without waiting.

The DbEnv::lock_stat method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

Errors

The DbEnv::lock_stat method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the DbEnv::lock_stat method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

Class

DbEnv, DbLock

See Also

DbEnv::set_lk_conflicts, DbEnv::set_lk_detect, DbEnv::set_lk_max, DbEnv::set_lk_max_lockers, DbEnv::set_lk_max_locks, DbEnv::set_lk_max_objects, DbEnv::lock_detect, DbEnv::lock_get, DbEnv::lock_id, DbLock::put, DbEnv::lock_stat, and DbEnv::lock_vec.

APIRef

Copyright Sleepycat Software @ 1.1 log @Initial revision @ text @d1 1 a1 1 @ 1.1.1.1 log @Import: RPM 4.0.3 @ text @@ 1.1.1.2 log @Import: RPM 4.0.4 @ text @d1 1 a1 1 d17 1 a17 1 APIRef d25 1 a25 1 DbEnv::lock_stat(DB_LOCK_STAT **statp, u_int32_t flags); a30 5

The flags value must be set to 0 or the following value:

DB_STAT_CLEAR
Reset statistics after returning their values.
a57 4
u_int32_t st_nlocktimeouts;
The number of locks that have timed out.
u_int32_t st_ntxntimeouts;
The number of transactions that have timed out. This value is also a component of st_ndeadlocks, the total number of deadlocks detected. d77 1 d84 1 a84 2 DbEnv::lock_id_free, DbEnv::lock_put, d90 1 a90 1 APIRef @ 1.1.1.3 log @Import: RPM 4.0.5 @ text @d1 2 a2 2 a3 1 d28 3 a30 1

The DbEnv::lock_stat method returns the locking subsystem statistics. a35 3

The DbEnv::lock_stat method creates a statistical structure of type DB_LOCK_STAT and copies a pointer to it into a user-specified memory location. d39 1 a39 1 library malloc(3) interface is used. The caller is d43 2 a44 1

The following DB_LOCK_STAT fields will be filled in: d46 1 a46 2

u_int32_t st_id;
The last allocated locker ID.
u_int32_t st_cur_maxid;
The current maximum unused locker ID. d50 1 a50 1
u_int32_t st_maxobjects;
The maximum number of lock objects possible. d55 2 a56 2
u_int32_t st_nobjects;
The number of current lock objects.
u_int32_t st_maxnobjects;
The maximum number of lock objects at any one time. d59 1 a59 1
u_int32_t st_nnowaits;
The total number of lock requests failing because d62 1 a62 2
u_int32_t st_ndeadlocks;
The number of deadlocks.
u_int32_t st_locktimeout;
Lock timeout value. a63 1
u_int32_t st_txntimeout;
Transaction timeout value. d67 1 a67 1
u_int32_t st_regsize;
The size of the lock region. d77 4 a80 4 If a catastrophic error has occurred, the DbEnv::lock_stat method may fail and either return DB_RUNRECOVERY or throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way. d82 1 a82 1 DbEnv, DbLock d84 13 a96 1 Locking Subsystem and Related Methods @ 1.1.1.4 log @Import: RPM 4.1 @ text @d1 2 a2 2 d4 1 d29 1 a29 3

The DbEnv::lock_stat method creates a statistical structure and copies a pointer to it into a user-specified memory location. d35 3 d41 1 a41 1 library function malloc(3) is used. The caller is d45 1 a45 2

The lock region statistics are stored in a structure of type DB_LOCK_STAT. The following DB_LOCK_STAT fields will be filled in: d47 2 a48 1

u_int32_t st_lastid;
The last allocated lock ID. d52 1 a52 1
u_int32_t st_maxobjects;
The maximum number of objects possible. d57 2 a58 2
u_int32_t st_nobjects;
The number of current objects.
u_int32_t st_maxnobjects;
The maximum number of objects at any one time. d61 1 a61 1
u_int32_t st_nnowaits;
The total number of lock requests that failed because d64 2 a65 1
u_int32_t st_ndeadlocks;
The number of deadlocks detected. d67 1 d71 1 a71 1
u_int32_t st_regsize;
The size of the region. d81 4 a84 4 If a catastrophic error has occurred, the DbEnv::lock_stat method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way. d86 1 a86 1 DbEnv, DbLock d88 1 a88 13 DbEnv::set_lk_conflicts, DbEnv::set_lk_detect, DbEnv::set_lk_max_lockers, DbEnv::set_lk_max_locks, DbEnv::set_lk_max_objects, DbEnv::lock_detect, DbEnv::lock_get, DbEnv::lock_id, DbEnv::lock_id_free, DbEnv::lock_put, DbEnv::lock_stat, and DbEnv::lock_vec. @ 1.1.1.5 log @Import: RPM 4.1.1 @ text @d1 2 a2 2 a3 1 d28 3 a30 1

The DbEnv::lock_stat method returns the locking subsystem statistics. a35 3

The DbEnv::lock_stat method creates a statistical structure of type DB_LOCK_STAT and copies a pointer to it into a user-specified memory location. d39 1 a39 1 library malloc(3) interface is used. The caller is d43 2 a44 1

The following DB_LOCK_STAT fields will be filled in: d46 1 a46 2

u_int32_t st_id;
The last allocated locker ID.
u_int32_t st_cur_maxid;
The current maximum unused locker ID. d50 1 a50 1
u_int32_t st_maxobjects;
The maximum number of lock objects possible. d55 2 a56 2
u_int32_t st_nobjects;
The number of current lock objects.
u_int32_t st_maxnobjects;
The maximum number of lock objects at any one time. d59 1 a59 1
u_int32_t st_nnowaits;
The total number of lock requests failing because d62 1 a62 2
u_int32_t st_ndeadlocks;
The number of deadlocks.
u_int32_t st_locktimeout;
Lock timeout value. a63 1
u_int32_t st_txntimeout;
Transaction timeout value. d67 1 a67 1
u_int32_t st_regsize;
The size of the lock region. d77 4 a80 4 If a catastrophic error has occurred, the DbEnv::lock_stat method may fail and either return DB_RUNRECOVERY or throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way. d82 1 a82 1 DbEnv, DbLock d84 13 a96 1 Locking Subsystem and Related Methods @