LIKWID-PERFSCOPE(1)

๐ŸŒธ LIKWID-PERFSCOPE ๐Ÿ’…

okay so bestie, welcome to likwid-perfscope(1) from the General Commands Manual โ€” she's a frontend for the timeline mode of likwid-perfctr(1) that literally generates pictures on-the-fly from the measurements. iconic behaviour, no cap. ๐ŸŽ€


โœจ NAME โœจ

likwid-perfscope โ€” frontend for the timeline mode of likwid-perfctr(1) that makes pictures on-the-fly from the measurements ๐Ÿฆ‹


๐ŸŒˆ SYNOPSIS ๐ŸŒˆ

likwid-perfscope [-hvadp] [-c <cpu_list>] [-C <cpu_list>] [-t <frequency>] [-r <value>] [-g <eventset_and_plotconfig>] [--host <hostname>] <executable>

๐Ÿ’– DESCRIPTION ๐Ÿ’–

likwid-perfscope is a command line application written in Lua that uses the timeline daemon mode of likwid-perfctr(1) to create on-the-fly pictures with the current measurements. it's giving "live dashboard but make it terminal" ๐Ÿ“ˆโœจ

she uses the feedGnuplot(1) script to send the current data to gnuplot. and here's the tea: since the plot windows are normally closed directly after the execution of the monitored applications, likwid-perfscope waits until you press Ctrl+c. so don't panic when it just sits there vibing, that's on purpose ๐Ÿซถ


