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>
58 lines
1.9 KiB
C
58 lines
1.9 KiB
C
/** @file
|
|
Defines the interface to convey performance information from SEC phase to PEI.
|
|
|
|
Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define PEI_SEC_PERFORMANCE_PPI_GUID \
|
|
{ \
|
|
0x0ecc666b, 0x4662, 0x47f9, {0x9d, 0xd5, 0xd0, 0x96, 0xff, 0x7d, 0xa4, 0x9e } \
|
|
}
|
|
|
|
typedef struct _PEI_SEC_PERFORMANCE_PPI PEI_SEC_PERFORMANCE_PPI;
|
|
|
|
///
|
|
/// Performance data collected in SEC phase.
|
|
///
|
|
typedef struct {
|
|
UINT64 ResetEnd; ///< Timer value logged at the beginning of firmware image execution, in unit of nanosecond.
|
|
} FIRMWARE_SEC_PERFORMANCE;
|
|
|
|
/**
|
|
This interface conveys performance information out of the Security (SEC) phase into PEI.
|
|
|
|
This service is published by the SEC phase. The SEC phase handoff has an optional
|
|
EFI_PEI_PPI_DESCRIPTOR list as its final argument when control is passed from SEC into the
|
|
PEI Foundation. As such, if the platform supports collecting performance data in SEC,
|
|
this information is encapsulated into the data structure abstracted by this service.
|
|
This information is collected for the boot-strap processor (BSP) on IA-32.
|
|
|
|
@param[in] PeiServices The pointer to the PEI Services Table.
|
|
@param[in] This The pointer to this instance of the PEI_SEC_PERFORMANCE_PPI.
|
|
@param[out] Performance The pointer to performance data collected in SEC phase.
|
|
|
|
@retval EFI_SUCCESS The performance data was successfully returned.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *GET_SEC_PERFORMANCE)(
|
|
IN CONST EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_SEC_PERFORMANCE_PPI *This,
|
|
OUT FIRMWARE_SEC_PERFORMANCE *Performance
|
|
);
|
|
|
|
///
|
|
/// This PPI provides function to get performance data collected in SEC phase.
|
|
///
|
|
struct _PEI_SEC_PERFORMANCE_PPI {
|
|
GET_SEC_PERFORMANCE GetPerformance;
|
|
};
|
|
|
|
extern EFI_GUID gPeiSecPerformancePpiGuid;
|