tau 2.17.3.1.dfsg-4 / usr / lib / tau / include / Profile / Profiler.h

/****************************************************************************
**			TAU Portable Profiling Package			   **
**			http://www.cs.uoregon.edu/research/tau	           **
*****************************************************************************
**    Copyright 1997  						   	   **
**    Department of Computer and Information Science, University of Oregon **
**    Advanced Computing Laboratory, Los Alamos National Laboratory        **
****************************************************************************/
/***************************************************************************
**	File 		: Profiler.h					  **
**	Description 	: TAU Profiling Package				  **
**	Author		: Sameer Shende					  **
**	Contact		: sameer@cs.uoregon.edu sameer@acl.lanl.gov 	  **
**	Flags		: Compile with				          **
**			  -DPROFILING_ON to enable profiling (ESSENTIAL)  **
**			  -DPROFILE_STATS for Std. Deviation of Excl Time **
**			  -DSGI_HW_COUNTERS for using SGI counters 	  **
**			  -DPROFILE_CALLS  for trace of each invocation   **
**			  -DSGI_TIMERS  for SGI fast nanosecs timer	  **
**			  -DTULIP_TIMERS for non-sgi Platform	 	  **
**			  -DPOOMA_STDSTL for using STD STL in POOMA src   **
**			  -DPOOMA_TFLOP for Intel Teraflop at SNL/NM 	  **
**			  -DPOOMA_KAI for KCC compiler 			  **
**			  -DDEBUG_PROF  for internal debugging messages   **
**                        -DPROFILE_CALLSTACK to enable callstack traces  **
**	Documentation	: See http://www.cs.uoregon.edu/research/tau      **
***************************************************************************/
#ifndef PROFILER_H
#define PROFILER_H

#if (defined(TAU_WINDOWS))
#pragma warning( disable : 4786 )
#define TAUDECL __cdecl
#else
#define TAUDECL
#endif /* TAU_WINDOWS */

#if (!defined(TAU_LIBRARY_SOURCE) && !defined(TAU_WINDOWS))

#include <sys/types.h>
#include <unistd.h>

#undef fork
#define fork() \
        tau_fork()

#ifdef __cplusplus
extern "C" 
#endif
pid_t tau_fork (void);

#ifdef PTHREADS
/* pthread_create wrapper */

#include <pthread.h>
#undef pthread_create
#define pthread_create(thread, attr, function, arg) \
        tau_pthread_create(thread, attr, function, arg)

#define pthread_exit(arg) \
        tau_pthread_exit(arg)

#ifdef __cplusplus
extern "C" 
#endif
int tau_pthread_create (pthread_t *threadp,
			const pthread_attr_t *attr,
			void *(*start_routine) (void *),
			void *arg);
void tau_pthread_exit (void *arg);

#endif /* PTHREADS */
#endif /* TAU_LIBRARY_SOURCE */


/* This is to get TAU_START/TAU_STOP since some codes just #include <Profile/Profiler.h> */
#include <TAU.h>



#ifdef TAU_MULTIPLE_COUNTERS
#define MAX_TAU_COUNTERS 25
#else
#define MAX_TAU_COUNTERS 1
#endif

#if (defined(PTHREADS) || defined(TULIPTHREADS) || defined(JAVA) || defined(TAU_WINDOWS) || defined (TAU_OPENMP) || defined (TAU_SPROC) || defined(TAU_PAPI_THREADS))


#ifndef TAU_MAX_THREADS

#ifdef TAU_CHARM
#define TAU_MAX_THREADS 512
#else
#define TAU_MAX_THREADS 128
#endif

#endif

#else
#define TAU_MAX_THREADS 1
#endif /* PTHREADS || TULIPTHREADS || JAVA || TAU_WINDOWS || OPENMP || SPROC */




#if (defined (__cplusplus ) && !defined (TAU_USE_C_API))

#include <Profile/ProfileGroups.h>
#include <Profile/TauAPI.h>

#if (defined(PROFILING_ON) || defined(TRACING_ON))

