lib/route-table.c

   1 /*
   2  * Copyright (c) 2011, 2012, 2013, 2014 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 <errno.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 "netlink.h"
  29 #include "netlink-notifier.h"
  30 #include "netlink-socket.h"
  31 #include "ofpbuf.h"
  32 #include "ovs-router.h"
  33 #include "ovs-router-linux.h"
  34 #include "rtnetlink-link.h"
  35 #include "vlog.h"
  36
  37 VLOG_DEFINE_THIS_MODULE(route_table);
  38
  39 struct route_data {
  40     /* Copied from struct rtmsg. */
  41     unsigned char rtm_dst_len;
  42
  43     /* Extracted from Netlink attributes. */
  44     ovs_be32 rta_dst; /* 0 if missing. */
  45     ovs_be32 rta_gw;
  46     char ifname[IFNAMSIZ]; /* Interface name. */
  47 };
  48
  49 /* A digested version of a route message sent down by the kernel to indicate
  50  * that a route has changed. */
  51 struct route_table_msg {
  52     bool relevant;        /* Should this message be processed? */
  53     int nlmsg_type;       /* e.g. RTM_NEWROUTE, RTM_DELROUTE. */
  54     struct route_data rd; /* Data parsed from this message. */
  55 };
  56
  57 static struct ovs_mutex route_table_mutex = OVS_MUTEX_INITIALIZER;
  58 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
  59
  60 /* Global change number for route-table, which should be incremented
  61  * every time route_table_reset() is called.  */
  62 static uint64_t rt_change_seq;
  63
  64 static unsigned int register_count = 0;
  65 static struct nln *nln = NULL;
  66 static struct route_table_msg rtmsg;
  67 static struct nln_notifier *route_notifier = NULL;
  68 static struct nln_notifier *name_notifier = NULL;
  69
  70 static bool route_table_valid = false;
  71
  72 static int route_table_reset(void);
  73 static void route_table_handle_msg(const struct route_table_msg *);
  74 static bool route_table_parse(struct ofpbuf *, struct route_table_msg *);
  75 static void route_table_change(const struct route_table_msg *, void *);
  76 static void route_map_clear(void);
  77
  78 static void name_table_init(void);
  79 static void name_table_uninit(void);
  80 static void name_table_change(const struct rtnetlink_link_change *, void *);
  81
  82 uint64_t
  83 route_table_get_change_seq(void)
  84 {
  85     return rt_change_seq;
  86 }
  87
  88 /* Users of the route_table module should register themselves with this
  89  * function before making any other route_table function calls. */
  90 void
  91 route_table_register(void)
  92     OVS_EXCLUDED(route_table_mutex)
  93 {
  94     ovs_mutex_lock(&route_table_mutex);
  95     if (!register_count) {
  96         ovs_assert(!nln);
  97         ovs_assert(!route_notifier);
  98
  99         nln = nln_create(NETLINK_ROUTE, RTNLGRP_IPV4_ROUTE,
 100                          (nln_parse_func *) route_table_parse, &rtmsg);
 101
 102         route_notifier =
 103             nln_notifier_create(nln, (nln_notify_func *) route_table_change,
 104                                 NULL);
 105
 106         route_table_reset();
 107         name_table_init();
 108     }
 109
 110     register_count++;
 111     ovs_mutex_unlock(&route_table_mutex);
 112 }
 113
 114 /* Users of the route_table module should unregister themselves with this
 115  * function when they will no longer be making any more route_table fuction
 116  * calls. */
 117 void
 118 route_table_unregister(void)
 119     OVS_EXCLUDED(route_table_mutex)
 120 {
 121     ovs_mutex_lock(&route_table_mutex);
 122     register_count--;
 123
 124     if (!register_count) {
 125         nln_notifier_destroy(route_notifier);
 126         route_notifier = NULL;
 127         nln_destroy(nln);
 128         nln = NULL;
 129
 130         route_map_clear();
 131         name_table_uninit();
 132     }
 133     ovs_mutex_unlock(&route_table_mutex);
 134 }
 135
 136 /* Run periodically to update the locally maintained routing table. */
 137 void
 138 route_table_run(void)
 139     OVS_EXCLUDED(route_table_mutex)
 140 {
 141     ovs_mutex_lock(&route_table_mutex);
 142     if (nln) {
 143         rtnetlink_link_run();
 144         nln_run(nln);
 145
 146         if (!route_table_valid) {
 147             route_table_reset();
 148         }
 149     }
 150     ovs_mutex_unlock(&route_table_mutex);
 151 }
 152
 153 /* Causes poll_block() to wake up when route_table updates are required. */
 154 void
 155 route_table_wait(void)
 156     OVS_EXCLUDED(route_table_mutex)
 157 {
 158     ovs_mutex_lock(&route_table_mutex);
 159     if (nln) {
 160         rtnetlink_link_wait();
 161         nln_wait(nln);
 162     }
 163     ovs_mutex_unlock(&route_table_mutex);
 164 }
 165
 166 static int
 167 route_table_reset(void)
 168 {
 169     struct nl_dump dump;
 170     struct rtgenmsg *rtmsg;
 171     uint64_t reply_stub[NL_DUMP_BUFSIZE / 8];
 172     struct ofpbuf request, reply, buf;
 173
 174     route_map_clear();
 175     route_table_valid = true;
 176     rt_change_seq++;
 177
 178     ofpbuf_init(&request, 0);
 179
 180     nl_msg_put_nlmsghdr(&request, sizeof *rtmsg, RTM_GETROUTE, NLM_F_REQUEST);
 181
 182     rtmsg = ofpbuf_put_zeros(&request, sizeof *rtmsg);
 183     rtmsg->rtgen_family = AF_INET;
 184
 185     nl_dump_start(&dump, NETLINK_ROUTE, &request);
 186     ofpbuf_uninit(&request);
 187
 188     ofpbuf_use_stub(&buf, reply_stub, sizeof reply_stub);
 189     while (nl_dump_next(&dump, &reply, &buf)) {
 190         struct route_table_msg msg;
 191
 192         if (route_table_parse(&reply, &msg)) {
 193             route_table_handle_msg(&msg);
 194         }
 195     }
 196     ofpbuf_uninit(&buf);
 197
 198     return nl_dump_done(&dump);
 199 }
 200
 201
 202 static bool
 203 route_table_parse(struct ofpbuf *buf, struct route_table_msg *change)
 204 {
 205     bool parsed;
 206
 207     static const struct nl_policy policy[] = {
 208         [RTA_DST] = { .type = NL_A_U32, .optional = true  },
 209         [RTA_OIF] = { .type = NL_A_U32, .optional = false },
 210         [RTA_GATEWAY] = { .type = NL_A_U32, .optional = true },
 211     };
 212
 213     struct nlattr *attrs[ARRAY_SIZE(policy)];
 214
 215     parsed = nl_policy_parse(buf, NLMSG_HDRLEN + sizeof(struct rtmsg),
 216                              policy, attrs, ARRAY_SIZE(policy));
 217
 218     if (parsed) {
 219         const struct rtmsg *rtm;
 220         const struct nlmsghdr *nlmsg;
 221         int rta_oif;      /* Output interface index. */
 222
 223         nlmsg = ofpbuf_data(buf);
 224         rtm = ofpbuf_at(buf, NLMSG_HDRLEN, sizeof *rtm);
 225
 226         if (rtm->rtm_family != AF_INET) {
 227             VLOG_DBG_RL(&rl, "received non AF_INET rtnetlink route message");
 228             return false;
 229         }
 230
 231         memset(change, 0, sizeof *change);
 232         change->relevant = true;
 233
 234         if (rtm->rtm_scope == RT_SCOPE_NOWHERE) {
 235             change->relevant = false;
 236         }
 237
 238         if (rtm->rtm_type != RTN_UNICAST &&
 239             rtm->rtm_type != RTN_LOCAL) {
 240             change->relevant = false;
 241         }
 242         change->nlmsg_type     = nlmsg->nlmsg_type;
 243         change->rd.rtm_dst_len = rtm->rtm_dst_len;
 244         rta_oif = nl_attr_get_u32(attrs[RTA_OIF]);
 245
 246         if (!if_indextoname(rta_oif, change->rd.ifname)) {
 247             int error = errno;
 248
 249             VLOG_DBG_RL(&rl, "Could not find interface name[%u]: %s",
 250                         rta_oif, ovs_strerror(error));
 251             return false;
 252         }
 253
 254         if (attrs[RTA_DST]) {
 255             change->rd.rta_dst = nl_attr_get_be32(attrs[RTA_DST]);
 256         }
 257         if (attrs[RTA_GATEWAY]) {
 258             change->rd.rta_gw = nl_attr_get_be32(attrs[RTA_GATEWAY]);
 259         }
 260
 261
 262     } else {
 263         VLOG_DBG_RL(&rl, "received unparseable rtnetlink route message");
 264     }
 265
 266     return parsed;
 267 }
 268
 269 static void
 270 route_table_change(const struct route_table_msg *change OVS_UNUSED,
 271                    void *aux OVS_UNUSED)
 272 {
 273     route_table_valid = false;
 274 }
 275
 276 static void
 277 route_table_handle_msg(const struct route_table_msg *change)
 278 {
 279     if (change->relevant && change->nlmsg_type == RTM_NEWROUTE) {
 280         const struct route_data *rd = &change->rd;
 281
 282         ovs_router_insert(rd->rta_dst, rd->rtm_dst_len,
 283                           rd->ifname, rd->rta_gw);
 284     }
 285 }
 286
 287 static void
 288 route_map_clear(void)
 289 {
 290     ovs_router_flush();
 291 }
 292
 293 \f
 294 /* name_table . */
 295
 296 static void
 297 name_table_init(void)
 298 {
 299     name_notifier = rtnetlink_link_notifier_create(name_table_change, NULL);
 300 }
 301
 302 static void
 303 name_table_uninit(void)
 304 {
 305     rtnetlink_link_notifier_destroy(name_notifier);
 306     name_notifier = NULL;
 307 }
 308
 309 static void
 310 name_table_change(const struct rtnetlink_link_change *change OVS_UNUSED,
 311                   void *aux OVS_UNUSED)
 312 {
 313     /* Changes to interface status can cause routing table changes that some
 314      * versions of the linux kernel do not advertise for some reason. */
 315     route_table_valid = false;
 316 }