BIER: fix support for longer bit-string lengths
[vpp.git] / test / test_bier.py
index 03ae52a..a70dd09 100644 (file)
@@ -3,7 +3,7 @@
 import unittest
 import socket
 
-from framework import VppTestCase, VppTestRunner
+from framework import VppTestCase, VppTestRunner, running_extended_tests
 from vpp_ip_route import VppIpRoute, VppRoutePath, VppMplsRoute, \
     VppMplsTable, VppIpMRoute, VppMRoutePath, VppIpTable, \
     MRouteEntryFlags, MRouteItfFlags, MPLS_LABEL_INVALID, DpoProto
@@ -66,13 +66,13 @@ class TestBier(VppTestCase):
             i.admin_down()
         super(TestBier, self).tearDown()
 
-    def test_bier_midpoint(self):
+    def bier_midpoint(self, hdr_len_id, n_bytes, max_bp):
         """BIER midpoint"""
 
         #
         # Add a BIER table for sub-domain 0, set 0, and BSL 256
         #
-        bti = VppBierTableID(0, 0, BIERLength.BIER_LEN_256)
+        bti = VppBierTableID(0, 0, hdr_len_id)
         bt = VppBierTable(self, bti, 77)
         bt.add_vpp_config()
 
@@ -81,8 +81,7 @@ class TestBier(VppTestCase):
         #
         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
              MPLS(label=77, ttl=255) /
-             BIER(length=BIERLength.BIER_LEN_256,
-                  BitString=chr(0)*64) /
+             BIER(length=hdr_len_id) /
              IPv6(src=self.pg0.remote_ip6, dst=self.pg0.remote_ip6) /
              UDP(sport=1234, dport=1234) /
              Raw())
@@ -98,7 +97,7 @@ class TestBier(VppTestCase):
         #
         nh_routes = []
         bier_routes = []
