]> git.saurik.com Git - apple/xnu.git/blob - tools/lldbmacros/kcdata.py
projects / apple / xnu.git / blob
? search:


12a996c6935f35fb0e8910ada76d7a0495997ac1
[apple/xnu.git] / tools / lldbmacros / kcdata.py
1 #!/usr/bin/env python
2 import sys
3 import struct
4 import mmap
5 import json
6 import cgitb
7 import copy
8 import re
9 import base64
10 import argparse
11 import os
12 import shlex
13 import subprocess
14 import logging
15 import contextlib
16 import base64
17
18 class Globals(object):
19 pass
20 G = Globals()
21 G.accept_incomplete_data = False
22 G.data_was_incomplete = False
23
24 kcdata_type_def = {
25 'KCDATA_TYPE_INVALID': 0x0,
26 'KCDATA_TYPE_STRING_DESC': 0x1,
27 'KCDATA_TYPE_UINT32_DESC': 0x2,
28 'KCDATA_TYPE_UINT64_DESC': 0x3,
29 'KCDATA_TYPE_INT32_DESC': 0x4,
30 'KCDATA_TYPE_INT64_DESC': 0x5,
31 'KCDATA_TYPE_BINDATA_DESC': 0x6,
32 'KCDATA_TYPE_ARRAY': 0x11,
33 'KCDATA_TYPE_TYPEDEFINTION': 0x12,
34 'KCDATA_TYPE_CONTAINER_BEGIN': 0x13,
35 'KCDATA_TYPE_CONTIANER_END': 0x14,
36
37 'KCDATA_TYPE_ARRAY_PAD0': 0x20,
38 'KCDATA_TYPE_ARRAY_PAD1': 0x21,
39 'KCDATA_TYPE_ARRAY_PAD2': 0x22,
40 'KCDATA_TYPE_ARRAY_PAD3': 0x23,
41 'KCDATA_TYPE_ARRAY_PAD4': 0x24,
42 'KCDATA_TYPE_ARRAY_PAD5': 0x25,
43 'KCDATA_TYPE_ARRAY_PAD6': 0x26,
44 'KCDATA_TYPE_ARRAY_PAD7': 0x27,
45 'KCDATA_TYPE_ARRAY_PAD8': 0x28,
46 'KCDATA_TYPE_ARRAY_PAD9': 0x29,
47 'KCDATA_TYPE_ARRAY_PADa': 0x2a,
48 'KCDATA_TYPE_ARRAY_PADb': 0x2b,
49 'KCDATA_TYPE_ARRAY_PADc': 0x2c,
50 'KCDATA_TYPE_ARRAY_PADd': 0x2d,
51 'KCDATA_TYPE_ARRAY_PADe': 0x2e,
52 'KCDATA_TYPE_ARRAY_PADf': 0x2f,
53
54 'KCDATA_TYPE_LIBRARY_LOADINFO': 0x30,
55 'KCDATA_TYPE_LIBRARY_LOADINFO64': 0x31,
56 'KCDATA_TYPE_TIMEBASE': 0x32,
57 'KCDATA_TYPE_MACH_ABSOLUTE_TIME': 0x33,
58 'KCDATA_TYPE_TIMEVAL': 0x34,
59 'KCDATA_TYPE_USECS_SINCE_EPOCH': 0x35,
60 'KCDATA_TYPE_PID': 0x36,
61 'KCDATA_TYPE_PROCNAME': 0x37,
62 'KCDATA_TYPE_NESTED_KCDATA': 0x38,
63
64 'STACKSHOT_KCCONTAINER_TASK': 0x903,
65 'STACKSHOT_KCCONTAINER_THREAD': 0x904,
66 'STACKSHOT_KCTYPE_DONATING_PIDS': 0x907,
67 'STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO': 0x908,
68 'STACKSHOT_KCTYPE_KERN_STACKFRAME': 0x90A,
69 'STACKSHOT_KCTYPE_KERN_STACKFRAME64': 0x90B,
70 'STACKSHOT_KCTYPE_USER_STACKFRAME': 0x90C,
71 'STACKSHOT_KCTYPE_USER_STACKFRAME64': 0x90D,
72 'STACKSHOT_KCTYPE_BOOTARGS': 0x90E,
73 'STACKSHOT_KCTYPE_OSVERSION': 0x90F,
74 'STACKSHOT_KCTYPE_KERN_PAGE_SIZE': 0x910,
75 'STACKSHOT_KCTYPE_JETSAM_LEVEL': 0x911,
76 'STACKSHOT_KCTYPE_DELTA_SINCE_TIMESTAMP': 0x912,
77 'STACKSHOT_KCTYPE_TASK_DELTA_SNAPSHOT': 0x940,
78 'STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT': 0x941,
79
80 'STACKSHOT_KCTYPE_KERN_STACKLR': 0x913,
81 'STACKSHOT_KCTYPE_KERN_STACKLR64': 0x914,
82 'STACKSHOT_KCTYPE_USER_STACKLR': 0x915,
83 'STACKSHOT_KCTYPE_USER_STACKLR64': 0x916,
84 'STACKSHOT_KCTYPE_NONRUNNABLE_TIDS': 0x917,
85 'STACKSHOT_KCTYPE_NONRUNNABLE_TASKS': 0x918,
86 'STACKSHOT_KCTYPE_CPU_TIMES': 0x919,
87 'STACKSHOT_KCTYPE_STACKSHOT_DURATION': 0x91a,
88 'STACKSHOT_KCTYPE_STACKSHOT_FAULT_STATS': 0x91b,
89 'STACKSHOT_KCTYPE_KERNELCACHE_LOADINFO': 0x91c,
90 'STACKSHOT_KCTYPE_THREAD_WAITINFO' : 0x91d,
91 'STACKSHOT_KCTYPE_THREAD_GROUP_SNAPSHOT' : 0x91e,
92 'STACKSHOT_KCTYPE_THREAD_GROUP' : 0x91f,
93 'STACKSHOT_KCTYPE_JETSAM_COALITION_SNAPSHOT' : 0x920,
94 'STACKSHOT_KCTYPE_JETSAM_COALITION' : 0x921,
95 'STACKSHOT_KCTYPE_INSTRS_CYCLES' : 0x923,
96
97 'STACKSHOT_KCTYPE_THREAD_POLICY_VERSION': 0x922,
98
99
100 'KCDATA_TYPE_BUFFER_END': 0xF19158ED,
101
102
103 'TASK_CRASHINFO_EXTMODINFO': 0x801,
104 'TASK_CRASHINFO_BSDINFOWITHUNIQID': 0x802,
105 'TASK_CRASHINFO_TASKDYLD_INFO': 0x803,
106 'TASK_CRASHINFO_UUID': 0x804,
107 'TASK_CRASHINFO_PID': 0x805,
108 'TASK_CRASHINFO_PPID': 0x806,
109
110 # Don't want anyone using this. It's struct rusage from whatever machine generated the data
111 #'TASK_CRASHINFO_RUSAGE': 0x807,
112 'Type_0x807': 0x807,
113
114 'TASK_CRASHINFO_RUSAGE_INFO': 0x808,
115 'TASK_CRASHINFO_PROC_NAME': 0x809,
116 'TASK_CRASHINFO_PROC_STARTTIME': 0x80B,
117 'TASK_CRASHINFO_USERSTACK': 0x80C,
118 'TASK_CRASHINFO_ARGSLEN': 0x80D,
119 'TASK_CRASHINFO_EXCEPTION_CODES': 0x80E,
120 'TASK_CRASHINFO_PROC_PATH': 0x80F,
121 'TASK_CRASHINFO_PROC_CSFLAGS': 0x810,
122 'TASK_CRASHINFO_PROC_STATUS': 0x811,
123 'TASK_CRASHINFO_UID': 0x812,
124 'TASK_CRASHINFO_GID': 0x813,
125 'TASK_CRASHINFO_PROC_ARGC': 0x814,
126 'TASK_CRASHINFO_PROC_FLAGS': 0x815,
127 'TASK_CRASHINFO_CPUTYPE': 0x816,
128 'TASK_CRASHINFO_WORKQUEUEINFO': 0x817,
129 'TASK_CRASHINFO_RESPONSIBLE_PID': 0x818,
130 'TASK_CRASHINFO_DIRTY_FLAGS': 0x819,
131 'TASK_CRASHINFO_CRASHED_THREADID': 0x81A,
132 'TASK_CRASHINFO_COALITION_ID': 0x81B,
133 'EXIT_REASON_SNAPSHOT': 0x1001,
134 'EXIT_REASON_USER_DESC': 0x1002,
135 'EXIT_REASON_USER_PAYLOAD': 0x1003,
136 'EXIT_REASON_CODESIGNING_INFO': 0x1004,
137 'EXIT_REASON_WORKLOOP_ID': 0x1005,
138 'EXIT_REASON_DISPATCH_QUEUE_NO': 0x1006,
139 'KCDATA_BUFFER_BEGIN_CRASHINFO': 0xDEADF157,
140 'KCDATA_BUFFER_BEGIN_DELTA_STACKSHOT': 0xDE17A59A,
141 'KCDATA_BUFFER_BEGIN_STACKSHOT': 0x59a25807,
142 'KCDATA_BUFFER_BEGIN_OS_REASON': 0x53A20900,
143 'KCDATA_BUFFER_BEGIN_XNUPOST_CONFIG': 0x1E21C09F
144 }
145 kcdata_type_def_rev = dict((v, k) for k, v in kcdata_type_def.iteritems())
146
147 KNOWN_TYPES_COLLECTION = {}
148
149 KNOWN_TOPLEVEL_CONTAINER_TYPES = ()
150
151 def enum(**args):
152 return type('enum', (), args)
153
154 KCSUBTYPE_TYPE = enum(KC_ST_CHAR=1, KC_ST_INT8=2, KC_ST_UINT8=3, KC_ST_INT16=4, KC_ST_UINT16=5, KC_ST_INT32=6, KC_ST_UINT32=7, KC_ST_INT64=8, KC_ST_UINT64=9)
155
156
157 LEGAL_OLD_STYLE_ARRAY_TYPE_NAMES = ['KCDATA_TYPE_LIBRARY_LOADINFO',
158 'KCDATA_TYPE_LIBRARY_LOADINFO64',
159 'STACKSHOT_KCTYPE_KERN_STACKFRAME',
160 'STACKSHOT_KCTYPE_USER_STACKFRAME',
161 'STACKSHOT_KCTYPE_KERN_STACKFRAME64',
162 'STACKSHOT_KCTYPE_USER_STACKFRAME64',
163 'STACKSHOT_KCTYPE_DONATING_PIDS',
164 'STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT']
165
166 KCDATA_FLAGS_STRUCT_PADDING_MASK = 0xf
167 KCDATA_FLAGS_STRUCT_HAS_PADDING = 0x80
168
169 class KCSubTypeElement(object):
170 """convert kcdata_subtype_descriptor to """
171 _unpack_formats = (None, 'c', 'b', 'B', 'h', 'H', 'i', 'I', 'q', 'Q')
172 _ctypes = ('Unknown', 'char', 'int8_t', 'uint8_t', 'int16_t', 'uint16_t', 'int32_t', 'uint32_t', 'int64_t', 'uint64_t')
173
174 def __init__(self, st_name, st_type, st_size, st_offset=0, st_flag=0, custom_repr=None):
175 self.name = st_name
176 self.offset = st_offset
177 self.type_id = st_type
178 if st_type <= 0 or st_type > KCSUBTYPE_TYPE.KC_ST_UINT64:
179 raise ValueError("Invalid type passed %d" % st_type)
180 self.unpack_fmt = KCSubTypeElement._unpack_formats[self.type_id]
181 self.size = st_size
182 self.totalsize = st_size
183 self.count = 1
184 self.is_array_type = False
185 self.custom_JsonRepr = custom_repr
186 if (st_flag & 0x1) == 0x1:
187 self.is_array_type = True
188 self.size = st_size & 0xffff
189 self.count = (st_size >> 16) & 0xffff
190 self.totalsize = self.size * self.count
191
192 @staticmethod
193 def GetSizeForArray(el_count, el_size):
194 return ((el_count & 0xffff) << 16) | (el_size & 0xffff)
195
196 @staticmethod
197 def FromBinaryTypeData(byte_data):
198 (st_flag, st_type, st_offset, st_size, st_name) = struct.unpack_from('=BBHI32s', byte_data)
199 st_name = st_name.rstrip('\x00')
200 return KCSubTypeElement(st_name, st_type, st_size, st_offset, st_flag)
201
202 @staticmethod
203 def FromBasicCtype(st_name, st_type, st_offset=0, legacy_size=None):
204 if st_type <= 0 or st_type > KCSUBTYPE_TYPE.KC_ST_UINT64:
205 raise ValueError("Invalid type passed %d" % st_type)
206 st_size = struct.calcsize(KCSubTypeElement._unpack_formats[st_type])
207 st_flag = 0
208 retval = KCSubTypeElement(st_name, st_type, st_size, st_offset, st_flag, KCSubTypeElement._get_naked_element_value)
209 if legacy_size:
210 retval.legacy_size = legacy_size
211 return retval
212
213 @staticmethod
214 def FromKCSubTypeElement(other, name_override=''):
215 _copy = copy.copy(other)
216 if name_override:
217 _copy.name = name_override
218 return copy
219
220 def GetName(self):
221 return self.name
222
223 def GetTotalSize(self):
224 return self.totalsize
225
226 def GetValueAsString(self, base_data, array_pos=0):
227 return str(self.GetValue(base_data, array_pos))
228
229 def GetValue(self, base_data, array_pos=0):
230 return struct.unpack_from(self.unpack_fmt, base_data[self.offset + (array_pos * self.size):])[0]
231
232 @staticmethod
233 def _get_naked_element_value(elementValue, elementName):
234 return json.dumps(elementValue)
235
236 def __str__(self):
237 if self.is_array_type:
238 return '[%d,%d] %s %s[%d];' % (self.offset, self.totalsize, self.GetCTypeDesc(), self.name, self.count)
239 return '[%d,%d] %s %s;' % (self.offset, self.totalsize, self.GetCTypeDesc(), self.name)
240
241 def __repr__(self):
242 return str(self)
243
244 def GetCTypeDesc(self):
245 return KCSubTypeElement._ctypes[self.type_id]
246
247 def GetStringRepr(self, base_data):
248 if not self.is_array_type:
249 return self.GetValueAsString(base_data)
250 if self.type_id == KCSUBTYPE_TYPE.KC_ST_CHAR:
251 str_len = self.count
252 if len(base_data) < str_len:
253 str_len = len(base_data)
254 str_arr = []
255 for i in range(str_len):
256 _v = self.GetValue(base_data, i)
257 if ord(_v) == 0:
258 break
259 str_arr.append(self.GetValueAsString(base_data, i))
260 return json.dumps(''.join(str_arr))
261
262 count = self.count
263 if count > len(base_data)/self.size:
264 count = len(base_data)/self.size
265
266 o = '[' + ','.join([self.GetValueAsString(base_data, i) for i in range(count)]) + ']'
267
268 return o
269
270 def GetJsonRepr(self, base_data, flags=0):
271 if (flags & (KCDATA_FLAGS_STRUCT_HAS_PADDING | KCDATA_FLAGS_STRUCT_PADDING_MASK)) != 0:
272 padding = (flags & KCDATA_FLAGS_STRUCT_PADDING_MASK)
273 if padding:
274 base_data = base_data[:-padding]
275 if self.custom_JsonRepr:
276 if self.is_array_type:
277 e_data = [self.GetValue(base_data, i) for i in range(self.count)]
278 else:
279 e_data = self.GetValue(base_data)
280 return self.custom_JsonRepr(e_data, self.name)
281 return self.GetStringRepr(base_data)
282
283 def sizeof(self):
284 return self.totalsize
285
286 def ShouldSkip(self, data):
287 return len(data) < self.offset + self.totalsize
288
289 def ShouldMerge(self):
290 return False
291
292
293 class KCTypeDescription(object):
294 def __init__(self, t_type_id, t_elements=[], t_name='anon', custom_repr=None, legacy_size=None, merge=False):
295 self.type_id = t_type_id
296 self.elements = t_elements
297 self.name = t_name
298 self.totalsize = 0
299 self.custom_JsonRepr = custom_repr
300 if legacy_size:
301 self.legacy_size = legacy_size
302 self.merge = merge
303 for e in self.elements:
304 self.totalsize += e.GetTotalSize()
305
306 def ValidateData(self, base_data):
307 if len(base_data) >= self.totalsize:
308 return True
309 return False
310
311 def GetTypeID(self):
312 return self.type_id
313
314 def GetName(self):
315 return self.name
316
317 def __str__(self):
318 o = '%s {\n\t' % self.name + "\n\t".join([str(e) for e in self.elements]) + '\n};'
319 return o
320
321 @staticmethod
322 def FromKCTypeDescription(other, t_type_id, t_name):
323 retval = KCTypeDescription(t_type_id, other.elements, t_name, other.custom_JsonRepr,
324 legacy_size=getattr(other, 'legacy_size', None))
325 return retval
326
327 def ShouldMerge(self):
328 return self.merge
329
330 def GetJsonRepr(self, base_data, flags):
331 if (flags & (KCDATA_FLAGS_STRUCT_HAS_PADDING | KCDATA_FLAGS_STRUCT_PADDING_MASK)) != 0:
332 padding = (flags & KCDATA_FLAGS_STRUCT_PADDING_MASK)
333 if padding:
334 base_data = base_data[:-padding]
335 elif hasattr(self, 'legacy_size') and len(base_data) == self.legacy_size + ((-self.legacy_size) & 0xf):
336 base_data = base_data[:self.legacy_size]
337 if self.custom_JsonRepr:
338 return self.custom_JsonRepr([e.GetValue(base_data) for e in self.elements])
339 o = ", ".join(['"%s": %s' % (e.GetName(), e.GetJsonRepr(base_data)) for e in self.elements if not e.ShouldSkip(base_data)])
340 if not self.merge:
341 o = '{' + o + '}'
342 return o
343
344 def sizeof(self):
345 return max(st.totalsize + st.offset for st in self.elements)
346
347
348 def GetTypeNameForKey(k):
349 retval = "0x%x" % k
350 if k in KNOWN_TYPES_COLLECTION:
351 retval = KNOWN_TYPES_COLLECTION[k].GetName()
352 elif k in kcdata_type_def_rev:
353 retval = kcdata_type_def_rev[k]
354 return retval
355
356
357 def GetTypeForName(n):
358 ret = 0
359 if n in kcdata_type_def:
360 ret = kcdata_type_def[n]
361 return ret
362
363
364 LEGAL_OLD_STYLE_ARRAY_TYPES = map(GetTypeForName, LEGAL_OLD_STYLE_ARRAY_TYPE_NAMES)
365
366 kcdata_type_def_rev[GetTypeForName('KCDATA_BUFFER_BEGIN_STACKSHOT')] = 'kcdata_stackshot'
367 kcdata_type_def_rev[GetTypeForName('KCDATA_BUFFER_BEGIN_DELTA_STACKSHOT')] = 'kcdata_delta_stackshot'
368 kcdata_type_def_rev[GetTypeForName('KCDATA_BUFFER_BEGIN_CRASHINFO')] = 'kcdata_crashinfo'
369 kcdata_type_def_rev[GetTypeForName('KCDATA_BUFFER_BEGIN_OS_REASON')] = 'kcdata_reason'
370 kcdata_type_def_rev[GetTypeForName('STACKSHOT_KCCONTAINER_TASK')] = 'task_snapshots'
371 kcdata_type_def_rev[GetTypeForName('STACKSHOT_KCCONTAINER_THREAD')] = 'thread_snapshots'
372 kcdata_type_def_rev[GetTypeForName('KCDATA_BUFFER_BEGIN_XNUPOST_CONFIG')] = 'xnupost_testconfig'
373
374 class Indent(object):
375 def __init__(self):
376 self.n = 0
377 def __call__(self, end=False):
378 if end:
379 return " " * (self.n-4)
380 else:
381 return " " * self.n
382 @contextlib.contextmanager
383 def indent(self):
384 self.n += 4
385 try:
386 yield
387 finally:
388 self.n -= 4
389
390 INDENT = Indent()
391
392 class KCObject(object):
393
394 def __init__(self, type_code, data, offset, flags=0):
395
396 self.i_type = type_code
397 self.i_data = data
398 self.offset = offset
399 self.i_size = len(data)
400 self.i_flags = flags
401 self.obj_collection = []
402 self.obj = {}
403 self.is_container_type = False
404 self.is_array_type = False
405 self.is_naked_type = False
406 self.nested_kcdata = None
407 self.i_name = GetTypeNameForKey(type_code)
408
409 self.ParseData()
410
411 if self.i_type == GetTypeForName('KCDATA_TYPE_CONTAINER_BEGIN'):
412 self.__class__ = KCContainerObject
413
414 if self.i_type in KNOWN_TOPLEVEL_CONTAINER_TYPES:
415 self.__class__ = KCBufferObject
416
417 self.InitAfterParse()
418
419 def __str__(self):
420 return "<KCObject at 0x%x>" % self.offset
421
422 def InitAfterParse(self):
423 pass
424
425 @staticmethod
426 def FromKCItem(kcitem):
427 return KCObject(kcitem.i_type, kcitem.i_data, kcitem.i_offset, kcitem.i_flags)
428
429 def IsContainerEnd(self):
430 return self.i_type == GetTypeForName('KCDATA_TYPE_CONTIANER_END')
431
432 def IsBufferEnd(self):
433 return self.i_type == GetTypeForName('KCDATA_TYPE_BUFFER_END')
434
435 def IsArray(self):
436 return self.is_array_type
437
438 def ShouldMerge(self):
439 if self.nested_kcdata:
440 return True
441 elif not self.is_array_type and self.i_type in KNOWN_TYPES_COLLECTION:
442 return KNOWN_TYPES_COLLECTION[self.i_type].ShouldMerge()
443 else:
444 return False
445
446 def GetJsonRepr(self):
447 if self.is_array_type:
448 return '[' + ', '.join([i.GetJsonRepr() for i in self.obj_collection]) + ']'
449 if self.i_type in KNOWN_TYPES_COLLECTION:
450 return KNOWN_TYPES_COLLECTION[self.i_type].GetJsonRepr(self.i_data, self.i_flags)
451 if self.is_naked_type:
452 return json.dumps(self.obj)
453 if self.nested_kcdata:
454 return self.nested_kcdata.GetJsonRepr()
455
456 raise NotImplementedError("Broken GetJsonRepr implementation")
457
458 def ParseData(self):
459
460
461 if self.i_type == GetTypeForName('KCDATA_TYPE_CONTAINER_BEGIN'):
462 self.obj['uniqID'] = self.i_flags
463 self.i_name = str(self.obj['uniqID'])
464 self.obj['typeID'] = struct.unpack_from('I', self.i_data)[0]
465 logging.info("0x%08x: %sCONTAINER: %s(%x)" % (self.offset, INDENT(), GetTypeNameForKey(self.obj['typeID']), self.i_flags))
466
467 elif self.i_type in (KNOWN_TOPLEVEL_CONTAINER_TYPES):
468 self.obj['uniqID'] = self.i_name
469 self.obj['typeID'] = self.i_type
470 logging.info("0x%08x: %s%s" % (self.offset, INDENT(), self.i_name))
471
472 elif self.i_type == GetTypeForName('KCDATA_TYPE_CONTIANER_END'):
473 self.obj['uniqID'] = self.i_flags
474 logging.info("0x%08x: %sEND" % (self.offset, INDENT(end=True)))
475
476 elif self.i_type == GetTypeForName('KCDATA_TYPE_BUFFER_END'):
477 self.obj = ''
478 logging.info("0x%08x: %sEND_BUFFER" % (self.offset, INDENT(end=True)))
479
480 elif self.i_type == GetTypeForName('KCDATA_TYPE_UINT32_DESC'):
481 self.is_naked_type = True
482 u_d = struct.unpack_from('32sI', self.i_data)
483 self.i_name = u_d[0].strip(chr(0))
484 self.obj = u_d[1]
485 logging.info("0x%08x: %s%s" % (self.offset, INDENT(), self.i_name))
486
487 elif self.i_type == GetTypeForName('KCDATA_TYPE_UINT64_DESC'):
488 self.is_naked_type = True
489 u_d = struct.unpack_from('32sQ', self.i_data)
490 self.i_name = u_d[0].strip(chr(0))
491 self.obj = u_d[1]
492 logging.info("0x%08x: %s%s" % (self.offset, INDENT(), self.i_name))
493
494 elif self.i_type == GetTypeForName('KCDATA_TYPE_TYPEDEFINTION'):
495 self.is_naked_type = True
496 u_d = struct.unpack_from('II32s', self.i_data)
497 self.obj['name'] = u_d[2].split(chr(0))[0]
498 self.i_name = "typedef[%s]" % self.obj['name']
499 self.obj['typeID'] = u_d[0]
500 self.obj['numOfFields'] = u_d[1]
501 element_arr = []
502 for i in range(u_d[1]):
503 e = KCSubTypeElement.FromBinaryTypeData(self.i_data[40+(i*40):])
504 element_arr.append(e)
505 type_desc = KCTypeDescription(u_d[0], element_arr, self.obj['name'])
506 self.obj['fields'] = [str(e) for e in element_arr]
507 KNOWN_TYPES_COLLECTION[type_desc.GetTypeID()] = type_desc
508 logging.info("0x%08x: %s%s" % (self.offset, INDENT(), self.i_name))
509
510 elif self.i_type == GetTypeForName('KCDATA_TYPE_ARRAY'):
511 self.is_array_type = True
512 e_t = (self.i_flags >> 32) & 0xffffffff
513 if e_t not in LEGAL_OLD_STYLE_ARRAY_TYPES:
514 raise Exception, "illegal old-style array type: %s (0x%x)" % (GetTypeNameForKey(e_t), e_t)
515 e_c = self.i_flags & 0xffffffff
516 e_s = KNOWN_TYPES_COLLECTION[e_t].legacy_size
517 if e_s * e_c > self.i_size:
518 raise Exception("array too small for its count")
519 self.obj['typeID'] = e_t
520 self.i_name = GetTypeNameForKey(e_t)
521 self.i_type = e_t
522 self.obj['numOfElements'] = e_c
523 self.obj['sizeOfElement'] = e_s
524 logging.info("0x%08x: %sARRAY: %s" % (self.offset, INDENT(), self.i_name))
525 #populate the array here by recursive creation of KCObject
526 with INDENT.indent():
527 for _i in range(e_c):
528 _o = KCObject(e_t, self.i_data[(_i * e_s):(_i * e_s) + e_s], self.offset + _i*e_s)
529 self.obj_collection.append(_o)
530
531 elif self.i_type >= GetTypeForName('KCDATA_TYPE_ARRAY_PAD0') and self.i_type <= GetTypeForName('KCDATA_TYPE_ARRAY_PADf'):
532 self.is_array_type = True
533 e_t = (self.i_flags >> 32) & 0xffffffff
534 e_c = self.i_flags & 0xffffffff
535 e_s = (self.i_size - (self.i_type & 0xf)) / e_c if e_c != 0 else None
536 self.obj['typeID'] = e_t
537 self.i_name = GetTypeNameForKey(e_t)
538 self.i_type = e_t
539 self.obj['numOfElements'] = e_c
540 self.obj['sizeOfElement'] = e_s
541 logging.info("0x%08x: %sARRAY: %s" % (self.offset, INDENT(), self.i_name))
542 #populate the array here by recursive creation of KCObject
543 with INDENT.indent():
544 for _i in range(e_c):
545 _o = KCObject(e_t, self.i_data[(_i * e_s):(_i * e_s) + e_s], self.offset + _i*e_s)
546 self.obj_collection.append(_o)
547
548 elif self.i_type == GetTypeForName('KCDATA_TYPE_NESTED_KCDATA'):
549 logging.info("0x%08x: %sNESTED_KCDATA" % (self.offset, INDENT()))
550 with INDENT.indent():
551 nested_iterator = kcdata_item_iterator(self.i_data[:self.i_size])
552 nested_buffer = KCObject.FromKCItem(nested_iterator.next())
553 if not isinstance(nested_buffer, KCBufferObject):
554 raise Exception, "nested buffer isn't a KCBufferObject"
555 nested_buffer.ReadItems(nested_iterator)
556 self.nested_kcdata = nested_buffer
557
558 elif self.i_type in KNOWN_TYPES_COLLECTION:
559 self.i_name = KNOWN_TYPES_COLLECTION[self.i_type].GetName()
560 self.is_naked_type = True
561 logging.info("0x%08x: %s%s" % (self.offset, INDENT(), self.i_name))
562 else:
563 self.is_naked_type = True
564 #self.obj = "data of len %d" % len(self.i_data)
565 #self.obj = ''.join(["%x" % ki for ki in struct.unpack('%dB' % len(self.i_data), self.i_data)])
566 self.obj = map(ord, self.i_data)
567 logging.info("0x%08x: %s%s" % (self.offset, INDENT(), self.i_name))
568
569
570 class KCContainerObject(KCObject):
571 def __init__(self, *args, **kwargs):
572 assert False
573
574 def InitAfterParse(self):
575 self.obj_container_dict = {}
576 self.obj_nested_objs = {}
577
578 def ShouldMerge(self):
579 return True
580
581 def GetJsonRepr(self):
582 # o = '"%s"' % self.obj['uniqID'] + ' : { "typeID" : %d ,' % self.obj['typeID']
583 o = '"%s"' % self.obj['uniqID'] + ' : { '
584 for (k, v) in self.obj_container_dict.items():
585 if v.ShouldMerge():
586 o += v.GetJsonRepr() + ","
587 else:
588 o += ' "%s" : ' % k + v.GetJsonRepr() + ","
589
590 for (k, v) in self.obj_nested_objs.items():
591 o += '"%s" : {' % k + ",".join([vi.GetJsonRepr() for vi in v.values()]) + "} ,"
592
593 o = o.rstrip(',') + "}"
594
595 return o
596
597 def AddObject(self, kco):
598 assert not kco.IsContainerEnd()
599 if isinstance(kco, KCContainerObject):
600 type_name = GetTypeNameForKey(kco.obj['typeID'])
601 if type_name not in self.obj_nested_objs:
602 self.obj_nested_objs[type_name] = {}
603 self.obj_nested_objs[type_name][kco.i_name] = kco
604 return
605 if kco.i_name in self.obj_container_dict:
606 if kco.IsArray() and self.obj_container_dict[kco.i_name].IsArray():
607 self.obj_container_dict[kco.i_name].obj_collection.extend( kco.obj_collection )
608 else:
609 self.obj_container_dict[kco.i_name] = kco
610
611 def IsEndMarker(self, o):
612 if not o.IsContainerEnd():
613 return False
614 if o.i_flags != self.i_flags:
615 raise Exception, "container end marker doesn't match"
616 return True
617
618 no_end_message = "could not find container end marker"
619
620 def ReadItems(self, iterator):
621 found_end = False
622 with INDENT.indent():
623 for i in iterator:
624 o = KCObject.FromKCItem(i)
625 if self.IsEndMarker(o):
626 found_end = True
627 break
628 if o.IsBufferEnd():
629 break
630 if isinstance(o, KCContainerObject):
631 o.ReadItems(iterator)
632 self.AddObject(o)
633 if not found_end:
634 if G.accept_incomplete_data:
635 if not G.data_was_incomplete:
636 print >>sys.stderr, "kcdata.py WARNING: data is incomplete!"
637 G.data_was_incomplete = True
638 else:
639 raise Exception, self.no_end_message
640
641
642
643 class KCBufferObject(KCContainerObject):
644
645 def IsEndMarker(self,o):
646 if o.IsContainerEnd():
647 raise Exception, "container end marker at the toplevel"
648 return o.IsBufferEnd()
649
650 no_end_message = "could not find buffer end marker"
651
652
653 class KCData_item:
654 """ a basic kcdata_item type object.
655 """
656 header_size = 16 # (uint32_t + uint32_t + uint64_t)
657
658 def __init__(self, item_type, item_size, item_flags, item_data):
659 self.i_type = item_type
660 self.i_size = item_size
661 self.i_flags = item_flags
662 self.i_data = item_data
663 self.i_offset = None
664
665 def __init__(self, barray, pos=0):
666 """ create an object by parsing data from bytes array
667 returns : obj - if data is readable
668 raises ValueError if something is not ok.
669 """
670 self.i_type = struct.unpack('I', barray[pos:pos+4])[0] # int.from_bytes(barray[pos:pos+4])
671 self.i_size = struct.unpack('I', barray[pos+4:pos+8])[0] # int.from_bytes(barray[pos+4:pos+8])
672 self.i_flags = struct.unpack('Q', barray[pos+8:pos+16])[0] # int.from_bytes(barray[pos+8:pos+16])
673 self.i_data = barray[pos+16: (pos + 16 + self.i_size)]
674 self.i_offset = pos
675
676 def __len__(self):
677 return self.i_size + KCData_item.header_size
678
679 def GetHeaderDescription(self):
680 outs = "type: 0x%x size: 0x%x flags: 0x%x (%s)" % (self.i_type, self.i_size, self.i_flags, GetTypeNameForKey(self.i_type))
681 if not self.i_offset is None:
682 outs = "pos: 0x%x" % self.i_offset + outs
683 return outs
684
685 def __str__(self):
686 return self.GetHeaderDescription()
687
688 def kcdata_item_iterator(data):
689 file_len = len(data)
690 curpos = 0
691 while curpos < file_len:
692 item = KCData_item(data, curpos)
693 yield item
694 curpos += len(item)
695
696 def _get_data_element(elementValues):
697 return json.dumps(elementValues[-1])
698
699 KNOWN_TOPLEVEL_CONTAINER_TYPES = map(GetTypeForName, ('KCDATA_BUFFER_BEGIN_CRASHINFO', 'KCDATA_BUFFER_BEGIN_STACKSHOT', 'KCDATA_BUFFER_BEGIN_DELTA_STACKSHOT', 'KCDATA_BUFFER_BEGIN_OS_REASON','KCDATA_BUFFER_BEGIN_XNUPOST_CONFIG'))
700
701 KNOWN_TYPES_COLLECTION[GetTypeForName('KCDATA_TYPE_UINT32_DESC')] = KCTypeDescription(GetTypeForName('KCDATA_TYPE_UINT32_DESC'), (
702 KCSubTypeElement('desc', KCSUBTYPE_TYPE.KC_ST_CHAR, KCSubTypeElement.GetSizeForArray(32, 1), 0, 1),
703 KCSubTypeElement('data', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 32, 0)
704 ),
705 'KCDATA_TYPE_UINT32_DESC',
706 _get_data_element
707 )
708
709 KNOWN_TYPES_COLLECTION[GetTypeForName('KCDATA_TYPE_UINT64_DESC')] = KCTypeDescription(GetTypeForName('KCDATA_TYPE_UINT64_DESC'), (
710 KCSubTypeElement('desc', KCSUBTYPE_TYPE.KC_ST_CHAR, KCSubTypeElement.GetSizeForArray(32, 1), 0, 1),
711 KCSubTypeElement('data', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 32, 0)
712 ),
713 'KCDATA_TYPE_UINT64_DESC',
714 _get_data_element
715 )
716
717 KNOWN_TYPES_COLLECTION[GetTypeForName('KCDATA_TYPE_TIMEBASE')] = KCTypeDescription(GetTypeForName('KCDATA_TYPE_TIMEBASE'), (
718 KCSubTypeElement('numer', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 0, 0),
719 KCSubTypeElement('denom', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4, 0)
720 ),
721 'mach_timebase_info'
722 )
723
724
725 STACKSHOT_IO_NUM_PRIORITIES = 4
726 KNOWN_TYPES_COLLECTION[0x901] = KCTypeDescription(0x901, (
727 KCSubTypeElement.FromBasicCtype('ss_disk_reads_count', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
728 KCSubTypeElement.FromBasicCtype('ss_disk_reads_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
729 KCSubTypeElement.FromBasicCtype('ss_disk_writes_count', KCSUBTYPE_TYPE.KC_ST_UINT64, 16),
730 KCSubTypeElement.FromBasicCtype('ss_disk_writes_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 24),
731 KCSubTypeElement('ss_io_priority_count', KCSUBTYPE_TYPE.KC_ST_UINT64, KCSubTypeElement.GetSizeForArray(STACKSHOT_IO_NUM_PRIORITIES, 8), 32, 1),
732 KCSubTypeElement('ss_io_priority_size', KCSUBTYPE_TYPE.KC_ST_UINT64, KCSubTypeElement.GetSizeForArray(STACKSHOT_IO_NUM_PRIORITIES, 8), 32 + (STACKSHOT_IO_NUM_PRIORITIES * 8), 1),
733 KCSubTypeElement.FromBasicCtype('ss_paging_count', KCSUBTYPE_TYPE.KC_ST_UINT64, 32 + 2 * (STACKSHOT_IO_NUM_PRIORITIES * 8)),
734 KCSubTypeElement.FromBasicCtype('ss_paging_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 40 + 2 * (STACKSHOT_IO_NUM_PRIORITIES * 8)),
735 KCSubTypeElement.FromBasicCtype('ss_non_paging_count', KCSUBTYPE_TYPE.KC_ST_UINT64, 48 + 2 * (STACKSHOT_IO_NUM_PRIORITIES * 8)),
736 KCSubTypeElement.FromBasicCtype('ss_non_paging_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 56 + 2 * (STACKSHOT_IO_NUM_PRIORITIES * 8)),
737 KCSubTypeElement.FromBasicCtype('ss_data_count', KCSUBTYPE_TYPE.KC_ST_UINT64, 64 + 2 * (STACKSHOT_IO_NUM_PRIORITIES * 8)),
738 KCSubTypeElement.FromBasicCtype('ss_data_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 72 + 2 * (STACKSHOT_IO_NUM_PRIORITIES * 8)),
739 KCSubTypeElement.FromBasicCtype('ss_metadata_count', KCSUBTYPE_TYPE.KC_ST_UINT64, 80 + 2 * (STACKSHOT_IO_NUM_PRIORITIES * 8)),
740 KCSubTypeElement.FromBasicCtype('ss_metadata_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 88 + 2 * (STACKSHOT_IO_NUM_PRIORITIES * 8))
741 ),
742 'io_statistics'
743 )
744
745 KNOWN_TYPES_COLLECTION[0x902] = KCTypeDescription(0x902, (
746 KCSubTypeElement('snapshot_magic', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 0, 0),
747 KCSubTypeElement('free_pages', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 1, 0),
748 KCSubTypeElement('active_pages', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 2, 0),
749 KCSubTypeElement('inactive_pages', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 3, 0),
750 KCSubTypeElement('purgeable_pages', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 4, 0),
751 KCSubTypeElement('wired_pages', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 5, 0),
752 KCSubTypeElement('speculative_pages', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 6, 0),
753 KCSubTypeElement('throttled_pages', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 7, 0),
754 KCSubTypeElement('filebacked_pages', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 8, 0),
755 KCSubTypeElement('compressions', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 9, 0),
756 KCSubTypeElement('decompressions', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 10, 0),
757 KCSubTypeElement('compressor_size', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 11, 0),
758 KCSubTypeElement('busy_buffer_count', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 4 * 12, 0),
759 KCSubTypeElement('pages_wanted', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 13, 0),
760 KCSubTypeElement('pages_reclaimed', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 4 * 14, 0),
761 KCSubTypeElement('pages_wanted_reclaimed_valid', KCSUBTYPE_TYPE.KC_ST_UINT8, 1, 4 * 15, 0)
762 ),
763 'mem_and_io_snapshot'
764 )
765
766
767 KNOWN_TYPES_COLLECTION[0x905] = KCTypeDescription(0x905, (
768 KCSubTypeElement.FromBasicCtype('ts_unique_pid', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
769 KCSubTypeElement.FromBasicCtype('ts_ss_flags', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
770 KCSubTypeElement.FromBasicCtype('ts_user_time_in_terminated_thre', KCSUBTYPE_TYPE.KC_ST_UINT64, 16),
771 KCSubTypeElement.FromBasicCtype('ts_system_time_in_terminated_th', KCSUBTYPE_TYPE.KC_ST_UINT64, 24),
772 KCSubTypeElement.FromBasicCtype('ts_p_start_sec', KCSUBTYPE_TYPE.KC_ST_UINT64, 32),
773 KCSubTypeElement.FromBasicCtype('ts_task_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 40),
774 KCSubTypeElement.FromBasicCtype('ts_max_resident_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 48),
775 KCSubTypeElement.FromBasicCtype('ts_suspend_count', KCSUBTYPE_TYPE.KC_ST_UINT32, 56),
776 KCSubTypeElement.FromBasicCtype('ts_faults', KCSUBTYPE_TYPE.KC_ST_UINT32, 60),
777 KCSubTypeElement.FromBasicCtype('ts_pageins', KCSUBTYPE_TYPE.KC_ST_UINT32, 64),
778 KCSubTypeElement.FromBasicCtype('ts_cow_faults', KCSUBTYPE_TYPE.KC_ST_UINT32, 68),
779 KCSubTypeElement.FromBasicCtype('ts_was_throttled', KCSUBTYPE_TYPE.KC_ST_UINT32, 72),
780 KCSubTypeElement.FromBasicCtype('ts_did_throttle', KCSUBTYPE_TYPE.KC_ST_UINT32, 76),
781 KCSubTypeElement.FromBasicCtype('ts_latency_qos', KCSUBTYPE_TYPE.KC_ST_UINT32, 80),
782 KCSubTypeElement.FromBasicCtype('ts_pid', KCSUBTYPE_TYPE.KC_ST_INT32, 84),
783 KCSubTypeElement('ts_p_comm', KCSUBTYPE_TYPE.KC_ST_CHAR, KCSubTypeElement.GetSizeForArray(32, 1), 88, 1)
784 ),
785 'task_snapshot'
786 )
787
788 KNOWN_TYPES_COLLECTION[0x906] = KCTypeDescription(0x906, (
789 KCSubTypeElement.FromBasicCtype('ths_thread_id', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
790 KCSubTypeElement.FromBasicCtype('ths_wait_event', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
791 KCSubTypeElement.FromBasicCtype('ths_continuation', KCSUBTYPE_TYPE.KC_ST_UINT64, 16),
792 KCSubTypeElement.FromBasicCtype('ths_total_syscalls', KCSUBTYPE_TYPE.KC_ST_UINT64, 24),
793 KCSubTypeElement.FromBasicCtype('ths_voucher_identifier', KCSUBTYPE_TYPE.KC_ST_UINT64, 32),
794 KCSubTypeElement.FromBasicCtype('ths_dqserialnum', KCSUBTYPE_TYPE.KC_ST_UINT64, 40),
795 KCSubTypeElement.FromBasicCtype('ths_user_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 48),
796 KCSubTypeElement.FromBasicCtype('ths_sys_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 56),
797 KCSubTypeElement.FromBasicCtype('ths_ss_flags', KCSUBTYPE_TYPE.KC_ST_UINT64, 64),
798 KCSubTypeElement.FromBasicCtype('ths_last_run_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 72),
799 KCSubTypeElement.FromBasicCtype('ths_last_made_runnable_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 80),
800 KCSubTypeElement.FromBasicCtype('ths_state', KCSUBTYPE_TYPE.KC_ST_UINT32, 88),
801 KCSubTypeElement.FromBasicCtype('ths_sched_flags', KCSUBTYPE_TYPE.KC_ST_UINT32, 92),
802 KCSubTypeElement.FromBasicCtype('ths_base_priority', KCSUBTYPE_TYPE.KC_ST_INT16, 96),
803 KCSubTypeElement.FromBasicCtype('ths_sched_priority', KCSUBTYPE_TYPE.KC_ST_INT16, 98),
804 KCSubTypeElement.FromBasicCtype('ths_eqos', KCSUBTYPE_TYPE.KC_ST_UINT8, 100),
805 KCSubTypeElement.FromBasicCtype('ths_rqos', KCSUBTYPE_TYPE.KC_ST_UINT8, 101),
806 KCSubTypeElement.FromBasicCtype('ths_rqos_override', KCSUBTYPE_TYPE.KC_ST_UINT8, 102),
807 KCSubTypeElement.FromBasicCtype('ths_io_tier', KCSUBTYPE_TYPE.KC_ST_UINT8, 103),
808 KCSubTypeElement.FromBasicCtype('ths_thread_t', KCSUBTYPE_TYPE.KC_ST_UINT64, 104),
809 KCSubTypeElement.FromBasicCtype('ths_requested_policy', KCSUBTYPE_TYPE.KC_ST_UINT64, 112),
810 KCSubTypeElement.FromBasicCtype('ths_effective_policy', KCSUBTYPE_TYPE.KC_ST_UINT64, 120),
811 ),
812 'thread_snapshot',
813 legacy_size = 0x68
814 )
815
816 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT'), (
817 KCSubTypeElement.FromBasicCtype('tds_thread_id', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
818 KCSubTypeElement.FromBasicCtype('tds_voucher_identifier', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
819 KCSubTypeElement.FromBasicCtype('tds_ss_flags', KCSUBTYPE_TYPE.KC_ST_UINT64, 16),
820 KCSubTypeElement.FromBasicCtype('tds_last_made_runnable_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 24),
821 KCSubTypeElement.FromBasicCtype('tds_state', KCSUBTYPE_TYPE.KC_ST_UINT32, 32),
822 KCSubTypeElement.FromBasicCtype('tds_sched_flags', KCSUBTYPE_TYPE.KC_ST_UINT32, 36),
823 KCSubTypeElement.FromBasicCtype('tds_base_priority', KCSUBTYPE_TYPE.KC_ST_INT16, 40),
824 KCSubTypeElement.FromBasicCtype('tds_sched_priority', KCSUBTYPE_TYPE.KC_ST_INT16, 42),
825 KCSubTypeElement.FromBasicCtype('tds_eqos', KCSUBTYPE_TYPE.KC_ST_UINT8, 44),
826 KCSubTypeElement.FromBasicCtype('tds_rqos', KCSUBTYPE_TYPE.KC_ST_UINT8, 45),
827 KCSubTypeElement.FromBasicCtype('tds_rqos_override', KCSUBTYPE_TYPE.KC_ST_UINT8, 46),
828 KCSubTypeElement.FromBasicCtype('tds_io_tier', KCSUBTYPE_TYPE.KC_ST_UINT8, 47),
829 KCSubTypeElement.FromBasicCtype('tds_requested_policy', KCSUBTYPE_TYPE.KC_ST_UINT64, 48),
830 KCSubTypeElement.FromBasicCtype('tds_effective_policy', KCSUBTYPE_TYPE.KC_ST_UINT64, 56),
831 ),
832 'thread_delta_snapshot',
833 legacy_size = 48
834 )
835
836 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_TASK_DELTA_SNAPSHOT')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_TASK_DELTA_SNAPSHOT'), (
837 KCSubTypeElement.FromBasicCtype('tds_unique_pid', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
838 KCSubTypeElement.FromBasicCtype('tds_ss_flags', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
839 KCSubTypeElement.FromBasicCtype('tds_user_time_in_terminated_thr', KCSUBTYPE_TYPE.KC_ST_UINT64, 16),
840 KCSubTypeElement.FromBasicCtype('tds_system_time_in_terminated_t', KCSUBTYPE_TYPE.KC_ST_UINT64, 24),
841 KCSubTypeElement.FromBasicCtype('tds_task_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 32),
842 KCSubTypeElement.FromBasicCtype('tds_max_resident_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 40),
843 KCSubTypeElement.FromBasicCtype('tds_suspend_count', KCSUBTYPE_TYPE.KC_ST_UINT32, 48),
844 KCSubTypeElement.FromBasicCtype('tds_faults', KCSUBTYPE_TYPE.KC_ST_UINT32, 52),
845 KCSubTypeElement.FromBasicCtype('tds_pageins', KCSUBTYPE_TYPE.KC_ST_UINT32, 56),
846 KCSubTypeElement.FromBasicCtype('tds_cow_faults', KCSUBTYPE_TYPE.KC_ST_UINT32, 60),
847 KCSubTypeElement.FromBasicCtype('tds_was_throttled', KCSUBTYPE_TYPE.KC_ST_UINT32, 64),
848 KCSubTypeElement.FromBasicCtype('tds_did_throttle', KCSUBTYPE_TYPE.KC_ST_UINT32, 68),
849 KCSubTypeElement.FromBasicCtype('tds_latency_qos', KCSUBTYPE_TYPE.KC_ST_UINT32, 72),
850 ),
851 'task_delta_snapshot'
852 )
853
854
855 KNOWN_TYPES_COLLECTION[0x909] = KCSubTypeElement('pth_name', KCSUBTYPE_TYPE.KC_ST_CHAR, KCSubTypeElement.GetSizeForArray(64, 1), 0, 1)
856
857
858
859 KNOWN_TYPES_COLLECTION[GetTypeForName('KCDATA_TYPE_LIBRARY_LOADINFO64')] = KCTypeDescription(GetTypeForName('KCDATA_TYPE_LIBRARY_LOADINFO64'), (
860 KCSubTypeElement('imageLoadAddress', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0),
861 KCSubTypeElement('imageUUID', KCSUBTYPE_TYPE.KC_ST_UINT8, KCSubTypeElement.GetSizeForArray(16, 1), 8, 1)
862 ),
863 'dyld_load_info',
864 legacy_size = 24
865 )
866
867 KNOWN_TYPES_COLLECTION[GetTypeForName('KCDATA_TYPE_LIBRARY_LOADINFO')] = KCTypeDescription(GetTypeForName('KCDATA_TYPE_LIBRARY_LOADINFO'), (
868 KCSubTypeElement('imageLoadAddress', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 0, 0),
869 KCSubTypeElement('imageUUID', KCSUBTYPE_TYPE.KC_ST_UINT8, KCSubTypeElement.GetSizeForArray(16, 1), 4, 1)
870 ),
871 'dyld_load_info',
872 legacy_size = 20
873 )
874
875 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO'), (
876 KCSubTypeElement('imageLoadAddress', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0),
877 KCSubTypeElement('imageUUID', KCSUBTYPE_TYPE.KC_ST_UINT8, KCSubTypeElement.GetSizeForArray(16, 1), 8, 1),
878 KCSubTypeElement('imageSlidBaseAddress', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 24, 0),
879 ),
880 'shared_cache_dyld_load_info',
881 legacy_size = 0x18
882 )
883
884 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERNELCACHE_LOADINFO')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_KERNELCACHE_LOADINFO'), (
885 KCSubTypeElement('imageLoadAddress', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0),
886 KCSubTypeElement('imageUUID', KCSUBTYPE_TYPE.KC_ST_UINT8, KCSubTypeElement.GetSizeForArray(16, 1), 8, 1),
887 ),
888 'kernelcache_load_info'
889 )
890
891 KNOWN_TYPES_COLLECTION[0x33] = KCSubTypeElement('mach_absolute_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0, KCSubTypeElement._get_naked_element_value)
892 KNOWN_TYPES_COLLECTION[0x907] = KCSubTypeElement.FromBasicCtype('donating_pids', KCSUBTYPE_TYPE.KC_ST_INT32, legacy_size=4)
893
894 KNOWN_TYPES_COLLECTION[GetTypeForName('KCDATA_TYPE_USECS_SINCE_EPOCH')] = KCSubTypeElement('usecs_since_epoch', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0, KCSubTypeElement._get_naked_element_value)
895
896 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKFRAME')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKFRAME'), (
897 KCSubTypeElement.FromBasicCtype('lr', KCSUBTYPE_TYPE.KC_ST_UINT32),
898 KCSubTypeElement.FromBasicCtype('sp', KCSUBTYPE_TYPE.KC_ST_UINT32, 4)
899 ),
900 'kernel_stack_frames',
901 legacy_size = 8
902 )
903
904 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKLR')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKLR'), (
905 KCSubTypeElement.FromBasicCtype('lr', KCSUBTYPE_TYPE.KC_ST_UINT32),
906 ),
907 'kernel_stack_frames'
908 )
909
910
911 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_USER_STACKFRAME')] = KCTypeDescription.FromKCTypeDescription(
912 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKFRAME')],
913 GetTypeForName('STACKSHOT_KCTYPE_USER_STACKFRAME'),
914 'user_stack_frames'
915 )
916
917 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_USER_STACKLR')] = KCTypeDescription.FromKCTypeDescription(
918 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKLR')],
919 GetTypeForName('STACKSHOT_KCTYPE_USER_STACKLR'),
920 'user_stack_frames'
921 )
922
923 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKFRAME64')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKFRAME64'), (
924 KCSubTypeElement.FromBasicCtype('lr', KCSUBTYPE_TYPE.KC_ST_UINT64),
925 KCSubTypeElement.FromBasicCtype('sp', KCSUBTYPE_TYPE.KC_ST_UINT64, 8)
926 ),
927 'kernel_stack_frames',
928 legacy_size = 16
929 )
930
931 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_USER_STACKFRAME64')] = KCTypeDescription.FromKCTypeDescription(
932 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKFRAME64')],
933 GetTypeForName('STACKSHOT_KCTYPE_USER_STACKFRAME64'),
934 'user_stack_frames'
935 )
936
937
938 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKLR64')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKLR64'), (
939 KCSubTypeElement.FromBasicCtype('lr', KCSUBTYPE_TYPE.KC_ST_UINT64),
940 ),
941 'kernel_stack_frames'
942 )
943
944 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_USER_STACKLR64')] = KCTypeDescription.FromKCTypeDescription(
945 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERN_STACKLR64')],
946 GetTypeForName('STACKSHOT_KCTYPE_USER_STACKLR64'),
947 'user_stack_frames'
948 )
949
950
951 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_NONRUNNABLE_TIDS')] = KCSubTypeElement.FromBasicCtype('nonrunnable_threads', KCSUBTYPE_TYPE.KC_ST_INT64)
952
953 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_NONRUNNABLE_TASKS')] = KCSubTypeElement.FromBasicCtype('nonrunnable_tasks', KCSUBTYPE_TYPE.KC_ST_INT64)
954
955 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_OSVERSION')] = KCSubTypeElement('osversion', KCSUBTYPE_TYPE.KC_ST_CHAR,
956 KCSubTypeElement.GetSizeForArray(256, 1), 0, 1)
957
958 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_BOOTARGS')] = KCSubTypeElement('boot_args', KCSUBTYPE_TYPE.KC_ST_CHAR,
959 KCSubTypeElement.GetSizeForArray(256, 1), 0, 1)
960
961 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_KERN_PAGE_SIZE')] = KCSubTypeElement('kernel_page_size', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 0, 0, KCSubTypeElement._get_naked_element_value)
962
963 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_THREAD_POLICY_VERSION')] = KCSubTypeElement('thread_policy_version', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 0, 0, KCSubTypeElement._get_naked_element_value)
964
965 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_JETSAM_LEVEL')] = KCSubTypeElement('jetsam_level', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 0, 0, KCSubTypeElement._get_naked_element_value)
966
967 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_DELTA_SINCE_TIMESTAMP')] = KCSubTypeElement("stackshot_delta_since_timestamp", KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0, KCSubTypeElement._get_naked_element_value)
968
969 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_STACKSHOT_FAULT_STATS')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_STACKSHOT_FAULT_STATS'),
970 (
971 KCSubTypeElement.FromBasicCtype('sfs_pages_faulted_in', KCSUBTYPE_TYPE.KC_ST_UINT32, 0),
972 KCSubTypeElement.FromBasicCtype('sfs_time_spent_faulting', KCSUBTYPE_TYPE.KC_ST_UINT64, 4),
973 KCSubTypeElement.FromBasicCtype('sfs_system_max_fault_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 12),
974 KCSubTypeElement.FromBasicCtype('sfs_stopped_faulting', KCSUBTYPE_TYPE.KC_ST_UINT8, 20)
975 ),
976 'stackshot_fault_stats')
977
978 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_THREAD_WAITINFO')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_THREAD_WAITINFO'),
979 (
980 KCSubTypeElement.FromBasicCtype('owner', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
981 KCSubTypeElement.FromBasicCtype('waiter', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
982 KCSubTypeElement.FromBasicCtype('context', KCSUBTYPE_TYPE.KC_ST_UINT64, 16),
983 KCSubTypeElement.FromBasicCtype('wait_type', KCSUBTYPE_TYPE.KC_ST_UINT8, 24)
984 ),
985 'thread_waitinfo')
986
987 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_THREAD_GROUP_SNAPSHOT')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_THREAD_GROUP'),
988 (
989 KCSubTypeElement.FromBasicCtype('tgs_id', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
990 KCSubTypeElement('tgs_name', KCSUBTYPE_TYPE.KC_ST_CHAR, KCSubTypeElement.GetSizeForArray(16, 1),
991 8, 1),
992 KCSubTypeElement.FromBasicCtype('tgs_flags', KCSUBTYPE_TYPE.KC_ST_UINT64, 24),
993 ),
994 'thread_group_snapshot')
995
996
997 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_THREAD_GROUP')] = KCSubTypeElement('thread_group', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0, KCSubTypeElement._get_naked_element_value)
998
999 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_JETSAM_COALITION_SNAPSHOT')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_JETSAM_COALITION_SNAPSHOT'),
1000 (
1001 KCSubTypeElement.FromBasicCtype('jcs_id', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
1002 KCSubTypeElement.FromBasicCtype('jcs_flags', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
1003 KCSubTypeElement.FromBasicCtype('jcs_thread_group', KCSUBTYPE_TYPE.KC_ST_UINT64, 16),
1004 KCSubTypeElement.FromBasicCtype('jcs_leader_task_uniqueid', KCSUBTYPE_TYPE.KC_ST_UINT64, 24)
1005 ),
1006 'jetsam_coalition_snapshot')
1007
1008 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_JETSAM_COALITION')] = KCSubTypeElement('jetsam_coalition', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0, KCSubTypeElement._get_naked_element_value)
1009
1010 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_INSTRS_CYCLES')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_INSTRS_CYCLES'),
1011 (
1012 KCSubTypeElement.FromBasicCtype('ics_instructions', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
1013 KCSubTypeElement.FromBasicCtype('ics_cycles', KCSUBTYPE_TYPE.KC_ST_UINT64, 8)
1014 ),
1015 'instrs_cycles_snapshot')
1016
1017 #KNOWN_TYPES_COLLECTION[0x907] = KCSubTypeElement('donating_pids', KCSUBTYPE_TYPE.KC_ST_UINT32, 4, 0, 0, KCSubTypeElement._get_naked_element_value)
1018 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_PID')] = KCSubTypeElement('pid', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1019 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_PPID')] = KCSubTypeElement('ppid', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1020 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_PROC_NAME')] = KCSubTypeElement('p_comm', KCSUBTYPE_TYPE.KC_ST_CHAR,
1021 KCSubTypeElement.GetSizeForArray(32, 1), 0, 1)
1022 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_USERSTACK')] = KCSubTypeElement('userstack_ptr', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0)
1023 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_ARGSLEN')] = KCSubTypeElement('p_argslen', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1024
1025 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_PROC_PATH')] = KCSubTypeElement('p_path', KCSUBTYPE_TYPE.KC_ST_CHAR,
1026 KCSubTypeElement.GetSizeForArray(1024, 1), 0, 1)
1027 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_PROC_CSFLAGS')] = KCSubTypeElement('p_csflags', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1028 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_UID')] = KCSubTypeElement('uid', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1029 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_GID')] = KCSubTypeElement('gid', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1030 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_PROC_ARGC')] = KCSubTypeElement('argc', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1031 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_PROC_FLAGS')] = KCSubTypeElement('p_flags', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1032 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_CPUTYPE')] = KCSubTypeElement('cputype', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1033 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_RESPONSIBLE_PID')] = KCSubTypeElement('responsible_pid', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1034 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_DIRTY_FLAGS')] = KCSubTypeElement('dirty_flags', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0)
1035 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_CRASHED_THREADID')] = KCSubTypeElement('crashed_threadid', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0)
1036 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_COALITION_ID')] = KCSubTypeElement('coalition_id', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0)
1037
1038 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_PROC_STATUS')] = KCSubTypeElement('p_status', KCSUBTYPE_TYPE.KC_ST_UINT8, 1, 0, 0)
1039
1040 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_BSDINFOWITHUNIQID')] = KCTypeDescription(GetTypeForName('TASK_CRASHINFO_BSDINFOWITHUNIQID'),
1041 ( KCSubTypeElement('p_uuid', KCSUBTYPE_TYPE.KC_ST_UINT8, KCSubTypeElement.GetSizeForArray(16, 1), 0, 1),
1042 KCSubTypeElement.FromBasicCtype('p_uniqueid', KCSUBTYPE_TYPE.KC_ST_UINT64, 16),
1043 KCSubTypeElement.FromBasicCtype('p_puniqueid', KCSUBTYPE_TYPE.KC_ST_UINT64, 24)
1044 ),
1045 'proc_uniqidentifierinfo')
1046
1047 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_EXCEPTION_CODES')] = (
1048 KCTypeDescription(GetTypeForName('TASK_CRASHINFO_EXCEPTION_CODES'),
1049 (KCSubTypeElement.FromBasicCtype('code_0', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
1050 KCSubTypeElement.FromBasicCtype('code_1', KCSUBTYPE_TYPE.KC_ST_UINT64, 8)),
1051 'mach_exception_data_t'))
1052
1053
1054 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_PROC_STARTTIME')] = (
1055 KCTypeDescription(GetTypeForName('TASK_CRASHINFO_PROC_STARTTIME'),
1056 (KCSubTypeElement.FromBasicCtype('tv_sec', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
1057 KCSubTypeElement.FromBasicCtype('tv_usec', KCSUBTYPE_TYPE.KC_ST_UINT64, 8)),
1058 'proc_starttime'))
1059
1060
1061 KNOWN_TYPES_COLLECTION[GetTypeForName('TASK_CRASHINFO_RUSAGE_INFO')] = KCTypeDescription(GetTypeForName('TASK_CRASHINFO_RUSAGE_INFO'),
1062 (
1063 KCSubTypeElement('ri_uuid', KCSUBTYPE_TYPE.KC_ST_UINT8, KCSubTypeElement.GetSizeForArray(16, 1), 0, 1),
1064 KCSubTypeElement.FromBasicCtype('ri_user_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 16),
1065 KCSubTypeElement.FromBasicCtype('ri_system_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 24),
1066 KCSubTypeElement.FromBasicCtype('ri_pkg_idle_wkups', KCSUBTYPE_TYPE.KC_ST_UINT64, 32),
1067 KCSubTypeElement.FromBasicCtype('ri_interrupt_wkups', KCSUBTYPE_TYPE.KC_ST_UINT64, 40),
1068 KCSubTypeElement.FromBasicCtype('ri_pageins', KCSUBTYPE_TYPE.KC_ST_UINT64, 48),
1069 KCSubTypeElement.FromBasicCtype('ri_wired_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 56),
1070 KCSubTypeElement.FromBasicCtype('ri_resident_size', KCSUBTYPE_TYPE.KC_ST_UINT64, 64),
1071 KCSubTypeElement.FromBasicCtype('ri_phys_footprint', KCSUBTYPE_TYPE.KC_ST_UINT64, 72),
1072 KCSubTypeElement.FromBasicCtype('ri_proc_start_abstime', KCSUBTYPE_TYPE.KC_ST_UINT64, 80),
1073 KCSubTypeElement.FromBasicCtype('ri_proc_exit_abstime', KCSUBTYPE_TYPE.KC_ST_UINT64, 88),
1074 KCSubTypeElement.FromBasicCtype('ri_child_user_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 96),
1075 KCSubTypeElement.FromBasicCtype('ri_child_system_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 104),
1076 KCSubTypeElement.FromBasicCtype('ri_child_pkg_idle_wkups', KCSUBTYPE_TYPE.KC_ST_UINT64, 112),
1077 KCSubTypeElement.FromBasicCtype('ri_child_interrupt_wkups', KCSUBTYPE_TYPE.KC_ST_UINT64, 120),
1078 KCSubTypeElement.FromBasicCtype('ri_child_pageins', KCSUBTYPE_TYPE.KC_ST_UINT64, 128),
1079 KCSubTypeElement.FromBasicCtype('ri_child_elapsed_abstime', KCSUBTYPE_TYPE.KC_ST_UINT64, 136),
1080 KCSubTypeElement.FromBasicCtype('ri_diskio_bytesread', KCSUBTYPE_TYPE.KC_ST_UINT64, 144),
1081 KCSubTypeElement.FromBasicCtype('ri_diskio_byteswritten', KCSUBTYPE_TYPE.KC_ST_UINT64, 152),
1082 KCSubTypeElement.FromBasicCtype('ri_cpu_time_qos_default', KCSUBTYPE_TYPE.KC_ST_UINT64, 160),
1083 KCSubTypeElement.FromBasicCtype('ri_cpu_time_qos_maintenance', KCSUBTYPE_TYPE.KC_ST_UINT64, 168),
1084 KCSubTypeElement.FromBasicCtype('ri_cpu_time_qos_background', KCSUBTYPE_TYPE.KC_ST_UINT64, 176),
1085 KCSubTypeElement.FromBasicCtype('ri_cpu_time_qos_utility', KCSUBTYPE_TYPE.KC_ST_UINT64, 184),
1086 KCSubTypeElement.FromBasicCtype('ri_cpu_time_qos_legacy', KCSUBTYPE_TYPE.KC_ST_UINT64, 192),
1087 KCSubTypeElement.FromBasicCtype('ri_cpu_time_qos_user_initiated', KCSUBTYPE_TYPE.KC_ST_UINT64, 200),
1088 KCSubTypeElement.FromBasicCtype('ri_cpu_time_qos_user_interactiv', KCSUBTYPE_TYPE.KC_ST_UINT64, 208),
1089 KCSubTypeElement.FromBasicCtype('ri_billed_system_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 216),
1090 KCSubTypeElement.FromBasicCtype('ri_serviced_system_time', KCSUBTYPE_TYPE.KC_ST_UINT64, 224)
1091 ),
1092 'rusage_info')
1093
1094 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_CPU_TIMES')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_CPU_TIMES'),
1095 (
1096 KCSubTypeElement.FromBasicCtype('user_usec', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
1097 KCSubTypeElement.FromBasicCtype('system_usec', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
1098 ), 'cpu_times')
1099
1100 KNOWN_TYPES_COLLECTION[GetTypeForName('STACKSHOT_KCTYPE_STACKSHOT_DURATION')] = KCTypeDescription(GetTypeForName('STACKSHOT_KCTYPE_STACKSHOT_DURATION'),
1101 (
1102 KCSubTypeElement.FromBasicCtype('stackshot_duration', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
1103 KCSubTypeElement.FromBasicCtype('stackshot_duration_outer', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
1104 ), 'stackshot_duration', merge=True
1105 )
1106
1107 KNOWN_TYPES_COLLECTION[GetTypeForName('KCDATA_TYPE_PROCNAME')] = (
1108 KCSubTypeElement("proc_name", KCSUBTYPE_TYPE.KC_ST_CHAR, KCSubTypeElement.GetSizeForArray(-1, 1), 0, 1))
1109
1110 KNOWN_TYPES_COLLECTION[GetTypeForName('KCDATA_TYPE_PID')] = (
1111 KCSubTypeElement('pid', KCSUBTYPE_TYPE.KC_ST_INT32, 4, 0, 0))
1112
1113 KNOWN_TYPES_COLLECTION[GetTypeForName('EXIT_REASON_SNAPSHOT')] = KCTypeDescription(GetTypeForName('EXIT_REASON_SNAPSHOT'),
1114 (
1115 KCSubTypeElement.FromBasicCtype('ers_namespace', KCSUBTYPE_TYPE.KC_ST_UINT32, 0),
1116 KCSubTypeElement.FromBasicCtype('ers_code', KCSUBTYPE_TYPE.KC_ST_UINT64, 4),
1117 KCSubTypeElement.FromBasicCtype('ers_flags', KCSUBTYPE_TYPE.KC_ST_UINT64, 12),
1118 ), 'exit_reason_basic_info')
1119
1120 KNOWN_TYPES_COLLECTION[GetTypeForName('EXIT_REASON_USER_DESC')] = (
1121 KCSubTypeElement("exit_reason_user_description", KCSUBTYPE_TYPE.KC_ST_CHAR, KCSubTypeElement.GetSizeForArray(-1, 1), 0, 1))
1122
1123 KNOWN_TYPES_COLLECTION[GetTypeForName('EXIT_REASON_USER_PAYLOAD')] = KCSubTypeElement('exit_reason_user_payload',
1124 KCSUBTYPE_TYPE.KC_ST_UINT8, KCSubTypeElement.GetSizeForArray(-1, 1), 0, 1)
1125
1126 KNOWN_TYPES_COLLECTION[GetTypeForName('EXIT_REASON_CODESIGNING_INFO')] = KCTypeDescription(GetTypeForName('EXIT_REASON_CODESIGNING_INFO'),
1127 (
1128 KCSubTypeElement.FromBasicCtype('ceri_virt_addr', KCSUBTYPE_TYPE.KC_ST_UINT64, 0),
1129 KCSubTypeElement.FromBasicCtype('ceri_file_offset', KCSUBTYPE_TYPE.KC_ST_UINT64, 8),
1130 KCSubTypeElement("ceri_pathname", KCSUBTYPE_TYPE.KC_ST_CHAR, KCSubTypeElement.GetSizeForArray(1024, 1), 16, 1),
1131 KCSubTypeElement("ceri_filename", KCSUBTYPE_TYPE.KC_ST_CHAR, KCSubTypeElement.GetSizeForArray(1024, 1), 1040, 1),
1132 KCSubTypeElement.FromBasicCtype('ceri_codesig_modtime_secs', KCSUBTYPE_TYPE.KC_ST_UINT64, 2064),
1133 KCSubTypeElement.FromBasicCtype('ceri_codesig_modtime_nsecs', KCSUBTYPE_TYPE.KC_ST_UINT64, 2072),
1134 KCSubTypeElement.FromBasicCtype('ceri_page_modtime_secs', KCSUBTYPE_TYPE.KC_ST_UINT64, 2080),
1135 KCSubTypeElement.FromBasicCtype('ceri_page_modtime_nsecs', KCSUBTYPE_TYPE.KC_ST_UINT64, 2088),
1136 KCSubTypeElement.FromBasicCtype('ceri_path_truncated', KCSUBTYPE_TYPE.KC_ST_UINT8, 2096),
1137 KCSubTypeElement.FromBasicCtype('ceri_object_codesigned', KCSUBTYPE_TYPE.KC_ST_UINT8, 2097),
1138 KCSubTypeElement.FromBasicCtype('ceri_page_codesig_validated', KCSUBTYPE_TYPE.KC_ST_UINT8, 2098),
1139 KCSubTypeElement.FromBasicCtype('ceri_page_codesig_tainted', KCSUBTYPE_TYPE.KC_ST_UINT8, 2099),
1140 KCSubTypeElement.FromBasicCtype('ceri_page_codesig_nx', KCSUBTYPE_TYPE.KC_ST_UINT8, 2100),
1141 KCSubTypeElement.FromBasicCtype('ceri_page_wpmapped', KCSUBTYPE_TYPE.KC_ST_UINT8, 2101),
1142 KCSubTypeElement.FromBasicCtype('ceri_page_slid', KCSUBTYPE_TYPE.KC_ST_UINT8, 2102),
1143 KCSubTypeElement.FromBasicCtype('ceri_page_dirty', KCSUBTYPE_TYPE.KC_ST_UINT8, 2103),
1144 KCSubTypeElement.FromBasicCtype('ceri_page_shadow_depth', KCSUBTYPE_TYPE.KC_ST_UINT32, 2104),
1145 ), 'exit_reason_codesigning_info')
1146
1147 KNOWN_TYPES_COLLECTION[GetTypeForName('EXIT_REASON_WORKLOOP_ID')] = (
1148 KCSubTypeElement('exit_reason_workloop_id', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0, KCSubTypeElement._get_naked_element_value))
1149
1150 KNOWN_TYPES_COLLECTION[GetTypeForName('EXIT_REASON_DISPATCH_QUEUE_NO')] = (
1151 KCSubTypeElement('exit_reason_dispatch_queue_no', KCSUBTYPE_TYPE.KC_ST_UINT64, 8, 0, 0, KCSubTypeElement._get_naked_element_value))
1152
1153 def GetSecondsFromMATime(mat, tb):
1154 return (float(mat) * tb['numer']) / tb['denom']
1155
1156 def FindLibraryForAddress(liblist, address):
1157 current_lib = None
1158 for l in liblist:
1159 if address >= l[1]:
1160 current_lib = l
1161 return current_lib
1162
1163 def FindIndexOfLibInCatalog(catalog, lib):
1164 index = None
1165 i = 0
1166 for l in catalog:
1167 if l[0] == lib[0] and l[1] == lib[1]:
1168 index = i
1169 break
1170 i += 1
1171
1172 if index is None:
1173 catalog.append(lib)
1174 index = len(catalog) - 1
1175
1176 return index
1177
1178 def GetOffsetOfAddressForLib(lib, address):
1179 return (address - lib[1])
1180
1181 def GetSymbolInfoForFrame(catalog, liblist, address):
1182 lib = FindLibraryForAddress(liblist, address)
1183 if not lib:
1184 lib = ["00000000000000000000000000000000",0,"A"]
1185 offset = GetOffsetOfAddressForLib(lib, address)
1186 index = FindIndexOfLibInCatalog(catalog, lib)
1187 return [index, offset]
1188
1189 def GetStateDescription(s):
1190 retval = []
1191 TH_WAIT = 0x01
1192 TH_SUSP = 0x02
1193 TH_RUN = 0x04
1194 TH_UNINT = 0x08
1195 TH_TERMINATE = 0x10
1196 TH_TERMINATE2 = 0x20
1197 TH_IDLE = 0x80
1198 if (s & TH_WAIT):
1199 retval.append("TH_WAIT")
1200 if (s & TH_SUSP):
1201 retval.append("TH_SUSP")
1202 if (s & TH_RUN):
1203 retval.append("TH_RUN")
1204 if (s & TH_UNINT):
1205 retval.append("TH_UNINT")
1206 if (s & TH_TERMINATE):
1207 retval.append("TH_TERMINATE")
1208 if (s & TH_TERMINATE2):
1209 retval.append("TH_TERMINATE2")
1210 if (s & TH_IDLE):
1211 retval.append("TH_IDLE")
1212 return retval
1213
1214
1215 def format_uuid(elementValues):
1216 return ''.join("%02x" % i for i in elementValues)
1217
1218 kThreadWaitNone = 0x00
1219 kThreadWaitKernelMutex = 0x01
1220 kThreadWaitPortReceive = 0x02
1221 kThreadWaitPortSetReceive = 0x03
1222 kThreadWaitPortSend = 0x04
1223 kThreadWaitPortSendInTransit = 0x05
1224 kThreadWaitSemaphore = 0x06
1225 kThreadWaitKernelRWLockRead = 0x07
1226 kThreadWaitKernelRWLockWrite = 0x08
1227 kThreadWaitKernelRWLockUpgrade = 0x09
1228 kThreadWaitUserLock = 0x0a
1229 kThreadWaitPThreadMutex = 0x0b
1230 kThreadWaitPThreadRWLockRead = 0x0c
1231 kThreadWaitPThreadRWLockWrite = 0x0d
1232 kThreadWaitPThreadCondVar = 0x0e
1233 kThreadWaitParkedWorkQueue = 0x0f
1234 kThreadWaitWorkloopSyncWait = 0x10
1235
1236
1237 UINT64_MAX = 0xffffffffffffffff
1238 STACKSHOT_WAITOWNER_KERNEL = (UINT64_MAX - 1)
1239 STACKSHOT_WAITOWNER_PORT_LOCKED = (UINT64_MAX - 2)
1240 STACKSHOT_WAITOWNER_PSET_LOCKED = (UINT64_MAX - 3)
1241 STACKSHOT_WAITOWNER_INTRANSIT = (UINT64_MAX - 4)
1242 STACKSHOT_WAITOWNER_MTXSPIN = (UINT64_MAX - 5)
1243 STACKSHOT_WAITOWNER_THREQUESTED = (UINT64_MAX - 6)
1244 STACKSHOT_WAITOWNER_SUSPENDED = (UINT64_MAX - 7)
1245
1246 def formatWaitInfo(info):
1247 s = 'thread %d: ' % info['waiter'];
1248 type = info['wait_type']
1249 context = info['context']
1250 owner = info['owner']
1251 if type == kThreadWaitKernelMutex:
1252 s += 'kernel mutex %x' % context
1253 if owner == STACKSHOT_WAITOWNER_MTXSPIN:
1254 s += " in spin mode"
1255 elif owner:
1256 s += " owned by thread %u" % owner
1257 else:
1258 s += "with unknown owner"
1259 elif type == kThreadWaitPortReceive:
1260 s += "mach_msg receive on "
1261 if owner == STACKSHOT_WAITOWNER_PORT_LOCKED:
1262 s += "locked port %x" % context
1263 elif owner == STACKSHOT_WAITOWNER_INTRANSIT:
1264 s += "intransit port %x" % context
1265 elif owner:
1266 s += "port %x name %x" % (context, owner)
1267 else:
1268 s += "port %x" % context
1269 elif type == kThreadWaitPortSetReceive:
1270 if owner == STACKSHOT_WAITOWNER_PSET_LOCKED:
1271 s += "mach_msg receive on locked port set %x" % context
1272 else:
1273 s += "mach_msg receive on port set %x" % context
1274 elif type == kThreadWaitPortSend:
1275 s += "mach_msg send on "
1276 if owner == STACKSHOT_WAITOWNER_PORT_LOCKED:
1277 s += "locked port %x" % context
1278 elif owner == STACKSHOT_WAITOWNER_INTRANSIT:
1279 s += "intransit port %x" % context
1280 elif owner == STACKSHOT_WAITOWNER_KERNEL:
1281 s += "port %x owned by kernel" % context
1282 elif owner:
1283 s += "port %x owned by pid %d" % (context, owner)
1284 else:
1285 s += "port %x with unknown owner" % context
1286 elif type == kThreadWaitPortSendInTransit:
1287 s += "mach_msg send on port %x in transit to " % context
1288 if owner:
1289 s += "port %x" % owner
1290 else:
1291 s += "unknown port"
1292 elif type == kThreadWaitSemaphore:
1293 s += "semaphore port %x " % context
1294 if owner:
1295 s += "owned by pid %d" % owner
1296 else:
1297 s += "with unknown owner"
1298 elif type == kThreadWaitKernelRWLockRead:
1299 s += "krwlock %x for reading" % context
1300 elif type == kThreadWaitKernelRWLockWrite:
1301 s += "krwlock %x for writing" % context
1302 elif type == kThreadWaitKernelRWLockUpgrade:
1303 s += "krwlock %x for upgrading" % context
1304 elif type == kThreadWaitUserLock:
1305 if owner:
1306 s += "unfair lock %x owned by thread %d" % (context, owner)
1307 else:
1308 s += "spin lock %x" % context
1309 elif type == kThreadWaitPThreadMutex:
1310 s += "pthread mutex %x" % context
1311 if owner:
1312 s += " owned by thread %d" % owner
1313 else:
1314 s += " with unknown owner"
1315 elif type == kThreadWaitPThreadRWLockRead:
1316 s += "pthread rwlock %x for reading" % context
1317 elif type == kThreadWaitPThreadRWLockWrite:
1318 s += "pthread rwlock %x for writing" % context
1319 elif type == kThreadWaitPThreadCondVar:
1320 s += "pthread condvar %x" % context
1321 elif type == kThreadWaitWorkloopSyncWait:
1322 s += "workloop sync wait"
1323 if owner == STACKSHOT_WAITOWNER_SUSPENDED:
1324 s += ", suspended"
1325 elif owner == STACKSHOT_WAITOWNER_THREQUESTED:
1326 s += ", thread requested"
1327 elif owner != 0:
1328 s += ", owned by thread %u" % owner
1329 else:
1330 s += ", unknown owner"
1331 s += ", workloop id %x" % context
1332 else:
1333 s += "unknown type %d (owner %d, context %x)" % (type, owner, context)
1334
1335 return s
1336
1337
1338 def SaveStackshotReport(j, outfile_name, dsc_uuid, dsc_libs_arr, incomplete):
1339 import time
1340 from operator import itemgetter, attrgetter
1341 ss = j.get('kcdata_stackshot')
1342 if not ss:
1343 print "No KCDATA_BUFFER_BEGIN_STACKSHOT object found. Skipping writing report."
1344 return
1345
1346 timestamp = ss.get('usecs_since_epoch', int(time.time()))
1347 try:
1348 timestamp = time.strftime("%Y-%m-%d %H:%M:%S %z",time.gmtime(timestamp))
1349 except ValueError, e:
1350 print "couldn't convert timestamp:", str(e)
1351 timestamp = None
1352
1353 os_version = ss.get('osversion', 'Unknown')
1354 timebase = ss.get('mach_timebase_info', {"denom": 1, "numer": 1})
1355 if not dsc_uuid and 'imageSlidBaseAddress' not in ss.get('shared_cache_dyld_load_info'):
1356 print "Stackshot format does not include slid shared cache base address and no UUID provided. Skipping writing report."
1357 return
1358
1359 # If a shared cache UUID is provided, treat the slide as the base address
1360 # for compatibility with existing tools that operate based on this logic
1361 if dsc_uuid:
1362 shared_cache_base_addr = ss.get('shared_cache_dyld_load_info')['imageLoadAddress']
1363 elif 'imageSlidBaseAddress' in ss.get('shared_cache_dyld_load_info'):
1364 shared_cache_base_addr = ss.get('shared_cache_dyld_load_info')['imageSlidBaseAddress']
1365 else:
1366 print "No shared cache UUID provided and data doesn't include imageSlidBaseAddress. Skipping writing report."
1367 return
1368
1369 dsc_common = [format_uuid(ss.get('shared_cache_dyld_load_info')['imageUUID']),
1370 shared_cache_base_addr,
1371 "S"
1372 ]
1373
1374 dsc_libs = []
1375 print "Shared cache UUID found from the binary data is <%s> " % str(dsc_common[0])
1376 if dsc_common[0].replace('-', '').lower() == dsc_uuid:
1377 print "SUCCESS: Found Matching dyld shared cache uuid. Loading library load addresses from layout provided."
1378 _load_addr = dsc_common[1]
1379 #print _load_addr
1380 #print dsc_libs_arr
1381 for i in dsc_libs_arr:
1382 _uuid = i[2].lower().replace('-','').strip()
1383 _addr = int(i[0], 16) + _load_addr
1384 dsc_libs.append([_uuid, _addr, "P"])
1385 #print "adding ", [_uuid, _addr, "C"]
1386 elif dsc_uuid:
1387 print "Provided shared cache UUID does not match. Skipping writing report."
1388 return
1389
1390 AllImageCatalog = []
1391 obj = {}
1392 obj["kernel"] = os_version
1393 if timestamp is not None:
1394 obj["date"] = timestamp
1395 obj["reason"] = "kernel panic stackshot"
1396 obj["incident"] = "ABCDEFGH-1234-56IJ-789K-0LMNOPQRSTUV"
1397 obj["crashReporterKey"] = "12ab34cd45aabbccdd6712ab34cd45aabbccdd67"
1398 obj["bootArgs"] = ss.get('boot_args','')
1399 obj["frontmostPids"] = [0]
1400 obj["exception"] = "0xDEADF157"
1401 obj["processByPid"] = {}
1402
1403 if incomplete:
1404 obj["reason"] = "!!!INCOMPLETE!!! kernel panic stackshot"
1405 obj["notes"] = "This stackshot report generated from incomplete data! Some information is missing! "
1406
1407 processByPid = obj["processByPid"]
1408 ssplist = ss.get('task_snapshots', {})
1409 kern_load_info = []
1410 if "0" in ssplist:
1411 kc_uuid = ssplist["0"].get('kernelcache_load_info', None)
1412 if kc_uuid:
1413 kernelcache_uuid = [format_uuid(kc_uuid['imageUUID']), kc_uuid['imageLoadAddress'], "U" ]
1414 kern_load_info.append(kernelcache_uuid)
1415
1416 kl_infos = ssplist["0"].get("dyld_load_info", [])
1417 for dlinfo in kl_infos:
1418 kern_load_info.append([format_uuid(dlinfo['imageUUID']), dlinfo['imageLoadAddress'], "K"])
1419 for pid,piddata in ssplist.iteritems():
1420 processByPid[str(pid)] = {}
1421 tsnap = processByPid[str(pid)]
1422 pr_lib_dsc = dsc_common
1423 if 'shared_cache_dyld_load_info' in tsnap:
1424 if 'imageSlidBaseAddress' in tsnap.get('shared_cache_dyld_load_info'):
1425 shared_cache_base_addr = tsnap.get('shared_cache_dyld_load_info')['imageSlidBaseAddress']
1426 else:
1427 print "Specific task shared cache format does not include slid shared cache base address. Skipping writing report."
1428 return
1429
1430 pr_lib_dsc = [format_uuid(tsnap.get('shared_cache_dyld_load_info')['imageUUID']),
1431 tsnap.get('shared_cache_dyld_load_info')['imageSlidBaseAddress'],
1432 "S"
1433 ]
1434
1435 pr_libs = []
1436 if len(dsc_libs) == 0:
1437 pr_libs.append(pr_lib_dsc)
1438 _lib_type = "P"
1439 if int(pid) == 0:
1440 _lib_type = "K"
1441 pr_libs = []
1442 else:
1443 for dlinfo in piddata.get('dyld_load_info',[]):
1444 pr_libs.append([format_uuid(dlinfo['imageUUID']), dlinfo['imageLoadAddress'], _lib_type])
1445
1446 pr_libs.extend(kern_load_info)
1447 pr_libs.extend(dsc_libs)
1448
1449 pr_libs.sort(key=itemgetter(1))
1450
1451 if 'task_snapshot' not in piddata:
1452 continue
1453 tasksnap = piddata['task_snapshot']
1454 tsnap["pid"] = tasksnap["ts_pid"]
1455 tsnap["residentMemoryBytes"] = tasksnap["ts_task_size"]
1456 tsnap["timesDidThrottle"] = tasksnap["ts_did_throttle"]
1457 tsnap["systemTimeTask"] = GetSecondsFromMATime(tasksnap["ts_system_time_in_terminated_th"], timebase)
1458 tsnap["pageIns"] = tasksnap["ts_pageins"]
1459 tsnap["pageFaults"] = tasksnap["ts_faults"]
1460 tsnap["userTimeTask"] = GetSecondsFromMATime(tasksnap[ "ts_user_time_in_terminated_thre"], timebase)
1461 tsnap["procname"] = tasksnap["ts_p_comm"]
1462 tsnap["copyOnWriteFaults"] = tasksnap["ts_cow_faults"]
1463 tsnap["timesThrottled"] = tasksnap["ts_was_throttled"]
1464 tsnap["threadById"] = {}
1465 threadByID = tsnap["threadById"]
1466 thlist = piddata.get('thread_snapshots', {})
1467 for tid,thdata in thlist.iteritems():
1468 threadByID[str(tid)] = {}
1469 thsnap = threadByID[str(tid)]
1470 if "thread_snapshot" not in thdata:
1471 print "Found broken thread state for thread ID: %s." % tid
1472 break
1473 threadsnap = thdata["thread_snapshot"]
1474 thsnap["userTime"] = GetSecondsFromMATime(threadsnap["ths_user_time"], timebase)
1475 thsnap["id"] = threadsnap["ths_thread_id"]
1476 thsnap["basePriority"] = threadsnap["ths_base_priority"]
1477 thsnap["systemTime"] = threadsnap["ths_sys_time"]
1478 thsnap["schedPriority"] = threadsnap["ths_sched_priority"]
1479 thsnap["state"] = GetStateDescription(threadsnap['ths_state'])
1480 thsnap["qosEffective"] = threadsnap["ths_eqos"]
1481 thsnap["qosRequested"] = threadsnap["ths_rqos"]
1482
1483 if threadsnap['ths_continuation']:
1484 thsnap["continuation"] = GetSymbolInfoForFrame(AllImageCatalog, pr_libs, threadsnap['ths_continuation'])
1485 if "kernel_stack_frames" in thdata:
1486 kuserframes = []
1487 for f in thdata["kernel_stack_frames"]:
1488 kuserframes.append(GetSymbolInfoForFrame(AllImageCatalog, pr_libs, f['lr']))
1489 thsnap["kernelFrames"] = kuserframes
1490
1491 if "user_stack_frames" in thdata:
1492 uframes = []
1493 for f in thdata["user_stack_frames"]:
1494 uframes.append(GetSymbolInfoForFrame(AllImageCatalog, pr_libs, f['lr']))
1495 thsnap["userFrames"] = uframes
1496 if threadsnap['ths_wait_event']:
1497 thsnap["waitEvent"] = GetSymbolInfoForFrame(AllImageCatalog, pr_libs, threadsnap['ths_wait_event'])
1498
1499 if 'thread_waitinfo' in piddata:
1500 tsnap['waitInfo'] = map(formatWaitInfo, piddata['thread_waitinfo'])
1501
1502 obj['binaryImages'] = AllImageCatalog
1503 if outfile_name == '-':
1504 fh = sys.stdout
1505 else:
1506 fh = open(outfile_name, "w")
1507
1508 header = {}
1509 header['bug_type'] = 288
1510 if timestamp is not None:
1511 header['timestamp'] = timestamp
1512 header['os_version'] = os_version
1513 fh.write(json.dumps(header))
1514 fh.write("\n")
1515
1516 fh.write(json.dumps(obj, sort_keys=False, indent=2, separators=(',', ': ')))
1517 fh.close()
1518
1519 ## Base utils for interacting with shell ##
1520 def RunCommand(bash_cmd_string, get_stderr = True):
1521 """
1522 returns: (int,str) : exit_code and output_str
1523 """
1524 print "RUNNING: %s" % bash_cmd_string
1525 cmd_args = shlex.split(bash_cmd_string)
1526 output_str = ""
1527 exit_code = 0
1528 try:
1529 if get_stderr:
1530 output_str = subprocess.check_output(cmd_args, stderr=subprocess.STDOUT)
1531 else:
1532 output_str = subprocess.check_output(cmd_args, stderr=None)
1533 except subprocess.CalledProcessError, e:
1534 exit_code = e.returncode
1535 finally:
1536 return (exit_code, output_str)
1537
1538 def ProcessDyldSharedCacheFile(shared_cache_file_path, sdk_str=""):
1539 """ returns (uuid, text_info) output from shared_cache_util.
1540 In case of error None is returned and err message is printed to stdout.
1541 """
1542 if not os.path.exists(shared_cache_file_path):
1543 print "File path: %s does not exists" % shared_cache_file_path
1544 return None
1545 if sdk_str:
1546 sdk_str = ' -sdk "%s" ' % sdk_str
1547 (c, so) = RunCommand("xcrun {} -find dyld_shared_cache_util".format(sdk_str))
1548 if c:
1549 print "Failed to find path to dyld_shared_cache_util. Exit code: %d , message: %s" % (c,so)
1550 return None
1551 dyld_shared_cache_util = so.strip()
1552 (c, so) = RunCommand("{} -info {}".format(dyld_shared_cache_util, shared_cache_file_path))
1553 if c:
1554 print "Failed to get uuid info from %s" % shared_cache_file_path
1555 print so
1556 return None
1557
1558 uuid = so.splitlines()[0].split(": ")[-1].strip().replace("-","").lower()
1559
1560 (c, so) = RunCommand("{} -text_info {}".format(dyld_shared_cache_util, shared_cache_file_path))
1561 if c:
1562 print "Failed to get text_info from %s" % shared_cache_file_path
1563 print so
1564 return None
1565
1566 print "Found %s uuid: %s" % (shared_cache_file_path, uuid)
1567 text_info = so
1568
1569 return (uuid, so)
1570
1571 parser = argparse.ArgumentParser(description="Decode a kcdata binary file.")
1572 parser.add_argument("-l", "--listtypes", action="store_true", required=False, default=False,
1573 help="List all known types",
1574 dest="list_known_types")
1575
1576 parser.add_argument("-s", "--stackshot", required=False, default=False,
1577 help="Generate a stackshot report file",
1578 dest="stackshot_file")
1579
1580 parser.add_argument("--multiple", help="look for multiple stackshots in a single file", action='store_true')
1581
1582 parser.add_argument("-p", "--plist", required=False, default=False,
1583 help="output as plist", action="store_true")
1584
1585 parser.add_argument("-U", "--uuid", required=False, default="", help="UUID of dyld shared cache to be analysed and filled in libs of stackshot report", dest="uuid")
1586 parser.add_argument("-L", "--layout", required=False, type=argparse.FileType("r"), help="Path to layout file for DyldSharedCache. You can generate one by doing \n\tbash$xcrun -sdk <sdk> dyld_shared_cache_util -text_info </path/to/dyld_shared_cache> ", dest="layout")
1587 parser.add_argument("-S", "--sdk", required=False, default="", help="sdk property passed to xcrun command to find the required tools. Default is empty string.", dest="sdk")
1588 parser.add_argument("-D", "--dyld_shared_cache", required=False, default="", help="Path to dyld_shared_cache built by B&I", dest="dsc")
1589 parser.add_argument("--pretty", default=False, action='store_true', help="make the output a little more human readable")
1590 parser.add_argument("--incomplete", action='store_true', help="accept incomplete data")
1591 parser.add_argument("kcdata_file", type=argparse.FileType('r'), help="Path to a kcdata binary file.")
1592
1593 class VerboseAction(argparse.Action):
1594 def __call__(self, parser, namespace, values, option_string=None):
1595 logging.basicConfig(level=logging.INFO, stream=sys.stderr, format='%(message)s')
1596 parser.add_argument('-v', "--verbose", action=VerboseAction, nargs=0)
1597
1598 @contextlib.contextmanager
1599 def data_from_stream(stream):
1600 try:
1601 fmap = mmap.mmap(stream.fileno(), 0, mmap.MAP_SHARED, mmap.PROT_READ)
1602 except:
1603 yield stream.read()
1604 else:
1605 try:
1606 yield fmap
1607 finally:
1608 fmap.close()
1609
1610 def iterate_kcdatas(kcdata_file):
1611 with data_from_stream(kcdata_file) as data:
1612 iterator = kcdata_item_iterator(data)
1613 kcdata_buffer = KCObject.FromKCItem(iterator.next())
1614 if not isinstance(kcdata_buffer, KCBufferObject):
1615 try:
1616 decoded = base64.b64decode(data)
1617 except:
1618 pass
1619 else:
1620 iterator = kcdata_item_iterator(decoded)
1621 kcdata_buffer = KCObject.FromKCItem(iterator.next())
1622 if not isinstance(kcdata_buffer, KCBufferObject):
1623 import gzip
1624 from io import BytesIO
1625 try:
1626 decompressed = gzip.GzipFile(fileobj=BytesIO(data[:])).read()
1627 except:
1628 pass
1629 else:
1630 iterator = kcdata_item_iterator(decompressed)
1631 kcdata_buffer = KCObject.FromKCItem(iterator.next())
1632 if not isinstance(kcdata_buffer, KCBufferObject):
1633 raise Exception, "unknown file type"
1634
1635 kcdata_buffer.ReadItems(iterator)
1636 yield kcdata_buffer
1637
1638 for magic in iterator:
1639 kcdata_buffer = KCObject.FromKCItem(magic)
1640 if not isinstance(kcdata_buffer, KCBufferObject):
1641 raise Exception, "unknown file type"
1642 kcdata_buffer.ReadItems(iterator)
1643 yield kcdata_buffer
1644
1645
1646 def prettify(data):
1647 if isinstance(data, list):
1648 return map(prettify, data);
1649
1650 elif isinstance(data, dict):
1651 newdata = dict()
1652 for key, value in data.items():
1653 if 'uuid' in key.lower() and isinstance(value, list) and len(value) == 16:
1654 value = '%02X%02X%02X%02X-%02X%02X-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X' % tuple(value)
1655 elif 'address' in key.lower() and isinstance(value, (int, long)):
1656 value = '0x%X' % value
1657 elif key == 'thread_waitinfo':
1658 value = map(formatWaitInfo, value)
1659 else:
1660 value = prettify(value);
1661 newdata[key] = value
1662
1663 return newdata
1664
1665 else:
1666 return data
1667
1668
1669 if __name__ == '__main__':
1670 args = parser.parse_args()
1671
1672 if args.multiple and args.stackshot_file:
1673 raise NotImplementedError
1674
1675 if args.list_known_types:
1676 for (n, t) in KNOWN_TYPES_COLLECTION.items():
1677 print "%d : %s " % (n, str(t))
1678 sys.exit(1)
1679
1680 if args.incomplete or args.stackshot_file:
1681 G.accept_incomplete_data = True
1682
1683 for i,kcdata_buffer in enumerate(iterate_kcdatas(args.kcdata_file)):
1684 if i > 0 and not args.multiple:
1685 break
1686
1687 str_data = "{" + kcdata_buffer.GetJsonRepr() + "}"
1688 str_data = str_data.replace("\t", " ")
1689
1690 try:
1691 json_obj = json.loads(str_data)
1692 except:
1693 print >>sys.stderr, "JSON reparsing failed! Printing string data!\n"
1694 import textwrap
1695 print textwrap.fill(str_data, 100)
1696 raise
1697
1698 if args.pretty:
1699 json_obj = prettify(json_obj)
1700
1701 dsc_uuid = None
1702 dsc_libs_arr = []
1703 libs_re = re.compile("^\s*(0x[a-fA-F0-9]+)\s->\s(0x[a-fA-F0-9]+)\s+<([a-fA-F0-9\-]+)>\s+.*$", re.MULTILINE)
1704 if args.uuid and args.layout:
1705 dsc_uuid = args.uuid.strip().replace("-",'').lower()
1706 dsc_libs_arr = libs_re.findall(args.layout.read())
1707
1708 if args.dsc:
1709 _ret = ProcessDyldSharedCacheFile(args.dsc, args.sdk)
1710 if _ret:
1711 dsc_uuid = _ret[0]
1712 dsc_libs_arr = libs_re.findall(_ret[1])
1713
1714 if args.stackshot_file:
1715 SaveStackshotReport(json_obj, args.stackshot_file, dsc_uuid, dsc_libs_arr, G.data_was_incomplete)
1716 elif args.plist:
1717 import Foundation
1718 plist = Foundation.NSPropertyListSerialization.dataWithPropertyList_format_options_error_(
1719 json_obj, Foundation.NSPropertyListXMLFormat_v1_0, 0, None)[0].bytes().tobytes()
1720 #sigh. on some pythons long integers are getting output with L's in the plist.
1721 plist = re.sub(r'^(\s*<integer>\d+)L(</integer>\s*)$', r"\1\2", plist, flags=re.MULTILINE)
1722 print plist,
1723 else:
1724 print json.dumps(json_obj, sort_keys=True, indent=4, separators=(',', ': '))
mirror of XNU