paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 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 | /* Work queue default hold and cycle times - millisec */ |
paul | 190880d | 2005-11-14 12:07:47 +0000 | [diff] [blame^] | 28 | #define WORK_QUEUE_DEFAULT_HOLD 50 /* hold-time between runs of a queue */ |
| 29 | #define WORK_QUEUE_DEFAULT_DELAY 10 /* minimum delay for queue runs */ |
| 30 | #define WORK_QUEUE_DEFAULT_FLOOD 40 /* flood factor, ~2s with prev values */ |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 31 | |
| 32 | /* action value, for use by item processor and item error handlers */ |
| 33 | typedef enum |
| 34 | { |
| 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 */ |
paul | 269d74f | 2005-05-23 13:42:46 +0000 | [diff] [blame] | 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.. */ |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 43 | } wq_item_status; |
| 44 | |
| 45 | /* A single work queue item, unsurprisingly */ |
| 46 | struct work_queue_item |
| 47 | { |
| 48 | void *data; /* opaque data */ |
paul | 8436968 | 2005-04-27 12:39:27 +0000 | [diff] [blame] | 49 | unsigned short ran; /* # of times item has been run */ |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 50 | }; |
| 51 | |
paul | 269d74f | 2005-05-23 13:42:46 +0000 | [diff] [blame] | 52 | enum work_queue_flags |
| 53 | { |
| 54 | WQ_UNPLUGGED = 0, |
| 55 | WQ_PLUGGED = 1, |
| 56 | }; |
| 57 | |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 58 | struct work_queue |
| 59 | { |
paul | 190880d | 2005-11-14 12:07:47 +0000 | [diff] [blame^] | 60 | /* Everything but the specification struct is private */ |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 61 | struct thread_master *master; /* thread master */ |
| 62 | struct thread *thread; /* thread, if one is active */ |
| 63 | char *name; /* work queue name */ |
paul | 190880d | 2005-11-14 12:07:47 +0000 | [diff] [blame^] | 64 | char status; /* status */ |
| 65 | #define WQ_STATE_FLOODED (1 << 0) |
paul | 269d74f | 2005-05-23 13:42:46 +0000 | [diff] [blame] | 66 | enum work_queue_flags flags; /* flags */ |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 67 | |
paul | 190880d | 2005-11-14 12:07:47 +0000 | [diff] [blame^] | 68 | /* Specification for this work queue. |
| 69 | * Public, must be set before use by caller. May be modified at will. |
| 70 | */ |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 71 | struct { |
| 72 | /* work function to process items with */ |
paul | 8cc4198 | 2005-05-06 21:25:49 +0000 | [diff] [blame] | 73 | wq_item_status (*workfunc) (void *); |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 74 | |
| 75 | /* error handling function, optional */ |
| 76 | void (*errorfunc) (struct work_queue *, struct work_queue_item *); |
| 77 | |
| 78 | /* callback to delete user specific item data */ |
paul | 8cc4198 | 2005-05-06 21:25:49 +0000 | [diff] [blame] | 79 | void (*del_item_data) (void *); |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 80 | |
paul | 269d74f | 2005-05-23 13:42:46 +0000 | [diff] [blame] | 81 | /* completion callback, called when queue is emptied, optional */ |
| 82 | void (*completion_func) (struct work_queue *); |
| 83 | |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 84 | /* max number of retries to make for item that errors */ |
| 85 | unsigned int max_retries; |
| 86 | |
| 87 | unsigned int hold; /* hold time for first run, in ms */ |
| 88 | unsigned int delay; /* min delay between queue runs, in ms */ |
paul | 190880d | 2005-11-14 12:07:47 +0000 | [diff] [blame^] | 89 | |
| 90 | unsigned int flood; /* number of queue runs after which we consider |
| 91 | * queue to be flooded, where the runs are |
| 92 | * consecutive and each has used its full slot, |
| 93 | * and the queue has still not been cleared. If |
| 94 | * the queue is flooded, then we try harder to |
| 95 | * clear it by ignoring the hold and delay |
| 96 | * times. No point sparing CPU resources just |
| 97 | * to use ever more memory resources. |
| 98 | */ |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 99 | } spec; |
| 100 | |
| 101 | /* remaining fields should be opaque to users */ |
| 102 | struct list *items; /* queue item list */ |
paul | 269d74f | 2005-05-23 13:42:46 +0000 | [diff] [blame] | 103 | unsigned long runs; /* runs count */ |
paul | 190880d | 2005-11-14 12:07:47 +0000 | [diff] [blame^] | 104 | unsigned int runs_since_clear; /* number of runs since queue was |
| 105 | * last cleared |
| 106 | */ |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 107 | |
| 108 | struct { |
| 109 | unsigned int best; |
| 110 | unsigned int granularity; |
| 111 | unsigned long total; |
| 112 | } cycles; /* cycle counts */ |
| 113 | }; |
| 114 | |
| 115 | /* User API */ |
paul | 269d74f | 2005-05-23 13:42:46 +0000 | [diff] [blame] | 116 | |
| 117 | /* create a new work queue, of given name. |
| 118 | * user must fill in the spec of the returned work queue before adding |
| 119 | * anything to it |
| 120 | */ |
paul | 8cc4198 | 2005-05-06 21:25:49 +0000 | [diff] [blame] | 121 | extern struct work_queue *work_queue_new (struct thread_master *, |
| 122 | const char *); |
paul | 269d74f | 2005-05-23 13:42:46 +0000 | [diff] [blame] | 123 | /* destroy work queue */ |
paul | 8cc4198 | 2005-05-06 21:25:49 +0000 | [diff] [blame] | 124 | extern void work_queue_free (struct work_queue *); |
paul | 269d74f | 2005-05-23 13:42:46 +0000 | [diff] [blame] | 125 | |
| 126 | /* Add the supplied data as an item onto the workqueue */ |
paul | 8cc4198 | 2005-05-06 21:25:49 +0000 | [diff] [blame] | 127 | extern void work_queue_add (struct work_queue *, void *); |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 128 | |
paul | 269d74f | 2005-05-23 13:42:46 +0000 | [diff] [blame] | 129 | /* plug the queue, ie prevent it from being drained / processed */ |
| 130 | extern void work_queue_plug (struct work_queue *wq); |
| 131 | /* unplug the queue, allow it to be drained again */ |
| 132 | extern void work_queue_unplug (struct work_queue *wq); |
| 133 | |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 134 | /* Helpers, exported for thread.c and command.c */ |
paul | 8cc4198 | 2005-05-06 21:25:49 +0000 | [diff] [blame] | 135 | extern int work_queue_run (struct thread *); |
paul | 354d119 | 2005-04-25 16:26:42 +0000 | [diff] [blame] | 136 | extern struct cmd_element show_work_queues_cmd; |
| 137 | #endif /* _QUAGGA_WORK_QUEUE_H */ |