]> git.saurik.com Git - apple/xnu.git/blobdiff - tools/lldbmacros/kevent.py
xnu-4570.1.46.tar.gz
[apple/xnu.git] / tools / lldbmacros / kevent.py
diff --git a/tools/lldbmacros/kevent.py b/tools/lldbmacros/kevent.py
new file mode 100755 (executable)
index 0000000..8f9f7c9
--- /dev/null
@@ -0,0 +1,381 @@
+from xnu import *
+
+def IterateProcKqueues(proc):
+    """ Iterate through all kqueues in the given process
+
+        params:
+            proc - the proc object
+        returns: nothing, this is meant to be used as a generator function
+            kq - yields each kqueue in the process
+    """
+    for kqf in IterateProcKqfiles(proc):
+        yield kern.GetValueFromAddress(int(kqf), 'struct kqueue *')
+    if int(proc.p_fd.fd_wqkqueue) != 0:
+        yield kern.GetValueFromAddress(int(proc.p_fd.fd_wqkqueue), 'struct kqueue *')
+    for kqwl in IterateProcKqworkloops(proc):
+        yield kern.GetValueFromAddress(int(kqwl), 'struct kqueue *')
+
+def IterateProcKqfiles(proc):
+    """ Iterate through all kqfiles in the given process
+
+        params:
+            proc - the proc object
+        returns: nothing, this is meant to be used as a generator function
+            kqf - yields each kqfile in the process
+    """
+    filetype_KQUEUE = 5
+
+    proc_filedesc = proc.p_fd
+    proc_lastfile = unsigned(proc_filedesc.fd_lastfile)
+    proc_ofiles = proc_filedesc.fd_ofiles
+    queues = list()
+    count = 0
+
+    if unsigned(proc_ofiles) == 0:
+        return
+
+    while count <= proc_lastfile:
+        if unsigned(proc_ofiles[count]) != 0:
+            proc_fd_flags = proc_ofiles[count].f_flags
+            proc_fd_fglob = proc_ofiles[count].f_fglob
+            proc_fd_ftype = unsigned(proc_fd_fglob.fg_ops.fo_type)
+            if proc_fd_ftype == xnudefines.DTYPE_KQUEUE:
+                yield kern.GetValueFromAddress(int(proc_fd_fglob.fg_data), 'struct kqfile *')
+        count += 1
+
+def IterateProcKqworkloops(proc):
+    """ Iterate through all kqworkloops in the given process
+
+        params:
+            proc - the proc object
+        returns: nothing, this is meant to be used as a generator function
+            kqwl - yields each kqworkloop in the process
+    """
+    proc_filedesc = proc.p_fd
+    if int(proc_filedesc.fd_kqhash) == 0:
+        return
+
+    hash_mask = proc_filedesc.fd_kqhashmask
+    for i in xrange(hash_mask + 1):
+        for kqwl in IterateListEntry(proc_filedesc.fd_kqhash[i], 'struct kqworkloop *', 'kqwl_hashlink', list_prefix='s'):
+            yield kqwl
+
+def IterateAllKqueues():
+    """ Iterate through all kqueues in the system
+
+        returns: nothing, this is meant to be used as a generator function
+            kq - yields each kqueue in the system
+    """
+    for t in kern.tasks:
+        if unsigned(t.bsd_info) == 0:
+            continue
+        proc = kern.GetValueFromAddress(t.bsd_info, 'proc_t')
+        for kq in IterateProcKqueues(proc):
+            yield kq
+
+def IterateProcKnotes(proc):
+    """ Iterate through all knotes in the given process
+
+        params:
+            proc - the proc object
+        returns: nothing, this is meant to be used as a generator function
+            kn - yields each knote in the process
+    """
+    proc_filedesc = proc.p_fd
+
+    if int(proc.p_fd.fd_knlist) != 0:
+        for i in xrange(proc.p_fd.fd_knlistsize):
+            for kn in IterateListEntry(proc.p_fd.fd_knlist[i], 'struct knote *', 'kn_link', list_prefix='s'):
+                yield kn
+    if int(proc.p_fd.fd_knhash) != 0:
+        for i in xrange(proc.p_fd.fd_knhashmask + 1):
+            for kn in IterateListEntry(proc.p_fd.fd_knhash[i], 'struct knote *', 'kn_link', list_prefix='s'):
+                yield kn
+
+def GetKnoteKqueue(kn):
+    """ Get the kqueue corresponding to a given knote
+
+        params:
+            kn - the knote object
+        returns: kq - the kqueue corresponding to the knote
+    """
+    return kern.GetValueFromAddress(kn.kn_kq_packed + kern.VM_MIN_KERNEL_AND_KEXT_ADDRESS, 'struct kqueue *')
+
+@lldb_type_summary(['knote *'])
+@header('{:<20s} {:<20s} {:<10s} {:<20s} {:<20s} {:<30s} {:<10} {:<10} {:<10} {:<30s}'.format('knote', 'ident', 'kev_flags', 'kqueue', 'udata', 'filtops', 'qos_use', 'qos_req', 'qos_ovr', 'status'))
+def GetKnoteSummary(kn):
+    """ Summarizes a knote and related information
+
+        returns: str - summary of knote
+    """
+    format_string = '{o: <#020x} {o.kn_kevent.ident: <#020x} {o.kn_kevent.flags: <#010x} {kq_ptr: <#020x} {o.kn_kevent.udata: <#020x} {ops_str: <30s} {qos_use: <10s} {qos_req: <10s} {qos_ovr: <10s} {st_str: <30s}'
+    state = unsigned(kn.kn_status)
+    fops_str = kern.Symbolicate(kern.globals.sysfilt_ops[unsigned(kn.kn_filtid)])
+    return format_string.format(
+            o=kn,
+            qos_use=xnudefines.thread_qos_short_strings[int(kn.kn_qos_index)],
+            qos_req=xnudefines.thread_qos_short_strings[int(kn.kn_req_index)],
+            qos_ovr=xnudefines.thread_qos_short_strings[int(kn.kn_qos_override)],
+            st_str=xnudefines.GetStateString(xnudefines.kn_state_strings, state),
+            kq_ptr=int(GetKnoteKqueue(kn)),
+            ops_str=fops_str)
+
+@lldb_command('showknote')
+def ShowKnote(cmd_args=None):
+    """ Show information about a knote
+
+        usage: showknote <struct knote *>
+    """
+    if not cmd_args:
+        raise ArgumentError('missing struct knote * argument')
+
+    kn = kern.GetValueFromAddress(cmd_args[0], 'struct knote *')
+    print GetKnoteSummary.header
+    print GetKnoteSummary(kn)
+
+def IterateKqueueKnotes(kq):
+    """ Iterate through all knotes of a given kqueue
+
+        params:
+            kq - the kqueue to iterate the knotes of
+        returns: nothing, this is meant to be used as a generator function
+            kn - yields each knote in the kqueue
+    """
+    proc = kq.kq_p
+    for kn in IterateProcKnotes(proc):
+        if unsigned(GetKnoteKqueue(kn)) != unsigned(addressof(kq)):
+            continue
+        yield kn
+
+@lldb_type_summary(['struct kqrequest *'])
+@header('{:<20s} {:<20s} {:<5s} {:<5s} {:<5s} {:<5s} {:s}'.format('kqrequest', 'thread', 'qos', 'ovr_qos', 'w_qos', 'sa_qos', 'state'))
+def GetKqrequestSummary(kqr):
+    """ Summarize kqrequest information
+
+        params:
+            kqr - the kqrequest object
+        returns: str - summary of kqrequest
+    """
+    fmt = '{kqrp: <#020x} {kqr.kqr_bound.kqrb_thread: <#020x} {qos: <5s} {ovr_qos: <5s} {w_qos: <5s} {sa_qos: <5s} {state_str:<s}'
+    return fmt.format(kqrp=int(kqr),
+            kqr=kqr,
+            qos=xnudefines.thread_qos_short_strings[int(kqr.kqr_qos_index)],
+            ovr_qos=xnudefines.thread_qos_short_strings[int(kqr.kqr_override_index)],
+            w_qos=xnudefines.thread_qos_short_strings[int(kqr.kqr_dsync_waiters_qos)],
+            sa_qos=xnudefines.thread_qos_short_strings[int(kqr.kqr_stayactive_qos)],
+            state_str=xnudefines.GetStateString(xnudefines.kqrequest_state_strings, kqr.kqr_state))
+
+@lldb_command('showkqrequest')
+def ShowKqrequest(cmd_args=None):
+    """ Display information about a kqrequest object.
+
+        usage: showkqrequest <struct kqrequest *>
+    """
+    if len(cmd_args) < 1:
+        raise ArgumentError('missing struct kqrequest * argument')
+    kqr = kern.GetValueFromAddress(cmd_args[0], 'struct kqrequest *')
+    print GetKqrequestSummary.header
+    print GetKqrequestSummary(kqr)
+    print GetKnoteSummary.header
+    for kn in IterateTAILQ_HEAD(kqr.kqr_suppressed, 'kn_tqe'):
+        print GetKnoteSummary(kn)
+
+kqueue_summary_fmt = '{ptr: <#020x} {o.kq_p: <#020x} {dyn_id: <#020x} {servicer: <#20x} {owner: <#20x} {o.kq_count: <6d} {wqs: <#020x} {kqr_state: <30s} {st_str: <10s}'
+
+@lldb_type_summary(['struct kqueue *'])
+@header('{: <20s} {: <20s} {: <20s} {: <20s} {: <20s} {: <6s} {: <20s} {: <30s} {: <10s}'.format('kqueue', 'process', 'dynamic_id', 'servicer', 'owner', '#evts', 'wqs', 'request', 'state'))
+def GetKqueueSummary(kq):
+    """ Summarize kqueue information
+
+        params:
+            kq - the kqueue object
+        returns: str - summary of kqueue
+    """
+    if kq.kq_state & xnudefines.KQ_WORKLOOP:
+        return GetKqworkloopSummary(kern.GetValueFromAddress(int(kq), 'struct kqworkloop *'))
+    elif kq.kq_state & xnudefines.KQ_WORKQ:
+        return GetKqworkqSummary(kern.GetValueFromAddress(int(kq), 'struct kqworkq *'))
+    else:
+        return GetKqfileSummary(kern.GetValueFromAddress(int(kq), 'struct kqfile *'))
+
+@lldb_type_summary(['struct kqfile *'])
+@header(GetKqueueSummary.header)
+def GetKqfileSummary(kqf):
+    kq = kern.GetValueFromAddress(int(kqf), 'struct kqueue *')
+    state = int(kq.kq_state)
+    return kqueue_summary_fmt.format(
+            o=kq,
+            ptr=int(kq),
+            wqs=int(kq.kq_wqs),
+            kqr_state='',
+            dyn_id=0,
+            st_str=xnudefines.GetStateString(xnudefines.kq_state_strings, state),
+            servicer=0,
+            owner=0)
+
+@lldb_command('showkqfile')
+def ShowKqfile(cmd_args=None):
+    """ Display information about a kqfile object.
+
+        usage: showkqfile <struct kqfile *>
+    """
+    if len(cmd_args) < 1:
+        raise ArgumentError('missing struct kqfile * argument')
+
+    kqf = kern.GetValueFromAddress(cmd_args[0], 'kqfile *')
+
+    print GetKqfileSummary.header
+    print GetKqfileSummary(kqf)
+    print GetKnoteSummary.header
+    for kn in IterateKqueueKnotes(kqf.kqf_kqueue):
+        print GetKnoteSummary(kn)
+    for kn in IterateTAILQ_HEAD(kqf.kqf_suppressed, 'kn_tqe'):
+        print GetKnoteSummary(kn)
+
+@lldb_type_summary(['struct kqworkq *'])
+@header(GetKqueueSummary.header)
+def GetKqworkqSummary(kqwq):
+    """ Summarize workqueue kqueue information
+
+        params:
+            kqwq - the kqworkq object
+        returns: str - summary of workqueue kqueue
+    """
+    return GetKqfileSummary(kern.GetValueFromAddress(int(kqwq), 'struct kqfile *'))
+
+@lldb_command('showkqworkq')
+def ShowKqworkq(cmd_args=None):
+    """ Display summary and knote information about a kqworkq.
+
+        usage: showkqworkq <struct kqworkq *>
+    """
+    if len(cmd_args) < 1:
+        raise ArgumentError('missing struct kqworkq * argument')
+
+    kqwq = kern.GetValueFromAddress(cmd_args[0], 'struct kqworkq *')
+    kq = kqwq.kqwq_kqueue
+    print GetKqueueSummary.header
+    print GetKqworkqSummary(kqwq)
+    print GetKnoteSummary.header
+    for kn in IterateKqueueKnotes(kq):
+        print GetKnoteSummary(kn)
+    for i in xrange(0, xnudefines.KQWQ_NBUCKETS):
+        for kn in IterateTAILQ_HEAD(kq.kq_queue[i], 'kn_tqe'):
+            print GetKnoteSummary(kn)
+
+@lldb_type_summary(['struct kqworkloop *'])
+@header(GetKqueueSummary.header)
+def GetKqworkloopSummary(kqwl):
+    """ Summarize workloop kqueue information
+
+        params:
+            kqwl - the kqworkloop object
+        returns: str - summary of workloop kqueue
+    """
+    state = int(kqwl.kqwl_kqueue.kq_state)
+    return kqueue_summary_fmt.format(
+            ptr=int(kqwl),
+            o=kqwl.kqwl_kqueue,
+            wqs=int(kqwl.kqwl_kqueue.kq_wqs),
+            dyn_id=kqwl.kqwl_dynamicid,
+            kqr_state=xnudefines.GetStateString(xnudefines.kqrequest_state_strings, kqwl.kqwl_request.kqr_state),
+            st_str=xnudefines.GetStateString(xnudefines.kq_state_strings, state),
+            servicer=int(kqwl.kqwl_request.kqr_bound.kqrb_thread),
+            owner=int(kqwl.kqwl_owner)
+            )
+
+@lldb_command('showkqworkloop')
+def ShowKqworkloop(cmd_args=None):
+    """ Display information about a kqworkloop.
+
+        usage: showkqworkloop <struct kqworkloop *>
+    """
+    if len(cmd_args) < 1:
+        raise ArgumentError('missing struct kqworkloop * argument')
+
+    kqwl = kern.GetValueFromAddress(cmd_args[0], 'struct kqworkloop *')
+
+    print GetKqworkloopSummary.header
+    print GetKqworkloopSummary(kqwl)
+
+    print GetKqrequestSummary.header
+    kqr = kern.GetValueFromAddress(unsigned(addressof(kqwl.kqwl_request)), 'struct kqrequest *')
+    print GetKqrequestSummary(kqr)
+
+    print GetKnoteSummary.header
+    for kn in IterateKqueueKnotes(kqwl.kqwl_kqueue):
+        print GetKnoteSummary(kn)
+
+@lldb_command('showkqueue')
+def ShowKqueue(cmd_args=None):
+    """ Given a struct kqueue pointer, display the summary of the kqueue
+
+        usage: showkqueue <struct kqueue *>
+    """
+    if not cmd_args:
+        raise ArgumentError('missing struct kqueue * argument')
+
+    kq = kern.GetValueFromAddress(cmd_args[0], 'struct kqueue *')
+    if int(kq.kq_state) & xnudefines.KQ_WORKQ:
+        ShowKqworkq(cmd_args=[str(int(kq))])
+    elif int(kq.kq_state) & xnudefines.KQ_WORKLOOP:
+        ShowKqworkloop(cmd_args=[str(int(kq))])
+    else:
+        print GetKqueueSummary.header
+        print GetKqueueSummary(kq)
+        print GetKnoteSummary.header
+        for kn in IterateKqueueKnotes(kq):
+            print GetKnoteSummary(kn)
+
+@lldb_command('showprocworkqkqueue')
+def ShowProcWorkqKqueue(cmd_args=None):
+    """ Show the workqueue kqueue for a given process.
+
+        usage: showworkqkqueue <proc_t>
+    """
+    if not cmd_args:
+        raise ArgumentError('missing struct proc * argument')
+
+    proc = kern.GetValueFromAddress(cmd_args[0], 'proc_t')
+    ShowKqworkq(cmd_args=[str(int(proc.p_fd.fd_wqkqueue))])
+
+@lldb_command('showprockqueues')
+def ShowProcKqueues(cmd_args=None):
+    """ Show the kqueues for a given process.
+
+        usage: showprockqueues <proc_t>
+    """
+    if not cmd_args:
+        raise ArgumentError('missing struct proc * argument')
+
+    proc = kern.GetValueFromAddress(cmd_args[0], 'proc_t')
+
+    print GetKqueueSummary.header
+    for kq in IterateProcKqueues(proc):
+        print GetKqueueSummary(kq)
+
+@lldb_command('showprocknotes')
+def ShowProcKnotes(cmd_args=None):
+    """ Show the knotes for a given process.
+
+        usage: showprocknotes <proc_t>
+    """
+
+    if not cmd_args:
+        raise ArgumentError('missing struct proc * argument')
+
+    proc = kern.GetValueFromAddress(cmd_args[0], 'proc_t')
+
+    print GetKnoteSummary.header
+    for kn in IterateProcKnotes(proc):
+        print GetKnoteSummary(kn)
+
+@lldb_command('showallkqueues')
+def ShowAllKqueues(cmd_args=[], cmd_options={}):
+    """ Display a summary of all the kqueues in the system
+
+        usage: showallkqueues
+    """
+    print GetKqueueSummary.header
+    for kq in IterateAllKqueues():
+        print GetKqueueSummary(kq)