lib/mac-learning.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 #ifndef MAC_LEARNING_H
  18 #define MAC_LEARNING_H 1
  19
  20 #include <time.h>
  21 #include "hmap.h"
  22 #include "list.h"
  23 #include "packets.h"
  24 #include "tag.h"
  25 #include "timeval.h"
  26
  27 struct mac_learning;
  28
  29 /* Default maximum size of a MAC learning table, in entries. */
  30 #define MAC_DEFAULT_MAX 2048
  31
  32 /* Time, in seconds, before expiring a mac_entry due to inactivity. */
  33 #define MAC_ENTRY_DEFAULT_IDLE_TIME 300
  34
  35 /* Time, in seconds, to lock an entry updated by a gratuitous ARP to avoid
  36  * relearning based on a reflection from a bond slave. */
  37 #define MAC_GRAT_ARP_LOCK_TIME 5
  38
  39 /* A MAC learning table entry. */
  40 struct mac_entry {
  41     struct hmap_node hmap_node; /* Node in a mac_learning hmap. */
  42     struct list lru_node;       /* Element in 'lrus' list. */
  43     time_t expires;             /* Expiration time. */
  44     time_t grat_arp_lock;       /* Gratuitous ARP lock expiration time. */
  45     uint8_t mac[ETH_ADDR_LEN];  /* Known MAC address. */
  46     uint16_t vlan;              /* VLAN tag. */
  47     tag_type tag;               /* Tag for this learning entry. */
  48
  49     /* Learned port. */
  50     union {
  51         void *p;
  52         ofp_port_t ofp_port;
  53     } port;
  54 };
  55
  56 int mac_entry_age(const struct mac_learning *, const struct mac_entry *);
  57
  58 /* Returns true if mac_learning_insert() just created 'mac' and the caller has
  59  * not yet properly initialized it. */
  60 static inline bool mac_entry_is_new(const struct mac_entry *mac)
  61 {
  62     return !mac->tag;
  63 }
  64
  65 /* Sets a gratuitous ARP lock on 'mac' that will expire in
  66  * MAC_GRAT_ARP_LOCK_TIME seconds. */
  67 static inline void mac_entry_set_grat_arp_lock(struct mac_entry *mac)
  68 {
  69     mac->grat_arp_lock = time_now() + MAC_GRAT_ARP_LOCK_TIME;
  70 }
  71
  72 /* Returns true if a gratuitous ARP lock is in effect on 'mac', false if none
  73  * has ever been asserted or if it has expired. */
  74 static inline bool mac_entry_is_grat_arp_locked(const struct mac_entry *mac)
  75 {
  76     return time_now() < mac->grat_arp_lock;
  77 }
  78
  79 /* MAC learning table. */
  80 struct mac_learning {
  81     struct hmap table;          /* Learning table. */
  82     struct list lrus;           /* In-use entries, least recently used at the
  83                                    front, most recently used at the back. */
  84     uint32_t secret;            /* Secret for randomizing hash table. */
  85     unsigned long *flood_vlans; /* Bitmap of learning disabled VLANs. */
  86     unsigned int idle_time;     /* Max age before deleting an entry. */
  87     size_t max_entries;         /* Max number of learned MACs. */
  88     struct tag_set tags;        /* Tags which have changed. */
  89 };
  90
  91 /* Basics. */
  92 struct mac_learning *mac_learning_create(unsigned int idle_time);
  93 void mac_learning_destroy(struct mac_learning *);
  94
  95 void mac_learning_run(struct mac_learning *, struct tag_set *);
  96 void mac_learning_wait(struct mac_learning *);
  97
  98 /* Configuration. */
  99 bool mac_learning_set_flood_vlans(struct mac_learning *,
 100                                   const unsigned long *bitmap);
 101 void mac_learning_set_idle_time(struct mac_learning *, unsigned int idle_time);
 102 void mac_learning_set_max_entries(struct mac_learning *, size_t max_entries);
 103
 104 /* Learning. */
 105 bool mac_learning_may_learn(const struct mac_learning *,
 106                             const uint8_t src_mac[ETH_ADDR_LEN],
 107                             uint16_t vlan);
 108 struct mac_entry *mac_learning_insert(struct mac_learning *,
 109                                       const uint8_t src[ETH_ADDR_LEN],
 110                                       uint16_t vlan);
 111 void mac_learning_changed(struct mac_learning *, struct mac_entry *);
 112
 113 /* Lookup. */
 114 struct mac_entry *mac_learning_lookup(const struct mac_learning *,
 115                                       const uint8_t dst[ETH_ADDR_LEN],
 116                                       uint16_t vlan, tag_type *);
 117
 118 /* Flushing. */
 119 void mac_learning_expire(struct mac_learning *, struct mac_entry *);
 120 void mac_learning_flush(struct mac_learning *, struct tag_set *);
 121
 122 #endif /* mac-learning.h */