librtasevent_src/librtasevent.h File Reference

Structure and Interface definitions for librtasevent. More...

#include <stdio.h>
#include <inttypes.h>
#include "librtasevent_v4.h"
#include "librtasevent_v6.h"

Go to the source code of this file.

Data Structures
struct	scn_header
struct	rtas_event
	Anchor structure for parsed RTAS events. More...
struct	rtas_date
	definition of date format in rtas events More...
struct	rtas_time
	definition of timestamp in rtas events More...
struct	rtas_event_hdr
	Fixed header at the beginning of all RTAS events. More...
struct	rtas_event_exthdr
	RTAS optional extended error log header (12 bytes). More...
struct	rtas_epow_scn
	Common RTAS EPOW section. More...
struct	rtas_io_scn
	RTAS i/o section. More...
Defines
#define	RE_SHDR_SZ   (sizeof(struct scn_header))
#define	RE_SHDR_OFFSET(x)   ((char *)(x) + RE_SHDR_SZ)
#define	RTAS_EVENT_HDR   1
#define	RTAS_EVENT_EXT_HDR   2
#define	RTAS_EPOW_SCN   3
#define	RTAS_IO_SCN   4
#define	RTAS_CPU_SCN   5
#define	RTAS_IBM_DIAG_SCN   6
#define	RTAS_MEM_SCN   7
#define	RTAS_POST_SCN   8
#define	RTAS_IBM_SP_SCN   9
#define	RTAS_VEND_ERRLOG_SCN   10
#define	RTAS_PRIV_HDR_SCN   11
#define	RTAS_USR_HDR_SCN   12
#define	RTAS_DUMP_SCN   13
#define	RTAS_LRI_SCN   14
#define	RTAS_MT_SCN   15
#define	RTAS_PSRC_SCN   16
#define	RTAS_SSRC_SCN   17
#define	RTAS_GENERIC_SCN   18
#define	RTAS_MAX_SCN_ID   19
#define	RE_EVENT_OFFSET(re)   ((re)->buffer + (re)->offset)
#define	RTAS_HDR_SEV_NO_ERROR   0
#define	RTAS_HDR_SEV_EVENT   1
#define	RTAS_HDR_SEV_WARNING   2
#define	RTAS_HDR_SEV_ERROR_SYNC   3
#define	RTAS_HDR_SEV_ERROR   4
#define	RTAS_HDR_SEV_FATAL   5
#define	RTAS_HDR_SEV_ALREADY_REPORTED   6
#define	RTAS_HDR_DISP_FULLY_RECOVERED   0
#define	RTAS_HDR_DISP_LIMITED_RECOVERY   1
#define	RTAS_HDR_DISP_NOT_RECOVERED   2
#define	RTAS_HDR_INIT_UNKNOWN   0
#define	RTAS_HDR_INIT_CPU   1
#define	RTAS_HDR_INIT_PCI   2
#define	RTAS_HDR_INIT_ISA   3
#define	RTAS_HDR_INIT_MEMORY   4
#define	RTAS_HDR_INIT_HOT_PLUG   5
#define	RTAS_HDR_TARGET_UNKNOWN   0
#define	RTAS_HDR_TARGET_CPU   1
#define	RTAS_HDR_TARGET_PCI   2
#define	RTAS_HDR_TARGET_ISA   3
#define	RTAS_HDR_TARGET_MEMORY   4
#define	RTAS_HDR_TARGET_HOT_PLUG   5
#define	RTAS_HDR_TYPE_RETRY   1
#define	RTAS_HDR_TYPE_TCE_ERR   2
#define	RTAS_HDR_TYPE_INTERN_DEV_FAIL   3
#define	RTAS_HDR_TYPE_TIMEOUT   4
#define	RTAS_HDR_TYPE_DATA_PARITY   5
#define	RTAS_HDR_TYPE_ADDR_PARITY   6
#define	RTAS_HDR_TYPE_CACHE_PARITY   7
#define	RTAS_HDR_TYPE_ADDR_INVALID   8
#define	RTAS_HDR_TYPE_ECC_UNCORRECTED   9
#define	RTAS_HDR_TYPE_ECC_CORRECTED   10
#define	RTAS_HDR_TYPE_EPOW   64
#define	RTAS_HDR_TYPE_PLATFORM_ERROR   224
#define	RTAS_HDR_TYPE_IBM_IO_EVENT   225
#define	RTAS_HDR_TYPE_PLATFORM_INFO   226
#define	RTAS_HDR_TYPE_RESOURCE_DEALLOC   227
#define	RTAS_HDR_TYPE_DUMP_NOTIFICATION   228
#define	RE_EVENT_HDR_SZ   8
#define	RTAS_EXTHDR_FMT_CPU   1
#define	RTAS_EXTHDR_FMT_MEMORY   2
#define	RTAS_EXTHDR_FMT_IO   3
#define	RTAS_EXTHDR_FMT_POST   4
#define	RTAS_EXTHDR_FMT_EPOW   5
#define	RTAS_EXTHDR_FMT_IBM_DIAG   12
#define	RTAS_EXTHDR_FMT_IBM_SP   13
#define	RTAS_EXTHDR_FMT_VEND_SPECIFIC_1   14
#define	RTAS_EXTHDR_FMT_VEND_SPECIFIC_2   15
#define	RE_EXT_HDR_SZ   12
#define	RTAS_EPOW_ACTION_RESET   0x00
#define	RTAS_EPOW_ACTION_WARN_COOLING   0x01
#define	RTAS_EPOW_ACTION_WARN_POWER   0x02
#define	RTAS_EPOW_ACTION_SYSTEM_SHUTDOWN   0x03
#define	RTAS_EPOW_ACTION_SYSTEM_HALT   0x04
#define	RTAS_EPOW_ACTION_MAIN_ENCLOSURE   0x05
#define	RTAS_EPOW_ACTION_POWER_OFF   0x07
#define	RTAS_EPOW_MOD_NA   0x00
#define	RTAS_EPOW_MOD_NORMAL_SHUTDOWN   0x01
#define	RTAS_EPOW_MOD_UTILITY_POWER_LOSS   0x02
#define	RTAS_EPOW_MOD_CRIT_FUNC_LOSS   0x03
#define	RE_EPOW_V6_SCN_SZ   20
#define	RTAS_IO_TYPE_DETECTED   0x01
#define	RTAS_IO_TYPE_RECOVERED   0x02
#define	RTAS_IO_TYPE_EVENT   0x03
#define	RTAS_IO_TYPE_RPC_PASS_THRU   0x04
#define	RTAS_IO_SCOPE_NA   0x00
#define	RTAS_IO_SCOPE_RIO_HUB   0x36
#define	RTAS_IO_SCOPE_RIO_BRIDGE   0x37
#define	RTAS_IO_SCOPE_PHB   0x38
#define	RTAS_IO_SCOPE_EADS_GLOBAL   0x39
#define	RTAS_IO_SCOPE_EADS_SLOT   0x3A
#define	RTAS_IO_SUBTYPE_NA   0x00
#define	RTAS_IO_SUBTYPE_REBALANCE   0x01
#define	RTAS_IO_SUBTYPE_NODE_ONLINE   0x02
#define	RTAS_IO_SUBTYPE_NODE_OFFLINE   0x04
#define	RE_IO_V6_SCN_OFFSET   (RE_SCN_HDR_SZ + RE_V4_SCN_SZ)
Functions
struct rtas_event *	parse_rtas_event (char *, int)
	parse an rtas event creating a populated rtas_event structure
