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

/*
 * Copyright (c) 2018 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * 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. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * 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
 * 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.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
#ifndef _KERN_LOCK_GROUP_H
#define _KERN_LOCK_GROUP_H

#include <kern/queue.h>
#include <mach/mach_types.h>

__BEGIN_DECLS

#define LCK_GRP_NULL    (lck_grp_t *)NULL

typedef enum lck_type {
	LCK_TYPE_SPIN,
	LCK_TYPE_MTX,
	LCK_TYPE_RW,
	LCK_TYPE_TICKET
} lck_type_t;

#if XNU_KERNEL_PRIVATE
#include <kern/startup.h>
#include <os/refcnt.h>

/*
 * Arguments wrapped in LCK_GRP_ARG() will be elided
 * when LOCK_STATS is not set.
 *
 * Arguments wrapped with LCK_GRP_PROBEARG() will be
 * NULL when LOCK_STATS is not set
 */
#if LOCK_STATS
#define LCK_GRP_ARG(expr) ,expr
#define LCK_GRP_PROBEARG(grp) grp
#else
#define LCK_GRP_ARG(expr)
#define LCK_GRP_PROBEARG(grp) LCK_GRP_NULL
#endif /* LOCK_STATS */

typedef struct _lck_grp_stat_ {
	uint64_t lgs_count;
	uint32_t lgs_enablings;
#if CONFIG_DTRACE
	/*
	 * Protected by dtrace_lock
	 */
	uint32_t lgs_probeid;
	uint64_t lgs_limit;
#endif /* CONFIG_DTRACE */
} lck_grp_stat_t;

typedef struct _lck_grp_stats_ {
#if LOCK_STATS
	lck_grp_stat_t          lgss_spin_held;
	lck_grp_stat_t          lgss_spin_miss;
	lck_grp_stat_t          lgss_spin_spin;
	lck_grp_stat_t          lgss_ticket_held;
	lck_grp_stat_t          lgss_ticket_miss;
	lck_grp_stat_t          lgss_ticket_spin;
#endif /* LOCK_STATS */

	lck_grp_stat_t          lgss_mtx_held;
	lck_grp_stat_t          lgss_mtx_direct_wait;
	lck_grp_stat_t          lgss_mtx_miss;
	lck_grp_stat_t          lgss_mtx_wait;
} lck_grp_stats_t;

#define LCK_GRP_MAX_NAME        64

typedef struct _lck_grp_ {
	queue_chain_t           lck_grp_link;
	os_refcnt_t             lck_grp_refcnt;
	uint32_t                lck_grp_spincnt;
	uint32_t                lck_grp_ticketcnt;
	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_stats_t         lck_grp_stats;
} lck_grp_t;

#else
typedef struct _lck_grp_ lck_grp_t;
#endif /* XNU_KERNEL_PRIVATE */

#define LCK_GRP_ATTR_STAT       0x1
#define LCK_GRP_ATTR_TIME_STAT  0x2

#ifdef XNU_KERNEL_PRIVATE
typedef struct _lck_grp_attr_ {
	uint32_t        grp_attr_val;
} lck_grp_attr_t;

struct lck_grp_attr_startup_spec {
	lck_grp_attr_t *grp_attr;
	uint32_t        grp_attr_set_flags;
	uint32_t        grp_attr_clear_flags;
};

struct lck_grp_startup_spec {
	lck_grp_t      *grp;
	const char     *grp_name;
	lck_grp_attr_t *grp_attr;
};

extern void lck_grp_attr_startup_init(
	struct lck_grp_attr_startup_spec *spec);

extern void lck_grp_startup_init(
	struct lck_grp_startup_spec *spec);

/*
 * Auto-initializing lock group declarations
 * -----------------------------------------
 *
 * Use LCK_GRP_DECLARE to declare an automatically initialized group.
 *
 * Unless you need to configure your lock groups in very specific ways,
 * there is no point creating explicit lock group attributes. If however
 * you do need to tune the group, then LCK_GRP_DECLARE_ATTR can be used
 * and takes an extra lock group attr argument previously declared with
 * LCK_GRP_ATTR_DECLARE.
 */
