plugins: move the more involved plugins to contrib
We have an exploding complexity problem in the testing so lets just move the more involved plugins into contrib. tests/plugins still exist for the basic plugins that exercise the API. We restore the old pre-meson style Makefile for contrib as it also doubles as a guide for out-of-tree plugin builds. While we are at it add some examples to the documentation and a specific plugins build target. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Message-Id: <20200909112742.25730-11-alex.bennee@linaro.org>
This commit is contained in:
Alex Bennée
parent
89e076f37d
commit
c17a386b6a
@ -2745,7 +2745,8 @@ M: Alex Bennée <alex.bennee@linaro.org>
|
||||
S: Maintained
|
||||
F: docs/devel/tcg-plugins.rst
|
||||
F: plugins/
|
||||
F: tests/plugin
|
||||
F: tests/plugin/
|
||||
F: contrib/plugins/
|
||||
|
||||
AArch64 TCG target
|
||||
M: Richard Henderson <richard.henderson@linaro.org>
|
||||
|
||||
11
Makefile
11
Makefile
@ -106,6 +106,12 @@ config-host.mak: $(SRC_PATH)/configure $(SRC_PATH)/pc-bios $(SRC_PATH)/VERSION
|
||||
# Force configure to re-run if the API symbols are updated
|
||||
ifeq ($(CONFIG_PLUGIN),y)
|
||||
config-host.mak: $(SRC_PATH)/plugins/qemu-plugins.symbols
|
||||
|
||||
.PHONY: plugins
|
||||
plugins:
|
||||
$(call quiet-command,\
|
||||
$(MAKE) $(SUBDIR_MAKEFLAGS) -C contrib/plugins V="$(V)", \
|
||||
"BUILD", "example plugins")
|
||||
endif
|
||||
|
||||
else
|
||||
@ -256,6 +262,11 @@ help:
|
||||
$(call print-help,cscope,Generate cscope index)
|
||||
$(call print-help,sparse,Run sparse on the QEMU source)
|
||||
@echo ''
|
||||
ifeq ($(CONFIG_PLUGIN),y)
|
||||
@echo 'Plugin targets:'
|
||||
$(call print-help,plugins,Build the example TCG plugins)
|
||||
@echo ''
|
||||
endif
|
||||
@echo 'Cleaning targets:'
|
||||
$(call print-help,clean,Remove most generated files but keep the config)
|
||||
$(call print-help,distclean,Remove all generated files)
|
||||
|
||||
2
configure
vendored
2
configure
vendored
@ -7855,6 +7855,7 @@ DIRS="$DIRS tests/qtest tests/qemu-iotests tests/vm tests/fp tests/qgraph"
|
||||
DIRS="$DIRS docs docs/interop fsdev scsi"
|
||||
DIRS="$DIRS pc-bios/optionrom pc-bios/s390-ccw"
|
||||
DIRS="$DIRS roms/seabios"
|
||||
DIRS="$DIRS contrib/plugins/"
|
||||
LINKS="Makefile"
|
||||
LINKS="$LINKS tests/tcg/lm32/Makefile"
|
||||
LINKS="$LINKS tests/tcg/Makefile.target"
|
||||
@ -7866,6 +7867,7 @@ LINKS="$LINKS .gdbinit scripts" # scripts needed by relative path in .gdbinit
|
||||
LINKS="$LINKS tests/acceptance tests/data"
|
||||
LINKS="$LINKS tests/qemu-iotests/check"
|
||||
LINKS="$LINKS python"
|
||||
LINKS="$LINKS contrib/plugins/Makefile "
|
||||
UNLINK="pc-bios/keymaps"
|
||||
for bios_file in \
|
||||
$source_path/pc-bios/*.bin \
|
||||
|
||||
42
contrib/plugins/Makefile
Normal file
42
contrib/plugins/Makefile
Normal file
@ -0,0 +1,42 @@
|
||||
# -*- Mode: makefile -*-
|
||||
#
|
||||
# This Makefile example is fairly independent from the main makefile
|
||||
# so users can take and adapt it for their build. We only really
|
||||
# include config-host.mak so we don't have to repeat probing for
|
||||
# cflags that the main configure has already done for us.
|
||||
#
|
||||
|
||||
BUILD_DIR := $(CURDIR)/../..
|
||||
|
||||
include $(BUILD_DIR)/config-host.mak
|
||||
|
||||
VPATH += $(SRC_PATH)/contrib/plugins
|
||||
|
||||
NAMES :=
|
||||
NAMES += hotblocks
|
||||
NAMES += hotpages
|
||||
NAMES += howvec
|
||||
NAMES += lockstep
|
||||
|
||||
SONAMES := $(addsuffix .so,$(addprefix lib,$(NAMES)))
|
||||
|
||||
# The main QEMU uses Glib extensively so it's perfectly fine to use it
|
||||
# in plugins (which many example do).
|
||||
CFLAGS = $(GLIB_CFLAGS)
|
||||
CFLAGS += -fPIC
|
||||
CFLAGS += $(if $(findstring no-psabi,$(QEMU_CFLAGS)),-Wpsabi)
|
||||
CFLAGS += -I$(SRC_PATH)/include/qemu
|
||||
|
||||
all: $(SONAMES)
|
||||
|
||||
%.o: %.c
|
||||
$(CC) $(CFLAGS) -c -o $@ $<
|
||||
|
||||
lib%.so: %.o
|
||||
$(CC) -shared -Wl,-soname,$@ -o $@ $^ $(LDLIBS)
|
||||
|
||||
clean:
|
||||
rm -f *.o *.so *.d
|
||||
rm -Rf .libs
|
||||
|
||||
.PHONY: all clean
|
||||
@ -134,3 +134,149 @@ longer want to instrument the code. This operation is asynchronous
|
||||
which means callbacks may still occur after the uninstall operation is
|
||||
requested. The plugin isn't completely uninstalled until the safe work
|
||||
has executed while all vCPUs are quiescent.
|
||||
|
||||
Example Plugins
|
||||
===============
|
||||
|
||||
There are a number of plugins included with QEMU and you are
|
||||
encouraged to contribute your own plugins plugins upstream. There is a
|
||||
`contrib/plugins` directory where they can go.
|
||||
|
||||
- tests/plugins
|
||||
|
||||
These are some basic plugins that are used to test and exercise the
|
||||
API during the `make check-tcg` target.
|
||||
|
||||
- contrib/plugins/hotblocks.c
|
||||
|
||||
The hotblocks plugin allows you to examine the where hot paths of
|
||||
execution are in your program. Once the program has finished you will
|
||||
get a sorted list of blocks reporting the starting PC, translation
|
||||
count, number of instructions and execution count. This will work best
|
||||
with linux-user execution as system emulation tends to generate
|
||||
re-translations as blocks from different programs get swapped in and
|
||||
out of system memory.
|
||||
|
||||
If your program is single-threaded you can use the `inline` option for
|
||||
slightly faster (but not thread safe) counters.
|
||||
|
||||
Example::
|
||||
|
||||
./aarch64-linux-user/qemu-aarch64 \
|
||||
-plugin contrib/plugins/libhotblocks.so -d plugin \
|
||||
./tests/tcg/aarch64-linux-user/sha1
|
||||
SHA1=15dd99a1991e0b3826fede3deffc1feba42278e6
|
||||
collected 903 entries in the hash table
|
||||
pc, tcount, icount, ecount
|
||||
0x0000000041ed10, 1, 5, 66087
|
||||
0x000000004002b0, 1, 4, 66087
|
||||
...
|
||||
|
||||
- contrib/plugins/hotpages.c
|
||||
|
||||
Similar to hotblocks but this time tracks memory accesses::
|
||||
|
||||
./aarch64-linux-user/qemu-aarch64 \
|
||||
-plugin contrib/plugins/libhotpages.so -d plugin \
|
||||
./tests/tcg/aarch64-linux-user/sha1
|
||||
SHA1=15dd99a1991e0b3826fede3deffc1feba42278e6
|
||||
Addr, RCPUs, Reads, WCPUs, Writes
|
||||
0x000055007fe000, 0x0001, 31747952, 0x0001, 8835161
|
||||
0x000055007ff000, 0x0001, 29001054, 0x0001, 8780625
|
||||
0x00005500800000, 0x0001, 687465, 0x0001, 335857
|
||||
0x0000000048b000, 0x0001, 130594, 0x0001, 355
|
||||
0x0000000048a000, 0x0001, 1826, 0x0001, 11
|
||||
|
||||
- contrib/plugins/howvec.c
|
||||
|
||||
This is an instruction classifier so can be used to count different
|
||||
types of instructions. It has a number of options to refine which get
|
||||
counted. You can give an argument for a class of instructions to break
|
||||
it down fully, so for example to see all the system registers
|
||||
accesses::
|
||||
|
||||
./aarch64-softmmu/qemu-system-aarch64 $(QEMU_ARGS) \
|
||||
-append "root=/dev/sda2 systemd.unit=benchmark.service" \
|
||||
-smp 4 -plugin ./contrib/plugins/libhowvec.so,arg=sreg -d plugin
|
||||
|
||||
which will lead to a sorted list after the class breakdown::
|
||||
|
||||
Instruction Classes:
|
||||
Class: UDEF not counted
|
||||
Class: SVE (68 hits)
|
||||
Class: PCrel addr (47789483 hits)
|
||||
Class: Add/Sub (imm) (192817388 hits)
|
||||
Class: Logical (imm) (93852565 hits)
|
||||
Class: Move Wide (imm) (76398116 hits)
|
||||
Class: Bitfield (44706084 hits)
|
||||
Class: Extract (5499257 hits)
|
||||
Class: Cond Branch (imm) (147202932 hits)
|
||||
Class: Exception Gen (193581 hits)
|
||||
Class: NOP not counted
|
||||
Class: Hints (6652291 hits)
|
||||
Class: Barriers (8001661 hits)
|
||||
Class: PSTATE (1801695 hits)
|
||||
Class: System Insn (6385349 hits)
|
||||
Class: System Reg counted individually
|
||||
Class: Branch (reg) (69497127 hits)
|
||||
Class: Branch (imm) (84393665 hits)
|
||||
Class: Cmp & Branch (110929659 hits)
|
||||
Class: Tst & Branch (44681442 hits)
|
||||
Class: AdvSimd ldstmult (736 hits)
|
||||
Class: ldst excl (9098783 hits)
|
||||
Class: Load Reg (lit) (87189424 hits)
|
||||
Class: ldst noalloc pair (3264433 hits)
|
||||
Class: ldst pair (412526434 hits)
|
||||
Class: ldst reg (imm) (314734576 hits)
|
||||
Class: Loads & Stores (2117774 hits)
|
||||
Class: Data Proc Reg (223519077 hits)
|
||||
Class: Scalar FP (31657954 hits)
|
||||
Individual Instructions:
|
||||
Instr: mrs x0, sp_el0 (2682661 hits) (op=0xd5384100/ System Reg)
|
||||
Instr: mrs x1, tpidr_el2 (1789339 hits) (op=0xd53cd041/ System Reg)
|
||||
Instr: mrs x2, tpidr_el2 (1513494 hits) (op=0xd53cd042/ System Reg)
|
||||
Instr: mrs x0, tpidr_el2 (1490823 hits) (op=0xd53cd040/ System Reg)
|
||||
Instr: mrs x1, sp_el0 (933793 hits) (op=0xd5384101/ System Reg)
|
||||
Instr: mrs x2, sp_el0 (699516 hits) (op=0xd5384102/ System Reg)
|
||||
Instr: mrs x4, tpidr_el2 (528437 hits) (op=0xd53cd044/ System Reg)
|
||||
Instr: mrs x30, ttbr1_el1 (480776 hits) (op=0xd538203e/ System Reg)
|
||||
Instr: msr ttbr1_el1, x30 (480713 hits) (op=0xd518203e/ System Reg)
|
||||
Instr: msr vbar_el1, x30 (480671 hits) (op=0xd518c01e/ System Reg)
|
||||
...
|
||||
|
||||
To find the argument shorthand for the class you need to examine the
|
||||
source code of the plugin at the moment, specifically the `*opt`
|
||||
argument in the InsnClassExecCount tables.
|
||||
|
||||
- contrib/plugins/lockstep.c
|
||||
|
||||
This is a debugging tool for developers who want to find out when and
|
||||
where execution diverges after a subtle change to TCG code generation.
|
||||
It is not an exact science and results are likely to be mixed once
|
||||
asynchronous events are introduced. While the use of -icount can
|
||||
introduce determinism to the execution flow it doesn't always follow
|
||||
the translation sequence will be exactly the same. Typically this is
|
||||
caused by a timer firing to service the GUI causing a block to end
|
||||
early. However in some cases it has proved to be useful in pointing
|
||||
people at roughly where execution diverges. The only argument you need
|
||||
for the plugin is a path for the socket the two instances will
|
||||
communicate over::
|
||||
|
||||
|
||||
./sparc-softmmu/qemu-system-sparc -monitor none -parallel none \
|
||||
-net none -M SS-20 -m 256 -kernel day11/zImage.elf \
|
||||
-plugin ./contrib/plugins/liblockstep.so,arg=lockstep-sparc.sock \
|
||||
-d plugin,nochain
|
||||
|
||||
which will eventually report::
|
||||
|
||||
qemu-system-sparc: warning: nic lance.0 has no peer
|
||||
@ 0x000000ffd06678 vs 0x000000ffd001e0 (2/1 since last)
|
||||
@ 0x000000ffd07d9c vs 0x000000ffd06678 (3/1 since last)
|
||||
Δ insn_count @ 0x000000ffd07d9c (809900609) vs 0x000000ffd06678 (809900612)
|
||||
previously @ 0x000000ffd06678/10 (809900609 insns)
|
||||
previously @ 0x000000ffd001e0/4 (809900599 insns)
|
||||
previously @ 0x000000ffd080ac/2 (809900595 insns)
|
||||
previously @ 0x000000ffd08098/5 (809900593 insns)
|
||||
previously @ 0x000000ffd080c0/1 (809900588 insns)
|
||||
|
||||
|
||||
@ -50,7 +50,7 @@ RUN_TCG_TARGET_RULES=$(patsubst %,run-tcg-tests-%, $(TARGET_DIRS))
|
||||
$(foreach PROBE_TARGET,$(TARGET_DIRS), \
|
||||
$(eval -include $(SRC_PATH)/tests/tcg/Makefile.prereqs))
|
||||
|
||||
build-tcg-tests-%: $(if $(CONFIG_PLUGIN),plugins)
|
||||
build-tcg-tests-%: $(if $(CONFIG_PLUGIN),test-plugins)
|
||||
$(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) \
|
||||
-f $(SRC_PATH)/tests/tcg/Makefile.qemu \
|
||||
SRC_PATH=$(SRC_PATH) \
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
t = []
|
||||
foreach i : ['bb', 'empty', 'insn', 'mem', 'hotblocks', 'howvec', 'hotpages', 'lockstep']
|
||||
foreach i : ['bb', 'empty', 'insn', 'mem']
|
||||
t += shared_module(i, files(i + '.c'),
|
||||
include_directories: '../../include/qemu',
|
||||
dependencies: glib)
|
||||
endforeach
|
||||
alias_target('plugins', t)
|
||||
alias_target('test-plugins', t)
|
||||
|
||||
@ -129,8 +129,7 @@ ifeq ($(CONFIG_PLUGIN),y)
|
||||
PLUGIN_SRC=$(SRC_PATH)/tests/plugin
|
||||
PLUGIN_LIB=../../plugin
|
||||
VPATH+=$(PLUGIN_LIB)
|
||||
PLUGINS=$(filter-out liblockstep.so,\
|
||||
$(patsubst %.c, lib%.so, $(notdir $(wildcard $(PLUGIN_SRC)/*.c))))
|
||||
PLUGINS=$(patsubst %.c, lib%.so, $(notdir $(wildcard $(PLUGIN_SRC)/*.c)))
|
||||
|
||||
# We need to ensure expand the run-plugin-TEST-with-PLUGIN
|
||||
# pre-requistes manually here as we can't use stems to handle it. We
|
||||
|
||||
Loading…
Reference in New Issue
Block a user