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>
114 lines
3.7 KiB
C
114 lines
3.7 KiB
C
/** @file
|
|
Dynamic Platform Info Repository
|
|
|
|
Copyright (c) 2021, Arm Limited. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
@par Glossary:
|
|
- Cm or CM - Configuration Manager
|
|
- Obj or OBJ - Object
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Protocol/ConfigurationManagerProtocol.h>
|
|
|
|
/** A structure describing the platform configuration
|
|
manager repository information
|
|
*/
|
|
typedef VOID *DYNAMIC_PLATFORM_REPOSITORY_INFO;
|
|
|
|
/** Add an object to the dynamic platform repository.
|
|
|
|
@param [in] This This dynamic platform repository.
|
|
@param [in] CmObjDesc CmObj to add. The data is copied.
|
|
@param [in] NewToken Token for this object. If CM_NULL_TOKEN, then
|
|
a new token is generated.
|
|
@param [out] Token If not NULL, token allocated to this CmObj.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_OUT_OF_RESOURCES An allocation has failed.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
DynPlatRepoAddObject (
|
|
IN DYNAMIC_PLATFORM_REPOSITORY_INFO *This,
|
|
IN CONST CM_OBJ_DESCRIPTOR *CmObjDesc,
|
|
IN CM_OBJECT_TOKEN NewToken,
|
|
OUT CM_OBJECT_TOKEN *Token OPTIONAL
|
|
);
|
|
|
|
/** Finalise the dynamic repository.
|
|
|
|
Finalising means:
|
|
- Preventing any further objects from being added.
|
|
- Allowing to get objects from the dynamic repository
|
|
(not possible before a call to this function).
|
|
|
|
@param [in] This This dynamic platform repository.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_ALREADY_STARTED Instance already initialised.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_BUFFER_TOO_SMALL Buffer too small.
|
|
@retval EFI_OUT_OF_RESOURCES An allocation has failed.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
DynamicPlatRepoFinalise (
|
|
IN DYNAMIC_PLATFORM_REPOSITORY_INFO *This
|
|
);
|
|
|
|
/** Get a CmObj from the dynamic repository.
|
|
|
|
@param [in] This Pointer to the Dynamic Platform Repository.
|
|
@param [in] CmObjectId The Configuration Manager Object ID.
|
|
@param [in] Token An optional token identifying the object. If
|
|
unused this must be CM_NULL_TOKEN.
|
|
@param [in, out] CmObjDesc Pointer to the Configuration Manager Object
|
|
descriptor describing the requested Object.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_NOT_FOUND The required object information is not found.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
DynamicPlatRepoGetObject (
|
|
IN DYNAMIC_PLATFORM_REPOSITORY_INFO *This,
|
|
IN CM_OBJECT_ID CmObjectId,
|
|
IN CM_OBJECT_TOKEN Token OPTIONAL,
|
|
IN OUT CM_OBJ_DESCRIPTOR *CmObjDesc
|
|
);
|
|
|
|
/** Initialize the dynamic platform repository.
|
|
|
|
@param [out] DynPlatRepo If success, contains the initialised dynamic
|
|
platform repository.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_OUT_OF_RESOURCES An allocation has failed.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
DynamicPlatRepoInit (
|
|
OUT DYNAMIC_PLATFORM_REPOSITORY_INFO **DynPlatRepo
|
|
);
|
|
|
|
/** Shutdown the dynamic platform repository.
|
|
|
|
Free all the memory allocated for the dynamic platform repository.
|
|
|
|
@param [in] DynPlatRepo The dynamic platform repository.
|
|
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_SUCCESS Success.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
DynamicPlatRepoShutdown (
|
|
IN DYNAMIC_PLATFORM_REPOSITORY_INFO *DynPlatRepo
|
|
);
|