binaryninja-api/python/basicblock.py at dev · Vector35/binaryninja-api · GitHub

History

820 lines (700 loc) · 31.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

# Permission is hereby granted, free of charge, to any person obtaining a copy

# of this software and associated documentation files (the "Software"), to

# deal in the Software without restriction, including without limitation the

# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

# sell copies of the Software, and to permit persons to whom the Software is

# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in

# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS

# IN THE SOFTWARE.

import ctypes

from dataclasses import dataclass

from typing import Generator, Optional, List, Tuple, Union

# Binary Ninja components

import binaryninja

from . import _binaryninjacore as core

from .enums import BranchType, HighlightStandardColor

from . import binaryview

from . import architecture

from . import highlight as _highlight

from . import function as _function

@dataclass(frozen=True)

class BasicBlockEdge:

"""

``class BasicBlockEdge`` represents the edges that connect basic blocks in graph view.

:cvar type: The :py:meth:`enums.BranchType` of the edge; Whether the edge is a true branch, false branch, unconditional, etc.

:cvar source: The basic block that the edge originates from.

:cvar target: The basic block that the edge is going to.

:cvar backedge: Whether this edge targets to a node whose control flow can eventually flow back through the source node of this edge.

:Example:

>>> current_basic_block.outgoing_edges

[<TrueBranch: x86_64@0x6>, <FalseBranch: x86_64@0x1f>]

"""

type: BranchType

source: 'BasicBlock'

target: 'BasicBlock'

back_edge: bool

fall_through: bool

def __repr__(self):

if self.type == BranchType.UnresolvedBranch:

return f"<{self.type.name}>"

elif self.target.arch:

return f"<{self.type.name}: {self.target.arch.name}@{self.target.start:#x}>"

else:

return f"<{self.type.name}: {self.target.start:#x}>"

@dataclass(frozen=True)

class PendingBasicBlockEdge:

"""

``class PendingBasicBlockEdge`` represents a pending edge that has not yet been resolved.

:cvar type: The edge branch type.

:cvar arch: The architecture of the target basic block.

:cvar target: The address of the target basic block.

:cvar fall_through: Whether this edge is a fallthrough edge.

"""

type: BranchType

arch: 'architecture.Architecture'

target: int

fallthrough: bool

class BasicBlock:

"""

The ``class BasicBlock`` object is returned during analysis and should not be directly instantiated.

Basic blocks contain a sequence of instructions that must execute in-order with no branches.

We include calls in basic blocks, which technically violates that assumption, but you can mark

functions as `func.can_return = False` if a given function should terminate basic blocks.

:Example:

>>> for func in bv.functions:

>>> for bb in func:

>>> # Any block-based analysis could start here

>>> for inst in bb:

>>> pass # Optionally do something here with instructions

"""

def __init__(self, handle: core.BNBasicBlockHandle, view: Optional['binaryview.BinaryView'] = None):

self._view = view

_handle = core.BNBasicBlockHandle

self.handle: core.BNBasicBlockHandle = ctypes.cast(handle, _handle)

self._arch = None

self._func = None

self._instStarts: Optional[List[int]] = None

self._instLengths: Optional[List[int]] = None

def __del__(self):

if core is not None:

core.BNFreeBasicBlock(self.handle)

@classmethod

def _from_core_block(cls, block: core.BNBasicBlockHandle) -> Optional[Union['BasicBlock', 'binaryninja.lowlevelil.LowLevelILBasicBlock', 'binaryninja.mediumlevelil.MediumLevelILBasicBlock', 'binaryninja.highlevelil.HighLevelILBasicBlock']]:

"""From a BNBasicBlockHandle, get a BasicBlock or one of the IL subclasses (takes ref)"""

func_handle = core.BNGetBasicBlockFunction(block)

if not func_handle:

core.BNFreeBasicBlock(block)

return None

