This patch updates IP4 stack to support 32bit subnet mask in PXE boot process.
When 32bit subnet mask is used, the IP4 driver couldn't use the subnet mask to determine
whether destination IP address is on-link or not, so it will always try to send all the
packets to the destination IP address directly first, if failed it will continue
to try the default gateway.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Fu Siyuan <siyuan.fu@intel.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>
Reviewed-by: Wu Jiaxin <jiaxin.wu@intel.com>
\r
If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address,\r
except when the originator is one of the endpoints of a point-to-point link with a 31-bit\r
- mask (RFC3021).\r
-\r
+ mask (RFC3021), or a 32bit NetMask (all 0xFF) is used for special network environment (e.g.\r
+ PPP link).\r
+ \r
@param[in] Ip The IP to check against.\r
@param[in] NetMask The mask of the IP.\r
\r
\r
If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address,\r
except when the originator is one of the endpoints of a point-to-point link with a 31-bit\r
- mask (RFC3021).\r
-\r
+ mask (RFC3021), or a 32bit NetMask (all 0xFF) is used for special network environment (e.g.\r
+ PPP link).\r
+ \r
@param[in] Ip The IP to check against.\r
@param[in] NetMask The mask of the IP.\r
\r
IN IP4_ADDR NetMask\r
)\r
{\r
+ INTN MaskLength;\r
+ \r
ASSERT (NetMask != 0);\r
\r
if (Ip == 0 || IP4_IS_LOCAL_BROADCAST (Ip)) {\r
return FALSE;\r
}\r
\r
- if (NetGetMaskLength (NetMask) != 31) {\r
+ MaskLength = NetGetMaskLength (NetMask);\r
+ ASSERT ((MaskLength >= 0) && (MaskLength <= IP4_MASK_NUM));\r
+ if (MaskLength < 31) {\r
if (((Ip &~NetMask) == ~NetMask) || ((Ip &~NetMask) == 0)) {\r
return FALSE;\r
}\r
- } else {\r
- return TRUE;\r
}\r
\r
return TRUE;\r
/// Compose the fragment field to be used in the IP4 header.\r
///\r
#define IP4_HEAD_FRAGMENT_FIELD(Df, Mf, Offset) \\r
- ((UINT16)(((Df) ? 0x4000 : 0) | ((Mf) ? 0x2000 : 0) | (((Offset) >> 3) & 0x1fff)))\r
+ ((UINT16)(((Df) ? IP4_HEAD_DF_MASK : 0) | ((Mf) ? IP4_HEAD_MF_MASK : 0) | (((Offset) >> 3) & IP4_HEAD_OFFSET_MASK)))\r
\r
#define IP4_LAST_FRAGMENT(FragmentField) \\r
(((FragmentField) & IP4_HEAD_MF_MASK) == 0)\r
@param[in] CallBack Call back function to execute if transmission\r
finished.\r
@param[in] Context Opaque parameter to the call back.\r
+ @param[in] IpSb The pointer to the IP4 service binding instance.\r
\r
@retval Token The wrapped token if succeed\r
@retval NULL The wrapped token if NULL\r
IN IP4_PROTOCOL *IpInstance OPTIONAL,\r
IN NET_BUF *Packet,\r
IN IP4_FRAME_CALLBACK CallBack,\r
- IN VOID *Context\r
+ IN VOID *Context,\r
+ IN IP4_SERVICE *IpSb\r
)\r
{\r
EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken;\r
\r
Token->Interface = Interface;\r
Token->IpInstance = IpInstance;\r
+ Token->IpSb = IpSb;\r
Token->CallBack = CallBack;\r
Token->Packet = Packet;\r
Token->Context = Context;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ This function tries to send all the queued frames in ArpQue to the default gateway if \r
+ the ARP resolve for direct destination address is failed when using /32 subnet mask.\r
+\r
+ @param[in] ArpQue The ARP queue of a failed request.\r
+ \r
+ @retval EFI_SUCCESS All the queued frames have been send to the default route.\r
+ @retval Others Failed to send the queued frames.\r
+ \r
+**/\r
+EFI_STATUS\r
+Ip4SendFrameToDefaultRoute (\r
+ IN IP4_ARP_QUE *ArpQue\r
+ )\r
+{\r
+ LIST_ENTRY *Entry;\r
+ LIST_ENTRY *Next;\r
+ IP4_ROUTE_CACHE_ENTRY *RtCacheEntry;\r
+ IP4_LINK_TX_TOKEN *Token;\r
+ IP4_ADDR Gateway;\r
+ EFI_STATUS Status;\r
+ IP4_ROUTE_ENTRY *DefaultRoute;\r
+ \r
+ //\r
+ // ARP resolve failed when using /32 subnet mask.\r
+ //\r
+ NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) {\r
+ RemoveEntryList (Entry);\r
+ Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link);\r
+ ASSERT (Token->Interface->SubnetMask == IP4_ALLONE_ADDRESS);\r
+ //\r
+ // Find the default gateway IP address. The default route was saved to the RtCacheEntry->Tag in Ip4Route().\r
+ //\r
+ RtCacheEntry = NULL;\r
+ if (Token->IpInstance != NULL) {\r
+ RtCacheEntry = Ip4FindRouteCache (Token->IpInstance->RouteTable, NTOHL (ArpQue->Ip), Token->Interface->Ip);\r
+ }\r
+ if (RtCacheEntry == NULL) {\r
+ RtCacheEntry = Ip4FindRouteCache (Token->IpSb->DefaultRouteTable, NTOHL (ArpQue->Ip), Token->Interface->Ip);\r
+ }\r
+ if (RtCacheEntry == NULL) {\r
+ Status= EFI_NO_MAPPING;\r
+ goto ON_ERROR;\r
+ }\r
+ DefaultRoute = (IP4_ROUTE_ENTRY*)RtCacheEntry->Tag;\r
+ if (DefaultRoute == NULL) {\r
+ Status= EFI_NO_MAPPING;\r
+ goto ON_ERROR;\r
+ }\r
+ //\r
+ // Try to send the frame to the default route.\r
+ //\r
+ Gateway = DefaultRoute->NextHop;\r
+ if (ArpQue->Ip == Gateway) {\r
+ //\r
+ // ARP resolve for the default route is failed, return error to caller. \r
+ //\r
+ Status= EFI_NO_MAPPING;\r
+ goto ON_ERROR;\r
+ }\r
+ RtCacheEntry->NextHop = Gateway;\r
+ Status = Ip4SendFrame (Token->Interface,Token->IpInstance,Token->Packet,Gateway,Token->CallBack,Token->Context,Token->IpSb);\r
+ if (EFI_ERROR (Status)) {\r
+ Status= EFI_NO_MAPPING;\r
+ goto ON_ERROR;\r
+ }\r
+ Ip4FreeRouteCacheEntry (RtCacheEntry);\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+ \r
+ON_ERROR:\r
+ if (RtCacheEntry != NULL) {\r
+ Ip4FreeRouteCacheEntry (RtCacheEntry);\r
+ }\r
+ Token->CallBack (Token->IpInstance, Token->Packet, Status, 0, Token->Context);\r
+ Ip4FreeLinkTxToken (Token);\r
+ return Status;\r
+}\r
+\r
\r
/**\r
- Callback function when ARP request are finished. It will cancelled\r
+ Callback function when ARP request are finished. It will cancel\r
all the queued frame if the ARP requests failed. Or transmit them\r
if the request succeed.\r
\r
IP4_INTERFACE *Interface;\r
IP4_LINK_TX_TOKEN *Token;\r
EFI_STATUS Status;\r
+ EFI_STATUS IoStatus;\r
\r
ArpQue = (IP4_ARP_QUE *) Context;\r
NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE);\r
RemoveEntryList (&ArpQue->Link);\r
\r
//\r
- // ARP resolve failed for some reason. Release all the frame\r
- // and ARP queue itself. Ip4FreeArpQue will call the frame's\r
- // owner back.\r
+ // ARP resolve failed for some reason. \r
//\r
if (NET_MAC_EQUAL (&ArpQue->Mac, &mZeroMacAddress, ArpQue->Interface->HwaddrLen)) {\r
- Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING);\r
-\r
- return ;\r
+ if (ArpQue->Interface->SubnetMask != IP4_ALLONE_ADDRESS) {\r
+ //\r
+ // Release all the frame and ARP queue itself. Ip4FreeArpQue will call the frame's\r
+ // owner back.\r
+ //\r
+ IoStatus = EFI_NO_MAPPING;\r
+ } else {\r
+ //\r
+ // ARP resolve failed when using 32bit subnet mask, try to send the packets to the\r
+ // default route.\r
+ //\r
+ IoStatus = Ip4SendFrameToDefaultRoute (ArpQue);\r
+ }\r
+ goto ON_EXIT;\r
}\r
\r
//\r
// queue. It isn't necessary for us to cache the ARP binding because\r
// we always check the ARP cache first before transmit.\r
//\r
+ IoStatus = EFI_SUCCESS;\r
Interface = ArpQue->Interface;\r
\r
NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) {\r
}\r
}\r
\r
- Ip4FreeArpQue (ArpQue, EFI_SUCCESS);\r
+ON_EXIT:\r
+ Ip4FreeArpQue (ArpQue, IoStatus);\r
}\r
\r
/**\r
to.\r
@param[in] CallBack Function to call back when transmit finished.\r
@param[in] Context Opaque parameter to the call back.\r
+ @param[in] IpSb The pointer to the IP4 service binding instance.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame\r
@retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop\r
IN NET_BUF *Packet,\r
IN IP4_ADDR NextHop,\r
IN IP4_FRAME_CALLBACK CallBack,\r
- IN VOID *Context\r
+ IN VOID *Context,\r
+ IN IP4_SERVICE *IpSb\r
)\r
{\r
IP4_LINK_TX_TOKEN *Token;\r
\r
ASSERT (Interface->Configured);\r
\r
- Token = Ip4WrapLinkTxToken (Interface, IpInstance, Packet, CallBack, Context);\r
+ Token = Ip4WrapLinkTxToken (Interface, IpInstance, Packet, CallBack, Context, IpSb);\r
\r
if (Token == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
LIST_ENTRY Link;\r
\r
IP4_INTERFACE *Interface;\r
+ IP4_SERVICE *IpSb;\r
\r
IP4_PROTOCOL *IpInstance;\r
IP4_FRAME_CALLBACK CallBack;\r
to.\r
@param[in] CallBack Function to call back when transmit finished.\r
@param[in] Context Opaque parameter to the call back.\r
+ @param[in] IpSb The pointer to the IP4 service binding instance.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame\r
@retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop\r
IN NET_BUF *Packet,\r
IN IP4_ADDR NextHop,\r
IN IP4_FRAME_CALLBACK CallBack,\r
- IN VOID *Context\r
+ IN VOID *Context,\r
+ IN IP4_SERVICE *IpSb\r
);\r
\r
/**\r
// the gateway address must be a unicast on the connected network if not zero.\r
//\r
if ((Nexthop != IP4_ALLZERO_ADDRESS) &&\r
- (!IP4_NET_EQUAL (Nexthop, IpIf->Ip, IpIf->SubnetMask) ||\r
+ ((IpIf->SubnetMask != IP4_ALLONE_ADDRESS && !IP4_NET_EQUAL (Nexthop, IpIf->Ip, IpIf->SubnetMask)) ||\r
IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop, IpIf)))) {\r
\r
Status = EFI_INVALID_PARAMETER;\r
// Route the packet unless overrided, that is, GateWay isn't zero.\r
//\r
if (IpInstance == NULL) {\r
- CacheEntry = Ip4Route (IpSb->DefaultRouteTable, Head->Dst, Head->Src);\r
+ CacheEntry = Ip4Route (IpSb->DefaultRouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, TRUE);\r
} else {\r
- CacheEntry = Ip4Route (IpInstance->RouteTable, Head->Dst, Head->Src);\r
+ CacheEntry = Ip4Route (IpInstance->RouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, FALSE);\r
//\r
// If failed to route the packet by using the instance's route table,\r
// try to use the default route table.\r
//\r
if (CacheEntry == NULL) {\r
- CacheEntry = Ip4Route (IpSb->DefaultRouteTable, Head->Dst, Head->Src);\r
+ CacheEntry = Ip4Route (IpSb->DefaultRouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, TRUE);\r
}\r
}\r
\r
Fragment,\r
GateWay,\r
Ip4SysPacketSent,\r
- Packet\r
+ Packet,\r
+ IpSb\r
);\r
\r
if (EFI_ERROR (Status)) {\r
// upper layer's packets.\r
//\r
Ip4PrependHead (Packet, Head, Option, OptLen);\r
- Status = Ip4SendFrame (IpIf, IpInstance, Packet, GateWay, Callback, Context);\r
+ Status = Ip4SendFrame (IpIf, IpInstance, Packet, GateWay, Callback, Context, IpSb);\r
\r
if (EFI_ERROR (Status)) {\r
goto ON_ERROR;\r
@param[in] RtTable The route table to search from\r
@param[in] Dest The destination address to search for\r
@param[in] Src The source address to search for\r
+ @param[in] SubnetMask The subnet mask of the Src address, this field is\r
+ used to check if the station is using /32 subnet.\r
+ @param[in] AlwaysTryDestAddr Always try to use the dest address as next hop even\r
+ though we can't find a matching route entry. This\r
+ field is only valid when using /32 subnet.\r
\r
@return NULL if failed to route packet, otherwise a route cache\r
entry that can be used to route packet.\r
Ip4Route (\r
IN IP4_ROUTE_TABLE *RtTable,\r
IN IP4_ADDR Dest,\r
- IN IP4_ADDR Src\r
+ IN IP4_ADDR Src,\r
+ IN IP4_ADDR SubnetMask,\r
+ IN BOOLEAN AlwaysTryDestAddr\r
)\r
{\r
LIST_ENTRY *Head;\r
RtEntry = Ip4FindRouteEntry (RtTable, Dest);\r
\r
if (RtEntry == NULL) {\r
- return NULL;\r
+ if (SubnetMask != IP4_ALLONE_ADDRESS) {\r
+ return NULL;\r
+ } else if (!AlwaysTryDestAddr) {\r
+ return NULL;\r
+ }\r
}\r
\r
//\r
// network. Otherwise, it is an indirect route, the packet will be\r
// sent to the next hop router.\r
//\r
- if ((RtEntry->Flag & IP4_DIRECT_ROUTE) != 0) {\r
+ // When using /32 subnet mask, the packet will always be sent to the direct\r
+ // destination first, if we can't find a matching route cache.\r
+ //\r
+ if (SubnetMask == IP4_ALLONE_ADDRESS || ((RtEntry->Flag & IP4_DIRECT_ROUTE) != 0)) {\r
NextHop = Dest;\r
} else {\r
NextHop = RtEntry->NextHop;\r
}\r
\r
- Ip4FreeRouteEntry (RtEntry);\r
+ if (RtEntry != NULL) {\r
+ Ip4FreeRouteEntry (RtEntry);\r
+ }\r
\r
//\r
// Create a route cache entry, and tag it as spawned from this route entry\r
+ // For /32 subnet mask, the default route in RtEntry will be used if failed\r
+ // to send the packet to driect destination address.\r
//\r
RtCacheEntry = Ip4CreateRouteCacheEntry (Dest, Src, NextHop, (UINTN) RtEntry);\r
\r
@param[in] RtTable The route table to search from\r
@param[in] Dest The destination address to search for\r
@param[in] Src The source address to search for\r
+ @param[in] SubnetMask The subnet mask of the Src address, this field is\r
+ used to check if the station is using /32 subnet.\r
+ @param[in] AlwaysTryDestAddr Always try to use the dest address as next hop even\r
+ though we can't find a matching route entry. This\r
+ field is only valid when using /32 subnet.\r
\r
@return NULL if failed to route packet, otherwise a route cache\r
entry that can be used to route packet.\r
Ip4Route (\r
IN IP4_ROUTE_TABLE *RtTable,\r
IN IP4_ADDR Dest,\r
- IN IP4_ADDR Src\r
+ IN IP4_ADDR Src,\r
+ IN IP4_ADDR SubnetMask,\r
+ IN BOOLEAN AlwaysTryDestAddr\r
);\r
\r
/**\r
goto ON_ERROR;\r
}\r
\r
+ gBS->RestoreTPL(OldTpl);\r
+\r
if (Token->Event != NULL) {\r
- gBS->RestoreTPL (OldTpl);\r
return EFI_SUCCESS;\r
}\r
\r
This->Poll (This);\r
}\r
\r
- gBS->RestoreTPL (OldTpl);\r
return Token->Status;\r
\r
ON_ERROR:\r
}\r
\r
if ((Gateway != 0) &&\r
- (!IP4_NET_EQUAL (Gateway, Ip, Netmask) || (Netmask != 0 && !NetIp4IsUnicast (Gateway, Netmask)))) {\r
+ ((Netmask != 0xFFFFFFFF && !IP4_NET_EQUAL (Gateway, Ip, Netmask)) || (Netmask != 0 && !NetIp4IsUnicast (Gateway, Netmask)))) {\r
\r
return EFI_INVALID_PARAMETER;\r
}\r
projects / mirror_edk2.git / commitdiff