<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[14999] CalendarServer/trunk/contrib/tools/lldb_utils.py</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/14999">14999</a></dd>
<dt>Author</dt> <dd>cdaboo@apple.com</dd>
<dt>Date</dt> <dd>2015-07-26 08:18:57 -0700 (Sun, 26 Jul 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add command to display python local variables. Add each call as a command for use directly within lldb.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcontribtoolslldb_utilspy">CalendarServer/trunk/contrib/tools/lldb_utils.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcontribtoolslldb_utilspy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/contrib/tools/lldb_utils.py (14998 => 14999)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/contrib/tools/lldb_utils.py 2015-07-25 15:34:39 UTC (rev 14998)
+++ CalendarServer/trunk/contrib/tools/lldb_utils.py 2015-07-26 15:18:57 UTC (rev 14999)
</span><span class="lines">@@ -23,37 +23,162 @@
</span><span class="cx"> > lldb
</span><span class="cx"> (lldb) target symbols add <path to Python.framework.dSYM>
</span><span class="cx"> (lldb) command script import contrib/tools/lldb_utils.py
</span><ins>+
+ Run commands using:
+
+ (lldb) pybt
+ ...
+ (lldb) pybtall
+ ...
+ (lldb) pylocals
+ ...
+
+ or inside the python shell:
+
</ins><span class="cx"> (lldb) script
</span><span class="cx"> Python Interactive Interpreter. To exit, type 'quit()', 'exit()' or Ctrl-D.
</span><span class="cx"> >>> lldb_utils.pybt()
</span><ins>+ ...
</ins><span class="cx"> >>> lldb_utils.pybtall()
</span><ins>+ ...
+ >>> lldb_utils.pylocals()
+ ...
</ins><span class="cx">
</span><del>-pybt - generate a python function call backtrace of the currently selected thread
-pybtall - generate a python function call backtrace of all threads
</del><ins>+pybt - generate a python function call back trace of the currently selected thread
+pybtall - generate a python function call back trace of all threads
+pylocals - generate a list of the name and values of all locals in the current
+ python frame (only works when the currently selected frame is a Python call
+ frame as found by the pybt command).
</ins><span class="cx"> """
</span><span class="cx">
</span><span class="cx"> import lldb #@UnresolvedImport
</span><span class="cx">
</span><del>-def pybt(thread=None):
- if thread is None:
- thread = lldb.thread
</del><ins>+def _toStr(obj, pystring_t):
+ return obj.Cast(pystring_t).GetValueForExpressionPath("->ob_sval").summary
+
+
+
+def pybt(debugger=None, command=None, result=None, dict=None, thread=None):
+ """
+ An lldb command that prints a Python call back trace for the specified
+ thread or the currently selected thread.
+
+ @param debugger: debugger to use
+ @type debugger: L{lldb.SBDebugger}
+ @param command: ignored
+ @type command: ignored
+ @param result: ignored
+ @type result: ignored
+ @param dict: ignored
+ @type dict: ignored
+ @param thread: the specific thread to target
+ @type thread: L{lldb.SBThread}
+ """
+
+ if debugger is None:
+ debugger = lldb.debugger
+ target = debugger.GetSelectedTarget()
+ if not isinstance(thread, lldb.SBThread):
+ thread = target.GetProcess().GetSelectedThread()
+
+ pystring_t = target.FindFirstType("PyStringObject").GetPointerType()
+
</ins><span class="cx"> num_frames = thread.GetNumFrames()
</span><del>- pystring_t = lldb.target.FindFirstType("PyStringObject").GetPointerType()
</del><span class="cx"> for i in range(num_frames - 1):
</span><span class="cx"> fr = thread.GetFrameAtIndex(i)
</span><span class="cx"> if fr.GetFunctionName() == "PyEval_EvalFrameEx":
</span><span class="cx"> fr_next = thread.GetFrameAtIndex(i + 1)
</span><span class="cx"> if fr_next.GetFunctionName() == "PyEval_EvalCodeEx":
</span><span class="cx"> f = fr.GetValueForVariablePath("f")
</span><del>- filename = f.GetValueForExpressionPath("->f_code->co_filename").Cast(pystring_t).GetValueForExpressionPath("->ob_sval")
- name = f.GetValueForExpressionPath(".f_code->co_name").Cast(pystring_t).GetValueForExpressionPath("->ob_sval")
- print("{} - {}".format(filename.summary, name.summary))
</del><ins>+ filename = _toStr(f.GetValueForExpressionPath("->f_code->co_filename"), pystring_t)
+ name = _toStr(f.GetValueForExpressionPath("->f_code->co_name"), pystring_t)
+ lineno = f.GetValueForExpressionPath("->f_lineno").GetValue()
+ print("#{}: {} - {}:{}".format(
+ fr.GetFrameID(),
+ filename[1:-1] if filename else ".",
+ name[1:-1] if name else ".",
+ lineno if lineno else ".",
+ ))
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><del>-def pybtall():
- numthreads = lldb.process.GetNumThreads()
</del><ins>+def pybtall(debugger=None, command=None, result=None, dict=None):
+ """
+ An lldb command that prints a Python call back trace for all threads.
+
+ @param debugger: debugger to use
+ @type debugger: L{lldb.SBDebugger}
+ @param command: ignored
+ @type command: ignored
+ @param result: ignored
+ @type result: ignored
+ @param dict: ignored
+ @type dict: ignored
+ """
+ if debugger is None:
+ debugger = lldb.debugger
+ process = debugger.GetSelectedTarget().GetProcess()
+ numthreads = process.GetNumThreads()
</ins><span class="cx"> for i in range(numthreads):
</span><del>- thread = lldb.process.GetThreadAtIndex(i)
</del><ins>+ thread = process.GetThreadAtIndex(i)
</ins><span class="cx"> print("----- Thread: {} -----".format(i + 1))
</span><del>- pybt(thread)
</del><ins>+ pybt(debugger=debugger, thread=thread)
+
+
+
+def pylocals(debugger=None, command=None, result=None, dict=None):
+ """
+ An lldb command that prints a list of Python local variables for the
+ currently selected frame.
+
+ @param debugger: debugger to use
+ @type debugger: L{lldb.SBDebugger}
+ @param command: ignored
+ @type command: ignored
+ @param result: ignored
+ @type result: ignored
+ @param dict: ignored
+ @type dict: ignored
+ """
+ if debugger is None:
+ debugger = lldb.debugger
+ target = debugger.GetSelectedTarget()
+ frame = target.GetProcess().GetSelectedThread().GetSelectedFrame()
+
+ pystring_t = target.FindFirstType("PyStringObject").GetPointerType()
+ pytuple_t = target.FindFirstType("PyTupleObject").GetPointerType()
+
+ f = frame.GetValueForVariablePath("f")
+ try:
+ numlocals = int(f.GetValueForExpressionPath("->f_code->co_nlocals").GetValue())
+ except TypeError:
+ print("Current frame is not a Python function")
+ return
+ print("Locals in frame #{}".format(frame.GetFrameID()))
+ names = f.GetValueForExpressionPath("->f_code->co_varnames").Cast(pytuple_t)
+ for i in range(numlocals):
+ localname = _toStr(names.GetValueForExpressionPath("->ob_item[{}]".format(i)), pystring_t)
+ local = frame.EvaluateExpression("PyString_AsString(PyObject_Repr(f->f_localsplus[{}]))".format(i)).summary
+ print(" {} = {}".format(
+ localname[1:-1] if localname else ".",
+ local[1:-1] if local else ".",
+ ))
+
+
+CMDS = ("pybt", "pybtall", "pylocals",)
+
+
+def __lldb_init_module(debugger, dict):
+ """
+ Register each command with lldb so they are available directly within lldb as
+ well as within its Python script shell.
+
+ @param debugger: debugger to use
+ @type debugger: L{lldb.SBDebugger}
+ @param dict: ignored
+ @type dict: ignored
+ """
+ for cmd in CMDS:
+ debugger.HandleCommand(
+ "command script add -f lldb_utils.{cmd} {cmd}".format(cmd=cmd)
+ )
</ins></span></pre>
</div>
</div>
</body>
</html>