Out-of-the-box installation does not work (for me)

[DanielDoehring]

I installed LIKWID using the quick install routine. That seems to have worked out, as I am getting

~/Software/likwid-5.3.0$ sudo make install
===> INSTALL access daemon to /usr/local/sbin/likwid-accessD
===> INSTALL setFrequencies tool to /usr/local/sbin/likwid-setFreq
===> No INSTALL of the application interface appDaemon
===> INSTALL applications to /usr/local/bin
===> INSTALL helper applications to /usr/local/bin
===> INSTALL lua to likwid interface to /usr/local/share/lua
===> INSTALL libraries to /usr/local/lib
===> INSTALL man pages to /usr/local/man/man1
===> INSTALL headers to /usr/local/include
===> INSTALL groups to /usr/local/share/likwid/perfgroups
===> INSTALL docs and examples to /usr/local/share/likwid/docs
===> INSTALL filters to /usr/local/share/likwid/filter
===> INSTALL cmake to /usr/local/share/likwid

with (default) config.mk file

#################################################################
#################################################################
# Configuration options                                         #
#################################################################
#################################################################

# Please have a look in INSTALL and the WIKI for details on
# configuration options setup steps.
# Supported: GCC, CLANG, ICC, MIC (ICC), GCCX86 (for 32bit systems)
# GCCARMv8, GCCARMv7 and GCCPOWER
COMPILER = GCC#NO SPACE

# Path were to install likwid
PREFIX ?= /usr/local#NO SPACE

# Set the default mode for MSR access.
# This can usually be overriden on the commandline.
# Valid values are: direct, accessdaemon and perf_event
ACCESSMODE = accessdaemon#NO SPACE

# Build Fortran90 module interface for Marker API. Adopt Fortran compiler
# in ./make/include_<COMPILER>.mk if necessary. Default: ifort (even for
# COMPILER=GCC)
FORTRAN_INTERFACE = false#NO SPACE

# Instrument likwid-bench with Marker API calls for use with likwid-perfctr
INSTRUMENT_BENCH = true#NO SPACE

# Build LIKWID with NVIDIA interface (CUDA, CUPTI)
# For configuring include paths, go to CUDA section
NVIDIA_INTERFACE = false#NO SPACE

# Build LIKWID with AMD GPU interface (ROCm)
# For configuring include paths, go to ROCm section
ROCM_INTERFACE = false#NO SPACE

# Build experimental sysfeatures interface and Lua CLI application
BUILD_SYSFEATURES = false#NO SPACE

#################################################################
#################################################################
# Advanced configuration options                                #
# Most users do not need to change values below this comment!   #
#################################################################
#################################################################

# Define the color of the likwid-pin output
# Can be NONE, BLACK, RED, GREEN, YELLOW, BLUE,
# MAGENTA, CYAN or WHITE
COLOR = BLUE#NO SPACE

# Some path definitions
MANPREFIX = $(PREFIX)/man#NO SPACE
BINPREFIX = $(PREFIX)/bin#NO SPACE
SBINPREFIX = $(PREFIX)/sbin#NO SPACE
LIBPREFIX = $(PREFIX)/lib#NO SPACE

# These paths are hardcoded into executables and libraries. Usually
# they'll be the same as above, but package maintainers may want to
# distinguish between the image directories and the final install
# target.
# Keep in mind that the access and setFreq daemon need enough
# privileges that may be deleted when copying the files to
# the INTSTALLED_PREFIX
INSTALLED_PREFIX ?= $(PREFIX)#NO SPACE
INSTALLED_BINPREFIX = $(INSTALLED_PREFIX)/bin#NO SPACE
INSTALLED_SBINPREFIX = $(INSTALLED_PREFIX)/sbin#NO SPACE
INSTALLED_LIBPREFIX = $(INSTALLED_PREFIX)/lib#NO SPACE

# Build the accessDaemon. Have a look in the WIKI for details.
BUILDDAEMON = true#NO SPACE
# For the daemon based secure msr/pci access configure
# the absolute path to the msr daemon executable.
ACCESSDAEMON = $(SBINPREFIX)/likwid-accessD#NO SPACE
INSTALLED_ACCESSDAEMON = $(INSTALLED_SBINPREFIX)/likwid-accessD#NO SPACE

# Build the setFrequencies daemon to allow users setting the CPU and Uncore
# frequency
BUILDFREQ = true#NO SPACE
# Paths for frequencie deaemon after installation
FREQDAEMON = $(SBINPREFIX)/likwid-setFreq#NO SPACE
INSTALLED_FREQDAEMON = $(INSTALLED_SBINPREFIX)/likwid-setFreq#NO SPACE

# Build the appDaemon. It's not really a daemon but an LD_PRELOAD library
# It is required to get access to the application context.
BUILDAPPDAEMON=true
APPDAEMON = $(PREFIX)/lib/likwid-appDaemon.so#NO SPACE
INSTALLED_APPDAEMON = $(INSTALLED_PREFIX)/lib/likwid-appDaemon.so#NO SPACE

# chown installed tools to this user/group
# if you change anything here, make sure that the user/group can access
# the MSR devices and (on Intel) the PCI devices.
INSTALL_CHOWN = -g root -o root#NO SPACE

# uncomment to optionally set external [email protected] or [email protected]:
# default is use internally provide lua
#LUA_INCLUDE_DIR = /usr/include/lua5.2#NO SPACE
#LUA_LIB_DIR = /usr/lib/x86_64-linux-gnu#NO SPACE
#LUA_LIB_NAME = lua5.2#NO SPACE, executable is assumed to have the same name
#LUA_BIN = /usr/bin#NO SPACE

