View source for TPTP Java Profilers Anatomy

== Introduction ==

TPTP provides with not only a profiling framework Martini, but also several Java profilers. Call graph, memory and thread anlysis are three basic profiling scenarios. In this wiki page, we will introduce main classes and their relations which consist in Java Profilers part. As profilers' features Pause/Resume, Attach/Detach design will be described in another wiki doc&nbsp;[http://wiki.eclipse.org/Pause_Resume_Attach_Detach_design_of_profilers Pause Resume Attach Detach design of profilers]. 

== Profilers Design Overview  ==

To abstract common operations in diffrent profilers, a class named "CBaseProf" is added. The design pattern Template is used here. BaseProf defines several template methods and subclasses of it need to implement these template methods. 

Profiling data will be stored or output for different profiling. We will discuss the profiling data structure later. Different handler classes are added for processing different Martini profiling events such as a method enter or a thread start etc. These classes are packaged with concrete profilers. 

Class "CProfEnv" is used for profiling context. It is used for interacting with Martini and JPIAgent. Profiling data will be stored or sent out by this class objects. Other utility classes such as "CTickets" is used for profiling data organization. 

In summary, there are three kinds of classes in Java Profilers: 

#Basic profilers: CBaseProf, CCGProf, CHeapProf and CThreadProf etc. 
#Martini events handler for profilers:&nbsp;CMethodEnterEvent, CMethodLeaveEvent and&nbsp;CObjAllocEvent etc. 
#Profiling context and data organization classes: CProfEnv and CTickets etc.

== Profiliers Anatomy  ==

Profilers' classes will be described as below. We will introduce some profilers' infrastructure classes. Utility classes or Martini events handlers' classes are contained in concrete profilers' description. 

=== CBaseProfiler: Base class for Concrete Profilers  ===

CBaseProfiler provide a method "init". In this method, three template virtual methods are called:&nbsp;ParceOptions,&nbsp;InitProfilerSpecificEvents(called by&nbsp;InitEvents) and&nbsp;InitFilter. Profiling context class CProfEnv is instantiated here too. Some common event handlers such as VM initialization and shut down are also instantiated in CBaseProfiler::InitEvents. 

=== ProfEnv: Profiling context and interface class  ===

Profiling context class CProfEnv is a little complex. This class undertakes too many responsibilities&nbsp;since TPTP code has been maintained for several years. To analyze some problems related with CProfEnv, here is two suggestions: 

*Start from outside callers to find which interfaces of CProfEnv are used. Then you can concentrate on these interfaces' implementation. 
*Make sure which kind of profiling (Call Graph? Heap? or Thread?) is in your analysis. For example, there are two fields named "m_Tickets" and "m_pShadowStackTracker" which are just related with call graph profiling.

=== Call Graph Profiler  ===

There are two modes which can be applied to Call Graph profiling - execution details and aggregated. The difference for users between these two modes is in execution details mode provides more detailed profiling information, and it can render call graph in workbench. However, it will run slower than aggregated mode. To support these two modes, different implementations are used in call graph profiler design. 

The first difference is data structure used for profiling data storage. CGProf profiling data is stored in a call-tree-like hierarchical stacks structure. Both are included in org.eclipse.tptp.platform.jvmti.runtime/src-native/src/baseprof/Tickets.h. Class CTicketStack is used for exec details mode while CStackHead for aggregated mode. 

The second difference is how to poll out profiling data. Exec Details mode uses a "push" model while aggregated mode uses a "pull" model. In exec details mode, profiling data is output promptly when methods' enter or leave events are received. In aggregated mode, the data will be sent out when receive collect data command or till termination of Java applications. You can also set polling out frequency before start profiling in Eclipse profiling options setting. 

=== Heap Profiler  ===

For Heap profiling, there is just one additional option in Eclipse workbench: whether track objects allocation sites. If the option is selected, you can get where some specific class objects are allocated. This option is represented by CProfEnv.ec_env-&gt;isAllocSitesSupported().<br> 

Profiling events handlers' classes related with heap profiler are CObjAllocEvent, CObjFreeEvent, CGcStartEvent and CGcFinishEvent etc. You can find the handlers' details in source code.&nbsp;<br> 

=== Thread Profiler  ===

Besides classes CThreadStartEvent and CThreadEndEvent, other event handlers such as CMonitorWaitEvent, CMonitorWatedEvent, CContendedMonitorEnterEvent, CContendedMonitorEnteredEvent and CThreadInteractionEvent are used for thread profiling. For these event information, please refer to [http://java.sun.com/j2se/1.5.0/docs/guide/jvmti/jvmti.html JVMTI specification]. 

----
<div></div><div><span class="Apple-style-span" style="font-family: arial;">←[http://wiki.eclipse.org/TPTP Back to TPTP wiki page]</span></div>