cr_info(3)

NAME

cr_info — retrieve crash dump information

SYNOPSIS

#include <libcrash.h>

cr_info_t *cr_info(CRASH *crash_cb);

DESCRIPTION

The cr_info() function returns a pointer to a cr_info_t structure with information about an open crash dump.

cr_info_t

The cr_info_t structure contains the following fields. Note that there is no necessary correlation between the placement in this list and the order in the structure, and the structure may contain other, reserved fields.

`char`	`*cri_hostname`	`Name of system dumped`
`char`	`*cri_model`	`Model string from system`
`char`	`*cri_panic`	`Panic message`
`char`	`*cri_release`	`Release string from system`
`char`	`*cri_dumptime`	`Time of the crash dump`
`char`	`*cri_savetime`	`Time crash dump saved`
`uint64_t`	`cri_chunksize`	`Size of uncompressed image files.`
`uint64_t`	`cri_memsize`	`Physical size of memory (bytes)`
`uint64_t`	`cri_num_err`	`Number of error messages`
`char`	`**cri_errmsg`	`Error messages from INDEX file`
`uint64_t`	`cri_num_warn`	`Number of warning messages`
`char`	`**cri_warnmsg`	`Warning messages from INDEX file`
`uint64_t`	`cri_num_mod`	`Number of module structures`
`cri_modinfo_t`	`*cri_modinfo`	`Array of module structures`

The fields cri_hostname, cri_model, cri_panic, cri_release, cri_dumptime, and cri_savetime are all null-terminated strings; respectively, representing the name and model of the system that dumped, the panic message, the release version string of the kernel, and the times that the system dumped and the dump was saved. The amount, in bytes, of physical memory on the system is in cri_memsize. The target size, in bytes, of individual uncompressed image files is in cri_chunksize. cri_errmsg and cri_warnmsg are arrays of null-terminated strings with the list of saved messages. cri_num_err and cri_num_warn are the number of strings in each list. cri_modinfo is an array of cri_modinfo_t structures defining the loaded kernel modules; there are cri_num_mod elements in the array.

cri_modinfo_t

The cri_modinfo_t structure contains information specific to kernel modules loaded into memory at the time of the system crash. The specific fields are:

`char`	`*mdi_loadpath`	`File path when loaded into memory`
`char`	`*mdi_savepath`	`File path when saved in crash directory`
`uint64_t`	`mdi_size`	`Size in bytes`
`uint64_t`	`mdi_checksum`	`Checksum of the file from cksum(1)`

Again, the order of these fields within the structure is not specified, and other reserved fields may be present in the structure.

The caller must not modify any information in any of the structures returned by cr_info().

RETURN VALUE

cr_info() returns a pointer to the cr_info_t structure described above. If crash_cb is not a valid descriptor of a crash dump opened with cr_open(), the return value is undefined.

EXAMPLES

Assuming a process opened a crash dump, the following call to cr_info(3) retrieves the information about the open crash dump.

#include <libcrash.h> 
  
CRASH *crshdes; 
cr_info_t *cri; 
  
cri = cr_info(crshdes); 

AUTHOR

cr_info() was developed by HP.

cr_info(3)

Technical documentation

» Table of Contents

» Index