WHEA_ERROR_RECORD_SECTION_DESCRIPTOR structure (ntddk.h)

Article
03/14/2023

The WHEA_ERROR_RECORD_SECTION_DESCRIPTOR structure describes a section of error information that is part of an error record.

Syntax

typedef struct _WHEA_ERROR_RECORD_SECTION_DESCRIPTOR {
  ULONG                                          SectionOffset;
  ULONG                                          SectionLength;
  WHEA_REVISION                                  Revision;
  WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_VALIDBITS ValidBits;
  UCHAR                                          Reserved;
  WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_FLAGS     Flags;
  GUID                                           SectionType;
  GUID                                           FRUId;
  WHEA_ERROR_SEVERITY                            SectionSeverity;
  CCHAR                                          FRUText[20];
} WHEA_ERROR_RECORD_SECTION_DESCRIPTOR, *PWHEA_ERROR_RECORD_SECTION_DESCRIPTOR;

Members

SectionOffset

The offset, in bytes, from the beginning of the error record to the beginning of the error record section.

SectionLength

The length, in bytes, of the error data contained in the error record section.

Revision

A WHEA_REVISION union that describes the revision level of the WHEA_ERROR_RECORD_SECTION_DESCRIPTOR structure.

ValidBits

A WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_VALIDBITS union that specifies which members of this structure contain valid data.

Reserved

Reserved for system use.

Flags

A WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_FLAGS union that describes the error record section. The WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_FLAGS union is defined as follows:

typedef union _WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_FLAGS {
  struct {
    ULONG  Primary:1;
    ULONG  ContainmentWarning:1;
    ULONG  Reset:1;
    ULONG  ThresholdExceeded:1;
    ULONG  ResourceNotAvailable:1;
    ULONG  LatentError:1;
    ULONG  Reserved:26;
  };
  ULONG  AsULONG;
} WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_FLAGS, *PWHEA_ERROR_RECORD_SECTION_DESCRIPTOR_FLAGS;

Primary

A single bit that indicates that the corresponding error record section is the primary section within the error record. When there are multiple sections contained in an error record, the primary section is the section that is used for error recovery.

ContainmentWarning

A single bit that indicates that the error described by the corresponding error record section was not contained within the processor or memory hierarchy. In this situation, the error might have propagated to other components of the system.

Reset

A single bit that indicates that the component must be reinitialized or re-enabled by the operating system.

ThresholdExceeded

A single bit that indicates that an error threshold has been exceeded.

ResourceNotAvailable

A single bit that indicates that a resource could not be queried for error information due to conflicts with other system software or resources. In this situation, some of the fields of the corresponding error record section will be invalid.

LatentError

A single bit that indicates that the reported error is a latent error (one not yet consumed) that could result in a more severe error when it is consumed.

Reserved

Reserved for system use.

AsULONG

A ULONG representation of the contents of the WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_FLAGS union.

SectionType

A GUID that identifies the type of error data that is contained in the error record section. The standard section types are defined as follows:

WHEA_PACKET_SECTION_GUID

The error record section contains the hardware error packet that was passed to the operating system by the low-level hardware error handler (LLHEH) that reported the error. This data is described by a WHEA_ERROR_PACKET structure.

PROCESSOR_GENERIC_ERROR_SECTION_GUID

The error record section contains processor error data that is not specific to a particular processor architecture. This data is described by a WHEA_PROCESSOR_GENERIC_ERROR_SECTION structure.

IPF_PROCESSOR_ERROR_SECTION_GUID

The error record section contains processor error data that is specific to the Itanium processor architecture. For more information about the format of the error data that is contained in this error record section, see the Intel Itanium Processor Family System Abstraction Layer Specification.

FIRMWARE_ERROR_RECORD_REFERENCE_GUID

The error record section contains a reference to a firmware error record that is specific to the Itanium processor architecture. This data is described by a WHEA_FIRMWARE_ERROR_RECORD_REFERENCE structure.

MEMORY_ERROR_SECTION_GUID

The error record section contains platform memory error data. This data is described by a WHEA_MEMORY_ERROR_SECTION structure.

NMI_SECTION_GUID

The error record section contains nonmaskable interrupt (NMI) error data. This data is described by a WHEA_NMI_ERROR_SECTION structure.

PCIEXPRESS_ERROR_SECTION_GUID

The error record section contains PCI Express (PCIe) error data. This data is described by a WHEA_PCIEXPRESS_ERROR_SECTION structure.

PCIXBUS_ERROR_SECTION_GUID

The error record section contains PCI/PCI-X bus error data. This data is described by a WHEA_PCIXBUS_ERROR_SECTION structure.

The error record section contains PCI/PCI-X device error data. This data is described by a WHEA_PCIXDEVICE_ERROR_SECTION structure.

XPF_PROCESSOR_ERROR_SECTION_GUID

The error record section contains processor error data that is specific to the x86 or x64 processor architecture. This data is described by a WHEA_XPF_PROCESSOR_ERROR_SECTION structure.

For error record sections that do not conform to one of the standard section types, this member contains a platform-specific GUID that identifies the type of error data that is contained in the error record section. If a platform-specific GUID is not defined for the type of error data that is contained in the error record section, this member contains GENERIC_SECTION_GUID.

FRUId

A GUID that identifies the Field Replaceable Unit (FRU) that contains the hardware where the error occurred. This member contains valid data only if the ValidBits.FRUId bit is set.

SectionSeverity

A WHEA_ERROR_SEVERITY-typed value that indicates the severity of the error condition that is described by the error record section.

FRUText[20]

A character string that identifies the Field Replaceable Unit (FRU) that contains the hardware where the error occurred. This member contains valid data only if the ValidBits.FRUText bit is set.

Remarks

The WHEA_ERROR_RECORD structure contains an array of WHEA_ERROR_RECORD_SECTION_DESCRIPTOR structures. Each descriptor describes a section of error information that is part of the error record.

Requirements

Requirement	Value
Header	ntddk.h (include Ntddk.h)