#define LCK_GRP_ATTR_DECLARE(var, set_flags, clear_flags) \
	SECURITY_READ_ONLY_LATE(lck_grp_attr_t) var; \
	static __startup_data struct lck_grp_attr_startup_spec \
	__startup_lck_grp_attr_spec_ ## var = { &var, set_flags, clear_flags }; \
	STARTUP_ARG(LOCKS_EARLY, STARTUP_RANK_SECOND, lck_grp_attr_startup_init, \
	    &__startup_lck_grp_attr_spec_ ## var)

#define LCK_GRP_DECLARE_ATTR(var, name, attr) \
	__PLACE_IN_SECTION("__DATA,__lock_grp") lck_grp_t var; \
	static __startup_data struct lck_grp_startup_spec \
	__startup_lck_grp_spec_ ## var = { &var, name, attr }; \
	STARTUP_ARG(LOCKS_EARLY, STARTUP_RANK_THIRD, lck_grp_startup_init, \
	    &__startup_lck_grp_spec_ ## var)

#define LCK_GRP_DECLARE(var, name) \
	LCK_GRP_DECLARE_ATTR(var, name, LCK_GRP_ATTR_NULL);

#else
typedef struct __lck_grp_attr__ lck_grp_attr_t;
#endif /* XNU_KERNEL_PRIVATE */

#define LCK_GRP_ATTR_NULL       (lck_grp_attr_t *)NULL

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);

extern void             lck_grp_free(
	lck_grp_t               *grp);

#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 /* MACH_KERNEL_PRIVATE */

__END_DECLS

#endif /* _KERN_LOCK_GROUP_H */
Commit	Line	Data
0a7de745 A	1	/*
	2	* Copyright (c) 2018 Apple Computer, 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	#ifndef _KERN_LOCK_GROUP_H
	29	#define _KERN_LOCK_GROUP_H
	30
	31	#include <kern/queue.h>
	32	#include <mach/mach_types.h>
	33
f427ee49	34	__BEGIN_DECLS
0a7de745	35
f427ee49	36	#define LCK_GRP_NULL (lck_grp_t *)NULL
0a7de745	37
f427ee49 A	38	typedef enum lck_type {
	39	LCK_TYPE_SPIN,
	40	LCK_TYPE_MTX,
	41	LCK_TYPE_RW,
	42	LCK_TYPE_TICKET
	43	} lck_type_t;
0a7de745 A	44
0a7de745 A	45	#if XNU_KERNEL_PRIVATE
f427ee49	46	#include <kern/startup.h>
cb323159	47	#include <os/refcnt.h>
f427ee49	48
0a7de745 A	49	/*
	50	* Arguments wrapped in LCK_GRP_ARG() will be elided
	51	* when LOCK_STATS is not set.
	52	*
	53	* Arguments wrapped with LCK_GRP_PROBEARG() will be
	54	* NULL when LOCK_STATS is not set
	55	*/
	56	#if LOCK_STATS
	57	#define LCK_GRP_ARG(expr) ,expr
	58	#define LCK_GRP_PROBEARG(grp) grp
	59	#else
	60	#define LCK_GRP_ARG(expr)
	61	#define LCK_GRP_PROBEARG(grp) LCK_GRP_NULL
	62	#endif /* LOCK_STATS */
	63
	64	typedef struct _lck_grp_stat_ {
	65	uint64_t lgs_count;
	66	uint32_t lgs_enablings;
	67	#if CONFIG_DTRACE
	68	/*
	69	* Protected by dtrace_lock
	70	*/
	71	uint32_t lgs_probeid;
	72	uint64_t lgs_limit;
	73	#endif /* CONFIG_DTRACE */
	74	} lck_grp_stat_t;
	75
	76	typedef struct _lck_grp_stats_ {
	77	#if LOCK_STATS
f427ee49 A	78	lck_grp_stat_t lgss_spin_held;
	79	lck_grp_stat_t lgss_spin_miss;
	80	lck_grp_stat_t lgss_spin_spin;
	81	lck_grp_stat_t lgss_ticket_held;
	82	lck_grp_stat_t lgss_ticket_miss;
	83	lck_grp_stat_t lgss_ticket_spin;
0a7de745 A	84	#endif /* LOCK_STATS */
0a7de745 A	85
f427ee49 A	86	lck_grp_stat_t lgss_mtx_held;
	87	lck_grp_stat_t lgss_mtx_direct_wait;
	88	lck_grp_stat_t lgss_mtx_miss;
	89	lck_grp_stat_t lgss_mtx_wait;
0a7de745 A	90	} lck_grp_stats_t;
	91
	92	#define LCK_GRP_MAX_NAME 64
	93
	94	typedef struct _lck_grp_ {
	95	queue_chain_t lck_grp_link;
cb323159	96	os_refcnt_t lck_grp_refcnt;
0a7de745	97	uint32_t lck_grp_spincnt;
f427ee49	98	uint32_t lck_grp_ticketcnt;
0a7de745 A	99	uint32_t lck_grp_mtxcnt;
	100	uint32_t lck_grp_rwcnt;
	101	uint32_t lck_grp_attr;
	102	char lck_grp_name[LCK_GRP_MAX_NAME];
	103	lck_grp_stats_t lck_grp_stats;
	104	} lck_grp_t;
	105
	106	#else
	107	typedef struct _lck_grp_ lck_grp_t;
	108	#endif /* XNU_KERNEL_PRIVATE */
	109
f427ee49 A	110	#define LCK_GRP_ATTR_STAT 0x1
f427ee49 A	111	#define LCK_GRP_ATTR_TIME_STAT 0x2
cb323159	112
f427ee49	113	#ifdef XNU_KERNEL_PRIVATE
0a7de745 A	114	typedef struct _lck_grp_attr_ {
	115	uint32_t grp_attr_val;
	116	} lck_grp_attr_t;
	117
f427ee49 A	118	struct lck_grp_attr_startup_spec {
	119	lck_grp_attr_t *grp_attr;
	120	uint32_t grp_attr_set_flags;
	121	uint32_t grp_attr_clear_flags;
	122	};
0a7de745	123
f427ee49 A	124	struct lck_grp_startup_spec {
	125	lck_grp_t *grp;
	126	const char *grp_name;
	127	lck_grp_attr_t *grp_attr;
	128	};
	129
	130	extern void lck_grp_attr_startup_init(
	131	struct lck_grp_attr_startup_spec *spec);
	132
	133	extern void lck_grp_startup_init(
	134	struct lck_grp_startup_spec *spec);
	135
	136	/*
	137	* Auto-initializing lock group declarations
	138	* -----------------------------------------
	139	*
	140	* Use LCK_GRP_DECLARE to declare an automatically initialized group.
	141	*
	142	* Unless you need to configure your lock groups in very specific ways,
	143	* there is no point creating explicit lock group attributes. If however
	144	* you do need to tune the group, then LCK_GRP_DECLARE_ATTR can be used
	145	* and takes an extra lock group attr argument previously declared with
	146	* LCK_GRP_ATTR_DECLARE.
	147	*/
	148	#define LCK_GRP_ATTR_DECLARE(var, set_flags, clear_flags) \
	149	SECURITY_READ_ONLY_LATE(lck_grp_attr_t) var; \
	150	static __startup_data struct lck_grp_attr_startup_spec \
	151	__startup_lck_grp_attr_spec_ ## var = { &var, set_flags, clear_flags }; \
	152	STARTUP_ARG(LOCKS_EARLY, STARTUP_RANK_SECOND, lck_grp_attr_startup_init, \
	153	&__startup_lck_grp_attr_spec_ ## var)
	154
	155	#define LCK_GRP_DECLARE_ATTR(var, name, attr) \
	156	__PLACE_IN_SECTION("__DATA,__lock_grp") lck_grp_t var; \
	157	static __startup_data struct lck_grp_startup_spec \
	158	__startup_lck_grp_spec_ ## var = { &var, name, attr }; \
	159	STARTUP_ARG(LOCKS_EARLY, STARTUP_RANK_THIRD, lck_grp_startup_init, \
	160	&__startup_lck_grp_spec_ ## var)
	161
	162	#define LCK_GRP_DECLARE(var, name) \
	163	LCK_GRP_DECLARE_ATTR(var, name, LCK_GRP_ATTR_NULL);
0a7de745 A	164
	165	#else
	166	typedef struct __lck_grp_attr__ lck_grp_attr_t;
f427ee49	167	#endif /* XNU_KERNEL_PRIVATE */
0a7de745	168
cb323159	169	#define LCK_GRP_ATTR_NULL (lck_grp_attr_t *)NULL
0a7de745	170
0a7de745 A	171	extern lck_grp_attr_t *lck_grp_attr_alloc_init(
	172	void);
	173
f427ee49 A	174	extern void lck_grp_attr_setdefault(
f427ee49 A	175	lck_grp_attr_t *attr);
0a7de745	176
f427ee49 A	177	extern void lck_grp_attr_setstat(
f427ee49 A	178	lck_grp_attr_t *attr);
0a7de745	179
f427ee49 A	180	extern void lck_grp_attr_free(
f427ee49 A	181	lck_grp_attr_t *attr);
0a7de745	182
f427ee49	183	extern lck_grp_t *lck_grp_alloc_init(
0a7de745 A	184	const char* grp_name,
	185	lck_grp_attr_t *attr);
	186
f427ee49	187	extern void lck_grp_free(
0a7de745 A	188	lck_grp_t *grp);
0a7de745 A	189
0a7de745	190	#ifdef MACH_KERNEL_PRIVATE
f427ee49	191	extern void lck_grp_init(
0a7de745 A	192	lck_grp_t *grp,
0a7de745 A	193	const char* grp_name,
f427ee49	194	lck_grp_attr_t *attr);
0a7de745	195
f427ee49	196	extern void lck_grp_reference(
0a7de745 A	197	lck_grp_t *grp);
0a7de745 A	198
f427ee49	199	extern void lck_grp_deallocate(
0a7de745 A	200	lck_grp_t *grp);
0a7de745 A	201
f427ee49	202	extern void lck_grp_lckcnt_incr(
0a7de745 A	203	lck_grp_t *grp,
	204	lck_type_t lck_type);
	205
f427ee49	206	extern void lck_grp_lckcnt_decr(
0a7de745 A	207	lck_grp_t *grp,
0a7de745 A	208	lck_type_t lck_type);
0a7de745 A	209	#endif /* MACH_KERNEL_PRIVATE */
0a7de745 A	210
f427ee49 A	211	__END_DECLS
f427ee49 A	212
0a7de745	213	#endif /* _KERN_LOCK_GROUP_H */