[apple/xnu.git] / osfmk / kperf / kdebug_trigger.c

/*
 * Copyright (c) 2016 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@
 */

/*
 * kperf's kdebug trigger is a precise mechanism for taking samples of the
 * thread tracing a kdebug event.
 *
 * The filter used by kperf differs from kdebug's typefilter. kperf's filter
 * is small -- only around 140 bytes, as opposed to kdebug's 8KB filter.  It
 * can also target precise debug IDs, instead of only being able to specify
 * an entire subclass in a kdebug typefilter.  Function specifiers can be
 * provided to match against along with a class or subclass.  For instance, this
 * allows the kperf filter to only trigger a sample if an ending syscall event
 * (DBG_BSD, DBG_BSD_EXCP_SC) occurs.
 *
 * The tradeoff for this flexibility is that only KPERF_KDEBUG_DEBUGIDS_MAX (32)
 * classes, subclasses, or exact debug IDs can be filtered at one time.
 *
 * The filter consists of up to 32 debug IDs and an array of 2-bit type codes
 * packed into a 64-bit value.  To determine if a given debug ID should trigger
 * a kperf sample, each debug ID is checked.  The type code is unpacked from the
 * 64-bit value to apply a mask to the debug ID.  Then, a sample occurs if the
 * masked debug ID is equal to the debug ID in the filter's list.
 */

#include <kern/kalloc.h>
#include <kperf/action.h>
#include <kperf/buffer.h>
#include <kperf/context.h>
#include <kperf/kdebug_trigger.h>
#include <kperf/kperf.h>
#include <sys/errno.h>

boolean_t kperf_kdebug_active = FALSE;
static void kperf_kdebug_update(void);

static uint8_t kperf_kdebug_action = 0;

static struct kperf_kdebug_filter {
	uint64_t types[2];
	uint32_t debugids[KPERF_KDEBUG_DEBUGIDS_MAX];
	uint8_t n_debugids;
} __attribute__((packed)) *kperf_kdebug_filter = NULL;

enum kperf_kdebug_filter_type {
	KPERF_KDEBUG_FILTER_CLASS,
	KPERF_KDEBUG_FILTER_CLASS_FN,
	KPERF_KDEBUG_FILTER_CSC,
	KPERF_KDEBUG_FILTER_CSC_FN,
	KPERF_KDEBUG_FILTER_DEBUGID,
	KPERF_KDEBUG_FILTER_DEBUGID_FN
};

const static uint32_t debugid_masks[] = {
	[KPERF_KDEBUG_FILTER_CLASS] = KDBG_CLASS_MASK,
	[KPERF_KDEBUG_FILTER_CLASS_FN] = KDBG_CLASS_MASK | KDBG_FUNC_MASK,
	[KPERF_KDEBUG_FILTER_CSC] = KDBG_CSC_MASK,
	[KPERF_KDEBUG_FILTER_CSC_FN] = KDBG_CSC_MASK | KDBG_FUNC_MASK,
	[KPERF_KDEBUG_FILTER_DEBUGID] = KDBG_EVENTID_MASK,
	[KPERF_KDEBUG_FILTER_DEBUGID_FN] = UINT32_MAX,
};

/*
 * Types are packed into 2 64-bit fields in the filter, with 4-bits for each
 * type.  Only 3 bits are strictly necessary, but using 4 simplifies the
 * unpacking.
 */

/* UNSAFE */
#define DECODE_TYPE(TYPES, I) ((((uint8_t *)(TYPES))[(I) / 2] >> ((I) % 2) * 4) & 0xf)

void
kperf_kdebug_setup(void)
{
	kperf_kdebug_filter = kalloc_tag(sizeof(*kperf_kdebug_filter),
	    VM_KERN_MEMORY_DIAG);
	bzero(kperf_kdebug_filter, sizeof(*kperf_kdebug_filter));
}

