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>
59 lines
1.8 KiB
C
59 lines
1.8 KiB
C
/** @file
|
|
This Variable Runtime Cache Info HOB is used to store the address
|
|
and the size of the buffer that will be used for variable runtime
|
|
service when the PcdEnableVariableRuntimeCache is TRUE.
|
|
|
|
Copyright (c) 2024, Intel Corporation. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define VARIABLE_RUNTIME_CACHE_INFO_HOB_REVISION 1
|
|
|
|
#define VARIABLE_RUNTIME_CACHE_INFO_GUID \
|
|
{ \
|
|
0x0f472f7d, 0x6713, 0x4915, {0x96, 0x14, 0x5d, 0xda, 0x28, 0x40, 0x10, 0x56} \
|
|
}
|
|
|
|
typedef struct {
|
|
///
|
|
/// TRUE indicates GetVariable () or GetNextVariable () is being called.
|
|
/// When the value is FALSE, the given update (and any other pending updates)
|
|
/// can be flushed to the runtime cache.
|
|
///
|
|
BOOLEAN ReadLock;
|
|
///
|
|
/// TRUE indicates there is pending update for the given variable store needed
|
|
/// to be flushed to the runtime cache.
|
|
///
|
|
BOOLEAN PendingUpdate;
|
|
///
|
|
/// TRUE indicates all HOB variables have been flushed in flash.
|
|
///
|
|
BOOLEAN HobFlushComplete;
|
|
} CACHE_INFO_FLAG;
|
|
|
|
typedef struct {
|
|
EFI_PHYSICAL_ADDRESS CacheInfoFlagBuffer;
|
|
///
|
|
/// Base address of the runtime Hob variable cache Buffer.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS RuntimeHobCacheBuffer;
|
|
UINT64 RuntimeHobCachePages;
|
|
///
|
|
/// Base address of the non-volatile variable runtime cache Buffer.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS RuntimeNvCacheBuffer;
|
|
UINT64 RuntimeNvCachePages;
|
|
///
|
|
/// Base address of the volatile variable runtime cache Buffer.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS RuntimeVolatileCacheBuffer;
|
|
UINT64 RuntimeVolatileCachePages;
|
|
} VARIABLE_RUNTIME_CACHE_INFO;
|
|
|
|
extern EFI_GUID gEdkiiVariableRuntimeCacheInfoHobGuid;
|