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 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 /*
  28  * When we get notification that nexthop tracking has an answer for
  29  * us call this function to find the nexthop we are tracking so it
  30  * can be installed or removed.
  31  *
  32  * sp -> The route we are looking at.  If NULL then look at all
  33  *       routes.
  34  * nhp -> The nexthop that is being tracked.
  35  * nh_num -> number of valid nexthops.
  36  * afi -> The afi we are working in.
  37  * vrf_id -> The vrf the nexthop is in.
  38  */
  39 extern void static_nht_update(struct prefix *sp, struct prefix *nhp,
  40                               uint32_t nh_num, afi_t afi, safi_t safi,
  41                               vrf_id_t vrf_id);
  42
  43 /*
  44  * For the given tracked nexthop, nhp, mark all routes that use
  45  * this route as in starting state again.
  46  */
  47 extern void static_nht_reset_start(struct prefix *nhp, afi_t afi, safi_t safi,
  48                                    vrf_id_t nh_vrf_id);
  49
  50 /*
  51  * For the given prefix, sp, mark it as in a particular state
  52  */
  53 extern void static_nht_mark_state(struct prefix *sp, safi_t safi,
  54                                   vrf_id_t vrf_id,
  55                                   enum static_install_states state);
  56
  57 /*
  58  * For the given nexthop, returns the string
  59  */
  60 extern void static_get_nh_str(struct static_nexthop *nh, char *nexthop,
  61                               size_t size);
  62
  63 #ifdef __cplusplus
  64 }
  65 #endif
  66
  67 #endif