/*
 * Copyright (c) 2011, Raphael Manfredi
 *
 *----------------------------------------------------------------------
 * This file is part of gtk-gnutella.
 *
 *  gtk-gnutella is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  gtk-gnutella is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with gtk-gnutella; if not, write to the Free Software
 *  Foundation, Inc.:
 *      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *----------------------------------------------------------------------
 */

/**
 * @ingroup lib
 * @file
 *
 * Spinning locks.
 *
 * The API distinguishes between "regular" and "hidden" locks.  If a lock is
 * taken in "hidden" mode, it must be released in "hidden" mode as well.
 *
 * A "hidden" lock is not tracked at the thread level, and therefore does not
 * cause any memory allocation and is very fast.  A "regular" lock is tracked
 * at the thread level in a stack, and allows sanity checks to prevent any
 * out-of-order lock release, which can cause deadlocks later.
 *
 * In the advent a deadlock occurs, all the tracked locks owned by the thread
 * are dumped.  This means "hidden" locks never appear (hence the name).
 *
 * The locking API is made of three basic calls:
 *
 *		spinlock()		-- takes the lock, blocking if busy
 *		spinlock_try()	-- try to take the lock, returns whether lock was taken
 *		spinunlock()	-- releases the lock, which must be owned
 *
 * Each of these calls can be suffixed with _hidden to use "hidden" locks.
 * A lock is not inherently "hidden": this adjective refers to the way the
 * lock is taken.
 *
 * As a rule of thumb, "hidden" locks should be reserved to trivial low-level
 * locking that does not require any nested locking and which has but one lock
 * and one unlock statement, without much code in-between.  The rationale is
 * that we want outer critical section boundaries to be valid suspension points.
 *
 * For situations where critical sections must overlap (e.g. grab lock A,
 * then lock B, release A and then release B), one must use one of the
 * following routines:
 *
 *		spinlock_swap()		-- takes lock, then swap order of locks
 *		spinlock_try_swap()	-- try to take lock, swapping order
 *
 * To achieve the critical section overlap, one would do this:
 *
 *		spinlock(A);
 *		...
 *		spinlock_swap(B, A);	// the critical section overlap
 *		spinunlock(A);
 *		...
 *		spinunlock(B);
 *
 * The swapping allows to release locks in the reverse order, something that
 * the runtime normally forbids.
 *
 * When critical sections overlap, it is necessary to ensure that the locking
 * order will always be the same.  Otherwise, a deadlock could happen.
 *
 * The API also provided the following extra routine:
 *
 *		spinlock_is_held()	-- returns whether someone holds the lock
 *
 * When SPINLOCK_DEBUG is defined, each spinlock remembers the location that
 * initially grabbed the lock, which can be useful when debugging deadlocks.
 *
 * @author Raphael Manfredi
 * @date 2011
 */

#ifndef _spinlock_h_
#define _spinlock_h_

#include "atomic.h"		/* For atomic_lock_t */
#include "thread.h"		/* For thread_check_suspended() */

#if 1
#define SPINLOCK_DEBUG			/* Tracks where we take the lock */
#endif
#if 0
#define SPINLOCK_OWNER_DEBUG	/* Tracks who takes the lock */
#include "thread.h"				/* For thread_small_id() */
#endif

enum spinlock_magic {
	SPINLOCK_MAGIC = 0x3918493e,
	SPINLOCK_DESTROYED = 0x132842f9
};

/**
 * A spinlock is just a memory location holding an integer value.
 *
 * When the integer is 0, the lock is available, when the integer is 1
 * the lock is busy.
 */
typedef struct spinlock {
	enum spinlock_magic magic;
	atomic_lock_t lock;
#ifdef SPINLOCK_OWNER_DEBUG
	uint8 stid;					/* Locking thread, for assertions & debug */
#endif
#ifdef SPINLOCK_DEBUG
	const char *file;
	unsigned line;
#endif
} spinlock_t;

/**
 * Static initialization value for a spinlock structure.
 */
#ifdef SPINLOCK_DEBUG
#ifdef SPINLOCK_OWNER_DEBUG
#define SPINLOCK_INIT	{ SPINLOCK_MAGIC, 0, -1, NULL, 0 }
#else
#define SPINLOCK_INIT	{ SPINLOCK_MAGIC, 0, NULL, 0 }
#endif
#else
#define SPINLOCK_INIT	{ SPINLOCK_MAGIC, 0 }
#endif

/*
 * These should not be called directly by user code to allow debugging.
 */

void spinlock_release(spinlock_t *s, bool hidden);

/*
 * Public interface.
 */

void spinlock_grab_from(spinlock_t *s,
	bool hidden, const char *file, unsigned line);
bool spinlock_grab_try_from(spinlock_t *s, bool hidden,
	const char *file, unsigned line);
void spinlock_grab_swap_from(spinlock_t *s, const void *plock,
	const char *file, unsigned line);
bool spinlock_grab_swap_try(spinlock_t *s, const void *plock,
	const char *file, unsigned line);
