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