summaryrefslogtreecommitdiffstats
path: root/test/vpp_ipsec.py
blob: 77a9d74edf3ff4b1320bd918c2e75f005c03193d (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
from vpp_object import VppObject
from ipaddress import ip_address
from vpp_papi import VppEnum

try:
    text_type = unicode
except NameError:
    text_type = str


class VppIpsecSpd(VppObject):
    """
    VPP SPD DB
    """

    def __init__(self, test, id):
        self.test = test
        self.id = id

    def add_vpp_config(self):
        self.test.vapi.ipsec_spd_add_del(self.id)
        self.test.registry.register(self, self.test.logger)

    def remove_vpp_config(self):
        self.test.vapi.ipsec_spd_add_del(self.id, is_add=0)

    def object_id(self):
        return "ipsec-spd-%d" % self.id

    def query_vpp_config(self):
        spds = self.test.vapi.ipsec_spds_dump()
        for spd in spds:
            if spd.spd_id == self.id:
                return True
        return False


class VppIpsecSpdItfBinding(VppObject):
    """
    VPP SPD DB to interface binding
    (i.e. this SPD is used on this interface)
    """

    def __init__(self, test, spd, itf):
        self.test = test
        self.spd = spd
        self.itf = itf

    def add_vpp_config(self):
        self.test.vapi.ipsec_interface_add_del_spd(self.spd.id,
                                                   self.itf.sw_if_index)
        self.test.registry.register(self, self.test.logger)

    def remove_vpp_config(self):
        self.test.vapi.ipsec_interface_add_del_spd(self.spd.id,
                                                   self.itf.sw_if_index,
                                                   is_add=0)

    def object_id(self):
        return "bind-%s-to-%s" % (self.spd.id, self.itf)

    def query_vpp_config(self):
        bs = self.test.vapi.ipsec_spd_interface_dump()
        for b in bs:
            if b.sw_if_index == self.itf.sw_if_index:
                return True
        return False


class VppIpsecSpdEntry(VppObject):
    """
    VPP SPD DB Entry
    """

    def __init__(self, test, spd, sa_id,
                 local_start, local_stop,
                 remote_start, remote_stop,
                 proto,
                 priority=100,
                 policy=None,
                 is_outbound=1,
                 remote_port_start=0,
                 remote_port_stop=65535,
                 local_port_start=0,
                 local_port_stop=65535):
        self.test = test
        self.spd = spd
        self.sa_id = sa_id
        self.local_start = ip_address(text_type(local_start))
        self.local_stop = ip_address(text_type(local_stop))
        self.remote_start = ip_address(text_type(remote_start))
        self.remote_stop = ip_address(text_type(remote_stop))
        self.proto = proto
        self.is_outbound = is_outbound
        self.priority = priority
        if not policy:
            self.policy = (VppEnum.vl_api_ipsec_spd_action_t.
                           IPSEC_API_SPD_ACTION_BYPASS)
        else:
            self.policy = policy
        self.is_ipv6 = (0 if self.local_start.version == 4 else 1)
        self.local_port_start = local_port_start
        self.local_port_stop = local_port_stop
        self.remote_port_start = remote_port_start
        self.remote_port_stop = remote_port_stop

    def add_vpp_config(self):
        rv = self.test.vapi.ipsec_spd_entry_add_del(
            self.spd.id,
            self.sa_id,
            self.local_start,
            self.local_stop,
            self.remote_start,
            self.remote_stop,
            protocol=self.proto,
            is_ipv6=self.is_ipv6,
            is_outbound=self.is_outbound,
            priority=self.priority,
            policy=self.policy,
            local_port_start=self.local_port_start,
            local_port_stop=self.local_port_stop,
            remote_port_start=self.remote_port_start,
            remote_port_stop=self.remote_port_stop)
        self.stat_index = rv.stat_index
        self.test.registry.register(self, self.test.logger)

    def remove_vpp_config(self):
        self.test.vapi.ipsec_spd_entry_add_del(
            self.spd.id,
            self.sa_id,
            self.local_start,
            self.local_stop,
            self.remote_start,
            self.remote_stop,
            protocol=self.proto,
            is_ipv6=self.is_ipv6,
            is_outbound=self.is_outbound,
            priority=self.priority,
            policy=self.policy,
            local_port_start=self.local_port_start,
            local_port_stop=self.local_port_stop,
            remote_port_start=self.remote_port_start,
            remote_port_stop=self.remote_port_stop,
            is_add=0)

    def object_id(self):
        return "spd-entry-%d-%d-%d-%d-%d-%d" % (self.spd.id,
                                                self.priority,
                                                self.policy,
                                                self.is_outbound,
                                                self.is_ipv6,
                                                self.remote_port_start)

    def query_vpp_config(self):
        ss = self.test.vapi.ipsec_spd_dump(self.spd.id)
        for s in ss:
            if s.entry.sa_id == self.sa_id and \
               s.entry.is_outbound == self.is_outbound and \
               s.entry.priority == self.priority and \
               s.entry.policy == self.policy and \
               s.entry.remote_address_start == self.remote_start and \
               s.entry.remote_port_start == self.remote_port_start:
                return True
        return False

    def get_stats(self):
        c = self.test.statistics.get_counter("/net/ipsec/policy")
        return c[0][self.stat_index]


class VppIpsecSA(VppObject):
    """
    VPP SAD Entry
    """

    def __init__(self, test, id, spi,
                 integ_alg, integ_key,
                 crypto_alg, crypto_key,
                 proto,
                 tun_src=None, tun_dst=None,
                 flags=None, salt=0):
        e = VppEnum.vl_api_ipsec_sad_flags_t
        self.test = test
        self.id = id
        self.spi = spi
        self.integ_alg = integ_alg
        self.integ_key = integ_key
        self.crypto_alg = crypto_alg
        self.crypto_key = crypto_key
        self.proto = proto
        self.salt = salt

        self.tun_src = tun_src
        self.tun_dst = tun_dst
        if not flags:
            self.flags = e.IPSEC_API_SAD_FLAG_NONE
        else:
            self.flags = flags
        if (tun_src):
            self.tun_src = ip_address(text_type(tun_src))
            self.flags = self.flags | e.IPSEC_API_SAD_FLAG_IS_TUNNEL
            if (self.tun_src.version == 6):
                self.flags = self.flags | e.IPSEC_API_SAD_FLAG_IS_TUNNEL_V6
        if (tun_dst):
            self.tun_dst = ip_address(text_type(tun_dst))

    def add_vpp_config(self):
        r = self.test.vapi.ipsec_sad_entry_add_del(
            self.id,
            self.spi,
            self.integ_alg,
            self.integ_key,
            self.crypto_alg,
            self.crypto_key,
            self.proto,
            (self.tun_src if self.tun_src else []),
            (self.tun_dst if self.tun_dst else []),
            flags=self.flags,
            salt=self.salt)
        self.stat_index = r.stat_index
        self.test.registry.register(self, self.test.logger)

    def remove_vpp_config(self):
        self.test.vapi.ipsec_sad_entry_add_del(
            self.id,
            self.spi,
            self.integ_alg,
            self.integ_key,
            self.crypto_alg,
            self.crypto_key,
            self.proto,
            (self.tun_src if self.tun_src else []),
            (self.tun_dst if self.tun_dst else []),
            flags=self.flags,
            is_add=0)

    def object_id(self):
        return "ipsec-sa-%d" % self.id

    def query_vpp_config(self):
        bs = self.test.vapi.ipsec_sa_dump()
        for b in bs:
            if b.entry.sad_id == self.id:
                return True
        return False

    def get_stats(self):
        c = self.test.statistics.get_counter("/net/ipsec/sa")
        return c[0][self.stat_index]
an> = vec_len (h->free_elts)) > 0) { e = elt_at (h, h->free_elts[l - 1]); _vec_len (h->free_elts) -= 1; } else vec_add2 (h->elts, e, 1); return e; } /* Return pointer to object at given offset. Used to write free list index of free objects. */ always_inline u32 * elt_data (void *v, heap_elt_t * e) { heap_header_t *h = heap_header (v); return v + heap_offset (e) * h->elt_bytes; } always_inline void set_free_elt (void *v, heap_elt_t * e, uword fi) { heap_header_t *h = heap_header (v); e->offset |= HEAP_ELT_FREE_BIT; if (h->elt_bytes >= sizeof (u32)) { *elt_data (v, e) = fi; } else { /* For elt_bytes < 4 we must store free index in separate vector. */ uword elt_index = e - h->elts; vec_validate (h->small_free_elt_free_index, elt_index); h->small_free_elt_free_index[elt_index] = fi; } } always_inline uword get_free_elt (void *v, heap_elt_t * e, uword * bin_result) { heap_header_t *h = heap_header (v); uword fb, fi; ASSERT (heap_is_free (e)); fb = size_to_bin (heap_elt_size (v, e)); if (h->elt_bytes >= sizeof (u32)) { fi = *elt_data (v, e); } else { uword elt_index = e - h->elts; fi = vec_elt (h->small_free_elt_free_index, elt_index); } *bin_result = fb; return fi; } always_inline void remove_free_block (void *v, uword b, uword i) { heap_header_t *h = heap_header (v); uword l; ASSERT (b < vec_len (h->free_lists)); ASSERT (i < vec_len (h->free_lists[b])); l = vec_len (h->free_lists[b]); if (i < l - 1) { uword t = h->free_lists[b][l - 1]; h->free_lists[b][i] = t; set_free_elt (v, elt_at (h, t), i); } _vec_len (h->free_lists[b]) = l - 1; } static heap_elt_t * search_free_list (void *v, uword size) { heap_header_t *h = heap_header (v); heap_elt_t *f, *u; uword b, fb, f_size, f_index; word s, l; if (!v) return 0; /* Search free lists for bins >= given size. */ for (b = size_to_bin (size); b < vec_len (h->free_lists); b++) if ((l = vec_len (h->free_lists[b])) > 0) { /* Find an object that is large enough. Search list in reverse so that more recently freed objects will be allocated again sooner. */ do { l--; f_index = h->free_lists[b][l]; f = elt_at (h, f_index); f_size = heap_elt_size (v, f); if ((s = f_size - size) >= 0) break; } while (l >= 0); /* If we fail to find a large enough object, try the next larger size. */ if (l < 0) continue; ASSERT (heap_is_free (f)); /* Link in used object (u) after free object (f). */ if (s == 0) { u = f; fb = HEAP_N_BINS; } else { u = elt_new (h); f = elt_at (h, f_index); elt_insert_after (h, f, u); fb = size_to_bin (s); } u->offset = heap_offset (f) + s; if (fb != b) { if (fb < HEAP_N_BINS) { uword i; vec_validate (h->free_lists, fb); i = vec_len (h->free_lists[fb]); vec_add1 (h->free_lists[fb], f - h->elts); set_free_elt (v, f, i); } remove_free_block (v, b, l); } return u; } return 0; } static void combine_free_blocks (void *v, heap_elt_t * e0, heap_elt_t * e1); static inline void dealloc_elt (void *v, heap_elt_t * e) { heap_header_t *h = heap_header (v); uword b, l; heap_elt_t *n, *p; b = size_to_bin (heap_elt_size (v, e)); vec_validate (h->free_lists, b); l = vec_len (h->free_lists[b]); vec_add1 (h->free_lists[b], e - h->elts); set_free_elt (v, e, l); /* See if we can combine the block we just freed with neighboring free blocks. */ p = heap_prev (e); if (!heap_is_free (p)) p = e; n = heap_next (e); if (!heap_is_free (n)) n = e; if (p != n) combine_free_blocks (v, p, n); } void * _heap_alloc (void *v, uword size, uword align, uword elt_bytes, uword * offset_return, uword * handle_return) { uword offset = 0, align_size; heap_header_t *h; heap_elt_t *e; if (size == 0) goto error; /* Round up alignment to power of 2. */ if (align <= 1) { align = 0; align_size = size; } else { align = max_pow2 (align); align_size = size + align - 1; } e = search_free_list (v, align_size); /* If nothing found on free list, allocate object from end of vector. */ if (!e) { uword max_len; offset = vec_len (v); max_len = heap_get_max_len (v); if (max_len && offset + align_size > max_len) goto error; h = heap_header (v); if (!v || !(h->flags & HEAP_IS_STATIC)) v = _vec_resize (v, align_size, (offset + align_size) * elt_bytes, sizeof (h[0]), HEAP_DATA_ALIGN); else _vec_len (v) += align_size; if (offset == 0) { h = heap_header (v); h->elt_bytes = elt_bytes; } } h = heap_header (v); /* Add new element to doubly linked chain of elements. */ if (!e) { e = elt_new (h); e->offset = offset; elt_insert_after (h, last (h), e); } if (align > 0) { uword e_index; uword new_offset, old_offset; old_offset = e->offset; new_offset = (old_offset + align - 1) & ~(align - 1); e->offset = new_offset; e_index = e - h->elts; /* Free fragments before and after aligned object. */ if (new_offset > old_offset) { heap_elt_t *before_e = elt_new (h); before_e->offset = old_offset; elt_insert_before (h, h->elts + e_index, before_e); dealloc_elt (v, before_e); } if (new_offset + size < old_offset + align_size) { heap_elt_t *after_e = elt_new (h); after_e->offset = new_offset + size; elt_insert_after (h, h->elts + e_index, after_e); dealloc_elt (v, after_e); } e = h->elts + e_index; } h->used_count++; /* Keep track of used elements when debugging. This allows deallocation to check that passed objects are valid. */ if (CLIB_DEBUG > 0) { uword handle = e - h->elts; ASSERT (!clib_bitmap_get (h->used_elt_bitmap, handle)); h->used_elt_bitmap = clib_bitmap_ori (h->used_elt_bitmap, handle); } *offset_return = e->offset; *handle_return = e - h->elts; return v; error: *offset_return = *handle_return = ~0; return v; } void heap_dealloc (void *v, uword handle) { heap_header_t *h = heap_header (v); heap_elt_t *e; ASSERT (handle < vec_len (h->elts)); /* For debugging we keep track of indices for valid objects. We make sure user is not trying to free object with an invalid index. */ if (CLIB_DEBUG > 0) { ASSERT (clib_bitmap_get (h->used_elt_bitmap, handle)); h->used_elt_bitmap = clib_bitmap_andnoti (h->used_elt_bitmap, handle); } h->used_count--; e = h->elts + handle; ASSERT (!heap_is_free (e)); dealloc_elt (v, e); } /* While freeing objects at INDEX we noticed free blocks i0 <= index and i1 >= index. We combine these two or three blocks into one big free block. */ static void combine_free_blocks (void *v, heap_elt_t * e0, heap_elt_t * e1) { heap_header_t *h = heap_header (v); uword total_size, i, b, tb, ti, i_last, g_offset; heap_elt_t *e; struct { u32 index; u32 bin; u32 bin_index; } f[3], g; /* Compute total size of free objects i0 through i1. */ total_size = 0; for (i = 0, e = e0; 1; e = heap_next (e), i++) { ASSERT (i < ARRAY_LEN (f)); ti = get_free_elt (v, e, &tb); ASSERT (tb < vec_len (h->free_lists)); ASSERT (ti < vec_len (h->free_lists[tb])); f[i].index = h->free_lists[tb][ti]; f[i].bin = tb; f[i].bin_index = ti; total_size += heap_elt_size (v, elt_at (h, f[i].index)); if (e == e1) { i_last = i; break; } } /* Compute combined bin. See if all objects can be combined into existing bin. */ b = size_to_bin (total_size); g.index = g.bin_index = 0; for (i = 0; i <= i_last; i++) if (b == f[i].bin) { g = f[i]; break; } /* Make sure we found a bin. */ if (i > i_last) { g.index = elt_new (h) - h->elts; vec_validate (h->free_lists, b); g.bin_index = vec_len (h->free_lists[b]); vec_add1 (h->free_lists[b], g.index); elt_insert_before (h, elt_at (h, f[0].index), elt_at (h, g.index)); } g_offset = elt_at (h, f[0].index)->offset; /* Delete unused bins. */ for (i = 0; i <= i_last; i++) if (g.index != f[i].index) { ti = get_free_elt (v, elt_at (h, f[i].index), &tb); remove_free_block (v, tb, ti); elt_delete (h, elt_at (h, f[i].index)); } /* Initialize new element. */ elt_at (h, g.index)->offset = g_offset; set_free_elt (v, elt_at (h, g.index), g.bin_index); } uword heap_len (void *v, word handle) { heap_header_t *h = heap_header (v); if (CLIB_DEBUG > 0) ASSERT (clib_bitmap_get (h->used_elt_bitmap, handle)); return heap_elt_size (v, elt_at (h, handle)); } void * _heap_free (void *v) { heap_header_t *h = heap_header (v); uword b; if (!v) return v; clib_bitmap_free (h->used_elt_bitmap); for (b = 0; b < vec_len (h->free_lists); b++) vec_free (h->free_lists[b]); vec_free (h->free_lists); vec_free (h->elts); vec_free (h->free_elts); vec_free (h->small_free_elt_free_index); if (!(h->flags & HEAP_IS_STATIC)) vec_free_h (v, sizeof (h[0])); return v; } uword heap_bytes (void *v) { heap_header_t *h = heap_header (v); uword bytes, b; if (!v) return 0; bytes = sizeof (h[0]); bytes += vec_len (v) * sizeof (h->elt_bytes); for (b = 0; b < vec_len (h->free_lists); b++) bytes += vec_capacity (h->free_lists[b], 0); bytes += vec_bytes (h->free_lists); bytes += vec_capacity (h->elts, 0); bytes += vec_capacity (h->free_elts, 0); bytes += vec_bytes (h->used_elt_bitmap); return bytes; } static u8 * debug_elt (u8 * s, void *v, word i, word n) { heap_elt_t *e, *e0, *e1; heap_header_t *h = heap_header (v); word j; if (vec_len (h->elts) == 0) return s; if (i < 0) e0 = first (h); else { e0 = h->elts + i; for (j = 0; j < n / 2; j++) e0 = heap_prev (e0); } if (n < 0) e1 = h->elts + h->tail; else { e1 = h->elts + i; for (j = 0; j < n / 2; j++) e1 = heap_next (e1); } i = -n / 2; for (e = e0; 1; e = heap_next (e)) { if (heap_is_free (e)) s = format (s, "index %4d, free\n", e - h->elts); else if (h->format_elt) s = format (s, "%U", h->format_elt, v, elt_data (v, e)); else s = format (s, "index %4d, used\n", e - h->elts); i++; if (e == e1) break; } return s; } u8 * format_heap (u8 * s, va_list * va) { void *v = va_arg (*va, void *); uword verbose = va_arg (*va, uword); heap_header_t *h = heap_header (v); heap_header_t zero; memset (&zero, 0, sizeof (zero)); if (!v) h = &zero; { f64 elt_bytes = vec_len (v) * h->elt_bytes; f64 overhead_bytes = heap_bytes (v); s = format (s, "heap %p, %6d objects, size %.1fk + overhead %.1fk\n", v, h->used_count, elt_bytes / 1024, (overhead_bytes - elt_bytes) / 1024); } if (v && verbose) s = debug_elt (s, v, -1, -1); return s; } void heap_validate (void *v) { heap_header_t *h = heap_header (v); uword i, o, s; u8 *free_map; heap_elt_t *e, *n; uword used_count, total_size; uword free_count, free_size; ASSERT (h->used_count == clib_bitmap_count_set_bits (h->used_elt_bitmap)); ASSERT (first (h)->prev == 0); ASSERT (last (h)->next == 0); /* Validate number of elements and size. */ free_size = free_count = 0; for (i = 0; i < vec_len (h->free_lists); i++) { free_count += vec_len (h->free_lists[i]); for (o = 0; o < vec_len (h->free_lists[i]); o++) { e = h->elts + h->free_lists[i][o]; s = heap_elt_size (v, e); ASSERT (size_to_bin (s) == i); ASSERT (heap_is_free (e)); free_size += s; } } { uword elt_free_size, elt_free_count; used_count = total_size = elt_free_size = elt_free_count = 0; for (e = first (h); 1; e = n) { int is_free = heap_is_free (e); used_count++; s = heap_elt_size (v, e); total_size += s; ASSERT (is_free == !clib_bitmap_get (h->used_elt_bitmap, e - h->elts)); if (is_free) { elt_free_count++; elt_free_size += s; } n = heap_next (e); if (e == n) { ASSERT (last (h) == n); break; } /* We should never have two free adjacent elements. */ ASSERT (!(heap_is_free (e) && heap_is_free (n))); } ASSERT (free_count == elt_free_count); ASSERT (free_size == elt_free_size); ASSERT (used_count == h->used_count + free_count); ASSERT (total_size == vec_len (v)); } free_map = vec_new (u8, used_count); e = first (h); for (i = o = 0; 1; i++) { ASSERT (heap_offset (e) == o); s = heap_elt_size (v, e); if (heap_is_free (e)) { uword fb, fi; fi = get_free_elt (v, e, &fb); ASSERT (fb < vec_len (h->free_lists)); ASSERT (fi < vec_len (h->free_lists[fb])); ASSERT (h->free_lists[fb][fi] == e - h->elts); ASSERT (!free_map[i]); free_map[i] = 1; } n = heap_next (e); if (e == n) break; ASSERT (heap_prev (n) == e); o += s; e = n; } vec_free (free_map); } /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */