1*43a90889SApple OSS Distributions /* 2*43a90889SApple OSS Distributions * Copyright (c) 2015 Apple Inc. All rights reserved. 3*43a90889SApple OSS Distributions * 4*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*43a90889SApple OSS Distributions * 6*43a90889SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*43a90889SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*43a90889SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*43a90889SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*43a90889SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*43a90889SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*43a90889SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*43a90889SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*43a90889SApple OSS Distributions * 15*43a90889SApple OSS Distributions * Please obtain a copy of the License at 16*43a90889SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*43a90889SApple OSS Distributions * 18*43a90889SApple OSS Distributions * The Original Code and all software distributed under the License are 19*43a90889SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*43a90889SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*43a90889SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*43a90889SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*43a90889SApple OSS Distributions * Please see the License for the specific language governing rights and 24*43a90889SApple OSS Distributions * limitations under the License. 25*43a90889SApple OSS Distributions * 26*43a90889SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*43a90889SApple OSS Distributions */ 28*43a90889SApple OSS Distributions 29*43a90889SApple OSS Distributions #ifndef SYS_KTRACE_H 30*43a90889SApple OSS Distributions #define SYS_KTRACE_H 31*43a90889SApple OSS Distributions 32*43a90889SApple OSS Distributions #include <stdint.h> 33*43a90889SApple OSS Distributions #include <os/base.h> 34*43a90889SApple OSS Distributions #include <kern/locks.h> 35*43a90889SApple OSS Distributions 36*43a90889SApple OSS Distributions __enum_decl(ktrace_state_t, unsigned int, { 37*43a90889SApple OSS Distributions /* No tool has configured ktrace. */ 38*43a90889SApple OSS Distributions KTRACE_STATE_OFF = 0, 39*43a90889SApple OSS Distributions /* A foreground tool has configured ktrace. */ 40*43a90889SApple OSS Distributions KTRACE_STATE_FG, 41*43a90889SApple OSS Distributions /* A background tool has configured ktrace. */ 42*43a90889SApple OSS Distributions KTRACE_STATE_BG, 43*43a90889SApple OSS Distributions }); 44*43a90889SApple OSS Distributions 45*43a90889SApple OSS Distributions void ktrace_lock(void); 46*43a90889SApple OSS Distributions void ktrace_unlock(void); 47*43a90889SApple OSS Distributions void ktrace_assert_lock_held(void); 48*43a90889SApple OSS Distributions void ktrace_start_single_threaded(void); 49*43a90889SApple OSS Distributions void ktrace_end_single_threaded(void); 50*43a90889SApple OSS Distributions 51*43a90889SApple OSS Distributions /* 52*43a90889SApple OSS Distributions * Subsystems that use ktrace to manage ownership. These values are passed as 53*43a90889SApple OSS Distributions * part of the `*_mask` arguments in `ktrace_configure` and `ktrace_reset`. 54*43a90889SApple OSS Distributions */ 55*43a90889SApple OSS Distributions #define KTRACE_KDEBUG (1 << 0) 56*43a90889SApple OSS Distributions #define KTRACE_KPERF (1 << 1) 57*43a90889SApple OSS Distributions 58*43a90889SApple OSS Distributions /* 59*43a90889SApple OSS Distributions * Used by subsystems to inform ktrace that a configuration is occurring. 60*43a90889SApple OSS Distributions * Validates whether the current process has privileges to configure 61*43a90889SApple OSS Distributions * ktrace. Pass the subsystem(s) being configured in config_mask. 62*43a90889SApple OSS Distributions * 63*43a90889SApple OSS Distributions * `ktrace_lock` must be held. 64*43a90889SApple OSS Distributions * 65*43a90889SApple OSS Distributions * Returns 0 if configuration is allowed, EPERM if process is not privileged, 66*43a90889SApple OSS Distributions * and EBUSY if ktrace is owned by another process. 67*43a90889SApple OSS Distributions */ 68*43a90889SApple OSS Distributions int ktrace_configure(uint32_t config_mask); 69*43a90889SApple OSS Distributions 70*43a90889SApple OSS Distributions /* 71*43a90889SApple OSS Distributions * Tell ktrace to reset a configuration. Pass the susbsystem(s) that are to 72*43a90889SApple OSS Distributions * be reset in the reset_mask. 73*43a90889SApple OSS Distributions * 74*43a90889SApple OSS Distributions * `ktrace_lock` must be held. 75*43a90889SApple OSS Distributions */ 76*43a90889SApple OSS Distributions void ktrace_reset(uint32_t reset_mask); 77*43a90889SApple OSS Distributions 78*43a90889SApple OSS Distributions /* 79*43a90889SApple OSS Distributions * Determine if the current process can read the configuration of ktrace. 80*43a90889SApple OSS Distributions * Only the owning process or a root privileged process is allowed. 81*43a90889SApple OSS Distributions * 82*43a90889SApple OSS Distributions * `ktrace_lock` must be held. 83*43a90889SApple OSS Distributions * 84*43a90889SApple OSS Distributions * Returns 0 if allowed, EPERM otherwise. 85*43a90889SApple OSS Distributions */ 86*43a90889SApple OSS Distributions int ktrace_read_check(void); 87*43a90889SApple OSS Distributions 88*43a90889SApple OSS Distributions /* 89*43a90889SApple OSS Distributions * With certain boot-args, the kernel can start tracing without user space 90*43a90889SApple OSS Distributions * intervention. With `trace=<n_events>`, the kernel will start tracing at 91*43a90889SApple OSS Distributions * boot. With `trace_wake=<n_events>`, the kernel will start tracing on the 92*43a90889SApple OSS Distributions * wake path out of hibernation (on Intel only). 93*43a90889SApple OSS Distributions * 94*43a90889SApple OSS Distributions * In these cases, ktrace must be aware of the state changes. This function 95*43a90889SApple OSS Distributions * should be called whenever the kernel initiates configuring ktrace. 96*43a90889SApple OSS Distributions * 97*43a90889SApple OSS Distributions * `ktrace_lock` must be held. 98*43a90889SApple OSS Distributions */ 99*43a90889SApple OSS Distributions void ktrace_kernel_configure(uint32_t config_mask); 100*43a90889SApple OSS Distributions 101*43a90889SApple OSS Distributions /* 102*43a90889SApple OSS Distributions * This KPI allows kernel systems to disable ktrace. ktrace will only be 103*43a90889SApple OSS Distributions * disabled if the state matches the provided state_to_match. 104*43a90889SApple OSS Distributions * 105*43a90889SApple OSS Distributions * This does not reset the configuration of any subsystems -- it just makes 106*43a90889SApple OSS Distributions * them stop logging events or sampling data. 107*43a90889SApple OSS Distributions * 108*43a90889SApple OSS Distributions * `ktrace_lock` must be held. 109*43a90889SApple OSS Distributions */ 110*43a90889SApple OSS Distributions void ktrace_disable(ktrace_state_t state_to_match); 111*43a90889SApple OSS Distributions 112*43a90889SApple OSS Distributions /* 113*43a90889SApple OSS Distributions * Returns the pid of the process that owns ktrace. If ktrace is unowned, 114*43a90889SApple OSS Distributions * returns 0. 115*43a90889SApple OSS Distributions * 116*43a90889SApple OSS Distributions * `ktrace_lock` must be held. 117*43a90889SApple OSS Distributions */ 118*43a90889SApple OSS Distributions int ktrace_get_owning_pid(void); 119*43a90889SApple OSS Distributions 120*43a90889SApple OSS Distributions /* 121*43a90889SApple OSS Distributions * Returns true if background tracing is active, false otherwise. 122*43a90889SApple OSS Distributions * 123*43a90889SApple OSS Distributions * `ktrace_lock` must be held. 124*43a90889SApple OSS Distributions */ 125*43a90889SApple OSS Distributions bool ktrace_background_active(void); 126*43a90889SApple OSS Distributions 127*43a90889SApple OSS Distributions /* 128*43a90889SApple OSS Distributions * These functions exist for the transition for kperf to allow blessing other 129*43a90889SApple OSS Distributions * processes. They should not be used by other clients. 130*43a90889SApple OSS Distributions */ 131*43a90889SApple OSS Distributions extern bool ktrace_keep_ownership_on_reset; 132*43a90889SApple OSS Distributions extern int ktrace_root_set_owner_allowed; 133*43a90889SApple OSS Distributions int ktrace_set_owning_pid(int pid); 134*43a90889SApple OSS Distributions 135*43a90889SApple OSS Distributions #endif /* SYS_KTRACE_H */ 136