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 #include "lib_errors.h"
  26
  27 #include "pimd.h"
  28 #include "pim_ssm.h"
  29 #include "pim_rpf.h"
  30 #include "pim_rp.h"
  31 #include "pim_mroute.h"
  32 #include "pim_oil.h"
  33 #include "pim_static.h"
  34 #include "pim_ssmpingd.h"
  35 #include "pim_vty.h"
  36
  37 static void pim_instance_terminate(struct pim_instance *pim)
  38 {
  39         if (pim->ssm_info) {
  40                 pim_ssm_terminate(pim->ssm_info);
  41                 pim->ssm_info = NULL;
  42         }
  43
  44         if (pim->static_routes)
  45                 list_delete(&pim->static_routes);
  46
  47         pim_upstream_terminate(pim);
  48
  49         pim_rp_free(pim);
  50
  51         /* Traverse and cleanup rpf_hash */
  52         if (pim->rpf_hash) {
  53                 hash_clean(pim->rpf_hash, (void *)pim_rp_list_hash_clean);
  54                 hash_free(pim->rpf_hash);
  55                 pim->rpf_hash = NULL;
  56         }
  57
  58         pim_if_terminate(pim);
  59
  60         pim_oil_terminate(pim);
  61
  62         pim_msdp_exit(pim);
  63
  64         XFREE(MTYPE_PIM_PIM_INSTANCE, pim);
  65 }
  66
  67 static struct pim_instance *pim_instance_init(struct vrf *vrf)
  68 {
  69         struct pim_instance *pim;
  70         char hash_name[64];
  71
  72         pim = XCALLOC(MTYPE_PIM_PIM_INSTANCE, sizeof(struct pim_instance));
  73
  74         pim_if_init(pim);
  75
  76         pim->keep_alive_time = PIM_KEEPALIVE_PERIOD;
  77         pim->rp_keep_alive_time = PIM_RP_KEEPALIVE_PERIOD;
  78
  79         pim->ecmp_enable = false;
  80         pim->ecmp_rebalance_enable = false;
  81
  82         pim->vrf_id = vrf->vrf_id;
  83         pim->vrf = vrf;
  84
  85         pim->spt.switchover = PIM_SPT_IMMEDIATE;
  86         pim->spt.plist = NULL;
  87
  88         pim_msdp_init(pim, router->master);
  89
  90         snprintf(hash_name, 64, "PIM %s RPF Hash", vrf->name);
  91         pim->rpf_hash = hash_create_size(256, pim_rpf_hash_key, pim_rpf_equal,
  92                                          hash_name);
  93
  94         if (PIM_DEBUG_ZEBRA)
  95                 zlog_debug("%s: NHT rpf hash init ", __PRETTY_FUNCTION__);
  96
  97         pim->ssm_info = pim_ssm_init();
  98
  99         pim->static_routes = list_new();
 100         pim->static_routes->del = (void (*)(void *))pim_static_route_free;
 101
 102         pim->send_v6_secondary = 1;
 103
 104         pim_rp_init(pim);
 105
 106         pim_oil_init(pim);
 107
 108         pim_upstream_init(pim);
 109
 110         pim->last_route_change_time = -1;
 111         return pim;
 112 }
 113
 114 struct pim_instance *pim_get_pim_instance(vrf_id_t vrf_id)
 115 {
 116         struct vrf *vrf = vrf_lookup_by_id(vrf_id);
 117
 118         if (vrf)
 119                 return vrf->info;
 120
 121         return NULL;
 122 }
 123
 124 static int pim_vrf_new(struct vrf *vrf)
 125 {
 126         struct pim_instance *pim = pim_instance_init(vrf);
 127
 128         zlog_debug("VRF Created: %s(%u)", vrf->name, vrf->vrf_id);
 129
 130         vrf->info = (void *)pim;
 131
 132         pim_ssmpingd_init(pim);
 133         return 0;
 134 }
 135
 136 static int pim_vrf_delete(struct vrf *vrf)
 137 {
 138         struct pim_instance *pim = vrf->info;
 139
 140         zlog_debug("VRF Deletion: %s(%u)", vrf->name, vrf->vrf_id);
 141
 142         pim_ssmpingd_destroy(pim);
 143         pim_instance_terminate(pim);
 144         return 0;
 145 }
 146
 147 /*
 148  * Code to turn on the pim instance that
 149  * we have created with new
 150  */
 151 static int pim_vrf_enable(struct vrf *vrf)
 152 {
 153         struct pim_instance *pim = (struct pim_instance *)vrf->info;
 154
 155         zlog_debug("%s: for %s", __PRETTY_FUNCTION__, vrf->name);
 156
 157         pim_mroute_socket_enable(pim);
 158
 159         return 0;
 160 }
 161
 162 static int pim_vrf_disable(struct vrf *vrf)
 163 {
 164         /* Note: This is a callback, the VRF will be deleted by the caller. */
 165         return 0;
 166 }
 167
 168 static int pim_vrf_config_write(struct vty *vty)
 169 {
 170         struct vrf *vrf;
 171         struct pim_instance *pim;
 172
 173         RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name) {
 174                 pim = vrf->info;
 175
 176                 if (!pim)
 177                         continue;
 178
 179                 if (vrf->vrf_id != VRF_DEFAULT)
 180                         vty_frame(vty, "vrf %s\n", vrf->name);
 181
 182                 pim_global_config_write_worker(pim, vty);
 183
 184                 if (vrf->vrf_id != VRF_DEFAULT)
 185                         vty_endframe(vty, " exit-vrf\n!\n");
 186         }
 187
 188         return 0;
 189 }
 190
 191 void pim_vrf_init(void)
 192 {
 193         vrf_init(pim_vrf_new, pim_vrf_enable, pim_vrf_disable,
 194                  pim_vrf_delete, NULL);
 195
 196         vrf_cmd_init(pim_vrf_config_write, &pimd_privs);
 197 }
 198
 199 void pim_vrf_terminate(void)
 200 {
 201         vrf_terminate();
 202 }