view = binaryview.BinaryView(handle=core.BNGetFunctionData(func_handle))

func = _function.Function(view, func_handle)

if core.BNIsLowLevelILBasicBlock(block):

return binaryninja.lowlevelil.LowLevelILBasicBlock(

block, binaryninja.lowlevelil.LowLevelILFunction(func.arch, core.BNGetBasicBlockLowLevelILFunction(block), func),

view

)

elif core.BNIsMediumLevelILBasicBlock(block):

mlil_func = binaryninja.mediumlevelil.MediumLevelILFunction(

func.arch, core.BNGetBasicBlockMediumLevelILFunction(block), func

)

return binaryninja.mediumlevelil.MediumLevelILBasicBlock(block, mlil_func, view)

elif core.BNIsHighLevelILBasicBlock(block):

hlil_func = binaryninja.highlevelil.HighLevelILFunction(func.arch, core.BNGetBasicBlockHighLevelILFunction(block), func)

return binaryninja.highlevelil.HighLevelILBasicBlock(block, hlil_func, view)

else:

return BasicBlock(block, view)

def __repr__(self):

arch = self.arch

if self.is_il:

# IL indices are shown as decimal

if arch:

return f"<{self.__class__.__name__}: {arch.name}@{self.start}-{self.end}>"

else:

return f"<{self.__class__.__name__}: {self.start}-{self.end}>"

else:

if arch:

return f"<{self.__class__.__name__}: {arch.name}@{self.start:#x}-{self.end:#x}>"

else:

return f"<{self.__class__.__name__}: {self.start:#x}-{self.end:#x}>"

def __len__(self):

return int(core.BNGetBasicBlockLength(self.handle))

def __lt__(self, other: 'BasicBlock') -> bool:

if not isinstance(other, self.__class__):

return NotImplemented

return self.start < other.start

def __gt__(self, other: 'BasicBlock') -> bool:

if not isinstance(other, self.__class__):

return NotImplemented

return self.start > other.start

def __le__(self, other: 'BasicBlock') -> bool:

if not isinstance(other, self.__class__):

return NotImplemented

return self.start <= other.start

def __ge__(self, other: 'BasicBlock') -> bool:

if not isinstance(other, self.__class__):

return NotImplemented

return self.start >= other.start

def __eq__(self, other):

if not isinstance(other, self.__class__):

return NotImplemented

return ctypes.addressof(self.handle.contents) == ctypes.addressof(other.handle.contents)

def __ne__(self, other):

if not isinstance(other, self.__class__):

return NotImplemented

return not (self == other)

def __hash__(self):

return hash((self.start, self.end, self.arch))

def __iter__(self) -> Generator[Tuple[List['_function.InstructionTextToken'], int], None, None]:

if self.view is None:

raise Exception("Attempting to iterate a Basic Block with no BinaryView")

if self._instStarts is None:

# don't add instruction start cache--the object is likely ephemeral

idx = self.start

while idx < self.end:

data = self.view.read(idx, min(self.arch.max_instr_length, self.end - idx))

result = self.arch.get_instruction_text(data, idx)

assert result is not None

text, size = result

if size == 0:

break

yield text, size

idx += size

else:

assert self._instLengths is not None

for start, length in zip(self._instStarts, self._instLengths):

result = self.arch.get_instruction_text(self.view.read(start, length), start)

assert result is not None

text, size = result

if size == 0:

break

yield text, size

def __getitem__(self, i):

self._buildStartCache()

assert self._instStarts is not None

assert self._instLengths is not None

if self.view is None:

raise Exception("Attempting to iterate a Basic Block with no BinaryView")

if isinstance(i, slice):

return [self[index] for index in range(*i.indices(len(self._instStarts)))]

start = self._instStarts[i]

length = self._instLengths[i]

data = self.view.read(start, length)

return self.arch.get_instruction_text(data, start)

def __contains__(self, i: int):

return self.start <= i < self.end

