jitprofiling.cc File Reference

#include "ittnotify_config.h"
#include <windows.h>
#include <malloc.h>
#include <stdlib.h>
#include "jitprofiling.h"
#include <stdio.h>

Include dependency graph for jitprofiling.cc:

Go to the source code of this file.

Classes
struct	ThreadStack

Macros
#define	DLL_ENVIRONMENT_VAR   "VS_PROFILER"
#define	NEW_DLL_ENVIRONMENT_VAR   "INTEL_JIT_PROFILER32"
#define	DEFAULT_DLLNAME   "JitPI.dll"
#define	ANDROID_JIT_AGENT_PATH   "/data/intel/libittnotify.so"
#define	INIT_TOP_Stack   10000

Typedefs
typedef unsigned int(*	TPInitialize) (void)
typedef unsigned int(*	TPNotify) (unsigned int, void *)
typedef struct ThreadStack *	pThreadStack

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

Variables
static const char	rcsid [] = "\n@(#) $Revision: 234474 $\n"
HINSTANCE	m_libHandle = NULL
static TPInitialize	FUNC_Initialize =NULL
static TPNotify	FUNC_NotifyEvent =NULL
static iJIT_IsProfilingActiveFlags	executionMode = iJIT_NOTHING_RUNNING
static int	iJIT_DLL_is_missing = 0
static DWORD	threadLocalStorageHandle = 0

Macro Definition Documentation

ANDROID_JIT_AGENT_PATH

#define ANDROID_JIT_AGENT_PATH   "/data/intel/libittnotify.so"

Definition at line 93 of file jitprofiling.cc.

DEFAULT_DLLNAME

#define DEFAULT_DLLNAME   "JitPI.dll"

Definition at line 85 of file jitprofiling.cc.

DLL_ENVIRONMENT_VAR

#define DLL_ENVIRONMENT_VAR   "VS_PROFILER"

Definition at line 74 of file jitprofiling.cc.

INIT_TOP_Stack

#define INIT_TOP_Stack   10000

Definition at line 130 of file jitprofiling.cc.

NEW_DLL_ENVIRONMENT_VAR

#define NEW_DLL_ENVIRONMENT_VAR   "INTEL_JIT_PROFILER32"

Definition at line 78 of file jitprofiling.cc.

Typedef Documentation

pThreadStack

typedef struct ThreadStack * pThreadStack

TPInitialize

typedef unsigned int(* TPInitialize) (void)

Definition at line 96 of file jitprofiling.cc.

TPNotify

typedef unsigned int(* TPNotify) (unsigned int, void *)

Definition at line 99 of file jitprofiling.cc.

Function Documentation

FinalizeProcess()

ITT_EXTERN_C 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()

ITT_EXTERN_C 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()

ITT_EXTERN_C 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()

ITT_EXTERN_C 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()

ITT_EXTERN_C 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()

ITT_EXTERN_C 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:

loadiJIT_Funcs()

static int loadiJIT_Funcs ( void  )

static

Definition at line 300 of file jitprofiling.cc.

{
    static int bDllWasLoaded = 0;
    char *dllName = (char*)rcsid; // !!! Just to avoid unused code elimination !!!
#if ITT_PLATFORM==ITT_PLATFORM_WIN
    DWORD dNameLength = 0;
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
 
    if(bDllWasLoaded)
    {// dll was already loaded, no need to do it for the second time
        return 1;
    }
 
    // Assumes that the DLL will not be found
    iJIT_DLL_is_missing = 1;
    FUNC_NotifyEvent = NULL;
 
    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;
    }
 
    // try to get the dll name from the environment
#if ITT_PLATFORM==ITT_PLATFORM_WIN
    dNameLength = GetEnvironmentVariableA(NEW_DLL_ENVIRONMENT_VAR, NULL, 0);
    if (dNameLength)
    {
        DWORD envret = 0;
        dllName = (char*)malloc(sizeof(char) * (dNameLength + 1));
        envret = GetEnvironmentVariableA(NEW_DLL_ENVIRONMENT_VAR, dllName, dNameLength);
        if (envret)
        {
            // Try to load the dll from the PATH...
            m_libHandle = LoadLibraryExA(dllName, NULL, LOAD_WITH_ALTERED_SEARCH_PATH);
        }
        free(dllName);
    } else {
        // Try to use old VS_PROFILER variable
        dNameLength = GetEnvironmentVariableA(DLL_ENVIRONMENT_VAR, NULL, 0);
        if (dNameLength)
        {
            DWORD envret = 0;
            dllName = (char*)malloc(sizeof(char) * (dNameLength + 1));
            envret = GetEnvironmentVariableA(DLL_ENVIRONMENT_VAR, dllName, dNameLength);
            if (envret)
            {
                // Try to load the dll from the PATH...
                m_libHandle = LoadLibraryA(dllName);
            }
            free(dllName);
        }
    }
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
    dllName = getenv(NEW_DLL_ENVIRONMENT_VAR);
    if (!dllName) {
        dllName = getenv(DLL_ENVIRONMENT_VAR);
    }
