2 * Copyright (c) 2011 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "route-table.h"
22 #include <arpa/inet.h>
23 #include <sys/socket.h>
24 #include <linux/rtnetlink.h>
30 #include "netlink-socket.h"
32 #include "rtnetlink.h"
33 #include "rtnetlink-link.h"
36 VLOG_DEFINE_THIS_MODULE(route_table
);
39 /* Copied from struct rtmsg. */
40 unsigned char rtm_dst_len
;
42 /* Extracted from Netlink attributes. */
43 uint32_t rta_dst
; /* Destination in host byte order. 0 if missing. */
44 int rta_oif
; /* Output interface index. */
47 /* A digested version of a route message sent down by the kernel to indicate
48 * that a route has changed. */
49 struct route_table_msg
{
50 bool relevant
; /* Should this message be processed? */
51 int nlmsg_type
; /* e.g. RTM_NEWROUTE, RTM_DELROUTE. */
52 struct route_data rd
; /* Data parsed from this message. */
56 struct hmap_node node
; /* Node in route_map. */
57 struct route_data rd
; /* Data associated with this node. */
61 struct hmap_node node
; /* Node in name_map. */
62 uint32_t ifi_index
; /* Kernel interface index. */
64 char ifname
[IFNAMSIZ
]; /* Interface name. */
67 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(5, 20);
69 static unsigned int register_count
= 0;
70 static struct rtnetlink
*rtn
= NULL
;
71 static struct route_table_msg rtmsg
;
72 static struct rtnetlink_notifier route_notifier
;
73 static struct rtnetlink_notifier name_notifier
;
75 static bool route_table_valid
= false;
76 static bool name_table_valid
= false;
77 static struct hmap route_map
;
78 static struct hmap name_map
;
80 static int route_table_reset(void);
81 static void route_table_handle_msg(const struct route_table_msg
*);
82 static bool route_table_parse(struct ofpbuf
*, struct route_table_msg
*);
83 static void route_table_change(const struct route_table_msg
*, void *);
84 static struct route_node
*route_node_lookup(const struct route_data
*);
85 static struct route_node
*route_node_lookup_by_ip(uint32_t ip
);
86 static void route_map_clear(void);
87 static uint32_t hash_route_data(const struct route_data
*);
89 static void name_table_init(void);
90 static void name_table_uninit(void);
91 static int name_table_reset(void);
92 static void name_table_change(const struct rtnetlink_link_change
*, void *);
93 static void name_map_clear(void);
94 static struct name_node
*name_node_lookup(int ifi_index
);
96 /* Populates 'name' with the name of the interface traffic destined for 'ip'
97 * is likely to egress out of (see route_table_get_ifindex).
99 * Returns true if successful, otherwise false. */
101 route_table_get_name(ovs_be32 ip
, char name
[IFNAMSIZ
])
105 if (!name_table_valid
) {
109 if (route_table_get_ifindex(ip
, &ifindex
)) {
110 struct name_node
*nn
;
112 nn
= name_node_lookup(ifindex
);
114 ovs_strlcpy(name
, nn
->ifname
, IFNAMSIZ
);
122 /* Populates 'ifindex' with the interface index traffic destined for 'ip' is
123 * likely to egress. There is no hard guarantee that traffic destined for 'ip'
124 * will egress out the specified interface. 'ifindex' may refer to an
125 * interface which is not physical (such as a bridge port).
127 * Returns true if successful, otherwise false. */
129 route_table_get_ifindex(ovs_be32 ip_
, int *ifindex
)
131 struct route_node
*rn
;
132 uint32_t ip
= ntohl(ip_
);
136 if (!route_table_valid
) {
140 rn
= route_node_lookup_by_ip(ip
);
143 *ifindex
= rn
->rd
.rta_oif
;
147 /* Choose a default route. */
148 HMAP_FOR_EACH(rn
, node
, &route_map
) {
149 if (rn
->rd
.rta_dst
== 0 && rn
->rd
.rtm_dst_len
== 0) {
150 *ifindex
= rn
->rd
.rta_oif
;
158 /* Users of the route_table module should register themselves with this
159 * function before making any other route_table function calls. */
161 route_table_register(void)
163 if (!register_count
) {
164 rtnetlink_parse_func
*pf
;
165 rtnetlink_notify_func
*nf
;
169 pf
= (rtnetlink_parse_func
*) route_table_parse
;
170 nf
= (rtnetlink_notify_func
*) route_table_change
;
172 rtn
= rtnetlink_create(RTNLGRP_IPV4_ROUTE
, pf
, &rtmsg
);
173 rtnetlink_notifier_register(rtn
, &route_notifier
, nf
, NULL
);
175 hmap_init(&route_map
);
183 /* Users of the route_table module should unregister themselves with this
184 * function when they will no longer be making any more route_table fuction
187 route_table_unregister(void)
191 if (!register_count
) {
192 rtnetlink_destroy(rtn
);
196 hmap_destroy(&route_map
);
201 /* Run periodically to update the locally maintained routing table. */
203 route_table_run(void)
206 rtnetlink_link_notifier_run();
207 rtnetlink_notifier_run(rtn
);
211 /* Causes poll_block() to wake up when route_table updates are required. */
213 route_table_wait(void)
216 rtnetlink_link_notifier_wait();
217 rtnetlink_notifier_wait(rtn
);
222 route_table_reset(void)
226 struct rtgenmsg
*rtmsg
;
227 struct ofpbuf request
, reply
;
228 static struct nl_sock
*rtnl_sock
;
231 route_table_valid
= true;
233 error
= nl_sock_create(NETLINK_ROUTE
, &rtnl_sock
);
235 VLOG_WARN_RL(&rl
, "failed to reset routing table, "
236 "cannot create RTNETLINK_ROUTE socket");
240 ofpbuf_init(&request
, 0);
242 nl_msg_put_nlmsghdr(&request
, sizeof *rtmsg
, RTM_GETROUTE
, NLM_F_REQUEST
);
244 rtmsg
= ofpbuf_put_zeros(&request
, sizeof *rtmsg
);
245 rtmsg
->rtgen_family
= AF_INET
;
247 nl_dump_start(&dump
, rtnl_sock
, &request
);
249 while (nl_dump_next(&dump
, &reply
)) {
250 struct route_table_msg msg
;
252 if (route_table_parse(&reply
, &msg
)) {
253 route_table_handle_msg(&msg
);
257 error
= nl_dump_done(&dump
);
258 nl_sock_destroy(rtnl_sock
);
265 route_table_parse(struct ofpbuf
*buf
, struct route_table_msg
*change
)
269 static const struct nl_policy policy
[] = {
270 [RTA_DST
] = { .type
= NL_A_U32
, .optional
= true },
271 [RTA_OIF
] = { .type
= NL_A_U32
, .optional
= false },
274 static struct nlattr
*attrs
[ARRAY_SIZE(policy
)];
276 parsed
= nl_policy_parse(buf
, NLMSG_HDRLEN
+ sizeof(struct rtmsg
),
277 policy
, attrs
, ARRAY_SIZE(policy
));
280 const struct rtmsg
*rtm
;
281 const struct nlmsghdr
*nlmsg
;
284 rtm
= (const struct rtmsg
*) ((const char *) buf
->data
+ NLMSG_HDRLEN
);
286 if (rtm
->rtm_family
!= AF_INET
) {
287 VLOG_DBG_RL(&rl
, "received non AF_INET rtnetlink route message");
291 memset(change
, 0, sizeof *change
);
292 change
->relevant
= true;
294 if (rtm
->rtm_scope
== RT_SCOPE_NOWHERE
) {
295 change
->relevant
= false;
298 if (rtm
->rtm_type
!= RTN_UNICAST
&&
299 rtm
->rtm_type
!= RTN_LOCAL
) {
300 change
->relevant
= false;
303 change
->nlmsg_type
= nlmsg
->nlmsg_type
;
304 change
->rd
.rtm_dst_len
= rtm
->rtm_dst_len
;
305 change
->rd
.rta_oif
= nl_attr_get_u32(attrs
[RTA_OIF
]);
307 if (attrs
[RTA_DST
]) {
308 change
->rd
.rta_dst
= ntohl(nl_attr_get_be32(attrs
[RTA_DST
]));
312 VLOG_DBG_RL(&rl
, "received unparseable rtnetlink route message");
319 route_table_change(const struct route_table_msg
*change OVS_UNUSED
,
320 void *aux OVS_UNUSED
)
322 route_table_valid
= false;
326 route_table_handle_msg(const struct route_table_msg
*change
)
328 if (change
->relevant
&& change
->nlmsg_type
== RTM_NEWROUTE
&&
329 !route_node_lookup(&change
->rd
)) {
330 struct route_node
*rn
;
332 rn
= xzalloc(sizeof *rn
);
333 memcpy(&rn
->rd
, &change
->rd
, sizeof change
->rd
);
335 hmap_insert(&route_map
, &rn
->node
, hash_route_data(&rn
->rd
));
339 static struct route_node
*
340 route_node_lookup(const struct route_data
*rd
)
342 struct route_node
*rn
;
344 HMAP_FOR_EACH_WITH_HASH(rn
, node
, hash_route_data(rd
), &route_map
) {
345 if (!memcmp(&rn
->rd
, rd
, sizeof *rd
)) {
353 static struct route_node
*
354 route_node_lookup_by_ip(uint32_t ip
)
357 struct route_node
*rn
, *rn_ret
;
362 HMAP_FOR_EACH(rn
, node
, &route_map
) {
363 uint32_t mask
= 0xffffffff << (32 - rn
->rd
.rtm_dst_len
);
365 if (rn
->rd
.rta_dst
== 0 && rn
->rd
.rtm_dst_len
== 0) {
370 if (rn
->rd
.rtm_dst_len
> dst_len
&&
371 (ip
& mask
) == (rn
->rd
.rta_dst
& mask
)) {
373 dst_len
= rn
->rd
.rtm_dst_len
;
381 route_map_clear(void)
383 struct route_node
*rn
, *rn_next
;
385 HMAP_FOR_EACH_SAFE(rn
, rn_next
, node
, &route_map
) {
386 hmap_remove(&route_map
, &rn
->node
);
392 hash_route_data(const struct route_data
*rd
)
394 return hash_bytes(rd
, sizeof *rd
, 0);
400 name_table_init(void)
402 hmap_init(&name_map
);
403 rtnetlink_link_notifier_register(&name_notifier
, name_table_change
, NULL
);
404 name_table_valid
= false;
408 name_table_uninit(void)
410 rtnetlink_link_notifier_unregister(&name_notifier
);
412 hmap_destroy(&name_map
);
416 name_table_reset(void)
420 struct rtgenmsg
*rtmsg
;
421 struct ofpbuf request
, reply
;
422 static struct nl_sock
*rtnl_sock
;
424 name_table_valid
= true;
426 error
= nl_sock_create(NETLINK_ROUTE
, &rtnl_sock
);
428 VLOG_WARN_RL(&rl
, "failed to create NETLINK_ROUTE socket");
432 ofpbuf_init(&request
, 0);
433 nl_msg_put_nlmsghdr(&request
, sizeof *rtmsg
, RTM_GETLINK
, NLM_F_REQUEST
);
434 rtmsg
= ofpbuf_put_zeros(&request
, sizeof *rtmsg
);
435 rtmsg
->rtgen_family
= AF_INET
;
437 nl_dump_start(&dump
, rtnl_sock
, &request
);
438 while (nl_dump_next(&dump
, &reply
)) {
439 struct rtnetlink_link_change change
;
441 if (rtnetlink_link_parse(&reply
, &change
)
442 && change
.nlmsg_type
== RTM_NEWLINK
443 && !name_node_lookup(change
.ifi_index
)) {
444 struct name_node
*nn
;
446 nn
= xzalloc(sizeof *nn
);
447 nn
->ifi_index
= change
.ifi_index
;
448 ovs_strlcpy(nn
->ifname
, change
.ifname
, IFNAMSIZ
);
449 hmap_insert(&name_map
, &nn
->node
, hash_int(nn
->ifi_index
, 0));
452 nl_sock_destroy(rtnl_sock
);
453 return nl_dump_done(&dump
);
457 name_table_change(const struct rtnetlink_link_change
*change OVS_UNUSED
,
458 void *aux OVS_UNUSED
)
460 /* Changes to interface status can cause routing table changes that some
461 * versions of the linux kernel do not advertise for some reason. */
462 route_table_valid
= false;
463 name_table_valid
= false;
466 static struct name_node
*
467 name_node_lookup(int ifi_index
)
469 struct name_node
*nn
;
471 HMAP_FOR_EACH_WITH_HASH(nn
, node
, hash_int(ifi_index
, 0), &name_map
) {
472 if (nn
->ifi_index
== ifi_index
) {
483 struct name_node
*nn
, *nn_next
;
485 HMAP_FOR_EACH_SAFE(nn
, nn_next
, node
, &name_map
) {
486 hmap_remove(&name_map
, &nn
->node
);