2 * Copyright (c) 2018 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef __GBP_ENDPOINT_H__
17 #define __GBP_ENDPOINT_H__
19 #include <plugins/gbp/gbp_types.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/ethernet/mac_address.h>
23 #include <vppinfra/bihash_16_8.h>
24 #include <vppinfra/bihash_template.h>
25 #include <vppinfra/bihash_24_8.h>
26 #include <vppinfra/bihash_template.h>
29 * Flags for each endpoint
31 typedef enum gbp_endpoint_attr_t_
33 GBP_ENDPOINT_ATTR_FIRST = 0,
34 GBP_ENDPOINT_ATTR_BOUNCE = GBP_ENDPOINT_ATTR_FIRST,
35 GBP_ENDPOINT_ATTR_REMOTE,
36 GBP_ENDPOINT_ATTR_LEARNT,
37 GBP_ENDPOINT_ATTR_EXTERNAL,
38 GBP_ENDPOINT_ATTR_LAST,
39 } gbp_endpoint_attr_t;
41 typedef enum gbp_endpoint_flags_t_
43 GBP_ENDPOINT_FLAG_NONE = 0,
44 GBP_ENDPOINT_FLAG_BOUNCE = (1 << GBP_ENDPOINT_ATTR_BOUNCE),
45 GBP_ENDPOINT_FLAG_REMOTE = (1 << GBP_ENDPOINT_ATTR_REMOTE),
46 GBP_ENDPOINT_FLAG_LEARNT = (1 << GBP_ENDPOINT_ATTR_LEARNT),
47 GBP_ENDPOINT_FLAG_EXTERNAL = (1 << GBP_ENDPOINT_ATTR_EXTERNAL),
48 } gbp_endpoint_flags_t;
50 #define GBP_ENDPOINT_ATTR_NAMES { \
51 [GBP_ENDPOINT_ATTR_BOUNCE] = "bounce", \
52 [GBP_ENDPOINT_ATTR_REMOTE] = "remote", \
53 [GBP_ENDPOINT_ATTR_LEARNT] = "learnt", \
54 [GBP_ENDPOINT_ATTR_EXTERNAL] = "external", \
57 extern u8 *format_gbp_endpoint_flags (u8 * s, va_list * args);
60 * Sources of Endpoints in priority order. The best (lowest value) source
61 * provides the forwarding information.
62 * Data-plane takes preference because the CP data is not always complete,
63 * it may not have the sclass.
65 #define foreach_gbp_endpoint_src \
67 _(CP, "control-plane") \
68 _(RR, "recursive-resolution")
70 typedef enum gbp_endpoint_src_t_
72 #define _(v,s) GBP_ENDPOINT_SRC_##v,
73 foreach_gbp_endpoint_src
77 #define GBP_ENDPOINT_SRC_MAX (GBP_ENDPOINT_SRC_RR+1)
79 extern u8 *format_gbp_endpoint_src (u8 * s, va_list * args);
82 * This is the identity of an endpoint, as such it is information
83 * about an endpoint that is idempotent.
84 * The ID is used to add the EP into the various data-bases for retrieval.
86 typedef struct gbp_endpoint_key_t_
89 * A vector of ip addresses that belong to the endpoint.
90 * Together with the route EPG's RD this forms the EP's L3 key
92 fib_prefix_t *gek_ips;
95 * MAC address of the endpoint.
96 * Together with the route EPG's BD this forms the EP's L2 key
98 mac_address_t gek_mac;
101 * Index of the Bridge-Domain
106 * Index of the Route-Domain
109 } gbp_endpoint_key_t;
112 * Information about the location of the endpoint provided by a source
115 typedef struct gbp_endpoint_loc_t_
118 * The source providing this location information
120 gbp_endpoint_src_t gel_src;
123 * The interface on which the EP is connected
130 gbp_endpoint_flags_t gel_flags;
138 * number of times this source has locked this
143 * Tunnel info for remote endpoints
147 u32 gel_parent_sw_if_index;
148 ip46_address_t gel_src;
149 ip46_address_t gel_dst;
151 } gbp_endpoint_loc_t;
154 * And endpoints current forwarding state
156 typedef struct gbp_endpoint_fwd_t_
159 * The interface on which the EP is connected
164 * The L3 adj, if created
169 * Endpoint Group's sclass. cached for fast DP access.
174 * FIB index the EP is in
178 gbp_endpoint_flags_t gef_flags;
179 } gbp_endpoint_fwd_t;
182 * A Group Based Policy Endpoint.
183 * This is typically a VM or container. If the endpoint is local (i.e. on
184 * the same compute node as VPP) then there is one interface per-endpoint.
185 * If the EP is remote,e.g. reachable over a [vxlan] tunnel, then there
186 * will be multiple EPs reachable over the tunnel and they can be distinguished
187 * via either their MAC or IP Address[es].
189 typedef struct gbp_endpoint_t_
192 * A FIB node that allows the tracking of children.
197 * The key/ID of this EP
199 gbp_endpoint_key_t ge_key;
202 * Location information provided by the various sources.
203 * These are sorted based on source priority.
205 gbp_endpoint_loc_t *ge_locs;
207 gbp_endpoint_fwd_t ge_fwd;
210 * The last time a packet from seen from this end point
215 extern u8 *format_gbp_endpoint (u8 * s, va_list * args);
218 * GBP Endpoint Databases
220 typedef struct gbp_ep_by_ip_itf_db_t_
222 index_t *ged_by_sw_if_index;
223 clib_bihash_24_8_t ged_by_ip_rd;
224 clib_bihash_16_8_t ged_by_mac_bd;
227 extern int gbp_endpoint_update_and_lock (gbp_endpoint_src_t src,
229 const ip46_address_t * ip,
230 const mac_address_t * mac,
231 index_t gbd, index_t grd,
233 gbp_endpoint_flags_t flags,
234 const ip46_address_t * tun_src,
235 const ip46_address_t * tun_dst,
237 extern void gbp_endpoint_unlock (gbp_endpoint_src_t src, index_t gbpei);
238 extern u32 gbp_endpoint_child_add (index_t gei,
239 fib_node_type_t type,
240 fib_node_index_t index);
241 extern void gbp_endpoint_child_remove (index_t gei, u32 sibling);
243 typedef walk_rc_t (*gbp_endpoint_cb_t) (index_t gbpei, void *ctx);
244 extern void gbp_endpoint_walk (gbp_endpoint_cb_t cb, void *ctx);
245 extern void gbp_endpoint_scan (vlib_main_t * vm);
246 extern int gbp_endpoint_is_remote (const gbp_endpoint_t * ge);
247 extern int gbp_endpoint_is_local (const gbp_endpoint_t * ge);
248 extern int gbp_endpoint_is_external (const gbp_endpoint_t * ge);
249 extern int gbp_endpoint_is_learnt (const gbp_endpoint_t * ge);
252 extern void gbp_endpoint_flush (gbp_endpoint_src_t src, u32 sw_if_index);
255 * DP functions and databases
257 extern gbp_ep_db_t gbp_ep_db;
258 extern gbp_endpoint_t *gbp_endpoint_pool;
261 * Get the endpoint from a port/interface
263 always_inline gbp_endpoint_t *
264 gbp_endpoint_get (index_t gbpei)
266 return (pool_elt_at_index (gbp_endpoint_pool, gbpei));
269 static_always_inline void
270 gbp_endpoint_mk_key_mac (const u8 * mac,
271 u32 bd_index, clib_bihash_kv_16_8_t * key)
273 key->key[0] = ethernet_mac_address_u64 (mac);
274 key->key[1] = bd_index;
277 static_always_inline gbp_endpoint_t *
278 gbp_endpoint_find_mac (const u8 * mac, u32 bd_index)
280 clib_bihash_kv_16_8_t key, value;
283 gbp_endpoint_mk_key_mac (mac, bd_index, &key);
285 rv = clib_bihash_search_16_8 (&gbp_ep_db.ged_by_mac_bd, &key, &value);
290 return (gbp_endpoint_get (value.value));
293 static_always_inline void
294 gbp_endpoint_mk_key_ip (const ip46_address_t * ip,
295 u32 fib_index, clib_bihash_kv_24_8_t * key)
297 key->key[0] = ip->as_u64[0];
298 key->key[1] = ip->as_u64[1];
299 key->key[2] = fib_index;
302 static_always_inline void
303 gbp_endpoint_mk_key_ip4 (const ip4_address_t * ip,
304 u32 fib_index, clib_bihash_kv_24_8_t * key)
306 const ip46_address_t a = {
309 gbp_endpoint_mk_key_ip (&a, fib_index, key);
312 static_always_inline gbp_endpoint_t *
313 gbp_endpoint_find_ip4 (const ip4_address_t * ip, u32 fib_index)
315 clib_bihash_kv_24_8_t key, value;
318 gbp_endpoint_mk_key_ip4 (ip, fib_index, &key);
320 rv = clib_bihash_search_24_8 (&gbp_ep_db.ged_by_ip_rd, &key, &value);
325 return (gbp_endpoint_get (value.value));
328 static_always_inline void
329 gbp_endpoint_mk_key_ip6 (const ip6_address_t * ip,
330 u32 fib_index, clib_bihash_kv_24_8_t * key)
332 key->key[0] = ip->as_u64[0];
333 key->key[1] = ip->as_u64[1];
334 key->key[2] = fib_index;
337 static_always_inline gbp_endpoint_t *
338 gbp_endpoint_find_ip6 (const ip6_address_t * ip, u32 fib_index)
340 clib_bihash_kv_24_8_t key, value;
343 gbp_endpoint_mk_key_ip6 (ip, fib_index, &key);
345 rv = clib_bihash_search_24_8 (&gbp_ep_db.ged_by_ip_rd, &key, &value);
350 return (gbp_endpoint_get (value.value));
353 static_always_inline gbp_endpoint_t *
354 gbp_endpoint_find_itf (u32 sw_if_index)
358 gei = gbp_ep_db.ged_by_sw_if_index[sw_if_index];
360 if (INDEX_INVALID != gei)
361 return (gbp_endpoint_get (gei));
370 * fd.io coding-style-patch-verification: ON
373 * eval: (c-set-style "gnu")