jitprofiling.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_iJIT_Method_Id
struct	_iJIT_Method_NIDS
struct	_LineNumberInfo
struct	_iJIT_Method_Load

Macros
#define	CDECL   __attribute__ ((cdecl))
#define	JITAPI   CDECL

Typedefs
typedef enum iJIT_jvm_event	iJIT_JVM_EVENT
typedef enum _iJIT_ModeFlags	iJIT_ModeFlags
typedef enum _iJIT_IsProfilingActiveFlags	iJIT_IsProfilingActiveFlags
typedef enum _iJDEnvironmentType	iJDEnvironmentType
typedef struct _iJIT_Method_Id *	piJIT_Method_Id
typedef struct _iJIT_Method_Id	iJIT_Method_Id
typedef struct _iJIT_Method_NIDS *	piJIT_Method_NIDS
typedef struct _iJIT_Method_NIDS	iJIT_Method_NIDS
typedef struct _LineNumberInfo *	pLineNumberInfo
typedef struct _LineNumberInfo	LineNumberInfo
typedef struct _iJIT_Method_Load *	piJIT_Method_Load
typedef struct _iJIT_Method_Load	iJIT_Method_Load
typedef void(*	iJIT_ModeChangedEx) (void *UserData, iJIT_ModeFlags Flags)

Enumerations
enum	iJIT_jvm_event {   iJVM_EVENT_TYPE_SHUTDOWN = 2 , iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED =13 , iJVM_EVENT_TYPE_METHOD_UNLOAD_START , iJVM_EVENT_TYPE_ENTER_NIDS = 19 ,   iJVM_EVENT_TYPE_LEAVE_NIDS }
enum	_iJIT_ModeFlags {   iJIT_NO_NOTIFICATIONS = 0x0000 , iJIT_BE_NOTIFY_ON_LOAD = 0x0001 , iJIT_BE_NOTIFY_ON_UNLOAD = 0x0002 , iJIT_BE_NOTIFY_ON_METHOD_ENTRY = 0x0004 ,   iJIT_BE_NOTIFY_ON_METHOD_EXIT = 0x0008 }
enum	_iJIT_IsProfilingActiveFlags { iJIT_NOTHING_RUNNING = 0x0000 , iJIT_SAMPLING_ON = 0x0001 , iJIT_CALLGRAPH_ON = 0x0002 }
enum	_iJDEnvironmentType { iJDE_JittingAPI = 2 }

Functions
int JITAPI	iJIT_NotifyEvent (iJIT_JVM_EVENT event_type, void *EventSpecificData)
void JITAPI	iJIT_RegisterCallbackEx (void *userdata, iJIT_ModeChangedEx NewModeCallBackFuncEx)
iJIT_IsProfilingActiveFlags JITAPI	iJIT_IsProfilingActive (void)
void JITAPI	FinalizeThread (void)
void JITAPI	FinalizeProcess (void)
unsigned int JITAPI	iJIT_GetNewMethodID (void)

Macro Definition Documentation

CDECL

#define CDECL   __attribute__ ((cdecl))

Definition at line 270 of file jitprofiling.h.

JITAPI

#define JITAPI   CDECL

Definition at line 275 of file jitprofiling.h.

Typedef Documentation

iJDEnvironmentType

typedef enum _iJDEnvironmentType iJDEnvironmentType

iJIT_IsProfilingActiveFlags

typedef enum _iJIT_IsProfilingActiveFlags iJIT_IsProfilingActiveFlags

iJIT_JVM_EVENT

typedef enum iJIT_jvm_event iJIT_JVM_EVENT

iJIT_Method_Id

typedef struct _iJIT_Method_Id iJIT_Method_Id

iJIT_Method_Load

typedef struct _iJIT_Method_Load iJIT_Method_Load

iJIT_Method_NIDS

typedef struct _iJIT_Method_NIDS iJIT_Method_NIDS

iJIT_ModeChangedEx

typedef void(* iJIT_ModeChangedEx) (void *UserData, iJIT_ModeFlags Flags)

Definition at line 278 of file jitprofiling.h.

iJIT_ModeFlags

typedef enum _iJIT_ModeFlags iJIT_ModeFlags

LineNumberInfo

