2 * Nexthop structure definition.
3 * Copyright (C) 1997, 98, 99, 2001 Kunihiro Ishiguro
4 * Copyright (C) 2013 Cumulus Networks, Inc.
6 * This file is part of Quagga.
8 * Quagga is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2, or (at your option) any
13 * Quagga is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; see the file COPYING; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #ifndef _LIB_NEXTHOP_H
24 #define _LIB_NEXTHOP_H
34 /* Maximum next hop string length - gateway + ifindex */
35 #define NEXTHOP_STRLEN (INET6_ADDRSTRLEN + 30)
42 enum nexthop_types_t
{
43 NEXTHOP_TYPE_IFINDEX
= 1, /* Directly connected. */
44 NEXTHOP_TYPE_IPV4
, /* IPv4 nexthop. */
45 NEXTHOP_TYPE_IPV4_IFINDEX
, /* IPv4 nexthop with ifindex. */
46 NEXTHOP_TYPE_IPV6
, /* IPv6 nexthop. */
47 NEXTHOP_TYPE_IPV6_IFINDEX
, /* IPv6 nexthop with ifindex. */
48 NEXTHOP_TYPE_BLACKHOLE
, /* Null0 nexthop. */
55 BLACKHOLE_ADMINPROHIB
,
59 NET_VXLAN
= 100, /* value copied from FPM_NH_ENCAP_VXLAN. */
62 /* Fixed limit on the number of backup nexthops per primary nexthop */
63 #define NEXTHOP_MAX_BACKUPS 8
65 /* Backup index value is limited */
66 #define NEXTHOP_BACKUP_IDX_MAX 255
68 /* Nexthop structure. */
74 * What vrf is this nexthop associated with?
78 /* Interface index. */
81 enum nexthop_types_t type
;
84 #define NEXTHOP_FLAG_ACTIVE (1 << 0) /* This nexthop is alive. */
85 #define NEXTHOP_FLAG_FIB (1 << 1) /* FIB nexthop. */
86 #define NEXTHOP_FLAG_RECURSIVE (1 << 2) /* Recursive nexthop. */
87 #define NEXTHOP_FLAG_ONLINK (1 << 3) /* Nexthop should be installed
90 #define NEXTHOP_FLAG_DUPLICATE (1 << 4) /* nexthop duplicates another
93 #define NEXTHOP_FLAG_RNH_FILTERED (1 << 5) /* rmap filtered, used by rnh */
94 #define NEXTHOP_FLAG_HAS_BACKUP (1 << 6) /* Backup nexthop index is set */
95 #define NEXTHOP_FLAG_SRTE (1 << 7) /* SR-TE color used for BGP traffic */
97 #define NEXTHOP_IS_ACTIVE(flags) \
98 (CHECK_FLAG(flags, NEXTHOP_FLAG_ACTIVE) \
99 && !CHECK_FLAG(flags, NEXTHOP_FLAG_DUPLICATE))
101 /* Nexthop address */
104 enum blackhole_type bh_type
;
107 union g_addr rmap_src
; /* Src is set via routemap */
109 /* Nexthops obtained by recursive resolution.
111 * If the nexthop struct needs to be resolved recursively,
112 * NEXTHOP_FLAG_RECURSIVE will be set in flags and the nexthops
113 * obtained by recursive resolution will be added to `resolved'.
115 struct nexthop
*resolved
;
116 /* Recursive parent */
117 struct nexthop
*rparent
;
119 /* Type of label(s), if any */
120 enum lsp_types_t nh_label_type
;
122 /* Label(s) associated with this nexthop. */
123 struct mpls_label_stack
*nh_label
;
125 /* Weight of the nexthop ( for unequal cost ECMP ) */
128 /* Count and index of corresponding backup nexthop(s) in a backup list;
129 * only meaningful if the HAS_BACKUP flag is set.
132 uint8_t backup_idx
[NEXTHOP_MAX_BACKUPS
];
134 /* Encapsulation information. */
135 enum nh_encap_type nh_encap_type
;
140 /* SR-TE color used for matching SR-TE policies */
144 /* Utility to append one nexthop to another. */
145 #define NEXTHOP_APPEND(to, new) \
147 (to)->next = (new); \
148 (new)->prev = (to); \
149 (new)->next = NULL; \
152 struct nexthop
*nexthop_new(void);
154 void nexthop_free(struct nexthop
*nexthop
);
155 void nexthops_free(struct nexthop
*nexthop
);
157 void nexthop_add_labels(struct nexthop
*nexthop
, enum lsp_types_t ltype
,
158 uint8_t num_labels
, const mpls_label_t
*labels
);
159 void nexthop_del_labels(struct nexthop
*);
162 * Allocate a new nexthop object and initialize it from various args.
164 struct nexthop
*nexthop_from_ifindex(ifindex_t ifindex
, vrf_id_t vrf_id
);
165 struct nexthop
*nexthop_from_ipv4(const struct in_addr
*ipv4
,
166 const struct in_addr
*src
,
168 struct nexthop
*nexthop_from_ipv4_ifindex(const struct in_addr
*ipv4
,
169 const struct in_addr
*src
,
170 ifindex_t ifindex
, vrf_id_t vrf_id
);
171 struct nexthop
*nexthop_from_ipv6(const struct in6_addr
*ipv6
,
173 struct nexthop
*nexthop_from_ipv6_ifindex(const struct in6_addr
*ipv6
,
174 ifindex_t ifindex
, vrf_id_t vrf_id
);
175 struct nexthop
*nexthop_from_blackhole(enum blackhole_type bh_type
);
178 * Hash a nexthop. Suitable for use with hash tables.
180 * This function uses the following values when computing the hash:
187 * The nexthop to hash
190 * 32-bit hash of nexthop
192 uint32_t nexthop_hash(const struct nexthop
*nexthop
);
194 * Hash a nexthop only on word-sized attributes:
200 uint32_t nexthop_hash_quick(const struct nexthop
*nexthop
);
202 extern bool nexthop_same(const struct nexthop
*nh1
, const struct nexthop
*nh2
);
203 extern bool nexthop_same_no_labels(const struct nexthop
*nh1
,
204 const struct nexthop
*nh2
);
205 extern int nexthop_cmp(const struct nexthop
*nh1
, const struct nexthop
*nh2
);
206 extern int nexthop_g_addr_cmp(enum nexthop_types_t type
,
207 const union g_addr
*addr1
,
208 const union g_addr
*addr2
);
210 /* More-limited comparison function used to detect duplicate nexthops.
213 int nexthop_cmp_basic(const struct nexthop
*nh1
, const struct nexthop
*nh2
);
215 extern const char *nexthop_type_to_str(enum nexthop_types_t nh_type
);
216 extern bool nexthop_labels_match(const struct nexthop
*nh1
,
217 const struct nexthop
*nh2
);
219 extern const char *nexthop2str(const struct nexthop
*nexthop
,
220 char *str
, int size
);
221 extern struct nexthop
*nexthop_next(const struct nexthop
*nexthop
);
222 extern struct nexthop
*
223 nexthop_next_active_resolved(const struct nexthop
*nexthop
);
224 extern unsigned int nexthop_level(const struct nexthop
*nexthop
);
225 /* Copies to an already allocated nexthop struct */
226 extern void nexthop_copy(struct nexthop
*copy
, const struct nexthop
*nexthop
,
227 struct nexthop
*rparent
);
228 /* Copies to an already allocated nexthop struct, not including recurse info */
229 extern void nexthop_copy_no_recurse(struct nexthop
*copy
,
230 const struct nexthop
*nexthop
,
231 struct nexthop
*rparent
);
232 /* Duplicates a nexthop and returns the newly allocated nexthop */
233 extern struct nexthop
*nexthop_dup(const struct nexthop
*nexthop
,
234 struct nexthop
*rparent
);
235 /* Duplicates a nexthop and returns the newly allocated nexthop */
236 extern struct nexthop
*nexthop_dup_no_recurse(const struct nexthop
*nexthop
,
237 struct nexthop
*rparent
);
240 * Parse one or more backup index values, as comma-separated numbers,
241 * into caller's array of uint8_ts. The array must be NEXTHOP_MAX_BACKUPS
242 * in size. Mails back the number of values converted, and returns 0 on
243 * success, <0 if an error in parsing.
245 int nexthop_str2backups(const char *str
, int *num_backups
,
248 #ifdef _FRR_ATTRIBUTE_PRINTFRR
249 #pragma FRR printfrr_ext "%pNH" (struct nexthop *)
256 #endif /*_LIB_NEXTHOP_H */