nx-match: Drop NXM_MAX_LEN.
[openvswitch] / lib / mac-learning.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 #ifndef MAC_LEARNING_H
18 #define MAC_LEARNING_H 1
19
20 #include <time.h>
21 #include "hmap.h"
22 #include "list.h"
23 #include "packets.h"
24 #include "tag.h"
25 #include "timeval.h"
26
27 struct mac_learning;
28
29 #define MAC_MAX 2048
30
31 /* Time, in seconds, before expiring a mac_entry due to inactivity. */
32 #define MAC_ENTRY_DEFAULT_IDLE_TIME 300
33
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
38 /* A MAC learning table entry. */
39 struct mac_entry {
40     struct hmap_node hmap_node; /* Node in a mac_learning hmap. */
41     struct list lru_node;       /* Element in 'lrus' list. */
42     time_t expires;             /* Expiration time. */
43     time_t grat_arp_lock;       /* Gratuitous ARP lock expiration time. */
44     uint8_t mac[ETH_ADDR_LEN];  /* Known MAC address. */
45     uint16_t vlan;              /* VLAN tag. */
46     tag_type tag;               /* Tag for this learning entry. */
47
48     /* Learned port. */
49     union {
50         void *p;
51         int i;
52     } port;
53 };
54
55 int mac_entry_age(const struct mac_learning *, const struct mac_entry *);
56
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 {
75     return time_now() < mac->grat_arp_lock;
76 }
77
78 /* MAC learning table. */
79 struct mac_learning {
80     struct hmap table;          /* Learning table. */
81     struct list lrus;           /* In-use entries, least recently used at the
82                                    front, most recently used at the back. */
83     uint32_t secret;            /* Secret for randomizing hash table. */
84     unsigned long *flood_vlans; /* Bitmap of learning disabled VLANs. */
85     unsigned int idle_time;     /* Max age before deleting an entry. */
86 };
87
88 /* Basics. */
89 struct mac_learning *mac_learning_create(unsigned int idle_time);
90 void mac_learning_destroy(struct mac_learning *);
91
92 void mac_learning_run(struct mac_learning *, struct tag_set *);
93 void mac_learning_wait(struct mac_learning *);
94
95 /* Configuration. */
96 bool mac_learning_set_flood_vlans(struct mac_learning *,
97                                   const unsigned long *bitmap);
98 void mac_learning_set_idle_time(struct mac_learning *, unsigned int idle_time);
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. */
115 void mac_learning_expire(struct mac_learning *, struct mac_entry *);
116 void mac_learning_flush(struct mac_learning *, struct tag_set *);
117
118 #endif /* mac-learning.h */