-        for i in range(1, 256):
+        for i in range(1, max_bp+1):
             nh = "10.0.%d.%d" % (i / 255, i % 255)
             nh_routes.append(VppIpRoute(self, nh, 32,
                                         [VppRoutePath(self.pg1.remote_ip4,
@@ -112,60 +111,92 @@ class TestBier(VppTestCase):
             bier_routes[-1].add_vpp_config()
 
         #
-        # A packet with all bits set gets spat out to BP:1
-        #
-        p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
-             MPLS(label=77, ttl=255) /
-             BIER(length=BIERLength.BIER_LEN_256) /
-             IPv6(src=self.pg0.remote_ip6, dst=self.pg0.remote_ip6) /
-             UDP(sport=1234, dport=1234) /
-             Raw())
-        pkts = [p]
-
-        self.pg0.add_stream(pkts)
-        self.pg_enable_capture(self.pg_interfaces)
-        self.pg_start()
-
-        rx = self.pg1.get_capture(255)
-
-        for rxp in rx:
-            #
-            # The packets are not required to be sent in bit-position order
-            # when we setup the routes above we used the bit-position to
-            # construct the out-label. so use that here to determine the BP
-            #
-            olabel = rxp[MPLS]
-            bp = olabel.label - 2000
-
-            blabel = olabel[MPLS].payload
-            self.assertEqual(blabel.label, 100+bp)
-            self.assertEqual(blabel.ttl, 254)
-
-            bier_hdr = blabel[MPLS].payload
-
-            self.assertEqual(bier_hdr.id, 5)
-            self.assertEqual(bier_hdr.version, 0)
-            self.assertEqual(bier_hdr.length, BIERLength.BIER_LEN_256)
-            self.assertEqual(bier_hdr.entropy, 0)
-            self.assertEqual(bier_hdr.OAM, 0)
-            self.assertEqual(bier_hdr.RSV, 0)
-            self.assertEqual(bier_hdr.DSCP, 0)
-            self.assertEqual(bier_hdr.Proto, 5)
-
-            # The bit-string should consist only of the BP given by i.
-            i = 0
-            bitstring = ""
-            bpi = bp - 1
-            while (i < bpi/8):
-                bitstring = chr(0) + bitstring
-                i += 1
-            bitstring = chr(1 << bpi % 8) + bitstring
-
-            while len(bitstring) < 32:
-                bitstring = chr(0) + bitstring
-
-            self.assertEqual(len(bitstring), len(bier_hdr.BitString))
-            self.assertEqual(bitstring, bier_hdr.BitString)
+        # A packet with all bits set gets replicated once for each bit
+        #
+        pkt_sizes = [64, 1400]
+
+        for pkt_size in pkt_sizes:
+            p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
+                 MPLS(label=77, ttl=255) /
+                 BIER(length=hdr_len_id, BitString=chr(255)*n_bytes) /
+                 IPv6(src=self.pg0.remote_ip6, dst=self.pg0.remote_ip6) /
+                 UDP(sport=1234, dport=1234) /
+                 Raw(chr(5) * pkt_size))
+            pkts = p
+
+            self.pg0.add_stream(pkts)
+            self.pg_enable_capture(self.pg_interfaces)
+            self.pg_start()
+
+            rx = self.pg1.get_capture(max_bp)
+
+            for rxp in rx:
+                #
+                # The packets are not required to be sent in bit-position order
+                # when we setup the routes above we used the bit-position to
+                # construct the out-label. so use that here to determine the BP
+                #
+                olabel = rxp[MPLS]
+                bp = olabel.label - 2000
+
+                blabel = olabel[MPLS].payload
+                self.assertEqual(blabel.label, 100+bp)
+                self.assertEqual(blabel.ttl, 254)
+
+                bier_hdr = blabel[MPLS].payload
+
+                self.assertEqual(bier_hdr.id, 5)
+                self.assertEqual(bier_hdr.version, 0)
+                self.assertEqual(bier_hdr.length, hdr_len_id)
+                self.assertEqual(bier_hdr.entropy, 0)
+                self.assertEqual(bier_hdr.OAM, 0)
+                self.assertEqual(bier_hdr.RSV, 0)
+                self.assertEqual(bier_hdr.DSCP, 0)
+                self.assertEqual(bier_hdr.Proto, 5)
+
+                # The bit-string should consist only of the BP given by i.
+                byte_array = ['\0'] * (n_bytes)
+                byte_val = chr(1 << (bp - 1) % 8)
+                byte_pos = n_bytes - (((bp - 1) / 8) + 1)
+                byte_array[byte_pos] = byte_val
+                bitstring = ''.join(byte_array)
+
+                self.assertEqual(len(bitstring), len(bier_hdr.BitString))
+                self.assertEqual(bitstring, bier_hdr.BitString)
+
+        #
+        # cleanup. not strictly necessary, but it's much quicker this way
+        # becuase the bier_fib_dump and ip_fib_dump will be empty when the
+        # auto-cleanup kicks in
+        #
+        for br in bier_routes:
+            br.remove_vpp_config()
+        for nhr in nh_routes:
+            nhr.remove_vpp_config()
+
+    @unittest.skipUnless(running_extended_tests(), "part of extended tests")
+    def test_bier_midpoint_1024(self):
+        """BIER midpoint BSL:1024"""
+        self.bier_midpoint(BIERLength.BIER_LEN_1024, 128, 1024)
+
+    @unittest.skipUnless(running_extended_tests(), "part of extended tests")
+    def test_bier_midpoint_512(self):
+        """BIER midpoint BSL:512"""
+        self.bier_midpoint(BIERLength.BIER_LEN_512, 64, 512)
+
+    @unittest.skipUnless(running_extended_tests(), "part of extended tests")
+    def test_bier_midpoint_256(self):
+        """BIER midpoint BSL:256"""
+        self.bier_midpoint(BIERLength.BIER_LEN_256, 32, 256)
+
+    @unittest.skipUnless(running_extended_tests(), "part of extended tests")
+    def test_bier_midpoint_128(self):
+        """BIER midpoint BSL:128"""
+        self.bier_midpoint(BIERLength.BIER_LEN_128, 16, 128)
+
+    def test_bier_midpoint_64(self):
+        """BIER midpoint BSL:256"""
+        self.bier_midpoint(BIERLength.BIER_LEN_64, 8, 64)
 
     def test_bier_head(self):
         """BIER head"""
@@ -292,6 +323,7 @@ class TestBier(VppTestCase):
         #
         bier_de_1 = VppBierDispEntry(self, bdt.id, 99,
                                      BIER_HDR_PAYLOAD.BIER_HDR_PROTO_IPV4,
+                                     DpoProto.DPO_PROTO_BIER,
                                      "0.0.0.0", 0, rpf_id=8192)
         bier_de_1.add_vpp_config()
 
@@ -313,7 +345,9 @@ class TestBier(VppTestCase):
         #
         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
              MPLS(label=77, ttl=255) /
-             BIER(length=BIERLength.BIER_LEN_256, BFRID=99) /
+             BIER(length=BIERLength.BIER_LEN_256,
+                  BitString=chr(255)*32,
+                  BFRID=99) /
              IP(src="1.1.1.1", dst="232.1.1.1") /
              UDP(sport=1234, dport=1234) /
              Raw())
@@ -325,7 +359,9 @@ class TestBier(VppTestCase):
         #
         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
              MPLS(label=77, ttl=255) /
-             BIER(length=BIERLength.BIER_LEN_256, BFRID=77) /
+             BIER(length=BIERLength.BIER_LEN_256,
+                  BitString=chr(255)*32,
+                  BFRID=77) /
              IP(src="1.1.1.1", dst="232.1.1.1") /
              UDP(sport=1234, dport=1234) /
              Raw())
