socket-util: closesocket() for Windows.
[sliver-openvswitch.git] / lib / mac-learning.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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         ovs_refcount_destroy(&ml->ref_cnt);
145         free(ml);
146     }
147 }
148
149 /* Provides a bitmap of VLANs which have learning disabled, that is, VLANs on
150  * which all packets are flooded.  Returns true if the set has changed from the
151  * previous value. */
152 bool
153 mac_learning_set_flood_vlans(struct mac_learning *ml,
154                              const unsigned long *bitmap)
155 {
156     if (vlan_bitmap_equal(ml->flood_vlans, bitmap)) {
157         return false;
158     } else {
159         bitmap_free(ml->flood_vlans);
160         ml->flood_vlans = vlan_bitmap_clone(bitmap);
161         return true;
162     }
163 }
164
165 /* Changes the MAC aging timeout of 'ml' to 'idle_time' seconds. */
166 void
167 mac_learning_set_idle_time(struct mac_learning *ml, unsigned int idle_time)
168 {
169     idle_time = normalize_idle_time(idle_time);
170     if (idle_time != ml->idle_time) {
171         struct mac_entry *e;
172         int delta;
173
174         delta = (int) idle_time - (int) ml->idle_time;
175         LIST_FOR_EACH (e, lru_node, &ml->lrus) {
176             e->expires += delta;
177         }
178         ml->idle_time = idle_time;
179     }
180 }
181
182 /* Sets the maximum number of entries in 'ml' to 'max_entries', adjusting it
183  * to be within a reasonable range. */
184 void
185 mac_learning_set_max_entries(struct mac_learning *ml, size_t max_entries)
186 {
187     ml->max_entries = (max_entries < 10 ? 10
188                        : max_entries > 1000 * 1000 ? 1000 * 1000
189                        : max_entries);
190 }
191
192 static bool
193 is_learning_vlan(const struct mac_learning *ml, uint16_t vlan)
194 {
195     return !ml->flood_vlans || !bitmap_is_set(ml->flood_vlans, vlan);
196 }
197
198 /* Returns true if 'src_mac' may be learned on 'vlan' for 'ml'.
199  * Returns false if 'ml' is NULL, if src_mac is not valid for learning, or if
200  * 'vlan' is configured on 'ml' to flood all packets. */
201 bool
202 mac_learning_may_learn(const struct mac_learning *ml,
203                        const uint8_t src_mac[ETH_ADDR_LEN], uint16_t vlan)
204 {
205     return ml && is_learning_vlan(ml, vlan) && !eth_addr_is_multicast(src_mac);
206 }
207
208 /* Searches 'ml' for and returns a MAC learning entry for 'src_mac' in 'vlan',
209  * inserting a new entry if necessary.  The caller must have already verified,
210  * by calling mac_learning_may_learn(), that 'src_mac' and 'vlan' are
211  * learnable.
212  *
213  * If the returned MAC entry is new (as may be determined by calling
214  * mac_entry_is_new()), then the caller must pass the new entry to
215  * mac_learning_changed().  The caller must also initialize the new entry's
216  * 'port' member.  Otherwise calling those functions is at the caller's
217  * discretion. */
218 struct mac_entry *
219 mac_learning_insert(struct mac_learning *ml,
220                     const uint8_t src_mac[ETH_ADDR_LEN], uint16_t vlan)
221 {
222     struct mac_entry *e;
223
224     e = mac_entry_lookup(ml, src_mac, vlan);
225     if (!e) {
226         uint32_t hash = mac_table_hash(ml, src_mac, vlan);
227
228         if (hmap_count(&ml->table) >= ml->max_entries) {
229             get_lru(ml, &e);
230             mac_learning_expire(ml, e);
231         }
232
233         e = xmalloc(sizeof *e);
234         hmap_insert(&ml->table, &e->hmap_node, hash);
235         memcpy(e->mac, src_mac, ETH_ADDR_LEN);
236         e->vlan = vlan;
237         e->grat_arp_lock = TIME_MIN;
238         e->port.p = NULL;
239     } else {
240         list_remove(&e->lru_node);
241     }
242
243     /* Mark 'e' as recently used. */
244     list_push_back(&ml->lrus, &e->lru_node);
245     e->expires = time_now() + ml->idle_time;
246
247     return e;
248 }
249
250 /* Changes 'e''s tag to a new, randomly selected one.  Causes
251  * mac_learning_run() to flag for revalidation the tag that would have been
252  * previously used for this entry's MAC and VLAN (either before 'e' was
253  * inserted, if it is new, or otherwise before its port was updated.)
254  *
255  * The client should call this function after obtaining a MAC learning entry
256  * from mac_learning_insert(), if the entry is either new or if its learned
257  * port has changed. */
258 void
259 mac_learning_changed(struct mac_learning *ml)
260 {
261     COVERAGE_INC(mac_learning_learned);
262     ml->need_revalidate = true;
263 }
264
265 /* Looks up MAC 'dst' for VLAN 'vlan' in 'ml' and returns the associated MAC
266  * learning entry, if any.  If 'tag' is nonnull, then the tag that associates
267  * 'dst' and 'vlan' with its currently learned port will be OR'd into
268  * '*tag'. */
269 struct mac_entry *
270 mac_learning_lookup(const struct mac_learning *ml,
271                     const uint8_t dst[ETH_ADDR_LEN], uint16_t vlan)
272 {
273     if (eth_addr_is_multicast(dst)) {
274         /* No tag because the treatment of multicast destinations never
275          * changes. */
276         return NULL;
277     } else if (!is_learning_vlan(ml, vlan)) {
278         /* We don't tag this property.  The set of learning VLANs changes so
279          * rarely that we revalidate every flow when it changes. */
280         return NULL;
281     } else {
282         struct mac_entry *e = mac_entry_lookup(ml, dst, vlan);
283
284         ovs_assert(e == NULL || e->port.p != NULL);
285         return e;
286     }
287 }
288
289 /* Expires 'e' from the 'ml' hash table. */
290 void
291 mac_learning_expire(struct mac_learning *ml, struct mac_entry *e)
292 {
293     hmap_remove(&ml->table, &e->hmap_node);
294     list_remove(&e->lru_node);
295     free(e);
296 }
297
298 /* Expires all the mac-learning entries in 'ml'.  If not NULL, the tags in 'ml'
299  * are added to 'tags'.  Otherwise the tags in 'ml' are discarded.  The client
300  * is responsible for revalidating any flows that depend on 'ml', if
301  * necessary. */
302 void
303 mac_learning_flush(struct mac_learning *ml)
304 {
305     struct mac_entry *e;
306     while (get_lru(ml, &e)){
307         ml->need_revalidate = true;
308         mac_learning_expire(ml, e);
309     }
310     hmap_shrink(&ml->table);
311 }
312
313 /* Does periodic work required by 'ml'.  Returns true if something changed that
314  * may require flow revalidation. */
315 bool
316 mac_learning_run(struct mac_learning *ml)
317 {
318     bool need_revalidate;
319     struct mac_entry *e;
320
321     while (get_lru(ml, &e)
322            && (hmap_count(&ml->table) > ml->max_entries
323                || time_now() >= e->expires)) {
324         COVERAGE_INC(mac_learning_expired);
325         ml->need_revalidate = true;
326         mac_learning_expire(ml, e);
327     }
328
329     need_revalidate = ml->need_revalidate;
330     ml->need_revalidate = false;
331     return need_revalidate;
332 }
333
334 void
335 mac_learning_wait(struct mac_learning *ml)
336 {
337     if (hmap_count(&ml->table) > ml->max_entries
338         || ml->need_revalidate) {
339         poll_immediate_wake();
340     } else if (!list_is_empty(&ml->lrus)) {
341         struct mac_entry *e = mac_entry_from_lru_node(ml->lrus.next);
342         poll_timer_wait_until(e->expires * 1000LL);
343     }
344 }