]> git.proxmox.com Git - mirror_frr.git/blame - bgpd/bgp_route.h
Merge pull request #624 "Babel"
[mirror_frr.git] / bgpd / bgp_route.h
CommitLineData
718e3744 1/* BGP routing information base
896014f4
DL
2 * Copyright (C) 1996, 97, 98, 2000 Kunihiro Ishiguro
3 *
4 * This file is part of GNU Zebra.
5 *
6 * GNU Zebra 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 * GNU Zebra 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 */
718e3744 20
00d252cb 21#ifndef _QUAGGA_BGP_ROUTE_H
22#define _QUAGGA_BGP_ROUTE_H
23
fb018d25 24#include "queue.h"
200df115 25#include "bgp_table.h"
26
fb018d25 27struct bgp_nexthop_cache;
7ef5a232 28struct bgp_route_evpn;
fb018d25 29
b2f0fa55
PG
30enum bgp_show_type
31{
32 bgp_show_type_normal,
33 bgp_show_type_regexp,
34 bgp_show_type_prefix_list,
35 bgp_show_type_filter_list,
36 bgp_show_type_route_map,
37 bgp_show_type_neighbor,
38 bgp_show_type_cidr_only,
39 bgp_show_type_prefix_longer,
40 bgp_show_type_community_all,
41 bgp_show_type_community,
42 bgp_show_type_community_exact,
43 bgp_show_type_community_list,
44 bgp_show_type_community_list_exact,
c016b6c7
DS
45 bgp_show_type_lcommunity_all,
46 bgp_show_type_lcommunity,
47 bgp_show_type_lcommunity_list,
b2f0fa55
PG
48 bgp_show_type_flap_statistics,
49 bgp_show_type_flap_neighbor,
50 bgp_show_type_dampend_paths,
51 bgp_show_type_damp_neighbor
52};
53
54
3f9c7369
DS
55#define BGP_SHOW_SCODE_HEADER "Status codes: s suppressed, d damped, "\
56 "h history, * valid, > best, = multipath,%s"\
57 " i internal, r RIB-failure, S Stale, R Removed%s"
58#define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete%s%s"
59#define BGP_SHOW_HEADER " Network Next Hop Metric LocPrf Weight Path%s"
60
fb982c25
PJ
61/* Ancillary information to struct bgp_info,
62 * used for uncommonly used data (aggregation, MPLS, etc.)
63 * and lazily allocated to save memory.
64 */
65struct bgp_info_extra
66{
67 /* Pointer to dampening structure. */
68 struct bgp_damp_info *damp_info;
69
70 /* This route is suppressed with aggregation. */
71 int suppress;
72
73 /* Nexthop reachability check. */
74 u_int32_t igpmetric;
75
76 /* MPLS label. */
77 u_char tag[3];
65efcfce
LB
78
79#if ENABLE_BGP_VNC
80 union {
81
82 struct {
83 void *rfapi_handle; /* export: NVE advertising this route */
84 struct list *local_nexthops; /* optional, for static routes */
85 } export;
86
87 struct {
b210b827 88 struct thread *timer;
65efcfce
LB
89 void *hme; /* encap monitor, if this is a VPN route */
90 struct prefix_rd rd; /* import: route's route-distinguisher */
91 u_char un_family; /* family of cached un address, 0 if unset */
92 union {
93 struct in_addr addr4;
94 struct in6_addr addr6;
95 } un; /* cached un address */
96 time_t create_time;
5ef6cd69 97 struct prefix aux_prefix; /* AFI_L2VPN: the IP addr, if family set */
65efcfce
LB
98 } import;
99
100 } vnc;
101#endif
fb982c25
PJ
102};
103
718e3744 104struct bgp_info
105{
106 /* For linked list. */
107 struct bgp_info *next;
108 struct bgp_info *prev;
fb018d25
DS
109
110 /* For nexthop linked list */
111 LIST_ENTRY(bgp_info) nh_thread;
112
113 /* Back pointer to the prefix node */
114 struct bgp_node *net;
115
116 /* Back pointer to the nexthop structure */
117 struct bgp_nexthop_cache *nexthop;
118
cbdfbaa5
PJ
119 /* Peer structure. */
120 struct peer *peer;
121
122 /* Attribute structure. */
123 struct attr *attr;
fb982c25
PJ
124
125 /* Extra information */
126 struct bgp_info_extra *extra;
127
de8d5dff
JB
128
129 /* Multipath information */
130 struct bgp_info_mpath *mpath;
131
cbdfbaa5
PJ
132 /* Uptime. */
133 time_t uptime;
134
200df115 135 /* reference count */
228da428 136 int lock;
200df115 137
718e3744 138 /* BGP information status. */
93406d87 139 u_int16_t flags;
718e3744 140#define BGP_INFO_IGP_CHANGED (1 << 0)
141#define BGP_INFO_DAMPED (1 << 1)
142#define BGP_INFO_HISTORY (1 << 2)
143#define BGP_INFO_SELECTED (1 << 3)
144#define BGP_INFO_VALID (1 << 4)
145#define BGP_INFO_ATTR_CHANGED (1 << 5)
146#define BGP_INFO_DMED_CHECK (1 << 6)
147#define BGP_INFO_DMED_SELECTED (1 << 7)
93406d87 148#define BGP_INFO_STALE (1 << 8)
b40d939b 149#define BGP_INFO_REMOVED (1 << 9)
902212c3 150#define BGP_INFO_COUNTED (1 << 10)
de8d5dff
JB
151#define BGP_INFO_MULTIPATH (1 << 11)
152#define BGP_INFO_MULTIPATH_CHG (1 << 12)
cd1964ff 153#define BGP_INFO_RIB_ATTR_CHG (1 << 13)
718e3744 154
cbdfbaa5
PJ
155 /* BGP route type. This can be static, RIP, OSPF, BGP etc. */
156 u_char type;
157
158 /* When above type is BGP. This sub type specify BGP sub type
159 information. */
160 u_char sub_type;
161#define BGP_ROUTE_NORMAL 0
162#define BGP_ROUTE_STATIC 1
163#define BGP_ROUTE_AGGREGATE 2
164#define BGP_ROUTE_REDISTRIBUTE 3
65efcfce
LB
165#ifdef ENABLE_BGP_VNC
166# define BGP_ROUTE_RFP 4
167#endif
7c8ff89e
DS
168
169 u_short instance;
170
a82478b9
DS
171 /* Addpath identifiers */
172 u_int32_t addpath_rx_id;
173 u_int32_t addpath_tx_id;
174
718e3744 175};
176
177/* BGP static route configuration. */
178struct bgp_static
179{
180 /* Backdoor configuration. */
181 int backdoor;
182
1b6d5c7e
VV
183 /* Label index configuration; applies to LU prefixes. */
184 u_int32_t label_index;
185#define BGP_INVALID_LABEL_INDEX 0xFFFFFFFF
186
718e3744 187 /* Import check status. */
188 u_char valid;
189
190 /* IGP metric. */
191 u_int32_t igpmetric;
192
193 /* IGP nexthop. */
194 struct in_addr igpnexthop;
195
41367172
PJ
196 /* Atomic set reference count (ie cause of pathlimit) */
197 u_int32_t atomic;
198
718e3744 199 /* BGP redistribute route-map. */
200 struct
201 {
202 char *name;
203 struct route_map *map;
204 } rmap;
205
137446f9
LB
206 /* Route Distinguisher */
207 struct prefix_rd prd;
208
718e3744 209 /* MPLS label. */
210 u_char tag[3];
684a7227
PG
211
212 /* EVPN */
213 struct eth_segment_id *eth_s_id;
31689a53 214 struct ethaddr *router_mac;
aee875b5 215 uint16_t encap_tunneltype;
a2dac1ef 216 struct prefix gatewayIp;
718e3744 217};
218
fe3ca08f
LB
219#define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
220 ((nhlen) < IPV4_MAX_BYTELEN ? 0 : \
221 ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
222
8a92a8a0
DS
223#define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
224 (! CHECK_FLAG (attr->flag, ATTR_FLAG_BIT (BGP_ATTR_NEXT_HOP)) && \
225 (attr)->extra && ((attr)->extra->mp_nexthop_len == 16 || \
226 (attr)->extra->mp_nexthop_len == 32))
80e0ad24
DS
227#define BGP_INFO_COUNTABLE(BI) \
228 (! CHECK_FLAG ((BI)->flags, BGP_INFO_HISTORY) \
229 && ! CHECK_FLAG ((BI)->flags, BGP_INFO_REMOVED))
230
1a392d46
PJ
231/* Flags which indicate a route is unuseable in some form */
232#define BGP_INFO_UNUSEABLE \
233 (BGP_INFO_HISTORY|BGP_INFO_DAMPED|BGP_INFO_REMOVED)
234/* Macro to check BGP information is alive or not. Sadly,
235 * not equivalent to just checking previous, because of the
236 * sense of the additional VALID flag.
237 */
238#define BGP_INFO_HOLDDOWN(BI) \
239 (! CHECK_FLAG ((BI)->flags, BGP_INFO_VALID) \
240 || CHECK_FLAG ((BI)->flags, BGP_INFO_UNUSEABLE))
241
718e3744 242#define DISTRIBUTE_IN_NAME(F) ((F)->dlist[FILTER_IN].name)
243#define DISTRIBUTE_IN(F) ((F)->dlist[FILTER_IN].alist)
244#define DISTRIBUTE_OUT_NAME(F) ((F)->dlist[FILTER_OUT].name)
245#define DISTRIBUTE_OUT(F) ((F)->dlist[FILTER_OUT].alist)
246
247#define PREFIX_LIST_IN_NAME(F) ((F)->plist[FILTER_IN].name)
248#define PREFIX_LIST_IN(F) ((F)->plist[FILTER_IN].plist)
249#define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
250#define PREFIX_LIST_OUT(F) ((F)->plist[FILTER_OUT].plist)
251
252#define FILTER_LIST_IN_NAME(F) ((F)->aslist[FILTER_IN].name)
253#define FILTER_LIST_IN(F) ((F)->aslist[FILTER_IN].aslist)
254#define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
255#define FILTER_LIST_OUT(F) ((F)->aslist[FILTER_OUT].aslist)
256
fee0f4c6 257#define ROUTE_MAP_IN_NAME(F) ((F)->map[RMAP_IN].name)
258#define ROUTE_MAP_IN(F) ((F)->map[RMAP_IN].map)
259#define ROUTE_MAP_OUT_NAME(F) ((F)->map[RMAP_OUT].name)
260#define ROUTE_MAP_OUT(F) ((F)->map[RMAP_OUT].map)
261
718e3744 262#define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
263#define UNSUPPRESS_MAP(F) ((F)->usmap.map)
264
2ec1e66f
DW
265/* path PREFIX (addpath rxid NUMBER) */
266#define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
267
4092b06c
DS
268enum bgp_path_type
269{
270 BGP_PATH_ALL,
271 BGP_PATH_BESTPATH,
272 BGP_PATH_MULTIPATH
273};
274
3f9c7369
DS
275static inline void
276bgp_bump_version (struct bgp_node *node)
277{
278 node->version = bgp_table_next_version(bgp_node_table(node));
279}
280
cd1964ff
DS
281static inline int
282bgp_fibupd_safi (safi_t safi)
283{
284 if (safi == SAFI_UNICAST ||
285 safi == SAFI_MULTICAST ||
286 safi == SAFI_LABELED_UNICAST)
287 return 1;
288 return 0;
289}
290
718e3744 291/* Prototypes. */
f188f2c4 292extern void bgp_process_queue_init (void);
94f2b392 293extern void bgp_route_init (void);
228da428 294extern void bgp_route_finish (void);
0c6262ed 295extern void bgp_cleanup_routes (struct bgp *);
94f2b392 296extern void bgp_announce_route (struct peer *, afi_t, safi_t);
3f9c7369 297extern void bgp_stop_announce_route_timer(struct peer_af *paf);
94f2b392 298extern void bgp_announce_route_all (struct peer *);
299extern void bgp_default_originate (struct peer *, afi_t, safi_t, int);
300extern void bgp_soft_reconfig_in (struct peer *, afi_t, safi_t);
2a3d5731 301extern void bgp_clear_route (struct peer *, afi_t, safi_t);
94f2b392 302extern void bgp_clear_route_all (struct peer *);
303extern void bgp_clear_adj_in (struct peer *, afi_t, safi_t);
304extern void bgp_clear_stale_route (struct peer *, afi_t, safi_t);
718e3744 305
4125bb67
DS
306extern struct bgp_node *bgp_afi_node_get (struct bgp_table *table, afi_t afi,
307 safi_t safi, struct prefix *p,
308 struct prefix_rd *prd);
200df115 309extern struct bgp_info *bgp_info_lock (struct bgp_info *);
310extern struct bgp_info *bgp_info_unlock (struct bgp_info *);
311extern void bgp_info_add (struct bgp_node *rn, struct bgp_info *ri);
312extern void bgp_info_delete (struct bgp_node *rn, struct bgp_info *ri);
fb982c25 313extern struct bgp_info_extra *bgp_info_extra_get (struct bgp_info *);
1a392d46
PJ
314extern void bgp_info_set_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
315extern void bgp_info_unset_flag (struct bgp_node *, struct bgp_info *, u_int32_t);
2ec1e66f 316extern void bgp_info_path_with_addpath_rx_str (struct bgp_info *ri, char *buf);
200df115 317
96e52474 318extern int bgp_nlri_parse_ip (struct peer *, struct attr *, struct bgp_nlri *);
718e3744 319
94f2b392 320extern int bgp_maximum_prefix_overflow (struct peer *, afi_t, safi_t, int);
718e3744 321
6aeb9e78 322extern void bgp_redistribute_add (struct bgp *, struct prefix *, const struct in_addr *,
bc413143 323 const struct in6_addr *, unsigned int ifindex,
dc9ffce8 324 u_int32_t, u_char, u_short, route_tag_t);
6aeb9e78 325extern void bgp_redistribute_delete (struct bgp *, struct prefix *, u_char, u_short);
7c8ff89e 326extern void bgp_redistribute_withdraw (struct bgp *, afi_t, int, u_short);
718e3744 327
6aeb9e78 328extern void bgp_static_add (struct bgp *);
94f2b392 329extern void bgp_static_delete (struct bgp *);
078430f6 330extern void bgp_static_redo_import_check (struct bgp *);
ad4cbda1 331extern void bgp_purge_static_redist_routes (struct bgp *bgp);
94f2b392 332extern void bgp_static_update (struct bgp *, struct prefix *, struct bgp_static *,
718e3744 333 afi_t, safi_t);
94f2b392 334extern void bgp_static_withdraw (struct bgp *, struct prefix *, afi_t, safi_t);
718e3744 335
201c3dac 336extern int bgp_static_set_safi (afi_t afi, safi_t safi, struct vty *vty, const char *,
3da6fcd5
PG
337 const char *, const char *, const char *,
338 int, const char *, const char *, const char *, const char *);
718e3744 339
201c3dac 340extern int bgp_static_unset_safi (afi_t afi, safi_t safi, struct vty *, const char *,
3da6fcd5
PG
341 const char *, const char *,
342 int, const char *, const char *, const char *);
718e3744 343
94f2b392 344/* this is primarily for MPLS-VPN */
a82478b9 345extern int bgp_update (struct peer *, struct prefix *, u_int32_t, struct attr *,
7ef5a232
PG
346 afi_t, safi_t, int, int, struct prefix_rd *,
347 u_char *, int, struct bgp_route_evpn *);
a82478b9 348extern int bgp_withdraw (struct peer *, struct prefix *, u_int32_t, struct attr *,
7ef5a232
PG
349 afi_t, safi_t, int, int, struct prefix_rd *, u_char *,
350 struct bgp_route_evpn *);
718e3744 351
94f2b392 352/* for bgp_nexthop and bgp_damp */
353extern void bgp_process (struct bgp *, struct bgp_node *, afi_t, safi_t);
cb1faec9
DS
354
355/*
356 * Add an end-of-initial-update marker to the process queue. This is just a
357 * queue element with NULL bgp node.
358 */
2a3d5731 359extern void bgp_add_eoiu_mark (struct bgp *);
73ac8160
DS
360extern int bgp_config_write_table_map (struct vty *, struct bgp *, afi_t, safi_t,
361 int *);
94f2b392 362extern int bgp_config_write_network (struct vty *, struct bgp *, afi_t, safi_t, int *);
734b349e 363extern int bgp_config_write_distance (struct vty *, struct bgp *, afi_t, safi_t, int *);
94f2b392 364
365extern void bgp_aggregate_increment (struct bgp *, struct prefix *, struct bgp_info *,
718e3744 366 afi_t, safi_t);
94f2b392 367extern void bgp_aggregate_decrement (struct bgp *, struct prefix *, struct bgp_info *,
718e3744 368 afi_t, safi_t);
369
734b349e 370extern u_char bgp_distance_apply (struct prefix *, struct bgp_info *, afi_t, safi_t, struct bgp *);
718e3744 371
94f2b392 372extern afi_t bgp_node_afi (struct vty *);
373extern safi_t bgp_node_safi (struct vty *);
5a646650 374
b05a1c8b 375extern void route_vty_out (struct vty *, struct prefix *, struct bgp_info *, int, safi_t, json_object *);
856ca177
MS
376extern void route_vty_out_tag (struct vty *, struct prefix *, struct bgp_info *, int, safi_t, json_object *);
377extern void route_vty_out_tmp (struct vty *, struct prefix *, struct attr *, safi_t, u_char, json_object *);
784d3a42
PG
378extern void
379route_vty_out_overlay (struct vty *vty, struct prefix *p,
380 struct bgp_info *binfo, int display, json_object *json);
00d252cb 381
3f9c7369
DS
382extern int
383subgroup_process_announce_selected (struct update_subgroup *subgrp,
384 struct bgp_info *selected,
adbac85e
DW
385 struct bgp_node *rn,
386 u_int32_t addpath_tx_id);
3f9c7369 387
cd1964ff 388extern int subgroup_announce_check(struct bgp_node *rn, struct bgp_info *ri,
3f9c7369
DS
389 struct update_subgroup *subgrp,
390 struct prefix *p, struct attr *attr);
391
bb86c601
LB
392extern void bgp_peer_clear_node_queue_drain_immediate (struct peer *peer);
393extern void bgp_process_queues_drain_immediate (void);
394
65efcfce
LB
395/* for encap/vpn */
396extern struct bgp_node *
397bgp_afi_node_get (struct bgp_table *, afi_t , safi_t , struct prefix *,
398 struct prefix_rd *);
399extern struct bgp_info *bgp_info_new (void);
400extern void bgp_info_restore (struct bgp_node *, struct bgp_info *);
401
402extern int bgp_info_cmp_compatible (struct bgp *, struct bgp_info *,
403 struct bgp_info *, afi_t, safi_t );
404
00d252cb 405#endif /* _QUAGGA_BGP_ROUTE_H */