The gtirb Reference Manual

Table of Contents

The gtirb Reference Manual

This is the gtirb Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:12:05 2020 GMT+0.

1 Introduction

Common Lisp library for GTIRB

The Common Lisp API for GrammaTech's IR for Binaries (GTIRB). GTIRB is a data structure designed to support the analysis and rewriting of binary executables. There are a number of tools that produce, process and consume GTIRB. See the following for more information on GTIRB:

• https://github.com/grammatech/gtirb the main GTIRB source repository.
• https://grammatech.github.io/gtirb/ the GTIRB manual repository.
• https://arxiv.org/abs/1907.02859 a white-paper describing the design goals of GTIRB.
• https://github.com/grammatech/ddisasm a very high performance reassembleable disassembler producing GTIRB.
• https://github.com/grammatech/gtirb-pprinter a pretty printer from GTIRB to assembler.

Requirements and Installation

Hopefully, eventually, it will be possible to install everything by (1) installing Protobuf, version 3.7.0 or later, and then (2) installing this Common Lisp GTIRB library with QuickLisp (ql:quickload :gtirb).

We're a ways away from that currently. So after you've installed Protobuf, you should clone and install the Common Lisp PROTOBUF package manually according to the instructions at https://github.com/brown/protobuf ensuring that the protoc-gen-lisp executable has been built and is on your path. At that point you should be able to load the GTIRB package.

Usage

The Common Lisp API attempts to provide access to the underlying GTIRB data-structure described above in idiomatic common lisp. The main Protobuf data structures are wrapped in CLOS objects. All fields are modifiable with setf. Invariant are maintained automatically by the API, e.g. using :around methods.

In some cases accessors are provided beyond the fields directly present in the Protobuf. For example, every GTIRB element has a UUID (which supports referencing elements from AuxData tables). The Common Lisp API provides uniform access to any element through the get-uuid method which operates similarly to gethash only it may be called on any top-level GTIRB IR object (which itself maintains a hash of every contained element by UUID).

The GTIRB CFG is represented as a graph using the Common Lisp graph library from https://github.com/eschulte/graph. This simple representation should promote easy exploration and modification of the control flow graph, and the many graph analysis functions defined in that library may be directly applied to the CFG. Every node of the graph holds the UUID for a code block.

The bytes of any code and data block may be accessed by calling the bytes method, which provides directly access to the bytes of the block's byte-interval.

Example Usage

See the test suite for a large number of basic usage examples. However, the following gives a simple usage example.

1. From the command-line. Use the datalog disassembler ddisasm to disassemble the ls executable into a GTIRB instance.

   ddisasm --ir $(which ls) /tmp/ls.gtirb
   

2. From the Common Lisp REPL. Load the GTIRB API, and then load the GTIRB instance created in step (1) into a common lisp GTIRB object.

   (ql:quickload :gtirb)
   (use-package :gtirb)
   (defparameter ls (read-gtirb "/tmp/ls.gtirb"))
   

3. At this point you can explore the CFG, perform analyses, or even modify the contents of the GTIRB object. Results of analyses may be saved into new AuxData tables which become part of the GTIRB object for later use by other sessions or by other tools potentially written in other languages.

   ;; Do stuff with the GTIRB, maybe make changes.
   

4. Finally, the resulting GTIRB object may be written back to the file system.

   (write-gtirb ls "/tmp/ls-modified.gtirb")
   

5. At the command line. A new executable may be created from the modified gtirb file using the gtirb-pprinter.

   gtirb-pprinter --ir /tmp/ls-modified.gtirb --binary /tmp/ls-modified
   

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 gtirb

Author

GrammaTech

License

MIT

Description

Common Lisp library for GTIRB

Long Description

A Common Lisp front end to the GrammaTech
Intermediate Representation for Bianries (GTIRB). GTIRB is serialized using Google’s protocol buffers. This library wraps the raw protocol buffer serialization with a more Lispy interface.

Defsystem Dependency

asdf-package-system

Dependency

gtirb/gtirb (system)

Source

gtirb.asd (file)

2.2 gtirb/gtirb

Author

GrammaTech

License

MIT

Dependencies

• alexandria
• graph
• trivia
• trivial-utf-8
• gtirb/ranged (system)
• gtirb/utility (system)
• named-readtables
• curry-compose-reader-macros
• proto (system)
• trivial-package-local-nicknames
• cl-intbytes

Source

gtirb.asd (file)

Component

lisp.lisp (file)

2.3 gtirb/ranged

Author

GrammaTech

License

MIT

Dependency

cl-interval

Source

gtirb.asd (file)

Component

lisp.lisp (file)

2.4 gtirb/utility

Author

GrammaTech

License

MIT

Dependencies

• protobuf
• cl-intbytes
• alexandria

Source

gtirb.asd (file)

Component

lisp.lisp (file)

2.5 proto

Author

GrammaTech

License

MIT

Description

Common Lisp interface to GTIRB protobuf files

Dependency

protobuf

Source

gtirb.asd (file)

Components

