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