osfmk/kperf/action.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 /* fwd decl */
  30 struct kperf_sample;
  31 struct kperf_context;
  32
  33
  34 /* bits for defining what to do on an action */
  35 #define SAMPLER_TINFO    (1<<0)
  36 #define SAMPLER_TINFOEX  (1<<1)
  37 #define SAMPLER_KSTACK   (1<<2)
  38 #define SAMPLER_USTACK   (1<<3)
  39
  40 /*  Take a sample into "sbuf" using current thread "cur_thread" */
  41 extern kern_return_t kperf_sample( struct kperf_sample *sbuf,
  42                                    struct kperf_context*,
  43                                    unsigned actionid,
  44                                    boolean_t pend_user );
  45
  46 /* return codes from taking a sample
  47  * either keep trigger, or something went wrong (or we're shutting down)
  48  * so turn off.
  49  */
  50 #define SAMPLE_CONTINUE (0)
  51 #define SAMPLE_SHUTDOWN (1)
  52
  53 /* Get the sample buffer to use from interrupt handler context. Only
  54  * valid in interrupt contexts.
  55  */
  56 extern struct kperf_sample* kperf_intr_sample_buffer(void);
  57
  58 /* Interface functions  */
  59 extern unsigned kperf_action_get_count(void);
  60 extern int kperf_action_set_count(unsigned count);
  61
  62 extern int kperf_action_set_samplers( unsigned actionid,
  63                                       uint32_t samplers );
  64 extern int kperf_action_get_samplers( unsigned actionid,
  65                                       uint32_t *samplers_out );
  66
  67 extern void
  68 kperf_thread_ast_handler( thread_t thread );