ip: add ip_table_allocate to api

Set tableID = ~0 for auto selection unused ID

https://jira.fd.io/browse/VPP-1993

Type: improvement
Change-Id: I4eec2cc1d18fc025196cb6ac4c9a4b374388eb56
Signed-off-by: Artem Glazychev <artem.glazychev@xored.com>
Signed-off-by: Aloys Augustin <aloaugus@cisco.com>

2 files changed, 183 insertions, 47 deletions

diff --git a/test/test_ip4_vrf_multi_instance.py b/test/test_ip4_vrf_multi_instance.py
index c0e2ff31c46..acef6c4ff09 100755
--- a/test/test_ip4_vrf_multi_instance.py
+++ b/test/test_ip4_vrf_multi_instance.py
@@ -136,13 +136,13 @@ class TestIp4VrfMultiInst(VppTestCase):
             cls.pg_not_in_vrf = [pg_if for pg_if in cls.pg_interfaces]
 
             # Create mapping of pg_interfaces to VRF IDs
-            cls.pg_if_by_vrf_id = dict()
+            cls.pg_if_sets = dict()
             for i in range(cls.nr_of_vrfs):
-                vrf_id = i + 1
+                set_id = i + 1
                 pg_list = [
                     cls.pg_interfaces[i * cls.pg_ifs_per_vrf + j]
                     for j in range(cls.pg_ifs_per_vrf)]
-                cls.pg_if_by_vrf_id[vrf_id] = pg_list
+                cls.pg_if_sets[set_id] = pg_list
 
         except Exception:
             super(TestIp4VrfMultiInst, cls).tearDownClass()
@@ -169,6 +169,19 @@ class TestIp4VrfMultiInst(VppTestCase):
         self.logger.info(self.vapi.ppcli("show ip fib"))
         self.logger.info(self.vapi.ppcli("show ip4 neighbors"))
 
+    def _assign_interfaces(self, vrf_id, if_set_id):
+        for i in range(self.pg_ifs_per_vrf):
+            pg_if = self.pg_if_sets[if_set_id][i]
+            pg_if.set_table_ip4(vrf_id)
+            self.logger.info("pg-interface %s added to IPv4 VRF ID %d"
+                             % (pg_if.name, vrf_id))
+            if pg_if not in self.pg_in_vrf:
+                self.pg_in_vrf.append(pg_if)
+            if pg_if in self.pg_not_in_vrf:
+                self.pg_not_in_vrf.remove(pg_if)
+            pg_if.config_ip4()
+            pg_if.configure_ipv4_neighbors()
+
     def create_vrf_and_assign_interfaces(self, count, start=1):
         """
         Create required number of FIB tables / VRFs, put 3 pg-ip4 interfaces
@@ -181,40 +194,53 @@ class TestIp4VrfMultiInst(VppTestCase):
 
         for i in range(count):
             vrf_id = i + start
-            pg_if = self.pg_if_by_vrf_id[vrf_id][0]
             self.vapi.ip_table_add_del(is_add=1, table={'table_id': vrf_id})
             self.logger.info("IPv4 VRF ID %d created" % vrf_id)
             if vrf_id not in self.vrf_list:
                 self.vrf_list.append(vrf_id)
             if vrf_id in self.vrf_reset_list:
                 self.vrf_reset_list.remove(vrf_id)
-            for j in range(self.pg_ifs_per_vrf):
-                pg_if = self.pg_if_by_vrf_id[vrf_id][j]
-                pg_if.set_table_ip4(vrf_id)
-                self.logger.info("pg-interface %s added to IPv4 VRF ID %d"
-                                 % (pg_if.name, vrf_id))
-                if pg_if not in self.pg_in_vrf:
-                    self.pg_in_vrf.append(pg_if)
-                if pg_if in self.pg_not_in_vrf:
-                    self.pg_not_in_vrf.remove(pg_if)
-                pg_if.config_ip4()
-                pg_if.configure_ipv4_neighbors()
+            self._assign_interfaces(vrf_id, vrf_id)
         self.logger.debug(self.vapi.ppcli("show ip fib"))
         self.logger.debug(self.vapi.ppcli("show ip4 neighbors"))
 
-    def reset_vrf_and_remove_from_vrf_list(self, vrf_id):
+    def create_vrf_by_id_and_assign_interfaces(self, set_id,
+                                               vrf_id=0xffffffff):
+        """
+        Create a FIB table / VRF by vrf_id, put 3 pg-ip4 interfaces
+        to FIB table / VRF.
+
+        :param int vrf_id: Required table ID / VRF ID. \
+        (Default value = 0xffffffff, ID will be selected automatically)
+        """
+        ret = self.vapi.ip_table_allocate(table={'table_id': vrf_id})
+        vrf_id = ret.table.table_id
+        self.logger.info("IPv4 VRF ID %d created" % vrf_id)
+        if vrf_id not in self.vrf_list:
+            self.vrf_list.append(vrf_id)
+        if vrf_id in self.vrf_reset_list:
+            self.vrf_reset_list.remove(vrf_id)
+        self._assign_interfaces(vrf_id, set_id)
+        self.logger.debug(self.vapi.ppcli("show ip fib"))
+        self.logger.debug(self.vapi.ppcli("show ip4 neighbors"))
+
+        return vrf_id
+
+    def reset_vrf_and_remove_from_vrf_list(self, vrf_id, if_set_id=None):
         """
         Reset required FIB table / VRF and remove it from VRF list.
 
         :param int vrf_id: The FIB table / VRF ID to be reset.
         """
+        if if_set_id is None:
+            if_set_id = vrf_id
         self.vapi.ip_table_flush(table={'table_id': vrf_id})
         if vrf_id in self.vrf_list:
             self.vrf_list.remove(vrf_id)
         if vrf_id not in self.vrf_reset_list:
             self.vrf_reset_list.append(vrf_id)
         for j in range(self.pg_ifs_per_vrf):
-            pg_if = self.pg_if_by_vrf_id[vrf_id][j]
+            pg_if = self.pg_if_sets[if_set_id][j]
             pg_if.unconfig_ip4()
             if pg_if in self.pg_in_vrf:
                 self.pg_in_vrf.remove(pg_if)
@@ -267,7 +293,7 @@ class TestIp4VrfMultiInst(VppTestCase):
         vrf_lst = list(self.vrf_list)
         vrf_lst.remove(vrf_id)
         for vrf in vrf_lst:
-            for dst_if in self.pg_if_by_vrf_id[vrf]:
+            for dst_if in self.pg_if_sets[vrf]:
                 for dst_host in dst_if.remote_hosts:
                     src_host = random.choice(src_hosts)
                     pkt_info = self.create_packet_info(src_if, dst_if)
@@ -327,20 +353,22 @@ class TestIp4VrfMultiInst(VppTestCase):
                 "Port %u: Packet expected from source %u didn't arrive" %
                 (dst_sw_if_index, i.sw_if_index))
 
-    def verify_vrf(self, vrf_id):
+    def verify_vrf(self, vrf_id, if_set_id=None):
         """
         Check if the FIB table / VRF ID is configured.
 
         :param int vrf_id: The FIB table / VRF ID to be verified.
         :return: 1 if the FIB table / VRF ID is configured, otherwise return 0.
         """
+        if if_set_id is None:
+            if_set_id = vrf_id
         ip_fib_dump = self.vapi.ip_route_dump(vrf_id)
         vrf_exist = len(ip_fib_dump)
         vrf_count = 0
         for ip_fib_details in ip_fib_dump:
             addr = ip_fib_details.route.prefix.network_address
             found = False
-            for pg_if in self.pg_if_by_vrf_id[vrf_id]:
+            for pg_if in self.pg_if_sets[if_set_id]:
                 if found:
                     break
                 for host in pg_if.remote_hosts:
@@ -406,7 +434,7 @@ class TestIp4VrfMultiInst(VppTestCase):
         # Test
         # Create incoming packet streams for packet-generator interfaces
         for vrf_id in self.vrf_list:
-            for pg_if in self.pg_if_by_vrf_id[vrf_id]:
+            for pg_if in self.pg_if_sets[vrf_id]:
                 pkts = self.create_stream_crosswise_vrf(
                     pg_if, vrf_id, self.pg_if_packet_sizes)
                 pg_if.add_stream(pkts)
@@ -499,6 +527,43 @@ class TestIp4VrfMultiInst(VppTestCase):
         self.run_verify_test()
         self.run_crosswise_vrf_test()
 
+    def test_ip4_vrf_05(self):
+        """ IP4 VRF  Multi-instance test 5 - id allocation
+        """
+        # Config 5
+        # Create several VRFs
+        # Set vrf_id manually first
+        self.create_vrf_by_id_and_assign_interfaces(1, 1)
+        # Set vrf_id automatically a few times
+        auto_vrf_id = [
+            self.create_vrf_by_id_and_assign_interfaces(i) for i in range(2, 5)
+        ]
+
+        # Verify 5
+        self.assert_equal(self.verify_vrf(1, 1), VRFState.configured, VRFState)
+        for i, vrf in enumerate(auto_vrf_id):
+            self.assert_equal(self.verify_vrf(vrf, i+2),
+                              VRFState.configured, VRFState)
+
+        # Test 5
+        self.run_verify_test()
+
+        # Config 5.1
+        # Reset VRFs
+        self.reset_vrf_and_remove_from_vrf_list(1)
+        for i, vrf in enumerate(auto_vrf_id):
+            self.reset_vrf_and_remove_from_vrf_list(vrf, i+2)
+
+        # Verify 5.1
+        self.assert_equal(self.verify_vrf(1, 1), VRFState.reset, VRFState)
+        for i, vrf in enumerate(auto_vrf_id):
+            self.assert_equal(self.verify_vrf(vrf, i+2),
+                              VRFState.reset, VRFState)
+
+        vrf_list_length = len(self.vrf_list)
+        self.assertEqual(
+            vrf_list_length, 0,
+            "List of configured VRFs is not empty: %s != 0" % vrf_list_length)
 
 if __name__ == '__main__':
     unittest.main(testRunner=VppTestRunner)
diff --git a/test/test_ip6_vrf_multi_instance.py b/test/test_ip6_vrf_multi_instance.py
index c2964b6c6c0..0f4a073366b 100755
--- a/test/test_ip6_vrf_multi_instance.py
+++ b/test/test_ip6_vrf_multi_instance.py
@@ -148,13 +148,13 @@ class TestIP6VrfMultiInst(VppTestCase):
             cls.pg_not_in_vrf = [pg_if for pg_if in cls.pg_interfaces]
 
             # Create mapping of pg_interfaces to VRF IDs
-            cls.pg_if_by_vrf_id = dict()
+            cls.pg_if_sets = dict()
             for i in range(cls.nr_of_vrfs):
-                vrf_id = i + 1
+                set_id = i + 1
                 pg_list = [
                     cls.pg_interfaces[i * cls.pg_ifs_per_vrf + j]
                     for j in range(cls.pg_ifs_per_vrf)]
-                cls.pg_if_by_vrf_id[vrf_id] = pg_list
+                cls.pg_if_sets[set_id] = pg_list
 
         except Exception:
             super(TestIP6VrfMultiInst, cls).tearDownClass()
@@ -181,6 +181,20 @@ class TestIP6VrfMultiInst(VppTestCase):
         self.logger.info(self.vapi.ppcli("show ip6 fib"))
         self.logger.info(self.vapi.ppcli("show ip6 neighbors"))
 
+    def _assign_interfaces(self, vrf_id, if_set_id):
+        for i in range(self.pg_ifs_per_vrf):
+            pg_if = self.pg_if_sets[if_set_id][i]
+            pg_if.set_table_ip6(vrf_id)
+            self.logger.info("pg-interface %s added to IPv6 VRF ID %d"
+                             % (pg_if.name, vrf_id))
+            if pg_if not in self.pg_in_vrf:
+                self.pg_in_vrf.append(pg_if)
+            if pg_if in self.pg_not_in_vrf:
+                self.pg_not_in_vrf.remove(pg_if)
+            pg_if.config_ip6()
+            pg_if.disable_ipv6_ra()
+            pg_if.configure_ipv6_neighbors()
+
     def create_vrf_and_assign_interfaces(self, count, start=1):
         """
         Create required number of FIB tables / VRFs, put 3 pg-ip6 interfaces
