osfmk/kperf/callstack.h

   1 /*
   2  * Copyright (c) 2011 Apple Computer, 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 KPERF_CALLSTACK_H
  30 #define KPERF_CALLSTACK_H
  31
  32 #define MAX_CALLSTACK_FRAMES (128)
  33
  34 /* the callstack contains valid data */
  35 #define CALLSTACK_VALID        (1U << 0)
  36 /* the callstack has been deferred */
  37 #define CALLSTACK_DEFERRED     (1U << 1)
  38 /* the callstack is 64-bit */
  39 #define CALLSTACK_64BIT        (1U << 2)
  40 /* the callstack is from the kernel */
  41 #define CALLSTACK_KERNEL       (1U << 3)
  42 /* the callstack was cut off */
  43 #define CALLSTACK_TRUNCATED    (1U << 4)
  44 /* the callstack is only holding a continuation "frame" */
  45 #define CALLSTACK_CONTINUATION (1U << 5)
  46 /* the frames field is filled with uintptr_t, not uint64_t */
  47 #define CALLSTACK_KERNEL_WORDS (1U << 6)
  48
  49 struct callstack {
  50         uint32_t flags;
  51         uint32_t nframes;
  52         /* WARNING this can be uintptr_t instead if CALLSTACK_KERNEL_WORDS is set */
  53         uint64_t frames[MAX_CALLSTACK_FRAMES];
  54 };
  55
  56 struct kperf_context;
  57
  58 void kperf_kcallstack_sample(struct callstack *cs, struct kperf_context *);
  59 void kperf_kcallstack_log(struct callstack *cs);
  60 void kperf_continuation_sample(struct callstack *cs, struct kperf_context *);
  61 void kperf_backtrace_sample(struct callstack *cs, struct kperf_context *context);
  62
  63 void kperf_ucallstack_sample(struct callstack *cs, struct kperf_context *);
  64 int kperf_ucallstack_pend(struct kperf_context *, uint32_t depth);
  65 void kperf_ucallstack_log(struct callstack *cs);
  66
  67 #endif /* !defined(KPERF_CALLSTACK_H) */