2 Implementation of EFI_HTTP_PROTOCOL protocol interfaces.
4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "HttpDriver.h"
19 EFI_HTTP_PROTOCOL mEfiHttpTemplate
= {
29 Returns the operational parameters for the current HTTP child instance.
31 The GetModeData() function is used to read the current mode data (operational
32 parameters) for this HTTP protocol instance.
34 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
35 @param[out] HttpConfigData Point to buffer for operational parameters of this
38 @retval EFI_SUCCESS Operation succeeded.
39 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
41 HttpConfigData is NULL.
42 HttpInstance->LocalAddressIsIPv6 is FALSE and
43 HttpConfigData->IPv4Node is NULL.
44 HttpInstance->LocalAddressIsIPv6 is TRUE and
45 HttpConfigData->IPv6Node is NULL.
46 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
52 IN EFI_HTTP_PROTOCOL
*This
,
53 OUT EFI_HTTP_CONFIG_DATA
*HttpConfigData
56 HTTP_PROTOCOL
*HttpInstance
;
59 // Check input parameters.
61 if ((This
== NULL
) || (HttpConfigData
== NULL
)) {
62 return EFI_INVALID_PARAMETER
;
65 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
66 ASSERT (HttpInstance
!= NULL
);
68 if ((HttpInstance
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv6Node
== NULL
) ||
69 (!HttpInstance
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv4Node
== NULL
)) {
70 return EFI_INVALID_PARAMETER
;
73 if (HttpInstance
->State
< HTTP_STATE_HTTP_CONFIGED
) {
74 return EFI_NOT_STARTED
;
77 HttpConfigData
->HttpVersion
= HttpInstance
->HttpVersion
;
78 HttpConfigData
->TimeOutMillisec
= HttpInstance
->TimeOutMillisec
;
79 HttpConfigData
->LocalAddressIsIPv6
= HttpInstance
->LocalAddressIsIPv6
;
81 if (HttpInstance
->LocalAddressIsIPv6
) {
83 HttpConfigData
->AccessPoint
.IPv6Node
,
84 &HttpInstance
->Ipv6Node
,
85 sizeof (HttpInstance
->Ipv6Node
)
89 HttpConfigData
->AccessPoint
.IPv4Node
,
90 &HttpInstance
->IPv4Node
,
91 sizeof (HttpInstance
->IPv4Node
)
99 Initialize or brutally reset the operational parameters for this EFI HTTP instance.
101 The Configure() function does the following:
102 When HttpConfigData is not NULL Initialize this EFI HTTP instance by configuring
103 timeout, local address, port, etc.
104 When HttpConfigData is NULL, reset this EFI HTTP instance by closing all active
105 connections with remote hosts, canceling all asynchronous tokens, and flush request
106 and response buffers without informing the appropriate hosts.
108 No other EFI HTTP function can be executed by this instance until the Configure()
109 function is executed and returns successfully.
111 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
112 @param[in] HttpConfigData Pointer to the configure data to configure the instance.
114 @retval EFI_SUCCESS Operation succeeded.
115 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
117 HttpConfigData is NULL.
118 HttpConfigData->LocalAddressIsIPv6 is FALSE and
119 HttpConfigData->IPv4Node is NULL.
120 HttpConfigData->LocalAddressIsIPv6 is TRUE and
121 HttpConfigData->IPv6Node is NULL.
122 @retval EFI_ALREADY_STARTED Reinitialize this HTTP instance without calling
123 Configure() with NULL to reset it.
124 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
125 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources when
126 executing Configure().
127 @retval EFI_UNSUPPORTED One or more options in HttpConfigData are not supported
128 in the implementation.
133 IN EFI_HTTP_PROTOCOL
*This
,
134 IN EFI_HTTP_CONFIG_DATA
*HttpConfigData
137 HTTP_PROTOCOL
*HttpInstance
;
141 // Check input parameters.
144 HttpConfigData
== NULL
||
145 ((HttpConfigData
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv6Node
== NULL
) ||
146 (!HttpConfigData
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv4Node
== NULL
))) {
147 return EFI_INVALID_PARAMETER
;
150 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
151 ASSERT (HttpInstance
!= NULL
&& HttpInstance
->Service
!= NULL
);
153 if (HttpConfigData
!= NULL
) {
156 // Now configure this HTTP instance.
158 if (HttpInstance
->State
!= HTTP_STATE_UNCONFIGED
) {
159 return EFI_ALREADY_STARTED
;
162 HttpInstance
->HttpVersion
= HttpConfigData
->HttpVersion
;
163 HttpInstance
->TimeOutMillisec
= HttpConfigData
->TimeOutMillisec
;
164 HttpInstance
->LocalAddressIsIPv6
= HttpConfigData
->LocalAddressIsIPv6
;
166 if (HttpConfigData
->LocalAddressIsIPv6
) {
168 &HttpInstance
->Ipv6Node
,
169 HttpConfigData
->AccessPoint
.IPv6Node
,
170 sizeof (HttpInstance
->Ipv6Node
)
174 &HttpInstance
->IPv4Node
,
175 HttpConfigData
->AccessPoint
.IPv4Node
,
176 sizeof (HttpInstance
->IPv4Node
)
183 Status
= HttpInitProtocol (HttpInstance
, HttpInstance
->LocalAddressIsIPv6
);
184 if (EFI_ERROR (Status
)) {
188 HttpInstance
->State
= HTTP_STATE_HTTP_CONFIGED
;
193 // Reset all the resources related to HttpInsance.
195 HttpCleanProtocol (HttpInstance
);
196 HttpInstance
->State
= HTTP_STATE_UNCONFIGED
;
203 The Request() function queues an HTTP request to this HTTP instance.
205 Similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent
206 successfully, or if there is an error, Status in token will be updated and Event will
209 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
210 @param[in] Token Pointer to storage containing HTTP request token.
212 @retval EFI_SUCCESS Outgoing data was processed.
213 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
214 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
215 @retval EFI_TIMEOUT Data was dropped out of the transmit or receive queue.
216 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
217 @retval EFI_UNSUPPORTED The HTTP method is not supported in current
219 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
222 Token->Message is NULL.
223 Token->Message->Body is not NULL,
224 Token->Message->BodyLength is non-zero, and
225 Token->Message->Data is NULL, but a previous call to
226 Request()has not been completed successfully.
231 IN EFI_HTTP_PROTOCOL
*This
,
232 IN EFI_HTTP_TOKEN
*Token
235 EFI_HTTP_MESSAGE
*HttpMsg
;
236 EFI_HTTP_REQUEST_DATA
*Request
;
241 HTTP_PROTOCOL
*HttpInstance
;
248 HTTP_TOKEN_WRAP
*Wrap
;
250 UINTN RequestMsgSize
;
262 if ((This
== NULL
) || (Token
== NULL
)) {
263 return EFI_INVALID_PARAMETER
;
266 HttpMsg
= Token
->Message
;
267 if (HttpMsg
== NULL
) {
268 return EFI_INVALID_PARAMETER
;
271 Request
= HttpMsg
->Data
.Request
;
274 // Only support GET, HEAD, PUT and POST method in current implementation.
276 if ((Request
!= NULL
) && (Request
->Method
!= HttpMethodGet
) &&
277 (Request
->Method
!= HttpMethodHead
) && (Request
->Method
!= HttpMethodPut
) && (Request
->Method
!= HttpMethodPost
)) {
278 return EFI_UNSUPPORTED
;
281 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
282 ASSERT (HttpInstance
!= NULL
);
285 // Capture the method into HttpInstance.
287 if (Request
!= NULL
) {
288 HttpInstance
->Method
= Request
->Method
;
291 if (HttpInstance
->State
< HTTP_STATE_HTTP_CONFIGED
) {
292 return EFI_NOT_STARTED
;
295 if (Request
== NULL
) {
297 // Request would be NULL only for PUT/POST operation (in the current implementation)
299 if ((HttpInstance
->Method
!= HttpMethodPut
) && (HttpInstance
->Method
!= HttpMethodPost
)) {
300 return EFI_INVALID_PARAMETER
;
304 // For PUT/POST, we need to have the TCP already configured. Bail out if it is not!
306 if (HttpInstance
->State
< HTTP_STATE_TCP_CONFIGED
) {
307 return EFI_INVALID_PARAMETER
;
311 // We need to have the Message Body for sending the HTTP message across in these cases.
313 if (HttpMsg
->Body
== NULL
|| HttpMsg
->BodyLength
== 0) {
314 return EFI_INVALID_PARAMETER
;
318 // Use existing TCP instance to transmit the packet.
324 // Check whether the token already existed.
326 if (EFI_ERROR (NetMapIterate (&HttpInstance
->TxTokens
, HttpTokenExist
, Token
))) {
327 return EFI_ACCESS_DENIED
;
331 // Parse the URI of the remote host.
333 Url
= HttpInstance
->Url
;
334 UrlLen
= StrLen (Request
->Url
) + 1;
335 if (UrlLen
> HTTP_URL_BUFFER_LEN
) {
336 Url
= AllocateZeroPool (UrlLen
);
338 return EFI_OUT_OF_RESOURCES
;
340 FreePool (HttpInstance
->Url
);
341 HttpInstance
->Url
= Url
;
345 UnicodeStrToAsciiStr (Request
->Url
, Url
);
347 Status
= HttpParseUrl (Url
, (UINT32
) AsciiStrLen (Url
), FALSE
, &UrlParser
);
348 if (EFI_ERROR (Status
)) {
353 Status
= HttpUrlGetHostName (Url
, UrlParser
, &HostName
);
354 if (EFI_ERROR (Status
)) {
358 Status
= HttpUrlGetPort (Url
, UrlParser
, &RemotePort
);
359 if (EFI_ERROR (Status
)) {
360 RemotePort
= HTTP_DEFAULT_PORT
;
363 // If Configure is TRUE, it indicates the first time to call Request();
364 // If ReConfigure is TRUE, it indicates the request URL is not same
365 // with the previous call to Request();
370 if (HttpInstance
->RemoteHost
== NULL
) {
372 // Request() is called the first time.
376 if ((HttpInstance
->RemotePort
== RemotePort
) &&
377 (AsciiStrCmp (HttpInstance
->RemoteHost
, HostName
) == 0)) {
379 // Host Name and port number of the request URL are the same with previous call to Request().
380 // Check whether previous TCP packet sent out.
383 if (EFI_ERROR (NetMapIterate (&HttpInstance
->TxTokens
, HttpTcpNotReady
, NULL
))) {
385 // Wrap the HTTP token in HTTP_TOKEN_WRAP
387 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
389 Status
= EFI_OUT_OF_RESOURCES
;
393 Wrap
->HttpToken
= Token
;
394 Wrap
->HttpInstance
= HttpInstance
;
396 Status
= HttpCreateTcpTxEvent (Wrap
);
397 if (EFI_ERROR (Status
)) {
401 Status
= NetMapInsertTail (&HttpInstance
->TxTokens
, Token
, Wrap
);
402 if (EFI_ERROR (Status
)) {
406 Wrap
->TcpWrap
.Method
= Request
->Method
;
411 // Queue the HTTP token and return.
416 // Use existing TCP instance to transmit the packet.
423 // Need close existing TCP instance and create a new TCP instance for data transmit.
425 if (HttpInstance
->RemoteHost
!= NULL
) {
426 FreePool (HttpInstance
->RemoteHost
);
427 HttpInstance
->RemoteHost
= NULL
;
428 HttpInstance
->RemotePort
= 0;
436 // Parse Url for IPv4 or IPv6 address, if failed, perform DNS resolution.
438 if (!HttpInstance
->LocalAddressIsIPv6
) {
439 Status
= NetLibAsciiStrToIp4 (HostName
, &HttpInstance
->RemoteAddr
);
441 Status
= HttpUrlGetIp6 (Url
, UrlParser
, &HttpInstance
->RemoteIpv6Addr
);
444 if (EFI_ERROR (Status
)) {
445 HostNameStr
= AllocateZeroPool ((AsciiStrLen (HostName
) + 1) * sizeof (CHAR16
));
446 if (HostNameStr
== NULL
) {
447 Status
= EFI_OUT_OF_RESOURCES
;
451 AsciiStrToUnicodeStr (HostName
, HostNameStr
);
452 if (!HttpInstance
->LocalAddressIsIPv6
) {
453 Status
= HttpDns4 (HttpInstance
, HostNameStr
, &HttpInstance
->RemoteAddr
);
455 Status
= HttpDns6 (HttpInstance
, HostNameStr
, &HttpInstance
->RemoteIpv6Addr
);
458 FreePool (HostNameStr
);
459 if (EFI_ERROR (Status
)) {
466 // Save the RemotePort and RemoteHost.
468 ASSERT (HttpInstance
->RemoteHost
== NULL
);
469 HttpInstance
->RemotePort
= RemotePort
;
470 HttpInstance
->RemoteHost
= HostName
;
476 // The request URL is different from previous calls to Request(), close existing TCP instance.
478 if (!HttpInstance
->LocalAddressIsIPv6
) {
479 ASSERT (HttpInstance
->Tcp4
!= NULL
);
481 ASSERT (HttpInstance
->Tcp6
!= NULL
);
483 HttpCloseConnection (HttpInstance
);
484 EfiHttpCancel (This
, NULL
);
488 // Wrap the HTTP token in HTTP_TOKEN_WRAP
490 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
492 Status
= EFI_OUT_OF_RESOURCES
;
496 Wrap
->HttpToken
= Token
;
497 Wrap
->HttpInstance
= HttpInstance
;
498 if (Request
!= NULL
) {
499 Wrap
->TcpWrap
.Method
= Request
->Method
;
502 Status
= HttpInitTcp (HttpInstance
, Wrap
, Configure
);
503 if (EFI_ERROR (Status
)) {
509 // For the new HTTP token, create TX TCP token events.
511 Status
= HttpCreateTcpTxEvent (Wrap
);
512 if (EFI_ERROR (Status
)) {
518 // Create request message.
521 if (Url
!= NULL
&& *FileUrl
!= '/') {
523 // Convert the absolute-URI to the absolute-path
525 while (*FileUrl
!= ':') {
528 if ((*(FileUrl
+1) == '/') && (*(FileUrl
+2) == '/')) {
530 while (*FileUrl
!= '/') {
534 Status
= EFI_INVALID_PARAMETER
;
539 Status
= HttpGenRequestMessage (HttpMsg
, FileUrl
, &RequestMsg
, &RequestMsgSize
);
541 if (EFI_ERROR (Status
)) {
546 // Every request we insert a TxToken and a response call would remove the TxToken.
547 // In cases of PUT/POST, after an initial request-response pair, we would do a
548 // continuous request without a response call. So, in such cases, where Request
549 // structure is NULL, we would not insert a TxToken.
551 if (Request
!= NULL
) {
552 Status
= NetMapInsertTail (&HttpInstance
->TxTokens
, Token
, Wrap
);
553 if (EFI_ERROR (Status
)) {
559 // Transmit the request message.
561 Status
= HttpTransmitTcp (
567 if (EFI_ERROR (Status
)) {
573 if (HostName
!= NULL
) {
581 // We would have inserted a TxToken only if Request structure is not NULL.
582 // Hence check before we do a remove in this error case.
584 if (Request
!= NULL
) {
585 NetMapRemoveTail (&HttpInstance
->TxTokens
, NULL
);
589 if (RequestMsg
!= NULL
) {
590 FreePool (RequestMsg
);
594 HttpCloseConnection (HttpInstance
);
597 HttpCloseTcpConnCloseEvent (HttpInstance
);
598 if (NULL
!= Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
) {
599 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
);
600 Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
= NULL
;
602 if (NULL
!= Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
) {
603 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
);
604 Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
= NULL
;
609 if (HostName
!= NULL
) {
615 if (UrlParser
!= NULL
) {
616 HttpUrlFreeParser (UrlParser
);
624 Cancel a user's Token.
626 @param[in] Map The HTTP instance's token queue.
627 @param[in] Item Object container for one HTTP token and token's wrap.
628 @param[in] Context The user's token to cancel.
630 @retval EFI_SUCCESS Continue to check the next Item.
631 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.
638 IN NET_MAP_ITEM
*Item
,
643 EFI_HTTP_TOKEN
*Token
;
644 HTTP_TOKEN_WRAP
*Wrap
;
645 HTTP_PROTOCOL
*HttpInstance
;
647 Token
= (EFI_HTTP_TOKEN
*) Context
;
650 // Return EFI_SUCCESS to check the next item in the map if
651 // this one doesn't match.
653 if ((Token
!= NULL
) && (Token
!= Item
->Key
)) {
657 Wrap
= (HTTP_TOKEN_WRAP
*) Item
->Value
;
658 ASSERT (Wrap
!= NULL
);
659 HttpInstance
= Wrap
->HttpInstance
;
664 NetMapRemoveItem (Map
, Item
, NULL
);
666 if (!HttpInstance
->LocalAddressIsIPv6
) {
667 if (Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
!= NULL
) {
668 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
);
671 if (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
!= NULL
) {
672 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
);
675 if (Wrap
->TcpWrap
.Rx4Token
.Packet
.RxData
->FragmentTable
[0].FragmentBuffer
!= NULL
) {
676 FreePool (Wrap
->TcpWrap
.Rx4Token
.Packet
.RxData
->FragmentTable
[0].FragmentBuffer
);
680 if (Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
!= NULL
) {
681 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
);
684 if (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
!= NULL
) {
685 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
);
688 if (Wrap
->TcpWrap
.Rx6Token
.Packet
.RxData
->FragmentTable
[0].FragmentBuffer
!= NULL
) {
689 FreePool (Wrap
->TcpWrap
.Rx6Token
.Packet
.RxData
->FragmentTable
[0].FragmentBuffer
);
697 // If only one item is to be cancel, return EFI_ABORTED to stop
698 // iterating the map any more.
708 Cancel the user's receive/transmit request. It is the worker function of
709 EfiHttpCancel API. If a matching token is found, it will call HttpCancelTokens to cancel the
712 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
713 @param[in] Token The token to cancel. If NULL, all token will be
716 @retval EFI_SUCCESS The token is cancelled.
717 @retval EFI_NOT_FOUND The asynchronous request or response token is not found.
718 @retval Others Other error as indicated.
723 IN HTTP_PROTOCOL
*HttpInstance
,
724 IN EFI_HTTP_TOKEN
*Token
730 // First check the tokens queued by EfiHttpRequest().
732 Status
= NetMapIterate (&HttpInstance
->TxTokens
, HttpCancelTokens
, Token
);
733 if (EFI_ERROR (Status
)) {
735 if (Status
== EFI_ABORTED
) {
744 // Then check the tokens queued by EfiHttpResponse().
746 Status
= NetMapIterate (&HttpInstance
->RxTokens
, HttpCancelTokens
, Token
);
747 if (EFI_ERROR (Status
)) {
749 if (Status
== EFI_ABORTED
) {
752 return EFI_NOT_FOUND
;
764 Abort an asynchronous HTTP request or response token.
766 The Cancel() function aborts a pending HTTP request or response transaction. If
767 Token is not NULL and the token is in transmit or receive queues when it is being
768 cancelled, its Token->Status will be set to EFI_ABORTED and then Token->Event will
769 be signaled. If the token is not in one of the queues, which usually means that the
770 asynchronous operation has completed, EFI_NOT_FOUND is returned. If Token is NULL,
771 all asynchronous tokens issued by Request() or Response() will be aborted.
773 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
774 @param[in] Token Point to storage containing HTTP request or response
777 @retval EFI_SUCCESS Request and Response queues are successfully flushed.
778 @retval EFI_INVALID_PARAMETER This is NULL.
779 @retval EFI_NOT_STARTED This instance hasn't been configured.
780 @retval EFI_NOT_FOUND The asynchronous request or response token is not
782 @retval EFI_UNSUPPORTED The implementation does not support this function.
788 IN EFI_HTTP_PROTOCOL
*This
,
789 IN EFI_HTTP_TOKEN
*Token
792 HTTP_PROTOCOL
*HttpInstance
;
795 return EFI_INVALID_PARAMETER
;
798 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
799 ASSERT (HttpInstance
!= NULL
);
801 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
802 return EFI_NOT_STARTED
;
805 return HttpCancel (HttpInstance
, Token
);
810 A callback function to intercept events during message parser.
812 This function will be invoked during HttpParseMessageBody() with various events type. An error
813 return status of the callback function will cause the HttpParseMessageBody() aborted.
815 @param[in] EventType Event type of this callback call.
816 @param[in] Data A pointer to data buffer.
817 @param[in] Length Length in bytes of the Data.
818 @param[in] Context Callback context set by HttpInitMsgParser().
820 @retval EFI_SUCCESS Continue to parser the message body.
825 HttpBodyParserCallback (
826 IN HTTP_BODY_PARSE_EVENT EventType
,
832 HTTP_TOKEN_WRAP
*Wrap
;
836 if (EventType
!= BodyParseEventOnComplete
) {
840 if (Data
== NULL
|| Length
!= 0 || Context
== NULL
) {
844 Wrap
= (HTTP_TOKEN_WRAP
*) Context
;
845 Body
= Wrap
->HttpToken
->Message
->Body
;
846 BodyLength
= Wrap
->HttpToken
->Message
->BodyLength
;
847 if (Data
< Body
+ BodyLength
) {
848 Wrap
->HttpInstance
->NextMsg
= Data
;
850 Wrap
->HttpInstance
->NextMsg
= NULL
;
855 // Free Tx4Token or Tx6Token since already received corrsponding HTTP response.
863 The work function of EfiHttpResponse().
865 @param[in] Wrap Pointer to HTTP token's wrap data.
867 @retval EFI_SUCCESS Allocation succeeded.
868 @retval EFI_OUT_OF_RESOURCES Failed to complete the opration due to lack of resources.
869 @retval EFI_NOT_READY Can't find a corresponding Tx4Token/Tx6Token or
870 the EFI_HTTP_UTILITIES_PROTOCOL is not available.
875 IN HTTP_TOKEN_WRAP
*Wrap
879 EFI_HTTP_MESSAGE
*HttpMsg
;
887 CHAR8
*StatusCodeStr
;
889 HTTP_PROTOCOL
*HttpInstance
;
890 EFI_HTTP_TOKEN
*Token
;
892 HTTP_TOKEN_WRAP
*ValueInItem
;
895 if (Wrap
== NULL
|| Wrap
->HttpInstance
== NULL
) {
896 return EFI_INVALID_PARAMETER
;
899 HttpInstance
= Wrap
->HttpInstance
;
900 Token
= Wrap
->HttpToken
;
901 HttpMsg
= Token
->Message
;
903 HttpInstance
->EndofHeader
= NULL
;
904 HttpInstance
->HttpHeaders
= NULL
;
905 HttpMsg
->Headers
= NULL
;
911 if (HttpMsg
->Data
.Response
!= NULL
) {
913 // Need receive the HTTP headers, prepare buffer.
915 Status
= HttpCreateTcpRxEventForHeader (HttpInstance
);
916 if (EFI_ERROR (Status
)) {
921 // Check whether we have cached header from previous call.
923 if ((HttpInstance
->CacheBody
!= NULL
) && (HttpInstance
->NextMsg
!= NULL
)) {
925 // The data is stored at [NextMsg, CacheBody + CacheLen].
927 HdrLen
= HttpInstance
->CacheBody
+ HttpInstance
->CacheLen
- HttpInstance
->NextMsg
;
928 HttpHeaders
= AllocateZeroPool (HdrLen
);
929 if (HttpHeaders
== NULL
) {
930 Status
= EFI_OUT_OF_RESOURCES
;
934 CopyMem (HttpHeaders
, HttpInstance
->NextMsg
, HdrLen
);
935 FreePool (HttpInstance
->CacheBody
);
936 HttpInstance
->CacheBody
= NULL
;
937 HttpInstance
->NextMsg
= NULL
;
938 HttpInstance
->CacheOffset
= 0;
939 SizeofHeaders
= HdrLen
;
940 BufferSize
= HttpInstance
->CacheLen
;
943 // Check whether we cached the whole HTTP headers.
945 EndofHeader
= AsciiStrStr (HttpHeaders
, HTTP_END_OF_HDR_STR
);
948 HttpInstance
->EndofHeader
= &EndofHeader
;
949 HttpInstance
->HttpHeaders
= &HttpHeaders
;
952 if (HttpInstance
->TimeoutEvent
== NULL
) {
954 // Create TimeoutEvent for response
956 Status
= gBS
->CreateEvent (
961 &HttpInstance
->TimeoutEvent
963 if (EFI_ERROR (Status
)) {
969 // Start the timer, and wait Timeout seconds to receive the header packet.
971 Status
= gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerRelative
, HTTP_RESPONSE_TIMEOUT
* TICKS_PER_SECOND
);
972 if (EFI_ERROR (Status
)) {
976 Status
= HttpTcpReceiveHeader (HttpInstance
, &SizeofHeaders
, &BufferSize
, HttpInstance
->TimeoutEvent
);
978 gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerCancel
, 0);
980 if (EFI_ERROR (Status
)) {
984 ASSERT (HttpHeaders
!= NULL
);
987 // Cache the part of body.
989 BodyLen
= BufferSize
- (EndofHeader
- HttpHeaders
);
991 if (HttpInstance
->CacheBody
!= NULL
) {
992 FreePool (HttpInstance
->CacheBody
);
995 HttpInstance
->CacheBody
= AllocateZeroPool (BodyLen
);
996 if (HttpInstance
->CacheBody
== NULL
) {
997 Status
= EFI_OUT_OF_RESOURCES
;
1001 CopyMem (HttpInstance
->CacheBody
, EndofHeader
, BodyLen
);
1002 HttpInstance
->CacheLen
= BodyLen
;
1006 // Search for Status Code.
1008 StatusCodeStr
= HttpHeaders
+ AsciiStrLen (HTTP_VERSION_STR
) + 1;
1009 if (StatusCodeStr
== NULL
) {
1013 StatusCode
= AsciiStrDecimalToUintn (StatusCodeStr
);
1016 // Remove the first line of HTTP message, e.g. "HTTP/1.1 200 OK\r\n".
1018 Tmp
= AsciiStrStr (HttpHeaders
, HTTP_CRLF_STR
);
1024 // We could have response with just a HTTP message and no headers. For Example,
1025 // "100 Continue". In such cases, we would not want to unnecessarily call a Parse
1026 // method. A "\r\n" following Tmp string again would indicate an end. Compare and
1027 // set SizeofHeaders to 0.
1029 Tmp
= Tmp
+ AsciiStrLen (HTTP_CRLF_STR
);
1030 if (CompareMem (Tmp
, HTTP_CRLF_STR
, AsciiStrLen (HTTP_CRLF_STR
)) == 0) {
1033 SizeofHeaders
= SizeofHeaders
- (Tmp
- HttpHeaders
);
1036 HttpMsg
->Data
.Response
->StatusCode
= HttpMappingToStatusCode (StatusCode
);
1037 HttpInstance
->StatusCode
= StatusCode
;
1039 Status
= EFI_NOT_READY
;
1043 // In cases of PUT/POST, after an initial request-response pair, we would do a
1044 // continuous request without a response call. So, we would not do an insert of
1045 // TxToken. After we have sent the complete file, we will call a response to get
1046 // a final response from server. In such a case, we would not have any TxTokens.
1047 // Hence, check that case before doing a NetMapRemoveHead.
1049 if (!NetMapIsEmpty (&HttpInstance
->TxTokens
)) {
1050 NetMapRemoveHead (&HttpInstance
->TxTokens
, (VOID
**) &ValueInItem
);
1051 if (ValueInItem
== NULL
) {
1056 // The first Tx Token not transmitted yet, insert back and return error.
1058 if (!ValueInItem
->TcpWrap
.IsTxDone
) {
1063 if (SizeofHeaders
!= 0) {
1064 HeaderTmp
= AllocateZeroPool (SizeofHeaders
);
1065 if (HeaderTmp
== NULL
) {
1069 CopyMem (HeaderTmp
, Tmp
, SizeofHeaders
);
1070 FreePool (HttpHeaders
);
1071 HttpHeaders
= HeaderTmp
;
1074 // Check whether the EFI_HTTP_UTILITIES_PROTOCOL is available.
1076 if (mHttpUtilities
== NULL
) {
1077 Status
= EFI_NOT_READY
;
1082 // Parse the HTTP header into array of key/value pairs.
1084 Status
= mHttpUtilities
->Parse (
1089 &HttpMsg
->HeaderCount
1091 if (EFI_ERROR (Status
)) {
1095 FreePool (HttpHeaders
);
1100 // Init message-body parser by header information.
1102 Status
= HttpInitMsgParser (
1103 HttpInstance
->Method
,
1104 HttpMsg
->Data
.Response
->StatusCode
,
1105 HttpMsg
->HeaderCount
,
1107 HttpBodyParserCallback
,
1108 (VOID
*) ValueInItem
,
1109 &HttpInstance
->MsgParser
1111 if (EFI_ERROR (Status
)) {
1116 // Check whether we received a complete HTTP message.
1118 if (HttpInstance
->CacheBody
!= NULL
) {
1119 Status
= HttpParseMessageBody (HttpInstance
->MsgParser
, HttpInstance
->CacheLen
, HttpInstance
->CacheBody
);
1120 if (EFI_ERROR (Status
)) {
1124 if (HttpIsMessageComplete (HttpInstance
->MsgParser
)) {
1126 // Free the MsgParse since we already have a full HTTP message.
1128 HttpFreeMsgParser (HttpInstance
->MsgParser
);
1129 HttpInstance
->MsgParser
= NULL
;
1134 if ((HttpMsg
->Body
== NULL
) || (HttpMsg
->BodyLength
== 0)) {
1135 Status
= EFI_SUCCESS
;
1141 // Receive the response body.
1146 // First check whether we cached some data.
1148 if (HttpInstance
->CacheBody
!= NULL
) {
1150 // Calculate the length of the cached data.
1152 if (HttpInstance
->NextMsg
!= NULL
) {
1154 // We have a cached HTTP message which includes a part of HTTP header of next message.
1156 BodyLen
= HttpInstance
->NextMsg
- (HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
);
1158 BodyLen
= HttpInstance
->CacheLen
- HttpInstance
->CacheOffset
;
1163 // We have some cached data. Just copy the data and return.
1165 if (HttpMsg
->BodyLength
< BodyLen
) {
1166 CopyMem (HttpMsg
->Body
, HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
, HttpMsg
->BodyLength
);
1167 HttpInstance
->CacheOffset
= HttpInstance
->CacheOffset
+ HttpMsg
->BodyLength
;
1170 // Copy all cached data out.
1172 CopyMem (HttpMsg
->Body
, HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
, BodyLen
);
1173 HttpInstance
->CacheOffset
= BodyLen
+ HttpInstance
->CacheOffset
;
1174 HttpMsg
->BodyLength
= BodyLen
;
1176 if (HttpInstance
->NextMsg
== NULL
) {
1178 // There is no HTTP header of next message. Just free the cache buffer.
1180 FreePool (HttpInstance
->CacheBody
);
1181 HttpInstance
->CacheBody
= NULL
;
1182 HttpInstance
->NextMsg
= NULL
;
1183 HttpInstance
->CacheOffset
= 0;
1187 // Return since we aready received required data.
1189 Status
= EFI_SUCCESS
;
1193 if (BodyLen
== 0 && HttpInstance
->MsgParser
== NULL
) {
1195 // We received a complete HTTP message, and we don't have more data to return to caller.
1197 HttpMsg
->BodyLength
= 0;
1198 Status
= EFI_SUCCESS
;
1203 ASSERT (HttpInstance
->MsgParser
!= NULL
);
1205 if (HttpInstance
->TimeoutEvent
== NULL
) {
1207 // Create TimeoutEvent for response
1209 Status
= gBS
->CreateEvent (
1214 &HttpInstance
->TimeoutEvent
1216 if (EFI_ERROR (Status
)) {
1222 // Start the timer, and wait Timeout seconds to receive the body packet.
1224 Status
= gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerRelative
, HTTP_RESPONSE_TIMEOUT
* TICKS_PER_SECOND
);
1225 if (EFI_ERROR (Status
)) {
1230 // We still need receive more data when there is no cache data and MsgParser is not NULL;
1232 Status
= HttpTcpReceiveBody (Wrap
, HttpMsg
, HttpInstance
->TimeoutEvent
);
1234 gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerCancel
, 0);
1236 if (EFI_ERROR (Status
)) {
1243 Item
= NetMapFindKey (&Wrap
->HttpInstance
->RxTokens
, Wrap
->HttpToken
);
1245 NetMapRemoveItem (&Wrap
->HttpInstance
->RxTokens
, Item
, NULL
);
1248 if (HttpInstance
->StatusCode
>= HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE
) {
1249 Token
->Status
= EFI_HTTP_ERROR
;
1251 Token
->Status
= Status
;
1254 gBS
->SignalEvent (Token
->Event
);
1255 HttpCloseTcpRxEvent (Wrap
);
1260 NetMapInsertHead (&HttpInstance
->TxTokens
, ValueInItem
->HttpToken
, ValueInItem
);
1263 HttpTcpTokenCleanup (Wrap
);
1265 if (HttpHeaders
!= NULL
) {
1266 FreePool (HttpHeaders
);
1269 if (HttpMsg
->Headers
!= NULL
) {
1270 FreePool (HttpMsg
->Headers
);
1273 if (HttpInstance
->CacheBody
!= NULL
) {
1274 FreePool (HttpInstance
->CacheBody
);
1275 HttpInstance
->CacheBody
= NULL
;
1278 if (HttpInstance
->StatusCode
>= HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE
) {
1279 Token
->Status
= EFI_HTTP_ERROR
;
1281 Token
->Status
= Status
;
1284 gBS
->SignalEvent (Token
->Event
);
1292 The Response() function queues an HTTP response to this HTTP instance, similar to
1293 Receive() function in the EFI TCP driver. When the HTTP response is received successfully,
1294 or if there is an error, Status in token will be updated and Event will be signaled.
1296 The HTTP driver will queue a receive token to the underlying TCP instance. When data
1297 is received in the underlying TCP instance, the data will be parsed and Token will
1298 be populated with the response data. If the data received from the remote host
1299 contains an incomplete or invalid HTTP header, the HTTP driver will continue waiting
1300 (asynchronously) for more data to be sent from the remote host before signaling
1303 It is the responsibility of the caller to allocate a buffer for Body and specify the
1304 size in BodyLength. If the remote host provides a response that contains a content
1305 body, up to BodyLength bytes will be copied from the receive buffer into Body and
1306 BodyLength will be updated with the amount of bytes received and copied to Body. This
1307 allows the client to download a large file in chunks instead of into one contiguous
1308 block of memory. Similar to HTTP request, if Body is not NULL and BodyLength is
1309 non-zero and all other fields are NULL or 0, the HTTP driver will queue a receive
1310 token to underlying TCP instance. If data arrives in the receive buffer, up to
1311 BodyLength bytes of data will be copied to Body. The HTTP driver will then update
1312 BodyLength with the amount of bytes received and copied to Body.
1314 If the HTTP driver does not have an open underlying TCP connection with the host
1315 specified in the response URL, Request() will return EFI_ACCESS_DENIED. This is
1316 consistent with RFC 2616 recommendation that HTTP clients should attempt to maintain
1317 an open TCP connection between client and host.
1319 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
1320 @param[in] Token Pointer to storage containing HTTP response token.
1322 @retval EFI_SUCCESS Allocation succeeded.
1323 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been
1325 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1328 Token->Message->Headers is NULL.
1329 Token->Message is NULL.
1330 Token->Message->Body is not NULL,
1331 Token->Message->BodyLength is non-zero, and
1332 Token->Message->Data is NULL, but a previous call to
1333 Response() has not been completed successfully.
1334 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
1335 @retval EFI_ACCESS_DENIED An open TCP connection is not present with the host
1336 specified by response URL.
1341 IN EFI_HTTP_PROTOCOL
*This
,
1342 IN EFI_HTTP_TOKEN
*Token
1346 EFI_HTTP_MESSAGE
*HttpMsg
;
1347 HTTP_PROTOCOL
*HttpInstance
;
1348 HTTP_TOKEN_WRAP
*Wrap
;
1350 if ((This
== NULL
) || (Token
== NULL
)) {
1351 return EFI_INVALID_PARAMETER
;
1354 HttpMsg
= Token
->Message
;
1355 if (HttpMsg
== NULL
) {
1356 return EFI_INVALID_PARAMETER
;
1359 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
1360 ASSERT (HttpInstance
!= NULL
);
1362 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
1363 return EFI_NOT_STARTED
;
1367 // Check whether the token already existed.
1369 if (EFI_ERROR (NetMapIterate (&HttpInstance
->RxTokens
, HttpTokenExist
, Token
))) {
1370 return EFI_ACCESS_DENIED
;
1373 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
1375 return EFI_OUT_OF_RESOURCES
;
1378 Wrap
->HttpInstance
= HttpInstance
;
1379 Wrap
->HttpToken
= Token
;
1381 Status
= HttpCreateTcpRxEvent (Wrap
);
1382 if (EFI_ERROR (Status
)) {
1386 Status
= NetMapInsertTail (&HttpInstance
->RxTokens
, Token
, Wrap
);
1387 if (EFI_ERROR (Status
)) {
1392 // If already have pending RxTokens, return directly.
1394 if (NetMapGetCount (&HttpInstance
->RxTokens
) > 1) {
1398 return HttpResponseWorker (Wrap
);
1402 if (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
!= NULL
) {
1403 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
);
1406 if (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
!= NULL
) {
1407 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
);
1416 The Poll() function can be used by network drivers and applications to increase the
1417 rate that data packets are moved between the communication devices and the transmit
1420 In some systems, the periodic timer event in the managed network driver may not poll
1421 the underlying communications device fast enough to transmit and/or receive all data
1422 packets without missing incoming packets or dropping outgoing packets. Drivers and
1423 applications that are experiencing packet loss should try calling the Poll() function
1426 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
1428 @retval EFI_SUCCESS Incoming or outgoing data was processed.
1429 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1430 @retval EFI_INVALID_PARAMETER This is NULL.
1431 @retval EFI_NOT_READY No incoming or outgoing data is processed.
1432 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
1438 IN EFI_HTTP_PROTOCOL
*This
1442 HTTP_PROTOCOL
*HttpInstance
;
1445 return EFI_INVALID_PARAMETER
;
1448 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
1449 ASSERT (HttpInstance
!= NULL
);
1451 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
1452 return EFI_NOT_STARTED
;
1455 if (HttpInstance
->LocalAddressIsIPv6
) {
1456 if (HttpInstance
->Tcp6
== NULL
) {
1457 return EFI_NOT_STARTED
;
1459 Status
= HttpInstance
->Tcp6
->Poll (HttpInstance
->Tcp6
);
1461 if (HttpInstance
->Tcp4
== NULL
) {
1462 return EFI_NOT_STARTED
;
1464 Status
= HttpInstance
->Tcp4
->Poll (HttpInstance
->Tcp4
);