aboutsummaryrefslogtreecommitdiffstats
path: root/test/test_pipe.py
blob: 20e6d2a4e1fe475268c9d7acf2320378270394c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
#!/usr/bin/env python
from socket import AF_INET, AF_INET6, inet_pton
import unittest

from scapy.packet import Raw
from scapy.layers.l2 import Ether
from scapy.layers.inet import IP, UDP

from framework import VppTestCase, VppTestRunner
from vpp_interface import VppInterface
from vpp_ip_route import VppIpTable, VppIpRoute, VppRoutePath

NUM_PKTS = 67


class VppPipe(VppInterface):
    """
    VPP Pipe
    """

    @property
    def east(self):
        return self.result.pipe_sw_if_index[1]

    @property
    def west(self):
        return self.result.pipe_sw_if_index[0]

    def __init__(self, test, instance=0xffffffff):
        super(VppPipe, self).__init__(test)
        self._test = test
        self.instance = instance

    def add_vpp_config(self):
        self.result = self._test.vapi.pipe_create(
            0 if self.instance == 0xffffffff else 1,
            self.instance)
        self.set_sw_if_index(self.result.sw_if_index)

    def remove_vpp_config(self):
        self._test.vapi.pipe_delete(
            self.result.sw_if_index)

    def object_id(self):
        return "pipe-%d" % (self._sw_if_index)

    def query_vpp_config(self):
        pipes = self._test.vapi.pipe_dump()
        for p in pipes:
            if p.sw_if_index == self.result.sw_if_index:
                return True
        return False

    def set_unnumbered(self, ip_sw_if_index, is_add=True):
        res = self._test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
                                                          self.east, is_add)
        res = self._test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
                                                          self.west, is_add)