typedef struct _LineNumberInfo LineNumberInfo

piJIT_Method_Id

typedef struct _iJIT_Method_Id * piJIT_Method_Id

piJIT_Method_Load

typedef struct _iJIT_Method_Load * piJIT_Method_Load

piJIT_Method_NIDS

typedef struct _iJIT_Method_NIDS * piJIT_Method_NIDS

pLineNumberInfo

typedef struct _LineNumberInfo * pLineNumberInfo

Enumeration Type Documentation

_iJDEnvironmentType

enum _iJDEnvironmentType

Enumerator
iJDE_JittingAPI

Definition at line 159 of file jitprofiling.h.

{
    iJDE_JittingAPI = 2
} iJDEnvironmentType;

_iJIT_IsProfilingActiveFlags

enum _iJIT_IsProfilingActiveFlags

Enumerator
iJIT_NOTHING_RUNNING
iJIT_SAMPLING_ON
iJIT_CALLGRAPH_ON

Definition at line 143 of file jitprofiling.h.

{
    /* No profiler is running. Currently not used */
    iJIT_NOTHING_RUNNING           = 0x0000,
 
    /* Sampling is running. This is the default value
     * returned by iJIT_IsProfilingActive()
     */
    iJIT_SAMPLING_ON               = 0x0001,
 
      /* Call Graph is running */
    iJIT_CALLGRAPH_ON              = 0x0002
 
} iJIT_IsProfilingActiveFlags;

_iJIT_ModeFlags

enum _iJIT_ModeFlags

Enumerator
iJIT_NO_NOTIFICATIONS
iJIT_BE_NOTIFY_ON_LOAD
iJIT_BE_NOTIFY_ON_UNLOAD
iJIT_BE_NOTIFY_ON_METHOD_ENTRY
iJIT_BE_NOTIFY_ON_METHOD_EXIT

Definition at line 105 of file jitprofiling.h.

{
    /* No need to Notify VTune, since VTune is not running */
    iJIT_NO_NOTIFICATIONS          = 0x0000,
 
    /* when turned on the jit must call
     * iJIT_NotifyEvent
     * (
     *     iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED,
     * )
     * for all the method already jitted
     */
    iJIT_BE_NOTIFY_ON_LOAD         = 0x0001,
 
    /* when turned on the jit must call
     * iJIT_NotifyEvent
     * (
     *     iJVM_EVENT_TYPE_METHOD_UNLOAD_FINISHED,
     *  ) for all the method that are unloaded
     */
    iJIT_BE_NOTIFY_ON_UNLOAD       = 0x0002,
 
    /* when turned on the jit must instrument all
     * the currently jited code with calls on
     * method entries
     */
    iJIT_BE_NOTIFY_ON_METHOD_ENTRY = 0x0004,
 
    /* when turned on the jit must instrument all
     * the currently jited code with calls
     * on method exit
     */
    iJIT_BE_NOTIFY_ON_METHOD_EXIT  = 0x0008
 
} iJIT_ModeFlags;

iJIT_jvm_event

enum iJIT_jvm_event

Enumerator
iJVM_EVENT_TYPE_SHUTDOWN
iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED
iJVM_EVENT_TYPE_METHOD_UNLOAD_START
iJVM_EVENT_TYPE_ENTER_NIDS
iJVM_EVENT_TYPE_LEAVE_NIDS

Definition at line 66 of file jitprofiling.h.

{
 
    /* shutdown  */
 
    /*
     * Program exiting EventSpecificData NA
     */
    iJVM_EVENT_TYPE_SHUTDOWN = 2,
 
    /* JIT profiling  */
 
    /*
     * issued after method code jitted into memory but before code is executed
     * EventSpecificData is an iJIT_Method_Load
     */
    iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED=13,
 
    /* issued before unload. Method code will no longer be executed, but code
     * and info are still in memory. The VTune profiler may capture method
     * code only at this point EventSpecificData is iJIT_Method_Id
     */
    iJVM_EVENT_TYPE_METHOD_UNLOAD_START,
 
    /* Method Profiling */
 
    /* method name, Id and stack is supplied
     * issued when a method is about to be entered EventSpecificData is
     * iJIT_Method_NIDS
     */
    iJVM_EVENT_TYPE_ENTER_NIDS = 19,
 
    /* method name, Id and stack is supplied
     * issued when a method is about to be left EventSpecificData is
     * iJIT_Method_NIDS
     */
    iJVM_EVENT_TYPE_LEAVE_NIDS
} iJIT_JVM_EVENT;

