mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
01f75b3927
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>
141 lines
4.9 KiB
C
141 lines
4.9 KiB
C
/** @file
|
|
Metadata Handler Library.
|
|
|
|
Copyright (c) 2025, Arm Limited. All rights reserved.
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/** Query the MetadataObjLib for metadata matching the input (Type/Token).
|
|
If the metadata exists, return it.
|
|
Otherwise:
|
|
- Generate a new metadata object
|
|
- Add it to the MetadataObjLib
|
|
- return it
|
|
|
|
@param[in] Root Root of the Metadata information.
|
|
@param[in] Type METADATA_TYPE of the entry to generate.
|
|
@param[in] Token Token uniquely identifying an entry among other
|
|
objects with the input METADATA_TYPE.
|
|
@param[in] Context Optional context to use during the Metadata generation.
|
|
@param[in, out] Metadata On input, can contain METADATA_TYPE-specific information.
|
|
On output and if success, contains the generated
|
|
Metadata object.
|
|
@param[in] MetadataSize Size of the input Metadata.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
**/
|
|
typedef EFI_STATUS (EFIAPI *METADATA_GENERATOR)(
|
|
IN METADATA_ROOT_HANDLE Root,
|
|
IN METADATA_TYPE Type,
|
|
IN CM_OBJECT_TOKEN Token,
|
|
IN VOID *Context,
|
|
IN OUT VOID *Metadata,
|
|
IN UINT32 MetadataSize
|
|
);
|
|
|
|
/** Validate the Metadata.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
**/
|
|
typedef EFI_STATUS (EFIAPI *METADATA_VALIDATOR)(
|
|
IN METADATA_ROOT_HANDLE Root
|
|
);
|
|
|
|
/** Metadata Handlers.
|
|
*/
|
|
typedef struct MetadataHandlers {
|
|
METADATA_GENERATOR Generate;
|
|
METADATA_VALIDATOR Validate;
|
|
} METADATA_HANDLERS;
|
|
|
|
/** Query the MetadataObjLib for metadata matching the input (Type/Token).
|
|
If the metadata exists, return it.
|
|
Otherwise:
|
|
- Generate a new metadata object
|
|
- Add it to the MetadataObjLib
|
|
- return it
|
|
|
|
@param[in] Root Root of the Metadata information.
|
|
@param[in] Type METADATA_TYPE of the entry to generate.
|
|
@param[in] Token Token uniquely identifying an entry among other
|
|
objects with the input METADATA_TYPE.
|
|
@param[in] Context Optional context to use during the Metadata generation.
|
|
@param[in, out] Metadata On input, can contain METADATA_TYPE-specific information.
|
|
On output and if success, contains the generated
|
|
Metadata object.
|
|
@param[in] MetadataSize Size of the input Metadata.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
MetadataGenerateUid (
|
|
IN METADATA_ROOT_HANDLE Root,
|
|
IN METADATA_TYPE Type,
|
|
IN CM_OBJECT_TOKEN Token,
|
|
IN VOID *Context,
|
|
IN OUT VOID *Metadata,
|
|
IN UINT32 MetadataSize
|
|
);
|
|
|
|
/** Validate the Metadata.
|
|
|
|
@param[in] Root Root of the Metadata information.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
MetadataValidateUid (
|
|
IN METADATA_ROOT_HANDLE Root
|
|
);
|
|
|
|
/** Query the MetadataObjLib for metadata matching the input (Type/Token).
|
|
If the metadata exists, return it.
|
|
Otherwise:
|
|
- Generate a new metadata object
|
|
- Add it to the MetadataObjLib
|
|
- return it
|
|
|
|
@param[in] Root Root of the Metadata information.
|
|
@param[in] Type METADATA_TYPE of the entry to generate.
|
|
@param[in] Token Token uniquely identifying an entry among other
|
|
objects with the input METADATA_TYPE.
|
|
@param[in] Context Optional context to use during the Metadata generation.
|
|
@param[in, out] Metadata On input, can contain METADATA_TYPE-specific information.
|
|
On output and if success, contains the generated
|
|
Metadata object.
|
|
@param[in] MetadataSize Size of the input Metadata.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
MetadataGenerateProximityDomain (
|
|
IN METADATA_ROOT_HANDLE Root,
|
|
IN METADATA_TYPE Type,
|
|
IN CM_OBJECT_TOKEN Token,
|
|
IN VOID *Context,
|
|
IN OUT VOID *Metadata,
|
|
IN UINT32 MetadataSize
|
|
);
|
|
|
|
/** Validate the Metadata.
|
|
|
|
@param[in] Root Root of the Metadata information.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
MetadataValidateProximityDomain (
|
|
IN METADATA_ROOT_HANDLE Root
|
|
);
|