]>
Commit | Line | Data |
---|---|---|
7e24fdf3 DS |
1 | /* |
2 | * STATICd - static routes header | |
3 | * Copyright (C) 2018 Cumulus Networks, Inc. | |
4 | * Donald Sharp | |
5 | * | |
8d5cbee9 DS |
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) | |
9 | * any later version. | |
7e24fdf3 | 10 | * |
8d5cbee9 DS |
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 | |
14 | * more details. | |
7e24fdf3 DS |
15 | * |
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 | |
19 | */ | |
20 | #ifndef __STATIC_ROUTES_H__ | |
21 | #define __STATIC_ROUTES_H__ | |
22 | ||
23 | #include "lib/mpls.h" | |
88fa5104 | 24 | #include "table.h" |
7e24fdf3 DS |
25 | |
26 | /* Static route label information */ | |
27 | struct static_nh_label { | |
28 | uint8_t num_labels; | |
29 | uint8_t reserved[3]; | |
30 | mpls_label_t label[MPLS_MAX_LABELS]; | |
31 | }; | |
32 | ||
33 | enum static_blackhole_type { | |
34 | STATIC_BLACKHOLE_DROP = 0, | |
35 | STATIC_BLACKHOLE_NULL, | |
36 | STATIC_BLACKHOLE_REJECT | |
37 | }; | |
38 | ||
88fa5104 | 39 | /* |
40 | * The order for below macros should be in sync with | |
41 | * yang model typedef nexthop-type | |
42 | */ | |
7e24fdf3 | 43 | typedef enum { |
88fa5104 | 44 | STATIC_IFNAME = 1, |
7e24fdf3 DS |
45 | STATIC_IPV4_GATEWAY, |
46 | STATIC_IPV4_GATEWAY_IFNAME, | |
7e24fdf3 DS |
47 | STATIC_IPV6_GATEWAY, |
48 | STATIC_IPV6_GATEWAY_IFNAME, | |
88fa5104 | 49 | STATIC_BLACKHOLE, |
7e24fdf3 DS |
50 | } static_types; |
51 | ||
0ed857ab DS |
52 | /* |
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. | |
64 | */ | |
65 | enum static_install_states { | |
66 | STATIC_START, | |
67 | STATIC_SENT_TO_ZEBRA, | |
68 | STATIC_INSTALLED, | |
69 | STATIC_NOT_INSTALLED, | |
70 | }; | |
71 | ||
88fa5104 | 72 | PREDECL_DLIST(static_path_list); |
73 | PREDECL_DLIST(static_nexthop_list); | |
74 | ||
75 | /* Static route information */ | |
76 | struct static_route_info { | |
77 | /* path list */ | |
78 | struct static_path_list_head path_list; | |
79 | }; | |
80 | ||
81 | /* Static path information */ | |
82 | struct static_path { | |
83 | /* Linkage for static path lists */ | |
84 | struct static_path_list_item list; | |
85 | /* Administrative distance. */ | |
86 | uint8_t distance; | |
87 | /* Tag */ | |
88 | route_tag_t tag; | |
89 | /* Table-id */ | |
90 | uint32_t table_id; | |
91 | /* Nexthop list */ | |
92 | struct static_nexthop_list_head nexthop_list; | |
93 | }; | |
94 | ||
95 | DECLARE_DLIST(static_path_list, struct static_path, list); | |
96 | ||
7e24fdf3 | 97 | /* Static route information. */ |
88fa5104 | 98 | struct static_nexthop { |
7e24fdf3 | 99 | /* For linked list. */ |
88fa5104 | 100 | struct static_nexthop_list_item list; |
7e24fdf3 DS |
101 | |
102 | /* VRF identifier. */ | |
7e24fdf3 DS |
103 | vrf_id_t nh_vrf_id; |
104 | char nh_vrfname[VRF_NAMSIZ + 1]; | |
105 | ||
0ed857ab DS |
106 | /* |
107 | * States that we walk the route through | |
108 | * To know where we are. | |
109 | */ | |
110 | enum static_install_states state; | |
111 | ||
7e24fdf3 DS |
112 | /* Flag for this static route's type. */ |
113 | static_types type; | |
114 | ||
115 | /* | |
116 | * Nexthop value. | |
117 | */ | |
118 | enum static_blackhole_type bh_type; | |
119 | union g_addr addr; | |
120 | ifindex_t ifindex; | |
121 | bool nh_registered; | |
122 | bool nh_valid; | |
123 | ||
124 | char ifname[INTERFACE_NAMSIZ + 1]; | |
125 | ||
126 | /* Label information */ | |
127 | struct static_nh_label snh_label; | |
128 | ||
02dc8ba3 QY |
129 | /* |
130 | * Whether to pretend the nexthop is directly attached to the specified | |
131 | * link. Only meaningful when both a gateway address and interface name | |
132 | * are specified. | |
133 | */ | |
134 | bool onlink; | |
7e24fdf3 DS |
135 | }; |
136 | ||
88fa5104 | 137 | DECLARE_DLIST(static_nexthop_list, struct static_nexthop, list); |
138 | ||
139 | ||
140 | /* | |
141 | * rib_dest_from_rnode | |
142 | */ | |
143 | static inline struct static_route_info * | |
144 | static_route_info_from_rnode(struct route_node *rn) | |
145 | { | |
146 | return (struct static_route_info *)(rn->info); | |
147 | } | |
148 | ||
7e24fdf3 DS |
149 | extern bool mpls_enabled; |
150 | ||
151 | extern struct zebra_privs_t static_privs; | |
152 | ||
153 | void static_fixup_vrf_ids(struct static_vrf *svrf); | |
154 | ||
88fa5104 | 155 | extern struct static_nexthop * |
156 | static_add_nexthop(struct route_node *rn, struct static_path *pn, safi_t safi, | |
157 | struct static_vrf *svrf, static_types type, | |
158 | struct ipaddr *ipaddr, const char *ifname, | |
159 | const char *nh_vrf); | |
160 | extern void static_install_nexthop(struct route_node *rn, | |
161 | struct static_path *pn, | |
162 | struct static_nexthop *nh, safi_t safi, | |
163 | struct static_vrf *svrf, const char *ifname, | |
164 | static_types type, const char *nh_vrf); | |
165 | ||
166 | extern int static_delete_nexthop(struct route_node *rn, struct static_path *pn, | |
167 | safi_t safi, struct static_vrf *svrf, | |
168 | struct static_nexthop *nh); | |
7e24fdf3 DS |
169 | |
170 | extern void static_cleanup_vrf_ids(struct static_vrf *disable_svrf); | |
171 | ||
a9be49bc DS |
172 | extern void static_install_intf_nh(struct interface *ifp); |
173 | ||
7e24fdf3 | 174 | extern void static_ifindex_update(struct interface *ifp, bool up); |
88fa5104 | 175 | |
176 | extern void static_install_path(struct route_node *rn, struct static_path *pn, | |
177 | safi_t safi, struct static_vrf *svrf); | |
178 | ||
179 | extern struct route_node *static_add_route(afi_t afi, safi_t safi, | |
180 | struct prefix *p, | |
181 | struct prefix_ipv6 *src_p, | |
182 | struct static_vrf *svrf); | |
183 | extern void static_del_route(struct route_node *rn, safi_t safi, | |
184 | struct static_vrf *svrf); | |
185 | ||
186 | extern struct static_path *static_add_path(struct route_node *rn, | |
187 | uint8_t distance); | |
188 | extern void static_del_path(struct route_node *rn, struct static_path *pn, | |
189 | safi_t safi, struct static_vrf *svrf); | |
190 | ||
191 | extern void static_get_nh_type(static_types stype, char *type, size_t size); | |
192 | extern bool static_add_nexthop_validate(struct static_vrf *svrf, | |
193 | static_types type, | |
194 | struct ipaddr *ipaddr); | |
195 | extern struct stable_info *static_get_stable_info(struct route_node *rn); | |
196 | extern void static_route_info_init(struct static_route_info *si); | |
7e24fdf3 | 197 | #endif |