[apple/xnu.git] / osfmk / kperf / thread_samplers.h

/*
 * Copyright (c) 2011 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 KPERF_THREAD_SAMPLERS_H
#define KPERF_THREAD_SAMPLERS_H

#include <kperf/context.h>

/* legacy thread info */
struct kperf_thread_info {
	uint64_t kpthi_pid;
	uint64_t kpthi_tid;
	uint64_t kpthi_dq_addr;
	uint64_t kpthi_runmode;
};

void kperf_thread_info_sample(struct kperf_thread_info *,
                              struct kperf_context *);
void kperf_thread_info_log(struct kperf_thread_info *);

/* scheduling information */
struct kperf_thread_scheduling {
	uint64_t kpthsc_user_time;
	uint64_t kpthsc_system_time;
	unsigned int kpthsc_state;
	uint16_t kpthsc_base_priority;
	uint16_t kpthsc_sched_priority;
	unsigned int kpthsc_effective_qos :3,
			kpthsc_requested_qos :3,
			kpthsc_requested_qos_override :3,
			kpthsc_requested_qos_promote :3,
			kpthsc_requested_qos_ipc_override :3,
			kpthsc_requested_qos_sync_ipc_override :3,
			kpthsc_effective_latency_qos :3;
};

void kperf_thread_scheduling_sample(struct kperf_thread_scheduling *,
                                    struct kperf_context *);
void kperf_thread_scheduling_log(struct kperf_thread_scheduling *);

/* thread snapshot information */
struct kperf_thread_snapshot {
	uint64_t kpthsn_last_made_runnable_time;
	int16_t kpthsn_suspend_count;
	uint8_t kpthsn_io_tier;
	uint8_t kpthsn_flags;
};

void kperf_thread_snapshot_sample(struct kperf_thread_snapshot *,
                                  struct kperf_context *);
void kperf_thread_snapshot_log(struct kperf_thread_snapshot *);

/* libdispatch information */
struct kperf_thread_dispatch {
	uint64_t kpthdi_dq_serialno;
};

void kperf_thread_dispatch_sample(struct kperf_thread_dispatch *,
                                  struct kperf_context *);
int kperf_thread_dispatch_pend(struct kperf_context *);
void kperf_thread_dispatch_log(struct kperf_thread_dispatch *);

void kperf_thread_inscyc_log(struct kperf_context *);

#endif /* !defined(KPERF_THREAD_SAMPLERS_H) */
Commit	Line	Data
39037602 A	1	/*
	2	* Copyright (c) 2011 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	#ifndef KPERF_THREAD_SAMPLERS_H
	30	#define KPERF_THREAD_SAMPLERS_H
	31
	32	#include <kperf/context.h>
	33
	34	/* legacy thread info */
	35	struct kperf_thread_info {
	36	uint64_t kpthi_pid;
	37	uint64_t kpthi_tid;
	38	uint64_t kpthi_dq_addr;
	39	uint64_t kpthi_runmode;
	40	};
	41
	42	void kperf_thread_info_sample(struct kperf_thread_info *,
	43	struct kperf_context *);
	44	void kperf_thread_info_log(struct kperf_thread_info *);
	45
	46	/* scheduling information */
	47	struct kperf_thread_scheduling {
	48	uint64_t kpthsc_user_time;
	49	uint64_t kpthsc_system_time;
	50	unsigned int kpthsc_state;
	51	uint16_t kpthsc_base_priority;
	52	uint16_t kpthsc_sched_priority;
5ba3f43e A	53	unsigned int kpthsc_effective_qos :3,
	54	kpthsc_requested_qos :3,
	55	kpthsc_requested_qos_override :3,
	56	kpthsc_requested_qos_promote :3,
	57	kpthsc_requested_qos_ipc_override :3,
	58	kpthsc_requested_qos_sync_ipc_override :3,
	59	kpthsc_effective_latency_qos :3;
39037602 A	60	};
	61
	62	void kperf_thread_scheduling_sample(struct kperf_thread_scheduling *,
	63	struct kperf_context *);
	64	void kperf_thread_scheduling_log(struct kperf_thread_scheduling *);
	65
	66	/* thread snapshot information */
	67	struct kperf_thread_snapshot {
	68	uint64_t kpthsn_last_made_runnable_time;
	69	int16_t kpthsn_suspend_count;
	70	uint8_t kpthsn_io_tier;
	71	uint8_t kpthsn_flags;
	72	};
	73
	74	void kperf_thread_snapshot_sample(struct kperf_thread_snapshot *,
	75	struct kperf_context *);
	76	void kperf_thread_snapshot_log(struct kperf_thread_snapshot *);
	77
	78	/* libdispatch information */
	79	struct kperf_thread_dispatch {
	80	uint64_t kpthdi_dq_serialno;
	81	};
	82
	83	void kperf_thread_dispatch_sample(struct kperf_thread_dispatch *,
	84	struct kperf_context *);
	85	int kperf_thread_dispatch_pend(struct kperf_context *);
	86	void kperf_thread_dispatch_log(struct kperf_thread_dispatch *);
	87
5ba3f43e A	88	void kperf_thread_inscyc_log(struct kperf_context *);
5ba3f43e A	89
39037602	90	#endif /* !defined(KPERF_THREAD_SAMPLERS_H) */