[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Icmp.c

/** @file\r
\r
Copyright (c) 2005 - 2009, 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
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
\r
**/\r
\r
#include "Ip4Impl.h"\r
\r
IP4_ICMP_CLASS\r
mIcmpClass[] = {\r
  {ICMP_ECHO_REPLY,         ICMP_QUERY_MESSAGE  },\r
  {1,                       ICMP_INVALID_MESSAGE},\r
  {2,                       ICMP_INVALID_MESSAGE},\r
  {ICMP_DEST_UNREACHABLE,   ICMP_ERROR_MESSAGE  },\r
  {ICMP_SOURCE_QUENCH,      ICMP_ERROR_MESSAGE  },\r
  {ICMP_REDIRECT,           ICMP_ERROR_MESSAGE  },\r
  {6,                       ICMP_INVALID_MESSAGE},\r
  {7,                       ICMP_INVALID_MESSAGE},\r
  {ICMP_ECHO_REQUEST,       ICMP_QUERY_MESSAGE  },\r
  {9,                       ICMP_INVALID_MESSAGE},\r
  {10,                      ICMP_INVALID_MESSAGE},\r
  {ICMP_TIME_EXCEEDED,      ICMP_ERROR_MESSAGE  },\r
  {ICMP_PARAMETER_PROBLEM,  ICMP_ERROR_MESSAGE  },\r
  {ICMP_TIMESTAMP ,         ICMP_QUERY_MESSAGE  },\r
  {14,                      ICMP_INVALID_MESSAGE},\r
  {ICMP_INFO_REQUEST ,      ICMP_QUERY_MESSAGE  },\r
  {ICMP_INFO_REPLY ,        ICMP_QUERY_MESSAGE  },\r
};\r
\r
EFI_IP4_ICMP_TYPE\r
mIp4SupportedIcmp[23] = {\r
  {ICMP_ECHO_REPLY,        ICMP_DEFAULT_CODE        },\r
\r
  {ICMP_DEST_UNREACHABLE,  ICMP_NET_UNREACHABLE     },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_HOST_UNREACHABLE    },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_PROTO_UNREACHABLE   },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_PORT_UNREACHABLE    },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_FRAGMENT_FAILED     },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_SOURCEROUTE_FAILED  },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_NET_UNKNOWN         },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_HOST_UNKNOWN        },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_SOURCE_ISOLATED     },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_NET_PROHIBITED      },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_HOST_PROHIBITED     },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_NET_UNREACHABLE_TOS },\r
  {ICMP_DEST_UNREACHABLE,  ICMP_HOST_UNREACHABLE_TOS},\r
\r
  {ICMP_SOURCE_QUENCH,     ICMP_DEFAULT_CODE        },\r
\r
  {ICMP_REDIRECT,          ICMP_NET_REDIRECT        },\r
  {ICMP_REDIRECT,          ICMP_HOST_REDIRECT       },\r
  {ICMP_REDIRECT,          ICMP_NET_TOS_REDIRECT    },\r
  {ICMP_REDIRECT,          ICMP_HOST_TOS_REDIRECT   },\r
\r
  {ICMP_ECHO_REQUEST,      ICMP_DEFAULT_CODE        },\r
\r
  {ICMP_TIME_EXCEEDED,     ICMP_TIMEOUT_IN_TRANSIT  },\r
  {ICMP_TIME_EXCEEDED,     ICMP_TIMEOUT_REASSEMBLE  },\r
