/** @file\r
Functions implementation related with DHCPv4 for UefiPxeBc Driver.\r
\r
- Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
\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
- http://opensource.org/licenses/bsd-license.php.\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
\r
/**\r
- Parse the PXE vender options and extract the information from them.\r
+ Parse the PXE vendor options and extract the information from them.\r
\r
@param[in] Dhcp4Option Pointer to vendor options in buffer.\r
@param[in] VendorOption Pointer to structure to store information in vendor options.\r
\r
if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) OptEnt.Uuid->Guid))) {\r
//\r
- // Zero the Guid to indicate NOT programable if failed to get system Guid.\r
+ // Zero the Guid to indicate NOT programmable if failed to get system Guid.\r
//\r
+ DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));\r
ZeroMem (OptEnt.Uuid->Guid, sizeof (EFI_GUID));\r
}\r
\r
@param[in] Dst Pointer to the cache buffer for DHCPv4 packet.\r
@param[in] Src Pointer to the DHCPv4 packet to be cached.\r
\r
+ @retval EFI_SUCCESS Packet is copied.\r
+ @retval EFI_BUFFER_TOO_SMALL Cache buffer is not big enough to hold the packet.\r
+\r
**/\r
-VOID\r
+EFI_STATUS\r
PxeBcCacheDhcp4Packet (\r
IN EFI_DHCP4_PACKET *Dst,\r
IN EFI_DHCP4_PACKET *Src\r
)\r
{\r
- ASSERT (Dst->Size >= Src->Length);\r
+ if (Dst->Size < Src->Length) {\r
+ return EFI_BUFFER_TOO_SMALL;\r
+ }\r
\r
CopyMem (&Dst->Dhcp4, &Src->Dhcp4, Src->Length);\r
Dst->Length = Src->Length;\r
+\r
+ return EFI_SUCCESS;\r
}\r
\r
\r
);\r
}\r
//\r
- // Second, Check if bootfilename and serverhostname is overloaded to carry DHCP options refers to rfc-2132. \r
+ // Second, Check if bootfilename and serverhostname is overloaded to carry DHCP options refers to rfc-2132.\r
// If yes, try to parse options from the BootFileName field, then ServerName field.\r
//\r
Option = Options[PXEBC_DHCP4_TAG_INDEX_OVERLOAD];\r
@param[in] Ack Pointer to the DHCPv4 ack packet.\r
@param[in] Verified If TRUE, parse the ACK packet and store info into mode data.\r
\r
+ @retval EFI_SUCCESS Cache and parse the packet successfully.\r
+ @retval EFI_BUFFER_TOO_SMALL Cache buffer is not big enough to hold the packet.\r
+\r
**/\r
-VOID\r
+EFI_STATUS\r
PxeBcCopyDhcp4Ack (\r
IN PXEBC_PRIVATE_DATA *Private,\r
IN EFI_DHCP4_PACKET *Ack,\r
)\r
{\r
EFI_PXE_BASE_CODE_MODE *Mode;\r
+ EFI_STATUS Status;\r
\r
Mode = Private->PxeBc.Mode;\r
\r
- PxeBcCacheDhcp4Packet (&Private->DhcpAck.Dhcp4.Packet.Ack, Ack);\r
+ Status = PxeBcCacheDhcp4Packet (&Private->DhcpAck.Dhcp4.Packet.Ack, Ack);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
\r
if (Verified) {\r
//\r
CopyMem (&Mode->DhcpAck.Dhcpv4, &Ack->Dhcp4, Ack->Length);\r
Mode->DhcpAckReceived = TRUE;\r
}\r
+\r
+ return EFI_SUCCESS;\r
}\r
\r
\r
@param[in] Private Pointer to PxeBc private data.\r
@param[in] OfferIndex The received order of offer packets.\r
\r
+ @retval EFI_SUCCESS Cache and parse the packet successfully.\r
+ @retval EFI_BUFFER_TOO_SMALL Cache buffer is not big enough to hold the packet.\r
+\r
**/\r
-VOID\r
+EFI_STATUS\r
PxeBcCopyProxyOffer (\r
IN PXEBC_PRIVATE_DATA *Private,\r
IN UINT32 OfferIndex\r
{\r
EFI_PXE_BASE_CODE_MODE *Mode;\r
EFI_DHCP4_PACKET *Offer;\r
+ EFI_STATUS Status;\r
\r
ASSERT (OfferIndex < Private->OfferNum);\r
ASSERT (OfferIndex < PXEBC_OFFER_MAX_NUM);\r
//\r
// Cache the proxy offer packet and parse it.\r
//\r
- PxeBcCacheDhcp4Packet (&Private->ProxyOffer.Dhcp4.Packet.Offer, Offer);\r
+ Status = PxeBcCacheDhcp4Packet (&Private->ProxyOffer.Dhcp4.Packet.Offer, Offer);\r
+ if (EFI_ERROR(Status)) {\r
+ return Status;\r
+ }\r
+\r
PxeBcParseDhcp4Packet (&Private->ProxyOffer.Dhcp4);\r
\r
//\r
//\r
CopyMem (&Mode->ProxyOffer.Dhcpv4, &Offer->Dhcp4, Offer->Length);\r
Mode->ProxyOfferReceived = TRUE;\r
+\r
+ return EFI_SUCCESS;\r
}\r
\r
\r
@param[in] Private Pointer to PxeBc private data.\r
@param[in] RcvdOffer Pointer to the received offer packet.\r
\r
+ @retval EFI_SUCCESS Cache and parse the packet successfully.\r
+ @retval Others Operation failed.\r
+\r
**/\r
-VOID\r
+EFI_STATUS\r
PxeBcCacheDhcp4Offer (\r
IN PXEBC_PRIVATE_DATA *Private,\r
IN EFI_DHCP4_PACKET *RcvdOffer\r
PXEBC_DHCP4_PACKET_CACHE *Cache4;\r
EFI_DHCP4_PACKET *Offer;\r
PXEBC_OFFER_TYPE OfferType;\r
+ EFI_STATUS Status;\r
\r
ASSERT (Private->OfferNum < PXEBC_OFFER_MAX_NUM);\r
Cache4 = &Private->OfferBuffer[Private->OfferNum].Dhcp4;\r
//\r
// Cache the content of DHCPv4 packet firstly.\r
//\r
- PxeBcCacheDhcp4Packet (Offer, RcvdOffer);\r
+ Status = PxeBcCacheDhcp4Packet (Offer, RcvdOffer);\r
+ if (EFI_ERROR(Status)) {\r
+ return Status;\r
+ }\r
\r
//\r
// Validate the DHCPv4 packet, and parse the options and offer type.\r
//\r
if (EFI_ERROR (PxeBcParseDhcp4Packet (Cache4))) {\r
- return;\r
+ return EFI_ABORTED;\r
}\r
\r
//\r
Private->OfferIndex[OfferType][0] = Private->OfferNum;\r
Private->OfferCount[OfferType] = 1;\r
} else {\r
- return;\r
+ return EFI_ABORTED;\r
}\r
} else {\r
ASSERT (Private->OfferCount[OfferType] < PXEBC_OFFER_MAX_NUM);\r
//\r
Private->OfferIndex[OfferType][Private->OfferCount[OfferType]] = Private->OfferNum;\r
Private->OfferCount[OfferType]++;\r
- } else if (Private->OfferCount[OfferType] > 0) {\r
+ } else if ((OfferType == PxeOfferTypeProxyPxe10 || OfferType == PxeOfferTypeProxyWfm11a) &&\r
+ Private->OfferCount[OfferType] < 1) {\r
//\r
// Only cache the first PXE10/WFM11a offer, and discard the others.\r
//\r
Private->OfferIndex[OfferType][0] = Private->OfferNum;\r
Private->OfferCount[OfferType] = 1;\r
} else {\r
- return ;\r
+ return EFI_ABORTED;\r
}\r
} else {\r
//\r
}\r
\r
Private->OfferNum++;\r
+\r
+ return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
Handle the DHCPv4 offer packet.\r
\r
- @param[in] Private Pointer to PxeBc private data.\r
+ @param[in] Private Pointer to PxeBc private data.\r
\r
- @retval EFI_SUCCESS Handled the DHCPv4 offer packet successfully.\r
- @retval EFI_NO_RESPONSE No response to the following request packet.\r
- @retval EFI_NOT_FOUND No boot filename received.\r
+ @retval EFI_SUCCESS Handled the DHCPv4 offer packet successfully.\r
+ @retval EFI_NO_RESPONSE No response to the following request packet.\r
+ @retval EFI_NOT_FOUND No boot filename received.\r
+ @retval EFI_BUFFER_TOO_SMALL Can't cache the offer pacet.\r
\r
**/\r
EFI_STATUS\r
//\r
// Success to try to request by a ProxyPxe10 or ProxyWfm11a offer, copy and parse it.\r
//\r
- PxeBcCopyProxyOffer (Private, ProxyIndex);\r
+ Status = PxeBcCopyProxyOffer (Private, ProxyIndex);\r
}\r
} else {\r
//\r
- // Othewise, the bootfile name must be included in DhcpOnly offer.\r
+ // Otherwise, the bootfile name must be included in DhcpOnly offer.\r
//\r
if (Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] == NULL) {\r
Status = EFI_NOT_FOUND;\r
Ack = Offer;\r
}\r
\r
- PxeBcCopyDhcp4Ack (Private, Ack, TRUE);\r
+ Status = PxeBcCopyDhcp4Ack (Private, Ack, TRUE);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
Mode->DhcpDiscoverValid = TRUE;\r
}\r
\r
return EFI_SUCCESS;\r
}\r
\r
+ ASSERT (Packet != NULL);\r
+\r
Private = (PXEBC_PRIVATE_DATA *) Context;\r
Mode = Private->PxeBc.Mode;\r
Callback = Private->PxeBcCallback;\r
Status = EFI_ABORTED;\r
break;\r
}\r
- \r
+\r
if (Mode->SendGUID) {\r
//\r
// Send the system Guid instead of the MAC address as the hardware address if required.\r
//\r
if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) Packet->Dhcp4.Header.ClientHwAddr))) {\r
//\r
- // Zero the Guid to indicate NOT programable if failed to get system Guid.\r
+ // Zero the Guid to indicate NOT programmable if failed to get system Guid.\r
//\r
+ DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));\r
ZeroMem (Packet->Dhcp4.Header.ClientHwAddr, sizeof (EFI_GUID));\r
}\r
Packet->Dhcp4.Header.HwAddrLen = (UINT8) sizeof (EFI_GUID);\r
//\r
// Cache the DHCPv4 offers to OfferBuffer[] for select later, and record\r
// the OfferIndex and OfferCount.\r
+ // If error happens, just ignore this packet and continue to wait more offer.\r
//\r
PxeBcCacheDhcp4Offer (Private, Packet);\r
}\r
break;\r
\r
case Dhcp4SelectOffer:\r
+ ASSERT (NewPacket != NULL);\r
+\r
//\r
// Select offer by the default policy or by order, and record the SelectIndex\r
// and SelectProxyType.\r
break;\r
\r
case Dhcp4RcvdAck:\r
- if (Packet->Length > PXEBC_DHCP4_PACKET_MAX_SIZE) {\r
- //\r
- // Abort the DHCP if the ACK packet exceeds the maximum length.\r
- //\r
- Status = EFI_ABORTED;\r
- break;\r
- }\r
-\r
//\r
// Cache the DHCPv4 ack to Private->Dhcp4Ack, but it's not the final ack in mode data\r
// without verification.\r
//\r
ASSERT (Private->SelectIndex != 0);\r
\r
- PxeBcCopyDhcp4Ack (Private, Packet, FALSE);\r
+ Status = PxeBcCopyDhcp4Ack (Private, Packet, FALSE);\r
+ if (EFI_ERROR (Status)) {\r
+ Status = EFI_ABORTED;\r
+ }\r
break;\r
\r
default:\r
if (Mode->SendGUID) {\r
if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) Token.Packet->Dhcp4.Header.ClientHwAddr))) {\r
//\r
- // Zero the Guid to indicate NOT programable if failed to get system Guid.\r
+ // Zero the Guid to indicate NOT programmable if failed to get system Guid.\r
//\r
+ DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));\r
ZeroMem (Token.Packet->Dhcp4.Header.ClientHwAddr, sizeof (EFI_GUID));\r
}\r
Token.Packet->Dhcp4.Header.HwAddrLen = (UINT8) sizeof (EFI_GUID);\r
// Find the right PXE Reply according to server address.\r
//\r
while (RepIndex < Token.ResponseCount) {\r
+ if (Response->Length > PXEBC_DHCP4_PACKET_MAX_SIZE) {\r
+ SrvIndex = 0;\r
+ RepIndex++;\r
+ Response = (EFI_DHCP4_PACKET *) ((UINT8 *) Response + Response->Size);\r
+ continue;\r
+ }\r
\r
while (SrvIndex < IpCount) {\r
if (SrvList[SrvIndex].AcceptAnyResponse) {\r
\r
SrvIndex = 0;\r
RepIndex++;\r
-\r
Response = (EFI_DHCP4_PACKET *) ((UINT8 *) Response + Response->Size);\r
}\r
\r
// Especially for PXE discover packet, store it into mode data here.\r
//\r
if (Private->IsDoDiscover) {\r
- PxeBcCacheDhcp4Packet (&Private->PxeReply.Dhcp4.Packet.Ack, Response);\r
+ Status = PxeBcCacheDhcp4Packet (&Private->PxeReply.Dhcp4.Packet.Ack, Response);\r
+ if (EFI_ERROR(Status)) {\r
+ goto ON_EXIT;\r
+ }\r
CopyMem (&Mode->PxeDiscover, &Token.Packet->Dhcp4, Token.Packet->Length);\r
} else {\r
- PxeBcCacheDhcp4Packet (&Private->ProxyOffer.Dhcp4.Packet.Offer, Response);\r
+ Status = PxeBcCacheDhcp4Packet (&Private->ProxyOffer.Dhcp4.Packet.Offer, Response);\r
+ if (EFI_ERROR(Status)) {\r
+ goto ON_EXIT;\r
+ }\r
}\r
} else {\r
//\r
//\r
Status = EFI_NOT_FOUND;\r
}\r
- if (Token.ResponseList != NULL) {\r
- FreePool (Token.ResponseList);\r
- }\r
}\r
+ON_EXIT:\r
\r
- FreePool (Token.Packet);\r
+ if (Token.ResponseList != NULL) {\r
+ FreePool (Token.ResponseList);\r
+ }\r
+ if (Token.Packet != NULL) {\r
+ FreePool (Token.Packet);\r
+ }\r
return Status;\r
}\r
\r
\r
**/\r
EFI_STATUS\r
-PxeBcSetIp4Policy ( \r
+PxeBcSetIp4Policy (\r
IN PXEBC_PRIVATE_DATA *Private\r
)\r
{\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
- \r
+\r
if (Policy != Ip4Config2PolicyStatic) {\r
Policy = Ip4Config2PolicyStatic;\r
Status= Ip4Config2->SetData (\r
);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
- } \r
+ }\r
}\r
\r
return EFI_SUCCESS;\r
ZeroMem (Private->OfferCount, sizeof (Private->OfferCount));\r
ZeroMem (Private->OfferIndex, sizeof (Private->OfferIndex));\r
\r
- //\r
- // Start DHCPv4 D.O.R.A. process to acquire IPv4 address. This may \r
- // have already been done, thus do not leave in error if the return\r
- // code is EFI_ALREADY_STARTED.\r
- //\r
Status = Dhcp4->Start (Dhcp4, NULL);\r
- if (EFI_ERROR (Status) && Status != EFI_ALREADY_STARTED) {\r
+ if (EFI_ERROR (Status)) {\r
if (Status == EFI_ICMP_ERROR) {\r
PxeMode->IcmpErrorReceived = TRUE;\r
}\r
+\r
+ if (Status == EFI_TIMEOUT && Private->OfferNum > 0) {\r
+ Status = EFI_NO_RESPONSE;\r
+ }\r
+\r
goto ON_EXIT;\r
}\r
\r
projects / mirror_edk2.git / blobdiff