| /*===-- jitprofiling.h - JIT Profiling API-------------------------*- C -*-===* |
| * |
| * Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| * See https://llvm.org/LICENSE.txt for license information. |
| * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| * |
| *===----------------------------------------------------------------------===* |
| * |
| * This file provides Intel(R) Performance Analyzer JIT (Just-In-Time) |
| * Profiling API declaration. |
| * |
| * NOTE: This file comes in a style different from the rest of LLVM |
| * source base since this is a piece of code shared from Intel(R) |
| * products. Please do not reformat / re-style this code to make |
| * subsequent merges and contributions from the original source base eaiser. |
| * |
| *===----------------------------------------------------------------------===*/ |
| #ifndef __JITPROFILING_H__ |
| #define __JITPROFILING_H__ |
| |
| /* |
| * Various constants used by functions |
| */ |
| |
| /* event notification */ |
| typedef enum iJIT_jvm_event |
| { |
| |
| /* 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; |
| |
| typedef enum _iJIT_ModeFlags |
| { |
| /* 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; |
| |
| |
| /* Flags used by iJIT_IsProfilingActive() */ |
| typedef enum _iJIT_IsProfilingActiveFlags |
| { |
| /* 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; |
| |
| /* Enumerator for the environment of methods*/ |
| typedef enum _iJDEnvironmentType |
| { |
| iJDE_JittingAPI = 2 |
| } iJDEnvironmentType; |
| |
| /********************************** |
| * Data structures for the events * |
| **********************************/ |
| |
| /* structure for the events: |
| * iJVM_EVENT_TYPE_METHOD_UNLOAD_START |
| */ |
| |
| typedef struct _iJIT_Method_Id |
| { |
| /* Id of the method (same as the one passed in |
| * the iJIT_Method_Load struct |
| */ |
| unsigned int method_id; |
| |
| } *piJIT_Method_Id, iJIT_Method_Id; |
| |
| |
| /* structure for the events: |
| * iJVM_EVENT_TYPE_ENTER_NIDS, |
| * iJVM_EVENT_TYPE_LEAVE_NIDS, |
| * iJVM_EVENT_TYPE_EXCEPTION_OCCURRED_NIDS |
| */ |
| |
| typedef struct _iJIT_Method_NIDS |
| { |
| /* unique method ID */ |
| unsigned int method_id; |
| |
| /* NOTE: no need to fill this field, it's filled by VTune */ |
| unsigned int stack_id; |
| |
| /* method name (just the method, without the class) */ |
| char* method_name; |
| } *piJIT_Method_NIDS, iJIT_Method_NIDS; |
| |
| /* structures for the events: |
| * iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED |
| */ |
| |
| typedef struct _LineNumberInfo |
| { |
| /* x86 Offset from the beginning of the method*/ |
| unsigned int Offset; |
| |
| /* source line number from the beginning of the source file */ |
| unsigned int LineNumber; |
| |
| } *pLineNumberInfo, LineNumberInfo; |
| |
| typedef struct _iJIT_Method_Load |
| { |
| /* unique method ID - can be any unique value, (except 0 - 999) */ |
| unsigned int method_id; |
| |
| /* method name (can be with or without the class and signature, in any case |
| * the class name will be added to it) |
| */ |
| char* method_name; |
| |
| /* virtual address of that method - This determines the method range for the |
| * iJVM_EVENT_TYPE_ENTER/LEAVE_METHOD_ADDR events |
| */ |
| void* method_load_address; |
| |
| /* Size in memory - Must be exact */ |
| unsigned int method_size; |
| |
| /* Line Table size in number of entries - Zero if none */ |
| unsigned int line_number_size; |
| |
| /* Pointer to the beginning of the line numbers info array */ |
| pLineNumberInfo line_number_table; |
| |
| /* unique class ID */ |
| unsigned int class_id; |
| |
| /* class file name */ |
| char* class_file_name; |
| |
| /* source file name */ |
| char* source_file_name; |
| |
| /* bits supplied by the user for saving in the JIT file */ |
| void* user_data; |
| |
| /* the size of the user data buffer */ |
| unsigned int user_data_size; |
| |
| /* NOTE: no need to fill this field, it's filled by VTune */ |
| iJDEnvironmentType env; |
| |
| } *piJIT_Method_Load, iJIT_Method_Load; |
| |
| /* API Functions */ |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| #ifndef CDECL |
| # if defined WIN32 || defined _WIN32 |
| # define CDECL __cdecl |
| # else /* defined WIN32 || defined _WIN32 */ |
| # if defined _M_X64 || defined _M_AMD64 || defined __x86_64__ |
| # define CDECL /* not actual on x86_64 platform */ |
| # else /* _M_X64 || _M_AMD64 || __x86_64__ */ |
| # define CDECL __attribute__ ((cdecl)) |
| # endif /* _M_X64 || _M_AMD64 || __x86_64__ */ |
| # endif /* defined WIN32 || defined _WIN32 */ |
| #endif /* CDECL */ |
| |
| #define JITAPI CDECL |
| |
| /* called when the settings are changed with new settings */ |
| typedef void (*iJIT_ModeChangedEx)(void *UserData, iJIT_ModeFlags Flags); |
| |
| int JITAPI iJIT_NotifyEvent(iJIT_JVM_EVENT event_type, void *EventSpecificData); |
| |
| /* The new mode call back routine */ |
| 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); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* __JITPROFILING_H__ */ |
