]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
e0edde6f | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. |
064af421 | 3 | * |
a14bc59f BP |
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: | |
064af421 | 7 | * |
a14bc59f BP |
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. | |
064af421 BP |
15 | */ |
16 | ||
17 | #ifndef MAC_LEARNING_H | |
18 | #define MAC_LEARNING_H 1 | |
19 | ||
962ff3d6 | 20 | #include <time.h> |
8ea45fdc | 21 | #include "hmap.h" |
962ff3d6 | 22 | #include "list.h" |
064af421 BP |
23 | #include "packets.h" |
24 | #include "tag.h" | |
db8077c3 | 25 | #include "timeval.h" |
064af421 | 26 | |
e764773c BP |
27 | struct mac_learning; |
28 | ||
30a2c8b1 | 29 | #define MAC_MAX 2048 |
962ff3d6 | 30 | |
321943f7 | 31 | /* Time, in seconds, before expiring a mac_entry due to inactivity. */ |
e764773c | 32 | #define MAC_ENTRY_DEFAULT_IDLE_TIME 300 |
321943f7 | 33 | |
7febb910 JG |
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 | |
37 | ||
962ff3d6 BP |
38 | /* A MAC learning table entry. */ |
39 | struct mac_entry { | |
8ea45fdc | 40 | struct hmap_node hmap_node; /* Node in a mac_learning hmap. */ |
16a5d1e4 | 41 | struct list lru_node; /* Element in 'lrus' list. */ |
962ff3d6 | 42 | time_t expires; /* Expiration time. */ |
7febb910 | 43 | time_t grat_arp_lock; /* Gratuitous ARP lock expiration time. */ |
962ff3d6 BP |
44 | uint8_t mac[ETH_ADDR_LEN]; /* Known MAC address. */ |
45 | uint16_t vlan; /* VLAN tag. */ | |
962ff3d6 | 46 | tag_type tag; /* Tag for this learning entry. */ |
1bfe9681 BP |
47 | |
48 | /* Learned port. */ | |
49 | union { | |
1648ddd7 | 50 | void *p; |
1bfe9681 BP |
51 | int i; |
52 | } port; | |
962ff3d6 BP |
53 | }; |
54 | ||
e764773c | 55 | int mac_entry_age(const struct mac_learning *, const struct mac_entry *); |
321943f7 | 56 | |
db8077c3 BP |
57 | /* Returns true if mac_learning_insert() just created 'mac' and the caller has |
58 | * not yet properly initialized it. */ | |
59 | static inline bool mac_entry_is_new(const struct mac_entry *mac) | |
60 | { | |
61 | return !mac->tag; | |
62 | } | |
63 | ||
64 | /* Sets a gratuitous ARP lock on 'mac' that will expire in | |
65 | * MAC_GRAT_ARP_LOCK_TIME seconds. */ | |
66 | static inline void mac_entry_set_grat_arp_lock(struct mac_entry *mac) | |
67 | { | |
68 | mac->grat_arp_lock = time_now() + MAC_GRAT_ARP_LOCK_TIME; | |
69 | } | |
70 | ||
71 | /* Returns true if a gratuitous ARP lock is in effect on 'mac', false if none | |
72 | * has ever been asserted or if it has expired. */ | |
73 | static inline bool mac_entry_is_grat_arp_locked(const struct mac_entry *mac) | |
74 | { | |
33065c43 | 75 | return time_now() < mac->grat_arp_lock; |
db8077c3 BP |
76 | } |
77 | ||
962ff3d6 BP |
78 | /* MAC learning table. */ |
79 | struct mac_learning { | |
8ea45fdc | 80 | struct hmap table; /* Learning table. */ |
962ff3d6 BP |
81 | struct list lrus; /* In-use entries, least recently used at the |
82 | front, most recently used at the back. */ | |
8f30d09a BP |
83 | uint32_t secret; /* Secret for randomizing hash table. */ |
84 | unsigned long *flood_vlans; /* Bitmap of learning disabled VLANs. */ | |
e764773c | 85 | unsigned int idle_time; /* Max age before deleting an entry. */ |
962ff3d6 BP |
86 | }; |
87 | ||
db8077c3 | 88 | /* Basics. */ |
e764773c | 89 | struct mac_learning *mac_learning_create(unsigned int idle_time); |
064af421 | 90 | void mac_learning_destroy(struct mac_learning *); |
db8077c3 BP |
91 | |
92 | void mac_learning_run(struct mac_learning *, struct tag_set *); | |
93 | void mac_learning_wait(struct mac_learning *); | |
94 | ||
95 | /* Configuration. */ | |
8f30d09a | 96 | bool mac_learning_set_flood_vlans(struct mac_learning *, |
2a4ae635 | 97 | const unsigned long *bitmap); |
e764773c | 98 | void mac_learning_set_idle_time(struct mac_learning *, unsigned int idle_time); |
db8077c3 BP |
99 | |
100 | /* Learning. */ | |
101 | bool mac_learning_may_learn(const struct mac_learning *, | |
102 | const uint8_t src_mac[ETH_ADDR_LEN], | |
103 | uint16_t vlan); | |
104 | struct mac_entry *mac_learning_insert(struct mac_learning *, | |
105 | const uint8_t src[ETH_ADDR_LEN], | |
106 | uint16_t vlan); | |
107 | tag_type mac_learning_changed(struct mac_learning *, struct mac_entry *); | |
108 | ||
109 | /* Lookup. */ | |
110 | struct mac_entry *mac_learning_lookup(const struct mac_learning *, | |
111 | const uint8_t dst[ETH_ADDR_LEN], | |
112 | uint16_t vlan, tag_type *); | |
113 | ||
114 | /* Flushing. */ | |
356180a8 | 115 | void mac_learning_expire(struct mac_learning *, struct mac_entry *); |
d0040604 | 116 | void mac_learning_flush(struct mac_learning *, struct tag_set *); |
064af421 BP |
117 | |
118 | #endif /* mac-learning.h */ |