Blame - www/python-reference.html - fp2-dev/platform/external/lldb

2012-01-24 02:40:42 +0000

[diff] [blame]

85

The embedded python interpreter can be accessed in a variety of ways from within LLDB. The

86

easiest way is to use the lldb command script with no arguments at the lldb command prompt:

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

87

<code><pre><tt>(lldb) script

88

Python Interactive Interpreter. To exit, type 'quit()', 'exit()' or Ctrl-D.

>>> 2+3

5

>>> hex(12345)

'0x3039'

>>>

</tt></pre></code>

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

96

This drops you into the embedded python interpreter. When running under the script command,

97

lldb sets some convenience variables that give you quick access to the currently selected entities that characterize

98

the program and debugger state. In each case, if there is no currently selected entity of the appropriate

Enrico Granata

b1052dc

2013-01-16 22:25:17 +0000

[diff] [blame^]

99

type, the variable's IsValid method will return false. These variables are:

100

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

101

102

<tr>

103

<td class="hed" width="20%">Variable</td>

104

105

<td class="hed" width="70%">Description</td>

</tr>

<tr>

lldb.debugger

</td>

lldb.SBDebugger

</td>

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

116

Contains the debugger object whose script command was invoked.

117

The lldb.SBDebugger object owns the command interpreter

118

and all the targets in your debug session. There will always be a

119

Debugger in the embedded interpreter.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

</td>

</tr>

<tr>

lldb.target

</td>

lldb.SBTarget

</td>

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

130

Contains the currently selected target - for instance the one made with the

131

file or selected by the target select <target-index> command.

132

The lldb.SBTarget manages one running process, and all the executable

133

and debug files for the process.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

</td>

</tr>

<tr>

lldb.process

</td>

lldb.SBProcess

</td>

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

144

Contains the process of the currently selected target.

145

The lldb.SBProcess object manages the threads and allows access to

146

memory for the process.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

</td>

</tr>

<tr>

lldb.thread

</td>

lldb.SBThread

</td>

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

157

Contains the currently selected thread.

158

The lldb.SBThread object manages the stack frames in that thread.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

159

A thread is always selected in the command interpreter when a target stops.

Enrico Granata

b1052dc

2013-01-16 22:25:17 +0000

[diff] [blame^]

160

The thread select <thread-index> command can be used to change the

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

161

currently selected thread. So as long as you have a stopped process, there will be

162

some selected thread.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

</td>

</tr>

<tr>

lldb.frame

</td>

lldb.SBFrame

</td>

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

173

Contains the currently selected stack frame.

174

The lldb.SBFrame object manage the stack locals and the register set for

175

that stack.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

176

A stack frame is always selected in the command interpreter when a target stops.

Enrico Granata

b1052dc

2013-01-16 22:25:17 +0000

[diff] [blame^]

177

The frame select <frame-index> command can be used to change the

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

178

currently selected frame. So as long as you have a stopped process, there will

179

be some selected frame.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

</td>

</tr>

</table>

Enrico Granata

2013-01-16 22:25:17 +0000

[diff] [blame^]

184

While extremely convenient, these variables have a couple caveats that you should be aware of.

185

First of all, they hold the values

186

of the selected objects on entry to the embedded interpreter. They do not update as you use the LLDB

187

API's to change, for example, the currently selected stack frame or thread.

188

Moreover, they are only defined and meaningful while in the interactive Python interpreter.

189

There is no guarantee on their value in any other situation, hence you should not use them when defining

190

Python formatters, breakpoint scripts and commands (or any other Python extension point that LLDB provides).

191

As a rationale for such behavior, consider that lldb can

192

run in a multithreaded environment, and another thread might call the "script" command, changing the value out

193

from under you.

194

195

To get started with these objects and LLDB scripting, please note that almost

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

196

all of the lldb Python objects are able to briefly describe themselves when you pass them

197

to the Python print function:

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

198

<code><pre><tt>(lldb) script

199

Python Interactive Interpreter. To exit, type 'quit()', 'exit()' or Ctrl-D.

200

>>> print lldb.debugger

201

Debugger (instance: "debugger_1", id: 1)

202

>>> print lldb.target

203

a.out

204

>>> print lldb.process

205

SBProcess: pid = 59289, state = stopped, threads = 1, executable = a.out

206

>>> print lldb.thread

207

SBThread: tid = 0x1f03

208

>>> print lldb.frame

209

