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 Find out whether the response is valid or invalid.
1043 @param TokensMap All DNS transmittal Tokens entry.
1044 @param Identification Identification for queried packet.
1045 @param Type Type for queried packet.
1046 @param Item Return corresponding Token entry.
1048 @retval TRUE The response is valid.
1049 @retval FALSE The response is invalid.
1053 IsValidDnsResponse (
1054 IN NET_MAP
*TokensMap
,
1055 IN UINT16 Identification
,
1057 OUT NET_MAP_ITEM
**Item
1064 DNS_HEADER
*DnsHeader
;
1066 DNS_QUERY_SECTION
*QuerySection
;
1068 NET_LIST_FOR_EACH (Entry
, &TokensMap
->Used
) {
1069 *Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1070 Packet
= (NET_BUF
*) ((*Item
)->Value
);
1071 if (Packet
== NULL
){
1075 TxString
= NetbufGetByte (Packet
, 0, NULL
);
1076 ASSERT (TxString
!= NULL
);
1077 DnsHeader
= (DNS_HEADER
*) TxString
;
1078 QueryName
= (CHAR8
*) (TxString
+ sizeof (*DnsHeader
));
1079 QuerySection
= (DNS_QUERY_SECTION
*) (QueryName
+ AsciiStrLen (QueryName
) + 1);
1081 DnsHeader
->Identification
= NTOHS (DnsHeader
->Identification
);
1082 QuerySection
->Type
= NTOHS (QuerySection
->Type
);
1084 if (DnsHeader
->Identification
== Identification
&& QuerySection
->Type
== Type
) {
1098 @param Instance The DNS instance
1099 @param RxString Received buffer.
1100 @param Completed Flag to indicate that Dns response is valid.
1102 @retval EFI_SUCCESS Parse Dns Response successfully.
1103 @retval Others Failed to parse Dns Response.
1108 IN OUT DNS_INSTANCE
*Instance
,
1110 OUT BOOLEAN
*Completed
1113 DNS_HEADER
*DnsHeader
;
1116 DNS_QUERY_SECTION
*QuerySection
;
1119 DNS_ANSWER_SECTION
*AnswerSection
;
1123 DNS4_TOKEN_ENTRY
*Dns4TokenEntry
;
1124 DNS6_TOKEN_ENTRY
*Dns6TokenEntry
;
1128 UINT32 AnswerSectionNum
;
1130 EFI_IPv4_ADDRESS
*HostAddr4
;
1131 EFI_IPv6_ADDRESS
*HostAddr6
;
1133 EFI_DNS4_CACHE_ENTRY
*Dns4CacheEntry
;
1134 EFI_DNS6_CACHE_ENTRY
*Dns6CacheEntry
;
1136 DNS_RESOURCE_RECORD
*Dns4RR
;
1137 DNS6_RESOURCE_RECORD
*Dns6RR
;
1144 Dns4TokenEntry
= NULL
;
1145 Dns6TokenEntry
= NULL
;
1149 AnswerSectionNum
= 0;
1154 Dns4CacheEntry
= NULL
;
1155 Dns6CacheEntry
= NULL
;
1161 Status
= EFI_SUCCESS
;
1166 DnsHeader
= (DNS_HEADER
*) RxString
;
1168 DnsHeader
->Identification
= NTOHS (DnsHeader
->Identification
);
1169 DnsHeader
->Flags
.Uint16
= NTOHS (DnsHeader
->Flags
.Uint16
);
1170 DnsHeader
->QuestionsNum
= NTOHS (DnsHeader
->QuestionsNum
);
1171 DnsHeader
->AnswersNum
= NTOHS (DnsHeader
->AnswersNum
);
1172 DnsHeader
->AuthorityNum
= NTOHS (DnsHeader
->AuthorityNum
);
1173 DnsHeader
->AditionalNum
= NTOHS (DnsHeader
->AditionalNum
);
1178 QueryName
= (CHAR8
*) (RxString
+ sizeof (*DnsHeader
));
1181 // Get query section
1183 QuerySection
= (DNS_QUERY_SECTION
*) (QueryName
+ AsciiStrLen (QueryName
) + 1);
1184 QuerySection
->Type
= NTOHS (QuerySection
->Type
);
1185 QuerySection
->Class
= NTOHS (QuerySection
->Class
);
1190 AnswerName
= (CHAR8
*) QuerySection
+ sizeof (*QuerySection
);
1192 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1195 // Check DnsResponse Validity, if so, also get a valid NET_MAP_ITEM.
1197 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1198 if (!IsValidDnsResponse (&Instance
->Dns4TxTokens
, DnsHeader
->Identification
, QuerySection
->Type
, &Item
)) {
1200 Status
= EFI_ABORTED
;
1203 ASSERT (Item
!= NULL
);
1204 Dns4TokenEntry
= (DNS4_TOKEN_ENTRY
*) (Item
->Key
);
1206 if (!IsValidDnsResponse (&Instance
->Dns6TxTokens
, DnsHeader
->Identification
, QuerySection
->Type
, &Item
)) {
1208 Status
= EFI_ABORTED
;
1211 ASSERT (Item
!= NULL
);
1212 Dns6TokenEntry
= (DNS6_TOKEN_ENTRY
*) (Item
->Key
);
1216 // Continue Check Some Errors.
1218 if (DnsHeader
->Flags
.Bits
.RCode
!= DNS_FLAGS_RCODE_NO_ERROR
|| DnsHeader
->AnswersNum
< 1 || \
1219 DnsHeader
->Flags
.Bits
.QR
!= DNS_FLAGS_QR_RESPONSE
|| QuerySection
->Class
!= DNS_CLASS_INET
) {
1220 Status
= EFI_ABORTED
;
1225 // Free the sending packet.
1227 if (Item
->Value
!= NULL
) {
1228 NetbufFree ((NET_BUF
*) (Item
->Value
));
1232 // Do some buffer allocations.
1234 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1235 ASSERT (Dns4TokenEntry
!= NULL
);
1237 if (Dns4TokenEntry
->GeneralLookUp
) {
1239 // It's the GeneralLookUp querying.
1241 Dns4TokenEntry
->Token
->RspData
.GLookupData
= AllocatePool (sizeof (DNS_RESOURCE_RECORD
));
1242 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
== NULL
) {
1243 Status
= EFI_OUT_OF_RESOURCES
;
1246 Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
= AllocatePool (DnsHeader
->AnswersNum
* sizeof (DNS_RESOURCE_RECORD
));
1247 if (Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
== NULL
) {
1248 Status
= EFI_OUT_OF_RESOURCES
;
1253 // It's not the GeneralLookUp querying. Check the Query type.
1255 if (QuerySection
->Type
== DNS_TYPE_A
) {
1256 Dns4TokenEntry
->Token
->RspData
.H2AData
= AllocatePool (sizeof (DNS_HOST_TO_ADDR_DATA
));
1257 if (Dns4TokenEntry
->Token
->RspData
.H2AData
== NULL
) {
1258 Status
= EFI_OUT_OF_RESOURCES
;
1261 Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
= AllocatePool (DnsHeader
->AnswersNum
* sizeof (EFI_IPv4_ADDRESS
));
1262 if (Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
== NULL
) {
1263 Status
= EFI_OUT_OF_RESOURCES
;
1267 Status
= EFI_UNSUPPORTED
;
1272 ASSERT (Dns6TokenEntry
!= NULL
);
1274 if (Dns6TokenEntry
->GeneralLookUp
) {
1276 // It's the GeneralLookUp querying.
1278 Dns6TokenEntry
->Token
->RspData
.GLookupData
= AllocatePool (sizeof (DNS_RESOURCE_RECORD
));
1279 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
== NULL
) {
1280 Status
= EFI_UNSUPPORTED
;
1283 Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
= AllocatePool (DnsHeader
->AnswersNum
* sizeof (DNS_RESOURCE_RECORD
));
1284 if (Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
== NULL
) {
1285 Status
= EFI_UNSUPPORTED
;
1290 // It's not the GeneralLookUp querying. Check the Query type.
1292 if (QuerySection
->Type
== DNS_TYPE_AAAA
) {
1293 Dns6TokenEntry
->Token
->RspData
.H2AData
= AllocatePool (sizeof (DNS6_HOST_TO_ADDR_DATA
));
1294 if (Dns6TokenEntry
->Token
->RspData
.H2AData
== NULL
) {
1295 Status
= EFI_UNSUPPORTED
;
1298 Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
= AllocatePool (DnsHeader
->AnswersNum
* sizeof (EFI_IPv6_ADDRESS
));
1299 if (Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
== NULL
) {
1300 Status
= EFI_UNSUPPORTED
;
1304 Status
= EFI_UNSUPPORTED
;
1311 // Processing AnswerSection.
1313 while (AnswerSectionNum
< DnsHeader
->AnswersNum
) {
1315 // Answer name should be PTR.
1317 ASSERT ((*(UINT8
*) AnswerName
& 0xC0) == 0xC0);
1320 // Get Answer section.
1322 AnswerSection
= (DNS_ANSWER_SECTION
*) (AnswerName
+ sizeof (UINT16
));
1323 AnswerSection
->Type
= NTOHS (AnswerSection
->Type
);
1324 AnswerSection
->Class
= NTOHS (AnswerSection
->Class
);
1325 AnswerSection
->Ttl
= NTOHL (AnswerSection
->Ttl
);
1326 AnswerSection
->DataLength
= NTOHS (AnswerSection
->DataLength
);
1329 // Check whether it's the GeneralLookUp querying.
1331 if (Instance
->Service
->IpVersion
== IP_VERSION_4
&& Dns4TokenEntry
->GeneralLookUp
) {
1332 Dns4RR
= Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRList
;
1333 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1336 // Fill the ResourceRecord.
1338 Dns4RR
[RRCount
].QName
= AllocateZeroPool (AsciiStrLen (QueryName
) + 1);
1339 if (Dns4RR
[RRCount
].QName
== NULL
) {
1340 Status
= EFI_UNSUPPORTED
;
1343 CopyMem (Dns4RR
[RRCount
].QName
, QueryName
, AsciiStrLen (QueryName
));
1344 Dns4RR
[RRCount
].QType
= AnswerSection
->Type
;
1345 Dns4RR
[RRCount
].QClass
= AnswerSection
->Class
;
1346 Dns4RR
[RRCount
].TTL
= AnswerSection
->Ttl
;
1347 Dns4RR
[RRCount
].DataLength
= AnswerSection
->DataLength
;
1348 Dns4RR
[RRCount
].RData
= AllocateZeroPool (Dns4RR
[RRCount
].DataLength
);
1349 if (Dns4RR
[RRCount
].RData
== NULL
) {
1350 Status
= EFI_UNSUPPORTED
;
1353 CopyMem (Dns4RR
[RRCount
].RData
, AnswerData
, Dns4RR
[RRCount
].DataLength
);
1356 } else if (Instance
->Service
->IpVersion
== IP_VERSION_6
&& Dns6TokenEntry
->GeneralLookUp
) {
1357 Dns6RR
= Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRList
;
1358 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1361 // Fill the ResourceRecord.
1363 Dns6RR
[RRCount
].QName
= AllocateZeroPool (AsciiStrLen (QueryName
) + 1);
1364 if (Dns6RR
[RRCount
].QName
== NULL
) {
1365 Status
= EFI_UNSUPPORTED
;
1368 CopyMem (Dns6RR
[RRCount
].QName
, QueryName
, AsciiStrLen (QueryName
));
1369 Dns6RR
[RRCount
].QType
= AnswerSection
->Type
;
1370 Dns6RR
[RRCount
].QClass
= AnswerSection
->Class
;
1371 Dns6RR
[RRCount
].TTL
= AnswerSection
->Ttl
;
1372 Dns6RR
[RRCount
].DataLength
= AnswerSection
->DataLength
;
1373 Dns6RR
[RRCount
].RData
= AllocateZeroPool (Dns6RR
[RRCount
].DataLength
);
1374 if (Dns6RR
[RRCount
].RData
== NULL
) {
1375 Status
= EFI_UNSUPPORTED
;
1378 CopyMem (Dns6RR
[RRCount
].RData
, AnswerData
, Dns6RR
[RRCount
].DataLength
);
1383 // It's not the GeneralLookUp querying.
1384 // Check the Query type, parse the response packet.
1386 switch (AnswerSection
->Type
) {
1389 // This is address entry, get Data.
1391 ASSERT (Dns4TokenEntry
!= NULL
&& AnswerSection
->DataLength
== 4);
1393 HostAddr4
= Dns4TokenEntry
->Token
->RspData
.H2AData
->IpList
;
1394 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1395 CopyMem (&HostAddr4
[IpCount
], AnswerData
, sizeof (EFI_IPv4_ADDRESS
));
1398 // Update DNS cache dynamically.
1400 if (Dns4CacheEntry
!= NULL
) {
1401 if (Dns4CacheEntry
->HostName
!= NULL
) {
1402 FreePool (Dns4CacheEntry
->HostName
);
1405 if (Dns4CacheEntry
->IpAddress
!= NULL
) {
1406 FreePool (Dns4CacheEntry
->IpAddress
);
1409 FreePool (Dns4CacheEntry
);
1413 // Allocate new CacheEntry pool.
1415 Dns4CacheEntry
= AllocateZeroPool (sizeof (EFI_DNS4_CACHE_ENTRY
));
1416 if (Dns4CacheEntry
== NULL
) {
1417 Status
= EFI_UNSUPPORTED
;
1420 Dns4CacheEntry
->HostName
= AllocateZeroPool (2 * (StrLen(Dns4TokenEntry
->QueryHostName
) + 1));
1421 if (Dns4CacheEntry
->HostName
== NULL
) {
1422 Status
= EFI_UNSUPPORTED
;
1425 CopyMem (Dns4CacheEntry
->HostName
, Dns4TokenEntry
->QueryHostName
, 2 * (StrLen(Dns4TokenEntry
->QueryHostName
) + 1));
1426 Dns4CacheEntry
->IpAddress
= AllocateZeroPool (sizeof (EFI_IPv4_ADDRESS
));
1427 if (Dns4CacheEntry
->IpAddress
== NULL
) {
1428 Status
= EFI_UNSUPPORTED
;
1431 CopyMem (Dns4CacheEntry
->IpAddress
, AnswerData
, sizeof (EFI_IPv4_ADDRESS
));
1432 Dns4CacheEntry
->Timeout
= AnswerSection
->Ttl
;
1434 UpdateDns4Cache (&mDriverData
->Dns4CacheList
, FALSE
, TRUE
, *Dns4CacheEntry
);
1440 // This is address entry, get Data.
1442 ASSERT (Dns6TokenEntry
!= NULL
&& AnswerSection
->DataLength
== 16);
1444 HostAddr6
= Dns6TokenEntry
->Token
->RspData
.H2AData
->IpList
;
1445 AnswerData
= (UINT8
*) AnswerSection
+ sizeof (*AnswerSection
);
1446 CopyMem (&HostAddr6
[IpCount
], AnswerData
, sizeof (EFI_IPv6_ADDRESS
));
1449 // Update DNS cache dynamically.
1451 if (Dns6CacheEntry
!= NULL
) {
1452 if (Dns6CacheEntry
->HostName
!= NULL
) {
1453 FreePool (Dns6CacheEntry
->HostName
);
1456 if (Dns6CacheEntry
->IpAddress
!= NULL
) {
1457 FreePool (Dns6CacheEntry
->IpAddress
);
1460 FreePool (Dns6CacheEntry
);
1464 // Allocate new CacheEntry pool.
1466 Dns6CacheEntry
= AllocateZeroPool (sizeof (EFI_DNS6_CACHE_ENTRY
));
1467 if (Dns6CacheEntry
== NULL
) {
1468 Status
= EFI_UNSUPPORTED
;
1471 Dns6CacheEntry
->HostName
= AllocateZeroPool (2 * (StrLen(Dns6TokenEntry
->QueryHostName
) + 1));
1472 if (Dns6CacheEntry
->HostName
== NULL
) {
1473 Status
= EFI_UNSUPPORTED
;
1476 CopyMem (Dns6CacheEntry
->HostName
, Dns6TokenEntry
->QueryHostName
, 2 * (StrLen(Dns6TokenEntry
->QueryHostName
) + 1));
1477 Dns6CacheEntry
->IpAddress
= AllocateZeroPool (sizeof (EFI_IPv6_ADDRESS
));
1478 if (Dns6CacheEntry
->IpAddress
== NULL
) {
1479 Status
= EFI_UNSUPPORTED
;
1482 CopyMem (Dns6CacheEntry
->IpAddress
, AnswerData
, sizeof (EFI_IPv6_ADDRESS
));
1483 Dns6CacheEntry
->Timeout
= AnswerSection
->Ttl
;
1485 UpdateDns6Cache (&mDriverData
->Dns6CacheList
, FALSE
, TRUE
, *Dns6CacheEntry
);
1490 Status
= EFI_UNSUPPORTED
;
1498 AnswerName
= (CHAR8
*) AnswerSection
+ sizeof (*AnswerSection
) + AnswerSection
->DataLength
;
1499 AnswerSectionNum
++;
1502 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1503 ASSERT (Dns4TokenEntry
!= NULL
);
1505 if (Dns4TokenEntry
->GeneralLookUp
) {
1506 Dns4TokenEntry
->Token
->RspData
.GLookupData
->RRCount
= RRCount
;
1508 if (QuerySection
->Type
== DNS_TYPE_A
) {
1509 Dns4TokenEntry
->Token
->RspData
.H2AData
->IpCount
= IpCount
;
1511 Status
= EFI_UNSUPPORTED
;
1516 ASSERT (Dns6TokenEntry
!= NULL
);
1518 if (Dns6TokenEntry
->GeneralLookUp
) {
1519 Dns6TokenEntry
->Token
->RspData
.GLookupData
->RRCount
= RRCount
;
1521 if (QuerySection
->Type
== DNS_TYPE_AAAA
) {
1522 Dns6TokenEntry
->Token
->RspData
.H2AData
->IpCount
= IpCount
;
1524 Status
= EFI_UNSUPPORTED
;
1531 // Parsing is complete, SignalEvent here.
1533 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1534 ASSERT (Dns4TokenEntry
!= NULL
);
1535 Dns4RemoveTokenEntry (&Instance
->Dns4TxTokens
, Dns4TokenEntry
);
1536 Dns4TokenEntry
->Token
->Status
= EFI_SUCCESS
;
1537 if (Dns4TokenEntry
->Token
->Event
!= NULL
) {
1538 gBS
->SignalEvent (Dns4TokenEntry
->Token
->Event
);
1542 ASSERT (Dns6TokenEntry
!= NULL
);
1543 Dns6RemoveTokenEntry (&Instance
->Dns6TxTokens
, Dns6TokenEntry
);
1544 Dns6TokenEntry
->Token
->Status
= EFI_SUCCESS
;
1545 if (Dns6TokenEntry
->Token
->Event
!= NULL
) {
1546 gBS
->SignalEvent (Dns6TokenEntry
->Token
->Event
);
1552 // Free allocated CacheEntry pool.
1554 if (Dns4CacheEntry
!= NULL
) {
1555 if (Dns4CacheEntry
->HostName
!= NULL
) {
1556 FreePool (Dns4CacheEntry
->HostName
);
1559 if (Dns4CacheEntry
->IpAddress
!= NULL
) {
1560 FreePool (Dns4CacheEntry
->IpAddress
);
1563 FreePool (Dns4CacheEntry
);
1566 if (Dns6CacheEntry
!= NULL
) {
1567 if (Dns6CacheEntry
->HostName
!= NULL
) {
1568 FreePool (Dns6CacheEntry
->HostName
);
1571 if (Dns6CacheEntry
->IpAddress
!= NULL
) {
1572 FreePool (Dns6CacheEntry
->IpAddress
);
1575 FreePool (Dns6CacheEntry
);
1579 gBS
->RestoreTPL (OldTpl
);
1584 Parse response packet.
1586 @param Packet The packets received.
1587 @param EndPoint The local/remote UDP access point
1588 @param IoStatus The status of the UDP receive
1589 @param Context The opaque parameter to the function.
1594 DnsOnPacketReceived (
1596 UDP_END_POINT
*EndPoint
,
1597 EFI_STATUS IoStatus
,
1601 DNS_INSTANCE
*Instance
;
1607 Instance
= (DNS_INSTANCE
*) Context
;
1608 NET_CHECK_SIGNATURE (Instance
, DNS_INSTANCE_SIGNATURE
);
1613 if (EFI_ERROR (IoStatus
)) {
1617 ASSERT (Packet
!= NULL
);
1619 RcvString
= NetbufGetByte (Packet
, 0, NULL
);
1620 ASSERT (RcvString
!= NULL
);
1623 // Parse Dns Response
1625 ParseDnsResponse (Instance
, RcvString
, &Completed
);
1629 if (Packet
!= NULL
) {
1630 NetbufFree (Packet
);
1634 UdpIoRecvDatagram (Instance
->UdpIo
, DnsOnPacketReceived
, Instance
, 0);
1639 Release the net buffer when packet is sent.
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.
1651 UDP_END_POINT
*EndPoint
,
1652 EFI_STATUS IoStatus
,
1656 DNS_INSTANCE
*Instance
;
1659 DNS4_TOKEN_ENTRY
*Dns4TokenEntry
;
1660 DNS6_TOKEN_ENTRY
*Dns6TokenEntry
;
1662 Dns4TokenEntry
= NULL
;
1663 Dns6TokenEntry
= NULL
;
1665 Instance
= (DNS_INSTANCE
*) Context
;
1666 NET_CHECK_SIGNATURE (Instance
, DNS_INSTANCE_SIGNATURE
);
1668 if (Instance
->Service
->IpVersion
== IP_VERSION_4
) {
1669 NET_LIST_FOR_EACH (Entry
, &Instance
->Dns4TxTokens
.Used
) {
1670 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1671 if (Packet
== (NET_BUF
*)(Item
->Value
)) {
1672 Dns4TokenEntry
= ((DNS4_TOKEN_ENTRY
*)Item
->Key
);
1673 Dns4TokenEntry
->PacketToLive
= Dns4TokenEntry
->Token
->RetryInterval
;
1678 NET_LIST_FOR_EACH (Entry
, &Instance
->Dns6TxTokens
.Used
) {
1679 Item
= NET_LIST_USER_STRUCT (Entry
, NET_MAP_ITEM
, Link
);
1680 if (Packet
== (NET_BUF
*)(Item
->Value
)) {
1681 Dns6TokenEntry
= ((DNS6_TOKEN_ENTRY
*)Item
->Key
);
1682 Dns6TokenEntry
->PacketToLive
= Dns6TokenEntry
->Token
->RetryInterval
;
1688 NetbufFree (Packet
);
1692 Query request information.
1694 @param Instance The DNS instance
1695 @param Packet The packet for querying request information.
1697 @retval EFI_SUCCESS Query request information successfully.
1698 @retval Others Failed to query request information.
1703 IN DNS_INSTANCE
*Instance
,
1710 // Ready to receive the DNS response.
1712 if (Instance
->UdpIo
->RecvRequest
== NULL
) {
1713 Status
= UdpIoRecvDatagram (Instance
->UdpIo
, DnsOnPacketReceived
, Instance
, 0);
1714 if (EFI_ERROR (Status
)) {
1720 // Transmit the DNS packet.
1722 NET_GET_REF (Packet
);
1724 Status
= UdpIoSendDatagram (Instance
->UdpIo
, Packet
, NULL
, NULL
, DnsOnPacketSent
, Instance
);
1730 Construct the Packet according query section.
1732 @param Instance The DNS instance
1733 @param QueryName Queried Name
1734 @param Type Queried Type
1735 @param Class Queried Class
1736 @param Packet The packet for query
1738 @retval EFI_SUCCESS The packet is constructed.
1739 @retval Others Failed to construct the Packet.
1744 IN DNS_INSTANCE
*Instance
,
1745 IN CHAR8
*QueryName
,
1748 OUT NET_BUF
**Packet
1752 DNS_HEADER
*DnsHeader
;
1753 DNS_QUERY_SECTION
*DnsQuery
;
1756 // Messages carried by UDP are restricted to 512 bytes (not counting the IP
1759 Frag
.Bulk
= AllocatePool (DNS_MAX_MESSAGE_SIZE
* sizeof (UINT8
));
1760 if (Frag
.Bulk
== NULL
) {
1761 return EFI_OUT_OF_RESOURCES
;
1767 DnsHeader
= (DNS_HEADER
*) Frag
.Bulk
;
1768 DnsHeader
->Identification
= (UINT16
)NET_RANDOM (NetRandomInitSeed());
1769 DnsHeader
->Flags
.Uint16
= 0x0000;
1770 DnsHeader
->Flags
.Bits
.RD
= 1;
1771 DnsHeader
->Flags
.Bits
.OpCode
= DNS_FLAGS_OPCODE_STANDARD
;
1772 DnsHeader
->Flags
.Bits
.QR
= DNS_FLAGS_QR_QUERY
;
1773 DnsHeader
->QuestionsNum
= 1;
1774 DnsHeader
->AnswersNum
= 0;
1775 DnsHeader
->AuthorityNum
= 0;
1776 DnsHeader
->AditionalNum
= 0;
1778 DnsHeader
->Identification
= HTONS (DnsHeader
->Identification
);
1779 DnsHeader
->Flags
.Uint16
= HTONS (DnsHeader
->Flags
.Uint16
);
1780 DnsHeader
->QuestionsNum
= HTONS (DnsHeader
->QuestionsNum
);
1781 DnsHeader
->AnswersNum
= HTONS (DnsHeader
->AnswersNum
);
1782 DnsHeader
->AuthorityNum
= HTONS (DnsHeader
->AuthorityNum
);
1783 DnsHeader
->AditionalNum
= HTONS (DnsHeader
->AditionalNum
);
1785 Frag
.Len
= sizeof (*DnsHeader
);
1790 CopyMem (Frag
.Bulk
+ Frag
.Len
, QueryName
, AsciiStrLen (QueryName
));
1791 Frag
.Len
= (UINT32
) (Frag
.Len
+ AsciiStrLen (QueryName
));
1792 *(Frag
.Bulk
+ Frag
.Len
) = 0;
1796 // Rest query section
1798 DnsQuery
= (DNS_QUERY_SECTION
*) (Frag
.Bulk
+ Frag
.Len
);
1800 DnsQuery
->Type
= HTONS (Type
);
1801 DnsQuery
->Class
= HTONS (Class
);
1803 Frag
.Len
+= sizeof (*DnsQuery
);
1806 // Wrap the Frag in a net buffer.
1808 *Packet
= NetbufFromExt (&Frag
, 1, 0, 0, DnsDummyExtFree
, NULL
);
1809 if (*Packet
== NULL
) {
1810 FreePool (Frag
.Bulk
);
1811 return EFI_OUT_OF_RESOURCES
;
1815 // Store the UdpIo in ProtoData.
1817 *((UINTN
*) &((*Packet
)->ProtoData
[0])) = (UINTN
) (Instance
->UdpIo
);
1823 Retransmit the packet.
1825 @param Instance The DNS instance
1826 @param Packet Retransmit the packet
1828 @retval EFI_SUCCESS The packet is retransmitted.
1829 @retval Others Failed to retransmit.
1834 IN DNS_INSTANCE
*Instance
,
1842 ASSERT (Packet
!= NULL
);
1845 // Set the requests to the listening port, other packets to the connected port
1847 Buffer
= NetbufGetByte (Packet
, 0, NULL
);
1848 ASSERT (Buffer
!= NULL
);
1850 NET_GET_REF (Packet
);
1852 Status
= UdpIoSendDatagram (
1861 if (EFI_ERROR (Status
)) {
1862 NET_PUT_REF (Packet
);
1869 The timer ticking function for the DNS services.
1871 @param Event The ticking event
1872 @param Context The DNS service instance
1877 DnsOnTimerRetransmit (
1882 DNS_SERVICE
*Service
;
1887 DNS_INSTANCE
*Instance
;
1888 LIST_ENTRY
*EntryNetMap
;
1889 NET_MAP_ITEM
*ItemNetMap
;
1890 DNS4_TOKEN_ENTRY
*Dns4TokenEntry
;
1891 DNS6_TOKEN_ENTRY
*Dns6TokenEntry
;
1893 Dns4TokenEntry
= NULL
;
1894 Dns6TokenEntry
= NULL
;
1896 Service
= (DNS_SERVICE
*) Context
;
1899 if (Service
->IpVersion
== IP_VERSION_4
) {
1901 // Iterate through all the children of the DNS service instance. Time
1902 // out the packet. If maximum retries reached, clean the Token up.
1904 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Service
->Dns4ChildrenList
) {
1905 Instance
= NET_LIST_USER_STRUCT (Entry
, DNS_INSTANCE
, Link
);
1907 EntryNetMap
= Instance
->Dns4TxTokens
.Used
.ForwardLink
;
1908 while (EntryNetMap
!= &Instance
->Dns4TxTokens
.Used
) {
1909 ItemNetMap
= NET_LIST_USER_STRUCT (EntryNetMap
, NET_MAP_ITEM
, Link
);
1910 Dns4TokenEntry
= (DNS4_TOKEN_ENTRY
*)(ItemNetMap
->Key
);
1911 if (Dns4TokenEntry
->PacketToLive
== 0 || (--Dns4TokenEntry
->PacketToLive
> 0)) {
1912 EntryNetMap
= EntryNetMap
->ForwardLink
;
1917 // Retransmit the packet if haven't reach the maxmium retry count,
1918 // otherwise exit the transfer.
1920 if (++Dns4TokenEntry
->Token
->RetryCount
< Instance
->MaxRetry
) {
1921 DnsRetransmit (Instance
, (NET_BUF
*)ItemNetMap
->Value
);
1922 EntryNetMap
= EntryNetMap
->ForwardLink
;
1925 // Maximum retries reached, clean the Token up.
1927 Dns4RemoveTokenEntry (&Instance
->Dns4TxTokens
, Dns4TokenEntry
);
1928 Dns4TokenEntry
->Token
->Status
= EFI_TIMEOUT
;
1929 gBS
->SignalEvent (Dns4TokenEntry
->Token
->Event
);
1933 // Free the sending packet.
1935 if (ItemNetMap
->Value
!= NULL
) {
1936 NetbufFree ((NET_BUF
*)(ItemNetMap
->Value
));
1939 EntryNetMap
= Instance
->Dns4TxTokens
.Used
.ForwardLink
;
1945 // Iterate through all the children of the DNS service instance. Time
1946 // out the packet. If maximum retries reached, clean the Token up.
1948 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Service
->Dns6ChildrenList
) {
1949 Instance
= NET_LIST_USER_STRUCT (Entry
, DNS_INSTANCE
, Link
);
1951 EntryNetMap
= Instance
->Dns6TxTokens
.Used
.ForwardLink
;
1952 while (EntryNetMap
!= &Instance
->Dns6TxTokens
.Used
) {
1953 ItemNetMap
= NET_LIST_USER_STRUCT (EntryNetMap
, NET_MAP_ITEM
, Link
);
1954 Dns6TokenEntry
= (DNS6_TOKEN_ENTRY
*) (ItemNetMap
->Key
);
1955 if (Dns6TokenEntry
->PacketToLive
== 0 || (--Dns6TokenEntry
->PacketToLive
> 0)) {
1956 EntryNetMap
= EntryNetMap
->ForwardLink
;
1961 // Retransmit the packet if haven't reach the maxmium retry count,
1962 // otherwise exit the transfer.
1964 if (++Dns6TokenEntry
->Token
->RetryCount
< Instance
->MaxRetry
) {
1965 DnsRetransmit (Instance
, (NET_BUF
*) ItemNetMap
->Value
);
1966 EntryNetMap
= EntryNetMap
->ForwardLink
;
1969 // Maximum retries reached, clean the Token up.
1971 Dns6RemoveTokenEntry (&Instance
->Dns6TxTokens
, Dns6TokenEntry
);
1972 Dns6TokenEntry
->Token
->Status
= EFI_TIMEOUT
;
1973 gBS
->SignalEvent (Dns6TokenEntry
->Token
->Event
);
1977 // Free the sending packet.
1979 if (ItemNetMap
->Value
!= NULL
) {
1980 NetbufFree ((NET_BUF
*) (ItemNetMap
->Value
));
1983 EntryNetMap
= Instance
->Dns6TxTokens
.Used
.ForwardLink
;
1991 The timer ticking function for the DNS driver.
1993 @param Event The ticking event
2013 // Iterate through all the DNS4 cache list.
2015 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &mDriverData
->Dns4CacheList
) {
2016 Item4
= NET_LIST_USER_STRUCT (Entry
, DNS4_CACHE
, AllCacheLink
);
2017 Item4
->DnsCache
.Timeout
--;
2020 Entry
= mDriverData
->Dns4CacheList
.ForwardLink
;
2021 while (Entry
!= &mDriverData
->Dns4CacheList
) {
2022 Item4
= NET_LIST_USER_STRUCT (Entry
, DNS4_CACHE
, AllCacheLink
);
2023 if (Item4
->DnsCache
.Timeout
<=0) {
2024 RemoveEntryList (&Item4
->AllCacheLink
);
2025 Entry
= mDriverData
->Dns4CacheList
.ForwardLink
;
2027 Entry
= Entry
->ForwardLink
;
2032 // Iterate through all the DNS6 cache list.
2034 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &mDriverData
->Dns6CacheList
) {
2035 Item6
= NET_LIST_USER_STRUCT (Entry
, DNS6_CACHE
, AllCacheLink
);
2036 Item6
->DnsCache
.Timeout
--;
2039 Entry
= mDriverData
->Dns6CacheList
.ForwardLink
;
2040 while (Entry
!= &mDriverData
->Dns6CacheList
) {
2041 Item6
= NET_LIST_USER_STRUCT (Entry
, DNS6_CACHE
, AllCacheLink
);
2042 if (Item6
->DnsCache
.Timeout
<=0) {
2043 RemoveEntryList (&Item6
->AllCacheLink
);
2044 Entry
= mDriverData
->Dns6CacheList
.ForwardLink
;
2046 Entry
= Entry
->ForwardLink
;