xnu-792.24.17.tar.gz

[apple/xnu.git] / osfmk / kern / wait_queue.h

diff --git a/osfmk/kern/wait_queue.h b/osfmk/kern/wait_queue.h
index 40955cb270c574afa75ca786079154456374dab6..6315e9e3a271a9bf271707ca56ed36bd03e2fd0a 100644 (file)
--- a/osfmk/kern/wait_queue.h
+++ b/osfmk/kern/wait_queue.h
@@ -1,44 +1,43 @@
 /*
 /*

- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.

  *
  * @APPLE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_LICENSE_HEADER_START@
  * 

- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
+ * The contents of this file constitute Original Code as defined in and
+ * are subject to the Apple Public Source License Version 1.1 (the
+ * "License").  You may not use this file except in compliance with the
+ * License.  Please obtain a copy of the License at
+ * http://www.apple.com/publicsource and read it before using this file.

  * 
  * 

- * This file contains Original Code and/or Modifications of Original Code
- * as defined in and that are subject to the Apple Public Source License
- * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- * 
- * The Original Code and all software distributed under the License are
- * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * This Original Code and all software distributed under the License are
+ * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- * Please see the License for the specific language governing rights and
- * limitations under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
+ * License for the specific language governing rights and limitations
+ * under the License.

  * 
  * @APPLE_LICENSE_HEADER_END@
  */
  * 
  * @APPLE_LICENSE_HEADER_END@
  */

-#ifndef _KERN_WAIT_QUEUE_H_
-#define _KERN_WAIT_QUEUE_H_

 
 

-#include <sys/appleapiopts.h>
+#ifdef KERNEL_PRIVATE

 
 

-#ifdef __APPLE_API_PRIVATE
+#ifndef _KERN_WAIT_QUEUE_H_
+#define _KERN_WAIT_QUEUE_H_

 
 

+#include <mach/mach_types.h>

 #include <mach/sync_policy.h>
 #include <mach/kern_return.h>          /* for kern_return_t */
 
 #include <kern/kern_types.h>           /* for wait_queue_t */
 
 #include <mach/sync_policy.h>
 #include <mach/kern_return.h>          /* for kern_return_t */
 
 #include <kern/kern_types.h>           /* for wait_queue_t */
 

-#ifdef MACH_KERNEL_PRIVATE
+#include <sys/cdefs.h>
+
+#ifdef MACH_KERNEL_PRIVATE

 
 #include <kern/lock.h>
 #include <kern/queue.h>
 
 #include <kern/lock.h>
 #include <kern/queue.h>