frame #0: 0x0000000100000bb6 a.out main + 54 at main.c:16

</tt></pre></code>

</div>

</div>

<h1 class ="postheader">Running a Python script when a breakpoint gets hit</h1>

218

219

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

220

One very powerful use of the lldb Python API is to have a python script run when a breakpoint gets hit. Adding python

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

221

scripts to breakpoints provides a way to create complex breakpoint

222

conditions and also allows for smart logging and data gathering.

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

223

When your process hits a breakpoint to which you have attached some python code, the code is executed as the

Greg Clayton

b34ca85

2012-10-26 17:53:21 +0000

[diff] [blame]

224

body of a function which takes three arguments:

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

225

Greg Clayton

b34ca85

2012-10-26 17:53:21 +0000

[diff] [blame]

226

<code><pre><tt>def breakpoint_function_wrapper(frame, bp_loc, dict):

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

227

# Your code goes here

</tt></pre></code>

<tr>

<td class="hed" width="10%">Argument</td>

232

233

<td class="hed" width="80%">Description</td>

</tr>

<tr>

frame

</td>

lldb.SBFrame

</td>

The current stack frame where the breakpoint got hit.

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

245

The object will always be valid.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

246

This frame argument might not match the currently selected stack frame found in the lldb module global variable lldb.frame.

</td>

</tr>

<tr>

bp_loc

</td>

lldb.SBBreakpointLocation

255

</td>

256

257

The breakpoint location that just got hit. Breakpoints are represented by lldb.SBBreakpoint

258

objects. These breakpoint objects can have one or more locations. These locations

259

are represented by lldb.SBBreakpointLocation objects.

260

</td>

261

</tr>

Greg Clayton

b34ca85

2012-10-26 17:53:21 +0000

[diff] [blame]

<tr>

dict

</td>

dict

</td>

The python session dictionary as a standard python dictionary object.

271

</td>

272

</tr>

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

273

</table>

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

274

An example will show how simple it is to write some python code and attach it to a breakpoint.

275

The following example will allow you to track the order in which the functions in a given shared library

276

are first executed during one run of your program. This is a simple method to gather an order file which

277

can be used to optimize function placement within a binary for execution locality.

278

We do this by setting a regular expression breakpoint

279

that will match every function in the shared library. The regular expression '.' will match

280

any string that has at least one character in it, so we will use that.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

281

This will result in one lldb.SBBreakpoint object

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

282

that contains an lldb.SBBreakpointLocation object for each function. As the breakpoint gets

283

hit, we use a counter to track the order in which the function at this particular breakpoint location got hit.

284

Since our code is passed the location that was hit, we can get the name of the function from the location,

285

disable the location so we won't count this function again; then log some info and continue the process.

286

Note we also have to initialize our counter, which we do with the simple one-line version of the script

command.

Here is the code:

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

290

<code><pre><tt>(lldb) breakpoint set --func-regex=. --shlib=libfoo.dylib

291

Breakpoint created: 1: regex = '.', module = libfoo.dylib, locations = 223

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

292

(lldb) script counter = 0

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

293

(lldb) breakpoint command add --script-type python 1

294

Enter your Python command(s). Type 'DONE' to end.

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

295

> # Increment our counter. Since we are in a function, this must be a global python variable

296

> global counter

297

> counter += 1

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

298

> # Get the name of the function

299

> name = frame.GetFunctionName()

300

> # Print the order and the function name

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

301

> print '[%i] %s' % (counter, name)

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

302

> # Disable the current breakpoint location so it doesn't get hit again

303

> bp_loc.SetEnabled(False)

304

> # How continue the process

305

> frame.GetThread().GetProcess().Continue()

306

> DONE

307

</tt></pre></code>

308

The breakpoint command add command above attaches a python script to breakpoint 1.

309

To remove the breakpoint command:

310

<code>(lldb) breakpoint command delete 1</code>

</div>

</div>

<h1 class ="postheader">Create a new LLDB command using a python function</h1>

315

316

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

317

Python functions can be used to create new LLDB command interpreter commands, which will work

318

like all the natively defined lldb commands. This provides a very flexible and easy way to extend LLDB to meet your

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

319

debugging requirements.

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

320

To write a python function that implements a new LDB command define the function to take four arguments as follows:

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

321

Enrico Granata

2012-08-08 02:06:30 +0000

[diff] [blame]

322

