Re: [edk2] [Patch] MdeModulePkg/TcpIoLib: Check input Timeout before calling CheckEvent() service.

[Ye, Ting]

Reviewed-by: Ye Ting  

-Original Message-
From: Fu Siyuan [mailto:siyuan...@intel.com] 
Sent: Tuesday, December 5, 2017 2:33 PM
To: edk2-devel@lists.01.org
Cc: Wu, Jiaxin ; Ye, Ting 
Subject: [Patch] MdeModulePkg/TcpIoLib: Check input Timeout before calling 
CheckEvent() service.

For TcpIoConnect() and TcpIoAccept(), this patch adds the check for Timeout 
event before calling CheckEvent() service so as to avoid the unnecessary 
function call.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Fu Siyuan 
Cc: Wu Jiaxin 
Cc: Ye Ting 
---
 MdeModulePkg/Include/Library/TcpIoLib.h| 14 +++---
 MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c | 20 ++--
 2 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/MdeModulePkg/Include/Library/TcpIoLib.h 
b/MdeModulePkg/Include/Library/TcpIoLib.h
index 2871f6747e..22629dbcd5 100644
--- a/MdeModulePkg/Include/Library/TcpIoLib.h
+++ b/MdeModulePkg/Include/Library/TcpIoLib.h
@@ -2,7 +2,7 @@
   This library is used to share code between UEFI network stack modules.
   It provides the helper routines to access TCP service.
 
-Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.
+Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.
 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 @@ -144,7 
