Re: [PATCH 1/4] MdePkg/BaseLib: Add safe string functions [Ascii]StrnSizeS

["Yao, Jiewen" <jiewen.yao@intel.com>]

Reviewed-by: jiewen.yao@intel.com

> -----Original Message-----
> From: Wu, Hao A
> Sent: Wednesday, January 4, 2017 7:23 PM
> To: edk2-devel@lists.01.org
> Cc: Wu, Hao A <hao.a.wu@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>;
> Gao, Liming <liming.gao@intel.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Subject: [PATCH 1/4] MdePkg/BaseLib: Add safe string functions [Ascii]StrnSizeS
> 
> Add StrnSizeS() and AsciiStrnSizeS() APIs.
> 
> These 2 safe version APIs are used to replace StrSize() and
> AsciiStrSize(). Those two APIs use similar checks as [Ascii]StrnLenS().
> 
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Michael Kinney <michael.d.kinney@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Hao Wu <hao.a.wu@intel.com>
> ---
>  MdePkg/Include/Library/BaseLib.h    | 56 ++++++++++++++++++++++-
>  MdePkg/Library/BaseLib/SafeString.c | 91
> ++++++++++++++++++++++++++++++++++++-
>  2 files changed, 145 insertions(+), 2 deletions(-)
> 
> diff --git a/MdePkg/Include/Library/BaseLib.h
> b/MdePkg/Include/Library/BaseLib.h
> index b69c703..72d1f0b 100644
> --- a/MdePkg/Include/Library/BaseLib.h
> +++ b/MdePkg/Include/Library/BaseLib.h
> @@ -2,7 +2,7 @@
>    Provides string functions, linked list functions, math functions,
> synchronization
>    functions, file path functions, and CPU architecture-specific functions.
> 
> -Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
> +Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
>  Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
>  This program and the accompanying materials
>  are licensed and made available under the terms and conditions of the BSD
> License
> @@ -208,6 +208,34 @@ StrnLenS (
>    );
> 
>  /**
> +  Returns the size of a Null-terminated Unicode string in bytes, including the
> +  Null terminator.
> +
> +  This function returns the size of the Null-terminated Unicode string
> +  specified by String in bytes, including the Null terminator.
> +
> +  If String is not aligned on a 16-bit boundary, then ASSERT().
> +
> +  @param  String   A pointer to a Null-terminated Unicode string.
> +  @param  MaxSize  The maximum number of Destination Unicode
> +                   char, including the Null terminator.
> +
> +  @retval 0  If String is NULL.
> +  @retval (sizeof (CHAR16) * (MaxSize + 1))
> +             If there is no Null terminator in the first MaxSize characters of
> +             String.
> +  @return The size of the Null-terminated Unicode string in bytes, including
> +          the Null terminator.
> +
> +**/
> +UINTN
> +EFIAPI
> +StrnSizeS (
> +  IN CONST CHAR16              *String,
> +  IN UINTN                     MaxSize
> +  );
> +
> +/**
>    Copies the string pointed to by Source (including the terminating null char)
>    to the array pointed to by Destination.
> 
> @@ -383,6 +411,32 @@ AsciiStrnLenS (
>    );
> 
>  /**
> +  Returns the size of a Null-terminated Ascii string in bytes, including the
> +  Null terminator.
> +
> +  This function returns the size of the Null-terminated Ascii string specified
> +  by String in bytes, including the Null terminator.
> +
> +  @param  String   A pointer to a Null-terminated Ascii string.
> +  @param  MaxSize  The maximum number of Destination Ascii
> +                   char, including the Null terminator.
> +
> +  @retval 0  If String is NULL.
> +  @retval (sizeof (CHAR8) * (MaxSize + 1))
> +             If there is no Null terminator in the first MaxSize characters of
> +             String.
> +  @return The size of the Null-terminated Ascii string in bytes, including the
> +          Null terminator.
> +
> +**/
> +UINTN
> +EFIAPI
> +AsciiStrnSizeS (
> +  IN CONST CHAR8               *String,
> +  IN UINTN                     MaxSize
> +  );
> +
> +/**
>    Copies the string pointed to by Source (including the terminating null char)
>    to the array pointed to by Destination.
> 
> diff --git a/MdePkg/Library/BaseLib/SafeString.c
> b/MdePkg/Library/BaseLib/SafeString.c
> index e4c0759..f80db9f 100644
> --- a/MdePkg/Library/BaseLib/SafeString.c
> +++ b/MdePkg/Library/BaseLib/SafeString.c
> @@ -1,7 +1,7 @@
>  /** @file
>    Safe String functions.
> 
> -  Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
> +  Copyright (c) 2014 - 2017, Intel Corporation. All rights reserved.<BR>
>    This program and the accompanying materials
>    are licensed and made available under the terms and conditions of the BSD
> License
>    which accompanies this distribution.  The full text of the license may be
> found at
> @@ -154,6 +154,51 @@ StrnLenS (
>  }
> 
>  /**
> +  Returns the size of a Null-terminated Unicode string in bytes, including the
> +  Null terminator.
> +
> +  This function returns the size of the Null-terminated Unicode string
> +  specified by String in bytes, including the Null terminator.
> +
> +  If String is not aligned on a 16-bit boundary, then ASSERT().
> +
> +  @param  String   A pointer to a Null-terminated Unicode string.
> +  @param  MaxSize  The maximum number of Destination Unicode
> +                   char, including the Null terminator.
> +
> +  @retval 0  If String is NULL.
> +  @retval (sizeof (CHAR16) * (MaxSize + 1))
> +             If there is no Null terminator in the first MaxSize characters of
> +             String.
> +  @return The size of the Null-terminated Unicode string in bytes, including
> +          the Null terminator.
> +
> +**/
> +UINTN
> +EFIAPI
> +StrnSizeS (
> +  IN CONST CHAR16              *String,
> +  IN UINTN                     MaxSize
> +  )
> +{
> +  //
> +  // If String is a null pointer, then the StrnSizeS function returns zero.
> +  //
> +  if (String == NULL) {
> +    return 0;
> +  }
> +
> +  //
> +  // Otherwise, the StrnSizeS function returns the size of the Null-terminated
> +  // Unicode string in bytes, including the Null terminator. If there is no
> +  // Null terminator in the first MaxSize characters of String, then StrnSizeS
> +  // returns (sizeof (CHAR16) * (MaxSize + 1)) to keep a consistent map with
> +  // the StrnLenS function.
> +  //
> +  return (StrnLenS (String, MaxSize) + 1) * sizeof (*String);
> +}
> +
> +/**
>    Copies the string pointed to by Source (including the terminating null char)
>    to the array pointed to by Destination.
> 
> @@ -586,6 +631,50 @@ AsciiStrnLenS (
>  }
> 
>  /**
> +  Returns the size of a Null-terminated Ascii string in bytes, including the
> +  Null terminator.
> +
> +  This function returns the size of the Null-terminated Ascii string specified
> +  by String in bytes, including the Null terminator.
> +
> +  @param  String   A pointer to a Null-terminated Ascii string.
> +  @param  MaxSize  The maximum number of Destination Ascii
> +                   char, including the Null terminator.
> +
> +  @retval 0  If String is NULL.
> +  @retval (sizeof (CHAR8) * (MaxSize + 1))
> +             If there is no Null terminator in the first MaxSize characters of
> +             String.
> +  @return The size of the Null-terminated Ascii string in bytes, including the
> +          Null terminator.
> +
> +**/
> +UINTN
> +EFIAPI
> +AsciiStrnSizeS (
> +  IN CONST CHAR8               *String,
> +  IN UINTN                     MaxSize
> +  )
> +{
> +  //
> +  // If String is a null pointer, then the AsciiStrnSizeS function returns
> +  // zero.
> +  //
> +  if (String == NULL) {
> +    return 0;
> +  }
> +
> +  //
> +  // Otherwise, the AsciiStrnSizeS function returns the size of the
> +  // Null-terminated Ascii string in bytes, including the Null terminator. If
> +  // there is no Null terminator in the first MaxSize characters of String,
> +  // then AsciiStrnSizeS returns (sizeof (CHAR8) * (MaxSize + 1)) to keep a
> +  // consistent map with the AsciiStrnLenS function.
> +  //
> +  return (AsciiStrnLenS (String, MaxSize) + 1) * sizeof (*String);
> +}
> +
> +/**
>    Copies the string pointed to by Source (including the terminating null char)
>    to the array pointed to by Destination.
> 
> --
> 1.9.5.msysgit.0