Xcode/LLDB: How to get information about an exception that was just thrown?

Question

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.

View more solutions

Comments

[Karoy Lorentey]

Remember, the exception has just been raised, its description hasn't been printed on the console yet.

[Nikolai Fetissov]

Check out this question: stackoverflow.com/questions/711650

[offex]

How would one do this in lldb? I get an error "error: reference to 'id' is ambiguous"

[João Nunes]

can you provide the source of this info? i would like to read more about it

[Karoy Lorentey]

The iOS/ARM calling conventions are documented in the iOS ABI Function Call Guide, which is based on the Procedure Call Standard for the ARM Architecture ABI. The iOS Simulator uses the OS X calling conventions on x86.

[wbyoung]

Currently the following works for me before the prologue when breaing on objc_exception_throw in LLDB: po *(id *)($esp + 4).

[funroll]

This worked! However, it didn't work until I selected stack frame 0. (objc_exception_throw).

[monkeydom]

po $eax works for me in the simulator as pendant to the $r0 when on device.

[bradheintz]

Hmm... In Xcode 6.1, I'm getting: (lldb) po $rax error: Couldn't materialize: couldn't read the value of register rax Errored out in Execute, couldn't PrepareToExecuteJITExpression

[João Nunes]

@bradheintz simulator or device? i tried this with 6.0.1

[Chris Conover]

Can you point provide a link to your source for that? Thanks!

[João Nunes]

I just wrote in lldb: register read . Then with this info we know that the first register in the exception frame holds the exception message.

[João Nunes]

Ok i found some docs: rax is a 64bits register: In 64-bit long mode you can use 64-bit registers (e.g. rax instead of eax, rbx instead of ebx, etc..)

[Rickster]

It seems that now you need to typecast these registers to an NSException. po (NSException*)$eax po (NSException*)$rax

[DanSkeel]

Check out this awesome script that automates the answer.

[Iulian Onofrei]

I get error: use of undeclared identifier '$r0' on iPad with iOS 7