2 * STATICd - static routes header
3 * Copyright (C) 2018 Cumulus Networks, Inc.
6 * This program 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 Free
8 * Software Foundation; either version 2 of the License, or (at your option)
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
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
20 #ifndef __STATIC_ROUTES_H__
21 #define __STATIC_ROUTES_H__
26 /* Static route label information */
27 struct static_nh_label
{
30 mpls_label_t label
[MPLS_MAX_LABELS
];
33 enum static_blackhole_type
{
34 STATIC_BLACKHOLE_DROP
= 0,
35 STATIC_BLACKHOLE_NULL
,
36 STATIC_BLACKHOLE_REJECT
40 * The order for below macros should be in sync with
41 * yang model typedef nexthop-type
46 STATIC_IPV4_GATEWAY_IFNAME
,
48 STATIC_IPV6_GATEWAY_IFNAME
,
53 * Route Creation gives us:
54 * START -> Initial State, only exit is when we send the route to
55 * zebra for installation
56 * When we send the route to Zebra move to SENT_TO_ZEBRA
57 * SENT_TO_ZEBRA -> A way to notice that we've sent the route to zebra
58 * But have not received a response on it's status yet
59 * After The response from zebra we move to INSTALLED or FAILED
60 * INSTALLED -> Route was accepted
61 * FAILED -> Route was rejected
62 * When we receive notification about a nexthop that a route uses
63 * We move the route back to START and initiate the process again.
65 enum static_install_states
{
72 PREDECL_DLIST(static_path_list
);
73 PREDECL_DLIST(static_nexthop_list
);
75 /* Static route information */
76 struct static_route_info
{
78 struct static_path_list_head path_list
;
81 /* Static path information */
83 /* Linkage for static path lists */
84 struct static_path_list_item list
;
85 /* Administrative distance. */
92 struct static_nexthop_list_head nexthop_list
;
95 DECLARE_DLIST(static_path_list
, struct static_path
, list
);
97 /* Static route information. */
98 struct static_nexthop
{
99 /* For linked list. */
100 struct static_nexthop_list_item list
;
102 /* VRF identifier. */
104 char nh_vrfname
[VRF_NAMSIZ
+ 1];
107 * States that we walk the route through
108 * To know where we are.
110 enum static_install_states state
;
112 /* Flag for this static route's type. */
118 enum static_blackhole_type bh_type
;
124 char ifname
[INTERFACE_NAMSIZ
+ 1];
126 /* Label information */
127 struct static_nh_label snh_label
;
130 * Whether to pretend the nexthop is directly attached to the specified
131 * link. Only meaningful when both a gateway address and interface name
140 DECLARE_DLIST(static_nexthop_list
, struct static_nexthop
, list
);
144 * rib_dest_from_rnode
146 static inline struct static_route_info
*
147 static_route_info_from_rnode(struct route_node
*rn
)
149 return (struct static_route_info
*)(rn
->info
);
152 extern bool mpls_enabled
;
154 extern struct zebra_privs_t static_privs
;
156 void static_fixup_vrf_ids(struct static_vrf
*svrf
);
158 extern struct static_nexthop
*
159 static_add_nexthop(struct route_node
*rn
, struct static_path
*pn
, safi_t safi
,
160 struct static_vrf
*svrf
, static_types type
,
161 struct ipaddr
*ipaddr
, const char *ifname
,
162 const char *nh_vrf
, uint32_t color
);
163 extern void static_install_nexthop(struct route_node
*rn
,
164 struct static_path
*pn
,
165 struct static_nexthop
*nh
, safi_t safi
,
166 struct static_vrf
*svrf
, const char *ifname
,
167 static_types type
, const char *nh_vrf
);
169 extern int static_delete_nexthop(struct route_node
*rn
, struct static_path
*pn
,
170 safi_t safi
, struct static_vrf
*svrf
,
171 struct static_nexthop
*nh
);
173 extern void static_cleanup_vrf_ids(struct static_vrf
*disable_svrf
);
175 extern void static_install_intf_nh(struct interface
*ifp
);
177 extern void static_ifindex_update(struct interface
*ifp
, bool up
);
179 extern void static_install_path(struct route_node
*rn
, struct static_path
*pn
,
180 safi_t safi
, struct static_vrf
*svrf
);
182 extern struct route_node
*static_add_route(afi_t afi
, safi_t safi
,
184 struct prefix_ipv6
*src_p
,
185 struct static_vrf
*svrf
);
186 extern void static_del_route(struct route_node
*rn
, safi_t safi
,
187 struct static_vrf
*svrf
);
189 extern struct static_path
*static_add_path(struct route_node
*rn
,
190 uint32_t table_id
, uint8_t distance
);
191 extern void static_del_path(struct route_node
*rn
, struct static_path
*pn
,
192 safi_t safi
, struct static_vrf
*svrf
);
194 extern void static_get_nh_type(static_types stype
, char *type
, size_t size
);
195 extern bool static_add_nexthop_validate(struct static_vrf
*svrf
,
197 struct ipaddr
*ipaddr
);
198 extern struct stable_info
*static_get_stable_info(struct route_node
*rn
);
199 extern void static_route_info_init(struct static_route_info
*si
);
202 * Max string return via API static_get_nh_str in size_t
205 #define NEXTHOP_STR (INET6_ADDRSTRLEN + INTERFACE_NAMSIZ + 25)
207 * For the given nexthop, returns the string
208 * nexthop : returns the formatted string in nexthop
209 * size : max size of formatted string
211 extern void static_get_nh_str(struct static_nexthop
*nh
, char *nexthop
,