mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-06-13 19:16:19 -07:00
Michael Kubackiandmergify[bot]
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>
81 lines
3.0 KiB
C
81 lines
3.0 KiB
C
/** @file
|
|
|
|
Copyright (c) 2023, Google LLC. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Uefi/UefiSpec.h>
|
|
|
|
///
|
|
/// Global ID for the EDKII_MEMORY_ATTRIBUTE_PPI.
|
|
///
|
|
#define EDKII_MEMORY_ATTRIBUTE_PPI_GUID \
|
|
{ \
|
|
0x1be840de, 0x2d92, 0x41ec, { 0xb6, 0xd3, 0x19, 0x64, 0x13, 0x50, 0x51, 0xfb } \
|
|
}
|
|
|
|
///
|
|
/// Forward declaration for the EDKII_MEMORY_ATTRIBUTE_PPI.
|
|
///
|
|
typedef struct _EDKII_MEMORY_ATTRIBUTE_PPI EDKII_MEMORY_ATTRIBUTE_PPI;
|
|
|
|
/**
|
|
Set the requested memory permission attributes on a region of memory.
|
|
|
|
BaseAddress and Length must be aligned to EFI_PAGE_SIZE.
|
|
|
|
Attributes must contain a combination of EFI_MEMORY_RP, EFI_MEMORY_RO and
|
|
EFI_MEMORY_XP, and specifies the attributes that must be set for the
|
|
region in question. Attributes that are omitted will be cleared from the
|
|
region only if they are set in AttributeMask.
|
|
|
|
AttributeMask must contain a combination of EFI_MEMORY_RP, EFI_MEMORY_RO and
|
|
EFI_MEMORY_XP, and specifies the attributes that the call will operate on.
|
|
AttributeMask must not be 0x0, and must contain at least the bits set in
|
|
Attributes.
|
|
|
|
@param[in] This The protocol instance pointer.
|
|
@param[in] BaseAddress The physical address that is the start address
|
|
of a memory region.
|
|
@param[in] Length The size in bytes of the memory region.
|
|
@param[in] Attributes Memory attributes to set or clear.
|
|
@param[in] AttributeMask Mask of memory attributes to operate on.
|
|
|
|
@retval EFI_SUCCESS The attributes were set for the memory region.
|
|
@retval EFI_INVALID_PARAMETER Length is zero.
|
|
AttributeMask is zero.
|
|
AttributeMask lacks bits set in Attributes.
|
|
BaseAddress or Length is not suitably aligned.
|
|
@retval EFI_UNSUPPORTED The processor does not support one or more
|
|
bytes of the memory resource range specified
|
|
by BaseAddress and Length.
|
|
The bit mask of attributes is not supported for
|
|
the memory resource range specified by
|
|
BaseAddress and Length.
|
|
@retval EFI_OUT_OF_RESOURCES Requested attributes cannot be applied due to
|
|
lack of system resources.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_MEMORY_ATTRIBUTE_SET_PERMISSIONS)(
|
|
IN EDKII_MEMORY_ATTRIBUTE_PPI *This,
|
|
IN EFI_PHYSICAL_ADDRESS BaseAddress,
|
|
IN UINT64 Length,
|
|
IN UINT64 Attributes,
|
|
IN UINT64 AttributeMask
|
|
);
|
|
|
|
///
|
|
/// This PPI contains a set of services to manage memory permission attributes.
|
|
///
|
|
struct _EDKII_MEMORY_ATTRIBUTE_PPI {
|
|
EDKII_MEMORY_ATTRIBUTE_SET_PERMISSIONS SetPermissions;
|
|
};
|
|
|
|
extern EFI_GUID gEdkiiMemoryAttributePpiGuid;
|