@@ -337,6 +373,7 @@ class TestBier(VppTestCase):
         #
         bier_de_2 = VppBierDispEntry(self, bdt.id, 0,
                                      BIER_HDR_PAYLOAD.BIER_HDR_PROTO_IPV4,
+                                     DpoProto.DPO_PROTO_BIER,
                                      "0.0.0.0", 0, rpf_id=8192)
         bier_de_2.add_vpp_config()
 
@@ -345,22 +382,28 @@ class TestBier(VppTestCase):
         #
         self.send_and_expect(self.pg0, [p], self.pg1)
 
-    def test_bier_e2e(self):
-        """ BIER end-to-end """
+    def bier_e2e(self, hdr_len_id, n_bytes, max_bp):
+        """ BIER end-to-end"""
 
         #
         # Add a BIER table for sub-domain 0, set 0, and BSL 256
         #
-        bti = VppBierTableID(0, 0, BIERLength.BIER_LEN_256)
+        bti = VppBierTableID(0, 0, hdr_len_id)
         bt = VppBierTable(self, bti, 77)
         bt.add_vpp_config()
 
+        lowest = ['\0'] * (n_bytes)
+        lowest[-1] = chr(1)
+        highest = ['\0'] * (n_bytes)
+        highest[0] = chr(128)
+
         #
-        # Impostion Sets bit string 101010101....
-        #  sender 333
+        # Impostion Sets bit strings
         #
-        bi = VppBierImp(self, bti, 333, chr(0x5) * 32)
-        bi.add_vpp_config()
+        bi_low = VppBierImp(self, bti, 333, lowest)
+        bi_low.add_vpp_config()
+        bi_high = VppBierImp(self, bti, 334, highest)
+        bi_high.add_vpp_config()
 
         #
         # Add a multicast route that will forward into the BIER doamin
@@ -375,8 +418,20 @@ class TestBier(VppTestCase):
                    VppMRoutePath(0xffffffff,
                                  MRouteItfFlags.MFIB_ITF_FLAG_FORWARD,
                                  proto=DpoProto.DPO_PROTO_BIER,
-                                 bier_imp=bi.bi_index)])
+                                 bier_imp=bi_low.bi_index)])
         route_ing_232_1_1_1.add_vpp_config()
+        route_ing_232_1_1_2 = VppIpMRoute(
+            self,
+            "0.0.0.0",
+            "232.1.1.2", 32,
+            MRouteEntryFlags.MFIB_ENTRY_FLAG_NONE,
+            paths=[VppMRoutePath(self.pg0.sw_if_index,
+                                 MRouteItfFlags.MFIB_ITF_FLAG_ACCEPT),
+                   VppMRoutePath(0xffffffff,
+                                 MRouteItfFlags.MFIB_ITF_FLAG_FORWARD,
+                                 proto=DpoProto.DPO_PROTO_BIER,
+                                 bier_imp=bi_high.bi_index)])
+        route_ing_232_1_1_2.add_vpp_config()
 
         #
         # disposition table 8
@@ -385,7 +440,7 @@ class TestBier(VppTestCase):
         bdt.add_vpp_config()
 
         #
-        # BIER route in table that's for-us, resolving through
+        # BIER routes in table that are for-us, resolving through
         # disp table 8.
         #
         bier_route_1 = VppBierRoute(self, bti, 1,
@@ -393,6 +448,11 @@ class TestBier(VppTestCase):
                                                   0xffffffff,
                                                   nh_table_id=8)])
         bier_route_1.add_vpp_config()
+        bier_route_max = VppBierRoute(self, bti, max_bp,
+                                      [VppRoutePath("0.0.0.0",
+                                                    0xffffffff,
+                                                    nh_table_id=8)])
+        bier_route_max.add_vpp_config()
 
         #
         # An entry in the disposition table for sender 333
@@ -400,11 +460,17 @@ class TestBier(VppTestCase):
         #
         bier_de_1 = VppBierDispEntry(self, bdt.id, 333,
                                      BIER_HDR_PAYLOAD.BIER_HDR_PROTO_IPV4,
+                                     DpoProto.DPO_PROTO_BIER,
                                      "0.0.0.0", 10, rpf_id=8192)
         bier_de_1.add_vpp_config()
+        bier_de_1 = VppBierDispEntry(self, bdt.id, 334,
+                                     BIER_HDR_PAYLOAD.BIER_HDR_PROTO_IPV4,
+                                     DpoProto.DPO_PROTO_BIER,
+                                     "0.0.0.0", 10, rpf_id=8193)
+        bier_de_1.add_vpp_config()
 
         #