• readme.md (file)
• proto (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 proto/proto

Parent

proto (system)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/

Components

• auxdata.lisp (file)
• byteinterval.lisp (file)
• cfg.lisp (file)
• codeblock.lisp (file)
• datablock.lisp (file)
• ir.lisp (file)
• module.lisp (file)
• proxyblock.lisp (file)
• section.lisp (file)
• symbol.lisp (file)
• symbolicexpression.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 gtirb.asd

Location

gtirb.asd

Systems

• gtirb (system)
• gtirb/gtirb (system)
• gtirb/ranged (system)
• gtirb/utility (system)
• proto (system)

4.1.2 gtirb/gtirb/lisp.lisp

Parent

gtirb/gtirb (system)

Location

gtirb.lisp

Packages

gtirb/gtirb

Exported Definitions

• *is-equal-p-verbose-p* (special variable)
• address (method)
• address (method)
• (setf address) (method)
• address (method)
• address-range (generic function)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• addressp (method)
• (setf addressp) (method)
• at-address (generic function)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-end (method)
• (setf at-end) (method)
• aux-data (method)
• (setf aux-data) (method)
• aux-data (method)
• (setf aux-data) (method)
• aux-data (class)
• aux-data-data (generic function)
• aux-data-data (method)
• (setf aux-data-data) (method)
• aux-data-type (generic function)
• aux-data-type (method)
• (setf aux-data-type) (method)
• binary-path (method)
• (setf binary-path) (method)
• blocks (method)
• (setf blocks) (method)
• byte-interval (method)
• (setf byte-interval) (method)
• byte-interval (method)
• (setf byte-interval) (method)
• byte-interval (class)
• byte-intervals (method)
• (setf byte-intervals) (method)
• bytes (generic function)
• bytes (method)
• bytes (method)
• (setf bytes) (setf expander)
• cfg (method)
• (setf cfg) (method)
• code-block (class)
• conditional (method)
• (setf conditional) (method)
• contents (method)
• (setf contents) (method)
• data-block (class)
• decode-mode (method)
• (setf decode-mode) (method)
• direct (method)
• (setf direct) (method)
• edge-label (class)
• edge-type (method)
• (setf edge-type) (method)
• entry-point (generic function)
• entry-point (method)
• (setf entry-point) (method)
• file-format (method)
• (setf file-format) (method)
• flags (method)
• (setf flags) (method)
• get-uuid (generic function)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• (setf get-uuid) (generic function)
• gtirb (method)
• (setf gtirb) (method)
• gtirb (class)
• gtirb-block (class)
• gtirb-byte-block (class)
• gtirb-node (class)
• gtirb-version (constant)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• is-equal-p (function)
• isa (method)
• (setf isa) (method)
• module (method)
• (setf module) (method)
• module (method)
• (setf module) (method)
• module (method)
• (setf module) (method)
• module (class)
• modules (method)
• (setf modules) (method)
• name (method)
• (setf name) (method)
• name (method)
• (setf name) (method)
• name (method)
• (setf name) (method)
• offset (method)
• (setf offset) (method)
• offset (method)
• (setf offset) (method)
• offset (method)
• (setf offset) (method)
• offset (method)
• (setf offset) (method)
• offset (method)
• (setf offset) (method)
• on-address (generic function)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• payload (generic function)
• payload (method)
• (setf payload) (method)
• preferred-addr (method)
• (setf preferred-addr) (method)
• protobuf-version (constant)
• proxies (method)
• (setf proxies) (method)
• read-gtirb (generic function)
• read-gtirb (method)
• read-gtirb (method)
• rebase-delta (method)
• (setf rebase-delta) (method)
• remove-uuid (generic function)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• scale (method)
• (setf scale) (method)
• section (method)
• (setf section) (method)
• section (class)
• sections (method)
• (setf sections) (method)
• size (method)
• size (method)
• size (method)
• size (method)
• (setf size) (method)
• (setf size) (method)
• (setf size) (method)
• sym-addr-addr (class)
• sym-addr-const (class)
• sym-stack-const (class)
• symbol (class)
• symbolic-expressions (method)
• symbolic-expressions (method)
• (setf symbolic-expressions) (method)
• symbols (method)
• (setf symbols) (method)
• symbols (method)
• (setf symbols) (method)
• update-proto (generic function)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• uuid (generic function)
• uuid (method)
• value (method)
• (setf value) (method)
• version (method)
• (setf version) (method)
• write-gtirb (function)

Internal Definitions

• *is-equal-p-verbose-output-buffer* (special variable)
• *is-equal-p-verbose-output-length* (special variable)
• +edge-label-type-map+ (constant)
• +module-file-format-map+ (constant)
• +module-isa-map+ (constant)
• +section-flags-map+ (constant)
• aux-data-decode (function)
• aux-data-encode (function)
• aux-data-from-proto (function)
• aux-data-slot-definition (special variable)
• aux-data-to-proto (function)
• aux-data-type-print (function)
• aux-data-type-read (function)
• by-address (method)
• (setf by-address) (method)
• by-uuid (method)
• (setf by-uuid) (method)
• compare-or-verbose (macro)
• decode (function)
• define-proto-backed-class (macro)
• delete-address (generic function)
• delete-address (method)
• encode (function)
• insert-address (generic function)
• insert-address (method)
• is-equal-p-internal (generic function)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• matching (function)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto-backed (class)
• proxy-block (class)
• referent-uuid (method)
• (setf referent-uuid) (method)
• set-parent-uuid (generic function)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• setf-bytes-after (generic function)
• setf-bytes-after (method)
• setf-bytes-after (method)
• shift-subseq (function)
• (setf shift-subseq) (setf expander)
• start-case (macro)
• symbolic-expression (class)
• version.txt (special variable)

4.1.3 gtirb/ranged/lisp.lisp

Parent

gtirb/ranged (system)

Location

ranged.lisp

Packages

gtirb/ranged

Exported Definitions

• make-ranged (function)
• ranged-delete (function)
• ranged-find (function)
• ranged-find-at (function)
• ranged-insert (function)

Internal Definitions

• copy-uuid-interval (function)
• make-uuid-interval (function)
• uuid-interval (structure)
• uuid-interval-end (function)
• (setf uuid-interval-end) (function)
• uuid-interval-p (function)
• uuid-interval-start (function)
• (setf uuid-interval-start) (function)
• uuid-interval-uuid (function)
• (setf uuid-interval-uuid) (function)
• uuid-interval= (function)

4.1.4 gtirb/utility/lisp.lisp

Parent

gtirb/utility (system)

Location

utility.lisp

Packages

gtirb/utility

Exported Definitions

• force-byte-array (function)
• integer-to-uuid (function)
• new-uuid (function)
• read-proto (generic function)
• read-proto (method)
• read-proto (method)
• read-proto (method)
• read-proto (method)
• uuid-to-integer (function)
• write-proto (function)

4.1.5 proto/proto/AuxData.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/AuxData.lisp

4.1.6 proto/proto/ByteInterval.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/ByteInterval.lisp

4.1.7 proto/proto/CFG.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/CFG.lisp

4.1.8 proto/proto/CodeBlock.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/CodeBlock.lisp

4.1.9 proto/proto/DataBlock.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/DataBlock.lisp

4.1.10 proto/proto/IR.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/IR.lisp

4.1.11 proto/proto/Module.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/Module.lisp

4.1.12 proto/proto/ProxyBlock.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/ProxyBlock.lisp

4.1.13 proto/proto/Section.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/Section.lisp

4.1.14 proto/proto/Symbol.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/Symbol.lisp

4.1.15 proto/proto/SymbolicExpression.lisp

Parent

proto (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/gtirb-quicklisp-daee8633-git/proto/SymbolicExpression.lisp

4.2 Static

4.2.1 proto/README.md

Parent

proto (system)

Location

README.md

5 Packages

Packages are listed by definition order.

5.1 gtirb/gtirb

Source

lisp.lisp (file)

Nickname

gtirb

Use List

• curry-compose-reader-macros
• editor-hints.named-readtables
• gtirb/utility
• gtirb/ranged
• trivial-utf-8
• trivia.level2
• graph/graph
• alexandria
• common-lisp

Exported Definitions

• *is-equal-p-verbose-p* (special variable)
• address (generic function)
• address (method)
• address (method)
• (setf address) (method)
• address (method)
• (setf address) (generic function)
• address-range (generic function)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• address-range (method)
• addressp (generic function)
• addressp (method)
• (setf addressp) (method)
• (setf addressp) (generic function)
• at-address (generic function)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-address (method)
• at-end (generic function)
• at-end (method)
• (setf at-end) (method)
• (setf at-end) (generic function)
• aux-data (generic function)
• aux-data (method)
• (setf aux-data) (method)
• aux-data (method)
• (setf aux-data) (method)
• (setf aux-data) (generic function)
• aux-data (class)
• aux-data-data (generic function)
• aux-data-data (method)
• (setf aux-data-data) (generic function)
• (setf aux-data-data) (method)
• aux-data-type (generic function)
• aux-data-type (method)
• (setf aux-data-type) (generic function)
• (setf aux-data-type) (method)
• binary-path (generic function)
• binary-path (method)
• (setf binary-path) (method)
• (setf binary-path) (generic function)
• blocks (generic function)
• blocks (method)
• (setf blocks) (method)
• (setf blocks) (generic function)
• byte-interval (generic function)
• byte-interval (method)
• (setf byte-interval) (method)
• byte-interval (method)
• (setf byte-interval) (method)
• (setf byte-interval) (generic function)
• byte-interval (class)
• byte-intervals (generic function)
• byte-intervals (method)
• (setf byte-intervals) (method)
• (setf byte-intervals) (generic function)
• bytes (generic function)
• bytes (method)
• bytes (method)
• (setf bytes) (setf expander)
• cfg (generic function)
• cfg (method)
• (setf cfg) (method)
• (setf cfg) (generic function)
• code-block (class)
• conditional (generic function)
• conditional (method)
• (setf conditional) (method)
• (setf conditional) (generic function)
• contents (generic function)
• contents (method)
• (setf contents) (method)
• (setf contents) (generic function)
• data-block (class)
• decode-mode (generic function)
• decode-mode (method)
• (setf decode-mode) (method)
• (setf decode-mode) (generic function)
• direct (generic function)
• direct (method)
• (setf direct) (method)
• (setf direct) (generic function)
• edge-label (class)
• edge-type (generic function)
• edge-type (method)
• (setf edge-type) (method)
• (setf edge-type) (generic function)
• entry-point (generic function)
• entry-point (method)
• (setf entry-point) (generic function)
• (setf entry-point) (method)
• file-format (generic function)
• file-format (method)
• (setf file-format) (method)
• (setf file-format) (generic function)
• flags (generic function)
• flags (method)
• (setf flags) (method)
• (setf flags) (generic function)
• get-uuid (generic function)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• get-uuid (method)
• (setf get-uuid) (method)
• (setf get-uuid) (generic function)
• gtirb (generic function)
• gtirb (method)
• (setf gtirb) (method)
• (setf gtirb) (generic function)
• gtirb (class)
• gtirb-block (class)
• gtirb-byte-block (class)
• gtirb-node (class)
• gtirb-version (constant)
• ir (generic function)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• ir (method)
• (setf ir) (method)
• (setf ir) (generic function)
• is-equal-p (function)
• isa (generic function)
• isa (method)
• (setf isa) (method)
• (setf isa) (generic function)
• module (generic function)
• module (method)
• (setf module) (method)
• module (method)
• (setf module) (method)
• module (method)
• (setf module) (method)
• (setf module) (generic function)
• module (class)
• modules (generic function)
• modules (method)
• (setf modules) (method)
• (setf modules) (generic function)
• name (generic function)
• name (method)
• (setf name) (method)
• name (method)
• (setf name) (method)
• name (method)
• (setf name) (method)
• (setf name) (generic function)
• offset (generic function)
• offset (method)
• (setf offset) (method)
• offset (method)
• (setf offset) (method)
• offset (method)
• (setf offset) (method)
• offset (method)
• (setf offset) (method)
• offset (method)
• (setf offset) (method)
• (setf offset) (generic function)
• on-address (generic function)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• on-address (method)
• payload (generic function)
• payload (method)
• (setf payload) (method)
• (setf payload) (generic function)
• preferred-addr (generic function)
• preferred-addr (method)
• (setf preferred-addr) (method)
• (setf preferred-addr) (generic function)
• protobuf-version (constant)
• proxies (generic function)
• proxies (method)
• (setf proxies) (method)
• (setf proxies) (generic function)
• read-gtirb (generic function)
• read-gtirb (method)
• read-gtirb (method)
• rebase-delta (generic function)
• rebase-delta (method)
• (setf rebase-delta) (method)
• (setf rebase-delta) (generic function)
• remove-uuid (generic function)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• remove-uuid (method)
• scale (generic function)
• scale (method)
• (setf scale) (method)
• (setf scale) (generic function)
• section (generic function)
• section (method)
• (setf section) (method)
• (setf section) (generic function)
• section (class)
• sections (generic function)
• sections (method)
• (setf sections) (method)
• (setf sections) (generic function)
• size (generic function)
• size (method)
• size (method)
• size (method)
• size (method)
• (setf size) (generic function)
• (setf size) (method)
• (setf size) (method)
• (setf size) (method)
• sym-addr-addr (class)
• sym-addr-const (class)
• sym-stack-const (class)
• symbol (class)
• symbolic-expressions (generic function)
• symbolic-expressions (method)
• symbolic-expressions (method)
• (setf symbolic-expressions) (method)
• (setf symbolic-expressions) (generic function)
• symbols (generic function)
• symbols (method)
• (setf symbols) (method)
• symbols (method)
• (setf symbols) (method)
• (setf symbols) (generic function)
• update-proto (generic function)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• update-proto (method)
• uuid (generic function)
• uuid (method)
• value (generic function)
• value (method)
• (setf value) (method)
• (setf value) (generic function)
• version (generic function)
• version (method)
• (setf version) (method)
• (setf version) (generic function)
• write-gtirb (function)

Internal Definitions

• *decode-data* (special variable)
• *is-equal-p-verbose-output-buffer* (special variable)
• *is-equal-p-verbose-output-length* (special variable)
• +edge-label-type-map+ (constant)
• +module-file-format-map+ (constant)
• +module-isa-map+ (constant)
• +section-flags-map+ (constant)
• aux-data-decode (function)
• aux-data-encode (function)
• aux-data-from-proto (function)
• aux-data-slot-definition (special variable)
• aux-data-to-proto (function)
• aux-data-type-print (function)
• aux-data-type-read (function)
• by-address (generic function)
• by-address (method)
• (setf by-address) (method)
• (setf by-address) (generic function)
• by-uuid (generic function)
• by-uuid (method)
• (setf by-uuid) (method)
• (setf by-uuid) (generic function)
• compare-or-verbose (macro)
• decode (function)
• define-proto-backed-class (macro)
• delete-address (generic function)
• delete-address (method)
• encode (function)
• insert-address (generic function)
• insert-address (method)
• is-equal-p-internal (generic function)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• is-equal-p-internal (method)
• matching (function)
• proto (generic function)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• proto (method)
• (setf proto) (method)
• (setf proto) (generic function)
• proto-backed (class)
• proxy-block (class)
• referent-uuid (generic function)
• referent-uuid (method)
• (setf referent-uuid) (method)
• (setf referent-uuid) (generic function)
• set-parent-uuid (generic function)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• set-parent-uuid (method)
• setf-bytes-after (generic function)
• setf-bytes-after (method)
• setf-bytes-after (method)
• shift-subseq (function)
• (setf shift-subseq) (setf expander)
• start-case (macro)
• symbolic-expression (class)
• version.txt (special variable)

5.2 gtirb/ranged

Source

lisp.lisp (file)

Use List

common-lisp

Used By List

gtirb/gtirb

Exported Definitions

• make-ranged (function)
• ranged-delete (function)
• ranged-find (function)
• ranged-find-at (function)
• ranged-insert (function)

Internal Definitions

• copy-uuid-interval (function)
• make-uuid-interval (function)
• uuid-interval (structure)
• uuid-interval-end (function)
• (setf uuid-interval-end) (function)
• uuid-interval-p (function)
• uuid-interval-start (function)
• (setf uuid-interval-start) (function)
• uuid-interval-uuid (function)
• (setf uuid-interval-uuid) (function)
• uuid-interval= (function)

5.3 gtirb/utility

Source

lisp.lisp (file)

Use List

common-lisp

Used By List

gtirb/gtirb

Exported Definitions

• force-byte-array (function)
• integer-to-uuid (function)
• new-uuid (function)
• read-proto (generic function)
• read-proto (method)
• read-proto (method)
• read-proto (method)
• read-proto (method)
• uuid-to-integer (function)
• write-proto (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Constants

Constant: gtirb-version

GTIRB Version as a string of "MAJOR.MINOR.PATCH".

Package

gtirb/gtirb

Source

lisp.lisp (file)

Constant: protobuf-version

GTIRB Protobuf Version as a non-negative integer.

Package

gtirb/gtirb

Source

lisp.lisp (file)

6.1.2 Special variables

Special Variable: *is-equal-p-verbose-p*

Compare equality verbosely in the ‘is-equal-p’ function.
This may be useful to print contextual information when an equality comparison fails for a large object with many nested objects.

Package

gtirb/gtirb

Source

lisp.lisp (file)

6.1.3 Functions

Function: force-byte-array ()

Force ARRAY into a byte array.

Package

gtirb/utility

Source

lisp.lisp (file)

Function: integer-to-uuid ()

Package

gtirb/utility

Source

lisp.lisp (file)

Function: is-equal-p LEFT RIGHT

Return t if LEFT and RIGHT are equal.
Recursively descend into any sub-structure. Custom recursive equality predicates are defined for common Common Lisp data structures as well as all GTIRB structures.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Function: make-ranged ()

Package

gtirb/ranged

Source

lisp.lisp (file)

Function: new-uuid ()

Return a new random UUID.

Package

gtirb/utility

Source

lisp.lisp (file)

Function: ranged-delete ()

Package

gtirb/ranged

Source

lisp.lisp (file)

Function: ranged-find ()

Package

gtirb/ranged

Source

lisp.lisp (file)

Function: ranged-find-at ()

Package

gtirb/ranged

Source

lisp.lisp (file)

Function: ranged-insert ()

Package

gtirb/ranged

Source

lisp.lisp (file)

Function: uuid-to-integer ()

Package

gtirb/utility

Source

lisp.lisp (file)

Function: write-gtirb GTIRB PATH

Write a GTIRB IR object to PATH.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Function: write-proto ()

Write OBJECT to PATH.

Package

gtirb/utility

Source

lisp.lisp (file)

6.1.4 Generic functions

Generic Function: address OBJ

Generic Function: (setf address) NEW OBJ

Package

gtirb/gtirb

Methods

Method: address (OBJ gtirb-byte-block)

Source

lisp.lisp (file)

Method: address (OBJ byte-interval)

Source

lisp.lisp (file)

Method: (setf address) NEW (OBJ byte-interval)

Optionally specify the address in memory at which this
~ byte-interval should start. Byte-intervals without address could exist anywhere in memory.

Source

lisp.lisp (file)

Method: address (OBJ section)

Source

lisp.lisp (file)

Generic Function: address-range PROTO-BACKED-OBJECT

Return any address range of the PROTO-BACKED-OBJECT GTIRB object.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Methods

Method: address-range (SELF aux-data)

Method: address-range (SELF proxy-block)

Method: address-range (SELF data-block)

Method: address-range (SELF code-block)

Method: address-range (SELF sym-addr-addr)

Method: address-range (SELF sym-addr-const)

Method: address-range (SELF sym-stack-const)

Method: address-range (SELF byte-interval)

Method: address-range (SELF section)

Method: address-range (SELF symbol)

Method: address-range (SELF edge-label)

Method: address-range (SELF module)

Method: address-range (SELF gtirb)

Generic Function: addressp OBJ

Generic Function: (setf addressp) NEW OBJ

Package

gtirb/gtirb

Methods

Method: addressp (OBJ byte-interval)

Method: (setf addressp) NEW (OBJ byte-interval)

Does this byte-interval have an address.

Source

lisp.lisp (file)

Generic Function: at-address OBJECT ADDRESS

Find all objects in OBJECT starting at ADDRESS.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Methods

Method: at-address (OBJECT proxy-block) ADDRESS

Method: at-address (OBJECT data-block) ADDRESS

Method: at-address (OBJECT code-block) ADDRESS

Method: at-address (OBJECT byte-interval) ADDRESS

Method: at-address (OBJECT section) ADDRESS

Method: at-address (OBJECT symbol) ADDRESS

Method: at-address (OBJECT module) ADDRESS

Method: at-address (GTIRB gtirb) ADDRESS

Generic Function: at-end OBJ

Generic Function: (setf at-end) NEW OBJ

Package

gtirb/gtirb

Methods

Method: at-end (OBJ symbol)

Method: (setf at-end) NEW (OBJ symbol)

Source

lisp.lisp (file)

Generic Function: aux-data OBJECT

Generic Function: (setf aux-data) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: aux-data (MODULE module)

Method: (setf aux-data) NEW-VALUE (MODULE module)

A-list of auxiliary data objects keyed by string name.
Aux-Data tables may hold structured or unstructured data. This data may refer to elements of the GTIRB IR through uuids. Information relevant to a particular module will be stored in Aux-Data tables accessible from the specific module. Aux-Data tables only exist on modules and on GTIRB IR instances.

Source

lisp.lisp (file)

Method: aux-data (GTIRB gtirb)

Method: (setf aux-data) NEW-VALUE (GTIRB gtirb)

A-list of auxiliary data objects keyed by string name.
Aux-Data tables may hold structured or unstructured data. This data may refer to elements of the GTIRB IR through uuids. Information relevant to a particular module will be stored in Aux-Data tables accessible from the specific module. Aux-Data tables only exist on modules and on GTIRB IR instances.

Source

lisp.lisp (file)

Generic Function: aux-data-data AUX-DATA

Access the structured representation of AUX-DATAs data.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Writer

(setf aux-data-data) (generic function)

Methods

Method: aux-data-data (OBJ aux-data)

Generic Function: (setf aux-data-data) NEW OBJ

Package

gtirb/gtirb

Reader

aux-data-data (generic function)

Methods

Method: (setf aux-data-data) NEW (OBJ aux-data)

Source

lisp.lisp (file)

Generic Function: aux-data-type AUX-DATA

Access the structured type of AUX-DATA.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Writer

(setf aux-data-type) (generic function)

Methods

Method: aux-data-type (OBJ aux-data)

Generic Function: (setf aux-data-type) NEW OBJ

Package

gtirb/gtirb

Reader

aux-data-type (generic function)

Methods

Method: (setf aux-data-type) NEW (OBJ aux-data)

Source

lisp.lisp (file)

Generic Function: binary-path OBJ

Generic Function: (setf binary-path) NEW OBJ

Package

gtirb/gtirb

Methods

Method: binary-path (OBJ module)

Method: (setf binary-path) NEW (OBJ module)

The path or filename for this module.
E.g, the name of a dynamically loaded library or of the main executable.

Source

lisp.lisp (file)

Generic Function: blocks OBJECT

Generic Function: (setf blocks) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: blocks (BYTE-INTERVAL byte-interval)

Method: (setf blocks) NEW-VALUE (BYTE-INTERVAL byte-interval)

Blocks in this byte-interval.
This list could include ‘code-block’ or ‘data-block’ elements (which both subclass the ‘gtirb-byte-block’ class) but not ‘proxy-block’ elements as proxy blocks do not hold bytes.

Source

lisp.lisp (file)

Generic Function: byte-interval OBJECT

Generic Function: (setf byte-interval) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: byte-interval (DATA-BLOCK data-block)

Method: (setf byte-interval) NEW-VALUE (DATA-BLOCK data-block)

Access the BYTE-INTERVAL of this DATA-BLOCK.

Source

lisp.lisp (file)

Method: byte-interval (CODE-BLOCK code-block)

Method: (setf byte-interval) NEW-VALUE (CODE-BLOCK code-block)

Access the BYTE-INTERVAL of this CODE-BLOCK.

Source

lisp.lisp (file)

Generic Function: byte-intervals OBJECT

Generic Function: (setf byte-intervals) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: byte-intervals (SECTION section)

Method: (setf byte-intervals) NEW-VALUE (SECTION section)

Byte-intervals holding all of the section’s bytes.

Source

lisp.lisp (file)

Generic Function: bytes OBJECT &optional START END

Return the bytes held by OBJECT.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Setf Expander

(setf bytes) (setf expander)

Methods

Method: bytes (OBJ byte-interval) &optional START END

Method: bytes (OBJ gtirb-byte-block) &optional START END

Setf Expander: (setf bytes) SEQUENCE &optional START END

Package

gtirb/gtirb

Source

lisp.lisp (file)

Reader

bytes (generic function)

Generic Function: cfg OBJECT

Generic Function: (setf cfg) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: cfg (GTIRB gtirb)

Method: (setf cfg) NEW-VALUE (GTIRB gtirb)

Control flow graph (CFG) represented as a ‘graph:digraph’.
Nodes in the graph hold the UUIDs of code blocks which may be looked up using ‘get-uuid’. Edges on the graph are labeled with ‘edge-label’ objects which provide information on the nature of the control flow of the graph.

Source

lisp.lisp (file)

Generic Function: conditional OBJ

Generic Function: (setf conditional) NEW OBJ

Package

gtirb/gtirb

Methods

Method: conditional (OBJ edge-label)

Method: (setf conditional) NEW (OBJ edge-label)

This is true if this edge is due to a conditional instruction.

Source

lisp.lisp (file)

Generic Function: contents OBJ

Generic Function: (setf contents) NEW OBJ

Package

gtirb/gtirb

Methods

Method: contents (OBJ byte-interval)

Method: (setf contents) NEW (OBJ byte-interval)

A vector holding the actual bytes of this byte interval.

Source

lisp.lisp (file)

Generic Function: decode-mode OBJ

Generic Function: (setf decode-mode) NEW OBJ

Package

gtirb/gtirb

Methods

Method: decode-mode (OBJ code-block)

Method: (setf decode-mode) NEW (OBJ code-block)

Only present on architecture with multiple decode-modes.

Source

lisp.lisp (file)

Generic Function: direct OBJ

Generic Function: (setf direct) NEW OBJ

Package

gtirb/gtirb

Methods

Method: direct (OBJ edge-label)

Method: (setf direct) NEW (OBJ edge-label)

Is this a direct (as opposed to indirect) control flow edge.

Source

lisp.lisp (file)

Generic Function: edge-type OBJ

Generic Function: (setf edge-type) NEW OBJ

Package

gtirb/gtirb

Methods

Method: edge-type (OBJ edge-label)

Method: (setf edge-type) NEW (OBJ edge-label)

The type of an edge indicates the nature of the
control flow along it. E.g., "branch," "call," "fallthrough," and "return" are examples.

Source

lisp.lisp (file)

Generic Function: entry-point MODULE

The code-block which is the entry point of MODULE.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Writer

(setf entry-point) (generic function)

Methods

Method: entry-point (OBJ module)

Generic Function: (setf entry-point) NEW OBJ

Package

gtirb/gtirb

Reader

entry-point (generic function)

Methods

Method: (setf entry-point) (NEW code-block) (OBJ module)

Source

lisp.lisp (file)

Generic Function: file-format OBJ

Generic Function: (setf file-format) NEW OBJ

Package

gtirb/gtirb

Methods

Method: file-format (OBJ module)

Method: (setf file-format) NEW (OBJ module)

The binary file format of the original file this module represents.

Source

lisp.lisp (file)

Generic Function: flags OBJ

Generic Function: (setf flags) NEW OBJ

Package

gtirb/gtirb

Methods

Method: flags (OBJ section)

Method: (setf flags) NEW (OBJ section)

Flags holding common properties of this section.
These flags only hold those section properties which are relatively universal including read, write, execute permissions, whether the section is loaded into memory at run-time or not, whether the section is zero initialized, and whether the section is thread-local.

Source

lisp.lisp (file)

Generic Function: get-uuid UUID OBJECT

Get the referent of UUID in OBJECT.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Writer

(setf get-uuid) (generic function)

Methods

Method: get-uuid UUID (OBJECT proxy-block)

Method: get-uuid UUID (OBJECT data-block)

Method: get-uuid UUID (OBJECT code-block)

Method: get-uuid UUID (OBJECT byte-interval)

Method: get-uuid UUID (OBJECT section)

Method: get-uuid UUID (OBJECT symbol)

Method: get-uuid UUID (OBJECT module)

Method: get-uuid UUID (OBJ gtirb)

Generic Function: (setf get-uuid) NEW UUID OBJECT

Register REFERENT behind UUID in OBJECT.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Reader

get-uuid (generic function)

Methods

Method: (setf get-uuid) NEW UUID (OBJECT proxy-block)

Method: (setf get-uuid) NEW UUID (OBJECT data-block)

Method: (setf get-uuid) NEW UUID (OBJECT code-block)

Method: (setf get-uuid) NEW UUID (OBJECT byte-interval)

Method: (setf get-uuid) NEW UUID (OBJECT section)

Method: (setf get-uuid) NEW UUID (OBJECT symbol)

Method: (setf get-uuid) NEW UUID (OBJECT module)

Method: (setf get-uuid) NEW UUID (OBJ gtirb)

Generic Function: gtirb OBJECT

Generic Function: (setf gtirb) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: gtirb (MODULE module)

Method: (setf gtirb) NEW-VALUE (MODULE module)

Access the GTIRB of this MODULE.

Source

lisp.lisp (file)

Generic Function: ir OBJECT

Generic Function: (setf ir) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: ir (AUX-DATA aux-data)

Method: (setf ir) NEW-VALUE (AUX-DATA aux-data)

Access the top-level IR of this AUX-DATA.

Source

lisp.lisp (file)

Method: ir (PROXY-BLOCK proxy-block)

Method: (setf ir) NEW-VALUE (PROXY-BLOCK proxy-block)

Access the top-level IR of this PROXY-BLOCK.

Source

lisp.lisp (file)

Method: ir (DATA-BLOCK data-block)

Method: (setf ir) NEW-VALUE (DATA-BLOCK data-block)

Access the top-level IR of this DATA-BLOCK.

Source

lisp.lisp (file)

Method: ir (CODE-BLOCK code-block)

Method: (setf ir) NEW-VALUE (CODE-BLOCK code-block)

Access the top-level IR of this CODE-BLOCK.

Source

lisp.lisp (file)

Method: ir (SYM-ADDR-ADDR sym-addr-addr)

Method: (setf ir) NEW-VALUE (SYM-ADDR-ADDR sym-addr-addr)

Access the top-level IR of this SYM-ADDR-ADDR.

Source

lisp.lisp (file)

Method: ir (SYM-ADDR-CONST sym-addr-const)

Method: (setf ir) NEW-VALUE (SYM-ADDR-CONST sym-addr-const)

Access the top-level IR of this SYM-ADDR-CONST.

Source

lisp.lisp (file)

Method: ir (SYM-STACK-CONST sym-stack-const)

Method: (setf ir) NEW-VALUE (SYM-STACK-CONST sym-stack-const)

Access the top-level IR of this SYM-STACK-CONST.

Source

lisp.lisp (file)

Method: ir (BYTE-INTERVAL byte-interval)

Method: (setf ir) NEW-VALUE (BYTE-INTERVAL byte-interval)

Access the top-level IR of this BYTE-INTERVAL.

Source

lisp.lisp (file)

Method: ir (SECTION section)

Method: (setf ir) NEW-VALUE (SECTION section)

Access the top-level IR of this SECTION.

Source

lisp.lisp (file)

Method: ir (SYMBOL symbol)

Method: (setf ir) NEW-VALUE (SYMBOL symbol)

Access the top-level IR of this SYMBOL.

Source

lisp.lisp (file)

Method: ir (EDGE-LABEL edge-label)

Method: (setf ir) NEW-VALUE (EDGE-LABEL edge-label)

Access the top-level IR of this EDGE-LABEL.

Source

lisp.lisp (file)

Method: ir (MODULE module)

Method: (setf ir) NEW-VALUE (MODULE module)

Access the top-level IR of this MODULE.

Source

lisp.lisp (file)

Method: ir (OBJ gtirb)

Source

lisp.lisp (file)

Method: (setf ir) NEW-VALUE (GTIRB gtirb)

Access the top-level IR of this GTIRB.

Source

lisp.lisp (file)

Generic Function: isa OBJ

Generic Function: (setf isa) NEW OBJ

Package

gtirb/gtirb

Methods

Method: isa (OBJ module)

Method: (setf isa) NEW (OBJ module)

The instruction set architecture (ISA) of the code in this module.

Source

lisp.lisp (file)

Generic Function: module OBJECT

Generic Function: (setf module) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: module (PROXY-BLOCK proxy-block)

Method: (setf module) NEW-VALUE (PROXY-BLOCK proxy-block)

Access the MODULE of this PROXY-BLOCK.

Source

lisp.lisp (file)

Method: module (SECTION section)

Method: (setf module) NEW-VALUE (SECTION section)

Access the MODULE of this SECTION.

Source

lisp.lisp (file)

Method: module (SYMBOL symbol)

Method: (setf module) NEW-VALUE (SYMBOL symbol)

Access the MODULE of this SYMBOL.

Source

lisp.lisp (file)

Generic Function: modules OBJECT

Generic Function: (setf modules) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: modules (GTIRB gtirb)

Method: (setf modules) NEW-VALUE (GTIRB gtirb)

List of the modules on a top-level GTIRB IR instance.

Source

lisp.lisp (file)

Generic Function: name OBJ

Generic Function: (setf name) NEW OBJ

Package

gtirb/gtirb

Methods

Method: name (OBJ section)

Method: (setf name) NEW (OBJ section)

Name of this section.

Source

lisp.lisp (file)

Method: name (OBJ symbol)

Method: (setf name) NEW (OBJ symbol)

Source

lisp.lisp (file)

Method: name (OBJ module)

Method: (setf name) NEW (OBJ module)

An optional human-readable name for this module.

Source

lisp.lisp (file)

Generic Function: offset OBJ

Generic Function: (setf offset) NEW OBJ

Package

gtirb/gtirb

Methods

Method: offset (DATA-BLOCK data-block)

Method: (setf offset) NEW-VALUE (DATA-BLOCK data-block)

Offset into this block’s bytes in the block’s byte-interval.

Source

lisp.lisp (file)

Method: offset (CODE-BLOCK code-block)

Method: (setf offset) NEW-VALUE (CODE-BLOCK code-block)

Offset into this block’s bytes in the block’s byte-interval.

Source

lisp.lisp (file)

Method: offset (OBJ sym-addr-addr)

Method: (setf offset) NEW (OBJ sym-addr-addr)

Source

lisp.lisp (file)

Method: offset (OBJ sym-addr-const)

Method: (setf offset) NEW (OBJ sym-addr-const)

Source

lisp.lisp (file)

Method: offset (OBJ sym-stack-const)

Method: (setf offset) NEW (OBJ sym-stack-const)

Source

lisp.lisp (file)

Generic Function: on-address OBJECT START-ADDRESS &optional END-ADDRESS

Find all objects in OBJECT between START-ADDRESS and END-ADDRESS.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Methods

Method: on-address (OBJECT proxy-block) START &optional END

Method: on-address (OBJECT data-block) START &optional END

Method: on-address (OBJECT code-block) START &optional END

Method: on-address (OBJECT byte-interval) START &optional END

Method: on-address (OBJECT section) START &optional END

Method: on-address (OBJECT symbol) START &optional END

Method: on-address (OBJECT module) START &optional END

Method: on-address (GTIRB gtirb) START &optional END

Generic Function: payload SYMBOL

Provide access to the referent or value of SYMBOL.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Writer

(setf payload) (generic function)

Methods

Method: payload (SYMBOL symbol)

Generic Function: (setf payload) NEW SYMBOL

Package

gtirb/gtirb

Reader

payload (generic function)

Methods

Method: (setf payload) NEW (SYMBOL symbol)

Source

lisp.lisp (file)

Generic Function: preferred-addr OBJ

Generic Function: (setf preferred-addr) NEW OBJ

Package

gtirb/gtirb

Methods

Method: preferred-addr (OBJ module)

Method: (setf preferred-addr) NEW (OBJ module)

Some systems specify a preferred address in memory.
On those systems this field may be used to capture this address.

Source

lisp.lisp (file)

Generic Function: proxies OBJECT

Generic Function: (setf proxies) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: proxies (MODULE module)

Method: (setf proxies) NEW-VALUE (MODULE module)

Hash-table of proxy-blocks keyed by UUID.
Proxy-blocks in GTIRB are used to represent cross-module linkages. For example when code in a module calls to a function defined in an external library, the CFG for that IR instance may represent this call with a call edge to a proxy block representing the external called function.

Source

lisp.lisp (file)

Generic Function: read-gtirb SOURCE

Read a protobuf serialized GTIRB instance from SOURCE.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Methods

Method: read-gtirb SOURCE around

Check the protobuf version.

Method: read-gtirb PATH

Generic Function: read-proto CLASS SOURCE

Read protobuf object of class CLASS from SOURCE.

Package

gtirb/utility

Source

lisp.lisp (file)

Methods

Method: read-proto CLASS (PATH pathname) before

Method: read-proto CLASS (PATH string)

Method: read-proto CLASS (PATH pathname)

Method: read-proto CLASS (INPUT stream) &aux GTIRB

Generic Function: rebase-delta OBJ

Generic Function: (setf rebase-delta) NEW OBJ

Package

gtirb/gtirb

Methods

Method: rebase-delta (OBJ module)

Method: (setf rebase-delta) NEW (OBJ module)

The difference between this module’s and
‘preferred-addr’ and the address at which it was actually loaded.

Source

lisp.lisp (file)

Generic Function: remove-uuid UUID OBJECT

Remove the entry for UUID from OBJECT.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Methods

Method: remove-uuid UUID (OBJECT proxy-block)

Method: remove-uuid UUID (OBJECT data-block)

Method: remove-uuid UUID (OBJECT code-block)

Method: remove-uuid UUID (OBJECT byte-interval)

Method: remove-uuid UUID (OBJECT section)

Method: remove-uuid UUID (OBJECT symbol)

Method: remove-uuid UUID (OBJECT module)

Method: remove-uuid UUID (OBJ gtirb)

Generic Function: scale OBJ

Generic Function: (setf scale) NEW OBJ

Package

gtirb/gtirb

Methods

Method: scale (OBJ sym-addr-addr)

Method: (setf scale) NEW (OBJ sym-addr-addr)

Source

lisp.lisp (file)

Generic Function: section OBJECT

Generic Function: (setf section) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: section (BYTE-INTERVAL byte-interval)

Method: (setf section) NEW-VALUE (BYTE-INTERVAL byte-interval)

Access the SECTION of this BYTE-INTERVAL.

Source

lisp.lisp (file)

Generic Function: sections OBJECT

Generic Function: (setf sections) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: sections (MODULE module)

Method: (setf sections) NEW-VALUE (MODULE module)

List of the sections comprising this module.

Source

lisp.lisp (file)

Generic Function: size IT

Generic Function: (setf size) NEW OBJ

Package

gtirb/gtirb

Methods

Method: size (OBJ data-block)

The length of the bytes held by this data block.

Source

lisp.lisp (file)

Method: size (OBJ code-block)

The length of the bytes held by this code block.

Source

lisp.lisp (file)

Method: size (OBJ byte-interval)

The size of this byte-interval.
It is possible for the size of a byte-interval to be larger than the number of bytes in the byte interval’s ‘contents’ if portions of the byte-interval are not represented statically but are zero-initialized at runtime.

Source

lisp.lisp (file)

Method: size (IT section)

Source

lisp.lisp (file)

Method: (setf size) NEW (OBJ data-block)

The length of the bytes held by this data block.

Source

lisp.lisp (file)

Method: (setf size) NEW (OBJ code-block)

The length of the bytes held by this code block.

Source

lisp.lisp (file)

Method: (setf size) NEW (OBJ byte-interval)

The size of this byte-interval.
It is possible for the size of a byte-interval to be larger than the number of bytes in the byte interval’s ‘contents’ if portions of the byte-interval are not represented statically but are zero-initialized at runtime.

Source

lisp.lisp (file)

Generic Function: symbolic-expressions OBJECT

Generic Function: (setf symbolic-expressions) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: symbolic-expressions (BB gtirb-byte-block)

Source

lisp.lisp (file)

Method: symbolic-expressions (BYTE-INTERVAL byte-interval)

Method: (setf symbolic-expressions) NEW-VALUE (BYTE-INTERVAL byte-interval)

Hash of symbolic-expressions keyed by offset.

Source

lisp.lisp (file)

Generic Function: symbols OBJECT

Generic Function: (setf symbols) NEW-VALUE OBJECT

Package

gtirb/gtirb

Methods

Method: symbols (SYMBOLIC-EXPRESSION symbolic-expression)

Method: (setf symbols) NEW-VALUE (SYMBOLIC-EXPRESSION symbolic-expression)

Symbol(s) appearing in this symbolic expression.

Source

lisp.lisp (file)

Method: symbols (MODULE module)

Method: (setf symbols) NEW-VALUE (MODULE module)

Hash-table of symbols keyed by UUID.

Source

lisp.lisp (file)

Generic Function: update-proto PROTO-BACKED-OBJECT

Update and return the ‘proto’ field of PROTO-BACKED-OBJECT.
This will ensure that any changes made to PROTO-BACKED-OBJECT outside of its protocol buffer, e.g. any slots initialized using the :from-proto option to ‘define-proto-backed-class’, are synchronized against the object’s protocol buffer.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Methods

Method: update-proto (SELF aux-data)

Method: update-proto (SELF proxy-block)

Method: update-proto (SELF data-block)

Method: update-proto (SELF code-block)

Method: update-proto (SYM sym-addr-addr) before

Method: update-proto (SYM sym-addr-const) before

Method: update-proto (SYM sym-stack-const) before

Method: update-proto (SELF sym-addr-addr)

Method: update-proto (SELF sym-addr-const)

Method: update-proto (SELF sym-stack-const)

Method: update-proto (SELF byte-interval)

Method: update-proto (SELF section)

Method: update-proto (SELF symbol)

Method: update-proto (SELF edge-label)

Method: update-proto (SELF module)

Method: update-proto (SELF gtirb)

Method: update-proto (PROTO-BACKED-OBJECT proto-backed)

Generic Function: uuid OBJECT

Return the UUID for OBJECT as an integer.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Methods

Method: uuid (OBJ proto-backed)

Generic Function: value OBJ

Generic Function: (setf value) NEW OBJ

Package

gtirb/gtirb

Methods

Method: value (OBJ symbol)

Method: (setf value) NEW (OBJ symbol)

Source

lisp.lisp (file)

Generic Function: version OBJ

Generic Function: (setf version) NEW OBJ

Package

gtirb/gtirb

Methods

Method: version (OBJ gtirb)

Method: (setf version) NEW (OBJ gtirb)

Protobuf version.

Source

lisp.lisp (file)

6.1.5 Classes

Class: aux-data ()

Package

gtirb/gtirb

Source

lisp.lisp (file)

Direct superclasses

proto-backed (class)

Direct methods

• (setf aux-data-data) (method)
• aux-data-data (method)
• (setf aux-data-type) (method)
• aux-data-type (method)
• print-object (method)
• is-equal-p-internal (method)
• update-proto (method)
• initialize-instance (method)
• address-range (method)
• ir (method)
• ir (method)
• proto (method)
• proto (method)

Direct slots

Slot: proto

Backing protobuf object.
Should not need to be manipulated by client code.

Type

gtirb.proto:aux-data

Initargs

:proto

Initform

(make-instance (quote gtirb.proto:aux-data))

Readers

proto (generic function)

Writers

(setf proto) (generic function)

Slot: ir

Access the top-level IR of this AUX-DATA.

Type

(or null gtirb/gtirb:gtirb)

Initargs

:ir

Readers

ir (generic function)

Writers

(setf ir) (generic function)

Class: byte-interval ()

Byte-interval in a GTIRB instance.

Package

gtirb/gtirb

Source

lisp.lisp (file)

Direct superclasses

proto-backed (class)

Direct methods

• setf-bytes-after (method)
• bytes (method)
• address (method)
• print-object (method)
• contents (method)
• contents (method)
• (setf size) (method)
• size (method)
• address (method)
• addressp (method)
• addressp (method)
• is-equal-p-internal (method)
• update-proto (method)
• initialize-instance (method)
• address-range (method)
• on-address (method)
• at-address (method)
• remove-uuid (method)
• get-uuid (method)
• set-parent-uuid (method)
• get-uuid (method)
• symbolic-expressions (method)
• symbolic-expressions (method)
• blocks (method)
• blocks (method)
• section (method)
• section (method)
• ir (method)
• ir (method)
• proto (method)
• proto (method)

Direct slots

Slot: proto

Backing protobuf object.
Should not need to be manipulated by client code.

Type

gtirb.proto:byte-interval

Initargs

:proto

Initform

(let ((gtirb/gtirb::it (make-instance (quote gtirb.proto:byte-interval)))) (setf (gtirb.proto:uuid gtirb/gtirb::it) (gtirb/utility:new-uuid)) gtirb/gtirb::it)

Readers

proto (generic function)

Writers

(setf proto) (generic function)

Slot: ir

Access the top-level IR of this BYTE-INTERVAL.

Type

(or null gtirb/gtirb:gtirb)

Initargs

:ir

Readers

ir (generic function)

Writers

(setf ir) (generic function)

Slot: section

Access the SECTION of this BYTE-INTERVAL.

Type

(or null gtirb/gtirb:section)

Initargs

:section

Readers

section (generic function)

Writers

(setf section) (generic function)

Slot: blocks

Blocks in this byte-interval.
This list could include ‘code-block’ or ‘data-block’ elements (which both subclass the ‘gtirb-byte-block’ class) but not ‘proxy-block’ elements as proxy blocks do not hold bytes.

Type

list

Initargs

:blocks

Readers

blocks (generic function)

Writers

(setf blocks) (generic function)

Slot: symbolic-expressions

Hash of symbolic-expressions keyed by offset.

Type

hash-table

Initargs

:symbolic-expressions

Readers

symbolic-expressions (generic function)

Writers

(setf symbolic-expressions) (generic function)