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>
72 lines
2.1 KiB
C
72 lines
2.1 KiB
C
/** @file
|
|
Define the EDKII_DEBUG_PPI that PEIMs can use to dump info to debug port.
|
|
|
|
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Pi/PiPeiCis.h>
|
|
|
|
//
|
|
// Global ID for the EDKII_DEBUG_PPI
|
|
//
|
|
#define EDKII_DEBUG_PPI_GUID \
|
|
{ \
|
|
0x999e699c, 0xb013, 0x475e, {0xb1, 0x7b, 0xf3, 0xa8, 0xae, 0x5c, 0x48, 0x75} \
|
|
}
|
|
|
|
///
|
|
/// Forward declaration for the PEI_DEBUG_LIB_DEBUG_PPI EDKII_DEBUG_PPI
|
|
///
|
|
typedef struct _EDKII_DEBUG_PPI EDKII_DEBUG_PPI;
|
|
|
|
/**
|
|
Print a debug message to debug output device if the specified error level
|
|
is enabled.
|
|
|
|
@param[in] ErrorLevel The error level of the debug message.
|
|
@param[in] Format Format string for the debug message to print.
|
|
@param[in] Marker BASE_LIST marker for the variable argument list.
|
|
|
|
**/
|
|
typedef
|
|
VOID
|
|
(EFIAPI *EDKII_DEBUG_BPRINT)(
|
|
IN UINTN ErrorLevel,
|
|
IN CONST CHAR8 *Format,
|
|
IN BASE_LIST Marker
|
|
);
|
|
|
|
/**
|
|
Print an assert message containing a filename, line number, and description.
|
|
This may be followed by a breakpoint or a dead loop.
|
|
|
|
@param[in] FileName The pointer to the name of the source file that
|
|
generated the assert condition.
|
|
@param[in] LineNumber The line number in the source file that generated
|
|
the assert condition
|
|
@param[in] Description The pointer to the description of the assert condition.
|
|
|
|
**/
|
|
typedef
|
|
VOID
|
|
(EFIAPI *EDKII_DEBUG_ASSERT)(
|
|
IN CONST CHAR8 *FileName,
|
|
IN UINTN LineNumber,
|
|
IN CONST CHAR8 *Description
|
|
);
|
|
|
|
///
|
|
/// This PPI contains a set of services to print message to debug output device
|
|
///
|
|
struct _EDKII_DEBUG_PPI {
|
|
EDKII_DEBUG_BPRINT DebugBPrint;
|
|
EDKII_DEBUG_ASSERT DebugAssert;
|
|
};
|
|
|
|
extern EFI_GUID gEdkiiDebugPpiGuid;
|