NetworkPkg: Stop and release DHCP4 child after boot info is ready

[mirror_edk2.git] / NetworkPkg / HttpDxe / HttpDns.c

/** @file\r
  Routines for HttpDxe driver to perform DNS resolution based on UEFI DNS protocols.\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "HttpDriver.h"\r
\r
/**\r
  Retrieve the host address using the EFI_DNS4_PROTOCOL.\r
\r
  @param[in]  HttpInstance        Pointer to HTTP_PROTOCOL instance.\r
  @param[in]  HostName            Pointer to buffer containing hostname.\r
  @param[out] IpAddress           On output, pointer to buffer containing IPv4 address.\r
\r
  @retval EFI_SUCCESS             Operation succeeded.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.\r
  @retval EFI_DEVICE_ERROR        An unexpected network error occurred.\r
  @retval Others                  Other errors as indicated.\r
  \r
**/\r
EFI_STATUS\r
HttpDns4 (\r
  IN     HTTP_PROTOCOL            *HttpInstance,\r
  IN     CHAR16                   *HostName,\r
     OUT EFI_IPv4_ADDRESS         *IpAddress                \r
  )\r
{\r
  EFI_STATUS                      Status;\r
  EFI_DNS4_PROTOCOL               *Dns4;\r
  EFI_DNS4_CONFIG_DATA            Dns4CfgData;\r
  EFI_DNS4_COMPLETION_TOKEN       Token;\r
  BOOLEAN                         IsDone;\r
  HTTP_SERVICE                    *Service;\r
  EFI_HANDLE                      Dns4Handle;\r
  EFI_IP4_CONFIG2_PROTOCOL        *Ip4Config2;\r
  UINTN                           DnsServerListCount;\r
  EFI_IPv4_ADDRESS                *DnsServerList;\r
  UINTN                           DataSize;\r
  \r
\r
  Service = HttpInstance->Service;\r
  ASSERT (Service != NULL);\r
\r
  DnsServerList      = NULL;\r
  DnsServerListCount = 0;\r
  ZeroMem (&Token, sizeof (EFI_DNS4_COMPLETION_TOKEN));\r
\r
  //\r
  // Get DNS server list from EFI IPv4 Configuration II protocol.\r
  //\r
  Status = gBS->HandleProtocol (Service->ControllerHandle, &gEfiIp4Config2ProtocolGuid, (VOID **) &Ip4Config2);\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Get the required size.\r
    //\r
    DataSize = 0;\r
    Status   = Ip4Config2->GetData (Ip4Config2, Ip4Config2DataTypeDnsServer, &DataSize, NULL);\r
    if (Status == EFI_BUFFER_TOO_SMALL) {\r
      DnsServerList = AllocatePool (DataSize);\r
      if (DnsServerList == NULL) {\r
        return EFI_OUT_OF_RESOURCES;\r
      }\r
\r
      Status   = Ip4Config2->GetData (Ip4Config2, Ip4Config2DataTypeDnsServer, &DataSize, DnsServerList);\r
      if (EFI_ERROR (Status)) {\r
        FreePool (DnsServerList);\r
        DnsServerList = NULL;\r
      } else {\r
        DnsServerListCount = DataSize / sizeof (EFI_IPv4_ADDRESS);\r
      }\r
    }\r
  }\r
\r
  Dns4Handle = NULL;\r
  Dns4       = NULL;\r
  \r
  //\r
  // Create a DNS child instance and get the protocol.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             Service->ControllerHandle,\r
             Service->ImageHandle,\r
             &gEfiDns4ServiceBindingProtocolGuid,\r
             &Dns4Handle\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }  \r
\r
  Status = gBS->OpenProtocol (\r
                  Dns4Handle,\r
                  &gEfiDns4ProtocolGuid,\r
                  (VOID **) &Dns4,\r
                  Service->ImageHandle,\r
                  Service->ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
\r
  //\r
  // Configure DNS4 instance for the DNS server address and protocol.\r
  //\r
  ZeroMem (&Dns4CfgData, sizeof (Dns4CfgData));\r
  Dns4CfgData.DnsServerListCount = DnsServerListCount;\r
  Dns4CfgData.DnsServerList      = DnsServerList;\r
  Dns4CfgData.UseDefaultSetting  = HttpInstance->IPv4Node.UseDefaultAddress;\r
  if (!Dns4CfgData.UseDefaultSetting) {\r
    IP4_COPY_ADDRESS (&Dns4CfgData.StationIp, &HttpInstance->IPv4Node.LocalAddress);\r
    IP4_COPY_ADDRESS (&Dns4CfgData.SubnetMask, &HttpInstance->IPv4Node.LocalSubnet);\r
  }\r
  Dns4CfgData.EnableDnsCache     = TRUE;\r
  Dns4CfgData.Protocol           = EFI_IP_PROTO_UDP;\r
  Status = Dns4->Configure (\r
                   Dns4,\r
                   &Dns4CfgData\r
                   );\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
  \r
  //\r
  // Create event to set the is done flag when name resolution is finished.\r
  //\r
  ZeroMem (&Token, sizeof (Token));\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  HttpCommonNotify,\r
                  &IsDone,\r
                  &Token.Event\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
\r
  //\r
  // Start asynchronous name resolution.\r
  //\r
  Token.Status = EFI_NOT_READY;\r
  IsDone       = FALSE;\r
  Status = Dns4->HostNameToIp (Dns4, HostName, &Token);\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
\r
  while (!IsDone) {\r
    Dns4->Poll (Dns4);\r
  }\r
\r
  //\r
  // Name resolution is done, check result.\r
  //\r
  Status = Token.Status;  \r
  if (!EFI_ERROR (Status)) {\r
    if (Token.RspData.H2AData == NULL) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto Exit;\r
    }\r
    if (Token.RspData.H2AData->IpCount == 0 || Token.RspData.H2AData->IpList == NULL) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto Exit;\r
    }\r
    //\r
    // We just return the first IP address from DNS protocol.\r
    //\r
    IP4_COPY_ADDRESS (IpAddress, Token.RspData.H2AData->IpList);\r
    Status = EFI_SUCCESS;\r
  }\r
\r
Exit:\r
  \r
  if (Token.Event != NULL) {\r
    gBS->CloseEvent (Token.Event);\r
  }\r
  if (Token.RspData.H2AData != NULL) {\r
    if (Token.RspData.H2AData->IpList != NULL) {\r
      FreePool (Token.RspData.H2AData->IpList);\r
    }\r
    FreePool (Token.RspData.H2AData);\r
  }\r
\r
  if (Dns4 != NULL) {\r
    Dns4->Configure (Dns4, NULL);\r
    \r
    gBS->CloseProtocol (\r
          Dns4Handle,\r
          &gEfiDns4ProtocolGuid,\r
          Service->ImageHandle,\r
          Service->ControllerHandle\r
          );\r
  }\r
\r
  if (Dns4Handle != NULL) {\r
    NetLibDestroyServiceChild (\r
      Service->ControllerHandle,\r
      Service->ImageHandle,\r
      &gEfiDns4ServiceBindingProtocolGuid,\r
      Dns4Handle\r
      );\r
  }\r
\r
  if (DnsServerList != NULL) {\r
    FreePool (DnsServerList);\r
  }\r
  \r
  return Status;\r
}\r