bsd/sys/kdebug_signpost.h

   1 /*
   2  * Copyright (c) 2016 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 BSD_SYS_KDEBUG_SIGNPOST_H
  30 #define BSD_SYS_KDEBUG_SIGNPOST_H
  31
  32 #include <Availability.h>
  33 #include <stdint.h>
  34 #include <sys/cdefs.h>
  35
  36 __BEGIN_DECLS
  37
  38 #ifndef KERNEL
  39
  40 /*
  41  * In previous versions of the operating system, applications could use:
  42  *
  43  * syscall(SYS_kdebug_trace, APPSDBG_CODE(DBG_MACH_CHUD, <your event code>) | DBG_FUNC_<type>, arg1, arg2, arg3, arg4);
  44  *
  45  * to record events that would be displayed by Instruments.
  46  *
  47  * syscall(2) is now deprecated and this interface replaces the above call as follows:
  48  *
  49  * The code argument is <your event code>.  Only the low 14-bits of the code are
  50  * preserved.
  51  */
  52
  53 /*
  54  * When <type> is NONE, use kdebug_signpost.
  55  */
  56 int kdebug_signpost(uint32_t code, uintptr_t arg1, uintptr_t arg2,  uintptr_t arg3,  uintptr_t arg4)
  57         __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0);
  58
  59 /*
  60  * When <type> is START, use kdebug_signpost_start.
  61  */
  62 int kdebug_signpost_start(uint32_t code, uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4)
  63         __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0);
  64
  65 /*
  66  * When <type> is END, use kdebug_signpost_end.
  67  */
  68 int kdebug_signpost_end(uint32_t code, uintptr_t arg1, uintptr_t arg2, uintptr_t arg3, uintptr_t arg4)
  69         __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0);
  70
  71 #endif /* !KERNEL */
  72
  73 __END_DECLS
  74
  75 #endif /* !BSD_SYS_KDEBUG_SIGNPOST_H */