]>
git.proxmox.com Git - mirror_frr.git/blob - lib/workqueue.h
4 * Copyright (C) 2005 Sun Microsystems, Inc.
6 * This file is part of Quagga.
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
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.
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
23 #ifndef _QUAGGA_WORK_QUEUE_H
24 #define _QUAGGA_WORK_QUEUE_H
33 DECLARE_MTYPE(WORK_QUEUE
)
35 /* Hold time for the initial schedule of a queue run, in millisec */
36 #define WORK_QUEUE_DEFAULT_HOLD 50
38 /* Retry for queue that is 'blocked' or 'retry later' */
39 #define WORK_QUEUE_DEFAULT_RETRY 0
41 /* action value, for use by item processor and item error handlers */
44 WQ_ERROR
, /* Error, run error handler if provided */
45 WQ_RETRY_NOW
, /* retry immediately */
46 WQ_RETRY_LATER
, /* retry later, cease processing work queue */
47 WQ_REQUEUE
, /* requeue item, continue processing work queue */
48 WQ_QUEUE_BLOCKED
, /* Queue cant be processed at this time.
49 * Similar to WQ_RETRY_LATER, but doesn't penalise
50 * the particular item.. */
53 /* A single work queue item, unsurprisingly */
54 struct work_queue_item
{
55 STAILQ_ENTRY(work_queue_item
) wq
;
56 void *data
; /* opaque data */
57 unsigned short ran
; /* # of times item has been run */
60 #define WQ_UNPLUGGED (1 << 0) /* available for draining */
63 /* Everything but the specification struct is private
64 * the following may be read
66 struct thread_master
*master
; /* thread master */
67 struct thread
*thread
; /* thread, if one is active */
68 char *name
; /* work queue name */
70 /* Specification for this work queue.
71 * Public, must be set before use by caller. May be modified at will.
74 /* optional opaque user data, global to the queue. */
77 /* work function to process items with:
78 * First argument is the workqueue queue.
79 * Second argument is the item data
81 wq_item_status (*workfunc
)(struct work_queue
*, void *);
83 /* error handling function, optional */
84 void (*errorfunc
)(struct work_queue
*,
85 struct work_queue_item
*);
87 /* callback to delete user specific item data */
88 void (*del_item_data
)(struct work_queue
*, void *);
90 /* completion callback, called when queue is emptied, optional
92 void (*completion_func
)(struct work_queue
*);
94 /* max number of retries to make for item that errors */
95 unsigned int max_retries
;
97 unsigned int hold
; /* hold time for first run, in ms */
100 yield
; /* yield time in us for associated thread */
102 uint32_t retry
; /* Optional retry timeout if queue is blocked */
105 /* remaining fields should be opaque to users */
106 STAILQ_HEAD(work_queue_items
, work_queue_item
)
107 items
; /* queue item list */
108 int item_count
; /* queued items */
109 unsigned long runs
; /* runs count */
110 unsigned long yields
; /* yields count */
114 unsigned int granularity
;
116 } cycles
; /* cycle counts */
119 uint16_t flags
; /* user set flag */
124 static inline int work_queue_item_count(struct work_queue
*wq
)
126 return wq
->item_count
;
129 static inline bool work_queue_empty(struct work_queue
*wq
)
131 return (wq
->item_count
== 0) ? true : false;
134 static inline struct work_queue_item
*
135 work_queue_last_item(struct work_queue
*wq
)
137 return STAILQ_LAST(&wq
->items
, work_queue_item
, wq
);
140 static inline void work_queue_item_enqueue(struct work_queue
*wq
,
141 struct work_queue_item
*item
)
143 STAILQ_INSERT_TAIL(&wq
->items
, item
, wq
);
147 static inline void work_queue_item_dequeue(struct work_queue
*wq
,
148 struct work_queue_item
*item
)
150 assert(wq
->item_count
> 0);
153 STAILQ_REMOVE(&wq
->items
, item
, work_queue_item
, wq
);
156 /* create a new work queue, of given name.
157 * user must fill in the spec of the returned work queue before adding
160 extern struct work_queue
*work_queue_new(struct thread_master
*, const char *);
162 /* destroy work queue */
164 * The usage of work_queue_free is being transitioned to pass
165 * in the double pointer to remove use after free's.
167 extern void work_queue_free_and_null(struct work_queue
**wqp
);
169 /* Add the supplied data as an item onto the workqueue */
170 extern void work_queue_add(struct work_queue
*wq
, void *item
);
172 /* plug the queue, ie prevent it from being drained / processed */
173 extern void work_queue_plug(struct work_queue
*wq
);
174 /* unplug the queue, allow it to be drained again */
175 extern void work_queue_unplug(struct work_queue
*wq
);
177 bool work_queue_is_scheduled(struct work_queue
*);
179 /* Helpers, exported for thread.c and command.c */
180 extern int work_queue_run(struct thread
*);
182 extern void workqueue_cmd_init(void);
188 #endif /* _QUAGGA_WORK_QUEUE_H */