/*
 * OXT - OS eXtensions for boosT
 * Provides important functionality necessary for writing robust server software.
 *
 * Copyright (c) 2010 Phusion
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _OXT_MACROS_HPP_
#define _OXT_MACROS_HPP_

/**
 * Specialized macros.
 *
 * These macros provide more specialized features which are not needed
 * so often by application programmers.
 */

#if (defined(__GNUC__) && (__GNUC__ > 2) && !defined(OXT_DEBUG)) || defined(IN_DOXYGEN)
	/**
	 * Indicate that the given expression is likely to be true.
	 * This allows the CPU to better perform branch prediction.
	 *
	 * Defining OXT_DEBUG will cause this macro to become an
	 * empty stub.
	 */
	#define OXT_LIKELY(expr) __builtin_expect((expr), 1)
	
	/**
	 * Indicate that the given expression is likely to be false.
	 * This allows the CPU to better perform branch prediction.
	 *
	 * Defining OXT_DEBUG will cause this macro to become an
	 * empty stub.
	 */
	#define OXT_UNLIKELY(expr) __builtin_expect((expr), 0)
#else
	#define OXT_LIKELY(expr) expr
	#define OXT_UNLIKELY(expr) expr
#endif

#endif /* _OXT_MACROS_HPP_ */
