← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_c/memp_stat.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_c/memp_stat.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DB_ENV-&gt;memp_stat</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DB_ENV-&gt;memp_stat</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db.h&gt;
24
 
<p>
25
 
int
26
 
DB_ENV-&gt;memp_stat(DB_ENV *env, DB_MPOOL_STAT **gsp,
27
 
    DB_MPOOL_FSTAT *(*fsp)[], u_int32_t flags);
28
 
</pre></h3>
29
 
<h1>Description</h1>
30
 
<p>The DB_ENV-&gt;memp_stat and <a href="../api_cxx/memp_stat.html">DbEnv::memp_fstat</a> methods return the memory pool
31
 
subsystem statistics.
32
 
<p>The <b>flags</b> value must be set to 0 or
33
 
the following value:
34
 
<p><dl compact>
35
 
<p><dt><a name="DB_STAT_CLEAR">DB_STAT_CLEAR</a><dd>Reset statistics after returning their values.
36
 
</dl>
37
 
<p>The DB_ENV-&gt;memp_stat and <a href="../api_cxx/memp_stat.html">DbEnv::memp_fstat</a> methods create statistical
38
 
structures of type DB_MPOOL_STAT and DB_MPOOL_FSTAT, and copy pointers
39
 
to them into user-specified memory locations.  The memory pool region
40
 
statistics are stored in the DB_MPOOL_STAT structure and the per-file
41
 
memory pool statistics are stored the DB_MPOOL_FSTAT structure.
42
 
<p>Statistical structures are created in allocated memory.  If application-specific allocation
43
 
routines have been declared (see <a href="../api_c/env_set_alloc.html">DB_ENV-&gt;set_alloc</a> for more
44
 
information), they are used to allocate the memory; otherwise, the
45
 
library <b>malloc</b>(3) interface is used.  The caller is
46
 
responsible for deallocating the memory.  To deallocate the memory, free
47
 
the memory reference; references inside the returned memory need not be
48
 
individually freed.
49
 
<p>If <b>gsp</b> is non-NULL, the global statistics for the memory pool
50
 
<b>mp</b> are copied into the memory location to which it refers.  The
51
 
following DB_MPOOL_STAT fields will be filled in:
52
 
<p><dl compact>
53
 
<dt>size_t st_gbytes;<dd>Gigabytes of cache (total cache size is st_gbytes + st_bytes).
54
 
<dt>size_t st_bytes;<dd>Bytes of cache (total cache size is st_gbytes + st_bytes).
55
 
<dt>u_int32_t st_ncache;<dd>Number of caches.
56
 
<dt>u_int32_t st_regsize;<dd>Individual cache size.
57
 
<dt>u_int32_t st_map;<dd>Requested pages mapped into the process' address space (there is no
58
 
available information about whether or not this request caused disk I/O,
59
 
although examining the application page fault rate may be helpful).
60
 
<dt>u_int32_t st_cache_hit;<dd>Requested pages found in the cache.
61
 
<dt>u_int32_t st_cache_miss;<dd>Requested pages not found in the cache.
62
 
<dt>u_int32_t st_page_create;<dd>Pages created in the cache.
63
 
<dt>u_int32_t st_page_in;<dd>Pages read into the cache.
64
 
<dt>u_int32_t st_page_out;<dd>Pages written from the cache to the backing file.
65
 
<dt>u_int32_t st_ro_evict;<dd>Clean pages forced from the cache.
66
 
<dt>u_int32_t st_rw_evict;<dd>Dirty pages forced from the cache.
67
 
<dt>u_int32_t st_page_trickle;<dd>Dirty pages written using the <a href="../api_c/memp_trickle.html">DB_ENV-&gt;memp_trickle</a> interface.
68
 
<dt>u_int32_t st_pages;<dd>Pages in the cache.
69
 
<dt>u_int32_t st_page_clean;<dd>Clean pages currently in the cache.
70
 
<dt>u_int32_t st_page_dirty;<dd>Dirty pages currently in the cache.
71
 
