Module Bisect_common

This module provides type definitions, and functions used by the various parts of Bisect.

type point_definition = {
  1. offset : int;
    (*

    Point offset, relative to file beginning.

    *)
  2. identifier : int;
    (*

    Point identifier, unique in file.

    *)
}

The type of point definitions, that is places of interest in the source code.

Utility functions

val try_out_channel : bool -> string -> (out_channel -> 'a) -> 'a

try_out_channel bin filename f opens an output channel for the file given at filename, and then runs f. When f returns or raises an exception, the channel is closed. If bin is true, the channel is opened in binary mode. Otherwise, it is opened in text mode.

I/O functions

exception Invalid_file of string * string

Exception to be raised when a read file does not conform to the Bisect format. The parameter is the name of the incriminated file and the reason of the error.

val write_runtime_data : out_channel -> unit

write_runtime_data o writes the current runtime data to the output channel oc using the Bisect file format. The runtime data list encodes a map (through an association list) from files to arrays of integers (the value at index i being the number of times point i has been visited). The arrays are paired with point definition lists, giving the location of each point in the file.

Raises Sys_error if an i/o error occurs.

val runtime_data_to_string : unit -> string option

Same as write_runtime_data, but accumulates output in a string instead.

val random_filename : string -> string

Returns a random filename, with the given prefix.

val write_points : point_definition list -> string

write_points pts converts the point definitions pts to a string. The string is a binary byte sequence; it is not meant to be legible.

val read_runtime_data : string -> (string * (int array * string)) list

read_runtime_data f reads the runtime data from file f.

Raises Sys_error if an i/o error occurs. May also raise Invalid_file, Unsupported_version, or Modified_file.

val read_points : string -> point_definition list

read_points s reads point definitions from the string s.

val reset_counters : unit -> unit

Clears accumulated coverage statistics.

val register_file : string -> point_count:int -> point_definitions:string -> [ `Staged of int -> unit ]

register_file file ~point_count ~point_definitions indicates that the file file is part of the application that has been instrumented. point_definitions is a serialized Common.point_definition list giving the locations of all points in the file. The returned callback is used to increment visitation counts.

val bisect_file : string option ref

Default value for BISECT_FILE.

val bisect_silent : string option ref

Default value for BISECT_SILENT.

type options = (Arg.key * Arg.spec * Arg.doc) list
val deprecated : string -> string -> options -> options

Appends a specification for a deprecated command-line argument.