xref: /xnu-11215.1.10/osfmk/kperf/kdebug_trigger.h (revision 8d741a5de7ff4191bf97d57b9f54c2f6d4a15585)
1*8d741a5dSApple OSS Distributions /*
2*8d741a5dSApple OSS Distributions  * Copyright (c) 2016 Apple Computer, Inc. All rights reserved.
3*8d741a5dSApple OSS Distributions  *
4*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*8d741a5dSApple OSS Distributions  *
6*8d741a5dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*8d741a5dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*8d741a5dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*8d741a5dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*8d741a5dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*8d741a5dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*8d741a5dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*8d741a5dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*8d741a5dSApple OSS Distributions  *
15*8d741a5dSApple OSS Distributions  * Please obtain a copy of the License at
16*8d741a5dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*8d741a5dSApple OSS Distributions  *
18*8d741a5dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*8d741a5dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*8d741a5dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*8d741a5dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*8d741a5dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*8d741a5dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*8d741a5dSApple OSS Distributions  * limitations under the License.
25*8d741a5dSApple OSS Distributions  *
26*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*8d741a5dSApple OSS Distributions  */
28*8d741a5dSApple OSS Distributions 
29*8d741a5dSApple OSS Distributions #ifndef KPERF_KDEBUG_TRIGGER_H
30*8d741a5dSApple OSS Distributions #define KPERF_KDEBUG_TRIGGER_H
31*8d741a5dSApple OSS Distributions 
32*8d741a5dSApple OSS Distributions #include <mach/boolean.h>
33*8d741a5dSApple OSS Distributions #include <stdint.h>
34*8d741a5dSApple OSS Distributions 
35*8d741a5dSApple OSS Distributions #define KPERF_KDEBUG_DEBUGIDS_MAX (32)
36*8d741a5dSApple OSS Distributions 
37*8d741a5dSApple OSS Distributions struct kperf_kdebug_filter;
38*8d741a5dSApple OSS Distributions 
39*8d741a5dSApple OSS Distributions #define KPERF_KDEBUG_FILTER_SIZE(N_DEBUGIDS) ((2 * sizeof(uint64_t)) + ((N_DEBUGIDS) * sizeof(uint32_t)))
40*8d741a5dSApple OSS Distributions /* UNSAFE */
41*8d741a5dSApple OSS Distributions #define KPERF_KDEBUG_N_DEBUGIDS(FILTER_SIZE) \
42*8d741a5dSApple OSS Distributions 	(((FILTER_SIZE) <= (2 * sizeof(uint64_t))) ? 0 : \
43*8d741a5dSApple OSS Distributions 	  (((FILTER_SIZE) - (2 * sizeof(uint64_t))) / sizeof(uint32_t)))
44*8d741a5dSApple OSS Distributions 
45*8d741a5dSApple OSS Distributions void kperf_kdebug_setup(void);
46*8d741a5dSApple OSS Distributions void kperf_kdebug_reset(void);
47*8d741a5dSApple OSS Distributions 
48*8d741a5dSApple OSS Distributions boolean_t kperf_kdebug_should_trigger(uint32_t debugid);
49*8d741a5dSApple OSS Distributions 
50*8d741a5dSApple OSS Distributions int kperf_kdebug_set_action(int action_id);
51*8d741a5dSApple OSS Distributions int kperf_kdebug_get_action(void);
52*8d741a5dSApple OSS Distributions 
53*8d741a5dSApple OSS Distributions int kperf_kdebug_set_n_debugids(uint32_t n_debugids_in);
54*8d741a5dSApple OSS Distributions int kperf_kdebug_set_filter(user_addr_t user_filter, uint32_t user_size);
55*8d741a5dSApple OSS Distributions uint32_t kperf_kdebug_get_filter(struct kperf_kdebug_filter **filter);
56*8d741a5dSApple OSS Distributions 
57*8d741a5dSApple OSS Distributions #endif /* !defined(KPERF_KDEBUG_TRIGGER_H) */
58