mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
de527ff606
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>
169 lines
2.8 KiB
C
169 lines
2.8 KiB
C
/** @file
|
|
|
|
Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
VOID
|
|
LibMtcInitialize (
|
|
VOID
|
|
);
|
|
|
|
VOID
|
|
LibMtcVirtualAddressChangeEvent (
|
|
VOID
|
|
);
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
LibMtcGetNextHighMonotonicCount (
|
|
OUT UINT32 *HighCount
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibMtcGetNextMonotonicCount (
|
|
OUT UINT64 *Count
|
|
);
|
|
|
|
VOID
|
|
LibVariableInitialize (
|
|
VOID
|
|
);
|
|
|
|
VOID
|
|
LibVariableVirtualAddressChangeEvent (
|
|
VOID
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibGetVariable (
|
|
IN CHAR16 *VariableName,
|
|
IN EFI_GUID *VendorGuid,
|
|
OUT UINT32 *Attributes OPTIONAL,
|
|
IN OUT UINTN *DataSize,
|
|
OUT VOID *Data
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibGetNextVariableName (
|
|
IN OUT UINTN *VariableNameSize,
|
|
IN OUT CHAR16 *VariableName,
|
|
IN OUT EFI_GUID *VendorGuid
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibSetVariable (
|
|
IN CHAR16 *VariableName,
|
|
IN EFI_GUID *VendorGuid,
|
|
IN UINT32 Attributes,
|
|
IN UINTN DataSize,
|
|
IN VOID *Data
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibQueryVariableInfo (
|
|
IN UINT32 Attributes,
|
|
OUT UINT64 *MaximumVariableStorageSize,
|
|
OUT UINT64 *RemainingVariableStorageSize,
|
|
OUT UINT64 *MaximumVariableSize
|
|
);
|
|
|
|
VOID
|
|
LibResetInitializeReset (
|
|
VOID
|
|
);
|
|
|
|
VOID
|
|
LibResetVirtualAddressChangeEvent (
|
|
VOID
|
|
);
|
|
|
|
VOID
|
|
LibResetSystem (
|
|
IN EFI_RESET_TYPE ResetType,
|
|
IN EFI_STATUS ResetStatus,
|
|
IN UINTN DataSize,
|
|
IN CHAR16 *ResetData OPTIONAL
|
|
);
|
|
|
|
VOID
|
|
LibCapsuleInitialize (
|
|
VOID
|
|
);
|
|
|
|
VOID
|
|
LibCapsuleVirtualAddressChangeEvent (
|
|
VOID
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibUpdateCapsule (
|
|
IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray,
|
|
IN UINTN CapsuleCount,
|
|
IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
|
|
);
|
|
|
|
EFI_STATUS
|
|
QueryCapsuleCapabilities (
|
|
IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray,
|
|
IN UINTN CapsuleCount,
|
|
OUT UINT64 *MaxiumCapsuleSize,
|
|
OUT EFI_RESET_TYPE *ResetType
|
|
);
|
|
|
|
VOID
|
|
LibRtcInitialize (
|
|
VOID
|
|
);
|
|
|
|
VOID
|
|
LibRtcVirtualAddressChangeEvent (
|
|
VOID
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibGetTime (
|
|
OUT EFI_TIME *Time,
|
|
OUT EFI_TIME_CAPABILITIES *Capabilities
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibSetTime (
|
|
IN EFI_TIME *Time
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibGetWakeupTime (
|
|
OUT BOOLEAN *Enabled,
|
|
OUT BOOLEAN *Pending,
|
|
OUT EFI_TIME *Time
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibSetWakeupTime (
|
|
IN BOOLEAN Enabled,
|
|
OUT EFI_TIME *Time
|
|
);
|
|
|
|
VOID
|
|
LibReportStatusCodeInitialize (
|
|
VOID
|
|
);
|
|
|
|
VOID
|
|
LibReportStatusCodeVirtualAddressChangeEvent (
|
|
VOID
|
|
);
|
|
|
|
EFI_STATUS
|
|
LibReportStatusCode (
|
|
IN EFI_STATUS_CODE_TYPE CodeType,
|
|
IN EFI_STATUS_CODE_VALUE Value,
|
|
IN UINT32 Instance,
|
|
IN EFI_GUID *CallerId,
|
|
IN EFI_STATUS_CODE_DATA *Data OPTIONAL
|
|
);
|