forked from tianocore/edk2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathDnsProtocol.c
1736 lines (1418 loc) · 52.7 KB
/
DnsProtocol.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/** @file
Implementation of EFI_DNS4_PROTOCOL and EFI_DNS6_PROTOCOL interfaces.
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "DnsImpl.h"
EFI_DNS4_PROTOCOL mDns4Protocol = {
Dns4GetModeData,
Dns4Configure,
Dns4HostNameToIp,
Dns4IpToHostName,
Dns4GeneralLookUp,
Dns4UpdateDnsCache,
Dns4Poll,
Dns4Cancel
};
EFI_DNS6_PROTOCOL mDns6Protocol = {
Dns6GetModeData,
Dns6Configure,
Dns6HostNameToIp,
Dns6IpToHostName,
Dns6GeneralLookUp,
Dns6UpdateDnsCache,
Dns6Poll,
Dns6Cancel
};
/**
Retrieve mode data of this DNS instance.
This function is used to retrieve DNS mode data for this DNS instance.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
@param[out] DnsModeData Point to the mode data.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED When DnsConfigData is queried, no configuration data
is available because this instance has not been
configured.
@retval EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.
@retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.
**/
EFI_STATUS
EFIAPI
Dns4GetModeData (
IN EFI_DNS4_PROTOCOL *This,
OUT EFI_DNS4_MODE_DATA *DnsModeData
)
{
DNS_INSTANCE *Instance;
EFI_TPL OldTpl;
UINTN Index;
LIST_ENTRY *Entry;
LIST_ENTRY *Next;
DNS4_SERVER_IP *ServerItem;
EFI_IPv4_ADDRESS *ServerList;
DNS4_CACHE *CacheItem;
EFI_DNS4_CACHE_ENTRY *CacheList;
EFI_STATUS Status;
ServerItem = NULL;
ServerList = NULL;
CacheItem = NULL;
CacheList = NULL;
Status = EFI_SUCCESS;
if ((This == NULL) || (DnsModeData == NULL)) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);
if (Instance->State == DNS_STATE_UNCONFIGED) {
Status = EFI_NOT_STARTED;
goto ON_EXIT;
}
ZeroMem (DnsModeData, sizeof (EFI_DNS4_MODE_DATA));
//
// Get the current configuration data of this instance.
//
Status = Dns4CopyConfigure (&DnsModeData->DnsConfigData, &Instance->Dns4CfgData);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
//
// Get the DnsServerCount and DnsServerList
//
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4ServerList) {
Index++;
}
DnsModeData->DnsServerCount = (UINT32)Index;
ServerList = AllocatePool (sizeof (EFI_IPv4_ADDRESS) * DnsModeData->DnsServerCount);
if (ServerList == NULL) {
Status = EFI_OUT_OF_RESOURCES;
Dns4CleanConfigure (&DnsModeData->DnsConfigData);
goto ON_EXIT;
}
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4ServerList) {
ServerItem = NET_LIST_USER_STRUCT (Entry, DNS4_SERVER_IP, AllServerLink);
CopyMem (ServerList + Index, &ServerItem->Dns4ServerIp, sizeof (EFI_IPv4_ADDRESS));
Index++;
}
DnsModeData->DnsServerList = ServerList;
//
// Get the DnsCacheCount and DnsCacheList
//
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4CacheList) {
Index++;
}
DnsModeData->DnsCacheCount = (UINT32)Index;
CacheList = AllocatePool (sizeof (EFI_DNS4_CACHE_ENTRY) * DnsModeData->DnsCacheCount);
if (CacheList == NULL) {
Status = EFI_OUT_OF_RESOURCES;
Dns4CleanConfigure (&DnsModeData->DnsConfigData);
FreePool (ServerList);
goto ON_EXIT;
}
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4CacheList) {
CacheItem = NET_LIST_USER_STRUCT (Entry, DNS4_CACHE, AllCacheLink);
CopyMem (CacheList + Index, &CacheItem->DnsCache, sizeof (EFI_DNS4_CACHE_ENTRY));
Index++;
}
DnsModeData->DnsCacheList = CacheList;
ON_EXIT:
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Configure this DNS instance.
This function is used to configure DNS mode data for this DNS instance.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
@param[in] DnsConfigData Point to the Configuration data.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_UNSUPPORTED The designated protocol is not supported.
@retval EFI_INVALID_PARAMETER This is NULL.
The StationIp address provided in DnsConfigData is not a
valid unicast.
DnsServerList is NULL while DnsServerListCount
is not ZERO.
DnsServerListCount is ZERO while DnsServerList
is not NULL
@retval EFI_OUT_OF_RESOURCES The DNS instance data or required space could not be
allocated.
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The
EFI DNSv4 Protocol instance is not configured.
@retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To
reconfigure the instance the caller must call Configure()
with NULL first to return driver to unconfigured state.
**/
EFI_STATUS
EFIAPI
Dns4Configure (
IN EFI_DNS4_PROTOCOL *This,
IN EFI_DNS4_CONFIG_DATA *DnsConfigData
)
{
EFI_STATUS Status;
DNS_INSTANCE *Instance;
EFI_TPL OldTpl;
IP4_ADDR Ip;
IP4_ADDR Netmask;
UINT32 ServerListCount;
EFI_IPv4_ADDRESS *ServerList;
Status = EFI_SUCCESS;
ServerList = NULL;
if ((This == NULL) ||
((DnsConfigData != NULL) && (((DnsConfigData->DnsServerListCount != 0) && (DnsConfigData->DnsServerList == NULL)) ||
((DnsConfigData->DnsServerListCount == 0) && (DnsConfigData->DnsServerList != NULL)))))
{
return EFI_INVALID_PARAMETER;
}
if ((DnsConfigData != NULL) && (DnsConfigData->Protocol != DNS_PROTOCOL_UDP)) {
return EFI_UNSUPPORTED;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);
if (DnsConfigData == NULL) {
ZeroMem (&Instance->SessionDnsServer, sizeof (EFI_IP_ADDRESS));
//
// Reset the Instance if ConfigData is NULL
//
if (!NetMapIsEmpty (&Instance->Dns4TxTokens)) {
Dns4InstanceCancelToken (Instance, NULL);
}
if (Instance->UdpIo != NULL) {
UdpIoCleanIo (Instance->UdpIo);
}
if (Instance->Dns4CfgData.DnsServerList != NULL) {
FreePool (Instance->Dns4CfgData.DnsServerList);
}
ZeroMem (&Instance->Dns4CfgData, sizeof (EFI_DNS4_CONFIG_DATA));
Instance->State = DNS_STATE_UNCONFIGED;
} else {
//
// Configure the parameters for new operation.
//
CopyMem (&Ip, &DnsConfigData->StationIp, sizeof (IP4_ADDR));
CopyMem (&Netmask, &DnsConfigData->SubnetMask, sizeof (IP4_ADDR));
Ip = NTOHL (Ip);
Netmask = NTOHL (Netmask);
if (!DnsConfigData->UseDefaultSetting &&
((!IP4_IS_VALID_NETMASK (Netmask) || ((Netmask != 0) && !NetIp4IsUnicast (Ip, Netmask)))))
{
Status = EFI_INVALID_PARAMETER;
goto ON_EXIT;
}
Status = Dns4CopyConfigure (&Instance->Dns4CfgData, DnsConfigData);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
if (DnsConfigData->DnsServerListCount == 0) {
gBS->RestoreTPL (OldTpl);
//
// The DNS instance will retrieve DNS server from DHCP Server
//
Status = GetDns4ServerFromDhcp4 (
Instance,
&ServerListCount,
&ServerList
);
if (EFI_ERROR (Status)) {
return Status;
}
ASSERT (ServerList != NULL);
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
CopyMem (&Instance->SessionDnsServer.v4, &ServerList[0], sizeof (EFI_IPv4_ADDRESS));
} else {
CopyMem (&Instance->SessionDnsServer.v4, &DnsConfigData->DnsServerList[0], sizeof (EFI_IPv4_ADDRESS));
}
//
// Config UDP
//
Status = Dns4ConfigUdp (Instance, Instance->UdpIo);
if (EFI_ERROR (Status)) {
if (Instance->Dns4CfgData.DnsServerList != NULL) {
FreePool (Instance->Dns4CfgData.DnsServerList);
Instance->Dns4CfgData.DnsServerList = NULL;
}
goto ON_EXIT;
}
//
// Add configured DNS server used by this instance to ServerList.
//
Status = AddDns4ServerIp (&mDriverData->Dns4ServerList, Instance->SessionDnsServer.v4);
if (EFI_ERROR (Status)) {
if (Instance->Dns4CfgData.DnsServerList != NULL) {
FreePool (Instance->Dns4CfgData.DnsServerList);
Instance->Dns4CfgData.DnsServerList = NULL;
}
goto ON_EXIT;
}
Instance->State = DNS_STATE_CONFIGED;
}
ON_EXIT:
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Host name to host address translation.
The HostNameToIp () function is used to translate the host name to host IP address. A
type A query is used to get the one or more IP addresses for this host.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
@param[in] HostName Host name.
@param[in] Token Point to the completion token to translate host name
to host address.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
This is NULL.
Token is NULL.
Token.Event is NULL.
HostName is NULL. HostName string is unsupported format.
@retval EFI_NO_MAPPING There's no source address is available for use.
@retval EFI_NOT_STARTED This instance has not been started.
**/
EFI_STATUS
EFIAPI
Dns4HostNameToIp (
IN EFI_DNS4_PROTOCOL *This,
IN CHAR16 *HostName,
IN EFI_DNS4_COMPLETION_TOKEN *Token
)
{
EFI_STATUS Status;
DNS_INSTANCE *Instance;
EFI_DNS4_CONFIG_DATA *ConfigData;
UINTN Index;
DNS4_CACHE *Item;
LIST_ENTRY *Entry;
LIST_ENTRY *Next;
CHAR8 *QueryName;
DNS4_TOKEN_ENTRY *TokenEntry;
NET_BUF *Packet;
EFI_TPL OldTpl;
Status = EFI_SUCCESS;
Item = NULL;
QueryName = NULL;
TokenEntry = NULL;
Packet = NULL;
//
// Validate the parameters
//
if ((This == NULL) || (HostName == NULL) || (Token == NULL)) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);
ConfigData = &(Instance->Dns4CfgData);
if (Instance->State != DNS_STATE_CONFIGED) {
Status = EFI_NOT_STARTED;
goto ON_EXIT;
}
Token->Status = EFI_NOT_READY;
//
// If zero, use the parameter configured through Dns.Configure() interface.
//
if (Token->RetryCount == 0) {
Token->RetryCount = ConfigData->RetryCount;
}
//
// If zero, use the parameter configured through Dns.Configure() interface.
//
if (Token->RetryInterval == 0) {
Token->RetryInterval = ConfigData->RetryInterval;
}
//
// Minimum interval of retry is 2 second. If the retry interval is less than 2 second, then use the 2 second.
//
if (Token->RetryInterval < DNS_DEFAULT_TIMEOUT) {
Token->RetryInterval = DNS_DEFAULT_TIMEOUT;
}
//
// Check cache
//
if (ConfigData->EnableDnsCache) {
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4CacheList) {
Item = NET_LIST_USER_STRUCT (Entry, DNS4_CACHE, AllCacheLink);
if (StrCmp (HostName, Item->DnsCache.HostName) == 0) {
Index++;
}
}
if (Index != 0) {
Token->RspData.H2AData = AllocatePool (sizeof (DNS_HOST_TO_ADDR_DATA));
if (Token->RspData.H2AData == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ON_EXIT;
}
Token->RspData.H2AData->IpCount = (UINT32)Index;
Token->RspData.H2AData->IpList = AllocatePool (sizeof (EFI_IPv4_ADDRESS) * Index);
if (Token->RspData.H2AData->IpList == NULL) {
if (Token->RspData.H2AData != NULL) {
FreePool (Token->RspData.H2AData);
}
Status = EFI_OUT_OF_RESOURCES;
goto ON_EXIT;
}
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4CacheList) {
Item = NET_LIST_USER_STRUCT (Entry, DNS4_CACHE, AllCacheLink);
if (((UINT32)Index < Token->RspData.H2AData->IpCount) && (StrCmp (HostName, Item->DnsCache.HostName) == 0)) {
CopyMem ((Token->RspData.H2AData->IpList) + Index, Item->DnsCache.IpAddress, sizeof (EFI_IPv4_ADDRESS));
Index++;
}
}
Token->Status = EFI_SUCCESS;
if (Token->Event != NULL) {
gBS->SignalEvent (Token->Event);
DispatchDpc ();
}
Status = Token->Status;
goto ON_EXIT;
}
}
//
// Construct DNS TokenEntry.
//
TokenEntry = AllocateZeroPool (sizeof (DNS4_TOKEN_ENTRY));
if (TokenEntry == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ON_EXIT;
}
TokenEntry->PacketToLive = Token->RetryInterval;
TokenEntry->Token = Token;
TokenEntry->QueryHostName = AllocateZeroPool (StrSize (HostName));
if (TokenEntry->QueryHostName == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ON_EXIT;
}
CopyMem (TokenEntry->QueryHostName, HostName, StrSize (HostName));
//
// Construct QName.
//
QueryName = NetLibCreateDnsQName (TokenEntry->QueryHostName);
if (QueryName == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ON_EXIT;
}
//
// Construct DNS Query Packet.
//
Status = ConstructDNSQuery (Instance, QueryName, DNS_TYPE_A, DNS_CLASS_INET, &Packet);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
ASSERT (Packet != NULL);
//
// Save the token into the Dns4TxTokens map.
//
Status = NetMapInsertTail (&Instance->Dns4TxTokens, TokenEntry, Packet);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
//
// Dns Query Ip
//
Status = DoDnsQuery (Instance, Packet);
if (EFI_ERROR (Status)) {
Dns4RemoveTokenEntry (&Instance->Dns4TxTokens, TokenEntry);
}
ON_EXIT:
if (EFI_ERROR (Status)) {
if (TokenEntry != NULL) {
if (TokenEntry->QueryHostName != NULL) {
FreePool (TokenEntry->QueryHostName);
}
FreePool (TokenEntry);
}
if (Packet != NULL) {
NetbufFree (Packet);
}
}
if (QueryName != NULL) {
FreePool (QueryName);
}
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
IPv4 address to host name translation also known as Reverse DNS lookup.
The IpToHostName() function is used to translate the host address to host name. A type PTR
query is used to get the primary name of the host. Support of this function is optional.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
@param[in] IpAddress Ip Address.
@param[in] Token Point to the completion token to translate host
address to host name.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_UNSUPPORTED This function is not supported.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
This is NULL.
Token is NULL.
Token.Event is NULL.
IpAddress is not valid IP address .
@retval EFI_NO_MAPPING There's no source address is available for use.
@retval EFI_ALREADY_STARTED This Token is being used in another DNS session.
@retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.
**/
EFI_STATUS
EFIAPI
Dns4IpToHostName (
IN EFI_DNS4_PROTOCOL *This,
IN EFI_IPv4_ADDRESS IpAddress,
IN EFI_DNS4_COMPLETION_TOKEN *Token
)
{
return EFI_UNSUPPORTED;
}
/**
Retrieve arbitrary information from the DNS server.
This GeneralLookup() function retrieves arbitrary information from the DNS. The caller
supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All
RR content (e.g., TTL) was returned. The caller need parse the returned RR to get
required information. The function is optional.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
@param[in] QName Pointer to Query Name.
@param[in] QType Query Type.
@param[in] QClass Query Name.
@param[in] Token Point to the completion token to retrieve arbitrary
information.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_UNSUPPORTED This function is not supported. Or the requested
QType is not supported
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
This is NULL.
Token is NULL.
Token.Event is NULL.
QName is NULL.
@retval EFI_NO_MAPPING There's no source address is available for use.
@retval EFI_ALREADY_STARTED This Token is being used in another DNS session.
@retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.
**/
EFI_STATUS
EFIAPI
Dns4GeneralLookUp (
IN EFI_DNS4_PROTOCOL *This,
IN CHAR8 *QName,
IN UINT16 QType,
IN UINT16 QClass,
IN EFI_DNS4_COMPLETION_TOKEN *Token
)
{
EFI_STATUS Status;
DNS_INSTANCE *Instance;
EFI_DNS4_CONFIG_DATA *ConfigData;
DNS4_TOKEN_ENTRY *TokenEntry;
NET_BUF *Packet;
EFI_TPL OldTpl;
Status = EFI_SUCCESS;
TokenEntry = NULL;
Packet = NULL;
//
// Validate the parameters
//
if ((This == NULL) || (QName == NULL) || (Token == NULL)) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);
ConfigData = &(Instance->Dns4CfgData);
if (Instance->State != DNS_STATE_CONFIGED) {
Status = EFI_NOT_STARTED;
goto ON_EXIT;
}
Token->Status = EFI_NOT_READY;
//
// If zero, use the parameter configured through Dns.Configure() interface.
//
if (Token->RetryCount == 0) {
Token->RetryCount = ConfigData->RetryCount;
}
//
// If zero, use the parameter configured through Dns.Configure() interface.
//
if (Token->RetryInterval == 0) {
Token->RetryInterval = ConfigData->RetryInterval;
}
//
// Minimum interval of retry is 2 second. If the retry interval is less than 2 second, then use the 2 second.
//
if (Token->RetryInterval < DNS_DEFAULT_TIMEOUT) {
Token->RetryInterval = DNS_DEFAULT_TIMEOUT;
}
//
// Construct DNS TokenEntry.
//
TokenEntry = AllocateZeroPool (sizeof (DNS4_TOKEN_ENTRY));
if (TokenEntry == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ON_EXIT;
}
TokenEntry->PacketToLive = Token->RetryInterval;
TokenEntry->GeneralLookUp = TRUE;
TokenEntry->Token = Token;
//
// Construct DNS Query Packet.
//
Status = ConstructDNSQuery (Instance, QName, QType, QClass, &Packet);
if (EFI_ERROR (Status)) {
if (TokenEntry != NULL) {
FreePool (TokenEntry);
}
goto ON_EXIT;
}
ASSERT (Packet != NULL);
//
// Save the token into the Dns4TxTokens map.
//
Status = NetMapInsertTail (&Instance->Dns4TxTokens, TokenEntry, Packet);
if (EFI_ERROR (Status)) {
if (TokenEntry != NULL) {
FreePool (TokenEntry);
}
NetbufFree (Packet);
goto ON_EXIT;
}
//
// Dns Query Ip
//
Status = DoDnsQuery (Instance, Packet);
if (EFI_ERROR (Status)) {
Dns4RemoveTokenEntry (&Instance->Dns4TxTokens, TokenEntry);
if (TokenEntry != NULL) {
FreePool (TokenEntry);
}
NetbufFree (Packet);
}
ON_EXIT:
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
This function is to update the DNS Cache.
The UpdateDnsCache() function is used to add/delete/modify DNS cache entry. DNS cache
can be normally dynamically updated after the DNS resolve succeeds. This function
provided capability to manually add/delete/modify the DNS cache.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
@param[in] DeleteFlag If FALSE, this function is to add one entry to the
DNS Cache. If TRUE, this function will delete
matching DNS Cache entry.
@param[in] Override If TRUE, the matching DNS cache entry will be
overwritten with the supplied parameter. If FALSE,
EFI_ACCESS_DENIED will be returned if the entry to
be added is already existed.
@param[in] DnsCacheEntry Pointer to DNS Cache entry.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
This is NULL.
DnsCacheEntry.HostName is NULL.
DnsCacheEntry.IpAddress is NULL.
DnsCacheEntry.Timeout is zero.
@retval EFI_ACCESS_DENIED The DNS cache entry already exists and Override is
not TRUE.
**/
EFI_STATUS
EFIAPI
Dns4UpdateDnsCache (
IN EFI_DNS4_PROTOCOL *This,
IN BOOLEAN DeleteFlag,
IN BOOLEAN Override,
IN EFI_DNS4_CACHE_ENTRY DnsCacheEntry
)
{
EFI_STATUS Status;
EFI_TPL OldTpl;
Status = EFI_SUCCESS;
if ((DnsCacheEntry.HostName == NULL) || (DnsCacheEntry.IpAddress == NULL) || (DnsCacheEntry.Timeout == 0)) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
//
// Update Dns4Cache here.
//
Status = UpdateDns4Cache (&mDriverData->Dns4CacheList, DeleteFlag, Override, DnsCacheEntry);
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Polls for incoming data packets and processes outgoing data packets.
The Poll() function can be used by network drivers and applications to increase the
rate that data packets are moved between the communications device and the transmit
and receive queues.
In some systems, the periodic timer event in the managed network driver may not poll
the underlying communications device fast enough to transmit and/or receive all data
packets without missing incoming packets or dropping outgoing packets. Drivers and
applications that are experiencing packet loss should try calling the Poll()
function more often.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started.
@retval EFI_INVALID_PARAMETER This is NULL.
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
@retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive
queue. Consider increasing the polling rate.
**/
EFI_STATUS
EFIAPI
Dns4Poll (
IN EFI_DNS4_PROTOCOL *This
)
{
DNS_INSTANCE *Instance;
EFI_UDP4_PROTOCOL *Udp;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);
if (Instance->State == DNS_STATE_UNCONFIGED) {
return EFI_NOT_STARTED;
} else if (Instance->State == DNS_STATE_DESTROY) {
return EFI_DEVICE_ERROR;
}
Udp = Instance->UdpIo->Protocol.Udp4;
return Udp->Poll (Udp);
}
/**
Abort an asynchronous DNS operation, including translation between IP and Host, and
general look up behavior.
The Cancel() function is used to abort a pending resolution request. After calling
this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be
signaled. If the token is not in one of the queues, which usually means that the
asynchronous operation has completed, this function will not signal the token and
EFI_NOT_FOUND is returned.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
@param[in] Token Pointer to a token that has been issued by
EFI_DNS4_PROTOCOL.HostNameToIp (),
EFI_DNS4_PROTOCOL.IpToHostName() or
EFI_DNS4_PROTOCOL.GeneralLookup().
If NULL, all pending tokens are aborted.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_NOT_STARTED This EFI DNS4 Protocol instance has not been started.
@retval EFI_INVALID_PARAMETER This is NULL.
@retval EFI_NOT_FOUND When Token is not NULL, and the asynchronous DNS
operation was not found in the transmit queue. It
was either completed or was not issued by
HostNameToIp(), IpToHostName() or GeneralLookup().
**/
EFI_STATUS
EFIAPI
Dns4Cancel (
IN EFI_DNS4_PROTOCOL *This,
IN EFI_DNS4_COMPLETION_TOKEN *Token
)
{
EFI_STATUS Status;
DNS_INSTANCE *Instance;
EFI_TPL OldTpl;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);
if (Instance->State == DNS_STATE_UNCONFIGED) {
return EFI_NOT_STARTED;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
//
// Cancel the tokens specified by Token for this instance.
//
Status = Dns4InstanceCancelToken (Instance, Token);
//
// Dispatch the DPC queued by the NotifyFunction of the canceled token's events.
//
DispatchDpc ();
gBS->RestoreTPL (OldTpl);
return Status;
}
/**
Retrieve mode data of this DNS instance.
This function is used to retrieve DNS mode data for this DNS instance.
@param[in] This Pointer to EFI_DNS6_PROTOCOL instance.
@param[out] DnsModeData Pointer to the caller-allocated storage for the
EFI_DNS6_MODE_DATA data.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED When DnsConfigData is queried, no configuration data
is available because this instance has not been
configured.
@retval EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.
@retval EFI_OUT_OF_RESOURCE Failed to allocate needed resources.
**/
EFI_STATUS
EFIAPI
Dns6GetModeData (
IN EFI_DNS6_PROTOCOL *This,
OUT EFI_DNS6_MODE_DATA *DnsModeData
)
{
DNS_INSTANCE *Instance;
EFI_TPL OldTpl;
UINTN Index;
LIST_ENTRY *Entry;
LIST_ENTRY *Next;
DNS6_SERVER_IP *ServerItem;
EFI_IPv6_ADDRESS *ServerList;
DNS6_CACHE *CacheItem;
EFI_DNS6_CACHE_ENTRY *CacheList;
EFI_STATUS Status;
ServerItem = NULL;
ServerList = NULL;
CacheItem = NULL;
CacheList = NULL;
Status = EFI_SUCCESS;
if ((This == NULL) || (DnsModeData == NULL)) {
return EFI_INVALID_PARAMETER;
}
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL6 (This);
if (Instance->State == DNS_STATE_UNCONFIGED) {
Status = EFI_NOT_STARTED;
goto ON_EXIT;
}
ZeroMem (DnsModeData, sizeof (EFI_DNS6_MODE_DATA));
//
// Get the current configuration data of this instance.
//
Status = Dns6CopyConfigure (&DnsModeData->DnsConfigData, &Instance->Dns6CfgData);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
//
// Get the DnsServerCount and DnsServerList
//
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6ServerList) {
Index++;
}
DnsModeData->DnsServerCount = (UINT32)Index;
ServerList = AllocatePool (sizeof (EFI_IPv6_ADDRESS) * DnsModeData->DnsServerCount);
if (ServerList == NULL) {
Status = EFI_OUT_OF_RESOURCES;
Dns6CleanConfigure (&DnsModeData->DnsConfigData);
goto ON_EXIT;
}
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6ServerList) {
ServerItem = NET_LIST_USER_STRUCT (Entry, DNS6_SERVER_IP, AllServerLink);
CopyMem (ServerList + Index, &ServerItem->Dns6ServerIp, sizeof (EFI_IPv6_ADDRESS));
Index++;
}
DnsModeData->DnsServerList = ServerList;
//
// Get the DnsCacheCount and DnsCacheList
//
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6CacheList) {
Index++;
}
DnsModeData->DnsCacheCount = (UINT32)Index;
CacheList = AllocatePool (sizeof (EFI_DNS6_CACHE_ENTRY) * DnsModeData->DnsCacheCount);
if (CacheList == NULL) {
Status = EFI_OUT_OF_RESOURCES;
Dns6CleanConfigure (&DnsModeData->DnsConfigData);
FreePool (ServerList);
goto ON_EXIT;
}
Index = 0;
NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6CacheList) {
CacheItem = NET_LIST_USER_STRUCT (Entry, DNS6_CACHE, AllCacheLink);
CopyMem (CacheList + Index, &CacheItem->DnsCache, sizeof (EFI_DNS6_CACHE_ENTRY));
Index++;
}
DnsModeData->DnsCacheList = CacheList;
ON_EXIT:
gBS->RestoreTPL (OldTpl);
return Status;