int	cleanup_rtas_event (struct rtas_event *)
	free the structures related to a parsed rtas event
struct rtas_event_hdr *	rtas_get_event_hdr_scn (struct rtas_event *)
	Retrieve the Main RTAS event header.
struct rtas_event_exthdr *	rtas_get_event_exthdr_scn (struct rtas_event *)
	Retrieve the RTAS Event extended header.
struct rtas_epow_scn *	rtas_get_epow_scn (struct rtas_event *)
	Retrieve the Environmental and Power Warning (EPOW) section.
struct rtas_io_scn *	rtas_get_io_scn (struct rtas_event *)
	Retrieve the I/O section of the RTAS Event.
struct rtas_cpu_scn *	rtas_get_cpu_scn (struct rtas_event *)
	Retrieve the CPU section of the RTAS Event.
struct rtas_ibm_diag_scn *	rtas_get_ibmdiag_scn (struct rtas_event *)
struct rtas_mem_scn *	rtas_get_mem_scn (struct rtas_event *)
	Retrieve the Memory Detected failure section of the RTAS Event.
struct rtas_post_scn *	rtas_get_post_scn (struct rtas_event *)
	Retrieve the Power-On Self Test (POST) section of the RTAS Event.
struct rtas_ibmsp_scn *	rtas_get_ibm_sp_scn (struct rtas_event *)
	Retrieve the IBM Service Processor Log section of the RTAS Event.
