bgpd/bgp_pbr.h

   1 /*
   2  * BGP pbr
   3  * Copyright (C) 6WIND
   4  *
   5  * FRR is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2, or (at your option) any
   8  * later version.
   9  *
  10  * FRR is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; see the file COPYING; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19 #ifndef __BGP_PBR_H__
  20 #define __BGP_PBR_H__
  21
  22 #include "nexthop.h"
  23 #include "zclient.h"
  24
  25 /* flowspec case: 0 to 3 actions maximum:
  26  * 1 redirect
  27  * 1 set dscp
  28  * 1 set traffic rate
  29  */
  30 #define ACTIONS_MAX_NUM 4
  31 enum bgp_pbr_action_enum {
  32         ACTION_TRAFFICRATE = 1,
  33         ACTION_TRAFFIC_ACTION = 2,
  34         ACTION_REDIRECT = 3,
  35         ACTION_MARKING = 4,
  36         ACTION_REDIRECT_IP = 5
  37 };
  38
  39 #define TRAFFIC_ACTION_SAMPLE     (1 << 0)
  40 #define TRAFFIC_ACTION_TERMINATE  (1 << 1)
  41 #define TRAFFIC_ACTION_DISTRIBUTE (1 << 2)
  42
  43 #define OPERATOR_COMPARE_LESS_THAN    (1<<1)
  44 #define OPERATOR_COMPARE_GREATER_THAN (1<<2)
  45 #define OPERATOR_COMPARE_EQUAL_TO     (1<<3)
  46 #define OPERATOR_COMPARE_EXACT_MATCH  (1<<4)
  47
  48 #define OPERATOR_UNARY_OR    (1<<1)
  49 #define OPERATOR_UNARY_AND   (1<<2)
  50
  51 /* struct used to store values [0;65535]
  52  * this can be used for port number of protocol
  53  */
  54 #define BGP_PBR_MATCH_VAL_MAX 5
  55
  56 struct bgp_pbr_match_val {
  57         uint16_t value;
  58         uint8_t compare_operator;
  59         uint8_t unary_operator;
  60 } bgp_pbr_value_t;
  61
  62 #define FRAGMENT_DONT  1
  63 #define FRAGMENT_IS    2
  64 #define FRAGMENT_FIRST 4
  65 #define FRAGMENT_LAST  8
  66
  67 struct bgp_pbr_fragment_val {
  68         uint8_t bitmask;
  69 };
  70
  71 struct bgp_pbr_entry_action {
  72         /* used to store enum bgp_pbr_action_enum enumerate */
  73         uint8_t action;
  74         union {
  75                 union {
  76                         uint8_t rate_info[4]; /* IEEE.754.1985 */
  77                         float rate;
  78                 } r __attribute__((aligned(8)));
  79                 struct _pbr_action {
  80                         uint8_t do_sample;
  81                         uint8_t filter;
  82                 } za;
  83                 vrf_id_t redirect_vrf;
  84                 struct _pbr_redirect_ip {
  85                         struct in_addr redirect_ip_v4;
  86                         uint8_t duplicate;
  87                 } zr;
  88                 uint8_t marking_dscp;
  89         } u __attribute__((aligned(8)));
  90 };
  91
  92 /* BGP Policy Route structure */
  93 struct bgp_pbr_entry_main {
  94         uint8_t type;
  95         uint16_t instance;
  96
  97         uint32_t flags;
  98
  99         uint8_t message;
 100
 101         /*
 102          * This is an enum but we are going to treat it as a uint8_t
 103          * for purpose of encoding/decoding
 104          */
 105         afi_t afi;
 106         safi_t safi;
 107
 108 #define PREFIX_SRC_PRESENT (1 << 0)
 109 #define PREFIX_DST_PRESENT (1 << 1)
 110         uint8_t match_bitmask;
 111
 112         uint8_t match_src_port_num;
 113         uint8_t match_dst_port_num;
 114         uint8_t match_port_num;
 115         uint8_t match_protocol_num;
 116         uint8_t match_icmp_type_num;
 117         uint8_t match_icmp_code_num;
 118         uint8_t match_packet_length_num;
 119         uint8_t match_dscp_num;
 120         uint8_t match_tcpflags_num;
 121         uint8_t match_fragment_num;
 122
 123         struct prefix src_prefix;
 124         struct prefix dst_prefix;
 125
 126 #define PROTOCOL_UDP 17
 127 #define PROTOCOL_TCP 6
 128 #define PROTOCOL_ICMP 1
 129         struct bgp_pbr_match_val protocol[BGP_PBR_MATCH_VAL_MAX];
 130         struct bgp_pbr_match_val src_port[BGP_PBR_MATCH_VAL_MAX];
 131         struct bgp_pbr_match_val dst_port[BGP_PBR_MATCH_VAL_MAX];
 132         struct bgp_pbr_match_val port[BGP_PBR_MATCH_VAL_MAX];
 133         struct bgp_pbr_match_val icmp_type[BGP_PBR_MATCH_VAL_MAX];
 134         struct bgp_pbr_match_val icmp_code[BGP_PBR_MATCH_VAL_MAX];
 135         struct bgp_pbr_match_val packet_length[BGP_PBR_MATCH_VAL_MAX];
 136         struct bgp_pbr_match_val dscp[BGP_PBR_MATCH_VAL_MAX];
 137
 138         struct bgp_pbr_match_val tcpflags[BGP_PBR_MATCH_VAL_MAX];
 139         struct bgp_pbr_match_val fragment[BGP_PBR_MATCH_VAL_MAX];
 140
 141         uint16_t action_num;
 142         struct bgp_pbr_entry_action actions[ACTIONS_MAX_NUM];
 143
 144         uint8_t distance;
 145
 146         uint32_t metric;
 147
 148         route_tag_t tag;
 149
 150         uint32_t mtu;
 151
 152         vrf_id_t vrf_id;
 153 };
 154
 155 struct bgp_pbr_interface {
 156         RB_ENTRY(bgp_pbr_interface) id_entry;
 157         char name[INTERFACE_NAMSIZ];
 158 };
 159
 160 RB_HEAD(bgp_pbr_interface_head, bgp_pbr_interface);
 161 RB_PROTOTYPE(bgp_pbr_interface_head, bgp_pbr_interface, id_entry,
 162              bgp_pbr_interface_compare);
 163
 164 extern int bgp_pbr_interface_compare(const struct bgp_pbr_interface *a,
 165                                      const struct bgp_pbr_interface *b);
 166
 167 struct bgp_pbr_config {
 168         struct bgp_pbr_interface_head ifaces_by_name_ipv4;
 169         bool pbr_interface_any_ipv4;
 170 };
 171
 172 extern struct bgp_pbr_config *bgp_pbr_cfg;
 173
 174 struct bgp_pbr_match {
 175         char ipset_name[ZEBRA_IPSET_NAME_SIZE];
 176
 177         /* mapped on enum ipset_type
 178          */
 179         uint32_t type;
 180
 181         uint32_t flags;
 182
 183         uint16_t pkt_len_min;
 184         uint16_t pkt_len_max;
 185         uint16_t tcp_flags;
 186         uint16_t tcp_mask_flags;
 187         uint8_t dscp_value;
 188         uint8_t fragment;
 189
 190         vrf_id_t vrf_id;
 191
 192         /* unique identifier for ipset create transaction
 193          */
 194         uint32_t unique;
 195
 196         /* unique identifier for iptable add transaction
 197          */
 198         uint32_t unique2;
 199
 200         bool installed;
 201         bool install_in_progress;
 202
 203         bool installed_in_iptable;
 204         bool install_iptable_in_progress;
 205
 206         struct hash *entry_hash;
 207
 208         struct bgp_pbr_action *action;
 209
 210 };
 211
 212 struct bgp_pbr_match_entry {
 213         struct bgp_pbr_match *backpointer;
 214
 215         uint32_t unique;
 216
 217         struct prefix src;
 218         struct prefix dst;
 219
 220         uint16_t src_port_min;
 221         uint16_t src_port_max;
 222         uint16_t dst_port_min;
 223         uint16_t dst_port_max;
 224         uint8_t proto;
 225
 226         void *bgp_info;
 227
 228         bool installed;
 229         bool install_in_progress;
 230 };
 231
 232 struct bgp_pbr_action {
 233
 234         /*
 235          * The Unique identifier of this specific pbrms
 236          */
 237         uint32_t unique;
 238
 239         uint32_t fwmark;
 240
 241         uint32_t table_id;
 242
 243         float rate;
 244
 245         /*
 246          * nexthop information, or drop information
 247          * contains src vrf_id and nh contains dest vrf_id
 248          */
 249         vrf_id_t vrf_id;
 250         struct nexthop nh;
 251
 252         bool installed;
 253         bool install_in_progress;
 254         uint32_t refcnt;
 255         struct bgp *bgp;
 256 };
 257
 258 extern struct bgp_pbr_action *bgp_pbr_action_rule_lookup(vrf_id_t vrf_id,
 259                                                          uint32_t unique);
 260
 261 extern struct bgp_pbr_match *bgp_pbr_match_ipset_lookup(vrf_id_t vrf_id,
 262                                                         uint32_t unique);
 263
 264 extern struct bgp_pbr_match_entry *bgp_pbr_match_ipset_entry_lookup(
 265                                             vrf_id_t vrf_id, char *name,
 266                                             uint32_t unique);
 267 extern struct bgp_pbr_match *bgp_pbr_match_iptable_lookup(vrf_id_t vrf_id,
 268                                                           uint32_t unique);
 269
 270 extern void bgp_pbr_cleanup(struct bgp *bgp);
 271 extern void bgp_pbr_init(struct bgp *bgp);
 272
 273 extern uint32_t bgp_pbr_action_hash_key(void *arg);
 274 extern int bgp_pbr_action_hash_equal(const void *arg1,
 275                                      const void *arg2);
 276 extern uint32_t bgp_pbr_match_entry_hash_key(void *arg);
 277 extern int bgp_pbr_match_entry_hash_equal(const void *arg1,
 278                                           const void *arg2);
 279 extern uint32_t bgp_pbr_match_hash_key(void *arg);
 280 extern int bgp_pbr_match_hash_equal(const void *arg1,
 281                                     const void *arg2);
 282
 283 void bgp_pbr_print_policy_route(struct bgp_pbr_entry_main *api);
 284
 285 struct bgp_node;
 286 struct bgp_info;
 287 extern void bgp_pbr_update_entry(struct bgp *bgp, struct prefix *p,
 288                                  struct bgp_info *new_select,
 289                                 afi_t afi, safi_t safi,
 290                                 bool nlri_update);
 291
 292 /* bgp pbr utilities */
 293 extern struct bgp_pbr_interface *pbr_interface_lookup(const char *name);
 294 extern void bgp_pbr_reset(struct bgp *bgp, afi_t afi);
 295 extern struct bgp_pbr_interface *bgp_pbr_interface_lookup(const char *name,
 296                                    struct bgp_pbr_interface_head *head);
 297
 298 #endif /* __BGP_PBR_H__ */