]>
Commit | Line | Data |
---|---|---|
99c048ef | 1 | /** @file\r |
2 | Implementation of EFI_DNS4_PROTOCOL and EFI_DNS6_PROTOCOL interfaces.\r | |
3 | \r | |
0f4e123f | 4 | Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r |
99c048ef | 5 | This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #include "DnsImpl.h"\r | |
16 | \r | |
17 | EFI_DNS4_PROTOCOL mDns4Protocol = {\r | |
18 | Dns4GetModeData,\r | |
19 | Dns4Configure,\r | |
20 | Dns4HostNameToIp,\r | |
21 | Dns4IpToHostName,\r | |
22 | Dns4GeneralLookUp,\r | |
23 | Dns4UpdateDnsCache,\r | |
24 | Dns4Poll,\r | |
25 | Dns4Cancel\r | |
26 | };\r | |
27 | \r | |
28 | EFI_DNS6_PROTOCOL mDns6Protocol = {\r | |
29 | Dns6GetModeData,\r | |
30 | Dns6Configure,\r | |
31 | Dns6HostNameToIp,\r | |
32 | Dns6IpToHostName,\r | |
33 | Dns6GeneralLookUp,\r | |
34 | Dns6UpdateDnsCache,\r | |
35 | Dns6Poll,\r | |
36 | Dns6Cancel\r | |
37 | };\r | |
38 | \r | |
39 | /**\r | |
0f4e123f | 40 | Retrieve mode data of this DNS instance.\r |
99c048ef | 41 | \r |
0f4e123f | 42 | This function is used to retrieve DNS mode data for this DNS instance.\r |
99c048ef | 43 | \r |
0f4e123f JW |
44 | @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r |
45 | @param[out] DnsModeData Point to the mode data.\r | |
99c048ef | 46 | \r |
0f4e123f JW |
47 | @retval EFI_SUCCESS The operation completed successfully.\r |
48 | @retval EFI_NOT_STARTED When DnsConfigData is queried, no configuration data\r | |
49 | is available because this instance has not been\r | |
50 | configured.\r | |
51 | @retval EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.\r | |
52 | @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r | |
99c048ef | 53 | **/\r |
54 | EFI_STATUS\r | |
55 | EFIAPI\r | |
56 | Dns4GetModeData (\r | |
57 | IN EFI_DNS4_PROTOCOL *This,\r | |
58 | OUT EFI_DNS4_MODE_DATA *DnsModeData\r | |
59 | )\r | |
60 | {\r | |
61 | DNS_INSTANCE *Instance;\r | |
62 | \r | |
63 | EFI_TPL OldTpl;\r | |
64 | \r | |
65 | UINTN Index;\r | |
66 | \r | |
67 | LIST_ENTRY *Entry;\r | |
68 | LIST_ENTRY *Next;\r | |
69 | \r | |
70 | DNS4_SERVER_IP *ServerItem;\r | |
71 | EFI_IPv4_ADDRESS *ServerList;\r | |
72 | DNS4_CACHE *CacheItem;\r | |
73 | EFI_DNS4_CACHE_ENTRY *CacheList;\r | |
74 | EFI_STATUS Status;\r | |
75 | \r | |
76 | ServerItem = NULL;\r | |
77 | ServerList = NULL;\r | |
78 | CacheItem = NULL;\r | |
79 | CacheList = NULL;\r | |
80 | Status = EFI_SUCCESS;\r | |
81 | \r | |
82 | \r | |
83 | if ((This == NULL) || (DnsModeData == NULL)) {\r | |
84 | return EFI_INVALID_PARAMETER;\r | |
85 | }\r | |
86 | \r | |
87 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
88 | \r | |
89 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);\r | |
90 | if (Instance->State == DNS_STATE_UNCONFIGED) {\r | |
ac0f5843 JW |
91 | Status = EFI_NOT_STARTED;\r |
92 | goto ON_EXIT;\r | |
99c048ef | 93 | }\r |
94 | \r | |
95 | ZeroMem (DnsModeData, sizeof (EFI_DNS4_MODE_DATA));\r | |
96 | \r | |
97 | //\r | |
98 | // Get the current configuration data of this instance. \r | |
99 | //\r | |
100 | Status = Dns4CopyConfigure (&DnsModeData->DnsConfigData, &Instance->Dns4CfgData);\r | |
101 | if (EFI_ERROR (Status)) {\r | |
ac0f5843 | 102 | goto ON_EXIT;\r |
99c048ef | 103 | }\r |
104 | \r | |
105 | //\r | |
106 | // Get the DnsServerCount and DnsServerList\r | |
107 | //\r | |
108 | Index = 0;\r | |
109 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4ServerList) {\r | |
110 | Index++;\r | |
111 | }\r | |
112 | DnsModeData->DnsServerCount = (UINT32) Index;\r | |
113 | ServerList = AllocatePool (sizeof (EFI_IPv4_ADDRESS) * DnsModeData->DnsServerCount);\r | |
ac0f5843 JW |
114 | if (ServerList == NULL) {\r |
115 | Status = EFI_OUT_OF_RESOURCES;\r | |
116 | Dns4CleanConfigure (&DnsModeData->DnsConfigData);\r | |
117 | goto ON_EXIT;\r | |
118 | }\r | |
119 | \r | |
99c048ef | 120 | Index = 0;\r |
121 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4ServerList) {\r | |
122 | ServerItem = NET_LIST_USER_STRUCT (Entry, DNS4_SERVER_IP, AllServerLink);\r | |
123 | CopyMem (ServerList + Index, &ServerItem->Dns4ServerIp, sizeof (EFI_IPv4_ADDRESS));\r | |
124 | Index++;\r | |
125 | }\r | |
126 | DnsModeData->DnsServerList = ServerList;\r | |
127 | \r | |
128 | //\r | |
129 | // Get the DnsCacheCount and DnsCacheList\r | |
130 | //\r | |
131 | Index =0;\r | |
132 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4CacheList) {\r | |
133 | Index++;\r | |
134 | }\r | |
135 | DnsModeData->DnsCacheCount = (UINT32) Index;\r | |
136 | CacheList = AllocatePool (sizeof (EFI_DNS4_CACHE_ENTRY) * DnsModeData->DnsCacheCount);\r | |
ac0f5843 JW |
137 | if (CacheList == NULL) {\r |
138 | Status = EFI_OUT_OF_RESOURCES;\r | |
139 | Dns4CleanConfigure (&DnsModeData->DnsConfigData);\r | |
140 | FreePool (ServerList);\r | |
141 | goto ON_EXIT;\r | |
142 | }\r | |
143 | \r | |
99c048ef | 144 | Index =0;\r |
145 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4CacheList) {\r | |
146 | CacheItem = NET_LIST_USER_STRUCT (Entry, DNS4_CACHE, AllCacheLink);\r | |
147 | CopyMem (CacheList + Index, &CacheItem->DnsCache, sizeof (EFI_DNS4_CACHE_ENTRY));\r | |
148 | Index++;\r | |
149 | }\r | |
150 | DnsModeData->DnsCacheList = CacheList;\r | |
151 | \r | |
ac0f5843 | 152 | ON_EXIT:\r |
99c048ef | 153 | gBS->RestoreTPL (OldTpl);\r |
ac0f5843 | 154 | return Status;\r |
99c048ef | 155 | }\r |
156 | \r | |
157 | /**\r | |
0f4e123f JW |
158 | Configure this DNS instance.\r |
159 | \r | |
160 | This function is used to configure DNS mode data for this DNS instance.\r | |
161 | \r | |
162 | @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r | |
163 | @param[in] DnsConfigData Point to the Configuration data.\r | |
164 | \r | |
165 | @retval EFI_SUCCESS The operation completed successfully.\r | |
166 | @retval EFI_UNSUPPORTED The designated protocol is not supported.\r | |
167 | @retval EFI_INVALID_PARAMTER Thisis NULL.\r | |
168 | The StationIp address provided in DnsConfigData is not a \r | |
169 | valid unicast.\r | |
170 | DnsServerList is NULL while DnsServerListCount\r | |
171 | is not ZERO.\r | |
172 | DnsServerListCount is ZERO while DnsServerList\r | |
173 | is not NULL\r | |
174 | @retval EFI_OUT_OF_RESOURCES The DNS instance data or required space could not be\r | |
175 | allocated.\r | |
176 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The\r | |
177 | EFI DNSv4 Protocol instance is not configured.\r | |
178 | @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To \r | |
179 | reconfigure the instance the caller must call Configure() \r | |
180 | with NULL first to return driver to unconfigured state.\r | |
99c048ef | 181 | **/\r |
182 | EFI_STATUS\r | |
183 | EFIAPI\r | |
184 | Dns4Configure (\r | |
185 | IN EFI_DNS4_PROTOCOL *This,\r | |
186 | IN EFI_DNS4_CONFIG_DATA *DnsConfigData\r | |
187 | )\r | |
188 | {\r | |
189 | EFI_STATUS Status;\r | |
190 | DNS_INSTANCE *Instance;\r | |
191 | \r | |
192 | EFI_TPL OldTpl;\r | |
193 | IP4_ADDR Ip;\r | |
194 | IP4_ADDR Netmask;\r | |
195 | \r | |
196 | UINT32 ServerListCount;\r | |
197 | EFI_IPv4_ADDRESS *ServerList; \r | |
198 | \r | |
199 | Status = EFI_SUCCESS;\r | |
200 | ServerList = NULL;\r | |
201 | \r | |
202 | if (This == NULL || \r | |
203 | (DnsConfigData != NULL && ((DnsConfigData->DnsServerListCount != 0 && DnsConfigData->DnsServerList == NULL) || \r | |
204 | (DnsConfigData->DnsServerListCount == 0 && DnsConfigData->DnsServerList != NULL)))) {\r | |
205 | return EFI_INVALID_PARAMETER;\r | |
206 | }\r | |
207 | \r | |
208 | if (DnsConfigData != NULL && DnsConfigData->Protocol != DNS_PROTOCOL_UDP) {\r | |
209 | return EFI_UNSUPPORTED;\r | |
210 | }\r | |
211 | \r | |
212 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
213 | \r | |
214 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);\r | |
215 | \r | |
216 | if (DnsConfigData == NULL) {\r | |
217 | ZeroMem (&Instance->SessionDnsServer, sizeof (EFI_IP_ADDRESS));\r | |
218 | \r | |
219 | //\r | |
220 | // Reset the Instance if ConfigData is NULL\r | |
221 | //\r | |
222 | if (!NetMapIsEmpty(&Instance->Dns4TxTokens)) {\r | |
223 | Dns4InstanceCancelToken(Instance, NULL);\r | |
224 | }\r | |
225 | \r | |
226 | Instance->MaxRetry = 0;\r | |
227 | \r | |
228 | if (Instance->UdpIo != NULL){\r | |
229 | UdpIoCleanIo (Instance->UdpIo);\r | |
230 | }\r | |
231 | \r | |
232 | if (Instance->Dns4CfgData.DnsServerList != NULL) {\r | |
233 | FreePool (Instance->Dns4CfgData.DnsServerList);\r | |
234 | }\r | |
235 | ZeroMem (&Instance->Dns4CfgData, sizeof (EFI_DNS4_CONFIG_DATA));\r | |
236 | \r | |
237 | Instance->State = DNS_STATE_UNCONFIGED;\r | |
238 | } else {\r | |
239 | //\r | |
240 | // Configure the parameters for new operation.\r | |
241 | //\r | |
242 | CopyMem (&Ip, &DnsConfigData->StationIp, sizeof (IP4_ADDR));\r | |
243 | CopyMem (&Netmask, &DnsConfigData->SubnetMask, sizeof (IP4_ADDR));\r | |
244 | \r | |
245 | Ip = NTOHL (Ip);\r | |
246 | Netmask = NTOHL (Netmask);\r | |
247 | \r | |
248 | if (!DnsConfigData->UseDefaultSetting &&\r | |
249 | ((!IP4_IS_VALID_NETMASK (Netmask) || !NetIp4IsUnicast (Ip, Netmask)))) {\r | |
250 | Status = EFI_INVALID_PARAMETER;\r | |
251 | goto ON_EXIT;\r | |
252 | }\r | |
253 | \r | |
254 | Status = Dns4CopyConfigure (&Instance->Dns4CfgData, DnsConfigData);\r | |
255 | if (EFI_ERROR (Status)) {\r | |
256 | goto ON_EXIT;\r | |
257 | }\r | |
258 | \r | |
259 | if (DnsConfigData->DnsServerListCount == 0 || DnsConfigData->DnsServerList == NULL) {\r | |
260 | gBS->RestoreTPL (OldTpl); \r | |
261 | \r | |
262 | //\r | |
263 | // The DNS instance will retrieve DNS server from DHCP Server\r | |
264 | //\r | |
265 | Status = GetDns4ServerFromDhcp4 (\r | |
266 | Instance,\r | |
267 | &ServerListCount, \r | |
268 | &ServerList\r | |
269 | );\r | |
270 | if (EFI_ERROR (Status)) {\r | |
271 | return Status;\r | |
272 | }\r | |
273 | \r | |
274 | ASSERT(ServerList != NULL);\r | |
275 | \r | |
276 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
277 | \r | |
278 | CopyMem (&Instance->SessionDnsServer.v4, &ServerList[0], sizeof (EFI_IPv4_ADDRESS));\r | |
279 | } else {\r | |
280 | CopyMem (&Instance->SessionDnsServer.v4, &DnsConfigData->DnsServerList[0], sizeof (EFI_IPv4_ADDRESS));\r | |
281 | }\r | |
282 | \r | |
283 | //\r | |
284 | // Config UDP\r | |
285 | //\r | |
286 | Status = Dns4ConfigUdp (Instance, Instance->UdpIo);\r | |
287 | if (EFI_ERROR (Status)) {\r | |
288 | if (Instance->Dns4CfgData.DnsServerList != NULL) {\r | |
289 | FreePool (Instance->Dns4CfgData.DnsServerList);\r | |
8aa2cdd7 | 290 | Instance->Dns4CfgData.DnsServerList = NULL;\r |
99c048ef | 291 | }\r |
292 | goto ON_EXIT;\r | |
293 | }\r | |
294 | \r | |
295 | //\r | |
296 | // Add configured DNS server used by this instance to ServerList.\r | |
297 | //\r | |
298 | Status = AddDns4ServerIp (&mDriverData->Dns4ServerList, Instance->SessionDnsServer.v4);\r | |
299 | if (EFI_ERROR (Status)) {\r | |
300 | if (Instance->Dns4CfgData.DnsServerList != NULL) {\r | |
301 | FreePool (Instance->Dns4CfgData.DnsServerList);\r | |
8aa2cdd7 | 302 | Instance->Dns4CfgData.DnsServerList = NULL;\r |
99c048ef | 303 | }\r |
304 | goto ON_EXIT;\r | |
305 | }\r | |
306 | \r | |
307 | Instance->State = DNS_STATE_CONFIGED;\r | |
308 | }\r | |
309 | \r | |
310 | ON_EXIT:\r | |
311 | gBS->RestoreTPL (OldTpl);\r | |
312 | return Status;\r | |
313 | }\r | |
314 | \r | |
315 | /**\r | |
0f4e123f JW |
316 | Host name to host address translation.\r |
317 | \r | |
318 | The HostNameToIp () function is used to translate the host name to host IP address. A\r | |
319 | type A query is used to get the one or more IP addresses for this host.\r | |
320 | \r | |
321 | @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r | |
322 | @param[in] HostName Host name.\r | |
323 | @param[in] Token Point to the completion token to translate host name\r | |
324 | to host address.\r | |
325 | \r | |
326 | @retval EFI_SUCCESS The operation completed successfully.\r | |
327 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
328 | This is NULL.\r | |
329 | Token is NULL.\r | |
330 | Token.Event is NULL.\r | |
331 | HostName is NULL. HostName string is unsupported format.\r | |
332 | @retval EFI_NO_MAPPING There's no source address is available for use.\r | |
333 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
99c048ef | 334 | **/\r |
335 | EFI_STATUS\r | |
336 | EFIAPI\r | |
337 | Dns4HostNameToIp (\r | |
338 | IN EFI_DNS4_PROTOCOL *This,\r | |
339 | IN CHAR16 *HostName,\r | |
340 | IN EFI_DNS4_COMPLETION_TOKEN *Token\r | |
341 | )\r | |
342 | {\r | |
343 | EFI_STATUS Status;\r | |
344 | \r | |
345 | DNS_INSTANCE *Instance;\r | |
346 | \r | |
347 | EFI_DNS4_CONFIG_DATA *ConfigData;\r | |
348 | \r | |
349 | UINTN Index;\r | |
350 | DNS4_CACHE *Item;\r | |
351 | LIST_ENTRY *Entry;\r | |
352 | LIST_ENTRY *Next;\r | |
353 | \r | |
fcae1a99 JW |
354 | CHAR8 *QueryName;\r |
355 | \r | |
99c048ef | 356 | DNS4_TOKEN_ENTRY *TokenEntry;\r |
357 | NET_BUF *Packet;\r | |
358 | \r | |
359 | EFI_TPL OldTpl;\r | |
360 | \r | |
361 | Status = EFI_SUCCESS;\r | |
362 | Item = NULL;\r | |
fcae1a99 | 363 | QueryName = NULL;\r |
99c048ef | 364 | TokenEntry = NULL;\r |
365 | Packet = NULL;\r | |
366 | \r | |
367 | //\r | |
368 | // Validate the parameters\r | |
369 | //\r | |
370 | if ((This == NULL) || (HostName == NULL) || Token == NULL) {\r | |
371 | return EFI_INVALID_PARAMETER;\r | |
372 | }\r | |
373 | \r | |
374 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
375 | \r | |
376 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);\r | |
377 | \r | |
378 | ConfigData = &(Instance->Dns4CfgData);\r | |
379 | \r | |
380 | Instance->MaxRetry = ConfigData->RetryCount;\r | |
381 | \r | |
382 | Token->Status = EFI_NOT_READY;\r | |
383 | Token->RetryCount = 0;\r | |
384 | Token->RetryInterval = ConfigData->RetryInterval;\r | |
385 | \r | |
386 | if (Instance->State != DNS_STATE_CONFIGED) {\r | |
387 | Status = EFI_NOT_STARTED;\r | |
388 | goto ON_EXIT;\r | |
389 | }\r | |
390 | \r | |
391 | //\r | |
392 | // Check the MaxRetry and RetryInterval values.\r | |
393 | //\r | |
394 | if (Instance->MaxRetry == 0) {\r | |
395 | Instance->MaxRetry = DNS_DEFAULT_RETRY;\r | |
396 | }\r | |
397 | \r | |
398 | if (Token->RetryInterval < DNS_DEFAULT_TIMEOUT) {\r | |
399 | Token->RetryInterval = DNS_DEFAULT_TIMEOUT;\r | |
400 | }\r | |
401 | \r | |
402 | //\r | |
403 | // Check cache\r | |
404 | //\r | |
405 | if (ConfigData->EnableDnsCache) {\r | |
406 | Index = 0;\r | |
407 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4CacheList) {\r | |
408 | Item = NET_LIST_USER_STRUCT (Entry, DNS4_CACHE, AllCacheLink);\r | |
409 | if (StrCmp (HostName, Item->DnsCache.HostName) == 0) {\r | |
410 | Index++;\r | |
411 | }\r | |
412 | }\r | |
413 | \r | |
414 | if (Index != 0) {\r | |
415 | Token->RspData.H2AData = AllocatePool (sizeof (DNS_HOST_TO_ADDR_DATA));\r | |
416 | if (Token->RspData.H2AData == NULL) {\r | |
417 | Status = EFI_OUT_OF_RESOURCES;\r | |
418 | goto ON_EXIT;\r | |
419 | }\r | |
420 | \r | |
421 | Token->RspData.H2AData->IpCount = (UINT32)Index;\r | |
422 | Token->RspData.H2AData->IpList = AllocatePool (sizeof (EFI_IPv4_ADDRESS) * Index);\r | |
423 | if (Token->RspData.H2AData->IpList == NULL) {\r | |
424 | if (Token->RspData.H2AData != NULL) {\r | |
425 | FreePool (Token->RspData.H2AData);\r | |
426 | }\r | |
427 | \r | |
428 | Status = EFI_OUT_OF_RESOURCES;\r | |
429 | goto ON_EXIT;\r | |
430 | }\r | |
431 | \r | |
432 | Index = 0;\r | |
433 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns4CacheList) {\r | |
434 | Item = NET_LIST_USER_STRUCT (Entry, DNS4_CACHE, AllCacheLink);\r | |
435 | if ((UINT32)Index < Token->RspData.H2AData->IpCount && StrCmp (HostName, Item->DnsCache.HostName) == 0) {\r | |
436 | CopyMem ((Token->RspData.H2AData->IpList) + Index, Item->DnsCache.IpAddress, sizeof (EFI_IPv4_ADDRESS));\r | |
437 | Index++; \r | |
438 | }\r | |
439 | }\r | |
440 | \r | |
441 | Token->Status = EFI_SUCCESS;\r | |
442 | \r | |
443 | if (Token->Event != NULL) {\r | |
444 | gBS->SignalEvent (Token->Event);\r | |
445 | DispatchDpc ();\r | |
446 | }\r | |
447 | \r | |
448 | Status = Token->Status;\r | |
449 | goto ON_EXIT;\r | |
450 | } \r | |
451 | }\r | |
452 | \r | |
453 | //\r | |
454 | // Construct DNS TokenEntry.\r | |
455 | //\r | |
456 | TokenEntry = AllocateZeroPool (sizeof(DNS4_TOKEN_ENTRY));\r | |
457 | if (TokenEntry == NULL) {\r | |
458 | Status = EFI_OUT_OF_RESOURCES;\r | |
459 | goto ON_EXIT;\r | |
460 | }\r | |
461 | \r | |
462 | TokenEntry->PacketToLive = Token->RetryInterval;\r | |
463 | TokenEntry->QueryHostName = HostName;\r | |
464 | TokenEntry->Token = Token;\r | |
465 | \r | |
fcae1a99 JW |
466 | //\r |
467 | // Construct QName.\r | |
468 | //\r | |
3700da73 | 469 | QueryName = NetLibCreateDnsQName (TokenEntry->QueryHostName);\r |
fcae1a99 JW |
470 | if (QueryName == NULL) {\r |
471 | Status = EFI_OUT_OF_RESOURCES;\r | |
472 | goto ON_EXIT;\r | |
473 | }\r | |
474 | \r | |
99c048ef | 475 | //\r |
476 | // Construct DNS Query Packet.\r | |
477 | //\r | |
fcae1a99 | 478 | Status = ConstructDNSQuery (Instance, QueryName, DNS_TYPE_A, DNS_CLASS_INET, &Packet);\r |
99c048ef | 479 | if (EFI_ERROR (Status)) {\r |
480 | if (TokenEntry != NULL) {\r | |
481 | FreePool (TokenEntry);\r | |
482 | }\r | |
483 | \r | |
484 | goto ON_EXIT;\r | |
485 | }\r | |
486 | \r | |
8339166d JW |
487 | ASSERT (Packet != NULL);\r |
488 | \r | |
99c048ef | 489 | //\r |
490 | // Save the token into the Dns4TxTokens map.\r | |
491 | //\r | |
492 | Status = NetMapInsertTail (&Instance->Dns4TxTokens, TokenEntry, Packet);\r | |
493 | if (EFI_ERROR (Status)) {\r | |
494 | if (TokenEntry != NULL) {\r | |
495 | FreePool (TokenEntry);\r | |
496 | }\r | |
497 | \r | |
498 | NetbufFree (Packet);\r | |
499 | \r | |
500 | goto ON_EXIT;\r | |
501 | }\r | |
502 | \r | |
503 | //\r | |
504 | // Dns Query Ip\r | |
505 | //\r | |
506 | Status = DoDnsQuery (Instance, Packet);\r | |
507 | if (EFI_ERROR (Status)) {\r | |
520a0746 JW |
508 | Dns4RemoveTokenEntry (&Instance->Dns4TxTokens, TokenEntry);\r |
509 | \r | |
99c048ef | 510 | if (TokenEntry != NULL) {\r |
511 | FreePool (TokenEntry);\r | |
512 | }\r | |
513 | \r | |
514 | NetbufFree (Packet);\r | |
515 | }\r | |
516 | \r | |
517 | ON_EXIT:\r | |
fcae1a99 JW |
518 | if (QueryName != NULL) {\r |
519 | FreePool (QueryName);\r | |
520 | }\r | |
521 | \r | |
99c048ef | 522 | gBS->RestoreTPL (OldTpl);\r |
523 | return Status;\r | |
524 | }\r | |
525 | \r | |
526 | /**\r | |
0f4e123f JW |
527 | IPv4 address to host name translation also known as Reverse DNS lookup.\r |
528 | \r | |
529 | The IpToHostName() function is used to translate the host address to host name. A type PTR \r | |
530 | query is used to get the primary name of the host. Support of this function is optional.\r | |
531 | \r | |
532 | @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r | |
533 | @param[in] IpAddress Ip Address.\r | |
534 | @param[in] Token Point to the completion token to translate host\r | |
535 | address to host name.\r | |
536 | \r | |
537 | @retval EFI_SUCCESS The operation completed successfully.\r | |
538 | @retval EFI_UNSUPPORTED This function is not supported.\r | |
539 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
540 | This is NULL.\r | |
541 | Token is NULL.\r | |
542 | Token.Event is NULL.\r | |
543 | IpAddress is not valid IP address .\r | |
544 | @retval EFI_NO_MAPPING There's no source address is available for use.\r | |
545 | @retval EFI_ALREADY_STARTED This Token is being used in another DNS session.\r | |
546 | @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r | |
99c048ef | 547 | **/\r |
548 | EFI_STATUS\r | |
549 | EFIAPI\r | |
550 | Dns4IpToHostName (\r | |
551 | IN EFI_DNS4_PROTOCOL *This,\r | |
552 | IN EFI_IPv4_ADDRESS IpAddress,\r | |
553 | IN EFI_DNS4_COMPLETION_TOKEN *Token\r | |
554 | )\r | |
555 | {\r | |
556 | return EFI_UNSUPPORTED;\r | |
557 | }\r | |
558 | \r | |
559 | /**\r | |
0f4e123f JW |
560 | Retrieve arbitrary information from the DNS server. \r |
561 | \r | |
562 | This GeneralLookup() function retrieves arbitrary information from the DNS. The caller\r | |
563 | supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All\r | |
564 | RR content (e.g., TTL) was returned. The caller need parse the returned RR to get\r | |
565 | required information. The function is optional.\r | |
566 | \r | |
567 | @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r | |
568 | @param[in] QName Pointer to Query Name.\r | |
569 | @param[in] QType Query Type.\r | |
570 | @param[in] QClass Query Name.\r | |
571 | @param[in] Token Point to the completion token to retrieve arbitrary\r | |
572 | information.\r | |
573 | \r | |
574 | @retval EFI_SUCCESS The operation completed successfully.\r | |
575 | @retval EFI_UNSUPPORTED This function is not supported. Or the requested\r | |
576 | QType is not supported\r | |
577 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
578 | This is NULL.\r | |
579 | Token is NULL.\r | |
580 | Token.Event is NULL.\r | |
581 | QName is NULL.\r | |
582 | @retval EFI_NO_MAPPING There's no source address is available for use.\r | |
583 | @retval EFI_ALREADY_STARTED This Token is being used in another DNS session.\r | |
584 | @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r | |
99c048ef | 585 | **/\r |
586 | EFI_STATUS\r | |
587 | EFIAPI\r | |
588 | Dns4GeneralLookUp (\r | |
589 | IN EFI_DNS4_PROTOCOL *This,\r | |
590 | IN CHAR8 *QName,\r | |
591 | IN UINT16 QType, \r | |
592 | IN UINT16 QClass,\r | |
593 | IN EFI_DNS4_COMPLETION_TOKEN *Token\r | |
594 | )\r | |
595 | {\r | |
fcae1a99 JW |
596 | EFI_STATUS Status;\r |
597 | \r | |
598 | DNS_INSTANCE *Instance;\r | |
599 | \r | |
600 | EFI_DNS4_CONFIG_DATA *ConfigData;\r | |
601 | \r | |
602 | DNS4_TOKEN_ENTRY *TokenEntry;\r | |
603 | NET_BUF *Packet;\r | |
604 | \r | |
605 | EFI_TPL OldTpl;\r | |
606 | \r | |
607 | Status = EFI_SUCCESS;\r | |
608 | TokenEntry = NULL;\r | |
609 | Packet = NULL;\r | |
610 | \r | |
611 | //\r | |
612 | // Validate the parameters\r | |
613 | //\r | |
614 | if ((This == NULL) || (QName == NULL) || Token == NULL) {\r | |
615 | return EFI_INVALID_PARAMETER;\r | |
616 | }\r | |
617 | \r | |
618 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
619 | \r | |
620 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);\r | |
621 | \r | |
622 | ConfigData = &(Instance->Dns4CfgData);\r | |
623 | \r | |
624 | Instance->MaxRetry = ConfigData->RetryCount;\r | |
625 | \r | |
626 | Token->Status = EFI_NOT_READY;\r | |
627 | Token->RetryCount = 0;\r | |
628 | Token->RetryInterval = ConfigData->RetryInterval;\r | |
629 | \r | |
630 | if (Instance->State != DNS_STATE_CONFIGED) {\r | |
631 | Status = EFI_NOT_STARTED;\r | |
632 | goto ON_EXIT;\r | |
633 | }\r | |
634 | \r | |
635 | //\r | |
636 | // Check the MaxRetry and RetryInterval values.\r | |
637 | //\r | |
638 | if (Instance->MaxRetry == 0) {\r | |
639 | Instance->MaxRetry = DNS_DEFAULT_RETRY;\r | |
640 | }\r | |
641 | \r | |
642 | if (Token->RetryInterval < DNS_DEFAULT_TIMEOUT) {\r | |
643 | Token->RetryInterval = DNS_DEFAULT_TIMEOUT;\r | |
644 | }\r | |
645 | \r | |
646 | //\r | |
647 | // Construct DNS TokenEntry.\r | |
648 | //\r | |
649 | TokenEntry = AllocateZeroPool (sizeof(DNS4_TOKEN_ENTRY));\r | |
650 | if (TokenEntry == NULL) {\r | |
651 | Status = EFI_OUT_OF_RESOURCES;\r | |
652 | goto ON_EXIT;\r | |
653 | }\r | |
654 | \r | |
655 | TokenEntry->PacketToLive = Token->RetryInterval;\r | |
656 | TokenEntry->GeneralLookUp = TRUE;\r | |
657 | TokenEntry->Token = Token;\r | |
658 | \r | |
659 | //\r | |
660 | // Construct DNS Query Packet.\r | |
661 | //\r | |
662 | Status = ConstructDNSQuery (Instance, QName, QType, QClass, &Packet);\r | |
663 | if (EFI_ERROR (Status)) {\r | |
664 | if (TokenEntry != NULL) {\r | |
665 | FreePool (TokenEntry);\r | |
666 | }\r | |
667 | \r | |
668 | goto ON_EXIT;\r | |
669 | }\r | |
670 | \r | |
8339166d JW |
671 | ASSERT (Packet != NULL);\r |
672 | \r | |
fcae1a99 JW |
673 | //\r |
674 | // Save the token into the Dns4TxTokens map.\r | |
675 | //\r | |
676 | Status = NetMapInsertTail (&Instance->Dns4TxTokens, TokenEntry, Packet);\r | |
677 | if (EFI_ERROR (Status)) {\r | |
678 | if (TokenEntry != NULL) {\r | |
679 | FreePool (TokenEntry);\r | |
680 | }\r | |
681 | \r | |
682 | NetbufFree (Packet);\r | |
683 | \r | |
684 | goto ON_EXIT;\r | |
685 | }\r | |
686 | \r | |
687 | //\r | |
688 | // Dns Query Ip\r | |
689 | //\r | |
690 | Status = DoDnsQuery (Instance, Packet);\r | |
691 | if (EFI_ERROR (Status)) {\r | |
520a0746 JW |
692 | Dns4RemoveTokenEntry (&Instance->Dns4TxTokens, TokenEntry);\r |
693 | \r | |
fcae1a99 JW |
694 | if (TokenEntry != NULL) {\r |
695 | FreePool (TokenEntry);\r | |
696 | }\r | |
697 | \r | |
698 | NetbufFree (Packet);\r | |
699 | }\r | |
700 | \r | |
701 | ON_EXIT:\r | |
702 | gBS->RestoreTPL (OldTpl);\r | |
703 | return Status;\r | |
99c048ef | 704 | }\r |
705 | \r | |
706 | /**\r | |
0f4e123f JW |
707 | This function is to update the DNS Cache.\r |
708 | \r | |
709 | The UpdateDnsCache() function is used to add/delete/modify DNS cache entry. DNS cache\r | |
710 | can be normally dynamically updated after the DNS resolve succeeds. This function\r | |
711 | provided capability to manually add/delete/modify the DNS cache.\r | |
712 | \r | |
713 | @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r | |
714 | @param[in] DeleteFlag If FALSE, this function is to add one entry to the\r | |
715 | DNS Cahce. If TRUE, this function will delete\r | |
716 | matching DNS Cache entry.\r | |
717 | @param[in] Override If TRUE, the maching DNS cache entry will be\r | |
718 | overwritten with the supplied parameter. If FALSE,\r | |
719 | EFI_ACCESS_DENIED will be returned if the entry to\r | |
720 | be added is already existed.\r | |
721 | @param[in] DnsCacheEntry Pointer to DNS Cache entry.\r | |
722 | \r | |
723 | @retval EFI_SUCCESS The operation completed successfully.\r | |
724 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
725 | This is NULL.\r | |
726 | DnsCacheEntry.HostName is NULL.\r | |
727 | DnsCacheEntry.IpAddress is NULL.\r | |
728 | DnsCacheEntry.Timeout is zero.\r | |
729 | @retval EFI_ACCESS_DENIED The DNS cache entry already exists and Override is\r | |
730 | not TRUE.\r | |
99c048ef | 731 | **/\r |
732 | EFI_STATUS\r | |
733 | EFIAPI\r | |
734 | Dns4UpdateDnsCache (\r | |
735 | IN EFI_DNS4_PROTOCOL *This,\r | |
736 | IN BOOLEAN DeleteFlag,\r | |
737 | IN BOOLEAN Override,\r | |
738 | IN EFI_DNS4_CACHE_ENTRY DnsCacheEntry\r | |
739 | )\r | |
740 | {\r | |
741 | EFI_STATUS Status; \r | |
742 | EFI_TPL OldTpl;\r | |
743 | \r | |
744 | Status = EFI_SUCCESS;\r | |
745 | \r | |
746 | if (DnsCacheEntry.HostName == NULL || DnsCacheEntry.IpAddress == NULL || DnsCacheEntry.Timeout == 0) {\r | |
747 | return EFI_INVALID_PARAMETER; \r | |
748 | }\r | |
749 | \r | |
750 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
751 | \r | |
752 | //\r | |
753 | // Update Dns4Cache here.\r | |
754 | //\r | |
755 | Status = UpdateDns4Cache (&mDriverData->Dns4CacheList, DeleteFlag, Override, DnsCacheEntry);\r | |
756 | \r | |
757 | gBS->RestoreTPL (OldTpl);\r | |
758 | \r | |
759 | return Status;\r | |
760 | }\r | |
761 | \r | |
762 | /**\r | |
0f4e123f JW |
763 | Polls for incoming data packets and processes outgoing data packets.\r |
764 | \r | |
765 | The Poll() function can be used by network drivers and applications to increase the\r | |
766 | rate that data packets are moved between the communications device and the transmit\r | |
767 | and receive queues.\r | |
768 | In some systems, the periodic timer event in the managed network driver may not poll\r | |
769 | the underlying communications device fast enough to transmit and/or receive all data\r | |
770 | packets without missing incoming packets or dropping outgoing packets. Drivers and\r | |
771 | applications that are experiencing packet loss should try calling the Poll()\r | |
772 | function more often.\r | |
773 | \r | |
774 | @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r | |
775 | \r | |
776 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
777 | @retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started.\r | |
778 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
779 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
780 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive\r | |
781 | queue. Consider increasing the polling rate.\r | |
99c048ef | 782 | **/\r |
783 | EFI_STATUS\r | |
784 | EFIAPI\r | |
785 | Dns4Poll (\r | |
786 | IN EFI_DNS4_PROTOCOL *This\r | |
787 | )\r | |
788 | {\r | |
789 | DNS_INSTANCE *Instance;\r | |
790 | EFI_UDP4_PROTOCOL *Udp;\r | |
791 | \r | |
792 | if (This == NULL) {\r | |
793 | return EFI_INVALID_PARAMETER;\r | |
794 | }\r | |
795 | \r | |
796 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);\r | |
797 | \r | |
798 | if (Instance->State == DNS_STATE_UNCONFIGED) {\r | |
799 | return EFI_NOT_STARTED;\r | |
800 | } else if (Instance->State == DNS_STATE_DESTROY) {\r | |
801 | return EFI_DEVICE_ERROR;\r | |
802 | }\r | |
803 | \r | |
804 | Udp = Instance->UdpIo->Protocol.Udp4;\r | |
805 | \r | |
806 | return Udp->Poll (Udp);\r | |
807 | }\r | |
808 | \r | |
809 | /**\r | |
0f4e123f JW |
810 | Abort an asynchronous DNS operation, including translation between IP and Host, and\r |
811 | general look up behavior.\r | |
812 | \r | |
813 | The Cancel() function is used to abort a pending resolution request. After calling\r | |
814 | this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be\r | |
815 | signaled. If the token is not in one of the queues, which usually means that the\r | |
816 | asynchronous operation has completed, this function will not signal the token and\r | |
817 | EFI_NOT_FOUND is returned.\r | |
818 | \r | |
819 | @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r | |
820 | @param[in] Token Pointer to a token that has been issued by\r | |
821 | EFI_DNS4_PROTOCOL.HostNameToIp (),\r | |
822 | EFI_DNS4_PROTOCOL.IpToHostName() or\r | |
823 | EFI_DNS4_PROTOCOL.GeneralLookup().\r | |
824 | If NULL, all pending tokens are aborted.\r | |
825 | \r | |
826 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
827 | @retval EFI_NOT_STARTED This EFI DNS4 Protocol instance has not been started.\r | |
828 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
829 | @retval EFI_NOT_FOUND When Token is not NULL, and the asynchronous DNS\r | |
830 | operation was not found in the transmit queue. It\r | |
831 | was either completed or was not issued by\r | |
832 | HostNameToIp(), IpToHostName() or GeneralLookup().\r | |
99c048ef | 833 | **/\r |
834 | EFI_STATUS\r | |
835 | EFIAPI\r | |
836 | Dns4Cancel (\r | |
837 | IN EFI_DNS4_PROTOCOL *This,\r | |
838 | IN EFI_DNS4_COMPLETION_TOKEN *Token\r | |
839 | )\r | |
840 | {\r | |
841 | EFI_STATUS Status;\r | |
842 | DNS_INSTANCE *Instance;\r | |
843 | EFI_TPL OldTpl;\r | |
844 | \r | |
845 | if (This == NULL) {\r | |
846 | return EFI_INVALID_PARAMETER;\r | |
847 | }\r | |
848 | \r | |
849 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (This);\r | |
850 | \r | |
851 | if (Instance->State == DNS_STATE_UNCONFIGED) {\r | |
852 | return EFI_NOT_STARTED;\r | |
853 | }\r | |
854 | \r | |
855 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
856 | \r | |
857 | //\r | |
858 | // Cancle the tokens specified by Token for this instance.\r | |
859 | //\r | |
860 | Status = Dns4InstanceCancelToken (Instance, Token);\r | |
861 | \r | |
862 | //\r | |
863 | // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.\r | |
864 | //\r | |
865 | DispatchDpc ();\r | |
866 | \r | |
867 | gBS->RestoreTPL (OldTpl);\r | |
868 | \r | |
869 | return Status;\r | |
870 | }\r | |
871 | \r | |
872 | /**\r | |
0f4e123f | 873 | Retrieve mode data of this DNS instance.\r |
99c048ef | 874 | \r |
0f4e123f | 875 | This function is used to retrieve DNS mode data for this DNS instance.\r |
99c048ef | 876 | \r |
0f4e123f JW |
877 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r |
878 | @param[out] DnsModeData Pointer to the caller-allocated storage for the \r | |
879 | EFI_DNS6_MODE_DATA data.\r | |
99c048ef | 880 | \r |
0f4e123f JW |
881 | @retval EFI_SUCCESS The operation completed successfully.\r |
882 | @retval EFI_NOT_STARTED When DnsConfigData is queried, no configuration data\r | |
883 | is available because this instance has not been\r | |
884 | configured.\r | |
885 | @retval EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.\r | |
886 | @retval EFI_OUT_OF_RESOURCE Failed to allocate needed resources.\r | |
99c048ef | 887 | **/\r |
888 | EFI_STATUS\r | |
889 | EFIAPI\r | |
890 | Dns6GetModeData (\r | |
891 | IN EFI_DNS6_PROTOCOL *This,\r | |
892 | OUT EFI_DNS6_MODE_DATA *DnsModeData\r | |
893 | )\r | |
894 | {\r | |
895 | DNS_INSTANCE *Instance;\r | |
896 | \r | |
897 | EFI_TPL OldTpl;\r | |
898 | \r | |
899 | UINTN Index;\r | |
900 | \r | |
901 | LIST_ENTRY *Entry;\r | |
902 | LIST_ENTRY *Next;\r | |
903 | \r | |
904 | DNS6_SERVER_IP *ServerItem;\r | |
905 | EFI_IPv6_ADDRESS *ServerList;\r | |
906 | DNS6_CACHE *CacheItem;\r | |
907 | EFI_DNS6_CACHE_ENTRY *CacheList;\r | |
908 | EFI_STATUS Status;\r | |
909 | \r | |
910 | ServerItem = NULL;\r | |
911 | ServerList = NULL;\r | |
912 | CacheItem = NULL;\r | |
913 | CacheList = NULL;\r | |
914 | Status = EFI_SUCCESS;\r | |
915 | \r | |
916 | if ((This == NULL) || (DnsModeData == NULL)) {\r | |
917 | return EFI_INVALID_PARAMETER;\r | |
918 | }\r | |
919 | \r | |
920 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
921 | \r | |
922 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL6 (This);\r | |
923 | if (Instance->State == DNS_STATE_UNCONFIGED) {\r | |
ac0f5843 JW |
924 | Status = EFI_NOT_STARTED;\r |
925 | goto ON_EXIT;\r | |
99c048ef | 926 | }\r |
927 | \r | |
928 | ZeroMem (DnsModeData, sizeof (EFI_DNS6_MODE_DATA));\r | |
929 | \r | |
930 | //\r | |
931 | // Get the current configuration data of this instance. \r | |
932 | //\r | |
ac0f5843 | 933 | Status = Dns6CopyConfigure (&DnsModeData->DnsConfigData, &Instance->Dns6CfgData);\r |
99c048ef | 934 | if (EFI_ERROR (Status)) {\r |
ac0f5843 | 935 | goto ON_EXIT;\r |
99c048ef | 936 | }\r |
937 | \r | |
938 | //\r | |
939 | // Get the DnsServerCount and DnsServerList\r | |
940 | //\r | |
941 | Index = 0;\r | |
942 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6ServerList) {\r | |
943 | Index++;\r | |
944 | }\r | |
945 | DnsModeData->DnsServerCount = (UINT32) Index;\r | |
946 | ServerList = AllocatePool (sizeof(EFI_IPv6_ADDRESS) * DnsModeData->DnsServerCount);\r | |
ac0f5843 JW |
947 | if (ServerList == NULL) {\r |
948 | Status = EFI_OUT_OF_RESOURCES;\r | |
949 | Dns6CleanConfigure (&DnsModeData->DnsConfigData);\r | |
950 | goto ON_EXIT;\r | |
951 | }\r | |
952 | \r | |
99c048ef | 953 | Index = 0;\r |
954 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6ServerList) {\r | |
955 | ServerItem = NET_LIST_USER_STRUCT (Entry, DNS6_SERVER_IP, AllServerLink);\r | |
956 | CopyMem (ServerList + Index, &ServerItem->Dns6ServerIp, sizeof (EFI_IPv6_ADDRESS));\r | |
957 | Index++;\r | |
958 | }\r | |
959 | DnsModeData->DnsServerList = ServerList;\r | |
960 | \r | |
961 | //\r | |
962 | // Get the DnsCacheCount and DnsCacheList\r | |
963 | //\r | |
964 | Index =0;\r | |
965 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6CacheList) {\r | |
966 | Index++;\r | |
967 | }\r | |
968 | DnsModeData->DnsCacheCount = (UINT32) Index;\r | |
969 | CacheList = AllocatePool (sizeof(EFI_DNS6_CACHE_ENTRY) * DnsModeData->DnsCacheCount);\r | |
ac0f5843 JW |
970 | if (CacheList == NULL) {\r |
971 | Status = EFI_OUT_OF_RESOURCES;\r | |
972 | Dns6CleanConfigure (&DnsModeData->DnsConfigData);\r | |
973 | FreePool (ServerList);\r | |
974 | goto ON_EXIT;\r | |
975 | }\r | |
976 | \r | |
99c048ef | 977 | Index =0;\r |
978 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6CacheList) {\r | |
979 | CacheItem = NET_LIST_USER_STRUCT (Entry, DNS6_CACHE, AllCacheLink);\r | |
980 | CopyMem (CacheList + Index, &CacheItem->DnsCache, sizeof (EFI_DNS6_CACHE_ENTRY));\r | |
981 | Index++;\r | |
982 | }\r | |
983 | DnsModeData->DnsCacheList = CacheList;\r | |
99c048ef | 984 | \r |
ac0f5843 JW |
985 | ON_EXIT:\r |
986 | gBS->RestoreTPL (OldTpl);\r | |
987 | return Status;\r | |
99c048ef | 988 | }\r |
989 | \r | |
990 | /**\r | |
0f4e123f JW |
991 | Configure this DNS instance.\r |
992 | \r | |
993 | The Configure() function is used to set and change the configuration data for this\r | |
994 | EFI DNSv6 Protocol driver instance. Reset the DNS instance if DnsConfigData is NULL.\r | |
995 | \r | |
996 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r | |
997 | @param[in] DnsConfigData Pointer to the configuration data structure. All associated \r | |
998 | storage to be allocated and released by caller.\r | |
999 | \r | |
1000 | @retval EFI_SUCCESS The operation completed successfully.\r | |
1001 | @retval EFI_INVALID_PARAMTER This is NULL.\r | |
1002 | The StationIp address provided in DnsConfigData is not zero and not a valid unicast.\r | |
1003 | DnsServerList is NULL while DnsServerList Count is not ZERO.\r | |
1004 | DnsServerList Count is ZERO while DnsServerList is not NULL.\r | |
1005 | @retval EFI_OUT_OF_RESOURCES The DNS instance data or required space could not be allocated.\r | |
1006 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The\r | |
1007 | EFI DNSv6 Protocol instance is not configured.\r | |
1008 | @retval EFI_UNSUPPORTED The designated protocol is not supported.\r | |
1009 | @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To \r | |
1010 | reconfigure the instance the caller must call Configure() with \r | |
1011 | NULL first to return driver to unconfigured state.\r | |
99c048ef | 1012 | **/\r |
1013 | EFI_STATUS\r | |
1014 | EFIAPI\r | |
1015 | Dns6Configure (\r | |
1016 | IN EFI_DNS6_PROTOCOL *This,\r | |
1017 | IN EFI_DNS6_CONFIG_DATA *DnsConfigData\r | |
1018 | )\r | |
1019 | {\r | |
1020 | EFI_STATUS Status;\r | |
1021 | DNS_INSTANCE *Instance;\r | |
1022 | \r | |
1023 | EFI_TPL OldTpl;\r | |
1024 | \r | |
1025 | UINT32 ServerListCount;\r | |
1026 | EFI_IPv6_ADDRESS *ServerList; \r | |
1027 | \r | |
1028 | Status = EFI_SUCCESS;\r | |
1029 | ServerList = NULL;\r | |
1030 | \r | |
1031 | if (This == NULL || \r | |
1032 | (DnsConfigData != NULL && ((DnsConfigData->DnsServerCount != 0 && DnsConfigData->DnsServerList == NULL) || \r | |
1033 | (DnsConfigData->DnsServerCount == 0 && DnsConfigData->DnsServerList != NULL)))) {\r | |
1034 | return EFI_INVALID_PARAMETER;\r | |
1035 | }\r | |
1036 | \r | |
1037 | if (DnsConfigData != NULL && DnsConfigData->Protocol != DNS_PROTOCOL_UDP) {\r | |
1038 | return EFI_UNSUPPORTED;\r | |
1039 | }\r | |
1040 | \r | |
1041 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
1042 | \r | |
1043 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL6 (This);\r | |
1044 | \r | |
1045 | if (DnsConfigData == NULL) {\r | |
1046 | ZeroMem (&Instance->SessionDnsServer, sizeof (EFI_IP_ADDRESS));\r | |
1047 | \r | |
1048 | //\r | |
1049 | // Reset the Instance if ConfigData is NULL\r | |
1050 | //\r | |
1051 | if (!NetMapIsEmpty(&Instance->Dns6TxTokens)) {\r | |
1052 | Dns6InstanceCancelToken(Instance, NULL);\r | |
1053 | }\r | |
1054 | \r | |
1055 | Instance->MaxRetry = 0;\r | |
1056 | \r | |
1057 | if (Instance->UdpIo != NULL){\r | |
1058 | UdpIoCleanIo (Instance->UdpIo);\r | |
1059 | }\r | |
1060 | \r | |
1061 | if (Instance->Dns6CfgData.DnsServerList != NULL) {\r | |
1062 | FreePool (Instance->Dns6CfgData.DnsServerList);\r | |
1063 | }\r | |
1064 | ZeroMem (&Instance->Dns6CfgData, sizeof (EFI_DNS6_CONFIG_DATA));\r | |
1065 | \r | |
1066 | Instance->State = DNS_STATE_UNCONFIGED;\r | |
1067 | } else {\r | |
1068 | //\r | |
1069 | // Configure the parameters for new operation.\r | |
1070 | //\r | |
90ae1f02 | 1071 | if (!NetIp6IsUnspecifiedAddr (&DnsConfigData->StationIp) && !NetIp6IsValidUnicast (&DnsConfigData->StationIp)) {\r |
99c048ef | 1072 | Status = EFI_INVALID_PARAMETER;\r |
1073 | goto ON_EXIT;\r | |
1074 | }\r | |
1075 | \r | |
1076 | Status = Dns6CopyConfigure (&Instance->Dns6CfgData, DnsConfigData);\r | |
1077 | if (EFI_ERROR (Status)) {\r | |
1078 | goto ON_EXIT;\r | |
1079 | }\r | |
1080 | \r | |
1081 | if (DnsConfigData->DnsServerCount == 0 || DnsConfigData->DnsServerList == NULL) {\r | |
1082 | gBS->RestoreTPL (OldTpl);\r | |
1083 | \r | |
1084 | //\r | |
1085 | //The DNS instance will retrieve DNS server from DHCP Server.\r | |
1086 | //\r | |
1087 | Status = GetDns6ServerFromDhcp6 (\r | |
1088 | Instance->Service->ImageHandle,\r | |
1089 | Instance->Service->ControllerHandle, \r | |
1090 | &ServerListCount, \r | |
1091 | &ServerList\r | |
1092 | );\r | |
1093 | if (EFI_ERROR (Status)) {\r | |
1094 | goto ON_EXIT;\r | |
1095 | }\r | |
1096 | \r | |
1097 | ASSERT(ServerList != NULL);\r | |
1098 | \r | |
1099 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
1100 | \r | |
1101 | CopyMem (&Instance->SessionDnsServer.v6, &ServerList[0], sizeof (EFI_IPv6_ADDRESS));\r | |
1102 | } else {\r | |
1103 | CopyMem (&Instance->SessionDnsServer.v6, &DnsConfigData->DnsServerList[0], sizeof (EFI_IPv6_ADDRESS));\r | |
1104 | }\r | |
1105 | \r | |
1106 | //\r | |
1107 | // Config UDP\r | |
1108 | //\r | |
1109 | Status = Dns6ConfigUdp (Instance, Instance->UdpIo);\r | |
1110 | if (EFI_ERROR (Status)) {\r | |
1111 | if (Instance->Dns6CfgData.DnsServerList != NULL) {\r | |
1112 | FreePool (Instance->Dns6CfgData.DnsServerList);\r | |
8aa2cdd7 | 1113 | Instance->Dns6CfgData.DnsServerList = NULL;\r |
99c048ef | 1114 | }\r |
1115 | goto ON_EXIT;\r | |
1116 | }\r | |
1117 | \r | |
1118 | //\r | |
1119 | // Add configured DNS server used by this instance to ServerList.\r | |
1120 | //\r | |
1121 | Status = AddDns6ServerIp (&mDriverData->Dns6ServerList, Instance->SessionDnsServer.v6);\r | |
1122 | if (EFI_ERROR (Status)) {\r | |
1123 | if (Instance->Dns6CfgData.DnsServerList != NULL) {\r | |
1124 | FreePool (Instance->Dns6CfgData.DnsServerList);\r | |
8aa2cdd7 | 1125 | Instance->Dns6CfgData.DnsServerList = NULL;\r |
99c048ef | 1126 | }\r |
1127 | goto ON_EXIT;\r | |
1128 | }\r | |
1129 | \r | |
1130 | Instance->State = DNS_STATE_CONFIGED;\r | |
1131 | }\r | |
1132 | \r | |
1133 | ON_EXIT:\r | |
1134 | gBS->RestoreTPL (OldTpl);\r | |
1135 | return Status;\r | |
1136 | }\r | |
1137 | \r | |
1138 | /**\r | |
0f4e123f JW |
1139 | Host name to host address translation.\r |
1140 | \r | |
1141 | The HostNameToIp () function is used to translate the host name to host IP address. A\r | |
1142 | type AAAA query is used to get the one or more IPv6 addresses for this host.\r | |
1143 | \r | |
1144 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r | |
1145 | @param[in] HostName Host name.\r | |
1146 | @param[in] Token Point to the completion token to translate host name\r | |
1147 | to host address.\r | |
1148 | \r | |
1149 | @retval EFI_SUCCESS The operation completed successfully.\r | |
1150 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
1151 | This is NULL.\r | |
1152 | Token is NULL.\r | |
1153 | Token.Event is NULL.\r | |
1154 | HostName is NULL or buffer contained unsupported characters.\r | |
1155 | @retval EFI_NO_MAPPING There's no source address is available for use.\r | |
1156 | @retval EFI_ALREADY_STARTED This Token is being used in another DNS session.\r | |
1157 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
1158 | @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r | |
99c048ef | 1159 | **/\r |
1160 | EFI_STATUS\r | |
1161 | EFIAPI\r | |
1162 | Dns6HostNameToIp (\r | |
1163 | IN EFI_DNS6_PROTOCOL *This,\r | |
1164 | IN CHAR16 *HostName,\r | |
1165 | IN EFI_DNS6_COMPLETION_TOKEN *Token\r | |
1166 | )\r | |
1167 | {\r | |
1168 | EFI_STATUS Status;\r | |
1169 | \r | |
1170 | DNS_INSTANCE *Instance;\r | |
1171 | \r | |
1172 | EFI_DNS6_CONFIG_DATA *ConfigData;\r | |
1173 | \r | |
1174 | UINTN Index; \r | |
1175 | DNS6_CACHE *Item;\r | |
1176 | LIST_ENTRY *Entry;\r | |
1177 | LIST_ENTRY *Next;\r | |
1178 | \r | |
fcae1a99 JW |
1179 | CHAR8 *QueryName;\r |
1180 | \r | |
99c048ef | 1181 | DNS6_TOKEN_ENTRY *TokenEntry;\r |
1182 | NET_BUF *Packet;\r | |
1183 | \r | |
1184 | EFI_TPL OldTpl;\r | |
1185 | \r | |
1186 | Status = EFI_SUCCESS;\r | |
1187 | Item = NULL;\r | |
fcae1a99 | 1188 | QueryName = NULL;\r |
99c048ef | 1189 | TokenEntry = NULL;\r |
1190 | Packet = NULL;\r | |
1191 | \r | |
1192 | //\r | |
1193 | // Validate the parameters\r | |
1194 | //\r | |
1195 | if ((This == NULL) || (HostName == NULL) || Token == NULL) {\r | |
1196 | return EFI_INVALID_PARAMETER;\r | |
1197 | }\r | |
1198 | \r | |
1199 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
1200 | \r | |
1201 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL6 (This);\r | |
1202 | \r | |
1203 | ConfigData = &(Instance->Dns6CfgData);\r | |
1204 | \r | |
1205 | Instance->MaxRetry = ConfigData->RetryCount;\r | |
1206 | \r | |
1207 | Token->Status = EFI_NOT_READY;\r | |
1208 | Token->RetryCount = 0;\r | |
1209 | Token->RetryInterval = ConfigData->RetryInterval;\r | |
1210 | \r | |
1211 | if (Instance->State != DNS_STATE_CONFIGED) {\r | |
1212 | Status = EFI_NOT_STARTED;\r | |
1213 | goto ON_EXIT;\r | |
1214 | }\r | |
1215 | \r | |
1216 | //\r | |
1217 | // Check the MaxRetry and RetryInterval values.\r | |
1218 | //\r | |
1219 | if (Instance->MaxRetry == 0) {\r | |
1220 | Instance->MaxRetry = DNS_DEFAULT_RETRY;\r | |
1221 | }\r | |
1222 | \r | |
1223 | if (Token->RetryInterval < DNS_DEFAULT_TIMEOUT) {\r | |
1224 | Token->RetryInterval = DNS_DEFAULT_TIMEOUT;\r | |
1225 | } \r | |
1226 | \r | |
1227 | //\r | |
1228 | // Check cache\r | |
1229 | //\r | |
1230 | if (ConfigData->EnableDnsCache) {\r | |
1231 | Index = 0;\r | |
1232 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6CacheList) {\r | |
1233 | Item = NET_LIST_USER_STRUCT (Entry, DNS6_CACHE, AllCacheLink);\r | |
1234 | if (StrCmp (HostName, Item->DnsCache.HostName) == 0) {\r | |
1235 | Index++;\r | |
1236 | }\r | |
1237 | }\r | |
1238 | \r | |
1239 | if (Index != 0) {\r | |
1240 | Token->RspData.H2AData = AllocatePool (sizeof (DNS6_HOST_TO_ADDR_DATA));\r | |
1241 | if (Token->RspData.H2AData == NULL) {\r | |
1242 | Status = EFI_OUT_OF_RESOURCES;\r | |
1243 | goto ON_EXIT;\r | |
1244 | }\r | |
1245 | \r | |
1246 | Token->RspData.H2AData->IpCount = (UINT32)Index;\r | |
1247 | Token->RspData.H2AData->IpList = AllocatePool (sizeof (EFI_IPv6_ADDRESS) * Index);\r | |
1248 | if (Token->RspData.H2AData->IpList == NULL) {\r | |
1249 | if (Token->RspData.H2AData != NULL) {\r | |
1250 | FreePool (Token->RspData.H2AData);\r | |
1251 | }\r | |
1252 | \r | |
1253 | Status = EFI_OUT_OF_RESOURCES;\r | |
1254 | goto ON_EXIT;\r | |
1255 | }\r | |
1256 | \r | |
1257 | Index = 0;\r | |
1258 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &mDriverData->Dns6CacheList) {\r | |
1259 | Item = NET_LIST_USER_STRUCT (Entry, DNS6_CACHE, AllCacheLink);\r | |
1260 | if ((UINT32)Index < Token->RspData.H2AData->IpCount && StrCmp (HostName, Item->DnsCache.HostName) == 0) {\r | |
1261 | CopyMem ((Token->RspData.H2AData->IpList) + Index, Item->DnsCache.IpAddress, sizeof (EFI_IPv6_ADDRESS));\r | |
1262 | Index++;\r | |
1263 | }\r | |
1264 | }\r | |
1265 | \r | |
1266 | Token->Status = EFI_SUCCESS;\r | |
1267 | \r | |
1268 | if (Token->Event != NULL) {\r | |
1269 | gBS->SignalEvent (Token->Event);\r | |
1270 | DispatchDpc ();\r | |
1271 | }\r | |
1272 | \r | |
1273 | Status = Token->Status;\r | |
1274 | goto ON_EXIT;\r | |
1275 | } \r | |
1276 | }\r | |
1277 | \r | |
1278 | //\r | |
1279 | // Construct DNS TokenEntry.\r | |
1280 | //\r | |
1281 | TokenEntry = AllocateZeroPool (sizeof (DNS6_TOKEN_ENTRY));\r | |
1282 | if (TokenEntry == NULL) {\r | |
1283 | Status = EFI_OUT_OF_RESOURCES;\r | |
1284 | goto ON_EXIT;\r | |
1285 | }\r | |
1286 | \r | |
1287 | TokenEntry->PacketToLive = Token->RetryInterval;\r | |
1288 | TokenEntry->QueryHostName = HostName;\r | |
1289 | TokenEntry->Token = Token;\r | |
1290 | \r | |
fcae1a99 JW |
1291 | \r |
1292 | //\r | |
1293 | // Construct QName.\r | |
1294 | //\r | |
3700da73 | 1295 | QueryName = NetLibCreateDnsQName (TokenEntry->QueryHostName);\r |
fcae1a99 JW |
1296 | if (QueryName == NULL) {\r |
1297 | Status = EFI_OUT_OF_RESOURCES;\r | |
1298 | goto ON_EXIT;\r | |
1299 | }\r | |
1300 | \r | |
99c048ef | 1301 | //\r |
1302 | // Construct DNS Query Packet.\r | |
1303 | //\r | |
fcae1a99 | 1304 | Status = ConstructDNSQuery (Instance, QueryName, DNS_TYPE_AAAA, DNS_CLASS_INET, &Packet);\r |
99c048ef | 1305 | if (EFI_ERROR (Status)) {\r |
1306 | if (TokenEntry != NULL) {\r | |
1307 | FreePool (TokenEntry);\r | |
1308 | }\r | |
1309 | \r | |
1310 | goto ON_EXIT;\r | |
1311 | }\r | |
1312 | \r | |
8339166d JW |
1313 | ASSERT (Packet != NULL);\r |
1314 | \r | |
99c048ef | 1315 | //\r |
1316 | // Save the token into the Dns6TxTokens map.\r | |
1317 | //\r | |
1318 | Status = NetMapInsertTail (&Instance->Dns6TxTokens, TokenEntry, Packet);\r | |
1319 | if (EFI_ERROR (Status)) {\r | |
1320 | if (TokenEntry != NULL) {\r | |
1321 | FreePool (TokenEntry);\r | |
1322 | }\r | |
1323 | \r | |
1324 | NetbufFree (Packet);\r | |
1325 | \r | |
1326 | goto ON_EXIT;\r | |
1327 | }\r | |
1328 | \r | |
1329 | //\r | |
1330 | // Dns Query Ip\r | |
1331 | //\r | |
1332 | Status = DoDnsQuery (Instance, Packet);\r | |
1333 | if (EFI_ERROR (Status)) {\r | |
520a0746 JW |
1334 | Dns6RemoveTokenEntry (&Instance->Dns6TxTokens, TokenEntry);\r |
1335 | \r | |
99c048ef | 1336 | if (TokenEntry != NULL) {\r |
1337 | FreePool (TokenEntry);\r | |
1338 | }\r | |
1339 | \r | |
1340 | NetbufFree (Packet);\r | |
1341 | }\r | |
1342 | \r | |
1343 | ON_EXIT:\r | |
fcae1a99 JW |
1344 | if (QueryName != NULL) {\r |
1345 | FreePool (QueryName);\r | |
1346 | }\r | |
1347 | \r | |
99c048ef | 1348 | gBS->RestoreTPL (OldTpl);\r |
1349 | return Status;\r | |
1350 | }\r | |
1351 | \r | |
1352 | /**\r | |
0f4e123f JW |
1353 | Host address to host name translation.\r |
1354 | \r | |
1355 | The IpToHostName () function is used to translate the host address to host name. A\r | |
1356 | type PTR query is used to get the primary name of the host. Implementation can choose\r | |
1357 | to support this function or not.\r | |
1358 | \r | |
1359 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r | |
1360 | @param[in] IpAddress Ip Address.\r | |
1361 | @param[in] Token Point to the completion token to translate host\r | |
1362 | address to host name.\r | |
1363 | \r | |
1364 | @retval EFI_SUCCESS The operation completed successfully.\r | |
1365 | @retval EFI_UNSUPPORTED This function is not supported.\r | |
1366 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
1367 | This is NULL.\r | |
1368 | Token is NULL.\r | |
1369 | Token.Event is NULL.\r | |
1370 | IpAddress is not valid IP address.\r | |
1371 | @retval EFI_NO_MAPPING There's no source address is available for use.\r | |
1372 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
1373 | @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r | |
99c048ef | 1374 | **/\r |
1375 | EFI_STATUS\r | |
1376 | EFIAPI\r | |
1377 | Dns6IpToHostName (\r | |
1378 | IN EFI_DNS6_PROTOCOL *This,\r | |
1379 | IN EFI_IPv6_ADDRESS IpAddress,\r | |
1380 | IN EFI_DNS6_COMPLETION_TOKEN *Token\r | |
1381 | )\r | |
1382 | {\r | |
1383 | return EFI_UNSUPPORTED;\r | |
1384 | }\r | |
1385 | \r | |
1386 | /**\r | |
0f4e123f JW |
1387 | This function provides capability to retrieve arbitrary information from the DNS\r |
1388 | server.\r | |
1389 | \r | |
1390 | This GeneralLookup() function retrieves arbitrary information from the DNS. The caller\r | |
1391 | supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All\r | |
1392 | RR content (e.g., TTL) was returned. The caller need parse the returned RR to get\r | |
1393 | required information. The function is optional. Implementation can choose to support\r | |
1394 | it or not.\r | |
1395 | \r | |
1396 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r | |
1397 | @param[in] QName Pointer to Query Name.\r | |
1398 | @param[in] QType Query Type.\r | |
1399 | @param[in] QClass Query Name.\r | |
1400 | @param[in] Token Point to the completion token to retrieve arbitrary\r | |
1401 | information.\r | |
1402 | \r | |
1403 | @retval EFI_SUCCESS The operation completed successfully.\r | |
1404 | @retval EFI_UNSUPPORTED This function is not supported. Or the requested\r | |
1405 | QType is not supported\r | |
1406 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
1407 | This is NULL.\r | |
1408 | Token is NULL.\r | |
1409 | Token.Event is NULL.\r | |
1410 | QName is NULL.\r | |
1411 | @retval EFI_NO_MAPPING There's no source address is available for use.\r | |
1412 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
1413 | @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r | |
99c048ef | 1414 | **/\r |
1415 | EFI_STATUS\r | |
1416 | EFIAPI\r | |
1417 | Dns6GeneralLookUp (\r | |
1418 | IN EFI_DNS6_PROTOCOL *This,\r | |
1419 | IN CHAR8 *QName,\r | |
1420 | IN UINT16 QType, \r | |
1421 | IN UINT16 QClass,\r | |
1422 | IN EFI_DNS6_COMPLETION_TOKEN *Token\r | |
1423 | )\r | |
1424 | {\r | |
fcae1a99 JW |
1425 | EFI_STATUS Status;\r |
1426 | \r | |
1427 | DNS_INSTANCE *Instance;\r | |
1428 | \r | |
1429 | EFI_DNS6_CONFIG_DATA *ConfigData;\r | |
1430 | \r | |
1431 | DNS6_TOKEN_ENTRY *TokenEntry;\r | |
1432 | NET_BUF *Packet;\r | |
1433 | \r | |
1434 | EFI_TPL OldTpl;\r | |
1435 | \r | |
1436 | Status = EFI_SUCCESS;\r | |
1437 | TokenEntry = NULL;\r | |
1438 | Packet = NULL;\r | |
1439 | \r | |
1440 | //\r | |
1441 | // Validate the parameters\r | |
1442 | //\r | |
1443 | if ((This == NULL) || (QName == NULL) || Token == NULL) {\r | |
1444 | return EFI_INVALID_PARAMETER;\r | |
1445 | }\r | |
1446 | \r | |
1447 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
1448 | \r | |
1449 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL6 (This);\r | |
1450 | \r | |
1451 | ConfigData = &(Instance->Dns6CfgData);\r | |
1452 | \r | |
1453 | Instance->MaxRetry = ConfigData->RetryCount;\r | |
1454 | \r | |
1455 | Token->Status = EFI_NOT_READY;\r | |
1456 | Token->RetryCount = 0;\r | |
1457 | Token->RetryInterval = ConfigData->RetryInterval;\r | |
1458 | \r | |
1459 | if (Instance->State != DNS_STATE_CONFIGED) {\r | |
1460 | Status = EFI_NOT_STARTED;\r | |
1461 | goto ON_EXIT;\r | |
1462 | }\r | |
1463 | \r | |
1464 | //\r | |
1465 | // Check the MaxRetry and RetryInterval values.\r | |
1466 | //\r | |
1467 | if (Instance->MaxRetry == 0) {\r | |
1468 | Instance->MaxRetry = DNS_DEFAULT_RETRY;\r | |
1469 | }\r | |
1470 | \r | |
1471 | if (Token->RetryInterval < DNS_DEFAULT_TIMEOUT) {\r | |
1472 | Token->RetryInterval = DNS_DEFAULT_TIMEOUT;\r | |
1473 | }\r | |
1474 | \r | |
1475 | //\r | |
1476 | // Construct DNS TokenEntry.\r | |
1477 | //\r | |
1478 | TokenEntry = AllocateZeroPool (sizeof(DNS6_TOKEN_ENTRY));\r | |
1479 | if (TokenEntry == NULL) {\r | |
1480 | Status = EFI_OUT_OF_RESOURCES;\r | |
1481 | goto ON_EXIT;\r | |
1482 | }\r | |
1483 | \r | |
1484 | TokenEntry->PacketToLive = Token->RetryInterval;\r | |
1485 | TokenEntry->GeneralLookUp = TRUE;\r | |
1486 | TokenEntry->Token = Token;\r | |
1487 | \r | |
1488 | //\r | |
1489 | // Construct DNS Query Packet.\r | |
1490 | //\r | |
1491 | Status = ConstructDNSQuery (Instance, QName, QType, QClass, &Packet);\r | |
1492 | if (EFI_ERROR (Status)) {\r | |
1493 | if (TokenEntry != NULL) {\r | |
1494 | FreePool (TokenEntry);\r | |
1495 | }\r | |
1496 | \r | |
1497 | goto ON_EXIT;\r | |
1498 | }\r | |
1499 | \r | |
8339166d JW |
1500 | ASSERT (Packet != NULL);\r |
1501 | \r | |
fcae1a99 JW |
1502 | //\r |
1503 | // Save the token into the Dns6TxTokens map.\r | |
1504 | //\r | |
1505 | Status = NetMapInsertTail (&Instance->Dns6TxTokens, TokenEntry, Packet);\r | |
1506 | if (EFI_ERROR (Status)) {\r | |
1507 | if (TokenEntry != NULL) {\r | |
1508 | FreePool (TokenEntry);\r | |
1509 | }\r | |
1510 | \r | |
1511 | NetbufFree (Packet);\r | |
1512 | \r | |
1513 | goto ON_EXIT;\r | |
1514 | }\r | |
1515 | \r | |
1516 | //\r | |
1517 | // Dns Query Ip\r | |
1518 | //\r | |
1519 | Status = DoDnsQuery (Instance, Packet);\r | |
1520 | if (EFI_ERROR (Status)) {\r | |
520a0746 JW |
1521 | Dns6RemoveTokenEntry (&Instance->Dns6TxTokens, TokenEntry);\r |
1522 | \r | |
fcae1a99 JW |
1523 | if (TokenEntry != NULL) {\r |
1524 | FreePool (TokenEntry);\r | |
1525 | }\r | |
1526 | \r | |
1527 | NetbufFree (Packet);\r | |
1528 | }\r | |
1529 | \r | |
1530 | ON_EXIT:\r | |
1531 | gBS->RestoreTPL (OldTpl);\r | |
1532 | return Status;\r | |
99c048ef | 1533 | }\r |
1534 | \r | |
1535 | /**\r | |
0f4e123f JW |
1536 | This function is to update the DNS Cache.\r |
1537 | \r | |
1538 | The UpdateDnsCache() function is used to add/delete/modify DNS cache entry. DNS cache\r | |
1539 | can be normally dynamically updated after the DNS resolve succeeds. This function\r | |
1540 | provided capability to manually add/delete/modify the DNS cache.\r | |
1541 | \r | |
1542 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r | |
1543 | @param[in] DeleteFlag If FALSE, this function is to add one entry to the\r | |
1544 | DNS Cahce. If TRUE, this function will delete\r | |
1545 | matching DNS Cache entry.\r | |
1546 | @param[in] Override If TRUE, the maching DNS cache entry will be\r | |
1547 | overwritten with the supplied parameter. If FALSE,\r | |
1548 | EFI_ACCESS_DENIED will be returned if the entry to\r | |
1549 | be added is already existed.\r | |
1550 | @param[in] DnsCacheEntry Pointer to DNS Cache entry.\r | |
1551 | \r | |
1552 | @retval EFI_SUCCESS The operation completed successfully.\r | |
1553 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
1554 | This is NULL.\r | |
1555 | DnsCacheEntry.HostName is NULL.\r | |
1556 | DnsCacheEntry.IpAddress is NULL.\r | |
1557 | DnsCacheEntry.Timeout is zero.\r | |
1558 | @retval EFI_ACCESS_DENIED The DNS cache entry already exists and Override is\r | |
1559 | not TRUE.\r | |
1560 | @retval EFI_OUT_OF_RESOURCE Failed to allocate needed resources.\r | |
99c048ef | 1561 | **/\r |
1562 | EFI_STATUS\r | |
1563 | EFIAPI\r | |
1564 | Dns6UpdateDnsCache (\r | |
1565 | IN EFI_DNS6_PROTOCOL *This,\r | |
1566 | IN BOOLEAN DeleteFlag,\r | |
1567 | IN BOOLEAN Override,\r | |
1568 | IN EFI_DNS6_CACHE_ENTRY DnsCacheEntry\r | |
1569 | )\r | |
1570 | {\r | |
1571 | EFI_STATUS Status; \r | |
1572 | EFI_TPL OldTpl;\r | |
1573 | \r | |
1574 | Status = EFI_SUCCESS;\r | |
1575 | \r | |
1576 | if (DnsCacheEntry.HostName == NULL || DnsCacheEntry.IpAddress == NULL || DnsCacheEntry.Timeout == 0) {\r | |
1577 | return EFI_INVALID_PARAMETER; \r | |
1578 | }\r | |
1579 | \r | |
1580 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
1581 | \r | |
1582 | //\r | |
1583 | // Update Dns6Cache here.\r | |
1584 | //\r | |
1585 | Status = UpdateDns6Cache (&mDriverData->Dns6CacheList, DeleteFlag, Override, DnsCacheEntry);\r | |
1586 | \r | |
1587 | gBS->RestoreTPL (OldTpl);\r | |
1588 | \r | |
1589 | return Status;\r | |
1590 | }\r | |
1591 | \r | |
1592 | /**\r | |
0f4e123f JW |
1593 | Polls for incoming data packets and processes outgoing data packets.\r |
1594 | \r | |
1595 | The Poll() function can be used by network drivers and applications to increase the\r | |
1596 | rate that data packets are moved between the communications device and the transmit\r | |
1597 | and receive queues.\r | |
1598 | \r | |
1599 | In some systems, the periodic timer event in the managed network driver may not poll\r | |
1600 | the underlying communications device fast enough to transmit and/or receive all data\r | |
1601 | packets without missing incoming packets or dropping outgoing packets. Drivers and\r | |
1602 | applications that are experiencing packet loss should try calling the Poll()\r | |
1603 | function more often.\r | |
1604 | \r | |
1605 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r | |
1606 | \r | |
1607 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
1608 | @retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started.\r | |
1609 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
1610 | @retval EFI_NO_MAPPING There is no source address is available for use.\r | |
1611 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
1612 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive\r | |
1613 | queue. Consider increasing the polling rate.\r | |
99c048ef | 1614 | **/\r |
1615 | EFI_STATUS\r | |
1616 | EFIAPI\r | |
1617 | Dns6Poll (\r | |
1618 | IN EFI_DNS6_PROTOCOL *This\r | |
1619 | )\r | |
1620 | {\r | |
1621 | DNS_INSTANCE *Instance;\r | |
1622 | EFI_UDP6_PROTOCOL *Udp;\r | |
1623 | \r | |
1624 | if (This == NULL) {\r | |
1625 | return EFI_INVALID_PARAMETER;\r | |
1626 | }\r | |
1627 | \r | |
1628 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL6 (This);\r | |
1629 | \r | |
1630 | if (Instance->State == DNS_STATE_UNCONFIGED) {\r | |
1631 | return EFI_NOT_STARTED;\r | |
1632 | } else if (Instance->State == DNS_STATE_DESTROY) {\r | |
1633 | return EFI_DEVICE_ERROR;\r | |
1634 | }\r | |
1635 | \r | |
1636 | Udp = Instance->UdpIo->Protocol.Udp6;\r | |
1637 | \r | |
1638 | return Udp->Poll (Udp);\r | |
1639 | }\r | |
1640 | \r | |
1641 | /**\r | |
0f4e123f JW |
1642 | Abort an asynchronous DNS operation, including translation between IP and Host, and\r |
1643 | general look up behavior.\r | |
1644 | \r | |
1645 | The Cancel() function is used to abort a pending resolution request. After calling\r | |
1646 | this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be\r | |
1647 | signaled. If the token is not in one of the queues, which usually means that the\r | |
1648 | asynchronous operation has completed, this function will not signal the token and\r | |
1649 | EFI_NOT_FOUND is returned.\r | |
1650 | \r | |
1651 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r | |
1652 | @param[in] Token Pointer to a token that has been issued by\r | |
1653 | EFI_DNS6_PROTOCOL.HostNameToIp (),\r | |
1654 | EFI_DNS6_PROTOCOL.IpToHostName() or\r | |
1655 | EFI_DNS6_PROTOCOL.GeneralLookup().\r | |
1656 | If NULL, all pending tokens are aborted.\r | |
1657 | \r | |
1658 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
1659 | @retval EFI_NOT_STARTED This EFI DNS6 Protocol instance has not been started.\r | |
1660 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
1661 | @retval EFI_NO_MAPPING There's no source address is available for use.\r | |
1662 | @retval EFI_NOT_FOUND When Token is not NULL, and the asynchronous DNS\r | |
1663 | operation was not found in the transmit queue. It\r | |
1664 | was either completed or was not issued by\r | |
1665 | HostNameToIp(), IpToHostName() or GeneralLookup().\r | |
99c048ef | 1666 | **/\r |
1667 | EFI_STATUS\r | |
1668 | EFIAPI\r | |
1669 | Dns6Cancel (\r | |
1670 | IN EFI_DNS6_PROTOCOL *This,\r | |
1671 | IN EFI_DNS6_COMPLETION_TOKEN *Token\r | |
1672 | )\r | |
1673 | {\r | |
1674 | EFI_STATUS Status;\r | |
1675 | DNS_INSTANCE *Instance;\r | |
1676 | EFI_TPL OldTpl;\r | |
1677 | \r | |
1678 | if (This == NULL) {\r | |
1679 | return EFI_INVALID_PARAMETER;\r | |
1680 | }\r | |
1681 | \r | |
1682 | Instance = DNS_INSTANCE_FROM_THIS_PROTOCOL6 (This);\r | |
1683 | \r | |
1684 | if (Instance->State == DNS_STATE_UNCONFIGED) {\r | |
1685 | return EFI_NOT_STARTED;\r | |
1686 | }\r | |
1687 | \r | |
1688 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
1689 | \r | |
1690 | //\r | |
1691 | // Cancle the tokens specified by Token for this instance.\r | |
1692 | //\r | |
1693 | Status = Dns6InstanceCancelToken (Instance, Token);\r | |
1694 | \r | |
1695 | //\r | |
1696 | // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.\r | |
1697 | //\r | |
1698 | DispatchDpc ();\r | |
1699 | \r | |
1700 | gBS->RestoreTPL (OldTpl);\r | |
1701 | \r | |
1702 | return Status;\r | |
1703 | }\r | |
1704 | \r |