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         queue_chain_init((entry)->q_link);                      \
  68 MACRO_END
  69
  70 #define qe(x)           ((queue_entry_t)(x))
  71 #define CE(x)           ((call_entry_t)(x))
  72
  73 static __inline__ queue_head_t *
  74 call_entry_enqueue_tail(
  75         call_entry_t            entry,
  76         queue_t                 queue)
  77 {
  78         queue_t                 old_queue = entry->queue;
  79
  80         if (old_queue != NULL)
  81                 (void)remque(qe(entry));
  82
  83         enqueue_tail(queue, qe(entry));
  84
  85         entry->queue = queue;
  86
  87         return (old_queue);
  88 }
  89
  90 static __inline__ queue_head_t *
  91 call_entry_dequeue(
  92         call_entry_t            entry)
  93 {
  94         queue_t                 old_queue = entry->queue;
  95
  96         if (old_queue != NULL) {
  97                 (void)remque(qe(entry));
  98
  99                 entry->queue = NULL;
 100         }
 101         return (old_queue);
 102 }
 103
 104 static __inline__ queue_head_t *
 105 call_entry_enqueue_deadline(
 106         call_entry_t                    entry,
 107         queue_head_t                    *queue,
 108         uint64_t                        deadline)
 109 {
 110         queue_t         old_queue = entry->queue;
 111         call_entry_t    current;
 112
 113         if (old_queue != queue || entry->deadline < deadline) {
 114                 if (old_queue == NULL) {
 115                         current = CE(queue_first(queue));
 116                 } else if (old_queue != queue) {
 117                         (void)remque(qe(entry));
 118                         current = CE(queue_first(queue));
 119                 } else {
 120                         current = CE(queue_next(qe(entry)));
 121                         (void)remque(qe(entry));
 122                 }
 123
 124                 while (TRUE) {
 125                         if (queue_end(queue, qe(current)) ||
 126                             deadline < current->deadline) {
 127                                 current = CE(queue_prev(qe(current)));
 128                                 break;
 129                         }
 130
 131                         current = CE(queue_next(qe(current)));
 132                 }
 133                 insque(qe(entry), qe(current));
 134         }
 135         else if (deadline < entry->deadline) {
 136                 current = CE(queue_prev(qe(entry)));
 137
 138                 (void)remque(qe(entry));
 139
 140                 while (TRUE) {
 141                         if (queue_end(queue, qe(current)) ||
 142                             current->deadline <= deadline) {
 143                                 break;
 144                         }
 145
 146                         current = CE(queue_prev(qe(current)));
 147                 }
 148                 insque(qe(entry), qe(current));
 149         }
 150         entry->queue = queue;
 151         entry->deadline = deadline;
 152
 153         return (old_queue);
 154 }
 155 #endif /* MACH_KERNEL_PRIVATE */
 156
 157 #endif /* XNU_KERNEL_PRIVATE */
 158
 159 #endif /* _KERN_CALL_ENTRY_H_ */