osfmk/kern/call_entry.h

   1 /*
   2  * Copyright (c) 1993-1995, 1999-2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Declarations for generic call outs.
  30  */
  31
  32 #ifndef _KERN_CALL_ENTRY_H_
  33 #define _KERN_CALL_ENTRY_H_
  34
  35 #ifdef MACH_KERNEL_PRIVATE
  36 #include <kern/queue.h>
  37
  38 typedef void            *call_entry_param_t;
  39 typedef void            (*call_entry_func_t)(
  40                                 call_entry_param_t      param0,
  41                                 call_entry_param_t      param1);
  42
  43 typedef struct call_entry {
  44     queue_chain_t       q_link;
  45     queue_head_t        *queue;
  46     call_entry_func_t   func;
  47     call_entry_param_t  param0;
  48     call_entry_param_t  param1;
  49     uint64_t            deadline;
  50 } call_entry_data_t;
  51
  52 typedef struct call_entry       *call_entry_t;
  53
  54
  55 #define call_entry_setup(entry, pfun, p0)                       \
  56 MACRO_BEGIN                                                     \
  57         (entry)->func           = (call_entry_func_t)(pfun);    \
  58         (entry)->param0         = (call_entry_param_t)(p0);     \
  59         (entry)->queue          = NULL;                         \
  60 MACRO_END
  61
  62 #define qe(x)           ((queue_entry_t)(x))
  63 #define CE(x)           ((call_entry_t)(x))
  64
  65 static __inline__ queue_head_t *
  66 call_entry_enqueue_tail(
  67         call_entry_t            entry,
  68         queue_t                 queue)
  69 {
  70         queue_t                 old_queue = entry->queue;
  71
  72         if (old_queue != NULL)
  73                 (void)remque(qe(entry));
  74
  75         enqueue_tail(queue, qe(entry));
  76
  77         entry->queue = queue;
  78
  79         return (old_queue);
  80 }
  81
  82 static __inline__ queue_head_t *
  83 call_entry_dequeue(
  84         call_entry_t            entry)
  85 {
  86         queue_t                 old_queue = entry->queue;
  87
  88         if (old_queue != NULL) {
  89                 (void)remque(qe(entry));
  90
  91                 entry->queue = NULL;
  92         }
  93         return (old_queue);
  94 }
  95
  96 static __inline__ queue_head_t *
  97 call_entry_enqueue_deadline(
  98         call_entry_t                    entry,
  99         queue_head_t                    *queue,
 100         uint64_t                        deadline)
 101 {
 102         queue_t         old_queue = entry->queue;
 103         call_entry_t    current;
 104
 105         if (old_queue != queue || entry->deadline < deadline) {
 106                 if (old_queue == NULL) {
 107                         current = CE(queue_first(queue));
 108                 } else if (old_queue != queue) {
 109                         (void)remque(qe(entry));
 110                         current = CE(queue_first(queue));
 111                 } else {
 112                         current = CE(queue_next(qe(entry)));
 113                         (void)remque(qe(entry));
 114                 }
 115
 116                 while (TRUE) {
 117                         if (queue_end(queue, qe(current)) ||
 118                             deadline < current->deadline) {
 119                                 current = CE(queue_prev(qe(current)));
 120                                 break;
 121                         }
 122
 123                         current = CE(queue_next(qe(current)));
 124                 }
 125                 insque(qe(entry), qe(current));
 126         }
 127         else
 128         if (deadline < entry->deadline) {
 129                 current = CE(queue_prev(qe(entry)));
 130
 131                 (void)remque(qe(entry));
 132
 133                 while (TRUE) {
 134                         if (queue_end(queue, qe(current)) ||
 135                             current->deadline <= deadline) {
 136                                 break;
 137                         }
 138
 139                         current = CE(queue_prev(qe(current)));
 140                 }
 141                 insque(qe(entry), qe(current));
 142         }
 143         entry->queue = queue;
 144         entry->deadline = deadline;
 145
 146         return (old_queue);
 147 }
 148 #endif /* MACH_KERNEL_PRIVATE */
 149
 150 #endif /* _KERN_CALL_ENTRY_H_ */