lib/mac-learning.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 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 #include "mac-learning.h"
  19
  20 #include <inttypes.h>
  21 #include <stdlib.h>
  22
  23 #include "bitmap.h"
  24 #include "coverage.h"
  25 #include "hash.h"
  26 #include "list.h"
  27 #include "poll-loop.h"
  28 #include "timeval.h"
  29 #include "unaligned.h"
  30 #include "util.h"
  31 #include "vlan-bitmap.h"
  32
  33 COVERAGE_DEFINE(mac_learning_learned);
  34 COVERAGE_DEFINE(mac_learning_expired);
  35
  36 /* Returns the number of seconds since 'e' (within 'ml') was last learned. */
  37 int
  38 mac_entry_age(const struct mac_learning *ml, const struct mac_entry *e)
  39 {
  40     time_t remaining = e->expires - time_now();
  41     return ml->idle_time - remaining;
  42 }
  43
  44 static uint32_t
  45 mac_table_hash(const struct mac_learning *ml, const uint8_t mac[ETH_ADDR_LEN],
  46                uint16_t vlan)
  47 {
  48     unsigned int mac1 = get_unaligned_u32(ALIGNED_CAST(uint32_t *, mac));
  49     unsigned int mac2 = get_unaligned_u16(ALIGNED_CAST(uint16_t *, mac + 4));
  50     return hash_3words(mac1, mac2 | (vlan << 16), ml->secret);
  51 }
  52
  53 static struct mac_entry *
  54 mac_entry_from_lru_node(struct list *list)
  55 {
  56     return CONTAINER_OF(list, struct mac_entry, lru_node);
  57 }
  58
  59 static struct mac_entry *
  60 mac_entry_lookup(const struct mac_learning *ml,
  61                  const uint8_t mac[ETH_ADDR_LEN], uint16_t vlan)
  62 {
  63     struct mac_entry *e;
  64
  65     HMAP_FOR_EACH_WITH_HASH (e, hmap_node, mac_table_hash(ml, mac, vlan),
  66                              &ml->table) {
  67         if (e->vlan == vlan && eth_addr_equals(e->mac, mac)) {
  68             return e;
  69         }
  70     }
  71     return NULL;
  72 }
  73
  74 /* If the LRU list is not empty, stores the least-recently-used entry in '*e'
  75  * and returns true.  Otherwise, if the LRU list is empty, stores NULL in '*e'
  76  * and return false. */
  77 static bool
  78 get_lru(struct mac_learning *ml, struct mac_entry **e)
  79     OVS_REQ_RDLOCK(ml->rwlock)
  80 {
  81     if (!list_is_empty(&ml->lrus)) {
  82         *e = mac_entry_from_lru_node(ml->lrus.next);
  83         return true;
  84     } else {
  85         *e = NULL;
  86         return false;
  87     }
  88 }
  89
  90 static unsigned int
  91 normalize_idle_time(unsigned int idle_time)
  92 {
  93     return (idle_time < 15 ? 15
  94             : idle_time > 3600 ? 3600
  95             : idle_time);
  96 }
  97
  98 /* Creates and returns a new MAC learning table with an initial MAC aging
  99  * timeout of 'idle_time' seconds and an initial maximum of MAC_DEFAULT_MAX
 100  * entries. */
 101 struct mac_learning *
 102 mac_learning_create(unsigned int idle_time)
 103 {
 104     struct mac_learning *ml;
 105
 106     ml = xmalloc(sizeof *ml);
 107     list_init(&ml->lrus);
 108     hmap_init(&ml->table);
 109     ml->secret = random_uint32();
 110     ml->flood_vlans = NULL;
 111     ml->idle_time = normalize_idle_time(idle_time);
 112     ml->max_entries = MAC_DEFAULT_MAX;
 113     ml->need_revalidate = false;
 114     ovs_refcount_init(&ml->ref_cnt);
 115     ovs_rwlock_init(&ml->rwlock);
 116     return ml;
 117 }
 118
 119 struct mac_learning *
 120 mac_learning_ref(const struct mac_learning *ml_)
 121 {
 122     struct mac_learning *ml = CONST_CAST(struct mac_learning *, ml_);
 123     if (ml) {
 124         ovs_refcount_ref(&ml->ref_cnt);
 125     }
 126     return ml;
 127 }
 128
 129 /* Unreferences (and possibly destroys) MAC learning table 'ml'. */
 130 void
 131 mac_learning_unref(struct mac_learning *ml)
 132 {
 133     if (ml && ovs_refcount_unref(&ml->ref_cnt) == 1) {
 134         struct mac_entry *e, *next;
 135
 136         HMAP_FOR_EACH_SAFE (e, next, hmap_node, &ml->table) {
 137             hmap_remove(&ml->table, &e->hmap_node);
 138             free(e);
 139         }
 140         hmap_destroy(&ml->table);
 141
 142         bitmap_free(ml->flood_vlans);
 143         ovs_rwlock_destroy(&ml->rwlock);
 144         free(ml);
 145     }
 146 }
 147
 148 /* Provides a bitmap of VLANs which have learning disabled, that is, VLANs on
 149  * which all packets are flooded.  Returns true if the set has changed from the
 150  * previous value. */
 151 bool
 152 mac_learning_set_flood_vlans(struct mac_learning *ml,
 153                              const unsigned long *bitmap)
 154 {
 155     if (vlan_bitmap_equal(ml->flood_vlans, bitmap)) {
 156         return false;
 157     } else {
 158         bitmap_free(ml->flood_vlans);
 159         ml->flood_vlans = vlan_bitmap_clone(bitmap);
 160         return true;
 161     }
 162 }
 163
 164 /* Changes the MAC aging timeout of 'ml' to 'idle_time' seconds. */
 165 void
 166 mac_learning_set_idle_time(struct mac_learning *ml, unsigned int idle_time)
 167 {
 168     idle_time = normalize_idle_time(idle_time);
 169     if (idle_time != ml->idle_time) {
 170         struct mac_entry *e;
 171         int delta;
 172
 173         delta = (int) idle_time - (int) ml->idle_time;
 174         LIST_FOR_EACH (e, lru_node, &ml->lrus) {
 175             e->expires += delta;
 176         }
 177         ml->idle_time = idle_time;
 178     }
 179 }
 180
 181 /* Sets the maximum number of entries in 'ml' to 'max_entries', adjusting it
 182  * to be within a reasonable range. */
 183 void
 184 mac_learning_set_max_entries(struct mac_learning *ml, size_t max_entries)
 185 {
 186     ml->max_entries = (max_entries < 10 ? 10
 187                        : max_entries > 1000 * 1000 ? 1000 * 1000
 188                        : max_entries);
 189 }
 190
 191 static bool
 192 is_learning_vlan(const struct mac_learning *ml, uint16_t vlan)
 193 {
 194     return !ml->flood_vlans || !bitmap_is_set(ml->flood_vlans, vlan);
 195 }
 196
 197 /* Returns true if 'src_mac' may be learned on 'vlan' for 'ml'.
 198  * Returns false if 'ml' is NULL, if src_mac is not valid for learning, or if
 199  * 'vlan' is configured on 'ml' to flood all packets. */
 200 bool
 201 mac_learning_may_learn(const struct mac_learning *ml,
 202                        const uint8_t src_mac[ETH_ADDR_LEN], uint16_t vlan)
 203 {
 204     return ml && is_learning_vlan(ml, vlan) && !eth_addr_is_multicast(src_mac);
 205 }
 206
 207 /* Searches 'ml' for and returns a MAC learning entry for 'src_mac' in 'vlan',
 208  * inserting a new entry if necessary.  The caller must have already verified,
 209  * by calling mac_learning_may_learn(), that 'src_mac' and 'vlan' are
 210  * learnable.
 211  *
 212  * If the returned MAC entry is new (as may be determined by calling
 213  * mac_entry_is_new()), then the caller must pass the new entry to
 214  * mac_learning_changed().  The caller must also initialize the new entry's
 215  * 'port' member.  Otherwise calling those functions is at the caller's
 216  * discretion. */
 217 struct mac_entry *
 218 mac_learning_insert(struct mac_learning *ml,
 219                     const uint8_t src_mac[ETH_ADDR_LEN], uint16_t vlan)
 220 {
 221     struct mac_entry *e;
 222
 223     e = mac_entry_lookup(ml, src_mac, vlan);
 224     if (!e) {
 225         uint32_t hash = mac_table_hash(ml, src_mac, vlan);
 226
 227         if (hmap_count(&ml->table) >= ml->max_entries) {
 228             get_lru(ml, &e);
 229             mac_learning_expire(ml, e);
 230         }
 231
 232         e = xmalloc(sizeof *e);
 233         hmap_insert(&ml->table, &e->hmap_node, hash);
 234         memcpy(e->mac, src_mac, ETH_ADDR_LEN);
 235         e->vlan = vlan;
 236         e->grat_arp_lock = TIME_MIN;
 237         e->port.p = NULL;
 238     } else {
 239         list_remove(&e->lru_node);
 240     }
 241
 242     /* Mark 'e' as recently used. */
 243     list_push_back(&ml->lrus, &e->lru_node);
 244     e->expires = time_now() + ml->idle_time;
 245
 246     return e;
 247 }
 248
 249 /* Changes 'e''s tag to a new, randomly selected one.  Causes
 250  * mac_learning_run() to flag for revalidation the tag that would have been
 251  * previously used for this entry's MAC and VLAN (either before 'e' was
 252  * inserted, if it is new, or otherwise before its port was updated.)
 253  *
 254  * The client should call this function after obtaining a MAC learning entry
 255  * from mac_learning_insert(), if the entry is either new or if its learned
 256  * port has changed. */
 257 void
 258 mac_learning_changed(struct mac_learning *ml)
 259 {
 260     COVERAGE_INC(mac_learning_learned);
 261     ml->need_revalidate = true;
 262 }
 263
 264 /* Looks up MAC 'dst' for VLAN 'vlan' in 'ml' and returns the associated MAC
 265  * learning entry, if any.  If 'tag' is nonnull, then the tag that associates
 266  * 'dst' and 'vlan' with its currently learned port will be OR'd into
 267  * '*tag'. */
 268 struct mac_entry *
 269 mac_learning_lookup(const struct mac_learning *ml,
 270                     const uint8_t dst[ETH_ADDR_LEN], uint16_t vlan)
 271 {
 272     if (eth_addr_is_multicast(dst)) {
 273         /* No tag because the treatment of multicast destinations never
 274          * changes. */
 275         return NULL;
 276     } else if (!is_learning_vlan(ml, vlan)) {
 277         /* We don't tag this property.  The set of learning VLANs changes so
 278          * rarely that we revalidate every flow when it changes. */
 279         return NULL;
 280     } else {
 281         struct mac_entry *e = mac_entry_lookup(ml, dst, vlan);
 282
 283         ovs_assert(e == NULL || e->port.p != NULL);
 284         return e;
 285     }
 286 }
 287
 288 /* Expires 'e' from the 'ml' hash table. */
 289 void
 290 mac_learning_expire(struct mac_learning *ml, struct mac_entry *e)
 291 {
 292     hmap_remove(&ml->table, &e->hmap_node);
 293     list_remove(&e->lru_node);
 294     free(e);
 295 }
 296
 297 /* Expires all the mac-learning entries in 'ml'.  If not NULL, the tags in 'ml'
 298  * are added to 'tags'.  Otherwise the tags in 'ml' are discarded.  The client
 299  * is responsible for revalidating any flows that depend on 'ml', if
 300  * necessary. */
 301 void
 302 mac_learning_flush(struct mac_learning *ml)
 303 {
 304     struct mac_entry *e;
 305     while (get_lru(ml, &e)){
 306         ml->need_revalidate = true;
 307         mac_learning_expire(ml, e);
 308     }
 309     hmap_shrink(&ml->table);
 310 }
 311
 312 /* Does periodic work required by 'ml'.  Returns true if something changed that
 313  * may require flow revalidation. */
 314 bool
 315 mac_learning_run(struct mac_learning *ml)
 316 {
 317     bool need_revalidate;
 318     struct mac_entry *e;
 319
 320     while (get_lru(ml, &e)
 321            && (hmap_count(&ml->table) > ml->max_entries
 322                || time_now() >= e->expires)) {
 323         COVERAGE_INC(mac_learning_expired);
 324         ml->need_revalidate = true;
 325         mac_learning_expire(ml, e);
 326     }
 327
 328     need_revalidate = ml->need_revalidate;
 329     ml->need_revalidate = false;
 330     return need_revalidate;
 331 }
 332
 333 void
 334 mac_learning_wait(struct mac_learning *ml)
 335 {
 336     if (hmap_count(&ml->table) > ml->max_entries
 337         || ml->need_revalidate) {
 338         poll_immediate_wake();
 339     } else if (!list_is_empty(&ml->lrus)) {
 340         struct mac_entry *e = mac_entry_from_lru_node(ml->lrus.next);
 341         poll_timer_wait_until(e->expires * 1000LL);
 342     }
 343 }