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>
59 lines
2.3 KiB
C
59 lines
2.3 KiB
C
/** @file
|
|
Migrated FV information
|
|
|
|
Copyright (c) 2020 - 2024, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
//
|
|
// FLAGS_FV_RAW_DATA_COPY indicates FV raw data will be copied to permanent memory
|
|
// or not. When FV is migrated to permanent memory, it will be rebased and raw
|
|
// data will be lost. This bit can be configured as below values:
|
|
// 0: FV raw data will not be used in later phase, and the copy will be skipped to
|
|
// optimize boot performance.
|
|
// 1: FV raw data will be copied to permanent memory for later phase use (such as
|
|
// FV measurement).
|
|
//
|
|
#define FLAGS_FV_RAW_DATA_COPY BIT0
|
|
#define FLAGS_FV_MIGRATE_BEFORE_PEI_CORE_REENTRY BIT1
|
|
|
|
///
|
|
/// In real use cases, not all FVs need migrate to permanent memory before TempRam tears
|
|
/// down. EDKII_MIGRATION_INFO hob should be published by platform to indicate which
|
|
/// FVs need migration to optimize boot performance. If this hob is not detected by Pei
|
|
/// Core, all FVs on TempRam will be migrated and FV raw data will also be copied.
|
|
/// Only one EDKII_MIGRATION_INFO hob should be published by platform, and this hob will
|
|
/// take effect only when migration feature is enabled by PCD.
|
|
///
|
|
typedef struct {
|
|
UINT32 FvOrgBaseOnTempRam; // Original FV address on Temporary Ram
|
|
//
|
|
// FV Migration Flags:
|
|
// Bit0: Indicate to copy FV raw data or not
|
|
// Others: Reserved bits
|
|
//
|
|
UINT32 FvMigrationFlags;
|
|
} TO_MIGRATE_FV_INFO;
|
|
|
|
typedef struct {
|
|
BOOLEAN MigrateAll; // Migrate all FVs and also copy FV raw data
|
|
//
|
|
// ToMigrateFvCount and ToMigrateFvInfo array indicate which FVs need be migrated, and
|
|
// these info should be ignored when MigrateAll field is set to TRUE.
|
|
//
|
|
UINT32 ToMigrateFvCount;
|
|
// TO_MIGRATE_FV_INFO ToMigrateFvInfo[];
|
|
} EDKII_MIGRATION_INFO;
|
|
|
|
typedef struct {
|
|
UINT32 FvOrgBase; // original FV address
|
|
UINT32 FvNewBase; // new FV address, 0 means rebased data is not copied
|
|
UINT32 FvDataBase; // original FV data, 0 means raw data is not copied
|
|
UINT32 FvLength; // Fv Length
|
|
} EDKII_MIGRATED_FV_INFO;
|
|
|
|
extern EFI_GUID gEdkiiMigrationInfoGuid;
|
|
extern EFI_GUID gEdkiiMigratedFvInfoGuid;
|