]> git.proxmox.com Git - mirror_frr.git/blame - zebra/zebra_vxlan_private.h
Merge pull request #3234 from donaldsharp/bsd_install_failure
[mirror_frr.git] / zebra / zebra_vxlan_private.h
CommitLineData
18a7a601 1/*
2 * Zebra VxLAN (EVPN) Data structures and definitions
3 * These are "internal" to this function.
4 * Copyright (C) 2016, 2017 Cumulus Networks, Inc.
5 *
6 * This file is part of FRR.
7 *
8 * FRR is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2, or (at your option) any
11 * later version.
12 *
13 * FRR is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with FRR; see the file COPYING. If not, write to the Free
20 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
21 * 02111-1307, USA.
22 */
23
24#ifndef _ZEBRA_VXLAN_PRIVATE_H
25#define _ZEBRA_VXLAN_PRIVATE_H
26
27#include <zebra.h>
28
29#include <zebra.h>
30
31#include "if.h"
32#include "linklist.h"
655b04d1 33#include "zebra_vxlan.h"
18a7a601 34
b7cfce93
MK
35#define ERR_STR_SZ 256
36
18a7a601 37/* definitions */
38typedef struct zebra_vni_t_ zebra_vni_t;
39typedef struct zebra_vtep_t_ zebra_vtep_t;
4122e252 40typedef struct zebra_mac_t_ zebra_mac_t;
41typedef struct zebra_neigh_t_ zebra_neigh_t;
b7cfce93 42typedef struct zebra_l3vni_t_ zebra_l3vni_t;
18a7a601 43
44/*
45 * VTEP info
46 *
47 * Right now, this just has each remote VTEP's IP address.
48 */
d62a17ae 49struct zebra_vtep_t_ {
50 /* Remote IP. */
51 /* NOTE: Can only be IPv4 right now. */
52 struct in_addr vtep_ip;
53
54 /* Links. */
55 struct zebra_vtep_t_ *next;
56 struct zebra_vtep_t_ *prev;
18a7a601 57};
58
59
60/*
61 * VNI hash table
62 *
63 * Contains information pertaining to a VNI:
64 * - the list of remote VTEPs (with this VNI)
65 */
d62a17ae 66struct zebra_vni_t_ {
67 /* VNI - key */
68 vni_t vni;
18a7a601 69
1a98c087 70 /* Flag for advertising gw macip */
d7c0a89a 71 uint8_t advertise_gw_macip;
1a98c087 72
31310b25 73 /* Flag for advertising gw macip */
d7c0a89a 74 uint8_t advertise_subnet;
31310b25 75
d62a17ae 76 /* Corresponding VxLAN interface. */
77 struct interface *vxlan_if;
18a7a601 78
d62a17ae 79 /* List of remote VTEPs */
80 zebra_vtep_t *vteps;
18a7a601 81
d62a17ae 82 /* Local IP */
83 struct in_addr local_vtep_ip;
4122e252 84
b7cfce93
MK
85 /* tenant VRF, if any */
86 vrf_id_t vrf_id;
87
d62a17ae 88 /* List of local or remote MAC */
89 struct hash *mac_table;
4122e252 90
d62a17ae 91 /* List of local or remote neighbors (MAC+IP) */
92 struct hash *neigh_table;
4122e252 93};
94
b7cfce93
MK
95/* L3 VNI hash table */
96struct zebra_l3vni_t_ {
97
98 /* VNI key */
99 vni_t vni;
100
101 /* vrf_id */
102 vrf_id_t vrf_id;
103
c48d9f5f
MK
104 uint32_t filter;
105#define PREFIX_ROUTES_ONLY (1 << 0) /* l3-vni used for prefix routes only */
106
b67a60d2 107 /* Local IP */
108 struct in_addr local_vtep_ip;
109
b7cfce93
MK
110 /* kernel interface for l3vni */
111 struct interface *vxlan_if;
112
113 /* SVI interface corresponding to the l3vni */
114 struct interface *svi_if;
115
116 /* list of L2 VNIs associated with the L3 VNI */
117 struct list *l2vnis;
118
119 /* list of remote router-macs */
120 struct hash *rmac_table;
121
122 /* list of remote vtep-ip neigh */
123 struct hash *nh_table;
124};
125
126/* get the vx-intf name for l3vni */
127static inline const char *zl3vni_vxlan_if_name(zebra_l3vni_t *zl3vni)
128{
129 return zl3vni->vxlan_if ? zl3vni->vxlan_if->name : "None";
130}
131
132/* get the svi intf name for l3vni */
133static inline const char *zl3vni_svi_if_name(zebra_l3vni_t *zl3vni)
134{
135 return zl3vni->svi_if ? zl3vni->svi_if->name : "None";
136}
137
138/* get the vrf name for l3vni */
139static inline const char *zl3vni_vrf_name(zebra_l3vni_t *zl3vni)
140{
141 return vrf_id_to_name(zl3vni->vrf_id);
142}
143
144/* get the rmac string */
145static inline const char *zl3vni_rmac2str(zebra_l3vni_t *zl3vni, char *buf,
146 int size)
147{
148 char *ptr;
149
150 if (!buf)
151 ptr = (char *)XMALLOC(MTYPE_TMP,
152 ETHER_ADDR_STRLEN * sizeof(char));
153 else {
154 assert(size >= ETHER_ADDR_STRLEN);
155 ptr = buf;
156 }
157
158 if (zl3vni->svi_if)
159 snprintf(ptr, (ETHER_ADDR_STRLEN),
160 "%02x:%02x:%02x:%02x:%02x:%02x",
161 (uint8_t)zl3vni->svi_if->hw_addr[0],
162 (uint8_t)zl3vni->svi_if->hw_addr[1],
163 (uint8_t)zl3vni->svi_if->hw_addr[2],
164 (uint8_t)zl3vni->svi_if->hw_addr[3],
165 (uint8_t)zl3vni->svi_if->hw_addr[4],
166 (uint8_t)zl3vni->svi_if->hw_addr[5]);
167 else
168 snprintf(ptr, ETHER_ADDR_STRLEN, "None");
169
170 return ptr;
171}
172
173/*
174 * l3-vni is oper up when:
655b04d1 175 * 0. if EVPN is enabled (advertise-all-vni cfged)
b7cfce93
MK
176 * 1. it is associated to a vxlan-intf
177 * 2. Associated vxlan-intf is oper up
178 * 3. it is associated to an SVI
179 * 4. associated SVI is oper up
180 */
181static inline int is_l3vni_oper_up(zebra_l3vni_t *zl3vni)
182{
996c9314
LB
183 return (is_evpn_enabled() && zl3vni && (zl3vni->vrf_id != VRF_UNKNOWN)
184 && zl3vni->vxlan_if && if_is_operative(zl3vni->vxlan_if)
185 && zl3vni->svi_if && if_is_operative(zl3vni->svi_if));
b7cfce93
MK
186}
187
188static inline const char *zl3vni_state2str(zebra_l3vni_t *zl3vni)
189{
190 if (!zl3vni)
191 return NULL;
192
193 if (is_l3vni_oper_up(zl3vni))
194 return "Up";
195 else
196 return "Down";
197
198 return NULL;
199}
200
201static inline vrf_id_t zl3vni_vrf_id(zebra_l3vni_t *zl3vni)
202{
203 return zl3vni->vrf_id;
204}
205
996c9314 206static inline void zl3vni_get_rmac(zebra_l3vni_t *zl3vni, struct ethaddr *rmac)
b7cfce93
MK
207{
208 if (!zl3vni)
209 return;
210
211 if (!is_l3vni_oper_up(zl3vni))
212 return;
213
214 if (zl3vni->svi_if && if_is_operative(zl3vni->svi_if))
215 memcpy(rmac->octet, zl3vni->svi_if->hw_addr, ETH_ALEN);
216}
217
5e1b0650
DS
218struct host_rb_entry {
219 RB_ENTRY(host_rb_entry) hl_entry;
220
221 struct prefix p;
222};
223
85442b09
DS
224RB_HEAD(host_rb_tree_entry, host_rb_entry);
225RB_PROTOTYPE(host_rb_tree_entry, host_rb_entry, hl_entry,
5e1b0650 226 host_rb_entry_compare);
4122e252 227/*
228 * MAC hash table.
229 *
230 * This table contains the MAC addresses pertaining to this VNI.
231 * This includes local MACs learnt on an attached VLAN that maps
232 * to this VNI as well as remote MACs learnt and installed by BGP.
233 * Local MACs will be known either on a VLAN sub-interface or
234 * on (port, VLAN); however, it is sufficient for zebra to maintain
235 * against the VNI i.e., it does not need to retain the local "port"
236 * information. The correct VNI will be obtained as zebra maintains
237 * the mapping (of VLAN to VNI).
238 */
d62a17ae 239struct zebra_mac_t_ {
240 /* MAC address. */
241 struct ethaddr macaddr;
4122e252 242
d7c0a89a 243 uint32_t flags;
4122e252 244#define ZEBRA_MAC_LOCAL 0x01
245#define ZEBRA_MAC_REMOTE 0x02
246#define ZEBRA_MAC_AUTO 0x04 /* Auto created for neighbor. */
c85c03c7 247#define ZEBRA_MAC_STICKY 0x08 /* Static MAC */
b7cfce93 248#define ZEBRA_MAC_REMOTE_RMAC 0x10 /* remote router mac */
ead40654 249#define ZEBRA_MAC_DEF_GW 0x20
51f4dab4
AK
250/* remote VTEP advertised MAC as default GW */
251#define ZEBRA_MAC_REMOTE_DEF_GW 0x40
4122e252 252
d62a17ae 253 /* Local or remote info. */
254 union {
255 struct {
256 ifindex_t ifindex;
257 vlanid_t vid;
258 } local;
4122e252 259
d62a17ae 260 struct in_addr r_vtep_ip;
261 } fwd_info;
4122e252 262
f07e1c99 263 /* Mobility sequence numbers associated with this entry. */
264 uint32_t rem_seq;
265 uint32_t loc_seq;
266
b6938a74
MK
267 /* List of neigh associated with this mac */
268 struct list *neigh_list;
b7cfce93 269
6134fd82 270 /* list of hosts pointing to this remote RMAC */
85442b09 271 struct host_rb_tree_entry host_rb;
4122e252 272};
273
274/*
275 * Context for MAC hash walk - used by callbacks.
276 */
d62a17ae 277struct mac_walk_ctx {
278 zebra_vni_t *zvni; /* VNI hash */
279 struct zebra_vrf *zvrf; /* VRF - for client notification. */
280 int uninstall; /* uninstall from kernel? */
281 int upd_client; /* uninstall from client? */
282
d7c0a89a 283 uint32_t flags;
4122e252 284#define DEL_LOCAL_MAC 0x1
285#define DEL_REMOTE_MAC 0x2
286#define DEL_ALL_MAC (DEL_LOCAL_MAC | DEL_REMOTE_MAC)
287#define DEL_REMOTE_MAC_FROM_VTEP 0x4
288#define SHOW_REMOTE_MAC_FROM_VTEP 0x8
289
d62a17ae 290 struct in_addr r_vtep_ip; /* To walk MACs from specific VTEP */
4122e252 291
cd233079 292 struct vty *vty; /* Used by VTY handlers */
d7c0a89a 293 uint32_t count; /* Used by VTY handlers */
cd233079 294 struct json_object *json; /* Used for JSON Output */
4122e252 295};
296
b7cfce93
MK
297struct rmac_walk_ctx {
298 struct vty *vty;
299 struct json_object *json;
300};
301
b6938a74
MK
302enum zebra_neigh_state { ZEBRA_NEIGH_INACTIVE = 0, ZEBRA_NEIGH_ACTIVE = 1 };
303
304#define IS_ZEBRA_NEIGH_ACTIVE(n) n->state == ZEBRA_NEIGH_ACTIVE
305
306#define IS_ZEBRA_NEIGH_INACTIVE(n) n->state == ZEBRA_NEIGH_INACTIVE
307
308#define ZEBRA_NEIGH_SET_ACTIVE(n) n->state = ZEBRA_NEIGH_ACTIVE
309
310#define ZEBRA_NEIGH_SET_INACTIVE(n) n->state = ZEBRA_NEIGH_INACTIVE
311
4122e252 312/*
313 * Neighbor hash table.
314 *
315 * This table contains the neighbors (IP to MAC bindings) pertaining to
316 * this VNI. This includes local neighbors learnt on the attached VLAN
317 * device that maps to this VNI as well as remote neighbors learnt and
318 * installed by BGP.
319 * Local neighbors will be known against the VLAN device (SVI); however,
320 * it is sufficient for zebra to maintain against the VNI. The correct
321 * VNI will be obtained as zebra maintains the mapping (of VLAN to VNI).
322 */
d62a17ae 323struct zebra_neigh_t_ {
324 /* IP address. */
325 struct ipaddr ip;
4122e252 326
d62a17ae 327 /* MAC address. */
328 struct ethaddr emac;
4122e252 329
d62a17ae 330 /* Underlying interface. */
331 ifindex_t ifindex;
4122e252 332
d7c0a89a 333 uint32_t flags;
b6938a74
MK
334#define ZEBRA_NEIGH_LOCAL 0x01
335#define ZEBRA_NEIGH_REMOTE 0x02
b7cfce93 336#define ZEBRA_NEIGH_REMOTE_NH 0x04 /* neigh entry for remote vtep */
ead40654 337#define ZEBRA_NEIGH_DEF_GW 0x08
68e33151 338#define ZEBRA_NEIGH_ROUTER_FLAG 0x10
b6938a74
MK
339
340 enum zebra_neigh_state state;
4122e252 341
d62a17ae 342 /* Remote VTEP IP - applicable only for remote neighbors. */
343 struct in_addr r_vtep_ip;
b7cfce93 344
f07e1c99 345 /*
346 * Mobility sequence numbers associated with this entry. The rem_seq
347 * represents the sequence number from the client (BGP) for the most
348 * recent add or update of this entry while the loc_seq represents
349 * the sequence number informed (or to be informed) by zebra to BGP
350 * for this entry.
351 */
352 uint32_t rem_seq;
353 uint32_t loc_seq;
354
6134fd82 355 /* list of hosts pointing to this remote NH entry */
85442b09 356 struct host_rb_tree_entry host_rb;
4122e252 357};
358
359/*
360 * Context for neighbor hash walk - used by callbacks.
361 */
d62a17ae 362struct neigh_walk_ctx {
363 zebra_vni_t *zvni; /* VNI hash */
364 struct zebra_vrf *zvrf; /* VRF - for client notification. */
365 int uninstall; /* uninstall from kernel? */
366 int upd_client; /* uninstall from client? */
367
d7c0a89a 368 uint32_t flags;
4122e252 369#define DEL_LOCAL_NEIGH 0x1
370#define DEL_REMOTE_NEIGH 0x2
371#define DEL_ALL_NEIGH (DEL_LOCAL_NEIGH | DEL_REMOTE_NEIGH)
372#define DEL_REMOTE_NEIGH_FROM_VTEP 0x4
373#define SHOW_REMOTE_NEIGH_FROM_VTEP 0x8
374
d62a17ae 375 struct in_addr r_vtep_ip; /* To walk neighbors from specific VTEP */
4122e252 376
cd233079 377 struct vty *vty; /* Used by VTY handlers */
d7c0a89a
QY
378 uint32_t count; /* Used by VTY handlers */
379 uint8_t addr_width; /* Used by VTY handlers */
cd233079 380 struct json_object *json; /* Used for JSON Output */
18a7a601 381};
382
b7cfce93
MK
383/* context for neigh hash walk - update l3vni and rmac */
384struct neigh_l3info_walk_ctx {
385
386 zebra_vni_t *zvni;
387 zebra_l3vni_t *zl3vni;
388 int add;
389};
390
391struct nh_walk_ctx {
392
393 struct vty *vty;
394 struct json_object *json;
395};
396
18a7a601 397#endif /* _ZEBRA_VXLAN_PRIVATE_H */