1*e3723e1fSApple OSS Distributions /* 2*e3723e1fSApple OSS Distributions * Copyright (c) 2014 Apple Inc. All rights reserved. 3*e3723e1fSApple OSS Distributions * 4*e3723e1fSApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*e3723e1fSApple OSS Distributions * 6*e3723e1fSApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*e3723e1fSApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*e3723e1fSApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*e3723e1fSApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*e3723e1fSApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*e3723e1fSApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*e3723e1fSApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*e3723e1fSApple OSS Distributions * terms of an Apple operating system software license agreement. 14*e3723e1fSApple OSS Distributions * 15*e3723e1fSApple OSS Distributions * Please obtain a copy of the License at 16*e3723e1fSApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*e3723e1fSApple OSS Distributions * 18*e3723e1fSApple OSS Distributions * The Original Code and all software distributed under the License are 19*e3723e1fSApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*e3723e1fSApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*e3723e1fSApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*e3723e1fSApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*e3723e1fSApple OSS Distributions * Please see the License for the specific language governing rights and 24*e3723e1fSApple OSS Distributions * limitations under the License. 25*e3723e1fSApple OSS Distributions * 26*e3723e1fSApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*e3723e1fSApple OSS Distributions */ 28*e3723e1fSApple OSS Distributions 29*e3723e1fSApple OSS Distributions #ifndef _SYS_STACKSHOT_H 30*e3723e1fSApple OSS Distributions #define _SYS_STACKSHOT_H 31*e3723e1fSApple OSS Distributions 32*e3723e1fSApple OSS Distributions #include <stdint.h> 33*e3723e1fSApple OSS Distributions 34*e3723e1fSApple OSS Distributions #define STACKSHOT_CONFIG_TYPE 1 35*e3723e1fSApple OSS Distributions 36*e3723e1fSApple OSS Distributions typedef struct stackshot_config { 37*e3723e1fSApple OSS Distributions /* Input options */ 38*e3723e1fSApple OSS Distributions int sc_pid; /* PID to trace, or -1 for the entire system */ 39*e3723e1fSApple OSS Distributions uint64_t sc_flags; /* Stackshot flags */ 40*e3723e1fSApple OSS Distributions uint64_t sc_delta_timestamp; /* Retrieve a delta stackshot of system state that has changed since this time */ 41*e3723e1fSApple OSS Distributions 42*e3723e1fSApple OSS Distributions /* Stackshot results */ 43*e3723e1fSApple OSS Distributions uint64_t sc_buffer; /* Pointer to stackshot buffer */ 44*e3723e1fSApple OSS Distributions uint32_t sc_size; /* Length of the stackshot buffer */ 45*e3723e1fSApple OSS Distributions 46*e3723e1fSApple OSS Distributions /* Internals */ 47*e3723e1fSApple OSS Distributions uint64_t sc_out_buffer_addr; /* Location where the kernel should copy the address of the newly mapped buffer in user space */ 48*e3723e1fSApple OSS Distributions uint64_t sc_out_size_addr; /* Location where the kernel should copy the size of the stackshot buffer */ 49*e3723e1fSApple OSS Distributions uint64_t sc_pagetable_mask; /* Mask of page table levels to dump, must pass STACKSHOT_PAGE_TABLES */ 50*e3723e1fSApple OSS Distributions } stackshot_config_t; 51*e3723e1fSApple OSS Distributions 52*e3723e1fSApple OSS Distributions typedef struct stackshot_stats { 53*e3723e1fSApple OSS Distributions uint64_t ss_last_start; /* mach_absolute_time of last start */ 54*e3723e1fSApple OSS Distributions uint64_t ss_last_end; /* mach_absolute_time of last end */ 55*e3723e1fSApple OSS Distributions uint64_t ss_count; /* count of stackshots taken */ 56*e3723e1fSApple OSS Distributions uint64_t ss_duration; /* sum(mach_absolute_time) of taken stackshots */ 57*e3723e1fSApple OSS Distributions } stackshot_stats_t; 58*e3723e1fSApple OSS Distributions 59*e3723e1fSApple OSS Distributions #ifndef KERNEL 60*e3723e1fSApple OSS Distributions 61*e3723e1fSApple OSS Distributions stackshot_config_t * stackshot_config_create(void); 62*e3723e1fSApple OSS Distributions int stackshot_config_set_pid(stackshot_config_t * stackshot_config, int pid); 63*e3723e1fSApple OSS Distributions int stackshot_config_set_flags(stackshot_config_t * stackshot_config, uint64_t flags); 64*e3723e1fSApple OSS Distributions int stackshot_capture_with_config(stackshot_config_t * stackshot_config); 65*e3723e1fSApple OSS Distributions void * stackshot_config_get_stackshot_buffer(stackshot_config_t * stackshot_config); 66*e3723e1fSApple OSS Distributions uint32_t stackshot_config_get_stackshot_size(stackshot_config_t * stackshot_config); 67*e3723e1fSApple OSS Distributions int stackshot_config_set_size_hint(stackshot_config_t * stackshot_config, uint32_t suggested_size); 68*e3723e1fSApple OSS Distributions int stackshot_config_set_delta_timestamp(stackshot_config_t * stackshot_config, uint64_t delta_timestamp); 69*e3723e1fSApple OSS Distributions int stackshot_config_set_pagetable_mask(stackshot_config_t * stackshot_config, uint32_t mask); 70*e3723e1fSApple OSS Distributions int stackshot_config_dealloc_buffer(stackshot_config_t * stackshot_config); 71*e3723e1fSApple OSS Distributions int stackshot_config_dealloc(stackshot_config_t * stackshot_config); 72*e3723e1fSApple OSS Distributions 73*e3723e1fSApple OSS Distributions #endif /* ! KERNEL */ 74*e3723e1fSApple OSS Distributions 75*e3723e1fSApple OSS Distributions #endif /* _SYS_STACKSHOT_H */ 76