]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Library/DxeNetLib/DxeNetLib.c
Update NetLibGetMacAddress() to handle the case correctly when SNP is absent.
[mirror_edk2.git] / MdeModulePkg / Library / DxeNetLib / DxeNetLib.c
index dbd77e5bda145d4afe3eda93fb52f5468f1fd147..467b82280eead55a16472111888457c69145649b 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Network library.\r
 \r
-Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2005 - 2013, 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
@@ -40,6 +40,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/UefiLib.h>\r
 \r
 #define NIC_ITEM_CONFIG_SIZE   sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE\r
+#define DEFAULT_ZERO_START     ((UINTN) ~0)\r
 \r
 //\r
 // All the supported IP4 maskes in host byte order.\r
@@ -1065,6 +1066,116 @@ NetListInsertBefore (
   PostEntry->BackLink               = NewEntry;\r
 }\r
 \r
+/**\r
+  Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.\r
+\r
+  Destroy network child instance list by list traversals is not safe due to graph dependencies between nodes.\r
+  This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed\r
+  has been removed from the list or not.\r
+  If it has been removed, then restart the traversal from the head.\r
+  If it hasn't been removed, then continue with the next node directly.\r
+  This function will end the iterate and return the CallBack's last return value if error happens,\r
+  or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.  \r
+\r
+  @param[in]    List             The head of the list.\r
+  @param[in]    CallBack         Pointer to the callback function to destroy one node in the list.\r
+  @param[in]    Context          Pointer to the callback function's context: corresponds to the\r
+                                 parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.\r
+  @param[out]   ListLength       The length of the link list if the function returns successfully.\r
+\r
+  @retval EFI_SUCCESS            Two complete passes are made with no changes in the number of children.\r
+  @retval EFI_INVALID_PARAMETER  The input parameter is invalid.\r
+  @retval Others                 Return the CallBack's last return value.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetDestroyLinkList (\r
+  IN   LIST_ENTRY                       *List,\r
+  IN   NET_DESTROY_LINK_LIST_CALLBACK   CallBack,\r
+  IN   VOID                             *Context,    OPTIONAL\r
+  OUT  UINTN                            *ListLength  OPTIONAL\r
+  )\r
+{\r
+  UINTN                         PreviousLength;\r
+  LIST_ENTRY                    *Entry;\r
+  LIST_ENTRY                    *Ptr;\r
+  UINTN                         Length;\r
+  EFI_STATUS                    Status;\r
+\r
+  if (List == NULL || CallBack == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Length = 0;\r
+  do {\r
+    PreviousLength = Length;\r
+    Entry = GetFirstNode (List);\r
+    while (!IsNull (List, Entry)) {\r
+      Status = CallBack (Entry, Context);\r
+      if (EFI_ERROR (Status)) {\r
+        return Status;\r
+      }\r
+      //\r
+      // Walk through the list to see whether the Entry has been removed or not.\r
+      // If the Entry still exists, just try to destroy the next one.\r
+      // If not, go back to the start point to iterate the list again.\r
+      //\r
+      for (Ptr = List->ForwardLink; Ptr != List; Ptr = Ptr->ForwardLink) {\r
+        if (Ptr == Entry) {\r
+          break;\r
+        }\r
+      }\r
+      if (Ptr == Entry) {\r
+        Entry = GetNextNode (List, Entry);\r
+      } else {\r
+        Entry = GetFirstNode (List);\r
+      }\r
+    }\r
+    for (Length = 0, Ptr = List->ForwardLink; Ptr != List; Length++, Ptr = Ptr->ForwardLink);\r
+  } while (Length != PreviousLength);\r
+\r
+  if (ListLength != NULL) {\r
+    *ListLength = Length;\r
+  }\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.\r
+\r
+  @param[in]  Handle             Handle to be checked.\r
+  @param[in]  NumberOfChildren   Number of Handles in ChildHandleBuffer.\r
+  @param[in]  ChildHandleBuffer  An array of child handles to be freed. May be NULL\r
+                                 if NumberOfChildren is 0.\r
+\r
+  @retval TURE                   Found the input Handle in ChildHandleBuffer.\r
+  @retval FALSE                  Can't find the input Handle in ChildHandleBuffer.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+NetIsInHandleBuffer (\r
+  IN  EFI_HANDLE          Handle,\r
+  IN  UINTN               NumberOfChildren,\r
+  IN  EFI_HANDLE          *ChildHandleBuffer OPTIONAL\r
+  )\r
+{\r
+  UINTN     Index;\r
+  \r
+  if (NumberOfChildren == 0 || ChildHandleBuffer == NULL) {\r
+    return FALSE;\r
+  }\r
+\r
+  for (Index = 0; Index < NumberOfChildren; Index++) {\r
+    if (Handle == ChildHandleBuffer[Index]) {\r
+      return TRUE;\r
+    }\r
+  }\r
+\r
+  return FALSE;\r
+}\r
+\r
 \r
 /**\r
   Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.\r
@@ -1677,6 +1788,7 @@ NetLibDefaultUnload (
   EFI_HANDLE                        *DeviceHandleBuffer;\r
   UINTN                             DeviceHandleCount;\r
   UINTN                             Index;\r
+  UINTN                             Index2;\r
   EFI_DRIVER_BINDING_PROTOCOL       *DriverBinding;\r
   EFI_COMPONENT_NAME_PROTOCOL       *ComponentName;\r
   EFI_COMPONENT_NAME2_PROTOCOL      *ComponentName2;\r
@@ -1698,28 +1810,12 @@ NetLibDefaultUnload (
     return Status;\r
   }\r
 \r
-  //\r
-  // Disconnect the driver specified by ImageHandle from all\r
-  // the devices in the handle database.\r
-  //\r
-  for (Index = 0; Index < DeviceHandleCount; Index++) {\r
-    Status = gBS->DisconnectController (\r
-                    DeviceHandleBuffer[Index],\r
-                    ImageHandle,\r
-                    NULL\r
-                    );\r
-  }\r
-\r
-  //\r
-  // Uninstall all the protocols installed in the driver entry point\r
-  //\r
   for (Index = 0; Index < DeviceHandleCount; Index++) {\r
     Status = gBS->HandleProtocol (\r
                     DeviceHandleBuffer[Index],\r
                     &gEfiDriverBindingProtocolGuid,\r
                     (VOID **) &DriverBinding\r
                     );\r
-\r
     if (EFI_ERROR (Status)) {\r
       continue;\r
     }\r
@@ -1727,12 +1823,28 @@ NetLibDefaultUnload (
     if (DriverBinding->ImageHandle != ImageHandle) {\r
       continue;\r
     }\r
-\r
+    \r
+    //\r
+    // Disconnect the driver specified by ImageHandle from all\r
+    // the devices in the handle database.\r
+    //\r
+    for (Index2 = 0; Index2 < DeviceHandleCount; Index2++) {\r
+      Status = gBS->DisconnectController (\r
+                      DeviceHandleBuffer[Index2],\r
+                      DriverBinding->DriverBindingHandle,\r
+                      NULL\r
+                      );\r
+    }\r
+    \r
+    //\r
+    // Uninstall all the protocols installed in the driver entry point\r
+    //    \r
     gBS->UninstallProtocolInterface (\r
-          ImageHandle,\r
+          DriverBinding->DriverBindingHandle,\r
           &gEfiDriverBindingProtocolGuid,\r
           DriverBinding\r
           );\r
+    \r
     Status = gBS->HandleProtocol (\r
                     DeviceHandleBuffer[Index],\r
                     &gEfiComponentNameProtocolGuid,\r
@@ -1740,7 +1852,7 @@ NetLibDefaultUnload (
                     );\r
     if (!EFI_ERROR (Status)) {\r
       gBS->UninstallProtocolInterface (\r
-             ImageHandle,\r
+             DriverBinding->DriverBindingHandle,\r
              &gEfiComponentNameProtocolGuid,\r
              ComponentName\r
              );\r
@@ -1753,7 +1865,7 @@ NetLibDefaultUnload (
                     );\r
     if (!EFI_ERROR (Status)) {\r
       gBS->UninstallProtocolInterface (\r
-             ImageHandle,\r
+             DriverBinding->DriverBindingHandle,\r
              &gEfiComponentName2ProtocolGuid,\r
              ComponentName2\r
              );\r
@@ -1829,7 +1941,7 @@ NetLibCreateServiceChild (
 \r
 \r
 /**\r
-  Destory a child of the service that is identified by ServiceBindingGuid.\r
+  Destroy a child of the service that is identified by ServiceBindingGuid.\r
 \r
   Get the ServiceBinding Protocol first, then use it to destroy a child.\r
 \r
@@ -1838,10 +1950,10 @@ NetLibCreateServiceChild (
   @param[in]   Controller            The controller which has the service installed.\r
   @param[in]   Image                 The image handle used to open service.\r
   @param[in]   ServiceBindingGuid    The service's Guid.\r
-  @param[in]   ChildHandle           The child to destory.\r
+  @param[in]   ChildHandle           The child to destroy.\r
 \r
-  @retval EFI_SUCCESS           The child is successfully destoried.\r
-  @retval Others                Failed to destory the child.\r
+  @retval EFI_SUCCESS           The child is successfully destroyed.\r
+  @retval Others                Failed to destroy the child.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1875,7 +1987,7 @@ NetLibDestroyServiceChild (
   }\r
 \r
   //\r
-  // destory the child\r
+  // destroy the child\r
   //\r
   Status = Service->DestroyChild (Service, ChildHandle);\r
   return Status;\r
@@ -2130,6 +2242,7 @@ NetLibGetMacAddress (
                     (VOID **) &Mnp\r
                     );\r
     if (EFI_ERROR (Status)) {\r
+      MnpSb->DestroyChild (MnpSb, MnpChildHandle);\r
       return Status;\r
     }\r
 \r
@@ -2137,7 +2250,8 @@ NetLibGetMacAddress (
     // Try to get SNP mode from MNP\r
     //\r
     Status = Mnp->GetModeData (Mnp, NULL, &SnpModeData);\r
-    if (EFI_ERROR (Status)) {\r
+    if (EFI_ERROR (Status) && (Status != EFI_NOT_STARTED)) {\r
+      MnpSb->DestroyChild (MnpSb, MnpChildHandle);\r
       return Status;\r
     }\r
     SnpMode = &SnpModeData;\r
@@ -2166,7 +2280,8 @@ NetLibGetMacAddress (
   @param[in]   ServiceHandle         The handle where network service binding protocol is\r
                                      installed on.\r
   @param[in]   ImageHandle           The image handle used to act as the agent handle to\r
-                                     get the simple network protocol.\r
+                                     get the simple network protocol. This parameter is\r
+                                     optional and may be NULL.\r
   @param[out]  MacString             The pointer to store the address of the string\r
                                      representation of  the mac address.\r
 \r
@@ -2179,7 +2294,7 @@ EFI_STATUS
 EFIAPI\r
 NetLibGetMacString (\r
   IN  EFI_HANDLE            ServiceHandle,\r
-  IN  EFI_HANDLE            ImageHandle,\r
+  IN  EFI_HANDLE            ImageHandle, OPTIONAL\r
   OUT CHAR16                **MacString\r
   )\r
 {\r
@@ -2576,7 +2691,6 @@ ON_EXIT:
 \r
   The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.\r
   The header subtype of IPv4 device path node is MSG_IPv4_DP.\r
-  The length of the IPv4 device path node in bytes is 19.\r
   Get other info from parameters to make up the whole IPv4 device path node.\r
 \r
   @param[in, out]  Node                  Pointer to the IPv4 device path node.\r
@@ -2604,7 +2718,7 @@ NetLibCreateIPv4DPathNode (
 {\r
   Node->Header.Type    = MESSAGING_DEVICE_PATH;\r
   Node->Header.SubType = MSG_IPv4_DP;\r
-  SetDevicePathNodeLength (&Node->Header, 19);\r
+  SetDevicePathNodeLength (&Node->Header, sizeof (IPv4_DEVICE_PATH));\r
 \r
   CopyMem (&Node->LocalIpAddress, &LocalIp, sizeof (EFI_IPv4_ADDRESS));\r
   CopyMem (&Node->RemoteIpAddress, &RemoteIp, sizeof (EFI_IPv4_ADDRESS));\r
@@ -2619,6 +2733,14 @@ NetLibCreateIPv4DPathNode (
   } else {\r
     Node->StaticIpAddress = NetLibDefaultAddressIsStatic (Controller);\r
   }\r
+\r
+  //\r
+  // Set the Gateway IP address to default value 0:0:0:0.\r
+  // Set the Subnet mask to default value 255:255:255:0.\r
+  //\r
+  ZeroMem (&Node->GatewayIpAddress, sizeof (EFI_IPv4_ADDRESS));\r
+  SetMem (&Node->SubnetMask, sizeof (EFI_IPv4_ADDRESS), 0xff);\r
+  Node->SubnetMask.Addr[3] = 0;\r
 }\r
 \r
 /**\r
@@ -2660,7 +2782,14 @@ NetLibCreateIPv6DPathNode (
   Node->RemotePort = RemotePort;\r
 \r
   Node->Protocol        = Protocol;\r
-  Node->StaticIpAddress = FALSE;\r
+\r
+  //\r
+  // Set default value to IPAddressOrigin, PrefixLength.\r
+  // Set the Gateway IP address to unspecified address.\r
+  //\r
+  Node->IpAddressOrigin = 0;\r
+  Node->PrefixLength    = IP6_PREFIX_LENGTH;\r
+  ZeroMem (&Node->GatewayIpAddress, sizeof (EFI_IPv6_ADDRESS));\r
 }\r
 \r
 /**\r
@@ -3158,7 +3287,110 @@ Exit:
   return Status;\r
 }\r
 \r
+/**\r
+\r
+  Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.\r
+  The text representation of address is defined in RFC 4291.\r
+  \r
+  @param[in]       Ip6Address     The pointer to the IPv6 address.\r
+  @param[out]      String         The buffer to return the converted string.\r
+  @param[in]       StringSize     The length in bytes of the input String.\r
+                                  \r
+  @retval EFI_SUCCESS             Convert to string successfully.\r
+  @retval EFI_INVALID_PARAMETER   The input parameter is invalid.\r
+  @retval EFI_BUFFER_TOO_SMALL    The BufferSize is too small for the result. BufferSize has been \r
+                                  updated with the size needed to complete the request.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibIp6ToStr (\r
+  IN         EFI_IPv6_ADDRESS      *Ip6Address,\r
+  OUT        CHAR16                *String,\r
+  IN         UINTN                 StringSize\r
+  )\r
+{\r
+  UINT16     Ip6Addr[8];\r
+  UINTN      Index;\r
+  UINTN      LongestZerosStart;\r
+  UINTN      LongestZerosLength;\r
+  UINTN      CurrentZerosStart;\r
+  UINTN      CurrentZerosLength;\r
+  CHAR16     Buffer[sizeof"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"];\r
+  CHAR16     *Ptr;\r
+\r
+  if (Ip6Address == NULL || String == NULL || StringSize == 0) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Convert the UINT8 array to an UINT16 array for easy handling.\r
+  // \r
+  ZeroMem (Ip6Addr, sizeof (Ip6Addr));\r
+  for (Index = 0; Index < 16; Index++) {\r
+    Ip6Addr[Index / 2] |= (Ip6Address->Addr[Index] << ((1 - (Index % 2)) << 3));\r
+  }\r
+\r
+  //\r
+  // Find the longest zeros and mark it.\r
+  //\r
+  CurrentZerosStart  = DEFAULT_ZERO_START;\r
+  CurrentZerosLength = 0;\r
+  LongestZerosStart  = DEFAULT_ZERO_START;\r
+  LongestZerosLength = 0;\r
+  for (Index = 0; Index < 8; Index++) {\r
+    if (Ip6Addr[Index] == 0) {\r
+      if (CurrentZerosStart == DEFAULT_ZERO_START) {\r
+        CurrentZerosStart = Index;\r
+        CurrentZerosLength = 1;\r
+      } else {\r
+        CurrentZerosLength++;\r
+      }\r
+    } else {\r
+      if (CurrentZerosStart != DEFAULT_ZERO_START) {\r
+        if (CurrentZerosLength > 2 && (LongestZerosStart == (DEFAULT_ZERO_START) || CurrentZerosLength > LongestZerosLength)) {\r
+          LongestZerosStart  = CurrentZerosStart;\r
+          LongestZerosLength = CurrentZerosLength;\r
+        }\r
+        CurrentZerosStart  = DEFAULT_ZERO_START;\r
+        CurrentZerosLength = 0;\r
+      }\r
+    }\r
+  }\r
+  \r
+  if (CurrentZerosStart != DEFAULT_ZERO_START && CurrentZerosLength > 2) {\r
+    if (LongestZerosStart == DEFAULT_ZERO_START || LongestZerosLength < CurrentZerosLength) {\r
+      LongestZerosStart  = CurrentZerosStart;\r
+      LongestZerosLength = CurrentZerosLength;\r
+    }\r
+  }\r
+\r
+  Ptr = Buffer;\r
+  for (Index = 0; Index < 8; Index++) {\r
+    if (LongestZerosStart != DEFAULT_ZERO_START && Index >= LongestZerosStart && Index < LongestZerosStart + LongestZerosLength) {\r
+      if (Index == LongestZerosStart) {\r
+        *Ptr++ = L':';\r
+      }\r
+      continue;\r
+    }\r
+    if (Index != 0) {\r
+      *Ptr++ = L':';\r
+    }\r
+    Ptr += UnicodeSPrint(Ptr, 10, L"%x", Ip6Addr[Index]);\r
+  }\r
+  \r
+  if (LongestZerosStart != DEFAULT_ZERO_START && LongestZerosStart + LongestZerosLength == 8) {\r
+    *Ptr++ = L':';\r
+  }\r
+  *Ptr = L'\0';\r
+\r
+  if ((UINTN)Ptr - (UINTN)Buffer > StringSize) {\r
+    return EFI_BUFFER_TOO_SMALL;\r
+  }\r
 \r
+  StrCpy (String, Buffer);\r
+\r
+  return EFI_SUCCESS;\r
+}\r
 \r
 /**\r
   This function obtains the system guid from the smbios table.\r