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