/** @file
The implementation for Ping shell command.
Copyright (c) 2009 - 2011, 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "UefiShellNetwork1CommandsLib.h"
//
// Function templates to match the IPv4 and IPv6 commands that we use.
//
typedef
);
typedef
);
typedef
);
typedef
);
///
/// A set of pointers to either IPv6 or IPv4 functions.
/// Unknown which one to the ping command.
///
typedef struct {
typedef union {
} PING_PACKET;
//
// PING_IPX_COMPLETION_TOKEN
// structures are used for both transmit and receive operations.
// This version is IP-unaware.
//
typedef struct {
#pragma pack(1)
typedef struct _ICMPX_ECHO_REQUEST_REPLY {
#pragma pack()
typedef struct _PING_ICMP_TX_INFO {
typedef struct _PING_PRIVATE_DATA {
/**
Calculate the internet checksum (see RFC 1071).
@param[in] Packet Buffer which contains the data to be checksummed.
@param[in] Length Length to be checksummed.
@retval Checksum Returns the 16 bit ones complement of
ones complement sum of 16 bit words
**/
)
{
Sum = 0;
Length >>= 1;
while ((Length--) != 0) {
}
if (Odd != 0) {
}
//
// in case above carried
//
}
/**
Reads and returns the current value of register.
In IA64, the register is the Interval Timer Vector (ITV).
@return The current value of the register.
**/
{
L"-l",
},
{
L"-n",
},
{
L"-_s",
},
{
L"-_ip6",
},
{
NULL,
},
};
//
// Global Variables in Ping command.
//
/**
Read the current time.
@retval the current tick value.
**/
ReadTime (
)
{
//
// The WinntGetTimerValue will return EFI_UNSUPPORTED. Set the
// TimerPeriod by ourselves.
//
CurrentTick += 1000000;
}
return CurrentTick;
}
/**
The result is saved in the globle variable mFrequency
@retval EFI_SUCCESS Caculated the frequency successfully.
@retval Others Failed to caculate the frequency.
**/
)
{
return Status;
}
}
//
// The timer period is in femtosecond (1 femtosecond is 1e-15 second).
//
return EFI_SUCCESS;
}
/**
Caculate a duration in ms.
@param[in] Begin The start point of time.
@param[in] End The end point of time.
@return The duration in ms.
@retval 0 The parameters were not valid.
**/
)
{
return (0);
}
}
/**
Destroy PING_ICMPX_TX_INFO, and recollect the memory.
@param[in] TxInfo The pointer to PING_ICMPX_TX_INFO.
@param[in] IpChoice Whether the token is IPv4 or IPv6
**/
)
{
return;
}
}
if (IpChoice == PING_IP_CHOICE_IP6) {
}
}
}
}
} else {
}
}
}
}
}
}
}
/**
Match the request, and reply with SequenceNum/TimeStamp.
@param[in] Private The pointer to PING_PRIVATE_DATA.
@param[in] Packet The pointer to ICMPX_ECHO_REQUEST_REPLY.
@retval EFI_SUCCESS The match is successful.
@retval EFI_NOT_FOUND The reply can't be matched with any request.
**/
)
{
return EFI_SUCCESS;
}
}
return EFI_NOT_FOUND;
}
/**
The original intention is to send a request.
Currently, the application retransmits an icmp6 echo request packet
per second in sendnumber times that is specified by the user.
Because nothing can be done here, all things move to the timer rountine.
@param[in] Event A EFI_EVENT type event.
@param[in] Context The pointer to Context.
**/
)
{
}
/**
receive reply, match and print reply infomation.
@param[in] Event A EFI_EVENT type event.
@param[in] Context The pointer to context.
**/
)
{
if (Private == NULL || Private->Status == EFI_ABORTED || Private->Signature != PING_PRIVATE_DATA_SIGNATURE) {
return;
}
return;
}
goto ON_EXIT;
}
!EFI_IP6_EQUAL (&((EFI_IP6_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->Header->SourceAddress, (EFI_IPv6_ADDRESS*)&Private->DstAddress)) {
goto ON_EXIT;
}
goto ON_EXIT;
}
} else {
!EFI_IP4_EQUAL (&((EFI_IP4_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->Header->SourceAddress, (EFI_IPv4_ADDRESS*)&Private->DstAddress)) {
goto ON_EXIT;
}
goto ON_EXIT;
}
}
goto ON_EXIT;
}
//
// Check whether the reply matches the sent request before.
//
goto ON_EXIT;
}
//
// Display statistics on this icmp6 echo reply packet.
//
if (Rtt != 0) {
} else {
}
-1,
-1,
NULL,
Private->IpChoice == PING_IP_CHOICE_IP6?((EFI_IP6_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->Header->HopLimit:0,
Near,
);
//
// Continue to receive icmp echo reply packets.
//
}
} else {
//
// All reply have already been received from the dest host.
//
}
//
// Singal to recycle the each rxdata here, not at the end of process.
//
gBS->SignalEvent (Private->IpChoice == PING_IP_CHOICE_IP6?((EFI_IP6_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->RecycleSignal:((EFI_IP4_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->RecycleSignal);
}
/**
Create a PING_IPX_COMPLETION_TOKEN.
@param[in] Private The pointer of PING_PRIVATE_DATA.
@param[in] TimeStamp The TimeStamp of request.
@param[in] SequenceNum The SequenceNum of request.
@return The pointer of PING_IPX_COMPLETION_TOKEN.
**/
)
{
return NULL;
}
TxData = AllocateZeroPool (Private->IpChoice==PING_IP_CHOICE_IP6?sizeof (EFI_IP6_TRANSMIT_DATA):sizeof (EFI_IP4_TRANSMIT_DATA));
return NULL;
}
return NULL;
}
//
// Assembly echo request packet.
//
Request->Type = (UINT8)(Private->IpChoice==PING_IP_CHOICE_IP6?ICMP_V6_ECHO_REQUEST:ICMP_V4_ECHO_REQUEST);
Request->Identifier = 0;
//
// Assembly token for transmit.
//
} else {
}
);
return NULL;
}
return Token;
}
/**
Transmit the PING_IPX_COMPLETION_TOKEN.
@param[in] Private The pointer of PING_PRIVATE_DATA.
@retval EFI_SUCCESS Transmitted successfully.
@retval EFI_OUT_OF_RESOURCES No memory is available on the platform.
@retval others Transmitted unsuccessfully.
**/
)
{
return EFI_OUT_OF_RESOURCES;
}
);
return EFI_OUT_OF_RESOURCES;
}
return Status;
}
return EFI_SUCCESS;
}
/**
Place a completion token into the receive packet queue to receive the echo reply.
@param[in] Private The pointer of PING_PRIVATE_DATA.
@retval EFI_SUCCESS Put the token into the receive packet queue successfully.
@retval others Put the token into the receive packet queue unsuccessfully.
**/
)
{
);
return Status;
}
}
/**
Remove the timeout request from the list.
@param[in] Event A EFI_EVENT type event.
@param[in] Context The pointer to Context.
**/
)
{
return;
}
//
// Retransmit icmp6 echo request packets per second in sendnumber times.
//
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_SEND_REQUEST), gShellNetwork1HiiHandle, Private->TxCount + 1);
}
}
}
//
// Check whether any icmp6 echo request in the list timeout.
//
//
// Remove the timeout echo request from txlist.
//
if (Time > DEFAULT_TIMEOUT) {
}
//
// Remove the timeout icmp6 echo request from list.
//
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_TIMEOUT), gShellNetwork1HiiHandle, TxInfo->SequenceNum);
//
// We dont need to wait for this some other time...
//
//
// All the left icmp6 echo request in the list timeout.
//
}
}
}
}
/**
Determine if a IP4 address is Link Local.
169.254.1.0 through 169.254.254.255 is link local.
@param[in] Address The address to test.
@retval TRUE It is.
@retval FALSE It is not.
**/
)
{
return ((BOOLEAN)(Address->Addr[0] == 169 && Address->Addr[1] == 254 && Address->Addr[2] >= 1 && Address->Addr[2] <= 254));
}
/**
Determine if a IP4 address is unspecified.
@param[in] Address The address to test.
@retval TRUE It is.
@retval FALSE It is not.
**/
)
{
}
/**
Create a valid IP instance.
@param[in] Private The pointer of PING_PRIVATE_DATA.
@retval EFI_SUCCESS Create a valid IPx instance successfully.
@retval EFI_ABORTED Locate handle with ipx service binding protocol unsuccessfully.
@retval EFI_INVALID_PARAMETER The source address is unspecified when the destination address is a link-local address.
@retval EFI_OUT_OF_RESOURCES No memory is available on the platform.
@retval EFI_NOT_FOUND The source address is not found.
**/
)
{
HandleBuffer = NULL;
IfInfoSize = 0;
//
// Locate all the handles with ip6 service binding protocol.
//
Private->IpChoice == PING_IP_CHOICE_IP6?&gEfiIp6ServiceBindingProtocolGuid:&gEfiIp4ServiceBindingProtocolGuid,
NULL,
);
return EFI_ABORTED;
}
//
// Source address is required when pinging a link-local address on multi-
// interfaces host.
//
(HandleNum > 1)) {
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellNetwork1HiiHandle, mSrcString);
goto ON_ERROR;
}
} else {
(HandleNum > 1)) {
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellNetwork1HiiHandle, mSrcString);
goto ON_ERROR;
}
}
//
// For each ip6 protocol, check interface addresses list.
//
IfInfoSize = 0;
Private->IpChoice == PING_IP_CHOICE_IP6?&gEfiIp6ServiceBindingProtocolGuid:&gEfiIp4ServiceBindingProtocolGuid,
);
goto ON_ERROR;
}
if (Private->IpChoice == PING_IP_CHOICE_IP6?NetIp6IsUnspecifiedAddr ((EFI_IPv6_ADDRESS*)&Private->SrcAddress):PingNetIp4IsUnspecifiedAddr ((EFI_IPv4_ADDRESS*)&Private->SrcAddress)) {
//
// No need to match interface address.
//
break;
} else {
//
// Ip6config protocol and ip6 service binding protocol are installed
// on the same handle.
//
);
goto ON_ERROR;
}
//
// Get the interface information size.
//
);
} else {
);
}
//
// Skip the ones not in current use.
//
if (Status == EFI_NOT_STARTED) {
continue;
}
if (Status != EFI_BUFFER_TOO_SMALL) {
goto ON_ERROR;
}
if (IpXInterfaceInfo == NULL) {
goto ON_ERROR;
}
//
// Get the interface info.
//
);
} else {
);
}
goto ON_ERROR;
}
//
// Check whether the source address is one of the interface addresses.
//
for (AddrIndex = 0; AddrIndex < ((EFI_IP6_CONFIG_INTERFACE_INFO*)IpXInterfaceInfo)->AddressInfoCount; AddrIndex++) {
//
// Match a certain interface address.
//
break;
}
}
//
// Found a nic handle with right interface address.
//
break;
}
} else {
//
// IP4 address check
//
if (EFI_IP4_EQUAL (&Private->SrcAddress, &((EFI_IP4_IPCONFIG_DATA*)IpXInterfaceInfo)->StationAddress)) {
//
// Match a certain interface address.
//
break;
}
}
}
}
//
// No exact interface address matched.
//
if (HandleIndex == HandleNum) {
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellNetwork1HiiHandle, mSrcString);
goto ON_ERROR;
}
goto ON_ERROR;
}
);
goto ON_ERROR;
}
//
// Configure the ip6 instance for icmp6 packet exchange.
//
Ip6Config.TrafficClass = 0;
Ip6Config.ReceiveTimeout = 0;
Ip6Config.TransmitTimeout = 0;
goto ON_ERROR;
}
Private->ProtocolPointers.Transmit = (PING_IPX_TRANSMIT )((EFI_IP6_PROTOCOL*)Private->IpProtocol)->Transmit;
Private->ProtocolPointers.Receive = (PING_IPX_RECEIVE )((EFI_IP6_PROTOCOL*)Private->IpProtocol)->Receive;
Private->ProtocolPointers.Cancel = (PING_IPX_CANCEL )((EFI_IP6_PROTOCOL*)Private->IpProtocol)->Cancel;
} else {
);
goto ON_ERROR;
}
//
// Configure the ip4 instance for icmp4 packet exchange.
//
// PING_IP4_COPY_ADDRESS (&Ip4Config.StationAddress, &Private->SrcAddress);
// Ip4Config.SubnetMask.Addr[0] = 0xFF;
// Ip4Config.SubnetMask.Addr[1] = 0xFF;
// Ip4Config.SubnetMask.Addr[2] = 0xFF;
// Ip4Config.SubnetMask.Addr[3] = 0x00;
Ip4Config.ReceiveTimeout = 0;
Ip4Config.TransmitTimeout = 0;
Ip4Config.TypeOfService = 0;
goto ON_ERROR;
}
Private->ProtocolPointers.Transmit = (PING_IPX_TRANSMIT )((EFI_IP4_PROTOCOL*)Private->IpProtocol)->Transmit;
Private->ProtocolPointers.Receive = (PING_IPX_RECEIVE )((EFI_IP4_PROTOCOL*)Private->IpProtocol)->Receive;
Private->ProtocolPointers.Cancel = (PING_IPX_CANCEL )((EFI_IP4_PROTOCOL*)Private->IpProtocol)->Cancel;
}
if (HandleBuffer != NULL) {
}
return EFI_SUCCESS;
if (HandleBuffer != NULL) {
}
if (IpXInterfaceInfo != NULL) {
}
}
return Status;
}
/**
Destory the IP instance.
@param[in] Private The pointer of PING_PRIVATE_DATA.
**/
)
{
gBS->CloseProtocol (
);
Private->IpChoice == PING_IP_CHOICE_IP6?&gEfiIp6ServiceBindingProtocolGuid:&gEfiIp4ServiceBindingProtocolGuid,
);
}
}
/**
The Ping Process.
@param[in] SendNumber The send request count.
@param[in] BufferSize The send buffer size.
@param[in] SrcAddress The source address.
@param[in] DstAddress The destination address.
@param[in] IpChoice The choice between IPv4 and IPv6.
@retval SHELL_SUCCESS The ping processed successfullly.
@retval others The ping processed unsuccessfully.
**/
)
{
return (SHELL_OUT_OF_RESOURCES);
}
//
// Open and configure a ip instance for us.
//
goto ON_EXIT;
}
//
// Print the command line itself.
//
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_START), gShellNetwork1HiiHandle, mDstString, Private->BufferSize);
//
// Create a ipv6 token to receive the first icmp6 echo reply packet.
//
goto ON_EXIT;
}
//
// Create and start timer to send icmp6 echo request packet per second.
//
);
goto ON_EXIT;
}
//
// Create a ipv6 token to send the first icmp6 echo request packet.
//
//
// EFI_NOT_READY for IPsec is enable and IKE is not established.
//
if(Status == EFI_NOT_FOUND) {
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_NOSOURCE_INDO), gShellNetwork1HiiHandle, mDstString);
} else if (Status == RETURN_NO_MAPPING) {
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_NOROUTE_FOUND), gShellNetwork1HiiHandle, mDstString, mSrcString);
} else {
ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_NETWORK_ERROR), gShellNetwork1HiiHandle, Status);
}
goto ON_EXIT;
}
);
goto ON_EXIT;
}
//
// Control the ping6 process by two factors:
// 1. Hot key
// 2. Private->Status
// 2.1. success means all icmp6 echo request packets get reply packets.
// 2.2. timeout means the last icmp6 echo reply request timeout to get reply.
// 2.3. noready means ping6 process is on-the-go.
//
if (ShellGetExecutionBreakFlag()) {
goto ON_STAT;
}
}
//
// Display the statistics in all.
//
-1,
-1,
NULL,
);
}
-1,
-1,
NULL,
);
}
}
}
}
}
}
}
}
return ShellStatus;
}
/**
Function for 'ping' command.
@param[in] ImageHandle Handle to the Image (NULL if Internal).
@param[in] SystemTable Pointer to the System Table (NULL if Internal).
**/
)
{
//
// we use IPv6 buffers to hold items...
// make sure this is enough space!
//
goto ON_EXIT;
}
}
//
// Parse the paramter of count number.
//
//
// ShellStrToUintn will return 0 when input is 0 or an invalid input string.
//
goto ON_EXIT;
}
} else {
}
//
// Parse the paramter of buffer size.
//
//
// ShellStrToUintn will return 0 when input is 0 or an invalid input string.
//
goto ON_EXIT;
}
} else {
}
//
// Parse the paramter of source ip address.
//
if (IpChoice == PING_IP_CHOICE_IP6) {
} else {
}
goto ON_EXIT;
}
}
//
// Parse the paramter of destination ip address.
//
if (NonOptionCount < 2) {
goto ON_EXIT;
}
if (NonOptionCount > 2) {
goto ON_EXIT;
}
if (IpChoice == PING_IP_CHOICE_IP6) {
} else {
}
goto ON_EXIT;
}
}
//
// Get frequency to calculate the time from ticks.
//
Status = GetFrequency ();
goto ON_EXIT;
}
//
// Enter into ping process.
//
ShellStatus = ShellPing (
);
return ShellStatus;
}