<code><pre><tt>def command_function(debugger, command, result, internal_dict):

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

323

# Your code goes here

324

</tt></pre></code>

Enrico Granata

c0791aa

2012-05-02 21:00:41 +0000

[diff] [blame]

325

326

Optionally, you can also provide a Python docstring, and LLDB will use it when providing help for your command, as in:

Enrico Granata

2012-08-08 02:06:30 +0000

[diff] [blame]

327

<code><pre><tt>def command_function(debugger, command, result, internal_dict):

Enrico Granata

c0791aa

2012-05-02 21:00:41 +0000

[diff] [blame]

328

"""This command takes a lot of options and does many fancy things"""

329

# Your code goes here

330

</tt></pre></code>

331

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

332

333

<tr>

334

<td class="hed" width="10%">Argument</td>

335

336

<td class="hed" width="80%">Description</td>

</tr>

<tr>

debugger

</td>

lldb.SBDebugger

</td>

The current debugger object.

</td>

</tr>

<tr>

command

</td>

python string

</td>

A python string containing all arguments for your command. If you need to chop up the arguments

359

try using the shlex module's <code>shlex.split(command)</code> to properly extract the

arguments.

</td>

</tr>

<tr>

result

</td>

lldb.SBCommandReturnObject

369

</td>

370

371

A return object where you can indicate the success or failure of your command. You can also

372

provide information for the command result by printing data into it. You can also just print

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

373

data as you normally would in a python script and the output will show up; this is useful for

374

logging, but the real output for your command should go in the result object.

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

</td>

</tr>

<tr>

Enrico Granata

2012-08-08 02:06:30 +0000

[diff] [blame]

379

internal_dict

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

</td>

python dict object

</td>

The dictionary for the current embedded script session which contains all variables

and functions.

</td>

</tr>

</table>

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

390

One other handy convenience when defining lldb command-line commands is the command

391

command script import which will import a module specified by file path - so you

392

don't have to change your PYTHONPATH for temporary scripts. It also has another convenience

393

that if your new script module has a function of the form:

394

Enrico Granata

2012-08-08 02:06:30 +0000

[diff] [blame]

395

<code><pre><tt>def __lldb_init_module(debugger, internal_dict):

Greg Clayton

261c974

2012-01-26 05:36:07 +0000

[diff] [blame]

396

# Command Initialization code goes here

397

</tt></pre></code>

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

398

Enrico Granata

2012-08-08 02:06:30 +0000

[diff] [blame]

399

where debugger and internal_dict are as above, that function will get run when the module is loaded

Greg Clayton

261c974

2012-01-26 05:36:07 +0000

[diff] [blame]

400

allowing you to add whatever commands you want into the current debugger. Note that

401

this function will only be run when using the LLDB comand command script import,

402

it will not get run if anyone imports your module from another module.

403

If you want to always run code when your module is loaded from LLDB

404

or when loaded via an import statement in python code

405

you can test the lldb.debugger object, since you imported the

406

<lldb> module at the top of the python ls.py module. This test

407

must be in code that isn't contained inside of any function or class,

408

just like the standard test for __main__ like all python modules

409

usally do. Sample code would look like:

410

411

<code><pre><tt>if __name__ == '__main__':

412

# Create a new debugger instance in your module if your module

413

# can be run from the command line. When we run a script from

414

# the command line, we won't have any debugger object in

415

# lldb.debugger, so we can just create it if it will be needed

416

lldb.debugger = lldb.SBDebugger.Create()

417

elif lldb.debugger:

418

# Module is being run inside the LLDB interpreter

419

lldb.debugger.HandleCommand('command script add -f ls.ls ls')

420

print 'The "ls" python command has been installed and is ready for use.'

421

</tt></pre></code>

422

Now we can create a module called ls.py in the file ~/ls.py that will implement a function that

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

423

can be used by LLDB's python command code:

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

424

425

<code><pre><tt>#!/usr/bin/python

import lldb

import commands

import optparse

import shlex

Enrico Granata

2012-08-08 02:06:30 +0000

[diff] [blame]

432

def ls(debugger, command, result, internal_dict):

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

433

result.PutCString(commands.getoutput('/bin/ls %s' % command))

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

434

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

435

# And the initialization code to add your commands

Enrico Granata

2012-08-08 02:06:30 +0000

[diff] [blame]

436

def __lldb_init_module(debugger, internal_dict):

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

437

debugger.HandleCommand('command script add -f ls.ls ls')

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

