]>
Commit | Line | Data |
---|---|---|
1 | /* | |
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 | * | |
18 | * You should have received a copy of the GNU General Public License | |
19 | * along with Quagga; see the file COPYING. If not, write to the Free | |
20 | * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
21 | * 02111-1307, USA. | |
22 | */ | |
23 | ||
24 | #ifndef _QUAGGA_WORK_QUEUE_H | |
25 | #define _QUAGGA_WORK_QUEUE_H | |
26 | ||
27 | /* Hold time for the initial schedule of a queue run, in millisec */ | |
28 | #define WORK_QUEUE_DEFAULT_HOLD 50 | |
29 | ||
30 | /* action value, for use by item processor and item error handlers */ | |
31 | typedef enum | |
32 | { | |
33 | WQ_SUCCESS = 0, | |
34 | WQ_ERROR, /* Error, run error handler if provided */ | |
35 | WQ_RETRY_NOW, /* retry immediately */ | |
36 | WQ_RETRY_LATER, /* retry later, cease processing work queue */ | |
37 | WQ_REQUEUE, /* requeue item, continue processing work queue */ | |
38 | WQ_QUEUE_BLOCKED, /* Queue cant be processed at this time. | |
39 | * Similar to WQ_RETRY_LATER, but doesn't penalise | |
40 | * the particular item.. */ | |
41 | } wq_item_status; | |
42 | ||
43 | /* A single work queue item, unsurprisingly */ | |
44 | struct work_queue_item | |
45 | { | |
46 | void *data; /* opaque data */ | |
47 | unsigned short ran; /* # of times item has been run */ | |
48 | }; | |
49 | ||
50 | enum work_queue_flags | |
51 | { | |
52 | WQ_UNPLUGGED = 0, | |
53 | WQ_PLUGGED = 1, | |
54 | }; | |
55 | ||
56 | struct work_queue | |
57 | { | |
58 | /* Everything but the specification struct is private | |
59 | * the following may be read | |
60 | */ | |
61 | struct thread_master *master; /* thread master */ | |
62 | struct thread *thread; /* thread, if one is active */ | |
63 | char *name; /* work queue name */ | |
64 | ||
65 | /* Specification for this work queue. | |
66 | * Public, must be set before use by caller. May be modified at will. | |
67 | */ | |
68 | struct { | |
69 | /* optional opaque user data, global to the queue. */ | |
70 | void *data; | |
71 | ||
72 | /* work function to process items with: | |
73 | * First argument is the workqueue queue. | |
74 | * Second argument is the item data | |
75 | */ | |
76 | wq_item_status (*workfunc) (struct work_queue *, void *); | |
77 | ||
78 | /* error handling function, optional */ | |
79 | void (*errorfunc) (struct work_queue *, struct work_queue_item *); | |
80 | ||
81 | /* callback to delete user specific item data */ | |
82 | void (*del_item_data) (struct work_queue *, void *); | |
83 | ||
84 | /* completion callback, called when queue is emptied, optional */ | |
85 | void (*completion_func) (struct work_queue *); | |
86 | ||
87 | /* max number of retries to make for item that errors */ | |
88 | unsigned int max_retries; | |
89 | ||
90 | unsigned int hold; /* hold time for first run, in ms */ | |
91 | } spec; | |
92 | ||
93 | /* remaining fields should be opaque to users */ | |
94 | struct list *items; /* queue item list */ | |
95 | unsigned long runs; /* runs count */ | |
96 | ||
97 | struct { | |
98 | unsigned int best; | |
99 | unsigned int granularity; | |
100 | unsigned long total; | |
101 | } cycles; /* cycle counts */ | |
102 | ||
103 | /* private state */ | |
104 | enum work_queue_flags flags; /* user set flag */ | |
105 | }; | |
106 | ||
107 | /* User API */ | |
108 | ||
109 | /* create a new work queue, of given name. | |
110 | * user must fill in the spec of the returned work queue before adding | |
111 | * anything to it | |
112 | */ | |
113 | extern struct work_queue *work_queue_new (struct thread_master *, | |
114 | const char *); | |
115 | /* destroy work queue */ | |
116 | extern void work_queue_free (struct work_queue *); | |
117 | ||
118 | /* Add the supplied data as an item onto the workqueue */ | |
119 | extern void work_queue_add (struct work_queue *, void *); | |
120 | ||
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); | |
125 | ||
126 | /* Helpers, exported for thread.c and command.c */ | |
127 | extern int work_queue_run (struct thread *); | |
128 | extern struct cmd_element show_work_queues_cmd; | |
129 | #endif /* _QUAGGA_WORK_QUEUE_H */ |