lib/route-table.c

   1 /*
   2  * Copyright (c) 2011 Nicira Networks.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "route-table.h"
  20
  21 #include <assert.h>
  22 #include <arpa/inet.h>
  23 #include <sys/socket.h>
  24 #include <linux/rtnetlink.h>
  25 #include <net/if.h>
  26
  27 #include "hash.h"
  28 #include "hmap.h"
  29 #include "netlink.h"
  30 #include "netlink-notifier.h"
  31 #include "netlink-socket.h"
  32 #include "ofpbuf.h"
  33 #include "rtnetlink-link.h"
  34 #include "vlog.h"
  35
  36 VLOG_DEFINE_THIS_MODULE(route_table);
  37
  38 struct route_data {
  39     /* Copied from struct rtmsg. */
  40     unsigned char rtm_dst_len;
  41
  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. */
  45 };
  46
  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. */
  53 };
  54
  55 struct route_node {
  56     struct hmap_node node; /* Node in route_map. */
  57     struct route_data rd;  /* Data associated with this node. */
  58 };
  59
  60 struct name_node {
  61     struct hmap_node node; /* Node in name_map. */
  62     uint32_t ifi_index;    /* Kernel interface index. */
  63
  64     char ifname[IFNAMSIZ]; /* Interface name. */
  65 };
  66
  67 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
  68
  69 static unsigned int register_count = 0;
  70 static struct nln *nln = NULL;
  71 static struct route_table_msg rtmsg;
  72 static struct nln_notifier route_notifier;
  73 static struct nln_notifier name_notifier;
  74
  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;
  79
  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 *);
  88
  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);
  95
  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).
  98  *
  99  * Returns true if successful, otherwise false. */
 100 bool
 101 route_table_get_name(ovs_be32 ip, char name[IFNAMSIZ])
 102 {
 103     int ifindex;
 104
 105     if (!name_table_valid) {
 106         name_table_reset();
 107     }
 108
 109     if (route_table_get_ifindex(ip, &ifindex)) {
 110         struct name_node *nn;
 111
 112         nn = name_node_lookup(ifindex);
 113         if (nn) {
 114             ovs_strlcpy(name, nn->ifname, IFNAMSIZ);
 115             return true;
 116         }
 117     }
 118
 119     return false;
 120 }
 121
 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).
 126  *
 127  * Returns true if successful, otherwise false. */
 128 bool
 129 route_table_get_ifindex(ovs_be32 ip_, int *ifindex)
 130 {
 131     struct route_node *rn;
 132     uint32_t ip = ntohl(ip_);
 133
 134     *ifindex = 0;
 135
 136     if (!route_table_valid) {
 137         route_table_reset();
 138     }
 139
 140     rn = route_node_lookup_by_ip(ip);
 141
 142     if (rn) {
 143         *ifindex = rn->rd.rta_oif;
 144         return true;
 145     }
 146
 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;
 151             return true;
 152         }
 153     }
 154
 155     return false;
 156 }
 157
 158 /* Users of the route_table module should register themselves with this
 159  * function before making any other route_table function calls. */
 160 void
 161 route_table_register(void)
 162 {
 163     if (!register_count) {
 164         assert(!nln);
 165
 166         nln = nln_create(NETLINK_ROUTE, RTNLGRP_IPV4_ROUTE,
 167                          (nln_parse_func *) route_table_parse, &rtmsg);
 168         nln_notifier_register(nln, &route_notifier,
 169                               (nln_notify_func *) route_table_change, NULL);
 170
 171         hmap_init(&route_map);
 172         route_table_reset();
 173         name_table_init();
 174     }
 175
 176     register_count++;
 177 }
 178
 179 /* Users of the route_table module should unregister themselves with this
 180  * function when they will no longer be making any more route_table fuction
 181  * calls. */
 182 void
 183 route_table_unregister(void)
 184 {
 185     register_count--;
 186
 187     if (!register_count) {
 188         nln_destroy(nln);
 189         nln = NULL;
 190
 191         route_map_clear();
 192         hmap_destroy(&route_map);
 193         name_table_uninit();
 194     }
 195 }
 196
 197 /* Run periodically to update the locally maintained routing table. */
 198 void
 199 route_table_run(void)
 200 {
 201     if (nln) {
 202         rtnetlink_link_run();
 203         nln_run(nln);
 204     }
 205 }
 206
 207 /* Causes poll_block() to wake up when route_table updates are required. */
 208 void
 209 route_table_wait(void)
 210 {
 211     if (nln) {
 212         rtnetlink_link_wait();
 213         nln_wait(nln);
 214     }
 215 }
 216
 217 static int
 218 route_table_reset(void)
 219 {
 220     int error;
 221     struct nl_dump dump;
 222     struct rtgenmsg *rtmsg;
 223     struct ofpbuf request, reply;
 224     static struct nl_sock *rtnl_sock;
 225
 226     route_map_clear();
 227     route_table_valid = true;
 228
 229     error = nl_sock_create(NETLINK_ROUTE, &rtnl_sock);
 230     if (error) {
 231         VLOG_WARN_RL(&rl, "failed to reset routing table, "
 232                      "cannot create RTNETLINK_ROUTE socket");
 233         return error;
 234     }
 235
 236     ofpbuf_init(&request, 0);
 237
 238     nl_msg_put_nlmsghdr(&request, sizeof *rtmsg, RTM_GETROUTE, NLM_F_REQUEST);
 239
 240     rtmsg = ofpbuf_put_zeros(&request, sizeof *rtmsg);
 241     rtmsg->rtgen_family = AF_INET;
 242
 243     nl_dump_start(&dump, rtnl_sock, &request);
 244
 245     while (nl_dump_next(&dump, &reply)) {
 246         struct route_table_msg msg;
 247
 248         if (route_table_parse(&reply, &msg)) {
 249             route_table_handle_msg(&msg);
 250         }
 251     }
 252
 253     error = nl_dump_done(&dump);
 254     nl_sock_destroy(rtnl_sock);
 255
 256     return error;
 257 }
 258
 259
 260 static bool
 261 route_table_parse(struct ofpbuf *buf, struct route_table_msg *change)
 262 {
 263     bool parsed;
 264
 265     static const struct nl_policy policy[] = {
 266         [RTA_DST] = { .type = NL_A_U32, .optional = true  },
 267         [RTA_OIF] = { .type = NL_A_U32, .optional = false },
 268     };
 269
 270     static struct nlattr *attrs[ARRAY_SIZE(policy)];
 271
 272     parsed = nl_policy_parse(buf, NLMSG_HDRLEN + sizeof(struct rtmsg),
 273                              policy, attrs, ARRAY_SIZE(policy));
 274
 275     if (parsed) {
 276         const struct rtmsg *rtm;
 277         const struct nlmsghdr *nlmsg;
 278
 279         nlmsg = buf->data;
 280         rtm = (const struct rtmsg *) ((const char *) buf->data + NLMSG_HDRLEN);
 281
 282         if (rtm->rtm_family != AF_INET) {
 283             VLOG_DBG_RL(&rl, "received non AF_INET rtnetlink route message");
 284             return false;
 285         }
 286
 287         memset(change, 0, sizeof *change);
 288         change->relevant = true;
 289
 290         if (rtm->rtm_scope == RT_SCOPE_NOWHERE) {
 291             change->relevant = false;
 292         }
 293
 294         if (rtm->rtm_type != RTN_UNICAST &&
 295             rtm->rtm_type != RTN_LOCAL) {
 296             change->relevant = false;
 297         }
 298
 299         change->nlmsg_type     = nlmsg->nlmsg_type;
 300         change->rd.rtm_dst_len = rtm->rtm_dst_len;
 301         change->rd.rta_oif     = nl_attr_get_u32(attrs[RTA_OIF]);
 302
 303         if (attrs[RTA_DST]) {
 304             change->rd.rta_dst = ntohl(nl_attr_get_be32(attrs[RTA_DST]));
 305         }
 306
 307     } else {
 308         VLOG_DBG_RL(&rl, "received unparseable rtnetlink route message");
 309     }
 310
 311     return parsed;
 312 }
 313
 314 static void
 315 route_table_change(const struct route_table_msg *change OVS_UNUSED,
 316                    void *aux OVS_UNUSED)
 317 {
 318     route_table_valid = false;
 319 }
 320
 321 static void
 322 route_table_handle_msg(const struct route_table_msg *change)
 323 {
 324     if (change->relevant && change->nlmsg_type == RTM_NEWROUTE &&
 325         !route_node_lookup(&change->rd)) {
 326         struct route_node *rn;
 327
 328         rn = xzalloc(sizeof *rn);
 329         memcpy(&rn->rd, &change->rd, sizeof change->rd);
 330
 331         hmap_insert(&route_map, &rn->node, hash_route_data(&rn->rd));
 332     }
 333 }
 334
 335 static struct route_node *
 336 route_node_lookup(const struct route_data *rd)
 337 {
 338     struct route_node *rn;
 339
 340     HMAP_FOR_EACH_WITH_HASH(rn, node, hash_route_data(rd), &route_map) {
 341         if (!memcmp(&rn->rd, rd, sizeof *rd)) {
 342             return rn;
 343         }
 344     }
 345
 346     return NULL;
 347 }
 348
 349 static struct route_node *
 350 route_node_lookup_by_ip(uint32_t ip)
 351 {
 352     int dst_len;
 353     struct route_node *rn, *rn_ret;
 354
 355     dst_len = -1;
 356     rn_ret  = NULL;
 357
 358     HMAP_FOR_EACH(rn, node, &route_map) {
 359         uint32_t mask = 0xffffffff << (32 - rn->rd.rtm_dst_len);
 360
 361         if (rn->rd.rta_dst == 0 && rn->rd.rtm_dst_len == 0) {
 362             /* Default route. */
 363             continue;
 364         }
 365
 366         if (rn->rd.rtm_dst_len > dst_len &&
 367             (ip & mask) == (rn->rd.rta_dst & mask)) {
 368             rn_ret  = rn;
 369             dst_len = rn->rd.rtm_dst_len;
 370         }
 371     }
 372
 373     return rn_ret;
 374 }
 375
 376 static void
 377 route_map_clear(void)
 378 {
 379     struct route_node *rn, *rn_next;
 380
 381     HMAP_FOR_EACH_SAFE(rn, rn_next, node, &route_map) {
 382         hmap_remove(&route_map, &rn->node);
 383         free(rn);
 384     }
 385 }
 386
 387 static uint32_t
 388 hash_route_data(const struct route_data *rd)
 389 {
 390     return hash_bytes(rd, sizeof *rd, 0);
 391 }
 392 \f
 393 /* name_table . */
 394
 395 static void
 396 name_table_init(void)
 397 {
 398     hmap_init(&name_map);
 399     rtnetlink_link_notifier_register(&name_notifier, name_table_change, NULL);
 400     name_table_valid = false;
 401 }
 402
 403 static void
 404 name_table_uninit(void)
 405 {
 406     rtnetlink_link_notifier_unregister(&name_notifier);
 407     name_map_clear();
 408     hmap_destroy(&name_map);
 409 }
 410
 411 static int
 412 name_table_reset(void)
 413 {
 414     int error;
 415     struct nl_dump dump;
 416     struct rtgenmsg *rtmsg;
 417     struct ofpbuf request, reply;
 418     static struct nl_sock *rtnl_sock;
 419
 420     name_table_valid = true;
 421     name_map_clear();
 422     error = nl_sock_create(NETLINK_ROUTE, &rtnl_sock);
 423     if (error) {
 424         VLOG_WARN_RL(&rl, "failed to create NETLINK_ROUTE socket");
 425         return error;
 426     }
 427
 428     ofpbuf_init(&request, 0);
 429     nl_msg_put_nlmsghdr(&request, sizeof *rtmsg, RTM_GETLINK, NLM_F_REQUEST);
 430     rtmsg = ofpbuf_put_zeros(&request, sizeof *rtmsg);
 431     rtmsg->rtgen_family = AF_INET;
 432
 433     nl_dump_start(&dump, rtnl_sock, &request);
 434     while (nl_dump_next(&dump, &reply)) {
 435         struct rtnetlink_link_change change;
 436
 437         if (rtnetlink_link_parse(&reply, &change)
 438             && change.nlmsg_type == RTM_NEWLINK
 439             && !name_node_lookup(change.ifi_index)) {
 440             struct name_node *nn;
 441
 442             nn = xzalloc(sizeof *nn);
 443             nn->ifi_index = change.ifi_index;
 444             ovs_strlcpy(nn->ifname, change.ifname, IFNAMSIZ);
 445             hmap_insert(&name_map, &nn->node, hash_int(nn->ifi_index, 0));
 446         }
 447     }
 448     nl_sock_destroy(rtnl_sock);
 449     return nl_dump_done(&dump);
 450 }
 451
 452 static void
 453 name_table_change(const struct rtnetlink_link_change *change OVS_UNUSED,
 454                   void *aux OVS_UNUSED)
 455 {
 456     /* Changes to interface status can cause routing table changes that some
 457      * versions of the linux kernel do not advertise for some reason. */
 458     route_table_valid = false;
 459     name_table_valid = false;
 460 }
 461
 462 static struct name_node *
 463 name_node_lookup(int ifi_index)
 464 {
 465     struct name_node *nn;
 466
 467     HMAP_FOR_EACH_WITH_HASH(nn, node, hash_int(ifi_index, 0), &name_map) {
 468         if (nn->ifi_index == ifi_index) {
 469             return nn;
 470         }
 471     }
 472
 473     return NULL;
 474 }
 475
 476 static void
 477 name_map_clear(void)
 478 {
 479     struct name_node *nn, *nn_next;
 480
 481     HMAP_FOR_EACH_SAFE(nn, nn_next, node, &name_map) {
 482         hmap_remove(&name_map, &nn->node);
 483         free(nn);
 484     }
 485 }