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