struct rtas_vend_errlog_scn *	rtas_get_vend_errlog_scn (struct rtas_event *)
	retrive a vendor specific section of the RTAS event
struct rtas_priv_hdr_scn *	rtas_get_priv_hdr_scn (struct rtas_event *)
	retrieve the Private Header section of an RTAS Event
struct rtas_usr_hdr_scn *	rtas_get_usr_hdr_scn (struct rtas_event *)
	retrieve the User Header section for an RTAS event.
struct rtas_dump_scn *	rtas_get_dump_scn (struct rtas_event *)
	Retrieve the Dump Locator section of the RTAS Event.
struct rtas_lri_scn *	rtas_get_lri_scn (struct rtas_event *)
	Retrieve the Logical Resource ID (LRI) section of the RTAS Event.
struct rtas_mt_scn *	rtas_get_mt_scn (struct rtas_event *)
	retrieve the Failing Enclosure (MTMS) section of an RTAS Event
struct rtas_src_scn *	rtas_get_src_scn (struct rtas_event *)
	retrieve the RTAS src section for a RTAS event
int	update_os_id_scn (struct rtas_event *, const char *)
int	rtas_print_scn (FILE *, struct scn_header *, int)
	print the contents of the specified rtas event section
int	rtas_print_event (FILE *, struct rtas_event *, int)
	print the contents of an entire rtas event
int	rtas_print_raw_event (FILE *, struct rtas_event *)
	Dump the entire rtas event in raw format.
int	rtas_set_print_width (int)
	set the output character width for librtasevent

---

Detailed Description

This provides the structure and interface definitions for librtasevent. Also see librtasevent_v4.h and librtasevent_v6.h for additional structure definitions particular those event versions.

librtasevent usage: The librtasevent library is meant to place the structure definitions, parsing and printing of RTAS events into a common place. The use of librtasevent is easiest through the following interfaces:

parse_rtas_event() - This takes a buffer containing an RTAS event in binary form and returns a pointer to an rtas_event struct. This struct has a list of rtas_event_scn objects hanging off of it for each section of the rtas event.

This presents the user with a broken down representation of the RTAS event that can then be easily searched for any relevant information or passed to either rtas_print_event() to print the entire RTAS event or the rtas_print_event_scn() to print a particular section of the RTAS event.

When finished a call to rtas_cleanup_event() will free all of the data structuires associated with the RTAS event.

Copyright (C) 2005 IBM Corporation Common Public License Version 1.0 (see COPYRIGHT)

Author:

Nathan Fontenot <nfont@austin.ibm.com>

---

Define Documentation

#define RE_EPOW_V6_SCN_SZ   20

Referenced by parse_epow_scn().

#define RE_EVENT_HDR_SZ   8

Referenced by parse_rtas_event().

#define RE_EVENT_OFFSET

(

re

)

((re)->buffer + (re)->offset)

Referenced by parse_fru_id_scn(), and parse_io_scn().

#define RE_EXT_HDR_SZ   12

Referenced by parse_rtas_event().

#define RE_IO_V6_SCN_OFFSET   (RE_SCN_HDR_SZ + RE_V4_SCN_SZ)

#define RE_SHDR_OFFSET

(

x

)

((char *)(x) + RE_SHDR_SZ)

Referenced by parse_cpu_scn(), parse_dump_scn(), parse_epow_scn(), parse_generic_v6_scn(), parse_ibm_diag_scn(), parse_io_scn(), parse_lri_scn(), parse_mem_scn(), parse_mt_scn(), parse_post_scn(), parse_priv_hdr_scn(), parse_rtas_event(), parse_sp_scn(), parse_src_scn(), parse_usr_hdr_scn(), and parse_vend_errlog_scn().

