debug.h

/* MLPACK 0.2
 *
 * Copyright (c) 2008, 2009 Alexander Gray,
 *                          Garry Boyer,
 *                          Ryan Riegel,
 *                          Nikolaos Vasiloglou,
 *                          Dongryeol Lee,
 *                          Chip Mappus, 
 *                          Nishant Mehta,
 *                          Hua Ouyang,
 *                          Parikshit Ram,
 *                          Long Tran,
 *                          Wee Chin Wong
 *
 * Copyright (c) 2008, 2009 Georgia Institute of Technology
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */
#ifndef BASE_DEBUG_H
#define BASE_DEBUG_H

#include "fastlib/base/common.h"

#ifdef DEBUG
#define DEBUG_ONLY if (0) NOP; else
#else
#define DEBUG_ONLY if (1) NOP; else
#endif

#ifdef VERBOSE
#define VERBOSE_ONLY if (0) NOP; else
#else
#define VERBOSE_ONLY if (1) NOP; else
#endif

#ifdef PROFILE
#define PROFILE_ONLY if (0) NOP; else
#else
#define PROFILE_ONLY if (1) NOP; else
#endif

extern double verbosity_level;
extern int print_got_heres;
extern int print_warnings;

#define VERBOSE_MSG(min_verbosity, msg_params...) \
    VERBOSE_ONLY( \
        unlikely(verbosity_level >= (min_verbosity)) \
            ? NOTIFY(msg_params) : NOP)

#define VERBOSE_GOT_HERE(min_verbosity) \
    VERBOSE_ONLY( \
        unlikely(print_got_heres && verbosity_level >= (min_verbosity)) \
            ? NOTIFY("Got to line %d of %s", __LINE__, __FUNCTION__) : NOP)

#define DEBUG_WARNING_MSG_IF(cond, msg_params...) \
    DEBUG_ONLY(unlikely((cond) && print_warnings) \
        ? NONFATAL(msg_params) : NOP)
#define DEBUG_WARN_MSG_IF DEBUG_WARNING_MSG_IF

#define DEBUG_WARNING_IF(cond) \
    DEBUG_WARNING_MSG_IF(cond, "warning: " #cond)
#define DEBUG_WARN_IF DEBUG_WARNING_IF

#define DEBUG_ERROR_MSG_IF(cond, msg_params...) \
    DEBUG_ONLY(unlikely(cond) \
        ? FATAL(msg_params) : NOP)
#define DEBUG_ERR_MSG_IF DEBUG_ERROR_MSG_IF

#define DEBUG_ERROR_IF(cond) \
    DEBUG_ERROR_MSG_IF(cond, "error: " #cond)
#define DEBUG_ERR_IF DEBUG_ERROR_IF

#define DEBUG_ASSERT_MSG(cond, msg_params...) \
    DEBUG_ONLY(likely(cond) \
        ? NOP : FATAL(msg_params))

#define DEBUG_ASSERT(cond) \
    DEBUG_ASSERT_MSG(cond, "assertion failure: %s", #cond)

#define BIG_BAD_NUMBER 2146666666

#define BIG_BAD_POINTER(type) (REINTERPRET_CAST(type *, 0xDEADBEEF))

#ifdef __cplusplus
template<typename T>
const T *poison_ptr(T *&x) {
  return x = BIG_BAD_POINTER(T);
}
#else
#define poison_ptr(x) ((x) = BIG_BAD_POINTER(void))
#endif

#define DEBUG_POISON_PTR(x) DEBUG_ONLY(poison_ptr(x))

#define DEBUG_BOUNDS(x, bound) \
    DEBUG_ASSERT_MSG(STATIC_CAST(uint64, x) < STATIC_CAST(uint64, bound), \
        "DEBUG_BOUNDS failed: %s = %"L64"d not in [0, %s = %"L64"d)\n", \
        #x, STATIC_CAST(int64, x), #bound, STATIC_CAST(int64, bound))

#define DEBUG_BOUNDS_INCLUSIVE(x, bound) \
    DEBUG_ASSERT_MSG(STATIC_CAST(uint64, x) <= STATIC_CAST(uint64, bound), \
        "DEBUG_BOUNDS failed: %s = %"L64"d not in [0, %s = %"L64"d]\n", \
        #x, STATIC_CAST(int64, x), #bound, STATIC_CAST(int64, bound))

#define DEBUG_SAME_INT(x, y) \
    DEBUG_ASSERT_MSG((x) == (y), \
        "DEBUG_SAME_INT failed: %s = %"L64"d not equal to %s = %"L64"d\n", \
        #x, STATIC_CAST(int64, x), #y, STATIC_CAST(int64, y))

#define DEBUG_SAME_SIZE(x, y) \
    DEBUG_ASSERT_MSG((x) == (y), \
        "DEBUG_SAME_SIZE failed: %s = %"L64"d not equal to %s = %"L64"d\n", \
        #x, STATIC_CAST(int64, x), #y, STATIC_CAST(int64, y))

#define DEBUG_SAME_DOUBLE(x, y) \
    DEBUG_ASSERT_MSG((x) == (y), \
        "DEBUG_SAME_DOUBLE failed: %s = %g not equal to %s = %g\n", \
        #x, STATIC_CAST(double, x), #y, STATIC_CAST(double, y))

#define DEBUG_APPROX_DOUBLE(x, y, eps) \
    DEBUG_ASSERT_MSG(fabs(STATIC_CAST(double, (x) - (y))) < eps, \
        "DEBUG_APPROX_DOUBLE failed: %s = %g not within %g of %s = %g\n", \
        #x, STATIC_CAST(double, x), STATIC_CAST(double, eps), \
        #y, STATIC_CAST(double, y))

#endif /* BASE_DEBUG_H */