<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; line-break: after-white-space;" class="">Mike, Bret,<div class=""> </div><div class="">The assertion in UnicodeStrnToAsciiStrS is currently not a runtime check but a precondition. I.e. the function does not work with such sequences.</div><div class=""> </div><div class="">I fully agree that it is not right, and that we should actually update the documentation and change it to the following construction (0x80 instead of 0x100 for 7-bit ASCII and ‘?’ for invalid patch): </div><div class=""> </div><div class="">if (*Source < 0x80) {</div><div class=""> *(Destination++) = (CHAR8) *(Source++);</div><div class="">} else {</div><div class=""> *(Destination++) = ‘?';</div><div class="">}</div><div class=""> </div><div class="">However, it has to be out of the scope of this patch due to the nature of the change: function behaviour change for RELEASE instead of assertion removal for the runtime check as for all the rest. Should file a bugzilla as well.</div><div class=""> </div><div class="">As for alignment, I believe Marvin explained it well, and I have nothing to add there. There is no need to change the patch anyhow.</div><div class=""> </div><div class="">Best wishes,</div><div class="">Vitaly</div><div class=""> </div><div class=""><div><blockquote type="cite" class=""><div class="">15 мая 2020 г., в 01:14, Kinney, Michael D <<a href="mailto:michael.d.kinney@intel.com" class="">michael.d.kinney@intel.com</a>> написал(а):</div> <div class=""><div class="WordSection1" style="page: WordSection1; caret-color: rgb(0, 0, 0); font-family: Helvetica; font-size: 12px; font-style: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration: none;"><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Bret,<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">I agree with all your points. Which is why I am asking if we should address this in the current patch under review.<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">I will also point out that another way to get an off pointer address value for a CHAR16 is through use of packed structures. If a CHAR16 string is in a packaged structure and starts at an odd byte offset, then directly passing the CHAR16 string field to one of these APIs will ASSERT() or generate an exception if the ASSERT()s are removed. When using packed structures, fields that are larger than 1-byte need to either be copied to an aligned location or accessed using the Unaligned Read/Write APIs.<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Mike<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div class=""><div style="border-style: solid none none; border-top-width: 1pt; border-top-color: rgb(225, 225, 225); padding: 3pt 0in 0in;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">From: <a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a> <<a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a>> On Behalf Of Bret Barkelew via <a href="http://groups.io/" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">groups.io</a> Sent: Thursday, May 14, 2020 2:15 PM To: <a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a>; Kinney, Michael D <<a href="mailto:michael.d.kinney@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">michael.d.kinney@intel.com</a>>; <a href="mailto:cheptsov@ispras.ru" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">cheptsov@ispras.ru</a> Cc: Andrew Fish <<a href="mailto:afish@apple.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">afish@apple.com</a>>; Ard Biesheuvel <<a href="mailto:ard.biesheuvel@linaro.org" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">ard.biesheuvel@linaro.org</a>>; Brian J . Johnson <<a href="mailto:brian.johnson@hpe.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">brian.johnson@hpe.com</a>>; Chiu, Chasel <<a href="mailto:chasel.chiu@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">chasel.chiu@intel.com</a>>; Justen, Jordan L <<a href="mailto:jordan.l.justen@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">jordan.l.justen@intel.com</a>>; Laszlo Ersek <<a href="mailto:lersek@redhat.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">lersek@redhat.com</a>>; Leif Lindholm <<a href="mailto:leif@nuviainc.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">leif@nuviainc.com</a>>; Gao, Liming <<a href="mailto:liming.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">liming.gao@intel.com</a>>; Marvin Häuser <<a href="mailto:mhaeuser@outlook.de" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">mhaeuser@outlook.de</a>>; Zimmer, Vincent <<a href="mailto:vincent.zimmer@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">vincent.zimmer@intel.com</a>>; Gao, Zhichao <<a href="mailto:zhichao.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">zhichao.gao@intel.com</a>> Subject: Re: [EXTERNAL] Re: [edk2-devel] [PATCH V6 1/1] MdePkg: Fix SafeString performing assertions on runtime checks<o:p class=""></o:p></div></div></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Why isn’t that a failed return value?<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">That would be unexpected behavior in RELEASE.<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Either that, or the function should take in a substitution character (e.g. ‘?’) for invalid characters.<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">The prototype of this function is bad if it doesn’t allow for this possibility, and an ASSERT isn’t making code any better/safer by only ASSERTing.<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">- Bret<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="border-style: solid none none; border-top-width: 1pt; border-top-color: rgb(225, 225, 225); padding: 3pt 0in 0in;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">From: <a href="mailto:michael.d.kinney=intel.com@groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Michael D Kinney via groups.io</a> Sent: Thursday, May 14, 2020 2:07 PM To: <a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a>; <a href="mailto:cheptsov@ispras.ru" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">cheptsov@ispras.ru</a>; <a href="mailto:michael.d.kinney@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Kinney, Michael D</a> Cc: <a href="mailto:afish@apple.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Andrew Fish</a>; <a href="mailto:ard.biesheuvel@linaro.org" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Ard Biesheuvel</a>; <a href="mailto:Bret.Barkelew@microsoft.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Bret Barkelew</a>; <a href="mailto:brian.johnson@hpe.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Brian J . Johnson</a>; <a href="mailto:chasel.chiu@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Chiu, Chasel</a>; <a href="mailto:jordan.l.justen@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Justen, Jordan L</a>; <a href="mailto:lersek@redhat.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Laszlo Ersek</a>; <a href="mailto:leif@nuviainc.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Leif Lindholm</a>; <a href="mailto:liming.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">liming.gao</a>; <a href="mailto:mhaeuser@outlook.de" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Marvin Häuser</a>; <a href="mailto:vincent.zimmer@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Zimmer, Vincent</a>; <a href="mailto:zhichao.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">Gao, Zhichao</a> Subject: [EXTERNAL] Re: [edk2-devel] [PATCH V6 1/1] MdePkg: Fix SafeString performing assertions on runtime checks<o:p class=""></o:p></div></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Hi Vitaly,<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">What about this ASSERT() in UnicodeStrnToAsciiStrS(). It is an ASSERT() on the data contents.<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> //<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> // Convert string<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> //<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> while ((*Source != 0) && (SourceLen > 0)) {<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> //<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> // If any Unicode characters in Source contain non-zero value in the upper<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> // 8 bits, then ASSERT().<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> //<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> ASSERT (*Source < 0x100);<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> *(Destination++) = (CHAR8) *(Source++);<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> SourceLen--;<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> (*DestinationLength)++;<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> }<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> *Destination = 0;<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Mike<o:p class=""></o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div class=""><div style="border-style: solid none none; border-top-width: 1pt; border-top-color: rgb(225, 225, 225); padding: 3pt 0in 0in;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">From: <a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a> <<a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a>> On Behalf Of Vitaly Cheptsov Sent: Thursday, May 14, 2020 11:59 AM To: Kinney, Michael D <<a href="mailto:michael.d.kinney@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">michael.d.kinney@intel.com</a>> Cc: <a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a>; Andrew Fish <<a href="mailto:afish@apple.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">afish@apple.com</a>>; Ard Biesheuvel <<a href="mailto:ard.biesheuvel@linaro.org" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">ard.biesheuvel@linaro.org</a>>; Bret Barkelew <<a href="mailto:bret.barkelew@microsoft.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">bret.barkelew@microsoft.com</a>>; Brian J . Johnson <<a href="mailto:brian.johnson@hpe.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">brian.johnson@hpe.com</a>>; Chiu, Chasel <<a href="mailto:chasel.chiu@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">chasel.chiu@intel.com</a>>; Justen, Jordan L <<a href="mailto:jordan.l.justen@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">jordan.l.justen@intel.com</a>>; Laszlo Ersek <<a href="mailto:lersek@redhat.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">lersek@redhat.com</a>>; Leif Lindholm <<a href="mailto:leif@nuviainc.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">leif@nuviainc.com</a>>; Gao, Liming <<a href="mailto:liming.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">liming.gao@intel.com</a>>; Marvin Häuser <<a href="mailto:mhaeuser@outlook.de" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">mhaeuser@outlook.de</a>>; Zimmer, Vincent <<a href="mailto:vincent.zimmer@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">vincent.zimmer@intel.com</a>>; Gao, Zhichao <<a href="mailto:zhichao.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">zhichao.gao@intel.com</a>> Subject: Re: [edk2-devel] [PATCH V6 1/1] MdePkg: Fix SafeString performing assertions on runtime checks<o:p class=""></o:p></div></div></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Mike,<o:p class=""></o:p></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">The code you posted may inflict undefined behaviour is not valid C for several reasons. The compiler is free to do whatever it desires. Please refer to ISO/IEC 9899 for more details.<o:p class=""></o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">If applications cast raw pointers to typed pointers without checking their alignment, well, god bless them :)<o:p class=""></o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">My opinion is both the compiler and the hardware are welcome to do the worst once your third line is discovered. On a number of CPUs such addresses cannot be even represented in the first place.<o:p class=""></o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Yet, once again it is out of the scope of the current problem.<o:p class=""></o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Best wishes,<o:p class=""></o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Vitaly<o:p class=""></o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div></div><div class=""><div class=""><o:p class=""> </o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">14 мая 2020 г., в 20:58, Kinney, Michael D <<a href="mailto:michael.d.kinney@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">michael.d.kinney@intel.com</a>> написал(а):<o:p class=""></o:p></div></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div><div class="">Vitaly, Why do you think there is no way to craft an odd address without memory corruption. UINT8 ByteArray[100]; CHAR16 *String String = (CHAR16 *)(&Array[3]); The reason I raised the question of these other ASSERT()s is that I thought the use case was using these safe string APIs from a UEFI App, and the UEFI App always wants to evaluate the return status to know if the operation was completed or not. In build that removes all ASSERT()s, an odd address will generate an exception on some CPU archs. Wouldn’t it be better for the UEFI App that is already designed to handle error return status to get an error code instead of an exception? Mike <o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class="">-----Original Message----- From: <a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a> <<a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a>> On Behalf Of Vitaly Cheptsov Sent: Thursday, May 14, 2020 10:39 AM To: Kinney, Michael D <<a href="mailto:michael.d.kinney@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">michael.d.kinney@intel.com</a>> Cc: <a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a>; Andrew Fish <<a href="mailto:afish@apple.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">afish@apple.com</a>>; Ard Biesheuvel <<a href="mailto:ard.biesheuvel@linaro.org" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">ard.biesheuvel@linaro.org</a>>; Bret Barkelew <<a href="mailto:bret.barkelew@microsoft.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">bret.barkelew@microsoft.com</a>>; Brian J . Johnson <<a href="mailto:brian.johnson@hpe.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">brian.johnson@hpe.com</a>>; Chiu, Chasel <<a href="mailto:chasel.chiu@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">chasel.chiu@intel.com</a>>; Justen, Jordan L <<a href="mailto:jordan.l.justen@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">jordan.l.justen@intel.com</a>>; Laszlo Ersek <<a href="mailto:lersek@redhat.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">lersek@redhat.com</a>>; Leif Lindholm <<a href="mailto:leif@nuviainc.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">leif@nuviainc.com</a>>; Gao, Liming <<a href="mailto:liming.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">liming.gao@intel.com</a>>; Marvin Häuser <<a href="mailto:mhaeuser@outlook.de" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">mhaeuser@outlook.de</a>>; Zimmer, Vincent <<a href="mailto:vincent.zimmer@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">vincent.zimmer@intel.com</a>>; Gao, Zhichao <<a href="mailto:zhichao.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">zhichao.gao@intel.com</a>> Subject: Re: [edk2-devel] [PATCH V6 1/1] MdePkg: Fix SafeString performing assertions on runtime checks Mike, Firstly, NULL check and odd-address checks are essentially different things: — NULL address is basically «no object», «optional argument» (e.g. failed allocation). — Odd address is memory corruption, as there is no way to craft such address anyhow else. For this reason the implementation is allowed to treat them differently. Secondly, as I said in my cover letter there is no behaviour change here for RELEASE builds. Behaviour changes unrelated to the bugfix will have to go to a separate patch. I agree that we may want to reconsider the interface in the future, but that’s for a separate bugzilla and patch. Not discussing it currently is important to avoid diverting from the primary problem. Could create a bugzilla not to forget about it soon after the stable tag. Best wishes, Vitaly <o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">14 мая 2020 г., в 19:38, Kinney, Michael D<o:p class=""></o:p></div></blockquote><<a href="mailto:michael.d.kinney@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">michael.d.kinney@intel.com</a>> написал(а):<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> Why preserve the ASSERT()s for an a Unicode strings that are not aligned in a 16-bit boundary? This is essentially the same as an invalid pointer<o:p class=""></o:p></div></blockquote>value<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">just like NULL. If NULL pointer returns an error<o:p class=""></o:p></div></blockquote>code,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class="">shouldn't and invalid pointer value? Thanks, Mike <o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">-----Original Message----- From: <a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a> <<a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a>> On Behalf Of Vitaly Cheptsov Sent: Thursday, May 14, 2020 2:26 AM To: <a href="mailto:devel@edk2.groups.io" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">devel@edk2.groups.io</a> Cc: Andrew Fish <<a href="mailto:afish@apple.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">afish@apple.com</a>>; Ard Biesheuvel <<a href="mailto:ard.biesheuvel@linaro.org" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">ard.biesheuvel@linaro.org</a>>; Bret Barkelew <<a href="mailto:bret.barkelew@microsoft.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">bret.barkelew@microsoft.com</a>>; Brian J . Johnson <<a href="mailto:brian.johnson@hpe.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">brian.johnson@hpe.com</a>>; Chiu, Chasel <<a href="mailto:chasel.chiu@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">chasel.chiu@intel.com</a>>; Justen, Jordan L <<a href="mailto:jordan.l.justen@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">jordan.l.justen@intel.com</a>>; Laszlo Ersek <<a href="mailto:lersek@redhat.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">lersek@redhat.com</a>>; Leif Lindholm<o:p class=""></o:p></div></blockquote></blockquote><<a href="mailto:leif@nuviainc.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">leif@nuviainc.com</a>>;<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">Gao, Liming <<a href="mailto:liming.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">liming.gao@intel.com</a>>; Marvin Häuser <<a href="mailto:mhaeuser@outlook.de" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">mhaeuser@outlook.de</a>>; Kinney, Michael D <<a href="mailto:michael.d.kinney@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">michael.d.kinney@intel.com</a>>; Zimmer, Vincent <<a href="mailto:vincent.zimmer@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">vincent.zimmer@intel.com</a>>; Gao, Zhichao <<a href="mailto:zhichao.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">zhichao.gao@intel.com</a>> Subject: [edk2-devel] [PATCH V6 1/1] MdePkg: Fix SafeString performing assertions on runtime checks REF: <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2054&data=02%7C01%7CBret.Barkelew%40microsoft.com%7C854c0200e7ed412219a008d7f84ad4e5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637250872617792374&sdata=obXC2njAL18GchcPz1HyiGBSNcBYk8i2Q0ZhWDwICCQ%3D&reserved=0" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">https://bugzilla.tianocore.org/show_bug.cgi?id=2054</a> Runtime checks returned via status return code<o:p class=""></o:p></div></blockquote></blockquote>should<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">not work as assertions to permit parsing not trusted data with SafeString interfaces. CC: Andrew Fish <<a href="mailto:afish@apple.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">afish@apple.com</a>> CC: Ard Biesheuvel <<a href="mailto:ard.biesheuvel@linaro.org" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">ard.biesheuvel@linaro.org</a>> CC: Bret Barkelew <<a href="mailto:bret.barkelew@microsoft.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">bret.barkelew@microsoft.com</a>> CC: Brian J. Johnson <<a href="mailto:brian.johnson@hpe.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">brian.johnson@hpe.com</a>> CC: Chasel Chiu <<a href="mailto:chasel.chiu@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">chasel.chiu@intel.com</a>> CC: Jordan Justen <<a href="mailto:jordan.l.justen@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">jordan.l.justen@intel.com</a>> CC: Laszlo Ersek <<a href="mailto:lersek@redhat.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">lersek@redhat.com</a>> CC: Leif Lindholm <<a href="mailto:leif@nuviainc.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">leif@nuviainc.com</a>> CC: Liming Gao <<a href="mailto:liming.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">liming.gao@intel.com</a>> CC: Marvin Häuser <<a href="mailto:mhaeuser@outlook.de" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">mhaeuser@outlook.de</a>> CC: Mike Kinney <<a href="mailto:michael.d.kinney@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">michael.d.kinney@intel.com</a>> CC: Vincent Zimmer <<a href="mailto:vincent.zimmer@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">vincent.zimmer@intel.com</a>> CC: Zhichao Gao <<a href="mailto:zhichao.gao@intel.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">zhichao.gao@intel.com</a>> Signed-off-by: Vitaly Cheptsov<o:p class=""></o:p></div></blockquote></blockquote><<a href="mailto:vit9696@protonmail.com" style="color: rgb(149, 79, 114); text-decoration: underline;" class="">vit9696@protonmail.com</a>><o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> --- MdePkg/Include/Library/BaseLib.h | 120 ++--------<o:p class=""></o:p></div></blockquote></blockquote>--<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">-------- MdePkg/Library/BaseLib/SafeString.c | 80 ----------<o:p class=""></o:p></div></blockquote></blockquote>--<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">- 2 files changed, 7 insertions(+), 193 deletions(-) diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h index ecadff8b23..62dc3151bc 100644 --- a/MdePkg/Include/Library/BaseLib.h +++ b/MdePkg/Include/Library/BaseLib.h @@ -189,7 +189,6 @@ StrnSizeS ( If Destination is not aligned on a 16-bit<o:p class=""></o:p></div></blockquote></blockquote>boundary,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -225,7 +224,6 @@ StrCpyS ( If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT(). If Length > 0 and Source is not aligned on a 16-<o:p class=""></o:p></div></blockquote></blockquote>bit<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">boundary, then ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -263,7 +261,6 @@ StrnCpyS ( If Destination is not aligned on a 16-bit<o:p class=""></o:p></div></blockquote></blockquote>boundary,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -303,7 +300,6 @@ StrCatS ( If Destination is not aligned on a 16-bit<o:p class=""></o:p></div></blockquote></blockquote>boundary,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -350,12 +346,7 @@ StrnCatS ( be ignored. Then, the function stops at the first character that is a not a valid decimal character or a Null-terminator, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). If String is not aligned in a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and String contains more than - PcdMaximumUnicodeStringLength Unicode characters, not including the - Null-terminator, then ASSERT(). If String has no valid decimal digits in the above format, then 0 is stored at the location pointed to by Data. @@ -406,12 +397,7 @@ StrDecimalToUintnS ( be ignored. Then, the function stops at the first character that is a not a valid decimal character or a Null-terminator, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). If String is not aligned in a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and String contains more than - PcdMaximumUnicodeStringLength Unicode characters, not including the - Null-terminator, then ASSERT(). If String has no valid decimal digits in the above format, then 0 is stored at the location pointed to by Data. @@ -467,12 +453,7 @@ StrDecimalToUint64S ( the first character that is a not a valid hexadecimal character or NULL, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). If String is not aligned in a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and String contains more than - PcdMaximumUnicodeStringLength Unicode characters, not including the - Null-terminator, then ASSERT(). If String has no valid hexadecimal digits in the above format, then 0 is stored at the location pointed to by Data. @@ -528,12 +509,7 @@ StrHexToUintnS ( the first character that is a not a valid hexadecimal character or NULL, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). If String is not aligned in a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and String contains more than - PcdMaximumUnicodeStringLength Unicode characters, not including the - Null-terminator, then ASSERT(). If String has no valid hexadecimal digits in the above format, then 0 is stored at the location pointed to by Data. @@ -622,8 +598,6 @@ AsciiStrnSizeS ( This function is similar as strcpy_s defined in<o:p class=""></o:p></div></blockquote></blockquote>C11.<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> - If an error would be returned, then the function will also ASSERT(). - If an error is returned, then the Destination is unmodified. @param Destination A pointer to a Null-terminated Ascii string. @@ -656,8 +630,6 @@ AsciiStrCpyS ( This function is similar as strncpy_s defined in C11. - If an error would be returned, then the function will also ASSERT(). - If an error is returned, then the Destination is unmodified. @param Destination A pointer to a Null-terminated Ascii string. @@ -692,8 +664,6 @@ AsciiStrnCpyS ( This function is similar as strcat_s defined in<o:p class=""></o:p></div></blockquote></blockquote>C11.<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> - If an error would be returned, then the function will also ASSERT(). - If an error is returned, then the Destination is unmodified. @param Destination A pointer to a Null-terminated Ascii string. @@ -730,8 +700,6 @@ AsciiStrCatS ( This function is similar as strncat_s defined in C11. - If an error would be returned, then the function will also ASSERT(). - If an error is returned, then the Destination is unmodified. @param Destination A pointer to a Null-terminated Ascii string. @@ -777,12 +745,6 @@ AsciiStrnCatS ( be ignored. Then, the function stops at the first character that is a not a valid decimal character or a Null-terminator, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and String contains more than - PcdMaximumAsciiStringLength Ascii characters, not including the - Null-terminator, then ASSERT(). - If String has no valid decimal digits in the above format, then 0 is stored at the location pointed to by Data. If the number represented by String exceeds the range defined by UINTN, then @@ -832,12 +794,6 @@ AsciiStrDecimalToUintnS ( be ignored. Then, the function stops at the first character that is a not a valid decimal character or a Null-terminator, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and String contains more than - PcdMaximumAsciiStringLength Ascii characters, not including the - Null-terminator, then ASSERT(). - If String has no valid decimal digits in the above format, then 0 is stored at the location pointed to by Data. If the number represented by String exceeds the range defined by UINT64, then @@ -891,12 +847,6 @@ AsciiStrDecimalToUint64S ( character that is a not a valid hexadecimal character or Null-terminator, whichever on comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and String contains more than - PcdMaximumAsciiStringLength Ascii characters, not including the - Null-terminator, then ASSERT(). - If String has no valid hexadecimal digits in the above format, then 0 is stored at the location pointed to by Data. If the number represented by String exceeds the range defined by UINTN, then @@ -950,12 +900,6 @@ AsciiStrHexToUintnS ( character that is a not a valid hexadecimal character or Null-terminator, whichever on comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and String contains more than - PcdMaximumAsciiStringLength Ascii characters, not including the - Null-terminator, then ASSERT(). - If String has no valid hexadecimal digits in the above format, then 0 is stored at the location pointed to by Data. If the number represented by String exceeds the range defined by UINT64, then @@ -1506,16 +1450,8 @@ StrHexToUint64 ( "::" can be used to compress one or more groups of<o:p class=""></o:p></div></blockquote></blockquote>X<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">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,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">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<o:p class=""></o:p></div></blockquote></blockquote>translated<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">from String, a pointer to the character that stopped the scan is stored<o:p class=""></o:p></div></blockquote></blockquote>at<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">the location pointed to by EndPointer. @@ -1567,15 +1503,10 @@ StrToIpv6Address ( When /P is in the String, the function stops at<o:p class=""></o:p></div></blockquote></blockquote>the<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">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,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">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<o:p class=""></o:p></div></blockquote></blockquote>translated<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">from String, a pointer to the character that stopped the scan is stored<o:p class=""></o:p></div></blockquote></blockquote>at<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">the location pointed to @@ -1640,8 +1571,6 @@ StrToIpv4Address ( 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,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). @param String Pointer to a<o:p class=""></o:p></div></blockquote></blockquote>Null-<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">terminated Unicode string. @@ -1676,17 +1605,6 @@ StrToGuid ( If String is not aligned in a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If String is NULL, then ASSERT(). - - If Buffer is NULL, then ASSERT(). - - If Length is not multiple of 2, then ASSERT(). - - If PcdMaximumUnicodeStringLength is not zero and Length is greater than - PcdMaximumUnicodeStringLength, then ASSERT(). - - If MaxBufferSize is less than (Length / 2), then ASSERT(). - @param String Pointer to a<o:p class=""></o:p></div></blockquote></blockquote>Null-<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">terminated Unicode string. @param Length The number of Unicode characters to decode. @param Buffer Pointer to the converted bytes array. @@ -1777,7 +1695,6 @@ UnicodeStrToAsciiStr ( the upper 8 bits, then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -1818,22 +1735,23 @@ UnicodeStrToAsciiStrS ( bits of each Unicode character. The function terminates the Ascii string Destination by appending a Null-terminator<o:p class=""></o:p></div></blockquote></blockquote>character<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">at the end. - The caller is responsible to make sure<o:p class=""></o:p></div></blockquote></blockquote>Destination<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">points to a buffer with size - equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes. + The caller is responsible to make sure<o:p class=""></o:p></div></blockquote></blockquote>Destination<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">points to a buffer with + size not smaller than ((MIN(StrLen(Source),<o:p class=""></o:p></div></blockquote></blockquote>Length)<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">+ 1) * sizeof (CHAR8)) + in bytes. If any Unicode characters in Source contain non-<o:p class=""></o:p></div></blockquote></blockquote>zero<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">value in the upper 8 bits, then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). - If an error is returned, then the Destination is unmodified. + If an error is returned, then Destination and DestinationLength are + unmodified. @param Source The pointer to a Null- terminated Unicode string. @param Length The maximum number of Unicode characters to convert. @param Destination The pointer to a Null- terminated Ascii string. - @param DestMax The maximum number of Destination Ascii - char, including terminating null char. + @param DestMax The maximum number of Destination Ascii char, + including terminating null char. @param DestinationLength The number of Unicode characters converted. @retval RETURN_SUCCESS String is converted. @@ -2388,10 +2306,6 @@ AsciiStrHexToUint64 ( "::" can be used to compress one or more groups of<o:p class=""></o:p></div></blockquote></blockquote>X<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">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 EndPointer is not NULL and Address is<o:p class=""></o:p></div></blockquote></blockquote>translated<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">from String, a pointer to the character that stopped the scan is stored<o:p class=""></o:p></div></blockquote></blockquote>at<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">the location pointed to by EndPointer. @@ -2443,10 +2357,6 @@ AsciiStrToIpv6Address ( When /P is in the String, the function stops at<o:p class=""></o:p></div></blockquote></blockquote>the<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">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 EndPointer is not NULL and Address is<o:p class=""></o:p></div></blockquote></blockquote>translated<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">from String, a pointer to the character that stopped the scan is stored<o:p class=""></o:p></div></blockquote></blockquote>at<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">the location pointed to by EndPointer. @@ -2508,9 +2418,6 @@ AsciiStrToIpv4Address ( oo Data4[48:55] pp Data4[56:63] - If String is NULL, then ASSERT(). - If Guid is NULL, then ASSERT(). - @param String Pointer to a<o:p class=""></o:p></div></blockquote></blockquote>Null-<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">terminated ASCII string. @param Guid Pointer to the converted GUID. @@ -2541,17 +2448,6 @@ AsciiStrToGuid ( decoding stops after Length of characters and outputs Buffer containing (Length / 2) bytes. - If String is NULL, then ASSERT(). - - If Buffer is NULL, then ASSERT(). - - If Length is not multiple of 2, then ASSERT(). - - If PcdMaximumAsciiStringLength 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<o:p class=""></o:p></div></blockquote></blockquote>Null-<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">terminated ASCII string. @param Length The number of<o:p class=""></o:p></div></blockquote></blockquote>ASCII<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">characters to decode. @param Buffer Pointer to the converted bytes array. @@ -2632,7 +2528,6 @@ AsciiStrToUnicodeStr ( equal or greater than ((AsciiStrLen (Source) + 1)<o:p class=""></o:p></div></blockquote></blockquote>*<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">sizeof (CHAR16)) in bytes. If Destination is not aligned on a 16-bit<o:p class=""></o:p></div></blockquote></blockquote>boundary,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">then ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -2678,7 +2573,6 @@ AsciiStrToUnicodeStrS ( ((MIN(AsciiStrLen(Source), Length) + 1) * sizeof (CHAR8)) in bytes. If Destination is not aligned on a 16-bit<o:p class=""></o:p></div></blockquote></blockquote>boundary,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">then ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then Destination and DestinationLength are unmodified. diff --git a/MdePkg/Library/BaseLib/SafeString.c b/MdePkg/Library/BaseLib/SafeString.c index 7dc03d2caa..1db42abb05 100644 --- a/MdePkg/Library/BaseLib/SafeString.c +++ b/MdePkg/Library/BaseLib/SafeString.c @@ -14,7 +14,6 @@ #define SAFE_STRING_CONSTRAINT_CHECK(Expression, Status) \ do { \ - ASSERT (Expression); \ if (!(Expression)) { \ return Status; \ } \ @@ -197,7 +196,6 @@ StrnSizeS ( If Destination is not aligned on a 16-bit<o:p class=""></o:p></div></blockquote></blockquote>boundary,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -279,7 +277,6 @@ StrCpyS ( If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT(). If Length > 0 and Source is not aligned on a 16-<o:p class=""></o:p></div></blockquote></blockquote>bit<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">boundary, then ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -372,7 +369,6 @@ StrnCpyS ( If Destination is not aligned on a 16-bit<o:p class=""></o:p></div></blockquote></blockquote>boundary,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -473,7 +469,6 @@ StrCatS ( If Destination is not aligned on a 16-bit<o:p class=""></o:p></div></blockquote></blockquote>boundary,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -590,12 +585,7 @@ StrnCatS ( be ignored. Then, the function stops at the first character that is a not a valid decimal character or a Null-terminator, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). If String is not aligned in a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and String contains more than - PcdMaximumUnicodeStringLength Unicode characters, not including the - Null-terminator, then ASSERT(). If String has no valid decimal digits in the above format, then 0 is stored at the location pointed to by Data. @@ -705,12 +695,7 @@ StrDecimalToUintnS ( be ignored. Then, the function stops at the first character that is a not a valid decimal character or a Null-terminator, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). If String is not aligned in a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and String contains more than - PcdMaximumUnicodeStringLength Unicode characters, not including the - Null-terminator, then ASSERT(). If String has no valid decimal digits in the above format, then 0 is stored at the location pointed to by Data. @@ -825,12 +810,7 @@ StrDecimalToUint64S ( the first character that is a not a valid hexadecimal character or NULL, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). If String is not aligned in a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and String contains more than - PcdMaximumUnicodeStringLength Unicode characters, not including the - Null-terminator, then ASSERT(). If String has no valid hexadecimal digits in the above format, then 0 is stored at the location pointed to by Data. @@ -956,12 +936,7 @@ StrHexToUintnS ( the first character that is a not a valid hexadecimal character or NULL, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). If String is not aligned in a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If PcdMaximumUnicodeStringLength is not zero, and String contains more than - PcdMaximumUnicodeStringLength Unicode characters, not including the - Null-terminator, then ASSERT(). If String has no valid hexadecimal digits in the above format, then 0 is stored at the location pointed to by Data. @@ -1856,8 +1831,6 @@ AsciiStrCpyS ( This function is similar as strncpy_s defined in C11. - If an error would be returned, then the function will also ASSERT(). - If an error is returned, then the Destination is unmodified. @param Destination A pointer to a Null-terminated Ascii string. @@ -1944,8 +1917,6 @@ AsciiStrnCpyS ( This function is similar as strcat_s defined in<o:p class=""></o:p></div></blockquote></blockquote>C11.<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""> - If an error would be returned, then the function will also ASSERT(). - If an error is returned, then the Destination is unmodified. @param Destination A pointer to a Null-terminated Ascii string. @@ -2040,8 +2011,6 @@ AsciiStrCatS ( This function is similar as strncat_s defined in C11. - If an error would be returned, then the function will also ASSERT(). - If an error is returned, then the Destination is unmodified. @param Destination A pointer to a Null-terminated Ascii string. @@ -2154,12 +2123,6 @@ AsciiStrnCatS ( be ignored. Then, the function stops at the first character that is a not a valid decimal character or a Null-terminator, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and String contains more than - PcdMaximumAsciiStringLength Ascii characters, not including the - Null-terminator, then ASSERT(). - If String has no valid decimal digits in the above format, then 0 is stored at the location pointed to by Data. If the number represented by String exceeds the range defined by UINTN, then @@ -2266,12 +2229,6 @@ AsciiStrDecimalToUintnS ( be ignored. Then, the function stops at the first character that is a not a valid decimal character or a Null-terminator, whichever one comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and String contains more than - PcdMaximumAsciiStringLength Ascii characters, not including the - Null-terminator, then ASSERT(). - If String has no valid decimal digits in the above format, then 0 is stored at the location pointed to by Data. If the number represented by String exceeds the range defined by UINT64, then @@ -2382,12 +2339,6 @@ AsciiStrDecimalToUint64S ( character that is a not a valid hexadecimal character or Null-terminator, whichever on comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and String contains more than - PcdMaximumAsciiStringLength Ascii characters, not including the - Null-terminator, then ASSERT(). - If String has no valid hexadecimal digits in the above format, then 0 is stored at the location pointed to by Data. If the number represented by String exceeds the range defined by UINTN, then @@ -2509,12 +2460,6 @@ AsciiStrHexToUintnS ( character that is a not a valid hexadecimal character or Null-terminator, whichever on comes first. - If String is NULL, then ASSERT(). - If Data is NULL, then ASSERT(). - If PcdMaximumAsciiStringLength is not zero, and String contains more than - PcdMaximumAsciiStringLength Ascii characters, not including the - Null-terminator, then ASSERT(). - If String has no valid hexadecimal digits in the above format, then 0 is stored at the location pointed to by Data. If the number represented by String exceeds the range defined by UINT64, then @@ -2635,7 +2580,6 @@ AsciiStrHexToUint64S ( the upper 8 bits, then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then the Destination is unmodified. @@ -2735,7 +2679,6 @@ UnicodeStrToAsciiStrS ( If any Unicode characters in Source contain non-<o:p class=""></o:p></div></blockquote></blockquote>zero<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">value in the upper 8 bits, then ASSERT(). If Source is not aligned on a 16-bit boundary,<o:p class=""></o:p></div></blockquote></blockquote>then<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then Destination and DestinationLength are unmodified. @@ -2948,7 +2891,6 @@ AsciiStrToUnicodeStrS ( ((MIN(AsciiStrLen(Source), Length) + 1) * sizeof (CHAR8)) in bytes. If Destination is not aligned on a 16-bit<o:p class=""></o:p></div></blockquote></blockquote>boundary,<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">then ASSERT(). - If an error would be returned, then the function will also ASSERT(). If an error is returned, then Destination and DestinationLength are unmodified. @@ -3072,10 +3014,6 @@ AsciiStrnToUnicodeStrS ( "::" can be used to compress one or more groups of<o:p class=""></o:p></div></blockquote></blockquote>X<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">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 EndPointer is not NULL and Address is<o:p class=""></o:p></div></blockquote></blockquote>translated<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">from String, a pointer to the character that stopped the scan is stored<o:p class=""></o:p></div></blockquote></blockquote>at<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">the location pointed to by EndPointer. @@ -3291,10 +3229,6 @@ AsciiStrToIpv6Address ( When /P is in the String, the function stops at<o:p class=""></o:p></div></blockquote></blockquote>the<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">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 EndPointer is not NULL and Address is<o:p class=""></o:p></div></blockquote></blockquote>translated<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">from String, a pointer to the character that stopped the scan is stored<o:p class=""></o:p></div></blockquote></blockquote>at<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">the location pointed to by EndPointer. @@ -3448,9 +3382,6 @@ AsciiStrToIpv4Address ( oo Data4[48:55] pp Data4[56:63] - If String is NULL, then ASSERT(). - If Guid is NULL, then ASSERT(). - @param String Pointer to a<o:p class=""></o:p></div></blockquote></blockquote>Null-<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">terminated ASCII string. @param Guid Pointer to the converted GUID. @@ -3550,17 +3481,6 @@ AsciiStrToGuid ( decoding stops after Length of characters and outputs Buffer containing (Length / 2) bytes. - If String is NULL, then ASSERT(). - - If Buffer is NULL, then ASSERT(). - - If Length is not multiple of 2, then ASSERT(). - - If PcdMaximumAsciiStringLength 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<o:p class=""></o:p></div></blockquote></blockquote>Null-<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class="">terminated ASCII string. @param Length The number of<o:p class=""></o:p></div></blockquote></blockquote>ASCII<o:p class=""></o:p><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class=""><blockquote style="margin-top: 5pt; margin-bottom: 5pt;" class="">characters to decode. @param Buffer Pointer to the converted bytes array. -- 2.24.2 (Apple Git-127) <o:p class=""></o:p></blockquote><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div></blockquote><o:p class=""> </o:p></blockquote></div></blockquote></div><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""><o:p class=""> </o:p></div></div><div class=""><div style="margin: 0in 0in 0.0001pt; font-size: 11pt; font-family: Calibri, sans-serif;" class=""></o:p></div></div></div></div></blockquote></div> </div></body></html> <div width="1" style="color:white;clear:both">_._,_._,_</div> <hr> Groups.io Links: You receive all messages sent to this group. <a target="_blank" href="https://edk2.groups.io/g/devel/message/59669">View/Reply Online (#59669)</a> | | <a target="_blank" href="https://groups.io/mt/74223854/1813853">Mute This Topic</a> | <a href="https://edk2.groups.io/g/devel/post">New Topic</a> <a href="https://edk2.groups.io/g/devel/editsub/1813853">Your Subscription</a> | <a href="mailto:devel+owner@edk2.groups.io">Contact Group Owner</a> | <a href="https://edk2.groups.io/g/devel/unsub">Unsubscribe</a> [edk2-devel-archive@redhat.com] <div width="1" style="color:white;clear:both">_._,_._,_</div>