pbrd/pbr_nht.h

   1 /*
   2  * PBR-nht Header
   3  * Copyright (C) 2018 Cumulus Networks, Inc.
   4  *               Donald Sharp
   5  *
   6  * FRR 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
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * FRR 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 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 __PBR_NHT_H__
  21 #define __PBR_NHT_H__
  22
  23 #include <lib/zclient.h>
  24 #include <lib/nexthop_group.h>
  25
  26 #include "pbr_map.h"
  27
  28 struct pbr_nexthop_group_cache {
  29         char name[PBR_MAP_NAMELEN];
  30
  31         uint32_t table_id;
  32
  33         struct hash *nhh;
  34
  35         /*
  36          * If all nexthops are considered valid
  37          */
  38         bool valid;
  39
  40         bool installed;
  41 };
  42
  43 struct pbr_nexthop_cache {
  44         struct pbr_nexthop_group_cache *parent;
  45
  46         struct nexthop *nexthop;
  47
  48         bool valid;
  49 };
  50
  51 extern void pbr_nht_write_table_range(struct vty *vty);
  52 #define PBR_NHT_DEFAULT_LOW_TABLEID 10000
  53 #define PBR_NHT_DEFAULT_HIGH_TABLEID 11000
  54 extern void pbr_nht_set_tableid_range(uint32_t low, uint32_t high);
  55
  56 /*
  57  * Get the next tableid to use for installation
  58  */
  59 extern uint32_t pbr_nht_get_next_tableid(void);
  60 /*
  61  * Get the next rule number to use for installation
  62  */
  63 extern void pbr_nht_write_rule_range(struct vty *vty);
  64
  65 #define PBR_NHT_DEFAULT_LOW_RULE 300
  66 #define PBR_NHT_DEFAULT_HIGH_RULE 1300
  67 extern void pbr_nht_set_rule_range(uint32_t low, uint32_t high);
  68
  69 extern uint32_t pbr_nht_get_next_rule(uint32_t seqno);
  70
  71 extern void pbr_nhgroup_add_cb(const char *name);
  72 extern void pbr_nhgroup_add_nexthop_cb(const struct nexthop_group_cmd *nhg,
  73                                        const struct nexthop *nhop);
  74 extern void pbr_nhgroup_del_nexthop_cb(const struct nexthop_group_cmd *nhg,
  75                                        const struct nexthop *nhop);
  76 extern void pbr_nhgroup_delete_cb(const char *name);
  77
  78 extern bool pbr_nht_nexthop_valid(struct nexthop_group *nhg);
  79 extern bool pbr_nht_nexthop_group_valid(const char *name);
  80
  81 extern struct pbr_nexthop_group_cache *pbr_nht_add_group(const char *name);
  82 extern void pbr_nht_change_group(const char *name);
  83 extern void pbr_nht_delete_group(const char *name);
  84
  85 extern void pbr_nht_add_individual_nexthop(struct pbr_map_sequence *pbrms);
  86 extern void pbr_nht_delete_individual_nexthop(struct pbr_map_sequence *pbrms);
  87 /*
  88  * Given the tableid of the installed default
  89  * route, find the nexthop-group associated with
  90  * it, then find all pbr-maps that use it and
  91  * install/delete them as well.
  92  */
  93 extern void pbr_nht_route_installed_for_table(uint32_t table_id);
  94 extern void pbr_nht_route_removed_for_table(uint32_t table_id);
  95
  96 /*
  97  * Given the nexthop group name, lookup the associated
  98  * tableid with it
  99  */
 100 extern uint32_t pbr_nht_get_table(const char *name);
 101
 102 extern bool pbr_nht_get_installed(const char *name);
 103
 104 extern char *pbr_nht_nexthop_make_name(char *name, size_t l, uint32_t seqno,
 105                                        char *buffer);
 106
 107 extern void pbr_nht_show_nexthop_group(struct vty *vty, const char *name);
 108
 109 /*
 110  * When we get a callback from zebra about a nexthop changing
 111  */
 112 extern void pbr_nht_nexthop_update(struct zapi_route *nhr);
 113
 114 extern void pbr_nht_init(void);
 115 #endif