Changing USE_LM_SENSORS to APEX_WITH_LM_SENSORS

CMakeLists.txt

@@ -508,7 +508,7 @@ endif()
 # LM Sensors configuration
 ################################################################################
 
-if((DEFINED LM_SENSORS_ROOT) OR (USE_LM_SENSORS))
+if((DEFINED LM_SENSORS_ROOT) OR (APEX_WITH_LM_SENSORS))
     find_package(LMSensors)
     if (LM_SENSORS_FOUND)
         include_directories(${LM_SENSORS_INCLUDE_DIRS})

cmake/Modules/APEX_DefaultOptions.cmake

@@ -13,6 +13,7 @@ option (APEX_WITH_PAPI "Enable PAPI support" FALSE)
 option (APEX_WITH_PLUGINS "Enable APEX policy plugin support" TRUE)
 option (APEX_WITH_TCMALLOC "Enable TCMalloc heap management" FALSE)
 option (APEX_WITH_JEMALLOC "Enable JEMalloc heap management" FALSE)
+option (APEX_WITH_LM_SENSORS "Enable LM Sensors support" FALSE)
 option (APEX_BUILD_TESTS "Build APEX tests (for 'make test')" TRUE)
 option (APEX_BUILD_EXAMPLES "Build APEX examples" TRUE)
 option (APEX_SANITIZE "Enable compiler sanitizer flags" FALSE)
@@ -70,6 +71,12 @@ if(DEFINED USE_TCMALLOC)
     set(APEX_WITH_TCMALLOC CACHE BOOL ${USE_TCMALLOC})
 endif()
 
+# Provide some backwards compatability
+if(DEFINED USE_LM_SENSORS)
+    message(WARNING "USE_LM_SENSORS is deprecated - please use APEX_WITH_LM_SENSORS")
+    set(APEX_WITH_LM_SENSORS CACHE BOOL ${USE_LM_SENSORS})
+endif()
+
 # Provide some backwards compatability
 if(DEFINED USE_JEMALLOC)
     message(WARNING "USE_JEMALLOC is deprecated - please use APEX_WITH_JEMALLOC")

doc/webdocs/docs/install.md