def _buildStartCache(self) -> None:

if self._instStarts is None:

# build the instruction start cache

if self.view is None:

raise Exception("Attempting to buildStartCache when BinaryView for BasicBlock is None")

self._instStarts = []

self._instLengths = []

start = self.start

while start < self.end:

length = self.view.get_instruction_length(start, self.arch)

if length == 0: # invalid instruction. avoid infinite loop

break

self._instLengths.append(length)

self._instStarts.append(start)

start += length

def _create_instance(self, handle: core.BNBasicBlockHandle) -> 'BasicBlock':

"""Internal method used to instantiate child instances"""

return BasicBlock(handle, self.view)

@property

def instruction_count(self) -> int:

self._buildStartCache()

assert self._instStarts is not None

return len(self._instStarts)

@property

def function(self) -> Optional['_function.Function']:

"""Basic block function (read-only)"""

if self._func is not None:

return self._func

func = core.BNGetBasicBlockFunction(self.handle)

if func is None:

return None

self._func = _function.Function(self._view, func)

return self._func

@property

def il_function(self) -> Optional['_function.ILFunctionType']:

"""IL Function of which this block is a part, if the block is part of an IL Function."""

func = self.function

if func is None:

return None

il_type = self.function_graph_type

if il_type == _function.FunctionGraphType.NormalFunctionGraph:

return None

elif il_type == _function.FunctionGraphType.LowLevelILFunctionGraph:

return func.low_level_il

elif il_type == _function.FunctionGraphType.LiftedILFunctionGraph:

return func.lifted_il

elif il_type == _function.FunctionGraphType.LowLevelILSSAFormFunctionGraph:

func_llil = func.low_level_il

return func_llil.ssa_form if func_llil is not None else None

elif il_type == _function.FunctionGraphType.MediumLevelILFunctionGraph:

return func.medium_level_il

elif il_type == _function.FunctionGraphType.MediumLevelILSSAFormFunctionGraph:

func_mlil = func.medium_level_il

return func_mlil.ssa_form if func_mlil is not None else None

elif il_type == _function.FunctionGraphType.MappedMediumLevelILFunctionGraph:

return func.mapped_medium_level_il

elif il_type == _function.FunctionGraphType.MappedMediumLevelILSSAFormFunctionGraph:

func_mmlil = func.mapped_medium_level_il

return func_mmlil.ssa_form if func_mmlil is not None else None

elif il_type == _function.FunctionGraphType.HighLevelILFunctionGraph:

return func.high_level_il

elif il_type == _function.FunctionGraphType.HighLevelILSSAFormFunctionGraph:

func_hlil = func.high_level_il

return func_hlil.ssa_form if func_hlil is not None else None

elif il_type == _function.FunctionGraphType.HighLevelLanguageRepresentationFunctionGraph:

return func.high_level_il

else:

return None

@property

def il_function_if_available(self) -> Optional['_function.ILFunctionType']:

"""IL Function of which this block is a part, if the block is part of an IL Function, and if the function has generated IL already."""

func = self.function

if func is None:

return None

il_type = self.function_graph_type

if il_type == _function.FunctionGraphType.NormalFunctionGraph:

return None

elif il_type == _function.FunctionGraphType.LowLevelILFunctionGraph:

return func.llil_if_available

elif il_type == _function.FunctionGraphType.LiftedILFunctionGraph:

return func.lifted_il_if_available

elif il_type == _function.FunctionGraphType.LowLevelILSSAFormFunctionGraph:

if func.llil_if_available is None:

return None

return func.llil_if_available.ssa_form

elif il_type == _function.FunctionGraphType.MediumLevelILFunctionGraph:

return func.mlil_if_available

elif il_type == _function.FunctionGraphType.MediumLevelILSSAFormFunctionGraph:

if func.mlil_if_available is None:

return None

return func.mlil_if_available.ssa_form

