#!/usr/bin/perl
#
# SCTP Conformance Test Suite Implementation
# (C) Copyright Fujitsu Ltd. 2008, 2009
#
# This file is part of the SCTP Conformance Test Suite implementation.
#
# The SCTP Conformance Test Suite implementation is free software;
# you can redistribute it and/or modify it under the terms of
# the GNU General Public License version 2 as published by
# the Free Software Foundation.
#
# The SCTP Conformance Test Suite implementation is distributed in the
# hope that it will be useful, but WITHOUT ANY WARRANTY; without even
# the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
# PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU CC; see the file COPYING.  If not, write to
# the Free Software Foundation, 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA.
#
# Please send any bug reports or fixes you make to the
# email address(es):
#    networktest sctp <networktest-sctp@lists.sourceforge.net>
#
# Or submit a bug report through the following website:
#    http://networktest.sourceforge.net/
#
# Written or modified by:
#    Hiroaki Kago <linuxsctp-kg@ml.css.fujitsu.com>
#    Wei Yongjun <yjwei@cn.fujitsu.com>
#
# Any bugs reported given to us we will try to fix... any fixes shared will
# be incorporated into the next SCTP release.
#
##############################################################################
BEGIN {	$V6evalTool::TestVersion = '$Name: REL_1_0_0 $'; }

use lib "../common";
use V6evalTool;
use SCTP;

%pktdesc = (
	sctp_chunk_data_a1	=> "Send SCTP CHUNK_DATA (A1)",
	sctp_chunk_sack_a1	=> "Recv SCTP CHUNK_SACK (A1)",
	sctp_chunk_data_a2	=> "Send SCTP CHUNK_DATA (A2)",
	sctp_chunk_sack_a2	=> "Recv SCTP CHUNK_SACK (A2)",
	sctp_chunk_data_a3	=> "Send SCTP CHUNK_DATA (A3)",
	sctp_chunk_sack_a3	=> "Recv SCTP CHUNK_SACK (A3)",
	sctp_chunk_data_a4	=> "Send SCTP CHUNK_DATA (A4)",
	sctp_chunk_sack_a4	=> "Recv SCTP CHUNK_SACK (A4)",
	sctp_chunk_data_r1	=> "Recv SCTP CHUNK_DATA (R1)",
	sctp_chunk_sack_r1	=> "Send SCTP CHUNK_SACK (R1)",
	sctp_chunk_data_r2	=> "Recv SCTP CHUNK_DATA (R2)",
	sctp_chunk_sack_r2	=> "Send SCTP CHUNK_SACK (R2)",
	sctp_chunk_data_r3	=> "Recv SCTP CHUNK_DATA (R3)",
	sctp_chunk_sack_r3	=> "Send SCTP CHUNK_SACK (R3)",
	sctp_chunk_data_r4	=> "Recv SCTP CHUNK_DATA (R4)",
	sctp_chunk_sack_r4	=> "Send SCTP CHUNK_SACK (R4)",
);

$IF0 = Link0;

vCapture($IF0);

sctpCheckEnv($IF0);

sctpStartEchoServer($IF0);

vConnect($IF0);

# Send A4
vSendMsg($IF0, sctp_chunk_data_a4, sctp_chunk_sack_a4);
# Send A3
vSendMsg($IF0, sctp_chunk_data_a3, sctp_chunk_sack_a3);
# Send A2
vSendMsg($IF0, sctp_chunk_data_a2, sctp_chunk_sack_a2);

vLogHTML('<B>================ Main Test =================</B>');

# Send A1
sctpUpdateSendTSN();
vSend($IF0, sctp_chunk_data_a1);

# Recv R1
sctpUpdateRecvACK();
%ret = vWarpRecv($IF0, 10, 0, 0, sctp_chunk_sack_a1, sctp_chunk_data_r1);
if ($ret{status} != 0) {
	vLogHTML('Cannot receive SCTP CHUNK_SACK<BR>');
	vLogHTML('<FONT COLOR="#00FF00">NG</FONT>'); 
	exit $V6evalTool::exitFail;
}

if ($ret{status} == 0 && $ret{recvFrame} eq sctp_chunk_sack_a1) {
	%ret = vWarpRecv($IF0, 10, 0, 0, sctp_chunk_data_r1);
	if($ret{status} != 0 || $ret{recvFrame} ne sctp_chunk_data_r1) {
		vLogHTML('Cannot receive SCTP CHUNK_SACK<BR>');
		vLogHTML('<FONT COLOR="#00FF00">NG</FONT>'); 
		exit $V6evalTool::exitFail;
	}
}

vSend($IF0, sctp_chunk_sack_r1);

# Recv R2
sctpUpdateRecvACK();
%ret = vWarpRecv($IF0, 10, 0, 0, sctp_chunk_sack_a1, sctp_chunk_data_r2);
if ($ret{status} != 0) {
	vLogHTML('Cannot receive SCTP CHUNK_SACK<BR>');
	vLogHTML('<FONT COLOR="#00FF00">NG</FONT>'); 
	exit $V6evalTool::exitFail;
}

if ($ret{status} == 0 && $ret{recvFrame} eq sctp_chunk_sack_a1) {
	%ret = vWarpRecv($IF0, 10, 0, 0, sctp_chunk_data_r2);
	if($ret{status} != 0 || $ret{recvFrame} ne sctp_chunk_data_r2) {
		vLogHTML('Cannot receive SCTP CHUNK_SACK<BR>');
		vLogHTML('<FONT COLOR="#00FF00">NG</FONT>'); 
		exit $V6evalTool::exitFail;
	}
}