#include <Profile/ProfileHeaders.h>
#include <Profile/PthreadLayer.h>
#include <Profile/TulipThreadLayer.h>
#include <Profile/JavaThreadLayer.h>
#include <Profile/SprocLayer.h>
#include <Profile/PapiThreadLayer.h>
#include <Profile/RtsLayer.h>
#include <Profile/FunctionInfo.h>
#include <Profile/UserEvent.h>
#include <Profile/PclLayer.h>
#include <Profile/PapiLayer.h>
#include <Profile/MultipleCounters.h>
#include <Profile/WindowsThreadLayer.h>
#include <Profile/TauMemory.h>
#include <Profile/TauScalasca.h>
#include <Profile/TauMuse.h>
#include <Profile/TauCompensate.h>
#include <Profile/TauHandler.h>
#include <Profile/TauEnv.h>

#if defined(TAUKTAU)
class KtauProfiler;
#ifdef TAUKTAU_MERGE
#include <Profile/KtauMergeInfo.h>
#endif /* defined(TAUKTAU_MERGE) */
#endif /* defined(TAUKTAU) */


/*
//////////////////////////////////////////////////////////////////////
//
// class Profiler
//
// This class is intended to be instantiated once per function
// (or other code block to be timed) as an auto variable.
//
// It will be constructed each time the block is entered
// and destroyed when the block is exited.  The constructor
// turns on the timer, and the destructor turns it off.
//
//////////////////////////////////////////////////////////////////////
*/
namespace tau {
class Profiler
{
public:
  Profiler(FunctionInfo * fi, TauGroup_t ProfileGroup = TAU_DEFAULT, 
	   bool StartStop = false, int tid = RtsLayer::myThread());
  
  void Start(int tid = RtsLayer::myThread());
  Profiler(const Profiler& X);
  Profiler& operator= (const Profiler& X);
  /* Clean up data from this invocation. */
  void Stop(int tid = RtsLayer::myThread(), bool useLastTimeStamp = false);
  ~Profiler();
#ifdef TAU_CALLPATH
  void CallPathStart(int tid);
#ifdef TAU_MULTIPLE_COUNTERS
  void CallPathStop(double* totaltime, int tid);
#else  /* TAU_MULTIPLE_COUNTERS  */
  void CallPathStop(double totaltime, int tid);
#endif /* TAU_MULTIPLE_COUNTERS  */
#endif /* TAU_CALLPATH  */
  
#ifdef TAU_PROFILEPARAM
#ifdef TAU_MULTIPLE_COUNTERS
  void ProfileParamStop(double* totaltime, int tid);
#else  /* TAU_MULTIPLE_COUNTERS  */
  void ProfileParamStop(double totaltime, int tid);
#endif /* TAU_MULTIPLE_COUNTERS */
#endif /* TAU_PROFILEPARAM */
  

  static int updateIntermediateStatistics(int tid);

  static void ProfileExit(const char *message=0, 
			  int tid = RtsLayer::myThread());
  static bool createDirectories();
  static int StoreData(int tid = RtsLayer::myThread()); 
  static int DumpData(bool increment = false, int tid = RtsLayer::myThread(), const char *prefix = "dump"); 

  static int writeData(int tid, const char *prefix = "profile", bool increment = false, 
		       const char **inFuncs = NULL, int numFuncs = 0);

  static void PurgeData(int tid = RtsLayer::myThread());
  static int Snapshot(const char *name, bool finalize = false,
		      int tid = RtsLayer::myThread()); 
  static void theFunctionList(const char ***inPtr, int *numOfFunctions,
			      bool addName = false, const char * inString = NULL);
  static void dumpFunctionNames();
  static void theCounterList(const char ***inPtr, int *numOfCounters);
  
  static void getFunctionValues(const char **inFuncs,
				int numFuncs,
				double ***counterExclusiveValues,
				double ***counterInclusiveValues,
				int **numOfCalls,
				int **numOfSubRoutines,
				const char ***counterNames,
				int *numOfCounters,
				int tid = RtsLayer::myThread());
  static int dumpFunctionValues(const char **inFuncs,
				int numFuncs,
				bool increment = false,
				int tid = RtsLayer::myThread(), 
				char *prefix = "dump");
  
  static void getUserEventList(const char ***inPtr, int *numUserEvents);
  
