]> git.proxmox.com Git - mirror_frr.git/blob - bgpd/bgpd.h
Merge pull request #5288 from SumitAgarwal123/bfd_docs
[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 "iana_afi.h"
33
34 /* For union sockunion. */
35 #include "queue.h"
36 #include "sockunion.h"
37 #include "routemap.h"
38 #include "linklist.h"
39 #include "defaults.h"
40 #include "bgp_memory.h"
41 #include "bitfield.h"
42 #include "vxlan.h"
43 #include "bgp_labelpool.h"
44 #include "bgp_addpath_types.h"
45
46 #define BGP_MAX_HOSTNAME 64 /* Linux max, is larger than most other sys */
47 #define BGP_PEER_MAX_HASH_SIZE 16384
48
49 /* Default interval for IPv6 RAs when triggered by BGP unnumbered neighbor. */
50 #define BGP_UNNUM_DEFAULT_RA_INTERVAL 10
51
52 struct update_subgroup;
53 struct bpacket;
54 struct bgp_pbr_config;
55
56 /*
57 * Allow the neighbor XXXX remote-as to take internal or external
58 * AS_SPECIFIED is zero to auto-inherit original non-feature/enhancement
59 * behavior
60 * in the system.
61 */
62 enum { AS_UNSPECIFIED = 0,
63 AS_SPECIFIED,
64 AS_INTERNAL,
65 AS_EXTERNAL,
66 };
67
68 /* Typedef BGP specific types. */
69 typedef uint32_t as_t;
70 typedef uint16_t as16_t; /* we may still encounter 16 Bit asnums */
71 typedef uint16_t bgp_size_t;
72
73 #define max(a, b) \
74 ({ \
75 __typeof__(a) _a = (a); \
76 __typeof__(b) _b = (b); \
77 _a > _b ? _a : _b; \
78 })
79
80 enum bgp_af_index {
81 BGP_AF_START,
82 BGP_AF_IPV4_UNICAST = BGP_AF_START,
83 BGP_AF_IPV4_MULTICAST,
84 BGP_AF_IPV4_VPN,
85 BGP_AF_IPV6_UNICAST,
86 BGP_AF_IPV6_MULTICAST,
87 BGP_AF_IPV6_VPN,
88 BGP_AF_IPV4_ENCAP,
89 BGP_AF_IPV6_ENCAP,
90 BGP_AF_L2VPN_EVPN,
91 BGP_AF_IPV4_LBL_UNICAST,
92 BGP_AF_IPV6_LBL_UNICAST,
93 BGP_AF_IPV4_FLOWSPEC,
94 BGP_AF_IPV6_FLOWSPEC,
95 BGP_AF_MAX
96 };
97
98 #define AF_FOREACH(af) for ((af) = BGP_AF_START; (af) < BGP_AF_MAX; (af)++)
99
100 #define FOREACH_AFI_SAFI(afi, safi) \
101 for (afi = AFI_IP; afi < AFI_MAX; afi++) \
102 for (safi = SAFI_UNICAST; safi < SAFI_MAX; safi++)
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 /* work queues */
119 struct work_queue *process_main_queue;
120
121 /* Listening sockets */
122 struct list *listen_sockets;
123
124 /* BGP port number. */
125 uint16_t port;
126
127 /* Listener address */
128 char *address;
129
130 /* The Mac table */
131 struct hash *self_mac_hash;
132
133 /* BGP start time. */
134 time_t start_time;
135
136 /* Various BGP global configuration. */
137 uint8_t options;
138 #define BGP_OPT_NO_FIB (1 << 0)
139 #define BGP_OPT_NO_LISTEN (1 << 1)
140 #define BGP_OPT_NO_ZEBRA (1 << 2)
141
142 uint64_t updgrp_idspace;
143 uint64_t subgrp_idspace;
144
145 /* timer to dampen route map changes */
146 struct thread *t_rmap_update; /* Handle route map updates */
147 uint32_t rmap_update_timer; /* Route map update timer */
148 #define RMAP_DEFAULT_UPDATE_TIMER 5 /* disabled by default */
149
150 /* Id space for automatic RD derivation for an EVI/VRF */
151 bitfield_t rd_idspace;
152
153 /* dynamic mpls label allocation pool */
154 struct labelpool labelpool;
155
156 /* BGP-EVPN VRF ID. Defaults to default VRF (if any) */
157 struct bgp* bgp_evpn;
158
159 /* How big should we set the socket buffer size */
160 uint32_t socket_buffer;
161
162 bool terminating; /* global flag that sigint terminate seen */
163 QOBJ_FIELDS
164 };
165 DECLARE_QOBJ_TYPE(bgp_master)
166
167 /* BGP route-map structure. */
168 struct bgp_rmap {
169 char *name;
170 struct route_map *map;
171 };
172
173 struct bgp_redist {
174 unsigned short instance;
175
176 /* BGP redistribute metric configuration. */
177 uint8_t redist_metric_flag;
178 uint32_t redist_metric;
179
180 /* BGP redistribute route-map. */
181 struct bgp_rmap rmap;
182 };
183
184 typedef enum {
185 BGP_VPN_POLICY_DIR_FROMVPN = 0,
186 BGP_VPN_POLICY_DIR_TOVPN = 1,
187 BGP_VPN_POLICY_DIR_MAX = 2
188 } vpn_policy_direction_t;
189
190 struct vpn_policy {
191 struct bgp *bgp; /* parent */
192 afi_t afi;
193 struct ecommunity *rtlist[BGP_VPN_POLICY_DIR_MAX];
194 struct ecommunity *import_redirect_rtlist;
195 char *rmap_name[BGP_VPN_POLICY_DIR_MAX];
196 struct route_map *rmap[BGP_VPN_POLICY_DIR_MAX];
197
198 /* should be mpls_label_t? */
199 uint32_t tovpn_label; /* may be MPLS_LABEL_NONE */
200 uint32_t tovpn_zebra_vrf_label_last_sent;
201 struct prefix_rd tovpn_rd;
202 struct prefix tovpn_nexthop; /* unset => set to 0 */
203 uint32_t flags;
204 #define BGP_VPN_POLICY_TOVPN_LABEL_AUTO (1 << 0)
205 #define BGP_VPN_POLICY_TOVPN_RD_SET (1 << 1)
206 #define BGP_VPN_POLICY_TOVPN_NEXTHOP_SET (1 << 2)
207
208 /*
209 * If we are importing another vrf into us keep a list of
210 * vrf names that are being imported into us.
211 */
212 struct list *import_vrf;
213
214 /*
215 * if we are being exported to another vrf keep a list of
216 * vrf names that we are being exported to.
217 */
218 struct list *export_vrf;
219 };
220
221 /*
222 * Type of 'struct bgp'.
223 * - Default: The default instance
224 * - VRF: A specific (non-default) VRF
225 * - View: An instance used for route exchange
226 * The "default" instance is treated separately to simplify the code. Note
227 * that if deployed in a Multi-VRF environment, it may not exist.
228 */
229 enum bgp_instance_type {
230 BGP_INSTANCE_TYPE_DEFAULT,
231 BGP_INSTANCE_TYPE_VRF,
232 BGP_INSTANCE_TYPE_VIEW
233 };
234
235 /* BGP instance structure. */
236 struct bgp {
237 /* AS number of this BGP instance. */
238 as_t as;
239
240 /* Name of this BGP instance. */
241 char *name;
242 char *name_pretty; /* printable "VRF|VIEW name|default" */
243
244 /* Type of instance and VRF id. */
245 enum bgp_instance_type inst_type;
246 vrf_id_t vrf_id;
247
248 /* Reference count to allow peer_delete to finish after bgp_delete */
249 int lock;
250
251 /* Self peer. */
252 struct peer *peer_self;
253
254 /* BGP peer. */
255 struct list *peer;
256 struct hash *peerhash;
257
258 /* BGP peer group. */
259 struct list *group;
260
261 /* The maximum number of BGP dynamic neighbors that can be created */
262 int dynamic_neighbors_limit;
263
264 /* The current number of BGP dynamic neighbors */
265 int dynamic_neighbors_count;
266
267 struct hash *update_groups[BGP_AF_MAX];
268
269 /*
270 * Global statistics for update groups.
271 */
272 struct {
273 uint32_t join_events;
274 uint32_t prune_events;
275 uint32_t merge_events;
276 uint32_t split_events;
277 uint32_t updgrp_switch_events;
278 uint32_t peer_refreshes_combined;
279 uint32_t adj_count;
280 uint32_t merge_checks_triggered;
281
282 uint32_t updgrps_created;
283 uint32_t updgrps_deleted;
284 uint32_t subgrps_created;
285 uint32_t subgrps_deleted;
286 } update_group_stats;
287
288 /* BGP configuration. */
289 uint16_t config;
290 #define BGP_CONFIG_CLUSTER_ID (1 << 0)
291 #define BGP_CONFIG_CONFEDERATION (1 << 1)
292
293 /* BGP router identifier. */
294 struct in_addr router_id;
295 struct in_addr router_id_static;
296 struct in_addr router_id_zebra;
297
298 /* BGP route reflector cluster ID. */
299 struct in_addr cluster_id;
300
301 /* BGP confederation information. */
302 as_t confed_id;
303 as_t *confed_peers;
304 int confed_peers_cnt;
305
306 struct thread
307 *t_startup; /* start-up timer on only once at the beginning */
308
309 uint32_t v_maxmed_onstartup; /* Duration of max-med on start-up */
310 #define BGP_MAXMED_ONSTARTUP_UNCONFIGURED 0 /* 0 means off, its the default */
311 uint32_t maxmed_onstartup_value; /* Max-med value when active on
312 start-up */
313 struct thread
314 *t_maxmed_onstartup; /* non-null when max-med onstartup is on */
315 uint8_t maxmed_onstartup_over; /* Flag to make it effective only once */
316
317 uint8_t v_maxmed_admin; /* 1/0 if max-med administrative is on/off */
318 #define BGP_MAXMED_ADMIN_UNCONFIGURED 0 /* Off by default */
319 uint32_t maxmed_admin_value; /* Max-med value when administrative in on
320 */
321 #define BGP_MAXMED_VALUE_DEFAULT 4294967294 /* Maximum by default */
322
323 uint8_t maxmed_active; /* 1/0 if max-med is active or not */
324 uint32_t maxmed_value; /* Max-med value when its active */
325
326 /* BGP update delay on startup */
327 struct thread *t_update_delay;
328 struct thread *t_establish_wait;
329 uint8_t update_delay_over;
330 uint8_t main_zebra_update_hold;
331 uint8_t main_peers_update_hold;
332 uint16_t v_update_delay;
333 uint16_t v_establish_wait;
334 char update_delay_begin_time[64];
335 char update_delay_end_time[64];
336 char update_delay_zebra_resume_time[64];
337 char update_delay_peers_resume_time[64];
338 uint32_t established;
339 uint32_t restarted_peers;
340 uint32_t implicit_eors;
341 uint32_t explicit_eors;
342 #define BGP_UPDATE_DELAY_DEF 0
343 #define BGP_UPDATE_DELAY_MIN 0
344 #define BGP_UPDATE_DELAY_MAX 3600
345
346 /* BGP flags. */
347 uint32_t flags;
348 #define BGP_FLAG_ALWAYS_COMPARE_MED (1 << 0)
349 #define BGP_FLAG_DETERMINISTIC_MED (1 << 1)
350 #define BGP_FLAG_MED_MISSING_AS_WORST (1 << 2)
351 #define BGP_FLAG_MED_CONFED (1 << 3)
352 #define BGP_FLAG_NO_DEFAULT_IPV4 (1 << 4)
353 #define BGP_FLAG_NO_CLIENT_TO_CLIENT (1 << 5)
354 #define BGP_FLAG_COMPARE_ROUTER_ID (1 << 7)
355 #define BGP_FLAG_ASPATH_IGNORE (1 << 8)
356 #define BGP_FLAG_IMPORT_CHECK (1 << 9)
357 #define BGP_FLAG_NO_FAST_EXT_FAILOVER (1 << 10)
358 #define BGP_FLAG_LOG_NEIGHBOR_CHANGES (1 << 11)
359 #define BGP_FLAG_GRACEFUL_RESTART (1 << 12)
360 #define BGP_FLAG_ASPATH_CONFED (1 << 13)
361 #define BGP_FLAG_ASPATH_MULTIPATH_RELAX (1 << 14)
362 #define BGP_FLAG_RR_ALLOW_OUTBOUND_POLICY (1 << 15)
363 #define BGP_FLAG_DISABLE_NH_CONNECTED_CHK (1 << 16)
364 #define BGP_FLAG_MULTIPATH_RELAX_AS_SET (1 << 17)
365 #define BGP_FLAG_FORCE_STATIC_PROCESS (1 << 18)
366 #define BGP_FLAG_SHOW_HOSTNAME (1 << 19)
367 #define BGP_FLAG_GR_PRESERVE_FWD (1 << 20)
368 #define BGP_FLAG_GRACEFUL_SHUTDOWN (1 << 21)
369 #define BGP_FLAG_DELETE_IN_PROGRESS (1 << 22)
370
371 /* BGP Per AF flags */
372 uint16_t af_flags[AFI_MAX][SAFI_MAX];
373 #define BGP_CONFIG_DAMPENING (1 << 0)
374 /* l2vpn evpn flags - 1 << 0 is used for DAMPENNG */
375 #define BGP_L2VPN_EVPN_ADVERTISE_IPV4_UNICAST (1 << 1)
376 #define BGP_L2VPN_EVPN_ADVERTISE_IPV6_UNICAST (1 << 2)
377 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV4 (1 << 3)
378 #define BGP_L2VPN_EVPN_DEFAULT_ORIGINATE_IPV6 (1 << 4)
379 /* import/export between address families */
380 #define BGP_CONFIG_VRF_TO_MPLSVPN_EXPORT (1 << 5)
381 #define BGP_CONFIG_MPLSVPN_TO_VRF_IMPORT (1 << 6)
382 /* vrf-route leaking flags */
383 #define BGP_CONFIG_VRF_TO_VRF_IMPORT (1 << 7)
384 #define BGP_CONFIG_VRF_TO_VRF_EXPORT (1 << 8)
385
386 /* BGP per AF peer count */
387 uint32_t af_peer_count[AFI_MAX][SAFI_MAX];
388
389 /* Route table for next-hop lookup cache. */
390 struct bgp_table *nexthop_cache_table[AFI_MAX];
391
392 /* Route table for import-check */
393 struct bgp_table *import_check_table[AFI_MAX];
394
395 struct bgp_table *connected_table[AFI_MAX];
396
397 struct hash *address_hash;
398
399 /* DB for all local tunnel-ips - used mainly for martian checks
400 Currently it only has all VxLan tunnel IPs*/
401 struct hash *tip_hash;
402
403 /* Static route configuration. */
404 struct bgp_table *route[AFI_MAX][SAFI_MAX];
405
406 /* Aggregate address configuration. */
407 struct bgp_table *aggregate[AFI_MAX][SAFI_MAX];
408
409 /* BGP routing information base. */
410 struct bgp_table *rib[AFI_MAX][SAFI_MAX];
411
412 /* BGP table route-map. */
413 struct bgp_rmap table_map[AFI_MAX][SAFI_MAX];
414
415 /* BGP redistribute configuration. */
416 struct list *redist[AFI_MAX][ZEBRA_ROUTE_MAX];
417
418 /* Allocate MPLS labels */
419 uint8_t allocate_mpls_labels[AFI_MAX][SAFI_MAX];
420
421 /* Allocate hash entries to store policy routing information
422 * The hash are used to host pbr rules somewhere.
423 * Actually, pbr will only be used by flowspec
424 * those hash elements will have relationship together as
425 * illustrated in below diagram:
426 *
427 * pbr_action a <----- pbr_match i <--- pbr_match_entry 1..n
428 * <----- pbr_match j <--- pbr_match_entry 1..m
429 * <----- pbr_rule k
430 *
431 * - here in BGP structure, the list of match and actions will
432 * stand for the list of ipset sets, and table_ids in the kernel
433 * - the arrow above between pbr_match and pbr_action indicate
434 * that a backpointer permits match to find the action
435 * - the arrow betwen match_entry and match is a hash list
436 * contained in match, that lists the whole set of entries
437 */
438 struct hash *pbr_match_hash;
439 struct hash *pbr_rule_hash;
440 struct hash *pbr_action_hash;
441
442 /* timer to re-evaluate neighbor default-originate route-maps */
443 struct thread *t_rmap_def_originate_eval;
444 #define RMAP_DEFAULT_ORIGINATE_EVAL_TIMER 5
445
446 /* BGP distance configuration. */
447 uint8_t distance_ebgp[AFI_MAX][SAFI_MAX];
448 uint8_t distance_ibgp[AFI_MAX][SAFI_MAX];
449 uint8_t distance_local[AFI_MAX][SAFI_MAX];
450
451 /* BGP default local-preference. */
452 uint32_t default_local_pref;
453
454 /* BGP default subgroup pkt queue max */
455 uint32_t default_subgroup_pkt_queue_max;
456
457 /* BGP default timer. */
458 uint32_t default_holdtime;
459 uint32_t default_keepalive;
460
461 /* BGP graceful restart */
462 uint32_t restart_time;
463 uint32_t stalepath_time;
464
465 /* Maximum-paths configuration */
466 struct bgp_maxpaths_cfg {
467 uint16_t maxpaths_ebgp;
468 uint16_t maxpaths_ibgp;
469 uint16_t ibgp_flags;
470 #define BGP_FLAG_IBGP_MULTIPATH_SAME_CLUSTERLEN (1 << 0)
471 } maxpaths[AFI_MAX][SAFI_MAX];
472
473 _Atomic uint32_t wpkt_quanta; // max # packets to write per i/o cycle
474 _Atomic uint32_t rpkt_quanta; // max # packets to read per i/o cycle
475
476 /* Automatic coalesce adjust on/off */
477 bool heuristic_coalesce;
478 /* Actual coalesce time */
479 uint32_t coalesce_time;
480
481 /* Auto-shutdown new peers */
482 bool autoshutdown;
483
484 struct bgp_addpath_bgp_data tx_addpath;
485
486 #if ENABLE_BGP_VNC
487 struct rfapi_cfg *rfapi_cfg;
488 struct rfapi *rfapi;
489 #endif
490
491 /* EVPN related information */
492
493 /* EVI hash table */
494 struct hash *vnihash;
495
496 /* EVPN enable - advertise gateway macip routes */
497 int advertise_gw_macip;
498
499 /* EVPN enable - advertise local VNIs and their MACs etc. */
500 int advertise_all_vni;
501
502 /* RFC 8212 - prevent route leaks. */
503 int ebgp_requires_policy;
504 #define DEFAULT_EBGP_POLICY_DISABLED 0
505 #define DEFAULT_EBGP_POLICY_ENABLED 1
506
507 /* draft-ietf-idr-deprecate-as-set-confed-set
508 * Reject aspaths with AS_SET and/or AS_CONFED_SET.
509 */
510 bool reject_as_sets;
511 #define BGP_REJECT_AS_SETS_DISABLED 0
512 #define BGP_REJECT_AS_SETS_ENABLED 1
513
514 struct bgp_evpn_info *evpn_info;
515
516 /* EVPN - use RFC 8365 to auto-derive RT */
517 int advertise_autort_rfc8365;
518
519 /*
520 * Flooding mechanism for BUM packets for VxLAN-EVPN.
521 */
522 enum vxlan_flood_control vxlan_flood_ctrl;
523
524 /* Hash table of Import RTs to EVIs */
525 struct hash *import_rt_hash;
526
527 /* Hash table of VRF import RTs to VRFs */
528 struct hash *vrf_import_rt_hash;
529
530 /* L3-VNI corresponding to this vrf */
531 vni_t l3vni;
532
533 /* router-mac to be used in mac-ip routes for this vrf */
534 struct ethaddr rmac;
535
536 /* originator ip - to be used as NH for type-5 routes */
537 struct in_addr originator_ip;
538
539 /* SVI associated with the L3-VNI corresponding to this vrf */
540 ifindex_t l3vni_svi_ifindex;
541
542 /* vrf flags */
543 uint32_t vrf_flags;
544 #define BGP_VRF_AUTO (1 << 0)
545 #define BGP_VRF_IMPORT_RT_CFGD (1 << 1)
546 #define BGP_VRF_EXPORT_RT_CFGD (1 << 2)
547 #define BGP_VRF_RD_CFGD (1 << 3)
548 #define BGP_VRF_L3VNI_PREFIX_ROUTES_ONLY (1 << 4)
549
550
551 /* unique ID for auto derivation of RD for this vrf */
552 uint16_t vrf_rd_id;
553
554 /* Automatically derived RD for this VRF */
555 struct prefix_rd vrf_prd_auto;
556
557 /* RD for this VRF */
558 struct prefix_rd vrf_prd;
559
560 /* import rt list for the vrf instance */
561 struct list *vrf_import_rtl;
562
563 /* export rt list for the vrf instance */
564 struct list *vrf_export_rtl;
565
566 /* list of corresponding l2vnis (struct bgpevpn) */
567 struct list *l2vnis;
568
569 /* route map for advertise ipv4/ipv6 unicast (type-5 routes) */
570 struct bgp_rmap adv_cmd_rmap[AFI_MAX][SAFI_MAX];
571
572 struct vpn_policy vpn_policy[AFI_MAX];
573
574 struct bgp_pbr_config *bgp_pbr_cfg;
575
576 /* local esi hash table */
577 struct hash *esihash;
578
579 /* Count of peers in established state */
580 uint32_t established_peers;
581
582 QOBJ_FIELDS
583 };
584 DECLARE_QOBJ_TYPE(bgp)
585
586 DECLARE_HOOK(bgp_inst_delete, (struct bgp *bgp), (bgp))
587 DECLARE_HOOK(bgp_inst_config_write,
588 (struct bgp *bgp, struct vty *vty),
589 (bgp, vty))
590
591 #define BGP_ROUTE_ADV_HOLD(bgp) (bgp->main_peers_update_hold)
592
593 #define IS_BGP_INST_KNOWN_TO_ZEBRA(bgp) \
594 (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT \
595 || (bgp->inst_type == BGP_INSTANCE_TYPE_VRF \
596 && bgp->vrf_id != VRF_UNKNOWN))
597
598 /* BGP peer-group support. */
599 struct peer_group {
600 /* Name of the peer-group. */
601 char *name;
602
603 /* Pointer to BGP. */
604 struct bgp *bgp;
605
606 /* Peer-group client list. */
607 struct list *peer;
608
609 /** Dynamic neighbor listening ranges */
610 struct list *listen_range[AFI_MAX];
611
612 /* Peer-group config */
613 struct peer *conf;
614 };
615
616 /* BGP Notify message format. */
617 struct bgp_notify {
618 uint8_t code;
619 uint8_t subcode;
620 char *data;
621 bgp_size_t length;
622 uint8_t *raw_data;
623 };
624
625 /* Next hop self address. */
626 struct bgp_nexthop {
627 struct interface *ifp;
628 struct in_addr v4;
629 struct in6_addr v6_global;
630 struct in6_addr v6_local;
631 };
632
633 /* BGP addpath values */
634 #define BGP_ADDPATH_RX 1
635 #define BGP_ADDPATH_TX 2
636 #define BGP_ADDPATH_ID_LEN 4
637
638 #define BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE 1
639
640 /* Route map direction */
641 #define RMAP_IN 0
642 #define RMAP_OUT 1
643 #define RMAP_MAX 2
644
645 #define BGP_DEFAULT_TTL 1
646
647 #include "filter.h"
648
649 /* BGP filter structure. */
650 struct bgp_filter {
651 /* Distribute-list. */
652 struct {
653 char *name;
654 struct access_list *alist;
655 } dlist[FILTER_MAX];
656
657 /* Prefix-list. */
658 struct {
659 char *name;
660 struct prefix_list *plist;
661 } plist[FILTER_MAX];
662
663 /* Filter-list. */
664 struct {
665 char *name;
666 struct as_list *aslist;
667 } aslist[FILTER_MAX];
668
669 /* Route-map. */
670 struct {
671 char *name;
672 struct route_map *map;
673 } map[RMAP_MAX];
674
675 /* Unsuppress-map. */
676 struct {
677 char *name;
678 struct route_map *map;
679 } usmap;
680 };
681
682 /* IBGP/EBGP identifier. We also have a CONFED peer, which is to say,
683 a peer who's AS is part of our Confederation. */
684 typedef enum {
685 BGP_PEER_UNSPECIFIED,
686 BGP_PEER_IBGP,
687 BGP_PEER_EBGP,
688 BGP_PEER_INTERNAL,
689 BGP_PEER_CONFED,
690 } bgp_peer_sort_t;
691
692 /* BGP message header and packet size. */
693 #define BGP_MARKER_SIZE 16
694 #define BGP_HEADER_SIZE 19
695 #define BGP_MAX_PACKET_SIZE 4096
696 #define BGP_MAX_PACKET_SIZE_OVERFLOW 1024
697
698 /*
699 * Trigger delay for bgp_announce_route().
700 */
701 #define BGP_ANNOUNCE_ROUTE_SHORT_DELAY_MS 100
702 #define BGP_ANNOUNCE_ROUTE_DELAY_MS 500
703
704 struct peer_af {
705 /* back pointer to the peer */
706 struct peer *peer;
707
708 /* which subgroup the peer_af belongs to */
709 struct update_subgroup *subgroup;
710
711 /* for being part of an update subgroup's peer list */
712 LIST_ENTRY(peer_af) subgrp_train;
713
714 /* for being part of a packet's peer list */
715 LIST_ENTRY(peer_af) pkt_train;
716
717 struct bpacket *next_pkt_to_send;
718
719 /*
720 * Trigger timer for bgp_announce_route().
721 */
722 struct thread *t_announce_route;
723
724 afi_t afi;
725 safi_t safi;
726 int afid;
727 };
728
729 /* BGP neighbor structure. */
730 struct peer {
731 /* BGP structure. */
732 struct bgp *bgp;
733
734 /* reference count, primarily to allow bgp_process'ing of route_node's
735 * to be done after a struct peer is deleted.
736 *
737 * named 'lock' for hysterical reasons within Quagga.
738 */
739 int lock;
740
741 /* BGP peer group. */
742 struct peer_group *group;
743 uint64_t version[AFI_MAX][SAFI_MAX];
744
745 /* BGP peer_af structures, per configured AF on this peer */
746 struct peer_af *peer_af_array[BGP_AF_MAX];
747
748 /* Peer's remote AS number. */
749 int as_type;
750 as_t as;
751
752 /* Peer's local AS number. */
753 as_t local_as;
754
755 bgp_peer_sort_t sort;
756
757 /* Peer's Change local AS number. */
758 as_t change_local_as;
759
760 /* Remote router ID. */
761 struct in_addr remote_id;
762
763 /* Local router ID. */
764 struct in_addr local_id;
765
766 /* Packet receive and send buffer. */
767 pthread_mutex_t io_mtx; // guards ibuf, obuf
768 struct stream_fifo *ibuf; // packets waiting to be processed
769 struct stream_fifo *obuf; // packets waiting to be written
770
771 struct ringbuf *ibuf_work; // WiP buffer used by bgp_read() only
772 struct stream *obuf_work; // WiP buffer used to construct packets
773
774 struct stream *curr; // the current packet being parsed
775
776 /* We use a separate stream to encode MP_REACH_NLRI for efficient
777 * NLRI packing. peer->obuf_work stores all the other attributes. The
778 * actual packet is then constructed by concatenating the two.
779 */
780 struct stream *scratch;
781
782 /* the doppelganger peer structure, due to dual TCP conn setup */
783 struct peer *doppelganger;
784
785 /* Status of the peer. */
786 int status;
787 int ostatus;
788
789 /* FSM events, stored for debug purposes.
790 * Note: uchar used for reduced memory usage.
791 */
792 unsigned char cur_event;
793 unsigned char last_event;
794 unsigned char last_major_event;
795
796 /* Peer index, used for dumping TABLE_DUMP_V2 format */
797 uint16_t table_dump_index;
798
799 /* Peer information */
800 int fd; /* File descriptor */
801 int ttl; /* TTL of TCP connection to the peer. */
802 int rtt; /* Estimated round-trip-time from TCP_INFO */
803 int gtsm_hops; /* minimum hopcount to peer */
804 char *desc; /* Description of the peer. */
805 unsigned short port; /* Destination port for peer */
806 char *host; /* Printable address of the peer. */
807 union sockunion su; /* Sockunion address of the peer. */
808 #define BGP_PEER_SU_UNSPEC(peer) (peer->su.sa.sa_family == AF_UNSPEC)
809 time_t uptime; /* Last Up/Down time */
810 time_t readtime; /* Last read time */
811 time_t resettime; /* Last reset time */
812
813 char *conf_if; /* neighbor interface config name. */
814 struct interface *ifp; /* corresponding interface */
815 char *ifname; /* bind interface name. */
816 char *update_if;
817 union sockunion *update_source;
818
819 union sockunion *su_local; /* Sockunion of local address. */
820 union sockunion *su_remote; /* Sockunion of remote address. */
821 int shared_network; /* Is this peer shared same network. */
822 struct bgp_nexthop nexthop; /* Nexthop */
823
824 /* Peer address family configuration. */
825 uint8_t afc[AFI_MAX][SAFI_MAX];
826 uint8_t afc_nego[AFI_MAX][SAFI_MAX];
827 uint8_t afc_adv[AFI_MAX][SAFI_MAX];
828 uint8_t afc_recv[AFI_MAX][SAFI_MAX];
829
830 /* Capability flags (reset in bgp_stop) */
831 uint32_t cap;
832 #define PEER_CAP_REFRESH_ADV (1 << 0) /* refresh advertised */
833 #define PEER_CAP_REFRESH_OLD_RCV (1 << 1) /* refresh old received */
834 #define PEER_CAP_REFRESH_NEW_RCV (1 << 2) /* refresh rfc received */
835 #define PEER_CAP_DYNAMIC_ADV (1 << 3) /* dynamic advertised */
836 #define PEER_CAP_DYNAMIC_RCV (1 << 4) /* dynamic received */
837 #define PEER_CAP_RESTART_ADV (1 << 5) /* restart advertised */
838 #define PEER_CAP_RESTART_RCV (1 << 6) /* restart received */
839 #define PEER_CAP_AS4_ADV (1 << 7) /* as4 advertised */
840 #define PEER_CAP_AS4_RCV (1 << 8) /* as4 received */
841 #define PEER_CAP_RESTART_BIT_ADV (1 << 9) /* sent restart state */
842 #define PEER_CAP_RESTART_BIT_RCV (1 << 10) /* peer restart state */
843 #define PEER_CAP_ADDPATH_ADV (1 << 11) /* addpath advertised */
844 #define PEER_CAP_ADDPATH_RCV (1 << 12) /* addpath received */
845 #define PEER_CAP_ENHE_ADV (1 << 13) /* Extended nexthop advertised */
846 #define PEER_CAP_ENHE_RCV (1 << 14) /* Extended nexthop received */
847 #define PEER_CAP_HOSTNAME_ADV (1 << 15) /* hostname advertised */
848 #define PEER_CAP_HOSTNAME_RCV (1 << 16) /* hostname received */
849
850 /* Capability flags (reset in bgp_stop) */
851 uint32_t af_cap[AFI_MAX][SAFI_MAX];
852 #define PEER_CAP_ORF_PREFIX_SM_ADV (1 << 0) /* send-mode advertised */
853 #define PEER_CAP_ORF_PREFIX_RM_ADV (1 << 1) /* receive-mode advertised */
854 #define PEER_CAP_ORF_PREFIX_SM_RCV (1 << 2) /* send-mode received */
855 #define PEER_CAP_ORF_PREFIX_RM_RCV (1 << 3) /* receive-mode received */
856 #define PEER_CAP_ORF_PREFIX_SM_OLD_RCV (1 << 4) /* send-mode received */
857 #define PEER_CAP_ORF_PREFIX_RM_OLD_RCV (1 << 5) /* receive-mode received */
858 #define PEER_CAP_RESTART_AF_RCV (1 << 6) /* graceful restart afi/safi received */
859 #define PEER_CAP_RESTART_AF_PRESERVE_RCV (1 << 7) /* graceful restart afi/safi F-bit received */
860 #define PEER_CAP_ADDPATH_AF_TX_ADV (1 << 8) /* addpath tx advertised */
861 #define PEER_CAP_ADDPATH_AF_TX_RCV (1 << 9) /* addpath tx received */
862 #define PEER_CAP_ADDPATH_AF_RX_ADV (1 << 10) /* addpath rx advertised */
863 #define PEER_CAP_ADDPATH_AF_RX_RCV (1 << 11) /* addpath rx received */
864 #define PEER_CAP_ENHE_AF_ADV (1 << 12) /* Extended nexthopi afi/safi advertised */
865 #define PEER_CAP_ENHE_AF_RCV (1 << 13) /* Extended nexthop afi/safi received */
866 #define PEER_CAP_ENHE_AF_NEGO (1 << 14) /* Extended nexthop afi/safi negotiated */
867
868 /* Global configuration flags. */
869 /*
870 * Parallel array to flags that indicates whether each flag originates
871 * from a peer-group or if it is config that is specific to this
872 * individual peer. If a flag is set independent of the peer-group, the
873 * same bit should be set here. If this peer is a peer-group, this
874 * memory region should be all zeros.
875 *
876 * The assumption is that the default state for all flags is unset,
877 * so if a flag is unset, the corresponding override flag is unset too.
878 * However if a flag is set, the corresponding override flag is set.
879 */
880 uint32_t flags_override;
881 /*
882 * Parallel array to flags that indicates whether the default behavior
883 * of *flags_override* should be inverted. If a flag is unset and the
884 * corresponding invert flag is set, the corresponding override flag
885 * would be set. However if a flag is set and the corresponding invert
886 * flag is unset, the corresponding override flag would be unset.
887 *
888 * This can be used for attributes like *send-community*, which are
889 * implicitely enabled and have to be disabled explicitely, compared to
890 * 'normal' attributes like *next-hop-self* which are implicitely set.
891 *
892 * All operations dealing with flags should apply the following boolean
893 * logic to keep the internal flag system in a sane state:
894 *
895 * value=0 invert=0 Inherit flag if member, otherwise unset flag
896 * value=0 invert=1 Unset flag unconditionally
897 * value=1 invert=0 Set flag unconditionally
898 * value=1 invert=1 Inherit flag if member, otherwise set flag
899 *
900 * Contrary to the implementation of *flags_override*, the flag
901 * inversion state can be set either on the peer OR the peer *and* the
902 * peer-group. This was done on purpose, as the inversion state of a
903 * flag can be determined on either the peer or the peer-group.
904 *
905 * Example: Enabling the cisco configuration mode inverts all flags
906 * related to *send-community* unconditionally for both peer-groups and
907 * peers.
908 *
909 * This behavior is different for interface peers though, which enable
910 * the *extended-nexthop* flag by default, which regular peers do not.
911 * As the peer-group can contain both regular and interface peers, the
912 * flag inversion state must be set on the peer only.
913 *
914 * When a peer inherits the configuration from a peer-group and the
915 * inversion state of the flag differs between peer and peer-group, the
916 * newly set value must equal to the inverted state of the peer-group.
917 */
918 uint32_t flags_invert;
919 /*
920 * Effective array for storing the peer/peer-group flags. In case of a
921 * peer-group, the peer-specific overrides (see flags_override and
922 * flags_invert) must be respected.
923 */
924 uint32_t flags;
925 #define PEER_FLAG_PASSIVE (1 << 0) /* passive mode */
926 #define PEER_FLAG_SHUTDOWN (1 << 1) /* shutdown */
927 #define PEER_FLAG_DONT_CAPABILITY (1 << 2) /* dont-capability */
928 #define PEER_FLAG_OVERRIDE_CAPABILITY (1 << 3) /* override-capability */
929 #define PEER_FLAG_STRICT_CAP_MATCH (1 << 4) /* strict-match */
930 #define PEER_FLAG_DYNAMIC_CAPABILITY (1 << 5) /* dynamic capability */
931 #define PEER_FLAG_DISABLE_CONNECTED_CHECK (1 << 6) /* disable-connected-check */
932 #define PEER_FLAG_LOCAL_AS_NO_PREPEND (1 << 7) /* local-as no-prepend */
933 #define PEER_FLAG_LOCAL_AS_REPLACE_AS (1 << 8) /* local-as no-prepend replace-as */
934 #define PEER_FLAG_DELETE (1 << 9) /* mark the peer for deleting */
935 #define PEER_FLAG_CONFIG_NODE (1 << 10) /* the node to update configs on */
936 #define PEER_FLAG_LONESOUL (1 << 11)
937 #define PEER_FLAG_DYNAMIC_NEIGHBOR (1 << 12) /* dynamic neighbor */
938 #define PEER_FLAG_CAPABILITY_ENHE (1 << 13) /* Extended next-hop (rfc 5549)*/
939 #define PEER_FLAG_IFPEER_V6ONLY (1 << 14) /* if-based peer is v6 only */
940 #define PEER_FLAG_IS_RFAPI_HD (1 << 15) /* attached to rfapi HD */
941 #define PEER_FLAG_ENFORCE_FIRST_AS (1 << 16) /* enforce-first-as */
942 #define PEER_FLAG_ROUTEADV (1 << 17) /* route advertise */
943 #define PEER_FLAG_TIMER (1 << 18) /* keepalive & holdtime */
944 #define PEER_FLAG_TIMER_CONNECT (1 << 19) /* connect timer */
945 #define PEER_FLAG_PASSWORD (1 << 20) /* password */
946 #define PEER_FLAG_LOCAL_AS (1 << 21) /* local-as */
947 #define PEER_FLAG_UPDATE_SOURCE (1 << 22) /* update-source */
948
949 /* outgoing message sent in CEASE_ADMIN_SHUTDOWN notify */
950 char *tx_shutdown_message;
951
952 /* NSF mode (graceful restart) */
953 uint8_t nsf[AFI_MAX][SAFI_MAX];
954
955 /* Peer Per AF flags */
956 /*
957 * Please consult the comments for *flags_override*, *flags_invert* and
958 * *flags* to understand what these three arrays do. The address-family
959 * specific attributes are being treated the exact same way as global
960 * peer attributes.
961 */
962 uint32_t af_flags_override[AFI_MAX][SAFI_MAX];
963 uint32_t af_flags_invert[AFI_MAX][SAFI_MAX];
964 uint32_t af_flags[AFI_MAX][SAFI_MAX];
965 #define PEER_FLAG_SEND_COMMUNITY (1 << 0) /* send-community */
966 #define PEER_FLAG_SEND_EXT_COMMUNITY (1 << 1) /* send-community ext. */
967 #define PEER_FLAG_NEXTHOP_SELF (1 << 2) /* next-hop-self */
968 #define PEER_FLAG_REFLECTOR_CLIENT (1 << 3) /* reflector-client */
969 #define PEER_FLAG_RSERVER_CLIENT (1 << 4) /* route-server-client */
970 #define PEER_FLAG_SOFT_RECONFIG (1 << 5) /* soft-reconfiguration */
971 #define PEER_FLAG_AS_PATH_UNCHANGED (1 << 6) /* transparent-as */
972 #define PEER_FLAG_NEXTHOP_UNCHANGED (1 << 7) /* transparent-next-hop */
973 #define PEER_FLAG_MED_UNCHANGED (1 << 8) /* transparent-next-hop */
974 #define PEER_FLAG_DEFAULT_ORIGINATE (1 << 9) /* default-originate */
975 #define PEER_FLAG_REMOVE_PRIVATE_AS (1 << 10) /* remove-private-as */
976 #define PEER_FLAG_ALLOWAS_IN (1 << 11) /* set allowas-in */
977 #define PEER_FLAG_ORF_PREFIX_SM (1 << 12) /* orf capability send-mode */
978 #define PEER_FLAG_ORF_PREFIX_RM (1 << 13) /* orf capability receive-mode */
979 #define PEER_FLAG_MAX_PREFIX (1 << 14) /* maximum prefix */
980 #define PEER_FLAG_MAX_PREFIX_WARNING (1 << 15) /* maximum prefix warning-only */
981 #define PEER_FLAG_NEXTHOP_LOCAL_UNCHANGED (1 << 16) /* leave link-local nexthop unchanged */
982 #define PEER_FLAG_FORCE_NEXTHOP_SELF (1 << 17) /* next-hop-self force */
983 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL (1 << 18) /* remove-private-as all */
984 #define PEER_FLAG_REMOVE_PRIVATE_AS_REPLACE (1 << 19) /* remove-private-as replace-as */
985 #define PEER_FLAG_AS_OVERRIDE (1 << 20) /* as-override */
986 #define PEER_FLAG_REMOVE_PRIVATE_AS_ALL_REPLACE (1 << 21) /* remove-private-as all replace-as */
987 #define PEER_FLAG_WEIGHT (1 << 24) /* weight */
988 #define PEER_FLAG_ALLOWAS_IN_ORIGIN (1 << 25) /* allowas-in origin */
989 #define PEER_FLAG_SEND_LARGE_COMMUNITY (1 << 26) /* Send large Communities */
990
991 enum bgp_addpath_strat addpath_type[AFI_MAX][SAFI_MAX];
992
993 /* MD5 password */
994 char *password;
995
996 /* default-originate route-map. */
997 struct {
998 char *name;
999 struct route_map *map;
1000 } default_rmap[AFI_MAX][SAFI_MAX];
1001
1002 /* Peer status flags. */
1003 uint16_t sflags;
1004 #define PEER_STATUS_ACCEPT_PEER (1 << 0) /* accept peer */
1005 #define PEER_STATUS_PREFIX_OVERFLOW (1 << 1) /* prefix-overflow */
1006 #define PEER_STATUS_CAPABILITY_OPEN (1 << 2) /* capability open send */
1007 #define PEER_STATUS_HAVE_ACCEPT (1 << 3) /* accept peer's parent */
1008 #define PEER_STATUS_GROUP (1 << 4) /* peer-group conf */
1009 #define PEER_STATUS_NSF_MODE (1 << 5) /* NSF aware peer */
1010 #define PEER_STATUS_NSF_WAIT (1 << 6) /* wait comeback peer */
1011
1012 /* Peer status af flags (reset in bgp_stop) */
1013 uint16_t af_sflags[AFI_MAX][SAFI_MAX];
1014 #define PEER_STATUS_ORF_PREFIX_SEND (1 << 0) /* prefix-list send peer */
1015 #define PEER_STATUS_ORF_WAIT_REFRESH (1 << 1) /* wait refresh received peer */
1016 #define PEER_STATUS_PREFIX_THRESHOLD (1 << 2) /* exceed prefix-threshold */
1017 #define PEER_STATUS_PREFIX_LIMIT (1 << 3) /* exceed prefix-limit */
1018 #define PEER_STATUS_EOR_SEND (1 << 4) /* end-of-rib send to peer */
1019 #define PEER_STATUS_EOR_RECEIVED (1 << 5) /* end-of-rib received from peer */
1020
1021 /* Configured timer values. */
1022 _Atomic uint32_t holdtime;
1023 _Atomic uint32_t keepalive;
1024 _Atomic uint32_t connect;
1025 _Atomic uint32_t routeadv;
1026
1027 /* Timer values. */
1028 _Atomic uint32_t v_start;
1029 _Atomic uint32_t v_connect;
1030 _Atomic uint32_t v_holdtime;
1031 _Atomic uint32_t v_keepalive;
1032 _Atomic uint32_t v_routeadv;
1033 _Atomic uint32_t v_pmax_restart;
1034 _Atomic uint32_t v_gr_restart;
1035
1036 /* Threads. */
1037 struct thread *t_read;
1038 struct thread *t_write;
1039 struct thread *t_start;
1040 struct thread *t_connect_check_r;
1041 struct thread *t_connect_check_w;
1042 struct thread *t_connect;
1043 struct thread *t_holdtime;
1044 struct thread *t_routeadv;
1045 struct thread *t_pmax_restart;
1046 struct thread *t_gr_restart;
1047 struct thread *t_gr_stale;
1048 struct thread *t_generate_updgrp_packets;
1049 struct thread *t_process_packet;
1050
1051 /* Thread flags. */
1052 _Atomic uint32_t thread_flags;
1053 #define PEER_THREAD_WRITES_ON (1 << 0)
1054 #define PEER_THREAD_READS_ON (1 << 1)
1055 #define PEER_THREAD_KEEPALIVES_ON (1 << 2)
1056 /* workqueues */
1057 struct work_queue *clear_node_queue;
1058
1059 #define PEER_TOTAL_RX(peer) \
1060 atomic_load_explicit(&peer->open_in, memory_order_relaxed) \
1061 + atomic_load_explicit(&peer->update_in, memory_order_relaxed) \
1062 + atomic_load_explicit(&peer->notify_in, memory_order_relaxed) \
1063 + atomic_load_explicit(&peer->refresh_in, \
1064 memory_order_relaxed) \
1065 + atomic_load_explicit(&peer->keepalive_in, \
1066 memory_order_relaxed) \
1067 + atomic_load_explicit(&peer->dynamic_cap_in, \
1068 memory_order_relaxed)
1069
1070 #define PEER_TOTAL_TX(peer) \
1071 atomic_load_explicit(&peer->open_out, memory_order_relaxed) \
1072 + atomic_load_explicit(&peer->update_out, \
1073 memory_order_relaxed) \
1074 + atomic_load_explicit(&peer->notify_out, \
1075 memory_order_relaxed) \
1076 + atomic_load_explicit(&peer->refresh_out, \
1077 memory_order_relaxed) \
1078 + atomic_load_explicit(&peer->keepalive_out, \
1079 memory_order_relaxed) \
1080 + atomic_load_explicit(&peer->dynamic_cap_out, \
1081 memory_order_relaxed)
1082
1083 /* Statistics field */
1084 _Atomic uint32_t open_in; /* Open message input count */
1085 _Atomic uint32_t open_out; /* Open message output count */
1086 _Atomic uint32_t update_in; /* Update message input count */
1087 _Atomic uint32_t update_out; /* Update message ouput count */
1088 _Atomic time_t update_time; /* Update message received time. */
1089 _Atomic uint32_t keepalive_in; /* Keepalive input count */
1090 _Atomic uint32_t keepalive_out; /* Keepalive output count */
1091 _Atomic uint32_t notify_in; /* Notify input count */
1092 _Atomic uint32_t notify_out; /* Notify output count */
1093 _Atomic uint32_t refresh_in; /* Route Refresh input count */
1094 _Atomic uint32_t refresh_out; /* Route Refresh output count */
1095 _Atomic uint32_t dynamic_cap_in; /* Dynamic Capability input count. */
1096 _Atomic uint32_t dynamic_cap_out; /* Dynamic Capability output count. */
1097
1098 uint32_t stat_pfx_filter;
1099 uint32_t stat_pfx_aspath_loop;
1100 uint32_t stat_pfx_originator_loop;
1101 uint32_t stat_pfx_cluster_loop;
1102 uint32_t stat_pfx_nh_invalid;
1103 uint32_t stat_pfx_dup_withdraw;
1104 uint32_t stat_upd_7606; /* RFC7606: treat-as-withdraw */
1105
1106 /* BGP state count */
1107 uint32_t established; /* Established */
1108 uint32_t dropped; /* Dropped */
1109
1110 /* Update delay related fields */
1111 uint8_t update_delay_over; /* When this is set, BGP is no more waiting
1112 for EOR */
1113
1114 /* Syncronization list and time. */
1115 struct bgp_synchronize *sync[AFI_MAX][SAFI_MAX];
1116 time_t synctime;
1117 /* timestamp when the last UPDATE msg was written */
1118 _Atomic time_t last_write;
1119 /* timestamp when the last msg was written */
1120 _Atomic time_t last_update;
1121
1122 /* Send prefix count. */
1123 unsigned long scount[AFI_MAX][SAFI_MAX];
1124
1125 /* Notify data. */
1126 struct bgp_notify notify;
1127
1128 /* Filter structure. */
1129 struct bgp_filter filter[AFI_MAX][SAFI_MAX];
1130
1131 /*
1132 * Parallel array to filter that indicates whether each filter
1133 * originates from a peer-group or if it is config that is specific to
1134 * this individual peer. If a filter is set independent of the
1135 * peer-group the appropriate bit should be set here. If this peer is a
1136 * peer-group, this memory region should be all zeros. The assumption
1137 * is that the default state for all flags is unset. Due to filters
1138 * having a direction (e.g. in/out/...), this array has a third
1139 * dimension for storing the overrides independently per direction.
1140 *
1141 * Notes:
1142 * - if a filter for an individual peer is unset, the corresponding
1143 * override flag is unset and the peer is considered to be back in
1144 * sync with the peer-group.
1145 * - This does *not* contain the filter values, rather it contains
1146 * whether the filter in filter (struct bgp_filter) is peer-specific.
1147 */
1148 uint8_t filter_override[AFI_MAX][SAFI_MAX][(FILTER_MAX > RMAP_MAX)
1149 ? FILTER_MAX
1150 : RMAP_MAX];
1151 #define PEER_FT_DISTRIBUTE_LIST (1 << 0) /* distribute-list */
1152 #define PEER_FT_FILTER_LIST (1 << 1) /* filter-list */
1153 #define PEER_FT_PREFIX_LIST (1 << 2) /* prefix-list */
1154 #define PEER_FT_ROUTE_MAP (1 << 3) /* route-map */
1155 #define PEER_FT_UNSUPPRESS_MAP (1 << 4) /* unsuppress-map */
1156
1157 /* ORF Prefix-list */
1158 struct prefix_list *orf_plist[AFI_MAX][SAFI_MAX];
1159
1160 /* Text description of last attribute rcvd */
1161 char rcvd_attr_str[BUFSIZ];
1162
1163 /* Track if we printed the attribute in debugs */
1164 int rcvd_attr_printed;
1165
1166 /* Prefix count. */
1167 uint32_t pcount[AFI_MAX][SAFI_MAX];
1168
1169 /* Max prefix count. */
1170 uint32_t pmax[AFI_MAX][SAFI_MAX];
1171 uint8_t pmax_threshold[AFI_MAX][SAFI_MAX];
1172 uint16_t pmax_restart[AFI_MAX][SAFI_MAX];
1173 #define MAXIMUM_PREFIX_THRESHOLD_DEFAULT 75
1174
1175 /* allowas-in. */
1176 char allowas_in[AFI_MAX][SAFI_MAX];
1177
1178 /* weight */
1179 unsigned long weight[AFI_MAX][SAFI_MAX];
1180
1181 /* peer reset cause */
1182 uint8_t last_reset;
1183 #define PEER_DOWN_RID_CHANGE 1 /* bgp router-id command */
1184 #define PEER_DOWN_REMOTE_AS_CHANGE 2 /* neighbor remote-as command */
1185 #define PEER_DOWN_LOCAL_AS_CHANGE 3 /* neighbor local-as command */
1186 #define PEER_DOWN_CLID_CHANGE 4 /* bgp cluster-id command */
1187 #define PEER_DOWN_CONFED_ID_CHANGE 5 /* bgp confederation identifier command */
1188 #define PEER_DOWN_CONFED_PEER_CHANGE 6 /* bgp confederation peer command */
1189 #define PEER_DOWN_RR_CLIENT_CHANGE 7 /* neighbor route-reflector-client command */
1190 #define PEER_DOWN_RS_CLIENT_CHANGE 8 /* neighbor route-server-client command */
1191 #define PEER_DOWN_UPDATE_SOURCE_CHANGE 9 /* neighbor update-source command */
1192 #define PEER_DOWN_AF_ACTIVATE 10 /* neighbor activate command */
1193 #define PEER_DOWN_USER_SHUTDOWN 11 /* neighbor shutdown command */
1194 #define PEER_DOWN_USER_RESET 12 /* clear ip bgp command */
1195 #define PEER_DOWN_NOTIFY_RECEIVED 13 /* notification received */
1196 #define PEER_DOWN_NOTIFY_SEND 14 /* notification send */
1197 #define PEER_DOWN_CLOSE_SESSION 15 /* tcp session close */
1198 #define PEER_DOWN_NEIGHBOR_DELETE 16 /* neghbor delete */
1199 #define PEER_DOWN_RMAP_BIND 17 /* neghbor peer-group command */
1200 #define PEER_DOWN_RMAP_UNBIND 18 /* no neighbor peer-group command */
1201 #define PEER_DOWN_CAPABILITY_CHANGE 19 /* neighbor capability command */
1202 #define PEER_DOWN_PASSIVE_CHANGE 20 /* neighbor passive command */
1203 #define PEER_DOWN_MULTIHOP_CHANGE 21 /* neighbor multihop command */
1204 #define PEER_DOWN_NSF_CLOSE_SESSION 22 /* NSF tcp session close */
1205 #define PEER_DOWN_V6ONLY_CHANGE 23 /* if-based peering v6only toggled */
1206 #define PEER_DOWN_BFD_DOWN 24 /* BFD down */
1207 #define PEER_DOWN_IF_DOWN 25 /* Interface down */
1208 #define PEER_DOWN_NBR_ADDR_DEL 26 /* Peer address lost */
1209 #define PEER_DOWN_WAITING_NHT 27 /* Waiting for NHT to resolve */
1210 #define PEER_DOWN_NBR_ADDR 28 /* Waiting for peer IPv6 IP Addr */
1211 #define PEER_DOWN_VRF_UNINIT 29 /* Associated VRF is not init yet */
1212 #define PEER_DOWN_NOAFI_ACTIVATED 30 /* No AFI/SAFI activated for peer */
1213 #define PEER_DOWN_AS_SETS_REJECT 31 /* Reject routes with AS_SET */
1214 size_t last_reset_cause_size;
1215 uint8_t last_reset_cause[BGP_MAX_PACKET_SIZE];
1216
1217 /* The kind of route-map Flags.*/
1218 uint16_t rmap_type;
1219 #define PEER_RMAP_TYPE_IN (1 << 0) /* neighbor route-map in */
1220 #define PEER_RMAP_TYPE_OUT (1 << 1) /* neighbor route-map out */
1221 #define PEER_RMAP_TYPE_NETWORK (1 << 2) /* network route-map */
1222 #define PEER_RMAP_TYPE_REDISTRIBUTE (1 << 3) /* redistribute route-map */
1223 #define PEER_RMAP_TYPE_DEFAULT (1 << 4) /* default-originate route-map */
1224 #define PEER_RMAP_TYPE_NOSET (1 << 5) /* not allow to set commands */
1225 #define PEER_RMAP_TYPE_IMPORT (1 << 6) /* neighbor route-map import */
1226 #define PEER_RMAP_TYPE_EXPORT (1 << 7) /* neighbor route-map export */
1227 #define PEER_RMAP_TYPE_AGGREGATE (1 << 8) /* aggregate-address route-map */
1228
1229 /* peer specific BFD information */
1230 struct bfd_info *bfd_info;
1231
1232 /* hostname and domainname advertised by host */
1233 char *hostname;
1234 char *domainname;
1235
1236 /* Sender side AS path loop detection. */
1237 bool as_path_loop_detection;
1238
1239 QOBJ_FIELDS
1240 };
1241 DECLARE_QOBJ_TYPE(peer)
1242
1243 /* Inherit peer attribute from peer-group. */
1244 #define PEER_ATTR_INHERIT(peer, group, attr) \
1245 ((peer)->attr = (group)->conf->attr)
1246 #define PEER_STR_ATTR_INHERIT(peer, group, attr, mt) \
1247 do { \
1248 if ((peer)->attr) \
1249 XFREE(mt, (peer)->attr); \
1250 if ((group)->conf->attr) \
1251 (peer)->attr = XSTRDUP(mt, (group)->conf->attr); \
1252 else \
1253 (peer)->attr = NULL; \
1254 } while (0)
1255 #define PEER_SU_ATTR_INHERIT(peer, group, attr) \
1256 do { \
1257 if ((peer)->attr) \
1258 sockunion_free((peer)->attr); \
1259 if ((group)->conf->attr) \
1260 (peer)->attr = sockunion_dup((group)->conf->attr); \
1261 else \
1262 (peer)->attr = NULL; \
1263 } while (0)
1264
1265 /* Check if suppress start/restart of sessions to peer. */
1266 #define BGP_PEER_START_SUPPRESSED(P) \
1267 (CHECK_FLAG((P)->flags, PEER_FLAG_SHUTDOWN) \
1268 || CHECK_FLAG((P)->sflags, PEER_STATUS_PREFIX_OVERFLOW))
1269
1270 #define PEER_PASSWORD_MINLEN (1)
1271 #define PEER_PASSWORD_MAXLEN (80)
1272
1273 /* This structure's member directly points incoming packet data
1274 stream. */
1275 struct bgp_nlri {
1276 /* AFI. */
1277 uint16_t afi; /* iana_afi_t */
1278
1279 /* SAFI. */
1280 uint8_t safi; /* iana_safi_t */
1281
1282 /* Pointer to NLRI byte stream. */
1283 uint8_t *nlri;
1284
1285 /* Length of whole NLRI. */
1286 bgp_size_t length;
1287 };
1288
1289 /* BGP versions. */
1290 #define BGP_VERSION_4 4
1291
1292 /* Default BGP port number. */
1293 #define BGP_PORT_DEFAULT 179
1294
1295 /* BGP minimum message size. */
1296 #define BGP_MSG_OPEN_MIN_SIZE (BGP_HEADER_SIZE + 10)
1297 #define BGP_MSG_UPDATE_MIN_SIZE (BGP_HEADER_SIZE + 4)
1298 #define BGP_MSG_NOTIFY_MIN_SIZE (BGP_HEADER_SIZE + 2)
1299 #define BGP_MSG_KEEPALIVE_MIN_SIZE (BGP_HEADER_SIZE + 0)
1300 #define BGP_MSG_ROUTE_REFRESH_MIN_SIZE (BGP_HEADER_SIZE + 4)
1301 #define BGP_MSG_CAPABILITY_MIN_SIZE (BGP_HEADER_SIZE + 3)
1302
1303 /* BGP message types. */
1304 #define BGP_MSG_OPEN 1
1305 #define BGP_MSG_UPDATE 2
1306 #define BGP_MSG_NOTIFY 3
1307 #define BGP_MSG_KEEPALIVE 4
1308 #define BGP_MSG_ROUTE_REFRESH_NEW 5
1309 #define BGP_MSG_CAPABILITY 6
1310 #define BGP_MSG_ROUTE_REFRESH_OLD 128
1311
1312 /* BGP open optional parameter. */
1313 #define BGP_OPEN_OPT_AUTH 1
1314 #define BGP_OPEN_OPT_CAP 2
1315
1316 /* BGP4 attribute type codes. */
1317 #define BGP_ATTR_ORIGIN 1
1318 #define BGP_ATTR_AS_PATH 2
1319 #define BGP_ATTR_NEXT_HOP 3
1320 #define BGP_ATTR_MULTI_EXIT_DISC 4
1321 #define BGP_ATTR_LOCAL_PREF 5
1322 #define BGP_ATTR_ATOMIC_AGGREGATE 6
1323 #define BGP_ATTR_AGGREGATOR 7
1324 #define BGP_ATTR_COMMUNITIES 8
1325 #define BGP_ATTR_ORIGINATOR_ID 9
1326 #define BGP_ATTR_CLUSTER_LIST 10
1327 #define BGP_ATTR_DPA 11
1328 #define BGP_ATTR_ADVERTISER 12
1329 #define BGP_ATTR_RCID_PATH 13
1330 #define BGP_ATTR_MP_REACH_NLRI 14
1331 #define BGP_ATTR_MP_UNREACH_NLRI 15
1332 #define BGP_ATTR_EXT_COMMUNITIES 16
1333 #define BGP_ATTR_AS4_PATH 17
1334 #define BGP_ATTR_AS4_AGGREGATOR 18
1335 #define BGP_ATTR_AS_PATHLIMIT 21
1336 #define BGP_ATTR_PMSI_TUNNEL 22
1337 #define BGP_ATTR_ENCAP 23
1338 #define BGP_ATTR_LARGE_COMMUNITIES 32
1339 #define BGP_ATTR_PREFIX_SID 40
1340 #if ENABLE_BGP_VNC_ATTR
1341 #define BGP_ATTR_VNC 255
1342 #endif
1343
1344 /* BGP update origin. */
1345 #define BGP_ORIGIN_IGP 0
1346 #define BGP_ORIGIN_EGP 1
1347 #define BGP_ORIGIN_INCOMPLETE 2
1348
1349 /* BGP notify message codes. */
1350 #define BGP_NOTIFY_HEADER_ERR 1
1351 #define BGP_NOTIFY_OPEN_ERR 2
1352 #define BGP_NOTIFY_UPDATE_ERR 3
1353 #define BGP_NOTIFY_HOLD_ERR 4
1354 #define BGP_NOTIFY_FSM_ERR 5
1355 #define BGP_NOTIFY_CEASE 6
1356 #define BGP_NOTIFY_CAPABILITY_ERR 7
1357
1358 #define BGP_NOTIFY_SUBCODE_UNSPECIFIC 0
1359
1360 /* BGP_NOTIFY_HEADER_ERR sub codes. */
1361 #define BGP_NOTIFY_HEADER_NOT_SYNC 1
1362 #define BGP_NOTIFY_HEADER_BAD_MESLEN 2
1363 #define BGP_NOTIFY_HEADER_BAD_MESTYPE 3
1364
1365 /* BGP_NOTIFY_OPEN_ERR sub codes. */
1366 #define BGP_NOTIFY_OPEN_MALFORMED_ATTR 0
1367 #define BGP_NOTIFY_OPEN_UNSUP_VERSION 1
1368 #define BGP_NOTIFY_OPEN_BAD_PEER_AS 2
1369 #define BGP_NOTIFY_OPEN_BAD_BGP_IDENT 3
1370 #define BGP_NOTIFY_OPEN_UNSUP_PARAM 4
1371 #define BGP_NOTIFY_OPEN_AUTH_FAILURE 5
1372 #define BGP_NOTIFY_OPEN_UNACEP_HOLDTIME 6
1373 #define BGP_NOTIFY_OPEN_UNSUP_CAPBL 7
1374
1375 /* BGP_NOTIFY_UPDATE_ERR sub codes. */
1376 #define BGP_NOTIFY_UPDATE_MAL_ATTR 1
1377 #define BGP_NOTIFY_UPDATE_UNREC_ATTR 2
1378 #define BGP_NOTIFY_UPDATE_MISS_ATTR 3
1379 #define BGP_NOTIFY_UPDATE_ATTR_FLAG_ERR 4
1380 #define BGP_NOTIFY_UPDATE_ATTR_LENG_ERR 5
1381 #define BGP_NOTIFY_UPDATE_INVAL_ORIGIN 6
1382 #define BGP_NOTIFY_UPDATE_AS_ROUTE_LOOP 7
1383 #define BGP_NOTIFY_UPDATE_INVAL_NEXT_HOP 8
1384 #define BGP_NOTIFY_UPDATE_OPT_ATTR_ERR 9
1385 #define BGP_NOTIFY_UPDATE_INVAL_NETWORK 10
1386 #define BGP_NOTIFY_UPDATE_MAL_AS_PATH 11
1387
1388 /* BGP_NOTIFY_CEASE sub codes (RFC 4486). */
1389 #define BGP_NOTIFY_CEASE_MAX_PREFIX 1
1390 #define BGP_NOTIFY_CEASE_ADMIN_SHUTDOWN 2
1391 #define BGP_NOTIFY_CEASE_PEER_UNCONFIG 3
1392 #define BGP_NOTIFY_CEASE_ADMIN_RESET 4
1393 #define BGP_NOTIFY_CEASE_CONNECT_REJECT 5
1394 #define BGP_NOTIFY_CEASE_CONFIG_CHANGE 6
1395 #define BGP_NOTIFY_CEASE_COLLISION_RESOLUTION 7
1396 #define BGP_NOTIFY_CEASE_OUT_OF_RESOURCE 8
1397
1398 /* BGP_NOTIFY_CAPABILITY_ERR sub codes (draft-ietf-idr-dynamic-cap-02). */
1399 #define BGP_NOTIFY_CAPABILITY_INVALID_ACTION 1
1400 #define BGP_NOTIFY_CAPABILITY_INVALID_LENGTH 2
1401 #define BGP_NOTIFY_CAPABILITY_MALFORMED_CODE 3
1402
1403 /* BGP finite state machine status. */
1404 #define Idle 1
1405 #define Connect 2
1406 #define Active 3
1407 #define OpenSent 4
1408 #define OpenConfirm 5
1409 #define Established 6
1410 #define Clearing 7
1411 #define Deleted 8
1412 #define BGP_STATUS_MAX 9
1413
1414 /* BGP finite state machine events. */
1415 #define BGP_Start 1
1416 #define BGP_Stop 2
1417 #define TCP_connection_open 3
1418 #define TCP_connection_closed 4
1419 #define TCP_connection_open_failed 5
1420 #define TCP_fatal_error 6
1421 #define ConnectRetry_timer_expired 7
1422 #define Hold_Timer_expired 8
1423 #define KeepAlive_timer_expired 9
1424 #define Receive_OPEN_message 10
1425 #define Receive_KEEPALIVE_message 11
1426 #define Receive_UPDATE_message 12
1427 #define Receive_NOTIFICATION_message 13
1428 #define Clearing_Completed 14
1429 #define BGP_EVENTS_MAX 15
1430
1431 /* BGP timers default value. */
1432 /* note: the DFLT_ ones depend on compile-time "defaults" selection */
1433 #define BGP_INIT_START_TIMER 1
1434 #define BGP_DEFAULT_HOLDTIME DFLT_BGP_HOLDTIME
1435 #define BGP_DEFAULT_KEEPALIVE DFLT_BGP_KEEPALIVE
1436 #define BGP_DEFAULT_EBGP_ROUTEADV 0
1437 #define BGP_DEFAULT_IBGP_ROUTEADV 0
1438 #define BGP_DEFAULT_CONNECT_RETRY DFLT_BGP_TIMERS_CONNECT
1439
1440 /* BGP default local preference. */
1441 #define BGP_DEFAULT_LOCAL_PREF 100
1442
1443 /* BGP local-preference to send when 'bgp graceful-shutdown'
1444 * is configured */
1445 #define BGP_GSHUT_LOCAL_PREF 0
1446
1447 /* BGP default subgroup packet queue max . */
1448 #define BGP_DEFAULT_SUBGROUP_PKT_QUEUE_MAX 40
1449
1450 /* BGP graceful restart */
1451 #define BGP_DEFAULT_RESTART_TIME 120
1452 #define BGP_DEFAULT_STALEPATH_TIME 360
1453
1454 /* BGP uptime string length. */
1455 #define BGP_UPTIME_LEN 25
1456
1457 /* Default configuration settings for bgpd. */
1458 #define BGP_VTY_PORT 2605
1459 #define BGP_DEFAULT_CONFIG "bgpd.conf"
1460
1461 /* BGP Dynamic Neighbors feature */
1462 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_DEFAULT 100
1463 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MIN 1
1464 #define BGP_DYNAMIC_NEIGHBORS_LIMIT_MAX 5000
1465
1466 /* Flag for peer_clear_soft(). */
1467 enum bgp_clear_type {
1468 BGP_CLEAR_SOFT_NONE,
1469 BGP_CLEAR_SOFT_OUT,
1470 BGP_CLEAR_SOFT_IN,
1471 BGP_CLEAR_SOFT_BOTH,
1472 BGP_CLEAR_SOFT_IN_ORF_PREFIX
1473 };
1474
1475 /* Macros. */
1476 #define BGP_INPUT(P) ((P)->curr)
1477 #define BGP_INPUT_PNT(P) (stream_pnt(BGP_INPUT(P)))
1478 #define BGP_IS_VALID_STATE_FOR_NOTIF(S) \
1479 (((S) == OpenSent) || ((S) == OpenConfirm) || ((S) == Established))
1480
1481 /* BGP error codes. */
1482 #define BGP_SUCCESS 0
1483 #define BGP_ERR_INVALID_VALUE -1
1484 #define BGP_ERR_INVALID_FLAG -2
1485 #define BGP_ERR_INVALID_AS -3
1486 #define BGP_ERR_INVALID_BGP -4
1487 #define BGP_ERR_PEER_GROUP_MEMBER -5
1488 #define BGP_ERR_PEER_GROUP_NO_REMOTE_AS -7
1489 #define BGP_ERR_PEER_GROUP_CANT_CHANGE -8
1490 #define BGP_ERR_PEER_GROUP_MISMATCH -9
1491 #define BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT -10
1492 #define BGP_ERR_AS_MISMATCH -12
1493 #define BGP_ERR_PEER_FLAG_CONFLICT -13
1494 #define BGP_ERR_PEER_GROUP_SHUTDOWN -14
1495 #define BGP_ERR_PEER_FILTER_CONFLICT -15
1496 #define BGP_ERR_NOT_INTERNAL_PEER -16
1497 #define BGP_ERR_REMOVE_PRIVATE_AS -17
1498 #define BGP_ERR_AF_UNCONFIGURED -18
1499 #define BGP_ERR_SOFT_RECONFIG_UNCONFIGURED -19
1500 #define BGP_ERR_INSTANCE_MISMATCH -20
1501 #define BGP_ERR_LOCAL_AS_ALLOWED_ONLY_FOR_EBGP -21
1502 #define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS -22
1503 #define BGP_ERR_TCPSIG_FAILED -23
1504 #define BGP_ERR_NO_EBGP_MULTIHOP_WITH_TTLHACK -24
1505 #define BGP_ERR_NO_IBGP_WITH_TTLHACK -25
1506 #define BGP_ERR_NO_INTERFACE_CONFIG -26
1507 #define BGP_ERR_CANNOT_HAVE_LOCAL_AS_SAME_AS_REMOTE_AS -27
1508 #define BGP_ERR_AS_OVERRIDE -28
1509 #define BGP_ERR_INVALID_DYNAMIC_NEIGHBORS_LIMIT -29
1510 #define BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_EXISTS -30
1511 #define BGP_ERR_DYNAMIC_NEIGHBORS_RANGE_NOT_FOUND -31
1512 #define BGP_ERR_INVALID_FOR_DYNAMIC_PEER -32
1513 #define BGP_ERR_MAX -33
1514 #define BGP_ERR_INVALID_FOR_DIRECT_PEER -34
1515 #define BGP_ERR_PEER_SAFI_CONFLICT -35
1516
1517 /*
1518 * Enumeration of different policy kinds a peer can be configured with.
1519 */
1520 typedef enum {
1521 BGP_POLICY_ROUTE_MAP,
1522 BGP_POLICY_FILTER_LIST,
1523 BGP_POLICY_PREFIX_LIST,
1524 BGP_POLICY_DISTRIBUTE_LIST,
1525 } bgp_policy_type_e;
1526
1527 /* peer_flag_change_type. */
1528 enum peer_change_type {
1529 peer_change_none,
1530 peer_change_reset,
1531 peer_change_reset_in,
1532 peer_change_reset_out,
1533 };
1534
1535 extern struct bgp_master *bm;
1536 extern unsigned int multipath_num;
1537
1538 /* Prototypes. */
1539 extern void bgp_terminate(void);
1540 extern void bgp_reset(void);
1541 extern time_t bgp_clock(void);
1542 extern void bgp_zclient_reset(void);
1543 extern struct bgp *bgp_get_default(void);
1544 extern struct bgp *bgp_lookup(as_t, const char *);
1545 extern struct bgp *bgp_lookup_by_name(const char *);
1546 extern struct bgp *bgp_lookup_by_vrf_id(vrf_id_t);
1547 extern struct bgp *bgp_get_evpn(void);
1548 extern void bgp_set_evpn(struct bgp *bgp);
1549 extern struct peer *peer_lookup(struct bgp *, union sockunion *);
1550 extern struct peer *peer_lookup_by_conf_if(struct bgp *, const char *);
1551 extern struct peer *peer_lookup_by_hostname(struct bgp *, const char *);
1552 extern void bgp_peer_conf_if_to_su_update(struct peer *);
1553 extern int peer_group_listen_range_del(struct peer_group *, struct prefix *);
1554 extern struct peer_group *peer_group_lookup(struct bgp *, const char *);
1555 extern struct peer_group *peer_group_get(struct bgp *, const char *);
1556 extern struct peer *peer_create_bind_dynamic_neighbor(struct bgp *,
1557 union sockunion *,
1558 struct peer_group *);
1559 extern struct prefix *
1560 peer_group_lookup_dynamic_neighbor_range(struct peer_group *, struct prefix *);
1561 extern struct peer_group *peer_group_lookup_dynamic_neighbor(struct bgp *,
1562 struct prefix *,
1563 struct prefix **);
1564 extern struct peer *peer_lookup_dynamic_neighbor(struct bgp *,
1565 union sockunion *);
1566
1567 /*
1568 * Peers are incredibly easy to memory leak
1569 * due to the various ways that they are actually used
1570 * Provide some functionality to debug locks and unlocks
1571 */
1572 extern struct peer *peer_lock_with_caller(const char *, struct peer *);
1573 extern struct peer *peer_unlock_with_caller(const char *, struct peer *);
1574 #define peer_unlock(A) peer_unlock_with_caller(__FUNCTION__, (A))
1575 #define peer_lock(B) peer_lock_with_caller(__FUNCTION__, (B))
1576
1577 extern bgp_peer_sort_t peer_sort(struct peer *peer);
1578 extern int peer_active(struct peer *);
1579 extern int peer_active_nego(struct peer *);
1580 extern void bgp_recalculate_all_bestpaths(struct bgp *bgp);
1581 extern struct peer *peer_create(union sockunion *, const char *, struct bgp *,
1582 as_t, as_t, int, afi_t, safi_t,
1583 struct peer_group *);
1584 extern struct peer *peer_create_accept(struct bgp *);
1585 extern void peer_xfer_config(struct peer *dst, struct peer *src);
1586 extern char *peer_uptime(time_t uptime2, char *buf, size_t len, bool use_json,
1587 json_object *json);
1588
1589 extern int bgp_config_write(struct vty *);
1590
1591 extern void bgp_master_init(struct thread_master *master,
1592 const int buffer_size);
1593
1594 extern void bgp_init(unsigned short instance);
1595 extern void bgp_pthreads_run(void);
1596 extern void bgp_pthreads_finish(void);
1597 extern void bgp_route_map_init(void);
1598 extern void bgp_session_reset(struct peer *);
1599
1600 extern int bgp_option_set(int);
1601 extern int bgp_option_unset(int);
1602 extern int bgp_option_check(int);
1603
1604 extern int bgp_get(struct bgp **, as_t *, const char *, enum bgp_instance_type);
1605 extern void bgp_instance_up(struct bgp *);
1606 extern void bgp_instance_down(struct bgp *);
1607 extern int bgp_delete(struct bgp *);
1608
1609 extern int bgp_handle_socket(struct bgp *bgp, struct vrf *vrf,
1610 vrf_id_t old_vrf_id, bool create);
1611
1612 extern int bgp_flag_set(struct bgp *, int);
1613 extern int bgp_flag_unset(struct bgp *, int);
1614 extern int bgp_flag_check(struct bgp *, int);
1615
1616 extern void bgp_router_id_zebra_bump(vrf_id_t, const struct prefix *);
1617 extern int bgp_router_id_static_set(struct bgp *, struct in_addr);
1618
1619 extern int bgp_cluster_id_set(struct bgp *, struct in_addr *);
1620 extern int bgp_cluster_id_unset(struct bgp *);
1621
1622 extern int bgp_confederation_id_set(struct bgp *, as_t);
1623 extern int bgp_confederation_id_unset(struct bgp *);
1624 extern int bgp_confederation_peers_check(struct bgp *, as_t);
1625
1626 extern int bgp_confederation_peers_add(struct bgp *, as_t);
1627 extern int bgp_confederation_peers_remove(struct bgp *, as_t);
1628
1629 extern int bgp_timers_set(struct bgp *, uint32_t keepalive, uint32_t holdtime);
1630 extern int bgp_timers_unset(struct bgp *);
1631
1632 extern int bgp_default_local_preference_set(struct bgp *, uint32_t);
1633 extern int bgp_default_local_preference_unset(struct bgp *);
1634
1635 extern int bgp_default_subgroup_pkt_queue_max_set(struct bgp *bgp, uint32_t);
1636 extern int bgp_default_subgroup_pkt_queue_max_unset(struct bgp *bgp);
1637
1638 extern int bgp_listen_limit_set(struct bgp *, int);
1639 extern int bgp_listen_limit_unset(struct bgp *);
1640
1641 extern int bgp_update_delay_active(struct bgp *);
1642 extern int bgp_update_delay_configured(struct bgp *);
1643 extern int bgp_afi_safi_peer_exists(struct bgp *bgp, afi_t afi, safi_t safi);
1644 extern void peer_as_change(struct peer *, as_t, int);
1645 extern int peer_remote_as(struct bgp *, union sockunion *, const char *, as_t *,
1646 int, afi_t, safi_t);
1647 extern int peer_group_remote_as(struct bgp *, const char *, as_t *, int);
1648 extern int peer_delete(struct peer *peer);
1649 extern int peer_notify_unconfig(struct peer *peer);
1650 extern int peer_group_delete(struct peer_group *);
1651 extern int peer_group_remote_as_delete(struct peer_group *);
1652 extern int peer_group_listen_range_add(struct peer_group *, struct prefix *);
1653 extern int peer_group_notify_unconfig(struct peer_group *group);
1654
1655 extern int peer_activate(struct peer *, afi_t, safi_t);
1656 extern int peer_deactivate(struct peer *, afi_t, safi_t);
1657 extern int peer_afc_set(struct peer *, afi_t, safi_t, int);
1658
1659 extern int peer_group_bind(struct bgp *, union sockunion *, struct peer *,
1660 struct peer_group *, as_t *);
1661
1662 extern int peer_flag_set(struct peer *, uint32_t);
1663 extern int peer_flag_unset(struct peer *, uint32_t);
1664 extern void peer_flag_inherit(struct peer *peer, uint32_t flag);
1665
1666 extern int peer_af_flag_set(struct peer *, afi_t, safi_t, uint32_t);
1667 extern int peer_af_flag_unset(struct peer *, afi_t, safi_t, uint32_t);
1668 extern int peer_af_flag_check(struct peer *, afi_t, safi_t, uint32_t);
1669 extern void peer_af_flag_inherit(struct peer *peer, afi_t afi, safi_t safi,
1670 uint32_t flag);
1671 extern void peer_change_action(struct peer *peer, afi_t afi, safi_t safi,
1672 enum peer_change_type type);
1673
1674 extern int peer_ebgp_multihop_set(struct peer *, int);
1675 extern int peer_ebgp_multihop_unset(struct peer *);
1676 extern int is_ebgp_multihop_configured(struct peer *peer);
1677
1678 extern int peer_description_set(struct peer *, const char *);
1679 extern int peer_description_unset(struct peer *);
1680
1681 extern int peer_update_source_if_set(struct peer *, const char *);
1682 extern int peer_update_source_addr_set(struct peer *, const union sockunion *);
1683 extern int peer_update_source_unset(struct peer *);
1684
1685 extern int peer_default_originate_set(struct peer *peer, afi_t afi, safi_t safi,
1686 const char *rmap,
1687 struct route_map *route_map);
1688 extern int peer_default_originate_unset(struct peer *, afi_t, safi_t);
1689
1690 extern int peer_port_set(struct peer *, uint16_t);
1691 extern int peer_port_unset(struct peer *);
1692
1693 extern int peer_weight_set(struct peer *, afi_t, safi_t, uint16_t);
1694 extern int peer_weight_unset(struct peer *, afi_t, safi_t);
1695
1696 extern int peer_timers_set(struct peer *, uint32_t keepalive,
1697 uint32_t holdtime);
1698 extern int peer_timers_unset(struct peer *);
1699
1700 extern int peer_timers_connect_set(struct peer *, uint32_t);
1701 extern int peer_timers_connect_unset(struct peer *);
1702
1703 extern int peer_advertise_interval_set(struct peer *, uint32_t);
1704 extern int peer_advertise_interval_unset(struct peer *);
1705
1706 extern void peer_interface_set(struct peer *, const char *);
1707 extern void peer_interface_unset(struct peer *);
1708
1709 extern int peer_distribute_set(struct peer *, afi_t, safi_t, int, const char *);
1710 extern int peer_distribute_unset(struct peer *, afi_t, safi_t, int);
1711
1712 extern int peer_allowas_in_set(struct peer *, afi_t, safi_t, int, int);
1713 extern int peer_allowas_in_unset(struct peer *, afi_t, safi_t);
1714
1715 extern int peer_local_as_set(struct peer *, as_t, int, int);
1716 extern int peer_local_as_unset(struct peer *);
1717
1718 extern int peer_prefix_list_set(struct peer *, afi_t, safi_t, int,
1719 const char *);
1720 extern int peer_prefix_list_unset(struct peer *, afi_t, safi_t, int);
1721
1722 extern int peer_aslist_set(struct peer *, afi_t, safi_t, int, const char *);
1723 extern int peer_aslist_unset(struct peer *, afi_t, safi_t, int);
1724
1725 extern int peer_route_map_set(struct peer *peer, afi_t afi, safi_t safi, int,
1726 const char *name, struct route_map *route_map);
1727 extern int peer_route_map_unset(struct peer *, afi_t, safi_t, int);
1728
1729 extern int peer_unsuppress_map_set(struct peer *peer, afi_t afi, safi_t safi,
1730 const char *name,
1731 struct route_map *route_map);
1732
1733 extern int peer_password_set(struct peer *, const char *);
1734 extern int peer_password_unset(struct peer *);
1735
1736 extern int peer_unsuppress_map_unset(struct peer *, afi_t, safi_t);
1737
1738 extern int peer_maximum_prefix_set(struct peer *, afi_t, safi_t, uint32_t,
1739 uint8_t, int, uint16_t);
1740 extern int peer_maximum_prefix_unset(struct peer *, afi_t, safi_t);
1741
1742 extern int peer_clear(struct peer *, struct listnode **);
1743 extern int peer_clear_soft(struct peer *, afi_t, safi_t, enum bgp_clear_type);
1744
1745 extern int peer_ttl_security_hops_set(struct peer *, int);
1746 extern int peer_ttl_security_hops_unset(struct peer *);
1747
1748 extern int peer_tx_shutdown_message_set(struct peer *, const char *msg);
1749 extern int peer_tx_shutdown_message_unset(struct peer *);
1750
1751 extern int bgp_route_map_update_timer(struct thread *thread);
1752 extern void bgp_route_map_terminate(void);
1753
1754 extern int peer_cmp(struct peer *p1, struct peer *p2);
1755
1756 extern int bgp_map_afi_safi_iana2int(iana_afi_t pkt_afi, iana_safi_t pkt_safi,
1757 afi_t *afi, safi_t *safi);
1758 extern int bgp_map_afi_safi_int2iana(afi_t afi, safi_t safi,
1759 iana_afi_t *pkt_afi,
1760 iana_safi_t *pkt_safi);
1761
1762 extern struct peer_af *peer_af_create(struct peer *, afi_t, safi_t);
1763 extern struct peer_af *peer_af_find(struct peer *, afi_t, safi_t);
1764 extern int peer_af_delete(struct peer *, afi_t, safi_t);
1765
1766 extern void bgp_close(void);
1767 extern void bgp_free(struct bgp *);
1768
1769 static inline struct bgp *bgp_lock(struct bgp *bgp)
1770 {
1771 bgp->lock++;
1772 return bgp;
1773 }
1774
1775 static inline void bgp_unlock(struct bgp *bgp)
1776 {
1777 assert(bgp->lock > 0);
1778 if (--bgp->lock == 0)
1779 bgp_free(bgp);
1780 }
1781
1782 static inline int afindex(afi_t afi, safi_t safi)
1783 {
1784 switch (afi) {
1785 case AFI_IP:
1786 switch (safi) {
1787 case SAFI_UNICAST:
1788 return BGP_AF_IPV4_UNICAST;
1789 break;
1790 case SAFI_MULTICAST:
1791 return BGP_AF_IPV4_MULTICAST;
1792 break;
1793 case SAFI_LABELED_UNICAST:
1794 return BGP_AF_IPV4_LBL_UNICAST;
1795 break;
1796 case SAFI_MPLS_VPN:
1797 return BGP_AF_IPV4_VPN;
1798 break;
1799 case SAFI_ENCAP:
1800 return BGP_AF_IPV4_ENCAP;
1801 break;
1802 case SAFI_FLOWSPEC:
1803 return BGP_AF_IPV4_FLOWSPEC;
1804 default:
1805 return BGP_AF_MAX;
1806 break;
1807 }
1808 break;
1809 case AFI_IP6:
1810 switch (safi) {
1811 case SAFI_UNICAST:
1812 return BGP_AF_IPV6_UNICAST;
1813 break;
1814 case SAFI_MULTICAST:
1815 return BGP_AF_IPV6_MULTICAST;
1816 break;
1817 case SAFI_LABELED_UNICAST:
1818 return BGP_AF_IPV6_LBL_UNICAST;
1819 break;
1820 case SAFI_MPLS_VPN:
1821 return BGP_AF_IPV6_VPN;
1822 break;
1823 case SAFI_ENCAP:
1824 return BGP_AF_IPV6_ENCAP;
1825 break;
1826 case SAFI_FLOWSPEC:
1827 return BGP_AF_IPV6_FLOWSPEC;
1828 default:
1829 return BGP_AF_MAX;
1830 break;
1831 }
1832 break;
1833 case AFI_L2VPN:
1834 switch (safi) {
1835 case SAFI_EVPN:
1836 return BGP_AF_L2VPN_EVPN;
1837 break;
1838 default:
1839 return BGP_AF_MAX;
1840 break;
1841 }
1842 default:
1843 return BGP_AF_MAX;
1844 break;
1845 }
1846 }
1847
1848 /* If the peer is not a peer-group but is bound to a peer-group return 1 */
1849 static inline int peer_group_active(struct peer *peer)
1850 {
1851 if (!CHECK_FLAG(peer->sflags, PEER_STATUS_GROUP) && peer->group)
1852 return 1;
1853 return 0;
1854 }
1855
1856 /* If peer is negotiated at least one address family return 1. */
1857 static inline int peer_afi_active_nego(const struct peer *peer, afi_t afi)
1858 {
1859 if (peer->afc_nego[afi][SAFI_UNICAST]
1860 || peer->afc_nego[afi][SAFI_MULTICAST]
1861 || peer->afc_nego[afi][SAFI_LABELED_UNICAST]
1862 || peer->afc_nego[afi][SAFI_MPLS_VPN]
1863 || peer->afc_nego[afi][SAFI_ENCAP]
1864 || peer->afc_nego[afi][SAFI_FLOWSPEC]
1865 || peer->afc_nego[afi][SAFI_EVPN])
1866 return 1;
1867 return 0;
1868 }
1869
1870 /* If at least one address family activated for group, return 1. */
1871 static inline int peer_group_af_configured(struct peer_group *group)
1872 {
1873 struct peer *peer = group->conf;
1874
1875 if (peer->afc[AFI_IP][SAFI_UNICAST] || peer->afc[AFI_IP][SAFI_MULTICAST]
1876 || peer->afc[AFI_IP][SAFI_LABELED_UNICAST]
1877 || peer->afc[AFI_IP][SAFI_FLOWSPEC]
1878 || peer->afc[AFI_IP][SAFI_MPLS_VPN] || peer->afc[AFI_IP][SAFI_ENCAP]
1879 || peer->afc[AFI_IP6][SAFI_UNICAST]
1880 || peer->afc[AFI_IP6][SAFI_MULTICAST]
1881 || peer->afc[AFI_IP6][SAFI_LABELED_UNICAST]
1882 || peer->afc[AFI_IP6][SAFI_MPLS_VPN]
1883 || peer->afc[AFI_IP6][SAFI_ENCAP]
1884 || peer->afc[AFI_IP6][SAFI_FLOWSPEC]
1885 || peer->afc[AFI_L2VPN][SAFI_EVPN])
1886 return 1;
1887 return 0;
1888 }
1889
1890 static inline char *timestamp_string(time_t ts)
1891 {
1892 time_t tbuf;
1893 tbuf = time(NULL) - (bgp_clock() - ts);
1894 return ctime(&tbuf);
1895 }
1896
1897 static inline int peer_established(struct peer *peer)
1898 {
1899 if (peer->status == Established)
1900 return 1;
1901 return 0;
1902 }
1903
1904 static inline int peer_dynamic_neighbor(struct peer *peer)
1905 {
1906 return (CHECK_FLAG(peer->flags, PEER_FLAG_DYNAMIC_NEIGHBOR)) ? 1 : 0;
1907 }
1908
1909 static inline int peer_cap_enhe(struct peer *peer, afi_t afi, safi_t safi)
1910 {
1911 return (CHECK_FLAG(peer->af_cap[afi][safi], PEER_CAP_ENHE_AF_NEGO));
1912 }
1913
1914 /* Lookup VRF for BGP instance based on its type. */
1915 static inline struct vrf *bgp_vrf_lookup_by_instance_type(struct bgp *bgp)
1916 {
1917 struct vrf *vrf;
1918
1919 if (bgp->inst_type == BGP_INSTANCE_TYPE_DEFAULT)
1920 vrf = vrf_lookup_by_id(VRF_DEFAULT);
1921 else if (bgp->inst_type == BGP_INSTANCE_TYPE_VRF)
1922 vrf = vrf_lookup_by_name(bgp->name);
1923 else
1924 vrf = NULL;
1925
1926 return vrf;
1927 }
1928
1929 /* Link BGP instance to VRF. */
1930 static inline void bgp_vrf_link(struct bgp *bgp, struct vrf *vrf)
1931 {
1932 bgp->vrf_id = vrf->vrf_id;
1933 if (vrf->info != (void *)bgp)
1934 vrf->info = (void *)bgp_lock(bgp);
1935 }
1936
1937 /* Unlink BGP instance from VRF. */
1938 static inline void bgp_vrf_unlink(struct bgp *bgp, struct vrf *vrf)
1939 {
1940 if (vrf->info == (void *)bgp) {
1941 vrf->info = NULL;
1942 bgp_unlock(bgp);
1943 }
1944 bgp->vrf_id = VRF_UNKNOWN;
1945 }
1946
1947 extern void bgp_unset_redist_vrf_bitmaps(struct bgp *, vrf_id_t);
1948
1949 /* For benefit of rfapi */
1950 extern struct peer *peer_new(struct bgp *bgp);
1951
1952 extern struct peer *peer_lookup_in_view(struct vty *vty, struct bgp *bgp,
1953 const char *ip_str, bool use_json);
1954
1955 /* Hooks */
1956 DECLARE_HOOK(peer_status_changed, (struct peer * peer), (peer))
1957
1958 #endif /* _QUAGGA_BGPD_H */