Function Documentation

FinalizeProcess()

void JITAPI FinalizeProcess

(

void

)

Definition at line 465 of file jitprofiling.cc.

{
    if (m_libHandle)
    {
#if ITT_PLATFORM==ITT_PLATFORM_WIN
        FreeLibrary(m_libHandle);
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        dlclose(m_libHandle);
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        m_libHandle = NULL;
    }
 
    if (threadLocalStorageHandle)
#if ITT_PLATFORM==ITT_PLATFORM_WIN
        TlsFree (threadLocalStorageHandle);
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
    pthread_key_delete(threadLocalStorageHandle);
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
}

References m_libHandle, NULL, and threadLocalStorageHandle.

FinalizeThread()

void JITAPI FinalizeThread

(

void

)

Definition at line 439 of file jitprofiling.cc.

{
    if (threadLocalStorageHandle)
    {
#if ITT_PLATFORM==ITT_PLATFORM_WIN
        pThreadStack threadStack = (pThreadStack)TlsGetValue (threadLocalStorageHandle);
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        pThreadStack threadStack = (pThreadStack)pthread_getspecific(threadLocalStorageHandle);
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        if (threadStack)
        {
            free (threadStack);
            threadStack = NULL;
#if ITT_PLATFORM==ITT_PLATFORM_WIN
            TlsSetValue (threadLocalStorageHandle, threadStack);
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
            pthread_setspecific(threadLocalStorageHandle, threadStack);
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        }
    }
}

References NULL, and threadLocalStorageHandle.

iJIT_GetNewMethodID()

unsigned int JITAPI iJIT_GetNewMethodID

(

void

)

Definition at line 490 of file jitprofiling.cc.

{
    static unsigned int methodID = 0x100000;
 
    if (methodID == 0)
        return 0;   // ERROR : this is not a valid value
 
    return methodID++;
}

Referenced by vTune::internal::VTUNEJITInterface::event_handler().

Here is the caller graph for this function:

iJIT_IsProfilingActive()

iJIT_IsProfilingActiveFlags JITAPI iJIT_IsProfilingActive

(

void

)

Definition at line 286 of file jitprofiling.cc.

{
    if (!iJIT_DLL_is_missing)
    {
        loadiJIT_Funcs();
    }
 
    return executionMode;
}

References executionMode, iJIT_DLL_is_missing, and loadiJIT_Funcs().

Here is the call graph for this function:

iJIT_NotifyEvent()

int JITAPI iJIT_NotifyEvent	(	iJIT_JVM_EVENT	event_type,
		void *	EventSpecificData
	)

Definition at line 151 of file jitprofiling.cc.

