]>
Commit | Line | Data |
---|---|---|
a3bcde70 HT |
1 | /** @file\r |
2 | Multicast Listener Discovery support routines.\r | |
3 | \r | |
4 | Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r | |
5 | \r | |
ecf98fbc | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
a3bcde70 HT |
7 | \r |
8 | **/\r | |
9 | \r | |
10 | #include "Ip6Impl.h"\r | |
11 | \r | |
12 | /**\r | |
13 | Create a IP6_MLD_GROUP list entry node and record to IP6 service binding data.\r | |
14 | \r | |
15 | @param[in, out] IpSb Points to IP6 service binding instance.\r | |
16 | @param[in] MulticastAddr The IPv6 multicast address to be recorded.\r | |
17 | @param[in] DelayTimer The maximum allowed delay before sending a responding\r | |
18 | report, in units of milliseconds.\r | |
19 | @return The created IP6_ML_GROUP list entry or NULL.\r | |
20 | \r | |
21 | **/\r | |
22 | IP6_MLD_GROUP *\r | |
23 | Ip6CreateMldEntry (\r | |
24 | IN OUT IP6_SERVICE *IpSb,\r | |
25 | IN EFI_IPv6_ADDRESS *MulticastAddr,\r | |
26 | IN UINT32 DelayTimer\r | |
27 | )\r | |
28 | {\r | |
29 | IP6_MLD_GROUP *Entry;\r | |
30 | \r | |
31 | NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r | |
32 | ASSERT (MulticastAddr != NULL && IP6_IS_MULTICAST (MulticastAddr));\r | |
33 | \r | |
34 | Entry = AllocatePool (sizeof (IP6_MLD_GROUP));\r | |
35 | if (Entry != NULL) {\r | |
36 | Entry->RefCnt = 1;\r | |
37 | Entry->DelayTimer = DelayTimer;\r | |
38 | Entry->SendByUs = FALSE;\r | |
39 | IP6_COPY_ADDRESS (&Entry->Address, MulticastAddr);\r | |
40 | InsertTailList (&IpSb->MldCtrl.Groups, &Entry->Link);\r | |
41 | }\r | |
42 | \r | |
43 | return Entry;\r | |
44 | }\r | |
45 | \r | |
46 | /**\r | |
47 | Search a IP6_MLD_GROUP list entry node from a list array.\r | |
48 | \r | |
49 | @param[in] IpSb Points to IP6 service binding instance.\r | |
50 | @param[in] MulticastAddr The IPv6 multicast address to be searched.\r | |
51 | \r | |
52 | @return The found IP6_ML_GROUP list entry or NULL.\r | |
53 | \r | |
54 | **/\r | |
55 | IP6_MLD_GROUP *\r | |
56 | Ip6FindMldEntry (\r | |
57 | IN IP6_SERVICE *IpSb,\r | |
58 | IN EFI_IPv6_ADDRESS *MulticastAddr\r | |
59 | )\r | |
60 | {\r | |
61 | LIST_ENTRY *Entry;\r | |
62 | IP6_MLD_GROUP *Group;\r | |
63 | \r | |
64 | NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r | |
65 | ASSERT (MulticastAddr != NULL && IP6_IS_MULTICAST (MulticastAddr));\r | |
66 | \r | |
67 | NET_LIST_FOR_EACH (Entry, &IpSb->MldCtrl.Groups) {\r | |
68 | Group = NET_LIST_USER_STRUCT (Entry, IP6_MLD_GROUP, Link);\r | |
69 | if (EFI_IP6_EQUAL (MulticastAddr, &Group->Address)) {\r | |
70 | return Group;\r | |
71 | }\r | |
72 | }\r | |
73 | \r | |
74 | return NULL;\r | |
75 | }\r | |
76 | \r | |
77 | /**\r | |
78 | Count the number of IP6 multicast groups that are mapped to the\r | |
79 | same MAC address. Several IP6 multicast address may be mapped to\r | |
80 | the same MAC address.\r | |
81 | \r | |
82 | @param[in] MldCtrl The MLD control block to search in.\r | |
83 | @param[in] Mac The MAC address to search.\r | |
84 | \r | |
85 | @return The number of the IP6 multicast group that mapped to the same\r | |
86 | multicast group Mac.\r | |
87 | \r | |
88 | **/\r | |
89 | INTN\r | |
90 | Ip6FindMac (\r | |
91 | IN IP6_MLD_SERVICE_DATA *MldCtrl,\r | |
92 | IN EFI_MAC_ADDRESS *Mac\r | |
93 | )\r | |
94 | {\r | |
95 | LIST_ENTRY *Entry;\r | |
96 | IP6_MLD_GROUP *Group;\r | |
97 | INTN Count;\r | |
98 | \r | |
99 | Count = 0;\r | |
100 | \r | |
101 | NET_LIST_FOR_EACH (Entry, &MldCtrl->Groups) {\r | |
102 | Group = NET_LIST_USER_STRUCT (Entry, IP6_MLD_GROUP, Link);\r | |
103 | \r | |
104 | if (NET_MAC_EQUAL (&Group->Mac, Mac, sizeof (EFI_MAC_ADDRESS))) {\r | |
105 | Count++;\r | |
106 | }\r | |
107 | }\r | |
108 | \r | |
109 | return Count;\r | |
110 | }\r | |
111 | \r | |
112 | /**\r | |
113 | Generate MLD report message and send it out to MulticastAddr.\r | |
114 | \r | |
115 | @param[in] IpSb The IP service to send the packet.\r | |
116 | @param[in] Interface The IP interface to send the packet.\r | |
117 | If NULL, a system interface will be selected.\r | |
118 | @param[in] MulticastAddr The specific IPv6 multicast address to which\r | |
119 | the message sender is listening.\r | |
120 | \r | |
121 | @retval EFI_OUT_OF_RESOURCES There are not sufficient resources to complete the\r | |
122 | operation.\r | |
123 | @retval EFI_SUCCESS The MLD report message was successfully sent out.\r | |
124 | \r | |
125 | **/\r | |
126 | EFI_STATUS\r | |
127 | Ip6SendMldReport (\r | |
128 | IN IP6_SERVICE *IpSb,\r | |
129 | IN IP6_INTERFACE *Interface OPTIONAL,\r | |
130 | IN EFI_IPv6_ADDRESS *MulticastAddr\r | |
131 | )\r | |
132 | {\r | |
133 | IP6_MLD_HEAD *MldHead;\r | |
134 | NET_BUF *Packet;\r | |
135 | EFI_IP6_HEADER Head;\r | |
136 | UINT16 PayloadLen;\r | |
137 | UINTN OptionLen;\r | |
138 | UINT8 *Options;\r | |
139 | EFI_STATUS Status;\r | |
140 | UINT16 HeadChecksum;\r | |
141 | UINT16 PseudoChecksum;\r | |
142 | \r | |
143 | NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r | |
144 | ASSERT (MulticastAddr != NULL && IP6_IS_MULTICAST (MulticastAddr));\r | |
145 | \r | |
146 | //\r | |
147 | // Generate the packet to be sent\r | |
148 | // IPv6 basic header + Hop by Hop option + MLD message\r | |
149 | //\r | |
150 | \r | |
151 | OptionLen = 0;\r | |
152 | Status = Ip6FillHopByHop (NULL, &OptionLen, IP6_ICMP);\r | |
153 | ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r | |
154 | \r | |
155 | PayloadLen = (UINT16) (OptionLen + sizeof (IP6_MLD_HEAD));\r | |
156 | Packet = NetbufAlloc (sizeof (EFI_IP6_HEADER) + (UINT32) PayloadLen);\r | |
157 | if (Packet == NULL) {\r | |
158 | return EFI_OUT_OF_RESOURCES;\r | |
159 | }\r | |
160 | \r | |
161 | //\r | |
162 | // Create the basic IPv6 header.\r | |
163 | // RFC3590: Use link-local address as source address if it is available,\r | |
164 | // otherwise use the unspecified address.\r | |
165 | //\r | |
166 | Head.FlowLabelL = 0;\r | |
167 | Head.FlowLabelH = 0;\r | |
168 | Head.PayloadLength = HTONS (PayloadLen);\r | |
169 | Head.NextHeader = IP6_HOP_BY_HOP;\r | |
170 | Head.HopLimit = 1;\r | |
171 | IP6_COPY_ADDRESS (&Head.DestinationAddress, MulticastAddr);\r | |
172 | \r | |
173 | //\r | |
174 | // If Link-Local address is not ready, we use unspecified address.\r | |
175 | //\r | |
176 | IP6_COPY_ADDRESS (&Head.SourceAddress, &IpSb->LinkLocalAddr);\r | |
177 | \r | |
178 | NetbufReserve (Packet, sizeof (EFI_IP6_HEADER));\r | |
179 | \r | |
180 | //\r | |
181 | // Fill a IPv6 Router Alert option in a Hop-by-Hop Options Header\r | |
182 | //\r | |
183 | Options = NetbufAllocSpace (Packet, (UINT32) OptionLen, FALSE);\r | |
184 | ASSERT (Options != NULL);\r | |
185 | Status = Ip6FillHopByHop (Options, &OptionLen, IP6_ICMP);\r | |
186 | if (EFI_ERROR (Status)) {\r | |
187 | NetbufFree (Packet);\r | |
188 | Packet = NULL;\r | |
189 | return Status;\r | |
190 | }\r | |
191 | \r | |
192 | //\r | |
193 | // Fill in MLD message - Report\r | |
194 | //\r | |
195 | MldHead = (IP6_MLD_HEAD *) NetbufAllocSpace (Packet, sizeof (IP6_MLD_HEAD), FALSE);\r | |
196 | ASSERT (MldHead != NULL);\r | |
197 | ZeroMem (MldHead, sizeof (IP6_MLD_HEAD));\r | |
198 | MldHead->Head.Type = ICMP_V6_LISTENER_REPORT;\r | |
199 | MldHead->Head.Code = 0;\r | |
200 | IP6_COPY_ADDRESS (&MldHead->Group, MulticastAddr);\r | |
201 | \r | |
202 | HeadChecksum = NetblockChecksum ((UINT8 *) MldHead, sizeof (IP6_MLD_HEAD));\r | |
203 | PseudoChecksum = NetIp6PseudoHeadChecksum (\r | |
204 | &Head.SourceAddress,\r | |
205 | &Head.DestinationAddress,\r | |
206 | IP6_ICMP,\r | |
207 | sizeof (IP6_MLD_HEAD)\r | |
208 | );\r | |
209 | \r | |
210 | MldHead->Head.Checksum = (UINT16) ~NetAddChecksum (HeadChecksum, PseudoChecksum);\r | |
211 | \r | |
212 | //\r | |
213 | // Transmit the packet\r | |
214 | //\r | |
215 | return Ip6Output (IpSb, Interface, NULL, Packet, &Head, NULL, 0, Ip6SysPacketSent, NULL);\r | |
216 | }\r | |
217 | \r | |
218 | /**\r | |
219 | Generate MLD Done message and send it out to MulticastAddr.\r | |
220 | \r | |
221 | @param[in] IpSb The IP service to send the packet.\r | |
222 | @param[in] MulticastAddr The specific IPv6 multicast address to which\r | |
223 | the message sender is ceasing to listen.\r | |
224 | \r | |
225 | @retval EFI_OUT_OF_RESOURCES There are not sufficient resources to complete the\r | |
226 | operation.\r | |
227 | @retval EFI_SUCCESS The MLD report message was successfully sent out.\r | |
228 | \r | |
229 | **/\r | |
230 | EFI_STATUS\r | |
231 | Ip6SendMldDone (\r | |
232 | IN IP6_SERVICE *IpSb,\r | |
233 | IN EFI_IPv6_ADDRESS *MulticastAddr\r | |
234 | )\r | |
235 | {\r | |
236 | IP6_MLD_HEAD *MldHead;\r | |
237 | NET_BUF *Packet;\r | |
238 | EFI_IP6_HEADER Head;\r | |
239 | UINT16 PayloadLen;\r | |
240 | UINTN OptionLen;\r | |
241 | UINT8 *Options;\r | |
242 | EFI_STATUS Status;\r | |
243 | EFI_IPv6_ADDRESS Destination;\r | |
244 | UINT16 HeadChecksum;\r | |
245 | UINT16 PseudoChecksum;\r | |
246 | \r | |
247 | NET_CHECK_SIGNATURE (IpSb, IP6_SERVICE_SIGNATURE);\r | |
248 | ASSERT (MulticastAddr != NULL && IP6_IS_MULTICAST (MulticastAddr));\r | |
249 | \r | |
250 | //\r | |
251 | // Generate the packet to be sent\r | |
252 | // IPv6 basic header + Hop by Hop option + MLD message\r | |
253 | //\r | |
254 | \r | |
255 | OptionLen = 0;\r | |
256 | Status = Ip6FillHopByHop (NULL, &OptionLen, IP6_ICMP);\r | |
257 | ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r | |
258 | \r | |
259 | PayloadLen = (UINT16) (OptionLen + sizeof (IP6_MLD_HEAD));\r | |
260 | Packet = NetbufAlloc (sizeof (EFI_IP6_HEADER) + (UINT32) PayloadLen);\r | |
261 | if (Packet == NULL) {\r | |
262 | return EFI_OUT_OF_RESOURCES;\r | |
263 | }\r | |
264 | \r | |
265 | //\r | |
266 | // Create the basic IPv6 header.\r | |
267 | //\r | |
268 | Head.FlowLabelL = 0;\r | |
269 | Head.FlowLabelH = 0;\r | |
270 | Head.PayloadLength = HTONS (PayloadLen);\r | |
271 | Head.NextHeader = IP6_HOP_BY_HOP;\r | |
272 | Head.HopLimit = 1;\r | |
273 | \r | |
274 | //\r | |
275 | // If Link-Local address is not ready, we use unspecified address.\r | |
276 | //\r | |
277 | IP6_COPY_ADDRESS (&Head.SourceAddress, &IpSb->LinkLocalAddr);\r | |
278 | \r | |
279 | Ip6SetToAllNodeMulticast (TRUE, IP6_LINK_LOCAL_SCOPE, &Destination);\r | |
280 | IP6_COPY_ADDRESS (&Head.DestinationAddress, &Destination);\r | |
281 | \r | |
282 | NetbufReserve (Packet, sizeof (EFI_IP6_HEADER));\r | |
283 | \r | |
284 | //\r | |
285 | // Fill a IPv6 Router Alert option in a Hop-by-Hop Options Header\r | |
286 | //\r | |
287 | Options = NetbufAllocSpace (Packet, (UINT32) OptionLen, FALSE);\r | |
288 | ASSERT (Options != NULL);\r | |
289 | Status = Ip6FillHopByHop (Options, &OptionLen, IP6_ICMP);\r | |
290 | if (EFI_ERROR (Status)) {\r | |
291 | NetbufFree (Packet);\r | |
292 | Packet = NULL;\r | |
293 | return Status;\r | |
294 | }\r | |
295 | \r | |
296 | //\r | |
297 | // Fill in MLD message - Done\r | |
298 | //\r | |
299 | MldHead = (IP6_MLD_HEAD *) NetbufAllocSpace (Packet, sizeof (IP6_MLD_HEAD), FALSE);\r | |
300 | ASSERT (MldHead != NULL);\r | |
301 | ZeroMem (MldHead, sizeof (IP6_MLD_HEAD));\r | |
302 | MldHead->Head.Type = ICMP_V6_LISTENER_DONE;\r | |
303 | MldHead->Head.Code = 0;\r | |
304 | IP6_COPY_ADDRESS (&MldHead->Group, MulticastAddr);\r | |
305 | \r | |
306 | HeadChecksum = NetblockChecksum ((UINT8 *) MldHead, sizeof (IP6_MLD_HEAD));\r | |
307 | PseudoChecksum = NetIp6PseudoHeadChecksum (\r | |
308 | &Head.SourceAddress,\r | |
309 | &Head.DestinationAddress,\r | |
310 | IP6_ICMP,\r | |
311 | sizeof (IP6_MLD_HEAD)\r | |
312 | );\r | |
313 | \r | |
314 | MldHead->Head.Checksum = (UINT16) ~NetAddChecksum (HeadChecksum, PseudoChecksum);\r | |
315 | \r | |
316 | //\r | |
317 | // Transmit the packet\r | |
318 | //\r | |
319 | return Ip6Output (IpSb, NULL, NULL, Packet, &Head, NULL, 0, Ip6SysPacketSent, NULL);\r | |
320 | }\r | |
321 | \r | |
322 | /**\r | |
323 | Init the MLD data of the IP6 service instance. Configure\r | |
324 | MNP to receive ALL SYSTEM multicast.\r | |
325 | \r | |
326 | @param[in] IpSb The IP6 service whose MLD is to be initialized.\r | |
327 | \r | |
328 | @retval EFI_OUT_OF_RESOURCES There are not sufficient resourcet to complete the\r | |
329 | operation.\r | |
330 | @retval EFI_SUCCESS The MLD module successfully initialized.\r | |
331 | \r | |
332 | **/\r | |
333 | EFI_STATUS\r | |
334 | Ip6InitMld (\r | |
335 | IN IP6_SERVICE *IpSb\r | |
336 | )\r | |
337 | {\r | |
338 | EFI_IPv6_ADDRESS AllNodes;\r | |
339 | IP6_MLD_GROUP *Group;\r | |
340 | EFI_STATUS Status;\r | |
341 | \r | |
342 | //\r | |
343 | // Join the link-scope all-nodes multicast address (FF02::1).\r | |
344 | // This address is started in Idle Listener state and never transitions to\r | |
345 | // another state, and never sends a Report or Done for that address.\r | |
346 | //\r | |
347 | \r | |
348 | Ip6SetToAllNodeMulticast (FALSE, IP6_LINK_LOCAL_SCOPE, &AllNodes);\r | |
349 | \r | |
350 | Group = Ip6CreateMldEntry (IpSb, &AllNodes, (UINT32) IP6_INFINIT_LIFETIME);\r | |
351 | if (Group == NULL) {\r | |
352 | return EFI_OUT_OF_RESOURCES;\r | |
353 | }\r | |
354 | \r | |
355 | Status = Ip6GetMulticastMac (IpSb->Mnp, &AllNodes, &Group->Mac);\r | |
356 | if (EFI_ERROR (Status)) {\r | |
357 | goto ERROR;\r | |
358 | }\r | |
359 | \r | |
360 | //\r | |
361 | // Configure MNP to receive all-nodes multicast\r | |
362 | //\r | |
363 | Status = IpSb->Mnp->Groups (IpSb->Mnp, TRUE, &Group->Mac);\r | |
364 | if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {\r | |
365 | goto ERROR;\r | |
366 | }\r | |
367 | \r | |
368 | return EFI_SUCCESS;\r | |
369 | \r | |
370 | ERROR:\r | |
371 | RemoveEntryList (&Group->Link);\r | |
372 | FreePool (Group);\r | |
373 | return Status;\r | |
374 | }\r | |
375 | \r | |
376 | /**\r | |
377 | Add a group address to the array of group addresses.\r | |
378 | The caller should make sure that no duplicated address\r | |
379 | existed in the array.\r | |
380 | \r | |
381 | @param[in, out] IpInstance Points to an IP6_PROTOCOL instance.\r | |
382 | @param[in] Group The IP6 multicast address to add.\r | |
383 | \r | |
384 | @retval EFI_OUT_OF_RESOURCES There are not sufficient resources to complete\r | |
385 | the operation.\r | |
386 | @retval EFI_SUCESS The address is added to the group address array.\r | |
387 | \r | |
388 | **/\r | |
389 | EFI_STATUS\r | |
390 | Ip6CombineGroups (\r | |
391 | IN OUT IP6_PROTOCOL *IpInstance,\r | |
392 | IN EFI_IPv6_ADDRESS *Group\r | |
393 | )\r | |
394 | {\r | |
395 | EFI_IPv6_ADDRESS *GroupList;\r | |
396 | \r | |
397 | NET_CHECK_SIGNATURE (IpInstance, IP6_PROTOCOL_SIGNATURE);\r | |
398 | ASSERT (Group != NULL && IP6_IS_MULTICAST (Group));\r | |
399 | \r | |
400 | IpInstance->GroupCount++;\r | |
401 | \r | |
402 | GroupList = AllocatePool (IpInstance->GroupCount * sizeof (EFI_IPv6_ADDRESS));\r | |
403 | if (GroupList == NULL) {\r | |
404 | return EFI_OUT_OF_RESOURCES;\r | |
405 | }\r | |
406 | \r | |
407 | if (IpInstance->GroupCount > 1) {\r | |
408 | ASSERT (IpInstance->GroupList != NULL);\r | |
409 | \r | |
410 | CopyMem (\r | |
411 | GroupList,\r | |
412 | IpInstance->GroupList,\r | |
413 | (IpInstance->GroupCount - 1) * sizeof (EFI_IPv6_ADDRESS)\r | |
414 | );\r | |
415 | \r | |
416 | FreePool (IpInstance->GroupList);\r | |
417 | }\r | |
418 | \r | |
419 | IP6_COPY_ADDRESS (GroupList + (IpInstance->GroupCount - 1), Group);\r | |
420 | \r | |
421 | IpInstance->GroupList = GroupList;\r | |
422 | \r | |
423 | return EFI_SUCCESS;\r | |
424 | }\r | |
425 | \r | |
426 | /**\r | |
427 | Remove a group address from the array of group addresses.\r | |
428 | Although the function doesn't assume the byte order of Group,\r | |
429 | the network byte order is used by the caller.\r | |
430 | \r | |
431 | @param[in, out] IpInstance Points to an IP6_PROTOCOL instance.\r | |
432 | @param[in] Group The IP6 multicast address to remove.\r | |
433 | \r | |
434 | @retval EFI_NOT_FOUND Cannot find the to be removed group address.\r | |
435 | @retval EFI_SUCCESS The group address was successfully removed.\r | |
436 | \r | |
437 | **/\r | |
438 | EFI_STATUS\r | |
439 | Ip6RemoveGroup (\r | |
440 | IN OUT IP6_PROTOCOL *IpInstance,\r | |
441 | IN EFI_IPv6_ADDRESS *Group\r | |
442 | )\r | |
443 | {\r | |
444 | UINT32 Index;\r | |
445 | UINT32 Count;\r | |
446 | \r | |
447 | Count = IpInstance->GroupCount;\r | |
448 | \r | |
449 | for (Index = 0; Index < Count; Index++) {\r | |
450 | if (EFI_IP6_EQUAL (IpInstance->GroupList + Index, Group)) {\r | |
451 | break;\r | |
452 | }\r | |
453 | }\r | |
454 | \r | |
455 | if (Index == Count) {\r | |
456 | return EFI_NOT_FOUND;\r | |
457 | }\r | |
458 | \r | |
459 | while (Index < Count - 1) {\r | |
460 | IP6_COPY_ADDRESS (IpInstance->GroupList + Index, IpInstance->GroupList + Index + 1);\r | |
461 | Index++;\r | |
462 | }\r | |
463 | \r | |
464 | ASSERT (IpInstance->GroupCount > 0);\r | |
465 | IpInstance->GroupCount--;\r | |
466 | \r | |
467 | return EFI_SUCCESS;\r | |
468 | }\r | |
469 | \r | |
470 | /**\r | |
471 | Join the multicast group on behalf of this IP6 service binding instance.\r | |
472 | \r | |
473 | @param[in] IpSb The IP6 service binding instance.\r | |
474 | @param[in] Interface Points to an IP6_INTERFACE structure.\r | |
475 | @param[in] Address The group address to join.\r | |
476 | \r | |
477 | @retval EFI_SUCCESS Successfully join the multicast group.\r | |
478 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r | |
479 | @retval Others Failed to join the multicast group.\r | |
480 | \r | |
481 | **/\r | |
482 | EFI_STATUS\r | |
483 | Ip6JoinGroup (\r | |
484 | IN IP6_SERVICE *IpSb,\r | |
485 | IN IP6_INTERFACE *Interface,\r | |
486 | IN EFI_IPv6_ADDRESS *Address\r | |
487 | )\r | |
488 | {\r | |
489 | IP6_MLD_GROUP *Group;\r | |
490 | EFI_STATUS Status;\r | |
491 | \r | |
492 | Group = Ip6FindMldEntry (IpSb, Address);\r | |
493 | if (Group != NULL) {\r | |
494 | Group->RefCnt++;\r | |
495 | return EFI_SUCCESS;\r | |
496 | }\r | |
497 | \r | |
498 | //\r | |
499 | // Repeat the report once or twcie after short delays [Unsolicited Report Interval] (default:10s)\r | |
500 | // Simulate this operation as a Multicast-Address-Specific Query was received for that addresss.\r | |
501 | //\r | |
502 | Group = Ip6CreateMldEntry (IpSb, Address, IP6_UNSOLICITED_REPORT_INTERVAL);\r | |
503 | if (Group == NULL) {\r | |
504 | return EFI_OUT_OF_RESOURCES;\r | |
505 | }\r | |
506 | \r | |
507 | Group->SendByUs = TRUE;\r | |
508 | \r | |
509 | Status = Ip6GetMulticastMac (IpSb->Mnp, Address, &Group->Mac);\r | |
510 | if (EFI_ERROR (Status)) {\r | |
511 | return Status;\r | |
512 | }\r | |
513 | \r | |
514 | Status = IpSb->Mnp->Groups (IpSb->Mnp, TRUE, &Group->Mac);\r | |
515 | if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {\r | |
516 | goto ERROR;\r | |
517 | }\r | |
518 | \r | |
519 | //\r | |
520 | // Send unsolicited report when a node starts listening to a multicast address\r | |
521 | //\r | |
522 | Status = Ip6SendMldReport (IpSb, Interface, Address);\r | |
523 | if (EFI_ERROR (Status)) {\r | |
524 | goto ERROR;\r | |
525 | }\r | |
526 | \r | |
527 | return EFI_SUCCESS;\r | |
528 | \r | |
529 | ERROR:\r | |
530 | RemoveEntryList (&Group->Link);\r | |
531 | FreePool (Group);\r | |
532 | return Status;\r | |
533 | }\r | |
534 | \r | |
535 | /**\r | |
536 | Leave the IP6 multicast group.\r | |
537 | \r | |
538 | @param[in] IpSb The IP6 service binding instance.\r | |
539 | @param[in] Address The group address to leave.\r | |
540 | \r | |
541 | @retval EFI_NOT_FOUND The IP6 service instance isn't in the group.\r | |
542 | @retval EFI_SUCCESS Successfully leave the multicast group..\r | |
543 | @retval Others Failed to leave the multicast group.\r | |
544 | \r | |
545 | **/\r | |
546 | EFI_STATUS\r | |
547 | Ip6LeaveGroup (\r | |
548 | IN IP6_SERVICE *IpSb,\r | |
549 | IN EFI_IPv6_ADDRESS *Address\r | |
550 | )\r | |
551 | {\r | |
552 | IP6_MLD_GROUP *Group;\r | |
553 | EFI_STATUS Status;\r | |
554 | \r | |
555 | Group = Ip6FindMldEntry (IpSb, Address);\r | |
556 | if (Group == NULL) {\r | |
557 | return EFI_NOT_FOUND;\r | |
558 | }\r | |
559 | \r | |
560 | //\r | |
561 | // If more than one instance is in the group, decrease\r | |
562 | // the RefCnt then return.\r | |
563 | //\r | |
564 | if ((Group->RefCnt > 0) && (--Group->RefCnt > 0)) {\r | |
565 | return EFI_SUCCESS;\r | |
566 | }\r | |
567 | \r | |
568 | //\r | |
569 | // If multiple IP6 group addresses are mapped to the same\r | |
570 | // multicast MAC address, don't configure the MNP to leave\r | |
571 | // the MAC.\r | |
572 | //\r | |
573 | if (Ip6FindMac (&IpSb->MldCtrl, &Group->Mac) == 1) {\r | |
574 | Status = IpSb->Mnp->Groups (IpSb->Mnp, FALSE, &Group->Mac);\r | |
575 | if (EFI_ERROR (Status) && (Status != EFI_NOT_FOUND)) {\r | |
576 | return Status;\r | |
577 | }\r | |
578 | }\r | |
579 | \r | |
580 | //\r | |
581 | // Send a leave report if we are the last node to report\r | |
582 | //\r | |
583 | if (Group->SendByUs) {\r | |
584 | Status = Ip6SendMldDone (IpSb, Address);\r | |
585 | if (EFI_ERROR (Status)) {\r | |
586 | return Status;\r | |
587 | }\r | |
588 | }\r | |
589 | \r | |
590 | RemoveEntryList (&Group->Link);\r | |
591 | FreePool (Group);\r | |
592 | \r | |
593 | return EFI_SUCCESS;\r | |
594 | }\r | |
595 | \r | |
596 | /**\r | |
597 | Worker function for EfiIp6Groups(). The caller\r | |
598 | should make sure that the parameters are valid.\r | |
599 | \r | |
600 | @param[in] IpInstance The IP6 child to change the setting.\r | |
601 | @param[in] JoinFlag TRUE to join the group, otherwise leave it.\r | |
602 | @param[in] GroupAddress The target group address. If NULL, leave all\r | |
603 | the group addresses.\r | |
604 | \r | |
605 | @retval EFI_ALREADY_STARTED Wants to join the group, but is already a member of it\r | |
606 | @retval EFI_OUT_OF_RESOURCES Failed to allocate sufficient resources.\r | |
607 | @retval EFI_DEVICE_ERROR Failed to set the group configuraton.\r | |
608 | @retval EFI_SUCCESS Successfully updated the group setting.\r | |
609 | @retval EFI_NOT_FOUND Try to leave the group which it isn't a member.\r | |
610 | \r | |
611 | **/\r | |
612 | EFI_STATUS\r | |
613 | Ip6Groups (\r | |
614 | IN IP6_PROTOCOL *IpInstance,\r | |
615 | IN BOOLEAN JoinFlag,\r | |
616 | IN EFI_IPv6_ADDRESS *GroupAddress OPTIONAL\r | |
617 | )\r | |
618 | {\r | |
619 | EFI_STATUS Status;\r | |
620 | IP6_SERVICE *IpSb;\r | |
621 | UINT32 Index;\r | |
622 | EFI_IPv6_ADDRESS *Group;\r | |
623 | \r | |
624 | IpSb = IpInstance->Service;\r | |
625 | \r | |
626 | if (JoinFlag) {\r | |
627 | ASSERT (GroupAddress != NULL);\r | |
628 | \r | |
629 | for (Index = 0; Index < IpInstance->GroupCount; Index++) {\r | |
630 | if (EFI_IP6_EQUAL (IpInstance->GroupList + Index, GroupAddress)) {\r | |
631 | return EFI_ALREADY_STARTED;\r | |
632 | }\r | |
633 | }\r | |
634 | \r | |
635 | Status = Ip6JoinGroup (IpSb, IpInstance->Interface, GroupAddress);\r | |
636 | if (!EFI_ERROR (Status)) {\r | |
637 | return Ip6CombineGroups (IpInstance, GroupAddress);\r | |
638 | }\r | |
639 | \r | |
640 | return Status;\r | |
641 | }\r | |
642 | \r | |
643 | //\r | |
644 | // Leave the group. Leave all the groups if GroupAddress is NULL.\r | |
645 | //\r | |
646 | for (Index = IpInstance->GroupCount; Index > 0; Index--) {\r | |
647 | Group = IpInstance->GroupList + (Index - 1);\r | |
648 | \r | |
649 | if ((GroupAddress == NULL) || EFI_IP6_EQUAL (Group, GroupAddress)) {\r | |
650 | Status = Ip6LeaveGroup (IpInstance->Service, Group);\r | |
651 | if (EFI_ERROR (Status)) {\r | |
652 | return Status;\r | |
653 | }\r | |
654 | \r | |
655 | Ip6RemoveGroup (IpInstance, Group);\r | |
656 | \r | |
657 | if (IpInstance->GroupCount == 0) {\r | |
658 | ASSERT (Index == 1);\r | |
659 | FreePool (IpInstance->GroupList);\r | |
660 | IpInstance->GroupList = NULL;\r | |
661 | }\r | |
662 | \r | |
663 | if (GroupAddress != NULL) {\r | |
664 | return EFI_SUCCESS;\r | |
665 | }\r | |
666 | }\r | |
667 | }\r | |
668 | \r | |
669 | return ((GroupAddress != NULL) ? EFI_NOT_FOUND : EFI_SUCCESS);\r | |
670 | }\r | |
671 | \r | |
672 | /**\r | |
673 | Set a random value of the delay timer for the multicast address from the range\r | |
674 | [0, Maximum Response Delay]. If a timer for any address is already\r | |
675 | running, it is reset to the new random value only if the requested\r | |
676 | Maximum Response Delay is less than the remaining value of the\r | |
677 | running timer. If the Query packet specifies a Maximum Response\r | |
678 | Delay of zero, each timer is effectively set to zero, and the action\r | |
679 | specified below for timer expiration is performed immediately.\r | |
680 | \r | |
681 | @param[in] IpSb The IP6 service binding instance.\r | |
682 | @param[in] MaxRespDelay The Maximum Response Delay, in milliseconds.\r | |
683 | @param[in] MulticastAddr The multicast address.\r | |
684 | @param[in, out] Group Points to a IP6_MLD_GROUP list entry node.\r | |
685 | \r | |
686 | @retval EFI_SUCCESS The delay timer is successfully updated or\r | |
687 | timer expiration is performed immediately.\r | |
688 | @retval Others Failed to send out MLD report message.\r | |
689 | \r | |
690 | **/\r | |
691 | EFI_STATUS\r | |
692 | Ip6UpdateDelayTimer (\r | |
693 | IN IP6_SERVICE *IpSb,\r | |
694 | IN UINT16 MaxRespDelay,\r | |
695 | IN EFI_IPv6_ADDRESS *MulticastAddr,\r | |
696 | IN OUT IP6_MLD_GROUP *Group\r | |
697 | )\r | |
698 | {\r | |
699 | UINT32 Delay;\r | |
700 | \r | |
701 | //\r | |
702 | // If the Query packet specifies a Maximum Response Delay of zero, perform timer\r | |
703 | // expiration immediately.\r | |
704 | //\r | |
705 | if (MaxRespDelay == 0) {\r | |
706 | Group->DelayTimer = 0;\r | |
707 | return Ip6SendMldReport (IpSb, NULL, MulticastAddr);\r | |
708 | }\r | |
709 | \r | |
710 | Delay = (UINT32) (MaxRespDelay / 1000);\r | |
711 | \r | |
712 | //\r | |
713 | // Sets a delay timer to a random value selected from the range [0, Maximum Response Delay]\r | |
714 | // If a timer is already running, resets it if the request Maximum Response Delay\r | |
715 | // is less than the remaining value of the running timer.\r | |
716 | //\r | |
717 | if (Group->DelayTimer == 0 || Delay < Group->DelayTimer) {\r | |
718 | Group->DelayTimer = Delay / 4294967295UL * NET_RANDOM (NetRandomInitSeed ());\r | |
719 | }\r | |
720 | \r | |
721 | return EFI_SUCCESS;\r | |
722 | }\r | |
723 | \r | |
724 | /**\r | |
725 | Process the Multicast Listener Query message.\r | |
726 | \r | |
727 | @param[in] IpSb The IP service that received the packet.\r | |
728 | @param[in] Head The IP head of the MLD query packet.\r | |
729 | @param[in] Packet The content of the MLD query packet with IP head\r | |
730 | removed.\r | |
731 | \r | |
732 | @retval EFI_SUCCESS The MLD query packet processed successfully.\r | |
733 | @retval EFI_INVALID_PARAMETER The packet is invalid.\r | |
734 | @retval Others Failed to process the packet.\r | |
735 | \r | |
736 | **/\r | |
737 | EFI_STATUS\r | |
738 | Ip6ProcessMldQuery (\r | |
739 | IN IP6_SERVICE *IpSb,\r | |
740 | IN EFI_IP6_HEADER *Head,\r | |
741 | IN NET_BUF *Packet\r | |
742 | )\r | |
743 | {\r | |
744 | EFI_IPv6_ADDRESS AllNodes;\r | |
745 | IP6_MLD_GROUP *Group;\r | |
746 | IP6_MLD_HEAD MldPacket;\r | |
747 | LIST_ENTRY *Entry;\r | |
748 | EFI_STATUS Status;\r | |
749 | \r | |
750 | Status = EFI_INVALID_PARAMETER;\r | |
751 | \r | |
752 | //\r | |
753 | // Check the validity of the packet, generic query or specific query\r | |
754 | //\r | |
755 | if (!NetIp6IsUnspecifiedAddr (&Head->SourceAddress) && !NetIp6IsLinkLocalAddr (&Head->SourceAddress)) {\r | |
756 | goto Exit;\r | |
757 | }\r | |
758 | \r | |
759 | if (Head->HopLimit != 1 || !IP6_IS_MULTICAST (&Head->DestinationAddress)) {\r | |
760 | goto Exit;\r | |
761 | }\r | |
762 | \r | |
763 | //\r | |
764 | // The Packet points to MLD report raw data without Hop-By-Hop option.\r | |
765 | //\r | |
766 | NetbufCopy (Packet, 0, sizeof (IP6_MLD_HEAD), (UINT8 *) &MldPacket);\r | |
767 | MldPacket.MaxRespDelay = NTOHS (MldPacket.MaxRespDelay);\r | |
768 | \r | |
769 | Ip6SetToAllNodeMulticast (FALSE, IP6_LINK_LOCAL_SCOPE, &AllNodes);\r | |
770 | if (!EFI_IP6_EQUAL (&Head->DestinationAddress, &AllNodes)) {\r | |
771 | //\r | |
772 | // Receives a Multicast-Address-Specific Query, check it firstly\r | |
773 | //\r | |
774 | if (!EFI_IP6_EQUAL (&Head->DestinationAddress, &MldPacket.Group)) {\r | |
775 | goto Exit;\r | |
776 | }\r | |
777 | //\r | |
778 | // The node is not listening but it receives the specific query. Just return.\r | |
779 | //\r | |
780 | Group = Ip6FindMldEntry (IpSb, &MldPacket.Group);\r | |
781 | if (Group == NULL) {\r | |
782 | Status = EFI_SUCCESS;\r | |
783 | goto Exit;\r | |
784 | }\r | |
785 | \r | |
786 | Status = Ip6UpdateDelayTimer (\r | |
787 | IpSb,\r | |
788 | MldPacket.MaxRespDelay,\r | |
789 | &MldPacket.Group,\r | |
790 | Group\r | |
791 | );\r | |
792 | goto Exit;\r | |
793 | }\r | |
794 | \r | |
795 | //\r | |
796 | // Receives a General Query, sets a delay timer for each multicast address it is listening\r | |
797 | //\r | |
798 | NET_LIST_FOR_EACH (Entry, &IpSb->MldCtrl.Groups) {\r | |
799 | Group = NET_LIST_USER_STRUCT (Entry, IP6_MLD_GROUP, Link);\r | |
800 | Status = Ip6UpdateDelayTimer (IpSb, MldPacket.MaxRespDelay, &Group->Address, Group);\r | |
801 | if (EFI_ERROR (Status)) {\r | |
802 | goto Exit;\r | |
803 | }\r | |
804 | }\r | |
805 | \r | |
806 | Status = EFI_SUCCESS;\r | |
807 | \r | |
808 | Exit:\r | |
809 | NetbufFree (Packet);\r | |
810 | return Status;\r | |
811 | }\r | |
812 | \r | |
813 | /**\r | |
814 | Process the Multicast Listener Report message.\r | |
815 | \r | |
816 | @param[in] IpSb The IP service that received the packet.\r | |
817 | @param[in] Head The IP head of the MLD report packet.\r | |
818 | @param[in] Packet The content of the MLD report packet with IP head\r | |
819 | removed.\r | |
820 | \r | |
821 | @retval EFI_SUCCESS The MLD report packet processed successfully.\r | |
822 | @retval EFI_INVALID_PARAMETER The packet is invalid.\r | |
823 | \r | |
824 | **/\r | |
825 | EFI_STATUS\r | |
826 | Ip6ProcessMldReport (\r | |
827 | IN IP6_SERVICE *IpSb,\r | |
828 | IN EFI_IP6_HEADER *Head,\r | |
829 | IN NET_BUF *Packet\r | |
830 | )\r | |
831 | {\r | |
832 | IP6_MLD_HEAD MldPacket;\r | |
833 | IP6_MLD_GROUP *Group;\r | |
834 | EFI_STATUS Status;\r | |
835 | \r | |
836 | Status = EFI_INVALID_PARAMETER;\r | |
837 | \r | |
838 | //\r | |
839 | // Validate the incoming message, if invalid, drop it.\r | |
840 | //\r | |
841 | if (!NetIp6IsUnspecifiedAddr (&Head->SourceAddress) && !NetIp6IsLinkLocalAddr (&Head->SourceAddress)) {\r | |
842 | goto Exit;\r | |
843 | }\r | |
844 | \r | |
845 | if (Head->HopLimit != 1 || !IP6_IS_MULTICAST (&Head->DestinationAddress)) {\r | |
846 | goto Exit;\r | |
847 | }\r | |
848 | \r | |
849 | //\r | |
850 | // The Packet points to MLD report raw data without Hop-By-Hop option.\r | |
851 | //\r | |
852 | NetbufCopy (Packet, 0, sizeof (IP6_MLD_HEAD), (UINT8 *) &MldPacket);\r | |
853 | if (!EFI_IP6_EQUAL (&Head->DestinationAddress, &MldPacket.Group)) {\r | |
854 | goto Exit;\r | |
855 | }\r | |
856 | \r | |
857 | Group = Ip6FindMldEntry (IpSb, &MldPacket.Group);\r | |
858 | if (Group == NULL) {\r | |
859 | goto Exit;\r | |
860 | }\r | |
861 | \r | |
862 | //\r | |
863 | // The report is sent by another node, stop its own timer relates to the multicast address and clear\r | |
864 | //\r | |
865 | \r | |
866 | if (!Group->SendByUs) {\r | |
867 | Group->DelayTimer = 0;\r | |
868 | }\r | |
869 | \r | |
870 | Status = EFI_SUCCESS;\r | |
871 | \r | |
872 | Exit:\r | |
873 | NetbufFree (Packet);\r | |
874 | return Status;\r | |
875 | }\r | |
876 | \r | |
877 | /**\r | |
878 | The heartbeat timer of MLD module. It sends out a solicited MLD report when\r | |
879 | DelayTimer expires.\r | |
880 | \r | |
881 | @param[in] IpSb The IP6 service binding instance.\r | |
882 | \r | |
883 | **/\r | |
884 | VOID\r | |
885 | Ip6MldTimerTicking (\r | |
886 | IN IP6_SERVICE *IpSb\r | |
887 | )\r | |
888 | {\r | |
889 | IP6_MLD_GROUP *Group;\r | |
890 | LIST_ENTRY *Entry;\r | |
891 | \r | |
892 | //\r | |
893 | // Send solicited report when timer expires\r | |
894 | //\r | |
895 | NET_LIST_FOR_EACH (Entry, &IpSb->MldCtrl.Groups) {\r | |
896 | Group = NET_LIST_USER_STRUCT (Entry, IP6_MLD_GROUP, Link);\r | |
897 | if ((Group->DelayTimer > 0) && (--Group->DelayTimer == 0)) {\r | |
898 | Ip6SendMldReport (IpSb, NULL, &Group->Address);\r | |
899 | }\r | |
900 | }\r | |
901 | }\r | |
902 | \r |