You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
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>
68 lines
1.7 KiB
C
68 lines
1.7 KiB
C
/** @file
|
|
Internal structure for Var Check Pcd.
|
|
|
|
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
//
|
|
// Alignment for PCD Variable and check data header.
|
|
//
|
|
#define HEADER_ALIGNMENT 4
|
|
#define HEADER_ALIGN(Header) (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))
|
|
|
|
#pragma pack (1)
|
|
|
|
#define VAR_CHECK_PCD_REVISION 0x0001
|
|
|
|
typedef enum {
|
|
VarCheckPcdVariableHeader,
|
|
VarCheckPcdValidList,
|
|
VarCheckPcdValidRange,
|
|
VarCheckPcdCheckTypeMax,
|
|
} VAR_CHECK_PCD_CHECK_TYPE;
|
|
|
|
typedef struct {
|
|
UINT16 Revision;
|
|
UINT16 HeaderLength;
|
|
UINT32 Length; // Length include this header
|
|
UINT8 Type;
|
|
UINT8 Reserved[3];
|
|
UINT32 Attributes;
|
|
EFI_GUID Guid;
|
|
// CHAR16 Name[];
|
|
} VAR_CHECK_PCD_VARIABLE_HEADER;
|
|
|
|
typedef struct {
|
|
UINT8 Type;
|
|
UINT8 Length; // Length include this header
|
|
UINT16 VarOffset;
|
|
UINT8 StorageWidth;
|
|
} VAR_CHECK_PCD_VALID_DATA_HEADER;
|
|
|
|
typedef struct {
|
|
UINT8 Type;
|
|
UINT8 Length; // Length include this header
|
|
UINT16 VarOffset;
|
|
UINT8 StorageWidth;
|
|
// UINTx Data[]; // x = UINT8/UINT16/UINT32/UINT64;
|
|
} VAR_CHECK_PCD_VALID_LIST;
|
|
|
|
// typedef struct {
|
|
// UINTx Minimum; // x = UINT8/UINT16/UINT32/UINT64
|
|
// UINTx Maximum; // x = UINT8/UINT16/UINT32/UINT64
|
|
// } VAR_CHECK_PCD_VALID_RANGE_DATA;
|
|
|
|
typedef struct {
|
|
UINT8 Type;
|
|
UINT8 Length; // Length include this header
|
|
UINT16 VarOffset;
|
|
UINT8 StorageWidth;
|
|
// VAR_CHECK_PCD_VALID_RANGE_DATA ValidRange[];
|
|
} VAR_CHECK_PCD_VALID_RANGE;
|
|
|
|
#pragma pack ()
|