2 Miscellaneous routines for HttpDxe driver.
4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "HttpDriver.h"
19 The common notify function used in HTTP driver.
21 @param[in] Event The event signaled.
22 @param[in] Context The context.
32 if ((Event
== NULL
) || (Context
== NULL
)) {
36 *((BOOLEAN
*) Context
) = TRUE
;
40 The notify function associated with Tx4Token for Tcp4->Transmit() or Tx6Token for Tcp6->Transmit().
42 @param[in] Context The context.
47 HttpTcpTransmitNotifyDpc (
51 HTTP_TOKEN_WRAP
*Wrap
;
52 HTTP_PROTOCOL
*HttpInstance
;
54 if (Context
== NULL
) {
58 Wrap
= (HTTP_TOKEN_WRAP
*) Context
;
59 HttpInstance
= Wrap
->HttpInstance
;
61 if (!HttpInstance
->LocalAddressIsIPv6
) {
62 Wrap
->HttpToken
->Status
= Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Status
;
63 gBS
->SignalEvent (Wrap
->HttpToken
->Event
);
68 if (Wrap
->TcpWrap
.Tx4Token
.Packet
.TxData
->FragmentTable
[0].FragmentBuffer
!= NULL
) {
69 FreePool (Wrap
->TcpWrap
.Tx4Token
.Packet
.TxData
->FragmentTable
[0].FragmentBuffer
);
72 if (Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
!= NULL
) {
73 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
);
77 Wrap
->HttpToken
->Status
= Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Status
;
78 gBS
->SignalEvent (Wrap
->HttpToken
->Event
);
83 if (Wrap
->TcpWrap
.Tx6Token
.Packet
.TxData
->FragmentTable
[0].FragmentBuffer
!= NULL
) {
84 FreePool (Wrap
->TcpWrap
.Tx6Token
.Packet
.TxData
->FragmentTable
[0].FragmentBuffer
);
87 if (Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
!= NULL
) {
88 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
);
93 Wrap
->TcpWrap
.IsTxDone
= TRUE
;
96 // Check pending TxTokens and sent out.
98 NetMapIterate (&Wrap
->HttpInstance
->TxTokens
, HttpTcpTransmit
, NULL
);
103 Request HttpTcpTransmitNotifyDpc as a DPC at TPL_CALLBACK.
105 @param Event The receive event delivered to TCP for transmit.
106 @param Context Context for the callback.
111 HttpTcpTransmitNotify (
117 // Request HttpTcpTransmitNotifyDpc as a DPC at TPL_CALLBACK
119 QueueDpc (TPL_CALLBACK
, HttpTcpTransmitNotifyDpc
, Context
);
123 The notify function associated with Rx4Token for Tcp4->Receive () or Rx6Token for Tcp6->Receive().
125 @param[in] Context The context.
130 HttpTcpReceiveNotifyDpc (
134 HTTP_TOKEN_WRAP
*Wrap
;
138 HTTP_PROTOCOL
*HttpInstance
;
141 if (Context
== NULL
) {
145 Wrap
= (HTTP_TOKEN_WRAP
*) Context
;
146 HttpInstance
= Wrap
->HttpInstance
;
147 UsingIpv6
= HttpInstance
->LocalAddressIsIPv6
;
150 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
);
152 if (EFI_ERROR (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Status
)) {
153 Wrap
->HttpToken
->Status
= Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Status
;
154 gBS
->SignalEvent (Wrap
->HttpToken
->Event
);
160 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
);
162 if (EFI_ERROR (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Status
)) {
163 Wrap
->HttpToken
->Status
= Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Status
;
164 gBS
->SignalEvent (Wrap
->HttpToken
->Event
);
171 // Check whether we receive a complete HTTP message.
173 ASSERT (HttpInstance
->MsgParser
!= NULL
);
175 Length
= (UINTN
) Wrap
->TcpWrap
.Rx6Data
.FragmentTable
[0].FragmentLength
;
177 Length
= (UINTN
) Wrap
->TcpWrap
.Rx4Data
.FragmentTable
[0].FragmentLength
;
180 Status
= HttpParseMessageBody (
181 HttpInstance
->MsgParser
,
183 Wrap
->HttpToken
->Message
->Body
185 if (EFI_ERROR (Status
)) {
189 if (HttpIsMessageComplete (HttpInstance
->MsgParser
)) {
191 // Free the MsgParse since we already have a full HTTP message.
193 HttpFreeMsgParser (HttpInstance
->MsgParser
);
194 HttpInstance
->MsgParser
= NULL
;
197 Wrap
->HttpToken
->Message
->BodyLength
= Length
;
198 ASSERT (HttpInstance
->CacheBody
== NULL
);
200 // We receive part of header of next HTTP msg.
202 if (HttpInstance
->NextMsg
!= NULL
) {
203 Wrap
->HttpToken
->Message
->BodyLength
= HttpInstance
->NextMsg
-
204 (CHAR8
*) Wrap
->HttpToken
->Message
->Body
;
205 HttpInstance
->CacheLen
= Length
- Wrap
->HttpToken
->Message
->BodyLength
;
206 if (HttpInstance
->CacheLen
!= 0) {
207 HttpInstance
->CacheBody
= AllocateZeroPool (HttpInstance
->CacheLen
);
208 if (HttpInstance
->CacheBody
== NULL
) {
211 CopyMem (HttpInstance
->CacheBody
, HttpInstance
->NextMsg
, HttpInstance
->CacheLen
);
212 HttpInstance
->NextMsg
= HttpInstance
->CacheBody
;
213 HttpInstance
->CacheOffset
= 0;
217 Item
= NetMapFindKey (&Wrap
->HttpInstance
->RxTokens
, Wrap
->HttpToken
);
219 NetMapRemoveItem (&Wrap
->HttpInstance
->RxTokens
, Item
, NULL
);
223 Wrap
->TcpWrap
.IsRxDone
= TRUE
;
225 Wrap
->HttpToken
->Status
= Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Status
;
227 Wrap
->HttpToken
->Status
= Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Status
;
231 gBS
->SignalEvent (Wrap
->HttpToken
->Event
);
234 // Check pending RxTokens and receive the HTTP message.
236 NetMapIterate (&Wrap
->HttpInstance
->RxTokens
, HttpTcpReceive
, NULL
);
242 Request HttpTcpReceiveNotifyDpc as a DPC at TPL_CALLBACK.
244 @param Event The receive event delivered to TCP for receive.
245 @param Context Context for the callback.
250 HttpTcpReceiveNotify (
256 // Request HttpTcpTransmitNotifyDpc as a DPC at TPL_CALLBACK
258 QueueDpc (TPL_CALLBACK
, HttpTcpReceiveNotifyDpc
, Context
);
262 Create events for the TCP connection token and TCP close token.
264 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
266 @retval EFI_SUCCESS The events are created successfully.
267 @retval others Other error as indicated.
271 HttpCreateTcpConnCloseEvent (
272 IN HTTP_PROTOCOL
*HttpInstance
277 if (!HttpInstance
->LocalAddressIsIPv6
) {
279 // Create events for variuos asynchronous operations.
281 Status
= gBS
->CreateEvent (
285 &HttpInstance
->IsTcp4ConnDone
,
286 &HttpInstance
->Tcp4ConnToken
.CompletionToken
.Event
288 if (EFI_ERROR (Status
)) {
293 // Initialize Tcp4CloseToken
295 Status
= gBS
->CreateEvent (
299 &HttpInstance
->IsTcp4CloseDone
,
300 &HttpInstance
->Tcp4CloseToken
.CompletionToken
.Event
302 if (EFI_ERROR (Status
)) {
308 // Create events for variuos asynchronous operations.
310 Status
= gBS
->CreateEvent (
314 &HttpInstance
->IsTcp6ConnDone
,
315 &HttpInstance
->Tcp6ConnToken
.CompletionToken
.Event
317 if (EFI_ERROR (Status
)) {
322 // Initialize Tcp6CloseToken
324 Status
= gBS
->CreateEvent (
328 &HttpInstance
->IsTcp6CloseDone
,
329 &HttpInstance
->Tcp6CloseToken
.CompletionToken
.Event
331 if (EFI_ERROR (Status
)) {
342 HttpCloseTcpConnCloseEvent (HttpInstance
);
349 Close events in the TCP connection token and TCP close token.
351 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
355 HttpCloseTcpConnCloseEvent (
356 IN HTTP_PROTOCOL
*HttpInstance
359 ASSERT (HttpInstance
!= NULL
);
361 if (HttpInstance
->LocalAddressIsIPv6
) {
362 if (NULL
!= HttpInstance
->Tcp6ConnToken
.CompletionToken
.Event
) {
363 gBS
->CloseEvent (HttpInstance
->Tcp6ConnToken
.CompletionToken
.Event
);
364 HttpInstance
->Tcp6ConnToken
.CompletionToken
.Event
= NULL
;
367 if (NULL
!= HttpInstance
->Tcp6CloseToken
.CompletionToken
.Event
) {
368 gBS
->CloseEvent(HttpInstance
->Tcp6CloseToken
.CompletionToken
.Event
);
369 HttpInstance
->Tcp6CloseToken
.CompletionToken
.Event
= NULL
;
373 if (NULL
!= HttpInstance
->Tcp4ConnToken
.CompletionToken
.Event
) {
374 gBS
->CloseEvent (HttpInstance
->Tcp4ConnToken
.CompletionToken
.Event
);
375 HttpInstance
->Tcp4ConnToken
.CompletionToken
.Event
= NULL
;
378 if (NULL
!= HttpInstance
->Tcp4CloseToken
.CompletionToken
.Event
) {
379 gBS
->CloseEvent(HttpInstance
->Tcp4CloseToken
.CompletionToken
.Event
);
380 HttpInstance
->Tcp4CloseToken
.CompletionToken
.Event
= NULL
;
387 Create event for the TCP transmit token.
389 @param[in] Wrap Point to HTTP token's wrap data.
391 @retval EFI_SUCCESS The events is created successfully.
392 @retval others Other error as indicated.
396 HttpCreateTcpTxEvent (
397 IN HTTP_TOKEN_WRAP
*Wrap
401 HTTP_PROTOCOL
*HttpInstance
;
402 HTTP_TCP_TOKEN_WRAP
*TcpWrap
;
404 HttpInstance
= Wrap
->HttpInstance
;
405 TcpWrap
= &Wrap
->TcpWrap
;
407 if (!HttpInstance
->LocalAddressIsIPv6
) {
408 Status
= gBS
->CreateEvent (
411 HttpTcpTransmitNotify
,
413 &TcpWrap
->Tx4Token
.CompletionToken
.Event
415 if (EFI_ERROR (Status
)) {
419 TcpWrap
->Tx4Data
.Push
= TRUE
;
420 TcpWrap
->Tx4Data
.Urgent
= FALSE
;
421 TcpWrap
->Tx4Data
.FragmentCount
= 1;
422 TcpWrap
->Tx4Token
.Packet
.TxData
= &Wrap
->TcpWrap
.Tx4Data
;
423 TcpWrap
->Tx4Token
.CompletionToken
.Status
= EFI_NOT_READY
;
426 Status
= gBS
->CreateEvent (
429 HttpTcpTransmitNotify
,
431 &TcpWrap
->Tx6Token
.CompletionToken
.Event
433 if (EFI_ERROR (Status
)) {
437 TcpWrap
->Tx6Data
.Push
= TRUE
;
438 TcpWrap
->Tx6Data
.Urgent
= FALSE
;
439 TcpWrap
->Tx6Data
.FragmentCount
= 1;
440 TcpWrap
->Tx6Token
.Packet
.TxData
= &Wrap
->TcpWrap
.Tx6Data
;
441 TcpWrap
->Tx6Token
.CompletionToken
.Status
=EFI_NOT_READY
;
450 Create event for the TCP receive token which is used to receive HTTP header.
452 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
454 @retval EFI_SUCCESS The events is created successfully.
455 @retval others Other error as indicated.
459 HttpCreateTcpRxEventForHeader (
460 IN HTTP_PROTOCOL
*HttpInstance
465 if (!HttpInstance
->LocalAddressIsIPv6
) {
466 Status
= gBS
->CreateEvent (
470 &HttpInstance
->IsRxDone
,
471 &HttpInstance
->Rx4Token
.CompletionToken
.Event
473 if (EFI_ERROR (Status
)) {
477 HttpInstance
->Rx4Data
.FragmentCount
= 1;
478 HttpInstance
->Rx4Token
.Packet
.RxData
= &HttpInstance
->Rx4Data
;
479 HttpInstance
->Rx4Token
.CompletionToken
.Status
= EFI_NOT_READY
;
482 Status
= gBS
->CreateEvent (
486 &HttpInstance
->IsRxDone
,
487 &HttpInstance
->Rx6Token
.CompletionToken
.Event
489 if (EFI_ERROR (Status
)) {
493 HttpInstance
->Rx6Data
.FragmentCount
=1;
494 HttpInstance
->Rx6Token
.Packet
.RxData
= &HttpInstance
->Rx6Data
;
495 HttpInstance
->Rx6Token
.CompletionToken
.Status
= EFI_NOT_READY
;
504 Create event for the TCP receive token which is used to receive HTTP body.
506 @param[in] Wrap Point to HTTP token's wrap data.
508 @retval EFI_SUCCESS The events is created successfully.
509 @retval others Other error as indicated.
513 HttpCreateTcpRxEvent (
514 IN HTTP_TOKEN_WRAP
*Wrap
518 HTTP_PROTOCOL
*HttpInstance
;
519 HTTP_TCP_TOKEN_WRAP
*TcpWrap
;
521 HttpInstance
= Wrap
->HttpInstance
;
522 TcpWrap
= &Wrap
->TcpWrap
;
523 if (!HttpInstance
->LocalAddressIsIPv6
) {
524 Status
= gBS
->CreateEvent (
527 HttpTcpReceiveNotify
,
529 &TcpWrap
->Rx4Token
.CompletionToken
.Event
531 if (EFI_ERROR (Status
)) {
535 TcpWrap
->Rx4Data
.FragmentCount
= 1;
536 TcpWrap
->Rx4Token
.Packet
.RxData
= &Wrap
->TcpWrap
.Rx4Data
;
537 TcpWrap
->Rx4Token
.CompletionToken
.Status
= EFI_NOT_READY
;
540 Status
= gBS
->CreateEvent (
543 HttpTcpReceiveNotify
,
545 &TcpWrap
->Rx6Token
.CompletionToken
.Event
547 if (EFI_ERROR (Status
)) {
551 TcpWrap
->Rx6Data
.FragmentCount
= 1;
552 TcpWrap
->Rx6Token
.Packet
.RxData
= &Wrap
->TcpWrap
.Rx6Data
;
553 TcpWrap
->Rx6Token
.CompletionToken
.Status
= EFI_NOT_READY
;
560 Close Events for Tcp Receive Tokens for HTTP body and HTTP header.
562 @param[in] Wrap Pointer to HTTP token's wrap data.
566 HttpCloseTcpRxEvent (
567 IN HTTP_TOKEN_WRAP
*Wrap
570 HTTP_PROTOCOL
*HttpInstance
;
572 ASSERT (Wrap
!= NULL
);
573 HttpInstance
= Wrap
->HttpInstance
;
575 if (HttpInstance
->LocalAddressIsIPv6
) {
576 if (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
!= NULL
) {
577 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
);
580 if (HttpInstance
->Rx6Token
.CompletionToken
.Event
!= NULL
) {
581 gBS
->CloseEvent (HttpInstance
->Rx6Token
.CompletionToken
.Event
);
582 HttpInstance
->Rx6Token
.CompletionToken
.Event
= NULL
;
585 if (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
!= NULL
) {
586 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
);
589 if (HttpInstance
->Rx4Token
.CompletionToken
.Event
!= NULL
) {
590 gBS
->CloseEvent (HttpInstance
->Rx4Token
.CompletionToken
.Event
);
591 HttpInstance
->Rx4Token
.CompletionToken
.Event
= NULL
;
597 Intiialize the HTTP_PROTOCOL structure to the unconfigured state.
599 @param[in, out] HttpInstance Pointer to HTTP_PROTOCOL structure.
600 @param[in] IpVersion Indicate us TCP4 protocol or TCP6 protocol.
602 @retval EFI_SUCCESS HTTP_PROTOCOL structure is initialized successfully.
603 @retval Others Other error as indicated.
608 IN OUT HTTP_PROTOCOL
*HttpInstance
,
616 ASSERT (HttpInstance
!= NULL
);
617 UsingIpv6
= IpVersion
;
621 // Create TCP4 child.
623 Status
= NetLibCreateServiceChild (
624 HttpInstance
->Service
->ControllerHandle
,
625 HttpInstance
->Service
->ImageHandle
,
626 &gEfiTcp4ServiceBindingProtocolGuid
,
627 &HttpInstance
->Tcp4ChildHandle
630 if (EFI_ERROR (Status
)) {
634 Status
= gBS
->OpenProtocol (
635 HttpInstance
->Tcp4ChildHandle
,
636 &gEfiTcp4ProtocolGuid
,
637 (VOID
**) &Interface
,
638 HttpInstance
->Service
->ImageHandle
,
639 HttpInstance
->Service
->ControllerHandle
,
640 EFI_OPEN_PROTOCOL_BY_DRIVER
643 if (EFI_ERROR (Status
)) {
647 Status
= gBS
->OpenProtocol (
648 HttpInstance
->Tcp4ChildHandle
,
649 &gEfiTcp4ProtocolGuid
,
650 (VOID
**) &HttpInstance
->Tcp4
,
651 HttpInstance
->Service
->ImageHandle
,
652 HttpInstance
->Handle
,
653 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
655 if (EFI_ERROR(Status
)) {
659 Status
= gBS
->OpenProtocol (
660 HttpInstance
->Service
->Tcp4ChildHandle
,
661 &gEfiTcp4ProtocolGuid
,
662 (VOID
**) &Interface
,
663 HttpInstance
->Service
->ImageHandle
,
664 HttpInstance
->Handle
,
665 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
667 if (EFI_ERROR(Status
)) {
672 // Create TCP6 Child.
674 Status
= NetLibCreateServiceChild (
675 HttpInstance
->Service
->ControllerHandle
,
676 HttpInstance
->Service
->ImageHandle
,
677 &gEfiTcp6ServiceBindingProtocolGuid
,
678 &HttpInstance
->Tcp6ChildHandle
681 if (EFI_ERROR (Status
)) {
685 Status
= gBS
->OpenProtocol (
686 HttpInstance
->Tcp6ChildHandle
,
687 &gEfiTcp6ProtocolGuid
,
688 (VOID
**) &Interface
,
689 HttpInstance
->Service
->ImageHandle
,
690 HttpInstance
->Service
->ControllerHandle
,
691 EFI_OPEN_PROTOCOL_BY_DRIVER
694 if (EFI_ERROR (Status
)) {
698 Status
= gBS
->OpenProtocol (
699 HttpInstance
->Tcp6ChildHandle
,
700 &gEfiTcp6ProtocolGuid
,
701 (VOID
**) &HttpInstance
->Tcp6
,
702 HttpInstance
->Service
->ImageHandle
,
703 HttpInstance
->Handle
,
704 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
707 if (EFI_ERROR(Status
)) {
711 Status
= gBS
->OpenProtocol (
712 HttpInstance
->Service
->Tcp6ChildHandle
,
713 &gEfiTcp6ProtocolGuid
,
714 (VOID
**) &Interface
,
715 HttpInstance
->Service
->ImageHandle
,
716 HttpInstance
->Handle
,
717 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
720 if (EFI_ERROR(Status
)) {
725 HttpInstance
->Url
= AllocateZeroPool (HTTP_URL_BUFFER_LEN
);
726 if (HttpInstance
->Url
== NULL
) {
727 Status
= EFI_OUT_OF_RESOURCES
;
735 if (HttpInstance
->Tcp4ChildHandle
!= NULL
) {
737 HttpInstance
->Tcp4ChildHandle
,
738 &gEfiTcp4ProtocolGuid
,
739 HttpInstance
->Service
->ImageHandle
,
740 HttpInstance
->Service
->ControllerHandle
744 HttpInstance
->Tcp4ChildHandle
,
745 &gEfiTcp4ProtocolGuid
,
746 HttpInstance
->Service
->ImageHandle
,
750 NetLibDestroyServiceChild (
751 HttpInstance
->Service
->ControllerHandle
,
752 HttpInstance
->Service
->ImageHandle
,
753 &gEfiTcp4ServiceBindingProtocolGuid
,
754 HttpInstance
->Tcp4ChildHandle
758 if (HttpInstance
->Service
->Tcp4ChildHandle
!= NULL
) {
760 HttpInstance
->Service
->Tcp4ChildHandle
,
761 &gEfiTcp4ProtocolGuid
,
762 HttpInstance
->Service
->ImageHandle
,
767 if (HttpInstance
->Tcp6ChildHandle
!= NULL
) {
769 HttpInstance
->Tcp6ChildHandle
,
770 &gEfiTcp6ProtocolGuid
,
771 HttpInstance
->Service
->ImageHandle
,
772 HttpInstance
->Service
->ControllerHandle
776 HttpInstance
->Tcp6ChildHandle
,
777 &gEfiTcp6ProtocolGuid
,
778 HttpInstance
->Service
->ImageHandle
,
782 NetLibDestroyServiceChild (
783 HttpInstance
->Service
->ControllerHandle
,
784 HttpInstance
->Service
->ImageHandle
,
785 &gEfiTcp6ServiceBindingProtocolGuid
,
786 HttpInstance
->Tcp6ChildHandle
790 if (HttpInstance
->Service
->Tcp6ChildHandle
!= NULL
) {
792 HttpInstance
->Service
->Tcp6ChildHandle
,
793 &gEfiTcp6ProtocolGuid
,
794 HttpInstance
->Service
->ImageHandle
,
799 return EFI_UNSUPPORTED
;
804 Clean up the HTTP child, release all the resources used by it.
806 @param[in] HttpInstance The HTTP child to clean up.
811 IN HTTP_PROTOCOL
*HttpInstance
814 HttpCloseConnection (HttpInstance
);
816 HttpCloseTcpConnCloseEvent (HttpInstance
);
818 if (HttpInstance
->TimeoutEvent
!= NULL
) {
819 gBS
->CloseEvent (HttpInstance
->TimeoutEvent
);
820 HttpInstance
->TimeoutEvent
= NULL
;
823 if (HttpInstance
->CacheBody
!= NULL
) {
824 FreePool (HttpInstance
->CacheBody
);
825 HttpInstance
->CacheBody
= NULL
;
826 HttpInstance
->NextMsg
= NULL
;
829 if (HttpInstance
->RemoteHost
!= NULL
) {
830 FreePool (HttpInstance
->RemoteHost
);
831 HttpInstance
->RemoteHost
= NULL
;
834 if (HttpInstance
->MsgParser
!= NULL
) {
835 HttpFreeMsgParser (HttpInstance
->MsgParser
);
836 HttpInstance
->MsgParser
= NULL
;
839 if (HttpInstance
->Url
!= NULL
) {
840 FreePool (HttpInstance
->Url
);
841 HttpInstance
->Url
= NULL
;
844 NetMapClean (&HttpInstance
->TxTokens
);
845 NetMapClean (&HttpInstance
->RxTokens
);
847 if (HttpInstance
->Tcp4ChildHandle
!= NULL
) {
849 HttpInstance
->Tcp4ChildHandle
,
850 &gEfiTcp4ProtocolGuid
,
851 HttpInstance
->Service
->ImageHandle
,
852 HttpInstance
->Service
->ControllerHandle
856 HttpInstance
->Tcp4ChildHandle
,
857 &gEfiTcp4ProtocolGuid
,
858 HttpInstance
->Service
->ImageHandle
,
862 NetLibDestroyServiceChild (
863 HttpInstance
->Service
->ControllerHandle
,
864 HttpInstance
->Service
->ImageHandle
,
865 &gEfiTcp4ServiceBindingProtocolGuid
,
866 HttpInstance
->Tcp4ChildHandle
870 if (HttpInstance
->Service
->Tcp4ChildHandle
!= NULL
) {
872 HttpInstance
->Service
->Tcp4ChildHandle
,
873 &gEfiTcp4ProtocolGuid
,
874 HttpInstance
->Service
->ImageHandle
,
879 if (HttpInstance
->Tcp6ChildHandle
!= NULL
) {
881 HttpInstance
->Tcp6ChildHandle
,
882 &gEfiTcp6ProtocolGuid
,
883 HttpInstance
->Service
->ImageHandle
,
884 HttpInstance
->Service
->ControllerHandle
888 HttpInstance
->Tcp6ChildHandle
,
889 &gEfiTcp6ProtocolGuid
,
890 HttpInstance
->Service
->ImageHandle
,
894 NetLibDestroyServiceChild (
895 HttpInstance
->Service
->ControllerHandle
,
896 HttpInstance
->Service
->ImageHandle
,
897 &gEfiTcp6ServiceBindingProtocolGuid
,
898 HttpInstance
->Tcp6ChildHandle
902 if (HttpInstance
->Service
->Tcp6ChildHandle
!= NULL
) {
904 HttpInstance
->Service
->Tcp6ChildHandle
,
905 &gEfiTcp6ProtocolGuid
,
906 HttpInstance
->Service
->ImageHandle
,
914 Establish TCP connection with HTTP server.
916 @param[in] HttpInstance The HTTP instance private data.
918 @retval EFI_SUCCESS The TCP connection is established.
919 @retval Others Other error as indicated.
923 HttpCreateConnection (
924 IN HTTP_PROTOCOL
*HttpInstance
930 // Connect to Http server
932 if (!HttpInstance
->LocalAddressIsIPv6
) {
933 HttpInstance
->IsTcp4ConnDone
= FALSE
;
934 HttpInstance
->Tcp4ConnToken
.CompletionToken
.Status
= EFI_NOT_READY
;
935 Status
= HttpInstance
->Tcp4
->Connect (HttpInstance
->Tcp4
, &HttpInstance
->Tcp4ConnToken
);
936 if (EFI_ERROR (Status
)) {
937 DEBUG ((EFI_D_ERROR
, "HttpCreateConnection: Tcp4->Connect() = %r\n", Status
));
941 while (!HttpInstance
->IsTcp4ConnDone
) {
942 HttpInstance
->Tcp4
->Poll (HttpInstance
->Tcp4
);
945 Status
= HttpInstance
->Tcp4ConnToken
.CompletionToken
.Status
;
948 HttpInstance
->IsTcp6ConnDone
= FALSE
;
949 HttpInstance
->Tcp6ConnToken
.CompletionToken
.Status
= EFI_NOT_READY
;
950 Status
= HttpInstance
->Tcp6
->Connect (HttpInstance
->Tcp6
, &HttpInstance
->Tcp6ConnToken
);
951 if (EFI_ERROR (Status
)) {
952 DEBUG ((EFI_D_ERROR
, "HttpCreateConnection: Tcp6->Connect() = %r\n", Status
));
956 while(!HttpInstance
->IsTcp6ConnDone
) {
957 HttpInstance
->Tcp6
->Poll (HttpInstance
->Tcp6
);
960 Status
= HttpInstance
->Tcp6ConnToken
.CompletionToken
.Status
;
963 if (!EFI_ERROR (Status
)) {
964 HttpInstance
->State
= HTTP_STATE_TCP_CONNECTED
;
971 Close existing TCP connection.
973 @param[in] HttpInstance The HTTP instance private data.
975 @retval EFI_SUCCESS The TCP connection is closed.
976 @retval Others Other error as indicated.
980 HttpCloseConnection (
981 IN HTTP_PROTOCOL
*HttpInstance
986 if (HttpInstance
->State
== HTTP_STATE_TCP_CONNECTED
) {
988 if (HttpInstance
->LocalAddressIsIPv6
) {
989 HttpInstance
->Tcp6CloseToken
.AbortOnClose
= TRUE
;
990 HttpInstance
->IsTcp6CloseDone
= FALSE
;
991 Status
= HttpInstance
->Tcp6
->Close (HttpInstance
->Tcp6
, &HttpInstance
->Tcp6CloseToken
);
992 if (EFI_ERROR (Status
)) {
996 while (!HttpInstance
->IsTcp6CloseDone
) {
997 HttpInstance
->Tcp6
->Poll (HttpInstance
->Tcp6
);
1001 HttpInstance
->Tcp4CloseToken
.AbortOnClose
= TRUE
;
1002 HttpInstance
->IsTcp4CloseDone
= FALSE
;
1003 Status
= HttpInstance
->Tcp4
->Close (HttpInstance
->Tcp4
, &HttpInstance
->Tcp4CloseToken
);
1004 if (EFI_ERROR (Status
)) {
1008 while (!HttpInstance
->IsTcp4CloseDone
) {
1009 HttpInstance
->Tcp4
->Poll (HttpInstance
->Tcp4
);
1015 HttpInstance
->State
= HTTP_STATE_TCP_CLOSED
;
1020 Configure TCP4 protocol child.
1022 @param[in] HttpInstance The HTTP instance private data.
1023 @param[in] Wrap The HTTP token's wrap data.
1025 @retval EFI_SUCCESS The TCP4 protocol child is configured.
1026 @retval Others Other error as indicated.
1031 IN HTTP_PROTOCOL
*HttpInstance
,
1032 IN HTTP_TOKEN_WRAP
*Wrap
1036 EFI_TCP4_CONFIG_DATA
*Tcp4CfgData
;
1037 EFI_TCP4_ACCESS_POINT
*Tcp4AP
;
1038 EFI_TCP4_OPTION
*Tcp4Option
;
1040 ASSERT (HttpInstance
!= NULL
);
1043 Tcp4CfgData
= &HttpInstance
->Tcp4CfgData
;
1044 ZeroMem (Tcp4CfgData
, sizeof (EFI_TCP4_CONFIG_DATA
));
1046 Tcp4CfgData
->TypeOfService
= HTTP_TOS_DEAULT
;
1047 Tcp4CfgData
->TimeToLive
= HTTP_TTL_DEAULT
;
1048 Tcp4CfgData
->ControlOption
= &HttpInstance
->Tcp4Option
;
1050 Tcp4AP
= &Tcp4CfgData
->AccessPoint
;
1051 Tcp4AP
->UseDefaultAddress
= HttpInstance
->IPv4Node
.UseDefaultAddress
;
1052 if (!Tcp4AP
->UseDefaultAddress
) {
1053 IP4_COPY_ADDRESS (&Tcp4AP
->StationAddress
, &HttpInstance
->IPv4Node
.LocalAddress
);
1054 IP4_COPY_ADDRESS (&Tcp4AP
->SubnetMask
, &HttpInstance
->IPv4Node
.LocalSubnet
);
1057 Tcp4AP
->StationPort
= HttpInstance
->IPv4Node
.LocalPort
;
1058 Tcp4AP
->RemotePort
= HttpInstance
->RemotePort
;
1059 Tcp4AP
->ActiveFlag
= TRUE
;
1060 IP4_COPY_ADDRESS (&Tcp4AP
->RemoteAddress
, &HttpInstance
->RemoteAddr
);
1062 Tcp4Option
= Tcp4CfgData
->ControlOption
;
1063 Tcp4Option
->ReceiveBufferSize
= HTTP_BUFFER_SIZE_DEAULT
;
1064 Tcp4Option
->SendBufferSize
= HTTP_BUFFER_SIZE_DEAULT
;
1065 Tcp4Option
->MaxSynBackLog
= HTTP_MAX_SYN_BACK_LOG
;
1066 Tcp4Option
->ConnectionTimeout
= HTTP_CONNECTION_TIMEOUT
;
1067 Tcp4Option
->DataRetries
= HTTP_DATA_RETRIES
;
1068 Tcp4Option
->FinTimeout
= HTTP_FIN_TIMEOUT
;
1069 Tcp4Option
->KeepAliveProbes
= HTTP_KEEP_ALIVE_PROBES
;
1070 Tcp4Option
->KeepAliveTime
= HTTP_KEEP_ALIVE_TIME
;
1071 Tcp4Option
->KeepAliveInterval
= HTTP_KEEP_ALIVE_INTERVAL
;
1072 Tcp4Option
->EnableNagle
= TRUE
;
1073 Tcp4CfgData
->ControlOption
= Tcp4Option
;
1075 Status
= HttpInstance
->Tcp4
->Configure (HttpInstance
->Tcp4
, Tcp4CfgData
);
1076 if (EFI_ERROR (Status
)) {
1077 DEBUG ((EFI_D_ERROR
, "HttpConfigureTcp4 - %r\n", Status
));
1081 Status
= HttpCreateTcpConnCloseEvent (HttpInstance
);
1082 if (EFI_ERROR (Status
)) {
1086 Status
= HttpCreateTcpTxEvent (Wrap
);
1087 if (EFI_ERROR (Status
)) {
1091 HttpInstance
->State
= HTTP_STATE_TCP_CONFIGED
;
1097 Configure TCP6 protocol child.
1099 @param[in] HttpInstance The HTTP instance private data.
1100 @param[in] Wrap The HTTP token's wrap data.
1102 @retval EFI_SUCCESS The TCP6 protocol child is configured.
1103 @retval Others Other error as indicated.
1108 IN HTTP_PROTOCOL
*HttpInstance
,
1109 IN HTTP_TOKEN_WRAP
*Wrap
1113 EFI_TCP6_CONFIG_DATA
*Tcp6CfgData
;
1114 EFI_TCP6_ACCESS_POINT
*Tcp6Ap
;
1115 EFI_TCP6_OPTION
*Tcp6Option
;
1117 ASSERT (HttpInstance
!= NULL
);
1119 Tcp6CfgData
= &HttpInstance
->Tcp6CfgData
;
1120 ZeroMem (Tcp6CfgData
, sizeof (EFI_TCP6_CONFIG_DATA
));
1122 Tcp6CfgData
->TrafficClass
= 0;
1123 Tcp6CfgData
->HopLimit
= 255;
1124 Tcp6CfgData
->ControlOption
= &HttpInstance
->Tcp6Option
;
1126 Tcp6Ap
= &Tcp6CfgData
->AccessPoint
;
1127 Tcp6Ap
->ActiveFlag
= TRUE
;
1128 Tcp6Ap
->StationPort
= HttpInstance
->Ipv6Node
.LocalPort
;
1129 Tcp6Ap
->RemotePort
= HttpInstance
->RemotePort
;
1130 IP6_COPY_ADDRESS (&Tcp6Ap
->StationAddress
, &HttpInstance
->Ipv6Node
.LocalAddress
);
1131 IP6_COPY_ADDRESS (&Tcp6Ap
->RemoteAddress
, &HttpInstance
->RemoteIpv6Addr
);
1133 Tcp6Option
= Tcp6CfgData
->ControlOption
;
1134 Tcp6Option
->ReceiveBufferSize
= HTTP_BUFFER_SIZE_DEAULT
;
1135 Tcp6Option
->SendBufferSize
= HTTP_BUFFER_SIZE_DEAULT
;
1136 Tcp6Option
->MaxSynBackLog
= HTTP_MAX_SYN_BACK_LOG
;
1137 Tcp6Option
->ConnectionTimeout
= HTTP_CONNECTION_TIMEOUT
;
1138 Tcp6Option
->DataRetries
= HTTP_DATA_RETRIES
;
1139 Tcp6Option
->FinTimeout
= HTTP_FIN_TIMEOUT
;
1140 Tcp6Option
->KeepAliveProbes
= HTTP_KEEP_ALIVE_PROBES
;
1141 Tcp6Option
->KeepAliveTime
= HTTP_KEEP_ALIVE_TIME
;
1142 Tcp6Option
->KeepAliveInterval
= HTTP_KEEP_ALIVE_INTERVAL
;
1143 Tcp6Option
->EnableNagle
= TRUE
;
1145 Status
= HttpInstance
->Tcp6
->Configure (HttpInstance
->Tcp6
, Tcp6CfgData
);
1146 if (EFI_ERROR (Status
)) {
1147 DEBUG ((EFI_D_ERROR
, "HttpConfigureTcp6 - %r\n", Status
));
1151 Status
= HttpCreateTcpConnCloseEvent (HttpInstance
);
1152 if (EFI_ERROR (Status
)) {
1156 Status
= HttpCreateTcpTxEvent (Wrap
);
1157 if (EFI_ERROR (Status
)) {
1161 HttpInstance
->State
= HTTP_STATE_TCP_CONFIGED
;
1168 Check existing TCP connection, if in error state, recover TCP4 connection.
1170 @param[in] HttpInstance The HTTP instance private data.
1172 @retval EFI_SUCCESS The TCP connection is established.
1173 @retval EFI_NOT_READY TCP4 protocol child is not created or configured.
1174 @retval Others Other error as indicated.
1179 IN HTTP_PROTOCOL
*HttpInstance
1183 EFI_TCP4_CONNECTION_STATE Tcp4State
;
1186 if (HttpInstance
->State
< HTTP_STATE_TCP_CONFIGED
|| HttpInstance
->Tcp4
== NULL
) {
1187 return EFI_NOT_READY
;
1190 Status
= HttpInstance
->Tcp4
->GetModeData(
1198 if (EFI_ERROR(Status
)){
1199 DEBUG ((EFI_D_ERROR
, "Tcp4 GetModeData fail - %x\n", Status
));
1203 if (Tcp4State
== Tcp4StateEstablished
) {
1205 } else if (Tcp4State
> Tcp4StateEstablished
) {
1206 HttpCloseConnection(HttpInstance
);
1209 return HttpCreateConnection (HttpInstance
);
1213 Check existing TCP connection, if in error state, recover TCP6 connection.
1215 @param[in] HttpInstance The HTTP instance private data.
1217 @retval EFI_SUCCESS The TCP connection is established.
1218 @retval EFI_NOT_READY TCP6 protocol child is not created or configured.
1219 @retval Others Other error as indicated.
1224 IN HTTP_PROTOCOL
*HttpInstance
1228 EFI_TCP6_CONNECTION_STATE Tcp6State
;
1230 if (HttpInstance
->State
< HTTP_STATE_TCP_CONFIGED
|| HttpInstance
->Tcp6
== NULL
) {
1231 return EFI_NOT_READY
;
1234 Status
= HttpInstance
->Tcp6
->GetModeData (
1243 if (EFI_ERROR(Status
)){
1244 DEBUG ((EFI_D_ERROR
, "Tcp6 GetModeData fail - %x\n", Status
));
1248 if (Tcp6State
== Tcp6StateEstablished
) {
1250 } else if (Tcp6State
> Tcp6StateEstablished
) {
1251 HttpCloseConnection(HttpInstance
);
1254 return HttpCreateConnection (HttpInstance
);
1258 Initialize TCP related data.
1260 @param[in] HttpInstance The HTTP instance private data.
1261 @param[in] Wrap The HTTP token's wrap data.
1262 @param[in] Configure The Flag indicates whether the first time to initialize Tcp.
1264 @retval EFI_SUCCESS The initialization of TCP instance is done.
1265 @retval Others Other error as indicated.
1270 IN HTTP_PROTOCOL
*HttpInstance
,
1271 IN HTTP_TOKEN_WRAP
*Wrap
,
1272 IN BOOLEAN Configure
1276 ASSERT (HttpInstance
!= NULL
);
1278 if (!HttpInstance
->LocalAddressIsIPv6
) {
1280 // Configure TCP instance.
1283 Status
= HttpConfigureTcp4 (HttpInstance
, Wrap
);
1284 if (EFI_ERROR (Status
)) {
1292 Status
= HttpConnectTcp4 (HttpInstance
);
1293 if (EFI_ERROR (Status
)) {
1298 // Configure TCP instance.
1301 Status
= HttpConfigureTcp6 (HttpInstance
, Wrap
);
1302 if (EFI_ERROR (Status
)) {
1310 Status
= HttpConnectTcp6 (HttpInstance
);
1311 if (EFI_ERROR (Status
)) {
1321 Send the HTTP message through TCP4 or TCP6.
1323 @param[in] HttpInstance The HTTP instance private data.
1324 @param[in] Wrap The HTTP token's wrap data.
1325 @param[in] TxString Buffer containing the HTTP message string.
1326 @param[in] TxStringLen Length of the HTTP message string in bytes.
1328 @retval EFI_SUCCESS The HTTP message is queued into TCP transmit queue.
1329 @retval Others Other error as indicated.
1334 IN HTTP_PROTOCOL
*HttpInstance
,
1335 IN HTTP_TOKEN_WRAP
*Wrap
,
1337 IN UINTN TxStringLen
1341 EFI_TCP4_IO_TOKEN
*Tx4Token
;
1342 EFI_TCP4_PROTOCOL
*Tcp4
;
1343 EFI_TCP6_IO_TOKEN
*Tx6Token
;
1344 EFI_TCP6_PROTOCOL
*Tcp6
;
1346 if (!HttpInstance
->LocalAddressIsIPv6
) {
1347 Tcp4
= HttpInstance
->Tcp4
;
1348 Tx4Token
= &Wrap
->TcpWrap
.Tx4Token
;
1350 Tx4Token
->Packet
.TxData
->DataLength
= (UINT32
) TxStringLen
;
1351 Tx4Token
->Packet
.TxData
->FragmentTable
[0].FragmentLength
= (UINT32
) TxStringLen
;
1352 Tx4Token
->Packet
.TxData
->FragmentTable
[0].FragmentBuffer
= (VOID
*) TxString
;
1353 Tx4Token
->CompletionToken
.Status
= EFI_NOT_READY
;
1355 Wrap
->TcpWrap
.IsTxDone
= FALSE
;
1356 Status
= Tcp4
->Transmit (Tcp4
, Tx4Token
);
1357 if (EFI_ERROR (Status
)) {
1358 DEBUG ((EFI_D_ERROR
, "Transmit failed: %r\n", Status
));
1363 Tcp6
= HttpInstance
->Tcp6
;
1364 Tx6Token
= &Wrap
->TcpWrap
.Tx6Token
;
1366 Tx6Token
->Packet
.TxData
->DataLength
= (UINT32
) TxStringLen
;
1367 Tx6Token
->Packet
.TxData
->FragmentTable
[0].FragmentLength
= (UINT32
) TxStringLen
;
1368 Tx6Token
->Packet
.TxData
->FragmentTable
[0].FragmentBuffer
= (VOID
*) TxString
;
1369 Tx6Token
->CompletionToken
.Status
= EFI_NOT_READY
;
1371 Wrap
->TcpWrap
.IsTxDone
= FALSE
;
1372 Status
= Tcp6
->Transmit (Tcp6
, Tx6Token
);
1373 if (EFI_ERROR (Status
)) {
1374 DEBUG ((EFI_D_ERROR
, "Transmit failed: %r\n", Status
));
1384 Check whether the user's token or event has already
1385 been enqueue on HTTP Tx or Rx Token list.
1387 @param[in] Map The container of either user's transmit or receive
1389 @param[in] Item Current item to check against.
1390 @param[in] Context The Token to check againist.
1392 @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP
1393 @retval EFI_SUCCESS The current item isn't the same token/event as the
1401 IN NET_MAP_ITEM
*Item
,
1405 EFI_HTTP_TOKEN
*Token
;
1406 EFI_HTTP_TOKEN
*TokenInItem
;
1408 Token
= (EFI_HTTP_TOKEN
*) Context
;
1409 TokenInItem
= (EFI_HTTP_TOKEN
*) Item
->Key
;
1411 if (Token
== TokenInItem
|| Token
->Event
== TokenInItem
->Event
) {
1412 return EFI_ACCESS_DENIED
;
1419 Check whether the HTTP message associated with Tx4Token or Tx6Token is already sent out.
1421 @param[in] Map The container of Tx4Token or Tx6Token.
1422 @param[in] Item Current item to check against.
1423 @param[in] Context The Token to check againist.
1425 @retval EFI_NOT_READY The HTTP message is still queued in the list.
1426 @retval EFI_SUCCESS The HTTP message has been sent out.
1433 IN NET_MAP_ITEM
*Item
,
1437 HTTP_TOKEN_WRAP
*ValueInItem
;
1439 ValueInItem
= (HTTP_TOKEN_WRAP
*) Item
->Value
;
1441 if (!ValueInItem
->TcpWrap
.IsTxDone
) {
1442 return EFI_NOT_READY
;
1449 Transmit the HTTP mssage by processing the associated HTTP token.
1451 @param[in] Map The container of Tx4Token or Tx6Token.
1452 @param[in] Item Current item to check against.
1453 @param[in] Context The Token to check againist.
1455 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
1456 @retval EFI_SUCCESS The HTTP message is queued into TCP transmit
1464 IN NET_MAP_ITEM
*Item
,
1468 HTTP_TOKEN_WRAP
*ValueInItem
;
1472 UINTN RequestMsgSize
;
1474 ValueInItem
= (HTTP_TOKEN_WRAP
*) Item
->Value
;
1475 if (ValueInItem
->TcpWrap
.IsTxDone
) {
1480 // Parse the URI of the remote host.
1482 Url
= AllocatePool (StrLen (ValueInItem
->HttpToken
->Message
->Data
.Request
->Url
) + 1);
1484 return EFI_OUT_OF_RESOURCES
;
1487 UnicodeStrToAsciiStr (ValueInItem
->HttpToken
->Message
->Data
.Request
->Url
, Url
);
1490 // Create request message.
1492 Status
= HttpGenRequestMessage (
1493 ValueInItem
->HttpToken
->Message
,
1500 if (EFI_ERROR (Status
)){
1505 // Transmit the request message.
1507 Status
= HttpTransmitTcp (
1508 ValueInItem
->HttpInstance
,
1510 (UINT8
*) RequestMsg
,
1513 FreePool (RequestMsg
);
1518 Receive the HTTP response by processing the associated HTTP token.
1520 @param[in] Map The container of Rx4Token or Rx6Token.
1521 @param[in] Item Current item to check against.
1522 @param[in] Context The Token to check againist.
1524 @retval EFI_SUCCESS The HTTP response is queued into TCP receive
1526 @retval Others Other error as indicated.
1533 IN NET_MAP_ITEM
*Item
,
1538 // Process the queued HTTP response.
1540 return HttpResponseWorker ((HTTP_TOKEN_WRAP
*) Item
->Value
);
1544 Receive the HTTP header by processing the associated HTTP token.
1546 @param[in] HttpInstance The HTTP instance private data.
1547 @param[in, out] SizeofHeaders The HTTP header length.
1548 @param[in, out] BufferSize The size of buffer to cacahe the header message.
1549 @param[in] Timeout The time to wait for receiving the header packet.
1551 @retval EFI_SUCCESS The HTTP header is received.
1552 @retval Others Other errors as indicated.
1556 HttpTcpReceiveHeader (
1557 IN HTTP_PROTOCOL
*HttpInstance
,
1558 IN OUT UINTN
*SizeofHeaders
,
1559 IN OUT UINTN
*BufferSize
,
1560 IN EFI_EVENT Timeout
1564 EFI_TCP4_IO_TOKEN
*Rx4Token
;
1565 EFI_TCP4_PROTOCOL
*Tcp4
;
1566 EFI_TCP6_IO_TOKEN
*Rx6Token
;
1567 EFI_TCP6_PROTOCOL
*Tcp6
;
1568 CHAR8
**EndofHeader
;
1569 CHAR8
**HttpHeaders
;
1572 ASSERT (HttpInstance
!= NULL
);
1574 EndofHeader
= HttpInstance
->EndofHeader
;
1575 HttpHeaders
= HttpInstance
->HttpHeaders
;
1576 Tcp4
= HttpInstance
->Tcp4
;
1577 Tcp6
= HttpInstance
->Tcp6
;
1582 if (HttpInstance
->LocalAddressIsIPv6
) {
1583 ASSERT (Tcp6
!= NULL
);
1585 ASSERT (Tcp4
!= NULL
);
1588 if (!HttpInstance
->LocalAddressIsIPv6
) {
1589 Rx4Token
= &HttpInstance
->Rx4Token
;
1590 Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
= AllocateZeroPool (DEF_BUF_LEN
);
1591 if (Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
== NULL
) {
1592 Status
= EFI_OUT_OF_RESOURCES
;
1597 // Receive the HTTP headers only when EFI_HTTP_RESPONSE_DATA is not NULL.
1599 while (*EndofHeader
== NULL
) {
1600 HttpInstance
->IsRxDone
= FALSE
;
1601 Rx4Token
->Packet
.RxData
->DataLength
= DEF_BUF_LEN
;
1602 Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentLength
= DEF_BUF_LEN
;
1603 Status
= Tcp4
->Receive (Tcp4
, Rx4Token
);
1604 if (EFI_ERROR (Status
)) {
1605 DEBUG ((EFI_D_ERROR
, "Tcp4 receive failed: %r\n", Status
));
1609 while (!HttpInstance
->IsRxDone
&& ((Timeout
== NULL
) || EFI_ERROR (gBS
->CheckEvent (Timeout
)))) {
1613 if (!HttpInstance
->IsRxDone
) {
1614 gBS
->CloseEvent (Rx4Token
->CompletionToken
.Event
);
1615 Rx4Token
->CompletionToken
.Status
= EFI_TIMEOUT
;
1618 Status
= Rx4Token
->CompletionToken
.Status
;
1619 if (EFI_ERROR (Status
)) {
1624 // Append the response string.
1626 *BufferSize
= (*SizeofHeaders
) + Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentLength
;
1627 Buffer
= AllocateZeroPool (*BufferSize
);
1628 if (Buffer
== NULL
) {
1629 Status
= EFI_OUT_OF_RESOURCES
;
1633 if (*HttpHeaders
!= NULL
) {
1634 CopyMem (Buffer
, *HttpHeaders
, (*SizeofHeaders
));
1635 FreePool (*HttpHeaders
);
1639 Buffer
+ (*SizeofHeaders
),
1640 Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
,
1641 Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentLength
1643 *HttpHeaders
= Buffer
;
1644 *SizeofHeaders
= *BufferSize
;
1647 // Check whether we received end of HTTP headers.
1649 *EndofHeader
= AsciiStrStr (*HttpHeaders
, HTTP_END_OF_HDR_STR
);
1651 FreePool (Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
);
1652 Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
= NULL
;
1655 Rx6Token
= &HttpInstance
->Rx6Token
;
1656 Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
= AllocateZeroPool (DEF_BUF_LEN
);
1657 if (Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
== NULL
) {
1658 Status
= EFI_OUT_OF_RESOURCES
;
1663 // Receive the HTTP headers only when EFI_HTTP_RESPONSE_DATA is not NULL.
1665 while (*EndofHeader
== NULL
) {
1666 HttpInstance
->IsRxDone
= FALSE
;
1667 Rx6Token
->Packet
.RxData
->DataLength
= DEF_BUF_LEN
;
1668 Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentLength
= DEF_BUF_LEN
;
1669 Status
= Tcp6
->Receive (Tcp6
, Rx6Token
);
1670 if (EFI_ERROR (Status
)) {
1671 DEBUG ((EFI_D_ERROR
, "Tcp6 receive failed: %r\n", Status
));
1675 while (!HttpInstance
->IsRxDone
&& ((Timeout
== NULL
) || EFI_ERROR (gBS
->CheckEvent (Timeout
)))) {
1679 if (!HttpInstance
->IsRxDone
) {
1680 gBS
->CloseEvent (Rx6Token
->CompletionToken
.Event
);
1681 Rx6Token
->CompletionToken
.Status
= EFI_TIMEOUT
;
1684 Status
= Rx6Token
->CompletionToken
.Status
;
1685 if (EFI_ERROR (Status
)) {
1690 // Append the response string.
1692 *BufferSize
= (*SizeofHeaders
) + Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentLength
;
1693 Buffer
= AllocateZeroPool (*BufferSize
);
1694 if (Buffer
== NULL
) {
1695 Status
= EFI_OUT_OF_RESOURCES
;
1699 if (*HttpHeaders
!= NULL
) {
1700 CopyMem (Buffer
, *HttpHeaders
, (*SizeofHeaders
));
1701 FreePool (*HttpHeaders
);
1705 Buffer
+ (*SizeofHeaders
),
1706 Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
,
1707 Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentLength
1709 *HttpHeaders
= Buffer
;
1710 *SizeofHeaders
= *BufferSize
;
1713 // Check whether we received end of HTTP headers.
1715 *EndofHeader
= AsciiStrStr (*HttpHeaders
, HTTP_END_OF_HDR_STR
);
1718 FreePool (Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
);
1719 Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
= NULL
;
1723 // Skip the CRLF after the HTTP headers.
1725 *EndofHeader
= *EndofHeader
+ AsciiStrLen (HTTP_END_OF_HDR_STR
);
1731 Receive the HTTP body by processing the associated HTTP token.
1733 @param[in] Wrap The HTTP token's wrap data.
1734 @param[in] HttpMsg The HTTP message data.
1735 @param[in] Timeout The time to wait for receiving the body packet.
1737 @retval EFI_SUCCESS The HTTP body is received.
1738 @retval Others Other error as indicated.
1742 HttpTcpReceiveBody (
1743 IN HTTP_TOKEN_WRAP
*Wrap
,
1744 IN EFI_HTTP_MESSAGE
*HttpMsg
,
1745 IN EFI_EVENT Timeout
1749 HTTP_PROTOCOL
*HttpInstance
;
1750 EFI_TCP6_PROTOCOL
*Tcp6
;
1751 EFI_TCP6_IO_TOKEN
*Rx6Token
;
1752 EFI_TCP4_PROTOCOL
*Tcp4
;
1753 EFI_TCP4_IO_TOKEN
*Rx4Token
;
1755 HttpInstance
= Wrap
->HttpInstance
;
1756 Tcp4
= HttpInstance
->Tcp4
;
1757 Tcp6
= HttpInstance
->Tcp6
;
1761 if (HttpInstance
->LocalAddressIsIPv6
) {
1762 ASSERT (Tcp6
!= NULL
);
1764 ASSERT (Tcp4
!= NULL
);
1767 if (HttpInstance
->LocalAddressIsIPv6
) {
1768 Rx6Token
= &Wrap
->TcpWrap
.Rx6Token
;
1769 Rx6Token
->Packet
.RxData
->DataLength
= (UINT32
) HttpMsg
->BodyLength
;
1770 Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentLength
= (UINT32
) HttpMsg
->BodyLength
;
1771 Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
= (VOID
*) HttpMsg
->Body
;
1772 Rx6Token
->CompletionToken
.Status
= EFI_NOT_READY
;
1774 Status
= Tcp6
->Receive (Tcp6
, Rx6Token
);
1775 if (EFI_ERROR (Status
)) {
1776 DEBUG ((EFI_D_ERROR
, "Tcp6 receive failed: %r\n", Status
));
1780 while (!Wrap
->TcpWrap
.IsRxDone
&& ((Timeout
== NULL
) || EFI_ERROR (gBS
->CheckEvent (Timeout
)))) {
1784 if (!Wrap
->TcpWrap
.IsRxDone
) {
1785 gBS
->CloseEvent (Rx6Token
->CompletionToken
.Event
);
1786 Rx6Token
->CompletionToken
.Status
= EFI_TIMEOUT
;
1787 Wrap
->HttpToken
->Status
= Rx6Token
->CompletionToken
.Status
;
1788 gBS
->SignalEvent (Wrap
->HttpToken
->Event
);
1791 Rx4Token
= &Wrap
->TcpWrap
.Rx4Token
;
1792 Rx4Token
->Packet
.RxData
->DataLength
= (UINT32
) HttpMsg
->BodyLength
;
1793 Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentLength
= (UINT32
) HttpMsg
->BodyLength
;
1794 Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
= (VOID
*) HttpMsg
->Body
;
1796 Rx4Token
->CompletionToken
.Status
= EFI_NOT_READY
;
1797 Status
= Tcp4
->Receive (Tcp4
, Rx4Token
);
1798 if (EFI_ERROR (Status
)) {
1799 DEBUG ((EFI_D_ERROR
, "Tcp4 receive failed: %r\n", Status
));
1803 while (!Wrap
->TcpWrap
.IsRxDone
&& ((Timeout
== NULL
) || EFI_ERROR (gBS
->CheckEvent (Timeout
)))) {
1807 if (!Wrap
->TcpWrap
.IsRxDone
) {
1808 gBS
->CloseEvent (Rx4Token
->CompletionToken
.Event
);
1809 Rx4Token
->CompletionToken
.Status
= EFI_TIMEOUT
;
1810 Wrap
->HttpToken
->Status
= Rx4Token
->CompletionToken
.Status
;
1811 gBS
->SignalEvent (Wrap
->HttpToken
->Event
);
1820 Clean up Tcp Tokens while the Tcp transmission error occurs.
1822 @param[in] Wrap Pointer to HTTP token's wrap data.
1826 HttpTcpTokenCleanup (
1827 IN HTTP_TOKEN_WRAP
*Wrap
1830 HTTP_PROTOCOL
*HttpInstance
;
1831 EFI_TCP4_IO_TOKEN
*Rx4Token
;
1832 EFI_TCP6_IO_TOKEN
*Rx6Token
;
1834 ASSERT (Wrap
!= NULL
);
1835 HttpInstance
= Wrap
->HttpInstance
;
1839 if (HttpInstance
->LocalAddressIsIPv6
) {
1840 Rx6Token
= &Wrap
->TcpWrap
.Rx6Token
;
1842 if (Rx6Token
->CompletionToken
.Event
!= NULL
) {
1843 gBS
->CloseEvent (Rx6Token
->CompletionToken
.Event
);
1844 Rx6Token
->CompletionToken
.Event
= NULL
;
1849 Rx6Token
= &HttpInstance
->Rx6Token
;
1851 if (Rx6Token
->CompletionToken
.Event
!= NULL
) {
1852 gBS
->CloseEvent (Rx6Token
->CompletionToken
.Event
);
1853 Rx6Token
->CompletionToken
.Event
= NULL
;
1856 if (Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
!= NULL
) {
1857 FreePool (Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
);
1858 Rx6Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
= NULL
;
1862 Rx4Token
= &Wrap
->TcpWrap
.Rx4Token
;
1864 if (Rx4Token
->CompletionToken
.Event
!= NULL
) {
1865 gBS
->CloseEvent (Rx4Token
->CompletionToken
.Event
);
1866 Rx4Token
->CompletionToken
.Event
= NULL
;
1871 Rx4Token
= &HttpInstance
->Rx4Token
;
1873 if (Rx4Token
->CompletionToken
.Event
!= NULL
) {
1874 gBS
->CloseEvent (Rx4Token
->CompletionToken
.Event
);
1875 Rx4Token
->CompletionToken
.Event
= NULL
;
1879 if (Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
!= NULL
) {
1880 FreePool (Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
);
1881 Rx4Token
->Packet
.RxData
->FragmentTable
[0].FragmentBuffer
= NULL
;