\r
  {ICMP_PARAMETER_PROBLEM, ICMP_DEFAULT_CODE        },\r
};\r
\r
\r
\r
/**\r
  Process the ICMP redirect. Find the instance then update\r
  its route cache.\r
  \r
  All kinds of redirect is treated as host redirect as\r
  specified by RFC1122 3.3.1.2:\r
  "Since the subnet mask appropriate to the destination\r
  address is generally not known, a Network Redirect\r
  message SHOULD be treated identically to a Host Redirect\r
  message;"\r
\r
  @param[in]  IpSb               The IP4 service binding instance that received \r
                                 the packet.\r
  @param[in]  Head               The IP head of the received ICMPpacket.\r
  @param[in]  Packet             The content of the ICMP redirect packet with IP\r
                                 head removed.\r
  @param[in]  Icmp               The buffer to store the ICMP error message if\r
                                 something is wrong.\r
\r
  @retval EFI_INVALID_PARAMETER  The parameter is invalid\r
  @retval EFI_SUCCESS            Successfully updated the route caches\r
\r
**/\r
EFI_STATUS\r
Ip4ProcessIcmpRedirect (\r
  IN IP4_SERVICE            *IpSb,\r
  IN IP4_HEAD               *Head,\r
  IN NET_BUF                *Packet,\r
  IN IP4_ICMP_ERROR_HEAD    *Icmp\r
  )\r
{\r
  LIST_ENTRY                *Entry;\r
  IP4_PROTOCOL              *Ip4Instance;\r
  IP4_ROUTE_CACHE_ENTRY     *CacheEntry;\r
  IP4_INTERFACE             *IpIf;\r
  IP4_ADDR                  Gateway;\r
  IP4_ADDR                  Src;\r
  IP4_ADDR                  Dst;\r
\r
  //\r
  // Find the interface whose IP address is the source of the\r
  // orgianl IP packet.\r
  //\r
  IpIf    = Ip4FindInterface (IpSb, NTOHL (Icmp->IpHead.Src));\r
  Gateway = NTOHL (Icmp->Fourth);\r
\r
  //\r
  // discard the packet if the new gateway address it specifies\r
  // is not on the same connected net through which the Redirect\r
  // arrived. (RFC1122 3.2.2.2).\r
  //\r
  if ((IpIf == NULL) || !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask)) {\r
    NetbufFree (Packet);\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Update each IP child's route cache on the interface.\r
  //\r
  NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) {\r
    Ip4Instance = NET_LIST_USER_STRUCT (Entry, IP4_PROTOCOL, AddrLink);\r
\r
    if (Ip4Instance->RouteTable == NULL) {\r
      continue;\r
    }\r
\r
    Dst = NTOHL (Icmp->IpHead.Dst);\r
    Src = NTOHL (Icmp->IpHead.Src);\r
    CacheEntry = Ip4FindRouteCache (Ip4Instance->RouteTable, Dst, Src);\r
\r
    //\r
    // Only update the route cache's gateway if the source of the\r
    // Redirect is the current first-hop gateway\r
    //\r
    if ((CacheEntry != NULL) && (NTOHL (Head->Src) == CacheEntry->NextHop)) {\r
      CacheEntry->NextHop = Gateway;\r
    }\r
  }\r
\r
  NetbufFree (Packet);\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Process the ICMP error packet. If it is an ICMP redirect packet,\r
  update call Ip4ProcessIcmpRedirect to update the IP instance's\r
  route cache, otherwise, deliver the packet to upper layer.\r
\r
  @param[in]  IpSb               The IP service that received the packet.\r
  @param[in]  Head               The IP head of the ICMP error packet\r
  @param[in]  Packet             The content of the ICMP error with IP head\r
                                 removed.\r
\r
  @retval EFI_SUCCESS            The ICMP error is processed successfully.\r
  @retval EFI_INVALID_PARAMETER  The packet is invalid\r
  @retval Others                 Failed to process the packet.\r
  \r
