1*f6217f89SApple OSS Distributions /* 2*f6217f89SApple OSS Distributions * Copyright (c) 2015-2024 Apple Inc. All rights reserved. 3*f6217f89SApple OSS Distributions * 4*f6217f89SApple OSS Distributions * @APPLE_LICENSE_HEADER_START@ 5*f6217f89SApple OSS Distributions * 6*f6217f89SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*f6217f89SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*f6217f89SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*f6217f89SApple OSS Distributions * compliance with the License. Please obtain a copy of the License at 10*f6217f89SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this 11*f6217f89SApple OSS Distributions * file. 12*f6217f89SApple OSS Distributions * 13*f6217f89SApple OSS Distributions * The Original Code and all software distributed under the License are 14*f6217f89SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 15*f6217f89SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 16*f6217f89SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 17*f6217f89SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 18*f6217f89SApple OSS Distributions * Please see the License for the specific language governing rights and 19*f6217f89SApple OSS Distributions * limitations under the License. 20*f6217f89SApple OSS Distributions * 21*f6217f89SApple OSS Distributions * @APPLE_LICENSE_HEADER_END@ 22*f6217f89SApple OSS Distributions */ 23*f6217f89SApple OSS Distributions 24*f6217f89SApple OSS Distributions #ifndef __os_log_private_h 25*f6217f89SApple OSS Distributions #define __os_log_private_h 26*f6217f89SApple OSS Distributions 27*f6217f89SApple OSS Distributions #include <os/log.h> 28*f6217f89SApple OSS Distributions #include <firehose/tracepoint_private.h> 29*f6217f89SApple OSS Distributions #include <sys/queue.h> 30*f6217f89SApple OSS Distributions 31*f6217f89SApple OSS Distributions #define OS_LOG_XNU_SUBSYSTEM "com.apple.xnu" 32*f6217f89SApple OSS Distributions #define OS_LOG_SUBSYSTEM "com.apple.xnu.oslog" 33*f6217f89SApple OSS Distributions #define OS_LOG_MAX_SIZE_ORDER 10 // Maximum log size order (1024 bytes) 34*f6217f89SApple OSS Distributions 35*f6217f89SApple OSS Distributions __BEGIN_DECLS 36*f6217f89SApple OSS Distributions 37*f6217f89SApple OSS Distributions /*! 38*f6217f89SApple OSS Distributions * @function os_log_with_args 39*f6217f89SApple OSS Distributions * 40*f6217f89SApple OSS Distributions * @abstract 41*f6217f89SApple OSS Distributions * os_log variant that supports va_list args. 42*f6217f89SApple OSS Distributions * 43*f6217f89SApple OSS Distributions * @discussion 44*f6217f89SApple OSS Distributions * os_log variant that supports va_list args. This SPI should only be used 45*f6217f89SApple OSS Distributions * to shim legacy logging systems through os_log. 46*f6217f89SApple OSS Distributions * 47*f6217f89SApple OSS Distributions * @param oslog 48*f6217f89SApple OSS Distributions * Pass OS_LOG_DEFAULT or a log object previously created with os_log_create. 49*f6217f89SApple OSS Distributions * 50*f6217f89SApple OSS Distributions * @param type 51*f6217f89SApple OSS Distributions * Pass one of the following message types. 52*f6217f89SApple OSS Distributions * OS_LOG_TYPE_DEFAULT 53*f6217f89SApple OSS Distributions * OS_LOG_TYPE_DEBUG 54*f6217f89SApple OSS Distributions * OS_LOG_TYPE_INFO 55*f6217f89SApple OSS Distributions * OS_LOG_TYPE_ERROR 56*f6217f89SApple OSS Distributions * OS_LOG_TYPE_FAULT 57*f6217f89SApple OSS Distributions * 58*f6217f89SApple OSS Distributions * @param format 59*f6217f89SApple OSS Distributions * A format string to generate a human-readable log message when the log 60*f6217f89SApple OSS Distributions * line is decoded. Supports all standard printf types in addition to %@ 61*f6217f89SApple OSS Distributions * and %m (objects and errno respectively). 62*f6217f89SApple OSS Distributions * 63*f6217f89SApple OSS Distributions * @param args 64*f6217f89SApple OSS Distributions * A va_list containing the values for the format string. 65*f6217f89SApple OSS Distributions * 66*f6217f89SApple OSS Distributions * @param ret_addr 67*f6217f89SApple OSS Distributions * Pass the __builtin_return_address(0) of the function that created the 68*f6217f89SApple OSS Distributions * va_list from variadic arguments. The caller must be the same binary 69*f6217f89SApple OSS Distributions * that generated the message and provided the format string. 70*f6217f89SApple OSS Distributions */ 71*f6217f89SApple OSS Distributions void 72*f6217f89SApple OSS Distributions os_log_with_args(os_log_t oslog, os_log_type_t type, const char *format, va_list args, void *ret_addr) 73*f6217f89SApple OSS Distributions __osloglike(3, 0); 74*f6217f89SApple OSS Distributions 75*f6217f89SApple OSS Distributions /* 76*f6217f89SApple OSS Distributions * A private interface allowing to emit already encoded log messages. 77*f6217f89SApple OSS Distributions */ 78*f6217f89SApple OSS Distributions bool os_log_encoded_metadata(firehose_tracepoint_id_u, uint64_t, const void *, size_t); 79*f6217f89SApple OSS Distributions bool os_log_encoded_signpost(firehose_stream_t, firehose_tracepoint_id_u, uint64_t, const void *, size_t, size_t); 80*f6217f89SApple OSS Distributions bool os_log_encoded_log(firehose_stream_t, firehose_tracepoint_id_u, uint64_t, const void *, size_t, size_t); 81*f6217f89SApple OSS Distributions 82*f6217f89SApple OSS Distributions __END_DECLS 83*f6217f89SApple OSS Distributions 84*f6217f89SApple OSS Distributions #endif // __os_log_private_h 85