Merge pull request #3356 from opensourcerouting/router-id-loopbacks

[mirror_frr.git] / lib / workqueue.h

diff --git a/lib/workqueue.h b/lib/workqueue.h
index efdbdf056b3e30b7c987d0a77a44742794228021..fe1700f8ded5aaf79eff7b3a232d9e51c1cdac29 100644 (file)
--- a/lib/workqueue.h
+++ b/lib/workqueue.h
@@ -15,20 +15,20 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with Quagga; see the file COPYING.  If not, write to the Free
- * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
- * 02111-1307, USA.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; see the file COPYING; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef _QUAGGA_WORK_QUEUE_H
 #define _QUAGGA_WORK_QUEUE_H
 
 #include "memory.h"
+#include "queue.h"
 DECLARE_MTYPE(WORK_QUEUE)
 
 /* Hold time for the initial schedule of a queue run, in  millisec */
-#define WORK_QUEUE_DEFAULT_HOLD  50 
+#define WORK_QUEUE_DEFAULT_HOLD 50
 
 /* action value, for use by item processor and item error handlers */
 typedef enum {
@@ -44,6 +44,7 @@ typedef enum {
 
 /* A single work queue item, unsurprisingly */
 struct work_queue_item {
+       STAILQ_ENTRY(work_queue_item) wq;
        void *data;      /* opaque data */
        unsigned short ran; /* # of times item has been run */
 };
@@ -92,7 +93,9 @@ struct work_queue {
        } spec;
 
        /* remaining fields should be opaque to users */
-       struct list *items;   /* queue item list */
+       STAILQ_HEAD(work_queue_items, work_queue_item)
+       items;                /* queue item list */
+       int item_count;       /* queued items */
        unsigned long runs;   /* runs count */
        unsigned long yields; /* yields count */
 
@@ -103,18 +106,64 @@ struct work_queue {
        } cycles; /* cycle counts */
 
        /* private state */
-       u_int16_t flags; /* user set flag */
+       uint16_t flags; /* user set flag */
 };
 
 /* User API */
 
+static inline int work_queue_item_count(struct work_queue *wq)
+{
+       return wq->item_count;
+}
+
+static inline bool work_queue_empty(struct work_queue *wq)
+{
+       return (wq->item_count == 0) ? true : false;
+}
+
+static inline struct work_queue_item *
+work_queue_last_item(struct work_queue *wq)
+{
+       return STAILQ_LAST(&wq->items, work_queue_item, wq);
+}
+
+static inline void work_queue_item_enqueue(struct work_queue *wq,
+                                          struct work_queue_item *item)
+{
+       STAILQ_INSERT_TAIL(&wq->items, item, wq);
+       wq->item_count++;
+}
+
+static inline void work_queue_item_dequeue(struct work_queue *wq,
+                                          struct work_queue_item *item)
+{
+       assert(wq->item_count > 0);
+
+       wq->item_count--;
+       STAILQ_REMOVE(&wq->items, item, work_queue_item, wq);
+}
+
 /* create a new work queue, of given name.
  * user must fill in the spec of the returned work queue before adding
  * anything to it
  */
 extern struct work_queue *work_queue_new(struct thread_master *, const char *);
+
 /* destroy work queue */
-extern void work_queue_free(struct work_queue *);
+/*
+ * The usage of work_queue_free is being transitioned to pass
+ * in the double pointer to remove use after free's.
+ */
+#if CONFDATE > 20190205
+CPP_NOTICE("work_queue_free without double pointer is deprecated, please fixup")
+#endif
+extern void work_queue_free_and_null(struct work_queue **);
+extern void work_queue_free_original(struct work_queue *);
+#define work_queue_free(X)                                                     \
+       do {                                                                   \
+               work_queue_free_original((X));                                 \
+               CPP_WARN("Please use work_queue_free_and_null");               \
+       } while (0)
 
 /* Add the supplied data as an item onto the workqueue */
 extern void work_queue_add(struct work_queue *, void *);