2 Miscellaneous routines for HttpDxe driver.
4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "HttpDriver.h"
18 The common notify function used in HTTP driver.
20 @param[in] Event The event signaled.
21 @param[in] Context The context.
31 if ((Event
== NULL
) || (Context
== NULL
)) {
35 *((BOOLEAN
*) Context
) = TRUE
;
39 The notify function associated with TxToken for Tcp4->Transmit().
41 @param[in] Event The event signaled.
42 @param[in] Context The context.
47 HttpTcpTransmitNotify (
52 HTTP_TOKEN_WRAP
*Wrap
;
54 if ((Event
== NULL
) || (Context
== NULL
)) {
58 Wrap
= (HTTP_TOKEN_WRAP
*) Context
;
59 Wrap
->HttpToken
->Status
= Wrap
->TcpWrap
.TxToken
.CompletionToken
.Status
;
60 gBS
->SignalEvent (Wrap
->HttpToken
->Event
);
65 if (Wrap
->TcpWrap
.TxToken
.Packet
.TxData
->FragmentTable
[0].FragmentBuffer
!= NULL
) {
66 FreePool (Wrap
->TcpWrap
.TxToken
.Packet
.TxData
->FragmentTable
[0].FragmentBuffer
);
69 if (Wrap
->TcpWrap
.TxToken
.CompletionToken
.Event
!= NULL
) {
70 gBS
->CloseEvent (Wrap
->TcpWrap
.TxToken
.CompletionToken
.Event
);
73 Wrap
->TcpWrap
.IsTxDone
= TRUE
;
76 // Check pending TxTokens and sent out.
78 NetMapIterate (&Wrap
->HttpInstance
->TxTokens
, HttpTcpTransmit
, NULL
);
83 The notify function associated with RxToken for Tcp4->Receive ().
85 @param[in] Event The event signaled.
86 @param[in] Context The context.
91 HttpTcpReceiveNotify (
96 HTTP_TOKEN_WRAP
*Wrap
;
100 HTTP_PROTOCOL
*HttpInstance
;
102 if ((Event
== NULL
) || (Context
== NULL
)) {
106 Wrap
= (HTTP_TOKEN_WRAP
*) Context
;
107 if (EFI_ERROR (Wrap
->TcpWrap
.RxToken
.CompletionToken
.Status
)) {
111 HttpInstance
= Wrap
->HttpInstance
;
114 // Check whether we receive a complete HTTP message.
116 ASSERT (HttpInstance
->MsgParser
!= NULL
);
118 Length
= (UINTN
) Wrap
->TcpWrap
.RxData
.FragmentTable
[0].FragmentLength
;
119 Status
= HttpParseMessageBody (
120 HttpInstance
->MsgParser
,
122 Wrap
->HttpToken
->Message
->Body
124 if (EFI_ERROR (Status
)) {
128 if (HttpIsMessageComplete (HttpInstance
->MsgParser
)) {
130 // Free the MsgParse since we already have a full HTTP message.
132 HttpFreeMsgParser (HttpInstance
->MsgParser
);
133 HttpInstance
->MsgParser
= NULL
;
136 Wrap
->HttpToken
->Message
->BodyLength
= Length
;
137 ASSERT (HttpInstance
->CacheBody
== NULL
);
139 // We receive part of header of next HTTP msg.
141 if (HttpInstance
->NextMsg
!= NULL
) {
142 Wrap
->HttpToken
->Message
->BodyLength
= HttpInstance
->NextMsg
-
143 (CHAR8
*) Wrap
->HttpToken
->Message
->Body
;
144 HttpInstance
->CacheLen
= Length
- Wrap
->HttpToken
->Message
->BodyLength
;
145 if (HttpInstance
->CacheLen
!= 0) {
146 HttpInstance
->CacheBody
= AllocateZeroPool (HttpInstance
->CacheLen
);
147 if (HttpInstance
->CacheBody
== NULL
) {
150 CopyMem (HttpInstance
->CacheBody
, HttpInstance
->NextMsg
, HttpInstance
->CacheLen
);
151 HttpInstance
->NextMsg
= HttpInstance
->CacheBody
;
152 HttpInstance
->CacheOffset
= 0;
156 Item
= NetMapFindKey (&Wrap
->HttpInstance
->RxTokens
, Wrap
->HttpToken
);
158 NetMapRemoveItem (&Wrap
->HttpInstance
->RxTokens
, Item
, NULL
);
162 Wrap
->TcpWrap
.IsRxDone
= TRUE
;
163 Wrap
->HttpToken
->Status
= Wrap
->TcpWrap
.RxToken
.CompletionToken
.Status
;
165 gBS
->SignalEvent (Wrap
->HttpToken
->Event
);
168 // Check pending RxTokens and receive the HTTP message.
170 NetMapIterate (&Wrap
->HttpInstance
->RxTokens
, HttpTcpReceive
, NULL
);
176 Create events for the TCP4 connection token and TCP4 close token.
178 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
180 @retval EFI_SUCCESS The events are created successfully.
181 @retval others Other error as indicated.
185 HttpCreateTcp4ConnCloseEvent (
186 IN HTTP_PROTOCOL
*HttpInstance
191 // Create events for variuos asynchronous operations.
193 Status
= gBS
->CreateEvent (
197 &HttpInstance
->IsConnDone
,
198 &HttpInstance
->ConnToken
.CompletionToken
.Event
200 if (EFI_ERROR (Status
)) {
205 // Initialize CloseToken
207 Status
= gBS
->CreateEvent (
211 &HttpInstance
->IsCloseDone
,
212 &HttpInstance
->CloseToken
.CompletionToken
.Event
214 if (EFI_ERROR (Status
)) {
225 HttpCloseTcp4ConnCloseEvent (HttpInstance
);
232 Close events in the TCP4 connection token and TCP4 close token.
234 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
238 HttpCloseTcp4ConnCloseEvent (
239 IN HTTP_PROTOCOL
*HttpInstance
242 ASSERT (HttpInstance
!= NULL
);
244 if (NULL
!= HttpInstance
->ConnToken
.CompletionToken
.Event
) {
245 gBS
->CloseEvent (HttpInstance
->ConnToken
.CompletionToken
.Event
);
246 HttpInstance
->ConnToken
.CompletionToken
.Event
= NULL
;
249 if (NULL
!= HttpInstance
->CloseToken
.CompletionToken
.Event
) {
250 gBS
->CloseEvent(HttpInstance
->CloseToken
.CompletionToken
.Event
);
251 HttpInstance
->CloseToken
.CompletionToken
.Event
= NULL
;
256 Create event for the TCP4 transmit token.
258 @param[in] Wrap Point to HTTP token's wrap data.
260 @retval EFI_SUCCESS The events is created successfully.
261 @retval others Other error as indicated.
265 HttpCreateTcp4TxEvent (
266 IN HTTP_TOKEN_WRAP
*Wrap
270 HTTP_PROTOCOL
*HttpInstance
;
271 HTTP_TCP_TOKEN_WRAP
*TcpWrap
;
273 HttpInstance
= Wrap
->HttpInstance
;
274 TcpWrap
= &Wrap
->TcpWrap
;
276 Status
= gBS
->CreateEvent (
279 HttpTcpTransmitNotify
,
281 &TcpWrap
->TxToken
.CompletionToken
.Event
283 if (EFI_ERROR (Status
)) {
287 TcpWrap
->TxData
.Push
= TRUE
;
288 TcpWrap
->TxData
.Urgent
= FALSE
;
289 TcpWrap
->TxData
.FragmentCount
= 1;
290 TcpWrap
->TxToken
.Packet
.TxData
= &Wrap
->TcpWrap
.TxData
;
291 TcpWrap
->TxToken
.CompletionToken
.Status
= EFI_NOT_READY
;
297 Create event for the TCP4 receive token which is used to receive HTTP header.
299 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
301 @retval EFI_SUCCESS The events is created successfully.
302 @retval others Other error as indicated.
306 HttpCreateTcp4RxEventForHeader (
307 IN HTTP_PROTOCOL
*HttpInstance
313 Status
= gBS
->CreateEvent (
317 &HttpInstance
->IsRxDone
,
318 &HttpInstance
->RxToken
.CompletionToken
.Event
320 if (EFI_ERROR (Status
)) {
324 HttpInstance
->RxData
.FragmentCount
= 1;
325 HttpInstance
->RxToken
.Packet
.RxData
= &HttpInstance
->RxData
;
326 HttpInstance
->RxToken
.CompletionToken
.Status
= EFI_NOT_READY
;
332 Create event for the TCP4 receive token which is used to receive HTTP body.
334 @param[in] Wrap Point to HTTP token's wrap data.
336 @retval EFI_SUCCESS The events is created successfully.
337 @retval others Other error as indicated.
341 HttpCreateTcp4RxEvent (
342 IN HTTP_TOKEN_WRAP
*Wrap
346 HTTP_PROTOCOL
*HttpInstance
;
347 HTTP_TCP_TOKEN_WRAP
*TcpWrap
;
349 HttpInstance
= Wrap
->HttpInstance
;
350 TcpWrap
= &Wrap
->TcpWrap
;
352 Status
= gBS
->CreateEvent (
355 HttpTcpReceiveNotify
,
357 &TcpWrap
->RxToken
.CompletionToken
.Event
359 if (EFI_ERROR (Status
)) {
363 TcpWrap
->RxData
.FragmentCount
= 1;
364 TcpWrap
->RxToken
.Packet
.RxData
= &Wrap
->TcpWrap
.RxData
;
365 TcpWrap
->RxToken
.CompletionToken
.Status
= EFI_NOT_READY
;
371 Intiialize the HTTP_PROTOCOL structure to the unconfigured state.
373 @param[in] HttpSb The HTTP service private instance.
374 @param[in, out] HttpInstance Pointer to HTTP_PROTOCOL structure.
376 @retval EFI_SUCCESS HTTP_PROTOCOL structure is initialized successfully.
377 @retval Others Other error as indicated.
382 IN HTTP_SERVICE
*HttpSb
,
383 IN OUT HTTP_PROTOCOL
*HttpInstance
389 ASSERT ((HttpSb
!= NULL
) && (HttpInstance
!= NULL
));
391 HttpInstance
->Signature
= HTTP_PROTOCOL_SIGNATURE
;
392 CopyMem (&HttpInstance
->Http
, &mEfiHttpTemplate
, sizeof (HttpInstance
->Http
));
393 HttpInstance
->Service
= HttpSb
;
398 Status
= NetLibCreateServiceChild (
399 HttpInstance
->Service
->ControllerHandle
,
400 HttpInstance
->Service
->ImageHandle
,
401 &gEfiTcp4ServiceBindingProtocolGuid
,
402 &HttpInstance
->TcpChildHandle
405 if (EFI_ERROR (Status
)) {
409 Status
= gBS
->OpenProtocol (
410 HttpInstance
->TcpChildHandle
,
411 &gEfiTcp4ProtocolGuid
,
412 (VOID
**) &Interface
,
413 HttpInstance
->Service
->ImageHandle
,
414 HttpInstance
->Service
->ControllerHandle
,
415 EFI_OPEN_PROTOCOL_BY_DRIVER
418 if (EFI_ERROR (Status
)) {
422 Status
= gBS
->OpenProtocol (
423 HttpInstance
->TcpChildHandle
,
424 &gEfiTcp4ProtocolGuid
,
425 (VOID
**) &HttpInstance
->Tcp4
,
426 HttpInstance
->Service
->ImageHandle
,
427 HttpInstance
->Handle
,
428 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
430 if (EFI_ERROR(Status
)) {
434 NetMapInit (&HttpInstance
->TxTokens
);
435 NetMapInit (&HttpInstance
->RxTokens
);
441 if (HttpInstance
->TcpChildHandle
!= NULL
) {
443 HttpInstance
->TcpChildHandle
,
444 &gEfiTcp4ProtocolGuid
,
445 HttpInstance
->Service
->ImageHandle
,
446 HttpInstance
->Service
->ControllerHandle
450 HttpInstance
->TcpChildHandle
,
451 &gEfiTcp4ProtocolGuid
,
452 HttpInstance
->Service
->ImageHandle
,
456 NetLibDestroyServiceChild (
457 HttpInstance
->Service
->ControllerHandle
,
458 HttpInstance
->Service
->ImageHandle
,
459 &gEfiTcp4ServiceBindingProtocolGuid
,
460 HttpInstance
->TcpChildHandle
469 Clean up the HTTP child, release all the resources used by it.
471 @param[in] HttpInstance The HTTP child to clean up.
476 IN HTTP_PROTOCOL
*HttpInstance
479 HttpCloseConnection (HttpInstance
);
481 HttpCloseTcp4ConnCloseEvent (HttpInstance
);
483 if (HttpInstance
->CacheBody
!= NULL
) {
484 FreePool (HttpInstance
->CacheBody
);
485 HttpInstance
->CacheBody
= NULL
;
486 HttpInstance
->NextMsg
= NULL
;
489 if (HttpInstance
->RemoteHost
!= NULL
) {
490 FreePool (HttpInstance
->RemoteHost
);
491 HttpInstance
->RemoteHost
= NULL
;
494 if (HttpInstance
->MsgParser
!= NULL
) {
495 HttpFreeMsgParser (HttpInstance
->MsgParser
);
496 HttpInstance
->MsgParser
= NULL
;
499 NetMapClean (&HttpInstance
->TxTokens
);
500 NetMapClean (&HttpInstance
->RxTokens
);
502 if (HttpInstance
->TcpChildHandle
!= NULL
) {
504 HttpInstance
->TcpChildHandle
,
505 &gEfiTcp4ProtocolGuid
,
506 HttpInstance
->Service
->ImageHandle
,
507 HttpInstance
->Service
->ControllerHandle
511 HttpInstance
->TcpChildHandle
,
512 &gEfiTcp4ProtocolGuid
,
513 HttpInstance
->Service
->ImageHandle
,
517 NetLibDestroyServiceChild (
518 HttpInstance
->Service
->ControllerHandle
,
519 HttpInstance
->Service
->ImageHandle
,
520 &gEfiTcp4ServiceBindingProtocolGuid
,
521 HttpInstance
->TcpChildHandle
527 Establish TCP connection with HTTP server.
529 @param[in] HttpInstance The HTTP instance private data.
531 @retval EFI_SUCCESS The TCP connection is established.
532 @retval Others Other error as indicated.
536 HttpCreateConnection (
537 IN HTTP_PROTOCOL
*HttpInstance
543 // Create events for variuos asynchronous operations.
545 HttpInstance
->IsConnDone
= FALSE
;
548 // Connect to Http server
550 HttpInstance
->ConnToken
.CompletionToken
.Status
= EFI_NOT_READY
;
551 Status
= HttpInstance
->Tcp4
->Connect (HttpInstance
->Tcp4
, &HttpInstance
->ConnToken
);
552 if (EFI_ERROR (Status
)) {
553 DEBUG ((EFI_D_ERROR
, "HttpCreateConnection: Tcp4->Connect() = %r\n", Status
));
557 while (!HttpInstance
->IsConnDone
) {
558 HttpInstance
->Tcp4
->Poll (HttpInstance
->Tcp4
);
561 Status
= HttpInstance
->ConnToken
.CompletionToken
.Status
;
563 if (!EFI_ERROR (Status
)) {
564 HttpInstance
->State
= HTTP_STATE_TCP_CONNECTED
;
571 Close existing TCP connection.
573 @param[in] HttpInstance The HTTP instance private data.
575 @retval EFI_SUCCESS The TCP connection is closed.
576 @retval Others Other error as indicated.
580 HttpCloseConnection (
581 IN HTTP_PROTOCOL
*HttpInstance
586 if (HttpInstance
->State
== HTTP_STATE_TCP_CONNECTED
) {
587 HttpInstance
->CloseToken
.AbortOnClose
= TRUE
;
588 HttpInstance
->IsCloseDone
= FALSE
;
590 Status
= HttpInstance
->Tcp4
->Close (HttpInstance
->Tcp4
, &HttpInstance
->CloseToken
);
591 if (EFI_ERROR (Status
)) {
595 while (!HttpInstance
->IsCloseDone
) {
596 HttpInstance
->Tcp4
->Poll (HttpInstance
->Tcp4
);
600 HttpInstance
->State
= HTTP_STATE_TCP_CLOSED
;
605 Configure TCP4 protocol child.
607 @param[in] HttpInstance The HTTP instance private data.
608 @param[in] Wrap The HTTP token's wrap data.
610 @retval EFI_SUCCESS The TCP4 protocol child is configured.
611 @retval Others Other error as indicated.
616 IN HTTP_PROTOCOL
*HttpInstance
,
617 IN HTTP_TOKEN_WRAP
*Wrap
621 EFI_TCP4_CONFIG_DATA
*Tcp4CfgData
;
622 EFI_TCP4_ACCESS_POINT
*Tcp4AP
;
623 EFI_TCP4_OPTION
*Tcp4Option
;
624 HTTP_TCP_TOKEN_WRAP
*TcpWrap
;
626 ASSERT (HttpInstance
!= NULL
);
627 TcpWrap
= &Wrap
->TcpWrap
;
630 Tcp4CfgData
= &HttpInstance
->Tcp4CfgData
;
631 ZeroMem (Tcp4CfgData
, sizeof (EFI_TCP4_CONFIG_DATA
));
633 Tcp4CfgData
->TypeOfService
= HTTP_TOS_DEAULT
;
634 Tcp4CfgData
->TimeToLive
= HTTP_TTL_DEAULT
;
635 Tcp4CfgData
->ControlOption
= &HttpInstance
->Tcp4Option
;
637 Tcp4AP
= &Tcp4CfgData
->AccessPoint
;
638 Tcp4AP
->UseDefaultAddress
= HttpInstance
->IPv4Node
.UseDefaultAddress
;
639 if (!Tcp4AP
->UseDefaultAddress
) {
640 IP4_COPY_ADDRESS (&Tcp4AP
->StationAddress
, &HttpInstance
->IPv4Node
.LocalAddress
);
641 IP4_COPY_ADDRESS (&Tcp4AP
->SubnetMask
, &HttpInstance
->IPv4Node
.LocalSubnet
);
644 Tcp4AP
->StationPort
= HttpInstance
->IPv4Node
.LocalPort
;
645 Tcp4AP
->RemotePort
= HttpInstance
->RemotePort
;
646 Tcp4AP
->ActiveFlag
= TRUE
;
647 IP4_COPY_ADDRESS (&Tcp4AP
->RemoteAddress
, &HttpInstance
->RemoteAddr
);
649 Tcp4Option
= Tcp4CfgData
->ControlOption
;
650 Tcp4Option
->ReceiveBufferSize
= HTTP_BUFFER_SIZE_DEAULT
;
651 Tcp4Option
->SendBufferSize
= HTTP_BUFFER_SIZE_DEAULT
;
652 Tcp4Option
->MaxSynBackLog
= HTTP_MAX_SYN_BACK_LOG
;
653 Tcp4Option
->ConnectionTimeout
= HTTP_CONNECTION_TIMEOUT
;
654 Tcp4Option
->DataRetries
= HTTP_DATA_RETRIES
;
655 Tcp4Option
->FinTimeout
= HTTP_FIN_TIMEOUT
;
656 Tcp4Option
->KeepAliveProbes
= HTTP_KEEP_ALIVE_PROBES
;
657 Tcp4Option
->KeepAliveTime
= HTTP_KEEP_ALIVE_TIME
;
658 Tcp4Option
->KeepAliveInterval
= HTTP_KEEP_ALIVE_INTERVAL
;
659 Tcp4Option
->EnableNagle
= TRUE
;
660 Tcp4CfgData
->ControlOption
= Tcp4Option
;
662 Status
= HttpInstance
->Tcp4
->Configure (HttpInstance
->Tcp4
, Tcp4CfgData
);
663 if (EFI_ERROR (Status
)) {
664 DEBUG ((EFI_D_ERROR
, "HttpConfigureTcp4 - %r\n", Status
));
668 Status
= HttpCreateTcp4ConnCloseEvent (HttpInstance
);
669 if (EFI_ERROR (Status
)) {
673 Status
= HttpCreateTcp4TxEvent (Wrap
);
674 if (EFI_ERROR (Status
)) {
678 HttpInstance
->State
= HTTP_STATE_TCP_CONFIGED
;
684 Check existing TCP connection, if in error state, receover TCP4 connection.
686 @param[in] HttpInstance The HTTP instance private data.
688 @retval EFI_SUCCESS The TCP connection is established.
689 @retval EFI_NOT_READY TCP4 protocol child is not created or configured.
690 @retval Others Other error as indicated.
695 IN HTTP_PROTOCOL
*HttpInstance
699 EFI_TCP4_CONNECTION_STATE Tcp4State
;
702 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONFIGED
|| HttpInstance
->Tcp4
== NULL
) {
703 return EFI_NOT_READY
;
706 Status
= HttpInstance
->Tcp4
->GetModeData(
714 if (EFI_ERROR(Status
)){
715 DEBUG ((EFI_D_ERROR
, "Tcp4 GetModeData fail - %x\n", Status
));
719 if (Tcp4State
> Tcp4StateEstablished
) {
720 HttpCloseConnection(HttpInstance
);
723 return HttpCreateConnection (HttpInstance
);
727 Send the HTTP message through TCP4.
729 @param[in] HttpInstance The HTTP instance private data.
730 @param[in] Wrap The HTTP token's wrap data.
731 @param[in] TxString Buffer containing the HTTP message string.
732 @param[in] TxStringLen Length of the HTTP message string in bytes.
734 @retval EFI_SUCCESS The HTTP message is queued into TCP transmit queue.
735 @retval Others Other error as indicated.
740 IN HTTP_PROTOCOL
*HttpInstance
,
741 IN HTTP_TOKEN_WRAP
*Wrap
,
747 EFI_TCP4_IO_TOKEN
*TxToken
;
748 EFI_TCP4_PROTOCOL
*Tcp4
;
750 Tcp4
= HttpInstance
->Tcp4
;
751 TxToken
= &Wrap
->TcpWrap
.TxToken
;
753 TxToken
->Packet
.TxData
->DataLength
= (UINT32
) TxStringLen
;
754 TxToken
->Packet
.TxData
->FragmentTable
[0].FragmentLength
= (UINT32
) TxStringLen
;
755 TxToken
->Packet
.TxData
->FragmentTable
[0].FragmentBuffer
= (VOID
*) TxString
;
756 TxToken
->CompletionToken
.Status
= EFI_NOT_READY
;
758 Wrap
->TcpWrap
.IsTxDone
= FALSE
;
759 Status
= Tcp4
->Transmit (Tcp4
, TxToken
);
760 if (EFI_ERROR (Status
)) {
761 DEBUG ((EFI_D_ERROR
, "Transmit failed: %r\n", Status
));
769 Translate the status code in HTTP message to EFI_HTTP_STATUS_CODE defined
770 in UEFI 2.5 specification.
772 @param[in] StatusCode The status code value in HTTP message.
774 @return Value defined in EFI_HTTP_STATUS_CODE .
778 HttpMappingToStatusCode (
782 switch (StatusCode
) {
784 return HTTP_STATUS_100_CONTINUE
;
786 return HTTP_STATUS_101_SWITCHING_PROTOCOLS
;
788 return HTTP_STATUS_200_OK
;
790 return HTTP_STATUS_201_CREATED
;
792 return HTTP_STATUS_202_ACCEPTED
;
794 return HTTP_STATUS_203_NON_AUTHORITATIVE_INFORMATION
;
796 return HTTP_STATUS_204_NO_CONTENT
;
798 return HTTP_STATUS_205_RESET_CONTENT
;
800 return HTTP_STATUS_206_PARTIAL_CONTENT
;
802 return HTTP_STATUS_300_MULTIPLE_CHIOCES
;
804 return HTTP_STATUS_301_MOVED_PERMANENTLY
;
806 return HTTP_STATUS_302_FOUND
;
808 return HTTP_STATUS_303_SEE_OTHER
;
810 return HTTP_STATUS_304_NOT_MODIFIED
;
812 return HTTP_STATUS_305_USE_PROXY
;
814 return HTTP_STATUS_307_TEMPORARY_REDIRECT
;
816 return HTTP_STATUS_400_BAD_REQUEST
;
818 return HTTP_STATUS_401_UNAUTHORIZED
;
820 return HTTP_STATUS_402_PAYMENT_REQUIRED
;
822 return HTTP_STATUS_403_FORBIDDEN
;
824 return HTTP_STATUS_404_NOT_FOUND
;
826 return HTTP_STATUS_405_METHOD_NOT_ALLOWED
;
828 return HTTP_STATUS_406_NOT_ACCEPTABLE
;
830 return HTTP_STATUS_407_PROXY_AUTHENTICATION_REQUIRED
;
832 return HTTP_STATUS_408_REQUEST_TIME_OUT
;
834 return HTTP_STATUS_409_CONFLICT
;
836 return HTTP_STATUS_410_GONE
;
838 return HTTP_STATUS_411_LENGTH_REQUIRED
;
840 return HTTP_STATUS_412_PRECONDITION_FAILED
;
842 return HTTP_STATUS_413_REQUEST_ENTITY_TOO_LARGE
;
844 return HTTP_STATUS_414_REQUEST_URI_TOO_LARGE
;
846 return HTTP_STATUS_415_UNSUPPORETD_MEDIA_TYPE
;
848 return HTTP_STATUS_416_REQUESTED_RANGE_NOT_SATISFIED
;
850 return HTTP_STATUS_417_EXPECTATION_FAILED
;
852 return HTTP_STATUS_500_INTERNAL_SERVER_ERROR
;
854 return HTTP_STATUS_501_NOT_IMIPLEMENTED
;
856 return HTTP_STATUS_502_BAD_GATEWAY
;
858 return HTTP_STATUS_503_SERVICE_UNAVAILABLE
;
860 return HTTP_STATUS_504_GATEWAY_TIME_OUT
;
862 return HTTP_STATUS_505_HTTP_VERSION_NOT_SUPPORTED
;
865 return HTTP_STATUS_UNSUPPORTED_STATUS
;
870 Check whether the user's token or event has already
871 been enqueue on HTTP TxToken or RxToken list.
873 @param[in] Map The container of either user's transmit or receive
875 @param[in] Item Current item to check against.
876 @param[in] Context The Token to check againist.
878 @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP
879 @retval EFI_SUCCESS The current item isn't the same token/event as the
887 IN NET_MAP_ITEM
*Item
,
891 EFI_HTTP_TOKEN
*Token
;
892 EFI_HTTP_TOKEN
*TokenInItem
;
894 Token
= (EFI_HTTP_TOKEN
*) Context
;
895 TokenInItem
= (EFI_HTTP_TOKEN
*) Item
->Key
;
897 if (Token
== TokenInItem
|| Token
->Event
== TokenInItem
->Event
) {
898 return EFI_ACCESS_DENIED
;
905 Check whether the HTTP message associated with TxToken is already sent out.
907 @param[in] Map The container of TxToken.
908 @param[in] Item Current item to check against.
909 @param[in] Context The Token to check againist.
911 @retval EFI_NOT_READY The HTTP message is still queued in the list.
912 @retval EFI_SUCCESS The HTTP message has been sent out.
919 IN NET_MAP_ITEM
*Item
,
923 HTTP_TOKEN_WRAP
*ValueInItem
;
925 ValueInItem
= (HTTP_TOKEN_WRAP
*) Item
->Value
;
927 if (!ValueInItem
->TcpWrap
.IsTxDone
) {
928 return EFI_NOT_READY
;
935 Transmit the HTTP mssage by processing the associated HTTP token.
937 @param[in] Map The container of TxToken.
938 @param[in] Item Current item to check against.
939 @param[in] Context The Token to check againist.
941 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
942 @retval EFI_SUCCESS The HTTP message is queued into TCP transmit
950 IN NET_MAP_ITEM
*Item
,
954 HTTP_TOKEN_WRAP
*ValueInItem
;
959 ValueInItem
= (HTTP_TOKEN_WRAP
*) Item
->Value
;
960 if (ValueInItem
->TcpWrap
.IsTxDone
) {
965 // Parse the URI of the remote host.
967 Url
= AllocatePool (StrLen (ValueInItem
->HttpToken
->Message
->Data
.Request
->Url
) + 1);
969 return EFI_OUT_OF_RESOURCES
;
972 UnicodeStrToAsciiStr (ValueInItem
->HttpToken
->Message
->Data
.Request
->Url
, Url
);
975 // Create request message.
977 RequestStr
= HttpGenRequestString (
978 ValueInItem
->HttpInstance
,
979 ValueInItem
->HttpToken
->Message
,
983 if (RequestStr
== NULL
) {
984 return EFI_OUT_OF_RESOURCES
;
988 // Transmit the request message.
990 Status
= HttpTransmitTcp4 (
991 ValueInItem
->HttpInstance
,
994 AsciiStrLen (RequestStr
)
996 FreePool (RequestStr
);
1001 Receive the HTTP response by processing the associated HTTP token.
1003 @param[in] Map The container of RxToken.
1004 @param[in] Item Current item to check against.
1005 @param[in] Context The Token to check againist.
1007 @retval EFI_SUCCESS The HTTP response is queued into TCP receive
1009 @retval Others Other error as indicated.
1016 IN NET_MAP_ITEM
*Item
,
1021 // Process the queued HTTP response.
1023 return HttpResponseWorker ((HTTP_TOKEN_WRAP
*) Item
->Value
);
1027 Generate HTTP request string.
1029 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
1030 @param[in] Message Pointer to storage containing HTTP message data.
1031 @param[in] Url The URL of a remote host.
1033 @return Pointer to the created HTTP request string.
1034 @return NULL if any error occured.
1038 HttpGenRequestString (
1039 IN HTTP_PROTOCOL
*HttpInstance
,
1040 IN EFI_HTTP_MESSAGE
*Message
,
1052 EFI_HTTP_HEADER
**AppendList
;
1055 ASSERT (HttpInstance
!= NULL
);
1056 ASSERT (Message
!= NULL
);
1058 DEBUG ((EFI_D_ERROR
, "HttpMethod - %x\n", Message
->Data
.Request
->Method
));
1068 AppendList
= AllocateZeroPool (sizeof (EFI_HTTP_HEADER
*) * (Message
->HeaderCount
));
1069 if (AppendList
== NULL
) {
1073 for(Index
= 0; Index
< Message
->HeaderCount
; Index
++){
1074 AppendList
[Index
] = &Message
->Headers
[Index
];
1078 // Check whether the EFI_HTTP_UTILITIES_PROTOCOL is available.
1080 if (mHttpUtilities
== NULL
) {
1085 // Build raw unformatted HTTP headers.
1087 Status
= mHttpUtilities
->Build (
1093 Message
->HeaderCount
,
1098 FreePool (AppendList
);
1099 if (EFI_ERROR (Status
) || HttpHdr
== NULL
) {
1104 // Calculate HTTP message length.
1106 MsgSize
= Message
->BodyLength
+ HTTP_MAXIMUM_METHOD_LEN
+ AsciiStrLen (Url
) +
1107 AsciiStrLen (HTTP_VERSION_CRLF_STR
) + HttpHdrSize
;
1108 Request
= AllocateZeroPool (MsgSize
);
1109 if (Request
== NULL
) {
1113 RequestPtr
= Request
;
1115 // Construct header request
1117 switch (Message
->Data
.Request
->Method
) {
1119 StrLength
= sizeof (HTTP_GET_STR
) - 1;
1120 CopyMem (RequestPtr
, HTTP_GET_STR
, StrLength
);
1121 RequestPtr
+= StrLength
;
1123 case HttpMethodHead
:
1124 StrLength
= sizeof (HTTP_HEAD_STR
) - 1;
1125 CopyMem (RequestPtr
, HTTP_HEAD_STR
, StrLength
);
1126 RequestPtr
+= StrLength
;
1133 StrLength
= AsciiStrLen (Url
);
1134 CopyMem (RequestPtr
, Url
, StrLength
);
1135 RequestPtr
+= StrLength
;
1137 StrLength
= sizeof (HTTP_VERSION_CRLF_STR
) - 1;
1138 CopyMem (RequestPtr
, HTTP_VERSION_CRLF_STR
, StrLength
);
1139 RequestPtr
+= StrLength
;
1144 CopyMem (RequestPtr
, HttpHdr
, HttpHdrSize
);
1145 RequestPtr
+= HttpHdrSize
;
1150 if (Message
->Body
!= NULL
) {
1151 CopyMem (RequestPtr
, Message
->Body
, Message
->BodyLength
);
1152 RequestPtr
+= Message
->BodyLength
;
1164 if (Request
!= NULL
) {
1171 if (HttpHdr
!= NULL
) {
1175 return (CHAR8
*) Request
;