MdeModulePkg/Ip4Dxe: Add an independent timer for reconfig checking

* Since wireless network can switch at very short time, the time interval
  of reconfig event checking is too long for this case. To achieve better
  performance and scalability, separate this task from Ip4 tick timer.

Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Ye Ting <ting.ye@intel.com>
Cc: Fu Siyuan <siyuan.fu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Wang Fan <fan.wang@intel.com>
Reviewed-by: Jiaxin Wu <jiaxin.wu@intel.com>
Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>
(cherry picked from commit 018432f0ce1b42541977f61f9c7607257a4bf43a)

3 files changed, 83 insertions, 22 deletions

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.c
index 792db5c173..913139bb31 100644
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.c
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.c
@@ -1,7 +1,7 @@
 /** @file

   The driver binding and service binding protocol for IP4 driver.

 

-Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>

 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>

 

 This program and the accompanying materials

@@ -245,6 +245,7 @@ Ip4CreateService (
   ZeroMem (&IpSb->SnpMode, sizeof (EFI_SIMPLE_NETWORK_MODE));

 

   IpSb->Timer = NULL;

+  IpSb->ReconfigCheckTimer = NULL;

 

   IpSb->ReconfigEvent = NULL;

 

@@ -277,6 +278,18 @@ Ip4CreateService (
   }

 

   Status = gBS->CreateEvent (

+                  EVT_NOTIFY_SIGNAL | EVT_TIMER,

+                  TPL_CALLBACK,

+                  Ip4TimerReconfigChecking,

+                  IpSb,

+                  &IpSb->ReconfigCheckTimer

+                  );

+

+  if (EFI_ERROR (Status)) {

+    goto ON_ERROR;

+  }

+

+  Status = gBS->CreateEvent (

                   EVT_NOTIFY_SIGNAL,

                   TPL_NOTIFY,

                   Ip4AutoReconfigCallBack,

@@ -402,6 +415,13 @@ Ip4CleanService (
     IpSb->Timer = NULL;

   }

 

+  if (IpSb->ReconfigCheckTimer != NULL) {

+    gBS->SetTimer (IpSb->ReconfigCheckTimer, TimerCancel, 0);

+    gBS->CloseEvent (IpSb->ReconfigCheckTimer);

+

+    IpSb->ReconfigCheckTimer = NULL;

+  }

+

   if (IpSb->DefaultInterface != NULL) {

     Status = Ip4FreeInterface (IpSb->DefaultInterface, NULL);

 

@@ -622,6 +642,12 @@ Ip4DriverBindingStart (
     goto UNINSTALL_PROTOCOL;

   }

 

+  Status = gBS->SetTimer (IpSb->ReconfigCheckTimer, TimerPeriodic, 500 * TICKS_PER_MS);

+

+  if (EFI_ERROR (Status)) {

+    goto UNINSTALL_PROTOCOL;

+  }

+

   //

   // Initialize the IP4 ID

   //

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.c
index 3cdf8ecaad..2035ac65d1 100644
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.c
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.c
@@ -1,6 +1,6 @@
 /** @file

 

-Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2005 - 2018, 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

@@ -2231,18 +2231,10 @@ Ip4SentPacketTicking (
   return EFI_SUCCESS;

 }

 

-

 /**

-  There are two steps for this the heart beat timer of IP4 service instance. 

-  First, it times out all of its IP4 children's received-but-not-delivered 

-  and transmitted-but-not-recycle packets, and provides time input for its 

-  IGMP protocol.

-  Second, a dedicated timer is used to poll underlying media status. In case 

-  of cable swap, a new round auto configuration will be initiated. The timer 

-  will signal the IP4 to run DHCP configuration again. IP4 driver will free

-  old IP address related resource, such as route table and Interface, then

-  initiate a DHCP process to acquire new IP, eventually create route table 

-  for new IP address.

+  This heart beat timer of IP4 service instance times out all of its IP4 children's 

+  received-but-not-delivered and transmitted-but-not-recycle packets, and provides 

+  time input for its IGMP protocol.

 

   @param[in]  Event                  The IP4 service instance's heart beat timer.

   @param[in]  Context                The IP4 service instance.

@@ -2256,6 +2248,34 @@ Ip4TimerTicking (
   )

 {

   IP4_SERVICE               *IpSb;

+

+  IpSb = (IP4_SERVICE *) Context;

+  NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE);

+  

+  Ip4PacketTimerTicking (IpSb);

+  Ip4IgmpTicking (IpSb);

+}

+

+/**

+  This dedicated timer is used to poll underlying network media status. In case 

+  of cable swap or wireless network switch, a new round auto configuration will 

+  be initiated. The timer will signal the IP4 to run DHCP configuration again. 

+  IP4 driver will free old IP address related resource, such as route table and 

+  Interface, then initiate a DHCP process to acquire new IP, eventually create 

+  route table for new IP address.

+

+  @param[in]  Event                  The IP4 service instance's heart beat timer.

+  @param[in]  Context                The IP4 service instance.

+

+**/

