]>
Commit | Line | Data |
---|---|---|
68fb0527 | 1 | /** @file\r |
2 | The implementation for Ping shell command.\r | |
3 | \r | |
c011b6c9 | 4 | (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r |
ba0014b9 | 5 | Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r |
80f7a8f5 | 6 | (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r |
68fb0527 | 7 | \r |
56ba3746 | 8 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
68fb0527 | 9 | \r |
10 | **/\r | |
11 | \r | |
12 | #include "UefiShellNetwork1CommandsLib.h"\r | |
13 | \r | |
14 | #define PING_IP4_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))\r | |
15 | \r | |
f52e226e | 16 | UINT64 mCurrentTick = 0;\r |
68fb0527 | 17 | \r |
18 | //\r | |
19 | // Function templates to match the IPv4 and IPv6 commands that we use.\r | |
20 | //\r | |
ba0014b9 | 21 | typedef\r |
68fb0527 | 22 | EFI_STATUS\r |
23 | (EFIAPI *PING_IPX_POLL)(\r | |
24 | IN VOID *This\r | |
ba0014b9 | 25 | );\r |
68fb0527 | 26 | \r |
ba0014b9 | 27 | typedef\r |
68fb0527 | 28 | EFI_STATUS\r |
29 | (EFIAPI *PING_IPX_TRANSMIT)(\r | |
30 | IN VOID *This,\r | |
31 | IN VOID *Token\r | |
32 | );\r | |
33 | \r | |
ba0014b9 | 34 | typedef\r |
68fb0527 | 35 | EFI_STATUS\r |
36 | (EFIAPI *PING_IPX_RECEIVE)(\r | |
37 | IN VOID *This,\r | |
38 | IN VOID *Token\r | |
ba0014b9 | 39 | );\r |
68fb0527 | 40 | \r |
41 | typedef\r | |
42 | EFI_STATUS\r | |
43 | (EFIAPI *PING_IPX_CANCEL)(\r | |
44 | IN VOID *This,\r | |
45 | IN VOID *Token OPTIONAL\r | |
46 | );\r | |
47 | \r | |
48 | ///\r | |
ba0014b9 | 49 | /// A set of pointers to either IPv6 or IPv4 functions.\r |
68fb0527 | 50 | /// Unknown which one to the ping command.\r |
51 | ///\r | |
52 | typedef struct {\r | |
53 | PING_IPX_TRANSMIT Transmit;\r | |
54 | PING_IPX_RECEIVE Receive;\r | |
55 | PING_IPX_CANCEL Cancel;\r | |
56 | PING_IPX_POLL Poll;\r | |
57 | }PING_IPX_PROTOCOL;\r | |
58 | \r | |
59 | \r | |
60 | typedef union {\r | |
61 | VOID *RxData;\r | |
62 | VOID *TxData;\r | |
63 | } PING_PACKET;\r | |
64 | \r | |
65 | //\r | |
66 | // PING_IPX_COMPLETION_TOKEN\r | |
ba0014b9 | 67 | // structures are used for both transmit and receive operations.\r |
68fb0527 | 68 | // This version is IP-unaware.\r |
69 | //\r | |
70 | typedef struct {\r | |
71 | EFI_EVENT Event;\r | |
72 | EFI_STATUS Status;\r | |
73 | PING_PACKET Packet;\r | |
74 | } PING_IPX_COMPLETION_TOKEN;\r | |
75 | \r | |
76 | #pragma pack(1)\r | |
77 | typedef struct _ICMPX_ECHO_REQUEST_REPLY {\r | |
78 | UINT8 Type;\r | |
79 | UINT8 Code;\r | |
80 | UINT16 Checksum;\r | |
81 | UINT16 Identifier;\r | |
82 | UINT16 SequenceNum;\r | |
2a326330 | 83 | UINT32 TimeStamp;\r |
68fb0527 | 84 | UINT8 Data[1];\r |
85 | } ICMPX_ECHO_REQUEST_REPLY;\r | |
86 | #pragma pack()\r | |
87 | \r | |
88 | typedef struct _PING_ICMP_TX_INFO {\r | |
89 | LIST_ENTRY Link;\r | |
90 | UINT16 SequenceNum;\r | |
2a326330 | 91 | UINT32 TimeStamp;\r |
68fb0527 | 92 | PING_IPX_COMPLETION_TOKEN *Token;\r |
93 | } PING_ICMPX_TX_INFO;\r | |
94 | \r | |
95 | #define DEFAULT_TIMEOUT 5000\r | |
96 | #define MAX_SEND_NUMBER 10000\r | |
97 | #define MAX_BUFFER_SIZE 32768\r | |
98 | #define DEFAULT_TIMER_PERIOD 358049\r | |
99 | #define ONE_SECOND 10000000\r | |
100 | #define PING_IP_CHOICE_IP4 1\r | |
101 | #define PING_IP_CHOICE_IP6 2\r | |
102 | #define DEFAULT_SEND_COUNT 10\r | |
103 | #define DEFAULT_BUFFER_SIZE 16\r | |
104 | #define ICMP_V4_ECHO_REQUEST 0x8\r | |
105 | #define ICMP_V4_ECHO_REPLY 0x0\r | |
2a326330 | 106 | #define STALL_1_MILLI_SECOND 1000\r |
68fb0527 | 107 | \r |
108 | #define PING_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('P', 'i', 'n', 'g')\r | |
109 | typedef struct _PING_PRIVATE_DATA {\r | |
110 | UINT32 Signature;\r | |
111 | EFI_HANDLE NicHandle;\r | |
112 | EFI_HANDLE IpChildHandle;\r | |
113 | EFI_EVENT Timer;\r | |
114 | \r | |
2a326330 | 115 | UINT32 TimerPeriod;\r |
ba0014b9 | 116 | UINT32 RttTimerTick;\r |
2a326330 FS |
117 | EFI_EVENT RttTimer;\r |
118 | \r | |
68fb0527 | 119 | EFI_STATUS Status;\r |
120 | LIST_ENTRY TxList;\r | |
121 | UINT16 RxCount;\r | |
122 | UINT16 TxCount;\r | |
123 | UINT64 RttSum;\r | |
124 | UINT64 RttMin;\r | |
125 | UINT64 RttMax;\r | |
126 | UINT32 SequenceNum;\r | |
127 | \r | |
128 | UINT32 SendNum;\r | |
129 | UINT32 BufferSize;\r | |
130 | UINT32 IpChoice;\r | |
131 | \r | |
132 | PING_IPX_PROTOCOL ProtocolPointers;\r | |
133 | VOID *IpProtocol;\r | |
134 | UINT8 SrcAddress[MAX(sizeof(EFI_IPv6_ADDRESS) , sizeof(EFI_IPv4_ADDRESS) )];\r | |
135 | UINT8 DstAddress[MAX(sizeof(EFI_IPv6_ADDRESS) , sizeof(EFI_IPv4_ADDRESS) )];\r | |
136 | PING_IPX_COMPLETION_TOKEN RxToken;\r | |
80f7a8f5 | 137 | UINT16 FailedCount;\r |
68fb0527 | 138 | } PING_PRIVATE_DATA;\r |
139 | \r | |
a1d4bfcc | 140 | /**\r |
141 | Calculate the internet checksum (see RFC 1071).\r | |
142 | \r | |
143 | @param[in] Packet Buffer which contains the data to be checksummed.\r | |
144 | @param[in] Length Length to be checksummed.\r | |
145 | \r | |
ba0014b9 | 146 | @retval Checksum Returns the 16 bit ones complement of\r |
a1d4bfcc | 147 | ones complement sum of 16 bit words\r |
148 | **/\r | |
68fb0527 | 149 | UINT16\r |
68fb0527 | 150 | NetChecksum (\r |
151 | IN UINT8 *Buffer,\r | |
152 | IN UINT32 Length\r | |
153 | )\r | |
68fb0527 | 154 | {\r |
155 | UINT32 Sum;\r | |
156 | UINT8 Odd;\r | |
157 | UINT16 *Packet;\r | |
158 | \r | |
159 | Packet = (UINT16 *) Buffer;\r | |
160 | \r | |
161 | Sum = 0;\r | |
162 | Odd = (UINT8) (Length & 1);\r | |
163 | Length >>= 1;\r | |
a1d4bfcc | 164 | while ((Length--) != 0) {\r |
68fb0527 | 165 | Sum += *Packet++;\r |
166 | }\r | |
167 | \r | |
a1d4bfcc | 168 | if (Odd != 0) {\r |
68fb0527 | 169 | Sum += *(UINT8 *) Packet;\r |
170 | }\r | |
171 | \r | |
172 | Sum = (Sum & 0xffff) + (Sum >> 16);\r | |
173 | \r | |
174 | //\r | |
175 | // in case above carried\r | |
176 | //\r | |
177 | Sum += Sum >> 16;\r | |
178 | \r | |
179 | return (UINT16) Sum;\r | |
180 | }\r | |
181 | \r | |
182 | /**\r | |
183 | Reads and returns the current value of register.\r | |
184 | In IA64, the register is the Interval Timer Vector (ITV).\r | |
185 | In X86(IA32/X64), the register is the Time Stamp Counter (TSC)\r | |
186 | \r | |
187 | @return The current value of the register.\r | |
188 | \r | |
189 | **/\r | |
68fb0527 | 190 | \r |
191 | STATIC CONST SHELL_PARAM_ITEM PingParamList[] = {\r | |
192 | {\r | |
193 | L"-l",\r | |
194 | TypeValue\r | |
195 | },\r | |
196 | {\r | |
197 | L"-n",\r | |
198 | TypeValue\r | |
199 | },\r | |
0b42d7d8 JW |
200 | {\r |
201 | L"-s",\r | |
202 | TypeValue\r | |
203 | },\r | |
68fb0527 | 204 | {\r |
205 | L"-_s",\r | |
206 | TypeValue\r | |
207 | },\r | |
208 | {\r | |
209 | L"-_ip6",\r | |
210 | TypeFlag\r | |
211 | },\r | |
212 | {\r | |
213 | NULL,\r | |
214 | TypeMax\r | |
215 | },\r | |
216 | };\r | |
217 | \r | |
218 | //\r | |
219 | // Global Variables in Ping command.\r | |
220 | //\r | |
221 | STATIC CONST CHAR16 *mDstString;\r | |
222 | STATIC CONST CHAR16 *mSrcString;\r | |
e0c2cc6f | 223 | \r |
6a5aa4d6 | 224 | /**\r |
2a326330 FS |
225 | RTT timer tick routine.\r |
226 | \r | |
227 | @param[in] Event A EFI_EVENT type event.\r | |
228 | @param[in] Context The pointer to Context.\r | |
6a5aa4d6 | 229 | \r |
6a5aa4d6 | 230 | **/\r |
2a326330 FS |
231 | VOID\r |
232 | EFIAPI\r | |
233 | RttTimerTickRoutine (\r | |
234 | IN EFI_EVENT Event,\r | |
235 | IN VOID *Context\r | |
236 | )\r | |
237 | {\r | |
238 | UINT32 *RttTimerTick;\r | |
239 | \r | |
240 | RttTimerTick = (UINT32*) Context;\r | |
241 | (*RttTimerTick)++;\r | |
242 | }\r | |
243 | \r | |
244 | /**\r | |
245 | Get the timer period of the system.\r | |
246 | \r | |
247 | This function tries to get the system timer period by creating\r | |
248 | an 1ms period timer.\r | |
249 | \r | |
250 | @return System timer period in MS, or 0 if operation failed.\r | |
251 | \r | |
252 | **/\r | |
253 | UINT32\r | |
254 | GetTimerPeriod(\r | |
e0c2cc6f | 255 | VOID\r |
256 | )\r | |
257 | {\r | |
2a326330 FS |
258 | EFI_STATUS Status;\r |
259 | UINT32 RttTimerTick;\r | |
260 | EFI_EVENT TimerEvent;\r | |
261 | UINT32 StallCounter;\r | |
262 | EFI_TPL OldTpl;\r | |
e0c2cc6f | 263 | \r |
2a326330 FS |
264 | RttTimerTick = 0;\r |
265 | StallCounter = 0;\r | |
e0c2cc6f | 266 | \r |
2a326330 FS |
267 | Status = gBS->CreateEvent (\r |
268 | EVT_TIMER | EVT_NOTIFY_SIGNAL,\r | |
269 | TPL_NOTIFY,\r | |
270 | RttTimerTickRoutine,\r | |
271 | &RttTimerTick,\r | |
272 | &TimerEvent\r | |
273 | );\r | |
e0c2cc6f | 274 | if (EFI_ERROR (Status)) {\r |
2a326330 FS |
275 | return 0;\r |
276 | }\r | |
277 | \r | |
278 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
279 | Status = gBS->SetTimer (\r | |
280 | TimerEvent,\r | |
281 | TimerPeriodic,\r | |
282 | TICKS_PER_MS\r | |
283 | );\r | |
284 | if (EFI_ERROR (Status)) {\r | |
285 | gBS->CloseEvent (TimerEvent);\r | |
286 | return 0;\r | |
287 | }\r | |
288 | \r | |
289 | while (RttTimerTick < 10) {\r | |
290 | gBS->Stall (STALL_1_MILLI_SECOND);\r | |
291 | ++StallCounter;\r | |
e0c2cc6f | 292 | }\r |
e0c2cc6f | 293 | \r |
2a326330 FS |
294 | gBS->RestoreTPL (OldTpl);\r |
295 | \r | |
296 | gBS->SetTimer (TimerEvent, TimerCancel, 0);\r | |
297 | gBS->CloseEvent (TimerEvent);\r | |
298 | \r | |
299 | return StallCounter / RttTimerTick;\r | |
300 | }\r | |
68fb0527 | 301 | \r |
302 | /**\r | |
2a326330 | 303 | Initialize the timer event for RTT (round trip time).\r |
68fb0527 | 304 | \r |
2a326330 FS |
305 | @param[in] Private The pointer to PING_PRIVATE_DATA.\r |
306 | \r | |
307 | @retval EFI_SUCCESS RTT timer is started.\r | |
308 | @retval Others Failed to start the RTT timer.\r | |
68fb0527 | 309 | \r |
310 | **/\r | |
311 | EFI_STATUS\r | |
2a326330 FS |
312 | PingInitRttTimer (\r |
313 | PING_PRIVATE_DATA *Private\r | |
68fb0527 | 314 | )\r |
315 | {\r | |
2a326330 FS |
316 | EFI_STATUS Status;\r |
317 | \r | |
318 | Private->TimerPeriod = GetTimerPeriod ();\r | |
319 | if (Private->TimerPeriod == 0) {\r | |
320 | return EFI_ABORTED;\r | |
321 | }\r | |
ba0014b9 | 322 | \r |
2a326330 FS |
323 | Private->RttTimerTick = 0;\r |
324 | Status = gBS->CreateEvent (\r | |
325 | EVT_TIMER | EVT_NOTIFY_SIGNAL,\r | |
326 | TPL_NOTIFY,\r | |
327 | RttTimerTickRoutine,\r | |
328 | &Private->RttTimerTick,\r | |
329 | &Private->RttTimer\r | |
330 | );\r | |
331 | if (EFI_ERROR (Status)) {\r | |
332 | return Status;\r | |
333 | }\r | |
68fb0527 | 334 | \r |
2a326330 FS |
335 | Status = gBS->SetTimer (\r |
336 | Private->RttTimer,\r | |
337 | TimerPeriodic,\r | |
338 | TICKS_PER_MS\r | |
339 | );\r | |
68fb0527 | 340 | if (EFI_ERROR (Status)) {\r |
2a326330 | 341 | gBS->CloseEvent (Private->RttTimer);\r |
68fb0527 | 342 | return Status;\r |
343 | }\r | |
344 | \r | |
2a326330 FS |
345 | return EFI_SUCCESS;\r |
346 | }\r | |
68fb0527 | 347 | \r |
2a326330 FS |
348 | /**\r |
349 | Free RTT timer event resource.\r | |
350 | \r | |
351 | @param[in] Private The pointer to PING_PRIVATE_DATA.\r | |
352 | \r | |
353 | **/\r | |
354 | VOID\r | |
355 | PingFreeRttTimer (\r | |
356 | PING_PRIVATE_DATA *Private\r | |
357 | )\r | |
358 | {\r | |
359 | if (Private->RttTimer != NULL) {\r | |
360 | gBS->SetTimer (Private->RttTimer, TimerCancel, 0);\r | |
361 | gBS->CloseEvent (Private->RttTimer);\r | |
68fb0527 | 362 | }\r |
2a326330 | 363 | }\r |
68fb0527 | 364 | \r |
2a326330 FS |
365 | /**\r |
366 | Read the current time.\r | |
ba0014b9 | 367 | \r |
2a326330 | 368 | @param[in] Private The pointer to PING_PRIVATE_DATA.\r |
68fb0527 | 369 | \r |
2a326330 FS |
370 | @retval the current tick value.\r |
371 | **/\r | |
372 | UINT32\r | |
373 | ReadTime (\r | |
374 | PING_PRIVATE_DATA *Private\r | |
375 | )\r | |
376 | {\r | |
377 | return Private->RttTimerTick;\r | |
68fb0527 | 378 | }\r |
379 | \r | |
380 | /**\r | |
85efb9d8 | 381 | Calculate a duration in ms.\r |
68fb0527 | 382 | \r |
2a326330 FS |
383 | @param[in] Private The pointer to PING_PRIVATE_DATA.\r |
384 | @param[in] Begin The start point of time.\r | |
385 | @param[in] End The end point of time.\r | |
68fb0527 | 386 | \r |
387 | @return The duration in ms.\r | |
388 | @retval 0 The parameters were not valid.\r | |
389 | **/\r | |
2a326330 | 390 | UINT32\r |
68fb0527 | 391 | CalculateTick (\r |
2a326330 FS |
392 | PING_PRIVATE_DATA *Private,\r |
393 | IN UINT32 Begin,\r | |
394 | IN UINT32 End\r | |
68fb0527 | 395 | )\r |
396 | {\r | |
2a326330 | 397 | if (End < Begin) {\r |
68fb0527 | 398 | return (0);\r |
399 | }\r | |
2a326330 FS |
400 | \r |
401 | return (End - Begin) * Private->TimerPeriod;\r | |
68fb0527 | 402 | }\r |
403 | \r | |
404 | /**\r | |
405 | Destroy PING_ICMPX_TX_INFO, and recollect the memory.\r | |
406 | \r | |
407 | @param[in] TxInfo The pointer to PING_ICMPX_TX_INFO.\r | |
408 | @param[in] IpChoice Whether the token is IPv4 or IPv6\r | |
409 | **/\r | |
410 | VOID\r | |
68fb0527 | 411 | PingDestroyTxInfo (\r |
412 | IN PING_ICMPX_TX_INFO *TxInfo,\r | |
413 | IN UINT32 IpChoice\r | |
414 | )\r | |
415 | {\r | |
416 | EFI_IP6_TRANSMIT_DATA *Ip6TxData;\r | |
417 | EFI_IP4_TRANSMIT_DATA *Ip4TxData;\r | |
418 | EFI_IP6_FRAGMENT_DATA *FragData;\r | |
419 | UINTN Index;\r | |
420 | \r | |
421 | if (TxInfo == NULL) {\r | |
422 | return;\r | |
423 | }\r | |
424 | \r | |
425 | if (TxInfo->Token != NULL) {\r | |
426 | \r | |
427 | if (TxInfo->Token->Event != NULL) {\r | |
428 | gBS->CloseEvent (TxInfo->Token->Event);\r | |
429 | }\r | |
430 | \r | |
431 | if (TxInfo->Token->Packet.TxData != NULL) {\r | |
432 | if (IpChoice == PING_IP_CHOICE_IP6) {\r | |
433 | Ip6TxData = TxInfo->Token->Packet.TxData;\r | |
434 | \r | |
435 | if (Ip6TxData->OverrideData != NULL) {\r | |
436 | FreePool (Ip6TxData->OverrideData);\r | |
437 | }\r | |
438 | \r | |
439 | if (Ip6TxData->ExtHdrs != NULL) {\r | |
440 | FreePool (Ip6TxData->ExtHdrs);\r | |
441 | }\r | |
442 | \r | |
443 | for (Index = 0; Index < Ip6TxData->FragmentCount; Index++) {\r | |
444 | FragData = Ip6TxData->FragmentTable[Index].FragmentBuffer;\r | |
445 | if (FragData != NULL) {\r | |
446 | FreePool (FragData);\r | |
447 | }\r | |
448 | }\r | |
449 | } else {\r | |
450 | Ip4TxData = TxInfo->Token->Packet.TxData;\r | |
451 | \r | |
452 | if (Ip4TxData->OverrideData != NULL) {\r | |
453 | FreePool (Ip4TxData->OverrideData);\r | |
454 | }\r | |
455 | \r | |
456 | for (Index = 0; Index < Ip4TxData->FragmentCount; Index++) {\r | |
457 | FragData = Ip4TxData->FragmentTable[Index].FragmentBuffer;\r | |
458 | if (FragData != NULL) {\r | |
459 | FreePool (FragData);\r | |
460 | }\r | |
461 | }\r | |
462 | }\r | |
463 | }\r | |
464 | \r | |
465 | FreePool (TxInfo->Token);\r | |
466 | }\r | |
467 | \r | |
468 | FreePool (TxInfo);\r | |
469 | }\r | |
470 | \r | |
471 | /**\r | |
472 | Match the request, and reply with SequenceNum/TimeStamp.\r | |
473 | \r | |
474 | @param[in] Private The pointer to PING_PRIVATE_DATA.\r | |
475 | @param[in] Packet The pointer to ICMPX_ECHO_REQUEST_REPLY.\r | |
476 | \r | |
477 | @retval EFI_SUCCESS The match is successful.\r | |
478 | @retval EFI_NOT_FOUND The reply can't be matched with any request.\r | |
479 | \r | |
480 | **/\r | |
481 | EFI_STATUS\r | |
68fb0527 | 482 | Ping6MatchEchoReply (\r |
483 | IN PING_PRIVATE_DATA *Private,\r | |
484 | IN ICMPX_ECHO_REQUEST_REPLY *Packet\r | |
485 | )\r | |
486 | {\r | |
487 | PING_ICMPX_TX_INFO *TxInfo;\r | |
488 | LIST_ENTRY *Entry;\r | |
489 | LIST_ENTRY *NextEntry;\r | |
490 | \r | |
491 | NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &Private->TxList) {\r | |
492 | TxInfo = BASE_CR (Entry, PING_ICMPX_TX_INFO, Link);\r | |
493 | \r | |
494 | if ((TxInfo->SequenceNum == Packet->SequenceNum) && (TxInfo->TimeStamp == Packet->TimeStamp)) {\r | |
495 | Private->RxCount++;\r | |
496 | RemoveEntryList (&TxInfo->Link);\r | |
497 | PingDestroyTxInfo (TxInfo, Private->IpChoice);\r | |
498 | return EFI_SUCCESS;\r | |
499 | }\r | |
500 | }\r | |
501 | \r | |
502 | return EFI_NOT_FOUND;\r | |
503 | }\r | |
504 | \r | |
505 | /**\r | |
506 | The original intention is to send a request.\r | |
507 | Currently, the application retransmits an icmp6 echo request packet\r | |
508 | per second in sendnumber times that is specified by the user.\r | |
509 | Because nothing can be done here, all things move to the timer rountine.\r | |
510 | \r | |
511 | @param[in] Event A EFI_EVENT type event.\r | |
512 | @param[in] Context The pointer to Context.\r | |
513 | \r | |
514 | **/\r | |
515 | VOID\r | |
516 | EFIAPI\r | |
517 | Ping6OnEchoRequestSent (\r | |
518 | IN EFI_EVENT Event,\r | |
519 | IN VOID *Context\r | |
520 | )\r | |
521 | {\r | |
522 | }\r | |
523 | \r | |
524 | /**\r | |
525 | receive reply, match and print reply infomation.\r | |
526 | \r | |
527 | @param[in] Event A EFI_EVENT type event.\r | |
528 | @param[in] Context The pointer to context.\r | |
529 | \r | |
530 | **/\r | |
531 | VOID\r | |
532 | EFIAPI\r | |
533 | Ping6OnEchoReplyReceived (\r | |
534 | IN EFI_EVENT Event,\r | |
535 | IN VOID *Context\r | |
536 | )\r | |
537 | {\r | |
538 | EFI_STATUS Status;\r | |
539 | PING_PRIVATE_DATA *Private;\r | |
540 | ICMPX_ECHO_REQUEST_REPLY *Reply;\r | |
541 | UINT32 PayLoad;\r | |
2a326330 | 542 | UINT32 Rtt;\r |
68fb0527 | 543 | \r |
544 | Private = (PING_PRIVATE_DATA *) Context;\r | |
545 | \r | |
546 | if (Private == NULL || Private->Status == EFI_ABORTED || Private->Signature != PING_PRIVATE_DATA_SIGNATURE) {\r | |
547 | return;\r | |
548 | }\r | |
549 | \r | |
550 | if (Private->RxToken.Packet.RxData == NULL) {\r | |
551 | return;\r | |
552 | }\r | |
553 | \r | |
554 | if (Private->IpChoice == PING_IP_CHOICE_IP6) {\r | |
555 | Reply = ((EFI_IP6_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->FragmentTable[0].FragmentBuffer;\r | |
556 | PayLoad = ((EFI_IP6_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->DataLength;\r | |
557 | if (((EFI_IP6_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->Header->NextHeader != IP6_ICMP) {\r | |
558 | goto ON_EXIT;\r | |
559 | }\r | |
ba0014b9 | 560 | if (!IP6_IS_MULTICAST ((EFI_IPv6_ADDRESS*)&Private->DstAddress) &&\r |
68fb0527 | 561 | !EFI_IP6_EQUAL (&((EFI_IP6_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->Header->SourceAddress, (EFI_IPv6_ADDRESS*)&Private->DstAddress)) {\r |
562 | goto ON_EXIT;\r | |
563 | }\r | |
564 | \r | |
565 | if ((Reply->Type != ICMP_V6_ECHO_REPLY) || (Reply->Code != 0)) {\r | |
566 | goto ON_EXIT;\r | |
567 | }\r | |
568 | } else {\r | |
569 | Reply = ((EFI_IP4_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->FragmentTable[0].FragmentBuffer;\r | |
570 | PayLoad = ((EFI_IP4_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->DataLength;\r | |
ba0014b9 | 571 | if (!IP4_IS_MULTICAST (EFI_IP4(*(EFI_IPv4_ADDRESS*)Private->DstAddress)) &&\r |
68fb0527 | 572 | !EFI_IP4_EQUAL (&((EFI_IP4_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->Header->SourceAddress, (EFI_IPv4_ADDRESS*)&Private->DstAddress)) {\r |
573 | goto ON_EXIT;\r | |
574 | }\r | |
575 | \r | |
576 | if ((Reply->Type != ICMP_V4_ECHO_REPLY) || (Reply->Code != 0)) {\r | |
577 | goto ON_EXIT;\r | |
578 | }\r | |
579 | }\r | |
ba0014b9 | 580 | \r |
68fb0527 | 581 | \r |
582 | if (PayLoad != Private->BufferSize) {\r | |
583 | goto ON_EXIT;\r | |
584 | }\r | |
585 | //\r | |
586 | // Check whether the reply matches the sent request before.\r | |
587 | //\r | |
588 | Status = Ping6MatchEchoReply (Private, Reply);\r | |
589 | if (EFI_ERROR(Status)) {\r | |
590 | goto ON_EXIT;\r | |
591 | }\r | |
592 | //\r | |
593 | // Display statistics on this icmp6 echo reply packet.\r | |
594 | //\r | |
2a326330 | 595 | Rtt = CalculateTick (Private, Reply->TimeStamp, ReadTime (Private));\r |
68fb0527 | 596 | \r |
597 | Private->RttSum += Rtt;\r | |
598 | Private->RttMin = Private->RttMin > Rtt ? Rtt : Private->RttMin;\r | |
599 | Private->RttMax = Private->RttMax < Rtt ? Rtt : Private->RttMax;\r | |
600 | \r | |
601 | ShellPrintHiiEx (\r | |
602 | -1,\r | |
603 | -1,\r | |
604 | NULL,\r | |
605 | STRING_TOKEN (STR_PING_REPLY_INFO),\r | |
606 | gShellNetwork1HiiHandle,\r | |
607 | PayLoad,\r | |
608 | mDstString,\r | |
609 | Reply->SequenceNum,\r | |
610 | Private->IpChoice == PING_IP_CHOICE_IP6?((EFI_IP6_RECEIVE_DATA*)Private->RxToken.Packet.RxData)->Header->HopLimit:0,\r | |
2a326330 FS |
611 | Rtt,\r |
612 | Rtt + Private->TimerPeriod\r | |
68fb0527 | 613 | );\r |
614 | \r | |
615 | ON_EXIT:\r | |
616 | \r | |
617 | if (Private->RxCount < Private->SendNum) {\r | |
618 | //\r | |
619 | // Continue to receive icmp echo reply packets.\r | |
620 | //\r | |
621 | Private->RxToken.Status = EFI_ABORTED;\r | |
622 | \r | |
623 | Status = Private->ProtocolPointers.Receive (Private->IpProtocol, &Private->RxToken);\r | |
624 | \r | |
625 | if (EFI_ERROR (Status)) {\r | |
5d8aa7eb | 626 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_RECEIVE), gShellNetwork1HiiHandle, Status);\r |
68fb0527 | 627 | Private->Status = EFI_ABORTED;\r |
628 | }\r | |
629 | } else {\r | |
630 | //\r | |
631 | // All reply have already been received from the dest host.\r | |
632 | //\r | |
633 | Private->Status = EFI_SUCCESS;\r | |
634 | }\r | |
635 | //\r | |
636 | // Singal to recycle the each rxdata here, not at the end of process.\r | |
637 | //\r | |
638 | 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);\r | |
639 | }\r | |
640 | \r | |
641 | /**\r | |
642 | Create a PING_IPX_COMPLETION_TOKEN.\r | |
643 | \r | |
644 | @param[in] Private The pointer of PING_PRIVATE_DATA.\r | |
645 | @param[in] TimeStamp The TimeStamp of request.\r | |
646 | @param[in] SequenceNum The SequenceNum of request.\r | |
647 | \r | |
648 | @return The pointer of PING_IPX_COMPLETION_TOKEN.\r | |
649 | \r | |
650 | **/\r | |
651 | PING_IPX_COMPLETION_TOKEN *\r | |
68fb0527 | 652 | PingGenerateToken (\r |
653 | IN PING_PRIVATE_DATA *Private,\r | |
2a326330 | 654 | IN UINT32 TimeStamp,\r |
68fb0527 | 655 | IN UINT16 SequenceNum\r |
656 | )\r | |
657 | {\r | |
658 | EFI_STATUS Status;\r | |
659 | PING_IPX_COMPLETION_TOKEN *Token;\r | |
660 | VOID *TxData;\r | |
661 | ICMPX_ECHO_REQUEST_REPLY *Request;\r | |
662 | UINT16 HeadSum;\r | |
663 | UINT16 TempChecksum;\r | |
664 | \r | |
665 | Request = AllocateZeroPool (Private->BufferSize);\r | |
666 | if (Request == NULL) {\r | |
667 | return NULL;\r | |
668 | }\r | |
669 | TxData = AllocateZeroPool (Private->IpChoice==PING_IP_CHOICE_IP6?sizeof (EFI_IP6_TRANSMIT_DATA):sizeof (EFI_IP4_TRANSMIT_DATA));\r | |
670 | if (TxData == NULL) {\r | |
671 | FreePool (Request);\r | |
672 | return NULL;\r | |
673 | }\r | |
674 | Token = AllocateZeroPool (sizeof (PING_IPX_COMPLETION_TOKEN));\r | |
675 | if (Token == NULL) {\r | |
676 | FreePool (Request);\r | |
677 | FreePool (TxData);\r | |
678 | return NULL;\r | |
679 | }\r | |
680 | \r | |
681 | //\r | |
682 | // Assembly echo request packet.\r | |
683 | //\r | |
684 | Request->Type = (UINT8)(Private->IpChoice==PING_IP_CHOICE_IP6?ICMP_V6_ECHO_REQUEST:ICMP_V4_ECHO_REQUEST);\r | |
685 | Request->Code = 0;\r | |
ba0014b9 | 686 | Request->SequenceNum = SequenceNum;\r |
68fb0527 | 687 | Request->Identifier = 0;\r |
688 | Request->Checksum = 0;\r | |
689 | \r | |
690 | //\r | |
691 | // Assembly token for transmit.\r | |
692 | //\r | |
693 | if (Private->IpChoice==PING_IP_CHOICE_IP6) {\r | |
3fd56a26 | 694 | Request->TimeStamp = TimeStamp;\r |
68fb0527 | 695 | ((EFI_IP6_TRANSMIT_DATA*)TxData)->ExtHdrsLength = 0;\r |
696 | ((EFI_IP6_TRANSMIT_DATA*)TxData)->ExtHdrs = NULL;\r | |
697 | ((EFI_IP6_TRANSMIT_DATA*)TxData)->OverrideData = 0;\r | |
698 | ((EFI_IP6_TRANSMIT_DATA*)TxData)->DataLength = Private->BufferSize;\r | |
699 | ((EFI_IP6_TRANSMIT_DATA*)TxData)->FragmentCount = 1;\r | |
700 | ((EFI_IP6_TRANSMIT_DATA*)TxData)->FragmentTable[0].FragmentBuffer = (VOID *) Request;\r | |
701 | ((EFI_IP6_TRANSMIT_DATA*)TxData)->FragmentTable[0].FragmentLength = Private->BufferSize;\r | |
702 | } else {\r | |
703 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->OptionsLength = 0;\r | |
704 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->OptionsBuffer = NULL;\r | |
705 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->OverrideData = 0;\r | |
706 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->TotalDataLength = Private->BufferSize;\r | |
707 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->FragmentCount = 1;\r | |
708 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->FragmentTable[0].FragmentBuffer = (VOID *) Request;\r | |
709 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->FragmentTable[0].FragmentLength = Private->BufferSize;\r | |
710 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->DestinationAddress.Addr[0] = Private->DstAddress[0];\r | |
711 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->DestinationAddress.Addr[1] = Private->DstAddress[1];\r | |
712 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->DestinationAddress.Addr[2] = Private->DstAddress[2];\r | |
713 | ((EFI_IP4_TRANSMIT_DATA*)TxData)->DestinationAddress.Addr[3] = Private->DstAddress[3];\r | |
714 | \r | |
715 | HeadSum = NetChecksum ((UINT8 *) Request, Private->BufferSize);\r | |
3fd56a26 | 716 | Request->TimeStamp = TimeStamp;\r |
68fb0527 | 717 | TempChecksum = NetChecksum ((UINT8 *) &Request->TimeStamp, sizeof (UINT64));\r |
718 | Request->Checksum = (UINT16)(~NetAddChecksum (HeadSum, TempChecksum));\r | |
719 | }\r | |
720 | \r | |
721 | \r | |
722 | Token->Status = EFI_ABORTED;\r | |
723 | Token->Packet.TxData = TxData;\r | |
724 | \r | |
725 | Status = gBS->CreateEvent (\r | |
726 | EVT_NOTIFY_SIGNAL,\r | |
727 | TPL_CALLBACK,\r | |
728 | Ping6OnEchoRequestSent,\r | |
729 | Private,\r | |
730 | &Token->Event\r | |
731 | );\r | |
732 | \r | |
733 | if (EFI_ERROR (Status)) {\r | |
734 | FreePool (Request);\r | |
735 | FreePool (TxData);\r | |
736 | FreePool (Token);\r | |
737 | return NULL;\r | |
738 | }\r | |
739 | \r | |
740 | return Token;\r | |
741 | }\r | |
742 | \r | |
743 | /**\r | |
744 | Transmit the PING_IPX_COMPLETION_TOKEN.\r | |
745 | \r | |
746 | @param[in] Private The pointer of PING_PRIVATE_DATA.\r | |
747 | \r | |
748 | @retval EFI_SUCCESS Transmitted successfully.\r | |
749 | @retval EFI_OUT_OF_RESOURCES No memory is available on the platform.\r | |
750 | @retval others Transmitted unsuccessfully.\r | |
751 | \r | |
752 | **/\r | |
753 | EFI_STATUS\r | |
68fb0527 | 754 | PingSendEchoRequest (\r |
755 | IN PING_PRIVATE_DATA *Private\r | |
756 | )\r | |
757 | {\r | |
758 | EFI_STATUS Status;\r | |
759 | PING_ICMPX_TX_INFO *TxInfo;\r | |
760 | \r | |
761 | TxInfo = AllocateZeroPool (sizeof (PING_ICMPX_TX_INFO));\r | |
762 | \r | |
763 | if (TxInfo == NULL) {\r | |
764 | return EFI_OUT_OF_RESOURCES;\r | |
765 | }\r | |
766 | \r | |
2a326330 | 767 | TxInfo->TimeStamp = ReadTime (Private);\r |
68fb0527 | 768 | TxInfo->SequenceNum = (UINT16) (Private->TxCount + 1);\r |
769 | TxInfo->Token = PingGenerateToken (\r | |
770 | Private,\r | |
771 | TxInfo->TimeStamp,\r | |
772 | TxInfo->SequenceNum\r | |
773 | );\r | |
774 | \r | |
775 | if (TxInfo->Token == NULL) {\r | |
776 | PingDestroyTxInfo (TxInfo, Private->IpChoice);\r | |
777 | return EFI_OUT_OF_RESOURCES;\r | |
778 | }\r | |
779 | \r | |
780 | ASSERT(Private->ProtocolPointers.Transmit != NULL);\r | |
d624deb7 MA |
781 | \r |
782 | InsertTailList (&Private->TxList, &TxInfo->Link);\r | |
783 | \r | |
68fb0527 | 784 | Status = Private->ProtocolPointers.Transmit (Private->IpProtocol, TxInfo->Token);\r |
785 | \r | |
786 | if (EFI_ERROR (Status)) {\r | |
d624deb7 | 787 | RemoveEntryList (&TxInfo->Link);\r |
68fb0527 | 788 | PingDestroyTxInfo (TxInfo, Private->IpChoice);\r |
789 | return Status;\r | |
790 | }\r | |
791 | \r | |
68fb0527 | 792 | Private->TxCount++;\r |
793 | \r | |
794 | return EFI_SUCCESS;\r | |
795 | }\r | |
796 | \r | |
797 | /**\r | |
798 | Place a completion token into the receive packet queue to receive the echo reply.\r | |
799 | \r | |
800 | @param[in] Private The pointer of PING_PRIVATE_DATA.\r | |
801 | \r | |
802 | @retval EFI_SUCCESS Put the token into the receive packet queue successfully.\r | |
803 | @retval others Put the token into the receive packet queue unsuccessfully.\r | |
804 | \r | |
805 | **/\r | |
806 | EFI_STATUS\r | |
68fb0527 | 807 | Ping6ReceiveEchoReply (\r |
808 | IN PING_PRIVATE_DATA *Private\r | |
809 | )\r | |
810 | {\r | |
811 | EFI_STATUS Status;\r | |
812 | \r | |
813 | ZeroMem (&Private->RxToken, sizeof (PING_IPX_COMPLETION_TOKEN));\r | |
814 | \r | |
815 | Status = gBS->CreateEvent (\r | |
816 | EVT_NOTIFY_SIGNAL,\r | |
817 | TPL_CALLBACK,\r | |
818 | Ping6OnEchoReplyReceived,\r | |
819 | Private,\r | |
820 | &Private->RxToken.Event\r | |
821 | );\r | |
822 | \r | |
823 | if (EFI_ERROR (Status)) {\r | |
824 | return Status;\r | |
825 | }\r | |
826 | \r | |
827 | Private->RxToken.Status = EFI_NOT_READY;\r | |
828 | \r | |
5d8aa7eb FS |
829 | Status = Private->ProtocolPointers.Receive (Private->IpProtocol, &Private->RxToken);\r |
830 | if (EFI_ERROR (Status)) {\r | |
831 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_RECEIVE), gShellNetwork1HiiHandle, Status);\r | |
832 | }\r | |
833 | return Status;\r | |
68fb0527 | 834 | }\r |
835 | \r | |
836 | /**\r | |
837 | Remove the timeout request from the list.\r | |
838 | \r | |
839 | @param[in] Event A EFI_EVENT type event.\r | |
840 | @param[in] Context The pointer to Context.\r | |
841 | \r | |
842 | **/\r | |
843 | VOID\r | |
844 | EFIAPI\r | |
845 | Ping6OnTimerRoutine (\r | |
846 | IN EFI_EVENT Event,\r | |
847 | IN VOID *Context\r | |
848 | )\r | |
849 | {\r | |
850 | EFI_STATUS Status;\r | |
851 | PING_PRIVATE_DATA *Private;\r | |
852 | PING_ICMPX_TX_INFO *TxInfo;\r | |
853 | LIST_ENTRY *Entry;\r | |
854 | LIST_ENTRY *NextEntry;\r | |
855 | UINT64 Time;\r | |
856 | \r | |
857 | Private = (PING_PRIVATE_DATA *) Context;\r | |
858 | if (Private->Signature != PING_PRIVATE_DATA_SIGNATURE) {\r | |
859 | Private->Status = EFI_NOT_FOUND;\r | |
860 | return;\r | |
861 | }\r | |
862 | \r | |
863 | //\r | |
864 | // Retransmit icmp6 echo request packets per second in sendnumber times.\r | |
865 | //\r | |
866 | if (Private->TxCount < Private->SendNum) {\r | |
867 | \r | |
868 | Status = PingSendEchoRequest (Private);\r | |
869 | if (Private->TxCount != 0){\r | |
870 | if (EFI_ERROR (Status)) {\r | |
871 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_SEND_REQUEST), gShellNetwork1HiiHandle, Private->TxCount + 1);\r | |
872 | }\r | |
873 | }\r | |
874 | }\r | |
875 | //\r | |
876 | // Check whether any icmp6 echo request in the list timeout.\r | |
877 | //\r | |
878 | NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &Private->TxList) {\r | |
879 | TxInfo = BASE_CR (Entry, PING_ICMPX_TX_INFO, Link);\r | |
2a326330 | 880 | Time = CalculateTick (Private, TxInfo->TimeStamp, ReadTime (Private));\r |
68fb0527 | 881 | \r |
882 | //\r | |
883 | // Remove the timeout echo request from txlist.\r | |
884 | //\r | |
885 | if (Time > DEFAULT_TIMEOUT) {\r | |
886 | \r | |
887 | if (EFI_ERROR (TxInfo->Token->Status)) {\r | |
888 | Private->ProtocolPointers.Cancel (Private->IpProtocol, TxInfo->Token);\r | |
889 | }\r | |
890 | //\r | |
891 | // Remove the timeout icmp6 echo request from list.\r | |
892 | //\r | |
893 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_TIMEOUT), gShellNetwork1HiiHandle, TxInfo->SequenceNum);\r | |
894 | \r | |
895 | RemoveEntryList (&TxInfo->Link);\r | |
896 | PingDestroyTxInfo (TxInfo, Private->IpChoice);\r | |
897 | \r | |
80f7a8f5 SSESPS |
898 | Private->RxCount++;\r |
899 | Private->FailedCount++;\r | |
900 | \r | |
68fb0527 | 901 | if (IsListEmpty (&Private->TxList) && (Private->TxCount == Private->SendNum)) {\r |
902 | //\r | |
903 | // All the left icmp6 echo request in the list timeout.\r | |
904 | //\r | |
905 | Private->Status = EFI_TIMEOUT;\r | |
906 | }\r | |
907 | }\r | |
908 | }\r | |
909 | }\r | |
910 | \r | |
911 | /**\r | |
912 | Determine if a IP4 address is Link Local.\r | |
913 | \r | |
914 | 169.254.1.0 through 169.254.254.255 is link local.\r | |
915 | \r | |
916 | @param[in] Address The address to test.\r | |
917 | \r | |
918 | @retval TRUE It is.\r | |
919 | @retval FALSE It is not.\r | |
920 | **/\r | |
921 | BOOLEAN\r | |
68fb0527 | 922 | PingNetIp4IsLinkLocalAddr (\r |
923 | IN CONST EFI_IPv4_ADDRESS *Address\r | |
924 | )\r | |
925 | {\r | |
926 | return ((BOOLEAN)(Address->Addr[0] == 169 && Address->Addr[1] == 254 && Address->Addr[2] >= 1 && Address->Addr[2] <= 254));\r | |
927 | }\r | |
928 | \r | |
929 | /**\r | |
930 | Determine if a IP4 address is unspecified.\r | |
931 | \r | |
932 | @param[in] Address The address to test.\r | |
933 | \r | |
934 | @retval TRUE It is.\r | |
935 | @retval FALSE It is not.\r | |
936 | **/\r | |
937 | BOOLEAN\r | |
68fb0527 | 938 | PingNetIp4IsUnspecifiedAddr (\r |
939 | IN CONST EFI_IPv4_ADDRESS *Address\r | |
940 | )\r | |
941 | {\r | |
942 | return ((BOOLEAN)((ReadUnaligned32 ((UINT32*)&Address->Addr[0])) == 0x00000000));\r | |
943 | }\r | |
944 | \r | |
945 | /**\r | |
946 | Create a valid IP instance.\r | |
947 | \r | |
948 | @param[in] Private The pointer of PING_PRIVATE_DATA.\r | |
949 | \r | |
950 | @retval EFI_SUCCESS Create a valid IPx instance successfully.\r | |
951 | @retval EFI_ABORTED Locate handle with ipx service binding protocol unsuccessfully.\r | |
952 | @retval EFI_INVALID_PARAMETER The source address is unspecified when the destination address is a link-local address.\r | |
953 | @retval EFI_OUT_OF_RESOURCES No memory is available on the platform.\r | |
954 | @retval EFI_NOT_FOUND The source address is not found.\r | |
955 | **/\r | |
956 | EFI_STATUS\r | |
68fb0527 | 957 | PingCreateIpInstance (\r |
958 | IN PING_PRIVATE_DATA *Private\r | |
959 | )\r | |
960 | {\r | |
961 | EFI_STATUS Status;\r | |
962 | UINTN HandleIndex;\r | |
963 | UINTN HandleNum;\r | |
964 | EFI_HANDLE *HandleBuffer;\r | |
9ce14ca1 | 965 | BOOLEAN UnspecifiedSrc;\r |
0f1e07ee | 966 | EFI_STATUS MediaStatus;\r |
68fb0527 | 967 | EFI_SERVICE_BINDING_PROTOCOL *EfiSb;\r |
968 | VOID *IpXCfg;\r | |
969 | EFI_IP6_CONFIG_DATA Ip6Config;\r | |
970 | EFI_IP4_CONFIG_DATA Ip4Config;\r | |
971 | VOID *IpXInterfaceInfo;\r | |
972 | UINTN IfInfoSize;\r | |
973 | EFI_IPv6_ADDRESS *Addr;\r | |
974 | UINTN AddrIndex;\r | |
975 | \r | |
976 | HandleBuffer = NULL;\r | |
9ce14ca1 | 977 | UnspecifiedSrc = FALSE;\r |
0f1e07ee | 978 | MediaStatus = EFI_SUCCESS;\r |
68fb0527 | 979 | EfiSb = NULL;\r |
980 | IpXInterfaceInfo = NULL;\r | |
981 | IfInfoSize = 0;\r | |
982 | \r | |
983 | //\r | |
984 | // Locate all the handles with ip6 service binding protocol.\r | |
985 | //\r | |
986 | Status = gBS->LocateHandleBuffer (\r | |
987 | ByProtocol,\r | |
988 | Private->IpChoice == PING_IP_CHOICE_IP6?&gEfiIp6ServiceBindingProtocolGuid:&gEfiIp4ServiceBindingProtocolGuid,\r | |
989 | NULL,\r | |
990 | &HandleNum,\r | |
991 | &HandleBuffer\r | |
992 | );\r | |
33c031ee | 993 | if (EFI_ERROR (Status) || (HandleNum == 0) || (HandleBuffer == NULL)) {\r |
68fb0527 | 994 | return EFI_ABORTED;\r |
995 | }\r | |
9ce14ca1 JW |
996 | \r |
997 | if (Private->IpChoice == PING_IP_CHOICE_IP6 ? NetIp6IsUnspecifiedAddr ((EFI_IPv6_ADDRESS*)&Private->SrcAddress) : \\r | |
998 | PingNetIp4IsUnspecifiedAddr ((EFI_IPv4_ADDRESS*)&Private->SrcAddress)) {\r | |
999 | //\r | |
ba0014b9 | 1000 | // SrcAddress is unspecified. So, both connected and configured interface will be automatic selected.\r |
9ce14ca1 JW |
1001 | //\r |
1002 | UnspecifiedSrc = TRUE;\r | |
1003 | }\r | |
ba0014b9 | 1004 | \r |
68fb0527 | 1005 | //\r |
9ce14ca1 | 1006 | // Source address is required when pinging a link-local address.\r |
68fb0527 | 1007 | //\r |
1008 | if (Private->IpChoice == PING_IP_CHOICE_IP6) {\r | |
9ce14ca1 JW |
1009 | if (NetIp6IsLinkLocalAddr ((EFI_IPv6_ADDRESS*)&Private->DstAddress) && UnspecifiedSrc) {\r |
1010 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_INVALID_SOURCE), gShellNetwork1HiiHandle);\r | |
68fb0527 | 1011 | Status = EFI_INVALID_PARAMETER;\r |
1012 | goto ON_ERROR;\r | |
1013 | }\r | |
1014 | } else {\r | |
1015 | ASSERT(Private->IpChoice == PING_IP_CHOICE_IP4);\r | |
9ce14ca1 | 1016 | if (PingNetIp4IsLinkLocalAddr ((EFI_IPv4_ADDRESS*)&Private->DstAddress) && UnspecifiedSrc) {\r |
ba0014b9 | 1017 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_INVALID_SOURCE), gShellNetwork1HiiHandle);\r |
68fb0527 | 1018 | Status = EFI_INVALID_PARAMETER;\r |
1019 | goto ON_ERROR;\r | |
1020 | }\r | |
1021 | }\r | |
ba0014b9 | 1022 | \r |
68fb0527 | 1023 | //\r |
1024 | // For each ip6 protocol, check interface addresses list.\r | |
1025 | //\r | |
1026 | for (HandleIndex = 0; HandleIndex < HandleNum; HandleIndex++) {\r | |
68fb0527 | 1027 | EfiSb = NULL;\r |
1028 | IpXInterfaceInfo = NULL;\r | |
1029 | IfInfoSize = 0;\r | |
1030 | \r | |
9ce14ca1 JW |
1031 | if (UnspecifiedSrc) {\r |
1032 | //\r | |
1033 | // Check media.\r | |
1034 | //\r | |
0f1e07ee | 1035 | NetLibDetectMediaWaitTimeout (HandleBuffer[HandleIndex], 0, &MediaStatus);\r |
1036 | if (MediaStatus != EFI_SUCCESS) {\r | |
9ce14ca1 JW |
1037 | //\r |
1038 | // Skip this one.\r | |
1039 | //\r | |
1040 | continue;\r | |
1041 | }\r | |
1042 | }\r | |
1043 | \r | |
68fb0527 | 1044 | Status = gBS->HandleProtocol (\r |
1045 | HandleBuffer[HandleIndex],\r | |
1046 | Private->IpChoice == PING_IP_CHOICE_IP6?&gEfiIp6ServiceBindingProtocolGuid:&gEfiIp4ServiceBindingProtocolGuid,\r | |
1047 | (VOID **) &EfiSb\r | |
1048 | );\r | |
1049 | if (EFI_ERROR (Status)) {\r | |
1050 | goto ON_ERROR;\r | |
1051 | }\r | |
1052 | \r | |
9ce14ca1 JW |
1053 | //\r |
1054 | // Ip6config protocol and ip6 service binding protocol are installed\r | |
1055 | // on the same handle.\r | |
1056 | //\r | |
1057 | Status = gBS->HandleProtocol (\r | |
1058 | HandleBuffer[HandleIndex],\r | |
1059 | Private->IpChoice == PING_IP_CHOICE_IP6?&gEfiIp6ConfigProtocolGuid:&gEfiIp4Config2ProtocolGuid,\r | |
1060 | (VOID **) &IpXCfg\r | |
1061 | );\r | |
68fb0527 | 1062 | \r |
9ce14ca1 JW |
1063 | if (EFI_ERROR (Status)) {\r |
1064 | goto ON_ERROR;\r | |
1065 | }\r | |
1066 | //\r | |
1067 | // Get the interface information size.\r | |
1068 | //\r | |
1069 | if (Private->IpChoice == PING_IP_CHOICE_IP6) {\r | |
1070 | Status = ((EFI_IP6_CONFIG_PROTOCOL*)IpXCfg)->GetData (\r | |
1071 | IpXCfg,\r | |
1072 | Ip6ConfigDataTypeInterfaceInfo,\r | |
1073 | &IfInfoSize,\r | |
1074 | NULL\r | |
1075 | );\r | |
1076 | } else {\r | |
1077 | Status = ((EFI_IP4_CONFIG2_PROTOCOL*)IpXCfg)->GetData (\r | |
1078 | IpXCfg,\r | |
1079 | Ip4Config2DataTypeInterfaceInfo,\r | |
1080 | &IfInfoSize,\r | |
1081 | NULL\r | |
1082 | );\r | |
1083 | }\r | |
ba0014b9 | 1084 | \r |
9ce14ca1 JW |
1085 | //\r |
1086 | // Skip the ones not in current use.\r | |
1087 | //\r | |
1088 | if (Status == EFI_NOT_STARTED) {\r | |
1089 | continue;\r | |
1090 | }\r | |
68fb0527 | 1091 | \r |
9ce14ca1 JW |
1092 | if (Status != EFI_BUFFER_TOO_SMALL) {\r |
1093 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_GETDATA), gShellNetwork1HiiHandle, Status);\r | |
1094 | goto ON_ERROR;\r | |
1095 | }\r | |
68fb0527 | 1096 | \r |
9ce14ca1 | 1097 | IpXInterfaceInfo = AllocateZeroPool (IfInfoSize);\r |
68fb0527 | 1098 | \r |
9ce14ca1 JW |
1099 | if (IpXInterfaceInfo == NULL) {\r |
1100 | Status = EFI_OUT_OF_RESOURCES;\r | |
1101 | goto ON_ERROR;\r | |
1102 | }\r | |
1103 | //\r | |
1104 | // Get the interface info.\r | |
1105 | //\r | |
1106 | if (Private->IpChoice == PING_IP_CHOICE_IP6) {\r | |
1107 | Status = ((EFI_IP6_CONFIG_PROTOCOL*)IpXCfg)->GetData (\r | |
1108 | IpXCfg,\r | |
1109 | Ip6ConfigDataTypeInterfaceInfo,\r | |
1110 | &IfInfoSize,\r | |
1111 | IpXInterfaceInfo\r | |
1112 | );\r | |
1113 | } else {\r | |
1114 | Status = ((EFI_IP4_CONFIG2_PROTOCOL*)IpXCfg)->GetData (\r | |
1115 | IpXCfg,\r | |
1116 | Ip4Config2DataTypeInterfaceInfo,\r | |
1117 | &IfInfoSize,\r | |
1118 | IpXInterfaceInfo\r | |
1119 | );\r | |
1120 | }\r | |
68fb0527 | 1121 | \r |
9ce14ca1 JW |
1122 | if (EFI_ERROR (Status)) {\r |
1123 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_GETDATA), gShellNetwork1HiiHandle, Status);\r | |
1124 | goto ON_ERROR;\r | |
1125 | }\r | |
1126 | //\r | |
1127 | // Check whether the source address is one of the interface addresses.\r | |
1128 | //\r | |
1129 | if (Private->IpChoice == PING_IP_CHOICE_IP6) {\r | |
1130 | for (AddrIndex = 0; AddrIndex < ((EFI_IP6_CONFIG_INTERFACE_INFO*)IpXInterfaceInfo)->AddressInfoCount; AddrIndex++) {\r | |
1131 | Addr = &(((EFI_IP6_CONFIG_INTERFACE_INFO*)IpXInterfaceInfo)->AddressInfo[AddrIndex].Address);\r | |
68fb0527 | 1132 | \r |
9ce14ca1 JW |
1133 | if (UnspecifiedSrc) {\r |
1134 | if (!NetIp6IsUnspecifiedAddr (Addr) && !NetIp6IsLinkLocalAddr (Addr)) {\r | |
68fb0527 | 1135 | //\r |
9ce14ca1 | 1136 | // Select the interface automatically.\r |
68fb0527 | 1137 | //\r |
9ce14ca1 | 1138 | CopyMem(&Private->SrcAddress, Addr, sizeof(Private->SrcAddress));\r |
68fb0527 | 1139 | break;\r |
1140 | }\r | |
9ce14ca1 | 1141 | } else if (EFI_IP6_EQUAL (&Private->SrcAddress, Addr)) {\r |
68fb0527 | 1142 | //\r |
9ce14ca1 | 1143 | // Match a certain interface address.\r |
68fb0527 | 1144 | //\r |
1145 | break;\r | |
1146 | }\r | |
9ce14ca1 JW |
1147 | }\r |
1148 | \r | |
1149 | if (AddrIndex < ((EFI_IP6_CONFIG_INTERFACE_INFO*)IpXInterfaceInfo)->AddressInfoCount) {\r | |
68fb0527 | 1150 | //\r |
9ce14ca1 | 1151 | // Found a nic handle with right interface address.\r |
68fb0527 | 1152 | //\r |
9ce14ca1 JW |
1153 | break;\r |
1154 | }\r | |
1155 | } else {\r | |
1156 | if (UnspecifiedSrc) {\r | |
ba0014b9 | 1157 | if (!PingNetIp4IsUnspecifiedAddr (&((EFI_IP4_CONFIG2_INTERFACE_INFO*)IpXInterfaceInfo)->StationAddress) &&\r |
9ce14ca1 | 1158 | !PingNetIp4IsLinkLocalAddr (&((EFI_IP4_CONFIG2_INTERFACE_INFO*)IpXInterfaceInfo)->StationAddress)) {\r |
68fb0527 | 1159 | //\r |
9ce14ca1 | 1160 | // Select the interface automatically.\r |
68fb0527 | 1161 | //\r |
1162 | break;\r | |
1163 | }\r | |
9ce14ca1 JW |
1164 | } else if (EFI_IP4_EQUAL (&Private->SrcAddress, &((EFI_IP4_CONFIG2_INTERFACE_INFO*)IpXInterfaceInfo)->StationAddress)) {\r |
1165 | //\r | |
1166 | // Match a certain interface address.\r | |
1167 | //\r | |
1168 | break;\r | |
68fb0527 | 1169 | }\r |
1170 | }\r | |
1171 | \r | |
1172 | FreePool (IpXInterfaceInfo);\r | |
1173 | IpXInterfaceInfo = NULL;\r | |
1174 | }\r | |
1175 | //\r | |
1176 | // No exact interface address matched.\r | |
1177 | //\r | |
1178 | \r | |
1179 | if (HandleIndex == HandleNum) {\r | |
ba0014b9 | 1180 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_CONFIGD_NIC_NF), gShellNetwork1HiiHandle, L"ping");\r |
68fb0527 | 1181 | Status = EFI_NOT_FOUND;\r |
1182 | goto ON_ERROR;\r | |
1183 | }\r | |
1184 | \r | |
1185 | Private->NicHandle = HandleBuffer[HandleIndex];\r | |
1186 | \r | |
1187 | ASSERT (EfiSb != NULL);\r | |
1188 | Status = EfiSb->CreateChild (EfiSb, &Private->IpChildHandle);\r | |
1189 | \r | |
1190 | if (EFI_ERROR (Status)) {\r | |
1191 | goto ON_ERROR;\r | |
1192 | }\r | |
1193 | if (Private->IpChoice == PING_IP_CHOICE_IP6) {\r | |
1194 | Status = gBS->OpenProtocol (\r | |
1195 | Private->IpChildHandle,\r | |
1196 | &gEfiIp6ProtocolGuid,\r | |
1197 | &Private->IpProtocol,\r | |
1198 | gImageHandle,\r | |
1199 | Private->IpChildHandle,\r | |
1200 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
1201 | );\r | |
1202 | if (EFI_ERROR (Status)) {\r | |
1203 | goto ON_ERROR;\r | |
1204 | }\r | |
1205 | \r | |
1206 | \r | |
1207 | ZeroMem (&Ip6Config, sizeof (EFI_IP6_CONFIG_DATA));\r | |
1208 | \r | |
1209 | //\r | |
1210 | // Configure the ip6 instance for icmp6 packet exchange.\r | |
1211 | //\r | |
1212 | Ip6Config.DefaultProtocol = 58;\r | |
1213 | Ip6Config.AcceptAnyProtocol = FALSE;\r | |
1214 | Ip6Config.AcceptIcmpErrors = TRUE;\r | |
1215 | Ip6Config.AcceptPromiscuous = FALSE;\r | |
1216 | Ip6Config.TrafficClass = 0;\r | |
1217 | Ip6Config.HopLimit = 128;\r | |
1218 | Ip6Config.FlowLabel = 0;\r | |
1219 | Ip6Config.ReceiveTimeout = 0;\r | |
1220 | Ip6Config.TransmitTimeout = 0;\r | |
1221 | \r | |
1222 | IP6_COPY_ADDRESS (&Ip6Config.StationAddress, &Private->SrcAddress);\r | |
1223 | IP6_COPY_ADDRESS (&Ip6Config.DestinationAddress, &Private->DstAddress);\r | |
1224 | \r | |
1225 | Status = ((EFI_IP6_PROTOCOL*)(Private->IpProtocol))->Configure (Private->IpProtocol, &Ip6Config);\r | |
1226 | \r | |
1227 | if (EFI_ERROR (Status)) {\r | |
1228 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_CONFIG), gShellNetwork1HiiHandle, Status);\r | |
1229 | goto ON_ERROR;\r | |
1230 | }\r | |
1231 | \r | |
1232 | Private->ProtocolPointers.Transmit = (PING_IPX_TRANSMIT )((EFI_IP6_PROTOCOL*)Private->IpProtocol)->Transmit;\r | |
1233 | Private->ProtocolPointers.Receive = (PING_IPX_RECEIVE )((EFI_IP6_PROTOCOL*)Private->IpProtocol)->Receive;\r | |
1234 | Private->ProtocolPointers.Cancel = (PING_IPX_CANCEL )((EFI_IP6_PROTOCOL*)Private->IpProtocol)->Cancel;\r | |
1235 | Private->ProtocolPointers.Poll = (PING_IPX_POLL )((EFI_IP6_PROTOCOL*)Private->IpProtocol)->Poll;\r | |
1236 | } else {\r | |
1237 | Status = gBS->OpenProtocol (\r | |
1238 | Private->IpChildHandle,\r | |
1239 | &gEfiIp4ProtocolGuid,\r | |
1240 | &Private->IpProtocol,\r | |
1241 | gImageHandle,\r | |
1242 | Private->IpChildHandle,\r | |
1243 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
1244 | );\r | |
1245 | if (EFI_ERROR (Status)) {\r | |
1246 | goto ON_ERROR;\r | |
1247 | }\r | |
1248 | \r | |
1249 | \r | |
1250 | ZeroMem (&Ip4Config, sizeof (EFI_IP4_CONFIG_DATA));\r | |
1251 | \r | |
1252 | //\r | |
1253 | // Configure the ip4 instance for icmp4 packet exchange.\r | |
1254 | //\r | |
68fb0527 | 1255 | Ip4Config.DefaultProtocol = 1;\r |
1256 | Ip4Config.AcceptAnyProtocol = FALSE;\r | |
1257 | Ip4Config.AcceptBroadcast = FALSE;\r | |
1258 | Ip4Config.AcceptIcmpErrors = TRUE;\r | |
1259 | Ip4Config.AcceptPromiscuous = FALSE;\r | |
1260 | Ip4Config.DoNotFragment = FALSE;\r | |
1261 | Ip4Config.RawData = FALSE;\r | |
1262 | Ip4Config.ReceiveTimeout = 0;\r | |
1263 | Ip4Config.TransmitTimeout = 0;\r | |
1264 | Ip4Config.UseDefaultAddress = TRUE;\r | |
1265 | Ip4Config.TimeToLive = 128;\r | |
1266 | Ip4Config.TypeOfService = 0;\r | |
1267 | \r | |
1268 | Status = ((EFI_IP4_PROTOCOL*)(Private->IpProtocol))->Configure (Private->IpProtocol, &Ip4Config);\r | |
1269 | \r | |
1270 | if (EFI_ERROR (Status)) {\r | |
1271 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_CONFIG), gShellNetwork1HiiHandle, Status);\r | |
1272 | goto ON_ERROR;\r | |
1273 | }\r | |
1274 | \r | |
1275 | Private->ProtocolPointers.Transmit = (PING_IPX_TRANSMIT )((EFI_IP4_PROTOCOL*)Private->IpProtocol)->Transmit;\r | |
1276 | Private->ProtocolPointers.Receive = (PING_IPX_RECEIVE )((EFI_IP4_PROTOCOL*)Private->IpProtocol)->Receive;\r | |
1277 | Private->ProtocolPointers.Cancel = (PING_IPX_CANCEL )((EFI_IP4_PROTOCOL*)Private->IpProtocol)->Cancel;\r | |
ba0014b9 | 1278 | Private->ProtocolPointers.Poll = (PING_IPX_POLL )((EFI_IP4_PROTOCOL*)Private->IpProtocol)->Poll;\r |
68fb0527 | 1279 | }\r |
1280 | \r | |
1281 | if (HandleBuffer != NULL) {\r | |
1282 | FreePool (HandleBuffer);\r | |
1283 | }\r | |
1284 | \r | |
1285 | return EFI_SUCCESS;\r | |
1286 | \r | |
1287 | ON_ERROR:\r | |
1288 | if (HandleBuffer != NULL) {\r | |
1289 | FreePool (HandleBuffer);\r | |
1290 | }\r | |
1291 | \r | |
1292 | if (IpXInterfaceInfo != NULL) {\r | |
1293 | FreePool (IpXInterfaceInfo);\r | |
1294 | }\r | |
1295 | \r | |
1296 | if ((EfiSb != NULL) && (Private->IpChildHandle != NULL)) {\r | |
1297 | EfiSb->DestroyChild (EfiSb, Private->IpChildHandle);\r | |
1298 | }\r | |
1299 | \r | |
1300 | return Status;\r | |
1301 | }\r | |
1302 | \r | |
1303 | /**\r | |
75dce340 | 1304 | Destroy the IP instance.\r |
68fb0527 | 1305 | \r |
1306 | @param[in] Private The pointer of PING_PRIVATE_DATA.\r | |
1307 | \r | |
1308 | **/\r | |
1309 | VOID\r | |
75dce340 | 1310 | Ping6DestroyIp6Instance (\r |
68fb0527 | 1311 | IN PING_PRIVATE_DATA *Private\r |
1312 | )\r | |
1313 | {\r | |
1314 | EFI_STATUS Status;\r | |
1315 | EFI_SERVICE_BINDING_PROTOCOL *IpSb;\r | |
1316 | \r | |
1317 | gBS->CloseProtocol (\r | |
1318 | Private->IpChildHandle,\r | |
1319 | Private->IpChoice == PING_IP_CHOICE_IP6?&gEfiIp6ProtocolGuid:&gEfiIp4ProtocolGuid,\r | |
1320 | gImageHandle,\r | |
1321 | Private->IpChildHandle\r | |
1322 | );\r | |
1323 | \r | |
1324 | Status = gBS->HandleProtocol (\r | |
1325 | Private->NicHandle,\r | |
1326 | Private->IpChoice == PING_IP_CHOICE_IP6?&gEfiIp6ServiceBindingProtocolGuid:&gEfiIp4ServiceBindingProtocolGuid,\r | |
1327 | (VOID **) &IpSb\r | |
1328 | );\r | |
1329 | \r | |
1330 | if (!EFI_ERROR(Status)) {\r | |
1331 | IpSb->DestroyChild (IpSb, Private->IpChildHandle);\r | |
1332 | }\r | |
1333 | }\r | |
1334 | \r | |
2a326330 | 1335 | \r |
68fb0527 | 1336 | /**\r |
1337 | The Ping Process.\r | |
1338 | \r | |
1339 | @param[in] SendNumber The send request count.\r | |
1340 | @param[in] BufferSize The send buffer size.\r | |
1341 | @param[in] SrcAddress The source address.\r | |
1342 | @param[in] DstAddress The destination address.\r | |
1343 | @param[in] IpChoice The choice between IPv4 and IPv6.\r | |
1344 | \r | |
1345 | @retval SHELL_SUCCESS The ping processed successfullly.\r | |
1346 | @retval others The ping processed unsuccessfully.\r | |
1347 | **/\r | |
1348 | SHELL_STATUS\r | |
68fb0527 | 1349 | ShellPing (\r |
1350 | IN UINT32 SendNumber,\r | |
1351 | IN UINT32 BufferSize,\r | |
1352 | IN EFI_IPv6_ADDRESS *SrcAddress,\r | |
1353 | IN EFI_IPv6_ADDRESS *DstAddress,\r | |
1354 | IN UINT32 IpChoice\r | |
1355 | )\r | |
1356 | {\r | |
1357 | EFI_STATUS Status;\r | |
1358 | PING_PRIVATE_DATA *Private;\r | |
1359 | PING_ICMPX_TX_INFO *TxInfo;\r | |
1360 | LIST_ENTRY *Entry;\r | |
1361 | LIST_ENTRY *NextEntry;\r | |
1362 | SHELL_STATUS ShellStatus;\r | |
1363 | \r | |
1364 | ShellStatus = SHELL_SUCCESS;\r | |
1365 | Private = AllocateZeroPool (sizeof (PING_PRIVATE_DATA));\r | |
1366 | \r | |
1367 | if (Private == NULL) {\r | |
1368 | return (SHELL_OUT_OF_RESOURCES);\r | |
1369 | }\r | |
1370 | \r | |
1371 | Private->IpChoice = IpChoice;\r | |
1372 | Private->Signature = PING_PRIVATE_DATA_SIGNATURE;\r | |
1373 | Private->SendNum = SendNumber;\r | |
1374 | Private->BufferSize = BufferSize;\r | |
1375 | Private->RttMin = ~((UINT64 )(0x0));\r | |
1376 | Private->Status = EFI_NOT_READY;\r | |
1377 | \r | |
1378 | CopyMem(&Private->SrcAddress, SrcAddress, sizeof(Private->SrcAddress));\r | |
1379 | CopyMem(&Private->DstAddress, DstAddress, sizeof(Private->DstAddress));\r | |
1380 | \r | |
1381 | InitializeListHead (&Private->TxList);\r | |
1382 | \r | |
1383 | //\r | |
1384 | // Open and configure a ip instance for us.\r | |
1385 | //\r | |
1386 | Status = PingCreateIpInstance (Private);\r | |
1387 | \r | |
1388 | if (EFI_ERROR (Status)) {\r | |
1389 | ShellStatus = SHELL_ACCESS_DENIED;\r | |
1390 | goto ON_EXIT;\r | |
1391 | }\r | |
1392 | //\r | |
1393 | // Print the command line itself.\r | |
1394 | //\r | |
1395 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_START), gShellNetwork1HiiHandle, mDstString, Private->BufferSize);\r | |
1396 | //\r | |
1397 | // Create a ipv6 token to receive the first icmp6 echo reply packet.\r | |
1398 | //\r | |
1399 | Status = Ping6ReceiveEchoReply (Private);\r | |
1400 | \r | |
1401 | if (EFI_ERROR (Status)) {\r | |
1402 | ShellStatus = SHELL_ACCESS_DENIED;\r | |
1403 | goto ON_EXIT;\r | |
1404 | }\r | |
1405 | //\r | |
1406 | // Create and start timer to send icmp6 echo request packet per second.\r | |
1407 | //\r | |
1408 | Status = gBS->CreateEvent (\r | |
1409 | EVT_TIMER | EVT_NOTIFY_SIGNAL,\r | |
1410 | TPL_CALLBACK,\r | |
1411 | Ping6OnTimerRoutine,\r | |
1412 | Private,\r | |
1413 | &Private->Timer\r | |
1414 | );\r | |
1415 | \r | |
1416 | if (EFI_ERROR (Status)) {\r | |
1417 | ShellStatus = SHELL_ACCESS_DENIED;\r | |
1418 | goto ON_EXIT;\r | |
1419 | }\r | |
2a326330 FS |
1420 | \r |
1421 | //\r | |
1422 | // Start a timer to calculate the RTT.\r | |
1423 | //\r | |
1424 | Status = PingInitRttTimer (Private);\r | |
1425 | if (EFI_ERROR (Status)) {\r | |
1426 | ShellStatus = SHELL_ACCESS_DENIED;\r | |
1427 | goto ON_EXIT;\r | |
1428 | }\r | |
ba0014b9 | 1429 | \r |
68fb0527 | 1430 | //\r |
1431 | // Create a ipv6 token to send the first icmp6 echo request packet.\r | |
1432 | //\r | |
1433 | Status = PingSendEchoRequest (Private);\r | |
1434 | //\r | |
1435 | // EFI_NOT_READY for IPsec is enable and IKE is not established.\r | |
1436 | //\r | |
1437 | if (EFI_ERROR (Status) && (Status != EFI_NOT_READY)) {\r | |
1438 | ShellStatus = SHELL_ACCESS_DENIED;\r | |
1439 | if(Status == EFI_NOT_FOUND) {\r | |
1440 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_NOSOURCE_INDO), gShellNetwork1HiiHandle, mDstString);\r | |
1441 | } else if (Status == RETURN_NO_MAPPING) {\r | |
1442 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_NOROUTE_FOUND), gShellNetwork1HiiHandle, mDstString, mSrcString);\r | |
1443 | } else {\r | |
ba0014b9 | 1444 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_PING_NETWORK_ERROR), gShellNetwork1HiiHandle, L"ping", Status);\r |
68fb0527 | 1445 | }\r |
1446 | \r | |
1447 | goto ON_EXIT;\r | |
1448 | }\r | |
1449 | \r | |
1450 | Status = gBS->SetTimer (\r | |
1451 | Private->Timer,\r | |
1452 | TimerPeriodic,\r | |
1453 | ONE_SECOND\r | |
1454 | );\r | |
1455 | \r | |
1456 | if (EFI_ERROR (Status)) {\r | |
1457 | ShellStatus = SHELL_ACCESS_DENIED;\r | |
1458 | goto ON_EXIT;\r | |
1459 | }\r | |
1460 | //\r | |
1461 | // Control the ping6 process by two factors:\r | |
1462 | // 1. Hot key\r | |
1463 | // 2. Private->Status\r | |
1464 | // 2.1. success means all icmp6 echo request packets get reply packets.\r | |
1465 | // 2.2. timeout means the last icmp6 echo reply request timeout to get reply.\r | |
1466 | // 2.3. noready means ping6 process is on-the-go.\r | |
1467 | //\r | |
1468 | while (Private->Status == EFI_NOT_READY) {\r | |
1469 | Status = Private->ProtocolPointers.Poll (Private->IpProtocol);\r | |
1470 | if (ShellGetExecutionBreakFlag()) {\r | |
1471 | Private->Status = EFI_ABORTED;\r | |
1472 | goto ON_STAT;\r | |
1473 | }\r | |
1474 | }\r | |
1475 | \r | |
1476 | ON_STAT:\r | |
1477 | //\r | |
1478 | // Display the statistics in all.\r | |
1479 | //\r | |
1480 | gBS->SetTimer (Private->Timer, TimerCancel, 0);\r | |
1481 | \r | |
1482 | if (Private->TxCount != 0) {\r | |
1483 | ShellPrintHiiEx (\r | |
1484 | -1,\r | |
1485 | -1,\r | |
1486 | NULL,\r | |
1487 | STRING_TOKEN (STR_PING_STAT),\r | |
1488 | gShellNetwork1HiiHandle,\r | |
1489 | Private->TxCount,\r | |
80f7a8f5 SSESPS |
1490 | (Private->RxCount - Private->FailedCount),\r |
1491 | (100 - ((100 * (Private->RxCount - Private->FailedCount)) / Private->TxCount)),\r | |
68fb0527 | 1492 | Private->RttSum\r |
1493 | );\r | |
1494 | }\r | |
1495 | \r | |
80f7a8f5 | 1496 | if (Private->RxCount > Private->FailedCount) {\r |
68fb0527 | 1497 | ShellPrintHiiEx (\r |
1498 | -1,\r | |
1499 | -1,\r | |
1500 | NULL,\r | |
1501 | STRING_TOKEN (STR_PING_RTT),\r | |
1502 | gShellNetwork1HiiHandle,\r | |
1503 | Private->RttMin,\r | |
2a326330 | 1504 | Private->RttMin + Private->TimerPeriod,\r |
68fb0527 | 1505 | Private->RttMax,\r |
2a326330 FS |
1506 | Private->RttMax + Private->TimerPeriod,\r |
1507 | DivU64x64Remainder (Private->RttSum, (Private->RxCount - Private->FailedCount), NULL),\r | |
1508 | DivU64x64Remainder (Private->RttSum, (Private->RxCount - Private->FailedCount), NULL) + Private->TimerPeriod\r | |
68fb0527 | 1509 | );\r |
1510 | }\r | |
1511 | \r | |
1512 | ON_EXIT:\r | |
1513 | \r | |
1514 | if (Private != NULL) {\r | |
1515 | \r | |
1516 | NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &Private->TxList) {\r | |
1517 | TxInfo = BASE_CR (Entry, PING_ICMPX_TX_INFO, Link);\r | |
1518 | \r | |
1519 | if (Private->IpProtocol != NULL && Private->ProtocolPointers.Cancel != NULL) {\r | |
1520 | Status = Private->ProtocolPointers.Cancel (Private->IpProtocol, TxInfo->Token);\r | |
1521 | }\r | |
1522 | \r | |
1523 | RemoveEntryList (&TxInfo->Link);\r | |
1524 | PingDestroyTxInfo (TxInfo, Private->IpChoice);\r | |
1525 | }\r | |
1526 | \r | |
2a326330 FS |
1527 | PingFreeRttTimer (Private);\r |
1528 | \r | |
68fb0527 | 1529 | if (Private->Timer != NULL) {\r |
1530 | gBS->CloseEvent (Private->Timer);\r | |
1531 | }\r | |
1532 | \r | |
1533 | if (Private->IpProtocol != NULL && Private->ProtocolPointers.Cancel != NULL) {\r | |
1534 | Status = Private->ProtocolPointers.Cancel (Private->IpProtocol, &Private->RxToken);\r | |
1535 | }\r | |
1536 | \r | |
1537 | if (Private->RxToken.Event != NULL) {\r | |
1538 | gBS->CloseEvent (Private->RxToken.Event);\r | |
1539 | }\r | |
1540 | \r | |
1541 | if (Private->IpChildHandle != NULL) {\r | |
75dce340 | 1542 | Ping6DestroyIp6Instance (Private);\r |
68fb0527 | 1543 | }\r |
1544 | \r | |
1545 | FreePool (Private);\r | |
1546 | }\r | |
1547 | \r | |
1548 | return ShellStatus;\r | |
1549 | }\r | |
1550 | \r | |
1551 | /**\r | |
1552 | Function for 'ping' command.\r | |
1553 | \r | |
1554 | @param[in] ImageHandle Handle to the Image (NULL if Internal).\r | |
1555 | @param[in] SystemTable Pointer to the System Table (NULL if Internal).\r | |
7c25b7ea | 1556 | \r |
1557 | @retval SHELL_SUCCESS The ping processed successfullly.\r | |
1558 | @retval others The ping processed unsuccessfully.\r | |
ba0014b9 | 1559 | \r |
68fb0527 | 1560 | **/\r |
1561 | SHELL_STATUS\r | |
1562 | EFIAPI\r | |
1563 | ShellCommandRunPing (\r | |
1564 | IN EFI_HANDLE ImageHandle,\r | |
1565 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1566 | )\r | |
1567 | {\r | |
1568 | EFI_STATUS Status;\r | |
1569 | SHELL_STATUS ShellStatus;\r | |
1570 | EFI_IPv6_ADDRESS DstAddress;\r | |
1571 | EFI_IPv6_ADDRESS SrcAddress;\r | |
1572 | UINT64 BufferSize;\r | |
1573 | UINTN SendNumber;\r | |
1574 | LIST_ENTRY *ParamPackage;\r | |
1575 | CONST CHAR16 *ValueStr;\r | |
1576 | UINTN NonOptionCount;\r | |
1577 | UINT32 IpChoice;\r | |
ab7c10f2 | 1578 | CHAR16 *ProblemParam;\r |
68fb0527 | 1579 | \r |
1580 | //\r | |
ba0014b9 | 1581 | // we use IPv6 buffers to hold items...\r |
68fb0527 | 1582 | // make sure this is enough space!\r |
1583 | //\r | |
1584 | ASSERT(sizeof(EFI_IPv4_ADDRESS ) <= sizeof(EFI_IPv6_ADDRESS ));\r | |
1585 | ASSERT(sizeof(EFI_IP4_COMPLETION_TOKEN) <= sizeof(EFI_IP6_COMPLETION_TOKEN ));\r | |
1586 | \r | |
1587 | IpChoice = PING_IP_CHOICE_IP4;\r | |
1588 | \r | |
1589 | ShellStatus = SHELL_SUCCESS;\r | |
ab7c10f2 | 1590 | ProblemParam = NULL;\r |
68fb0527 | 1591 | \r |
ab7c10f2 | 1592 | Status = ShellCommandLineParseEx (PingParamList, &ParamPackage, &ProblemParam, TRUE, FALSE);\r |
68fb0527 | 1593 | if (EFI_ERROR(Status)) {\r |
ab7c10f2 | 1594 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellNetwork1HiiHandle, L"ping", ProblemParam);\r |
68fb0527 | 1595 | ShellStatus = SHELL_INVALID_PARAMETER;\r |
1596 | goto ON_EXIT;\r | |
1597 | }\r | |
1598 | \r | |
1599 | if (ShellCommandLineGetFlag (ParamPackage, L"-_ip6")) {\r | |
1600 | IpChoice = PING_IP_CHOICE_IP6;\r | |
1601 | }\r | |
1602 | \r | |
1603 | //\r | |
268d3445 | 1604 | // Parse the parameter of count number.\r |
68fb0527 | 1605 | //\r |
1606 | ValueStr = ShellCommandLineGetValue (ParamPackage, L"-n");\r | |
1607 | if (ValueStr != NULL) {\r | |
1608 | SendNumber = ShellStrToUintn (ValueStr);\r | |
1609 | \r | |
1610 | //\r | |
1611 | // ShellStrToUintn will return 0 when input is 0 or an invalid input string.\r | |
1612 | //\r | |
1613 | if ((SendNumber == 0) || (SendNumber > MAX_SEND_NUMBER)) {\r | |
ba0014b9 | 1614 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellNetwork1HiiHandle, L"ping", ValueStr);\r |
68fb0527 | 1615 | ShellStatus = SHELL_INVALID_PARAMETER;\r |
1616 | goto ON_EXIT;\r | |
1617 | }\r | |
1618 | } else {\r | |
1619 | SendNumber = DEFAULT_SEND_COUNT;\r | |
1620 | }\r | |
1621 | //\r | |
268d3445 | 1622 | // Parse the parameter of buffer size.\r |
68fb0527 | 1623 | //\r |
1624 | ValueStr = ShellCommandLineGetValue (ParamPackage, L"-l");\r | |
1625 | if (ValueStr != NULL) {\r | |
1626 | BufferSize = ShellStrToUintn (ValueStr);\r | |
1627 | \r | |
1628 | //\r | |
1629 | // ShellStrToUintn will return 0 when input is 0 or an invalid input string.\r | |
1630 | //\r | |
1631 | if ((BufferSize < 16) || (BufferSize > MAX_BUFFER_SIZE)) {\r | |
ba0014b9 | 1632 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellNetwork1HiiHandle, L"ping", ValueStr);\r |
68fb0527 | 1633 | ShellStatus = SHELL_INVALID_PARAMETER;\r |
1634 | goto ON_EXIT;\r | |
1635 | }\r | |
1636 | } else {\r | |
1637 | BufferSize = DEFAULT_BUFFER_SIZE;\r | |
1638 | }\r | |
1639 | \r | |
1640 | ZeroMem (&SrcAddress, sizeof (EFI_IPv6_ADDRESS));\r | |
1641 | ZeroMem (&DstAddress, sizeof (EFI_IPv6_ADDRESS));\r | |
1642 | \r | |
1643 | //\r | |
268d3445 | 1644 | // Parse the parameter of source ip address.\r |
68fb0527 | 1645 | //\r |
0b42d7d8 JW |
1646 | ValueStr = ShellCommandLineGetValue (ParamPackage, L"-s");\r |
1647 | if (ValueStr == NULL) {\r | |
1648 | ValueStr = ShellCommandLineGetValue (ParamPackage, L"-_s");\r | |
1649 | }\r | |
ba0014b9 | 1650 | \r |
68fb0527 | 1651 | if (ValueStr != NULL) {\r |
1652 | mSrcString = ValueStr;\r | |
1653 | if (IpChoice == PING_IP_CHOICE_IP6) {\r | |
1654 | Status = NetLibStrToIp6 (ValueStr, &SrcAddress);\r | |
1655 | } else {\r | |
1656 | Status = NetLibStrToIp4 (ValueStr, (EFI_IPv4_ADDRESS*)&SrcAddress);\r | |
1657 | }\r | |
1658 | if (EFI_ERROR (Status)) {\r | |
ba0014b9 | 1659 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellNetwork1HiiHandle, L"ping", ValueStr);\r |
68fb0527 | 1660 | ShellStatus = SHELL_INVALID_PARAMETER;\r |
1661 | goto ON_EXIT;\r | |
1662 | }\r | |
1663 | }\r | |
1664 | //\r | |
268d3445 | 1665 | // Parse the parameter of destination ip address.\r |
68fb0527 | 1666 | //\r |
1667 | NonOptionCount = ShellCommandLineGetCount(ParamPackage);\r | |
1668 | if (NonOptionCount < 2) {\r | |
ba0014b9 | 1669 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellNetwork1HiiHandle, L"ping");\r |
68fb0527 | 1670 | ShellStatus = SHELL_INVALID_PARAMETER;\r |
1671 | goto ON_EXIT;\r | |
1672 | }\r | |
1673 | if (NonOptionCount > 2) {\r | |
ba0014b9 | 1674 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellNetwork1HiiHandle, L"ping");\r |
68fb0527 | 1675 | ShellStatus = SHELL_INVALID_PARAMETER;\r |
1676 | goto ON_EXIT;\r | |
1677 | }\r | |
1678 | ValueStr = ShellCommandLineGetRawValue (ParamPackage, 1);\r | |
1679 | if (ValueStr != NULL) {\r | |
1680 | mDstString = ValueStr;\r | |
1681 | if (IpChoice == PING_IP_CHOICE_IP6) {\r | |
1682 | Status = NetLibStrToIp6 (ValueStr, &DstAddress);\r | |
1683 | } else {\r | |
1684 | Status = NetLibStrToIp4 (ValueStr, (EFI_IPv4_ADDRESS*)&DstAddress);\r | |
1685 | }\r | |
1686 | if (EFI_ERROR (Status)) {\r | |
ba0014b9 | 1687 | ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellNetwork1HiiHandle, L"ping", ValueStr);\r |
68fb0527 | 1688 | ShellStatus = SHELL_INVALID_PARAMETER;\r |
1689 | goto ON_EXIT;\r | |
1690 | }\r | |
1691 | }\r | |
68fb0527 | 1692 | \r |
68fb0527 | 1693 | //\r |
1694 | // Enter into ping process.\r | |
1695 | //\r | |
1696 | ShellStatus = ShellPing (\r | |
1697 | (UINT32)SendNumber,\r | |
1698 | (UINT32)BufferSize,\r | |
1699 | &SrcAddress,\r | |
1700 | &DstAddress,\r | |
1701 | IpChoice\r | |
1702 | );\r | |
1703 | \r | |
1704 | ON_EXIT:\r | |
1705 | ShellCommandLineFreeVarList (ParamPackage);\r | |
1706 | return ShellStatus;\r | |
1707 | }\r |