xnu-3247.1.106.tar.gz

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

diff --git a/osfmk/kern/locks.h b/osfmk/kern/locks.h
index e5e11691b16d0cd470478cf456a78bc1145ccebd..c8768fe6d707818af86574c60f51f68212626d53 100644 (file)
--- a/osfmk/kern/locks.h
+++ b/osfmk/kern/locks.h
@@ -1,5 +1,5 @@
 /*
 /*

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

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -46,7 +46,7 @@ typedef       unsigned int    lck_type_t;
 
 #define        LCK_TYPE_SPIN   1
 #define        LCK_TYPE_MTX    2
 
 #define        LCK_TYPE_SPIN   1
 #define        LCK_TYPE_MTX    2

-#define        LCK_TYPE_RW             3
+#define        LCK_TYPE_RW     3

 
 #endif
 
 
 #endif
 


@@ -57,8 +57,10 @@ typedef      unsigned int            lck_sleep_action_t;
 #define        LCK_SLEEP_UNLOCK        0x01    /* Release the lock and return unheld */
 #define        LCK_SLEEP_SHARED        0x02    /* Reclaim the lock in shared mode (RW only) */
 #define        LCK_SLEEP_EXCLUSIVE     0x04    /* Reclaim the lock in exclusive mode (RW only) */
 #define        LCK_SLEEP_UNLOCK        0x01    /* Release the lock and return unheld */
 #define        LCK_SLEEP_SHARED        0x02    /* Reclaim the lock in shared mode (RW only) */
 #define        LCK_SLEEP_EXCLUSIVE     0x04    /* Reclaim the lock in exclusive mode (RW only) */

+#define        LCK_SLEEP_SPIN          0x08    /* Reclaim the lock in spin mode (mutex only) */
+#define        LCK_SLEEP_PROMOTED_PRI  0x10    /* Sleep at a promoted priority */

 
 

-#define        LCK_SLEEP_MASK          0x07    /* Valid actions */
+#define        LCK_SLEEP_MASK          0x1f    /* Valid actions */

 
 #ifdef MACH_KERNEL_PRIVATE
 
 
 #ifdef MACH_KERNEL_PRIVATE
 


