18.5. 错误串行化

• 错误记录串行化功能用于将硬件错误信息保存到持久存储并从中检索。OSPM 通过平台接口与平台交互。如果存在错误记录串行化表（ERST），则 OSPM 使用下面描述的 ACPI 方案。否则，在基于 UEFI 的平台上，OSPM 使用 UEFI 运行时变量服务来执行错误记录持久化操作。

  • 为了实现跨重启的错误持久化，平台必须实现某种形式的非易失性存储来保存错误记录。所需空间量取决于平台的处理器架构。通常，此存储将是闪存或某种其他形式的非易失性 RAM。

  • 串行化错误按照通用平台错误记录（CPER）格式进行编码，该格式在 UEFI 规范的附录中描述。这些条目称为错误记录。

  • 错误记录串行化接口的设计足够抽象，以便硬件供应商在如何实现其错误记录串行化硬件方面具有灵活性。平台通过使用一组串行化指令条目填充 ERST 来提供与其串行化硬件通信所需的详细信息。一个或多个串行化指令条目组成一个串行化操作。OSPM 通过执行一系列串行化操作来执行串行化操作。串行化操作和串行化指令将在以下章节中详细描述。

下表详细说明了 ERST 布局，系统固件负责构建该布局。

表 18.16 错误记录串行化表（ERST）

18.5.1. 串行化操作表

串行化操作被定义为对寄存器执行的一系列串行化指令，这些指令会产生一个众所周知的操作。串行化指令是串行化操作的原语，由读取或写入抽象化硬件寄存器组成。串行化操作表包含平台支持的所有串行化操作的串行化指令条目。

在大多数情况下，一个序列化动作仅包含一条序列化指令，但可以设想，更复杂的设备将需要多于一条序列化指令。当一个动作确实包含多于一条指令时，这些指令必须连续列出，因此它们将按照其在序列化动作表中的位置顺序执行。

18.5.1.1. 序列化动作

本节标识构成错误记录序列化接口的序列化动作，如下表所示。

表 18.17 错误记录序列化动作

下表定义了从 GET_COMMAND_STATUS 返回的序列化动作状态码。

表 18.18 命令状态定义

18.5.1.2. 序列化指令项

每个序列化动作由一个或多个序列化指令组成。序列化指令表示对抽象硬件寄存器执行的一个基本操作，该寄存器由序列化指令项中定义的寄存器区域表示。

序列化指令项描述了序列化硬件寄存器中的一个区域，以及要对该区域执行的序列化指令。下表详细说明了序列化指令项的布局。

表 18.19 序列化指令项

寄存器区域被描述为通用地址结构。该结构描述寄存器的物理地址，以及与期望寄存器区域对应的位范围。位范围被定义为包含寄存器中与该序列化指令相关的每一位的最小连续位集合。如果位 [6:5] 和位 [3:2] 都对应于某个序列化指令，则该指令的位范围将是 [6:2]。

由于一个位范围可能包含与特定序列化指令无关的位（即上述示例中的位 4），因此需要使用位掩码来区分该区域中与该指令对应的所有位。Mask 字段被定义为该位掩码，对于位范围内（由寄存器区域定义）对应于该序列化指令的每一位，其对应位设置为“1”。请注意，位掩码的位 0 对应于该位范围中的最低位。在上面使用的示例中，掩码将为 11011b 或 0x1B。

Instruction 字段标识该指令项要在寄存器区域上执行的操作。下表标识了所支持的指令。

表 18.20 序列化指令

Flags 字段允许将限定标志与该指令相关联。下表标识了可与序列化指令关联的标志。

表 18.21 指令标志

18.5.1.2.1. READ_REGISTER_VALUE

读取寄存器值指令读取寄存器区域，并将结果与指定值进行比较。如果这些值不相等，则该指令失败。这可以用如下伪代码描述：

X = Read(register)
X = X >> Bit Offset described in Register Region
X = X & Mask
If (X != Value) FAIL
SUCCEED

18.5.1.2.2. READ_REGISTER

读取寄存器指令读取寄存器区域。结果是一个通用值，不应与 Value 进行比较。Value 将被忽略。这可以用如下伪代码描述：

