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