{
    int ReturnValue;
 
    /*******************************************************************************
    ** This section is for debugging outside of VTune.
    ** It creates the environment variables that indicates call graph mode.
    ** If running outside of VTune remove the remark.
    **
 
      static int firstTime = 1;
      char DoCallGraph[12] = "DoCallGraph";
      if (firstTime)
      {
      firstTime = 0;
      SetEnvironmentVariable( "BISTRO_COLLECTORS_DO_CALLGRAPH", DoCallGraph);
      }
 
    ** end of section.
    *******************************************************************************/
 
    /* initialization part - the functions have not been loaded yet. This part
    **      will load the functions, and check if we are in Call Graph mode.
    **      (for special treatment).
    */
    if (!FUNC_NotifyEvent)
    {
        if (iJIT_DLL_is_missing)
            return 0;
 
        // load the Function from the DLL
        if (!loadiJIT_Funcs())
            return 0;
 
        /* Call Graph initialization. */
    }
 
    /* If the event is method entry/exit, check that in the current mode
    ** VTune is allowed to receive it
    */
    if ((event_type == iJVM_EVENT_TYPE_ENTER_NIDS || event_type == iJVM_EVENT_TYPE_LEAVE_NIDS) &&
        (executionMode != iJIT_CALLGRAPH_ON))
    {
        return 0;
    }
    /* This section is performed when method enter event occurs.
    ** It updates the virtual stack, or creates it if this is the first
    ** method entry in the thread. The stack pointer is decreased.
    */
    if (event_type == iJVM_EVENT_TYPE_ENTER_NIDS)
    {
#if ITT_PLATFORM==ITT_PLATFORM_WIN
        pThreadStack threadStack = (pThreadStack)TlsGetValue (threadLocalStorageHandle);
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        pThreadStack threadStack = (pThreadStack)pthread_getspecific(threadLocalStorageHandle);
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
 
        // check for use of reserved method IDs
        if ( ((piJIT_Method_NIDS) EventSpecificData)->method_id <= 999 )
            return 0;
 
        if (!threadStack)
        {
            // initialize the stack.
            threadStack = (pThreadStack) calloc (sizeof(ThreadStack), 1);
            threadStack->TopStack = INIT_TOP_Stack;
            threadStack->CurrentStack = INIT_TOP_Stack;
#if ITT_PLATFORM==ITT_PLATFORM_WIN
            TlsSetValue(threadLocalStorageHandle,(void*)threadStack);
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
            pthread_setspecific(threadLocalStorageHandle,(void*)threadStack);
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        }
 
        // decrease the stack.
        ((piJIT_Method_NIDS) EventSpecificData)->stack_id = (threadStack->CurrentStack)--;
    }
 
    /* This section is performed when method leave event occurs
    ** It updates the virtual stack.
    **      Increases the stack pointer.
    **      If the stack pointer reached the top (left the global function)
    **          increase the pointer and the top pointer.
    */
    if (event_type == iJVM_EVENT_TYPE_LEAVE_NIDS)
    {
#if ITT_PLATFORM==ITT_PLATFORM_WIN
        pThreadStack threadStack = (pThreadStack)TlsGetValue (threadLocalStorageHandle);
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        pThreadStack threadStack = (pThreadStack)pthread_getspecific(threadLocalStorageHandle);
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
 
        // check for use of reserved method IDs
        if ( ((piJIT_Method_NIDS) EventSpecificData)->method_id <= 999 )
            return 0;
 
        if (!threadStack)
        {
            /* Error: first report in this thread is method exit */
            exit (1);
        }
 
        ((piJIT_Method_NIDS) EventSpecificData)->stack_id = ++(threadStack->CurrentStack) + 1;
 
        if (((piJIT_Method_NIDS) EventSpecificData)->stack_id > threadStack->TopStack)
            ((piJIT_Method_NIDS) EventSpecificData)->stack_id = (unsigned int)-1;
    }
 
    if (event_type == iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED)
    {
        // check for use of reserved method IDs
        if ( ((piJIT_Method_Load) EventSpecificData)->method_id <= 999 )
            return 0;
    }
 
    ReturnValue = (int)FUNC_NotifyEvent(event_type, EventSpecificData);
 
    return ReturnValue;
}

References ThreadStack::CurrentStack, executionMode, FUNC_NotifyEvent, iJIT_CALLGRAPH_ON, iJIT_DLL_is_missing, iJVM_EVENT_TYPE_ENTER_NIDS, iJVM_EVENT_TYPE_LEAVE_NIDS, iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED, INIT_TOP_Stack, loadiJIT_Funcs(), threadLocalStorageHandle, and ThreadStack::TopStack.

Referenced by vTune::internal::VTUNEJITInterface::event_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

iJIT_RegisterCallbackEx()

void JITAPI iJIT_RegisterCallbackEx	(	void *	userdata,
		iJIT_ModeChangedEx	NewModeCallBackFuncEx
	)

Definition at line 271 of file jitprofiling.cc.

{
    // is it already missing... or the load of functions from the DLL failed
    if (iJIT_DLL_is_missing || !loadiJIT_Funcs())
    {
        NewModeCallBackFuncEx(userdata, iJIT_NO_NOTIFICATIONS);  // then do not bother with notifications
        /* Error: could not load JIT functions. */
        return;
    }
    // nothing to do with the callback
}

References iJIT_DLL_is_missing, iJIT_NO_NOTIFICATIONS, and loadiJIT_Funcs().

Here is the call graph for this function: