pbrd/pbr_map.h

   1 /*
   2  * PBR-map 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_MAP_H__
  21 #define __PBR_MAP_H__
  22
  23 #include <bitfield.h>
  24
  25 struct pbr_map {
  26         /*
  27          * RB Tree of the pbr_maps
  28          */
  29         RB_ENTRY(pbr_map) pbr_map_entry;
  30
  31         /*
  32          * The name of the PBR_MAP
  33          */
  34 #define PBR_MAP_NAMELEN 100
  35         char name[PBR_MAP_NAMELEN];
  36
  37         struct list *seqnumbers;
  38
  39         /*
  40          * The list of incoming interfaces that
  41          * we will apply this policy map onto
  42          */
  43         struct list *incoming;
  44
  45         bitfield_t ifi_bitfield;
  46         /*
  47          * If valid is true we think the pbr_map is valid,
  48          * If false, look in individual pbrms to see
  49          * what we think is the invalid reason
  50          */
  51         bool valid;
  52 };
  53
  54 RB_HEAD(pbr_map_entry_head, pbr_map);
  55 RB_PROTOTYPE(pbr_map_entry_head, pbr_map, pbr_map_entry, pbr_map_compare)
  56
  57 struct pbr_map_interface {
  58         uint32_t install_bit;
  59
  60         struct interface *ifp;
  61
  62         struct pbr_map *pbrm;
  63
  64         bool delete;
  65 };
  66
  67 struct pbr_map_sequence {
  68         struct pbr_map *parent;
  69
  70         /*
  71          * The Unique identifier of this specific pbrms
  72          */
  73         uint32_t unique;
  74
  75         /*
  76          * The sequence of where we are for display
  77          */
  78         uint32_t seqno;
  79
  80         /*
  81          * The rule number to install into
  82          */
  83         uint32_t ruleno;
  84
  85         /*
  86          * Our policy Catchers
  87          */
  88         struct prefix *src;
  89         struct prefix *dst;
  90         uint32_t mark;
  91
  92         /*
  93          * Family of the src/dst.  Needed when deleting since we clear them
  94          */
  95         unsigned char family;
  96
  97         /*
  98          * The nexthop group we auto create
  99          * for when the user specifies a individual
 100          * nexthop
 101          */
 102         struct nexthop_group *nhg;
 103         char *internal_nhg_name;
 104
 105         /*
 106          * The name of the nexthop group
 107          * configured in the pbr-map
 108          */
 109         char *nhgrp_name;
 110
 111         /*
 112          * Do we think are nexthops are installed
 113          */
 114         bool nhs_installed;
 115
 116         /*
 117          * Are we installed
 118          */
 119         uint64_t installed;
 120
 121         /*
 122          * A reason of 0 means we think the pbr_map_sequence is good to go
 123          * We can accumuluate multiple failure states
 124          */
 125 #define PBR_MAP_VALID_SEQUENCE_NUMBER  0
 126 #define PBR_MAP_INVALID_NEXTHOP_GROUP  (1 << 0)
 127 #define PBR_MAP_INVALID_NEXTHOP        (1 << 1)
 128 #define PBR_MAP_INVALID_NO_NEXTHOPS    (1 << 2)
 129 #define PBR_MAP_INVALID_BOTH_NHANDGRP  (1 << 3)
 130 #define PBR_MAP_INVALID_EMPTY          (1 << 4)
 131         uint64_t reason;
 132
 133         QOBJ_FIELDS
 134 };
 135
 136 DECLARE_QOBJ_TYPE(pbr_map_sequence)
 137
 138 extern struct pbr_map_entry_head pbr_maps;
 139
 140 extern struct pbr_map_sequence *pbrms_get(const char *name, uint32_t seqno);
 141 extern struct pbr_map_sequence *
 142 pbrms_lookup_unique(uint32_t unique, ifindex_t ifindex,
 143                     struct pbr_map_interface **ppmi);
 144
 145 extern struct pbr_map *pbrm_find(const char *name);
 146 extern void pbr_map_delete(struct pbr_map_sequence *pbrms);
 147 extern void pbr_map_delete_nexthop_group(struct pbr_map_sequence *pbrms);
 148 extern void pbr_map_add_interface(struct pbr_map *pbrm, struct interface *ifp);
 149 extern void pbr_map_interface_delete(struct pbr_map *pbrm,
 150                                      struct interface *ifp);
 151 extern void pbr_map_final_interface_deletion(struct pbr_map *pbrm,
 152                                              struct pbr_map_interface *pmi);
 153 extern void pbr_map_write_interfaces(struct vty *vty, struct interface *ifp);
 154 extern void pbr_map_init(void);
 155
 156 extern bool pbr_map_check_valid(const char *name);
 157
 158 extern void pbr_map_check(struct pbr_map_sequence *pbrms);
 159 extern void pbr_map_check_nh_group_change(const char *nh_group);
 160 extern void pbr_map_reason_string(unsigned int reason, char *buf, int size);
 161
 162 extern void pbr_map_schedule_policy_from_nhg(const char *nh_group);
 163
 164 extern void pbr_map_install(struct pbr_map *pbrm);
 165
 166 extern void pbr_map_policy_install(const char *name);
 167 extern void pbr_map_policy_delete(struct pbr_map *pbrm,
 168                                   struct pbr_map_interface *pmi);
 169 #endif