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