]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Output.c
Update the copyright notice format
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / Tcp4Output.c
index 707bc3ada3b08727c5c67b2ab355ae07b4e455ec..6e08ac9cdb64bd44f4900af6beb1433d61c849a5 100644 (file)
@@ -1,28 +1,20 @@
 /** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+  TCP output process routines.\r
+    \r
+Copyright (c) 2005 - 2009, Intel Corporation. All rights reserved.<BR>\r
+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
+http://opensource.org/licenses/bsd-license.php<BR>\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
-  Tcp4Output.c\r
-\r
-Abstract:\r
-\r
-  TCP output process routines.\r
-\r
-\r
 **/\r
 \r
 #include "Tcp4Main.h"\r
 \r
-STATIC UINT8  mTcpOutFlag[] = {\r
+UINT8  mTcpOutFlag[] = {\r
   0,                          // TCP_CLOSED\r
   0,                          // TCP_LISTEN\r
   TCP_FLG_SYN,                // TCP_SYN_SENT\r
@@ -85,7 +77,7 @@ TcpRcvWinNow (
   UINT32  OldWin;\r
 \r
   Sk = Tcb->Sk;\r
-  ASSERT (Sk);\r
+  ASSERT (Sk != NULL);\r
 \r
   OldWin    = TcpRcvWinOld (Tcb);\r
 \r
@@ -112,8 +104,7 @@ TcpRcvWinNow (
 \r
 \r
 /**\r
-  Compute the value to fill in the window size field\r
-  of the outgoing segment.\r
+  Compute the value to fill in the window size field of the outgoing segment.\r
 \r
   @param  Tcb     Pointer to the TCP_CB of this TCP instance.\r
   @param  Syn     The flag to indicate whether the outgoing segment is a SYN\r
@@ -122,11 +113,10 @@ TcpRcvWinNow (
   @return The value of the local receive window size used to fill the outing segment.\r
 \r
 **/\r
-STATIC\r
 UINT16\r
 TcpComputeWnd (\r
-  IN TCP_CB  *Tcb,\r
-  IN BOOLEAN Syn\r
+  IN OUT TCP_CB  *Tcb,\r
+  IN     BOOLEAN Syn\r
   )\r
 {\r
   UINT32  Wnd;\r
@@ -162,10 +152,10 @@ TcpGetMaxSndNxt (
   IN TCP_CB *Tcb\r
   )\r
 {\r
-  NET_LIST_ENTRY  *Entry;\r
+  LIST_ENTRY      *Entry;\r
   NET_BUF         *Nbuf;\r
 \r
-  if (NetListIsEmpty (&Tcb->SndQue)) {\r
+  if (IsListEmpty (&Tcb->SndQue)) {\r
     return Tcb->SndNxt;\r
   }\r
 \r
@@ -200,7 +190,7 @@ TcpDataToSend (
   UINT32  Limit;\r
 \r
   Sk = Tcb->Sk;\r
-  ASSERT (Sk);\r
+  ASSERT (Sk != NULL);\r
 \r
   //\r
   // TCP should NOT send data beyond the send window\r
@@ -236,7 +226,7 @@ TcpDataToSend (
     Len = Tcb->SndMss;\r
   }\r
 \r
-  if (Force || (Len == 0 && Left == 0)) {\r
+  if ((Force != 0)|| (Len == 0 && Left == 0)) {\r
     return Len;\r
   }\r
 \r
@@ -271,8 +261,9 @@ TcpDataToSend (
 SetPersistTimer:\r
   if (!TCP_TIMER_ON (Tcb->EnabledTimer, TCP_TIMER_REXMIT)) {\r
 \r
-    TCP4_DEBUG_WARN (\r
-      ("TcpDataToSend: enter persistent state for TCB %x\n",\r
+    DEBUG (\r
+      (EFI_D_WARN,\r
+      "TcpDataToSend: enter persistent state for TCB %p\n",\r
       Tcb)\r
       );\r
 \r
@@ -284,8 +275,7 @@ SetPersistTimer:
 \r
 \r
 /**\r
-  Build the TCP header of the TCP segment and transmit the\r
-  segment by IP.\r
+  Build the TCP header of the TCP segment and transmit the segment by IP.\r
 \r
   @param  Tcb     Pointer to the TCP_CB of this TCP instance.\r
   @param  Nbuf    Pointer to the buffer containing the segment to be sent out.\r
@@ -294,11 +284,10 @@ SetPersistTimer:
   @retval other   Error condition occurred.\r
 \r
 **/\r
-STATIC\r
 INTN\r
 TcpTransmitSegment (\r
-  IN TCP_CB  *Tcb,\r
-  IN NET_BUF *Nbuf\r
+  IN OUT TCP_CB  *Tcb,\r
+  IN     NET_BUF *Nbuf\r
   )\r
 {\r
   UINT16    Len;\r
@@ -307,7 +296,7 @@ TcpTransmitSegment (
   BOOLEAN   Syn;\r
   UINT32    DataLen;\r
 \r
-  ASSERT (Nbuf && (Nbuf->Tcp == NULL) && TcpVerifySegment (Nbuf));\r
+  ASSERT ((Nbuf != NULL) && (Nbuf->Tcp == NULL) && (TcpVerifySegment (Nbuf) != 0));\r
 \r
   DataLen = Nbuf->TotalSize;\r
 \r
@@ -425,8 +414,8 @@ TcpGetSegmentSndQue (
   IN UINT32    Len\r
   )\r
 {\r
-  NET_LIST_ENTRY  *Head;\r
-  NET_LIST_ENTRY  *Cur;\r
+  LIST_ENTRY      *Head;\r
+  LIST_ENTRY      *Cur;\r
   NET_BUF         *Node;\r
   TCP_SEG         *Seg;\r
   NET_BUF         *Nbuf;\r
@@ -436,7 +425,7 @@ TcpGetSegmentSndQue (
   INT32           Offset;\r
   INT32           CopyLen;\r
 \r
-  ASSERT (Tcb && TCP_SEQ_LEQ (Seq, Tcb->SndNxt) && (Len > 0));\r
+  ASSERT ((Tcb != NULL) && TCP_SEQ_LEQ (Seq, Tcb->SndNxt) && (Len > 0));\r
 \r
   //\r
   // Find the segment that contains the Seq.\r
@@ -456,7 +445,9 @@ TcpGetSegmentSndQue (
     }\r
   }\r
 \r
-  ASSERT (Cur != Head);\r
+  ASSERT (Cur  != Head);\r
+  ASSERT (Node != NULL);\r
+  ASSERT (Seg  != NULL);\r
 \r
   //\r
   // Return the buffer if it can be returned without\r
@@ -529,16 +520,16 @@ TcpGetSegmentSndQue (
   //\r
   // copy data to the segment\r
   //\r
-  if (CopyLen) {\r
+  if (CopyLen != 0) {\r
     Data = NetbufAllocSpace (Nbuf, CopyLen, NET_BUF_TAIL);\r
-    ASSERT (Data);\r
+    ASSERT (Data != NULL);\r
 \r
     if ((INT32) NetbufCopy (Node, Offset, CopyLen, Data) != CopyLen) {\r
       goto OnError;\r
     }\r
   }\r
 \r
-  NetCopyMem (TCPSEG_NETBUF (Nbuf), Seg, sizeof (TCP_SEG));\r
+  CopyMem (TCPSEG_NETBUF (Nbuf), Seg, sizeof (TCP_SEG));\r
 \r
   TCPSEG_NETBUF (Nbuf)->Seq   = Seq;\r
   TCPSEG_NETBUF (Nbuf)->End   = End;\r
@@ -573,13 +564,13 @@ TcpGetSegmentSock (
   UINT8   *Data;\r
   UINT32  DataGet;\r
 \r
-  ASSERT (Tcb && Tcb->Sk);\r
+  ASSERT ((Tcb != NULL) && (Tcb->Sk != NULL));\r
 \r
   Nbuf = NetbufAlloc (Len + TCP_MAX_HEAD);\r
 \r
   if (Nbuf == NULL) {\r
-    TCP4_DEBUG_ERROR (("TcpGetSegmentSock: failed to allocate "\r
-      "a netbuf for TCB %x\n",Tcb));\r
+    DEBUG ((EFI_D_ERROR, "TcpGetSegmentSock: failed to allocate "\r
+      "a netbuf for TCB %p\n",Tcb));\r
 \r
     return NULL;\r
   }\r
@@ -588,12 +579,12 @@ TcpGetSegmentSock (
 \r
   DataGet = 0;\r
 \r
-  if (Len) {\r
+  if (Len != 0) {\r
     //\r
     // copy data to the segment.\r
     //\r
     Data = NetbufAllocSpace (Nbuf, Len, NET_BUF_TAIL);\r
-    ASSERT (Data);\r
+    ASSERT (Data != NULL);\r
 \r
     DataGet = SockGetDataToSend (Tcb->Sk, 0, Len, Data);\r
   }\r
@@ -603,7 +594,7 @@ TcpGetSegmentSock (
   TCPSEG_NETBUF (Nbuf)->Seq = Seq;\r
   TCPSEG_NETBUF (Nbuf)->End = Seq + Len;\r
 \r
-  NetListInsertTail (&(Tcb->SndQue), &(Nbuf->List));\r
+  InsertTailList (&(Tcb->SndQue), &(Nbuf->List));\r
 \r
   if (DataGet != 0) {\r
 \r
@@ -634,7 +625,7 @@ TcpGetSegment (
 {\r
   NET_BUF *Nbuf;\r
 \r
-  ASSERT (Tcb);\r
+  ASSERT (Tcb != NULL);\r
 \r
   //\r
   // Compare the SndNxt with the max sequence number sent.\r
@@ -647,7 +638,7 @@ TcpGetSegment (
     Nbuf = TcpGetSegmentSock (Tcb, Seq, Len);\r
   }\r
 \r
-  ASSERT (TcpVerifySegment (Nbuf));\r
+  ASSERT (TcpVerifySegment (Nbuf) != 0);\r
   return Nbuf;\r
 }\r
 \r
@@ -679,8 +670,8 @@ TcpRetransmit (
   // 3. will not change the boundaries of queued segments.\r
   //\r
   if (TCP_SEQ_LT (Tcb->SndWl2 + Tcb->SndWnd, Seq)) {\r
-    TCP4_DEBUG_WARN (("TcpRetransmit: retransmission cancelled "\r
-      "because send window too small for TCB %x\n", Tcb));\r
+    DEBUG ((EFI_D_WARN, "TcpRetransmit: retransmission cancelled "\r
+      "because send window too small for TCB %p\n", Tcb));\r
 \r
     return 0;\r
   }\r
@@ -693,7 +684,7 @@ TcpRetransmit (
     return -1;\r
   }\r
 \r
-  ASSERT (TcpVerifySegment (Nbuf));\r
+  ASSERT (TcpVerifySegment (Nbuf) != 0);\r
 \r
   if (TcpTransmitSegment (Tcb, Nbuf) != 0) {\r
     goto OnError;\r
@@ -704,7 +695,7 @@ TcpRetransmit (
   // trim TCP head because all the buffer on SndQue\r
   // are headless.\r
   //\r
-  ASSERT (Nbuf->Tcp);\r
+  ASSERT (Nbuf->Tcp != NULL);\r
   NetbufTrim (Nbuf, (Nbuf->Tcp->HeadLen << 2), NET_BUF_HEAD);\r
   Nbuf->Tcp = NULL;\r
 \r
@@ -732,8 +723,8 @@ OnError:
 **/\r
 INTN\r
 TcpToSendData (\r
-  IN TCP_CB *Tcb,\r
-  IN INTN Force\r
+  IN OUT TCP_CB *Tcb,\r
+  IN     INTN Force\r
   )\r
 {\r
   UINT32    Len;\r
@@ -744,7 +735,7 @@ TcpToSendData (
   TCP_SEQNO Seq;\r
   TCP_SEQNO End;\r
 \r
-  ASSERT (Tcb && Tcb->Sk && (Tcb->State != TCP_LISTEN));\r
+  ASSERT ((Tcb != NULL) && (Tcb->Sk != NULL) && (Tcb->State != TCP_LISTEN));\r
 \r
   Sent = 0;\r
 \r
@@ -761,9 +752,10 @@ SEND_AGAIN:
   Len   = TcpDataToSend (Tcb, Force);\r
   Seq   = Tcb->SndNxt;\r
 \r
+  ASSERT ((Tcb->State) < (sizeof (mTcpOutFlag) / sizeof (mTcpOutFlag[0])));\r
   Flag  = mTcpOutFlag[Tcb->State];\r
 \r
-  if (Flag & TCP_FLG_SYN) {\r
+  if ((Flag & TCP_FLG_SYN) != 0) {\r
 \r
     Seq = Tcb->Iss;\r
     Len = 0;\r
@@ -773,15 +765,17 @@ SEND_AGAIN:
   // only send a segment without data if SYN or\r
   // FIN is set.\r
   //\r
-  if ((Len == 0) && !(Flag & (TCP_FLG_SYN | TCP_FLG_FIN))) {\r
+  if ((Len == 0) && \r
+      ((Flag & (TCP_FLG_SYN | TCP_FLG_FIN)) == 0)) {\r
     return Sent;\r
   }\r
 \r
   Nbuf = TcpGetSegment (Tcb, Seq, Len);\r
 \r
   if (Nbuf == NULL) {\r
-    TCP4_DEBUG_ERROR (\r
-      ("TcpToSendData: failed to get a segment for TCB %x\n",\r
+    DEBUG (\r
+      (EFI_D_ERROR,\r
+      "TcpToSendData: failed to get a segment for TCB %p\n",\r
       Tcb)\r
       );\r
 \r
@@ -799,18 +793,22 @@ SEND_AGAIN:
     End++;\r
   }\r
 \r
-  if (Flag & TCP_FLG_FIN) {\r
+  if ((Flag & TCP_FLG_FIN) != 0) {\r
     //\r
     // Send FIN if all data is sent, and FIN is\r
     // in the window\r
     //\r
     if ((TcpGetMaxSndNxt (Tcb) == Tcb->SndNxt) &&\r
         (GET_SND_DATASIZE (Tcb->Sk) == 0) &&\r
-        TCP_SEQ_LT (End + 1, Tcb->SndWnd + Tcb->SndWl2)\r
-          ) {\r
-\r
-      TCP4_DEBUG_TRACE (("TcpToSendData: send FIN "\r
-        "to peer for TCB %x in state %d\n", Tcb, Tcb->State));\r
+        TCP_SEQ_LT (End + 1, Tcb->SndWnd + Tcb->SndWl2)) {\r
+\r
+      DEBUG (\r
+               (EFI_D_INFO, \r
+               "TcpToSendData: send FIN "\r
+        "to peer for TCB %p in state %s\n", \r
+        Tcb, \r
+        mTcpStateName[Tcb->State])\r
+      );\r
 \r
       End++;\r
     } else {\r
@@ -822,28 +820,25 @@ SEND_AGAIN:
   Seg->End  = End;\r
   Seg->Flag = Flag;\r
 \r
-  ASSERT (TcpVerifySegment (Nbuf));\r
-  ASSERT (TcpCheckSndQue (&Tcb->SndQue));\r
+  ASSERT (TcpVerifySegment (Nbuf) != 0);\r
+  ASSERT (TcpCheckSndQue (&Tcb->SndQue) != 0);\r
 \r
   //\r
   // don't send an empty segment here.\r
   //\r
   if (Seg->End == Seg->Seq) {\r
-    TCP4_DEBUG_WARN (("TcpToSendData: created a empty"\r
-      " segment for TCB %x, free it now\n", Tcb));\r
+    DEBUG ((EFI_D_WARN, "TcpToSendData: created a empty"\r
+      " segment for TCB %p, free it now\n", Tcb));\r
 \r
     NetbufFree (Nbuf);\r
     return Sent;\r
   }\r
 \r
   if (TcpTransmitSegment (Tcb, Nbuf) != 0) {\r
-    //\r
-    // TODO: double check this\r
-    //\r
     NetbufTrim (Nbuf, (Nbuf->Tcp->HeadLen << 2), NET_BUF_HEAD);\r
     Nbuf->Tcp = NULL;\r
 \r
-    if (Flag & TCP_FLG_FIN) {\r
+    if ((Flag & TCP_FLG_FIN) != 0)  {\r
       TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_FIN_SENT);\r
     }\r
 \r
@@ -855,7 +850,7 @@ SEND_AGAIN:
   //\r
   // All the buffer in the SndQue is headless\r
   //\r
-  ASSERT (Nbuf->Tcp);\r
+  ASSERT (Nbuf->Tcp != NULL);\r
 \r
   NetbufTrim (Nbuf, (Nbuf->Tcp->HeadLen << 2), NET_BUF_HEAD);\r
   Nbuf->Tcp = NULL;\r
@@ -867,7 +862,7 @@ SEND_AGAIN:
   //\r
   Tcb->DelayedAck = 0;\r
 \r
-  if (Flag & TCP_FLG_FIN) {\r
+  if ((Flag & TCP_FLG_FIN) != 0) {\r
     TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_FIN_SENT);\r
   }\r
 \r
@@ -886,8 +881,8 @@ SEND_AGAIN:
   if ((Tcb->CongestState == TCP_CONGEST_OPEN) &&\r
       !TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_RTT_ON)) {\r
 \r
-    TCP4_DEBUG_TRACE (("TcpToSendData: set RTT measure "\r
-      "sequence %d for TCB %x\n", Seq, Tcb));\r
+    DEBUG ((EFI_D_INFO, "TcpToSendData: set RTT measure "\r
+      "sequence %d for TCB %p\n", Seq, Tcb));\r
 \r
     TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_RTT_ON);\r
     Tcb->RttSeq     = Seq;\r
@@ -914,12 +909,10 @@ OnError:
 \r
   @param  Tcb     Pointer to the TCP_CB of this TCP instance.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 TcpSendAck (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   )\r
 {\r
   NET_BUF *Nbuf;\r
@@ -948,8 +941,7 @@ TcpSendAck (
 \r
 \r
 /**\r
-  Send a zero probe segment. It can be used by keepalive\r
-  and zero window probe.\r
+  Send a zero probe segment. It can be used by keepalive and zero window probe.\r
 \r
   @param  Tcb     Pointer to the TCP_CB of this TCP instance.\r
 \r
@@ -959,7 +951,7 @@ TcpSendAck (
 **/\r
 INTN\r
 TcpSendZeroProbe (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   )\r
 {\r
   NET_BUF *Nbuf;\r
@@ -995,12 +987,10 @@ TcpSendZeroProbe (
 \r
   @param  Tcb     Pointer to the TCP_CB of this TCP instance.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 TcpToSendAck (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   )\r
 {\r
   UINT32 TcpNow;\r
@@ -1014,14 +1004,13 @@ TcpToSendAck (
   //\r
   if (TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_ACK_NOW) ||\r
       (Tcb->DelayedAck >= 1) ||\r
-      (TcpNow > TcpRcvWinOld (Tcb))\r
-      ) {\r
+      (TcpNow > TcpRcvWinOld (Tcb))) {\r
     TcpSendAck (Tcb);\r
     return;\r
   }\r
 \r
-  TCP4_DEBUG_TRACE (("TcpToSendAck: scheduled a delayed"\r
-    " ACK for TCB %x\n", Tcb));\r
+  DEBUG ((EFI_D_INFO, "TcpToSendAck: scheduled a delayed"\r
+    " ACK for TCB %p\n", Tcb));\r
 \r
   //\r
   // schedule a delayed ACK\r
@@ -1059,7 +1048,7 @@ TcpSendReset (
   //\r
   // Don't respond to a Reset with reset\r
   //\r
-  if (Head->Flag & TCP_FLG_RST) {\r
+  if ((Head->Flag & TCP_FLG_RST) != 0) {\r
     return 0;\r
   }\r
 \r
@@ -1182,14 +1171,14 @@ TcpVerifySegment (
 **/\r
 INTN\r
 TcpCheckSndQue (\r
-  IN NET_LIST_ENTRY *Head\r
+  IN LIST_ENTRY     *Head\r
   )\r
 {\r
-  NET_LIST_ENTRY  *Entry;\r
+  LIST_ENTRY      *Entry;\r
   NET_BUF         *Nbuf;\r
   TCP_SEQNO       Seq;\r
 \r
-  if (NetListIsEmpty (Head)) {\r
+  if (IsListEmpty (Head)) {\r
     return 1;\r
   }\r
   //\r