]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/Ip6Dxe/Ip6Nd.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
1. Fix bugs for PXE-IPv6 to accommodate the situation:
[mirror_edk2.git] / NetworkPkg / Ip6Dxe / Ip6Nd.c
CommitLineData
a3bcde70
HT		 1/** @file\r
2 Implementation of Neighbor Discovery support routines.\r
3\r
76389e18 4 Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
a3bcde70
HT		 5\r
6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php.\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#include "Ip6Impl.h"\r
17\r
18EFI_MAC_ADDRESS mZeroMacAddress;\r
19\r
20/**\r
21 Update the ReachableTime in IP6 service binding instance data, in milliseconds.\r
22\r
23 @param[in, out] IpSb Points to the IP6_SERVICE.\r
24\r
25**/\r
26VOID\r
27Ip6UpdateReachableTime (\r
28 IN OUT IP6_SERVICE *IpSb\r
29 )\r
30{\r
31 UINT32 Random;\r
32\r
33 Random = (NetRandomInitSeed () / 4294967295UL) * IP6_RANDOM_FACTOR_SCALE;\r
34 Random = Random + IP6_MIN_RANDOM_FACTOR_SCALED;\r
35 IpSb->ReachableTime = (IpSb->BaseReachableTime * Random) / IP6_RANDOM_FACTOR_SCALE;\r
36}\r
37\r
38/**\r
39 Build a array of EFI_IP6_NEIGHBOR_CACHE to be returned to the caller. The number\r
40 of EFI_IP6_NEIGHBOR_CACHE is also returned.\r
41\r
42 @param[in] IpInstance The pointer to IP6_PROTOCOL instance.\r
43 @param[out] NeighborCount The number of returned neighbor cache entries.\r
44 @param[out] NeighborCache The pointer to the array of EFI_IP6_NEIGHBOR_CACHE.\r
45\r
46 @retval EFI_SUCCESS The EFI_IP6_NEIGHBOR_CACHE successfully built.\r
47 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the route table.\r
48\r
49**/\r
50EFI_STATUS\r
51Ip6BuildEfiNeighborCache (\r
52 IN IP6_PROTOCOL *IpInstance,\r
53 OUT UINT32 *NeighborCount,\r
54 OUT EFI_IP6_NEIGHBOR_CACHE **NeighborCache\r
55 )\r
56{\r
57 IP6_NEIGHBOR_ENTRY *Neighbor;\r
58 LIST_ENTRY *Entry;\r
59 IP6_SERVICE *IpSb;\r
60 UINT32 Count;\r
61 EFI_IP6_NEIGHBOR_CACHE *EfiNeighborCache;\r
62 EFI_IP6_NEIGHBOR_CACHE *NeighborCacheTmp;\r
63\r
64 NET_CHECK_SIGNATURE (IpInstance, IP6_PROTOCOL_SIGNATURE);\r
65 ASSERT (NeighborCount != NULL && NeighborCache != NULL);\r
66\r
67 IpSb = IpInstance->Service;\r
68 Count = 0;\r
69\r
70 NET_LIST_FOR_EACH (Entry, &IpSb->NeighborTable) {\r
71 Count++;\r
72 }\r
73\r
74 if (Count == 0) {\r
75 return EFI_SUCCESS;\r
76 }\r
77\r
78 NeighborCacheTmp = AllocatePool (Count * sizeof (EFI_IP6_NEIGHBOR_CACHE));\r
79 if (NeighborCacheTmp == NULL) {\r
80 return EFI_OUT_OF_RESOURCES;\r
81 }\r
82\r
83 *NeighborCount = Count;\r
84 Count = 0;\r
85\r
86 NET_LIST_FOR_EACH (Entry, &IpSb->NeighborTable) {\r
87 Neighbor = NET_LIST_USER_STRUCT (Entry, IP6_NEIGHBOR_ENTRY, Link);\r
88\r
89 EfiNeighborCache = NeighborCacheTmp + Count;\r
90\r
91 EfiNeighborCache->State = Neighbor->State;\r
92 IP6_COPY_ADDRESS (&EfiNeighborCache->Neighbor, &Neighbor->Neighbor);\r
93 IP6_COPY_LINK_ADDRESS (&EfiNeighborCache->LinkAddress, &Neighbor->LinkAddress);\r
94\r
95 Count++;\r
96 }\r
97\r
98 ASSERT (*NeighborCount == Count);\r
99 *NeighborCache = NeighborCacheTmp;\r
100\r
101 return EFI_SUCCESS;\r
102}\r
103\r
104/**\r
105 Build a array of EFI_IP6_ADDRESS_INFO to be returned to the caller. The number\r
106 of prefix entries is also returned.\r
107\r
108 @param[in] IpInstance The pointer to IP6_PROTOCOL instance.\r
109 @param[out] PrefixCount The number of returned prefix entries.\r
110 @param[out] PrefixTable The pointer to the array of PrefixTable.\r
111\r
112 @retval EFI_SUCCESS The prefix table successfully built.\r
113 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the prefix table.\r
114\r
115**/\r
116EFI_STATUS\r
117Ip6BuildPrefixTable (\r
118 IN IP6_PROTOCOL *IpInstance,\r
119 OUT UINT32 *PrefixCount,\r
120 OUT EFI_IP6_ADDRESS_INFO **PrefixTable\r
121 )\r
122{\r
123 LIST_ENTRY *Entry;\r
124 IP6_SERVICE *IpSb;\r
125 UINT32 Count;\r
126 IP6_PREFIX_LIST_ENTRY *PrefixList;\r
127 EFI_IP6_ADDRESS_INFO *EfiPrefix;\r
128 EFI_IP6_ADDRESS_INFO *PrefixTableTmp;\r
129\r
130 NET_CHECK_SIGNATURE (IpInstance, IP6_PROTOCOL_SIGNATURE);\r
131 ASSERT (PrefixCount != NULL && PrefixTable != NULL);\r
132\r
133 IpSb = IpInstance->Service;\r
134 Count = 0;\r
135\r
136 NET_LIST_FOR_EACH (Entry, &IpSb->OnlinkPrefix) {\r
137 Count++;\r
138 }\r
139\r
140 if (Count == 0) {\r
141 return EFI_SUCCESS;\r
142 }\r
143\r
144 PrefixTableTmp = AllocatePool (Count * sizeof (EFI_IP6_ADDRESS_INFO));\r
145 if (PrefixTableTmp == NULL) {\r
146 return EFI_OUT_OF_RESOURCES;\r
147 }\r
148\r
149 *PrefixCount = Count;\r
150 Count = 0;\r
151\r
152 NET_LIST_FOR_EACH (Entry, &IpSb->OnlinkPrefix) {\r
153 PrefixList = NET_LIST_USER_STRUCT (Entry, IP6_PREFIX_LIST_ENTRY, Link);\r
154 EfiPrefix = PrefixTableTmp + Count;\r
155 IP6_COPY_ADDRESS (&EfiPrefix->Address, &PrefixList->Prefix);\r
156 EfiPrefix->PrefixLength = PrefixList->PrefixLength;\r
157\r
158 Count++;\r
159 }\r
160\r
161 ASSERT (*PrefixCount == Count);\r
162 *PrefixTable = PrefixTableTmp;\r
163\r
164 return EFI_SUCCESS;\r
165}\r
166\r
167/**\r
168 Allocate and initialize a IP6 prefix list entry.\r
169\r
170 @param[in] IpSb The pointer to IP6_SERVICE instance.\r
171 @param[in] OnLinkOrAuto If TRUE, the entry is created for the on link prefix list.\r
172 Otherwise, it is created for the autoconfiguration prefix list.\r
173 @param[in] ValidLifetime The length of time in seconds that the prefix\r
174 is valid for the purpose of on-link determination.\r
175 @param[in] PreferredLifetime The length of time in seconds that addresses\r
176 generated from the prefix via stateless address\r
177 autoconfiguration remain preferred.\r
178 @param[in] PrefixLength The prefix length of the Prefix.\r
179 @param[in] Prefix The prefix address.\r
180\r
181 @return NULL if it failed to allocate memory for the prefix node. Otherwise, point\r
182 to the created or existing prefix list entry.\r
183\r
184**/\r
185IP6_PREFIX_LIST_ENTRY *\r
186Ip6CreatePrefixListEntry (\r
187 IN IP6_SERVICE *IpSb,\r
188 IN BOOLEAN OnLinkOrAuto,\r
189 IN UINT32 ValidLifetime,\r
190 IN UINT32 PreferredLifetime,\r
191 IN UINT8 PrefixLength,\r
192 IN EFI_IPv6_ADDRESS *Prefix\r
193 )\r
194{\r
195 IP6_PREFIX_LIST_ENTRY *PrefixEntry;\r
196 IP6_ROUTE_ENTRY *RtEntry;\r
197 LIST_ENTRY *ListHead;\r
198 LIST_ENTRY *Entry;\r
199 IP6_PREFIX_LIST_ENTRY *TmpPrefixEntry;\r
200\r
201 if (Prefix == NULL || PreferredLifetime > ValidLifetime || PrefixLength >= IP6_PREFIX_NUM) {\r
202 return NULL;\r
203 }\r
204\r
205 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
206\r
207 PrefixEntry = Ip6FindPrefixListEntry (\r
208 IpSb,\r
209 OnLinkOrAuto,\r
210 PrefixLength,\r
211 Prefix\r
212 );\r
213 if (PrefixEntry != NULL) {\r
214 PrefixEntry->RefCnt ++;\r
215 return PrefixEntry;\r
216 }\r
217\r
218 PrefixEntry = AllocatePool (sizeof (IP6_PREFIX_LIST_ENTRY));\r
219 if (PrefixEntry == NULL) {\r
220 return NULL;\r
221 }\r
222\r
223 PrefixEntry->RefCnt = 1;\r
224 PrefixEntry->ValidLifetime = ValidLifetime;\r
225 PrefixEntry->PreferredLifetime = PreferredLifetime;\r
226 PrefixEntry->PrefixLength = PrefixLength;\r
227 IP6_COPY_ADDRESS (&PrefixEntry->Prefix, Prefix);\r
228\r
229 ListHead = OnLinkOrAuto ? &IpSb->OnlinkPrefix : &IpSb->AutonomousPrefix;\r
230\r
231 //\r
232 // Create a direct route entry for on-link prefix and insert to route area.\r
233 //\r
234 if (OnLinkOrAuto) {\r
235 RtEntry = Ip6CreateRouteEntry (Prefix, PrefixLength, NULL);\r
236 if (RtEntry == NULL) {\r
237 FreePool (PrefixEntry);\r
238 return NULL;\r
239 }\r
240\r
241 RtEntry->Flag = IP6_DIRECT_ROUTE;\r
242 InsertHeadList (&IpSb->RouteTable->RouteArea[PrefixLength], &RtEntry->Link);\r
243 IpSb->RouteTable->TotalNum++;\r
244 }\r
245\r
246 //\r
247 // Insert the prefix entry in the order that a prefix with longer prefix length\r
248 // is put ahead in the list.\r
249 //\r
250 NET_LIST_FOR_EACH (Entry, ListHead) {\r
251 TmpPrefixEntry = NET_LIST_USER_STRUCT(Entry, IP6_PREFIX_LIST_ENTRY, Link);\r
252\r
253 if (TmpPrefixEntry->PrefixLength < PrefixEntry->PrefixLength) {\r
254 break;\r
255 }\r
256 }\r
257\r
258 NetListInsertBefore (Entry, &PrefixEntry->Link);\r
259\r
260 return PrefixEntry;\r
261}\r
262\r
263/**\r
264 Destory a IP6 prefix list entry.\r
265\r
266 @param[in] IpSb The pointer to IP6_SERVICE instance.\r
267 @param[in] PrefixEntry The to be destroyed prefix list entry.\r
268 @param[in] OnLinkOrAuto If TRUE, the entry is removed from on link prefix list.\r
269 Otherwise remove from autoconfiguration prefix list.\r
270 @param[in] ImmediateDelete If TRUE, remove the entry directly.\r
271 Otherwise, check the reference count to see whether\r
272 it should be removed.\r
273\r
274**/\r
275VOID\r
276Ip6DestroyPrefixListEntry (\r
277 IN IP6_SERVICE *IpSb,\r
278 IN IP6_PREFIX_LIST_ENTRY *PrefixEntry,\r
279 IN BOOLEAN OnLinkOrAuto,\r
280 IN BOOLEAN ImmediateDelete\r
281 )\r
282{\r
283 LIST_ENTRY *Entry;\r
284 IP6_INTERFACE *IpIf;\r
285 EFI_STATUS Status;\r
286\r
287 if ((!ImmediateDelete) && (PrefixEntry->RefCnt > 0) && ((--PrefixEntry->RefCnt) > 0)) {\r
288 return ;\r
289 }\r
290\r
291 if (OnLinkOrAuto) {\r
292 //\r
293 // Remove the direct route for onlink prefix from route table.\r
294 //\r
295 do {\r
296 Status = Ip6DelRoute (\r
297 IpSb->RouteTable,\r
298 &PrefixEntry->Prefix,\r
299 PrefixEntry->PrefixLength,\r
300 NULL\r
301 );\r
302 } while (Status != EFI_NOT_FOUND);\r
303 } else {\r
304 //\r
305 // Remove the corresponding addresses generated from this autonomous prefix.\r
306 //\r
307 NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) {\r
308 IpIf = NET_LIST_USER_STRUCT_S (Entry, IP6_INTERFACE, Link, IP6_INTERFACE_SIGNATURE);\r
309\r
310 Ip6RemoveAddr (IpSb, &IpIf->AddressList, &IpIf->AddressCount, &PrefixEntry->Prefix, PrefixEntry->PrefixLength);\r
311 }\r
312 }\r
313\r
314 RemoveEntryList (&PrefixEntry->Link);\r
315 FreePool (PrefixEntry);\r
316}\r
317\r
318/**\r
319 Search the list array to find an IP6 prefix list entry.\r
320\r
321 @param[in] IpSb The pointer to IP6_SERVICE instance.\r
322 @param[in] OnLinkOrAuto If TRUE, the search the link prefix list,\r
323 Otherwise search the autoconfiguration prefix list.\r
324 @param[in] PrefixLength The prefix length of the Prefix\r
325 @param[in] Prefix The prefix address.\r
326\r
327 @return NULL if cannot find the IP6 prefix list entry. Otherwise, return the\r
328 pointer to the IP6 prefix list entry.\r
329\r
330**/\r
331IP6_PREFIX_LIST_ENTRY *\r
332Ip6FindPrefixListEntry (\r
333 IN IP6_SERVICE *IpSb,\r
334 IN BOOLEAN OnLinkOrAuto,\r
335 IN UINT8 PrefixLength,\r
336 IN EFI_IPv6_ADDRESS *Prefix\r
337 )\r
338{\r
339 IP6_PREFIX_LIST_ENTRY *PrefixList;\r
340 LIST_ENTRY *Entry;\r
341 LIST_ENTRY *ListHead;\r
342\r
343 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
344 ASSERT (Prefix != NULL);\r
345\r
346 if (OnLinkOrAuto) {\r
347 ListHead = &IpSb->OnlinkPrefix;\r
348 } else {\r
349 ListHead = &IpSb->AutonomousPrefix;\r
350 }\r
351\r
352 NET_LIST_FOR_EACH (Entry, ListHead) {\r
353 PrefixList = NET_LIST_USER_STRUCT (Entry, IP6_PREFIX_LIST_ENTRY, Link);\r
354 if (PrefixLength != 255) {\r
355 //\r
356 // Perform exactly prefix match.\r
357 //\r
358 if (PrefixList->PrefixLength == PrefixLength &&\r
359 NetIp6IsNetEqual (&PrefixList->Prefix, Prefix, PrefixLength)) {\r
360 return PrefixList;\r
361 }\r
362 } else {\r
363 //\r
364 // Perform the longest prefix match. The list is already sorted with\r
365 // the longest length prefix put at the head of the list.\r
366 //\r
367 if (NetIp6IsNetEqual (&PrefixList->Prefix, Prefix, PrefixList->PrefixLength)) {\r
368 return PrefixList;\r
369 }\r
370 }\r
371 }\r
372\r
373 return NULL;\r
374}\r
375\r
376/**\r
377 Release the resource in the prefix list table, and destroy the list entry and\r
378 corresponding addresses or route entries.\r
379\r
380 @param[in] IpSb The pointer to the IP6_SERVICE instance.\r
381 @param[in] ListHead The list entry head of the prefix list table.\r
382\r
383**/\r
384VOID\r
385Ip6CleanPrefixListTable (\r
386 IN IP6_SERVICE *IpSb,\r
387 IN LIST_ENTRY *ListHead\r
388 )\r
389{\r
390 IP6_PREFIX_LIST_ENTRY *PrefixList;\r
391 BOOLEAN OnLink;\r
392\r
393 OnLink = (BOOLEAN) (ListHead == &IpSb->OnlinkPrefix);\r
394\r
395 while (!IsListEmpty (ListHead)) {\r
396 PrefixList = NET_LIST_HEAD (ListHead, IP6_PREFIX_LIST_ENTRY, Link);\r
397 Ip6DestroyPrefixListEntry (IpSb, PrefixList, OnLink, TRUE);\r
398 }\r
399}\r
400\r
401/**\r
402 Callback function when address resolution is finished. It will cancel\r
403 all the queued frames if the address resolution failed, or transmit them\r
404 if the request succeeded.\r
405\r
406 @param[in] Context The context of the callback, a pointer to IP6_NEIGHBOR_ENTRY.\r
407\r
408**/\r
409VOID\r
410Ip6OnArpResolved (\r
411 IN VOID *Context\r
412 )\r
413{\r
414 LIST_ENTRY *Entry;\r
415 LIST_ENTRY *Next;\r
416 IP6_NEIGHBOR_ENTRY *ArpQue;\r
417 IP6_SERVICE *IpSb;\r
418 IP6_LINK_TX_TOKEN *Token;\r
419 EFI_STATUS Status;\r
420 BOOLEAN Sent;\r
421\r
422 ArpQue = (IP6_NEIGHBOR_ENTRY *) Context;\r
423 if ((ArpQue == NULL) || (ArpQue->Interface == NULL)) {\r
424 return ;\r
425 }\r
426\r
427 IpSb = ArpQue->Interface->Service;\r
428 if ((IpSb == NULL) || (IpSb->Signature != IP6_SERVICE_SIGNATURE)) {\r
429 return ;\r
430 }\r
431\r
432 //\r
433 // ARP resolve failed for some reason. Release all the frame\r
434 // and ARP queue itself. Ip6FreeArpQue will call the frame's\r
435 // owner back.\r
436 //\r
437 if (NET_MAC_EQUAL (&ArpQue->LinkAddress, &mZeroMacAddress, IpSb->SnpMode.HwAddressSize)) {\r
438 Ip6FreeNeighborEntry (IpSb, ArpQue, FALSE, TRUE, EFI_NO_MAPPING, NULL, NULL);\r
439 return ;\r
440 }\r
441\r
442 //\r
443 // ARP resolve succeeded, Transmit all the frame.\r
444 //\r
445 Sent = FALSE;\r
446 NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) {\r
447 RemoveEntryList (Entry);\r
448\r
449 Token = NET_LIST_USER_STRUCT (Entry, IP6_LINK_TX_TOKEN, Link);\r
450 IP6_COPY_LINK_ADDRESS (&Token->DstMac, &ArpQue->LinkAddress);\r
451\r
452 //\r
453 // Insert the tx token before transmitting it via MNP as the FrameSentDpc\r
454 // may be called before Mnp->Transmit returns which will remove this tx\r
455 // token from the SentFrames list. Remove it from the list if the returned\r
456 // Status of Mnp->Transmit is not EFI_SUCCESS as in this case the\r
457 // FrameSentDpc won't be queued.\r
458 //\r
459 InsertTailList (&ArpQue->Interface->SentFrames, &Token->Link);\r
460\r
461 Status = IpSb->Mnp->Transmit (IpSb->Mnp, &Token->MnpToken);\r
462 if (EFI_ERROR (Status)) {\r
463 RemoveEntryList (&Token->Link);\r
464 Token->CallBack (Token->Packet, Status, 0, Token->Context);\r
465\r
466 Ip6FreeLinkTxToken (Token);\r
467 continue;\r
468 } else {\r
469 Sent = TRUE;\r
470 }\r
471 }\r
472\r
473 //\r
474 // Free the ArpQue only but not the whole neighbor entry.\r
475 //\r
476 Ip6FreeNeighborEntry (IpSb, ArpQue, FALSE, FALSE, EFI_SUCCESS, NULL, NULL);\r
477\r
478 if (Sent && (ArpQue->State == EfiNeighborStale)) {\r
479 ArpQue->State = EfiNeighborDelay;\r
480 ArpQue->Ticks = (UINT32) IP6_GET_TICKS (IP6_DELAY_FIRST_PROBE_TIME);\r
481 }\r
482}\r
483\r
484/**\r
485 Allocate and initialize an IP6 neighbor cache entry.\r
486\r
487 @param[in] IpSb The pointer to the IP6_SERVICE instance.\r
488 @param[in] CallBack The callback function to be called when\r
489 address resolution is finished.\r
490 @param[in] Ip6Address Points to the IPv6 address of the neighbor.\r
491 @param[in] LinkAddress Points to the MAC address of the neighbor.\r
492 Ignored if NULL.\r
493\r
494 @return NULL if failed to allocate memory for the neighbor cache entry.\r
495 Otherwise, point to the created neighbor cache entry.\r
496\r
497**/\r
498IP6_NEIGHBOR_ENTRY *\r
499Ip6CreateNeighborEntry (\r
500 IN IP6_SERVICE *IpSb,\r
501 IN IP6_ARP_CALLBACK CallBack,\r
502 IN EFI_IPv6_ADDRESS *Ip6Address,\r
503 IN EFI_MAC_ADDRESS *LinkAddress OPTIONAL\r
504 )\r
505{\r
506 IP6_NEIGHBOR_ENTRY *Entry;\r
507 IP6_DEFAULT_ROUTER *DefaultRouter;\r
508\r
509 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
510 ASSERT (Ip6Address!= NULL);\r
511\r
512 Entry = AllocateZeroPool (sizeof (IP6_NEIGHBOR_ENTRY));\r
513 if (Entry == NULL) {\r
514 return NULL;\r
515 }\r
516\r
517 Entry->RefCnt = 1;\r
518 Entry->IsRouter = FALSE;\r
519 Entry->ArpFree = FALSE;\r
520 Entry->Dynamic = FALSE;\r
521 Entry->State = EfiNeighborInComplete;\r
522 Entry->Transmit = IP6_MAX_MULTICAST_SOLICIT + 1;\r
523 Entry->CallBack = CallBack;\r
524 Entry->Interface = NULL;\r
525\r
526 InitializeListHead (&Entry->Frames);\r
527\r
528 IP6_COPY_ADDRESS (&Entry->Neighbor, Ip6Address);\r
529\r
530 if (LinkAddress != NULL) {\r
531 IP6_COPY_LINK_ADDRESS (&Entry->LinkAddress, LinkAddress);\r
532 } else {\r
533 IP6_COPY_LINK_ADDRESS (&Entry->LinkAddress, &mZeroMacAddress);\r
534 }\r
535\r
536 InsertHeadList (&IpSb->NeighborTable, &Entry->Link);\r
537\r
538 //\r
539 // If corresponding default router entry exists, establish the relationship.\r
540 //\r
541 DefaultRouter = Ip6FindDefaultRouter (IpSb, Ip6Address);\r
542 if (DefaultRouter != NULL) {\r
543 DefaultRouter->NeighborCache = Entry;\r
544 }\r
545\r
546 return Entry;\r
547}\r
548\r
549/**\r
550 Search a IP6 neighbor cache entry.\r
551\r
552 @param[in] IpSb The pointer to the IP6_SERVICE instance.\r
553 @param[in] Ip6Address Points to the IPv6 address of the neighbor.\r
554\r
555 @return NULL if it failed to find the matching neighbor cache entry.\r
556 Otherwise, point to the found neighbor cache entry.\r
557\r
558**/\r
559IP6_NEIGHBOR_ENTRY *\r
560Ip6FindNeighborEntry (\r
561 IN IP6_SERVICE *IpSb,\r
562 IN EFI_IPv6_ADDRESS *Ip6Address\r
563 )\r
564{\r
565 LIST_ENTRY *Entry;\r
566 LIST_ENTRY *Next;\r
567 IP6_NEIGHBOR_ENTRY *Neighbor;\r
568\r
569 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
570 ASSERT (Ip6Address != NULL);\r
571\r
572 NET_LIST_FOR_EACH_SAFE (Entry, Next, &IpSb->NeighborTable) {\r
573 Neighbor = NET_LIST_USER_STRUCT (Entry, IP6_NEIGHBOR_ENTRY, Link);\r
574 if (EFI_IP6_EQUAL (Ip6Address, &Neighbor->Neighbor)) {\r
575 RemoveEntryList (Entry);\r
576 InsertHeadList (&IpSb->NeighborTable, Entry);\r
577\r
578 return Neighbor;\r
579 }\r
580 }\r
581\r
582 return NULL;\r
583}\r
584\r
585/**\r
586 Free a IP6 neighbor cache entry and remove all the frames on the address\r
587 resolution queue that pass the FrameToCancel. That is, either FrameToCancel\r
588 is NULL, or it returns true for the frame.\r
589\r
590 @param[in] IpSb The pointer to the IP6_SERVICE instance.\r
591 @param[in] NeighborCache The to be free neighbor cache entry.\r
592 @param[in] SendIcmpError If TRUE, send out ICMP error.\r
593 @param[in] FullFree If TRUE, remove the neighbor cache entry.\r
594 Otherwise remove the pending frames.\r
595 @param[in] IoStatus The status returned to the cancelled frames'\r
596 callback function.\r
597 @param[in] FrameToCancel Function to select which frame to cancel.\r
598 This is an optional parameter that may be NULL.\r
599 @param[in] Context Opaque parameter to the FrameToCancel.\r
600 Ignored if FrameToCancel is NULL.\r
601\r
602 @retval EFI_INVALID_PARAMETER The input parameter is invalid.\r
603 @retval EFI_SUCCESS The operation finished successfully.\r
604\r
605**/\r
606EFI_STATUS\r
607Ip6FreeNeighborEntry (\r
608 IN IP6_SERVICE *IpSb,\r
609 IN IP6_NEIGHBOR_ENTRY *NeighborCache,\r
610 IN BOOLEAN SendIcmpError,\r
611 IN BOOLEAN FullFree,\r
612 IN EFI_STATUS IoStatus,\r
613 IN IP6_FRAME_TO_CANCEL FrameToCancel OPTIONAL,\r
614 IN VOID *Context OPTIONAL\r
615 )\r
616{\r
617 IP6_LINK_TX_TOKEN *TxToken;\r
618 LIST_ENTRY *Entry;\r
619 LIST_ENTRY *Next;\r
620 IP6_DEFAULT_ROUTER *DefaultRouter;\r
621\r
622 //\r
623 // If FrameToCancel fails, the token will not be released.\r
624 // To avoid the memory leak, stop this usage model.\r
625 //\r
626 if (FullFree && FrameToCancel != NULL) {\r
627 return EFI_INVALID_PARAMETER;\r
628 }\r
629\r
630 NET_LIST_FOR_EACH_SAFE (Entry, Next, &NeighborCache->Frames) {\r
631 TxToken = NET_LIST_USER_STRUCT (Entry, IP6_LINK_TX_TOKEN, Link);\r
632\r
633 if (SendIcmpError && !IP6_IS_MULTICAST (&TxToken->Packet->Ip.Ip6->DestinationAddress)) {\r
634 Ip6SendIcmpError (\r
635 IpSb,\r
636 TxToken->Packet,\r
637 NULL,\r
638 &TxToken->Packet->Ip.Ip6->SourceAddress,\r
639 ICMP_V6_DEST_UNREACHABLE,\r
640 ICMP_V6_ADDR_UNREACHABLE,\r
641 NULL\r
642 );\r
643 }\r
644\r
645 if ((FrameToCancel == NULL) || FrameToCancel (TxToken, Context)) {\r
646 RemoveEntryList (Entry);\r
647 TxToken->CallBack (TxToken->Packet, IoStatus, 0, TxToken->Context);\r
648 Ip6FreeLinkTxToken (TxToken);\r
649 }\r
650 }\r
651\r
652 if (NeighborCache->ArpFree && IsListEmpty (&NeighborCache->Frames)) {\r
653 RemoveEntryList (&NeighborCache->ArpList);\r
654 NeighborCache->ArpFree = FALSE;\r
655 }\r
656\r
657 if (FullFree) {\r
658 if (NeighborCache->IsRouter) {\r
659 DefaultRouter = Ip6FindDefaultRouter (IpSb, &NeighborCache->Neighbor);\r
660 if (DefaultRouter != NULL) {\r
661 Ip6DestroyDefaultRouter (IpSb, DefaultRouter);\r
662 }\r
663 }\r
664\r
665 RemoveEntryList (&NeighborCache->Link);\r
666 FreePool (NeighborCache);\r
667 }\r
668\r
669 return EFI_SUCCESS;\r
670}\r
671\r
672/**\r
673 Allocate and initialize an IP6 default router entry.\r
674\r
675 @param[in] IpSb The pointer to the IP6_SERVICE instance.\r
676 @param[in] Ip6Address The IPv6 address of the default router.\r
677 @param[in] RouterLifetime The lifetime associated with the default\r
678 router, in units of seconds.\r
679\r
680 @return NULL if it failed to allocate memory for the default router node.\r
681 Otherwise, point to the created default router node.\r
682\r
683**/\r
684IP6_DEFAULT_ROUTER *\r
685Ip6CreateDefaultRouter (\r
686 IN IP6_SERVICE *IpSb,\r
687 IN EFI_IPv6_ADDRESS *Ip6Address,\r
688 IN UINT16 RouterLifetime\r
689 )\r
690{\r
691 IP6_DEFAULT_ROUTER *Entry;\r
692 IP6_ROUTE_ENTRY *RtEntry;\r
693\r
694 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
695 ASSERT (Ip6Address != NULL);\r
696\r
697 Entry = AllocatePool (sizeof (IP6_DEFAULT_ROUTER));\r
698 if (Entry == NULL) {\r
699 return NULL;\r
700 }\r
701\r
702 Entry->RefCnt = 1;\r
703 Entry->Lifetime = RouterLifetime;\r
704 Entry->NeighborCache = Ip6FindNeighborEntry (IpSb, Ip6Address);\r
705 IP6_COPY_ADDRESS (&Entry->Router, Ip6Address);\r
706\r
707 //\r
708 // Add a default route into route table with both Destination and PrefixLength set to zero.\r
709 //\r
710 RtEntry = Ip6CreateRouteEntry (NULL, 0, Ip6Address);\r
711 if (RtEntry == NULL) {\r
712 FreePool (Entry);\r
713 return NULL;\r
714 }\r
715\r
716 InsertHeadList (&IpSb->RouteTable->RouteArea[0], &RtEntry->Link);\r
717 IpSb->RouteTable->TotalNum++;\r
718\r
719 InsertTailList (&IpSb->DefaultRouterList, &Entry->Link);\r
720\r
721 return Entry;\r
722}\r
723\r
724/**\r
725 Destroy an IP6 default router entry.\r
726\r
727 @param[in] IpSb The pointer to the IP6_SERVICE instance.\r
728 @param[in] DefaultRouter The to be destroyed IP6_DEFAULT_ROUTER.\r
729\r
730**/\r
731VOID\r
732Ip6DestroyDefaultRouter (\r
733 IN IP6_SERVICE *IpSb,\r
734 IN IP6_DEFAULT_ROUTER *DefaultRouter\r
735 )\r
736{\r
737 EFI_STATUS Status;\r
738\r
739 RemoveEntryList (&DefaultRouter->Link);\r
740\r
741 //\r
742 // Update the Destination Cache - all entries using the time-out router as next-hop\r
743 // should perform next-hop determination again.\r
744 //\r
745 do {\r
746 Status = Ip6DelRoute (IpSb->RouteTable, NULL, 0, &DefaultRouter->Router);\r
747 } while (Status != EFI_NOT_FOUND);\r
748\r
749 FreePool (DefaultRouter);\r
750}\r
751\r
752/**\r
753 Clean an IP6 default router list.\r
754\r
755 @param[in] IpSb The pointer to the IP6_SERVICE instance.\r
a3bcde70
HT		 756\r
757**/\r
758VOID\r
759Ip6CleanDefaultRouterList (\r
760 IN IP6_SERVICE *IpSb\r
761 )\r
762{\r
763 IP6_DEFAULT_ROUTER *DefaultRouter;\r
764\r
765 while (!IsListEmpty (&IpSb->DefaultRouterList)) {\r
766 DefaultRouter = NET_LIST_HEAD (&IpSb->DefaultRouterList, IP6_DEFAULT_ROUTER, Link);\r
767 Ip6DestroyDefaultRouter (IpSb, DefaultRouter);\r
768 }\r
769}\r
770\r
771/**\r
772 Search a default router node from an IP6 default router list.\r
773\r
774 @param[in] IpSb The pointer to the IP6_SERVICE instance.\r
775 @param[in] Ip6Address The IPv6 address of the to be searched default router node.\r
776\r
777 @return NULL if it failed to find the matching default router node.\r
778 Otherwise, point to the found default router node.\r
779\r
780**/\r
781IP6_DEFAULT_ROUTER *\r
782Ip6FindDefaultRouter (\r
783 IN IP6_SERVICE *IpSb,\r
784 IN EFI_IPv6_ADDRESS *Ip6Address\r
785 )\r
786{\r
787 LIST_ENTRY *Entry;\r
788 IP6_DEFAULT_ROUTER *DefaultRouter;\r
789\r
790 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
791 ASSERT (Ip6Address != NULL);\r
792\r
793 NET_LIST_FOR_EACH (Entry, &IpSb->DefaultRouterList) {\r
794 DefaultRouter = NET_LIST_USER_STRUCT (Entry, IP6_DEFAULT_ROUTER, Link);\r
795 if (EFI_IP6_EQUAL (Ip6Address, &DefaultRouter->Router)) {\r
796 return DefaultRouter;\r
797 }\r
798 }\r
799\r
800 return NULL;\r
801}\r
802\r
803/**\r
804 The function to be called after DAD (Duplicate Address Detection) is performed.\r
805\r
806 @param[in] IsDadPassed If TRUE, the DAD operation succeed. Otherwise, the DAD operation failed.\r
807 @param[in] IpIf Points to the IP6_INTERFACE.\r
808 @param[in] DadEntry The DAD entry which already performed DAD.\r
809\r
810**/\r
811VOID\r
812Ip6OnDADFinished (\r
813 IN BOOLEAN IsDadPassed,\r
814 IN IP6_INTERFACE *IpIf,\r
815 IN IP6_DAD_ENTRY *DadEntry\r
816 )\r
817{\r
818 IP6_SERVICE *IpSb;\r
819 IP6_ADDRESS_INFO *AddrInfo;\r
820 EFI_DHCP6_PROTOCOL *Dhcp6;\r
821 UINT16 OptBuf[4];\r
822 EFI_DHCP6_PACKET_OPTION *Oro;\r
823 EFI_DHCP6_RETRANSMISSION InfoReqReXmit;\r
824\r
825 IpSb = IpIf->Service;\r
826 AddrInfo = DadEntry->AddressInfo;\r
827\r
828 if (IsDadPassed) {\r
829 //\r
830 // DAD succeed.\r
831 //\r
832 if (NetIp6IsLinkLocalAddr (&AddrInfo->Address)) {\r
833 ASSERT (!IpSb->LinkLocalOk);\r
834\r
835 IP6_COPY_ADDRESS (&IpSb->LinkLocalAddr, &AddrInfo->Address);\r
836 IpSb->LinkLocalOk = TRUE;\r
837 IpIf->Configured = TRUE;\r
838\r
839 //\r
840 // Check whether DHCP6 need to be started.\r
841 //\r
842 Dhcp6 = IpSb->Ip6ConfigInstance.Dhcp6;\r
843\r
844 if (IpSb->Dhcp6NeedStart) {\r
845 Dhcp6->Start (Dhcp6);\r
846 IpSb->Dhcp6NeedStart = FALSE;\r
847 }\r
848\r
849 if (IpSb->Dhcp6NeedInfoRequest) {\r
850 //\r
851 // Set the exta options to send. Here we only want the option request option\r
852 // with DNS SERVERS.\r
853 //\r
854 Oro = (EFI_DHCP6_PACKET_OPTION *) OptBuf;\r
855 Oro->OpCode = HTONS (IP6_CONFIG_DHCP6_OPTION_ORO);\r
856 Oro->OpLen = HTONS (2);\r
857 *((UINT16 *) &Oro->Data[0]) = HTONS (IP6_CONFIG_DHCP6_OPTION_DNS_SERVERS);\r
858\r
859 InfoReqReXmit.Irt = 4;\r
860 InfoReqReXmit.Mrc = 64;\r
861 InfoReqReXmit.Mrt = 60;\r
862 InfoReqReXmit.Mrd = 0;\r
863\r
864 Dhcp6->InfoRequest (\r
865 Dhcp6,\r
866 TRUE,\r
867 Oro,\r
868 0,\r
869 NULL,\r
870 &InfoReqReXmit,\r
871 IpSb->Ip6ConfigInstance.Dhcp6Event,\r
872 Ip6ConfigOnDhcp6Reply,\r
873 &IpSb->Ip6ConfigInstance\r
874 );\r
875 }\r
876\r
877 //\r
878 // Add an on-link prefix for link-local address.\r
879 //\r
880 Ip6CreatePrefixListEntry (\r
881 IpSb,\r
882 TRUE,\r
883 (UINT32) IP6_INFINIT_LIFETIME,\r
884 (UINT32) IP6_INFINIT_LIFETIME,\r
885 IP6_LINK_LOCAL_PREFIX_LENGTH,\r
886 &IpSb->LinkLocalAddr\r
887 );\r
888\r
889 } else {\r
890 //\r
891 // Global scope unicast address.\r
892 //\r
893 Ip6AddAddr (IpIf, AddrInfo);\r
894\r
895 //\r
896 // Add an on-link prefix for this address.\r
897 //\r
898 Ip6CreatePrefixListEntry (\r
899 IpSb,\r
900 TRUE,\r
901 AddrInfo->ValidLifetime,\r
902 AddrInfo->PreferredLifetime,\r
903 AddrInfo->PrefixLength,\r
904 &AddrInfo->Address\r
905 );\r
906\r
907 IpIf->Configured = TRUE;\r
908 }\r
909 } else {\r
910 //\r
911 // Leave the group we joined before.\r
912 //\r
913 Ip6LeaveGroup (IpSb, &DadEntry->Destination);\r
914 }\r
915\r
916 if (DadEntry->Callback != NULL) {\r
917 DadEntry->Callback (IsDadPassed, &AddrInfo->Address, DadEntry->Context);\r
918 }\r
919\r
920 if (!IsDadPassed && NetIp6IsLinkLocalAddr (&AddrInfo->Address)) {\r
921 FreePool (AddrInfo);\r
922 RemoveEntryList (&DadEntry->Link);\r
923 FreePool (DadEntry);\r
924 //\r
925 // Disable IP operation since link-local address is a duplicate address.\r
926 //\r
927 IpSb->LinkLocalDadFail = TRUE;\r
928 IpSb->Mnp->Configure (IpSb->Mnp, NULL);\r
929 gBS->SetTimer (IpSb->Timer, TimerCancel, 0);\r
930 gBS->SetTimer (IpSb->FasterTimer, TimerCancel, 0);\r
931 return ;\r
932 }\r
933\r
934 if (!IsDadPassed || NetIp6IsLinkLocalAddr (&AddrInfo->Address)) {\r
935 //\r
936 // Free the AddressInfo we hold if DAD fails or it is a link-local address.\r
937 //\r
938 FreePool (AddrInfo);\r
939 }\r
940\r
941 RemoveEntryList (&DadEntry->Link);\r
942 FreePool (DadEntry);\r
943}\r
944\r
945/**\r
946 Create a DAD (Duplicate Address Detection) entry and queue it to be performed.\r
947\r
948 @param[in] IpIf Points to the IP6_INTERFACE.\r
949 @param[in] AddressInfo The address information which needs DAD performed.\r
950 @param[in] Callback The callback routine that will be called after DAD\r
951 is performed. This is an optional parameter that\r
952 may be NULL.\r
953 @param[in] Context The opaque parameter for a DAD callback routine.\r
954 This is an optional parameter that may be NULL.\r
955\r
956 @retval EFI_SUCCESS The DAD entry was created and queued.\r
957 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory to complete the\r
958 operation.\r
959\r
960\r
961**/\r
962EFI_STATUS\r
963Ip6InitDADProcess (\r
964 IN IP6_INTERFACE *IpIf,\r
965 IN IP6_ADDRESS_INFO *AddressInfo,\r
966 IN IP6_DAD_CALLBACK Callback OPTIONAL,\r
967 IN VOID *Context OPTIONAL\r
968 )\r
969{\r
970 IP6_DAD_ENTRY *Entry;\r
971 EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS *DadXmits;\r
972 IP6_SERVICE *IpSb;\r
973 EFI_STATUS Status;\r
974 UINT32 MaxDelayTick;\r
975\r
976 NET_CHECK_SIGNATURE (IpIf, IP6_INTERFACE_SIGNATURE);\r
977 ASSERT (AddressInfo != NULL);\r
978\r
979 Status = EFI_SUCCESS;\r
980 IpSb = IpIf->Service;\r
981 DadXmits = &IpSb->Ip6ConfigInstance.DadXmits;\r
982\r
983 //\r
984 // Allocate the resources and insert info\r
985 //\r
986 Entry = AllocatePool (sizeof (IP6_DAD_ENTRY));\r
987 if (Entry == NULL) {\r
988 return EFI_OUT_OF_RESOURCES;\r
989 }\r
990\r
991 //\r
992 // Map the incoming unicast address to solicited-node multicast address\r
993 //\r
994 Ip6CreateSNMulticastAddr (&AddressInfo->Address, &Entry->Destination);\r
995\r
996 //\r
997 // Join in the solicited-node multicast address.\r
998 //\r
999 Status = Ip6JoinGroup (IpSb, IpIf, &Entry->Destination);\r
1000 if (EFI_ERROR (Status)) {\r
1001 FreePool (Entry);\r
1002 return Status;\r
1003 }\r
1004\r
1005 Entry->Signature = IP6_DAD_ENTRY_SIGNATURE;\r
1006 Entry->MaxTransmit = DadXmits->DupAddrDetectTransmits;\r
1007 Entry->Transmit = 0;\r
1008 Entry->Receive = 0;\r
1009 MaxDelayTick = IP6_MAX_RTR_SOLICITATION_DELAY / IP6_TIMER_INTERVAL_IN_MS;\r
1010 Entry->RetransTick = (MaxDelayTick * ((NET_RANDOM (NetRandomInitSeed ()) % 5) + 1)) / 5;\r
1011 Entry->AddressInfo = AddressInfo;\r
1012 Entry->Callback = Callback;\r
1013 Entry->Context = Context;\r
1014 InsertTailList (&IpIf->DupAddrDetectList, &Entry->Link);\r
1015\r
1016 if (Entry->MaxTransmit == 0) {\r
1017 //\r
1018 // DAD is disabled on this interface, immediately mark this DAD successful.\r
1019 //\r
1020 Ip6OnDADFinished (TRUE, IpIf, Entry);\r
1021 }\r
1022\r
1023 return EFI_SUCCESS;\r
1024}\r
1025\r
1026/**\r
1027 Search IP6_DAD_ENTRY from the Duplicate Address Detection List.\r
1028\r
1029 @param[in] IpSb The pointer to the IP6_SERVICE instance.\r
1030 @param[in] Target The address information which needs DAD performed .\r
1031 @param[out] Interface If not NULL, output the IP6 interface that configures\r
1032 the tentative address.\r
1033\r
1034 @return NULL if failed to find the matching DAD entry.\r
1035 Otherwise, point to the found DAD entry.\r
1036\r
1037**/\r
1038IP6_DAD_ENTRY *\r
1039Ip6FindDADEntry (\r
1040 IN IP6_SERVICE *IpSb,\r
1041 IN EFI_IPv6_ADDRESS *Target,\r
1042 OUT IP6_INTERFACE **Interface OPTIONAL\r
1043 )\r
1044{\r
1045 LIST_ENTRY *Entry;\r
1046 LIST_ENTRY *Entry2;\r
1047 IP6_INTERFACE *IpIf;\r
1048 IP6_DAD_ENTRY *DupAddrDetect;\r
1049 IP6_ADDRESS_INFO *AddrInfo;\r
1050\r
1051 NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) {\r
1052 IpIf = NET_LIST_USER_STRUCT (Entry, IP6_INTERFACE, Link);\r
1053\r
1054 NET_LIST_FOR_EACH (Entry2, &IpIf->DupAddrDetectList) {\r
1055 DupAddrDetect = NET_LIST_USER_STRUCT_S (Entry2, IP6_DAD_ENTRY, Link, IP6_DAD_ENTRY_SIGNATURE);\r
1056 AddrInfo = DupAddrDetect->AddressInfo;\r
1057 if (EFI_IP6_EQUAL (&AddrInfo->Address, Target)) {\r
1058 if (Interface != NULL) {\r
1059 *Interface = IpIf;\r
1060 }\r
1061 return DupAddrDetect;\r
1062 }\r
1063 }\r
1064 }\r
1065\r
1066 return NULL;\r
1067}\r
1068\r
1069/**\r
1070 Generate router solicit message and send it out to Destination Address or\r
1071 All Router Link Local scope multicast address.\r
1072\r
1073 @param[in] IpSb The IP service to send the packet.\r
1074 @param[in] Interface If not NULL, points to the IP6 interface to send\r
1075 the packet.\r
1076 @param[in] SourceAddress If not NULL, the source address of the message.\r
1077 @param[in] DestinationAddress If not NULL, the destination address of the message.\r
1078 @param[in] SourceLinkAddress If not NULL, the MAC address of the source.\r
1079 A source link-layer address option will be appended\r
1080 to the message.\r
1081\r
1082 @retval EFI_OUT_OF_RESOURCES Insufficient resources to complete the\r
1083 operation.\r
1084 @retval EFI_SUCCESS The router solicit message was successfully sent.\r
1085\r
1086**/\r
1087EFI_STATUS\r
1088Ip6SendRouterSolicit (\r
1089 IN IP6_SERVICE *IpSb,\r
1090 IN IP6_INTERFACE *Interface OPTIONAL,\r
1091 IN EFI_IPv6_ADDRESS *SourceAddress OPTIONAL,\r
1092 IN EFI_IPv6_ADDRESS *DestinationAddress OPTIONAL,\r
1093 IN EFI_MAC_ADDRESS *SourceLinkAddress OPTIONAL\r
1094 )\r
1095{\r
1096 NET_BUF *Packet;\r
1097 EFI_IP6_HEADER Head;\r
1098 IP6_ICMP_INFORMATION_HEAD *IcmpHead;\r
1099 IP6_ETHER_ADDR_OPTION *LinkLayerOption;\r
1100 UINT16 PayloadLen;\r
1101 IP6_INTERFACE *IpIf;\r
1102\r
1103 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
1104\r
1105 IpIf = Interface;\r
1106 if (IpIf == NULL && IpSb->DefaultInterface != NULL) {\r
1107 IpIf = IpSb->DefaultInterface;\r
1108 }\r
1109\r
1110 //\r
1111 // Generate the packet to be sent\r
1112 //\r
1113\r
1114 PayloadLen = (UINT16) sizeof (IP6_ICMP_INFORMATION_HEAD);\r
1115 if (SourceLinkAddress != NULL) {\r
1116 PayloadLen += sizeof (IP6_ETHER_ADDR_OPTION);\r
1117 }\r
1118\r
1119 Packet = NetbufAlloc (sizeof (EFI_IP6_HEADER) + (UINT32) PayloadLen);\r
1120 if (Packet == NULL) {\r
1121 return EFI_OUT_OF_RESOURCES;\r
1122 }\r
1123\r
1124 //\r
1125 // Create the basic IPv6 header.\r
1126 //\r
1127 Head.FlowLabelL = 0;\r
1128 Head.FlowLabelH = 0;\r
1129 Head.PayloadLength = HTONS (PayloadLen);\r
1130 Head.NextHeader = IP6_ICMP;\r
1131 Head.HopLimit = IP6_HOP_LIMIT;\r
1132\r
1133 if (SourceAddress != NULL) {\r
1134 IP6_COPY_ADDRESS (&Head.SourceAddress, SourceAddress);\r
1135 } else {\r
1136 ZeroMem (&Head.SourceAddress, sizeof (EFI_IPv6_ADDRESS));\r
1137 }\r
1138\r
1139\r
1140 if (DestinationAddress != NULL) {\r
1141 IP6_COPY_ADDRESS (&Head.DestinationAddress, DestinationAddress);\r
1142 } else {\r
1143 Ip6SetToAllNodeMulticast (TRUE, IP6_LINK_LOCAL_SCOPE, &Head.DestinationAddress);\r
1144 }\r
1145\r
1146 NetbufReserve (Packet, sizeof (EFI_IP6_HEADER));\r
1147\r
1148 //\r
1149 // Fill in the ICMP header, and Source link-layer address if contained.\r
1150 //\r
1151\r
1152 IcmpHead = (IP6_ICMP_INFORMATION_HEAD *) NetbufAllocSpace (Packet, sizeof (IP6_ICMP_INFORMATION_HEAD), FALSE);\r
1153 ASSERT (IcmpHead != NULL);\r
1154 ZeroMem (IcmpHead, sizeof (IP6_ICMP_INFORMATION_HEAD));\r
1155 IcmpHead->Head.Type = ICMP_V6_ROUTER_SOLICIT;\r
1156 IcmpHead->Head.Code = 0;\r
1157\r
1158 LinkLayerOption = NULL;\r
1159 if (SourceLinkAddress != NULL) {\r
1160 LinkLayerOption = (IP6_ETHER_ADDR_OPTION *) NetbufAllocSpace (\r
1161 Packet,\r
1162 sizeof (IP6_ETHER_ADDR_OPTION),\r
1163 FALSE\r
1164 );\r
1165 ASSERT (LinkLayerOption != NULL);\r
1166 LinkLayerOption->Type = Ip6OptionEtherSource;\r
1167 LinkLayerOption->Length = (UINT8) sizeof (IP6_ETHER_ADDR_OPTION);\r
1168 CopyMem (LinkLayerOption->EtherAddr, SourceLinkAddress, 6);\r
1169 }\r
1170\r
1171 //\r
1172 // Transmit the packet\r
1173 //\r
1174 return Ip6Output (IpSb, IpIf, NULL, Packet, &Head, NULL, 0, Ip6SysPacketSent, NULL);\r
1175}\r
1176\r
1177/**\r
1178 Generate a Neighbor Advertisement message and send it out to Destination Address.\r
1179\r
1180 @param[in] IpSb The IP service to send the packet.\r
1181 @param[in] SourceAddress The source address of the message.\r
1182 @param[in] DestinationAddress The destination address of the message.\r
1183 @param[in] TargetIp6Address The target address field in the Neighbor Solicitation\r
1184 message that prompted this advertisement.\r
1185 @param[in] TargetLinkAddress The MAC address for the target, i.e. the sender\r
1186 of the advertisement.\r
1187 @param[in] IsRouter If TRUE, indicates the sender is a router.\r
1188 @param[in] Override If TRUE, indicates the advertisement should override\r
1189 an existing cache entry and update the MAC address.\r
1190 @param[in] Solicited If TRUE, indicates the advertisement was sent\r
1191 in response to a Neighbor Solicitation from\r
1192 the Destination address.\r
1193\r
1194 @retval EFI_OUT_OF_RESOURCES Insufficient resources to complete the\r
1195 operation.\r
1196 @retval EFI_SUCCESS The Neighbor Advertise message was successfully sent.\r
1197\r
1198**/\r
1199EFI_STATUS\r
1200Ip6SendNeighborAdvertise (\r
1201 IN IP6_SERVICE *IpSb,\r
1202 IN EFI_IPv6_ADDRESS *SourceAddress,\r
1203 IN EFI_IPv6_ADDRESS *DestinationAddress,\r
1204 IN EFI_IPv6_ADDRESS *TargetIp6Address,\r
1205 IN EFI_MAC_ADDRESS *TargetLinkAddress,\r
1206 IN BOOLEAN IsRouter,\r
1207 IN BOOLEAN Override,\r
1208 IN BOOLEAN Solicited\r
1209 )\r
1210{\r
1211 NET_BUF *Packet;\r
1212 EFI_IP6_HEADER Head;\r
1213 IP6_ICMP_INFORMATION_HEAD *IcmpHead;\r
1214 IP6_ETHER_ADDR_OPTION *LinkLayerOption;\r
1215 EFI_IPv6_ADDRESS *Target;\r
1216 UINT16 PayloadLen;\r
1217\r
1218 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
1219\r
1220 //\r
1221 // The Neighbor Advertisement message must include a Target link-layer address option\r
1222 // when responding to multicast solicitation and should include such option when\r
1223 // responding to unicast solicitation. It also must include such option as unsolicited\r
1224 // advertisement.\r
1225 //\r
1226 ASSERT (DestinationAddress != NULL && TargetIp6Address != NULL && TargetLinkAddress != NULL);\r
1227\r
1228 PayloadLen = (UINT16) (sizeof (IP6_ICMP_INFORMATION_HEAD) + sizeof (EFI_IPv6_ADDRESS) + sizeof (IP6_ETHER_ADDR_OPTION));\r
1229\r
1230 //\r
1231 // Generate the packet to be sent\r
1232 //\r
1233\r
1234 Packet = NetbufAlloc (sizeof (EFI_IP6_HEADER) + (UINT32) PayloadLen);\r
1235 if (Packet == NULL) {\r
1236 return EFI_OUT_OF_RESOURCES;\r
1237 }\r
1238\r
1239 //\r
1240 // Create the basic IPv6 header.\r
1241 //\r
1242 Head.FlowLabelL = 0;\r
1243 Head.FlowLabelH = 0;\r
1244 Head.PayloadLength = HTONS (PayloadLen);\r
1245 Head.NextHeader = IP6_ICMP;\r
1246 Head.HopLimit = IP6_HOP_LIMIT;\r
1247\r
1248 IP6_COPY_ADDRESS (&Head.SourceAddress, SourceAddress);\r
1249 IP6_COPY_ADDRESS (&Head.DestinationAddress, DestinationAddress);\r
1250\r
1251 NetbufReserve (Packet, sizeof (EFI_IP6_HEADER));\r
1252\r
1253 //\r
1254 // Fill in the ICMP header, Target address, and Target link-layer address.\r
1255 // Set the Router flag, Solicited flag and Override flag.\r
1256 //\r
1257\r
1258 IcmpHead = (IP6_ICMP_INFORMATION_HEAD *) NetbufAllocSpace (Packet, sizeof (IP6_ICMP_INFORMATION_HEAD), FALSE);\r
1259 ASSERT (IcmpHead != NULL);\r
1260 ZeroMem (IcmpHead, sizeof (IP6_ICMP_INFORMATION_HEAD));\r
1261 IcmpHead->Head.Type = ICMP_V6_NEIGHBOR_ADVERTISE;\r
1262 IcmpHead->Head.Code = 0;\r
1263\r
1264 if (IsRouter) {\r
1265 IcmpHead->Fourth |= IP6_IS_ROUTER_FLAG;\r
1266 }\r
1267\r
1268 if (Solicited) {\r
1269 IcmpHead->Fourth |= IP6_SOLICITED_FLAG;\r
1270 }\r
1271\r
1272 if (Override) {\r
1273 IcmpHead->Fourth |= IP6_OVERRIDE_FLAG;\r
1274 }\r
1275\r
1276 Target = (EFI_IPv6_ADDRESS *) NetbufAllocSpace (Packet, sizeof (EFI_IPv6_ADDRESS), FALSE);\r
1277 ASSERT (Target != NULL);\r
1278 IP6_COPY_ADDRESS (Target, TargetIp6Address);\r
1279\r
1280 LinkLayerOption = (IP6_ETHER_ADDR_OPTION *) NetbufAllocSpace (\r
1281 Packet,\r
1282 sizeof (IP6_ETHER_ADDR_OPTION),\r
1283 FALSE\r
1284 );\r
1285 ASSERT (LinkLayerOption != NULL);\r
1286 LinkLayerOption->Type = Ip6OptionEtherTarget;\r
1287 LinkLayerOption->Length = 1;\r
1288 CopyMem (LinkLayerOption->EtherAddr, TargetLinkAddress, 6);\r
1289\r
1290 //\r
1291 // Transmit the packet\r
1292 //\r
1293 return Ip6Output (IpSb, NULL, NULL, Packet, &Head, NULL, 0, Ip6SysPacketSent, NULL);\r
1294}\r
1295\r
1296/**\r
1297 Generate the Neighbor Solicitation message and send it to the Destination Address.\r
1298\r
1299 @param[in] IpSb The IP service to send the packet\r
1300 @param[in] SourceAddress The source address of the message.\r
1301 @param[in] DestinationAddress The destination address of the message.\r
1302 @param[in] TargetIp6Address The IP address of the target of the solicitation.\r
1303 It must not be a multicast address.\r
1304 @param[in] SourceLinkAddress The MAC address for the sender. If not NULL,\r
1305 a source link-layer address option will be appended\r
1306 to the message.\r
1307\r
1308 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
1309 @retval EFI_OUT_OF_RESOURCES Insufficient resources to complete the\r
1310 operation.\r
1311 @retval EFI_SUCCESS The Neighbor Advertise message was successfully sent.\r
1312\r
1313**/\r
1314EFI_STATUS\r
1315Ip6SendNeighborSolicit (\r
1316 IN IP6_SERVICE *IpSb,\r
1317 IN EFI_IPv6_ADDRESS *SourceAddress,\r
1318 IN EFI_IPv6_ADDRESS *DestinationAddress,\r
1319 IN EFI_IPv6_ADDRESS *TargetIp6Address,\r
1320 IN EFI_MAC_ADDRESS *SourceLinkAddress OPTIONAL\r
1321 )\r
1322{\r
1323 NET_BUF *Packet;\r
1324 EFI_IP6_HEADER Head;\r
1325 IP6_ICMP_INFORMATION_HEAD *IcmpHead;\r
1326 IP6_ETHER_ADDR_OPTION *LinkLayerOption;\r
1327 EFI_IPv6_ADDRESS *Target;\r
1328 BOOLEAN IsDAD;\r
1329 UINT16 PayloadLen;\r
1330 IP6_NEIGHBOR_ENTRY *Neighbor;\r
1331\r
1332 //\r
1333 // Check input parameters\r
1334 //\r
1335 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
1336 if (DestinationAddress == NULL || TargetIp6Address == NULL) {\r
1337 return EFI_INVALID_PARAMETER;\r
1338 }\r
1339\r
1340 IsDAD = FALSE;\r
1341\r
1342 if (SourceAddress == NULL || (SourceAddress != NULL && NetIp6IsUnspecifiedAddr (SourceAddress))) {\r
1343 IsDAD = TRUE;\r
1344 }\r
1345\r
1346 //\r
1347 // The Neighbor Solicitation message should include a source link-layer address option\r
1348 // if the solicitation is not sent by performing DAD - Duplicate Address Detection.\r
1349 // Otherwise must not include it.\r
1350 //\r
1351 PayloadLen = (UINT16) (sizeof (IP6_ICMP_INFORMATION_HEAD) + sizeof (EFI_IPv6_ADDRESS));\r
1352\r
1353 if (!IsDAD) {\r
1354 if (SourceLinkAddress == NULL) {\r
1355 return EFI_INVALID_PARAMETER;\r
1356 }\r
1357\r
1358 PayloadLen = (UINT16) (PayloadLen + sizeof (IP6_ETHER_ADDR_OPTION));\r
1359 }\r
1360\r
1361 //\r
1362 // Generate the packet to be sent\r
1363 //\r
1364\r
1365 Packet = NetbufAlloc (sizeof (EFI_IP6_HEADER) + (UINT32) PayloadLen);\r
1366 if (Packet == NULL) {\r
1367 return EFI_OUT_OF_RESOURCES;\r
1368 }\r
1369\r
1370 //\r
1371 // Create the basic IPv6 header\r
1372 //\r
1373 Head.FlowLabelL = 0;\r
1374 Head.FlowLabelH = 0;\r
1375 Head.PayloadLength = HTONS (PayloadLen);\r
1376 Head.NextHeader = IP6_ICMP;\r
1377 Head.HopLimit = IP6_HOP_LIMIT;\r
1378\r
1379 if (SourceAddress != NULL) {\r
1380 IP6_COPY_ADDRESS (&Head.SourceAddress, SourceAddress);\r
1381 } else {\r
1382 ZeroMem (&Head.SourceAddress, sizeof (EFI_IPv6_ADDRESS));\r
1383 }\r
1384\r
1385 IP6_COPY_ADDRESS (&Head.DestinationAddress, DestinationAddress);\r
1386\r
1387 NetbufReserve (Packet, sizeof (EFI_IP6_HEADER));\r
1388\r
1389 //\r
1390 // Fill in the ICMP header, Target address, and Source link-layer address.\r
1391 //\r
1392 IcmpHead = (IP6_ICMP_INFORMATION_HEAD *) NetbufAllocSpace (Packet, sizeof (IP6_ICMP_INFORMATION_HEAD), FALSE);\r
1393 ASSERT (IcmpHead != NULL);\r
1394 ZeroMem (IcmpHead, sizeof (IP6_ICMP_INFORMATION_HEAD));\r
1395 IcmpHead->Head.Type = ICMP_V6_NEIGHBOR_SOLICIT;\r
1396 IcmpHead->Head.Code = 0;\r
1397\r
1398 Target = (EFI_IPv6_ADDRESS *) NetbufAllocSpace (Packet, sizeof (EFI_IPv6_ADDRESS), FALSE);\r
1399 ASSERT (Target != NULL);\r
1400 IP6_COPY_ADDRESS (Target, TargetIp6Address);\r
1401\r
1402 LinkLayerOption = NULL;\r
1403 if (!IsDAD) {\r
1404\r
1405 //\r
1406 // Fill in the source link-layer address option\r
1407 //\r
1408 LinkLayerOption = (IP6_ETHER_ADDR_OPTION *) NetbufAllocSpace (\r
1409 Packet,\r
1410 sizeof (IP6_ETHER_ADDR_OPTION),\r
1411 FALSE\r
1412 );\r
1413 ASSERT (LinkLayerOption != NULL);\r
1414 LinkLayerOption->Type = Ip6OptionEtherSource;\r
1415 LinkLayerOption->Length = 1;\r
1416 CopyMem (LinkLayerOption->EtherAddr, SourceLinkAddress, 6);\r
1417 }\r
1418\r
1419 //\r
1420 // Create a Neighbor Cache entry in the INCOMPLETE state when performing\r
1421 // address resolution.\r
1422 //\r
1423 if (!IsDAD && Ip6IsSNMulticastAddr (DestinationAddress)) {\r
1424 Neighbor = Ip6FindNeighborEntry (IpSb, TargetIp6Address);\r
1425 if (Neighbor == NULL) {\r
1426 Neighbor = Ip6CreateNeighborEntry (IpSb, Ip6OnArpResolved, TargetIp6Address, NULL);\r
1427 ASSERT (Neighbor != NULL);\r
1428 }\r
1429 }\r
1430\r
1431 //\r
1432 // Transmit the packet\r
1433 //\r
1434 return Ip6Output (IpSb, IpSb->DefaultInterface, NULL, Packet, &Head, NULL, 0, Ip6SysPacketSent, NULL);\r
1435}\r
1436\r
1437/**\r
1438 Process the Neighbor Solicitation message. The message may be sent for Duplicate\r
1439 Address Detection or Address Resolution.\r
1440\r
1441 @param[in] IpSb The IP service that received the packet.\r
1442 @param[in] Head The IP head of the message.\r
1443 @param[in] Packet The content of the message with IP head removed.\r
1444\r
1445 @retval EFI_SUCCESS The packet processed successfully.\r
1446 @retval EFI_INVALID_PARAMETER The packet is invalid.\r
1447 @retval EFI_ICMP_ERROR The packet indicates that DAD is failed.\r
1448 @retval Others Failed to process the packet.\r
1449\r
1450**/\r
1451EFI_STATUS\r
1452Ip6ProcessNeighborSolicit (\r
1453 IN IP6_SERVICE *IpSb,\r
1454 IN EFI_IP6_HEADER *Head,\r
1455 IN NET_BUF *Packet\r
1456 )\r
1457{\r
1458 IP6_ICMP_INFORMATION_HEAD Icmp;\r
1459 EFI_IPv6_ADDRESS Target;\r
1460 IP6_ETHER_ADDR_OPTION LinkLayerOption;\r
1461 BOOLEAN IsDAD;\r
1462 BOOLEAN IsUnicast;\r
1463 BOOLEAN IsMaintained;\r
1464 IP6_DAD_ENTRY *DupAddrDetect;\r
1465 IP6_INTERFACE *IpIf;\r
1466 IP6_NEIGHBOR_ENTRY *Neighbor;\r
1467 BOOLEAN Solicited;\r
1468 BOOLEAN UpdateCache;\r
1469 EFI_IPv6_ADDRESS Dest;\r
1470 UINT16 OptionLen;\r
1471 UINT8 *Option;\r
1472 BOOLEAN Provided;\r
1473 EFI_STATUS Status;\r
1474 VOID *MacAddress;\r
1475\r
1476 NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp);\r
1477 NetbufCopy (Packet, sizeof (Icmp), sizeof (Target), Target.Addr);\r
1478\r
1479 //\r
1480 // Perform Message Validation:\r
1481 // The IP Hop Limit field has a value of 255, i.e., the packet\r
1482 // could not possibly have been forwarded by a router.\r
1483 // ICMP Code is 0.\r
1484 // Target Address is not a multicast address.\r
1485 //\r
1486 Status = EFI_INVALID_PARAMETER;\r
1487\r
1488 if (Head->HopLimit != IP6_HOP_LIMIT || Icmp.Head.Code != 0 || !NetIp6IsValidUnicast (&Target)) {\r
1489 goto Exit;\r
1490 }\r
1491\r
1492 //\r
1493 // ICMP length is 24 or more octets.\r
1494 //\r
1495 OptionLen = 0;\r
1496 if (Head->PayloadLength < IP6_ND_LENGTH) {\r
1497 goto Exit;\r
1498 } else {\r
1499 OptionLen = (UINT16) (Head->PayloadLength - IP6_ND_LENGTH);\r
1500 Option = NetbufGetByte (Packet, IP6_ND_LENGTH, NULL);\r
1501\r
1502 //\r
1503 // All included options should have a length that is greater than zero.\r
1504 //\r
1505 if (!Ip6IsNDOptionValid (Option, OptionLen)) {\r
1506 goto Exit;\r
1507 }\r
1508 }\r
1509\r
1510 IsDAD = NetIp6IsUnspecifiedAddr (&Head->SourceAddress);\r
1511 IsUnicast = (BOOLEAN) !Ip6IsSNMulticastAddr (&Head->DestinationAddress);\r
1512 IsMaintained = Ip6IsOneOfSetAddress (IpSb, &Target, &IpIf, NULL);\r
1513\r
1514 Provided = FALSE;\r
1515 if (OptionLen >= sizeof (IP6_ETHER_ADDR_OPTION)) {\r
1516 NetbufCopy (\r
1517 Packet,\r
1518 IP6_ND_LENGTH,\r
1519 sizeof (IP6_ETHER_ADDR_OPTION),\r
1520 (UINT8 *) &LinkLayerOption\r
1521 );\r
1522 //\r
1523 // The solicitation for neighbor discovery should include a source link-layer\r
1524 // address option. If the option is not recognized, silently ignore it.\r
1525 //\r
1526 if (LinkLayerOption.Type == Ip6OptionEtherSource) {\r
1527 if (IsDAD) {\r
1528 //\r
1529 // If the IP source address is the unspecified address, the source\r
1530 // link-layer address option must not be included in the message.\r
1531 //\r
1532 goto Exit;\r
1533 }\r
1534\r
1535 Provided = TRUE;\r
1536 }\r
1537 }\r
1538\r
1539 //\r
1540 // If the IP source address is the unspecified address, the IP\r
1541 // destination address is a solicited-node multicast address.\r
1542 //\r
1543 if (IsDAD && IsUnicast) {\r
1544 goto Exit;\r
1545 }\r
1546\r
1547 //\r
1548 // If the target address is tentative, and the source address is a unicast address,\r
1549 // the solicitation's sender is performing address resolution on the target;\r
1550 // the solicitation should be silently ignored.\r
1551 //\r
1552 if (!IsDAD && !IsMaintained) {\r
1553 goto Exit;\r
1554 }\r
1555\r
1556 //\r
1557 // If received unicast neighbor solicitation but destination is not this node,\r
1558 // drop the packet.\r
1559 //\r
1560 if (IsUnicast && !IsMaintained) {\r
1561 goto Exit;\r
1562 }\r
1563\r
1564 //\r
1565 // In DAD, when target address is a tentative address,\r
1566 // process the received neighbor solicitation message but not send out response.\r
1567 //\r
1568 if (IsDAD && !IsMaintained) {\r
1569 DupAddrDetect = Ip6FindDADEntry (IpSb, &Target, &IpIf);\r
1570 if (DupAddrDetect != NULL) {\r
1571 if (DupAddrDetect->Transmit == 0) {\r
1572 //\r
1573 // The NS is from another node to performing DAD on the same address since\r
1574 // we haven't send out any NS yet. Fail DAD for the tentative address.\r
1575 //\r
1576 Ip6OnDADFinished (FALSE, IpIf, DupAddrDetect);\r
1577 Status = EFI_ICMP_ERROR;\r
1578 goto Exit;\r
1579 }\r
1580\r
1581 //\r
1582 // Check the MAC address of the incoming packet.\r
1583 //\r
1584 if (IpSb->RecvRequest.MnpToken.Packet.RxData == NULL) {\r
1585 goto Exit;\r
1586 }\r
1587\r
1588 MacAddress = IpSb->RecvRequest.MnpToken.Packet.RxData->SourceAddress;\r
1589 if (MacAddress != NULL) {\r
1590 if (CompareMem (\r
1591 MacAddress,\r
1592 &IpSb->SnpMode.CurrentAddress,\r
1593 IpSb->SnpMode.HwAddressSize\r
1594 ) != 0) {\r
1595 //\r
1596 // The NS is from another node to performing DAD on the same address.\r
1597 // Fail DAD for the tentative address.\r
1598 //\r
1599 Ip6OnDADFinished (FALSE, IpIf, DupAddrDetect);\r
1600 Status = EFI_ICMP_ERROR;\r
1601 } else {\r
1602 //\r
1603 // The below layer loopback the NS we sent. Record it and wait for more.\r
1604 //\r
1605 DupAddrDetect->Receive++;\r
1606 Status = EFI_SUCCESS;\r
1607 }\r
1608 }\r
1609 }\r
1610 goto Exit;\r
1611 }\r
1612\r
1613 //\r
1614 // If the solicitation does not contain a link-layer address, DO NOT create or\r
1615 // update the neighbor cache entries.\r
1616 //\r
1617 if (Provided) {\r
1618 Neighbor = Ip6FindNeighborEntry (IpSb, &Head->SourceAddress);\r
1619 UpdateCache = FALSE;\r
1620\r
1621 if (Neighbor == NULL) {\r
1622 Neighbor = Ip6CreateNeighborEntry (IpSb, Ip6OnArpResolved, &Head->SourceAddress, NULL);\r
1623 if (Neighbor == NULL) {\r
1624 Status = EFI_OUT_OF_RESOURCES;\r
1625 goto Exit;\r
1626 }\r
1627 UpdateCache = TRUE;\r
1628 } else {\r
1629 if (CompareMem (Neighbor->LinkAddress.Addr, LinkLayerOption.EtherAddr, 6) != 0) {\r
1630 UpdateCache = TRUE;\r
1631 }\r
1632 }\r
1633\r
1634 if (UpdateCache) {\r
1635 Neighbor->State = EfiNeighborStale;\r
1636 Neighbor->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
1637 CopyMem (Neighbor->LinkAddress.Addr, LinkLayerOption.EtherAddr, 6);\r
1638 //\r
1639 // Send queued packets if exist.\r
1640 //\r
1641 Neighbor->CallBack ((VOID *) Neighbor);\r
1642 }\r
1643 }\r
1644\r
1645 //\r
1646 // Sends a Neighbor Advertisement as response.\r
1647 // Set the Router flag to zero since the node is a host.\r
1648 // If the source address of the solicitation is unspeicifed, and target address\r
1649 // is one of the maintained address, reply a unsolicited multicast advertisement.\r
1650 //\r
1651 if (IsDAD && IsMaintained) {\r
1652 Solicited = FALSE;\r
1653 Ip6SetToAllNodeMulticast (FALSE, IP6_LINK_LOCAL_SCOPE, &Dest);\r
1654 } else {\r
1655 Solicited = TRUE;\r
1656 IP6_COPY_ADDRESS (&Dest, &Head->SourceAddress);\r
1657 }\r
1658\r
1659 Status = Ip6SendNeighborAdvertise (\r
1660 IpSb,\r
1661 &Target,\r
1662 &Dest,\r
1663 &Target,\r
1664 &IpSb->SnpMode.CurrentAddress,\r
1665 FALSE,\r
1666 TRUE,\r
1667 Solicited\r
1668 );\r
1669Exit:\r
1670 NetbufFree (Packet);\r
1671 return Status;\r
1672}\r
1673\r
1674/**\r
1675 Process the Neighbor Advertisement message.\r
1676\r
1677 @param[in] IpSb The IP service that received the packet.\r
1678 @param[in] Head The IP head of the message.\r
1679 @param[in] Packet The content of the message with IP head removed.\r
1680\r
1681 @retval EFI_SUCCESS The packet processed successfully.\r
1682 @retval EFI_INVALID_PARAMETER The packet is invalid.\r
1683 @retval EFI_ICMP_ERROR The packet indicates that DAD is failed.\r
1684 @retval Others Failed to process the packet.\r
1685\r
1686**/\r
1687EFI_STATUS\r
1688Ip6ProcessNeighborAdvertise (\r
1689 IN IP6_SERVICE *IpSb,\r
1690 IN EFI_IP6_HEADER *Head,\r
1691 IN NET_BUF *Packet\r
1692 )\r
1693{\r
1694 IP6_ICMP_INFORMATION_HEAD Icmp;\r
1695 EFI_IPv6_ADDRESS Target;\r
1696 IP6_ETHER_ADDR_OPTION LinkLayerOption;\r
1697 BOOLEAN Provided;\r
1698 INTN Compare;\r
1699 IP6_NEIGHBOR_ENTRY *Neighbor;\r
1700 IP6_DEFAULT_ROUTER *DefaultRouter;\r
1701 BOOLEAN Solicited;\r
1702 BOOLEAN IsRouter;\r
1703 BOOLEAN Override;\r
1704 IP6_DAD_ENTRY *DupAddrDetect;\r
1705 IP6_INTERFACE *IpIf;\r
1706 UINT16 OptionLen;\r
1707 UINT8 *Option;\r
1708 EFI_STATUS Status;\r
1709\r
1710 NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp);\r
1711 NetbufCopy (Packet, sizeof (Icmp), sizeof (Target), Target.Addr);\r
1712\r
1713 //\r
1714 // Validate the incoming Neighbor Advertisement\r
1715 //\r
1716 Status = EFI_INVALID_PARAMETER;\r
1717 //\r
1718 // The IP Hop Limit field has a value of 255, i.e., the packet\r
1719 // could not possibly have been forwarded by a router.\r
1720 // ICMP Code is 0.\r
1721 // Target Address is not a multicast address.\r
1722 //\r
1723 if (Head->HopLimit != IP6_HOP_LIMIT || Icmp.Head.Code != 0 || !NetIp6IsValidUnicast (&Target)) {\r
1724 goto Exit;\r
1725 }\r
1726\r
1727 //\r
1728 // ICMP length is 24 or more octets.\r
1729 //\r
1730 Provided = FALSE;\r
1731 OptionLen = 0;\r
1732 if (Head->PayloadLength < IP6_ND_LENGTH) {\r
1733 goto Exit;\r
1734 } else {\r
1735 OptionLen = (UINT16) (Head->PayloadLength - IP6_ND_LENGTH);\r
1736 Option = NetbufGetByte (Packet, IP6_ND_LENGTH, NULL);\r
1737\r
1738 //\r
1739 // All included options should have a length that is greater than zero.\r
1740 //\r
1741 if (!Ip6IsNDOptionValid (Option, OptionLen)) {\r
1742 goto Exit;\r
1743 }\r
1744 }\r
1745\r
1746 //\r
1747 // If the IP destination address is a multicast address, Solicited Flag is ZERO.\r
1748 //\r
1749 Solicited = FALSE;\r
1750 if ((Icmp.Fourth & IP6_SOLICITED_FLAG) == IP6_SOLICITED_FLAG) {\r
1751 Solicited = TRUE;\r
1752 }\r
1753 if (IP6_IS_MULTICAST (&Head->DestinationAddress) && Solicited) {\r
1754 goto Exit;\r
1755 }\r
1756\r
1757 //\r
1758 // DAD - Check whether the Target is one of our tentative address.\r
1759 //\r
1760 DupAddrDetect = Ip6FindDADEntry (IpSb, &Target, &IpIf);\r
1761 if (DupAddrDetect != NULL) {\r
1762 //\r
1763 // DAD fails, some other node is using this address.\r
1764 //\r
1765 NetbufFree (Packet);\r
1766 Ip6OnDADFinished (FALSE, IpIf, DupAddrDetect);\r
1767 return EFI_ICMP_ERROR;\r
1768 }\r
1769\r
1770 //\r
1771 // Search the Neighbor Cache for the target's entry. If no entry exists,\r
1772 // the advertisement should be silently discarded.\r
1773 //\r
1774 Neighbor = Ip6FindNeighborEntry (IpSb, &Target);\r
1775 if (Neighbor == NULL) {\r
1776 goto Exit;\r
1777 }\r
1778\r
1779 //\r
1780 // Get IsRouter Flag and Override Flag\r
1781 //\r
1782 IsRouter = FALSE;\r
1783 Override = FALSE;\r
1784 if ((Icmp.Fourth & IP6_IS_ROUTER_FLAG) == IP6_IS_ROUTER_FLAG) {\r
1785 IsRouter = TRUE;\r
1786 }\r
1787 if ((Icmp.Fourth & IP6_OVERRIDE_FLAG) == IP6_OVERRIDE_FLAG) {\r
1788 Override = TRUE;\r
1789 }\r
1790\r
1791 //\r
1792 // Check whether link layer option is included.\r
1793 //\r
1794 if (OptionLen >= sizeof (IP6_ETHER_ADDR_OPTION)) {\r
1795 NetbufCopy (\r
1796 Packet,\r
1797 IP6_ND_LENGTH,\r
1798 sizeof (IP6_ETHER_ADDR_OPTION),\r
1799 (UINT8 *) &LinkLayerOption\r
1800 );\r
1801\r
1802 if (LinkLayerOption.Type == Ip6OptionEtherTarget) {\r
1803 Provided = TRUE;\r
1804 }\r
1805 }\r
1806\r
1807 Compare = 0;\r
1808 if (Provided) {\r
1809 Compare = CompareMem (Neighbor->LinkAddress.Addr, LinkLayerOption.EtherAddr, 6);\r
1810 }\r
1811\r
1812 if (!Neighbor->IsRouter && IsRouter) {\r
1813 DefaultRouter = Ip6FindDefaultRouter (IpSb, &Target);\r
1814 if (DefaultRouter != NULL) {\r
1815 DefaultRouter->NeighborCache = Neighbor;\r
1816 }\r
1817 }\r
1818\r
1819 if (Neighbor->State == EfiNeighborInComplete) {\r
1820 //\r
1821 // If the target's Neighbor Cache entry is in INCOMPLETE state and no\r
1822 // Target Link-Layer address option is included while link layer has\r
1823 // address, the message should be silently discarded.\r
1824 //\r
1825 if (!Provided) {\r
1826 goto Exit;\r
1827 }\r
1828 //\r
1829 // Update the Neighbor Cache\r
1830 //\r
1831 CopyMem (Neighbor->LinkAddress.Addr, LinkLayerOption.EtherAddr, 6);\r
1832 if (Solicited) {\r
1833 Neighbor->State = EfiNeighborReachable;\r
1834 Neighbor->Ticks = IP6_GET_TICKS (IpSb->ReachableTime);\r
1835 } else {\r
1836 Neighbor->State = EfiNeighborStale;\r
1837 Neighbor->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
1838 //\r
1839 // Send any packets queued for the neighbor awaiting address resolution.\r
1840 //\r
1841 Neighbor->CallBack ((VOID *) Neighbor);\r
1842 }\r
1843\r
1844 Neighbor->IsRouter = IsRouter;\r
1845\r
1846 } else {\r
1847 if (!Override && Compare != 0) {\r
1848 //\r
1849 // When the Override Flag is clear and supplied link-layer address differs from\r
1850 // that in the cache, if the state of the entry is not REACHABLE, ignore the\r
1851 // message. Otherwise set it to STALE but do not update the entry in any\r
1852 // other way.\r
1853 //\r
1854 if (Neighbor->State == EfiNeighborReachable) {\r
1855 Neighbor->State = EfiNeighborStale;\r
1856 Neighbor->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
1857 }\r
1858 } else {\r
1859 if (Compare != 0) {\r
1860 CopyMem (Neighbor->LinkAddress.Addr, LinkLayerOption.EtherAddr, 6);\r
1861 }\r
1862 //\r
1863 // Update the entry's state\r
1864 //\r
1865 if (Solicited) {\r
1866 Neighbor->State = EfiNeighborReachable;\r
1867 Neighbor->Ticks = IP6_GET_TICKS (IpSb->ReachableTime);\r
1868 } else {\r
1869 if (Compare != 0) {\r
1870 Neighbor->State = EfiNeighborStale;\r
1871 Neighbor->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
1872 }\r
1873 }\r
1874\r
1875 //\r
1876 // When IsRouter is changed from TRUE to FALSE, remove the router from the\r
1877 // Default Router List and remove the Destination Cache entries for all destinations\r
1878 // using the neighbor as a router.\r
1879 //\r
1880 if (Neighbor->IsRouter && !IsRouter) {\r
1881 DefaultRouter = Ip6FindDefaultRouter (IpSb, &Target);\r
1882 if (DefaultRouter != NULL) {\r
1883 Ip6DestroyDefaultRouter (IpSb, DefaultRouter);\r
1884 }\r
1885 }\r
1886\r
1887 Neighbor->IsRouter = IsRouter;\r
1888 }\r
1889 }\r
1890\r
1891 if (Neighbor->State == EfiNeighborReachable) {\r
1892 Neighbor->CallBack ((VOID *) Neighbor);\r
1893 }\r
1894\r
1895 Status = EFI_SUCCESS;\r
1896\r
1897Exit:\r
1898 NetbufFree (Packet);\r
1899 return Status;\r
1900}\r
1901\r
1902/**\r
1903 Process the Router Advertisement message according to RFC4861.\r
1904\r
1905 @param[in] IpSb The IP service that received the packet.\r
1906 @param[in] Head The IP head of the message.\r
1907 @param[in] Packet The content of the message with the IP head removed.\r
1908\r
1909 @retval EFI_SUCCESS The packet processed successfully.\r
1910 @retval EFI_INVALID_PARAMETER The packet is invalid.\r
1911 @retval EFI_OUT_OF_RESOURCES Insufficient resources to complete the\r
1912 operation.\r
1913 @retval Others Failed to process the packet.\r
1914\r
1915**/\r
1916EFI_STATUS\r
1917Ip6ProcessRouterAdvertise (\r
1918 IN IP6_SERVICE *IpSb,\r
1919 IN EFI_IP6_HEADER *Head,\r
1920 IN NET_BUF *Packet\r
1921 )\r
1922{\r
1923 IP6_ICMP_INFORMATION_HEAD Icmp;\r
1924 UINT32 ReachableTime;\r
1925 UINT32 RetransTimer;\r
1926 UINT16 RouterLifetime;\r
1927 UINT16 Offset;\r
1928 UINT8 Type;\r
1929 UINT8 Length;\r
1930 IP6_ETHER_ADDR_OPTION LinkLayerOption;\r
1931 UINT32 Fourth;\r
1932 UINT8 CurHopLimit;\r
1933 BOOLEAN Mflag;\r
1934 BOOLEAN Oflag;\r
1935 IP6_DEFAULT_ROUTER *DefaultRouter;\r
1936 IP6_NEIGHBOR_ENTRY *NeighborCache;\r
1937 EFI_MAC_ADDRESS LinkLayerAddress;\r
1938 IP6_MTU_OPTION MTUOption;\r
1939 IP6_PREFIX_INFO_OPTION PrefixOption;\r
1940 IP6_PREFIX_LIST_ENTRY *PrefixList;\r
1941 BOOLEAN OnLink;\r
1942 BOOLEAN Autonomous;\r
1943 EFI_IPv6_ADDRESS StatelessAddress;\r
1944 EFI_STATUS Status;\r
1945 UINT16 OptionLen;\r
1946 UINT8 *Option;\r
1947 INTN Result;\r
1948\r
1949 Status = EFI_INVALID_PARAMETER;\r
1950\r
1951 if (IpSb->Ip6ConfigInstance.Policy != Ip6ConfigPolicyAutomatic) {\r
1952 //\r
1953 // Skip the process below as it's not required under the current policy.\r
1954 //\r
1955 goto Exit;\r
1956 }\r
1957\r
1958 NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp);\r
1959\r
1960 //\r
1961 // Validate the incoming Router Advertisement\r
1962 //\r
1963\r
1964 //\r
1965 // The IP source address must be a link-local address\r
1966 //\r
1967 if (!NetIp6IsLinkLocalAddr (&Head->SourceAddress)) {\r
1968 goto Exit;\r
1969 }\r
1970 //\r
1971 // The IP Hop Limit field has a value of 255, i.e. the packet\r
1972 // could not possibly have been forwarded by a router.\r
1973 // ICMP Code is 0.\r
1974 // ICMP length (derived from the IP length) is 16 or more octets.\r
1975 //\r
1976 if (Head->HopLimit != IP6_HOP_LIMIT || Icmp.Head.Code != 0 ||\r
1977 Head->PayloadLength < IP6_RA_LENGTH) {\r
1978 goto Exit;\r
1979 }\r
1980\r
1981 //\r
1982 // All included options have a length that is greater than zero.\r
1983 //\r
1984 OptionLen = (UINT16) (Head->PayloadLength - IP6_RA_LENGTH);\r
1985 Option = NetbufGetByte (Packet, IP6_RA_LENGTH, NULL);\r
1986\r
1987 if (!Ip6IsNDOptionValid (Option, OptionLen)) {\r
1988 goto Exit;\r
1989 }\r
1990\r
1991 //\r
1992 // Process Fourth field.\r
1993 // In Router Advertisement, Fourth is composed of CurHopLimit (8bit), M flag, O flag,\r
1994 // and Router Lifetime (16 bit).\r
1995 //\r
1996\r
1997 Fourth = NTOHL (Icmp.Fourth);\r
1998 CopyMem (&RouterLifetime, &Fourth, sizeof (UINT16));\r
1999\r
2000 //\r
2001 // If the source address already in the default router list, update it.\r
2002 // Otherwise create a new entry.\r
2003 // A Lifetime of zero indicates that the router is not a default router.\r
2004 //\r
2005 DefaultRouter = Ip6FindDefaultRouter (IpSb, &Head->SourceAddress);\r
2006 if (DefaultRouter == NULL) {\r
2007 if (RouterLifetime != 0) {\r
2008 DefaultRouter = Ip6CreateDefaultRouter (IpSb, &Head->SourceAddress, RouterLifetime);\r
2009 if (DefaultRouter == NULL) {\r
2010 Status = EFI_OUT_OF_RESOURCES;\r
2011 goto Exit;\r
2012 }\r
2013 }\r
2014 } else {\r
2015 if (RouterLifetime != 0) {\r
2016 DefaultRouter->Lifetime = RouterLifetime;\r
2017 //\r
2018 // Check the corresponding neighbor cache entry here.\r
2019 //\r
2020 if (DefaultRouter->NeighborCache == NULL) {\r
2021 DefaultRouter->NeighborCache = Ip6FindNeighborEntry (IpSb, &Head->SourceAddress);\r
2022 }\r
2023 } else {\r
2024 //\r
2025 // If the address is in the host's default router list and the router lifetime is zero,\r
2026 // immediately time-out the entry.\r
2027 //\r
2028 Ip6DestroyDefaultRouter (IpSb, DefaultRouter);\r
2029 }\r
2030 }\r
2031\r
2032 CurHopLimit = *((UINT8 *) &Fourth + 3);\r
2033 if (CurHopLimit != 0) {\r
2034 IpSb->CurHopLimit = CurHopLimit;\r
2035 }\r
2036\r
2037 Mflag = FALSE;\r
2038 Oflag = FALSE;\r
2039 if ((*((UINT8 *) &Fourth + 2) & IP6_M_ADDR_CONFIG_FLAG) == IP6_M_ADDR_CONFIG_FLAG) {\r
2040 Mflag = TRUE;\r
2041 } else {\r
2042 if ((*((UINT8 *) &Fourth + 2) & IP6_O_CONFIG_FLAG) == IP6_O_CONFIG_FLAG) {\r
2043 Oflag = TRUE;\r
2044 }\r
2045 }\r
2046\r
2047 if (Mflag || Oflag) {\r
2048 //\r
2049 // Use Ip6Config to get available addresses or other configuration from DHCP.\r
2050 //\r
2051 Ip6ConfigStartStatefulAutoConfig (&IpSb->Ip6ConfigInstance, Oflag);\r
2052 }\r
2053\r
2054 //\r
2055 // Process Reachable Time and Retrans Timer fields.\r
2056 //\r
2057 NetbufCopy (Packet, sizeof (Icmp), sizeof (UINT32), (UINT8 *) &ReachableTime);\r
2058 NetbufCopy (Packet, sizeof (Icmp) + sizeof (UINT32), sizeof (UINT32), (UINT8 *) &RetransTimer);\r
2059 ReachableTime = NTOHL (ReachableTime);\r
2060 RetransTimer = NTOHL (RetransTimer);\r
2061\r
2062 if (ReachableTime != 0 && ReachableTime != IpSb->BaseReachableTime) {\r
2063 //\r
2064 // If new value is not unspecified and differs from the previous one, record it\r
2065 // in BaseReachableTime and recompute a ReachableTime.\r
2066 //\r
2067 IpSb->BaseReachableTime = ReachableTime;\r
2068 Ip6UpdateReachableTime (IpSb);\r
2069 }\r
2070\r
2071 if (RetransTimer != 0) {\r
2072 IpSb->RetransTimer = RetransTimer;\r
2073 }\r
2074\r
2075 //\r
2076 // IsRouter flag must be set to TRUE if corresponding neighbor cache entry exists.\r
2077 //\r
2078 NeighborCache = Ip6FindNeighborEntry (IpSb, &Head->SourceAddress);\r
2079 if (NeighborCache != NULL) {\r
2080 NeighborCache->IsRouter = TRUE;\r
2081 }\r
2082\r
2083 //\r
2084 // If an valid router advertisment is received, stops router solicitation.\r
2085 //\r
2086 IpSb->RouterAdvertiseReceived = TRUE;\r
2087\r
2088 //\r
2089 // The only defined options that may appear are the Source\r
2090 // Link-Layer Address, Prefix information and MTU options.\r
2091 // All included options have a length that is greater than zero.\r
2092 //\r
2093 Offset = 16;\r
2094 while (Offset < Head->PayloadLength) {\r
2095 NetbufCopy (Packet, Offset, sizeof (UINT8), &Type);\r
2096 switch (Type) {\r
2097 case Ip6OptionEtherSource:\r
2098 //\r
2099 // Update the neighbor cache\r
2100 //\r
2101 NetbufCopy (Packet, Offset, sizeof (IP6_ETHER_ADDR_OPTION), (UINT8 *) &LinkLayerOption);\r
2102 if (LinkLayerOption.Length <= 0) {\r
2103 goto Exit;\r
2104 }\r
2105\r
2106 ZeroMem (&LinkLayerAddress, sizeof (EFI_MAC_ADDRESS));\r
2107 CopyMem (&LinkLayerAddress, LinkLayerOption.EtherAddr, 6);\r
2108\r
2109 if (NeighborCache == NULL) {\r
2110 NeighborCache = Ip6CreateNeighborEntry (\r
2111 IpSb,\r
2112 Ip6OnArpResolved,\r
2113 &Head->SourceAddress,\r
2114 &LinkLayerAddress\r
2115 );\r
2116 if (NeighborCache == NULL) {\r
2117 Status = EFI_OUT_OF_RESOURCES;\r
2118 goto Exit;\r
2119 }\r
2120 NeighborCache->IsRouter = TRUE;\r
2121 NeighborCache->State = EfiNeighborStale;\r
2122 NeighborCache->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
2123 } else {\r
2124 Result = CompareMem (&LinkLayerAddress, &NeighborCache->LinkAddress, 6);\r
2125\r
2126 //\r
2127 // If the link-local address is the same as that already in the cache,\r
2128 // the cache entry's state remains unchanged. Otherwise update the\r
2129 // reachability state to STALE.\r
2130 //\r
2131 if ((NeighborCache->State == EfiNeighborInComplete) || (Result != 0)) {\r
2132 CopyMem (&NeighborCache->LinkAddress, &LinkLayerAddress, 6);\r
2133\r
2134 NeighborCache->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
2135\r
2136 if (NeighborCache->State == EfiNeighborInComplete) {\r
2137 //\r
2138 // Send queued packets if exist.\r
2139 //\r
2140 NeighborCache->State = EfiNeighborStale;\r
2141 NeighborCache->CallBack ((VOID *) NeighborCache);\r
2142 } else {\r
2143 NeighborCache->State = EfiNeighborStale;\r
2144 }\r
2145 }\r
2146 }\r
2147\r
2148 Offset = (UINT16) (Offset + (UINT16) LinkLayerOption.Length * 8);\r
2149 break;\r
2150 case Ip6OptionPrefixInfo:\r
2151 NetbufCopy (Packet, Offset, sizeof (IP6_PREFIX_INFO_OPTION), (UINT8 *) &PrefixOption);\r
2152 if (PrefixOption.Length != 4) {\r
2153 goto Exit;\r
2154 }\r
2155 PrefixOption.ValidLifetime = NTOHL (PrefixOption.ValidLifetime);\r
2156 PrefixOption.PreferredLifetime = NTOHL (PrefixOption.PreferredLifetime);\r
2157\r
2158 //\r
2159 // Get L and A flag, recorded in the lower 2 bits of Reserved1\r
2160 //\r
2161 OnLink = FALSE;\r
2162 if ((PrefixOption.Reserved1 & IP6_ON_LINK_FLAG) == IP6_ON_LINK_FLAG) {\r
2163 OnLink = TRUE;\r
2164 }\r
2165 Autonomous = FALSE;\r
2166 if ((PrefixOption.Reserved1 & IP6_AUTO_CONFIG_FLAG) == IP6_AUTO_CONFIG_FLAG) {\r
2167 Autonomous = TRUE;\r
2168 }\r
2169\r
2170 //\r
2171 // If the prefix is the link-local prefix, silently ignore the prefix option.\r
2172 //\r
2173 if (PrefixOption.PrefixLength == IP6_LINK_LOCAL_PREFIX_LENGTH &&\r
2174 NetIp6IsLinkLocalAddr (&PrefixOption.Prefix)\r
2175 ) {\r
2176 Offset += sizeof (IP6_PREFIX_INFO_OPTION);\r
2177 break;\r
2178 }\r
2179 //\r
2180 // Do following if on-link flag is set according to RFC4861.\r
2181 //\r
2182 if (OnLink) {\r
2183 PrefixList = Ip6FindPrefixListEntry (\r
2184 IpSb,\r
2185 TRUE,\r
2186 PrefixOption.PrefixLength,\r
2187 &PrefixOption.Prefix\r
2188 );\r
2189 //\r
2190 // Create a new entry for the prefix, if the ValidLifetime is zero,\r
2191 // silently ignore the prefix option.\r
2192 //\r
2193 if (PrefixList == NULL && PrefixOption.ValidLifetime != 0) {\r
2194 PrefixList = Ip6CreatePrefixListEntry (\r
2195 IpSb,\r
2196 TRUE,\r
2197 PrefixOption.ValidLifetime,\r
2198 PrefixOption.PreferredLifetime,\r
2199 PrefixOption.PrefixLength,\r
2200 &PrefixOption.Prefix\r
2201 );\r
2202 if (PrefixList == NULL) {\r
2203 Status = EFI_OUT_OF_RESOURCES;\r
2204 goto Exit;\r
2205 }\r
2206 } else if (PrefixList != NULL) {\r
2207 if (PrefixOption.ValidLifetime != 0) {\r
2208 PrefixList->ValidLifetime = PrefixOption.ValidLifetime;\r
2209 } else {\r
2210 //\r
2211 // If the prefix exists and incoming ValidLifetime is zero, immediately\r
2212 // remove the prefix.\r
2213 Ip6DestroyPrefixListEntry (IpSb, PrefixList, OnLink, TRUE);\r
2214 }\r
2215 }\r
2216 }\r
2217\r
2218 //\r
2219 // Do following if Autonomous flag is set according to RFC4862.\r
2220 //\r
2221 if (Autonomous && PrefixOption.PreferredLifetime <= PrefixOption.ValidLifetime) {\r
2222 PrefixList = Ip6FindPrefixListEntry (\r
2223 IpSb,\r
2224 FALSE,\r
2225 PrefixOption.PrefixLength,\r
2226 &PrefixOption.Prefix\r
2227 );\r
2228 //\r
2229 // Create a new entry for the prefix, and form an address by prefix + interface id\r
2230 // If the sum of the prefix length and interface identifier length\r
2231 // does not equal 128 bits, the Prefix Information option MUST be ignored.\r
2232 //\r
2233 if (PrefixList == NULL &&\r
2234 PrefixOption.ValidLifetime != 0 &&\r
2235 PrefixOption.PrefixLength + IpSb->InterfaceIdLen * 8 == 128\r
2236 ) {\r
2237 //\r
2238 // Form the address in network order.\r
2239 //\r
2240 CopyMem (&StatelessAddress, &PrefixOption.Prefix, sizeof (UINT64));\r
2241 CopyMem (&StatelessAddress.Addr[8], IpSb->InterfaceId, sizeof (UINT64));\r
2242\r
2243 //\r
2244 // If the address is not yet in the assigned address list, adds it into.\r
2245 //\r
2246 if (!Ip6IsOneOfSetAddress (IpSb, &StatelessAddress, NULL, NULL)) {\r
2247 //\r
2248 // And also not in the DAD process, check its uniqeness firstly.\r
2249 //\r
2250 if (Ip6FindDADEntry (IpSb, &StatelessAddress, NULL) == NULL) {\r
2251 Status = Ip6SetAddress (\r
2252 IpSb->DefaultInterface,\r
2253 &StatelessAddress,\r
2254 FALSE,\r
2255 PrefixOption.PrefixLength,\r
2256 PrefixOption.ValidLifetime,\r
2257 PrefixOption.PreferredLifetime,\r
2258 NULL,\r
2259 NULL\r
2260 );\r
2261 if (EFI_ERROR (Status)) {\r
2262 goto Exit;\r
2263 }\r
2264 }\r
2265 }\r
2266\r
2267 //\r
2268 // Adds the prefix option to stateless prefix option list.\r
2269 //\r
2270 PrefixList = Ip6CreatePrefixListEntry (\r
2271 IpSb,\r
2272 FALSE,\r
2273 PrefixOption.ValidLifetime,\r
2274 PrefixOption.PreferredLifetime,\r
2275 PrefixOption.PrefixLength,\r
2276 &PrefixOption.Prefix\r
2277 );\r
2278 if (PrefixList == NULL) {\r
2279 Status = EFI_OUT_OF_RESOURCES;\r
2280 goto Exit;\r
2281 }\r
2282 } else if (PrefixList != NULL) {\r
2283\r
2284 //\r
2285 // Reset the preferred lifetime of the address if the advertised prefix exists.\r
2286 // Perform specific action to valid lifetime together.\r
2287 //\r
2288 PrefixList->PreferredLifetime = PrefixOption.PreferredLifetime;\r
2289 if ((PrefixOption.ValidLifetime > 7200) ||\r
2290 (PrefixOption.ValidLifetime > PrefixList->ValidLifetime)) {\r
2291 //\r
2292 // If the received Valid Lifetime is greater than 2 hours or\r
2293 // greater than RemainingLifetime, set the valid lifetime of the\r
2294 // corresponding address to the advertised Valid Lifetime.\r
2295 //\r
2296 PrefixList->ValidLifetime = PrefixOption.ValidLifetime;\r
2297\r
2298 } else if (PrefixList->ValidLifetime <= 7200) {\r
2299 //\r
2300 // If RemainingLifetime is less than or equls to 2 hours, ignore the\r
2301 // Prefix Information option with regards to the valid lifetime.\r
2302 // TODO: If this option has been authenticated, set the valid lifetime.\r
2303 //\r
2304 } else {\r
2305 //\r
2306 // Otherwise, reset the valid lifetime of the corresponding\r
2307 // address to 2 hours.\r
2308 //\r
2309 PrefixList->ValidLifetime = 7200;\r
2310 }\r
2311 }\r
2312 }\r
2313\r
2314 Offset += sizeof (IP6_PREFIX_INFO_OPTION);\r
2315 break;\r
2316 case Ip6OptionMtu:\r
2317 NetbufCopy (Packet, Offset, sizeof (IP6_MTU_OPTION), (UINT8 *) &MTUOption);\r
2318 if (MTUOption.Length != 1) {\r
2319 goto Exit;\r
2320 }\r
2321\r
2322 //\r
2323 // Use IPv6 minimum link MTU 1280 bytes as the maximum packet size in order\r
2324 // to omit implementation of Path MTU Discovery. Thus ignore the MTU option\r
2325 // in Router Advertisement.\r
2326 //\r
2327\r
2328 Offset += sizeof (IP6_MTU_OPTION);\r
2329 break;\r
2330 default:\r
2331 //\r
2332 // Silently ignore unrecognized options\r
2333 //\r
2334 NetbufCopy (Packet, Offset + sizeof (UINT8), sizeof (UINT8), &Length);\r
2335 if (Length <= 0) {\r
2336 goto Exit;\r
2337 }\r
2338\r
2339 Offset = (UINT16) (Offset + (UINT16) Length * 8);\r
2340 break;\r
2341 }\r
2342 }\r
2343\r
2344 Status = EFI_SUCCESS;\r
2345\r
2346Exit:\r
2347 NetbufFree (Packet);\r
2348 return Status;\r
2349}\r
2350\r
2351/**\r
2352 Process the ICMPv6 redirect message. Find the instance, then update\r
2353 its route cache.\r
2354\r
2355 @param[in] IpSb The IP6 service binding instance that received\r
2356 the packet.\r
2357 @param[in] Head The IP head of the received ICMPv6 packet.\r
2358 @param[in] Packet The content of the ICMPv6 redirect packet with\r
2359 the IP head removed.\r
2360\r
2361 @retval EFI_INVALID_PARAMETER The parameter is invalid.\r
2362 @retval EFI_OUT_OF_RESOURCES Insuffcient resources to complete the\r
2363 operation.\r
2364 @retval EFI_SUCCESS Successfully updated the route caches.\r
2365\r
2366**/\r
2367EFI_STATUS\r
2368Ip6ProcessRedirect (\r
2369 IN IP6_SERVICE *IpSb,\r
2370 IN EFI_IP6_HEADER *Head,\r
2371 IN NET_BUF *Packet\r
2372 )\r
2373{\r
2374 IP6_ICMP_INFORMATION_HEAD *Icmp;\r
2375 EFI_IPv6_ADDRESS *Target;\r
2376 EFI_IPv6_ADDRESS *IcmpDest;\r
2377 UINT8 *Option;\r
2378 UINT16 OptionLen;\r
2379 IP6_ROUTE_ENTRY *RouteEntry;\r
2380 IP6_ROUTE_CACHE_ENTRY *RouteCache;\r
2381 IP6_NEIGHBOR_ENTRY *NeighborCache;\r
2382 INT32 Length;\r
2383 UINT8 OptLen;\r
2384 IP6_ETHER_ADDR_OPTION *LinkLayerOption;\r
2385 EFI_MAC_ADDRESS Mac;\r
2386 UINT32 Index;\r
2387 BOOLEAN IsRouter;\r
2388 EFI_STATUS Status;\r
2389 INTN Result;\r
2390\r
2391 Status = EFI_INVALID_PARAMETER;\r
2392\r
2393 Icmp = (IP6_ICMP_INFORMATION_HEAD *) NetbufGetByte (Packet, 0, NULL);\r
2394 if (Icmp == NULL) {\r
2395 goto Exit;\r
2396 }\r
2397\r
2398 //\r
2399 // Validate the incoming Redirect message\r
2400 //\r
2401\r
2402 //\r
2403 // The IP Hop Limit field has a value of 255, i.e. the packet\r
2404 // could not possibly have been forwarded by a router.\r
2405 // ICMP Code is 0.\r
2406 // ICMP length (derived from the IP length) is 40 or more octets.\r
2407 //\r
2408 if (Head->HopLimit != IP6_HOP_LIMIT || Icmp->Head.Code != 0 ||\r
2409 Head->PayloadLength < IP6_REDITECT_LENGTH) {\r
2410 goto Exit;\r
2411 }\r
2412\r
2413 //\r
2414 // The IP source address must be a link-local address\r
2415 //\r
2416 if (!NetIp6IsLinkLocalAddr (&Head->SourceAddress)) {\r
2417 goto Exit;\r
2418 }\r
2419\r
2420 //\r
2421 // The dest of this ICMP redirect message is not us.\r
2422 //\r
2423 if (!Ip6IsOneOfSetAddress (IpSb, &Head->DestinationAddress, NULL, NULL)) {\r
2424 goto Exit;\r
2425 }\r
2426\r
2427 //\r
2428 // All included options have a length that is greater than zero.\r
2429 //\r
2430 OptionLen = (UINT16) (Head->PayloadLength - IP6_REDITECT_LENGTH);\r
2431 Option = NetbufGetByte (Packet, IP6_REDITECT_LENGTH, NULL);\r
2432\r
2433 if (!Ip6IsNDOptionValid (Option, OptionLen)) {\r
2434 goto Exit;\r
2435 }\r
2436\r
2437 Target = (EFI_IPv6_ADDRESS *) (Icmp + 1);\r
2438 IcmpDest = Target + 1;\r
2439\r
2440 //\r
2441 // The ICMP Destination Address field in the redirect message does not contain\r
2442 // a multicast address.\r
2443 //\r
2444 if (IP6_IS_MULTICAST (IcmpDest)) {\r
2445 goto Exit;\r
2446 }\r
2447\r
2448 //\r
2449 // The ICMP Target Address is either a link-local address (when redirected to\r
2450 // a router) or the same as the ICMP Destination Address (when redirected to\r
2451 // the on-link destination).\r
2452 //\r
2453 IsRouter = (BOOLEAN) !EFI_IP6_EQUAL (Target, IcmpDest);\r
2454 if (!NetIp6IsLinkLocalAddr (Target) && IsRouter) {\r
2455 goto Exit;\r
2456 }\r
2457\r
2458 //\r
2459 // Check the options. The only interested option here is the target-link layer\r
2460 // address option.\r
2461 //\r
2462 Length = Packet->TotalSize - 40;\r
2463 Option = (UINT8 *) (IcmpDest + 1);\r
2464 LinkLayerOption = NULL;\r
2465 while (Length > 0) {\r
2466 switch (*Option) {\r
2467 case Ip6OptionEtherTarget:\r
2468\r
2469 LinkLayerOption = (IP6_ETHER_ADDR_OPTION *) Option;\r
2470 OptLen = LinkLayerOption->Length;\r
2471 if (OptLen != 1) {\r
2472 //\r
2473 // For ethernet, the length must be 1.\r
2474 //\r
2475 goto Exit;\r
2476 }\r
2477 break;\r
2478\r
2479 default:\r
2480\r
2481 OptLen = *(Option + 1);\r
2482 if (OptLen == 0) {\r
2483 //\r
2484 // A length of 0 is invalid.\r
2485 //\r
2486 goto Exit;\r
2487 }\r
2488 break;\r
2489 }\r
2490\r
2491 Length -= 8 * OptLen;\r
2492 Option += 8 * OptLen;\r
2493 }\r
2494\r
2495 if (Length != 0) {\r
2496 goto Exit;\r
2497 }\r
2498\r
2499 //\r
2500 // The IP source address of the Redirect is the same as the current\r
2501 // first-hop router for the specified ICMP Destination Address.\r
2502 //\r
2503 RouteCache = Ip6FindRouteCache (IpSb->RouteTable, IcmpDest, &Head->DestinationAddress);\r
2504 if (RouteCache != NULL) {\r
2505 if (!EFI_IP6_EQUAL (&RouteCache->NextHop, &Head->SourceAddress)) {\r
2506 //\r
2507 // The source of this Redirect message must match the NextHop of the\r
2508 // corresponding route cache entry.\r
2509 //\r
2510 goto Exit;\r
2511 }\r
2512\r
2513 //\r
2514 // Update the NextHop.\r
2515 //\r
2516 IP6_COPY_ADDRESS (&RouteCache->NextHop, Target);\r
2517\r
2518 if (!IsRouter) {\r
2519 RouteEntry = (IP6_ROUTE_ENTRY *) RouteCache->Tag;\r
2520 RouteEntry->Flag = RouteEntry->Flag | IP6_DIRECT_ROUTE;\r
2521 }\r
2522\r
2523 } else {\r
2524 //\r
2525 // Get the Route Entry.\r
2526 //\r
2527 RouteEntry = Ip6FindRouteEntry (IpSb->RouteTable, IcmpDest, NULL);\r
2528 if (RouteEntry == NULL) {\r
2529 RouteEntry = Ip6CreateRouteEntry (IcmpDest, 0, NULL);\r
2530 if (RouteEntry == NULL) {\r
2531 Status = EFI_OUT_OF_RESOURCES;\r
2532 goto Exit;\r
2533 }\r
2534 }\r
2535\r
2536 if (!IsRouter) {\r
2537 RouteEntry->Flag = IP6_DIRECT_ROUTE;\r
2538 }\r
2539\r
2540 //\r
2541 // Create a route cache for this.\r
2542 //\r
2543 RouteCache = Ip6CreateRouteCacheEntry (\r
2544 IcmpDest,\r
2545 &Head->DestinationAddress,\r
2546 Target,\r
2547 (UINTN) RouteEntry\r
2548 );\r
2549 if (RouteCache == NULL) {\r
2550 Status = EFI_OUT_OF_RESOURCES;\r
2551 goto Exit;\r
2552 }\r
2553\r
2554 //\r
2555 // Insert the newly created route cache entry.\r
2556 //\r
2557 Index = IP6_ROUTE_CACHE_HASH (IcmpDest, &Head->DestinationAddress);\r
2558 InsertHeadList (&IpSb->RouteTable->Cache.CacheBucket[Index], &RouteCache->Link);\r
2559 }\r
2560\r
2561 //\r
2562 // Try to locate the neighbor cache for the Target.\r
2563 //\r
2564 NeighborCache = Ip6FindNeighborEntry (IpSb, Target);\r
2565\r
2566 if (LinkLayerOption != NULL) {\r
2567 if (NeighborCache == NULL) {\r
2568 //\r
2569 // Create a neighbor cache for the Target.\r
2570 //\r
2571 ZeroMem (&Mac, sizeof (EFI_MAC_ADDRESS));\r
2572 CopyMem (&Mac, LinkLayerOption->EtherAddr, 6);\r
2573 NeighborCache = Ip6CreateNeighborEntry (IpSb, Ip6OnArpResolved, Target, &Mac);\r
2574 if (NeighborCache == NULL) {\r
2575 //\r
2576 // Just report a success here. The neighbor cache can be created in\r
2577 // some other place.\r
2578 //\r
2579 Status = EFI_SUCCESS;\r
2580 goto Exit;\r
2581 }\r
2582\r
2583 NeighborCache->State = EfiNeighborStale;\r
2584 NeighborCache->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
2585 } else {\r
2586 Result = CompareMem (LinkLayerOption->EtherAddr, &NeighborCache->LinkAddress, 6);\r
2587\r
2588 //\r
2589 // If the link-local address is the same as that already in the cache,\r
2590 // the cache entry's state remains unchanged. Otherwise update the\r
2591 // reachability state to STALE.\r
2592 //\r
2593 if ((NeighborCache->State == EfiNeighborInComplete) || (Result != 0)) {\r
2594 CopyMem (&NeighborCache->LinkAddress, LinkLayerOption->EtherAddr, 6);\r
2595\r
2596 NeighborCache->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
2597\r
2598 if (NeighborCache->State == EfiNeighborInComplete) {\r
2599 //\r
2600 // Send queued packets if exist.\r
2601 //\r
2602 NeighborCache->State = EfiNeighborStale;\r
2603 NeighborCache->CallBack ((VOID *) NeighborCache);\r
2604 } else {\r
2605 NeighborCache->State = EfiNeighborStale;\r
2606 }\r
2607 }\r
2608 }\r
2609 }\r
2610\r
2611 if (NeighborCache != NULL && IsRouter) {\r
2612 //\r
2613 // The Target is a router, set IsRouter to TRUE.\r
2614 //\r
2615 NeighborCache->IsRouter = TRUE;\r
2616 }\r
2617\r
2618 Status = EFI_SUCCESS;\r
2619\r
2620Exit:\r
2621 NetbufFree (Packet);\r
2622 return Status;\r
2623}\r
2624\r
2625/**\r
2626 Add Neighbor cache entries. It is a work function for EfiIp6Neighbors().\r
2627\r
2628 @param[in] IpSb The IP6 service binding instance.\r
2629 @param[in] TargetIp6Address Pointer to Target IPv6 address.\r
2630 @param[in] TargetLinkAddress Pointer to link-layer address of the target. Ignored if NULL.\r
2631 @param[in] Timeout Time in 100-ns units that this entry will remain in the neighbor\r
2632 cache. It will be deleted after Timeout. A value of zero means that\r
2633 the entry is permanent. A non-zero value means that the entry is\r
2634 dynamic.\r
2635 @param[in] Override If TRUE, the cached link-layer address of the matching entry will\r
2636 be overridden and updated; if FALSE, and if a\r
2637 corresponding cache entry already existed, EFI_ACCESS_DENIED\r
2638 will be returned.\r
2639\r
2640 @retval EFI_SUCCESS The neighbor cache entry has been added.\r
2641 @retval EFI_OUT_OF_RESOURCES Could not add the entry to the neighbor cache\r
2642 due to insufficient resources.\r
2643 @retval EFI_NOT_FOUND TargetLinkAddress is NULL.\r
2644 @retval EFI_ACCESS_DENIED The to-be-added entry is already defined in the neighbor cache,\r
2645 and that entry is tagged as un-overridden (when DeleteFlag\r
2646 is FALSE).\r
2647\r
2648**/\r
2649EFI_STATUS\r
2650Ip6AddNeighbor (\r
2651 IN IP6_SERVICE *IpSb,\r
2652 IN EFI_IPv6_ADDRESS *TargetIp6Address,\r
2653 IN EFI_MAC_ADDRESS *TargetLinkAddress OPTIONAL,\r
2654 IN UINT32 Timeout,\r
2655 IN BOOLEAN Override\r
2656 )\r
2657{\r
2658 IP6_NEIGHBOR_ENTRY *Neighbor;\r
2659\r
2660 Neighbor = Ip6FindNeighborEntry (IpSb, TargetIp6Address);\r
2661 if (Neighbor != NULL) {\r
2662 if (!Override) {\r
2663 return EFI_ACCESS_DENIED;\r
2664 } else {\r
2665 if (TargetLinkAddress != NULL) {\r
2666 IP6_COPY_LINK_ADDRESS (&Neighbor->LinkAddress, TargetLinkAddress);\r
2667 }\r
2668 }\r
2669 } else {\r
2670 if (TargetLinkAddress == NULL) {\r
2671 return EFI_NOT_FOUND;\r
2672 }\r
2673\r
2674 Neighbor = Ip6CreateNeighborEntry (IpSb, Ip6OnArpResolved, TargetIp6Address, TargetLinkAddress);\r
2675 if (Neighbor == NULL) {\r
2676 return EFI_OUT_OF_RESOURCES;\r
2677 }\r
2678 }\r
2679\r
2680 Neighbor->State = EfiNeighborReachable;\r
2681\r
2682 if (Timeout != 0) {\r
2683 Neighbor->Ticks = IP6_GET_TICKS (Timeout / TICKS_PER_MS);\r
2684 Neighbor->Dynamic = TRUE;\r
2685 } else {\r
2686 Neighbor->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
2687 }\r
2688\r
2689 return EFI_SUCCESS;\r
2690}\r
2691\r
2692/**\r
2693 Delete or update Neighbor cache entries. It is a work function for EfiIp6Neighbors().\r
2694\r
2695 @param[in] IpSb The IP6 service binding instance.\r
2696 @param[in] TargetIp6Address Pointer to Target IPv6 address.\r
2697 @param[in] TargetLinkAddress Pointer to link-layer address of the target. Ignored if NULL.\r
2698 @param[in] Timeout Time in 100-ns units that this entry will remain in the neighbor\r
2699 cache. It will be deleted after Timeout. A value of zero means that\r
2700 the entry is permanent. A non-zero value means that the entry is\r
2701 dynamic.\r
2702 @param[in] Override If TRUE, the cached link-layer address of the matching entry will\r
2703 be overridden and updated; if FALSE, and if a\r
2704 corresponding cache entry already existed, EFI_ACCESS_DENIED\r
2705 will be returned.\r
2706\r
2707 @retval EFI_SUCCESS The neighbor cache entry has been updated or deleted.\r
2708 @retval EFI_NOT_FOUND This entry is not in the neighbor cache.\r
2709\r
2710**/\r
2711EFI_STATUS\r
2712Ip6DelNeighbor (\r
2713 IN IP6_SERVICE *IpSb,\r
2714 IN EFI_IPv6_ADDRESS *TargetIp6Address,\r
2715 IN EFI_MAC_ADDRESS *TargetLinkAddress OPTIONAL,\r
2716 IN UINT32 Timeout,\r
2717 IN BOOLEAN Override\r
2718 )\r
2719{\r
2720 IP6_NEIGHBOR_ENTRY *Neighbor;\r
2721\r
2722 Neighbor = Ip6FindNeighborEntry (IpSb, TargetIp6Address);\r
2723 if (Neighbor == NULL) {\r
2724 return EFI_NOT_FOUND;\r
2725 }\r
2726\r
2727 RemoveEntryList (&Neighbor->Link);\r
2728 FreePool (Neighbor);\r
2729\r
2730 return EFI_SUCCESS;\r
2731}\r
2732\r
2733/**\r
2734 The heartbeat timer of ND module in IP6_TIMER_INTERVAL_IN_MS milliseconds.\r
2735 This time routine handles DAD module and neighbor state transition.\r
2736 It is also responsible for sending out router solicitations.\r
2737\r
2738 @param[in] Event The IP6 service instance's heartbeat timer.\r
2739 @param[in] Context The IP6 service instance.\r
2740\r
2741**/\r
2742VOID\r
2743EFIAPI\r
2744Ip6NdFasterTimerTicking (\r
2745 IN EFI_EVENT Event,\r
2746 IN VOID *Context\r
2747 )\r
2748{\r
2749 LIST_ENTRY *Entry;\r
2750 LIST_ENTRY *Next;\r
2751 LIST_ENTRY *Entry2;\r
2752 IP6_INTERFACE *IpIf;\r
2753 IP6_DELAY_JOIN_LIST *DelayNode;\r
2754 EFI_IPv6_ADDRESS Source;\r
2755 IP6_DAD_ENTRY *DupAddrDetect;\r
2756 EFI_STATUS Status;\r
2757 IP6_NEIGHBOR_ENTRY *NeighborCache;\r
2758 EFI_IPv6_ADDRESS Destination;\r
2759 IP6_SERVICE *IpSb;\r
2760 BOOLEAN Flag;\r
2761\r
2762 IpSb = (IP6_SERVICE *) Context;\r
2763 NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r
2764\r
2765 ZeroMem (&Source, sizeof (EFI_IPv6_ADDRESS));\r
2766\r
2767 //\r
2768 // A host SHOULD transmit up to MAX_RTR_SOLICITATIONS (3) Router\r
2769 // Solicitation messages, each separated by at least\r
2770 // RTR_SOLICITATION_INTERVAL (4) seconds.\r
2771 //\r
2772 if ((IpSb->Ip6ConfigInstance.Policy == Ip6ConfigPolicyAutomatic) &&\r
2773 !IpSb->RouterAdvertiseReceived &&\r
2774 IpSb->SolicitTimer > 0\r
2775 ) {\r
2776 if ((IpSb->Ticks == 0) || (--IpSb->Ticks == 0)) {\r
2777 Status = Ip6SendRouterSolicit (IpSb, NULL, NULL, NULL, NULL);\r
2778 if (!EFI_ERROR (Status)) {\r
2779 IpSb->SolicitTimer--;\r
2780 IpSb->Ticks = (UINT32) IP6_GET_TICKS (IP6_RTR_SOLICITATION_INTERVAL);\r
2781 }\r
2782 }\r
2783 }\r
2784\r
2785 NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) {\r
2786 IpIf = NET_LIST_USER_STRUCT (Entry, IP6_INTERFACE, Link);\r
2787\r
2788 //\r
2789 // Process the delay list to join the solicited-node multicast address.\r
2790 //\r
2791 NET_LIST_FOR_EACH_SAFE (Entry2, Next, &IpIf->DelayJoinList) {\r
2792 DelayNode = NET_LIST_USER_STRUCT (Entry2, IP6_DELAY_JOIN_LIST, Link);\r
2793 if ((DelayNode->DelayTime == 0) || (--DelayNode->DelayTime == 0)) {\r
2794 //\r
2795 // The timer expires, init the duplicate address detection.\r
2796 //\r
2797 Ip6InitDADProcess (\r
2798 DelayNode->Interface,\r
2799 DelayNode->AddressInfo,\r
2800 DelayNode->DadCallback,\r
2801 DelayNode->Context\r
2802 );\r
2803\r
2804 //\r
2805 // Remove the delay node\r
2806 //\r
2807 RemoveEntryList (&DelayNode->Link);\r
2808 FreePool (DelayNode);\r
2809 }\r
2810 }\r
2811\r
2812 //\r
2813 // Process the duplicate address detection list.\r
2814 //\r
2815 NET_LIST_FOR_EACH_SAFE (Entry2, Next, &IpIf->DupAddrDetectList) {\r
2816 DupAddrDetect = NET_LIST_USER_STRUCT (Entry2, IP6_DAD_ENTRY, Link);\r
2817\r
2818 if ((DupAddrDetect->RetransTick == 0) || (--DupAddrDetect->RetransTick == 0)) {\r
2819 //\r
2820 // The timer expires, check the remaining transmit counts.\r
2821 //\r
2822 if (DupAddrDetect->Transmit < DupAddrDetect->MaxTransmit) {\r
2823 //\r
2824 // Send the Neighbor Solicitation message with\r
2825 // Source - unspecified address, destination - solicited-node multicast address\r
2826 // Target - the address to be validated\r
2827 //\r
2828 Status = Ip6SendNeighborSolicit (\r
2829 IpSb,\r
2830 NULL,\r
2831 &DupAddrDetect->Destination,\r
2832 &DupAddrDetect->AddressInfo->Address,\r
2833 NULL\r
2834 );\r
2835 if (EFI_ERROR (Status)) {\r
2836 return;\r
2837 }\r
2838\r
2839 DupAddrDetect->Transmit++;\r
2840 DupAddrDetect->RetransTick = IP6_GET_TICKS (IpSb->RetransTimer);\r
2841 } else {\r
2842 //\r
2843 // All required solicitation has been sent out, and the RetransTime after the last\r
2844 // Neighbor Solicit is elapsed, finish the DAD process.\r
2845 //\r
2846 Flag = FALSE;\r
2847 if ((DupAddrDetect->Receive == 0) ||\r
2848 (DupAddrDetect->Transmit == DupAddrDetect->Receive)) {\r
2849 Flag = TRUE;\r
2850 }\r
2851\r
2852 Ip6OnDADFinished (Flag, IpIf, DupAddrDetect);\r
2853 }\r
2854 }\r
2855 }\r
2856 }\r
2857\r
2858 //\r
2859 // Polling the state of Neighbor cache\r
2860 //\r
2861 NET_LIST_FOR_EACH_SAFE (Entry, Next, &IpSb->NeighborTable) {\r
2862 NeighborCache = NET_LIST_USER_STRUCT (Entry, IP6_NEIGHBOR_ENTRY, Link);\r
2863\r
2864 switch (NeighborCache->State) {\r
2865 case EfiNeighborInComplete:\r
2866 if (NeighborCache->Ticks > 0) {\r
2867 --NeighborCache->Ticks;\r
2868 }\r
2869\r
2870 //\r
2871 // Retransmit Neighbor Solicitation messages approximately every\r
2872 // RetransTimer milliseconds while awaiting a response.\r
2873 //\r
2874 if (NeighborCache->Ticks == 0) {\r
2875 if (NeighborCache->Transmit > 1) {\r
2876 //\r
2877 // Send out multicast neighbor solicitation for address resolution.\r
2878 // After last neighbor solicitation message has been sent out, wait\r
2879 // for RetransTimer and then remove entry if no response is received.\r
2880 //\r
2881 Ip6CreateSNMulticastAddr (&NeighborCache->Neighbor, &Destination);\r
2882 Status = Ip6SelectSourceAddress (IpSb, &NeighborCache->Neighbor, &Source);\r
2883 if (EFI_ERROR (Status)) {\r
2884 return;\r
2885 }\r
2886\r
2887 Status = Ip6SendNeighborSolicit (\r
2888 IpSb,\r
2889 &Source,\r
2890 &Destination,\r
2891 &NeighborCache->Neighbor,\r
2892 &IpSb->SnpMode.CurrentAddress\r
2893 );\r
2894 if (EFI_ERROR (Status)) {\r
2895 return;\r
2896 }\r
2897 }\r
2898\r
2899 //\r
2900 // Update the retransmit times.\r
2901 //\r
2902 if (NeighborCache->Transmit > 0) {\r
2903 --NeighborCache->Transmit;\r
2904 NeighborCache->Ticks = IP6_GET_TICKS (IpSb->RetransTimer);\r
2905 }\r
2906 }\r
2907\r
2908 if (NeighborCache->Transmit == 0) {\r
2909 //\r
2910 // Timeout, send ICMP destination unreachable packet and then remove entry\r
2911 //\r
2912 Status = Ip6FreeNeighborEntry (\r
2913 IpSb,\r
2914 NeighborCache,\r
2915 TRUE,\r
2916 TRUE,\r
2917 EFI_ICMP_ERROR,\r
2918 NULL,\r
2919 NULL\r
2920 );\r
2921 if (EFI_ERROR (Status)) {\r
2922 return;\r
2923 }\r
2924 }\r
2925\r
2926 break;\r
2927\r
2928 case EfiNeighborReachable:\r
2929 //\r
2930 // This entry is inserted by EfiIp6Neighbors() as static entry\r
2931 // and will not timeout.\r
2932 //\r
2933 if (!NeighborCache->Dynamic && (NeighborCache->Ticks == IP6_INFINIT_LIFETIME)) {\r
2934 break;\r
2935 }\r
2936\r
2937 if ((NeighborCache->Ticks == 0) || (--NeighborCache->Ticks == 0)) {\r
2938 if (NeighborCache->Dynamic) {\r
2939 //\r
2940 // This entry is inserted by EfiIp6Neighbors() as dynamic entry\r
2941 // and will be deleted after timeout.\r
2942 //\r
2943 Status = Ip6FreeNeighborEntry (\r
2944 IpSb,\r
2945 NeighborCache,\r
2946 FALSE,\r
2947 TRUE,\r
2948 EFI_TIMEOUT,\r
2949 NULL,\r
2950 NULL\r
2951 );\r
2952 if (EFI_ERROR (Status)) {\r
2953 return;\r
2954 }\r
2955 } else {\r
2956 NeighborCache->State = EfiNeighborStale;\r
2957 NeighborCache->Ticks = (UINT32) IP6_INFINIT_LIFETIME;\r
2958 }\r
2959 }\r
2960\r
2961 break;\r
2962\r
2963 case EfiNeighborDelay:\r
2964 if ((NeighborCache->Ticks == 0) || (--NeighborCache->Ticks == 0)) {\r
2965\r
2966 NeighborCache->State = EfiNeighborProbe;\r
2967 NeighborCache->Ticks = IP6_GET_TICKS (IpSb->RetransTimer);\r
2968 NeighborCache->Transmit = IP6_MAX_UNICAST_SOLICIT + 1;\r
2969 //\r
2970 // Send out unicast neighbor solicitation for Neighbor Unreachability Detection\r
2971 //\r
2972 Status = Ip6SelectSourceAddress (IpSb, &NeighborCache->Neighbor, &Source);\r
2973 if (EFI_ERROR (Status)) {\r
2974 return;\r
2975 }\r
2976\r
2977 Status = Ip6SendNeighborSolicit (\r
2978 IpSb,\r
2979 &Source,\r
2980 &NeighborCache->Neighbor,\r
2981 &NeighborCache->Neighbor,\r
2982 &IpSb->SnpMode.CurrentAddress\r
2983 );\r
2984 if (EFI_ERROR (Status)) {\r
2985 return;\r
2986 }\r
2987\r
2988 NeighborCache->Transmit--;\r
2989 }\r
2990\r
2991 break;\r
2992\r
2993 case EfiNeighborProbe:\r
2994 if (NeighborCache->Ticks > 0) {\r
2995 --NeighborCache->Ticks;\r
2996 }\r
2997\r
2998 //\r
2999 // Retransmit Neighbor Solicitation messages approximately every\r
3000 // RetransTimer milliseconds while awaiting a response.\r
3001 //\r
3002 if (NeighborCache->Ticks == 0) {\r
3003 if (NeighborCache->Transmit > 1) {\r
3004 //\r
3005 // Send out unicast neighbor solicitation for Neighbor Unreachability\r
3006 // Detection. After last neighbor solicitation message has been sent out,\r
3007 // wait for RetransTimer and then remove entry if no response is received.\r
3008 //\r
3009 Status = Ip6SelectSourceAddress (IpSb, &NeighborCache->Neighbor, &Source);\r
3010 if (EFI_ERROR (Status)) {\r
3011 return;\r
3012 }\r
3013\r
3014 Status = Ip6SendNeighborSolicit (\r
3015 IpSb,\r
3016 &Source,\r
3017 &NeighborCache->Neighbor,\r
3018 &NeighborCache->Neighbor,\r
3019 &IpSb->SnpMode.CurrentAddress\r
3020 );\r
3021 if (EFI_ERROR (Status)) {\r
3022 return;\r
3023 }\r
3024 }\r
3025\r
3026 //\r
3027 // Update the retransmit times.\r
3028 //\r
3029 if (NeighborCache->Transmit > 0) {\r
3030 --NeighborCache->Transmit;\r
3031 NeighborCache->Ticks = IP6_GET_TICKS (IpSb->RetransTimer);\r
3032 }\r
3033 }\r
3034\r
3035 if (NeighborCache->Transmit == 0) {\r
3036 //\r
3037 // Delete the neighbor entry.\r
3038 //\r
3039 Status = Ip6FreeNeighborEntry (\r
3040 IpSb,\r
3041 NeighborCache,\r
3042 FALSE,\r
3043 TRUE,\r
3044 EFI_TIMEOUT,\r
3045 NULL,\r
3046 NULL\r
3047 );\r
3048 if (EFI_ERROR (Status)) {\r
3049 return;\r
3050 }\r
3051 }\r
3052\r
3053 break;\r
3054\r
3055 default:\r
3056 break;\r
3057 }\r
3058 }\r
3059}\r
3060\r
3061/**\r
3062 The heartbeat timer of ND module in 1 second. This time routine handles following\r
3063 things: 1) maitain default router list; 2) maintain prefix options;\r
3064 3) maintain route caches.\r
3065\r
3066 @param[in] IpSb The IP6 service binding instance.\r
3067\r
3068**/\r
3069VOID\r
3070Ip6NdTimerTicking (\r
3071 IN IP6_SERVICE *IpSb\r
3072 )\r
3073{\r
3074 LIST_ENTRY *Entry;\r
3075 LIST_ENTRY *Next;\r
3076 IP6_DEFAULT_ROUTER *DefaultRouter;\r
3077 IP6_PREFIX_LIST_ENTRY *PrefixOption;\r
3078 UINT8 Index;\r
3079 IP6_ROUTE_CACHE_ENTRY *RouteCache;\r
3080\r
3081 //\r
3082 // Decrease the lifetime of default router, if expires remove it from default router list.\r
3083 //\r
3084 NET_LIST_FOR_EACH_SAFE (Entry, Next, &IpSb->DefaultRouterList) {\r
3085 DefaultRouter = NET_LIST_USER_STRUCT (Entry, IP6_DEFAULT_ROUTER, Link);\r
3086 if (DefaultRouter->Lifetime != IP6_INF_ROUTER_LIFETIME) {\r
3087 if ((DefaultRouter->Lifetime == 0) || (--DefaultRouter->Lifetime == 0)) {\r
3088 Ip6DestroyDefaultRouter (IpSb, DefaultRouter);\r
3089 }\r
3090 }\r
3091 }\r
3092\r
3093 //\r
3094 // Decrease Valid lifetime and Preferred lifetime of Prefix options and corresponding addresses.\r
3095 //\r
3096 NET_LIST_FOR_EACH_SAFE (Entry, Next, &IpSb->AutonomousPrefix) {\r
3097 PrefixOption = NET_LIST_USER_STRUCT (Entry, IP6_PREFIX_LIST_ENTRY, Link);\r
3098 if (PrefixOption->ValidLifetime != (UINT32) IP6_INFINIT_LIFETIME) {\r
3099 if ((PrefixOption->ValidLifetime > 0) && (--PrefixOption->ValidLifetime > 0)) {\r
3100 if ((PrefixOption->PreferredLifetime != (UINT32) IP6_INFINIT_LIFETIME) &&\r
3101 (PrefixOption->PreferredLifetime > 0)\r
3102 ) {\r
3103 --PrefixOption->PreferredLifetime;\r
3104 }\r
3105 } else {\r
3106 Ip6DestroyPrefixListEntry (IpSb, PrefixOption, FALSE, TRUE);\r
3107 }\r
3108 }\r
3109 }\r
3110\r
3111 NET_LIST_FOR_EACH_SAFE (Entry, Next, &IpSb->OnlinkPrefix) {\r
3112 PrefixOption = NET_LIST_USER_STRUCT (Entry, IP6_PREFIX_LIST_ENTRY, Link);\r
3113 if (PrefixOption->ValidLifetime != (UINT32) IP6_INFINIT_LIFETIME) {\r
3114 if ((PrefixOption->ValidLifetime == 0) || (--PrefixOption->ValidLifetime == 0)) {\r
3115 Ip6DestroyPrefixListEntry (IpSb, PrefixOption, TRUE, TRUE);\r
3116 }\r
3117 }\r
3118 }\r
3119\r
3120 //\r
3121 // Each bucket of route cache can contain at most IP6_ROUTE_CACHE_MAX entries.\r
3122 // Remove the entries at the tail of the bucket. These entries\r
3123 // are likely to be used least.\r
3124 // Reclaim frequency is set to 1 second.\r
3125 //\r
3126 for (Index = 0; Index < IP6_ROUTE_CACHE_HASH_SIZE; Index++) {\r
3127 while (IpSb->RouteTable->Cache.CacheNum[Index] > IP6_ROUTE_CACHE_MAX) {\r
3128 Entry = NetListRemoveTail (&IpSb->RouteTable->Cache.CacheBucket[Index]);\r
3129 if (Entry == NULL) {\r
3130 break;\r
3131 }\r
3132\r
3133 RouteCache = NET_LIST_USER_STRUCT (Entry, IP6_ROUTE_CACHE_ENTRY, Link);\r
3134 Ip6FreeRouteCacheEntry (RouteCache);\r
3135 ASSERT (IpSb->RouteTable->Cache.CacheNum[Index] > 0);\r
3136 IpSb->RouteTable->Cache.CacheNum[Index]--;\r
3137 }\r
3138 }\r
3139}\r
3140\r
EFI Development Kit II mirror for PVE