#!/usr/bin/perl
#
# Copyright (C) 1999,2000 Yokogawa Electric Corporation and
#                         YDC Corporation.
# All rights reserved.
# 
# Redistribution and use of this software in source and binary
# forms, with or without modification, are permitted provided that
# the following conditions and disclaimer are agreed and accepted
# by the user:
# 
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in
#    the documentation and/or other materials provided with
#    the distribution.
# 
# 3. Neither the names of the copyrighters, the name of the project
#    which is related to this software (hereinafter referred to as
#    "project") nor the names of the contributors may be used to
#    endorse or promote products derived from this software without
#    specific prior written permission.
# 
# 4. No merchantable use may be permitted without prior written
#    notification to the copyrighters.
# 
# 5. The copyrighters, the project and the contributors may prohibit
#    the use of this software at any time.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHTERS, THE PROJECT AND
# CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING
# BUT NOT LIMITED THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.  IN NO EVENT SHALL THE
# COPYRIGHTERS, THE PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# $Id: RH_IntermediateNode.seq,v 1.1.1.1 2000/10/31 22:39:52 sekiya Exp $
#
######################################################################
BEGIN {
	$V6evalTool::TestVersion = '$Name:  $';
}

use V6evalTool;

if ($V6evalTool::NutDef{Type} ne 'router') {
    vLogHTML("This test is for the router only<BR>");
    exit $V6evalTool::exitRouterOnly;
}

%pktdesc = (
	packet_to_link0		=> 'Send Packet to Link0 (Router1 to Router2)',
	packet_from_link1	=> 'Recv Packet from Link1 (Router2 to Router3)',
	packet_to_link1		=> 'Send Packet to Link1 (Router3 to Router2)',
	packet_from_link0	=> 'Recv Packet from Link0 (Router2 to Router1)',

	na_to_link0		=> 'Send Neighbor Advertisement to Link0 (Global Address)',
	na_to_link0_ll		=> 'Send Neighbor Advertisement to Link0 (Link Local Address)',
	na_to_link1		=> 'Send Neighbor Advertisement to Link1 (Global Address)',
	na_to_link1_ll		=> 'Send Neighbor Advertisement to Link1 (Link Local Address)',

	ns_from_link0		=> 'Recv Neighbor Solicitation from Link0 (Global Address)',
	ns_from_link0_ll	=> 'Recv Neighbor Solicitation from Link0 (Link Local Address)',
	ns_from_link1		=> 'Recv Neighbor Solicitation from Link1 (Global Address)',
	ns_from_link1_ll	=> 'Recv Neighbor Solicitation from Link1 (Link Local Address)',

);

$IF0 = Link0;
$IF1 = Link1;

#----- start capturing

vCapture($IF0);
vCapture($IF1);

#======================================================================

vSend($IF0, packet_to_link0);

%ret = vRecv($IF1, 5, 0, 0, ns_from_link1, ns_from_link1_ll, packet_from_link1);
if ($ret{status} != 0) {
	vLogHTML('<FONT COLOR="#FF0000">NG</FONT>');
	exit $V6evalTool::exitFail;
}

if ($ret{recvFrame} eq 'ns_from_link1') {
	vSend($IF1, na_to_link1);
	%ret = vRecv($IF1, 5, 0, 0, packet_from_link1);
	if ($ret{status} != 0) {
		vLogHTML('<FONT COLOR="#FF0000">NG</FONT>');
		exit $V6evalTool::exitFail;
	}
}
if ($ret{recvFrame} eq 'ns_from_link1_ll') {
	vSend($IF1, na_to_link1_ll);
	%ret = vRecv($IF1, 5, 0, 0, packet_from_link1);
	if ($ret{status} != 0) {
		vLogHTML('<FONT COLOR="#FF0000">NG</FONT>');
		exit $V6evalTool::exitFail;
	}
}
if ($ret{recvFrame} ne 'packet_from_link1') {
	vLogHTML('<FONT COLOR="#FF0000">NG</FONT>');
	exit $V6evalTool::exitFail;
}

vSend($IF1, packet_to_link1);

%ret = vRecv($IF0, 5, 0, 0, ns_from_link0, ns_from_link0_ll, packet_from_link0);
if ($ret{status} != 0) {
	vLogHTML('<FONT COLOR="#FF0000">NG</FONT>');
	exit $V6evalTool::exitFail;
}
if ($ret{recvFrame} eq 'ns_from_link0') {
	vSend($IF0, na_to_link0);
	%ret = vRecv($IF0, 5, 0, 0, packet_from_link0);
	if ($ret{status} != 0) {
		vLogHTML('<FONT COLOR="#FF0000">NG</FONT>');
		exit $V6evalTool::exitFail;
	}
}
if ($ret{recvFrame} eq 'ns_from_link0_ll') {
	vSend($IF0, na_to_link0_ll);
	%ret = vRecv($IF0, 5, 0, 0, packet_from_link0);
	if ($ret{status} != 0) {
		vLogHTML('<FONT COLOR="#FF0000">NG</FONT>');
		exit $V6evalTool::exitFail;
	}
}
if ($ret{recvFrame} ne 'packet_from_link0') {
	vLogHTML('<FONT COLOR="#FF0000">NG</FONT>');
	exit $V6evalTool::exitFail;
}

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

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

