1 | /* |
2 | * Copyright (c) 2021 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 _SYSTEM_EVENT_LOG_H_ |
30 | #define _SYSTEM_EVENT_LOG_H_ |
31 | |
32 | #include <Availability.h> |
33 | #include <sys/cdefs.h> |
34 | #include <stdint.h> |
35 | |
36 | __BEGIN_DECLS |
37 | |
38 | #define SYSTEM_EVENT_ENTITLEMENT "com.apple.private.record_system_event" |
39 | |
40 | // These arbitrary numbers are used to limit the size of the system event message. |
41 | // We don't want the messages to be too long, as they're going over serial. |
42 | #define SYSTEM_EVENT_EVENT_MAX 64 |
43 | #define SYSTEM_EVENT_PAYLOAD_MAX 96 |
44 | |
45 | __enum_decl(system_event_type, uint8_t, { |
46 | SYSTEM_EVENT_TYPE_FIRST = 0, |
47 | SYSTEM_EVENT_TYPE_INFO, |
48 | SYSTEM_EVENT_TYPE_ERROR, |
49 | SYSTEM_EVENT_TYPE_LAST |
50 | }); |
51 | |
52 | __enum_decl(system_event_subsystem, uint8_t, { |
53 | SYSTEM_EVENT_SUBSYSTEM_FIRST = 0, |
54 | SYSTEM_EVENT_SUBSYSTEM_LAUNCHD, |
55 | SYSTEM_EVENT_SUBSYSTEM_TEST, |
56 | SYSTEM_EVENT_SUBSYSTEM_NVRAM, |
57 | SYSTEM_EVENT_SUBSYSTEM_PROCESS, |
58 | SYSTEM_EVENT_SUBSYSTEM_PMRD, |
59 | SYSTEM_EVENT_SUBSYSTEM_LAST |
60 | }); |
61 | |
62 | #ifndef KERNEL |
63 | |
64 | /* |
65 | * Known subsystems can use this to emit system event transition logging messages in |
66 | * a structured and understandable way. |
67 | */ |
68 | |
69 | __WATCHOS_AVAILABLE(9.0) __OSX_AVAILABLE(13.0) __IOS_AVAILABLE(16.0) __TVOS_AVAILABLE(16.0) |
70 | int |
71 | record_system_event_as_kernel(system_event_type type, system_event_subsystem subsystem, const char *event, |
72 | const char *payload); |
73 | |
74 | #endif /* !KERNEL */ |
75 | |
76 | __END_DECLS |
77 | |
78 | #endif /* _SYSTEM_EVENT_LOG_H_ */ |
79 | |