#define RE_SHDR_SZ   (sizeof(struct scn_header))

Referenced by update_os_id_scn().

#define RTAS_CPU_SCN   5

Referenced by parse_cpu_scn(), parse_post_scn(), parse_sp_scn(), print_re_cpu_scn(), and rtas_get_cpu_scn().

#define RTAS_DUMP_SCN   13

Referenced by parse_dump_scn(), parse_v6_rtas_event(), print_re_dump_scn(), re_scn_id(), and rtas_get_dump_scn().

#define RTAS_EPOW_ACTION_MAIN_ENCLOSURE   0x05

#define RTAS_EPOW_ACTION_POWER_OFF   0x07

#define RTAS_EPOW_ACTION_RESET   0x00

#define RTAS_EPOW_ACTION_SYSTEM_HALT   0x04

#define RTAS_EPOW_ACTION_SYSTEM_SHUTDOWN   0x03

#define RTAS_EPOW_ACTION_WARN_COOLING   0x01

#define RTAS_EPOW_ACTION_WARN_POWER   0x02

#define RTAS_EPOW_MOD_CRIT_FUNC_LOSS   0x03

#define RTAS_EPOW_MOD_NA   0x00

#define RTAS_EPOW_MOD_NORMAL_SHUTDOWN   0x01

#define RTAS_EPOW_MOD_UTILITY_POWER_LOSS   0x02

#define RTAS_EPOW_SCN   3

Referenced by parse_epow_scn(), parse_v6_rtas_event(), print_re_epow_scn(), re_scn_id(), and rtas_get_epow_scn().

#define RTAS_EVENT_EXT_HDR   2

Referenced by parse_rtas_event(), print_re_exthdr_scn(), and rtas_get_event_exthdr_scn().

#define RTAS_EVENT_HDR   1

Referenced by parse_rtas_event(), print_re_hdr_scn(), and rtas_get_event_hdr_scn().

#define RTAS_EXTHDR_FMT_CPU   1

Referenced by parse_rtas_event().

#define RTAS_EXTHDR_FMT_EPOW   5

Referenced by parse_rtas_event().

#define RTAS_EXTHDR_FMT_IBM_DIAG   12

Referenced by parse_rtas_event().

#define RTAS_EXTHDR_FMT_IBM_SP   13

Referenced by parse_rtas_event().

#define RTAS_EXTHDR_FMT_IO   3

Referenced by parse_rtas_event().

#define RTAS_EXTHDR_FMT_MEMORY   2

Referenced by parse_rtas_event().

#define RTAS_EXTHDR_FMT_POST   4

Referenced by parse_rtas_event().

#define RTAS_EXTHDR_FMT_VEND_SPECIFIC_1   14

Referenced by parse_rtas_event().

#define RTAS_EXTHDR_FMT_VEND_SPECIFIC_2   15

Referenced by parse_rtas_event().

#define RTAS_GENERIC_SCN   18

Referenced by cleanup_rtas_event(), parse_generic_v6_scn(), and print_re_generic_scn().

#define RTAS_HDR_DISP_FULLY_RECOVERED   0

#define RTAS_HDR_DISP_LIMITED_RECOVERY   1

#define RTAS_HDR_DISP_NOT_RECOVERED   2

#define RTAS_HDR_INIT_CPU   1

#define RTAS_HDR_INIT_HOT_PLUG   5

#define RTAS_HDR_INIT_ISA   3

#define RTAS_HDR_INIT_MEMORY   4

#define RTAS_HDR_INIT_PCI   2

#define RTAS_HDR_INIT_UNKNOWN   0

#define RTAS_HDR_SEV_ALREADY_REPORTED   6

#define RTAS_HDR_SEV_ERROR   4

#define RTAS_HDR_SEV_ERROR_SYNC   3

#define RTAS_HDR_SEV_EVENT   1

#define RTAS_HDR_SEV_FATAL   5

#define RTAS_HDR_SEV_NO_ERROR   0

#define RTAS_HDR_SEV_WARNING   2

#define RTAS_HDR_TARGET_CPU   1

#define RTAS_HDR_TARGET_HOT_PLUG   5

#define RTAS_HDR_TARGET_ISA   3

#define RTAS_HDR_TARGET_MEMORY   4

#define RTAS_HDR_TARGET_PCI   2

#define RTAS_HDR_TARGET_UNKNOWN   0

#define RTAS_HDR_TYPE_ADDR_INVALID   8

#define RTAS_HDR_TYPE_ADDR_PARITY   6

#define RTAS_HDR_TYPE_CACHE_PARITY   7

#define RTAS_HDR_TYPE_DATA_PARITY   5

#define RTAS_HDR_TYPE_DUMP_NOTIFICATION   228

#define RTAS_HDR_TYPE_ECC_CORRECTED   10

#define RTAS_HDR_TYPE_ECC_UNCORRECTED   9

#define RTAS_HDR_TYPE_EPOW   64

#define RTAS_HDR_TYPE_IBM_IO_EVENT   225

#define RTAS_HDR_TYPE_INTERN_DEV_FAIL   3

#define RTAS_HDR_TYPE_PLATFORM_ERROR   224

#define RTAS_HDR_TYPE_PLATFORM_INFO   226

#define RTAS_HDR_TYPE_RESOURCE_DEALLOC   227

#define RTAS_HDR_TYPE_RETRY   1

#define RTAS_HDR_TYPE_TCE_ERR   2

#define RTAS_HDR_TYPE_TIMEOUT   4

#define RTAS_IBM_DIAG_SCN   6

Referenced by parse_ibm_diag_scn(), print_re_ibm_diag_scn(), and rtas_get_ibm_diag_scn().

#define RTAS_IBM_SP_SCN   9

Referenced by print_re_ibmsp_scn(), and rtas_get_ibm_sp_scn().

#define RTAS_IO_SCN   4

Referenced by parse_io_scn(), parse_v6_rtas_event(), print_re_io_scn(), re_scn_id(), and rtas_get_io_scn().

#define RTAS_IO_SCOPE_EADS_GLOBAL   0x39

#define RTAS_IO_SCOPE_EADS_SLOT   0x3A

#define RTAS_IO_SCOPE_NA   0x00

#define RTAS_IO_SCOPE_PHB   0x38

#define RTAS_IO_SCOPE_RIO_BRIDGE   0x37

#define RTAS_IO_SCOPE_RIO_HUB   0x36

#define RTAS_IO_SUBTYPE_NA   0x00

#define RTAS_IO_SUBTYPE_NODE_OFFLINE   0x04

#define RTAS_IO_SUBTYPE_NODE_ONLINE   0x02

#define RTAS_IO_SUBTYPE_REBALANCE   0x01

#define RTAS_IO_TYPE_DETECTED   0x01

#define RTAS_IO_TYPE_EVENT   0x03

#define RTAS_IO_TYPE_RECOVERED   0x02

#define RTAS_IO_TYPE_RPC_PASS_THRU   0x04

#define RTAS_LRI_SCN   14

Referenced by parse_lri_scn(), parse_v6_rtas_event(), print_re_lri_scn(), re_scn_id(), and rtas_get_lri_scn().

#define RTAS_MAX_SCN_ID   19

#define RTAS_MEM_SCN   7

Referenced by parse_mem_scn(), print_re_mem_scn(), and rtas_get_mem_scn().

#define RTAS_MT_SCN   15

Referenced by parse_mt_scn(), parse_v6_rtas_event(), print_re_mt_scn(), re_scn_id(), and rtas_get_mt_scn().

#define RTAS_POST_SCN   8

Referenced by print_re_post_scn(), and rtas_get_post_scn().

#define RTAS_PRIV_HDR_SCN   11

Referenced by parse_priv_hdr_scn(), print_re_priv_hdr_scn(), and rtas_get_priv_hdr_scn().

#define RTAS_PSRC_SCN   16

Referenced by cleanup_rtas_event(), parse_v6_rtas_event(), print_re_src_scn(), re_scn_id(), and rtas_get_src_scn().

#define RTAS_SSRC_SCN   17

Referenced by cleanup_rtas_event(), parse_v6_rtas_event(), print_re_src_scn(), and re_scn_id().

