]> git.proxmox.com Git - mirror_frr.git/blob - bgpd/bgpd.h
projects / mirror_frr.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge pull request #11877 from sri-mohan1/sri-ldp-dbg1
[mirror_frr.git] / bgpd / bgpd.h
1 /* BGP message definition header.
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 */
20
21 #ifndef _QUAGGA_BGPD_H
22 #define _QUAGGA_BGPD_H
23
24 #include "qobj.h"
25 #include <pthread.h>
26
27 #include "hook.h"
28 #include "frr_pthread.h"
29 #include "lib/json.h"
30 #include "vrf.h"
31 #include "vty.h"
32 #include "srv6.h"
33 #include "iana_afi.h"
34
35 /* For union sockunion. */
36 #include "queue.h"
37 #include "sockunion.h"
38 #include "routemap.h"
39 #include "linklist.h"
40 #include "defaults.h"
41 #include "bgp_memory.h"
42 #include "bitfield.h"
43 #include "vxlan.h"
44 #include "bgp_labelpool.h"
45 #include "bgp_addpath_types.h"
46 #include "bgp_nexthop.h"
47 #include "bgp_io.h"
48
49 #include "lib/bfd.h"
50
51 #define BGP_MAX_HOSTNAME 64 /* Linux max, is larger than most other sys */
52 #define BGP_PEER_MAX_HASH_SIZE 16384
53
54 /* Default interval for IPv6 RAs when triggered by BGP unnumbered neighbor. */
55 #define BGP_UNNUM_DEFAULT_RA_INTERVAL 10
56
57 struct update_subgroup;
58 struct bpacket;
59 struct bgp_pbr_config;
60
61 /*
62 * Allow the neighbor XXXX remote-as to take internal or external
63 * AS_SPECIFIED is zero to auto-inherit original non-feature/enhancement
64 * behavior
65 * in the system.
66 */
67 enum { AS_UNSPECIFIED = 0,
68 AS_SPECIFIED,
69 AS_INTERNAL,
70 AS_EXTERNAL,
71 };
72
73 /* Zebra Gracaful Restart states */
74 enum zebra_gr_mode {
75 ZEBRA_GR_DISABLE = 0,
76 ZEBRA_GR_ENABLE
77 };
78
79 /* Typedef BGP specific types. */
80 typedef uint32_t as_t;
81 typedef uint16_t as16_t; /* we may still encounter 16 Bit asnums */
82 typedef uint16_t bgp_size_t;
83
84 enum bgp_af_index {
85 BGP_AF_START,
86 BGP_AF_IPV4_UNICAST = BGP_AF_START,
87 BGP_AF_IPV4_MULTICAST,
88 BGP_AF_IPV4_VPN,
89 BGP_AF_IPV6_UNICAST,
90 BGP_AF_IPV6_MULTICAST,
91 BGP_AF_IPV6_VPN,
92 BGP_AF_IPV4_ENCAP,
93 BGP_AF_IPV6_ENCAP,
94 BGP_AF_L2VPN_EVPN,
95 BGP_AF_IPV4_LBL_UNICAST,
96 BGP_AF_IPV6_LBL_UNICAST,
97 BGP_AF_IPV4_FLOWSPEC,
98 BGP_AF_IPV6_FLOWSPEC,
99 BGP_AF_MAX
100 };
101
102 #define AF_FOREACH(af) for ((af) = BGP_AF_START; (af) < BGP_AF_MAX; (af)++)
103
104 #define FOREACH_SAFI(safi) \
105 for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
106
107 extern struct frr_pthread *bgp_pth_io;
108 extern struct frr_pthread *bgp_pth_ka;
109
110 /* BGP master for system wide configurations and variables. */
111 struct bgp_master {
112 /* BGP instance list. */
113 struct list *bgp;
114
115 /* BGP thread master. */
116 struct thread_master *master;
117
118 /* Listening sockets */
119 struct list *listen_sockets;
120
121 /* BGP port number. */
122 uint16_t port;
123
124 /* Listener addresses */
125 struct list *addresses;
126
127 /* The Mac table */
128 struct hash *self_mac_hash;
129
130 /* BGP start time. */
131 time_t start_time;
132
133 /* Various BGP global configuration. */
134 uint8_t options;
135 #define BGP_OPT_NO_FIB (1 << 0)
136 #define BGP_OPT_NO_LISTEN (1 << 1)
137 #define BGP_OPT_NO_ZEBRA (1 << 2)
138
139 uint64_t updgrp_idspace;
140 uint64_t subgrp_idspace;
141
142 /* timer to dampen route map changes */
143 struct thread *t_rmap_update; /* Handle route map updates */
144 uint32_t rmap_update_timer; /* Route map update timer */
145 #define RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
146
147 /* Id space for automatic RD derivation for an EVI/VRF */
148 bitfield_t rd_idspace;
149
150 /* dynamic mpls label allocation pool */
151 struct labelpool labelpool;
152
153 /* BGP-EVPN VRF ID. Defaults to default VRF (if any) */
154 struct bgp* bgp_evpn;
155
156 /* How big should we set the socket buffer size */
157 uint32_t socket_buffer;
158
159 /* Should we do wait for fib install globally? */
160 bool wait_for_fib;
161
162 /* EVPN multihoming */
163 struct bgp_evpn_mh_info *mh_info;
164
165 /* global update-delay timer values */
166 uint16_t v_update_delay;
167 uint16_t v_establish_wait;
168
169 uint32_t flags;
170 #define BM_FLAG_GRACEFUL_SHUTDOWN (1 << 0)
171 #define BM_FLAG_SEND_EXTRA_DATA_TO_ZEBRA (1 << 1)
172
173 bool terminating; /* global flag that sigint terminate seen */
174
175 /* DSCP value for TCP sessions */
176 uint8_t tcp_dscp;
177
178 QOBJ_FIELDS;
179 };
180 DECLARE_QOBJ_TYPE(bgp_master);
181
182 /* BGP route-map structure. */
183 struct bgp_rmap {
184 char *name;
185 struct route_map *map;
186 };
187
188 struct bgp_redist {
189 unsigned short instance;
190
191 /* BGP redistribute metric configuration. */
192 uint8_t redist_metric_flag;
193 uint32_t redist_metric;
194
195 /* BGP redistribute route-map. */
196 struct bgp_rmap rmap;
197 };
198
199 enum vpn_policy_direction {
200 BGP_VPN_POLICY_DIR_FROMVPN = 0,
201 BGP_VPN_POLICY_DIR_TOVPN = 1,
202 BGP_VPN_POLICY_DIR_MAX = 2
203 };
204
205 struct vpn_policy {
206 struct bgp *bgp; /* parent */
207 afi_t afi;
208 struct ecommunity *rtlist[BGP_VPN_POLICY_DIR_MAX];
209 struct ecommunity *import_redirect_rtlist;
210 char *rmap_name[BGP_VPN_POLICY_DIR_MAX];
211 struct route_map *rmap[BGP_VPN_POLICY_DIR_MAX];
212
213 /* should be mpls_label_t? */
214 uint32_t tovpn_label; /* may be MPLS_LABEL_NONE */
215 uint32_t tovpn_zebra_vrf_label_last_sent;
216 struct prefix_rd tovpn_rd;
217 struct prefix tovpn_nexthop; /* unset => set to 0 */
218 uint32_t flags;
219 #define BGP_VPN_POLICY_TOVPN_LABEL_AUTO (1 << 0)
220 #define BGP_VPN_POLICY_TOVPN_RD_SET (1 << 1)
221 #define BGP_VPN_POLICY_TOVPN_NEXTHOP_SET (1 << 2)
222 #define BGP_VPN_POLICY_TOVPN_SID_AUTO (1 << 3)
223
224 /*
225 * If we are importing another vrf into us keep a list of
226 * vrf names that are being imported into us.
227 */
228 struct list *import_vrf;
229
230 /*
231 * if we are being exported to another vrf keep a list of
232 * vrf names that we are being exported to.
233 */
234 struct list *export_vrf;
235
236 /*
237 * Segment-Routing SRv6 Mode
238 */
239 uint32_t tovpn_sid_index; /* unset => set to 0 */
240 struct in6_addr *tovpn_sid;
241 struct in6_addr *tovpn_sid_locator;
242 uint32_t tovpn_sid_transpose_label;
243 struct in6_addr *tovpn_zebra_vrf_sid_last_sent;
244 };
245
246 /*
247 * Type of 'struct bgp'.
248 * - Default: The default instance
249 * - VRF: A specific (non-default) VRF
250 * - View: An instance used for route exchange
251 * The "default" instance is treated separately to simplify the code. Note
252 * that if deployed in a Multi-VRF environment, it may not exist.
253 */
254 enum bgp_instance_type {
255 BGP_INSTANCE_TYPE_DEFAULT,
256 BGP_INSTANCE_TYPE_VRF,
257 BGP_INSTANCE_TYPE_VIEW
258 };
259
260 #define BGP_SEND_EOR(bgp, afi, safi) \
261 (!CHECK_FLAG(bgp->flags, BGP_FLAG_GR_DISABLE_EOR) \
262 && ((bgp->gr_info[afi][safi].t_select_deferral == NULL) \
263 || (bgp->gr_info[afi][safi].eor_required \
264 == bgp->gr_info[afi][safi].eor_received)))
265
266 /* BGP GR Global ds */
267
268 #define BGP_GLOBAL_GR_MODE 4
269 #define BGP_GLOBAL_GR_EVENT_CMD 4
270
271 /* Graceful restart selection deferral timer info */
272 struct graceful_restart_info {
273 /* Count of EOR message expected */
274 uint32_t eor_required;
275 /* Count of EOR received */
276 uint32_t eor_received;
277 /* Deferral Timer */
278 struct thread *t_select_deferral;
279 /* Routes Deferred */
280 uint32_t gr_deferred;
281 /* Best route select */
282 struct thread *t_route_select;
283 /* AFI, SAFI enabled */
284 bool af_enabled[AFI_MAX][SAFI_MAX];
285 /* Route update completed */
286 bool route_sync[AFI_MAX][SAFI_MAX];
287 };
288
289 enum global_mode {
290 GLOBAL_HELPER = 0, /* This is the default mode */
291 GLOBAL_GR,
292 GLOBAL_DISABLE,
293 GLOBAL_INVALID
294 };
295
296 enum global_gr_command {
297 GLOBAL_GR_CMD = 0,
298 NO_GLOBAL_GR_CMD,
299 GLOBAL_DISABLE_CMD,
300 NO_GLOBAL_DISABLE_CMD
301 };
302
303 #define BGP_GR_SUCCESS 0
304 #define BGP_GR_FAILURE 1
305
306 /* Handling of BGP link bandwidth (LB) on receiver - whether and how to
307 * do weighted ECMP. Note: This applies after multipath computation.
308 */
309 enum bgp_link_bw_handling {
310 /* Do ECMP if some paths don't have LB - default */
311 BGP_LINK_BW_ECMP,
312 /* Completely ignore LB, just do regular ECMP */
313 BGP_LINK_BW_IGNORE_BW,
314 /* Skip paths without LB, do wECMP on others */
315 BGP_LINK_BW_SKIP_MISSING,
316 /* Do wECMP with default weight for paths not having LB */
317 BGP_LINK_BW_DEFWT_4_MISSING
318 };
319
320 RB_HEAD(bgp_es_vrf_rb_head, bgp_evpn_es_vrf);
321 RB_PROTOTYPE(bgp_es_vrf_rb_head, bgp_evpn_es_vrf, rb_node, bgp_es_vrf_rb_cmp);
322
323 struct bgp_snmp_stats {
324 /* SNMP variables for mplsL3Vpn*/
325 time_t creation_time;
326 time_t modify_time;
327 bool active;
328 uint32_t routes_added;
329 uint32_t routes_deleted;
330 };
331
332 struct bgp_srv6_function {
333 struct in6_addr sid;
334 char locator_name[SRV6_LOCNAME_SIZE];
335 };
336
337 /* BGP instance structure. */
338 struct bgp {
339 /* AS number of this BGP instance. */
340 as_t as;
341
342 /* Name of this BGP instance. */
343 char *name;
344 char *name_pretty; /* printable "VRF|VIEW name|default" */
345
346 /* Type of instance and VRF id. */
347 enum bgp_instance_type inst_type;
348 vrf_id_t vrf_id;
349
350 /* Reference count to allow peer_delete to finish after bgp_delete */
351 int lock;
352
353 /* Self peer. */
354 struct peer *peer_self;
355
356 /* BGP peer. */
357 struct list *peer;
358 struct hash *peerhash;
359
360 /* BGP peer group. */
361 struct list *group;
362
363 /* The maximum number of BGP dynamic neighbors that can be created */
364 int dynamic_neighbors_limit;
365
366 /* The current number of BGP dynamic neighbors */
367 int dynamic_neighbors_count;
368
369 struct hash *update_groups[BGP_AF_MAX];
370
371 /*
372 * Global statistics for update groups.
373 */
374 struct {
375 uint32_t join_events;
376 uint32_t prune_events;
377 uint32_t merge_events;
378 uint32_t split_events;
379 uint32_t updgrp_switch_events;
380 uint32_t peer_refreshes_combined;
381 uint32_t adj_count;
382 uint32_t merge_checks_triggered;
383
384 uint32_t updgrps_created;
385 uint32_t updgrps_deleted;
386 uint32_t subgrps_created;
387 uint32_t subgrps_deleted;
388 } update_group_stats;
389
390 struct bgp_snmp_stats *snmp_stats;
391
392 /* BGP configuration. */
393 uint16_t config;
394 #define BGP_CONFIG_CLUSTER_ID (1 << 0)
395 #define BGP_CONFIG_CONFEDERATION (1 << 1)
396
397 /* BGP router identifier. */
398 struct in_addr router_id;
399 struct in_addr router_id_static;
400 struct in_addr router_id_zebra;
401
402 /* BGP route reflector cluster ID. */
403 struct in_addr cluster_id;
404
405 /* BGP confederation information. */
406 as_t confed_id;
407 as_t *confed_peers;
408 int confed_peers_cnt;
409
410 struct thread
411 *t_startup; /* start-up timer on only once at the beginning */
412
413 uint32_t v_maxmed_onstartup; /* Duration of max-med on start-up */
414 #define BGP_MAXMED_ONSTARTUP_UNCONFIGURED 0 /* 0 means off, its the default */
415 uint32_t maxmed_onstartup_value; /* Max-med value when active on
416 start-up */
417 struct thread
418 *t_maxmed_onstartup; /* non-null when max-med onstartup is on */
419 uint8_t maxmed_onstartup_over; /* Flag to make it effective only once */
420
421 bool v_maxmed_admin; /* true/false if max-med administrative is on/off
422 */
423 #define BGP_MAXMED_ADMIN_UNCONFIGURED false /* Off by default */
424 uint32_t maxmed_admin_value; /* Max-med value when administrative in on
425 */
426 #define BGP_MAXMED_VALUE_DEFAULT 4294967294 /* Maximum by default */
427
428 uint8_t maxmed_active; /* 1/0 if max-med is active or not */
429 uint32_t maxmed_value; /* Max-med value when its active */
430
431 /* BGP update delay on startup */
432 struct thread *t_update_delay;
433 struct thread *t_establish_wait;
434 uint8_t update_delay_over;
435 uint8_t main_zebra_update_hold;
436 uint8_t main_peers_update_hold;
437 uint16_t v_update_delay;
438 uint16_t v_establish_wait;
439 char update_delay_begin_time[64];
440 char update_delay_end_time[64];
441 char update_delay_zebra_resume_time[64];
442 char update_delay_peers_resume_time[64];
443 uint32_t established;
444 uint32_t restarted_peers;
445 uint32_t implicit_eors;
446 uint32_t explicit_eors;
447 #define BGP_UPDATE_DELAY_DEF 0
448 #define BGP_UPDATE_DELAY_MIN 0
449 #define BGP_UPDATE_DELAY_MAX 3600
450
451 /* Reference bandwidth for BGP link-bandwidth. Used when
452 * the LB value has to be computed based on some other
453 * factor (e.g., number of multipaths for the prefix)
454 * Value is in Mbps
455 */
456 uint32_t lb_ref_bw;
457 #define BGP_LINK_BW_REF_BW 1
458
459 /* BGP flags. */
460 uint64_t flags;
461 #define BGP_FLAG_ALWAYS_COMPARE_MED (1 << 0)
462 #define BGP_FLAG_DETERMINISTIC_MED (1 << 1)
463 #define BGP_FLAG_MED_MISSING_AS_WORST (1 << 2)
464 #define BGP_FLAG_MED_CONFED (1 << 3)
465 #define BGP_FLAG_NO_CLIENT_TO_CLIENT (1 << 4)
466 #define BGP_FLAG_COMPARE_ROUTER_ID (1 << 5)
467 #define BGP_FLAG_ASPATH_IGNORE (1 << 6)
468 #define BGP_FLAG_IMPORT_CHECK (1 << 7)
469 #define BGP_FLAG_NO_FAST_EXT_FAILOVER (1 << 8)
470 #define BGP_FLAG_LOG_NEIGHBOR_CHANGES (1 << 9)
471
472 /* This flag is set when we have full BGP Graceful-Restart mode enable */
473 #define BGP_FLAG_GRACEFUL_RESTART (1 << 10)
474
475 #define BGP_FLAG_ASPATH_CONFED (1 << 11)
476 #define BGP_FLAG_ASPATH_MULTIPATH_RELAX (1 << 12)
477 #define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1 << 13)
478 #define BGP_FLAG_DISABLE_NH_CONNECTED_CHK (1 << 14)
479 #define BGP_FLAG_MULTIPATH_RELAX_AS_SET (1 << 15)
480 #define BGP_FLAG_FORCE_STATIC_PROCESS (1 << 16)
481 #define BGP_FLAG_SHOW_HOSTNAME (1 << 17)
482 #define BGP_FLAG_GR_PRESERVE_FWD (1 << 18)
483 #define BGP_FLAG_GRACEFUL_SHUTDOWN (1 << 19)
484 #define BGP_FLAG_DELETE_IN_PROGRESS (1 << 20)
485 #define BGP_FLAG_SELECT_DEFER_DISABLE (1 << 21)
486 #define BGP_FLAG_GR_DISABLE_EOR (1 << 22)
487 #define BGP_FLAG_EBGP_REQUIRES_POLICY (1 << 23)
488 #define BGP_FLAG_SHOW_NEXTHOP_HOSTNAME (1 << 24)
489
490 /* This flag is set if the instance is in administrative shutdown */
491 #define BGP_FLAG_SHUTDOWN (1 << 25)
492 #define BGP_FLAG_SUPPRESS_FIB_PENDING (1 << 26)
493 #define BGP_FLAG_SUPPRESS_DUPLICATES (1 << 27)
494 #define BGP_FLAG_PEERTYPE_MULTIPATH_RELAX (1 << 29)
495 /* Indicate Graceful Restart support for BGP NOTIFICATION messages */
496 #define BGP_FLAG_GRACEFUL_NOTIFICATION (1 << 30)
497 /* Send Hard Reset CEASE Notification for 'Administrative Reset' */
498 #define BGP_FLAG_HARD_ADMIN_RESET (1 << 31)
499
500 /* BGP default address-families.
501 * New peers inherit enabled afi/safis from bgp instance.
502 */
503 uint16_t default_af[AFI_MAX][SAFI_MAX];
504
505 enum global_mode GLOBAL_GR_FSM[BGP_GLOBAL_GR_MODE]
506 [BGP_GLOBAL_GR_EVENT_CMD];
507 enum global_mode global_gr_present_state;
508
509 /* This variable stores the current Graceful Restart state of Zebra
510 * - ZEBRA_GR_ENABLE / ZEBRA_GR_DISABLE
511 */
512 enum zebra_gr_mode present_zebra_gr_state;
513
514 /* BGP Per AF flags */
515 uint16_t af_flags[AFI_MAX][SAFI_MAX];
516 #define BGP_CONFIG_DAMPENING (1 << 0)
517 /* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */
518 #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST (1 << 1)
519 #define BGP_L2VPN_EVPN_ADV_IPV4_UNICAST_GW_IP (1 << 2)
520 #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST (1 << 3)
521 #define BGP_L2VPN_EVPN_ADV_IPV6_UNICAST_GW_IP (1 << 4)
522 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 5)
523 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 6)
524 /* import/export between address families */
525 #define BGP_CONFIG_VRF_TO_MPLSVPN_EXPORT (1 << 7)
526 #define BGP_CONFIG_MPLSVPN_TO_VRF_IMPORT (1 << 8)
527 /* vrf-route leaking flags */
528 #define BGP_CONFIG_VRF_TO_VRF_IMPORT (1 << 9)
529 #define BGP_CONFIG_VRF_TO_VRF_EXPORT (1 << 10)
530 /* vpnvx retain flag */
531 #define BGP_VPNVX_RETAIN_ROUTE_TARGET_ALL (1 << 11)
532
533 /* BGP per AF peer count */
534 uint32_t af_peer_count[AFI_MAX][SAFI_MAX];
535
536 /* Tree for next-hop lookup cache. */
537 struct bgp_nexthop_cache_head nexthop_cache_table[AFI_MAX];
538
539 /* Tree for import-check */
540 struct bgp_nexthop_cache_head import_check_table[AFI_MAX];
541
542 struct bgp_table *connected_table[AFI_MAX];
543
544 struct hash *address_hash;
545
546 /* DB for all local tunnel-ips - used mainly for martian checks
547 Currently it only has all VxLan tunnel IPs*/
548 struct hash *tip_hash;
549
550 /* Static route configuration. */
551 struct bgp_table *route[AFI_MAX][SAFI_MAX];
552
553 /* Aggregate address configuration. */
554 struct bgp_table *aggregate[AFI_MAX][SAFI_MAX];
555
556 /* BGP routing information base. */
557 struct bgp_table *rib[AFI_MAX][SAFI_MAX];
558
559 /* BGP table route-map. */
560 struct bgp_rmap table_map[AFI_MAX][SAFI_MAX];
561
562 /* BGP redistribute configuration. */
563 struct list *redist[AFI_MAX][ZEBRA_ROUTE_MAX];
564
565 /* Allocate MPLS labels */
566 uint8_t allocate_mpls_labels[AFI_MAX][SAFI_MAX];
567
568 /* Allocate hash entries to store policy routing information
569 * The hash are used to host pbr rules somewhere.
570 * Actually, pbr will only be used by flowspec
571 * those hash elements will have relationship together as
572 * illustrated in below diagram:
573 *
574 * pbr_action a <----- pbr_match i <--- pbr_match_entry 1..n
575 * <----- pbr_match j <--- pbr_match_entry 1..m
576 * <----- pbr_rule k
577 *
578 * - here in BGP structure, the list of match and actions will
579 * stand for the list of ipset sets, and table_ids in the kernel
580 * - the arrow above between pbr_match and pbr_action indicate
581 * that a backpointer permits match to find the action
582 * - the arrow betwen match_entry and match is a hash list
583 * contained in match, that lists the whole set of entries
584 */
585 struct hash *pbr_match_hash;
586 struct hash *pbr_rule_hash;
587 struct hash *pbr_action_hash;
588
589 /* timer to re-evaluate neighbor default-originate route-maps */
590 struct thread *t_rmap_def_originate_eval;
591 #define RMAP_DEFAULT_ORIGINATE_EVAL_TIMER 5
592
593 /* BGP distance configuration. */
594 uint8_t distance_ebgp[AFI_MAX][SAFI_MAX];
595 uint8_t distance_ibgp[AFI_MAX][SAFI_MAX];
596 uint8_t distance_local[AFI_MAX][SAFI_MAX];
597
598 /* BGP default local-preference. */
599 uint32_t default_local_pref;
600
601 /* BGP default subgroup pkt queue max */
602 uint32_t default_subgroup_pkt_queue_max;
603
604 /* BGP default timer. */
605 uint32_t default_holdtime;
606 uint32_t default_keepalive;
607 uint32_t default_connect_retry;
608 uint32_t default_delayopen;
609
610 /* BGP minimum holdtime. */
611 uint16_t default_min_holdtime;
612
613 /* BGP graceful restart */
614 uint32_t restart_time;
615 uint32_t stalepath_time;
616 uint32_t select_defer_time;
617 struct graceful_restart_info gr_info[AFI_MAX][SAFI_MAX];
618 uint32_t rib_stale_time;
619
620 /* BGP Long-lived Graceful Restart */
621 uint32_t llgr_stale_time;
622
623 #define BGP_ROUTE_SELECT_DELAY 1
624 #define BGP_MAX_BEST_ROUTE_SELECT 10000
625 /* Maximum-paths configuration */
626 struct bgp_maxpaths_cfg {
627 uint16_t maxpaths_ebgp;
628 uint16_t maxpaths_ibgp;
629 bool same_clusterlen;
630 } maxpaths[AFI_MAX][SAFI_MAX];
631
632 _Atomic uint32_t wpkt_quanta; // max # packets to write per i/o cycle
633 _Atomic uint32_t rpkt_quanta; // max # packets to read per i/o cycle
634
635 /* Automatic coalesce adjust on/off */
636 bool heuristic_coalesce;
637 /* Actual coalesce time */
638 uint32_t coalesce_time;
639
640 /* Auto-shutdown new peers */
641 bool autoshutdown;
642
643 struct bgp_addpath_bgp_data tx_addpath;
644
645 #ifdef ENABLE_BGP_VNC
646 struct rfapi_cfg *rfapi_cfg;
647 struct rfapi *rfapi;
648 #endif
649
650 /* EVPN related information */
651
652 /* EVI hash table */
653 struct hash *vnihash;
654
655 /*
656 * VNI hash table based on SVI ifindex as its key.
657 * We use SVI ifindex as key to lookup a VNI table for gateway IP
658 * overlay index recursive lookup.
659 * For this purpose, a hashtable is added which optimizes this lookup.
660 */
661 struct hash *vni_svi_hash;
662
663 /* EVPN enable - advertise gateway macip routes */
664 int advertise_gw_macip;
665
666 /* EVPN enable - advertise local VNIs and their MACs etc. */
667 int advertise_all_vni;
668
669 /* draft-ietf-idr-deprecate-as-set-confed-set
670 * Reject aspaths with AS_SET and/or AS_CONFED_SET.
671 */
672 bool reject_as_sets;
673
674 struct bgp_evpn_info *evpn_info;
675
676 /* EVPN - use RFC 8365 to auto-derive RT */
677 int advertise_autort_rfc8365;
678
679 /*
680 * Flooding mechanism for BUM packets for VxLAN-EVPN.
681 */
682 enum vxlan_flood_control vxlan_flood_ctrl;
683
684 /* Hash table of Import RTs to EVIs */
685 struct hash *import_rt_hash;
686
687 /* Hash table of VRF import RTs to VRFs */
688 struct hash *vrf_import_rt_hash;
689
690 /* L3-VNI corresponding to this vrf */
691 vni_t l3vni;
692
693 /* router-mac to be used in mac-ip routes for this vrf */
694 struct ethaddr rmac;
695
696 /* originator ip - to be used as NH for type-5 routes */
697 struct in_addr originator_ip;
698
699 /* SVI associated with the L3-VNI corresponding to this vrf */
700 ifindex_t l3vni_svi_ifindex;
701
702 /* RB tree of ES-VRFs */
703 struct bgp_es_vrf_rb_head es_vrf_rb_tree;
704
705 /* Hash table of EVPN nexthops maintained per-tenant-VRF */
706 struct hash *evpn_nh_table;
707
708 /*
709 * Flag resolve_overlay_index is used for recursive resolution
710 * procedures for EVPN type-5 route's gateway IP overlay index.
711 * When this flag is set, we build remote-ip-hash for
712 * all L2VNIs and resolve overlay index nexthops using this hash.
713 * Overlay index nexthops remain unresolved if this flag is not set.
714 */
715 bool resolve_overlay_index;
716
717 /* vrf flags */
718 uint32_t vrf_flags;
719 #define BGP_VRF_AUTO (1 << 0)
720 #define BGP_VRF_IMPORT_RT_CFGD (1 << 1)
721 #define BGP_VRF_EXPORT_RT_CFGD (1 << 2)
722 #define BGP_VRF_RD_CFGD (1 << 3)
723 #define BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY (1 << 4)
724
725 /* unique ID for auto derivation of RD for this vrf */
726 uint16_t vrf_rd_id;
727
728 /* Automatically derived RD for this VRF */
729 struct prefix_rd vrf_prd_auto;
730
731 /* RD for this VRF */
732 struct prefix_rd vrf_prd;
733
734 /* import rt list for the vrf instance */
735 struct list *vrf_import_rtl;
736
737 /* export rt list for the vrf instance */
738 struct list *vrf_export_rtl;
739
740 /* list of corresponding l2vnis (struct bgpevpn) */
741 struct list *l2vnis;
742
743 /* route map for advertise ipv4/ipv6 unicast (type-5 routes) */
744 struct bgp_rmap adv_cmd_rmap[AFI_MAX][SAFI_MAX];
745
746 struct vpn_policy vpn_policy[AFI_MAX];
747
748 struct bgp_pbr_config *bgp_pbr_cfg;
749
750 /* Count of peers in established state */
751 uint32_t established_peers;
752
753 /* Weighted ECMP related config. */
754 enum bgp_link_bw_handling lb_handling;
755
756 /* Process Queue for handling routes */
757 struct work_queue *process_queue;
758
759 bool fast_convergence;
760
761 /* BGP Conditional advertisement */
762 uint32_t condition_check_period;
763 uint32_t condition_filter_count;
764 struct thread *t_condition_check;
765
766 /* BGP VPN SRv6 backend */
767 bool srv6_enabled;
768 char srv6_locator_name[SRV6_LOCNAME_SIZE];
769 struct list *srv6_locator_chunks;
770 struct list *srv6_functions;
771
772 struct timeval ebgprequirespolicywarning;
773 #define FIFTEENMINUTE2USEC (int64_t)15 * 60 * 1000000
774
775 bool allow_martian;
776
777 QOBJ_FIELDS;
778 };
779 DECLARE_QOBJ_TYPE(bgp);
780
781 DECLARE_HOOK(bgp_inst_delete, (struct bgp *bgp), (bgp));
782 DECLARE_HOOK(bgp_inst_config_write,
783 (struct bgp *bgp, struct vty *vty),
784 (bgp, vty));
785 DECLARE_HOOK(bgp_config_end, (struct bgp *bgp), (bgp));
786
787 /* Thread callback information */
788 struct afi_safi_info {
789 afi_t afi;
790 safi_t safi;
791 struct bgp *bgp;
792 };
793
794 #define BGP_ROUTE_ADV_HOLD(bgp) (bgp->main_peers_update_hold)
795
796 #define IS_BGP_INST_KNOWN_TO_ZEBRA(bgp) \
797 (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT \
798 || (bgp->inst_type == BGP_INSTANCE_TYPE_VRF \
799 && bgp->vrf_id != VRF_UNKNOWN))
800
801 #define BGP_SELECT_DEFER_DISABLE(bgp) \
802 (CHECK_FLAG(bgp->flags, BGP_FLAG_SELECT_DEFER_DISABLE))
803
804 #define BGP_SUPPRESS_FIB_ENABLED(bgp) \
805 (CHECK_FLAG(bgp->flags, BGP_FLAG_SUPPRESS_FIB_PENDING) \
806 || bm->wait_for_fib)
807
808 /* BGP peer-group support. */
809 struct peer_group {
810 /* Name of the peer-group. */
811 char *name;
812
813 /* Pointer to BGP. */
814 struct bgp *bgp;
815
816 /* Peer-group client list. */
817 struct list *peer;
818
819 /** Dynamic neighbor listening ranges */
820 struct list *listen_range[AFI_MAX];
821
822 /* Peer-group config */
823 struct peer *conf;
824 };
825
826 /* BGP Notify message format. */
827 struct bgp_notify {
828 uint8_t code;
829 uint8_t subcode;
830 char *data;
831 bgp_size_t length;
832 uint8_t *raw_data;
833 bool hard_reset;
834 };
835
836 /* Next hop self address. */
837 struct bgp_nexthop {
838 struct interface *ifp;
839 struct in_addr v4;
840 struct in6_addr v6_global;
841 struct in6_addr v6_local;
842 };
843
844 /* BGP addpath values */
845 #define BGP_ADDPATH_RX 1
846 #define BGP_ADDPATH_TX 2
847 #define BGP_ADDPATH_ID_LEN 4
848
849 #define BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE 1
850
851 /* Route map direction */
852 #define RMAP_IN 0
853 #define RMAP_OUT 1
854 #define RMAP_MAX 2
855
856 #define BGP_DEFAULT_TTL 1
857 #define BGP_GTSM_HOPS_DISABLED 0
858 #define BGP_GTSM_HOPS_CONNECTED 1
859
860 /* Advertise map */
861 #define CONDITION_NON_EXIST false
862 #define CONDITION_EXIST true
863
864 enum update_type { UPDATE_TYPE_WITHDRAW, UPDATE_TYPE_ADVERTISE };
865
866 #include "filter.h"
867
868 /* BGP filter structure. */
869 struct bgp_filter {
870 /* Distribute-list. */
871 struct {
872 char *name;
873 struct access_list *alist;
874 } dlist[FILTER_MAX];
875
876 /* Prefix-list. */
877 struct {
878 char *name;
879 struct prefix_list *plist;
880 } plist[FILTER_MAX];
881
882 /* Filter-list. */
883 struct {
884 char *name;
885 struct as_list *aslist;
886 } aslist[FILTER_MAX];
887
888 /* Route-map. */
889 struct {
890 char *name;
891 struct route_map *map;
892 } map[RMAP_MAX];
893
894 /* Unsuppress-map. */
895 struct {
896 char *name;
897 struct route_map *map;
898 } usmap;
899
900 /* Advertise-map */
901 struct {
902 char *aname;
903 struct route_map *amap;
904
905 bool condition;
906
907 char *cname;
908 struct route_map *cmap;
909
910 enum update_type update_type;
911 } advmap;
912 };
913
914 /* IBGP/EBGP identifier. We also have a CONFED peer, which is to say,
915 a peer who's AS is part of our Confederation. */
916 enum bgp_peer_sort {
917 BGP_PEER_UNSPECIFIED,
918 BGP_PEER_IBGP,
919 BGP_PEER_EBGP,
920 BGP_PEER_INTERNAL,
921 BGP_PEER_CONFED,
922 };
923
924 /* BGP message header and packet size. */
925 #define BGP_MARKER_SIZE 16
926 #define BGP_HEADER_SIZE 19
927 #define BGP_STANDARD_MESSAGE_MAX_PACKET_SIZE 4096
928 #define BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE 65535
929 #define BGP_MAX_PACKET_SIZE BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
930 #define BGP_MAX_PACKET_SIZE_OVERFLOW 1024
931
932 /*
933 * Trigger delay for bgp_announce_route().
934 */
935 #define BGP_ANNOUNCE_ROUTE_SHORT_DELAY_MS 100
936 #define BGP_ANNOUNCE_ROUTE_DELAY_MS 500
937
938 struct peer_af {
939 /* back pointer to the peer */
940 struct peer *peer;
941
942 /* which subgroup the peer_af belongs to */
943 struct update_subgroup *subgroup;
944
945 /* for being part of an update subgroup's peer list */
946 LIST_ENTRY(peer_af) subgrp_train;
947
948 /* for being part of a packet's peer list */
949 LIST_ENTRY(peer_af) pkt_train;
950
951 struct bpacket *next_pkt_to_send;
952
953 /*
954 * Trigger timer for bgp_announce_route().
955 */
956 struct thread *t_announce_route;
957
958 afi_t afi;
959 safi_t safi;
960 int afid;
961 };
962 /* BGP GR per peer ds */
963
964 #define BGP_PEER_GR_MODE 5
965 #define BGP_PEER_GR_EVENT_CMD 6
966
967 enum peer_mode {
968 PEER_HELPER = 0,
969 PEER_GR,
970 PEER_DISABLE,
971 PEER_INVALID,
972 PEER_GLOBAL_INHERIT /* This is the default mode */
973
974 };
975
976 enum peer_gr_command {
977 PEER_GR_CMD = 0,
978 NO_PEER_GR_CMD,
979 PEER_DISABLE_CMD,
980 NO_PEER_DISABLE_CMD,
981 PEER_HELPER_CMD,
982 NO_PEER_HELPER_CMD
983 };
984
985 typedef unsigned int (*bgp_peer_gr_action_ptr)(struct peer *, int, int);
986
987 struct bgp_peer_gr {
988 enum peer_mode next_state;
989 bgp_peer_gr_action_ptr action_fun;
990 };
991
992 /*
993 * BGP FSM event codes, per RFC 4271 ss. 8.1
994 */
995 enum bgp_fsm_rfc_codes {
996 BGP_FSM_ManualStart = 1,
997 BGP_FSM_ManualStop = 2,
998 BGP_FSM_AutomaticStart = 3,
999 BGP_FSM_ManualStart_with_PassiveTcpEstablishment = 4,
1000 BGP_FSM_AutomaticStart_with_PassiveTcpEstablishment = 5,
1001 BGP_FSM_AutomaticStart_with_DampPeerOscillations = 6,
1002 BGP_FSM_AutomaticStart_with_DampPeerOscillations_and_PassiveTcpEstablishment =
1003 7,
1004 BGP_FSM_AutomaticStop = 8,
1005 BGP_FSM_ConnectRetryTimer_Expires = 9,
1006 BGP_FSM_HoldTimer_Expires = 10,
1007 BGP_FSM_KeepaliveTimer_Expires = 11,
1008 BGP_FSM_DelayOpenTimer_Expires = 12,
1009 BGP_FSM_IdleHoldTimer_Expires = 13,
1010 BGP_FSM_TcpConnection_Valid = 14,
1011 BGP_FSM_Tcp_CR_Invalid = 15,
1012 BGP_FSM_Tcp_CR_Acked = 16,
1013 BGP_FSM_TcpConnectionConfirmed = 17,
1014 BGP_FSM_TcpConnectionFails = 18,
1015 BGP_FSM_BGPOpen = 19,
1016 BGP_FSM_BGPOpen_with_DelayOpenTimer_running = 20,
1017 BGP_FSM_BGPHeaderErr = 21,
1018 BGP_FSM_BGPOpenMsgErr = 22,
1019 BGP_FSM_OpenCollisionDump = 23,
1020 BGP_FSM_NotifMsgVerErr = 24,
1021 BGP_FSM_NotifMsg = 25,
1022 BGP_FSM_KeepAliveMsg = 26,
1023 BGP_FSM_UpdateMsg = 27,
1024 BGP_FSM_UpdateMsgErr = 28
1025 };
1026
1027 /*
1028 * BGP finite state machine events
1029 *
1030 * Note: these do not correspond to RFC-defined event codes. Those are
1031 * defined elsewhere.
1032 */
1033 enum bgp_fsm_events {
1034 BGP_Start = 1,
1035 BGP_Stop,
1036 TCP_connection_open,
1037 TCP_connection_open_w_delay,
1038 TCP_connection_closed,
1039 TCP_connection_open_failed,
1040 TCP_fatal_error,
1041 ConnectRetry_timer_expired,
1042 Hold_Timer_expired,
1043 KeepAlive_timer_expired,
1044 DelayOpen_timer_expired,
1045 Receive_OPEN_message,
1046 Receive_KEEPALIVE_message,
1047 Receive_UPDATE_message,
1048 Receive_NOTIFICATION_message,
1049 Clearing_Completed,
1050 BGP_EVENTS_MAX,
1051 };
1052
1053 /* BGP finite state machine status. */
1054 enum bgp_fsm_status {
1055 Idle = 1,
1056 Connect,
1057 Active,
1058 OpenSent,
1059 OpenConfirm,
1060 Established,
1061 Clearing,
1062 Deleted,
1063 BGP_STATUS_MAX,
1064 };
1065
1066 #define PEER_HOSTNAME(peer) ((peer)->host ? (peer)->host : "(unknown peer)")
1067
1068 struct llgr_info {
1069 uint32_t stale_time;
1070 uint8_t flags;
1071 };
1072
1073 /* BGP neighbor structure. */
1074 struct peer {
1075 /* BGP structure. */
1076 struct bgp *bgp;
1077
1078 /* reference count, primarily to allow bgp_process'ing of route_node's
1079 * to be done after a struct peer is deleted.
1080 *
1081 * named 'lock' for hysterical reasons within Quagga.
1082 */
1083 int lock;
1084
1085 /* BGP peer group. */
1086 struct peer_group *group;
1087 uint64_t version[AFI_MAX][SAFI_MAX];
1088
1089 /* BGP peer_af structures, per configured AF on this peer */
1090 struct peer_af *peer_af_array[BGP_AF_MAX];
1091
1092 /* Peer's remote AS number. */
1093 int as_type;
1094 as_t as;
1095
1096 /* Peer's local AS number. */
1097 as_t local_as;
1098
1099 enum bgp_peer_sort sort;
1100
1101 /* Peer's Change local AS number. */
1102 as_t change_local_as;
1103
1104 /* Remote router ID. */
1105 struct in_addr remote_id;
1106
1107 /* Local router ID. */
1108 struct in_addr local_id;
1109
1110 /* Packet receive and send buffer. */
1111 pthread_mutex_t io_mtx; // guards ibuf, obuf
1112 struct stream_fifo *ibuf; // packets waiting to be processed
1113 struct stream_fifo *obuf; // packets waiting to be written
1114
1115 /* used as a block to deposit raw wire data to */
1116 uint8_t ibuf_scratch[BGP_EXTENDED_MESSAGE_MAX_PACKET_SIZE
1117 * BGP_READ_PACKET_MAX];
1118 struct ringbuf *ibuf_work; // WiP buffer used by bgp_read() only
1119 struct stream *obuf_work; // WiP buffer used to construct packets
1120
1121 struct stream *curr; // the current packet being parsed
1122
1123 /* We use a separate stream to encode MP_REACH_NLRI for efficient
1124 * NLRI packing. peer->obuf_work stores all the other attributes. The
1125 * actual packet is then constructed by concatenating the two.
1126 */
1127 struct stream *scratch;
1128
1129 /* the doppelganger peer structure, due to dual TCP conn setup */
1130 struct peer *doppelganger;
1131
1132 /* Status of the peer. */
1133 enum bgp_fsm_status status;
1134 enum bgp_fsm_status ostatus;
1135
1136 /* FSM events, stored for debug purposes.
1137 * Note: uchar used for reduced memory usage.
1138 */
1139 enum bgp_fsm_events cur_event;
1140 enum bgp_fsm_events last_event;
1141 enum bgp_fsm_events last_major_event;
1142
1143 /* Peer index, used for dumping TABLE_DUMP_V2 format */
1144 uint16_t table_dump_index;
1145
1146 /* Peer information */
1147 int fd; /* File descriptor */
1148 int ttl; /* TTL of TCP connection to the peer. */
1149 int rtt; /* Estimated round-trip-time from TCP_INFO */
1150 int rtt_expected; /* Expected round-trip-time for a peer */
1151 uint8_t rtt_keepalive_rcv; /* Received count for RTT shutdown */
1152 uint8_t rtt_keepalive_conf; /* Configured count for RTT shutdown */
1153 int gtsm_hops; /* minimum hopcount to peer */
1154 char *desc; /* Description of the peer. */
1155 unsigned short port; /* Destination port for peer */
1156 char *host; /* Printable address of the peer. */
1157 union sockunion su; /* Sockunion address of the peer. */
1158 #define BGP_PEER_SU_UNSPEC(peer) (peer->su.sa.sa_family == AF_UNSPEC)
1159 time_t uptime; /* Last Up/Down time */
1160 time_t readtime; /* Last read time */
1161 time_t resettime; /* Last reset time */
1162
1163 char *conf_if; /* neighbor interface config name. */
1164 struct interface *ifp; /* corresponding interface */
1165 char *ifname; /* bind interface name. */
1166 char *update_if;
1167 union sockunion *update_source;
1168
1169 union sockunion *su_local; /* Sockunion of local address. */
1170 union sockunion *su_remote; /* Sockunion of remote address. */
1171 int shared_network; /* Is this peer shared same network. */
1172 struct bgp_nexthop nexthop; /* Nexthop */
1173
1174 /* Roles in bgp session */
1175 uint8_t local_role;
1176 uint8_t remote_role;
1177 #define ROLE_PROVIDER 0
1178 #define ROLE_RS_SERVER 1
1179 #define ROLE_RS_CLIENT 2
1180 #define ROLE_CUSTOMER 3
1181 #define ROLE_PEER 4
1182 #define ROLE_UNDEFINED 255
1183
1184 #define ROLE_NAME_MAX_LEN 20
1185
1186 /* Peer address family configuration. */
1187 uint8_t afc[AFI_MAX][SAFI_MAX];
1188 uint8_t afc_nego[AFI_MAX][SAFI_MAX];
1189 uint8_t afc_adv[AFI_MAX][SAFI_MAX];
1190 uint8_t afc_recv[AFI_MAX][SAFI_MAX];
1191
1192 /* Capability flags (reset in bgp_stop) */
1193 uint32_t cap;
1194 #define PEER_CAP_REFRESH_ADV (1U << 0) /* refresh advertised */
1195 #define PEER_CAP_REFRESH_OLD_RCV (1U << 1) /* refresh old received */
1196 #define PEER_CAP_REFRESH_NEW_RCV (1U << 2) /* refresh rfc received */
1197 #define PEER_CAP_DYNAMIC_ADV (1U << 3) /* dynamic advertised */
1198 #define PEER_CAP_DYNAMIC_RCV (1U << 4) /* dynamic received */
1199 #define PEER_CAP_RESTART_ADV (1U << 5) /* restart advertised */
1200 #define PEER_CAP_RESTART_RCV (1U << 6) /* restart received */
1201 #define PEER_CAP_AS4_ADV (1U << 7) /* as4 advertised */
1202 #define PEER_CAP_AS4_RCV (1U << 8) /* as4 received */
1203 /* sent graceful-restart restart (R) bit */
1204 #define PEER_CAP_GRACEFUL_RESTART_R_BIT_ADV (1U << 9)
1205 /* received graceful-restart restart (R) bit */
1206 #define PEER_CAP_GRACEFUL_RESTART_R_BIT_RCV (1U << 10)
1207 #define PEER_CAP_ADDPATH_ADV (1U << 11) /* addpath advertised */
1208 #define PEER_CAP_ADDPATH_RCV (1U << 12) /* addpath received */
1209 #define PEER_CAP_ENHE_ADV (1U << 13) /* Extended nexthop advertised */
1210 #define PEER_CAP_ENHE_RCV (1U << 14) /* Extended nexthop received */
1211 #define PEER_CAP_HOSTNAME_ADV (1U << 15) /* hostname advertised */
1212 #define PEER_CAP_HOSTNAME_RCV (1U << 16) /* hostname received */
1213 #define PEER_CAP_ENHANCED_RR_ADV (1U << 17) /* enhanced rr advertised */
1214 #define PEER_CAP_ENHANCED_RR_RCV (1U << 18) /* enhanced rr received */
1215 #define PEER_CAP_EXTENDED_MESSAGE_ADV (1U << 19)
1216 #define PEER_CAP_EXTENDED_MESSAGE_RCV (1U << 20)
1217 #define PEER_CAP_LLGR_ADV (1U << 21)
1218 #define PEER_CAP_LLGR_RCV (1U << 22)
1219 /* sent graceful-restart notification (N) bit */
1220 #define PEER_CAP_GRACEFUL_RESTART_N_BIT_ADV (1U << 23)
1221 /* received graceful-restart notification (N) bit */
1222 #define PEER_CAP_GRACEFUL_RESTART_N_BIT_RCV (1U << 24)
1223 #define PEER_CAP_ROLE_ADV (1U << 25) /* role advertised */
1224 #define PEER_CAP_ROLE_RCV (1U << 26) /* role received */
1225
1226 /* Capability flags (reset in bgp_stop) */
1227 uint32_t af_cap[AFI_MAX][SAFI_MAX];
1228 #define PEER_CAP_ORF_PREFIX_SM_ADV (1U << 0) /* send-mode advertised */
1229 #define PEER_CAP_ORF_PREFIX_RM_ADV (1U << 1) /* receive-mode advertised */
1230 #define PEER_CAP_ORF_PREFIX_SM_RCV (1U << 2) /* send-mode received */
1231 #define PEER_CAP_ORF_PREFIX_RM_RCV (1U << 3) /* receive-mode received */
1232 #define PEER_CAP_ORF_PREFIX_SM_OLD_RCV (1U << 4) /* send-mode received */
1233 #define PEER_CAP_ORF_PREFIX_RM_OLD_RCV (1U << 5) /* receive-mode received */
1234 #define PEER_CAP_RESTART_AF_RCV (1U << 6) /* graceful restart afi/safi received */
1235 #define PEER_CAP_RESTART_AF_PRESERVE_RCV (1U << 7) /* graceful restart afi/safi F-bit received */
1236 #define PEER_CAP_ADDPATH_AF_TX_ADV (1U << 8) /* addpath tx advertised */
1237 #define PEER_CAP_ADDPATH_AF_TX_RCV (1U << 9) /* addpath tx received */
1238 #define PEER_CAP_ADDPATH_AF_RX_ADV (1U << 10) /* addpath rx advertised */
1239 #define PEER_CAP_ADDPATH_AF_RX_RCV (1U << 11) /* addpath rx received */
1240 #define PEER_CAP_ENHE_AF_ADV (1U << 12) /* Extended nexthopi afi/safi advertised */
1241 #define PEER_CAP_ENHE_AF_RCV (1U << 13) /* Extended nexthop afi/safi received */
1242 #define PEER_CAP_ENHE_AF_NEGO (1U << 14) /* Extended nexthop afi/safi negotiated */
1243 #define PEER_CAP_LLGR_AF_ADV (1U << 15)
1244 #define PEER_CAP_LLGR_AF_RCV (1U << 16)
1245
1246 /* Global configuration flags. */
1247 /*
1248 * Parallel array to flags that indicates whether each flag originates
1249 * from a peer-group or if it is config that is specific to this
1250 * individual peer. If a flag is set independent of the peer-group, the
1251 * same bit should be set here. If this peer is a peer-group, this
1252 * memory region should be all zeros.
1253 *
1254 * The assumption is that the default state for all flags is unset,
1255 * so if a flag is unset, the corresponding override flag is unset too.
1256 * However if a flag is set, the corresponding override flag is set.
1257 */
1258 uint32_t flags_override;
1259 /*
1260 * Parallel array to flags that indicates whether the default behavior
1261 * of *flags_override* should be inverted. If a flag is unset and the
1262 * corresponding invert flag is set, the corresponding override flag
1263 * would be set. However if a flag is set and the corresponding invert
1264 * flag is unset, the corresponding override flag would be unset.
1265 *
1266 * This can be used for attributes like *send-community*, which are
1267 * implicitely enabled and have to be disabled explicitely, compared to
1268 * 'normal' attributes like *next-hop-self* which are implicitely set.
1269 *
1270 * All operations dealing with flags should apply the following boolean
1271 * logic to keep the internal flag system in a sane state:
1272 *
1273 * value=0 invert=0 Inherit flag if member, otherwise unset flag
1274 * value=0 invert=1 Unset flag unconditionally
1275 * value=1 invert=0 Set flag unconditionally
1276 * value=1 invert=1 Inherit flag if member, otherwise set flag
1277 *
1278 * Contrary to the implementation of *flags_override*, the flag
1279 * inversion state can be set either on the peer OR the peer *and* the
1280 * peer-group. This was done on purpose, as the inversion state of a
1281 * flag can be determined on either the peer or the peer-group.
1282 *
1283 * Example: Enabling the cisco configuration mode inverts all flags
1284 * related to *send-community* unconditionally for both peer-groups and
1285 * peers.
1286 *
1287 * This behavior is different for interface peers though, which enable
1288 * the *extended-nexthop* flag by default, which regular peers do not.
1289 * As the peer-group can contain both regular and interface peers, the
1290 * flag inversion state must be set on the peer only.
1291 *
1292 * When a peer inherits the configuration from a peer-group and the
1293 * inversion state of the flag differs between peer and peer-group, the
1294 * newly set value must equal to the inverted state of the peer-group.
1295 */
1296 uint32_t flags_invert;
1297 /*
1298 * Effective array for storing the peer/peer-group flags. In case of a
1299 * peer-group, the peer-specific overrides (see flags_override and
1300 * flags_invert) must be respected.
1301 */
1302 uint64_t flags;
1303 #define PEER_FLAG_PASSIVE (1ULL << 0) /* passive mode */
1304 #define PEER_FLAG_SHUTDOWN (1ULL << 1) /* shutdown */
1305 #define PEER_FLAG_DONT_CAPABILITY (1ULL << 2) /* dont-capability */
1306 #define PEER_FLAG_OVERRIDE_CAPABILITY (1ULL << 3) /* override-capability */
1307 #define PEER_FLAG_STRICT_CAP_MATCH (1ULL << 4) /* strict-match */
1308 #define PEER_FLAG_DYNAMIC_CAPABILITY (1ULL << 5) /* dynamic capability */
1309 #define PEER_FLAG_DISABLE_CONNECTED_CHECK (1ULL << 6) /* disable-connected-check */
1310 #define PEER_FLAG_LOCAL_AS_NO_PREPEND (1ULL << 7) /* local-as no-prepend */
1311 #define PEER_FLAG_LOCAL_AS_REPLACE_AS (1ULL << 8) /* local-as no-prepend replace-as */
1312 #define PEER_FLAG_DELETE (1ULL << 9) /* mark the peer for deleting */
1313 #define PEER_FLAG_CONFIG_NODE (1ULL << 10) /* the node to update configs on */
1314 #define PEER_FLAG_LONESOUL (1ULL << 11)
1315 #define PEER_FLAG_DYNAMIC_NEIGHBOR (1ULL << 12) /* dynamic neighbor */
1316 #define PEER_FLAG_CAPABILITY_ENHE (1ULL << 13) /* Extended next-hop (rfc 5549)*/
1317 #define PEER_FLAG_IFPEER_V6ONLY (1ULL << 14) /* if-based peer is v6 only */
1318 #define PEER_FLAG_IS_RFAPI_HD (1ULL << 15) /* attached to rfapi HD */
1319 #define PEER_FLAG_ENFORCE_FIRST_AS (1ULL << 16) /* enforce-first-as */
1320 #define PEER_FLAG_ROUTEADV (1ULL << 17) /* route advertise */
1321 #define PEER_FLAG_TIMER (1ULL << 18) /* keepalive & holdtime */
1322 #define PEER_FLAG_TIMER_CONNECT (1ULL << 19) /* connect timer */
1323 #define PEER_FLAG_PASSWORD (1ULL << 20) /* password */
1324 #define PEER_FLAG_LOCAL_AS (1ULL << 21) /* local-as */
1325 #define PEER_FLAG_UPDATE_SOURCE (1ULL << 22) /* update-source */
1326
1327 /* BGP-GR Peer related flags */
1328 #define PEER_FLAG_GRACEFUL_RESTART_HELPER (1ULL << 23) /* Helper */
1329 #define PEER_FLAG_GRACEFUL_RESTART (1ULL << 24) /* Graceful Restart */
1330 #define PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT (1ULL << 25) /* Global-Inherit */
1331 #define PEER_FLAG_RTT_SHUTDOWN (1ULL << 26) /* shutdown rtt */
1332 #define PEER_FLAG_TIMER_DELAYOPEN (1ULL << 27) /* delayopen timer */
1333 #define PEER_FLAG_TCP_MSS (1ULL << 28) /* tcp-mss */
1334 /* Disable IEEE floating-point link bandwidth encoding in
1335 * extended communities.
1336 */
1337 #define PEER_FLAG_DISABLE_LINK_BW_ENCODING_IEEE (1ULL << 29)
1338 /* force the extended format for Optional Parameters in OPEN message */
1339 #define PEER_FLAG_EXTENDED_OPT_PARAMS (1ULL << 30)
1340
1341 /* BGP Open Policy flags.
1342 * Enforce using roles on both sides:
1343 * `local-role ROLE strict-mode` configured.
1344 */
1345 #define PEER_FLAG_ROLE_STRICT_MODE (1ULL << 31)
1346 /* `local-role` configured */
1347 #define PEER_FLAG_ROLE (1ULL << 32)
1348 #define PEER_FLAG_PORT (1ULL << 33)
1349
1350 /*
1351 *GR-Disabled mode means unset PEER_FLAG_GRACEFUL_RESTART
1352 *& PEER_FLAG_GRACEFUL_RESTART_HELPER
1353 *and PEER_FLAG_GRACEFUL_RESTART_GLOBAL_INHERIT
1354 */
1355
1356 struct bgp_peer_gr PEER_GR_FSM[BGP_PEER_GR_MODE][BGP_PEER_GR_EVENT_CMD];
1357 enum peer_mode peer_gr_present_state;
1358 /* Non stop forwarding afi-safi count for BGP gr feature*/
1359 uint8_t nsf_af_count;
1360
1361 uint8_t peer_gr_new_status_flag;
1362 #define PEER_GRACEFUL_RESTART_NEW_STATE_HELPER (1U << 0)
1363 #define PEER_GRACEFUL_RESTART_NEW_STATE_RESTART (1U << 1)
1364 #define PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT (1U << 2)
1365
1366 /* outgoing message sent in CEASE_ADMIN_SHUTDOWN notify */
1367 char *tx_shutdown_message;
1368
1369 /* NSF mode (graceful restart) */
1370 uint8_t nsf[AFI_MAX][SAFI_MAX];
1371 /* EOR Send time */
1372 time_t eor_stime[AFI_MAX][SAFI_MAX];
1373 /* Last update packet sent time */
1374 time_t pkt_stime[AFI_MAX][SAFI_MAX];
1375
1376 /* Peer Per AF flags */
1377 /*
1378 * Please consult the comments for *flags_override*, *flags_invert* and
1379 * *flags* to understand what these three arrays do. The address-family
1380 * specific attributes are being treated the exact same way as global
1381 * peer attributes.
1382 */
1383 uint32_t af_flags_override[AFI_MAX][SAFI_MAX];
1384 uint32_t af_flags_invert[AFI_MAX][SAFI_MAX];
1385 uint32_t af_flags[AFI_MAX][SAFI_MAX];
1386 #define PEER_FLAG_SEND_COMMUNITY (1U << 0) /* send-community */
1387 #define PEER_FLAG_SEND_EXT_COMMUNITY (1U << 1) /* send-community ext. */
1388 #define PEER_FLAG_NEXTHOP_SELF (1U << 2) /* next-hop-self */
1389 #define PEER_FLAG_REFLECTOR_CLIENT (1U << 3) /* reflector-client */
1390 #define PEER_FLAG_RSERVER_CLIENT (1U << 4) /* route-server-client */
1391 #define PEER_FLAG_SOFT_RECONFIG (1U << 5) /* soft-reconfiguration */
1392 #define PEER_FLAG_AS_PATH_UNCHANGED (1U << 6) /* transparent-as */
1393 #define PEER_FLAG_NEXTHOP_UNCHANGED (1U << 7) /* transparent-next-hop */
1394 #define PEER_FLAG_MED_UNCHANGED (1U << 8) /* transparent-next-hop */
1395 #define PEER_FLAG_DEFAULT_ORIGINATE (1U << 9) /* default-originate */
1396 #define PEER_FLAG_REMOVE_PRIVATE_AS (1U << 10) /* remove-private-as */
1397 #define PEER_FLAG_ALLOWAS_IN (1U << 11) /* set allowas-in */
1398 #define PEER_FLAG_ORF_PREFIX_SM (1U << 12) /* orf capability send-mode */
1399 #define PEER_FLAG_ORF_PREFIX_RM (1U << 13) /* orf capability receive-mode */
1400 #define PEER_FLAG_MAX_PREFIX (1U << 14) /* maximum prefix */
1401 #define PEER_FLAG_MAX_PREFIX_WARNING (1U << 15) /* maximum prefix warning-only */
1402 #define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED (1U << 16) /* leave link-local nexthop unchanged */
1403 #define PEER_FLAG_FORCE_NEXTHOP_SELF (1U << 17) /* next-hop-self force */
1404 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL (1U << 18) /* remove-private-as all */
1405 #define PEER_FLAG_REMOVE_PRIVATE_AS_REPLACE (1U << 19) /* remove-private-as replace-as */
1406 #define PEER_FLAG_AS_OVERRIDE (1U << 20) /* as-override */
1407 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL_REPLACE (1U << 21) /* remove-private-as all replace-as */
1408 #define PEER_FLAG_WEIGHT (1U << 24) /* weight */
1409 #define PEER_FLAG_ALLOWAS_IN_ORIGIN (1U << 25) /* allowas-in origin */
1410 #define PEER_FLAG_SEND_LARGE_COMMUNITY (1U << 26) /* Send large Communities */
1411 #define PEER_FLAG_MAX_PREFIX_OUT (1U << 27) /* outgoing maximum prefix */
1412 #define PEER_FLAG_MAX_PREFIX_FORCE (1U << 28) /* maximum-prefix <num> force */
1413 #define PEER_FLAG_DISABLE_ADDPATH_RX (1U << 29) /* disable-addpath-rx */
1414
1415 enum bgp_addpath_strat addpath_type[AFI_MAX][SAFI_MAX];
1416
1417 /* MD5 password */
1418 char *password;
1419
1420 /* default-originate route-map. */
1421 struct {
1422 char *name;
1423 struct route_map *map;
1424 } default_rmap[AFI_MAX][SAFI_MAX];
1425
1426 /* Peer status flags. */
1427 uint16_t sflags;
1428 #define PEER_STATUS_ACCEPT_PEER (1U << 0) /* accept peer */
1429 #define PEER_STATUS_PREFIX_OVERFLOW (1U << 1) /* prefix-overflow */
1430 #define PEER_STATUS_CAPABILITY_OPEN (1U << 2) /* capability open send */
1431 #define PEER_STATUS_HAVE_ACCEPT (1U << 3) /* accept peer's parent */
1432 #define PEER_STATUS_GROUP (1U << 4) /* peer-group conf */
1433 #define PEER_STATUS_NSF_MODE (1U << 5) /* NSF aware peer */
1434 #define PEER_STATUS_NSF_WAIT (1U << 6) /* wait comeback peer */
1435 /* received extended format encoding for OPEN message */
1436 #define PEER_STATUS_EXT_OPT_PARAMS_LENGTH (1U << 7)
1437
1438 /* Peer status af flags (reset in bgp_stop) */
1439 uint16_t af_sflags[AFI_MAX][SAFI_MAX];
1440 #define PEER_STATUS_ORF_PREFIX_SEND (1U << 0) /* prefix-list send peer */
1441 #define PEER_STATUS_ORF_WAIT_REFRESH (1U << 1) /* wait refresh received peer */
1442 #define PEER_STATUS_PREFIX_THRESHOLD (1U << 2) /* exceed prefix-threshold */
1443 #define PEER_STATUS_PREFIX_LIMIT (1U << 3) /* exceed prefix-limit */
1444 #define PEER_STATUS_EOR_SEND (1U << 4) /* end-of-rib send to peer */
1445 #define PEER_STATUS_EOR_RECEIVED (1U << 5) /* end-of-rib received from peer */
1446 #define PEER_STATUS_ENHANCED_REFRESH (1U << 6) /* Enhanced Route Refresh */
1447 #define PEER_STATUS_BORR_SEND (1U << 7) /* BoRR send to peer */
1448 #define PEER_STATUS_BORR_RECEIVED (1U << 8) /* BoRR received from peer */
1449 #define PEER_STATUS_EORR_SEND (1U << 9) /* EoRR send to peer */
1450 #define PEER_STATUS_EORR_RECEIVED (1U << 10) /* EoRR received from peer */
1451 /* LLGR aware peer */
1452 #define PEER_STATUS_LLGR_WAIT (1U << 11)
1453
1454 /* Configured timer values. */
1455 _Atomic uint32_t holdtime;
1456 _Atomic uint32_t keepalive;
1457 _Atomic uint32_t connect;
1458 _Atomic uint32_t routeadv;
1459 _Atomic uint32_t delayopen;
1460
1461 /* Timer values. */
1462 _Atomic uint32_t v_start;
1463 _Atomic uint32_t v_connect;
1464 _Atomic uint32_t v_holdtime;
1465 _Atomic uint32_t v_keepalive;
1466 _Atomic uint32_t v_routeadv;
1467 _Atomic uint32_t v_delayopen;
1468 _Atomic uint32_t v_pmax_restart;
1469 _Atomic uint32_t v_gr_restart;
1470
1471 /* Threads. */
1472 struct thread *t_read;
1473 struct thread *t_write;
1474 struct thread *t_start;
1475 struct thread *t_connect_check_r;
1476 struct thread *t_connect_check_w;
1477 struct thread *t_connect;
1478 struct thread *t_holdtime;
1479 struct thread *t_routeadv;
1480 struct thread *t_delayopen;
1481 struct thread *t_pmax_restart;
1482 struct thread *t_gr_restart;
1483 struct thread *t_gr_stale;
1484 struct thread *t_llgr_stale[AFI_MAX][SAFI_MAX];
1485 struct thread *t_generate_updgrp_packets;
1486 struct thread *t_process_packet;
1487 struct thread *t_process_packet_error;
1488 struct thread *t_refresh_stalepath;
1489
1490 /* Thread flags. */
1491 _Atomic uint32_t thread_flags;
1492 #define PEER_THREAD_WRITES_ON (1U << 0)
1493 #define PEER_THREAD_READS_ON (1U << 1)
1494 #define PEER_THREAD_KEEPALIVES_ON (1U << 2)
1495 #define PEER_THREAD_SUBGRP_ADV_DELAY (1U << 3)
1496
1497 /* workqueues */
1498 struct work_queue *clear_node_queue;
1499
1500 #define PEER_TOTAL_RX(peer) \
1501 atomic_load_explicit(&peer->open_in, memory_order_relaxed) \
1502 + atomic_load_explicit(&peer->update_in, memory_order_relaxed) \
1503 + atomic_load_explicit(&peer->notify_in, memory_order_relaxed) \
1504 + atomic_load_explicit(&peer->refresh_in, \
1505 memory_order_relaxed) \
1506 + atomic_load_explicit(&peer->keepalive_in, \
1507 memory_order_relaxed) \
1508 + atomic_load_explicit(&peer->dynamic_cap_in, \
1509 memory_order_relaxed)
1510
1511 #define PEER_TOTAL_TX(peer) \
1512 atomic_load_explicit(&peer->open_out, memory_order_relaxed) \
1513 + atomic_load_explicit(&peer->update_out, \
1514 memory_order_relaxed) \
1515 + atomic_load_explicit(&peer->notify_out, \
1516 memory_order_relaxed) \
1517 + atomic_load_explicit(&peer->refresh_out, \
1518 memory_order_relaxed) \
1519 + atomic_load_explicit(&peer->keepalive_out, \
1520 memory_order_relaxed) \
1521 + atomic_load_explicit(&peer->dynamic_cap_out, \
1522 memory_order_relaxed)
1523
1524 /* Statistics field */
1525 _Atomic uint32_t open_in; /* Open message input count */
1526 _Atomic uint32_t open_out; /* Open message output count */
1527 _Atomic uint32_t update_in; /* Update message input count */
1528 _Atomic uint32_t update_out; /* Update message ouput count */
1529 _Atomic time_t update_time; /* Update message received time. */
1530 _Atomic uint32_t keepalive_in; /* Keepalive input count */
1531 _Atomic uint32_t keepalive_out; /* Keepalive output count */
1532 _Atomic uint32_t notify_in; /* Notify input count */
1533 _Atomic uint32_t notify_out; /* Notify output count */
1534 _Atomic uint32_t refresh_in; /* Route Refresh input count */
1535 _Atomic uint32_t refresh_out; /* Route Refresh output count */
1536 _Atomic uint32_t dynamic_cap_in; /* Dynamic Capability input count. */
1537 _Atomic uint32_t dynamic_cap_out; /* Dynamic Capability output count. */
1538
1539 uint32_t stat_pfx_filter;
1540 uint32_t stat_pfx_aspath_loop;
1541 uint32_t stat_pfx_originator_loop;
1542 uint32_t stat_pfx_cluster_loop;
1543 uint32_t stat_pfx_nh_invalid;
1544 uint32_t stat_pfx_dup_withdraw;
1545 uint32_t stat_upd_7606; /* RFC7606: treat-as-withdraw */
1546
1547 /* BGP state count */
1548 uint32_t established; /* Established */
1549 uint32_t dropped; /* Dropped */
1550
1551 /* Update delay related fields */
1552 uint8_t update_delay_over; /* When this is set, BGP is no more waiting
1553 for EOR */
1554
1555 /* Syncronization list and time. */
1556 struct bgp_synchronize *sync[AFI_MAX][SAFI_MAX];
1557 time_t synctime;
1558 /* timestamp when the last UPDATE msg was written */
1559 _Atomic time_t last_write;
1560 /* timestamp when the last msg was written */
1561 _Atomic time_t last_update;
1562
1563 /* only updated under io_mtx.
1564 * last_sendq_warn is only for ratelimiting log warning messages.
1565 */
1566 time_t last_sendq_ok, last_sendq_warn;
1567
1568 /* Notify data. */
1569 struct bgp_notify notify;
1570
1571 /* Filter structure. */
1572 struct bgp_filter filter[AFI_MAX][SAFI_MAX];
1573
1574 /*
1575 * Parallel array to filter that indicates whether each filter
1576 * originates from a peer-group or if it is config that is specific to
1577 * this individual peer. If a filter is set independent of the
1578 * peer-group the appropriate bit should be set here. If this peer is a
1579 * peer-group, this memory region should be all zeros. The assumption
1580 * is that the default state for all flags is unset. Due to filters
1581 * having a direction (e.g. in/out/...), this array has a third
1582 * dimension for storing the overrides independently per direction.
1583 *
1584 * Notes:
1585 * - if a filter for an individual peer is unset, the corresponding
1586 * override flag is unset and the peer is considered to be back in
1587 * sync with the peer-group.
1588 * - This does *not* contain the filter values, rather it contains
1589 * whether the filter in filter (struct bgp_filter) is peer-specific.
1590 */
1591 uint8_t filter_override[AFI_MAX][SAFI_MAX][FILTER_MAX];
1592 #define PEER_FT_DISTRIBUTE_LIST (1U << 0) /* distribute-list */
1593 #define PEER_FT_FILTER_LIST (1U << 1) /* filter-list */
1594 #define PEER_FT_PREFIX_LIST (1U << 2) /* prefix-list */
1595 #define PEER_FT_ROUTE_MAP (1U << 3) /* route-map */
1596 #define PEER_FT_UNSUPPRESS_MAP (1U << 4) /* unsuppress-map */
1597 #define PEER_FT_ADVERTISE_MAP (1U << 5) /* advertise-map */
1598
1599 /* ORF Prefix-list */
1600 struct prefix_list *orf_plist[AFI_MAX][SAFI_MAX];
1601
1602 /* Text description of last attribute rcvd */
1603 char rcvd_attr_str[BUFSIZ];
1604
1605 /* Track if we printed the attribute in debugs */
1606 int rcvd_attr_printed;
1607
1608 /* Accepted prefix count */
1609 uint32_t pcount[AFI_MAX][SAFI_MAX];
1610
1611 /* Max prefix count. */
1612 uint32_t pmax[AFI_MAX][SAFI_MAX];
1613 uint8_t pmax_threshold[AFI_MAX][SAFI_MAX];
1614 uint16_t pmax_restart[AFI_MAX][SAFI_MAX];
1615 #define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
1616
1617 /* Send prefix count. */
1618 uint32_t pmax_out[AFI_MAX][SAFI_MAX];
1619
1620 /* allowas-in. */
1621 char allowas_in[AFI_MAX][SAFI_MAX];
1622
1623 /* weight */
1624 unsigned long weight[AFI_MAX][SAFI_MAX];
1625
1626 /* peer reset cause */
1627 uint8_t last_reset;
1628 #define PEER_DOWN_RID_CHANGE 1U /* bgp router-id command */
1629 #define PEER_DOWN_REMOTE_AS_CHANGE 2U /* neighbor remote-as command */
1630 #define PEER_DOWN_LOCAL_AS_CHANGE 3U /* neighbor local-as command */
1631 #define PEER_DOWN_CLID_CHANGE 4U /* bgp cluster-id command */
1632 #define PEER_DOWN_CONFED_ID_CHANGE 5U /* bgp confederation id command */
1633 #define PEER_DOWN_CONFED_PEER_CHANGE 6U /* bgp confederation peer command */
1634 #define PEER_DOWN_RR_CLIENT_CHANGE 7U /* neighbor rr-client command */
1635 #define PEER_DOWN_RS_CLIENT_CHANGE 8U /* neighbor rs-client command */
1636 #define PEER_DOWN_UPDATE_SOURCE_CHANGE 9U /* neighbor update-source command */
1637 #define PEER_DOWN_AF_ACTIVATE 10U /* neighbor activate command */
1638 #define PEER_DOWN_USER_SHUTDOWN 11U /* neighbor shutdown command */
1639 #define PEER_DOWN_USER_RESET 12U /* clear ip bgp command */
1640 #define PEER_DOWN_NOTIFY_RECEIVED 13U /* notification received */
1641 #define PEER_DOWN_NOTIFY_SEND 14U /* notification send */
1642 #define PEER_DOWN_CLOSE_SESSION 15U /* tcp session close */
1643 #define PEER_DOWN_NEIGHBOR_DELETE 16U /* neghbor delete */
1644 #define PEER_DOWN_RMAP_BIND 17U /* neghbor peer-group command */
1645 #define PEER_DOWN_RMAP_UNBIND 18U /* no neighbor peer-group command */
1646 #define PEER_DOWN_CAPABILITY_CHANGE 19U /* neighbor capability command */
1647 #define PEER_DOWN_PASSIVE_CHANGE 20U /* neighbor passive command */
1648 #define PEER_DOWN_MULTIHOP_CHANGE 21U /* neighbor multihop command */
1649 #define PEER_DOWN_NSF_CLOSE_SESSION 22U /* NSF tcp session close */
1650 #define PEER_DOWN_V6ONLY_CHANGE 23U /* if-based peering v6only toggled */
1651 #define PEER_DOWN_BFD_DOWN 24U /* BFD down */
1652 #define PEER_DOWN_IF_DOWN 25U /* Interface down */
1653 #define PEER_DOWN_NBR_ADDR_DEL 26U /* Peer address lost */
1654 #define PEER_DOWN_WAITING_NHT 27U /* Waiting for NHT to resolve */
1655 #define PEER_DOWN_NBR_ADDR 28U /* Waiting for peer IPv6 IP Addr */
1656 #define PEER_DOWN_VRF_UNINIT 29U /* Associated VRF is not init yet */
1657 #define PEER_DOWN_NOAFI_ACTIVATED 30U /* No AFI/SAFI activated for peer */
1658 #define PEER_DOWN_AS_SETS_REJECT 31U /* Reject routes with AS_SET */
1659 #define PEER_DOWN_WAITING_OPEN 32U /* Waiting for open to succeed */
1660 #define PEER_DOWN_PFX_COUNT 33U /* Reached received prefix count */
1661 #define PEER_DOWN_SOCKET_ERROR 34U /* Some socket error happened */
1662 /*
1663 * Remember to update peer_down_str in bgp_fsm.c when you add
1664 * a new value to the last_reset reason
1665 */
1666
1667 uint16_t last_reset_cause_size;
1668 uint8_t last_reset_cause[BGP_MAX_PACKET_SIZE];
1669
1670 /* The kind of route-map Flags.*/
1671 uint16_t rmap_type;
1672 #define PEER_RMAP_TYPE_IN (1U << 0) /* neighbor route-map in */
1673 #define PEER_RMAP_TYPE_OUT (1U << 1) /* neighbor route-map out */
1674 #define PEER_RMAP_TYPE_NETWORK (1U << 2) /* network route-map */
1675 #define PEER_RMAP_TYPE_REDISTRIBUTE (1U << 3) /* redistribute route-map */
1676 #define PEER_RMAP_TYPE_DEFAULT (1U << 4) /* default-originate route-map */
1677 #define PEER_RMAP_TYPE_NOSET (1U << 5) /* not allow to set commands */
1678 #define PEER_RMAP_TYPE_IMPORT (1U << 6) /* neighbor route-map import */
1679 #define PEER_RMAP_TYPE_EXPORT (1U << 7) /* neighbor route-map export */
1680 #define PEER_RMAP_TYPE_AGGREGATE (1U << 8) /* aggregate-address route-map */
1681
1682 /** Peer overwrite configuration. */
1683 struct bfd_session_config {
1684 /**
1685 * Manual configuration bit.
1686 *
1687 * This flag only makes sense for real peers (and not groups),
1688 * it keeps track if the user explicitly configured BFD for a
1689 * peer.
1690 */
1691 bool manual;
1692 /** Control Plane Independent. */
1693 bool cbit;
1694 /** Detection multiplier. */
1695 uint8_t detection_multiplier;
1696 /** Minimum required RX interval. */
1697 uint32_t min_rx;
1698 /** Minimum required TX interval. */
1699 uint32_t min_tx;
1700 /** Profile name. */
1701 char profile[BFD_PROFILE_NAME_LEN];
1702 /** Peer BFD session */
1703 struct bfd_session_params *session;
1704 } * bfd_config;
1705
1706 /* hostname and domainname advertised by host */
1707 char *hostname;
1708 char *domainname;
1709
1710 /* Sender side AS path loop detection. */
1711 bool as_path_loop_detection;
1712
1713 /* Extended Message Support */
1714 uint16_t max_packet_size;
1715
1716 /* Conditional advertisement */
1717 bool advmap_config_change[AFI_MAX][SAFI_MAX];
1718 bool advmap_table_change;
1719
1720 /* set TCP max segment size */
1721 uint32_t tcp_mss;
1722
1723 /* Long-lived Graceful Restart */
1724 struct llgr_info llgr[AFI_MAX][SAFI_MAX];
1725
1726 bool shut_during_cfg;
1727
1728 QOBJ_FIELDS;
1729 };
1730 DECLARE_QOBJ_TYPE(peer);
1731
1732 /* Inherit peer attribute from peer-group. */
1733 #define PEER_ATTR_INHERIT(peer, group, attr) \
1734 ((peer)->attr = (group)->conf->attr)
1735 #define PEER_STR_ATTR_INHERIT(peer, group, attr, mt) \
1736 do { \
1737 XFREE(mt, (peer)->attr); \
1738 if ((group)->conf->attr) \
1739 (peer)->attr = XSTRDUP(mt, (group)->conf->attr); \
1740 else \
1741 (peer)->attr = NULL; \
1742 } while (0)
1743 #define PEER_SU_ATTR_INHERIT(peer, group, attr) \
1744 do { \
1745 if ((peer)->attr) \
1746 sockunion_free((peer)->attr); \
1747 if ((group)->conf->attr) \
1748 (peer)->attr = sockunion_dup((group)->conf->attr); \
1749 else \
1750 (peer)->attr = NULL; \
1751 } while (0)
1752
1753 /* Check if suppress start/restart of sessions to peer. */
1754 #define BGP_PEER_START_SUPPRESSED(P) \
1755 (CHECK_FLAG((P)->flags, PEER_FLAG_SHUTDOWN) || \
1756 CHECK_FLAG((P)->sflags, PEER_STATUS_PREFIX_OVERFLOW) || \
1757 CHECK_FLAG((P)->bgp->flags, BGP_FLAG_SHUTDOWN) || \
1758 (P)->shut_during_cfg)
1759
1760 #define PEER_ROUTE_ADV_DELAY(peer) \
1761 (CHECK_FLAG(peer->thread_flags, PEER_THREAD_SUBGRP_ADV_DELAY))
1762
1763 #define PEER_PASSWORD_MINLEN (1)
1764 #define PEER_PASSWORD_MAXLEN (80)
1765
1766 /* This structure's member directly points incoming packet data
1767 stream. */
1768 struct bgp_nlri {
1769 /* AFI. */
1770 uint16_t afi; /* iana_afi_t */
1771
1772 /* SAFI. */
1773 uint8_t safi; /* iana_safi_t */
1774
1775 /* Pointer to NLRI byte stream. */
1776 uint8_t *nlri;
1777
1778 /* Length of whole NLRI. */
1779 bgp_size_t length;
1780 };
1781
1782 /* BGP versions. */
1783 #define BGP_VERSION_4 4
1784
1785 /* Default BGP port number. */
1786 #define BGP_PORT_DEFAULT 179
1787
1788 /* Extended BGP Administrative Shutdown Communication */
1789 #define BGP_ADMIN_SHUTDOWN_MSG_LEN 255
1790
1791 /* BGP minimum message size. */
1792 #define BGP_MSG_OPEN_MIN_SIZE (BGP_HEADER_SIZE + 10)
1793 #define BGP_MSG_UPDATE_MIN_SIZE (BGP_HEADER_SIZE + 4)
1794 #define BGP_MSG_NOTIFY_MIN_SIZE (BGP_HEADER_SIZE + 2)
1795 #define BGP_MSG_KEEPALIVE_MIN_SIZE (BGP_HEADER_SIZE + 0)
1796 #define BGP_MSG_ROUTE_REFRESH_MIN_SIZE (BGP_HEADER_SIZE + 4)
1797 #define BGP_MSG_CAPABILITY_MIN_SIZE (BGP_HEADER_SIZE + 3)
1798
1799 /* BGP message types. */
1800 #define BGP_MSG_OPEN 1
1801 #define BGP_MSG_UPDATE 2
1802 #define BGP_MSG_NOTIFY 3
1803 #define BGP_MSG_KEEPALIVE 4
1804 #define BGP_MSG_ROUTE_REFRESH_NEW 5
1805 #define BGP_MSG_CAPABILITY 6
1806 #define BGP_MSG_ROUTE_REFRESH_OLD 128
1807
1808 /* BGP open optional parameter. */
1809 #define BGP_OPEN_OPT_AUTH 1
1810 #define BGP_OPEN_OPT_CAP 2
1811
1812 /* BGP4 attribute type codes. */
1813 #define BGP_ATTR_ORIGIN 1
1814 #define BGP_ATTR_AS_PATH 2
1815 #define BGP_ATTR_NEXT_HOP 3
1816 #define BGP_ATTR_MULTI_EXIT_DISC 4
1817 #define BGP_ATTR_LOCAL_PREF 5
1818 #define BGP_ATTR_ATOMIC_AGGREGATE 6
1819 #define BGP_ATTR_AGGREGATOR 7
1820 #define BGP_ATTR_COMMUNITIES 8
1821 #define BGP_ATTR_ORIGINATOR_ID 9
1822 #define BGP_ATTR_CLUSTER_LIST 10
1823 #define BGP_ATTR_MP_REACH_NLRI 14
1824 #define BGP_ATTR_MP_UNREACH_NLRI 15
1825 #define BGP_ATTR_EXT_COMMUNITIES 16
1826 #define BGP_ATTR_AS4_PATH 17
1827 #define BGP_ATTR_AS4_AGGREGATOR 18
1828 #define BGP_ATTR_AS_PATHLIMIT 21
1829 #define BGP_ATTR_PMSI_TUNNEL 22
1830 #define BGP_ATTR_ENCAP 23
1831 #define BGP_ATTR_IPV6_EXT_COMMUNITIES 25
1832 #define BGP_ATTR_LARGE_COMMUNITIES 32
1833 #define BGP_ATTR_OTC 35
1834 #define BGP_ATTR_PREFIX_SID 40
1835 #define BGP_ATTR_SRTE_COLOR 51
1836 #ifdef ENABLE_BGP_VNC_ATTR
1837 #define BGP_ATTR_VNC 255
1838 #endif
1839
1840 /* BGP update origin. */
1841 #define BGP_ORIGIN_IGP 0
1842 #define BGP_ORIGIN_EGP 1
1843 #define BGP_ORIGIN_INCOMPLETE 2
1844 #define BGP_ORIGIN_UNSPECIFIED 255
1845
1846 /* BGP notify message codes. */
1847 #define BGP_NOTIFY_HEADER_ERR 1
1848 #define BGP_NOTIFY_OPEN_ERR 2
1849 #define BGP_NOTIFY_UPDATE_ERR 3
1850 #define BGP_NOTIFY_HOLD_ERR 4
1851 #define BGP_NOTIFY_FSM_ERR 5
1852 #define BGP_NOTIFY_CEASE 6
1853 #define BGP_NOTIFY_ROUTE_REFRESH_ERR 7
1854
1855 /* Subcodes for BGP Finite State Machine Error */
1856 #define BGP_NOTIFY_FSM_ERR_SUBCODE_UNSPECIFIC 0
1857 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENSENT 1
1858 #define BGP_NOTIFY_FSM_ERR_SUBCODE_OPENCONFIRM 2
1859 #define BGP_NOTIFY_FSM_ERR_SUBCODE_ESTABLISHED 3
1860
1861 #define BGP_NOTIFY_SUBCODE_UNSPECIFIC 0
1862
1863 /* BGP_NOTIFY_HEADER_ERR sub codes. */
1864 #define BGP_NOTIFY_HEADER_NOT_SYNC 1
1865 #define BGP_NOTIFY_HEADER_BAD_MESLEN 2
1866 #define BGP_NOTIFY_HEADER_BAD_MESTYPE 3
1867
1868 /* BGP_NOTIFY_OPEN_ERR sub codes. */
1869 #define BGP_NOTIFY_OPEN_MALFORMED_ATTR 0
1870 #define BGP_NOTIFY_OPEN_UNSUP_VERSION 1
1871 #define BGP_NOTIFY_OPEN_BAD_PEER_AS 2
1872 #define BGP_NOTIFY_OPEN_BAD_BGP_IDENT 3
1873 #define BGP_NOTIFY_OPEN_UNSUP_PARAM 4
1874 #define BGP_NOTIFY_OPEN_AUTH_FAILURE 5
1875 #define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME 6
1876 #define BGP_NOTIFY_OPEN_UNSUP_CAPBL 7
1877 #define BGP_NOTIFY_OPEN_ROLE_MISMATCH 11
1878
1879 /* BGP_NOTIFY_UPDATE_ERR sub codes. */
1880 #define BGP_NOTIFY_UPDATE_MAL_ATTR 1
1881 #define BGP_NOTIFY_UPDATE_UNREC_ATTR 2
1882 #define BGP_NOTIFY_UPDATE_MISS_ATTR 3
1883 #define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR 4
1884 #define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR 5
1885 #define BGP_NOTIFY_UPDATE_INVAL_ORIGIN 6
1886 #define BGP_NOTIFY_UPDATE_AS_ROUTE_LOOP 7
1887 #define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP 8
1888 #define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR 9
1889 #define BGP_NOTIFY_UPDATE_INVAL_NETWORK 10
1890 #define BGP_NOTIFY_UPDATE_MAL_AS_PATH 11
1891
1892 /* BGP_NOTIFY_CEASE sub codes (RFC 4486). */
1893 #define BGP_NOTIFY_CEASE_MAX_PREFIX 1
1894 #define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN 2
1895 #define BGP_NOTIFY_CEASE_PEER_UNCONFIG 3
1896 #define BGP_NOTIFY_CEASE_ADMIN_RESET 4
1897 #define BGP_NOTIFY_CEASE_CONNECT_REJECT 5
1898 #define BGP_NOTIFY_CEASE_CONFIG_CHANGE 6
1899 #define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION 7
1900 #define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE 8
1901 #define BGP_NOTIFY_CEASE_HARD_RESET 9
1902 #define BGP_NOTIFY_CEASE_BFD_DOWN 10
1903
1904 /* BGP_NOTIFY_ROUTE_REFRESH_ERR sub codes (RFC 7313). */
1905 #define BGP_NOTIFY_ROUTE_REFRESH_INVALID_MSG_LEN 1
1906
1907 /* BGP route refresh optional subtypes. */
1908 #define BGP_ROUTE_REFRESH_NORMAL 0
1909 #define BGP_ROUTE_REFRESH_BORR 1
1910 #define BGP_ROUTE_REFRESH_EORR 2
1911
1912 /* BGP timers default value. */
1913 #define BGP_INIT_START_TIMER 1
1914 /* The following 3 are RFC defaults that are overridden in bgp_vty.c with
1915 * version-/profile-specific values. The values here do not matter, they only
1916 * exist to provide a clear layering separation between core and CLI.
1917 */
1918 #define BGP_DEFAULT_HOLDTIME 180
1919 #define BGP_DEFAULT_KEEPALIVE 60
1920 #define BGP_DEFAULT_CONNECT_RETRY 120
1921
1922 #define BGP_DEFAULT_EBGP_ROUTEADV 0
1923 #define BGP_DEFAULT_IBGP_ROUTEADV 0
1924
1925 /* BGP RFC 4271 DelayOpenTime default value */
1926 #define BGP_DEFAULT_DELAYOPEN 120
1927
1928 /* BGP default local preference. */
1929 #define BGP_DEFAULT_LOCAL_PREF 100
1930
1931 /* BGP local-preference to send when 'bgp graceful-shutdown'
1932 * is configured */
1933 #define BGP_GSHUT_LOCAL_PREF 0
1934
1935 /* BGP default subgroup packet queue max . */
1936 #define BGP_DEFAULT_SUBGROUP_PKT_QUEUE_MAX 40
1937
1938 /* BGP graceful restart */
1939 #define BGP_DEFAULT_RESTART_TIME 120
1940 #define BGP_DEFAULT_STALEPATH_TIME 360
1941 #define BGP_DEFAULT_SELECT_DEFERRAL_TIME 360
1942 #define BGP_DEFAULT_RIB_STALE_TIME 500
1943 #define BGP_DEFAULT_UPDATE_ADVERTISEMENT_TIME 1
1944
1945 /* BGP Long-lived Graceful Restart */
1946 #define BGP_DEFAULT_LLGR_STALE_TIME 0
1947
1948 /* BGP uptime string length. */
1949 #define BGP_UPTIME_LEN 25
1950
1951 /* Default configuration settings for bgpd. */
1952 #define BGP_VTY_PORT 2605
1953 #define BGP_DEFAULT_CONFIG "bgpd.conf"
1954
1955 /* BGP Dynamic Neighbors feature */
1956 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_DEFAULT 100
1957 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MIN 1
1958 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MAX 65535
1959
1960 /* Flag for peer_clear_soft(). */
1961 enum bgp_clear_type {
1962 BGP_CLEAR_SOFT_NONE,
1963 BGP_CLEAR_SOFT_OUT,
1964 BGP_CLEAR_SOFT_IN,
1965 BGP_CLEAR_SOFT_BOTH,
1966 BGP_CLEAR_SOFT_IN_ORF_PREFIX,
1967 BGP_CLEAR_MESSAGE_STATS
1968 };
1969
1970 /* Macros. */
1971 #define BGP_INPUT(P) ((P)->curr)
1972 #define BGP_INPUT_PNT(P) (stream_pnt(BGP_INPUT(P)))
1973 #define BGP_IS_VALID_STATE_FOR_NOTIF(S) \
1974 (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
1975
1976 /* BGP error codes. */
1977 enum bgp_create_error_code {
1978 BGP_SUCCESS = 0,
1979 BGP_CREATED = 1,
1980 BGP_ERR_INVALID_VALUE = -1,
1981 BGP_ERR_INVALID_FLAG = -2,
1982 BGP_ERR_INVALID_AS = -3,
1983 BGP_ERR_PEER_GROUP_MEMBER = -4,
1984 BGP_ERR_PEER_GROUP_NO_REMOTE_AS = -5,
1985 BGP_ERR_PEER_GROUP_CANT_CHANGE = -6,
1986 BGP_ERR_PEER_GROUP_MISMATCH = -7,
1987 BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT = -8,
1988 BGP_ERR_AS_MISMATCH = -9,
1989 BGP_ERR_PEER_FLAG_CONFLICT = -10,
1990 BGP_ERR_PEER_GROUP_SHUTDOWN = -11,
1991 BGP_ERR_PEER_FILTER_CONFLICT = -12,
1992 BGP_ERR_NOT_INTERNAL_PEER = -13,
1993 BGP_ERR_REMOVE_PRIVATE_AS = -14,
1994 BGP_ERR_AF_UNCONFIGURED = -15,
1995 BGP_ERR_SOFT_RECONFIG_UNCONFIGURED = -16,
1996 BGP_ERR_INSTANCE_MISMATCH = -17,
1997 BGP_ERR_LOCAL_AS_ALLOWED_ONLY_FOR_EBGP = -18,
1998 BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS = -19,
1999 BGP_ERR_TCPSIG_FAILED = -20,
2000 BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK = -21,
2001 BGP_ERR_NO_IBGP_WITH_TTLHACK = -22,
2002 BGP_ERR_NO_INTERFACE_CONFIG = -23,
2003 BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS_REMOTE_AS = -24,
2004 BGP_ERR_AS_OVERRIDE = -25,
2005 BGP_ERR_INVALID_DYNAMIC_NEIGHBORS_LIMIT = -26,
2006 BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_EXISTS = -27,
2007 BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_NOT_FOUND = -28,
2008 BGP_ERR_INVALID_FOR_DYNAMIC_PEER = -29,
2009 BGP_ERR_INVALID_FOR_DIRECT_PEER = -30,
2010 BGP_ERR_PEER_SAFI_CONFLICT = -31,
2011
2012 /* BGP GR ERRORS */
2013 BGP_ERR_GR_INVALID_CMD = -32,
2014 BGP_ERR_GR_OPERATION_FAILED = -33,
2015 BGP_GR_NO_OPERATION = -34,
2016
2017 /*BGP Open Policy ERRORS */
2018 BGP_ERR_INVALID_ROLE_NAME = -35,
2019 BGP_ERR_INVALID_INTERNAL_ROLE = -36
2020 };
2021
2022 /*
2023 * Enumeration of different policy kinds a peer can be configured with.
2024 */
2025 enum bgp_policy_type {
2026 BGP_POLICY_ROUTE_MAP,
2027 BGP_POLICY_FILTER_LIST,
2028 BGP_POLICY_PREFIX_LIST,
2029 BGP_POLICY_DISTRIBUTE_LIST,
2030 };
2031
2032 /* peer_flag_change_type. */
2033 enum peer_change_type {
2034 peer_change_none,
2035 peer_change_reset,
2036 peer_change_reset_in,
2037 peer_change_reset_out,
2038 };
2039
2040 extern struct bgp_master *bm;
2041 extern unsigned int multipath_num;
2042
2043 /* Prototypes. */
2044 extern void bgp_terminate(void);
2045 extern void bgp_reset(void);
2046 extern void bgp_zclient_reset(void);
2047 extern struct bgp *bgp_get_default(void);
2048 extern struct bgp *bgp_lookup(as_t, const char *);
2049 extern struct bgp *bgp_lookup_by_name(const char *);
2050 extern struct bgp *bgp_lookup_by_vrf_id(vrf_id_t);
2051 extern struct bgp *bgp_get_evpn(void);
2052 extern void bgp_set_evpn(struct bgp *bgp);
2053 extern struct peer *peer_lookup(struct bgp *, union sockunion *);
2054 extern struct peer *peer_lookup_by_conf_if(struct bgp *, const char *);
2055 extern struct peer *peer_lookup_by_hostname(struct bgp *, const char *);
2056 extern void bgp_peer_conf_if_to_su_update(struct peer *);
2057 extern int peer_group_listen_range_del(struct peer_group *, struct prefix *);
2058 extern struct peer_group *peer_group_lookup(struct bgp *, const char *);
2059 extern struct peer_group *peer_group_get(struct bgp *, const char *);
2060 extern struct peer *peer_create_bind_dynamic_neighbor(struct bgp *,
2061 union sockunion *,
2062 struct peer_group *);
2063 extern struct prefix *
2064 peer_group_lookup_dynamic_neighbor_range(struct peer_group *, struct prefix *);
2065 extern struct peer_group *peer_group_lookup_dynamic_neighbor(struct bgp *,
2066 struct prefix *,
2067 struct prefix **);
2068 extern struct peer *peer_lookup_dynamic_neighbor(struct bgp *,
2069 union sockunion *);
2070
2071 /*
2072 * Peers are incredibly easy to memory leak
2073 * due to the various ways that they are actually used
2074 * Provide some functionality to debug locks and unlocks
2075 */
2076 extern struct peer *peer_lock_with_caller(const char *, struct peer *);
2077 extern struct peer *peer_unlock_with_caller(const char *, struct peer *);
2078 #define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
2079 #define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
2080
2081 extern enum bgp_peer_sort peer_sort(struct peer *peer);
2082 extern enum bgp_peer_sort peer_sort_lookup(struct peer *peer);
2083
2084 extern bool peer_active(struct peer *);
2085 extern bool peer_active_nego(struct peer *);
2086 extern bool peer_afc_received(struct peer *peer);
2087 extern bool peer_afc_advertised(struct peer *peer);
2088 extern void bgp_recalculate_all_bestpaths(struct bgp *bgp);
2089 extern struct peer *peer_create(union sockunion *, const char *, struct bgp *,
2090 as_t, as_t, int, struct peer_group *);
2091 extern struct peer *peer_create_accept(struct bgp *);
2092 extern void peer_xfer_config(struct peer *dst, struct peer *src);
2093 extern char *peer_uptime(time_t uptime2, char *buf, size_t len, bool use_json,
2094 json_object *json);
2095
2096 extern int bgp_config_write(struct vty *);
2097
2098 extern void bgp_master_init(struct thread_master *master, const int buffer_size,
2099 struct list *addresses);
2100
2101 extern void bgp_init(unsigned short instance);
2102 extern void bgp_pthreads_run(void);
2103 extern void bgp_pthreads_finish(void);
2104 extern void bgp_route_map_init(void);
2105 extern void bgp_session_reset(struct peer *);
2106
2107 extern int bgp_option_set(int);
2108 extern int bgp_option_unset(int);
2109 extern int bgp_option_check(int);
2110
2111 /* set the bgp no-rib option during runtime and remove installed routes */
2112 extern void bgp_option_norib_set_runtime(void);
2113
2114 /* unset the bgp no-rib option during runtime and reset all peers */
2115 extern void bgp_option_norib_unset_runtime(void);
2116
2117 extern int bgp_get(struct bgp **, as_t *, const char *, enum bgp_instance_type);
2118 extern void bgp_instance_up(struct bgp *);
2119 extern void bgp_instance_down(struct bgp *);
2120 extern int bgp_delete(struct bgp *);
2121
2122 extern int bgp_handle_socket(struct bgp *bgp, struct vrf *vrf,
2123 vrf_id_t old_vrf_id, bool create);
2124
2125 extern void bgp_router_id_zebra_bump(vrf_id_t, const struct prefix *);
2126 extern void bgp_router_id_static_set(struct bgp *, struct in_addr);
2127
2128 extern void bm_wait_for_fib_set(bool set);
2129 extern void bgp_suppress_fib_pending_set(struct bgp *bgp, bool set);
2130 extern void bgp_cluster_id_set(struct bgp *bgp, struct in_addr *cluster_id);
2131 extern void bgp_cluster_id_unset(struct bgp *bgp);
2132
2133 extern void bgp_confederation_id_set(struct bgp *bgp, as_t as);
2134 extern void bgp_confederation_id_unset(struct bgp *bgp);
2135 extern bool bgp_confederation_peers_check(struct bgp *, as_t);
2136
2137 extern void bgp_confederation_peers_add(struct bgp *bgp, as_t as);
2138 extern void bgp_confederation_peers_remove(struct bgp *bgp, as_t as);
2139
2140 extern void bgp_timers_set(struct bgp *, uint32_t keepalive, uint32_t holdtime,
2141 uint32_t connect_retry, uint32_t delayopen);
2142 extern void bgp_timers_unset(struct bgp *);
2143
2144 extern void bgp_default_local_preference_set(struct bgp *bgp,
2145 uint32_t local_pref);
2146 extern void bgp_default_local_preference_unset(struct bgp *bgp);
2147
2148 extern void bgp_default_subgroup_pkt_queue_max_set(struct bgp *bgp,
2149 uint32_t queue_size);
2150 extern void bgp_default_subgroup_pkt_queue_max_unset(struct bgp *bgp);
2151
2152 extern void bgp_listen_limit_set(struct bgp *bgp, int listen_limit);
2153 extern void bgp_listen_limit_unset(struct bgp *bgp);
2154
2155 extern bool bgp_update_delay_active(struct bgp *);
2156 extern bool bgp_update_delay_configured(struct bgp *);
2157 extern bool bgp_afi_safi_peer_exists(struct bgp *bgp, afi_t afi, safi_t safi);
2158 extern void peer_as_change(struct peer *, as_t, int);
2159 extern int peer_remote_as(struct bgp *, union sockunion *, const char *, as_t *,
2160 int);
2161 extern int peer_group_remote_as(struct bgp *, const char *, as_t *, int);
2162 extern int peer_delete(struct peer *peer);
2163 extern void peer_notify_unconfig(struct peer *peer);
2164 extern int peer_group_delete(struct peer_group *);
2165 extern int peer_group_remote_as_delete(struct peer_group *);
2166 extern int peer_group_listen_range_add(struct peer_group *, struct prefix *);
2167 extern void peer_group_notify_unconfig(struct peer_group *group);
2168
2169 extern int peer_activate(struct peer *, afi_t, safi_t);
2170 extern int peer_deactivate(struct peer *, afi_t, safi_t);
2171
2172 extern int peer_group_bind(struct bgp *, union sockunion *, struct peer *,
2173 struct peer_group *, as_t *);
2174
2175 extern int peer_flag_set(struct peer *peer, uint64_t flag);
2176 extern int peer_flag_unset(struct peer *peer, uint64_t flag);
2177 extern void peer_flag_inherit(struct peer *peer, uint64_t flag);
2178
2179 extern int peer_af_flag_set(struct peer *, afi_t, safi_t, uint32_t);
2180 extern int peer_af_flag_unset(struct peer *, afi_t, safi_t, uint32_t);
2181 extern int peer_af_flag_check(struct peer *, afi_t, safi_t, uint32_t);
2182 extern void peer_af_flag_inherit(struct peer *peer, afi_t afi, safi_t safi,
2183 uint32_t flag);
2184 extern void peer_change_action(struct peer *peer, afi_t afi, safi_t safi,
2185 enum peer_change_type type);
2186
2187 extern int peer_ebgp_multihop_set(struct peer *, int);
2188 extern int peer_ebgp_multihop_unset(struct peer *);
2189 extern int is_ebgp_multihop_configured(struct peer *peer);
2190
2191 extern int peer_role_set(struct peer *peer, uint8_t role, bool strict_mode);
2192 extern int peer_role_unset(struct peer *peer);
2193
2194 extern void peer_description_set(struct peer *, const char *);
2195 extern void peer_description_unset(struct peer *);
2196
2197 extern int peer_update_source_if_set(struct peer *, const char *);
2198 extern void peer_update_source_addr_set(struct peer *peer,
2199 const union sockunion *su);
2200 extern void peer_update_source_unset(struct peer *peer);
2201
2202 extern int peer_default_originate_set(struct peer *peer, afi_t afi, safi_t safi,
2203 const char *rmap,
2204 struct route_map *route_map);
2205 extern int peer_default_originate_unset(struct peer *, afi_t, safi_t);
2206
2207 extern void peer_port_set(struct peer *, uint16_t);
2208 extern void peer_port_unset(struct peer *);
2209
2210 extern int peer_weight_set(struct peer *, afi_t, safi_t, uint16_t);
2211 extern int peer_weight_unset(struct peer *, afi_t, safi_t);
2212
2213 extern int peer_timers_set(struct peer *, uint32_t keepalive,
2214 uint32_t holdtime);
2215 extern int peer_timers_unset(struct peer *);
2216
2217 extern int peer_timers_connect_set(struct peer *, uint32_t);
2218 extern int peer_timers_connect_unset(struct peer *);
2219
2220 extern int peer_advertise_interval_set(struct peer *, uint32_t);
2221 extern int peer_advertise_interval_unset(struct peer *);
2222
2223 extern int peer_timers_delayopen_set(struct peer *peer, uint32_t delayopen);
2224 extern int peer_timers_delayopen_unset(struct peer *peer);
2225
2226 extern void peer_interface_set(struct peer *, const char *);
2227 extern void peer_interface_unset(struct peer *);
2228
2229 extern int peer_distribute_set(struct peer *, afi_t, safi_t, int, const char *);
2230 extern int peer_distribute_unset(struct peer *, afi_t, safi_t, int);
2231
2232 extern int peer_allowas_in_set(struct peer *, afi_t, safi_t, int, int);
2233 extern int peer_allowas_in_unset(struct peer *, afi_t, safi_t);
2234
2235 extern int peer_local_as_set(struct peer *, as_t, bool no_prepend,
2236 bool replace_as);
2237 extern int peer_local_as_unset(struct peer *);
2238
2239 extern int peer_prefix_list_set(struct peer *, afi_t, safi_t, int,
2240 const char *);
2241 extern int peer_prefix_list_unset(struct peer *, afi_t, safi_t, int);
2242
2243 extern int peer_aslist_set(struct peer *, afi_t, safi_t, int, const char *);
2244 extern int peer_aslist_unset(struct peer *, afi_t, safi_t, int);
2245
2246 extern int peer_route_map_set(struct peer *peer, afi_t afi, safi_t safi, int,
2247 const char *name, struct route_map *route_map);
2248 extern int peer_route_map_unset(struct peer *, afi_t, safi_t, int);
2249
2250 extern int peer_unsuppress_map_set(struct peer *peer, afi_t afi, safi_t safi,
2251 const char *name,
2252 struct route_map *route_map);
2253
2254 extern int peer_advertise_map_set(struct peer *peer, afi_t afi, safi_t safi,
2255 const char *advertise_name,
2256 struct route_map *advertise_map,
2257 const char *condition_name,
2258 struct route_map *condition_map,
2259 bool condition);
2260
2261 extern int peer_password_set(struct peer *, const char *);
2262 extern int peer_password_unset(struct peer *);
2263
2264 extern int peer_unsuppress_map_unset(struct peer *, afi_t, safi_t);
2265
2266 extern int peer_advertise_map_unset(struct peer *peer, afi_t afi, safi_t safi,
2267 const char *advertise_name,
2268 struct route_map *advertise_map,
2269 const char *condition_name,
2270 struct route_map *condition_map,
2271 bool condition);
2272
2273 extern int peer_maximum_prefix_set(struct peer *, afi_t, safi_t, uint32_t,
2274 uint8_t, int, uint16_t, bool force);
2275 extern int peer_maximum_prefix_unset(struct peer *, afi_t, safi_t);
2276
2277 extern void peer_maximum_prefix_out_refresh_routes(struct peer *peer, afi_t afi,
2278 safi_t safi);
2279 extern int peer_maximum_prefix_out_set(struct peer *peer, afi_t afi,
2280 safi_t safi, uint32_t max);
2281 extern int peer_maximum_prefix_out_unset(struct peer *peer, afi_t afi,
2282 safi_t safi);
2283
2284 extern int peer_clear(struct peer *, struct listnode **);
2285 extern int peer_clear_soft(struct peer *, afi_t, safi_t, enum bgp_clear_type);
2286
2287 extern int peer_ttl_security_hops_set(struct peer *, int);
2288 extern int peer_ttl_security_hops_unset(struct peer *);
2289
2290 extern void peer_tx_shutdown_message_set(struct peer *, const char *msg);
2291 extern void peer_tx_shutdown_message_unset(struct peer *);
2292
2293 extern void bgp_route_map_update_timer(struct thread *thread);
2294 extern const char *bgp_get_name_by_role(uint8_t role);
2295
2296 extern void bgp_route_map_terminate(void);
2297
2298 extern int peer_cmp(struct peer *p1, struct peer *p2);
2299
2300 extern int bgp_map_afi_safi_iana2int(iana_afi_t pkt_afi, iana_safi_t pkt_safi,
2301 afi_t *afi, safi_t *safi);
2302 extern int bgp_map_afi_safi_int2iana(afi_t afi, safi_t safi,
2303 iana_afi_t *pkt_afi,
2304 iana_safi_t *pkt_safi);
2305
2306 extern struct peer_af *peer_af_create(struct peer *, afi_t, safi_t);
2307 extern struct peer_af *peer_af_find(struct peer *, afi_t, safi_t);
2308 extern int peer_af_delete(struct peer *, afi_t, safi_t);
2309
2310 extern void bgp_shutdown_enable(struct bgp *bgp, const char *msg);
2311 extern void bgp_shutdown_disable(struct bgp *bgp);
2312
2313 extern void bgp_close(void);
2314 extern void bgp_free(struct bgp *);
2315 void bgp_gr_apply_running_config(void);
2316
2317 /* BGP GR */
2318 int bgp_global_gr_init(struct bgp *bgp);
2319 int bgp_peer_gr_init(struct peer *peer);
2320
2321
2322 #define BGP_GR_ROUTER_DETECT_AND_SEND_CAPABILITY_TO_ZEBRA(_bgp, _peer_list) \
2323 do { \
2324 struct peer *peer_loop; \
2325 bool gr_router_detected = false; \
2326 struct listnode *node = {0}; \
2327 for (ALL_LIST_ELEMENTS_RO(_peer_list, node, peer_loop)) { \
2328 if (CHECK_FLAG(peer_loop->flags, \
2329 PEER_FLAG_GRACEFUL_RESTART)) \
2330 gr_router_detected = true; \
2331 } \
2332 if (gr_router_detected \
2333 && _bgp->present_zebra_gr_state == ZEBRA_GR_DISABLE) { \
2334 bgp_zebra_send_capabilities(_bgp, false); \
2335 } else if (!gr_router_detected \
2336 && _bgp->present_zebra_gr_state \
2337 == ZEBRA_GR_ENABLE) { \
2338 bgp_zebra_send_capabilities(_bgp, true); \
2339 } \
2340 } while (0)
2341
2342 static inline struct bgp *bgp_lock(struct bgp *bgp)
2343 {
2344 bgp->lock++;
2345 return bgp;
2346 }
2347
2348 static inline void bgp_unlock(struct bgp *bgp)
2349 {
2350 assert(bgp->lock > 0);
2351 if (--bgp->lock == 0)
2352 bgp_free(bgp);
2353 }
2354
2355 static inline int afindex(afi_t afi, safi_t safi)
2356 {
2357 switch (afi) {
2358 case AFI_IP:
2359 switch (safi) {
2360 case SAFI_UNICAST:
2361 return BGP_AF_IPV4_UNICAST;
2362 case SAFI_MULTICAST:
2363 return BGP_AF_IPV4_MULTICAST;
2364 case SAFI_LABELED_UNICAST:
2365 return BGP_AF_IPV4_LBL_UNICAST;
2366 case SAFI_MPLS_VPN:
2367 return BGP_AF_IPV4_VPN;
2368 case SAFI_ENCAP:
2369 return BGP_AF_IPV4_ENCAP;
2370 case SAFI_FLOWSPEC:
2371 return BGP_AF_IPV4_FLOWSPEC;
2372 default:
2373 return BGP_AF_MAX;
2374 }
2375 break;
2376 case AFI_IP6:
2377 switch (safi) {
2378 case SAFI_UNICAST:
2379 return BGP_AF_IPV6_UNICAST;
2380 case SAFI_MULTICAST:
2381 return BGP_AF_IPV6_MULTICAST;
2382 case SAFI_LABELED_UNICAST:
2383 return BGP_AF_IPV6_LBL_UNICAST;
2384 case SAFI_MPLS_VPN:
2385 return BGP_AF_IPV6_VPN;
2386 case SAFI_ENCAP:
2387 return BGP_AF_IPV6_ENCAP;
2388 case SAFI_FLOWSPEC:
2389 return BGP_AF_IPV6_FLOWSPEC;
2390 default:
2391 return BGP_AF_MAX;
2392 }
2393 break;
2394 case AFI_L2VPN:
2395 switch (safi) {
2396 case SAFI_EVPN:
2397 return BGP_AF_L2VPN_EVPN;
2398 default:
2399 return BGP_AF_MAX;
2400 }
2401 default:
2402 return BGP_AF_MAX;
2403 }
2404 }
2405
2406 /* If the peer is not a peer-group but is bound to a peer-group return 1 */
2407 static inline int peer_group_active(struct peer *peer)
2408 {
2409 if (!CHECK_FLAG(peer->sflags, PEER_STATUS_GROUP) && peer->group)
2410 return 1;
2411 return 0;
2412 }
2413
2414 /* If peer is negotiated at least one address family return 1. */
2415 static inline int peer_afi_active_nego(const struct peer *peer, afi_t afi)
2416 {
2417 if (peer->afc_nego[afi][SAFI_UNICAST]
2418 || peer->afc_nego[afi][SAFI_MULTICAST]
2419 || peer->afc_nego[afi][SAFI_LABELED_UNICAST]
2420 || peer->afc_nego[afi][SAFI_MPLS_VPN]
2421 || peer->afc_nego[afi][SAFI_ENCAP]
2422 || peer->afc_nego[afi][SAFI_FLOWSPEC]
2423 || peer->afc_nego[afi][SAFI_EVPN])
2424 return 1;
2425 return 0;
2426 }
2427
2428 /* If at least one address family activated for group, return 1. */
2429 static inline int peer_group_af_configured(struct peer_group *group)
2430 {
2431 struct peer *peer = group->conf;
2432
2433 if (peer->afc[AFI_IP][SAFI_UNICAST] || peer->afc[AFI_IP][SAFI_MULTICAST]
2434 || peer->afc[AFI_IP][SAFI_LABELED_UNICAST]
2435 || peer->afc[AFI_IP][SAFI_FLOWSPEC]
2436 || peer->afc[AFI_IP][SAFI_MPLS_VPN] || peer->afc[AFI_IP][SAFI_ENCAP]
2437 || peer->afc[AFI_IP6][SAFI_UNICAST]
2438 || peer->afc[AFI_IP6][SAFI_MULTICAST]
2439 || peer->afc[AFI_IP6][SAFI_LABELED_UNICAST]
2440 || peer->afc[AFI_IP6][SAFI_MPLS_VPN]
2441 || peer->afc[AFI_IP6][SAFI_ENCAP]
2442 || peer->afc[AFI_IP6][SAFI_FLOWSPEC]
2443 || peer->afc[AFI_L2VPN][SAFI_EVPN])
2444 return 1;
2445 return 0;
2446 }
2447
2448 static inline char *timestamp_string(time_t ts)
2449 {
2450 time_t tbuf;
2451 tbuf = time(NULL) - (monotime(NULL) - ts);
2452 return ctime(&tbuf);
2453 }
2454
2455 static inline bool peer_established(struct peer *peer)
2456 {
2457 return peer->status == Established;
2458 }
2459
2460 static inline bool peer_dynamic_neighbor(struct peer *peer)
2461 {
2462 return CHECK_FLAG(peer->flags, PEER_FLAG_DYNAMIC_NEIGHBOR);
2463 }
2464
2465 static inline bool peer_dynamic_neighbor_no_nsf(struct peer *peer)
2466 {
2467 return (peer_dynamic_neighbor(peer) &&
2468 !CHECK_FLAG(peer->sflags, PEER_STATUS_NSF_WAIT));
2469 }
2470
2471 static inline int peer_cap_enhe(struct peer *peer, afi_t afi, safi_t safi)
2472 {
2473 return (CHECK_FLAG(peer->af_cap[afi][safi], PEER_CAP_ENHE_AF_NEGO));
2474 }
2475
2476 /* Lookup VRF for BGP instance based on its type. */
2477 static inline struct vrf *bgp_vrf_lookup_by_instance_type(struct bgp *bgp)
2478 {
2479 struct vrf *vrf;
2480
2481 if (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT)
2482 vrf = vrf_lookup_by_id(VRF_DEFAULT);
2483 else if (bgp->inst_type == BGP_INSTANCE_TYPE_VRF)
2484 vrf = vrf_lookup_by_name(bgp->name);
2485 else
2486 vrf = NULL;
2487
2488 return vrf;
2489 }
2490
2491 static inline uint32_t bgp_vrf_interfaces(struct bgp *bgp, bool active)
2492 {
2493 struct vrf *vrf;
2494 struct interface *ifp;
2495 uint32_t count = 0;
2496
2497 /* if there is one interface in the vrf which is up then it is deemed
2498 * active
2499 */
2500 vrf = bgp_vrf_lookup_by_instance_type(bgp);
2501 if (vrf == NULL)
2502 return 0;
2503 RB_FOREACH (ifp, if_name_head, &vrf->ifaces_by_name) {
2504 if (strcmp(ifp->name, bgp->name) == 0)
2505 continue;
2506 if (!active || if_is_up(ifp))
2507 count++;
2508 }
2509 return count;
2510 }
2511
2512 /* Link BGP instance to VRF. */
2513 static inline void bgp_vrf_link(struct bgp *bgp, struct vrf *vrf)
2514 {
2515 bgp->vrf_id = vrf->vrf_id;
2516 if (vrf->info != (void *)bgp)
2517 vrf->info = (void *)bgp_lock(bgp);
2518 }
2519
2520 /* Unlink BGP instance from VRF. */
2521 static inline void bgp_vrf_unlink(struct bgp *bgp, struct vrf *vrf)
2522 {
2523 if (vrf->info == (void *)bgp) {
2524 vrf->info = NULL;
2525 bgp_unlock(bgp);
2526 }
2527 bgp->vrf_id = VRF_UNKNOWN;
2528 }
2529
2530 static inline bool bgp_in_graceful_shutdown(struct bgp *bgp)
2531 {
2532 /* True if either set for this instance or globally */
2533 return (!!CHECK_FLAG(bgp->flags, BGP_FLAG_GRACEFUL_SHUTDOWN) ||
2534 !!CHECK_FLAG(bm->flags, BM_FLAG_GRACEFUL_SHUTDOWN));
2535 }
2536
2537 /* For benefit of rfapi */
2538 extern struct peer *peer_new(struct bgp *bgp);
2539
2540 extern struct peer *peer_lookup_in_view(struct vty *vty, struct bgp *bgp,
2541 const char *ip_str, bool use_json);
2542 extern int bgp_lookup_by_as_name_type(struct bgp **bgp_val, as_t *as,
2543 const char *name,
2544 enum bgp_instance_type inst_type);
2545
2546 /* Hooks */
2547 DECLARE_HOOK(bgp_vrf_status_changed, (struct bgp *bgp, struct interface *ifp),
2548 (bgp, ifp));
2549 DECLARE_HOOK(peer_status_changed, (struct peer *peer), (peer));
2550 DECLARE_HOOK(bgp_snmp_init_stats, (struct bgp *bgp), (bgp));
2551 DECLARE_HOOK(bgp_snmp_update_last_changed, (struct bgp *bgp), (bgp));
2552 DECLARE_HOOK(bgp_snmp_update_stats,
2553 (struct bgp_node *rn, struct bgp_path_info *pi, bool added),
2554 (rn, pi, added));
2555 DECLARE_HOOK(bgp_rpki_prefix_status,
2556 (struct peer * peer, struct attr *attr,
2557 const struct prefix *prefix),
2558 (peer, attr, prefix));
2559
2560 void peer_nsf_stop(struct peer *peer);
2561
2562 void peer_tcp_mss_set(struct peer *peer, uint32_t tcp_mss);
2563 void peer_tcp_mss_unset(struct peer *peer);
2564
2565 extern void bgp_recalculate_afi_safi_bestpaths(struct bgp *bgp, afi_t afi,
2566 safi_t safi);
2567
2568 #ifdef _FRR_ATTRIBUTE_PRINTFRR
2569 /* clang-format off */
2570 #pragma FRR printfrr_ext "%pBP" (struct peer *)
2571 /* clang-format on */
2572 #endif
2573
2574 #endif /* _QUAGGA_BGPD_H */
FRRouting mirror