source: trunk/IPs/systemC/processor/Morpheo/Common/include/Debug.h @ 129

#ifndef Morpheo_Debug_h
#define Morpheo_Debug_h

/*
 * $Id: Debug.h 129 2009-06-29 16:38:40Z rosiere $
 *
 * [ Description ]
 * 
 * function to help the debugging :
 *
 *  - log_printf
 *  - log_begin
 *  - log_end
 *  - log_function
 *  - msg_print
 *  - breakpoint
 *
 *  Debug's Level :
 *  - None    : print elementary information
 *  - Info    : print basic information
 *  - Trace   : trace internal variable
 *  - Func    : trace call and return function
 *  - All     : print all information
 */

#include "Common/include/Debug_type.h"
#include "Common/include/Systemc.h"
#include "Common/include/Message.h"
#include "Common/include/FromString.h"
#include "Common/include/ChangeCase.h"
#include "Behavioural/include/Debug_component.h"
#include "Behavioural/include/Model.h"
#include "Behavioural/include/Simulation.h"
#include <systemc.h>
#include <stdio.h>
#include <string.h>
#include <iostream>
#include <sstream>
#include <string>
#include "Common/include/MemCheck.h"

namespace morpheo {

// typedef enum 
//   {
//     DEBUG_NONE ,
//     DEBUG_INFO ,
//     DEBUG_TRACE,
//     DEBUG_FUNC ,
//     DEBUG_ALL
//   } debug_verbosity_t;

  extern debug_verbosity_t debug;
  extern bool              debug_cycle_test;
  extern double            debug_cycle_start;
  extern double            debug_cycle_stop ;
  extern double            debug_idle_cycle;
  extern uint32_t          debug_idle_time;

  void        debug_init    (void);
  void        debug_init    (debug_verbosity_t level,
                             double            cycle_start,
                             double            cycle_stop ,
                             double            idle_cycle ,
                             uint32_t          idle_time  );

#ifdef SYSTEMC
#define debug_test_simulation_time                                      \
  (not debug_cycle_test or                                              \
   ( (simulation_cycle() >= debug_cycle_start) and                    \
    ((simulation_cycle() <= debug_cycle_stop) or                      \
      (debug_cycle_stop == -1))))
#else
#define debug_test_simulation_time true
#endif
  
#ifdef DEBUG
# define log_printf(level, component, func, str... )                    \
  do                                                                    \
    {                                                                   \
      debug_init();                                                     \
                                                                        \
      if (debug_test_simulation_time and                                \
          ((debug == DEBUG_ALL ) or                                     \
           (( DEBUG_ ## level <= debug) and                             \
            ( morpheo::behavioural::_model.get_debug(NAME_ ## component))))) \
        {                                                               \
          if (DEBUG_ ## level <= DEBUG_INFO)                            \
            {                                                           \
              msg("%s ",MSG_INFORMATION);                               \
            }                                                           \
          else                                                          \
            {                                                           \
              msg("%s ",MSG_DEBUG);                                     \
            }                                                           \
                                                                        \
          if (debug >= DEBUG_FUNC)                                      \
            {                                                           \
              msg(  "<%s> " ,func);                                     \
              msg(_("In file %s, "),__FILE__);                          \
              msg(_("at line %d " ),__LINE__);                          \
              msg(  ": " );                                             \
            }                                                           \
          msg(str);                                                     \
          msg("\n");                                                    \
        }                                                               \
    } while(0)

# define log_begin(component, func)                                     \
  do                                                                    \
    {                                                                   \
      log_printf(FUNC,component,func,_("Begin"));                       \
    } while(0)

# define log_end(component, func)                                       \
  do                                                                    \
    {                                                                   \
      log_printf(FUNC,component,func,_("End"));                         \
    } while(0)

#else
# define log_printf(level, component, func, str... )                    \
  do                                                                    \
    {                                                                   \
    } while(0)

# define log_begin(component, func)                                     \
  do                                                                    \
    {                                                                   \
    } while(0)

# define log_end(component, func)                                       \
  do                                                                    \
    {                                                                   \
    } while(0)

#endif // DEBUG

# define log_function(component,func,name)                              \
  do                                                                    \
    {                                                                   \
      log_printf(TRACE,component,func,_("[%d] %s.%s"),static_cast<uint32_t>(simulation_cycle()),name,func); \
    } while(0)


#define msg_printf(type,str...)                                         \
  do                                                                    \
    {                                                                   \
      msg("%s ",MSG_ ## type);                                          \
      msg(str);                                                         \
      msg("\n");                                                        \
    } while(0)


#define breakpoint(str...)                                              \
  do                                                                    \
    {                                                                   \
      fprintf(stdout,_("%s "),MSG_BREAKPOINT);                                     \
      fprintf(stdout,_("Breakpoint in file %s, line %d.\n"),__FILE__,__LINE__);    \
      fprintf(stdout,_("%s "),MSG_NONE);                                           \
      fprintf(stdout,str);                                                              \
      fprintf(stdout,_("\n"));                                                     \
      fprintf(stdout,_("%s "),MSG_NONE);                                           \
      fprintf(stdout,_("Enter any key to continue\n"));                            \
      getchar();                                                        \
    } while(0)

#ifdef DEBUG_TEST
#define TEST_PTR(x)                                                     \
  do                                                                    \
    {                                                                   \
      if (x == NULL)                                                    \
        err(_("File %s, Line %d, this pointeur is null\n"),__FILE__,__LINE__); \
    }                                                                   \
  while (0)
#else
#define TEST_PTR(x)      \
  do                     \
    {                    \
    }                    \
  while (0)
#endif


  template<> inline debug_verbosity_t fromString<debug_verbosity_t> (const std::string& x)
  {
    std::string y=x;
    LowerCase(y);

    if ( (y.compare("0")     == 0) or
         (y.compare("none")  == 0))
      return DEBUG_NONE ;
    if ( (y.compare("1")     == 0) or
         (y.compare("info")  == 0))
      return DEBUG_INFO ;
    if ( (y.compare("2")     == 0) or
         (y.compare("trace") == 0))
      return DEBUG_TRACE;
    if ( (y.compare("3")     == 0) or
         (y.compare("func")  == 0))
      return DEBUG_FUNC ;
    if ( (y.compare("4")     == 0) or
         (y.compare("all")   == 0))
      return DEBUG_ALL  ;

#ifdef DEBUG
    return DEBUG;
#else
    return DEBUG_NONE ;
#endif
  }

}; // end namespace morpheo
#endif // !DEBUG_H