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