1/* 2 * Copyright (c) 2011 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/* fwd decl */ 30struct kperf_sample; 31struct kperf_context; 32 33 34/* bits for defining what to do on an action */ 35#define SAMPLER_TINFO (1<<0) 36#define SAMPLER_TINFOEX (1<<1) 37#define SAMPLER_KSTACK (1<<2) 38#define SAMPLER_USTACK (1<<3) 39#define SAMPLER_PMC_THREAD (1<<4) /* FIXME: not implemented */ 40#define SAMPLER_PMC_CPU (1<<5) 41#define SAMPLER_PMC_CONFIG (1<<6) 42 43/* flags for sample calls*/ 44#define SAMPLE_FLAG_PEND_USER (1<<0) 45#define SAMPLE_FLAG_IDLE_THREADS (1<<1) 46#define SAMPLE_FLAG_EMPTY_CALLSTACK (1<<2) 47 48/* Take a sample into "sbuf" using current thread "cur_thread" */ 49extern kern_return_t kperf_sample( struct kperf_sample *sbuf, 50 struct kperf_context*, 51 unsigned actionid, 52 unsigned sample_flags ); 53 54/* return codes from taking a sample 55 * either keep trigger, or something went wrong (or we're shutting down) 56 * so turn off. 57 */ 58#define SAMPLE_CONTINUE (0) 59#define SAMPLE_SHUTDOWN (1) 60#define SAMPLE_OFF (2) 61 62/* Get the sample buffer to use from interrupt handler context. Only 63 * valid in interrupt contexts. 64 */ 65extern struct kperf_sample* kperf_intr_sample_buffer(void); 66 67/* Interface functions */ 68extern unsigned kperf_action_get_count(void); 69extern int kperf_action_set_count(unsigned count); 70 71extern int kperf_action_set_samplers( unsigned actionid, 72 uint32_t samplers ); 73extern int kperf_action_get_samplers( unsigned actionid, 74 uint32_t *samplers_out ); 75 76extern int kperf_action_set_userdata( unsigned actionid, 77 uint32_t userdata ); 78extern int kperf_action_get_userdata( unsigned actionid, 79 uint32_t *userdata_out ); 80 81extern int kperf_action_set_filter( unsigned actionid, 82 int pid ); 83extern int kperf_action_get_filter( unsigned actionid, 84 int *pid_out ); 85