locks

%% -*- mode: erlang; indent-tabs-mode: nil; -*-
%%---- BEGIN COPYRIGHT -------------------------------------------------------
%%
%% Copyright (C) 2013 Ulf Wiger. All rights reserved.
%%
%% This Source Code Form is subject to the terms of the Mozilla Public
%% License, v. 2.0. If a copy of the MPL was not distributed with this
%% file, You can obtain one at http://mozilla.org/MPL/2.0/.
%%
%%---- END COPYRIGHT ---------------------------------------------------------
%% Key contributor: Thomas Arts <thomas.arts@quviq.com>
%%
%%=============================================================================

-type oid()      :: [any()].
-type mode()     :: read | write.
-type where()    :: [node()].
-type req()      :: any | all | majority | all_alive.
-type agent()    :: pid().
-type tid()      :: any().

-type lock_id()  :: {oid(), node()}.

-type obj()      :: {oid(), mode()}
		  | {oid(), mode(), where()}
		  | {oid(), mode(), where(), req()}.

-type objs()     :: [obj()].

-type options() :: [{link, boolean()}
		    | {client, pid()}
		    | {abort_on_error, boolean()}
		    | {abort_on_deadlock, boolean()}].

-type deadlocks() :: [lock_id()].

-type lock_status() :: have_all_locks | have_none.
-type lock_result()  :: {lock_status(), deadlocks()}.

-type locktype() :: direct | indirect.


-record(entry, {
	  agent         :: pid(),
          client        :: pid(),
	  version = 0   :: integer(),
	  type = direct :: locktype()
	 }).

-record(w, {
	  entries = []     :: [#entry{}]
	 }).

-record(r, {
	  entries = []     :: [#entry{}]
	 }).

-record(lock, {
	  object = []    :: oid() | lock_id() | '_',
	  version = 1    :: integer()     | '_',
	  pid = self()   :: pid()         | '_',
	  queue = []     :: [#r{} | #w{}] | '_',
	  watchers = [] :: [pid()]
         }).

-record(locks_info, {
	  lock,
	  where = node(),
	  note = []}).

-define(LOCKER, locks_server).