elif il_type == _function.FunctionGraphType.MappedMediumLevelILFunctionGraph:

return func.mmlil_if_available

elif il_type == _function.FunctionGraphType.MappedMediumLevelILSSAFormFunctionGraph:

if func.mmlil_if_available is None:

return None

return func.mmlil_if_available.ssa_form

elif il_type == _function.FunctionGraphType.HighLevelILFunctionGraph:

return func.hlil_if_available

elif il_type == _function.FunctionGraphType.HighLevelILSSAFormFunctionGraph:

if func.hlil_if_available is None:

return None

return func.hlil_if_available.ssa_form

elif il_type == _function.FunctionGraphType.HighLevelLanguageRepresentationFunctionGraph:

return func.hlil_if_available

else:

return None

@property

def view(self) -> Optional['binaryview.BinaryView']:

"""BinaryView that contains the basic block (read-only)"""

if self._view is not None:

return self._view

if self.function is None:

return None

self._view = self.function.view

return self._view

@property

def arch(self) -> 'architecture.Architecture':

"""Basic block architecture (read-only)"""

# The arch for a BasicBlock isn't going to change so just cache

# it the first time we need it

if self._arch is not None:

return self._arch

arch = core.BNGetBasicBlockArchitecture(self.handle)

assert arch is not None, "core.BNGetBasicBlockArchitecture returned None"

self._arch = architecture.CoreArchitecture._from_cache(arch)

return self._arch

@property

def source_block(self) -> Optional['BasicBlock']:

"""The corresponding assembly-level basic block for this basic block (read-only)"""

block = core.BNGetBasicBlockSource(self.handle)

if block is None:

return None

return BasicBlock(block, self._view)

@property

def start(self) -> int:

"""Basic block start (read-only)"""

return core.BNGetBasicBlockStart(self.handle)

@property

def end(self) -> int:

"""Basic block end (read-only)"""

return core.BNGetBasicBlockEnd(self.handle)

@end.setter

def end(self, value: int) -> None:

"""Sets the end of the basic block

.. note:: This setter is intended for use by architecture plugins only.

"""

core.BNSetBasicBlockEnd(self.handle, value)

@property

def length(self) -> int:

"""Basic block length (read-only)"""

return core.BNGetBasicBlockLength(self.handle)

@property

def index(self) -> int:

"""Basic block index in list of blocks for the function (read-only)"""

return core.BNGetBasicBlockIndex(self.handle)

def _make_edges(self, edges, count: int, direction: bool) -> List[BasicBlockEdge]:

assert edges is not None, "Got empty edges list from core"

if self.view is None:

raise ValueError("Attempting to get BasicBlock edges when BinaryView is None")

result: List[BasicBlockEdge] = []

try:

for i in range(0, count):

branch_type = BranchType(edges[i].type)

handle = core.BNNewBasicBlockReference(edges[i].target)

assert handle is not None

target = self._create_instance(handle)

if direction:

sink, source = target, self

else:

sink, source = self, target

result.append(BasicBlockEdge(branch_type, sink, source, edges[i].backEdge, edges[i].fallThrough))

return result

finally:

core.BNFreeBasicBlockEdgeList(edges, count)

@property

def outgoing_edges(self) -> List[BasicBlockEdge]:

"""List of basic block outgoing edges (read-only)"""

count = ctypes.c_ulonglong(0)

return self._make_edges(core.BNGetBasicBlockOutgoingEdges(self.handle, count), count.value, False)

@property

def incoming_edges(self) -> List[BasicBlockEdge]:

"""List of basic block incoming edges (read-only)"""

count = ctypes.c_ulonglong(0)

return self._make_edges(core.BNGetBasicBlockIncomingEdges(self.handle, count), count.value, True)

@property

def has_undetermined_outgoing_edges(self) -> bool:

"""Whether basic block has undetermined outgoing edges (read-only)"""