@@ -192,7 +206,6 @@ class TestIP6VrfMultiInst(VppTestCase):
         """
         for i in range(count):
             vrf_id = i + start
-            pg_if = self.pg_if_by_vrf_id[vrf_id][0]
             self.vapi.ip_table_add_del(is_add=1,
                                        table={'table_id': vrf_id, 'is_ip6': 1})
             self.logger.info("IPv6 VRF ID %d created" % vrf_id)
@@ -200,34 +213,48 @@ class TestIP6VrfMultiInst(VppTestCase):
                 self.vrf_list.append(vrf_id)
             if vrf_id in self.vrf_reset_list:
                 self.vrf_reset_list.remove(vrf_id)
-            for j in range(self.pg_ifs_per_vrf):
-                pg_if = self.pg_if_by_vrf_id[vrf_id][j]
-                pg_if.set_table_ip6(vrf_id)
-                self.logger.info("pg-interface %s added to IPv6 VRF ID %d"
-                                 % (pg_if.name, vrf_id))
-                if pg_if not in self.pg_in_vrf:
-                    self.pg_in_vrf.append(pg_if)
-                if pg_if in self.pg_not_in_vrf:
-                    self.pg_not_in_vrf.remove(pg_if)
-                pg_if.config_ip6()
-                pg_if.disable_ipv6_ra()
-                pg_if.configure_ipv6_neighbors()
+            self._assign_interfaces(vrf_id, vrf_id)
+        self.logger.debug(self.vapi.ppcli("show ip6 fib"))
+        self.logger.debug(self.vapi.ppcli("show ip6 neighbors"))
+
+    def create_vrf_by_id_and_assign_interfaces(self, set_id,
+                                               vrf_id=0xffffffff):
+        """
+        Create a FIB table / VRF by vrf_id, put 3 pg-ip6 interfaces
+        to FIB table / VRF.
+
+        :param int vrf_id: Required table ID / VRF ID. \
+        (Default value = 0xffffffff, ID will be selected automatically)
+        """
+        ret = self.vapi.ip_table_allocate(table={'table_id': vrf_id,
+                                                 'is_ip6': 1})
+        vrf_id = ret.table.table_id
+        self.logger.info("IPv6 VRF ID %d created" % vrf_id)
+        if vrf_id not in self.vrf_list:
+            self.vrf_list.append(vrf_id)
+        if vrf_id in self.vrf_reset_list:
+            self.vrf_reset_list.remove(vrf_id)
+        self._assign_interfaces(vrf_id, set_id)
         self.logger.debug(self.vapi.ppcli("show ip6 fib"))
         self.logger.debug(self.vapi.ppcli("show ip6 neighbors"))
 
-    def reset_vrf_and_remove_from_vrf_list(self, vrf_id):
+        return vrf_id
+
+    def reset_vrf_and_remove_from_vrf_list(self, vrf_id, if_set_id=None):
         """
         Reset required FIB table / VRF and remove it from VRF list.
 
         :param int vrf_id: The FIB table / VRF ID to be reset.
         """
+        if if_set_id is None:
+            if_set_id = vrf_id
         self.vapi.ip_table_flush(table={'table_id': vrf_id, 'is_ip6': 1})
         if vrf_id in self.vrf_list:
             self.vrf_list.remove(vrf_id)
         if vrf_id not in self.vrf_reset_list:
             self.vrf_reset_list.append(vrf_id)
         for j in range(self.pg_ifs_per_vrf):
-            pg_if = self.pg_if_by_vrf_id[vrf_id][j]
+            pg_if = self.pg_if_sets[if_set_id][j]
             pg_if.unconfig_ip6()
             if pg_if in self.pg_in_vrf:
                 self.pg_in_vrf.remove(pg_if)
@@ -281,7 +308,7 @@ class TestIP6VrfMultiInst(VppTestCase):
         vrf_lst = list(self.vrf_list)
         vrf_lst.remove(vrf_id)
         for vrf in vrf_lst:
-            for dst_if in self.pg_if_by_vrf_id[vrf]:
+            for dst_if in self.pg_if_sets[vrf]:
                 for dst_host in dst_if.remote_hosts:
                     src_host = random.choice(src_hosts)
                     pkt_info = self.create_packet_info(src_if, dst_if)
@@ -341,20 +368,22 @@ class TestIP6VrfMultiInst(VppTestCase):
                 "Port %u: Packet expected from source %u didn't arrive" %
                 (dst_sw_if_index, i.sw_if_index))
 
-    def verify_vrf(self, vrf_id):
+    def verify_vrf(self, vrf_id, if_set_id=None):
         """
         Check if the FIB table / VRF ID is configured.
 
         :param int vrf_id: The FIB table / VRF ID to be verified.
         :return: 1 if the FIB table / VRF ID is configured, otherwise return 0.
         """
+        if if_set_id is None:
+            if_set_id = vrf_id
         ip6_fib_dump = self.vapi.ip_route_dump(vrf_id, True)
         vrf_exist = len(ip6_fib_dump)
         vrf_count = 0
         for ip6_fib_details in ip6_fib_dump:
             addr = ip6_fib_details.route.prefix.network_address
             found = False
-            for pg_if in self.pg_if_by_vrf_id[vrf_id]:
+            for pg_if in self.pg_if_sets[if_set_id]:
                 if found:
                     break
                 for host in pg_if.remote_hosts:
@@ -420,7 +449,7 @@ class TestIP6VrfMultiInst(VppTestCase):
         # Test
         # Create incoming packet streams for packet-generator interfaces
         for vrf_id in self.vrf_list:
-            for pg_if in self.pg_if_by_vrf_id[vrf_id]:
+            for pg_if in self.pg_if_sets[vrf_id]:
                 pkts = self.create_stream_crosswise_vrf(
                     pg_if, vrf_id, self.pg_if_packet_sizes)
                 pg_if.add_stream(pkts)
@@ -473,8 +502,8 @@ class TestIP6VrfMultiInst(VppTestCase):
         self.run_crosswise_vrf_test()
 
         # Reset routes learned from ICMPv6 Neighbor Discovery
-        for vrf_id in self.vrf_reset_list:
-            self.reset_vrf_and_remove_from_vrf_list(vrf_id)
+        # for vrf_id in self.vrf_reset_list:
+        #     self.reset_vrf_and_remove_from_vrf_list(vrf_id)
 
     def test_ip6_vrf_03(self):
         """ IP6 VRF  Multi-instance 3 - add 2 VRFs