void
kperf_kdebug_reset(void)
{
	kperf_setup();

	kperf_kdebug_action = 0;
	bzero(kperf_kdebug_filter, sizeof(*kperf_kdebug_filter));
	kperf_kdebug_update();
}

boolean_t
kperf_kdebug_should_trigger(uint32_t debugid)
{
	/* ignore kperf events */
	if (KDBG_EXTRACT_CLASS(debugid) == DBG_PERF) {
		return FALSE;
	}

	/*
	 * Search linearly through list of debugids and masks.  If the filter
	 * gets larger than 128 bytes, change this to either a binary search or
	 * a sparse bitmap on the uint32_t range, depending on the new size.
	 */
	for (uint8_t i = 0; i < kperf_kdebug_filter->n_debugids; i++) {
		uint32_t check_debugid =
		    kperf_kdebug_filter->debugids[i];
		uint32_t mask = debugid_masks[DECODE_TYPE(kperf_kdebug_filter->types, i)];

		if ((debugid & mask) == check_debugid) {
			return TRUE;
		}
	}

	return FALSE;
}

int
kperf_kdebug_set_filter(user_addr_t user_filter, uint32_t user_size)
{
	uint32_t n_debugids_provided = 0;
	int err = 0;

	kperf_setup();

	n_debugids_provided = (uint32_t)KPERF_KDEBUG_N_DEBUGIDS(user_size);

	/* detect disabling the filter completely */
	if (n_debugids_provided == 0) {
		bzero(kperf_kdebug_filter, sizeof(*kperf_kdebug_filter));
		goto out;
	}

	if ((err = kperf_kdebug_set_n_debugids(n_debugids_provided))) {
		goto out;
	}

	if ((err = copyin(user_filter, (char *)kperf_kdebug_filter,
	    KPERF_KDEBUG_FILTER_SIZE(n_debugids_provided)))) {
		bzero(kperf_kdebug_filter, sizeof(*kperf_kdebug_filter));
		goto out;
	}

out:
	kperf_kdebug_update();

	return err;
}

uint32_t
kperf_kdebug_get_filter(struct kperf_kdebug_filter **filter)
{
	kperf_setup();

	assert(filter != NULL);

	*filter = kperf_kdebug_filter;
	return kperf_kdebug_filter->n_debugids;
}

int
kperf_kdebug_set_n_debugids(uint32_t n_debugids_in)
{
	kperf_setup();

	if (n_debugids_in > KPERF_KDEBUG_DEBUGIDS_MAX) {
		return EINVAL;
	}

	kperf_kdebug_filter->n_debugids = n_debugids_in;

	return 0;
}

int
kperf_kdebug_set_action(int action_id)
{
	if (action_id < 0 || (unsigned int)action_id > kperf_action_get_count()) {
		return EINVAL;
	}

	kperf_kdebug_action = action_id;
	kperf_kdebug_update();

	return 0;
}

int
kperf_kdebug_get_action(void)
{
	return kperf_kdebug_action;
}

