1 /* 2 * Copyright (c) 2015-2024 Apple Inc. All rights reserved. 3 * 4 * @APPLE_APACHE_LICENSE_HEADER_START@ 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 * 18 * @APPLE_APACHE_LICENSE_HEADER_END@ 19 */ 20 21 #ifndef __FIREHOSE_TYPES_PRIVATE__ 22 #define __FIREHOSE_TYPES_PRIVATE__ 23 24 #include <mach/mach_types.h> 25 #include <mach/std_types.h> 26 #include <os/base.h> 27 28 OS_ASSUME_NONNULL_BEGIN 29 30 __BEGIN_DECLS 31 32 /*! 33 * @enum firehose_activity_flags_t 34 * 35 * @discussion 36 * The lower 8 bits are or-ed in the upper 8 bits of Activity ID and propagated 37 * to children activities 38 */ 39 OS_OPTIONS(firehose_activity_flags, unsigned long, 40 firehose_activity_flags_default = 0x0000, 41 42 firehose_activity_flags_info_mode = 0x0001, 43 firehose_activity_flags_debug_mode = 0x0002, 44 firehose_activity_flags_stream_live_mode = 0x0004, 45 46 firehose_activity_flags_precise_timestamp = 0x0080, 47 ); 48 49 /*! 50 * @typedef firehose_activity_id_t 51 * 52 * @abstract 53 * Opaque activity identifier. 54 * 55 * @discussion 56 * Scalar value type, not reference counted. 57 */ 58 typedef uint64_t firehose_activity_id_t; 59 #define FIREHOSE_ACTIVITY_ID_NULL ((firehose_activity_id_t)0) 60 #define FIREHOSE_ACTIVITY_ID_INVALID ((firehose_activity_id_t)~0ULL) 61 #define FIREHOSE_ACTIVITY_ID_FLAGS_SHIFT 56 62 #define FIREHOSE_ACTIVITY_ID_FLAGS(aid) \ 63 ((firehose_activity_flags_t)((aid) >> FIREHOSE_ACTIVITY_ID_FLAGS_SHIFT)) 64 #define FIREHOSE_ACTIVITY_ID_MERGE_FLAGS(aid, flags) (\ 65 ((firehose_activity_id_t)(aid)) | \ 66 ((firehose_activity_id_t)(flags) << FIREHOSE_ACTIVITY_ID_FLAGS_SHIFT)) 67 68 /*! 69 * @enum firehose_stream_t 70 */ 71 OS_ENUM(firehose_stream, uint8_t, 72 firehose_stream_persist = 0, 73 firehose_stream_special = 1, 74 firehose_stream_memory = 2, 75 firehose_stream_metadata = 3, 76 firehose_stream_signpost = 4, 77 firehose_stream_memory_wifi = 5, 78 firehose_stream_memory_baseband = 6, 79 80 _firehose_stream_max, 81 _firehose_stream_disabled = (uint8_t)-1, 82 ); 83 84 /*! 85 * @enum firehose_tracepoint_namespace_t 86 * 87 * @abstract 88 * Namespaces of tracepoints. 89 */ 90 OS_ENUM(firehose_tracepoint_namespace, uint8_t, 91 firehose_tracepoint_namespace_activity = 0x02, 92 firehose_tracepoint_namespace_trace = 0x03, 93 firehose_tracepoint_namespace_log = 0x04, 94 firehose_tracepoint_namespace_metadata = 0x05, 95 firehose_tracepoint_namespace_signpost = 0x06, 96 firehose_tracepoint_namespace_loss = 0x07, 97 ); 98 99 /*! 100 * @enum firehose_tracepoint_code_t 101 * 102 * @abstract 103 * Codes of tracepoints. 104 */ 105 OS_ENUM(firehose_tracepoint_code, uint32_t, 106 firehose_tracepoint_code_invalid = 0x00, 107 firehose_tracepoint_code_load = 0x01, 108 firehose_tracepoint_code_unload = 0x02, 109 firehose_tracepoint_code_load_memory = 0x08, 110 firehose_tracepoint_code_load_filesystem_ftab = 0x10, 111 firehose_tracepoint_code_load_exclavekit_dsc = 0x20, 112 ); 113 114 /*! 115 * @typedef firehose_tracepoint_type_t 116 * 117 * @abstract 118 * Type of tracepoints. 119 */ 120 typedef uint8_t firehose_tracepoint_type_t; 121 122 /*! 123 * @typedef firehose_tracepoint_flags_t 124 * 125 * @abstract 126 * Flags for tracepoints. 127 */ 128 OS_OPTIONS(firehose_tracepoint_flags, uint16_t, 129 _firehose_tracepoint_flags_base_has_current_aid = 0x0001, 130 #define _firehose_tracepoint_flags_pc_style_mask (0x0007 << 1) 131 _firehose_tracepoint_flags_pc_style_none = 0x0000 << 1, 132 _firehose_tracepoint_flags_pc_style_main_exe = 0x0001 << 1, 133 _firehose_tracepoint_flags_pc_style_shared_cache = 0x0002 << 1, 134 _firehose_tracepoint_flags_pc_style_main_plugin = 0x0003 << 1, 135 _firehose_tracepoint_flags_pc_style_absolute = 0x0004 << 1, 136 _firehose_tracepoint_flags_pc_style_uuid_relative = 0x0005 << 1, 137 _firehose_tracepoint_flags_pc_style_large_shared_cache = 0x0006 << 1, 138 _firehose_tracepoint_flags_pc_style__unused7 = 0x0007 << 1, 139 _firehose_tracepoint_flags_base_has_unique_pid = 0x0010, 140 _firehose_tracepoint_flags_base_has_large_offset = 0x0020, 141 ); 142 143 /* 144 * Same as _OS_TRACE_DYNAMIC_BIT defined in libtrace/tracepoint_internal.h. 145 * This bit is used by logd to know how to evaluate the format 146 * string. 147 * If it is set, logd assumes that the format is "%s" and the content of the 148 * whole string is passed with the firehose_tracepoint. 149 * Otherwise it tries to find the unformatted string within the text 150 * section of the executable and expects only the content of the variables 151 * on the firehose_tracepoint. 152 */ 153 #define FIREHOSE_TRACEPOINT_PC_DYNAMIC_BIT 0x80000000 154 155 /* 156 * Same as KERNEL_MASK defined in logd/logd_main.c 157 * It is used by logd to mask the pc before calling 158 * OSKextCopyUUIDForAddress. 159 */ 160 #define FIREHOSE_TRACEPOINT_PC_KERNEL_MASK 0xffff000000000000 161 162 /*! 163 * @typedef firehose_tracepoint_id_t 164 * 165 * @abstract 166 * Opaque tracepoint identifier. 167 */ 168 typedef uint64_t firehose_tracepoint_id_t; 169 170 /*! 171 * @enum _firehose_tracepoint_type_activity_t 172 * 173 * @abstract 174 * Types of Activity tracepoints (namespace activity). 175 */ 176 OS_ENUM(_firehose_tracepoint_type_activity, firehose_tracepoint_type_t, 177 _firehose_tracepoint_type_activity_create = 0x01, 178 _firehose_tracepoint_type_activity_swap = 0x02, 179 _firehose_tracepoint_type_activity_useraction = 0x03, 180 ); 181 182 /*! 183 * @enum firehose_tracepoint_flags_activity_t 184 * 185 * @abstract 186 * Flags for Activity tracepoints (namespace activity). 187 */ 188 OS_OPTIONS(_firehose_tracepoint_flags_activity, uint16_t, 189 _firehose_tracepoint_flags_activity_user_interface = 0x0100, 190 _firehose_tracepoint_flags_activity_has_other_aid = 0x0200, 191 ); 192 193 /*! 194 * @enum firehose_tracepoint_type_trace_t 195 * 196 * @abstract 197 * Types of trace tracepoints (namespace trace). 198 */ 199 OS_ENUM(_firehose_tracepoint_type_trace, firehose_tracepoint_type_t, 200 _firehose_tracepoint_type_trace_default = 0x00, 201 _firehose_tracepoint_type_trace_info = 0x01, 202 _firehose_tracepoint_type_trace_debug = 0x02, 203 _firehose_tracepoint_type_trace_error = 0x10, 204 _firehose_tracepoint_type_trace_fault = 0x11, 205 ); 206 207 /*! 208 * @enum firehose_tracepoint_type_log_t 209 * 210 * @abstract 211 * Types of Log tracepoints (namespace log). 212 */ 213 OS_ENUM(_firehose_tracepoint_type_log, firehose_tracepoint_type_t, 214 _firehose_tracepoint_type_log_default = 0x00, 215 _firehose_tracepoint_type_log_info = 0x01, 216 _firehose_tracepoint_type_log_debug = 0x02, 217 _firehose_tracepoint_type_log_error = 0x10, 218 _firehose_tracepoint_type_log_fault = 0x11, 219 ); 220 221 /*! 222 * @enum firehose_tracepoint_flags_log_t 223 * 224 * @abstract 225 * Flags for Log tracepoints (namespace log). 226 */ 227 OS_OPTIONS(_firehose_tracepoint_flags_log, uint16_t, 228 _firehose_tracepoint_flags_log_has_private_data = 0x0100, 229 _firehose_tracepoint_flags_log_has_subsystem = 0x0200, 230 _firehose_tracepoint_flags_log_has_rules = 0x0400, 231 _firehose_tracepoint_flags_log_has_oversize = 0x0800, 232 _firehose_tracepoint_flags_log_has_context_data = 0x1000, 233 ); 234 235 /*! 236 * @enum _firehose_tracepoint_type_metadata_t 237 * 238 * @abstract 239 * Types for metadata tracepoints (namespace metadata). 240 */ 241 OS_ENUM(_firehose_tracepoint_type_metadata, firehose_tracepoint_type_t, 242 _firehose_tracepoint_type_metadata_dyld = 0x01, 243 _firehose_tracepoint_type_metadata_subsystem = 0x02, 244 _firehose_tracepoint_type_metadata_kext = 0x03, 245 _firehose_tracepoint_type_metadata_coprocessor = 0x04, 246 _firehose_tracepoint_type_metadata_exclave = 0x05, 247 ); 248 249 /*! 250 * @enum firehose_tracepoint_type_signpost_t 251 * 252 * @abstract 253 * Types of Log tracepoints (namespace signpost). 254 */ 255 OS_ENUM(_firehose_tracepoint_type_signpost, firehose_tracepoint_type_t, 256 _firehose_tracepoint_type_signpost_event = 0x00, 257 _firehose_tracepoint_type_signpost_interval_begin = 0x01, 258 _firehose_tracepoint_type_signpost_interval_end = 0x02, 259 260 _firehose_tracepoint_type_signpost_scope_mask = 0xc0, 261 _firehose_tracepoint_type_signpost_scope_thread = 0x40, 262 _firehose_tracepoint_type_signpost_scope_process = 0x80, 263 _firehose_tracepoint_type_signpost_scope_system = 0xc0, 264 ); 265 266 /*! 267 * @enum firehose_tracepoint_flags_signpost_t 268 * 269 * @abstract 270 * Flags for Log tracepoints (namespace signpost). 271 * 272 * When flags are shared with the log type, they should have the same values. 273 */ 274 OS_OPTIONS(_firehose_tracepoint_flags_signpost, uint16_t, 275 // shared with log 276 _firehose_tracepoint_flags_signpost_has_private_data = 0x0100, 277 _firehose_tracepoint_flags_signpost_has_subsystem = 0x0200, 278 _firehose_tracepoint_flags_signpost_has_rules = 0x0400, 279 _firehose_tracepoint_flags_signpost_has_oversize = 0x0800, 280 _firehose_tracepoint_flags_signpost_has_context_data = 0x1000, 281 282 // specific to signpost 283 _firehose_tracepoint_flags_signpost_has_name = 0x8000, 284 ); 285 286 /* MIG firehose push reply structure */ 287 typedef struct firehose_push_reply_s { 288 uint64_t fpr_mem_flushed_pos; 289 uint64_t fpr_io_flushed_pos; 290 } firehose_push_reply_t; 291 292 typedef struct firehose_buffer_map_info_s { 293 mach_vm_address_t fbmi_addr; 294 mach_vm_size_t fbmi_size; 295 } firehose_buffer_map_info_t; 296 297 #define FIREHOSE_PUSH_REPLY_CORRUPTED ((firehose_push_reply_t){ ~0ULL, ~0ULL }) 298 299 typedef union firehose_buffer_u *firehose_buffer_t; 300 301 __END_DECLS 302 303 OS_ASSUME_NONNULL_END 304 305 #endif // __FIREHOSE_TYPES_PRIVATE__ 306