-        # Add a multicast route that will forward the traffic
+        # Add a multicast routes that will forward the traffic
         # post-disposition
         #
         route_eg_232_1_1_1 = VppIpMRoute(
@@ -417,6 +483,16 @@ class TestBier(VppTestCase):
                                  MRouteItfFlags.MFIB_ITF_FLAG_FORWARD)])
         route_eg_232_1_1_1.add_vpp_config()
         route_eg_232_1_1_1.update_rpf_id(8192)
+        route_eg_232_1_1_2 = VppIpMRoute(
+            self,
+            "0.0.0.0",
+            "232.1.1.2", 32,
+            MRouteEntryFlags.MFIB_ENTRY_FLAG_NONE,
+            table_id=10,
+            paths=[VppMRoutePath(self.pg1.sw_if_index,
+                                 MRouteItfFlags.MFIB_ITF_FLAG_FORWARD)])
+        route_eg_232_1_1_2.add_vpp_config()
+        route_eg_232_1_1_2.update_rpf_id(8193)
 
         #
         # inject a packet in VRF-0. We expect it to be BIER encapped,
@@ -426,16 +502,48 @@ class TestBier(VppTestCase):
         p = (Ether(dst=self.pg0.local_mac,
                    src=self.pg0.remote_mac) /
              IP(src="1.1.1.1", dst="232.1.1.1") /
-             UDP(sport=1234, dport=1234))
+             UDP(sport=1234, dport=1234) /
+             Raw(chr(5) * 32))
 
         rx = self.send_and_expect(self.pg0, p*65, self.pg1)
 
-        #
-        # should be IP
-        #
         self.assertEqual(rx[0][IP].src, "1.1.1.1")
         self.assertEqual(rx[0][IP].dst, "232.1.1.1")
 
+        p = (Ether(dst=self.pg0.local_mac,
+                   src=self.pg0.remote_mac) /
+             IP(src="1.1.1.1", dst="232.1.1.2") /
+             UDP(sport=1234, dport=1234) /
+             Raw(chr(5) * 512))
+
+        rx = self.send_and_expect(self.pg0, p*65, self.pg1)
+        self.assertEqual(rx[0][IP].src, "1.1.1.1")
+        self.assertEqual(rx[0][IP].dst, "232.1.1.2")
+
+    @unittest.skipUnless(running_extended_tests(), "part of extended tests")
+    def test_bier_e2e_1024(self):
+        """ BIER end-to-end BSL:1024"""
+        self.bier_e2e(BIERLength.BIER_LEN_1024, 128, 1024)
+
+    @unittest.skipUnless(running_extended_tests(), "part of extended tests")
+    def test_bier_e2e_512(self):
+        """ BIER end-to-end BSL:512"""
+        self.bier_e2e(BIERLength.BIER_LEN_512, 64, 512)
+
+    @unittest.skipUnless(running_extended_tests(), "part of extended tests")
+    def test_bier_e2e_256(self):
+        """ BIER end-to-end BSL:256"""
+        self.bier_e2e(BIERLength.BIER_LEN_256, 32, 256)
+
+    @unittest.skipUnless(running_extended_tests(), "part of extended tests")
+    def test_bier_e2e_128(self):
+        """ BIER end-to-end BSL:128"""
+        self.bier_e2e(BIERLength.BIER_LEN_128, 16, 128)
+
+    def test_bier_e2e_64(self):
+        """ BIER end-to-end BSL:64"""
+        self.bier_e2e(BIERLength.BIER_LEN_64, 8, 64)
+
     def test_bier_head_o_udp(self):
         """BIER head over UDP"""
 
@@ -552,6 +660,7 @@ class TestBier(VppTestCase):
         #
         bier_de_1 = VppBierDispEntry(self, bdt.id, 99,
                                      BIER_HDR_PAYLOAD.BIER_HDR_PROTO_IPV4,
+                                     DpoProto.DPO_PROTO_BIER,
                                      "0.0.0.0", 0, rpf_id=8192)
         bier_de_1.add_vpp_config()
 
@@ -575,7 +684,9 @@ class TestBier(VppTestCase):
              IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
              UDP(sport=333, dport=8138) /
              BIFT(sd=1, set=0, bsl=2, ttl=255) /
-             BIER(length=BIERLength.BIER_LEN_256, BFRID=99) /
+             BIER(length=BIERLength.BIER_LEN_256,
+                  BitString=chr(255)*32,
+                  BFRID=99) /
              IP(src="1.1.1.1", dst="232.1.1.1") /
              UDP(sport=1234, dport=1234) /
              Raw())