class TestPipe(VppTestCase):
    """ Pipes """

    @classmethod
    def setUpClass(cls):
        super(TestPipe, cls).setUpClass()

    @classmethod
    def tearDownClass(cls):
        super(TestPipe, cls).tearDownClass()

    def setUp(self):
        super(TestPipe, self).setUp()

        self.create_pg_interfaces(range(4))

        for i in self.pg_interfaces:
            i.admin_up()

    def tearDown(self):
        for i in self.pg_interfaces:
            i.admin_down()

        super(TestPipe, self).tearDown()

    def test_pipe(self):
        """ Pipes """

        pipes = [VppPipe(self), VppPipe(self, 10)]

        for p in pipes:
            p.add_vpp_config()
            p.admin_up()

        #
        # L2 cross-connect pipe0 east with pg0 and west with pg1
        #
        self.vapi.sw_interface_set_l2_xconnect(self.pg0.sw_if_index,
                                               pipes[0].east,
                                               enable=1)
        self.vapi.sw_interface_set_l2_xconnect(pipes[0].east,
                                               self.pg0.sw_if_index,
                                               enable=1)
        self.vapi.sw_interface_set_l2_xconnect(self.pg1.sw_if_index,
                                               pipes[0].west,
                                               enable=1)
        self.vapi.sw_interface_set_l2_xconnect(pipes[0].west,
                                               self.pg1.sw_if_index,
                                               enable=1)

        # test bi-directional L2 flow pg0<->pg1
        p = (Ether(src=self.pg0.remote_mac,
                   dst=self.pg1.remote_mac) /
             IP(src="1.1.1.1",
                dst="1.1.1.2") /
             UDP(sport=1234, dport=1234) /
             Raw('\xa5' * 100))

        self.send_and_expect(self.pg0, p * NUM_PKTS, self.pg1)
        self.send_and_expect(self.pg1, p * NUM_PKTS, self.pg0)

        #
        # Attach ACL to ensure features are run on the pipe
        #
        rule_1 = ({'is_permit': 0,
                   'is_ipv6': 0,
                   'proto': 17,
                   'srcport_or_icmptype_first': 1234,
                   'srcport_or_icmptype_last': 1234,
                   'src_ip_prefix_len': 32,
                   'src_ip_addr': inet_pton(AF_INET, "1.1.1.1"),
                   'dstport_or_icmpcode_first': 1234,
                   'dstport_or_icmpcode_last': 1234,
                   'dst_ip_prefix_len': 32,
                   'dst_ip_addr': inet_pton(AF_INET, "1.1.1.2")})
        acl = self.vapi.acl_add_replace(acl_index=4294967295,
                                        r=[rule_1])

        # Apply the ACL on the pipe on output
        self.vapi.acl_interface_set_acl_list(pipes[0].east,
                                             0,
                                             [acl.acl_index])
        self.send_and_assert_no_replies(self.pg0, p * NUM_PKTS)
        self.send_and_expect(self.pg1, p * NUM_PKTS, self.pg0)

        # remove from output and apply on input
        self.vapi.acl_interface_set_acl_list(pipes[0].east,
                                             0,
                                             [])
        self.vapi.acl_interface_set_acl_list(pipes[0].west,
                                             1,
                                             [acl.acl_index])
        self.send_and_assert_no_replies(self.pg0, p * NUM_PKTS)
        self.send_and_expect(self.pg1, p * NUM_PKTS, self.pg0)
        self.vapi.acl_interface_set_acl_list(pipes[0].west,
                                             0,
                                             [])
        self.send_and_expect(self.pg0, p * NUM_PKTS, self.pg1)
        self.send_and_expect(self.pg1, p * NUM_PKTS, self.pg0)

        #
        # L3 routes in two separate tables so a pipe can be used to L3
        # x-connect
        #
        tables = []
        tables.append(VppIpTable(self, 1))
        tables.append(VppIpTable(self, 2))

        for t in tables:
            t.add_vpp_config()

        self.pg2.set_table_ip4(1)
        self.pg2.config_ip4()
        self.pg2.resolve_arp()
        self.pg3.set_table_ip4(2)
        self.pg3.config_ip4()
        self.pg3.resolve_arp()

        routes = []
        routes.append(VppIpRoute(self, "1.1.1.1", 32,
                                 [VppRoutePath(self.pg3.remote_ip4,
                                               self.pg3.sw_if_index)],
                                 table_id=2))
        routes.append(VppIpRoute(self, "1.1.1.1", 32,
                                 [VppRoutePath("0.0.0.0", pipes[1].east)],
                                 table_id=1))
        routes.append(VppIpRoute(self, "1.1.1.2", 32,
                                 [VppRoutePath("0.0.0.0", pipes[1].west)],
                                 table_id=2))
        routes.append(VppIpRoute(self, "1.1.1.2", 32,
                                 [VppRoutePath(self.pg2.remote_ip4,
                                               self.pg2.sw_if_index)],
                                 table_id=1))

        for r in routes:
            r.add_vpp_config()

        p_east = (Ether(src=self.pg2.remote_mac,
                        dst=self.pg2.local_mac) /
                  IP(src="1.1.1.2",
                     dst="1.1.1.1") /
                  UDP(sport=1234, dport=1234) /
                  Raw('\xa5' * 100))

        # bind the pipe ends to the correct tables
        self.vapi.sw_interface_set_table(pipes[1].west, 0, 2)
        self.vapi.sw_interface_set_table(pipes[1].east, 0, 1)

        # IP is not enabled on the pipes at this point
        self.send_and_assert_no_replies(self.pg2, p_east * NUM_PKTS)

        # IP enable the Pipes by making them unnumbered
        pipes[0].set_unnumbered(self.pg2.sw_if_index)
        pipes[1].set_unnumbered(self.pg3.sw_if_index)

        self.send_and_expect(self.pg2, p_east * NUM_PKTS, self.pg3)

        # and the return path
        p_west = (Ether(src=self.pg3.remote_mac,
                        dst=self.pg3.local_mac) /
                  IP(src="1.1.1.1",
                     dst="1.1.1.2") /
                  UDP(sport=1234, dport=1234) /
                  Raw('\xa5' * 100))
        self.send_and_expect(self.pg3, p_west * NUM_PKTS, self.pg2)

        #
        # Use ACLs to test features run on the Pipes
        #
        self.vapi.acl_interface_set_acl_list(pipes[1].east,
                                             0,
                                             [acl.acl_index])
        self.send_and_assert_no_replies(self.pg2, p_east * NUM_PKTS)
        self.send_and_expect(self.pg3, p_west * NUM_PKTS, self.pg2)

        # remove from output and apply on input
        self.vapi.acl_interface_set_acl_list(pipes[1].east,
                                             0,
                                             [])
        self.vapi.acl_interface_set_acl_list(pipes[1].west,
                                             1,
                                             [acl.acl_index])
        self.send_and_assert_no_replies(self.pg2, p_east * NUM_PKTS)
        self.send_and_expect(self.pg3, p_west * NUM_PKTS, self.pg2)
        self.vapi.acl_interface_set_acl_list(pipes[1].west,
                                             0,
                                             [])
        self.send_and_expect(self.pg2, p_east * NUM_PKTS, self.pg3)
        self.send_and_expect(self.pg3, p_west * NUM_PKTS, self.pg2)

        # cleanup (so the tables delete)
        self.pg2.unconfig_ip4()
        self.pg2.set_table_ip4(0)
        self.pg3.unconfig_ip4()
        self.pg3.set_table_ip4(0)
        self.vapi.sw_interface_set_table(pipes[1].west, 0, 0)
        self.vapi.sw_interface_set_table(pipes[1].east, 0, 0)


