NetworkPkg: Handling timeout case in httpboot driver

This patch is used to handle timeout case when downloading
the message. The Status in the token should also be checked
to handle any response error case including timeout case.

Cc: Fu Siyuan <siyuan.fu@intel.com>
Cc: Ye Ting <ting.ye@intel.com>
Cc: Zhang Lubo <lubo.zhang@intel.com>
Cc: Hegde Nagaraj P <nagaraj-p.hegde@hpe.com>
Cc: Gary Lin <glin@suse.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiaxin Wu <jiaxin.wu@intel.com>
Reviewed-by: Gary Lin <glin@suse.com>
Reviewed-by: Hegde Nagaraj P <nagaraj-p.hegde@hpe.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>
Tested-by: Gary Lin <glin@suse.com>
Tested-by: Hegde Nagaraj P <nagaraj-p.hegde@hpe.com>

NetworkPkg/HttpBootDxe/HttpBootClient.c

@@ -1008,7 +1008,10 @@ HttpBootGetBootFile (
                    FALSE,
                    &ResponseBody
                    );
-        if (EFI_ERROR (Status)) {
+        if (EFI_ERROR (Status) || EFI_ERROR (ResponseBody.Status)) {
+          if (EFI_ERROR (ResponseBody.Status)) {
+            Status = ResponseBody.Status;
+          }
           goto ERROR_6;
         }
         ReceivedSize += ResponseBody.BodyLength;
@@ -1045,7 +1048,10 @@ HttpBootGetBootFile (
                    FALSE,
                    &ResponseBody
                    );
-        if (EFI_ERROR (Status)) {
+        if (EFI_ERROR (Status) || EFI_ERROR (ResponseBody.Status)) {
+          if (EFI_ERROR (ResponseBody.Status)) {
+            Status = ResponseBody.Status;
+          }
           goto ERROR_6;
         }
 

NetworkPkg/HttpBootDxe/HttpBootClient.h

@@ -17,6 +17,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __EFI_HTTP_BOOT_HTTP_H__
 
 #define HTTP_BOOT_REQUEST_TIMEOUT            5000      // 5 seconds in uints of millisecond.
+#define HTTP_BOOT_RESPONSE_TIMEOUT           5000      // 5 seconds in uints of millisecond.
 #define HTTP_BOOT_BLOCK_SIZE                 1500
 
 

NetworkPkg/HttpBootDxe/HttpBootSupport.c

@@ -754,6 +754,21 @@ HttpIoCreateIo (
   HttpIo->RspToken.Event = Event;
   HttpIo->RspToken.Message = &HttpIo->RspMessage;
 
+  //
+  // Create TimeoutEvent for response
+  //
+  Status = gBS->CreateEvent (
+                  EVT_TIMER,
+                  TPL_CALLBACK,
+                  NULL,
+                  NULL,
+                  &Event
+                  );
+  if (EFI_ERROR (Status)) {
+    goto ON_ERROR;
+  }
+  HttpIo->TimeoutEvent = Event;
+
   return EFI_SUCCESS;
   
 ON_ERROR:
@@ -789,6 +804,11 @@ HttpIoDestroyIo (
   if (Event != NULL) {
     gBS->CloseEvent (Event);
   }
+
+  Event = HttpIo->TimeoutEvent;
+  if (Event != NULL) {
+    gBS->CloseEvent (Event);
+  }
   
   Http = HttpIo->Http;
   if (Http != NULL) {
@@ -902,6 +922,14 @@ HttpIoRecvResponse (
     return EFI_INVALID_PARAMETER;
   }
 
+  //
+  // Start the timer, and wait Timeout seconds to receive the header packet.
+  //
+  Status = gBS->SetTimer (HttpIo->TimeoutEvent, TimerRelative, HTTP_BOOT_RESPONSE_TIMEOUT * TICKS_PER_MS);
+  if (EFI_ERROR (Status)) {
+    return Status;
+  }
+
   //
   // Queue the response token to HTTP instances.
   //
@@ -924,16 +952,32 @@ HttpIoRecvResponse (
                    );
   
   if (EFI_ERROR (Status)) {
+    gBS->SetTimer (HttpIo->TimeoutEvent, TimerCancel, 0);
     return Status;
   }
 
   //
   // Poll the network until receive finish.
   //
-  while (!HttpIo->IsRxDone) {
+  while (!HttpIo->IsRxDone && ((HttpIo->TimeoutEvent == NULL) || EFI_ERROR (gBS->CheckEvent (HttpIo->TimeoutEvent)))) {
     Http->Poll (Http);
   }
 
+  gBS->SetTimer (HttpIo->TimeoutEvent, TimerCancel, 0);
+
+  if (!HttpIo->IsRxDone) {
+    //
+    // Timeout occurs, cancel the response token.
+    //
+    Http->Cancel (Http, &HttpIo->RspToken);
+   
+    Status = EFI_TIMEOUT;
+    
+    return Status;
+  } else {
+    HttpIo->IsRxDone = FALSE;
+  }
+
   //
   // Store the received data into the wrapper.
   //

NetworkPkg/HttpBootDxe/HttpBootSupport.h

@@ -196,6 +196,8 @@ typedef struct {
 
   BOOLEAN                   IsTxDone;
   BOOLEAN                   IsRxDone;
+
+  EFI_EVENT                 TimeoutEvent;
 } HTTP_IO;
 
 //