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->LocalAddressIsIPv6 is FALSE and
118 HttpConfigData->IPv4Node is NULL.
119 HttpConfigData->LocalAddressIsIPv6 is TRUE and
120 HttpConfigData->IPv6Node is NULL.
121 @retval EFI_ALREADY_STARTED Reinitialize this HTTP instance without calling
122 Configure() with NULL to reset it.
123 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
124 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources when
125 executing Configure().
126 @retval EFI_UNSUPPORTED One or more options in HttpConfigData are not supported
127 in the implementation.
132 IN EFI_HTTP_PROTOCOL
*This
,
133 IN EFI_HTTP_CONFIG_DATA
*HttpConfigData
136 HTTP_PROTOCOL
*HttpInstance
;
140 // Check input parameters.
143 (HttpConfigData
!= NULL
&&
144 ((HttpConfigData
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv6Node
== NULL
) ||
145 (!HttpConfigData
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv4Node
== NULL
)))) {
146 return EFI_INVALID_PARAMETER
;
149 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
150 ASSERT (HttpInstance
!= NULL
&& HttpInstance
->Service
!= NULL
);
152 if (HttpConfigData
!= NULL
) {
155 // Now configure this HTTP instance.
157 if (HttpInstance
->State
!= HTTP_STATE_UNCONFIGED
) {
158 return EFI_ALREADY_STARTED
;
161 HttpInstance
->HttpVersion
= HttpConfigData
->HttpVersion
;
162 HttpInstance
->TimeOutMillisec
= HttpConfigData
->TimeOutMillisec
;
163 HttpInstance
->LocalAddressIsIPv6
= HttpConfigData
->LocalAddressIsIPv6
;
165 if (HttpConfigData
->LocalAddressIsIPv6
) {
167 &HttpInstance
->Ipv6Node
,
168 HttpConfigData
->AccessPoint
.IPv6Node
,
169 sizeof (HttpInstance
->Ipv6Node
)
173 &HttpInstance
->IPv4Node
,
174 HttpConfigData
->AccessPoint
.IPv4Node
,
175 sizeof (HttpInstance
->IPv4Node
)
182 Status
= HttpInitProtocol (HttpInstance
, HttpInstance
->LocalAddressIsIPv6
);
183 if (EFI_ERROR (Status
)) {
187 HttpInstance
->State
= HTTP_STATE_HTTP_CONFIGED
;
192 // Reset all the resources related to HttpInsance.
194 HttpCleanProtocol (HttpInstance
);
195 HttpInstance
->State
= HTTP_STATE_UNCONFIGED
;
202 The Request() function queues an HTTP request to this HTTP instance.
204 Similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent
205 successfully, or if there is an error, Status in token will be updated and Event will
208 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
209 @param[in] Token Pointer to storage containing HTTP request token.
211 @retval EFI_SUCCESS Outgoing data was processed.
212 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
213 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
214 @retval EFI_TIMEOUT Data was dropped out of the transmit or receive queue.
215 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
216 @retval EFI_UNSUPPORTED The HTTP method is not supported in current
218 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
221 Token->Message is NULL.
222 Token->Message->Body is not NULL,
223 Token->Message->BodyLength is non-zero, and
224 Token->Message->Data is NULL, but a previous call to
225 Request()has not been completed successfully.
230 IN EFI_HTTP_PROTOCOL
*This
,
231 IN EFI_HTTP_TOKEN
*Token
234 EFI_HTTP_MESSAGE
*HttpMsg
;
235 EFI_HTTP_REQUEST_DATA
*Request
;
240 HTTP_PROTOCOL
*HttpInstance
;
247 HTTP_TOKEN_WRAP
*Wrap
;
249 UINTN RequestMsgSize
;
263 if ((This
== NULL
) || (Token
== NULL
)) {
264 return EFI_INVALID_PARAMETER
;
267 HttpMsg
= Token
->Message
;
268 if (HttpMsg
== NULL
) {
269 return EFI_INVALID_PARAMETER
;
272 Request
= HttpMsg
->Data
.Request
;
275 // Only support GET, HEAD, PUT and POST method in current implementation.
277 if ((Request
!= NULL
) && (Request
->Method
!= HttpMethodGet
) &&
278 (Request
->Method
!= HttpMethodHead
) && (Request
->Method
!= HttpMethodPut
) && (Request
->Method
!= HttpMethodPost
)) {
279 return EFI_UNSUPPORTED
;
282 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
283 ASSERT (HttpInstance
!= NULL
);
286 // Capture the method into HttpInstance.
288 if (Request
!= NULL
) {
289 HttpInstance
->Method
= Request
->Method
;
292 if (HttpInstance
->State
< HTTP_STATE_HTTP_CONFIGED
) {
293 return EFI_NOT_STARTED
;
296 if (Request
== NULL
) {
298 // Request would be NULL only for PUT/POST operation (in the current implementation)
300 if ((HttpInstance
->Method
!= HttpMethodPut
) && (HttpInstance
->Method
!= HttpMethodPost
)) {
301 return EFI_INVALID_PARAMETER
;
305 // For PUT/POST, we need to have the TCP already configured. Bail out if it is not!
307 if (HttpInstance
->State
< HTTP_STATE_TCP_CONFIGED
) {
308 return EFI_INVALID_PARAMETER
;
312 // We need to have the Message Body for sending the HTTP message across in these cases.
314 if (HttpMsg
->Body
== NULL
|| HttpMsg
->BodyLength
== 0) {
315 return EFI_INVALID_PARAMETER
;
319 // Use existing TCP instance to transmit the packet.
325 // Check whether the token already existed.
327 if (EFI_ERROR (NetMapIterate (&HttpInstance
->TxTokens
, HttpTokenExist
, Token
))) {
328 return EFI_ACCESS_DENIED
;
332 // Parse the URI of the remote host.
334 Url
= HttpInstance
->Url
;
335 UrlLen
= StrLen (Request
->Url
) + 1;
336 if (UrlLen
> HTTP_URL_BUFFER_LEN
) {
337 Url
= AllocateZeroPool (UrlLen
);
339 return EFI_OUT_OF_RESOURCES
;
341 FreePool (HttpInstance
->Url
);
342 HttpInstance
->Url
= Url
;
346 UnicodeStrToAsciiStr (Request
->Url
, Url
);
348 Status
= HttpParseUrl (Url
, (UINT32
) AsciiStrLen (Url
), FALSE
, &UrlParser
);
349 if (EFI_ERROR (Status
)) {
354 Status
= HttpUrlGetHostName (Url
, UrlParser
, &HostName
);
355 if (EFI_ERROR (Status
)) {
359 Status
= HttpUrlGetPort (Url
, UrlParser
, &RemotePort
);
360 if (EFI_ERROR (Status
)) {
361 RemotePort
= HTTP_DEFAULT_PORT
;
364 // If Configure is TRUE, it indicates the first time to call Request();
365 // If ReConfigure is TRUE, it indicates the request URL is not same
366 // with the previous call to Request();
371 if (HttpInstance
->RemoteHost
== NULL
) {
373 // Request() is called the first time.
377 if ((HttpInstance
->RemotePort
== RemotePort
) &&
378 (AsciiStrCmp (HttpInstance
->RemoteHost
, HostName
) == 0)) {
380 // Host Name and port number of the request URL are the same with previous call to Request().
381 // Check whether previous TCP packet sent out.
384 if (EFI_ERROR (NetMapIterate (&HttpInstance
->TxTokens
, HttpTcpNotReady
, NULL
))) {
386 // Wrap the HTTP token in HTTP_TOKEN_WRAP
388 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
390 Status
= EFI_OUT_OF_RESOURCES
;
394 Wrap
->HttpToken
= Token
;
395 Wrap
->HttpInstance
= HttpInstance
;
397 Status
= HttpCreateTcpTxEvent (Wrap
);
398 if (EFI_ERROR (Status
)) {
402 Status
= NetMapInsertTail (&HttpInstance
->TxTokens
, Token
, Wrap
);
403 if (EFI_ERROR (Status
)) {
407 Wrap
->TcpWrap
.Method
= Request
->Method
;
412 // Queue the HTTP token and return.
417 // Use existing TCP instance to transmit the packet.
424 // Need close existing TCP instance and create a new TCP instance for data transmit.
426 if (HttpInstance
->RemoteHost
!= NULL
) {
427 FreePool (HttpInstance
->RemoteHost
);
428 HttpInstance
->RemoteHost
= NULL
;
429 HttpInstance
->RemotePort
= 0;
437 // Parse Url for IPv4 or IPv6 address, if failed, perform DNS resolution.
439 if (!HttpInstance
->LocalAddressIsIPv6
) {
440 Status
= NetLibAsciiStrToIp4 (HostName
, &HttpInstance
->RemoteAddr
);
442 Status
= HttpUrlGetIp6 (Url
, UrlParser
, &HttpInstance
->RemoteIpv6Addr
);
445 if (EFI_ERROR (Status
)) {
446 HostNameStr
= AllocateZeroPool ((AsciiStrLen (HostName
) + 1) * sizeof (CHAR16
));
447 if (HostNameStr
== NULL
) {
448 Status
= EFI_OUT_OF_RESOURCES
;
452 AsciiStrToUnicodeStr (HostName
, HostNameStr
);
453 if (!HttpInstance
->LocalAddressIsIPv6
) {
454 Status
= HttpDns4 (HttpInstance
, HostNameStr
, &HttpInstance
->RemoteAddr
);
456 Status
= HttpDns6 (HttpInstance
, HostNameStr
, &HttpInstance
->RemoteIpv6Addr
);
459 FreePool (HostNameStr
);
460 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
;
608 if (HostName
!= NULL
) {
614 if (UrlParser
!= NULL
) {
615 HttpUrlFreeParser (UrlParser
);
623 Cancel a user's Token.
625 @param[in] Map The HTTP instance's token queue.
626 @param[in] Item Object container for one HTTP token and token's wrap.
627 @param[in] Context The user's token to cancel.
629 @retval EFI_SUCCESS Continue to check the next Item.
630 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.
637 IN NET_MAP_ITEM
*Item
,
641 EFI_HTTP_TOKEN
*Token
;
642 HTTP_TOKEN_WRAP
*Wrap
;
643 HTTP_PROTOCOL
*HttpInstance
;
645 Token
= (EFI_HTTP_TOKEN
*) Context
;
648 // Return EFI_SUCCESS to check the next item in the map if
649 // this one doesn't match.
651 if ((Token
!= NULL
) && (Token
!= Item
->Key
)) {
655 Wrap
= (HTTP_TOKEN_WRAP
*) Item
->Value
;
656 ASSERT (Wrap
!= NULL
);
657 HttpInstance
= Wrap
->HttpInstance
;
659 if (!HttpInstance
->LocalAddressIsIPv6
) {
660 if (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
!= NULL
) {
662 // Cancle the Token before close its Event.
664 HttpInstance
->Tcp4
->Cancel (HttpInstance
->Tcp4
, &Wrap
->TcpWrap
.Rx4Token
.CompletionToken
);
667 // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.
672 if (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
!= NULL
) {
674 // Cancle the Token before close its Event.
676 HttpInstance
->Tcp6
->Cancel (HttpInstance
->Tcp6
, &Wrap
->TcpWrap
.Rx6Token
.CompletionToken
);
679 // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.
686 // If only one item is to be cancel, return EFI_ABORTED to stop
687 // iterating the map any more.
697 Cancel the user's receive/transmit request. It is the worker function of
698 EfiHttpCancel API. If a matching token is found, it will call HttpCancelTokens to cancel the
701 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
702 @param[in] Token The token to cancel. If NULL, all token will be
705 @retval EFI_SUCCESS The token is cancelled.
706 @retval EFI_NOT_FOUND The asynchronous request or response token is not found.
707 @retval Others Other error as indicated.
712 IN HTTP_PROTOCOL
*HttpInstance
,
713 IN EFI_HTTP_TOKEN
*Token
719 // First check the tokens queued by EfiHttpRequest().
721 Status
= NetMapIterate (&HttpInstance
->TxTokens
, HttpCancelTokens
, Token
);
722 if (EFI_ERROR (Status
)) {
724 if (Status
== EFI_ABORTED
) {
733 // Then check the tokens queued by EfiHttpResponse().
735 Status
= NetMapIterate (&HttpInstance
->RxTokens
, HttpCancelTokens
, Token
);
736 if (EFI_ERROR (Status
)) {
738 if (Status
== EFI_ABORTED
) {
741 return EFI_NOT_FOUND
;
753 Abort an asynchronous HTTP request or response token.
755 The Cancel() function aborts a pending HTTP request or response transaction. If
756 Token is not NULL and the token is in transmit or receive queues when it is being
757 cancelled, its Token->Status will be set to EFI_ABORTED and then Token->Event will
758 be signaled. If the token is not in one of the queues, which usually means that the
759 asynchronous operation has completed, EFI_NOT_FOUND is returned. If Token is NULL,
760 all asynchronous tokens issued by Request() or Response() will be aborted.
762 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
763 @param[in] Token Point to storage containing HTTP request or response
766 @retval EFI_SUCCESS Request and Response queues are successfully flushed.
767 @retval EFI_INVALID_PARAMETER This is NULL.
768 @retval EFI_NOT_STARTED This instance hasn't been configured.
769 @retval EFI_NOT_FOUND The asynchronous request or response token is not
771 @retval EFI_UNSUPPORTED The implementation does not support this function.
777 IN EFI_HTTP_PROTOCOL
*This
,
778 IN EFI_HTTP_TOKEN
*Token
781 HTTP_PROTOCOL
*HttpInstance
;
784 return EFI_INVALID_PARAMETER
;
787 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
788 ASSERT (HttpInstance
!= NULL
);
790 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
791 return EFI_NOT_STARTED
;
794 return HttpCancel (HttpInstance
, Token
);
799 A callback function to intercept events during message parser.
801 This function will be invoked during HttpParseMessageBody() with various events type. An error
802 return status of the callback function will cause the HttpParseMessageBody() aborted.
804 @param[in] EventType Event type of this callback call.
805 @param[in] Data A pointer to data buffer.
806 @param[in] Length Length in bytes of the Data.
807 @param[in] Context Callback context set by HttpInitMsgParser().
809 @retval EFI_SUCCESS Continue to parser the message body.
814 HttpBodyParserCallback (
815 IN HTTP_BODY_PARSE_EVENT EventType
,
821 HTTP_TOKEN_WRAP
*Wrap
;
825 if (EventType
!= BodyParseEventOnComplete
) {
829 if (Data
== NULL
|| Length
!= 0 || Context
== NULL
) {
833 Wrap
= (HTTP_TOKEN_WRAP
*) Context
;
834 Body
= Wrap
->HttpToken
->Message
->Body
;
835 BodyLength
= Wrap
->HttpToken
->Message
->BodyLength
;
836 if (Data
< Body
+ BodyLength
) {
837 Wrap
->HttpInstance
->NextMsg
= Data
;
839 Wrap
->HttpInstance
->NextMsg
= NULL
;
844 // Free Tx4Token or Tx6Token since already received corrsponding HTTP response.
852 The work function of EfiHttpResponse().
854 @param[in] Wrap Pointer to HTTP token's wrap data.
856 @retval EFI_SUCCESS Allocation succeeded.
857 @retval EFI_OUT_OF_RESOURCES Failed to complete the opration due to lack of resources.
858 @retval EFI_NOT_READY Can't find a corresponding Tx4Token/Tx6Token or
859 the EFI_HTTP_UTILITIES_PROTOCOL is not available.
864 IN HTTP_TOKEN_WRAP
*Wrap
868 EFI_HTTP_MESSAGE
*HttpMsg
;
876 CHAR8
*StatusCodeStr
;
878 HTTP_PROTOCOL
*HttpInstance
;
879 EFI_HTTP_TOKEN
*Token
;
881 HTTP_TOKEN_WRAP
*ValueInItem
;
884 if (Wrap
== NULL
|| Wrap
->HttpInstance
== NULL
) {
885 return EFI_INVALID_PARAMETER
;
888 HttpInstance
= Wrap
->HttpInstance
;
889 Token
= Wrap
->HttpToken
;
890 HttpMsg
= Token
->Message
;
892 HttpInstance
->EndofHeader
= NULL
;
893 HttpInstance
->HttpHeaders
= NULL
;
894 HttpMsg
->Headers
= NULL
;
901 if (HttpMsg
->Data
.Response
!= NULL
) {
903 // Need receive the HTTP headers, prepare buffer.
905 Status
= HttpCreateTcpRxEventForHeader (HttpInstance
);
906 if (EFI_ERROR (Status
)) {
911 // Check whether we have cached header from previous call.
913 if ((HttpInstance
->CacheBody
!= NULL
) && (HttpInstance
->NextMsg
!= NULL
)) {
915 // The data is stored at [NextMsg, CacheBody + CacheLen].
917 HdrLen
= HttpInstance
->CacheBody
+ HttpInstance
->CacheLen
- HttpInstance
->NextMsg
;
918 HttpHeaders
= AllocateZeroPool (HdrLen
);
919 if (HttpHeaders
== NULL
) {
920 Status
= EFI_OUT_OF_RESOURCES
;
924 CopyMem (HttpHeaders
, HttpInstance
->NextMsg
, HdrLen
);
925 FreePool (HttpInstance
->CacheBody
);
926 HttpInstance
->CacheBody
= NULL
;
927 HttpInstance
->NextMsg
= NULL
;
928 HttpInstance
->CacheOffset
= 0;
929 SizeofHeaders
= HdrLen
;
930 BufferSize
= HttpInstance
->CacheLen
;
933 // Check whether we cached the whole HTTP headers.
935 EndofHeader
= AsciiStrStr (HttpHeaders
, HTTP_END_OF_HDR_STR
);
938 HttpInstance
->EndofHeader
= &EndofHeader
;
939 HttpInstance
->HttpHeaders
= &HttpHeaders
;
942 if (HttpInstance
->TimeoutEvent
== NULL
) {
944 // Create TimeoutEvent for response
946 Status
= gBS
->CreateEvent (
951 &HttpInstance
->TimeoutEvent
953 if (EFI_ERROR (Status
)) {
959 // Start the timer, and wait Timeout seconds to receive the header packet.
961 Status
= gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerRelative
, HTTP_RESPONSE_TIMEOUT
* TICKS_PER_SECOND
);
962 if (EFI_ERROR (Status
)) {
966 Status
= HttpTcpReceiveHeader (HttpInstance
, &SizeofHeaders
, &BufferSize
, HttpInstance
->TimeoutEvent
);
968 gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerCancel
, 0);
970 if (EFI_ERROR (Status
)) {
974 ASSERT (HttpHeaders
!= NULL
);
977 // Cache the part of body.
979 BodyLen
= BufferSize
- (EndofHeader
- HttpHeaders
);
981 if (HttpInstance
->CacheBody
!= NULL
) {
982 FreePool (HttpInstance
->CacheBody
);
985 HttpInstance
->CacheBody
= AllocateZeroPool (BodyLen
);
986 if (HttpInstance
->CacheBody
== NULL
) {
987 Status
= EFI_OUT_OF_RESOURCES
;
991 CopyMem (HttpInstance
->CacheBody
, EndofHeader
, BodyLen
);
992 HttpInstance
->CacheLen
= BodyLen
;
996 // Search for Status Code.
998 StatusCodeStr
= HttpHeaders
+ AsciiStrLen (HTTP_VERSION_STR
) + 1;
999 if (StatusCodeStr
== NULL
) {
1000 Status
= EFI_NOT_READY
;
1004 StatusCode
= AsciiStrDecimalToUintn (StatusCodeStr
);
1007 // Remove the first line of HTTP message, e.g. "HTTP/1.1 200 OK\r\n".
1009 Tmp
= AsciiStrStr (HttpHeaders
, HTTP_CRLF_STR
);
1011 Status
= EFI_NOT_READY
;
1016 // We could have response with just a HTTP message and no headers. For Example,
1017 // "100 Continue". In such cases, we would not want to unnecessarily call a Parse
1018 // method. A "\r\n" following Tmp string again would indicate an end. Compare and
1019 // set SizeofHeaders to 0.
1021 Tmp
= Tmp
+ AsciiStrLen (HTTP_CRLF_STR
);
1022 if (CompareMem (Tmp
, HTTP_CRLF_STR
, AsciiStrLen (HTTP_CRLF_STR
)) == 0) {
1025 SizeofHeaders
= SizeofHeaders
- (Tmp
- HttpHeaders
);
1028 HttpMsg
->Data
.Response
->StatusCode
= HttpMappingToStatusCode (StatusCode
);
1029 HttpInstance
->StatusCode
= StatusCode
;
1031 Status
= EFI_NOT_READY
;
1035 // In cases of PUT/POST, after an initial request-response pair, we would do a
1036 // continuous request without a response call. So, we would not do an insert of
1037 // TxToken. After we have sent the complete file, we will call a response to get
1038 // a final response from server. In such a case, we would not have any TxTokens.
1039 // Hence, check that case before doing a NetMapRemoveHead.
1041 if (!NetMapIsEmpty (&HttpInstance
->TxTokens
)) {
1042 NetMapRemoveHead (&HttpInstance
->TxTokens
, (VOID
**) &ValueInItem
);
1043 if (ValueInItem
== NULL
) {
1048 // The first Tx Token not transmitted yet, insert back and return error.
1050 if (!ValueInItem
->TcpWrap
.IsTxDone
) {
1055 if (SizeofHeaders
!= 0) {
1056 HeaderTmp
= AllocateZeroPool (SizeofHeaders
);
1057 if (HeaderTmp
== NULL
) {
1058 Status
= EFI_OUT_OF_RESOURCES
;
1062 CopyMem (HeaderTmp
, Tmp
, SizeofHeaders
);
1063 FreePool (HttpHeaders
);
1064 HttpHeaders
= HeaderTmp
;
1067 // Check whether the EFI_HTTP_UTILITIES_PROTOCOL is available.
1069 if (mHttpUtilities
== NULL
) {
1070 Status
= EFI_NOT_READY
;
1075 // Parse the HTTP header into array of key/value pairs.
1077 Status
= mHttpUtilities
->Parse (
1082 &HttpMsg
->HeaderCount
1084 if (EFI_ERROR (Status
)) {
1088 FreePool (HttpHeaders
);
1093 // Init message-body parser by header information.
1095 Status
= HttpInitMsgParser (
1096 HttpInstance
->Method
,
1097 HttpMsg
->Data
.Response
->StatusCode
,
1098 HttpMsg
->HeaderCount
,
1100 HttpBodyParserCallback
,
1101 (VOID
*) ValueInItem
,
1102 &HttpInstance
->MsgParser
1104 if (EFI_ERROR (Status
)) {
1109 // Check whether we received a complete HTTP message.
1111 if (HttpInstance
->CacheBody
!= NULL
) {
1112 Status
= HttpParseMessageBody (HttpInstance
->MsgParser
, HttpInstance
->CacheLen
, HttpInstance
->CacheBody
);
1113 if (EFI_ERROR (Status
)) {
1117 if (HttpIsMessageComplete (HttpInstance
->MsgParser
)) {
1119 // Free the MsgParse since we already have a full HTTP message.
1121 HttpFreeMsgParser (HttpInstance
->MsgParser
);
1122 HttpInstance
->MsgParser
= NULL
;
1127 if ((HttpMsg
->Body
== NULL
) || (HttpMsg
->BodyLength
== 0)) {
1128 Status
= EFI_SUCCESS
;
1134 // Receive the response body.
1139 // First check whether we cached some data.
1141 if (HttpInstance
->CacheBody
!= NULL
) {
1143 // Calculate the length of the cached data.
1145 if (HttpInstance
->NextMsg
!= NULL
) {
1147 // We have a cached HTTP message which includes a part of HTTP header of next message.
1149 BodyLen
= HttpInstance
->NextMsg
- (HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
);
1151 BodyLen
= HttpInstance
->CacheLen
- HttpInstance
->CacheOffset
;
1156 // We have some cached data. Just copy the data and return.
1158 if (HttpMsg
->BodyLength
< BodyLen
) {
1159 CopyMem (HttpMsg
->Body
, HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
, HttpMsg
->BodyLength
);
1160 HttpInstance
->CacheOffset
= HttpInstance
->CacheOffset
+ HttpMsg
->BodyLength
;
1163 // Copy all cached data out.
1165 CopyMem (HttpMsg
->Body
, HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
, BodyLen
);
1166 HttpInstance
->CacheOffset
= BodyLen
+ HttpInstance
->CacheOffset
;
1167 HttpMsg
->BodyLength
= BodyLen
;
1169 if (HttpInstance
->NextMsg
== NULL
) {
1171 // There is no HTTP header of next message. Just free the cache buffer.
1173 FreePool (HttpInstance
->CacheBody
);
1174 HttpInstance
->CacheBody
= NULL
;
1175 HttpInstance
->NextMsg
= NULL
;
1176 HttpInstance
->CacheOffset
= 0;
1180 // Return since we aready received required data.
1182 Status
= EFI_SUCCESS
;
1186 if (BodyLen
== 0 && HttpInstance
->MsgParser
== NULL
) {
1188 // We received a complete HTTP message, and we don't have more data to return to caller.
1190 HttpMsg
->BodyLength
= 0;
1191 Status
= EFI_SUCCESS
;
1196 ASSERT (HttpInstance
->MsgParser
!= NULL
);
1199 // We still need receive more data when there is no cache data and MsgParser is not NULL;
1201 Status
= HttpTcpReceiveBody (Wrap
, HttpMsg
);
1202 if (EFI_ERROR (Status
)) {
1209 Item
= NetMapFindKey (&Wrap
->HttpInstance
->RxTokens
, Wrap
->HttpToken
);
1211 NetMapRemoveItem (&Wrap
->HttpInstance
->RxTokens
, Item
, NULL
);
1214 if (HttpInstance
->StatusCode
>= HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE
) {
1215 Token
->Status
= EFI_HTTP_ERROR
;
1217 Token
->Status
= Status
;
1220 gBS
->SignalEvent (Token
->Event
);
1221 HttpCloseTcpRxEvent (Wrap
);
1226 if (ValueInItem
!= NULL
) {
1227 NetMapInsertHead (&HttpInstance
->TxTokens
, ValueInItem
->HttpToken
, ValueInItem
);
1231 Item
= NetMapFindKey (&Wrap
->HttpInstance
->RxTokens
, Wrap
->HttpToken
);
1233 NetMapRemoveItem (&Wrap
->HttpInstance
->RxTokens
, Item
, NULL
);
1236 HttpTcpTokenCleanup (Wrap
);
1238 if (HttpHeaders
!= NULL
) {
1239 FreePool (HttpHeaders
);
1242 if (HttpMsg
->Headers
!= NULL
) {
1243 FreePool (HttpMsg
->Headers
);
1246 if (HttpInstance
->CacheBody
!= NULL
) {
1247 FreePool (HttpInstance
->CacheBody
);
1248 HttpInstance
->CacheBody
= NULL
;
1251 if (HttpInstance
->StatusCode
>= HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE
) {
1252 Token
->Status
= EFI_HTTP_ERROR
;
1254 Token
->Status
= Status
;
1257 gBS
->SignalEvent (Token
->Event
);
1265 The Response() function queues an HTTP response to this HTTP instance, similar to
1266 Receive() function in the EFI TCP driver. When the HTTP response is received successfully,
1267 or if there is an error, Status in token will be updated and Event will be signaled.
1269 The HTTP driver will queue a receive token to the underlying TCP instance. When data
1270 is received in the underlying TCP instance, the data will be parsed and Token will
1271 be populated with the response data. If the data received from the remote host
1272 contains an incomplete or invalid HTTP header, the HTTP driver will continue waiting
1273 (asynchronously) for more data to be sent from the remote host before signaling
1276 It is the responsibility of the caller to allocate a buffer for Body and specify the
1277 size in BodyLength. If the remote host provides a response that contains a content
1278 body, up to BodyLength bytes will be copied from the receive buffer into Body and
1279 BodyLength will be updated with the amount of bytes received and copied to Body. This
1280 allows the client to download a large file in chunks instead of into one contiguous
1281 block of memory. Similar to HTTP request, if Body is not NULL and BodyLength is
1282 non-zero and all other fields are NULL or 0, the HTTP driver will queue a receive
1283 token to underlying TCP instance. If data arrives in the receive buffer, up to
1284 BodyLength bytes of data will be copied to Body. The HTTP driver will then update
1285 BodyLength with the amount of bytes received and copied to Body.
1287 If the HTTP driver does not have an open underlying TCP connection with the host
1288 specified in the response URL, Request() will return EFI_ACCESS_DENIED. This is
1289 consistent with RFC 2616 recommendation that HTTP clients should attempt to maintain
1290 an open TCP connection between client and host.
1292 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
1293 @param[in] Token Pointer to storage containing HTTP response token.
1295 @retval EFI_SUCCESS Allocation succeeded.
1296 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been
1298 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1301 Token->Message->Headers is NULL.
1302 Token->Message is NULL.
1303 Token->Message->Body is not NULL,
1304 Token->Message->BodyLength is non-zero, and
1305 Token->Message->Data is NULL, but a previous call to
1306 Response() has not been completed successfully.
1307 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
1308 @retval EFI_ACCESS_DENIED An open TCP connection is not present with the host
1309 specified by response URL.
1314 IN EFI_HTTP_PROTOCOL
*This
,
1315 IN EFI_HTTP_TOKEN
*Token
1319 EFI_HTTP_MESSAGE
*HttpMsg
;
1320 HTTP_PROTOCOL
*HttpInstance
;
1321 HTTP_TOKEN_WRAP
*Wrap
;
1323 if ((This
== NULL
) || (Token
== NULL
)) {
1324 return EFI_INVALID_PARAMETER
;
1327 HttpMsg
= Token
->Message
;
1328 if (HttpMsg
== NULL
) {
1329 return EFI_INVALID_PARAMETER
;
1332 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
1333 ASSERT (HttpInstance
!= NULL
);
1335 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
1336 return EFI_NOT_STARTED
;
1340 // Check whether the token already existed.
1342 if (EFI_ERROR (NetMapIterate (&HttpInstance
->RxTokens
, HttpTokenExist
, Token
))) {
1343 return EFI_ACCESS_DENIED
;
1346 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
1348 return EFI_OUT_OF_RESOURCES
;
1351 Wrap
->HttpInstance
= HttpInstance
;
1352 Wrap
->HttpToken
= Token
;
1354 Status
= HttpCreateTcpRxEvent (Wrap
);
1355 if (EFI_ERROR (Status
)) {
1359 Status
= NetMapInsertTail (&HttpInstance
->RxTokens
, Token
, Wrap
);
1360 if (EFI_ERROR (Status
)) {
1365 // If already have pending RxTokens, return directly.
1367 if (NetMapGetCount (&HttpInstance
->RxTokens
) > 1) {
1371 return HttpResponseWorker (Wrap
);
1375 if (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
!= NULL
) {
1376 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
);
1379 if (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
!= NULL
) {
1380 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
);
1389 The Poll() function can be used by network drivers and applications to increase the
1390 rate that data packets are moved between the communication devices and the transmit
1393 In some systems, the periodic timer event in the managed network driver may not poll
1394 the underlying communications device fast enough to transmit and/or receive all data
1395 packets without missing incoming packets or dropping outgoing packets. Drivers and
1396 applications that are experiencing packet loss should try calling the Poll() function
1399 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
1401 @retval EFI_SUCCESS Incoming or outgoing data was processed.
1402 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1403 @retval EFI_INVALID_PARAMETER This is NULL.
1404 @retval EFI_NOT_READY No incoming or outgoing data is processed.
1405 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
1411 IN EFI_HTTP_PROTOCOL
*This
1415 HTTP_PROTOCOL
*HttpInstance
;
1418 return EFI_INVALID_PARAMETER
;
1421 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
1422 ASSERT (HttpInstance
!= NULL
);
1424 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
1425 return EFI_NOT_STARTED
;
1428 if (HttpInstance
->LocalAddressIsIPv6
) {
1429 if (HttpInstance
->Tcp6
== NULL
) {
1430 return EFI_NOT_STARTED
;
1432 Status
= HttpInstance
->Tcp6
->Poll (HttpInstance
->Tcp6
);
1434 if (HttpInstance
->Tcp4
== NULL
) {
1435 return EFI_NOT_STARTED
;
1437 Status
= HttpInstance
->Tcp4
->Poll (HttpInstance
->Tcp4
);