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

/*
 * Copyright (c) 2017-2019 Apple 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_MONOTONIC_H
#define KERN_MONOTONIC_H

#if MONOTONIC

#include <stdbool.h>
#include <stdint.h>
#include <sys/cdefs.h>

__BEGIN_DECLS

extern bool mt_debug;
extern _Atomic uint64_t mt_pmis;
extern _Atomic uint64_t mt_retrograde;

void mt_fixed_counts(uint64_t *counts);
void mt_cur_thread_fixed_counts(uint64_t *counts);
void mt_cur_task_fixed_counts(uint64_t *counts);
uint64_t mt_cur_cpu_instrs(void);
uint64_t mt_cur_cpu_cycles(void);
uint64_t mt_cur_thread_instrs(void);
uint64_t mt_cur_thread_cycles(void);

__END_DECLS

#if MACH_KERNEL_PRIVATE

#include <kern/thread.h>
#include <kern/task.h>
#include <stdbool.h>

__BEGIN_DECLS

#if defined(__arm__) || defined(__arm64__)
#include <arm/cpu_data_internal.h>
#elif defined(__x86_64__)
#include <i386/cpu_data.h>
#else /* !defined(__arm__) && !defined(__arm64__) && !defined(__x86_64__) */
#error unsupported architecture
#endif /* !defined(__arm__) && !defined(__arm64__) && !defined(__x86_64__) */

void mt_update_fixed_counts(void);
void mt_update_task(task_t task, thread_t thread);
bool mt_update_thread(thread_t thread);
int mt_fixed_thread_counts(thread_t thread, uint64_t *counts_out);
int mt_fixed_task_counts(task_t task, uint64_t *counts_out);

/*
 * Private API for the platform layers.
 */

/*
 * Called once early in boot, before CPU initialization occurs (where
 * `mt_cpu_up` is called).
 *
 * This allows monotonic to detect if the hardware supports performance counters
 * and install the global PMI handler.
 */
void mt_early_init(void);

/*
 * Called when a core is idling and exiting from idle.
 */
void mt_cpu_idle(cpu_data_t *cpu);
void mt_cpu_run(cpu_data_t *cpu);

/*
 * Called when a core is shutting down or powering up.
 */
void mt_cpu_down(cpu_data_t *cpu);
void mt_cpu_up(cpu_data_t *cpu);

/*
 * Called while single-threaded when the system is going to sleep.
 */
void mt_sleep(void);

/*
 * Called on each CPU as the system is waking from sleep.
 */
void mt_wake_per_core(void);

/*
 * "Up-call" to the Mach layer to update counters from a PMI.
 */
uint64_t mt_cpu_update_count(cpu_data_t *cpu, unsigned int ctr);

/*
 * Private API for the scheduler.
 */

/*
 * Called when a thread is switching off-core or expires its quantum.
 */
void mt_sched_update(thread_t thread);

/*
 * Called when a thread is terminating to save its counters into the task.  The
 * task lock must be held and the thread should be removed from the task's
 * thread list in that same critical section.
 */
void mt_terminate_update(task_t task, thread_t thread);

/*
 * Private API for the performance controller callout.
 */
void mt_perfcontrol(uint64_t *instrs, uint64_t *cycles);

/*
 * Private API for stackshot.
 */
void mt_stackshot_thread(thread_t thread, uint64_t *instrs, uint64_t *cycles);
void mt_stackshot_task(task_t task, uint64_t *instrs, uint64_t *cycles);

/*
 * Private API for microstackshot.
 */
typedef void (*mt_pmi_fn)(bool user_mode, void *ctx);
int mt_microstackshot_start(unsigned int ctr, uint64_t period, mt_pmi_fn fn,
    void *ctx);
int mt_microstackshot_stop(void);

__END_DECLS

#endif /* MACH_KERNEL_PRIVATE */

#endif /* MONOTONIC */

#endif /* !defined(KERN_MONOTONIC_H) */
Commit	Line	Data
5ba3f43e	1	/*
cb323159	2	* Copyright (c) 2017-2019 Apple Inc. All rights reserved.
5ba3f43e A	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_MONOTONIC_H
	29	#define KERN_MONOTONIC_H
	30
cb323159 A	31	#if MONOTONIC
cb323159 A	32
5ba3f43e A	33	#include <stdbool.h>
5ba3f43e A	34	#include <stdint.h>
d9a64523 A	35	#include <sys/cdefs.h>
	36
	37	__BEGIN_DECLS
5ba3f43e A	38
	39	extern bool mt_debug;
	40	extern _Atomic uint64_t mt_pmis;
	41	extern _Atomic uint64_t mt_retrograde;
	42
	43	void mt_fixed_counts(uint64_t *counts);
	44	void mt_cur_thread_fixed_counts(uint64_t *counts);
	45	void mt_cur_task_fixed_counts(uint64_t *counts);
	46	uint64_t mt_cur_cpu_instrs(void);
	47	uint64_t mt_cur_cpu_cycles(void);
	48	uint64_t mt_cur_thread_instrs(void);
	49	uint64_t mt_cur_thread_cycles(void);
	50
d9a64523 A	51	__END_DECLS
d9a64523 A	52
5ba3f43e A	53	#if MACH_KERNEL_PRIVATE
	54
	55	#include <kern/thread.h>
	56	#include <kern/task.h>
	57	#include <stdbool.h>
	58
d9a64523 A	59	__BEGIN_DECLS
d9a64523 A	60
5ba3f43e A	61	#if defined(__arm__) \|\| defined(__arm64__)
	62	#include <arm/cpu_data_internal.h>
	63	#elif defined(__x86_64__)
	64	#include <i386/cpu_data.h>
	65	#else /* !defined(__arm__) && !defined(__arm64__) && !defined(__x86_64__) */
	66	#error unsupported architecture
	67	#endif /* !defined(__arm__) && !defined(__arm64__) && !defined(__x86_64__) */
	68
5ba3f43e A	69	void mt_update_fixed_counts(void);
	70	void mt_update_task(task_t task, thread_t thread);
	71	bool mt_update_thread(thread_t thread);
	72	int mt_fixed_thread_counts(thread_t thread, uint64_t *counts_out);
	73	int mt_fixed_task_counts(task_t task, uint64_t *counts_out);
	74
	75	/*
d9a64523	76	* Private API for the platform layers.
5ba3f43e	77	*/
5ba3f43e A	78
5ba3f43e A	79	/*
d9a64523 A	80	* Called once early in boot, before CPU initialization occurs (where
	81	* `mt_cpu_up` is called).
	82	*
	83	* This allows monotonic to detect if the hardware supports performance counters
	84	* and install the global PMI handler.
5ba3f43e	85	*/
d9a64523	86	void mt_early_init(void);
5ba3f43e A	87
	88	/*
	89	* Called when a core is idling and exiting from idle.
	90	*/
	91	void mt_cpu_idle(cpu_data_t *cpu);
	92	void mt_cpu_run(cpu_data_t *cpu);
	93
	94	/*
	95	* Called when a core is shutting down or powering up.
	96	*/
	97	void mt_cpu_down(cpu_data_t *cpu);
	98	void mt_cpu_up(cpu_data_t *cpu);
	99
	100	/*
d9a64523	101	* Called while single-threaded when the system is going to sleep.
5ba3f43e A	102	*/
5ba3f43e A	103	void mt_sleep(void);
d9a64523 A	104
	105	/*
	106	* Called on each CPU as the system is waking from sleep.
	107	*/
	108	void mt_wake_per_core(void);
	109
d9a64523 A	110	/*
	111	* "Up-call" to the Mach layer to update counters from a PMI.
	112	*/
	113	uint64_t mt_cpu_update_count(cpu_data_t *cpu, unsigned int ctr);
	114
	115	/*
	116	* Private API for the scheduler.
	117	*/
	118
	119	/*
	120	* Called when a thread is switching off-core or expires its quantum.
	121	*/
	122	void mt_sched_update(thread_t thread);
	123
	124	/*
	125	* Called when a thread is terminating to save its counters into the task. The
	126	* task lock must be held and the thread should be removed from the task's
	127	* thread list in that same critical section.
	128	*/
	129	void mt_terminate_update(task_t task, thread_t thread);
5ba3f43e A	130
	131	/*
	132	* Private API for the performance controller callout.
	133	*/
	134	void mt_perfcontrol(uint64_t instrs, uint64_t cycles);
	135
	136	/*
	137	* Private API for stackshot.
	138	*/
	139	void mt_stackshot_thread(thread_t thread, uint64_t instrs, uint64_t cycles);
	140	void mt_stackshot_task(task_t task, uint64_t instrs, uint64_t cycles);
	141
d9a64523 A	142	/*
	143	* Private API for microstackshot.
	144	*/
	145	typedef void (mt_pmi_fn)(bool user_mode, void ctx);
	146	int mt_microstackshot_start(unsigned int ctr, uint64_t period, mt_pmi_fn fn,
0a7de745	147	void *ctx);
d9a64523 A	148	int mt_microstackshot_stop(void);
	149
	150	__END_DECLS
	151
5ba3f43e A	152	#endif /* MACH_KERNEL_PRIVATE */
5ba3f43e A	153
cb323159 A	154	#endif /* MONOTONIC */
cb323159 A	155
5ba3f43e	156	#endif /* !defined(KERN_MONOTONIC_H) */