[mirror_edk2.git] / MdeModulePkg / Universal / Network / Mtftp4Dxe / Mtftp4Support.c

/** @file\r
\r
Copyright (c) 2006 - 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  Mtftp4Support.c\r
\r
Abstract:\r
\r
  Support routines for Mtftp\r
\r
\r
**/\r
\r
#include "Mtftp4Impl.h"\r
\r
\r
/**\r
  Allocate a MTFTP4 block range, then init it to the\r
  range of [Start, End]\r
\r
  @param  Start                 The start block number\r
  @param  End                   The last block number in the range\r
\r
  @return NULL if failed to allocate memory, otherwise the created block range.\r
\r
**/\r
STATIC\r
MTFTP4_BLOCK_RANGE *\r
Mtftp4AllocateRange (\r
  IN UINT16                 Start,\r
  IN UINT16                 End\r
  )\r
{\r
  MTFTP4_BLOCK_RANGE        *Range;\r
\r
  Range = NetAllocatePool (sizeof (MTFTP4_BLOCK_RANGE));\r
\r
  if (Range == NULL) {\r
    return NULL;\r
  }\r
\r
  NetListInit (&Range->Link);\r
  Range->Start  = Start;\r
  Range->End    = End;\r
\r
  return Range;\r
}\r
\r
\r
/**\r
  Initialize the block range for either RRQ or WRQ. RRQ and WRQ have\r
  different requirements for Start and End. For example, during start\r
  up, WRQ initializes its whole valid block range to [0, 0xffff]. This\r
  is bacause the server will send us a ACK0 to inform us to start the\r
  upload. When the client received ACK0, it will remove 0 from the range,\r
  get the next block number, which is 1, then upload the BLOCK1. For RRQ\r
  without option negotiation, the server will directly send us the BLOCK1\r
  in response to the client's RRQ. When received BLOCK1, the client will\r
  remove it from the block range and send an ACK. It also works if there\r
  is option negotiation.\r
\r
  @param  Head                  The block range head to initialize\r
  @param  Start                 The Start block number.\r
  @param  End                   The last block number.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory for initial block range\r
  @retval EFI_SUCCESS           The initial block range is created.\r
\r
**/\r
EFI_STATUS\r
Mtftp4InitBlockRange (\r
  IN NET_LIST_ENTRY         *Head,\r
  IN UINT16                 Start,\r
  IN UINT16                 End\r
  )\r
{\r
  MTFTP4_BLOCK_RANGE        *Range;\r
\r
  Range = Mtftp4AllocateRange (Start, End);\r
\r
  if (Range == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  NetListInsertTail (Head, &Range->Link);\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Get the first valid block number on the range list.\r
\r
  @param  Head                  The block range head\r
\r
  @return -1: if the block range is empty. Otherwise the first valid block number.\r
\r
**/\r
INTN\r
Mtftp4GetNextBlockNum (\r
  IN NET_LIST_ENTRY         *Head\r
  )\r
{\r
  MTFTP4_BLOCK_RANGE  *Range;\r
\r
  if (NetListIsEmpty (Head)) {\r
    return -1;\r
  }\r
\r
  Range = NET_LIST_HEAD (Head, MTFTP4_BLOCK_RANGE, Link);\r
  return Range->Start;\r
}\r
\r
\r
/**\r
  Set the last block number of the block range list. It will\r
  remove all the blocks after the Last. MTFTP initialize the\r
  block range to the maximum possible range, such as [0, 0xffff]\r
  for WRQ. When it gets the last block number, it will call\r
  this function to set the last block number.\r
\r
  @param  Head                  The block range list\r
  @param  Last                  The last block number\r
\r
  @return None\r
\r
**/\r
VOID\r
Mtftp4SetLastBlockNum (\r
  IN NET_LIST_ENTRY         *Head,\r
  IN UINT16                 Last\r
  )\r
{\r
  MTFTP4_BLOCK_RANGE        *Range;\r
\r
  //\r
  // Iterate from the tail to head to remove the block number\r
  // after the last.\r
  //\r
  while (!NetListIsEmpty (Head)) {\r
    Range = NET_LIST_TAIL (Head, MTFTP4_BLOCK_RANGE, Link);\r
\r
    if (Range->Start > Last) {\r
      NetListRemoveEntry (&Range->Link);\r
      NetFreePool (Range);\r
      continue;\r
    }\r
\r
    if (Range->End > Last) {\r
      Range->End = Last;\r
    }\r
\r
    return ;\r
  }\r
}\r
\r
\r
/**\r
  Remove the block number from the block range list.\r
\r
  @param  Head                  The block range list to remove from\r
  @param  Num                   The block number to remove\r
\r
  @retval EFI_NOT_FOUND         The block number isn't in the block range list\r
  @retval EFI_SUCCESS           The block number has been removed from the list\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource\r
\r
**/\r
EFI_STATUS\r
Mtftp4RemoveBlockNum (\r
  IN NET_LIST_ENTRY         *Head,\r
  IN UINT16                 Num\r
  )\r
{\r
  MTFTP4_BLOCK_RANGE        *Range;\r
  MTFTP4_BLOCK_RANGE        *NewRange;\r
  NET_LIST_ENTRY            *Entry;\r
\r
  NET_LIST_FOR_EACH (Entry, Head) {\r
\r
    //\r
    // Each block represents a hole [Start, End] in the file,\r
    // skip to the first range with End >= Num\r
    //\r
    Range = NET_LIST_USER_STRUCT (Entry, MTFTP4_BLOCK_RANGE, Link);\r
\r
    if (Range->End < Num) {\r
      continue;\r
    }\r
\r
    //\r
    // There are three different cases for Start\r
    // 1. (Start > Num) && (End >= Num):\r
    //    because all the holes before this one has the condition of\r
    //    End < Num, so this block number has been removed.\r
    //\r
    // 2. (Start == Num) && (End >= Num):\r
    //    Need to increase the Start by one, and if End == Num, this\r
    //    hole has been removed completely, remove it.\r
    //\r
    // 3. (Start < Num) && (End >= Num):\r
    //    if End == Num, only need to decrease the End by one because\r
    //    we have (Start < Num) && (Num == End), so (Start <= End - 1).\r
    //    if (End > Num), the hold is splited into two holes, with\r
    //    [Start, Num - 1] and [Num + 1, End].\r
    //\r
    if (Range->Start > Num) {\r
      return EFI_NOT_FOUND;\r
\r
    } else if (Range->Start == Num) {\r
      Range->Start++;\r
\r
      if (Range->Start > Range->End) {\r
        NetListRemoveEntry (&Range->Link);\r
        NetFreePool (Range);\r
      }\r
\r
      return EFI_SUCCESS;\r
\r
    } else {\r
      if (Range->End == Num) {\r
        Range->End--;\r
      } else {\r
        NewRange = Mtftp4AllocateRange ((UINT16) (Num + 1), (UINT16) Range->End);\r
\r
        if (NewRange == NULL) {\r
          return EFI_OUT_OF_RESOURCES;\r
        }\r
\r
        Range->End = Num - 1;\r
        NetListInsertAfter (&Range->Link, &NewRange->Link);\r
      }\r
\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
\r
/**\r
  Build then transmit the request packet for the MTFTP session.\r
\r
  @param  Instance              The Mtftp session\r
\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory for the request\r
  @retval EFI_SUCCESS           The request is built and sent\r
  @retval Others                Failed to transmit the packet.\r
\r
**/\r
EFI_STATUS\r
Mtftp4SendRequest (\r
  IN MTFTP4_PROTOCOL        *Instance\r
  )\r
{\r
  EFI_MTFTP4_PACKET         *Packet;\r
  EFI_MTFTP4_OPTION         *Options;\r
  EFI_MTFTP4_TOKEN          *Token;\r
  NET_BUF                   *Nbuf;\r
  UINT8                     *Mode;\r
  UINT8                     *Cur;\r
  UINT32                    Len;\r
  UINTN                     Index;\r
  UINT32                    Len1;\r
  UINT32                    Len2;\r
\r
  Token   = Instance->Token;\r
  Options = Token->OptionList;\r
  Mode    = Instance->Token->ModeStr;\r
\r
  if (Mode == NULL) {\r
    Mode = "octet";\r
  }\r
\r
  //\r
  // Compute the packet length\r
  //\r
  Len1 = (UINT32) AsciiStrLen ((CHAR8 *) Token->Filename);\r
  Len2 = (UINT32) AsciiStrLen ((CHAR8 *) Mode);\r
  Len  = (Len1 + Len2 + 4);\r
\r
  for (Index = 0; Index < Token->OptionCount; Index++) {\r
    Len1 = (UINT32) AsciiStrLen ((CHAR8 *) Options[Index].OptionStr);\r
    Len2 = (UINT32) AsciiStrLen ((CHAR8 *) Options[Index].ValueStr);\r
    Len += Len1 + Len2 + 2;\r
  }\r
\r
  //\r
  // Allocate a packet then copy the data over\r
  //\r
  if ((Nbuf = NetbufAlloc (Len)) == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Packet         = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (Nbuf, Len, FALSE);\r
  Packet->OpCode = HTONS (Instance->Operation);\r
  Cur            = Packet->Rrq.Filename;\r
  Cur            = (UINT8 *) AsciiStrCpy ((CHAR8 *) Cur, (CHAR8 *) Token->Filename);\r
  Cur            = (UINT8 *) AsciiStrCpy ((CHAR8 *) Cur, (CHAR8 *) Mode);\r
\r
  for (Index = 0; Index < Token->OptionCount; ++Index) {\r
    Cur = (UINT8 *) AsciiStrCpy ((CHAR8 *) Cur, (CHAR8 *) Options[Index].OptionStr);\r
    Cur = (UINT8 *) AsciiStrCpy ((CHAR8 *) Cur, (CHAR8 *) Options[Index].ValueStr);\r
  }\r
\r
  return Mtftp4SendPacket (Instance, Nbuf);\r
}\r
\r
\r
/**\r
  Build then send an error message\r
\r
  @param  Instance              The MTFTP session\r
  @param  ErrInfo               The error code and message\r
\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory for the error packet\r
  @retval EFI_SUCCESS           The error packet is transmitted.\r
  @retval Others                Failed to transmit the packet.\r
\r
**/\r
EFI_STATUS\r
Mtftp4SendError (\r
  IN MTFTP4_PROTOCOL        *Instance,\r
  IN UINT16                 ErrCode,\r
  IN UINT8*                 ErrInfo\r
  )\r
{\r
  NET_BUF                   *Packet;\r
  EFI_MTFTP4_PACKET         *TftpError;\r
  UINT32                    Len;\r
\r
  Len     = (UINT32) (AsciiStrLen ((CHAR8 *) ErrInfo) + sizeof (EFI_MTFTP4_ERROR_HEADER));\r
  Packet  = NetbufAlloc (Len);\r
\r
  if (Packet == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  TftpError         = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (Packet, Len, FALSE);\r
  TftpError->OpCode = HTONS (EFI_MTFTP4_OPCODE_ERROR);\r
  TftpError->Error.ErrorCode = HTONS (ErrCode);\r
\r
  AsciiStrCpy ((CHAR8 *) TftpError->Error.ErrorMessage, (CHAR8 *) ErrInfo);\r
\r
  return Mtftp4SendPacket (Instance, Packet);\r
}\r
\r
\r
/**\r
  The callback function called when the packet is transmitted.\r
  It simply frees the packet.\r
\r
  @param  Packet                The transmitted (or failed to) packet\r
  @param  Points                The local and remote UDP access point\r
  @param  IoStatus              The result of the transmission\r
  @param  Context               Opaque parameter to the callback\r
\r
  @return None\r
\r
**/\r
STATIC\r
VOID\r
Mtftp4OnPacketSent (\r
  NET_BUF                   *Packet,\r
  UDP_POINTS                *Points,\r
  EFI_STATUS                IoStatus,\r
  VOID                      *Context\r
  )\r
{\r
  NetbufFree (Packet);\r
}\r
\r
\r
/**\r
  Set the timeout for the instance. User a longer time for\r
  passive instances.\r
\r
  @param  Instance              The Mtftp session to set time out\r
\r
  @return None\r
\r
**/\r
VOID\r
Mtftp4SetTimeout (\r
  IN MTFTP4_PROTOCOL        *Instance\r
  )\r
{\r
  if (Instance->Master) {\r
    Instance->PacketToLive = Instance->Timeout;\r
  } else {\r
    Instance->PacketToLive = Instance->Timeout * 2;\r
  }\r
}\r
\r
\r
/**\r
  Send the packet for the instance. It will first save a reference to\r
  the packet for later retransmission. then determine the destination\r
  port, listen port for requests, and connected port for others. At last,\r
  send the packet out.\r
\r
  @param  Instance              The Mtftp instance\r
  @param  Packet                The packet to send\r
\r
  @retval EFI_SUCCESS           The packet is sent out\r
  @retval Others                Failed to transmit the packet.\r
\r
**/\r
EFI_STATUS\r
Mtftp4SendPacket (\r
  IN MTFTP4_PROTOCOL        *Instance,\r
  IN NET_BUF                *Packet\r
  )\r
{\r
  UDP_POINTS                UdpPoint;\r
  EFI_STATUS                Status;\r
  UINT16                    OpCode;\r
  UINT16                    Value;\r
\r
  //\r
  // Save the packet for retransmission\r
  //\r
  if (Instance->LastPacket != NULL) {\r
    NetbufFree (Instance->LastPacket);\r
  }\r
\r
  Instance->LastPacket  = Packet;\r
\r
  Instance->CurRetry    = 0;\r
  Mtftp4SetTimeout (Instance);\r
\r
  UdpPoint.LocalAddr    = 0;\r
  UdpPoint.LocalPort    = 0;\r
  UdpPoint.RemoteAddr   = Instance->ServerIp;\r
\r
  //\r
  // Send the requests to the listening port, other packets\r
  // to the connected port\r
  //\r
  Value = *((UINT16 *) NetbufGetByte (Packet, 0, NULL));\r
  OpCode = NTOHS (Value);\r
\r
  if ((OpCode == EFI_MTFTP4_OPCODE_RRQ) || (OpCode == EFI_MTFTP4_OPCODE_DIR) ||\r
      (OpCode == EFI_MTFTP4_OPCODE_WRQ)) {\r
    UdpPoint.RemotePort = Instance->ListeningPort;\r
  } else {\r
    UdpPoint.RemotePort = Instance->ConnectedPort;\r
  }\r
\r
  NET_GET_REF (Packet);\r
\r
  Status = UdpIoSendDatagram (\r
             Instance->UnicastPort,\r
             Packet,\r
             &UdpPoint,\r
             Instance->Gateway,\r
             Mtftp4OnPacketSent,\r
             Instance\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    NET_PUT_REF (Packet);\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Retransmit the last packet for the instance\r
\r
  @param  Instance              The Mtftp instance\r
\r
  @retval EFI_SUCCESS           The last packet is retransmitted.\r
  @retval Others                Failed to retransmit.\r
\r
**/\r
EFI_STATUS\r
Mtftp4Retransmit (\r
  IN MTFTP4_PROTOCOL        *Instance\r
  )\r
{\r
  UDP_POINTS                UdpPoint;\r
  EFI_STATUS                Status;\r
  UINT16                    OpCode;\r
  UINT16                    Value;\r
\r
  ASSERT (Instance->LastPacket != NULL);\r
\r
  UdpPoint.LocalAddr  = 0;\r
  UdpPoint.LocalPort  = 0;\r
  UdpPoint.RemoteAddr = Instance->ServerIp;\r
\r
  //\r
  // Set the requests to the listening port, other packets to the connected port\r
  //\r
  Value = *(UINT16 *) NetbufGetByte (Instance->LastPacket, 0, NULL);\r
  OpCode = NTOHS (Value);\r
\r
  if ((OpCode == EFI_MTFTP4_OPCODE_RRQ) || (OpCode == EFI_MTFTP4_OPCODE_DIR) ||\r
      (OpCode == EFI_MTFTP4_OPCODE_WRQ)) {\r
    UdpPoint.RemotePort = Instance->ListeningPort;\r
  } else {\r
    UdpPoint.RemotePort = Instance->ConnectedPort;\r
  }\r
\r
  NET_GET_REF (Instance->LastPacket);\r
\r
  Status = UdpIoSendDatagram (\r
             Instance->UnicastPort,\r
             Instance->LastPacket,\r
             &UdpPoint,\r
             Instance->Gateway,\r
             Mtftp4OnPacketSent,\r
             Instance\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    NET_PUT_REF (Instance->LastPacket);\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  The timer ticking function for the Mtftp service instance.\r
\r
  @param  Event                 The ticking event\r
  @param  Context               The Mtftp service instance\r
\r
  @return None\r
\r
**/\r
VOID\r
EFIAPI\r
Mtftp4OnTimerTick (\r
  IN EFI_EVENT              Event,\r
  IN VOID                   *Context\r
  )\r
{\r
  MTFTP4_SERVICE            *MtftpSb;\r
  NET_LIST_ENTRY            *Entry;\r
  NET_LIST_ENTRY            *Next;\r
  MTFTP4_PROTOCOL           *Instance;\r
  EFI_MTFTP4_TOKEN          *Token;\r
\r
  MtftpSb = (MTFTP4_SERVICE *) Context;\r
\r
  //\r
  // Iterate through all the children of the Mtftp service instance. Time\r
  // out the packet. If maximum retries reached, clean the session up.\r
  //\r
  NET_LIST_FOR_EACH_SAFE (Entry, Next, &MtftpSb->Children) {\r
    Instance = NET_LIST_USER_STRUCT (Entry, MTFTP4_PROTOCOL, Link);\r
\r
    if ((Instance->PacketToLive == 0) || (--Instance->PacketToLive > 0)) {\r
      continue;\r
    }\r
\r
    //\r
    // Call the user's time out handler\r
    //\r
    Token = Instance->Token;\r
\r
    if ((Token->TimeoutCallback != NULL) &&\r
        EFI_ERROR (Token->TimeoutCallback (&Instance->Mtftp4, Token))) {\r
\r
      Mtftp4SendError (\r
         Instance,\r
         EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r
         "User aborted the transfer in time out"\r
         );\r
\r
      Mtftp4CleanOperation (Instance, EFI_ABORTED);\r
      continue;\r
    }\r
\r
    //\r
    // Retransmit the packet if haven't reach the maxmium retry count,\r
    // otherwise exit the transfer.\r
    //\r
    if (++Instance->CurRetry < Instance->MaxRetry) {\r
      Mtftp4Retransmit (Instance);\r
      Mtftp4SetTimeout (Instance);\r
    } else {\r
      Mtftp4CleanOperation (Instance, EFI_TIMEOUT);\r
      continue;\r
    }\r
  }\r
}\r
Commit	Line	Data
772db4bb	1	/** @file\r
	2	\r
	3	Copyright (c) 2006 - 2007, Intel Corporation\r
	4	All rights reserved. This program and the accompanying materials\r
	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	Module Name:\r
	13	\r
	14	Mtftp4Support.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	Support routines for Mtftp\r
	19	\r
	20	\r
	21	**/\r
	22	\r
	23	#include "Mtftp4Impl.h"\r
	24	\r
	25	\r
	26	/**\r
	27	Allocate a MTFTP4 block range, then init it to the\r
	28	range of [Start, End]\r
	29	\r
	30	@param Start The start block number\r
	31	@param End The last block number in the range\r
	32	\r
	33	@return NULL if failed to allocate memory, otherwise the created block range.\r
	34	\r
	35	**/\r
	36	STATIC\r
	37	MTFTP4_BLOCK_RANGE *\r
	38	Mtftp4AllocateRange (\r
	39	IN UINT16 Start,\r
	40	IN UINT16 End\r
	41	)\r
	42	{\r
	43	MTFTP4_BLOCK_RANGE *Range;\r
	44	\r
	45	Range = NetAllocatePool (sizeof (MTFTP4_BLOCK_RANGE));\r
	46	\r
	47	if (Range == NULL) {\r
	48	return NULL;\r
	49	}\r
	50	\r
	51	NetListInit (&Range->Link);\r
	52	Range->Start = Start;\r
	53	Range->End = End;\r
	54	\r
	55	return Range;\r
	56	}\r
	57	\r
	58	\r
	59	/**\r
	60	Initialize the block range for either RRQ or WRQ. RRQ and WRQ have\r
	61	different requirements for Start and End. For example, during start\r
	62	up, WRQ initializes its whole valid block range to [0, 0xffff]. This\r
	63	is bacause the server will send us a ACK0 to inform us to start the\r
	64	upload. When the client received ACK0, it will remove 0 from the range,\r
65	get the next block number, which is 1, then upload the BLOCK1. For RRQ\r
66	without option negotiation, the server will directly send us the BLOCK1\r
67	in response to the client's RRQ. When received BLOCK1, the client will\r
68	remove it from the block range and send an ACK. It also works if there\r
69	is option negotiation.\r
70	\r
71	@param Head The block range head to initialize\r
72	@param Start The Start block number.\r
73	@param End The last block number.\r
74	\r
75	@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for initial block range\r
76	@retval EFI_SUCCESS The initial block range is created.\r
77	\r
78	**/\r
79	EFI_STATUS\r
80	Mtftp4InitBlockRange (\r
81	IN NET_LIST_ENTRY *Head,\r
82	IN UINT16 Start,\r
83	IN UINT16 End\r
84	)\r
85	{\r
86	MTFTP4_BLOCK_RANGE *Range;\r
87	\r
88	Range = Mtftp4AllocateRange (Start, End);\r
89	\r
90	if (Range == NULL) {\r
91	return EFI_OUT_OF_RESOURCES;\r
92	}\r
93	\r
94	NetListInsertTail (Head, &Range->Link);\r
95	return EFI_SUCCESS;\r
96	}\r
97	\r
98	\r
99	/**\r
100	Get the first valid block number on the range list.\r
101	\r
102	@param Head The block range head\r
103	\r
104	@return -1: if the block range is empty. Otherwise the first valid block number.\r
105	\r
106	**/\r
107	INTN\r
108	Mtftp4GetNextBlockNum (\r
109	IN NET_LIST_ENTRY *Head\r
110	)\r
111	{\r
112	MTFTP4_BLOCK_RANGE *Range;\r
113	\r
114	if (NetListIsEmpty (Head)) {\r
115	return -1;\r
116	}\r
117	\r
118	Range = NET_LIST_HEAD (Head, MTFTP4_BLOCK_RANGE, Link);\r
119	return Range->Start;\r
120	}\r
121	\r
122	\r
123	/**\r
124	Set the last block number of the block range list. It will\r
125	remove all the blocks after the Last. MTFTP initialize the\r
126	block range to the maximum possible range, such as [0, 0xffff]\r
127	for WRQ. When it gets the last block number, it will call\r
128	this function to set the last block number.\r
129	\r
130	@param Head The block range list\r
131	@param Last The last block number\r
132	\r
133	@return None\r
134	\r
135	**/\r
136	VOID\r
137	Mtftp4SetLastBlockNum (\r
138	IN NET_LIST_ENTRY *Head,\r
139	IN UINT16 Last\r
140	)\r
141	{\r
142	MTFTP4_BLOCK_RANGE *Range;\r
143	\r
144	//\r
145	// Iterate from the tail to head to remove the block number\r
146	// after the last.\r
147	//\r
148	while (!NetListIsEmpty (Head)) {\r
149	Range = NET_LIST_TAIL (Head, MTFTP4_BLOCK_RANGE, Link);\r
150	\r
151	if (Range->Start > Last) {\r
152	NetListRemoveEntry (&Range->Link);\r
153	NetFreePool (Range);\r
154	continue;\r
155	}\r
156	\r
157	if (Range->End > Last) {\r
158	Range->End = Last;\r
159	}\r
160	\r
161	return ;\r
162	}\r
163	}\r
164	\r
165	\r
166	/**\r
167	Remove the block number from the block range list.\r
168	\r
169	@param Head The block range list to remove from\r
170	@param Num The block number to remove\r
171	\r
172	@retval EFI_NOT_FOUND The block number isn't in the block range list\r
173	@retval EFI_SUCCESS The block number has been removed from the list\r
174	@retval EFI_OUT_OF_RESOURCES Failed to allocate resource\r
175	\r
176	**/\r
177	EFI_STATUS\r
178	Mtftp4RemoveBlockNum (\r
179	IN NET_LIST_ENTRY *Head,\r
180	IN UINT16 Num\r
181	)\r
182	{\r
183	MTFTP4_BLOCK_RANGE *Range;\r
184	MTFTP4_BLOCK_RANGE *NewRange;\r
185	NET_LIST_ENTRY *Entry;\r
186	\r
187	NET_LIST_FOR_EACH (Entry, Head) {\r
188	\r
189	//\r
190	// Each block represents a hole [Start, End] in the file,\r
191	// skip to the first range with End >= Num\r
192	//\r
193	Range = NET_LIST_USER_STRUCT (Entry, MTFTP4_BLOCK_RANGE, Link);\r
194	\r
195	if (Range->End < Num) {\r
196	continue;\r
197	}\r
198	\r
199	//\r
200	// There are three different cases for Start\r
201	// 1. (Start > Num) && (End >= Num):\r
202	// because all the holes before this one has the condition of\r
203	// End < Num, so this block number has been removed.\r
204	//\r
205	// 2. (Start == Num) && (End >= Num):\r
206	// Need to increase the Start by one, and if End == Num, this\r
207	// hole has been removed completely, remove it.\r
208	//\r
209	// 3. (Start < Num) && (End >= Num):\r
210	// if End == Num, only need to decrease the End by one because\r
211	// we have (Start < Num) && (Num == End), so (Start <= End - 1).\r
212	// if (End > Num), the hold is splited into two holes, with\r
213	// [Start, Num - 1] and [Num + 1, End].\r
214	//\r
215	if (Range->Start > Num) {\r
216	return EFI_NOT_FOUND;\r
217	\r
218	} else if (Range->Start == Num) {\r
219	Range->Start++;\r
220	\r
221	if (Range->Start > Range->End) {\r
222	NetListRemoveEntry (&Range->Link);\r
223	NetFreePool (Range);\r
224	}\r
225	\r
226	return EFI_SUCCESS;\r
227	\r
228	} else {\r
229	if (Range->End == Num) {\r
230	Range->End--;\r
231	} else {\r
687a2e5f	232	NewRange = Mtftp4AllocateRange ((UINT16) (Num + 1), (UINT16) Range->End);\r
772db4bb	233	\r
	234	if (NewRange == NULL) {\r
	235	return EFI_OUT_OF_RESOURCES;\r
	236	}\r
	237	\r
	238	Range->End = Num - 1;\r
	239	NetListInsertAfter (&Range->Link, &NewRange->Link);\r
	240	}\r
	241	\r
	242	return EFI_SUCCESS;\r
	243	}\r
	244	}\r
	245	\r
	246	return EFI_NOT_FOUND;\r
	247	}\r
	248	\r
	249	\r
	250	/**\r
	251	Build then transmit the request packet for the MTFTP session.\r
	252	\r
	253	@param Instance The Mtftp session\r
	254	\r
	255	@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the request\r
	256	@retval EFI_SUCCESS The request is built and sent\r
	257	@retval Others Failed to transmit the packet.\r
	258	\r
	259	**/\r
	260	EFI_STATUS\r
	261	Mtftp4SendRequest (\r
	262	IN MTFTP4_PROTOCOL *Instance\r
	263	)\r
	264	{\r
	265	EFI_MTFTP4_PACKET *Packet;\r
	266	EFI_MTFTP4_OPTION *Options;\r
	267	EFI_MTFTP4_TOKEN *Token;\r
	268	NET_BUF *Nbuf;\r
	269	UINT8 *Mode;\r
	270	UINT8 *Cur;\r
	271	UINT32 Len;\r
	272	UINTN Index;\r
687a2e5f	273	UINT32 Len1;\r
687a2e5f	274	UINT32 Len2;\r
772db4bb	275	\r
	276	Token = Instance->Token;\r
	277	Options = Token->OptionList;\r
	278	Mode = Instance->Token->ModeStr;\r
	279	\r
	280	if (Mode == NULL) {\r
	281	Mode = "octet";\r
	282	}\r
	283	\r
	284	//\r
	285	// Compute the packet length\r
	286	//\r
687a2e5f	287	Len1 = (UINT32) AsciiStrLen ((CHAR8 *) Token->Filename);\r
	288	Len2 = (UINT32) AsciiStrLen ((CHAR8 *) Mode);\r
	289	Len = (Len1 + Len2 + 4);\r
772db4bb	290	\r
772db4bb	291	for (Index = 0; Index < Token->OptionCount; Index++) {\r
687a2e5f	292	Len1 = (UINT32) AsciiStrLen ((CHAR8 *) Options[Index].OptionStr);\r
	293	Len2 = (UINT32) AsciiStrLen ((CHAR8 *) Options[Index].ValueStr);\r
	294	Len += Len1 + Len2 + 2;\r
772db4bb	295	}\r
	296	\r
	297	//\r
	298	// Allocate a packet then copy the data over\r
	299	//\r
	300	if ((Nbuf = NetbufAlloc (Len)) == NULL) {\r
	301	return EFI_OUT_OF_RESOURCES;\r
	302	}\r
	303	\r
	304	Packet = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (Nbuf, Len, FALSE);\r
	305	Packet->OpCode = HTONS (Instance->Operation);\r
	306	Cur = Packet->Rrq.Filename;\r
687a2e5f	307	Cur = (UINT8 ) AsciiStrCpy ((CHAR8 ) Cur, (CHAR8 *) Token->Filename);\r
687a2e5f	308	Cur = (UINT8 ) AsciiStrCpy ((CHAR8 ) Cur, (CHAR8 *) Mode);\r
772db4bb	309	\r
772db4bb	310	for (Index = 0; Index < Token->OptionCount; ++Index) {\r
687a2e5f	311	Cur = (UINT8 ) AsciiStrCpy ((CHAR8 ) Cur, (CHAR8 *) Options[Index].OptionStr);\r
687a2e5f	312	Cur = (UINT8 ) AsciiStrCpy ((CHAR8 ) Cur, (CHAR8 *) Options[Index].ValueStr);\r
772db4bb	313	}\r
	314	\r
	315	return Mtftp4SendPacket (Instance, Nbuf);\r
	316	}\r
	317	\r
	318	\r
	319	/**\r
	320	Build then send an error message\r
	321	\r
	322	@param Instance The MTFTP session\r
	323	@param ErrInfo The error code and message\r
	324	\r
	325	@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet\r
	326	@retval EFI_SUCCESS The error packet is transmitted.\r
	327	@retval Others Failed to transmit the packet.\r
	328	\r
	329	**/\r
	330	EFI_STATUS\r
	331	Mtftp4SendError (\r
	332	IN MTFTP4_PROTOCOL *Instance,\r
	333	IN UINT16 ErrCode,\r
	334	IN UINT8* ErrInfo\r
	335	)\r
	336	{\r
	337	NET_BUF *Packet;\r
	338	EFI_MTFTP4_PACKET *TftpError;\r
	339	UINT32 Len;\r
	340	\r
687a2e5f	341	Len = (UINT32) (AsciiStrLen ((CHAR8 *) ErrInfo) + sizeof (EFI_MTFTP4_ERROR_HEADER));\r
772db4bb	342	Packet = NetbufAlloc (Len);\r
	343	\r
	344	if (Packet == NULL) {\r
	345	return EFI_OUT_OF_RESOURCES;\r
	346	}\r
	347	\r
	348	TftpError = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (Packet, Len, FALSE);\r
	349	TftpError->OpCode = HTONS (EFI_MTFTP4_OPCODE_ERROR);\r
	350	TftpError->Error.ErrorCode = HTONS (ErrCode);\r
	351	\r
687a2e5f	352	AsciiStrCpy ((CHAR8 ) TftpError->Error.ErrorMessage, (CHAR8 ) ErrInfo);\r
772db4bb	353	\r
	354	return Mtftp4SendPacket (Instance, Packet);\r
	355	}\r
	356	\r
	357	\r
	358	/**\r
	359	The callback function called when the packet is transmitted.\r
	360	It simply frees the packet.\r
	361	\r
	362	@param Packet The transmitted (or failed to) packet\r
	363	@param Points The local and remote UDP access point\r
	364	@param IoStatus The result of the transmission\r
	365	@param Context Opaque parameter to the callback\r
	366	\r
	367	@return None\r
	368	\r
	369	**/\r
	370	STATIC\r
	371	VOID\r
	372	Mtftp4OnPacketSent (\r
	373	NET_BUF *Packet,\r
	374	UDP_POINTS *Points,\r
	375	EFI_STATUS IoStatus,\r
	376	VOID *Context\r
	377	)\r
	378	{\r
	379	NetbufFree (Packet);\r
	380	}\r
	381	\r
	382	\r
	383	/**\r
	384	Set the timeout for the instance. User a longer time for\r
	385	passive instances.\r
	386	\r
	387	@param Instance The Mtftp session to set time out\r
	388	\r
	389	@return None\r
	390	\r
	391	**/\r
	392	VOID\r
	393	Mtftp4SetTimeout (\r
	394	IN MTFTP4_PROTOCOL *Instance\r
	395	)\r
	396	{\r
	397	if (Instance->Master) {\r
	398	Instance->PacketToLive = Instance->Timeout;\r
	399	} else {\r
	400	Instance->PacketToLive = Instance->Timeout * 2;\r
	401	}\r
	402	}\r
	403	\r
	404	\r
	405	/**\r
	406	Send the packet for the instance. It will first save a reference to\r
	407	the packet for later retransmission. then determine the destination\r
	408	port, listen port for requests, and connected port for others. At last,\r
	409	send the packet out.\r
	410	\r
	411	@param Instance The Mtftp instance\r
	412	@param Packet The packet to send\r
	413	\r
	414	@retval EFI_SUCCESS The packet is sent out\r
	415	@retval Others Failed to transmit the packet.\r
	416	\r
417	**/\r
418	EFI_STATUS\r
419	Mtftp4SendPacket (\r
420	IN MTFTP4_PROTOCOL *Instance,\r
421	IN NET_BUF *Packet\r
422	)\r
423	{\r
424	UDP_POINTS UdpPoint;\r
425	EFI_STATUS Status;\r
426	UINT16 OpCode;\r
687a2e5f	427	UINT16 Value;\r
772db4bb	428	\r
	429	//\r
	430	// Save the packet for retransmission\r
	431	//\r
	432	if (Instance->LastPacket != NULL) {\r
	433	NetbufFree (Instance->LastPacket);\r
	434	}\r
	435	\r
	436	Instance->LastPacket = Packet;\r
	437	\r
	438	Instance->CurRetry = 0;\r
	439	Mtftp4SetTimeout (Instance);\r
	440	\r
	441	UdpPoint.LocalAddr = 0;\r
	442	UdpPoint.LocalPort = 0;\r
	443	UdpPoint.RemoteAddr = Instance->ServerIp;\r
	444	\r
	445	//\r
	446	// Send the requests to the listening port, other packets\r
	447	// to the connected port\r
	448	//\r
687a2e5f	449	Value = ((UINT16 ) NetbufGetByte (Packet, 0, NULL));\r
687a2e5f	450	OpCode = NTOHS (Value);\r
772db4bb	451	\r
	452	if ((OpCode == EFI_MTFTP4_OPCODE_RRQ) \|\| (OpCode == EFI_MTFTP4_OPCODE_DIR) \|\|\r
	453	(OpCode == EFI_MTFTP4_OPCODE_WRQ)) {\r
	454	UdpPoint.RemotePort = Instance->ListeningPort;\r
	455	} else {\r
	456	UdpPoint.RemotePort = Instance->ConnectedPort;\r
	457	}\r
	458	\r
	459	NET_GET_REF (Packet);\r
	460	\r
	461	Status = UdpIoSendDatagram (\r
	462	Instance->UnicastPort,\r
	463	Packet,\r
	464	&UdpPoint,\r
	465	Instance->Gateway,\r
	466	Mtftp4OnPacketSent,\r
	467	Instance\r
	468	);\r
	469	\r
	470	if (EFI_ERROR (Status)) {\r
	471	NET_PUT_REF (Packet);\r
	472	}\r
	473	\r
	474	return Status;\r
	475	}\r
	476	\r
	477	\r
	478	/**\r
	479	Retransmit the last packet for the instance\r
	480	\r
	481	@param Instance The Mtftp instance\r
	482	\r
	483	@retval EFI_SUCCESS The last packet is retransmitted.\r
	484	@retval Others Failed to retransmit.\r
	485	\r
	486	**/\r
	487	EFI_STATUS\r
	488	Mtftp4Retransmit (\r
	489	IN MTFTP4_PROTOCOL *Instance\r
	490	)\r
	491	{\r
	492	UDP_POINTS UdpPoint;\r
	493	EFI_STATUS Status;\r
	494	UINT16 OpCode;\r
687a2e5f	495	UINT16 Value;\r
772db4bb	496	\r
	497	ASSERT (Instance->LastPacket != NULL);\r
	498	\r
	499	UdpPoint.LocalAddr = 0;\r
	500	UdpPoint.LocalPort = 0;\r
	501	UdpPoint.RemoteAddr = Instance->ServerIp;\r
	502	\r
	503	//\r
	504	// Set the requests to the listening port, other packets to the connected port\r
	505	//\r
687a2e5f	506	Value = (UINT16 ) NetbufGetByte (Instance->LastPacket, 0, NULL);\r
687a2e5f	507	OpCode = NTOHS (Value);\r
772db4bb	508	\r
	509	if ((OpCode == EFI_MTFTP4_OPCODE_RRQ) \|\| (OpCode == EFI_MTFTP4_OPCODE_DIR) \|\|\r
	510	(OpCode == EFI_MTFTP4_OPCODE_WRQ)) {\r
	511	UdpPoint.RemotePort = Instance->ListeningPort;\r
	512	} else {\r
	513	UdpPoint.RemotePort = Instance->ConnectedPort;\r
	514	}\r
	515	\r
	516	NET_GET_REF (Instance->LastPacket);\r
	517	\r
	518	Status = UdpIoSendDatagram (\r
	519	Instance->UnicastPort,\r
	520	Instance->LastPacket,\r
	521	&UdpPoint,\r
	522	Instance->Gateway,\r
	523	Mtftp4OnPacketSent,\r
	524	Instance\r
	525	);\r
	526	\r
	527	if (EFI_ERROR (Status)) {\r
	528	NET_PUT_REF (Instance->LastPacket);\r
	529	}\r
	530	\r
	531	return Status;\r
	532	}\r
	533	\r
	534	\r
	535	/**\r
	536	The timer ticking function for the Mtftp service instance.\r
	537	\r
	538	@param Event The ticking event\r
	539	@param Context The Mtftp service instance\r
	540	\r
	541	@return None\r
	542	\r
	543	**/\r
	544	VOID\r
	545	EFIAPI\r
	546	Mtftp4OnTimerTick (\r
	547	IN EFI_EVENT Event,\r
	548	IN VOID *Context\r
	549	)\r
	550	{\r
	551	MTFTP4_SERVICE *MtftpSb;\r
	552	NET_LIST_ENTRY *Entry;\r
	553	NET_LIST_ENTRY *Next;\r
	554	MTFTP4_PROTOCOL *Instance;\r
	555	EFI_MTFTP4_TOKEN *Token;\r
	556	\r
	557	MtftpSb = (MTFTP4_SERVICE *) Context;\r
	558	\r
	559	//\r
	560	// Iterate through all the children of the Mtftp service instance. Time\r
	561	// out the packet. If maximum retries reached, clean the session up.\r
	562	//\r
	563	NET_LIST_FOR_EACH_SAFE (Entry, Next, &MtftpSb->Children) {\r
	564	Instance = NET_LIST_USER_STRUCT (Entry, MTFTP4_PROTOCOL, Link);\r
	565	\r
	566	if ((Instance->PacketToLive == 0) \|\| (--Instance->PacketToLive > 0)) {\r
	567	continue;\r
	568	}\r
	569	\r
	570	//\r
	571	// Call the user's time out handler\r
572	//\r
573	Token = Instance->Token;\r
574	\r
575	if ((Token->TimeoutCallback != NULL) &&\r
576	EFI_ERROR (Token->TimeoutCallback (&Instance->Mtftp4, Token))) {\r
577	\r
578	Mtftp4SendError (\r
579	Instance,\r
580	EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r
581	"User aborted the transfer in time out"\r
582	);\r
583	\r
584	Mtftp4CleanOperation (Instance, EFI_ABORTED);\r
585	continue;\r
586	}\r
587	\r
588	//\r
589	// Retransmit the packet if haven't reach the maxmium retry count,\r
590	// otherwise exit the transfer.\r
591	//\r
592	if (++Instance->CurRetry < Instance->MaxRetry) {\r
593	Mtftp4Retransmit (Instance);\r
594	Mtftp4SetTimeout (Instance);\r
595	} else {\r
596	Mtftp4CleanOperation (Instance, EFI_TIMEOUT);\r
597	continue;\r
598	}\r
599	}\r
600	}\r