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_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 extern queue_t          call_entry_enqueue_deadline(
  55                                                         call_entry_t            entry,
  56                                                         queue_t                         queue,
  57                                                         uint64_t                        deadline);
  58
  59 extern queue_t          call_entry_enqueue_tail(
  60                                                         call_entry_t    entry,
  61                                                         queue_t                 queue);
  62
  63 extern queue_t          call_entry_dequeue(
  64                                                         call_entry_t    entry);
  65
  66 #define call_entry_setup(entry, pfun, p0)                               \
  67 MACRO_BEGIN                                                                                             \
  68         (entry)->func           = (call_entry_func_t)(pfun);    \
  69         (entry)->param0         = (call_entry_param_t)(p0);             \
  70         (entry)->queue          = NULL;                                                 \
  71 MACRO_END
  72
  73 #endif /* MACH_KERNEL_PRIVATE */
  74
  75 #endif /* _KERN_CALL_ENTRY_H_ */