mirror of
https://git.proxmox.com/git/mirror_frr
synced 2025-11-04 13:30:17 +00:00
6878453548
2006-03-25 Paul Jakma <paul.jakma@sun.com> * workqueue.h: (struct work_queue) Remove status field and state flag, no longer used.
130 lines
4.2 KiB
C
130 lines
4.2 KiB
C
/*
|
|
* Quagga Work Queues.
|
|
*
|
|
* Copyright (C) 2005 Sun Microsystems, Inc.
|
|
*
|
|
* This file is part of Quagga.
|
|
*
|
|
* Quagga is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation; either version 2, or (at your option) any
|
|
* later version.
|
|
*
|
|
* Quagga is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Quagga; see the file COPYING. If not, write to the Free
|
|
* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
* 02111-1307, USA.
|
|
*/
|
|
|
|
#ifndef _QUAGGA_WORK_QUEUE_H
|
|
#define _QUAGGA_WORK_QUEUE_H
|
|
|
|
/* Hold time for the initial schedule of a queue run, in millisec */
|
|
#define WORK_QUEUE_DEFAULT_HOLD 50
|
|
|
|
/* action value, for use by item processor and item error handlers */
|
|
typedef enum
|
|
{
|
|
WQ_SUCCESS = 0,
|
|
WQ_ERROR, /* Error, run error handler if provided */
|
|
WQ_RETRY_NOW, /* retry immediately */
|
|
WQ_RETRY_LATER, /* retry later, cease processing work queue */
|
|
WQ_REQUEUE, /* requeue item, continue processing work queue */
|
|
WQ_QUEUE_BLOCKED, /* Queue cant be processed at this time.
|
|
* Similar to WQ_RETRY_LATER, but doesn't penalise
|
|
* the particular item.. */
|
|
} wq_item_status;
|
|
|
|
/* A single work queue item, unsurprisingly */
|
|
struct work_queue_item
|
|
{
|
|
void *data; /* opaque data */
|
|
unsigned short ran; /* # of times item has been run */
|
|
};
|
|
|
|
enum work_queue_flags
|
|
{
|
|
WQ_UNPLUGGED = 0,
|
|
WQ_PLUGGED = 1,
|
|
};
|
|
|
|
struct work_queue
|
|
{
|
|
/* Everything but the specification struct is private
|
|
* the following may be read
|
|
*/
|
|
struct thread_master *master; /* thread master */
|
|
struct thread *thread; /* thread, if one is active */
|
|
char *name; /* work queue name */
|
|
|
|
/* Specification for this work queue.
|
|
* Public, must be set before use by caller. May be modified at will.
|
|
*/
|
|
struct {
|
|
/* optional opaque user data, global to the queue. */
|
|
void *data;
|
|
|
|
/* work function to process items with:
|
|
* First argument is the workqueue queue.
|
|
* Second argument is the item data
|
|
*/
|
|
wq_item_status (*workfunc) (struct work_queue *, void *);
|
|
|
|
/* error handling function, optional */
|
|
void (*errorfunc) (struct work_queue *, struct work_queue_item *);
|
|
|
|
/* callback to delete user specific item data */
|
|
void (*del_item_data) (struct work_queue *, void *);
|
|
|
|
/* completion callback, called when queue is emptied, optional */
|
|
void (*completion_func) (struct work_queue *);
|
|
|
|
/* max number of retries to make for item that errors */
|
|
unsigned int max_retries;
|
|
|
|
unsigned int hold; /* hold time for first run, in ms */
|
|
} spec;
|
|
|
|
/* remaining fields should be opaque to users */
|
|
struct list *items; /* queue item list */
|
|
unsigned long runs; /* runs count */
|
|
|
|
struct {
|
|
unsigned int best;
|
|
unsigned int granularity;
|
|
unsigned long total;
|
|
} cycles; /* cycle counts */
|
|
|
|
/* private state */
|
|
enum work_queue_flags flags; /* user set flag */
|
|
};
|
|
|
|
/* User API */
|
|
|
|
/* create a new work queue, of given name.
|
|
* user must fill in the spec of the returned work queue before adding
|
|
* anything to it
|
|
*/
|
|
extern struct work_queue *work_queue_new (struct thread_master *,
|
|
const char *);
|
|
/* destroy work queue */
|
|
extern void work_queue_free (struct work_queue *);
|
|
|
|
/* Add the supplied data as an item onto the workqueue */
|
|
extern void work_queue_add (struct work_queue *, void *);
|
|
|
|
/* plug the queue, ie prevent it from being drained / processed */
|
|
extern void work_queue_plug (struct work_queue *wq);
|
|
/* unplug the queue, allow it to be drained again */
|
|
extern void work_queue_unplug (struct work_queue *wq);
|
|
|
|
/* Helpers, exported for thread.c and command.c */
|
|
extern int work_queue_run (struct thread *);
|
|
extern struct cmd_element show_work_queues_cmd;
|
|
#endif /* _QUAGGA_WORK_QUEUE_H */
|