zebra/zebra_ns.c

   1 /* zebra NS Routines
   2  * Copyright (C) 2016 Cumulus Networks, Inc.
   3  *                    Donald Sharp
   4  * Copyright (C) 2017/2018 6WIND
   5  *
   6  * This file is part of Quagga.
   7  *
   8  * Quagga 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  * Quagga 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 along
  19  * with this program; see the file COPYING; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22 #include "zebra.h"
  23
  24 #include "lib/ns.h"
  25 #include "lib/vrf.h"
  26 #include "lib/prefix.h"
  27 #include "lib/memory.h"
  28
  29 #include "zebra_ns.h"
  30 #include "zebra_vrf.h"
  31 #include "rt.h"
  32 #include "zebra_vxlan.h"
  33 #include "debug.h"
  34 #include "zebra_netns_notify.h"
  35 #include "zebra_netns_id.h"
  36 #include "zebra_pbr.h"
  37 #include "rib.h"
  38 #include "table_manager.h"
  39 #include "zebra_errors.h"
  40
  41 extern struct zebra_privs_t zserv_privs;
  42
  43 DEFINE_MTYPE_STATIC(ZEBRA, ZEBRA_NS, "Zebra Name Space");
  44
  45 static struct zebra_ns *dzns;
  46
  47 static int zebra_ns_disable_internal(struct zebra_ns *zns, bool complete);
  48
  49 struct zebra_ns *zebra_ns_lookup(ns_id_t ns_id)
  50 {
  51         if (ns_id == NS_DEFAULT)
  52                 return dzns;
  53         struct zebra_ns *info = (struct zebra_ns *)ns_info_lookup(ns_id);
  54
  55         return (info == NULL) ? dzns : info;
  56 }
  57
  58 static struct zebra_ns *zebra_ns_alloc(void)
  59 {
  60         return XCALLOC(MTYPE_ZEBRA_NS, sizeof(struct zebra_ns));
  61 }
  62
  63 static int zebra_ns_new(struct ns *ns)
  64 {
  65         struct zebra_ns *zns;
  66
  67         if (!ns)
  68                 return -1;
  69
  70         if (IS_ZEBRA_DEBUG_EVENT)
  71                 zlog_info("ZNS %s with id %u (created)", ns->name, ns->ns_id);
  72
  73         zns = zebra_ns_alloc();
  74         ns->info = zns;
  75         zns->ns = ns;
  76         zns->ns_id = ns->ns_id;
  77
  78         /* Do any needed per-NS data structure allocation. */
  79         zns->if_table = route_table_init();
  80
  81         return 0;
  82 }
  83
  84 static int zebra_ns_delete(struct ns *ns)
  85 {
  86         struct zebra_ns *zns = (struct zebra_ns *)ns->info;
  87
  88         if (IS_ZEBRA_DEBUG_EVENT)
  89                 zlog_info("ZNS %s with id %u (deleted)", ns->name, ns->ns_id);
  90         if (!zns)
  91                 return 0;
  92         XFREE(MTYPE_ZEBRA_NS, ns->info);
  93         return 0;
  94 }
  95
  96 static int zebra_ns_enabled(struct ns *ns)
  97 {
  98         struct zebra_ns *zns = ns->info;
  99
 100         if (IS_ZEBRA_DEBUG_EVENT)
 101                 zlog_info("ZNS %s with id %u (enabled)", ns->name, ns->ns_id);
 102         if (!zns)
 103                 return 0;
 104         return zebra_ns_enable(ns->ns_id, (void **)&zns);
 105 }
 106
 107 int zebra_ns_disabled(struct ns *ns)
 108 {
 109         struct zebra_ns *zns = ns->info;
 110
 111         if (IS_ZEBRA_DEBUG_EVENT)
 112                 zlog_info("ZNS %s with id %u (disabled)", ns->name, ns->ns_id);
 113         if (!zns)
 114                 return 0;
 115         return zebra_ns_disable_internal(zns, true);
 116 }
 117
 118 /* Do global enable actions - open sockets, read kernel config etc. */
 119 int zebra_ns_enable(ns_id_t ns_id, void **info)
 120 {
 121         struct zebra_ns *zns = (struct zebra_ns *)(*info);
 122
 123         zns->ns_id = ns_id;
 124
 125         kernel_init(zns);
 126         zebra_dplane_ns_enable(zns, true);
 127         interface_list(zns);
 128         route_read(zns);
 129         kernel_read_pbr_rules(zns);
 130
 131         return 0;
 132 }
 133
 134 /* Common handler for ns disable - this can be called during ns config,
 135  * or during zebra shutdown.
 136  */
 137 static int zebra_ns_disable_internal(struct zebra_ns *zns, bool complete)
 138 {
 139         route_table_finish(zns->if_table);
 140
 141         zebra_dplane_ns_enable(zns, false /*Disable*/);
 142
 143         kernel_terminate(zns, complete);
 144
 145         zns->ns_id = NS_DEFAULT;
 146
 147         return 0;
 148 }
 149
 150 /* During zebra shutdown, do partial cleanup while the async dataplane
 151  * is still running.
 152  */
 153 int zebra_ns_early_shutdown(struct ns *ns,
 154                             void *param_in __attribute__((unused)),
 155                             void **param_out __attribute__((unused)))
 156 {
 157         struct zebra_ns *zns = ns->info;
 158
 159         if (zns == NULL)
 160                 return 0;
 161
 162         zebra_ns_disable_internal(zns, false);
 163         return NS_WALK_CONTINUE;
 164 }
 165
 166 /* During zebra shutdown, do final cleanup
 167  * after all dataplane work is complete.
 168  */
 169 int zebra_ns_final_shutdown(struct ns *ns,
 170                             void *param_in __attribute__((unused)),
 171                             void **param_out __attribute__((unused)))
 172 {
 173         struct zebra_ns *zns = ns->info;
 174
 175         if (zns == NULL)
 176                 return 0;
 177
 178         kernel_terminate(zns, true);
 179
 180         return NS_WALK_CONTINUE;
 181 }
 182
 183 int zebra_ns_init(const char *optional_default_name)
 184 {
 185         struct ns *default_ns;
 186         ns_id_t ns_id;
 187         ns_id_t ns_id_external;
 188         struct ns *ns;
 189
 190         frr_with_privs(&zserv_privs) {
 191                 ns_id = zebra_ns_id_get_default();
 192         }
 193         ns_id_external = ns_map_nsid_with_external(ns_id, true);
 194         ns_init_management(ns_id_external, ns_id);
 195         ns = ns_get_default();
 196         if (ns)
 197                 ns->relative_default_ns = ns_id;
 198
 199         default_ns = ns_lookup(NS_DEFAULT);
 200         if (!default_ns) {
 201                 flog_err(EC_ZEBRA_NS_NO_DEFAULT,
 202                          "%s: failed to find default ns", __func__);
 203                 exit(EXIT_FAILURE); /* This is non-recoverable */
 204         }
 205
 206         /* Do any needed per-NS data structure allocation. */
 207         zebra_ns_new(default_ns);
 208         dzns = default_ns->info;
 209
 210         /* Register zebra VRF callbacks, create and activate default VRF. */
 211         zebra_vrf_init();
 212
 213         /* Default NS is activated */
 214         zebra_ns_enable(ns_id_external, (void **)&dzns);
 215
 216         if (optional_default_name)
 217                 vrf_set_default_name(optional_default_name,
 218                                      true);
 219
 220         if (vrf_is_backend_netns()) {
 221                 ns_add_hook(NS_NEW_HOOK, zebra_ns_new);
 222                 ns_add_hook(NS_ENABLE_HOOK, zebra_ns_enabled);
 223                 ns_add_hook(NS_DISABLE_HOOK, zebra_ns_disabled);
 224                 ns_add_hook(NS_DELETE_HOOK, zebra_ns_delete);
 225                 zebra_ns_notify_parse();
 226                 zebra_ns_notify_init();
 227         }
 228
 229         return 0;
 230 }
 231
 232 int zebra_ns_config_write(struct vty *vty, struct ns *ns)
 233 {
 234         if (ns && ns->name != NULL)
 235                 vty_out(vty, " netns %s\n", ns->name);
 236         return 0;
 237 }