2 DnsDxe support functions implementation.
4 Copyright (c) 2016, 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
.IsConfigured
) {
647 Udp
->Configure (Udp
, NULL
);
648 return (BOOLEAN
) (Udp
->Configure (Udp
, UdpCfgData
) == EFI_SUCCESS
);
659 @param Instance The DNS session
660 @param UdpIo The UDP_IO instance
662 @retval EFI_SUCCESS The UDP is successfully configured for the
668 IN DNS_INSTANCE
*Instance
,
672 EFI_DNS4_CONFIG_DATA
*Config
;
673 EFI_UDP4_CONFIG_DATA UdpConfig
;
676 Config
= &Instance
->Dns4CfgData
;
678 UdpConfig
.AcceptBroadcast
= FALSE
;
679 UdpConfig
.AcceptPromiscuous
= FALSE
;
680 UdpConfig
.AcceptAnyPort
= FALSE
;
681 UdpConfig
.AllowDuplicatePort
= FALSE
;
682 UdpConfig
.TypeOfService
= 0;
683 UdpConfig
.TimeToLive
= 128;
684 UdpConfig
.DoNotFragment
= FALSE
;
685 UdpConfig
.ReceiveTimeout
= 0;
686 UdpConfig
.TransmitTimeout
= 0;
687 UdpConfig
.UseDefaultAddress
= Config
->UseDefaultSetting
;
688 UdpConfig
.SubnetMask
= Config
->SubnetMask
;
689 UdpConfig
.StationPort
= Config
->LocalPort
;
690 UdpConfig
.RemotePort
= DNS_SERVER_PORT
;
692 CopyMem (&UdpConfig
.StationAddress
, &Config
->StationIp
, sizeof (EFI_IPv4_ADDRESS
));
693 CopyMem (&UdpConfig
.RemoteAddress
, &Instance
->SessionDnsServer
.v4
, sizeof (EFI_IPv4_ADDRESS
));
695 Status
= UdpIo
->Protocol
.Udp4
->Configure (UdpIo
->Protocol
.Udp4
, &UdpConfig
);
697 if ((Status
== EFI_NO_MAPPING
) && Dns4GetMapping (Instance
, UdpIo
, &UdpConfig
)) {
707 @param Instance The DNS session
708 @param UdpIo The UDP_IO instance
710 @retval EFI_SUCCESS The UDP is successfully configured for the
716 IN DNS_INSTANCE
*Instance
,
720 EFI_DNS6_CONFIG_DATA
*Config
;
721 EFI_UDP6_CONFIG_DATA UdpConfig
;
724 Config
= &Instance
->Dns6CfgData
;
726 UdpConfig
.AcceptPromiscuous
= FALSE
;
727 UdpConfig
.AcceptAnyPort
= FALSE
;
728 UdpConfig
.AllowDuplicatePort
= FALSE
;
729 UdpConfig
.TrafficClass
= 0;
730 UdpConfig
.HopLimit
= 128;
731 UdpConfig
.ReceiveTimeout
= 0;
732 UdpConfig
.TransmitTimeout
= 0;
733 UdpConfig
.StationPort
= Config
->LocalPort
;
734 UdpConfig
.RemotePort
= DNS_SERVER_PORT
;
735 CopyMem (&UdpConfig
.StationAddress
, &Config
->StationIp
, sizeof (EFI_IPv6_ADDRESS
));
736 CopyMem (&UdpConfig
.RemoteAddress
, &Instance
->SessionDnsServer
.v6
, sizeof (EFI_IPv6_ADDRESS
));
738 Status
= UdpIo
->Protocol
.Udp6
->Configure (UdpIo
->Protocol
.Udp6
, &UdpConfig
);
740 if ((Status
== EFI_NO_MAPPING
) && Dns6GetMapping (Instance
, UdpIo
, &UdpConfig
)) {
748 Update Dns4 cache to shared list of caches of all DNSv4 instances.
750 @param Dns4CacheList All Dns4 cache list.
751 @param DeleteFlag If FALSE, this function is to add one entry to the DNS Cache.
752 If TRUE, this function will delete matching DNS Cache entry.
753 @param Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter.
754 If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.
755 @param DnsCacheEntry Entry Pointer to DNS Cache entry.
757 @retval EFI_SUCCESS Update Dns4 cache successfully.
758 @retval Others Failed to update Dns4 cache.
764 IN LIST_ENTRY
*Dns4CacheList
,
765 IN BOOLEAN DeleteFlag
,
767 IN EFI_DNS4_CACHE_ENTRY DnsCacheEntry
770 DNS4_CACHE
*NewDnsCache
;
779 // Search the database for the matching EFI_DNS_CACHE_ENTRY
781 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Dns4CacheList
) {
782 Item
= NET_LIST_USER_STRUCT (Entry
, DNS4_CACHE
, AllCacheLink
);
783 if (StrCmp (DnsCacheEntry
.HostName
, Item
->DnsCache
.HostName
) == 0 && \
784 CompareMem (DnsCacheEntry
.IpAddress
, Item
->DnsCache
.IpAddress
, sizeof (EFI_IPv4_ADDRESS
)) == 0) {
786 // This is the Dns cache entry
790 // Delete matching DNS Cache entry
792 RemoveEntryList (&Item
->AllCacheLink
);
795 } else if (Override
) {
799 Item
->DnsCache
.Timeout
= DnsCacheEntry
.Timeout
;
803 return EFI_ACCESS_DENIED
;
811 NewDnsCache
= AllocatePool (sizeof (DNS4_CACHE
));
812 if (NewDnsCache
== NULL
) {
813 return EFI_OUT_OF_RESOURCES
;
816 InitializeListHead (&NewDnsCache
->AllCacheLink
);
818 NewDnsCache
->DnsCache
.HostName
= AllocatePool (StrSize (DnsCacheEntry
.HostName
));
819 if (NewDnsCache
->DnsCache
.HostName
== NULL
) {
820 return EFI_OUT_OF_RESOURCES
;
823 CopyMem (NewDnsCache
->DnsCache
.HostName
, DnsCacheEntry
.HostName
, StrSize (DnsCacheEntry
.HostName
));
825 NewDnsCache
->DnsCache
.IpAddress
= AllocatePool (sizeof (EFI_IPv4_ADDRESS
));
826 if (NewDnsCache
->DnsCache
.IpAddress
== NULL
) {
827 return EFI_OUT_OF_RESOURCES
;
830 CopyMem (NewDnsCache
->DnsCache
.IpAddress
, DnsCacheEntry
.IpAddress
, sizeof (EFI_IPv4_ADDRESS
));
832 NewDnsCache
->DnsCache
.Timeout
= DnsCacheEntry
.Timeout
;
834 InsertTailList (Dns4CacheList
, &NewDnsCache
->AllCacheLink
);
840 Update Dns6 cache to shared list of caches of all DNSv6 instances.
842 @param Dns6CacheList All Dns6 cache list.
843 @param DeleteFlag If FALSE, this function is to add one entry to the DNS Cache.
844 If TRUE, this function will delete matching DNS Cache entry.
845 @param Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter.
846 If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.
847 @param DnsCacheEntry Entry Pointer to DNS Cache entry.
849 @retval EFI_SUCCESS Update Dns6 cache successfully.
850 @retval Others Failed to update Dns6 cache.
855 IN LIST_ENTRY
*Dns6CacheList
,
856 IN BOOLEAN DeleteFlag
,
858 IN EFI_DNS6_CACHE_ENTRY DnsCacheEntry
861 DNS6_CACHE
*NewDnsCache
;
870 // Search the database for the matching EFI_DNS_CACHE_ENTRY
872 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Dns6CacheList
) {
873 Item
= NET_LIST_USER_STRUCT (Entry
, DNS6_CACHE
, AllCacheLink
);
874 if (StrCmp (DnsCacheEntry
.HostName
, Item
->DnsCache
.HostName
) == 0 && \
875 CompareMem (DnsCacheEntry
.IpAddress
, Item
->DnsCache
.IpAddress
, sizeof (EFI_IPv6_ADDRESS
)) == 0) {
877 // This is the Dns cache entry
881 // Delete matching DNS Cache entry
883 RemoveEntryList (&Item
->AllCacheLink
);
886 } else if (Override
) {
890 Item
->DnsCache
.Timeout
= DnsCacheEntry
.Timeout
;
894 return EFI_ACCESS_DENIED
;
902 NewDnsCache
= AllocatePool (sizeof (DNS6_CACHE
));
903 if (NewDnsCache
== NULL
) {
904 return EFI_OUT_OF_RESOURCES
;
907 InitializeListHead (&NewDnsCache
->AllCacheLink
);
909 NewDnsCache
->DnsCache
.HostName
= AllocatePool (StrSize (DnsCacheEntry
.HostName
));
910 if (NewDnsCache
->DnsCache
.HostName
== NULL
) {
911 return EFI_OUT_OF_RESOURCES
;
914 CopyMem (NewDnsCache
->DnsCache
.HostName
, DnsCacheEntry
.HostName
, StrSize (DnsCacheEntry
.HostName
));
916 NewDnsCache
->DnsCache
.IpAddress
= AllocatePool (sizeof (EFI_IPv6_ADDRESS
));
917 if (NewDnsCache
->DnsCache
.IpAddress
== NULL
) {
918 return EFI_OUT_OF_RESOURCES
;
921 CopyMem (NewDnsCache
->DnsCache
.IpAddress
, DnsCacheEntry
.IpAddress
, sizeof (EFI_IPv6_ADDRESS
));
923 NewDnsCache
->DnsCache
.Timeout
= DnsCacheEntry
.Timeout
;
925 InsertTailList (Dns6CacheList
, &NewDnsCache
->AllCacheLink
);
931 Add Dns4 ServerIp to common list of addresses of all configured DNSv4 server.
933 @param Dns4ServerList Common list of addresses of all configured DNSv4 server.
934 @param ServerIp DNS server Ip.
936 @retval EFI_SUCCESS Add Dns4 ServerIp to common list successfully.
937 @retval Others Failed to add Dns4 ServerIp to common list.
943 IN LIST_ENTRY
*Dns4ServerList
,
944 IN EFI_IPv4_ADDRESS ServerIp
947 DNS4_SERVER_IP
*NewServerIp
;
948 DNS4_SERVER_IP
*Item
;
956 // Search the database for the matching ServerIp
958 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Dns4ServerList
) {
959 Item
= NET_LIST_USER_STRUCT (Entry
, DNS4_SERVER_IP
, AllServerLink
);
960 if (CompareMem (&Item
->Dns4ServerIp
, &ServerIp
, sizeof (EFI_IPv4_ADDRESS
)) == 0) {
971 NewServerIp
= AllocatePool (sizeof (DNS4_SERVER_IP
));
972 if (NewServerIp
== NULL
) {
973 return EFI_OUT_OF_RESOURCES
;
976 InitializeListHead (&NewServerIp
->AllServerLink
);
978 CopyMem (&NewServerIp
->Dns4ServerIp
, &ServerIp
, sizeof (EFI_IPv4_ADDRESS
));
980 InsertTailList (Dns4ServerList
, &NewServerIp
->AllServerLink
);
986 Add Dns6 ServerIp to common list of addresses of all configured DNSv6 server.
988 @param Dns6ServerList Common list of addresses of all configured DNSv6 server.
989 @param ServerIp DNS server Ip.
991 @retval EFI_SUCCESS Add Dns6 ServerIp to common list successfully.
992 @retval Others Failed to add Dns6 ServerIp to common list.
998 IN LIST_ENTRY
*Dns6ServerList
,
999 IN EFI_IPv6_ADDRESS ServerIp
1002 DNS6_SERVER_IP
*NewServerIp
;
1003 DNS6_SERVER_IP
*Item
;
1011 // Search the database for the matching ServerIp
1013 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Dns6ServerList
) {
1014 Item
= NET_LIST_USER_STRUCT (Entry
, DNS6_SERVER_IP
, AllServerLink
);
1015 if (CompareMem (&Item
->Dns6ServerIp
, &ServerIp
, sizeof (EFI_IPv6_ADDRESS
)) == 0) {
1026 NewServerIp
= AllocatePool (sizeof (DNS6_SERVER_IP
));
1027 if (NewServerIp
== NULL
) {
1028 return EFI_OUT_OF_RESOURCES
;
1031 InitializeListHead (&NewServerIp
->AllServerLink
);
1033 CopyMem (&NewServerIp
->Dns6ServerIp
, &ServerIp
, sizeof (EFI_IPv6_ADDRESS
));
1035 InsertTailList (Dns6ServerList
, &NewServerIp
->AllServerLink
);
1041 Fill QName for IP querying. QName is a domain name represented as
1042 a sequence of labels, where each label consists of a length octet
1043 followed by that number of octets. The domain name terminates with
1044 the zero length octet for the null label of the root. Caller should
1045 take responsibility to the buffer in QName.
1047 @param HostName Queried HostName
1049 @retval NULL Failed to fill QName.
1050 @return QName filled successfully.
1055 DnsFillinQNameForQueryIp (
1069 QueryName
= AllocateZeroPool (DNS_DEFAULT_BLKSIZE
);
1070 if (QueryName
== NULL
) {
1077 for (Index
= 0; HostName
[Index
] != 0; Index
++) {
1078 *Tail
= (CHAR8
) HostName
[Index
];
1080 *Header
= (CHAR8
) Len
;
1089 *Header
= (CHAR8
) Len
;
1096 Find out whether the response is valid or invalid.
1098 @param TokensMap All DNS transmittal Tokens entry.
1099 @param Identification Identification for queried packet.
1100 @param Type Type for queried packet.
1101 @param Item Return corresponding Token entry.
1103 @retval TRUE The response is valid.
1104 @retval FALSE The response is invalid.
1108 IsValidDnsResponse (
1109 IN NET_MAP
*TokensMap
,
1110 IN UINT16 Identification
,
1112 OUT NET_MAP_ITEM
**Item
1119 DNS_HEADER
*DnsHeader
;
1121 DNS_QUERY_SECTION
*QuerySection
;
1123 NET_LIST_FOR_EACH (Entry
, &TokensMap
->Used
) {
1124 *Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1125 Packet
= (NET_BUF
*) ((*Item
)->Value
);
1126 if (Packet
== NULL
){
1130 TxString
= NetbufGetByte (Packet
, 0, NULL
);
1131 ASSERT (TxString
!= NULL
);
1132 DnsHeader
= (DNS_HEADER
*) TxString
;
1133 QueryName
= (CHAR8
*) (TxString
+ sizeof (*DnsHeader
));
1134 QuerySection
= (DNS_QUERY_SECTION
*) (QueryName
+ AsciiStrLen (QueryName
) + 1);
1136 DnsHeader
->Identification
= NTOHS (DnsHeader
->Identification
);
1137 QuerySection
->Type
= NTOHS (QuerySection
->Type
);
1139 if (DnsHeader
->Identification
== Identification
&& QuerySection
->Type
== Type
) {
1153 @param Instance The DNS instance
1154 @param RxString Received buffer.
1155 @param Completed Flag to indicate that Dns response is valid.
1157 @retval EFI_SUCCESS Parse Dns Response successfully.
1158 @retval Others Failed to parse Dns Response.
1163 IN OUT DNS_INSTANCE
*Instance
,
1165 OUT BOOLEAN
*Completed
1168 DNS_HEADER
*DnsHeader
;
1171 DNS_QUERY_SECTION
*QuerySection
;
1174 DNS_ANSWER_SECTION
*AnswerSection
;
1178 DNS4_TOKEN_ENTRY
*Dns4TokenEntry
;
1179 DNS6_TOKEN_ENTRY
*Dns6TokenEntry
;
1183 UINT32 AnswerSectionNum
;
1185 EFI_IPv4_ADDRESS
*HostAddr4
;
1186 EFI_IPv6_ADDRESS
*HostAddr6
;
1188 EFI_DNS4_CACHE_ENTRY
*Dns4CacheEntry
;
1189 EFI_DNS6_CACHE_ENTRY
*Dns6CacheEntry
;
1191 DNS_RESOURCE_RECORD
*Dns4RR
;
1192 DNS6_RESOURCE_RECORD
*Dns6RR
;
1199 Dns4TokenEntry
= NULL
;
1200 Dns6TokenEntry
= NULL
;
1204 AnswerSectionNum
= 0;
1209 Dns4CacheEntry
= NULL
;
1210 Dns6CacheEntry
= NULL
;
1216 Status
= EFI_SUCCESS
;
1221 DnsHeader
= (DNS_HEADER
*) RxString
;
1223 DnsHeader
->Identification
= NTOHS (DnsHeader
->Identification
);
1224 DnsHeader
->Flags
.Uint16
= NTOHS (DnsHeader
->Flags
.Uint16
);
1225 DnsHeader
->QuestionsNum
= NTOHS (DnsHeader
->QuestionsNum
);
1226 DnsHeader
->AnswersNum
= NTOHS (DnsHeader
->AnswersNum
);
1227 DnsHeader
->AuthorityNum
= NTOHS (DnsHeader
->AuthorityNum
);
1228 DnsHeader
->AditionalNum
= NTOHS (DnsHeader
->AditionalNum
);
1233 QueryName
= (CHAR8
*) (RxString
+ sizeof (*DnsHeader
));
1236 // Get query section
1238 QuerySection
= (DNS_QUERY_SECTION
*) (QueryName
+ AsciiStrLen (QueryName
) + 1);
1239 QuerySection
->Type
= NTOHS (QuerySection
->Type
);
1240 QuerySection
->Class
= NTOHS (QuerySection
->Class
);
1245 AnswerName
= (CHAR8
*) QuerySection
+ sizeof (*QuerySection
);
1247 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1250 // Check DnsResponse Validity, if so, also get a valid NET_MAP_ITEM.
1252 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1253 if (!IsValidDnsResponse (&Instance
->Dns4TxTokens
, DnsHeader
->Identification
, QuerySection
->Type
, &Item
)) {
1255 Status
= EFI_ABORTED
;
1258 ASSERT (Item
!= NULL
);
1259 Dns4TokenEntry
= (DNS4_TOKEN_ENTRY
*) (Item
->Key
);
1261 if (!IsValidDnsResponse (&Instance
->Dns6TxTokens
, DnsHeader
->Identification
, QuerySection
->Type
, &Item
)) {
1263 Status
= EFI_ABORTED
;
1266 ASSERT (Item
!= NULL
);
1267 Dns6TokenEntry
= (DNS6_TOKEN_ENTRY
*) (Item
->Key
);
1271 // Continue Check Some Errors.
1273 if (DnsHeader
->Flags
.Bits
.RCode
!= DNS_FLAGS_RCODE_NO_ERROR
|| DnsHeader
->AnswersNum
< 1 || \
1274 DnsHeader
->Flags
.Bits
.QR
!= DNS_FLAGS_QR_RESPONSE
|| QuerySection
->Class
!= DNS_CLASS_INET
) {
1275 Status
= EFI_ABORTED
;
1280 // Free the sending packet.
1282 if (Item
->Value
!= NULL
) {
1283 NetbufFree ((NET_BUF
*) (Item
->Value
));
1287 // Do some buffer allocations.
1289 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1290 ASSERT (Dns4TokenEntry
!= NULL
);
1292 if (Dns4TokenEntry
->GeneralLookUp
) {
1294 // It's the GeneralLookUp querying.
1296 Dns4TokenEntry
->Token
->RspData
.GLookupData
= AllocatePool (sizeof (DNS_RESOURCE_RECORD
));
1297 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
== NULL
) {
1298 Status
= EFI_OUT_OF_RESOURCES
;
1301 Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
= AllocatePool (DnsHeader
->AnswersNum
* sizeof (DNS_RESOURCE_RECORD
));
1302 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
== NULL
) {
1303 Status
= EFI_OUT_OF_RESOURCES
;
1308 // It's not the GeneralLookUp querying. Check the Query type.
1310 if (QuerySection
->Type
== DNS_TYPE_A
) {
1311 Dns4TokenEntry
->Token
->RspData
.H2AData
= AllocatePool (sizeof (DNS_HOST_TO_ADDR_DATA
));
1312 if (Dns4TokenEntry
->Token
->RspData
.H2AData
== NULL
) {
1313 Status
= EFI_OUT_OF_RESOURCES
;
1316 Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
= AllocatePool (DnsHeader
->AnswersNum
* sizeof (EFI_IPv4_ADDRESS
));
1317 if (Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
== NULL
) {
1318 Status
= EFI_OUT_OF_RESOURCES
;
1322 Status
= EFI_UNSUPPORTED
;
1327 ASSERT (Dns6TokenEntry
!= NULL
);
1329 if (Dns6TokenEntry
->GeneralLookUp
) {
1331 // It's the GeneralLookUp querying.
1333 Dns6TokenEntry
->Token
->RspData
.GLookupData
= AllocatePool (sizeof (DNS_RESOURCE_RECORD
));
1334 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
== NULL
) {
1335 Status
= EFI_UNSUPPORTED
;
1338 Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
= AllocatePool (DnsHeader
->AnswersNum
* sizeof (DNS_RESOURCE_RECORD
));
1339 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
== NULL
) {
1340 Status
= EFI_UNSUPPORTED
;
1345 // It's not the GeneralLookUp querying. Check the Query type.
1347 if (QuerySection
->Type
== DNS_TYPE_AAAA
) {
1348 Dns6TokenEntry
->Token
->RspData
.H2AData
= AllocatePool (sizeof (DNS6_HOST_TO_ADDR_DATA
));
1349 if (Dns6TokenEntry
->Token
->RspData
.H2AData
== NULL
) {
1350 Status
= EFI_UNSUPPORTED
;
1353 Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
= AllocatePool (DnsHeader
->AnswersNum
* sizeof (EFI_IPv6_ADDRESS
));
1354 if (Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
== NULL
) {
1355 Status
= EFI_UNSUPPORTED
;
1359 Status
= EFI_UNSUPPORTED
;
1366 // Processing AnswerSection.
1368 while (AnswerSectionNum
< DnsHeader
->AnswersNum
) {
1370 // Answer name should be PTR.
1372 ASSERT ((*(UINT8
*) AnswerName
& 0xC0) == 0xC0);
1375 // Get Answer section.
1377 AnswerSection
= (DNS_ANSWER_SECTION
*) (AnswerName
+ sizeof (UINT16
));
1378 AnswerSection
->Type
= NTOHS (AnswerSection
->Type
);
1379 AnswerSection
->Class
= NTOHS (AnswerSection
->Class
);
1380 AnswerSection
->Ttl
= NTOHL (AnswerSection
->Ttl
);
1381 AnswerSection
->DataLength
= NTOHS (AnswerSection
->DataLength
);
1384 // Check whether it's the GeneralLookUp querying.
1386 if (Instance
->Service
->IpVersion
== IP_VERSION_4
&& Dns4TokenEntry
->GeneralLookUp
) {
1387 Dns4RR
= Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
;
1388 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1391 // Fill the ResourceRecord.
1393 Dns4RR
[RRCount
].QName
= AllocateZeroPool (AsciiStrLen (QueryName
) + 1);
1394 if (Dns4RR
[RRCount
].QName
== NULL
) {
1395 Status
= EFI_UNSUPPORTED
;
1398 CopyMem (Dns4RR
[RRCount
].QName
, QueryName
, AsciiStrLen (QueryName
));
1399 Dns4RR
[RRCount
].QType
= AnswerSection
->Type
;
1400 Dns4RR
[RRCount
].QClass
= AnswerSection
->Class
;
1401 Dns4RR
[RRCount
].TTL
= AnswerSection
->Ttl
;
1402 Dns4RR
[RRCount
].DataLength
= AnswerSection
->DataLength
;
1403 Dns4RR
[RRCount
].RData
= AllocateZeroPool (Dns4RR
[RRCount
].DataLength
);
1404 if (Dns4RR
[RRCount
].RData
== NULL
) {
1405 Status
= EFI_UNSUPPORTED
;
1408 CopyMem (Dns4RR
[RRCount
].RData
, AnswerData
, Dns4RR
[RRCount
].DataLength
);
1411 } else if (Instance
->Service
->IpVersion
== IP_VERSION_6
&& Dns6TokenEntry
->GeneralLookUp
) {
1412 Dns6RR
= Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
;
1413 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1416 // Fill the ResourceRecord.
1418 Dns6RR
[RRCount
].QName
= AllocateZeroPool (AsciiStrLen (QueryName
) + 1);
1419 if (Dns6RR
[RRCount
].QName
== NULL
) {
1420 Status
= EFI_UNSUPPORTED
;
1423 CopyMem (Dns6RR
[RRCount
].QName
, QueryName
, AsciiStrLen (QueryName
));
1424 Dns6RR
[RRCount
].QType
= AnswerSection
->Type
;
1425 Dns6RR
[RRCount
].QClass
= AnswerSection
->Class
;
1426 Dns6RR
[RRCount
].TTL
= AnswerSection
->Ttl
;
1427 Dns6RR
[RRCount
].DataLength
= AnswerSection
->DataLength
;
1428 Dns6RR
[RRCount
].RData
= AllocateZeroPool (Dns6RR
[RRCount
].DataLength
);
1429 if (Dns6RR
[RRCount
].RData
== NULL
) {
1430 Status
= EFI_UNSUPPORTED
;
1433 CopyMem (Dns6RR
[RRCount
].RData
, AnswerData
, Dns6RR
[RRCount
].DataLength
);
1438 // It's not the GeneralLookUp querying.
1439 // Check the Query type, parse the response packet.
1441 switch (AnswerSection
->Type
) {
1444 // This is address entry, get Data.
1446 ASSERT (Dns4TokenEntry
!= NULL
&& AnswerSection
->DataLength
== 4);
1448 HostAddr4
= Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
;
1449 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1450 CopyMem (&HostAddr4
[IpCount
], AnswerData
, sizeof (EFI_IPv4_ADDRESS
));
1453 // Update DNS cache dynamically.
1455 if (Dns4CacheEntry
!= NULL
) {
1456 if (Dns4CacheEntry
->HostName
!= NULL
) {
1457 FreePool (Dns4CacheEntry
->HostName
);
1460 if (Dns4CacheEntry
->IpAddress
!= NULL
) {
1461 FreePool (Dns4CacheEntry
->IpAddress
);
1464 FreePool (Dns4CacheEntry
);
1468 // Allocate new CacheEntry pool.
1470 Dns4CacheEntry
= AllocateZeroPool (sizeof (EFI_DNS4_CACHE_ENTRY
));
1471 if (Dns4CacheEntry
== NULL
) {
1472 Status
= EFI_UNSUPPORTED
;
1475 Dns4CacheEntry
->HostName
= AllocateZeroPool (2 * (StrLen(Dns4TokenEntry
->QueryHostName
) + 1));
1476 if (Dns4CacheEntry
->HostName
== NULL
) {
1477 Status
= EFI_UNSUPPORTED
;
1480 CopyMem (Dns4CacheEntry
->HostName
, Dns4TokenEntry
->QueryHostName
, 2 * (StrLen(Dns4TokenEntry
->QueryHostName
) + 1));
1481 Dns4CacheEntry
->IpAddress
= AllocateZeroPool (sizeof (EFI_IPv4_ADDRESS
));
1482 if (Dns4CacheEntry
->IpAddress
== NULL
) {
1483 Status
= EFI_UNSUPPORTED
;
1486 CopyMem (Dns4CacheEntry
->IpAddress
, AnswerData
, sizeof (EFI_IPv4_ADDRESS
));
1487 Dns4CacheEntry
->Timeout
= AnswerSection
->Ttl
;
1489 UpdateDns4Cache (&mDriverData
->Dns4CacheList
, FALSE
, TRUE
, *Dns4CacheEntry
);
1495 // This is address entry, get Data.
1497 ASSERT (Dns6TokenEntry
!= NULL
&& AnswerSection
->DataLength
== 16);
1499 HostAddr6
= Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
;
1500 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1501 CopyMem (&HostAddr6
[IpCount
], AnswerData
, sizeof (EFI_IPv6_ADDRESS
));
1504 // Update DNS cache dynamically.
1506 if (Dns6CacheEntry
!= NULL
) {
1507 if (Dns6CacheEntry
->HostName
!= NULL
) {
1508 FreePool (Dns6CacheEntry
->HostName
);
1511 if (Dns6CacheEntry
->IpAddress
!= NULL
) {
1512 FreePool (Dns6CacheEntry
->IpAddress
);
1515 FreePool (Dns6CacheEntry
);
1519 // Allocate new CacheEntry pool.
1521 Dns6CacheEntry
= AllocateZeroPool (sizeof (EFI_DNS6_CACHE_ENTRY
));
1522 if (Dns6CacheEntry
== NULL
) {
1523 Status
= EFI_UNSUPPORTED
;
1526 Dns6CacheEntry
->HostName
= AllocateZeroPool (2 * (StrLen(Dns6TokenEntry
->QueryHostName
) + 1));
1527 if (Dns6CacheEntry
->HostName
== NULL
) {
1528 Status
= EFI_UNSUPPORTED
;
1531 CopyMem (Dns6CacheEntry
->HostName
, Dns6TokenEntry
->QueryHostName
, 2 * (StrLen(Dns6TokenEntry
->QueryHostName
) + 1));
1532 Dns6CacheEntry
->IpAddress
= AllocateZeroPool (sizeof (EFI_IPv6_ADDRESS
));
1533 if (Dns6CacheEntry
->IpAddress
== NULL
) {
1534 Status
= EFI_UNSUPPORTED
;
1537 CopyMem (Dns6CacheEntry
->IpAddress
, AnswerData
, sizeof (EFI_IPv6_ADDRESS
));
1538 Dns6CacheEntry
->Timeout
= AnswerSection
->Ttl
;
1540 UpdateDns6Cache (&mDriverData
->Dns6CacheList
, FALSE
, TRUE
, *Dns6CacheEntry
);
1545 Status
= EFI_UNSUPPORTED
;
1553 AnswerName
= (CHAR8
*) AnswerSection
+ sizeof (*AnswerSection
) + AnswerSection
->DataLength
;
1554 AnswerSectionNum
++;
1557 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1558 ASSERT (Dns4TokenEntry
!= NULL
);
1560 if (Dns4TokenEntry
->GeneralLookUp
) {
1561 Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRCount
= RRCount
;
1563 if (QuerySection
->Type
== DNS_TYPE_A
) {
1564 Dns4TokenEntry
->Token
->RspData
.H2AData
->IpCount
= IpCount
;
1566 Status
= EFI_UNSUPPORTED
;
1571 ASSERT (Dns6TokenEntry
!= NULL
);
1573 if (Dns6TokenEntry
->GeneralLookUp
) {
1574 Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRCount
= RRCount
;
1576 if (QuerySection
->Type
== DNS_TYPE_AAAA
) {
1577 Dns6TokenEntry
->Token
->RspData
.H2AData
->IpCount
= IpCount
;
1579 Status
= EFI_UNSUPPORTED
;
1586 // Parsing is complete, SignalEvent here.
1588 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1589 ASSERT (Dns4TokenEntry
!= NULL
);
1590 Dns4RemoveTokenEntry (&Instance
->Dns4TxTokens
, Dns4TokenEntry
);
1591 Dns4TokenEntry
->Token
->Status
= EFI_SUCCESS
;
1592 if (Dns4TokenEntry
->Token
->Event
!= NULL
) {
1593 gBS
->SignalEvent (Dns4TokenEntry
->Token
->Event
);
1597 ASSERT (Dns6TokenEntry
!= NULL
);
1598 Dns6RemoveTokenEntry (&Instance
->Dns6TxTokens
, Dns6TokenEntry
);
1599 Dns6TokenEntry
->Token
->Status
= EFI_SUCCESS
;
1600 if (Dns6TokenEntry
->Token
->Event
!= NULL
) {
1601 gBS
->SignalEvent (Dns6TokenEntry
->Token
->Event
);
1607 // Free allocated CacheEntry pool.
1609 if (Dns4CacheEntry
!= NULL
) {
1610 if (Dns4CacheEntry
->HostName
!= NULL
) {
1611 FreePool (Dns4CacheEntry
->HostName
);
1614 if (Dns4CacheEntry
->IpAddress
!= NULL
) {
1615 FreePool (Dns4CacheEntry
->IpAddress
);
1618 FreePool (Dns4CacheEntry
);
1621 if (Dns6CacheEntry
!= NULL
) {
1622 if (Dns6CacheEntry
->HostName
!= NULL
) {
1623 FreePool (Dns6CacheEntry
->HostName
);
1626 if (Dns6CacheEntry
->IpAddress
!= NULL
) {
1627 FreePool (Dns6CacheEntry
->IpAddress
);
1630 FreePool (Dns6CacheEntry
);
1634 gBS
->RestoreTPL (OldTpl
);
1639 Parse response packet.
1641 @param Packet The packets received.
1642 @param EndPoint The local/remote UDP access point
1643 @param IoStatus The status of the UDP receive
1644 @param Context The opaque parameter to the function.
1649 DnsOnPacketReceived (
1651 UDP_END_POINT
*EndPoint
,
1652 EFI_STATUS IoStatus
,
1656 DNS_INSTANCE
*Instance
;
1662 Instance
= (DNS_INSTANCE
*) Context
;
1663 NET_CHECK_SIGNATURE (Instance
, DNS_INSTANCE_SIGNATURE
);
1668 if (EFI_ERROR (IoStatus
)) {
1672 ASSERT (Packet
!= NULL
);
1674 RcvString
= NetbufGetByte (Packet
, 0, NULL
);
1675 ASSERT (RcvString
!= NULL
);
1678 // Parse Dns Response
1680 ParseDnsResponse (Instance
, RcvString
, &Completed
);
1684 if (Packet
!= NULL
) {
1685 NetbufFree (Packet
);
1689 UdpIoRecvDatagram (Instance
->UdpIo
, DnsOnPacketReceived
, Instance
, 0);
1694 Release the net buffer when packet is sent.
1696 @param Packet The packets received.
1697 @param EndPoint The local/remote UDP access point
1698 @param IoStatus The status of the UDP receive
1699 @param Context The opaque parameter to the function.
1706 UDP_END_POINT
*EndPoint
,
1707 EFI_STATUS IoStatus
,
1711 DNS_INSTANCE
*Instance
;
1714 DNS4_TOKEN_ENTRY
*Dns4TokenEntry
;
1715 DNS6_TOKEN_ENTRY
*Dns6TokenEntry
;
1717 Dns4TokenEntry
= NULL
;
1718 Dns6TokenEntry
= NULL
;
1720 Instance
= (DNS_INSTANCE
*) Context
;
1721 NET_CHECK_SIGNATURE (Instance
, DNS_INSTANCE_SIGNATURE
);
1723 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1724 NET_LIST_FOR_EACH (Entry
, &Instance
->Dns4TxTokens
.Used
) {
1725 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1726 if (Packet
== (NET_BUF
*)(Item
->Value
)) {
1727 Dns4TokenEntry
= ((DNS4_TOKEN_ENTRY
*)Item
->Key
);
1728 Dns4TokenEntry
->PacketToLive
= Dns4TokenEntry
->Token
->RetryInterval
;
1733 NET_LIST_FOR_EACH (Entry
, &Instance
->Dns6TxTokens
.Used
) {
1734 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1735 if (Packet
== (NET_BUF
*)(Item
->Value
)) {
1736 Dns6TokenEntry
= ((DNS6_TOKEN_ENTRY
*)Item
->Key
);
1737 Dns6TokenEntry
->PacketToLive
= Dns6TokenEntry
->Token
->RetryInterval
;
1743 NetbufFree (Packet
);
1747 Query request information.
1749 @param Instance The DNS instance
1750 @param Packet The packet for querying request information.
1752 @retval EFI_SUCCESS Query request information successfully.
1753 @retval Others Failed to query request information.
1758 IN DNS_INSTANCE
*Instance
,
1765 // Ready to receive the DNS response.
1767 if (Instance
->UdpIo
->RecvRequest
== NULL
) {
1768 Status
= UdpIoRecvDatagram (Instance
->UdpIo
, DnsOnPacketReceived
, Instance
, 0);
1769 if (EFI_ERROR (Status
)) {
1775 // Transmit the DNS packet.
1777 NET_GET_REF (Packet
);
1779 Status
= UdpIoSendDatagram (Instance
->UdpIo
, Packet
, NULL
, NULL
, DnsOnPacketSent
, Instance
);
1785 Construct the Packet according query section.
1787 @param Instance The DNS instance
1788 @param QueryName Queried Name
1789 @param Type Queried Type
1790 @param Class Queried Class
1791 @param Packet The packet for query
1793 @retval EFI_SUCCESS The packet is constructed.
1794 @retval Others Failed to construct the Packet.
1799 IN DNS_INSTANCE
*Instance
,
1800 IN CHAR8
*QueryName
,
1803 OUT NET_BUF
**Packet
1807 DNS_HEADER
*DnsHeader
;
1808 DNS_QUERY_SECTION
*DnsQuery
;
1810 Frag
.Bulk
= AllocatePool (DNS_DEFAULT_BLKSIZE
* sizeof (UINT8
));
1811 if (Frag
.Bulk
== NULL
) {
1812 return EFI_OUT_OF_RESOURCES
;
1818 DnsHeader
= (DNS_HEADER
*) Frag
.Bulk
;
1819 DnsHeader
->Identification
= (UINT16
)NET_RANDOM (NetRandomInitSeed());
1820 DnsHeader
->Flags
.Uint16
= 0x0000;
1821 DnsHeader
->Flags
.Bits
.RD
= 1;
1822 DnsHeader
->Flags
.Bits
.OpCode
= DNS_FLAGS_OPCODE_STANDARD
;
1823 DnsHeader
->Flags
.Bits
.QR
= DNS_FLAGS_QR_QUERY
;
1824 DnsHeader
->QuestionsNum
= 1;
1825 DnsHeader
->AnswersNum
= 0;
1826 DnsHeader
->AuthorityNum
= 0;
1827 DnsHeader
->AditionalNum
= 0;
1829 DnsHeader
->Identification
= HTONS (DnsHeader
->Identification
);
1830 DnsHeader
->Flags
.Uint16
= HTONS (DnsHeader
->Flags
.Uint16
);
1831 DnsHeader
->QuestionsNum
= HTONS (DnsHeader
->QuestionsNum
);
1832 DnsHeader
->AnswersNum
= HTONS (DnsHeader
->AnswersNum
);
1833 DnsHeader
->AuthorityNum
= HTONS (DnsHeader
->AuthorityNum
);
1834 DnsHeader
->AditionalNum
= HTONS (DnsHeader
->AditionalNum
);
1836 Frag
.Len
= sizeof (*DnsHeader
);
1841 CopyMem (Frag
.Bulk
+ Frag
.Len
, QueryName
, AsciiStrLen (QueryName
));
1842 Frag
.Len
= (UINT32
) (Frag
.Len
+ AsciiStrLen (QueryName
));
1843 *(Frag
.Bulk
+ Frag
.Len
) = 0;
1847 // Rest query section
1849 DnsQuery
= (DNS_QUERY_SECTION
*) (Frag
.Bulk
+ Frag
.Len
);
1851 DnsQuery
->Type
= HTONS (Type
);
1852 DnsQuery
->Class
= HTONS (Class
);
1854 Frag
.Len
+= sizeof (*DnsQuery
);
1857 // Wrap the Frag in a net buffer.
1859 *Packet
= NetbufFromExt (&Frag
, 1, 0, 0, DnsDummyExtFree
, NULL
);
1860 if (*Packet
== NULL
) {
1861 FreePool (Frag
.Bulk
);
1862 return EFI_OUT_OF_RESOURCES
;
1866 // Store the UdpIo in ProtoData.
1868 *((UINTN
*) &((*Packet
)->ProtoData
[0])) = (UINTN
) (Instance
->UdpIo
);
1874 Retransmit the packet.
1876 @param Instance The DNS instance
1877 @param Packet Retransmit the packet
1879 @retval EFI_SUCCESS The packet is retransmitted.
1880 @retval Others Failed to retransmit.
1885 IN DNS_INSTANCE
*Instance
,
1893 ASSERT (Packet
!= NULL
);
1896 // Set the requests to the listening port, other packets to the connected port
1898 Buffer
= NetbufGetByte (Packet
, 0, NULL
);
1899 ASSERT (Buffer
!= NULL
);
1901 NET_GET_REF (Packet
);
1903 Status
= UdpIoSendDatagram (
1912 if (EFI_ERROR (Status
)) {
1913 NET_PUT_REF (Packet
);
1920 The timer ticking function for the DNS services.
1922 @param Event The ticking event
1923 @param Context The DNS service instance
1928 DnsOnTimerRetransmit (
1933 DNS_SERVICE
*Service
;
1938 DNS_INSTANCE
*Instance
;
1939 LIST_ENTRY
*EntryNetMap
;
1940 NET_MAP_ITEM
*ItemNetMap
;
1941 DNS4_TOKEN_ENTRY
*Dns4TokenEntry
;
1942 DNS6_TOKEN_ENTRY
*Dns6TokenEntry
;
1944 Dns4TokenEntry
= NULL
;
1945 Dns6TokenEntry
= NULL
;
1947 Service
= (DNS_SERVICE
*) Context
;
1950 if (Service
->IpVersion
== IP_VERSION_4
) {
1952 // Iterate through all the children of the DNS service instance. Time
1953 // out the packet. If maximum retries reached, clean the Token up.
1955 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Service
->Dns4ChildrenList
) {
1956 Instance
= NET_LIST_USER_STRUCT (Entry
, DNS_INSTANCE
, Link
);
1958 EntryNetMap
= Instance
->Dns4TxTokens
.Used
.ForwardLink
;
1959 while (EntryNetMap
!= &Instance
->Dns4TxTokens
.Used
) {
1960 ItemNetMap
= NET_LIST_USER_STRUCT (EntryNetMap
, NET_MAP_ITEM
, Link
);
1961 Dns4TokenEntry
= (DNS4_TOKEN_ENTRY
*)(ItemNetMap
->Key
);
1962 if (Dns4TokenEntry
->PacketToLive
== 0 || (--Dns4TokenEntry
->PacketToLive
> 0)) {
1963 EntryNetMap
= EntryNetMap
->ForwardLink
;
1968 // Retransmit the packet if haven't reach the maxmium retry count,
1969 // otherwise exit the transfer.
1971 if (++Dns4TokenEntry
->Token
->RetryCount
< Instance
->MaxRetry
) {
1972 DnsRetransmit (Instance
, (NET_BUF
*)ItemNetMap
->Value
);
1973 EntryNetMap
= EntryNetMap
->ForwardLink
;
1976 // Maximum retries reached, clean the Token up.
1978 Dns4RemoveTokenEntry (&Instance
->Dns4TxTokens
, Dns4TokenEntry
);
1979 Dns4TokenEntry
->Token
->Status
= EFI_TIMEOUT
;
1980 gBS
->SignalEvent (Dns4TokenEntry
->Token
->Event
);
1984 // Free the sending packet.
1986 if (ItemNetMap
->Value
!= NULL
) {
1987 NetbufFree ((NET_BUF
*)(ItemNetMap
->Value
));
1990 EntryNetMap
= Instance
->Dns4TxTokens
.Used
.ForwardLink
;
1996 // Iterate through all the children of the DNS service instance. Time
1997 // out the packet. If maximum retries reached, clean the Token up.
1999 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Service
->Dns6ChildrenList
) {
2000 Instance
= NET_LIST_USER_STRUCT (Entry
, DNS_INSTANCE
, Link
);
2002 EntryNetMap
= Instance
->Dns6TxTokens
.Used
.ForwardLink
;
2003 while (EntryNetMap
!= &Instance
->Dns6TxTokens
.Used
) {
2004 ItemNetMap
= NET_LIST_USER_STRUCT (EntryNetMap
, NET_MAP_ITEM
, Link
);
2005 Dns6TokenEntry
= (DNS6_TOKEN_ENTRY
*) (ItemNetMap
->Key
);
2006 if (Dns6TokenEntry
->PacketToLive
== 0 || (--Dns6TokenEntry
->PacketToLive
> 0)) {
2007 EntryNetMap
= EntryNetMap
->ForwardLink
;
2012 // Retransmit the packet if haven't reach the maxmium retry count,
2013 // otherwise exit the transfer.
2015 if (++Dns6TokenEntry
->Token
->RetryCount
< Instance
->MaxRetry
) {
2016 DnsRetransmit (Instance
, (NET_BUF
*) ItemNetMap
->Value
);
2017 EntryNetMap
= EntryNetMap
->ForwardLink
;
2020 // Maximum retries reached, clean the Token up.
2022 Dns6RemoveTokenEntry (&Instance
->Dns6TxTokens
, Dns6TokenEntry
);
2023 Dns6TokenEntry
->Token
->Status
= EFI_TIMEOUT
;
2024 gBS
->SignalEvent (Dns6TokenEntry
->Token
->Event
);
2028 // Free the sending packet.
2030 if (ItemNetMap
->Value
!= NULL
) {
2031 NetbufFree ((NET_BUF
*) (ItemNetMap
->Value
));
2034 EntryNetMap
= Instance
->Dns6TxTokens
.Used
.ForwardLink
;
2042 The timer ticking function for the DNS driver.
2044 @param Event The ticking event
2064 // Iterate through all the DNS4 cache list.
2066 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &mDriverData
->Dns4CacheList
) {
2067 Item4
= NET_LIST_USER_STRUCT (Entry
, DNS4_CACHE
, AllCacheLink
);
2068 Item4
->DnsCache
.Timeout
--;
2071 Entry
= mDriverData
->Dns4CacheList
.ForwardLink
;
2072 while (Entry
!= &mDriverData
->Dns4CacheList
) {
2073 Item4
= NET_LIST_USER_STRUCT (Entry
, DNS4_CACHE
, AllCacheLink
);
2074 if (Item4
->DnsCache
.Timeout
<=0) {
2075 RemoveEntryList (&Item4
->AllCacheLink
);
2076 Entry
= mDriverData
->Dns4CacheList
.ForwardLink
;
2078 Entry
= Entry
->ForwardLink
;
2083 // Iterate through all the DNS6 cache list.
2085 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &mDriverData
->Dns6CacheList
) {
2086 Item6
= NET_LIST_USER_STRUCT (Entry
, DNS6_CACHE
, AllCacheLink
);
2087 Item6
->DnsCache
.Timeout
--;
2090 Entry
= mDriverData
->Dns6CacheList
.ForwardLink
;
2091 while (Entry
!= &mDriverData
->Dns6CacheList
) {
2092 Item6
= NET_LIST_USER_STRUCT (Entry
, DNS6_CACHE
, AllCacheLink
);
2093 if (Item6
->DnsCache
.Timeout
<=0) {
2094 RemoveEntryList (&Item6
->AllCacheLink
);
2095 Entry
= mDriverData
->Dns6CacheList
.ForwardLink
;
2097 Entry
= Entry
->ForwardLink
;