perf: enable compression of record mode trace to save storage space
Subsystems (2)
v9 cover perf: enable compression of record mode trace to save storage space
The patch set implements runtime trace compression (-z option) in record mode and trace auto decompression in report and inject modes. Streaming Zstd API [1] is used for compression and decompression of data that come from kernel mmaped data buffers.
Usage of implemented -z,--compression_level=n option provides ~3-5x avg. trace file size reduction on variety of tested workloads what saves storage space on larger server systems where trace file size can easily reach several tens or even hundreds of GiBs, especially when profiling with dwarf-based stacks and tracing of context switches. Default option value is 1 (fastest compression).
Implemented --mmap-flush option can be used to specify minimal size of data chunk that is extracted from mmaped kernel buffer to store into a trace. The option is independent from -z setting and doesn't vary with compression level. The default option value is 1 byte what means every time trace writing thread finds some new data in the mmaped buffer the data is extracted, possibly compressed and written to a trace. The option serves two purposes the first one is to increase the compression ratio of trace data and the second one is to avoid live-lock self tool process monitoring in system wide (-a) profiling mode. Profiling in system wide mode with compression (-a -z) can additionally induce data into the kernel buffers along with the data from monitored processes. If performance data rate and volume from the monitored processes is high then trace streaming and compression activity in the tool is also high. It can lead to subtle live-lock effect of endless activity when compression of single new byte from some of mmaped kernel buffer induces the next single byte at some mmaped buffer. So perf tool thread never stops on polling event file descriptors. Varying data chunk size to be extracted from mmap buffers allows avoiding live-locking self monitoring in system wide mode and makes mmap buffers polling loop manageable. Possible usage examples:
$ tools/perf/perf record -z -e cycles -- matrix.gcc $ tools/perf/perf record --aio -z -e cycles -- matrix.gcc $ tools/perf/perf record -z --mmap-flush 1024 -e cycles -- matrix.gcc $ tools/perf/perf record --aio -z --mmap-flush 1K -e cycles -- matrix.gcc
Runtime compression overhead has been measured for serial and AIO trace writing modes when profiling matrix multiplication workload:
-------------------------------------------------------------
| SERIAL | AIO-1 |
----|-----------------------------|-----------------------------| |-z | OVH(x) | ratio(x) size(MiB) | OVH(x) | ratio(x) size(MiB) | |---|--------|--------------------|--------|--------------------| | 0 | 1,00 | 1,000 179,424 | 1,00 | 1,000 187,527 | | 1 | 1,04 | 8,427 181,148 | 1,01 | 8,474 188,562 | | 2 | 1,07 | 8,055 186,953 | 1,03 | 7,912 191,773 | | 3 | 1,04 | 8,283 181,908 | 1,03 | 8,220 191,078 | | 5 | 1,09 | 8,101 187,705 | 1,05 | 7,780 190,065 | | 8 | 1,05 | 9,217 179,191 | 1,12 | 6,111 193,024 |
-----------------------------------------------------------------
OVH = (Execution time with -z N) / (Execution time with -z 0)
ratio - compression ratio
size - number of bytes that was compressed
size ~= trace file x ratio
See complete description of measurement conditions with details below.
Introduced compression functionality can be disabled or configured from the command line using NO_LIBZSTD and LIBZSTD_DIR defines:
$ make -C tools/perf NO_LIBZSTD=1 clean all $ make -C tools/perf LIBZSTD_DIR=/path/to/zstd/sources/ clean all
If your system has some version of the zstd package preinstalled then the build system finds and uses it during the build. Auto detection feature status is reported just before compilation starts, as usual. If you still prefer to compile with some other version of zstd you have capability to refer the compilation to that version using LIBZSTD_DIR define.
See 'perf test' results below for enabled and disabled (NO_LIBZSTD=1) feature configurations.
---
Alexey Budankov (12):
feature: implement libzstd check, LIBZSTD_DIR and NO_LIBZSTD defines perf record: implement --mmap-flush=<number> option
perf session: define bytes_transferred and bytes_compressed metrics perf record: implement COMPRESSED event record and its attributes perf mmap: implement dedicated memory buffer for data compression perf util: introduce Zstd streaming based compression API perf record: implement compression for serial trace streaming perf record: implement compression for AIO trace streaming perf record: implement -z,--compression_level[=<n>] option perf report: implement record trace decompression
perf inject: enable COMPRESSED records decompression
perf tests: implement Zstd comp/decomp integration test
tools/build/Makefile.feature | 6 +- tools/build/feature/Makefile | 6 +- tools/build/feature/test-all.c | 5 + tools/build/feature/test-libzstd.c | 12 + tools/perf/Documentation/perf-record.txt | 17 ++ .../Documentation/perf.data-file-format.txt | 24 ++ tools/perf/Makefile.config | 20 ++ tools/perf/Makefile.perf | 3 + tools/perf/builtin-inject.c | 4 + tools/perf/builtin-record.c | 285 +++++++++++++++--- tools/perf/builtin-report.c | 5 +- tools/perf/builtin-version.c | 2 + tools/perf/perf.h | 2 + .../tests/shell/record+zstd_comp_decomp.sh | 28 ++ tools/perf/util/Build | 2 + tools/perf/util/compress.h | 54 ++++ tools/perf/util/env.h | 11 + tools/perf/util/event.c | 1 + tools/perf/util/event.h | 7 + tools/perf/util/evlist.c | 8 +- tools/perf/util/evlist.h | 3 +- tools/perf/util/header.c | 55 +++- tools/perf/util/header.h | 1 + tools/perf/util/mmap.c | 106 ++----- tools/perf/util/mmap.h | 17 +- tools/perf/util/session.c | 124 +++++++- tools/perf/util/session.h | 14 + tools/perf/util/tool.h | 2 + tools/perf/util/zstd.c | 111 +++++++ 29 files changed, 801 insertions(+), 134 deletions(-) create mode 100644 tools/build/feature/test-libzstd.c create mode 100755 tools/perf/tests/shell/record+zstd_comp_decomp.sh create mode 100644 tools/perf/util/zstd.c
---
Changes in v9:
- fixed issue with improper max COMPRESSED record size calculation
- moved up calculation of ratio variable in 03/12
- made minor corrections in changelogs
- corrected several checkpatch.pl warnings and errors
Changes in v8:
- avoid using -f for --mmap-flush option
- move stubs to compress.h and avoid unconditional compiling of zstd.c
- fixed silent interruption for perf record collection
- implemented -z 1 as default
Changes in v7:
- rebased to Arnaldo's perf/core tip
- implemented B/K/M/G suffixes for -f option
- reworked record__mmap_read_evlist() to replace perf_mmap__aio_push() by perf_mmap__push() in AIO case
- extended "[ perf record: Captured ... ]" message with compression statistics
- extended changelog for v5 06/10
- used PERF_SAMPLE_MAX_SIZE for compressed record size calculations
- renamed record__zstd_compress to zstd_compress and record__process_comp_header to process_comp_header
- separated nr_cblocks_max applying
Changes in v6:
- extended docs with description of PERF_RECORD_COMPRESSED record and HEADER_COMPRESSED feature layouts
Changes in v5:
- implemented perf version --build-options extension for aio and zstd - see TESTING below
- adjusted commit message and perf-record.txt content for -f option
- fixed build errors in case of NO_AIO=1 and NO_LIBZSTD=1
Changes in v4:
- implemented integration tests
- adjusted zstd_ stub functions
- rebased on tip of Arnaldo's perf/core
Changes in v3:
- moved -f,--mmap-flush option implementation into a separate patch
- moved definition and printing of bytes_transferred and bytes_compressed into a separate patch
- moved COMPRESSED feature into a separate patch
- added versioning and stored COMPRESSED feature attributes as u32
- implemented dedicated memory buffer for compression in case of serial streaming
- moved low level Zstd based compression functions into util/{compress.h,zstd.c}
- made compress function to be a param of __push(), __aio_push() functions
- enabled perf inject to decompress COMPRESSED records
- measured compression overhead for serial and AIO streaming using
basic matrix multiplication workload on 8 core skylake
Changes in v2:
- moved compression/decompression code to session layer
- enabled allocation aio data buffers for compression
- enabled trace compression for serial trace streaming
---
[1] https://github.com/facebook/zstd
---
OVERHEAD MEASUREMENTS:
uname -a
Linux localhost 4.20.7-200.fc29.x86_64 #1 SMP Wed Feb 6 19:16:42 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux
cat /proc/cpuinfo
processor : 7vendor_id : GenuineIntel
cpu family : 6
model : 94
model name : Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz
stepping : 3
microcode : 0xc6
cpu MHz : 4021.884
cache size : 8192 KB
physical id : 0
siblings : 8
core id : 3
cpu cores : 4
apicid : 7
initial apicid : 7
fpu : yesfpu_exception : yes
cpuid level : 22
wp : yes
flags : fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf tsc_known_freq pni pclmulqdq dtes64 monitor ds_cpl vmx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault invpcid_single pti ssbd ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm mpx rdseed adx smap clflushopt intel_pt xsaveopt xsavec xgetbv1 xsaves dtherm ida arat pln pts hwp hwp_notify hwp_act_window hwp_epp flush_l1d
bugs : cpu_meltdown spectre_v1 spectre_v2 spec_store_bypass l1tf
bogomips : 8016.00
clflush size : 64cache_alignment : 64
address sizes : 39 bits physical, 48 bits virtual
power management:
-----------------------------------------------------------------
#!/bin/bash -xv
echo 0 > /proc/sys/kernel/perf_event_paranoid
+ echo 0
cat /proc/sys/kernel/perf_event_paranoid
+ cat /proc/sys/kernel/perf_event_paranoid
0
echo performance | tee /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor
+ echo performance
+ tee /sys/devices/system/cpu/cpu0/cpufreq/scaling_governor /sys/devices/system/cpu/cpu1/cpufreq/scaling_governor /sys/devices/system/cpu/cpu2/cpufreq/scaling_governor /sys/devices/system/cpu/cpu3/cpufreq/scaling_governor /sys/devices/system/cpu/cpu4/cpufreq/scaling_governor /sys/devices/system/cpu/cpu5/cpufreq/scaling_governor /sys/devices/system/cpu/cpu6/cpufreq/scaling_governor /sys/devices/system/cpu/cpu7/cpufreq/scaling_governor performance
for i in 0 1 2 3 5 8
do
/usr/bin/time tools/perf/perf record -z $i -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc
done
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record -z 0 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7fe36de5c010
Offs of buf1 = 0x7fe36de5c180
Addr of buf2 = 0x7fe36be5b010
Offs of buf2 = 0x7fe36be5b1c0
Addr of buf3 = 0x7fe369e5a010
Offs of buf3 = 0x7fe369e5a100
Addr of buf4 = 0x7fe367e59010
Offs of buf4 = 0x7fe367e59140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 16.949 seconds
[ perf record: Woken up 309 times to write data ]
[ perf record: Captured and wrote 179.424 MB perf.data ]
133.67user 0.35system 0:17.08elapsed 784%CPU (0avgtext+0avgdata 100580maxresident)k 0inputs+367480outputs (0major+34737minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record -z 1 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7fcaec334010
Offs of buf1 = 0x7fcaec334180
Addr of buf2 = 0x7fcaea333010
Offs of buf2 = 0x7fcaea3331c0
Addr of buf3 = 0x7fcae8332010
Offs of buf3 = 0x7fcae8332100
Addr of buf4 = 0x7fcae6331010
Offs of buf4 = 0x7fcae6331140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 17.608 seconds
[ perf record: Woken up 595 times to write data ]
[ perf record: Compressed 181.148 MB to 21.497 MB, ratio is 8.427 ]
[ perf record: Captured and wrote 21.527 MB perf.data ]
135.69user 0.24system 0:17.73elapsed 766%CPU (0avgtext+0avgdata 100500maxresident)k 0inputs+44112outputs (0major+35033minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record -z 2 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7f1336f8d010
Offs of buf1 = 0x7f1336f8d180
Addr of buf2 = 0x7f1334f8c010
Offs of buf2 = 0x7f1334f8c1c0
Addr of buf3 = 0x7f1332f8b010
Offs of buf3 = 0x7f1332f8b100
Addr of buf4 = 0x7f1330f8a010
Offs of buf4 = 0x7f1330f8a140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 18.175 seconds
[ perf record: Woken up 521 times to write data ]
[ perf record: Compressed 186.953 MB to 23.210 MB, ratio is 8.055 ]
[ perf record: Captured and wrote 23.239 MB perf.data ]
140.21user 0.25system 0:18.32elapsed 766%CPU (0avgtext+0avgdata 100560maxresident)k 0inputs+47608outputs (0major+35263minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record -z 3 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7f97060e3010
Offs of buf1 = 0x7f97060e3180
Addr of buf2 = 0x7f97040e2010
Offs of buf2 = 0x7f97040e21c0
Addr of buf3 = 0x7f97020e1010
Offs of buf3 = 0x7f97020e1100
Addr of buf4 = 0x7f97000e0010
Offs of buf4 = 0x7f97000e0140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 17.688 seconds
[ perf record: Woken up 485 times to write data ]
[ perf record: Compressed 181.908 MB to 21.962 MB, ratio is 8.283 ]
[ perf record: Captured and wrote 21.991 MB perf.data ]
136.87user 0.23system 0:17.81elapsed 769%CPU (0avgtext+0avgdata 100616maxresident)k 0inputs+45064outputs (0major+35773minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record -z 5 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7f477b444010
Offs of buf1 = 0x7f477b444180
Addr of buf2 = 0x7f4779443010
Offs of buf2 = 0x7f47794431c0
Addr of buf3 = 0x7f4777442010
Offs of buf3 = 0x7f4777442100
Addr of buf4 = 0x7f4775441010
Offs of buf4 = 0x7f4775441140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 18.406 seconds
[ perf record: Woken up 416 times to write data ]
[ perf record: Compressed 187.705 MB to 23.170 MB, ratio is 8.101 ]
[ perf record: Captured and wrote 23.200 MB perf.data ]
142.72user 0.26system 0:18.53elapsed 771%CPU (0avgtext+0avgdata 100520maxresident)k 0inputs+47528outputs (0major+36928minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record -z 8 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7fb5bf032010
Offs of buf1 = 0x7fb5bf032180
Addr of buf2 = 0x7fb5bd031010
Offs of buf2 = 0x7fb5bd0311c0
Addr of buf3 = 0x7fb5bb030010
Offs of buf3 = 0x7fb5bb030100
Addr of buf4 = 0x7fb5b902f010
Offs of buf4 = 0x7fb5b902f140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 17.751 seconds
[ perf record: Woken up 391 times to write data ]
[ perf record: Compressed 179.191 MB to 19.441 MB, ratio is 9.217 ]
[ perf record: Captured and wrote 19.502 MB perf.data ]
138.90user 0.29system 0:17.88elapsed 778%CPU (0avgtext+0avgdata 100612maxresident)k 0inputs+39968outputs (0major+37436minor)pagefaults 0swaps
for i in 0 1 2 3 5 8
do
/usr/bin/time tools/perf/perf record --aio=1 -z $i -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc
done
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record --aio=1 -z 0 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7feee4519010
Offs of buf1 = 0x7feee4519180
Addr of buf2 = 0x7feee2518010
Offs of buf2 = 0x7feee25181c0
Addr of buf3 = 0x7feee0517010
Offs of buf3 = 0x7feee0517100
Addr of buf4 = 0x7feede516010
Offs of buf4 = 0x7feede516140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 17.912 seconds
[ perf record: Woken up 390 times to write data ]
[ perf record: Captured and wrote 187.527 MB perf.data ]
139.70user 0.39system 0:18.04elapsed 776%CPU (0avgtext+0avgdata 100624maxresident)k 0inputs+384072outputs (0major+35257minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record --aio=1 -z 1 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7f72b93ac010
Offs of buf1 = 0x7f72b93ac180
Addr of buf2 = 0x7f72b73ab010
Offs of buf2 = 0x7f72b73ab1c0
Addr of buf3 = 0x7f72b53aa010
Offs of buf3 = 0x7f72b53aa100
Addr of buf4 = 0x7f72b33a9010
Offs of buf4 = 0x7f72b33a9140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 18.198 seconds
[ perf record: Woken up 416 times to write data ]
[ perf record: Compressed 188.562 MB to 22.252 MB, ratio is 8.474 ]
[ perf record: Captured and wrote 22.284 MB perf.data ]
141.12user 0.32system 0:18.32elapsed 771%CPU (0avgtext+0avgdata 100576maxresident)k 0inputs+45664outputs (0major+35040minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record --aio=1 -z 2 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7ffb9caf3010
Offs of buf1 = 0x7ffb9caf3180
Addr of buf2 = 0x7ffb9aaf2010
Offs of buf2 = 0x7ffb9aaf21c0
Addr of buf3 = 0x7ffb98af1010
Offs of buf3 = 0x7ffb98af1100
Addr of buf4 = 0x7ffb96af0010
Offs of buf4 = 0x7ffb96af0140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 18.360 seconds
[ perf record: Woken up 442 times to write data ]
[ perf record: Compressed 191.773 MB to 24.238 MB, ratio is 7.912 ]
[ perf record: Captured and wrote 24.290 MB perf.data ]
143.76user 0.49system 0:18.50elapsed 779%CPU (0avgtext+0avgdata 100596maxresident)k 0inputs+49760outputs (0major+35276minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record --aio=1 -z 3 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7f13f2df2010
Offs of buf1 = 0x7f13f2df2180
Addr of buf2 = 0x7f13f0df1010
Offs of buf2 = 0x7f13f0df11c0
Addr of buf3 = 0x7f13eedf0010
Offs of buf3 = 0x7f13eedf0100
Addr of buf4 = 0x7f13ecdef010
Offs of buf4 = 0x7f13ecdef140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 18.383 seconds
[ perf record: Woken up 499 times to write data ]
[ perf record: Compressed 191.078 MB to 23.246 MB, ratio is 8.220 ]
[ perf record: Captured and wrote 23.282 MB perf.data ]
143.72user 0.34system 0:18.51elapsed 778%CPU (0avgtext+0avgdata 100616maxresident)k 0inputs+47704outputs (0major+35783minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record --aio=1 -z 5 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7fca0d091010
Offs of buf1 = 0x7fca0d091180
Addr of buf2 = 0x7fca0b090010
Offs of buf2 = 0x7fca0b0901c0
Addr of buf3 = 0x7fca0908f010
Offs of buf3 = 0x7fca0908f100
Addr of buf4 = 0x7fca0708e010
Offs of buf4 = 0x7fca0708e140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 18.758 seconds
[ perf record: Woken up 535 times to write data ]
[ perf record: Compressed 190.065 MB to 24.430 MB, ratio is 7.780 ]
[ perf record: Captured and wrote 24.519 MB perf.data ]
144.62user 0.66system 0:18.88elapsed 769%CPU (0avgtext+0avgdata 100528maxresident)k 0inputs+50232outputs (0major+36942minor)pagefaults 0swaps
+ for i in 0 1 2 3 5 8
+ /usr/bin/time tools/perf/perf record --aio=1 -z 8 -F 25000 -N -B -T -R -e cycles -- ../../matrix/linux/matrix.gcc Addr of buf1 = 0x7f7e1f449010
Offs of buf1 = 0x7f7e1f449180
Addr of buf2 = 0x7f7e1d448010
Offs of buf2 = 0x7f7e1d4481c0
Addr of buf3 = 0x7f7e1b447010
Offs of buf3 = 0x7f7e1b447100
Addr of buf4 = 0x7f7e19446010
Offs of buf4 = 0x7f7e19446140
Threads #: 8 Pthreads
Matrix size: 2048
Using multiply kernel: multiply1
Execution time = 20.103 seconds
[ perf record: Woken up 260 times to write data ]
[ perf record: Compressed 193.024 MB to 31.588 MB, ratio is 6.111 ]
[ perf record: Captured and wrote 32.139 MB perf.data ]
151.73user 4.21system 0:20.23elapsed 770%CPU (0avgtext+0avgdata 100616maxresident)k 0inputs+65848outputs (0major+37431minor)pagefaults 0swaps
---
TESTING:
$ tools/perf/perf version --build-options
perf version 4.13.rc5.gd8d056b
dwarf: [ on ] # HAVE_DWARF_SUPPORT
dwarf_getlocations: [ on ] # HAVE_DWARF_GETLOCATIONS_SUPPORT
glibc: [ on ] # HAVE_GLIBC_SUPPORT
gtk2: [ on ] # HAVE_GTK2_SUPPORT
syscall_table: [ on ] # HAVE_SYSCALL_TABLE_SUPPORT
libbfd: [ on ] # HAVE_LIBBFD_SUPPORT
libelf: [ on ] # HAVE_LIBELF_SUPPORT
libnuma: [ on ] # HAVE_LIBNUMA_SUPPORT
numa_num_possible_cpus: [ on ] # HAVE_LIBNUMA_SUPPORT
libperl: [ on ] # HAVE_LIBPERL_SUPPORT
libpython: [ on ] # HAVE_LIBPYTHON_SUPPORT
libslang: [ on ] # HAVE_SLANG_SUPPORT
libcrypto: [ on ] # HAVE_LIBCRYPTO_SUPPORT
libunwind: [ on ] # HAVE_LIBUNWIND_SUPPORT
libdw-dwarf-unwind: [ on ] # HAVE_DWARF_SUPPORT
zlib: [ on ] # HAVE_ZLIB_SUPPORT
lzma: [ on ] # HAVE_LZMA_SUPPORT
get_cpuid: [ on ] # HAVE_AUXTRACE_SUPPORT
bpf: [ on ] # HAVE_LIBBPF_SUPPORT
aio: [ OFF ] # HAVE_AIO_SUPPORT
zstd: [ OFF ] # HAVE_ZSTD_SUPPORT $ tools/perf/perf version --build-options
perf version 4.13.rc5.gd8d056b
dwarf: [ on ] # HAVE_DWARF_SUPPORT
dwarf_getlocations: [ on ] # HAVE_DWARF_GETLOCATIONS_SUPPORT
glibc: [ on ] # HAVE_GLIBC_SUPPORT
gtk2: [ on ] # HAVE_GTK2_SUPPORT
syscall_table: [ on ] # HAVE_SYSCALL_TABLE_SUPPORT
libbfd: [ on ] # HAVE_LIBBFD_SUPPORT
libelf: [ on ] # HAVE_LIBELF_SUPPORT
libnuma: [ on ] # HAVE_LIBNUMA_SUPPORT
numa_num_possible_cpus: [ on ] # HAVE_LIBNUMA_SUPPORT
libperl: [ on ] # HAVE_LIBPERL_SUPPORT
libpython: [ on ] # HAVE_LIBPYTHON_SUPPORT
libslang: [ on ] # HAVE_SLANG_SUPPORT
libcrypto: [ on ] # HAVE_LIBCRYPTO_SUPPORT
libunwind: [ on ] # HAVE_LIBUNWIND_SUPPORT
libdw-dwarf-unwind: [ on ] # HAVE_DWARF_SUPPORT
zlib: [ on ] # HAVE_ZLIB_SUPPORT
lzma: [ on ] # HAVE_LZMA_SUPPORT
get_cpuid: [ on ] # HAVE_AUXTRACE_SUPPORT
bpf: [ on ] # HAVE_LIBBPF_SUPPORT
aio: [ on ] # HAVE_AIO_SUPPORT
zstd: [ on ] # HAVE_ZSTD_SUPPORT$ make -C tools/perf clean all ... $ pushd tools/perf/ && ./perf test && popd ~/abudanko/kernel/acme/tools/perf ~/abudanko/kernel/acme 1: vmlinux symtab matches kallsyms : Skip 2: Detect openat syscall event : Ok 3: Detect openat syscall event on all cpus : Ok 4: Read samples using the mmap interface : Ok 5: Test data source output : Ok 6: Parse event definition strings : Ok 7: Simple expression parser : Ok 8: PERF_RECORD_* events & perf_sample fields : Ok 9: Parse perf pmu format : Ok 10: DSO data read : Ok 11: DSO data cache : Ok 12: DSO data reopen : Ok 13: Roundtrip evsel->name : Ok 14: Parse sched tracepoints fields : Ok 15: syscalls:sys_enter_openat event fields : Ok 16: Setup struct perf_event_attr : Ok 17: Match and link multiple hists : Ok 18: 'import perf' in python : Ok 19: Breakpoint overflow signal handler : Ok 20: Breakpoint overflow sampling : Ok 21: Breakpoint accounting : Ok 22: Watchpoint : 22.1: Read Only Watchpoint : Skip 22.2: Write Only Watchpoint : Ok 22.3: Read / Write Watchpoint : Ok 22.4: Modify Watchpoint : Ok 23: Number of exit events of a simple workload : Ok 24: Software clock events period values : Ok 25: Object code reading : Ok 26: Sample parsing : Ok 27: Use a dummy software event to keep tracking : Ok 28: Parse with no sample_id_all bit set : Ok 29: Filter hist entries : Ok 30: Lookup mmap thread : Ok 31: Share thread mg : Ok 32: Sort output of hist entries : Ok 33: Cumulate child hist entries : Ok 34: Track with sched_switch : Ok 35: Filter fds with revents mask in a fdarray : Ok 36: Add fd to a fdarray, making it autogrow : Ok 37: kmod_path__parse : Ok 38: Thread map : Ok 39: LLVM search and compile : 39.1: Basic BPF llvm compile : Skip 39.2: kbuild searching : Skip 39.3: Compile source for BPF prologue generation : Skip 39.4: Compile source for BPF relocation : Skip 40: Session topology : Ok 41: BPF filter : 41.1: Basic BPF filtering : Skip 41.2: BPF pinning : Skip 41.3: BPF prologue generation : Skip 41.4: BPF relocation checker : Skip 42: Synthesize thread map : Ok 43: Remove thread map : Ok 44: Synthesize cpu map : Ok 45: Synthesize stat config : Ok 46: Synthesize stat : Ok 47: Synthesize stat round : Ok 48: Synthesize attr update : Ok 49: Event times : Ok 50: Read backward ring buffer : Ok 51: Print cpu map : Ok 52: Probe SDT events : Ok 53: is_printable_array : Ok 54: Print bitmap : Ok 55: perf hooks : Ok 56: builtin clang support : Skip (not compiled in) 57: unit_number__scnprintf : Ok 58: mem2node : Ok 59: x86 rdpmc : Ok 60: Convert perf time to TSC : Ok 61: DWARF unwind : Ok 62: x86 instruction decoder - new instructions : Ok 63: x86 bp modify : Ok 64: Check open filename arg using perf trace + vfs_getname: Skip 65: Add vfs_getname probe to get syscall args filenames : Skip 66: probe libc's inet_pton & backtrace it with ping : Ok 67: Use vfs_getname probe to get syscall args filenames : Skip 68: record trace Zstd compression/decompression : Ok ~/abudanko/kernel/acme
$ make -C tools/perf NO_LIBZSTD=1 clean all ... $ pushd tools/perf/ && ./perf test && popd ~/abudanko/kernel/acme/tools/perf ~/abudanko/kernel/acme ... 68: record trace Zstd compression/decompression : Skip ~/abudanko/kernel/acme
PATCH v9 1/12 feature: implement libzstd check, LIBZSTD_DIR and NO_LIBZSTD defines
Implement libzstd feature check, NO_LIBZSTD and LIBZSTD_DIR defines to override Zstd library sources or disable the feature from the command line:
$ make -C tools/perf LIBZSTD_DIR=/path/to/zstd/sources/ clean all $ make -C tools/perf NO_LIBZSTD=1 clean all
Auto detection feature status is reported just before compilation starts. If your system has some version of the zstd library preinstalled then the build system finds and uses it during the build.
If you still prefer to compile with some other version of zstd library you have capability to refer the compilation to that version using LIBZSTD_DIR define.
--- tools/build/Makefile.feature | 6 ++++-- tools/build/feature/Makefile | 6 +++++- tools/build/feature/test-all.c | 5 +++++ tools/build/feature/test-libzstd.c | 12 ++++++++++++ tools/perf/Makefile.config | 20 ++++++++++++++++++++ tools/perf/Makefile.perf | 3 +++ tools/perf/builtin-version.c | 2 ++ 7 files changed, 51 insertions(+), 3 deletions(-) create mode 100644 tools/build/feature/test-libzstd.c
tools/build/Makefile.feature +4 -2
@@ -66,7 +66,8 @@ FEATURE_TESTS_BASIC := \ sched_getcpu \ sdt \ setns \ - libaio + libaio \ + libzstd # FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list # of all feature tests
@@ -118,7 +119,8 @@ FEATURE_DISPLAY ?= \ lzma \ get_cpuid \ bpf \ - libaio + libaio \ + libzstd # Set FEATURE_CHECK_(C|LD)FLAGS-all for all FEATURE_TESTS features. # If in the future we need per-feature checks/flags for features not
tools/build/feature/Makefile +5 -1
@@ -62,7 +62,8 @@ FILES= \ test-clang.bin \ test-llvm.bin \ test-llvm-version.bin \ - test-libaio.bin + test-libaio.bin \ + test-libzstd.bin FILES := $(addprefix $(OUTPUT),$(FILES))
@@ -301,6 +302,9 @@ $(OUTPUT)test-clang.bin: $(OUTPUT)test-libaio.bin: $(BUILD) -lrt +$(OUTPUT)test-libzstd.bin: + $(BUILD) -lzstd + ############################### clean:
tools/build/feature/test-all.c +5 -0
@@ -178,6 +178,10 @@# include "test-reallocarray.c" #undef main +#define main main_test_zstd +# include "test-libzstd.c" +#undef main +int main (int argc,char *argv[]) {main_test_libpython ();
@@ -219,6 +223,7 @@ int main(int argc, char *argv[])main_test_setns ();main_test_libaio ();main_test_reallocarray (); +main_test_libzstd ();return 0 ; }
tools/build/feature/test-libzstd.c new file +12 -0
@@ -0,0 +1,12 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <zstd.h> + +int main (void ) +{ +ZSTD_CStream *cstream; + + cstream =ZSTD_createCStream (); +ZSTD_freeCStream (cstream); + +return 0 ; +}
tools/perf/Makefile.config +20 -0
@@ -152,6 +152,13 @@ endif FEATURE_CHECK_CFLAGS-libbabeltrace := $(LIBBABELTRACE_CFLAGS) FEATURE_CHECK_LDFLAGS-libbabeltrace := $(LIBBABELTRACE_LDFLAGS) -lbabeltrace-ctf +ifdef LIBZSTD_DIR + LIBZSTD_CFLAGS := -I$(LIBZSTD_DIR)/lib + LIBZSTD_LDFLAGS := -L$(LIBZSTD_DIR)/lib +endif +FEATURE_CHECK_CFLAGS-libzstd := $(LIBZSTD_CFLAGS) +FEATURE_CHECK_LDFLAGS-libzstd := $(LIBZSTD_LDFLAGS) + FEATURE_CHECK_CFLAGS-bpf = -I. -I$(srctree)/tools/include -I$(srctree)/tools/arch/$(SRCARCH)/include/uapi -I$(srctree)/tools/include/uapi # include ARCH specific config -include $(src-perf)/arch/$(SRCARCH)/Makefile
@@ -782,6 +789,19 @@ ifndef NO_LZMA endif endif +ifndef NO_LIBZSTD + ifeq ($(feature-libzstd), 1) + CFLAGS += -DHAVE_ZSTD_SUPPORT + CFLAGS += $(LIBZSTD_CFLAGS) + LDFLAGS += $(LIBZSTD_LDFLAGS) + EXTLIBS += -lzstd + $(call detected,CONFIG_ZSTD) + else + msg := $(warning No libzstd found, disables trace compression, please install libzstd-dev[el] and/or set LIBZSTD_DIR); + NO_LIBZSTD := 1 + endif +endif + ifndef NO_BACKTRACE ifeq ($(feature-backtrace), 1) CFLAGS += -DHAVE_BACKTRACE_SUPPORT
tools/perf/Makefile.perf +3 -0
@@ -108,6 +108,9 @@ include ../scripts/utilities.mak # streaming for record mode. Currently Posix AIO trace streaming is # supported only when linking with glibc. # +# Define NO_LIBZSTD if you do not want support of Zstandard based runtime +# trace compression in record mode. +# # As per kernel Makefile, avoid funny character set dependencies unexport LC_ALL
tools/perf/builtin-version.c +2 -0
@@ -78,6 +78,8 @@ static void library_status(void)STATUS (HAVE_LZMA_SUPPORT , lzma);STATUS (HAVE_AUXTRACE_SUPPORT , get_cpuid);STATUS (HAVE_LIBBPF_SUPPORT , bpf); +STATUS (HAVE_AIO_SUPPORT , aio); +STATUS (HAVE_ZSTD_SUPPORT , zstd); }int cmd_version (int argc,const char **argv)
Signature · 1 line
2.20.1
PATCH v9 2/12 perf record: implement --mmap-flush=<number> option
In reply to Alexey BudankovImplemented --mmap-flush option that specifies minimal number of bytes that is extracted from mmaped kernel buffer to store into a trace. The default option value is 1 byte what means every time trace writing thread finds some new data in the mmaped buffer the data is extracted, possibly compressed and written to a trace.
$ tools/perf/perf record --mmap-flush 1024 -e cycles -- matrix.gcc $ tools/perf/perf record --aio --mmap-flush 1K -e cycles -- matrix.gcc
The option is independent from -z setting, doesn't vary with compression level and can serve two purposes.
The first purpose is to increase the compression ratio of a trace data. Larger data chunks are compressed more effectively so the implemented option allows specifying data chunk size to compress. Also at some cases executing more write syscalls with smaller data size can take longer than executing less write syscalls with bigger data size due to syscall overhead so extracting bigger data chunks specified by the option value could additionally decrease runtime overhead.
The second purpose is to avoid self monitoring live-lock issue in system wide (-a) profiling mode. Profiling in system wide mode with compression (-a -z) can additionally induce data into the kernel buffers along with the data from monitored processes. If performance data rate and volume from the monitored processes is high then trace streaming and compression activity in the tool is also high. High tool process activity can lead to subtle live-lock effect when compression of single new byte from some of mmaped kernel buffer leads to generation of the next single byte at some mmaped buffer. So perf tool process ends up in endless self monitoring.
Implemented sync parameter is the mean to force data move independently from the specified flush threshold value. Despite the provided flush value the tool needs capability to unconditionally drain memory buffers, at least in the end of the collection.
--- tools/perf/Documentation/perf-record.txt | 12 +++++ tools/perf/builtin-record.c | 65 +++++++++++++++++++++--- tools/perf/perf.h | 1 + tools/perf/util/evlist.c | 6 +-- tools/perf/util/evlist.h | 3 +- tools/perf/util/mmap.c | 4 +- tools/perf/util/mmap.h | 3 +- 7 files changed, 82 insertions(+), 12 deletions(-)
tools/perf/Documentation/perf-record.txt +12 -0
@@ -459,6 +459,18 @@ Set affinity mask of trace reading thread according to the policy defined by 'mo node - thread affinity mask is set to NUMA node cpu mask of the processed mmap buffer cpu - thread affinity mask is set to cpu of the processed mmap buffer +--mmap-flush=number:: +Specify minimal number of bytes that is extracted from mmap data pages and stored +into a trace. The number specification is possible using B/K/M/G suffixes. Maximal allowed +value is a quarter of the size of mmaped data pages. The default option value is 1 byte +what means that every time trace writing thread finds some new data in the mmaped buffer +the data is extracted, possibly compressed (-z) and written to a trace. Larger data chunks +are compressed more effectively in comparison to smaller chunks so extraction of larger +chunks from the mmap data pages is preferable from perspective of trace size reduction. +Also at some cases executing less trace write syscalls with bigger data size can take +shorter than executing more trace write syscalls with smaller data size thus lowering +runtime profiling overhead. + --all-kernel:: Configure all used events to run in kernel space.
tools/perf/builtin-record.c +59 -6
147 lines not on this page · raw message
tools/perf/perf.h +1 -0
@@ -85,6 +85,7 @@ struct record_opts {u64 clockid_res_ns;int nr_cblocks;int affinity; +int mmap_flush; };enum perf_affinity {
tools/perf/util/evlist.c +3 -3
@@ -1037,7 +1037,7 @@ int perf_evlist__parse_mmap_pages(const struct option *opt, const char *str,*/ int perf_evlist__mmap_ex (struct perf_evlist *evlist,unsigned int pages,unsigned int auxtrace_pages, -bool auxtrace_overwrite,int nr_cblocks,int affinity) +bool auxtrace_overwrite,int nr_cblocks,int affinity,int flush) {struct perf_evsel *evsel;const struct cpu_map *cpus = evlist->cpus;
@@ -1047,7 +1047,7 @@ int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,* Its value is decided by evsel's write_backward. * So &mp should not be passed through const pointer. */ -struct mmap_params mp = { .nr_cblocks = nr_cblocks, .affinity = affinity }; +struct mmap_params mp = { .nr_cblocks = nr_cblocks, .affinity = affinity, .flush = flush };if (!evlist->mmap) evlist->mmap =perf_evlist__alloc_mmap (evlist, false);
@@ -1079,7 +1079,7 @@ int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,int perf_evlist__mmap (struct perf_evlist *evlist,unsigned int pages) { -return perf_evlist__mmap_ex (evlist, pages,0 , false,0 ,PERF_AFFINITY_SYS ); +return perf_evlist__mmap_ex (evlist, pages,0 , false,0 ,PERF_AFFINITY_SYS ,1 ); }int perf_evlist__create_maps (struct perf_evlist *evlist,struct target *target)
tools/perf/util/evlist.h +2 -1
@@ -165,7 +165,8 @@ unsigned long perf_event_mlock_kb_in_pages(void);int perf_evlist__mmap_ex (struct perf_evlist *evlist,unsigned int pages,unsigned int auxtrace_pages, -bool auxtrace_overwrite,int nr_cblocks,int affinity); +bool auxtrace_overwrite,int nr_cblocks, +int affinity,int flush);int perf_evlist__mmap (struct perf_evlist *evlist,unsigned int pages);void perf_evlist__munmap (struct perf_evlist *evlist);
tools/perf/util/mmap.c +3 -1
@@ -440,6 +440,8 @@ int perf_mmap__mmap(struct perf_mmap *map, struct mmap_params *mp, int fd, int cperf_mmap__setup_affinity_mask (map, mp); + map->flush = mp->flush; +if (auxtrace_mmap__mmap (&map->auxtrace_mmap, &mp->auxtrace_mp, map->base, fd))return -1 ;
@@ -492,7 +494,7 @@ static int __perf_mmap__read_init(struct perf_mmap *md) md->start = md->overwrite ? head : old; md->end = md->overwrite ? old : head; -if (md->start == md->end) +if ((md->end - md->start) < md->flush)return -EAGAIN ; size = md->end - md->start;
tools/perf/util/mmap.h +2 -1
@@ -39,6 +39,7 @@ struct perf_mmap { } aio;#endif cpu_set_t affinity_mask; +u64 flush; };/*
@@ -70,7 +71,7 @@ enum bkw_mmap_state { };struct mmap_params { -int prot, mask, nr_cblocks, affinity; +int prot, mask, nr_cblocks, affinity, flush;struct auxtrace_mmap_params auxtrace_mp; };
Signature · 1 line
2.20.1
PATCH v9 3/12 perf session: define bytes_transferred and bytes_compressed metrics
In reply to Alexey BudankovDefine bytes_transferred and bytes_compressed metrics to calculate ratio in the end of the data collection:
compression ratio = bytes_transferred / bytes_compressed
bytes_transferred accumulates the amount of bytes that was extracted from the mmaped kernel buffers for compression. bytes_compressed accumulates the amount of bytes that was received after applying compression.
--- tools/perf/builtin-record.c | 14 +++++++++++++- tools/perf/util/env.h | 1 + tools/perf/util/session.h | 2 ++ 3 files changed, 16 insertions(+), 1 deletion(-)
tools/perf/builtin-record.c +13 -1
@@ -1166,6 +1166,7 @@ static int __cmd_record(struct record *rec, int argc, const char **argv)struct perf_session *session;bool disabled = false, draining = false;int fd; +float ratio =0 ;atexit (record__sig_exit);signal (SIGCHLD , sig_handler);
@@ -1463,6 +1464,11 @@ static int __cmd_record(struct record *rec, int argc, const char **argv)record__mmap_read_all (rec, true);record__aio_mmap_read_sync (rec); +if (rec->session->bytes_transferred && rec->session->bytes_compressed) { + ratio = (float )rec->session->bytes_transferred/(float )rec->session->bytes_compressed; + session->header.env.comp_ratio = ratio +0.5 ; + } +if (forks) {int exit_status;
@@ -1509,9 +1515,15 @@ static int __cmd_record(struct record *rec, int argc, const char **argv)else samples[0 ] ='\0' ; -fprintf (stderr,"[ perf record: Captured and wrote %.3f MB %s%s%s ]\n" , +fprintf (stderr,"[ perf record: Captured and wrote %.3f MB %s%s%s" ,perf_data__size (data) /1024.0 /1024.0 , data->path, postfix, samples); +if (ratio) { +fprintf (stderr,", compressed (original %.3f MB, ratio is %.3f)" , + rec->session->bytes_transferred /1024.0 /1024.0 , + ratio); + } +fprintf (stderr," ]\n" ); } out_delete_session:
tools/perf/util/env.h +1 -0
@@ -64,6 +64,7 @@ struct perf_env {struct memory_node *memory_nodes;unsigned long long memory_bsize;u64 clockid_res_ns; +u32 comp_ratio; };extern struct perf_env perf_env;
tools/perf/util/session.h +2 -0
@@ -35,6 +35,8 @@ struct perf_session {struct ordered_events ordered_events;struct perf_data *data;struct perf_tool *tool; +u64 bytes_transferred; +u64 bytes_compressed; };struct perf_tool ;
Signature · 1 line
2.20.1
PATCH v9 4/12 perf record: implement COMPRESSED event record and its attributes
In reply to Alexey BudankovImplemented PERF_RECORD_COMPRESSED event, related data types, header feature and functions to write, read and print feature attributes from the trace header section.
comp_mmap_len preserves the size of mmaped kernel buffer that was used during collection. comp_mmap_len size is used on loading stage as the size of decomp buffer for decompression of COMPRESSED events content.
--- .../Documentation/perf.data-file-format.txt | 24 ++++++++ tools/perf/builtin-record.c | 8 +++ tools/perf/perf.h | 1 + tools/perf/util/env.h | 10 ++++ tools/perf/util/event.c | 1 + tools/perf/util/event.h | 7 +++ tools/perf/util/header.c | 55 ++++++++++++++++++- tools/perf/util/header.h | 1 + 8 files changed, 106 insertions(+), 1 deletion(-)
tools/perf/Documentation/perf.data-file-format.txt +24 -0
@@ -272,6 +272,19 @@ struct { Two uint64_t for the time of first sample and the time of last sample. + HEADER_COMPRESSED = 24, + +struct { + u32 version; + u32 type; + u32 level; + u32 ratio; + u32 mmap_len; +}; + +Indicates that trace contains records of PERF_RECORD_COMPRESSED type +that have perf_events records in compressed form. + other bits are reserved and should ignored for now HEADER_FEAT_BITS = 256,
@@ -437,6 +450,17 @@ struct auxtrace_error_event { Describes a header feature. These are records used in pipe-mode that contain information that otherwise would be in perf.data file's header. + PERF_RECORD_COMPRESSED = 81, + +struct compressed_event { + struct perf_event_header header; + char data[]; +}; + +The header is followed by compressed data frame that can be decompressed +into array of perf trace records. The size of the entire compressed event +record including the header is limited by the max value of header.size. + Event types Define the event attributes with their IDs.
tools/perf/builtin-record.c +8 -0
@@ -369,6 +369,11 @@ static int record__mmap_flush_parse(const struct option *opt,return 0 ; } +static int record__comp_enabled (struct record *rec) +{ +return rec->opts.comp_level >0 ; +} + static int process_synthesized_event(struct perf_tool *tool, union perf_event *event, struct perf_sample *sample __maybe_unused,
@@ -885,6 +890,8 @@ static void record__init_features(struct record *rec)perf_header__clear_feat (&session->header,HEADER_CLOCKID );perf_header__clear_feat (&session->header,HEADER_DIR_FORMAT ); +if (!record__comp_enabled (rec)) +perf_header__clear_feat (&session->header,HEADER_COMPRESSED );perf_header__clear_feat (&session->header,HEADER_STAT ); }
@@ -1225,6 +1232,7 @@ static int __cmd_record(struct record *rec, int argc, const char **argv) err =-1 ; goto out_child; } + session->header.env.comp_mmap_len = session->evlist->mmap_len; err =bpf__apply_obj_config ();if (err) {
tools/perf/perf.h +1 -0
@@ -86,6 +86,7 @@ struct record_opts {int nr_cblocks;int affinity;int mmap_flush; +unsigned int comp_level; };enum perf_affinity {
tools/perf/util/env.h +10 -0
@@ -65,6 +65,16 @@ struct perf_env {unsigned long long memory_bsize;u64 clockid_res_ns;u32 comp_ratio; +u32 comp_ver; +u32 comp_type; +u32 comp_level; +u32 comp_mmap_len; +}; + +enum perf_compress_type { +PERF_COMP_NONE =0 , +PERF_COMP_ZSTD , +PERF_COMP_MAX };extern struct perf_env perf_env;
tools/perf/util/event.c +1 -0
@@ -68,6 +68,7 @@ static const char *perf_event__names[] = { [PERF_RECORD_EVENT_UPDATE] = "EVENT_UPDATE", [PERF_RECORD_TIME_CONV] = "TIME_CONV", [PERF_RECORD_HEADER_FEATURE] = "FEATURE", + [PERF_RECORD_COMPRESSED] = "COMPRESSED", };static const char *perf_ns__names[] = {
tools/perf/util/event.h +7 -0
@@ -254,6 +254,7 @@ enum perf_user_event_type { /* above any possible kernel type */PERF_RECORD_EVENT_UPDATE =78 ,PERF_RECORD_TIME_CONV =79 ,PERF_RECORD_HEADER_FEATURE =80 , +PERF_RECORD_COMPRESSED =81 , PERF_RECORD_HEADER_MAX };
@@ -626,6 +627,11 @@ struct feature_event {char data[]; }; +struct compressed_event { +struct perf_event_header header; +char data[]; +}; +union perf_event {struct perf_event_header header;struct mmap_event mmap;
@@ -659,6 +665,7 @@ union perf_event {struct feature_event feat;struct ksymbol_event ksymbol_event;struct bpf_event bpf_event; +struct compressed_event pack; };void perf_event__print_totals (void );
tools/perf/util/header.c +54 -1
79 lines not on this page · raw message
tools/perf/util/header.h +1 -0
@@ -40,6 +40,7 @@ enum {HEADER_MEM_TOPOLOGY ,HEADER_CLOCKID ,HEADER_DIR_FORMAT , +HEADER_COMPRESSED ,HEADER_LAST_FEATURE , HEADER_FEAT_BITS = 256, };
Signature · 1 line
2.20.1
PATCH v9 5/12 perf mmap: implement dedicated memory buffer for data compression
In reply to Alexey BudankovImplemented mmap data buffer that is used as the memory to operate on when compressing data in case of serial trace streaming.
--- tools/perf/builtin-record.c | 8 +++++++- tools/perf/util/evlist.c | 8 +++++--- tools/perf/util/evlist.h | 2 +- tools/perf/util/mmap.c | 30 ++++++++++++++++++++++++++++-- tools/perf/util/mmap.h | 4 +++- 5 files changed, 44 insertions(+), 8 deletions(-)
tools/perf/builtin-record.c +7 -1
@@ -369,6 +369,8 @@ static int record__mmap_flush_parse(const struct option *opt,return 0 ; } +static unsigned int comp_level_max =22 ; +static int record__comp_enabled (struct record *rec) {return rec->opts.comp_level >0 ;
@@ -584,7 +586,7 @@ static int record__mmap_evlist(struct record *rec, opts->auxtrace_mmap_pages, opts->auxtrace_snapshot_mode, opts->nr_cblocks, opts->affinity, - opts->mmap_flush) < 0) { + opts->mmap_flush, opts->comp_level) < 0) {if (errno ==EPERM ) {pr_err ("Permission error mapping pages.\n" "Consider increasing "
@@ -2258,6 +2260,10 @@ int cmd_record(int argc, const char **argv)pr_debug ("affinity: %s\n" , affinity_tags[rec->opts.affinity]);pr_debug ("mmap flush: %d\n" , rec->opts.mmap_flush); +if (rec->opts.comp_level > comp_level_max) + rec->opts.comp_level = comp_level_max; +pr_debug ("comp level: %d\n" , rec->opts.comp_level); + err =__cmd_record (&record, argc, argv); out:perf_evlist__delete (rec->evlist);
tools/perf/util/evlist.c +5 -3
@@ -1037,7 +1037,8 @@ int perf_evlist__parse_mmap_pages(const struct option *opt, const char *str,*/ int perf_evlist__mmap_ex (struct perf_evlist *evlist,unsigned int pages,unsigned int auxtrace_pages, -bool auxtrace_overwrite,int nr_cblocks,int affinity,int flush) +bool auxtrace_overwrite,int nr_cblocks,int affinity,int flush, +int comp_level) {struct perf_evsel *evsel;const struct cpu_map *cpus = evlist->cpus;
@@ -1047,7 +1048,8 @@ int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,* Its value is decided by evsel's write_backward. * So &mp should not be passed through const pointer. */ -struct mmap_params mp = { .nr_cblocks = nr_cblocks, .affinity = affinity, .flush = flush }; +struct mmap_params mp = { .nr_cblocks = nr_cblocks, .affinity = affinity, .flush = flush, + .comp_level = comp_level };if (!evlist->mmap) evlist->mmap =perf_evlist__alloc_mmap (evlist, false);
@@ -1079,7 +1081,7 @@ int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,int perf_evlist__mmap (struct perf_evlist *evlist,unsigned int pages) { -return perf_evlist__mmap_ex (evlist, pages,0 , false,0 ,PERF_AFFINITY_SYS ,1 ); +return perf_evlist__mmap_ex (evlist, pages,0 , false,0 ,PERF_AFFINITY_SYS ,1 ,0 ); }int perf_evlist__create_maps (struct perf_evlist *evlist,struct target *target)
tools/perf/util/evlist.h +1 -1
@@ -166,7 +166,7 @@ unsigned long perf_event_mlock_kb_in_pages(void);int perf_evlist__mmap_ex (struct perf_evlist *evlist,unsigned int pages,unsigned int auxtrace_pages,bool auxtrace_overwrite,int nr_cblocks, -int affinity,int flush); +int affinity,int flush,int comp_level);int perf_evlist__mmap (struct perf_evlist *evlist,unsigned int pages);void perf_evlist__munmap (struct perf_evlist *evlist);
tools/perf/util/mmap.c +28 -2
@@ -157,6 +157,10 @@ void __weak auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp __mayb }#ifdef HAVE_AIO_SUPPORT +static int perf_mmap__aio_enabled (struct perf_mmap *map) +{ +return map->aio.nr_cblocks >0 ; +}#ifdef HAVE_LIBNUMA_SUPPORT static int perf_mmap__aio_alloc (struct perf_mmap *map,int idx)
@@ -198,7 +202,7 @@ static int perf_mmap__aio_bind(struct perf_mmap *map, int idx, int cpu, int affi return 0; } -#else +#else /* !HAVE_LIBNUMA_SUPPORT */ static int perf_mmap__aio_alloc (struct perf_mmap *map,int idx) { map->aio.data[idx] =malloc (perf_mmap__mmap_len (map));
@@ -359,7 +363,12 @@ int perf_mmap__aio_push(struct perf_mmap *md, void *to, int idx, return rc; } -#else +#else /* !HAVE_AIO_SUPPORT */ +static int perf_mmap__aio_enabled (struct perf_mmap *map__maybe_unused ) +{ +return 0 ; +} +static int perf_mmap__aio_mmap (struct perf_mmap *map__maybe_unused ,struct mmap_params *mp__maybe_unused ) {
@@ -374,6 +383,10 @@ static void perf_mmap__aio_munmap(struct perf_mmap *map __maybe_unused)void perf_mmap__munmap (struct perf_mmap *map) {perf_mmap__aio_munmap (map); +if (map->data !=NULL ) { +munmap (map->data,perf_mmap__mmap_len (map)); + map->data =NULL ; + }if (map->base !=NULL ) {munmap (map->base,perf_mmap__mmap_len (map)); map->base =NULL ;
@@ -442,6 +455,19 @@ int perf_mmap__mmap(struct perf_mmap *map, struct mmap_params *mp, int fd, int c map->flush = mp->flush; + map->comp_level = mp->comp_level; + +if (map->comp_level && !perf_mmap__aio_enabled (map)) { + map->data =mmap (NULL ,perf_mmap__mmap_len (map),PROT_READ |PROT_WRITE , +MAP_PRIVATE |MAP_ANONYMOUS ,0 ,0 ); +if (map->data ==MAP_FAILED ) { +pr_debug2 ("failed to mmap data buffer, error %d\n" , + errno); + map->data =NULL ; +return -1 ; + } + } +if (auxtrace_mmap__mmap (&map->auxtrace_mmap, &mp->auxtrace_mp, map->base, fd))return -1 ;
tools/perf/util/mmap.h +3 -1
@@ -40,6 +40,8 @@ struct perf_mmap {#endif cpu_set_t affinity_mask;u64 flush; +void *data; +int comp_level; };/*
@@ -71,7 +73,7 @@ enum bkw_mmap_state { };struct mmap_params { -int prot, mask, nr_cblocks, affinity, flush; +int prot, mask, nr_cblocks, affinity, flush, comp_level;struct auxtrace_mmap_params auxtrace_mp; };
Signature · 1 line
2.20.1
PATCH v9 6/12 perf util: introduce Zstd streaming based compression API
In reply to Alexey BudankovImplemented functions are based on Zstd streaming compression API. The functions are used in runtime to compress data that come from mmaped kernel buffer. zstd_init(), zstd_fini() are used for initialization and finalization to allocate and deallocate internal zstd objects. zstd_compress_stream_to_records() is used to convert parts of mmaped kernel buffer into an array of PERF_RECORD_COMPRESSED records.
--- tools/perf/util/Build | 2 ++ tools/perf/util/compress.h | 43 +++++++++++++++++++++++ tools/perf/util/zstd.c | 71 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 116 insertions(+) create mode 100644 tools/perf/util/zstd.c
tools/perf/util/Build +2 -0
@@ -145,6 +145,8 @@ perf-y += scripting-engines/ perf-$(CONFIG_ZLIB) += zlib.o perf-$(CONFIG_LZMA) += lzma.o +perf-$(CONFIG_ZSTD) += zstd.o + perf-y += demangle-java.o perf-y += demangle-rust.o
tools/perf/util/compress.h +43 -0
53 lines not on this page · raw message
tools/perf/util/zstd.c new file +71 -0
71 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v9 7/12 perf record: implement compression for serial trace streaming
In reply to Alexey BudankovCompression is implemented using the functions from zstd.c. As the memory to operate on the compression uses mmap->data buffer. If Zstd streaming compression API fails for some reason the data to be compressed are just copied into the memory buffers using plain memcpy().
Compressed trace frame consists of an array of PERF_RECORD_COMPRESSED records. Each element of the array is not longer that PERF_SAMPLE_MAX_SIZE and consists of perf_event_header followed by the compressed chunk that is decompressed on the loading stage.
--- tools/perf/builtin-record.c | 53 +++++++++++++++++++++++++++++++++++-- tools/perf/util/session.h | 2 ++ 2 files changed, 53 insertions(+), 2 deletions(-)
tools/perf/builtin-record.c +51 -2
@@ -130,6 +130,9 @@ static int record__write(struct record *rec, struct perf_mmap *map __maybe_unusereturn 0 ; } +static size_t zstd_compress (struct perf_session *session,void *dst,size_t dst_size, +void *src,size_t src_size); +#ifdef HAVE_AIO_SUPPORT static int record__aio_write (struct aiocb *cblock,int trace_fd,void *buf,size_t size,off_t off)
@@ -389,6 +392,12 @@ static int record__pushfn(struct perf_mmap *map, void *to, void *bf, size_t size {struct record *rec = to; +if (record__comp_enabled (rec)) { + size =zstd_compress (rec->session, map->data, +perf_mmap__mmap_len (map), bf, size); + bf = map->data; + } + rec->samples++;return record__write (rec, map, bf, size); }
@@ -775,6 +784,38 @@ static void record__adjust_affinity(struct record *rec, struct perf_mmap *map) } } +static size_t process_comp_header (void *record,size_t increment) +{ +struct compressed_event *event = record; +size_t size =sizeof (struct compressed_event ); + +if (increment) { + event->header.size += increment; +return increment; + } + + event->header.type =PERF_RECORD_COMPRESSED ; + event->header.size = size; + +return size; +} + +static size_t zstd_compress (struct perf_session *session,void *dst,size_t dst_size, +void *src,size_t src_size) +{ +size_t compressed; +size_t max_record_size =PERF_SAMPLE_MAX_SIZE -sizeof (struct compressed_event ) -1 ; + + compressed =zstd_compress_stream_to_records (&(session->zstd_data), + dst, dst_size, src, src_size, max_record_size, + process_comp_header); + + session->bytes_transferred += src_size; + session->bytes_compressed += compressed; + +return compressed; +} +static int record__mmap_read_evlist (struct record *rec,struct perf_evlist *evlist,bool overwrite,bool sync) {
@@ -1205,6 +1246,14 @@ static int __cmd_record(struct record *rec, int argc, const char **argv) fd =perf_data__fd (data); rec->session = session; +if (zstd_init (&(session->zstd_data), rec->opts.comp_level) <0 ) { +pr_err ("Compression initialization failed.\n" ); +return -1 ; + } + + session->header.env.comp_type =PERF_COMP_ZSTD ; + session->header.env.comp_level = rec->opts.comp_level; +record__init_features (rec);if (rec->opts.use_clockid && rec->opts.clockid_res_ns)
@@ -1537,6 +1586,7 @@ static int __cmd_record(struct record *rec, int argc, const char **argv) } out_delete_session: +zstd_fini (&(session->zstd_data));perf_session__delete (session);return status; }
@@ -2254,8 +2304,7 @@ int cmd_record(int argc, const char **argv)if (rec->opts.nr_cblocks > nr_cblocks_max) rec->opts.nr_cblocks = nr_cblocks_max; -if (verbose >0 ) -pr_info ("nr_cblocks: %d\n" , rec->opts.nr_cblocks); +pr_debug ("nr_cblocks: %d\n" , rec->opts.nr_cblocks);pr_debug ("affinity: %s\n" , affinity_tags[rec->opts.affinity]);pr_debug ("mmap flush: %d\n" , rec->opts.mmap_flush);
tools/perf/util/session.h +2 -0
@@ -8,6 +8,7 @@#include "machine.h" #include "data.h" #include "ordered-events.h" +#include "util/compress.h" #include <linux/kernel.h> #include <linux/rbtree.h> #include <linux/perf_event.h>
@@ -37,6 +38,7 @@ struct perf_session {struct perf_tool *tool;u64 bytes_transferred;u64 bytes_compressed; +struct zstd_data zstd_data; };struct perf_tool ;
Signature · 1 line
2.20.1
PATCH v9 8/12 perf record: implement compression for AIO trace streaming
In reply to Alexey BudankovCompression is implemented using the functions from zstd.c. As the memory to operate on the compression uses mmap->aio.data[] buffers. If Zstd streaming compression API fails for some reason the data to be compressed are just copied into the memory buffers using plain memcpy().
Compressed trace frame consists of an array of PERF_RECORD_COMPRESSED records. Each element of the array is not longer that PERF_SAMPLE_MAX_SIZE and consists of perf_event_header followed by the compressed chunk that is decompressed on the loading stage.
perf_mmap__aio_push() is replaced by perf_mmap__push() which is now used in the both serial and AIO streaming cases. perf_mmap__push() is extended with positive return values to signify absence of data ready for processing.
--- tools/perf/builtin-record.c | 114 ++++++++++++++++++++++++++++-------- tools/perf/util/mmap.c | 76 +----------------------- tools/perf/util/mmap.h | 12 ---- 3 files changed, 89 insertions(+), 113 deletions(-)
tools/perf/builtin-record.c +88 -26
@@ -130,6 +130,8 @@ static int record__write(struct record *rec, struct perf_mmap *map __maybe_unusereturn 0 ; } +static int record__aio_enabled (struct record *rec); +static int record__comp_enabled (struct record *rec);static size_t zstd_compress (struct perf_session *session,void *dst,size_t dst_size,void *src,size_t src_size);
@@ -183,9 +185,9 @@ static int record__aio_complete(struct perf_mmap *md, struct aiocb *cblock)if (rem_size ==0 ) { cblock->aio_fildes =-1 ;/* -* md->refcount is incremented in perf_mmap__push() for -* every enqueued aio write request so decrement it because -* the request is now complete. +* md->refcount is incremented in record__aio_pushfn() for +* every aio write request started in record__aio_push() so +* decrement it because the request is now complete. */ perf_mmap__put (md); rc =1 ;
@@ -240,18 +242,89 @@ static int record__aio_sync(struct perf_mmap *md, bool sync_all) }while (1 ); } -static int record__aio_pushfn (void *to,struct aiocb *cblock,void *bf,size_t size,off_t off) +struct record_aio { +struct record *rec; +void *data; +size_t size; +}; + +static int record__aio_pushfn (struct perf_mmap *map,void *to,void *buf,size_t size) { -struct record *rec = to; -int ret, trace_fd = rec->session->data->file.fd; +struct record_aio *aio = to; - rec->samples++; +/* +* map->base data pointed by buf is copied into free map->aio.data[] buffer +* to release space in the kernel buffer as fast as possible, calling +* perf_mmap__consume() from perf_mmap__push() function. +* +* That lets the kernel to proceed with storing more profiling data into +* the kernel buffer earlier than other per-cpu kernel buffers are handled. +* +* Coping can be done in two steps in case the chunk of profiling data +* crosses the upper bound of the kernel buffer. In this case we first move +* part of data from map->start till the upper bound and then the reminder +* from the beginning of the kernel buffer till the end of the data chunk. +*/ - ret =record__aio_write (cblock, trace_fd, bf, size, off); +if (record__comp_enabled (aio->rec)) { + size =zstd_compress (aio->rec->session, aio->data + aio->size, +perf_mmap__mmap_len (map) - aio->size, + buf, size); + }else { +memcpy (aio->data + aio->size, buf, size); + } + +if (!aio->size) { +/* +* Increment map->refcount to guard map->aio.data[] buffer +* from premature deallocation because map object can be +* released earlier than aio write request started on +* map->aio.data[] buffer is complete. +* +* perf_mmap__put() is done at record__aio_complete() +* after started aio request completion or at record__aio_push() +* if the request failed to start. +*/ +perf_mmap__get (map); + } + + aio->size += size; + +return size; +} + +static int record__aio_push (struct record *rec,struct perf_mmap *map,off_t *off) +{ +int ret, idx; +int trace_fd = rec->session->data->file.fd; +struct record_aio aio = { .rec = rec, .size =0 }; + +/* +* Call record__aio_sync() to wait till map->aio.data[] buffer +* becomes available after previous aio write operation. +*/ + + idx =record__aio_sync (map, false); + aio.data = map->aio.data[idx]; + ret =perf_mmap__push (map, &aio, record__aio_pushfn); +if (ret !=0 )/* ret > 0 - no data, ret < 0 - error */ +return ret; + + rec->samples++; + ret =record__aio_write (&(map->aio.cblocks[idx]), trace_fd, aio.data, aio.size, *off);if (!ret) { - rec->bytes_written += size; + *off += aio.size; + rec->bytes_written += aio.size;if (switch_output_size (rec))trigger_hit (&switch_output_trigger); + }else { +/* +* Decrement map->refcount incremented in record__aio_pushfn() +* back if record__aio_write() operation failed to start, otherwise +* map->refcount is decremented in record__aio_complete() after +* aio write operation finishes successfully. +*/ +perf_mmap__put (map); }return ret;
@@ -273,7 +346,7 @@ static void record__aio_mmap_read_sync(struct record *rec)struct perf_evlist *evlist = rec->evlist;struct perf_mmap *maps = evlist->mmap; -if (!rec->opts.nr_cblocks) +if (!record__aio_enabled (rec))return ;for (i =0 ; i < evlist->nr_mmaps; i++) {
@@ -307,13 +380,8 @@ static int record__aio_parse(const struct option *opt,#else /* HAVE_AIO_SUPPORT */ static int nr_cblocks_max =0 ; -static int record__aio_sync (struct perf_mmap *md__maybe_unused ,bool sync_all__maybe_unused ) -{ -return -1 ; -} - -static int record__aio_pushfn (void *to__maybe_unused ,struct aiocb *cblock__maybe_unused , -void *bf__maybe_unused ,size_t size__maybe_unused ,off_t off__maybe_unused ) +static int record__aio_push (struct record *rec__maybe_unused ,struct perf_mmap *map__maybe_unused , +off_t *off__maybe_unused ) {return -1 ; }
@@ -824,7 +892,7 @@ static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evliint rc =0 ;struct perf_mmap *maps;int trace_fd = rec->data.file.fd; -off_t off; +off_t off =0 ;if (!evlist)return 0 ;
@@ -850,20 +918,14 @@ static int record__mmap_read_evlist(struct record *rec, struct perf_evlist *evli map->flush =1 ; }if (!record__aio_enabled (rec)) { -if (perf_mmap__push (map, rec, record__pushfn) !=0 ) { +if (perf_mmap__push (map, rec, record__pushfn) <0 ) {if (sync) map->flush = flush; rc =-1 ; goto out; } }else { -int idx; -/* -* Call record__aio_sync() to wait till map->data buffer -* becomes available after previous aio write request. -*/ - idx =record__aio_sync (map, false); -if (perf_mmap__aio_push (map, rec, idx, record__aio_pushfn, &off) !=0 ) { +if (record__aio_push (rec, map, &off) <0 ) {record__aio_set_pos (trace_fd, off);if (sync) map->flush = flush;
tools/perf/util/mmap.c +1 -75
88 lines not on this page · raw message
tools/perf/util/mmap.h +0 -12
@@ -101,18 +101,6 @@ union perf_event *perf_mmap__read_event(struct perf_mmap *map);int perf_mmap__push (struct perf_mmap *md,void *to,int push (struct perf_mmap *map,void *to,void *buf,size_t size)); -#ifdef HAVE_AIO_SUPPORT -int perf_mmap__aio_push (struct perf_mmap *md,void *to,int idx, -int push (void *to,struct aiocb *cblock,void *buf,size_t size,off_t off), -off_t *off); -#else -static inline int perf_mmap__aio_push (struct perf_mmap *md__maybe_unused ,void *to__maybe_unused ,int idx__maybe_unused , -int push (void *to,struct aiocb *cblock,void *buf,size_t size,off_t off)__maybe_unused , -off_t *off__maybe_unused ) -{ -return 0 ; -} -#endif size_t perf_mmap__mmap_len (struct perf_mmap *map);
Signature · 1 line
2.20.1
PATCH v9 9/12 perf record: implement -z,--compression_level[=<n>] option
In reply to Alexey BudankovImplemented -z,--compression_level[=<n>] option that enables compression of mmaped kernel data buffers content in runtime during perf record mode collection. Default option value is 1 (fastest compression).
Compression overhead has been measured for serial and AIO streaming when profiling matrix multiplication workload:
-------------------------------------------------------------
| SERIAL | AIO-1 |
----------------------------------------------------------------| |-z | OVH(x) | ratio(x) size(MiB) | OVH(x) | ratio(x) size(MiB) | |---------------------------------------------------------------| | 0 | 1,00 | 1,000 179,424 | 1,00 | 1,000 187,527 | | 1 | 1,04 | 8,427 181,148 | 1,01 | 8,474 188,562 | | 2 | 1,07 | 8,055 186,953 | 1,03 | 7,912 191,773 | | 3 | 1,04 | 8,283 181,908 | 1,03 | 8,220 191,078 | | 5 | 1,09 | 8,101 187,705 | 1,05 | 7,780 190,065 | | 8 | 1,05 | 9,217 179,191 | 1,12 | 6,111 193,024 |
-----------------------------------------------------------------
OVH = (Execution time with -z N) / (Execution time with -z 0)
ratio - compression ratio
size - number of bytes that was compressed
size ~= trace size x ratio
--- tools/perf/Documentation/perf-record.txt | 5 +++++ tools/perf/builtin-record.c | 25 ++++++++++++++++++++++++ 2 files changed, 30 insertions(+)
tools/perf/Documentation/perf-record.txt +5 -0
@@ -471,6 +471,11 @@ Also at some cases executing less trace write syscalls with bigger data size can shorter than executing more trace write syscalls with smaller data size thus lowering runtime profiling overhead. +-z:: +--compression-level[=n]:: +Produce compressed trace using specified level n (default: 1 - fastest compression, +22 - smallest trace) + --all-kernel:: Configure all used events to run in kernel space.
tools/perf/builtin-record.c +25 -0
@@ -440,6 +440,26 @@ static int record__mmap_flush_parse(const struct option *opt,return 0 ; } +#ifdef HAVE_ZSTD_SUPPORT +static unsigned int comp_level_default =1 ; +static int record__parse_comp_level (const struct option *opt, +const char *str, +int unset) +{ +struct record_opts *opts = (struct record_opts *)opt->value; + +if (unset) { + opts->comp_level =0 ; + }else { +if (str) + opts->comp_level =strtol (str,NULL ,0 ); +if (!opts->comp_level) + opts->comp_level = comp_level_default; + } + +return 0 ; +} +#endif static unsigned int comp_level_max =22 ;static int record__comp_enabled (struct record *rec)
@@ -2169,6 +2189,11 @@ static struct option __record_options[] = { OPT_CALLBACK(0, "affinity", &record.opts, "node|cpu", "Set affinity mask of trace reading thread to NUMA node cpu mask or cpu of processed mmap buffer", record__parse_affinity), +#ifdef HAVE_ZSTD_SUPPORT +OPT_CALLBACK_OPTARG ('z' ,"compression-level" , &record.opts, &comp_level_default, +"n" ,"Produce compressed trace using specified level (default: 1 - fastest compression, 22 - smallest trace)" , + record__parse_comp_level), +#endifOPT_END () };
Signature · 1 line
2.20.1
PATCH v9 10/12 perf report: implement record trace decompression
In reply to Alexey Budankovzstd_init(, comp_level = 0) initializes decompression part of API only that now consists of zstd_decompress_stream() function.
Trace frames containing PERF_RECORD_COMPRESSED records are decompressed using zstd_decompress_stream() function into a linked list of mmaped memory regions of mmap_comp_len size (struct decomp).
After decompression of one COMPRESSED record its content is iterated and fetched for usual processing. The mmaped memory regions with decompressed events are kept in the linked list till the tool process termination.
When dumping raw trace (e.g., perf report -D --header) file offsets of events from compressed records are printed as zero.
--- tools/perf/builtin-report.c | 5 +- tools/perf/util/compress.h | 11 ++++ tools/perf/util/session.c | 124 +++++++++++++++++++++++++++++++++++- tools/perf/util/session.h | 10 +++ tools/perf/util/tool.h | 2 + tools/perf/util/zstd.c | 40 ++++++++++++ 6 files changed, 190 insertions(+), 2 deletions(-)
tools/perf/builtin-report.c +4 -1
@@ -1260,6 +1260,9 @@ int cmd_report(int argc, const char **argv)if (session ==NULL )return -1 ; +if (zstd_init (&(session->zstd_data),0 ) <0 ) +pr_warning ("Decompression initialization failed. Reported data may be incomplete.\n" ); +if (report.queue_size) {ordered_events__set_alloc_size (&session->ordered_events, report.queue_size);
@@ -1450,7 +1453,7 @@ int cmd_report(int argc, const char **argv) error:if (report.ptime_range)zfree (&report.ptime_range); - +zstd_fini (&(session->zstd_data));perf_session__delete (session);return ret; }
tools/perf/util/compress.h +11 -0
@@ -20,6 +20,7 @@ bool lzma_is_compressed(const char *input);struct zstd_data {#ifdef HAVE_ZSTD_SUPPORT ZSTD_CStream *cstream; +ZSTD_DStream *dstream;#endif };
@@ -32,6 +33,9 @@ size_t zstd_compress_stream_to_records(struct zstd_data *data, void *dst, size_t dst_size, void *src, size_t src_size, size_t max_record_size, size_t process_header(void *record, size_t increment)); +size_t zstd_decompress_stream (struct zstd_data *data, +void *src,size_t src_size,void *dst,size_t dst_size); +#else /* !HAVE_ZSTD_SUPPORT */ static inline int zstd_init (struct zstd_data *data__maybe_unused ,int level__maybe_unused )
@@ -53,6 +57,13 @@ static inline size_t zstd_compress_stream_to_records(struct zstd_data *data __mareturn 0 ; } +static inline size_t zstd_decompress_stream (struct zstd_data *data__maybe_unused ,void *src__maybe_unused , +size_t src_size__maybe_unused ,void *dst__maybe_unused , +size_t dst_size__maybe_unused ) +{ +return 0 ; +} +#endif #endif /* PERF_COMPRESS_H */
tools/perf/util/session.c +123 -1
184 lines not on this page · raw message
tools/perf/util/session.h +10 -0
@@ -39,6 +39,16 @@ struct perf_session {u64 bytes_transferred;u64 bytes_compressed;struct zstd_data zstd_data; +struct decomp *decomp; +struct decomp *decomp_last; +}; + +struct decomp { +struct decomp *next; +u64 file_pos; +u64 head; +size_t size; +char data[]; };struct perf_tool ;
tools/perf/util/tool.h +2 -0
@@ -28,6 +28,7 @@ typedef int (*event_attr_op)(struct perf_tool *tool,typedef int (*event_op2 )(struct perf_session *session,union perf_event *event);typedef s64 (*event_op3 )(struct perf_session *session,union perf_event *event); +typedef int (*event_op4 )(struct perf_session *session,union perf_event *event,u64 data);typedef int (*event_oe )(struct perf_tool *tool,union perf_event *event,struct ordered_events *oe);
@@ -72,6 +73,7 @@ struct perf_tool { stat, stat_round, feature; +event_op4 compressed;event_op3 auxtrace;bool ordered_events;bool ordering_requires_timestamps;
tools/perf/util/zstd.c +40 -0
@@ -9,6 +9,21 @@ int zstd_init(struct zstd_data *data, int level) {size_t ret; + data->dstream =ZSTD_createDStream (); +if (data->dstream ==NULL ) { +pr_err ("Couldn't create decompression stream.\n" ); +return -1 ; + } + + ret =ZSTD_initDStream (data->dstream); +if (ZSTD_isError (ret)) { +pr_err ("Failed to initialize decompression stream: %s\n" ,ZSTD_getErrorName (ret)); +return -1 ; + } + +if (!level) +return 0 ; + data->cstream =ZSTD_createCStream ();if (data->cstream ==NULL ) {pr_err ("Couldn't create compression stream.\n" );
@@ -26,6 +41,11 @@ int zstd_init(struct zstd_data *data, int level)int zstd_fini (struct zstd_data *data) { +if (data->dstream) { +ZSTD_freeDStream (data->dstream); + data->dstream =NULL ; + } +if (data->cstream) {ZSTD_freeCStream (data->cstream); data->cstream =NULL ;
@@ -69,3 +89,23 @@ size_t zstd_compress_stream_to_records(struct zstd_data *data,return compressed; } +size_t zstd_decompress_stream (struct zstd_data *data, +void *src,size_t src_size,void *dst,size_t dst_size) +{ +size_t ret; +ZSTD_inBuffer input = { src, src_size,0 }; +ZSTD_outBuffer output = { dst, dst_size,0 }; + +while (input.pos < input.size) { + ret =ZSTD_decompressStream (data->dstream, &output, &input); +if (ZSTD_isError (ret)) { +pr_err ("failed to decompress (B): %ld -> %ld : %s\n" , + src_size, output.size,ZSTD_getErrorName (ret)); +break ; + } + output.dst = dst + output.pos; + output.size = dst_size - output.pos; + } + +return output.pos; +}
Signature · 1 line
2.20.1
PATCH v9 11/12 perf inject: enable COMPRESSED records decompression
In reply to Alexey BudankovInitialized decompression part of Zstd based API so COMPRESSED records would be decompressed into the resulting output data file.
--- tools/perf/builtin-inject.c | 4 ++++ 1 file changed, 4 insertions(+)
tools/perf/builtin-inject.c +4 -0
@@ -837,6 +837,9 @@ int cmd_inject(int argc, const char **argv)if (inject.session ==NULL )return -1 ; +if (zstd_init (&(inject.session->zstd_data),0 ) <0 ) +pr_warning ("Decompression initialization failed.\n" ); +if (inject.build_ids) {/* * to make sure the mmap records are ordered correctly
@@ -867,6 +870,7 @@ int cmd_inject(int argc, const char **argv) ret =__cmd_inject (&inject); out_delete: +zstd_fini (&(inject.session->zstd_data));perf_session__delete (inject.session);return ret; }
Signature · 1 line
2.20.1
PATCH v9 12/12 perf tests: implement Zstd comp/decomp integration test
In reply to Alexey BudankovImplemented basic integration test for Zstd based trace compression/decompression in record and report modes.
--- .../tests/shell/record+zstd_comp_decomp.sh | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100755 tools/perf/tests/shell/record+zstd_comp_decomp.sh
tools/perf/tests/shell/record+zstd_comp_decomp.sh new file +28 -0
@@ -0,0 +1,28 @@ +#!/bin/sh +# record trace Zstd compression/decompression + +trace_file=$(mktemp /tmp/perf.data.XXX) +perf_tool=perf +output=/dev/null + +skip_if_no_z_record() { + $perf_tool record -h 2>&1 | grep '\-z, \-\-compression\-level' +} + +collect_z_record() { + echo "Collecting compressed record trace file:" + $perf_tool record -o $trace_file -a -z -F 25000 -e cycles -- \ + dd count=2000 if=/dev/random of=/dev/null > $output 2>&1 +} + +check_compressed_stats() { + echo "Checking compressed events stats:" + $perf_tool report -i $trace_file --header --stats | \ + grep -E "(# compressed : Zstd,)|(COMPRESSED events:)" > $output 2>&1 +} + +skip_if_no_z_record || exit 2 +collect_z_record && check_compressed_stats +err=$? +rm -f $trace_file +exit $err
Signature · 1 line
2.20.1
Re: [PATCH v9 10/12] perf report: implement record trace decompression
In reply to Alexey BudankovOn Sat, Mar 16, 2019 at 05:17:06PM +0300, Alexey Budankov wrote:
SNIP
Quoted 14 lines
static int perf_session__deliver_event(struct
perf_session*session,tools/perf/util/session.c +2
-0union perf_event *event, struct perf_tool *tool,@@ -198,12 +259,23 @@ static void perf_session__delete_threads(struct perf_session *session)void perf_session__delete (struct perf_session *session) { +struct decomp *next, *decomp; +size_t decomp_len;if (session ==NULL )return ;auxtrace__free (session);auxtrace_index__free (&session->auxtrace_index);perf_session__destroy_kernel_maps (session);
tools/perf/util/session.c static void perf_session__delete_threads(struct perf_session *session) · line 278
Quoted 10 lines
tools/perf/util/session.c +9
-0perf_session__delete_threads (session); + next = session->decomp; + decomp_len = session->header.env.comp_mmap_len; +do { + decomp = next; +if (decomp ==NULL ) +break ; + next = decomp->next; +munmap (decomp, decomp_len +sizeof (struct decomp )); + }while (1 );
please put this to separate function
thanks,
jirka
On Sat, Mar 16, 2019 at 11:58:30AM +0300, Alexey Budankov wrote:
SNIP
Quoted 49 lines
---
Alexey Budankov (12):
feature: implement libzstd check,LIBZSTD_DIRandNO_LIBZSTDdefines perf record: implement --mmap-flush=<number> option
perf session: definebytes_transferredandbytes_compressedmetrics perf record: implement COMPRESSED event record and its attributes perf mmap: implement dedicated memory buffer for data compression perf util: introduce Zstd streaming based compression API perf record: implement compression for serial trace streaming perf record: implement compression for AIO trace streaming perf record: implement -z,--compression_level[=<n>] option perf report: implement record trace decompression
perf inject: enable COMPRESSED records decompression
perf tests: implement Zstd comp/decomp integration testtools/build/Makefile.feature | 6 +- tools/build/feature/Makefile | 6 +- tools/build/feature/test-all.c | 5 + tools/build/feature/test-libzstd.c | 12 + tools/perf/Documentation/perf-record.txt | 17 ++ .../Documentation/perf.data-file-format.txt | 24 ++ tools/perf/Makefile.config | 20 ++ tools/perf/Makefile.perf | 3 + tools/perf/builtin-inject.c | 4 + tools/perf/builtin-record.c | 285 +++++++++++++++--- tools/perf/builtin-report.c | 5 +- tools/perf/builtin-version.c | 2 + tools/perf/perf.h | 2 + .../tests/shell/record+zstd_comp_decomp.sh | 28 ++ tools/perf/util/Build | 2 + tools/perf/util/compress.h | 54 ++++ tools/perf/util/env.h | 11 + tools/perf/util/event.c | 1 + tools/perf/util/event.h | 7 + tools/perf/util/evlist.c | 8 +- tools/perf/util/evlist.h | 3 +- tools/perf/util/header.c | 55 +++- tools/perf/util/header.h | 1 + tools/perf/util/mmap.c | 106 ++----- tools/perf/util/mmap.h | 17 +- tools/perf/util/session.c | 124 +++++++- tools/perf/util/session.h | 14 + tools/perf/util/tool.h | 2 + tools/perf/util/zstd.c | 111 +++++++ 29 files changed, 801 insertions(+), 134 deletions(-) create mode 100644 tools/build/feature/test-libzstd.c create mode 100755 tools/perf/tests/shell/record+zstd_comp_decomp.sh create mode 100644 tools/perf/util/zstd.c
Quoted 6 lines
---
Changes in v9:
- fixed issue with improper max COMPRESSED record size calculation
- moved up calculation of ratio variable in 03/12
- made minor corrections in changelogs
- corrected several checkpatch.pl warnings and errors
apart from 2 comments I'm ok with this patchset
thanks a lot,
jirka
Re: [PATCH v9 12/12] perf tests: implement Zstd comp/decomp integration test
In reply to Alexey BudankovQuoted 47 lines · Alexey Budankov
Implemented basic integration test for Zstd based trace compression/decompression in record and report modes.
Signed-off-by Alexey Budankov <[email protected]>--- .../tests/shell/record+zstd_comp_decomp.sh | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100755 tools/perf/tests/shell/record+zstd_comp_decomp.shtools/perf/tests/shell/record+zstd_comp_decomp.sh new file +28
-0@@ -0,0 +1,28 @@ +#!/bin/sh +# record trace Zstd compression/decompression + +trace_file=$(mktemp /tmp/perf.data.XXX) +perf_tool=perf +output=/dev/null + +skip_if_no_z_record() { + $perf_tool record -h 2>&1 | grep '\-z, \-\-compression\-level' +} + +collect_z_record() { + echo "Collecting compressed record trace file:" + $perf_tool record -o $trace_file -a -z -F 25000 -e cycles -- \ + dd count=2000 if=/dev/random of=/dev/null > $output 2>&1 +} + +check_compressed_stats() { + echo "Checking compressed events stats:" + $perf_tool report -i $trace_file --header --stats | \ + grep -E "(# compressed : Zstd,)|(COMPRESSED events:)" > $output 2>&1 +} + +skip_if_no_z_record || exit 2 +collect_z_record && check_compressed_stats +err=$? +rm -f $trace_file +exit $errSignature · 1 line
2.20.1
could we also check the actualy decompression like below
plus let's disable -a so non root user can run it, and also it takes too long.. changing dd to count=1000 and adding -g to record
jirka
---
tools/perf/tests/shell/record+zstd_comp_decomp.sh +11 -4
@@ -11,8 +11,8 @@ skip_if_no_z_record() { collect_z_record() { echo "Collecting compressed record trace file:" - $perf_tool record -o $trace_file -a -z -F 25000 -e cycles -- \ - dd count=2000 if=/dev/random of=/dev/null > $output 2>&1 + $perf_tool record -o $trace_file -g -z -F 25000 -- \ + dd count=1000 if=/dev/random of=/dev/null > $output 2>&1 } check_compressed_stats() {
@@ -21,8 +21,15 @@ check_compressed_stats() { grep -E "(# compressed : Zstd,)|(COMPRESSED events:)" > $output 2>&1 } +check_compressed_output() { + $perf_tool inject -i $trace_file -o $trace_file.decomp && + $perf_tool report -i $trace_file --stdio | head -n -3 > $trace_file.comp.output && + $perf_tool report -i $trace_file.decomp --stdio | head -n -3 > $trace_file.decomp.output && + diff $trace_file.comp.output $trace_file.decomp.output > $output 2>&1 +} + skip_if_no_z_record || exit 2 -collect_z_record && check_compressed_stats +collect_z_record && check_compressed_stats && check_compressed_output err=$? -rm -f $trace_file +rm -f $trace_file* exit $err
Re: [PATCH v9 10/12] perf report: implement record trace decompression
In reply to Jiri OlsaQuoted 22 lines · Jiri Olsa
On Sat, Mar 16, 2019 at 05:17:06PM +0300, Alexey Budankov wrote:
SNIP
Quoted 18 lines
static int perf_session__deliver_event(struct
perf_session*session,tools/perf/util/session.c +5
-0union perf_event *event, struct perf_tool *tool,@@ -198,12 +259,23 @@ static void perf_session__delete_threads(struct perf_session *session)void perf_session__delete (struct perf_session *session) { +struct decomp *next, *decomp; +size_t decomp_len;if (session ==NULL )return ;auxtrace__free (session);auxtrace_index__free (&session->auxtrace_index);perf_session__destroy_kernel_maps (session);perf_session__delete_threads (session); + next = session->decomp; + decomp_len = session->header.env.comp_mmap_len; + do {
Quoted 8 lines
tools/perf/util/session.c static void perf_session__delete_threads(struct perf_session *session) · line 278
Quoted 6 lines
tools/perf/util/session.c +6
-0+ decomp = next; +if (decomp ==NULL ) +break ; + next = decomp->next; +munmap (decomp, decomp_len +sizeof (struct decomp )); + }while (1 );please put this to separate function
in v10.
~Alexey
Quoted 4 lines
thanks,
jirka
Re: [PATCH v9 12/12] perf tests: implement Zstd comp/decomp integration test
In reply to Jiri OlsaQuoted 51 lines · Jiri Olsa
Quoted 47 lines · Alexey Budankov
Implemented basic integration test for Zstd based trace compression/decompression in record and report modes.
Signed-off-by Alexey Budankov <[email protected]>--- .../tests/shell/record+zstd_comp_decomp.sh | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100755 tools/perf/tests/shell/record+zstd_comp_decomp.shtools/perf/tests/shell/record+zstd_comp_decomp.sh new file +28
-0@@ -0,0 +1,28 @@ +#!/bin/sh +# record trace Zstd compression/decompression + +trace_file=$(mktemp /tmp/perf.data.XXX) +perf_tool=perf +output=/dev/null + +skip_if_no_z_record() { + $perf_tool record -h 2>&1 | grep '\-z, \-\-compression\-level' +} + +collect_z_record() { + echo "Collecting compressed record trace file:" + $perf_tool record -o $trace_file -a -z -F 25000 -e cycles -- \ + dd count=2000 if=/dev/random of=/dev/null > $output 2>&1 +} + +check_compressed_stats() { + echo "Checking compressed events stats:" + $perf_tool report -i $trace_file --header --stats | \ + grep -E "(# compressed : Zstd,)|(COMPRESSED events:)" > $output 2>&1 +} + +skip_if_no_z_record || exit 2 +collect_z_record && check_compressed_stats +err=$? +rm -f $trace_file +exit $errSignature · 1 line
2.20.1could we also check the actualy decompression like below
Quoted 3 lines
plus let's disable -a so non root user can run it, and also it takes too long.. changing dd to count=1000 and adding -g to record
in v10.
~Alexey
Quoted 39 lines
jirka
---
tools/perf/tests/shell/record+zstd_comp_decomp.sh +11
-4@@ -11,8 +11,8 @@ skip_if_no_z_record() { collect_z_record() { echo "Collecting compressed record trace file:" - $perf_tool record -o $trace_file -a -z -F 25000 -e cycles -- \ - dd count=2000 if=/dev/random of=/dev/null > $output 2>&1 + $perf_tool record -o $trace_file -g -z -F 25000 -- \ + dd count=1000 if=/dev/random of=/dev/null > $output 2>&1 } check_compressed_stats() {@@ -21,8 +21,15 @@ check_compressed_stats() { grep -E "(# compressed : Zstd,)|(COMPRESSED events:)" > $output 2>&1 } +check_compressed_output() { + $perf_tool inject -i $trace_file -o $trace_file.decomp && + $perf_tool report -i $trace_file --stdio | head -n -3 > $trace_file.comp.output && + $perf_tool report -i $trace_file.decomp --stdio | head -n -3 > $trace_file.decomp.output && + diff $trace_file.comp.output $trace_file.decomp.output > $output 2>&1 +} + skip_if_no_z_record || exit 2 -collect_z_record && check_compressed_stats +collect_z_record && check_compressed_stats && check_compressed_output err=$? -rm -f $trace_file +rm -f $trace_file* exit $err
Quoted 53 lines · Jiri Olsa
On Sat, Mar 16, 2019 at 11:58:30AM +0300, Alexey Budankov wrote:
SNIP
Quoted 49 lines
---
Alexey Budankov (12):
feature: implement libzstd check,LIBZSTD_DIRandNO_LIBZSTDdefines perf record: implement --mmap-flush=<number> option
perf session: definebytes_transferredandbytes_compressedmetrics perf record: implement COMPRESSED event record and its attributes perf mmap: implement dedicated memory buffer for data compression perf util: introduce Zstd streaming based compression API perf record: implement compression for serial trace streaming perf record: implement compression for AIO trace streaming perf record: implement -z,--compression_level[=<n>] option perf report: implement record trace decompression
perf inject: enable COMPRESSED records decompression
perf tests: implement Zstd comp/decomp integration testtools/build/Makefile.feature | 6 +- tools/build/feature/Makefile | 6 +- tools/build/feature/test-all.c | 5 + tools/build/feature/test-libzstd.c | 12 + tools/perf/Documentation/perf-record.txt | 17 ++ .../Documentation/perf.data-file-format.txt | 24 ++ tools/perf/Makefile.config | 20 ++ tools/perf/Makefile.perf | 3 + tools/perf/builtin-inject.c | 4 + tools/perf/builtin-record.c | 285 +++++++++++++++--- tools/perf/builtin-report.c | 5 +- tools/perf/builtin-version.c | 2 + tools/perf/perf.h | 2 + .../tests/shell/record+zstd_comp_decomp.sh | 28 ++ tools/perf/util/Build | 2 + tools/perf/util/compress.h | 54 ++++ tools/perf/util/env.h | 11 + tools/perf/util/event.c | 1 + tools/perf/util/event.h | 7 + tools/perf/util/evlist.c | 8 +- tools/perf/util/evlist.h | 3 +- tools/perf/util/header.c | 55 +++- tools/perf/util/header.h | 1 + tools/perf/util/mmap.c | 106 ++----- tools/perf/util/mmap.h | 17 +- tools/perf/util/session.c | 124 +++++++- tools/perf/util/session.h | 14 + tools/perf/util/tool.h | 2 + tools/perf/util/zstd.c | 111 +++++++ 29 files changed, 801 insertions(+), 134 deletions(-) create mode 100644 tools/build/feature/test-libzstd.c create mode 100755 tools/perf/tests/shell/record+zstd_comp_decomp.sh create mode 100644 tools/perf/util/zstd.c
Quoted 8 lines
Quoted 6 lines
---
Changes in v9:
- fixed issue with improper max COMPRESSED record size calculation
- moved up calculation of ratio variable in 03/12
- made minor corrections in changelogs
- corrected several checkpatch.pl warnings and errorsapart from 2 comments I'm ok with this patchset
Comments are addressed in v10.
Quoted 2 lines
Reviewed-by Jiri Olsa <[email protected]>
Thanks,
Alexey
Quoted 4 lines
thanks a lot,
jirka