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
35 /* Maximum next hop string length - gateway + ifindex */
36 #define NEXTHOP_STRLEN (INET6_ADDRSTRLEN + 30)
43 enum nexthop_types_t
{
44 NEXTHOP_TYPE_IFINDEX
= 1, /* Directly connected. */
45 NEXTHOP_TYPE_IPV4
, /* IPv4 nexthop. */
46 NEXTHOP_TYPE_IPV4_IFINDEX
, /* IPv4 nexthop with ifindex. */
47 NEXTHOP_TYPE_IPV6
, /* IPv6 nexthop. */
48 NEXTHOP_TYPE_IPV6_IFINDEX
, /* IPv6 nexthop with ifindex. */
49 NEXTHOP_TYPE_BLACKHOLE
, /* Null0 nexthop. */
56 BLACKHOLE_ADMINPROHIB
,
60 NET_VXLAN
= 100, /* value copied from FPM_NH_ENCAP_VXLAN. */
63 /* Fixed limit on the number of backup nexthops per primary nexthop */
64 #define NEXTHOP_MAX_BACKUPS 8
66 /* Backup index value is limited */
67 #define NEXTHOP_BACKUP_IDX_MAX 255
69 /* Nexthop structure. */
75 * What vrf is this nexthop associated with?
79 /* Interface index. */
82 enum nexthop_types_t type
;
85 #define NEXTHOP_FLAG_ACTIVE (1 << 0) /* This nexthop is alive. */
86 #define NEXTHOP_FLAG_FIB (1 << 1) /* FIB nexthop. */
87 #define NEXTHOP_FLAG_RECURSIVE (1 << 2) /* Recursive nexthop. */
88 #define NEXTHOP_FLAG_ONLINK (1 << 3) /* Nexthop should be installed
91 #define NEXTHOP_FLAG_DUPLICATE (1 << 4) /* nexthop duplicates another
94 #define NEXTHOP_FLAG_RNH_FILTERED (1 << 5) /* rmap filtered, used by rnh */
95 #define NEXTHOP_FLAG_HAS_BACKUP (1 << 6) /* Backup nexthop index is set */
96 #define NEXTHOP_FLAG_SRTE (1 << 7) /* SR-TE color used for BGP traffic */
98 #define NEXTHOP_IS_ACTIVE(flags) \
99 (CHECK_FLAG(flags, NEXTHOP_FLAG_ACTIVE) \
100 && !CHECK_FLAG(flags, NEXTHOP_FLAG_DUPLICATE))
102 /* Nexthop address */
105 enum blackhole_type bh_type
;
108 union g_addr rmap_src
; /* Src is set via routemap */
110 /* Nexthops obtained by recursive resolution.
112 * If the nexthop struct needs to be resolved recursively,
113 * NEXTHOP_FLAG_RECURSIVE will be set in flags and the nexthops
114 * obtained by recursive resolution will be added to `resolved'.
116 struct nexthop
*resolved
;
117 /* Recursive parent */
118 struct nexthop
*rparent
;
120 /* Type of label(s), if any */
121 enum lsp_types_t nh_label_type
;
123 /* Label(s) associated with this nexthop. */
124 struct mpls_label_stack
*nh_label
;
126 /* Weight of the nexthop ( for unequal cost ECMP ) */
129 /* Count and index of corresponding backup nexthop(s) in a backup list;
130 * only meaningful if the HAS_BACKUP flag is set.
133 uint8_t backup_idx
[NEXTHOP_MAX_BACKUPS
];
135 /* Encapsulation information. */
136 enum nh_encap_type nh_encap_type
;
141 /* SR-TE color used for matching SR-TE policies */
144 /* SRv6 information */
145 struct nexthop_srv6
*nh_srv6
;
148 /* Utility to append one nexthop to another. */
149 #define NEXTHOP_APPEND(to, new) \
151 (to)->next = (new); \
152 (new)->prev = (to); \
153 (new)->next = NULL; \
156 struct nexthop
*nexthop_new(void);
158 void nexthop_free(struct nexthop
*nexthop
);
159 void nexthops_free(struct nexthop
*nexthop
);
161 void nexthop_add_labels(struct nexthop
*nexthop
, enum lsp_types_t ltype
,
162 uint8_t num_labels
, const mpls_label_t
*labels
);
163 void nexthop_del_labels(struct nexthop
*);
164 void nexthop_add_srv6_seg6local(struct nexthop
*nexthop
, uint32_t action
,
165 const struct seg6local_context
*ctx
);
166 void nexthop_del_srv6_seg6local(struct nexthop
*nexthop
);
167 void nexthop_add_srv6_seg6(struct nexthop
*nexthop
,
168 const struct in6_addr
*segs
);
169 void nexthop_del_srv6_seg6(struct nexthop
*nexthop
);
172 * Allocate a new nexthop object and initialize it from various args.
174 struct nexthop
*nexthop_from_ifindex(ifindex_t ifindex
, vrf_id_t vrf_id
);
175 struct nexthop
*nexthop_from_ipv4(const struct in_addr
*ipv4
,
176 const struct in_addr
*src
,
178 struct nexthop
*nexthop_from_ipv4_ifindex(const struct in_addr
*ipv4
,
179 const struct in_addr
*src
,
180 ifindex_t ifindex
, vrf_id_t vrf_id
);
181 struct nexthop
*nexthop_from_ipv6(const struct in6_addr
*ipv6
,
183 struct nexthop
*nexthop_from_ipv6_ifindex(const struct in6_addr
*ipv6
,
184 ifindex_t ifindex
, vrf_id_t vrf_id
);
185 struct nexthop
*nexthop_from_blackhole(enum blackhole_type bh_type
,
189 * Hash a nexthop. Suitable for use with hash tables.
191 * This function uses the following values when computing the hash:
198 * The nexthop to hash
201 * 32-bit hash of nexthop
203 uint32_t nexthop_hash(const struct nexthop
*nexthop
);
205 * Hash a nexthop only on word-sized attributes:
211 uint32_t nexthop_hash_quick(const struct nexthop
*nexthop
);
213 extern bool nexthop_same(const struct nexthop
*nh1
, const struct nexthop
*nh2
);
214 extern bool nexthop_same_no_labels(const struct nexthop
*nh1
,
215 const struct nexthop
*nh2
);
216 extern int nexthop_cmp(const struct nexthop
*nh1
, const struct nexthop
*nh2
);
217 extern int nexthop_g_addr_cmp(enum nexthop_types_t type
,
218 const union g_addr
*addr1
,
219 const union g_addr
*addr2
);
221 /* More-limited comparison function used to detect duplicate nexthops.
224 int nexthop_cmp_basic(const struct nexthop
*nh1
, const struct nexthop
*nh2
);
226 extern const char *nexthop_type_to_str(enum nexthop_types_t nh_type
);
227 extern bool nexthop_labels_match(const struct nexthop
*nh1
,
228 const struct nexthop
*nh2
);
230 extern const char *nexthop2str(const struct nexthop
*nexthop
,
231 char *str
, int size
);
232 extern struct nexthop
*nexthop_next(const struct nexthop
*nexthop
);
233 extern struct nexthop
*
234 nexthop_next_active_resolved(const struct nexthop
*nexthop
);
235 extern unsigned int nexthop_level(const struct nexthop
*nexthop
);
236 /* Copies to an already allocated nexthop struct */
237 extern void nexthop_copy(struct nexthop
*copy
, const struct nexthop
*nexthop
,
238 struct nexthop
*rparent
);
239 /* Copies to an already allocated nexthop struct, not including recurse info */
240 extern void nexthop_copy_no_recurse(struct nexthop
*copy
,
241 const struct nexthop
*nexthop
,
242 struct nexthop
*rparent
);
243 /* Duplicates a nexthop and returns the newly allocated nexthop */
244 extern struct nexthop
*nexthop_dup(const struct nexthop
*nexthop
,
245 struct nexthop
*rparent
);
246 /* Duplicates a nexthop and returns the newly allocated nexthop */
247 extern struct nexthop
*nexthop_dup_no_recurse(const struct nexthop
*nexthop
,
248 struct nexthop
*rparent
);
251 * Parse one or more backup index values, as comma-separated numbers,
252 * into caller's array of uint8_ts. The array must be NEXTHOP_MAX_BACKUPS
253 * in size. Mails back the number of values converted, and returns 0 on
254 * success, <0 if an error in parsing.
256 int nexthop_str2backups(const char *str
, int *num_backups
,
259 #ifdef _FRR_ATTRIBUTE_PRINTFRR
260 #pragma FRR printfrr_ext "%pNH" (struct nexthop *)
267 #endif /*_LIB_NEXTHOP_H */