/*-
 * Copyright (c) 2014-2018 MongoDB, Inc.
 * Copyright (c) 2008-2014 WiredTiger, Inc.
 *	All rights reserved.
 *
 * See the file LICENSE for redistribution information.
 */
#define	WT_COMPAT_MSG_PREFIX "Version incompatibility detected: "

#define	WT_DEBUG_POINT	((void *)(uintptr_t)0xdeadbeef)
#define	WT_DEBUG_BYTE	(0xab)

/* In DIAGNOSTIC mode, yield in places where we want to encourage races. */
#ifdef HAVE_DIAGNOSTIC
#define	WT_DIAGNOSTIC_YIELD do {					\
	__wt_yield();							\
} while (0)
#else
#define	WT_DIAGNOSTIC_YIELD
#endif

#define	__wt_err(session, error, ...)					\
	__wt_err_func(session, error, __func__, __LINE__, __VA_ARGS__)
#define	__wt_errx(session, ...)						\
	__wt_errx_func(session, __func__, __LINE__, __VA_ARGS__)
#define	__wt_set_return(session, error)					\
	__wt_set_return_func(session, __func__, __LINE__, error)

/* Set "ret" and branch-to-err-label tests. */
#define	WT_ERR(a) do {							\
	if ((ret = (a)) != 0)						\
		goto err;						\
} while (0)
#define	WT_ERR_MSG(session, v, ...) do {				\
	ret = (v);							\
	__wt_err(session, ret, __VA_ARGS__);				\
	goto err;							\
} while (0)
#define	WT_ERR_TEST(a, v) do {						\
	if (a) {							\
		ret = (v);						\
		goto err;						\
	} else								\
		ret = 0;						\
} while (0)
#define	WT_ERR_ERROR_OK(a, e)						\
	WT_ERR_TEST((ret = (a)) != 0 && ret != (e), ret)
#define	WT_ERR_BUSY_OK(a)	WT_ERR_ERROR_OK(a, EBUSY)
#define	WT_ERR_NOTFOUND_OK(a)	WT_ERR_ERROR_OK(a, WT_NOTFOUND)

/* Return tests. */
#define	WT_RET(a) do {							\
	int __ret;							\
	if ((__ret = (a)) != 0)						\
		return (__ret);						\
} while (0)
#define	WT_RET_TRACK(a) do {						\
	int __ret;							\
	if ((__ret = (a)) != 0)	{					\
		WT_TRACK_OP_END(session);				\
		return (__ret);						\
	}								\
} while (0)
#define	WT_RET_MSG(session, v, ...) do {				\
	int __ret = (v);						\
	__wt_err(session, __ret, __VA_ARGS__);				\
	return (__ret);							\
} while (0)
#define	WT_RET_TEST(a, v) do {						\
	if (a)								\
		return (v);						\
} while (0)
#define	WT_RET_ERROR_OK(a, e) do {					\
	int __ret = (a);						\
	WT_RET_TEST(__ret != 0 && __ret != (e), __ret);			\
} while (0)
#define	WT_RET_BUSY_OK(a)	WT_RET_ERROR_OK(a, EBUSY)
#define	WT_RET_NOTFOUND_OK(a)	WT_RET_ERROR_OK(a, WT_NOTFOUND)
/* Set "ret" if not already set. */
#define	WT_TRET(a) do {							\
	int __ret;							\
	if ((__ret = (a)) != 0 &&					\
	    (__ret == WT_PANIC ||					\
	    ret == 0 || ret == WT_DUPLICATE_KEY ||			\
	    ret == WT_NOTFOUND || ret == WT_RESTART))			\
		ret = __ret;						\
} while (0)
#define	WT_TRET_ERROR_OK(a, e) do {					\
	int __ret;							\
	if ((__ret = (a)) != 0 && __ret != (e) &&			\
	    (__ret == WT_PANIC ||					\
	    ret == 0 || ret == WT_DUPLICATE_KEY ||			\
	    ret == WT_NOTFOUND || ret == WT_RESTART))			\
		ret = __ret;						\
} while (0)
#define	WT_TRET_BUSY_OK(a)	WT_TRET_ERROR_OK(a, EBUSY)
#define	WT_TRET_NOTFOUND_OK(a)	WT_TRET_ERROR_OK(a, WT_NOTFOUND)

/* Called on unexpected code path: locate the failure. */
#define	__wt_illegal_value(session, v)					\
	__wt_illegal_value_func(session, (uintmax_t)(v), __func__, __LINE__)

/* Return and branch-to-err-label cases for switch statements. */
#define	WT_ILLEGAL_VALUE(session, v)					\
	default:							\
		return (__wt_illegal_value(session, v))
#define	WT_ILLEGAL_VALUE_ERR(session, v)				\
	default:							\
		ret = __wt_illegal_value(session, v);			\
		goto err

#define	WT_PANIC_MSG(session, v, ...) do {				\
	__wt_err(session, v, __VA_ARGS__);				\
	WT_IGNORE_RET(__wt_panic(session));				\
} while (0)
#define	WT_PANIC_ERR(session, v, ...) do {				\
	WT_PANIC_MSG(session, v, __VA_ARGS__);				\
	/* Return WT_PANIC regardless of earlier return codes. */	\
	WT_ERR(WT_PANIC);						\
} while (0)
#define	WT_PANIC_RET(session, v, ...) do {				\
	WT_PANIC_MSG(session, v, __VA_ARGS__);				\
	/* Return WT_PANIC regardless of earlier return codes. */	\
	return (WT_PANIC);						\
} while (0)

/*
 * WT_ASSERT
 *	Assert an expression, aborting in diagnostic mode.  Otherwise,
 * "use" the session to keep the compiler quiet and don't evaluate the
 * expression.
 */
#ifdef HAVE_DIAGNOSTIC
#define	WT_ASSERT(session, exp) do {					\
	if (!(exp)) {							\
		__wt_errx(session, "%s", #exp);				\
		__wt_abort(session);					\
	}								\
} while (0)
#else
#define	WT_ASSERT(session, exp)						\
	WT_UNUSED(session)
#endif

/*
 * __wt_verbose --
 *	Display a verbose message.
 *
 * Not an inlined function because you can't inline functions taking variadic
 * arguments and we don't want to make a function call in production systems
 * just to find out a verbose flag isn't set.
 *
 * The macro must take a format string and at least one additional argument,
 * there's no portable way to remove the comma before an empty __VA_ARGS__
 * value.
 */
#define	__wt_verbose(session, flag, fmt, ...) do {			\
	if (WT_VERBOSE_ISSET(session, flag))				\
		__wt_verbose_worker(session, fmt, __VA_ARGS__);		\
} while (0)