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.
18 #include "mac-learning.h"
28 #include "poll-loop.h"
34 VLOG_DEFINE_THIS_MODULE(mac_learning
);
36 COVERAGE_DEFINE(mac_learning_learned
);
37 COVERAGE_DEFINE(mac_learning_expired
);
39 /* Returns the number of seconds since 'e' was last learned. */
41 mac_entry_age(const struct mac_entry
*e
)
43 time_t remaining
= e
->expires
- time_now();
44 return MAC_ENTRY_IDLE_TIME
- remaining
;
48 mac_table_hash(const uint8_t mac
[ETH_ADDR_LEN
], uint16_t vlan
)
50 return hash_bytes(mac
, ETH_ADDR_LEN
, vlan
);
53 static struct mac_entry
*
54 mac_entry_from_lru_node(struct list
*list
)
56 return CONTAINER_OF(list
, struct mac_entry
, lru_node
);
59 /* Returns a tag that represents that 'mac' is on an unknown port in 'vlan'.
60 * (When we learn where 'mac' is in 'vlan', this allows flows that were
61 * flooded to be revalidated.) */
63 make_unknown_mac_tag(const struct mac_learning
*ml
,
64 const uint8_t mac
[ETH_ADDR_LEN
], uint16_t vlan
)
66 uint32_t h
= hash_int(ml
->secret
, mac_table_hash(mac
, vlan
));
67 return tag_create_deterministic(h
);
71 mac_table_bucket(const struct mac_learning
*ml
,
72 const uint8_t mac
[ETH_ADDR_LEN
],
75 uint32_t hash
= mac_table_hash(mac
, vlan
);
76 const struct list
*list
= &ml
->table
[hash
& MAC_HASH_BITS
];
77 return (struct list
*) list
;
80 static struct mac_entry
*
81 search_bucket(struct list
*bucket
, const uint8_t mac
[ETH_ADDR_LEN
],
85 LIST_FOR_EACH (e
, hash_node
, bucket
) {
86 if (eth_addr_equals(e
->mac
, mac
) && e
->vlan
== vlan
) {
93 /* If the LRU list is not empty, stores the least-recently-used entry in '*e'
94 * and returns true. Otherwise, if the LRU list is empty, stores NULL in '*e'
95 * and return false. */
97 get_lru(struct mac_learning
*ml
, struct mac_entry
**e
)
99 if (!list_is_empty(&ml
->lrus
)) {
100 *e
= mac_entry_from_lru_node(ml
->lrus
.next
);
108 /* Removes 'e' from the 'ml' hash table. 'e' must not already be on the free
111 free_mac_entry(struct mac_learning
*ml
, struct mac_entry
*e
)
113 list_remove(&e
->hash_node
);
114 list_remove(&e
->lru_node
);
115 list_push_front(&ml
->free
, &e
->lru_node
);
118 /* Creates and returns a new MAC learning table. */
119 struct mac_learning
*
120 mac_learning_create(void)
122 struct mac_learning
*ml
;
125 ml
= xmalloc(sizeof *ml
);
126 list_init(&ml
->lrus
);
127 list_init(&ml
->free
);
128 for (i
= 0; i
< MAC_HASH_SIZE
; i
++) {
129 list_init(&ml
->table
[i
]);
131 for (i
= 0; i
< MAC_MAX
; i
++) {
132 struct mac_entry
*s
= &ml
->entries
[i
];
133 list_push_front(&ml
->free
, &s
->lru_node
);
135 ml
->secret
= random_uint32();
136 ml
->flood_vlans
= NULL
;
140 /* Destroys MAC learning table 'ml'. */
142 mac_learning_destroy(struct mac_learning
*ml
)
145 bitmap_free(ml
->flood_vlans
);
150 /* Provides a bitmap of VLANs which have learning disabled, that is, VLANs on
151 * which all packets are flooded. It takes ownership of the bitmap. Returns
152 * true if the set has changed from the previous value. */
154 mac_learning_set_flood_vlans(struct mac_learning
*ml
, unsigned long *bitmap
)
156 bool ret
= (bitmap
== NULL
157 ? ml
->flood_vlans
!= NULL
158 : (ml
->flood_vlans
== NULL
159 || !bitmap_equal(bitmap
, ml
->flood_vlans
, 4096)));
161 bitmap_free(ml
->flood_vlans
);
162 ml
->flood_vlans
= bitmap
;
168 is_learning_vlan(const struct mac_learning
*ml
, uint16_t vlan
)
170 return !(ml
->flood_vlans
&& bitmap_is_set(ml
->flood_vlans
, vlan
));
173 /* Attempts to make 'ml' learn from the fact that a frame from 'src_mac' was
174 * just observed arriving from 'src_port' on the given 'vlan'.
176 * Returns nonzero if we actually learned something from this, zero if it just
177 * confirms what we already knew. The nonzero return value is the tag of flows
178 * that now need revalidation.
180 * The 'vlan' parameter is used to maintain separate per-VLAN learning tables.
181 * Specify 0 if this behavior is undesirable.
183 * 'lock_type' specifies whether the entry should be locked or existing locks
186 mac_learning_learn(struct mac_learning
*ml
,
187 const uint8_t src_mac
[ETH_ADDR_LEN
], uint16_t vlan
,
188 uint16_t src_port
, enum grat_arp_lock_type lock_type
)
193 if (!is_learning_vlan(ml
, vlan
)) {
197 if (eth_addr_is_multicast(src_mac
)) {
198 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(30, 30);
199 VLOG_DBG_RL(&rl
, "multicast packet source "ETH_ADDR_FMT
,
200 ETH_ADDR_ARGS(src_mac
));
204 bucket
= mac_table_bucket(ml
, src_mac
, vlan
);
205 e
= search_bucket(bucket
, src_mac
, vlan
);
207 if (!list_is_empty(&ml
->free
)) {
208 e
= mac_entry_from_lru_node(ml
->free
.next
);
210 e
= mac_entry_from_lru_node(ml
->lrus
.next
);
211 list_remove(&e
->hash_node
);
213 memcpy(e
->mac
, src_mac
, ETH_ADDR_LEN
);
214 list_push_front(bucket
, &e
->hash_node
);
217 e
->tag
= make_unknown_mac_tag(ml
, src_mac
, vlan
);
218 e
->grat_arp_lock
= TIME_MIN
;
221 if (lock_type
!= GRAT_ARP_LOCK_CHECK
|| time_now() >= e
->grat_arp_lock
) {
222 /* Make the entry most-recently-used. */
223 list_remove(&e
->lru_node
);
224 list_push_back(&ml
->lrus
, &e
->lru_node
);
225 e
->expires
= time_now() + MAC_ENTRY_IDLE_TIME
;
226 if (lock_type
== GRAT_ARP_LOCK_SET
) {
227 e
->grat_arp_lock
= time_now() + MAC_GRAT_ARP_LOCK_TIME
;
230 /* Did we learn something? */
231 if (e
->port
!= src_port
) {
232 tag_type old_tag
= e
->tag
;
234 e
->tag
= tag_create_random();
235 COVERAGE_INC(mac_learning_learned
);
243 /* Looks up MAC 'dst' for VLAN 'vlan' in 'ml'. Returns the port on which a
244 * frame destined for 'dst' should be sent, -1 if unknown. 'is_grat_arp_locked'
245 * is an optional parameter that returns whether the entry is currently
248 mac_learning_lookup(const struct mac_learning
*ml
,
249 const uint8_t dst
[ETH_ADDR_LEN
], uint16_t vlan
,
250 bool *is_grat_arp_locked
)
253 return mac_learning_lookup_tag(ml
, dst
, vlan
, &tag
, is_grat_arp_locked
);
256 /* Looks up MAC 'dst' for VLAN 'vlan' in 'ml'. Returns the port on which a
257 * frame destined for 'dst' should be sent, -1 if unknown.
259 * Adds to '*tag' (which the caller must have initialized) the tag that should
260 * be attached to any flow created based on the return value, if any, to allow
261 * those flows to be revalidated when the MAC learning entry changes.
263 * 'is_grat_arp_locked' is an optional parameter that returns whether the entry
264 * is currently locked.*/
266 mac_learning_lookup_tag(const struct mac_learning
*ml
,
267 const uint8_t dst
[ETH_ADDR_LEN
], uint16_t vlan
,
268 tag_type
*tag
, bool *is_grat_arp_locked
)
270 if (eth_addr_is_multicast(dst
) || !is_learning_vlan(ml
, vlan
)) {
273 struct mac_entry
*e
= search_bucket(mac_table_bucket(ml
, dst
, vlan
),
278 if (is_grat_arp_locked
) {
279 *is_grat_arp_locked
= time_now() < e
->grat_arp_lock
;
284 *tag
|= make_unknown_mac_tag(ml
, dst
, vlan
);
290 /* Expires all the mac-learning entries in 'ml'. The tags in 'ml' are
291 * discarded, so the client is responsible for revalidating any flows that
292 * depend on 'ml', if necessary. */
294 mac_learning_flush(struct mac_learning
*ml
)
297 while (get_lru(ml
, &e
)){
298 free_mac_entry(ml
, e
);
303 mac_learning_run(struct mac_learning
*ml
, struct tag_set
*set
)
306 while (get_lru(ml
, &e
) && time_now() >= e
->expires
) {
307 COVERAGE_INC(mac_learning_expired
);
309 tag_set_add(set
, e
->tag
);
311 free_mac_entry(ml
, e
);
316 mac_learning_wait(struct mac_learning
*ml
)
318 if (!list_is_empty(&ml
->lrus
)) {
319 struct mac_entry
*e
= mac_entry_from_lru_node(ml
->lrus
.next
);
320 poll_timer_wait_until(e
->expires
* 1000LL);