zebra/zebra_router.c

   1 /* Zebra Router Code.
   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 #include "zebra.h"
  23
  24 #include <pthread.h>
  25 #include "lib/frratomic.h"
  26
  27 #include "zebra_router.h"
  28 #include "zebra_pbr.h"
  29 #include "zebra_vxlan.h"
  30 #include "zebra_mlag.h"
  31 #include "zebra_nhg.h"
  32 #include "debug.h"
  33 #include "zebra_script.h"
  34
  35 DEFINE_MTYPE_STATIC(ZEBRA, RIB_TABLE_INFO, "RIB table info");
  36 DEFINE_MTYPE_STATIC(ZEBRA, ZEBRA_RT_TABLE, "Zebra VRF table");
  37
  38 struct zebra_router zrouter = {
  39         .multipath_num = MULTIPATH_NUM,
  40         .ipv4_multicast_mode = MCAST_NO_CONFIG,
  41 };
  42
  43 static inline int
  44 zebra_router_table_entry_compare(const struct zebra_router_table *e1,
  45                                  const struct zebra_router_table *e2);
  46
  47 RB_GENERATE(zebra_router_table_head, zebra_router_table,
  48             zebra_router_table_entry, zebra_router_table_entry_compare);
  49
  50
  51 static inline int
  52 zebra_router_table_entry_compare(const struct zebra_router_table *e1,
  53                                  const struct zebra_router_table *e2)
  54 {
  55         if (e1->tableid < e2->tableid)
  56                 return -1;
  57         if (e1->tableid > e2->tableid)
  58                 return 1;
  59         if (e1->ns_id < e2->ns_id)
  60                 return -1;
  61         if (e1->ns_id > e2->ns_id)
  62                 return 1;
  63         if (e1->afi < e2->afi)
  64                 return -1;
  65         if (e1->afi > e2->afi)
  66                 return 1;
  67         return (e1->safi - e2->safi);
  68 }
  69
  70 struct zebra_router_table *zebra_router_find_zrt(struct zebra_vrf *zvrf,
  71                                                  uint32_t tableid, afi_t afi,
  72                                                  safi_t safi)
  73 {
  74         struct zebra_router_table finder;
  75         struct zebra_router_table *zrt;
  76
  77         memset(&finder, 0, sizeof(finder));
  78         finder.afi = afi;
  79         finder.safi = safi;
  80         finder.tableid = tableid;
  81         finder.ns_id = zvrf->zns->ns_id;
  82         zrt = RB_FIND(zebra_router_table_head, &zrouter.tables, &finder);
  83
  84         return zrt;
  85 }
  86
  87 struct route_table *zebra_router_find_table(struct zebra_vrf *zvrf,
  88                                             uint32_t tableid, afi_t afi,
  89                                             safi_t safi)
  90 {
  91         struct zebra_router_table finder;
  92         struct zebra_router_table *zrt;
  93
  94         memset(&finder, 0, sizeof(finder));
  95         finder.afi = afi;
  96         finder.safi = safi;
  97         finder.tableid = tableid;
  98         finder.ns_id = zvrf->zns->ns_id;
  99         zrt = RB_FIND(zebra_router_table_head, &zrouter.tables, &finder);
 100
 101         if (zrt)
 102                 return zrt->table;
 103         else
 104                 return NULL;
 105 }
 106
 107 struct route_table *zebra_router_get_table(struct zebra_vrf *zvrf,
 108                                            uint32_t tableid, afi_t afi,
 109                                            safi_t safi)
 110 {
 111         struct zebra_router_table finder;
 112         struct zebra_router_table *zrt;
 113         struct rib_table_info *info;
 114
 115         memset(&finder, 0, sizeof(finder));
 116         finder.afi = afi;
 117         finder.safi = safi;
 118         finder.tableid = tableid;
 119         finder.ns_id = zvrf->zns->ns_id;
 120         zrt = RB_FIND(zebra_router_table_head, &zrouter.tables, &finder);
 121
 122         if (zrt)
 123                 return zrt->table;
 124
 125         zrt = XCALLOC(MTYPE_ZEBRA_RT_TABLE, sizeof(*zrt));
 126         zrt->tableid = tableid;
 127         zrt->afi = afi;
 128         zrt->safi = safi;
 129         zrt->ns_id = zvrf->zns->ns_id;
 130         zrt->table =
 131                 (afi == AFI_IP6) ? srcdest_table_init() : route_table_init();
 132
 133         info = XCALLOC(MTYPE_RIB_TABLE_INFO, sizeof(*info));
 134         info->zvrf = zvrf;
 135         info->afi = afi;
 136         info->safi = safi;
 137         info->table_id = tableid;
 138         route_table_set_info(zrt->table, info);
 139         zrt->table->cleanup = zebra_rtable_node_cleanup;
 140
 141         RB_INSERT(zebra_router_table_head, &zrouter.tables, zrt);
 142         return zrt->table;
 143 }
 144
 145 void zebra_router_show_table_summary(struct vty *vty)
 146 {
 147         struct zebra_router_table *zrt;
 148
 149         vty_out(vty,
 150                 "VRF             NS ID    VRF ID     AFI            SAFI    Table      Count\n");
 151         vty_out(vty,
 152                 "---------------------------------------------------------------------------\n");
 153         RB_FOREACH (zrt, zebra_router_table_head, &zrouter.tables) {
 154                 struct rib_table_info *info = route_table_get_info(zrt->table);
 155
 156                 vty_out(vty, "%-16s%5d %9d %7s %15s %8d %10lu\n", info->zvrf->vrf->name,
 157                         zrt->ns_id, info->zvrf->vrf->vrf_id,
 158                         afi2str(zrt->afi), safi2str(zrt->safi),
 159                         zrt->tableid,
 160                         zrt->table->count);
 161         }
 162 }
 163
 164 void zebra_router_sweep_route(void)
 165 {
 166         struct zebra_router_table *zrt;
 167
 168         RB_FOREACH (zrt, zebra_router_table_head, &zrouter.tables) {
 169                 if (zrt->ns_id != NS_DEFAULT)
 170                         continue;
 171                 rib_sweep_table(zrt->table);
 172         }
 173 }
 174
 175 void zebra_router_sweep_nhgs(void)
 176 {
 177         zebra_nhg_sweep_table(zrouter.nhgs_id);
 178 }
 179
 180 static void zebra_router_free_table(struct zebra_router_table *zrt)
 181 {
 182         void *table_info;
 183
 184         table_info = route_table_get_info(zrt->table);
 185         route_table_finish(zrt->table);
 186         RB_REMOVE(zebra_router_table_head, &zrouter.tables, zrt);
 187
 188         XFREE(MTYPE_RIB_TABLE_INFO, table_info);
 189         XFREE(MTYPE_ZEBRA_RT_TABLE, zrt);
 190 }
 191
 192 void zebra_router_release_table(struct zebra_vrf *zvrf, uint32_t tableid,
 193                                 afi_t afi, safi_t safi)
 194 {
 195         struct zebra_router_table finder;
 196         struct zebra_router_table *zrt;
 197
 198         memset(&finder, 0, sizeof(finder));
 199         finder.afi = afi;
 200         finder.safi = safi;
 201         finder.tableid = tableid;
 202         finder.ns_id = zvrf->zns->ns_id;
 203         zrt = RB_FIND(zebra_router_table_head, &zrouter.tables, &finder);
 204
 205         if (!zrt)
 206                 return;
 207
 208         zebra_router_free_table(zrt);
 209 }
 210
 211 uint32_t zebra_router_get_next_sequence(void)
 212 {
 213         return 1
 214                + atomic_fetch_add_explicit(&zrouter.sequence_num, 1,
 215                                            memory_order_relaxed);
 216 }
 217
 218 void multicast_mode_ipv4_set(enum multicast_mode mode)
 219 {
 220         if (IS_ZEBRA_DEBUG_RIB)
 221                 zlog_debug("%s: multicast lookup mode set (%d)", __func__,
 222                            mode);
 223         zrouter.ipv4_multicast_mode = mode;
 224 }
 225
 226 enum multicast_mode multicast_mode_ipv4_get(void)
 227 {
 228         return zrouter.ipv4_multicast_mode;
 229 }
 230
 231 void zebra_router_terminate(void)
 232 {
 233         struct zebra_router_table *zrt, *tmp;
 234
 235         THREAD_OFF(zrouter.sweeper);
 236
 237         RB_FOREACH_SAFE (zrt, zebra_router_table_head, &zrouter.tables, tmp)
 238                 zebra_router_free_table(zrt);
 239
 240         work_queue_free_and_null(&zrouter.ribq);
 241         meta_queue_free(zrouter.mq);
 242
 243         zebra_vxlan_disable();
 244         zebra_mlag_terminate();
 245
 246         /* Free NHE in ID table only since it has unhashable entries as well */
 247         hash_clean(zrouter.nhgs_id, zebra_nhg_hash_free);
 248         hash_free(zrouter.nhgs_id);
 249         hash_clean(zrouter.nhgs, NULL);
 250         hash_free(zrouter.nhgs);
 251
 252         hash_clean(zrouter.rules_hash, zebra_pbr_rules_free);
 253         hash_free(zrouter.rules_hash);
 254
 255         hash_clean(zrouter.ipset_entry_hash, zebra_pbr_ipset_entry_free),
 256                 hash_clean(zrouter.ipset_hash, zebra_pbr_ipset_free);
 257         hash_free(zrouter.ipset_hash);
 258         hash_free(zrouter.ipset_entry_hash);
 259         hash_clean(zrouter.iptable_hash, zebra_pbr_iptable_free);
 260         hash_free(zrouter.iptable_hash);
 261
 262 #ifdef HAVE_SCRIPTING
 263         zebra_script_destroy();
 264 #endif
 265
 266         /* OS-specific deinit */
 267         kernel_router_terminate();
 268 }
 269
 270 bool zebra_router_notify_on_ack(void)
 271 {
 272         return !zrouter.asic_offloaded || zrouter.notify_on_ack;
 273 }
 274
 275 void zebra_router_init(bool asic_offload, bool notify_on_ack)
 276 {
 277         zrouter.sequence_num = 0;
 278
 279         zrouter.packets_to_process = ZEBRA_ZAPI_PACKETS_TO_PROCESS;
 280
 281         zrouter.nhg_keep = ZEBRA_DEFAULT_NHG_KEEP_TIMER;
 282
 283         zebra_vxlan_init();
 284         zebra_mlag_init();
 285
 286         zrouter.rules_hash = hash_create_size(8, zebra_pbr_rules_hash_key,
 287                                               zebra_pbr_rules_hash_equal,
 288                                               "Rules Hash");
 289
 290         zrouter.ipset_hash =
 291                 hash_create_size(8, zebra_pbr_ipset_hash_key,
 292                                  zebra_pbr_ipset_hash_equal, "IPset Hash");
 293
 294         zrouter.ipset_entry_hash = hash_create_size(
 295                 8, zebra_pbr_ipset_entry_hash_key,
 296                 zebra_pbr_ipset_entry_hash_equal, "IPset Hash Entry");
 297
 298         zrouter.iptable_hash = hash_create_size(8, zebra_pbr_iptable_hash_key,
 299                                                 zebra_pbr_iptable_hash_equal,
 300                                                 "IPtable Hash Entry");
 301
 302         zrouter.nhgs =
 303                 hash_create_size(8, zebra_nhg_hash_key, zebra_nhg_hash_equal,
 304                                  "Zebra Router Nexthop Groups");
 305         zrouter.nhgs_id =
 306                 hash_create_size(8, zebra_nhg_id_key, zebra_nhg_hash_id_equal,
 307                                  "Zebra Router Nexthop Groups ID index");
 308
 309         zrouter.asic_offloaded = asic_offload;
 310         zrouter.notify_on_ack = notify_on_ack;
 311
 312 #ifdef HAVE_SCRIPTING
 313         zebra_script_init();
 314 #endif
 315
 316         /* OS-specific init */
 317         kernel_router_init();
 318 }