Add StrToIp functions to NetLib.
authortye1 <tye1@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 25 Jan 2010 02:19:04 +0000 (02:19 +0000)
committertye1 <tye1@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 25 Jan 2010 02:19:04 +0000 (02:19 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk@9798 6f19259b-4bc3-4df7-8a09-765794883524

edk2/MdeModulePkg/Include/Library/NetLib.h
edk2/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c

index d90f82d..3a3b190 100644 (file)
@@ -1195,9 +1195,97 @@ NetLibDefaultUnload (
   IN EFI_HANDLE             ImageHandle\r
   );\r
 \r
   IN EFI_HANDLE             ImageHandle\r
   );\r
 \r
+/**\r
+  Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip4Address     The pointer to the converted IPv4 address.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv4 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip4Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibAsciiStrToIp4 (\r
+  IN CONST CHAR8                 *String,\r
+  OUT      EFI_IPv4_ADDRESS      *Ip4Address\r
+  );\r
+\r
+/**\r
+  Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the\r
+  string is defined in RFC 4291 - Text Pepresentation of Addresses.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip6Address     The pointer to the converted IPv6 address.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv6 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip6Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibAsciiStrToIp6 (\r
+  IN CONST CHAR8                 *String,\r
+  OUT      EFI_IPv6_ADDRESS      *Ip6Address\r
+  );\r
+\r
+/**\r
+  Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip4Address     The pointer to the converted IPv4 address.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv4 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip4Address is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES   Fail to perform the operation due to lack of resource.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibStrToIp4 (\r
+  IN CONST CHAR16                *String,\r
+  OUT      EFI_IPv4_ADDRESS      *Ip4Address\r
+  );\r
+\r
+/**\r
+  Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS.  The format of\r
+  the string is defined in RFC 4291 - Text Pepresentation of Addresses.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip6Address     The pointer to the converted IPv6 address.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv6 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip6Address is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES   Fail to perform the operation due to lack of resource.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibStrToIp6 (\r
+  IN CONST CHAR16                *String,\r
+  OUT      EFI_IPv6_ADDRESS      *Ip6Address\r
+  );\r
+\r
+/**\r
+  Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.\r
+  The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses\r
+  Prefixes: ipv6-address/prefix-length.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip6Address     The pointer to the converted IPv6 address.\r
+  @param[out]     PrefixLength   The pointer to the converted prefix length.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv6 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip6Address is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES   Fail to perform the operation due to lack of resource.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibStrToIp6andPrefix (\r
+  IN CONST CHAR16                *String,\r
+  OUT      EFI_IPv6_ADDRESS      *Ip6Address,\r
+  OUT      UINT8                 *PrefixLength\r
+  );\r
 \r
 //\r
 \r
 //\r
-//Various signatures\r
+// Various signatures\r
 //\r
 #define  NET_BUF_SIGNATURE    SIGNATURE_32 ('n', 'b', 'u', 'f')\r
 #define  NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')\r
 //\r
 #define  NET_BUF_SIGNATURE    SIGNATURE_32 ('n', 'b', 'u', 'f')\r
 #define  NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')\r
index 5ff84a9..9ab7ab0 100644 (file)
@@ -2410,3 +2410,378 @@ NetLibGetNicHandle (
   gBS->FreePool (OpenBuffer);\r
   return Handle;\r
 }\r
   gBS->FreePool (OpenBuffer);\r
   return Handle;\r
 }\r
+\r
+/**\r
+  Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip4Address     The pointer to the converted IPv4 address.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv4 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip4Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibAsciiStrToIp4 (\r
+  IN CONST CHAR8                 *String,\r
+  OUT      EFI_IPv4_ADDRESS      *Ip4Address\r
+  )\r
+{\r
+  UINT8                          Index;\r
+  CHAR8                          *Ip4Str;\r
+  CHAR8                          *TempStr;\r
+  UINTN                          NodeVal;\r
+\r
+  if ((String == NULL) || (Ip4Address == NULL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Ip4Str = (CHAR8 *) String;\r
+\r
+  for (Index = 0; Index < 4; Index++) {\r
+    TempStr = Ip4Str;\r
+\r
+    while ((*Ip4Str != '\0') && (*Ip4Str != '.')) {\r
+      Ip4Str++;\r
+    }\r
+\r
+    //\r
+    // The IPv4 address is X.X.X.X\r
+    //\r
+    if (*Ip4Str == '.') {\r
+      if (Index == 3) {\r
+        return EFI_INVALID_PARAMETER;\r
+      }\r
+    } else {\r
+      if (Index != 3) {\r
+        return EFI_INVALID_PARAMETER;\r
+      }\r
+    }\r
+\r
+    NodeVal = AsciiStrDecimalToUintn (TempStr);\r
+    if (NodeVal > 0xFF) {\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
+\r
+    Ip4Address->Addr[Index] = (UINT8) NodeVal;\r
+\r
+    Ip4Str++;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+  Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the\r
+  string is defined in RFC 4291 - Text Pepresentation of Addresses.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip6Address     The pointer to the converted IPv6 address.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv6 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip6Address is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibAsciiStrToIp6 (\r
+  IN CONST CHAR8                 *String,\r
+  OUT      EFI_IPv6_ADDRESS      *Ip6Address\r
+  )\r
+{\r
+  UINT8                          Index;\r
+  CHAR8                          *Ip6Str;\r
+  CHAR8                          *TempStr;\r
+  CHAR8                          *TempStr2;\r
+  UINT8                          NodeCnt;\r
+  UINT8                          TailNodeCnt;\r
+  UINT8                          AllowedCnt;\r
+  UINTN                          NodeVal;\r
+  BOOLEAN                        Short;\r
+  BOOLEAN                        Update;\r
+\r
+  if ((String == NULL) || (Ip6Address == NULL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Ip6Str     = (CHAR8 *) String;\r
+  AllowedCnt = 6;\r
+\r
+  //\r
+  // An IPv6 address leading with : looks strange.\r
+  //\r
+  if (*Ip6Str == ':') {\r
+    if (*(Ip6Str + 1) != ':') {\r
+      return EFI_INVALID_PARAMETER;\r
+    } else {\r
+      AllowedCnt = 7;\r
+    }    \r
+  }\r
+\r
+  ZeroMem (Ip6Address, sizeof (EFI_IPv6_ADDRESS));\r
+\r
+  NodeCnt     = 0;\r
+  TailNodeCnt = 0;\r
+  Short       = FALSE;\r
+  Update      = FALSE;\r
+\r
+  for (Index = 0; (Index + 1) < 16; Index = (UINT8) (Index + 2)) {\r
+    TempStr = Ip6Str;\r
+\r
+    while ((*Ip6Str != '\0') && (*Ip6Str != ':')) {\r
+      Ip6Str++;\r
+    }\r
+\r
+    if ((*Ip6Str == '\0') && (Index != 14)) {\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
+\r
+    if (*Ip6Str == ':') {\r
+      if (*(Ip6Str + 1) == ':') {\r
+        if ((*(Ip6Str + 2) == '0') || (NodeCnt > 6)) {\r
+          //\r
+          // ::0 looks strange. report error to user.\r
+          //\r
+          return EFI_INVALID_PARAMETER;\r
+        }           \r
+\r
+        //\r
+        // Skip the abbreviation part of IPv6 address.\r
+        //\r
+        TempStr2 = Ip6Str + 2;\r
+        while ((*TempStr2 != '\0')) {\r
+          if (*TempStr2 == ':') {\r
+            if (*(TempStr2 + 1) == ':') {\r
+              //\r
+              // :: can only appear once in IPv6 address.\r
+              //\r
+              return EFI_INVALID_PARAMETER;\r
+            }\r
+            \r
+            TailNodeCnt++;\r
+            if (TailNodeCnt >= (AllowedCnt - NodeCnt)) {\r
+              //\r
+              // :: indicates one or more groups of 16 bits of zeros.\r
+              //\r
+              return EFI_INVALID_PARAMETER;\r
+            }\r
+          }\r
+\r
+          TempStr2++;\r
+        }       \r
+\r
+        Short  = TRUE;\r
+        Update = TRUE;\r
+\r
+        Ip6Str = Ip6Str + 2;\r
+      } else {\r
+        Ip6Str++;\r
+        NodeCnt++;\r
+        if ((Short && (NodeCnt > 6)) || (!Short && (NodeCnt > 7))) {\r
+          //\r
+          // There are more than 8 groups of 16 bits of zeros.\r
+          //\r
+          return EFI_INVALID_PARAMETER;\r
+        }\r
+      }      \r
+    }    \r
+\r
+    //\r
+    // Convert the Str to IPv6 address.\r
+    //\r
+    NodeVal = AsciiStrHexToUintn (TempStr);\r
+    if ((NodeVal > 0xFFFF) || (Index > 14)) {\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
+\r
+    Ip6Address->Addr[Index] = (UINT8) (NodeVal >> 8);\r
+    Ip6Address->Addr[Index + 1] = (UINT8) (NodeVal & 0xFF);\r
+\r
+    //\r
+    // Skip the groups of zeros by ::\r
+    //\r
+    if (Short && Update) {\r
+      Index  = (UINT8) (16 - (TailNodeCnt + 2) * 2);\r
+      Update = FALSE;\r
+    }\r
+  }\r
+\r
+  if ((!Short && Index != 16) || (*Ip6Str != '\0')) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+  Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip4Address     The pointer to the converted IPv4 address.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv4 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip4Address is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES   Fail to perform the operation due to lack of resource.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibStrToIp4 (\r
+  IN CONST CHAR16                *String,\r
+  OUT      EFI_IPv4_ADDRESS      *Ip4Address\r
+  )\r
+{\r
+  CHAR8                          *Ip4Str;\r
+  EFI_STATUS                     Status;\r
+  \r
+  if ((String == NULL) || (Ip4Address == NULL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Ip4Str = (CHAR8 *) AllocatePool ((StrLen (String) + 1) * sizeof (CHAR8));\r
+  if (Ip4Str == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  UnicodeStrToAsciiStr (String, Ip4Str);\r
+\r
+  Status = NetLibAsciiStrToIp4 (Ip4Str, Ip4Address);\r
+\r
+  FreePool (Ip4Str);\r
+\r
+  return Status;\r
+}\r
+\r
+\r
+/**\r
+  Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS.  The format of\r
+  the string is defined in RFC 4291 - Text Pepresentation of Addresses.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip6Address     The pointer to the converted IPv6 address.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv6 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip6Address is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES   Fail to perform the operation due to lack of resource.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibStrToIp6 (\r
+  IN CONST CHAR16                *String,\r
+  OUT      EFI_IPv6_ADDRESS      *Ip6Address\r
+  ) \r
+{\r
+  CHAR8                          *Ip6Str;\r
+  EFI_STATUS                     Status;\r
+  \r
+  if ((String == NULL) || (Ip6Address == NULL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Ip6Str = (CHAR8 *) AllocatePool ((StrLen (String) + 1) * sizeof (CHAR8));\r
+  if (Ip6Str == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  UnicodeStrToAsciiStr (String, Ip6Str);\r
+\r
+  Status = NetLibAsciiStrToIp6 (Ip6Str, Ip6Address);\r
+\r
+  FreePool (Ip6Str);\r
+\r
+  return Status;\r
+}\r
+\r
+/**\r
+  Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.\r
+  The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses\r
+  Prefixes: ipv6-address/prefix-length.\r
+\r
+  @param[in]      String         The pointer to the Ascii string.\r
+  @param[out]     Ip6Address     The pointer to the converted IPv6 address.\r
+  @param[out]     PrefixLength   The pointer to the converted prefix length.\r
+\r
+  @retval EFI_SUCCESS            Convert to IPv6 address successfully.  \r
+  @retval EFI_INVALID_PARAMETER  The string is mal-formated or Ip6Address is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES   Fail to perform the operation due to lack of resource.\r
+\r
+**/\r
+EFI_STATUS\r
+NetLibStrToIp6andPrefix (\r
+  IN CONST CHAR16                *String,\r
+  OUT      EFI_IPv6_ADDRESS      *Ip6Address,\r
+  OUT      UINT8                 *PrefixLength\r
+  ) \r
+{\r
+  CHAR8                          *Ip6Str;  \r
+  CHAR8                          *PrefixStr;\r
+  CHAR8                          *TempStr;\r
+  EFI_STATUS                     Status;\r
+  UINT8                          Length;\r
+  \r
+  if ((String == NULL) || (Ip6Address == NULL) || (PrefixLength == NULL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Ip6Str = (CHAR8 *) AllocatePool ((StrLen (String) + 1) * sizeof (CHAR8));\r
+  if (Ip6Str == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  UnicodeStrToAsciiStr (String, Ip6Str);\r
+\r
+  //\r
+  // Get the sub string describing prefix length.\r
+  //\r
+  TempStr = Ip6Str;\r
+  while (*TempStr != '\0' && (*TempStr != '/')) {\r
+    TempStr++;\r
+  }\r
+\r
+  if (*TempStr == '/') {\r
+    PrefixStr = TempStr + 1;\r
+  } else {\r
+    PrefixStr = NULL;\r
+  }\r
+\r
+  //\r
+  // Get the sub string describing IPv6 address and convert it.\r
+  //\r
+  *TempStr = '\0';\r
+\r
+  Status = NetLibAsciiStrToIp6 (Ip6Str, Ip6Address);\r
+  if (EFI_ERROR (Status)) {\r
+    goto Exit;\r
+  }\r
+\r
+  //\r
+  // Convert the string to prefix length\r
+  //\r
+  Length = 0;\r
+  if (PrefixStr != NULL) {\r
+\r
+    Status = EFI_INVALID_PARAMETER;\r
+\r
+    while (*PrefixStr != '\0') {\r
+      if (NET_IS_DIGIT (*PrefixStr)) {\r
+        Length = (UINT8) (Length * 10 + (*PrefixStr - '0'));\r
+        if (Length >= IP6_PREFIX_NUM) {\r
+          goto Exit;\r
+        }\r
+      } else {\r
+        goto Exit;\r
+      }\r
+\r
+      PrefixStr++;\r
+    }\r
+  }\r
+\r
+  *PrefixLength = Length;\r
+  Status        = EFI_SUCCESS;\r
+\r
+Exit:\r
+\r
+  FreePool (Ip6Str);\r
+  return Status;\r
+}\r
+\r