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