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