lib/route-table.c

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