package binsec_codex

  1. Overview
  2. Docs
package binsec_codex
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Binsec_codex_lib.Codex_loggerSource

Sourceval current_instr_addr : Binsec.Virtual_address.t ref
Sourcemodule Alarm_record : sig ... end
Sourcemodule type BINSEC_LOGGER_S = sig ... end
include BINSEC_LOGGER_S
include Binsec.Logger.S

Channels

type channel
val fatal_channel : channel
val error_channel : channel
val result_channel : channel
val warning_channel : channel
val info_channel : channel
val debug_channel : channel

These predefined channels are flushed after each call and a newline character is inserted.

Sourceval fatal : ?e:exn -> ('a, Format.formatter, unit, 'b) format4 -> 'a

For messages that show a fatal failure, In this case, you should not be able to continue and exit code should follow the emission. Use error otherwise.

Sourceval error : ('a, Format.formatter, unit) format -> 'a

For error messages only.

Sourceval result : ('a, Format.formatter, unit) format -> 'a

For important results that will be displayed

Sourceval warning : ?level:int -> ('a, Format.formatter, unit) format -> 'a

For warning messages.

val set_warning_level : int -> unit
val get_warning_level : unit -> int
val info : ?level:int -> ('a, Format.formatter, unit) format -> 'a

Any info that should be displayed

val set_info_level : int -> unit
val get_info_level : unit -> int
val debug : ?level:int -> ('a, Format.formatter, unit) format -> 'a

debug ~level:n msg will be displayed if at least level n + 1 debug is activated

val fdebug : ?level:int -> (unit -> (unit, Format.formatter, unit) format) -> unit

fdebug ~level f acts like like debug ~level msg where msg = f () but lazily evaluates its argument. Use fdebug instead of debug if you need to print values that might be hard to compute (and that you therefore compute inside the closure).

val set_debug_level : int -> unit
val get_debug_level : unit -> int
val is_debug_enabled : unit -> bool
val set_tagged_entry : bool -> unit

set_tagged_entry Print channel identifiers, like warning for the warning channel, in front of messages to explicit their origins.

If might not be necessary if you use colors for example.

val set_log_level : string -> unit

Set logger to display only messages from that channel and those with higher loglevels.

Valid arguments in increasing order of loglevels are : "debug", "info", "warning", "error", "fatal"/"result".

You cannot turn off fatal_channel or result_channel.

val cli_handler : Arg.spec
val quiet : unit -> unit
val channel_set_color : bool -> channel -> unit

set_channel_color b chan activates (if b is true) or deactivates (if b is false) the emission of ANSI color tags for terminal.

You might want to deactivate the feature if you plan on analyzing the log in a file for example.

val channel_get_color : channel -> bool
val set_color : bool -> unit

Activate color tags rendering on all outputs.

In your format strings, tags of the form "\@\{<color>format\@\}" will thus be interpreted.

color can be any of the following:

  • black
  • darkgray
  • blue
  • lightblue
  • green
  • lightgreen,
  • cyan
  • lightcyan
  • red
  • lightred
  • purple
  • lightpurple
  • brown
  • yellow
  • lightgray
  • white

format is any format string recognized by Format. For example, after activating color tags Format.printf "\@\{<purple>Hello!\@\}" will write "Hello!" in purple if your terminal has such features.

val get_color : unit -> bool
val set_zmq_logging_only : send:(string -> unit) -> bool -> unit

set_zmq_logging_only ~send b identity diverts all formatting operations to an identity if b is true.

Warning: all other formatters are erased.

If b is false, formatters are reset to default initial values.

Sourceval check : string -> unit

Emit a check notification, i.e. inform the log reader that an alarm may follow.

Sourceval alarm : _ Operator.Alarm.t -> unit

Emit an alarm, i.e. a notification that the code could not be proved conform to the specification.

Sourceval alarm_record : unit -> Alarm_record.t
Sourceval switch_to_phase : string -> unit

Logger to be used specifically by the libase library.