  static void getUserEventValues(const char **inUserEvents, int numUserEvents,
				 int **numEvents, double **max, double **min,
				 double **mean, double **sumSqr, 
				 int tid = RtsLayer::myThread());
  
#if ( defined(PROFILE_CALLS) || defined(PROFILE_STATS) || defined(PROFILE_CALLSTACK) ) 
  int ExcludeTimeThisCall(double t);
  double ExclTimeThisCall; /* for this invocation of the function */
#endif /* PROFILE_CALLS || PROFILE_STATS */
  
  static Profiler * CurrentProfiler[TAU_MAX_THREADS];

  double *getStartValues();
  
#ifndef TAU_MULTIPLE_COUNTERS
  double StartTime;
#else /* TAU_MULTIPLE_COUNTERS */
  double StartTime[MAX_TAU_COUNTERS];
  double CurrentTime[MAX_TAU_COUNTERS];
  double TotalTime[MAX_TAU_COUNTERS];
#endif /* TAU_MULTIPLE_COUNTERS */
  FunctionInfo * ThisFunction;
#ifdef TAU_CALLPATH
  FunctionInfo * CallPathFunction;
  bool 	       AddInclCallPathFlag; 
#endif /* TAU_CALLPATH */
#ifdef TAU_PROFILEPARAM
  FunctionInfo * ProfileParamFunction; 
  bool 	       AddInclProfileParamFlag; 
  static void AddProfileParamData(long key, string& keyname);
#endif /* TAU_PROFILEPARAM */
#ifdef TAU_COMPENSATE
  /* Compensate for instrumentation overhead based on total number of 
     child calls executed under the given timer */
  long NumChildren;
  void SetNumChildren(long n);
  long GetNumChildren(void);
  void AddNumChildren(long value);
#endif /* TAU_COMPENSATE */
  Profiler * ParentProfiler; 
  
  
  
#ifdef PROFILE_CALLSTACK
  double InclTime_cs;
  double ExclTime_cs;
  static void CallStackTrace(int tid = RtsLayer::myThread());
#endif /* PROFILE_CALLSTACK  */
#ifdef TAU_PROFILEPHASE
  bool GetPhase(void);
  void SetPhase(bool flag);
#endif /* TAU_PROFILEPHASE */
#ifdef TAU_DEPTH_LIMIT
  int  GetDepthLimit(void);
  void SetDepthLimit(int value);
#endif /* TAU_DEPTH_LIMIT */ 
#ifdef TAU_MPITRACE
  void EnableAllEventsOnCallStack(int tid, Profiler *current);
#endif /* TAU_MPITRACE */
  
#if defined(TAUKTAU)
  KtauProfiler* ThisKtauProfiler;
#if defined(TAUKTAU_MERGE)
  KtauMergeInfo ThisKtauMergeInfo;
#endif /* TAUKTAU_MERGE */
#endif /* TAUKTAU */
  
private:
  TauGroup_t MyProfileGroup_;
  bool	StartStopUsed_;
  bool 	AddInclFlag; 
  /* There is a class that will do some initialization
	   of FunctionStack that can't be done with
	   just the constructor.
	   friend class ProfilerInitializer; */
  bool 	PhaseFlag;
#ifdef TAU_DEPTH_LIMIT
  int  profiledepth; 
#endif /* TAU_DEPTH_LIMIT */
  
#ifdef TAU_MPITRACE
  bool 	RecordEvent; /* true when an MPI call is in the callpath */
#endif /* TAU_MPITRACE */
};
};
#ifdef TAU_LIBRARY_SOURCE
using tau::Profiler;
#endif /* TAU_LIBRARY_SOURCE */



#endif /* PROFILING_ON || TRACING_ON */
#include <Profile/TauMapping.h>
/* included after class Profiler is defined. */
#else /* __cplusplus && ! TAU_USE_C_API */
#include <Profile/TauCAPI.h> /* For C program */
#endif /* __cplusplus && ! TAU_USE_C_API */

#endif /* PROFILER_H */
/***************************************************************************
 * $RCSfile: Profiler.h,v $   $Author: amorris $
 * $Revision: 1.84 $   $Date: 2008/06/06 23:15:30 $
 * POOMA_VERSION_ID: $Id: Profiler.h,v 1.84 2008/06/06 23:15:30 amorris Exp $ 
 ***************************************************************************/