]> git.proxmox.com Git - mirror_frr.git/blame - lib/workqueue.h
Merge branch 'master' into dev-master
[mirror_frr.git] / lib / workqueue.h
CommitLineData
d62a17ae 1/*
354d119a 2 * Quagga Work Queues.
3 *
4 * Copyright (C) 2005 Sun Microsystems, Inc.
5 *
6 * This file is part of Quagga.
7 *
8 * Quagga is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2, or (at your option) any
11 * later version.
12 *
13 * Quagga is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
896014f4
DL
18 * You should have received a copy of the GNU General Public License along
19 * with this program; see the file COPYING; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
354d119a 21 */
22
23#ifndef _QUAGGA_WORK_QUEUE_H
24#define _QUAGGA_WORK_QUEUE_H
25
4a1ab8e4 26#include "memory.h"
f104f6c1 27#include "queue.h"
4a1ab8e4
DL
28DECLARE_MTYPE(WORK_QUEUE)
29
306d8890 30/* Hold time for the initial schedule of a queue run, in millisec */
31#define WORK_QUEUE_DEFAULT_HOLD 50
354d119a 32
33/* action value, for use by item processor and item error handlers */
d62a17ae 34typedef enum {
35 WQ_SUCCESS = 0,
36 WQ_ERROR, /* Error, run error handler if provided */
37 WQ_RETRY_NOW, /* retry immediately */
38 WQ_RETRY_LATER, /* retry later, cease processing work queue */
39 WQ_REQUEUE, /* requeue item, continue processing work queue */
40 WQ_QUEUE_BLOCKED, /* Queue cant be processed at this time.
41 * Similar to WQ_RETRY_LATER, but doesn't penalise
42 * the particular item.. */
354d119a 43} wq_item_status;
44
45/* A single work queue item, unsurprisingly */
d62a17ae 46struct work_queue_item {
f104f6c1 47 STAILQ_ENTRY(work_queue_item) wq;
d62a17ae 48 void *data; /* opaque data */
49 unsigned short ran; /* # of times item has been run */
354d119a 50};
51
6ce80bdb 52#define WQ_UNPLUGGED (1 << 0) /* available for draining */
269d74fd 53
d62a17ae 54struct work_queue {
55 /* Everything but the specification struct is private
56 * the following may be read
57 */
58 struct thread_master *master; /* thread master */
59 struct thread *thread; /* thread, if one is active */
60 char *name; /* work queue name */
61
62 /* Specification for this work queue.
63 * Public, must be set before use by caller. May be modified at will.
64 */
65 struct {
66 /* optional opaque user data, global to the queue. */
67 void *data;
68
69 /* work function to process items with:
70 * First argument is the workqueue queue.
71 * Second argument is the item data
72 */
73 wq_item_status (*workfunc)(struct work_queue *, void *);
74
75 /* error handling function, optional */
76 void (*errorfunc)(struct work_queue *,
77 struct work_queue_item *);
78
79 /* callback to delete user specific item data */
80 void (*del_item_data)(struct work_queue *, void *);
81
82 /* completion callback, called when queue is emptied, optional
83 */
84 void (*completion_func)(struct work_queue *);
85
86 /* max number of retries to make for item that errors */
87 unsigned int max_retries;
88
89 unsigned int hold; /* hold time for first run, in ms */
90
91 unsigned long
92 yield; /* yield time in us for associated thread */
93 } spec;
94
95 /* remaining fields should be opaque to users */
f104f6c1
JB
96 STAILQ_HEAD(work_queue_items, work_queue_item) items; /* queue item list */
97 int item_count; /* queued items */
d62a17ae 98 unsigned long runs; /* runs count */
99 unsigned long yields; /* yields count */
100
101 struct {
102 unsigned int best;
103 unsigned int granularity;
104 unsigned long total;
105 } cycles; /* cycle counts */
106
107 /* private state */
108 u_int16_t flags; /* user set flag */
354d119a 109};
110
111/* User API */
269d74fd 112
f104f6c1
JB
113static inline int work_queue_item_count(struct work_queue *wq)
114{
115 return wq->item_count;
116}
117
118static inline bool work_queue_empty(struct work_queue *wq)
119{
120 return (wq->item_count == 0) ? true : false;
121}
122
123static inline struct work_queue_item *work_queue_last_item(struct work_queue *wq)
124{
125 return STAILQ_LAST(&wq->items, work_queue_item, wq);
126}
127
128static inline void work_queue_item_enqueue(struct work_queue *wq,
129 struct work_queue_item *item)
130{
131 STAILQ_INSERT_TAIL(&wq->items, item, wq);
132 wq->item_count++;
133}
134
135static inline void work_queue_item_dequeue(struct work_queue *wq,
136 struct work_queue_item *item)
137{
138 assert(wq->item_count > 0);
139
140 wq->item_count--;
141 STAILQ_REMOVE(&wq->items, item, work_queue_item, wq);
142}
143
d62a17ae 144/* create a new work queue, of given name.
269d74fd 145 * user must fill in the spec of the returned work queue before adding
146 * anything to it
147 */
d62a17ae 148extern struct work_queue *work_queue_new(struct thread_master *, const char *);
269d74fd 149/* destroy work queue */
d62a17ae 150extern void work_queue_free(struct work_queue *);
269d74fd 151
152/* Add the supplied data as an item onto the workqueue */
d62a17ae 153extern void work_queue_add(struct work_queue *, void *);
354d119a 154
269d74fd 155/* plug the queue, ie prevent it from being drained / processed */
d62a17ae 156extern void work_queue_plug(struct work_queue *wq);
269d74fd 157/* unplug the queue, allow it to be drained again */
d62a17ae 158extern void work_queue_unplug(struct work_queue *wq);
269d74fd 159
d62a17ae 160bool work_queue_is_scheduled(struct work_queue *);
86582682 161
354d119a 162/* Helpers, exported for thread.c and command.c */
d62a17ae 163extern int work_queue_run(struct thread *);
0b84f294 164
d62a17ae 165extern void workqueue_cmd_init(void);
0b84f294 166
354d119a 167#endif /* _QUAGGA_WORK_QUEUE_H */