mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04: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>
65 lines
1.5 KiB
C
65 lines
1.5 KiB
C
/** @file
|
|
|
|
Debug Mask Protocol.
|
|
|
|
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
///
|
|
/// Protocol GUID for DXE Phase Debug Mask support
|
|
///
|
|
#define EFI_DEBUG_MASK_PROTOCOL_GUID \
|
|
{ 0x4c8a2451, 0xc207, 0x405b, {0x96, 0x94, 0x99, 0xea, 0x13, 0x25, 0x13, 0x41} }
|
|
|
|
///
|
|
/// Forward reference for pure ANSI compatability
|
|
///
|
|
typedef struct _EFI_DEBUG_MASK_PROTOCOL EFI_DEBUG_MASK_PROTOCOL;
|
|
|
|
///
|
|
///
|
|
///
|
|
#define EFI_DEBUG_MASK_REVISION 0x00010000
|
|
|
|
//
|
|
// DebugMask member functions definition
|
|
//
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_GET_DEBUG_MASK)(
|
|
IN EFI_DEBUG_MASK_PROTOCOL *This,
|
|
IN OUT UINTN *CurrentDebugMask
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SET_DEBUG_MASK)(
|
|
IN EFI_DEBUG_MASK_PROTOCOL *This,
|
|
IN UINTN NewDebugMask
|
|
);
|
|
|
|
///
|
|
/// DebugMask protocol definition
|
|
///
|
|
struct _EFI_DEBUG_MASK_PROTOCOL {
|
|
INT64 Revision;
|
|
EFI_GET_DEBUG_MASK GetDebugMask;
|
|
EFI_SET_DEBUG_MASK SetDebugMask;
|
|
};
|
|
|
|
extern EFI_GUID gEfiDebugMaskProtocolGuid;
|
|
|
|
///
|
|
/// GUID used to store the global debug mask in an the "EFIDebug" EFI Variabe
|
|
/// Also used as a GUIDed HOB that contains a UINT32 debug mask default value
|
|
///
|
|
#define EFI_GENERIC_VARIABLE_GUID \
|
|
{ 0x59d1c24f, 0x50f1, 0x401a, {0xb1, 0x01, 0xf3, 0x3e, 0x0d, 0xae, 0xd4, 0x43} }
|
|
|
|
#define DEBUG_MASK_VARIABLE_NAME L"EFIDebug"
|
|
|
|
extern EFI_GUID gEfiGenericVariableGuid;
|