2 DnsDxe support functions implementation.
4 Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Remove TokenEntry from TokenMap.
20 @param[in] TokenMap All DNSv4 Token entrys.
21 @param[in] TokenEntry TokenEntry need to be removed.
23 @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfully.
24 @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap.
28 Dns4RemoveTokenEntry (
30 IN DNS4_TOKEN_ENTRY
*TokenEntry
36 // Find the TokenEntry first.
38 Item
= NetMapFindKey (TokenMap
, (VOID
*) TokenEntry
);
42 // Remove the TokenEntry if it's found in the map.
44 NetMapRemoveItem (TokenMap
, Item
, NULL
);
53 Remove TokenEntry from TokenMap.
55 @param[in] TokenMap All DNSv6 Token entrys.
56 @param[in] TokenEntry TokenEntry need to be removed.
58 @retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfully.
59 @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap.
63 Dns6RemoveTokenEntry (
65 IN DNS6_TOKEN_ENTRY
*TokenEntry
71 // Find the TokenEntry first.
73 Item
= NetMapFindKey (TokenMap
, (VOID
*) TokenEntry
);
77 // Remove the TokenEntry if it's found in the map.
79 NetMapRemoveItem (TokenMap
, Item
, NULL
);
88 This function cancle the token specified by Arg in the Map.
90 @param[in] Map Pointer to the NET_MAP.
91 @param[in] Item Pointer to the NET_MAP_ITEM.
92 @param[in] Arg Pointer to the token to be cancelled. If NULL, all
93 the tokens in this Map will be cancelled.
94 This parameter is optional and may be NULL.
96 @retval EFI_SUCCESS The token is cancelled if Arg is NULL, or the token
97 is not the same as that in the Item, if Arg is not
99 @retval EFI_ABORTED Arg is not NULL, and the token specified by Arg is
107 IN NET_MAP_ITEM
*Item
,
108 IN VOID
*Arg OPTIONAL
111 DNS4_TOKEN_ENTRY
*TokenEntry
;
115 if ((Arg
!= NULL
) && (Item
->Key
!= Arg
)) {
119 if (Item
->Value
!= NULL
) {
121 // If the TokenEntry is a transmit TokenEntry, the corresponding Packet is recorded in
124 Packet
= (NET_BUF
*) (Item
->Value
);
125 UdpIo
= (UDP_IO
*) (*((UINTN
*) &Packet
->ProtoData
[0]));
127 UdpIoCancelSentDatagram (UdpIo
, Packet
);
131 // Remove TokenEntry from Dns4TxTokens.
133 TokenEntry
= (DNS4_TOKEN_ENTRY
*) Item
->Key
;
134 if (Dns4RemoveTokenEntry (Map
, TokenEntry
) == EFI_SUCCESS
) {
135 TokenEntry
->Token
->Status
= EFI_ABORTED
;
136 gBS
->SignalEvent (TokenEntry
->Token
->Event
);
148 This function cancle the token specified by Arg in the Map.
150 @param[in] Map Pointer to the NET_MAP.
151 @param[in] Item Pointer to the NET_MAP_ITEM.
152 @param[in] Arg Pointer to the token to be cancelled. If NULL, all
153 the tokens in this Map will be cancelled.
154 This parameter is optional and may be NULL.
156 @retval EFI_SUCCESS The token is cancelled if Arg is NULL, or the token
157 is not the same as that in the Item, if Arg is not
159 @retval EFI_ABORTED Arg is not NULL, and the token specified by Arg is
167 IN NET_MAP_ITEM
*Item
,
168 IN VOID
*Arg OPTIONAL
171 DNS6_TOKEN_ENTRY
*TokenEntry
;
175 if ((Arg
!= NULL
) && (Item
->Key
!= Arg
)) {
179 if (Item
->Value
!= NULL
) {
181 // If the TokenEntry is a transmit TokenEntry, the corresponding Packet is recorded in
184 Packet
= (NET_BUF
*) (Item
->Value
);
185 UdpIo
= (UDP_IO
*) (*((UINTN
*) &Packet
->ProtoData
[0]));
187 UdpIoCancelSentDatagram (UdpIo
, Packet
);
191 // Remove TokenEntry from Dns6TxTokens.
193 TokenEntry
= (DNS6_TOKEN_ENTRY
*) Item
->Key
;
194 if (Dns6RemoveTokenEntry (Map
, TokenEntry
) == EFI_SUCCESS
) {
195 TokenEntry
->Token
->Status
= EFI_ABORTED
;
196 gBS
->SignalEvent (TokenEntry
->Token
->Event
);
208 Get the TokenEntry from the TokensMap.
210 @param[in] TokensMap All DNSv4 Token entrys
211 @param[in] Token Pointer to the token to be get.
212 @param[out] TokenEntry Pointer to TokenEntry corresponding Token.
214 @retval EFI_SUCCESS Get the TokenEntry from the TokensMap sucessfully.
215 @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap.
221 IN NET_MAP
*TokensMap
,
222 IN EFI_DNS4_COMPLETION_TOKEN
*Token
,
223 OUT DNS4_TOKEN_ENTRY
**TokenEntry
230 NET_LIST_FOR_EACH (Entry
, &TokensMap
->Used
) {
231 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
232 *TokenEntry
= (DNS4_TOKEN_ENTRY
*) (Item
->Key
);
233 if ((*TokenEntry
)->Token
== Token
) {
240 return EFI_NOT_FOUND
;
244 Get the TokenEntry from the TokensMap.
246 @param[in] TokensMap All DNSv6 Token entrys
247 @param[in] Token Pointer to the token to be get.
248 @param[out] TokenEntry Pointer to TokenEntry corresponding Token.
250 @retval EFI_SUCCESS Get the TokenEntry from the TokensMap sucessfully.
251 @retval EFI_NOT_FOUND TokenEntry is not found in TokenMap.
257 IN NET_MAP
*TokensMap
,
258 IN EFI_DNS6_COMPLETION_TOKEN
*Token
,
259 OUT DNS6_TOKEN_ENTRY
**TokenEntry
266 NET_LIST_FOR_EACH (Entry
, &TokensMap
->Used
) {
267 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
268 *TokenEntry
= (DNS6_TOKEN_ENTRY
*) (Item
->Key
);
269 if ((*TokenEntry
)->Token
== Token
) {
276 return EFI_NOT_FOUND
;
280 Cancel DNS4 tokens from the DNS4 instance.
282 @param[in] Instance Pointer to the DNS instance context data.
283 @param[in] Token Pointer to the token to be canceled. If NULL, all
284 tokens in this instance will be cancelled.
285 This parameter is optional and may be NULL.
287 @retval EFI_SUCCESS The Token is cancelled.
288 @retval EFI_NOT_FOUND The Token is not found.
292 Dns4InstanceCancelToken (
293 IN DNS_INSTANCE
*Instance
,
294 IN EFI_DNS4_COMPLETION_TOKEN
*Token
298 DNS4_TOKEN_ENTRY
*TokenEntry
;
303 Status
= GetDns4TokenEntry (&Instance
->Dns4TxTokens
, Token
, &TokenEntry
);
304 if (EFI_ERROR (Status
)) {
312 // Cancel this TokenEntry from the Dns4TxTokens map.
314 Status
= NetMapIterate (&Instance
->Dns4TxTokens
, Dns4CancelTokens
, TokenEntry
);
316 if ((TokenEntry
!= NULL
) && (Status
== EFI_ABORTED
)) {
318 // If Token isn't NULL and Status is EFI_ABORTED, the token is cancelled from
319 // the Dns4TxTokens and returns success.
321 if (NetMapIsEmpty (&Instance
->Dns4TxTokens
)) {
322 Instance
->UdpIo
->Protocol
.Udp4
->Cancel (Instance
->UdpIo
->Protocol
.Udp4
, &Instance
->UdpIo
->RecvRequest
->Token
.Udp4
);
327 ASSERT ((TokenEntry
!= NULL
) || (0 == NetMapGetCount (&Instance
->Dns4TxTokens
)));
329 if (NetMapIsEmpty (&Instance
->Dns4TxTokens
)) {
330 Instance
->UdpIo
->Protocol
.Udp4
->Cancel (Instance
->UdpIo
->Protocol
.Udp4
, &Instance
->UdpIo
->RecvRequest
->Token
.Udp4
);
337 Cancel DNS6 tokens from the DNS6 instance.
339 @param[in] Instance Pointer to the DNS instance context data.
340 @param[in] Token Pointer to the token to be canceled. If NULL, all
341 tokens in this instance will be cancelled.
342 This parameter is optional and may be NULL.
344 @retval EFI_SUCCESS The Token is cancelled.
345 @retval EFI_NOT_FOUND The Token is not found.
349 Dns6InstanceCancelToken (
350 IN DNS_INSTANCE
*Instance
,
351 IN EFI_DNS6_COMPLETION_TOKEN
*Token
355 DNS6_TOKEN_ENTRY
*TokenEntry
;
360 Status
= GetDns6TokenEntry (&Instance
->Dns6TxTokens
, Token
, &TokenEntry
);
361 if (EFI_ERROR (Status
)) {
369 // Cancel this TokenEntry from the Dns6TxTokens map.
371 Status
= NetMapIterate (&Instance
->Dns6TxTokens
, Dns6CancelTokens
, TokenEntry
);
373 if ((TokenEntry
!= NULL
) && (Status
== EFI_ABORTED
)) {
375 // If Token isn't NULL and Status is EFI_ABORTED, the token is cancelled from
376 // the Dns6TxTokens and returns success.
378 if (NetMapIsEmpty (&Instance
->Dns6TxTokens
)) {
379 Instance
->UdpIo
->Protocol
.Udp6
->Cancel (Instance
->UdpIo
->Protocol
.Udp6
, &Instance
->UdpIo
->RecvRequest
->Token
.Udp6
);
384 ASSERT ((TokenEntry
!= NULL
) || (0 == NetMapGetCount (&Instance
->Dns6TxTokens
)));
386 if (NetMapIsEmpty (&Instance
->Dns6TxTokens
)) {
387 Instance
->UdpIo
->Protocol
.Udp6
->Cancel (Instance
->UdpIo
->Protocol
.Udp6
, &Instance
->UdpIo
->RecvRequest
->Token
.Udp6
);
394 Free the resource related to the configure parameters.
396 @param Config The DNS configure data
401 IN OUT EFI_DNS4_CONFIG_DATA
*Config
404 if (Config
->DnsServerList
!= NULL
) {
405 FreePool (Config
->DnsServerList
);
408 ZeroMem (Config
, sizeof (EFI_DNS4_CONFIG_DATA
));
412 Free the resource related to the configure parameters.
414 @param Config The DNS configure data
419 IN OUT EFI_DNS6_CONFIG_DATA
*Config
422 if (Config
->DnsServerList
!= NULL
) {
423 FreePool (Config
->DnsServerList
);
426 ZeroMem (Config
, sizeof (EFI_DNS6_CONFIG_DATA
));
430 Allocate memory for configure parameter such as timeout value for Dst,
431 then copy the configure parameter from Src to Dst.
433 @param[out] Dst The destination DHCP configure data.
434 @param[in] Src The source DHCP configure data.
436 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
437 @retval EFI_SUCCESS The configure is copied.
442 OUT EFI_DNS4_CONFIG_DATA
*Dst
,
443 IN EFI_DNS4_CONFIG_DATA
*Src
449 CopyMem (Dst
, Src
, sizeof (*Dst
));
450 Dst
->DnsServerList
= NULL
;
453 // Allocate a memory then copy DnsServerList to it
455 if (Src
->DnsServerList
!= NULL
) {
456 Len
= Src
->DnsServerListCount
* sizeof (EFI_IPv4_ADDRESS
);
457 Dst
->DnsServerList
= AllocatePool (Len
);
458 if (Dst
->DnsServerList
== NULL
) {
459 Dns4CleanConfigure (Dst
);
460 return EFI_OUT_OF_RESOURCES
;
463 for (Index
= 0; Index
< Src
->DnsServerListCount
; Index
++) {
464 CopyMem (&Dst
->DnsServerList
[Index
], &Src
->DnsServerList
[Index
], sizeof (EFI_IPv4_ADDRESS
));
472 Allocate memory for configure parameter such as timeout value for Dst,
473 then copy the configure parameter from Src to Dst.
475 @param[out] Dst The destination DHCP configure data.
476 @param[in] Src The source DHCP configure data.
478 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
479 @retval EFI_SUCCESS The configure is copied.
484 OUT EFI_DNS6_CONFIG_DATA
*Dst
,
485 IN EFI_DNS6_CONFIG_DATA
*Src
491 CopyMem (Dst
, Src
, sizeof (*Dst
));
492 Dst
->DnsServerList
= NULL
;
495 // Allocate a memory then copy DnsServerList to it
497 if (Src
->DnsServerList
!= NULL
) {
498 Len
= Src
->DnsServerCount
* sizeof (EFI_IPv6_ADDRESS
);
499 Dst
->DnsServerList
= AllocatePool (Len
);
500 if (Dst
->DnsServerList
== NULL
) {
501 Dns6CleanConfigure (Dst
);
502 return EFI_OUT_OF_RESOURCES
;
505 for (Index
= 0; Index
< Src
->DnsServerCount
; Index
++) {
506 CopyMem (&Dst
->DnsServerList
[Index
], &Src
->DnsServerList
[Index
], sizeof (EFI_IPv6_ADDRESS
));
514 Callback of Dns packet. Does nothing.
516 @param Arg The context.
528 Poll the UDP to get the IP4 default address, which may be retrieved
531 The default time out value is 5 seconds. If IP has retrieved the default address,
532 the UDP is reconfigured.
534 @param Instance The DNS instance
535 @param UdpIo The UDP_IO to poll
536 @param UdpCfgData The UDP configure data to reconfigure the UDP_IO
538 @retval TRUE The default address is retrieved and UDP is reconfigured.
539 @retval FALSE Some error occured.
544 IN DNS_INSTANCE
*Instance
,
546 IN EFI_UDP4_CONFIG_DATA
*UdpCfgData
549 DNS_SERVICE
*Service
;
550 EFI_IP4_MODE_DATA Ip4Mode
;
551 EFI_UDP4_PROTOCOL
*Udp
;
554 ASSERT (Instance
->Dns4CfgData
.UseDefaultSetting
);
556 Service
= Instance
->Service
;
557 Udp
= UdpIo
->Protocol
.Udp4
;
559 Status
= gBS
->SetTimer (
560 Service
->TimerToGetMap
,
562 DNS_TIME_TO_GETMAP
* TICKS_PER_SECOND
564 if (EFI_ERROR (Status
)) {
568 while (EFI_ERROR (gBS
->CheckEvent (Service
->TimerToGetMap
))) {
571 if (!EFI_ERROR (Udp
->GetModeData (Udp
, NULL
, &Ip4Mode
, NULL
, NULL
)) &&
572 Ip4Mode
.IsConfigured
) {
574 Udp
->Configure (Udp
, NULL
);
575 return (BOOLEAN
) (Udp
->Configure (Udp
, UdpCfgData
) == EFI_SUCCESS
);
583 Configure the opened Udp6 instance until the corresponding Ip6 instance
586 @param Instance The DNS instance
587 @param UdpIo The UDP_IO to poll
588 @param UdpCfgData The UDP configure data to reconfigure the UDP_IO
590 @retval TRUE Configure the Udp6 instance successfully.
591 @retval FALSE Some error occured.
596 IN DNS_INSTANCE
*Instance
,
598 IN EFI_UDP6_CONFIG_DATA
*UdpCfgData
601 DNS_SERVICE
*Service
;
602 EFI_IP6_MODE_DATA Ip6Mode
;
603 EFI_UDP6_PROTOCOL
*Udp
;
606 Service
= Instance
->Service
;
607 Udp
= UdpIo
->Protocol
.Udp6
;
609 Status
= gBS
->SetTimer (
610 Service
->TimerToGetMap
,
612 DNS_TIME_TO_GETMAP
* TICKS_PER_SECOND
614 if (EFI_ERROR (Status
)) {
618 while (EFI_ERROR (gBS
->CheckEvent (Service
->TimerToGetMap
))) {
621 if (!EFI_ERROR (Udp
->GetModeData (Udp
, NULL
, &Ip6Mode
, NULL
, NULL
))) {
622 if (Ip6Mode
.AddressList
!= NULL
) {
623 FreePool (Ip6Mode
.AddressList
);
626 if (Ip6Mode
.GroupTable
!= NULL
) {
627 FreePool (Ip6Mode
.GroupTable
);
630 if (Ip6Mode
.RouteTable
!= NULL
) {
631 FreePool (Ip6Mode
.RouteTable
);
634 if (Ip6Mode
.NeighborCache
!= NULL
) {
635 FreePool (Ip6Mode
.NeighborCache
);
638 if (Ip6Mode
.PrefixTable
!= NULL
) {
639 FreePool (Ip6Mode
.PrefixTable
);
642 if (Ip6Mode
.IcmpTypeList
!= NULL
) {
643 FreePool (Ip6Mode
.IcmpTypeList
);
646 if (!Ip6Mode
.IsStarted
|| Ip6Mode
.IsConfigured
) {
647 Udp
->Configure (Udp
, NULL
);
648 if (Udp
->Configure (Udp
, UdpCfgData
) == EFI_SUCCESS
) {
661 @param Instance The DNS session
662 @param UdpIo The UDP_IO instance
664 @retval EFI_SUCCESS The UDP is successfully configured for the
670 IN DNS_INSTANCE
*Instance
,
674 EFI_DNS4_CONFIG_DATA
*Config
;
675 EFI_UDP4_CONFIG_DATA UdpConfig
;
678 Config
= &Instance
->Dns4CfgData
;
680 UdpConfig
.AcceptBroadcast
= FALSE
;
681 UdpConfig
.AcceptPromiscuous
= FALSE
;
682 UdpConfig
.AcceptAnyPort
= FALSE
;
683 UdpConfig
.AllowDuplicatePort
= FALSE
;
684 UdpConfig
.TypeOfService
= 0;
685 UdpConfig
.TimeToLive
= 128;
686 UdpConfig
.DoNotFragment
= FALSE
;
687 UdpConfig
.ReceiveTimeout
= 0;
688 UdpConfig
.TransmitTimeout
= 0;
689 UdpConfig
.UseDefaultAddress
= Config
->UseDefaultSetting
;
690 UdpConfig
.SubnetMask
= Config
->SubnetMask
;
691 UdpConfig
.StationPort
= Config
->LocalPort
;
692 UdpConfig
.RemotePort
= DNS_SERVER_PORT
;
694 CopyMem (&UdpConfig
.StationAddress
, &Config
->StationIp
, sizeof (EFI_IPv4_ADDRESS
));
695 CopyMem (&UdpConfig
.RemoteAddress
, &Instance
->SessionDnsServer
.v4
, sizeof (EFI_IPv4_ADDRESS
));
697 Status
= UdpIo
->Protocol
.Udp4
->Configure (UdpIo
->Protocol
.Udp4
, &UdpConfig
);
699 if ((Status
== EFI_NO_MAPPING
) && Dns4GetMapping (Instance
, UdpIo
, &UdpConfig
)) {
709 @param Instance The DNS session
710 @param UdpIo The UDP_IO instance
712 @retval EFI_SUCCESS The UDP is successfully configured for the
718 IN DNS_INSTANCE
*Instance
,
722 EFI_DNS6_CONFIG_DATA
*Config
;
723 EFI_UDP6_CONFIG_DATA UdpConfig
;
726 Config
= &Instance
->Dns6CfgData
;
728 UdpConfig
.AcceptPromiscuous
= FALSE
;
729 UdpConfig
.AcceptAnyPort
= FALSE
;
730 UdpConfig
.AllowDuplicatePort
= FALSE
;
731 UdpConfig
.TrafficClass
= 0;
732 UdpConfig
.HopLimit
= 128;
733 UdpConfig
.ReceiveTimeout
= 0;
734 UdpConfig
.TransmitTimeout
= 0;
735 UdpConfig
.StationPort
= Config
->LocalPort
;
736 UdpConfig
.RemotePort
= DNS_SERVER_PORT
;
737 CopyMem (&UdpConfig
.StationAddress
, &Config
->StationIp
, sizeof (EFI_IPv6_ADDRESS
));
738 CopyMem (&UdpConfig
.RemoteAddress
, &Instance
->SessionDnsServer
.v6
, sizeof (EFI_IPv6_ADDRESS
));
740 Status
= UdpIo
->Protocol
.Udp6
->Configure (UdpIo
->Protocol
.Udp6
, &UdpConfig
);
742 if ((Status
== EFI_NO_MAPPING
) && Dns6GetMapping (Instance
, UdpIo
, &UdpConfig
)) {
750 Update Dns4 cache to shared list of caches of all DNSv4 instances.
752 @param Dns4CacheList All Dns4 cache list.
753 @param DeleteFlag If FALSE, this function is to add one entry to the DNS Cache.
754 If TRUE, this function will delete matching DNS Cache entry.
755 @param Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter.
756 If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.
757 @param DnsCacheEntry Entry Pointer to DNS Cache entry.
759 @retval EFI_SUCCESS Update Dns4 cache successfully.
760 @retval Others Failed to update Dns4 cache.
766 IN LIST_ENTRY
*Dns4CacheList
,
767 IN BOOLEAN DeleteFlag
,
769 IN EFI_DNS4_CACHE_ENTRY DnsCacheEntry
772 DNS4_CACHE
*NewDnsCache
;
781 // Search the database for the matching EFI_DNS_CACHE_ENTRY
783 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Dns4CacheList
) {
784 Item
= NET_LIST_USER_STRUCT (Entry
, DNS4_CACHE
, AllCacheLink
);
785 if (StrCmp (DnsCacheEntry
.HostName
, Item
->DnsCache
.HostName
) == 0 && \
786 CompareMem (DnsCacheEntry
.IpAddress
, Item
->DnsCache
.IpAddress
, sizeof (EFI_IPv4_ADDRESS
)) == 0) {
788 // This is the Dns cache entry
792 // Delete matching DNS Cache entry
794 RemoveEntryList (&Item
->AllCacheLink
);
796 FreePool (Item
->DnsCache
.HostName
);
797 FreePool (Item
->DnsCache
.IpAddress
);
801 } else if (Override
) {
805 Item
->DnsCache
.Timeout
= DnsCacheEntry
.Timeout
;
809 return EFI_ACCESS_DENIED
;
817 NewDnsCache
= AllocatePool (sizeof (DNS4_CACHE
));
818 if (NewDnsCache
== NULL
) {
819 return EFI_OUT_OF_RESOURCES
;
822 InitializeListHead (&NewDnsCache
->AllCacheLink
);
824 NewDnsCache
->DnsCache
.HostName
= AllocatePool (StrSize (DnsCacheEntry
.HostName
));
825 if (NewDnsCache
->DnsCache
.HostName
== NULL
) {
826 FreePool (NewDnsCache
);
827 return EFI_OUT_OF_RESOURCES
;
830 CopyMem (NewDnsCache
->DnsCache
.HostName
, DnsCacheEntry
.HostName
, StrSize (DnsCacheEntry
.HostName
));
832 NewDnsCache
->DnsCache
.IpAddress
= AllocatePool (sizeof (EFI_IPv4_ADDRESS
));
833 if (NewDnsCache
->DnsCache
.IpAddress
== NULL
) {
834 FreePool (NewDnsCache
->DnsCache
.HostName
);
835 FreePool (NewDnsCache
);
836 return EFI_OUT_OF_RESOURCES
;
839 CopyMem (NewDnsCache
->DnsCache
.IpAddress
, DnsCacheEntry
.IpAddress
, sizeof (EFI_IPv4_ADDRESS
));
841 NewDnsCache
->DnsCache
.Timeout
= DnsCacheEntry
.Timeout
;
843 InsertTailList (Dns4CacheList
, &NewDnsCache
->AllCacheLink
);
849 Update Dns6 cache to shared list of caches of all DNSv6 instances.
851 @param Dns6CacheList All Dns6 cache list.
852 @param DeleteFlag If FALSE, this function is to add one entry to the DNS Cache.
853 If TRUE, this function will delete matching DNS Cache entry.
854 @param Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter.
855 If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.
856 @param DnsCacheEntry Entry Pointer to DNS Cache entry.
858 @retval EFI_SUCCESS Update Dns6 cache successfully.
859 @retval Others Failed to update Dns6 cache.
864 IN LIST_ENTRY
*Dns6CacheList
,
865 IN BOOLEAN DeleteFlag
,
867 IN EFI_DNS6_CACHE_ENTRY DnsCacheEntry
870 DNS6_CACHE
*NewDnsCache
;
879 // Search the database for the matching EFI_DNS_CACHE_ENTRY
881 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Dns6CacheList
) {
882 Item
= NET_LIST_USER_STRUCT (Entry
, DNS6_CACHE
, AllCacheLink
);
883 if (StrCmp (DnsCacheEntry
.HostName
, Item
->DnsCache
.HostName
) == 0 && \
884 CompareMem (DnsCacheEntry
.IpAddress
, Item
->DnsCache
.IpAddress
, sizeof (EFI_IPv6_ADDRESS
)) == 0) {
886 // This is the Dns cache entry
890 // Delete matching DNS Cache entry
892 RemoveEntryList (&Item
->AllCacheLink
);
894 FreePool (Item
->DnsCache
.HostName
);
895 FreePool (Item
->DnsCache
.IpAddress
);
899 } else if (Override
) {
903 Item
->DnsCache
.Timeout
= DnsCacheEntry
.Timeout
;
907 return EFI_ACCESS_DENIED
;
915 NewDnsCache
= AllocatePool (sizeof (DNS6_CACHE
));
916 if (NewDnsCache
== NULL
) {
917 return EFI_OUT_OF_RESOURCES
;
920 InitializeListHead (&NewDnsCache
->AllCacheLink
);
922 NewDnsCache
->DnsCache
.HostName
= AllocatePool (StrSize (DnsCacheEntry
.HostName
));
923 if (NewDnsCache
->DnsCache
.HostName
== NULL
) {
924 FreePool (NewDnsCache
);
925 return EFI_OUT_OF_RESOURCES
;
928 CopyMem (NewDnsCache
->DnsCache
.HostName
, DnsCacheEntry
.HostName
, StrSize (DnsCacheEntry
.HostName
));
930 NewDnsCache
->DnsCache
.IpAddress
= AllocatePool (sizeof (EFI_IPv6_ADDRESS
));
931 if (NewDnsCache
->DnsCache
.IpAddress
== NULL
) {
932 FreePool (NewDnsCache
->DnsCache
.HostName
);
933 FreePool (NewDnsCache
);
934 return EFI_OUT_OF_RESOURCES
;
937 CopyMem (NewDnsCache
->DnsCache
.IpAddress
, DnsCacheEntry
.IpAddress
, sizeof (EFI_IPv6_ADDRESS
));
939 NewDnsCache
->DnsCache
.Timeout
= DnsCacheEntry
.Timeout
;
941 InsertTailList (Dns6CacheList
, &NewDnsCache
->AllCacheLink
);
947 Add Dns4 ServerIp to common list of addresses of all configured DNSv4 server.
949 @param Dns4ServerList Common list of addresses of all configured DNSv4 server.
950 @param ServerIp DNS server Ip.
952 @retval EFI_SUCCESS Add Dns4 ServerIp to common list successfully.
953 @retval Others Failed to add Dns4 ServerIp to common list.
959 IN LIST_ENTRY
*Dns4ServerList
,
960 IN EFI_IPv4_ADDRESS ServerIp
963 DNS4_SERVER_IP
*NewServerIp
;
964 DNS4_SERVER_IP
*Item
;
972 // Search the database for the matching ServerIp
974 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Dns4ServerList
) {
975 Item
= NET_LIST_USER_STRUCT (Entry
, DNS4_SERVER_IP
, AllServerLink
);
976 if (CompareMem (&Item
->Dns4ServerIp
, &ServerIp
, sizeof (EFI_IPv4_ADDRESS
)) == 0) {
987 NewServerIp
= AllocatePool (sizeof (DNS4_SERVER_IP
));
988 if (NewServerIp
== NULL
) {
989 return EFI_OUT_OF_RESOURCES
;
992 InitializeListHead (&NewServerIp
->AllServerLink
);
994 CopyMem (&NewServerIp
->Dns4ServerIp
, &ServerIp
, sizeof (EFI_IPv4_ADDRESS
));
996 InsertTailList (Dns4ServerList
, &NewServerIp
->AllServerLink
);
1002 Add Dns6 ServerIp to common list of addresses of all configured DNSv6 server.
1004 @param Dns6ServerList Common list of addresses of all configured DNSv6 server.
1005 @param ServerIp DNS server Ip.
1007 @retval EFI_SUCCESS Add Dns6 ServerIp to common list successfully.
1008 @retval Others Failed to add Dns6 ServerIp to common list.
1014 IN LIST_ENTRY
*Dns6ServerList
,
1015 IN EFI_IPv6_ADDRESS ServerIp
1018 DNS6_SERVER_IP
*NewServerIp
;
1019 DNS6_SERVER_IP
*Item
;
1027 // Search the database for the matching ServerIp
1029 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Dns6ServerList
) {
1030 Item
= NET_LIST_USER_STRUCT (Entry
, DNS6_SERVER_IP
, AllServerLink
);
1031 if (CompareMem (&Item
->Dns6ServerIp
, &ServerIp
, sizeof (EFI_IPv6_ADDRESS
)) == 0) {
1042 NewServerIp
= AllocatePool (sizeof (DNS6_SERVER_IP
));
1043 if (NewServerIp
== NULL
) {
1044 return EFI_OUT_OF_RESOURCES
;
1047 InitializeListHead (&NewServerIp
->AllServerLink
);
1049 CopyMem (&NewServerIp
->Dns6ServerIp
, &ServerIp
, sizeof (EFI_IPv6_ADDRESS
));
1051 InsertTailList (Dns6ServerList
, &NewServerIp
->AllServerLink
);
1057 Find out whether the response is valid or invalid.
1059 @param TokensMap All DNS transmittal Tokens entry.
1060 @param Identification Identification for queried packet.
1061 @param Type Type for queried packet.
1062 @param Class Class for queried packet.
1063 @param Item Return corresponding Token entry.
1065 @retval TRUE The response is valid.
1066 @retval FALSE The response is invalid.
1070 IsValidDnsResponse (
1071 IN NET_MAP
*TokensMap
,
1072 IN UINT16 Identification
,
1075 OUT NET_MAP_ITEM
**Item
1082 DNS_HEADER
*DnsHeader
;
1084 DNS_QUERY_SECTION
*QuerySection
;
1086 NET_LIST_FOR_EACH (Entry
, &TokensMap
->Used
) {
1087 *Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1088 Packet
= (NET_BUF
*) ((*Item
)->Value
);
1089 if (Packet
== NULL
){
1093 TxString
= NetbufGetByte (Packet
, 0, NULL
);
1094 ASSERT (TxString
!= NULL
);
1095 DnsHeader
= (DNS_HEADER
*) TxString
;
1096 QueryName
= (CHAR8
*) (TxString
+ sizeof (*DnsHeader
));
1097 QuerySection
= (DNS_QUERY_SECTION
*) (QueryName
+ AsciiStrLen (QueryName
) + 1);
1099 if (NTOHS (DnsHeader
->Identification
) == Identification
&&
1100 NTOHS (QuerySection
->Type
) == Type
&&
1101 NTOHS (QuerySection
->Class
) == Class
) {
1115 @param Instance The DNS instance
1116 @param RxString Received buffer.
1117 @param Length Received buffer length.
1118 @param Completed Flag to indicate that Dns response is valid.
1120 @retval EFI_SUCCESS Parse Dns Response successfully.
1121 @retval Others Failed to parse Dns Response.
1126 IN OUT DNS_INSTANCE
*Instance
,
1129 OUT BOOLEAN
*Completed
1132 DNS_HEADER
*DnsHeader
;
1135 UINT32 QueryNameLen
;
1136 DNS_QUERY_SECTION
*QuerySection
;
1139 DNS_ANSWER_SECTION
*AnswerSection
;
1143 DNS4_TOKEN_ENTRY
*Dns4TokenEntry
;
1144 DNS6_TOKEN_ENTRY
*Dns6TokenEntry
;
1148 UINT32 AnswerSectionNum
;
1151 EFI_IPv4_ADDRESS
*HostAddr4
;
1152 EFI_IPv6_ADDRESS
*HostAddr6
;
1154 EFI_DNS4_CACHE_ENTRY
*Dns4CacheEntry
;
1155 EFI_DNS6_CACHE_ENTRY
*Dns6CacheEntry
;
1157 DNS_RESOURCE_RECORD
*Dns4RR
;
1158 DNS6_RESOURCE_RECORD
*Dns6RR
;
1161 UINT32 RemainingLength
;
1166 Dns4TokenEntry
= NULL
;
1167 Dns6TokenEntry
= NULL
;
1171 AnswerSectionNum
= 0;
1177 Dns4CacheEntry
= NULL
;
1178 Dns6CacheEntry
= NULL
;
1184 Status
= EFI_SUCCESS
;
1185 RemainingLength
= Length
;
1188 // Check whether the remaining packet length is avaiable or not.
1190 if (RemainingLength
<= sizeof (DNS_HEADER
)) {
1194 RemainingLength
-= sizeof (DNS_HEADER
);
1200 DnsHeader
= (DNS_HEADER
*) RxString
;
1202 DnsHeader
->Identification
= NTOHS (DnsHeader
->Identification
);
1203 DnsHeader
->Flags
.Uint16
= NTOHS (DnsHeader
->Flags
.Uint16
);
1204 DnsHeader
->QuestionsNum
= NTOHS (DnsHeader
->QuestionsNum
);
1205 DnsHeader
->AnswersNum
= NTOHS (DnsHeader
->AnswersNum
);
1206 DnsHeader
->AuthorityNum
= NTOHS (DnsHeader
->AuthorityNum
);
1207 DnsHeader
->AditionalNum
= NTOHS (DnsHeader
->AditionalNum
);
1210 // There is always one QuestionsNum in DNS message. The capability to handle more
1211 // than one requires to redesign the message format. Currently, it's not supported.
1213 if (DnsHeader
->QuestionsNum
> 1) {
1215 return EFI_UNSUPPORTED
;
1221 QueryName
= (CHAR8
*) (RxString
+ sizeof (*DnsHeader
));
1223 QueryNameLen
= (UINT32
) AsciiStrLen (QueryName
) + 1;
1226 // Check whether the remaining packet length is avaiable or not.
1228 if (RemainingLength
<= QueryNameLen
+ sizeof (DNS_QUERY_SECTION
)) {
1232 RemainingLength
-= (QueryNameLen
+ sizeof (DNS_QUERY_SECTION
));
1236 // Get query section
1238 QuerySection
= (DNS_QUERY_SECTION
*) (QueryName
+ QueryNameLen
);
1239 QuerySection
->Type
= NTOHS (QuerySection
->Type
);
1240 QuerySection
->Class
= NTOHS (QuerySection
->Class
);
1242 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1245 // Check DnsResponse Validity, if so, also get a valid NET_MAP_ITEM.
1247 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1248 if (!IsValidDnsResponse (
1249 &Instance
->Dns4TxTokens
,
1250 DnsHeader
->Identification
,
1252 QuerySection
->Class
,
1256 Status
= EFI_ABORTED
;
1259 ASSERT (Item
!= NULL
);
1260 Dns4TokenEntry
= (DNS4_TOKEN_ENTRY
*) (Item
->Key
);
1262 if (!IsValidDnsResponse (
1263 &Instance
->Dns6TxTokens
,
1264 DnsHeader
->Identification
,
1266 QuerySection
->Class
,
1270 Status
= EFI_ABORTED
;
1273 ASSERT (Item
!= NULL
);
1274 Dns6TokenEntry
= (DNS6_TOKEN_ENTRY
*) (Item
->Key
);
1278 // Continue Check Some Errors.
1280 if (DnsHeader
->Flags
.Bits
.RCode
!= DNS_FLAGS_RCODE_NO_ERROR
|| DnsHeader
->AnswersNum
< 1 || \
1281 DnsHeader
->Flags
.Bits
.QR
!= DNS_FLAGS_QR_RESPONSE
) {
1283 // The domain name referenced in the query does not exist.
1285 if (DnsHeader
->Flags
.Bits
.RCode
== DNS_FLAGS_RCODE_NAME_ERROR
) {
1286 Status
= EFI_NOT_FOUND
;
1288 Status
= EFI_DEVICE_ERROR
;
1295 // Do some buffer allocations.
1297 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1298 ASSERT (Dns4TokenEntry
!= NULL
);
1300 if (Dns4TokenEntry
->GeneralLookUp
) {
1302 // It's the GeneralLookUp querying.
1304 Dns4TokenEntry
->Token
->RspData
.GLookupData
= AllocateZeroPool (sizeof (DNS_RESOURCE_RECORD
));
1305 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
== NULL
) {
1306 Status
= EFI_OUT_OF_RESOURCES
;
1309 Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
= AllocateZeroPool (DnsHeader
->AnswersNum
* sizeof (DNS_RESOURCE_RECORD
));
1310 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
== NULL
) {
1311 Status
= EFI_OUT_OF_RESOURCES
;
1316 // It's not the GeneralLookUp querying. Check the Query type.
1318 if (QuerySection
->Type
== DNS_TYPE_A
) {
1319 Dns4TokenEntry
->Token
->RspData
.H2AData
= AllocateZeroPool (sizeof (DNS_HOST_TO_ADDR_DATA
));
1320 if (Dns4TokenEntry
->Token
->RspData
.H2AData
== NULL
) {
1321 Status
= EFI_OUT_OF_RESOURCES
;
1324 Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
= AllocateZeroPool (DnsHeader
->AnswersNum
* sizeof (EFI_IPv4_ADDRESS
));
1325 if (Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
== NULL
) {
1326 Status
= EFI_OUT_OF_RESOURCES
;
1330 Status
= EFI_UNSUPPORTED
;
1335 ASSERT (Dns6TokenEntry
!= NULL
);
1337 if (Dns6TokenEntry
->GeneralLookUp
) {
1339 // It's the GeneralLookUp querying.
1341 Dns6TokenEntry
->Token
->RspData
.GLookupData
= AllocateZeroPool (sizeof (DNS_RESOURCE_RECORD
));
1342 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
== NULL
) {
1343 Status
= EFI_OUT_OF_RESOURCES
;
1346 Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
= AllocateZeroPool (DnsHeader
->AnswersNum
* sizeof (DNS_RESOURCE_RECORD
));
1347 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
== NULL
) {
1348 Status
= EFI_OUT_OF_RESOURCES
;
1353 // It's not the GeneralLookUp querying. Check the Query type.
1355 if (QuerySection
->Type
== DNS_TYPE_AAAA
) {
1356 Dns6TokenEntry
->Token
->RspData
.H2AData
= AllocateZeroPool (sizeof (DNS6_HOST_TO_ADDR_DATA
));
1357 if (Dns6TokenEntry
->Token
->RspData
.H2AData
== NULL
) {
1358 Status
= EFI_OUT_OF_RESOURCES
;
1361 Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
= AllocateZeroPool (DnsHeader
->AnswersNum
* sizeof (EFI_IPv6_ADDRESS
));
1362 if (Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
== NULL
) {
1363 Status
= EFI_OUT_OF_RESOURCES
;
1367 Status
= EFI_UNSUPPORTED
;
1373 Status
= EFI_NOT_FOUND
;
1378 AnswerName
= (CHAR8
*) QuerySection
+ sizeof (*QuerySection
);
1381 // Processing AnswerSection.
1383 while (AnswerSectionNum
< DnsHeader
->AnswersNum
) {
1385 // Check whether the remaining packet length is avaiable or not.
1387 if (RemainingLength
<= sizeof (UINT16
) + sizeof (DNS_ANSWER_SECTION
)) {
1389 Status
= EFI_ABORTED
;
1392 RemainingLength
-= (sizeof (UINT16
) + sizeof (DNS_ANSWER_SECTION
));
1396 // Answer name should be PTR, else EFI_UNSUPPORTED returned.
1398 if ((*(UINT8
*) AnswerName
& 0xC0) != 0xC0) {
1399 Status
= EFI_UNSUPPORTED
;
1404 // Get Answer section.
1406 AnswerSection
= (DNS_ANSWER_SECTION
*) (AnswerName
+ sizeof (UINT16
));
1407 AnswerSection
->Type
= NTOHS (AnswerSection
->Type
);
1408 AnswerSection
->Class
= NTOHS (AnswerSection
->Class
);
1409 AnswerSection
->Ttl
= NTOHL (AnswerSection
->Ttl
);
1410 AnswerSection
->DataLength
= NTOHS (AnswerSection
->DataLength
);
1413 // Check whether the remaining packet length is avaiable or not.
1415 if (RemainingLength
< AnswerSection
->DataLength
) {
1417 Status
= EFI_ABORTED
;
1420 RemainingLength
-= AnswerSection
->DataLength
;
1424 // Check whether it's the GeneralLookUp querying.
1426 if (Instance
->Service
->IpVersion
== IP_VERSION_4
&& Dns4TokenEntry
->GeneralLookUp
) {
1427 Dns4RR
= Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
;
1428 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1431 // Fill the ResourceRecord.
1433 Dns4RR
[RRCount
].QName
= AllocateZeroPool (AsciiStrLen (QueryName
) + 1);
1434 if (Dns4RR
[RRCount
].QName
== NULL
) {
1435 Status
= EFI_OUT_OF_RESOURCES
;
1438 CopyMem (Dns4RR
[RRCount
].QName
, QueryName
, AsciiStrLen (QueryName
));
1439 Dns4RR
[RRCount
].QType
= AnswerSection
->Type
;
1440 Dns4RR
[RRCount
].QClass
= AnswerSection
->Class
;
1441 Dns4RR
[RRCount
].TTL
= AnswerSection
->Ttl
;
1442 Dns4RR
[RRCount
].DataLength
= AnswerSection
->DataLength
;
1443 Dns4RR
[RRCount
].RData
= AllocateZeroPool (Dns4RR
[RRCount
].DataLength
);
1444 if (Dns4RR
[RRCount
].RData
== NULL
) {
1445 Status
= EFI_OUT_OF_RESOURCES
;
1448 CopyMem (Dns4RR
[RRCount
].RData
, AnswerData
, Dns4RR
[RRCount
].DataLength
);
1451 Status
= EFI_SUCCESS
;
1452 } else if (Instance
->Service
->IpVersion
== IP_VERSION_6
&& Dns6TokenEntry
->GeneralLookUp
) {
1453 Dns6RR
= Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
;
1454 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1457 // Fill the ResourceRecord.
1459 Dns6RR
[RRCount
].QName
= AllocateZeroPool (AsciiStrLen (QueryName
) + 1);
1460 if (Dns6RR
[RRCount
].QName
== NULL
) {
1461 Status
= EFI_OUT_OF_RESOURCES
;
1464 CopyMem (Dns6RR
[RRCount
].QName
, QueryName
, AsciiStrLen (QueryName
));
1465 Dns6RR
[RRCount
].QType
= AnswerSection
->Type
;
1466 Dns6RR
[RRCount
].QClass
= AnswerSection
->Class
;
1467 Dns6RR
[RRCount
].TTL
= AnswerSection
->Ttl
;
1468 Dns6RR
[RRCount
].DataLength
= AnswerSection
->DataLength
;
1469 Dns6RR
[RRCount
].RData
= AllocateZeroPool (Dns6RR
[RRCount
].DataLength
);
1470 if (Dns6RR
[RRCount
].RData
== NULL
) {
1471 Status
= EFI_OUT_OF_RESOURCES
;
1474 CopyMem (Dns6RR
[RRCount
].RData
, AnswerData
, Dns6RR
[RRCount
].DataLength
);
1477 Status
= EFI_SUCCESS
;
1480 // It's not the GeneralLookUp querying.
1481 // Check the Query type, parse the response packet.
1483 switch (AnswerSection
->Type
) {
1486 // This is address entry, get Data.
1488 ASSERT (Dns4TokenEntry
!= NULL
);
1490 if (AnswerSection
->DataLength
!= 4) {
1491 Status
= EFI_ABORTED
;
1495 HostAddr4
= Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
;
1496 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1497 CopyMem (&HostAddr4
[IpCount
], AnswerData
, sizeof (EFI_IPv4_ADDRESS
));
1500 // Allocate new CacheEntry pool to update DNS cache dynamically.
1502 Dns4CacheEntry
= AllocateZeroPool (sizeof (EFI_DNS4_CACHE_ENTRY
));
1503 if (Dns4CacheEntry
== NULL
) {
1504 Status
= EFI_OUT_OF_RESOURCES
;
1507 Dns4CacheEntry
->HostName
= AllocateZeroPool (2 * (StrLen(Dns4TokenEntry
->QueryHostName
) + 1));
1508 if (Dns4CacheEntry
->HostName
== NULL
) {
1509 Status
= EFI_OUT_OF_RESOURCES
;
1512 CopyMem (Dns4CacheEntry
->HostName
, Dns4TokenEntry
->QueryHostName
, 2 * (StrLen(Dns4TokenEntry
->QueryHostName
) + 1));
1513 Dns4CacheEntry
->IpAddress
= AllocateZeroPool (sizeof (EFI_IPv4_ADDRESS
));
1514 if (Dns4CacheEntry
->IpAddress
== NULL
) {
1515 Status
= EFI_OUT_OF_RESOURCES
;
1518 CopyMem (Dns4CacheEntry
->IpAddress
, AnswerData
, sizeof (EFI_IPv4_ADDRESS
));
1520 if (CNameTtl
!= 0 && AnswerSection
->Ttl
!= 0) {
1521 Dns4CacheEntry
->Timeout
= MIN (CNameTtl
, AnswerSection
->Ttl
);
1523 Dns4CacheEntry
->Timeout
= MAX (CNameTtl
, AnswerSection
->Ttl
);
1526 UpdateDns4Cache (&mDriverData
->Dns4CacheList
, FALSE
, TRUE
, *Dns4CacheEntry
);
1529 // Free allocated CacheEntry pool.
1531 FreePool (Dns4CacheEntry
->HostName
);
1532 Dns4CacheEntry
->HostName
= NULL
;
1534 FreePool (Dns4CacheEntry
->IpAddress
);
1535 Dns4CacheEntry
->IpAddress
= NULL
;
1537 FreePool (Dns4CacheEntry
);
1538 Dns4CacheEntry
= NULL
;
1541 Status
= EFI_SUCCESS
;
1545 // This is address entry, get Data.
1547 ASSERT (Dns6TokenEntry
!= NULL
);
1549 if (AnswerSection
->DataLength
!= 16) {
1550 Status
= EFI_ABORTED
;
1554 HostAddr6
= Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
;
1555 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1556 CopyMem (&HostAddr6
[IpCount
], AnswerData
, sizeof (EFI_IPv6_ADDRESS
));
1559 // Allocate new CacheEntry pool to update DNS cache dynamically.
1561 Dns6CacheEntry
= AllocateZeroPool (sizeof (EFI_DNS6_CACHE_ENTRY
));
1562 if (Dns6CacheEntry
== NULL
) {
1563 Status
= EFI_OUT_OF_RESOURCES
;
1566 Dns6CacheEntry
->HostName
= AllocateZeroPool (2 * (StrLen(Dns6TokenEntry
->QueryHostName
) + 1));
1567 if (Dns6CacheEntry
->HostName
== NULL
) {
1568 Status
= EFI_OUT_OF_RESOURCES
;
1571 CopyMem (Dns6CacheEntry
->HostName
, Dns6TokenEntry
->QueryHostName
, 2 * (StrLen(Dns6TokenEntry
->QueryHostName
) + 1));
1572 Dns6CacheEntry
->IpAddress
= AllocateZeroPool (sizeof (EFI_IPv6_ADDRESS
));
1573 if (Dns6CacheEntry
->IpAddress
== NULL
) {
1574 Status
= EFI_OUT_OF_RESOURCES
;
1577 CopyMem (Dns6CacheEntry
->IpAddress
, AnswerData
, sizeof (EFI_IPv6_ADDRESS
));
1579 if (CNameTtl
!= 0 && AnswerSection
->Ttl
!= 0) {
1580 Dns6CacheEntry
->Timeout
= MIN (CNameTtl
, AnswerSection
->Ttl
);
1582 Dns6CacheEntry
->Timeout
= MAX (CNameTtl
, AnswerSection
->Ttl
);
1585 UpdateDns6Cache (&mDriverData
->Dns6CacheList
, FALSE
, TRUE
, *Dns6CacheEntry
);
1588 // Free allocated CacheEntry pool.
1590 FreePool (Dns6CacheEntry
->HostName
);
1591 Dns6CacheEntry
->HostName
= NULL
;
1593 FreePool (Dns6CacheEntry
->IpAddress
);
1594 Dns6CacheEntry
->IpAddress
= NULL
;
1596 FreePool (Dns6CacheEntry
);
1597 Dns6CacheEntry
= NULL
;
1600 Status
= EFI_SUCCESS
;
1602 case DNS_TYPE_CNAME
:
1604 // According RFC 1034 - 3.6.2, if the query name is an alias, the name server will include the CNAME
1605 // record in the response and restart the query at the domain name specified in the data field of the
1606 // CNAME record. So, just record the TTL value of the CNAME, then skip to parse the next record.
1608 CNameTtl
= AnswerSection
->Ttl
;
1611 Status
= EFI_UNSUPPORTED
;
1619 AnswerName
= (CHAR8
*) AnswerSection
+ sizeof (*AnswerSection
) + AnswerSection
->DataLength
;
1620 AnswerSectionNum
++;
1623 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1624 ASSERT (Dns4TokenEntry
!= NULL
);
1626 if (Dns4TokenEntry
->GeneralLookUp
) {
1627 Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRCount
= RRCount
;
1629 if (QuerySection
->Type
== DNS_TYPE_A
) {
1630 Dns4TokenEntry
->Token
->RspData
.H2AData
->IpCount
= IpCount
;
1632 Status
= EFI_UNSUPPORTED
;
1637 ASSERT (Dns6TokenEntry
!= NULL
);
1639 if (Dns6TokenEntry
->GeneralLookUp
) {
1640 Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRCount
= RRCount
;
1642 if (QuerySection
->Type
== DNS_TYPE_AAAA
) {
1643 Dns6TokenEntry
->Token
->RspData
.H2AData
->IpCount
= IpCount
;
1645 Status
= EFI_UNSUPPORTED
;
1653 // Parsing is complete, free the sending packet and signal Event here.
1655 if (Item
!= NULL
&& Item
->Value
!= NULL
) {
1656 NetbufFree ((NET_BUF
*) (Item
->Value
));
1659 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1660 ASSERT (Dns4TokenEntry
!= NULL
);
1661 Dns4RemoveTokenEntry (&Instance
->Dns4TxTokens
, Dns4TokenEntry
);
1662 Dns4TokenEntry
->Token
->Status
= Status
;
1663 if (Dns4TokenEntry
->Token
->Event
!= NULL
) {
1664 gBS
->SignalEvent (Dns4TokenEntry
->Token
->Event
);
1668 ASSERT (Dns6TokenEntry
!= NULL
);
1669 Dns6RemoveTokenEntry (&Instance
->Dns6TxTokens
, Dns6TokenEntry
);
1670 Dns6TokenEntry
->Token
->Status
= Status
;
1671 if (Dns6TokenEntry
->Token
->Event
!= NULL
) {
1672 gBS
->SignalEvent (Dns6TokenEntry
->Token
->Event
);
1679 // Free the allocated buffer if error happen.
1681 if (EFI_ERROR (Status
)) {
1682 if (Dns4TokenEntry
!= NULL
) {
1683 if (Dns4TokenEntry
->GeneralLookUp
) {
1684 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
!= NULL
) {
1685 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
!= NULL
) {
1686 while (RRCount
!= 0) {
1688 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
[RRCount
].QName
!= NULL
) {
1689 FreePool (Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
[RRCount
].QName
);
1692 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
[RRCount
].RData
!= NULL
) {
1693 FreePool (Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
[RRCount
].RData
);
1697 FreePool (Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
);
1700 FreePool (Dns4TokenEntry
->Token
->RspData
.GLookupData
);
1703 if (QuerySection
->Type
== DNS_TYPE_A
&& Dns4TokenEntry
->Token
->RspData
.H2AData
!= NULL
) {
1704 if (Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
!= NULL
) {
1705 FreePool (Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
);
1708 FreePool (Dns4TokenEntry
->Token
->RspData
.H2AData
);
1713 if (Dns6TokenEntry
!= NULL
) {
1714 if (Dns6TokenEntry
->GeneralLookUp
) {
1715 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
!= NULL
) {
1716 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
!= NULL
) {
1717 while (RRCount
!= 0) {
1719 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
[RRCount
].QName
!= NULL
) {
1720 FreePool (Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
[RRCount
].QName
);
1723 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
[RRCount
].RData
!= NULL
) {
1724 FreePool (Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
[RRCount
].RData
);
1728 FreePool (Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
);
1731 FreePool (Dns6TokenEntry
->Token
->RspData
.GLookupData
);
1734 if (QuerySection
->Type
== DNS_TYPE_AAAA
&& Dns6TokenEntry
->Token
->RspData
.H2AData
!= NULL
) {
1735 if (Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
!= NULL
) {
1736 FreePool (Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
);
1739 FreePool (Dns6TokenEntry
->Token
->RspData
.H2AData
);
1744 if (Dns4CacheEntry
!= NULL
) {
1745 if (Dns4CacheEntry
->HostName
!= NULL
) {
1746 FreePool (Dns4CacheEntry
->HostName
);
1749 if (Dns4CacheEntry
->IpAddress
!= NULL
) {
1750 FreePool (Dns4CacheEntry
->IpAddress
);
1753 FreePool (Dns4CacheEntry
);
1756 if (Dns6CacheEntry
!= NULL
) {
1757 if (Dns6CacheEntry
->HostName
!= NULL
) {
1758 FreePool (Dns6CacheEntry
->HostName
);
1761 if (Dns6CacheEntry
->IpAddress
!= NULL
) {
1762 FreePool (Dns6CacheEntry
->IpAddress
);
1765 FreePool (Dns6CacheEntry
);
1769 gBS
->RestoreTPL (OldTpl
);
1774 Parse response packet.
1776 @param Packet The packets received.
1777 @param EndPoint The local/remote UDP access point
1778 @param IoStatus The status of the UDP receive
1779 @param Context The opaque parameter to the function.
1784 DnsOnPacketReceived (
1786 UDP_END_POINT
*EndPoint
,
1787 EFI_STATUS IoStatus
,
1791 DNS_INSTANCE
*Instance
;
1798 Instance
= (DNS_INSTANCE
*) Context
;
1799 NET_CHECK_SIGNATURE (Instance
, DNS_INSTANCE_SIGNATURE
);
1804 if (EFI_ERROR (IoStatus
)) {
1808 ASSERT (Packet
!= NULL
);
1810 Len
= Packet
->TotalSize
;
1812 RcvString
= NetbufGetByte (Packet
, 0, NULL
);
1813 ASSERT (RcvString
!= NULL
);
1816 // Parse Dns Response
1818 ParseDnsResponse (Instance
, RcvString
, Len
, &Completed
);
1822 if (Packet
!= NULL
) {
1823 NetbufFree (Packet
);
1827 UdpIoRecvDatagram (Instance
->UdpIo
, DnsOnPacketReceived
, Instance
, 0);
1832 Release the net buffer when packet is sent.
1834 @param Packet The packets received.
1835 @param EndPoint The local/remote UDP access point
1836 @param IoStatus The status of the UDP receive
1837 @param Context The opaque parameter to the function.
1844 UDP_END_POINT
*EndPoint
,
1845 EFI_STATUS IoStatus
,
1849 DNS_INSTANCE
*Instance
;
1852 DNS4_TOKEN_ENTRY
*Dns4TokenEntry
;
1853 DNS6_TOKEN_ENTRY
*Dns6TokenEntry
;
1855 Dns4TokenEntry
= NULL
;
1856 Dns6TokenEntry
= NULL
;
1858 Instance
= (DNS_INSTANCE
*) Context
;
1859 NET_CHECK_SIGNATURE (Instance
, DNS_INSTANCE_SIGNATURE
);
1861 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1862 NET_LIST_FOR_EACH (Entry
, &Instance
->Dns4TxTokens
.Used
) {
1863 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1864 if (Packet
== (NET_BUF
*)(Item
->Value
)) {
1865 Dns4TokenEntry
= ((DNS4_TOKEN_ENTRY
*)Item
->Key
);
1866 Dns4TokenEntry
->PacketToLive
= Dns4TokenEntry
->Token
->RetryInterval
;
1871 NET_LIST_FOR_EACH (Entry
, &Instance
->Dns6TxTokens
.Used
) {
1872 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1873 if (Packet
== (NET_BUF
*)(Item
->Value
)) {
1874 Dns6TokenEntry
= ((DNS6_TOKEN_ENTRY
*)Item
->Key
);
1875 Dns6TokenEntry
->PacketToLive
= Dns6TokenEntry
->Token
->RetryInterval
;
1881 NetbufFree (Packet
);
1885 Query request information.
1887 @param Instance The DNS instance
1888 @param Packet The packet for querying request information.
1890 @retval EFI_SUCCESS Query request information successfully.
1891 @retval Others Failed to query request information.
1896 IN DNS_INSTANCE
*Instance
,
1903 // Ready to receive the DNS response.
1905 if (Instance
->UdpIo
->RecvRequest
== NULL
) {
1906 Status
= UdpIoRecvDatagram (Instance
->UdpIo
, DnsOnPacketReceived
, Instance
, 0);
1907 if (EFI_ERROR (Status
)) {
1913 // Transmit the DNS packet.
1915 NET_GET_REF (Packet
);
1917 Status
= UdpIoSendDatagram (Instance
->UdpIo
, Packet
, NULL
, NULL
, DnsOnPacketSent
, Instance
);
1923 Construct the Packet according query section.
1925 @param Instance The DNS instance
1926 @param QueryName Queried Name
1927 @param Type Queried Type
1928 @param Class Queried Class
1929 @param Packet The packet for query
1931 @retval EFI_SUCCESS The packet is constructed.
1932 @retval Others Failed to construct the Packet.
1937 IN DNS_INSTANCE
*Instance
,
1938 IN CHAR8
*QueryName
,
1941 OUT NET_BUF
**Packet
1945 DNS_HEADER
*DnsHeader
;
1946 DNS_QUERY_SECTION
*DnsQuery
;
1949 // Messages carried by UDP are restricted to 512 bytes (not counting the IP
1952 Frag
.Bulk
= AllocatePool (DNS_MAX_MESSAGE_SIZE
* sizeof (UINT8
));
1953 if (Frag
.Bulk
== NULL
) {
1954 return EFI_OUT_OF_RESOURCES
;
1960 DnsHeader
= (DNS_HEADER
*) Frag
.Bulk
;
1961 DnsHeader
->Identification
= (UINT16
)NET_RANDOM (NetRandomInitSeed());
1962 DnsHeader
->Flags
.Uint16
= 0x0000;
1963 DnsHeader
->Flags
.Bits
.RD
= 1;
1964 DnsHeader
->Flags
.Bits
.OpCode
= DNS_FLAGS_OPCODE_STANDARD
;
1965 DnsHeader
->Flags
.Bits
.QR
= DNS_FLAGS_QR_QUERY
;
1966 DnsHeader
->QuestionsNum
= 1;
1967 DnsHeader
->AnswersNum
= 0;
1968 DnsHeader
->AuthorityNum
= 0;
1969 DnsHeader
->AditionalNum
= 0;
1971 DnsHeader
->Identification
= HTONS (DnsHeader
->Identification
);
1972 DnsHeader
->Flags
.Uint16
= HTONS (DnsHeader
->Flags
.Uint16
);
1973 DnsHeader
->QuestionsNum
= HTONS (DnsHeader
->QuestionsNum
);
1974 DnsHeader
->AnswersNum
= HTONS (DnsHeader
->AnswersNum
);
1975 DnsHeader
->AuthorityNum
= HTONS (DnsHeader
->AuthorityNum
);
1976 DnsHeader
->AditionalNum
= HTONS (DnsHeader
->AditionalNum
);
1978 Frag
.Len
= sizeof (*DnsHeader
);
1983 CopyMem (Frag
.Bulk
+ Frag
.Len
, QueryName
, AsciiStrLen (QueryName
));
1984 Frag
.Len
= (UINT32
) (Frag
.Len
+ AsciiStrLen (QueryName
));
1985 *(Frag
.Bulk
+ Frag
.Len
) = 0;
1989 // Rest query section
1991 DnsQuery
= (DNS_QUERY_SECTION
*) (Frag
.Bulk
+ Frag
.Len
);
1993 DnsQuery
->Type
= HTONS (Type
);
1994 DnsQuery
->Class
= HTONS (Class
);
1996 Frag
.Len
+= sizeof (*DnsQuery
);
1999 // Wrap the Frag in a net buffer.
2001 *Packet
= NetbufFromExt (&Frag
, 1, 0, 0, DnsDummyExtFree
, NULL
);
2002 if (*Packet
== NULL
) {
2003 FreePool (Frag
.Bulk
);
2004 return EFI_OUT_OF_RESOURCES
;
2008 // Store the UdpIo in ProtoData.
2010 *((UINTN
*) &((*Packet
)->ProtoData
[0])) = (UINTN
) (Instance
->UdpIo
);
2016 Retransmit the packet.
2018 @param Instance The DNS instance
2019 @param Packet Retransmit the packet
2021 @retval EFI_SUCCESS The packet is retransmitted.
2022 @retval Others Failed to retransmit.
2027 IN DNS_INSTANCE
*Instance
,
2035 ASSERT (Packet
!= NULL
);
2038 // Set the requests to the listening port, other packets to the connected port
2040 Buffer
= NetbufGetByte (Packet
, 0, NULL
);
2041 ASSERT (Buffer
!= NULL
);
2043 NET_GET_REF (Packet
);
2045 Status
= UdpIoSendDatagram (
2054 if (EFI_ERROR (Status
)) {
2055 NET_PUT_REF (Packet
);
2062 The timer ticking function for the DNS services.
2064 @param Event The ticking event
2065 @param Context The DNS service instance
2070 DnsOnTimerRetransmit (
2075 DNS_SERVICE
*Service
;
2080 DNS_INSTANCE
*Instance
;
2081 LIST_ENTRY
*EntryNetMap
;
2082 NET_MAP_ITEM
*ItemNetMap
;
2083 DNS4_TOKEN_ENTRY
*Dns4TokenEntry
;
2084 DNS6_TOKEN_ENTRY
*Dns6TokenEntry
;
2086 Dns4TokenEntry
= NULL
;
2087 Dns6TokenEntry
= NULL
;
2089 Service
= (DNS_SERVICE
*) Context
;
2092 if (Service
->IpVersion
== IP_VERSION_4
) {
2094 // Iterate through all the children of the DNS service instance. Time
2095 // out the packet. If maximum retries reached, clean the Token up.
2097 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Service
->Dns4ChildrenList
) {
2098 Instance
= NET_LIST_USER_STRUCT (Entry
, DNS_INSTANCE
, Link
);
2100 EntryNetMap
= Instance
->Dns4TxTokens
.Used
.ForwardLink
;
2101 while (EntryNetMap
!= &Instance
->Dns4TxTokens
.Used
) {
2102 ItemNetMap
= NET_LIST_USER_STRUCT (EntryNetMap
, NET_MAP_ITEM
, Link
);
2103 Dns4TokenEntry
= (DNS4_TOKEN_ENTRY
*)(ItemNetMap
->Key
);
2104 if (Dns4TokenEntry
->PacketToLive
== 0 || (--Dns4TokenEntry
->PacketToLive
> 0)) {
2105 EntryNetMap
= EntryNetMap
->ForwardLink
;
2110 // Retransmit the packet if haven't reach the maxmium retry count,
2111 // otherwise exit the transfer.
2113 if (++Dns4TokenEntry
->RetryCounting
<= Dns4TokenEntry
->Token
->RetryCount
) {
2114 DnsRetransmit (Instance
, (NET_BUF
*)ItemNetMap
->Value
);
2115 EntryNetMap
= EntryNetMap
->ForwardLink
;
2118 // Maximum retries reached, clean the Token up.
2120 Dns4RemoveTokenEntry (&Instance
->Dns4TxTokens
, Dns4TokenEntry
);
2121 Dns4TokenEntry
->Token
->Status
= EFI_TIMEOUT
;
2122 gBS
->SignalEvent (Dns4TokenEntry
->Token
->Event
);
2126 // Free the sending packet.
2128 if (ItemNetMap
->Value
!= NULL
) {
2129 NetbufFree ((NET_BUF
*)(ItemNetMap
->Value
));
2132 EntryNetMap
= Instance
->Dns4TxTokens
.Used
.ForwardLink
;
2138 // Iterate through all the children of the DNS service instance. Time
2139 // out the packet. If maximum retries reached, clean the Token up.
2141 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Service
->Dns6ChildrenList
) {
2142 Instance
= NET_LIST_USER_STRUCT (Entry
, DNS_INSTANCE
, Link
);
2144 EntryNetMap
= Instance
->Dns6TxTokens
.Used
.ForwardLink
;
2145 while (EntryNetMap
!= &Instance
->Dns6TxTokens
.Used
) {
2146 ItemNetMap
= NET_LIST_USER_STRUCT (EntryNetMap
, NET_MAP_ITEM
, Link
);
2147 Dns6TokenEntry
= (DNS6_TOKEN_ENTRY
*) (ItemNetMap
->Key
);
2148 if (Dns6TokenEntry
->PacketToLive
== 0 || (--Dns6TokenEntry
->PacketToLive
> 0)) {
2149 EntryNetMap
= EntryNetMap
->ForwardLink
;
2154 // Retransmit the packet if haven't reach the maxmium retry count,
2155 // otherwise exit the transfer.
2157 if (++Dns6TokenEntry
->RetryCounting
<= Dns6TokenEntry
->Token
->RetryCount
) {
2158 DnsRetransmit (Instance
, (NET_BUF
*) ItemNetMap
->Value
);
2159 EntryNetMap
= EntryNetMap
->ForwardLink
;
2162 // Maximum retries reached, clean the Token up.
2164 Dns6RemoveTokenEntry (&Instance
->Dns6TxTokens
, Dns6TokenEntry
);
2165 Dns6TokenEntry
->Token
->Status
= EFI_TIMEOUT
;
2166 gBS
->SignalEvent (Dns6TokenEntry
->Token
->Event
);
2170 // Free the sending packet.
2172 if (ItemNetMap
->Value
!= NULL
) {
2173 NetbufFree ((NET_BUF
*) (ItemNetMap
->Value
));
2176 EntryNetMap
= Instance
->Dns6TxTokens
.Used
.ForwardLink
;
2184 The timer ticking function for the DNS driver.
2186 @param Event The ticking event
2206 // Iterate through all the DNS4 cache list.
2208 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &mDriverData
->Dns4CacheList
) {
2209 Item4
= NET_LIST_USER_STRUCT (Entry
, DNS4_CACHE
, AllCacheLink
);
2210 Item4
->DnsCache
.Timeout
--;
2213 Entry
= mDriverData
->Dns4CacheList
.ForwardLink
;
2214 while (Entry
!= &mDriverData
->Dns4CacheList
) {
2215 Item4
= NET_LIST_USER_STRUCT (Entry
, DNS4_CACHE
, AllCacheLink
);
2216 if (Item4
->DnsCache
.Timeout
== 0) {
2217 RemoveEntryList (&Item4
->AllCacheLink
);
2218 FreePool (Item4
->DnsCache
.HostName
);
2219 FreePool (Item4
->DnsCache
.IpAddress
);
2221 Entry
= mDriverData
->Dns4CacheList
.ForwardLink
;
2223 Entry
= Entry
->ForwardLink
;
2228 // Iterate through all the DNS6 cache list.
2230 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &mDriverData
->Dns6CacheList
) {
2231 Item6
= NET_LIST_USER_STRUCT (Entry
, DNS6_CACHE
, AllCacheLink
);
2232 Item6
->DnsCache
.Timeout
--;
2235 Entry
= mDriverData
->Dns6CacheList
.ForwardLink
;
2236 while (Entry
!= &mDriverData
->Dns6CacheList
) {
2237 Item6
= NET_LIST_USER_STRUCT (Entry
, DNS6_CACHE
, AllCacheLink
);
2238 if (Item6
->DnsCache
.Timeout
== 0) {
2239 RemoveEntryList (&Item6
->AllCacheLink
);
2240 FreePool (Item6
->DnsCache
.HostName
);
2241 FreePool (Item6
->DnsCache
.IpAddress
);
2243 Entry
= mDriverData
->Dns6CacheList
.ForwardLink
;
2245 Entry
= Entry
->ForwardLink
;