void spinlock_raw_from(spinlock_t *s, const char *file, unsigned line);

#define spinlock(x)		spinlock_grab_from((x), FALSE, _WHERE_, __LINE__)
#define spinlock_try(x)	spinlock_grab_try_from((x), FALSE, _WHERE_, __LINE__)

#define spinlock_const(x) \
	spinlock_grab_from(deconstify_pointer(x), FALSE, _WHERE_, __LINE__)

#define spinlock_try_const(x) \
	spinlock_grab_from(deconstify_pointer(x), FALSE, _WHERE_, __LINE__)

#define spinlock_hidden(x) \
	spinlock_grab_from((x), TRUE, _WHERE_, __LINE__)

#define spinlock_hidden_try(x) \
	spinlock_grab_try_from((x), TRUE, _WHERE_, __LINE__)

#define spinlock_swap(x,y) \
	spinlock_grab_swap_from((x), (y), _WHERE_, __LINE__)

#define spinlock_swap_try(x,y) \
	spinlock_grab_swap_try_from((x), (y), _WHERE_, __LINE__)

#define spinlock_raw(x)			spinlock_raw_from((x), _WHERE_, __LINE__)

#define spinunlock(x)			spinlock_release((x), FALSE)
#define spinunlock_hidden(x)	spinlock_release((x), TRUE)
#define spinunlock_raw(x)		spinlock_release((x), TRUE)

#define spinunlock_const(x)		spinlock_release(deconstify_pointer(x), FALSE)

#ifdef SPINLOCK_DEBUG
/*
 * Direct operations should only be used when locking and unlocking is
 * always done from a single thread, thereby not requiring that atomic
 * operations be used.
 *
 * These allow assertions like spinlock_is_held() without paying a huge
 * cost to the locking / unlocking process.
 */

#define spinlock_direct(x) G_STMT_START {	\
	(x)->lock = 1;							\
	(x)->file = _WHERE_;					\
	(x)->line = __LINE__;					\
} G_STMT_END

#define spinunlock_direct(x) G_STMT_START {	\
	(x)->lock = 0;							\
} G_STMT_END

#else	/* !SPINLOCK_DEBUG */

#define spinlock_direct(x) G_STMT_START {	\
	(x)->lock = 1;							\
} G_STMT_END

#define spinunlock_direct(x) G_STMT_START {	\
	(x)->lock = 0;							\
} G_STMT_END

#endif	/* SPINLOCK_DEBUG */

void spinlock_init(spinlock_t *s);
void spinlock_destroy(spinlock_t *s);
void spinlock_crash_mode(void);
void spinlock_exit_mode(void);

#if defined(SPINLOCK_SOURCE) || defined(MUTEX_SOURCE)

enum spinlock_source {
	SPINLOCK_SRC_SPINLOCK,
	SPINLOCK_SRC_MUTEX
};

const char *spinlock_source_string(enum spinlock_source src);

/**
 * Callback to signal possible deadlocking condition.
 */
typedef void (spinlock_deadlock_cb_t)(const volatile void *, unsigned,
	const char *file, unsigned line);

/**
 * Callback to abort on definitive deadlocking condition.
 */
typedef void (spinlock_deadlocked_cb_t)(const volatile void *, unsigned,
	const char *file, unsigned line);

void spinlock_loop(volatile spinlock_t *s,
	enum spinlock_source src, const void *src_object,
	spinlock_deadlock_cb_t deadlock, spinlock_deadlocked_cb_t deadlocked,
	const char *file, unsigned line);

#endif /* SPINLOCK_SOURCE || MUTEX_SOURCE */

#ifdef THREAD_SOURCE
void spinlock_reset(spinlock_t *s);
#endif	/* THREAD_SOURCE */

extern int spinlock_pass_through;

static inline bool
spinlock_in_crash_mode(void)
{
	if G_LIKELY(0 == atomic_int_get(&spinlock_pass_through))
		return FALSE;
	thread_check_suspended();
	return TRUE;
}

/**
 * Check that spinlock is held, for assertions.
 */
static inline bool NON_NULL_PARAM((1))
spinlock_is_held(const spinlock_t *s)
{
#ifdef SPINLOCK_OWNER_DEBUG
	if (thread_small_id() != s->stid)
		return FALSE;
#endif

	/* Make this fast, no assertion on the spinlock validity */
	return s->lock != 0 || spinlock_in_crash_mode();
}

/**
 * Fast version of spinlock_is_held() to be used when we do not want to
 * check the spinlock ownership, even with compiled with SPINLOCK_OWNER_DEBUG.
 */
static inline bool NON_NULL_PARAM((1))
spinlock_is_held_fast(const spinlock_t *s)
{
	/* Make this fast, no assertion on the spinlock validity */
	return s->lock != 0 || spinlock_in_crash_mode();
}

#endif /* _spinlock_h_ */

/* vi: set ts=4 sw=4 cindent: */