# uncomment to optionally use system hwloc (tested with hwloc 2.x):
# default is to use internal hwloc
#HWLOC_INCLUDE_DIR = /usr/include#NO SPACE
#HWLOC_LIB_DIR = /usr/lib#NO SPACE
#HWLOC_LIB_NAME = hwloc#NO SPACE, used later as -l$HWLOC_LIB_NAME

# Change to true to a build shared library instead of a static one
# It is NOT recommended to switch to static libraries as some features don't
# work when compiled statically
SHARED_LIBRARY = true#NO SPACE

# Build LIKWID with debug flags
DEBUG = false#NO SPACE

# Basic configuration for some internal arrays.
# Maximal number of hardware threads
MAX_NUM_THREADS = 500
# Maximal number of sockets
MAX_NUM_NODES = 128
# Maximal number of CLI parameters
MAX_NUM_CLIARGS = 16384

# Paths to some configuration files that can be used to overwrite some
# array lengths defined at compilation
CFG_FILE_PATH = /etc/likwid.cfg
# With the likwid-genTopoCfg it is possible to store the topology of a system
# in a file to avoid re-reading all topology informations again
TOPO_FILE_PATH = /etc/likwid_topo.cfg

# Versioning Information
# The libraries are named liblikwid.<VERSION>.<RELEASE>
VERSION = 5
RELEASE = 3
MINOR = 0
# Date when the release is published
DATE    = 10.11.2023

# In come cases it is important to set the rpaths for the LIKWID library. One
# example is the use of sudo because it resets environment variables like
# LD_LIBRARY_PATH
RPATHS = -Wl,-rpath=$(INSTALLED_LIBPREFIX)

# LIKWID uses a lock to avoid simultaneous usage by multiple users. The user
# owning this file has access to the LIKWID library and can use LIKWID
# simultaneously.
LIKWIDLOCKPATH = /var/run/likwid.lock

# The access daemon creates sockets under this path to communicate with the
# LIKWID library.
LIKWIDSOCKETBASE = /tmp/likwid  # -%d will be added automatically to the socket name

# The pinning library is put in LD_PRELOAD when using LIKIWD for thread/process
# pinning. The library overloads the pthread_create function to pin threads
# directly after their creation
LIBLIKWIDPIN = $(abspath $(INSTALLED_LIBPREFIX)/liblikwidpin.so.$(VERSION).$(RELEASE))

# Some tools (likwid-perfctr and likwid-topology) provide the export of their
# output to a file. LIKWID tries to format the file based on the file suffix.
# The folder contains scripts named as the file suffix, like xml, which read
# the CSV output of the tools and perform the conversation to the desired file
# format
LIKWIDFILTERPATH = $(abspath $(INSTALLED_PREFIX)/share/likwid/filter)

# LIKWID uses txt-files as input for the performance groups. The configured
# folder contains folders for each architecture with the architecture-specific
# performance group files. Despite this folder, LIKWID also checks
# $HOME/.likwid/groups
LIKWIDGROUPPATH = $(abspath $(INSTALLED_PREFIX)/share/likwid/perfgroups)

# CUDA / CUPTI build data
# LIKWID requires CUDA and CUPTI to be present only for compilation with
# NVIDIA_INTERFACE=true. At runtime, the CUDA and the CUPTI library have
# to be in the LD_LIBRARY_PATH to dynamically load the libraries.
# Include directory for CUDA headers
CUDAINCLUDE = $(CUDA_HOME)/include
# Include directory for CUPTI headers
CUPTIINCLUDE = $(CUDA_HOME)/extras/CUPTI/include
# In order to hook into the CUDA application, the appDaemon is required
# If you just want the NvMarkerAPI, you can keep it false
BUILDAPPDAEMON=false

# ROCm build data
# LIKWID requires ROCm to be present only for compilation with
# ROCM_INTERFACE=true. At runtime, the ROCm library have
# to be in the LD_LIBRARY_PATH to dynamically load the libraries.
# Include directory for ROCm headers
HSAINCLUDE 			= $(ROCM_HOME)/include
ROCPROFILERINCLUDE	        = $(ROCM_HOME)/include/rocprofiler
HIPINCLUDE 			= $(ROCM_HOME)/include
RSMIINCLUDE			= $(ROCM_HOME)/include

and indeed the shared libraries are present in /usr/share/local:

However

julia> using LIKWID
┌ Warning: The library `liblikwid`` couldn't be found. Don't expect anything to work.
│   liblikwid = "liblikwid"
└ @ LIKWID ~/.julia/packages/LIKWID/LBnVK/src/LIKWID.jl:96

So I had a brief look in to the source code which revealed that

LIKWID.jl/src/misc.jl

Lines 79 to 81 in 83707df

	function liblikwid_available()
	return Libdl.find_library(liblikwid) != ""
	end

calls

https://github.com/JuliaLang/julia/blob/80a279152bd090cca0a3bed598f0059cffa74b26/base/libdl.jl#L199-L216

without any extrapaths which might cause the error?

[carstenbauer]

Do you have /usr/local/lib on LD_LIBRARY_PATH?

[carstenbauer]

You could also reactivate/take over #43 which allows setting the path to liblikwid as a preference.

[DanielDoehring]

Hm, looks like this was an issue with VSCode which probably required a restart after updating the LD_LIBRARY_PATH.
Anyways, maybe it makes sense to mention in the README.md that the user needs to have LD_LIBRARY_PATH pointing to the correct directory?

[carstenbauer]

Sure, doesn't hurt I guess. Although that's just how dynamic libraries work. Feel free to make a PR!