#define RTAS_USR_HDR_SCN   12

Referenced by parse_usr_hdr_scn(), print_re_usr_hdr_scn(), and rtas_get_usr_hdr_scn().

#define RTAS_VEND_ERRLOG_SCN   10

Referenced by cleanup_rtas_event(), parse_vend_errlog_scn(), print_re_vend_errlog_scn(), and rtas_get_vend_errlog_scn().

---

Function Documentation

int cleanup_rtas_event

(

struct rtas_event *

re

)

cleanup_rtas_event

Parameters:

re

rtas_event pointer

Returns:

0 on success, !0 on failure

References rtas_v6_generic::data, rtas_event::event_scns, rtas_src_scn::fru_scns, rtas_fru_hdr::next, rtas_fru_scn::next, scn_header::next, RTAS_GENERIC_SCN, RTAS_PSRC_SCN, RTAS_SSRC_SCN, RTAS_VEND_ERRLOG_SCN, scn_header::scn_id, rtas_fru_scn::subscns, and rtas_vend_errlog::vendor_data.

Referenced by parse_rtas_event(), parse_src_scn(), and parse_v6_rtas_event().

struct rtas_event* parse_rtas_event	(	char *	buf,
		int	buflen
	)			[read]

parse_rtas_event

Parameters:

	buf	buffer containing the binary RTAS event
	buflen	length of the buffer 'buf'

Returns:

pointer to rtas_event

References add_re_scn(), rtas_event::buffer, cleanup_rtas_event(), rtas_event::event_length, rtas_event::event_no, rtas_event_hdr::ext_log_length, rtas_event_hdr::extended, rtas_event_exthdr::format_type, rtas_event::offset, parse_cpu_scn(), parse_epow_scn(), parse_ibm_diag_scn(), parse_io_scn(), parse_mem_scn(), parse_post_scn(), parse_sp_scn(), parse_v6_rtas_event(), parse_vend_errlog_scn(), RE_EVENT_HDR_SZ, RE_EXT_HDR_SZ, RE_SHDR_OFFSET, rtas_copy(), RTAS_EVENT_EXT_HDR, RTAS_EVENT_HDR, RTAS_EXTHDR_FMT_CPU, RTAS_EXTHDR_FMT_EPOW, RTAS_EXTHDR_FMT_IBM_DIAG, RTAS_EXTHDR_FMT_IBM_SP, RTAS_EXTHDR_FMT_IO, RTAS_EXTHDR_FMT_MEMORY, RTAS_EXTHDR_FMT_POST, RTAS_EXTHDR_FMT_VEND_SPECIFIC_1, RTAS_EXTHDR_FMT_VEND_SPECIFIC_2, rtas_event_hdr::version, and rtas_event::version.

struct rtas_cpu_scn* rtas_get_cpu_scn

(

struct rtas_event *

re

)

[read]

rtas_get_cpu_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer for cpu section

References get_re_scn(), and RTAS_CPU_SCN.

struct rtas_dump_scn* rtas_get_dump_scn

(

struct rtas_event *

re

)

[read]

rtas_get_dump_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer to dump locator section

References get_re_scn(), and RTAS_DUMP_SCN.

Referenced by update_os_id_scn().

struct rtas_epow_scn* rtas_get_epow_scn

(

struct rtas_event *

re

)

[read]

rtas_get_epow_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer for the epow section

References get_re_scn(), and RTAS_EPOW_SCN.

struct rtas_event_exthdr* rtas_get_event_exthdr_scn

(

struct rtas_event *

re

)

[read]

rtas_get_event_exthdr_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer for RTAS extended header section

References get_re_scn(), and RTAS_EVENT_EXT_HDR.

struct rtas_event_hdr* rtas_get_event_hdr_scn

(

struct rtas_event *

re

)

[read]

rtas_get_event_hdr_scn

Parameters:

re

rtas_event pointer

Returns:

pointer to rtas_event_scn for main rtas event header

References get_re_scn(), and RTAS_EVENT_HDR.

struct rtas_ibmsp_scn* rtas_get_ibm_sp_scn

(

struct rtas_event *

re

)

[read]

rtas_get_ibm_sp_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer for IBM SP section