X = Read(register)
X = X >> Bit Offset described in Register Region
X = X & Mask
Return X

18.5.1.2.3. WRITE_REGISTER_VALUE

写寄存器值指令将指定的值写入寄存器区域。如果在指令标志中设置了 PRESERVE_REGISTER，则与写值指令不对应的位会被保留。如果寄存器被保留，则写值指令需要先读取该寄存器。可用如下伪代码描述：

X = Value & Mask
X = X << Bit Offset described in Register Region
If (Preserve Register)
Y = Read(register)
Y = Y & ~(Mask << Bit Offset)
X = X \| Y
Write(X, Register)

18.5.1.2.4. WRITE_REGISTER

写寄存器指令将一个值写入寄存器区域。值将被忽略。如果在指令标志中设置了 PRESERVE_REGISTER，则与写指令不对应的位会被保留。如果寄存器被保留，则写值指令需要先读取该寄存器。可用如下伪代码描述：

X = supplied value
X = X & Mask
X = X << Bit Offset described in Register Region
If (Preserve Register)
Y = Read(register)
Y = Y & ~(Mask << Bit Offset)
X = X \| Y
Write(X, Register)

18.5.1.3. 错误记录序列化信息

APEI 错误记录包含一个称为 OSPM Reserved 的 8 字节字段。下表定义了该字段的布局。错误记录序列化信息是平台可用于序列化簿记的一个小缓冲区。平台可自由使用从位偏移 16 开始的 48 位以满足其自身用途。它可以使用这些位来指示错误记录的忙/空闲状态、记录内部标识符等。

表 18.22 错误记录序列化信息

18.5.2. 操作

错误记录序列化接口由三种操作组成：写入、读取和清除。OSPM 使用写入操作将单个错误记录写入持久存储。读取操作用于取回先前通过写入操作记录到持久存储中的单个错误记录。清除操作允许 OSPM 通知平台某个给定错误记录已经被完全处理且不再需要，从而允许平台回收与已清除错误记录关联的存储。

当 Error Log Address Range 为 NVRAM 时，由于无需将数据从 Error Log Address Range 传输到单独的存储设备，因此可以进行显著优化。不过，如果平台选择这样做，它仍然可以将记录从 NVRAM 复制到另一设备。例如，这允许平台将错误记录复制到私有日志文件。为了给平台提供这样做的机会，即使 Error Log Address Range 是 NVRAM，OSPM 也必须使用写入操作来持久化错误记录。然而，在这种情况下，读取和清除操作是不必要的，因为 OSPM 能够在无需平台协助的情况下读取和清除错误记录。

18.5.2.1. 写入

为了写入单个 HW 错误记录，OSPM 执行以下步骤：

1. 初始化错误记录的序列化信息。OSPM 必须填写 Signature。

2. 将要持久化的错误记录写入 Error Log Address Range。

3. 执行 BEGIN_WRITE_OPERATION 动作，以通知平台记录写入操作即将开始。

4. 执行 SET_RECORD_OFFSET 动作，以通知平台在

5. Error Log Address Range 中错误记录所在的位置偏移。

6. 执行 EXECUTE_OPERATION 动作，以指示平台开始写入操作。

7. 通过持续执行 CHECK_BUSY_STATUS 动作进行忙等待，直到返回 FALSE。

8. 执行 GET_COMMAND_STATUS 动作，以确定写入操作的状态。如果指示出现错误，OS

9. PM 可以重试该操作。

10. 执行 END_OPERATION 动作，以通知平台记录写入操作已完成。

当 OSPM 在记录写入操作的上下文中执行 EXECUTE_OPERATION 动作时，平台会尝试将错误记录从 Error Log Address Range 中指定的偏移位置传输到其选择的持久存储中。如果 Error Log Address Range 是非易失性 RAM，则无需传输。

当平台需要将错误记录从 Error Log Address Range 传输到持久存储时，它在收到写入命令后执行以下步骤：

1. 设置某些内部状态以表明其正忙。OSPM 通过执行 CHECK_BUSY_STATUS 动作进行轮询，直到操作完成。

