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>
129 lines
2.7 KiB
C
129 lines
2.7 KiB
C
/** @file
|
|
Include file for Var Check Hii bin generation.
|
|
|
|
Copyright (c) 2024, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include "VarCheckHii.h"
|
|
extern VAR_CHECK_HII_VARIABLE_HEADER *mVarCheckHiiBin;
|
|
extern UINTN mVarCheckHiiBinSize;
|
|
|
|
/**
|
|
Dump Hii Package.
|
|
|
|
@param[in] HiiPackage Pointer to Hii Package.
|
|
|
|
**/
|
|
VOID
|
|
DumpHiiPackage (
|
|
IN VOID *HiiPackage
|
|
);
|
|
|
|
/**
|
|
Dump Hii Database.
|
|
|
|
@param[in] HiiDatabase Pointer to Hii Database.
|
|
@param[in] HiiDatabaseSize Hii Database size.
|
|
|
|
**/
|
|
VOID
|
|
DumpHiiDatabase (
|
|
IN VOID *HiiDatabase,
|
|
IN UINTN HiiDatabaseSize
|
|
);
|
|
|
|
/**
|
|
Allocates and zeros a buffer of type EfiBootServicesData.
|
|
|
|
Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the
|
|
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
|
|
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
|
|
request, then NULL is returned.
|
|
|
|
@param AllocationSize The number of bytes to allocate and zero.
|
|
|
|
@return A pointer to the allocated buffer or NULL if allocation fails.
|
|
|
|
**/
|
|
VOID *
|
|
InternalVarCheckAllocateZeroPool (
|
|
IN UINTN AllocationSize
|
|
);
|
|
|
|
/**
|
|
Frees a buffer that was previously allocated with one of the pool allocation functions in the
|
|
Memory Allocation Library.
|
|
|
|
Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the
|
|
pool allocation services of the Memory Allocation Library. If it is not possible to free pool
|
|
resources, then this function will perform no actions.
|
|
|
|
If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,
|
|
then ASSERT().
|
|
|
|
@param Buffer The pointer to the buffer to free.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
InternalVarCheckFreePool (
|
|
IN VOID *Buffer
|
|
);
|
|
|
|
/**
|
|
Var Check Parse Hii Package.
|
|
|
|
@param[in] HiiPackage Pointer to Hii Package.
|
|
@param[in] FromFv Hii Package from FV.
|
|
|
|
**/
|
|
VOID
|
|
VarCheckParseHiiPackage (
|
|
IN VOID *HiiPackage,
|
|
IN BOOLEAN FromFv
|
|
);
|
|
|
|
/**
|
|
Var Check Parse Hii Database.
|
|
|
|
@param[in] HiiDatabase Pointer to Hii Database.
|
|
@param[in] HiiDatabaseSize Hii Database size.
|
|
|
|
**/
|
|
VOID
|
|
VarCheckParseHiiDatabase (
|
|
IN VOID *HiiDatabase,
|
|
IN UINTN HiiDatabaseSize
|
|
);
|
|
|
|
/**
|
|
Generate from FV.
|
|
|
|
**/
|
|
VOID
|
|
VarCheckHiiGenFromFv (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Generate from Hii Database.
|
|
|
|
**/
|
|
VOID
|
|
VarCheckHiiGenFromHiiDatabase (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Generate VarCheckHiiBin from Hii Database and FV.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
VarCheckHiiGen (
|
|
VOID
|
|
);
|