bsd/sys/stackshot.h

   1 /*
   2  * Copyright (c) 2014 Apple 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 #ifndef _SYS_STACKSHOT_H
  30 #define _SYS_STACKSHOT_H
  31
  32 #include <stdint.h>
  33
  34 #define STACKSHOT_CONFIG_TYPE 1
  35
  36 typedef struct stackshot_config {
  37         /* Input options */
  38         int             sc_pid;                 /* PID to trace, or -1 for the entire system */
  39         uint64_t        sc_flags;               /* Stackshot flags */
  40         uint64_t        sc_delta_timestamp;     /* Retrieve a delta stackshot of system state that has changed since this time */
  41
  42         /* Stackshot results */
  43         uint64_t        sc_buffer;              /* Pointer to stackshot buffer */
  44         uint32_t        sc_size;                /* Length of the stackshot buffer */
  45
  46         /* Internals */
  47         uint64_t        sc_out_buffer_addr;     /* Location where the kernel should copy the address of the newly mapped buffer in user space */
  48         uint64_t        sc_out_size_addr;       /* Location where the kernel should copy the size of the stackshot buffer */
  49         uint64_t                sc_pagetable_mask;      /* Mask of page table levels to dump, must pass STACKSHOT_PAGE_TABLES */
  50 } stackshot_config_t;
  51
  52 #ifndef KERNEL
  53
  54 stackshot_config_t * stackshot_config_create(void);
  55 int stackshot_config_set_pid(stackshot_config_t * stackshot_config, int pid);
  56 int stackshot_config_set_flags(stackshot_config_t * stackshot_config, uint64_t flags);
  57 int stackshot_capture_with_config(stackshot_config_t * stackshot_config);
  58 void * stackshot_config_get_stackshot_buffer(stackshot_config_t * stackshot_config);
  59 uint32_t stackshot_config_get_stackshot_size(stackshot_config_t * stackshot_config);
  60 int stackshot_config_set_size_hint(stackshot_config_t * stackshot_config, uint32_t suggested_size);
  61 int stackshot_config_set_delta_timestamp(stackshot_config_t * stackshot_config, uint64_t delta_timestamp);
  62 int stackshot_config_set_pagetable_mask(stackshot_config_t * stackshot_config, uint32_t mask);
  63 int stackshot_config_dealloc_buffer(stackshot_config_t * stackshot_config);
  64 int stackshot_config_dealloc(stackshot_config_t * stackshot_config);
  65
  66 #endif /* ! KERNEL */
  67
  68 #endif /* _SYS_STACKSHOT_H */