2. 读取错误记录的 Record ID 字段，以确定应将提供的错误记录写入存储介质上的哪个位置。平台尝试在持久存储中定位指定的错误记录。

   • 如果指定的错误记录不存在，则平台尝试将新记录写入持久存储。

   • 如果指定的错误记录确实存在，那么若现有错误记录足够大，能够被提供的错误记录覆盖，则平台可以进行原地替换。如果现有记录不足以被覆盖，则平台必须尝试定位可写入新记录的空间。它可以将现有记录标记为空闲，并合并相邻的空闲记录以创建所需空间。

3. 将错误记录传输到持久存储上的选定位置。

4. 如果写入了新记录，则更新内部的 Record Count。

5. 记录该操作的状态，以便 OSPM 能够通过执行 GET_COMMAND_STATUS 动作来获取该状态。

6. 根据需要修改内部忙状态，以便当 OSPM 执行 CHECK_BUSY_STATUS 时，结果表明该操作已完成。

如果 Error Log Address Range 位于 NVRAM 中，则平台所需执行的最少步骤为：

1. 设置某些内部状态以表明其正忙。OSPM 通过执行 CHECK_BUSY_STATUS 动作进行轮询，直到操作完成。

2. 记录该操作的状态，以便 OSPM 能够通过执行 GET_COMMAND_STATUS 动作来获取该状态。

3. 清除内部忙状态，以便当 OSPM 执行 CHECK_BUSY_STATUS 时，结果表明该操作已完成。

18.5.2.2. 读取

在引导期间，OSPM 尝试从持久存储中取回所有序列化的错误记录。如果 Error Log Address Range 不位于 NVRAM 中，则 OSPM 执行以下步骤来取回所有错误记录：

1. 执行 BEGIN_ READ_OPERATION 动作，以通知平台记录读取操作即将开始。

2. 执行 SET_ RECORD_OFFSET 动作，以通知平台应将错误记录传输到 Error Log Address Range 中哪个偏移位置。

3. 执行 SET_RECORD_IDENTIFER 动作，以通知平台应从其持久存储中读取哪个错误记录。

4. 执行 EXECUTE_OPERATION 动作，以指示平台开始读取操作。

5. 通过持续执行 CHECK_BUSY_STATUS 动作进行忙等待，直到返回 FALSE。

6. 执行 GET_COMMAND_STATUS 动作，以确定读取操作的状态。

   • 如果状态是 Record Store Empty (0x04)，继续执行步骤 7。

   • 如果在读取有效错误记录时发生错误，则状态将为 Failed (0x03)，继续执行步骤 7。

   • 如果状态是 Record Not Found (0x05)，表示指定的错误记录不存在，则 OSPM 通过执行 GET_RECORD_IDENTIFIER 动作来获取一个有效标识符。平台将返回一个有效的记录标识符。

   • 如果状态为 Success，则 OSPM 将检索到的记录从 Error Log Address Range 传输到私有缓冲区，然后执行 GET_RECORD_IDENTIFIER 动作，以确定持久存储中下一条记录的标识符。

7. 执行 END_OPERATION，以通知平台记录读取操作已完成。

平台为执行读取请求而执行的步骤如下：

1. 设置某些内部状态以表明其正忙。OSPM 通过执行 CHECK_BUSY_STATUS 动作进行轮询，直到操作完成。

2. 使用 OSPM 通过 SET_RECORD_IDENTIFIER 操作提供的记录标识符，确定要读取哪个错误记录：

   • 如果标识符为 0x0（未指定），则平台从其持久存储中读取“第一条”错误记录（“第一条”的定义由具体实现决定）。

   • 如果标识符非零，则平台尝试在持久存储中定位指定的错误记录。

   • 如果指定的错误记录不存在，则将状态寄存器的 Status 设为 Record Not Found (0x05)，并使用“第一条”错误记录的标识符更新状态寄存器的 Identifier 字段。

3. 将记录从持久存储传输到由 OSPM 指定的、相对于 Error Log Address Range 基地址的偏移位置。

4. 记录位于持久存储中的“下一条”有效错误记录的 Identifier。这允许 OSPM 通过执行 GET_RECORD_IDENTIFIER 操作来获取一个有效的记录标识符。

