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>
123 lines
3.9 KiB
C
123 lines
3.9 KiB
C
/** @file
|
|
This is definition for service binding for Hash driver.
|
|
|
|
Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Uefi.h>
|
|
|
|
#include <Protocol/ServiceBinding.h>
|
|
#include <Protocol/Hash2.h>
|
|
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/UefiRuntimeServicesTableLib.h>
|
|
#include <Library/DevicePathLib.h>
|
|
#include <Library/UefiLib.h>
|
|
|
|
#define HASH2_SERVICE_DATA_SIGNATURE SIGNATURE_32 ('H', 'S', '2', 'S')
|
|
|
|
typedef struct {
|
|
UINT32 Signature;
|
|
EFI_HANDLE ServiceHandle;
|
|
EFI_SERVICE_BINDING_PROTOCOL ServiceBinding;
|
|
|
|
LIST_ENTRY ChildrenList;
|
|
} HASH2_SERVICE_DATA;
|
|
|
|
#define HASH2_SERVICE_DATA_FROM_THIS(a) \
|
|
CR ( \
|
|
(a), \
|
|
HASH2_SERVICE_DATA, \
|
|
ServiceBinding, \
|
|
HASH2_SERVICE_DATA_SIGNATURE \
|
|
)
|
|
|
|
#define HASH2_INSTANCE_DATA_SIGNATURE SIGNATURE_32 ('H', 's', '2', 'I')
|
|
|
|
typedef struct {
|
|
UINT32 Signature;
|
|
HASH2_SERVICE_DATA *Hash2ServiceData;
|
|
EFI_HANDLE Handle;
|
|
LIST_ENTRY InstEntry;
|
|
EFI_HASH2_PROTOCOL Hash2Protocol;
|
|
VOID *HashContext;
|
|
VOID *HashInfoContext;
|
|
BOOLEAN Updated;
|
|
} HASH2_INSTANCE_DATA;
|
|
|
|
#define HASH2_INSTANCE_DATA_FROM_THIS(a) \
|
|
CR ( \
|
|
(a), \
|
|
HASH2_INSTANCE_DATA, \
|
|
Hash2Protocol, \
|
|
HASH2_INSTANCE_DATA_SIGNATURE \
|
|
)
|
|
|
|
#define HASH2_INSTANCE_DATA_FROM_LINK(a) \
|
|
CR ( \
|
|
(a), \
|
|
HASH2_INSTANCE_DATA, \
|
|
InstEntry, \
|
|
HASH2_INSTANCE_DATA_SIGNATURE \
|
|
)
|
|
|
|
/**
|
|
Creates a child handle with a set of I/O services.
|
|
|
|
@param[in] This Protocol instance pointer.
|
|
@param[in, out] ChildHandle Pointer to the handle of the child to create. If
|
|
it is NULL, then a new handle is created. If
|
|
it is not NULL, then the I/O services are added
|
|
to the existing child handle.
|
|
|
|
@retval EFI_SUCCESS The protocol was added to ChildHandle.
|
|
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
|
|
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to
|
|
create the child.
|
|
@retval Others The child handle was not created.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
Hash2ServiceBindingCreateChild (
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
|
IN OUT EFI_HANDLE *ChildHandle
|
|
);
|
|
|
|
/**
|
|
Destroys a child handle with a set of I/O services.
|
|
|
|
The DestroyChild() function does the opposite of CreateChild(). It removes a
|
|
protocol that was installed by CreateChild() from ChildHandle. If the removed
|
|
protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.
|
|
|
|
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL
|
|
instance.
|
|
@param[in] ChildHandle Handle of the child to destroy.
|
|
|
|
@retval EFI_SUCCESS The protocol was removed from ChildHandle.
|
|
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that
|
|
is being removed.
|
|
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
|
|
@retval EFI_ACCESS_DENIED The protocol could not be removed from the
|
|
ChildHandle because its services are being
|
|
used.
|
|
@retval Others The child handle was not destroyed.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
Hash2ServiceBindingDestroyChild (
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
|
IN EFI_HANDLE ChildHandle
|
|
);
|
|
|
|
extern EFI_HASH2_PROTOCOL mHash2Protocol;
|