Debug.h

Go to the documentation of this file.

#ifndef DEBUG_H
#define DEBUG_H

// assert enabled by compiling with USE_ASSERT
#undef ASSERT
#ifdef USE_ASSERT
#define ASSERT(expr) \
  do { \
    if ( !(expr) ) { \
      char msg[256]; \
      snprintf(msg, sizeof(msg), "ASSERT: \"%s\" " \
          "(%s, %d)\n", #expr, __FILE__, __LINE__); \
      NAMD_die(msg); \
    } \
  } while (0)  // requires terminating semi-colon
#else
#define ASSERT(expr)
#endif // USE_ASSERT

#ifndef MIN_DEBUG_LEVEL
  #define MIN_DEBUG_LEVEL 0
#endif
#ifndef MAX_DEBUG_LEVEL
  #define MAX_DEBUG_LEVEL 10
#endif
#ifndef STDERR_LEVEL
  /* anything >= this error level goes to stderr */
  #define STDERR_LEVEL 5
#endif


/*****************************************************************
 *  DebugM(): function to display a debug message.
 *  Messages have different levels.  The low numbers are low severity
 *  while the high numbers are really important.  Very high numbers
 *  are sent to stderr rather than stdout.
 *  The default severity scale is from 0 to 10.
 *     0 = plain message
 *     4 = important message
 *     5 = warning (stderr)
 *     10 = CRASH BANG BOOM error (stderr)
 *  The remaining args are like printf: a format string and some args.
 *  This function can be turned off by compiling without the DEBUGM flag
 *  No parameters to this function should have a side effect!
 *  No functions should be passed as parameters!  (including inline)
 *****************************************************************/

 #ifdef DEBUGM

#include "InfoStream.h"

  #define Debug(x) (x)
  #define DebugM(level,format) \
        { \
          if ((level >= MIN_DEBUG_LEVEL) && (level <= MAX_DEBUG_LEVEL)) \
          { \
            infostream Dout; \
            if (level >= STDERR_LEVEL)  Dout << "[ERROR " << level << "] "; \
            else if (level > 0) Dout << "[Debug " << level << "] "; \
            Dout << iPE << ' ' << iFILE; \
            Dout << format << endi; \
          } \
        }

 #else
  /* make a void function. */
  /* parameters with side effects will be removed! */
  #define Debug(x) ;
  #define DebugM(x,y)   ;

 #endif /* DEBUGM */

#ifdef PROCTRACE_DEBUG
#include "charm++.h"
#include <stdarg.h>
#include "ProcessorPrivate.h"
class DebugFileTrace{
private:
    char *fname;
    FILE *fp;
public:
    inline static DebugFileTrace *Instance(char *fn){
        if(CkpvAccess(DebugFileTrace_instance)==0){
            CkpvAccess(DebugFileTrace_instance) = new DebugFileTrace(fn);
        }
        return CkpvAccess(DebugFileTrace_instance);
    }
    inline static DebugFileTrace *Object(){
        return CkpvAccess(DebugFileTrace_instance);
    }
    DebugFileTrace(char *fn){
        if(fn==NULL) {
            fname = NULL;
            fp = stdout;
            return;
        }else{
            char tmp[128];
            memset(tmp, 0, 128*sizeof(char));
            sprintf(tmp, "%s.%d", fn, CkMyPe());
            fname = new char[strlen(tmp)+1];
            memcpy(fname, tmp, strlen(tmp)+1);
            fp = fopen(fname, "w");
            fclose(fp);
        }
    }
    ~DebugFileTrace(){
        delete [] fname;
    }
    inline void writeTrace(const char *msg, ...){
        va_list argList;
        va_start(argList, msg);
        vfprintf(fp, msg, argList);
        va_end(argList);
    }   
    inline int openTrace(){ 
        if(fname==NULL)  return 0;
        fp = fopen(fname, "a"); 
        if(fp==NULL)
            return 1;
        else
            return 0;
    }
    inline int closeTrace(){ 
        if(fname==NULL)  return 0;
        return fclose(fp); 
    }
    inline int flushTrace(){
        return fflush(fp);
    }
};
#endif


#undef D_MSG
#undef D_STR
#undef D_INT
#undef D_REAL
#undef D_REXP
#undef D_VEC

#ifdef NL_DEBUG

#define D_MSG(t) \
  fprintf(stderr, "DEBUG: %s:%d: %s\n", __FILE__, __LINE__, t)
#define D_STR(t) \
  fprintf(stderr, "DEBUG: %s:%d: %s=\"%s\"\n", __FILE__, __LINE__, #t, t)
#define D_INT(n) \
  fprintf(stderr, "DEBUG: %s:%d: %s=%d\n", __FILE__, __LINE__, #n, n)
#define D_REAL(r) \
  fprintf(stderr, "DEBUG: %s:%d: %s=%g\n", __FILE__, __LINE__, #r, double(r))
#define D_REXP(r) \
  fprintf(stderr, "DEBUG: %s:%d: %s=%e\n", __FILE__, __LINE__, #r, double(r))
#define D_VEC(v) \
  fprintf(stderr, "DEBUG: %s:%d: %s=%g %g %g\n", __FILE__, __LINE__, \
      #v, double(v.x), double(v.y), double(v.z))

#else

#define D_MSG(t)
#define D_STR(t)
#define D_INT(t)
#define D_REAL(t)
#define D_REXP(t)
#define D_VEC(t)

#endif // NL_DEBUG


#endif /* DEBUG_H */