[MCJIT] Add cmake variables to customize ittapi git location and revision.

[ekovanov]

Summary

To support llorg builds this patch provides the following changes:

1. Added cmake variable ITTAPI_GIT_REPOSITORY to control the location of ITTAPI repository. Default value of ITTAPI_GIT_REPOSITORY is github location: https://github.com/intel/ittapi.git Also, the separate cmake variable ITTAPI_GIT_TAG was added for repo tag.
2. Added cmake variable ITTAPI_SOURCE_DIR to control the place where the repo will be cloned. Default value of ITTAPI_SOURCE_DIR is build area: PROJECT_BINARY_DIR

[etyurin]

LGTM.

[ekovanov]

Hi @etyurin ,
I do not have commit access - could you please land it?

[etyurin]

In D91935#2411726, @ekovanov wrote:

Hi @etyurin ,
I do not have commit access - could you please land it?

I don't have it as well:)

[bader]

I also suggest using CMake's ExternalProject_Add command to checkout sources instead of running a set of execute_process commands.

llvm/lib/ExecutionEngine/IntelJITEvents/CMakeLists.txt

14–15

CMAKE_CURRENT_SOURCE_DIR -> ITTAPI_SOURCE_DIR

[bader]

In D91935#2411726, @ekovanov wrote:

Hi @etyurin ,
I do not have commit access - could you please land it?

I can help with that, but current version of the patch has a bug, which should be addressed before commit.

[ekovanov]

fixed llvm/lib/ExecutionEngine/IntelJITEvents/CMakeLists.txt:15
CMAKE_CURRENT_SOURCE_DIR -> ITTAPI_SOURCE_DIR

thank you Alexey!

[bader]

@etyurin, let me know when it's ready for commit.

[tstellar]

Can you explain more about what llorg is and why this change is needed?

[bader]

In D91935#2414448, @tstellar wrote:

Can you explain more about what llorg is and why this change is needed?

llorg is the term used by Intel compiler team to differentiate vanilla llvm source repository (or compiler built from these sources) from Intel's customized version. It shouldn't have been used w/o providing the context.

This change allows developers to customize ittapi git repository location and source revision. It's required for enabling use of internal mirrors.

I suggest changing the log message title to:

• [MCJIT] Add cmake variables to customize ittapi git location and revision.

[tstellar]

Thanks for the explanation. Doing a git clone as part of the build is usually discouraged, though I see Lang approved the original patch. Is this code disabled by default?

[ekovanov]

Hi Tom,
Yes, it's disabled by default. To enable this code the option -DLLVM_USE_INTEL_JITEVENTS=ON should be used.

[lhames]

In D91935#2415346, @tstellar wrote:

Thanks for the explanation. Doing a git clone as part of the build is usually discouraged, though I see Lang approved the original patch. Is this code disabled by default?

I approved under the understanding that this was off by default, but I'm definitely not a build system expert -- If you feel this should be done differently then that seems worth discussing.

[bader]

@tstellar, are you okay with the change?
Please, let us know if you have any additional questions.

[tstellar]

In my opinion , it would be better to to build against an installed version of the library, rather than fetching the git source. But I don't have any objections to this specific patch, because it is updating something that is already in tree.

[bader]

In D91935#2442723, @tstellar wrote:

In my opinion , it would be better to to build against an installed version of the library, rather than fetching the git source. But I don't have any objections to this specific patch, because it is updating something that is already in tree.

Thanks! I'll submit this patch.
@ekovanov, please, consider building against installed version of the library.

llvm/lib/ExecutionEngine/IntelJITEvents/CMakeLists.txt

 include_directories( ${CMAKE_CURRENT_SOURCE_DIR}/.. )
 
-set(GIT_REPOSITORY https://github.com/intel/ittapi.git)
-set(GIT_TAG v3.18.8)
+if(NOT DEFINED ITTAPI_GIT_REPOSITORY)
+    set(ITTAPI_GIT_REPOSITORY https://github.com/intel/ittapi.git)
+endif()
+
+if(NOT DEFINED ITTAPI_GIT_TAG)
+    set(ITTAPI_GIT_TAG v3.18.8)
+endif()
+
+if(NOT DEFINED ITTAPI_SOURCE_DIR)
+    set(ITTAPI_SOURCE_DIR ${PROJECT_BINARY_DIR})
+endif()
 
-if(NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/ittapi)
-    execute_process(COMMAND ${GIT_EXECUTABLE} clone ${GIT_REPOSITORY}
-                    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+if(NOT EXISTS ${ITTAPI_SOURCE_DIR}/ittapi)
+    execute_process(COMMAND ${GIT_EXECUTABLE} clone ${ITTAPI_GIT_REPOSITORY}
+                    WORKING_DIRECTORY ${ITTAPI_SOURCE_DIR}
                     RESULT_VARIABLE GIT_CLONE_RESULT)
     if(NOT GIT_CLONE_RESULT EQUAL "0")
-        message(FATAL_ERROR "git clone ${GIT_REPOSITORY} failed with ${GIT_CLONE_RESULT}, please clone ${GIT_REPOSITORY}")
+        message(FATAL_ERROR "git clone ${ITTAPI_GIT_REPOSITORY} failed with ${GIT_CLONE_RESULT}, please clone ${ITTAPI_GIT_REPOSITORY}")
     endif()
 endif()
 
-execute_process(COMMAND ${GIT_EXECUTABLE} checkout ${GIT_TAG}
-                WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/ittapi
+execute_process(COMMAND ${GIT_EXECUTABLE} checkout ${ITTAPI_GIT_TAG}
+                WORKING_DIRECTORY ${ITTAPI_SOURCE_DIR}/ittapi
                 RESULT_VARIABLE GIT_CHECKOUT_RESULT)
 if(NOT GIT_CHECKOUT_RESULT EQUAL "0")
-    message(FATAL_ERROR "git checkout ${GIT_TAG} failed with ${GIT_CHECKOUT_RESULT}, please checkout ${GIT_TAG} at ${CMAKE_CURRENT_SOURCE_DIR}/ittapi")
+    message(FATAL_ERROR "git checkout ${ITTAPI_GIT_TAG} failed with ${GIT_CHECKOUT_RESULT}, please checkout ${ITTAPI_GIT_TAG} at ${ITTAPI_SOURCE_DIR}/ittapi")
 endif()
 
-include_directories( ${CMAKE_CURRENT_SOURCE_DIR}/ittapi/include/ )
+include_directories( ${ITTAPI_SOURCE_DIR}/ittapi/include/ )
 
 if( HAVE_LIBDL )
     set(LLVM_INTEL_JIT_LIBS ${CMAKE_DL_LIBS})
 endif()
 
 set(LLVM_INTEL_JIT_LIBS ${LLVM_PTHREAD_LIB} ${LLVM_INTEL_JIT_LIBS})
 
 
 add_llvm_component_library(LLVMIntelJITEvents
   IntelJITEventListener.cpp
   jitprofiling.c
-  ittapi/src/ittnotify/ittnotify_static.c
+  ${ITTAPI_SOURCE_DIR}/ittapi/src/ittnotify/ittnotify_static.c
 
   LINK_LIBS ${LLVM_INTEL_JIT_LIBS}
 
   LINK_COMPONENTS
   CodeGen
   Core
   DebugInfoDWARF
   Support
   Object
   ExecutionEngine
 )
 
 add_dependencies(LLVMIntelJITEvents LLVMCodeGen)