File: perf.mli

package info (click to toggle)
coq 8.20.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 44,116 kB
  • sloc: ml: 234,160; sh: 4,301; python: 3,270; ansic: 2,644; makefile: 882; lisp: 172; javascript: 63; xml: 24; sed: 2
file content (28 lines) | stat: -rw-r--r-- 1,640 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
(************************************************************************)
(*         *   The Coq Proof Assistant / The Coq Development Team       *)
(*  v      *         Copyright INRIA, CNRS and contributors             *)
(* <O___,, * (see version control and CREDITS file for authors & dates) *)
(*   \VV/  **************************************************************)
(*    //   *    This file is distributed under the terms of the         *)
(*         *     GNU Lesser General Public License Version 2.1          *)
(*         *     (see LICENSE file for the text of the license)         *)
(************************************************************************)

(** Global CPU instruction counter. *)

(** [init ()] initialises, resets to 0, and starts the instruction counter. In
    case of an error, the [Failure] exception is raised, and the counter state
    is fully re-initialised so that [init] may be called again. Initialization
    is required prior to calling the [drop] and [peek] functions. *)
val init : unit -> unit

(** [drop ()] undoes the effect of [init], and frees all resources used by the
    internal state of the instruction counter. Note that the counter must have
    been initialised before calling [drop], otherwise [Failure] is raised. *)
val drop : unit -> unit

(** [peek ()] reads the value of the instruction counter, which corresponds to
    the number of instructions run by the CPU since the last (successful) call
    to [init]. Note that [Failure] is raised in case of an error, including if
    the function is called while the counter is not initialised. *)
val peek : unit -> Int64.t