Module InferIR__Errlog

Module for error logs.

type node_tag =
| Condition of bool
| Exception of InferIR.Typ.name
| Procedure_start of InferIR.Typ.Procname.t
| Procedure_end of InferIR.Typ.Procname.t
type loc_trace_elem = private {
lt_level : int;

nesting level of procedure calls

lt_loc : InferBase.Location.t;

source location at the current step in the trace

lt_description : string;

description of the current step in the trace

lt_node_tags : node_tag list;

tags describing the node at the current location

}

Element of a loc trace

val make_trace_element : int -> InferBase.Location.t -> string -> node_tag list -> loc_trace_elem

build a loc_trace_elem from its constituents (unambiguously identified by their types).

type loc_trace = loc_trace_elem list

Trace of locations

val concat_traces : (string * loc_trace) list -> loc_trace
val compute_local_exception_line : loc_trace -> int option

Look at all the trace steps and find those that are arising any exception, then bind them to the closest step at level 0. This extra information adds value to the report itself, and may avoid digging into the trace to understand the cause of the report.

type node =
| UnknownNode
| FrontendNode of {
node_key : InferIR.Procdesc.NodeKey.t;
}
| BackendNode of {
node : InferIR.Procdesc.Node.t;
}
type err_key = private {
severity : InferIR.Exceptions.severity;
err_name : InferBase.IssueType.t;
err_desc : InferIR.Localise.error_desc;
}
val compare_err_key : err_key -> err_key -> int
val merge_err_key : err_key -> err_key -> merge_issues:(InferBase.IssueType.t -> InferBase.IssueType.t -> InferBase.IssueType.t) -> merge_descriptions:(string list -> string list -> string) -> err_key

Merges two error keys, setting the result's severity to the maximum of that of the two arguments and giving the user the opportunity to pass a function to merge the IssueTypes and descriptions of the two.

type err_data = private {
node_id : int;
node_key : InferIR.Procdesc.NodeKey.t option;
session : int;
loc : InferBase.Location.t;
loc_in_ml_source : InferBase.Logging.ocaml_pos option;
loc_trace : loc_trace;
err_class : InferIR.Exceptions.err_class;
visibility : InferIR.Exceptions.visibility;
linters_def_file : string option;
doc_url : string option;

url to documentation of the issue type

access : string option;
extras : InferGenerated.Jsonbug_t.extra option;
}

Data associated to a specific error

val compare_err_data : err_data -> err_data -> int
val merge_err_data : err_data -> err_data -> err_data

Merges two err_datas, throwing out most information and setting the trace of the result to the concatenation of the traces of the two arguments with a separator in between. Used specifically for QuandaryBO.

type t

Type of the error log

val empty : unit -> t

Empty error log

type iter_fun = err_key -> err_data -> unit

type of the function to be passed to iter

val iter : iter_fun -> t -> unit

Apply f to nodes and error names

val fold : (err_key -> err_data -> 'a -> 'a) -> t -> 'a -> 'a
val pp_loc_trace_elem : Stdlib.Format.formatter -> loc_trace_elem -> unit
val pp_loc_trace : Stdlib.Format.formatter -> loc_trace -> unit
val pp_errors : Stdlib.Format.formatter -> t -> unit

Print errors from error log

val pp_warnings : Stdlib.Format.formatter -> t -> unit

Print warnings from error log

val pp_html : InferBase.SourceFile.t -> InferBase.DB.Results_dir.path -> Stdlib.Format.formatter -> t -> unit

Print an error log in html format

val size : (InferIR.Exceptions.severity -> bool) -> t -> int

Return the number of elements in the error log which satisfy the filter.

val update : t -> t -> unit

Update an old error log with a new one

val log_issue : InferIR.Typ.Procname.t -> clang_method_kind:InferIR.ClangMethodKind.t option -> InferIR.Exceptions.severity -> t -> loc:InferBase.Location.t -> node:node -> session:int -> ltr:loc_trace -> linters_def_file:string option -> doc_url:string option -> access:string option -> extras:InferGenerated.Jsonbug_t.extra option -> exn -> unit