return core.BNBasicBlockHasUndeterminedOutgoingEdges(self.handle)

@has_undetermined_outgoing_edges.setter

def has_undetermined_outgoing_edges(self, value: bool) -> None:

"""Sets whether basic block has undetermined outgoing edges"""

core.BNBasicBlockSetUndeterminedOutgoingEdges(self.handle, value)

@property

def can_exit(self) -> bool:

"""Whether basic block can return or is tagged as 'No Return' (read-only)"""

return core.BNBasicBlockCanExit(self.handle)

@can_exit.setter

def can_exit(self, value: bool) -> None:

"""Sets whether basic block can return or is tagged as 'No Return'"""

core.BNBasicBlockSetCanExit(self.handle, value)

@property

def has_invalid_instructions(self) -> bool:

"""Whether basic block has any invalid instructions (read-only)"""

return core.BNBasicBlockHasInvalidInstructions(self.handle)

@has_invalid_instructions.setter

def has_invalid_instructions(self, value: bool) -> None:

"""Sets whether basic block has any invalid instructions"""

core.BNBasicBlockSetHasInvalidInstructions(self.handle, value)

def add_pending_outgoing_edge(self, typ: BranchType, addr: int, arch: 'architecture.Architecture', fallthrough: bool = False) -> None:

"""

Adds a pending outgoing edge to the basic block. This is used to add edges that are not yet resolved.

.. note:: This method is intended for use by architecture plugins only.

:param BranchType typ: The type of the branch.

:param int addr: The address of the target basic block.

:param Architecture arch: The architecture of the target basic block.

:param bool fallthrough: Whether this edge is a fallthrough edge.

"""

core.BNBasicBlockAddPendingOutgoingEdge(self.handle, typ.value, addr, arch.handle, fallthrough)

def get_pending_outgoing_edges(self) -> list[PendingBasicBlockEdge]:

"""

Returns a list of pending outgoing edges for the basic block. These are edges that have not yet been resolved.

.. note:: This method is intended for use by architecture plugins only.

:return: List of PendingBasicBlockEdge objects.

"""

count = ctypes.c_ulonglong(0)

pending_edges = core.BNGetBasicBlockPendingOutgoingEdges(self.handle, ctypes.byref(count))

if pending_edges is None:

return []

result: List[PendingBasicBlockEdge] = []

try:

for i in range(count.value):

result.append(PendingBasicBlockEdge(

type=BranchType(pending_edges[i].type),

arch=architecture.CoreArchitecture._from_cache(pending_edges[i].arch),

target=pending_edges[i].target,

fallthrough=pending_edges[i].fallThrough

))

return result

finally:

core.BNFreePendingBasicBlockEdgeList(pending_edges)

def clear_pending_outgoing_edges(self) -> None:

"""

Clears all pending outgoing edges for the basic block. This is used to remove edges that have not yet been resolved.

.. note:: This method is intended for use by architecture plugins only.

"""

core.BNClearBasicBlockPendingOutgoingEdges(self.handle)

@property

def fallthrough_to_function(self) -> bool:

"""Whether the basic block has a fallthrough edge to a function."""

return core.BNBasicBlockIsFallThroughToFunction(self.handle)

@fallthrough_to_function.setter

def fallthrough_to_function(self, value: bool) -> None:

"""Sets whether the basic block has a fallthrough edge to a function.

.. note:: This setter is intended for use by architecture plugins only.

"""

if not isinstance(value, bool):

raise TypeError("value must be of type bool")

core.BNBasicBlockSetFallThroughToFunction(self.handle, value)

def _make_blocks(self, blocks, count: int) -> List['BasicBlock']:

assert blocks is not None, "core returned empty block list"

try:

result: List['BasicBlock'] = []

for i in range(0, count):

handle = core.BNNewBasicBlockReference(blocks[i])

assert handle is not None

result.append(self._create_instance(handle))

return result

finally:

core.BNFreeBasicBlockList(blocks, count)

@property

def dominators(self) -> List['BasicBlock']:

"""

List of dominators for this basic block (read-only).

A dominator of a basic block B is a block that must be executed before B can be executed.

In other words, every path from the entry block to B must go through the dominator.

This includes B itself - every block dominates itself. See

:py:func:`BasicBlock.strict_dominators` for dominators that don't include B.

"""

count = ctypes.c_ulonglong()

blocks = core.BNGetBasicBlockDominators(self.handle, count, False)

return self._make_blocks(blocks, count.value)

@property

def post_dominators(self) -> List['BasicBlock']:

"""

List of post-dominators for this basic block (read-only)

A post-dominator of a basic block B is a block that must be executed after B is executed.

In other words, every path from B to an exit block must go through the post-dominator.

This includes B itself - every block post-dominates itself. See

:py:func:`BasicBlock.strict_post_dominators` for post-dominators that don't include B.

If B has outgoing edges that can lead to different exit blocks, then this will only include B.

"""

count = ctypes.c_ulonglong()

blocks = core.BNGetBasicBlockDominators(self.handle, count, True)

return self._make_blocks(blocks, count.value)

@property

def strict_dominators(self) -> List['BasicBlock']:

"""

List of strict dominators for this basic block (read-only)

A strict dominator of a basic block B is a dominator of B that is not B itself.

See :py:func:`BasicBlock.dominators` for the definition of a dominator.

"""

count = ctypes.c_ulonglong()

blocks = core.BNGetBasicBlockStrictDominators(self.handle, count, False)

return self._make_blocks(blocks, count.value)

@property

def strict_post_dominators(self) -> List['BasicBlock']:

"""

List of strict post-dominators for this basic block (read-only)

A strict post-dominator of a basic block B is a post-dominator of B that is not B itself.

See :py:func:`BasicBlock.post_dominators` for the definition of a post-dominator.

"""

count = ctypes.c_ulonglong()

blocks = core.BNGetBasicBlockStrictDominators(self.handle, count, True)

return self._make_blocks(blocks, count.value)

@property

def immediate_dominator(self) -> Optional['BasicBlock']:

"""

Immediate dominator of this basic block (read-only)

The immediate dominator of a basic block B is the dominator closest to B in the control flow graph.

In other words, among all dominators of B, it is the dominator that doesn't dominate any other

dominator of B except itself. Each basic block except the entry block has a unique immediate dominator.

"""

result = core.BNGetBasicBlockImmediateDominator(self.handle, False)

if not result:

return None

return self._create_instance(result)

@property

def immediate_post_dominator(self) -> Optional['BasicBlock']:

"""

Immediate post-dominator of this basic block (read-only)

The immediate post-dominator of a basic block B is the post-dominator closest to B in the control flow graph.

In other words, among all post-dominators of B, it is the post-dominator that doesn't post-dominate any other

post-dominator of B except itself.

If B has outgoing edges that can lead to different exit blocks, then this will not exist.

"""

result = core.BNGetBasicBlockImmediateDominator(self.handle, True)

if not result:

return None

return self._create_instance(result)

@property

def dominator_tree_children(self) -> List['BasicBlock']:

"""

List of child blocks in the dominator tree for this basic block (read-only)

The dominator tree children of a basic block B are the blocks dominated by B.

See :py:func:`BasicBlock.dominators` for the definition of a dominator.

"""

count = ctypes.c_ulonglong()

blocks = core.BNGetBasicBlockDominatorTreeChildren(self.handle, count, False)

return self._make_blocks(blocks, count.value)

@property

def post_dominator_tree_children(self) -> List['BasicBlock']:

"""

List of child blocks in the post-dominator tree for this basic block (read-only)

The post-dominator tree children of a basic block B are the blocks post-dominated by B.

See :py:func:`BasicBlock.post_dominators` for the definition of a post-dominator.

"""

