]> git.proxmox.com Git - mirror_frr.git/blame - bgpd/bgpd.h
Merge pull request #5717 from pguibert6WIND/flowspec_issue_redistribute
[mirror_frr.git] / bgpd / bgpd.h
CommitLineData
718e3744 1/* BGP message definition header.
896014f4
DL
2 * Copyright (C) 1996, 97, 98, 99, 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_BGPD_H
22#define _QUAGGA_BGPD_H
23
19df7279 24#include "qobj.h"
d3ecc69e
QY
25#include <pthread.h>
26
2b9bcf30 27#include "hook.h"
1ac267a2 28#include "frr_pthread.h"
856ca177 29#include "lib/json.h"
6aeb9e78 30#include "vrf.h"
94c60424 31#include "vty.h"
17136bf2 32#include "iana_afi.h"
6aeb9e78 33
718e3744 34/* For union sockunion. */
3f9c7369 35#include "queue.h"
718e3744 36#include "sockunion.h"
518f0eb1 37#include "routemap.h"
ffd0c037 38#include "linklist.h"
8efe88ea 39#include "defaults.h"
4a1ab8e4 40#include "bgp_memory.h"
14c1a7bf 41#include "bitfield.h"
fe1dc5a3 42#include "vxlan.h"
955bfd98 43#include "bgp_labelpool.h"
dcc68b5e 44#include "bgp_addpath_types.h"
718e3744 45
04b6bdc0 46#define BGP_MAX_HOSTNAME 64 /* Linux max, is larger than most other sys */
40520c36 47#define BGP_PEER_MAX_HASH_SIZE 16384
04b6bdc0 48
5c81b96a 49/* Default interval for IPv6 RAs when triggered by BGP unnumbered neighbor. */
50#define BGP_UNNUM_DEFAULT_RA_INTERVAL 10
51
3f9c7369
DS
52struct update_subgroup;
53struct bpacket;
4762c213 54struct bgp_pbr_config;
3f9c7369 55
0299c004
DS
56/*
57 * Allow the neighbor XXXX remote-as to take internal or external
d62a17ae 58 * AS_SPECIFIED is zero to auto-inherit original non-feature/enhancement
59 * behavior
0299c004
DS
60 * in the system.
61 */
d62a17ae 62enum { AS_UNSPECIFIED = 0,
63 AS_SPECIFIED,
64 AS_INTERNAL,
65 AS_EXTERNAL,
0299c004
DS
66};
67
2d3dd828 68/* Zebra Gracaful Restart states */
69enum zebra_gr_mode {
70 ZEBRA_GR_DISABLE = 0,
71 ZEBRA_GR_ENABLE
72};
73
718e3744 74/* Typedef BGP specific types. */
d7c0a89a
QY
75typedef uint32_t as_t;
76typedef uint16_t as16_t; /* we may still encounter 16 Bit asnums */
77typedef uint16_t bgp_size_t;
718e3744 78
d62a17ae 79#define max(a, b) \
80 ({ \
81 __typeof__(a) _a = (a); \
82 __typeof__(b) _b = (b); \
83 _a > _b ? _a : _b; \
84 })
85
86enum bgp_af_index {
87 BGP_AF_START,
88 BGP_AF_IPV4_UNICAST = BGP_AF_START,
89 BGP_AF_IPV4_MULTICAST,
90 BGP_AF_IPV4_VPN,
91 BGP_AF_IPV6_UNICAST,
92 BGP_AF_IPV6_MULTICAST,
93 BGP_AF_IPV6_VPN,
94 BGP_AF_IPV4_ENCAP,
95 BGP_AF_IPV6_ENCAP,
96 BGP_AF_L2VPN_EVPN,
97 BGP_AF_IPV4_LBL_UNICAST,
98 BGP_AF_IPV6_LBL_UNICAST,
7c40bf39 99 BGP_AF_IPV4_FLOWSPEC,
100 BGP_AF_IPV6_FLOWSPEC,
d62a17ae 101 BGP_AF_MAX
3f9c7369
DS
102};
103
d62a17ae 104#define AF_FOREACH(af) for ((af) = BGP_AF_START; (af) < BGP_AF_MAX; (af)++)
3f9c7369 105
d62a17ae 106#define FOREACH_AFI_SAFI(afi, safi) \
107 for (afi = AFI_IP; afi < AFI_MAX; afi++) \
108 for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
3f9c7369 109
d1927ebe
AS
110#define FOREACH_SAFI(safi) \
111 for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
3f9c7369 112
1ac267a2
DL
113extern struct frr_pthread *bgp_pth_io;
114extern struct frr_pthread *bgp_pth_ka;
115
718e3744 116/* BGP master for system wide configurations and variables. */
d62a17ae 117struct bgp_master {
118 /* BGP instance list. */
119 struct list *bgp;
120
121 /* BGP thread master. */
122 struct thread_master *master;
718e3744 123
d62a17ae 124 /* work queues */
125 struct work_queue *process_main_queue;
87d4a781 126
d62a17ae 127 /* Listening sockets */
128 struct list *listen_sockets;
718e3744 129
d62a17ae 130 /* BGP port number. */
d7c0a89a 131 uint16_t port;
3a02d1f7 132
d62a17ae 133 /* Listener address */
134 char *address;
718e3744 135
48ecf8f5
DS
136 /* The Mac table */
137 struct hash *self_mac_hash;
138
d62a17ae 139 /* BGP start time. */
140 time_t start_time;
141
142 /* Various BGP global configuration. */
d7c0a89a 143 uint8_t options;
718e3744 144#define BGP_OPT_NO_FIB (1 << 0)
d8a9922d
DS
145#define BGP_OPT_NO_LISTEN (1 << 1)
146#define BGP_OPT_NO_ZEBRA (1 << 2)
3f9c7369 147
d62a17ae 148 uint64_t updgrp_idspace;
149 uint64_t subgrp_idspace;
5fe9f963 150
d62a17ae 151 /* timer to dampen route map changes */
152 struct thread *t_rmap_update; /* Handle route map updates */
d7c0a89a 153 uint32_t rmap_update_timer; /* Route map update timer */
5fe9f963 154#define RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
19df7279 155
e9eb5f63 156 /* Id space for automatic RD derivation for an EVI/VRF */
157 bitfield_t rd_idspace;
158
955bfd98
PZ
159 /* dynamic mpls label allocation pool */
160 struct labelpool labelpool;
161
e2f3a930
T
162 /* BGP-EVPN VRF ID. Defaults to default VRF (if any) */
163 struct bgp* bgp_evpn;
164
c2d020ad
DS
165 /* How big should we set the socket buffer size */
166 uint32_t socket_buffer;
167
97b4a0ec 168 bool terminating; /* global flag that sigint terminate seen */
d62a17ae 169 QOBJ_FIELDS
718e3744 170};
19df7279 171DECLARE_QOBJ_TYPE(bgp_master)
718e3744 172
73ac8160 173/* BGP route-map structure. */
d62a17ae 174struct bgp_rmap {
175 char *name;
176 struct route_map *map;
73ac8160
DS
177};
178
d62a17ae 179struct bgp_redist {
d7c0a89a 180 unsigned short instance;
7c8ff89e 181
d62a17ae 182 /* BGP redistribute metric configuration. */
d7c0a89a
QY
183 uint8_t redist_metric_flag;
184 uint32_t redist_metric;
7c8ff89e 185
d62a17ae 186 /* BGP redistribute route-map. */
187 struct bgp_rmap rmap;
7c8ff89e
DS
188};
189
ddb5b488
PZ
190typedef enum {
191 BGP_VPN_POLICY_DIR_FROMVPN = 0,
192 BGP_VPN_POLICY_DIR_TOVPN = 1,
193 BGP_VPN_POLICY_DIR_MAX = 2
194} vpn_policy_direction_t;
195
e70e9f8e
PZ
196struct vpn_policy {
197 struct bgp *bgp; /* parent */
198 afi_t afi;
199 struct ecommunity *rtlist[BGP_VPN_POLICY_DIR_MAX];
200 struct ecommunity *import_redirect_rtlist;
201 char *rmap_name[BGP_VPN_POLICY_DIR_MAX];
202 struct route_map *rmap[BGP_VPN_POLICY_DIR_MAX];
203
204 /* should be mpls_label_t? */
205 uint32_t tovpn_label; /* may be MPLS_LABEL_NONE */
206 uint32_t tovpn_zebra_vrf_label_last_sent;
207 struct prefix_rd tovpn_rd;
208 struct prefix tovpn_nexthop; /* unset => set to 0 */
209 uint32_t flags;
210#define BGP_VPN_POLICY_TOVPN_LABEL_AUTO (1 << 0)
211#define BGP_VPN_POLICY_TOVPN_RD_SET (1 << 1)
212#define BGP_VPN_POLICY_TOVPN_NEXTHOP_SET (1 << 2)
12a844a5 213
1d4e8b0d
DS
214 /*
215 * If we are importing another vrf into us keep a list of
216 * vrf names that are being imported into us.
217 */
12a844a5 218 struct list *import_vrf;
1d4e8b0d
DS
219
220 /*
221 * if we are being exported to another vrf keep a list of
222 * vrf names that we are being exported to.
223 */
12a844a5 224 struct list *export_vrf;
e70e9f8e
PZ
225};
226
ad4cbda1 227/*
228 * Type of 'struct bgp'.
229 * - Default: The default instance
230 * - VRF: A specific (non-default) VRF
231 * - View: An instance used for route exchange
232 * The "default" instance is treated separately to simplify the code. Note
233 * that if deployed in a Multi-VRF environment, it may not exist.
234 */
d62a17ae 235enum bgp_instance_type {
236 BGP_INSTANCE_TYPE_DEFAULT,
237 BGP_INSTANCE_TYPE_VRF,
238 BGP_INSTANCE_TYPE_VIEW
ad4cbda1 239};
240
9e3b51a7 241#define BGP_SEND_EOR(bgp, afi, safi) \
242 (!bgp_flag_check(bgp, BGP_FLAG_GR_DISABLE_EOR) && \
243 ((bgp->gr_info[afi][safi].t_select_deferral == NULL) || \
244 (bgp->gr_info[afi][safi].eor_required == \
245 bgp->gr_info[afi][safi].eor_received)))
b0965c44 246
247/* BGP GR Global ds */
248
2ba1fe69 249#define BGP_GLOBAL_GR_MODE 4
250#define BGP_GLOBAL_GR_EVENT_CMD 4
b0965c44 251
b0965c44 252/* Graceful restart selection deferral timer info */
253struct graceful_restart_info {
254 /* Count of EOR message expected */
255 uint32_t eor_required;
256 /* Count of EOR received */
257 uint32_t eor_received;
258 /* Deferral Timer */
259 struct thread *t_select_deferral;
260 /* Route list */
261 struct list *route_list;
262 /* Best route select */
263 struct thread *t_route_select;
2d3dd828 264 /* AFI, SAFI enabled */
265 bool af_enabled[AFI_MAX][SAFI_MAX];
266 /* Route update completed */
267 bool route_sync[AFI_MAX][SAFI_MAX];
b0965c44 268};
269
b0965c44 270enum global_mode {
271 GLOBAL_HELPER = 0, /* This is the default mode */
272 GLOBAL_GR,
273 GLOBAL_DISABLE,
274 GLOBAL_INVALID
275};
276
277enum global_gr_command {
278 GLOBAL_GR_CMD = 0,
279 NO_GLOBAL_GR_CMD,
280 GLOBAL_DISABLE_CMD,
281 NO_GLOBAL_DISABLE_CMD
282};
283
284#define BGP_GR_SUCCESS 0
285#define BGP_GR_FAILURE 1
286
718e3744 287/* BGP instance structure. */
d62a17ae 288struct bgp {
289 /* AS number of this BGP instance. */
290 as_t as;
291
292 /* Name of this BGP instance. */
293 char *name;
3572fb26 294 char *name_pretty; /* printable "VRF|VIEW name|default" */
d62a17ae 295
296 /* Type of instance and VRF id. */
297 enum bgp_instance_type inst_type;
298 vrf_id_t vrf_id;
299
300 /* Reference count to allow peer_delete to finish after bgp_delete */
301 int lock;
302
303 /* Self peer. */
304 struct peer *peer_self;
305
306 /* BGP peer. */
307 struct list *peer;
308 struct hash *peerhash;
309
310 /* BGP peer group. */
311 struct list *group;
312
313 /* The maximum number of BGP dynamic neighbors that can be created */
314 int dynamic_neighbors_limit;
315
316 /* The current number of BGP dynamic neighbors */
317 int dynamic_neighbors_count;
318
319 struct hash *update_groups[BGP_AF_MAX];
320
321 /*
322 * Global statistics for update groups.
323 */
324 struct {
d7c0a89a
QY
325 uint32_t join_events;
326 uint32_t prune_events;
327 uint32_t merge_events;
328 uint32_t split_events;
329 uint32_t updgrp_switch_events;
330 uint32_t peer_refreshes_combined;
331 uint32_t adj_count;
332 uint32_t merge_checks_triggered;
333
334 uint32_t updgrps_created;
335 uint32_t updgrps_deleted;
336 uint32_t subgrps_created;
337 uint32_t subgrps_deleted;
d62a17ae 338 } update_group_stats;
339
340 /* BGP configuration. */
d7c0a89a 341 uint16_t config;
c2d58d6d 342#define BGP_CONFIG_CLUSTER_ID (1 << 0)
343#define BGP_CONFIG_CONFEDERATION (1 << 1)
718e3744 344
d62a17ae 345 /* BGP router identifier. */
346 struct in_addr router_id;
347 struct in_addr router_id_static;
348 struct in_addr router_id_zebra;
718e3744 349
d62a17ae 350 /* BGP route reflector cluster ID. */
351 struct in_addr cluster_id;
718e3744 352
d62a17ae 353 /* BGP confederation information. */
354 as_t confed_id;
355 as_t *confed_peers;
356 int confed_peers_cnt;
718e3744 357
d62a17ae 358 struct thread
359 *t_startup; /* start-up timer on only once at the beginning */
abc920f8 360
d7c0a89a 361 uint32_t v_maxmed_onstartup; /* Duration of max-med on start-up */
abc920f8 362#define BGP_MAXMED_ONSTARTUP_UNCONFIGURED 0 /* 0 means off, its the default */
d7c0a89a
QY
363 uint32_t maxmed_onstartup_value; /* Max-med value when active on
364 start-up */
d62a17ae 365 struct thread
366 *t_maxmed_onstartup; /* non-null when max-med onstartup is on */
d7c0a89a 367 uint8_t maxmed_onstartup_over; /* Flag to make it effective only once */
d62a17ae 368
d7c0a89a 369 uint8_t v_maxmed_admin; /* 1/0 if max-med administrative is on/off */
abc920f8 370#define BGP_MAXMED_ADMIN_UNCONFIGURED 0 /* Off by default */
d7c0a89a
QY
371 uint32_t maxmed_admin_value; /* Max-med value when administrative in on
372 */
abc920f8
DS
373#define BGP_MAXMED_VALUE_DEFAULT 4294967294 /* Maximum by default */
374
d7c0a89a
QY
375 uint8_t maxmed_active; /* 1/0 if max-med is active or not */
376 uint32_t maxmed_value; /* Max-med value when its active */
d62a17ae 377
378 /* BGP update delay on startup */
379 struct thread *t_update_delay;
380 struct thread *t_establish_wait;
d7c0a89a
QY
381 uint8_t update_delay_over;
382 uint8_t main_zebra_update_hold;
383 uint8_t main_peers_update_hold;
384 uint16_t v_update_delay;
385 uint16_t v_establish_wait;
d62a17ae 386 char update_delay_begin_time[64];
387 char update_delay_end_time[64];
388 char update_delay_zebra_resume_time[64];
389 char update_delay_peers_resume_time[64];
d7c0a89a
QY
390 uint32_t established;
391 uint32_t restarted_peers;
392 uint32_t implicit_eors;
393 uint32_t explicit_eors;
f188f2c4
DS
394#define BGP_UPDATE_DELAY_DEF 0
395#define BGP_UPDATE_DELAY_MIN 0
396#define BGP_UPDATE_DELAY_MAX 3600
397
d62a17ae 398 /* BGP flags. */
d7c0a89a 399 uint32_t flags;
718e3744 400#define BGP_FLAG_ALWAYS_COMPARE_MED (1 << 0)
401#define BGP_FLAG_DETERMINISTIC_MED (1 << 1)
402#define BGP_FLAG_MED_MISSING_AS_WORST (1 << 2)
403#define BGP_FLAG_MED_CONFED (1 << 3)
404#define BGP_FLAG_NO_DEFAULT_IPV4 (1 << 4)
405#define BGP_FLAG_NO_CLIENT_TO_CLIENT (1 << 5)
718e3744 406#define BGP_FLAG_COMPARE_ROUTER_ID (1 << 7)
407#define BGP_FLAG_ASPATH_IGNORE (1 << 8)
408#define BGP_FLAG_IMPORT_CHECK (1 << 9)
409#define BGP_FLAG_NO_FAST_EXT_FAILOVER (1 << 10)
848973c7 410#define BGP_FLAG_LOG_NEIGHBOR_CHANGES (1 << 11)
b0965c44 411
412/* This flag is set when we have full BGP Graceful-Restart mode enable */
538621f2 413#define BGP_FLAG_GRACEFUL_RESTART (1 << 12)
b0965c44 414
6811845b 415#define BGP_FLAG_ASPATH_CONFED (1 << 13)
2fdd455c 416#define BGP_FLAG_ASPATH_MULTIPATH_RELAX (1 << 14)
8bd9d948 417#define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1 << 15)
907f92c8 418#define BGP_FLAG_DISABLE_NH_CONNECTED_CHK (1 << 16)
219178b6 419#define BGP_FLAG_MULTIPATH_RELAX_AS_SET (1 << 17)
078430f6 420#define BGP_FLAG_FORCE_STATIC_PROCESS (1 << 18)
5623e905 421#define BGP_FLAG_SHOW_HOSTNAME (1 << 19)
6a9a3cde 422#define BGP_FLAG_GR_PRESERVE_FWD (1 << 20)
7f323236 423#define BGP_FLAG_GRACEFUL_SHUTDOWN (1 << 21)
9f822fa2 424#define BGP_FLAG_DELETE_IN_PROGRESS (1 << 22)
cfd47646 425#define BGP_FLAG_SELECT_DEFER_DISABLE (1 << 23)
d6e3c15b 426#define BGP_FLAG_GR_DISABLE_EOR (1 << 24)
b0965c44 427
2ba1fe69 428 enum global_mode GLOBAL_GR_FSM[BGP_GLOBAL_GR_MODE]
429 [BGP_GLOBAL_GR_EVENT_CMD];
b0965c44 430 enum global_mode global_gr_present_state;
431
2d3dd828 432 /* This variable stores the current Graceful Restart state of Zebra
433 * - ZEBRA_GR_ENABLE / ZEBRA_GR_DISABLE
434 */
435 enum zebra_gr_mode present_zebra_gr_state;
436
d62a17ae 437 /* BGP Per AF flags */
d7c0a89a 438 uint16_t af_flags[AFI_MAX][SAFI_MAX];
f4882003 439#define BGP_CONFIG_DAMPENING (1 << 0)
2c29b18a 440/* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */
f4882003
MK
441#define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST (1 << 1)
442#define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST (1 << 2)
443#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 3)
444#define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 4)
445/* import/export between address families */
446#define BGP_CONFIG_VRF_TO_MPLSVPN_EXPORT (1 << 5)
447#define BGP_CONFIG_MPLSVPN_TO_VRF_IMPORT (1 << 6)
448/* vrf-route leaking flags */
449#define BGP_CONFIG_VRF_TO_VRF_IMPORT (1 << 7)
450#define BGP_CONFIG_VRF_TO_VRF_EXPORT (1 << 8)
154faa50 451
210ec2a0
AS
452 /* BGP per AF peer count */
453 uint32_t af_peer_count[AFI_MAX][SAFI_MAX];
454
d62a17ae 455 /* Route table for next-hop lookup cache. */
456 struct bgp_table *nexthop_cache_table[AFI_MAX];
6aeb9e78 457
d62a17ae 458 /* Route table for import-check */
459 struct bgp_table *import_check_table[AFI_MAX];
6aeb9e78 460
d62a17ae 461 struct bgp_table *connected_table[AFI_MAX];
6aeb9e78 462
d62a17ae 463 struct hash *address_hash;
6aeb9e78 464
db0e1937
MK
465 /* DB for all local tunnel-ips - used mainly for martian checks
466 Currently it only has all VxLan tunnel IPs*/
467 struct hash *tip_hash;
468
d62a17ae 469 /* Static route configuration. */
470 struct bgp_table *route[AFI_MAX][SAFI_MAX];
718e3744 471
d62a17ae 472 /* Aggregate address configuration. */
473 struct bgp_table *aggregate[AFI_MAX][SAFI_MAX];
718e3744 474
d62a17ae 475 /* BGP routing information base. */
476 struct bgp_table *rib[AFI_MAX][SAFI_MAX];
718e3744 477
d62a17ae 478 /* BGP table route-map. */
479 struct bgp_rmap table_map[AFI_MAX][SAFI_MAX];
73ac8160 480
d62a17ae 481 /* BGP redistribute configuration. */
482 struct list *redist[AFI_MAX][ZEBRA_ROUTE_MAX];
718e3744 483
318cac96 484 /* Allocate MPLS labels */
d7c0a89a 485 uint8_t allocate_mpls_labels[AFI_MAX][SAFI_MAX];
318cac96 486
f3d32faa
PG
487 /* Allocate hash entries to store policy routing information
488 * The hash are used to host pbr rules somewhere.
489 * Actually, pbr will only be used by flowspec
490 * those hash elements will have relationship together as
491 * illustrated in below diagram:
492 *
493 * pbr_action a <----- pbr_match i <--- pbr_match_entry 1..n
494 * <----- pbr_match j <--- pbr_match_entry 1..m
27e376d4 495 * <----- pbr_rule k
f3d32faa
PG
496 *
497 * - here in BGP structure, the list of match and actions will
498 * stand for the list of ipset sets, and table_ids in the kernel
499 * - the arrow above between pbr_match and pbr_action indicate
500 * that a backpointer permits match to find the action
501 * - the arrow betwen match_entry and match is a hash list
502 * contained in match, that lists the whole set of entries
503 */
504 struct hash *pbr_match_hash;
27e376d4 505 struct hash *pbr_rule_hash;
f3d32faa
PG
506 struct hash *pbr_action_hash;
507
d62a17ae 508 /* timer to re-evaluate neighbor default-originate route-maps */
509 struct thread *t_rmap_def_originate_eval;
0de4848d
DS
510#define RMAP_DEFAULT_ORIGINATE_EVAL_TIMER 5
511
d62a17ae 512 /* BGP distance configuration. */
d7c0a89a
QY
513 uint8_t distance_ebgp[AFI_MAX][SAFI_MAX];
514 uint8_t distance_ibgp[AFI_MAX][SAFI_MAX];
515 uint8_t distance_local[AFI_MAX][SAFI_MAX];
d62a17ae 516
517 /* BGP default local-preference. */
d7c0a89a 518 uint32_t default_local_pref;
d62a17ae 519
520 /* BGP default subgroup pkt queue max */
d7c0a89a 521 uint32_t default_subgroup_pkt_queue_max;
d62a17ae 522
523 /* BGP default timer. */
d7c0a89a
QY
524 uint32_t default_holdtime;
525 uint32_t default_keepalive;
5d5393b9 526 uint32_t default_connect_retry;
d62a17ae 527
528 /* BGP graceful restart */
d7c0a89a
QY
529 uint32_t restart_time;
530 uint32_t stalepath_time;
b0965c44 531 uint32_t select_defer_time;
532 struct graceful_restart_info gr_info[AFI_MAX][SAFI_MAX];
2d3dd828 533 uint32_t rib_stale_time;
534
cfd47646 535#define BGP_ROUTE_SELECT_DELAY 1
536#define BGP_MAX_BEST_ROUTE_SELECT 10000
d62a17ae 537 /* Maximum-paths configuration */
538 struct bgp_maxpaths_cfg {
d7c0a89a
QY
539 uint16_t maxpaths_ebgp;
540 uint16_t maxpaths_ibgp;
541 uint16_t ibgp_flags;
5e242b0d 542#define BGP_FLAG_IBGP_MULTIPATH_SAME_CLUSTERLEN (1 << 0)
d62a17ae 543 } maxpaths[AFI_MAX][SAFI_MAX];
cb1faec9 544
555e09d4
QY
545 _Atomic uint32_t wpkt_quanta; // max # packets to write per i/o cycle
546 _Atomic uint32_t rpkt_quanta; // max # packets to read per i/o cycle
547
37a333fe
QY
548 /* Automatic coalesce adjust on/off */
549 bool heuristic_coalesce;
14b8641a
QY
550 /* Actual coalesce time */
551 uint32_t coalesce_time;
adbac85e 552
f26845f9
QY
553 /* Auto-shutdown new peers */
554 bool autoshutdown;
555
dcc68b5e 556 struct bgp_addpath_bgp_data tx_addpath;
65efcfce
LB
557
558#if ENABLE_BGP_VNC
d62a17ae 559 struct rfapi_cfg *rfapi_cfg;
560 struct rfapi *rfapi;
65efcfce 561#endif
19df7279 562
d62a17ae 563 /* EVPN related information */
14c1a7bf 564
d62a17ae 565 /* EVI hash table */
566 struct hash *vnihash;
14c1a7bf 567
1a98c087
MK
568 /* EVPN enable - advertise gateway macip routes */
569 int advertise_gw_macip;
570
d62a17ae 571 /* EVPN enable - advertise local VNIs and their MACs etc. */
572 int advertise_all_vni;
14c1a7bf 573
9dac9fc8
DA
574 /* RFC 8212 - prevent route leaks. */
575 int ebgp_requires_policy;
576#define DEFAULT_EBGP_POLICY_DISABLED 0
577#define DEFAULT_EBGP_POLICY_ENABLED 1
578
fb29348a
DA
579 /* draft-ietf-idr-deprecate-as-set-confed-set
580 * Reject aspaths with AS_SET and/or AS_CONFED_SET.
581 */
582 bool reject_as_sets;
583#define BGP_REJECT_AS_SETS_DISABLED 0
584#define BGP_REJECT_AS_SETS_ENABLED 1
585
85c8d83b
CS
586 struct bgp_evpn_info *evpn_info;
587
bf1061d8
VB
588 /* EVPN - use RFC 8365 to auto-derive RT */
589 int advertise_autort_rfc8365;
590
fd069644
DS
591 /*
592 * Flooding mechanism for BUM packets for VxLAN-EVPN.
593 */
594 enum vxlan_flood_control vxlan_flood_ctrl;
595
d62a17ae 596 /* Hash table of Import RTs to EVIs */
597 struct hash *import_rt_hash;
14c1a7bf 598
10ebe1ab
MK
599 /* Hash table of VRF import RTs to VRFs */
600 struct hash *vrf_import_rt_hash;
601
fe1dc5a3
MK
602 /* L3-VNI corresponding to this vrf */
603 vni_t l3vni;
604
605 /* router-mac to be used in mac-ip routes for this vrf */
606 struct ethaddr rmac;
607
b67a60d2 608 /* originator ip - to be used as NH for type-5 routes */
609 struct in_addr originator_ip;
610
0483af6e 611 /* SVI associated with the L3-VNI corresponding to this vrf */
612 ifindex_t l3vni_svi_ifindex;
613
fe1dc5a3
MK
614 /* vrf flags */
615 uint32_t vrf_flags;
676f83b9 616#define BGP_VRF_AUTO (1 << 0)
154faa50
MK
617#define BGP_VRF_IMPORT_RT_CFGD (1 << 1)
618#define BGP_VRF_EXPORT_RT_CFGD (1 << 2)
619#define BGP_VRF_RD_CFGD (1 << 3)
23e386ac
MK
620#define BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY (1 << 4)
621
676f83b9 622 /* unique ID for auto derivation of RD for this vrf */
623 uint16_t vrf_rd_id;
624
92708db6 625 /* Automatically derived RD for this VRF */
626 struct prefix_rd vrf_prd_auto;
627
676f83b9 628 /* RD for this VRF */
629 struct prefix_rd vrf_prd;
c581d8b0
MK
630
631 /* import rt list for the vrf instance */
632 struct list *vrf_import_rtl;
633
634 /* export rt list for the vrf instance */
635 struct list *vrf_export_rtl;
fe1dc5a3 636
6a8657d0
MK
637 /* list of corresponding l2vnis (struct bgpevpn) */
638 struct list *l2vnis;
639
53c84f78
MK
640 /* route map for advertise ipv4/ipv6 unicast (type-5 routes) */
641 struct bgp_rmap adv_cmd_rmap[AFI_MAX][SAFI_MAX];
642
e70e9f8e 643 struct vpn_policy vpn_policy[AFI_MAX];
ddb5b488 644
4762c213
PG
645 struct bgp_pbr_config *bgp_pbr_cfg;
646
50f74cf1 647 /* local esi hash table */
648 struct hash *esihash;
649
36dc7588 650 /* Count of peers in established state */
651 uint32_t established_peers;
652
d62a17ae 653 QOBJ_FIELDS
718e3744 654};
19df7279 655DECLARE_QOBJ_TYPE(bgp)
718e3744 656
2b9bcf30
DL
657DECLARE_HOOK(bgp_inst_delete, (struct bgp *bgp), (bgp))
658DECLARE_HOOK(bgp_inst_config_write,
659 (struct bgp *bgp, struct vty *vty),
660 (bgp, vty))
661
cfd47646 662 /* Thread callback information */
663 struct afi_safi_info {
664 afi_t afi;
665 safi_t safi;
666 struct bgp *bgp;
667 };
668
2a3d5731 669#define BGP_ROUTE_ADV_HOLD(bgp) (bgp->main_peers_update_hold)
d889623f 670
d62a17ae 671#define IS_BGP_INST_KNOWN_TO_ZEBRA(bgp) \
672 (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT \
673 || (bgp->inst_type == BGP_INSTANCE_TYPE_VRF \
674 && bgp->vrf_id != VRF_UNKNOWN))
ad4cbda1 675
f009ff26 676#define BGP_SELECT_DEFER_DISABLE(bgp) \
677 (bgp_flag_check(bgp, BGP_FLAG_SELECT_DEFER_DISABLE))
cfd47646 678
718e3744 679/* BGP peer-group support. */
d62a17ae 680struct peer_group {
681 /* Name of the peer-group. */
682 char *name;
718e3744 683
d62a17ae 684 /* Pointer to BGP. */
685 struct bgp *bgp;
718e3744 686
d62a17ae 687 /* Peer-group client list. */
688 struct list *peer;
f14e6fdb 689
d62a17ae 690 /** Dynamic neighbor listening ranges */
691 struct list *listen_range[AFI_MAX];
692
693 /* Peer-group config */
694 struct peer *conf;
718e3744 695};
696
697/* BGP Notify message format. */
d62a17ae 698struct bgp_notify {
d7c0a89a
QY
699 uint8_t code;
700 uint8_t subcode;
d62a17ae 701 char *data;
702 bgp_size_t length;
d7c0a89a 703 uint8_t *raw_data;
718e3744 704};
705
706/* Next hop self address. */
d62a17ae 707struct bgp_nexthop {
708 struct interface *ifp;
709 struct in_addr v4;
710 struct in6_addr v6_global;
711 struct in6_addr v6_local;
718e3744 712};
713
a82478b9
DS
714/* BGP addpath values */
715#define BGP_ADDPATH_RX 1
716#define BGP_ADDPATH_TX 2
717#define BGP_ADDPATH_ID_LEN 4
718
adbac85e
DW
719#define BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE 1
720
3f54c705 721/* Route map direction */
2a3d5731
DW
722#define RMAP_IN 0
723#define RMAP_OUT 1
724#define RMAP_MAX 2
fee0f4c6 725
a0903cd2
DA
726#define BGP_DEFAULT_TTL 1
727
65efcfce
LB
728#include "filter.h"
729
718e3744 730/* BGP filter structure. */
d62a17ae 731struct bgp_filter {
732 /* Distribute-list. */
733 struct {
734 char *name;
735 struct access_list *alist;
736 } dlist[FILTER_MAX];
737
738 /* Prefix-list. */
739 struct {
740 char *name;
741 struct prefix_list *plist;
742 } plist[FILTER_MAX];
743
744 /* Filter-list. */
745 struct {
746 char *name;
747 struct as_list *aslist;
748 } aslist[FILTER_MAX];
749
750 /* Route-map. */
751 struct {
752 char *name;
753 struct route_map *map;
754 } map[RMAP_MAX];
755
756 /* Unsuppress-map. */
757 struct {
758 char *name;
759 struct route_map *map;
760 } usmap;
718e3744 761};
762
6d85b15b
JBD
763/* IBGP/EBGP identifier. We also have a CONFED peer, which is to say,
764 a peer who's AS is part of our Confederation. */
d62a17ae 765typedef enum {
faa16034
DS
766 BGP_PEER_UNSPECIFIED,
767 BGP_PEER_IBGP,
d62a17ae 768 BGP_PEER_EBGP,
769 BGP_PEER_INTERNAL,
770 BGP_PEER_CONFED,
6d85b15b
JBD
771} bgp_peer_sort_t;
772
d6661008
DS
773/* BGP message header and packet size. */
774#define BGP_MARKER_SIZE 16
775#define BGP_HEADER_SIZE 19
776#define BGP_MAX_PACKET_SIZE 4096
0a91ff55 777#define BGP_MAX_PACKET_SIZE_OVERFLOW 1024
d6661008 778
3f9c7369
DS
779/*
780 * Trigger delay for bgp_announce_route().
781 */
782#define BGP_ANNOUNCE_ROUTE_SHORT_DELAY_MS 100
783#define BGP_ANNOUNCE_ROUTE_DELAY_MS 500
784
d62a17ae 785struct peer_af {
786 /* back pointer to the peer */
787 struct peer *peer;
3f9c7369 788
d62a17ae 789 /* which subgroup the peer_af belongs to */
790 struct update_subgroup *subgroup;
3f9c7369 791
d62a17ae 792 /* for being part of an update subgroup's peer list */
793 LIST_ENTRY(peer_af) subgrp_train;
3f9c7369 794
d62a17ae 795 /* for being part of a packet's peer list */
796 LIST_ENTRY(peer_af) pkt_train;
3f9c7369 797
d62a17ae 798 struct bpacket *next_pkt_to_send;
3f9c7369 799
d62a17ae 800 /*
801 * Trigger timer for bgp_announce_route().
802 */
803 struct thread *t_announce_route;
3f9c7369 804
d62a17ae 805 afi_t afi;
806 safi_t safi;
807 int afid;
3f9c7369 808};
b0965c44 809/* BGP GR per peer ds */
810
2ba1fe69 811#define BGP_PEER_GR_MODE 5
812#define BGP_PEER_GR_EVENT_CMD 6
b0965c44 813
814enum peer_mode {
815 PEER_HELPER = 0,
816 PEER_GR,
817 PEER_DISABLE,
818 PEER_INVALID,
819 PEER_GLOBAL_INHERIT /* This is the default mode */
820
821};
822
823enum peer_gr_command {
824 PEER_GR_CMD = 0,
825 NO_PEER_GR_CMD,
2ba1fe69 826 PEER_DISABLE_CMD,
b0965c44 827 NO_PEER_DISABLE_CMD,
828 PEER_HELPER_CMD,
829 NO_PEER_HELPER_CMD
830};
831
832typedef unsigned int (*bgp_peer_gr_action_ptr)(struct peer *, int, int);
833
834struct bgp_peer_gr {
835 enum peer_mode next_state;
836 bgp_peer_gr_action_ptr action_fun;
837};
838
3f9c7369 839
718e3744 840/* BGP neighbor structure. */
d62a17ae 841struct peer {
842 /* BGP structure. */
843 struct bgp *bgp;
844
845 /* reference count, primarily to allow bgp_process'ing of route_node's
846 * to be done after a struct peer is deleted.
847 *
848 * named 'lock' for hysterical reasons within Quagga.
849 */
850 int lock;
851
852 /* BGP peer group. */
853 struct peer_group *group;
854 uint64_t version[AFI_MAX][SAFI_MAX];
855
856 /* BGP peer_af structures, per configured AF on this peer */
857 struct peer_af *peer_af_array[BGP_AF_MAX];
858
859 /* Peer's remote AS number. */
860 int as_type;
861 as_t as;
862
863 /* Peer's local AS number. */
864 as_t local_as;
865
866 bgp_peer_sort_t sort;
867
868 /* Peer's Change local AS number. */
869 as_t change_local_as;
870
871 /* Remote router ID. */
872 struct in_addr remote_id;
873
874 /* Local router ID. */
875 struct in_addr local_id;
876
877 /* Packet receive and send buffer. */
424ab01d
QY
878 pthread_mutex_t io_mtx; // guards ibuf, obuf
879 struct stream_fifo *ibuf; // packets waiting to be processed
880 struct stream_fifo *obuf; // packets waiting to be written
881
74ffbfe6
QY
882 struct ringbuf *ibuf_work; // WiP buffer used by bgp_read() only
883 struct stream *obuf_work; // WiP buffer used to construct packets
424ab01d
QY
884
885 struct stream *curr; // the current packet being parsed
d62a17ae 886
887 /* We use a separate stream to encode MP_REACH_NLRI for efficient
424ab01d 888 * NLRI packing. peer->obuf_work stores all the other attributes. The
d62a17ae 889 * actual packet is then constructed by concatenating the two.
890 */
891 struct stream *scratch;
892
893 /* the doppelganger peer structure, due to dual TCP conn setup */
894 struct peer *doppelganger;
895
896 /* Status of the peer. */
897 int status;
898 int ostatus;
899
900 /* FSM events, stored for debug purposes.
901 * Note: uchar used for reduced memory usage.
902 */
903 unsigned char cur_event;
904 unsigned char last_event;
905 unsigned char last_major_event;
906
907 /* Peer index, used for dumping TABLE_DUMP_V2 format */
908 uint16_t table_dump_index;
909
910 /* Peer information */
911 int fd; /* File descriptor */
912 int ttl; /* TTL of TCP connection to the peer. */
913 int rtt; /* Estimated round-trip-time from TCP_INFO */
914 int gtsm_hops; /* minimum hopcount to peer */
915 char *desc; /* Description of the peer. */
916 unsigned short port; /* Destination port for peer */
917 char *host; /* Printable address of the peer. */
918 union sockunion su; /* Sockunion address of the peer. */
a80beece 919#define BGP_PEER_SU_UNSPEC(peer) (peer->su.sa.sa_family == AF_UNSPEC)
d62a17ae 920 time_t uptime; /* Last Up/Down time */
921 time_t readtime; /* Last read time */
922 time_t resettime; /* Last reset time */
923
d62a17ae 924 char *conf_if; /* neighbor interface config name. */
925 struct interface *ifp; /* corresponding interface */
926 char *ifname; /* bind interface name. */
927 char *update_if;
928 union sockunion *update_source;
929
930 union sockunion *su_local; /* Sockunion of local address. */
931 union sockunion *su_remote; /* Sockunion of remote address. */
932 int shared_network; /* Is this peer shared same network. */
933 struct bgp_nexthop nexthop; /* Nexthop */
934
935 /* Peer address family configuration. */
d7c0a89a
QY
936 uint8_t afc[AFI_MAX][SAFI_MAX];
937 uint8_t afc_nego[AFI_MAX][SAFI_MAX];
938 uint8_t afc_adv[AFI_MAX][SAFI_MAX];
939 uint8_t afc_recv[AFI_MAX][SAFI_MAX];
d62a17ae 940
941 /* Capability flags (reset in bgp_stop) */
d7c0a89a 942 uint32_t cap;
718e3744 943#define PEER_CAP_REFRESH_ADV (1 << 0) /* refresh advertised */
944#define PEER_CAP_REFRESH_OLD_RCV (1 << 1) /* refresh old received */
945#define PEER_CAP_REFRESH_NEW_RCV (1 << 2) /* refresh rfc received */
946#define PEER_CAP_DYNAMIC_ADV (1 << 3) /* dynamic advertised */
947#define PEER_CAP_DYNAMIC_RCV (1 << 4) /* dynamic received */
538621f2 948#define PEER_CAP_RESTART_ADV (1 << 5) /* restart advertised */
949#define PEER_CAP_RESTART_RCV (1 << 6) /* restart received */
0b2aa3a0
PJ
950#define PEER_CAP_AS4_ADV (1 << 7) /* as4 advertised */
951#define PEER_CAP_AS4_RCV (1 << 8) /* as4 received */
fe7d2a48
DS
952#define PEER_CAP_RESTART_BIT_ADV (1 << 9) /* sent restart state */
953#define PEER_CAP_RESTART_BIT_RCV (1 << 10) /* peer restart state */
a82478b9
DS
954#define PEER_CAP_ADDPATH_ADV (1 << 11) /* addpath advertised */
955#define PEER_CAP_ADDPATH_RCV (1 << 12) /* addpath received */
c744aa9f
DS
956#define PEER_CAP_ENHE_ADV (1 << 13) /* Extended nexthop advertised */
957#define PEER_CAP_ENHE_RCV (1 << 14) /* Extended nexthop received */
04b6bdc0
DW
958#define PEER_CAP_HOSTNAME_ADV (1 << 15) /* hostname advertised */
959#define PEER_CAP_HOSTNAME_RCV (1 << 16) /* hostname received */
718e3744 960
d62a17ae 961 /* Capability flags (reset in bgp_stop) */
d7c0a89a 962 uint32_t af_cap[AFI_MAX][SAFI_MAX];
718e3744 963#define PEER_CAP_ORF_PREFIX_SM_ADV (1 << 0) /* send-mode advertised */
964#define PEER_CAP_ORF_PREFIX_RM_ADV (1 << 1) /* receive-mode advertised */
965#define PEER_CAP_ORF_PREFIX_SM_RCV (1 << 2) /* send-mode received */
966#define PEER_CAP_ORF_PREFIX_RM_RCV (1 << 3) /* receive-mode received */
967#define PEER_CAP_ORF_PREFIX_SM_OLD_RCV (1 << 4) /* send-mode received */
968#define PEER_CAP_ORF_PREFIX_RM_OLD_RCV (1 << 5) /* receive-mode received */
93406d87 969#define PEER_CAP_RESTART_AF_RCV (1 << 6) /* graceful restart afi/safi received */
970#define PEER_CAP_RESTART_AF_PRESERVE_RCV (1 << 7) /* graceful restart afi/safi F-bit received */
a82478b9
DS
971#define PEER_CAP_ADDPATH_AF_TX_ADV (1 << 8) /* addpath tx advertised */
972#define PEER_CAP_ADDPATH_AF_TX_RCV (1 << 9) /* addpath tx received */
973#define PEER_CAP_ADDPATH_AF_RX_ADV (1 << 10) /* addpath rx advertised */
974#define PEER_CAP_ADDPATH_AF_RX_RCV (1 << 11) /* addpath rx received */
8a92a8a0
DS
975#define PEER_CAP_ENHE_AF_ADV (1 << 12) /* Extended nexthopi afi/safi advertised */
976#define PEER_CAP_ENHE_AF_RCV (1 << 13) /* Extended nexthop afi/safi received */
977#define PEER_CAP_ENHE_AF_NEGO (1 << 14) /* Extended nexthop afi/safi negotiated */
718e3744 978
d62a17ae 979 /* Global configuration flags. */
9fb964de
PM
980 /*
981 * Parallel array to flags that indicates whether each flag originates
982 * from a peer-group or if it is config that is specific to this
983 * individual peer. If a flag is set independent of the peer-group, the
984 * same bit should be set here. If this peer is a peer-group, this
985 * memory region should be all zeros.
986 *
987 * The assumption is that the default state for all flags is unset,
988 * so if a flag is unset, the corresponding override flag is unset too.
989 * However if a flag is set, the corresponding override flag is set.
990 */
991 uint32_t flags_override;
992 /*
993 * Parallel array to flags that indicates whether the default behavior
994 * of *flags_override* should be inverted. If a flag is unset and the
995 * corresponding invert flag is set, the corresponding override flag
996 * would be set. However if a flag is set and the corresponding invert
997 * flag is unset, the corresponding override flag would be unset.
998 *
999 * This can be used for attributes like *send-community*, which are
1000 * implicitely enabled and have to be disabled explicitely, compared to
1001 * 'normal' attributes like *next-hop-self* which are implicitely set.
1002 *
1003 * All operations dealing with flags should apply the following boolean
1004 * logic to keep the internal flag system in a sane state:
1005 *
1006 * value=0 invert=0 Inherit flag if member, otherwise unset flag
1007 * value=0 invert=1 Unset flag unconditionally
1008 * value=1 invert=0 Set flag unconditionally
1009 * value=1 invert=1 Inherit flag if member, otherwise set flag
1010 *
1011 * Contrary to the implementation of *flags_override*, the flag
1012 * inversion state can be set either on the peer OR the peer *and* the
1013 * peer-group. This was done on purpose, as the inversion state of a
1014 * flag can be determined on either the peer or the peer-group.
1015 *
1016 * Example: Enabling the cisco configuration mode inverts all flags
1017 * related to *send-community* unconditionally for both peer-groups and
1018 * peers.
1019 *
1020 * This behavior is different for interface peers though, which enable
1021 * the *extended-nexthop* flag by default, which regular peers do not.
1022 * As the peer-group can contain both regular and interface peers, the
1023 * flag inversion state must be set on the peer only.
1024 *
1025 * When a peer inherits the configuration from a peer-group and the
1026 * inversion state of the flag differs between peer and peer-group, the
1027 * newly set value must equal to the inverted state of the peer-group.
1028 */
1029 uint32_t flags_invert;
1030 /*
1031 * Effective array for storing the peer/peer-group flags. In case of a
1032 * peer-group, the peer-specific overrides (see flags_override and
1033 * flags_invert) must be respected.
1034 */
d7c0a89a 1035 uint32_t flags;
718e3744 1036#define PEER_FLAG_PASSIVE (1 << 0) /* passive mode */
1037#define PEER_FLAG_SHUTDOWN (1 << 1) /* shutdown */
1038#define PEER_FLAG_DONT_CAPABILITY (1 << 2) /* dont-capability */
1039#define PEER_FLAG_OVERRIDE_CAPABILITY (1 << 3) /* override-capability */
1040#define PEER_FLAG_STRICT_CAP_MATCH (1 << 4) /* strict-match */
c9502438 1041#define PEER_FLAG_DYNAMIC_CAPABILITY (1 << 5) /* dynamic capability */
6ffd2079 1042#define PEER_FLAG_DISABLE_CONNECTED_CHECK (1 << 6) /* disable-connected-check */
c9502438 1043#define PEER_FLAG_LOCAL_AS_NO_PREPEND (1 << 7) /* local-as no-prepend */
9d3f9705 1044#define PEER_FLAG_LOCAL_AS_REPLACE_AS (1 << 8) /* local-as no-prepend replace-as */
47cbc09b
PM
1045#define PEER_FLAG_DELETE (1 << 9) /* mark the peer for deleting */
1046#define PEER_FLAG_CONFIG_NODE (1 << 10) /* the node to update configs on */
7f342629
DS
1047#define PEER_FLAG_LONESOUL (1 << 11)
1048#define PEER_FLAG_DYNAMIC_NEIGHBOR (1 << 12) /* dynamic neighbor */
1049#define PEER_FLAG_CAPABILITY_ENHE (1 << 13) /* Extended next-hop (rfc 5549)*/
88177fe3 1050#define PEER_FLAG_IFPEER_V6ONLY (1 << 14) /* if-based peer is v6 only */
47cbc09b
PM
1051#define PEER_FLAG_IS_RFAPI_HD (1 << 15) /* attached to rfapi HD */
1052#define PEER_FLAG_ENFORCE_FIRST_AS (1 << 16) /* enforce-first-as */
b90a8e13
PM
1053#define PEER_FLAG_ROUTEADV (1 << 17) /* route advertise */
1054#define PEER_FLAG_TIMER (1 << 18) /* keepalive & holdtime */
1055#define PEER_FLAG_TIMER_CONNECT (1 << 19) /* connect timer */
a14810f4
PM
1056#define PEER_FLAG_PASSWORD (1 << 20) /* password */
1057#define PEER_FLAG_LOCAL_AS (1 << 21) /* local-as */
1058#define PEER_FLAG_UPDATE_SOURCE (1 << 22) /* update-source */
02a82b47 1059
b0965c44 1060 /* BGP-GR Peer related flags */
1061#define PEER_FLAG_GRACEFUL_RESTART_HELPER (1 << 23) /* Helper */
1062#define PEER_FLAG_GRACEFUL_RESTART (1 << 24) /* Graceful Restart */
1063#define PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT (1 << 25) /* Global-Inherit */
1064
1065 /*
1066 *GR-Disabled mode means unset PEER_FLAG_GRACEFUL_RESTART
1067 *& PEER_FLAG_GRACEFUL_RESTART_HELPER
1068 *and PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT
1069 */
1070
2ba1fe69 1071 struct bgp_peer_gr PEER_GR_FSM[BGP_PEER_GR_MODE][BGP_PEER_GR_EVENT_CMD];
b0965c44 1072 enum peer_mode peer_gr_present_state;
1073 /* Non stop forwarding afi-safi count for BGP gr feature*/
1074 uint8_t nsf_af_count;
1075
1076 uint8_t peer_gr_new_status_flag;
1077#define PEER_GRACEFUL_RESTART_NEW_STATE_HELPER (1 << 0)
1078#define PEER_GRACEFUL_RESTART_NEW_STATE_RESTART (1 << 1)
794b37d5 1079#define PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT (1 << 2)
b0965c44 1080
d62a17ae 1081 /* outgoing message sent in CEASE_ADMIN_SHUTDOWN notify */
1082 char *tx_shutdown_message;
718e3744 1083
d62a17ae 1084 /* NSF mode (graceful restart) */
d7c0a89a 1085 uint8_t nsf[AFI_MAX][SAFI_MAX];
9e3b51a7 1086 /* EOR Send time */
1087 time_t eor_stime[AFI_MAX][SAFI_MAX];
1088 /* Last update packet sent time */
1089 time_t pkt_stime[AFI_MAX][SAFI_MAX];
93406d87 1090
04e1c5bb
QY
1091 /* Peer Per AF flags */
1092 /*
9fb964de
PM
1093 * Please consult the comments for *flags_override*, *flags_invert* and
1094 * *flags* to understand what these three arrays do. The address-family
1095 * specific attributes are being treated the exact same way as global
1096 * peer attributes.
04e1c5bb
QY
1097 */
1098 uint32_t af_flags_override[AFI_MAX][SAFI_MAX];
27c05d4d 1099 uint32_t af_flags_invert[AFI_MAX][SAFI_MAX];
d7c0a89a 1100 uint32_t af_flags[AFI_MAX][SAFI_MAX];
718e3744 1101#define PEER_FLAG_SEND_COMMUNITY (1 << 0) /* send-community */
1102#define PEER_FLAG_SEND_EXT_COMMUNITY (1 << 1) /* send-community ext. */
1103#define PEER_FLAG_NEXTHOP_SELF (1 << 2) /* next-hop-self */
1104#define PEER_FLAG_REFLECTOR_CLIENT (1 << 3) /* reflector-client */
1105#define PEER_FLAG_RSERVER_CLIENT (1 << 4) /* route-server-client */
1106#define PEER_FLAG_SOFT_RECONFIG (1 << 5) /* soft-reconfiguration */
1107#define PEER_FLAG_AS_PATH_UNCHANGED (1 << 6) /* transparent-as */
1108#define PEER_FLAG_NEXTHOP_UNCHANGED (1 << 7) /* transparent-next-hop */
1109#define PEER_FLAG_MED_UNCHANGED (1 << 8) /* transparent-next-hop */
1110#define PEER_FLAG_DEFAULT_ORIGINATE (1 << 9) /* default-originate */
1111#define PEER_FLAG_REMOVE_PRIVATE_AS (1 << 10) /* remove-private-as */
1112#define PEER_FLAG_ALLOWAS_IN (1 << 11) /* set allowas-in */
794b37d5 1113#define PEER_FLAG_ORF_PREFIX_SM (1 << 12) /* orf capability send-mode */
718e3744 1114#define PEER_FLAG_ORF_PREFIX_RM (1 << 13) /* orf capability receive-mode */
1115#define PEER_FLAG_MAX_PREFIX (1 << 14) /* maximum prefix */
1116#define PEER_FLAG_MAX_PREFIX_WARNING (1 << 15) /* maximum prefix warning-only */
0df7c91f 1117#define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED (1 << 16) /* leave link-local nexthop unchanged */
a538debe 1118#define PEER_FLAG_FORCE_NEXTHOP_SELF (1 << 17) /* next-hop-self force */
5000f21c
DS
1119#define PEER_FLAG_REMOVE_PRIVATE_AS_ALL (1 << 18) /* remove-private-as all */
1120#define PEER_FLAG_REMOVE_PRIVATE_AS_REPLACE (1 << 19) /* remove-private-as replace-as */
c7122e14 1121#define PEER_FLAG_AS_OVERRIDE (1 << 20) /* as-override */
88b8ed8d 1122#define PEER_FLAG_REMOVE_PRIVATE_AS_ALL_REPLACE (1 << 21) /* remove-private-as all replace-as */
d93f7ffc 1123#define PEER_FLAG_WEIGHT (1 << 24) /* weight */
aac9ef6c 1124#define PEER_FLAG_ALLOWAS_IN_ORIGIN (1 << 25) /* allowas-in origin */
57d187bc 1125#define PEER_FLAG_SEND_LARGE_COMMUNITY (1 << 26) /* Send large Communities */
fde246e8 1126#define PEER_FLAG_MAX_PREFIX_OUT (1 << 27) /* outgoing maximum prefix */
0df7c91f 1127
dcc68b5e
MS
1128 enum bgp_addpath_strat addpath_type[AFI_MAX][SAFI_MAX];
1129
d62a17ae 1130 /* MD5 password */
1131 char *password;
718e3744 1132
d62a17ae 1133 /* default-originate route-map. */
1134 struct {
1135 char *name;
1136 struct route_map *map;
1137 } default_rmap[AFI_MAX][SAFI_MAX];
718e3744 1138
d62a17ae 1139 /* Peer status flags. */
d7c0a89a 1140 uint16_t sflags;
718e3744 1141#define PEER_STATUS_ACCEPT_PEER (1 << 0) /* accept peer */
1142#define PEER_STATUS_PREFIX_OVERFLOW (1 << 1) /* prefix-overflow */
1143#define PEER_STATUS_CAPABILITY_OPEN (1 << 2) /* capability open send */
1144#define PEER_STATUS_HAVE_ACCEPT (1 << 3) /* accept peer's parent */
1145#define PEER_STATUS_GROUP (1 << 4) /* peer-group conf */
93406d87 1146#define PEER_STATUS_NSF_MODE (1 << 5) /* NSF aware peer */
1147#define PEER_STATUS_NSF_WAIT (1 << 6) /* wait comeback peer */
718e3744 1148
d62a17ae 1149 /* Peer status af flags (reset in bgp_stop) */
d7c0a89a 1150 uint16_t af_sflags[AFI_MAX][SAFI_MAX];
718e3744 1151#define PEER_STATUS_ORF_PREFIX_SEND (1 << 0) /* prefix-list send peer */
1152#define PEER_STATUS_ORF_WAIT_REFRESH (1 << 1) /* wait refresh received peer */
840fced9
DS
1153#define PEER_STATUS_PREFIX_THRESHOLD (1 << 2) /* exceed prefix-threshold */
1154#define PEER_STATUS_PREFIX_LIMIT (1 << 3) /* exceed prefix-limit */
1155#define PEER_STATUS_EOR_SEND (1 << 4) /* end-of-rib send to peer */
1156#define PEER_STATUS_EOR_RECEIVED (1 << 5) /* end-of-rib received from peer */
e0701b79 1157
b90a8e13 1158 /* Configured timer values. */
1588f6f4
QY
1159 _Atomic uint32_t holdtime;
1160 _Atomic uint32_t keepalive;
1161 _Atomic uint32_t connect;
1162 _Atomic uint32_t routeadv;
d62a17ae 1163
1164 /* Timer values. */
1588f6f4
QY
1165 _Atomic uint32_t v_start;
1166 _Atomic uint32_t v_connect;
1167 _Atomic uint32_t v_holdtime;
1168 _Atomic uint32_t v_keepalive;
1169 _Atomic uint32_t v_routeadv;
1170 _Atomic uint32_t v_pmax_restart;
1171 _Atomic uint32_t v_gr_restart;
d62a17ae 1172
1173 /* Threads. */
1174 struct thread *t_read;
424ab01d 1175 struct thread *t_write;
d62a17ae 1176 struct thread *t_start;
387f984e
QY
1177 struct thread *t_connect_check_r;
1178 struct thread *t_connect_check_w;
d62a17ae 1179 struct thread *t_connect;
1180 struct thread *t_holdtime;
d62a17ae 1181 struct thread *t_routeadv;
1182 struct thread *t_pmax_restart;
1183 struct thread *t_gr_restart;
1184 struct thread *t_gr_stale;
56257a44 1185 struct thread *t_generate_updgrp_packets;
424ab01d 1186 struct thread *t_process_packet;
d62a17ae 1187
49507a6f 1188 /* Thread flags. */
0545c373 1189 _Atomic uint32_t thread_flags;
b750b0ba
QY
1190#define PEER_THREAD_WRITES_ON (1 << 0)
1191#define PEER_THREAD_READS_ON (1 << 1)
1192#define PEER_THREAD_KEEPALIVES_ON (1 << 2)
d62a17ae 1193 /* workqueues */
1194 struct work_queue *clear_node_queue;
1195
a4d82a8a
PZ
1196#define PEER_TOTAL_RX(peer) \
1197 atomic_load_explicit(&peer->open_in, memory_order_relaxed) \
1198 + atomic_load_explicit(&peer->update_in, memory_order_relaxed) \
1199 + atomic_load_explicit(&peer->notify_in, memory_order_relaxed) \
1200 + atomic_load_explicit(&peer->refresh_in, \
1201 memory_order_relaxed) \
1202 + atomic_load_explicit(&peer->keepalive_in, \
1203 memory_order_relaxed) \
1204 + atomic_load_explicit(&peer->dynamic_cap_in, \
1205 memory_order_relaxed)
1206
1207#define PEER_TOTAL_TX(peer) \
1208 atomic_load_explicit(&peer->open_out, memory_order_relaxed) \
1209 + atomic_load_explicit(&peer->update_out, \
1210 memory_order_relaxed) \
1211 + atomic_load_explicit(&peer->notify_out, \
1212 memory_order_relaxed) \
1213 + atomic_load_explicit(&peer->refresh_out, \
1214 memory_order_relaxed) \
1215 + atomic_load_explicit(&peer->keepalive_out, \
1216 memory_order_relaxed) \
1217 + atomic_load_explicit(&peer->dynamic_cap_out, \
1218 memory_order_relaxed)
0112e9e0 1219
d62a17ae 1220 /* Statistics field */
996c9314
LB
1221 _Atomic uint32_t open_in; /* Open message input count */
1222 _Atomic uint32_t open_out; /* Open message output count */
1588f6f4
QY
1223 _Atomic uint32_t update_in; /* Update message input count */
1224 _Atomic uint32_t update_out; /* Update message ouput count */
1225 _Atomic time_t update_time; /* Update message received time. */
1226 _Atomic uint32_t keepalive_in; /* Keepalive input count */
1227 _Atomic uint32_t keepalive_out; /* Keepalive output count */
1228 _Atomic uint32_t notify_in; /* Notify input count */
1229 _Atomic uint32_t notify_out; /* Notify output count */
1230 _Atomic uint32_t refresh_in; /* Route Refresh input count */
1231 _Atomic uint32_t refresh_out; /* Route Refresh output count */
1232 _Atomic uint32_t dynamic_cap_in; /* Dynamic Capability input count. */
a4d82a8a 1233 _Atomic uint32_t dynamic_cap_out; /* Dynamic Capability output count. */
d62a17ae 1234
b4d46cc9
DL
1235 uint32_t stat_pfx_filter;
1236 uint32_t stat_pfx_aspath_loop;
1237 uint32_t stat_pfx_originator_loop;
1238 uint32_t stat_pfx_cluster_loop;
1239 uint32_t stat_pfx_nh_invalid;
1240 uint32_t stat_pfx_dup_withdraw;
1241 uint32_t stat_upd_7606; /* RFC7606: treat-as-withdraw */
1242
d62a17ae 1243 /* BGP state count */
d7c0a89a
QY
1244 uint32_t established; /* Established */
1245 uint32_t dropped; /* Dropped */
d62a17ae 1246
1247 /* Update delay related fields */
d7c0a89a 1248 uint8_t update_delay_over; /* When this is set, BGP is no more waiting
d62a17ae 1249 for EOR */
1250
1251 /* Syncronization list and time. */
1252 struct bgp_synchronize *sync[AFI_MAX][SAFI_MAX];
1253 time_t synctime;
1588f6f4
QY
1254 /* timestamp when the last UPDATE msg was written */
1255 _Atomic time_t last_write;
1256 /* timestamp when the last msg was written */
1257 _Atomic time_t last_update;
d62a17ae 1258
d62a17ae 1259 /* Notify data. */
1260 struct bgp_notify notify;
1261
d62a17ae 1262 /* Filter structure. */
1263 struct bgp_filter filter[AFI_MAX][SAFI_MAX];
1264
70ee29b4
PM
1265 /*
1266 * Parallel array to filter that indicates whether each filter
1267 * originates from a peer-group or if it is config that is specific to
1268 * this individual peer. If a filter is set independent of the
1269 * peer-group the appropriate bit should be set here. If this peer is a
1270 * peer-group, this memory region should be all zeros. The assumption
1271 * is that the default state for all flags is unset. Due to filters
1272 * having a direction (e.g. in/out/...), this array has a third
1273 * dimension for storing the overrides independently per direction.
1274 *
1275 * Notes:
1276 * - if a filter for an individual peer is unset, the corresponding
1277 * override flag is unset and the peer is considered to be back in
1278 * sync with the peer-group.
1279 * - This does *not* contain the filter values, rather it contains
1280 * whether the filter in filter (struct bgp_filter) is peer-specific.
1281 */
1282 uint8_t filter_override[AFI_MAX][SAFI_MAX][(FILTER_MAX > RMAP_MAX)
1283 ? FILTER_MAX
1284 : RMAP_MAX];
1285#define PEER_FT_DISTRIBUTE_LIST (1 << 0) /* distribute-list */
1286#define PEER_FT_FILTER_LIST (1 << 1) /* filter-list */
1287#define PEER_FT_PREFIX_LIST (1 << 2) /* prefix-list */
1288#define PEER_FT_ROUTE_MAP (1 << 3) /* route-map */
1289#define PEER_FT_UNSUPPRESS_MAP (1 << 4) /* unsuppress-map */
1290
d62a17ae 1291 /* ORF Prefix-list */
1292 struct prefix_list *orf_plist[AFI_MAX][SAFI_MAX];
1293
1294 /* Text description of last attribute rcvd */
1295 char rcvd_attr_str[BUFSIZ];
1296
1297 /* Track if we printed the attribute in debugs */
1298 int rcvd_attr_printed;
1299
1300 /* Prefix count. */
a0a87037 1301 uint32_t pcount[AFI_MAX][SAFI_MAX];
d62a17ae 1302
1303 /* Max prefix count. */
a0a87037 1304 uint32_t pmax[AFI_MAX][SAFI_MAX];
d7c0a89a
QY
1305 uint8_t pmax_threshold[AFI_MAX][SAFI_MAX];
1306 uint16_t pmax_restart[AFI_MAX][SAFI_MAX];
e0701b79 1307#define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
718e3744 1308
fde246e8
DA
1309 /* Send prefix count. */
1310 uint32_t pmax_out[AFI_MAX][SAFI_MAX];
1311
d62a17ae 1312 /* allowas-in. */
1313 char allowas_in[AFI_MAX][SAFI_MAX];
ac41b2a2 1314
d62a17ae 1315 /* weight */
1316 unsigned long weight[AFI_MAX][SAFI_MAX];
d93f7ffc 1317
d62a17ae 1318 /* peer reset cause */
1a1f4534 1319 uint8_t last_reset;
e0701b79 1320#define PEER_DOWN_RID_CHANGE 1 /* bgp router-id command */
1321#define PEER_DOWN_REMOTE_AS_CHANGE 2 /* neighbor remote-as command */
1322#define PEER_DOWN_LOCAL_AS_CHANGE 3 /* neighbor local-as command */
1323#define PEER_DOWN_CLID_CHANGE 4 /* bgp cluster-id command */
1324#define PEER_DOWN_CONFED_ID_CHANGE 5 /* bgp confederation identifier command */
1325#define PEER_DOWN_CONFED_PEER_CHANGE 6 /* bgp confederation peer command */
1326#define PEER_DOWN_RR_CLIENT_CHANGE 7 /* neighbor route-reflector-client command */
1327#define PEER_DOWN_RS_CLIENT_CHANGE 8 /* neighbor route-server-client command */
1328#define PEER_DOWN_UPDATE_SOURCE_CHANGE 9 /* neighbor update-source command */
1329#define PEER_DOWN_AF_ACTIVATE 10 /* neighbor activate command */
1330#define PEER_DOWN_USER_SHUTDOWN 11 /* neighbor shutdown command */
1331#define PEER_DOWN_USER_RESET 12 /* clear ip bgp command */
1332#define PEER_DOWN_NOTIFY_RECEIVED 13 /* notification received */
1333#define PEER_DOWN_NOTIFY_SEND 14 /* notification send */
1334#define PEER_DOWN_CLOSE_SESSION 15 /* tcp session close */
1335#define PEER_DOWN_NEIGHBOR_DELETE 16 /* neghbor delete */
1336#define PEER_DOWN_RMAP_BIND 17 /* neghbor peer-group command */
1337#define PEER_DOWN_RMAP_UNBIND 18 /* no neighbor peer-group command */
1338#define PEER_DOWN_CAPABILITY_CHANGE 19 /* neighbor capability command */
1339#define PEER_DOWN_PASSIVE_CHANGE 20 /* neighbor passive command */
1340#define PEER_DOWN_MULTIHOP_CHANGE 21 /* neighbor multihop command */
93406d87 1341#define PEER_DOWN_NSF_CLOSE_SESSION 22 /* NSF tcp session close */
8ffedcea 1342#define PEER_DOWN_V6ONLY_CHANGE 23 /* if-based peering v6only toggled */
7bbc6864 1343#define PEER_DOWN_BFD_DOWN 24 /* BFD down */
e60480bd
DD
1344#define PEER_DOWN_IF_DOWN 25 /* Interface down */
1345#define PEER_DOWN_NBR_ADDR_DEL 26 /* Peer address lost */
3577f1c5
DD
1346#define PEER_DOWN_WAITING_NHT 27 /* Waiting for NHT to resolve */
1347#define PEER_DOWN_NBR_ADDR 28 /* Waiting for peer IPv6 IP Addr */
1348#define PEER_DOWN_VRF_UNINIT 29 /* Associated VRF is not init yet */
05912a17 1349#define PEER_DOWN_NOAFI_ACTIVATED 30 /* No AFI/SAFI activated for peer */
fb29348a 1350#define PEER_DOWN_AS_SETS_REJECT 31 /* Reject routes with AS_SET */
1a1f4534 1351 size_t last_reset_cause_size;
d7c0a89a 1352 uint8_t last_reset_cause[BGP_MAX_PACKET_SIZE];
e0701b79 1353
d62a17ae 1354 /* The kind of route-map Flags.*/
a3116965 1355 uint16_t rmap_type;
ac41b2a2 1356#define PEER_RMAP_TYPE_IN (1 << 0) /* neighbor route-map in */
1357#define PEER_RMAP_TYPE_OUT (1 << 1) /* neighbor route-map out */
1358#define PEER_RMAP_TYPE_NETWORK (1 << 2) /* network route-map */
1359#define PEER_RMAP_TYPE_REDISTRIBUTE (1 << 3) /* redistribute route-map */
1360#define PEER_RMAP_TYPE_DEFAULT (1 << 4) /* default-originate route-map */
1361#define PEER_RMAP_TYPE_NOSET (1 << 5) /* not allow to set commands */
fee0f4c6 1362#define PEER_RMAP_TYPE_IMPORT (1 << 6) /* neighbor route-map import */
1363#define PEER_RMAP_TYPE_EXPORT (1 << 7) /* neighbor route-map export */
20894f50 1364#define PEER_RMAP_TYPE_AGGREGATE (1 << 8) /* aggregate-address route-map */
6410e93a 1365
d62a17ae 1366 /* peer specific BFD information */
1367 struct bfd_info *bfd_info;
04b6bdc0 1368
d62a17ae 1369 /* hostname and domainname advertised by host */
1370 char *hostname;
1371 char *domainname;
19df7279 1372
2b31007c
RZ
1373 /* Sender side AS path loop detection. */
1374 bool as_path_loop_detection;
1375
d62a17ae 1376 QOBJ_FIELDS
718e3744 1377};
19df7279 1378DECLARE_QOBJ_TYPE(peer)
718e3744 1379
598ce6bd 1380/* Inherit peer attribute from peer-group. */
e7103a96
PM
1381#define PEER_ATTR_INHERIT(peer, group, attr) \
1382 ((peer)->attr = (group)->conf->attr)
1383#define PEER_STR_ATTR_INHERIT(peer, group, attr, mt) \
598ce6bd
PM
1384 do { \
1385 if ((peer)->attr) \
1386 XFREE(mt, (peer)->attr); \
e7103a96
PM
1387 if ((group)->conf->attr) \
1388 (peer)->attr = XSTRDUP(mt, (group)->conf->attr); \
598ce6bd
PM
1389 else \
1390 (peer)->attr = NULL; \
1391 } while (0)
a14810f4
PM
1392#define PEER_SU_ATTR_INHERIT(peer, group, attr) \
1393 do { \
1394 if ((peer)->attr) \
1395 sockunion_free((peer)->attr); \
1396 if ((group)->conf->attr) \
1397 (peer)->attr = sockunion_dup((group)->conf->attr); \
1398 else \
1399 (peer)->attr = NULL; \
1400 } while (0)
598ce6bd 1401
ad4cbda1 1402/* Check if suppress start/restart of sessions to peer. */
d62a17ae 1403#define BGP_PEER_START_SUPPRESSED(P) \
1404 (CHECK_FLAG((P)->flags, PEER_FLAG_SHUTDOWN) \
1405 || CHECK_FLAG((P)->sflags, PEER_STATUS_PREFIX_OVERFLOW))
ad4cbda1 1406
0df7c91f
PJ
1407#define PEER_PASSWORD_MINLEN (1)
1408#define PEER_PASSWORD_MAXLEN (80)
1409
718e3744 1410/* This structure's member directly points incoming packet data
1411 stream. */
d62a17ae 1412struct bgp_nlri {
1413 /* AFI. */
a46a2e9b 1414 uint16_t afi; /* iana_afi_t */
718e3744 1415
d62a17ae 1416 /* SAFI. */
a46a2e9b 1417 uint8_t safi; /* iana_safi_t */
718e3744 1418
d62a17ae 1419 /* Pointer to NLRI byte stream. */
d7c0a89a 1420 uint8_t *nlri;
718e3744 1421
d62a17ae 1422 /* Length of whole NLRI. */
1423 bgp_size_t length;
718e3744 1424};
1425
1426/* BGP versions. */
1427#define BGP_VERSION_4 4
718e3744 1428
1429/* Default BGP port number. */
1430#define BGP_PORT_DEFAULT 179
1431
718e3744 1432/* BGP minimum message size. */
1433#define BGP_MSG_OPEN_MIN_SIZE (BGP_HEADER_SIZE + 10)
1434#define BGP_MSG_UPDATE_MIN_SIZE (BGP_HEADER_SIZE + 4)
1435#define BGP_MSG_NOTIFY_MIN_SIZE (BGP_HEADER_SIZE + 2)
1436#define BGP_MSG_KEEPALIVE_MIN_SIZE (BGP_HEADER_SIZE + 0)
1437#define BGP_MSG_ROUTE_REFRESH_MIN_SIZE (BGP_HEADER_SIZE + 4)
1438#define BGP_MSG_CAPABILITY_MIN_SIZE (BGP_HEADER_SIZE + 3)
1439
1440/* BGP message types. */
1441#define BGP_MSG_OPEN 1
1442#define BGP_MSG_UPDATE 2
1443#define BGP_MSG_NOTIFY 3
1444#define BGP_MSG_KEEPALIVE 4
1445#define BGP_MSG_ROUTE_REFRESH_NEW 5
1446#define BGP_MSG_CAPABILITY 6
1447#define BGP_MSG_ROUTE_REFRESH_OLD 128
1448
1449/* BGP open optional parameter. */
1450#define BGP_OPEN_OPT_AUTH 1
1451#define BGP_OPEN_OPT_CAP 2
1452
1453/* BGP4 attribute type codes. */
1454#define BGP_ATTR_ORIGIN 1
1455#define BGP_ATTR_AS_PATH 2
1456#define BGP_ATTR_NEXT_HOP 3
1457#define BGP_ATTR_MULTI_EXIT_DISC 4
1458#define BGP_ATTR_LOCAL_PREF 5
1459#define BGP_ATTR_ATOMIC_AGGREGATE 6
1460#define BGP_ATTR_AGGREGATOR 7
1461#define BGP_ATTR_COMMUNITIES 8
1462#define BGP_ATTR_ORIGINATOR_ID 9
1463#define BGP_ATTR_CLUSTER_LIST 10
1464#define BGP_ATTR_DPA 11
1465#define BGP_ATTR_ADVERTISER 12
1466#define BGP_ATTR_RCID_PATH 13
1467#define BGP_ATTR_MP_REACH_NLRI 14
1468#define BGP_ATTR_MP_UNREACH_NLRI 15
1469#define BGP_ATTR_EXT_COMMUNITIES 16
0b2aa3a0
PJ
1470#define BGP_ATTR_AS4_PATH 17
1471#define BGP_ATTR_AS4_AGGREGATOR 18
41367172 1472#define BGP_ATTR_AS_PATHLIMIT 21
a21bd7a3 1473#define BGP_ATTR_PMSI_TUNNEL 22
f4c89855 1474#define BGP_ATTR_ENCAP 23
57d187bc 1475#define BGP_ATTR_LARGE_COMMUNITIES 32
c5a543b4 1476#define BGP_ATTR_PREFIX_SID 40
943d595a 1477#if ENABLE_BGP_VNC_ATTR
65efcfce
LB
1478#define BGP_ATTR_VNC 255
1479#endif
718e3744 1480
1481/* BGP update origin. */
1482#define BGP_ORIGIN_IGP 0
1483#define BGP_ORIGIN_EGP 1
1484#define BGP_ORIGIN_INCOMPLETE 2
1485
1486/* BGP notify message codes. */
1487#define BGP_NOTIFY_HEADER_ERR 1
1488#define BGP_NOTIFY_OPEN_ERR 2
1489#define BGP_NOTIFY_UPDATE_ERR 3
1490#define BGP_NOTIFY_HOLD_ERR 4
1491#define BGP_NOTIFY_FSM_ERR 5
1492#define BGP_NOTIFY_CEASE 6
1493#define BGP_NOTIFY_CAPABILITY_ERR 7
718e3744 1494
4b4e07d2
DT
1495#define BGP_NOTIFY_SUBCODE_UNSPECIFIC 0
1496
718e3744 1497/* BGP_NOTIFY_HEADER_ERR sub codes. */
1498#define BGP_NOTIFY_HEADER_NOT_SYNC 1
1499#define BGP_NOTIFY_HEADER_BAD_MESLEN 2
1500#define BGP_NOTIFY_HEADER_BAD_MESTYPE 3
718e3744 1501
1502/* BGP_NOTIFY_OPEN_ERR sub codes. */
14051b36 1503#define BGP_NOTIFY_OPEN_MALFORMED_ATTR 0
718e3744 1504#define BGP_NOTIFY_OPEN_UNSUP_VERSION 1
1505#define BGP_NOTIFY_OPEN_BAD_PEER_AS 2
1506#define BGP_NOTIFY_OPEN_BAD_BGP_IDENT 3
1507#define BGP_NOTIFY_OPEN_UNSUP_PARAM 4
1508#define BGP_NOTIFY_OPEN_AUTH_FAILURE 5
1509#define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME 6
1510#define BGP_NOTIFY_OPEN_UNSUP_CAPBL 7
718e3744 1511
1512/* BGP_NOTIFY_UPDATE_ERR sub codes. */
1513#define BGP_NOTIFY_UPDATE_MAL_ATTR 1
1514#define BGP_NOTIFY_UPDATE_UNREC_ATTR 2
1515#define BGP_NOTIFY_UPDATE_MISS_ATTR 3
1516#define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR 4
1517#define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR 5
1518#define BGP_NOTIFY_UPDATE_INVAL_ORIGIN 6
1519#define BGP_NOTIFY_UPDATE_AS_ROUTE_LOOP 7
1520#define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP 8
1521#define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR 9
1522#define BGP_NOTIFY_UPDATE_INVAL_NETWORK 10
1523#define BGP_NOTIFY_UPDATE_MAL_AS_PATH 11
718e3744 1524
4b4e07d2 1525/* BGP_NOTIFY_CEASE sub codes (RFC 4486). */
718e3744 1526#define BGP_NOTIFY_CEASE_MAX_PREFIX 1
1527#define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN 2
1528#define BGP_NOTIFY_CEASE_PEER_UNCONFIG 3
1529#define BGP_NOTIFY_CEASE_ADMIN_RESET 4
1530#define BGP_NOTIFY_CEASE_CONNECT_REJECT 5
1531#define BGP_NOTIFY_CEASE_CONFIG_CHANGE 6
545acafb 1532#define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION 7
1533#define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE 8
718e3744 1534
1535/* BGP_NOTIFY_CAPABILITY_ERR sub codes (draft-ietf-idr-dynamic-cap-02). */
1536#define BGP_NOTIFY_CAPABILITY_INVALID_ACTION 1
1537#define BGP_NOTIFY_CAPABILITY_INVALID_LENGTH 2
1538#define BGP_NOTIFY_CAPABILITY_MALFORMED_CODE 3
718e3744 1539
1540/* BGP finite state machine status. */
1541#define Idle 1
1542#define Connect 2
1543#define Active 3
1544#define OpenSent 4
1545#define OpenConfirm 5
1546#define Established 6
ca058a30
PJ
1547#define Clearing 7
1548#define Deleted 8
1549#define BGP_STATUS_MAX 9
718e3744 1550
1551/* BGP finite state machine events. */
1552#define BGP_Start 1
1553#define BGP_Stop 2
1554#define TCP_connection_open 3
1555#define TCP_connection_closed 4
1556#define TCP_connection_open_failed 5
1557#define TCP_fatal_error 6
1558#define ConnectRetry_timer_expired 7
1559#define Hold_Timer_expired 8
1560#define KeepAlive_timer_expired 9
1561#define Receive_OPEN_message 10
1562#define Receive_KEEPALIVE_message 11
1563#define Receive_UPDATE_message 12
1564#define Receive_NOTIFICATION_message 13
ca058a30
PJ
1565#define Clearing_Completed 14
1566#define BGP_EVENTS_MAX 15
718e3744 1567
1568/* BGP timers default value. */
5ca5f1c8 1569#define BGP_INIT_START_TIMER 1
5d5393b9
DL
1570/* The following 3 are RFC defaults that are overridden in bgp_vty.c with
1571 * version-/profile-specific values. The values here do not matter, they only
1572 * exist to provide a clear layering separation between core and CLI.
1573 */
1574#define BGP_DEFAULT_HOLDTIME 180
1575#define BGP_DEFAULT_KEEPALIVE 60
1576#define BGP_DEFAULT_CONNECT_RETRY 120
1577
12179ba3 1578#define BGP_DEFAULT_EBGP_ROUTEADV 0
1670355a 1579#define BGP_DEFAULT_IBGP_ROUTEADV 0
718e3744 1580
1581/* BGP default local preference. */
1582#define BGP_DEFAULT_LOCAL_PREF 100
1583
7f323236
DW
1584/* BGP local-preference to send when 'bgp graceful-shutdown'
1585 * is configured */
1586#define BGP_GSHUT_LOCAL_PREF 0
1587
3f9c7369
DS
1588/* BGP default subgroup packet queue max . */
1589#define BGP_DEFAULT_SUBGROUP_PKT_QUEUE_MAX 40
1590
538621f2 1591/* BGP graceful restart */
1592#define BGP_DEFAULT_RESTART_TIME 120
1593#define BGP_DEFAULT_STALEPATH_TIME 360
cfd47646 1594#define BGP_DEFAULT_SELECT_DEFERRAL_TIME 360
2d3dd828 1595#define BGP_DEFAULT_RIB_STALE_TIME 500
538621f2 1596
718e3744 1597/* BGP uptime string length. */
1598#define BGP_UPTIME_LEN 25
1599
1600/* Default configuration settings for bgpd. */
1601#define BGP_VTY_PORT 2605
718e3744 1602#define BGP_DEFAULT_CONFIG "bgpd.conf"
1603
f14e6fdb
DS
1604/* BGP Dynamic Neighbors feature */
1605#define BGP_DYNAMIC_NEIGHBORS_LIMIT_DEFAULT 100
1606#define BGP_DYNAMIC_NEIGHBORS_LIMIT_MIN 1
1607#define BGP_DYNAMIC_NEIGHBORS_LIMIT_MAX 5000
1608
718e3744 1609/* Flag for peer_clear_soft(). */
d62a17ae 1610enum bgp_clear_type {
1611 BGP_CLEAR_SOFT_NONE,
1612 BGP_CLEAR_SOFT_OUT,
1613 BGP_CLEAR_SOFT_IN,
1614 BGP_CLEAR_SOFT_BOTH,
1615 BGP_CLEAR_SOFT_IN_ORF_PREFIX
718e3744 1616};
1617
1618/* Macros. */
424ab01d 1619#define BGP_INPUT(P) ((P)->curr)
2d34fb80 1620#define BGP_INPUT_PNT(P) (stream_pnt(BGP_INPUT(P)))
d62a17ae 1621#define BGP_IS_VALID_STATE_FOR_NOTIF(S) \
1622 (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
718e3744 1623
718e3744 1624/* BGP error codes. */
1625#define BGP_SUCCESS 0
5d5393b9 1626#define BGP_CREATED 1
718e3744 1627#define BGP_ERR_INVALID_VALUE -1
1628#define BGP_ERR_INVALID_FLAG -2
1629#define BGP_ERR_INVALID_AS -3
1630#define BGP_ERR_INVALID_BGP -4
1631#define BGP_ERR_PEER_GROUP_MEMBER -5
c8560b44
DW
1632#define BGP_ERR_PEER_GROUP_NO_REMOTE_AS -7
1633#define BGP_ERR_PEER_GROUP_CANT_CHANGE -8
1634#define BGP_ERR_PEER_GROUP_MISMATCH -9
1635#define BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT -10
c8560b44
DW
1636#define BGP_ERR_AS_MISMATCH -12
1637#define BGP_ERR_PEER_FLAG_CONFLICT -13
1638#define BGP_ERR_PEER_GROUP_SHUTDOWN -14
1639#define BGP_ERR_PEER_FILTER_CONFLICT -15
1640#define BGP_ERR_NOT_INTERNAL_PEER -16
1641#define BGP_ERR_REMOVE_PRIVATE_AS -17
1642#define BGP_ERR_AF_UNCONFIGURED -18
1643#define BGP_ERR_SOFT_RECONFIG_UNCONFIGURED -19
1644#define BGP_ERR_INSTANCE_MISMATCH -20
1645#define BGP_ERR_LOCAL_AS_ALLOWED_ONLY_FOR_EBGP -21
1646#define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS -22
1647#define BGP_ERR_TCPSIG_FAILED -23
1648#define BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK -24
1649#define BGP_ERR_NO_IBGP_WITH_TTLHACK -25
1650#define BGP_ERR_NO_INTERFACE_CONFIG -26
1651#define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS_REMOTE_AS -27
1652#define BGP_ERR_AS_OVERRIDE -28
1653#define BGP_ERR_INVALID_DYNAMIC_NEIGHBORS_LIMIT -29
1654#define BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_EXISTS -30
1655#define BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_NOT_FOUND -31
1656#define BGP_ERR_INVALID_FOR_DYNAMIC_PEER -32
1657#define BGP_ERR_MAX -33
63fa10b5 1658#define BGP_ERR_INVALID_FOR_DIRECT_PEER -34
9bedbb1e 1659#define BGP_ERR_PEER_SAFI_CONFLICT -35
718e3744 1660
b0965c44 1661/* BGP GR ERRORS */
b0965c44 1662#define BGP_ERR_GR_INVALID_CMD -36
1663#define BGP_ERR_GR_OPERATION_FAILED -37
1664#define BGP_GR_NO_OPERATION -38
1665
3f9c7369
DS
1666/*
1667 * Enumeration of different policy kinds a peer can be configured with.
1668 */
d62a17ae 1669typedef enum {
1670 BGP_POLICY_ROUTE_MAP,
1671 BGP_POLICY_FILTER_LIST,
1672 BGP_POLICY_PREFIX_LIST,
1673 BGP_POLICY_DISTRIBUTE_LIST,
3f9c7369
DS
1674} bgp_policy_type_e;
1675
dcc68b5e
MS
1676/* peer_flag_change_type. */
1677enum peer_change_type {
1678 peer_change_none,
1679 peer_change_reset,
1680 peer_change_reset_in,
1681 peer_change_reset_out,
1682};
1683
718e3744 1684extern struct bgp_master *bm;
37fe7731 1685extern unsigned int multipath_num;
718e3744 1686
718e3744 1687/* Prototypes. */
d62a17ae 1688extern void bgp_terminate(void);
1689extern void bgp_reset(void);
1690extern time_t bgp_clock(void);
1691extern void bgp_zclient_reset(void);
d62a17ae 1692extern struct bgp *bgp_get_default(void);
1693extern struct bgp *bgp_lookup(as_t, const char *);
1694extern struct bgp *bgp_lookup_by_name(const char *);
1695extern struct bgp *bgp_lookup_by_vrf_id(vrf_id_t);
e2f3a930
T
1696extern struct bgp *bgp_get_evpn(void);
1697extern void bgp_set_evpn(struct bgp *bgp);
d62a17ae 1698extern struct peer *peer_lookup(struct bgp *, union sockunion *);
1699extern struct peer *peer_lookup_by_conf_if(struct bgp *, const char *);
04b6bdc0 1700extern struct peer *peer_lookup_by_hostname(struct bgp *, const char *);
d62a17ae 1701extern void bgp_peer_conf_if_to_su_update(struct peer *);
ffd0c037 1702extern int peer_group_listen_range_del(struct peer_group *, struct prefix *);
d62a17ae 1703extern struct peer_group *peer_group_lookup(struct bgp *, const char *);
1704extern struct peer_group *peer_group_get(struct bgp *, const char *);
1705extern struct peer *peer_create_bind_dynamic_neighbor(struct bgp *,
1706 union sockunion *,
1707 struct peer_group *);
1708extern struct prefix *
1709peer_group_lookup_dynamic_neighbor_range(struct peer_group *, struct prefix *);
1710extern struct peer_group *peer_group_lookup_dynamic_neighbor(struct bgp *,
1711 struct prefix *,
1712 struct prefix **);
1713extern struct peer *peer_lookup_dynamic_neighbor(struct bgp *,
1714 union sockunion *);
28066f4b
DS
1715
1716/*
1717 * Peers are incredibly easy to memory leak
1718 * due to the various ways that they are actually used
1719 * Provide some functionality to debug locks and unlocks
1720 */
1721extern struct peer *peer_lock_with_caller(const char *, struct peer *);
1722extern struct peer *peer_unlock_with_caller(const char *, struct peer *);
1723#define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
1724#define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
1725
d62a17ae 1726extern bgp_peer_sort_t peer_sort(struct peer *peer);
1727extern int peer_active(struct peer *);
1728extern int peer_active_nego(struct peer *);
1729extern void bgp_recalculate_all_bestpaths(struct bgp *bgp);
a80beece 1730extern struct peer *peer_create(union sockunion *, const char *, struct bgp *,
d62a17ae 1731 as_t, as_t, int, afi_t, safi_t,
1732 struct peer_group *);
1733extern struct peer *peer_create_accept(struct bgp *);
1734extern void peer_xfer_config(struct peer *dst, struct peer *src);
94d4c685
DS
1735extern char *peer_uptime(time_t uptime2, char *buf, size_t len, bool use_json,
1736 json_object *json);
856ca177 1737
d62a17ae 1738extern int bgp_config_write(struct vty *);
6b0655a2 1739
c2d020ad
DS
1740extern void bgp_master_init(struct thread_master *master,
1741 const int buffer_size);
718e3744 1742
f533be73 1743extern void bgp_init(unsigned short instance);
419dfe6a 1744extern void bgp_pthreads_run(void);
2d4ee774 1745extern void bgp_pthreads_finish(void);
d62a17ae 1746extern void bgp_route_map_init(void);
1747extern void bgp_session_reset(struct peer *);
718e3744 1748
d62a17ae 1749extern int bgp_option_set(int);
1750extern int bgp_option_unset(int);
1751extern int bgp_option_check(int);
718e3744 1752
d62a17ae 1753extern int bgp_get(struct bgp **, as_t *, const char *, enum bgp_instance_type);
1754extern void bgp_instance_up(struct bgp *);
1755extern void bgp_instance_down(struct bgp *);
1756extern int bgp_delete(struct bgp *);
718e3744 1757
e5619c28
PG
1758extern int bgp_handle_socket(struct bgp *bgp, struct vrf *vrf,
1759 vrf_id_t old_vrf_id, bool create);
1760
d62a17ae 1761extern int bgp_flag_set(struct bgp *, int);
1762extern int bgp_flag_unset(struct bgp *, int);
1763extern int bgp_flag_check(struct bgp *, int);
718e3744 1764
d62a17ae 1765extern void bgp_router_id_zebra_bump(vrf_id_t, const struct prefix *);
1766extern int bgp_router_id_static_set(struct bgp *, struct in_addr);
718e3744 1767
d62a17ae 1768extern int bgp_cluster_id_set(struct bgp *, struct in_addr *);
1769extern int bgp_cluster_id_unset(struct bgp *);
718e3744 1770
d62a17ae 1771extern int bgp_confederation_id_set(struct bgp *, as_t);
1772extern int bgp_confederation_id_unset(struct bgp *);
1773extern int bgp_confederation_peers_check(struct bgp *, as_t);
718e3744 1774
d62a17ae 1775extern int bgp_confederation_peers_add(struct bgp *, as_t);
1776extern int bgp_confederation_peers_remove(struct bgp *, as_t);
718e3744 1777
5d5393b9
DL
1778extern int bgp_timers_set(struct bgp *, uint32_t keepalive, uint32_t holdtime,
1779 uint32_t connect_retry);
d62a17ae 1780extern int bgp_timers_unset(struct bgp *);
718e3744 1781
d7c0a89a 1782extern int bgp_default_local_preference_set(struct bgp *, uint32_t);
d62a17ae 1783extern int bgp_default_local_preference_unset(struct bgp *);
718e3744 1784
d7c0a89a 1785extern int bgp_default_subgroup_pkt_queue_max_set(struct bgp *bgp, uint32_t);
d62a17ae 1786extern int bgp_default_subgroup_pkt_queue_max_unset(struct bgp *bgp);
3f9c7369 1787
d62a17ae 1788extern int bgp_listen_limit_set(struct bgp *, int);
1789extern int bgp_listen_limit_unset(struct bgp *);
f14e6fdb 1790
d62a17ae 1791extern int bgp_update_delay_active(struct bgp *);
1792extern int bgp_update_delay_configured(struct bgp *);
318cac96 1793extern int bgp_afi_safi_peer_exists(struct bgp *bgp, afi_t afi, safi_t safi);
d62a17ae 1794extern void peer_as_change(struct peer *, as_t, int);
1795extern int peer_remote_as(struct bgp *, union sockunion *, const char *, as_t *,
1796 int, afi_t, safi_t);
1797extern int peer_group_remote_as(struct bgp *, const char *, as_t *, int);
1798extern int peer_delete(struct peer *peer);
4e2786df 1799extern int peer_notify_unconfig(struct peer *peer);
d62a17ae 1800extern int peer_group_delete(struct peer_group *);
1801extern int peer_group_remote_as_delete(struct peer_group *);
f14e6fdb 1802extern int peer_group_listen_range_add(struct peer_group *, struct prefix *);
4e2786df 1803extern int peer_group_notify_unconfig(struct peer_group *group);
718e3744 1804
d62a17ae 1805extern int peer_activate(struct peer *, afi_t, safi_t);
1806extern int peer_deactivate(struct peer *, afi_t, safi_t);
1807extern int peer_afc_set(struct peer *, afi_t, safi_t, int);
718e3744 1808
d62a17ae 1809extern int peer_group_bind(struct bgp *, union sockunion *, struct peer *,
1810 struct peer_group *, as_t *);
718e3744 1811
d7c0a89a
QY
1812extern int peer_flag_set(struct peer *, uint32_t);
1813extern int peer_flag_unset(struct peer *, uint32_t);
9fb964de 1814extern void peer_flag_inherit(struct peer *peer, uint32_t flag);
718e3744 1815
d7c0a89a
QY
1816extern int peer_af_flag_set(struct peer *, afi_t, safi_t, uint32_t);
1817extern int peer_af_flag_unset(struct peer *, afi_t, safi_t, uint32_t);
1818extern int peer_af_flag_check(struct peer *, afi_t, safi_t, uint32_t);
cf9ac8bf
PM
1819extern void peer_af_flag_inherit(struct peer *peer, afi_t afi, safi_t safi,
1820 uint32_t flag);
dcc68b5e
MS
1821extern void peer_change_action(struct peer *peer, afi_t afi, safi_t safi,
1822 enum peer_change_type type);
718e3744 1823
d62a17ae 1824extern int peer_ebgp_multihop_set(struct peer *, int);
1825extern int peer_ebgp_multihop_unset(struct peer *);
1826extern int is_ebgp_multihop_configured(struct peer *peer);
718e3744 1827
d62a17ae 1828extern int peer_description_set(struct peer *, const char *);
1829extern int peer_description_unset(struct peer *);
718e3744 1830
d62a17ae 1831extern int peer_update_source_if_set(struct peer *, const char *);
1832extern int peer_update_source_addr_set(struct peer *, const union sockunion *);
1833extern int peer_update_source_unset(struct peer *);
718e3744 1834
1de27621
DA
1835extern int peer_default_originate_set(struct peer *peer, afi_t afi, safi_t safi,
1836 const char *rmap,
1837 struct route_map *route_map);
d62a17ae 1838extern int peer_default_originate_unset(struct peer *, afi_t, safi_t);
718e3744 1839
d7c0a89a 1840extern int peer_port_set(struct peer *, uint16_t);
d62a17ae 1841extern int peer_port_unset(struct peer *);
718e3744 1842
d7c0a89a 1843extern int peer_weight_set(struct peer *, afi_t, safi_t, uint16_t);
d62a17ae 1844extern int peer_weight_unset(struct peer *, afi_t, safi_t);
718e3744 1845
d7c0a89a
QY
1846extern int peer_timers_set(struct peer *, uint32_t keepalive,
1847 uint32_t holdtime);
d62a17ae 1848extern int peer_timers_unset(struct peer *);
718e3744 1849
d7c0a89a 1850extern int peer_timers_connect_set(struct peer *, uint32_t);
d62a17ae 1851extern int peer_timers_connect_unset(struct peer *);
718e3744 1852
d7c0a89a 1853extern int peer_advertise_interval_set(struct peer *, uint32_t);
d62a17ae 1854extern int peer_advertise_interval_unset(struct peer *);
718e3744 1855
d62a17ae 1856extern void peer_interface_set(struct peer *, const char *);
1857extern void peer_interface_unset(struct peer *);
718e3744 1858
d62a17ae 1859extern int peer_distribute_set(struct peer *, afi_t, safi_t, int, const char *);
1860extern int peer_distribute_unset(struct peer *, afi_t, safi_t, int);
718e3744 1861
d62a17ae 1862extern int peer_allowas_in_set(struct peer *, afi_t, safi_t, int, int);
1863extern int peer_allowas_in_unset(struct peer *, afi_t, safi_t);
718e3744 1864
d62a17ae 1865extern int peer_local_as_set(struct peer *, as_t, int, int);
1866extern int peer_local_as_unset(struct peer *);
718e3744 1867
d62a17ae 1868extern int peer_prefix_list_set(struct peer *, afi_t, safi_t, int,
1869 const char *);
1870extern int peer_prefix_list_unset(struct peer *, afi_t, safi_t, int);
718e3744 1871
d62a17ae 1872extern int peer_aslist_set(struct peer *, afi_t, safi_t, int, const char *);
1873extern int peer_aslist_unset(struct peer *, afi_t, safi_t, int);
718e3744 1874
1de27621
DA
1875extern int peer_route_map_set(struct peer *peer, afi_t afi, safi_t safi, int,
1876 const char *name, struct route_map *route_map);
d62a17ae 1877extern int peer_route_map_unset(struct peer *, afi_t, safi_t, int);
718e3744 1878
1de27621
DA
1879extern int peer_unsuppress_map_set(struct peer *peer, afi_t afi, safi_t safi,
1880 const char *name,
1881 struct route_map *route_map);
0df7c91f 1882
d62a17ae 1883extern int peer_password_set(struct peer *, const char *);
1884extern int peer_password_unset(struct peer *);
0df7c91f 1885
d62a17ae 1886extern int peer_unsuppress_map_unset(struct peer *, afi_t, safi_t);
718e3744 1887
d7c0a89a
QY
1888extern int peer_maximum_prefix_set(struct peer *, afi_t, safi_t, uint32_t,
1889 uint8_t, int, uint16_t);
d62a17ae 1890extern int peer_maximum_prefix_unset(struct peer *, afi_t, safi_t);
718e3744 1891
d62a17ae 1892extern int peer_clear(struct peer *, struct listnode **);
1893extern int peer_clear_soft(struct peer *, afi_t, safi_t, enum bgp_clear_type);
93406d87 1894
d62a17ae 1895extern int peer_ttl_security_hops_set(struct peer *, int);
1896extern int peer_ttl_security_hops_unset(struct peer *);
fa411a21 1897
d62a17ae 1898extern int peer_tx_shutdown_message_set(struct peer *, const char *msg);
1899extern int peer_tx_shutdown_message_unset(struct peer *);
73d70fa6 1900
d62a17ae 1901extern int bgp_route_map_update_timer(struct thread *thread);
518f0eb1 1902extern void bgp_route_map_terminate(void);
16286195 1903
d62a17ae 1904extern int peer_cmp(struct peer *p1, struct peer *p2);
3f9c7369 1905
5c525538 1906extern int bgp_map_afi_safi_iana2int(iana_afi_t pkt_afi, iana_safi_t pkt_safi,
d62a17ae 1907 afi_t *afi, safi_t *safi);
1908extern int bgp_map_afi_safi_int2iana(afi_t afi, safi_t safi,
a4d82a8a
PZ
1909 iana_afi_t *pkt_afi,
1910 iana_safi_t *pkt_safi);
9cabb64b 1911
d62a17ae 1912extern struct peer_af *peer_af_create(struct peer *, afi_t, safi_t);
1913extern struct peer_af *peer_af_find(struct peer *, afi_t, safi_t);
1914extern int peer_af_delete(struct peer *, afi_t, safi_t);
3f9c7369 1915
ffd0c037 1916extern void bgp_close(void);
92375c91 1917extern void bgp_free(struct bgp *);
b0965c44 1918void bgp_gr_apply_running_config(void);
1919
1920/* BGP GR */
b0965c44 1921int bgp_global_gr_init(struct bgp *bgp);
1922int bgp_peer_gr_init(struct peer *peer);
92375c91 1923
2d3dd828 1924
1925#define BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA( \
1926 _bgp, _peer_list) \
1927do { \
1928 struct peer *peer_loop; \
1929 bool gr_router_detected = false; \
1930 struct listnode *node = {0}; \
1931 struct listnode *nnode = {0}; \
1932 for (ALL_LIST_ELEMENTS( \
1933 _peer_list, node, \
1934 nnode, peer_loop)) { \
1935 if (CHECK_FLAG( \
1936 peer_loop->flags, \
1937 PEER_FLAG_GRACEFUL_RESTART)) \
1938 gr_router_detected = true; \
1939 } \
1940 if (gr_router_detected && \
1941 _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
1942 bgp_zebra_send_capabilities(_bgp, false); \
1943 } else if (!gr_router_detected && \
1944 _bgp->present_zebra_gr_state == ZEBRA_GR_ENABLE) { \
1945 bgp_zebra_send_capabilities(_bgp, true); \
1946 } \
1947} while (0)
1948
92375c91
JB
1949static inline struct bgp *bgp_lock(struct bgp *bgp)
1950{
1951 bgp->lock++;
1952 return bgp;
1953}
1954
1955static inline void bgp_unlock(struct bgp *bgp)
1956{
1957 assert(bgp->lock > 0);
1958 if (--bgp->lock == 0)
1959 bgp_free(bgp);
1960}
ffd0c037 1961
d62a17ae 1962static inline int afindex(afi_t afi, safi_t safi)
3f9c7369 1963{
d62a17ae 1964 switch (afi) {
1965 case AFI_IP:
1966 switch (safi) {
1967 case SAFI_UNICAST:
1968 return BGP_AF_IPV4_UNICAST;
1969 break;
1970 case SAFI_MULTICAST:
1971 return BGP_AF_IPV4_MULTICAST;
1972 break;
1973 case SAFI_LABELED_UNICAST:
1974 return BGP_AF_IPV4_LBL_UNICAST;
1975 break;
1976 case SAFI_MPLS_VPN:
1977 return BGP_AF_IPV4_VPN;
1978 break;
1979 case SAFI_ENCAP:
1980 return BGP_AF_IPV4_ENCAP;
1981 break;
7c40bf39 1982 case SAFI_FLOWSPEC:
1983 return BGP_AF_IPV4_FLOWSPEC;
d62a17ae 1984 default:
1985 return BGP_AF_MAX;
1986 break;
1987 }
1988 break;
1989 case AFI_IP6:
1990 switch (safi) {
1991 case SAFI_UNICAST:
1992 return BGP_AF_IPV6_UNICAST;
1993 break;
1994 case SAFI_MULTICAST:
1995 return BGP_AF_IPV6_MULTICAST;
1996 break;
1997 case SAFI_LABELED_UNICAST:
1998 return BGP_AF_IPV6_LBL_UNICAST;
1999 break;
2000 case SAFI_MPLS_VPN:
2001 return BGP_AF_IPV6_VPN;
2002 break;
2003 case SAFI_ENCAP:
2004 return BGP_AF_IPV6_ENCAP;
2005 break;
7c40bf39 2006 case SAFI_FLOWSPEC:
2007 return BGP_AF_IPV6_FLOWSPEC;
d62a17ae 2008 default:
2009 return BGP_AF_MAX;
2010 break;
2011 }
2012 break;
2013 case AFI_L2VPN:
2014 switch (safi) {
2015 case SAFI_EVPN:
2016 return BGP_AF_L2VPN_EVPN;
2017 break;
2018 default:
2019 return BGP_AF_MAX;
2020 break;
2021 }
3f9c7369 2022 default:
d62a17ae 2023 return BGP_AF_MAX;
2024 break;
3f9c7369 2025 }
3f9c7369
DS
2026}
2027
c8560b44 2028/* If the peer is not a peer-group but is bound to a peer-group return 1 */
d62a17ae 2029static inline int peer_group_active(struct peer *peer)
3f9c7369 2030{
d62a17ae 2031 if (!CHECK_FLAG(peer->sflags, PEER_STATUS_GROUP) && peer->group)
2032 return 1;
2033 return 0;
3f9c7369
DS
2034}
2035
2036/* If peer is negotiated at least one address family return 1. */
d62a17ae 2037static inline int peer_afi_active_nego(const struct peer *peer, afi_t afi)
3f9c7369 2038{
d62a17ae 2039 if (peer->afc_nego[afi][SAFI_UNICAST]
2040 || peer->afc_nego[afi][SAFI_MULTICAST]
2041 || peer->afc_nego[afi][SAFI_LABELED_UNICAST]
2042 || peer->afc_nego[afi][SAFI_MPLS_VPN]
2043 || peer->afc_nego[afi][SAFI_ENCAP]
7c40bf39 2044 || peer->afc_nego[afi][SAFI_FLOWSPEC]
d62a17ae 2045 || peer->afc_nego[afi][SAFI_EVPN])
2046 return 1;
2047 return 0;
3f9c7369
DS
2048}
2049
f14e6fdb 2050/* If at least one address family activated for group, return 1. */
d62a17ae 2051static inline int peer_group_af_configured(struct peer_group *group)
f14e6fdb 2052{
d62a17ae 2053 struct peer *peer = group->conf;
2054
2055 if (peer->afc[AFI_IP][SAFI_UNICAST] || peer->afc[AFI_IP][SAFI_MULTICAST]
2056 || peer->afc[AFI_IP][SAFI_LABELED_UNICAST]
7c40bf39 2057 || peer->afc[AFI_IP][SAFI_FLOWSPEC]
d62a17ae 2058 || peer->afc[AFI_IP][SAFI_MPLS_VPN] || peer->afc[AFI_IP][SAFI_ENCAP]
2059 || peer->afc[AFI_IP6][SAFI_UNICAST]
2060 || peer->afc[AFI_IP6][SAFI_MULTICAST]
2061 || peer->afc[AFI_IP6][SAFI_LABELED_UNICAST]
2062 || peer->afc[AFI_IP6][SAFI_MPLS_VPN]
ba0fcaf6 2063 || peer->afc[AFI_IP6][SAFI_ENCAP]
7c40bf39 2064 || peer->afc[AFI_IP6][SAFI_FLOWSPEC]
ba0fcaf6 2065 || peer->afc[AFI_L2VPN][SAFI_EVPN])
d62a17ae 2066 return 1;
2067 return 0;
f14e6fdb
DS
2068}
2069
d62a17ae 2070static inline char *timestamp_string(time_t ts)
3f9c7369 2071{
d62a17ae 2072 time_t tbuf;
2073 tbuf = time(NULL) - (bgp_clock() - ts);
2074 return ctime(&tbuf);
3f9c7369
DS
2075}
2076
d62a17ae 2077static inline int peer_established(struct peer *peer)
3f9c7369 2078{
d62a17ae 2079 if (peer->status == Established)
2080 return 1;
2081 return 0;
3f9c7369
DS
2082}
2083
d62a17ae 2084static inline int peer_dynamic_neighbor(struct peer *peer)
f14e6fdb 2085{
d62a17ae 2086 return (CHECK_FLAG(peer->flags, PEER_FLAG_DYNAMIC_NEIGHBOR)) ? 1 : 0;
f14e6fdb
DS
2087}
2088
d62a17ae 2089static inline int peer_cap_enhe(struct peer *peer, afi_t afi, safi_t safi)
8a92a8a0 2090{
d62a17ae 2091 return (CHECK_FLAG(peer->af_cap[afi][safi], PEER_CAP_ENHE_AF_NEGO));
8a92a8a0
DS
2092}
2093
d1be1f08 2094/* Lookup VRF for BGP instance based on its type. */
d62a17ae 2095static inline struct vrf *bgp_vrf_lookup_by_instance_type(struct bgp *bgp)
d1be1f08 2096{
d62a17ae 2097 struct vrf *vrf;
d1be1f08 2098
d62a17ae 2099 if (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT)
2100 vrf = vrf_lookup_by_id(VRF_DEFAULT);
2101 else if (bgp->inst_type == BGP_INSTANCE_TYPE_VRF)
2102 vrf = vrf_lookup_by_name(bgp->name);
2103 else
2104 vrf = NULL;
d1be1f08 2105
d62a17ae 2106 return vrf;
d1be1f08 2107}
2108
2109/* Link BGP instance to VRF. */
d62a17ae 2110static inline void bgp_vrf_link(struct bgp *bgp, struct vrf *vrf)
d1be1f08 2111{
d62a17ae 2112 bgp->vrf_id = vrf->vrf_id;
92375c91
JB
2113 if (vrf->info != (void *)bgp)
2114 vrf->info = (void *)bgp_lock(bgp);
d1be1f08 2115}
2116
2117/* Unlink BGP instance from VRF. */
d62a17ae 2118static inline void bgp_vrf_unlink(struct bgp *bgp, struct vrf *vrf)
d1be1f08 2119{
d62a17ae 2120 if (vrf->info == (void *)bgp) {
2121 vrf->info = NULL;
2122 bgp_unlock(bgp);
2123 }
2124 bgp->vrf_id = VRF_UNKNOWN;
d1be1f08 2125}
2126
401d56cc 2127extern void bgp_unset_redist_vrf_bitmaps(struct bgp *, vrf_id_t);
65efcfce
LB
2128
2129/* For benefit of rfapi */
d62a17ae 2130extern struct peer *peer_new(struct bgp *bgp);
dcc1615e
DD
2131
2132extern struct peer *peer_lookup_in_view(struct vty *vty, struct bgp *bgp,
2133 const char *ip_str, bool use_json);
2134
7d8d0eab
MKS
2135/* Hooks */
2136DECLARE_HOOK(peer_status_changed, (struct peer * peer), (peer))
d7b3cda6 2137void peer_nsf_stop(struct peer *peer);
7d8d0eab 2138
00d252cb 2139#endif /* _QUAGGA_BGPD_H */