xref: /xnu-11215/bsd/sys/kdebug_signpost.h (revision a5e72196)
1 /*
2  * Copyright (c) 2016-2019 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  * kdebug_signpost(2) is deprecated.  Use the os_signpost(3) family of tracing
42  * functions, instead.
43  */
44 
45 int kdebug_signpost(uint32_t code, uintptr_t arg1, uintptr_t arg2,
46     uintptr_t arg3, uintptr_t arg4)
47 __API_DEPRECATED_WITH_REPLACEMENT("os_signpost_event_emit",
48     macos(10.12, 10.15), ios(10.0, 13.0), watchos(3.0, 6.0), tvos(10.0, 13.0));
49 
50 int kdebug_signpost_start(uint32_t code, uintptr_t arg1, uintptr_t arg2,
51     uintptr_t arg3, uintptr_t arg4)
52 __API_DEPRECATED_WITH_REPLACEMENT("os_signpost_interval_begin",
53     macos(10.12, 10.15), ios(10.0, 13.0), watchos(3.0, 6.0), tvos(10.0, 13.0));
54 
55 int kdebug_signpost_end(uint32_t code, uintptr_t arg1, uintptr_t arg2,
56     uintptr_t arg3, uintptr_t arg4)
57 __API_DEPRECATED_WITH_REPLACEMENT("os_signpost_interval_end",
58     macos(10.12, 10.15), ios(10.0, 13.0), watchos(3.0, 6.0), tvos(10.0, 13.0));
59 
60 #endif /* !KERNEL */
61 
62 __END_DECLS
63 
64 #endif /* !BSD_SYS_KDEBUG_SIGNPOST_H */
65