zebra/zebra_router.h

   1 /* Zebra Router header.
   2  * Copyright (C) 2018 Cumulus Networks, Inc.
   3  *                    Donald Sharp
   4  *
   5  * This file is part of FRR.
   6  *
   7  * FRR is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2, or (at your option) any
  10  * later version.
  11  *
  12  * FRR is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with FRR; see the file COPYING.  If not, write to the Free
  19  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20  * 02111-1307, USA.
  21  */
  22 #ifndef __ZEBRA_ROUTER_H__
  23 #define __ZEBRA_ROUTER_H__
  24
  25 #include "lib/mlag.h"
  26
  27 #include "zebra/zebra_ns.h"
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /*
  34  * This header file contains the idea of a router and as such
  35  * owns data that is associated with a router from zebra's
  36  * perspective.
  37  */
  38
  39 struct zebra_router_table {
  40         RB_ENTRY(zebra_router_table) zebra_router_table_entry;
  41
  42         uint32_t tableid;
  43         afi_t afi;
  44         safi_t safi;
  45         ns_id_t ns_id;
  46
  47         struct route_table *table;
  48 };
  49 RB_HEAD(zebra_router_table_head, zebra_router_table);
  50 RB_PROTOTYPE(zebra_router_table_head, zebra_router_table,
  51              zebra_router_table_entry, zebra_router_table_entry_compare)
  52
  53 struct zebra_mlag_info {
  54         /* Role this zebra router is playing */
  55         enum mlag_role role;
  56
  57         /* The peerlink being used for mlag */
  58         char *peerlink;
  59         ifindex_t peerlink_ifindex;
  60
  61         /* The system mac being used */
  62         struct ethaddr mac;
  63 };
  64
  65 struct zebra_router {
  66         /* Thread master */
  67         struct thread_master *master;
  68
  69         /* Lists of clients who have connected to us */
  70         struct list *client_list;
  71
  72         struct zebra_router_table_head tables;
  73
  74         /* L3-VNI hash table (for EVPN). Only in default instance */
  75         struct hash *l3vni_table;
  76
  77         struct hash *rules_hash;
  78
  79         struct hash *ipset_hash;
  80
  81         struct hash *ipset_entry_hash;
  82
  83         struct hash *iptable_hash;
  84
  85 #if defined(HAVE_RTADV)
  86         struct rtadv rtadv;
  87 #endif /* HAVE_RTADV */
  88
  89         /* A sequence number used for tracking routes */
  90         _Atomic uint32_t sequence_num;
  91
  92         /* rib work queue */
  93 #define ZEBRA_RIB_PROCESS_HOLD_TIME 10
  94 #define ZEBRA_RIB_PROCESS_RETRY_TIME 1
  95         struct work_queue *ribq;
  96
  97         /* Meta Queue Information */
  98         struct meta_queue *mq;
  99
 100         /* LSP work queue */
 101         struct work_queue *lsp_process_q;
 102
 103 #define ZEBRA_ZAPI_PACKETS_TO_PROCESS 1000
 104         _Atomic uint32_t packets_to_process;
 105
 106         /* Mlag information for the router */
 107         struct zebra_mlag_info mlag_info;
 108
 109         /*
 110          * The EVPN instance, if any
 111          */
 112         struct zebra_vrf *evpn_vrf;
 113
 114         uint32_t multipath_num;
 115 };
 116
 117 extern struct zebra_router zrouter;
 118
 119 extern void zebra_router_init(void);
 120 extern void zebra_router_terminate(void);
 121
 122 extern struct route_table *zebra_router_find_table(struct zebra_vrf *zvrf,
 123                                                    uint32_t tableid, afi_t afi,
 124                                                    safi_t safi);
 125 extern struct route_table *zebra_router_get_table(struct zebra_vrf *zvrf,
 126                                                   uint32_t tableid, afi_t afi,
 127                                                   safi_t safi);
 128 extern void zebra_router_release_table(struct zebra_vrf *zvrf, uint32_t tableid,
 129                                        afi_t afi, safi_t safi);
 130
 131 extern int zebra_router_config_write(struct vty *vty);
 132
 133 extern void zebra_router_sweep_route(void);
 134
 135 extern void zebra_router_show_table_summary(struct vty *vty);
 136
 137 extern uint32_t zebra_router_get_next_sequence(void);
 138
 139 static inline vrf_id_t zebra_vrf_get_evpn_id(void)
 140 {
 141         return zrouter.evpn_vrf ? zvrf_id(zrouter.evpn_vrf) : VRF_DEFAULT;
 142 }
 143 static inline struct zebra_vrf *zebra_vrf_get_evpn(void)
 144 {
 145         return zrouter.evpn_vrf ? zrouter.evpn_vrf
 146                                 : zebra_vrf_lookup_by_id(VRF_DEFAULT);
 147 }
 148
 149 #ifdef __cplusplus
 150 }
 151 #endif
 152
 153 #endif