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