mac-learning: Reference count 'struct mac_learning".

[sliver-openvswitch.git] / lib / mac-learning.h

diff --git a/lib/mac-learning.h b/lib/mac-learning.h
index 16c92db..06e99f3 100644 (file)
--- a/lib/mac-learning.h
+++ b/lib/mac-learning.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2009, 2010, 2011 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.
@@ -18,19 +18,19 @@
 #define MAC_LEARNING_H 1
 
 #include <time.h>
+#include "hmap.h"
 #include "list.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
 
 /* Time, in seconds, to lock an entry updated by a gratuitous ARP to avoid
  * relearning based on a reflection from a bond slave. */
@@ -38,8 +38,8 @@
 
 /* A MAC learning table entry. */
 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. */
+    struct list lru_node;       /* Element in 'lrus' list. */
     time_t expires;             /* Expiration time. */
     time_t grat_arp_lock;       /* Gratuitous ARP lock expiration time. */
     uint8_t mac[ETH_ADDR_LEN];  /* Known MAC address. */
@@ -49,11 +49,11 @@ struct mac_entry {
     /* Learned port. */
     union {
         void *p;
-        int i;
+        ofp_port_t ofp_port;
     } port;
 };
 
-int mac_entry_age(const struct mac_entry *);
+int mac_entry_age(const struct mac_learning *, const struct mac_entry *);
 
 /* Returns true if mac_learning_insert() just created 'mac' and the caller has
  * not yet properly initialized it. */
@@ -73,30 +73,35 @@ static inline void mac_entry_set_grat_arp_lock(struct mac_entry *mac)
  * 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;
+    return time_now() < mac->grat_arp_lock;
 }
 
 /* MAC learning table. */
 struct mac_learning {
-    struct list free;           /* Not-in-use entries. */
+    struct hmap table;          /* Learning table. */
     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. */
     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. */
+    struct tag_set tags;        /* Tags which have changed. */
+    int ref_cnt;
 };
 
 /* Basics. */
-struct mac_learning *mac_learning_create(void);
-void mac_learning_destroy(struct mac_learning *);
+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 *);
 
 void mac_learning_run(struct mac_learning *, struct tag_set *);
 void mac_learning_wait(struct mac_learning *);
 
 /* Configuration. */
 bool mac_learning_set_flood_vlans(struct mac_learning *,
-                                  unsigned long *bitmap);
+                                  const unsigned long *bitmap);
+void mac_learning_set_idle_time(struct mac_learning *, unsigned int idle_time);
+void mac_learning_set_max_entries(struct mac_learning *, size_t max_entries);
 
 /* Learning. */
 bool mac_learning_may_learn(const struct mac_learning *,
@@ -105,7 +110,7 @@ bool mac_learning_may_learn(const struct mac_learning *,
 struct mac_entry *mac_learning_insert(struct mac_learning *,
                                       const uint8_t src[ETH_ADDR_LEN],
                                       uint16_t vlan);
-tag_type mac_learning_changed(struct mac_learning *, struct mac_entry *);
+void mac_learning_changed(struct mac_learning *, struct mac_entry *);
 
 /* Lookup. */
 struct mac_entry *mac_learning_lookup(const struct mac_learning *,
@@ -114,6 +119,6 @@ struct mac_entry *mac_learning_lookup(const struct mac_learning *,
 
 /* Flushing. */
 void mac_learning_expire(struct mac_learning *, struct mac_entry *);
-void mac_learning_flush(struct mac_learning *);
+void mac_learning_flush(struct mac_learning *, struct tag_set *);
 
 #endif /* mac-learning.h */