438

print 'The "ls" python command has been installed and is ready for use.'

439

</tt></pre></code>

440

Now we can load the module into LLDB and use it

441

<code><pre><tt>% lldb

Greg Clayton

261c974

2012-01-26 05:36:07 +0000

[diff] [blame]

442

(lldb) command script import ~/ls.py

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

443

The "ls" python command has been installed and is ready for use.

444

(lldb) ls -l /tmp/

445

total 365848

446

-rw-r--r--@ 1 someuser wheel 6148 Jan 19 17:27 .DS_Store

447

-rw------- 1 someuser wheel 7331 Jan 19 15:37 crash.log

448

</tt></pre></code>

449

A template has been created in the source repository that can help you to create

450

lldb command quickly:

451

<a href="http://llvm.org/svn/llvm-project/lldb/trunk/examples/python/cmdtemplate.py">cmdtemplate.py</a>

Enrico Granata

74566c9

2012-08-24 21:20:14 +0000

[diff] [blame]

452

453

A commonly required facility is being able to create a command that does some token substitution, and then runs a different debugger command

454

(usually, it po'es the result of an expression evaluated on its argument). For instance, given the following program:

455

456

#import <Foundation/Foundation.h>

457

NSString*

458

ModifyString(NSString* src)

459

{

460

return [src stringByAppendingString:@"foobar"];

}

int main()

{

NSString* aString = @"Hello world";

466

NSString* anotherString = @"Let's be friends";

return 1;

}

</tt></pre></code>

you may want a pofoo X command, that equates po [ModifyString(X) capitalizedString].

471

The following debugger interaction shows how to achieve that goal:

472

473

(lldb) script

474

Python Interactive Interpreter. To exit, type 'quit()', 'exit()' or Ctrl-D.

475

>>> def pofoo_funct(debugger, command, result, internal_dict):

476

... cmd = "po [ModifyString(" + command + ") capitalizedString]"

477

... lldb.debugger.HandleCommand(cmd)

478

...

479

>>> ^D

480

(lldb) command script add pofoo -f pofoo_funct

481

(lldb) pofoo aString

482

$1 = 0x000000010010aa00 Hello Worldfoobar

483

(lldb) pofoo anotherString

484

$2 = 0x000000010010aba0 Let's Be Friendsfoobar</tt></pre></code>

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

485

</div>

486

487

<h1 class ="postheader">Using the lldb.py module in python</h1>

488

489

490

LLDB has all of its core code build into a shared library which gets

491

used by the lldb command line application. On Mac OS X this

492

shared library is a framework: LLDB.framework and on other

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

493

unix variants the program is a shared library: lldb.so. LLDB also

494

provides an lldb.py module that contains the bindings from LLDB into Python.

495

To use the

496

LLDB.framework to create your own stand-alone python programs, you will

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

497

need to tell python where to look in order to find this module. This

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

498

is done by setting the PYTHONPATH environment variable, adding

499

a path to the directory that contains the lldb.py python module. On

500

Mac OS X, this is contained inside the LLDB.framework, so you would do:

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

501

502

For csh and tcsh:

503

<code>% setenv PYTHONPATH /Developer/Library/PrivateFrameworks/LLDB.framework/Resources/Python</code>

504

For sh and bash:

505

<code>% export PYTHONPATH=/Developer/Library/PrivateFrameworks/LLDB.framework/Resources/Python</code>

506

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

507

Alternately, you can append the LLDB Python directory to the sys.path list directly in

508

your Python code before importing the lldb module.

509

Greg Clayton

2012-01-22 02:55:08 +0000

[diff] [blame]

510

511

Now your python scripts are ready to import the lldb module. Below is a

512

python script that will launch a program from the current working directory

513

called "a.out", set a breakpoint at "main", and then run and hit the breakpoint,

514

and print the process, thread and frame objects if the process stopped:

515

516

517

<code><pre><tt>#!/usr/bin/python

import lldb

# Set the path to the executable to debug

522

exe = "./a.out"

523

524

# Create a new debugger instance

525

debugger = lldb.SBDebugger.Create()

526

527

# When we step or continue, don't return from the function until the process

Jim Ingham

2012-01-24 02:40:42 +0000

[diff] [blame]

528

# stops. Otherwise we would have to handle the process events ourselves which, while doable is

529

#a little tricky. We do this by setting the async mode to false.

Greg Clayton