sys/sys/_task.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2000 Doug Rabson
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _SYS__TASK_H_
  32 #define _SYS__TASK_H_
  33
  34 #include <sys/queue.h>
  35
  36 /*
  37  * Each task includes a function which is called from
  38  * taskqueue_run().  The first argument is taken from the 'ta_context'
  39  * field of struct task and the second argument is a count of how many
  40  * times the task was enqueued before the call to taskqueue_run().
  41  *
  42  * List of locks
  43  * (c)  const after init
  44  * (q)  taskqueue lock
  45  */
  46 typedef void task_fn_t(void *context, int pending);
  47
  48 struct task {
  49         STAILQ_ENTRY(task) ta_link;     /* (q) link for queue */
  50         uint16_t ta_pending;            /* (q) count times queued */
  51         uint8_t ta_priority;            /* (c) Priority */
  52         uint8_t ta_flags;               /* (c) Flags */
  53         task_fn_t *ta_func;             /* (c) task handler */
  54         void    *ta_context;            /* (c) argument for handler */
  55 };
  56
  57 #define TASK_ENQUEUED           0x1
  58 #define TASK_NOENQUEUE          0x2
  59 #define TASK_NETWORK            0x4
  60
  61 #define TASK_IS_NET(ta)         ((ta)->ta_flags & TASK_NETWORK)
  62
  63 #ifdef _KERNEL
  64
  65 typedef void gtask_fn_t(void *context);
  66
  67 struct gtask {
  68         STAILQ_ENTRY(gtask) ta_link;    /* (q) link for queue */
  69         uint16_t ta_flags;              /* (q) state flags */
  70         u_short ta_priority;            /* (c) Priority */
  71         gtask_fn_t *ta_func;            /* (c) task handler */
  72         void    *ta_context;            /* (c) argument for handler */
  73 };
  74
  75 #endif /* _KERNEL */
  76
  77 #endif /* !_SYS__TASK_H_ */