]>
git.proxmox.com Git - mirror_ovs.git/blob - lib/mac-learning.c
2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
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"
27 #include "poll-loop.h"
30 #include "unaligned.h"
32 #include "vlan-bitmap.h"
35 VLOG_DEFINE_THIS_MODULE(mac_learning
);
37 COVERAGE_DEFINE(mac_learning_learned
);
38 COVERAGE_DEFINE(mac_learning_expired
);
40 /* Returns the number of seconds since 'e' (within 'ml') was last learned. */
42 mac_entry_age(const struct mac_learning
*ml
, const struct mac_entry
*e
)
44 time_t remaining
= e
->expires
- time_now();
45 return ml
->idle_time
- remaining
;
49 mac_table_hash(const struct mac_learning
*ml
, const uint8_t mac
[ETH_ADDR_LEN
],
52 unsigned int mac1
= get_unaligned_u32(ALIGNED_CAST(uint32_t *, mac
));
53 unsigned int mac2
= get_unaligned_u16(ALIGNED_CAST(uint16_t *, mac
+ 4));
54 return hash_3words(mac1
, mac2
| (vlan
<< 16), ml
->secret
);
57 static struct mac_entry
*
58 mac_entry_from_lru_node(struct list
*list
)
60 return CONTAINER_OF(list
, struct mac_entry
, lru_node
);
63 /* Returns a tag that represents that 'mac' is on an unknown port in 'vlan'.
64 * (When we learn where 'mac' is in 'vlan', this allows flows that were
65 * flooded to be revalidated.) */
67 make_unknown_mac_tag(const struct mac_learning
*ml
,
68 const uint8_t mac
[ETH_ADDR_LEN
], uint16_t vlan
)
70 return tag_create_deterministic(mac_table_hash(ml
, mac
, vlan
));
73 static struct mac_entry
*
74 mac_entry_lookup(const struct mac_learning
*ml
,
75 const uint8_t mac
[ETH_ADDR_LEN
], uint16_t vlan
)
79 HMAP_FOR_EACH_WITH_HASH (e
, hmap_node
, mac_table_hash(ml
, mac
, vlan
),
81 if (e
->vlan
== vlan
&& eth_addr_equals(e
->mac
, mac
)) {
88 /* If the LRU list is not empty, stores the least-recently-used entry in '*e'
89 * and returns true. Otherwise, if the LRU list is empty, stores NULL in '*e'
90 * and return false. */
92 get_lru(struct mac_learning
*ml
, struct mac_entry
**e
)
93 OVS_REQ_RDLOCK(ml
->rwlock
)
95 if (!list_is_empty(&ml
->lrus
)) {
96 *e
= mac_entry_from_lru_node(ml
->lrus
.next
);
105 normalize_idle_time(unsigned int idle_time
)
107 return (idle_time
< 15 ? 15
108 : idle_time
> 3600 ? 3600
112 /* Creates and returns a new MAC learning table with an initial MAC aging
113 * timeout of 'idle_time' seconds and an initial maximum of MAC_DEFAULT_MAX
115 struct mac_learning
*
116 mac_learning_create(unsigned int idle_time
)
118 struct mac_learning
*ml
;
120 ml
= xmalloc(sizeof *ml
);
121 list_init(&ml
->lrus
);
122 hmap_init(&ml
->table
);
123 ml
->secret
= random_uint32();
124 ml
->flood_vlans
= NULL
;
125 ml
->idle_time
= normalize_idle_time(idle_time
);
126 ml
->max_entries
= MAC_DEFAULT_MAX
;
127 tag_set_init(&ml
->tags
);
128 atomic_init(&ml
->ref_cnt
, 1);
129 ovs_rwlock_init(&ml
->rwlock
);
133 struct mac_learning
*
134 mac_learning_ref(const struct mac_learning
*ml_
)
136 struct mac_learning
*ml
= CONST_CAST(struct mac_learning
*, ml_
);
139 atomic_add(&ml
->ref_cnt
, 1, &orig
);
140 ovs_assert(orig
> 0);
145 /* Unreferences (and possibly destroys) MAC learning table 'ml'. */
147 mac_learning_unref(struct mac_learning
*ml
)
155 atomic_sub(&ml
->ref_cnt
, 1, &orig
);
156 ovs_assert(orig
> 0);
158 struct mac_entry
*e
, *next
;
160 HMAP_FOR_EACH_SAFE (e
, next
, hmap_node
, &ml
->table
) {
161 hmap_remove(&ml
->table
, &e
->hmap_node
);
164 hmap_destroy(&ml
->table
);
166 bitmap_free(ml
->flood_vlans
);
167 ovs_rwlock_destroy(&ml
->rwlock
);
172 /* Provides a bitmap of VLANs which have learning disabled, that is, VLANs on
173 * which all packets are flooded. Returns true if the set has changed from the
176 mac_learning_set_flood_vlans(struct mac_learning
*ml
,
177 const unsigned long *bitmap
)
179 if (vlan_bitmap_equal(ml
->flood_vlans
, bitmap
)) {
182 bitmap_free(ml
->flood_vlans
);
183 ml
->flood_vlans
= vlan_bitmap_clone(bitmap
);
188 /* Changes the MAC aging timeout of 'ml' to 'idle_time' seconds. */
190 mac_learning_set_idle_time(struct mac_learning
*ml
, unsigned int idle_time
)
192 idle_time
= normalize_idle_time(idle_time
);
193 if (idle_time
!= ml
->idle_time
) {
197 delta
= (int) idle_time
- (int) ml
->idle_time
;
198 LIST_FOR_EACH (e
, lru_node
, &ml
->lrus
) {
201 ml
->idle_time
= idle_time
;
205 /* Sets the maximum number of entries in 'ml' to 'max_entries', adjusting it
206 * to be within a reasonable range. */
208 mac_learning_set_max_entries(struct mac_learning
*ml
, size_t max_entries
)
210 ml
->max_entries
= (max_entries
< 10 ? 10
211 : max_entries
> 1000 * 1000 ? 1000 * 1000
216 is_learning_vlan(const struct mac_learning
*ml
, uint16_t vlan
)
218 return !ml
->flood_vlans
|| !bitmap_is_set(ml
->flood_vlans
, vlan
);
221 /* Returns true if 'src_mac' may be learned on 'vlan' for 'ml'.
222 * Returns false if 'ml' is NULL, if src_mac is not valid for learning, or if
223 * 'vlan' is configured on 'ml' to flood all packets. */
225 mac_learning_may_learn(const struct mac_learning
*ml
,
226 const uint8_t src_mac
[ETH_ADDR_LEN
], uint16_t vlan
)
228 return ml
&& is_learning_vlan(ml
, vlan
) && !eth_addr_is_multicast(src_mac
);
231 /* Searches 'ml' for and returns a MAC learning entry for 'src_mac' in 'vlan',
232 * inserting a new entry if necessary. The caller must have already verified,
233 * by calling mac_learning_may_learn(), that 'src_mac' and 'vlan' are
236 * If the returned MAC entry is new (as may be determined by calling
237 * mac_entry_is_new()), then the caller must pass the new entry to
238 * mac_learning_changed(). The caller must also initialize the new entry's
239 * 'port' member. Otherwise calling those functions is at the caller's
242 mac_learning_insert(struct mac_learning
*ml
,
243 const uint8_t src_mac
[ETH_ADDR_LEN
], uint16_t vlan
)
247 e
= mac_entry_lookup(ml
, src_mac
, vlan
);
249 uint32_t hash
= mac_table_hash(ml
, src_mac
, vlan
);
251 if (hmap_count(&ml
->table
) >= ml
->max_entries
) {
253 mac_learning_expire(ml
, e
);
256 e
= xmalloc(sizeof *e
);
257 hmap_insert(&ml
->table
, &e
->hmap_node
, hash
);
258 memcpy(e
->mac
, src_mac
, ETH_ADDR_LEN
);
261 e
->grat_arp_lock
= TIME_MIN
;
263 list_remove(&e
->lru_node
);
266 /* Mark 'e' as recently used. */
267 list_push_back(&ml
->lrus
, &e
->lru_node
);
268 e
->expires
= time_now() + ml
->idle_time
;
273 /* Changes 'e''s tag to a new, randomly selected one. Causes
274 * mac_learning_run() to flag for revalidation the tag that would have been
275 * previously used for this entry's MAC and VLAN (either before 'e' was
276 * inserted, if it is new, or otherwise before its port was updated.)
278 * The client should call this function after obtaining a MAC learning entry
279 * from mac_learning_insert(), if the entry is either new or if its learned
280 * port has changed. */
282 mac_learning_changed(struct mac_learning
*ml
, struct mac_entry
*e
)
284 tag_type tag
= e
->tag
? e
->tag
: make_unknown_mac_tag(ml
, e
->mac
, e
->vlan
);
286 COVERAGE_INC(mac_learning_learned
);
288 e
->tag
= tag_create_random();
289 tag_set_add(&ml
->tags
, tag
);
292 /* Looks up MAC 'dst' for VLAN 'vlan' in 'ml' and returns the associated MAC
293 * learning entry, if any. If 'tag' is nonnull, then the tag that associates
294 * 'dst' and 'vlan' with its currently learned port will be OR'd into
297 mac_learning_lookup(const struct mac_learning
*ml
,
298 const uint8_t dst
[ETH_ADDR_LEN
], uint16_t vlan
,
301 if (eth_addr_is_multicast(dst
)) {
302 /* No tag because the treatment of multicast destinations never
305 } else if (!is_learning_vlan(ml
, vlan
)) {
306 /* We don't tag this property. The set of learning VLANs changes so
307 * rarely that we revalidate every flow when it changes. */
310 struct mac_entry
*e
= mac_entry_lookup(ml
, dst
, vlan
);
312 ovs_assert(e
== NULL
|| e
->tag
!= 0);
314 /* Tag either the learned port or the lack thereof. */
315 *tag
|= e
? e
->tag
: make_unknown_mac_tag(ml
, dst
, vlan
);
321 /* Expires 'e' from the 'ml' hash table. */
323 mac_learning_expire(struct mac_learning
*ml
, struct mac_entry
*e
)
325 hmap_remove(&ml
->table
, &e
->hmap_node
);
326 list_remove(&e
->lru_node
);
330 /* Expires all the mac-learning entries in 'ml'. If not NULL, the tags in 'ml'
331 * are added to 'tags'. Otherwise the tags in 'ml' are discarded. The client
332 * is responsible for revalidating any flows that depend on 'ml', if
335 mac_learning_flush(struct mac_learning
*ml
, struct tag_set
*tags
)
338 while (get_lru(ml
, &e
)){
340 tag_set_add(tags
, e
->tag
);
342 mac_learning_expire(ml
, e
);
344 hmap_shrink(&ml
->table
);
348 mac_learning_run(struct mac_learning
*ml
, struct tag_set
*set
)
353 tag_set_union(set
, &ml
->tags
);
355 tag_set_init(&ml
->tags
);
357 while (get_lru(ml
, &e
)
358 && (hmap_count(&ml
->table
) > ml
->max_entries
359 || time_now() >= e
->expires
)) {
360 COVERAGE_INC(mac_learning_expired
);
362 tag_set_add(set
, e
->tag
);
364 mac_learning_expire(ml
, e
);
369 mac_learning_wait(struct mac_learning
*ml
)
371 if (hmap_count(&ml
->table
) > ml
->max_entries
372 || !tag_set_is_empty(&ml
->tags
)) {
373 poll_immediate_wake();
374 } else if (!list_is_empty(&ml
->lrus
)) {
375 struct mac_entry
*e
= mac_entry_from_lru_node(ml
->lrus
.next
);
376 poll_timer_wait_until(e
->expires
* 1000LL);