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 XNU_KERNEL_PRIVATE
  36 #include <kern/queue.h>
  37
  38 #define TIMER_TRACE     1
  39
  40 typedef void            *call_entry_param_t;
  41 typedef void            (*call_entry_func_t)(
  42                                 call_entry_param_t      param0,
  43                                 call_entry_param_t      param1);
  44
  45 typedef struct call_entry {
  46     queue_chain_t       q_link;
  47     queue_head_t        *queue;
  48     call_entry_func_t   func;
  49     call_entry_param_t  param0;
  50     call_entry_param_t  param1;
  51     uint64_t            deadline;
  52 #if TIMER_TRACE
  53     uint64_t            entry_time;
  54 #endif
  55 } call_entry_data_t;
  56
  57 typedef struct call_entry       *call_entry_t;
  58
  59 #ifdef MACH_KERNEL_PRIVATE
  60
  61 #define call_entry_setup(entry, pfun, p0)                       \
  62 MACRO_BEGIN                                                     \
  63         (entry)->func           = (call_entry_func_t)(pfun);    \
  64         (entry)->param0         = (call_entry_param_t)(p0);     \
  65         (entry)->queue          = NULL;                         \
  66         (entry)->deadline       = 0;                            \
  67 MACRO_END
  68
  69 #define qe(x)           ((queue_entry_t)(x))
  70 #define CE(x)           ((call_entry_t)(x))
  71
  72 static __inline__ queue_head_t *
  73 call_entry_enqueue_tail(
  74         call_entry_t            entry,
  75         queue_t                 queue)
  76 {
  77         queue_t                 old_queue = entry->queue;
  78
  79         if (old_queue != NULL)
  80                 (void)remque(qe(entry));
  81
  82         enqueue_tail(queue, qe(entry));
  83
  84         entry->queue = queue;
  85
  86         return (old_queue);
  87 }
  88
  89 static __inline__ queue_head_t *
  90 call_entry_dequeue(
  91         call_entry_t            entry)
  92 {
  93         queue_t                 old_queue = entry->queue;
  94
  95         if (old_queue != NULL) {
  96                 (void)remque(qe(entry));
  97
  98                 entry->queue = NULL;
  99         }
 100         return (old_queue);
 101 }
 102
 103 static __inline__ queue_head_t *
 104 call_entry_enqueue_deadline(
 105         call_entry_t                    entry,
 106         queue_head_t                    *queue,
 107         uint64_t                        deadline)
 108 {
 109         queue_t         old_queue = entry->queue;
 110         call_entry_t    current;
 111
 112         if (old_queue != queue || entry->deadline < deadline) {
 113                 if (old_queue == NULL) {
 114                         current = CE(queue_first(queue));
 115                 } else if (old_queue != queue) {
 116                         (void)remque(qe(entry));
 117                         current = CE(queue_first(queue));
 118                 } else {
 119                         current = CE(queue_next(qe(entry)));
 120                         (void)remque(qe(entry));
 121                 }
 122
 123                 while (TRUE) {
 124                         if (queue_end(queue, qe(current)) ||
 125                             deadline < current->deadline) {
 126                                 current = CE(queue_prev(qe(current)));
 127                                 break;
 128                         }
 129
 130                         current = CE(queue_next(qe(current)));
 131                 }
 132                 insque(qe(entry), qe(current));
 133         }
 134         else if (deadline < entry->deadline) {
 135                 current = CE(queue_prev(qe(entry)));
 136
 137                 (void)remque(qe(entry));
 138
 139                 while (TRUE) {
 140                         if (queue_end(queue, qe(current)) ||
 141                             current->deadline <= deadline) {
 142                                 break;
 143                         }
 144
 145                         current = CE(queue_prev(qe(current)));
 146                 }
 147                 insque(qe(entry), qe(current));
 148         }
 149         entry->queue = queue;
 150         entry->deadline = deadline;
 151
 152         return (old_queue);
 153 }
 154 #endif /* MACH_KERNEL_PRIVATE */
 155
 156 #endif /* XNU_KERNEL_PRIVATE */
 157
 158 #endif /* _KERN_CALL_ENTRY_H_ */