]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.c
MdeModulePkg: Fix DHCP4 driver hang issue in some case.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Dhcp4Dxe / Dhcp4Driver.c
index 0041493c358d83473fba0cece1f3637b7372566c..9253df2b3f08eb1ddf1e2473f5cdc008692da70e 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 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
@@ -146,11 +146,11 @@ DhcpConfigUdpIo (
 \r
 \r
 /**\r
-  Destory the DHCP service. The Dhcp4 service may be partly initialized,\r
+  Destroy the DHCP service. The Dhcp4 service may be partly initialized,\r
   or partly destroyed. If a resource is destroyed, it is marked as so in\r
   case the destroy failed and being called again later.\r
 \r
-  @param[in]  DhcpSb                 The DHCP service instance to destory.\r
+  @param[in]  DhcpSb                 The DHCP service instance to destroy.\r
 \r
   @retval EFI_SUCCESS            Always return success.\r
 \r
@@ -212,7 +212,6 @@ Dhcp4CreateService (
 \r
   DhcpSb->Signature       = DHCP_SERVICE_SIGNATURE;\r
   DhcpSb->ServiceState    = DHCP_UNCONFIGED;\r
-  DhcpSb->InDestory       = FALSE;\r
   DhcpSb->Controller      = Controller;\r
   DhcpSb->Image           = ImageHandle;\r
   InitializeListHead (&DhcpSb->Children);\r
@@ -354,6 +353,36 @@ ON_ERROR:
   return Status;\r
 }\r
 \r
+/**\r
+  Callback function which provided by user to remove one node in NetDestroyLinkList process.\r
+  \r
+  @param[in]    Entry           The entry to be removed.\r
+  @param[in]    Context         Pointer to the callback context corresponds to the Context in NetDestroyLinkList.\r
+\r
+  @retval EFI_SUCCESS           The entry has been removed successfully.\r
+  @retval Others                Fail to remove the entry.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+Dhcp4DestroyChildEntry (\r
+  IN LIST_ENTRY         *Entry,\r
+  IN VOID               *Context\r
+  )\r
+{\r
+  DHCP_PROTOCOL                    *Instance;\r
+  EFI_SERVICE_BINDING_PROTOCOL     *ServiceBinding;\r
+\r
+  if (Entry == NULL || Context == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Instance = NET_LIST_USER_STRUCT_S (Entry, DHCP_PROTOCOL, Link, DHCP_PROTOCOL_SIGNATURE);\r
+  ServiceBinding = (EFI_SERVICE_BINDING_PROTOCOL *) Context;\r
+\r
+  return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
+}\r
+\r
 \r
 /**\r
   Stop this driver on ControllerHandle. This service is called by the\r
@@ -384,10 +413,10 @@ Dhcp4DriverBindingStop (
 {\r
   EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;\r
   DHCP_SERVICE                  *DhcpSb;\r
-  DHCP_PROTOCOL                 *Instance;\r
   EFI_HANDLE                    NicHandle;\r
   EFI_STATUS                    Status;\r
-  EFI_TPL                       OldTpl;\r
+  LIST_ENTRY                    *List;\r
+  UINTN                         ListLength;\r
 \r
   //\r
   // DHCP driver opens UDP child, So, the ControllerHandle is the\r
@@ -396,7 +425,7 @@ Dhcp4DriverBindingStop (
   NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp4ProtocolGuid);\r
 \r
   if (NicHandle == NULL) {\r
-    return EFI_DEVICE_ERROR;\r
+    return EFI_SUCCESS;\r
   }\r
 \r
    Status = gBS->OpenProtocol (\r
@@ -413,17 +442,31 @@ Dhcp4DriverBindingStop (
   }\r
 \r
   DhcpSb = DHCP_SERVICE_FROM_THIS (ServiceBinding);\r
-\r
-  if (DhcpSb->InDestory) {\r
-    return EFI_SUCCESS;\r
+  if (!IsListEmpty (&DhcpSb->Children)) {\r
+    //\r
+    // Destroy all the children instances before destory the service.\r
+    //  \r
+    List = &DhcpSb->Children;\r
+    Status = NetDestroyLinkList (\r
+               List,\r
+               Dhcp4DestroyChildEntry,\r
+               ServiceBinding,\r
+               &ListLength\r
+               );\r
+    if (EFI_ERROR (Status) || ListLength != 0) {\r
+      Status = EFI_DEVICE_ERROR;\r
+    }\r
   }\r
 \r
-  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
-\r
-  if (NumberOfChildren == 0) {\r
+  if (NumberOfChildren == 0 && !IsListEmpty (&DhcpSb->Children)) {\r
+    Status = EFI_DEVICE_ERROR;\r
+  }\r
 \r
-    DhcpSb->InDestory    = TRUE;\r
-    DhcpSb->ServiceState = DHCP_DESTORY;\r
+  if (NumberOfChildren == 0 && IsListEmpty (&DhcpSb->Children)) {\r
+    //\r
+    // Destroy the service itself if no child instance left.\r
+    //\r
+    DhcpSb->ServiceState = DHCP_DESTROY;\r
 \r
     gBS->UninstallProtocolInterface (\r
            NicHandle,\r
@@ -433,24 +476,15 @@ Dhcp4DriverBindingStop (
 \r
     Dhcp4CloseService (DhcpSb);\r
 \r
-    FreePool (DhcpSb);\r
-  } else {\r
-    //\r
-    // Don't use NET_LIST_FOR_EACH_SAFE here, Dhcp4ServiceBindingDestoryChild\r
-    // may cause other child to be deleted.\r
-    //\r
-    while (!IsListEmpty (&DhcpSb->Children)) {\r
-      Instance = NET_LIST_HEAD (&DhcpSb->Children, DHCP_PROTOCOL, Link);\r
-      ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
-    }\r
-\r
-    if (DhcpSb->NumChildren != 0) {\r
-      Status = EFI_DEVICE_ERROR;\r
+    if (gDhcpControllerNameTable != NULL) {\r
+      FreeUnicodeStringTable (gDhcpControllerNameTable);\r
+      gDhcpControllerNameTable = NULL;\r
     }\r
+    FreePool (DhcpSb);\r
+    \r
+    Status = EFI_SUCCESS;\r
   }\r
 \r
-  gBS->RestoreTPL (OldTpl);\r
-\r
   return Status;\r
 }\r
 \r
@@ -473,11 +507,12 @@ DhcpInitProtocol (
   InitializeListHead (&Instance->Link);\r
   Instance->Handle            = NULL;\r
   Instance->Service           = DhcpSb;\r
-  Instance->InDestory         = FALSE;\r
+  Instance->InDestroy         = FALSE;\r
   Instance->CompletionEvent   = NULL;\r
   Instance->RenewRebindEvent  = NULL;\r
   Instance->Token             = NULL;\r
   Instance->UdpIo             = NULL;\r
+  Instance->ElaspedTime       = 0;\r
   NetbufQueInit (&Instance->ResponseQueue);\r
 }\r
 \r
@@ -590,7 +625,7 @@ Dhcp4ServiceBindingCreateChild (
 \r
   @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
-  @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+  @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r
                                 because its services are being used.\r
   @retval other                 The child handle was not destroyed\r
@@ -639,15 +674,15 @@ Dhcp4ServiceBindingDestroyChild (
   //\r
   // A child can be destroyed more than once. For example,\r
   // Dhcp4DriverBindingStop will destroy all of its children.\r
-  // when caller driver is being stopped, it will destory the\r
+  // when caller driver is being stopped, it will destroy the\r
   // dhcp child it opens.\r
   //\r
-  if (Instance->InDestory) {\r
+  if (Instance->InDestroy) {\r
     return EFI_SUCCESS;\r
   }\r
 \r
   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
-  Instance->InDestory = TRUE;\r
+  Instance->InDestroy = TRUE;\r
 \r
   //\r
   // Close the Udp4 protocol.\r
@@ -662,14 +697,15 @@ Dhcp4ServiceBindingDestroyChild (
   //\r
   // Uninstall the DHCP4 protocol first to enable a top down destruction.\r
   //\r
+  gBS->RestoreTPL (OldTpl);\r
   Status = gBS->UninstallProtocolInterface (\r
                   ChildHandle,\r
                   &gEfiDhcp4ProtocolGuid,\r
                   Dhcp\r
                   );\r
-\r
+  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
   if (EFI_ERROR (Status)) {\r
-    Instance->InDestory = FALSE;\r
+    Instance->InDestroy = FALSE;\r
 \r
     gBS->RestoreTPL (OldTpl);\r
     return Status;\r
@@ -682,6 +718,19 @@ Dhcp4ServiceBindingDestroyChild (
   RemoveEntryList (&Instance->Link);\r
   DhcpSb->NumChildren--;\r
 \r
+  if (Instance->UdpIo != NULL) {\r
+    UdpIoCleanIo (Instance->UdpIo);\r
+    gBS->CloseProtocol (\r
+           Instance->UdpIo->UdpHandle,\r
+           &gEfiUdp4ProtocolGuid,\r
+           Instance->Service->Image,\r
+           Instance->Handle\r
+           );\r
+    UdpIoFreeIo (Instance->UdpIo);\r
+    Instance->UdpIo = NULL;\r
+    Instance->Token = NULL;\r
+  }\r
+\r
   gBS->RestoreTPL (OldTpl);\r
 \r
   FreePool (Instance);\r