**/\r
EFI_STATUS\r
Ip4ProcessIcmpError (\r
  IN IP4_SERVICE            *IpSb,\r
  IN IP4_HEAD               *Head,\r
  IN NET_BUF                *Packet\r
  )\r
{\r
  IP4_ICMP_ERROR_HEAD       Icmp;\r
\r
  if (Packet->TotalSize < sizeof (Icmp)) {\r
    NetbufFree (Packet);\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp);\r
\r
  //\r
  // If it is an ICMP redirect error, update the route cache\r
  // as RFC1122. Otherwise, demultiplex it to IP instances.\r
  //\r
  if (Icmp.Head.Type == ICMP_REDIRECT) {\r
    return Ip4ProcessIcmpRedirect (IpSb, Head, Packet, &Icmp);\r
  }\r
\r
  IP4_GET_CLIP_INFO (Packet)->Status = EFI_ICMP_ERROR;\r
  return Ip4Demultiplex (IpSb, Head, Packet);\r
}\r
\r
\r
/**\r
  Replay an ICMP echo request.\r
\r
  @param[in]  IpSb               The IP service that receivd the packet\r
  @param[in]  Head               The IP head of the ICMP error packet\r
  @param[in]  Packet             The content of the ICMP error with IP head\r
                                 removed.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resource.\r
  @retval EFI_SUCCESS            The ICMP Echo request is successfully answered.\r
  @retval Others                 Failed to answer the ICMP echo request.\r
\r
**/\r
EFI_STATUS\r
Ip4IcmpReplyEcho (\r
  IN IP4_SERVICE            *IpSb,\r
  IN IP4_HEAD               *Head,\r
  IN NET_BUF                *Packet\r
  )\r
{\r
  IP4_ICMP_QUERY_HEAD       *Icmp;\r
  NET_BUF                   *Data;\r
  EFI_STATUS                Status;\r
  IP4_HEAD                  ReplyHead;\r
\r
  //\r
  // make a copy the packet, it is really a bad idea to\r
  // send the MNP's buffer back to MNP.\r
  //\r
  Data = NetbufDuplicate (Packet, NULL, IP4_MAX_HEADLEN);\r
\r
  if (Data == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Change the ICMP type to echo reply, exchange the source\r
  // and destination, then send it. The source is updated to\r
  // use specific destination. See RFC1122. SRR/RR option\r
  // update is omitted.\r
  //\r
  Icmp                = (IP4_ICMP_QUERY_HEAD *) NetbufGetByte (Data, 0, NULL);\r
  Icmp->Head.Type     = ICMP_ECHO_REPLY;\r
  Icmp->Head.Checksum = 0;\r
  Icmp->Head.Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Icmp, Data->TotalSize));\r
\r
  ReplyHead.Tos       = 0;\r
  ReplyHead.Fragment  = 0;\r
  ReplyHead.Ttl       = 64;\r
  ReplyHead.Protocol  = EFI_IP_PROTO_ICMP;\r
  ReplyHead.Src       = 0;\r
\r
  //\r
  // Ip4Output will select a source for us\r
  //\r
  ReplyHead.Dst = Head->Src;\r
\r
  Status = Ip4Output (\r
             IpSb,\r
             NULL,\r
             Data,\r
             &ReplyHead,\r
             NULL,\r
             0,\r
             IP4_ALLZERO_ADDRESS,\r
             Ip4SysPacketSent,\r
             NULL\r
             );\r
\r
ON_EXIT:\r
  NetbufFree (Packet);\r
  return Status;\r
}\r
\r
\r
/**\r
  Process the ICMP query message. If it is an ICMP echo\r
  request, answer it. Otherwise deliver it to upper layer.\r
\r
  @param[in]  IpSb               The IP service that receivd the packet\r
  @param[in]  Head               The IP head of the ICMP query packet\r
  @param[in]  Packet             The content of the ICMP query with IP head\r
                                 removed.\r
\r
  @retval EFI_INVALID_PARAMETER  The packet is invalid\r
  @retval EFI_SUCCESS            The ICMP query message is processed\r
  @retval Others                 Failed to process ICMP query.\r
\r
**/\r
EFI_STATUS\r
Ip4ProcessIcmpQuery (\r
  IN IP4_SERVICE            *IpSb,\r
  IN IP4_HEAD               *Head,\r
  IN NET_BUF                *Packet\r
  )\r
{\r
  IP4_ICMP_QUERY_HEAD       Icmp;\r
\r
  if (Packet->TotalSize < sizeof (Icmp)) {\r
    NetbufFree (Packet);\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp);\r
\r
  if (Icmp.Head.Type == ICMP_ECHO_REQUEST) {\r
    return Ip4IcmpReplyEcho (IpSb, Head, Packet);\r
  }\r
\r
  return Ip4Demultiplex (IpSb, Head, Packet);\r
}\r
\r
\r
/**\r
  Handle the ICMP packet. First validate the message format,\r
  then according to the message types, process it as query or\r
  error packet.\r
\r
  @param[in]  IpSb               The IP service that receivd the packet\r
  @param[in]  Head               The IP head of the ICMP query packet\r
  @param[in]  Packet             The content of the ICMP query with IP head\r
                                 removed.\r
\r
  @retval EFI_INVALID_PARAMETER  The packet is malformated.\r
  @retval EFI_SUCCESS            The ICMP message is successfully processed.\r
  @retval Others                 Failed to handle ICMP packet.\r
\r
**/\r
EFI_STATUS\r
Ip4IcmpHandle (\r
  IN IP4_SERVICE            *IpSb,\r
  IN IP4_HEAD               *Head,\r
  IN NET_BUF                *Packet\r
  )\r
{\r
  IP4_ICMP_HEAD             Icmp;\r
  UINT16                    Checksum;\r
\r
  if (Packet->TotalSize < sizeof (Icmp)) {\r
    goto DROP;\r
  }\r
\r
  NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp);\r
