#ifndef _KERN_LOCKS_H_
#define _KERN_LOCKS_H_
#include <sys/cdefs.h>
#include <sys/appleapiopts.h>
#include <mach/boolean.h>
#include <mach/mach_types.h>
#include <kern/kern_types.h>
#include <machine/locks.h>
#ifdef MACH_KERNEL_PRIVATE
#include <kern/queue.h>
extern void lck_mod_init(
void);
typedef unsigned int lck_type_t;
#define LCK_TYPE_SPIN 1
#define LCK_TYPE_MTX 2
#define LCK_TYPE_RW 3
#endif
typedef unsigned int lck_sleep_action_t;
#define LCK_SLEEP_DEFAULT 0x00
#define LCK_SLEEP_UNLOCK 0x01
#define LCK_SLEEP_SHARED 0x02
#define LCK_SLEEP_EXCLUSIVE 0x04
#define LCK_SLEEP_SPIN 0x08
#define LCK_SLEEP_PROMOTED_PRI 0x10
#define LCK_SLEEP_MASK 0x1f
#ifdef MACH_KERNEL_PRIVATE
typedef struct {
uint64_t lck_grp_spin_util_cnt;
uint64_t lck_grp_spin_held_cnt;
uint64_t lck_grp_spin_miss_cnt;
uint64_t lck_grp_spin_held_max;
uint64_t lck_grp_spin_held_cum;
} lck_grp_spin_stat_t;
typedef struct {
uint64_t lck_grp_mtx_util_cnt;
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_max;
uint64_t lck_grp_mtx_held_cum;
uint64_t lck_grp_mtx_wait_max;
uint64_t lck_grp_mtx_wait_cum;
} lck_grp_mtx_stat_t;
typedef struct {
uint64_t lck_grp_rw_util_cnt;
uint64_t lck_grp_rw_held_cnt;
uint64_t lck_grp_rw_miss_cnt;
uint64_t lck_grp_rw_wait_cnt;
uint64_t lck_grp_rw_held_max;
uint64_t lck_grp_rw_held_cum;
uint64_t lck_grp_rw_wait_max;
uint64_t lck_grp_rw_wait_cum;
} lck_grp_rw_stat_t;
typedef struct _lck_grp_stat_ {
lck_grp_spin_stat_t lck_grp_spin_stat;
lck_grp_mtx_stat_t lck_grp_mtx_stat;
lck_grp_rw_stat_t lck_grp_rw_stat;
} lck_grp_stat_t;
#define LCK_GRP_MAX_NAME 64
typedef struct _lck_grp_ {
queue_chain_t lck_grp_link;
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;
#define LCK_GRP_NULL (lck_grp_t *)0
#else
typedef struct __lck_grp__ lck_grp_t;
#endif
#ifdef MACH_KERNEL_PRIVATE
typedef struct _lck_grp_attr_ {
uint32_t grp_attr_val;
} lck_grp_attr_t;
extern lck_grp_attr_t LockDefaultGroupAttr;
#define LCK_GRP_ATTR_STAT 0x1
#else
typedef struct __lck_grp_attr__ lck_grp_attr_t;
#endif
#define LCK_GRP_ATTR_NULL (lck_grp_attr_t *)0
__BEGIN_DECLS
extern lck_grp_attr_t *lck_grp_attr_alloc_init(
void);
extern void lck_grp_attr_setdefault(
lck_grp_attr_t *attr);
extern void lck_grp_attr_setstat(
lck_grp_attr_t *attr);
extern void lck_grp_attr_free(
lck_grp_attr_t *attr);
extern lck_grp_t *lck_grp_alloc_init(
const char* grp_name,
lck_grp_attr_t *attr);
__END_DECLS
#ifdef MACH_KERNEL_PRIVATE
extern void lck_grp_init(
lck_grp_t *grp,
const char* grp_name,
lck_grp_attr_t *attr);
extern void lck_grp_reference(
lck_grp_t *grp);
extern void lck_grp_deallocate(
lck_grp_t *grp);
extern void lck_grp_lckcnt_incr(
lck_grp_t *grp,
lck_type_t lck_type);
extern void lck_grp_lckcnt_decr(
lck_grp_t *grp,
lck_type_t lck_type);
#endif
__BEGIN_DECLS
extern void lck_grp_free(
lck_grp_t *grp);
__END_DECLS
#ifdef MACH_KERNEL_PRIVATE
typedef struct _lck_attr_ {
unsigned int lck_attr_val;
} lck_attr_t;
extern lck_attr_t LockDefaultLckAttr;
#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;
#endif
#define LCK_ATTR_NULL (lck_attr_t *)0
__BEGIN_DECLS
extern lck_attr_t *lck_attr_alloc_init(
void);
extern void lck_attr_setdefault(
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);
#define decl_lck_spin_data(class,name) class lck_spin_t name;
extern lck_spin_t *lck_spin_alloc_init(
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_spin_init(
lck_spin_t *lck,
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_spin_lock(
lck_spin_t *lck);
extern void lck_spin_unlock(
lck_spin_t *lck);
extern void lck_spin_destroy(
lck_spin_t *lck,
lck_grp_t *grp);
extern void lck_spin_free(
lck_spin_t *lck,
lck_grp_t *grp);
extern wait_result_t lck_spin_sleep(
lck_spin_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible);
extern wait_result_t lck_spin_sleep_deadline(
lck_spin_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible,
uint64_t deadline);
#ifdef KERNEL_PRIVATE
extern boolean_t lck_spin_try_lock( lck_spin_t *lck);
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
#define decl_lck_mtx_data(class,name) class lck_mtx_t name;
extern lck_mtx_t *lck_mtx_alloc_init(
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_mtx_init(
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_unlock(
lck_mtx_t *lck);
extern void lck_mtx_destroy(
lck_mtx_t *lck,
lck_grp_t *grp);
extern void lck_mtx_free(
lck_mtx_t *lck,
lck_grp_t *grp);
extern wait_result_t lck_mtx_sleep(
lck_mtx_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible);
extern wait_result_t lck_mtx_sleep_deadline(
lck_mtx_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible,
uint64_t deadline);
#ifdef KERNEL_PRIVATE
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);
extern boolean_t lck_mtx_try_lock_spin(
lck_mtx_t *lck);
extern void lck_mtx_lock_spin(
lck_mtx_t *lck);
extern boolean_t kdp_lck_mtx_lock_spin_is_acquired(
lck_mtx_t *lck);
extern void lck_mtx_convert_spin(
lck_mtx_t *lck);
extern void lck_mtx_lock_spin_always(
lck_mtx_t *lck);
extern boolean_t lck_mtx_try_lock_spin_always(
lck_mtx_t *lck);
#define lck_mtx_unlock_always(l) lck_mtx_unlock(l)
extern void lck_spin_assert(
lck_spin_t *lck,
unsigned int type);
extern boolean_t kdp_lck_rw_lock_is_acquired_exclusive(
lck_rw_t *lck);
#endif
extern void lck_mtx_assert(
lck_mtx_t *lck,
unsigned int type);
#if MACH_ASSERT
#define LCK_MTX_ASSERT(lck,type) lck_mtx_assert((lck),(type))
#else
#define LCK_MTX_ASSERT(lck,type)
#endif
#if DEBUG
#define LCK_MTX_ASSERT_DEBUG(lck,type) lck_mtx_assert((lck),(type))
#else
#define LCK_MTX_ASSERT_DEBUG(lck,type)
#endif
__END_DECLS
#define LCK_ASSERT_OWNED 1
#define LCK_ASSERT_NOTOWNED 2
#define LCK_MTX_ASSERT_OWNED LCK_ASSERT_OWNED
#define LCK_MTX_ASSERT_NOTOWNED LCK_ASSERT_NOTOWNED
#ifdef MACH_KERNEL_PRIVATE
extern void lck_mtx_lock_wait(
lck_mtx_t *lck,
thread_t holder);
extern int lck_mtx_lock_acquire(
lck_mtx_t *lck);
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_try_lock(
lck_mtx_t *lck);
#endif
#define decl_lck_rw_data(class,name) class lck_rw_t name;
typedef unsigned int lck_rw_type_t;
#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(
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_rw_init(
lck_rw_t *lck,
lck_grp_t *grp,
lck_attr_t *attr);
extern void lck_rw_lock(
lck_rw_t *lck,
lck_rw_type_t lck_rw_type);
extern void lck_rw_unlock(
lck_rw_t *lck,
lck_rw_type_t lck_rw_type);
extern void lck_rw_lock_shared(
lck_rw_t *lck);
extern void lck_rw_unlock_shared(
lck_rw_t *lck);
extern void lck_rw_lock_exclusive(
lck_rw_t *lck);
extern void lck_rw_unlock_exclusive(
lck_rw_t *lck);
#ifdef XNU_KERNEL_PRIVATE
extern void lck_rw_assert(
lck_rw_t *lck,
unsigned int type);
extern void lck_rw_clear_promotion(
thread_t thread);
extern void lck_rw_set_promotion_locked(thread_t thread);
#endif
#ifdef KERNEL_PRIVATE
extern lck_rw_type_t lck_rw_done(
lck_rw_t *lck);
#endif
extern void lck_rw_destroy(
lck_rw_t *lck,
lck_grp_t *grp);
extern void lck_rw_free(
lck_rw_t *lck,
lck_grp_t *grp);
extern wait_result_t lck_rw_sleep(
lck_rw_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible);
extern wait_result_t lck_rw_sleep_deadline(
lck_rw_t *lck,
lck_sleep_action_t lck_sleep_action,
event_t event,
wait_interrupt_t interruptible,
uint64_t deadline);
extern boolean_t lck_rw_lock_shared_to_exclusive(
lck_rw_t *lck);
extern void lck_rw_lock_exclusive_to_shared(
lck_rw_t *lck);
extern boolean_t lck_rw_try_lock(
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_exclusive(
lck_rw_t *lck);
#endif
__END_DECLS
#endif