@@ -497,8 +526,8 @@ class TestIP6VrfMultiInst(VppTestCase):
         self.run_crosswise_vrf_test()
 
         # Reset routes learned from ICMPv6 Neighbor Discovery
-        for vrf_id in self.vrf_reset_list:
-            self.reset_vrf_and_remove_from_vrf_list(vrf_id)
+        # for vrf_id in self.vrf_reset_list:
+        #     self.reset_vrf_and_remove_from_vrf_list(vrf_id)
 
     def test_ip6_vrf_04(self):
         """ IP6 VRF  Multi-instance test 4 - reset 4 VRFs
@@ -506,6 +535,7 @@ class TestIP6VrfMultiInst(VppTestCase):
         # Config 4
         # Reset all VRFs (i.e. no VRF except VRF=0 configured)
         for i in range(len(self.vrf_list)):
+            # This call removes the first item of vrf_list as a side effect
             self.reset_vrf_and_remove_from_vrf_list(self.vrf_list[0])
 
         # Verify 4
@@ -521,6 +551,47 @@ class TestIP6VrfMultiInst(VppTestCase):
         self.run_verify_test()
         self.run_crosswise_vrf_test()
 
+    @unittest.skip('VPP crashes after running this test. \
+    There seems to be an issue with the way fib locks are managed')
+    def test_ip6_vrf_05(self):
+        """ IP6 VRF  Multi-instance test 5 - auto allocate vrf id
+        """
+        # Config 5
+        # Create several VRFs
+        # Set vrf_id manually first
+        self.create_vrf_by_id_and_assign_interfaces(1, 10)
+        # Set vrf_id automatically a few times
+        auto_vrf_id = [
+            self.create_vrf_by_id_and_assign_interfaces(i) for i in range(2, 5)
+        ]
+
+        # Verify 5
+        self.assert_equal(self.verify_vrf(10, 1), VRFState.configured,
+                          VRFState)
+        for i, vrf in enumerate(auto_vrf_id):
+            self.assert_equal(self.verify_vrf(vrf, i+2),
+                              VRFState.configured, VRFState)
+
+        # Test 5
+        self.run_verify_test()
+
+        # Config 5.1
+        # Reset VRFs
+        self.reset_vrf_and_remove_from_vrf_list(10, 1)
+        for i, vrf in enumerate(auto_vrf_id):
+            self.reset_vrf_and_remove_from_vrf_list(vrf, i+2)
+
+        # Verify 5.1
+        self.assert_equal(self.verify_vrf(10, 1), VRFState.reset, VRFState)
+        for i, vrf in enumerate(auto_vrf_id):
+            self.assert_equal(self.verify_vrf(vrf, i+2),
+                              VRFState.reset, VRFState)
+
+        vrf_list_length = len(self.vrf_list)
+        self.assertEqual(
+            vrf_list_length, 0,
+            "List of configured VRFs is not empty: %s != 0" % vrf_list_length)
+
 
 if __name__ == '__main__':
     unittest.main(testRunner=VppTestRunner)