1 /* A generic nexthop structure
2 * Copyright (C) 2013 Cumulus Networks, Inc.
4 * This file is part of Quagga.
6 * Quagga 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
11 * Quagga 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.
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
28 #include "sockunion.h"
37 DEFINE_MTYPE_STATIC(LIB
, NEXTHOP
, "Nexthop")
38 DEFINE_MTYPE_STATIC(LIB
, NH_LABEL
, "Nexthop label")
40 static int _nexthop_labels_cmp(const struct nexthop
*nh1
,
41 const struct nexthop
*nh2
)
43 const struct mpls_label_stack
*nhl1
= NULL
;
44 const struct mpls_label_stack
*nhl2
= NULL
;
49 /* No labels is a match */
59 if (nhl1
->num_labels
> nhl2
->num_labels
)
62 if (nhl1
->num_labels
< nhl2
->num_labels
)
65 return memcmp(nhl1
->label
, nhl2
->label
, nhl1
->num_labels
);
68 static int _nexthop_g_addr_cmp(enum nexthop_types_t type
,
69 const union g_addr
*addr1
,
70 const union g_addr
*addr2
)
75 case NEXTHOP_TYPE_IPV4
:
76 case NEXTHOP_TYPE_IPV4_IFINDEX
:
77 ret
= IPV4_ADDR_CMP(&addr1
->ipv4
, &addr2
->ipv4
);
79 case NEXTHOP_TYPE_IPV6
:
80 case NEXTHOP_TYPE_IPV6_IFINDEX
:
81 ret
= IPV6_ADDR_CMP(&addr1
->ipv6
, &addr2
->ipv6
);
83 case NEXTHOP_TYPE_IFINDEX
:
84 case NEXTHOP_TYPE_BLACKHOLE
:
92 static int _nexthop_gateway_cmp(const struct nexthop
*nh1
,
93 const struct nexthop
*nh2
)
95 return _nexthop_g_addr_cmp(nh1
->type
, &nh1
->gate
, &nh2
->gate
);
98 static int _nexthop_source_cmp(const struct nexthop
*nh1
,
99 const struct nexthop
*nh2
)
101 return _nexthop_g_addr_cmp(nh1
->type
, &nh1
->src
, &nh2
->src
);
104 static int _nexthop_cmp_no_labels(const struct nexthop
*next1
,
105 const struct nexthop
*next2
)
109 if (next1
->vrf_id
< next2
->vrf_id
)
112 if (next1
->vrf_id
> next2
->vrf_id
)
115 if (next1
->type
< next2
->type
)
118 if (next1
->type
> next2
->type
)
121 switch (next1
->type
) {
122 case NEXTHOP_TYPE_IPV4
:
123 case NEXTHOP_TYPE_IPV6
:
124 ret
= _nexthop_gateway_cmp(next1
, next2
);
128 case NEXTHOP_TYPE_IPV4_IFINDEX
:
129 case NEXTHOP_TYPE_IPV6_IFINDEX
:
130 ret
= _nexthop_gateway_cmp(next1
, next2
);
133 /* Intentional Fall-Through */
134 case NEXTHOP_TYPE_IFINDEX
:
135 if (next1
->ifindex
< next2
->ifindex
)
138 if (next1
->ifindex
> next2
->ifindex
)
141 case NEXTHOP_TYPE_BLACKHOLE
:
142 if (next1
->bh_type
< next2
->bh_type
)
145 if (next1
->bh_type
> next2
->bh_type
)
150 ret
= _nexthop_source_cmp(next1
, next2
);
155 int nexthop_cmp(const struct nexthop
*next1
, const struct nexthop
*next2
)
159 ret
= _nexthop_cmp_no_labels(next1
, next2
);
163 ret
= _nexthop_labels_cmp(next1
, next2
);
168 int nexthop_same_firsthop(struct nexthop
*next1
, struct nexthop
*next2
)
170 int type1
= NEXTHOP_FIRSTHOPTYPE(next1
->type
);
171 int type2
= NEXTHOP_FIRSTHOPTYPE(next2
->type
);
176 case NEXTHOP_TYPE_IPV4_IFINDEX
:
177 if (!IPV4_ADDR_SAME(&next1
->gate
.ipv4
, &next2
->gate
.ipv4
))
179 if (next1
->ifindex
!= next2
->ifindex
)
182 case NEXTHOP_TYPE_IFINDEX
:
183 if (next1
->ifindex
!= next2
->ifindex
)
186 case NEXTHOP_TYPE_IPV6_IFINDEX
:
187 if (!IPV6_ADDR_SAME(&next1
->gate
.ipv6
, &next2
->gate
.ipv6
))
189 if (next1
->ifindex
!= next2
->ifindex
)
200 * nexthop_type_to_str
202 const char *nexthop_type_to_str(enum nexthop_types_t nh_type
)
204 static const char *desc
[] = {
205 "none", "Directly connected",
206 "IPv4 nexthop", "IPv4 nexthop with ifindex",
207 "IPv6 nexthop", "IPv6 nexthop with ifindex",
211 return desc
[nh_type
];
215 * Check if the labels match for the 2 nexthops specified.
217 bool nexthop_labels_match(const struct nexthop
*nh1
, const struct nexthop
*nh2
)
219 if (_nexthop_labels_cmp(nh1
, nh2
) != 0)
225 struct nexthop
*nexthop_new(void)
227 return XCALLOC(MTYPE_NEXTHOP
, sizeof(struct nexthop
));
231 void nexthop_free(struct nexthop
*nexthop
)
233 nexthop_del_labels(nexthop
);
234 if (nexthop
->resolved
)
235 nexthops_free(nexthop
->resolved
);
236 XFREE(MTYPE_NEXTHOP
, nexthop
);
239 /* Frees a list of nexthops */
240 void nexthops_free(struct nexthop
*nexthop
)
242 struct nexthop
*nh
, *next
;
244 for (nh
= nexthop
; nh
; nh
= next
) {
250 bool nexthop_same(const struct nexthop
*nh1
, const struct nexthop
*nh2
)
261 if (nexthop_cmp(nh1
, nh2
) != 0)
267 bool nexthop_same_no_labels(const struct nexthop
*nh1
,
268 const struct nexthop
*nh2
)
279 if (_nexthop_cmp_no_labels(nh1
, nh2
) != 0)
285 /* Update nexthop with label information. */
286 void nexthop_add_labels(struct nexthop
*nexthop
, enum lsp_types_t type
,
287 uint8_t num_labels
, mpls_label_t
*label
)
289 struct mpls_label_stack
*nh_label
;
292 nexthop
->nh_label_type
= type
;
293 nh_label
= XCALLOC(MTYPE_NH_LABEL
,
294 sizeof(struct mpls_label_stack
)
295 + num_labels
* sizeof(mpls_label_t
));
296 nh_label
->num_labels
= num_labels
;
297 for (i
= 0; i
< num_labels
; i
++)
298 nh_label
->label
[i
] = *(label
+ i
);
299 nexthop
->nh_label
= nh_label
;
302 /* Free label information of nexthop, if present. */
303 void nexthop_del_labels(struct nexthop
*nexthop
)
305 if (nexthop
->nh_label
) {
306 XFREE(MTYPE_NH_LABEL
, nexthop
->nh_label
);
307 nexthop
->nh_label_type
= ZEBRA_LSP_NONE
;
311 const char *nexthop2str(const struct nexthop
*nexthop
, char *str
, int size
)
313 switch (nexthop
->type
) {
314 case NEXTHOP_TYPE_IFINDEX
:
315 snprintf(str
, size
, "if %u", nexthop
->ifindex
);
317 case NEXTHOP_TYPE_IPV4
:
318 case NEXTHOP_TYPE_IPV4_IFINDEX
:
319 snprintf(str
, size
, "%s if %u", inet_ntoa(nexthop
->gate
.ipv4
),
322 case NEXTHOP_TYPE_IPV6
:
323 case NEXTHOP_TYPE_IPV6_IFINDEX
:
324 snprintf(str
, size
, "%s if %u", inet6_ntoa(nexthop
->gate
.ipv6
),
327 case NEXTHOP_TYPE_BLACKHOLE
:
328 snprintf(str
, size
, "blackhole");
331 snprintf(str
, size
, "unknown");
339 * Iteration step for ALL_NEXTHOPS macro:
340 * This is the tricky part. Check if `nexthop' has
341 * NEXTHOP_FLAG_RECURSIVE set. If yes, this implies that `nexthop' has
342 * at least one nexthop attached to `nexthop->resolved', which will be
345 * If NEXTHOP_FLAG_RECURSIVE is not set, `nexthop' will progress in its
346 * current chain. In case its current chain end is reached, it will move
347 * upwards in the recursion levels and progress there. Whenever a step
348 * forward in a chain is done, recursion will be checked again.
349 * In a nustshell, it's equivalent to a pre-traversal order assuming that
350 * left branch is 'resolved' and right branch is 'next':
351 * https://en.wikipedia.org/wiki/Tree_traversal#/media/File:Sorted_binary_tree_preorder.svg
353 struct nexthop
*nexthop_next(struct nexthop
*nexthop
)
355 if (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_RECURSIVE
))
356 return nexthop
->resolved
;
359 return nexthop
->next
;
361 for (struct nexthop
*par
= nexthop
->rparent
; par
; par
= par
->rparent
)
368 unsigned int nexthop_level(struct nexthop
*nexthop
)
372 for (struct nexthop
*par
= nexthop
->rparent
; par
; par
= par
->rparent
)
378 uint32_t nexthop_hash(const struct nexthop
*nexthop
)
380 uint32_t key
= 0x45afe398;
382 key
= jhash_3words(nexthop
->type
, nexthop
->vrf_id
,
383 nexthop
->nh_label_type
, key
);
384 /* gate and blackhole are together in a union */
385 key
= jhash(&nexthop
->gate
, sizeof(nexthop
->gate
), key
);
386 key
= jhash(&nexthop
->src
, sizeof(nexthop
->src
), key
);
387 key
= jhash(&nexthop
->rmap_src
, sizeof(nexthop
->rmap_src
), key
);
389 if (nexthop
->nh_label
) {
390 int labels
= nexthop
->nh_label
->num_labels
;
393 while (labels
>= 3) {
394 key
= jhash_3words(nexthop
->nh_label
->label
[i
],
395 nexthop
->nh_label
->label
[i
+ 1],
396 nexthop
->nh_label
->label
[i
+ 2],
403 key
= jhash_2words(nexthop
->nh_label
->label
[i
],
404 nexthop
->nh_label
->label
[i
+ 1],
411 key
= jhash_1word(nexthop
->nh_label
->label
[i
], key
);
414 switch (nexthop
->type
) {
415 case NEXTHOP_TYPE_IPV4_IFINDEX
:
416 case NEXTHOP_TYPE_IPV6_IFINDEX
:
417 case NEXTHOP_TYPE_IFINDEX
:
418 key
= jhash_1word(nexthop
->ifindex
, key
);
420 case NEXTHOP_TYPE_BLACKHOLE
:
421 case NEXTHOP_TYPE_IPV4
:
422 case NEXTHOP_TYPE_IPV6
:
428 void nexthop_copy(struct nexthop
*copy
, const struct nexthop
*nexthop
,
429 struct nexthop
*rparent
)
431 copy
->vrf_id
= nexthop
->vrf_id
;
432 copy
->ifindex
= nexthop
->ifindex
;
433 copy
->type
= nexthop
->type
;
434 copy
->flags
= nexthop
->flags
;
435 memcpy(©
->gate
, &nexthop
->gate
, sizeof(nexthop
->gate
));
436 memcpy(©
->src
, &nexthop
->src
, sizeof(nexthop
->src
));
437 memcpy(©
->rmap_src
, &nexthop
->rmap_src
, sizeof(nexthop
->rmap_src
));
438 copy
->rparent
= rparent
;
439 if (nexthop
->nh_label
)
440 nexthop_add_labels(copy
, nexthop
->nh_label_type
,
441 nexthop
->nh_label
->num_labels
,
442 &nexthop
->nh_label
->label
[0]);
445 struct nexthop
*nexthop_dup(const struct nexthop
*nexthop
,
446 struct nexthop
*rparent
)
448 struct nexthop
*new = nexthop_new();
450 nexthop_copy(new, nexthop
, rparent
);
455 * nexthop printing variants:
459 * is directly connected, eth0
460 * unreachable (blackhole)
464 * directly connected, eth0
465 * unreachable (blackhole)
469 printfrr_ext_autoreg_p("NH", printfrr_nh
)
470 static ssize_t
printfrr_nh(char *buf
, size_t bsz
, const char *fmt
,
471 int prec
, const void *ptr
)
473 const struct nexthop
*nexthop
= ptr
;
474 struct fbuf fb
= { .buf
= buf
, .pos
= buf
, .len
= bsz
- 1 };
476 const char *s
, *v_is
= "", *v_via
= "", *v_viaif
= "via ";
488 switch (nexthop
->type
) {
489 case NEXTHOP_TYPE_IPV4
:
490 case NEXTHOP_TYPE_IPV4_IFINDEX
:
491 bprintfrr(&fb
, "%s%pI4", v_via
, &nexthop
->gate
.ipv4
);
494 case NEXTHOP_TYPE_IPV6
:
495 case NEXTHOP_TYPE_IPV6_IFINDEX
:
496 bprintfrr(&fb
, "%s%pI6", v_via
, &nexthop
->gate
.ipv6
);
499 case NEXTHOP_TYPE_IFINDEX
:
500 bprintfrr(&fb
, "%sdirectly connected, %s", v_is
,
501 ifindex2ifname(nexthop
->ifindex
,
504 case NEXTHOP_TYPE_BLACKHOLE
:
505 switch (nexthop
->bh_type
) {
506 case BLACKHOLE_REJECT
:
507 s
= " (ICMP unreachable)";
509 case BLACKHOLE_ADMINPROHIB
:
510 s
= " (ICMP admin-prohibited)";
519 bprintfrr(&fb
, "unreachable%s", s
);
524 if (do_ifi
&& nexthop
->ifindex
)
525 bprintfrr(&fb
, ", %s%s", v_viaif
, ifindex2ifname(
532 nexthop2str(nexthop
, buf
, bsz
);