[dts] [PATCH v1 1/2] test_plans: add test plan for ptp client sample

[dts] [PATCH v1 1/2] test_plans: add test plan for ptp client sample

[Yong Liu]

From: Marvin Liu <yong.liu@intel.com>

The PTP (Precision Time Protocol) client sample application is a simple
example of using the DPDK IEEE1588 API to communicate with a PTP master clock
to synchronize the time on the NIC and, optionally, on the Linux system.

Signed-off-by: Marvin Liu <yong.liu@intel.com>

diff --git a/test_plans/ieee1588_sample_test_plan.rst b/test_plans/ieee1588_sample_test_plan.rst
new file mode 100644
index 0000000..862019f
--- /dev/null
+++ b/test_plans/ieee1588_sample_test_plan.rst
@@ -0,0 +1,79 @@
+.. Copyright (c) <2015> Intel Corporation
+   All rights reserved.
+
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions
+   are met:
+
+   - Redistributions of source code must retain the above copyright
+     notice, this list of conditions and the following disclaimer.
+
+   - 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.
+
+   - Neither the name of Intel Corporation nor the names of its
+     contributors may be used to endorse or promote products derived
+     from this software without specific prior written permission.
+
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+   COPYRIGHT OWNER 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.
+   
+================
+ IEEE1588 Sample
+================
+
+The PTP (Precision Time Protocol) client sample application is a simple
+example of using the DPDK IEEE1588 API to communicate with a PTP master clock
+to synchronize the time on the NIC and, optionally, on the Linux system.
+
+
+Prerequisites
+=============
+Assume one port are connected to the tester and tester has been installed
+"linuxptp.x86_64".
+
+The sample should be validated on Forville, Niantic and i350 Nics. 
+
+Test case: ptp client
+=====================
+Start ptp server on tester with IEEE 802.3 network transport.
+    ptp4l -i p785p1 -2 -m
+
+Start ptp client on DUT and wait few seconds.
+    ./examples/ptpclient/build/ptpclient -c f -n 3 -- -T 0 -p 0x1
+
+Check that output message contained T1,T2,T3,T4 clock and time difference
+between master and slave time is about 10us in niantic, 20us in Fortville,
+8us in i350.
+
+Test case: update system
+========================
+Reset DUT clock to initial time and make sure system time has been changed.
+    date -s "1970-01-01 00:00:00" 
+
+Strip DUT and tester board system time.
+    date +"%s.%N"
+
+Start ptp server on tester with IEEE 802.3 network transport.
+    ptp4l -i p785p1 -2 -m
+
+Start ptp client on DUT and wait few seconds.
+    ./examples/ptpclient/build/ptpclient -c f -n 3 -- -T 1 -p 0x1
+
+Make sure DUT system time has been changed to same as tester.
+
+Check that output message contained T1,T2,T3,T4 clock and time difference
+between master and slave time is about 10us in niantic, 20us in Fortville,
+8us in i350.
-- 
1.9.3

[dts] [PATCH v1 2/2] tests ieee1588_sample: add test suite for ptp client

[Yong Liu]

From: Marvin Liu <yong.liu@intel.com>

Case "ptp client" checked that the sample can acted as ptp client, and work
with real ptp master.
Case "update system" checked that after synced with server, the sample can
update kernel system time normally.

Signed-off-by: Marvin Liu <yong.liu@intel.com>

