osfmk/kern/thread_call.h

   1 /*
   2  * Copyright (c) 1993-1995, 1999-2007 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 thread-based callouts.
  30  */
  31
  32 #ifndef _KERN_THREAD_CALL_H_
  33 #define _KERN_THREAD_CALL_H_
  34
  35 #include <mach/mach_types.h>
  36
  37 #include <kern/clock.h>
  38
  39 #include <sys/cdefs.h>
  40
  41 typedef struct call_entry       *thread_call_t;
  42 typedef void                            *thread_call_param_t;
  43 typedef void                            (*thread_call_func_t)(
  44                                                                         thread_call_param_t             param0,
  45                                                                         thread_call_param_t             param1);
  46 __BEGIN_DECLS
  47
  48 boolean_t
  49 thread_call_enter(
  50         thread_call_t           call
  51 );
  52
  53 boolean_t
  54 thread_call_enter1(
  55         thread_call_t                   call,
  56         thread_call_param_t             param1
  57 );
  58
  59 boolean_t
  60 thread_call_enter_delayed(
  61         thread_call_t           call,
  62         uint64_t                        deadline
  63 );
  64
  65 boolean_t
  66 thread_call_enter1_delayed(
  67         thread_call_t                   call,
  68         thread_call_param_t             param1,
  69         uint64_t                                deadline
  70 );
  71
  72 boolean_t
  73 thread_call_cancel(
  74         thread_call_t           call
  75 );
  76
  77 thread_call_t
  78 thread_call_allocate(
  79         thread_call_func_t              func,
  80         thread_call_param_t             param0
  81 );
  82
  83 boolean_t
  84 thread_call_free(
  85         thread_call_t           call
  86 );
  87
  88 __END_DECLS
  89
  90 #ifdef  MACH_KERNEL_PRIVATE
  91
  92 #include <kern/call_entry.h>
  93
  94 typedef struct call_entry       thread_call_data_t;
  95
  96 void
  97 thread_call_initialize(void);
  98
  99 void
 100 thread_call_setup(
 101         thread_call_t                   call,
 102         thread_call_func_t              func,
 103         thread_call_param_t             param0
 104 );
 105
 106 #endif  /* MACH_KERNEL_PRIVATE */
 107
 108 #ifdef  KERNEL_PRIVATE
 109
 110 __BEGIN_DECLS
 111
 112 /*
 113  * Obsolete interfaces.
 114  */
 115
 116 boolean_t
 117 thread_call_is_delayed(
 118         thread_call_t           call,
 119         uint64_t                        *deadline
 120 );
 121
 122 void
 123 thread_call_func(
 124         thread_call_func_t              func,
 125         thread_call_param_t             param,
 126         boolean_t                               unique_call
 127 );
 128
 129 void
 130 thread_call_func_delayed(
 131         thread_call_func_t              func,
 132         thread_call_param_t             param,
 133         uint64_t                                deadline
 134 );
 135
 136 boolean_t
 137 thread_call_func_cancel(
 138         thread_call_func_t              func,
 139         thread_call_param_t             param,
 140         boolean_t                               cancel_all
 141 );
 142
 143 #ifndef MACH_KERNEL_PRIVATE
 144
 145 #ifndef ABSOLUTETIME_SCALAR_TYPE
 146
 147 #define thread_call_enter_delayed(a, b) \
 148         thread_call_enter_delayed((a), __OSAbsoluteTime(b))
 149
 150 #define thread_call_enter1_delayed(a, b, c)     \
 151         thread_call_enter1_delayed((a), (b), __OSAbsoluteTime(c))
 152
 153 #define thread_call_is_delayed(a, b)    \
 154         thread_call_is_delayed((a), __OSAbsoluteTimePtr(b))
 155
 156 #define thread_call_func_delayed(a, b, c)       \
 157         thread_call_func_delayed((a), (b), __OSAbsoluteTime(c))
 158
 159 #endif  /* ABSOLUTETIME_SCALAR_TYPE */
 160
 161 #endif  /* MACH_KERNEL_PRIVATE */
 162
 163 __END_DECLS
 164
 165 #endif  /* KERNEL_PRIVATE */
 166
 167 #endif  /* _KERN_THREAD_CALL_H_ */