]>
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
27 DECLARE_MTYPE(WORK_QUEUE
)
29 /* Hold time for the initial schedule of a queue run, in millisec */
30 #define WORK_QUEUE_DEFAULT_HOLD 50
32 /* action value, for use by item processor and item error handlers */
35 WQ_ERROR
, /* Error, run error handler if provided */
36 WQ_RETRY_NOW
, /* retry immediately */
37 WQ_RETRY_LATER
, /* retry later, cease processing work queue */
38 WQ_REQUEUE
, /* requeue item, continue processing work queue */
39 WQ_QUEUE_BLOCKED
, /* Queue cant be processed at this time.
40 * Similar to WQ_RETRY_LATER, but doesn't penalise
41 * the particular item.. */
44 /* A single work queue item, unsurprisingly */
45 struct work_queue_item
{
46 void *data
; /* opaque data */
47 unsigned short ran
; /* # of times item has been run */
50 #define WQ_UNPLUGGED (1 << 0) /* available for draining */
53 /* Everything but the specification struct is private
54 * the following may be read
56 struct thread_master
*master
; /* thread master */
57 struct thread
*thread
; /* thread, if one is active */
58 char *name
; /* work queue name */
60 /* Specification for this work queue.
61 * Public, must be set before use by caller. May be modified at will.
64 /* optional opaque user data, global to the queue. */
67 /* work function to process items with:
68 * First argument is the workqueue queue.
69 * Second argument is the item data
71 wq_item_status (*workfunc
)(struct work_queue
*, void *);
73 /* error handling function, optional */
74 void (*errorfunc
)(struct work_queue
*,
75 struct work_queue_item
*);
77 /* callback to delete user specific item data */
78 void (*del_item_data
)(struct work_queue
*, void *);
80 /* completion callback, called when queue is emptied, optional
82 void (*completion_func
)(struct work_queue
*);
84 /* max number of retries to make for item that errors */
85 unsigned int max_retries
;
87 unsigned int hold
; /* hold time for first run, in ms */
90 yield
; /* yield time in us for associated thread */
93 /* remaining fields should be opaque to users */
94 struct list
*items
; /* queue item list */
95 unsigned long runs
; /* runs count */
96 unsigned long yields
; /* yields count */
100 unsigned int granularity
;
102 } cycles
; /* cycle counts */
105 u_int16_t flags
; /* user set flag */
110 /* create a new work queue, of given name.
111 * user must fill in the spec of the returned work queue before adding
114 extern struct work_queue
*work_queue_new(struct thread_master
*, const char *);
115 /* destroy work queue */
116 extern void work_queue_free(struct work_queue
*);
118 /* Add the supplied data as an item onto the workqueue */
119 extern void work_queue_add(struct work_queue
*, void *);
121 /* plug the queue, ie prevent it from being drained / processed */
122 extern void work_queue_plug(struct work_queue
*wq
);
123 /* unplug the queue, allow it to be drained again */
124 extern void work_queue_unplug(struct work_queue
*wq
);
126 bool work_queue_is_scheduled(struct work_queue
*);
128 /* Helpers, exported for thread.c and command.c */
129 extern int work_queue_run(struct thread
*);
131 extern void workqueue_cmd_init(void);
133 #endif /* _QUAGGA_WORK_QUEUE_H */