staticd/static_nht.h

   1 /*
   2  * Static NHT header.
   3  * Copyright (C) 2018 Cumulus Networks, Inc.
   4  *               Donald Sharp
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the Free
   8  * Software Foundation; either version 2 of the License, or (at your option)
   9  * any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14  * more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20 #ifndef __STATIC_NHT_H__
  21 #define __STATIC_NHT_H__
  22
  23 /*
  24  * When we get notification that nexthop tracking has an answer for
  25  * us call this function to find the nexthop we are tracking so it
  26  * can be installed or removed.
  27  *
  28  * sp -> The route we are looking at.  If NULL then look at all
  29  *       routes.
  30  * nhp -> The nexthop that is being tracked.
  31  * nh_num -> number of valid nexthops.
  32  * afi -> The afi we are working in.
  33  * vrf_id -> The vrf the nexthop is in.
  34  */
  35 extern void static_nht_update(struct prefix *sp, struct prefix *nhp,
  36                               uint32_t nh_num, afi_t afi, vrf_id_t vrf_id);
  37
  38 /*
  39  * For the given tracked nexthop, nhp, mark all routes that use
  40  * this route as in starting state again.
  41  */
  42 extern void static_nht_reset_start(struct prefix *nhp, afi_t afi,
  43                                    vrf_id_t nh_vrf_id);
  44
  45 /*
  46  * For the given prefix, sp, mark it as in a particular state
  47  */
  48 extern void static_nht_mark_state(struct prefix *sp, vrf_id_t vrf_id,
  49                                   enum static_install_states state);
  50 #endif