Xcode/LLDB: How to get information about an exception that was just thrown?
OK, so imagine that my breakpoint in objc_exception_throw
has just triggered. I'm sitting at the debugger prompt, and I want to get some more information about the exception object. Where do I find it?
Solution 1:
The exception object is passed in as the first argument to objc_exception_throw
. LLDB provides $arg1
..$argn
variables to refer to arguments in the correct calling convention, making it simple to print the exception details:
(lldb) po $arg1
(lldb) po [$arg1 name]
(lldb) po [$arg1 reason]
Make sure to select the objc_exception_throw
frame in the call stack before executing these commands. See the "Advanced Debugging and the Address Sanitizer" in the WWDC15 session videos to see this performed on stage.
Outdated Information
If you're on GDB, the syntax to refer to the first argument depends on the calling conventions of the architecture you're running on. If you're debugging on an actual iOS device, the pointer to the object is in register r0
. To print it or send messages to it, use the following simple syntax:
(gdb) po $r0
(gdb) po [$r0 name]
(gdb) po [$r0 reason]
On the iPhone Simulator, all function arguments are passed on the stack, so the syntax is considerably more horrible. The shortest expression I could construct that gets to it is *(id *)($ebp + 8)
. To make things less painful, I suggest using a convenience variable:
(gdb) set $exception = *(id *)($ebp + 8)
(gdb) po $exception
(gdb) po [$exception name]
(gdb) po [$exception reason]
You can also set $exception
automatically whenever the breakpoint is triggered by adding a command list to the objc_exception_throw
breakpoint.
(Note that in all cases I tested, the exception object was also present in the eax
and edx
registers at the time the breakpoint hit. I'm not sure that'll always be the case, though.)
Added from comment below:
In lldb, select the stack frame for objc_exception_throw
and then enter this command:
(lldb) po *(id *)($esp + 4)
Solution 2:
on new simulators (iOS 8, 64bit) xcode 6 im using in the exception frame: objc_exception_throw
po $rax
in 32bit:
po $eax
What is rax?
Rax is a 64bits register that replaces the old eax
How to find all the registers?
register read
Source wikipedia
Solution 3:
At the time of this writing, this post is my top Google hit for: lldb print exception. Thus, I am adding this answer to account for lldb and x86_64.
My attempts to find the exception using po $eax
failed with error: Couldn't materialize struct: Couldn't read eax (materialize)
. Other attempts described in linked documents from earlier answers also failed.
The key was I had to first click on the objc_exception_throw
frame in my main thread. lldb does not start off in that frame.
In all my searching and following examples, this blog entry was the first to explain things in a way that worked for me. It is more modern, being posted in Aug 2012.
Solution 4:
If you have a catch statement, put a breakpoint in there and you can inspect the exception object at that point.
If you don't have a catch statement, continue.
You'll get a message in your terminal like this:
Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '* -[__NSPlaceholderDictionary initWithObjects:forKeys:count:]: attempt to insert nil object from objects[0]'
However, you're probably looking for a way to inspect it without continuing since you'll lose your nice stack trace when the application is terminated.
For that it sounds like Fnord's answer is best, but I wasn't able to get it working in LLDB.