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>
80 lines
3.5 KiB
C
80 lines
3.5 KiB
C
/** @file -- VarCheckPolicyMmiCommon.h
|
|
This header contains communication definitions that are shared between DXE
|
|
and the MM component of VarCheckPolicy.
|
|
|
|
Copyright (c) Microsoft Corporation.
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define VAR_CHECK_POLICY_COMM_SIG SIGNATURE_32('V', 'C', 'P', 'C')
|
|
#define VAR_CHECK_POLICY_COMM_REVISION 1
|
|
|
|
#pragma pack(push, 1)
|
|
|
|
typedef struct _VAR_CHECK_POLICY_COMM_HEADER {
|
|
UINT32 Signature;
|
|
UINT32 Revision;
|
|
UINT32 Command;
|
|
EFI_STATUS Result;
|
|
} VAR_CHECK_POLICY_COMM_HEADER;
|
|
|
|
typedef struct _VAR_CHECK_POLICY_COMM_IS_ENABLED_PARAMS {
|
|
BOOLEAN State;
|
|
} VAR_CHECK_POLICY_COMM_IS_ENABLED_PARAMS;
|
|
|
|
typedef struct _VAR_CHECK_POLICY_COMM_DUMP_PARAMS {
|
|
UINT32 PageRequested;
|
|
UINT32 TotalSize;
|
|
UINT32 PageSize;
|
|
BOOLEAN HasMore;
|
|
} VAR_CHECK_POLICY_COMM_DUMP_PARAMS;
|
|
|
|
typedef union {
|
|
VARIABLE_POLICY_ENTRY VariablePolicy;
|
|
VARIABLE_LOCK_ON_VAR_STATE_POLICY LockOnVarStatePolicy;
|
|
} VAR_CHECK_POLICY_OUTPUT_POLICY_ENTRY;
|
|
|
|
typedef struct _VAR_CHECK_POLICY_COMM_GET_INFO_PARAMS {
|
|
EFI_GUID InputVendorGuid;
|
|
UINT32 InputVariableNameSize;
|
|
UINT32 OutputVariableNameSize;
|
|
VAR_CHECK_POLICY_OUTPUT_POLICY_ENTRY OutputPolicyEntry;
|
|
CHAR16 InputVariableName[1];
|
|
} VAR_CHECK_POLICY_COMM_GET_INFO_PARAMS;
|
|
|
|
#pragma pack(pop)
|
|
|
|
#define VAR_CHECK_POLICY_COMM_GET_INFO_PARAMS_END \
|
|
(OFFSET_OF(VAR_CHECK_POLICY_COMM_GET_INFO_PARAMS, InputVariableName))
|
|
|
|
// Make sure that we will hold at least the headers.
|
|
#define VAR_CHECK_POLICY_MM_COMM_BUFFER_SIZE MAX((OFFSET_OF(EFI_MM_COMMUNICATE_HEADER, Data) + sizeof (VAR_CHECK_POLICY_COMM_HEADER) + EFI_PAGES_TO_SIZE(1)), EFI_PAGES_TO_SIZE(4))
|
|
#define VAR_CHECK_POLICY_MM_DUMP_BUFFER_SIZE (VAR_CHECK_POLICY_MM_COMM_BUFFER_SIZE - \
|
|
(OFFSET_OF(EFI_MM_COMMUNICATE_HEADER, Data) + \
|
|
sizeof(VAR_CHECK_POLICY_COMM_HEADER) + \
|
|
sizeof(VAR_CHECK_POLICY_COMM_DUMP_PARAMS)))
|
|
|
|
#define VAR_CHECK_POLICY_MM_GET_INFO_BUFFER_SIZE (VAR_CHECK_POLICY_MM_COMM_BUFFER_SIZE - \
|
|
(OFFSET_OF(EFI_MM_COMMUNICATE_HEADER, Data) + \
|
|
sizeof(VAR_CHECK_POLICY_COMM_HEADER) + \
|
|
OFFSET_OF(VAR_CHECK_POLICY_COMM_GET_INFO_PARAMS, InputVariableName)))
|
|
|
|
STATIC_ASSERT (
|
|
VAR_CHECK_POLICY_MM_DUMP_BUFFER_SIZE < VAR_CHECK_POLICY_MM_COMM_BUFFER_SIZE,
|
|
"an integer underflow may have occurred calculating VAR_CHECK_POLICY_MM_DUMP_BUFFER_SIZE"
|
|
);
|
|
|
|
STATIC_ASSERT (
|
|
VAR_CHECK_POLICY_MM_GET_INFO_BUFFER_SIZE < VAR_CHECK_POLICY_MM_COMM_BUFFER_SIZE,
|
|
"an integer underflow may have occurred calculating VAR_CHECK_POLICY_MM_GET_INFO_BUFFER_SIZE"
|
|
);
|
|
|
|
#define VAR_CHECK_POLICY_COMMAND_DISABLE 0x0001
|
|
#define VAR_CHECK_POLICY_COMMAND_IS_ENABLED 0x0002
|
|
#define VAR_CHECK_POLICY_COMMAND_REGISTER 0x0003
|
|
#define VAR_CHECK_POLICY_COMMAND_DUMP 0x0004
|
|
#define VAR_CHECK_POLICY_COMMAND_LOCK 0x0005
|
|
#define VAR_CHECK_POLICY_COMMAND_GET_INFO 0x0006
|
|
#define VAR_CHECK_POLICY_COMMAND_GET_LOCK_VAR_STATE_INFO 0x0007
|