From f55a8361816d202c2118d4c0c2571762befcfe70 Mon Sep 17 00:00:00 2001 From: Jim Ingham Date: Thu, 31 Mar 2011 21:56:13 +0000 Subject: [PATCH] Little bit of cleanup, and added a few new bits. llvm-svn: 128678 --- lldb/www/tutorial.html | 174 +++++++++++++++++++++++++++++++++-------- 1 file changed, 140 insertions(+), 34 deletions(-) diff --git a/lldb/www/tutorial.html b/lldb/www/tutorial.html index 4a27b2f434c2..7e359d384101 100755 --- a/lldb/www/tutorial.html +++ b/lldb/www/tutorial.html @@ -3,7 +3,7 @@ -LLDB Goals +LLDB Tutorial @@ -20,7 +20,7 @@

Here's a short precis of how to run lldb if you are familiar with the gdb command set. - We will first start with some details on lldb command structure to help orient you.

+ We will start with some details on lldb command structure and syntax to help orient you.

@@ -34,13 +34,14 @@ form:

- <noun> <verb< [-options [option-value]] [argument [argument...]] + <noun> <verb> [-options [option-value]] [argument [argument...]]

The command line parsing is done before command execution, so it is - uniform across all the commands. The command syntax is very simple, - basically arguments, options and option values are all white-space - separated. If you need to put a backslash or double-quote character + uniform across all the commands. The command syntax for basic commands is very simple, + arguments, options and option values are all white-space + separated, and double-quotes are used to protect white-spaces in an argument. + If you need to put a backslash or double-quote character in an argument you back-slash it in the argument. That makes the command syntax more regular, but it also means you may have to quote some arguments in lldb that you wouldn't in gdb.

@@ -61,15 +62,18 @@ parsers, which sometimes forces the user to be a little more explicit about stating their intentions. The first instance you'll note of this is the breakpoint command. In gdb, to set a breakpoint, you - might enter one of:

+ might enter

(gdb) break foo.c:12 -
(gdb) break foo + +

to break at line 12 of foo.c, and:

+ + (gdb) break foo -

if foo is a function. As time went on, the parser that tells foo.c:12 - from foo from foo.c::foo (which means the function foo in the file +

to break at the function foo. As time went on, the parser that tells foo.c:12 + from foo from foo.c::foo (which means the function foo in the file foo.c) got more and more complex and bizarre, and especially in C++ there are times where there's really no way to specify the function you want to break on. The lldb commands are more verbose but also more precise @@ -89,7 +93,7 @@
(lldb) breakpoint set -n foo -

Setting breakpoints by name is event more specialized in LLDB as you can specify +

Setting breakpoints by name is even more specialized in LLDB as you can specify that you want to set a breakpoint at a function by method name. To set a breakpoint on all C++ methods named foo you can entier either of:

@@ -121,7 +125,7 @@ (lldb) breakpoint set -n "-[SKTGraphicView alignLeftEdges:]" -
(lldb) b s -n "-[SKTGraphicView alignLeftEdges:]" +
(lldb) br s -n "-[SKTGraphicView alignLeftEdges:]"

lldb also supports command completion for source file names, symbol @@ -155,7 +159,7 @@ "next" and "continue") but we haven't tried to be exhaustive because in our experience it is more convenient to make the basic commands unique down to a letter or two, and then learn these sequences than - fill the namespace with lots of aliases, and then have to type them + to fill the namespace with lots of aliases, and then have to type them all the way out.

However, users are free to customize lldb's command set however they @@ -164,6 +168,37 @@ you. Your aliases are also documented in the help command so you can remind yourself of what you've set up.

+

One alias of note that we do include by popular demand is a weak emulator + of gdb's "break" command. It doesn't try to do everything that gdb's + break command does (for instance, it doesn't handle foo.c::bar. But + it mostly works, and makes the transition easier. Also by popular demand, it + is aliased to b. If you actually want to learn the lldb command + set natively, that means it will get in the way of the rest of the breakpoint + commands. Fortunately, if you don't like one of our aliases, you an easily + get rid of it by running (for example):

+ + + (lldb) command unalias b + + +

I actually also do:

+ + + (lldb) command alias b breakpoint + + +

so I can run the native lldb breakpoint command with just b

+ +

