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#ifndef KPERF_ACTION_H
30#define KPERF_ACTION_H
31
32#include <mach/kern_return.h>
33#include <stdint.h>
34#include <stdbool.h>
35
36struct kperf_sample;
37struct kperf_usample;
38struct kperf_context;
39
40extern int kperf_max_actions;
41
42/* bits for defining what to do on an action */
43#define SAMPLER_TH_INFO (1U << 0)
44#define SAMPLER_TH_SNAPSHOT (1U << 1)
45#define SAMPLER_KSTACK (1U << 2)
46#define SAMPLER_USTACK (1U << 3)
47#define SAMPLER_PMC_THREAD (1U << 4)
48#define SAMPLER_PMC_CPU (1U << 5)
49#define SAMPLER_PMC_CONFIG (1U << 6)
50#define SAMPLER_MEMINFO (1U << 7)
51#define SAMPLER_TH_SCHEDULING (1U << 8)
52#define SAMPLER_TH_DISPATCH (1U << 9)
53#define SAMPLER_TK_SNAPSHOT (1U << 10)
54#define SAMPLER_SYS_MEM (1U << 11)
55#define SAMPLER_TH_INSCYC (1U << 12)
56#define SAMPLER_TK_INFO (1U << 13)
57#define SAMPLER_EXSTACK (1U << 14)
58
59#define SAMPLER_TASK_MASK (SAMPLER_MEMINFO | SAMPLER_TK_SNAPSHOT | \
60 SAMPLER_TK_INFO)
61#define SAMPLER_THREAD_MASK (SAMPLER_TH_INFO | SAMPLER_TH_SNAPSHOT | \
62 SAMPLER_KSTACK | SAMPLER_USTACK | SAMPLER_PMC_THREAD | \
63 SAMPLER_TH_SCHEDULING | SAMPLER_TH_DISPATCH | SAMPLER_TH_INSCYC | \
64 SAMPLER_EXSTACK)
65
66/* flags for sample calls */
67
68/* pend samplers requiring copyin until AST boundary */
69#define SAMPLE_FLAG_PEND_USER (1U << 0)
70/* sample idle threads */
71#define SAMPLE_FLAG_IDLE_THREADS (1U << 1)
72/* do not sample callstacks */
73#define SAMPLE_FLAG_EMPTY_CALLSTACK (1U << 2)
74/* use the continuation as a kernel backtrace */
75#define SAMPLE_FLAG_CONTINUATION (1U << 3)
76/* sample is occurring outside of interrupt context */
77#define SAMPLE_FLAG_NON_INTERRUPT (1U << 4)
78/* sample should include system samplers */
79#define SAMPLE_FLAG_SYSTEM (1U << 5)
80/* sample should not include non-system samplers */
81#define SAMPLE_FLAG_ONLY_SYSTEM (1U << 6)
82/* sample should only include task samplers */
83#define SAMPLE_FLAG_TASK_ONLY (1U << 7)
84/* sample should only include thread samplers */
85#define SAMPLE_FLAG_THREAD_ONLY (1U << 8)
86
87/* Take a sample into "sbuf" using current thread "cur_thread" */
88kern_return_t kperf_sample(struct kperf_sample *sbuf,
89 struct kperf_context *ctx,
90 unsigned actionid,
91 unsigned sample_flags);
92
93/*
94 * Sample user space.
95 */
96void kperf_sample_user(struct kperf_usample *sbuf, struct kperf_context *ctx,
97 unsigned int actionid, unsigned int sample_flags);
98
99/* during this sample, the thread was idle. set only if !SAMPLE_FLAG_IDLE_THREADS */
100#define SAMPLE_META_THREAD_WAS_IDLE (1U << 0)
101/* during this sample, a user callstack sample was pended */
102#define SAMPLE_META_UPEND (1U << 1)
103/* during this sample, an exclave callstack sample was pended */
104#define SAMPLE_META_EXPEND (1U << 2)
105
106/* Whether the action provided samples non-system values. */
107bool kperf_action_has_non_system(unsigned actionid);
108bool kperf_action_has_thread(unsigned int actionid);
109bool kperf_action_has_task(unsigned int actionid);
110
111/* return codes from taking a sample
112 * either keep trigger, or something went wrong (or we're shutting down)
113 * so turn off.
114 */
115#define SAMPLE_CONTINUE (0)
116#define SAMPLE_SHUTDOWN (1)
117#define SAMPLE_OFF (2)
118
119void kperf_action_reset(void);
120
121/* Interface functions */
122unsigned kperf_action_get_count(void);
123int kperf_action_set_count(unsigned count);
124
125int kperf_action_set_samplers(unsigned int actionid, uint32_t samplers);
126int kperf_action_get_samplers(unsigned int actionid, uint32_t *samplers_out);
127
128int kperf_action_set_userdata(unsigned int actionid, uint32_t userdata);
129int kperf_action_get_userdata(unsigned int actionid, uint32_t *userdata_out);
130
131int kperf_action_set_ucallstack_depth(unsigned int actionid, uint32_t depth);
132int kperf_action_get_ucallstack_depth(unsigned int actionid, uint32_t * depth_out);
133int kperf_action_set_kcallstack_depth(unsigned int actionid, uint32_t depth);
134int kperf_action_get_kcallstack_depth(unsigned int actionid, uint32_t * depth_out);
135
136int kperf_action_set_filter(unsigned int actionid, int pid);
137int kperf_action_get_filter(unsigned int actionid, int *pid_out);
138
139void kperf_kdebug_handler(uint32_t debugid, uintptr_t *starting_fp);
140
141/* whether to output tracepoints on context-switch */
142extern int kperf_kdebug_cswitch;
143int kperf_kdbg_cswitch_get(void);
144int kperf_kdbg_cswitch_set(int newval);
145
146#endif /* !defined(KPERF_ACTION_H) */
147