@@ -12,7 +12,7 @@ The `-DHPX_WITH_APEX_TAG=develop` can be used to indicate a specific release ver
 
 * `-DAPEX_WITH_LM_SENSORS=TRUE` to enable [LM sensors](https://hwmon.wiki.kernel.org/lm_sensors) support (assumed to be installed in default system paths)
 * `-DAPEX_WITH_PAPI=TRUE` and `-DPAPI_ROOT=...` to enable [PAPI](https://icl.utk.edu/papi/) support
-* `-DAPEX_WITH_BFD=TRUE` and `-DBFD_ROOT=...` *or* `-DBUILD_BFD=TRUE` to enable [Binutils](https://www.gnu.org/software/binutils/) support for converting function/lambda/instruction pointers to human-readable code regions.  For demangling of C++ symbols, `demangle.h` needs to be installed with the binutils headers (not typical in system installations).
+* `-DAPEX_WITH_BFD=TRUE` and `-DBFD_ROOT=...` *or* `-DAPEX_BUILD_BFD=TRUE` to enable [Binutils](https://www.gnu.org/software/binutils/) support for converting function/lambda/instruction pointers to human-readable code regions.  For demangling of C++ symbols, `demangle.h` needs to be installed with the binutils headers (not typical in system installations).
 * `-DAPEX_WITH_MSR=TRUE` to enable [libmsr](https://github.com/LLNL/libmsr) support for RAPL power measurement (typically not needed, as RAPL support is natively handled where available)
 * `-DAPEX_WITH_OTF2=TRUE` and `-DOTF2_ROOT=...` to enable [OTF2 tracing](https://www.vi-hps.org/projects/score-p/index.html) support
 * `-DHPX_WITH_HPXMP=TRUE` to enable HPX OpenMP support and OMPT measurement support from APEX
@@ -99,43 +99,43 @@ make install
 
 There are several utility libraries that provide additional functionality in APEX. Not all libraries are required, but some are recommended.  For the following options, the default values are in *italics*.
 
-* `-DUSE_ACTIVEHARMONY=`
+* `-DAPEX_WITH_ACTIVEHARMONY=`
   *TRUE* or FALSE.  Active Harmony is a library that intelligently searches for parametric combinations to support adapting to heterogeneous and changing environments.  For more information, see <http://www.dyninst.org/harmony>.  APEX uses Active Harmony for runtime adaptation.
 * `-DACTIVEHARMONY_ROOT=`
-  the path to Active Harmony, or set the ACTIVEHARMONY_ROOT environment variable before running cmake.  It should be noted that if Active Harmony is not specified and -DUSE_ACTIVEHARMONY is TRUE or not set, APEX will download and build Active Harmony as a CMake project. To disable Active Harmony entirely, specify -DUSE_ACTIVEHARMONY=FALSE.
-* `-DBUILD_ACTIVEHARMONY=`
+  the path to Active Harmony, or set the ACTIVEHARMONY_ROOT environment variable before running cmake.  It should be noted that if Active Harmony is not specified and -DAPEX_WITH_ACTIVEHARMONY is TRUE or not set, APEX will download and build Active Harmony as a CMake project. To disable Active Harmony entirely, specify -DAPEX_WITH_ACTIVEHARMONY=FALSE.
+* `-DAPEX_BUILD_ACTIVEHARMONY=`
   TRUE or *FALSE*.  Whether or not Active Harmony is installed on the system, this option forces CMake to automatically download and build Active Harmony as part of the APEX project.
-* `-DUSE_OMPT=`
+* `-DAPEX_WITH_OMPT=`
   TRUE or *FALSE*.  OMPT is a proposed standard for OpenMP runtimes to provide callback hooks to performance tools. For more information, see the [OpenMP specification](https://www.openmp.org/specifications/) v5.0 or newer.  APEX has support for most OMPT OpenMP trace events. See [the OpenMP use case](usecases.md#openmp-example) for an example.  Some compilers (Clang 10+, Intel 19+, IBM XL 16+) include OMPT support already, and APEX will use the built-in support.  For GCC, older Clang and older Intel Compilers, APEX can build and use the [LLVM OpenMP runtime](https://github.com/llvm-mirror/openmp) which provides KMP and GOMP API calls for those compilers.
 * `-DOMPT_ROOT=`
   the path to OMPT, or set the OMPT_ROOT environment variable before running cmake.
-* `-DBUILD_OMPT=`
+* `-DAPEX_BUILD_OMPT=`
   TRUE or *FALSE*. Whether or not an OpenMP library with OMPT support is found by CMake, this option forces CMake to automatically download and build an OpenMP runtime with OMPT support as part of the APEX project.  In most cases, only relevant for gcc/g++.
-* `-DUSE_BFD=`
+* `-DAPEX_WITH_BFD=`
   TRUE or *FALSE*.  APEX uses libbfd (Binutils) to convert instruction addresses to source code locations. BFD support is useful for generating human-readable output for summaries and concurrency graphs. Libbfd is not required for runtime adaptation.  For more information, see <https://www.gnu.org/software/binutils/>.
 * `-DBFD_ROOT=`
   path to Binutils, or set the BFD_ROOT environment variable.
-* `-DBUILD_BFD=`
+* `-DAPEX_BUILD_BFD=`
   TRUE or FALSE.  Whether or not binutils is found by CMake, this option forces CMake to automatically download and build binutils as part of the APEX project.
-* `-DUSE_TCMALLOC=`
+* `-DAPEX_WITH_TCMALLOC=`
   TRUE or *FALSE*.  TCMalloc is a heap management library distributed as part of Google perftools. For more information, see <https://github.com/gperftools/gperftools>.  TCMalloc provides faster memory performance in multithreaded environments.
 * `-DGPERFTOOLS_ROOT=`
   path to gperftools (TCMalloc), or set the GPERFTOOLS_ROOT environment variable before running cmake.
-* `-DUSE_JEMALLOC=`
+* `-DAPEX_WITH_JEMALLOC=`
   TRUE or *FALSE*.  JEMalloc is a heap management library.  For more information, see <http://www.canonware.com/jemalloc/>.  JEMalloc provides faster memory performance in multithreaded environments.
 * `-DJEMALLOC\_ROOT=`
   path to JEMalloc, or set the JEMALLOC_ROOT environment variable before running cmake.
-* `-DUSE_PAPI=`
+* `-DAPEX_WITH_PAPI=`
   TRUE or *FALSE*.  PAPI (Performance Application Programming Interface) provides the tool designer and application engineer with a consistent interface and methodology for use of the performance counter hardware found in most major microprocessors.  For more information, see <http://icl.cs.utk.edu/papi/>.  APEX uses PAPI to optionally collect hardware counters for timed events.
 * `-DPAPI_ROOT=`
   some path to PAPI, or set the PAPI_ROOT environment variable before running cmake. See [the PAPI use case](usecases.md#papi-example) for an example.
-* `-DUSE_LM_SENSORS=`
+* `-DAPEX_WITH_LM_SENSORS=`
   TRUE or *FALSE*. Lm\_sensors (Linux Monitoring Sensors) is a library for monitoring hardware temperatures and fan speeds. For more information, see <https://en.wikipedia.org/wiki/Lm_sensors>.  APEX uses lm\_sensors to monitor hardware, where available.
-* `-DBUILD_EXAMPLES=`
+* `-DAPEX_BUILD_EXAMPLES=`
   TRUE or *FALSE*. Whether or not to build the application examples in APEX.
-* `-DBUILD_TESTS=`
+* `-DAPEX_BUILD_TESTS=`
   *TRUE* or FALSE. Whether or not to build the APEX unit tests.
-* `-DUSE_MPI=`
+* `-DAPEX_WITH_MPI=`
   TRUE or *FALSE*. Whether to build MPI global support and related examples.
 
 ### Other CMake variables of interest