osfmk/kern/timer_queue.h

   1 /*
   2  * Copyright (c) 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  * Timer queue support routines.
  30  */
  31
  32 #ifndef _KERN_TIMER_QUEUE_H_
  33 #define _KERN_TIMER_QUEUE_H_
  34
  35 #include <mach/mach_types.h>
  36
  37 #ifdef MACH_KERNEL_PRIVATE
  38
  39 #include <kern/queue.h>
  40
  41 /*
  42  *      Invoked by kernel, implemented by platform.
  43  */
  44
  45 /* Request an expiration deadline, returns queue association */
  46 extern mpqueue_head_t *timer_queue_assign(
  47                                 uint64_t                deadline);
  48
  49 extern uint64_t         timer_call_slop(
  50                                                 uint64_t                deadline);
  51
  52 /* Cancel an associated expiration deadline and specify new deadline */
  53 extern void             timer_queue_cancel(
  54                                 mpqueue_head_t          *queue,
  55                                 uint64_t                deadline,
  56                                 uint64_t                new_deadline);
  57
  58 /*
  59  *      Invoked by platform, implemented by kernel.
  60  */
  61
  62 /* Process deadline expiration for queue, returns new deadline */
  63 extern uint64_t         timer_queue_expire(
  64                                 mpqueue_head_t          *queue,
  65                                 uint64_t                deadline);
  66
  67 /* Shutdown a timer queue and reassign existing activities */
  68 extern void             timer_queue_shutdown(
  69                                 mpqueue_head_t          *queue);
  70
  71 /* Move timer requests from one queue to another */
  72 extern int              timer_queue_migrate(
  73                                 mpqueue_head_t          *from,
  74                                 mpqueue_head_t          *to);
  75
  76 #endif  /* MACH_KERNEL_PRIVATE */
  77
  78 #endif  /* _KERN_TIMER_QUEUE_H_ */