1#!/usr/bin/env python3
2
3import socket
4from util import ip4_range
5import unittest
6from framework import VppTestCase, VppTestRunner
7from template_bd import BridgeDomain
8
9from scapy.layers.l2 import Ether
10from scapy.layers.inet import IP, UDP
11from scapy.contrib.geneve import GENEVE
12
13import util
14from vpp_ip_route import VppIpRoute, VppRoutePath
15from vpp_ip import INVALID_INDEX
16
17
18class TestGeneve(BridgeDomain, VppTestCase):
19    """ GENEVE Test Case """
20
21    def __init__(self, *args):
22        BridgeDomain.__init__(self)
23        VppTestCase.__init__(self, *args)
24
25    def encapsulate(self, pkt, vni):
26
27        """
28        Encapsulate the original payload frame by adding GENEVE header with its
29        UDP, IP and Ethernet fields
30        """
31        return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
32                IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
33                UDP(sport=self.dport, dport=self.dport, chksum=0) /
34                GENEVE(vni=vni) /
35                pkt)
36
37    def ip_range(self, start, end):
38        """ range of remote ip's """
39        return ip4_range(self.pg0.remote_ip4, start, end)
40
41    def encap_mcast(self, pkt, src_ip, src_mac, vni):
42        """
43        Encapsulate the original payload frame by adding GENEVE header with its
44        UDP, IP and Ethernet fields
45        """
46        return (Ether(src=src_mac, dst=self.mcast_mac) /
47                IP(src=src_ip, dst=self.mcast_ip4) /
48                UDP(sport=self.dport, dport=self.dport, chksum=0) /
49                GENEVE(vni=vni) /
50                pkt)
51
52    def decapsulate(self, pkt):
53        """
54        Decapsulate the original payload frame by removing GENEVE header
55        """
56        # check if is set I flag
57        # self.assertEqual(pkt[GENEVE].flags, int('0x8', 16))
58        return pkt[GENEVE].payload
59
60    # Method for checking GENEVE encapsulation.
61    #
62    def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
63        # TODO: add error messages
64        # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
65        #  by VPP using ARP.
66        self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
67        if not local_only:
68            if not mcast_pkt:
69                self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
70            else:
71                self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
72        # Verify GENEVE tunnel source IP is VPP_IP and destination IP is MY_IP.
73        self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
74        if not local_only:
75            if not mcast_pkt:
76                self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
77            else:
78                self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
79        # Verify UDP destination port is GENEVE 4789, source UDP port could be
80        #  arbitrary.
81        self.assertEqual(pkt[UDP].dport, type(self).dport)
82        # TODO: checksum check
83        # Verify VNI
84        self.assertEqual(pkt[GENEVE].vni, vni)
85
86    @classmethod
87    def create_geneve_flood_test_bd(cls, vni, n_ucast_tunnels):
88        # Create 10 ucast geneve tunnels under bd
89        ip_range_start = 10
90        ip_range_end = ip_range_start + n_ucast_tunnels
91        next_hop_address = cls.pg0.remote_ip4
92        for dest_ip4 in ip4_range(next_hop_address, ip_range_start,
93                                  ip_range_end):
94            # add host route so dest_ip4 will not be resolved
95            rip = VppIpRoute(cls, dest_ip4, 32,
96                             [VppRoutePath(next_hop_address,
97                                           INVALID_INDEX)],
98                             register=False)
99            rip.add_vpp_config()
100            r = cls.vapi.geneve_add_del_tunnel(
101                local_address=cls.pg0.local_ip4, remote_address=dest_ip4,
102                vni=vni)
103            cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
104                                                bd_id=vni)
105
106    @classmethod
107    def add_del_shared_mcast_dst_load(cls, is_add):
108        """
109        add or del tunnels sharing the same mcast dst
110        to test geneve ref_count mechanism
111        """
112        n_shared_dst_tunnels = 10
113        vni_start = 10000
114        vni_end = vni_start + n_shared_dst_tunnels
115        for vni in range(vni_start, vni_end):
116            r = cls.vapi.geneve_add_del_tunnel(
117                local_address=cls.pg0.local_ip4,
118                remote_address=cls.mcast_ip4, mcast_sw_if_index=1,
119                is_add=is_add, vni=vni)
120            if r.sw_if_index == 0xffffffff:
121                raise ValueError("bad sw_if_index: ~0")
122
123    @classmethod
124    def add_shared_mcast_dst_load(cls):
125        cls.add_del_shared_mcast_dst_load(is_add=1)
126
127    @classmethod
128    def del_shared_mcast_dst_load(cls):
129        cls.add_del_shared_mcast_dst_load(is_add=0)
130
131    @classmethod
132    def add_del_mcast_tunnels_load(cls, is_add):
133        """
134        add or del tunnels to test geneve stability
135        """
136        n_distinct_dst_tunnels = 10
137        ip_range_start = 10
138        ip_range_end = ip_range_start + n_distinct_dst_tunnels
139        for dest_ip4 in ip4_range(cls.mcast_ip4, ip_range_start,
140                                  ip_range_end):
141            vni = int(dest_ip4.split('.')[3])
142            cls.vapi.geneve_add_del_tunnel(local_address=cls.pg0.local_ip4,
143                                           remote_address=dest_ip4,
144                                           mcast_sw_if_index=1, is_add=is_add,
145                                           vni=vni)
146
147    @classmethod
148    def add_mcast_tunnels_load(cls):
149        cls.add_del_mcast_tunnels_load(is_add=1)
150
151    @classmethod
152    def del_mcast_tunnels_load(cls):
153        cls.add_del_mcast_tunnels_load(is_add=0)
154
155    # Class method to start the GENEVE test case.
156    #  Overrides setUpClass method in VppTestCase class.
157    #  Python try..except statement is used to ensure that the tear down of
158    #  the class will be executed even if exception is raised.
159    #  @param cls The class pointer.
160    @classmethod
161    def setUpClass(cls):
162        super(TestGeneve, cls).setUpClass()
163
164        try:
165            cls.dport = 6081
166
167            # Create 2 pg interfaces.
168            cls.create_pg_interfaces(range(4))
169            for pg in cls.pg_interfaces:
170                pg.admin_up()
171
172            # Configure IPv4 addresses on VPP pg0.
173            cls.pg0.config_ip4()
174
175            # Resolve MAC address for VPP's IP address on pg0.
176            cls.pg0.resolve_arp()
177
178            # Our Multicast address
179            cls.mcast_ip4 = '239.1.1.1'
180            cls.mcast_mac = util.mcast_ip_to_mac(cls.mcast_ip4)
181
182            # Create GENEVE VTEP on VPP pg0, and put geneve_tunnel0 and pg1
183            #  into BD.
184            cls.single_tunnel_vni = 0xabcde
185            cls.single_tunnel_bd = 1
186            r = cls.vapi.geneve_add_del_tunnel(
187                local_address=cls.pg0.local_ip4,
188                remote_address=cls.pg0.remote_ip4, vni=cls.single_tunnel_vni)
189            cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
190                                                bd_id=cls.single_tunnel_bd)
191            cls.vapi.sw_interface_set_l2_bridge(
192                rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.single_tunnel_bd)
193
194            # Setup vni 2 to test multicast flooding
195            cls.n_ucast_tunnels = 10
196            cls.mcast_flood_bd = 2
197            cls.create_geneve_flood_test_bd(cls.mcast_flood_bd,
198                                            cls.n_ucast_tunnels)
199            r = cls.vapi.geneve_add_del_tunnel(
200                local_address=cls.pg0.local_ip4,
201                remote_address=cls.mcast_ip4, mcast_sw_if_index=1,
202                vni=cls.mcast_flood_bd)
203            cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
204                                                bd_id=cls.mcast_flood_bd)
205            cls.vapi.sw_interface_set_l2_bridge(
206                rx_sw_if_index=cls.pg2.sw_if_index, bd_id=cls.mcast_flood_bd)
207
208            # Add and delete mcast tunnels to check stability
209            cls.add_shared_mcast_dst_load()
210            cls.add_mcast_tunnels_load()
211            cls.del_shared_mcast_dst_load()
212            cls.del_mcast_tunnels_load()
213
214            # Setup vni 3 to test unicast flooding
215            cls.ucast_flood_bd = 3
216            cls.create_geneve_flood_test_bd(cls.ucast_flood_bd,
217                                            cls.n_ucast_tunnels)
218            cls.vapi.sw_interface_set_l2_bridge(
219                rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd)
220        except Exception:
221            super(TestGeneve, cls).tearDownClass()
222            raise
223
224    # Method to define VPP actions before tear down of the test case.
225    #  Overrides tearDown method in VppTestCase class.
226    #  @param self The object pointer.
227    def tearDown(self):
228        super(TestGeneve, self).tearDown()
229
230    def show_commands_at_teardown(self):
231        self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
232        self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
233        self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
234        self.logger.info(self.vapi.cli("show geneve tunnel"))
235
236
237if __name__ == '__main__':
238    unittest.main(testRunner=VppTestRunner)
239