diff options
| author | Maxime Dénès | 2019-04-01 17:41:22 +0200 |
|---|---|---|
| committer | Maxime Dénès | 2019-04-03 12:01:25 +0200 |
| commit | f374b79e08e135de11def93005110a833686c5f7 (patch) | |
| tree | 5b48870361b12c53f254381cbf809e2697e5e5ef /lib/control.mli | |
| parent | b45d4425b760b4e6346df4ea19f24d5c1e84b911 (diff) | |
Protect some I/O routines from SIGALRM
This is necessary to prevent Coq from sending ill-formed output in some
scenarios involving `Timeout`.
Co-authored-by: Enrico Tassi <Enrico.Tassi@inria.fr>
Diffstat (limited to 'lib/control.mli')
| -rw-r--r-- | lib/control.mli | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/control.mli b/lib/control.mli index 59e2a15158..640d41a4f7 100644 --- a/lib/control.mli +++ b/lib/control.mli @@ -29,3 +29,14 @@ val timeout : int -> ('a -> 'b) -> 'a -> exn -> 'b API and it is scheduled to go away. *) type timeout = { timeout : 'a 'b. int -> ('a -> 'b) -> 'a -> exn -> 'b } val set_timeout : timeout -> unit + +(** [protect_sigalrm f x] computes [f x], but if SIGALRM is received during that + computation, the signal handler is executed only once the computation is + terminated. Otherwise said, it makes the execution of [f] atomic w.r.t. + handling of SIGALRM. + + This is useful for example to prevent the implementation of `Timeout` to + interrupt I/O routines, generating ill-formed output. + +*) +val protect_sigalrm : ('a -> 'b) -> 'a -> 'b |