@@ -72,9 +74,11 @@ typedef struct {
 
 typedef struct {
        uint64_t                        lck_grp_mtx_util_cnt;
 
 typedef struct {
        uint64_t                        lck_grp_mtx_util_cnt;

+       /* On x86, this is used as the "direct wait" count */

        uint64_t                        lck_grp_mtx_held_cnt;
        uint64_t                        lck_grp_mtx_miss_cnt;
        uint64_t                        lck_grp_mtx_wait_cnt;
        uint64_t                        lck_grp_mtx_held_cnt;
        uint64_t                        lck_grp_mtx_miss_cnt;
        uint64_t                        lck_grp_mtx_wait_cnt;

+       /* Rest currently unused */

        uint64_t                        lck_grp_mtx_held_max;
        uint64_t                        lck_grp_mtx_held_cum;
        uint64_t                        lck_grp_mtx_wait_max;
        uint64_t                        lck_grp_mtx_held_max;
        uint64_t                        lck_grp_mtx_held_cum;
        uint64_t                        lck_grp_mtx_wait_max;


@@ -102,12 +106,12 @@ typedef   struct _lck_grp_stat_ {
 
 typedef        struct _lck_grp_ {
        queue_chain_t           lck_grp_link;
 
 typedef        struct _lck_grp_ {
        queue_chain_t           lck_grp_link;

-       unsigned int            lck_grp_refcnt;
-       unsigned int            lck_grp_spincnt;
-       unsigned int            lck_grp_mtxcnt;
-       unsigned int            lck_grp_rwcnt;
-       unsigned int            lck_grp_attr;
-       char                            lck_grp_name[LCK_GRP_MAX_NAME];
+       uint32_t                lck_grp_refcnt;
+       uint32_t                lck_grp_spincnt;
+       uint32_t                lck_grp_mtxcnt;
+       uint32_t                lck_grp_rwcnt;
+       uint32_t                lck_grp_attr;
+       char                    lck_grp_name[LCK_GRP_MAX_NAME];

        lck_grp_stat_t          lck_grp_stat;
 } lck_grp_t;
 
        lck_grp_stat_t          lck_grp_stat;
 } lck_grp_t;
 


@@ -119,7 +123,7 @@ typedef struct __lck_grp__ lck_grp_t;
 
 #ifdef MACH_KERNEL_PRIVATE
 typedef        struct _lck_grp_attr_ {
 
 #ifdef MACH_KERNEL_PRIVATE
 typedef        struct _lck_grp_attr_ {

-       unsigned int    grp_attr_val;
+       uint32_t        grp_attr_val;

 } lck_grp_attr_t;
 
 extern lck_grp_attr_t  LockDefaultGroupAttr;
 } lck_grp_attr_t;
 
 extern lck_grp_attr_t  LockDefaultGroupAttr;


@@ -187,8 +191,10 @@ typedef    struct _lck_attr_ {
 
 extern lck_attr_t      LockDefaultLckAttr;
 
 
 extern lck_attr_t      LockDefaultLckAttr;
 

-#define        LCK_ATTR_NONE           0
-#define        LCK_ATTR_DEBUG  0x1
+#define LCK_ATTR_NONE          0
+
+#define        LCK_ATTR_DEBUG                          0x00000001
+#define        LCK_ATTR_RW_SHARED_PRIORITY     0x00010000

 
 #else
 typedef struct __lck_attr__ lck_attr_t;
 
 #else
 typedef struct __lck_attr__ lck_attr_t;


@@ -207,6 +213,14 @@ extern     void                    lck_attr_setdefault(
 extern void                    lck_attr_setdebug(
                                                                        lck_attr_t              *attr);
 
 extern void                    lck_attr_setdebug(
                                                                        lck_attr_t              *attr);
 

+extern void                    lck_attr_cleardebug(
+                                                                       lck_attr_t              *attr);
+
+#ifdef XNU_KERNEL_PRIVATE
+extern void                    lck_attr_rw_shared_priority(
+                                                                       lck_attr_t              *attr);
+#endif
+

 extern void                    lck_attr_free(
                                                                        lck_attr_t              *attr);
 
 extern void                    lck_attr_free(
                                                                        lck_attr_t              *attr);
 


@@ -250,8 +264,14 @@ extern wait_result_t       lck_spin_sleep_deadline(
 
 #ifdef KERNEL_PRIVATE
 
 
 #ifdef KERNEL_PRIVATE
 

-extern boolean_t               lck_spin_try_lock(
-                                                                       lck_spin_t              *lck);
+extern boolean_t               lck_spin_try_lock(                      lck_spin_t              *lck);
+
+/* NOT SAFE: To be used only by kernel debugger to avoid deadlock. */
+extern boolean_t               kdp_lck_spin_is_acquired(               lck_spin_t              *lck);
+
+struct _lck_mtx_ext_;
+extern void lck_mtx_init_ext(lck_mtx_t *lck, struct _lck_mtx_ext_ *lck_ext,
+    lck_grp_t *grp, lck_attr_t *attr);

 
 #endif
 
 
 #endif
 


@@ -266,7 +286,6 @@ extern void                         lck_mtx_init(
                                                                        lck_mtx_t               *lck, 
                                                                        lck_grp_t               *grp,
                                                                        lck_attr_t              *attr);
                                                                        lck_mtx_t               *lck, 
                                                                        lck_grp_t               *grp,
                                                                        lck_attr_t              *attr);

-

 extern void                            lck_mtx_lock(
                                                                        lck_mtx_t               *lck);
 
 extern void                            lck_mtx_lock(
                                                                        lck_mtx_t               *lck);
 


@@ -299,6 +318,44 @@ extern wait_result_t       lck_mtx_sleep_deadline(
 extern boolean_t               lck_mtx_try_lock(
                                                                        lck_mtx_t               *lck);
 
 extern boolean_t               lck_mtx_try_lock(
                                                                        lck_mtx_t               *lck);
 

+extern void                            mutex_pause(uint32_t);
+
+extern void                    lck_mtx_yield (
+                                                                       lck_mtx_t               *lck);
+
+#if defined(__i386__) || defined(__x86_64__)
+extern boolean_t               lck_mtx_try_lock_spin(
+                                                                       lck_mtx_t               *lck);
+
+extern boolean_t               lck_mtx_try_lock_spin_always(
+                                                                       lck_mtx_t               *lck);
+
+extern void                    lck_mtx_lock_spin_always(
+                                                                       lck_mtx_t               *lck);
+
+extern void                    lck_mtx_lock_spin(
+                                                                       lck_mtx_t               *lck);
+
+extern void                    lck_mtx_convert_spin(
+                                                                       lck_mtx_t               *lck);
+
+extern boolean_t               kdp_lck_mtx_lock_spin_is_acquired(
+                                                                       lck_mtx_t               *lck);
+#define lck_mtx_unlock_always(l)       lck_mtx_unlock(l)
+
+#else
+#define lck_mtx_try_lock_spin(l)       lck_mtx_try_lock(l)
+#define        lck_mtx_lock_spin(l)            lck_mtx_lock(l)
+#define lck_mtx_try_lock_spin_always(l)        lck_spin_try_lock(l)
+#define lck_mtx_lock_spin_always(l)    lck_spin_lock(l)
+#define kdp_lck_mtx_lock_spin_is_acquired(l) kdp_lck_spin_is_acquired(l)
+#define lck_mtx_unlock_always(l)       lck_spin_unlock(l)
+#define        lck_mtx_convert_spin(l)         do {} while (0)
+#endif
+
+extern boolean_t               kdp_lck_rw_lock_is_acquired_exclusive(
+                                                                       lck_rw_t                *lck);
+

 #endif /* KERNEL_PRIVATE */
 
 extern void                            lck_mtx_assert(
 #endif /* KERNEL_PRIVATE */
 
 extern void                            lck_mtx_assert(


@@ -321,9 +378,15 @@ extern int                         lck_mtx_lock_acquire(
 extern void                            lck_mtx_unlock_wakeup(
                                                                        lck_mtx_t               *lck,
                                                                        thread_t                holder);
 extern void                            lck_mtx_unlock_wakeup(
                                                                        lck_mtx_t               *lck,
                                                                        thread_t                holder);

+extern void                            lck_mtx_unlockspin_wakeup(
+                                                                       lck_mtx_t               *lck);

 
 extern boolean_t               lck_mtx_ilk_unlock(
                                                                        lck_mtx_t               *lck);
 
 extern boolean_t               lck_mtx_ilk_unlock(
                                                                        lck_mtx_t               *lck);

+
+extern boolean_t               lck_mtx_ilk_try_lock(
+                                                                       lck_mtx_t               *lck);
+

 #endif
 
 #define decl_lck_rw_data(class,name)     class lck_rw_t name;
 #endif
 
 #define decl_lck_rw_data(class,name)     class lck_rw_t name;


@@ -333,6 +396,13 @@ typedef unsigned int        lck_rw_type_t;
 #define        LCK_RW_TYPE_SHARED                      0x01
 #define        LCK_RW_TYPE_EXCLUSIVE           0x02
 
 #define        LCK_RW_TYPE_SHARED                      0x01
 #define        LCK_RW_TYPE_EXCLUSIVE           0x02
 

+#ifdef XNU_KERNEL_PRIVATE
+#define LCK_RW_ASSERT_SHARED   0x01
+#define LCK_RW_ASSERT_EXCLUSIVE        0x02
+#define LCK_RW_ASSERT_HELD             0x03
+#define LCK_RW_ASSERT_NOTHELD  0x04
+#endif
+

 __BEGIN_DECLS
 
 extern lck_rw_t                        *lck_rw_alloc_init(
 __BEGIN_DECLS
 
 extern lck_rw_t                        *lck_rw_alloc_init(


@@ -364,6 +434,20 @@ extern void                                lck_rw_lock_exclusive(
 extern void                            lck_rw_unlock_exclusive(
                                                                        lck_rw_t                *lck);
 
 extern void                            lck_rw_unlock_exclusive(
                                                                        lck_rw_t                *lck);
 

+#ifdef XNU_KERNEL_PRIVATE
+/*
+ * CAUTION
+ * read-write locks do not have a concept of ownership, so lck_rw_assert()
+ * merely asserts that someone is holding the lock, not necessarily the caller.
+ */
+extern void                            lck_rw_assert(
+                                                                       lck_rw_t                *lck,
+                                                                       unsigned int            type);
+
+extern void                            lck_rw_clear_promotion(
+                                                                       thread_t                thread);
+#endif
+

 #ifdef KERNEL_PRIVATE
 
 extern lck_rw_type_t   lck_rw_done(
 #ifdef KERNEL_PRIVATE
 
 extern lck_rw_type_t   lck_rw_done(


@@ -391,8 +475,6 @@ extern wait_result_t        lck_rw_sleep_deadline(
                                                                        wait_interrupt_t        interruptible,
                                                                        uint64_t                        deadline);
 
                                                                        wait_interrupt_t        interruptible,
                                                                        uint64_t                        deadline);
 

-#ifdef KERNEL_PRIVATE
-

 extern boolean_t               lck_rw_lock_shared_to_exclusive(
                                                                        lck_rw_t                *lck);
 
 extern boolean_t               lck_rw_lock_shared_to_exclusive(
                                                                        lck_rw_t                *lck);
 


@@ -403,6 +485,8 @@ extern boolean_t            lck_rw_try_lock(
                                                                        lck_rw_t                *lck,
                                                                        lck_rw_type_t   lck_rw_type);
 
                                                                        lck_rw_t                *lck,
                                                                        lck_rw_type_t   lck_rw_type);
 

+#ifdef KERNEL_PRIVATE
+

 extern boolean_t               lck_rw_try_lock_shared(
                                                                        lck_rw_t                *lck);
 
 extern boolean_t               lck_rw_try_lock_shared(
                                                                        lck_rw_t                *lck);