[mlir] Add CMake flags to properly enable Jit event listeners.

[nicolasvasilache]

Summary

By default, the listeners do nothing unless linked in.
This revision allows the "Perf" and "Intel" Jit event listeners to be used.

The "OProfile" event listener is not enabled at this time,
the associated library structure is not well-isolated.

[mehdi_amini]

mlir/lib/ExecutionEngine/CMakeLists.txt

24

Are these Cmake libraries defined by LLVM itself? (The names don’t include LLVM which isn’t usual)

mlir/lib/ExecutionEngine/ExecutionEngine.cpp

203

Can you commit formatting change ahead and keep this diff minimal?
(Unless there is more than formatting here?)

[nicolasvasilache]

Address comments.

mlir/lib/ExecutionEngine/CMakeLists.txt

24

Yes and it seems to be a pattern, e.g. LLVMScalarOpts -> libLLVMScalarOpts, LLVMMC -> libLLVMMC, etc.

[mehdi_amini]

mlir/lib/ExecutionEngine/CMakeLists.txt

24

Right my comment is that these break the pattern: IntelJITEvents instead of LLVMIntelJITEvents.

[nicolasvasilache]

mlir/lib/ExecutionEngine/CMakeLists.txt

24

sorry, I wasn't explicit enough.

This is the pattern: MC -> LLVMMC -> libLLVMMC

The LINK_COMPONENTS section seems to implicitly add the LLVM in front of MC.

[mehdi_amini]

mlir/lib/ExecutionEngine/CMakeLists.txt

24

Oh I see, it is a "components" and not a CMake library, thanks :)

mlir/lib/ExecutionEngine/CMakeLists.txt

 # Exclude these from libMLIR.so because the JIT infrastructure
 # is a big dependency which most don't need.
 
 set(LLVM_OPTIONAL_SOURCES
   AsyncRuntime.cpp
   CRunnerUtils.cpp
   CudaRuntimeWrappers.cpp
   SparseTensorUtils.cpp
   ExecutionEngine.cpp
   RocmRuntimeWrappers.cpp
   RunnerUtils.cpp
   OptUtils.cpp
   JitRunner.cpp
   )
 
+if(LLVM_USE_INTEL_JITEVENTS)
+  set(LLVM_JIT_LISTENER_LIB
+      IntelJITEvents)
+endif(LLVM_USE_INTEL_JITEVENTS)
+
+if(LLVM_USE_PERF)
+  set(LLVM_JIT_LISTENER_LIB
+      PerfJITEvents)
+endif(LLVM_USE_PERF)
+
 add_mlir_library(MLIRExecutionEngine
   ExecutionEngine.cpp
   OptUtils.cpp
 
   EXCLUDE_FROM_LIBMLIR
 
   ADDITIONAL_HEADER_DIRS
   ${MLIR_MAIN_INCLUDE_DIR}/mlir/ExecutionEngine
add_mlir_library(MLIRExecutionEngine
   InstCombine
   MC
   ScalarOpts
   Target
   Vectorize
   TransformUtils
   nativecodegen
   IPO
+  ${LLVM_JIT_LISTENER_LIB}
 
   LINK_LIBS PUBLIC
   MLIRLLVMIR
   MLIRLLVMToLLVMIRTranslation
   MLIRTargetLLVMIRExport
   )
 
 get_property(dialect_libs GLOBAL PROPERTY MLIR_DIALECT_LIBS)

mlir/lib/ExecutionEngine/ExecutionEngine.cpp

for (auto &func : module->getFunctionList()) {
     bb->insertInto(interfaceFunc);
     builder.SetInsertPoint(bb);
     llvm::Value *argList = interfaceFunc->arg_begin();
     SmallVector<llvm::Value *, 8> args;
     args.reserve(llvm::size(func.args()));
     for (auto &indexedArg : llvm::enumerate(func.args())) {
       llvm::Value *argIndex = llvm::Constant::getIntegerValue(
           builder.getInt64Ty(), APInt(64, indexedArg.index()));
-      llvm::Value *argPtrPtr = builder.CreateGEP(
-          builder.getInt8PtrTy(), argList, argIndex);
-      llvm::Value *argPtr = builder.CreateLoad(builder.getInt8PtrTy(),
-                                               argPtrPtr);
+      llvm::Value *argPtrPtr =
+          builder.CreateGEP(builder.getInt8PtrTy(), argList, argIndex);
+      llvm::Value *argPtr =
+          builder.CreateLoad(builder.getInt8PtrTy(), argPtrPtr);
       llvm::Type *argTy = indexedArg.value().getType();
       argPtr = builder.CreateBitCast(argPtr, argTy->getPointerTo());
       llvm::Value *arg = builder.CreateLoad(argTy, argPtr);
       args.push_back(arg);
     }
 
     // Call the implementation function with the extracted arguments.
     llvm::Value *result = builder.CreateCall(&func, args);
 
     // Assuming the result is one value, potentially of type `void`.
     if (!result->getType()->isVoidTy()) {
       llvm::Value *retIndex = llvm::Constant::getIntegerValue(
           builder.getInt64Ty(), APInt(64, llvm::size(func.args())));
       llvm::Value *retPtrPtr =
           builder.CreateGEP(builder.getInt8PtrTy(), argList, retIndex);
-      llvm::Value *retPtr = builder.CreateLoad(builder.getInt8PtrTy(),
-                                               retPtrPtr);
+      llvm::Value *retPtr =
+          builder.CreateLoad(builder.getInt8PtrTy(), retPtrPtr);
       retPtr = builder.CreateBitCast(retPtr, result->getType()->getPointerTo());
       builder.CreateStore(result, retPtr);
     }
 
     // The interface function returns void.
     builder.CreateRetVoid();
   }
 }
 
 ExecutionEngine::ExecutionEngine(bool enableObjectCache,
                                  bool enableGDBNotificationListener,
                                  bool enablePerfNotificationListener)
     : cache(enableObjectCache ? new SimpleObjectCache() : nullptr),
       gdbListener(enableGDBNotificationListener
                       ? llvm::JITEventListener::createGDBRegistrationListener()
                       : nullptr),
-      perfListener(enablePerfNotificationListener
-                       ? llvm::JITEventListener::createPerfJITEventListener()
-                       : nullptr) {}
+      perfListener(nullptr) {
+  if (enablePerfNotificationListener) {
+    if (auto *listener = llvm::JITEventListener::createPerfJITEventListener())
+      perfListener = listener;
+    else if (auto *listener =
+                 llvm::JITEventListener::createIntelJITEventListener())
+      perfListener = listener;
+  }
+}
 
 Expected<std::unique_ptr<ExecutionEngine>> ExecutionEngine::create(
     ModuleOp m,
     llvm::function_ref<std::unique_ptr<llvm::Module>(ModuleOp,
                                                      llvm::LLVMContext &)>
         llvmModuleBuilder,
     llvm::function_ref<Error(llvm::Module *)> transformer,
     Optional<llvm::CodeGenOpt::Level> jitCodeGenOptLevel,