1/*
2 * Copyright (c) 2015-2016 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
28OS_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 */
39OS_ENUM(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 */
58typedef 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 */
71OS_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);
82
83/*!
84 * @enum firehose_tracepoint_namespace_t
85 *
86 * @abstract
87 * Namespaces of tracepoints.
88 */
89OS_ENUM(firehose_tracepoint_namespace, uint8_t,
90 firehose_tracepoint_namespace_activity = 0x02,
91 firehose_tracepoint_namespace_trace = 0x03,
92 firehose_tracepoint_namespace_log = 0x04,
93 firehose_tracepoint_namespace_metadata = 0x05,
94 firehose_tracepoint_namespace_signpost = 0x06,
95 firehose_tracepoint_namespace_loss = 0x07,
96);
97
98/*!
99 * @enum firehose_tracepoint_code_t
100 *
101 * @abstract
102 * Codes of tracepoints.
103 */
104OS_ENUM(firehose_tracepoint_code, uint32_t,
105 firehose_tracepoint_code_load = 0x01,
106 firehose_tracepoint_code_unload = 0x02,
107);
108
109/*!
110 * @typedef firehose_tracepoint_type_t
111 *
112 * @abstract
113 * Type of tracepoints.
114 */
115typedef uint8_t firehose_tracepoint_type_t;
116
117/*!
118 * @typedef firehose_tracepoint_flags_t
119 *
120 * @abstract
121 * Flags for tracepoints.
122 */
123OS_ENUM(firehose_tracepoint_flags, uint16_t,
124 _firehose_tracepoint_flags_base_has_current_aid = 0x0001,
125#define _firehose_tracepoint_flags_pc_style_mask (0x0007 << 1)
126 _firehose_tracepoint_flags_pc_style_none = 0x0000 << 1,
127 _firehose_tracepoint_flags_pc_style_main_exe = 0x0001 << 1,
128 _firehose_tracepoint_flags_pc_style_shared_cache = 0x0002 << 1,
129 _firehose_tracepoint_flags_pc_style_main_plugin = 0x0003 << 1,
130 _firehose_tracepoint_flags_pc_style_absolute = 0x0004 << 1,
131 _firehose_tracepoint_flags_pc_style_uuid_relative = 0x0005 << 1,
132 _firehose_tracepoint_flags_pc_style__unused6 = 0x0006 << 1,
133 _firehose_tracepoint_flags_pc_style__unused7 = 0x0007 << 1,
134 _firehose_tracepoint_flags_base_has_unique_pid = 0x0010,
135);
136
137/*!
138 * @typedef firehose_tracepoint_id_t
139 *
140 * @abstract
141 * Opaque tracepoint identifier.
142 */
143typedef uint64_t firehose_tracepoint_id_t;
144
145/*!
146 * @enum _firehose_tracepoint_type_activity_t
147 *
148 * @abstract
149 * Types of Activity tracepoints (namespace activity).
150 */
151OS_ENUM(_firehose_tracepoint_type_activity, firehose_tracepoint_type_t,
152 _firehose_tracepoint_type_activity_create = 0x01,
153 _firehose_tracepoint_type_activity_swap = 0x02,
154 _firehose_tracepoint_type_activity_useraction = 0x03,
155);
156
157/*!
158 * @enum firehose_tracepoint_flags_activity_t
159 *
160 * @abstract
161 * Flags for Activity tracepoints (namespace activity).
162 */
163OS_ENUM(_firehose_tracepoint_flags_activity, uint16_t,
164 _firehose_tracepoint_flags_activity_user_interface = 0x0100,
165 _firehose_tracepoint_flags_activity_has_other_aid = 0x0200,
166);
167
168/*!
169 * @enum firehose_tracepoint_type_trace_t
170 *
171 * @abstract
172 * Types of trace tracepoints (namespace trace).
173 */
174OS_ENUM(_firehose_tracepoint_type_trace, firehose_tracepoint_type_t,
175 _firehose_tracepoint_type_trace_default = 0x00,
176 _firehose_tracepoint_type_trace_info = 0x01,
177 _firehose_tracepoint_type_trace_debug = 0x02,
178 _firehose_tracepoint_type_trace_error = 0x10,
179 _firehose_tracepoint_type_trace_fault = 0x11,
180);
181
182/*!
183 * @enum firehose_tracepoint_type_log_t
184 *
185 * @abstract
186 * Types of Log tracepoints (namespace log).
187 */
188OS_ENUM(_firehose_tracepoint_type_log, firehose_tracepoint_type_t,
189 _firehose_tracepoint_type_log_default = 0x00,
190 _firehose_tracepoint_type_log_info = 0x01,
191 _firehose_tracepoint_type_log_debug = 0x02,
192 _firehose_tracepoint_type_log_error = 0x10,
193 _firehose_tracepoint_type_log_fault = 0x11,
194);
195
196/*!
197 * @enum firehose_tracepoint_flags_log_t
198 *
199 * @abstract
200 * Flags for Log tracepoints (namespace log).
201 */
202OS_ENUM(_firehose_tracepoint_flags_log, uint16_t,
203 _firehose_tracepoint_flags_log_has_private_data = 0x0100,
204 _firehose_tracepoint_flags_log_has_subsystem = 0x0200,
205 _firehose_tracepoint_flags_log_has_rules = 0x0400,
206 _firehose_tracepoint_flags_log_has_oversize = 0x0800,
207 _firehose_tracepoint_flags_log_has_context_data = 0x1000,
208);
209
210/*!
211 * @enum _firehose_tracepoint_type_metadata_t
212 *
213 * @abstract
214 * Types for metadata tracepoints (namespace metadata).
215 */
216OS_ENUM(_firehose_tracepoint_type_metadata, firehose_tracepoint_type_t,
217 _firehose_tracepoint_type_metadata_dyld = 0x01,
218 _firehose_tracepoint_type_metadata_subsystem = 0x02,
219 _firehose_tracepoint_type_metadata_kext = 0x03,
220);
221
222/*!
223 * @enum firehose_tracepoint_type_signpost_t
224 *
225 * @abstract
226 * Types of Log tracepoints (namespace signpost).
227 */
228OS_ENUM(_firehose_tracepoint_type_signpost, firehose_tracepoint_type_t,
229 _firehose_tracepoint_type_signpost_event = 0x00,
230 _firehose_tracepoint_type_signpost_interval_begin = 0x01,
231 _firehose_tracepoint_type_signpost_interval_end = 0x02,
232
233 _firehose_tracepoint_type_signpost_scope_mask = 0xc0,
234 _firehose_tracepoint_type_signpost_scope_thread = 0x40,
235 _firehose_tracepoint_type_signpost_scope_process = 0x80,
236 _firehose_tracepoint_type_signpost_scope_system = 0xc0,
237);
238
239/*!
240 * @enum firehose_tracepoint_flags_signpost_t
241 *
242 * @abstract
243 * Flags for Log tracepoints (namespace signpost).
244 *
245 * When flags are shared with the log type, they should have the same values.
246 */
247OS_ENUM(_firehose_tracepoint_flags_signpost, uint16_t,
248 _firehose_tracepoint_flags_signpost_has_private_data = 0x0100,
249 _firehose_tracepoint_flags_signpost_has_subsystem = 0x0200,
250 _firehose_tracepoint_flags_signpost_has_rules = 0x0400,
251 _firehose_tracepoint_flags_signpost_has_oversize = 0x0800,
252 _firehose_tracepoint_flags_signpost_has_context_data = 0x1000,
253);
254
255/* MIG firehose push reply structure */
256typedef struct firehose_push_reply_s {
257 uint64_t fpr_mem_flushed_pos;
258 uint64_t fpr_io_flushed_pos;
259} firehose_push_reply_t;
260
261typedef struct firehose_buffer_map_info_s {
262 mach_vm_address_t fbmi_addr;
263 mach_vm_size_t fbmi_size;
264} firehose_buffer_map_info_t;
265
266#define FIREHOSE_PUSH_REPLY_CORRUPTED ((firehose_push_reply_t){ ~0ULL, ~0ULL })
267
268typedef union firehose_buffer_u *firehose_buffer_t;
269
270__END_DECLS
271
272OS_ASSUME_NONNULL_END
273
274#endif // __FIREHOSE_TYPES_PRIVATE__
275