\r
  if (Icmp.Type > ICMP_TYPE_MAX) {\r
    goto DROP;\r
  }\r
\r
  Checksum = (UINT16) (~NetbufChecksum (Packet));\r
  if ((Icmp.Checksum != 0) && (Checksum != 0)) {\r
    goto DROP;\r
  }\r
\r
  if (mIcmpClass[Icmp.Type].IcmpClass == ICMP_ERROR_MESSAGE) {\r
    return Ip4ProcessIcmpError (IpSb, Head, Packet);\r
\r
  } else if (mIcmpClass[Icmp.Type].IcmpClass == ICMP_QUERY_MESSAGE) {\r
    return Ip4ProcessIcmpQuery (IpSb, Head, Packet);\r
\r
  }\r
\r
DROP:\r
  NetbufFree (Packet);\r
  return EFI_INVALID_PARAMETER;\r
}\r
Commit	Line	Data
772db4bb	1	/** @file\r
772db4bb	2	\r
e5eed7d3 HT	3	Copyright (c) 2005 - 2009, Intel Corporation. All rights reserved.<BR>\r
e5eed7d3 HT	4	This program and the accompanying materials\r
772db4bb	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
772db4bb	12	**/\r
	13	\r
	14	#include "Ip4Impl.h"\r
	15	\r
	16	IP4_ICMP_CLASS\r
	17	mIcmpClass[] = {\r
	18	{ICMP_ECHO_REPLY, ICMP_QUERY_MESSAGE },\r
	19	{1, ICMP_INVALID_MESSAGE},\r
	20	{2, ICMP_INVALID_MESSAGE},\r
	21	{ICMP_DEST_UNREACHABLE, ICMP_ERROR_MESSAGE },\r
	22	{ICMP_SOURCE_QUENCH, ICMP_ERROR_MESSAGE },\r
	23	{ICMP_REDIRECT, ICMP_ERROR_MESSAGE },\r
	24	{6, ICMP_INVALID_MESSAGE},\r
	25	{7, ICMP_INVALID_MESSAGE},\r
	26	{ICMP_ECHO_REQUEST, ICMP_QUERY_MESSAGE },\r
	27	{9, ICMP_INVALID_MESSAGE},\r
	28	{10, ICMP_INVALID_MESSAGE},\r
	29	{ICMP_TIME_EXCEEDED, ICMP_ERROR_MESSAGE },\r
	30	{ICMP_PARAMETER_PROBLEM, ICMP_ERROR_MESSAGE },\r
	31	{ICMP_TIMESTAMP , ICMP_QUERY_MESSAGE },\r
	32	{14, ICMP_INVALID_MESSAGE},\r
	33	{ICMP_INFO_REQUEST , ICMP_QUERY_MESSAGE },\r
	34	{ICMP_INFO_REPLY , ICMP_QUERY_MESSAGE },\r
	35	};\r
	36	\r
	37	EFI_IP4_ICMP_TYPE\r
