mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
9326c0eb0a
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>
132 lines
3.7 KiB
C
132 lines
3.7 KiB
C
/** @file
|
|
Provides a functions to enroll keys based on default values.
|
|
|
|
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
(C) Copyright 2018 Hewlett Packard Enterprise Development LP<BR>
|
|
Copyright (c) 2021, ARM Ltd. All rights reserved.<BR>
|
|
Copyright (c) 2021, Semihalf All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
Sets the content of the 'db' variable based on 'dbDefault' variable content.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES If memory allocation for EFI_VARIABLE_AUTHENTICATION_2 fails
|
|
while VendorGuid is NULL.
|
|
@retval other Errors from GetVariable2(), GetTime() and SetVariable()
|
|
--*/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EnrollDbFromDefault (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Sets the content of the 'dbx' variable based on 'dbxDefault' variable content.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES If memory allocation for EFI_VARIABLE_AUTHENTICATION_2 fails
|
|
while VendorGuid is NULL.
|
|
@retval other Errors from GetVariable2(), GetTime() and SetVariable()
|
|
--*/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EnrollDbxFromDefault (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Sets the content of the 'dbt' variable based on 'dbtDefault' variable content.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES If memory allocation for EFI_VARIABLE_AUTHENTICATION_2 fails
|
|
while VendorGuid is NULL.
|
|
@retval other Errors from GetVariable2(), GetTime() and SetVariable()
|
|
--*/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EnrollDbtFromDefault (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Sets the content of the 'KEK' variable based on 'KEKDefault' variable content.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES If memory allocation for EFI_VARIABLE_AUTHENTICATION_2 fails
|
|
while VendorGuid is NULL.
|
|
@retval other Errors from GetVariable2(), GetTime() and SetVariable()
|
|
--*/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EnrollKEKFromDefault (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Sets the content of the 'PK' variable based on 'PKDefault' variable content.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES If memory allocation for EFI_VARIABLE_AUTHENTICATION_2 fails
|
|
while VendorGuid is NULL.
|
|
@retval other Errors from GetVariable2(), GetTime() and SetVariable()
|
|
--*/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EnrollPKFromDefault (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Initializes PKDefault variable with data from FFS section.
|
|
|
|
@retval EFI_SUCCESS Variable was initialized successfully.
|
|
@retval EFI_UNSUPPORTED Variable already exists.
|
|
--*/
|
|
EFI_STATUS
|
|
SecureBootInitPKDefault (
|
|
IN VOID
|
|
);
|
|
|
|
/**
|
|
Initializes KEKDefault variable with data from FFS section.
|
|
|
|
@retval EFI_SUCCESS Variable was initialized successfully.
|
|
@retval EFI_UNSUPPORTED Variable already exists.
|
|
--*/
|
|
EFI_STATUS
|
|
SecureBootInitKEKDefault (
|
|
IN VOID
|
|
);
|
|
|
|
/**
|
|
Initializes dbDefault variable with data from FFS section.
|
|
|
|
@retval EFI_SUCCESS Variable was initialized successfully.
|
|
@retval EFI_UNSUPPORTED Variable already exists.
|
|
--*/
|
|
EFI_STATUS
|
|
SecureBootInitDbDefault (
|
|
IN VOID
|
|
);
|
|
|
|
/**
|
|
Initializes dbtDefault variable with data from FFS section.
|
|
|
|
@retval EFI_SUCCESS Variable was initialized successfully.
|
|
@retval EFI_UNSUPPORTED Variable already exists.
|
|
--*/
|
|
EFI_STATUS
|
|
SecureBootInitDbtDefault (
|
|
IN VOID
|
|
);
|
|
|
|
/**
|
|
Initializes dbxDefault variable with data from FFS section.
|
|
|
|
@retval EFI_SUCCESS Variable was initialized successfully.
|
|
@retval EFI_UNSUPPORTED Variable already exists.
|
|
--*/
|
|
EFI_STATUS
|
|
SecureBootInitDbxDefault (
|
|
IN VOID
|
|
);
|