-
+#include <machine/cpu_number.h>

 
 /*
  *     wait_queue_t
 
 /*
  *     wait_queue_t


@@ -172,7 +171,8 @@ __private_extern__ wait_result_t wait_queue_assert_wait64_locked(
                        wait_queue_t wait_queue,
                        event64_t wait_event,
                        wait_interrupt_t interruptible,
                        wait_queue_t wait_queue,
                        event64_t wait_event,
                        wait_interrupt_t interruptible,

-                       boolean_t unlock);
+                       uint64_t deadline,
+                       thread_t thread);

 
 /* peek to see which thread would be chosen for a wakeup - but keep on queue */
 __private_extern__ void wait_queue_peek64_locked(
 
 /* peek to see which thread would be chosen for a wakeup - but keep on queue */
 __private_extern__ void wait_queue_peek64_locked(


@@ -216,11 +216,15 @@ __private_extern__ kern_return_t wait_queue_wakeup64_thread_locked(
                        wait_result_t result,
                        boolean_t unlock);
 
                        wait_result_t result,
                        boolean_t unlock);
 

-#endif /* MACH_KERNEL_PRIVATE */
+#endif /* MACH_KERNEL_PRIVATE */
+
+__BEGIN_DECLS

 
 

-#ifdef __APPLE_API_UNSTABLE

 /******** Semi-Public interfaces (not a part of a higher construct) ************/
 
 /******** Semi-Public interfaces (not a part of a higher construct) ************/
 

+extern unsigned int wait_queue_set_size(void);
+extern unsigned int wait_queue_link_size(void);
+

 extern kern_return_t wait_queue_init(
                        wait_queue_t wait_queue,
                        int policy);
 extern kern_return_t wait_queue_init(
                        wait_queue_t wait_queue,
                        int policy);


@@ -228,6 +232,10 @@ extern kern_return_t wait_queue_init(
 extern wait_queue_set_t wait_queue_set_alloc(
                        int policy);
 
 extern wait_queue_set_t wait_queue_set_alloc(
                        int policy);
 

+extern kern_return_t wait_queue_set_init(
+                       wait_queue_set_t set_queue,
+                       int policy);
+

 extern kern_return_t wait_queue_set_free(
                        wait_queue_set_t set_queue);
 
 extern kern_return_t wait_queue_set_free(
                        wait_queue_set_t set_queue);
 


@@ -237,17 +245,16 @@ extern wait_queue_link_t wait_queue_link_alloc(
 extern kern_return_t wait_queue_link_free(
                        wait_queue_link_t link_element);
 
 extern kern_return_t wait_queue_link_free(
                        wait_queue_link_t link_element);
 

-#endif /* __APPLE_API_UNSTABLE */
-
-#ifdef __APPLE_API_EVOLVING
-
-extern wait_queue_t wait_queue_alloc(
-                       int policy);
+extern kern_return_t wait_queue_link(
+                       wait_queue_t wait_queue,
+                       wait_queue_set_t set_queue);

 
 

-extern kern_return_t wait_queue_free(
-                       wait_queue_t wait_queue);
+extern kern_return_t wait_queue_link_noalloc(
+                       wait_queue_t wait_queue,
+                       wait_queue_set_t set_queue,
+                       wait_queue_link_t link);

 
 

-extern kern_return_t wait_queue_link(
+extern boolean_t wait_queue_member(

                        wait_queue_t wait_queue,
                        wait_queue_set_t set_queue);
 
                        wait_queue_t wait_queue,
                        wait_queue_set_t set_queue);
 


@@ -258,14 +265,35 @@ extern kern_return_t wait_queue_unlink(
 extern kern_return_t wait_queue_unlink_all(
                        wait_queue_t wait_queue);
 
 extern kern_return_t wait_queue_unlink_all(
                        wait_queue_t wait_queue);
 

+extern kern_return_t wait_queue_unlinkall_nofree(
+                       wait_queue_t wait_queue);
+

 extern kern_return_t wait_queue_set_unlink_all(
                        wait_queue_set_t set_queue);
 
 extern kern_return_t wait_queue_set_unlink_all(
                        wait_queue_set_t set_queue);
 

+/* legacy API */
+kern_return_t wait_queue_sub_init(
+                       wait_queue_set_t set_queue,
+                       int policy);
+
+kern_return_t wait_queue_sub_clearrefs(
+                       wait_queue_set_t wq_set);
+
+extern kern_return_t wait_subqueue_unlink_all(
+                       wait_queue_set_t set_queue);
+
+extern wait_queue_t wait_queue_alloc(
+                       int policy);
+
+extern kern_return_t wait_queue_free(
+                       wait_queue_t wait_queue);
+

 /* assert intent to wait on <wait_queue,event64> pair */
 extern wait_result_t wait_queue_assert_wait64(
                        wait_queue_t wait_queue,
                        event64_t wait_event,
 /* assert intent to wait on <wait_queue,event64> pair */
 extern wait_result_t wait_queue_assert_wait64(
                        wait_queue_t wait_queue,
                        event64_t wait_event,

-                       wait_interrupt_t interruptible);
+                       wait_interrupt_t interruptible,
+                       uint64_t deadline);

 
 /* wakeup the most appropriate thread waiting on <wait_queue,event64> pair */
 extern kern_return_t wait_queue_wakeup64_one(
 
 /* wakeup the most appropriate thread waiting on <wait_queue,event64> pair */
 extern kern_return_t wait_queue_wakeup64_one(


@@ -286,8 +314,6 @@ extern kern_return_t wait_queue_wakeup64_thread(
                        thread_t thread,
                        wait_result_t result);
 
                        thread_t thread,
                        wait_result_t result);
 

-#endif  /* __APPLE_API_EVOLVING */
-

 /*
  * Compatibility Wait Queue APIs based on pointer events instead of 64bit
  * integer events.
 /*
  * Compatibility Wait Queue APIs based on pointer events instead of 64bit
  * integer events.


@@ -297,7 +323,8 @@ extern kern_return_t wait_queue_wakeup64_thread(
 extern wait_result_t wait_queue_assert_wait(
                        wait_queue_t wait_queue,
                        event_t wait_event,
 extern wait_result_t wait_queue_assert_wait(
                        wait_queue_t wait_queue,
                        event_t wait_event,

-                       wait_interrupt_t interruptible);
+                       wait_interrupt_t interruptible,
+                       uint64_t deadline);

 
 /* wakeup the most appropriate thread waiting on <wait_queue,event> pair */
 extern kern_return_t wait_queue_wakeup_one(
 
 /* wakeup the most appropriate thread waiting on <wait_queue,event> pair */
 extern kern_return_t wait_queue_wakeup_one(


@@ -318,6 +345,8 @@ extern kern_return_t wait_queue_wakeup_thread(
                        thread_t thread,
                        wait_result_t result);
 
                        thread_t thread,
                        wait_result_t result);
 

-#endif /* __APPLE_API_PRIVATE */
+__END_DECLS
+
+#endif /* _KERN_WAIT_QUEUE_H_ */

 
 

-#endif /* _KERN_WAIT_QUEUE_H_ */
+#endif /* KERNEL_PRIVATE */