vSend($IF0, sctp_chunk_sack_r2);

# Recv R3
sctpUpdateRecvACK();
%ret = vWarpRecv($IF0, 10, 0, 0, sctp_chunk_sack_a1, sctp_chunk_data_r3);
if ($ret{status} != 0) {
	vLogHTML('Cannot receive SCTP CHUNK_SACK<BR>');
	vLogHTML('<FONT COLOR="#00FF00">NG</FONT>'); 
	exit $V6evalTool::exitFail;
}

if ($ret{status} == 0 && $ret{recvFrame} eq sctp_chunk_sack_a1) {
	%ret = vWarpRecv($IF0, 10, 0, 0, sctp_chunk_data_r3);
	if($ret{status} != 0 || $ret{recvFrame} ne sctp_chunk_data_r3) {
		vLogHTML('Cannot receive SCTP CHUNK_SACK<BR>');
		vLogHTML('<FONT COLOR="#00FF00">NG</FONT>'); 
		exit $V6evalTool::exitFail;
	}
}

vSend($IF0, sctp_chunk_sack_r3);

# Recv R4
sctpUpdateRecvACK();
%ret = vWarpRecv($IF0, 10, 0, 0, sctp_chunk_sack_a1, sctp_chunk_data_r4);
if ($ret{status} != 0) {
	vLogHTML('Cannot receive SCTP CHUNK_SACK<BR>');
	vLogHTML('<FONT COLOR="#00FF00">NG</FONT>'); 
	exit $V6evalTool::exitFail;
}

if ($ret{status} == 0 && $ret{recvFrame} eq sctp_chunk_sack_a1) {
	%ret = vWarpRecv($IF0, 10, 0, 0, sctp_chunk_data_r4);
	if($ret{status} != 0 || $ret{recvFrame} ne sctp_chunk_data_r4) {
		vLogHTML('Cannot receive SCTP CHUNK_SACK<BR>');
		vLogHTML('<FONT COLOR="#00FF00">NG</FONT>'); 
		exit $V6evalTool::exitFail;
	}
}

vSend($IF0, sctp_chunk_sack_r4);

vClose($IF0);

vLogHTML(OK);
exit $V6evalTool::exitPass;

######################################################################
__END__

=head1 NAME

  SO_MixA4A3A2A1.seq - Ordered Data chunks are received for Re-order (A4->A3->A2->A1)

=head1 PURPOSE

  To check that if DATA chunks arrive out of order of their stream
  sequence number, the endpoint MUST hold the received DATA chunks
  from delivery to the ULP until they are re-ordered.

=head1 SYNOPSIS

=begin html
<PRE>
  <A HREF="./SO_MixA4A3A2A1.seq">./SO_MixA4A3A2A1.seq</A> [-tooloption ...] -pkt <A HREF="./SO_Segment.def">./SO_Segment.def</A>
    -tooloption : v6eval tool option
  See Also: <A HREF="../common/STD_PKT_COMMON.def">../common/STD_PKT_COMMON.def</A>
            <A HREF="../common/SCTP_COMMON.def">../common/SCTP_COMMON.def</A>
</PRE>

=end html

=head1 PRE-TEST CONDITION

  Association is established between endpoint A and B. Arrange data in
  endpoint A such that ordered DATA messages are sent to endpoint B.

=head1 TEST PROCEDURE

  Endpoint A                           Endpoint B                ULP
  (ESTABLISHED)                        (ESTABLISHED)

  DATA A4      ---------------->
  [Strm=0, Seq=3]
               <----------------        SACK

  DATA A3      ---------------->
  [Strm=0, Seq=2]
               <----------------        SACK

  DATA A2      ---------------->
  [Strm=0, Seq=1]
               <----------------        SACK

  DATA A1      ---------------->
  [Strm=0, Seq=0]
               <----------------        SACK
                                        DATA A1, A2, A3, A4 Arrive       ----->
               <----------------        DATA R1 (ECHO of A1)

  SACK         ---------------->

               <----------------        DATA R2 (ECHO of A2)

  SACK         ---------------->

               <----------------        DATA R3 (ECHO of A3)

               <----------------        DATA R4 (ECHO of A4)

  SACK         ---------------->

  TEST DESCRIPTION:

  1. Send DATA A4 from endpoint A to B with Strm=0 and Seq=3.
  2. Check A: DATA A4 is not delivered to the ULP.
  3. Send DATA A3 from endpoint A to B with Strm=0 and Seq=2.
  4. Check B: DATA A3 is not delivered to the ULP.
  5. Send DATA A2 from endpoint A to B with Strm=0 and Seq=1.
  6. Check C: DATA A2 is not delivered to the ULP.
  7. Send DATA A1 from endpoint A to B with Strm=0 and Seq=0.
  8. Check D: DATA A1, A2, A3 and A4 is delivered to the ULP and be send back.

=head1 NOTE

  None

=head1 REFERENCE

  RFC 4960

  6.6.  Ordered and Unordered Delivery

=begin html
<PRE>
    Within a stream, an endpoint MUST deliver DATA chunks received with
    the U flag set to 0 to the upper layer according to the order of
    their Stream Sequence Number.  If DATA chunks arrive out of order of
    their Stream Sequence Number, the endpoint MUST hold the received
    DATA chunks from delivery to the ULP until they are reordered.
</PRE>

=end html

    However, an SCTP endpoint can indicate that no ordered delivery is
    required for a particular DATA chunk transmitted within the stream by
    setting the U flag of the DATA chunk to 1.