# DbEnv::memp_stat

`

###

    #include <db_cxx.h>

    int
    DbEnv::memp_stat(DB_MPOOL_STAT **gsp,
        DB_MPOOL_FSTAT *(*fsp)[], u_int32_t flags);

# Description

The DbEnv::memp_stat method method creates statistical structures and copies pointers to them into user-specified memory locations. The statistics include the number of files participating in the pool, the active pages in the pool, and information about how effective the cache has been.

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

DB_STAT_CLEAR
  Reset statistics after returning their values.

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.

If gsp is non-NULL, the global statistics for the memory pool mp are copied into the memory location to which it refers. The global statistics are stored in a structure of type DB_MPOOL_STAT.

The following DB_MPOOL_STAT fields will be filled in:

size_t st_gbytes;
  Gigabytes of cache (total cache size is st_gbytes + st_bytes).
size_t st_bytes;
  Bytes of cache (total cache size is st_gbytes + st_bytes).
u_int32_t st_ncache;
  Number of caches.
u_int32_t st_regsize;
  Individual cache size.
u_int32_t st_cache_hit;
  Requested pages found in the cache.
u_int32_t st_cache_miss;
  Requested pages not found in the cache.
u_int32_t st_map;
  Requested pages mapped into the process' address space (there is no available information about whether or not this request caused disk I/O, although examining the application page fault rate may be helpful).
u_int32_t st_page_create;
  Pages created in the cache.
u_int32_t st_page_in;
  Pages read into the cache.
u_int32_t st_page_out;
  Pages written from the cache to the backing file.
u_int32_t st_ro_evict;
  Clean pages forced from the cache.
u_int32_t st_rw_evict;
  Dirty pages forced from the cache.
u_int32_t st_hash_buckets;
  Number of hash buckets in buffer hash table.
u_int32_t st_hash_searches;
  Total number of buffer hash table lookups.
u_int32_t st_hash_longest;
  The longest chain ever encountered in buffer hash table lookups.
u_int32_t st_hash_examined;
  Total number of hash elements traversed during hash table lookups.
u_int32_t st_page_clean;
  Clean pages currently in the cache.
u_int32_t st_page_dirty;
  Dirty pages currently in the cache.
u_int32_t st_page_trickle;
  Dirty pages written using the DbEnv::memp_trickle interface.
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.

If fsp is non-NULL, a pointer to a NULL-terminated variable length array of statistics for individual files, in the memory pool mp, is copied into the memory location to which it refers. If no individual files currently exist in the memory pool, fsp will be set to NULL.

The per-file statistics are stored in structures of type DB_MPOOL_FSTAT. The following DB_MPOOL_FSTAT fields will be filled in for each file in the pool; that is, each element of the array:

char *file_name;
  The name of the file.
size_t st_pagesize;
  Page size in bytes.
u_int32_t st_cache_hit;
  Requested pages found in the cache.
u_int32_t st_cache_miss;
  Requested pages not found in the cache.
u_int32_t st_map;
  Requested pages mapped into the process' address space.
u_int32_t st_page_create;
  Pages created in the cache.
u_int32_t st_page_in;
  Pages read into the cache.
u_int32_t st_page_out;
  Pages written from the cache to the backing file.

The DbEnv::memp_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::memp_stat method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

The DbEnv::memp_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::memp_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, DbMpoolFile

# See Also

DbEnv::set_cachesize, DbEnv::set_mp_mmapsize, DbEnv::memp_fcreate, DbMpoolFile::close, DbMpoolFile::get, DbMpoolFile::open, DbMpoolFile::put, DbMpoolFile::set, DbMpoolFile::sync, DbEnv::memp_register, DbMpoolFile::set_clear_len, DbMpoolFile::set_fileid, DbMpoolFile::set_ftype, DbMpoolFile::set_lsn_offset, DbMpoolFile::set_pgcookie, DbEnv::memp_stat, DbEnv::memp_sync, and DbEnv::memp_trickle.`

Copyright Sleepycat Software