References get_re_scn(), and RTAS_IBM_SP_SCN.

struct rtas_ibm_diag_scn* rtas_get_ibmdiag_scn

(

struct rtas_event *

)

[read]

struct rtas_io_scn* rtas_get_io_scn

(

struct rtas_event *

re

)

[read]

rtas_get_io_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer for i/o section

References get_re_scn(), and RTAS_IO_SCN.

struct rtas_lri_scn* rtas_get_lri_scn

(

struct rtas_event *

re

)

[read]

rtas_get_lri_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer for lri section

References get_re_scn(), and RTAS_LRI_SCN.

struct rtas_mem_scn* rtas_get_mem_scn

(

struct rtas_event *

re

)

[read]

rtas_get_mem_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer for memory section

References get_re_scn(), and RTAS_MEM_SCN.

struct rtas_mt_scn* rtas_get_mt_scn

(

struct rtas_event *

re

)

[read]

rtas_get_mtms_scn

Parameters:

re

rtas_event pointer

Returns:

pointer to rtas_event_scn on success, NULL on failure

References get_re_scn(), and RTAS_MT_SCN.

struct rtas_post_scn* rtas_get_post_scn

(

struct rtas_event *

re

)

[read]

rtas_get_post_ecn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer for post section

References get_re_scn(), and RTAS_POST_SCN.

struct rtas_priv_hdr_scn* rtas_get_priv_hdr_scn

(

struct rtas_event *

re

)

[read]

rtas_get_priv_hdr_scn

Parameters:

re

rtas_event pointer

Returns:

pointer to rtas_event_scn on success, NULL on failure

References get_re_scn(), and RTAS_PRIV_HDR_SCN.

struct rtas_src_scn* rtas_get_src_scn

(

struct rtas_event *

re

)

[read]

rtas_get_src_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer for a SRC section

References get_re_scn(), and RTAS_PSRC_SCN.

struct rtas_usr_hdr_scn* rtas_get_usr_hdr_scn

(

struct rtas_event *

re

)

[read]

rtas_rtas_usr_hdr_scn

Parameters:

re

rtas_event pointer

Returns:

rtas_event_scn pointer to User Header section, NULL on failure

References get_re_scn(), and RTAS_USR_HDR_SCN.

struct rtas_vend_errlog_scn* rtas_get_vend_errlog_scn

(

struct rtas_event *

re

)

[read]

rtas_get_vend_specific

Parameters:

re

parsed rtas event

Returns:

reference to a rtas_event_scn on success, NULL on failure

References get_re_scn(), and RTAS_VEND_ERRLOG_SCN.

int rtas_print_event	(	FILE *	stream,
		struct rtas_event *	re,
		int	verbosity
	)

rtas_print_event

Parameters:

	stream	output stream to print to
	re	rtas_event pointer to print out
	verbosity	verbose level of output

Returns:

number of bytes written

References rtas_event::event_no, rtas_event::event_scns, scn_header::next, ostream, print_scn_title(), and rtas_print_scn().

int rtas_print_raw_event	(	FILE *	stream,
		struct rtas_event *	re
	)

rtas_print_raw_event

Parameters:

	stream	ouput stream to write to
	re	rtas_event pointer

Returns:

number of bytes written

References rtas_event::buffer, rtas_event::event_length, ostream, print_raw_data(), and print_scn_title().

int rtas_print_scn	(	FILE *	stream,
		struct scn_header *	shdr,
		int	verbosity
	)

rtas_print_scn

Parameters:

	stream	output stream to write to
	res	rtas_event_scn pointer to print
	verbosity	verbose level for output

Returns:

number of bytes written

References ostream, re_print_fns, and scn_header::scn_id.

Referenced by rtas_print_event().

int rtas_set_print_width

(

int

width

)

rtas_set_print_width

Parameters:

width

character width of output

Returns:

0 on success, !0 on failure

References rtas_print_width.

int update_os_id_scn	(	struct rtas_event *	re,
		const char *	id
	)

update_os_dump_id

References rtas_event::buffer, rtas_dump_scn::id_len, rtas_dump_scn::os_id, scn_header::raw_offset, RE_SHDR_SZ, rtas_get_dump_scn(), and rtas_dump_scn::shdr.