osfmk/kperf/kdebug_trigger.h

   1 /*
   2  * Copyright (c) 2016 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_KDEBUG_TRIGGER_H
  30 #define KPERF_KDEBUG_TRIGGER_H
  31
  32 #include <mach/boolean.h>
  33 #include <stdint.h>
  34
  35 #define KPERF_KDEBUG_DEBUGIDS_MAX (32)
  36
  37 struct kperf_kdebug_filter;
  38
  39 #define KPERF_KDEBUG_FILTER_SIZE(N_DEBUGIDS) ((2 * sizeof(uint64_t)) + ((N_DEBUGIDS) * sizeof(uint32_t)))
  40 /* UNSAFE */
  41 #define KPERF_KDEBUG_N_DEBUGIDS(FILTER_SIZE) \
  42         (((FILTER_SIZE) <= (2 * sizeof(uint64_t))) ? 0 : \
  43           (((FILTER_SIZE) - (2 * sizeof(uint64_t))) / sizeof(uint32_t)))
  44
  45 int kperf_kdebug_init(void);
  46 void kperf_kdebug_reset(void);
  47
  48 boolean_t kperf_kdebug_should_trigger(uint32_t debugid);
  49
  50 int kperf_kdebug_set_action(int action_id);
  51 int kperf_kdebug_get_action(void);
  52
  53 int kperf_kdebug_set_n_debugids(uint32_t n_debugids_in);
  54 int kperf_kdebug_set_filter(user_addr_t user_filter, uint32_t user_size);
  55 uint32_t kperf_kdebug_get_filter(struct kperf_kdebug_filter **filter);
  56
  57 #endif /* !defined(KPERF_KDEBUG_TRIGGER_H) */