1. Sync the latest network stack. Add NetLibCreateIPv4DPathNode () in netlib library.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Udp4Dxe / Udp4Impl.c
1 /** @file
2
3 Copyright (c) 2006 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 Module Name:
13
14 Udp4Impl.c
15
16 Abstract:
17
18 The implementation of the Udp4 protocol.
19
20
21 **/
22
23
24 #include "Udp4Impl.h"
25
26 UINT16 mUdp4RandomPort;
27
28 STATIC
29 VOID
30 EFIAPI
31 Udp4CheckTimeout (
32 IN EFI_EVENT Event,
33 IN VOID *Context
34 );
35
36 STATIC
37 BOOLEAN
38 Udp4FindInstanceByPort (
39 IN NET_LIST_ENTRY *InstanceList,
40 IN EFI_IPv4_ADDRESS *Address,
41 IN UINT16 Port
42 );
43
44 STATIC
45 VOID
46 Udp4DgramSent (
47 IN EFI_STATUS Status,
48 IN VOID *Context,
49 IN VOID *Sender,
50 IN VOID *NotifyData
51 );
52
53 STATIC
54 VOID
55 Udp4DgramRcvd (
56 IN EFI_STATUS Status,
57 IN ICMP_ERROR IcmpError,
58 IN EFI_NET_SESSION_DATA *NetSession,
59 IN NET_BUF *Packet,
60 IN VOID *Context
61 );
62
63 STATIC
64 EFI_STATUS
65 Udp4CancelTokens (
66 IN NET_MAP *Map,
67 IN NET_MAP_ITEM *Item,
68 IN VOID *Arg OPTIONAL
69 );
70
71 STATIC
72 BOOLEAN
73 Udp4MatchDgram (
74 IN UDP4_INSTANCE_DATA *Instance,
75 IN EFI_UDP4_SESSION_DATA *Udp4Session
76 );
77
78 STATIC
79 VOID
80 EFIAPI
81 Udp4RecycleRxDataWrap (
82 IN EFI_EVENT Event,
83 IN VOID *Context
84 );
85
86 STATIC
87 UDP4_RXDATA_WRAP *
88 Udp4WrapRxData (
89 IN UDP4_INSTANCE_DATA *Instance,
90 IN NET_BUF *Packet,
91 IN EFI_UDP4_RECEIVE_DATA *RxData
92 );
93
94 STATIC
95 UINTN
96 Udp4EnqueueDgram (
97 IN UDP4_SERVICE_DATA *Udp4Service,
98 IN NET_BUF *Packet,
99 IN EFI_UDP4_RECEIVE_DATA *RxData
100 );
101
102 STATIC
103 VOID
104 Udp4DeliverDgram (
105 IN UDP4_SERVICE_DATA *Udp4Service
106 );
107
108 STATIC
109 VOID
110 Udp4Demultiplex (
111 IN UDP4_SERVICE_DATA *Udp4Service,
112 IN EFI_NET_SESSION_DATA *NetSession,
113 IN NET_BUF *Packet
114 );
115
116 STATIC
117 VOID
118 Udp4IcmpHandler (
119 IN UDP4_SERVICE_DATA *Udp4Service,
120 IN ICMP_ERROR IcmpError,
121 IN EFI_NET_SESSION_DATA *NetSession,
122 IN NET_BUF *Packet
123 );
124
125 STATIC
126 VOID
127 Udp4SendPortUnreach (
128 IN IP_IO *IpIo,
129 IN EFI_NET_SESSION_DATA *NetSession,
130 IN VOID *Udp4Header
131 );
132
133
134 /**
135 Create the Udp service context data.
136
137 @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
138 @param ImageHandle The image handle of this udp4 driver.
139 @param ControllerHandle The controller handle this udp4 driver binds on.
140
141 @retval EFI_SUCCESS The udp4 service context data is created and
142 initialized.
143 @retval EFI_OUT_OF_RESOURCES Cannot allocate memory.
144
145 **/
146 EFI_STATUS
147 Udp4CreateService (
148 IN UDP4_SERVICE_DATA *Udp4Service,
149 IN EFI_HANDLE ImageHandle,
150 IN EFI_HANDLE ControllerHandle
151 )
152 {
153 EFI_STATUS Status;
154 IP_IO_OPEN_DATA OpenData;
155
156 Udp4Service->Signature = UDP4_SERVICE_DATA_SIGNATURE;
157 Udp4Service->ServiceBinding = mUdp4ServiceBinding;
158 Udp4Service->ImageHandle = ImageHandle;
159 Udp4Service->ControllerHandle = ControllerHandle;
160 Udp4Service->ChildrenNumber = 0;
161
162 NetListInit (&Udp4Service->ChildrenList);
163
164 //
165 // Create the IpIo for this service context.
166 //
167 Udp4Service->IpIo = IpIoCreate (ImageHandle, ControllerHandle);
168 if (Udp4Service->IpIo == NULL) {
169 return EFI_OUT_OF_RESOURCES;
170 }
171
172 //
173 // Set the OpenData used to open the IpIo.
174 //
175 CopyMem (&OpenData.IpConfigData, &mIpIoDefaultIpConfigData, sizeof (OpenData.IpConfigData));
176 OpenData.IpConfigData.AcceptBroadcast = TRUE;
177 OpenData.RcvdContext = (VOID *) Udp4Service;
178 OpenData.SndContext = NULL;
179 OpenData.PktRcvdNotify = Udp4DgramRcvd;
180 OpenData.PktSentNotify = Udp4DgramSent;
181
182 //
183 // Configure and start the IpIo.
184 //
185 Status = IpIoOpen (Udp4Service->IpIo, &OpenData);
186 if (EFI_ERROR (Status)) {
187 goto RELEASE_IPIO;
188 }
189
190 //
191 // Create the event for Udp timeout checking.
192 //
193 Status = gBS->CreateEvent (
194 EVT_TIMER | EVT_NOTIFY_SIGNAL,
195 NET_TPL_FAST_TIMER,
196 Udp4CheckTimeout,
197 Udp4Service,
198 &Udp4Service->TimeoutEvent
199 );
200 if (EFI_ERROR (Status)) {
201 goto RELEASE_IPIO;
202 }
203
204 //
205 // Start the timeout timer event.
206 //
207 Status = gBS->SetTimer (
208 Udp4Service->TimeoutEvent,
209 TimerPeriodic,
210 UDP4_TIMEOUT_INTERVAL
211 );
212 if (EFI_ERROR (Status)) {
213 goto RELEASE_ALL;
214 }
215
216 Udp4Service->MacString = NULL;
217
218 return EFI_SUCCESS;
219
220 RELEASE_ALL:
221
222 gBS->CloseEvent (Udp4Service->TimeoutEvent);
223
224 RELEASE_IPIO:
225
226 IpIoDestroy (Udp4Service->IpIo);
227
228 return Status;
229 }
230
231
232 /**
233 Clean the Udp service context data.
234
235 @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
236
237 @return None.
238
239 **/
240 VOID
241 Udp4CleanService (
242 IN UDP4_SERVICE_DATA *Udp4Service
243 )
244 {
245 //
246 // Cancel the TimeoutEvent timer.
247 //
248 gBS->SetTimer (Udp4Service->TimeoutEvent, TimerCancel, 0);
249
250 //
251 // Close the TimeoutEvent timer.
252 //
253 gBS->CloseEvent (Udp4Service->TimeoutEvent);
254
255 //
256 // Destroy the IpIo.
257 //
258 IpIoDestroy (Udp4Service->IpIo);
259 }
260
261
262 /**
263 This function checks and timeouts the I/O datagrams holding by the corresponding
264 service context.
265
266 @param Event The event this function registered to.
267 @param Conext The context data registered during the creation of
268 the Event.
269
270 @return None.
271
272 **/
273 STATIC
274 VOID
275 EFIAPI
276 Udp4CheckTimeout (
277 IN EFI_EVENT Event,
278 IN VOID *Context
279 )
280 {
281 UDP4_SERVICE_DATA *Udp4Service;
282 NET_LIST_ENTRY *Entry;
283 UDP4_INSTANCE_DATA *Instance;
284 NET_LIST_ENTRY *WrapEntry;
285 NET_LIST_ENTRY *NextEntry;
286 UDP4_RXDATA_WRAP *Wrap;
287
288 Udp4Service = (UDP4_SERVICE_DATA *) Context;
289 NET_CHECK_SIGNATURE (Udp4Service, UDP4_SERVICE_DATA_SIGNATURE);
290
291 NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) {
292 //
293 // Iterate all the instances belonging to this service context.
294 //
295 Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link);
296 NET_CHECK_SIGNATURE (Instance, UDP4_INSTANCE_DATA_SIGNATURE);
297
298 if (!Instance->Configured || (Instance->ConfigData.ReceiveTimeout == 0)) {
299 //
300 // Skip this instance if it's not configured or no receive timeout.
301 //
302 continue;
303 }
304
305 NET_LIST_FOR_EACH_SAFE (WrapEntry, NextEntry, &Instance->RcvdDgramQue) {
306 //
307 // Iterate all the rxdatas belonging to this udp instance.
308 //
309 Wrap = NET_LIST_USER_STRUCT (Entry, UDP4_RXDATA_WRAP, Link);
310
311 if (Wrap->TimeoutTick <= UDP4_TIMEOUT_INTERVAL / 1000) {
312 //
313 // Remove this RxData if it timeouts.
314 //
315 Udp4RecycleRxDataWrap (NULL, (VOID *) Wrap);
316 } else {
317 Wrap->TimeoutTick -= UDP4_TIMEOUT_INTERVAL / 1000;
318 }
319 }
320 }
321 }
322
323
324 /**
325 This function intializes the new created udp instance.
326
327 @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
328 @param Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.
329
330 @return None.
331
332 **/
333 VOID
334 Udp4InitInstance (
335 IN UDP4_SERVICE_DATA *Udp4Service,
336 IN UDP4_INSTANCE_DATA *Instance
337 )
338 {
339 //
340 // Set the signature.
341 //
342 Instance->Signature = UDP4_INSTANCE_DATA_SIGNATURE;
343
344 //
345 // Init the lists.
346 //
347 NetListInit (&Instance->Link);
348 NetListInit (&Instance->RcvdDgramQue);
349 NetListInit (&Instance->DeliveredDgramQue);
350
351 //
352 // Init the NET_MAPs.
353 //
354 NetMapInit (&Instance->TxTokens);
355 NetMapInit (&Instance->RxTokens);
356 NetMapInit (&Instance->McastIps);
357
358 //
359 // Save the pointer to the UDP4_SERVICE_DATA, and initialize other members.
360 //
361 Instance->Udp4Service = Udp4Service;
362 CopyMem (&Instance->Udp4Proto, &mUdp4Protocol, sizeof (Instance->Udp4Proto));
363 Instance->IcmpError = EFI_SUCCESS;
364 Instance->Configured = FALSE;
365 Instance->IsNoMapping = FALSE;
366 Instance->Destroyed = FALSE;
367 }
368
369
370 /**
371 This function cleans the udp instance.
372
373 @param Instance Pointer to the UDP4_INSTANCE_DATA to clean.
374
375 @return None.
376
377 **/
378 VOID
379 Udp4CleanInstance (
380 IN UDP4_INSTANCE_DATA *Instance
381 )
382 {
383 NetMapClean (&Instance->McastIps);
384 NetMapClean (&Instance->RxTokens);
385 NetMapClean (&Instance->TxTokens);
386 }
387
388
389 /**
390 This function finds the udp instance by the specified <Address, Port> pair.
391
392 @param InstanceList Pointer to the head of the list linking the udp
393 instances.
394 @param Address Pointer to the specified IPv4 address.
395 @param Port The udp port number.
396
397 @return Is the specified <Address, Port> pair found or not.
398
399 **/
400 STATIC
401 BOOLEAN
402 Udp4FindInstanceByPort (
403 IN NET_LIST_ENTRY *InstanceList,
404 IN EFI_IPv4_ADDRESS *Address,
405 IN UINT16 Port
406 )
407 {
408 NET_LIST_ENTRY *Entry;
409 UDP4_INSTANCE_DATA *Instance;
410 EFI_UDP4_CONFIG_DATA *ConfigData;
411
412 NET_LIST_FOR_EACH (Entry, InstanceList) {
413 //
414 // Iterate all the udp instances.
415 //
416 Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link);
417 ConfigData = &Instance->ConfigData;
418
419 if (!Instance->Configured || ConfigData->AcceptAnyPort) {
420 //
421 // If the instance is not configured or the configdata of the instance indicates
422 // this instance accepts any port, skip it.
423 //
424 continue;
425 }
426
427 if (EFI_IP4_EQUAL (&ConfigData->StationAddress, Address) &&
428 (ConfigData->StationPort == Port)) {
429 //
430 // if both the address and the port are the same, return TRUE.
431 //
432 return TRUE;
433 }
434 }
435
436 //
437 // return FALSE when matching fails.
438 //
439 return FALSE;
440 }
441
442
443 /**
444 This function tries to bind the udp instance according to the configured port
445 allocation stragety.
446
447 @param InstanceList Pointer to the head of the list linking the udp
448 instances.
449 @param ConfigData Pointer to the ConfigData of the instance to be
450 bound.
451
452 @retval EFI_SUCCESS The bound operation is completed successfully.
453 @retval EFI_ACCESS_DENIED The <Address, Port> specified by the ConfigData is
454 already used by other instance.
455 @retval EFI_OUT_OF_RESOURCES No available port resources.
456
457 **/
458 EFI_STATUS
459 Udp4Bind (
460 IN NET_LIST_ENTRY *InstanceList,
461 IN EFI_UDP4_CONFIG_DATA *ConfigData
462 )
463 {
464 EFI_IPv4_ADDRESS *StationAddress;
465 UINT16 StartPort;
466
467 if (ConfigData->AcceptAnyPort) {
468 return EFI_SUCCESS;
469 }
470
471 StationAddress = &ConfigData->StationAddress;
472
473 if (ConfigData->StationPort != 0) {
474
475 if (!ConfigData->AllowDuplicatePort &&
476 Udp4FindInstanceByPort (InstanceList, StationAddress, ConfigData->StationPort)) {
477 //
478 // Do not allow duplicate port and the port is already used by other instance.
479 //
480 return EFI_ACCESS_DENIED;
481 }
482 } else {
483 //
484 // select a random port for this instance;
485 //
486
487 if (ConfigData->AllowDuplicatePort) {
488 //
489 // Just pick up the random port if the instance allows duplicate port.
490 //
491 ConfigData->StationPort = mUdp4RandomPort;
492 } else {
493
494 StartPort = mUdp4RandomPort;
495
496 while (Udp4FindInstanceByPort(InstanceList, StationAddress, mUdp4RandomPort)) {
497
498 mUdp4RandomPort++;
499 if (mUdp4RandomPort == 0) {
500 mUdp4RandomPort = UDP4_PORT_KNOWN;
501 }
502
503 if (mUdp4RandomPort == StartPort) {
504 //
505 // No available port.
506 //
507 return EFI_OUT_OF_RESOURCES;
508 }
509 }
510
511 ConfigData->StationPort = mUdp4RandomPort;
512 }
513
514 mUdp4RandomPort++;
515 if (mUdp4RandomPort == 0) {
516 mUdp4RandomPort = UDP4_PORT_KNOWN;
517 }
518 }
519
520 return EFI_SUCCESS;
521 }
522
523
524 /**
525 This function is used to check whether the NewConfigData has any un-reconfigurable
526 parameters changed compared to the OldConfigData.
527
528 @param OldConfigData Pointer to the current ConfigData the udp instance
529 uses.
530 @param NewConfigData Pointer to the new ConfigData.
531
532 @return The instance is reconfigurable or not according to the NewConfigData.
533
534 **/
535 BOOLEAN
536 Udp4IsReconfigurable (
537 IN EFI_UDP4_CONFIG_DATA *OldConfigData,
538 IN EFI_UDP4_CONFIG_DATA *NewConfigData
539 )
540 {
541 if ((NewConfigData->AcceptAnyPort != OldConfigData->AcceptAnyPort) ||
542 (NewConfigData->AcceptBroadcast != OldConfigData->AcceptBroadcast) ||
543 (NewConfigData->AcceptPromiscuous != OldConfigData->AcceptPromiscuous) ||
544 (NewConfigData->AllowDuplicatePort != OldConfigData->AllowDuplicatePort)) {
545 //
546 // The receiving filter parameters cannot be changed.
547 //
548 return FALSE;
549 }
550
551 if ((!NewConfigData->AcceptAnyPort) &&
552 (NewConfigData->StationPort != OldConfigData->StationPort)) {
553 //
554 // The port is not changeable.
555 //
556 return FALSE;
557 }
558
559 if (!NewConfigData->AcceptPromiscuous) {
560
561 if (NewConfigData->UseDefaultAddress != OldConfigData->UseDefaultAddress) {
562 //
563 // The NewConfigData differs to the old one on the UseDefaultAddress.
564 //
565 return FALSE;
566 }
567
568 if (!NewConfigData->UseDefaultAddress &&
569 (!EFI_IP4_EQUAL (&NewConfigData->StationAddress, &OldConfigData->StationAddress) ||
570 !EFI_IP4_EQUAL (&NewConfigData->SubnetMask, &OldConfigData->SubnetMask))) {
571 //
572 // If the instance doesn't use the default address, and the new address or
573 // new subnet mask is different from the old values.
574 //
575 return FALSE;
576 }
577 }
578
579 if (!EFI_IP4_EQUAL (&NewConfigData->RemoteAddress, &OldConfigData->RemoteAddress)) {
580 //
581 // The remoteaddress is not the same.
582 //
583 return FALSE;
584 }
585
586 if (!EFI_IP4_EQUAL (&NewConfigData->RemoteAddress, &mZeroIp4Addr) && (NewConfigData->RemotePort != OldConfigData->RemotePort)) {
587 //
588 // The RemotePort differs if it's designated in the configdata.
589 //
590 return FALSE;
591 }
592
593 //
594 // All checks pass, return TRUE.
595 //
596 return TRUE;
597 }
598
599
600 /**
601 This function builds the Ip4 configdata from the Udp4ConfigData.
602
603 @param Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.
604 @param Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.
605
606 @return None.
607
608 **/
609 VOID
610 Udp4BuildIp4ConfigData (
611 IN EFI_UDP4_CONFIG_DATA *Udp4ConfigData,
612 IN EFI_IP4_CONFIG_DATA *Ip4ConfigData
613 )
614 {
615 CopyMem (Ip4ConfigData, &mIpIoDefaultIpConfigData, sizeof (*Ip4ConfigData));
616
617 Ip4ConfigData->DefaultProtocol = EFI_IP_PROTO_UDP;
618 Ip4ConfigData->AcceptBroadcast = Udp4ConfigData->AcceptBroadcast;
619 Ip4ConfigData->AcceptPromiscuous = Udp4ConfigData->AcceptPromiscuous;
620 Ip4ConfigData->UseDefaultAddress = Udp4ConfigData->UseDefaultAddress;
621 Ip4ConfigData->StationAddress = Udp4ConfigData->StationAddress;
622 Ip4ConfigData->SubnetMask = Udp4ConfigData->SubnetMask;
623
624 //
625 // use the -1 magic number to disable the receiving process of the ip instance.
626 //
627 Ip4ConfigData->ReceiveTimeout = (UINT32) (-1);
628 }
629
630
631 /**
632 This function validates the TxToken, it returns the error code according to the spec.
633
634 @param Instance Pointer to the udp instance context data.
635 @param TxToken Pointer to the token to be checked.
636
637 @retval EFI_SUCCESS The TxToken is valid.
638 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is
639 NULL. Token is NULL. Token.Event is NULL.
640 Token.Packet.TxData is NULL.
641 Token.Packet.TxData.FragmentCount is zero.
642 Token.Packet.TxData.DataLength is not equal to the
643 sum of fragment lengths. One or more of the
644 Token.Packet.TxData.FragmentTable[].
645 FragmentLength fields is zero. One or more of the
646 Token.Packet.TxData.FragmentTable[].
647 FragmentBuffer fields is NULL.
648 Token.Packet.TxData. GatewayAddress is not a
649 unicast IPv4 address if it is not NULL. One or
650 more IPv4 addresses in Token.Packet.TxData.
651 UdpSessionData are not valid unicast IPv4
652 addresses if the UdpSessionData is not NULL.
653 @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP
654 packet size.
655
656 **/
657 EFI_STATUS
658 Udp4ValidateTxToken (
659 IN UDP4_INSTANCE_DATA *Instance,
660 IN EFI_UDP4_COMPLETION_TOKEN *TxToken
661 )
662 {
663 EFI_UDP4_TRANSMIT_DATA *TxData;
664 UINT32 Index;
665 UINT32 TotalLen;
666 EFI_UDP4_CONFIG_DATA *ConfigData;
667 EFI_UDP4_SESSION_DATA *UdpSessionData;
668 IP4_ADDR SourceAddress;
669 IP4_ADDR GatewayAddress;
670
671 if (TxToken->Event == NULL) {
672 return EFI_INVALID_PARAMETER;
673 }
674
675 TxData = TxToken->Packet.TxData;
676
677 if ((TxData == NULL) || (TxData->FragmentCount == 0)) {
678 return EFI_INVALID_PARAMETER;
679 }
680
681 TotalLen = 0;
682 for (Index = 0; Index < TxData->FragmentCount; Index++) {
683
684 if ((TxData->FragmentTable[Index].FragmentBuffer == NULL) ||
685 (TxData->FragmentTable[Index].FragmentLength == 0)) {
686 //
687 // if the FragmentBuffer is NULL or the FragmentLeng is zero.
688 //
689 return EFI_INVALID_PARAMETER;
690 }
691
692 TotalLen += TxData->FragmentTable[Index].FragmentLength;
693 }
694
695 if (TotalLen != TxData->DataLength) {
696 //
697 // The TotalLen calculated by adding all the FragmentLeng doesn't equal to the
698 // DataLength.
699 //
700 return EFI_INVALID_PARAMETER;
701 }
702
703 if (TxData->GatewayAddress != NULL) {
704 NetCopyMem (&GatewayAddress, TxData->GatewayAddress, sizeof (IP4_ADDR));
705
706 if (!Ip4IsUnicast (NTOHL (GatewayAddress), 0)) {
707 //
708 // The specified GatewayAddress is not a unicast IPv4 address while it's not 0.
709 //
710 return EFI_INVALID_PARAMETER;
711 }
712 }
713
714 ConfigData = &Instance->ConfigData;
715 UdpSessionData = TxData->UdpSessionData;
716
717 if (UdpSessionData != NULL) {
718
719 NetCopyMem (&SourceAddress, &UdpSessionData->SourceAddress, sizeof (IP4_ADDR));
720
721 if ((SourceAddress != 0) && !Ip4IsUnicast (HTONL (SourceAddress), 0)) {
722 //
723 // Check whether SourceAddress is a valid IPv4 address in case it's not zero.
724 // The configured station address is used if SourceAddress is zero.
725 //
726 return EFI_INVALID_PARAMETER;
727 }
728
729 if ((UdpSessionData->DestinationPort == 0) && (ConfigData->RemotePort == 0)) {
730 //
731 // Ambiguous, no avalaible DestinationPort for this token.
732 //
733 return EFI_INVALID_PARAMETER;
734 }
735
736 if (EFI_IP4_EQUAL (&UdpSessionData->DestinationAddress, &mZeroIp4Addr)) {
737 //
738 // The DestinationAddress specified in the UdpSessionData is 0.
739 //
740 return EFI_INVALID_PARAMETER;
741 }
742 } else if (EFI_IP4_EQUAL (&ConfigData->RemoteAddress, &mZeroIp4Addr)) {
743 //
744 // the configured RemoteAddress is all zero, and the user doens't override the
745 // destination address.
746 //
747 return EFI_INVALID_PARAMETER;
748 }
749
750 if (TxData->DataLength > UDP4_MAX_DATA_SIZE) {
751 return EFI_BAD_BUFFER_SIZE;
752 }
753
754 return EFI_SUCCESS;
755 }
756
757
758 /**
759 This function checks whether the specified Token duplicates with the one in the Map.
760
761 @param Map Pointer to the NET_MAP.
762 @param Item Pointer to the NET_MAP_ITEM contain the pointer to
763 the Token.
764 @param Context Pointer to the Token to be checked.
765
766 @retval EFI_SUCCESS The Token specified by Context differs from the
767 one in the Item.
768 @retval EFI_ACCESS_DENIED The Token duplicates with the one in the Item.
769
770 **/
771 EFI_STATUS
772 Udp4TokenExist (
773 IN NET_MAP *Map,
774 IN NET_MAP_ITEM *Item,
775 IN VOID *Context
776 )
777 {
778 EFI_UDP4_COMPLETION_TOKEN *Token;
779 EFI_UDP4_COMPLETION_TOKEN *TokenInItem;
780
781 Token = (EFI_UDP4_COMPLETION_TOKEN*) Context;
782 TokenInItem = (EFI_UDP4_COMPLETION_TOKEN*) Item->Key;
783
784 if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) {
785 //
786 // The Token duplicates with the TokenInItem in case either the two pointers are the
787 // same or the Events of these two tokens are the same.
788 //
789 return EFI_ACCESS_DENIED;
790 }
791
792 return EFI_SUCCESS;
793 }
794
795
796 /**
797 This function calculates the checksum for the Packet, utilizing the pre-calculated
798 pseudo HeadSum to reduce some overhead.
799
800 @param Packet Pointer to the NET_BUF contains the udp datagram.
801 @param HeadSum Checksum of the pseudo header execpt the length
802 field.
803
804 @return The 16-bit checksum of this udp datagram.
805
806 **/
807 UINT16
808 Udp4Checksum (
809 IN NET_BUF *Packet,
810 IN UINT16 HeadSum
811 )
812 {
813 UINT16 Checksum;
814
815 Checksum = NetbufChecksum (Packet);
816 Checksum = NetAddChecksum (Checksum, HeadSum);
817
818 Checksum = NetAddChecksum (Checksum, HTONS ((UINT16) Packet->TotalSize));
819
820 return (UINT16) ~Checksum;
821 }
822
823
824 /**
825 This function removes the specified Token from the TokenMap.
826
827 @param TokenMap Pointer to the NET_MAP containing the tokens.
828 @param Token Pointer to the Token to be removed.
829
830 @retval EFI_SUCCESS The specified Token is removed from the TokenMap.
831 @retval EFI_NOT_FOUND The specified Token is not found in the TokenMap.
832
833 **/
834 EFI_STATUS
835 Udp4RemoveToken (
836 IN NET_MAP *TokenMap,
837 IN EFI_UDP4_COMPLETION_TOKEN *Token
838 )
839 {
840 NET_MAP_ITEM *Item;
841
842 //
843 // Find the Token first.
844 //
845 Item = NetMapFindKey (TokenMap, (VOID *) Token);
846
847 if (Item != NULL) {
848 //
849 // Remove the token if it's found in the map.
850 //
851 NetMapRemoveItem (TokenMap, Item, NULL);
852
853 return EFI_SUCCESS;
854 }
855
856 return EFI_NOT_FOUND;
857 }
858
859
860 /**
861 This function is the packet transmitting notify function registered to the IpIo
862 interface. It's called to signal the udp TxToken when IpIo layer completes the
863 transmitting of the udp datagram.
864
865 @param Status The completion status of the output udp datagram.
866 @param Context Pointer to the context data.
867 @param Sender Pointer to the Ip sender of the udp datagram.
868 @param NotifyData Pointer to the notify data.
869
870 @return None.
871
872 **/
873 STATIC
874 VOID
875 Udp4DgramSent (
876 IN EFI_STATUS Status,
877 IN VOID *Context,
878 IN VOID *Sender,
879 IN VOID *NotifyData
880 )
881 {
882 UDP4_INSTANCE_DATA *Instance;
883 EFI_UDP4_COMPLETION_TOKEN *Token;
884
885 Instance = (UDP4_INSTANCE_DATA *) Context;
886 Token = (EFI_UDP4_COMPLETION_TOKEN *) NotifyData;
887
888 if (Udp4RemoveToken (&Instance->TxTokens, Token) == EFI_SUCCESS) {
889 //
890 // The token may be cancelled. Only signal it if the remove operation succeeds.
891 //
892 Token->Status = Status;
893 gBS->SignalEvent (Token->Event);
894 }
895 }
896
897
898 /**
899 This function processes the received datagram passed up by the IpIo layer.
900
901 @param Status The status of this udp datagram.
902 @param IcmpError The IcmpError code, only available when Status is
903 EFI_ICMP_ERROR.
904 @param NetSession Pointer to the EFI_NET_SESSION_DATA.
905 @param Packet Pointer to the NET_BUF containing the received udp
906 datagram.
907 @param Context Pointer to the context data.
908
909 @return None.
910
911 **/
912 STATIC
913 VOID
914 Udp4DgramRcvd (
915 IN EFI_STATUS Status,
916 IN ICMP_ERROR IcmpError,
917 IN EFI_NET_SESSION_DATA *NetSession,
918 IN NET_BUF *Packet,
919 IN VOID *Context
920 )
921 {
922 NET_CHECK_SIGNATURE (Packet, NET_BUF_SIGNATURE);
923
924 //
925 // IpIo only passes received packets with Status EFI_SUCCESS or EFI_ICMP_ERROR.
926 //
927 if (Status == EFI_SUCCESS) {
928 //
929 // Demultiplex the received datagram.
930 //
931 Udp4Demultiplex ((UDP4_SERVICE_DATA *) Context, NetSession, Packet);
932 } else {
933 //
934 // Handle the ICMP_ERROR packet.
935 //
936 Udp4IcmpHandler ((UDP4_SERVICE_DATA *) Context, IcmpError, NetSession, Packet);
937 }
938 }
939
940
941 /**
942 This function removes the multicast group specified by Arg from the Map.
943
944 @param Map Pointer to the NET_MAP.
945 @param Item Pointer to the NET_MAP_ITEM.
946 @param Arg Pointer to the Arg, it's the pointer to a
947 multicast IPv4 Address.
948
949 @retval EFI_SUCCESS The multicast address is removed.
950 @retval EFI_ABORTED The specified multicast address is removed and the
951 Arg is not NULL.
952
953 **/
954 EFI_STATUS
955 Udp4LeaveGroup (
956 IN NET_MAP *Map,
957 IN NET_MAP_ITEM *Item,
958 IN VOID *Arg OPTIONAL
959 )
960 {
961 EFI_IPv4_ADDRESS *McastIp;
962
963 McastIp = Arg;
964
965 if ((McastIp != NULL) && (!EFI_IP4_EQUAL (McastIp, &(Item->Key)))) {
966 //
967 // McastIp is not NULL and the multicast address contained in the Item
968 // is not the same as McastIp.
969 //
970 return EFI_SUCCESS;
971 }
972
973 //
974 // Remove this Item.
975 //
976 NetMapRemoveItem (Map, Item, NULL);
977
978 if (McastIp != NULL) {
979 //
980 // Return EFI_ABORTED in case McastIp is not NULL to terminate the iteration.
981 //
982 return EFI_ABORTED;
983 }
984
985 return EFI_SUCCESS;
986 }
987
988
989 /**
990 This function cancle the token specified by Arg in the Map.
991
992 @param Map Pointer to the NET_MAP.
993 @param Item Pointer to the NET_MAP_ITEM.
994 @param Arg Pointer to the token to be cancelled, if NULL, all
995 the tokens in this Map will be cancelled.
996
997 @retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token
998 is not the same as that in the Item if Arg is not
999 NULL.
1000 @retval EFI_ABORTED Arg is not NULL, and the token specified by Arg is
1001 cancelled.
1002
1003 **/
1004 STATIC
1005 EFI_STATUS
1006 Udp4CancelTokens (
1007 IN NET_MAP *Map,
1008 IN NET_MAP_ITEM *Item,
1009 IN VOID *Arg OPTIONAL
1010 )
1011 {
1012 EFI_UDP4_COMPLETION_TOKEN *TokenToCancel;
1013 NET_BUF *Packet;
1014 IP_IO *IpIo;
1015
1016 if ((Arg != NULL) && (Item->Key != Arg)) {
1017 return EFI_SUCCESS;
1018 }
1019
1020 if (Item->Value != NULL) {
1021 //
1022 // If the token is a transmit token, the corresponding Packet is recorded in
1023 // Item->Value, invoke IpIo to cancel this packet first. The IpIoCancelTxToken
1024 // will invoke Udp4DgramSent, the token will be signaled and this Item will
1025 // be removed from the Map there.
1026 //
1027 Packet = (NET_BUF *) (Item->Value);
1028 IpIo = (IP_IO *) (*((UINTN *) &Packet->ProtoData[0]));
1029
1030 IpIoCancelTxToken (IpIo, Packet);
1031 } else {
1032 //
1033 // The token is a receive token. Abort it and remove it from the Map.
1034 //
1035 TokenToCancel = (EFI_UDP4_COMPLETION_TOKEN *) Item->Key;
1036
1037 TokenToCancel->Status = EFI_ABORTED;
1038 gBS->SignalEvent (TokenToCancel->Event);
1039
1040 NetMapRemoveItem (Map, Item, NULL);
1041 }
1042
1043 if (Arg != NULL) {
1044 return EFI_ABORTED;
1045 }
1046
1047 return EFI_SUCCESS;
1048 }
1049
1050
1051 /**
1052 This function removes all the Wrap datas in the RcvdDgramQue.
1053
1054 @param RcvdDgramQue Pointer to the list containing all the Wrap datas.
1055
1056 @return None.
1057
1058 **/
1059 VOID
1060 Udp4FlushRxData (
1061 IN NET_LIST_ENTRY *RcvdDgramQue
1062 )
1063 {
1064 UDP4_RXDATA_WRAP *Wrap;
1065 EFI_TPL OldTpl;
1066
1067 OldTpl = NET_RAISE_TPL (NET_TPL_RECYCLE);
1068
1069 while (!NetListIsEmpty (RcvdDgramQue)) {
1070 //
1071 // Iterate all the Wraps in the RcvdDgramQue.
1072 //
1073 Wrap = NET_LIST_HEAD (RcvdDgramQue, UDP4_RXDATA_WRAP, Link);
1074
1075 //
1076 // The Wrap will be removed from the RcvdDgramQue by this function call.
1077 //
1078 Udp4RecycleRxDataWrap (NULL, (VOID *) Wrap);
1079 }
1080
1081 NET_RESTORE_TPL (OldTpl);
1082 }
1083
1084
1085
1086 /**
1087
1088 @param Instance Pointer to the udp instance context data.
1089 @param Token Pointer to the token to be canceled, if NULL, all
1090 tokens in this instance will be cancelled.
1091
1092 @retval EFI_SUCCESS The Token is cancelled.
1093 @retval EFI_NOT_FOUND The Token is not found.
1094
1095 **/
1096 EFI_STATUS
1097 Udp4InstanceCancelToken (
1098 IN UDP4_INSTANCE_DATA *Instance,
1099 IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL
1100 )
1101 {
1102 EFI_STATUS Status;
1103
1104 //
1105 // Cancle this token from the TxTokens map.
1106 //
1107 Status = NetMapIterate (&Instance->TxTokens, Udp4CancelTokens, Token);
1108
1109 if ((Token != NULL) && (Status == EFI_ABORTED)) {
1110 //
1111 // If Token isn't NULL and Status is EFI_ABORTED, the token is cancelled from
1112 // the TxTokens, just return success.
1113 //
1114 return EFI_SUCCESS;
1115 }
1116
1117 //
1118 // Try to cancel this token from the RxTokens map in condition either the Token
1119 // is NULL or the specified Token is not in TxTokens.
1120 //
1121 Status = NetMapIterate (&Instance->RxTokens, Udp4CancelTokens, Token);
1122
1123 if ((Token != NULL) && (Status == EFI_SUCCESS)) {
1124 //
1125 // If Token isn't NULL and Status is EFI_SUCCESS, the token is neither in the
1126 // TxTokens nor the RxTokens, or say, it's not found.
1127 //
1128 return EFI_NOT_FOUND;
1129 }
1130
1131 ASSERT ((Token != NULL) || ((0 == NetMapGetCount (&Instance->TxTokens))
1132 && (0 == NetMapGetCount (&Instance->RxTokens))));
1133
1134 return EFI_SUCCESS;
1135 }
1136
1137
1138 /**
1139 This function matches the received udp datagram with the Instance.
1140
1141 @param Instance Pointer to the udp instance context data.
1142 @param Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted
1143 from the received udp datagram.
1144
1145 @return The udp datagram matches the receiving requirments of the Instance or not.
1146
1147 **/
1148 STATIC
1149 BOOLEAN
1150 Udp4MatchDgram (
1151 IN UDP4_INSTANCE_DATA *Instance,
1152 IN EFI_UDP4_SESSION_DATA *Udp4Session
1153 )
1154 {
1155 EFI_UDP4_CONFIG_DATA *ConfigData;
1156 IP4_ADDR Destination;
1157
1158 ConfigData = &Instance->ConfigData;
1159
1160 if (ConfigData->AcceptPromiscuous) {
1161 //
1162 // Always matches if this instance is in the promiscuous state.
1163 //
1164 return TRUE;
1165 }
1166
1167 if ((!ConfigData->AcceptAnyPort && (Udp4Session->DestinationPort != ConfigData->StationPort)) ||
1168 ((ConfigData->RemotePort != 0) && (Udp4Session->SourcePort != ConfigData->RemotePort))) {
1169 //
1170 // The local port or the remote port doesn't match.
1171 //
1172 return FALSE;
1173 }
1174
1175 if (!EFI_IP4_EQUAL (&ConfigData->RemoteAddress, &mZeroIp4Addr) &&
1176 !EFI_IP4_EQUAL (&ConfigData->RemoteAddress, &Udp4Session->SourceAddress)) {
1177 //
1178 // This datagram doesn't come from the instance's specified sender.
1179 //
1180 return FALSE;
1181 }
1182
1183 if (EFI_IP4_EQUAL (&ConfigData->StationAddress, &mZeroIp4Addr) ||
1184 EFI_IP4_EQUAL (&Udp4Session->DestinationAddress, &ConfigData->StationAddress)) {
1185 //
1186 // The instance is configured to receive datagrams destinated to any station IP or
1187 // the destination address of this datagram matches the configured station IP.
1188 //
1189 return TRUE;
1190 }
1191
1192 NetCopyMem (&Destination, &Udp4Session->DestinationAddress, sizeof (IP4_ADDR));
1193
1194 if (IP4_IS_LOCAL_BROADCAST (Destination) && ConfigData->AcceptBroadcast) {
1195 //
1196 // The instance is configured to receive broadcast and this is a broadcast packet.
1197 //
1198 return TRUE;
1199 }
1200
1201 if (IP4_IS_MULTICAST (NTOHL (Destination)) &&
1202 (NULL != NetMapFindKey (&Instance->McastIps, (VOID *) (UINTN) Destination))) {
1203 //
1204 // It's a multicast packet and the multicast address is accepted by this instance.
1205 //
1206 return TRUE;
1207 }
1208
1209 return FALSE;
1210 }
1211
1212
1213 /**
1214 This function removes the Wrap specified by Context and release relevant resources.
1215
1216 @param Event The Event this notify function registered to.
1217 @param Context Pointer to the context data.
1218
1219 @return None.
1220
1221 **/
1222 STATIC
1223 VOID
1224 EFIAPI
1225 Udp4RecycleRxDataWrap (
1226 IN EFI_EVENT Event,
1227 IN VOID *Context
1228 )
1229 {
1230 UDP4_RXDATA_WRAP *Wrap;
1231
1232 Wrap = (UDP4_RXDATA_WRAP *) Context;
1233
1234 //
1235 // Remove the Wrap from the list it belongs to.
1236 //
1237 NetListRemoveEntry (&Wrap->Link);
1238
1239 //
1240 // Free the Packet associated with this Wrap.
1241 //
1242 NetbufFree (Wrap->Packet);
1243
1244 //
1245 // Close the event.
1246 //
1247 gBS->CloseEvent (Wrap->RxData.RecycleSignal);
1248
1249 NetFreePool (Wrap);
1250 }
1251
1252
1253 /**
1254 This function wraps the Packet and the RxData.
1255
1256 @param Instance Pointer to the instance context data.
1257 @param Packet Pointer to the buffer containing the received
1258 datagram.
1259 @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
1260 datagram.
1261
1262 @return Pointer to the structure wrapping the RxData and the Packet.
1263
1264 **/
1265 STATIC
1266 UDP4_RXDATA_WRAP *
1267 Udp4WrapRxData (
1268 IN UDP4_INSTANCE_DATA *Instance,
1269 IN NET_BUF *Packet,
1270 IN EFI_UDP4_RECEIVE_DATA *RxData
1271 )
1272 {
1273 EFI_STATUS Status;
1274 UDP4_RXDATA_WRAP *Wrap;
1275
1276 //
1277 // Allocate buffer for the Wrap.
1278 //
1279 Wrap = NetAllocatePool (sizeof (UDP4_RXDATA_WRAP) +
1280 (Packet->BlockOpNum - 1) * sizeof (EFI_UDP4_FRAGMENT_DATA));
1281 if (Wrap == NULL) {
1282 return NULL;
1283 }
1284
1285 NetListInit (&Wrap->Link);
1286
1287 CopyMem (&Wrap->RxData, RxData, sizeof (Wrap->RxData));
1288
1289 //
1290 // Create the Recycle event.
1291 //
1292 Status = gBS->CreateEvent (
1293 EVT_NOTIFY_SIGNAL,
1294 NET_TPL_RECYCLE,
1295 Udp4RecycleRxDataWrap,
1296 Wrap,
1297 &Wrap->RxData.RecycleSignal
1298 );
1299 if (EFI_ERROR (Status)) {
1300 NetFreePool (Wrap);
1301 return NULL;
1302 }
1303
1304 Wrap->Packet = Packet;
1305 Wrap->TimeoutTick = Instance->ConfigData.ReceiveTimeout;
1306
1307 return Wrap;
1308 }
1309
1310
1311 /**
1312 This function enqueues the received datagram into the instances' receiving queues.
1313
1314 @param Udp4Service Pointer to the udp service context data.
1315 @param Packet Pointer to the buffer containing the received
1316 datagram.
1317 @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
1318 datagram.
1319
1320 @return The times this datagram is enqueued.
1321
1322 **/
1323 STATIC
1324 UINTN
1325 Udp4EnqueueDgram (
1326 IN UDP4_SERVICE_DATA *Udp4Service,
1327 IN NET_BUF *Packet,
1328 IN EFI_UDP4_RECEIVE_DATA *RxData
1329 )
1330 {
1331 NET_LIST_ENTRY *Entry;
1332 UDP4_INSTANCE_DATA *Instance;
1333 UDP4_RXDATA_WRAP *Wrap;
1334 UINTN Enqueued;
1335
1336 Enqueued = 0;
1337
1338 NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) {
1339 //
1340 // Iterate the instances.
1341 //
1342 Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link);
1343
1344 if (!Instance->Configured) {
1345 continue;
1346 }
1347
1348 if (Udp4MatchDgram (Instance, &RxData->UdpSession)) {
1349 //
1350 // Wrap the RxData and put this Wrap into the instances RcvdDgramQue.
1351 //
1352 Wrap = Udp4WrapRxData (Instance, Packet, RxData);
1353 if (Wrap == NULL) {
1354 continue;
1355 }
1356
1357 NET_GET_REF (Packet);
1358
1359 NetListInsertTail (&Instance->RcvdDgramQue, &Wrap->Link);
1360
1361 Enqueued++;
1362 }
1363 }
1364
1365 return Enqueued;
1366 }
1367
1368
1369 /**
1370 This function delivers the received datagrams for the specified instance.
1371
1372 @param Instance Pointer to the instance context data.
1373
1374 @return None.
1375
1376 **/
1377 VOID
1378 Udp4InstanceDeliverDgram (
1379 IN UDP4_INSTANCE_DATA *Instance
1380 )
1381 {
1382 UDP4_RXDATA_WRAP *Wrap;
1383 EFI_UDP4_COMPLETION_TOKEN *Token;
1384 NET_BUF *Dup;
1385 EFI_UDP4_RECEIVE_DATA *RxData;
1386
1387 if (!NetListIsEmpty (&Instance->RcvdDgramQue) &&
1388 !NetMapIsEmpty (&Instance->RxTokens)) {
1389
1390 Wrap = NET_LIST_HEAD (&Instance->RcvdDgramQue, UDP4_RXDATA_WRAP, Link);
1391
1392 if (NET_BUF_SHARED (Wrap->Packet)) {
1393 //
1394 // Duplicate the Packet if it is shared between instances.
1395 //
1396 Dup = NetbufDuplicate (Wrap->Packet, NULL, 0);
1397 if (Dup == NULL) {
1398 return;
1399 }
1400
1401 NetbufFree (Wrap->Packet);
1402
1403 Wrap->Packet = Dup;
1404 }
1405
1406 NetListRemoveHead (&Instance->RcvdDgramQue);
1407
1408 Token = (EFI_UDP4_COMPLETION_TOKEN *) NetMapRemoveHead (&Instance->RxTokens, NULL);
1409
1410 //
1411 // Build the FragmentTable and set the FragmentCount in RxData.
1412 //
1413 RxData = &Wrap->RxData;
1414 RxData->FragmentCount = Wrap->Packet->BlockOpNum;
1415
1416 NetbufBuildExt (
1417 Wrap->Packet,
1418 (NET_FRAGMENT *) RxData->FragmentTable,
1419 &RxData->FragmentCount
1420 );
1421
1422 Token->Status = EFI_SUCCESS;
1423 Token->Packet.RxData = &Wrap->RxData;
1424
1425 gBS->SignalEvent (Token->Event);
1426
1427 NetListInsertTail (&Instance->DeliveredDgramQue, &Wrap->Link);
1428 }
1429 }
1430
1431
1432 /**
1433 This function delivers the datagrams enqueued in the instances.
1434
1435 @param Udp4Service Pointer to the udp service context data.
1436
1437 @return None.
1438
1439 **/
1440 STATIC
1441 VOID
1442 Udp4DeliverDgram (
1443 IN UDP4_SERVICE_DATA *Udp4Service
1444 )
1445 {
1446 NET_LIST_ENTRY *Entry;
1447 UDP4_INSTANCE_DATA *Instance;
1448
1449 NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) {
1450 //
1451 // Iterate the instances.
1452 //
1453 Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link);
1454
1455 if (!Instance->Configured) {
1456 continue;
1457 }
1458
1459 //
1460 // Deliver the datagrams of this instance.
1461 //
1462 Udp4InstanceDeliverDgram (Instance);
1463 }
1464 }
1465
1466
1467 /**
1468 This function demultiplexes the received udp datagram to the apropriate instances.
1469
1470 @param Udp4Service Pointer to the udp service context data.
1471 @param NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from
1472 the received datagram.
1473 @param Packet Pointer to the buffer containing the received udp
1474 datagram.
1475
1476 @return None.
1477
1478 **/
1479 STATIC
1480 VOID
1481 Udp4Demultiplex (
1482 IN UDP4_SERVICE_DATA *Udp4Service,
1483 IN EFI_NET_SESSION_DATA *NetSession,
1484 IN NET_BUF *Packet
1485 )
1486 {
1487 EFI_UDP4_HEADER *Udp4Header;
1488 UINT16 HeadSum;
1489 EFI_UDP4_RECEIVE_DATA RxData;
1490 EFI_UDP4_SESSION_DATA *Udp4Session;
1491 UINTN Enqueued;
1492
1493 //
1494 // Get the datagram header from the packet buffer.
1495 //
1496 Udp4Header = (EFI_UDP4_HEADER *) NetbufGetByte (Packet, 0, NULL);
1497
1498 if (Udp4Header->Checksum != 0) {
1499 //
1500 // check the checksum.
1501 //
1502 HeadSum = NetPseudoHeadChecksum (
1503 NetSession->Source,
1504 NetSession->Dest,
1505 EFI_IP_PROTO_UDP,
1506 0
1507 );
1508
1509 if (Udp4Checksum (Packet, HeadSum) != 0) {
1510 //
1511 // Wrong checksum.
1512 //
1513 return;
1514 }
1515 }
1516
1517 gRT->GetTime (&RxData.TimeStamp, NULL);
1518
1519 Udp4Session = &RxData.UdpSession;
1520 Udp4Session->SourcePort = NTOHS (Udp4Header->SrcPort);
1521 Udp4Session->DestinationPort = NTOHS (Udp4Header->DstPort);
1522
1523 NetCopyMem (&Udp4Session->SourceAddress, &NetSession->Source, sizeof (EFI_IPv4_ADDRESS));
1524 NetCopyMem (&Udp4Session->DestinationAddress, &NetSession->Dest, sizeof (EFI_IPv4_ADDRESS));
1525
1526 //
1527 // Trim the UDP header.
1528 //
1529 NetbufTrim (Packet, UDP4_HEADER_SIZE, TRUE);
1530
1531 RxData.DataLength = (UINT32) Packet->TotalSize;
1532
1533 //
1534 // Try to enqueue this datagram into the instances.
1535 //
1536 Enqueued = Udp4EnqueueDgram (Udp4Service, Packet, &RxData);
1537
1538 if (Enqueued == 0) {
1539 //
1540 // Send the port unreachable ICMP packet before we free this NET_BUF
1541 //
1542 Udp4SendPortUnreach (Udp4Service->IpIo, NetSession, Udp4Header);
1543 }
1544
1545 //
1546 // Try to free the packet before deliver it.
1547 //
1548 NetbufFree (Packet);
1549
1550 if (Enqueued > 0) {
1551 //
1552 // Deliver the datagram.
1553 //
1554 Udp4DeliverDgram (Udp4Service);
1555 }
1556 }
1557
1558
1559 /**
1560 This function builds and sends out a icmp port unreachable message.
1561
1562 @param IpIo Pointer to the IP_IO instance.
1563 @param NetSession Pointer to the EFI_NET_SESSION_DATA of the packet
1564 causes this icmp error message.
1565 @param Udp4Header Pointer to the udp header of the datagram causes
1566 this icmp error message.
1567
1568 @return None.
1569
1570 **/
1571 STATIC
1572 VOID
1573 Udp4SendPortUnreach (
1574 IN IP_IO *IpIo,
1575 IN EFI_NET_SESSION_DATA *NetSession,
1576 IN VOID *Udp4Header
1577 )
1578 {
1579 NET_BUF *Packet;
1580 UINT32 Len;
1581 IP4_ICMP_ERROR_HEAD *IcmpErrHdr;
1582 EFI_IP4_HEADER *IpHdr;
1583 UINT8 *Ptr;
1584 IP_IO_OVERRIDE Override;
1585 IP_IO_IP_INFO *IpSender;
1586
1587 IpSender = IpIoFindSender (&IpIo, NetSession->Dest);
1588 if (IpSender == NULL) {
1589 //
1590 // No apropriate sender, since we cannot send out the ICMP message through
1591 // the default zero station address IP instance, abort.
1592 //
1593 return;
1594 }
1595
1596 IpHdr = NetSession->IpHdr;
1597
1598 //
1599 // Calculate the requried length of the icmp error message.
1600 //
1601 Len = sizeof (IP4_ICMP_ERROR_HEAD) + (EFI_IP4_HEADER_LEN (IpHdr) -
1602 sizeof (IP4_HEAD)) + ICMP_ERROR_PACKET_LENGTH;
1603
1604 //
1605 // Allocate buffer for the icmp error message.
1606 //
1607 Packet = NetbufAlloc (Len);
1608 if (Packet == NULL) {
1609 return;
1610 }
1611
1612 //
1613 // Allocate space for the IP4_ICMP_ERROR_HEAD.
1614 //
1615 IcmpErrHdr = (IP4_ICMP_ERROR_HEAD *) NetbufAllocSpace (Packet, Len, FALSE);
1616
1617 //
1618 // Set the required fields for the icmp port unreachable message.
1619 //
1620 IcmpErrHdr->Head.Type = ICMP_TYPE_UNREACH;
1621 IcmpErrHdr->Head.Code = ICMP_CODE_UNREACH_PORT;
1622 IcmpErrHdr->Head.Checksum = 0;
1623 IcmpErrHdr->Fourth = 0;
1624
1625 //
1626 // Copy the IP header of the datagram tragged the error.
1627 //
1628 NetCopyMem (&IcmpErrHdr->IpHead, IpHdr, EFI_IP4_HEADER_LEN (IpHdr));
1629
1630 //
1631 // Copy the UDP header.
1632 //
1633 Ptr = (UINT8 *) &IcmpErrHdr->IpHead + EFI_IP4_HEADER_LEN (IpHdr);
1634 NetCopyMem (Ptr, Udp4Header, ICMP_ERROR_PACKET_LENGTH);
1635
1636 //
1637 // Calculate the checksum.
1638 //
1639 IcmpErrHdr->Head.Checksum = (UINT16) ~(NetbufChecksum (Packet));
1640
1641 //
1642 // Fill the override data.
1643 //
1644 Override.DoNotFragment = FALSE;
1645 Override.TypeOfService = 0;
1646 Override.TimeToLive = 255;
1647 Override.Protocol = EFI_IP_PROTO_ICMP;
1648
1649 NetCopyMem (&Override.SourceAddress, &NetSession->Dest, sizeof (EFI_IPv4_ADDRESS));
1650 NetZeroMem (&Override.GatewayAddress, sizeof (EFI_IPv4_ADDRESS));
1651
1652 //
1653 // Send out this icmp packet.
1654 //
1655 IpIoSend (IpIo, Packet, IpSender, NULL, NULL, NetSession->Source, &Override);
1656
1657 NetbufFree (Packet);
1658 }
1659
1660
1661 /**
1662 This function handles the received Icmp Error message and demultiplexes it to the
1663 instance.
1664
1665 @param Udp4Service Pointer to the udp service context data.
1666 @param IcmpError The icmp error code.
1667 @param NetSession Pointer to the EFI_NET_SESSION_DATA abstracted
1668 from the received Icmp Error packet.
1669 @param Packet Pointer to the Icmp Error packet.
1670
1671 @return None.
1672
1673 **/
1674 STATIC
1675 VOID
1676 Udp4IcmpHandler (
1677 IN UDP4_SERVICE_DATA *Udp4Service,
1678 IN ICMP_ERROR IcmpError,
1679 IN EFI_NET_SESSION_DATA *NetSession,
1680 IN NET_BUF *Packet
1681 )
1682 {
1683 EFI_UDP4_HEADER *Udp4Header;
1684 EFI_UDP4_SESSION_DATA Udp4Session;
1685 NET_LIST_ENTRY *Entry;
1686 UDP4_INSTANCE_DATA *Instance;
1687
1688 Udp4Header = (EFI_UDP4_HEADER *) NetbufGetByte (Packet, 0, NULL);
1689
1690 NetCopyMem (&Udp4Session.SourceAddress, &NetSession->Source, sizeof (EFI_IPv4_ADDRESS));
1691 NetCopyMem (&Udp4Session.DestinationAddress, &NetSession->Dest, sizeof (EFI_IPv4_ADDRESS));
1692
1693 Udp4Session.SourcePort = NTOHS (Udp4Header->DstPort);
1694 Udp4Session.DestinationPort = NTOHS (Udp4Header->SrcPort);
1695
1696 NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) {
1697 //
1698 // Iterate all the instances.
1699 //
1700 Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link);
1701
1702 if (!Instance->Configured ||
1703 Instance->ConfigData.AcceptPromiscuous ||
1704 Instance->ConfigData.AcceptAnyPort ||
1705 EFI_IP4_EQUAL (&Instance->ConfigData.StationAddress, &mZeroIp4Addr)) {
1706 //
1707 // Don't try to deliver the ICMP error to this instance if it is not configured,
1708 // or it's configured to be promiscuous or accept any port or accept all the
1709 // datagrams.
1710 //
1711 continue;
1712 }
1713
1714 if (Udp4MatchDgram (Instance, &Udp4Session)) {
1715 //
1716 // Translate the Icmp Error code according to the udp spec.
1717 //
1718 Instance->IcmpError = IpIoGetIcmpErrStatus (IcmpError, NULL, NULL);
1719
1720 if (IcmpError > ICMP_ERR_UNREACH_PORT) {
1721 Instance->IcmpError = EFI_ICMP_ERROR;
1722 }
1723
1724 //
1725 // Notify the instance with the received Icmp Error.
1726 //
1727 Udp4ReportIcmpError (Instance);
1728
1729 break;
1730 }
1731 }
1732
1733 NetbufFree (Packet);
1734 }
1735
1736
1737 /**
1738 This function reports the received ICMP error.
1739
1740 @param Instance Pointer to the udp instance context data.
1741
1742 @return None.
1743
1744 **/
1745 VOID
1746 Udp4ReportIcmpError (
1747 IN UDP4_INSTANCE_DATA *Instance
1748 )
1749 {
1750 EFI_UDP4_COMPLETION_TOKEN *Token;
1751
1752 if (NetMapIsEmpty (&Instance->RxTokens)) {
1753 //
1754 // There are no receive tokens to deliver the ICMP error.
1755 //
1756 return;
1757 }
1758
1759 if (EFI_ERROR (Instance->IcmpError)) {
1760 //
1761 // Try to get a RxToken from the RxTokens map.
1762 //
1763 Token = (EFI_UDP4_COMPLETION_TOKEN *) NetMapRemoveHead (&Instance->RxTokens, NULL);
1764
1765 if (Token != NULL) {
1766 //
1767 // Report the error through the Token.
1768 //
1769 Token->Status = Instance->IcmpError;
1770 gBS->SignalEvent (Token->Event);
1771
1772 //
1773 // Clear the IcmpError.
1774 //
1775 Instance->IcmpError = EFI_SUCCESS;
1776 }
1777 }
1778 }
1779
1780
1781 /**
1782 This function is a dummy ext-free function for the NET_BUF created for the output
1783 udp datagram.
1784
1785 @param Context Pointer to the context data.
1786
1787 @return None.
1788
1789 **/
1790 VOID
1791 Udp4NetVectorExtFree (
1792 VOID *Context
1793 )
1794 {
1795 }
1796
1797
1798 /**
1799 Set the Udp4 variable data.
1800
1801 @param Udp4Service Udp4 service data.
1802
1803 @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the
1804 variable.
1805 @retval other Set variable failed.
1806
1807 **/
1808 EFI_STATUS
1809 Udp4SetVariableData (
1810 IN UDP4_SERVICE_DATA *Udp4Service
1811 )
1812 {
1813 UINT32 NumConfiguredInstance;
1814 NET_LIST_ENTRY *Entry;
1815 UINTN VariableDataSize;
1816 EFI_UDP4_VARIABLE_DATA *Udp4VariableData;
1817 EFI_UDP4_SERVICE_POINT *Udp4ServicePoint;
1818 UDP4_INSTANCE_DATA *Udp4Instance;
1819 CHAR16 *NewMacString;
1820 EFI_STATUS Status;
1821
1822 NumConfiguredInstance = 0;
1823
1824 //
1825 // Go through the children list to count the configured children.
1826 //
1827 NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) {
1828 Udp4Instance = NET_LIST_USER_STRUCT_S (
1829 Entry,
1830 UDP4_INSTANCE_DATA,
1831 Link,
1832 UDP4_INSTANCE_DATA_SIGNATURE
1833 );
1834
1835 if (Udp4Instance->Configured) {
1836 NumConfiguredInstance++;
1837 }
1838 }
1839
1840 //
1841 // Calculate the size of the Udp4VariableData. As there may be no Udp4 child,
1842 // we should add extra buffer for the service points only if the number of configured
1843 // children is more than 1.
1844 //
1845 VariableDataSize = sizeof (EFI_UDP4_VARIABLE_DATA);
1846
1847 if (NumConfiguredInstance > 1) {
1848 VariableDataSize += sizeof (EFI_UDP4_SERVICE_POINT) * (NumConfiguredInstance - 1);
1849 }
1850
1851 Udp4VariableData = NetAllocatePool (VariableDataSize);
1852 if (Udp4VariableData == NULL) {
1853 return EFI_OUT_OF_RESOURCES;
1854 }
1855
1856 Udp4VariableData->DriverHandle = Udp4Service->ImageHandle;
1857 Udp4VariableData->ServiceCount = NumConfiguredInstance;
1858
1859 Udp4ServicePoint = &Udp4VariableData->Services[0];
1860
1861 //
1862 // Go through the children list to fill the configured children's address pairs.
1863 //
1864 NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) {
1865 Udp4Instance = NET_LIST_USER_STRUCT_S (
1866 Entry,
1867 UDP4_INSTANCE_DATA,
1868 Link,
1869 UDP4_INSTANCE_DATA_SIGNATURE
1870 );
1871
1872 if (Udp4Instance->Configured) {
1873 Udp4ServicePoint->InstanceHandle = Udp4Instance->ChildHandle;
1874 Udp4ServicePoint->LocalAddress = Udp4Instance->ConfigData.StationAddress;
1875 Udp4ServicePoint->LocalPort = Udp4Instance->ConfigData.StationPort;
1876 Udp4ServicePoint->RemoteAddress = Udp4Instance->ConfigData.RemoteAddress;
1877 Udp4ServicePoint->RemotePort = Udp4Instance->ConfigData.RemotePort;
1878
1879 Udp4ServicePoint++;
1880 }
1881 }
1882
1883 //
1884 // Get the mac string.
1885 //
1886 Status = NetLibGetMacString (
1887 Udp4Service->ControllerHandle,
1888 Udp4Service->ImageHandle,
1889 &NewMacString
1890 );
1891 if (EFI_ERROR (Status)) {
1892 goto ON_ERROR;
1893 }
1894
1895 if (Udp4Service->MacString != NULL) {
1896 //
1897 // The variable is set already, we're going to update it.
1898 //
1899 if (StrCmp (Udp4Service->MacString, NewMacString) != 0) {
1900 //
1901 // The mac address is changed, delete the previous variable first.
1902 //
1903 gRT->SetVariable (
1904 Udp4Service->MacString,
1905 &gEfiUdp4ServiceBindingProtocolGuid,
1906 EFI_VARIABLE_BOOTSERVICE_ACCESS,
1907 0,
1908 NULL
1909 );
1910 }
1911
1912 NetFreePool (Udp4Service->MacString);
1913 }
1914
1915 Udp4Service->MacString = NewMacString;
1916
1917 Status = gRT->SetVariable (
1918 Udp4Service->MacString,
1919 &gEfiUdp4ServiceBindingProtocolGuid,
1920 EFI_VARIABLE_BOOTSERVICE_ACCESS,
1921 VariableDataSize,
1922 (VOID *) Udp4VariableData
1923 );
1924
1925 ON_ERROR:
1926
1927 NetFreePool (Udp4VariableData);
1928
1929 return Status;
1930 }
1931
1932
1933 /**
1934 Clear the variable and free the resource.
1935
1936 @param Udp4Service Udp4 service data.
1937
1938 @return None.
1939
1940 **/
1941 VOID
1942 Udp4ClearVariableData (
1943 IN UDP4_SERVICE_DATA *Udp4Service
1944 )
1945 {
1946 ASSERT (Udp4Service->MacString != NULL);
1947
1948 gRT->SetVariable (
1949 Udp4Service->MacString,
1950 &gEfiUdp4ServiceBindingProtocolGuid,
1951 EFI_VARIABLE_BOOTSERVICE_ACCESS,
1952 0,
1953 NULL
1954 );
1955
1956 NetFreePool (Udp4Service->MacString);
1957 Udp4Service->MacString = NULL;
1958 }