mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-06-13 19:16:19 -07:00
Michael Kubackiandmergify[bot]
7a934d0bef
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
95 lines
3.0 KiB
C
95 lines
3.0 KiB
C
/** @file
|
|
GUID used to identify status code records HOB that originate from the PEI status code.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
///
|
|
/// Global ID used to identify GUIDed HOBs that start with a structure of type
|
|
/// MEMORY_STATUSCODE_PACKET_HEADER, followed by an array of structures of type
|
|
/// MEMORY_STATUSCODE_RECORD. These GUIDed HOBs record all the information
|
|
/// passed into the ReportStatusCode() service of PEI Services Table.
|
|
///
|
|
/// <pre>
|
|
/// Memory status code records packet structure :
|
|
/// +---------------+----------+----------+-----+----------+-----+----------+
|
|
/// | Packet Header | Record 1 | Record 2 | ... + Record n | ... | Record m |
|
|
/// +---------------+----------+----------+-----+----------+-----+----------+
|
|
/// ^ ^ ^
|
|
/// +--------- RecordIndex -----------+ |
|
|
/// +---------------- MaxRecordsNumber----------------------+
|
|
/// </pre>
|
|
///
|
|
#define MEMORY_STATUS_CODE_RECORD_GUID \
|
|
{ \
|
|
0x60cc026, 0x4c0d, 0x4dda, {0x8f, 0x41, 0x59, 0x5f, 0xef, 0x0, 0xa5, 0x2} \
|
|
}
|
|
|
|
///
|
|
/// A header structure that is followed by an array of records that contain the
|
|
/// parameters passed into the ReportStatusCode() service in the PEI Services Table.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// Index of the packet.
|
|
///
|
|
UINT16 PacketIndex;
|
|
///
|
|
/// The number of active records in the packet.
|
|
///
|
|
UINT16 RecordIndex;
|
|
///
|
|
/// The maximum number of records that the packet can store.
|
|
///
|
|
UINT32 MaxRecordsNumber;
|
|
} MEMORY_STATUSCODE_PACKET_HEADER;
|
|
|
|
///
|
|
/// A header structure that is followed by an array of records that contain the
|
|
/// parameters passed into the ReportStatusCode() service in the DXE Services Table.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The index pointing to the last recored being stored.
|
|
///
|
|
UINT32 RecordIndex;
|
|
///
|
|
/// The number of records being stored.
|
|
///
|
|
UINT32 NumberOfRecords;
|
|
///
|
|
/// The maximum number of records that can be stored.
|
|
///
|
|
UINT32 MaxRecordsNumber;
|
|
} RUNTIME_MEMORY_STATUSCODE_HEADER;
|
|
|
|
///
|
|
/// A structure that contains the parameters passed into the ReportStatusCode()
|
|
/// service in the PEI Services Table.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// Status Code type to be reported.
|
|
///
|
|
EFI_STATUS_CODE_TYPE CodeType;
|
|
|
|
///
|
|
/// An operation, plus value information about the class and subclass, used to
|
|
/// classify the hardware and software entity.
|
|
///
|
|
EFI_STATUS_CODE_VALUE Value;
|
|
|
|
///
|
|
/// The enumeration of a hardware or software entity within
|
|
/// the system. Valid instance numbers start with the number 1.
|
|
///
|
|
UINT32 Instance;
|
|
} MEMORY_STATUSCODE_RECORD;
|
|
|
|
extern EFI_GUID gMemoryStatusCodeRecordGuid;
|