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>
32 lines
950 B
C
32 lines
950 B
C
/** @file
|
|
Register a status code handler for printing the Boot Manager's LoadImage()
|
|
and StartImage() preparations, and return codes, to the UEFI console.
|
|
|
|
This feature enables users that are not accustomed to analyzing the firmware
|
|
log to glean some information about UEFI boot option processing (loading and
|
|
starting).
|
|
|
|
Copyright (C) 2019, Red Hat, Inc.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Uefi/UefiBaseType.h>
|
|
|
|
/**
|
|
Register a status code handler for printing the Boot Manager's LoadImage()
|
|
and StartImage() preparations, and return codes, to the UEFI console.
|
|
|
|
@retval EFI_SUCCESS The status code handler has been successfully
|
|
registered.
|
|
|
|
@return Error codes propagated from boot services and from
|
|
EFI_RSC_HANDLER_PROTOCOL.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
PlatformBmPrintScRegisterHandler (
|
|
VOID
|
|
);
|