/* * Zebra EVPN MAC Data structures and definitions * These are "internal" to this function. * Copyright (C) 2016, 2017 Cumulus Networks, Inc. * Copyright (C) 2020 Volta Networks. * * This file is part of FRR. * * FRR is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the * Free Software Foundation; either version 2, or (at your option) any * later version. * * FRR is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with FRR; see the file COPYING. If not, write to the Free * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA * 02111-1307, USA. */ #ifndef _ZEBRA_EVPN_MAC_H #define _ZEBRA_EVPN_MAC_H #ifdef __cplusplus extern "C" { #endif struct host_rb_entry { RB_ENTRY(host_rb_entry) hl_entry; struct prefix p; }; RB_HEAD(host_rb_tree_entry, host_rb_entry); RB_PROTOTYPE(host_rb_tree_entry, host_rb_entry, hl_entry, host_rb_entry_compare); /* * MAC hash table. * * This table contains the MAC addresses pertaining to this VNI. * This includes local MACs learnt on an attached VLAN that maps * to this VNI as well as remote MACs learnt and installed by BGP. * Local MACs will be known either on a VLAN sub-interface or * on (port, VLAN); however, it is sufficient for zebra to maintain * against the VNI i.e., it does not need to retain the local "port" * information. The correct VNI will be obtained as zebra maintains * the mapping (of VLAN to VNI). */ struct zebra_mac { /* MAC address. */ struct ethaddr macaddr; /* When modifying flags please fixup zebra_evpn_zebra_mac_flag_dump */ uint32_t flags; #define ZEBRA_MAC_LOCAL 0x01 #define ZEBRA_MAC_REMOTE 0x02 #define ZEBRA_MAC_AUTO 0x04 /* Auto created for neighbor. */ #define ZEBRA_MAC_STICKY 0x08 /* Static MAC */ #define ZEBRA_MAC_REMOTE_RMAC 0x10 /* remote router mac */ #define ZEBRA_MAC_DEF_GW 0x20 /* remote VTEP advertised MAC as default GW */ #define ZEBRA_MAC_REMOTE_DEF_GW 0x40 #define ZEBRA_MAC_DUPLICATE 0x80 #define ZEBRA_MAC_FPM_SENT 0x100 /* whether or not this entry was sent. */ /* MAC is locally active on an ethernet segment peer */ #define ZEBRA_MAC_ES_PEER_ACTIVE 0x200 /* MAC has been proxy-advertised by peers. This means we need to * keep the entry for forwarding but cannot advertise it */ #define ZEBRA_MAC_ES_PEER_PROXY 0x400 /* We have not been able to independently establish that the host is * local connected but one or more ES peers claims it is. * We will maintain the entry for forwarding purposes and continue * to advertise it as locally attached but with a "proxy" flag */ #define ZEBRA_MAC_LOCAL_INACTIVE 0x800 /* The MAC entry was created because of advertise_svi_mac */ #define ZEBRA_MAC_SVI 0x1000 #define ZEBRA_MAC_ALL_LOCAL_FLAGS (ZEBRA_MAC_LOCAL | ZEBRA_MAC_LOCAL_INACTIVE) #define ZEBRA_MAC_ALL_PEER_FLAGS \ (ZEBRA_MAC_ES_PEER_PROXY | ZEBRA_MAC_ES_PEER_ACTIVE) /* back pointer to zevpn */ struct zebra_evpn *zevpn; /* Local or remote info. * Note: fwd_info is only relevant if mac->es is NULL. */ union { struct { ifindex_t ifindex; ns_id_t ns_id; vlanid_t vid; } local; struct in_addr r_vtep_ip; } fwd_info; /* Local or remote ES */ struct zebra_evpn_es *es; /* memory used to link the mac to the es */ struct listnode es_listnode; /* access-port/bridge member. only relevant for local macs that * are associated with a zero-ESI, * XXX - this belongs in fwd_info.local; however fwd_info is * being cleared and memset to zero in different ways that can * mess up the links. */ struct interface *ifp; /* memory used to link the mac to the ifp */ struct listnode ifp_listnode; /* Mobility sequence numbers associated with this entry. */ uint32_t rem_seq; uint32_t loc_seq; /* List of neigh associated with this mac */ struct list *neigh_list; /* List of nexthop associated with this RMAC */ struct list *nh_list; /* Duplicate mac detection */ uint32_t dad_count; struct thread *dad_mac_auto_recovery_timer; struct timeval detect_start_time; time_t dad_dup_detect_time; /* used for ageing out the PEER_ACTIVE flag */ struct thread *hold_timer; /* number of neigh entries (using this mac) that have * ZEBRA_MAC_ES_PEER_ACTIVE or ZEBRA_NEIGH_ES_PEER_PROXY */ uint32_t sync_neigh_cnt; time_t uptime; }; /* * Context for MAC hash walk - used by callbacks. */ struct mac_walk_ctx { struct zebra_evpn *zevpn; /* EVPN hash */ struct zebra_vrf *zvrf; /* VRF - for client notification. */ int uninstall; /* uninstall from kernel? */ int upd_client; /* uninstall from client? */ uint32_t flags; #define DEL_LOCAL_MAC 0x1 #define DEL_REMOTE_MAC 0x2 #define DEL_ALL_MAC (DEL_LOCAL_MAC | DEL_REMOTE_MAC) #define DEL_REMOTE_MAC_FROM_VTEP 0x4 #define SHOW_REMOTE_MAC_FROM_VTEP 0x8 struct in_addr r_vtep_ip; /* To walk MACs from specific VTEP */ struct vty *vty; /* Used by VTY handlers */ uint32_t count; /* Used by VTY handlers */ struct json_object *json; /* Used for JSON Output */ bool print_dup; /* Used to print dup addr list */ }; struct rmac_walk_ctx { struct vty *vty; struct json_object *json; }; /* temporary datastruct to pass info between the mac-update and * neigh-update while handling mac-ip routes */ struct sync_mac_ip_ctx { bool ignore_macip; bool mac_created; bool mac_inactive; bool mac_dp_update_deferred; struct zebra_mac *mac; }; /**************************** SYNC MAC handling *****************************/ /* if the mac has been added of a mac-route from the peer * or if it is being referenced by a neigh added by the * peer we cannot let it age out i.e. we set the static bit * in the dataplane */ static inline bool zebra_evpn_mac_is_static(struct zebra_mac *mac) { return ((mac->flags & ZEBRA_MAC_ALL_PEER_FLAGS) || mac->sync_neigh_cnt); } /* mac needs to be locally active or active on an ES peer */ static inline bool zebra_evpn_mac_is_ready_for_bgp(uint32_t flags) { return (flags & ZEBRA_MAC_LOCAL) && (!(flags & ZEBRA_MAC_LOCAL_INACTIVE) || (flags & ZEBRA_MAC_ES_PEER_ACTIVE)); } void zebra_evpn_mac_stop_hold_timer(struct zebra_mac *mac); static inline void zebra_evpn_mac_clear_sync_info(struct zebra_mac *mac) { UNSET_FLAG(mac->flags, ZEBRA_MAC_ALL_PEER_FLAGS); zebra_evpn_mac_stop_hold_timer(mac); } static inline bool zebra_evpn_mac_in_use(struct zebra_mac *mac) { return !list_isempty(mac->neigh_list) || CHECK_FLAG(mac->flags, ZEBRA_MAC_SVI); } struct hash *zebra_mac_db_create(const char *desc); uint32_t num_valid_macs(struct zebra_evpn *zevi); uint32_t num_dup_detected_macs(struct zebra_evpn *zevi); int zebra_evpn_rem_mac_uninstall(struct zebra_evpn *zevi, struct zebra_mac *mac, bool force); int zebra_evpn_rem_mac_install(struct zebra_evpn *zevi, struct zebra_mac *mac, bool was_static); void zebra_evpn_deref_ip2mac(struct zebra_evpn *zevi, struct zebra_mac *mac); struct zebra_mac *zebra_evpn_mac_lookup(struct zebra_evpn *zevi, const struct ethaddr *mac); struct zebra_mac *zebra_evpn_mac_add(struct zebra_evpn *zevi, const struct ethaddr *macaddr); int zebra_evpn_mac_del(struct zebra_evpn *zevi, struct zebra_mac *mac); int zebra_evpn_macip_send_msg_to_client(uint32_t id, const struct ethaddr *macaddr, const struct ipaddr *ip, uint8_t flags, uint32_t seq, int state, struct zebra_evpn_es *es, uint16_t cmd); void zebra_evpn_print_mac(struct zebra_mac *mac, void *ctxt, json_object *json); void zebra_evpn_print_mac_hash(struct hash_bucket *bucket, void *ctxt); void zebra_evpn_print_mac_hash_detail(struct hash_bucket *bucket, void *ctxt); int zebra_evpn_sync_mac_dp_install(struct zebra_mac *mac, bool set_inactive, bool force_clear_static, const char *caller); void zebra_evpn_mac_send_add_del_to_client(struct zebra_mac *mac, bool old_bgp_ready, bool new_bgp_ready); void zebra_evpn_mac_del_all(struct zebra_evpn *zevi, int uninstall, int upd_client, uint32_t flags); int zebra_evpn_mac_send_add_to_client(vni_t vni, const struct ethaddr *macaddr, uint32_t mac_flags, uint32_t seq, struct zebra_evpn_es *es); int zebra_evpn_mac_send_del_to_client(vni_t vni, const struct ethaddr *macaddr, uint32_t flags, bool force); void zebra_evpn_send_mac_list_to_client(struct zebra_evpn *zevi); struct zebra_mac *zebra_evpn_proc_sync_mac_update( struct zebra_evpn *zevi, const struct ethaddr *macaddr, uint16_t ipa_len, const struct ipaddr *ipaddr, uint8_t flags, uint32_t seq, const esi_t *esi, struct sync_mac_ip_ctx *ctx); void zebra_evpn_sync_mac_del(struct zebra_mac *mac); void zebra_evpn_rem_mac_del(struct zebra_evpn *zevi, struct zebra_mac *mac); void zebra_evpn_print_dad_mac_hash(struct hash_bucket *bucket, void *ctxt); void zebra_evpn_print_dad_mac_hash_detail(struct hash_bucket *bucket, void *ctxt); int zebra_evpn_mac_remote_macip_add( struct zebra_evpn *zevpn, struct zebra_vrf *zvrf, const struct ethaddr *macaddr, uint16_t ipa_len, const struct ipaddr *ipaddr, struct zebra_mac **macp, struct in_addr vtep_ip, uint8_t flags, uint32_t seq, const esi_t *esi); int zebra_evpn_add_update_local_mac(struct zebra_vrf *zvrf, struct zebra_evpn *zevpn, struct interface *ifp, const struct ethaddr *macaddr, vlanid_t vid, bool sticky, bool local_inactive, bool dp_static, struct zebra_mac *mac); int zebra_evpn_del_local_mac(struct zebra_evpn *zevpn, struct zebra_mac *mac, bool clear_static); void zebra_evpn_mac_gw_macip_add(struct interface *ifp, struct zebra_evpn *zevpn, const struct ipaddr *ip, struct zebra_mac **macp, const struct ethaddr *macaddr, vlanid_t vlan_id, bool def_gw); void zebra_evpn_mac_svi_add(struct interface *ifp, struct zebra_evpn *zevpn); void zebra_evpn_mac_svi_del(struct interface *ifp, struct zebra_evpn *zevpn); void zebra_evpn_mac_ifp_del(struct interface *ifp); void zebra_evpn_mac_clear_fwd_info(struct zebra_mac *zmac); #ifdef __cplusplus } #endif #endif /*_ZEBRA_EVPN_MAC_H */