Update the copyright notice format

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / Tcp4Output.c

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Output.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Output.c
index 39fbc3b73562c032a075986102dbee4c38fe7b03..6e08ac9cdb64bd44f4900af6beb1433d61c849a5 100644 (file)
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Output.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Output.c
@@ -1,23 +1,15 @@
 /** @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
@@ -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
@@ -124,8 +115,8 @@ TcpRcvWinNow (
 **/\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
@@ -199,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
@@ -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
@@ -296,8 +286,8 @@ SetPersistTimer:
 **/\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
@@ -306,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
@@ -435,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
@@ -455,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
@@ -530,7 +522,7 @@ TcpGetSegmentSndQue (
   //\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
@@ -572,7 +564,7 @@ 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
@@ -592,7 +584,7 @@ TcpGetSegmentSock (
     // 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
@@ -633,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
@@ -646,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
@@ -692,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
@@ -703,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
@@ -731,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
@@ -743,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
@@ -760,6 +752,7 @@ 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) != 0) {\r
@@ -807,11 +800,15 @@ SEND_AGAIN:
     //\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
-      DEBUG ((EFI_D_INFO, "TcpToSendData: send FIN "\r
-        "to peer for TCB %p 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
@@ -823,8 +820,8 @@ 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
@@ -838,9 +835,6 @@ SEND_AGAIN:
   }\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
@@ -856,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
@@ -915,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
@@ -949,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
@@ -960,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
@@ -996,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
@@ -1015,8 +1004,7 @@ 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
@@ -1060,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