IpIo Library.\r
\r
(C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r
-Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
\r
@retval EFI_SUCCESS The IP child is created and the IP protocol\r
interface is retrieved.\r
+ @retval EFI_UNSUPPORTED Upsupported IpVersion.\r
@retval Others The required operation failed.\r
\r
**/\r
\r
@retval EFI_SUCCESS The IP protocol is closed and the relevant IP child\r
is destroyed.\r
+ @retval EFI_UNSUPPORTED Upsupported IpVersion.\r
@retval Others The required operation failed.\r
\r
**/\r
//\r
// Close the previously openned IP protocol.\r
//\r
- gBS->CloseProtocol (\r
- ChildHandle,\r
- IpProtocolGuid,\r
- ImageHandle,\r
- ControllerHandle\r
- );\r
+ Status = gBS->CloseProtocol (\r
+ ChildHandle,\r
+ IpProtocolGuid,\r
+ ImageHandle,\r
+ ControllerHandle\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
\r
//\r
// Destroy the IP child.\r
//\r
- Status = NetLibDestroyServiceChild (\r
- ControllerHandle,\r
- ImageHandle,\r
- ServiceBindingGuid,\r
- ChildHandle\r
- );\r
-\r
- return Status;\r
+ return NetLibDestroyServiceChild (\r
+ ControllerHandle,\r
+ ImageHandle,\r
+ ServiceBindingGuid,\r
+ ChildHandle\r
+ );\r
}\r
\r
/**\r
UINT8 Type;\r
UINT8 Code;\r
UINT32 TrimBytes;\r
-\r
+ \r
+ ASSERT (IpIo != NULL);\r
+ ASSERT (Pkt != NULL);\r
+ ASSERT (Session != NULL);\r
ASSERT (IpIo->IpVersion == IP_VERSION_4);\r
-\r
- IcmpHdr = NET_PROTO_HDR (Pkt, IP4_ICMP_ERROR_HEAD);\r
- IpHdr = (EFI_IP4_HEADER *) (&IcmpHdr->IpHead);\r
-\r
+ \r
//\r
// Check the ICMP packet length.\r
//\r
+ if (Pkt->TotalSize < sizeof (IP4_ICMP_ERROR_HEAD)) {\r
+ return EFI_ABORTED;\r
+ }\r
+ \r
+ IcmpHdr = NET_PROTO_HDR (Pkt, IP4_ICMP_ERROR_HEAD);\r
+ IpHdr = (EFI_IP4_HEADER *) (&IcmpHdr->IpHead);\r
+\r
if (Pkt->TotalSize < ICMP_ERRLEN (IpHdr)) {\r
\r
return EFI_ABORTED;\r
TrimBytes = (UINT32) (PayLoadHdr - (UINT8 *) IcmpHdr);\r
\r
NetbufTrim (Pkt, TrimBytes, TRUE);\r
-\r
- IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext);\r
+ \r
+ //\r
+ // If the input packet has invalid format, and TrimBytes is larger than \r
+ // the packet size, the NetbufTrim might trim the packet to zero.\r
+ //\r
+ if (Pkt->TotalSize != 0) {\r
+ IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext);\r
+ }\r
\r
return EFI_SUCCESS; \r
}\r
UINT32 TrimBytes;\r
BOOLEAN Flag;\r
\r
+ ASSERT (IpIo != NULL);\r
+ ASSERT (Pkt != NULL);\r
+ ASSERT (Session != NULL);\r
ASSERT (IpIo->IpVersion == IP_VERSION_6);\r
\r
//\r
\r
NetbufTrim (Pkt, TrimBytes, TRUE);\r
\r
- IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext);\r
+ //\r
+ // If the input packet has invalid format, and TrimBytes is larger than \r
+ // the packet size, the NetbufTrim might trim the packet to zero.\r
+ //\r
+ if (Pkt->TotalSize != 0) {\r
+ IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext);\r
+ }\r
\r
return EFI_SUCCESS;\r
}\r
@param[in] Dest Pointer to the destination IP address.\r
@param[in] Override Pointer to the overriden IP_IO data.\r
\r
- @return Pointer to the data structure created to wrap the packet. If NULL,\r
- @return resource limit occurred.\r
+ @return Pointer to the data structure created to wrap the packet. If any error occurs, \r
+ then return NULL.\r
\r
**/\r
IP_IO_SEND_ENTRY *\r
return;\r
}\r
\r
- if (((EFI_SUCCESS != Status) && (EFI_ICMP_ERROR != Status)) || (NULL == RxData)) {\r
+ if ((EFI_SUCCESS != Status) && (EFI_ICMP_ERROR != Status)) {\r
//\r
- // @bug Only process the normal packets and the icmp error packets, if RxData is NULL\r
- // @bug with Status == EFI_SUCCESS or EFI_ICMP_ERROR, just resume the receive although\r
- // @bug this should be a bug of the low layer (IP).\r
+ // Only process the normal packets and the icmp error packets.\r
//\r
+ if (RxData != NULL) {\r
+ goto CleanUp;\r
+ } else {\r
+ goto Resume;\r
+ }\r
+ }\r
+\r
+ //\r
+ // if RxData is NULL with Status == EFI_SUCCESS or EFI_ICMP_ERROR, this should be a code issue in the low layer (IP).\r
+ //\r
+ ASSERT (RxData != NULL);\r
+ if (RxData == NULL) {\r
goto Resume;\r
}\r
\r
}\r
\r
if (IpIo->IpVersion == IP_VERSION_4) {\r
+ ASSERT (RxData->Ip4RxData.Header != NULL);\r
if (IP4_IS_LOCAL_BROADCAST (EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress))) {\r
//\r
// The source address is a broadcast address, discard it.\r
IP4_NET_EQUAL (IpIo->StationIp, EFI_NTOHL (((EFI_IP4_RECEIVE_DATA *) RxData)->Header->SourceAddress), IpIo->SubnetMask) &&\r
!NetIp4IsUnicast (EFI_NTOHL (((EFI_IP4_RECEIVE_DATA *) RxData)->Header->SourceAddress), IpIo->SubnetMask)) {\r
//\r
- // The source address is not zero and it's not a unicast IP address, discard it.\r
+ // The source address doesn't match StationIp and it's not a unicast IP address, discard it.\r
//\r
goto CleanUp;\r
}\r
goto CleanUp;\r
}\r
\r
+ //\r
+ // The fragment should always be valid for non-zero length packet.\r
+ //\r
+ ASSERT (RxData->Ip4RxData.FragmentCount != 0);\r
+\r
//\r
// Create a netbuffer representing IPv4 packet\r
//\r
Session.IpHdrLen = RxData->Ip4RxData.HeaderLength;\r
Session.IpVersion = IP_VERSION_4;\r
} else {\r
-\r
+ ASSERT (RxData->Ip6RxData.Header != NULL);\r
if (!NetIp6IsValidUnicast(&RxData->Ip6RxData.Header->SourceAddress)) {\r
goto CleanUp;\r
}\r
goto CleanUp;\r
}\r
\r
+ //\r
+ // The fragment should always be valid for non-zero length packet.\r
+ //\r
+ ASSERT (RxData->Ip6RxData.FragmentCount != 0);\r
+ \r
//\r
// Create a netbuffer representing IPv6 packet\r
//\r
\r
/**\r
Create a new IP_IO instance.\r
+\r
+ If IpVersion is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r
\r
This function uses IP4/IP6 service binding protocol in Controller to create\r
an IP4/IP6 child (aka IP4/IP6 instance).\r
Image,\r
&IpIo->ChildHandle,\r
IpVersion, \r
- (VOID **)&(IpIo->Ip)\r
+ (VOID **) & (IpIo->Ip)\r
);\r
if (EFI_ERROR (Status)) {\r
goto ReleaseIpIo;\r
\r
/**\r
Open an IP_IO instance for use.\r
- \r
+\r
+ If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r
+\r
This function is called after IpIoCreate(). It is used for configuring the IP\r
instance and register the callbacks and their context data for sending and\r
receiving IP packets.\r
@param[in] OpenData The configuration data and callbacks for\r
the IP_IO instance.\r
\r
- @retval EFI_SUCCESS The IP_IO instance opened with OpenData\r
- successfully.\r
- @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to \r
- reopen it.\r
- @retval Others Error condition occurred.\r
+ @retval EFI_SUCCESS The IP_IO instance opened with OpenData\r
+ successfully.\r
+ @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to \r
+ reopen it.\r
+ @retval EFI_UNSUPPORTED IPv4 RawData mode is no supported.\r
+ @retval EFI_INVALID_PARAMETER Invalid input parameter.\r
+ @retval Others Error condition occurred.\r
\r
**/\r
EFI_STATUS\r
EFI_STATUS Status;\r
UINT8 IpVersion;\r
\r
+ if (IpIo == NULL || OpenData == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
if (IpIo->IsConfigured) {\r
return EFI_ACCESS_DENIED;\r
}\r
);\r
if (EFI_ERROR (Status)) {\r
IpIo->Ip.Ip4->Configure (IpIo->Ip.Ip4, NULL);\r
- goto ErrorExit;\r
+ return Status;\r
}\r
\r
} else {\r
);\r
if (EFI_ERROR (Status)) {\r
IpIo->Ip.Ip6->Configure (IpIo->Ip.Ip6, NULL);\r
- goto ErrorExit;\r
+ return Status;\r
}\r
}\r
\r
IpIo->IsConfigured = TRUE;\r
InsertTailList (&mActiveIpIoList, &IpIo->Entry);\r
\r
-ErrorExit:\r
-\r
return Status;\r
}\r
\r
\r
/**\r
Stop an IP_IO instance.\r
+\r
+ If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r
\r
This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all\r
the pending send/receive tokens will be canceled.\r
\r
@param[in, out] IpIo Pointer to the IP_IO instance that needs to stop.\r
\r
- @retval EFI_SUCCESS The IP_IO instance stopped successfully.\r
- @retval Others Error condition occurred.\r
+ @retval EFI_SUCCESS The IP_IO instance stopped successfully.\r
+ @retval EFI_INVALID_PARAMETER Invalid input parameter.\r
+ @retval Others Error condition occurred.\r
\r
**/\r
EFI_STATUS\r
IP_IO_IP_INFO *IpInfo;\r
UINT8 IpVersion;\r
\r
+ if (IpIo == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
if (!IpIo->IsConfigured) {\r
return EFI_SUCCESS;\r
}\r
IN OUT IP_IO *IpIo\r
)\r
{\r
+ EFI_STATUS Status;\r
+ \r
//\r
// Stop the IpIo.\r
//\r
- IpIoStop (IpIo);\r
+ Status = IpIoStop (IpIo);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
\r
//\r
// Close the IP protocol and destroy the child.\r
//\r
- IpIoCloseProtocolDestroyIpChild (\r
- IpIo->Controller,\r
- IpIo->Image,\r
- IpIo->ChildHandle,\r
- IpIo->IpVersion\r
- );\r
+ Status = IpIoCloseProtocolDestroyIpChild (\r
+ IpIo->Controller,\r
+ IpIo->Image,\r
+ IpIo->ChildHandle,\r
+ IpIo->IpVersion\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
\r
gBS->FreePool (IpIo);\r
\r
/**\r
Send out an IP packet.\r
\r
- This function is called after IpIoOpen(). The data to be sent are wrapped in\r
+ This function is called after IpIoOpen(). The data to be sent is wrapped in\r
Pkt. The IP instance wrapped in IpIo is used for sending by default but can be\r
overriden by Sender. Other sending configs, like source address and gateway\r
address etc., are specified in OverrideData.\r
@param[in] Context Optional context data.\r
@param[in] NotifyData Optional notify data.\r
@param[in] Dest The destination IP address to send this packet to.\r
+ This parameter is optional when using IPv6.\r
@param[in] OverrideData The data to override some configuration of the IP\r
instance used for sending.\r
\r
@retval EFI_SUCCESS The operation is completed successfully.\r
+ @retval EFI_INVALID_PARAMETER The input parameter is not correct.\r
@retval EFI_NOT_STARTED The IpIo is not configured.\r
@retval EFI_OUT_OF_RESOURCES Failed due to resource limit.\r
+ @retval Others Error condition occurred.\r
\r
**/\r
EFI_STATUS\r
IN IP_IO_IP_INFO *Sender OPTIONAL,\r
IN VOID *Context OPTIONAL,\r
IN VOID *NotifyData OPTIONAL,\r
- IN EFI_IP_ADDRESS *Dest,\r
+ IN EFI_IP_ADDRESS *Dest OPTIONAL,\r
IN IP_IO_OVERRIDE *OverrideData OPTIONAL\r
)\r
{\r
IP_IO_IP_PROTOCOL Ip;\r
IP_IO_SEND_ENTRY *SndEntry;\r
\r
- ASSERT ((IpIo->IpVersion != IP_VERSION_4) || (Dest != NULL));\r
+ if ((IpIo == NULL) || (Pkt == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ if ((IpIo->IpVersion == IP_VERSION_4) && (Dest == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
\r
if (!IpIo->IsConfigured) {\r
return EFI_NOT_STARTED;\r
/**\r
Cancel the IP transmit token which wraps this Packet.\r
\r
+ If IpIo is NULL, then ASSERT().\r
+ If Packet is NULL, then ASSERT().\r
+\r
@param[in] IpIo Pointer to the IP_IO instance.\r
@param[in] Packet Pointer to the packet of NET_BUF to cancel.\r
\r
\r
/**\r
Add a new IP instance for sending data.\r
+\r
+ If IpIo is NULL, then ASSERT().\r
+ If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r
\r
The function is used to add the IP_IO to the IP_IO sending list. The caller\r
can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send\r
if (IpInfo == NULL) {\r
return NULL;\r
}\r
+ ASSERT ((IpInfo->IpVersion == IP_VERSION_4) || (IpInfo->IpVersion == IP_VERSION_6));\r
\r
//\r
// Init this IpInfo, set the Addr and SubnetMask to 0 before we configure the IP\r
Configure the IP instance of this IpInfo and start the receiving if IpConfigData\r
is not NULL.\r
\r
+ If IpInfo is NULL, then ASSERT().\r
+ If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r
+\r
@param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance.\r
@param[in, out] IpConfigData The IP configure data used to configure the IP\r
instance, if NULL the IP instance is reset. If\r
}\r
\r
if (EFI_ERROR (Status)) {\r
- goto OnExit;\r
+ return Status;\r
}\r
\r
if (IpConfigData != NULL) {\r
- if (IpInfo->IpVersion == IP_VERSION_4){\r
+ if (IpInfo->IpVersion == IP_VERSION_4) {\r
\r
if (((EFI_IP4_CONFIG_DATA *) IpConfigData)->UseDefaultAddress) {\r
- Ip.Ip4->GetModeData (\r
- Ip.Ip4, \r
- &Ip4ModeData, \r
- NULL, \r
- NULL\r
- );\r
+ Status = Ip.Ip4->GetModeData (\r
+ Ip.Ip4, \r
+ &Ip4ModeData, \r
+ NULL, \r
+ NULL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ Ip.Ip4->Configure (Ip.Ip4, NULL);\r
+ return Status;\r
+ }\r
\r
IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->StationAddress, &Ip4ModeData.ConfigData.StationAddress);\r
IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->SubnetMask, &Ip4ModeData.ConfigData.SubnetMask);\r
- }\r
+ }\r
\r
CopyMem (\r
&IpInfo->Addr.Addr, \r
Ip.Ip4,\r
&IpInfo->DummyRcvToken.Ip4Token\r
);\r
- if (EFI_ERROR (Status)) {\r
- Ip.Ip4->Configure (Ip.Ip4, NULL);\r
- }\r
- } else {\r
- Ip.Ip6->GetModeData (\r
- Ip.Ip6,\r
- &Ip6ModeData,\r
- NULL,\r
- NULL\r
- );\r
+ if (EFI_ERROR (Status)) {\r
+ Ip.Ip4->Configure (Ip.Ip4, NULL);\r
+ }\r
+ } else {\r
+ Status = Ip.Ip6->GetModeData (\r
+ Ip.Ip6,\r
+ &Ip6ModeData,\r
+ NULL,\r
+ NULL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ Ip.Ip6->Configure (Ip.Ip6, NULL);\r
+ return Status;\r
+ }\r
\r
if (Ip6ModeData.IsConfigured) {\r
CopyMem (\r
\r
} else {\r
Status = EFI_NO_MAPPING;\r
- goto OnExit;\r
+ return Status;\r
} \r
\r
CopyMem (\r
ZeroMem (&IpInfo->PreMask, sizeof (IpInfo->PreMask));\r
}\r
\r
-OnExit:\r
-\r
return Status;\r
}\r
\r
/**\r
Destroy an IP instance maintained in IpIo->IpList for\r
sending purpose.\r
+\r
+ If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r
\r
This function pairs with IpIoAddIp(). The IpInfo is previously created by\r
IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance\r
{\r
\r
UINT8 IpVersion;\r
+ \r
+ if (IpIo == NULL || IpInfo == NULL) {\r
+ return;\r
+ }\r
\r
ASSERT (IpInfo->RefCnt > 0);\r
\r
@param[in] Src The local IP address.\r
\r
@return Pointer to the IP protocol can be used for sending purpose and its local\r
- address is the same with Src.\r
+ address is the same with Src. NULL if failed.\r
\r
**/\r
IP_IO_IP_INFO *\r
LIST_ENTRY *IpInfoEntry;\r
IP_IO_IP_INFO *IpInfo;\r
\r
- ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); \r
+ if (IpIo == NULL || Src == NULL) {\r
+ return NULL;\r
+ }\r
+\r
+ if ((IpVersion != IP_VERSION_4) && (IpVersion != IP_VERSION_6)) {\r
+ return NULL;\r
+ }\r
\r
NET_LIST_FOR_EACH (IpIoEntry, &mActiveIpIoList) {\r
IpIoPtr = NET_LIST_USER_STRUCT (IpIoEntry, IP_IO, Entry);\r
*IpIo = IpIoPtr;\r
return IpInfo; \r
}\r
- } \r
-\r
+ }\r
}\r
}\r
\r
@param[out] IsHard If TRUE, indicates that it is a hard error.\r
@param[out] Notify If TRUE, SockError needs to be notified.\r
\r
+ @retval EFI_UNSUPPORTED Unrecognizable ICMP error code.\r
@return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.\r
\r
**/\r
@retval EFI_INVALID_PARAMETER Neighbor Address is invalid.\r
@retval EFI_NOT_FOUND The neighbor cache entry is not in the \r
neighbor table. \r
+ @retval EFI_UNSUPPORTED IP version is IPv4, which doesn't support neighbor cache refresh.\r
@retval EFI_OUT_OF_RESOURCES Failed due to resource limit.\r
\r
**/\r
EFI_STATUS\r
+EFIAPI\r
IpIoRefreshNeighbor (\r
IN IP_IO *IpIo,\r
IN EFI_IP_ADDRESS *Neighbor,\r
{\r
EFI_IP6_PROTOCOL *Ip;\r
\r
- if (!IpIo->IsConfigured || IpIo->IpVersion != IP_VERSION_6) {\r
+ if (!IpIo->IsConfigured) {\r
return EFI_NOT_STARTED;\r
}\r
\r
+ if (IpIo->IpVersion != IP_VERSION_6) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
Ip = IpIo->Ip.Ip6;\r
\r
return Ip->Neighbors (Ip, FALSE, &Neighbor->v6, NULL, Timeout, TRUE);\r
projects / mirror_edk2.git / blobdiff