2 Implementation of the boot file download function.
4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
6 This program and the accompanying materials are licensed and made available under
7 the terms and conditions of the BSD License that accompanies this distribution.
8 The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "HttpBootDxe.h"
19 Update the IP and URL device path node to include the boot resource information.
21 @param[in] Private The pointer to the driver's private data.
23 @retval EFI_SUCCESS Device patch successfully updated.
24 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
25 @retval Others Unexpected error happened.
29 HttpBootUpdateDevicePath (
30 IN HTTP_BOOT_PRIVATE_DATA
*Private
34 EFI_DEVICE_PATH_PROTOCOL
*TmpDevicePath
;
35 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
42 // Update the IP node with DHCP assigned information.
44 if (!Private
->UsingIpv6
) {
45 Node
= AllocateZeroPool (sizeof (IPv4_DEVICE_PATH
));
47 return EFI_OUT_OF_RESOURCES
;
49 Node
->Ipv4
.Header
.Type
= MESSAGING_DEVICE_PATH
;
50 Node
->Ipv4
.Header
.SubType
= MSG_IPv4_DP
;
51 SetDevicePathNodeLength (Node
, sizeof (IPv4_DEVICE_PATH
));
52 CopyMem (&Node
->Ipv4
.LocalIpAddress
, &Private
->StationIp
, sizeof (EFI_IPv4_ADDRESS
));
53 Node
->Ipv4
.RemotePort
= Private
->Port
;
54 Node
->Ipv4
.Protocol
= EFI_IP_PROTO_TCP
;
55 Node
->Ipv4
.StaticIpAddress
= FALSE
;
56 CopyMem (&Node
->Ipv4
.GatewayIpAddress
, &Private
->GatewayIp
, sizeof (EFI_IPv4_ADDRESS
));
57 CopyMem (&Node
->Ipv4
.SubnetMask
, &Private
->SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
59 Node
= AllocateZeroPool (sizeof (IPv6_DEVICE_PATH
));
61 return EFI_OUT_OF_RESOURCES
;
63 Node
->Ipv6
.Header
.Type
= MESSAGING_DEVICE_PATH
;
64 Node
->Ipv6
.Header
.SubType
= MSG_IPv6_DP
;
65 SetDevicePathNodeLength (Node
, sizeof (IPv6_DEVICE_PATH
));
66 Node
->Ipv6
.PrefixLength
= IP6_PREFIX_LENGTH
;
67 Node
->Ipv6
.RemotePort
= Private
->Port
;
68 Node
->Ipv6
.Protocol
= EFI_IP_PROTO_TCP
;
69 Node
->Ipv6
.IpAddressOrigin
= 0;
70 CopyMem (&Node
->Ipv6
.LocalIpAddress
, &Private
->StationIp
.v6
, sizeof (EFI_IPv6_ADDRESS
));
71 CopyMem (&Node
->Ipv6
.RemoteIpAddress
, &Private
->ServerIp
.v6
, sizeof (EFI_IPv6_ADDRESS
));
72 CopyMem (&Node
->Ipv6
.GatewayIpAddress
, &Private
->GatewayIp
.v6
, sizeof (EFI_IPv6_ADDRESS
));
75 TmpDevicePath
= AppendDevicePathNode (Private
->ParentDevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) Node
);
77 if (TmpDevicePath
== NULL
) {
78 return EFI_OUT_OF_RESOURCES
;
82 // Update the URI node with the boot file URI.
84 Length
= sizeof (EFI_DEVICE_PATH_PROTOCOL
) + AsciiStrSize (Private
->BootFileUri
);
85 Node
= AllocatePool (Length
);
87 FreePool (TmpDevicePath
);
88 return EFI_OUT_OF_RESOURCES
;
90 Node
->DevPath
.Type
= MESSAGING_DEVICE_PATH
;
91 Node
->DevPath
.SubType
= MSG_URI_DP
;
92 SetDevicePathNodeLength (Node
, Length
);
93 CopyMem ((UINT8
*) Node
+ sizeof (EFI_DEVICE_PATH_PROTOCOL
), Private
->BootFileUri
, AsciiStrSize (Private
->BootFileUri
));
95 NewDevicePath
= AppendDevicePathNode (TmpDevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) Node
);
97 FreePool (TmpDevicePath
);
98 if (NewDevicePath
== NULL
) {
99 return EFI_OUT_OF_RESOURCES
;
102 if (!Private
->UsingIpv6
) {
104 // Reinstall the device path protocol of the child handle.
106 Status
= gBS
->ReinstallProtocolInterface (
107 Private
->Ip4Nic
->Controller
,
108 &gEfiDevicePathProtocolGuid
,
109 Private
->Ip4Nic
->DevicePath
,
112 if (EFI_ERROR (Status
)) {
116 FreePool (Private
->Ip4Nic
->DevicePath
);
117 Private
->Ip4Nic
->DevicePath
= NewDevicePath
;
120 // Reinstall the device path protocol of the child handle.
122 Status
= gBS
->ReinstallProtocolInterface (
123 Private
->Ip6Nic
->Controller
,
124 &gEfiDevicePathProtocolGuid
,
125 Private
->Ip6Nic
->DevicePath
,
128 if (EFI_ERROR (Status
)) {
131 FreePool (Private
->Ip6Nic
->DevicePath
);
132 Private
->Ip6Nic
->DevicePath
= NewDevicePath
;
139 Parse the boot file URI information from the selected Dhcp4 offer packet.
141 @param[in] Private The pointer to the driver's private data.
143 @retval EFI_SUCCESS Successfully parsed out all the boot information.
144 @retval Others Failed to parse out the boot information.
148 HttpBootDhcp4ExtractUriInfo (
149 IN HTTP_BOOT_PRIVATE_DATA
*Private
152 HTTP_BOOT_DHCP4_PACKET_CACHE
*SelectOffer
;
153 HTTP_BOOT_DHCP4_PACKET_CACHE
*HttpOffer
;
156 EFI_DHCP4_PACKET_OPTION
*Option
;
159 ASSERT (Private
!= NULL
);
160 ASSERT (Private
->SelectIndex
!= 0);
161 SelectIndex
= Private
->SelectIndex
- 1;
162 ASSERT (SelectIndex
< HTTP_BOOT_OFFER_MAX_NUM
);
164 Status
= EFI_SUCCESS
;
167 // SelectOffer contains the IP address configuration and name server configuration.
168 // HttpOffer contains the boot file URL.
170 SelectOffer
= &Private
->OfferBuffer
[SelectIndex
].Dhcp4
;
171 if (Private
->FilePathUri
== NULL
) {
173 // In Corporate environment, we need a HttpOffer.
175 if ((SelectOffer
->OfferType
== HttpOfferTypeDhcpIpUri
) ||
176 (SelectOffer
->OfferType
== HttpOfferTypeDhcpIpUriDns
) ||
177 (SelectOffer
->OfferType
== HttpOfferTypeDhcpNameUriDns
)) {
178 HttpOffer
= SelectOffer
;
180 ASSERT (Private
->SelectProxyType
!= HttpOfferTypeMax
);
181 ProxyIndex
= Private
->OfferIndex
[Private
->SelectProxyType
][0];
182 HttpOffer
= &Private
->OfferBuffer
[ProxyIndex
].Dhcp4
;
184 Private
->BootFileUriParser
= HttpOffer
->UriParser
;
185 Private
->BootFileUri
= (CHAR8
*) HttpOffer
->OptList
[HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE
]->Data
;
188 // In Home environment the BootFileUri comes from the FilePath.
190 Private
->BootFileUriParser
= Private
->FilePathUriParser
;
191 Private
->BootFileUri
= Private
->FilePathUri
;
195 // Configure the default DNS server if server assigned.
197 if ((SelectOffer
->OfferType
== HttpOfferTypeDhcpNameUriDns
) ||
198 (SelectOffer
->OfferType
== HttpOfferTypeDhcpDns
) ||
199 (SelectOffer
->OfferType
== HttpOfferTypeDhcpIpUriDns
)) {
200 Option
= SelectOffer
->OptList
[HTTP_BOOT_DHCP4_TAG_INDEX_DNS_SERVER
];
201 ASSERT (Option
!= NULL
);
202 Status
= HttpBootRegisterIp4Dns (
207 if (EFI_ERROR (Status
)) {
213 // Extract the port from URL, and use default HTTP port 80 if not provided.
215 Status
= HttpUrlGetPort (
216 Private
->BootFileUri
,
217 Private
->BootFileUriParser
,
220 if (EFI_ERROR (Status
) || Private
->Port
== 0) {
225 // All boot informations are valid here.
227 AsciiPrint ("\n URI: %a", Private
->BootFileUri
);
230 // Update the device path to include the IP and boot URI information.
232 Status
= HttpBootUpdateDevicePath (Private
);
238 Parse the boot file URI information from the selected Dhcp6 offer packet.
240 @param[in] Private The pointer to the driver's private data.
242 @retval EFI_SUCCESS Successfully parsed out all the boot information.
243 @retval Others Failed to parse out the boot information.
247 HttpBootDhcp6ExtractUriInfo (
248 IN HTTP_BOOT_PRIVATE_DATA
*Private
251 HTTP_BOOT_DHCP6_PACKET_CACHE
*SelectOffer
;
252 HTTP_BOOT_DHCP6_PACKET_CACHE
*HttpOffer
;
255 EFI_DHCP6_PACKET_OPTION
*Option
;
256 EFI_IPv6_ADDRESS IpAddr
;
261 ASSERT (Private
!= NULL
);
262 ASSERT (Private
->SelectIndex
!= 0);
263 SelectIndex
= Private
->SelectIndex
- 1;
264 ASSERT (SelectIndex
< HTTP_BOOT_OFFER_MAX_NUM
);
266 Status
= EFI_SUCCESS
;
269 // SelectOffer contains the IP address configuration and name server configuration.
270 // HttpOffer contains the boot file URL.
272 SelectOffer
= &Private
->OfferBuffer
[SelectIndex
].Dhcp6
;
273 if (Private
->FilePathUri
== NULL
) {
275 // In Corporate environment, we need a HttpOffer.
277 if ((SelectOffer
->OfferType
== HttpOfferTypeDhcpIpUri
) ||
278 (SelectOffer
->OfferType
== HttpOfferTypeDhcpIpUriDns
) ||
279 (SelectOffer
->OfferType
== HttpOfferTypeDhcpNameUriDns
)) {
280 HttpOffer
= SelectOffer
;
282 ASSERT (Private
->SelectProxyType
!= HttpOfferTypeMax
);
283 ProxyIndex
= Private
->OfferIndex
[Private
->SelectProxyType
][0];
284 HttpOffer
= &Private
->OfferBuffer
[ProxyIndex
].Dhcp6
;
286 Private
->BootFileUriParser
= HttpOffer
->UriParser
;
287 Private
->BootFileUri
= (CHAR8
*) HttpOffer
->OptList
[HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL
]->Data
;
290 // In Home environment the BootFileUri comes from the FilePath.
292 Private
->BootFileUriParser
= Private
->FilePathUriParser
;
293 Private
->BootFileUri
= Private
->FilePathUri
;
297 // Set the Local station address to IP layer.
299 Status
= HttpBootSetIp6Address (Private
);
300 if (EFI_ERROR (Status
)) {
305 // Configure the default DNS server if server assigned.
307 if ((SelectOffer
->OfferType
== HttpOfferTypeDhcpNameUriDns
) ||
308 (SelectOffer
->OfferType
== HttpOfferTypeDhcpDns
) ||
309 (SelectOffer
->OfferType
== HttpOfferTypeDhcpIpUriDns
)) {
310 Option
= SelectOffer
->OptList
[HTTP_BOOT_DHCP6_IDX_DNS_SERVER
];
311 ASSERT (Option
!= NULL
);
312 Status
= HttpBootSetIp6Dns (
314 HTONS (Option
->OpLen
),
317 if (EFI_ERROR (Status
)) {
323 // Extract the HTTP server Ip frome URL. This is used to Check route table
324 // whether can send message to HTTP Server Ip through the GateWay.
326 Status
= HttpUrlGetIp6 (
327 Private
->BootFileUri
,
328 Private
->BootFileUriParser
,
332 if (EFI_ERROR (Status
)) {
334 // The Http server address is expressed by Name Ip, so perform DNS resolution
336 Status
= HttpUrlGetHostName (
337 Private
->BootFileUri
,
338 Private
->BootFileUriParser
,
341 if (EFI_ERROR (Status
)) {
345 HostNameStr
= AllocateZeroPool ((AsciiStrLen (HostName
) + 1) * sizeof (CHAR16
));
346 if (HostNameStr
== NULL
) {
347 Status
= EFI_OUT_OF_RESOURCES
;
351 AsciiStrToUnicodeStr (HostName
, HostNameStr
);
352 Status
= HttpBootDns (Private
, HostNameStr
, &IpAddr
);
353 FreePool (HostNameStr
);
354 if (EFI_ERROR (Status
)) {
359 CopyMem (&Private
->ServerIp
.v6
, &IpAddr
, sizeof (EFI_IPv6_ADDRESS
));
362 // register the IPv6 gateway address to the network device.
364 Status
= HttpBootSetIp6Gateway (Private
);
365 if (EFI_ERROR (Status
)) {
370 // Extract the port from URL, and use default HTTP port 80 if not provided.
372 Status
= HttpUrlGetPort (
373 Private
->BootFileUri
,
374 Private
->BootFileUriParser
,
377 if (EFI_ERROR (Status
) || Private
->Port
== 0) {
382 // All boot informations are valid here.
384 AsciiPrint ("\n URI: %a", Private
->BootFileUri
);
386 // Update the device path to include the IP and boot URI information.
388 Status
= HttpBootUpdateDevicePath (Private
);
392 if (HostName
!= NULL
) {
401 Discover all the boot information for boot file.
403 @param[in, out] Private The pointer to the driver's private data.
405 @retval EFI_SUCCESS Successfully obtained all the boot information .
406 @retval Others Failed to retrieve the boot information.
410 HttpBootDiscoverBootInfo (
411 IN OUT HTTP_BOOT_PRIVATE_DATA
*Private
417 // Start D.O.R.A/S.A.R.R exchange to acquire station ip address and
418 // other Http boot information.
420 Status
= HttpBootDhcp (Private
);
421 if (EFI_ERROR (Status
)) {
425 if (!Private
->UsingIpv6
) {
426 Status
= HttpBootDhcp4ExtractUriInfo (Private
);
428 Status
= HttpBootDhcp6ExtractUriInfo (Private
);
435 Create a HttpIo instance for the file download.
437 @param[in] Private The pointer to the driver's private data.
439 @retval EFI_SUCCESS Successfully created.
440 @retval Others Failed to create HttpIo.
444 HttpBootCreateHttpIo (
445 IN HTTP_BOOT_PRIVATE_DATA
*Private
448 HTTP_IO_CONFIG_DATA ConfigData
;
451 ASSERT (Private
!= NULL
);
453 ZeroMem (&ConfigData
, sizeof (HTTP_IO_CONFIG_DATA
));
454 if (!Private
->UsingIpv6
) {
455 ConfigData
.Config4
.HttpVersion
= HttpVersion11
;
456 ConfigData
.Config4
.RequestTimeOut
= HTTP_BOOT_REQUEST_TIMEOUT
;
457 IP4_COPY_ADDRESS (&ConfigData
.Config4
.LocalIp
, &Private
->StationIp
.v4
);
458 IP4_COPY_ADDRESS (&ConfigData
.Config4
.SubnetMask
, &Private
->SubnetMask
.v4
);
460 ConfigData
.Config6
.HttpVersion
= HttpVersion11
;
461 ConfigData
.Config6
.RequestTimeOut
= HTTP_BOOT_REQUEST_TIMEOUT
;
462 IP6_COPY_ADDRESS (&ConfigData
.Config6
.LocalIp
, &Private
->StationIp
.v6
);
465 Status
= HttpIoCreateIo (
468 Private
->UsingIpv6
? IP_VERSION_6
: IP_VERSION_4
,
472 if (EFI_ERROR (Status
)) {
476 Private
->HttpCreated
= TRUE
;
481 Release all the resource of a cache item.
483 @param[in] Cache The pointer to the cache item.
488 IN HTTP_BOOT_CACHE_CONTENT
*Cache
493 LIST_ENTRY
*NextEntry
;
494 HTTP_BOOT_ENTITY_DATA
*EntityData
;
498 // Free the request data
500 if (Cache
->RequestData
!= NULL
) {
501 if (Cache
->RequestData
->Url
!= NULL
) {
502 FreePool (Cache
->RequestData
->Url
);
504 FreePool (Cache
->RequestData
);
508 // Free the response header
510 if (Cache
->ResponseData
!= NULL
) {
511 if (Cache
->ResponseData
->Headers
!= NULL
) {
512 for (Index
= 0; Index
< Cache
->ResponseData
->HeaderCount
; Index
++) {
513 FreePool (Cache
->ResponseData
->Headers
[Index
].FieldName
);
514 FreePool (Cache
->ResponseData
->Headers
[Index
].FieldValue
);
516 FreePool (Cache
->ResponseData
->Headers
);
521 // Free the response body
523 NET_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &Cache
->EntityDataList
) {
524 EntityData
= NET_LIST_USER_STRUCT (Entry
, HTTP_BOOT_ENTITY_DATA
, Link
);
525 if (EntityData
->Block
!= NULL
) {
526 FreePool (EntityData
->Block
);
528 RemoveEntryList (&EntityData
->Link
);
529 FreePool (EntityData
);
537 Clean up all cached data.
539 @param[in] Private The pointer to the driver's private data.
543 HttpBootFreeCacheList (
544 IN HTTP_BOOT_PRIVATE_DATA
*Private
548 LIST_ENTRY
*NextEntry
;
549 HTTP_BOOT_CACHE_CONTENT
*Cache
;
551 NET_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &Private
->CacheList
) {
552 Cache
= NET_LIST_USER_STRUCT (Entry
, HTTP_BOOT_CACHE_CONTENT
, Link
);
553 RemoveEntryList (&Cache
->Link
);
554 HttpBootFreeCache (Cache
);
559 Get the file content from cached data.
561 @param[in] Private The pointer to the driver's private data.
562 @param[in] Uri Uri of the file to be retrieved from cache.
563 @param[in, out] BufferSize On input the size of Buffer in bytes. On output with a return
564 code of EFI_SUCCESS, the amount of data transferred to
565 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
566 the size of Buffer required to retrieve the requested file.
567 @param[out] Buffer The memory buffer to transfer the file to. IF Buffer is NULL,
568 then the size of the requested file is returned in
571 @retval EFI_SUCCESS Successfully created.
572 @retval Others Failed to create HttpIo.
576 HttpBootGetFileFromCache (
577 IN HTTP_BOOT_PRIVATE_DATA
*Private
,
579 IN OUT UINTN
*BufferSize
,
585 HTTP_BOOT_CACHE_CONTENT
*Cache
;
586 HTTP_BOOT_ENTITY_DATA
*EntityData
;
589 if (Uri
== NULL
|| BufferSize
== 0 || Buffer
== NULL
) {
590 return EFI_INVALID_PARAMETER
;
593 NET_LIST_FOR_EACH (Entry
, &Private
->CacheList
) {
594 Cache
= NET_LIST_USER_STRUCT (Entry
, HTTP_BOOT_CACHE_CONTENT
, Link
);
596 // Compare the URI to see whether we already have a cache for this file.
598 if ((Cache
->RequestData
!= NULL
) &&
599 (Cache
->RequestData
->Url
!= NULL
) &&
600 (StrCmp (Uri
, Cache
->RequestData
->Url
) == 0))
603 // Hit cache, check buffer size.
605 if (*BufferSize
< Cache
->EntityLength
) {
606 *BufferSize
= Cache
->EntityLength
;
607 return EFI_BUFFER_TOO_SMALL
;
611 // Fill data to buffer.
614 NET_LIST_FOR_EACH (Entry2
, &Cache
->EntityDataList
) {
615 EntityData
= NET_LIST_USER_STRUCT (Entry2
, HTTP_BOOT_ENTITY_DATA
, Link
);
616 if (*BufferSize
> CopyedSize
) {
619 EntityData
->DataStart
,
620 MIN (EntityData
->DataLength
, *BufferSize
- CopyedSize
)
622 CopyedSize
+= MIN (EntityData
->DataLength
, *BufferSize
- CopyedSize
);
625 *BufferSize
= CopyedSize
;
630 return EFI_NOT_FOUND
;
634 A callback function to intercept events during message parser.
636 This function will be invoked during HttpParseMessageBody() with various events type. An error
637 return status of the callback function will cause the HttpParseMessageBody() aborted.
639 @param[in] EventType Event type of this callback call.
640 @param[in] Data A pointer to data buffer.
641 @param[in] Length Length in bytes of the Data.
642 @param[in] Context Callback context set by HttpInitMsgParser().
644 @retval EFI_SUCCESS Continue to parser the message body.
645 @retval Others Abort the parse.
650 HttpBootGetBootFileCallback (
651 IN HTTP_BODY_PARSE_EVENT EventType
,
657 HTTP_BOOT_CALLBACK_DATA
*CallbackData
;
658 HTTP_BOOT_ENTITY_DATA
*NewEntityData
;
661 // We only care about the entity data.
663 if (EventType
!= BodyParseEventOnData
) {
667 CallbackData
= (HTTP_BOOT_CALLBACK_DATA
*) Context
;
669 // Copy data if caller has provided a buffer.
671 if (CallbackData
->BufferSize
> CallbackData
->CopyedSize
) {
673 CallbackData
->Buffer
+ CallbackData
->CopyedSize
,
675 MIN (Length
, CallbackData
->BufferSize
- CallbackData
->CopyedSize
)
677 CallbackData
->CopyedSize
+= MIN (Length
, CallbackData
->BufferSize
- CallbackData
->CopyedSize
);
681 // The caller doesn't provide a buffer, save the block into cache list.
683 if (CallbackData
->Cache
!= NULL
) {
684 NewEntityData
= AllocatePool (sizeof (HTTP_BOOT_ENTITY_DATA
));
685 if (NewEntityData
== NULL
) {
686 return EFI_OUT_OF_RESOURCES
;
688 if (CallbackData
->NewBlock
) {
689 NewEntityData
->Block
= CallbackData
->Block
;
690 CallbackData
->Block
= NULL
;
692 NewEntityData
->DataLength
= Length
;
693 NewEntityData
->DataStart
= (UINT8
*) Data
;
694 InsertTailList (&CallbackData
->Cache
->EntityDataList
, &NewEntityData
->Link
);
700 This function download the boot file by using UEFI HTTP protocol.
702 @param[in] Private The pointer to the driver's private data.
703 @param[in] HeaderOnly Only request the response header, it could save a lot of time if
704 the caller only want to know the size of the requested file.
705 @param[in, out] BufferSize On input the size of Buffer in bytes. On output with a return
706 code of EFI_SUCCESS, the amount of data transferred to
707 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
708 the size of Buffer required to retrieve the requested file.
709 @param[out] Buffer The memory buffer to transfer the file to. IF Buffer is NULL,
710 then the size of the requested file is returned in
713 @retval EFI_SUCCESS The file was loaded.
714 @retval EFI_INVALID_PARAMETER BufferSize is NULL or Buffer Size is not NULL but Buffer is NULL.
715 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources
716 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to read the current directory entry.
717 BufferSize has been updated with the size needed to complete
719 @retval Others Unexpected error happened.
723 HttpBootGetBootFile (
724 IN HTTP_BOOT_PRIVATE_DATA
*Private
,
725 IN BOOLEAN HeaderOnly
,
726 IN OUT UINTN
*BufferSize
,
731 EFI_HTTP_STATUS_CODE StatusCode
;
733 EFI_HTTP_REQUEST_DATA
*RequestData
;
734 HTTP_IO_RESPONSE_DATA
*ResponseData
;
735 HTTP_IO_RESPONSE_DATA ResponseBody
;
737 HTTP_IO_HEADER
*HttpIoHeader
;
739 HTTP_BOOT_CALLBACK_DATA Context
;
741 HTTP_BOOT_CACHE_CONTENT
*Cache
;
744 BOOLEAN IdentityMode
;
747 ASSERT (Private
!= NULL
);
748 ASSERT (Private
->HttpCreated
);
750 if (BufferSize
== NULL
) {
751 return EFI_INVALID_PARAMETER
;
754 if (*BufferSize
!= 0 && Buffer
== NULL
) {
755 return EFI_INVALID_PARAMETER
;
759 // First, check whether we already cached the requested Uri.
761 Url
= AllocatePool ((AsciiStrLen (Private
->BootFileUri
) + 1) * sizeof (CHAR16
));
763 return EFI_OUT_OF_RESOURCES
;
765 AsciiStrToUnicodeStr (Private
->BootFileUri
, Url
);
767 Status
= HttpBootGetFileFromCache (Private
, Url
, BufferSize
, Buffer
);
768 if (Status
!= EFI_NOT_FOUND
) {
775 // Not found in cache, try to download it through HTTP.
779 // 1. Create a temp cache item for the requested URI if caller doesn't provide buffer.
782 if ((!HeaderOnly
) && (*BufferSize
== 0)) {
783 Cache
= AllocateZeroPool (sizeof (HTTP_BOOT_CACHE_CONTENT
));
785 Status
= EFI_OUT_OF_RESOURCES
;
788 InitializeListHead (&Cache
->EntityDataList
);
792 // 2. Send HTTP request message.
796 // 2.1 Build HTTP header for the request, 3 header is needed to download a boot file:
801 HttpIoHeader
= HttpBootCreateHeader (3);
802 if (HttpIoHeader
== NULL
) {
803 Status
= EFI_OUT_OF_RESOURCES
;
808 // Add HTTP header field 1: Host
811 Status
= HttpUrlGetHostName (
812 Private
->BootFileUri
,
813 Private
->BootFileUriParser
,
816 if (EFI_ERROR (Status
)) {
819 Status
= HttpBootSetHeader (
825 if (EFI_ERROR (Status
)) {
830 // Add HTTP header field 2: Accept
832 Status
= HttpBootSetHeader (
837 if (EFI_ERROR (Status
)) {
842 // Add HTTP header field 3: User-Agent
844 Status
= HttpBootSetHeader (
846 HTTP_HEADER_USER_AGENT
,
847 HTTP_USER_AGENT_EFI_HTTP_BOOT
849 if (EFI_ERROR (Status
)) {
854 // 2.2 Build the rest of HTTP request info.
856 RequestData
= AllocatePool (sizeof (EFI_HTTP_REQUEST_DATA
));
857 if (RequestData
== NULL
) {
858 Status
= EFI_OUT_OF_RESOURCES
;
861 RequestData
->Method
= HeaderOnly
? HttpMethodHead
: HttpMethodGet
;
862 RequestData
->Url
= Url
;
863 if (RequestData
->Url
== NULL
) {
864 Status
= EFI_OUT_OF_RESOURCES
;
867 AsciiStrToUnicodeStr (Private
->BootFileUri
, RequestData
->Url
);
870 // 2.3 Record the request info in a temp cache item.
873 Cache
->RequestData
= RequestData
;
877 // 2.4 Send out the request to HTTP server.
879 HttpIo
= &Private
->HttpIo
;
880 Status
= HttpIoSendRequest (
883 HttpIoHeader
->HeaderCount
,
884 HttpIoHeader
->Headers
,
888 if (EFI_ERROR (Status
)) {
893 // 3. Receive HTTP response message.
897 // 3.1 First step, use zero BodyLength to only receive the response headers.
899 ResponseData
= AllocateZeroPool (sizeof(HTTP_IO_RESPONSE_DATA
));
900 if (ResponseData
== NULL
) {
901 Status
= EFI_OUT_OF_RESOURCES
;
904 Status
= HttpIoRecvResponse (
909 if (EFI_ERROR (Status
) || EFI_ERROR (ResponseData
->Status
)) {
910 if (EFI_ERROR (ResponseData
->Status
)) {
911 StatusCode
= HttpIo
->RspToken
.Message
->Data
.Response
->StatusCode
;
912 HttpBootPrintErrorMessage (StatusCode
);
913 Status
= ResponseData
->Status
;
919 // 3.2 Cache the response header.
922 Cache
->ResponseData
= ResponseData
;
926 // 3.3 Init a message-body parser from the header information.
929 Context
.NewBlock
= FALSE
;
930 Context
.Block
= NULL
;
931 Context
.CopyedSize
= 0;
932 Context
.Buffer
= Buffer
;
933 Context
.BufferSize
= *BufferSize
;
934 Context
.Cache
= Cache
;
935 Status
= HttpInitMsgParser (
936 HeaderOnly
? HttpMethodHead
: HttpMethodGet
,
937 ResponseData
->Response
.StatusCode
,
938 ResponseData
->HeaderCount
,
939 ResponseData
->Headers
,
940 HttpBootGetBootFileCallback
,
944 if (EFI_ERROR (Status
)) {
949 // 3.4 Continue to receive and parse message-body if needed.
954 // 3.4.1, check whether we are in identity transfer-coding.
957 Status
= HttpGetEntityLength (Parser
, &ContentLength
);
958 if (!EFI_ERROR (Status
)) {
961 IdentityMode
= FALSE
;
965 // 3.4.2, start the message-body download, the identity and chunked transfer-coding
966 // is handled in different path here.
968 ZeroMem (&ResponseBody
, sizeof (HTTP_IO_RESPONSE_DATA
));
971 // In identity transfer-coding there is no need to parse the message body,
972 // just download the message body to the user provided buffer directly.
975 while (ReceivedSize
< ContentLength
) {
976 ResponseBody
.Body
= (CHAR8
*) Buffer
+ ReceivedSize
;
977 ResponseBody
.BodyLength
= *BufferSize
- ReceivedSize
;
978 Status
= HttpIoRecvResponse (
983 if (EFI_ERROR (Status
)) {
986 ReceivedSize
+= ResponseBody
.BodyLength
;
990 // In "chunked" transfer-coding mode, so we need to parse the received
991 // data to get the real entity content.
994 while (!HttpIsMessageComplete (Parser
)) {
996 // Allocate a buffer in Block to hold the message-body.
997 // If caller provides a buffer, this Block will be reused in every HttpIoRecvResponse().
998 // Otherwise a buffer, the buffer in Block will be cached and we should allocate a new before
999 // every HttpIoRecvResponse().
1001 if (Block
== NULL
|| Context
.BufferSize
== 0) {
1002 Block
= AllocatePool (HTTP_BOOT_BLOCK_SIZE
);
1003 if (Block
== NULL
) {
1004 Status
= EFI_OUT_OF_RESOURCES
;
1007 Context
.NewBlock
= TRUE
;
1008 Context
.Block
= Block
;
1010 Context
.NewBlock
= FALSE
;
1013 ResponseBody
.Body
= (CHAR8
*) Block
;
1014 ResponseBody
.BodyLength
= HTTP_BOOT_BLOCK_SIZE
;
1015 Status
= HttpIoRecvResponse (
1020 if (EFI_ERROR (Status
)) {
1025 // Parse the new received block of the message-body, the block will be saved in cache.
1027 Status
= HttpParseMessageBody (
1029 ResponseBody
.BodyLength
,
1032 if (EFI_ERROR (Status
)) {
1040 // 3.5 Message-body receive & parse is completed, we should be able to get the file size now.
1042 Status
= HttpGetEntityLength (Parser
, &ContentLength
);
1043 if (EFI_ERROR (Status
)) {
1047 if (*BufferSize
< ContentLength
) {
1048 Status
= EFI_BUFFER_TOO_SMALL
;
1050 *BufferSize
= ContentLength
;
1053 // 4. Save the cache item to driver's cache list and return.
1055 if (Cache
!= NULL
) {
1056 Cache
->EntityLength
= ContentLength
;
1057 InsertTailList (&Private
->CacheList
, &Cache
->Link
);
1060 if (Parser
!= NULL
) {
1061 HttpFreeMsgParser (Parser
);
1067 if (Parser
!= NULL
) {
1068 HttpFreeMsgParser (Parser
);
1070 if (Context
.Block
!= NULL
) {
1071 FreePool (Context
.Block
);
1073 HttpBootFreeCache (Cache
);
1076 if (ResponseData
!= NULL
) {
1077 FreePool (ResponseData
);
1080 if (RequestData
!= NULL
) {
1081 FreePool (RequestData
);
1084 HttpBootFreeHeader (HttpIoHeader
);
1086 if (Cache
!= NULL
) {