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