diff --git a/tests/TestSuite_ieee1588_sample.py b/tests/TestSuite_ieee1588_sample.py
new file mode 100644
index 0000000..5d1ffae
--- /dev/null
+++ b/tests/TestSuite_ieee1588_sample.py
@@ -0,0 +1,222 @@
+# BSD LICENSE
+#
+# Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#   * 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.
+#   * Neither the name of Intel Corporation nor the names of its
+#     contributors may be used to endorse or promote products derived
+#     from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER 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.
+
+"""
+DPDK Test suite.
+Test ieee1588 sample
+"""
+
+import dts
+import time
+import re
+from test_case import TestCase
+from pmd_output import PmdOutput
+from packet import Packet, sniff_packets, load_sniff_packets
+import random
+
+
+class TestIeee1588Sample(TestCase):
+
+    def set_up_all(self):
+        """
+        Run at the start of each test suite.
+        """
+        self.ports = self.dut.get_ports()
+        self.verify(len(self.ports) >= 2, "No ports found for " + self.nic)
+
+        # enable ieee1588 first
+        if "bsdapp" in self.target:
+            self.dut.send_expect("sed -i -e 's/IEEE1588=n$/IEEE1588=y/' config/common_bsdapp", "# ", 30)
+        else:
+            self.dut.send_expect("sed -i -e 's/IEEE1588=n$/IEEE1588=y/' config/common_linuxapp", "# ", 30)
+
+        self.dut.skip_setup = False
+        self.dut.build_install_dpdk(self.target)
+
+        # build sample app
+        out = self.dut.send_expect("make -C examples/ptpclient", "# ")
+        self.verify("Error" not in out, "compilation error 1")
+        self.verify("No such file" not in out, "compilation error 2")
+
+        self.path = "./examples/ptpclient/build/ptpclient"
+        port = self.ports[0]
+        self.portmask = dts.create_mask([port])
+
+        # verify ptp server installed
+        out = self.tester.send_expect("whereis ptp4l", "# ")
+        print out
+        self.verify("/usr/sbin/ptp4l" in out, "Please install PTP Boundary/Ordinary Clock in tester for validation")
+
+        # start ptp server
+        tester_port = self.tester.get_local_port(port)
+        intf = self.tester.get_interface(tester_port)
+        self.tester.send_expect("ptp4l -i %s -2 -m" % intf, "assuming the grand master role", 60)
+
+    def set_up(self):
+        """
+        Run before each test case.
+        """
+        pass
+
+    def test_ptp_client(self):
+        """
+        Test ptpclient sync time from ptp server
+        """
+        cmd = "%s -c f -n %d -- -T 0 -p %s 2>&1 > /tmp/output.log &" % (self.path, self.dut.get_memory_channels(), self.portmask)
+        self.dut.send_expect(cmd, "# ")
+        # wait for ptpclient startup and ptp sync done
+        time.sleep(60)
+
+        output = self.dut.send_expect("cat /tmp/output.log", "# ")
+
+        separator = "[Ctrl+C to quit]"
+        # find the last one
+        last_end = output.rfind(separator)
+        output_last = output[:last_end]
+        last_start = output_last.rfind(separator)
+        sync_output = output_last[last_start:]
+
+        t1, t2, t3, t4, ms_delta, _ = self.strip_ptp_output(sync_output)
+        print dts.GREEN("Master and slave delta is %d ns" % ms_delta)
+        self.verify(abs(t2 - t1) < 0.02, "Master and slave clock not sync")
+        self.verify(abs(t4 - t3) < 0.02, "Master and slave second clock not sync")
+        self.verify(abs(ms_delta) < 5000, "Master and slave clock delta over size")
+
+        self.dut.send_expect("killall ptpclient", "# ")
+
+    def test_update_system(self):
+        """
+        Test ptpclient can set system time after synced
+        """
+        # reset dut board system time
+        self.dut.send_expect("date -s \"1970-01-01 00:00:00\"", "# ")
+        cmd = "%s -c f -n %d -- -T 1 -p %s 2>&1 > /tmp/output.log &" % (self.path, self.dut.get_memory_channels(), self.portmask)
+        self.dut.send_expect(cmd, "# ")
+        # wait for ptpclient startup and ptp sync done
+        time.sleep(60)
+
+        output = self.dut.send_expect("cat /tmp/output.log", "# ")
+
+        separator = "[Ctrl+C to quit]"
+        # find the last one
+        last_end = output.rfind(separator)
+        output_last = output[:last_end]
+        last_start = output_last.rfind(separator)
+        sync_output = output_last[last_start:]
+
+        t1, t2, t3, t4, ms_delta, pl_delta = self.strip_ptp_output(sync_output)
+        print dts.GREEN("PTP server and linux kernel delta is %d ns" % ms_delta)
+        self.verify(abs(t2 - t1) < 0.02, "Master and slave clock not sync")
+        self.verify(abs(t4 - t3) < 0.02, "Master and slave second clock not sync")
+        self.verify(abs(ms_delta) < 5000, "Master and slave clock delta over size")
+        self.verify(abs(pl_delta) < 5000, "PTP server and linux kernel clock delta over size")
+
+        self.dut.send_expect("killall ptpclient", "# ")
+        # strip dut system time
+        out = self.dut.send_expect("date +\"%s.%N\"", "# ")
+        time_str = out.split()[0]
+        dut_time = float(time_str)
+        # strip tester system time
+        out = self.tester.alt_session.send_expect("date +\"%s.%N\"", "# ")
+        time_str = out.split()[0]
+        tester_time = float(time_str)
+        self.verify(abs(tester_time - dut_time) < 2.0, "Failed to sync DUT kernel clock")
+
+    def strip_ptp_output(self, output):
+        lines = output.split("\n")
+        lines.remove("")
+        T2_pat = r"T2 - Slave  Clock.  (\d+)s (\d+)ns"
+        T1_pat = r"T1 - Master Clock.  (\d+)s (\d+)ns"
+        T3_pat = r"T3 - Slave  Clock.  (\d+)s (\d+)ns"
+        T4_pat = r"T4 - Master Clock.  (\d+)s (\d+)ns"
+        ms_pat = r"Delta between master and slave clocks:([-]?)(\d+)ns"
+        pl_pat = r"Delta between PTP and Linux Kernel time:([-]?)(\d+)ns"
+
+        # default value
+        t1 = 0.0
+        t2 = 0.0
+        t3 = 0.0
+        t4 = 0.0
+        delta_ms = 0.0
+        delta_pl = 0.0
+
+        for line in lines:
+            m_t2 = re.match(T2_pat, line)
+            m_t1 = re.match(T1_pat, line)
+            m_t3 = re.match(T3_pat, line)
+            m_t4 = re.match(T4_pat, line)
+            m_delta_ms = re.match(ms_pat, line)
+            m_delta_pl = re.match(pl_pat, line)
+            if m_t2:
+                t2sec = int(m_t2.group(1))
+                t2ns = int(m_t2.group(2))
+                t2 = t2sec + t2ns * 10e-10
+            if m_t1:
+                t1sec = int(m_t1.group(1))
+                t1ns = int(m_t1.group(2))
+                t1 = t1sec + t1ns * 10e-10
+            if m_t3:
+                t3sec = int(m_t3.group(1))
+                t3ns = int(m_t3.group(2))
+                t3 = t3sec + t3ns * 10e-10
+            if m_t4:
+                t4sec = int(m_t4.group(1))
+                t4ns = int(m_t4.group(2))
+                t4 = t4sec + t4ns * 10e-10
+            if m_delta_ms:
+                delta_ms = int(m_delta_ms.group(2))
+                if m_delta_ms.group(1) is "-":
+                    delta_ms = delta_ms * (-1)
+            if m_delta_pl:
+                delta_pl = int(m_delta_pl.group(2))
+                if m_delta_pl.group(1) is "-":
+                    delta_pl = delta_pl * (-1)
+
+        return (t1, t2, t3, t3, delta_ms, delta_pl)
+
+    def tear_down(self):
+        """
+        Run after each test case.
+        """
+        self.dut.kill_all()
+        pass
+
+    def tear_down_all(self):
+        """
+        Run after each test suite.
+        """
+        self.tester.send_expect("^C", "# ")
+        # Restore the config file and recompile the package.
+        if "bsdapp" in self.target:
+            self.dut.send_expect("sed -i -e 's/IEEE1588=y$/IEEE1588=n/' config/common_bsdapp", "# ", 30)
+        else:
+            self.dut.send_expect("sed -i -e 's/IEEE1588=y$/IEEE1588=n/' config/common_linuxapp", "# ", 30)
+        self.dut.build_install_dpdk(self.target)
-- 
1.9.3