count = ctypes.c_ulonglong()

blocks = core.BNGetBasicBlockDominatorTreeChildren(self.handle, count, True)

return self._make_blocks(blocks, count.value)

@property

def dominance_frontier(self) -> List['BasicBlock']:

"""

Dominance frontier for this basic block (read-only)

The dominance frontier of a basic block B is the set of blocks that are not strictly dominated by B,

but are immediately control-dependent on B. In other words, it contains the blocks where B's dominance

"stops" - the blocks that have at least one predecessor not dominated by B, while having another

predecessor that is dominated by B.

"""

count = ctypes.c_ulonglong()

blocks = core.BNGetBasicBlockDominanceFrontier(self.handle, count, False)

return self._make_blocks(blocks, count.value)

@property

def post_dominance_frontier(self) -> List['BasicBlock']:

"""

Post-dominance frontier for this basic block (read-only)

The post-dominance frontier of a basic block B is the set of blocks that are not strictly post-dominated

by B, but have at least one successor that is post-dominated by B. In other words, it contains the blocks

where B's post-dominance "stops" - the blocks that have at least one successor not post-dominated by B,

while having another successor that is post-dominated by B.

"""

count = ctypes.c_ulonglong()

blocks = core.BNGetBasicBlockDominanceFrontier(self.handle, count, True)

return self._make_blocks(blocks, count.value)

@property

def annotations(self) -> List[List['_function.InstructionTextToken']]:

"""List of automatic annotations for the start of this block (read-only)"""

if self.function is None:

raise ValueError("Attempting to call BasicBlock.annotations when Function is None")

return self.function.get_block_annotations(self.start, self.arch)

@property

def sort_hint(self) -> Optional[int]:

"""Graph edge sorting hint for this block (read-only)"""

if self.function is None:

raise ValueError("Attempting to call BasicBlock.sort_hint when Function is None")

return self.function.get_block_sort_hint(self.start, self.arch)

@property

def disassembly_text(self) -> List['_function.DisassemblyTextLine']:

"""

``disassembly_text`` property which returns a list of function.DisassemblyTextLine objects for the current basic block.

:Example:

>>> current_basic_block.disassembly_text

[<0x100000f30: _main:>, ...]

"""

return self.get_disassembly_text()

@property

def highlight(self) -> '_highlight.HighlightColor':

"""Gets or sets the highlight color for basic block

:Example:

>>> current_basic_block.highlight = HighlightStandardColor.BlueHighlightColor

>>> current_basic_block.highlight

<color: blue>

"""

return _highlight.HighlightColor._from_core_struct(core.BNGetBasicBlockHighlight(self.handle))

@highlight.setter

def highlight(self, value: '_highlight.HighlightColor') -> None:

self.set_user_highlight(value)

@property

def function_graph_type(self) -> '_function.FunctionGraphType':

"""Type of function graph from which this block represents instructions"""

return _function.FunctionGraphType(core.BNGetBasicBlockFunctionGraphType(self.handle))

@property

def is_il(self) -> bool:

"""Whether the basic block contains IL"""

return core.BNIsILBasicBlock(self.handle)

@property

def is_low_level_il(self) -> bool:

"""Whether the basic block contains Low Level IL"""

return core.BNIsLowLevelILBasicBlock(self.handle)

@property

def is_medium_level_il(self) -> bool:

"""Whether the basic block contains Medium Level IL"""

return core.BNIsMediumLevelILBasicBlock(self.handle)

@property

def is_high_level_il(self) -> bool:

"""Whether the basic block contains High Level IL"""

return core.BNIsHighLevelILBasicBlock(self.handle)

def get_iterated_dominance_frontier(self, blocks: List['BasicBlock']) -> List['BasicBlock']:

"""Calculates the iterated dominance frontier of the given blocks (this is used to determine φ node placement)"""

if len(blocks) == 0:

return []

