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