5405e9a6	38	mIp4SupportedIcmp[23] = {\r
	39	{ICMP_ECHO_REPLY, ICMP_DEFAULT_CODE },\r
	40	\r
	41	{ICMP_DEST_UNREACHABLE, ICMP_NET_UNREACHABLE },\r
	42	{ICMP_DEST_UNREACHABLE, ICMP_HOST_UNREACHABLE },\r
	43	{ICMP_DEST_UNREACHABLE, ICMP_PROTO_UNREACHABLE },\r
	44	{ICMP_DEST_UNREACHABLE, ICMP_PORT_UNREACHABLE },\r
	45	{ICMP_DEST_UNREACHABLE, ICMP_FRAGMENT_FAILED },\r
	46	{ICMP_DEST_UNREACHABLE, ICMP_SOURCEROUTE_FAILED },\r
	47	{ICMP_DEST_UNREACHABLE, ICMP_NET_UNKNOWN },\r
	48	{ICMP_DEST_UNREACHABLE, ICMP_HOST_UNKNOWN },\r
	49	{ICMP_DEST_UNREACHABLE, ICMP_SOURCE_ISOLATED },\r
	50	{ICMP_DEST_UNREACHABLE, ICMP_NET_PROHIBITED },\r
	51	{ICMP_DEST_UNREACHABLE, ICMP_HOST_PROHIBITED },\r
772db4bb	52	{ICMP_DEST_UNREACHABLE, ICMP_NET_UNREACHABLE_TOS },\r
	53	{ICMP_DEST_UNREACHABLE, ICMP_HOST_UNREACHABLE_TOS},\r
	54	\r
5405e9a6	55	{ICMP_SOURCE_QUENCH, ICMP_DEFAULT_CODE },\r
772db4bb	56	\r
5405e9a6	57	{ICMP_REDIRECT, ICMP_NET_REDIRECT },\r
	58	{ICMP_REDIRECT, ICMP_HOST_REDIRECT },\r
	59	{ICMP_REDIRECT, ICMP_NET_TOS_REDIRECT },\r
	60	{ICMP_REDIRECT, ICMP_HOST_TOS_REDIRECT },\r
772db4bb	61	\r
5405e9a6	62	{ICMP_ECHO_REQUEST, ICMP_DEFAULT_CODE },\r
772db4bb	63	\r
5405e9a6	64	{ICMP_TIME_EXCEEDED, ICMP_TIMEOUT_IN_TRANSIT },\r
f6b7393c	65	{ICMP_TIME_EXCEEDED, ICMP_TIMEOUT_REASSEMBLE },\r
772db4bb	66	\r
5405e9a6	67	{ICMP_PARAMETER_PROBLEM, ICMP_DEFAULT_CODE },\r
772db4bb	68	};\r
	69	\r
	70	\r
	71	\r
	72	/**\r
	73	Process the ICMP redirect. Find the instance then update\r
	74	its route cache.\r
5405e9a6	75	\r
772db4bb	76	All kinds of redirect is treated as host redirect as\r
	77	specified by RFC1122 3.3.1.2:\r
	78	"Since the subnet mask appropriate to the destination\r
	79	address is generally not known, a Network Redirect\r
	80	message SHOULD be treated identically to a Host Redirect\r
	81	message;"\r
	82	\r
3e8c18da	83	@param[in] IpSb The IP4 service binding instance that received \r
	84	the packet.\r
	85	@param[in] Head The IP head of the received ICMPpacket.\r
	86	@param[in] Packet The content of the ICMP redirect packet with IP\r
772db4bb	87	head removed.\r
3e8c18da	88	@param[in] Icmp The buffer to store the ICMP error message if\r
772db4bb	89	something is wrong.\r
	90	\r
	91	@retval EFI_INVALID_PARAMETER The parameter is invalid\r
	92	@retval EFI_SUCCESS Successfully updated the route caches\r
	93	\r
	94	**/\r
