2 Support routines for Mtftp.
4 Copyright (c) 2006 - 2007, Intel Corporation<BR>
5 All rights reserved. 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<BR>
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 "Mtftp4Impl.h"
19 Allocate a MTFTP4 block range, then init it to the range of [Start, End]
21 @param Start The start block number
22 @param End The last block number in the range
24 @return Pointer to the created block range, NULL if failed to allocate memory.
33 MTFTP4_BLOCK_RANGE
*Range
;
35 Range
= AllocatePool (sizeof (MTFTP4_BLOCK_RANGE
));
41 InitializeListHead (&Range
->Link
);
50 Initialize the block range for either RRQ or WRQ.
52 RRQ and WRQ have different requirements for Start and End.
53 For example, during start up, WRQ initializes its whole valid block range
54 to [0, 0xffff]. This is bacause the server will send us a ACK0 to inform us
55 to start the upload. When the client received ACK0, it will remove 0 from the
56 range, get the next block number, which is 1, then upload the BLOCK1. For RRQ
57 without option negotiation, the server will directly send us the BLOCK1 in
58 response to the client's RRQ. When received BLOCK1, the client will remove
59 it from the block range and send an ACK. It also works if there is option
62 @param Head The block range head to initialize
63 @param Start The Start block number.
64 @param End The last block number.
66 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for initial block range
67 @retval EFI_SUCCESS The initial block range is created.
71 Mtftp4InitBlockRange (
77 MTFTP4_BLOCK_RANGE
*Range
;
79 Range
= Mtftp4AllocateRange (Start
, End
);
82 return EFI_OUT_OF_RESOURCES
;
85 InsertTailList (Head
, &Range
->Link
);
91 Get the first valid block number on the range list.
93 @param Head The block range head
95 @return The first valid block number, -1 if the block range is empty.
99 Mtftp4GetNextBlockNum (
103 MTFTP4_BLOCK_RANGE
*Range
;
105 if (IsListEmpty (Head
)) {
109 Range
= NET_LIST_HEAD (Head
, MTFTP4_BLOCK_RANGE
, Link
);
115 Set the last block number of the block range list.
117 It will remove all the blocks after the Last. MTFTP initialize the block range
118 to the maximum possible range, such as [0, 0xffff] for WRQ. When it gets the
119 last block number, it will call this function to set the last block number.
121 @param Head The block range list
122 @param Last The last block number
126 Mtftp4SetLastBlockNum (
131 MTFTP4_BLOCK_RANGE
*Range
;
134 // Iterate from the tail to head to remove the block number
137 while (!IsListEmpty (Head
)) {
138 Range
= NET_LIST_TAIL (Head
, MTFTP4_BLOCK_RANGE
, Link
);
140 if (Range
->Start
> Last
) {
141 RemoveEntryList (&Range
->Link
);
142 gBS
->FreePool (Range
);
146 if (Range
->End
> Last
) {
156 Remove the block number from the block range list.
158 @param Head The block range list to remove from
159 @param Num The block number to remove
161 @retval EFI_NOT_FOUND The block number isn't in the block range list
162 @retval EFI_SUCCESS The block number has been removed from the list
163 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource
167 Mtftp4RemoveBlockNum (
172 MTFTP4_BLOCK_RANGE
*Range
;
173 MTFTP4_BLOCK_RANGE
*NewRange
;
176 NET_LIST_FOR_EACH (Entry
, Head
) {
179 // Each block represents a hole [Start, End] in the file,
180 // skip to the first range with End >= Num
182 Range
= NET_LIST_USER_STRUCT (Entry
, MTFTP4_BLOCK_RANGE
, Link
);
184 if (Range
->End
< Num
) {
189 // There are three different cases for Start
190 // 1. (Start > Num) && (End >= Num):
191 // because all the holes before this one has the condition of
192 // End < Num, so this block number has been removed.
194 // 2. (Start == Num) && (End >= Num):
195 // Need to increase the Start by one, and if End == Num, this
196 // hole has been removed completely, remove it.
198 // 3. (Start < Num) && (End >= Num):
199 // if End == Num, only need to decrease the End by one because
200 // we have (Start < Num) && (Num == End), so (Start <= End - 1).
201 // if (End > Num), the hold is splited into two holes, with
202 // [Start, Num - 1] and [Num + 1, End].
204 if (Range
->Start
> Num
) {
205 return EFI_NOT_FOUND
;
207 } else if (Range
->Start
== Num
) {
210 if (Range
->Start
> Range
->End
) {
211 RemoveEntryList (&Range
->Link
);
212 gBS
->FreePool (Range
);
218 if (Range
->End
== Num
) {
221 NewRange
= Mtftp4AllocateRange ((UINT16
) (Num
+ 1), (UINT16
) Range
->End
);
223 if (NewRange
== NULL
) {
224 return EFI_OUT_OF_RESOURCES
;
227 Range
->End
= Num
- 1;
228 NetListInsertAfter (&Range
->Link
, &NewRange
->Link
);
235 return EFI_NOT_FOUND
;
240 Build then transmit the request packet for the MTFTP session.
242 @param Instance The Mtftp session
244 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the request
245 @retval EFI_SUCCESS The request is built and sent
246 @retval Others Failed to transmit the packet.
251 IN MTFTP4_PROTOCOL
*Instance
254 EFI_MTFTP4_PACKET
*Packet
;
255 EFI_MTFTP4_OPTION
*Options
;
256 EFI_MTFTP4_TOKEN
*Token
;
265 Token
= Instance
->Token
;
266 Options
= Token
->OptionList
;
267 Mode
= Instance
->Token
->ModeStr
;
270 Mode
= (UINT8
*) "octet";
274 // Compute the packet length
276 Len1
= (UINT32
) AsciiStrLen ((CHAR8
*) Token
->Filename
);
277 Len2
= (UINT32
) AsciiStrLen ((CHAR8
*) Mode
);
278 Len
= (Len1
+ Len2
+ 4);
280 for (Index
= 0; Index
< Token
->OptionCount
; Index
++) {
281 Len1
= (UINT32
) AsciiStrLen ((CHAR8
*) Options
[Index
].OptionStr
);
282 Len2
= (UINT32
) AsciiStrLen ((CHAR8
*) Options
[Index
].ValueStr
);
283 Len
+= Len1
+ Len2
+ 2;
287 // Allocate a packet then copy the data over
289 if ((Nbuf
= NetbufAlloc (Len
)) == NULL
) {
290 return EFI_OUT_OF_RESOURCES
;
293 Packet
= (EFI_MTFTP4_PACKET
*) NetbufAllocSpace (Nbuf
, Len
, FALSE
);
294 Packet
->OpCode
= HTONS (Instance
->Operation
);
295 Cur
= Packet
->Rrq
.Filename
;
296 Cur
= (UINT8
*) AsciiStrCpy ((CHAR8
*) Cur
, (CHAR8
*) Token
->Filename
);
297 Cur
+= AsciiStrLen ((CHAR8
*) Token
->Filename
) + 1;
298 Cur
= (UINT8
*) AsciiStrCpy ((CHAR8
*) Cur
, (CHAR8
*) Mode
);
299 Cur
+= AsciiStrLen ((CHAR8
*) Mode
) + 1;
301 for (Index
= 0; Index
< Token
->OptionCount
; ++Index
) {
302 Cur
= (UINT8
*) AsciiStrCpy ((CHAR8
*) Cur
, (CHAR8
*) Options
[Index
].OptionStr
);
303 Cur
+= AsciiStrLen ((CHAR8
*) Options
[Index
].OptionStr
) + 1;
305 Cur
= (UINT8
*) AsciiStrCpy ((CHAR8
*) Cur
, (CHAR8
*) Options
[Index
].ValueStr
);
306 Cur
+= AsciiStrLen ((CHAR8
*) (CHAR8
*) Options
[Index
].ValueStr
) + 1;
309 return Mtftp4SendPacket (Instance
, Nbuf
);
314 Build then send an error message.
316 @param Instance The MTFTP session
317 @param ErrCode The error code
318 @param ErrInfo The error message
320 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet
321 @retval EFI_SUCCESS The error packet is transmitted.
322 @retval Others Failed to transmit the packet.
327 IN MTFTP4_PROTOCOL
*Instance
,
333 EFI_MTFTP4_PACKET
*TftpError
;
336 Len
= (UINT32
) (AsciiStrLen ((CHAR8
*) ErrInfo
) + sizeof (EFI_MTFTP4_ERROR_HEADER
));
337 Packet
= NetbufAlloc (Len
);
339 if (Packet
== NULL
) {
340 return EFI_OUT_OF_RESOURCES
;
343 TftpError
= (EFI_MTFTP4_PACKET
*) NetbufAllocSpace (Packet
, Len
, FALSE
);
344 TftpError
->OpCode
= HTONS (EFI_MTFTP4_OPCODE_ERROR
);
345 TftpError
->Error
.ErrorCode
= HTONS (ErrCode
);
347 AsciiStrCpy ((CHAR8
*) TftpError
->Error
.ErrorMessage
, (CHAR8
*) ErrInfo
);
349 return Mtftp4SendPacket (Instance
, Packet
);
354 The callback function called when the packet is transmitted.
356 It simply frees the packet.
358 @param Packet The transmitted (or failed to) packet
359 @param Points The local and remote UDP access point
360 @param IoStatus The result of the transmission
361 @param Context Opaque parameter to the callback
377 Set the timeout for the instance. User a longer time for passive instances.
379 @param Instance The Mtftp session to set time out
384 IN OUT MTFTP4_PROTOCOL
*Instance
387 if (Instance
->Master
) {
388 Instance
->PacketToLive
= Instance
->Timeout
;
390 Instance
->PacketToLive
= Instance
->Timeout
* 2;
396 Send the packet for the instance.
398 It will first save a reference to the packet for later retransmission.
399 Then determine the destination port, listen port for requests, and connected
400 port for others. At last, send the packet out.
402 @param Instance The Mtftp instance
403 @param Packet The packet to send
405 @retval EFI_SUCCESS The packet is sent out
406 @retval Others Failed to transmit the packet.
411 IN OUT MTFTP4_PROTOCOL
*Instance
,
412 IN OUT NET_BUF
*Packet
421 // Save the packet for retransmission
423 if (Instance
->LastPacket
!= NULL
) {
424 NetbufFree (Instance
->LastPacket
);
427 Instance
->LastPacket
= Packet
;
429 Instance
->CurRetry
= 0;
430 Mtftp4SetTimeout (Instance
);
432 UdpPoint
.LocalAddr
= 0;
433 UdpPoint
.LocalPort
= 0;
434 UdpPoint
.RemoteAddr
= Instance
->ServerIp
;
437 // Send the requests to the listening port, other packets
438 // to the connected port
440 Value
= *((UINT16
*) NetbufGetByte (Packet
, 0, NULL
));
441 OpCode
= NTOHS (Value
);
443 if ((OpCode
== EFI_MTFTP4_OPCODE_RRQ
) ||
444 (OpCode
== EFI_MTFTP4_OPCODE_DIR
) ||
445 (OpCode
== EFI_MTFTP4_OPCODE_WRQ
)) {
446 UdpPoint
.RemotePort
= Instance
->ListeningPort
;
448 UdpPoint
.RemotePort
= Instance
->ConnectedPort
;
451 NET_GET_REF (Packet
);
453 Status
= UdpIoSendDatagram (
454 Instance
->UnicastPort
,
462 if (EFI_ERROR (Status
)) {
463 NET_PUT_REF (Packet
);
471 Retransmit the last packet for the instance.
473 @param Instance The Mtftp instance
475 @retval EFI_SUCCESS The last packet is retransmitted.
476 @retval Others Failed to retransmit.
481 IN MTFTP4_PROTOCOL
*Instance
489 ASSERT (Instance
->LastPacket
!= NULL
);
491 UdpPoint
.LocalAddr
= 0;
492 UdpPoint
.LocalPort
= 0;
493 UdpPoint
.RemoteAddr
= Instance
->ServerIp
;
496 // Set the requests to the listening port, other packets to the connected port
498 Value
= *(UINT16
*) NetbufGetByte (Instance
->LastPacket
, 0, NULL
);
499 OpCode
= NTOHS (Value
);
501 if ((OpCode
== EFI_MTFTP4_OPCODE_RRQ
) || (OpCode
== EFI_MTFTP4_OPCODE_DIR
) ||
502 (OpCode
== EFI_MTFTP4_OPCODE_WRQ
)) {
503 UdpPoint
.RemotePort
= Instance
->ListeningPort
;
505 UdpPoint
.RemotePort
= Instance
->ConnectedPort
;
508 NET_GET_REF (Instance
->LastPacket
);
510 Status
= UdpIoSendDatagram (
511 Instance
->UnicastPort
,
512 Instance
->LastPacket
,
519 if (EFI_ERROR (Status
)) {
520 NET_PUT_REF (Instance
->LastPacket
);
528 The timer ticking function for the Mtftp service instance.
530 @param Event The ticking event
531 @param Context The Mtftp service instance
541 MTFTP4_SERVICE
*MtftpSb
;
544 MTFTP4_PROTOCOL
*Instance
;
545 EFI_MTFTP4_TOKEN
*Token
;
547 MtftpSb
= (MTFTP4_SERVICE
*) Context
;
550 // Iterate through all the children of the Mtftp service instance. Time
551 // out the packet. If maximum retries reached, clean the session up.
553 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &MtftpSb
->Children
) {
554 Instance
= NET_LIST_USER_STRUCT (Entry
, MTFTP4_PROTOCOL
, Link
);
556 if ((Instance
->PacketToLive
== 0) || (--Instance
->PacketToLive
> 0)) {
561 // Call the user's time out handler
563 Token
= Instance
->Token
;
565 if ((Token
->TimeoutCallback
!= NULL
) &&
566 EFI_ERROR (Token
->TimeoutCallback (&Instance
->Mtftp4
, Token
))) {
570 EFI_MTFTP4_ERRORCODE_REQUEST_DENIED
,
571 (UINT8
*) "User aborted the transfer in time out"
574 Mtftp4CleanOperation (Instance
, EFI_ABORTED
);
579 // Retransmit the packet if haven't reach the maxmium retry count,
580 // otherwise exit the transfer.
582 if (++Instance
->CurRetry
< Instance
->MaxRetry
) {
583 Mtftp4Retransmit (Instance
);
584 Mtftp4SetTimeout (Instance
);
586 Mtftp4CleanOperation (Instance
, EFI_TIMEOUT
);