File: memprof_coq.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 (53 lines) | stat: -rw-r--r-- 1,298 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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
(* From memprof-limits *)
val is_interrupted : unit -> bool

module Masking : sig

  val with_resource :
    acquire:('a -> 'b) -> 'a -> scope:('b -> 'c) -> release:('b -> unit) -> 'c

  val is_blocked : unit -> bool

  val assert_blocked : unit -> unit
end

module Thread_map : sig

  (** An async-safe, scoped thread-local store *)

  type 'a t

  val create : unit -> 'a t
  (** Create an empty map *)

  val with_value : 'a t -> value:'a -> scope:(unit -> 'b) -> 'b
  (** Associate [~value] to the current thread for the duration of a scope.
      It can be nested: the previous association is restored on exit. *)

  val get : 'a t -> 'a option
  (** Get the value currently associated with the current thread. *)

end

module Resource_bind : sig
  (** Open {!Memprof_limits.Resource_bind} to enable the [let&] binder
      for resources. *)

  val ( let& ) : (scope:('a -> 'b) -> 'b) -> ('a -> 'b) -> 'b
(** RAII-style notation for resources cleaned-up at the end of
    scope. Example:
    {[open Memprof_limits.Resource_bind

      let with_my_resource x =
        Memprof_limits.Masking.with_resource ~acquire x ~release

      let f x =
        let& resource = with_my_resource x in
        …]} *)
end

module Mutex_aux : sig

  val with_lock : Mutex.t -> scope:(unit -> 'a) -> 'a

end