]> git.proxmox.com Git - mirror_frr.git/blob - bgpd/bgp_pbr.h
Merge pull request #2367 from qlyoung/docuser
[mirror_frr.git] / 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 #define FRAGMENT_PRESENT (1 << 2)
111 uint8_t match_bitmask;
112
113 uint8_t match_src_port_num;
114 uint8_t match_dst_port_num;
115 uint8_t match_port_num;
116 uint8_t match_protocol_num;
117 uint8_t match_icmp_type_num;
118 uint8_t match_icmp_code_num;
119 uint8_t match_packet_length_num;
120 uint8_t match_dscp_num;
121 uint8_t match_tcpflags_num;
122
123 struct prefix src_prefix;
124 struct prefix dst_prefix;
125
126 #define PROTOCOL_UDP 17
127 #define PROTOCOL_TCP 6
128 struct bgp_pbr_match_val protocol[BGP_PBR_MATCH_VAL_MAX];
129 struct bgp_pbr_match_val src_port[BGP_PBR_MATCH_VAL_MAX];
130 struct bgp_pbr_match_val dst_port[BGP_PBR_MATCH_VAL_MAX];
131 struct bgp_pbr_match_val port[BGP_PBR_MATCH_VAL_MAX];
132 struct bgp_pbr_match_val icmp_type[BGP_PBR_MATCH_VAL_MAX];
133 struct bgp_pbr_match_val icmp_code[BGP_PBR_MATCH_VAL_MAX];
134 struct bgp_pbr_match_val packet_length[BGP_PBR_MATCH_VAL_MAX];
135 struct bgp_pbr_match_val dscp[BGP_PBR_MATCH_VAL_MAX];
136 struct bgp_pbr_match_val tcpflags[BGP_PBR_MATCH_VAL_MAX];
137 struct bgp_pbr_fragment_val fragment;
138
139 uint16_t action_num;
140 struct bgp_pbr_entry_action actions[ACTIONS_MAX_NUM];
141
142 uint8_t distance;
143
144 uint32_t metric;
145
146 route_tag_t tag;
147
148 uint32_t mtu;
149
150 vrf_id_t vrf_id;
151 };
152
153 struct bgp_pbr_interface {
154 RB_ENTRY(bgp_pbr_interface) id_entry;
155 char name[INTERFACE_NAMSIZ];
156 };
157
158 RB_HEAD(bgp_pbr_interface_head, bgp_pbr_interface);
159 RB_PROTOTYPE(bgp_pbr_interface_head, bgp_pbr_interface, id_entry,
160 bgp_pbr_interface_compare);
161
162 extern int bgp_pbr_interface_compare(const struct bgp_pbr_interface *a,
163 const struct bgp_pbr_interface *b);
164
165 struct bgp_pbr_config {
166 struct bgp_pbr_interface_head ifaces_by_name_ipv4;
167 bool pbr_interface_any_ipv4;
168 };
169
170 extern struct bgp_pbr_config *bgp_pbr_cfg;
171
172 struct bgp_pbr_match {
173 char ipset_name[ZEBRA_IPSET_NAME_SIZE];
174
175 /* mapped on enum ipset_type
176 */
177 uint32_t type;
178
179 #define MATCH_IP_SRC_SET (1 << 0)
180 #define MATCH_IP_DST_SET (1 << 1)
181 #define MATCH_PORT_SRC_SET (1 << 2)
182 #define MATCH_PORT_DST_SET (1 << 3)
183 #define MATCH_PORT_SRC_RANGE_SET (1 << 4)
184 #define MATCH_PORT_DST_RANGE_SET (1 << 5)
185 uint32_t flags;
186
187 vrf_id_t vrf_id;
188
189 /* unique identifier for ipset create transaction
190 */
191 uint32_t unique;
192
193 /* unique identifier for iptable add transaction
194 */
195 uint32_t unique2;
196
197 bool installed;
198 bool install_in_progress;
199
200 bool installed_in_iptable;
201 bool install_iptable_in_progress;
202
203 struct hash *entry_hash;
204
205 struct bgp_pbr_action *action;
206
207 };
208
209 struct bgp_pbr_match_entry {
210 struct bgp_pbr_match *backpointer;
211
212 uint32_t unique;
213
214 struct prefix src;
215 struct prefix dst;
216
217 uint16_t src_port_min;
218 uint16_t src_port_max;
219 uint16_t dst_port_min;
220 uint16_t dst_port_max;
221 uint8_t proto;
222
223 void *bgp_info;
224
225 bool installed;
226 bool install_in_progress;
227 };
228
229 struct bgp_pbr_action {
230
231 /*
232 * The Unique identifier of this specific pbrms
233 */
234 uint32_t unique;
235
236 uint32_t fwmark;
237
238 uint32_t table_id;
239
240 float rate;
241
242 /*
243 * nexthop information, or drop information
244 * contains src vrf_id and nh contains dest vrf_id
245 */
246 vrf_id_t vrf_id;
247 struct nexthop nh;
248
249 bool installed;
250 bool install_in_progress;
251 uint32_t refcnt;
252 struct bgp *bgp;
253 };
254
255 extern struct bgp_pbr_action *bgp_pbr_action_rule_lookup(vrf_id_t vrf_id,
256 uint32_t unique);
257
258 extern struct bgp_pbr_match *bgp_pbr_match_ipset_lookup(vrf_id_t vrf_id,
259 uint32_t unique);
260
261 extern struct bgp_pbr_match_entry *bgp_pbr_match_ipset_entry_lookup(
262 vrf_id_t vrf_id, char *name,
263 uint32_t unique);
264 extern struct bgp_pbr_match *bgp_pbr_match_iptable_lookup(vrf_id_t vrf_id,
265 uint32_t unique);
266
267 extern void bgp_pbr_cleanup(struct bgp *bgp);
268 extern void bgp_pbr_init(struct bgp *bgp);
269
270 extern uint32_t bgp_pbr_action_hash_key(void *arg);
271 extern int bgp_pbr_action_hash_equal(const void *arg1,
272 const void *arg2);
273 extern uint32_t bgp_pbr_match_entry_hash_key(void *arg);
274 extern int bgp_pbr_match_entry_hash_equal(const void *arg1,
275 const void *arg2);
276 extern uint32_t bgp_pbr_match_hash_key(void *arg);
277 extern int bgp_pbr_match_hash_equal(const void *arg1,
278 const void *arg2);
279
280 void bgp_pbr_print_policy_route(struct bgp_pbr_entry_main *api);
281
282 struct bgp_node;
283 struct bgp_info;
284 extern void bgp_pbr_update_entry(struct bgp *bgp, struct prefix *p,
285 struct bgp_info *new_select,
286 afi_t afi, safi_t safi,
287 bool nlri_update);
288
289 /* bgp pbr utilities */
290 extern struct bgp_pbr_interface *pbr_interface_lookup(const char *name);
291 extern void bgp_pbr_reset(struct bgp *bgp, afi_t afi);
292 extern struct bgp_pbr_interface *bgp_pbr_interface_lookup(const char *name,
293 struct bgp_pbr_interface_head *head);
294
295 #endif /* __BGP_PBR_H__ */