static void
kperf_kdebug_update(void)
{
	kperf_setup();

	if (kperf_kdebug_action != 0 &&
	    kperf_kdebug_filter->n_debugids != 0) {
		kperf_kdebug_active = TRUE;
	} else {
		kperf_kdebug_active = FALSE;
	}
}
Commit	Line	Data
39037602 A	1	/*
	2	* Copyright (c) 2016 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
	29	/*
	30	* kperf's kdebug trigger is a precise mechanism for taking samples of the
	31	* thread tracing a kdebug event.
	32	*
	33	* The filter used by kperf differs from kdebug's typefilter. kperf's filter
	34	* is small -- only around 140 bytes, as opposed to kdebug's 8KB filter. It
	35	* can also target precise debug IDs, instead of only being able to specify
	36	* an entire subclass in a kdebug typefilter. Function specifiers can be
	37	* provided to match against along with a class or subclass. For instance, this
	38	* allows the kperf filter to only trigger a sample if an ending syscall event
	39	* (DBG_BSD, DBG_BSD_EXCP_SC) occurs.
	40	*
	41	* The tradeoff for this flexibility is that only KPERF_KDEBUG_DEBUGIDS_MAX (32)
	42	* classes, subclasses, or exact debug IDs can be filtered at one time.
	43	*
	44	* The filter consists of up to 32 debug IDs and an array of 2-bit type codes
	45	* packed into a 64-bit value. To determine if a given debug ID should trigger
	46	* a kperf sample, each debug ID is checked. The type code is unpacked from the
	47	* 64-bit value to apply a mask to the debug ID. Then, a sample occurs if the
	48	* masked debug ID is equal to the debug ID in the filter's list.
	49	*/
	50
	51	#include <kern/kalloc.h>
	52	#include <kperf/action.h>
	53	#include <kperf/buffer.h>
	54	#include <kperf/context.h>
	55	#include <kperf/kdebug_trigger.h>
	56	#include <kperf/kperf.h>
	57	#include <sys/errno.h>
	58
	59	boolean_t kperf_kdebug_active = FALSE;
	60	static void kperf_kdebug_update(void);
	61
	62	static uint8_t kperf_kdebug_action = 0;
	63
	64	static struct kperf_kdebug_filter {
65	uint64_t types[2];
66	uint32_t debugids[KPERF_KDEBUG_DEBUGIDS_MAX];
67	uint8_t n_debugids;
68	} __attribute__((packed)) *kperf_kdebug_filter = NULL;
69
70	enum kperf_kdebug_filter_type {
71	KPERF_KDEBUG_FILTER_CLASS,
72	KPERF_KDEBUG_FILTER_CLASS_FN,
73	KPERF_KDEBUG_FILTER_CSC,
74	KPERF_KDEBUG_FILTER_CSC_FN,
75	KPERF_KDEBUG_FILTER_DEBUGID,
76	KPERF_KDEBUG_FILTER_DEBUGID_FN
77	};
78
79	const static uint32_t debugid_masks[] = {
80	[KPERF_KDEBUG_FILTER_CLASS] = KDBG_CLASS_MASK,
81	[KPERF_KDEBUG_FILTER_CLASS_FN] = KDBG_CLASS_MASK \| KDBG_FUNC_MASK,
82	[KPERF_KDEBUG_FILTER_CSC] = KDBG_CSC_MASK,
83	[KPERF_KDEBUG_FILTER_CSC_FN] = KDBG_CSC_MASK \| KDBG_FUNC_MASK,
84	[KPERF_KDEBUG_FILTER_DEBUGID] = KDBG_EVENTID_MASK,
85	[KPERF_KDEBUG_FILTER_DEBUGID_FN] = UINT32_MAX,
86	};
87
88	/*
89	* Types are packed into 2 64-bit fields in the filter, with 4-bits for each
90	* type. Only 3 bits are strictly necessary, but using 4 simplifies the
91	* unpacking.
92	*/
93
94	/* UNSAFE */
95	#define DECODE_TYPE(TYPES, I) ((((uint8_t )(TYPES))[(I) / 2] >> ((I) % 2) 4) & 0xf)
96
f427ee49 A	97	void
f427ee49 A	98	kperf_kdebug_setup(void)
39037602 A	99	{
39037602 A	100	kperf_kdebug_filter = kalloc_tag(sizeof(*kperf_kdebug_filter),
0a7de745	101	VM_KERN_MEMORY_DIAG);
39037602	102	bzero(kperf_kdebug_filter, sizeof(*kperf_kdebug_filter));
39037602 A	103	}
	104
	105	void
	106	kperf_kdebug_reset(void)
	107	{
f427ee49	108	kperf_setup();
39037602 A	109
	110	kperf_kdebug_action = 0;
	111	bzero(kperf_kdebug_filter, sizeof(*kperf_kdebug_filter));
	112	kperf_kdebug_update();
	113	}
	114
	115	boolean_t
	116	kperf_kdebug_should_trigger(uint32_t debugid)
	117	{
	118	/* ignore kperf events */
	119	if (KDBG_EXTRACT_CLASS(debugid) == DBG_PERF) {
	120	return FALSE;
	121	}
	122
	123	/*
	124	* Search linearly through list of debugids and masks. If the filter
	125	* gets larger than 128 bytes, change this to either a binary search or
	126	* a sparse bitmap on the uint32_t range, depending on the new size.
	127	*/
	128	for (uint8_t i = 0; i < kperf_kdebug_filter->n_debugids; i++) {
	129	uint32_t check_debugid =
0a7de745	130	kperf_kdebug_filter->debugids[i];
39037602 A	131	uint32_t mask = debugid_masks[DECODE_TYPE(kperf_kdebug_filter->types, i)];
	132
	133	if ((debugid & mask) == check_debugid) {
	134	return TRUE;
	135	}
	136	}
	137
	138	return FALSE;
	139	}
	140
	141	int
	142	kperf_kdebug_set_filter(user_addr_t user_filter, uint32_t user_size)
	143	{
	144	uint32_t n_debugids_provided = 0;
	145	int err = 0;
	146
f427ee49	147	kperf_setup();
39037602	148
d9a64523 A	149	n_debugids_provided = (uint32_t)KPERF_KDEBUG_N_DEBUGIDS(user_size);
d9a64523 A	150
39037602	151	/* detect disabling the filter completely */
d9a64523	152	if (n_debugids_provided == 0) {
39037602 A	153	bzero(kperf_kdebug_filter, sizeof(*kperf_kdebug_filter));
	154	goto out;
	155	}
	156
39037602 A	157	if ((err = kperf_kdebug_set_n_debugids(n_debugids_provided))) {
	158	goto out;
	159	}
	160
	161	if ((err = copyin(user_filter, (char *)kperf_kdebug_filter,
0a7de745	162	KPERF_KDEBUG_FILTER_SIZE(n_debugids_provided)))) {
39037602 A	163	bzero(kperf_kdebug_filter, sizeof(*kperf_kdebug_filter));
	164	goto out;
	165	}
	166
	167	out:
	168	kperf_kdebug_update();
	169
	170	return err;
	171	}
	172
	173	uint32_t
	174	kperf_kdebug_get_filter(struct kperf_kdebug_filter **filter)
	175	{
f427ee49	176	kperf_setup();
39037602 A	177
	178	assert(filter != NULL);
	179
	180	*filter = kperf_kdebug_filter;
	181	return kperf_kdebug_filter->n_debugids;
	182	}
	183
	184	int
	185	kperf_kdebug_set_n_debugids(uint32_t n_debugids_in)
	186	{
f427ee49	187	kperf_setup();
39037602 A	188
	189	if (n_debugids_in > KPERF_KDEBUG_DEBUGIDS_MAX) {
	190	return EINVAL;
	191	}
	192
	193	kperf_kdebug_filter->n_debugids = n_debugids_in;
	194
	195	return 0;
	196	}
	197
	198	int
	199	kperf_kdebug_set_action(int action_id)
	200	{
	201	if (action_id < 0 \|\| (unsigned int)action_id > kperf_action_get_count()) {
	202	return EINVAL;
	203	}
	204
	205	kperf_kdebug_action = action_id;
	206	kperf_kdebug_update();
	207
	208	return 0;
	209	}
	210
	211	int
	212	kperf_kdebug_get_action(void)
	213	{
	214	return kperf_kdebug_action;
	215	}
	216
	217	static void
	218	kperf_kdebug_update(void)
	219	{
f427ee49	220	kperf_setup();
39037602 A	221
39037602 A	222	if (kperf_kdebug_action != 0 &&
0a7de745	223	kperf_kdebug_filter->n_debugids != 0) {
39037602 A	224	kperf_kdebug_active = TRUE;
	225	} else {
	226	kperf_kdebug_active = FALSE;
	227	}
	228	}