]>
Commit | Line | Data |
---|---|---|
5adc2528 AS |
1 | /* |
2 | * Code for encoding/decoding FPM messages that are in netlink format. | |
3 | * | |
4 | * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro | |
5 | * Copyright (C) 2012 by Open Source Routing. | |
6 | * Copyright (C) 2012 by Internet Systems Consortium, Inc. ("ISC") | |
7 | * | |
8 | * This file is part of GNU Zebra. | |
9 | * | |
10 | * GNU Zebra is free software; you can redistribute it and/or modify it | |
11 | * under the terms of the GNU General Public License as published by the | |
12 | * Free Software Foundation; either version 2, or (at your option) any | |
13 | * later version. | |
14 | * | |
15 | * GNU Zebra is distributed in the hope that it will be useful, but | |
16 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | * General Public License for more details. | |
19 | * | |
896014f4 DL |
20 | * You should have received a copy of the GNU General Public License along |
21 | * with this program; see the file COPYING; if not, write to the Free Software | |
22 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
5adc2528 AS |
23 | */ |
24 | ||
25 | #include <zebra.h> | |
26 | ||
ddfeb486 DL |
27 | #ifdef HAVE_NETLINK |
28 | ||
5adc2528 AS |
29 | #include "log.h" |
30 | #include "rib.h" | |
82f97584 | 31 | #include "vty.h" |
e3be0432 | 32 | #include "prefix.h" |
5adc2528 | 33 | |
1fdc9eae | 34 | #include "zebra/zserv.h" |
35 | #include "zebra/zebra_ns.h" | |
36 | #include "zebra/zebra_vrf.h" | |
37 | #include "zebra/kernel_netlink.h" | |
38 | #include "zebra/rt_netlink.h" | |
fb018d25 | 39 | #include "nexthop.h" |
5adc2528 | 40 | |
1fdc9eae | 41 | #include "zebra/zebra_fpm_private.h" |
5adc2528 AS |
42 | |
43 | /* | |
44 | * addr_to_a | |
45 | * | |
46 | * Returns string representation of an address of the given AF. | |
47 | */ | |
d62a17ae | 48 | static inline const char *addr_to_a(u_char af, void *addr) |
5adc2528 | 49 | { |
d62a17ae | 50 | if (!addr) |
51 | return "<No address>"; | |
52 | ||
53 | switch (af) { | |
54 | ||
55 | case AF_INET: | |
56 | return inet_ntoa(*((struct in_addr *)addr)); | |
57 | break; | |
58 | case AF_INET6: | |
59 | return inet6_ntoa(*((struct in6_addr *)addr)); | |
60 | break; | |
61 | default: | |
62 | return "<Addr in unknown AF>"; | |
63 | break; | |
64 | } | |
5adc2528 AS |
65 | } |
66 | ||
67 | /* | |
68 | * prefix_addr_to_a | |
69 | * | |
70 | * Convience wrapper that returns a human-readable string for the | |
71 | * address in a prefix. | |
72 | */ | |
d62a17ae | 73 | static const char *prefix_addr_to_a(struct prefix *prefix) |
5adc2528 | 74 | { |
d62a17ae | 75 | if (!prefix) |
76 | return "<No address>"; | |
5adc2528 | 77 | |
d62a17ae | 78 | return addr_to_a(prefix->family, &prefix->u.prefix); |
5adc2528 AS |
79 | } |
80 | ||
81 | /* | |
82 | * af_addr_size | |
83 | * | |
84 | * The size of an address in a given address family. | |
85 | */ | |
d62a17ae | 86 | static size_t af_addr_size(u_char af) |
5adc2528 | 87 | { |
d62a17ae | 88 | switch (af) { |
89 | ||
90 | case AF_INET: | |
91 | return 4; | |
92 | break; | |
93 | case AF_INET6: | |
94 | return 16; | |
95 | break; | |
96 | default: | |
97 | assert(0); | |
98 | return 16; | |
99 | } | |
5adc2528 AS |
100 | } |
101 | ||
102 | /* | |
103 | * netlink_nh_info_t | |
104 | * | |
105 | * Holds information about a single nexthop for netlink. These info | |
106 | * structures are transient and may contain pointers into rib | |
107 | * data structures for convenience. | |
108 | */ | |
d62a17ae | 109 | typedef struct netlink_nh_info_t_ { |
110 | uint32_t if_index; | |
111 | union g_addr *gateway; | |
112 | ||
113 | /* | |
114 | * Information from the struct nexthop from which this nh was | |
115 | * derived. For debug purposes only. | |
116 | */ | |
117 | int recursive; | |
118 | enum nexthop_types_t type; | |
5adc2528 AS |
119 | } netlink_nh_info_t; |
120 | ||
121 | /* | |
122 | * netlink_route_info_t | |
123 | * | |
124 | * A structure for holding information for a netlink route message. | |
125 | */ | |
d62a17ae | 126 | typedef struct netlink_route_info_t_ { |
127 | uint16_t nlmsg_type; | |
128 | u_char rtm_type; | |
129 | uint32_t rtm_table; | |
130 | u_char rtm_protocol; | |
131 | u_char af; | |
132 | struct prefix *prefix; | |
133 | uint32_t *metric; | |
134 | unsigned int num_nhs; | |
135 | ||
136 | /* | |
137 | * Nexthop structures | |
138 | */ | |
139 | netlink_nh_info_t nhs[MULTIPATH_NUM]; | |
140 | union g_addr *pref_src; | |
5adc2528 AS |
141 | } netlink_route_info_t; |
142 | ||
143 | /* | |
144 | * netlink_route_info_add_nh | |
145 | * | |
146 | * Add information about the given nexthop to the given route info | |
147 | * structure. | |
148 | * | |
149 | * Returns TRUE if a nexthop was added, FALSE otherwise. | |
150 | */ | |
d62a17ae | 151 | static int netlink_route_info_add_nh(netlink_route_info_t *ri, |
152 | struct nexthop *nexthop) | |
5adc2528 | 153 | { |
d62a17ae | 154 | netlink_nh_info_t nhi; |
155 | union g_addr *src; | |
156 | ||
157 | memset(&nhi, 0, sizeof(nhi)); | |
158 | src = NULL; | |
159 | ||
160 | if (ri->num_nhs >= (int)ZEBRA_NUM_OF(ri->nhs)) | |
161 | return 0; | |
162 | ||
163 | nhi.recursive = nexthop->rparent ? 1 : 0; | |
164 | nhi.type = nexthop->type; | |
165 | nhi.if_index = nexthop->ifindex; | |
166 | ||
167 | if (nexthop->type == NEXTHOP_TYPE_IPV4 | |
168 | || nexthop->type == NEXTHOP_TYPE_IPV4_IFINDEX) { | |
169 | nhi.gateway = &nexthop->gate; | |
170 | if (nexthop->src.ipv4.s_addr) | |
171 | src = &nexthop->src; | |
172 | } | |
173 | ||
174 | if (nexthop->type == NEXTHOP_TYPE_IPV6 | |
175 | || nexthop->type == NEXTHOP_TYPE_IPV6_IFINDEX) { | |
176 | nhi.gateway = &nexthop->gate; | |
177 | } | |
178 | ||
179 | if (nexthop->type == NEXTHOP_TYPE_IFINDEX) { | |
180 | if (nexthop->src.ipv4.s_addr) | |
181 | src = &nexthop->src; | |
182 | } | |
183 | ||
184 | if (!nhi.gateway && nhi.if_index == 0) | |
185 | return 0; | |
186 | ||
187 | /* | |
188 | * We have a valid nhi. Copy the structure over to the route_info. | |
189 | */ | |
190 | ri->nhs[ri->num_nhs] = nhi; | |
191 | ri->num_nhs++; | |
192 | ||
193 | if (src && !ri->pref_src) | |
194 | ri->pref_src = src; | |
195 | ||
196 | return 1; | |
5adc2528 AS |
197 | } |
198 | ||
199 | /* | |
200 | * netlink_proto_from_route_type | |
201 | */ | |
d62a17ae | 202 | static u_char netlink_proto_from_route_type(int type) |
5adc2528 | 203 | { |
d62a17ae | 204 | switch (type) { |
205 | case ZEBRA_ROUTE_KERNEL: | |
206 | case ZEBRA_ROUTE_CONNECT: | |
207 | return RTPROT_KERNEL; | |
208 | ||
209 | default: | |
210 | return RTPROT_ZEBRA; | |
211 | } | |
5adc2528 AS |
212 | } |
213 | ||
214 | /* | |
215 | * netlink_route_info_fill | |
216 | * | |
217 | * Fill out the route information object from the given route. | |
218 | * | |
219 | * Returns TRUE on success and FALSE on failure. | |
220 | */ | |
d62a17ae | 221 | static int netlink_route_info_fill(netlink_route_info_t *ri, int cmd, |
222 | rib_dest_t *dest, struct route_entry *re) | |
5adc2528 | 223 | { |
d62a17ae | 224 | struct nexthop *nexthop; |
225 | int discard; | |
226 | ||
227 | memset(ri, 0, sizeof(*ri)); | |
228 | ||
229 | ri->prefix = rib_dest_prefix(dest); | |
230 | ri->af = rib_dest_af(dest); | |
231 | ||
232 | ri->nlmsg_type = cmd; | |
233 | ri->rtm_table = zvrf_id(rib_dest_vrf(dest)); | |
234 | ri->rtm_protocol = RTPROT_UNSPEC; | |
235 | ||
236 | /* | |
237 | * An RTM_DELROUTE need not be accompanied by any nexthops, | |
238 | * particularly in our communication with the FPM. | |
239 | */ | |
240 | if (cmd == RTM_DELROUTE && !re) | |
241 | return 1; | |
242 | ||
243 | if (!re) { | |
244 | zfpm_debug("%s: Expected non-NULL re pointer", | |
245 | __PRETTY_FUNCTION__); | |
246 | return 0; | |
247 | } | |
248 | ||
249 | ri->rtm_protocol = netlink_proto_from_route_type(re->type); | |
250 | ||
251 | if ((re->flags & ZEBRA_FLAG_BLACKHOLE) | |
252 | || (re->flags & ZEBRA_FLAG_REJECT)) | |
253 | discard = 1; | |
254 | else | |
255 | discard = 0; | |
256 | ||
257 | if (cmd == RTM_NEWROUTE) { | |
258 | if (discard) { | |
259 | if (re->flags & ZEBRA_FLAG_BLACKHOLE) | |
260 | ri->rtm_type = RTN_BLACKHOLE; | |
261 | else if (re->flags & ZEBRA_FLAG_REJECT) | |
262 | ri->rtm_type = RTN_UNREACHABLE; | |
263 | else | |
264 | assert(0); | |
265 | } else | |
266 | ri->rtm_type = RTN_UNICAST; | |
267 | } | |
268 | ||
269 | ri->metric = &re->metric; | |
270 | ||
271 | if (discard) | |
272 | return 1; | |
273 | ||
274 | for (ALL_NEXTHOPS(re->nexthop, nexthop)) { | |
275 | if (ri->num_nhs >= multipath_num) | |
276 | break; | |
277 | ||
278 | if (CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_RECURSIVE)) | |
279 | continue; | |
280 | ||
281 | if ((cmd == RTM_NEWROUTE | |
282 | && CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_ACTIVE)) | |
283 | || (cmd == RTM_DELROUTE | |
284 | && CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_FIB))) { | |
285 | netlink_route_info_add_nh(ri, nexthop); | |
286 | } | |
287 | } | |
288 | ||
289 | /* If there is no useful nexthop then return. */ | |
290 | if (ri->num_nhs == 0) { | |
291 | zfpm_debug("netlink_encode_route(): No useful nexthop."); | |
292 | return 0; | |
293 | } | |
294 | ||
295 | return 1; | |
5adc2528 AS |
296 | } |
297 | ||
298 | /* | |
299 | * netlink_route_info_encode | |
300 | * | |
301 | * Returns the number of bytes written to the buffer. 0 or a negative | |
302 | * value indicates an error. | |
303 | */ | |
d62a17ae | 304 | static int netlink_route_info_encode(netlink_route_info_t *ri, char *in_buf, |
305 | size_t in_buf_len) | |
5adc2528 | 306 | { |
d62a17ae | 307 | size_t bytelen; |
308 | unsigned int nexthop_num = 0; | |
309 | size_t buf_offset; | |
310 | netlink_nh_info_t *nhi; | |
5adc2528 | 311 | |
d62a17ae | 312 | struct { |
313 | struct nlmsghdr n; | |
314 | struct rtmsg r; | |
315 | char buf[1]; | |
316 | } * req; | |
5adc2528 | 317 | |
d62a17ae | 318 | req = (void *)in_buf; |
5adc2528 | 319 | |
d62a17ae | 320 | buf_offset = ((char *)req->buf) - ((char *)req); |
5adc2528 | 321 | |
d62a17ae | 322 | if (in_buf_len < buf_offset) { |
323 | assert(0); | |
324 | return 0; | |
325 | } | |
5adc2528 | 326 | |
d62a17ae | 327 | memset(req, 0, buf_offset); |
5adc2528 | 328 | |
d62a17ae | 329 | bytelen = af_addr_size(ri->af); |
5adc2528 | 330 | |
d62a17ae | 331 | req->n.nlmsg_len = NLMSG_LENGTH(sizeof(struct rtmsg)); |
332 | req->n.nlmsg_flags = NLM_F_CREATE | NLM_F_REQUEST; | |
333 | req->n.nlmsg_type = ri->nlmsg_type; | |
334 | req->r.rtm_family = ri->af; | |
335 | req->r.rtm_table = ri->rtm_table; | |
336 | req->r.rtm_dst_len = ri->prefix->prefixlen; | |
337 | req->r.rtm_protocol = ri->rtm_protocol; | |
338 | req->r.rtm_scope = RT_SCOPE_UNIVERSE; | |
5adc2528 | 339 | |
d62a17ae | 340 | addattr_l(&req->n, in_buf_len, RTA_DST, &ri->prefix->u.prefix, bytelen); |
5adc2528 | 341 | |
d62a17ae | 342 | req->r.rtm_type = ri->rtm_type; |
5adc2528 | 343 | |
d62a17ae | 344 | /* Metric. */ |
345 | if (ri->metric) | |
346 | addattr32(&req->n, in_buf_len, RTA_PRIORITY, *ri->metric); | |
5adc2528 | 347 | |
d62a17ae | 348 | if (ri->num_nhs == 0) |
349 | goto done; | |
5adc2528 | 350 | |
d62a17ae | 351 | if (ri->num_nhs == 1) { |
352 | nhi = &ri->nhs[0]; | |
5adc2528 | 353 | |
d62a17ae | 354 | if (nhi->gateway) { |
355 | addattr_l(&req->n, in_buf_len, RTA_GATEWAY, | |
356 | nhi->gateway, bytelen); | |
357 | } | |
5adc2528 | 358 | |
d62a17ae | 359 | if (nhi->if_index) { |
360 | addattr32(&req->n, in_buf_len, RTA_OIF, nhi->if_index); | |
361 | } | |
5adc2528 | 362 | |
d62a17ae | 363 | goto done; |
5adc2528 AS |
364 | } |
365 | ||
d62a17ae | 366 | /* |
367 | * Multipath case. | |
368 | */ | |
369 | char buf[NL_PKT_BUF_SIZE]; | |
370 | struct rtattr *rta = (void *)buf; | |
371 | struct rtnexthop *rtnh; | |
372 | ||
373 | rta->rta_type = RTA_MULTIPATH; | |
374 | rta->rta_len = RTA_LENGTH(0); | |
375 | rtnh = RTA_DATA(rta); | |
376 | ||
377 | for (nexthop_num = 0; nexthop_num < ri->num_nhs; nexthop_num++) { | |
378 | nhi = &ri->nhs[nexthop_num]; | |
379 | ||
380 | rtnh->rtnh_len = sizeof(*rtnh); | |
381 | rtnh->rtnh_flags = 0; | |
382 | rtnh->rtnh_hops = 0; | |
383 | rtnh->rtnh_ifindex = 0; | |
384 | rta->rta_len += rtnh->rtnh_len; | |
385 | ||
386 | if (nhi->gateway) { | |
387 | rta_addattr_l(rta, sizeof(buf), RTA_GATEWAY, | |
388 | nhi->gateway, bytelen); | |
389 | rtnh->rtnh_len += sizeof(struct rtattr) + bytelen; | |
390 | } | |
391 | ||
392 | if (nhi->if_index) { | |
393 | rtnh->rtnh_ifindex = nhi->if_index; | |
394 | } | |
395 | ||
396 | rtnh = RTNH_NEXT(rtnh); | |
5adc2528 AS |
397 | } |
398 | ||
d62a17ae | 399 | assert(rta->rta_len > RTA_LENGTH(0)); |
400 | addattr_l(&req->n, in_buf_len, RTA_MULTIPATH, RTA_DATA(rta), | |
401 | RTA_PAYLOAD(rta)); | |
5adc2528 AS |
402 | |
403 | done: | |
404 | ||
d62a17ae | 405 | if (ri->pref_src) { |
406 | addattr_l(&req->n, in_buf_len, RTA_PREFSRC, &ri->pref_src, | |
407 | bytelen); | |
408 | } | |
5adc2528 | 409 | |
d62a17ae | 410 | assert(req->n.nlmsg_len < in_buf_len); |
411 | return req->n.nlmsg_len; | |
5adc2528 AS |
412 | } |
413 | ||
414 | /* | |
415 | * zfpm_log_route_info | |
416 | * | |
417 | * Helper function to log the information in a route_info structure. | |
418 | */ | |
d62a17ae | 419 | static void zfpm_log_route_info(netlink_route_info_t *ri, const char *label) |
5adc2528 | 420 | { |
d62a17ae | 421 | netlink_nh_info_t *nhi; |
422 | unsigned int i; | |
423 | ||
424 | zfpm_debug("%s : %s %s/%d, Proto: %s, Metric: %u", label, | |
425 | nl_msg_type_to_str(ri->nlmsg_type), | |
426 | prefix_addr_to_a(ri->prefix), ri->prefix->prefixlen, | |
427 | nl_rtproto_to_str(ri->rtm_protocol), | |
428 | ri->metric ? *ri->metric : 0); | |
429 | ||
430 | for (i = 0; i < ri->num_nhs; i++) { | |
431 | nhi = &ri->nhs[i]; | |
432 | zfpm_debug(" Intf: %u, Gateway: %s, Recursive: %s, Type: %s", | |
433 | nhi->if_index, addr_to_a(ri->af, nhi->gateway), | |
434 | nhi->recursive ? "yes" : "no", | |
435 | nexthop_type_to_str(nhi->type)); | |
436 | } | |
5adc2528 AS |
437 | } |
438 | ||
439 | /* | |
440 | * zfpm_netlink_encode_route | |
441 | * | |
442 | * Create a netlink message corresponding to the given route in the | |
443 | * given buffer space. | |
444 | * | |
445 | * Returns the number of bytes written to the buffer. 0 or a negative | |
446 | * value indicates an error. | |
447 | */ | |
d62a17ae | 448 | int zfpm_netlink_encode_route(int cmd, rib_dest_t *dest, struct route_entry *re, |
449 | char *in_buf, size_t in_buf_len) | |
5adc2528 | 450 | { |
d62a17ae | 451 | netlink_route_info_t ri_space, *ri; |
5adc2528 | 452 | |
d62a17ae | 453 | ri = &ri_space; |
5adc2528 | 454 | |
d62a17ae | 455 | if (!netlink_route_info_fill(ri, cmd, dest, re)) |
456 | return 0; | |
5adc2528 | 457 | |
d62a17ae | 458 | zfpm_log_route_info(ri, __FUNCTION__); |
5adc2528 | 459 | |
d62a17ae | 460 | return netlink_route_info_encode(ri, in_buf, in_buf_len); |
5adc2528 | 461 | } |
ddfeb486 DL |
462 | |
463 | #endif /* HAVE_NETLINK */ |