NetworkPkg/HttpBootDxe: Utilize HttpIoLib

Remove HTTP IO realted funcitons from HttpBootDxe
and use HttpIoLib instead.

Signed-off-by: Abner Chang <abner.chang@hpe.com>

Cc: Maciej Rabeda <maciej.rabeda@linux.intel.com>
Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Siyuan Fu <siyuan.fu@intel.com>
Cc: Nickle Wang <nickle.wang@hpe.com>
Reviewed-by: Maciej Rabeda <maciej.rabeda@linux.intel.com>

1 files changed, 1 insertions, 430 deletions

diff --git a/NetworkPkg/HttpBootDxe/HttpBootSupport.c b/NetworkPkg/HttpBootDxe/HttpBootSupport.c
index 5b0e054a05..93d9dfc464 100644
--- a/NetworkPkg/HttpBootDxe/HttpBootSupport.c
+++ b/NetworkPkg/HttpBootDxe/HttpBootSupport.c
@@ -2,7 +2,7 @@
   Support functions implementation for UEFI HTTP boot driver.

 

 Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>

-(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>

+(C) Copyright 2016 - 2020 Hewlett Packard Enterprise Development LP<BR>

 SPDX-License-Identifier: BSD-2-Clause-Patent

 

 **/

@@ -623,435 +623,6 @@ HttpBootSetHeader (
 }

 

 /**

-  Notify the callback function when an event is triggered.

-

-  @param[in]  Context         The opaque parameter to the function.

-

-**/

-VOID

-EFIAPI

-HttpIoNotifyDpc (

-  IN VOID                *Context

-  )

-{

-  *((BOOLEAN *) Context) = TRUE;

-}

-

-/**

-  Request HttpIoNotifyDpc as a DPC at TPL_CALLBACK.

-

-  @param[in]  Event                 The event signaled.

-  @param[in]  Context               The opaque parameter to the function.

-

-**/

-VOID

-EFIAPI

-HttpIoNotify (

-  IN EFI_EVENT              Event,

-  IN VOID                   *Context

-  )

-{

-  //

-  // Request HttpIoNotifyDpc as a DPC at TPL_CALLBACK

-  //

-  QueueDpc (TPL_CALLBACK, HttpIoNotifyDpc, Context);

-}

-

-/**

-  Create a HTTP_IO to access the HTTP service. It will create and configure

-  a HTTP child handle.

-

-  @param[in]  Image          The handle of the driver image.

-  @param[in]  Controller     The handle of the controller.

-  @param[in]  IpVersion      IP_VERSION_4 or IP_VERSION_6.

-  @param[in]  ConfigData     The HTTP_IO configuration data.

-  @param[in]  Callback       Callback function which will be invoked when specified

-                             HTTP_IO_CALLBACK_EVENT happened.

-  @param[in]  Context        The Context data which will be passed to the Callback function.

-  @param[out] HttpIo         The HTTP_IO.

-

-  @retval EFI_SUCCESS            The HTTP_IO is created and configured.

-  @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.

-  @retval EFI_UNSUPPORTED        One or more of the control options are not

-                                 supported in the implementation.

-  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.

-  @retval Others                 Failed to create the HTTP_IO or configure it.

-

-**/

-EFI_STATUS

-HttpIoCreateIo (

-  IN EFI_HANDLE             Image,

-  IN EFI_HANDLE             Controller,

-  IN UINT8                  IpVersion,

-  IN HTTP_IO_CONFIG_DATA    *ConfigData,

-  IN HTTP_IO_CALLBACK       Callback,

-  IN VOID                   *Context,

-  OUT HTTP_IO               *HttpIo

-  )

-{

-  EFI_STATUS                Status;

-  EFI_HTTP_CONFIG_DATA      HttpConfigData;

-  EFI_HTTPv4_ACCESS_POINT   Http4AccessPoint;

-  EFI_HTTPv6_ACCESS_POINT   Http6AccessPoint;

-  EFI_HTTP_PROTOCOL         *Http;

-  EFI_EVENT                 Event;

-

-  if ((Image == NULL) || (Controller == NULL) || (ConfigData == NULL) || (HttpIo == NULL)) {

-    return EFI_INVALID_PARAMETER;

-  }

-

-  if (IpVersion != IP_VERSION_4 && IpVersion != IP_VERSION_6) {

-    return EFI_UNSUPPORTED;

-  }

-

-  ZeroMem (HttpIo, sizeof (HTTP_IO));

-

-  //

-  // Create the HTTP child instance and get the HTTP protocol.

-  //

-  Status = NetLibCreateServiceChild (

-             Controller,

-             Image,

-             &gEfiHttpServiceBindingProtocolGuid,

-             &HttpIo->Handle

-             );

-  if (EFI_ERROR (Status)) {

-    return Status;

-  }

-

-  Status = gBS->OpenProtocol (

-                  HttpIo->Handle,

-                  &gEfiHttpProtocolGuid,

-                  (VOID **) &Http,

-                  Image,

-                  Controller,

-                  EFI_OPEN_PROTOCOL_BY_DRIVER

-                  );

-  if (EFI_ERROR (Status) || (Http == NULL)) {

-    goto ON_ERROR;

-  }

-

-  //

-  // Init the configuration data and configure the HTTP child.

-  //

-  HttpIo->Image       = Image;

-  HttpIo->Controller  = Controller;

-  HttpIo->IpVersion   = IpVersion;

-  HttpIo->Http        = Http;

-  HttpIo->Callback    = Callback;

-  HttpIo->Context     = Context;

-

-  ZeroMem (&HttpConfigData, sizeof (EFI_HTTP_CONFIG_DATA));

-  HttpConfigData.HttpVersion        = HttpVersion11;

-  HttpConfigData.TimeOutMillisec    = ConfigData->Config4.RequestTimeOut;

-  if (HttpIo->IpVersion == IP_VERSION_4) {

-    HttpConfigData.LocalAddressIsIPv6 = FALSE;

-

-    Http4AccessPoint.UseDefaultAddress = ConfigData->Config4.UseDefaultAddress;

-    Http4AccessPoint.LocalPort         = ConfigData->Config4.LocalPort;

-    IP4_COPY_ADDRESS (&Http4AccessPoint.LocalAddress, &ConfigData->Config4.LocalIp);

-    IP4_COPY_ADDRESS (&Http4AccessPoint.LocalSubnet, &ConfigData->Config4.SubnetMask);

-    HttpConfigData.AccessPoint.IPv4Node = &Http4AccessPoint;

-  } else {

-    HttpConfigData.LocalAddressIsIPv6 = TRUE;

-    Http6AccessPoint.LocalPort        = ConfigData->Config6.LocalPort;

-    IP6_COPY_ADDRESS (&Http6AccessPoint.LocalAddress, &ConfigData->Config6.LocalIp);

-    HttpConfigData.AccessPoint.IPv6Node = &Http6AccessPoint;

-  }

-

-  Status = Http->Configure (Http, &HttpConfigData);

-  if (EFI_ERROR (Status)) {

-    goto ON_ERROR;

-  }

-

-  //

-  // Create events for various asynchronous operations.

-  //

-  Status = gBS->CreateEvent (

-                  EVT_NOTIFY_SIGNAL,

-                  TPL_NOTIFY,

-                  HttpIoNotify,

-                  &HttpIo->IsTxDone,

-                  &Event

-                  );

-  if (EFI_ERROR (Status)) {

-    goto ON_ERROR;

-  }

-  HttpIo->ReqToken.Event = Event;

-  HttpIo->ReqToken.Message = &HttpIo->ReqMessage;

-

-  Status = gBS->CreateEvent (

-                  EVT_NOTIFY_SIGNAL,

-                  TPL_NOTIFY,

-                  HttpIoNotify,

-                  &HttpIo->IsRxDone,

-                  &Event

-                  );

-  if (EFI_ERROR (Status)) {

-    goto ON_ERROR;

-  }

-  HttpIo->RspToken.Event = Event;

-  HttpIo->RspToken.Message = &HttpIo->RspMessage;

-

-  //

-  // Create TimeoutEvent for response

-  //

-  Status = gBS->CreateEvent (

-                  EVT_TIMER,

-                  TPL_CALLBACK,

-                  NULL,

-                  NULL,

-                  &Event

-                  );

-  if (EFI_ERROR (Status)) {

-    goto ON_ERROR;

-  }

-  HttpIo->TimeoutEvent = Event;

-

-  return EFI_SUCCESS;

-

-ON_ERROR:

-  HttpIoDestroyIo (HttpIo);

-

-  return Status;

-}

-

-/**

-  Destroy the HTTP_IO and release the resources.

-

-  @param[in]  HttpIo          The HTTP_IO which wraps the HTTP service to be destroyed.

-

-**/

-VOID

-HttpIoDestroyIo (

-  IN HTTP_IO                *HttpIo

-  )

-{

-  EFI_HTTP_PROTOCOL         *Http;

-  EFI_EVENT                 Event;

-

-  if (HttpIo == NULL) {

-    return;

-  }

-

-  Event = HttpIo->ReqToken.Event;

-  if (Event != NULL) {

-    gBS->CloseEvent (Event);

-  }

-

-  Event = HttpIo->RspToken.Event;

-  if (Event != NULL) {

-    gBS->CloseEvent (Event);

-  }

-

-  Event = HttpIo->TimeoutEvent;

-  if (Event != NULL) {

-    gBS->CloseEvent (Event);

-  }

-

-  Http = HttpIo->Http;

-  if (Http != NULL) {

-    Http->Configure (Http, NULL);

-    gBS->CloseProtocol (

-           HttpIo->Handle,

-           &gEfiHttpProtocolGuid,

-           HttpIo->Image,

-           HttpIo->Controller

-           );

-  }

-

-  NetLibDestroyServiceChild (

-    HttpIo->Controller,

-    HttpIo->Image,

-    &gEfiHttpServiceBindingProtocolGuid,

-    HttpIo->Handle

-    );

-}

-

-/**

-  Synchronously send a HTTP REQUEST message to the server.

-

-  @param[in]   HttpIo           The HttpIo wrapping the HTTP service.

-  @param[in]   Request          A pointer to storage such data as URL and HTTP method.

-  @param[in]   HeaderCount      Number of HTTP header structures in Headers list.

-  @param[in]   Headers          Array containing list of HTTP headers.

-  @param[in]   BodyLength       Length in bytes of the HTTP body.

-  @param[in]   Body             Body associated with the HTTP request.

-

-  @retval EFI_SUCCESS            The HTTP request is transmitted.

-  @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.

-  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.

-  @retval EFI_DEVICE_ERROR       An unexpected network or system error occurred.

-  @retval Others                 Other errors as indicated.

-

-**/

-EFI_STATUS

-HttpIoSendRequest (

-  IN  HTTP_IO                *HttpIo,

-  IN  EFI_HTTP_REQUEST_DATA  *Request,

-  IN  UINTN                  HeaderCount,

-  IN  EFI_HTTP_HEADER        *Headers,

-  IN  UINTN                  BodyLength,

-  IN  VOID                   *Body

-  )

-{

-  EFI_STATUS                 Status;

-  EFI_HTTP_PROTOCOL          *Http;

-

-  if (HttpIo == NULL || HttpIo->Http == NULL) {

-    return EFI_INVALID_PARAMETER;

-  }

-

-  HttpIo->ReqToken.Status  = EFI_NOT_READY;

-  HttpIo->ReqToken.Message->Data.Request = Request;

-  HttpIo->ReqToken.Message->HeaderCount  = HeaderCount;

-  HttpIo->ReqToken.Message->Headers      = Headers;

-  HttpIo->ReqToken.Message->BodyLength   = BodyLength;

-  HttpIo->ReqToken.Message->Body         = Body;

-

-  if (HttpIo->Callback != NULL) {

-    Status = HttpIo->Callback (

-               HttpIoRequest,

-               HttpIo->ReqToken.Message,

-               HttpIo->Context

-               );

-    if (EFI_ERROR (Status)) {

-      return Status;

-    }

-  }

-

-  //

-  // Queue the request token to HTTP instances.

-  //

-  Http = HttpIo->Http;

-  HttpIo->IsTxDone = FALSE;

-  Status = Http->Request (

-                   Http,

-                   &HttpIo->ReqToken

-                   );

-  if (EFI_ERROR (Status)) {

-    return Status;

-  }

-

-  //

-  // Poll the network until transmit finish.

-  //

-  while (!HttpIo->IsTxDone) {

-    Http->Poll (Http);

-  }

-

-  return HttpIo->ReqToken.Status;

-}

-

-/**

-  Synchronously receive a HTTP RESPONSE message from the server.

-

-  @param[in]   HttpIo           The HttpIo wrapping the HTTP service.

-  @param[in]   RecvMsgHeader    TRUE to receive a new HTTP response (from message header).

-                                FALSE to continue receive the previous response message.

-  @param[out]  ResponseData     Point to a wrapper of the received response data.

-

-  @retval EFI_SUCCESS            The HTTP response is received.

-  @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.

-  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.

-  @retval EFI_DEVICE_ERROR       An unexpected network or system error occurred.

-  @retval Others                 Other errors as indicated.

-

-**/

-EFI_STATUS

-HttpIoRecvResponse (

-  IN      HTTP_IO                  *HttpIo,

-  IN      BOOLEAN                  RecvMsgHeader,

-     OUT  HTTP_IO_RESPONSE_DATA    *ResponseData

-  )

-{

-  EFI_STATUS                 Status;

-  EFI_HTTP_PROTOCOL          *Http;

-

-  if (HttpIo == NULL || HttpIo->Http == NULL || ResponseData == NULL) {

-    return EFI_INVALID_PARAMETER;

-  }

-

-  //

-  // Start the timer, and wait Timeout seconds to receive the header packet.

-  //

-  Status = gBS->SetTimer (HttpIo->TimeoutEvent, TimerRelative, HTTP_BOOT_RESPONSE_TIMEOUT * TICKS_PER_MS);

-  if (EFI_ERROR (Status)) {

-    return Status;

-  }

-

-  //

-  // Queue the response token to HTTP instances.

-  //

-  HttpIo->RspToken.Status  = EFI_NOT_READY;

-  if (RecvMsgHeader) {

-    HttpIo->RspToken.Message->Data.Response = &ResponseData->Response;

-  } else {

-    HttpIo->RspToken.Message->Data.Response = NULL;

-  }

-  HttpIo->RspToken.Message->HeaderCount   = 0;

-  HttpIo->RspToken.Message->Headers       = NULL;

-  HttpIo->RspToken.Message->BodyLength    = ResponseData->BodyLength;

-  HttpIo->RspToken.Message->Body          = ResponseData->Body;

-

-  Http = HttpIo->Http;

-  HttpIo->IsRxDone = FALSE;

-  Status = Http->Response (

-                   Http,

-                   &HttpIo->RspToken

-                   );

-

-  if (EFI_ERROR (Status)) {

-    gBS->SetTimer (HttpIo->TimeoutEvent, TimerCancel, 0);

-    return Status;

-  }

-

-  //

-  // Poll the network until receive finish.

-  //

-  while (!HttpIo->IsRxDone && ((HttpIo->TimeoutEvent == NULL) || EFI_ERROR (gBS->CheckEvent (HttpIo->TimeoutEvent)))) {

-    Http->Poll (Http);

-  }

-

-  gBS->SetTimer (HttpIo->TimeoutEvent, TimerCancel, 0);

-

-  if (!HttpIo->IsRxDone) {

-    //

-    // Timeout occurs, cancel the response token.

-    //

-    Http->Cancel (Http, &HttpIo->RspToken);

-

-    Status = EFI_TIMEOUT;

-

-    return Status;

-  } else {

-    HttpIo->IsRxDone = FALSE;

-  }

-

-  if ((HttpIo->Callback != NULL) &&

-      (HttpIo->RspToken.Status == EFI_SUCCESS || HttpIo->RspToken.Status == EFI_HTTP_ERROR)) {

-    Status = HttpIo->Callback (

-               HttpIoResponse,

-               HttpIo->RspToken.Message,

-               HttpIo->Context

-               );

-    if (EFI_ERROR (Status)) {

-      return Status;

-    }

-  }

-

-  //

-  // Store the received data into the wrapper.

-  //

-  ResponseData->Status = HttpIo->RspToken.Status;

-  ResponseData->HeaderCount = HttpIo->RspToken.Message->HeaderCount;

-  ResponseData->Headers     = HttpIo->RspToken.Message->Headers;

-  ResponseData->BodyLength  = HttpIo->RspToken.Message->BodyLength;

-

-  return Status;

-}

-

-/**

   This function checks the HTTP(S) URI scheme.

 

   @param[in]    Uri              The pointer to the URI string.