1*e3723e1fSApple OSS Distributions /* 2*e3723e1fSApple OSS Distributions * Copyright (c) 2021 Apple Inc. All rights reserved. 3*e3723e1fSApple OSS Distributions * 4*e3723e1fSApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*e3723e1fSApple OSS Distributions * 6*e3723e1fSApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*e3723e1fSApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*e3723e1fSApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*e3723e1fSApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*e3723e1fSApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*e3723e1fSApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*e3723e1fSApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*e3723e1fSApple OSS Distributions * terms of an Apple operating system software license agreement. 14*e3723e1fSApple OSS Distributions * 15*e3723e1fSApple OSS Distributions * Please obtain a copy of the License at 16*e3723e1fSApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*e3723e1fSApple OSS Distributions * 18*e3723e1fSApple OSS Distributions * The Original Code and all software distributed under the License are 19*e3723e1fSApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*e3723e1fSApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*e3723e1fSApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*e3723e1fSApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*e3723e1fSApple OSS Distributions * Please see the License for the specific language governing rights and 24*e3723e1fSApple OSS Distributions * limitations under the License. 25*e3723e1fSApple OSS Distributions * 26*e3723e1fSApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*e3723e1fSApple OSS Distributions */ 28*e3723e1fSApple OSS Distributions 29*e3723e1fSApple OSS Distributions #ifndef _SYSTEM_EVENT_LOG_H_ 30*e3723e1fSApple OSS Distributions #define _SYSTEM_EVENT_LOG_H_ 31*e3723e1fSApple OSS Distributions 32*e3723e1fSApple OSS Distributions #include <Availability.h> 33*e3723e1fSApple OSS Distributions #include <sys/cdefs.h> 34*e3723e1fSApple OSS Distributions #include <stdint.h> 35*e3723e1fSApple OSS Distributions 36*e3723e1fSApple OSS Distributions __BEGIN_DECLS 37*e3723e1fSApple OSS Distributions 38*e3723e1fSApple OSS Distributions #define SYSTEM_EVENT_ENTITLEMENT "com.apple.private.record_system_event" 39*e3723e1fSApple OSS Distributions 40*e3723e1fSApple OSS Distributions // These arbitrary numbers are used to limit the size of the system event message. 41*e3723e1fSApple OSS Distributions // We don't want the messages to be too long, as they're going over serial. 42*e3723e1fSApple OSS Distributions #define SYSTEM_EVENT_EVENT_MAX 64 43*e3723e1fSApple OSS Distributions #define SYSTEM_EVENT_PAYLOAD_MAX 96 44*e3723e1fSApple OSS Distributions 45*e3723e1fSApple OSS Distributions __enum_decl(system_event_type, uint8_t, { 46*e3723e1fSApple OSS Distributions SYSTEM_EVENT_TYPE_FIRST = 0, 47*e3723e1fSApple OSS Distributions SYSTEM_EVENT_TYPE_INFO, 48*e3723e1fSApple OSS Distributions SYSTEM_EVENT_TYPE_ERROR, 49*e3723e1fSApple OSS Distributions SYSTEM_EVENT_TYPE_LAST 50*e3723e1fSApple OSS Distributions }); 51*e3723e1fSApple OSS Distributions 52*e3723e1fSApple OSS Distributions __enum_decl(system_event_subsystem, uint8_t, { 53*e3723e1fSApple OSS Distributions SYSTEM_EVENT_SUBSYSTEM_FIRST = 0, 54*e3723e1fSApple OSS Distributions SYSTEM_EVENT_SUBSYSTEM_LAUNCHD, 55*e3723e1fSApple OSS Distributions SYSTEM_EVENT_SUBSYSTEM_TEST, 56*e3723e1fSApple OSS Distributions SYSTEM_EVENT_SUBSYSTEM_NVRAM, 57*e3723e1fSApple OSS Distributions SYSTEM_EVENT_SUBSYSTEM_PROCESS, 58*e3723e1fSApple OSS Distributions SYSTEM_EVENT_SUBSYSTEM_PMRD, 59*e3723e1fSApple OSS Distributions SYSTEM_EVENT_SUBSYSTEM_LAST 60*e3723e1fSApple OSS Distributions }); 61*e3723e1fSApple OSS Distributions 62*e3723e1fSApple OSS Distributions #ifndef KERNEL 63*e3723e1fSApple OSS Distributions 64*e3723e1fSApple OSS Distributions /* 65*e3723e1fSApple OSS Distributions * Known subsystems can use this to emit system event transition logging messages in 66*e3723e1fSApple OSS Distributions * a structured and understandable way. 67*e3723e1fSApple OSS Distributions */ 68*e3723e1fSApple OSS Distributions 69*e3723e1fSApple OSS Distributions __WATCHOS_AVAILABLE(9.0) __OSX_AVAILABLE(13.0) __IOS_AVAILABLE(16.0) __TVOS_AVAILABLE(16.0) 70*e3723e1fSApple OSS Distributions int 71*e3723e1fSApple OSS Distributions record_system_event_as_kernel(system_event_type type, system_event_subsystem subsystem, const char *event, 72*e3723e1fSApple OSS Distributions const char *payload); 73*e3723e1fSApple OSS Distributions 74*e3723e1fSApple OSS Distributions #endif /* !KERNEL */ 75*e3723e1fSApple OSS Distributions 76*e3723e1fSApple OSS Distributions __END_DECLS 77*e3723e1fSApple OSS Distributions 78*e3723e1fSApple OSS Distributions #endif /* _SYSTEM_EVENT_LOG_H_ */ 79