tau_mapping_profile(3) [debian man page]

TAU_MAPPING_PROFILE(3)						  TAU Mapping API					    TAU_MAPPING_PROFILE(3)

NAME

       TAU_MAPPING_PROFILE - Profiles a block based on a mapping

SYNOPSIS

       C/C++:

       TAU_MAPPING_PROFILE(FunctionInfo *FuncIdVar);

DESCRIPTION

       The TAU_MAPPING_PROFILE macro measures the time and attributes it to the statement mapped in TAU_MAPPING macro. It takes as its argument
       the identifier of the higher level statement that is stored using TAU_MAPPING_OBJECT and linked to the statement using TAU_MAPPING_LINK
       macros.	TAU_MAPPING_PROFILE measures the time spent in the entire block in which it is invoked. For example, if the time spent in the run
       method of the class does work that must be associated with the higher-level array expression, then, we can instrument it as follows:

EXAMPLE

       C/C++ :

       // Evaluate the kernel
       // Just tell an InlineEvaluator to do it.

       template<class LHS,class Op,class RHS,class EvalTag>
       void
       ExpressionKernel<LHS,Op,RHS,EvalTag>::run() {
	 TAU_MAPPING_PROFILE(TauMapFI)

	 // Just evaluate the expression.
	 KernelEvaluator<EvalTag>().evalate(lhs_m,op_m,rhs_m);
	 // we could release the locks here or in dtor
       }

SEE ALSO

       TAU_MAPPING_CREATE(3), TAU_MAPPING_LINK(3), TAU_MAPPING_OBJECT(3)

								    08/31/2005						    TAU_MAPPING_PROFILE(3)

TAU_MAPPING_CREATE(3)						  TAU Mapping API					     TAU_MAPPING_CREATE(3)

NAME

       TAU_MAPPING_CREATE - Creates a mapping

SYNOPSIS

       C/C++:

       TAU_MAPPING_CREATE(char *name, char *type, char *groupname, unsigned long key, int tid);

DESCRIPTION

       TAU_MAPPING_CREATE creates a mapping and associates it with the key that is specified. Later, this key may be used to retrieve the
       FunctionInfo object associated with this key for timing purposes. The thread identifier is specified in the tid parameter.

EXAMPLE

       C/C++ :

       class MyClass {
	 public:
	   MyClass() {
	     TAU_MAPPING_LINK(runtimer, TAU_USER);
	   }
	   ~MyClass() {}

	   void Run(void) {
	     TAU_MAPPING_PROFILE(runtimer); // For one object
	     TAU_PROFILE("MyClass::Run()", " void (void)", TAU_USER1);

	     cout <<"Sleeping for 2 secs..."<<endl;
	     sleep(2);
	   }
	 private:
	   TAU_MAPPING_OBJECT(runtimer)  // EMBEDDED ASSOCIATION
       };

       int main(int argc, char **argv) {
	 TAU_PROFILE_INIT(argc, argv);
	 TAU_PROFILE("main()", "int (int, char **)", TAU_DEFAULT);
	 MyClass x, y, z;
	 TAU_MAPPING_CREATE("MyClass::Run() for object a", " " , TAU_USER,
			    "TAU_USER", 0);
	 MyClass a;
	 TAU_PROFILE_SET_NODE(0);
	 cout <<"Inside main"<<endl;

	 a.Run();
	 x.Run();
	 y.Run();
       }

SEE ALSO

       TAU_MAPPING_LINK(3), TAU_MAPPING_OBJECT(3), TAU_MAPPING_PROFILE(3)

								    08/31/2005						     TAU_MAPPING_CREATE(3)