772db4bb	95	EFI_STATUS\r
	96	Ip4ProcessIcmpRedirect (\r
	97	IN IP4_SERVICE *IpSb,\r
	98	IN IP4_HEAD *Head,\r
	99	IN NET_BUF *Packet,\r
	100	IN IP4_ICMP_ERROR_HEAD *Icmp\r
	101	)\r
	102	{\r
e48e37fc	103	LIST_ENTRY *Entry;\r
772db4bb	104	IP4_PROTOCOL *Ip4Instance;\r
	105	IP4_ROUTE_CACHE_ENTRY *CacheEntry;\r
	106	IP4_INTERFACE *IpIf;\r
	107	IP4_ADDR Gateway;\r
1204fe83	108	IP4_ADDR Src;\r
1204fe83	109	IP4_ADDR Dst;\r
772db4bb	110	\r
	111	//\r
	112	// Find the interface whose IP address is the source of the\r
	113	// orgianl IP packet.\r
	114	//\r
	115	IpIf = Ip4FindInterface (IpSb, NTOHL (Icmp->IpHead.Src));\r
	116	Gateway = NTOHL (Icmp->Fourth);\r
	117	\r
	118	//\r
	119	// discard the packet if the new gateway address it specifies\r
	120	// is not on the same connected net through which the Redirect\r
	121	// arrived. (RFC1122 3.2.2.2).\r
	122	//\r
	123	if ((IpIf == NULL) \|\| !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask)) {\r
	124	NetbufFree (Packet);\r
	125	return EFI_INVALID_PARAMETER;\r
	126	}\r
	127	\r
	128	//\r
	129	// Update each IP child's route cache on the interface.\r
	130	//\r
	131	NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) {\r
	132	Ip4Instance = NET_LIST_USER_STRUCT (Entry, IP4_PROTOCOL, AddrLink);\r
	133	\r
	134	if (Ip4Instance->RouteTable == NULL) {\r
	135	continue;\r
	136	}\r
	137	\r
1204fe83	138	Dst = NTOHL (Icmp->IpHead.Dst);\r
	139	Src = NTOHL (Icmp->IpHead.Src);\r
	140	CacheEntry = Ip4FindRouteCache (Ip4Instance->RouteTable, Dst, Src);\r
772db4bb	141	\r
	142	//\r
	143	// Only update the route cache's gateway if the source of the\r
	144	// Redirect is the current first-hop gateway\r
	145	//\r
	146	if ((CacheEntry != NULL) && (NTOHL (Head->Src) == CacheEntry->NextHop)) {\r
	147	CacheEntry->NextHop = Gateway;\r
	148	}\r
	149	}\r
	150	\r
	151	NetbufFree (Packet);\r
	152	return EFI_SUCCESS;\r
	153	}\r
	154	\r
	155	\r
	156	/**\r
	157	Process the ICMP error packet. If it is an ICMP redirect packet,\r
	158	update call Ip4ProcessIcmpRedirect to update the IP instance's\r
	159	route cache, otherwise, deliver the packet to upper layer.\r
	160	\r
3e8c18da	161	@param[in] IpSb The IP service that received the packet.\r
	162	@param[in] Head The IP head of the ICMP error packet\r
	163	@param[in] Packet The content of the ICMP error with IP head\r
772db4bb	164	removed.\r
772db4bb	165	\r
5405e9a6	166	@retval EFI_SUCCESS The ICMP error is processed successfully.\r
772db4bb	167	@retval EFI_INVALID_PARAMETER The packet is invalid\r
772db4bb	168	@retval Others Failed to process the packet.\r
5405e9a6	169	\r
772db4bb	170	**/\r
772db4bb	171	EFI_STATUS\r
	172	Ip4ProcessIcmpError (\r
	173	IN IP4_SERVICE *IpSb,\r
	174	IN IP4_HEAD *Head,\r
	175	IN NET_BUF *Packet\r
	176	)\r
	177	{\r
	178	IP4_ICMP_ERROR_HEAD Icmp;\r
	179	\r
	180	if (Packet->TotalSize < sizeof (Icmp)) {\r
	181	NetbufFree (Packet);\r
	182	return EFI_INVALID_PARAMETER;\r
	183	}\r
	184	\r
	185	NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp);\r
	186	\r
	187	//\r
	188	// If it is an ICMP redirect error, update the route cache\r
	189	// as RFC1122. Otherwise, demultiplex it to IP instances.\r
	190	//\r
	191	if (Icmp.Head.Type == ICMP_REDIRECT) {\r
	192	return Ip4ProcessIcmpRedirect (IpSb, Head, Packet, &Icmp);\r
	193	}\r
	194	\r
	195	IP4_GET_CLIP_INFO (Packet)->Status = EFI_ICMP_ERROR;\r
	196	return Ip4Demultiplex (IpSb, Head, Packet);\r
	197	}\r
	198	\r
	199	\r
	200	/**\r
	201	Replay an ICMP echo request.\r
	202	\r
3e8c18da	203	@param[in] IpSb The IP service that receivd the packet\r
	204	@param[in] Head The IP head of the ICMP error packet\r
	205	@param[in] Packet The content of the ICMP error with IP head\r
772db4bb	206	removed.\r
	207	\r
	208	@retval EFI_OUT_OF_RESOURCES Failed to allocate resource.\r
	209	@retval EFI_SUCCESS The ICMP Echo request is successfully answered.\r
	210	@retval Others Failed to answer the ICMP echo request.\r
	211	\r
	212	**/\r
	213	EFI_STATUS\r
	214	Ip4IcmpReplyEcho (\r
	215	IN IP4_SERVICE *IpSb,\r
	216	IN IP4_HEAD *Head,\r
	217	IN NET_BUF *Packet\r
	218	)\r
	219	{\r
	220	IP4_ICMP_QUERY_HEAD *Icmp;\r
	221	NET_BUF *Data;\r
	222	EFI_STATUS Status;\r
	223	IP4_HEAD ReplyHead;\r
	224	\r
	225	//\r
	226	// make a copy the packet, it is really a bad idea to\r
	227	// send the MNP's buffer back to MNP.\r
	228	//\r
	229	Data = NetbufDuplicate (Packet, NULL, IP4_MAX_HEADLEN);\r
	230	\r
	231	if (Data == NULL) {\r
	232	Status = EFI_OUT_OF_RESOURCES;\r
	233	goto ON_EXIT;\r
	234	}\r
	235	\r
	236	//\r
	237	// Change the ICMP type to echo reply, exchange the source\r
	238	// and destination, then send it. The source is updated to\r
	239	// use specific destination. See RFC1122. SRR/RR option\r
	240	// update is omitted.\r
	241	//\r
	242	Icmp = (IP4_ICMP_QUERY_HEAD *) NetbufGetByte (Data, 0, NULL);\r
	243	Icmp->Head.Type = ICMP_ECHO_REPLY;\r
	244	Icmp->Head.Checksum = 0;\r
687a2e5f	245	Icmp->Head.Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Icmp, Data->TotalSize));\r
772db4bb	246	\r
	247	ReplyHead.Tos = 0;\r
	248	ReplyHead.Fragment = 0;\r
	249	ReplyHead.Ttl = 64;\r
