From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 306E882223 for ; Tue, 21 Feb 2017 23:58:33 -0800 (PST) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 21 Feb 2017 23:58:32 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.35,193,1484035200"; d="scan'208";a="827100841" Received: from fmsmsx107.amr.corp.intel.com ([10.18.124.205]) by FMSMGA003.fm.intel.com with ESMTP; 21 Feb 2017 23:58:32 -0800 Received: from fmsmsx151.amr.corp.intel.com (10.18.125.4) by fmsmsx107.amr.corp.intel.com (10.18.124.205) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 21 Feb 2017 23:58:32 -0800 Received: from shsmsx102.ccr.corp.intel.com (10.239.4.154) by FMSMSX151.amr.corp.intel.com (10.18.125.4) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 21 Feb 2017 23:58:31 -0800 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.59]) by shsmsx102.ccr.corp.intel.com ([169.254.2.88]) with mapi id 14.03.0248.002; Wed, 22 Feb 2017 15:58:24 +0800 From: "Ni, Ruiyu" To: "Yao, Jiewen" , "edk2-devel@lists.01.org" CC: "Gao, Liming" , "Fu, Siyuan" Thread-Topic: [PATCH 04/11] MdePkg/BaseLib: Add StrToGuid/StrHexToBytes/StrToIpv[4/6]Address Thread-Index: AQHSjNEzL7qocpjRTEOS5sN+KyfGPqF0qGKQ Date: Wed, 22 Feb 2017 07:58:23 +0000 Message-ID: <734D49CCEBEEF84792F5B80ED585239D5B8AB296@SHSMSX104.ccr.corp.intel.com> References: <20170222045047.558308-1-ruiyu.ni@intel.com> <20170222045047.558308-5-ruiyu.ni@intel.com> <74D8A39837DF1E4DA445A8C0B3885C503A8F33C7@shsmsx102.ccr.corp.intel.com> In-Reply-To: <74D8A39837DF1E4DA445A8C0B3885C503A8F33C7@shsmsx102.ccr.corp.intel.com> Accept-Language: en-US, zh-CN X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [PATCH 04/11] MdePkg/BaseLib: Add StrToGuid/StrHexToBytes/StrToIpv[4/6]Address X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 22 Feb 2017 07:58:33 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Jiewen, If we returns Unsupported for " 1.2.3.4". What shall we return for " 1.2.3"? If we need to return Invalid Parameter for " 1.2.3", the implementation h= as to check whether it's a valid IP address after spaces, or an invalid IP = address. Can you just return Invalid Parameter for all cases? Thanks/Ray > -----Original Message----- > From: Yao, Jiewen > Sent: Wednesday, February 22, 2017 2:02 PM > To: Ni, Ruiyu ; edk2-devel@lists.01.org > Cc: Gao, Liming ; Fu, Siyuan > Subject: RE: [PATCH 04/11] MdePkg/BaseLib: Add > StrToGuid/StrHexToBytes/StrToIpv[4/6]Address >=20 > Thanks. >=20 > I suggest we clearly say: This function does not support the leading pad = space , > which includes spaces or tab characters, before the first valid char. >=20 > For example, " 1.2.3.4" is considered as invalid IPv4 address. > And I suggest we return EFI_UNSUPPORTED. >=20 > The comment is applied to add [Ascii]StrToGuid/IpV4/IpV6. >=20 > Thank you > Yao Jiewen >=20 > > -----Original Message----- > > From: Ni, Ruiyu > > Sent: Wednesday, February 22, 2017 12:51 PM > > To: edk2-devel@lists.01.org > > Cc: Gao, Liming ; Yao, Jiewen > > ; Fu, Siyuan > > Subject: [PATCH 04/11] MdePkg/BaseLib: Add > > StrToGuid/StrHexToBytes/StrToIpv[4/6]Address > > > > The patch adds 4 APIs to convert Unicode string to GUID, bytes buffer, > > IP v4 address and IP v6 address. > > > > Contributed-under: TianoCore Contribution Agreement 1.0 > > Signed-off-by: Ruiyu Ni > > Cc: Liming Gao > > Cc: Jiewen Yao > > Cc: Siyuan Fu > > --- > > MdePkg/Include/Library/BaseLib.h | 241 ++++++++++++++ > > MdePkg/Library/BaseLib/SafeString.c | 623 > > ++++++++++++++++++++++++++++++++++++ > > 2 files changed, 864 insertions(+) > > > > diff --git a/MdePkg/Include/Library/BaseLib.h > > b/MdePkg/Include/Library/BaseLib.h > > index d71ccb7..8aac4c8 100644 > > --- a/MdePkg/Include/Library/BaseLib.h > > +++ b/MdePkg/Include/Library/BaseLib.h > > @@ -1536,6 +1536,247 @@ StrHexToUint64 ( > > IN CONST CHAR16 *String > > ); > > > > +/** > > + Convert a Null-terminated Unicode string to IPv6 address and prefix = length. > > + > > + This function outputs a value of type IPv6_ADDRESS and may output a > > + value of type UINT8 by interpreting the contents of the Unicode > > + string specified by String. The format of the input Unicode string S= tring is as > follows: > > + > > + X:X:X:X:X:X:X:X[/P] > > + > > + X contains one to four hexadecimal digit characters in the range > > + [0-9], [a-f] > > and > > + [A-F]. X is converted to a value of type UINT16, whose low byte is > > + stored in > > low > > + memory address and high byte is stored in high memory address. P > > + contains > > decimal > > + digit characters in the range [0-9]. The running zero in the > > + beginning of P will be ignored. /P is optional. > > + > > + When /P is not in the String, the function stops at the first > > + character that is not a valid hexadecimal digit character after eigh= t X's are > converted. > > + > > + When /P is in the String, the function stops at the first character > > + that is not a valid decimal digit character after P is converted. > > + > > + "::" can be used to compress one or more groups of X when X contains= only > 0. > > + The "::" can only appear once in the String. > > + > > + If String is NULL, then ASSERT(). > > + > > + If Address is NULL, then ASSERT(). > > + > > + If String is not aligned in a 16-bit boundary, then ASSERT(). > > + > > + If PcdMaximumUnicodeStringLength is not zero, and String contains > > + more > > than > > + PcdMaximumUnicodeStringLength Unicode characters, not including the > > + Null-terminator, then ASSERT(). > > + > > + If EndPointer is not NULL and Address is translated from String, a > > + pointer to the character that stopped the scan is stored at the > > + location pointed to by EndPointer. > > + > > + @param String Pointer to a Null-terminated Unicod= e > > string. > > + @param EndPointer Pointer to character that stops sca= n. > > + @param Address Pointer to the converted IPv6 > > address. > > + @param PrefixLength Pointer to the converted IPv6 addre= ss > > prefix > > + length. MAX_UINT8 is returned when > > /P is > > + not in the String. > > + > > + @retval RETURN_SUCCESS Address is translated from String. > > + @retval RETURN_INVALID_PARAMETER If String is NULL. > > + If Data is NULL. > > + If PcdMaximumUnicodeStringLength > > + is > > not > > + zero, and String contains more tha= n > > + PcdMaximumUnicodeStringLength > > Unicode > > + characters, not including the > > + Null-terminator. > > + If X contains more than four > > hexadecimal > > + digit characters. > > + If String contains "::" and number = of X > > + is not less than 8. > > + If P starts with character that is = not a > > + valid decimal digit character. > > + If the decimal number converted > > + from > > P > > + exceeds 128. > > + > > +**/ > > +RETURN_STATUS > > +EFIAPI > > +StrToIpv6Address ( > > + IN CONST CHAR16 *String, > > + OUT CHAR16 **EndPointer, OPTIONAL > > + OUT IPv6_ADDRESS *Address, > > + OUT UINT8 *PrefixLength OPTIONAL > > + ); > > + > > +/** > > + Convert a Null-terminated Unicode string to IPv4 address and prefix = length. > > + > > + This function outputs a value of type IPv4_ADDRESS and may output a > > + value of type UINT8 by interpreting the contents of the Unicode > > + string specified by String. The format of the input Unicode string S= tring is as > follows: > > + > > + D.D.D.D[/P] > > + > > + D and P are decimal digit characters in the range [0-9]. The > > + running zero in the beginning of D and P will be ignored. /P is opti= onal. > > + > > + When /P is not in the String, the function stops at the first > > + character that is not a valid decimal digit character after four D's= are > converted. > > + > > + When /P is in the String, the function stops at the first character > > + that is not a valid decimal digit character after P is converted. > > + > > + If String is NULL, then ASSERT(). > > + > > + If Address is NULL, then ASSERT(). > > + > > + If String is not aligned in a 16-bit boundary, then ASSERT(). > > + > > + If PcdMaximumUnicodeStringLength is not zero, and String contains > > + more > > than > > + PcdMaximumUnicodeStringLength Unicode characters, not including the > > + Null-terminator, then ASSERT(). > > + > > + If EndPointer is not NULL and Address is translated from String, a > > + pointer to the character that stopped the scan is stored at the > > + location pointed to by EndPointer. > > + > > + @param String Pointer to a Null-terminated Unicod= e > > string. > > + @param EndPointer Pointer to character that stops sca= n. > > + @param Address Pointer to the converted IPv4 > > address. > > + @param PrefixLength Pointer to the converted IPv4 addre= ss > > prefix > > + length. MAX_UINT8 is returned when > > /P is > > + not in the String. > > + > > + @retval RETURN_SUCCESS Address is translated from String. > > + @retval RETURN_INVALID_PARAMETER If String is NULL. > > + If Data is NULL. > > + If PcdMaximumUnicodeStringLength > > + is > > not > > + zero, and String contains more tha= n > > + PcdMaximumUnicodeStringLength > > Unicode > > + characters, not including the > > + Null-terminator. > > + If String is not in the correct for= mat. > > + If any decimal number converted > > + from > > D > > + exceeds 255. > > + If the decimal number converted > > + from > > P > > + exceeds 32. > > + > > +**/ > > +RETURN_STATUS > > +EFIAPI > > +StrToIpv4Address ( > > + IN CONST CHAR16 *String, > > + OUT CHAR16 **EndPointer, OPTIONAL > > + OUT IPv4_ADDRESS *Address, > > + OUT UINT8 *PrefixLength OPTIONAL > > + ); > > + > > +#define GUID_STRING_LENGTH 36 > > + > > +/** > > + Convert a Null-terminated Unicode GUID string to a value of type > > + EFI_GUID. > > + > > + This function outputs a GUID value by interpreting the contents of > > + the Unicode string specified by String. The format of the input > > + Unicode string String consists of 36 characters, as follows: > > + > > + aabbccdd-eeff-gghh-iijj-kkllmmnnoopp > > + > > + The pairs aa - pp are two characters in the range [0-9], [a-f] and > > + [A-F], with each pair representing a single byte hexadecimal value. > > + > > + The mapping between String and the EFI_GUID structure is as follows: > > + aa Data1[24:31] > > + bb Data1[16:23] > > + cc Data1[8:15] > > + dd Data1[0:7] > > + ee Data2[8:15] > > + ff Data2[0:7] > > + gg Data3[8:15] > > + hh Data3[0:7] > > + ii Data4[0:7] > > + jj Data4[8:15] > > + kk Data4[16:23] > > + ll Data4[24:31] > > + mm Data4[32:39] > > + nn Data4[40:47] > > + oo Data4[48:55] > > + pp Data4[56:63] > > + > > + If String is NULL, then ASSERT(). > > + If Guid is NULL, then ASSERT(). > > + If String is not aligned in a 16-bit boundary, then ASSERT(). > > + > > + @param String Pointer to a Null-terminated Unicod= e > > string. > > + @param Guid Pointer to the converted GUID. > > + > > + @retval RETURN_SUCCESS Guid is translated from String. > > + @retval RETURN_INVALID_PARAMETER If String is NULL. > > + If Data is NULL. > > + If String is not as the above forma= t. > > + > > +**/ > > +RETURN_STATUS > > +EFIAPI > > +StrToGuid ( > > + IN CONST CHAR16 *String, > > + OUT GUID *Guid > > + ); > > + > > +/** > > + Convert a Null-terminated Unicode hexadecimal string to a byte array= . > > + > > + This function outputs a byte array by interpreting the contents of > > + the Unicode string specified by String in hexadecimal format. The > > + format of the input Unicode string String is: > > + > > + [XX]* > > + > > + X is a hexadecimal digit character in the range [0-9], [a-f] and [A-= F]. > > + The function decodes every two hexadecimal digit characters as one b= yte. > > The > > + decoding stops after Length of characters and outputs Buffer > > + containing (Length / 2) bytes. > > + > > + If String is not aligned in a 16-bit boundary, then ASSERT(). > > + > > + If String is NULL, then ASSERT(). > > + > > + If Buffer is NULL, then ASSERT(). > > + > > + If Length is not multiple of 2, then ASSERT(). > > + > > + If PcdMaximumStringLength is not zero and Length is greater than > > + PcdMaximumAsciiStringLength, then ASSERT(). > > + > > + If MaxBufferSize is less than (Length / 2), then ASSERT(). > > + > > + @param String Pointer to a Null-terminated Unicod= e > > string. > > + @param Length The number of Unicode characters to > > decode. > > + @param Buffer Pointer to the converted bytes arra= y. > > + @param MaxBufferSize The maximum size of Buffer. > > + > > + @retval RETURN_SUCCESS Buffer is translated from String. > > + @retval RETURN_INVALID_PARAMETER If String is NULL. > > + If Data is NULL. > > + If Length is not multiple of 2. > > + If PcdMaximumStringLength is not > > zero, > > + and Length is greater than > > + PcdMaximumAsciiStringLength. > > + If Length of characters from > > + String > > contain > > + a character that is not valid > > hexadecimal > > + digit characters, or a Null-termin= ator. > > + @retval RETURN_BUFFER_TOO_SMALL If MaxBufferSize is less than > > (Length / 2). > > +**/ > > +RETURN_STATUS > > +EFIAPI > > +StrHexToBytes ( > > + IN CONST CHAR16 *String, > > + IN UINTN Length, > > + OUT UINT8 *Buffer, > > + IN UINTN MaxBufferSize > > + ); > > + > > #ifndef DISABLE_NEW_DEPRECATED_INTERFACES > > > > /** > > diff --git a/MdePkg/Library/BaseLib/SafeString.c > > b/MdePkg/Library/BaseLib/SafeString.c > > index 315059e..ede1c99 100644 > > --- a/MdePkg/Library/BaseLib/SafeString.c > > +++ b/MdePkg/Library/BaseLib/SafeString.c > > @@ -1074,6 +1074,629 @@ StrHexToUint64S ( } > > > > /** > > + Convert a Null-terminated Unicode string to IPv6 address and prefix = length. > > + > > + This function outputs a value of type IPv6_ADDRESS and may output a > > + value of type UINT8 by interpreting the contents of the Unicode > > + string specified by String. The format of the input Unicode string S= tring is as > follows: > > + > > + X:X:X:X:X:X:X:X[/P] > > + > > + X contains one to four hexadecimal digit characters in the range > > + [0-9], [a-f] > > and > > + [A-F]. X is converted to a value of type UINT16, whose low byte is > > + stored in > > low > > + memory address and high byte is stored in high memory address. P > > + contains > > decimal > > + digit characters in the range [0-9]. The running zero in the > > + beginning of P will be ignored. /P is optional. > > + > > + When /P is not in the String, the function stops at the first > > + character that is not a valid hexadecimal digit character after eigh= t X's are > converted. > > + > > + When /P is in the String, the function stops at the first character > > + that is not a valid decimal digit character after P is converted. > > + > > + "::" can be used to compress one or more groups of X when X contains= only > 0. > > + The "::" can only appear once in the String. > > + > > + If String is NULL, then ASSERT(). > > + > > + If Address is NULL, then ASSERT(). > > + > > + If String is not aligned in a 16-bit boundary, then ASSERT(). > > + > > + If PcdMaximumUnicodeStringLength is not zero, and String contains > > + more > > than > > + PcdMaximumUnicodeStringLength Unicode characters, not including the > > + Null-terminator, then ASSERT(). > > + > > + If EndPointer is not NULL and Address is translated from String, a > > + pointer to the character that stopped the scan is stored at the > > + location pointed to by EndPointer. > > + > > + @param String Pointer to a Null-terminated Unicod= e > > string. > > + @param EndPointer Pointer to character that stops sca= n. > > + @param Address Pointer to the converted IPv6 > > address. > > + @param PrefixLength Pointer to the converted IPv6 addre= ss > > prefix > > + length. MAX_UINT8 is returned when > > /P is > > + not in the String. > > + > > + @retval RETURN_SUCCESS Address is translated from String. > > + @retval RETURN_INVALID_PARAMETER If String is NULL. > > + If Data is NULL. > > + If PcdMaximumUnicodeStringLength > > + is > > not > > + zero, and String contains more tha= n > > + PcdMaximumUnicodeStringLength > > Unicode > > + characters, not including the > > + Null-terminator. > > + If X contains more than four > > hexadecimal > > + digit characters. > > + If String contains "::" and number = of X > > + is not less than 8. > > + If P starts with character that is = not a > > + valid decimal digit character. > > + If the decimal number converted > > + from > > P > > + exceeds 128. > > + > > +**/ > > +RETURN_STATUS > > +EFIAPI > > +StrToIpv6Address ( > > + IN CONST CHAR16 *String, > > + OUT CHAR16 **EndPointer, OPTIONAL > > + OUT IPv6_ADDRESS *Address, > > + OUT UINT8 *PrefixLength OPTIONAL > > + ) > > +{ > > + RETURN_STATUS Status; > > + UINTN AddressIndex; > > + UINTN Uintn; > > + IPv6_ADDRESS LocalAddress; > > + UINT8 LocalPrefixLength; > > + CONST CHAR16 *Pointer; > > + CHAR16 *End; > > + UINTN CompressStart; > > + BOOLEAN ExpectPrefix; > > + > > + LocalPrefixLength =3D MAX_UINT8; > > + CompressStart =3D ARRAY_SIZE (Address->Addr); > > + ExpectPrefix =3D FALSE; > > + > > + ASSERT (((UINTN) String & BIT0) =3D=3D 0); > > + > > + // > > + // 1. None of String or Guid shall be a null pointer. > > + // > > + SAFE_STRING_CONSTRAINT_CHECK ((String !=3D NULL), > > RETURN_INVALID_PARAMETER); > > + SAFE_STRING_CONSTRAINT_CHECK ((Address !=3D NULL), > > RETURN_INVALID_PARAMETER); > > + > > + for (Pointer =3D String, AddressIndex =3D 0; AddressIndex < ARRAY_SI= ZE > > (Address->Addr) + 1;) { > > + if (!InternalIsHexaDecimalDigitCharacter (*Pointer)) { > > + if (*Pointer !=3D L':') { > > + // > > + // ":" or "/" should be followed by digit characters. > > + // > > + return RETURN_INVALID_PARAMETER; > > + } > > + > > + // > > + // Meet second ":" after previous ":" or "/" > > + // or meet first ":" in the beginning of String. > > + // > > + if (ExpectPrefix) { > > + // > > + // ":" shall not be after "/" > > + // > > + return RETURN_INVALID_PARAMETER; > > + } > > + > > + if (CompressStart !=3D ARRAY_SIZE (Address->Addr) || AddressInde= x > > + =3D=3D > > ARRAY_SIZE (Address->Addr)) { > > + // > > + // "::" can only appear once. > > + // "::" can only appear when address is not full length. > > + // > > + return RETURN_INVALID_PARAMETER; > > + } else { > > + // > > + // Remember the start of zero compressing. > > + // > > + CompressStart =3D AddressIndex; > > + Pointer++; > > + > > + if (CompressStart =3D=3D 0) { > > + if (*Pointer !=3D L':') { > > + // > > + // Single ":" shall not be in the beginning of String. > > + // > > + return RETURN_INVALID_PARAMETER; > > + } > > + Pointer++; > > + } > > + } > > + } > > + > > + if (!InternalIsHexaDecimalDigitCharacter (*Pointer)) { > > + if (*Pointer =3D=3D L'/') { > > + // > > + // Might be optional "/P" after "::". > > + // > > + if (CompressStart !=3D AddressIndex) { > > + return RETURN_INVALID_PARAMETER; > > + } > > + } else { > > + break; > > + } > > + } else { > > + if (!ExpectPrefix) { > > + // > > + // Get X. > > + // > > + Status =3D StrHexToUintnS (Pointer, &End, &Uintn); > > + if (RETURN_ERROR (Status) || End - Pointer > 4) { > > + // > > + // Number of hexadecimal digit characters is no more than 4. > > + // > > + return RETURN_INVALID_PARAMETER; > > + } > > + Pointer =3D End; > > + // > > + // Uintn won't exceed MAX_UINT16 if number of hexadecimal > > + digit > > characters is no more than 4. > > + // > > + LocalAddress.Addr[AddressIndex] =3D (UINT8) ((UINT16) Uintn >>= 8); > > + LocalAddress.Addr[AddressIndex + 1] =3D (UINT8) Uintn; > > + AddressIndex +=3D 2; > > + } else { > > + // > > + // Get P, then exit the loop. > > + // > > + Status =3D StrDecimalToUintnS (Pointer, &End, &Uintn); > > + if (RETURN_ERROR (Status) || End =3D=3D Pointer || Uintn > 128= ) { > > + // > > + // Prefix length should not exceed 128. > > + // > > + return RETURN_INVALID_PARAMETER; > > + } > > + LocalPrefixLength =3D (UINT8) Uintn; > > + Pointer =3D End; > > + break; > > + } > > + } > > + > > + // > > + // Skip ':' or "/" > > + // > > + if (*Pointer =3D=3D L'/') { > > + ExpectPrefix =3D TRUE; > > + } else if (*Pointer =3D=3D L':') { > > + if (AddressIndex =3D=3D ARRAY_SIZE (Address->Addr)) { > > + // > > + // Meet additional ":" after all 8 16-bit address > > + // > > + break; > > + } > > + } else { > > + // > > + // Meet other character that is not "/" or ":" after all 8 16-bi= t address > > + // > > + break; > > + } > > + Pointer++; > > + } > > + > > + if ((AddressIndex =3D=3D ARRAY_SIZE (Address->Addr) && CompressStart= !=3D > > ARRAY_SIZE (Address->Addr)) || > > + (AddressIndex !=3D ARRAY_SIZE (Address->Addr) && CompressStart =3D= =3D > > ARRAY_SIZE (Address->Addr)) > > + ) { > > + // > > + // Full length of address shall not have compressing zeros. > > + // Non-full length of address shall have compressing zeros. > > + // > > + return RETURN_INVALID_PARAMETER; > > + } > > + CopyMem (&Address->Addr[0], &LocalAddress.Addr[0], CompressStart); > > + ZeroMem (&Address->Addr[CompressStart], ARRAY_SIZE (Address->Addr) - > > AddressIndex); > > + CopyMem ( > > + &Address->Addr[CompressStart + ARRAY_SIZE (Address->Addr) - > > AddressIndex], > > + &LocalAddress.Addr[CompressStart], > > + AddressIndex - CompressStart > > + ); > > + > > + if (PrefixLength !=3D NULL) { > > + *PrefixLength =3D LocalPrefixLength; } if (EndPointer !=3D NULL)= { > > + *EndPointer =3D (CHAR16 *) Pointer; } > > + > > + return RETURN_SUCCESS; > > +} > > + > > +/** > > + Convert a Null-terminated Unicode string to IPv4 address and prefix = length. > > + > > + This function outputs a value of type IPv4_ADDRESS and may output a > > + value of type UINT8 by interpreting the contents of the Unicode > > + string specified by String. The format of the input Unicode string S= tring is as > follows: > > + > > + D.D.D.D[/P] > > + > > + D and P are decimal digit characters in the range [0-9]. The > > + running zero in the beginning of D and P will be ignored. /P is opti= onal. > > + > > + When /P is not in the String, the function stops at the first > > + character that is not a valid decimal digit character after four D's= are > converted. > > + > > + When /P is in the String, the function stops at the first character > > + that is not a valid decimal digit character after P is converted. > > + > > + If String is NULL, then ASSERT(). > > + > > + If Address is NULL, then ASSERT(). > > + > > + If String is not aligned in a 16-bit boundary, then ASSERT(). > > + > > + If PcdMaximumUnicodeStringLength is not zero, and String contains > > + more > > than > > + PcdMaximumUnicodeStringLength Unicode characters, not including the > > + Null-terminator, then ASSERT(). > > + > > + If EndPointer is not NULL and Address is translated from String, a > > + pointer to the character that stopped the scan is stored at the > > + location pointed to by EndPointer. > > + > > + @param String Pointer to a Null-terminated Unicod= e > > string. > > + @param EndPointer Pointer to character that stops sca= n. > > + @param Address Pointer to the converted IPv4 > > address. > > + @param PrefixLength Pointer to the converted IPv4 addre= ss > > prefix > > + length. MAX_UINT8 is returned when > > /P is > > + not in the String. > > + > > + @retval RETURN_SUCCESS Address is translated from String. > > + @retval RETURN_INVALID_PARAMETER If String is NULL. > > + If Data is NULL. > > + If PcdMaximumUnicodeStringLength > > + is > > not > > + zero, and String contains more tha= n > > + PcdMaximumUnicodeStringLength > > Unicode > > + characters, not including the > > + Null-terminator. > > + If String is not in the correct for= mat. > > + If any decimal number converted > > + from > > D > > + exceeds 255. > > + If the decimal number converted > > + from > > P > > + exceeds 32. > > + > > +**/ > > +RETURN_STATUS > > +EFIAPI > > +StrToIpv4Address ( > > + IN CONST CHAR16 *String, > > + OUT CHAR16 **EndPointer, OPTIONAL > > + OUT IPv4_ADDRESS *Address, > > + OUT UINT8 *PrefixLength OPTIONAL > > + ) > > +{ > > + RETURN_STATUS Status; > > + UINTN AddressIndex; > > + UINTN Uintn; > > + IPv4_ADDRESS LocalAddress; > > + UINT8 LocalPrefixLength; > > + CHAR16 *Pointer; > > + > > + LocalPrefixLength =3D MAX_UINT8; > > + > > + ASSERT (((UINTN) String & BIT0) =3D=3D 0); > > + > > + // > > + // 1. None of String or Guid shall be a null pointer. > > + // > > + SAFE_STRING_CONSTRAINT_CHECK ((String !=3D NULL), > > RETURN_INVALID_PARAMETER); > > + SAFE_STRING_CONSTRAINT_CHECK ((Address !=3D NULL), > > RETURN_INVALID_PARAMETER); > > + > > + for (Pointer =3D (CHAR16 *) String, AddressIndex =3D 0; AddressIndex= < > > ARRAY_SIZE (Address->Addr) + 1;) { > > + if (!InternalIsDecimalDigitCharacter (*Pointer)) { > > + // > > + // D or P contains invalid characters. > > + // > > + break; > > + } > > + > > + // > > + // Get D or P. > > + // > > + Status =3D StrDecimalToUintnS ((CONST CHAR16 *) Pointer, &Pointer, > > &Uintn); > > + if (RETURN_ERROR (Status)) { > > + return RETURN_INVALID_PARAMETER; > > + } > > + if (AddressIndex =3D=3D ARRAY_SIZE (Address->Addr)) { > > + // > > + // It's P. > > + // > > + if (Uintn > 32) { > > + return RETURN_INVALID_PARAMETER; > > + } > > + LocalPrefixLength =3D (UINT8) Uintn; > > + } else { > > + // > > + // It's D. > > + // > > + if (Uintn > MAX_UINT8) { > > + return RETURN_INVALID_PARAMETER; > > + } > > + LocalAddress.Addr[AddressIndex] =3D (UINT8) Uintn; > > + AddressIndex++; > > + } > > + > > + // > > + // Check the '.' or '/', depending on the AddressIndex. > > + // > > + if (AddressIndex =3D=3D ARRAY_SIZE (Address->Addr)) { > > + if (*Pointer =3D=3D L'/') { > > + // > > + // '/P' is in the String. > > + // Skip "/" and get P in next loop. > > + // > > + Pointer++; > > + } else { > > + // > > + // '/P' is not in the String. > > + // > > + break; > > + } > > + } else if (AddressIndex < ARRAY_SIZE (Address->Addr)) { > > + if (*Pointer =3D=3D L'.') { > > + // > > + // D should be followed by '.' > > + // > > + Pointer++; > > + } else { > > + return RETURN_INVALID_PARAMETER; > > + } > > + } > > + } > > + > > + if (AddressIndex < ARRAY_SIZE (Address->Addr)) { > > + return RETURN_INVALID_PARAMETER; > > + } > > + > > + CopyMem (Address, &LocalAddress, sizeof (*Address)); if > > + (PrefixLength !=3D NULL) { > > + *PrefixLength =3D LocalPrefixLength; } if (EndPointer !=3D NULL)= { > > + *EndPointer =3D Pointer; > > + } > > + > > + return RETURN_SUCCESS; > > +} > > + > > +/** > > + Convert a Null-terminated Unicode GUID string to a value of type > > + EFI_GUID. > > + > > + This function outputs a GUID value by interpreting the contents of > > + the Unicode string specified by String. The format of the input > > + Unicode string String consists of 36 characters, as follows: > > + > > + aabbccdd-eeff-gghh-iijj-kkllmmnnoopp > > + > > + The pairs aa - pp are two characters in the range [0-9], [a-f] and > > + [A-F], with each pair representing a single byte hexadecimal value. > > + > > + The mapping between String and the EFI_GUID structure is as follows: > > + aa Data1[24:31] > > + bb Data1[16:23] > > + cc Data1[8:15] > > + dd Data1[0:7] > > + ee Data2[8:15] > > + ff Data2[0:7] > > + gg Data3[8:15] > > + hh Data3[0:7] > > + ii Data4[0:7] > > + jj Data4[8:15] > > + kk Data4[16:23] > > + ll Data4[24:31] > > + mm Data4[32:39] > > + nn Data4[40:47] > > + oo Data4[48:55] > > + pp Data4[56:63] > > + > > + If String is NULL, then ASSERT(). > > + If Guid is NULL, then ASSERT(). > > + If String is not aligned in a 16-bit boundary, then ASSERT(). > > + > > + @param String Pointer to a Null-terminated Unicod= e > > string. > > + @param Guid Pointer to the converted GUID. > > + > > + @retval RETURN_SUCCESS Guid is translated from String. > > + @retval RETURN_INVALID_PARAMETER If String is NULL. > > + If Data is NULL. > > + If String is not as the above forma= t. > > + > > +**/ > > +RETURN_STATUS > > +EFIAPI > > +StrToGuid ( > > + IN CONST CHAR16 *String, > > + OUT GUID *Guid > > + ) > > +{ > > + RETURN_STATUS Status; > > + GUID LocalGuid; > > + > > + ASSERT (((UINTN) String & BIT0) =3D=3D 0); > > + > > + // > > + // 1. None of String or Guid shall be a null pointer. > > + // > > + SAFE_STRING_CONSTRAINT_CHECK ((String !=3D NULL), > > RETURN_INVALID_PARAMETER); > > + SAFE_STRING_CONSTRAINT_CHECK ((Guid !=3D NULL), > > RETURN_INVALID_PARAMETER); > > + > > + // > > + // Get aabbccdd in big-endian. > > + // > > + Status =3D StrHexToBytes (String, 2 * sizeof (LocalGuid.Data1), > > + (UINT8 *) > > &LocalGuid.Data1, sizeof (LocalGuid.Data1)); > > + if (RETURN_ERROR (Status) || String[2 * sizeof (LocalGuid.Data1)] != =3D L'-') { > > + return RETURN_INVALID_PARAMETER; > > + } > > + // > > + // Convert big-endian to little-endian. > > + // > > + LocalGuid.Data1 =3D SwapBytes32 (LocalGuid.Data1); String +=3D 2 * > > + sizeof (LocalGuid.Data1) + 1; > > + > > + // > > + // Get eeff in big-endian. > > + // > > + Status =3D StrHexToBytes (String, 2 * sizeof (LocalGuid.Data2), > > + (UINT8 *) > > &LocalGuid.Data2, sizeof (LocalGuid.Data2)); > > + if (RETURN_ERROR (Status) || String[2 * sizeof (LocalGuid.Data2)] != =3D L'-') { > > + return RETURN_INVALID_PARAMETER; > > + } > > + // > > + // Convert big-endian to little-endian. > > + // > > + LocalGuid.Data2 =3D SwapBytes16 (LocalGuid.Data2); String +=3D 2 * > > + sizeof (LocalGuid.Data2) + 1; > > + > > + // > > + // Get gghh in big-endian. > > + // > > + Status =3D StrHexToBytes (String, 2 * sizeof (LocalGuid.Data3), > > + (UINT8 *) > > &LocalGuid.Data3, sizeof (LocalGuid.Data3)); > > + if (RETURN_ERROR (Status) || String[2 * sizeof (LocalGuid.Data3)] != =3D L'-') { > > + return RETURN_INVALID_PARAMETER; > > + } > > + // > > + // Convert big-endian to little-endian. > > + // > > + LocalGuid.Data3 =3D SwapBytes16 (LocalGuid.Data3); String +=3D 2 * > > + sizeof (LocalGuid.Data3) + 1; > > + > > + // > > + // Get iijj. > > + // > > + Status =3D StrHexToBytes (String, 2 * 2, &LocalGuid.Data4[0], 2); i= f > > + (RETURN_ERROR (Status) || String[2 * 2] !=3D L'-') { > > + return RETURN_INVALID_PARAMETER; > > + } > > + String +=3D 2 * 2 + 1; > > + > > + // > > + // Get kkllmmnnoopp. > > + // > > + Status =3D StrHexToBytes (String, 2 * 6, &LocalGuid.Data4[2], 6); i= f > > + (RETURN_ERROR (Status)) { > > + return RETURN_INVALID_PARAMETER; > > + } > > + > > + CopyGuid (Guid, &LocalGuid); > > + return RETURN_SUCCESS; > > +} > > + > > +/** > > + Convert a Null-terminated Unicode hexadecimal string to a byte array= . > > + > > + This function outputs a byte array by interpreting the contents of > > + the Unicode string specified by String in hexadecimal format. The > > + format of the input Unicode string String is: > > + > > + [XX]* > > + > > + X is a hexadecimal digit character in the range [0-9], [a-f] and [A-= F]. > > + The function decodes every two hexadecimal digit characters as one b= yte. > > The > > + decoding stops after Length of characters and outputs Buffer > > + containing (Length / 2) bytes. > > + > > + If String is not aligned in a 16-bit boundary, then ASSERT(). > > + > > + If String is NULL, then ASSERT(). > > + > > + If Buffer is NULL, then ASSERT(). > > + > > + If Length is not multiple of 2, then ASSERT(). > > + > > + If PcdMaximumStringLength is not zero and Length is greater than > > + PcdMaximumAsciiStringLength, then ASSERT(). > > + > > + If MaxBufferSize is less than (Length / 2), then ASSERT(). > > + > > + @param String Pointer to a Null-terminated Unicod= e > > string. > > + @param Length The number of Unicode characters to > > decode. > > + @param Buffer Pointer to the converted bytes arra= y. > > + @param MaxBufferSize The maximum size of Buffer. > > + > > + @retval RETURN_SUCCESS Buffer is translated from String. > > + @retval RETURN_INVALID_PARAMETER If String is NULL. > > + If Data is NULL. > > + If Length is not multiple of 2. > > + If PcdMaximumStringLength is not > > zero, > > + and Length is greater than > > + PcdMaximumAsciiStringLength. > > + If Length of characters from > > + String > > contain > > + a character that is not valid > > hexadecimal > > + digit characters, or a Null-termin= ator. > > + @retval RETURN_BUFFER_TOO_SMALL If MaxBufferSize is less than > > (Length / 2). > > +**/ > > +RETURN_STATUS > > +EFIAPI > > +StrHexToBytes ( > > + IN CONST CHAR16 *String, > > + IN UINTN Length, > > + OUT UINT8 *Buffer, > > + IN UINTN MaxBufferSize > > + ) > > +{ > > + UINTN Index; > > + > > + ASSERT (((UINTN) String & BIT0) =3D=3D 0); > > + > > + // > > + // 1. None of String or Buffer shall be a null pointer. > > + // > > + SAFE_STRING_CONSTRAINT_CHECK ((String !=3D NULL), > > RETURN_INVALID_PARAMETER); > > + SAFE_STRING_CONSTRAINT_CHECK ((Buffer !=3D NULL), > > RETURN_INVALID_PARAMETER); > > + > > + // > > + // 2. Length shall not be greater than RSIZE_MAX. > > + // > > + if (RSIZE_MAX !=3D 0) { > > + SAFE_STRING_CONSTRAINT_CHECK ((Length <=3D RSIZE_MAX), > > RETURN_INVALID_PARAMETER); > > + } > > + > > + // > > + // 3. Length shall not be odd. > > + // > > + SAFE_STRING_CONSTRAINT_CHECK (((Length & BIT0) =3D=3D 0), > > RETURN_INVALID_PARAMETER); > > + > > + // > > + // 4. MaxBufferSize shall equal to or greater than Length / 2. > > + // > > + SAFE_STRING_CONSTRAINT_CHECK ((MaxBufferSize >=3D Length / 2), > > RETURN_BUFFER_TOO_SMALL); > > + > > + // > > + // 5. String shall not contains invalid hexadecimal digits. > > + // > > + for (Index =3D 0; Index < Length; Index++) { > > + if (!InternalIsHexaDecimalDigitCharacter (String[Index])) { > > + break; > > + } > > + } > > + if (Index !=3D Length) { > > + return RETURN_INVALID_PARAMETER; > > + } > > + > > + // > > + // Convert the hex string to bytes. > > + // > > + for(Index =3D 0; Index < Length; Index++) { > > + > > + // > > + // For even characters, write the upper nibble for each buffer byt= e, > > + // and for even characters, the lower nibble. > > + // > > + if ((Index & BIT0) =3D=3D 0) { > > + Buffer[Index / 2] =3D (UINT8) InternalHexCharToUintn > > + (String[Index]) << > > 4; > > + } else { > > + Buffer[Index / 2] |=3D (UINT8) InternalHexCharToUintn (String[In= dex]); > > + } > > + } > > + return RETURN_SUCCESS; > > +} > > + > > +/** > > Returns the length of a Null-terminated Ascii string. > > > > This function is similar as strlen_s defined in C11. > > -- > > 2.9.0.windows.1