#ifdef ANDROID
    if (!dllName)
        dllName = ANDROID_JIT_AGENT_PATH;
#endif
    if (dllName)
    {
        // Try to load the dll from the PATH...
        m_libHandle = dlopen(dllName, RTLD_LAZY);
    }
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
 
    if (!m_libHandle)
    {
#if ITT_PLATFORM==ITT_PLATFORM_WIN
        m_libHandle = LoadLibraryA(DEFAULT_DLLNAME);
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        m_libHandle = dlopen(DEFAULT_DLLNAME, RTLD_LAZY);
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
    }
 
    // if the dll wasn't loaded - exit.
    if (!m_libHandle)
    {
        iJIT_DLL_is_missing = 1; // don't try to initialize JIT agent the second time
        return 0;
    }
#if ITT_PLATFORM==ITT_PLATFORM_WIN
    FUNC_NotifyEvent = (TPNotify)GetProcAddress(m_libHandle, "NotifyEvent");
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
    FUNC_NotifyEvent = reinterpret_cast<TPNotify>(reinterpret_cast<intptr_t>(dlsym(m_libHandle, "NotifyEvent")));
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
    if (!FUNC_NotifyEvent)
    {
        FUNC_Initialize = NULL;
        return 0;
    }
 
#if ITT_PLATFORM==ITT_PLATFORM_WIN
    FUNC_Initialize = (TPInitialize)GetProcAddress(m_libHandle, "Initialize");
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
    FUNC_Initialize = reinterpret_cast<TPInitialize>(reinterpret_cast<intptr_t>(dlsym(m_libHandle, "Initialize")));
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
    if (!FUNC_Initialize)
    {
        FUNC_NotifyEvent = NULL;
        return 0;
    }
 
    executionMode = (iJIT_IsProfilingActiveFlags)FUNC_Initialize();
    if (executionMode != iJIT_SAMPLING_ON)
      executionMode = iJIT_SAMPLING_ON;
 
    bDllWasLoaded = 1;
    iJIT_DLL_is_missing = 0; // DLL is ok.
 
    /*
    ** Call Graph mode: init the thread local storage
    ** (need to store the virtual stack there).
    */
    if ( executionMode == iJIT_CALLGRAPH_ON )
    {
        // Allocate a thread local storage slot for the thread "stack"
        if (!threadLocalStorageHandle)
#if ITT_PLATFORM==ITT_PLATFORM_WIN
            threadLocalStorageHandle = TlsAlloc();
#else  /* ITT_PLATFORM==ITT_PLATFORM_WIN */
        pthread_key_create(&threadLocalStorageHandle, NULL);
#endif /* ITT_PLATFORM==ITT_PLATFORM_WIN */
    }
 
    return 1;
}

References ANDROID_JIT_AGENT_PATH, DEFAULT_DLLNAME, DLL_ENVIRONMENT_VAR, v8::base::DWORD(), executionMode, FUNC_Initialize, FUNC_NotifyEvent, iJIT_CALLGRAPH_ON, iJIT_DLL_is_missing, iJIT_SAMPLING_ON, m_libHandle, NEW_DLL_ENVIRONMENT_VAR, NULL, rcsid, and threadLocalStorageHandle.

Referenced by iJIT_IsProfilingActive(), iJIT_NotifyEvent(), and iJIT_RegisterCallbackEx().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

executionMode

iJIT_IsProfilingActiveFlags executionMode = iJIT_NOTHING_RUNNING

static

Definition at line 102 of file jitprofiling.cc.

Referenced by iJIT_IsProfilingActive(), iJIT_NotifyEvent(), and loadiJIT_Funcs().

FUNC_Initialize

TPInitialize FUNC_Initialize =NULL

static

Definition at line 97 of file jitprofiling.cc.

Referenced by loadiJIT_Funcs().

FUNC_NotifyEvent

TPNotify FUNC_NotifyEvent =NULL

static

Definition at line 100 of file jitprofiling.cc.

Referenced by iJIT_NotifyEvent(), and loadiJIT_Funcs().

iJIT_DLL_is_missing

int iJIT_DLL_is_missing = 0

static

Definition at line 115 of file jitprofiling.cc.

Referenced by iJIT_IsProfilingActive(), iJIT_NotifyEvent(), iJIT_RegisterCallbackEx(), and loadiJIT_Funcs().

m_libHandle

HINSTANCE m_libHandle = NULL

Definition at line 86 of file jitprofiling.cc.

Referenced by FinalizeProcess(), and loadiJIT_Funcs().

rcsid

const char rcsid[] = "\n@(#) $Revision: 234474 $\n"

static

Definition at line 72 of file jitprofiling.cc.

Referenced by loadiJIT_Funcs().

threadLocalStorageHandle

DWORD threadLocalStorageHandle = 0

static

Definition at line 125 of file jitprofiling.cc.

Referenced by FinalizeProcess(), FinalizeThread(), iJIT_NotifyEvent(), and loadiJIT_Funcs().