2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef MAC_LEARNING_H
18 #define MAC_LEARNING_H 1
25 #define MAC_HASH_BITS 10
26 #define MAC_HASH_MASK (MAC_HASH_SIZE - 1)
27 #define MAC_HASH_SIZE (1u << MAC_HASH_BITS)
31 /* Time, in seconds, before expiring a mac_entry due to inactivity. */
32 #define MAC_ENTRY_IDLE_TIME 60
34 /* Time, in seconds, to lock an entry updated by a gratuitous ARP to avoid
35 * relearning based on a reflection from a bond slave. */
36 #define MAC_GRAT_ARP_LOCK_TIME 5
38 enum grat_arp_lock_type {
44 /* A MAC learning table entry. */
46 struct list hash_node; /* Element in a mac_learning 'table' list. */
47 struct list lru_node; /* Element in 'lrus' or 'free' list. */
48 time_t expires; /* Expiration time. */
49 time_t grat_arp_lock; /* Gratuitous ARP lock expiration time. */
50 uint8_t mac[ETH_ADDR_LEN]; /* Known MAC address. */
51 uint16_t vlan; /* VLAN tag. */
52 int port; /* Port on which MAC was most recently seen. */
53 tag_type tag; /* Tag for this learning entry. */
56 int mac_entry_age(const struct mac_entry *);
58 /* MAC learning table. */
60 struct list free; /* Not-in-use entries. */
61 struct list lrus; /* In-use entries, least recently used at the
62 front, most recently used at the back. */
63 struct list table[MAC_HASH_SIZE]; /* Hash table. */
64 struct mac_entry entries[MAC_MAX]; /* All entries. */
65 uint32_t secret; /* Secret for randomizing hash table. */
66 unsigned long *flood_vlans; /* Bitmap of learning disabled VLANs. */
69 struct mac_learning *mac_learning_create(void);
70 void mac_learning_destroy(struct mac_learning *);
71 bool mac_learning_set_flood_vlans(struct mac_learning *,
72 unsigned long *bitmap);
73 tag_type mac_learning_learn(struct mac_learning *,
74 const uint8_t src[ETH_ADDR_LEN], uint16_t vlan,
75 uint16_t src_port, enum grat_arp_lock_type
77 int mac_learning_lookup(const struct mac_learning *,
78 const uint8_t dst[ETH_ADDR_LEN], uint16_t vlan,
79 bool *is_grat_arp_locked);
80 int mac_learning_lookup_tag(const struct mac_learning *,
81 const uint8_t dst[ETH_ADDR_LEN],
82 uint16_t vlan, tag_type *tag,
83 bool *is_grat_arp_locked);
84 void mac_learning_flush(struct mac_learning *);
85 void mac_learning_run(struct mac_learning *, struct tag_set *);
86 void mac_learning_wait(struct mac_learning *);
88 #endif /* mac-learning.h */