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 };
  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_entry_action {
  68         /* used to store enum bgp_pbr_action_enum enumerate */
  69         uint8_t action;
  70         union {
  71                 union {
  72                         uint8_t rate_info[4]; /* IEEE.754.1985 */
  73                         float rate;
  74                 } r __attribute__((aligned(8)));
  75                 struct _pbr_action {
  76                         uint8_t do_sample;
  77                         uint8_t filter;
  78                 } za;
  79                 vrf_id_t redirect_vrf;
  80                 struct _pbr_redirect_ip {
  81                         struct in_addr redirect_ip_v4;
  82                         uint8_t duplicate;
  83                 } zr;
  84                 uint8_t marking_dscp;
  85         } u __attribute__((aligned(8)));
  86 };
  87
  88 /* BGP Policy Route structure */
  89 struct bgp_pbr_entry_main {
  90 #define BGP_PBR_UNDEFINED       0
  91 #define BGP_PBR_IPSET           1
  92 #define BGP_PBR_IPRULE          2
  93         uint8_t type;
  94
  95         /*
  96          * This is an enum but we are going to treat it as a uint8_t
  97          * for purpose of encoding/decoding
  98          */
  99         afi_t afi;
 100         safi_t safi;
 101
 102 #define PREFIX_SRC_PRESENT (1 << 0)
 103 #define PREFIX_DST_PRESENT (1 << 1)
 104         uint8_t match_bitmask_iprule;
 105         uint8_t match_bitmask;
 106
 107         uint8_t match_src_port_num;
 108         uint8_t match_dst_port_num;
 109         uint8_t match_port_num;
 110         uint8_t match_protocol_num;
 111         uint8_t match_icmp_type_num;
 112         uint8_t match_icmp_code_num;
 113         uint8_t match_packet_length_num;
 114         uint8_t match_dscp_num;
 115         uint8_t match_tcpflags_num;
 116         uint8_t match_fragment_num;
 117
 118         struct prefix src_prefix;
 119         struct prefix dst_prefix;
 120
 121 #define PROTOCOL_UDP 17
 122 #define PROTOCOL_TCP 6
 123 #define PROTOCOL_ICMP 1
 124         struct bgp_pbr_match_val protocol[BGP_PBR_MATCH_VAL_MAX];
 125         struct bgp_pbr_match_val src_port[BGP_PBR_MATCH_VAL_MAX];
 126         struct bgp_pbr_match_val dst_port[BGP_PBR_MATCH_VAL_MAX];
 127         struct bgp_pbr_match_val port[BGP_PBR_MATCH_VAL_MAX];
 128         struct bgp_pbr_match_val icmp_type[BGP_PBR_MATCH_VAL_MAX];
 129         struct bgp_pbr_match_val icmp_code[BGP_PBR_MATCH_VAL_MAX];
 130         struct bgp_pbr_match_val packet_length[BGP_PBR_MATCH_VAL_MAX];
 131         struct bgp_pbr_match_val dscp[BGP_PBR_MATCH_VAL_MAX];
 132
 133         struct bgp_pbr_match_val tcpflags[BGP_PBR_MATCH_VAL_MAX];
 134         struct bgp_pbr_match_val fragment[BGP_PBR_MATCH_VAL_MAX];
 135
 136         uint16_t action_num;
 137         struct bgp_pbr_entry_action actions[ACTIONS_MAX_NUM];
 138
 139         vrf_id_t vrf_id;
 140 };
 141
 142 struct bgp_pbr_interface {
 143         RB_ENTRY(bgp_pbr_interface) id_entry;
 144         char name[INTERFACE_NAMSIZ];
 145 };
 146
 147 RB_HEAD(bgp_pbr_interface_head, bgp_pbr_interface);
 148 RB_PROTOTYPE(bgp_pbr_interface_head, bgp_pbr_interface, id_entry,
 149              bgp_pbr_interface_compare);
 150
 151 extern int bgp_pbr_interface_compare(const struct bgp_pbr_interface *a,
 152                                      const struct bgp_pbr_interface *b);
 153
 154 struct bgp_pbr_config {
 155         struct bgp_pbr_interface_head ifaces_by_name_ipv4;
 156         bool pbr_interface_any_ipv4;
 157 };
 158
 159 extern struct bgp_pbr_config *bgp_pbr_cfg;
 160
 161 struct bgp_pbr_rule {
 162         uint32_t flags;
 163         struct prefix src;
 164         struct prefix dst;
 165         struct bgp_pbr_action *action;
 166         vrf_id_t vrf_id;
 167         uint32_t unique;
 168         uint32_t priority;
 169         bool installed;
 170         bool install_in_progress;
 171         void *path;
 172 };
 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         uint8_t protocol;
 190
 191         vrf_id_t vrf_id;
 192
 193         /* unique identifier for ipset create transaction
 194          */
 195         uint32_t unique;
 196
 197         /* unique identifier for iptable add transaction
 198          */
 199         uint32_t unique2;
 200
 201         bool installed;
 202         bool install_in_progress;
 203
 204         bool installed_in_iptable;
 205         bool install_iptable_in_progress;
 206
 207         struct hash *entry_hash;
 208
 209         struct bgp_pbr_action *action;
 210
 211 };
 212
 213 struct bgp_pbr_match_entry {
 214         struct bgp_pbr_match *backpointer;
 215
 216         uint32_t unique;
 217
 218         struct prefix src;
 219         struct prefix dst;
 220
 221         uint16_t src_port_min;
 222         uint16_t src_port_max;
 223         uint16_t dst_port_min;
 224         uint16_t dst_port_max;
 225         uint8_t proto;
 226
 227         void *path;
 228
 229         bool installed;
 230         bool install_in_progress;
 231 };
 232
 233 struct bgp_pbr_action {
 234
 235         /*
 236          * The Unique identifier of this specific pbrms
 237          */
 238         uint32_t unique;
 239
 240         uint32_t fwmark;
 241
 242         uint32_t table_id;
 243
 244         float rate;
 245
 246         /*
 247          * nexthop information, or drop information
 248          * contains src vrf_id and nh contains dest vrf_id
 249          */
 250         vrf_id_t vrf_id;
 251         struct nexthop nh;
 252
 253         bool installed;
 254         bool install_in_progress;
 255         uint32_t refcnt;
 256         struct bgp *bgp;
 257 };
 258
 259 extern struct bgp_pbr_rule *bgp_pbr_rule_lookup(vrf_id_t vrf_id,
 260                                                 uint32_t unique);
 261
 262 extern struct bgp_pbr_action *bgp_pbr_action_rule_lookup(vrf_id_t vrf_id,
 263                                                          uint32_t unique);
 264
 265 extern struct bgp_pbr_match *bgp_pbr_match_ipset_lookup(vrf_id_t vrf_id,
 266                                                         uint32_t unique);
 267
 268 extern struct bgp_pbr_match_entry *bgp_pbr_match_ipset_entry_lookup(
 269                                             vrf_id_t vrf_id, char *name,
 270                                             uint32_t unique);
 271 extern struct bgp_pbr_match *bgp_pbr_match_iptable_lookup(vrf_id_t vrf_id,
 272                                                           uint32_t unique);
 273
 274 extern void bgp_pbr_cleanup(struct bgp *bgp);
 275 extern void bgp_pbr_init(struct bgp *bgp);
 276
 277 extern uint32_t bgp_pbr_rule_hash_key(const void *arg);
 278 extern bool bgp_pbr_rule_hash_equal(const void *arg1,
 279                                    const void *arg2);
 280 extern uint32_t bgp_pbr_action_hash_key(const void *arg);
 281 extern bool bgp_pbr_action_hash_equal(const void *arg1,
 282                                      const void *arg2);
 283 extern uint32_t bgp_pbr_match_entry_hash_key(const void *arg);
 284 extern bool bgp_pbr_match_entry_hash_equal(const void *arg1,
 285                                           const void *arg2);
 286 extern uint32_t bgp_pbr_match_hash_key(const void *arg);
 287 extern bool bgp_pbr_match_hash_equal(const void *arg1,
 288                                     const void *arg2);
 289
 290 void bgp_pbr_print_policy_route(struct bgp_pbr_entry_main *api);
 291
 292 struct bgp_node;
 293 struct bgp_path_info;
 294 extern void bgp_pbr_update_entry(struct bgp *bgp, struct prefix *p,
 295                                  struct bgp_path_info *new_select, afi_t afi,
 296                                  safi_t safi, bool nlri_update);
 297
 298 /* bgp pbr utilities */
 299 extern struct bgp_pbr_interface *pbr_interface_lookup(const char *name);
 300 extern void bgp_pbr_reset(struct bgp *bgp, afi_t afi);
 301 extern struct bgp_pbr_interface *bgp_pbr_interface_lookup(const char *name,
 302                                    struct bgp_pbr_interface_head *head);
 303
 304 extern int bgp_pbr_build_and_validate_entry(struct prefix *p,
 305                                             struct bgp_path_info *path,
 306                                             struct bgp_pbr_entry_main *api);
 307 #endif /* __BGP_PBR_H__ */