+VOID

+EFIAPI

+Ip4TimerReconfigChecking (

+  IN EFI_EVENT              Event,

+  IN VOID                   *Context

+  )

+{

+  IP4_SERVICE               *IpSb;

   BOOLEAN                   OldMediaPresent;

   EFI_STATUS                Status;

   EFI_SIMPLE_NETWORK_MODE   SnpModeData;

@@ -2265,9 +2285,6 @@ Ip4TimerTicking (
   

   OldMediaPresent = IpSb->MediaPresent;

 

-  Ip4PacketTimerTicking (IpSb);

-  Ip4IgmpTicking (IpSb);

-

   //

   // Get fresh mode data from MNP, since underlying media status may change. 

   // Here, it needs to mention that the MediaPresent can also be checked even if 

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.h
index f6b4047941..8bdc39a3f1 100644
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.h
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.h
@@ -1,7 +1,7 @@
 /** @file

   Ip4 internal functions and type defintions.

   

-Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>

 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>

 

 This program and the accompanying materials

@@ -206,7 +206,7 @@ struct _IP4_SERVICE {
   EFI_SIMPLE_NETWORK_MODE         SnpMode;

 

   EFI_EVENT                       Timer;

-

+  EFI_EVENT                       ReconfigCheckTimer;

   EFI_EVENT                       ReconfigEvent;

 

   BOOLEAN                         Reconfig;

@@ -334,10 +334,9 @@ Ip4Groups (
   );

 

 /**

-  The heart beat timer of IP4 service instance. It times out

-  all of its IP4 children's received-but-not-delivered and

-  transmitted-but-not-recycle packets, and provides time input

-  for its IGMP protocol.

+  This heart beat timer of IP4 service instance times out all of its IP4 children's 

+  received-but-not-delivered and transmitted-but-not-recycle packets, and provides 

+  time input for its IGMP protocol.

 

   @param[in]  Event                  The IP4 service instance's heart beat timer.

   @param[in]  Context                The IP4 service instance.

@@ -351,6 +350,25 @@ Ip4TimerTicking (
   );

 

 /**

+  This dedicated timer is used to poll underlying network media status. In case 

+  of cable swap or wireless network switch, a new round auto configuration will 

+  be initiated. The timer will signal the IP4 to run DHCP configuration again. 

+  IP4 driver will free old IP address related resource, such as route table and 

+  Interface, then initiate a DHCP process to acquire new IP, eventually create 

+  route table for new IP address.

+

+  @param[in]  Event                  The IP4 service instance's heart beat timer.

+  @param[in]  Context                The IP4 service instance.

+

+**/

+VOID

+EFIAPI

+Ip4TimerReconfigChecking (

+  IN EFI_EVENT              Event,

+  IN VOID                   *Context

+  );

+

+/**

   Decrease the life of the transmitted packets. If it is

   decreased to zero, cancel the packet. This function is

   called by Ip4PacketTimerTicking which time out both the