lib/tnl-arp-cache.c

   1 /*
   2  * Copyright (c) 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 #include <inttypes.h>
  19 #include <stdlib.h>
  20
  21 #include "bitmap.h"
  22 #include "cmap.h"
  23 #include "coverage.h"
  24 #include "dpif-netdev.h"
  25 #include "dynamic-string.h"
  26 #include "errno.h"
  27 #include "flow.h"
  28 #include "netdev.h"
  29 #include "ovs-thread.h"
  30 #include "packets.h"
  31 #include "packet-dpif.h"
  32 #include "poll-loop.h"
  33 #include "seq.h"
  34 #include "timeval.h"
  35 #include "tnl-arp-cache.h"
  36 #include "unaligned.h"
  37 #include "unixctl.h"
  38 #include "util.h"
  39 #include "openvswitch/vlog.h"
  40
  41
  42 /* In seconds */
  43 #define ARP_ENTRY_DEFAULT_IDLE_TIME  (15 * 60)
  44
  45 struct tnl_arp_entry {
  46     struct cmap_node cmap_node;
  47     ovs_be32 ip;
  48     uint8_t mac[ETH_ADDR_LEN];
  49     time_t expires;             /* Expiration time. */
  50     char br_name[IFNAMSIZ];
  51 };
  52
  53 static struct cmap table;
  54 static struct ovs_mutex mutex = OVS_MUTEX_INITIALIZER;
  55
  56 static struct tnl_arp_entry *
  57 tnl_arp_lookup__(const char br_name[IFNAMSIZ], ovs_be32 dst)
  58 {
  59     struct tnl_arp_entry *arp;
  60
  61     CMAP_FOR_EACH_WITH_HASH (arp, cmap_node, (OVS_FORCE uint32_t) dst, &table) {
  62         if (arp->ip == dst && !strcmp(arp->br_name, br_name)) {
  63             arp->expires = time_now() + ARP_ENTRY_DEFAULT_IDLE_TIME;
  64             return arp;
  65         }
  66     }
  67     return NULL;
  68 }
  69
  70 int
  71 tnl_arp_lookup(const char br_name[IFNAMSIZ], ovs_be32 dst,
  72                uint8_t mac[ETH_ADDR_LEN])
  73 {
  74     struct tnl_arp_entry *arp;
  75     int res = ENOENT;
  76
  77     arp = tnl_arp_lookup__(br_name, dst);
  78     if (arp) {
  79             memcpy(mac, arp->mac, ETH_ADDR_LEN);
  80             res = 0;
  81     }
  82
  83     return res;
  84 }
  85
  86 static void
  87 arp_entry_free(struct tnl_arp_entry *arp)
  88 {
  89     free(arp);
  90 }
  91
  92 static void
  93 tnl_arp_delete(struct tnl_arp_entry *arp)
  94 {
  95     cmap_remove(&table, &arp->cmap_node, (OVS_FORCE uint32_t) arp->ip);
  96     ovsrcu_postpone(arp_entry_free, arp);
  97 }
  98
  99 int
 100 tnl_arp_snoop(const struct flow *flow, struct flow_wildcards *wc,
 101               const char name[IFNAMSIZ])
 102 {
 103     struct tnl_arp_entry *arp;
 104
 105     if (flow->dl_type != htons(ETH_TYPE_ARP)) {
 106         return EINVAL;
 107     }
 108
 109     /* Exact Match on all ARP flows. */
 110     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
 111     memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
 112     memset(&wc->masks.arp_sha, 0xff, sizeof wc->masks.arp_sha);
 113
 114     ovs_mutex_lock(&mutex);
 115     arp = tnl_arp_lookup__(name, flow->nw_src);
 116     if (arp) {
 117         if (!memcmp(arp->mac, flow->arp_sha, ETH_ADDR_LEN)) {
 118             arp->expires = time_now() + ARP_ENTRY_DEFAULT_IDLE_TIME;
 119             ovs_mutex_unlock(&mutex);
 120             return 0;
 121         }
 122         tnl_arp_delete(arp);
 123         seq_change(tnl_conf_seq);
 124     }
 125
 126     arp = xmalloc(sizeof *arp);
 127
 128     arp->ip = flow->nw_src;
 129     memcpy(arp->mac, flow->arp_sha, ETH_ADDR_LEN);
 130     arp->expires = time_now() + ARP_ENTRY_DEFAULT_IDLE_TIME;
 131     strncpy(arp->br_name, name, IFNAMSIZ);
 132     cmap_insert(&table, &arp->cmap_node, (OVS_FORCE uint32_t) arp->ip);
 133     ovs_mutex_unlock(&mutex);
 134     return 0;
 135 }
 136
 137 void
 138 tnl_arp_cache_run(void)
 139 {
 140     struct tnl_arp_entry *arp;
 141     bool changed = false;
 142
 143     ovs_mutex_lock(&mutex);
 144     CMAP_FOR_EACH(arp, cmap_node, &table) {
 145         if (arp->expires <= time_now()) {
 146              tnl_arp_delete(arp);
 147              changed = true;
 148         }
 149     }
 150     ovs_mutex_unlock(&mutex);
 151
 152     if (changed) {
 153         seq_change(tnl_conf_seq);
 154     }
 155 }
 156
 157 static void
 158 tnl_arp_cache_flush(struct unixctl_conn *conn OVS_UNUSED, int argc OVS_UNUSED,
 159                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
 160 {
 161     struct tnl_arp_entry *arp;
 162     bool changed = false;
 163
 164     ovs_mutex_lock(&mutex);
 165     CMAP_FOR_EACH(arp, cmap_node, &table) {
 166           tnl_arp_delete(arp);
 167           changed = true;
 168     }
 169     ovs_mutex_unlock(&mutex);
 170     if (changed) {
 171         seq_change(tnl_conf_seq);
 172     }
 173     unixctl_command_reply(conn, "OK");
 174 }
 175
 176 #define MAX_IP_ADDR_LEN 17
 177
 178 static void
 179 tnl_arp_cache_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
 180                    const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
 181 {
 182     struct ds ds = DS_EMPTY_INITIALIZER;
 183     struct tnl_arp_entry *arp;
 184
 185     ds_put_cstr(&ds, "IP               MAC                 Bridge\n");
 186     ds_put_cstr(&ds, "=============================================\n");
 187     ovs_mutex_lock(&mutex);
 188     CMAP_FOR_EACH(arp, cmap_node, &table) {
 189         int start_len, need_ws;
 190
 191         start_len = ds.length;
 192         ds_put_format(&ds, IP_FMT, IP_ARGS(arp->ip));
 193
 194         need_ws = MAX_IP_ADDR_LEN - (ds.length - start_len);
 195         ds_put_char_multiple(&ds, ' ', need_ws);
 196
 197         ds_put_format(&ds, ETH_ADDR_FMT"   %s\n",
 198                       ETH_ADDR_ARGS(arp->mac), arp->br_name);
 199
 200     }
 201     ovs_mutex_unlock(&mutex);
 202     unixctl_command_reply(conn, ds_cstr(&ds));
 203     ds_destroy(&ds);
 204 }
 205
 206 void
 207 tnl_arp_cache_init(void)
 208 {
 209     cmap_init(&table);
 210
 211     unixctl_command_register("tnl/arp/show", "", 0, 0, tnl_arp_cache_show, NULL);
 212     unixctl_command_register("tnl/arp/flush", "", 0, 0, tnl_arp_cache_flush, NULL);
 213 }