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>
123 lines
4.5 KiB
C
123 lines
4.5 KiB
C
/** @file
|
|
|
|
Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
@par Glossary:
|
|
- Std - Standard
|
|
- ACPI - Advanced Configuration and Power Interface
|
|
- SMBIOS - System Management BIOS
|
|
- DT - Device Tree
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#pragma pack(1)
|
|
|
|
/** A structure that holds the list of registered ACPI and
|
|
SMBIOS table generators.
|
|
*/
|
|
typedef struct DynamicTableFactoryInfo {
|
|
/// An array for holding the list of Standard ACPI Table Generators.
|
|
CONST ACPI_TABLE_GENERATOR *
|
|
StdAcpiTableGeneratorList[EStdAcpiTableIdMax];
|
|
|
|
/// An array for holding the list of Custom ACPI Table Generators.
|
|
CONST ACPI_TABLE_GENERATOR *
|
|
CustomAcpiTableGeneratorList[FixedPcdGet16 (
|
|
PcdMaxCustomACPIGenerators
|
|
)];
|
|
|
|
/// An array for holding the list of Standard SMBIOS Table Generators.
|
|
CONST SMBIOS_TABLE_GENERATOR *
|
|
StdSmbiosTableGeneratorList[EStdSmbiosTableIdMax];
|
|
|
|
/// An array for holding the list of Custom SMBIOS Table Generators.
|
|
CONST SMBIOS_TABLE_GENERATOR *
|
|
CustomSmbiosTableGeneratorList[FixedPcdGet16 (
|
|
PcdMaxCustomSMBIOSGenerators
|
|
)];
|
|
|
|
/// An array for holding the list of Standard DT Table Generators.
|
|
CONST DT_TABLE_GENERATOR *
|
|
StdDtTableGeneratorList[EStdDtTableIdMax];
|
|
|
|
/// An array for holding the list of Custom DT Table Generators.
|
|
CONST DT_TABLE_GENERATOR *
|
|
CustomDtTableGeneratorList[FixedPcdGet16 (
|
|
PcdMaxCustomDTGenerators
|
|
)];
|
|
|
|
/// An array for holding a map of SMBIOS handles and the CM Object
|
|
/// token used to build the SMBIOS record.
|
|
SMBIOS_HANDLE_MAP
|
|
SmbiosHandleMap[FixedPcdGet16 (
|
|
PcdMaxSmbiosHandleMapEntries
|
|
)];
|
|
} EDKII_DYNAMIC_TABLE_FACTORY_INFO;
|
|
|
|
/** Return a pointer to the ACPI table generator.
|
|
|
|
@param [in] This Pointer to the Dynamic Table Factory Protocol.
|
|
@param [in] GeneratorId The ACPI table generator ID for the
|
|
requested generator.
|
|
@param [out] Generator Pointer to the requested ACPI table
|
|
generator.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_NOT_FOUND The requested generator is not found
|
|
in the list of registered generators.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetAcpiTableGenerator (
|
|
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This,
|
|
IN CONST ACPI_TABLE_GENERATOR_ID GeneratorId,
|
|
OUT CONST ACPI_TABLE_GENERATOR **CONST Generator
|
|
);
|
|
|
|
/** Return a pointer to the SMBIOS table generator.
|
|
|
|
@param [in] This Pointer to the Dynamic Table Factory Protocol.
|
|
@param [in] GeneratorId The SMBIOS table generator ID for the
|
|
requested generator.
|
|
@param [out] Generator Pointer to the requested SMBIOS table
|
|
generator.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_NOT_FOUND The requested generator is not found
|
|
in the list of registered generators.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetSmbiosTableGenerator (
|
|
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This,
|
|
IN CONST SMBIOS_TABLE_GENERATOR_ID GeneratorId,
|
|
OUT CONST SMBIOS_TABLE_GENERATOR **CONST Generator
|
|
);
|
|
|
|
/** Return a pointer to the DT table generator.
|
|
|
|
@param [in] This Pointer to the Dynamic Table Factory Protocol.
|
|
@param [in] GeneratorId The DT table generator ID for the
|
|
requested generator.
|
|
@param [out] Generator Pointer to the requested DT table
|
|
generator.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_NOT_FOUND The requested generator is not found
|
|
in the list of registered generators.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetDtTableGenerator (
|
|
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This,
|
|
IN CONST DT_TABLE_GENERATOR_ID GeneratorId,
|
|
OUT CONST DT_TABLE_GENERATOR **CONST Generator
|
|
);
|
|
|
|
#pragma pack()
|