""" Please make sure you read the README file COMPLETELY BEFORE reading anything below. It is very critical that you read coding guidelines in Section E in README file. """ from xnu import * import sys, shlex from utils import * from process import * from atm import * from bank import * import xnudefines @header("{0: <20s} {1: <6s} {2: <6s} {3: <10s} {4: <15s}".format("task", "pid", '#acts', "tablesize", "command")) def GetTaskIPCSummary(task): """ Display a task's ipc summary. params: task : core.value represeting a Task in kernel returns str - string of ipc info for the task """ out_string = '' format_string = "{0: <#020x} {1: <6d} {2: <6d} {3: <10d} {4: <15s}" pval = Cast(task.bsd_info, 'proc *') table_size = int(task.itk_space.is_table_size) proc_name = str(pval.p_comm) out_string += format_string.format(task, pval.p_pid, task.thread_count, table_size, proc_name) return out_string @header("{0: <20s} {1: <28s} {2: <12s} {3: <6s} {4: <4s} {5: <20s} {6: <4s}\n".format( "port", "mqueue", "recvname", "flags", "refs", "recvname", "dest")) def GetPortSummary(port, show_kmsg_summary=True, prefix=""): """ Display a port's summary params: port : core.value representing a port in the kernel returns str : string of ipc info for the given port """ out_string = "" portp = Cast(port, 'struct ipc_port *') destspacep = kern.GetValueFromAddress(0, 'struct ipc_space *') spacep = portp.data.receiver format_string = "{0: #019x} {1: #019x} {2: <8s} {3: #011x} {4: <5s} {5: #05x} {6: #019x} {7: <16s}\n" if portp.ip_object.io_bits & 0x80000000: out_string += prefix + format_string.format( unsigned(portp), addressof(portp.ip_messages), ' '*8, unsigned(portp.ip_messages.data.port.receiver_name), "APort", portp.ip_object.io_references, unsigned(portp.ip_messages.data.port.receiver_name), GetPortDestProc(portp)) else: out_string += prefix + format_string.format( unsigned(portp), addressof(portp.ip_messages), ' '*8, unsigned(portp.ip_messages.data.port.receiver_name), "DPort", portp.ip_object.io_references, unsigned(portp), "inactive-port") if show_kmsg_summary: kmsgp = Cast(portp.ip_messages.data.port.messages.ikmq_base, 'ipc_kmsg_t') out_string += prefix + GetKMsgSummary.header + prefix + GetKMsgSummary(kmsgp) kmsgheadp = kmsgp kmsgp = kmsgp.ikm_next while (kmsgp) != (kmsgheadp): out_string += prefix + GetKMsgSummary(kmsgp) kmsgp = kmsgp.ikm_next return out_string def GetPortDestProc(portp): """ Display the name and pid of a given port's receiver params: portp : core.value representing a pointer to a port in the kernel destspacep : core.value representing a pointer to an ipc_space returns: str : string containing receiver's name and pid """ spacep = portp.data.receiver out_str = "Not found" for tsk in kern.tasks: if tsk.itk_space == spacep: if tsk.bsd_info: destprocp = Cast(tsk.bsd_info, 'struct proc *') out_str = "{0:s}({1: """ if not cmd_args: print "No arguments passed" print ShowIPC.__doc__ return False ipc = kern.GetValueFromAddress(cmd_args[0], 'ipc_space *') if not ipc: print "unknown arguments:", str(cmd_args) return False print GetIPCInformation.header print GetIPCInformation(ipc, False, False) # EndMacro: showipc # Macro: showtaskipc @lldb_command('showtaskipc') def ShowTaskIPC(cmd_args=None): """ Routine to print IPC summary of given task Usage: showtaskipc
""" if not cmd_args: print "No arguments passed" print ShowTaskIPC.__doc__ return False tval = kern.GetValueFromAddress(cmd_args[0], 'task *') if not tval: print "unknown arguments:", str(cmd_args) return False print GetTaskSummary.header + " " + GetProcSummary.header pval = Cast(tval.bsd_info, 'proc *') print GetTaskSummary(tval) + " " + GetProcSummary(pval) print GetTaskIPCSummary.header print GetTaskIPCSummary(tval) # EndMacro: showtaskipc # Macro: showallipc @lldb_command('showallipc') def ShowAllIPC(cmd_args=None): """ Routine to print IPC summary of all tasks Usage: showallipc """ for t in kern.tasks: print GetTaskSummary.header + " " + GetProcSummary.header pval = Cast(t.bsd_info, 'proc *') print GetTaskSummary(t) + " " + GetProcSummary(pval) print GetIPCInformation.header print GetIPCInformation(t.itk_space, False, False) + "\n\n" # EndMacro: showallipc @lldb_command('showipcsummary') def ShowIPCSummary(cmd_args=None): """ Summarizes the IPC state of all tasks. This is a convenient way to dump some basic clues about IPC messaging. You can use the output to determine tasks that are candidates for further investigation. """ print GetTaskIPCSummary.header for t in kern.tasks: print GetTaskIPCSummary(t) return def GetKObjectFromPort(portval): """ Get Kobject description from the port. params: portval - core.value representation of 'ipc_port *' object returns: str - string of kobject information """ kobject_str = "{0: <#020x}".format(portval.kdata.kobject) io_bits = unsigned(portval.ip_object.io_bits) objtype_index = io_bits & 0xfff if objtype_index < len(xnudefines.kobject_types) : desc_str = "kobject({0:s})".format(xnudefines.kobject_types[objtype_index]) if xnudefines.kobject_types[objtype_index] in ('TASK_RESUME', 'TASK'): desc_str += " " + GetProcNameForTask(Cast(portval.kdata.kobject, 'task *')) else: desc_str = "kobject(UNKNOWN) {:d}".format(objtype_index) return kobject_str + " " + desc_str @static_var('destcache', {}) def GetDestinationProcessFromPort(port): """ params: port - core.value representation of 'ipc_port *' object returns: str - name of process """ out_str = '' dest_space = port.data.receiver found_dest = False #update destcache if data is not found if hex(dest_space) not in GetDestinationProcessFromPort.destcache: for t in kern.tasks: if hex(t.itk_space) == hex(dest_space): pval = Cast(t.bsd_info, 'proc *') GetDestinationProcessFromPort.destcache[hex(dest_space)] = (t, pval) found_dest = True break #end of for loop else: found_dest = True if found_dest: (ftask , fproc) = GetDestinationProcessFromPort.destcache[hex(dest_space)] if fproc: out_str = "{0:s}({1:d})".format(fproc.p_comm, fproc.p_pid ) else: out_str = "task {0: <#020x}".format(ftask) return out_str @header("{0: <20s} {1: <20s}".format("destname", "destination") ) def GetPortDestinationSummary(port): """ Get destination information for a port. params: port - core.value representation of 'ipc_port *' object returns: str - string of info about ports destination """ out_str = '' format_string = "{0: <20s} {1: <20s}" destname_str = '' destination_str = '' ipc_space_kernel = unsigned(kern.globals.ipc_space_kernel) target_spaceval = port.data.receiver if unsigned(target_spaceval) == ipc_space_kernel : destname_str = GetKObjectFromPort(port) else: if int(port.ip_object.io_bits) & 0x80000000 : destname_str = "{0: <#020x}".format(port.ip_messages.data.port.receiver_name) destination_str = GetDestinationProcessFromPort(port) else: destname_str = "{0: <#020x}".format(port) destination_str = "inactive-port" out_str += format_string.format(destname_str, destination_str) return out_str @lldb_type_summary(['ipc_entry_t']) @header("{0: <20s} {1: <20s} {2: <8s} {3: <8s} {4: <20s} {5: <20s}".format("object", "name","rite", "urefs", "destname", "destination")) def GetIPCEntrySummary(entry, ipc_name=''): """ Get summary of a ipc entry. params: entry - core.value representing ipc_entry_t in the kernel ipc_name - str of format '0x0123' for display in summary. returns: str - string of ipc entry related information """ out_str = '' entry_ptr = int(hex(entry), 16) format_string = "{0: <#020x} {1: <12s} {2: <8s} {3: <8d} {4: <20s} {5: <20s}" right_str = '' destname_str = '' destination_str = '' ie_object = entry.ie_object ie_bits = int(entry.ie_bits) urefs = int(ie_bits & 0xffff) if ie_bits & 0x00100000 : right_str = 'Dead' elif ie_bits & 0x00080000: right_str = 'Set' else: if ie_bits & 0x00010000 : if ie_bits & 0x00020000 : right_str = 'SR' else: right_str = 'S' elif ie_bits & 0x00020000: right_str = 'R' elif ie_bits & 0x00040000 : right_str = 'O' portval = Cast(ie_object, 'ipc_port_t') if int(entry.index.request) != 0: requestsval = portval.ip_requests sorightval = requestsval[int(entry.index.request)].notify.port soright_ptr = unsigned(sorightval) if soright_ptr != 0: if soright_ptr & 0x1 : right_str +='s' elif soright_ptr & 0x2 : right_str +='d' else : right_str +='n' if ie_bits & 0x00800000 : right_str +='c' if portval.ip_nsrequest != 0: right_str +='x' # now show the port destination part destname_str = GetPortDestinationSummary(Cast(ie_object, 'ipc_port_t')) out_str = format_string.format(ie_object, ipc_name, right_str, urefs, destname_str, destination_str) return out_str @header("{0: >20s}".format("user bt") ) def GetPortUserStack(port, task): """ Get UserStack information for the given port & task. params: port - core.value representation of 'ipc_port *' object task - value representing 'task *' object returns: str - string information on port's userstack """ out_str = '' ie_port_callstack = port.ip_callstack ie_port_spares = port.ip_spares[0] proc_val = Cast(task.bsd_info, 'proc *') if ie_port_callstack[0]: out_str += "{: <10x}".format(ie_port_callstack[0]) count = 1 while count < 16 and ie_port_callstack[count]: out_str += ": <10x".format(ie_port_callstack[count]) count = count + 1 if ie_port_spares != proc_val.p_pid: out_str += " ({:<10d})".format(ie_port_spares) out_str += '\n' return out_str @lldb_type_summary(['ipc_space *']) @header("{0: <20s} {1: <20s} {2: <20s} {3: <8s} {4: <10s} {5: <16s} {6: <10s} {7: <7s}".format('ipc_space', 'is_task', 'is_table', 'flags', 'ports', 'table_next', 'low_mod', 'high_mod')) def GetIPCInformation(space, show_entries=False, show_userstack=False): """ Provide a summary of the ipc space """ out_str = '' format_string = "{0: <#020x} {1: <#020x} {2: <#020x} {3: <8s} {4: <10d} {5: <#01x} {6: >10d} {7: >10d}" is_tableval = space.is_table ports = int(space.is_table_size) flags ='' is_bits = int(space.is_bits) if (is_bits & 0x40000000) == 0: flags +='A' else: flags += ' ' if (is_bits & 0x20000000) != 0: flags +='G' out_str += format_string.format(space, space.is_task, space.is_table, flags, space.is_table_size, space.is_table_next, space.is_low_mod, space.is_high_mod) #should show the each individual entries if asked. if show_entries == True: out_str += "\n\t" + GetIPCEntrySummary.header + "\n" num_entries = ports index = 0 while index < num_entries: entryval = GetObjectAtIndexFromArray(is_tableval, index) entry_ie_bits = unsigned(entryval.ie_bits) if (int(entry_ie_bits) & 0x001f0000 ) != 0: entry_name = "{0: <#020x}".format( (index <<8 | entry_ie_bits >> 24) ) out_str += "\t" + GetIPCEntrySummary(entryval, entry_name) + "\n" if show_userstack == True: entryport = Cast(entryval.ie_object, 'ipc_port *') if entryval.ie_object and (int(entry_ie_bits) & 0x00070000) and entryport.ip_callstack[0]: out_str += GetPortUserStack.header out_str += GetPortUserStack(entryport, space.is_task) index +=1 #done with showing entries return out_str # Macro: showrights @lldb_command('showrights') def ShowRights(cmd_args=None): """ Routine to print rights information for the given IPC space Usage: showrights
""" if not cmd_args: print "No arguments passed" print ShowRights.__doc__ return False ipc = kern.GetValueFromAddress(cmd_args[0], 'ipc_space *') if not ipc: print "unknown arguments:", str(cmd_args) return False print GetIPCInformation.header print GetIPCInformation(ipc, True, False) # EndMacro: showrights @lldb_command('showtaskrights') def ShowTaskRights(cmd_args=None): """ Routine to ipc rights information for a task Usage: showtaskrights """ if cmd_args == None: print "No arguments passed" print ShowTaskStacksCmdHelper.__doc__ return False tval = kern.GetValueFromAddress(cmd_args[0], 'task *') if not tval: print "unknown arguments:", str(cmd_args) return False print GetTaskSummary.header + " " + GetProcSummary.header pval = Cast(tval.bsd_info, 'proc *') print GetTaskSummary(tval) + " " + GetProcSummary(pval) print GetIPCInformation.header print GetIPCInformation(tval.itk_space, True, False) # Macro: showataskrightsbt @lldb_command('showtaskrightsbt') def ShowTaskRightsBt(cmd_args=None): """ Routine to ipc rights information with userstacks for a task Usage: showtaskrightsbt """ if cmd_args == None: print "No arguments passed" print ShowTaskRightsBt.__doc__ return False tval = kern.GetValueFromAddress(cmd_args[0], 'task *') if not tval: print "unknown arguments:", str(cmd_args) return False print GetTaskSummary.header + " " + GetProcSummary.header pval = Cast(tval.bsd_info, 'proc *') print GetTaskSummary(tval) + " " + GetProcSummary(pval) print GetIPCInformation.header print GetIPCInformation(tval.itk_space, True, True) # EndMacro: showtaskrightsbt # Macro: showallrights @lldb_command('showallrights') def ShowAllRights(cmd_args=None): """ Routine to print rights information for IPC space of all tasks Usage: showallrights """ for t in kern.tasks: print GetTaskSummary.header + " " + GetProcSummary.header pval = Cast(t.bsd_info, 'proc *') print GetTaskSummary(t) + " " + GetProcSummary(pval) try: print GetIPCInformation.header print GetIPCInformation(t.itk_space, True, False) + "\n\n" except (KeyboardInterrupt, SystemExit): raise except: print "Failed to get IPC information. Do individual showtaskrights to find the error. \n\n" # EndMacro: showallrights # Macro: showpipestats @lldb_command('showpipestats') def ShowPipeStats(cmd_args=None): """ Display pipes usage information in the kernel """ print "Number of pipes: {: d}".format(kern.globals.amountpipes) print "Memory used by pipes: {:s}".format(sizeof_fmt(int(kern.globals.amountpipekva))) print "Max memory allowed for pipes: {:s}".format(sizeof_fmt(int(kern.globals.maxpipekva))) # EndMacro: showpipestats # Macro: showtaskbusyports @lldb_command('showtaskbusyports') def ShowTaskBusyPorts(cmd_args=None): """ Routine to print information about receive rights belonging to this task that have enqueued messages. This is oten a sign of a blocked or hung process Usage: showtaskbusyports """ if not cmd_args: print "No arguments passed. Please pass in the address of a task" print ShowTaskBusyPorts.__doc__ return task = kern.GetValueFromAddress(cmd_args[0], 'task_t') print GetTaskBusyPorts(task) return def GetTaskBusyPorts(task): """ Prints all busy ports for a given task. ie. all receive rights belonging to this task that have enqueued messages. params: task : core.value representing a task in kernel returns: str : String containing information about the given task's busy ports """ isp = task.itk_space i = 0 out_string = "" while i < isp.is_table_size: iep = addressof(isp.is_table[i]) if iep.ie_bits & 0x00020000: port = Cast(iep.ie_object, 'ipc_port_t') if port.ip_messages.data.port.msgcount > 0: out_string += GetPortSummary.header + GetPortSummary(port) i = i + 1 return out_string # EndMacro: showtaskbusyports # Macro: showallbusyports @lldb_command('showallbusyports') def ShowAllBusyPorts(cmd_args=None): """ Routine to print information about all receive rights on the system that have enqueued messages. """ task_queue_head = kern.globals.tasks for tsk in kern.tasks: print GetTaskBusyPorts(tsk) return # EndMacro: showallbusyports # Macro: showmqueue: @lldb_command('showmqueue') def ShowMQueue(cmd_args=None): """ Routine that lists details about a given mqueue Syntax: (lldb) showmqueue 0xaddr """ if not cmd_args: print "Please specify the address of the ipc_mqueue whose details you want to print" print ShowMQueue.__doc__ return mqueue = kern.GetValueFromAddress(cmd_args[0], 'struct ipc_mqueue *') wq_type = mqueue.data.pset.set_queue.wqs_wait_queue.wq_type if int(wq_type) == 3: psetoff = getfieldoffset('struct ipc_pset', 'ips_messages') pset = unsigned(ArgumentStringToInt(cmd_args[0])) - unsigned(psetoff) print GetPortSetSummary.header + GetPortSetSummary(kern.GetValueFromAddress(pset, 'struct ipc_pset *')) if int(wq_type) == 2: portoff = getfieldoffset('struct ipc_port', 'ip_messages') port = unsigned(ArgumentStringToInt(cmd_args[0])) - unsigned(portoff) print GetPortSummary.header + GetPortSummary(kern.GetValueFromAddress(port, 'struct ipc_port *')) # EndMacro: showmqueue # Macro: showkmsg: @lldb_command('showkmsg') def ShowKMSG(cmd_args=[]): """ Show detail information about a structure Usage: (lldb) showkmsg """ if not cmd_args: raise ArgumentError('Invalid arguments') kmsg = kern.GetValueFromAddress(cmd_args[0], 'ipc_kmsg_t') print GetKMsgSummary.header print GetKMsgSummary(kmsg) # EndMacro: showkmsg # Macro: showpset @lldb_command('showpset') def ShowPSet(cmd_args=None): """ Routine that prints details for a given ipc_pset * Syntax: (lldb) showpset 0xaddr """ if not cmd_args: print "Please specify the address of the pset whose details you want to print" print ShowPSet.__doc__ return print GetPortSetSummary.header + GetPortSetSummary(kern.GetValueFromAddress(cmd_args[0], 'ipc_pset *')) # EndMacro: showpset # IPC importance inheritance related macros. @lldb_command('showalliits') def ShowAllIITs(cmd_args=[], cmd_options={}): """ Development only macro. Show list of all iits allocated in the system. """ try: iit_queue = kern.globals.global_iit_alloc_queue except ValueError: print "This debug macro is only available in development or debug kernels" return print GetIPCImportantTaskSummary.header for iit in IterateQueue(iit_queue, 'struct ipc_importance_task *', 'iit_allocation'): print GetIPCImportantTaskSummary(iit) return @header("{: <18s} {: <3s} {: <18s} {: <20s} {: <18s} {: <8s}".format("ipc_imp_inherit", "don", "to_task", "proc_name", "from_elem", "depth")) @lldb_type_summary(['ipc_importance_inherit *', 'ipc_importance_inherit_t']) def GetIPCImportanceInheritSummary(iii): """ describes iii object of type ipc_importance_inherit_t * """ out_str = "" fmt = "{o: <#018x} {don: <3s} {o.iii_to_task.iit_task: <#018x} {task_name: <20s} {o.iii_from_elem: <#018x} {o.iii_depth: <#08x}" donating_str = "" if unsigned(iii.iii_donating): donating_str = "DON" taskname = GetProcNameForTask(iii.iii_to_task.iit_task) if hasattr(iii.iii_to_task, 'iit_bsd_pid'): taskname = "({:d}) {:s}".format(iii.iii_to_task.iit_bsd_pid, iii.iii_to_task.iit_procname) out_str += fmt.format(o=iii, task_name = taskname, don=donating_str) return out_str @static_var('recursion_count', 0) @header("{: <18s} {: <4s} {: <8s} {: <8s} {: <18s} {: <18s}".format("iie", "type", "refs", "made", "#kmsgs", "#inherits")) @lldb_type_summary(['ipc_importance_elem *']) def GetIPCImportanceElemSummary(iie): """ describes an ipc_importance_elem * object """ if GetIPCImportanceElemSummary.recursion_count > 500: GetIPCImportanceElemSummary.recursion_count = 0 return "Recursion of 500 reached" out_str = '' fmt = "{: <#018x} {: <4s} {: <8d} {: <8d} {: <#018x} {: <#018x}" type_str = 'TASK' if unsigned(iie.iie_bits) & 0x80000000: type_str = "INH" refs = unsigned(iie.iie_bits) & 0x7fffffff made_refs = unsigned(iie.iie_made) kmsg_count = sum(1 for i in IterateQueue(iie.iie_kmsgs, 'struct ipc_kmsg *', 'ikm_inheritance')) inherit_count = sum(1 for i in IterateQueue(iie.iie_inherits, 'struct ipc_importance_inherit *', 'iii_inheritance')) out_str += fmt.format(iie, type_str, refs, made_refs, kmsg_count, inherit_count) if config['verbosity'] > vHUMAN: if kmsg_count > 0: out_str += "\n\t"+ GetKMsgSummary.header for k in IterateQueue(iie.iie_kmsgs, 'struct ipc_kmsg *', 'ikm_inheritance'): out_str += "\t" + "{: <#018x}".format(k.ikm_header.msgh_remote_port) + ' ' + GetKMsgSummary(k).lstrip() out_str += "\n" if inherit_count > 0: out_str += "\n\t" + GetIPCImportanceInheritSummary.header + "\n" for i in IterateQueue(iie.iie_inherits, 'struct ipc_importance_inherit *', 'iii_inheritance'): out_str += "\t" + GetIPCImportanceInheritSummary(i) + "\n" out_str += "\n" if type_str == "INH": iii = Cast(iie, 'struct ipc_importance_inherit *') out_str += "Inherit from: " + GetIPCImportanceElemSummary(iii.iii_from_elem) return out_str @header("{: <18s} {: <18s} {: <20s}".format("iit", "task", "name")) @lldb_type_summary(['ipc_importance_task *']) def GetIPCImportantTaskSummary(iit): """ iit is a ipc_importance_task value object. """ fmt = "{: <#018x} {: <#018x} {: <20s}" out_str='' pname = GetProcNameForTask(iit.iit_task) if hasattr(iit, 'iit_bsd_pid'): pname = "({:d}) {:s}".format(iit.iit_bsd_pid, iit.iit_procname) out_str += fmt.format(iit, iit.iit_task, pname) return out_str @lldb_command('showallimportancetasks') def ShowIPCImportanceTasks(cmd_args=[], cmd_options={}): """ display a list of all tasks with ipc importance information. Usage: (lldb) showallimportancetasks Tip: add "-v" to see detailed information on each kmsg or inherit elems """ print ' ' + GetIPCImportantTaskSummary.header + ' ' + GetIPCImportanceElemSummary.header for t in kern.tasks: s = "" if unsigned(t.task_imp_base): s += ' ' + GetIPCImportantTaskSummary(t.task_imp_base) s += ' ' + GetIPCImportanceElemSummary(addressof(t.task_imp_base.iit_elem)) print s @lldb_command('showipcimportance', '') def ShowIPCImportance(cmd_args=[], cmd_options={}): """ Describe an importance from argument. Usage: (lldb) showimportance """ if not cmd_args: raise ArgumentError("Please provide valid argument") elem = kern.GetValueFromAddress(cmd_args[0], 'ipc_importance_elem_t') print GetIPCImportanceElemSummary.header print GetIPCImportanceElemSummary(elem) @header("{: <18s} {: <10s} {: <18s} {: <18s} {: <8s} {: <5s} {: <5s} {: <5s}".format("ivac", "refs", "port", "tbl", "tblsize", "index", "Grow", "freelist")) @lldb_type_summary(['ipc_voucher_attr_control *', 'ipc_voucher_attr_control_t']) def GetIPCVoucherAttrControlSummary(ivac): """ describes a voucher attribute control settings """ out_str = "" fmt = "{c: <#018x} {c.ivac_refs: <10d} {c.ivac_port: <#018x} {c.ivac_table: <#018x} {c.ivac_table_size: <8d} {c.ivac_key_index: <5d} {growing: <5s} {c.ivac_freelist: <5d}" growing_str = "" if unsigned(ivac) == 0: return "{: <#018x}".format(ivac) if unsigned(ivac.ivac_is_growing): growing_str = "Y" out_str += fmt.format(c=ivac, growing = growing_str) return out_str @lldb_command('showivac','') def ShowIPCVoucherAttributeControl(cmd_args=[], cmd_options={}): """ Show summary of voucher attribute contols. Usage: (lldb) showivac """ if not cmd_args: raise ArgumentError("Please provide correct arguments.") ivac = kern.GetValueFromAddress(cmd_args[0], 'ipc_voucher_attr_control_t') print GetIPCVoucherAttrControlSummary.header print GetIPCVoucherAttrControlSummary(ivac) if config['verbosity'] > vHUMAN: cur_entry_index = 0 last_entry_index = unsigned(ivac.ivac_table_size) print "index " + GetIPCVoucherAttributeEntrySummary.header while cur_entry_index < last_entry_index: print "{: <5d} ".format(cur_entry_index) + GetIPCVoucherAttributeEntrySummary(addressof(ivac.ivac_table[cur_entry_index])) cur_entry_index += 1 @header("{: <18s} {: <30s} {: <30s} {: <30s} {: <30s} {: <30s}".format("ivam", "get_value_fn", "extract_fn", "release_value_fn", "command_fn", "release_fn")) @lldb_type_summary(['ipc_voucher_attr_manager *', 'ipc_voucher_attr_manager_t']) def GetIPCVoucherAttrManagerSummary(ivam): """ describes a voucher attribute manager settings """ out_str = "" fmt = "{: <#018x} {: <30s} {: <30s} {: <30s} {: <30s} {: <30s}" if unsigned(ivam) == 0 : return "{: <#018x}".format(ivam) get_value_fn = kern.Symbolicate(unsigned(ivam.ivam_get_value)) extract_fn = kern.Symbolicate(unsigned(ivam.ivam_extract_content)) release_value_fn = kern.Symbolicate(unsigned(ivam.ivam_release_value)) command_fn = kern.Symbolicate(unsigned(ivam.ivam_command)) release_fn = kern.Symbolicate(unsigned(ivam.ivam_release)) out_str += fmt.format(ivam, get_value_fn, extract_fn, release_value_fn, command_fn, release_fn) return out_str @header("{: <18s} {: <10s} {:s} {:s}".format("ivgte", "key", GetIPCVoucherAttrControlSummary.header.strip(), GetIPCVoucherAttrManagerSummary.header.strip())) @lldb_type_summary(['ipc_voucher_global_table_element *', 'ipc_voucher_global_table_element_t']) def GetIPCVoucherGlobalTableElementSummary(ivgte): """ describes a ipc_voucher_global_table_element object """ out_str = "" fmt = "{g: <#018x} {g.ivgte_key: <10d} {ctrl_s:s} {mgr_s:s}" out_str += fmt.format(g=ivgte, ctrl_s=GetIPCVoucherAttrControlSummary(ivgte.ivgte_control), mgr_s=GetIPCVoucherAttrManagerSummary(ivgte.ivgte_manager)) return out_str @lldb_command('showglobalvouchertable', '') def ShowGlobalVoucherTable(cmd_args=[], cmd_options={}): """ show detailed information of all voucher attribute managers registered with vouchers system Usage: (lldb) showglobalvouchertable """ entry_size = sizeof(kern.globals.iv_global_table[0]) elems = sizeof(kern.globals.iv_global_table) / entry_size print GetIPCVoucherGlobalTableElementSummary.header for i in range(elems): elt = addressof(kern.globals.iv_global_table[i]) print GetIPCVoucherGlobalTableElementSummary(elt) # Type summaries for Bag of Bits. @lldb_type_summary(['user_data_value_element', 'user_data_element_t']) @header("{0: <20s} {1: <16s} {2: <20s} {3: <20s} {4: <16s} {5: <20s}".format("user_data_ve", "maderefs", "checksum", "hash value", "size", "data")) def GetBagofBitsElementSummary(data_element): """ Summarizes the Bag of Bits element params: data_element = value of the object of type user_data_value_element_t returns: String with summary of the type. """ format_str = "{0: <#020x} {1: <16d} {2: <#020x} {3: <#020x} {4: <16d}" out_string = format_str.format(data_element, unsigned(data_element.e_made), data_element.e_sum, data_element.e_hash, unsigned(data_element.e_size)) out_string += " 0x" for i in range(0, (unsigned(data_element.e_size) - 1)): out_string += "{:02x}".format(int(data_element.e_data[i])) return out_string def GetIPCHandleSummary(handle_ptr): """ converts a handle value inside a voucher attribute table to ipc element and returns appropriate summary. params: handle_ptr - uint64 number stored in handle of voucher. returns: str - string summary of the element held in internal structure """ elem = kern.GetValueFromAddress(handle_ptr, 'ipc_importance_elem_t') if elem.iie_bits & 0x80000000 : iie = Cast(elem, 'struct ipc_importance_inherit *') return GetIPCImportanceInheritSummary(iie) else: iit = Cast(elem, 'struct ipc_importance_task *') return GetIPCImportantTaskSummary(iit) def GetATMHandleSummary(handle_ptr): """ Convert a handle value to atm value and returns corresponding summary of its fields. params: handle_ptr - uint64 number stored in handle of voucher returns: str - summary of atm value """ elem = kern.GetValueFromAddress(handle_ptr, 'atm_value *') return GetATMValueSummary(elem) def GetBankHandleSummary(handle_ptr): """ converts a handle value inside a voucher attribute table to bank element and returns appropriate summary. params: handle_ptr - uint64 number stored in handle of voucher. returns: str - summary of bank element """ elem = kern.GetValueFromAddress(handle_ptr, 'bank_element_t') if elem.be_type & 1 : ba = Cast(elem, 'struct bank_account *') return GetBankAccountSummary(ba) else: bt = Cast(elem, 'struct bank_task *') return GetBankTaskSummary(bt) def GetBagofBitsHandleSummary(handle_ptr): """ Convert a handle value to bag of bits value and returns corresponding summary of its fields. params: handle_ptr - uint64 number stored in handle of voucher returns: str - summary of bag of bits element """ elem = kern.GetValueFromAddress(handle_ptr, 'user_data_element_t') return GetBagofBitsElementSummary(elem) @static_var('attr_managers',{1: GetATMHandleSummary, 2: GetIPCHandleSummary, 3: GetBankHandleSummary, 7: GetBagofBitsHandleSummary}) def GetHandleSummaryForKey(handle_ptr, key_num): """ Get a summary of handle pointer from the voucher attribute manager. For example key 1 -> ATM and it puts atm_value_t in the handle. So summary of it would be atm value and refs etc. key 2 -> ipc and it puts either ipc_importance_inherit_t or ipc_important_task_t. key 3 -> Bank and it puts either bank_task_t or bank_account_t. key 7 -> Bag of Bits and it puts user_data_element_t in handle. So summary of it would be Bag of Bits content and refs etc. """ key_num = int(key_num) if key_num not in GetHandleSummaryForKey.attr_managers: return "Unknown key %d" % key_num return GetHandleSummaryForKey.attr_managers[key_num](handle_ptr) @header("{: <18s} {: <18s} {: <10s} {: <4s} {: <18s} {: <18s}".format("ivace", "value_handle", "#refs", "rel?", "maderefs", "next_layer")) @lldb_type_summary(['ivac_entry *', 'ivac_entry_t']) def GetIPCVoucherAttributeEntrySummary(ivace, manager_key_num = 0): """ Get summary for voucher attribute entry. """ out_str = "" fmt = "{e: <#018x} {e.ivace_value: <#018x} {e.ivace_refs: <10d} {release: <4s} {made_refs: <18s} {next_layer: <18s}" release_str = "" free_str = "" made_refs = "" next_layer = "" if unsigned(ivace.ivace_releasing): release_str = "Y" if unsigned(ivace.ivace_free): free_str = 'F' if unsigned(ivace.ivace_layered): next_layer = "{: <#018x}".format(ivace.ivace_u.ivaceu_layer) else: made_refs = "{: <18d}".format(ivace.ivace_u.ivaceu_made) out_str += fmt.format(e=ivace, release=release_str, made_refs=made_refs, next_layer=next_layer) if config['verbosity'] > vHUMAN and manager_key_num > 0: out_str += " " + GetHandleSummaryForKey(unsigned(ivace.ivace_value), manager_key_num) if config['verbosity'] > vHUMAN : out_str += ' {: <2s} {: <4d} {: <4d}'.format(free_str, ivace.ivace_next, ivace.ivace_index) return out_str @lldb_command('showivacfreelist','') def ShowIVACFreeList(cmd_args=[], cmd_options={}): """ Walk the free list and print every entry in the list. usage: (lldb) showivacfreelist """ if not cmd_args: raise ArgumentError('Please provide ') ivac = kern.GetValueFromAddress(cmd_args[0], 'ipc_voucher_attr_control_t') print GetIPCVoucherAttrControlSummary.header print GetIPCVoucherAttrControlSummary(ivac) if unsigned(ivac.ivac_freelist) == 0: print "ivac table is full" return print "index " + GetIPCVoucherAttributeEntrySummary.header next_free = unsigned(ivac.ivac_freelist) while next_free != 0: print "{: <5d} ".format(next_free) + GetIPCVoucherAttributeEntrySummary(addressof(ivac.ivac_table[next_free])) next_free = unsigned(ivac.ivac_table[next_free].ivace_next) @header('{: <18s} {: <8s} {: <18s} {: <18s} {: <18s} {: <18s} {: <18s}'.format("ipc_voucher", "refs", "checksum", "hash", "tbl_size", "table", "voucher_port")) @lldb_type_summary(['ipc_voucher *', 'ipc_voucher_t']) def GetIPCVoucherSummary(voucher, show_entries=False): """ describe a voucher from its ipc_voucher * object """ out_str = "" fmt = "{v: <#018x} {v.iv_refs: <8d} {v.iv_sum: <#018x} {v.iv_hash: <#018x} {v.iv_table_size: <#018x} {v.iv_table: <#018x} {v.iv_port: <#018x}" out_str += fmt.format(v = voucher) entries_str = '' if show_entries or config['verbosity'] > vHUMAN: elems = unsigned(voucher.iv_table_size) entries_header_str = "\n\t" + "{: <5s} {: <3s} {: <16s} {: <30s}".format("index", "key", "value_index", "manager") + " " + GetIPCVoucherAttributeEntrySummary.header fmt = "{: <5d} {: <3d} {: <16d} {: <30s}" for i in range(elems): voucher_entry_index = unsigned(voucher.iv_inline_table[i]) if voucher_entry_index: s = fmt.format(i, GetVoucherManagerKeyForIndex(i), voucher_entry_index, GetVoucherAttributeManagerNameForIndex(i)) e = GetVoucherValueHandleFromVoucherForIndex(voucher, i) if e is not None: s += " " + GetIPCVoucherAttributeEntrySummary(addressof(e), GetVoucherManagerKeyForIndex(i) ) if entries_header_str : entries_str = entries_header_str entries_header_str = '' entries_str += "\n\t" + s if not entries_header_str: entries_str += "\n\t" out_str += entries_str return out_str def GetVoucherManagerKeyForIndex(idx): """ Returns key number for index based on global table. Will raise index error if value is incorrect """ return unsigned(kern.globals.iv_global_table[idx].ivgte_key) def GetVoucherAttributeManagerForKey(k): """ Walks through the iv_global_table and finds the attribute manager name params: k - int key number of the manager return: cvalue - the attribute manager object. None - if not found """ retval = None entry_size = sizeof(kern.globals.iv_global_table[0]) elems = sizeof(kern.globals.iv_global_table) / entry_size for i in range(elems): elt = addressof(kern.globals.iv_global_table[i]) if k == unsigned(elt.ivgte_key): retval = elt.ivgte_manager break return retval def GetVoucherAttributeControllerForKey(k): """ Walks through the iv_global_table and finds the attribute controller params: k - int key number of the manager return: cvalue - the attribute controller object. None - if not found """ retval = None entry_size = sizeof(kern.globals.iv_global_table[0]) elems = sizeof(kern.globals.iv_global_table) / entry_size for i in range(elems): elt = addressof(kern.globals.iv_global_table[i]) if k == unsigned(elt.ivgte_key): retval = elt.ivgte_control break return retval def GetVoucherAttributeManagerName(ivam): """ find the name of the ivam object param: ivam - cvalue object of type ipc_voucher_attr_manager_t returns: str - name of the manager """ return kern.Symbolicate(unsigned(ivam)) def GetVoucherAttributeManagerNameForIndex(idx): """ get voucher attribute manager name for index return: str - name of the attribute manager object """ return GetVoucherAttributeManagerName(GetVoucherAttributeManagerForKey(GetVoucherManagerKeyForIndex(idx))) def GetVoucherValueHandleFromVoucherForIndex(voucher, idx): """ traverse the voucher attrs and get value_handle in the voucher attr controls table params: voucher - cvalue object of type ipc_voucher_t idx - int index in the entries for which you wish to get actual handle for returns: cvalue object of type ivac_entry_t None if no handle found. """ manager_key = GetVoucherManagerKeyForIndex(idx) voucher_num_elems = unsigned(voucher.iv_table_size) if idx >= voucher_num_elems: debuglog("idx %d is out of range max: %d" % (idx, voucher_num_elems)) return None voucher_entry_value = unsigned(voucher.iv_inline_table[idx]) debuglog("manager_key %d" % manager_key) ivac = GetVoucherAttributeControllerForKey(manager_key) if ivac is None or unsigned(ivac) == 0: debuglog("No voucher attribute controller for idx %d" % idx) return None ivac = kern.GetValueFromAddress(unsigned(ivac), 'ipc_voucher_attr_control_t') # ??? No idea why lldb does not addressof directly ivace_table = ivac.ivac_table if voucher_entry_value >= unsigned(ivac.ivac_table_size): print "Failed to get ivace for value %d in table of size %d" % (voucher_entry_value, unsigned(ivac.ivac_table_size)) return None return ivace_table[voucher_entry_value] @lldb_command('showallvouchers') def ShowAllVouchers(cmd_args=[], cmd_options={}): """ Display a list of all vouchers in the global voucher hash table Usage: (lldb) showallvouchers """ iv_hash_table = kern.globals.ivht_bucket num_buckets = sizeof(kern.globals.ivht_bucket) / sizeof(kern.globals.ivht_bucket[0]) print GetIPCVoucherSummary.header for i in range(num_buckets): for v in IterateQueue(iv_hash_table[i], 'ipc_voucher_t', 'iv_hash_link'): print GetIPCVoucherSummary(v) @lldb_command('showvoucher', '') def ShowVoucher(cmd_args=[], cmd_options={}): """ Describe a voucher from argument. Usage: (lldb) showvoucher """ if not cmd_args: raise ArgumentError("Please provide valid argument") voucher = kern.GetValueFromAddress(cmd_args[0], 'ipc_voucher_t') print GetIPCVoucherSummary.header print GetIPCVoucherSummary(voucher, show_entries=True)