xref: /xnu-8020.101.4/tools/lldbmacros/workqueue.py (revision e7776783b89a353188416a9a346c6cdb4928faad)
1from __future__ import absolute_import, division, print_function
2
3from xnu import *
4from process import GetBSDThread, GetMachThread
5from scheduler import GetRecentTimestamp
6import xnudefines
7
8def GetProcWorkqueue(proc):
9    wq = proc.p_wqptr;
10    if unsigned(wq):
11        return Cast(wq, "struct workqueue *");
12    return None
13
14@header("{:<20s} {:<20s} {:<20s} {:<10s} {:<10s} {:<10s} {:<10s} {:<10s} {:<10s} {:<30s}".format(
15    'task', 'proc', 'wq', 'sched', 'pending', 'idle', 'dying', 'creations', 'fulfilled', 'wq_flags'))
16def GetWorkqueueSummary(proc, wq):
17    wq_flags = []
18    if wq.wq_flags & GetEnumValue("workq_state_flags_t::WQ_EXITING"):
19        wq_flags.append("EXITING")
20    if wq.wq_flags & GetEnumValue("workq_state_flags_t::WQ_PROC_SUSPENDED"):
21        wq_flags.append("PROC_SUSPENDED")
22    if wq.wq_flags & GetEnumValue("workq_state_flags_t::WQ_DEATH_CALL_SCHEDULED"):
23        wq_flags.append("DEATH_CALL")
24
25    scheduled = GetEnumValue("workq_state_flags_t::WQ_DELAYED_CALL_SCHEDULED")
26    pended = GetEnumValue("workq_state_flags_t::WQ_DELAYED_CALL_PENDED")
27    if wq.wq_flags & (scheduled | pended):
28        s = "DELAYED_CALL["
29        if wq.wq_flags & scheduled: s += 'S'
30        if wq.wq_flags & pended: s += 'P'
31        s += ']'
32        wq_flags.append(s)
33
34    scheduled = GetEnumValue("workq_state_flags_t::WQ_IMMEDIATE_CALL_SCHEDULED")
35    pended = GetEnumValue("workq_state_flags_t::WQ_IMMEDIATE_CALL_PENDED")
36    if wq.wq_flags & (scheduled | pended):
37        s = "IMMEDIATE_CALL["
38        if wq.wq_flags & scheduled: s += 'S'
39        if wq.wq_flags & pended: s += 'P'
40        s += ']'
41        wq_flags.append(s)
42
43    return "{p.task: <#020x} {p: <#020x} {wq: <#020x} {wq.wq_threads_scheduled: <10d} {wq.wq_reqcount: <10d} {wq.wq_thidlecount: <10d} {wq.wq_thdying_count: <10d} {wq.wq_creations: <10d} {wq.wq_fulfilled: <10d} {wq_flags: <30s}".format(p=proc, wq=wq, wq_flags=" ".join(wq_flags));
44
45@header("{:<20s} {:<20s} {:>10s}  {:9s} {:<20s} {:<10s} {:<30s}".format(
46    'thread', 'uthread', 'thport', 'kind', 'kqueue', 'idle (ms)', 'uu_workq_flags'))
47def GetWQThreadSummary(th, uth):
48    p = th.t_tro.tro_proc
49    wq = p.p_wqptr
50
51    uu_workq_flags = []
52    if uth.uu_workq_flags & 0x01: uu_workq_flags.append("NEW")
53    if uth.uu_workq_flags & 0x02:
54        uu_workq_flags.append("RUNNING")
55        if wq.wq_creator == uth:
56            kind = "creator"
57        else:
58            kind = "workq"
59        idle = ""
60    else:
61        ts = kern.GetNanotimeFromAbstime(GetRecentTimestamp() - uth.uu_save.uus_workq_park_data.idle_stamp) / 1e9
62        kind = "idle"
63        idle = "%#.03f" % (ts)
64    if uth.uu_workq_flags & 0x04: uu_workq_flags.append("DYING")
65    if uth.uu_workq_flags & 0x08: uu_workq_flags.append("OVERCOMMIT")
66    if uth.uu_workq_flags & 0x100: uu_workq_flags.append("COOPERATIVE")
67    if uth.uu_workq_flags & 0x10: uu_workq_flags.append("OUTSIDE_QOS")
68    if uth.uu_workq_flags & 0x20: uu_workq_flags.append("IDLE_CLEANUP")
69    if uth.uu_workq_flags & 0x40: uu_workq_flags.append("EARLY_BOUND")
70    if uth.uu_workq_flags & 0x80: uu_workq_flags.append("CPU%")
71
72    kqr = uth.uu_kqr_bound
73    if not kqr:
74        kq = 0
75    elif kqr.tr_flags & 0x1: # kevent
76        kq = p.p_fd.fd_wqkqueue
77        kind = "kqwq[%s]" % (xnudefines.thread_qos_short_strings[int(kqr.tr_kq_qos_index)])
78    elif kqr.tr_flags & 0x2: # workloop
79        kq = ContainerOf(kqr, 'struct kqworkloop', 'kqwl_request')
80        kind = "workloop"
81    else:
82        kq = 0
83        kind = "???"
84
85    return "{th: <#020x} {uth: <#020x} {thport: >#010x}  {kind: <9s} {kq: <#020x} {idle: <10s} {uu_workq_flags: <30s}".format(th=th, uth=uth, thport=uth.uu_workq_thport, kind=kind, kq=kq, idle=idle, uu_workq_flags=" ".join(uu_workq_flags))
86
87@header("{:<20s} {:<20s} {:<20s} {:<10s} {:<4s} {:<6s} {:<6s} {:<6s} {:<30s}".format(
88    'request', 'kqueue', 'thread', 'state', '#', 'qos', 'kq_qos', 'kq_ovr', 'tr_flags'))
89def GetWorkqueueThreadRequestSummary(proc, req): # req is the actual structure, not pointer
90    kq = 0
91    tr_flags = []
92    req_addr = addressof(req)
93
94    if req.tr_flags & 0x01:
95        tr_flags.append("KEVENT")
96        kq = proc.p_fd.fd_wqkqueue
97    if req.tr_flags & 0x02:
98        tr_flags.append("WORKLOOP")
99        kq = ContainerOf(req_addr, 'struct kqworkloop', 'kqwl_request')
100    if req.tr_flags & 0x04: tr_flags.append("OVERCOMMIT")
101    if req.tr_flags & 0x08: tr_flags.append("PARAMS")
102    if req.tr_flags & 0x10: tr_flags.append("OUTSIDE_QOS")
103    if req.tr_flags & 0x20: tr_flags.append("COOPERATIVE")
104
105    state = {0: "IDLE", 1: "NEW", 2: "QUEUED", 3: "CANCELED", 4: "BINDING", 5: "BOUND" }[int(req.tr_state)]
106
107    thread = 0
108    if int(req.tr_state) in [4, 5]: # BINDING or BOUND
109        thread = req.tr_thread
110
111    qos = int(req.tr_qos)
112    if qos == 8:
113        qos = "MG"
114    elif qos == 7:
115        qos = "SP"
116    else:
117        qos = xnudefines.thread_qos_short_strings[qos]
118
119    kq_qos = xnudefines.thread_qos_short_strings[int(req.tr_kq_qos_index)]
120    kq_ovr = xnudefines.thread_qos_short_strings[int(req.tr_kq_override_index)]
121
122    return "{req_addr: <#020x} {kq: <#020x} {thread: <#020x} {state: <10s} {tr_count: <4d} {qos: <6s} {kq_qos: <6s} {kq_ovr: <6s} {tr_flags: <30s}".format(
123            req_addr=unsigned(req_addr), kq=kq, thread=thread, state=state, qos=qos, kq_qos=kq_qos, kq_ovr=kq_ovr, tr_count=req.tr_count, tr_flags=" ".join(tr_flags))
124
125@lldb_command('showwqthread', fancy=True)
126def ShowWQThread(cmd_args=None, cmd_options={}, O=None):
127    """ Shows info about a workqueue thread
128
129        usage: showworkqthread <thread_t>
130    """
131
132    if not cmd_args:
133        return O.error('missing struct proc * argument')
134
135    th = kern.GetValueFromAddress(cmd_args[0], "struct thread *")
136    if not (th.thread_tag & 0x20):
137        raise ArgumentError('not a workqueue thread')
138
139    with O.table(GetWQThreadSummary.header):
140        print(GetWQThreadSummary(th, GetBSDThread(th)))
141
142
143@lldb_command('showprocworkqueue', fancy=True)
144def ShowProcWorkqueue(cmd_args=None, cmd_options={}, O=None):
145    """ Shows the process workqueue
146
147        usage: showprocworkqueue <proc_t>
148    """
149
150    if not cmd_args:
151        return O.error('missing struct proc * argument')
152
153    proc = kern.GetValueFromAddress(cmd_args[0], "proc_t")
154    wq = Cast(proc.p_wqptr, "struct workqueue *")
155    if not wq:
156        return O.error("{:#x} doesn't have a workqueue", proc)
157
158    with O.table(GetWorkqueueSummary.header):
159        print(GetWorkqueueSummary(proc, wq))
160
161        with O.table(GetWorkqueueThreadRequestSummary.header, indent=True):
162            if wq.wq_reqcount:
163                print("")
164            if wq.wq_event_manager_threadreq:
165                print(GetWorkqueueThreadRequestSummary(proc, dereference(wq.wq_event_manager_threadreq)))
166            for req in IterateSchedPriorityQueue(wq.wq_overcommit_queue, 'struct workq_threadreq_s', 'tr_entry'):
167                print(GetWorkqueueThreadRequestSummary(proc, dereference(req)))
168            for req in IterateSchedPriorityQueue(wq.wq_constrained_queue, 'struct workq_threadreq_s', 'tr_entry'):
169                print(GetWorkqueueThreadRequestSummary(proc, dereference(req)))
170            for req in IterateSchedPriorityQueue(wq.wq_special_queue, 'struct workq_threadreq_s', 'tr_entry'):
171                print(GetWorkqueueThreadRequestSummary(proc, dereference(req)))
172            for qos in xnudefines.thread_qos_short_strings:
173                bucket = 0;
174                if qos > 2: #Greater than BG
175                    bucket = qos - 2;
176                for req in IterateSTAILQ_HEAD(wq.wq_cooperative_queue[bucket], "tr_link"):
177                    print(GetWorkqueueThreadRequestSummary(proc, dereference(req)))
178
179
180        with O.table(GetWQThreadSummary.header, indent=True):
181            print("")
182            for uth in IterateTAILQ_HEAD(wq.wq_thrunlist, "uu_workq_entry"):
183                print(GetWQThreadSummary(GetMachThread(uth), uth))
184            for uth in IterateTAILQ_HEAD(wq.wq_thidlelist, "uu_workq_entry"):
185                print(GetWQThreadSummary(GetMachThread(uth), uth))
186            for uth in IterateTAILQ_HEAD(wq.wq_thnewlist, "uu_workq_entry"):
187                print(GetWQThreadSummary(GetMachThread(uth), uth))
188
189@lldb_command('showallworkqueues', fancy=True)
190def ShowAllWorkqueues(cmd_args=None, cmd_options={}, O=None):
191    """ Display a summary of all the workqueues in the system
192
193        usage: showallworkqueues
194    """
195
196    with O.table(GetWorkqueueSummary.header):
197        for t in kern.tasks:
198            proc = Cast(t.bsd_info, 'proc *')
199            wq = Cast(proc.p_wqptr, "struct workqueue *");
200            if wq:
201                print(GetWorkqueueSummary(proc, wq))
202