Validate python packages availability before building ompd gdb-plugin code

[Vigneshbalu]

Summary

This is a follow up patch to the review: https://reviews.llvm.org/D100185
GDB uses a python interface to access OpenMP runtime through libompd.
This python code depends on packages like "wheel" and "setuptools", so verify the availability of those packages before building gdb-plugin code.

[Vigneshbalu]

This patch is validated on Ubuntu 20.04.
I will validate the same in debian and fedora and update.

[protze.joachim]

An alternative approach would be to install the python modules wheels and setuptools into the build directory using pip instead of bailing out.

openmp/libompd/CMakeLists.txt

64

I'm afraid, this will break if locale is not English.

openmp/libompd/CMakeLists.txt

 #
 #//===----------------------------------------------------------------------===//
 #//
 #// 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
 #//
 #//===----------------------------------------------------------------------===//
 #
 
+find_package (Python3 COMPONENTS Interpreter Development)
+
 if(LIBOMP_OMPD_SUPPORT)
-    set(OMPD_INCLUDE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/src/)
-    add_subdirectory(src)
-    if(NOT DISABLE_OMPD_GDB_PLUGIN)
-        add_subdirectory(gdb-plugin)
-    endif()
+    file(READ "/etc/os-release" OS_RELEASE)
+  set(DIST "")
+  string(REGEX MATCH "Debian|debian|Ubuntu|ubuntu" DIST ${OS_RELEASE})
+  # UBUNTU and Debian package manager have its own patch in "pip" to avoid user
+  # installed packages messing up with default paths.
+  # https://bugs.launchpad.net/ubuntu/+source/python-pip/+bug/1419695
+  # Therfore, we have to use "--system" (specific to ubuntu and debian) when we
+  # use system installed pip.(Not required if user installed pip on other paths.)
+  # However, this has been taken care in pip for 20+ versions.
+  # https://github.com/pypa/pip/commit/5f1468274987348b569aa586eeca4363494d0357
+  if(DIST)
+    execute_process(COMMAND "${Python3_EXECUTABLE}"
+              "-mpip"
+              "--version"
+              OUTPUT_VARIABLE PIP_VERSION_INFO
+              RESULT_VARIABLE HAD_ERROR)
+      if (NOT ${HAD_ERROR} EQUAL 0)
+        message(WARNING "PIP command failed, gdb-plugin disabled.")
+        return()
+      endif ()
+
+      string(REGEX REPLACE " " ";" PIP_VERSION_INFO "${PIP_VERSION_INFO}")
+      list(GET PIP_VERSION_INFO 1 PIP_VERSION)
+      set(PYSYSFLAG "")
+
+    if(PIP_VERSION VERSION_LESS "20.0.0")
+        execute_process(COMMAND "${Python3_EXECUTABLE}"
+                "-mpip"
+                "install"
+                "--help"
+                OUTPUT_VARIABLE PIP_INSTALL_HELP
+                RESULT_VARIABLE HAD_ERROR )
+        string(REGEX MATCH "--system" SYSTEM_FLAG ${PIP_INSTALL_HELP})
+        if (SYSTEM_FLAG)
+          set(PYSYSFLAG "--system")
+        endif()
+      endif()
+
+      #Python code used by gdb-plugin depends on "wheel" and "setuptool"
+      #packages. Skip the gdb-plugin if those are not available.
+      execute_process(COMMAND "${Python3_EXECUTABLE}" "-mpip" "show" "wheel"
+          OUTPUT_VARIABLE PIP3_SHOW_INFO
+          RESULT_VARIABLE PIP3_ERROR)
+      if (NOT ${PIP3_ERROR} EQUAL 0)
+        message(WARNING "PIP command failed, gdb-plugin disabled.")
+        return()
+      endif()
+      string(FIND ${PIP3_SHOW_INFO} "not found" WHEEL_FOUND)
+      if(NOT WHEEL_FOUND EQUAL -1)
+        message(WARNING "Required wheel, not found. gdb-plugin disabled.")
+        return()
+      endif()
+      execute_process(COMMAND "${Python3_EXECUTABLE}" "-mpip" "show" "setuptools"
+            OUTPUT_VARIABLE PIP3_SHOW_INFO
+            RESULT_VARIABLE PIP3_ERROR)
+      string(FIND ${PIP3_SHOW_INFO} "not found" SETUP_FOUND)
+      if(NOT SETUP_FOUND EQUAL -1)
+        message(WARNING "Required setuptools, not found. gdb-plugin disabled.")
+        return()
+      endif()
+    endif()
 endif()

openmp/libompd/gdb-plugin/CMakeLists.txt

 
 set (CMAKE_MODULE_PATH
     "${CMAKE_SOURCE_DIR}/libompd/"
     ${CMAKE_MODULE_PATH}
 )
 
 find_package (Python3 COMPONENTS Interpreter Development)
 
-file(READ "/etc/os-release" OS_RELEASE)
-set(DIST "")
-string(REGEX MATCH "Debian|Ubuntu" DIST ${OS_RELEASE})
-
-# UBUNTU and Debian package manager have its own patch in "pip" to avoid user
-# installed packages messing up with default paths.
-# https://bugs.launchpad.net/ubuntu/+source/python-pip/+bug/1419695
-# Therfore, we have to use "--system" (specific to ubuntu and debian) when we 
-# use system installed pip.(Not required if user installed pip on other paths.)
-# However, this has been taken care in pip for 20+ versions.
-# https://github.com/pypa/pip/commit/5f1468274987348b569aa586eeca4363494d0357
-
-if(DIST)
-    execute_process(COMMAND "${Python3_EXECUTABLE}"
-            "-mpip"
-            "--version"
-            OUTPUT_VARIABLE PIP_VERSION_INFO
-            RESULT_VARIABLE HAD_ERROR)
-    if (NOT ${HAD_ERROR} EQUAL 0)
-      message(WARNING "PIP command failed, gdb-plugin disabled.")
-      return()
-    endif ()
-    string(REGEX REPLACE " " ";" PIP_VERSION_INFO "${PIP_VERSION_INFO}")
-    list(GET PIP_VERSION_INFO 1 PIP_VERSION)
-    set(PYSYSFLAG "")
-
-    if(PIP_VERSION VERSION_LESS "20.0.0")
-      execute_process(COMMAND "${Python3_EXECUTABLE}"
-                "-mpip"
-                "install"
-                "--help"
-                OUTPUT_VARIABLE PIP_INSTALL_HELP
-                RESULT_VARIABLE HAD_ERROR )
-      string(REGEX MATCH "--system" SYSTEM_FLAG ${PIP_INSTALL_HELP})
-      if (SYSTEM_FLAG)
-        set(PYSYSFLAG "--system")
-      endif()
-    endif()
-endif()
+
 
 include_directories (${OMPD_INCLUDE_PATH})
 include_directories (${LIBOMP_INCLUDE_DIR})
 add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/python-module/ompd/__init__.py
                    DEPENDS ompdModule.c ompdAPITests.c setup.py ompd/frame_filter.py ompd/__init__.py ompd/ompd_address_space.py ompd/ompd_callbacks.py ompd/ompd_handles.py ompd/ompd.py
                    COMMAND ${CMAKE_COMMAND} -E env LIBOMP_INCLUDE_DIR=${LIBOMP_INCLUDE_DIR}
                    ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/setup.py -v bdist_wheel -b ${CMAKE_CURRENT_BINARY_DIR}/build -d ${CMAKE_CURRENT_BINARY_DIR}
                    COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/setup.py clean --all