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
29 /* Maximum next hop string length - gateway + ifindex */
30 #define NEXTHOP_STRLEN (INET6_ADDRSTRLEN + 30)
37 enum nexthop_types_t
{
38 NEXTHOP_TYPE_IFINDEX
= 1, /* Directly connected. */
39 NEXTHOP_TYPE_IPV4
, /* IPv4 nexthop. */
40 NEXTHOP_TYPE_IPV4_IFINDEX
, /* IPv4 nexthop with ifindex. */
41 NEXTHOP_TYPE_IPV6
, /* IPv6 nexthop. */
42 NEXTHOP_TYPE_IPV6_IFINDEX
, /* IPv6 nexthop with ifindex. */
43 NEXTHOP_TYPE_BLACKHOLE
, /* Null0 nexthop. */
50 BLACKHOLE_ADMINPROHIB
,
53 /* IPV[46] -> IPV[46]_IFINDEX */
54 #define NEXTHOP_FIRSTHOPTYPE(type) \
55 ((type) == NEXTHOP_TYPE_IFINDEX || (type) == NEXTHOP_TYPE_BLACKHOLE) \
56 ? (type) : ((type) | 1)
58 /* Nexthop label structure. */
59 struct nexthop_label
{
62 mpls_label_t label
[0]; /* 1 or more labels. */
65 /* Nexthop structure. */
70 /* Interface index. */
73 enum nexthop_types_t type
;
76 #define NEXTHOP_FLAG_ACTIVE (1 << 0) /* This nexthop is alive. */
77 #define NEXTHOP_FLAG_FIB (1 << 1) /* FIB nexthop. */
78 #define NEXTHOP_FLAG_RECURSIVE (1 << 2) /* Recursive nexthop. */
79 #define NEXTHOP_FLAG_ONLINK (1 << 3) /* Nexthop should be installed onlink. */
80 #define NEXTHOP_FLAG_MATCHED (1 << 4) /* Already matched vs a nexthop */
81 #define NEXTHOP_FLAG_FILTERED (1 << 5) /* rmap filtered, used by static only */
82 #define NEXTHOP_FLAG_DUPLICATE (1 << 6) /* nexthop duplicates another active one */
83 #define NEXTHOP_FLAG_EVPN_RVTEP (1 << 7) /* EVPN remote vtep nexthop */
84 #define NEXTHOP_IS_ACTIVE(flags) \
85 (CHECK_FLAG(flags, NEXTHOP_FLAG_ACTIVE) \
86 && !CHECK_FLAG(flags, NEXTHOP_FLAG_DUPLICATE))
91 enum blackhole_type bh_type
;
94 union g_addr rmap_src
; /* Src is set via routemap */
96 /* Nexthops obtained by recursive resolution.
98 * If the nexthop struct needs to be resolved recursively,
99 * NEXTHOP_FLAG_RECURSIVE will be set in flags and the nexthops
100 * obtained by recursive resolution will be added to `resolved'.
102 struct nexthop
*resolved
;
103 /* Recursive parent */
104 struct nexthop
*rparent
;
106 /* Type of label(s), if any */
107 enum lsp_types_t nh_label_type
;
109 /* Label(s) associated with this nexthop. */
110 struct nexthop_label
*nh_label
;
113 /* The following for loop allows to iterate over the nexthop
114 * structure of routes.
116 * head: The pointer to the first nexthop in the chain.
118 * nexthop: The pointer to the current nexthop, either in the
119 * top-level chain or in a resolved chain.
121 #define ALL_NEXTHOPS(head, nexthop) \
122 (nexthop) = (head); \
124 (nexthop) = nexthop_next(nexthop)
126 extern int zebra_rnh_ip_default_route
;
127 extern int zebra_rnh_ipv6_default_route
;
129 static inline int nh_resolve_via_default(int family
)
131 if (((family
== AF_INET
) && zebra_rnh_ip_default_route
)
132 || ((family
== AF_INET6
) && zebra_rnh_ipv6_default_route
))
138 struct nexthop
*nexthop_new(void);
139 void nexthop_add(struct nexthop
**target
, struct nexthop
*nexthop
);
141 void copy_nexthops(struct nexthop
**tnh
, struct nexthop
*nh
,
142 struct nexthop
*rparent
);
143 void nexthop_free(struct nexthop
*nexthop
);
144 void nexthops_free(struct nexthop
*nexthop
);
146 void nexthop_add_labels(struct nexthop
*, enum lsp_types_t
, u_int8_t
,
148 void nexthop_del_labels(struct nexthop
*);
150 extern const char *nexthop_type_to_str(enum nexthop_types_t nh_type
);
151 extern int nexthop_same_no_recurse(const struct nexthop
*next1
,
152 const struct nexthop
*next2
);
153 extern int nexthop_labels_match(struct nexthop
*nh1
, struct nexthop
*nh2
);
154 extern int nexthop_same_firsthop (struct nexthop
*next1
, struct nexthop
*next2
);
156 extern const char *nexthop2str(struct nexthop
*nexthop
, char *str
, int size
);
157 extern struct nexthop
*nexthop_next(struct nexthop
*nexthop
);
158 extern unsigned int nexthop_level(struct nexthop
*nexthop
);
159 #endif /*_LIB_NEXTHOP_H */