f6b7393c	250	ReplyHead.Protocol = EFI_IP_PROTO_ICMP;\r
772db4bb	251	ReplyHead.Src = 0;\r
	252	\r
	253	//\r
	254	// Ip4Output will select a source for us\r
	255	//\r
	256	ReplyHead.Dst = Head->Src;\r
	257	\r
	258	Status = Ip4Output (\r
	259	IpSb,\r
	260	NULL,\r
	261	Data,\r
	262	&ReplyHead,\r
	263	NULL,\r
	264	0,\r
	265	IP4_ALLZERO_ADDRESS,\r
	266	Ip4SysPacketSent,\r
	267	NULL\r
	268	);\r
	269	\r
	270	ON_EXIT:\r
	271	NetbufFree (Packet);\r
	272	return Status;\r
	273	}\r
	274	\r
	275	\r
	276	/**\r
	277	Process the ICMP query message. If it is an ICMP echo\r
	278	request, answer it. Otherwise deliver it to upper layer.\r
	279	\r
3e8c18da	280	@param[in] IpSb The IP service that receivd the packet\r
	281	@param[in] Head The IP head of the ICMP query packet\r
	282	@param[in] Packet The content of the ICMP query with IP head\r
772db4bb	283	removed.\r
	284	\r
	285	@retval EFI_INVALID_PARAMETER The packet is invalid\r
	286	@retval EFI_SUCCESS The ICMP query message is processed\r
5405e9a6	287	@retval Others Failed to process ICMP query.\r
772db4bb	288	\r
	289	**/\r
	290	EFI_STATUS\r
	291	Ip4ProcessIcmpQuery (\r
	292	IN IP4_SERVICE *IpSb,\r
	293	IN IP4_HEAD *Head,\r
	294	IN NET_BUF *Packet\r
	295	)\r
	296	{\r
	297	IP4_ICMP_QUERY_HEAD Icmp;\r
	298	\r
	299	if (Packet->TotalSize < sizeof (Icmp)) {\r
	300	NetbufFree (Packet);\r
	301	return EFI_INVALID_PARAMETER;\r
	302	}\r
	303	\r
	304	NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp);\r
	305	\r
	306	if (Icmp.Head.Type == ICMP_ECHO_REQUEST) {\r
	307	return Ip4IcmpReplyEcho (IpSb, Head, Packet);\r
	308	}\r
	309	\r
	310	return Ip4Demultiplex (IpSb, Head, Packet);\r
	311	}\r
	312	\r
	313	\r
	314	/**\r
	315	Handle the ICMP packet. First validate the message format,\r
	316	then according to the message types, process it as query or\r
	317	error packet.\r
	318	\r
3e8c18da	319	@param[in] IpSb The IP service that receivd the packet\r
	320	@param[in] Head The IP head of the ICMP query packet\r
	321	@param[in] Packet The content of the ICMP query with IP head\r
772db4bb	322	removed.\r
	323	\r
	324	@retval EFI_INVALID_PARAMETER The packet is malformated.\r
	325	@retval EFI_SUCCESS The ICMP message is successfully processed.\r
5405e9a6	326	@retval Others Failed to handle ICMP packet.\r
772db4bb	327	\r
	328	**/\r
	329	EFI_STATUS\r
	330	Ip4IcmpHandle (\r
	331	IN IP4_SERVICE *IpSb,\r
	332	IN IP4_HEAD *Head,\r
	333	IN NET_BUF *Packet\r
	334	)\r
	335	{\r
	336	IP4_ICMP_HEAD Icmp;\r
	337	UINT16 Checksum;\r
	338	\r
	339	if (Packet->TotalSize < sizeof (Icmp)) {\r
	340	goto DROP;\r
	341	}\r
	342	\r
	343	NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp);\r
	344	\r
	345	if (Icmp.Type > ICMP_TYPE_MAX) {\r
	346	goto DROP;\r
	347	}\r
	348	\r
687a2e5f	349	Checksum = (UINT16) (~NetbufChecksum (Packet));\r
772db4bb	350	if ((Icmp.Checksum != 0) && (Checksum != 0)) {\r
	351	goto DROP;\r
	352	}\r
	353	\r
	354	if (mIcmpClass[Icmp.Type].IcmpClass == ICMP_ERROR_MESSAGE) {\r
	355	return Ip4ProcessIcmpError (IpSb, Head, Packet);\r
	356	\r
	357	} else if (mIcmpClass[Icmp.Type].IcmpClass == ICMP_QUERY_MESSAGE) {\r
	358	return Ip4ProcessIcmpQuery (IpSb, Head, Packet);\r
	359	\r
	360	}\r
	361	\r
	362	DROP:\r
	363	NetbufFree (Packet);\r
	364	return EFI_INVALID_PARAMETER;\r
	365	}\r