pimd/pim_instance.c

   1 /*
   2  * PIM for FRR - PIM Instance
   3  * Copyright (C) 2017 Cumulus Networks, Inc.
   4  * Donald Sharp
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; see the file COPYING; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
  19  * MA 02110-1301 USA
  20  */
  21 #include <zebra.h>
  22
  23 #include "hash.h"
  24 #include "vrf.h"
  25
  26 #include "pimd.h"
  27 #include "pim_ssm.h"
  28 #include "pim_rpf.h"
  29 #include "pim_rp.h"
  30 #include "pim_mroute.h"
  31 #include "pim_oil.h"
  32 #include "pim_static.h"
  33 #include "pim_ssmpingd.h"
  34 #include "pim_vty.h"
  35
  36 static void pim_instance_terminate(struct pim_instance *pim)
  37 {
  38         if (pim->ssm_info) {
  39                 pim_ssm_terminate(pim->ssm_info);
  40                 pim->ssm_info = NULL;
  41         }
  42
  43         if (pim->static_routes)
  44                 list_delete_and_null(&pim->static_routes);
  45
  46         pim_rp_free(pim);
  47
  48         pim_upstream_terminate(pim);
  49
  50         /* Traverse and cleanup rpf_hash */
  51         if (pim->rpf_hash) {
  52                 hash_clean(pim->rpf_hash, (void *)pim_rp_list_hash_clean);
  53                 hash_free(pim->rpf_hash);
  54                 pim->rpf_hash = NULL;
  55         }
  56
  57         pim_oil_terminate(pim);
  58
  59         pim_if_terminate(pim);
  60
  61         pim_msdp_exit(pim);
  62
  63         XFREE(MTYPE_PIM_PIM_INSTANCE, pim);
  64 }
  65
  66 static struct pim_instance *pim_instance_init(struct vrf *vrf)
  67 {
  68         struct pim_instance *pim;
  69         char hash_name[64];
  70
  71         pim = XCALLOC(MTYPE_PIM_PIM_INSTANCE, sizeof(struct pim_instance));
  72         if (!pim)
  73                 return NULL;
  74
  75         pim_if_init(pim);
  76
  77         pim->keep_alive_time = PIM_KEEPALIVE_PERIOD;
  78         pim->rp_keep_alive_time = PIM_RP_KEEPALIVE_PERIOD;
  79
  80         pim->ecmp_enable = false;
  81         pim->ecmp_rebalance_enable = false;
  82
  83         pim->vrf_id = vrf->vrf_id;
  84         pim->vrf = vrf;
  85
  86         pim->spt.switchover = PIM_SPT_IMMEDIATE;
  87         pim->spt.plist = NULL;
  88
  89         pim_msdp_init(pim, master);
  90
  91         snprintf(hash_name, 64, "PIM %s RPF Hash", vrf->name);
  92         pim->rpf_hash = hash_create_size(256, pim_rpf_hash_key, pim_rpf_equal,
  93                                          hash_name);
  94
  95         if (PIM_DEBUG_ZEBRA)
  96                 zlog_debug("%s: NHT rpf hash init ", __PRETTY_FUNCTION__);
  97
  98         pim->ssm_info = pim_ssm_init();
  99         if (!pim->ssm_info) {
 100                 pim_instance_terminate(pim);
 101                 return NULL;
 102         }
 103
 104         pim->static_routes = list_new();
 105         if (!pim->static_routes) {
 106                 zlog_err("%s %s: failure: static_routes=list_new()", __FILE__,
 107                          __PRETTY_FUNCTION__);
 108                 pim_instance_terminate(pim);
 109                 return NULL;
 110         }
 111         pim->static_routes->del = (void (*)(void *))pim_static_route_free;
 112
 113         pim->send_v6_secondary = 1;
 114
 115         if (vrf->vrf_id == VRF_DEFAULT)
 116                 pimg = pim;
 117
 118         pim_rp_init(pim);
 119
 120         pim_oil_init(pim);
 121
 122         pim_upstream_init(pim);
 123
 124         pim->last_route_change_time = -1;
 125         return pim;
 126 }
 127
 128 struct pim_instance *pim_get_pim_instance(vrf_id_t vrf_id)
 129 {
 130         struct vrf *vrf = vrf_lookup_by_id(vrf_id);
 131
 132         if (vrf)
 133                 return vrf->info;
 134
 135         return NULL;
 136 }
 137
 138 static int pim_vrf_new(struct vrf *vrf)
 139 {
 140         struct pim_instance *pim = pim_instance_init(vrf);
 141
 142         zlog_debug("VRF Created: %s(%u)", vrf->name, vrf->vrf_id);
 143         if (pim == NULL) {
 144                 zlog_err("%s %s: pim class init failure ", __FILE__,
 145                          __PRETTY_FUNCTION__);
 146                 /*
 147                  * We will crash and burn otherwise
 148                  */
 149                 exit(1);
 150         }
 151
 152         vrf->info = (void *)pim;
 153
 154         if (vrf->vrf_id == VRF_DEFAULT)
 155                 pimg = pim;
 156
 157         pim_ssmpingd_init(pim);
 158         return 0;
 159 }
 160
 161 static int pim_vrf_delete(struct vrf *vrf)
 162 {
 163         struct pim_instance *pim = vrf->info;
 164
 165         zlog_debug("VRF Deletion: %s(%u)", vrf->name, vrf->vrf_id);
 166
 167         pim_ssmpingd_destroy(pim);
 168         pim_instance_terminate(pim);
 169         return 0;
 170 }
 171
 172 /*
 173  * Code to turn on the pim instance that
 174  * we have created with new
 175  */
 176 static int pim_vrf_enable(struct vrf *vrf)
 177 {
 178         struct pim_instance *pim = (struct pim_instance *)vrf->info;
 179
 180         zlog_debug("%s: for %s", __PRETTY_FUNCTION__, vrf->name);
 181
 182         pim_mroute_socket_enable(pim);
 183
 184         return 0;
 185 }
 186
 187 static int pim_vrf_disable(struct vrf *vrf)
 188 {
 189         /* Note: This is a callback, the VRF will be deleted by the caller. */
 190         return 0;
 191 }
 192
 193 static int pim_vrf_config_write(struct vty *vty)
 194 {
 195         struct vrf *vrf;
 196         struct pim_instance *pim;
 197
 198         RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name) {
 199                 pim = vrf->info;
 200
 201                 if (!pim)
 202                         continue;
 203
 204                 if (vrf->vrf_id != VRF_DEFAULT)
 205                         vty_frame(vty, "vrf %s\n", vrf->name);
 206
 207                 pim_global_config_write_worker(pim, vty);
 208
 209                 if (vrf->vrf_id != VRF_DEFAULT)
 210                         vty_endframe(vty, "!\n");
 211         }
 212
 213         return 0;
 214 }
 215
 216 void pim_vrf_init(void)
 217 {
 218         vrf_init(pim_vrf_new, pim_vrf_enable, pim_vrf_disable, pim_vrf_delete);
 219
 220         vrf_cmd_init(pim_vrf_config_write, &pimd_privs);
 221 }
 222
 223 void pim_vrf_terminate(void)
 224 {
 225         vrf_terminate();
 226 }