logEvent.h

/*  _________________________________________________________________________
 *
 *  UTILIB: A utility library for developing portable C++ codes.
 *  Copyright (c) 2001, Sandia National Laboratories.
 *  This software is distributed under the GNU Lesser General Public License.
 *  For more information, see the README file in the top UTILIB directory.
 *  _________________________________________________________________________
 */

//
// logEvent.H
//
#ifndef __logEvent_H
#define __logEvent_H

#ifdef __GNUC__
#pragma interface
#endif

#if defined(USING_MPI) && defined(DEBUGGING) && defined(MPE)

#include "paramTable.h"

#include <values.h>
#include "mpi.h"
#include "mpe.h"


class logEvent
{
public:

  CLASS_PARAMETER(eventLog);

  enum { undefinedState = -MAXINT };

  static void init()  { MPE_Init_log(); };

  static void open();

  static void close();

  static int defineState(const char* description,const char* color);

  static void log_start(int stateNumber) { event(stateNumber*2); };
  static void log_end(int stateNumber)   { event(stateNumber*2 + 1); };

  static void log_point(int stateNumber)
    {
      log_start(stateNumber);
      log_end(stateNumber);
    };
  
private:

  static void event(int eventNumber) 
    { 
      MPE_Log_event(eventNumber,0,(char *) ""); 
    };

  static int numberOfStates;

};


#define IF_LOGGING_COMPILED(arbitraryCode) arbitraryCode

#define IF_LOGGING_EVENTS(level,action) \
   if (logEvent::eventLog() >= level) action

#define LOG_EVENT(level,how,state) \
   IF_LOGGING_EVENTS(level,logEvent::log_##how(state);)

#define LOG_EVENT_CONDITIONAL(level,cond,how,state) \
   IF_LOGGING_EVENTS(level,if (cond) logEvent::log_##how(state);)

#define EVENT_LOGGING_PRESENT 1


#else


#define IF_LOGGING_COMPILED(arbitraryCode)          /* Nothing */
#define IF_LOGGING_EVENTS(level,action)             /* Nothing */
#define LOG_EVENT(level,how,state)                  /* Nothing */
#define LOG_EVENT_CONDITIONAL(level,cond,how,state) /* Nothing */
#undef  EVENT_LOGGING_PRESENT


#endif


#endif