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