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>
53 lines
1.6 KiB
C
53 lines
1.6 KiB
C
/** @file
|
|
The library class provides platform variable cleanup services.
|
|
|
|
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Guid/VarErrorFlag.h>
|
|
|
|
typedef enum {
|
|
VarCleanupAll,
|
|
VarCleanupManually,
|
|
VarCleanupMax,
|
|
} VAR_CLEANUP_TYPE;
|
|
|
|
/**
|
|
Get last boot variable error flag.
|
|
|
|
@return Last boot variable error flag.
|
|
|
|
**/
|
|
VAR_ERROR_FLAG
|
|
EFIAPI
|
|
GetLastBootVarErrorFlag (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Platform variable cleanup.
|
|
|
|
@param[in] Flag Variable error flag.
|
|
@param[in] Type Variable cleanup type.
|
|
If it is VarCleanupManually, the interface must be called after console connected.
|
|
|
|
@retval EFI_SUCCESS No error or error processed.
|
|
@retval EFI_UNSUPPORTED The specified Flag or Type is not supported.
|
|
For example, system error may be not supported to process and Platform should have mechanism to reset system to manufacture mode.
|
|
Another, if system and user variables are wanted to be distinguished to process, the interface must be called after EndOfDxe.
|
|
@retval EFI_OUT_OF_RESOURCES Not enough resource to process the error.
|
|
@retval EFI_INVALID_PARAMETER The specified Flag or Type is an invalid value.
|
|
@retval Others Other failure occurs.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
PlatformVarCleanup (
|
|
IN VAR_ERROR_FLAG Flag,
|
|
IN VAR_CLEANUP_TYPE Type
|
|
);
|