=head1 NAME

  RH_IntermediateNode - check Routing Header Processing (Intermediate Node)

=head1 TARGET

  Router

=head1 SYNOPSIS

=begin html
<PRE>
  <A HREF="./RH_IntermediateNode.seq">RH_IntermediateNode.seq</A> [-tooloption ...] -pkt <A HREF="./RH_IntermediateNode.def">RH_IntermediateNode.def</A>
    -tooloption : v6eval tool option
  See also <A HREF="./RH.def">RH.def</A>
</PRE>

=end html

=head1 INITIALIZATION

  None

=head1 TEST PROCEDURE

  Tester                      Target                      Tester
              (Link0)                     (Link1)
    |                           |                           |
    |-------------------------->|                           |
    |   Packet to Link0         |                           |
    |                           |                           |
    |                           |-------------------------->|
    |                           |   Neighbor Solicitation   |
    |                           |                           |
    |                           |<--------------------------|
    |                           |   Neighbor Advertisement  |
    |                           |                           |
    |                           |-------------------------->|
    |                           |   Packet from Link1       |
    |                           |                           |
    |                           |                           |
    |                           |<--------------------------|
    |                           |   Packet to Link1         |
    |                           |                           |
    |<--------------------------|                           |
    |   Neighbor Solicitation   |                           |
    |                           |                           |
    |-------------------------->|                           |
    |   Neighbor Advertisement  |                           |
    |                           |                           |
    |<--------------------------|                           |
    |   Packet from Link0       |                           |
    |                           |                           |
    v                           v                           v

  1. Send Packet to Link0
  2. Wait Packet from Link1 or NS from Link1
  3. If NS received then send NA to Link1, and wait Packet form Link1 again
  4. Receive Packet from Link1
  5. Send Packet to Link1
  6. Wait Packet from Link0 or NS from Link0
  7. If NS received then send NA to Link0, and wait Packet form Link0 again
  8. Receive Packet from Link0

  Network topology

                        (Link0)        (Link1)
                 Tester         Target         Tester
    Host1 ------ Router1 ------ Router2 ------ Router3 ------ Host2
         Global 2       Global 0       Global 1       Global 3

  Packet to Link0 is:

        IPv6 Header
            Version            = 6
            Traffic Class      = 0
            FlowLabel          = 0
            PayloadLength      = 56
            NextHeader         = 43 (Routing Header)
            SourceAddress      = Global 2 Address (Host1)
            DestinationAddress = Global 0 Address (Router2)

        Routing Header
            NextHeader      = 59 (No Next Header)
            HeaderExtLength = 6 
            RoutingType     = 0 
            SegmentsLeft    = 2 
            Address[1]      = Global 2 Address (Router1)
            Address[2]      = Global 1 Address (Router3)
            Address[3]      = Global 3 Address (Host2)

  Packet to Link1 is:

        IPv6 Header
            Version            = 6
            Traffic Class      = 0
            FlowLabel          = 0
            PayloadLength      = 56
            NextHeader         = 43 (Routing Header)
            SourceAddress      = Global 3 Address (Host2)
            DestinationAddress = Global 1 Address (Router2)

        Routing Header
            NextHeader      = 59 (No Next Header)
            HeaderExtLength = 6 
            RoutingType     = 0 
            SegmentsLeft    = 2 
            Address[1]      = Global 3 Address (Router3)
            Address[2]      = Global 0 Address (Router1)
            Address[3]      = Global 2 Address (Host1)


  Neighbor Solicitation packet's IP source Address selection may be:
    - Link Local Address
    - Global Address
  This test IS NOT the Neighbor Discovery test, so admit both implementation.

=head1 JUDGEMENT

  PASS: Packet from Link1 and Packet from Link0 Received

    Packet from Link1 is:

        IPv6 Header
            Version            = 6
            Traffic Class      = 0
            FlowLabel          = 0
            PayloadLength      = 56
            NextHeader         = 43 (Routing Header)
            SourceAddress      = Global 2 Address (Host1)
            DestinationAddress = Global 1 Address (Router3) <-+
                                                              |
        Routing Header                                        |
            NextHeader      = 59 (No Next Header)             | (swapped)
            HeaderExtLength = 6                               |
            RoutingType     = 0                               |
            SegmentsLeft    = 1 (decremented)                 |
            Address[1]      = Global 2 Address (Router1) <----+
            Address[2]      = Global 0 Address (Router2)
            Address[3]      = Global 3 Address (Host2)


    Packet from Link0 is:

        IPv6 Header
            Version            = 6
            Traffic Class      = 0
            FlowLabel          = 0
            PayloadLength      = 56
            NextHeader         = 43 (Routing Header)
            SourceAddress      = Global 3 Address (Host2)
            DestinationAddress = Global 0 Address (Router1) <-+
                                                              |
        Routing Header                                        |
            NextHeader      = 59 (No Next Header)             | (swapped)
            HeaderExtLength = 6                               |
            RoutingType     = 0                               |
            SegmentsLeft    = 1 (decremented)                 |
            Address[1]      = Global 3 Address (Router3)      |
            Address[2]      = Global 1 Address (Router2)      |
            Address[3]      = Global 2 Address (Host1) <------+

=head1 SEE ALSO

  perldoc V6evalTool

=cut