block_set = (ctypes.POINTER(core.BNBasicBlock) * len(blocks))() # type: ignore

for i in range(len(blocks)):

block_set[i] = blocks[i].handle

count = ctypes.c_ulonglong()

out_blocks = core.BNGetBasicBlockIteratedDominanceFrontier(block_set, len(blocks), count)

return self._make_blocks(out_blocks, count.value)

def mark_recent_use(self) -> None:

core.BNMarkBasicBlockAsRecentlyUsed(self.handle)

def get_disassembly_text(self,

settings: Optional['_function.DisassemblySettings'] = None) -> List['_function.DisassemblyTextLine']:

"""

``get_disassembly_text`` returns a list of DisassemblyTextLine objects for the current basic block.

:param DisassemblySettings settings: (optional) DisassemblySettings object

:Example:

>>> current_basic_block.get_disassembly_text()

[<0x100000f30: _main:>, <0x100000f30: push rbp>, ... ]

"""

settings_obj = None

if settings:

settings_obj = settings.handle

count = ctypes.c_ulonglong()

lines = core.BNGetBasicBlockDisassemblyText(self.handle, settings_obj, count)

assert lines is not None, "core.BNGetBasicBlockDisassemblyText returned None"

result = []

try:

for i in range(0, count.value):

addr = lines[i].addr

if (lines[i].instrIndex != 0xffffffffffffffff) and hasattr(self, 'il_function'):

il_instr = self.il_function[lines[i].instrIndex] # type: ignore

else:

il_instr = None

color = _highlight.HighlightColor._from_core_struct(lines[i].highlight)

tokens = _function.InstructionTextToken._from_core_struct(lines[i].tokens, lines[i].count)

result.append(_function.DisassemblyTextLine(tokens, addr, il_instr, color))

return result

finally:

core.BNFreeDisassemblyTextLines(lines, count.value)

def set_auto_highlight(self, color: '_highlight.HighlightColor') -> None:

"""

``set_auto_highlight`` highlights the current BasicBlock with the supplied color.

.. warning:: Use only in analysis plugins. Do not use in regular plugins, as colors won't be saved to the database.

:param HighlightStandardColor or HighlightColor color: Color value to use for highlighting

"""

if not isinstance(color, HighlightStandardColor) and not isinstance(color, _highlight.HighlightColor):

raise ValueError("Specified color is not one of HighlightStandardColor, HighlightColor")

if isinstance(color, HighlightStandardColor):

color = _highlight.HighlightColor(color)

core.BNSetAutoBasicBlockHighlight(self.handle, color._to_core_struct())

def set_user_highlight(self, color: '_highlight.HighlightColor') -> None:

"""

``set_user_highlight`` highlights the current BasicBlock with the supplied color

:param HighlightStandardColor or HighlightColor color: Color value to use for highlighting

:Example:

>>> current_basic_block.set_user_highlight(_highlight.HighlightColor(red=0xff, blue=0xff, green=0))

>>> current_basic_block.set_user_highlight(HighlightStandardColor.BlueHighlightColor)

"""

if not isinstance(color, HighlightStandardColor) and not isinstance(color, _highlight.HighlightColor):

raise ValueError("Specified color is not one of HighlightStandardColor, HighlightColor")

if isinstance(color, HighlightStandardColor):

color = _highlight.HighlightColor(color)

core.BNSetUserBasicBlockHighlight(self.handle, color._to_core_struct())

def get_instruction_containing_address(self, addr: int) -> Tuple[bool, int]:

start = ctypes.c_uint64()

ret: bool = core.BNGetBasicBlockInstructionContainingAddress(self.handle, addr, start)

return ret, start.value

binaryninja-api/python/basicblock.py at dev · Vector35/binaryninja-api · GitHub

Uh oh!

Expand file tree

Breadcrumbs

basicblock.py

Latest commit

History

Breadcrumbs

basicblock.py

File metadata and controls