The lldb command parser also supports "raw" commands, where, after command options + are stripped off, the rest of the command string is passed uninterpreted to the command. + This is convenient for commands whose arguments might be some complex expression that would + be painful to backslash protect. + For instance the "expression" command is a "raw" command for obvious reasons. The + "help" output for a command will tell you if it is "raw" or not, so you know what to expect. + The one thing you have to watch out for is that since raw commands still can have options, + if your command string has dashes in it, you'll have to indicate these are not option + markers by putting "--" after the command name, but before your command string. +

lldb also has a built-in Python interpreter, which is accessible by the "script" command. All the functionality of the debugger is available as classes in the Python interpreter, so the more complex @@ -172,6 +207,9 @@ then loading the scripts into your running session and accessing them with the "script" command.

+

Having given an overview of lldb's command syntax, we proceed to lay out the stages + of a standard debug session.

+
@@ -219,12 +257,17 @@ Current breakpoints: 1.1: where = Sketch`-[SKTGraphicView alignLeftEdges:] + 33 at /Projects/Sketch/SKTGraphicView.m:1405, address = 0x0000000100010d5b, resolved, hit count = 0 -

Note that each logical breakpoint can have multiple locations. - The logical breakpoint has an integer id, and it's locations have an +

Note that setting a breakpoint creates a logical breakpoint, which could + resolve to one or more locations. For instance, break by selector would + set a breakpoint on all the methods that implement that selector in the classes in + your program. Similarly, a file and line breakpoint might result in multiple + locations if that file and line were inlined in different places in your code.

+ +

The logical breakpoint has an integer id, and it's locations have an id within their parent breakpoint (the two are joined by a ".", e.g. 1.1 in the example above.)

-

Also the breakpoints remain live so that if another shared library +

Also the logical breakpoints remain live so that if another shared library were to be loaded that had another implementation of the "alignLeftEdges:" selector, the new location would be added to breakpoint 1 (e.g. a "1.2" breakpoint would be set on the newly loaded @@ -243,7 +286,7 @@ Current breakpoints: (gdb) set breakpoint pending on -

That is, lldb should always make a breakpoint from your specification, even +

That is, lldb will always make a breakpoint from your specification, even if it couldn't find any locations that match the specification. You can tell whether the expression was resolved or not by checking the locations field in "breakpoint list", and we report the breakpoint as "pending" when you @@ -257,22 +300,43 @@ Current breakpoints:

You can delete, disable, set conditions and ignore counts either on all the - locations generated by your logical breakpoint, or on particular locations + locations generated by your logical breakpoint, or on any one of the particular locations your specification resolved to. For instance if we wanted to add a command to print a backtrace when we hit this breakpoint we could do:

- (lldb) breakpoint command add --commands 1.1 + (lldb) breakpoint command add 1.1
Enter your debugger command(s). Type 'DONE' to end.
> bt
> DONE -

The "--command" option specifies that the breakpoint command is a set of lldb - commmand interpreter commands. Use "--script" if you want to implement your - breakpoint command using the Python script instead.

+

By default, the breakpoint command add command takes lldb command line commands. + You can also specify this explicitly by passing the "--command" option. + Use "--script" if you want to implement your breakpoint command using the Python script instead.

- +

This is an convenient point to bring up another feature of the lldb command help. Do:

+ + + (lldb) help break command add +
Add a set of commands to a breakpoint, to be executed whenever the breakpoint is hit. +
+
Syntax: breakpoint command add <cmd-options> <breakpt-id> +
etc... + + +

When you see arguments to commands specified in the Syntax in angle + brackets like <breakpt-id>, that indicates that + that is some common argument type that you can get further help on from the command system. + So in this case you could do:

+ + + (lldb) help <breakpt-id> +
<breakpt-id> -- Breakpoint ID's consist major and minor numbers; the major +
etc... + + +
@@ -375,7 +439,7 @@ Current breakpoints: the process is running anything you type will go to the STDIN of the inferior process. To interrupt your inferior program, type CTRL+C.

-

If you attach to a process, or launch a process with the "--no-stdin +

If you attach to a process, or launch a process with the "--no-stdin" option, the command interpreter is always available to enter commands. This might be a little disconcerting to gdb users when always have an (lldb) prompt. This allows you to set a breakpoint, etc without having to explicitly interrupt @@ -394,13 +458,33 @@ Current breakpoints: This mode will allow us to run all threads and only stop the threads that are at breakpoints or have exceptions or signals.

-

There command commands that currently work while running include +

The commands that currently work while running include interrupting the process to halt execution ("process interrupt"), getting the process status ("process status"), breakpoint setting and clearing (" breakpoint [set|clear|enable|disable|list] ..."), and memory reading and writing (" memory [read|write] ...").

+

The question of disabling stdio when running brings up a good opportunity to + show how to set debugger properties in general. + If you always want to run in the --no-stdin mode, you can set this + as a generic process property using the lldb "settings&qout; command, + which is equivalent to gdb's "set" command. For instance, + in this case you would say:

+ + + (lldb) settings set target.process.disable-stdio true + + +

Over time, gdb's "set command became a wilderness of disordered options, + so that there were useful options that even experienced gdb users didn't know about + because they were too hard to find. We tried to organize the settings hierarchically + using the structure of the basic entities in the debugger. For the most part anywhere + you can specify a setting on a generic entity (threads, for example) you can also apply + the option to a particular instance, which can also be convenient at times. + You can view the available settings with "settings list" and + there is help on the settings command explaining how it works more generally.

+
@@ -409,7 +493,7 @@ Current breakpoints:

Once you've stopped, lldb will choose a current thread, usually the - one that stopped "for a reason", and a current frame in that thread. + one that stopped "for a reason", and a current frame in that thread (on stop this is always the bottom-most frame). Many the commands for inspecting state work on this current thread/frame.

@@ -447,7 +531,16 @@ thread #1: tid = 0x2c03, stop reason = breakpoint 1.1, queue = com.apple.main-th (lldb) thread backtrace all -

+ +

You can select the current thread, which will be used by default in all the commands in + the next section, with the "thread select" command:

+ + + (lldb) thread select 2 + + +

where the thread index is just the one shown in the "thread list" listing. +

@@ -469,12 +562,21 @@ thread #1: tid = 0x2c03, stop reason = breakpoint 1.1, queue = com.apple.main-th

As you see above, if you don't specify any variable names, all arguments - and locals will be shown. If give "frame variable" some arguments, - they should be the name of locals or paths to children of the variables:

+ and locals will be shown. If you call "frame variable" + passing in the names of a particular local(s), only those variables + will be printed. For instance: +

(lldb) frame variable self
(SKTGraphicView *) self = 0x0000000100208b40 + + +

You can also pass in a path to some subelement of one of the available locals, + and that sub-element will be printed. For instance: +

+ +
(lldb) frame variable self.isa
(struct objc_class *) self.isa = 0x0000000100023730 @@ -499,20 +601,25 @@ thread #1: tid = 0x2c03, stop reason = breakpoint 1.1, queue = com.apple.main-th

The frame variable command will also perform "object printing" operations on - variables (currently we only support NSPrintForDebugger) with:

+ variables (currently we only support ObjC printing, using the object's "description" method. + Turn this on by passing the -o flag to frame variable:

(lldb) frame variable -o self (SKTGraphicView *) self = 0x0000000100208b40 <SKTGraphicView: 0x100208b40> -

You can select another frame to view with by selecting a frame with the "frame select"

+

You can select another frame to view with the "frame select" command

(lldb) frame select 9 - frame #9: 0x0000000100015ae3, where = Sketch`function1 + 33 at /Projects/Sketch/SKTFunctions.m:11 +
frame #9: 0x0000000100015ae3, where = Sketch`function1 + 33 at /Projects/Sketch/SKTFunctions.m:11 +

You can also move up and down the stack by passing the "--relative" ("-r") + option. And we have built-in aliases "u" and "d" which + behave like their gdb equivalents. +

If you need to view more complex data or change program data, you can use the general "expression" command. It takes an expression and evaluates it in the scope of the currently selected frame. For instance:

@@ -534,8 +641,7 @@ thread #1: tid = 0x2c03, stop reason = breakpoint 1.1, queue = com.apple.main-th
I have a pointer 0x0. -

One thing to note from this example is that lldb commands can be defined to - take "raw" input. "expression" is one of these. So in the expression command, +

As I said above, "expression" is one of the "raw" commands. So you don't have to quote your whole expression, nor backslash protect quotes, etc...