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