<dt>u_int32_t st_hash_buckets;<dd>Number of hash buckets in buffer hash table.
72
 
<dt>u_int32_t st_hash_searches;<dd>Total number of buffer hash table lookups.
73
 
<dt>u_int32_t st_hash_longest;<dd>The longest chain ever encountered in buffer hash table lookups.
74
 
<dt>u_int32_t st_hash_examined;<dd>Total number of hash elements traversed during hash table lookups.
75
 
<dt>u_int32_t st_hash_nowait;<dd>The number of times that a thread of control was able to obtain a hash
76
 
bucket lock without waiting.
77
 
<dt>u_int32_t st_hash_wait;<dd>The number of times that a thread of control was forced to wait before
78
 
obtaining a hash bucket lock.
79
 
<dt>u_int32_t st_hash_max_wait;<dd>The maximum number of times any hash bucket lock was waited for by a
80
 
thread of control.
81
 
<dt>u_int32_t st_region_wait;<dd>The number of times that a thread of control was forced to wait before
82
 
obtaining a region lock.
83
 
<dt>u_int32_t st_region_nowait;<dd>The number of times that a thread of control was able to obtain a region
84
 
lock without waiting.
85
 
<dt>u_int32_t st_alloc;<dd>Number of page allocations.
86
 
<dt>u_int32_t st_alloc_buckets;<dd>Number of hash buckets checked during allocation.
87
 
<dt>u_int32_t st_alloc_max_buckets;<dd>Maximum number of hash buckets checked during an allocation.
88
 
<dt>u_int32_t st_alloc_pages;<dd>Number of pages checked during allocation.
89
 
<dt>u_int32_t st_alloc_max_pages;<dd>Maximum number of pages checked during an allocation.
90
 
</dl>
91
 
<p>If <b>fsp</b> is non-NULL, a pointer to a NULL-terminated
92
 
variable length array of statistics for individual files, in the memory
93
 
pool <b>mp</b>, is copied into the memory location to which it refers.
94
 
If no individual files currently exist in the memory pool, <b>fsp</b>
95
 
will be set to NULL.
96
 
<p>The per-file statistics are stored in structures of type DB_MPOOL_FSTAT.
97
 
The following DB_MPOOL_FSTAT fields will be filled in for each file in
98
 
the pool; that is, each element of the array:
99
 
<p><dl compact>
100
 
<dt>char *file_name;<dd>The name of the file.
101
 
<dt>size_t st_pagesize;<dd>Page size in bytes.
102
 
<dt>u_int32_t st_cache_hit;<dd>Requested pages found in the cache.
103
 
<dt>u_int32_t st_cache_miss;<dd>Requested pages not found in the cache.
104
 
<dt>u_int32_t st_map;<dd>Requested pages mapped into the process' address space.
105
 
<dt>u_int32_t st_page_create;<dd>Pages created in the cache.
106
 
<dt>u_int32_t st_page_in;<dd>Pages read into the cache.
107
 
<dt>u_int32_t st_page_out;<dd>Pages written from the cache to the backing file.
108
 
</dl>
109
 
<p>The DB_ENV-&gt;memp_stat method returns a non-zero error value on failure and 0 on success.
110
 
<h1>Errors</h1>
111
 
<p>The DB_ENV-&gt;memp_stat method may fail and return a non-zero error for the following conditions:
112
 
<p><dl compact>
113
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
114
 
</dl>
115
 
<p>The DB_ENV-&gt;memp_stat method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
116
 
If a catastrophic error has occurred, the DB_ENV-&gt;memp_stat method may fail and
117
 
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
118
 
in which case all subsequent Berkeley DB calls will fail in the same way.
119
 
<h1>Class</h1>
120
 
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/mempfile_class.html">DB_MPOOLFILE</a>
121
 
<h1>See Also</h1>
122
 
<a href="../api_c/memp_list.html">Memory Pools and Related Methods</a>
123
 
</tt>
124
 
<table width="100%"><tr><td><br></td><td align=right>
125
 
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
126
 
</td></tr></table>
127
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
128
 
</body>
129
 
</html>