if __name__ == '__main__':
    unittest.main(testRunner=VppTestRunner)
>.tv_sec = 0; ts.tv_nsec = 10000*1000; /* 10 ms */ while (nanosleep(&ts, &tsrem) < 0) ts = tsrem; } /* Mutex buggered, "fix" it */ memset (&q->mutex, 0, sizeof (q->mutex)); clib_warning ("forcibly release main input queue mutex"); mutex_ok: am->vlib_rp = vlib_rp; while (unix_shared_memory_queue_sub (q, (u8 *)&old_msg, 1 /* nowait */) != -2 /* queue underflow */) { vl_msg_api_free_nolock ((void *)old_msg); am->shmem_hdr->restart_reclaims++; } pthread_mutex_unlock (&vlib_rp->mutex); root_rp = svm_get_root_rp(); ASSERT(root_rp); /* Clean up the root region client list */ pthread_mutex_lock (&root_rp->mutex); svm_client_scan_this_region_nolock (root_rp); pthread_mutex_unlock (&root_rp->mutex); } pthread_mutex_unlock (&vlib_rp->mutex); am->vlib_rp = vlib_rp; vec_add1(am->mapped_shmem_regions, vlib_rp); return 0; } /* Clients simply have to wait... */ if (!is_vlib) { pthread_mutex_unlock (&vlib_rp->mutex); /* Wait up to 100 seconds... */ for (i = 0; i < 10000; i++) { ts.tv_sec = 0; ts.tv_nsec = 10000*1000; /* 10 ms */ while (nanosleep(&ts, &tsrem) < 0) ts = tsrem; if (vlib_rp->user_ctx) goto ready; } /* Clean up and leave... */ svm_region_unmap (vlib_rp); clib_warning ("region init fail"); return (-2); ready: am->shmem_hdr = (void *)vlib_rp->user_ctx; am->our_pid = getpid(); am->vlib_rp = vlib_rp; vec_add1(am->mapped_shmem_regions, vlib_rp); return 0; } /* Nope, it's our problem... */ oldheap = svm_push_data_heap (vlib_rp); vec_validate(shmem_hdr, 0); shmem_hdr->version = VL_SHM_VERSION; /* vlib main input queue */ shmem_hdr->vl_input_queue = unix_shared_memory_queue_init (1024, sizeof (uword), getpid(), am->vlib_signal); /* Set up the msg ring allocator */ #define _(sz,n) \ do { \ ring_alloc_t _rp; \ _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \ _rp.size = (sz); \ _rp.nitems = n; \ _rp.hits = 0; \ _rp.misses = 0; \ vec_add1(shmem_hdr->vl_rings, _rp); \ } while (0); foreach_vl_aring_size; #undef _ #define _(sz,n) \ do { \ ring_alloc_t _rp; \ _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \ _rp.size = (sz); \ _rp.nitems = n; \ _rp.hits = 0; \ _rp.misses = 0; \ vec_add1(shmem_hdr->client_rings, _rp); \ } while (0); foreach_clnt_aring_size; #undef _ am->shmem_hdr = shmem_hdr; am->vlib_rp = vlib_rp; am->our_pid = getpid(); if (is_vlib) am->shmem_hdr->vl_pid = am->our_pid; svm_pop_heap (oldheap); /* * After absolutely everything that a client might see is set up, * declare the shmem region valid */ vlib_rp->user_ctx = shmem_hdr; pthread_mutex_unlock (&vlib_rp->mutex); vec_add1(am->mapped_shmem_regions, vlib_rp); return 0; } void vl_register_mapped_shmem_region(svm_region_t *rp) { api_main_t *am = &api_main; vec_add1(am->mapped_shmem_regions, rp); } void vl_unmap_shmem (void) { svm_region_t *rp; int i; api_main_t *am = &api_main; if (! svm_get_root_rp()) return; for (i = 0; i < vec_len(am->mapped_shmem_regions); i++) { rp = am->mapped_shmem_regions[i]; svm_region_unmap (rp); } vec_free(am->mapped_shmem_regions); am->shmem_hdr = 0; svm_region_exit (); /* $$$ more careful cleanup, valgrind run... */ vec_free (am->msg_handlers); vec_free (am->msg_endian_handlers); vec_free (am->msg_print_handlers); } void vl_msg_api_send_shmem (unix_shared_memory_queue_t *q, u8 *elem) { api_main_t *am = &api_main; uword *trace = (uword *)elem; if (am->tx_trace && am->tx_trace->enabled) vl_msg_api_trace(am, am->tx_trace, (void *)trace[0]); (void)unix_shared_memory_queue_add(q, elem, 0 /* nowait */); } void vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t *q, u8 *elem) { api_main_t *am = &api_main; uword *trace = (uword *)elem; if (am->tx_trace && am->tx_trace->enabled) vl_msg_api_trace(am, am->tx_trace, (void *)trace[0]); (void)unix_shared_memory_queue_add_nolock (q, elem); } static void vl_api_memclnt_create_reply_t_handler ( vl_api_memclnt_create_reply_t *mp) { api_main_t *am = &api_main; int rv; am->my_client_index = mp->index; am->my_registration = (vl_api_registration_t *)(uword) mp->handle; rv = ntohl(mp->response); if (rv < 0) clib_warning ("WARNING: API mismatch detected"); } void vl_client_add_api_signatures (vl_api_memclnt_create_t *mp) __attribute__((weak)); void vl_client_add_api_signatures (vl_api_memclnt_create_t *mp) { int i; for (i = 0; i < ARRAY_LEN(mp->api_versions); i++) mp->api_versions[i] = 0; } int vl_client_connect (char *name, int ctx_quota, int input_queue_size) { svm_region_t *svm; vl_api_memclnt_create_t *mp; vl_api_memclnt_create_reply_t *rp; unix_shared_memory_queue_t *vl_input_queue; vl_shmem_hdr_t *shmem_hdr; int rv=0; void *oldheap; api_main_t *am = &api_main; if (am->my_registration) { clib_warning ("client %s already connected...", name); return -1; } if (am->vlib_rp == 0) { clib_warning ("am->vlib_rp NULL"); return -1; } svm = am->vlib_rp; shmem_hdr = am->shmem_hdr; if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0) { clib_warning ("shmem_hdr / input queue NULL"); return -1; } pthread_mutex_lock (&svm->mutex); oldheap = svm_push_data_heap(svm); vl_input_queue = unix_shared_memory_queue_init (input_queue_size, sizeof(uword), getpid(), 0); pthread_mutex_unlock(&svm->mutex); svm_pop_heap (oldheap); am->my_client_index = ~0; am->my_registration = 0; am->vl_input_queue = vl_input_queue; mp = vl_msg_api_alloc(sizeof(vl_api_memclnt_create_t)); memset(mp, 0, sizeof (*mp)); mp->_vl_msg_id = ntohs(VL_API_MEMCLNT_CREATE); mp->ctx_quota = ctx_quota; mp->input_queue = (uword)vl_input_queue; strncpy ((char *) mp->name, name, sizeof(mp->name)-1); vl_client_add_api_signatures(mp); vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *)&mp); while (1) { int qstatus; struct timespec ts, tsrem; int i; /* Wait up to 10 seconds */ for (i = 0; i < 1000; i++) { qstatus = unix_shared_memory_queue_sub (vl_input_queue, (u8 *)&rp, 1 /* nowait */); if (qstatus == 0) goto read_one_msg; ts.tv_sec = 0; ts.tv_nsec = 10000*1000; /* 10 ms */ while (nanosleep(&ts, &tsrem) < 0) ts = tsrem; } /* Timeout... */ clib_warning ("memclnt_create_reply timeout"); return -1; read_one_msg: if (ntohs(rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY) { clib_warning ("unexpected reply: id %d", ntohs(rp->_vl_msg_id)); continue; } rv = clib_net_to_host_u32(rp->response); vl_msg_api_handler((void *)rp); break; } return (rv); } static void vl_api_memclnt_delete_reply_t_handler ( vl_api_memclnt_delete_reply_t *mp) { void *oldheap; api_main_t *am = &api_main; pthread_mutex_lock (&am->vlib_rp->mutex); oldheap = svm_push_data_heap(am->vlib_rp); unix_shared_memory_queue_free (am->vl_input_queue); pthread_mutex_unlock (&am->vlib_rp->mutex); svm_pop_heap (oldheap); am->my_client_index = ~0; am->my_registration = 0; am->vl_input_queue = 0; } void vl_client_disconnect (void) { vl_api_memclnt_delete_t *mp; vl_api_memclnt_delete_reply_t *rp; unix_shared_memory_queue_t *vl_input_queue; vl_shmem_hdr_t *shmem_hdr; time_t begin; api_main_t *am = &api_main; ASSERT(am->vlib_rp); shmem_hdr = am->shmem_hdr; ASSERT(shmem_hdr && shmem_hdr->vl_input_queue); vl_input_queue = am->vl_input_queue; mp = vl_msg_api_alloc(sizeof(vl_api_memclnt_delete_t)); memset(mp, 0, sizeof (*mp)); mp->_vl_msg_id = ntohs(VL_API_MEMCLNT_DELETE); mp->index = am->my_client_index; mp->handle = (uword) am->my_registration; vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *)&mp); /* * Have to be careful here, in case the client is disconnecting * because e.g. the vlib process died, or is unresponsive. */ begin = time (0); while (1) { time_t now; now = time (0); if (now >= (begin + 2)) { clib_warning ("peer unresponsive, give up"); am->my_client_index = ~0; am->my_registration = 0; am->shmem_hdr = 0; break; } if (unix_shared_memory_queue_sub (vl_input_queue, (u8 *)&rp, 1) < 0) continue; /* drain the queue */ if (ntohs(rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY) { vl_msg_api_handler ((void *)rp); continue; } vl_msg_api_handler((void *)rp); break; } } static inline vl_api_registration_t *vl_api_client_index_to_registration_internal (u32 handle) { vl_api_registration_t **regpp; vl_api_registration_t *regp; api_main_t *am = &api_main; u32 index; index = vl_msg_api_handle_get_index (handle); if ((am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK) != vl_msg_api_handle_get_epoch (handle)) { vl_msg_api_increment_missing_client_counter(); return 0; } regpp = am->vl_clients + index; if (pool_is_free(am->vl_clients, regpp)) { vl_msg_api_increment_missing_client_counter(); return 0; } regp = *regpp; return (regp); } vl_api_registration_t *vl_api_client_index_to_registration (u32 index) { return (vl_api_client_index_to_registration_internal (index)); } unix_shared_memory_queue_t *vl_api_client_index_to_input_queue (u32 index) { vl_api_registration_t *regp; regp = vl_api_client_index_to_registration_internal (index); if (!regp) return 0; return (regp->vl_input_queue); } #define foreach_api_client_msg \ _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \ _(MEMCLNT_DELETE_REPLY, memclnt_delete_reply) int vl_client_api_map (char *region_name) { int rv; if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */)) < 0) { return rv; } #define _(N,n) \ vl_msg_api_set_handlers(VL_API_##N, 0 /* name */, \ vl_api_##n##_t_handler, \ 0/* cleanup */, 0/* endian */, 0/* print */, \ sizeof(vl_api_##n##_t), 1); foreach_api_client_msg; #undef _ return 0; } void vl_client_api_unmap (void) { vl_unmap_shmem(); }