]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Routines to process Wrq (upload).\r | |
3 | \r | |
4 | Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r | |
5 | This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php<BR>\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #include "Mtftp4Impl.h"\r | |
16 | \r | |
17 | \r | |
18 | \r | |
19 | /**\r | |
20 | Build then send a MTFTP data packet for the MTFTP upload session.\r | |
21 | \r | |
22 | @param Instance The MTFTP upload session.\r | |
23 | @param BlockNum The block number to send.\r | |
24 | \r | |
25 | @retval EFI_OUT_OF_RESOURCES Failed to build the packet.\r | |
26 | @retval EFI_ABORTED The consumer of this child directs to abort the\r | |
27 | transmission by return an error through PacketNeeded.\r | |
28 | @retval EFI_SUCCESS The data is sent.\r | |
29 | \r | |
30 | **/\r | |
31 | EFI_STATUS\r | |
32 | Mtftp4WrqSendBlock (\r | |
33 | IN OUT MTFTP4_PROTOCOL *Instance,\r | |
34 | IN UINT16 BlockNum\r | |
35 | )\r | |
36 | {\r | |
37 | EFI_MTFTP4_PACKET *Packet;\r | |
38 | EFI_MTFTP4_TOKEN *Token;\r | |
39 | NET_BUF *UdpPacket;\r | |
40 | EFI_STATUS Status;\r | |
41 | UINT16 DataLen;\r | |
42 | UINT8 *DataBuf;\r | |
43 | UINT64 Start;\r | |
44 | \r | |
45 | //\r | |
46 | // Allocate a buffer to hold the user data\r | |
47 | //\r | |
48 | UdpPacket = NetbufAlloc (Instance->BlkSize + MTFTP4_DATA_HEAD_LEN);\r | |
49 | \r | |
50 | if (UdpPacket == NULL) {\r | |
51 | return EFI_OUT_OF_RESOURCES;\r | |
52 | }\r | |
53 | \r | |
54 | Packet = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (UdpPacket, MTFTP4_DATA_HEAD_LEN, FALSE);\r | |
55 | ASSERT (Packet != NULL);\r | |
56 | \r | |
57 | Packet->Data.OpCode = HTONS (EFI_MTFTP4_OPCODE_DATA);\r | |
58 | Packet->Data.Block = HTONS (BlockNum);\r | |
59 | \r | |
60 | //\r | |
61 | // Read the block from either the buffer or PacketNeeded callback\r | |
62 | //\r | |
63 | Token = Instance->Token;\r | |
64 | DataLen = Instance->BlkSize;\r | |
65 | \r | |
66 | if (Token->Buffer != NULL) {\r | |
67 | Start = MultU64x32 (BlockNum - 1, Instance->BlkSize);\r | |
68 | \r | |
69 | if (Token->BufferSize < Start + Instance->BlkSize) {\r | |
70 | DataLen = (UINT16) (Token->BufferSize - Start);\r | |
71 | Instance->LastBlock = BlockNum;\r | |
72 | Mtftp4SetLastBlockNum (&Instance->Blocks, BlockNum);\r | |
73 | }\r | |
74 | \r | |
75 | if (DataLen > 0) {\r | |
76 | NetbufAllocSpace (UdpPacket, DataLen, FALSE);\r | |
77 | CopyMem (Packet->Data.Data, (UINT8 *) Token->Buffer + Start, DataLen);\r | |
78 | }\r | |
79 | \r | |
80 | } else {\r | |
81 | //\r | |
82 | // Get data from PacketNeeded\r | |
83 | //\r | |
84 | DataBuf = NULL;\r | |
85 | Status = Token->PacketNeeded (\r | |
86 | &Instance->Mtftp4,\r | |
87 | Token,\r | |
88 | &DataLen,\r | |
89 | (VOID **) &DataBuf\r | |
90 | );\r | |
91 | \r | |
92 | if (EFI_ERROR (Status) || (DataLen > Instance->BlkSize)) {\r | |
93 | if (DataBuf != NULL) {\r | |
94 | FreePool (DataBuf);\r | |
95 | }\r | |
96 | \r | |
97 | Mtftp4SendError (\r | |
98 | Instance,\r | |
99 | EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r | |
100 | (UINT8 *) "User aborted the transfer"\r | |
101 | );\r | |
102 | \r | |
103 | return EFI_ABORTED;\r | |
104 | }\r | |
105 | \r | |
106 | if (DataLen < Instance->BlkSize) {\r | |
107 | Instance->LastBlock = BlockNum;\r | |
108 | Mtftp4SetLastBlockNum (&Instance->Blocks, BlockNum);\r | |
109 | }\r | |
110 | \r | |
111 | if (DataLen > 0) {\r | |
112 | NetbufAllocSpace (UdpPacket, DataLen, FALSE);\r | |
113 | CopyMem (Packet->Data.Data, DataBuf, DataLen);\r | |
114 | FreePool (DataBuf);\r | |
115 | }\r | |
116 | }\r | |
117 | \r | |
118 | return Mtftp4SendPacket (Instance, UdpPacket);\r | |
119 | }\r | |
120 | \r | |
121 | \r | |
122 | /**\r | |
123 | Function to handle received ACK packet. \r | |
124 | \r | |
125 | If the ACK number matches the expected block number, and there are more \r | |
126 | data pending, send the next block. Otherwise tell the caller that we are done.\r | |
127 | \r | |
128 | @param Instance The MTFTP upload session\r | |
129 | @param Packet The MTFTP packet received\r | |
130 | @param Len The packet length\r | |
131 | @param Completed Return whether the upload has finished.\r | |
132 | \r | |
133 | @retval EFI_SUCCESS The ACK is successfully processed.\r | |
134 | @retval EFI_TFTP_ERROR The block number loops back.\r | |
135 | @retval Others Failed to transmit the next data packet.\r | |
136 | \r | |
137 | **/\r | |
138 | EFI_STATUS\r | |
139 | Mtftp4WrqHandleAck (\r | |
140 | IN MTFTP4_PROTOCOL *Instance,\r | |
141 | IN EFI_MTFTP4_PACKET *Packet,\r | |
142 | IN UINT32 Len,\r | |
143 | OUT BOOLEAN *Completed\r | |
144 | )\r | |
145 | {\r | |
146 | UINT16 AckNum;\r | |
147 | INTN Expected;\r | |
148 | UINT64 TotalBlock;\r | |
149 | \r | |
150 | *Completed = FALSE;\r | |
151 | AckNum = NTOHS (Packet->Ack.Block[0]);\r | |
152 | Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r | |
153 | \r | |
154 | ASSERT (Expected >= 0);\r | |
155 | \r | |
156 | //\r | |
157 | // Get an unwanted ACK, return EFI_SUCCESS to let Mtftp4WrqInput\r | |
158 | // restart receive.\r | |
159 | //\r | |
160 | if (Expected != AckNum) {\r | |
161 | return EFI_SUCCESS;\r | |
162 | }\r | |
163 | \r | |
164 | //\r | |
165 | // Remove the acked block number, if this is the last block number,\r | |
166 | // tell the Mtftp4WrqInput to finish the transfer. This is the last\r | |
167 | // block number if the block range are empty..\r | |
168 | //\r | |
169 | Mtftp4RemoveBlockNum (&Instance->Blocks, AckNum, *Completed,&TotalBlock);\r | |
170 | \r | |
171 | Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r | |
172 | \r | |
173 | if (Expected < 0) {\r | |
174 | \r | |
175 | //\r | |
176 | // The block range is empty. It may either because the the last\r | |
177 | // block has been ACKed, or the sequence number just looped back,\r | |
178 | // that is, there is more than 0xffff blocks.\r | |
179 | //\r | |
180 | if (Instance->LastBlock == AckNum) {\r | |
181 | ASSERT (Instance->LastBlock >= 1);\r | |
182 | *Completed = TRUE;\r | |
183 | return EFI_SUCCESS;\r | |
184 | \r | |
185 | } else {\r | |
186 | Mtftp4SendError (\r | |
187 | Instance,\r | |
188 | EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r | |
189 | (UINT8 *) "Block number rolls back, not supported, try blksize option"\r | |
190 | );\r | |
191 | \r | |
192 | return EFI_TFTP_ERROR;\r | |
193 | }\r | |
194 | }\r | |
195 | \r | |
196 | return Mtftp4WrqSendBlock (Instance, (UINT16) Expected);\r | |
197 | }\r | |
198 | \r | |
199 | \r | |
200 | /**\r | |
201 | Check whether the received OACK is valid. \r | |
202 | \r | |
203 | The OACK is valid only if:\r | |
204 | 1. It only include options requested by us\r | |
205 | 2. It can only include a smaller block size\r | |
206 | 3. It can't change the proposed time out value.\r | |
207 | 4. Other requirements of the individal MTFTP options as required.\r | |
208 | \r | |
209 | @param Reply The options included in the OACK\r | |
210 | @param Request The options we requested\r | |
211 | \r | |
212 | @retval TRUE The options included in OACK is valid.\r | |
213 | @retval FALSE The options included in OACK is invalid.\r | |
214 | \r | |
215 | **/\r | |
216 | BOOLEAN\r | |
217 | Mtftp4WrqOackValid (\r | |
218 | IN MTFTP4_OPTION *Reply,\r | |
219 | IN MTFTP4_OPTION *Request\r | |
220 | )\r | |
221 | {\r | |
222 | //\r | |
223 | // It is invalid for server to return options we don't request\r | |
224 | //\r | |
225 | if ((Reply->Exist & ~Request->Exist) != 0) {\r | |
226 | return FALSE;\r | |
227 | }\r | |
228 | \r | |
229 | //\r | |
230 | // Server can only specify a smaller block size to be used and\r | |
231 | // return the timeout matches that requested.\r | |
232 | //\r | |
233 | if ((((Reply->Exist & MTFTP4_BLKSIZE_EXIST) != 0) && (Reply->BlkSize > Request->BlkSize)) ||\r | |
234 | (((Reply->Exist & MTFTP4_TIMEOUT_EXIST) != 0) && (Reply->Timeout != Request->Timeout))) {\r | |
235 | return FALSE;\r | |
236 | }\r | |
237 | \r | |
238 | return TRUE;\r | |
239 | }\r | |
240 | \r | |
241 | \r | |
242 | /**\r | |
243 | Function to handle the MTFTP OACK packet. \r | |
244 | \r | |
245 | It parses the packet's options, and update the internal states of the session.\r | |
246 | \r | |
247 | @param Instance The MTFTP session\r | |
248 | @param Packet The received OACK packet\r | |
249 | @param Len The length of the packet\r | |
250 | @param Completed Whether the transmisson has completed. NOT used by\r | |
251 | this function.\r | |
252 | \r | |
253 | @retval EFI_SUCCESS The OACK process is OK\r | |
254 | @retval EFI_TFTP_ERROR Some error occured, and the session reset.\r | |
255 | \r | |
256 | **/\r | |
257 | EFI_STATUS\r | |
258 | Mtftp4WrqHandleOack (\r | |
259 | IN OUT MTFTP4_PROTOCOL *Instance,\r | |
260 | IN EFI_MTFTP4_PACKET *Packet,\r | |
261 | IN UINT32 Len,\r | |
262 | OUT BOOLEAN *Completed\r | |
263 | )\r | |
264 | {\r | |
265 | MTFTP4_OPTION Reply;\r | |
266 | EFI_MTFTP4_PACKET Bogus;\r | |
267 | EFI_STATUS Status;\r | |
268 | INTN Expected;\r | |
269 | \r | |
270 | *Completed = FALSE;\r | |
271 | \r | |
272 | //\r | |
273 | // Ignore the OACK if already started the upload\r | |
274 | //\r | |
275 | Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r | |
276 | \r | |
277 | if (Expected != 0) {\r | |
278 | return EFI_SUCCESS;\r | |
279 | }\r | |
280 | \r | |
281 | //\r | |
282 | // Parse and validate the options from server\r | |
283 | //\r | |
284 | ZeroMem (&Reply, sizeof (MTFTP4_OPTION));\r | |
285 | Status = Mtftp4ParseOptionOack (Packet, Len, &Reply);\r | |
286 | \r | |
287 | if (EFI_ERROR (Status) || !Mtftp4WrqOackValid (&Reply, &Instance->RequestOption)) {\r | |
288 | //\r | |
289 | // Don't send a MTFTP error packet when out of resource, it can\r | |
290 | // only make it worse.\r | |
291 | //\r | |
292 | if (Status != EFI_OUT_OF_RESOURCES) {\r | |
293 | Mtftp4SendError (\r | |
294 | Instance,\r | |
295 | EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r | |
296 | (UINT8 *) "Mal-formated OACK packet"\r | |
297 | );\r | |
298 | }\r | |
299 | \r | |
300 | return EFI_TFTP_ERROR;\r | |
301 | }\r | |
302 | \r | |
303 | if (Reply.BlkSize != 0) {\r | |
304 | Instance->BlkSize = Reply.BlkSize;\r | |
305 | }\r | |
306 | \r | |
307 | if (Reply.Timeout != 0) {\r | |
308 | Instance->Timeout = Reply.Timeout;\r | |
309 | }\r | |
310 | \r | |
311 | //\r | |
312 | // Build a bogus ACK0 packet then pass it to the Mtftp4WrqHandleAck,\r | |
313 | // which will start the transmission of the first data block.\r | |
314 | //\r | |
315 | Bogus.Ack.OpCode = HTONS (EFI_MTFTP4_OPCODE_ACK);\r | |
316 | Bogus.Ack.Block[0] = 0;\r | |
317 | \r | |
318 | Status = Mtftp4WrqHandleAck (\r | |
319 | Instance,\r | |
320 | &Bogus,\r | |
321 | sizeof (EFI_MTFTP4_ACK_HEADER),\r | |
322 | Completed\r | |
323 | );\r | |
324 | \r | |
325 | return Status;\r | |
326 | }\r | |
327 | \r | |
328 | \r | |
329 | /**\r | |
330 | The input process routine for MTFTP upload.\r | |
331 | \r | |
332 | @param UdpPacket The received MTFTP packet.\r | |
333 | @param EndPoint The local/remote access point\r | |
334 | @param IoStatus The result of the packet receiving\r | |
335 | @param Context Opaque parameter for the callback, which is the\r | |
336 | MTFTP session.\r | |
337 | **/\r | |
338 | VOID\r | |
339 | EFIAPI\r | |
340 | Mtftp4WrqInput (\r | |
341 | IN NET_BUF *UdpPacket,\r | |
342 | IN UDP_END_POINT *EndPoint,\r | |
343 | IN EFI_STATUS IoStatus,\r | |
344 | IN VOID *Context\r | |
345 | )\r | |
346 | {\r | |
347 | MTFTP4_PROTOCOL *Instance;\r | |
348 | EFI_MTFTP4_PACKET *Packet;\r | |
349 | BOOLEAN Completed;\r | |
350 | EFI_STATUS Status;\r | |
351 | UINT32 Len;\r | |
352 | UINT16 Opcode;\r | |
353 | \r | |
354 | Instance = (MTFTP4_PROTOCOL *) Context;\r | |
355 | NET_CHECK_SIGNATURE (Instance, MTFTP4_PROTOCOL_SIGNATURE);\r | |
356 | \r | |
357 | Completed = FALSE;\r | |
358 | Packet = NULL;\r | |
359 | Status = EFI_SUCCESS;\r | |
360 | \r | |
361 | if (EFI_ERROR (IoStatus)) {\r | |
362 | Status = IoStatus;\r | |
363 | goto ON_EXIT;\r | |
364 | }\r | |
365 | \r | |
366 | ASSERT (UdpPacket != NULL);\r | |
367 | \r | |
368 | if (UdpPacket->TotalSize < MTFTP4_OPCODE_LEN) {\r | |
369 | goto ON_EXIT;\r | |
370 | }\r | |
371 | \r | |
372 | //\r | |
373 | // Client send initial request to server's listening port. Server\r | |
374 | // will select a UDP port to communicate with the client.\r | |
375 | //\r | |
376 | if (EndPoint->RemotePort != Instance->ConnectedPort) {\r | |
377 | if (Instance->ConnectedPort != 0) {\r | |
378 | goto ON_EXIT;\r | |
379 | } else {\r | |
380 | Instance->ConnectedPort = EndPoint->RemotePort;\r | |
381 | }\r | |
382 | }\r | |
383 | \r | |
384 | //\r | |
385 | // Copy the MTFTP packet to a continuous buffer if it isn't already so.\r | |
386 | //\r | |
387 | Len = UdpPacket->TotalSize;\r | |
388 | \r | |
389 | if (UdpPacket->BlockOpNum > 1) {\r | |
390 | Packet = AllocatePool (Len);\r | |
391 | \r | |
392 | if (Packet == NULL) {\r | |
393 | Status = EFI_OUT_OF_RESOURCES;\r | |
394 | goto ON_EXIT;\r | |
395 | }\r | |
396 | \r | |
397 | NetbufCopy (UdpPacket, 0, Len, (UINT8 *) Packet);\r | |
398 | \r | |
399 | } else {\r | |
400 | Packet = (EFI_MTFTP4_PACKET *) NetbufGetByte (UdpPacket, 0, NULL);\r | |
401 | ASSERT (Packet != NULL);\r | |
402 | }\r | |
403 | \r | |
404 | Opcode = NTOHS (Packet->OpCode);\r | |
405 | \r | |
406 | //\r | |
407 | // Call the user's CheckPacket if provided. Abort the transmission\r | |
408 | // if CheckPacket returns an EFI_ERROR code.\r | |
409 | //\r | |
410 | if ((Instance->Token->CheckPacket != NULL) &&\r | |
411 | ((Opcode == EFI_MTFTP4_OPCODE_OACK) || (Opcode == EFI_MTFTP4_OPCODE_ERROR))) {\r | |
412 | \r | |
413 | Status = Instance->Token->CheckPacket (\r | |
414 | &Instance->Mtftp4,\r | |
415 | Instance->Token,\r | |
416 | (UINT16) Len,\r | |
417 | Packet\r | |
418 | );\r | |
419 | \r | |
420 | if (EFI_ERROR (Status)) {\r | |
421 | //\r | |
422 | // Send an error message to the server to inform it\r | |
423 | //\r | |
424 | if (Opcode != EFI_MTFTP4_OPCODE_ERROR) {\r | |
425 | Mtftp4SendError (\r | |
426 | Instance,\r | |
427 | EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r | |
428 | (UINT8 *) "User aborted the transfer"\r | |
429 | );\r | |
430 | }\r | |
431 | \r | |
432 | Status = EFI_ABORTED;\r | |
433 | goto ON_EXIT;\r | |
434 | }\r | |
435 | }\r | |
436 | \r | |
437 | switch (Opcode) {\r | |
438 | case EFI_MTFTP4_OPCODE_ACK:\r | |
439 | if (Len != MTFTP4_OPCODE_LEN + MTFTP4_BLKNO_LEN) {\r | |
440 | goto ON_EXIT;\r | |
441 | }\r | |
442 | \r | |
443 | Status = Mtftp4WrqHandleAck (Instance, Packet, Len, &Completed);\r | |
444 | break;\r | |
445 | \r | |
446 | case EFI_MTFTP4_OPCODE_OACK:\r | |
447 | if (Len <= MTFTP4_OPCODE_LEN) {\r | |
448 | goto ON_EXIT;\r | |
449 | }\r | |
450 | \r | |
451 | Status = Mtftp4WrqHandleOack (Instance, Packet, Len, &Completed);\r | |
452 | break;\r | |
453 | \r | |
454 | case EFI_MTFTP4_OPCODE_ERROR:\r | |
455 | Status = EFI_TFTP_ERROR;\r | |
456 | break;\r | |
457 | \r | |
458 | default:\r | |
459 | break;\r | |
460 | }\r | |
461 | \r | |
462 | ON_EXIT:\r | |
463 | //\r | |
464 | // Free the resources, then if !EFI_ERROR (Status) and not completed,\r | |
465 | // restart the receive, otherwise end the session.\r | |
466 | //\r | |
467 | if ((Packet != NULL) && (UdpPacket->BlockOpNum > 1)) {\r | |
468 | FreePool (Packet);\r | |
469 | }\r | |
470 | \r | |
471 | if (UdpPacket != NULL) {\r | |
472 | NetbufFree (UdpPacket);\r | |
473 | }\r | |
474 | \r | |
475 | if (!EFI_ERROR (Status) && !Completed) {\r | |
476 | Status = UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4WrqInput, Instance, 0);\r | |
477 | }\r | |
478 | \r | |
479 | //\r | |
480 | // Status may have been updated by UdpIoRecvDatagram\r | |
481 | //\r | |
482 | if (EFI_ERROR (Status) || Completed) {\r | |
483 | Mtftp4CleanOperation (Instance, Status);\r | |
484 | }\r | |
485 | }\r | |
486 | \r | |
487 | \r | |
488 | \r | |
489 | /**\r | |
490 | Start the MTFTP session for upload.\r | |
491 | \r | |
492 | It will first init some states, then send the WRQ request packet, \r | |
493 | and start receiving the packet.\r | |
494 | \r | |
495 | @param Instance The MTFTP session\r | |
496 | @param Operation Redundant parameter, which is always\r | |
497 | EFI_MTFTP4_OPCODE_WRQ here.\r | |
498 | \r | |
499 | @retval EFI_SUCCESS The upload process has been started.\r | |
500 | @retval Others Failed to start the upload.\r | |
501 | \r | |
502 | **/\r | |
503 | EFI_STATUS\r | |
504 | Mtftp4WrqStart (\r | |
505 | IN MTFTP4_PROTOCOL *Instance,\r | |
506 | IN UINT16 Operation\r | |
507 | )\r | |
508 | {\r | |
509 | EFI_STATUS Status;\r | |
510 | \r | |
511 | //\r | |
512 | // The valid block number range are [0, 0xffff]. For example:\r | |
513 | // the client sends an WRQ request to the server, the server\r | |
514 | // ACK with an ACK0 to let client start transfer the first\r | |
515 | // packet.\r | |
516 | //\r | |
517 | Status = Mtftp4InitBlockRange (&Instance->Blocks, 0, 0xffff);\r | |
518 | \r | |
519 | if (EFI_ERROR (Status)) {\r | |
520 | return Status;\r | |
521 | }\r | |
522 | \r | |
523 | Status = Mtftp4SendRequest (Instance);\r | |
524 | \r | |
525 | if (EFI_ERROR (Status)) {\r | |
526 | return Status;\r | |
527 | }\r | |
528 | \r | |
529 | return UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4WrqInput, Instance, 0);\r | |
530 | }\r | |
531 | \r |