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 struct nln *nln = NULL;
  65 static struct route_table_msg rtmsg;
  66 static struct nln_notifier *route_notifier = NULL;
  67 static struct nln_notifier *name_notifier = NULL;
  68
  69 static bool route_table_valid = false;
  70
  71 static int route_table_reset(void);
  72 static void route_table_handle_msg(const struct route_table_msg *);
  73 static bool route_table_parse(struct ofpbuf *, struct route_table_msg *);
  74 static void route_table_change(const struct route_table_msg *, void *);
  75 static void route_map_clear(void);
  76
  77 static void name_table_init(void);
  78 static void name_table_change(const struct rtnetlink_link_change *, void *);
  79
  80 uint64_t
  81 route_table_get_change_seq(void)
  82 {
  83     return rt_change_seq;
  84 }
  85
  86 /* Users of the route_table module should register themselves with this
  87  * function before making any other route_table function calls. */
  88 void
  89 route_table_init(void)
  90     OVS_EXCLUDED(route_table_mutex)
  91 {
  92     ovs_mutex_lock(&route_table_mutex);
  93     ovs_assert(!nln);
  94     ovs_assert(!route_notifier);
  95
  96     ovs_router_init();
  97     nln = nln_create(NETLINK_ROUTE, RTNLGRP_IPV4_ROUTE,
  98                      (nln_parse_func *) route_table_parse, &rtmsg);
  99
 100     route_notifier =
 101         nln_notifier_create(nln, (nln_notify_func *) route_table_change,
 102                             NULL);
 103
 104     route_table_reset();
 105     name_table_init();
 106
 107     ovs_mutex_unlock(&route_table_mutex);
 108 }
 109
 110 /* Run periodically to update the locally maintained routing table. */
 111 void
 112 route_table_run(void)
 113     OVS_EXCLUDED(route_table_mutex)
 114 {
 115     ovs_mutex_lock(&route_table_mutex);
 116     if (nln) {
 117         rtnetlink_link_run();
 118         nln_run(nln);
 119
 120         if (!route_table_valid) {
 121             route_table_reset();
 122         }
 123     }
 124     ovs_mutex_unlock(&route_table_mutex);
 125 }
 126
 127 /* Causes poll_block() to wake up when route_table updates are required. */
 128 void
 129 route_table_wait(void)
 130     OVS_EXCLUDED(route_table_mutex)
 131 {
 132     ovs_mutex_lock(&route_table_mutex);
 133     if (nln) {
 134         rtnetlink_link_wait();
 135         nln_wait(nln);
 136     }
 137     ovs_mutex_unlock(&route_table_mutex);
 138 }
 139
 140 static int
 141 route_table_reset(void)
 142 {
 143     struct nl_dump dump;
 144     struct rtgenmsg *rtmsg;
 145     uint64_t reply_stub[NL_DUMP_BUFSIZE / 8];
 146     struct ofpbuf request, reply, buf;
 147
 148     route_map_clear();
 149     route_table_valid = true;
 150     rt_change_seq++;
 151
 152     ofpbuf_init(&request, 0);
 153
 154     nl_msg_put_nlmsghdr(&request, sizeof *rtmsg, RTM_GETROUTE, NLM_F_REQUEST);
 155
 156     rtmsg = ofpbuf_put_zeros(&request, sizeof *rtmsg);
 157     rtmsg->rtgen_family = AF_INET;
 158
 159     nl_dump_start(&dump, NETLINK_ROUTE, &request);
 160     ofpbuf_uninit(&request);
 161
 162     ofpbuf_use_stub(&buf, reply_stub, sizeof reply_stub);
 163     while (nl_dump_next(&dump, &reply, &buf)) {
 164         struct route_table_msg msg;
 165
 166         if (route_table_parse(&reply, &msg)) {
 167             route_table_handle_msg(&msg);
 168         }
 169     }
 170     ofpbuf_uninit(&buf);
 171
 172     return nl_dump_done(&dump);
 173 }
 174
 175
 176 static bool
 177 route_table_parse(struct ofpbuf *buf, struct route_table_msg *change)
 178 {
 179     bool parsed;
 180
 181     static const struct nl_policy policy[] = {
 182         [RTA_DST] = { .type = NL_A_U32, .optional = true  },
 183         [RTA_OIF] = { .type = NL_A_U32, .optional = false },
 184         [RTA_GATEWAY] = { .type = NL_A_U32, .optional = true },
 185     };
 186
 187     struct nlattr *attrs[ARRAY_SIZE(policy)];
 188
 189     parsed = nl_policy_parse(buf, NLMSG_HDRLEN + sizeof(struct rtmsg),
 190                              policy, attrs, ARRAY_SIZE(policy));
 191
 192     if (parsed) {
 193         const struct rtmsg *rtm;
 194         const struct nlmsghdr *nlmsg;
 195         int rta_oif;      /* Output interface index. */
 196
 197         nlmsg = ofpbuf_data(buf);
 198         rtm = ofpbuf_at(buf, NLMSG_HDRLEN, sizeof *rtm);
 199
 200         if (rtm->rtm_family != AF_INET) {
 201             VLOG_DBG_RL(&rl, "received non AF_INET rtnetlink route message");
 202             return false;
 203         }
 204
 205         memset(change, 0, sizeof *change);
 206         change->relevant = true;
 207
 208         if (rtm->rtm_scope == RT_SCOPE_NOWHERE) {
 209             change->relevant = false;
 210         }
 211
 212         if (rtm->rtm_type != RTN_UNICAST &&
 213             rtm->rtm_type != RTN_LOCAL) {
 214             change->relevant = false;
 215         }
 216         change->nlmsg_type     = nlmsg->nlmsg_type;
 217         change->rd.rtm_dst_len = rtm->rtm_dst_len;
 218         rta_oif = nl_attr_get_u32(attrs[RTA_OIF]);
 219
 220         if (!if_indextoname(rta_oif, change->rd.ifname)) {
 221             int error = errno;
 222
 223             VLOG_DBG_RL(&rl, "Could not find interface name[%u]: %s",
 224                         rta_oif, ovs_strerror(error));
 225             return false;
 226         }
 227
 228         if (attrs[RTA_DST]) {
 229             change->rd.rta_dst = nl_attr_get_be32(attrs[RTA_DST]);
 230         }
 231         if (attrs[RTA_GATEWAY]) {
 232             change->rd.rta_gw = nl_attr_get_be32(attrs[RTA_GATEWAY]);
 233         }
 234
 235
 236     } else {
 237         VLOG_DBG_RL(&rl, "received unparseable rtnetlink route message");
 238     }
 239
 240     return parsed;
 241 }
 242
 243 static void
 244 route_table_change(const struct route_table_msg *change OVS_UNUSED,
 245                    void *aux OVS_UNUSED)
 246 {
 247     route_table_valid = false;
 248 }
 249
 250 static void
 251 route_table_handle_msg(const struct route_table_msg *change)
 252 {
 253     if (change->relevant && change->nlmsg_type == RTM_NEWROUTE) {
 254         const struct route_data *rd = &change->rd;
 255
 256         ovs_router_insert(rd->rta_dst, rd->rtm_dst_len,
 257                           rd->ifname, rd->rta_gw);
 258     }
 259 }
 260
 261 static void
 262 route_map_clear(void)
 263 {
 264     ovs_router_flush();
 265 }
 266
 267 \f
 268 /* name_table . */
 269
 270 static void
 271 name_table_init(void)
 272 {
 273     name_notifier = rtnetlink_link_notifier_create(name_table_change, NULL);
 274 }
 275
 276
 277 static void
 278 name_table_change(const struct rtnetlink_link_change *change OVS_UNUSED,
 279                   void *aux OVS_UNUSED)
 280 {
 281     /* Changes to interface status can cause routing table changes that some
 282      * versions of the linux kernel do not advertise for some reason. */
 283     route_table_valid = false;
 284 }