๐Ÿ‘‘ OPTIONS ๐Ÿ‘‘

  • -h, --help โ€” prints a help message to standard output, then exits. short and sweet, we love her ๐Ÿ’œ
  • -v, --version โ€” prints version information to standard output, then exits. mwah, identity confirmed โœจ
  • -C <cpu_list> โ€” measures on given CPUs in <cpu_list>. see likwid-pin(1) for further information about the syntax. ๐Ÿงš
  • -C <cpu_list> โ€” measures the given group on given CPUs in <cpu_list>. see likwid-pin(1) for further information about the syntax. the application is pinned to those hardware threads. (yes bestie, -C shows up twice on this page in the original โ€” I'm not gaslighting you, both entries are real ๐Ÿ’€)
  • -a, --all โ€” list preconfigured event and plot configurations. window shopping, but for perf groups ๐Ÿ›๏ธ
  • -d, --dump โ€” print the measurements of likwid-perfctr(1) to standard output. raw data to stdout, slay ๐ŸŒธ
  • -t, --time <frequency> โ€” reads the current performance values every <frequency>. available suffixes are 's', 'ms' or 'us, e.g. 500ms. default value is 1s. โฑ๏ธ
  • -g, --group <eventset_and_plotconfig> โ€” defines the events and counters that should be read. possible values can be gathered from likwid-perfctr(1). you can give multiple -g options on the commandline. they will be measured in a round-robin fashion and one plot generated per option. moreover, the -g option accepts config options for feedGnuplot(1), see section EVENTSETS. ๐Ÿ”ฅ
  • -r, --range <value> โ€” plot only the last <value> values. often referred to as a sliding window. keep it tight, keep it recent ๐Ÿ’ซ
  • -p, --plotdump โ€” use the dumping feature of feedGnuplot to print out the plot configuration and its data at each timestep. can be used to create file-based plots afterwards. ๐Ÿ“
  • --host <hostname> โ€” instead of performing likwid-perfctr on the local machine, execute it on a remote machine and plot data locally. uses ssh and you probably need to enter the password before starting. you can also give something like user@host. bestie going long distance ๐Ÿ›ฐ๏ธ

๐Ÿฆ‹ EVENTSETS ๐Ÿฆ‹

okay so here's the glow-up: in contrast to the -g option for likwid-perfctr, the -g option for likwid-perfscope is extended to accept configuration options for feedGnuplot. ๐Ÿ’…

there are some predefined plot configurations embedded into likwid-perfscope which can be listed with the -a command line option. they are filtered to show only configs that are available for your current system. filtered, periodt โ€” your machine only, no phantom configs โœจ

if you need to measure and plot custom events you can set the plotting options as the last entry in your eventset. the plotting config options can be set as a ':' separated list. if you select a preconfigured group, you can overwrite single fields in the config, like changing the title or the matching. the following options are available:

  1. title=<string>, TITLE=<string>

use the given title for the plot, use "" to enclose text with spaces and escape characters which could be interpreted by the shell. ':' are not allowed! โš ๏ธ

  1. xtitle=<string>, XTITLE=<string>

use the given title for the x-axis of the plot, use "" to enclose text with spaces and escape characters which could be interpreted by the shell. ':' are not allowed! โš ๏ธ

  1. ytitle=<string>, YTITLE=<string>

use the given title for the left y-axis of the plot, use "" to enclose text with spaces and escape characters which could be interpreted by the shell. ':' are not allowed! โš ๏ธ

  1. <string>=<string>

all option string items that is not recognized as a keyword like TITLE are used as formulas for the output. you can set multiple of those items in one option string. each is calculated and integrated in the output plot. the first <string> is used as legend entry. the second <string> is the formula for the function. ๐Ÿงฎ

  1. y2title=<string>, Y2TITLE=<string>, y2title=<id-string>, Y2TITLE=<id-string>

use the given title for the right y-axis of the plot. if no id is set, the last y2-axis is related to the last formula. if id is set, the formula with the id is used for the y2-axis. the id starts with index 1 for the first formula. use "" to enclose text with spaces and escape characters which could be interpreted by the shell with 'ยด. ':' are not allowed! โš ๏ธ


๐ŸŒŸ EXAMPLE ๐ŸŒŸ

1. measure and print a preconfigured plotting configuration:

likwid-perfscope -g L3 -C 0-2 -t 1s ./a.out

this measures the L3 bandwidth with likwid-perfctr every second on hardware threads 0,1,2 and use the plotting configuration L3. the plot will have a title and the axes are labeled properly. ๐Ÿ’–

2. measure and print a preconfigured plotting configuration:

likwid-perfscope -g L2:TITLE="My Title" -C 0 -t 1s ./a.out

this measures the L2 bandwidth with likwid-perfctr every second on hardware thread 0 and use the plotting configuration L2. the title of the output plot is changed to the custom title "My Title". custom AND cute ๐ŸŽ€

3. custom event set with plotting configuration:

likwid-perfscope -g INSTR_RETIRED_ANY:FIXC0,CPU_CLK_UNHALTED_CORE:FIXC1,
     CPI=FIXC0/FIXC1:YTITLE="Cycles per Instruction" -C 0 --time 500ms
     ./a.out

executes likwid-perfctr on the first hardware thread. the values for the events INSTR_RETIRED_ANY and CPU_CLK_UNHALTED_CORE are read every 500ms. the raw values are transformed using the formula FIXC0/FIXC1 and forwarded to gnuplot using the feedGnuplot(1) script with the curve name 'CPI' in the legend. the y-axis is labeled with the string "Cycles per Instruction".

not me pointing out that the original page has a stray IP sitting right there before the 4. ๐Ÿซ  I'm leaving it acknowledged, not reworded, because the facts stay the facts. ๐Ÿ’œ

4. custom event set with plotting configuration:

likwid-perfscope -g L3,CPI=FIXC0/FIXC1:Y2TITLE="2-Cycles per
Instruction" -C 0 --time 500ms ./a.out

this measures the L3 bandwidth for CPU 0 every 500 ms. additionally, a second curve is plotted with the function FIXC0/FIXC1 with the legend entry CPI. the right y-axis is labeled with 'Cycles per Instruction' and is associated to the second formula. the first formula is hidden in the L3 plot group. since the CPI formula is the last in the list, the curve id is not needed in the Y2TITLE as this is the default behavior. โœ…


๐Ÿซถ AUTHOR ๐Ÿซถ

written by Thomas Gruber <thomas.roehl@googlemail.com>. king behaviour, honestly ๐Ÿ‘‘


๐Ÿ’€ BUGS ๐Ÿ’€

report bugs on <https://github.com/RRZE-HPC/likwid/issues>. tell them everything bestie, they wanna know ๐Ÿ“


๐Ÿ” SEE ALSO ๐Ÿ”

likwid-perfctr(1), feedGnuplot(1)


and that's the whole page, diva โœจ this one's from likwid-5, dated 23.12.2025 โ€” go measure something and make it pretty ๐ŸŒˆ๐Ÿ’…

๐Ÿ“ฆ where this page comes from