mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
a536e5d699
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.
Note: Headers taken directly from external projects, such as those
in OvmfPkg/Include/IndustryStandard/Xen/ were not modified since they
may be periodically re-synced and do not follow other edk2 coding
stadards.
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>
125 lines
3.8 KiB
C
125 lines
3.8 KiB
C
/** @file
|
|
Parse the contents of named fw_cfg files as simple (scalar) data types.
|
|
|
|
Copyright (C) 2020, Red Hat, Inc.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Base.h>
|
|
|
|
/**
|
|
Look up FileName with QemuFwCfgFindFile() from QemuFwCfgLib. Read the fw_cfg
|
|
file into a small array with automatic storage duration. Parse the array as
|
|
the textual representation of a BOOLEAN.
|
|
|
|
@param[in] FileName The name of the fw_cfg file to look up and parse.
|
|
|
|
@param[out] Value On success, Value is TRUE if the contents of the fw_cfg
|
|
file case-insensitively match "true", "yes", "y",
|
|
"enable", "enabled", "1".
|
|
|
|
On success, Value is FALSE if the contents of the fw_cfg
|
|
file case-insensitively match "false", "no", "n",
|
|
"disable", "disabled", "0".
|
|
|
|
On failure, Value is not changed.
|
|
|
|
@retval RETURN_SUCCESS Parsing successful. Value has been set.
|
|
|
|
@retval RETURN_UNSUPPORTED Firmware configuration is unavailable.
|
|
|
|
@retval RETURN_PROTOCOL_ERROR Parsing failed. Value has not been changed.
|
|
|
|
@return Error codes propagated from
|
|
QemuFwCfgFindFile(). Value has not been
|
|
changed.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
QemuFwCfgParseBool (
|
|
IN CONST CHAR8 *FileName,
|
|
OUT BOOLEAN *Value
|
|
);
|
|
|
|
/**
|
|
Look up FileName with QemuFwCfgFindFile() from QemuFwCfgLib. Read the fw_cfg
|
|
file into a small array with automatic storage duration. Parse the array as
|
|
the textual representation of a UINT8.
|
|
|
|
@param[in] FileName The name of the fw_cfg file to look up and parse.
|
|
|
|
@param[in] ParseAsHex If TRUE, call BaseLib's AsciiStrHexToUint64S() for
|
|
parsing the fw_cfg file.
|
|
|
|
If FALSE, call BaseLib's AsciiStrDecimalToUint64S()
|
|
for parsing the fw_cfg file.
|
|
|
|
@param[out] Value On success, Value has been parsed with the BaseLib
|
|
function determined by ParseAsHex, and also
|
|
range-checked for [0, MAX_UINT8].
|
|
|
|
On failure, Value is not changed.
|
|
|
|
@retval RETURN_SUCCESS Parsing successful. Value has been set.
|
|
|
|
@retval RETURN_UNSUPPORTED Firmware configuration is unavailable.
|
|
|
|
@retval RETURN_PROTOCOL_ERROR Parsing failed. Value has not been changed.
|
|
|
|
@retval RETURN_PROTOCOL_ERROR Parsing succeeded, but the result does not fit
|
|
in the [0, MAX_UINT8] range. Value has not
|
|
been changed.
|
|
|
|
@return Error codes propagated from
|
|
QemuFwCfgFindFile() and from the BaseLib
|
|
function selected by ParseAsHex. Value has not
|
|
been changed.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
QemuFwCfgParseUint8 (
|
|
IN CONST CHAR8 *FileName,
|
|
IN BOOLEAN ParseAsHex,
|
|
OUT UINT8 *Value
|
|
);
|
|
|
|
//
|
|
// The following functions behave identically to QemuFwCfgParseUint8(),
|
|
// only their range checks use MAX_UINT16, MAX_UINT32, MAX_UINT64, MAX_UINTN,
|
|
// respectively.
|
|
//
|
|
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
QemuFwCfgParseUint16 (
|
|
IN CONST CHAR8 *FileName,
|
|
IN BOOLEAN ParseAsHex,
|
|
OUT UINT16 *Value
|
|
);
|
|
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
QemuFwCfgParseUint32 (
|
|
IN CONST CHAR8 *FileName,
|
|
IN BOOLEAN ParseAsHex,
|
|
OUT UINT32 *Value
|
|
);
|
|
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
QemuFwCfgParseUint64 (
|
|
IN CONST CHAR8 *FileName,
|
|
IN BOOLEAN ParseAsHex,
|
|
OUT UINT64 *Value
|
|
);
|
|
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
QemuFwCfgParseUintn (
|
|
IN CONST CHAR8 *FileName,
|
|
IN BOOLEAN ParseAsHex,
|
|
OUT UINTN *Value
|
|
);
|