5. 记录该操作的状态，以便 OSPM 能够通过执行 GET_COMMAND_STATUS 动作来获取该状态。

6. 清除内部忙状态，以便当 OSPM 执行 CHECK_BUSY_STATUS 时，结果表明该操作已完成。

当 Error Log Address Range 确实位于 NVRAM 中时，OSPM 在读取持久化错误记录时不需要平台支持。OSPM 可以自行扫描 Error Log Address Range 并取回其先前持久化的错误记录。

18.5.2.3. 清除

在 OSPM 完成对错误记录的处理后，它会通过清除该记录来通知平台。这使平台能够从持久存储中删除该记录，或对其进行标记，使该空间为空闲且可重用。OSPM 执行以下步骤来清除错误记录：

1. 执行 BEGIN_ CLEAR_OPERATION 动作，以通知平台记录清除操作即将开始。

2. 执行 SET_RECORD_IDENTIFER 动作，以通知平台应清除哪个错误记录。该值不得设置为 0x0（未指定）。

3. 执行 EXECUTE_OPERATION 动作，以指示平台开始清除操作。

4. 通过持续执行 CHECK_BUSY_STATUS 动作进行忙等待，直到返回 FALSE。

5. 执行 GET_COMMAND_STATUS 动作，以确定清除操作的状态。

6. 执行 END_OPERATION，以通知平台记录读取操作已完成。

平台通过执行以下步骤来完成清除请求：

1. 设置某些内部状态以表明其正忙。OSPM 通过执行 CHECK_BUSY_STATUS 动作进行轮询，直到操作完成。

2. 使用 OSPM 通过 SET_RECORD_IDENTIFIER 操作提供的记录标识符，确定要清除哪个错误记录。该值不得为 0x0（未指定）。

3. 在持久存储中定位指定的错误记录。

4. 通过更新其序列化头中的 Attributes 将该记录标记为空闲。

5. 更新内部记录计数。

6. 清除内部忙状态，以便当 OSPM 执行 CHECK_BUSY_STATUS 时，结果表明该操作已完成。

当 Error Log Address Range 位于 NVRAM 中时，OS 在清除错误记录时不需要平台支持。

18.5.2.4. 用法

本节描述了错误记录序列化机制可能实现的几种方式。

18.5.2.4.1. 错误日志地址范围位于 NVRAM 中

如果 错误日志地址范围 位于 NVRAM 中，那么当 OSPM 向日志记录范围写入一条记录时，该记录会自动持久化，且忙位可以立即清除。在随后的引导中，OSPM 可以直接从持久存储范围读取任何已持久化的错误记录。在这种情况下，持久存储的大小应足以容纳若干条错误记录。

18.5.2.4.2. 错误日志地址范围位于（易失性）RAM 中

在这种实现中，错误日志地址范围描述的是错误记录的中间位置。为了持久化一条记录，OSPM 会将该记录复制到错误日志地址范围中并设置执行，此时平台会运行必要的代码（非 UEFI 系统上的 SMM 代码，以及启用 UEFI 的系统上的 UEFI 运行时代码），将错误记录从主内存转移到某个持久存储中。要读取一条记录，OSPM 会要求平台将一条记录从持久存储复制到错误日志地址范围内的指定偏移处。错误日志地址范围的大小至少应足以容纳一条错误记录。

18.5.2.4.3. 错误日志地址范围位于服务处理器上

在这种类型的实现中，错误日志地址范围实际上是 MMIO。当 OSPM 向错误日志地址范围写入一条错误记录时，实际上是在向服务处理器上的内存写入。当 OSPM 设置执行控制位时，平台就知道 OSPM 已完成该记录的写入，并且可以对其进行某些处理，例如将其移入服务处理器上的永久位置（即硬盘）。这种实现类型中的持久存储大小通常足以容纳一条错误记录。

18.5.2.4.4. 错误日志地址范围通过网络复制

在这种类型的实现中，错误日志地址范围是错误记录的中间缓存。为了持久化一条错误记录，OSPM 会将该记录复制到错误日志地址范围中并设置执行控制位，平台随后运行代码通过网络传输该错误记录。这种实现类型中的错误日志地址范围大小通常足以容纳一条错误记录。