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