mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
58de02af29
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>
94 lines
3.2 KiB
C
94 lines
3.2 KiB
C
/** @file
|
|
This file defines the EDKII HTTP Callback Protocol interface.
|
|
|
|
Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
|
|
Copyright (C) 2024 Advanced Micro Devices, Inc. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define EDKII_HTTP_CALLBACK_PROTOCOL_GUID \
|
|
{ \
|
|
0x611114f1, 0xa37b, 0x4468, {0xa4, 0x36, 0x5b, 0xdd, 0xa1, 0x6a, 0xa2, 0x40} \
|
|
}
|
|
|
|
typedef struct _EDKII_HTTP_CALLBACK_PROTOCOL EDKII_HTTP_CALLBACK_PROTOCOL;
|
|
|
|
///
|
|
/// EDKII_HTTP_CALLBACK_EVENT
|
|
///
|
|
typedef enum {
|
|
///
|
|
/// The Status of DNS Event to retrieve the host address.
|
|
/// EventStatus:
|
|
/// EFI_SUCCESS Operation succeeded.
|
|
/// EFI_OUT_OF_RESOURCES Failed to allocate needed resources.
|
|
/// EFI_DEVICE_ERROR An unexpected network error occurred.
|
|
/// Others Other errors as indicated.
|
|
///
|
|
HttpEventDns,
|
|
|
|
///
|
|
/// The Status of Event to initiate a nonblocking TCP connection request.
|
|
/// EventStatus:
|
|
/// EFI_SUCCESS The connection request is successfully initiated.
|
|
/// EFI_NOT_STARTED This EFI TCP Protocol instance has not been configured.
|
|
/// EFI_DEVICE_ERROR An unexpected system or network error occurred.
|
|
/// Others Other errors as indicated.
|
|
///
|
|
HttpEventConnectTcp,
|
|
|
|
///
|
|
/// The Status of Event to connect one TLS session by finishing the TLS handshake process.
|
|
/// EventStatus:
|
|
/// EFI_SUCCESS The TLS session is established.
|
|
/// EFI_OUT_OF_RESOURCES Can't allocate memory resources.
|
|
/// EFI_ABORTED TLS session state is incorrect.
|
|
/// Others Other error as indicated.
|
|
///
|
|
HttpEventTlsConnectSession,
|
|
|
|
///
|
|
/// The Status of Event to initialize Http session
|
|
/// EventStatus:
|
|
/// EFI_SUCCESS The initialization of session is done.
|
|
/// Others Other error as indicated.
|
|
///
|
|
HttpEventInitSession,
|
|
|
|
///
|
|
/// The Status of Event to configure TLS configuration data.
|
|
/// EventStatus:
|
|
/// EFI_SUCCESS The TLS is configured successfully with the default value.
|
|
/// EFI_INVALID_PARAMETER One or more input parameters to SetSessionData() is invalid.
|
|
/// EFI_NOT_READY Current TLS session state is NOT EfiTlsSessionStateNotStarted.
|
|
/// EFI_NOT_FOUND Fail to get 'HttpTlsCipherList' variable.
|
|
/// Others Other error as indicated.
|
|
///
|
|
HttpEventTlsConfigured
|
|
} EDKII_HTTP_CALLBACK_EVENT;
|
|
|
|
/**
|
|
Callback function that is invoked when HTTP event occurs.
|
|
|
|
@param[in] This Pointer to the EDKII_HTTP_CALLBACK_PROTOCOL instance.
|
|
@param[in] Event The event that occurs in the current state.
|
|
@param[in] EventStatus The Status of Event, EFI_SUCCESS or other errors.
|
|
**/
|
|
typedef
|
|
VOID
|
|
(EFIAPI *EDKII_HTTP_CALLBACK)(
|
|
IN EDKII_HTTP_CALLBACK_PROTOCOL *This,
|
|
IN EDKII_HTTP_CALLBACK_EVENT Event,
|
|
IN EFI_STATUS EventStatus
|
|
);
|
|
|
|
///
|
|
/// EFI HTTP Callback Protocol is invoked when HTTP event occurs.
|
|
///
|
|
struct _EDKII_HTTP_CALLBACK_PROTOCOL {
|
|
EDKII_HTTP_CALLBACK Callback;
|
|
};
|
|
|
|
extern EFI_GUID gEdkiiHttpCallbackProtocolGuid;
|