Merge pull request #3835 from qlyoung/build-update-libyang-doc-link

[mirror_frr.git] / lib / workqueue.h

diff --git a/lib/workqueue.h b/lib/workqueue.h
index ff7f57690dd93721be68b5964fbe149508e0d1a1..7c610f5dd6b5e51d7c0fe8e118d5537fbb9aeb44 100644 (file)
--- a/lib/workqueue.h
+++ b/lib/workqueue.h
@@ -24,10 +24,19 @@
 #define _QUAGGA_WORK_QUEUE_H
 
 #include "memory.h"
+#include "queue.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 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
+
+/* Retry for queue that is 'blocked' or 'retry later' */
+#define WORK_QUEUE_DEFAULT_RETRY 0
 
 /* action value, for use by item processor and item error handlers */
 typedef enum {
@@ -43,6 +52,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 */
 };
@@ -88,10 +98,14 @@ struct work_queue {
 
                unsigned long
                        yield; /* yield time in us for associated thread */
+
+               uint32_t retry; /* Optional retry timeout if queue is blocked */
        } 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 */
 
@@ -102,21 +116,58 @@ 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.
+ */
+extern void work_queue_free_and_null(struct work_queue **wqp);
 
 /* Add the supplied data as an item onto the workqueue */
-extern void work_queue_add(struct work_queue *, void *);
+extern void work_queue_add(struct work_queue *wq, void *item);
 
 /* plug the queue, ie prevent it from being drained / processed */
 extern void work_queue_plug(struct work_queue *wq);
@@ -130,4 +181,8 @@ extern int work_queue_run(struct thread *);
 
 extern void workqueue_cmd_init(void);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* _QUAGGA_WORK_QUEUE_H */