zebra/zebra_evpn_mac.h

   1 /*
   2  * Zebra EVPN MAC Data structures and definitions
   3  * These are "internal" to this function.
   4  * Copyright (C) 2016, 2017 Cumulus Networks, Inc.
   5  * Copyright (C) 2020 Volta Networks.
   6  *
   7  * This file is part of FRR.
   8  *
   9  * FRR is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the
  11  * Free Software Foundation; either version 2, or (at your option) any
  12  * later version.
  13  *
  14  * FRR is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with FRR; see the file COPYING.  If not, write to the Free
  21  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  22  * 02111-1307, USA.
  23  */
  24
  25 #ifndef _ZEBRA_EVPN_MAC_H
  26 #define _ZEBRA_EVPN_MAC_H
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 typedef struct zebra_mac_t_ zebra_mac_t;
  33
  34 struct host_rb_entry {
  35         RB_ENTRY(host_rb_entry) hl_entry;
  36
  37         struct prefix p;
  38 };
  39
  40 RB_HEAD(host_rb_tree_entry, host_rb_entry);
  41 RB_PROTOTYPE(host_rb_tree_entry, host_rb_entry, hl_entry,
  42              host_rb_entry_compare);
  43 /*
  44  * MAC hash table.
  45  *
  46  * This table contains the MAC addresses pertaining to this VNI.
  47  * This includes local MACs learnt on an attached VLAN that maps
  48  * to this VNI as well as remote MACs learnt and installed by BGP.
  49  * Local MACs will be known either on a VLAN sub-interface or
  50  * on (port, VLAN); however, it is sufficient for zebra to maintain
  51  * against the VNI i.e., it does not need to retain the local "port"
  52  * information. The correct VNI will be obtained as zebra maintains
  53  * the mapping (of VLAN to VNI).
  54  */
  55 struct zebra_mac_t_ {
  56         /* MAC address. */
  57         struct ethaddr macaddr;
  58
  59         /* When modifying flags please fixup zebra_evpn_zebra_mac_flag_dump */
  60         uint32_t flags;
  61 #define ZEBRA_MAC_LOCAL 0x01
  62 #define ZEBRA_MAC_REMOTE 0x02
  63 #define ZEBRA_MAC_AUTO 0x04     /* Auto created for neighbor. */
  64 #define ZEBRA_MAC_STICKY 0x08      /* Static MAC */
  65 #define ZEBRA_MAC_REMOTE_RMAC 0x10 /* remote router mac */
  66 #define ZEBRA_MAC_DEF_GW 0x20
  67 /* remote VTEP advertised MAC as default GW */
  68 #define ZEBRA_MAC_REMOTE_DEF_GW 0x40
  69 #define ZEBRA_MAC_DUPLICATE 0x80
  70 #define ZEBRA_MAC_FPM_SENT 0x100 /* whether or not this entry was sent. */
  71 /* MAC is locally active on an ethernet segment peer */
  72 #define ZEBRA_MAC_ES_PEER_ACTIVE 0x200
  73 /* MAC has been proxy-advertised by peers. This means we need to
  74  * keep the entry for forwarding but cannot advertise it
  75  */
  76 #define ZEBRA_MAC_ES_PEER_PROXY 0x400
  77 /* We have not been able to independently establish that the host is
  78  * local connected but one or more ES peers claims it is.
  79  * We will maintain the entry for forwarding purposes and continue
  80  * to advertise it as locally attached but with a "proxy" flag
  81  */
  82 #define ZEBRA_MAC_LOCAL_INACTIVE 0x800
  83
  84 #define ZEBRA_MAC_ALL_LOCAL_FLAGS (ZEBRA_MAC_LOCAL | ZEBRA_MAC_LOCAL_INACTIVE)
  85 #define ZEBRA_MAC_ALL_PEER_FLAGS                                               \
  86         (ZEBRA_MAC_ES_PEER_PROXY | ZEBRA_MAC_ES_PEER_ACTIVE)
  87
  88         /* back pointer to zevpn */
  89         zebra_evpn_t *zevpn;
  90
  91         /* Local or remote info. */
  92         union {
  93                 struct {
  94                         ifindex_t ifindex;
  95                         ns_id_t ns_id;
  96                         vlanid_t vid;
  97                 } local;
  98
  99                 struct in_addr r_vtep_ip;
 100         } fwd_info;
 101
 102         /* Local or remote ES */
 103         struct zebra_evpn_es *es;
 104         /* memory used to link the mac to the es */
 105         struct listnode es_listnode;
 106
 107         /* Mobility sequence numbers associated with this entry. */
 108         uint32_t rem_seq;
 109         uint32_t loc_seq;
 110
 111         /* List of neigh associated with this mac */
 112         struct list *neigh_list;
 113
 114         /* list of hosts pointing to this remote RMAC */
 115         struct host_rb_tree_entry host_rb;
 116
 117         /* Duplicate mac detection */
 118         uint32_t dad_count;
 119
 120         struct thread *dad_mac_auto_recovery_timer;
 121
 122         struct timeval detect_start_time;
 123
 124         time_t dad_dup_detect_time;
 125
 126         /* used for ageing out the PEER_ACTIVE flag */
 127         struct thread *hold_timer;
 128
 129         /* number of neigh entries (using this mac) that have
 130          * ZEBRA_MAC_ES_PEER_ACTIVE or ZEBRA_NEIGH_ES_PEER_PROXY
 131          */
 132         uint32_t sync_neigh_cnt;
 133
 134         time_t uptime;
 135 };
 136
 137 /*
 138  * Context for MAC hash walk - used by callbacks.
 139  */
 140 struct mac_walk_ctx {
 141         zebra_evpn_t *zevpn;    /* EVPN hash */
 142         struct zebra_vrf *zvrf; /* VRF - for client notification. */
 143         int uninstall;          /* uninstall from kernel? */
 144         int upd_client;         /* uninstall from client? */
 145
 146         uint32_t flags;
 147 #define DEL_LOCAL_MAC 0x1
 148 #define DEL_REMOTE_MAC 0x2
 149 #define DEL_ALL_MAC (DEL_LOCAL_MAC | DEL_REMOTE_MAC)
 150 #define DEL_REMOTE_MAC_FROM_VTEP 0x4
 151 #define SHOW_REMOTE_MAC_FROM_VTEP 0x8
 152
 153         struct in_addr r_vtep_ip; /* To walk MACs from specific VTEP */
 154
 155         struct vty *vty;          /* Used by VTY handlers */
 156         uint32_t count;           /* Used by VTY handlers */
 157         struct json_object *json; /* Used for JSON Output */
 158         bool print_dup;           /* Used to print dup addr list */
 159 };
 160
 161 struct rmac_walk_ctx {
 162         struct vty *vty;
 163         struct json_object *json;
 164 };
 165
 166 /* temporary datastruct to pass info between the mac-update and
 167  * neigh-update while handling mac-ip routes
 168  */
 169 struct sync_mac_ip_ctx {
 170         bool ignore_macip;
 171         bool mac_created;
 172         bool mac_inactive;
 173         bool mac_dp_update_deferred;
 174         zebra_mac_t *mac;
 175 };
 176
 177 /**************************** SYNC MAC handling *****************************/
 178 /* if the mac has been added of a mac-route from the peer
 179  * or if it is being referenced by a neigh added by the
 180  * peer we cannot let it age out i.e. we set the static bit
 181  * in the dataplane
 182  */
 183 static inline bool zebra_evpn_mac_is_static(zebra_mac_t *mac)
 184 {
 185         return ((mac->flags & ZEBRA_MAC_ALL_PEER_FLAGS) || mac->sync_neigh_cnt);
 186 }
 187
 188 /* mac needs to be locally active or active on an ES peer */
 189 static inline bool zebra_evpn_mac_is_ready_for_bgp(uint32_t flags)
 190 {
 191         return (flags & ZEBRA_MAC_LOCAL)
 192                && (!(flags & ZEBRA_MAC_LOCAL_INACTIVE)
 193                    || (flags & ZEBRA_MAC_ES_PEER_ACTIVE));
 194 }
 195
 196 void zebra_evpn_mac_stop_hold_timer(zebra_mac_t *mac);
 197
 198 static inline void zebra_evpn_mac_clear_sync_info(zebra_mac_t *mac)
 199 {
 200         UNSET_FLAG(mac->flags, ZEBRA_MAC_ALL_PEER_FLAGS);
 201         zebra_evpn_mac_stop_hold_timer(mac);
 202 }
 203
 204 struct hash *zebra_mac_db_create(const char *desc);
 205 uint32_t num_valid_macs(zebra_evpn_t *zevi);
 206 uint32_t num_dup_detected_macs(zebra_evpn_t *zevi);
 207 int zebra_evpn_rem_mac_uninstall(zebra_evpn_t *zevi, zebra_mac_t *mac,
 208                                  bool force);
 209 int zebra_evpn_rem_mac_install(zebra_evpn_t *zevi, zebra_mac_t *mac,
 210                                bool was_static);
 211 void zebra_evpn_deref_ip2mac(zebra_evpn_t *zevi, zebra_mac_t *mac);
 212 zebra_mac_t *zebra_evpn_mac_lookup(zebra_evpn_t *zevi, struct ethaddr *mac);
 213 zebra_mac_t *zebra_evpn_mac_add(zebra_evpn_t *zevi, struct ethaddr *macaddr);
 214 int zebra_evpn_mac_del(zebra_evpn_t *zevi, zebra_mac_t *mac);
 215 int zebra_evpn_macip_send_msg_to_client(uint32_t id, struct ethaddr *macaddr,
 216                                         struct ipaddr *ip, uint8_t flags,
 217                                         uint32_t seq, int state,
 218                                         struct zebra_evpn_es *es, uint16_t cmd);
 219 void zebra_evpn_print_mac(zebra_mac_t *mac, void *ctxt, json_object *json);
 220 void zebra_evpn_print_mac_hash(struct hash_bucket *bucket, void *ctxt);
 221 void zebra_evpn_print_mac_hash_detail(struct hash_bucket *bucket, void *ctxt);
 222 int zebra_evpn_sync_mac_dp_install(zebra_mac_t *mac, bool set_inactive,
 223                                    bool force_clear_static, const char *caller);
 224 void zebra_evpn_mac_send_add_del_to_client(zebra_mac_t *mac, bool old_bgp_ready,
 225                                            bool new_bgp_ready);
 226
 227 void zebra_evpn_mac_del_all(zebra_evpn_t *zevi, int uninstall, int upd_client,
 228                             uint32_t flags);
 229 int zebra_evpn_mac_send_add_to_client(vni_t vni, struct ethaddr *macaddr,
 230                                       uint32_t mac_flags, uint32_t seq,
 231                                       struct zebra_evpn_es *es);
 232 int zebra_evpn_mac_send_del_to_client(vni_t vni, struct ethaddr *macaddr,
 233                                       uint32_t flags, bool force);
 234 void zebra_evpn_send_mac_list_to_client(zebra_evpn_t *zevi);
 235 zebra_mac_t *
 236 zebra_evpn_proc_sync_mac_update(zebra_evpn_t *zevi, struct ethaddr *macaddr,
 237                                 uint16_t ipa_len, struct ipaddr *ipaddr,
 238                                 uint8_t flags, uint32_t seq, esi_t *esi,
 239                                 struct sync_mac_ip_ctx *ctx);
 240 void zebra_evpn_sync_mac_del(zebra_mac_t *mac);
 241 void zebra_evpn_rem_mac_del(zebra_evpn_t *zevi, zebra_mac_t *mac);
 242 void zebra_evpn_print_dad_mac_hash(struct hash_bucket *bucket, void *ctxt);
 243 void zebra_evpn_print_dad_mac_hash_detail(struct hash_bucket *bucket,
 244                                           void *ctxt);
 245 int process_mac_remote_macip_add(zebra_evpn_t *zevpn, struct zebra_vrf *zvrf,
 246                                  struct ethaddr *macaddr, uint16_t ipa_len,
 247                                  struct ipaddr *ipaddr, zebra_mac_t **macp,
 248                                  struct in_addr vtep_ip, uint8_t flags,
 249                                  uint32_t seq, esi_t *esi);
 250
 251 int zebra_evpn_add_update_local_mac(struct zebra_vrf *zvrf, zebra_evpn_t *zevpn,
 252                                     struct interface *ifp,
 253                                     struct ethaddr *macaddr, vlanid_t vid,
 254                                     bool sticky, bool local_inactive,
 255                                     bool dp_static);
 256 int zebra_evpn_del_local_mac(zebra_evpn_t *zevpn, struct ethaddr *macaddr,
 257                              struct interface *ifp);
 258 int zebra_evpn_mac_gw_macip_add(struct interface *ifp, zebra_evpn_t *zevpn,
 259                                 struct ipaddr *ip, zebra_mac_t **macp,
 260                                 struct ethaddr *macaddr, vlanid_t vlan_id);
 261
 262 #ifdef __cplusplus
 263 }
 264 #endif
 265
 266 #endif /*_ZEBRA_EVPN_MAC_H */