/*
- * Copyright (c) 2008, 2009, 2010 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#define MAC_LEARNING_H 1
#include <time.h>
+#include "hmap.h"
#include "list.h"
+#include "ovs-atomic.h"
+#include "ovs-thread.h"
#include "packets.h"
-#include "tag.h"
+#include "timeval.h"
-#define MAC_HASH_BITS 10
-#define MAC_HASH_MASK (MAC_HASH_SIZE - 1)
-#define MAC_HASH_SIZE (1u << MAC_HASH_BITS)
+struct mac_learning;
-#define MAC_MAX 2048
+/* Default maximum size of a MAC learning table, in entries. */
+#define MAC_DEFAULT_MAX 2048
/* Time, in seconds, before expiring a mac_entry due to inactivity. */
-#define MAC_ENTRY_IDLE_TIME 60
+#define MAC_ENTRY_DEFAULT_IDLE_TIME 300
-/* A MAC learning table entry. */
+/* Time, in seconds, to lock an entry updated by a gratuitous ARP to avoid
+ * relearning based on a reflection from a bond slave. */
+#define MAC_GRAT_ARP_LOCK_TIME 5
+
+/* A MAC learning table entry.
+ * Guarded by owning 'mac_learning''s rwlock */
struct mac_entry {
- struct list hash_node; /* Element in a mac_learning 'table' list. */
- struct list lru_node; /* Element in 'lrus' or 'free' list. */
+ struct hmap_node hmap_node; /* Node in a mac_learning hmap. */
time_t expires; /* Expiration time. */
+ time_t grat_arp_lock; /* Gratuitous ARP lock expiration time. */
uint8_t mac[ETH_ADDR_LEN]; /* Known MAC address. */
uint16_t vlan; /* VLAN tag. */
- int port; /* Port on which MAC was most recently seen. */
- tag_type tag; /* Tag for this learning entry. */
+
+ /* The following are marked guarded to prevent users from iterating over or
+ * accessing a mac_entry without hodling the parent mac_learning rwlock. */
+ struct list lru_node OVS_GUARDED; /* Element in 'lrus' list. */
+
+ /* Learned port. */
+ union {
+ void *p;
+ ofp_port_t ofp_port;
+ } port OVS_GUARDED;
};
-int mac_entry_age(const struct mac_entry *);
+/* Sets a gratuitous ARP lock on 'mac' that will expire in
+ * MAC_GRAT_ARP_LOCK_TIME seconds. */
+static inline void mac_entry_set_grat_arp_lock(struct mac_entry *mac)
+{
+ mac->grat_arp_lock = time_now() + MAC_GRAT_ARP_LOCK_TIME;
+}
+
+/* Returns true if a gratuitous ARP lock is in effect on 'mac', false if none
+ * has ever been asserted or if it has expired. */
+static inline bool mac_entry_is_grat_arp_locked(const struct mac_entry *mac)
+{
+ return time_now() < mac->grat_arp_lock;
+}
/* MAC learning table. */
struct mac_learning {
- struct list free; /* Not-in-use entries. */
- struct list lrus; /* In-use entries, least recently used at the
- front, most recently used at the back. */
- struct list table[MAC_HASH_SIZE]; /* Hash table. */
- struct mac_entry entries[MAC_MAX]; /* All entries. */
+ struct hmap table; /* Learning table. */
+ struct list lrus OVS_GUARDED; /* In-use entries, least recently used at the
+ front, most recently used at the back. */
uint32_t secret; /* Secret for randomizing hash table. */
unsigned long *flood_vlans; /* Bitmap of learning disabled VLANs. */
+ unsigned int idle_time; /* Max age before deleting an entry. */
+ size_t max_entries; /* Max number of learned MACs. */
+ atomic_int ref_cnt;
+ struct ovs_rwlock rwlock;
+ bool need_revalidate;
};
-struct mac_learning *mac_learning_create(void);
-void mac_learning_destroy(struct mac_learning *);
-bool mac_learning_set_flood_vlans(struct mac_learning *,
- unsigned long *bitmap);
-tag_type mac_learning_learn(struct mac_learning *,
- const uint8_t src[ETH_ADDR_LEN], uint16_t vlan,
- uint16_t src_port);
-int mac_learning_lookup(const struct mac_learning *,
- const uint8_t dst[ETH_ADDR_LEN], uint16_t vlan);
-int mac_learning_lookup_tag(const struct mac_learning *,
- const uint8_t dst[ETH_ADDR_LEN],
- uint16_t vlan, tag_type *tag);
-void mac_learning_flush(struct mac_learning *);
-void mac_learning_run(struct mac_learning *, struct tag_set *);
-void mac_learning_wait(struct mac_learning *);
+int mac_entry_age(const struct mac_learning *ml, const struct mac_entry *e)
+ OVS_REQ_RDLOCK(ml->rwlock);
+
+/* Basics. */
+struct mac_learning *mac_learning_create(unsigned int idle_time);
+struct mac_learning *mac_learning_ref(const struct mac_learning *);
+void mac_learning_unref(struct mac_learning *);
+
+bool mac_learning_run(struct mac_learning *ml) OVS_REQ_WRLOCK(ml->rwlock);
+void mac_learning_wait(struct mac_learning *ml)
+ OVS_REQ_RDLOCK(ml->rwlock);
+
+/* Configuration. */
+bool mac_learning_set_flood_vlans(struct mac_learning *ml,
+ const unsigned long *bitmap)
+ OVS_REQ_WRLOCK(ml->rwlock);
+void mac_learning_set_idle_time(struct mac_learning *ml,
+ unsigned int idle_time)
+ OVS_REQ_WRLOCK(ml->rwlock);
+void mac_learning_set_max_entries(struct mac_learning *ml, size_t max_entries)
+ OVS_REQ_WRLOCK(ml->rwlock);
+
+/* Learning. */
+bool mac_learning_may_learn(const struct mac_learning *ml,
+ const uint8_t src_mac[ETH_ADDR_LEN],
+ uint16_t vlan)
+ OVS_REQ_RDLOCK(ml->rwlock);
+struct mac_entry *mac_learning_insert(struct mac_learning *ml,
+ const uint8_t src[ETH_ADDR_LEN],
+ uint16_t vlan)
+ OVS_REQ_WRLOCK(ml->rwlock);
+void mac_learning_changed(struct mac_learning *ml) OVS_REQ_WRLOCK(ml->rwlock);
+
+/* Lookup. */
+struct mac_entry *mac_learning_lookup(const struct mac_learning *ml,
+ const uint8_t dst[ETH_ADDR_LEN],
+ uint16_t vlan)
+ OVS_REQ_RDLOCK(ml->rwlock);
+
+/* Flushing. */
+void mac_learning_expire(struct mac_learning *ml, struct mac_entry *e)
+ OVS_REQ_WRLOCK(ml->rwlock);
+void mac_learning_flush(struct mac_learning *ml) OVS_REQ_WRLOCK(ml->rwlock);
#endif /* mac-learning.h */