+144,7 @@ TcpIoDestroySocket (
   Connect to the other endpoint of the TCP socket.
 
   @param[in, out]  TcpIo The TcpIo wrapping the TCP socket.
-  @param[in]   Timeout   The time to wait for connection done.
+  @param[in]   Timeout   The time to wait for connection done. Set to NULL 
for infinite wait.
   
   @retval EFI_SUCCESSConnect to the other endpoint of the TCP 
socket
  successfully.
@@ -160,14 +160,14 @@ EFI_STATUS
 EFIAPI
 TcpIoConnect (
   IN OUT TCP_IO *TcpIo,
-  IN EFI_EVENT  Timeout
+  IN EFI_EVENT  TimeoutOPTIONAL
   );
 
 /**
   Accept the incomding request from the other endpoint of the TCP socket.
 
   @param[in, out]  TcpIo The TcpIo wrapping the TCP socket.
-  @param[in]   Timeout   The time to wait for connection done.
+  @param[in]   Timeout   The time to wait for connection done. Set to NULL 
for infinite wait.
 
   
   @retval EFI_SUCCESSConnect to the other endpoint of the TCP 
socket
@@ -185,7 +185,7 @@ EFI_STATUS
 EFIAPI
 TcpIoAccept (
   IN OUT TCP_IO *TcpIo,
-  IN EFI_EVENT  Timeout
+  IN EFI_EVENT  TimeoutOPTIONAL
   );
   
 /**
@@ -229,7 +229,7 @@ TcpIoTransmit (
   @param[in]   Packet  The buffer to hold the data copy from the 
socket rx buffer.
   @param[in]   AsyncMode   Is this receive asyncronous or not.
   @param[in]   Timeout The time to wait for receiving the amount of 
data the Packet
-   can hold.
+   can hold. Set to NULL for infinite wait.
 
   @retval EFI_SUCCESSThe required amount of data is received from 
the socket.
   @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.
@@ -246,7 +246,7 @@ TcpIoReceive (
   IN OUT TCP_IO *TcpIo,
   IN NET_BUF*Packet,
   IN BOOLEANAsyncMode,
-  IN EFI_EVENT  Timeout
+  IN EFI_EVENT  Timeout   OPTIONAL
   );
 
 #endif
diff --git a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c 
b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
index 17183e1a6c..a7637579f2 100644
--- a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
+++ b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
@@ -2,7 +2,7 @@
   This library is used to share code between UEFI network stack modules.
   It provides the helper routines to access TCP service.
 
-Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.
+Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.
 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 @@ -530,7 
+530,7 @@ TcpIoDestroySocket (
   Connect to the other endpoint of the TCP socket.
 
   @param[in, out]  TcpIo The TcpIo wrapping the TCP socket.
-  @param[in]   Timeout   The time to wait for connection done.
+  @param[in]   Timeout   The time to wait for connection done. Set to NULL 
for infinite wait.
   
   @retval EFI_SUCCESSConnect to the other endpoint of the TCP 
socket
  successfully.
@@ -546,7 +546,7 @@ EFI_STATUS
 EFIAPI
 TcpIoConnect (
   IN OUT TCP_IO 

Re: [edk2] [Patch] MdeModulePkg/TcpIoLib: Check input Timeout before calling CheckEvent() service.

[Wu, Jiaxin]

Reviewed-by: Wu Jiaxin 



> -Original Message-
> From: Fu Siyuan [mailto:siyuan...@intel.com]
> Sent: Tuesday, December 5, 2017 2:33 PM
> To: edk2-devel@lists.01.org
> Cc: Wu, Jiaxin ; Ye, Ting 
> Subject: [Patch] MdeModulePkg/TcpIoLib: Check input Timeout before
> calling CheckEvent() service.
> 
> For TcpIoConnect() and TcpIoAccept(), this patch adds the check for Timeout
> event
> before calling CheckEvent() service so as to avoid the unnecessary function
> call.
> 
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Fu Siyuan 
> Cc: Wu Jiaxin 
> Cc: Ye Ting 
> ---
>  MdeModulePkg/Include/Library/TcpIoLib.h| 14 +++---
>  MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c | 20 ++
> --
>  2 files changed, 17 insertions(+), 17 deletions(-)
> 
> diff --git a/MdeModulePkg/Include/Library/TcpIoLib.h
> b/MdeModulePkg/Include/Library/TcpIoLib.h
> index 2871f6747e..22629dbcd5 100644
> --- a/MdeModulePkg/Include/Library/TcpIoLib.h
> +++ b/MdeModulePkg/Include/Library/TcpIoLib.h
> @@ -2,7 +2,7 @@
>This library is used to share code between UEFI network stack modules.
>It provides the helper routines to access TCP service.
> 
> -Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.
> +Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.
>  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
> @@ -144,7 +144,7 @@ TcpIoDestroySocket (
>Connect to the other endpoint of the TCP socket.
> 
>@param[in, out]  TcpIo The TcpIo wrapping the TCP socket.
> -  @param[in]   Timeout   The time to wait for connection done.
> +  @param[in]   Timeout   The time to wait for connection done. Set to
> NULL for infinite wait.
> 
>@retval EFI_SUCCESSConnect to the other endpoint of the TCP
> socket
>   successfully.
> @@ -160,14 +160,14 @@ EFI_STATUS
>  EFIAPI
>  TcpIoConnect (
>IN OUT TCP_IO *TcpIo,
> -  IN EFI_EVENT  Timeout
> +  IN EFI_EVENT  TimeoutOPTIONAL
>);
> 
>  /**
>Accept the incomding request from the other endpoint of the TCP socket.
> 
>@param[in, out]  TcpIo The TcpIo wrapping the TCP socket.
> -  @param[in]   Timeout   The time to wait for connection done.
> +  @param[in]   Timeout   The time to wait for connection done. Set to
> NULL for infinite wait.
> 
> 
>@retval EFI_SUCCESSConnect to the other endpoint of the TCP
> socket
> @@ -185,7 +185,7 @@ EFI_STATUS
>  EFIAPI
>  TcpIoAccept (
>IN OUT TCP_IO *TcpIo,
> -  IN EFI_EVENT  Timeout
> +  IN EFI_EVENT  TimeoutOPTIONAL
>);
> 
>  /**
> @@ -229,7 +229,7 @@ TcpIoTransmit (
>@param[in]   Packet  The buffer to hold the data copy from the 
> socket
> rx buffer.
>@param[in]   AsyncMode   Is this receive asyncronous or not.
>@param[in]   Timeout The time to wait for receiving the amount of 
> data
> the Packet
> -   can hold.
> +   can hold. Set to NULL for infinite wait.
> 
>@retval EFI_SUCCESSThe required amount of data is received from
> the socket.
>@retval EFI_INVALID_PARAMETER  One or more parameters are invalid.
> @@ -246,7 +246,7 @@ TcpIoReceive (
>IN OUT TCP_IO *TcpIo,
>IN NET_BUF*Packet,
>IN BOOLEANAsyncMode,
> -  IN EFI_EVENT  Timeout
> +  IN EFI_EVENT  Timeout   OPTIONAL
>);
> 
>  #endif
> diff --git a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
> b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
> index 17183e1a6c..a7637579f2 100644
> --- a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
> +++ b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
> @@ -2,7 +2,7 @@
>This library is used to share code between UEFI network stack modules.
>It provides the helper routines to access TCP service.
> 
> -Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.
> +Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.
>  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
> @@ -530,7 +530,7 @@ TcpIoDestroySocket (
>Connect to the other endpoint of the TCP socket.
> 
>@param[in, out]  TcpIo The TcpIo wrapping the TCP socket.
> -  @param[in]   Timeout   The time to wait for connection done.
> +  @param[in]   Timeout   The time to wait for connection done. Set to
> NULL for infinite wait.
> 
>

[edk2] [Patch] MdeModulePkg/TcpIoLib: Check input Timeout before calling CheckEvent() service.

[Fu Siyuan]

For TcpIoConnect() and TcpIoAccept(), this patch adds the check for Timeout 
event
before calling CheckEvent() service so as to avoid the unnecessary function 
call.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Fu Siyuan 
Cc: Wu Jiaxin 
Cc: Ye Ting 
---
 MdeModulePkg/Include/Library/TcpIoLib.h| 14 +++---
 MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c | 20 ++--
 2 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/MdeModulePkg/Include/Library/TcpIoLib.h 
b/MdeModulePkg/Include/Library/TcpIoLib.h
index 2871f6747e..22629dbcd5 100644
--- a/MdeModulePkg/Include/Library/TcpIoLib.h
+++ b/MdeModulePkg/Include/Library/TcpIoLib.h
@@ -2,7 +2,7 @@
   This library is used to share code between UEFI network stack modules.
   It provides the helper routines to access TCP service.
 
-Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.
+Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.
 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
@@ -144,7 +144,7 @@ TcpIoDestroySocket (
   Connect to the other endpoint of the TCP socket.
 
   @param[in, out]  TcpIo The TcpIo wrapping the TCP socket.
-  @param[in]   Timeout   The time to wait for connection done.
+  @param[in]   Timeout   The time to wait for connection done. Set to NULL 
for infinite wait.
   
   @retval EFI_SUCCESSConnect to the other endpoint of the TCP 
socket
  successfully.
@@ -160,14 +160,14 @@ EFI_STATUS
 EFIAPI
 TcpIoConnect (
   IN OUT TCP_IO *TcpIo,
-  IN EFI_EVENT  Timeout
+  IN EFI_EVENT  TimeoutOPTIONAL
   );
 
 /**
   Accept the incomding request from the other endpoint of the TCP socket.
 
   @param[in, out]  TcpIo The TcpIo wrapping the TCP socket.
-  @param[in]   Timeout   The time to wait for connection done.
+  @param[in]   Timeout   The time to wait for connection done. Set to NULL 
for infinite wait.
 
   
   @retval EFI_SUCCESSConnect to the other endpoint of the TCP 
socket
@@ -185,7 +185,7 @@ EFI_STATUS
 EFIAPI
 TcpIoAccept (
   IN OUT TCP_IO *TcpIo,
-  IN EFI_EVENT  Timeout
+  IN EFI_EVENT  TimeoutOPTIONAL
   );
   
 /**
@@ -229,7 +229,7 @@ TcpIoTransmit (
   @param[in]   Packet  The buffer to hold the data copy from the 
socket rx buffer.
   @param[in]   AsyncMode   Is this receive asyncronous or not.
   @param[in]   Timeout The time to wait for receiving the amount of 
data the Packet
-   can hold.
+   can hold. Set to NULL for infinite wait.
 
   @retval EFI_SUCCESSThe required amount of data is received from 
the socket.
   @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.
@@ -246,7 +246,7 @@ TcpIoReceive (
   IN OUT TCP_IO *TcpIo,
   IN NET_BUF*Packet,
   IN BOOLEANAsyncMode,
-  IN EFI_EVENT  Timeout
+  IN EFI_EVENT  Timeout   OPTIONAL
   );
 
 #endif
diff --git a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c 
b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
index 17183e1a6c..a7637579f2 100644
--- a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
+++ b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c
@@ -2,7 +2,7 @@
   This library is used to share code between UEFI network stack modules.
   It provides the helper routines to access TCP service.
 
-Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.
+Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.
 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
@@ -530,7 +530,7 @@ TcpIoDestroySocket (
   Connect to the other endpoint of the TCP socket.
 
   @param[in, out]  TcpIo The TcpIo wrapping the TCP socket.
-  @param[in]   Timeout   The time to wait for connection done.
+  @param[in]   Timeout   The time to wait for connection done. Set to NULL 
for infinite wait.
   
   @retval EFI_SUCCESSConnect to the other endpoint of the TCP 
socket
  successfully.
@@ -546,7 +546,7 @@ EFI_STATUS
 EFIAPI
 TcpIoConnect (
   IN OUT TCP_IO *TcpIo,
-  IN EFI_EVENT  Timeout
+  IN EFI_EVENT  TimeoutOPTIONAL
   )
 {
   EFI_TCP4_PROTOCOL *Tcp4;
@@ -576,7 +576,7 @@ TcpIoConnect (
 return Status;
   }
 
-  while (!TcpIo->IsConnDone && EFI_ERROR (gBS->CheckEvent (Timeout))) {
+  while (!TcpIo->IsConnDone && ((Timeout == NULL) || EFI_ERROR 
(gBS->CheckEvent