(*
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *)

open! IStd

exception UnlockNotLocked of Procname.t

val setup : unit -> unit
(** This should be called once before trying to lock Anything. *)

val try_lock : Procname.t -> bool
(** true = the lock belongs to the calling process. false = the lock belongs to a different worker *)

val unlock : Procname.t -> unit
(** This will work as a cleanup function because after calling unlock all the workers that need an
    unlocked Proc should find it's summary already Cached. Throws if the lock had not been taken. *)

val clean : unit -> unit
(** This should be called when locks will no longer be used to remove any files or state that's not
    necessary. *)

val is_locked : Procname.t -> bool