package bap-std

  1. Overview
  2. Docs
package bap-std
Legend:
Library
Module
Module type
Parameter
Class
Class type

A program analysis pass.

Pass is essentially a function that takes a project data structures, and returns a new project, possibly modified.

Passes may depend on other passes, and have a few properties, associated with them.

type t = pass
type error =
  1. | Unsat_dep of pass * string
  2. | Runtime_error of pass * exn

An error that can occur when loading or running pass.

  • Not_loaded name pass with a given name wasn't loaded for some reason. This is a very unlikely error, indicating either a logic error in the plugin system implementation or something very weird, that we didn't expect.
  • Not_loaded name when we tried to load plugin with a given name we failed to find it in our search paths.
  • Runtime_error (name,exn) when plugin with a given name was run it raised an exn.
val sexp_of_error : error -> Ppx_sexp_conv_lib.Sexp.t
exception Failed of error

run_pass project pass applies pass to a project.

If a pass has dependencies, then they will be run before the pass in some topological order.

val run_exn : t -> project -> project

run_pass_exn proj is the same as run_pass, but raises an exception on error. Useful to provide custom error handling/printing.

  • raises Pass_failed

    if failed to load, or if plugin failed at runtime.

val name : t -> string

name pass is a pass name

val autorun : t -> bool

autorun pass is true if a pass was created with autorun option

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct