mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
6181c85fa9
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>
79 lines
3.1 KiB
C
79 lines
3.1 KiB
C
/** @file
|
|
Internal Functions for RedfishLib.
|
|
|
|
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
|
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Library/BaseLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/JsonLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/PrintLib.h>
|
|
#include <Library/RedfishLib.h>
|
|
#include <Library/UefiLib.h>
|
|
#include <Protocol/EdkIIRedfishCredential.h>
|
|
#include <redfish.h>
|
|
|
|
#define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))
|
|
|
|
/**
|
|
Creates a REDFISH_SERVICE which can be later used to access the Redfish resources.
|
|
|
|
This function will configure REST EX child according to parameters described in
|
|
Redfish network host interface in SMBIOS type 42 record. The service enumerator will also
|
|
handle the authentication flow automatically if HTTP basic auth or Redfish session
|
|
login is configured to use.
|
|
|
|
@param[in] RedfishConfigServiceInfo Redfish service information the EFI Redfish
|
|
feature driver communicates with.
|
|
@param[in] AuthMethod None, HTTP basic auth, or Redfish session login.
|
|
@param[in] UserId User Name used for authentication.
|
|
@param[in] Password Password used for authentication.
|
|
|
|
@return New created Redfish service, or NULL if error happens.
|
|
|
|
**/
|
|
REDFISH_SERVICE
|
|
RedfishCreateLibredfishService (
|
|
IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo,
|
|
IN EDKII_REDFISH_AUTH_METHOD AuthMethod,
|
|
IN CHAR8 *UserId,
|
|
IN CHAR8 *Password
|
|
);
|
|
|
|
/**
|
|
Retrieve platform's Redfish authentication information.
|
|
|
|
This functions returns the Redfish authentication method together with the user
|
|
Id and password.
|
|
For AuthMethodNone, UserId and Password will point to NULL which means authentication
|
|
is not required to access the Redfish service.
|
|
For AuthMethodHttpBasic, the UserId and Password could be used for
|
|
HTTP header authentication as defined by RFC7235. For AuthMethodRedfishSession,
|
|
the UserId and Password could be used for Redfish session login as defined by
|
|
Redfish API specification (DSP0266).
|
|
|
|
Callers are responsible for freeing the returned string storage pointed by UserId
|
|
and Password.
|
|
|
|
@param[out] AuthMethod Type of Redfish authentication method.
|
|
@param[out] UserId The pointer to store the returned UserId string.
|
|
@param[out] Password The pointer to store the returned Password string.
|
|
|
|
@retval EFI_SUCCESS Get the authentication information successfully.
|
|
@retval EFI_INVALID_PARAMETER AuthMethod or UserId or Password is NULL.
|
|
@retval EFI_UNSUPPORTED Unsupported authentication method is found.
|
|
**/
|
|
EFI_STATUS
|
|
RedfishGetAuthInfo (
|
|
OUT EDKII_REDFISH_AUTH_METHOD *AuthMethod,
|
|
OUT CHAR8 **UserId,
|
|
OUT CHAR8 **Password
|
|
);
|