This patchset proposes roadtest, a device-driver testing framework. Drivers
are tested under User Mode Linux (UML) and interact with mocked/modelled
hardware. The tests and hardware models are written in Python, the former
using Python's built-in unittest framework.
Drivers are tested via their userspace interfaces. The hardware models allow
tests to inject values into registers and assert that drivers control the
hardware in the right way and react as expected to stimuli.
Roadtest is meant to be used for relatively simple drivers, such as the ones
part of the IIO, regulator and RTC subsystems.
Questions and answers:
= Why do we need this?
There are a large amount of these kind of drivers in the kernel. Most of the
hardware is not available in current CI systems so most drivers can only, at
best, be build-tested there. Even basic soundness such as a driver
successfully probing and binding to the devices it tries to be support cannot
be tested. Drivers cannot be easily regression-tested to ensure that bugs
fixed once do not get reintroduced.
Many drivers support multiple related hardware variants, and far from all patch
submitters have access to all the variants which the driver that they are
patching supports, so there is no way for them to easily verify that they
haven't broken something basic on a variant which they do not own.
Furthermore, hardware can be used in many different configurations with drivers
supporting many different devicetree properties, so even just having access to
all the variants would be insufficient.
On top of that, some of the chips measure environmental conditions such as
temperature, so testing extreme cases may not be simple even if one has access
to the hardware.
All this makes development, modification, maintenance, and reviewing of these
drivers harder than it necessarily needs to be. Roadtest hopes to make some of
these things slightly easier by providing a framework to create hardware
models/mocks and to write testcases which exercise drivers using these models.
= Do you have some specific examples of the kind of code this could be used to
test?
Here is an example of a patch which can easily be regression-tested using
roadtest (in fact, this series includes such a regression test) but is much
harder to do so automatically with real hardware since it requires specific
environmental conditions:
iio: light: opt3001: Fixed timeout error when 0 lux
https://lore.kernel.org/lkml/[email protected]/
Here is another example. This driver has code which correctly parses a
documented devicetree property (amstaos,proximity-diodes) but which then fails
to actually communicate this setting to the hardware in any way. Such code can
be easily tested with roadtest since the framework integrates devicetree
support and provides functions to assert that drivers writes expected registers
with expected values:
drivers/iio/light/tsl2772.c tsl2772_read_prox_diodes()
(Both the above examples happen to be from the same subsystem but that should
in no way be taken to imply that such issues are unique to that subsystem or
that that subsystem has more of them.)
= How does this relate to kselftests?
Tests in kselftests also test kernel code using the userspace interfaces, but
that's about what's common between the frameworks. kselftests has other goals
and does not provide any kind of mechanism for hardware mocking.
= How does this relate to kunit?
Kunit is for unit testing of functions in kernel code, and is not meant for
testing kernel code via userspace interfaces. It could in theory be used to
test some of the simple drivers too, but that would require (1) a large amount
of mocking code in various kernel frameworks, and, more importantly, (2)
refactoring of the drivers to be tested.
This can be contrasted with roadtest which works with mostly unmodified drivers
and which mocks the hardware at the lowest level without having to change
kernel frameworks.
= How do I use it?
See Documentation/dev-tools/roadtest.rst added by the documentation patch for
more information about running and writing tests using this framework.
= What's included in the patchset?
The current framework allows developing tests for hardware which uses the I2C
bus. Hardware models can also control GPIOs and use them to trigger
interrupts.
This series includes tests for some IIO, regulator and RTC drivers. The
regulator and RTC tests depend on a few driver patches which are either in
review or in linux-next. These are noted in the commit messages.
The entire patch set, including the required dependencies, is also available in
a git tree:
https://github.com/vwax/linux/commits/roadtest/rfc-v1
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Vincent Whitchurch (10):
roadtest: import libvhost-user from QEMU
roadtest: add C backend
roadtest: add framework
roadtest: add base config
roadtest: add build files
roadtest: add documentation
iio: light: opt3001: add roadtest
iio: light: vcnl4000: add roadtest
regulator: tps62864: add roadtest
rtc: pcf8563: add roadtest
Documentation/dev-tools/index.rst | 1 +
Documentation/dev-tools/roadtest.rst | 669 ++++
tools/testing/roadtest/.gitignore | 2 +
tools/testing/roadtest/Dockerfile | 25 +
tools/testing/roadtest/Makefile | 84 +
tools/testing/roadtest/init.sh | 19 +
tools/testing/roadtest/pyproject.toml | 10 +
tools/testing/roadtest/requirements.txt | 4 +
tools/testing/roadtest/roadtest/__init__.py | 2 +
.../roadtest/roadtest/backend/__init__.py | 0
.../roadtest/roadtest/backend/backend.py | 32 +
.../testing/roadtest/roadtest/backend/gpio.py | 111 +
.../testing/roadtest/roadtest/backend/i2c.py | 123 +
.../testing/roadtest/roadtest/backend/main.py | 13 +
.../testing/roadtest/roadtest/backend/mock.py | 20 +
.../roadtest/roadtest/backend/test_gpio.py | 98 +
.../roadtest/roadtest/backend/test_i2c.py | 84 +
.../testing/roadtest/roadtest/cmd/__init__.py | 0
tools/testing/roadtest/roadtest/cmd/main.py | 146 +
tools/testing/roadtest/roadtest/cmd/remote.py | 48 +
.../roadtest/roadtest/core/__init__.py | 0
.../testing/roadtest/roadtest/core/control.py | 52 +
.../roadtest/roadtest/core/devicetree.py | 155 +
.../roadtest/roadtest/core/hardware.py | 94 +
tools/testing/roadtest/roadtest/core/log.py | 42 +
.../testing/roadtest/roadtest/core/modules.py | 38 +
.../testing/roadtest/roadtest/core/opslog.py | 35 +
tools/testing/roadtest/roadtest/core/proxy.py | 48 +
tools/testing/roadtest/roadtest/core/suite.py | 286 ++
tools/testing/roadtest/roadtest/core/sysfs.py | 77 +
.../roadtest/roadtest/core/test_control.py | 35 +
.../roadtest/roadtest/core/test_devicetree.py | 31 +
.../roadtest/roadtest/core/test_hardware.py | 41 +
.../roadtest/roadtest/core/test_log.py | 54 +
.../roadtest/roadtest/core/test_opslog.py | 27 +
.../roadtest/roadtest/tests/__init__.py | 0
.../roadtest/roadtest/tests/base/config | 84 +
.../roadtest/roadtest/tests/iio/__init__.py | 0
.../roadtest/roadtest/tests/iio/config | 1 +
.../roadtest/roadtest/tests/iio/iio.py | 112 +
.../roadtest/tests/iio/light/__init__.py | 0
.../roadtest/roadtest/tests/iio/light/config | 2 +
.../roadtest/tests/iio/light/test_opt3001.py | 95 +
.../roadtest/tests/iio/light/test_vcnl4000.py | 132 +
.../roadtest/tests/iio/light/test_vcnl4010.py | 282 ++
.../roadtest/tests/iio/light/test_vcnl4040.py | 104 +
.../roadtest/tests/iio/light/test_vcnl4200.py | 96 +
.../roadtest/tests/regulator/__init__.py | 0
.../roadtest/roadtest/tests/regulator/config | 4 +
.../roadtest/tests/regulator/test_tps62864.py | 187 ++
.../roadtest/roadtest/tests/rtc/__init__.py | 0
.../roadtest/roadtest/tests/rtc/config | 1 +
.../roadtest/roadtest/tests/rtc/rtc.py | 73 +
.../roadtest/tests/rtc/test_pcf8563.py | 348 ++
tools/testing/roadtest/src/.gitignore | 1 +
tools/testing/roadtest/src/backend.c | 884 +++++
.../src/libvhost-user/include/atomic.h | 310 ++
.../src/libvhost-user/libvhost-user.c | 2885 +++++++++++++++++
.../src/libvhost-user/libvhost-user.h | 691 ++++
59 files changed, 8798 insertions(+)
create mode 100644 Documentation/dev-tools/roadtest.rst
create mode 100644 tools/testing/roadtest/.gitignore
create mode 100644 tools/testing/roadtest/Dockerfile
create mode 100644 tools/testing/roadtest/Makefile
create mode 100755 tools/testing/roadtest/init.sh
create mode 100644 tools/testing/roadtest/pyproject.toml
create mode 100644 tools/testing/roadtest/requirements.txt
create mode 100644 tools/testing/roadtest/roadtest/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/backend/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/backend/backend.py
create mode 100644 tools/testing/roadtest/roadtest/backend/gpio.py
create mode 100644 tools/testing/roadtest/roadtest/backend/i2c.py
create mode 100644 tools/testing/roadtest/roadtest/backend/main.py
create mode 100644 tools/testing/roadtest/roadtest/backend/mock.py
create mode 100644 tools/testing/roadtest/roadtest/backend/test_gpio.py
create mode 100644 tools/testing/roadtest/roadtest/backend/test_i2c.py
create mode 100644 tools/testing/roadtest/roadtest/cmd/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/cmd/main.py
create mode 100644 tools/testing/roadtest/roadtest/cmd/remote.py
create mode 100644 tools/testing/roadtest/roadtest/core/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/core/control.py
create mode 100644 tools/testing/roadtest/roadtest/core/devicetree.py
create mode 100644 tools/testing/roadtest/roadtest/core/hardware.py
create mode 100644 tools/testing/roadtest/roadtest/core/log.py
create mode 100644 tools/testing/roadtest/roadtest/core/modules.py
create mode 100644 tools/testing/roadtest/roadtest/core/opslog.py
create mode 100644 tools/testing/roadtest/roadtest/core/proxy.py
create mode 100644 tools/testing/roadtest/roadtest/core/suite.py
create mode 100644 tools/testing/roadtest/roadtest/core/sysfs.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_control.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_devicetree.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_hardware.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_log.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_opslog.py
create mode 100644 tools/testing/roadtest/roadtest/tests/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/tests/base/config
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/config
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/iio.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/config
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py
create mode 100644 tools/testing/roadtest/roadtest/tests/regulator/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/tests/regulator/config
create mode 100644 tools/testing/roadtest/roadtest/tests/regulator/test_tps62864.py
create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/config
create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/rtc.py
create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/test_pcf8563.py
create mode 100644 tools/testing/roadtest/src/.gitignore
create mode 100644 tools/testing/roadtest/src/backend.c
create mode 100644 tools/testing/roadtest/src/libvhost-user/include/atomic.h
create mode 100644 tools/testing/roadtest/src/libvhost-user/libvhost-user.c
create mode 100644 tools/testing/roadtest/src/libvhost-user/libvhost-user.h
--
2.34.1
Add a regression test for the problem fixed by the following patch,
which would require specific environmental conditions to be able to be
reproduced and regression-tested on real hardware:
iio: light: opt3001: Fixed timeout error when 0 lux
https://lore.kernel.org/lkml/[email protected]/
No other aspects of the driver are tested.
Signed-off-by: Vincent Whitchurch <[email protected]>
---
.../roadtest/roadtest/tests/iio/__init__.py | 0
.../roadtest/roadtest/tests/iio/config | 1 +
.../roadtest/tests/iio/light/__init__.py | 0
.../roadtest/roadtest/tests/iio/light/config | 1 +
.../roadtest/tests/iio/light/test_opt3001.py | 95 +++++++++++++++++++
5 files changed, 97 insertions(+)
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/config
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/config
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py
diff --git a/tools/testing/roadtest/roadtest/tests/iio/__init__.py b/tools/testing/roadtest/roadtest/tests/iio/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/tools/testing/roadtest/roadtest/tests/iio/config b/tools/testing/roadtest/roadtest/tests/iio/config
new file mode 100644
index 000000000000..a08d9e23ce38
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/iio/config
@@ -0,0 +1 @@
+CONFIG_IIO=y
diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/__init__.py b/tools/testing/roadtest/roadtest/tests/iio/light/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/config b/tools/testing/roadtest/roadtest/tests/iio/light/config
new file mode 100644
index 000000000000..b9753f2d0728
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/iio/light/config
@@ -0,0 +1 @@
+CONFIG_OPT3001=m
diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py
new file mode 100644
index 000000000000..abf20b8f3516
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py
@@ -0,0 +1,95 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+from typing import Any, Final
+
+from roadtest.backend.i2c import SMBusModel
+from roadtest.core.devicetree import DtFragment, DtVar
+from roadtest.core.hardware import Hardware
+from roadtest.core.modules import insmod, rmmod
+from roadtest.core.suite import UMLTestCase
+from roadtest.core.sysfs import I2CDriver, read_float
+
+REG_RESULT: Final = 0x00
+REG_CONFIGURATION: Final = 0x01
+REG_LOW_LIMIT: Final = 0x02
+REG_HIGH_LIMIT: Final = 0x03
+REG_MANUFACTURER_ID: Final = 0x7E
+REG_DEVICE_ID: Final = 0x7F
+
+REG_CONFIGURATION_CRF: Final = 1 << 7
+
+
+class OPT3001(SMBusModel):
+ def __init__(self, **kwargs: Any) -> None:
+ super().__init__(regbytes=2, byteorder="big", **kwargs)
+ # Reset values from datasheet
+ self.regs = {
+ REG_RESULT: 0x0000,
+ REG_CONFIGURATION: 0xC810,
+ REG_LOW_LIMIT: 0xC000,
+ REG_HIGH_LIMIT: 0xBFFF,
+ REG_MANUFACTURER_ID: 0x5449,
+ REG_DEVICE_ID: 0x3001,
+ }
+
+ def reg_read(self, addr: int) -> int:
+ val = self.regs[addr]
+
+ if addr == REG_CONFIGURATION:
+ # Always indicate that the conversion is ready. This is good
+ # enough for our current purposes.
+ val |= REG_CONFIGURATION_CRF
+
+ return val
+
+ def reg_write(self, addr: int, val: int) -> None:
+ assert addr in self.regs
+ self.regs[addr] = val
+
+
+class TestOPT3001(UMLTestCase):
+ dts = DtFragment(
+ src="""
+&i2c {
+ light-sensor@$addr$ {
+ compatible = "ti,opt3001";
+ reg = <0x$addr$>;
+ };
+};
+ """,
+ variables={
+ "addr": DtVar.I2C_ADDR,
+ },
+ )
+
+ @classmethod
+ def setUpClass(cls) -> None:
+ insmod("opt3001")
+
+ @classmethod
+ def tearDownClass(cls) -> None:
+ rmmod("opt3001")
+
+ def setUp(self) -> None:
+ self.driver = I2CDriver("opt3001")
+ self.hw = Hardware("i2c")
+ self.hw.load_model(OPT3001)
+
+ def tearDown(self) -> None:
+ self.hw.close()
+
+ def test_illuminance(self) -> None:
+ data = [
+ # Some values from datasheet, and 0
+ (0b_0000_0000_0000_0000, 0),
+ (0b_0000_0000_0000_0001, 0.01),
+ (0b_0011_0100_0101_0110, 88.80),
+ (0b_0111_1000_1001_1010, 2818.56),
+ ]
+ with self.driver.bind(self.dts["addr"]) as dev:
+ luxfile = dev.path / "iio:device0/in_illuminance_input"
+
+ for regval, lux in data:
+ self.hw.reg_write(REG_RESULT, regval)
+ self.assertEqual(read_float(luxfile), lux)
--
2.34.1
Add the bulk of the roadtest framework. Apart from one init shell
script, this is written in Python and includes three closely-related
parts:
- The test runner which is invoked from the command line by the user
and which starts the backend and sends the test jobs and results
to/from UML.
- Test support code which is used by the actual driver tests run inside
UML and which interact with the backend via a file-based asynchronous
communication method.
- The backend which is run by the Python interpreter embedded in the C
backend. This part runs the hardware models and is controlled by the
tests and the driver (via virtio in the C backend).
Some unit tests for the framework itself are included and these will be
automatically run whenever the driver tests are run.
Signed-off-by: Vincent Whitchurch <[email protected]>
---
tools/testing/roadtest/init.sh | 19 ++
tools/testing/roadtest/roadtest/__init__.py | 2 +
.../roadtest/roadtest/backend/__init__.py | 0
.../roadtest/roadtest/backend/backend.py | 32 ++
.../testing/roadtest/roadtest/backend/gpio.py | 111 +++++++
.../testing/roadtest/roadtest/backend/i2c.py | 123 ++++++++
.../testing/roadtest/roadtest/backend/main.py | 13 +
.../testing/roadtest/roadtest/backend/mock.py | 20 ++
.../roadtest/roadtest/backend/test_gpio.py | 98 ++++++
.../roadtest/roadtest/backend/test_i2c.py | 84 +++++
.../testing/roadtest/roadtest/cmd/__init__.py | 0
tools/testing/roadtest/roadtest/cmd/main.py | 146 +++++++++
tools/testing/roadtest/roadtest/cmd/remote.py | 48 +++
.../roadtest/roadtest/core/__init__.py | 0
.../testing/roadtest/roadtest/core/control.py | 52 ++++
.../roadtest/roadtest/core/devicetree.py | 155 ++++++++++
.../roadtest/roadtest/core/hardware.py | 94 ++++++
tools/testing/roadtest/roadtest/core/log.py | 42 +++
.../testing/roadtest/roadtest/core/modules.py | 38 +++
.../testing/roadtest/roadtest/core/opslog.py | 35 +++
tools/testing/roadtest/roadtest/core/proxy.py | 48 +++
tools/testing/roadtest/roadtest/core/suite.py | 286 ++++++++++++++++++
tools/testing/roadtest/roadtest/core/sysfs.py | 77 +++++
.../roadtest/roadtest/core/test_control.py | 35 +++
.../roadtest/roadtest/core/test_devicetree.py | 31 ++
.../roadtest/roadtest/core/test_hardware.py | 41 +++
.../roadtest/roadtest/core/test_log.py | 54 ++++
.../roadtest/roadtest/core/test_opslog.py | 27 ++
.../roadtest/roadtest/tests/__init__.py | 0
29 files changed, 1711 insertions(+)
create mode 100755 tools/testing/roadtest/init.sh
create mode 100644 tools/testing/roadtest/roadtest/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/backend/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/backend/backend.py
create mode 100644 tools/testing/roadtest/roadtest/backend/gpio.py
create mode 100644 tools/testing/roadtest/roadtest/backend/i2c.py
create mode 100644 tools/testing/roadtest/roadtest/backend/main.py
create mode 100644 tools/testing/roadtest/roadtest/backend/mock.py
create mode 100644 tools/testing/roadtest/roadtest/backend/test_gpio.py
create mode 100644 tools/testing/roadtest/roadtest/backend/test_i2c.py
create mode 100644 tools/testing/roadtest/roadtest/cmd/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/cmd/main.py
create mode 100644 tools/testing/roadtest/roadtest/cmd/remote.py
create mode 100644 tools/testing/roadtest/roadtest/core/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/core/control.py
create mode 100644 tools/testing/roadtest/roadtest/core/devicetree.py
create mode 100644 tools/testing/roadtest/roadtest/core/hardware.py
create mode 100644 tools/testing/roadtest/roadtest/core/log.py
create mode 100644 tools/testing/roadtest/roadtest/core/modules.py
create mode 100644 tools/testing/roadtest/roadtest/core/opslog.py
create mode 100644 tools/testing/roadtest/roadtest/core/proxy.py
create mode 100644 tools/testing/roadtest/roadtest/core/suite.py
create mode 100644 tools/testing/roadtest/roadtest/core/sysfs.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_control.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_devicetree.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_hardware.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_log.py
create mode 100644 tools/testing/roadtest/roadtest/core/test_opslog.py
create mode 100644 tools/testing/roadtest/roadtest/tests/__init__.py
diff --git a/tools/testing/roadtest/init.sh b/tools/testing/roadtest/init.sh
new file mode 100755
index 000000000000..c5fb28478aa3
--- /dev/null
+++ b/tools/testing/roadtest/init.sh
@@ -0,0 +1,19 @@
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0-only
+
+mount -t proc proc /proc
+echo 8 > /proc/sys/kernel/printk
+mount -t sysfs nodev /sys
+mount -t debugfs nodev /sys/kernel/debug
+
+echo 0 > /sys/bus/i2c/drivers_autoprobe
+echo 0 > /sys/bus/platform/drivers_autoprobe
+
+python3 -m roadtest.cmd.remote
+status=$?
+[ "${ROADTEST_SHELL}" = "1" ] || {
+ # rsync doesn't handle these zero-sized files correctly.
+ cp -ra --no-preserve=ownership /sys/kernel/debug/gcov ${ROADTEST_WORK_DIR}/gcov
+ echo o > /proc/sysrq-trigger
+}
+exec setsid sh -c 'exec bash </dev/tty0 >/dev/tty0 2>&1'
diff --git a/tools/testing/roadtest/roadtest/__init__.py b/tools/testing/roadtest/roadtest/__init__.py
new file mode 100644
index 000000000000..dac3ce6976e5
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/__init__.py
@@ -0,0 +1,2 @@
+ENV_WORK_DIR = "ROADTEST_WORK_DIR"
+ENV_BUILD_DIR = "ROADTEST_BUILD_DIR"
diff --git a/tools/testing/roadtest/roadtest/backend/__init__.py b/tools/testing/roadtest/roadtest/backend/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/tools/testing/roadtest/roadtest/backend/backend.py b/tools/testing/roadtest/roadtest/backend/backend.py
new file mode 100644
index 000000000000..bfd19fc363c2
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/backend/backend.py
@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import logging
+import os
+from pathlib import Path
+
+from roadtest import ENV_WORK_DIR
+from roadtest.core.control import ControlReader
+
+from . import gpio, i2c, mock
+
+logger = logging.getLogger(__name__)
+
+try:
+ import cbackend # type: ignore[import]
+except ModuleNotFoundError:
+ # In unit tests
+ cbackend = None
+
+
+class Backend:
+ def __init__(self) -> None:
+ work = Path(os.environ[ENV_WORK_DIR])
+ self.control = ControlReader(work_dir=work)
+ self.c = cbackend
+ self.i2c = i2c.I2CBackend(self)
+ self.gpio = gpio.GpioBackend(self)
+ self.mock = mock.MockBackend(work)
+
+ def process_control(self) -> None:
+ self.control.process({"backend": self})
diff --git a/tools/testing/roadtest/roadtest/backend/gpio.py b/tools/testing/roadtest/roadtest/backend/gpio.py
new file mode 100644
index 000000000000..2eaf52b31c72
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/backend/gpio.py
@@ -0,0 +1,111 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import logging
+import typing
+from typing import Optional
+
+if typing.TYPE_CHECKING:
+ # Avoid circular imports
+ from .backend import Backend
+
+logger = logging.getLogger(__name__)
+
+
+class Gpio:
+ IRQ_TYPE_NONE = 0x00
+ IRQ_TYPE_EDGE_RISING = 0x01
+ IRQ_TYPE_EDGE_FALLING = 0x02
+ IRQ_TYPE_EDGE_BOTH = 0x03
+ IRQ_TYPE_LEVEL_HIGH = 0x04
+ IRQ_TYPE_LEVEL_LOW = 0x08
+
+ def __init__(self, backend: "Backend", pin: int):
+ self.backend = backend
+ self.pin = pin
+ self.state = False
+ self.irq_type = Gpio.IRQ_TYPE_NONE
+ self.masked = True
+ self.edge_irq_latched = False
+
+ def _level_irq_active(self) -> bool:
+ if self.irq_type == Gpio.IRQ_TYPE_LEVEL_HIGH:
+ return self.state
+ elif self.irq_type == Gpio.IRQ_TYPE_LEVEL_LOW:
+ return not self.state
+
+ return False
+
+ def _latch_edge_irq(self, old: bool, new: bool) -> bool:
+ if old != new:
+ logger.debug(f"{self}: latch_edge_irq {self.irq_type} {old} -> {new}")
+
+ if self.irq_type == Gpio.IRQ_TYPE_EDGE_RISING:
+ return not old and new
+ elif self.irq_type == Gpio.IRQ_TYPE_EDGE_FALLING:
+ return old and not new
+ elif self.irq_type == Gpio.IRQ_TYPE_EDGE_BOTH:
+ return old != new
+
+ return False
+
+ def _check_irq(self) -> None:
+ if self.irq_type == Gpio.IRQ_TYPE_NONE or self.masked:
+ return
+ if not self.edge_irq_latched and not self._level_irq_active():
+ return
+
+ self.masked = True
+ self.edge_irq_latched = False
+
+ logger.debug(f"{self}: trigger irq")
+ self.backend.c.trigger_gpio_irq(self.pin)
+
+ def set_irq_type(self, irq_type: int) -> None:
+ logger.debug(f"{self}: set_irq_type {irq_type}")
+ if irq_type == Gpio.IRQ_TYPE_NONE:
+ self.masked = True
+
+ self.irq_type = irq_type
+ self.edge_irq_latched = False
+ self._check_irq()
+
+ def unmask(self) -> None:
+ logger.debug(f"{self}: unmask")
+ self.masked = False
+ self._check_irq()
+
+ def set(self, val: int) -> None:
+ old = self.state
+ new = bool(val)
+
+ if old != new:
+ logger.debug(f"{self}: gpio set {old} -> {new}")
+
+ self.state = new
+ if self._latch_edge_irq(old, new):
+ logger.debug(f"{self}: latching edge")
+ self.edge_irq_latched = True
+
+ self._check_irq()
+
+ def __str__(self) -> str:
+ return f"Gpio({self.pin})"
+
+
+class GpioBackend:
+ def __init__(self, backend: "Backend") -> None:
+ self.backend = backend
+ self.gpios = [Gpio(backend, pin) for pin in range(64)]
+
+ def set(self, pin: Optional[int], val: bool) -> None:
+ if pin is None:
+ return
+
+ self.gpios[pin].set(val)
+
+ def set_irq_type(self, pin: int, irq_type: int) -> None:
+ self.gpios[pin].set_irq_type(irq_type)
+
+ def unmask(self, pin: int) -> None:
+ self.gpios[pin].unmask()
diff --git a/tools/testing/roadtest/roadtest/backend/i2c.py b/tools/testing/roadtest/roadtest/backend/i2c.py
new file mode 100644
index 000000000000..b877c2b76851
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/backend/i2c.py
@@ -0,0 +1,123 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import abc
+import importlib
+import logging
+import typing
+from typing import Any, Literal, Optional
+
+if typing.TYPE_CHECKING:
+ # Avoid circular imports
+ from .backend import Backend
+
+logger = logging.getLogger(__name__)
+
+
+class I2CBackend:
+ def __init__(self, backend: "Backend") -> None:
+ self.model: Optional[I2CModel] = None
+ self.backend = backend
+
+ def load_model(self, modname: str, clsname: str, *args: Any, **kwargs: Any) -> None:
+ mod = importlib.import_module(modname)
+ cls = getattr(mod, clsname)
+ self.model = cls(*args, **kwargs, backend=self.backend)
+
+ def unload_model(self) -> None:
+ self.model = None
+
+ def read(self, length: int) -> bytes:
+ if not self.model:
+ raise Exception("No I2C model loaded")
+
+ return self.model.read(length)
+
+ def write(self, data: bytes) -> None:
+ if not self.model:
+ raise Exception("No I2C model loaded")
+
+ self.model.write(data)
+
+ def __getattr__(self, name: str) -> Any:
+ return getattr(self.model, name)
+
+
+class I2CModel(abc.ABC):
+ def __init__(self, backend: "Backend") -> None:
+ self.backend = backend
+
+ @abc.abstractmethod
+ def read(self, length: int) -> bytes:
+ return bytes(length)
+
+ @abc.abstractmethod
+ def write(self, data: bytes) -> None:
+ pass
+
+
+class SMBusModel(I2CModel):
+ def __init__(
+ self,
+ regbytes: int,
+ byteorder: Literal["little", "big"] = "little",
+ *args: Any,
+ **kwargs: Any,
+ ) -> None:
+ super().__init__(*args, **kwargs)
+ self.reg_addr = 0x0
+ self.regbytes = regbytes
+ self.byteorder = byteorder
+
+ @abc.abstractmethod
+ def reg_read(self, addr: int) -> int:
+ return 0
+
+ @abc.abstractmethod
+ def reg_write(self, addr: int, val: int) -> None:
+ pass
+
+ def val_to_bytes(self, val: int) -> bytes:
+ return val.to_bytes(self.regbytes, self.byteorder)
+
+ def bytes_to_val(self, data: bytes) -> int:
+ return int.from_bytes(data, self.byteorder)
+
+ def read(self, length: int) -> bytes:
+ data = bytearray()
+ for idx in range(0, length, self.regbytes):
+ addr = self.reg_addr + idx
+ val = self.reg_read(addr)
+ logger.debug(f"SMBus read {addr=:#02x} {val=:#02x}")
+ data += self.val_to_bytes(val)
+ return bytes(data)
+
+ def write(self, data: bytes) -> None:
+ self.reg_addr = data[0]
+
+ if len(data) > 1:
+ length = len(data) - 1
+ data = data[1:]
+ assert length % self.regbytes == 0
+ for idx in range(0, length, self.regbytes):
+ val = self.bytes_to_val(data[idx : (idx + self.regbytes)])
+ addr = self.reg_addr + idx
+ self.backend.mock.reg_write(addr, val)
+ self.reg_write(addr, val)
+ logger.debug(f"SMBus write {addr=:#02x} {val=:#02x}")
+ elif len(data) == 1:
+ pass
+
+
+class SimpleSMBusModel(SMBusModel):
+ def __init__(self, regs: dict[int, int], **kwargs: Any) -> None:
+ super().__init__(**kwargs)
+ self.regs = regs
+
+ def reg_read(self, addr: int) -> int:
+ val = self.regs[addr]
+ return val
+
+ def reg_write(self, addr: int, val: int) -> None:
+ assert addr in self.regs
+ self.regs[addr] = val
diff --git a/tools/testing/roadtest/roadtest/backend/main.py b/tools/testing/roadtest/roadtest/backend/main.py
new file mode 100644
index 000000000000..25be86ded9ea
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/backend/main.py
@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import logging
+
+import roadtest.backend.backend
+
+logging.basicConfig(
+ format="%(asctime)s - %(levelname)s - %(name)s: %(message)s", level=logging.DEBUG
+)
+
+backend = roadtest.backend.backend.Backend()
+backend.process_control()
diff --git a/tools/testing/roadtest/roadtest/backend/mock.py b/tools/testing/roadtest/roadtest/backend/mock.py
new file mode 100644
index 000000000000..8ce33a6bc0f1
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/backend/mock.py
@@ -0,0 +1,20 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import functools
+from pathlib import Path
+from typing import Any, Callable
+
+from roadtest.core.opslog import OpsLogWriter
+
+
+class MockBackend:
+ def __init__(self, work: Path) -> None:
+ self.opslog = OpsLogWriter(work)
+
+ @functools.cache
+ def __getattr__(self, name: str) -> Callable:
+ def func(*args: Any, **kwargs: Any) -> None:
+ self.opslog.write(f"mock.{name}(*{str(args)}, **{str(kwargs)})")
+
+ return func
diff --git a/tools/testing/roadtest/roadtest/backend/test_gpio.py b/tools/testing/roadtest/roadtest/backend/test_gpio.py
new file mode 100644
index 000000000000..feffe4fb9625
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/backend/test_gpio.py
@@ -0,0 +1,98 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import unittest
+from unittest.mock import MagicMock
+
+from .gpio import Gpio
+
+
+class TestGpio(unittest.TestCase):
+ def test_irq_low(self) -> None:
+ m = MagicMock()
+ gpio = Gpio(backend=m, pin=1)
+
+ gpio.set_irq_type(Gpio.IRQ_TYPE_LEVEL_LOW)
+ m.c.trigger_gpio_irq.assert_not_called()
+
+ gpio.unmask()
+ m.c.trigger_gpio_irq.assert_called_once_with(1)
+ m.c.trigger_gpio_irq.reset_mock()
+
+ gpio.set(True)
+ gpio.unmask()
+ m.c.trigger_gpio_irq.assert_not_called()
+
+ def test_irq_high(self) -> None:
+ m = MagicMock()
+ gpio = Gpio(backend=m, pin=2)
+
+ gpio.set_irq_type(Gpio.IRQ_TYPE_LEVEL_HIGH)
+ gpio.unmask()
+
+ m.c.trigger_gpio_irq.assert_not_called()
+
+ gpio.set(True)
+ m.c.trigger_gpio_irq.assert_called_once_with(2)
+ m.c.trigger_gpio_irq.reset_mock()
+
+ gpio.set(False)
+ gpio.unmask()
+ m.c.trigger_gpio_irq.assert_not_called()
+
+ def test_irq_rising(self) -> None:
+ m = MagicMock()
+ gpio = Gpio(backend=m, pin=63)
+
+ gpio.set_irq_type(Gpio.IRQ_TYPE_EDGE_RISING)
+ gpio.set(False)
+ gpio.set(True)
+
+ m.c.trigger_gpio_irq.assert_not_called()
+ gpio.unmask()
+ m.c.trigger_gpio_irq.assert_called_once_with(63)
+ m.c.trigger_gpio_irq.reset_mock()
+
+ gpio.set(False)
+ gpio.set(True)
+
+ gpio.unmask()
+ m.c.trigger_gpio_irq.assert_called_once()
+
+ def test_irq_falling(self) -> None:
+ m = MagicMock()
+ gpio = Gpio(backend=m, pin=0)
+
+ gpio.set_irq_type(Gpio.IRQ_TYPE_EDGE_FALLING)
+ gpio.unmask()
+ gpio.set(False)
+ gpio.set(True)
+ m.c.trigger_gpio_irq.assert_not_called()
+
+ gpio.set(False)
+ m.c.trigger_gpio_irq.assert_called_once_with(0)
+ m.c.trigger_gpio_irq.reset_mock()
+
+ gpio.set(True)
+ gpio.set(False)
+ gpio.set(True)
+ gpio.unmask()
+ m.c.trigger_gpio_irq.assert_called_once()
+
+ def test_irq_both(self) -> None:
+ m = MagicMock()
+ gpio = Gpio(backend=m, pin=32)
+
+ gpio.set_irq_type(Gpio.IRQ_TYPE_EDGE_BOTH)
+ gpio.unmask()
+ gpio.set(False)
+ gpio.set(True)
+ m.c.trigger_gpio_irq.assert_called_once_with(32)
+
+ gpio.set(False)
+ m.c.trigger_gpio_irq.assert_called_once_with(32)
+ m.c.trigger_gpio_irq.reset_mock()
+
+ gpio.set(True)
+ gpio.unmask()
+ m.c.trigger_gpio_irq.assert_called_once_with(32)
diff --git a/tools/testing/roadtest/roadtest/backend/test_i2c.py b/tools/testing/roadtest/roadtest/backend/test_i2c.py
new file mode 100644
index 000000000000..eda4e1a4b80f
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/backend/test_i2c.py
@@ -0,0 +1,84 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import unittest
+from typing import Any
+from unittest.mock import MagicMock
+
+from .i2c import SimpleSMBusModel, SMBusModel
+
+
+class DummyModel(SMBusModel):
+ def __init__(self, *args: Any, **kwargs: Any) -> None:
+ super().__init__(*args, **kwargs)
+ self.regs: dict[int, int] = {}
+
+ def reg_read(self, addr: int) -> int:
+ return self.regs[addr]
+
+ def reg_write(self, addr: int, val: int) -> None:
+ self.regs[addr] = val
+
+
+class TestSMBusModel(unittest.TestCase):
+ def test_1(self) -> None:
+ m = DummyModel(regbytes=1, backend=MagicMock())
+
+ m.write(bytes([0x12, 0x34]))
+ m.write(bytes([0x13, 0xAB, 0xCD]))
+
+ self.assertEqual(m.regs[0x12], 0x34)
+ self.assertEqual(m.regs[0x13], 0xAB)
+ self.assertEqual(m.regs[0x14], 0xCD)
+
+ m.write(bytes([0x12]))
+ self.assertEqual(m.read(1), bytes([0x34]))
+
+ m.write(bytes([0x12]))
+ self.assertEqual(m.read(3), bytes([0x34, 0xAB, 0xCD]))
+
+ def test_2big(self) -> None:
+ m = DummyModel(regbytes=2, byteorder="big", backend=MagicMock())
+
+ m.write(bytes([0x12, 0x34, 0x56, 0xAB, 0xCD]))
+ self.assertEqual(m.regs[0x12], 0x3456)
+ self.assertEqual(m.regs[0x14], 0xABCD)
+
+ m.write(bytes([0x12]))
+ self.assertEqual(m.read(2), bytes([0x34, 0x56]))
+
+ m.write(bytes([0x14]))
+ self.assertEqual(m.read(2), bytes([0xAB, 0xCD]))
+
+ m.write(bytes([0x12]))
+ self.assertEqual(m.read(4), bytes([0x34, 0x56, 0xAB, 0xCD]))
+
+ def test_2little(self) -> None:
+ m = DummyModel(regbytes=2, byteorder="little", backend=MagicMock())
+
+ m.write(bytes([0x12, 0x34, 0x56, 0xAB, 0xCD]))
+ self.assertEqual(m.regs[0x12], 0x5634)
+ self.assertEqual(m.regs[0x14], 0xCDAB)
+
+ m.write(bytes([0x12]))
+ self.assertEqual(m.read(2), bytes([0x34, 0x56]))
+
+
+class TestSimpleSMBusModel(unittest.TestCase):
+ def test_simple(self) -> None:
+ m = SimpleSMBusModel(
+ regs={0x01: 0x12, 0x02: 0x34},
+ regbytes=1,
+ backend=MagicMock(),
+ )
+ self.assertEqual(m.reg_read(0x01), 0x12)
+ self.assertEqual(m.reg_read(0x02), 0x34)
+
+ m.reg_write(0x01, 0x56)
+ self.assertEqual(m.reg_read(0x01), 0x56)
+ self.assertEqual(m.reg_read(0x02), 0x34)
+
+ with self.assertRaises(Exception):
+ m.reg_write(0x03, 0x00)
+ with self.assertRaises(Exception):
+ m.reg_read(0x03)
diff --git a/tools/testing/roadtest/roadtest/cmd/__init__.py b/tools/testing/roadtest/roadtest/cmd/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/tools/testing/roadtest/roadtest/cmd/main.py b/tools/testing/roadtest/roadtest/cmd/main.py
new file mode 100644
index 000000000000..634c27fe795c
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/cmd/main.py
@@ -0,0 +1,146 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import argparse
+import fnmatch
+import sys
+import unittest
+from typing import Optional
+from unittest.suite import TestSuite
+
+assert sys.version_info >= (3, 9), "Python version is too old"
+
+from roadtest.core.suite import UMLSuite, UMLTestCase
+
+
+def make_umlsuite(args: argparse.Namespace) -> UMLSuite:
+ return UMLSuite(
+ timeout=args.timeout,
+ workdir=args.work_dir,
+ builddir=args.build_dir,
+ ksrcdir=args.ksrc_dir,
+ uml_args_pre=args.uml_prepend,
+ uml_args_post=args.uml_append,
+ shell=args.shell,
+ )
+
+
+def main() -> None:
+ parser = argparse.ArgumentParser()
+ parser.add_argument(
+ "--timeout",
+ type=int,
+ default=60,
+ help="Timeout (in seconds) for each UML run, 0 to disable",
+ )
+ parser.add_argument("--work-dir", type=str, help="Work directory for UML runs")
+ parser.add_argument("--build-dir", type=str, required=True)
+ parser.add_argument("--ksrc-dir", type=str, required=True)
+ parser.add_argument(
+ "--uml-prepend",
+ nargs="*",
+ default=[],
+ help="Extra arguments to prepend to the UML command (example: gdbserver :1234)",
+ )
+ parser.add_argument(
+ "--uml-append",
+ nargs="*",
+ default=[],
+ help="Extra arguments to append to the UML command (example: trace_event=i2c:* tp_printk)",
+ )
+ parser.add_argument(
+ "--filter",
+ nargs="+",
+ default=[],
+ )
+ parser.add_argument("--shell", action="store_true")
+ parser.add_argument("test", nargs="?", default="roadtest")
+ args = parser.parse_args()
+
+ if args.shell:
+ args.timeout = 0
+
+ if not any(p.startswith("con=") for p in args.uml_append):
+ print(
+ "Error: --shell used but no con= UML argument specified",
+ file=sys.stderr,
+ )
+ sys.exit(1)
+
+ test = args.test
+ test = test.replace("/", ".")
+ test = test.removesuffix(".py")
+ test = test.removesuffix(".")
+
+ loader = unittest.defaultTestLoader
+ suitegroups = loader.discover(test)
+
+ args.filter = [f"*{f}*" for f in args.filter]
+
+ # Backend tests and the like don't need to be run inside UML.
+ localsuite = None
+
+ # For simplicity, we currently run all target tests in one UML instance
+ # since python in UML is slow to start up. This can be revisited if we
+ # want to run several UML instances in parallel.
+ deftargetsuite = None
+ targetsuites = []
+
+ for suites in suitegroups:
+ # unittest can in arbitrarily nest and mix TestCases
+ # and TestSuites, but we expect a fixed hierarchy.
+ assert isinstance(suites, unittest.TestSuite)
+
+ for suite in suites:
+ # assert not isinstance(suite, unittest.TestCase)
+
+ # If the import of a test fails, then suite is a
+ # unittest.loader._FailedTest instead of a suite
+ if not isinstance(suite, unittest.TestSuite):
+ suite = [suite] # type: ignore[assignment]
+
+ # Suite at this level contains one TestCase for each
+ # test method in a particular test class.
+ #
+ # All the test functions for one particular test class
+ # can only be run either in UML or locally, not mixed.
+ destsuite: Optional[TestSuite] = None
+
+ for t in suite: # type: ignore[union-attr]
+ # We don't support suites nested at this level.
+ assert isinstance(t, unittest.TestCase)
+
+ id = t.id()
+ if args.filter and not any(fnmatch.fnmatch(id, f) for f in args.filter):
+ continue
+
+ if isinstance(t, UMLTestCase):
+ if t.run_separately:
+ if not destsuite:
+ destsuite = make_umlsuite(args)
+ targetsuites.append(destsuite)
+ else:
+ if not deftargetsuite:
+ deftargetsuite = make_umlsuite(args)
+ targetsuites.append(deftargetsuite)
+
+ destsuite = deftargetsuite
+ else:
+ if not localsuite:
+ localsuite = TestSuite()
+ destsuite = localsuite
+
+ if destsuite:
+ destsuite.addTest(t)
+
+ tests = unittest.TestSuite()
+ if localsuite:
+ tests.addTest(localsuite)
+ tests.addTests(targetsuites)
+
+ result = unittest.TextTestRunner(verbosity=2).run(tests)
+ sys.exit(not result.wasSuccessful())
+
+
+if __name__ == "__main__":
+ main()
diff --git a/tools/testing/roadtest/roadtest/cmd/remote.py b/tools/testing/roadtest/roadtest/cmd/remote.py
new file mode 100644
index 000000000000..29c3c6d35c65
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/cmd/remote.py
@@ -0,0 +1,48 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import importlib
+import json
+import os
+from pathlib import Path
+from typing import cast
+from unittest import TestSuite, TextTestRunner
+
+from roadtest import ENV_WORK_DIR
+from roadtest.core import proxy
+
+
+def main() -> None:
+ workdir = Path(os.environ[ENV_WORK_DIR])
+ with open(workdir / "tests.json") as f:
+ testinfos = json.load(f)
+
+ suite = TestSuite()
+ for info in testinfos:
+ id = info["id"]
+ *modparts, clsname, method = id.split(".")
+
+ fullname = ".".join(modparts)
+ mod = importlib.import_module(fullname)
+
+ cls = getattr(mod, clsname)
+ test = cls(methodName=method)
+
+ values = info["values"]
+ if values:
+ test.dts.values = values
+
+ suite.addTest(test)
+
+ runner = TextTestRunner(
+ verbosity=0, buffer=False, resultclass=proxy.ProxyTextTestResult
+ )
+ result = cast(proxy.ProxyTextTestResult, runner.run(suite))
+
+ proxyresult = result.to_proxy()
+ with open(workdir / "results.json", "w") as f:
+ json.dump(proxyresult, f)
+
+
+if __name__ == "__main__":
+ main()
diff --git a/tools/testing/roadtest/roadtest/core/__init__.py b/tools/testing/roadtest/roadtest/core/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/tools/testing/roadtest/roadtest/core/control.py b/tools/testing/roadtest/roadtest/core/control.py
new file mode 100644
index 000000000000..cd74861099b9
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/control.py
@@ -0,0 +1,52 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import logging
+import os
+from pathlib import Path
+from typing import Optional
+
+from roadtest import ENV_WORK_DIR
+
+CONTROL_FILE = "control.txt"
+
+logger = logging.getLogger(__name__)
+
+
+class ControlReader:
+ def __init__(self, work_dir: Optional[Path] = None) -> None:
+ if not work_dir:
+ work_dir = Path(os.environ[ENV_WORK_DIR])
+
+ path = work_dir / CONTROL_FILE
+ path.unlink(missing_ok=True)
+ path.write_text("")
+
+ self.file = path.open("r")
+
+ def process(self, vars: dict) -> None:
+ for line in self.file.readlines():
+ cmd = line.rstrip()
+
+ if cmd.startswith("# "):
+ logger.info(line[2:].rstrip())
+ continue
+
+ logger.debug(cmd)
+ eval(cmd, vars)
+
+
+class ControlWriter:
+ def __init__(self, work_dir: Optional[Path] = None) -> None:
+ if not work_dir:
+ work_dir = Path(os.environ[ENV_WORK_DIR])
+ self.file = (work_dir / CONTROL_FILE).open("a", buffering=1)
+
+ def write_cmd(self, line: str) -> None:
+ self.file.write(line + "\n")
+
+ def write_log(self, line: str) -> None:
+ self.file.write(f"# {line}\n")
+
+ def close(self) -> None:
+ self.file.close()
diff --git a/tools/testing/roadtest/roadtest/core/devicetree.py b/tools/testing/roadtest/roadtest/core/devicetree.py
new file mode 100644
index 000000000000..40876738fb39
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/devicetree.py
@@ -0,0 +1,155 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import enum
+import subprocess
+from pathlib import Path
+from typing import Any, Optional
+
+HEADER = """
+/dts-v1/;
+
+/ {
+ #address-cells = <2>;
+ #size-cells = <2>;
+
+ virtio@0 {
+ compatible = "virtio,uml";
+ socket-path = "WORK/gpio.sock";
+ virtio-device-id = <0x29>;
+
+ gpio: gpio {
+ compatible = "virtio,device29";
+
+ gpio-controller;
+ #gpio-cells = <2>;
+
+ interrupt-controller;
+ #interrupt-cells = <2>;
+ };
+ };
+
+ virtio@1 {
+ compatible = "virtio,uml";
+ socket-path = "WORK/i2c.sock";
+ virtio-device-id = <0x22>;
+
+ i2c: i2c {
+ compatible = "virtio,device22";
+
+ #address-cells = <1>;
+ #size-cells = <0>;
+ };
+ };
+
+ // See Hardware.kick()
+ leds {
+ compatible = "gpio-leds";
+ led0 {
+ gpios = <&gpio 0 0>;
+ };
+ };
+};
+"""
+
+
+class DtVar(enum.Enum):
+ I2C_ADDR = 0
+ GPIO_PIN = 1
+
+
+class DtFragment:
+ def __init__(self, src: str, variables: Optional[dict[str, DtVar]] = None) -> None:
+ self.src = src
+ if not variables:
+ variables = {}
+ self.variables = variables
+ self.values: dict[str, int] = {}
+
+ def apply(self, values: dict[str, Any]) -> str:
+ src = self.src
+
+ for var in self.variables.keys():
+ typ = self.variables[var]
+ val = values[var]
+
+ if typ == DtVar.I2C_ADDR:
+ str = f"{val:02x}"
+ elif typ == DtVar.GPIO_PIN:
+ str = f"{val:d}"
+
+ src = src.replace(f"${var}$", str)
+
+ self.values = values
+ return src
+
+ def __getitem__(self, key: str) -> Any:
+ return self.values[key]
+
+
+class Devicetree:
+ def __init__(self, workdir: Path, ksrcdir: Path) -> None:
+ self.workdir: Path = workdir
+ self.ksrcdir: Path = ksrcdir
+ self.next_i2c_addr: int = 0x1
+ # 0 is used for gpio-leds for Hardware.kick()
+ self.next_gpio_pin: int = 1
+ self.src: str = ""
+
+ def assemble(self, fragments: list[DtFragment]) -> None:
+ parts = []
+ for fragment in fragments:
+ if fragment.values:
+ # Multiple test functions from the same class will use
+ # the same class instance
+ continue
+
+ values = {}
+
+ for var, type in fragment.variables.items():
+ if type == DtVar.I2C_ADDR:
+ values[var] = self.next_i2c_addr
+ self.next_i2c_addr += 1
+ elif type == DtVar.GPIO_PIN:
+ values[var] = self.next_gpio_pin
+ self.next_gpio_pin += 1
+
+ parts.append(fragment.apply(values))
+
+ self.src = "\n".join(parts)
+
+ def compile(self, dtb: str) -> None:
+ dts = self.workdir / "test.dts"
+
+ try:
+ subprocess.run(
+ [
+ "gcc",
+ "-E",
+ "-nostdinc",
+ f"-I{self.ksrcdir}/scripts/dtc/include-prefixes",
+ "-undef",
+ "-D__DTS__",
+ "-x",
+ "assembler-with-cpp",
+ "-o",
+ dts,
+ "-",
+ ],
+ input=self.src,
+ text=True,
+ check=True,
+ capture_output=True,
+ )
+
+ full = HEADER.replace("WORK", str(self.workdir)) + dts.read_text()
+ dts.write_text(full)
+
+ subprocess.run(
+ ["dtc", "-I", "dts", "-O", "dtb", dts, "-o", self.workdir / dtb],
+ check=True,
+ capture_output=True,
+ text=True,
+ )
+ except subprocess.CalledProcessError as e:
+ raise Exception(f"{e.stderr}")
diff --git a/tools/testing/roadtest/roadtest/core/hardware.py b/tools/testing/roadtest/roadtest/core/hardware.py
new file mode 100644
index 000000000000..ae81a531d2a2
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/hardware.py
@@ -0,0 +1,94 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import contextlib
+import functools
+import os
+from pathlib import Path
+from typing import Any, Callable, Optional, Type, cast
+from unittest import TestCase
+from unittest.mock import MagicMock, call
+
+from roadtest import ENV_WORK_DIR
+
+from .control import ControlWriter
+from .opslog import OpsLogReader
+from .sysfs import write_int
+
+
+class HwMock(MagicMock):
+ def assert_reg_write_once(self, test: TestCase, reg: int, value: int) -> None:
+ test.assertEqual(
+ [c for c in self.mock_calls if c.args[0] == reg],
+ [call.reg_write(reg, value)],
+ )
+
+ def assert_last_reg_write(self, test: TestCase, reg: int, value: int) -> None:
+ test.assertEqual(
+ [c for c in self.mock_calls if c.args[0] == reg][-1:],
+ [call.reg_write(reg, value)],
+ )
+
+ def get_last_reg_write(self, reg: int) -> int:
+ return cast(int, [c for c in self.mock_calls if c.args[0] == reg][-1].args[1])
+
+
+class Hardware(contextlib.AbstractContextManager):
+ def __init__(self, bus: str, work: Optional[Path] = None) -> None:
+ if not work:
+ work = Path(os.environ[ENV_WORK_DIR])
+
+ self.bus = bus
+ self.mock = HwMock()
+ self.control = ControlWriter(work)
+ self.opslog = OpsLogReader(work)
+ self.loaded_model = False
+
+ # Ignore old entries
+ self.opslog.read_next()
+
+ def _call(self, method: str, *args: Any, **kwargs: Any) -> None:
+ self.control.write_cmd(
+ f"backend.{self.bus}.{method}(*{str(args)}, **{str(kwargs)})"
+ )
+
+ def kick(self) -> None:
+ # Control writes are only applied when the backend gets something
+ # to process, usually because the driver tried to access the device.
+ # But in some cases, such as when the driver is waiting for a
+ # sequence of interrupts, the test code needs the control write to take
+ # effect immediately. For this, we just need to kick the backend
+ # into processing its control queue.
+ #
+ # We (ab)use gpio-leds for this. devicetree.py sets up the device.
+ write_int(Path("/sys/class/leds/led0/brightness"), 0)
+
+ def load_model(self, cls: Type[Any], *args: Any, **kwargs: Any) -> "Hardware":
+ self._call("load_model", cls.__module__, cls.__name__, *args, **kwargs)
+ self.loaded_model = True
+ return self
+
+ def __enter__(self) -> "Hardware":
+ return self
+
+ def __exit__(self, *_: Any) -> None:
+ self.close()
+
+ @functools.cache
+ def __getattr__(self, name: str) -> Callable:
+ def func(*args: Any, **kwargs: Any) -> None:
+ self._call(name, *args, **kwargs)
+
+ return func
+
+ def close(self) -> None:
+ if self.loaded_model:
+ self._call("unload_model")
+ self.control.close()
+
+ def update_mock(self) -> HwMock:
+ opslog = self.opslog.read_next()
+ for line in opslog:
+ eval(line, {"mock": self.mock})
+
+ return self.mock
diff --git a/tools/testing/roadtest/roadtest/core/log.py b/tools/testing/roadtest/roadtest/core/log.py
new file mode 100644
index 000000000000..7d73e40eb2d8
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/log.py
@@ -0,0 +1,42 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+from pathlib import Path
+
+
+class LogParser:
+ DNF_MESSAGE = "<Test did not finish cleanly>"
+
+ def __init__(self, file: Path):
+ try:
+ raw = file.read_text()
+ lines = raw.splitlines()
+ except FileNotFoundError:
+ lines = []
+ raw = ""
+
+ self.raw = raw
+ self.lines = lines
+
+ def has_any(self) -> bool:
+ return "START<" in self.raw
+
+ def get_testcase_log(self, id: str) -> list[str]:
+ startmarker = f"START<{id}>"
+ stopmarker = f"STOP<{id}>"
+
+ try:
+ startpos = next(
+ i for i, line in enumerate(self.lines) if startmarker in line
+ )
+ except StopIteration:
+ return []
+
+ try:
+ stoppos = next(
+ i for i, line in enumerate(self.lines[startpos:]) if stopmarker in line
+ )
+ except StopIteration:
+ return self.lines[startpos + 1 :] + [LogParser.DNF_MESSAGE]
+
+ return self.lines[startpos + 1 : startpos + stoppos]
diff --git a/tools/testing/roadtest/roadtest/core/modules.py b/tools/testing/roadtest/roadtest/core/modules.py
new file mode 100644
index 000000000000..5bd2d92a322b
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/modules.py
@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import os
+import subprocess
+from pathlib import Path
+from typing import Any
+
+from roadtest import ENV_BUILD_DIR
+
+
+def modprobe(modname: str, remove: bool = False) -> None:
+ moddir = Path(os.environ[ENV_BUILD_DIR]) / "modules"
+ args = []
+ if remove:
+ args.append("--remove")
+ args += [f"--dirname={moddir}", modname]
+ subprocess.check_output(["/sbin/modprobe"] + args)
+
+
+def insmod(modname: str) -> None:
+ modprobe(modname)
+
+
+def rmmod(modname: str) -> None:
+ subprocess.check_output(["/sbin/rmmod", modname])
+
+
+class Module:
+ def __init__(self, name: str) -> None:
+ self.name = name
+
+ def __enter__(self) -> "Module":
+ modprobe(self.name)
+ return self
+
+ def __exit__(self, *_: Any) -> None:
+ rmmod(self.name)
diff --git a/tools/testing/roadtest/roadtest/core/opslog.py b/tools/testing/roadtest/roadtest/core/opslog.py
new file mode 100644
index 000000000000..83bb4f525d03
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/opslog.py
@@ -0,0 +1,35 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import os
+from pathlib import Path
+
+OPSLOG_FILE = "opslog.txt"
+
+
+class OpsLogWriter:
+ def __init__(self, work: Path) -> None:
+ path = work / OPSLOG_FILE
+ path.unlink(missing_ok=True)
+ self.file = open(path, "a", buffering=1)
+
+ def write(self, line: str) -> None:
+ self.file.write(line + "\n")
+
+
+class OpsLogReader:
+ def __init__(self, work: Path) -> None:
+ self.path = work / OPSLOG_FILE
+ self.opslogpos = 0
+
+ def read_next(self) -> list[str]:
+ # There is a problem in hostfs (see Hostfs Caveats) which means
+ # that reads from UML on a file which is extended on the host don't see
+ # the new data unless we open and close the file, so we can't open once
+ # and use readlines().
+ with open(self.path, "r") as f:
+ os.lseek(f.fileno(), self.opslogpos, os.SEEK_SET)
+ opslog = [line.rstrip() for line in f.readlines()]
+ self.opslogpos = os.lseek(f.fileno(), 0, os.SEEK_CUR)
+
+ return opslog
diff --git a/tools/testing/roadtest/roadtest/core/proxy.py b/tools/testing/roadtest/roadtest/core/proxy.py
new file mode 100644
index 000000000000..36089e21d7d5
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/proxy.py
@@ -0,0 +1,48 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+from typing import Any
+from unittest import TestCase, TextTestResult
+
+from . import control
+
+
+class ProxyTextTestResult(TextTestResult):
+ def __init__(self, stream: Any, descriptions: Any, verbosity: Any) -> None:
+ super().__init__(stream, descriptions, verbosity)
+ self.successes: list[tuple[TestCase, str]] = []
+
+ # Print via kmsg to avoid getting cut off by other kernel prints.
+ self.kmsg = open("/dev/kmsg", "w", buffering=1)
+ self.control = control.ControlWriter()
+
+ def addSuccess(self, test: TestCase) -> None:
+ super().addSuccess(test)
+ self.successes.append((test, ""))
+
+ def _log(self, test: TestCase, action: str) -> None:
+ line = f"{action}<{test.id()}>"
+ self.kmsg.write(line + "\n")
+ self.control.write_log(line)
+
+ def startTest(self, test: TestCase) -> None:
+ self._log(test, "START")
+ super().startTest(test)
+
+ def stopTest(self, test: TestCase) -> None:
+ super().stopTest(test)
+ self._log(test, "STOP")
+
+ def _replace_id(self, reslist: list[tuple[TestCase, str]]) -> list[tuple[str, str]]:
+ return [(case.id(), tb) for case, tb in reslist]
+
+ def to_proxy(self) -> dict[str, Any]:
+ return {
+ "testsRun": self.testsRun,
+ "wasSuccessful": self.wasSuccessful(),
+ "successes": self._replace_id(self.successes),
+ "errors": self._replace_id(self.errors),
+ "failures": self._replace_id(self.failures),
+ "skipped": self._replace_id(self.skipped),
+ "unexpectedSuccesses": [t.id() for t in self.unexpectedSuccesses],
+ }
diff --git a/tools/testing/roadtest/roadtest/core/suite.py b/tools/testing/roadtest/roadtest/core/suite.py
new file mode 100644
index 000000000000..e99a60b4faba
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/suite.py
@@ -0,0 +1,286 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import json
+import os
+import shlex
+import signal
+import subprocess
+import textwrap
+import unittest
+from pathlib import Path
+from typing import Any, ClassVar, Optional, Tuple, cast
+from unittest import TestResult
+
+from roadtest import ENV_BUILD_DIR, ENV_WORK_DIR
+
+from . import devicetree
+from .log import LogParser
+
+
+class UMLTestCase(unittest.TestCase):
+ run_separately: ClassVar[bool] = False
+ dts: ClassVar[Optional[devicetree.DtFragment]] = None
+
+
+class UMLSuite(unittest.TestSuite):
+ def __init__(
+ self,
+ timeout: int,
+ workdir: str,
+ builddir: str,
+ ksrcdir: str,
+ uml_args_pre: list[str],
+ uml_args_post: list[str],
+ shell: bool,
+ *args: Any,
+ **kwargs: Any,
+ ) -> None:
+ super().__init__(*args, **kwargs)
+
+ self.timeout = timeout
+ self.workdir = Path(workdir).resolve()
+ self.builddir = Path(builddir)
+ self.ksrcdir = Path(ksrcdir)
+ self.uml_args_pre = uml_args_pre
+ self.uml_args_post = uml_args_post
+ self.shell = shell
+
+ self.backendlog = self.workdir / "backend.txt"
+ self.umllog = self.workdir / "uml.txt"
+
+ # Used from the roadtest.cmd.remote running inside UML
+ self.testfile = self.workdir / "tests.json"
+ self.resultfile = self.workdir / "results.json"
+
+ def run(
+ self, result: unittest.TestResult, debug: bool = False
+ ) -> unittest.TestResult:
+ pwd = os.getcwd()
+
+ os.makedirs(self.workdir, exist_ok=True)
+ workdir = self.workdir
+
+ tests = cast(list[UMLTestCase], list(self))
+
+ os.environ[ENV_WORK_DIR] = str(workdir)
+ os.environ[ENV_BUILD_DIR] = str(self.builddir)
+
+ dt = devicetree.Devicetree(workdir=workdir, ksrcdir=self.ksrcdir)
+ dt.assemble([test.dts for test in tests if test.dts])
+ dt.compile("test.dtb")
+
+ testinfos = []
+ ids = []
+ for t in tests:
+ id = t.id()
+ # This fixup is needed when discover is done starting from "roadtest"
+ if not id.startswith("roadtest."):
+ id = f"roadtest.{id}"
+ ids.append(id)
+
+ testinfos.append({"id": id, "values": t.dts.values if t.dts else {}})
+
+ with self.testfile.open("w") as f:
+ json.dump(testinfos, f)
+
+ uml_args = [
+ str(self.builddir / "vmlinux"),
+ f"PYTHONPATH={pwd}",
+ f"{ENV_WORK_DIR}={workdir}",
+ f"{ENV_BUILD_DIR}={self.builddir}",
+ # Should be enough for anybody?
+ "mem=64M",
+ "dtb=test.dtb",
+ "rootfstype=hostfs",
+ "rw",
+ f"init={pwd}/init.sh",
+ f"uml_dir={workdir}",
+ "umid=uml",
+ # ProxyTextTestResult writes to /dev/kmsg
+ "printk.devkmsg=on",
+ "slub_debug",
+ # For ease of debugging
+ "no_hash_pointers",
+ ]
+
+ if self.shell:
+ # See init.sh
+ uml_args += ["ROADTEST_SHELL=1"]
+ else:
+ # Set by slub_debug
+ TAINT_BAD_PAGE = 1 << 5
+ uml_args += [
+ # init.sh increases the loglevel after bootup.
+ "quiet",
+ "panic_on_warn=1",
+ f"panic_on_taint={TAINT_BAD_PAGE}",
+ "oops=panic",
+ # Speeds up delays, but as a consequence also causes
+ # 100% CPU consumption at an idle shell prompt.
+ "time-travel",
+ ]
+
+ main_script = (Path(__file__).parent / "../backend/main.py").resolve()
+
+ args = (
+ [
+ str(self.builddir / "roadtest-backend"),
+ # The socket locations are also present in the devicetree.
+ f"--gpio-socket={workdir}/gpio.sock",
+ f"--i2c-socket={workdir}/i2c.sock",
+ f"--main-script={main_script}",
+ "--",
+ ]
+ + self.uml_args_pre
+ + uml_args
+ + self.uml_args_post
+ )
+
+ print(
+ "Running backend/UML with: {}".format(
+ " ".join([shlex.quote(a) for a in args])
+ )
+ )
+
+ # Truncate instead of deleting so that tail -f can be used to monitor
+ # the log across runs.
+ self.backendlog.write_text("")
+ self.umllog.write_text("")
+ self.resultfile.unlink(missing_ok=True)
+
+ umlpidfile = workdir / "uml/pid"
+ umlpidfile.unlink(missing_ok=True)
+
+ newenv = dict(os.environ, PYTHONPATH=pwd)
+
+ try:
+ process = None
+ with self.backendlog.open("w") as f:
+ process = subprocess.Popen(
+ args,
+ env=newenv,
+ stdin=subprocess.PIPE,
+ stdout=f,
+ stderr=subprocess.STDOUT,
+ text=True,
+ preexec_fn=os.setsid,
+ )
+ process.wait(self.timeout if self.timeout else None)
+ except subprocess.TimeoutExpired:
+ pass
+ finally:
+ try:
+ if process:
+ os.killpg(process.pid, signal.SIGKILL)
+ except ProcessLookupError:
+ pass
+ try:
+ pid = int(umlpidfile.read_text())
+ os.killpg(pid, signal.SIGKILL)
+ except (FileNotFoundError, ProcessLookupError):
+ pass
+
+ if process and process.returncode is not None and process.returncode != 0:
+ with self.backendlog.open("a") as f:
+ f.write(f"<Backend exited with error code {process.returncode}>\n")
+
+ try:
+ with self.resultfile.open("r") as f:
+ proxy = json.load(f)
+ except FileNotFoundError:
+ # UML crashed, timed out, etc
+ proxy = None
+
+ return self._convert_results(proxy, tests, result)
+
+ def _parse_status(self, id: str, proxy: dict) -> Tuple[str, str]:
+ if not proxy:
+ return "ERROR", "No result. UML or backend crashed?\n"
+
+ try:
+ _, tb = next(e for e in proxy["successes"] if e[0] == id)
+ return "ok", ""
+ except StopIteration:
+ pass
+
+ try:
+ _, tb = next(e for e in proxy["errors"] if e[0] == id)
+ return "ERROR", tb
+ except StopIteration:
+ pass
+
+ try:
+ _, tb = next(e for e in proxy["failures"] if e[0] == id)
+ return "FAIL", tb
+ except StopIteration:
+ pass
+
+ # setupClass, etc
+ if proxy["errors"]:
+ _, tb = proxy["errors"][0]
+ return "ERROR", tb
+
+ raise Exception("Unable to parse status")
+
+ def _get_log(
+ self, name: str, parser: LogParser, id: str, full_if_none: bool
+ ) -> Optional[str]:
+ testloglines = parser.get_testcase_log(id)
+ tb = None
+ if testloglines:
+ tb = "\n".join([f"{name} log:"] + [" " + line for line in testloglines])
+ elif full_if_none and not parser.has_any():
+ if parser.raw:
+ tb = "\n".join(
+ [f"Full {name} log:", textwrap.indent(parser.raw, " ").rstrip()]
+ )
+ else:
+ tb = f"\nNo {name} log found."
+
+ return tb
+
+ def _convert_results(
+ self,
+ proxy: dict,
+ tests: list[UMLTestCase],
+ result: TestResult,
+ ) -> TestResult:
+ umllog = LogParser(self.umllog)
+ backendlog = LogParser(self.backendlog)
+
+ first_fail = True
+ for test in tests:
+ assert isinstance(test, unittest.TestCase)
+
+ id = test.id()
+ if not id.startswith("roadtest."):
+ id = f"roadtest.{id}"
+
+ status, tb = self._parse_status(id, proxy)
+ if status != "ok":
+ parts = []
+
+ backendtb = self._get_log("Backend", backendlog, id, first_fail)
+ if backendtb:
+ parts.append(backendtb)
+
+ umltb = self._get_log("UML", umllog, id, first_fail)
+ if umltb:
+ parts.append(umltb)
+
+ # In the case of no START/STOP markers at all in the logs, we include
+ # the full logs, but only do it in the first failing test case to
+ # reduce noise.
+ first_fail = False
+ tb = "\n\n".join(parts + [tb])
+
+ if status == "ERROR":
+ result.errors.append((test, tb))
+ elif status == "FAIL":
+ result.failures.append((test, tb))
+
+ print(f"{test} ... {status}")
+ result.testsRun += 1
+
+ return result
diff --git a/tools/testing/roadtest/roadtest/core/sysfs.py b/tools/testing/roadtest/roadtest/core/sysfs.py
new file mode 100644
index 000000000000..64228978718e
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/sysfs.py
@@ -0,0 +1,77 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import contextlib
+from pathlib import Path
+from typing import Iterator
+
+
+# Path.write_text() is inappropriate since Python calls write(2)
+# a second time if the first one returns an error, if the file
+# was opened as text.
+def write_str(path: Path, val: str) -> None:
+ path.write_bytes(val.encode())
+
+
+def write_int(path: Path, val: int) -> None:
+ write_str(path, str(val))
+
+
+def write_float(path: Path, val: float) -> None:
+ write_str(path, str(val))
+
+
+def read_str(path: Path) -> str:
+ return path.read_text().rstrip()
+
+
+def read_int(path: Path) -> int:
+ return int(read_str(path))
+
+
+def read_float(path: Path) -> float:
+ return float(read_str(path))
+
+
+class I2CDevice:
+ def __init__(self, addr: int, bus: int = 0) -> None:
+ self.id = f"{bus}-{addr:04x}"
+ self.path = Path(f"/sys/bus/i2c/devices/{self.id}")
+
+
+class PlatformDevice:
+ def __init__(self, name: str) -> None:
+ self.id = name
+ self.path = Path(f"/sys/bus/platform/devices/{self.id}")
+
+
+class I2CDriver:
+ def __init__(self, driver: str) -> None:
+ self.driver = driver
+ self.path = Path(f"/sys/bus/i2c/drivers/{driver}")
+
+ @contextlib.contextmanager
+ def bind(self, addr: int, bus: int = 0) -> Iterator[I2CDevice]:
+ dev = I2CDevice(addr, bus)
+ write_str(self.path / "bind", dev.id)
+
+ try:
+ yield dev
+ finally:
+ write_str(self.path / "unbind", dev.id)
+
+
+class PlatformDriver:
+ def __init__(self, driver: str) -> None:
+ self.driver = driver
+ self.path = Path(f"/sys/bus/platform/drivers/{driver}")
+
+ @contextlib.contextmanager
+ def bind(self, addr: str) -> Iterator[PlatformDevice]:
+ dev = PlatformDevice(addr)
+ write_str(self.path / "bind", dev.id)
+
+ try:
+ yield dev
+ finally:
+ write_str(self.path / "unbind", dev.id)
diff --git a/tools/testing/roadtest/roadtest/core/test_control.py b/tools/testing/roadtest/roadtest/core/test_control.py
new file mode 100644
index 000000000000..a8cf9105eb52
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/test_control.py
@@ -0,0 +1,35 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+from pathlib import Path
+from tempfile import TemporaryDirectory
+from unittest import TestCase
+
+from .control import ControlReader, ControlWriter
+
+
+class TestControl(TestCase):
+ def test_control(self) -> None:
+ with TemporaryDirectory() as tmpdir:
+ work = Path(tmpdir)
+ reader = ControlReader(work)
+ writer = ControlWriter(work)
+
+ values = []
+
+ def append(new: int) -> None:
+ nonlocal values
+ values.append(new)
+
+ vars = {"append": append}
+ writer.write_cmd("append(1)")
+
+ reader.process(vars)
+ self.assertEqual(values, [1])
+
+ writer.write_cmd("append(2)")
+ writer.write_log("append(4)")
+ writer.write_cmd("append(3)")
+
+ reader.process(vars)
+ self.assertEqual(values, [1, 2, 3])
diff --git a/tools/testing/roadtest/roadtest/core/test_devicetree.py b/tools/testing/roadtest/roadtest/core/test_devicetree.py
new file mode 100644
index 000000000000..db61fd24b39a
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/test_devicetree.py
@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import tempfile
+import unittest
+from pathlib import Path
+
+from . import devicetree
+
+
+class TestDevicetree(unittest.TestCase):
+ def test_compile(self) -> None:
+ with tempfile.TemporaryDirectory() as tmp:
+ tmpdir = Path(tmp)
+ # We don't have the ksrcdir so we can't test if includes work.
+ dt = devicetree.Devicetree(tmpdir, tmpdir)
+
+ dt.assemble(
+ [
+ devicetree.DtFragment(
+ src="""
+&i2c {
+ foo = <1>;
+};
+ """
+ )
+ ]
+ )
+ dt.compile("test.dtb")
+ dtb = tmpdir / "test.dtb"
+ self.assertTrue((dtb).exists())
diff --git a/tools/testing/roadtest/roadtest/core/test_hardware.py b/tools/testing/roadtest/roadtest/core/test_hardware.py
new file mode 100644
index 000000000000..eb09b317e258
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/test_hardware.py
@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+from pathlib import Path
+from tempfile import TemporaryDirectory
+from unittest import TestCase
+
+from roadtest.backend.mock import MockBackend
+
+from .hardware import Hardware
+
+
+class TestHardware(TestCase):
+ def test_mock(self) -> None:
+ with TemporaryDirectory() as tmpdir:
+ work = Path(tmpdir)
+
+ backend = MockBackend(work)
+ hw = Hardware(bus="dummy", work=work)
+
+ backend.reg_write(0x1, 0xDEAD)
+ backend.reg_write(0x2, 0xBEEF)
+ mock = hw.update_mock()
+ mock.assert_reg_write_once(self, 0x1, 0xDEAD)
+
+ backend.reg_write(0x1, 0xCAFE)
+ mock = hw.update_mock()
+ with self.assertRaises(AssertionError):
+ mock.assert_reg_write_once(self, 0x1, 0xDEAD)
+
+ mock.assert_last_reg_write(self, 0x1, 0xCAFE)
+
+ self.assertEqual(mock.get_last_reg_write(0x1), 0xCAFE)
+ self.assertEqual(mock.get_last_reg_write(0x2), 0xBEEF)
+
+ with self.assertRaises(IndexError):
+ self.assertEqual(mock.get_last_reg_write(0x3), 0x0)
+
+ mock.reset_mock()
+ with self.assertRaises(AssertionError):
+ mock.assert_last_reg_write(self, 0x2, 0xBEEF)
diff --git a/tools/testing/roadtest/roadtest/core/test_log.py b/tools/testing/roadtest/roadtest/core/test_log.py
new file mode 100644
index 000000000000..6988ff4419db
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/test_log.py
@@ -0,0 +1,54 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+from pathlib import Path
+from tempfile import NamedTemporaryFile
+from unittest import TestCase
+
+from .log import LogParser
+
+
+class TestLog(TestCase):
+ def test_parser(self) -> None:
+ with NamedTemporaryFile() as tmpfile:
+ path = Path(tmpfile.name)
+
+ path.write_text(
+ """
+xyz START<finished>
+finished1
+finished2
+STOP<finished>
+START<empty>
+STOP<empty>
+START<foo> monkey STOP<foo>
+START<unfinished>
+unfinished1
+unfinished2"""
+ )
+
+ parser = LogParser(path)
+ self.assertEqual(
+ parser.get_testcase_log("finished"), ["finished1", "finished2"]
+ )
+
+ self.assertEqual(
+ parser.get_testcase_log("unfinished"),
+ ["unfinished1", "unfinished2", LogParser.DNF_MESSAGE],
+ )
+
+ self.assertEqual(
+ parser.get_testcase_log("notpresent"),
+ [],
+ )
+
+ self.assertEqual(
+ parser.get_testcase_log("enpty"),
+ [],
+ )
+
+ # Shouldn't happen since we print from the kernel?
+ self.assertEqual(
+ parser.get_testcase_log("foo"),
+ [],
+ )
diff --git a/tools/testing/roadtest/roadtest/core/test_opslog.py b/tools/testing/roadtest/roadtest/core/test_opslog.py
new file mode 100644
index 000000000000..bd594c587032
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/core/test_opslog.py
@@ -0,0 +1,27 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+from pathlib import Path
+from tempfile import TemporaryDirectory
+from unittest import TestCase
+
+from .opslog import OpsLogReader, OpsLogWriter
+
+
+class TestOpsLOg(TestCase):
+ def test_opslog(self) -> None:
+ with TemporaryDirectory() as tmpdir:
+ work = Path(tmpdir)
+ writer = OpsLogWriter(work)
+ reader = OpsLogReader(work)
+
+ self.assertEqual(reader.read_next(), [])
+
+ writer.write("1")
+ writer.write("2")
+
+ self.assertEqual(reader.read_next(), ["1", "2"])
+ self.assertEqual(reader.read_next(), [])
+
+ writer.write("3")
+ self.assertEqual(reader.read_next(), ["3"])
diff --git a/tools/testing/roadtest/roadtest/tests/__init__.py b/tools/testing/roadtest/roadtest/tests/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
--
2.34.1
Add documentation for the roadtest device driver testing framework.
This includes a "how to write your first test" tutorial.
Signed-off-by: Vincent Whitchurch <[email protected]>
---
Documentation/dev-tools/index.rst | 1 +
Documentation/dev-tools/roadtest.rst | 669 +++++++++++++++++++++++++++
2 files changed, 670 insertions(+)
create mode 100644 Documentation/dev-tools/roadtest.rst
diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst
index 4621eac290f4..44fea7c50dad 100644
--- a/Documentation/dev-tools/index.rst
+++ b/Documentation/dev-tools/index.rst
@@ -33,6 +33,7 @@ Documentation/dev-tools/testing-overview.rst
kselftest
kunit/index
ktap
+ roadtest
.. only:: subproject and html
diff --git a/Documentation/dev-tools/roadtest.rst b/Documentation/dev-tools/roadtest.rst
new file mode 100644
index 000000000000..114bf822e376
--- /dev/null
+++ b/Documentation/dev-tools/roadtest.rst
@@ -0,0 +1,669 @@
+========
+Roadtest
+========
+
+Roadtest is a device-driver testing framework. It tests drivers under User
+Mode Linux using models of the hardware. The tests cases and hardware models
+are written in Python, the former using the built-in unittest framework.
+
+Roadtest is meant to be used for relatively simple drivers, such as the ones
+part of the IIO, regulator or RTC subsystems.
+
+Drivers are tested via their userspace interfaces and interact with hardware
+models which allow tests to inject values into registers and assert that
+drivers control the hardware in the right way and react as expected to stimuli.
+
+Installing the requirements
+===========================
+
+Addition to the normal requirements for building kernels, *running* roadtest
+requires Python 3.9 or later, including the development libraries:
+
+.. code-block:: shell
+
+ apt-get -y install python3.9 libpython3.9-dev device-tree-compiler
+
+There is also support for running the tests in a Docker container without
+having to install any packages.
+
+Running roadtest
+================
+
+To run the tests, run the following command from the base of a kernel source
+tree:
+
+.. code-block:: shell
+
+ $ make -C tools/testing/roadtest
+
+Or, if you prefer to use the Docker container:
+
+.. code-block:: shell
+
+ $ make -C tools/testing/roadtest DOCKER=1
+
+Either of these commands will build a kernel and run all roadtests.
+
+.. note::
+
+ Roadtest builds the kernel out-of-tree. The kernel build system may instruct
+ you to clean your tree if you have previously performed an in-tree build. You
+ can pass the usual ``-jNN`` options to parallelize the build. The tests
+ themselves are currently always run sequentially.
+
+Writing roadtests
+=================
+
+Tutorial: Writing your first roadtest
+-------------------------------------
+
+You may find it simplest to have a look at the existing tests and base your new
+tests on them, but if you prefer, this section provides a tutorial which will
+guide you to write a new basic test from scratch.
+
+Even if you're not too keen on following the tutorial hands-on, you're
+encouraged to skim through it since there are useful debugging tips and notes
+on roadtest's internals which could be useful to know before diving in and
+writing tests.
+
+A quick note on the terminology before we begin: we'll refer to the framework
+itself as "roadtest" or just "the framework", and we'll call a driver test
+which uses this framework a "roadtest" or just a "test".
+
+Goal for the test
+~~~~~~~~~~~~~~~~~
+
+In this tutorial, we'll add a basic test for one of the features of the
+VCNL4000 light sensor driver which is a part of the IIO subsystem
+(``drivers/iio/light/vcnl4000.c``).
+
+This driver supports a bunch of related proximity and ambient light sensor
+chips which communicate using the I2C protocol; we'll be testing the VCNL4000
+variant. The datasheet for the chip is, at the time of writing, available
+`here <https://cdn-shop.adafruit.com/datasheets/vcnl4000.pdf>`_.
+
+The test will check that the driver correctly reads and reports the illuminance
+values from the hardware to userspace via the IIO framework.
+
+Test file placement
+~~~~~~~~~~~~~~~~~~~
+
+Roadtests are placed under ``tools/testing/roadtest/roadtest/tests``. (In case
+you're wondering, the second ``roadtest`` is to create a Python package, so
+that imports of ``roadtest`` work without having to mess with module search
+paths.)
+
+Tests are organized by subsystem. Normally we'd put our IIO light sensor tests
+under ``iio/light/`` (below the ``tests`` directory), but since there is
+already a VCNL4000 test there, we'll create a new subsystem directory called
+``tutorial`` and put our test there in a new file called ``test_tutorial.py``.
+
+We'll also need to create an empty ``__init__.py`` in that directory to allow
+Python to recognize it as a package.
+
+All the commands in this tutorial should be executed from the
+``tools/testing/roadtest`` directory inside the kernel source tree. (To reduce
+noise, we won't show the current working directory before the ``$`` in future
+command line examples.)
+
+.. code-block:: shell
+
+ tools/testing/roadtest$ mkdir -p roadtest/tests/tutorial/
+ tools/testing/roadtest$ touch roadtest/tests/tutorial/__init__.py
+
+Building the module
+~~~~~~~~~~~~~~~~~~~
+
+First, we'll need to ensure that our driver is built. To do that, we'll add
+the appropriate config option to built our driver as a module. The lines
+should be written to a new file called ``config`` in the ``tutorial``
+directory. Roadtest will gather all ``config`` files placed anywhere under
+``tests`` and build a kernel with the combined config.
+
+.. code-block:: shell
+
+ $ echo CONFIG_VCNL4000=m >> roadtest/tests/tutorial/config
+
+.. note::
+
+ This driver will actually be built even if you don't add this config, since
+ it's already present in the ``roadtest/tests/iio/light/config`` used by the
+ existing VCNL4000 test. Roadtest uses a single build for all tests.
+
+Loading the module from the test
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We've set up our module to be built, so we can now start working on the test
+case iself. We'll start with the following few lines of code. Tests are
+written Python's built-in `unittest
+<https://docs.python.org/3/library/unittest.html>`_ module. This tutorial will
+assume familiariy with that framework; see the Python documentation for more
+information.
+
+Test classes should subclass ``roadtest.core.suite.UMLTestCase`` instead of
+``unittest.TestCase``. This informs the roadtest core code that the test
+should be run inside UML.
+
+.. note::
+
+ There are several "real" unit tests for the framework itself; these subclass
+ ``unittest.TestCase`` directly and are run on the host system. You'll see
+ these run in the beginning when you run roadtest.
+
+All this test currently does is insert our driver's module, do nothing, and
+then remove our driver's kernel module. (The ``roadtest.core.modules.Module``
+class implements a ``ContextManager`` which automatically cleans up using the
+``with`` statement.)
+
+.. code-block:: python
+
+ from roadtest.core.suite import UMLTestCase
+ from roadtest.core.modules import Module
+
+ class TestTutorial(UMLTestCase):
+ def test_illuminance(self) -> None:
+ with Module("vcnl4000"):
+ pass
+
+You can now build the kernel and run roadtest with:
+
+.. code-block:: shell
+
+ $ make
+
+.. note::
+
+ Make sure you have all the dependencies described at the beginning of the
+ document installed. You can also use a Docker container, append ``DOCKER=1``
+ to all the ``make`` commands in this tutorial if you want to do that.
+
+You should see your new test run and pass in the output of the above command:
+
+.. code-block::
+
+ ...
+ test_illuminance (tests.tutorial.test_tutorial.TestTutorial) ... ok
+ ...
+
+Shortening feedback loops
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+While just running ``make`` runs your new test, it also runs all the *other*
+tests too, and what's more, it calls in to the kernel build system every time,
+and that can be relatively slow even if there's nothing to be rebuilt.
+
+When you're only working on writing tests, and not modifying the driver or the
+kernel source, you can avoid calling into Kbuild by passing ``KBUILD=0`` to the
+``make`` invocation. For example:
+
+.. code-block:: shell
+
+ $ make KBUILD=0
+
+To only run specific tests, you can use the ``--filter`` option to roadtest's
+main script (implemented in ``roadtest.cmd.main``) which takes a wildcard
+pattern. Only tests whoses names match the pattern are run.
+
+Options to the main script are passed via the ``OPTS`` variable. So the
+following would both skip the kernel build and only run your test:
+
+.. code-block:: shell
+
+ $ make KBUILD=0 OPTS="--filter tutorial"
+
+.. tip::
+
+ Roadtest builds the kernel inside a directory called ``.roadtest`` in your
+ kernel source tree. Logs from UML are saved as
+ ``.roadtest/roadtest-work/uml.txt`` and logs from roadtest's backend (more on
+ that later) are at ``.roadtest/roadtest-work/backend.txt``. It's sometimes
+ useful to keep a terminal open running ``tail -f`` on these files while
+ developing roadtests.
+
+Adding a device
+~~~~~~~~~~~~~~~
+
+Our basic test only loads and unloads the module, so the next step is to
+actually get our driver to probe and bind to a device. On many systems,
+devices are instantiated based on the hardware descriptions in devicetree, and
+this is the case on roadtest's UML-based system too. See
+:ref:`Documentation/driver-api/driver-model/binding.rst <binding>` and
+:ref:`Documentation/devicetree/usage-model.rst <usage-model>` for more
+information.
+
+When working on real harwdare, the hardware design specifies at what address
+and on which I2C bus the hardware sensor chip is connected. Roadtest provides
+a virtual I2C bus and the test can chose to place devices at any valid address
+on this bus.
+
+In this tutorial, we'll use a hard coded device address of ``0x42`` and set the
+``run_separately`` flag on the test, asking roadtest to run our test in a
+separate UML instance so that we know that no other test has tried to put a
+device at that I2C address.
+
+.. note::
+
+ Normally, roadtests use what the framework refers to as *relocatable
+ devicetree fragments* (unrelated to the fragments used in devicetree
+ overlays). These do not use fixed addreses for specific devices, but instead
+ allow the framework to freely assign addresses. This allows several
+ different, independent tests can be run using one devicetree and one UML
+ instance (to save on startup time costs), without having to coordinate
+ selection of device addesses.
+
+ When writing "real" roadtests (after you're done with this tutorial), you too
+ should use relocatable fragments. See the existing tests for examples.
+
+The framework's devicetree module (``roadtest.core.devicetree``) includes a
+base tree that provides an I2C controller node (appropriately named ``i2c``)
+for the virtual I2C, so we will add our new device under that node.
+
+Unlike on a default Linux system, just adding the node to the devicetree won't
+get our I2C driver to automatically bind to the driver when we load the module.
+This is because roadtest's ``init.sh`` (a script which runs inside UML after
+the kernel boots up) turns off automatic probing on the I2C bus, in order to
+give the test cases full control of when things get probed.
+
+So we'll have ask the ``test_illuminance()`` method to get the ``vcnl4000``
+driver (that's the name of the I2C driver which the module registers, and
+that's not necessarily the same as the name of the module) to explicitly bind
+to our chosen ``0x42`` I2C device using some of the helper classes in the
+framework:
+
+.. code-block:: python
+
+ from roadtest.core.devicetree import DtFragment
+ from roadtest.core.devices import I2CDriver
+
+ class TestTutorial(UMLTestCase):
+ run_separately = True
+ dts = DtFragment(
+ src="""
+ &i2c {
+ light-sensor@42 {
+ compatible = "vishay,vcnl4000";
+ reg = <0x42>;
+ };
+ };
+ """,
+ )
+
+ def test_illuminance(self) -> None:
+ with (
+ Module("vcnl4000"),
+ I2CDriver("vcnl4000").bind(0x42) as dev,
+ ):
+ pass
+
+You can run this test using the same ``make`` command you used previously.
+This time, rather than an "ok", you should see roadtest complain about an error
+during your test:
+
+.. code-block::
+
+ ======================================================================
+ ERROR: test_illuminance (tests.tutorial.test_tutorial.TestTutorial)
+ ----------------------------------------------------------------------
+ Backend log:
+ Traceback (most recent call last):
+ File ".../roadtest/backend/i2c.py", line 35, in write
+ raise Exception("No I2C model loaded")
+ Exception: No I2C model loaded
+ Traceback (most recent call last):
+ File ".../roadtest/backend/i2c.py", line 29, in read
+ raise Exception("No I2C model loaded")
+ Exception: No I2C model loaded
+
+ UML log:
+ [ 1220.410000][ T19] vcnl4000: probe of 0-0042 failed with error -5
+
+ Traceback (most recent call last):
+ File ".../roadtest/tests/tutorial/test_tutorial.py", line 21, in test_illuminance
+ with (
+ File "/usr/lib/python3.9/contextlib.py", line 119, in __enter__
+ return next(self.gen)
+ File ".../roadtest/core/devices.py", line 32, in bind
+ f.write(dev.id.encode())
+ OSError: [Errno 5] Input/output error
+
+To understand and fix this error, we'll have to learn a bit about how roadtest
+works under the hood.
+
+Adding a hardware model
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Roadtest's *backend* is what allows the hardware to modelled for the sake of
+driver testing. The backend runs outside of UML and communication between the
+drivers and the models goes via ``virtio-uml``, a shared-memory based
+communication protocol. At its lowest level, the backend is written in C and
+implements virtio devices for ``virtio-i2c`` and ``virtio-gpio``, both of which
+have respective virtio drivers which run inside UML and provide the virtual I2C
+bus (and GPIO controller) whose nodes are available in the devicetree.
+
+The C backend embeds a Python interpreter which runs a Python module which
+implements the I2C bus model. It's that Python module which is complaining now
+that it does not have any I2C device model to handle the I2C transactions that
+it received from UML. This is quite understandable since we haven't
+implemented one yet!
+
+.. note::
+
+ In the error message above, you'll also notice an error ``printk()`` from the
+ driver (as part of the *UML log*, which includes kernel console messages), as
+ well as the exception stacktrace from the test case itself. The ``-EIO``
+ seen inside UML is a result of the roadtest backend failing the I2C
+ transaction due to the exception.
+
+Models are placed in the same source file as the test cases. The model and
+the test cases will however run in two different Python interpreters on two
+different systems (the test case inside UML, and the model inside the backend
+on your host).
+
+For I2C, the interface our model needs to implement is specified by the
+Abstract Base Class ``roadtest.backend.i2c.I2CModel`` (which can be found,
+following Python's standard naming conventions, in the file
+``roadtest/backend/i2c.py``). You can see that it expects the model to
+implement ``read()`` and ``write()`` functions which transmit and receive the
+raw bytes of the I2C transaction.
+
+Our VCNL4000 device uses the SMBus protocol which is a subset of the I2C
+protocol, so we can use a higher-level class to base our implementation off,
+``roadtest.backend.i2c.SMBusModel``. This one takes care of doing segmentation
+of the I2C requests, and expects subclasses to implement ``reg_read()`` and
+``reg_write()`` methods which will handle the register access for the device.
+
+For our initial model, we'll just going to just make our ``reg_read()`` and
+``reg_write()`` methods read and store the register values in a dictionary.
+We'll need some initial values for the registers, and for these we use the
+values which are specified in the VCNL4000's datasheet. We won't bother with
+creating constants for the register addresses and we'll just specify them in
+hex:
+
+.. code-block:: python
+
+ from typing import Any
+ from roadtest.backend.i2c import SMBusModel
+
+ class VCNL4000(SMBusModel):
+ def __init__(self, **kwargs: Any) -> None:
+ super().__init__(regbytes=1, **kwargs)
+ self.regs = {
+ 0x80: 0b_1000_0000,
+ 0x81: 0x11,
+ 0x82: 0x00,
+ 0x83: 0x00,
+ 0x84: 0x00,
+ 0x85: 0x00,
+ 0x86: 0x00,
+ 0x87: 0x00,
+ 0x88: 0x00,
+ 0x89: 0x00,
+ }
+
+ def reg_read(self, addr: int) -> int:
+ val = self.regs[addr]
+ return val
+
+ def reg_write(self, addr: int, val: int) -> None:
+ assert addr in self.regs
+ self.regs[addr] = val
+
+Then we need to modify the test function to ask the backend to load this model:
+
+.. code-block:: python
+ :emphasize-lines: 1,6
+
+ from roadtest.core.hardware import Hardware
+
+ def test_illuminance(self) -> None:
+ with (
+ Module("vcnl4000"),
+ Hardware("i2c").load_model(VCNL4000),
+ I2CDriver("vcnl4000").bind(0x42),
+ ):
+ pass
+
+Now run the test again. You should see the test pass, meaning that the driver
+successfully talked to and recognized your hardware model. (You can look at
+the UML and backend logs mentioned earlier to confirm this.)
+
+.. tip::
+
+ You can add arbitrary command line arguments to UML using the
+ ``--uml-append`` option. For example, while developing tests for I2C
+ drivers, it could be helpful to turn on the appropriate trace events and
+ arrange for them to be printed to the console (which you can then access via
+ the previously mentioned ``uml.txt``.):
+
+ .. code-block::
+
+ OPTS="--filter tutorial --uml-append tp_printk trace_event=i2c:*"
+
+Exploring the target
+~~~~~~~~~~~~~~~~~~~~
+
+Now that we've gotten the driver to probe to our new device, we want to get the
+test to read the illuminance value from the driver. However, which file should
+the test read the value from? IIO exposes the illuminance value in a sysfs
+file, but where do we find this file?
+
+If you have real hardware with a VCNL4000 chip and already running the vcnl4000
+driver, or are already very familiar with the IIO framework, you likely already
+know what sysfs files to read, but in our case, we can open up a shell on UML
+to manually explore the system and find the relevant sysfs files before
+implementing the rest of the test case.
+
+Roadtest's ``--shell`` option makes UML start a shell instead of exiting after
+the tests are run. However, since our test case cleans up after itself (as
+it should) using context managers, neither the module nor the model would
+remain loaded after the test exists, which would make manual exploration
+difficult.
+
+To remedy this, we can combine ``--shell`` with temporary code in our test to
+_exit(2) after setting up everything:
+
+.. code-block:: python
+ :emphasize-lines: 5,7
+
+ def test_illuminance(self) -> None:
+ with (
+ Module("vcnl4000"),
+ Hardware("i2c").load_model(VCNL4000),
+ I2CDriver("vcnl4000").bind(0x42) as dev,
+ ):
+ print(dev.path)
+ import os; os._exit(1)
+
+.. note::
+
+ The communication between the test cases and the models uses a simple text
+ based protocol where the test cases write Python expressions to a file which
+ the backend reads and evaluates, so it is possible to load a model using only
+ shell commands, but this is undocumented. See the source code if you need to
+ do this.
+
+We'll also need to ask UML to open up a terminal emulator (``con=xterm``) or start a telnet server
+and wait for a connection (``con=port:9000``). See
+:ref:`Documentation/virt/uml/user_mode_linux_hotwo_v2.rst
+<user_mode_linux_hotwo_v2>` for more information about the required packages.
+These options can be passed to UML using ``--uml-append``. So the final
+``OPTS`` argument is something like the following (you can combine this with
+the tracing options):
+
+.. code-block::
+
+ OPTS="--shell --uml-append con=xterm"
+
+.. tip::
+
+ ``con=xterm doesn``'t work in the Docker container, so use the telnet option
+ if you're running roadtest inside Docker. ``screen -L //telnet localhost
+ 9000`` or similar can be used to connect to UML.
+
+ When running *without* using Docker, the telnet option tends to leave UML's
+ ``port-helper`` running in the background, so you may have to ``kill(1)`` it
+ yourself after each run.
+
+Using the shell, you should be able to find the illuminance file under the
+device's sysfs path:
+
+.. code-block::
+
+ root@(none):/sys/bus/i2c/devices/0-0042# ls -1 iio\:device0/in*
+ iio:device0/in_illuminance_raw
+ iio:device0/in_illuminance_scale
+ iio:device0/in_proximity_nearlevel
+ iio:device0/in_proximity_raw
+
+You can also attempt to read the ``in_illuminance_raw`` file; you should see
+that it fails with something like this (with the trace events enabled):
+
+.. code-block::
+
+ root@(none):/sys/bus/i2c/devices/0-0042# cat iio:device0/in_illuminance_raw
+ [ 151.270000][ T34] i2c_write: i2c-0 #0 a=042 f=0000 l=2 [80-10]
+ [ 151.270000][ T34] i2c_result: i2c-0 n=1 ret=1
+ ...
+ [ 152.030000][ T34] i2c_write: i2c-0 #0 a=042 f=0000 l=1 [80]
+ [ 152.030000][ T34] i2c_read: i2c-0 #1 a=042 f=0001 l=1
+ [ 152.030000][ T34] i2c_reply: i2c-0 #1 a=042 f=0001 l=1 [10]
+ [ 152.030000][ T34] i2c_result: i2c-0 n=2 ret=2
+ [ 152.070000][ T34] vcnl4000 0-0042: vcnl4000_measure() failed, data not ready
+
+Controlling register values
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Our next challenge is to get the ``in_illuminance_raw`` file to be read
+successfully. From the I2C trace events above, or from looking at the
+``backend.txt`` (below), we can see that the driver repeatedly reads a
+particular register.
+
+.. code-block::
+
+ INFO - roadtest.core.control: START<roadtest.tests.tutorial.test_tutorial.TestTutorial.test_illuminance>
+ DEBUG - roadtest.core.control: backend.i2c.load_model(*('roadtest.tests.tutorial.test_tutorial', 'VCNL4000'), **{})
+ DEBUG - roadtest.backend.i2c: SMBus read addr=0x81 val=0x11
+ DEBUG - roadtest.backend.i2c: SMBus write addr=0x80 val=0x10
+ DEBUG - roadtest.backend.i2c: SMBus read addr=0x80 val=0x10
+ DEBUG - roadtest.backend.i2c: SMBus read addr=0x80 val=0x10
+ ...
+
+To understand this register, we need to take a look at the chip's datasheet and
+compare it with the driver code. By doing so, we can see the driver is waiting
+for the hardware to signal that the data is ready by polling for a particular
+bit to be set.
+
+One simple way to set the data ready bit, which we'll use for the purpose of
+this tutorial, is to simply ensure that the model always returns reads to the
+0x80 register with that bit set.
+
+.. note::
+
+ This method wouldn't allow a test to be written to test the timeout handling,
+ but we won't bother with that in this tutorial. You can explore the exising
+ roadtests for alternative solutions, such as setting the data ready bit
+ whenever the test injects new data and clearing it when the driver reads the
+ data.
+
+.. code-block:: python
+ :emphasize-lines: 4,5
+
+ def reg_read(self, addr: int) -> int:
+ val = self.regs[addr]
+
+ if addr == 0x80:
+ val |= 1 << 6
+
+ return val
+
+This should get the bit set and make the read succeed (you can check this using
+the shell), but we'd also like to return different values from the data
+registers rather the reset values we hardcoded in ``__init__``. One way to do
+this is to have the test inject the values into the ALS result registers by
+having it call the ``reg_write()`` method of the model. It can do this via the
+``Hardware`` object.
+
+.. note::
+
+ The test can call methods on the model but it can't receive return values
+ from these methods, nor can it set attributes on the model. The model and
+ the test run on different systems and communication between them is
+ asynchronous.
+
+We'll combine this with a read of the sysfs file we identified and throw in an
+assertion to check that the value which the driver reports to userspace via
+that file matches the value which we inject into the hardware's result
+registers:
+
+.. code-block:: python
+ :emphasize-lines: 6,8,9-13
+
+ from roadtest.core.sysfs import read_int
+
+ def test_illuminance(self) -> None:
+ with (
+ Module("vcnl4000"),
+ Hardware("i2c").load_model(VCNL4000) as hw,
+ I2CDriver("vcnl4000").bind(0x42) as dev,
+ ):
+ hw.reg_write(0x85, 0x12)
+ hw.reg_write(0x86, 0x34)
+ self.assertEqual(
+ read_int(dev.path / "iio:device0/in_illuminance_raw", 0x1234)
+ )
+
+And that's it for this tutorial. We've written a simple end-to-end test for
+one aspect of this driver with the help of a minimal model of the hardware.
+
+Verifying drivers' interactions with the hardware
+-------------------------------------------------
+
+The tutorial covered injection of values into hardware registers and how to
+check that the driver interprets the value exposed by the hardware correctly,
+but another important aspect of testing device drivers is to verify that the
+driver actually *controls* the hardware in the expected way.
+
+For example, if you are testing a regulator driver, you want to test that
+driver actually writes the correct voltage register in the hardware with the
+correct value when the driver is asked to set a voltage using the kernel's
+regulator API.
+
+To support this, roadtest integrates with Python's built-in `unittest.mock
+<https://docs.python.org/3/library/unittest.mock.html>`_ library. The
+``update_mock()`` method on the ``Hardware`` objects results in a ``HwMock`` (a
+subclass of ``unittest.mock``'s ``MagicMock``) object which, in the case of
+``SMBusModel``, provides access to a log of all register writes and their
+values.
+
+The object can be then used to check which registers the hardware has written
+with which values, and to assert that the expect actions have been taken.
+
+See ``roadtest/tests/regulator/test_tps62864.py`` for an example of this.
+
+GPIOs
+-----
+
+The framework includes support for hardware models to trigger interrupts by
+controlling GPIOs. See ``roadtest/tests/rtc/test_pcf8563.py`` for an example.
+
+Support has not been implemented yet for asserting that drivers control GPIOs
+correctly. See the comment in ``gpio_handle_cmdq()`` in ``src/backend.c``.
+
+Coding guidelines
+-----------------
+
+Run ``make fmt`` to automatically format your Python code to follow the coding
+style. Run ``make check`` and ensure that your code passes static checkers and
+style checks. Typing hints are mandatory.
+
+These two commands require that you have installed the packages listed in
+``requirements.txt``, for example with something like the following patch and
+then ensuring that ``~/.local/bin`` is in your ``$PATH``.
+
+.. code-block:: shell
+
+ $ pip3 install --user -r requirements.txt
+
+Alternatively, you can also run these commands in the Docker container (by
+appending ``DOCKER=1`` to the ``make`` commands) which has all the correct
+tools installed.
--
2.34.1
Add the base config options for the roadtest kernel (generated with
"savedefconfig").
roadtest uses a single kernel for all tests and the drivers under test
are built as modules. Additional config options are added by merging
config fragments from each subsystems' test directory.
The kernel is built with several debug options to catch more problems
during testing.
Signed-off-by: Vincent Whitchurch <[email protected]>
---
.../roadtest/roadtest/tests/base/config | 84 +++++++++++++++++++
1 file changed, 84 insertions(+)
create mode 100644 tools/testing/roadtest/roadtest/tests/base/config
diff --git a/tools/testing/roadtest/roadtest/tests/base/config b/tools/testing/roadtest/roadtest/tests/base/config
new file mode 100644
index 000000000000..c1952d047c8e
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/base/config
@@ -0,0 +1,84 @@
+CONFIG_NO_HZ=y
+CONFIG_HIGH_RES_TIMERS=y
+CONFIG_LOG_BUF_SHIFT=14
+CONFIG_EXPERT=y
+CONFIG_HOSTFS=y
+CONFIG_UML_TIME_TRAVEL_SUPPORT=y
+CONFIG_NULL_CHAN=y
+CONFIG_PORT_CHAN=y
+CONFIG_PTY_CHAN=y
+CONFIG_TTY_CHAN=y
+CONFIG_XTERM_CHAN=y
+CONFIG_CON_CHAN="pts"
+CONFIG_SSL=y
+CONFIG_SSL_CHAN="pts"
+CONFIG_MAGIC_SYSRQ=y
+CONFIG_VIRTIO_UML=y
+CONFIG_UML_PCI_OVER_VIRTIO=y
+CONFIG_UML_PCI_OVER_VIRTIO_DEVICE_ID=1234
+CONFIG_GCOV_KERNEL=y
+CONFIG_MODULES=y
+CONFIG_MODULE_UNLOAD=y
+CONFIG_BINFMT_MISC=m
+# CONFIG_COMPACTION is not set
+CONFIG_DEVTMPFS=y
+CONFIG_DEVTMPFS_MOUNT=y
+CONFIG_OF=y
+# CONFIG_INPUT is not set
+CONFIG_LEGACY_PTY_COUNT=32
+CONFIG_HW_RANDOM=y
+# CONFIG_HW_RANDOM_IXP4XX is not set
+# CONFIG_HW_RANDOM_STM32 is not set
+# CONFIG_HW_RANDOM_MESON is not set
+# CONFIG_HW_RANDOM_CAVIUM is not set
+# CONFIG_HW_RANDOM_MTK is not set
+# CONFIG_HW_RANDOM_EXYNOS is not set
+# CONFIG_HW_RANDOM_NPCM is not set
+# CONFIG_HW_RANDOM_KEYSTONE is not set
+CONFIG_RANDOM_TRUST_BOOTLOADER=y
+CONFIG_I2C=y
+# CONFIG_I2C_COMPAT is not set
+CONFIG_I2C_CHARDEV=y
+CONFIG_I2C_VIRTIO=y
+CONFIG_I2C_STUB=m
+CONFIG_PPS=y
+CONFIG_GPIOLIB=y
+CONFIG_GPIO_VIRTIO=y
+CONFIG_NET=y
+CONFIG_UNIX=y
+CONFIG_NEW_LEDS=y
+CONFIG_LEDS_CLASS=y
+CONFIG_LEDS_GPIO=y
+CONFIG_LEDS_TRIGGERS=y
+CONFIG_LEDS_TRIGGER_HEARTBEAT=y
+CONFIG_RTC_CLASS=y
+# CONFIG_RTC_HCTOSYS is not set
+# CONFIG_RTC_SYSTOHC is not set
+CONFIG_RTC_DEBUG=y
+# CONFIG_RTC_NVMEM is not set
+CONFIG_VIRTIO_INPUT=y
+# CONFIG_BCM_VIDEOCORE is not set
+CONFIG_QUOTA=y
+CONFIG_AUTOFS4_FS=m
+CONFIG_PROC_KCORE=y
+CONFIG_TMPFS=y
+CONFIG_NLS=y
+CONFIG_CRYPTO=y
+CONFIG_CRYPTO_CRC32C=y
+CONFIG_CRYPTO_JITTERENTROPY=y
+CONFIG_CRC16=y
+CONFIG_PRINTK_TIME=y
+CONFIG_PRINTK_CALLER=y
+CONFIG_DYNAMIC_DEBUG=y
+CONFIG_DEBUG_INFO=y
+CONFIG_FRAME_WARN=1024
+CONFIG_READABLE_ASM=y
+CONFIG_DEBUG_FS=y
+CONFIG_UBSAN=y
+CONFIG_PAGE_EXTENSION=y
+CONFIG_DEBUG_OBJECTS=y
+CONFIG_DEBUG_OBJECTS_FREE=y
+CONFIG_DEBUG_OBJECTS_TIMERS=y
+CONFIG_DEBUG_OBJECTS_WORK=y
+CONFIG_PROVE_LOCKING=y
+CONFIG_ENABLE_DEFAULT_TRACERS=y
--
2.34.1
Import the libvhost-user from QEMU for use in the implementation of the
virtio devices in the roadtest backend.
The files are from the following paths in v6.2.0 of QEMU:
include/qemu/atomic.h
subprojects/libvhost-user/libvhost-user.c
subprojects/libvhost-user/libvhost-user.h
In order to keep further imports strightforward, the files have been
copied as-is with only the following essential modifications:
- Addition of SPDX lines (GPL-2.0-or-later, in conformance with the
existing copyright messages in the files)
- Change of "standard-headers/linux/virtio_ring.h" to
<linux/virtio_ring.h> in libvhost-user.h. It will be built with the
headers from the current kernel.
Signed-off-by: Vincent Whitchurch <[email protected]>
---
.../src/libvhost-user/include/atomic.h | 310 ++
.../src/libvhost-user/libvhost-user.c | 2885 +++++++++++++++++
.../src/libvhost-user/libvhost-user.h | 691 ++++
3 files changed, 3886 insertions(+)
create mode 100644 tools/testing/roadtest/src/libvhost-user/include/atomic.h
create mode 100644 tools/testing/roadtest/src/libvhost-user/libvhost-user.c
create mode 100644 tools/testing/roadtest/src/libvhost-user/libvhost-user.h
diff --git a/tools/testing/roadtest/src/libvhost-user/include/atomic.h b/tools/testing/roadtest/src/libvhost-user/include/atomic.h
new file mode 100644
index 000000000000..65026bf54406
--- /dev/null
+++ b/tools/testing/roadtest/src/libvhost-user/include/atomic.h
@@ -0,0 +1,310 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Simple interface for atomic operations.
+ *
+ * Copyright (C) 2013 Red Hat, Inc.
+ *
+ * Author: Paolo Bonzini <[email protected]>
+ *
+ * This work is licensed under the terms of the GNU GPL, version 2 or later.
+ * See the COPYING file in the top-level directory.
+ *
+ * See docs/devel/atomics.rst for discussion about the guarantees each
+ * atomic primitive is meant to provide.
+ */
+
+#ifndef QEMU_ATOMIC_H
+#define QEMU_ATOMIC_H
+
+/* Compiler barrier */
+#define barrier() ({ asm volatile("" ::: "memory"); (void)0; })
+
+/* The variable that receives the old value of an atomically-accessed
+ * variable must be non-qualified, because atomic builtins return values
+ * through a pointer-type argument as in __atomic_load(&var, &old, MODEL).
+ *
+ * This macro has to handle types smaller than int manually, because of
+ * implicit promotion. int and larger types, as well as pointers, can be
+ * converted to a non-qualified type just by applying a binary operator.
+ */
+#define typeof_strip_qual(expr) \
+ typeof( \
+ __builtin_choose_expr( \
+ __builtin_types_compatible_p(typeof(expr), bool) || \
+ __builtin_types_compatible_p(typeof(expr), const bool) || \
+ __builtin_types_compatible_p(typeof(expr), volatile bool) || \
+ __builtin_types_compatible_p(typeof(expr), const volatile bool), \
+ (bool)1, \
+ __builtin_choose_expr( \
+ __builtin_types_compatible_p(typeof(expr), signed char) || \
+ __builtin_types_compatible_p(typeof(expr), const signed char) || \
+ __builtin_types_compatible_p(typeof(expr), volatile signed char) || \
+ __builtin_types_compatible_p(typeof(expr), const volatile signed char), \
+ (signed char)1, \
+ __builtin_choose_expr( \
+ __builtin_types_compatible_p(typeof(expr), unsigned char) || \
+ __builtin_types_compatible_p(typeof(expr), const unsigned char) || \
+ __builtin_types_compatible_p(typeof(expr), volatile unsigned char) || \
+ __builtin_types_compatible_p(typeof(expr), const volatile unsigned char), \
+ (unsigned char)1, \
+ __builtin_choose_expr( \
+ __builtin_types_compatible_p(typeof(expr), signed short) || \
+ __builtin_types_compatible_p(typeof(expr), const signed short) || \
+ __builtin_types_compatible_p(typeof(expr), volatile signed short) || \
+ __builtin_types_compatible_p(typeof(expr), const volatile signed short), \
+ (signed short)1, \
+ __builtin_choose_expr( \
+ __builtin_types_compatible_p(typeof(expr), unsigned short) || \
+ __builtin_types_compatible_p(typeof(expr), const unsigned short) || \
+ __builtin_types_compatible_p(typeof(expr), volatile unsigned short) || \
+ __builtin_types_compatible_p(typeof(expr), const volatile unsigned short), \
+ (unsigned short)1, \
+ (expr)+0))))))
+
+#ifndef __ATOMIC_RELAXED
+#error "Expecting C11 atomic ops"
+#endif
+
+/* Manual memory barriers
+ *
+ *__atomic_thread_fence does not include a compiler barrier; instead,
+ * the barrier is part of __atomic_load/__atomic_store's "volatile-like"
+ * semantics. If smp_wmb() is a no-op, absence of the barrier means that
+ * the compiler is free to reorder stores on each side of the barrier.
+ * Add one here, and similarly in smp_rmb() and smp_read_barrier_depends().
+ */
+
+#define smp_mb() ({ barrier(); __atomic_thread_fence(__ATOMIC_SEQ_CST); })
+#define smp_mb_release() ({ barrier(); __atomic_thread_fence(__ATOMIC_RELEASE); })
+#define smp_mb_acquire() ({ barrier(); __atomic_thread_fence(__ATOMIC_ACQUIRE); })
+
+/* Most compilers currently treat consume and acquire the same, but really
+ * no processors except Alpha need a barrier here. Leave it in if
+ * using Thread Sanitizer to avoid warnings, otherwise optimize it away.
+ */
+#if defined(__SANITIZE_THREAD__)
+#define smp_read_barrier_depends() ({ barrier(); __atomic_thread_fence(__ATOMIC_CONSUME); })
+#elif defined(__alpha__)
+#define smp_read_barrier_depends() asm volatile("mb":::"memory")
+#else
+#define smp_read_barrier_depends() barrier()
+#endif
+
+/*
+ * A signal barrier forces all pending local memory ops to be observed before
+ * a SIGSEGV is delivered to the *same* thread. In practice this is exactly
+ * the same as barrier(), but since we have the correct builtin, use it.
+ */
+#define signal_barrier() __atomic_signal_fence(__ATOMIC_SEQ_CST)
+
+/* Sanity check that the size of an atomic operation isn't "overly large".
+ * Despite the fact that e.g. i686 has 64-bit atomic operations, we do not
+ * want to use them because we ought not need them, and this lets us do a
+ * bit of sanity checking that other 32-bit hosts might build.
+ *
+ * That said, we have a problem on 64-bit ILP32 hosts in that in order to
+ * sync with TCG_OVERSIZED_GUEST, this must match TCG_TARGET_REG_BITS.
+ * We'd prefer not want to pull in everything else TCG related, so handle
+ * those few cases by hand.
+ *
+ * Note that x32 is fully detected with __x86_64__ + _ILP32, and that for
+ * Sparc we always force the use of sparcv9 in configure. MIPS n32 (ILP32) &
+ * n64 (LP64) ABIs are both detected using __mips64.
+ */
+#if defined(__x86_64__) || defined(__sparc__) || defined(__mips64)
+# define ATOMIC_REG_SIZE 8
+#else
+# define ATOMIC_REG_SIZE sizeof(void *)
+#endif
+
+/* Weak atomic operations prevent the compiler moving other
+ * loads/stores past the atomic operation load/store. However there is
+ * no explicit memory barrier for the processor.
+ *
+ * The C11 memory model says that variables that are accessed from
+ * different threads should at least be done with __ATOMIC_RELAXED
+ * primitives or the result is undefined. Generally this has little to
+ * no effect on the generated code but not using the atomic primitives
+ * will get flagged by sanitizers as a violation.
+ */
+#define qatomic_read__nocheck(ptr) \
+ __atomic_load_n(ptr, __ATOMIC_RELAXED)
+
+#define qatomic_read(ptr) \
+ ({ \
+ QEMU_BUILD_BUG_ON(sizeof(*ptr) > ATOMIC_REG_SIZE); \
+ qatomic_read__nocheck(ptr); \
+ })
+
+#define qatomic_set__nocheck(ptr, i) \
+ __atomic_store_n(ptr, i, __ATOMIC_RELAXED)
+
+#define qatomic_set(ptr, i) do { \
+ QEMU_BUILD_BUG_ON(sizeof(*ptr) > ATOMIC_REG_SIZE); \
+ qatomic_set__nocheck(ptr, i); \
+} while(0)
+
+/* See above: most compilers currently treat consume and acquire the
+ * same, but this slows down qatomic_rcu_read unnecessarily.
+ */
+#ifdef __SANITIZE_THREAD__
+#define qatomic_rcu_read__nocheck(ptr, valptr) \
+ __atomic_load(ptr, valptr, __ATOMIC_CONSUME);
+#else
+#define qatomic_rcu_read__nocheck(ptr, valptr) \
+ __atomic_load(ptr, valptr, __ATOMIC_RELAXED); \
+ smp_read_barrier_depends();
+#endif
+
+#define qatomic_rcu_read(ptr) \
+ ({ \
+ QEMU_BUILD_BUG_ON(sizeof(*ptr) > ATOMIC_REG_SIZE); \
+ typeof_strip_qual(*ptr) _val; \
+ qatomic_rcu_read__nocheck(ptr, &_val); \
+ _val; \
+ })
+
+#define qatomic_rcu_set(ptr, i) do { \
+ QEMU_BUILD_BUG_ON(sizeof(*ptr) > ATOMIC_REG_SIZE); \
+ __atomic_store_n(ptr, i, __ATOMIC_RELEASE); \
+} while(0)
+
+#define qatomic_load_acquire(ptr) \
+ ({ \
+ QEMU_BUILD_BUG_ON(sizeof(*ptr) > ATOMIC_REG_SIZE); \
+ typeof_strip_qual(*ptr) _val; \
+ __atomic_load(ptr, &_val, __ATOMIC_ACQUIRE); \
+ _val; \
+ })
+
+#define qatomic_store_release(ptr, i) do { \
+ QEMU_BUILD_BUG_ON(sizeof(*ptr) > ATOMIC_REG_SIZE); \
+ __atomic_store_n(ptr, i, __ATOMIC_RELEASE); \
+} while(0)
+
+
+/* All the remaining operations are fully sequentially consistent */
+
+#define qatomic_xchg__nocheck(ptr, i) ({ \
+ __atomic_exchange_n(ptr, (i), __ATOMIC_SEQ_CST); \
+})
+
+#define qatomic_xchg(ptr, i) ({ \
+ QEMU_BUILD_BUG_ON(sizeof(*ptr) > ATOMIC_REG_SIZE); \
+ qatomic_xchg__nocheck(ptr, i); \
+})
+
+/* Returns the eventual value, failed or not */
+#define qatomic_cmpxchg__nocheck(ptr, old, new) ({ \
+ typeof_strip_qual(*ptr) _old = (old); \
+ (void)__atomic_compare_exchange_n(ptr, &_old, new, false, \
+ __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST); \
+ _old; \
+})
+
+#define qatomic_cmpxchg(ptr, old, new) ({ \
+ QEMU_BUILD_BUG_ON(sizeof(*ptr) > ATOMIC_REG_SIZE); \
+ qatomic_cmpxchg__nocheck(ptr, old, new); \
+})
+
+/* Provide shorter names for GCC atomic builtins, return old value */
+#define qatomic_fetch_inc(ptr) __atomic_fetch_add(ptr, 1, __ATOMIC_SEQ_CST)
+#define qatomic_fetch_dec(ptr) __atomic_fetch_sub(ptr, 1, __ATOMIC_SEQ_CST)
+
+#define qatomic_fetch_add(ptr, n) __atomic_fetch_add(ptr, n, __ATOMIC_SEQ_CST)
+#define qatomic_fetch_sub(ptr, n) __atomic_fetch_sub(ptr, n, __ATOMIC_SEQ_CST)
+#define qatomic_fetch_and(ptr, n) __atomic_fetch_and(ptr, n, __ATOMIC_SEQ_CST)
+#define qatomic_fetch_or(ptr, n) __atomic_fetch_or(ptr, n, __ATOMIC_SEQ_CST)
+#define qatomic_fetch_xor(ptr, n) __atomic_fetch_xor(ptr, n, __ATOMIC_SEQ_CST)
+
+#define qatomic_inc_fetch(ptr) __atomic_add_fetch(ptr, 1, __ATOMIC_SEQ_CST)
+#define qatomic_dec_fetch(ptr) __atomic_sub_fetch(ptr, 1, __ATOMIC_SEQ_CST)
+#define qatomic_add_fetch(ptr, n) __atomic_add_fetch(ptr, n, __ATOMIC_SEQ_CST)
+#define qatomic_sub_fetch(ptr, n) __atomic_sub_fetch(ptr, n, __ATOMIC_SEQ_CST)
+#define qatomic_and_fetch(ptr, n) __atomic_and_fetch(ptr, n, __ATOMIC_SEQ_CST)
+#define qatomic_or_fetch(ptr, n) __atomic_or_fetch(ptr, n, __ATOMIC_SEQ_CST)
+#define qatomic_xor_fetch(ptr, n) __atomic_xor_fetch(ptr, n, __ATOMIC_SEQ_CST)
+
+/* And even shorter names that return void. */
+#define qatomic_inc(ptr) \
+ ((void) __atomic_fetch_add(ptr, 1, __ATOMIC_SEQ_CST))
+#define qatomic_dec(ptr) \
+ ((void) __atomic_fetch_sub(ptr, 1, __ATOMIC_SEQ_CST))
+#define qatomic_add(ptr, n) \
+ ((void) __atomic_fetch_add(ptr, n, __ATOMIC_SEQ_CST))
+#define qatomic_sub(ptr, n) \
+ ((void) __atomic_fetch_sub(ptr, n, __ATOMIC_SEQ_CST))
+#define qatomic_and(ptr, n) \
+ ((void) __atomic_fetch_and(ptr, n, __ATOMIC_SEQ_CST))
+#define qatomic_or(ptr, n) \
+ ((void) __atomic_fetch_or(ptr, n, __ATOMIC_SEQ_CST))
+#define qatomic_xor(ptr, n) \
+ ((void) __atomic_fetch_xor(ptr, n, __ATOMIC_SEQ_CST))
+
+#define smp_wmb() smp_mb_release()
+#define smp_rmb() smp_mb_acquire()
+
+/* qatomic_mb_read/set semantics map Java volatile variables. They are
+ * less expensive on some platforms (notably POWER) than fully
+ * sequentially consistent operations.
+ *
+ * As long as they are used as paired operations they are safe to
+ * use. See docs/devel/atomics.rst for more discussion.
+ */
+
+#define qatomic_mb_read(ptr) \
+ qatomic_load_acquire(ptr)
+
+#if !defined(__SANITIZE_THREAD__) && \
+ (defined(__i386__) || defined(__x86_64__) || defined(__s390x__))
+/* This is more efficient than a store plus a fence. */
+# define qatomic_mb_set(ptr, i) ((void)qatomic_xchg(ptr, i))
+#else
+# define qatomic_mb_set(ptr, i) \
+ ({ qatomic_store_release(ptr, i); smp_mb(); })
+#endif
+
+#define qatomic_fetch_inc_nonzero(ptr) ({ \
+ typeof_strip_qual(*ptr) _oldn = qatomic_read(ptr); \
+ while (_oldn && qatomic_cmpxchg(ptr, _oldn, _oldn + 1) != _oldn) { \
+ _oldn = qatomic_read(ptr); \
+ } \
+ _oldn; \
+})
+
+/*
+ * Abstractions to access atomically (i.e. "once") i64/u64 variables.
+ *
+ * The i386 abi is odd in that by default members are only aligned to
+ * 4 bytes, which means that 8-byte types can wind up mis-aligned.
+ * Clang will then warn about this, and emit a call into libatomic.
+ *
+ * Use of these types in structures when they will be used with atomic
+ * operations can avoid this.
+ */
+typedef int64_t aligned_int64_t __attribute__((aligned(8)));
+typedef uint64_t aligned_uint64_t __attribute__((aligned(8)));
+
+#ifdef CONFIG_ATOMIC64
+/* Use __nocheck because sizeof(void *) might be < sizeof(u64) */
+#define qatomic_read_i64(P) \
+ _Generic(*(P), int64_t: qatomic_read__nocheck(P))
+#define qatomic_read_u64(P) \
+ _Generic(*(P), uint64_t: qatomic_read__nocheck(P))
+#define qatomic_set_i64(P, V) \
+ _Generic(*(P), int64_t: qatomic_set__nocheck(P, V))
+#define qatomic_set_u64(P, V) \
+ _Generic(*(P), uint64_t: qatomic_set__nocheck(P, V))
+
+static inline void qatomic64_init(void)
+{
+}
+#else /* !CONFIG_ATOMIC64 */
+int64_t qatomic_read_i64(const int64_t *ptr);
+uint64_t qatomic_read_u64(const uint64_t *ptr);
+void qatomic_set_i64(int64_t *ptr, int64_t val);
+void qatomic_set_u64(uint64_t *ptr, uint64_t val);
+void qatomic64_init(void);
+#endif /* !CONFIG_ATOMIC64 */
+
+#endif /* QEMU_ATOMIC_H */
diff --git a/tools/testing/roadtest/src/libvhost-user/libvhost-user.c b/tools/testing/roadtest/src/libvhost-user/libvhost-user.c
new file mode 100644
index 000000000000..1e6dddfb10df
--- /dev/null
+++ b/tools/testing/roadtest/src/libvhost-user/libvhost-user.c
@@ -0,0 +1,2885 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Vhost User library
+ *
+ * Copyright IBM, Corp. 2007
+ * Copyright (c) 2016 Red Hat, Inc.
+ *
+ * Authors:
+ * Anthony Liguori <[email protected]>
+ * Marc-André Lureau <[email protected]>
+ * Victor Kaplansky <[email protected]>
+ *
+ * This work is licensed under the terms of the GNU GPL, version 2 or
+ * later. See the COPYING file in the top-level directory.
+ */
+
+/* this code avoids GLib dependency */
+#include <stdlib.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <stdarg.h>
+#include <errno.h>
+#include <string.h>
+#include <assert.h>
+#include <inttypes.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/eventfd.h>
+#include <sys/mman.h>
+#include <endian.h>
+
+#if defined(__linux__)
+#include <sys/syscall.h>
+#include <fcntl.h>
+#include <sys/ioctl.h>
+#include <linux/vhost.h>
+
+#ifdef __NR_userfaultfd
+#include <linux/userfaultfd.h>
+#endif
+
+#endif
+
+#include "include/atomic.h"
+
+#include "libvhost-user.h"
+
+/* usually provided by GLib */
+#ifndef MIN
+#define MIN(x, y) ({ \
+ typeof(x) _min1 = (x); \
+ typeof(y) _min2 = (y); \
+ (void) (&_min1 == &_min2); \
+ _min1 < _min2 ? _min1 : _min2; })
+#endif
+
+/* Round number down to multiple */
+#define ALIGN_DOWN(n, m) ((n) / (m) * (m))
+
+/* Round number up to multiple */
+#define ALIGN_UP(n, m) ALIGN_DOWN((n) + (m) - 1, (m))
+
+#ifndef unlikely
+#define unlikely(x) __builtin_expect(!!(x), 0)
+#endif
+
+/* Align each region to cache line size in inflight buffer */
+#define INFLIGHT_ALIGNMENT 64
+
+/* The version of inflight buffer */
+#define INFLIGHT_VERSION 1
+
+/* The version of the protocol we support */
+#define VHOST_USER_VERSION 1
+#define LIBVHOST_USER_DEBUG 0
+
+#define DPRINT(...) \
+ do { \
+ if (LIBVHOST_USER_DEBUG) { \
+ fprintf(stderr, __VA_ARGS__); \
+ } \
+ } while (0)
+
+static inline
+bool has_feature(uint64_t features, unsigned int fbit)
+{
+ assert(fbit < 64);
+ return !!(features & (1ULL << fbit));
+}
+
+static inline
+bool vu_has_feature(VuDev *dev,
+ unsigned int fbit)
+{
+ return has_feature(dev->features, fbit);
+}
+
+static inline bool vu_has_protocol_feature(VuDev *dev, unsigned int fbit)
+{
+ return has_feature(dev->protocol_features, fbit);
+}
+
+static const char *
+vu_request_to_string(unsigned int req)
+{
+#define REQ(req) [req] = #req
+ static const char *vu_request_str[] = {
+ REQ(VHOST_USER_NONE),
+ REQ(VHOST_USER_GET_FEATURES),
+ REQ(VHOST_USER_SET_FEATURES),
+ REQ(VHOST_USER_SET_OWNER),
+ REQ(VHOST_USER_RESET_OWNER),
+ REQ(VHOST_USER_SET_MEM_TABLE),
+ REQ(VHOST_USER_SET_LOG_BASE),
+ REQ(VHOST_USER_SET_LOG_FD),
+ REQ(VHOST_USER_SET_VRING_NUM),
+ REQ(VHOST_USER_SET_VRING_ADDR),
+ REQ(VHOST_USER_SET_VRING_BASE),
+ REQ(VHOST_USER_GET_VRING_BASE),
+ REQ(VHOST_USER_SET_VRING_KICK),
+ REQ(VHOST_USER_SET_VRING_CALL),
+ REQ(VHOST_USER_SET_VRING_ERR),
+ REQ(VHOST_USER_GET_PROTOCOL_FEATURES),
+ REQ(VHOST_USER_SET_PROTOCOL_FEATURES),
+ REQ(VHOST_USER_GET_QUEUE_NUM),
+ REQ(VHOST_USER_SET_VRING_ENABLE),
+ REQ(VHOST_USER_SEND_RARP),
+ REQ(VHOST_USER_NET_SET_MTU),
+ REQ(VHOST_USER_SET_SLAVE_REQ_FD),
+ REQ(VHOST_USER_IOTLB_MSG),
+ REQ(VHOST_USER_SET_VRING_ENDIAN),
+ REQ(VHOST_USER_GET_CONFIG),
+ REQ(VHOST_USER_SET_CONFIG),
+ REQ(VHOST_USER_POSTCOPY_ADVISE),
+ REQ(VHOST_USER_POSTCOPY_LISTEN),
+ REQ(VHOST_USER_POSTCOPY_END),
+ REQ(VHOST_USER_GET_INFLIGHT_FD),
+ REQ(VHOST_USER_SET_INFLIGHT_FD),
+ REQ(VHOST_USER_GPU_SET_SOCKET),
+ REQ(VHOST_USER_VRING_KICK),
+ REQ(VHOST_USER_GET_MAX_MEM_SLOTS),
+ REQ(VHOST_USER_ADD_MEM_REG),
+ REQ(VHOST_USER_REM_MEM_REG),
+ REQ(VHOST_USER_MAX),
+ };
+#undef REQ
+
+ if (req < VHOST_USER_MAX) {
+ return vu_request_str[req];
+ } else {
+ return "unknown";
+ }
+}
+
+static void
+vu_panic(VuDev *dev, const char *msg, ...)
+{
+ char *buf = NULL;
+ va_list ap;
+
+ va_start(ap, msg);
+ if (vasprintf(&buf, msg, ap) < 0) {
+ buf = NULL;
+ }
+ va_end(ap);
+
+ dev->broken = true;
+ dev->panic(dev, buf);
+ free(buf);
+
+ /*
+ * FIXME:
+ * find a way to call virtio_error, or perhaps close the connection?
+ */
+}
+
+/* Translate guest physical address to our virtual address. */
+void *
+vu_gpa_to_va(VuDev *dev, uint64_t *plen, uint64_t guest_addr)
+{
+ int i;
+
+ if (*plen == 0) {
+ return NULL;
+ }
+
+ /* Find matching memory region. */
+ for (i = 0; i < dev->nregions; i++) {
+ VuDevRegion *r = &dev->regions[i];
+
+ if ((guest_addr >= r->gpa) && (guest_addr < (r->gpa + r->size))) {
+ if ((guest_addr + *plen) > (r->gpa + r->size)) {
+ *plen = r->gpa + r->size - guest_addr;
+ }
+ return (void *)(uintptr_t)
+ guest_addr - r->gpa + r->mmap_addr + r->mmap_offset;
+ }
+ }
+
+ return NULL;
+}
+
+/* Translate qemu virtual address to our virtual address. */
+static void *
+qva_to_va(VuDev *dev, uint64_t qemu_addr)
+{
+ int i;
+
+ /* Find matching memory region. */
+ for (i = 0; i < dev->nregions; i++) {
+ VuDevRegion *r = &dev->regions[i];
+
+ if ((qemu_addr >= r->qva) && (qemu_addr < (r->qva + r->size))) {
+ return (void *)(uintptr_t)
+ qemu_addr - r->qva + r->mmap_addr + r->mmap_offset;
+ }
+ }
+
+ return NULL;
+}
+
+static void
+vmsg_close_fds(VhostUserMsg *vmsg)
+{
+ int i;
+
+ for (i = 0; i < vmsg->fd_num; i++) {
+ close(vmsg->fds[i]);
+ }
+}
+
+/* Set reply payload.u64 and clear request flags and fd_num */
+static void vmsg_set_reply_u64(VhostUserMsg *vmsg, uint64_t val)
+{
+ vmsg->flags = 0; /* defaults will be set by vu_send_reply() */
+ vmsg->size = sizeof(vmsg->payload.u64);
+ vmsg->payload.u64 = val;
+ vmsg->fd_num = 0;
+}
+
+/* A test to see if we have userfault available */
+static bool
+have_userfault(void)
+{
+#if defined(__linux__) && defined(__NR_userfaultfd) &&\
+ defined(UFFD_FEATURE_MISSING_SHMEM) &&\
+ defined(UFFD_FEATURE_MISSING_HUGETLBFS)
+ /* Now test the kernel we're running on really has the features */
+ int ufd = syscall(__NR_userfaultfd, O_CLOEXEC | O_NONBLOCK);
+ struct uffdio_api api_struct;
+ if (ufd < 0) {
+ return false;
+ }
+
+ api_struct.api = UFFD_API;
+ api_struct.features = UFFD_FEATURE_MISSING_SHMEM |
+ UFFD_FEATURE_MISSING_HUGETLBFS;
+ if (ioctl(ufd, UFFDIO_API, &api_struct)) {
+ close(ufd);
+ return false;
+ }
+ close(ufd);
+ return true;
+
+#else
+ return false;
+#endif
+}
+
+static bool
+vu_message_read_default(VuDev *dev, int conn_fd, VhostUserMsg *vmsg)
+{
+ char control[CMSG_SPACE(VHOST_MEMORY_BASELINE_NREGIONS * sizeof(int))] = {};
+ struct iovec iov = {
+ .iov_base = (char *)vmsg,
+ .iov_len = VHOST_USER_HDR_SIZE,
+ };
+ struct msghdr msg = {
+ .msg_iov = &iov,
+ .msg_iovlen = 1,
+ .msg_control = control,
+ .msg_controllen = sizeof(control),
+ };
+ size_t fd_size;
+ struct cmsghdr *cmsg;
+ int rc;
+
+ do {
+ rc = recvmsg(conn_fd, &msg, 0);
+ } while (rc < 0 && (errno == EINTR || errno == EAGAIN));
+
+ if (rc < 0) {
+ vu_panic(dev, "Error while recvmsg: %s", strerror(errno));
+ return false;
+ }
+
+ vmsg->fd_num = 0;
+ for (cmsg = CMSG_FIRSTHDR(&msg);
+ cmsg != NULL;
+ cmsg = CMSG_NXTHDR(&msg, cmsg))
+ {
+ if (cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type == SCM_RIGHTS) {
+ fd_size = cmsg->cmsg_len - CMSG_LEN(0);
+ vmsg->fd_num = fd_size / sizeof(int);
+ memcpy(vmsg->fds, CMSG_DATA(cmsg), fd_size);
+ break;
+ }
+ }
+
+ if (vmsg->size > sizeof(vmsg->payload)) {
+ vu_panic(dev,
+ "Error: too big message request: %d, size: vmsg->size: %u, "
+ "while sizeof(vmsg->payload) = %zu\n",
+ vmsg->request, vmsg->size, sizeof(vmsg->payload));
+ goto fail;
+ }
+
+ if (vmsg->size) {
+ do {
+ rc = read(conn_fd, &vmsg->payload, vmsg->size);
+ } while (rc < 0 && (errno == EINTR || errno == EAGAIN));
+
+ if (rc <= 0) {
+ vu_panic(dev, "Error while reading: %s", strerror(errno));
+ goto fail;
+ }
+
+ assert(rc == vmsg->size);
+ }
+
+ return true;
+
+fail:
+ vmsg_close_fds(vmsg);
+
+ return false;
+}
+
+static bool
+vu_message_write(VuDev *dev, int conn_fd, VhostUserMsg *vmsg)
+{
+ int rc;
+ uint8_t *p = (uint8_t *)vmsg;
+ char control[CMSG_SPACE(VHOST_MEMORY_BASELINE_NREGIONS * sizeof(int))] = {};
+ struct iovec iov = {
+ .iov_base = (char *)vmsg,
+ .iov_len = VHOST_USER_HDR_SIZE,
+ };
+ struct msghdr msg = {
+ .msg_iov = &iov,
+ .msg_iovlen = 1,
+ .msg_control = control,
+ };
+ struct cmsghdr *cmsg;
+
+ memset(control, 0, sizeof(control));
+ assert(vmsg->fd_num <= VHOST_MEMORY_BASELINE_NREGIONS);
+ if (vmsg->fd_num > 0) {
+ size_t fdsize = vmsg->fd_num * sizeof(int);
+ msg.msg_controllen = CMSG_SPACE(fdsize);
+ cmsg = CMSG_FIRSTHDR(&msg);
+ cmsg->cmsg_len = CMSG_LEN(fdsize);
+ cmsg->cmsg_level = SOL_SOCKET;
+ cmsg->cmsg_type = SCM_RIGHTS;
+ memcpy(CMSG_DATA(cmsg), vmsg->fds, fdsize);
+ } else {
+ msg.msg_controllen = 0;
+ }
+
+ do {
+ rc = sendmsg(conn_fd, &msg, 0);
+ } while (rc < 0 && (errno == EINTR || errno == EAGAIN));
+
+ if (vmsg->size) {
+ do {
+ if (vmsg->data) {
+ rc = write(conn_fd, vmsg->data, vmsg->size);
+ } else {
+ rc = write(conn_fd, p + VHOST_USER_HDR_SIZE, vmsg->size);
+ }
+ } while (rc < 0 && (errno == EINTR || errno == EAGAIN));
+ }
+
+ if (rc <= 0) {
+ vu_panic(dev, "Error while writing: %s", strerror(errno));
+ return false;
+ }
+
+ return true;
+}
+
+static bool
+vu_send_reply(VuDev *dev, int conn_fd, VhostUserMsg *vmsg)
+{
+ /* Set the version in the flags when sending the reply */
+ vmsg->flags &= ~VHOST_USER_VERSION_MASK;
+ vmsg->flags |= VHOST_USER_VERSION;
+ vmsg->flags |= VHOST_USER_REPLY_MASK;
+
+ return vu_message_write(dev, conn_fd, vmsg);
+}
+
+/*
+ * Processes a reply on the slave channel.
+ * Entered with slave_mutex held and releases it before exit.
+ * Returns true on success.
+ */
+static bool
+vu_process_message_reply(VuDev *dev, const VhostUserMsg *vmsg)
+{
+ VhostUserMsg msg_reply;
+ bool result = false;
+
+ if ((vmsg->flags & VHOST_USER_NEED_REPLY_MASK) == 0) {
+ result = true;
+ goto out;
+ }
+
+ if (!vu_message_read_default(dev, dev->slave_fd, &msg_reply)) {
+ goto out;
+ }
+
+ if (msg_reply.request != vmsg->request) {
+ DPRINT("Received unexpected msg type. Expected %d received %d",
+ vmsg->request, msg_reply.request);
+ goto out;
+ }
+
+ result = msg_reply.payload.u64 == 0;
+
+out:
+ pthread_mutex_unlock(&dev->slave_mutex);
+ return result;
+}
+
+/* Kick the log_call_fd if required. */
+static void
+vu_log_kick(VuDev *dev)
+{
+ if (dev->log_call_fd != -1) {
+ DPRINT("Kicking the QEMU's log...\n");
+ if (eventfd_write(dev->log_call_fd, 1) < 0) {
+ vu_panic(dev, "Error writing eventfd: %s", strerror(errno));
+ }
+ }
+}
+
+static void
+vu_log_page(uint8_t *log_table, uint64_t page)
+{
+ DPRINT("Logged dirty guest page: %"PRId64"\n", page);
+ qatomic_or(&log_table[page / 8], 1 << (page % 8));
+}
+
+static void
+vu_log_write(VuDev *dev, uint64_t address, uint64_t length)
+{
+ uint64_t page;
+
+ if (!(dev->features & (1ULL << VHOST_F_LOG_ALL)) ||
+ !dev->log_table || !length) {
+ return;
+ }
+
+ assert(dev->log_size > ((address + length - 1) / VHOST_LOG_PAGE / 8));
+
+ page = address / VHOST_LOG_PAGE;
+ while (page * VHOST_LOG_PAGE < address + length) {
+ vu_log_page(dev->log_table, page);
+ page += 1;
+ }
+
+ vu_log_kick(dev);
+}
+
+static void
+vu_kick_cb(VuDev *dev, int condition, void *data)
+{
+ int index = (intptr_t)data;
+ VuVirtq *vq = &dev->vq[index];
+ int sock = vq->kick_fd;
+ eventfd_t kick_data;
+ ssize_t rc;
+
+ rc = eventfd_read(sock, &kick_data);
+ if (rc == -1) {
+ vu_panic(dev, "kick eventfd_read(): %s", strerror(errno));
+ dev->remove_watch(dev, dev->vq[index].kick_fd);
+ } else {
+ DPRINT("Got kick_data: %016"PRIx64" handler:%p idx:%d\n",
+ kick_data, vq->handler, index);
+ if (vq->handler) {
+ vq->handler(dev, index);
+ }
+ }
+}
+
+static bool
+vu_get_features_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ vmsg->payload.u64 =
+ /*
+ * The following VIRTIO feature bits are supported by our virtqueue
+ * implementation:
+ */
+ 1ULL << VIRTIO_F_NOTIFY_ON_EMPTY |
+ 1ULL << VIRTIO_RING_F_INDIRECT_DESC |
+ 1ULL << VIRTIO_RING_F_EVENT_IDX |
+ 1ULL << VIRTIO_F_VERSION_1 |
+
+ /* vhost-user feature bits */
+ 1ULL << VHOST_F_LOG_ALL |
+ 1ULL << VHOST_USER_F_PROTOCOL_FEATURES;
+
+ if (dev->iface->get_features) {
+ vmsg->payload.u64 |= dev->iface->get_features(dev);
+ }
+
+ vmsg->size = sizeof(vmsg->payload.u64);
+ vmsg->fd_num = 0;
+
+ DPRINT("Sending back to guest u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
+
+ return true;
+}
+
+static void
+vu_set_enable_all_rings(VuDev *dev, bool enabled)
+{
+ uint16_t i;
+
+ for (i = 0; i < dev->max_queues; i++) {
+ dev->vq[i].enable = enabled;
+ }
+}
+
+static bool
+vu_set_features_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ DPRINT("u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
+
+ dev->features = vmsg->payload.u64;
+ if (!vu_has_feature(dev, VIRTIO_F_VERSION_1)) {
+ /*
+ * We only support devices conforming to VIRTIO 1.0 or
+ * later
+ */
+ vu_panic(dev, "virtio legacy devices aren't supported by libvhost-user");
+ return false;
+ }
+
+ if (!(dev->features & VHOST_USER_F_PROTOCOL_FEATURES)) {
+ vu_set_enable_all_rings(dev, true);
+ }
+
+ if (dev->iface->set_features) {
+ dev->iface->set_features(dev, dev->features);
+ }
+
+ return false;
+}
+
+static bool
+vu_set_owner_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ return false;
+}
+
+static void
+vu_close_log(VuDev *dev)
+{
+ if (dev->log_table) {
+ if (munmap(dev->log_table, dev->log_size) != 0) {
+ perror("close log munmap() error");
+ }
+
+ dev->log_table = NULL;
+ }
+ if (dev->log_call_fd != -1) {
+ close(dev->log_call_fd);
+ dev->log_call_fd = -1;
+ }
+}
+
+static bool
+vu_reset_device_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ vu_set_enable_all_rings(dev, false);
+
+ return false;
+}
+
+static bool
+map_ring(VuDev *dev, VuVirtq *vq)
+{
+ vq->vring.desc = qva_to_va(dev, vq->vra.desc_user_addr);
+ vq->vring.used = qva_to_va(dev, vq->vra.used_user_addr);
+ vq->vring.avail = qva_to_va(dev, vq->vra.avail_user_addr);
+
+ DPRINT("Setting virtq addresses:\n");
+ DPRINT(" vring_desc at %p\n", vq->vring.desc);
+ DPRINT(" vring_used at %p\n", vq->vring.used);
+ DPRINT(" vring_avail at %p\n", vq->vring.avail);
+
+ return !(vq->vring.desc && vq->vring.used && vq->vring.avail);
+}
+
+static bool
+generate_faults(VuDev *dev) {
+ int i;
+ for (i = 0; i < dev->nregions; i++) {
+ VuDevRegion *dev_region = &dev->regions[i];
+ int ret;
+#ifdef UFFDIO_REGISTER
+ /*
+ * We should already have an open ufd. Mark each memory
+ * range as ufd.
+ * Discard any mapping we have here; note I can't use MADV_REMOVE
+ * or fallocate to make the hole since I don't want to lose
+ * data that's already arrived in the shared process.
+ * TODO: How to do hugepage
+ */
+ ret = madvise((void *)(uintptr_t)dev_region->mmap_addr,
+ dev_region->size + dev_region->mmap_offset,
+ MADV_DONTNEED);
+ if (ret) {
+ fprintf(stderr,
+ "%s: Failed to madvise(DONTNEED) region %d: %s\n",
+ __func__, i, strerror(errno));
+ }
+ /*
+ * Turn off transparent hugepages so we dont get lose wakeups
+ * in neighbouring pages.
+ * TODO: Turn this backon later.
+ */
+ ret = madvise((void *)(uintptr_t)dev_region->mmap_addr,
+ dev_region->size + dev_region->mmap_offset,
+ MADV_NOHUGEPAGE);
+ if (ret) {
+ /*
+ * Note: This can happen legally on kernels that are configured
+ * without madvise'able hugepages
+ */
+ fprintf(stderr,
+ "%s: Failed to madvise(NOHUGEPAGE) region %d: %s\n",
+ __func__, i, strerror(errno));
+ }
+ struct uffdio_register reg_struct;
+ reg_struct.range.start = (uintptr_t)dev_region->mmap_addr;
+ reg_struct.range.len = dev_region->size + dev_region->mmap_offset;
+ reg_struct.mode = UFFDIO_REGISTER_MODE_MISSING;
+
+ if (ioctl(dev->postcopy_ufd, UFFDIO_REGISTER, ®_struct)) {
+ vu_panic(dev, "%s: Failed to userfault region %d "
+ "@%p + size:%zx offset: %zx: (ufd=%d)%s\n",
+ __func__, i,
+ dev_region->mmap_addr,
+ dev_region->size, dev_region->mmap_offset,
+ dev->postcopy_ufd, strerror(errno));
+ return false;
+ }
+ if (!(reg_struct.ioctls & ((__u64)1 << _UFFDIO_COPY))) {
+ vu_panic(dev, "%s Region (%d) doesn't support COPY",
+ __func__, i);
+ return false;
+ }
+ DPRINT("%s: region %d: Registered userfault for %"
+ PRIx64 " + %" PRIx64 "\n", __func__, i,
+ (uint64_t)reg_struct.range.start,
+ (uint64_t)reg_struct.range.len);
+ /* Now it's registered we can let the client at it */
+ if (mprotect((void *)(uintptr_t)dev_region->mmap_addr,
+ dev_region->size + dev_region->mmap_offset,
+ PROT_READ | PROT_WRITE)) {
+ vu_panic(dev, "failed to mprotect region %d for postcopy (%s)",
+ i, strerror(errno));
+ return false;
+ }
+ /* TODO: Stash 'zero' support flags somewhere */
+#endif
+ }
+
+ return true;
+}
+
+static bool
+vu_add_mem_reg(VuDev *dev, VhostUserMsg *vmsg) {
+ int i;
+ bool track_ramblocks = dev->postcopy_listening;
+ VhostUserMemoryRegion m = vmsg->payload.memreg.region, *msg_region = &m;
+ VuDevRegion *dev_region = &dev->regions[dev->nregions];
+ void *mmap_addr;
+
+ /*
+ * If we are in postcopy mode and we receive a u64 payload with a 0 value
+ * we know all the postcopy client bases have been received, and we
+ * should start generating faults.
+ */
+ if (track_ramblocks &&
+ vmsg->size == sizeof(vmsg->payload.u64) &&
+ vmsg->payload.u64 == 0) {
+ (void)generate_faults(dev);
+ return false;
+ }
+
+ DPRINT("Adding region: %u\n", dev->nregions);
+ DPRINT(" guest_phys_addr: 0x%016"PRIx64"\n",
+ msg_region->guest_phys_addr);
+ DPRINT(" memory_size: 0x%016"PRIx64"\n",
+ msg_region->memory_size);
+ DPRINT(" userspace_addr 0x%016"PRIx64"\n",
+ msg_region->userspace_addr);
+ DPRINT(" mmap_offset 0x%016"PRIx64"\n",
+ msg_region->mmap_offset);
+
+ dev_region->gpa = msg_region->guest_phys_addr;
+ dev_region->size = msg_region->memory_size;
+ dev_region->qva = msg_region->userspace_addr;
+ dev_region->mmap_offset = msg_region->mmap_offset;
+
+ /*
+ * We don't use offset argument of mmap() since the
+ * mapped address has to be page aligned, and we use huge
+ * pages.
+ */
+ if (track_ramblocks) {
+ /*
+ * In postcopy we're using PROT_NONE here to catch anyone
+ * accessing it before we userfault.
+ */
+ mmap_addr = mmap(0, dev_region->size + dev_region->mmap_offset,
+ PROT_NONE, MAP_SHARED,
+ vmsg->fds[0], 0);
+ } else {
+ mmap_addr = mmap(0, dev_region->size + dev_region->mmap_offset,
+ PROT_READ | PROT_WRITE, MAP_SHARED, vmsg->fds[0],
+ 0);
+ }
+
+ if (mmap_addr == MAP_FAILED) {
+ vu_panic(dev, "region mmap error: %s", strerror(errno));
+ } else {
+ dev_region->mmap_addr = (uint64_t)(uintptr_t)mmap_addr;
+ DPRINT(" mmap_addr: 0x%016"PRIx64"\n",
+ dev_region->mmap_addr);
+ }
+
+ close(vmsg->fds[0]);
+
+ if (track_ramblocks) {
+ /*
+ * Return the address to QEMU so that it can translate the ufd
+ * fault addresses back.
+ */
+ msg_region->userspace_addr = (uintptr_t)(mmap_addr +
+ dev_region->mmap_offset);
+
+ /* Send the message back to qemu with the addresses filled in. */
+ vmsg->fd_num = 0;
+ if (!vu_send_reply(dev, dev->sock, vmsg)) {
+ vu_panic(dev, "failed to respond to add-mem-region for postcopy");
+ return false;
+ }
+
+ DPRINT("Successfully added new region in postcopy\n");
+ dev->nregions++;
+ return false;
+
+ } else {
+ for (i = 0; i < dev->max_queues; i++) {
+ if (dev->vq[i].vring.desc) {
+ if (map_ring(dev, &dev->vq[i])) {
+ vu_panic(dev, "remapping queue %d for new memory region",
+ i);
+ }
+ }
+ }
+
+ DPRINT("Successfully added new region\n");
+ dev->nregions++;
+ vmsg_set_reply_u64(vmsg, 0);
+ return true;
+ }
+}
+
+static inline bool reg_equal(VuDevRegion *vudev_reg,
+ VhostUserMemoryRegion *msg_reg)
+{
+ if (vudev_reg->gpa == msg_reg->guest_phys_addr &&
+ vudev_reg->qva == msg_reg->userspace_addr &&
+ vudev_reg->size == msg_reg->memory_size) {
+ return true;
+ }
+
+ return false;
+}
+
+static bool
+vu_rem_mem_reg(VuDev *dev, VhostUserMsg *vmsg) {
+ int i, j;
+ bool found = false;
+ VuDevRegion shadow_regions[VHOST_USER_MAX_RAM_SLOTS] = {};
+ VhostUserMemoryRegion m = vmsg->payload.memreg.region, *msg_region = &m;
+
+ DPRINT("Removing region:\n");
+ DPRINT(" guest_phys_addr: 0x%016"PRIx64"\n",
+ msg_region->guest_phys_addr);
+ DPRINT(" memory_size: 0x%016"PRIx64"\n",
+ msg_region->memory_size);
+ DPRINT(" userspace_addr 0x%016"PRIx64"\n",
+ msg_region->userspace_addr);
+ DPRINT(" mmap_offset 0x%016"PRIx64"\n",
+ msg_region->mmap_offset);
+
+ for (i = 0, j = 0; i < dev->nregions; i++) {
+ if (!reg_equal(&dev->regions[i], msg_region)) {
+ shadow_regions[j].gpa = dev->regions[i].gpa;
+ shadow_regions[j].size = dev->regions[i].size;
+ shadow_regions[j].qva = dev->regions[i].qva;
+ shadow_regions[j].mmap_addr = dev->regions[i].mmap_addr;
+ shadow_regions[j].mmap_offset = dev->regions[i].mmap_offset;
+ j++;
+ } else {
+ found = true;
+ VuDevRegion *r = &dev->regions[i];
+ void *m = (void *) (uintptr_t) r->mmap_addr;
+
+ if (m) {
+ munmap(m, r->size + r->mmap_offset);
+ }
+ }
+ }
+
+ if (found) {
+ memcpy(dev->regions, shadow_regions,
+ sizeof(VuDevRegion) * VHOST_USER_MAX_RAM_SLOTS);
+ DPRINT("Successfully removed a region\n");
+ dev->nregions--;
+ vmsg_set_reply_u64(vmsg, 0);
+ } else {
+ vu_panic(dev, "Specified region not found\n");
+ }
+
+ return true;
+}
+
+static bool
+vu_set_mem_table_exec_postcopy(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int i;
+ VhostUserMemory m = vmsg->payload.memory, *memory = &m;
+ dev->nregions = memory->nregions;
+
+ DPRINT("Nregions: %u\n", memory->nregions);
+ for (i = 0; i < dev->nregions; i++) {
+ void *mmap_addr;
+ VhostUserMemoryRegion *msg_region = &memory->regions[i];
+ VuDevRegion *dev_region = &dev->regions[i];
+
+ DPRINT("Region %d\n", i);
+ DPRINT(" guest_phys_addr: 0x%016"PRIx64"\n",
+ msg_region->guest_phys_addr);
+ DPRINT(" memory_size: 0x%016"PRIx64"\n",
+ msg_region->memory_size);
+ DPRINT(" userspace_addr 0x%016"PRIx64"\n",
+ msg_region->userspace_addr);
+ DPRINT(" mmap_offset 0x%016"PRIx64"\n",
+ msg_region->mmap_offset);
+
+ dev_region->gpa = msg_region->guest_phys_addr;
+ dev_region->size = msg_region->memory_size;
+ dev_region->qva = msg_region->userspace_addr;
+ dev_region->mmap_offset = msg_region->mmap_offset;
+
+ /* We don't use offset argument of mmap() since the
+ * mapped address has to be page aligned, and we use huge
+ * pages.
+ * In postcopy we're using PROT_NONE here to catch anyone
+ * accessing it before we userfault
+ */
+ mmap_addr = mmap(0, dev_region->size + dev_region->mmap_offset,
+ PROT_NONE, MAP_SHARED,
+ vmsg->fds[i], 0);
+
+ if (mmap_addr == MAP_FAILED) {
+ vu_panic(dev, "region mmap error: %s", strerror(errno));
+ } else {
+ dev_region->mmap_addr = (uint64_t)(uintptr_t)mmap_addr;
+ DPRINT(" mmap_addr: 0x%016"PRIx64"\n",
+ dev_region->mmap_addr);
+ }
+
+ /* Return the address to QEMU so that it can translate the ufd
+ * fault addresses back.
+ */
+ msg_region->userspace_addr = (uintptr_t)(mmap_addr +
+ dev_region->mmap_offset);
+ close(vmsg->fds[i]);
+ }
+
+ /* Send the message back to qemu with the addresses filled in */
+ vmsg->fd_num = 0;
+ if (!vu_send_reply(dev, dev->sock, vmsg)) {
+ vu_panic(dev, "failed to respond to set-mem-table for postcopy");
+ return false;
+ }
+
+ /* Wait for QEMU to confirm that it's registered the handler for the
+ * faults.
+ */
+ if (!dev->read_msg(dev, dev->sock, vmsg) ||
+ vmsg->size != sizeof(vmsg->payload.u64) ||
+ vmsg->payload.u64 != 0) {
+ vu_panic(dev, "failed to receive valid ack for postcopy set-mem-table");
+ return false;
+ }
+
+ /* OK, now we can go and register the memory and generate faults */
+ (void)generate_faults(dev);
+
+ return false;
+}
+
+static bool
+vu_set_mem_table_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int i;
+ VhostUserMemory m = vmsg->payload.memory, *memory = &m;
+
+ for (i = 0; i < dev->nregions; i++) {
+ VuDevRegion *r = &dev->regions[i];
+ void *m = (void *) (uintptr_t) r->mmap_addr;
+
+ if (m) {
+ munmap(m, r->size + r->mmap_offset);
+ }
+ }
+ dev->nregions = memory->nregions;
+
+ if (dev->postcopy_listening) {
+ return vu_set_mem_table_exec_postcopy(dev, vmsg);
+ }
+
+ DPRINT("Nregions: %u\n", memory->nregions);
+ for (i = 0; i < dev->nregions; i++) {
+ void *mmap_addr;
+ VhostUserMemoryRegion *msg_region = &memory->regions[i];
+ VuDevRegion *dev_region = &dev->regions[i];
+
+ DPRINT("Region %d\n", i);
+ DPRINT(" guest_phys_addr: 0x%016"PRIx64"\n",
+ msg_region->guest_phys_addr);
+ DPRINT(" memory_size: 0x%016"PRIx64"\n",
+ msg_region->memory_size);
+ DPRINT(" userspace_addr 0x%016"PRIx64"\n",
+ msg_region->userspace_addr);
+ DPRINT(" mmap_offset 0x%016"PRIx64"\n",
+ msg_region->mmap_offset);
+
+ dev_region->gpa = msg_region->guest_phys_addr;
+ dev_region->size = msg_region->memory_size;
+ dev_region->qva = msg_region->userspace_addr;
+ dev_region->mmap_offset = msg_region->mmap_offset;
+
+ /* We don't use offset argument of mmap() since the
+ * mapped address has to be page aligned, and we use huge
+ * pages. */
+ mmap_addr = mmap(0, dev_region->size + dev_region->mmap_offset,
+ PROT_READ | PROT_WRITE, MAP_SHARED,
+ vmsg->fds[i], 0);
+
+ if (mmap_addr == MAP_FAILED) {
+ vu_panic(dev, "region mmap error: %s", strerror(errno));
+ } else {
+ dev_region->mmap_addr = (uint64_t)(uintptr_t)mmap_addr;
+ DPRINT(" mmap_addr: 0x%016"PRIx64"\n",
+ dev_region->mmap_addr);
+ }
+
+ close(vmsg->fds[i]);
+ }
+
+ for (i = 0; i < dev->max_queues; i++) {
+ if (dev->vq[i].vring.desc) {
+ if (map_ring(dev, &dev->vq[i])) {
+ vu_panic(dev, "remapping queue %d during setmemtable", i);
+ }
+ }
+ }
+
+ return false;
+}
+
+static bool
+vu_set_log_base_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int fd;
+ uint64_t log_mmap_size, log_mmap_offset;
+ void *rc;
+
+ if (vmsg->fd_num != 1 ||
+ vmsg->size != sizeof(vmsg->payload.log)) {
+ vu_panic(dev, "Invalid log_base message");
+ return true;
+ }
+
+ fd = vmsg->fds[0];
+ log_mmap_offset = vmsg->payload.log.mmap_offset;
+ log_mmap_size = vmsg->payload.log.mmap_size;
+ DPRINT("Log mmap_offset: %"PRId64"\n", log_mmap_offset);
+ DPRINT("Log mmap_size: %"PRId64"\n", log_mmap_size);
+
+ rc = mmap(0, log_mmap_size, PROT_READ | PROT_WRITE, MAP_SHARED, fd,
+ log_mmap_offset);
+ close(fd);
+ if (rc == MAP_FAILED) {
+ perror("log mmap error");
+ }
+
+ if (dev->log_table) {
+ munmap(dev->log_table, dev->log_size);
+ }
+ dev->log_table = rc;
+ dev->log_size = log_mmap_size;
+
+ vmsg->size = sizeof(vmsg->payload.u64);
+ vmsg->fd_num = 0;
+
+ return true;
+}
+
+static bool
+vu_set_log_fd_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ if (vmsg->fd_num != 1) {
+ vu_panic(dev, "Invalid log_fd message");
+ return false;
+ }
+
+ if (dev->log_call_fd != -1) {
+ close(dev->log_call_fd);
+ }
+ dev->log_call_fd = vmsg->fds[0];
+ DPRINT("Got log_call_fd: %d\n", vmsg->fds[0]);
+
+ return false;
+}
+
+static bool
+vu_set_vring_num_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ unsigned int index = vmsg->payload.state.index;
+ unsigned int num = vmsg->payload.state.num;
+
+ DPRINT("State.index: %u\n", index);
+ DPRINT("State.num: %u\n", num);
+ dev->vq[index].vring.num = num;
+
+ return false;
+}
+
+static bool
+vu_set_vring_addr_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ struct vhost_vring_addr addr = vmsg->payload.addr, *vra = &addr;
+ unsigned int index = vra->index;
+ VuVirtq *vq = &dev->vq[index];
+
+ DPRINT("vhost_vring_addr:\n");
+ DPRINT(" index: %d\n", vra->index);
+ DPRINT(" flags: %d\n", vra->flags);
+ DPRINT(" desc_user_addr: 0x%016" PRIx64 "\n", (uint64_t)vra->desc_user_addr);
+ DPRINT(" used_user_addr: 0x%016" PRIx64 "\n", (uint64_t)vra->used_user_addr);
+ DPRINT(" avail_user_addr: 0x%016" PRIx64 "\n", (uint64_t)vra->avail_user_addr);
+ DPRINT(" log_guest_addr: 0x%016" PRIx64 "\n", (uint64_t)vra->log_guest_addr);
+
+ vq->vra = *vra;
+ vq->vring.flags = vra->flags;
+ vq->vring.log_guest_addr = vra->log_guest_addr;
+
+
+ if (map_ring(dev, vq)) {
+ vu_panic(dev, "Invalid vring_addr message");
+ return false;
+ }
+
+ vq->used_idx = le16toh(vq->vring.used->idx);
+
+ if (vq->last_avail_idx != vq->used_idx) {
+ bool resume = dev->iface->queue_is_processed_in_order &&
+ dev->iface->queue_is_processed_in_order(dev, index);
+
+ DPRINT("Last avail index != used index: %u != %u%s\n",
+ vq->last_avail_idx, vq->used_idx,
+ resume ? ", resuming" : "");
+
+ if (resume) {
+ vq->shadow_avail_idx = vq->last_avail_idx = vq->used_idx;
+ }
+ }
+
+ return false;
+}
+
+static bool
+vu_set_vring_base_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ unsigned int index = vmsg->payload.state.index;
+ unsigned int num = vmsg->payload.state.num;
+
+ DPRINT("State.index: %u\n", index);
+ DPRINT("State.num: %u\n", num);
+ dev->vq[index].shadow_avail_idx = dev->vq[index].last_avail_idx = num;
+
+ return false;
+}
+
+static bool
+vu_get_vring_base_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ unsigned int index = vmsg->payload.state.index;
+
+ DPRINT("State.index: %u\n", index);
+ vmsg->payload.state.num = dev->vq[index].last_avail_idx;
+ vmsg->size = sizeof(vmsg->payload.state);
+
+ dev->vq[index].started = false;
+ if (dev->iface->queue_set_started) {
+ dev->iface->queue_set_started(dev, index, false);
+ }
+
+ if (dev->vq[index].call_fd != -1) {
+ close(dev->vq[index].call_fd);
+ dev->vq[index].call_fd = -1;
+ }
+ if (dev->vq[index].kick_fd != -1) {
+ dev->remove_watch(dev, dev->vq[index].kick_fd);
+ close(dev->vq[index].kick_fd);
+ dev->vq[index].kick_fd = -1;
+ }
+
+ return true;
+}
+
+static bool
+vu_check_queue_msg_file(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int index = vmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
+ bool nofd = vmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK;
+
+ if (index >= dev->max_queues) {
+ vmsg_close_fds(vmsg);
+ vu_panic(dev, "Invalid queue index: %u", index);
+ return false;
+ }
+
+ if (nofd) {
+ vmsg_close_fds(vmsg);
+ return true;
+ }
+
+ if (vmsg->fd_num != 1) {
+ vmsg_close_fds(vmsg);
+ vu_panic(dev, "Invalid fds in request: %d", vmsg->request);
+ return false;
+ }
+
+ return true;
+}
+
+static int
+inflight_desc_compare(const void *a, const void *b)
+{
+ VuVirtqInflightDesc *desc0 = (VuVirtqInflightDesc *)a,
+ *desc1 = (VuVirtqInflightDesc *)b;
+
+ if (desc1->counter > desc0->counter &&
+ (desc1->counter - desc0->counter) < VIRTQUEUE_MAX_SIZE * 2) {
+ return 1;
+ }
+
+ return -1;
+}
+
+static int
+vu_check_queue_inflights(VuDev *dev, VuVirtq *vq)
+{
+ int i = 0;
+
+ if (!vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD)) {
+ return 0;
+ }
+
+ if (unlikely(!vq->inflight)) {
+ return -1;
+ }
+
+ if (unlikely(!vq->inflight->version)) {
+ /* initialize the buffer */
+ vq->inflight->version = INFLIGHT_VERSION;
+ return 0;
+ }
+
+ vq->used_idx = le16toh(vq->vring.used->idx);
+ vq->resubmit_num = 0;
+ vq->resubmit_list = NULL;
+ vq->counter = 0;
+
+ if (unlikely(vq->inflight->used_idx != vq->used_idx)) {
+ vq->inflight->desc[vq->inflight->last_batch_head].inflight = 0;
+
+ barrier();
+
+ vq->inflight->used_idx = vq->used_idx;
+ }
+
+ for (i = 0; i < vq->inflight->desc_num; i++) {
+ if (vq->inflight->desc[i].inflight == 1) {
+ vq->inuse++;
+ }
+ }
+
+ vq->shadow_avail_idx = vq->last_avail_idx = vq->inuse + vq->used_idx;
+
+ if (vq->inuse) {
+ vq->resubmit_list = calloc(vq->inuse, sizeof(VuVirtqInflightDesc));
+ if (!vq->resubmit_list) {
+ return -1;
+ }
+
+ for (i = 0; i < vq->inflight->desc_num; i++) {
+ if (vq->inflight->desc[i].inflight) {
+ vq->resubmit_list[vq->resubmit_num].index = i;
+ vq->resubmit_list[vq->resubmit_num].counter =
+ vq->inflight->desc[i].counter;
+ vq->resubmit_num++;
+ }
+ }
+
+ if (vq->resubmit_num > 1) {
+ qsort(vq->resubmit_list, vq->resubmit_num,
+ sizeof(VuVirtqInflightDesc), inflight_desc_compare);
+ }
+ vq->counter = vq->resubmit_list[0].counter + 1;
+ }
+
+ /* in case of I/O hang after reconnecting */
+ if (eventfd_write(vq->kick_fd, 1)) {
+ return -1;
+ }
+
+ return 0;
+}
+
+static bool
+vu_set_vring_kick_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int index = vmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
+ bool nofd = vmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK;
+
+ DPRINT("u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
+
+ if (!vu_check_queue_msg_file(dev, vmsg)) {
+ return false;
+ }
+
+ if (dev->vq[index].kick_fd != -1) {
+ dev->remove_watch(dev, dev->vq[index].kick_fd);
+ close(dev->vq[index].kick_fd);
+ dev->vq[index].kick_fd = -1;
+ }
+
+ dev->vq[index].kick_fd = nofd ? -1 : vmsg->fds[0];
+ DPRINT("Got kick_fd: %d for vq: %d\n", dev->vq[index].kick_fd, index);
+
+ dev->vq[index].started = true;
+ if (dev->iface->queue_set_started) {
+ dev->iface->queue_set_started(dev, index, true);
+ }
+
+ if (dev->vq[index].kick_fd != -1 && dev->vq[index].handler) {
+ dev->set_watch(dev, dev->vq[index].kick_fd, VU_WATCH_IN,
+ vu_kick_cb, (void *)(long)index);
+
+ DPRINT("Waiting for kicks on fd: %d for vq: %d\n",
+ dev->vq[index].kick_fd, index);
+ }
+
+ if (vu_check_queue_inflights(dev, &dev->vq[index])) {
+ vu_panic(dev, "Failed to check inflights for vq: %d\n", index);
+ }
+
+ return false;
+}
+
+void vu_set_queue_handler(VuDev *dev, VuVirtq *vq,
+ vu_queue_handler_cb handler)
+{
+ int qidx = vq - dev->vq;
+
+ vq->handler = handler;
+ if (vq->kick_fd >= 0) {
+ if (handler) {
+ dev->set_watch(dev, vq->kick_fd, VU_WATCH_IN,
+ vu_kick_cb, (void *)(long)qidx);
+ } else {
+ dev->remove_watch(dev, vq->kick_fd);
+ }
+ }
+}
+
+bool vu_set_queue_host_notifier(VuDev *dev, VuVirtq *vq, int fd,
+ int size, int offset)
+{
+ int qidx = vq - dev->vq;
+ int fd_num = 0;
+ VhostUserMsg vmsg = {
+ .request = VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG,
+ .flags = VHOST_USER_VERSION | VHOST_USER_NEED_REPLY_MASK,
+ .size = sizeof(vmsg.payload.area),
+ .payload.area = {
+ .u64 = qidx & VHOST_USER_VRING_IDX_MASK,
+ .size = size,
+ .offset = offset,
+ },
+ };
+
+ if (fd == -1) {
+ vmsg.payload.area.u64 |= VHOST_USER_VRING_NOFD_MASK;
+ } else {
+ vmsg.fds[fd_num++] = fd;
+ }
+
+ vmsg.fd_num = fd_num;
+
+ if (!vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD)) {
+ return false;
+ }
+
+ pthread_mutex_lock(&dev->slave_mutex);
+ if (!vu_message_write(dev, dev->slave_fd, &vmsg)) {
+ pthread_mutex_unlock(&dev->slave_mutex);
+ return false;
+ }
+
+ /* Also unlocks the slave_mutex */
+ return vu_process_message_reply(dev, &vmsg);
+}
+
+static bool
+vu_set_vring_call_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int index = vmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
+ bool nofd = vmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK;
+
+ DPRINT("u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
+
+ if (!vu_check_queue_msg_file(dev, vmsg)) {
+ return false;
+ }
+
+ if (dev->vq[index].call_fd != -1) {
+ close(dev->vq[index].call_fd);
+ dev->vq[index].call_fd = -1;
+ }
+
+ dev->vq[index].call_fd = nofd ? -1 : vmsg->fds[0];
+
+ /* in case of I/O hang after reconnecting */
+ if (dev->vq[index].call_fd != -1 && eventfd_write(vmsg->fds[0], 1)) {
+ return -1;
+ }
+
+ DPRINT("Got call_fd: %d for vq: %d\n", dev->vq[index].call_fd, index);
+
+ return false;
+}
+
+static bool
+vu_set_vring_err_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int index = vmsg->payload.u64 & VHOST_USER_VRING_IDX_MASK;
+ bool nofd = vmsg->payload.u64 & VHOST_USER_VRING_NOFD_MASK;
+
+ DPRINT("u64: 0x%016"PRIx64"\n", vmsg->payload.u64);
+
+ if (!vu_check_queue_msg_file(dev, vmsg)) {
+ return false;
+ }
+
+ if (dev->vq[index].err_fd != -1) {
+ close(dev->vq[index].err_fd);
+ dev->vq[index].err_fd = -1;
+ }
+
+ dev->vq[index].err_fd = nofd ? -1 : vmsg->fds[0];
+
+ return false;
+}
+
+static bool
+vu_get_protocol_features_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ /*
+ * Note that we support, but intentionally do not set,
+ * VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS. This means that
+ * a device implementation can return it in its callback
+ * (get_protocol_features) if it wants to use this for
+ * simulation, but it is otherwise not desirable (if even
+ * implemented by the master.)
+ */
+ uint64_t features = 1ULL << VHOST_USER_PROTOCOL_F_MQ |
+ 1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD |
+ 1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ |
+ 1ULL << VHOST_USER_PROTOCOL_F_HOST_NOTIFIER |
+ 1ULL << VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD |
+ 1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK |
+ 1ULL << VHOST_USER_PROTOCOL_F_CONFIGURE_MEM_SLOTS;
+
+ if (have_userfault()) {
+ features |= 1ULL << VHOST_USER_PROTOCOL_F_PAGEFAULT;
+ }
+
+ if (dev->iface->get_config && dev->iface->set_config) {
+ features |= 1ULL << VHOST_USER_PROTOCOL_F_CONFIG;
+ }
+
+ if (dev->iface->get_protocol_features) {
+ features |= dev->iface->get_protocol_features(dev);
+ }
+
+ vmsg_set_reply_u64(vmsg, features);
+ return true;
+}
+
+static bool
+vu_set_protocol_features_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ uint64_t features = vmsg->payload.u64;
+
+ DPRINT("u64: 0x%016"PRIx64"\n", features);
+
+ dev->protocol_features = vmsg->payload.u64;
+
+ if (vu_has_protocol_feature(dev,
+ VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS) &&
+ (!vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_SLAVE_REQ) ||
+ !vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_REPLY_ACK))) {
+ /*
+ * The use case for using messages for kick/call is simulation, to make
+ * the kick and call synchronous. To actually get that behaviour, both
+ * of the other features are required.
+ * Theoretically, one could use only kick messages, or do them without
+ * having F_REPLY_ACK, but too many (possibly pending) messages on the
+ * socket will eventually cause the master to hang, to avoid this in
+ * scenarios where not desired enforce that the settings are in a way
+ * that actually enables the simulation case.
+ */
+ vu_panic(dev,
+ "F_IN_BAND_NOTIFICATIONS requires F_SLAVE_REQ && F_REPLY_ACK");
+ return false;
+ }
+
+ if (dev->iface->set_protocol_features) {
+ dev->iface->set_protocol_features(dev, features);
+ }
+
+ return false;
+}
+
+static bool
+vu_get_queue_num_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ vmsg_set_reply_u64(vmsg, dev->max_queues);
+ return true;
+}
+
+static bool
+vu_set_vring_enable_exec(VuDev *dev, VhostUserMsg *vmsg)
+{
+ unsigned int index = vmsg->payload.state.index;
+ unsigned int enable = vmsg->payload.state.num;
+
+ DPRINT("State.index: %u\n", index);
+ DPRINT("State.enable: %u\n", enable);
+
+ if (index >= dev->max_queues) {
+ vu_panic(dev, "Invalid vring_enable index: %u", index);
+ return false;
+ }
+
+ dev->vq[index].enable = enable;
+ return false;
+}
+
+static bool
+vu_set_slave_req_fd(VuDev *dev, VhostUserMsg *vmsg)
+{
+ if (vmsg->fd_num != 1) {
+ vu_panic(dev, "Invalid slave_req_fd message (%d fd's)", vmsg->fd_num);
+ return false;
+ }
+
+ if (dev->slave_fd != -1) {
+ close(dev->slave_fd);
+ }
+ dev->slave_fd = vmsg->fds[0];
+ DPRINT("Got slave_fd: %d\n", vmsg->fds[0]);
+
+ return false;
+}
+
+static bool
+vu_get_config(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int ret = -1;
+
+ if (dev->iface->get_config) {
+ ret = dev->iface->get_config(dev, vmsg->payload.config.region,
+ vmsg->payload.config.size);
+ }
+
+ if (ret) {
+ /* resize to zero to indicate an error to master */
+ vmsg->size = 0;
+ }
+
+ return true;
+}
+
+static bool
+vu_set_config(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int ret = -1;
+
+ if (dev->iface->set_config) {
+ ret = dev->iface->set_config(dev, vmsg->payload.config.region,
+ vmsg->payload.config.offset,
+ vmsg->payload.config.size,
+ vmsg->payload.config.flags);
+ if (ret) {
+ vu_panic(dev, "Set virtio configuration space failed");
+ }
+ }
+
+ return false;
+}
+
+static bool
+vu_set_postcopy_advise(VuDev *dev, VhostUserMsg *vmsg)
+{
+ dev->postcopy_ufd = -1;
+#ifdef UFFDIO_API
+ struct uffdio_api api_struct;
+
+ dev->postcopy_ufd = syscall(__NR_userfaultfd, O_CLOEXEC | O_NONBLOCK);
+ vmsg->size = 0;
+#endif
+
+ if (dev->postcopy_ufd == -1) {
+ vu_panic(dev, "Userfaultfd not available: %s", strerror(errno));
+ goto out;
+ }
+
+#ifdef UFFDIO_API
+ api_struct.api = UFFD_API;
+ api_struct.features = 0;
+ if (ioctl(dev->postcopy_ufd, UFFDIO_API, &api_struct)) {
+ vu_panic(dev, "Failed UFFDIO_API: %s", strerror(errno));
+ close(dev->postcopy_ufd);
+ dev->postcopy_ufd = -1;
+ goto out;
+ }
+ /* TODO: Stash feature flags somewhere */
+#endif
+
+out:
+ /* Return a ufd to the QEMU */
+ vmsg->fd_num = 1;
+ vmsg->fds[0] = dev->postcopy_ufd;
+ return true; /* = send a reply */
+}
+
+static bool
+vu_set_postcopy_listen(VuDev *dev, VhostUserMsg *vmsg)
+{
+ if (dev->nregions) {
+ vu_panic(dev, "Regions already registered at postcopy-listen");
+ vmsg_set_reply_u64(vmsg, -1);
+ return true;
+ }
+ dev->postcopy_listening = true;
+
+ vmsg_set_reply_u64(vmsg, 0);
+ return true;
+}
+
+static bool
+vu_set_postcopy_end(VuDev *dev, VhostUserMsg *vmsg)
+{
+ DPRINT("%s: Entry\n", __func__);
+ dev->postcopy_listening = false;
+ if (dev->postcopy_ufd > 0) {
+ close(dev->postcopy_ufd);
+ dev->postcopy_ufd = -1;
+ DPRINT("%s: Done close\n", __func__);
+ }
+
+ vmsg_set_reply_u64(vmsg, 0);
+ DPRINT("%s: exit\n", __func__);
+ return true;
+}
+
+static inline uint64_t
+vu_inflight_queue_size(uint16_t queue_size)
+{
+ return ALIGN_UP(sizeof(VuDescStateSplit) * queue_size +
+ sizeof(uint16_t), INFLIGHT_ALIGNMENT);
+}
+
+#ifdef MFD_ALLOW_SEALING
+static void *
+memfd_alloc(const char *name, size_t size, unsigned int flags, int *fd)
+{
+ void *ptr;
+ int ret;
+
+ *fd = memfd_create(name, MFD_ALLOW_SEALING);
+ if (*fd < 0) {
+ return NULL;
+ }
+
+ ret = ftruncate(*fd, size);
+ if (ret < 0) {
+ close(*fd);
+ return NULL;
+ }
+
+ ret = fcntl(*fd, F_ADD_SEALS, flags);
+ if (ret < 0) {
+ close(*fd);
+ return NULL;
+ }
+
+ ptr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, *fd, 0);
+ if (ptr == MAP_FAILED) {
+ close(*fd);
+ return NULL;
+ }
+
+ return ptr;
+}
+#endif
+
+static bool
+vu_get_inflight_fd(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int fd = -1;
+ void *addr = NULL;
+ uint64_t mmap_size;
+ uint16_t num_queues, queue_size;
+
+ if (vmsg->size != sizeof(vmsg->payload.inflight)) {
+ vu_panic(dev, "Invalid get_inflight_fd message:%d", vmsg->size);
+ vmsg->payload.inflight.mmap_size = 0;
+ return true;
+ }
+
+ num_queues = vmsg->payload.inflight.num_queues;
+ queue_size = vmsg->payload.inflight.queue_size;
+
+ DPRINT("set_inflight_fd num_queues: %"PRId16"\n", num_queues);
+ DPRINT("set_inflight_fd queue_size: %"PRId16"\n", queue_size);
+
+ mmap_size = vu_inflight_queue_size(queue_size) * num_queues;
+
+#ifdef MFD_ALLOW_SEALING
+ addr = memfd_alloc("vhost-inflight", mmap_size,
+ F_SEAL_GROW | F_SEAL_SHRINK | F_SEAL_SEAL,
+ &fd);
+#else
+ vu_panic(dev, "Not implemented: memfd support is missing");
+#endif
+
+ if (!addr) {
+ vu_panic(dev, "Failed to alloc vhost inflight area");
+ vmsg->payload.inflight.mmap_size = 0;
+ return true;
+ }
+
+ memset(addr, 0, mmap_size);
+
+ dev->inflight_info.addr = addr;
+ dev->inflight_info.size = vmsg->payload.inflight.mmap_size = mmap_size;
+ dev->inflight_info.fd = vmsg->fds[0] = fd;
+ vmsg->fd_num = 1;
+ vmsg->payload.inflight.mmap_offset = 0;
+
+ DPRINT("send inflight mmap_size: %"PRId64"\n",
+ vmsg->payload.inflight.mmap_size);
+ DPRINT("send inflight mmap offset: %"PRId64"\n",
+ vmsg->payload.inflight.mmap_offset);
+
+ return true;
+}
+
+static bool
+vu_set_inflight_fd(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int fd, i;
+ uint64_t mmap_size, mmap_offset;
+ uint16_t num_queues, queue_size;
+ void *rc;
+
+ if (vmsg->fd_num != 1 ||
+ vmsg->size != sizeof(vmsg->payload.inflight)) {
+ vu_panic(dev, "Invalid set_inflight_fd message size:%d fds:%d",
+ vmsg->size, vmsg->fd_num);
+ return false;
+ }
+
+ fd = vmsg->fds[0];
+ mmap_size = vmsg->payload.inflight.mmap_size;
+ mmap_offset = vmsg->payload.inflight.mmap_offset;
+ num_queues = vmsg->payload.inflight.num_queues;
+ queue_size = vmsg->payload.inflight.queue_size;
+
+ DPRINT("set_inflight_fd mmap_size: %"PRId64"\n", mmap_size);
+ DPRINT("set_inflight_fd mmap_offset: %"PRId64"\n", mmap_offset);
+ DPRINT("set_inflight_fd num_queues: %"PRId16"\n", num_queues);
+ DPRINT("set_inflight_fd queue_size: %"PRId16"\n", queue_size);
+
+ rc = mmap(0, mmap_size, PROT_READ | PROT_WRITE, MAP_SHARED,
+ fd, mmap_offset);
+
+ if (rc == MAP_FAILED) {
+ vu_panic(dev, "set_inflight_fd mmap error: %s", strerror(errno));
+ return false;
+ }
+
+ if (dev->inflight_info.fd) {
+ close(dev->inflight_info.fd);
+ }
+
+ if (dev->inflight_info.addr) {
+ munmap(dev->inflight_info.addr, dev->inflight_info.size);
+ }
+
+ dev->inflight_info.fd = fd;
+ dev->inflight_info.addr = rc;
+ dev->inflight_info.size = mmap_size;
+
+ for (i = 0; i < num_queues; i++) {
+ dev->vq[i].inflight = (VuVirtqInflight *)rc;
+ dev->vq[i].inflight->desc_num = queue_size;
+ rc = (void *)((char *)rc + vu_inflight_queue_size(queue_size));
+ }
+
+ return false;
+}
+
+static bool
+vu_handle_vring_kick(VuDev *dev, VhostUserMsg *vmsg)
+{
+ unsigned int index = vmsg->payload.state.index;
+
+ if (index >= dev->max_queues) {
+ vu_panic(dev, "Invalid queue index: %u", index);
+ return false;
+ }
+
+ DPRINT("Got kick message: handler:%p idx:%u\n",
+ dev->vq[index].handler, index);
+
+ if (!dev->vq[index].started) {
+ dev->vq[index].started = true;
+
+ if (dev->iface->queue_set_started) {
+ dev->iface->queue_set_started(dev, index, true);
+ }
+ }
+
+ if (dev->vq[index].handler) {
+ dev->vq[index].handler(dev, index);
+ }
+
+ return false;
+}
+
+static bool vu_handle_get_max_memslots(VuDev *dev, VhostUserMsg *vmsg)
+{
+ vmsg->flags = VHOST_USER_REPLY_MASK | VHOST_USER_VERSION;
+ vmsg->size = sizeof(vmsg->payload.u64);
+ vmsg->payload.u64 = VHOST_USER_MAX_RAM_SLOTS;
+ vmsg->fd_num = 0;
+
+ if (!vu_message_write(dev, dev->sock, vmsg)) {
+ vu_panic(dev, "Failed to send max ram slots: %s\n", strerror(errno));
+ }
+
+ DPRINT("u64: 0x%016"PRIx64"\n", (uint64_t) VHOST_USER_MAX_RAM_SLOTS);
+
+ return false;
+}
+
+static bool
+vu_process_message(VuDev *dev, VhostUserMsg *vmsg)
+{
+ int do_reply = 0;
+
+ /* Print out generic part of the request. */
+ DPRINT("================ Vhost user message ================\n");
+ DPRINT("Request: %s (%d)\n", vu_request_to_string(vmsg->request),
+ vmsg->request);
+ DPRINT("Flags: 0x%x\n", vmsg->flags);
+ DPRINT("Size: %u\n", vmsg->size);
+
+ if (vmsg->fd_num) {
+ int i;
+ DPRINT("Fds:");
+ for (i = 0; i < vmsg->fd_num; i++) {
+ DPRINT(" %d", vmsg->fds[i]);
+ }
+ DPRINT("\n");
+ }
+
+ if (dev->iface->process_msg &&
+ dev->iface->process_msg(dev, vmsg, &do_reply)) {
+ return do_reply;
+ }
+
+ switch (vmsg->request) {
+ case VHOST_USER_GET_FEATURES:
+ return vu_get_features_exec(dev, vmsg);
+ case VHOST_USER_SET_FEATURES:
+ return vu_set_features_exec(dev, vmsg);
+ case VHOST_USER_GET_PROTOCOL_FEATURES:
+ return vu_get_protocol_features_exec(dev, vmsg);
+ case VHOST_USER_SET_PROTOCOL_FEATURES:
+ return vu_set_protocol_features_exec(dev, vmsg);
+ case VHOST_USER_SET_OWNER:
+ return vu_set_owner_exec(dev, vmsg);
+ case VHOST_USER_RESET_OWNER:
+ return vu_reset_device_exec(dev, vmsg);
+ case VHOST_USER_SET_MEM_TABLE:
+ return vu_set_mem_table_exec(dev, vmsg);
+ case VHOST_USER_SET_LOG_BASE:
+ return vu_set_log_base_exec(dev, vmsg);
+ case VHOST_USER_SET_LOG_FD:
+ return vu_set_log_fd_exec(dev, vmsg);
+ case VHOST_USER_SET_VRING_NUM:
+ return vu_set_vring_num_exec(dev, vmsg);
+ case VHOST_USER_SET_VRING_ADDR:
+ return vu_set_vring_addr_exec(dev, vmsg);
+ case VHOST_USER_SET_VRING_BASE:
+ return vu_set_vring_base_exec(dev, vmsg);
+ case VHOST_USER_GET_VRING_BASE:
+ return vu_get_vring_base_exec(dev, vmsg);
+ case VHOST_USER_SET_VRING_KICK:
+ return vu_set_vring_kick_exec(dev, vmsg);
+ case VHOST_USER_SET_VRING_CALL:
+ return vu_set_vring_call_exec(dev, vmsg);
+ case VHOST_USER_SET_VRING_ERR:
+ return vu_set_vring_err_exec(dev, vmsg);
+ case VHOST_USER_GET_QUEUE_NUM:
+ return vu_get_queue_num_exec(dev, vmsg);
+ case VHOST_USER_SET_VRING_ENABLE:
+ return vu_set_vring_enable_exec(dev, vmsg);
+ case VHOST_USER_SET_SLAVE_REQ_FD:
+ return vu_set_slave_req_fd(dev, vmsg);
+ case VHOST_USER_GET_CONFIG:
+ return vu_get_config(dev, vmsg);
+ case VHOST_USER_SET_CONFIG:
+ return vu_set_config(dev, vmsg);
+ case VHOST_USER_NONE:
+ /* if you need processing before exit, override iface->process_msg */
+ exit(0);
+ case VHOST_USER_POSTCOPY_ADVISE:
+ return vu_set_postcopy_advise(dev, vmsg);
+ case VHOST_USER_POSTCOPY_LISTEN:
+ return vu_set_postcopy_listen(dev, vmsg);
+ case VHOST_USER_POSTCOPY_END:
+ return vu_set_postcopy_end(dev, vmsg);
+ case VHOST_USER_GET_INFLIGHT_FD:
+ return vu_get_inflight_fd(dev, vmsg);
+ case VHOST_USER_SET_INFLIGHT_FD:
+ return vu_set_inflight_fd(dev, vmsg);
+ case VHOST_USER_VRING_KICK:
+ return vu_handle_vring_kick(dev, vmsg);
+ case VHOST_USER_GET_MAX_MEM_SLOTS:
+ return vu_handle_get_max_memslots(dev, vmsg);
+ case VHOST_USER_ADD_MEM_REG:
+ return vu_add_mem_reg(dev, vmsg);
+ case VHOST_USER_REM_MEM_REG:
+ return vu_rem_mem_reg(dev, vmsg);
+ default:
+ vmsg_close_fds(vmsg);
+ vu_panic(dev, "Unhandled request: %d", vmsg->request);
+ }
+
+ return false;
+}
+
+bool
+vu_dispatch(VuDev *dev)
+{
+ VhostUserMsg vmsg = { 0, };
+ int reply_requested;
+ bool need_reply, success = false;
+
+ if (!dev->read_msg(dev, dev->sock, &vmsg)) {
+ goto end;
+ }
+
+ need_reply = vmsg.flags & VHOST_USER_NEED_REPLY_MASK;
+
+ reply_requested = vu_process_message(dev, &vmsg);
+ if (!reply_requested && need_reply) {
+ vmsg_set_reply_u64(&vmsg, 0);
+ reply_requested = 1;
+ }
+
+ if (!reply_requested) {
+ success = true;
+ goto end;
+ }
+
+ if (!vu_send_reply(dev, dev->sock, &vmsg)) {
+ goto end;
+ }
+
+ success = true;
+
+end:
+ free(vmsg.data);
+ return success;
+}
+
+void
+vu_deinit(VuDev *dev)
+{
+ int i;
+
+ for (i = 0; i < dev->nregions; i++) {
+ VuDevRegion *r = &dev->regions[i];
+ void *m = (void *) (uintptr_t) r->mmap_addr;
+ if (m != MAP_FAILED) {
+ munmap(m, r->size + r->mmap_offset);
+ }
+ }
+ dev->nregions = 0;
+
+ for (i = 0; i < dev->max_queues; i++) {
+ VuVirtq *vq = &dev->vq[i];
+
+ if (vq->call_fd != -1) {
+ close(vq->call_fd);
+ vq->call_fd = -1;
+ }
+
+ if (vq->kick_fd != -1) {
+ dev->remove_watch(dev, vq->kick_fd);
+ close(vq->kick_fd);
+ vq->kick_fd = -1;
+ }
+
+ if (vq->err_fd != -1) {
+ close(vq->err_fd);
+ vq->err_fd = -1;
+ }
+
+ if (vq->resubmit_list) {
+ free(vq->resubmit_list);
+ vq->resubmit_list = NULL;
+ }
+
+ vq->inflight = NULL;
+ }
+
+ if (dev->inflight_info.addr) {
+ munmap(dev->inflight_info.addr, dev->inflight_info.size);
+ dev->inflight_info.addr = NULL;
+ }
+
+ if (dev->inflight_info.fd > 0) {
+ close(dev->inflight_info.fd);
+ dev->inflight_info.fd = -1;
+ }
+
+ vu_close_log(dev);
+ if (dev->slave_fd != -1) {
+ close(dev->slave_fd);
+ dev->slave_fd = -1;
+ }
+ pthread_mutex_destroy(&dev->slave_mutex);
+
+ if (dev->sock != -1) {
+ close(dev->sock);
+ }
+
+ free(dev->vq);
+ dev->vq = NULL;
+}
+
+bool
+vu_init(VuDev *dev,
+ uint16_t max_queues,
+ int socket,
+ vu_panic_cb panic,
+ vu_read_msg_cb read_msg,
+ vu_set_watch_cb set_watch,
+ vu_remove_watch_cb remove_watch,
+ const VuDevIface *iface)
+{
+ uint16_t i;
+
+ assert(max_queues > 0);
+ assert(socket >= 0);
+ assert(set_watch);
+ assert(remove_watch);
+ assert(iface);
+ assert(panic);
+
+ memset(dev, 0, sizeof(*dev));
+
+ dev->sock = socket;
+ dev->panic = panic;
+ dev->read_msg = read_msg ? read_msg : vu_message_read_default;
+ dev->set_watch = set_watch;
+ dev->remove_watch = remove_watch;
+ dev->iface = iface;
+ dev->log_call_fd = -1;
+ pthread_mutex_init(&dev->slave_mutex, NULL);
+ dev->slave_fd = -1;
+ dev->max_queues = max_queues;
+
+ dev->vq = malloc(max_queues * sizeof(dev->vq[0]));
+ if (!dev->vq) {
+ DPRINT("%s: failed to malloc virtqueues\n", __func__);
+ return false;
+ }
+
+ for (i = 0; i < max_queues; i++) {
+ dev->vq[i] = (VuVirtq) {
+ .call_fd = -1, .kick_fd = -1, .err_fd = -1,
+ .notification = true,
+ };
+ }
+
+ return true;
+}
+
+VuVirtq *
+vu_get_queue(VuDev *dev, int qidx)
+{
+ assert(qidx < dev->max_queues);
+ return &dev->vq[qidx];
+}
+
+bool
+vu_queue_enabled(VuDev *dev, VuVirtq *vq)
+{
+ return vq->enable;
+}
+
+bool
+vu_queue_started(const VuDev *dev, const VuVirtq *vq)
+{
+ return vq->started;
+}
+
+static inline uint16_t
+vring_avail_flags(VuVirtq *vq)
+{
+ return le16toh(vq->vring.avail->flags);
+}
+
+static inline uint16_t
+vring_avail_idx(VuVirtq *vq)
+{
+ vq->shadow_avail_idx = le16toh(vq->vring.avail->idx);
+
+ return vq->shadow_avail_idx;
+}
+
+static inline uint16_t
+vring_avail_ring(VuVirtq *vq, int i)
+{
+ return le16toh(vq->vring.avail->ring[i]);
+}
+
+static inline uint16_t
+vring_get_used_event(VuVirtq *vq)
+{
+ return vring_avail_ring(vq, vq->vring.num);
+}
+
+static int
+virtqueue_num_heads(VuDev *dev, VuVirtq *vq, unsigned int idx)
+{
+ uint16_t num_heads = vring_avail_idx(vq) - idx;
+
+ /* Check it isn't doing very strange things with descriptor numbers. */
+ if (num_heads > vq->vring.num) {
+ vu_panic(dev, "Guest moved used index from %u to %u",
+ idx, vq->shadow_avail_idx);
+ return -1;
+ }
+ if (num_heads) {
+ /* On success, callers read a descriptor at vq->last_avail_idx.
+ * Make sure descriptor read does not bypass avail index read. */
+ smp_rmb();
+ }
+
+ return num_heads;
+}
+
+static bool
+virtqueue_get_head(VuDev *dev, VuVirtq *vq,
+ unsigned int idx, unsigned int *head)
+{
+ /* Grab the next descriptor number they're advertising, and increment
+ * the index we've seen. */
+ *head = vring_avail_ring(vq, idx % vq->vring.num);
+
+ /* If their number is silly, that's a fatal mistake. */
+ if (*head >= vq->vring.num) {
+ vu_panic(dev, "Guest says index %u is available", *head);
+ return false;
+ }
+
+ return true;
+}
+
+static int
+virtqueue_read_indirect_desc(VuDev *dev, struct vring_desc *desc,
+ uint64_t addr, size_t len)
+{
+ struct vring_desc *ori_desc;
+ uint64_t read_len;
+
+ if (len > (VIRTQUEUE_MAX_SIZE * sizeof(struct vring_desc))) {
+ return -1;
+ }
+
+ if (len == 0) {
+ return -1;
+ }
+
+ while (len) {
+ read_len = len;
+ ori_desc = vu_gpa_to_va(dev, &read_len, addr);
+ if (!ori_desc) {
+ return -1;
+ }
+
+ memcpy(desc, ori_desc, read_len);
+ len -= read_len;
+ addr += read_len;
+ desc += read_len;
+ }
+
+ return 0;
+}
+
+enum {
+ VIRTQUEUE_READ_DESC_ERROR = -1,
+ VIRTQUEUE_READ_DESC_DONE = 0, /* end of chain */
+ VIRTQUEUE_READ_DESC_MORE = 1, /* more buffers in chain */
+};
+
+static int
+virtqueue_read_next_desc(VuDev *dev, struct vring_desc *desc,
+ int i, unsigned int max, unsigned int *next)
+{
+ /* If this descriptor says it doesn't chain, we're done. */
+ if (!(le16toh(desc[i].flags) & VRING_DESC_F_NEXT)) {
+ return VIRTQUEUE_READ_DESC_DONE;
+ }
+
+ /* Check they're not leading us off end of descriptors. */
+ *next = le16toh(desc[i].next);
+ /* Make sure compiler knows to grab that: we don't want it changing! */
+ smp_wmb();
+
+ if (*next >= max) {
+ vu_panic(dev, "Desc next is %u", *next);
+ return VIRTQUEUE_READ_DESC_ERROR;
+ }
+
+ return VIRTQUEUE_READ_DESC_MORE;
+}
+
+void
+vu_queue_get_avail_bytes(VuDev *dev, VuVirtq *vq, unsigned int *in_bytes,
+ unsigned int *out_bytes,
+ unsigned max_in_bytes, unsigned max_out_bytes)
+{
+ unsigned int idx;
+ unsigned int total_bufs, in_total, out_total;
+ int rc;
+
+ idx = vq->last_avail_idx;
+
+ total_bufs = in_total = out_total = 0;
+ if (unlikely(dev->broken) ||
+ unlikely(!vq->vring.avail)) {
+ goto done;
+ }
+
+ while ((rc = virtqueue_num_heads(dev, vq, idx)) > 0) {
+ unsigned int max, desc_len, num_bufs, indirect = 0;
+ uint64_t desc_addr, read_len;
+ struct vring_desc *desc;
+ struct vring_desc desc_buf[VIRTQUEUE_MAX_SIZE];
+ unsigned int i;
+
+ max = vq->vring.num;
+ num_bufs = total_bufs;
+ if (!virtqueue_get_head(dev, vq, idx++, &i)) {
+ goto err;
+ }
+ desc = vq->vring.desc;
+
+ if (le16toh(desc[i].flags) & VRING_DESC_F_INDIRECT) {
+ if (le32toh(desc[i].len) % sizeof(struct vring_desc)) {
+ vu_panic(dev, "Invalid size for indirect buffer table");
+ goto err;
+ }
+
+ /* If we've got too many, that implies a descriptor loop. */
+ if (num_bufs >= max) {
+ vu_panic(dev, "Looped descriptor");
+ goto err;
+ }
+
+ /* loop over the indirect descriptor table */
+ indirect = 1;
+ desc_addr = le64toh(desc[i].addr);
+ desc_len = le32toh(desc[i].len);
+ max = desc_len / sizeof(struct vring_desc);
+ read_len = desc_len;
+ desc = vu_gpa_to_va(dev, &read_len, desc_addr);
+ if (unlikely(desc && read_len != desc_len)) {
+ /* Failed to use zero copy */
+ desc = NULL;
+ if (!virtqueue_read_indirect_desc(dev, desc_buf,
+ desc_addr,
+ desc_len)) {
+ desc = desc_buf;
+ }
+ }
+ if (!desc) {
+ vu_panic(dev, "Invalid indirect buffer table");
+ goto err;
+ }
+ num_bufs = i = 0;
+ }
+
+ do {
+ /* If we've got too many, that implies a descriptor loop. */
+ if (++num_bufs > max) {
+ vu_panic(dev, "Looped descriptor");
+ goto err;
+ }
+
+ if (le16toh(desc[i].flags) & VRING_DESC_F_WRITE) {
+ in_total += le32toh(desc[i].len);
+ } else {
+ out_total += le32toh(desc[i].len);
+ }
+ if (in_total >= max_in_bytes && out_total >= max_out_bytes) {
+ goto done;
+ }
+ rc = virtqueue_read_next_desc(dev, desc, i, max, &i);
+ } while (rc == VIRTQUEUE_READ_DESC_MORE);
+
+ if (rc == VIRTQUEUE_READ_DESC_ERROR) {
+ goto err;
+ }
+
+ if (!indirect) {
+ total_bufs = num_bufs;
+ } else {
+ total_bufs++;
+ }
+ }
+ if (rc < 0) {
+ goto err;
+ }
+done:
+ if (in_bytes) {
+ *in_bytes = in_total;
+ }
+ if (out_bytes) {
+ *out_bytes = out_total;
+ }
+ return;
+
+err:
+ in_total = out_total = 0;
+ goto done;
+}
+
+bool
+vu_queue_avail_bytes(VuDev *dev, VuVirtq *vq, unsigned int in_bytes,
+ unsigned int out_bytes)
+{
+ unsigned int in_total, out_total;
+
+ vu_queue_get_avail_bytes(dev, vq, &in_total, &out_total,
+ in_bytes, out_bytes);
+
+ return in_bytes <= in_total && out_bytes <= out_total;
+}
+
+/* Fetch avail_idx from VQ memory only when we really need to know if
+ * guest has added some buffers. */
+bool
+vu_queue_empty(VuDev *dev, VuVirtq *vq)
+{
+ if (unlikely(dev->broken) ||
+ unlikely(!vq->vring.avail)) {
+ return true;
+ }
+
+ if (vq->shadow_avail_idx != vq->last_avail_idx) {
+ return false;
+ }
+
+ return vring_avail_idx(vq) == vq->last_avail_idx;
+}
+
+static bool
+vring_notify(VuDev *dev, VuVirtq *vq)
+{
+ uint16_t old, new;
+ bool v;
+
+ /* We need to expose used array entries before checking used event. */
+ smp_mb();
+
+ /* Always notify when queue is empty (when feature acknowledge) */
+ if (vu_has_feature(dev, VIRTIO_F_NOTIFY_ON_EMPTY) &&
+ !vq->inuse && vu_queue_empty(dev, vq)) {
+ return true;
+ }
+
+ if (!vu_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
+ return !(vring_avail_flags(vq) & VRING_AVAIL_F_NO_INTERRUPT);
+ }
+
+ v = vq->signalled_used_valid;
+ vq->signalled_used_valid = true;
+ old = vq->signalled_used;
+ new = vq->signalled_used = vq->used_idx;
+ return !v || vring_need_event(vring_get_used_event(vq), new, old);
+}
+
+static void _vu_queue_notify(VuDev *dev, VuVirtq *vq, bool sync)
+{
+ if (unlikely(dev->broken) ||
+ unlikely(!vq->vring.avail)) {
+ return;
+ }
+
+ if (!vring_notify(dev, vq)) {
+ DPRINT("skipped notify...\n");
+ return;
+ }
+
+ if (vq->call_fd < 0 &&
+ vu_has_protocol_feature(dev,
+ VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS) &&
+ vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_SLAVE_REQ)) {
+ VhostUserMsg vmsg = {
+ .request = VHOST_USER_SLAVE_VRING_CALL,
+ .flags = VHOST_USER_VERSION,
+ .size = sizeof(vmsg.payload.state),
+ .payload.state = {
+ .index = vq - dev->vq,
+ },
+ };
+ bool ack = sync &&
+ vu_has_protocol_feature(dev,
+ VHOST_USER_PROTOCOL_F_REPLY_ACK);
+
+ if (ack) {
+ vmsg.flags |= VHOST_USER_NEED_REPLY_MASK;
+ }
+
+ vu_message_write(dev, dev->slave_fd, &vmsg);
+ if (ack) {
+ vu_message_read_default(dev, dev->slave_fd, &vmsg);
+ }
+ return;
+ }
+
+ if (eventfd_write(vq->call_fd, 1) < 0) {
+ vu_panic(dev, "Error writing eventfd: %s", strerror(errno));
+ }
+}
+
+void vu_queue_notify(VuDev *dev, VuVirtq *vq)
+{
+ _vu_queue_notify(dev, vq, false);
+}
+
+void vu_queue_notify_sync(VuDev *dev, VuVirtq *vq)
+{
+ _vu_queue_notify(dev, vq, true);
+}
+
+static inline void
+vring_used_flags_set_bit(VuVirtq *vq, int mask)
+{
+ uint16_t *flags;
+
+ flags = (uint16_t *)((char*)vq->vring.used +
+ offsetof(struct vring_used, flags));
+ *flags = htole16(le16toh(*flags) | mask);
+}
+
+static inline void
+vring_used_flags_unset_bit(VuVirtq *vq, int mask)
+{
+ uint16_t *flags;
+
+ flags = (uint16_t *)((char*)vq->vring.used +
+ offsetof(struct vring_used, flags));
+ *flags = htole16(le16toh(*flags) & ~mask);
+}
+
+static inline void
+vring_set_avail_event(VuVirtq *vq, uint16_t val)
+{
+ uint16_t *avail;
+
+ if (!vq->notification) {
+ return;
+ }
+
+ avail = (uint16_t *)&vq->vring.used->ring[vq->vring.num];
+ *avail = htole16(val);
+}
+
+void
+vu_queue_set_notification(VuDev *dev, VuVirtq *vq, int enable)
+{
+ vq->notification = enable;
+ if (vu_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
+ vring_set_avail_event(vq, vring_avail_idx(vq));
+ } else if (enable) {
+ vring_used_flags_unset_bit(vq, VRING_USED_F_NO_NOTIFY);
+ } else {
+ vring_used_flags_set_bit(vq, VRING_USED_F_NO_NOTIFY);
+ }
+ if (enable) {
+ /* Expose avail event/used flags before caller checks the avail idx. */
+ smp_mb();
+ }
+}
+
+static bool
+virtqueue_map_desc(VuDev *dev,
+ unsigned int *p_num_sg, struct iovec *iov,
+ unsigned int max_num_sg, bool is_write,
+ uint64_t pa, size_t sz)
+{
+ unsigned num_sg = *p_num_sg;
+
+ assert(num_sg <= max_num_sg);
+
+ if (!sz) {
+ vu_panic(dev, "virtio: zero sized buffers are not allowed");
+ return false;
+ }
+
+ while (sz) {
+ uint64_t len = sz;
+
+ if (num_sg == max_num_sg) {
+ vu_panic(dev, "virtio: too many descriptors in indirect table");
+ return false;
+ }
+
+ iov[num_sg].iov_base = vu_gpa_to_va(dev, &len, pa);
+ if (iov[num_sg].iov_base == NULL) {
+ vu_panic(dev, "virtio: invalid address for buffers");
+ return false;
+ }
+ iov[num_sg].iov_len = len;
+ num_sg++;
+ sz -= len;
+ pa += len;
+ }
+
+ *p_num_sg = num_sg;
+ return true;
+}
+
+static void *
+virtqueue_alloc_element(size_t sz,
+ unsigned out_num, unsigned in_num)
+{
+ VuVirtqElement *elem;
+ size_t in_sg_ofs = ALIGN_UP(sz, __alignof__(elem->in_sg[0]));
+ size_t out_sg_ofs = in_sg_ofs + in_num * sizeof(elem->in_sg[0]);
+ size_t out_sg_end = out_sg_ofs + out_num * sizeof(elem->out_sg[0]);
+
+ assert(sz >= sizeof(VuVirtqElement));
+ elem = malloc(out_sg_end);
+ elem->out_num = out_num;
+ elem->in_num = in_num;
+ elem->in_sg = (void *)elem + in_sg_ofs;
+ elem->out_sg = (void *)elem + out_sg_ofs;
+ return elem;
+}
+
+static void *
+vu_queue_map_desc(VuDev *dev, VuVirtq *vq, unsigned int idx, size_t sz)
+{
+ struct vring_desc *desc = vq->vring.desc;
+ uint64_t desc_addr, read_len;
+ unsigned int desc_len;
+ unsigned int max = vq->vring.num;
+ unsigned int i = idx;
+ VuVirtqElement *elem;
+ unsigned int out_num = 0, in_num = 0;
+ struct iovec iov[VIRTQUEUE_MAX_SIZE];
+ struct vring_desc desc_buf[VIRTQUEUE_MAX_SIZE];
+ int rc;
+
+ if (le16toh(desc[i].flags) & VRING_DESC_F_INDIRECT) {
+ if (le32toh(desc[i].len) % sizeof(struct vring_desc)) {
+ vu_panic(dev, "Invalid size for indirect buffer table");
+ return NULL;
+ }
+
+ /* loop over the indirect descriptor table */
+ desc_addr = le64toh(desc[i].addr);
+ desc_len = le32toh(desc[i].len);
+ max = desc_len / sizeof(struct vring_desc);
+ read_len = desc_len;
+ desc = vu_gpa_to_va(dev, &read_len, desc_addr);
+ if (unlikely(desc && read_len != desc_len)) {
+ /* Failed to use zero copy */
+ desc = NULL;
+ if (!virtqueue_read_indirect_desc(dev, desc_buf,
+ desc_addr,
+ desc_len)) {
+ desc = desc_buf;
+ }
+ }
+ if (!desc) {
+ vu_panic(dev, "Invalid indirect buffer table");
+ return NULL;
+ }
+ i = 0;
+ }
+
+ /* Collect all the descriptors */
+ do {
+ if (le16toh(desc[i].flags) & VRING_DESC_F_WRITE) {
+ if (!virtqueue_map_desc(dev, &in_num, iov + out_num,
+ VIRTQUEUE_MAX_SIZE - out_num, true,
+ le64toh(desc[i].addr),
+ le32toh(desc[i].len))) {
+ return NULL;
+ }
+ } else {
+ if (in_num) {
+ vu_panic(dev, "Incorrect order for descriptors");
+ return NULL;
+ }
+ if (!virtqueue_map_desc(dev, &out_num, iov,
+ VIRTQUEUE_MAX_SIZE, false,
+ le64toh(desc[i].addr),
+ le32toh(desc[i].len))) {
+ return NULL;
+ }
+ }
+
+ /* If we've got too many, that implies a descriptor loop. */
+ if ((in_num + out_num) > max) {
+ vu_panic(dev, "Looped descriptor");
+ return NULL;
+ }
+ rc = virtqueue_read_next_desc(dev, desc, i, max, &i);
+ } while (rc == VIRTQUEUE_READ_DESC_MORE);
+
+ if (rc == VIRTQUEUE_READ_DESC_ERROR) {
+ vu_panic(dev, "read descriptor error");
+ return NULL;
+ }
+
+ /* Now copy what we have collected and mapped */
+ elem = virtqueue_alloc_element(sz, out_num, in_num);
+ elem->index = idx;
+ for (i = 0; i < out_num; i++) {
+ elem->out_sg[i] = iov[i];
+ }
+ for (i = 0; i < in_num; i++) {
+ elem->in_sg[i] = iov[out_num + i];
+ }
+
+ return elem;
+}
+
+static int
+vu_queue_inflight_get(VuDev *dev, VuVirtq *vq, int desc_idx)
+{
+ if (!vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD)) {
+ return 0;
+ }
+
+ if (unlikely(!vq->inflight)) {
+ return -1;
+ }
+
+ vq->inflight->desc[desc_idx].counter = vq->counter++;
+ vq->inflight->desc[desc_idx].inflight = 1;
+
+ return 0;
+}
+
+static int
+vu_queue_inflight_pre_put(VuDev *dev, VuVirtq *vq, int desc_idx)
+{
+ if (!vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD)) {
+ return 0;
+ }
+
+ if (unlikely(!vq->inflight)) {
+ return -1;
+ }
+
+ vq->inflight->last_batch_head = desc_idx;
+
+ return 0;
+}
+
+static int
+vu_queue_inflight_post_put(VuDev *dev, VuVirtq *vq, int desc_idx)
+{
+ if (!vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD)) {
+ return 0;
+ }
+
+ if (unlikely(!vq->inflight)) {
+ return -1;
+ }
+
+ barrier();
+
+ vq->inflight->desc[desc_idx].inflight = 0;
+
+ barrier();
+
+ vq->inflight->used_idx = vq->used_idx;
+
+ return 0;
+}
+
+void *
+vu_queue_pop(VuDev *dev, VuVirtq *vq, size_t sz)
+{
+ int i;
+ unsigned int head;
+ VuVirtqElement *elem;
+
+ if (unlikely(dev->broken) ||
+ unlikely(!vq->vring.avail)) {
+ return NULL;
+ }
+
+ if (unlikely(vq->resubmit_list && vq->resubmit_num > 0)) {
+ i = (--vq->resubmit_num);
+ elem = vu_queue_map_desc(dev, vq, vq->resubmit_list[i].index, sz);
+
+ if (!vq->resubmit_num) {
+ free(vq->resubmit_list);
+ vq->resubmit_list = NULL;
+ }
+
+ return elem;
+ }
+
+ if (vu_queue_empty(dev, vq)) {
+ return NULL;
+ }
+ /*
+ * Needed after virtio_queue_empty(), see comment in
+ * virtqueue_num_heads().
+ */
+ smp_rmb();
+
+ if (vq->inuse >= vq->vring.num) {
+ vu_panic(dev, "Virtqueue size exceeded");
+ return NULL;
+ }
+
+ if (!virtqueue_get_head(dev, vq, vq->last_avail_idx++, &head)) {
+ return NULL;
+ }
+
+ if (vu_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
+ vring_set_avail_event(vq, vq->last_avail_idx);
+ }
+
+ elem = vu_queue_map_desc(dev, vq, head, sz);
+
+ if (!elem) {
+ return NULL;
+ }
+
+ vq->inuse++;
+
+ vu_queue_inflight_get(dev, vq, head);
+
+ return elem;
+}
+
+static void
+vu_queue_detach_element(VuDev *dev, VuVirtq *vq, VuVirtqElement *elem,
+ size_t len)
+{
+ vq->inuse--;
+ /* unmap, when DMA support is added */
+}
+
+void
+vu_queue_unpop(VuDev *dev, VuVirtq *vq, VuVirtqElement *elem,
+ size_t len)
+{
+ vq->last_avail_idx--;
+ vu_queue_detach_element(dev, vq, elem, len);
+}
+
+bool
+vu_queue_rewind(VuDev *dev, VuVirtq *vq, unsigned int num)
+{
+ if (num > vq->inuse) {
+ return false;
+ }
+ vq->last_avail_idx -= num;
+ vq->inuse -= num;
+ return true;
+}
+
+static inline
+void vring_used_write(VuDev *dev, VuVirtq *vq,
+ struct vring_used_elem *uelem, int i)
+{
+ struct vring_used *used = vq->vring.used;
+
+ used->ring[i] = *uelem;
+ vu_log_write(dev, vq->vring.log_guest_addr +
+ offsetof(struct vring_used, ring[i]),
+ sizeof(used->ring[i]));
+}
+
+
+static void
+vu_log_queue_fill(VuDev *dev, VuVirtq *vq,
+ const VuVirtqElement *elem,
+ unsigned int len)
+{
+ struct vring_desc *desc = vq->vring.desc;
+ unsigned int i, max, min, desc_len;
+ uint64_t desc_addr, read_len;
+ struct vring_desc desc_buf[VIRTQUEUE_MAX_SIZE];
+ unsigned num_bufs = 0;
+
+ max = vq->vring.num;
+ i = elem->index;
+
+ if (le16toh(desc[i].flags) & VRING_DESC_F_INDIRECT) {
+ if (le32toh(desc[i].len) % sizeof(struct vring_desc)) {
+ vu_panic(dev, "Invalid size for indirect buffer table");
+ return;
+ }
+
+ /* loop over the indirect descriptor table */
+ desc_addr = le64toh(desc[i].addr);
+ desc_len = le32toh(desc[i].len);
+ max = desc_len / sizeof(struct vring_desc);
+ read_len = desc_len;
+ desc = vu_gpa_to_va(dev, &read_len, desc_addr);
+ if (unlikely(desc && read_len != desc_len)) {
+ /* Failed to use zero copy */
+ desc = NULL;
+ if (!virtqueue_read_indirect_desc(dev, desc_buf,
+ desc_addr,
+ desc_len)) {
+ desc = desc_buf;
+ }
+ }
+ if (!desc) {
+ vu_panic(dev, "Invalid indirect buffer table");
+ return;
+ }
+ i = 0;
+ }
+
+ do {
+ if (++num_bufs > max) {
+ vu_panic(dev, "Looped descriptor");
+ return;
+ }
+
+ if (le16toh(desc[i].flags) & VRING_DESC_F_WRITE) {
+ min = MIN(le32toh(desc[i].len), len);
+ vu_log_write(dev, le64toh(desc[i].addr), min);
+ len -= min;
+ }
+
+ } while (len > 0 &&
+ (virtqueue_read_next_desc(dev, desc, i, max, &i)
+ == VIRTQUEUE_READ_DESC_MORE));
+}
+
+void
+vu_queue_fill(VuDev *dev, VuVirtq *vq,
+ const VuVirtqElement *elem,
+ unsigned int len, unsigned int idx)
+{
+ struct vring_used_elem uelem;
+
+ if (unlikely(dev->broken) ||
+ unlikely(!vq->vring.avail)) {
+ return;
+ }
+
+ vu_log_queue_fill(dev, vq, elem, len);
+
+ idx = (idx + vq->used_idx) % vq->vring.num;
+
+ uelem.id = htole32(elem->index);
+ uelem.len = htole32(len);
+ vring_used_write(dev, vq, &uelem, idx);
+}
+
+static inline
+void vring_used_idx_set(VuDev *dev, VuVirtq *vq, uint16_t val)
+{
+ vq->vring.used->idx = htole16(val);
+ vu_log_write(dev,
+ vq->vring.log_guest_addr + offsetof(struct vring_used, idx),
+ sizeof(vq->vring.used->idx));
+
+ vq->used_idx = val;
+}
+
+void
+vu_queue_flush(VuDev *dev, VuVirtq *vq, unsigned int count)
+{
+ uint16_t old, new;
+
+ if (unlikely(dev->broken) ||
+ unlikely(!vq->vring.avail)) {
+ return;
+ }
+
+ /* Make sure buffer is written before we update index. */
+ smp_wmb();
+
+ old = vq->used_idx;
+ new = old + count;
+ vring_used_idx_set(dev, vq, new);
+ vq->inuse -= count;
+ if (unlikely((int16_t)(new - vq->signalled_used) < (uint16_t)(new - old))) {
+ vq->signalled_used_valid = false;
+ }
+}
+
+void
+vu_queue_push(VuDev *dev, VuVirtq *vq,
+ const VuVirtqElement *elem, unsigned int len)
+{
+ vu_queue_fill(dev, vq, elem, len, 0);
+ vu_queue_inflight_pre_put(dev, vq, elem->index);
+ vu_queue_flush(dev, vq, 1);
+ vu_queue_inflight_post_put(dev, vq, elem->index);
+}
diff --git a/tools/testing/roadtest/src/libvhost-user/libvhost-user.h b/tools/testing/roadtest/src/libvhost-user/libvhost-user.h
new file mode 100644
index 000000000000..691e0bc051c1
--- /dev/null
+++ b/tools/testing/roadtest/src/libvhost-user/libvhost-user.h
@@ -0,0 +1,691 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Vhost User library
+ *
+ * Copyright (c) 2016 Red Hat, Inc.
+ *
+ * Authors:
+ * Victor Kaplansky <[email protected]>
+ * Marc-André Lureau <[email protected]>
+ *
+ * This work is licensed under the terms of the GNU GPL, version 2 or
+ * later. See the COPYING file in the top-level directory.
+ */
+
+#ifndef LIBVHOST_USER_H
+#define LIBVHOST_USER_H
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <stddef.h>
+#include <poll.h>
+#include <linux/vhost.h>
+#include <pthread.h>
+#include <linux/virtio_ring.h>
+
+/* Based on qemu/hw/virtio/vhost-user.c */
+#define VHOST_USER_F_PROTOCOL_FEATURES 30
+#define VHOST_LOG_PAGE 4096
+
+#define VIRTQUEUE_MAX_SIZE 1024
+
+#define VHOST_MEMORY_BASELINE_NREGIONS 8
+
+/*
+ * Set a reasonable maximum number of ram slots, which will be supported by
+ * any architecture.
+ */
+#define VHOST_USER_MAX_RAM_SLOTS 32
+
+#define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
+
+typedef enum VhostSetConfigType {
+ VHOST_SET_CONFIG_TYPE_MASTER = 0,
+ VHOST_SET_CONFIG_TYPE_MIGRATION = 1,
+} VhostSetConfigType;
+
+/*
+ * Maximum size of virtio device config space
+ */
+#define VHOST_USER_MAX_CONFIG_SIZE 256
+
+enum VhostUserProtocolFeature {
+ VHOST_USER_PROTOCOL_F_MQ = 0,
+ VHOST_USER_PROTOCOL_F_LOG_SHMFD = 1,
+ VHOST_USER_PROTOCOL_F_RARP = 2,
+ VHOST_USER_PROTOCOL_F_REPLY_ACK = 3,
+ VHOST_USER_PROTOCOL_F_NET_MTU = 4,
+ VHOST_USER_PROTOCOL_F_SLAVE_REQ = 5,
+ VHOST_USER_PROTOCOL_F_CROSS_ENDIAN = 6,
+ VHOST_USER_PROTOCOL_F_CRYPTO_SESSION = 7,
+ VHOST_USER_PROTOCOL_F_PAGEFAULT = 8,
+ VHOST_USER_PROTOCOL_F_CONFIG = 9,
+ VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD = 10,
+ VHOST_USER_PROTOCOL_F_HOST_NOTIFIER = 11,
+ VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD = 12,
+ VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS = 14,
+ VHOST_USER_PROTOCOL_F_CONFIGURE_MEM_SLOTS = 15,
+
+ VHOST_USER_PROTOCOL_F_MAX
+};
+
+#define VHOST_USER_PROTOCOL_FEATURE_MASK ((1 << VHOST_USER_PROTOCOL_F_MAX) - 1)
+
+typedef enum VhostUserRequest {
+ VHOST_USER_NONE = 0,
+ VHOST_USER_GET_FEATURES = 1,
+ VHOST_USER_SET_FEATURES = 2,
+ VHOST_USER_SET_OWNER = 3,
+ VHOST_USER_RESET_OWNER = 4,
+ VHOST_USER_SET_MEM_TABLE = 5,
+ VHOST_USER_SET_LOG_BASE = 6,
+ VHOST_USER_SET_LOG_FD = 7,
+ VHOST_USER_SET_VRING_NUM = 8,
+ VHOST_USER_SET_VRING_ADDR = 9,
+ VHOST_USER_SET_VRING_BASE = 10,
+ VHOST_USER_GET_VRING_BASE = 11,
+ VHOST_USER_SET_VRING_KICK = 12,
+ VHOST_USER_SET_VRING_CALL = 13,
+ VHOST_USER_SET_VRING_ERR = 14,
+ VHOST_USER_GET_PROTOCOL_FEATURES = 15,
+ VHOST_USER_SET_PROTOCOL_FEATURES = 16,
+ VHOST_USER_GET_QUEUE_NUM = 17,
+ VHOST_USER_SET_VRING_ENABLE = 18,
+ VHOST_USER_SEND_RARP = 19,
+ VHOST_USER_NET_SET_MTU = 20,
+ VHOST_USER_SET_SLAVE_REQ_FD = 21,
+ VHOST_USER_IOTLB_MSG = 22,
+ VHOST_USER_SET_VRING_ENDIAN = 23,
+ VHOST_USER_GET_CONFIG = 24,
+ VHOST_USER_SET_CONFIG = 25,
+ VHOST_USER_CREATE_CRYPTO_SESSION = 26,
+ VHOST_USER_CLOSE_CRYPTO_SESSION = 27,
+ VHOST_USER_POSTCOPY_ADVISE = 28,
+ VHOST_USER_POSTCOPY_LISTEN = 29,
+ VHOST_USER_POSTCOPY_END = 30,
+ VHOST_USER_GET_INFLIGHT_FD = 31,
+ VHOST_USER_SET_INFLIGHT_FD = 32,
+ VHOST_USER_GPU_SET_SOCKET = 33,
+ VHOST_USER_VRING_KICK = 35,
+ VHOST_USER_GET_MAX_MEM_SLOTS = 36,
+ VHOST_USER_ADD_MEM_REG = 37,
+ VHOST_USER_REM_MEM_REG = 38,
+ VHOST_USER_MAX
+} VhostUserRequest;
+
+typedef enum VhostUserSlaveRequest {
+ VHOST_USER_SLAVE_NONE = 0,
+ VHOST_USER_SLAVE_IOTLB_MSG = 1,
+ VHOST_USER_SLAVE_CONFIG_CHANGE_MSG = 2,
+ VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
+ VHOST_USER_SLAVE_VRING_CALL = 4,
+ VHOST_USER_SLAVE_VRING_ERR = 5,
+ VHOST_USER_SLAVE_MAX
+} VhostUserSlaveRequest;
+
+typedef struct VhostUserMemoryRegion {
+ uint64_t guest_phys_addr;
+ uint64_t memory_size;
+ uint64_t userspace_addr;
+ uint64_t mmap_offset;
+} VhostUserMemoryRegion;
+
+typedef struct VhostUserMemory {
+ uint32_t nregions;
+ uint32_t padding;
+ VhostUserMemoryRegion regions[VHOST_MEMORY_BASELINE_NREGIONS];
+} VhostUserMemory;
+
+typedef struct VhostUserMemRegMsg {
+ uint64_t padding;
+ VhostUserMemoryRegion region;
+} VhostUserMemRegMsg;
+
+typedef struct VhostUserLog {
+ uint64_t mmap_size;
+ uint64_t mmap_offset;
+} VhostUserLog;
+
+typedef struct VhostUserConfig {
+ uint32_t offset;
+ uint32_t size;
+ uint32_t flags;
+ uint8_t region[VHOST_USER_MAX_CONFIG_SIZE];
+} VhostUserConfig;
+
+static VhostUserConfig c __attribute__ ((unused));
+#define VHOST_USER_CONFIG_HDR_SIZE (sizeof(c.offset) \
+ + sizeof(c.size) \
+ + sizeof(c.flags))
+
+typedef struct VhostUserVringArea {
+ uint64_t u64;
+ uint64_t size;
+ uint64_t offset;
+} VhostUserVringArea;
+
+typedef struct VhostUserInflight {
+ uint64_t mmap_size;
+ uint64_t mmap_offset;
+ uint16_t num_queues;
+ uint16_t queue_size;
+} VhostUserInflight;
+
+#if defined(_WIN32) && (defined(__x86_64__) || defined(__i386__))
+# define VU_PACKED __attribute__((gcc_struct, packed))
+#else
+# define VU_PACKED __attribute__((packed))
+#endif
+
+typedef struct VhostUserMsg {
+ int request;
+
+#define VHOST_USER_VERSION_MASK (0x3)
+#define VHOST_USER_REPLY_MASK (0x1 << 2)
+#define VHOST_USER_NEED_REPLY_MASK (0x1 << 3)
+ uint32_t flags;
+ uint32_t size; /* the following payload size */
+
+ union {
+#define VHOST_USER_VRING_IDX_MASK (0xff)
+#define VHOST_USER_VRING_NOFD_MASK (0x1 << 8)
+ uint64_t u64;
+ struct vhost_vring_state state;
+ struct vhost_vring_addr addr;
+ VhostUserMemory memory;
+ VhostUserMemRegMsg memreg;
+ VhostUserLog log;
+ VhostUserConfig config;
+ VhostUserVringArea area;
+ VhostUserInflight inflight;
+ } payload;
+
+ int fds[VHOST_MEMORY_BASELINE_NREGIONS];
+ int fd_num;
+ uint8_t *data;
+} VU_PACKED VhostUserMsg;
+
+typedef struct VuDevRegion {
+ /* Guest Physical address. */
+ uint64_t gpa;
+ /* Memory region size. */
+ uint64_t size;
+ /* QEMU virtual address (userspace). */
+ uint64_t qva;
+ /* Starting offset in our mmaped space. */
+ uint64_t mmap_offset;
+ /* Start address of mmaped space. */
+ uint64_t mmap_addr;
+} VuDevRegion;
+
+typedef struct VuDev VuDev;
+
+typedef uint64_t (*vu_get_features_cb) (VuDev *dev);
+typedef void (*vu_set_features_cb) (VuDev *dev, uint64_t features);
+typedef int (*vu_process_msg_cb) (VuDev *dev, VhostUserMsg *vmsg,
+ int *do_reply);
+typedef bool (*vu_read_msg_cb) (VuDev *dev, int sock, VhostUserMsg *vmsg);
+typedef void (*vu_queue_set_started_cb) (VuDev *dev, int qidx, bool started);
+typedef bool (*vu_queue_is_processed_in_order_cb) (VuDev *dev, int qidx);
+typedef int (*vu_get_config_cb) (VuDev *dev, uint8_t *config, uint32_t len);
+typedef int (*vu_set_config_cb) (VuDev *dev, const uint8_t *data,
+ uint32_t offset, uint32_t size,
+ uint32_t flags);
+
+typedef struct VuDevIface {
+ /* called by VHOST_USER_GET_FEATURES to get the features bitmask */
+ vu_get_features_cb get_features;
+ /* enable vhost implementation features */
+ vu_set_features_cb set_features;
+ /* get the protocol feature bitmask from the underlying vhost
+ * implementation */
+ vu_get_features_cb get_protocol_features;
+ /* enable protocol features in the underlying vhost implementation. */
+ vu_set_features_cb set_protocol_features;
+ /* process_msg is called for each vhost-user message received */
+ /* skip libvhost-user processing if return value != 0 */
+ vu_process_msg_cb process_msg;
+ /* tells when queues can be processed */
+ vu_queue_set_started_cb queue_set_started;
+ /*
+ * If the queue is processed in order, in which case it will be
+ * resumed to vring.used->idx. This can help to support resuming
+ * on unmanaged exit/crash.
+ */
+ vu_queue_is_processed_in_order_cb queue_is_processed_in_order;
+ /* get the config space of the device */
+ vu_get_config_cb get_config;
+ /* set the config space of the device */
+ vu_set_config_cb set_config;
+} VuDevIface;
+
+typedef void (*vu_queue_handler_cb) (VuDev *dev, int qidx);
+
+typedef struct VuRing {
+ unsigned int num;
+ struct vring_desc *desc;
+ struct vring_avail *avail;
+ struct vring_used *used;
+ uint64_t log_guest_addr;
+ uint32_t flags;
+} VuRing;
+
+typedef struct VuDescStateSplit {
+ /* Indicate whether this descriptor is inflight or not.
+ * Only available for head-descriptor. */
+ uint8_t inflight;
+
+ /* Padding */
+ uint8_t padding[5];
+
+ /* Maintain a list for the last batch of used descriptors.
+ * Only available when batching is used for submitting */
+ uint16_t next;
+
+ /* Used to preserve the order of fetching available descriptors.
+ * Only available for head-descriptor. */
+ uint64_t counter;
+} VuDescStateSplit;
+
+typedef struct VuVirtqInflight {
+ /* The feature flags of this region. Now it's initialized to 0. */
+ uint64_t features;
+
+ /* The version of this region. It's 1 currently.
+ * Zero value indicates a vm reset happened. */
+ uint16_t version;
+
+ /* The size of VuDescStateSplit array. It's equal to the virtqueue
+ * size. Slave could get it from queue size field of VhostUserInflight. */
+ uint16_t desc_num;
+
+ /* The head of list that track the last batch of used descriptors. */
+ uint16_t last_batch_head;
+
+ /* Storing the idx value of used ring */
+ uint16_t used_idx;
+
+ /* Used to track the state of each descriptor in descriptor table */
+ VuDescStateSplit desc[];
+} VuVirtqInflight;
+
+typedef struct VuVirtqInflightDesc {
+ uint16_t index;
+ uint64_t counter;
+} VuVirtqInflightDesc;
+
+typedef struct VuVirtq {
+ VuRing vring;
+
+ VuVirtqInflight *inflight;
+
+ VuVirtqInflightDesc *resubmit_list;
+
+ uint16_t resubmit_num;
+
+ uint64_t counter;
+
+ /* Next head to pop */
+ uint16_t last_avail_idx;
+
+ /* Last avail_idx read from VQ. */
+ uint16_t shadow_avail_idx;
+
+ uint16_t used_idx;
+
+ /* Last used index value we have signalled on */
+ uint16_t signalled_used;
+
+ /* Last used index value we have signalled on */
+ bool signalled_used_valid;
+
+ /* Notification enabled? */
+ bool notification;
+
+ int inuse;
+
+ vu_queue_handler_cb handler;
+
+ int call_fd;
+ int kick_fd;
+ int err_fd;
+ unsigned int enable;
+ bool started;
+
+ /* Guest addresses of our ring */
+ struct vhost_vring_addr vra;
+} VuVirtq;
+
+enum VuWatchCondtion {
+ VU_WATCH_IN = POLLIN,
+ VU_WATCH_OUT = POLLOUT,
+ VU_WATCH_PRI = POLLPRI,
+ VU_WATCH_ERR = POLLERR,
+ VU_WATCH_HUP = POLLHUP,
+};
+
+typedef void (*vu_panic_cb) (VuDev *dev, const char *err);
+typedef void (*vu_watch_cb) (VuDev *dev, int condition, void *data);
+typedef void (*vu_set_watch_cb) (VuDev *dev, int fd, int condition,
+ vu_watch_cb cb, void *data);
+typedef void (*vu_remove_watch_cb) (VuDev *dev, int fd);
+
+typedef struct VuDevInflightInfo {
+ int fd;
+ void *addr;
+ uint64_t size;
+} VuDevInflightInfo;
+
+struct VuDev {
+ int sock;
+ uint32_t nregions;
+ VuDevRegion regions[VHOST_USER_MAX_RAM_SLOTS];
+ VuVirtq *vq;
+ VuDevInflightInfo inflight_info;
+ int log_call_fd;
+ /* Must be held while using slave_fd */
+ pthread_mutex_t slave_mutex;
+ int slave_fd;
+ uint64_t log_size;
+ uint8_t *log_table;
+ uint64_t features;
+ uint64_t protocol_features;
+ bool broken;
+ uint16_t max_queues;
+
+ /*
+ * @read_msg: custom method to read vhost-user message
+ *
+ * Read data from vhost_user socket fd and fill up
+ * the passed VhostUserMsg *vmsg struct.
+ *
+ * If reading fails, it should close the received set of file
+ * descriptors as socket message's auxiliary data.
+ *
+ * For the details, please refer to vu_message_read in libvhost-user.c
+ * which will be used by default if not custom method is provided when
+ * calling vu_init
+ *
+ * Returns: true if vhost-user message successfully received,
+ * otherwise return false.
+ *
+ */
+ vu_read_msg_cb read_msg;
+
+ /*
+ * @set_watch: add or update the given fd to the watch set,
+ * call cb when condition is met.
+ */
+ vu_set_watch_cb set_watch;
+
+ /* @remove_watch: remove the given fd from the watch set */
+ vu_remove_watch_cb remove_watch;
+
+ /*
+ * @panic: encountered an unrecoverable error, you may try to re-initialize
+ */
+ vu_panic_cb panic;
+ const VuDevIface *iface;
+
+ /* Postcopy data */
+ int postcopy_ufd;
+ bool postcopy_listening;
+};
+
+typedef struct VuVirtqElement {
+ unsigned int index;
+ unsigned int out_num;
+ unsigned int in_num;
+ struct iovec *in_sg;
+ struct iovec *out_sg;
+} VuVirtqElement;
+
+/**
+ * vu_init:
+ * @dev: a VuDev context
+ * @max_queues: maximum number of virtqueues
+ * @socket: the socket connected to vhost-user master
+ * @panic: a panic callback
+ * @set_watch: a set_watch callback
+ * @remove_watch: a remove_watch callback
+ * @iface: a VuDevIface structure with vhost-user device callbacks
+ *
+ * Initializes a VuDev vhost-user context.
+ *
+ * Returns: true on success, false on failure.
+ **/
+bool vu_init(VuDev *dev,
+ uint16_t max_queues,
+ int socket,
+ vu_panic_cb panic,
+ vu_read_msg_cb read_msg,
+ vu_set_watch_cb set_watch,
+ vu_remove_watch_cb remove_watch,
+ const VuDevIface *iface);
+
+
+/**
+ * vu_deinit:
+ * @dev: a VuDev context
+ *
+ * Cleans up the VuDev context
+ */
+void vu_deinit(VuDev *dev);
+
+/**
+ * vu_dispatch:
+ * @dev: a VuDev context
+ *
+ * Process one vhost-user message.
+ *
+ * Returns: TRUE on success, FALSE on failure.
+ */
+bool vu_dispatch(VuDev *dev);
+
+/**
+ * vu_gpa_to_va:
+ * @dev: a VuDev context
+ * @plen: guest memory size
+ * @guest_addr: guest address
+ *
+ * Translate a guest address to a pointer. Returns NULL on failure.
+ */
+void *vu_gpa_to_va(VuDev *dev, uint64_t *plen, uint64_t guest_addr);
+
+/**
+ * vu_get_queue:
+ * @dev: a VuDev context
+ * @qidx: queue index
+ *
+ * Returns the queue number @qidx.
+ */
+VuVirtq *vu_get_queue(VuDev *dev, int qidx);
+
+/**
+ * vu_set_queue_handler:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @handler: the queue handler callback
+ *
+ * Set the queue handler. This function may be called several times
+ * for the same queue. If called with NULL @handler, the handler is
+ * removed.
+ */
+void vu_set_queue_handler(VuDev *dev, VuVirtq *vq,
+ vu_queue_handler_cb handler);
+
+/**
+ * vu_set_queue_host_notifier:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @fd: a file descriptor
+ * @size: host page size
+ * @offset: notifier offset in @fd file
+ *
+ * Set queue's host notifier. This function may be called several
+ * times for the same queue. If called with -1 @fd, the notifier
+ * is removed.
+ */
+bool vu_set_queue_host_notifier(VuDev *dev, VuVirtq *vq, int fd,
+ int size, int offset);
+
+/**
+ * vu_queue_set_notification:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @enable: state
+ *
+ * Set whether the queue notifies (via event index or interrupt)
+ */
+void vu_queue_set_notification(VuDev *dev, VuVirtq *vq, int enable);
+
+/**
+ * vu_queue_enabled:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ *
+ * Returns: whether the queue is enabled.
+ */
+bool vu_queue_enabled(VuDev *dev, VuVirtq *vq);
+
+/**
+ * vu_queue_started:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ *
+ * Returns: whether the queue is started.
+ */
+bool vu_queue_started(const VuDev *dev, const VuVirtq *vq);
+
+/**
+ * vu_queue_empty:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ *
+ * Returns: true if the queue is empty or not ready.
+ */
+bool vu_queue_empty(VuDev *dev, VuVirtq *vq);
+
+/**
+ * vu_queue_notify:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ *
+ * Request to notify the queue via callfd (skipped if unnecessary)
+ */
+void vu_queue_notify(VuDev *dev, VuVirtq *vq);
+
+/**
+ * vu_queue_notify_sync:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ *
+ * Request to notify the queue via callfd (skipped if unnecessary)
+ * or sync message if possible.
+ */
+void vu_queue_notify_sync(VuDev *dev, VuVirtq *vq);
+
+/**
+ * vu_queue_pop:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @sz: the size of struct to return (must be >= VuVirtqElement)
+ *
+ * Returns: a VuVirtqElement filled from the queue or NULL. The
+ * returned element must be free()-d by the caller.
+ */
+void *vu_queue_pop(VuDev *dev, VuVirtq *vq, size_t sz);
+
+
+/**
+ * vu_queue_unpop:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @elem: The #VuVirtqElement
+ * @len: number of bytes written
+ *
+ * Pretend the most recent element wasn't popped from the virtqueue. The next
+ * call to vu_queue_pop() will refetch the element.
+ */
+void vu_queue_unpop(VuDev *dev, VuVirtq *vq, VuVirtqElement *elem,
+ size_t len);
+
+/**
+ * vu_queue_rewind:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @num: number of elements to push back
+ *
+ * Pretend that elements weren't popped from the virtqueue. The next
+ * virtqueue_pop() will refetch the oldest element.
+ *
+ * Returns: true on success, false if @num is greater than the number of in use
+ * elements.
+ */
+bool vu_queue_rewind(VuDev *dev, VuVirtq *vq, unsigned int num);
+
+/**
+ * vu_queue_fill:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @elem: a VuVirtqElement
+ * @len: length in bytes to write
+ * @idx: optional offset for the used ring index (0 in general)
+ *
+ * Fill the used ring with @elem element.
+ */
+void vu_queue_fill(VuDev *dev, VuVirtq *vq,
+ const VuVirtqElement *elem,
+ unsigned int len, unsigned int idx);
+
+/**
+ * vu_queue_push:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @elem: a VuVirtqElement
+ * @len: length in bytes to write
+ *
+ * Helper that combines vu_queue_fill() with a vu_queue_flush().
+ */
+void vu_queue_push(VuDev *dev, VuVirtq *vq,
+ const VuVirtqElement *elem, unsigned int len);
+
+/**
+ * vu_queue_flush:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @num: number of elements to flush
+ *
+ * Mark the last number of elements as done (used.idx is updated by
+ * num elements).
+*/
+void vu_queue_flush(VuDev *dev, VuVirtq *vq, unsigned int num);
+
+/**
+ * vu_queue_get_avail_bytes:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @in_bytes: in bytes
+ * @out_bytes: out bytes
+ * @max_in_bytes: stop counting after max_in_bytes
+ * @max_out_bytes: stop counting after max_out_bytes
+ *
+ * Count the number of available bytes, up to max_in_bytes/max_out_bytes.
+ */
+void vu_queue_get_avail_bytes(VuDev *vdev, VuVirtq *vq, unsigned int *in_bytes,
+ unsigned int *out_bytes,
+ unsigned max_in_bytes, unsigned max_out_bytes);
+
+/**
+ * vu_queue_avail_bytes:
+ * @dev: a VuDev context
+ * @vq: a VuVirtq queue
+ * @in_bytes: expected in bytes
+ * @out_bytes: expected out bytes
+ *
+ * Returns: true if in_bytes <= in_total && out_bytes <= out_total
+ */
+bool vu_queue_avail_bytes(VuDev *dev, VuVirtq *vq, unsigned int in_bytes,
+ unsigned int out_bytes);
+
+#endif /* LIBVHOST_USER_H */
--
2.34.1
Add a Makefile and other miscellaneous build-related files for the
roadtest framework.
To make it easier to run the tests on systems which do not have the
required libraries or Python version, a Dockerfile is included and the
Makefile has built-in support for running the tests in a Docker
container.
Targets for code formatting and static checking of the Python code are
included.
Signed-off-by: Vincent Whitchurch <[email protected]>
---
tools/testing/roadtest/.gitignore | 2 +
tools/testing/roadtest/Dockerfile | 25 ++++++++
tools/testing/roadtest/Makefile | 84 +++++++++++++++++++++++++
tools/testing/roadtest/pyproject.toml | 10 +++
tools/testing/roadtest/requirements.txt | 4 ++
tools/testing/roadtest/src/.gitignore | 1 +
6 files changed, 126 insertions(+)
create mode 100644 tools/testing/roadtest/.gitignore
create mode 100644 tools/testing/roadtest/Dockerfile
create mode 100644 tools/testing/roadtest/Makefile
create mode 100644 tools/testing/roadtest/pyproject.toml
create mode 100644 tools/testing/roadtest/requirements.txt
create mode 100644 tools/testing/roadtest/src/.gitignore
diff --git a/tools/testing/roadtest/.gitignore b/tools/testing/roadtest/.gitignore
new file mode 100644
index 000000000000..0cbd00343694
--- /dev/null
+++ b/tools/testing/roadtest/.gitignore
@@ -0,0 +1,2 @@
+__pycache__
+.py[cod]
diff --git a/tools/testing/roadtest/Dockerfile b/tools/testing/roadtest/Dockerfile
new file mode 100644
index 000000000000..f2982179c327
--- /dev/null
+++ b/tools/testing/roadtest/Dockerfile
@@ -0,0 +1,25 @@
+FROM debian:bullseye
+
+# Kernel build
+RUN apt-get update && apt-get -y install \
+ bc \
+ build-essential \
+ flex \
+ bison \
+ rsync \
+ kmod
+
+# Running roadtests
+RUN apt-get update && apt-get -y install \
+ python3.9 \
+ libpython3.9-dev \
+ python3 \
+ device-tree-compiler
+
+# Development and debugging
+RUN apt-get update && apt-get -y install \
+ uml-utilities \
+ telnetd \
+ python3-pip
+COPY requirements.txt /tmp/
+RUN pip install --requirement /tmp/requirements.txt
diff --git a/tools/testing/roadtest/Makefile b/tools/testing/roadtest/Makefile
new file mode 100644
index 000000000000..525b26581142
--- /dev/null
+++ b/tools/testing/roadtest/Makefile
@@ -0,0 +1,84 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+.PHONY: all build-kernel test clean check fmt docker-run
+
+all:
+
+KSOURCE := ${PWD}
+ROADTEST_DIR = ${CURDIR}
+ROADTEST_BUILD_DIR := ${KSOURCE}/.roadtest
+KHEADERS := ${ROADTEST_BUILD_DIR}/usr
+KMODULES := ${ROADTEST_BUILD_DIR}/modules
+
+ifeq (${KSOURCE},${ROADTEST_DIR})
+# Make make from the standard roadtest directory work without having to set
+# additional variables.
+KSOURCE=$(ROADTEST_DIR:/tools/testing/roadtest=)
+endif
+
+CFLAGS += -g -D_GNU_SOURCE=1 -Wall -Werror -std=gnu99 \
+ -I${KSOURCE}/tools/include/ \
+ -I${KHEADERS}/include/ \
+ -I${ROADTEST_DIR}/src/libvhost-user/ \
+ $(shell python3-config --embed --includes) -O2
+
+${ROADTEST_BUILD_DIR}/roadtest-backend: ${ROADTEST_BUILD_DIR}/backend.o ${ROADTEST_BUILD_DIR}/libvhost-user.o
+ $(CC) -o $@ $^ $(shell python3-config --embed --libs)
+ # For the benefit of clangd
+ echo ${CFLAGS} | tr " " "\n" > ${ROADTEST_DIR}/src/compile_flags.txt
+
+${ROADTEST_BUILD_DIR}/backend.o: src/backend.c
+ $(CC) -c -o $@ $(CFLAGS) $<
+
+${ROADTEST_BUILD_DIR}/libvhost-user.o: src/libvhost-user/libvhost-user.c
+ $(CC) -c -o $@ $(CFLAGS) $<
+
+clean:
+ rm -rf ${ROADTEST_BUILD_DIR} .docker_built
+
+ifeq ($(DOCKER),1)
+.docker_built: Dockerfile requirements.txt
+ docker build --network=host -t roadtest ${ROADTEST_DIR}
+ touch $@
+
+# --network=host allows UML's con=port:... to work seamlessly
+docker-run: .docker_built
+ mkdir -p ${ROADTEST_BUILD_DIR}/umltmp
+ docker run --network=host ${DOCKEROPTS} --user $(shell id -u ${USER}):$(shell id -g ${USER}) --interactive --tty --rm -v ${KSOURCE}:${KSOURCE} -w ${KSOURCE} --env TMPDIR=${ROADTEST_BUILD_DIR}/umltmp roadtest sh -c '${MAKE} -C ${ROADTEST_DIR} -${MAKEFLAGS} ${MAKECMDGOALS} DOCKER=0'
+
+all test build-kernel check fmt: docker-run
+ @:
+else
+all: test
+
+ifneq ($(KBUILD),0)
+# Calling make on the kernel is slow even if there is nothing to be rebuilt.
+# Allow the user to avoid it with KBUILD=0
+${ROADTEST_BUILD_DIR}/backend.o: build-kernel
+${ROADTEST_BUILD_DIR}/libvhost-user.o: build-kernel
+test: build-kernel
+endif
+
+build-kernel:
+ mkdir -p ${ROADTEST_BUILD_DIR}
+ find ${ROADTEST_DIR}/roadtest/tests/ -type f -name config | xargs cat > ${ROADTEST_BUILD_DIR}/.config
+ ${MAKE} -C ${KSOURCE} ARCH=um O=${ROADTEST_BUILD_DIR} olddefconfig
+ ${MAKE} -C ${KSOURCE} ARCH=um O=${ROADTEST_BUILD_DIR}
+ ${MAKE} -C ${KSOURCE} ARCH=um O=${ROADTEST_BUILD_DIR} INSTALL_HDR_PATH=${KHEADERS} headers_install
+ ${MAKE} -C ${KSOURCE} ARCH=um O=${ROADTEST_BUILD_DIR} INSTALL_MOD_PATH=${KMODULES} modules_install
+
+test: ${ROADTEST_BUILD_DIR}/roadtest-backend
+ python3 -m roadtest.cmd.main --ksrc-dir ${KSOURCE} --build-dir ${ROADTEST_BUILD_DIR} --work-dir ${ROADTEST_BUILD_DIR}/roadtest-work/ ${OPTS}
+
+check:
+ mypy --no-error-summary roadtest
+ pyflakes roadtest
+ black --check roadtest
+ isort --profile black --check roadtest
+
+fmt:
+ black roadtest
+ isort --profile black roadtest
+
+endif
diff --git a/tools/testing/roadtest/pyproject.toml b/tools/testing/roadtest/pyproject.toml
new file mode 100644
index 000000000000..6b8b05eb3cad
--- /dev/null
+++ b/tools/testing/roadtest/pyproject.toml
@@ -0,0 +1,10 @@
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+disallow_untyped_defs = true
+check_untyped_defs = true
+no_implicit_optional = true
+warn_return_any = true
+warn_unused_ignores = true
+show_error_codes = true
diff --git a/tools/testing/roadtest/requirements.txt b/tools/testing/roadtest/requirements.txt
new file mode 100644
index 000000000000..e1ac403d826e
--- /dev/null
+++ b/tools/testing/roadtest/requirements.txt
@@ -0,0 +1,4 @@
+black==22.1.0
+isort==5.10.1
+mypy==0.931
+pyflakes==2.4.0
diff --git a/tools/testing/roadtest/src/.gitignore b/tools/testing/roadtest/src/.gitignore
new file mode 100644
index 000000000000..895dab3fe4be
--- /dev/null
+++ b/tools/testing/roadtest/src/.gitignore
@@ -0,0 +1 @@
+compile_flags.txt
--
2.34.1
Add a roadtest for the PCF8563 RTC driver, testing many of the features
including alarm and invalid time handling. Since it's the first
roadtest for RTC, some helper code for handling the ABI is included.
The following fixes were posted for problems identified during
development of these tests:
- rtc: fix use-after-free on device removal
https://lore.kernel.org/lkml/[email protected]/
- rtc: pcf8563: clear RTC_FEATURE_ALARM if no irq
https://lore.kernel.org/lkml/[email protected]/
- rtc: pcf8523: fix alarm interrupt disabling
https://lore.kernel.org/lkml/[email protected]/
(not the same hardware/driver, but this was the original target for
test development)
Signed-off-by: Vincent Whitchurch <[email protected]>
---
.../roadtest/roadtest/tests/rtc/__init__.py | 0
.../roadtest/roadtest/tests/rtc/config | 1 +
.../roadtest/roadtest/tests/rtc/rtc.py | 73 ++++
.../roadtest/tests/rtc/test_pcf8563.py | 348 ++++++++++++++++++
4 files changed, 422 insertions(+)
create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/__init__.py
create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/config
create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/rtc.py
create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/test_pcf8563.py
diff --git a/tools/testing/roadtest/roadtest/tests/rtc/__init__.py b/tools/testing/roadtest/roadtest/tests/rtc/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/tools/testing/roadtest/roadtest/tests/rtc/config b/tools/testing/roadtest/roadtest/tests/rtc/config
new file mode 100644
index 000000000000..f3654f9d7c19
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/rtc/config
@@ -0,0 +1 @@
+CONFIG_RTC_DRV_PCF8563=m
diff --git a/tools/testing/roadtest/roadtest/tests/rtc/rtc.py b/tools/testing/roadtest/roadtest/tests/rtc/rtc.py
new file mode 100644
index 000000000000..1a2855bfc195
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/rtc/rtc.py
@@ -0,0 +1,73 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import contextlib
+import fcntl
+import struct
+import typing
+from pathlib import Path
+from typing import Any, cast
+
+RTC_RD_TIME = 0x80247009
+RTC_SET_TIME = 0x4024700A
+RTC_WKALM_SET = 0x4028700F
+RTC_VL_READ = 0x80047013
+
+RTC_IRQF = 0x80
+RTC_AF = 0x20
+
+RTC_VL_DATA_INVALID = 1 << 0
+
+
+class RTCTime(typing.NamedTuple):
+ tm_sec: int
+ tm_min: int
+ tm_hour: int
+ tm_mday: int
+ tm_mon: int
+ tm_year: int
+ tm_wday: int
+ tm_yday: int
+ tm_isdst: int
+
+
+class RTC(contextlib.AbstractContextManager):
+ def __init__(self, devpath: Path) -> None:
+ rtc = next(devpath.glob("rtc/rtc*")).name
+ self.filename = f"/dev/{rtc}"
+
+ def __enter__(self) -> "RTC":
+ self.file = open(self.filename, "rb")
+ return self
+
+ def __exit__(self, *_: Any) -> None:
+ self.file.close()
+
+ def read_time(self) -> RTCTime:
+ s = struct.Struct("9i")
+ buf = bytearray(s.size)
+ fcntl.ioctl(self.file.fileno(), RTC_RD_TIME, buf)
+ return RTCTime._make(s.unpack(buf))
+
+ def set_time(self, tm: RTCTime) -> int:
+ s = struct.Struct("9i")
+ buf = bytearray(s.size)
+ s.pack_into(buf, 0, *tm)
+ return fcntl.ioctl(self.file.fileno(), RTC_SET_TIME, buf)
+
+ def set_wake_alarm(self, enabled: bool, time: RTCTime) -> int:
+ s = struct.Struct("2B9i")
+ buf = bytearray(s.size)
+ s.pack_into(buf, 0, enabled, False, *time)
+ return fcntl.ioctl(self.file.fileno(), RTC_WKALM_SET, buf)
+
+ def read(self) -> int:
+ s = struct.Struct("L")
+ buf = self.file.read(s.size)
+ return cast(int, s.unpack(buf)[0])
+
+ def read_vl(self) -> int:
+ s = struct.Struct("I")
+ buf = bytearray(s.size)
+ fcntl.ioctl(self.file.fileno(), RTC_VL_READ, buf)
+ return cast(int, s.unpack(buf)[0])
diff --git a/tools/testing/roadtest/roadtest/tests/rtc/test_pcf8563.py b/tools/testing/roadtest/roadtest/tests/rtc/test_pcf8563.py
new file mode 100644
index 000000000000..a9f4c6d92762
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/rtc/test_pcf8563.py
@@ -0,0 +1,348 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import errno
+import logging
+from typing import Any, Final, Optional
+
+from roadtest.backend.i2c import I2CModel
+from roadtest.core.devicetree import DtFragment, DtVar
+from roadtest.core.hardware import Hardware
+from roadtest.core.modules import insmod
+from roadtest.core.suite import UMLTestCase
+from roadtest.core.sysfs import I2CDriver
+
+from . import rtc
+
+logger = logging.getLogger(__name__)
+
+REG_CONTROL_STATUS_1: Final = 0x00
+REG_CONTROL_STATUS_2: Final = 0x01
+REG_VL_SECONDS: Final = 0x02
+REG_VL_MINUTES: Final = 0x03
+REG_VL_HOURS: Final = 0x04
+REG_VL_DAYS: Final = 0x05
+REG_VL_WEEKDAYS: Final = 0x06
+REG_VL_CENTURY_MONTHS: Final = 0x07
+REG_VL_YEARS: Final = 0x08
+REG_VL_MINUTE_ALARM: Final = 0x09
+REG_VL_HOUR_ALARM: Final = 0x0A
+REG_VL_DAY_ALARM: Final = 0x0B
+REG_VL_WEEKDAY_ALARM: Final = 0x0C
+REG_CLKOUT_CONTROL: Final = 0x0D
+REG_TIMER_CONTROL: Final = 0x0E
+REG_TIMER: Final = 0x0F
+
+REG_CONTROL_STATUS_2_AIE: Final = 1 << 1
+REG_CONTROL_STATUS_2_AF: Final = 1 << 3
+
+REG_VL_CENTURY_MONTHS_C: Final = 1 << 7
+
+REG_VL_ALARM_AE: Final = 1 << 7
+
+
+class PCF8563(I2CModel):
+ def __init__(self, int: Optional[int] = None, **kwargs: Any) -> None:
+ super().__init__(**kwargs)
+ self.int = int
+ self._set_int(False)
+
+ self.reg_addr = 0
+ # Reset values from Table 27 in datasheet, with X and - bits set to 0
+ self.regs = {
+ REG_CONTROL_STATUS_1: 0b_0000_1000,
+ REG_CONTROL_STATUS_2: 0b_0000_0000,
+ REG_VL_SECONDS: 0b_1000_0000,
+ REG_VL_MINUTES: 0b_0000_0000,
+ REG_VL_HOURS: 0b_0000_0000,
+ REG_VL_DAYS: 0b_0000_0000,
+ REG_VL_WEEKDAYS: 0b_0000_0000,
+ REG_VL_CENTURY_MONTHS: 0b_0000_0000,
+ REG_VL_YEARS: 0b_0000_0000,
+ REG_VL_MINUTE_ALARM: 0b_1000_0000,
+ REG_VL_HOUR_ALARM: 0b_1000_0000,
+ REG_VL_DAY_ALARM: 0b_1000_0000,
+ REG_VL_WEEKDAY_ALARM: 0b_1000_0000,
+ REG_CLKOUT_CONTROL: 0b_1000_0000,
+ REG_TIMER_CONTROL: 0b_0000_0011,
+ REG_TIMER: 0b_0000_0000,
+ }
+
+ def _set_int(self, active: int) -> None:
+ # Active-low
+ self.backend.gpio.set(self.int, not active)
+
+ def _check_alarm(self, addr: int) -> None:
+ alarmregs = [
+ REG_VL_MINUTE_ALARM,
+ REG_VL_HOUR_ALARM,
+ REG_VL_DAY_ALARM,
+ REG_VL_WEEKDAY_ALARM,
+ ]
+ timeregs = [
+ REG_VL_MINUTES,
+ REG_VL_HOURS,
+ REG_VL_DAYS,
+ REG_VL_WEEKDAYS,
+ ]
+
+ if addr not in alarmregs + timeregs:
+ return
+
+ af = all(
+ self.regs[a] == self.regs[b]
+ for a, b in zip(alarmregs, timeregs)
+ if not self.regs[a] & REG_VL_ALARM_AE
+ )
+ self.reg_write(REG_CONTROL_STATUS_2, self.regs[REG_CONTROL_STATUS_2] | af << 3)
+
+ def _update_irq(self) -> None:
+ aie = self.regs[REG_CONTROL_STATUS_2] & REG_CONTROL_STATUS_2_AIE
+ af = self.regs[REG_CONTROL_STATUS_2] & REG_CONTROL_STATUS_2_AF
+
+ logger.debug(f"{aie=} {af=}")
+ self._set_int(aie and af)
+
+ def reg_read(self, addr: int) -> int:
+ val = self.regs[addr]
+ return val
+
+ def reg_write(self, addr: int, val: int) -> None:
+ assert addr in self.regs
+ self.regs[addr] = val
+ logger.debug(f"{addr=:x} {val=:x}")
+ self._check_alarm(addr)
+ self._update_irq()
+
+ def read(self, len: int) -> bytes:
+ data = bytearray(len)
+
+ for i in range(len):
+ data[i] = self.reg_read(self.reg_addr)
+ self.reg_addr = self.reg_addr + 1
+
+ return bytes(data)
+
+ def write(self, data: bytes) -> None:
+ self.reg_addr = data[0]
+
+ for i, byte in enumerate(data[1:]):
+ addr = self.reg_addr + i
+ self.backend.mock.reg_write(addr, byte)
+ self.reg_write(addr, byte)
+
+
+class TestPCF8563(UMLTestCase):
+ dts = DtFragment(
+ src="""
+#include <dt-bindings/interrupt-controller/irq.h>
+
+&i2c {
+ rtc@$addr$ {
+ compatible = "nxp,pcf8563";
+ reg = <0x$addr$>;
+ };
+
+ rtc@$irqaddr$ {
+ compatible = "nxp,pcf8563";
+ reg = <0x$irqaddr$>;
+ interrupt-parent = <&gpio>;
+ interrupts = <$gpio$ IRQ_TYPE_LEVEL_LOW>;
+ };
+};
+ """,
+ variables={
+ "addr": DtVar.I2C_ADDR,
+ "irqaddr": DtVar.I2C_ADDR,
+ "gpio": DtVar.GPIO_PIN,
+ },
+ )
+
+ @classmethod
+ def setUpClass(cls) -> None:
+ insmod("rtc-pcf8563")
+
+ @classmethod
+ def tearDownClass(cls) -> None:
+ # Can't rmmod since alarmtimer holds permanent reference
+ pass
+
+ def setUp(self) -> None:
+ self.driver = I2CDriver("rtc-pcf8563")
+ self.hw = Hardware("i2c")
+ self.hw.load_model(PCF8563, int=self.dts["gpio"])
+
+ def tearDown(self) -> None:
+ self.hw.close()
+
+ def test_read_time_invalid(self) -> None:
+ addr = self.dts["addr"]
+ with self.driver.bind(addr) as dev, rtc.RTC(dev.path) as rtcdev:
+ self.assertEqual(rtcdev.read_vl(), rtc.RTC_VL_DATA_INVALID)
+
+ with self.assertRaises(OSError) as cm:
+ rtcdev.read_time()
+ self.assertEqual(cm.exception.errno, errno.EINVAL)
+
+ def test_no_alarm_support(self) -> None:
+ addr = self.dts["addr"]
+ with self.driver.bind(addr) as dev, rtc.RTC(dev.path) as rtcdev:
+ # Make sure the times are valid so we don't get -EINVAL due to
+ # that.
+ tm = rtc.RTCTime(
+ tm_sec=10,
+ tm_min=1,
+ tm_hour=1,
+ tm_mday=1,
+ tm_mon=0,
+ tm_year=121,
+ tm_wday=0,
+ tm_yday=0,
+ tm_isdst=0,
+ )
+ rtcdev.set_time(tm)
+
+ alarmtm = tm._replace(tm_sec=0, tm_min=2)
+ with self.assertRaises(OSError) as cm:
+ rtcdev.set_wake_alarm(True, alarmtm)
+ self.assertEqual(cm.exception.errno, errno.EINVAL)
+
+ def test_alarm(self) -> None:
+ addr = self.dts["irqaddr"]
+ with self.driver.bind(addr) as dev, rtc.RTC(dev.path) as rtcdev:
+ tm = rtc.RTCTime(
+ tm_sec=10,
+ tm_min=1,
+ tm_hour=1,
+ tm_mday=1,
+ tm_mon=0,
+ tm_year=121,
+ tm_wday=5,
+ tm_yday=0,
+ tm_isdst=0,
+ )
+ rtcdev.set_time(tm)
+
+ alarmtm = tm._replace(tm_sec=0, tm_min=2)
+ rtcdev.set_wake_alarm(True, alarmtm)
+
+ mock = self.hw.update_mock()
+ mock.assert_last_reg_write(self, REG_VL_MINUTE_ALARM, 0x02)
+ mock.assert_last_reg_write(self, REG_VL_HOUR_ALARM, 0x01)
+ mock.assert_last_reg_write(self, REG_VL_DAY_ALARM, 0x01)
+ mock.assert_last_reg_write(self, REG_VL_WEEKDAY_ALARM, 5)
+ mock.assert_last_reg_write(
+ self, REG_CONTROL_STATUS_2, REG_CONTROL_STATUS_2_AIE
+ )
+ mock.reset_mock()
+
+ self.hw.reg_write(REG_VL_MINUTES, 0x02)
+ self.hw.kick()
+
+ # This waits for the interrupt
+ self.assertEqual(rtcdev.read() & 0xFF, rtc.RTC_IRQF | rtc.RTC_AF)
+
+ alarmtm = tm._replace(tm_sec=0, tm_min=3)
+ rtcdev.set_wake_alarm(False, alarmtm)
+
+ mock = self.hw.update_mock()
+ mock.assert_last_reg_write(self, REG_CONTROL_STATUS_2, 0)
+
+ def test_read_time_valid(self) -> None:
+ self.hw.reg_write(REG_VL_SECONDS, 0x37)
+ self.hw.reg_write(REG_VL_MINUTES, 0x10)
+ self.hw.reg_write(REG_VL_HOURS, 0x11)
+ self.hw.reg_write(REG_VL_DAYS, 0x25)
+ self.hw.reg_write(REG_VL_WEEKDAYS, 0x00)
+ self.hw.reg_write(REG_VL_CENTURY_MONTHS, REG_VL_CENTURY_MONTHS_C | 0x12)
+ self.hw.reg_write(REG_VL_YEARS, 0x21)
+
+ addr = self.dts["addr"]
+ with self.driver.bind(addr) as dev, rtc.RTC(dev.path) as rtcdev:
+ tm = rtcdev.read_time()
+ self.assertEqual(
+ tm,
+ rtc.RTCTime(
+ tm_sec=37,
+ tm_min=10,
+ tm_hour=11,
+ tm_mday=25,
+ tm_mon=11,
+ tm_year=121,
+ tm_wday=0,
+ tm_yday=0,
+ tm_isdst=0,
+ ),
+ )
+
+ def test_set_time_after_invalid(self) -> None:
+ addr = self.dts["addr"]
+ with self.driver.bind(addr) as dev, rtc.RTC(dev.path) as rtcdev:
+ self.assertEqual(rtcdev.read_vl(), rtc.RTC_VL_DATA_INVALID)
+
+ tm = rtc.RTCTime(
+ tm_sec=37,
+ tm_min=10,
+ tm_hour=11,
+ tm_mday=25,
+ tm_mon=11,
+ tm_year=121,
+ tm_wday=0,
+ tm_yday=0,
+ tm_isdst=0,
+ )
+
+ rtcdev.set_time(tm)
+ tm2 = rtcdev.read_time()
+ self.assertEqual(tm, tm2)
+
+ mock = self.hw.update_mock()
+ mock.assert_reg_write_once(self, REG_VL_SECONDS, 0x37)
+ mock.assert_reg_write_once(self, REG_VL_MINUTES, 0x10)
+ mock.assert_reg_write_once(self, REG_VL_HOURS, 0x11)
+ mock.assert_reg_write_once(self, REG_VL_DAYS, 0x25)
+ mock.assert_reg_write_once(self, REG_VL_WEEKDAYS, 0x00)
+ # The driver uses the wrong polarity of the Century bit
+ # if the time was invalid. This probably doesn't matter(?).
+ mock.assert_reg_write_once(self, REG_VL_CENTURY_MONTHS, 0 << 7 | 0x12)
+ mock.assert_reg_write_once(self, REG_VL_YEARS, 0x21)
+
+ self.assertEqual(rtcdev.read_vl(), 0)
+
+ def test_set_time_after_valid(self) -> None:
+ self.hw.reg_write(REG_VL_SECONDS, 0x37)
+ self.hw.reg_write(REG_VL_MINUTES, 0x10)
+ self.hw.reg_write(REG_VL_HOURS, 0x11)
+ self.hw.reg_write(REG_VL_DAYS, 0x25)
+ self.hw.reg_write(REG_VL_WEEKDAYS, 0x00)
+ self.hw.reg_write(REG_VL_CENTURY_MONTHS, REG_VL_CENTURY_MONTHS_C | 0x12)
+ self.hw.reg_write(REG_VL_YEARS, 0x21)
+
+ addr = self.dts["addr"]
+ with self.driver.bind(addr) as dev, rtc.RTC(dev.path) as rtcdev:
+ tm = rtc.RTCTime(
+ tm_sec=37,
+ tm_min=10,
+ tm_hour=11,
+ tm_mday=25,
+ tm_mon=11,
+ tm_year=121,
+ tm_wday=0,
+ tm_yday=0,
+ tm_isdst=0,
+ )
+
+ rtcdev.set_time(tm)
+ tm2 = rtcdev.read_time()
+ self.assertEqual(tm, tm2)
+
+ mock = self.hw.update_mock()
+ mock.assert_reg_write_once(self, REG_VL_SECONDS, 0x37)
+ mock.assert_reg_write_once(self, REG_VL_MINUTES, 0x10)
+ mock.assert_reg_write_once(self, REG_VL_HOURS, 0x11)
+ mock.assert_reg_write_once(self, REG_VL_DAYS, 0x25)
+ mock.assert_reg_write_once(self, REG_VL_WEEKDAYS, 0x00)
+ mock.assert_reg_write_once(
+ self, REG_VL_CENTURY_MONTHS, REG_VL_CENTURY_MONTHS_C | 0x12
+ )
+ mock.assert_reg_write_once(self, REG_VL_YEARS, 0x21)
--
2.34.1
Add roadtests for the vcnl4000 driver, testing several of the driver's
features including buffer and event handling. Since it's the first IIO
roadtest testing the non-sysfs parts, some support code for using the
IIO ABI is included.
The different variants supported by the driver are in separate tests and
models since no two variants have fully identical register interfaces.
This duplicates some of the test code, but it:
- Avoids the tests duplicating the same multi-variant logic as the
driver, reducing the risk for both the test and the driver being
wrong.
- Allows each variant's test and model to be individually understood
and modified looking at only one specific datasheet, making it easier
to extend tests and implement new features in the driver.
During development of these tests, two oddities were noticed in the
driver's handling of VCNL4040, but the tests simply assume that the
current driver knows what it's doing (although we may want to fix the
first point later):
- The driver reads an invalid/undefined register on the VCNL4040 when
attempting to distinguish between that one and VCNL4200.
- The driver uses a lux/step unit which differs from the datasheet (but
which is specified in an application note).
Signed-off-by: Vincent Whitchurch <[email protected]>
---
.../roadtest/roadtest/tests/iio/iio.py | 112 +++++++
.../roadtest/roadtest/tests/iio/light/config | 1 +
.../roadtest/tests/iio/light/test_vcnl4000.py | 132 ++++++++
.../roadtest/tests/iio/light/test_vcnl4010.py | 282 ++++++++++++++++++
.../roadtest/tests/iio/light/test_vcnl4040.py | 104 +++++++
.../roadtest/tests/iio/light/test_vcnl4200.py | 96 ++++++
6 files changed, 727 insertions(+)
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/iio.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py
create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py
diff --git a/tools/testing/roadtest/roadtest/tests/iio/iio.py b/tools/testing/roadtest/roadtest/tests/iio/iio.py
new file mode 100644
index 000000000000..ea57b28ea9d3
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/iio/iio.py
@@ -0,0 +1,112 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import contextlib
+import enum
+import fcntl
+import struct
+from dataclasses import dataclass, field
+from typing import Any
+
+IIO_GET_EVENT_FD_IOCTL = 0x80046990
+IIO_BUFFER_GET_FD_IOCTL = 0xC0046991
+
+
+class IIOChanType(enum.IntEnum):
+ IIO_VOLTAGE = 0
+ IIO_CURRENT = 1
+ IIO_POWER = 2
+ IIO_ACCEL = 3
+ IIO_ANGL_VEL = 4
+ IIO_MAGN = 5
+ IIO_LIGHT = 6
+ IIO_INTENSITY = 7
+ IIO_PROXIMITY = 8
+ IIO_TEMP = 9
+ IIO_INCLI = 10
+ IIO_ROT = 11
+ IIO_ANGL = 12
+ IIO_TIMESTAMP = 13
+ IIO_CAPACITANCE = 14
+ IIO_ALTVOLTAGE = 15
+ IIO_CCT = 16
+ IIO_PRESSURE = 17
+ IIO_HUMIDITYRELATIVE = 18
+ IIO_ACTIVITY = 19
+ IIO_STEPS = 20
+ IIO_ENERGY = 21
+ IIO_DISTANCE = 22
+ IIO_VELOCITY = 23
+ IIO_CONCENTRATION = 24
+ IIO_RESISTANCE = 25
+ IIO_PH = 26
+ IIO_UVINDEX = 27
+ IIO_ELECTRICALCONDUCTIVITY = 28
+ IIO_COUNT = 29
+ IIO_INDEX = 30
+ IIO_GRAVITY = 31
+ IIO_POSITIONRELATIVE = 32
+ IIO_PHASE = 33
+ IIO_MASSCONCENTRATION = 34
+
+
+@dataclass
+class IIOEvent:
+ id: int
+ timestamp: int
+ type: IIOChanType = field(init=False)
+
+ def __post_init__(self) -> None:
+ self.type = IIOChanType((self.id >> 32) & 0xFF)
+
+
+class IIOEventMonitor(contextlib.AbstractContextManager):
+ def __init__(self, devname: str) -> None:
+ self.devname = devname
+
+ def __enter__(self) -> "IIOEventMonitor":
+ self.file = open(self.devname, "rb")
+
+ s = struct.Struct("L")
+ buf = bytearray(s.size)
+ fcntl.ioctl(self.file.fileno(), IIO_GET_EVENT_FD_IOCTL, buf)
+ eventfd = s.unpack(buf)[0]
+ self.eventf = open(eventfd, "rb")
+
+ return self
+
+ def read(self) -> IIOEvent:
+ s = struct.Struct("Qq")
+ buf = self.eventf.read(s.size)
+ return IIOEvent(*s.unpack(buf))
+
+ def __exit__(self, *_: Any) -> None:
+ self.eventf.close()
+ self.file.close()
+
+
+class IIOBuffer(contextlib.AbstractContextManager):
+ def __init__(self, devname: str, bufidx: int) -> None:
+ self.devname = devname
+ self.bufidx = bufidx
+
+ def __enter__(self) -> "IIOBuffer":
+ self.file = open(self.devname, "rb")
+
+ s = struct.Struct("L")
+ buf = bytearray(s.size)
+ s.pack_into(buf, 0, self.bufidx)
+ fcntl.ioctl(self.file.fileno(), IIO_BUFFER_GET_FD_IOCTL, buf)
+ eventfd = s.unpack(buf)[0]
+ self.eventf = open(eventfd, "rb")
+
+ return self
+
+ def read(self, spec: str) -> tuple:
+ s = struct.Struct(spec)
+ buf = self.eventf.read(s.size)
+ return s.unpack(buf)
+
+ def __exit__(self, *_: Any) -> None:
+ self.eventf.close()
+ self.file.close()
diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/config b/tools/testing/roadtest/roadtest/tests/iio/light/config
index b9753f2d0728..3bd4125cbb6b 100644
--- a/tools/testing/roadtest/roadtest/tests/iio/light/config
+++ b/tools/testing/roadtest/roadtest/tests/iio/light/config
@@ -1 +1,2 @@
CONFIG_OPT3001=m
+CONFIG_VCNL4000=m
diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py
new file mode 100644
index 000000000000..16a5bed18b7e
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py
@@ -0,0 +1,132 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import errno
+import logging
+from typing import Any, Final
+
+from roadtest.backend.i2c import SMBusModel
+from roadtest.core.devicetree import DtFragment, DtVar
+from roadtest.core.hardware import Hardware
+from roadtest.core.modules import insmod, rmmod
+from roadtest.core.suite import UMLTestCase
+from roadtest.core.sysfs import I2CDriver, read_float, read_int, read_str
+
+logger = logging.getLogger(__name__)
+
+REG_COMMAND: Final = 0x80
+REG_PRODUCT_ID_REVISION: Final = 0x81
+REG_IR_LED_CURRENT: Final = 0x83
+REG_ALS_PARAM: Final = 0x84
+REG_ALS_RESULT_HIGH: Final = 0x85
+REG_ALS_RESULT_LOW: Final = 0x86
+REG_PROX_RESULT_HIGH: Final = 0x87
+REG_PROX_RESULT_LOW: Final = 0x88
+REG_PROX_SIGNAL_FREQ: Final = 0x89
+
+REG_COMMAND_ALS_DATA_RDY: Final = 1 << 6
+REG_COMMAND_PROX_DATA_RDY: Final = 1 << 5
+
+
+class VCNL4000(SMBusModel):
+ def __init__(self, **kwargs: Any) -> None:
+ super().__init__(regbytes=1, **kwargs)
+ self.regs = {
+ REG_COMMAND: 0b_1000_0000,
+ REG_PRODUCT_ID_REVISION: 0x11,
+ # Register "without function in current version"
+ 0x82: 0x00,
+ REG_IR_LED_CURRENT: 0x00,
+ REG_ALS_PARAM: 0x00,
+ REG_ALS_RESULT_HIGH: 0x00,
+ REG_ALS_RESULT_LOW: 0x00,
+ REG_PROX_RESULT_HIGH: 0x00,
+ REG_PROX_RESULT_LOW: 0x00,
+ REG_PROX_RESULT_LOW: 0x00,
+ }
+
+ def reg_read(self, addr: int) -> int:
+ val = self.regs[addr]
+
+ if addr in (REG_ALS_RESULT_HIGH, REG_ALS_RESULT_LOW):
+ self.regs[REG_COMMAND] &= ~REG_COMMAND_ALS_DATA_RDY
+ if addr in (REG_PROX_RESULT_HIGH, REG_PROX_RESULT_LOW):
+ self.regs[REG_COMMAND] &= ~REG_COMMAND_PROX_DATA_RDY
+
+ return val
+
+ def reg_write(self, addr: int, val: int) -> None:
+ assert addr in self.regs
+
+ if addr == REG_COMMAND:
+ rw = 0b_0001_1000
+ val = (self.regs[addr] & ~rw) | (val & rw)
+
+ self.regs[addr] = val
+
+ def inject(self, addr: int, val: int, mask: int = ~0) -> None:
+ old = self.regs[addr] & ~mask
+ new = old | (val & mask)
+ self.regs[addr] = new
+
+
+class TestVCNL4000(UMLTestCase):
+ dts = DtFragment(
+ src="""
+&i2c {
+ light-sensor@$addr$ {
+ compatible = "vishay,vcnl4000";
+ reg = <0x$addr$>;
+ };
+};
+ """,
+ variables={
+ "addr": DtVar.I2C_ADDR,
+ },
+ )
+
+ @classmethod
+ def setUpClass(cls) -> None:
+ insmod("vcnl4000")
+
+ @classmethod
+ def tearDownClass(cls) -> None:
+ rmmod("vcnl4000")
+
+ def setUp(self) -> None:
+ self.driver = I2CDriver("vcnl4000")
+ self.hw = Hardware("i2c")
+ self.hw.load_model(VCNL4000)
+
+ def tearDown(self) -> None:
+ self.hw.close()
+
+ def test_lux(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ scale = read_float(dev.path / "iio:device0/in_illuminance_scale")
+ self.assertEqual(scale, 0.25)
+
+ data = [
+ (0x00, 0x00),
+ (0x12, 0x34),
+ (0xFF, 0xFF),
+ ]
+ luxfile = dev.path / "iio:device0/in_illuminance_raw"
+ for high, low in data:
+ self.hw.inject(REG_ALS_RESULT_HIGH, high)
+ self.hw.inject(REG_ALS_RESULT_LOW, low)
+ self.hw.inject(
+ REG_COMMAND,
+ val=REG_COMMAND_ALS_DATA_RDY,
+ mask=REG_COMMAND_ALS_DATA_RDY,
+ )
+
+ self.assertEqual(read_int(luxfile), high << 8 | low)
+
+ def test_lux_timeout(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ # self.hw.set_never_ready(True)
+ with self.assertRaises(OSError) as cm:
+ luxfile = dev.path / "iio:device0/in_illuminance_raw"
+ read_str(luxfile)
+ self.assertEqual(cm.exception.errno, errno.EIO)
diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py
new file mode 100644
index 000000000000..929db970405f
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py
@@ -0,0 +1,282 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import errno
+import logging
+from pathlib import Path
+from typing import Any, Final, Optional
+
+from roadtest.backend.i2c import SMBusModel
+from roadtest.core.devicetree import DtFragment, DtVar
+from roadtest.core.hardware import Hardware
+from roadtest.core.modules import insmod, rmmod
+from roadtest.core.suite import UMLTestCase
+from roadtest.core.sysfs import (
+ I2CDriver,
+ read_float,
+ read_int,
+ read_str,
+ write_int,
+ write_str,
+)
+from roadtest.tests.iio import iio
+
+logger = logging.getLogger(__name__)
+
+REG_COMMAND: Final = 0x80
+REG_PRODUCT_ID_REVISION: Final = 0x81
+REG_PROXIMITY_RATE: Final = 0x82
+REG_IR_LED_CURRENT: Final = 0x83
+REG_ALS_PARAM: Final = 0x84
+REG_ALS_RESULT_HIGH: Final = 0x85
+REG_ALS_RESULT_LOW: Final = 0x86
+REG_PROX_RESULT_HIGH: Final = 0x87
+REG_PROX_RESULT_LOW: Final = 0x88
+REG_INTERRUPT_CONTROL: Final = 0x89
+REG_LOW_THRESHOLD_HIGH: Final = 0x8A
+REG_LOW_THRESHOLD_LOW: Final = 0x8B
+REG_HIGH_THRESHOLD_HIGH: Final = 0x8C
+REG_HIGH_THRESHOLD_LOW: Final = 0x8D
+REG_INTERRUPT_STATUS: Final = 0x8E
+
+REG_COMMAND_ALS_DATA_RDY: Final = 1 << 6
+REG_COMMAND_PROX_DATA_RDY: Final = 1 << 5
+
+
+class VCNL4010(SMBusModel):
+ def __init__(self, int: Optional[int] = None, **kwargs: Any) -> None:
+ super().__init__(regbytes=1, **kwargs)
+ self.int = int
+ self._set_int(False)
+ self.regs = {
+ REG_COMMAND: 0b_1000_0000,
+ REG_PRODUCT_ID_REVISION: 0x21,
+ REG_PROXIMITY_RATE: 0x00,
+ REG_IR_LED_CURRENT: 0x00,
+ REG_ALS_PARAM: 0x00,
+ REG_ALS_RESULT_HIGH: 0x00,
+ REG_ALS_RESULT_LOW: 0x00,
+ REG_PROX_RESULT_HIGH: 0x00,
+ REG_PROX_RESULT_LOW: 0x00,
+ REG_INTERRUPT_CONTROL: 0x00,
+ REG_LOW_THRESHOLD_HIGH: 0x00,
+ REG_LOW_THRESHOLD_LOW: 0x00,
+ REG_HIGH_THRESHOLD_HIGH: 0x00,
+ REG_HIGH_THRESHOLD_LOW: 0x00,
+ REG_INTERRUPT_STATUS: 0x00,
+ }
+
+ def _set_int(self, active: int) -> None:
+ # Active-low
+ self.backend.gpio.set(self.int, not active)
+
+ def _update_irq(self) -> None:
+ selftimed_en = self.regs[REG_COMMAND] & (1 << 0)
+ prox_en = self.regs[REG_COMMAND] & (1 << 1)
+ prox_data_rdy = self.regs[REG_COMMAND] & REG_COMMAND_PROX_DATA_RDY
+ int_prox_ready_en = self.regs[REG_INTERRUPT_CONTROL] & (1 << 3)
+
+ logger.debug(
+ f"{selftimed_en=:x} {prox_en=:x} {prox_data_rdy=:x} {int_prox_ready_en=:x}"
+ )
+
+ if selftimed_en and prox_en and prox_data_rdy and int_prox_ready_en:
+ self.regs[REG_INTERRUPT_STATUS] |= 1 << 3
+
+ low_threshold = (
+ self.regs[REG_LOW_THRESHOLD_HIGH] << 8 | self.regs[REG_LOW_THRESHOLD_LOW]
+ )
+ high_threshold = (
+ self.regs[REG_HIGH_THRESHOLD_HIGH] << 8 | self.regs[REG_HIGH_THRESHOLD_LOW]
+ )
+ proximity = (
+ self.regs[REG_PROX_RESULT_HIGH] << 8 | self.regs[REG_PROX_RESULT_LOW]
+ )
+ int_thres_en = self.regs[REG_INTERRUPT_CONTROL] & (1 << 1)
+
+ logger.debug(
+ f"{low_threshold=:x} {high_threshold=:x} {proximity=:x} {int_thres_en=:x}"
+ )
+
+ if int_thres_en:
+ if proximity < low_threshold:
+ logger.debug("LOW")
+ self.regs[REG_INTERRUPT_STATUS] |= 1 << 1
+ if proximity > high_threshold:
+ logger.debug("HIGH")
+ self.regs[REG_INTERRUPT_STATUS] |= 1 << 0
+
+ self._set_int(self.regs[REG_INTERRUPT_STATUS])
+
+ def reg_read(self, addr: int) -> int:
+ val = self.regs[addr]
+
+ if addr in (REG_ALS_RESULT_HIGH, REG_ALS_RESULT_LOW):
+ self.regs[REG_COMMAND] &= ~REG_COMMAND_ALS_DATA_RDY
+ if addr in (REG_PROX_RESULT_HIGH, REG_PROX_RESULT_LOW):
+ self.regs[REG_COMMAND] &= ~REG_COMMAND_PROX_DATA_RDY
+
+ return val
+
+ def reg_write(self, addr: int, val: int) -> None:
+ assert addr in self.regs
+
+ if addr == REG_COMMAND:
+ rw = 0b_0001_1111
+ val = (self.regs[addr] & ~rw) | (val & rw)
+ elif addr == REG_INTERRUPT_STATUS:
+ val = self.regs[addr] & ~(val & 0xF)
+
+ self.regs[addr] = val
+ self._update_irq()
+
+ def inject(self, addr: int, val: int, mask: int = ~0) -> None:
+ old = self.regs[addr] & ~mask
+ new = old | (val & mask)
+ self.regs[addr] = new
+ self._update_irq()
+
+ def set_bit(self, addr: int, val: int) -> None:
+ self.inject(addr, val, val)
+
+
+class TestVCNL4010(UMLTestCase):
+ dts = DtFragment(
+ src="""
+#include <dt-bindings/interrupt-controller/irq.h>
+
+&i2c {
+ light-sensor@$addr$ {
+ compatible = "vishay,vcnl4020";
+ reg = <0x$addr$>;
+ interrupt-parent = <&gpio>;
+ interrupts = <$gpio$ IRQ_TYPE_EDGE_FALLING>;
+ };
+};
+ """,
+ variables={
+ "addr": DtVar.I2C_ADDR,
+ "gpio": DtVar.GPIO_PIN,
+ },
+ )
+
+ @classmethod
+ def setUpClass(cls) -> None:
+ insmod("vcnl4000")
+
+ @classmethod
+ def tearDownClass(cls) -> None:
+ rmmod("vcnl4000")
+
+ def setUp(self) -> None:
+ self.driver = I2CDriver("vcnl4000")
+ self.hw = Hardware("i2c")
+ self.hw.load_model(VCNL4010, int=self.dts["gpio"])
+
+ def tearDown(self) -> None:
+ self.hw.close()
+
+ def test_lux(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+
+ scale = read_float(dev.path / "iio:device0/in_illuminance_scale")
+ self.assertEqual(scale, 0.25)
+
+ data = [
+ (0x00, 0x00),
+ (0x12, 0x34),
+ (0xFF, 0xFF),
+ ]
+ luxfile = dev.path / "iio:device0/in_illuminance_raw"
+ for high, low in data:
+ self.hw.inject(REG_ALS_RESULT_HIGH, high)
+ self.hw.inject(REG_ALS_RESULT_LOW, low)
+ self.hw.set_bit(REG_COMMAND, REG_COMMAND_ALS_DATA_RDY)
+
+ self.assertEqual(read_int(luxfile), high << 8 | low)
+
+ def test_lux_timeout(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ with self.assertRaises(OSError) as cm:
+ luxfile = dev.path / "iio:device0/in_illuminance_raw"
+ read_str(luxfile)
+ self.assertEqual(cm.exception.errno, errno.EIO)
+
+ def test_proximity_thresh_rising(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ high_thresh = (
+ dev.path / "iio:device0/events/in_proximity_thresh_rising_value"
+ )
+ write_int(high_thresh, 0x1234)
+
+ mock = self.hw.update_mock()
+ mock.assert_last_reg_write(self, REG_HIGH_THRESHOLD_HIGH, 0x12)
+ mock.assert_last_reg_write(self, REG_HIGH_THRESHOLD_LOW, 0x34)
+ mock.reset_mock()
+
+ self.assertEqual(read_int(high_thresh), 0x1234)
+
+ with iio.IIOEventMonitor("/dev/iio:device0") as mon:
+ en = dev.path / "iio:device0/events/in_proximity_thresh_either_en"
+ write_int(en, 1)
+
+ self.hw.inject(REG_PROX_RESULT_HIGH, 0x12)
+ self.hw.inject(REG_PROX_RESULT_LOW, 0x35)
+ self.hw.set_bit(REG_COMMAND, REG_COMMAND_PROX_DATA_RDY)
+ self.hw.kick()
+
+ self.assertEqual(read_int(en), 1)
+
+ event = mon.read()
+ self.assertEqual(event.type, iio.IIOChanType.IIO_PROXIMITY)
+
+ def test_proximity_thresh_falling(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ high_thresh = (
+ dev.path / "iio:device0/events/in_proximity_thresh_falling_value"
+ )
+ write_int(high_thresh, 0x0ABC)
+
+ mock = self.hw.update_mock()
+ mock.assert_last_reg_write(self, REG_LOW_THRESHOLD_HIGH, 0x0A)
+ mock.assert_last_reg_write(self, REG_LOW_THRESHOLD_LOW, 0xBC)
+ mock.reset_mock()
+
+ self.assertEqual(read_int(high_thresh), 0x0ABC)
+
+ with iio.IIOEventMonitor("/dev/iio:device0") as mon:
+ write_int(
+ dev.path / "iio:device0/events/in_proximity_thresh_either_en", 1
+ )
+
+ event = mon.read()
+ self.assertEqual(event.type, iio.IIOChanType.IIO_PROXIMITY)
+
+ def test_proximity_triggered(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ data = [
+ (0x00, 0x00, 0),
+ (0x00, 0x01, 1),
+ (0xF0, 0x02, 0xF002),
+ (0xFF, 0xFF, 0xFFFF),
+ ]
+
+ trigger = read_str(Path("/sys/bus/iio/devices/trigger0/name"))
+
+ write_int(dev.path / "iio:device0/buffer0/in_proximity_en", 1)
+ write_str(dev.path / "iio:device0/trigger/current_trigger", trigger)
+
+ with iio.IIOBuffer("/dev/iio:device0", bufidx=0) as buffer:
+ write_int(dev.path / "iio:device0/buffer0/length", 128)
+ write_int(dev.path / "iio:device0/buffer0/enable", 1)
+
+ for low, high, expected in data:
+ self.hw.inject(REG_PROX_RESULT_HIGH, low)
+ self.hw.inject(REG_PROX_RESULT_LOW, high)
+ self.hw.set_bit(REG_COMMAND, REG_COMMAND_PROX_DATA_RDY)
+ self.hw.kick()
+
+ scanline = buffer.read("H")
+
+ val = scanline[0]
+ self.assertEqual(val, expected)
diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py
new file mode 100644
index 000000000000..f2aa2cb9f3d5
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py
@@ -0,0 +1,104 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import logging
+from typing import Any
+
+from roadtest.backend.i2c import SMBusModel
+from roadtest.core.devicetree import DtFragment, DtVar
+from roadtest.core.hardware import Hardware
+from roadtest.core.modules import insmod, rmmod
+from roadtest.core.suite import UMLTestCase
+from roadtest.core.sysfs import I2CDriver, read_float, read_int
+
+logger = logging.getLogger(__name__)
+
+
+class VCNL4040(SMBusModel):
+ def __init__(self, **kwargs: Any) -> None:
+ super().__init__(regbytes=2, byteorder="little", **kwargs)
+ self.regs = {
+ 0x00: 0x0101,
+ 0x01: 0x0000,
+ 0x02: 0x0000,
+ 0x03: 0x0001,
+ 0x04: 0x0000,
+ 0x05: 0x0000,
+ 0x06: 0x0000,
+ 0x07: 0x0000,
+ 0x08: 0x0000,
+ 0x09: 0x0000,
+ 0x0A: 0x0000,
+ 0x0A: 0x0000,
+ 0x0B: 0x0000,
+ 0x0C: 0x0186,
+ # The driver reads this register which is undefined for
+ # VCNL4040. Perhaps the driver should be fixed instead
+ # of having this here?
+ 0x0E: 0x0000,
+ }
+
+ def reg_read(self, addr: int) -> int:
+ return self.regs[addr]
+
+ def reg_write(self, addr: int, val: int) -> None:
+ assert addr in self.regs
+ self.regs[addr] = val
+
+
+class TestVCNL4040(UMLTestCase):
+ dts = DtFragment(
+ src="""
+&i2c {
+ light-sensor@$addr$ {
+ compatible = "vishay,vcnl4040";
+ reg = <0x$addr$>;
+ };
+};
+ """,
+ variables={
+ "addr": DtVar.I2C_ADDR,
+ },
+ )
+
+ @classmethod
+ def setUpClass(cls) -> None:
+ insmod("vcnl4000")
+
+ @classmethod
+ def tearDownClass(cls) -> None:
+ rmmod("vcnl4000")
+
+ def setUp(self) -> None:
+ self.driver = I2CDriver("vcnl4000")
+ self.hw = Hardware("i2c")
+ self.hw.load_model(VCNL4040)
+
+ def tearDown(self) -> None:
+ self.hw.close()
+
+ def test_illuminance_scale(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ scalefile = dev.path / "iio:device0/in_illuminance_scale"
+ # The datasheet says 0.10 lux/step, but the driver follows
+ # the application note "Designing the VCNL4040 Into an
+ # Application" which claims a different value.
+ self.assertEqual(read_float(scalefile), 0.12)
+
+ def test_illuminance(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ luxfile = dev.path / "iio:device0/in_illuminance_raw"
+
+ data = [0x0000, 0x1234, 0xFFFF]
+ for regval in data:
+ self.hw.reg_write(0x09, regval)
+ self.assertEqual(read_int(luxfile), regval)
+
+ def test_proximity(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ rawfile = dev.path / "iio:device0/in_proximity_raw"
+
+ data = [0x0000, 0x1234, 0xFFFF]
+ for regval in data:
+ self.hw.reg_write(0x08, regval)
+ self.assertEqual(read_int(rawfile), regval)
diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py
new file mode 100644
index 000000000000..d1cf819e563e
--- /dev/null
+++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py
@@ -0,0 +1,96 @@
+# SPDX-License-Identifier: GPL-2.0-only
+# Copyright Axis Communications AB
+
+import logging
+from typing import Any
+
+from roadtest.backend.i2c import SMBusModel
+from roadtest.core.devicetree import DtFragment, DtVar
+from roadtest.core.hardware import Hardware
+from roadtest.core.modules import insmod, rmmod
+from roadtest.core.suite import UMLTestCase
+from roadtest.core.sysfs import I2CDriver, read_float, read_int
+
+logger = logging.getLogger(__name__)
+
+
+class VCNL4200(SMBusModel):
+ def __init__(self, **kwargs: Any) -> None:
+ super().__init__(regbytes=2, byteorder="little", **kwargs)
+ self.regs = {
+ 0x00: 0x0101,
+ 0x01: 0x0000,
+ 0x02: 0x0000,
+ 0x03: 0x0001,
+ 0x04: 0x0000,
+ 0x05: 0x0000,
+ 0x06: 0x0000,
+ 0x07: 0x0000,
+ 0x08: 0x0000,
+ 0x09: 0x0000,
+ 0x0A: 0x0000,
+ 0x0D: 0x0000,
+ 0x0E: 0x1058,
+ }
+
+ def reg_read(self, addr: int) -> int:
+ return self.regs[addr]
+
+ def reg_write(self, addr: int, val: int) -> None:
+ assert addr in self.regs
+ self.regs[addr] = val
+
+
+class TestVCNL4200(UMLTestCase):
+ dts = DtFragment(
+ src="""
+&i2c {
+ light-sensor@$addr$ {
+ compatible = "vishay,vcnl4200";
+ reg = <0x$addr$>;
+ };
+};
+ """,
+ variables={
+ "addr": DtVar.I2C_ADDR,
+ },
+ )
+
+ @classmethod
+ def setUpClass(cls) -> None:
+ insmod("vcnl4000")
+
+ @classmethod
+ def tearDownClass(cls) -> None:
+ rmmod("vcnl4000")
+
+ def setUp(self) -> None:
+ self.driver = I2CDriver("vcnl4000")
+ self.hw = Hardware("i2c")
+ self.hw.load_model(VCNL4200)
+
+ def tearDown(self) -> None:
+ self.hw.close()
+
+ def test_illuminance_scale(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ scalefile = dev.path / "iio:device0/in_illuminance_scale"
+ self.assertEqual(read_float(scalefile), 0.024)
+
+ def test_illuminance(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ luxfile = dev.path / "iio:device0/in_illuminance_raw"
+
+ data = [0x0000, 0x1234, 0xFFFF]
+ for regval in data:
+ self.hw.reg_write(0x09, regval)
+ self.assertEqual(read_int(luxfile), regval)
+
+ def test_proximity(self) -> None:
+ with self.driver.bind(self.dts["addr"]) as dev:
+ rawfile = dev.path / "iio:device0/in_proximity_raw"
+
+ data = [0x0000, 0x1234, 0xFFFF]
+ for regval in data:
+ self.hw.reg_write(0x08, regval)
+ self.assertEqual(read_int(rawfile), regval)
--
2.34.1
Add the C parts of the roadtest framework. This uses QEMU's
libvhost-user to implement the device side of virtio-user and
virtio-gpio and bridge them to the Python portions of the backend.
The C backend is also responsible for starting UML after the virtio
device implementations are initialized.
Signed-off-by: Vincent Whitchurch <[email protected]>
---
tools/testing/roadtest/src/backend.c | 884 +++++++++++++++++++++++++++
1 file changed, 884 insertions(+)
create mode 100644 tools/testing/roadtest/src/backend.c
diff --git a/tools/testing/roadtest/src/backend.c b/tools/testing/roadtest/src/backend.c
new file mode 100644
index 000000000000..d5ac08b20fd9
--- /dev/null
+++ b/tools/testing/roadtest/src/backend.c
@@ -0,0 +1,884 @@
+// SPDX-License-Identifier: GPL-2.0-only
+// Copyright Axis Communications AB
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+
+#include <err.h>
+#include <getopt.h>
+#include <stdlib.h>
+#include <sys/epoll.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <sys/uio.h>
+#include <sys/un.h>
+#include <unistd.h>
+#include <stdio.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <linux/virtio_gpio.h>
+#include <linux/virtio_i2c.h>
+#include <linux/kernel.h>
+#include <linux/list.h>
+
+#include "libvhost-user.h"
+
+enum watch_type {
+ LISTEN,
+ SOCKET_WATCH,
+ VU_WATCH,
+};
+
+struct watch {
+ VuDev *dev;
+ enum watch_type type;
+ int fd;
+ void *func;
+ void *data;
+ struct list_head list;
+};
+
+struct vhost_user_i2c {
+ VuDev dev;
+ FILE *control;
+};
+
+struct vhost_user_gpio {
+ VuDev dev;
+ FILE *control;
+ VuVirtqElement *irq_elements[64];
+};
+
+#define dbg(...) \
+ do { \
+ if (0) { \
+ fprintf(stderr, __VA_ARGS__); \
+ } \
+ } while (0)
+
+static LIST_HEAD(watches);
+
+static int epfd;
+
+static PyObject *py_i2c_read, *py_i2c_write, *py_process_control;
+static PyObject *py_gpio_set_irq_type, *py_gpio_unmask;
+
+static const char *opt_main_script;
+static char *opt_gpio_socket;
+static char *opt_i2c_socket;
+
+static struct vhost_user_gpio gpio;
+static struct vhost_user_i2c i2c;
+
+static void dump_iov(const char *what, struct iovec *iovec, unsigned int count)
+{
+ int i;
+
+ dbg("dumping %s with count %u\n", what, count);
+
+ for (i = 0; i < count; i++) {
+ struct iovec *iov = &iovec[0];
+
+ dbg("i %d base %p len %zu\n", i, iov->iov_base, iov->iov_len);
+ }
+}
+
+static bool i2c_read(struct vhost_user_i2c *vi, uint16_t addr, void *data,
+ size_t len)
+{
+ PyObject *pArgs, *pValue;
+
+ dbg("i2c read addr %#x len %zu\n", addr, len);
+
+ pArgs = PyTuple_New(1);
+ pValue = PyLong_FromLong(len);
+ PyTuple_SetItem(pArgs, 0, pValue);
+
+ pValue = PyObject_CallObject(py_i2c_read, pArgs);
+ Py_DECREF(pArgs);
+ if (!pValue) {
+ PyErr_Print();
+ return false;
+ }
+
+ unsigned char *buffer;
+ Py_ssize_t length;
+
+ if (PyBytes_AsStringAndSize(pValue, (char **)&buffer, &length) < 0) {
+ PyErr_Print();
+ errx(1, "invalid result from i2c.read()");
+ }
+ if (length != len) {
+ errx(1,
+ "unexpected length from i2c.read(), expected %zu, got %zu",
+ len, length);
+ }
+
+ memcpy(data, buffer, len);
+
+ return true;
+}
+
+static bool i2c_write(struct vhost_user_i2c *vi, uint16_t addr,
+ const void *data, size_t len)
+{
+ PyObject *pArgs, *pValue;
+
+ dbg("i2c write addr %#x len %zu\n", addr, len);
+
+ pArgs = PyTuple_New(1);
+ pValue = PyBytes_FromStringAndSize(data, len);
+ PyTuple_SetItem(pArgs, 0, pValue);
+
+ pValue = PyObject_CallObject(py_i2c_write, pArgs);
+ Py_DECREF(pArgs);
+ if (!pValue) {
+ PyErr_Print();
+ return false;
+ }
+
+ return true;
+}
+
+static void gpio_send_irq_response(struct vhost_user_gpio *gpio,
+ unsigned int pin, unsigned int status);
+
+static PyObject *cbackend_trigger_gpio_irq(PyObject *self, PyObject *args)
+{
+ unsigned int pin;
+
+ if (!PyArg_ParseTuple(args, "I", &pin))
+ return NULL;
+
+ dbg("trigger gpio %u irq\n", pin);
+
+ gpio_send_irq_response(&gpio, pin, VIRTIO_GPIO_IRQ_STATUS_VALID);
+
+ Py_RETURN_NONE;
+}
+
+static PyMethodDef EmbMethods[] = {
+ { "trigger_gpio_irq", cbackend_trigger_gpio_irq, METH_VARARGS,
+ "Return the number of arguments received by the process." },
+ { NULL, NULL, 0, NULL }
+};
+
+static PyModuleDef EmbModule = { PyModuleDef_HEAD_INIT,
+ "cbackend",
+ NULL,
+ -1,
+ EmbMethods,
+ NULL,
+ NULL,
+ NULL,
+ NULL };
+
+static PyObject *PyInit_cbackend(void)
+{
+ return PyModule_Create(&EmbModule);
+}
+
+static void init_python_i2c(PyObject *backend)
+{
+ PyObject *i2c = PyObject_GetAttrString(backend, "i2c");
+
+ if (!i2c) {
+ PyErr_Print();
+ errx(1, "Error getting backend.i2c");
+ }
+
+ py_i2c_read = PyObject_GetAttrString(i2c, "read");
+ if (!py_i2c_read) {
+ PyErr_Print();
+ errx(1, "Error getting i2c.read");
+ }
+
+ py_i2c_write = PyObject_GetAttrString(i2c, "write");
+ if (!py_i2c_write) {
+ PyErr_Print();
+ errx(1, "Error getting i2c.write");
+ }
+}
+
+static void init_python_gpio(PyObject *backend)
+{
+ PyObject *gpio = PyObject_GetAttrString(backend, "gpio");
+
+ if (!gpio) {
+ PyErr_Print();
+ errx(1, "error getting backend.gpio");
+ }
+
+ py_gpio_set_irq_type = PyObject_GetAttrString(gpio, "set_irq_type");
+ if (!py_gpio_set_irq_type) {
+ PyErr_Print();
+ errx(1, "error getting gpio.set_irq_type");
+ }
+
+ py_gpio_unmask = PyObject_GetAttrString(gpio, "unmask");
+ if (!py_gpio_unmask) {
+ PyErr_Print();
+ errx(1, "error getting gpio.unmask");
+ }
+}
+
+static void init_python(void)
+{
+ PyObject *mainmod, *backend;
+ FILE *file;
+
+ PyImport_AppendInittab("cbackend", &PyInit_cbackend);
+
+ Py_Initialize();
+
+ file = fopen(opt_main_script, "r");
+ if (!file)
+ err(1, "open %s", opt_main_script);
+
+ if (PyRun_SimpleFile(file, "main.py") < 0) {
+ PyErr_Print();
+ errx(1, "error running %s", opt_main_script);
+ }
+ fclose(file);
+
+ mainmod = PyImport_AddModule("__main__");
+ if (!mainmod) {
+ PyErr_Print();
+ errx(1, "error getting __main__");
+ }
+
+ backend = PyObject_GetAttrString(mainmod, "backend");
+ if (!backend) {
+ PyErr_Print();
+ errx(1, "error getting backend");
+ }
+
+ py_process_control = PyObject_GetAttrString(backend, "process_control");
+ if (!py_process_control) {
+ PyErr_Print();
+ errx(1, "error getting backend.process_control");
+ }
+
+ init_python_i2c(backend);
+ init_python_gpio(backend);
+}
+
+static void i2c_handle_cmdq(VuDev *dev, int qidx)
+{
+ struct vhost_user_i2c *vi =
+ container_of(dev, struct vhost_user_i2c, dev);
+ VuVirtq *vq = vu_get_queue(dev, qidx);
+ VuVirtqElement *elem;
+
+ for (;;) {
+ struct virtio_i2c_out_hdr *hdr;
+ struct iovec *resultv;
+ size_t used = 0;
+ bool ok = true;
+
+ elem = vu_queue_pop(dev, vq, sizeof(VuVirtqElement));
+ if (!elem)
+ break;
+
+ dbg("elem %p index %u out_num %u in_num %u\n", elem,
+ elem->index, elem->out_num, elem->in_num);
+ dump_iov("out", elem->out_sg, elem->out_num);
+ dump_iov("in", elem->in_sg, elem->in_num);
+
+ assert(elem->out_sg[0].iov_len == sizeof(*hdr));
+ hdr = elem->out_sg[0].iov_base;
+
+ if (elem->out_num == 2 && elem->in_num == 1) {
+ struct iovec *data = &elem->out_sg[1];
+
+ ok = i2c_write(vi, hdr->addr, data->iov_base,
+ data->iov_len);
+ resultv = &elem->in_sg[0];
+ } else if (elem->out_num == 1 && elem->in_num == 2) {
+ struct iovec *data = &elem->in_sg[0];
+
+ ok = i2c_read(vi, hdr->addr, data->iov_base,
+ data->iov_len);
+ resultv = &elem->in_sg[1];
+ used += data->iov_len;
+ } else {
+ assert(false);
+ }
+
+ struct virtio_i2c_in_hdr *inhdr = resultv->iov_base;
+
+ inhdr->status = ok ? VIRTIO_I2C_MSG_OK : VIRTIO_I2C_MSG_ERR;
+
+ used += sizeof(*inhdr);
+ vu_queue_push(dev, vq, elem, used);
+ free(elem);
+ }
+
+ vu_queue_notify(&vi->dev, vq);
+}
+
+static void i2c_queue_set_started(VuDev *dev, int qidx, bool started)
+{
+ VuVirtq *vq = vu_get_queue(dev, qidx);
+
+ dbg("queue started %d:%d\n", qidx, started);
+
+ vu_set_queue_handler(dev, vq, started ? i2c_handle_cmdq : NULL);
+}
+
+static bool i2cquit;
+static bool gpioquit;
+
+static void remove_watch(VuDev *dev, int fd);
+
+static int i2c_process_msg(VuDev *dev, VhostUserMsg *vmsg, int *do_reply)
+{
+ if (vmsg->request == VHOST_USER_NONE) {
+ dbg("i2c disconnect");
+ remove_watch(dev, -1);
+ i2cquit = true;
+ return true;
+ }
+ return false;
+}
+static int gpio_process_msg(VuDev *dev, VhostUserMsg *vmsg, int *do_reply)
+{
+ if (vmsg->request == VHOST_USER_NONE) {
+ dbg("gpio disconnect");
+ remove_watch(dev, -1);
+ gpioquit = true;
+ return true;
+ }
+ return false;
+}
+
+static uint64_t i2c_get_features(VuDev *dev)
+{
+ return 1ull << VIRTIO_I2C_F_ZERO_LENGTH_REQUEST;
+}
+
+static const VuDevIface i2c_iface = {
+ .get_features = i2c_get_features,
+ .queue_set_started = i2c_queue_set_started,
+ .process_msg = i2c_process_msg,
+};
+
+static void gpio_send_irq_response(struct vhost_user_gpio *gpio,
+ unsigned int pin, unsigned int status)
+{
+ assert(pin < ARRAY_SIZE(gpio->irq_elements));
+
+ VuVirtqElement *elem = gpio->irq_elements[pin];
+ VuVirtq *vq = vu_get_queue(&gpio->dev, 1);
+
+ if (!elem) {
+ dbg("no irq buf for pin %d\n", pin);
+ assert(status != VIRTIO_GPIO_IRQ_STATUS_VALID);
+ return;
+ }
+
+ struct virtio_gpio_irq_response *resp;
+
+ assert(elem->out_num == 1);
+ assert(elem->in_sg[0].iov_len == sizeof(*resp));
+
+ resp = elem->in_sg[0].iov_base;
+ resp->status = status;
+
+ vu_queue_push(&gpio->dev, vq, elem, sizeof(*resp));
+ gpio->irq_elements[pin] = NULL;
+ free(elem);
+
+ vu_queue_notify(&gpio->dev, vq);
+}
+
+static void gpio_set_irq_type(struct vhost_user_gpio *gpio, unsigned int pin,
+ unsigned int type)
+{
+ PyObject *pArgs, *pValue;
+
+ pArgs = PyTuple_New(2);
+ pValue = PyLong_FromLong(pin);
+ PyTuple_SetItem(pArgs, 0, pValue);
+
+ pValue = PyLong_FromLong(type);
+ PyTuple_SetItem(pArgs, 1, pValue);
+
+ pValue = PyObject_CallObject(py_gpio_set_irq_type, pArgs);
+ if (!pValue) {
+ PyErr_Print();
+ errx(1, "error from gpio.set_irq_type()");
+ }
+ Py_DECREF(pArgs);
+
+ if (type == VIRTIO_GPIO_IRQ_TYPE_NONE) {
+ gpio_send_irq_response(gpio, pin,
+ VIRTIO_GPIO_IRQ_STATUS_INVALID);
+ }
+}
+
+static void gpio_unmask(struct vhost_user_gpio *vi, unsigned int gpio)
+{
+ PyObject *pArgs, *pValue;
+
+ pArgs = PyTuple_New(1);
+ pValue = PyLong_FromLong(gpio);
+ PyTuple_SetItem(pArgs, 0, pValue);
+
+ pValue = PyObject_CallObject(py_gpio_unmask, pArgs);
+ if (!pValue) {
+ PyErr_Print();
+ errx(1, "error from gpio.unmask()");
+ }
+ Py_DECREF(pArgs);
+}
+
+static void gpio_handle_cmdq(VuDev *dev, int qidx)
+{
+ struct vhost_user_gpio *vi =
+ container_of(dev, struct vhost_user_gpio, dev);
+ VuVirtq *vq = vu_get_queue(dev, qidx);
+ VuVirtqElement *elem;
+
+ while (1) {
+ struct virtio_gpio_request *req;
+ struct virtio_gpio_response *resp;
+
+ elem = vu_queue_pop(dev, vq, sizeof(VuVirtqElement));
+ if (!elem)
+ break;
+
+ dbg("elem %p index %u out_num %u in_num %u\n", elem,
+ elem->index, elem->out_num, elem->in_num);
+
+ dump_iov("out", elem->out_sg, elem->out_num);
+ dump_iov("in", elem->in_sg, elem->in_num);
+
+ assert(elem->out_num == 1);
+ assert(elem->in_num == 1);
+
+ assert(elem->out_sg[0].iov_len == sizeof(*req));
+ assert(elem->in_sg[0].iov_len == sizeof(*resp));
+
+ req = elem->out_sg[0].iov_base;
+ resp = elem->in_sg[0].iov_base;
+
+ dbg("req type %#x gpio %#x value %#x\n", req->type, req->gpio,
+ req->value);
+
+ switch (req->type) {
+ case VIRTIO_GPIO_MSG_IRQ_TYPE:
+ gpio_set_irq_type(vi, req->gpio, req->value);
+ break;
+ default:
+ /*
+ * The other types couldhooked up to Python later for
+ * testing of drivers' control of GPIOs.
+ */
+ break;
+ }
+
+ resp->status = VIRTIO_GPIO_STATUS_OK;
+ resp->value = 0;
+
+ vu_queue_push(dev, vq, elem, sizeof(*resp));
+ free(elem);
+ }
+
+ vu_queue_notify(&vi->dev, vq);
+}
+
+static void gpio_handle_eventq(VuDev *dev, int qidx)
+{
+ struct vhost_user_gpio *vi =
+ container_of(dev, struct vhost_user_gpio, dev);
+ VuVirtq *vq = vu_get_queue(dev, qidx);
+ VuVirtqElement *elem;
+
+ for (;;) {
+ struct virtio_gpio_irq_request *req;
+ struct virtio_gpio_irq_response *resp;
+
+ elem = vu_queue_pop(dev, vq, sizeof(VuVirtqElement));
+ if (!elem)
+ break;
+
+ dbg("elem %p index %u out_num %u in_num %u\n", elem,
+ elem->index, elem->out_num, elem->in_num);
+
+ dump_iov("out", elem->out_sg, elem->out_num);
+ dump_iov("in", elem->in_sg, elem->in_num);
+
+ assert(elem->out_num == 1);
+ assert(elem->in_num == 1);
+
+ assert(elem->out_sg[0].iov_len == sizeof(*req));
+ assert(elem->in_sg[0].iov_len == sizeof(*resp));
+
+ req = elem->out_sg[0].iov_base;
+ resp = elem->in_sg[0].iov_base;
+
+ dbg("irq req gpio %#x\n", req->gpio);
+
+ assert(req->gpio < ARRAY_SIZE(vi->irq_elements));
+ assert(vi->irq_elements[req->gpio] == NULL);
+
+ vi->irq_elements[req->gpio] = elem;
+
+ gpio_unmask(vi, req->gpio);
+ }
+}
+
+static void gpio_queue_set_started(VuDev *dev, int qidx, bool started)
+{
+ VuVirtq *vq = vu_get_queue(dev, qidx);
+
+ dbg("%s %d:%d\n", __func__, qidx, started);
+
+ if (qidx == 0)
+ vu_set_queue_handler(dev, vq,
+ started ? gpio_handle_cmdq : NULL);
+ if (qidx == 1)
+ vu_set_queue_handler(dev, vq,
+ started ? gpio_handle_eventq : NULL);
+}
+
+static int gpio_get_config(VuDev *dev, uint8_t *config, uint32_t len)
+{
+ struct vhost_user_gpio *gpio =
+ container_of(dev, struct vhost_user_gpio, dev);
+ static struct virtio_gpio_config gpioconfig = {
+ .ngpio = ARRAY_SIZE(gpio->irq_elements),
+ };
+
+ dbg("%s: len %u\n", __func__, len);
+
+ if (len > sizeof(struct virtio_gpio_config))
+ return -1;
+
+ memcpy(config, &gpioconfig, len);
+
+ return 0;
+}
+
+static uint64_t gpio_get_protocol_features(VuDev *dev)
+{
+ return 1ull << VHOST_USER_PROTOCOL_F_CONFIG;
+}
+
+static uint64_t gpio_get_features(VuDev *dev)
+{
+ return 1ull << VIRTIO_GPIO_F_IRQ;
+}
+
+static const VuDevIface gpio_vuiface = {
+ .get_features = gpio_get_features,
+ .queue_set_started = gpio_queue_set_started,
+ .process_msg = gpio_process_msg,
+ .get_config = gpio_get_config,
+ .get_protocol_features = gpio_get_protocol_features,
+};
+
+static void panic(VuDev *dev, const char *err)
+{
+ fprintf(stderr, "panicking!");
+ abort();
+}
+
+static struct watch *new_watch(struct VuDev *dev, int fd, enum watch_type type,
+ void *func, void *data)
+{
+ struct watch *watch = malloc(sizeof(*watch));
+
+ assert(watch);
+
+ watch->dev = dev;
+ watch->fd = fd;
+ watch->func = func;
+ watch->data = data;
+ watch->type = type;
+
+ list_add(&watch->list, &watches);
+
+ return watch;
+}
+
+static void set_watch(VuDev *dev, int fd, int condition, vu_watch_cb cb,
+ void *data)
+{
+ struct watch *watch = new_watch(dev, fd, VU_WATCH, cb, data);
+ int ret;
+
+ struct epoll_event ev = {
+ .events = EPOLLIN,
+ .data.ptr = watch,
+ };
+
+ dbg("set watch epfd %d fd %d condition %d cb %p\n", epfd, fd, condition,
+ cb);
+
+ epoll_ctl(epfd, EPOLL_CTL_DEL, fd, NULL);
+
+ ret = epoll_ctl(epfd, EPOLL_CTL_ADD, fd, &ev);
+ if (ret < 0)
+ err(1, "epoll_ctl");
+}
+
+static void remove_watch(VuDev *dev, int fd)
+{
+ struct watch *watch, *tmp;
+
+ list_for_each_entry_safe(watch, tmp, &watches, list) {
+ if (watch->dev != dev)
+ continue;
+ if (fd >= 0 && watch->fd != fd)
+ continue;
+
+ epoll_ctl(epfd, EPOLL_CTL_DEL, watch->fd, NULL);
+
+ list_del(&watch->list);
+ free(watch);
+ }
+}
+
+static int unix_listen(const char *path)
+{
+ struct sockaddr_un un = {
+ .sun_family = AF_UNIX,
+ };
+ int sock;
+ int ret;
+
+ unlink(path);
+
+ sock = socket(PF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0);
+ if (sock < 0)
+ err(1, "socket");
+
+ memcpy(&un.sun_path, path, strlen(path));
+
+ ret = bind(sock, (struct sockaddr *)&un, sizeof(un));
+ if (ret < 0)
+ err(1, "bind");
+
+ ret = listen(sock, 1);
+ if (ret < 0)
+ err(1, "listen");
+
+ return sock;
+}
+
+static void dev_add_watch(int epfd, struct watch *watch)
+{
+ struct epoll_event event = {
+ .events = EPOLLIN | EPOLLONESHOT,
+ .data.ptr = watch,
+ };
+ int ret;
+
+ ret = epoll_ctl(epfd, EPOLL_CTL_ADD, watch->fd, &event);
+ if (ret < 0)
+ err(1, "EPOLL_CTL_ADD");
+}
+
+static VuDev *gpio_init(int epfd, const char *path)
+{
+ struct watch *watch;
+ VuDev *dev;
+ int lsock;
+ bool rc;
+
+ lsock = unix_listen(path);
+ if (lsock < 0)
+ err(1, "listen %s", path);
+
+ rc = vu_init(&gpio.dev, 2, lsock, panic, NULL, set_watch,
+ remove_watch, &gpio_vuiface);
+ assert(rc == true);
+
+ dev = &gpio.dev;
+ watch = new_watch(dev, lsock, LISTEN, vu_dispatch, dev);
+
+ dev_add_watch(epfd, watch);
+
+ return dev;
+}
+
+static VuDev *i2c_init(int epfd, const char *path)
+{
+ static struct vhost_user_i2c i2c = {};
+ VuDev *dev = &i2c.dev;
+ struct watch *watch;
+ int lsock;
+ bool rc;
+
+ lsock = unix_listen(path);
+ if (lsock < 0)
+ err(1, "listen %s", path);
+
+ rc = vu_init(dev, 1, lsock, panic, NULL, set_watch,
+ remove_watch, &i2c_iface);
+ assert(rc == true);
+
+ watch = new_watch(dev, lsock, LISTEN, vu_dispatch, dev);
+
+ dev_add_watch(epfd, watch);
+
+ return dev;
+}
+
+static pid_t run_uml(char **argv)
+{
+ int log, null, ret;
+ pid_t pid;
+
+ pid = fork();
+ if (pid < 0)
+ err(1, "fork");
+ if (pid > 0)
+ return pid;
+
+ chdir(getenv("ROADTEST_WORK_DIR"));
+
+ log = open("uml.txt", O_WRONLY | O_TRUNC | O_APPEND | O_CREAT, 0600);
+ if (log < 0)
+ err(1, "open uml.txt");
+
+ null = open("/dev/null", O_RDONLY);
+ if (null < 0)
+ err(1, "open null");
+
+ ret = dup2(null, 0);
+ if (ret < 0)
+ err(1, "dup2");
+
+ ret = dup2(log, 1);
+ if (ret < 0)
+ err(1, "dup2");
+
+ ret = dup2(log, 2);
+ if (ret < 0)
+ err(1, "dup2");
+
+ execvpe(argv[0], argv, environ);
+ err(1, "execve");
+
+ return -1;
+}
+
+int main(int argc, char *argv[])
+{
+ static struct option long_option[] = {
+ { "main-script", required_argument, 0, 'm' },
+ { "gpio-socket", required_argument, 0, 'g' },
+ { "i2c-socket", required_argument, 0, 'i' },
+ };
+
+ while (1) {
+ int c = getopt_long(argc, argv, "", long_option, NULL);
+
+ if (c == -1)
+ break;
+
+ switch (c) {
+ case 'm':
+ opt_main_script = optarg;
+ break;
+
+ case 'g':
+ opt_gpio_socket = optarg;
+ break;
+
+ case 'i':
+ opt_i2c_socket = optarg;
+ break;
+
+ default:
+ errx(1, "getopt");
+ }
+ }
+
+ if (!opt_main_script || !opt_gpio_socket || !opt_i2c_socket)
+ errx(1, "Invalid arguments");
+
+ epfd = epoll_create1(EPOLL_CLOEXEC);
+ if (epfd < 0)
+ err(1, "epoll_create1");
+
+ init_python();
+
+ gpio_init(epfd, opt_gpio_socket);
+ i2c_init(epfd, opt_i2c_socket);
+
+ run_uml(&argv[optind]);
+
+ while (1) {
+ struct epoll_event events[10];
+ int nfds;
+ int i;
+
+ nfds = epoll_wait(epfd, events, ARRAY_SIZE(events), -1);
+ if (nfds < 0) {
+ if (errno == EINTR) {
+ continue;
+
+ err(1, "epoll_wait");
+ }
+ }
+
+ if (!PyObject_CallObject(py_process_control, NULL)) {
+ PyErr_Print();
+ errx(1, "error from backend.process_control");
+ }
+
+ for (i = 0; i < nfds; i++) {
+ struct epoll_event *event = &events[i];
+ struct watch *watch = event->data.ptr;
+ int fd;
+
+ switch (watch->type) {
+ case LISTEN:
+ fd = accept(watch->fd, NULL, NULL);
+ close(watch->fd);
+ if (fd == -1)
+ err(1, "accept");
+
+ watch->dev->sock = fd;
+ watch->fd = fd;
+ watch->type = SOCKET_WATCH;
+
+ struct epoll_event event = {
+ .events = EPOLLIN,
+ .data.ptr = watch,
+ };
+
+ int ret = epoll_ctl(epfd, EPOLL_CTL_ADD, fd,
+ &event);
+ if (ret < 0)
+ err(1, "epoll_ctl");
+
+ break;
+ case SOCKET_WATCH:
+ vu_dispatch(watch->dev);
+ break;
+ case VU_WATCH:
+ ((vu_watch_cb)(watch->func))(watch->dev, POLLIN,
+ watch->data);
+ break;
+ default:
+ fprintf(stderr, "abort!");
+ abort();
+ }
+ }
+
+ if (i2cquit && gpioquit)
+ break;
+ }
+
+ vu_deinit(&i2c.dev);
+ vu_deinit(&gpio.dev);
+
+ Py_Finalize();
+
+ return 0;
+}
--
2.34.1
On Fri, Mar 11, 2022 at 11:24 AM Vincent Whitchurch
<[email protected]> wrote:
>
> Add a regression test for the problem fixed by the following patch,
> which would require specific environmental conditions to be able to be
> reproduced and regression-tested on real hardware:
>
> iio: light: opt3001: Fixed timeout error when 0 lux
> https://lore.kernel.org/lkml/[email protected]/
>
> No other aspects of the driver are tested.
>
> Signed-off-by: Vincent Whitchurch <[email protected]>
> ---
> .../roadtest/roadtest/tests/iio/__init__.py | 0
> .../roadtest/roadtest/tests/iio/config | 1 +
> .../roadtest/tests/iio/light/__init__.py | 0
> .../roadtest/roadtest/tests/iio/light/config | 1 +
> .../roadtest/tests/iio/light/test_opt3001.py | 95 +++++++++++++++++++
> 5 files changed, 97 insertions(+)
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py
>
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/__init__.py b/tools/testing/roadtest/roadtest/tests/iio/__init__.py
> new file mode 100644
> index 000000000000..e69de29bb2d1
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/config b/tools/testing/roadtest/roadtest/tests/iio/config
> new file mode 100644
> index 000000000000..a08d9e23ce38
> --- /dev/null
> +++ b/tools/testing/roadtest/roadtest/tests/iio/config
> @@ -0,0 +1 @@
> +CONFIG_IIO=y
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/__init__.py b/tools/testing/roadtest/roadtest/tests/iio/light/__init__.py
> new file mode 100644
> index 000000000000..e69de29bb2d1
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/config b/tools/testing/roadtest/roadtest/tests/iio/light/config
> new file mode 100644
> index 000000000000..b9753f2d0728
> --- /dev/null
> +++ b/tools/testing/roadtest/roadtest/tests/iio/light/config
> @@ -0,0 +1 @@
> +CONFIG_OPT3001=m
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py
> new file mode 100644
> index 000000000000..abf20b8f3516
> --- /dev/null
> +++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py
> @@ -0,0 +1,95 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +# Copyright Axis Communications AB
> +
> +from typing import Any, Final
> +
> +from roadtest.backend.i2c import SMBusModel
> +from roadtest.core.devicetree import DtFragment, DtVar
> +from roadtest.core.hardware import Hardware
> +from roadtest.core.modules import insmod, rmmod
> +from roadtest.core.suite import UMLTestCase
> +from roadtest.core.sysfs import I2CDriver, read_float
> +
> +REG_RESULT: Final = 0x00
> +REG_CONFIGURATION: Final = 0x01
> +REG_LOW_LIMIT: Final = 0x02
> +REG_HIGH_LIMIT: Final = 0x03
> +REG_MANUFACTURER_ID: Final = 0x7E
> +REG_DEVICE_ID: Final = 0x7F
> +
> +REG_CONFIGURATION_CRF: Final = 1 << 7
> +
> +
> +class OPT3001(SMBusModel):
> + def __init__(self, **kwargs: Any) -> None:
> + super().__init__(regbytes=2, byteorder="big", **kwargs)
> + # Reset values from datasheet
> + self.regs = {
> + REG_RESULT: 0x0000,
> + REG_CONFIGURATION: 0xC810,
> + REG_LOW_LIMIT: 0xC000,
> + REG_HIGH_LIMIT: 0xBFFF,
> + REG_MANUFACTURER_ID: 0x5449,
> + REG_DEVICE_ID: 0x3001,
> + }
> +
> + def reg_read(self, addr: int) -> int:
> + val = self.regs[addr]
> +
> + if addr == REG_CONFIGURATION:
> + # Always indicate that the conversion is ready. This is good
> + # enough for our current purposes.
> + val |= REG_CONFIGURATION_CRF
> +
> + return val
> +
> + def reg_write(self, addr: int, val: int) -> None:
> + assert addr in self.regs
> + self.regs[addr] = val
> +
> +
> +class TestOPT3001(UMLTestCase):
I am partial to starting with UML since there are a lot of nice easy
things about starting there; however, I imagine people will eventually
want to use this on other architectures (speaking from experience).
How difficult do you think it would be to extend this to support
manipulating fake devices in say QEMU?
I also have some colleagues inside of Google that worked on some
projects to simulate simple devices on an FPGA to test software and
adjacent devices in a conceptually similar way; one of these teams
built a Domain Specific Language kind of like roadtest to implement
the tests and the environment for the tests. The main reason I mention
this here is I am thinking about maybe one day having an API you can
implement so you can run your roadtests on UML, QEMU, or on any
emulator or hardware testbed that implements the appropriate API.
I'll try to dig up some people who might be interested and add them here.
> + dts = DtFragment(
> + src="""
> +&i2c {
> + light-sensor@$addr$ {
> + compatible = "ti,opt3001";
> + reg = <0x$addr$>;
> + };
> +};
> + """,
> + variables={
> + "addr": DtVar.I2C_ADDR,
> + },
> + )
> +
> + @classmethod
> + def setUpClass(cls) -> None:
> + insmod("opt3001")
> +
> + @classmethod
> + def tearDownClass(cls) -> None:
> + rmmod("opt3001")
> +
> + def setUp(self) -> None:
> + self.driver = I2CDriver("opt3001")
> + self.hw = Hardware("i2c")
> + self.hw.load_model(OPT3001)
> +
> + def tearDown(self) -> None:
> + self.hw.close()
> +
> + def test_illuminance(self) -> None:
> + data = [
> + # Some values from datasheet, and 0
> + (0b_0000_0000_0000_0000, 0),
> + (0b_0000_0000_0000_0001, 0.01),
> + (0b_0011_0100_0101_0110, 88.80),
> + (0b_0111_1000_1001_1010, 2818.56),
> + ]
> + with self.driver.bind(self.dts["addr"]) as dev:
> + luxfile = dev.path / "iio:device0/in_illuminance_input"
> +
> + for regval, lux in data:
> + self.hw.reg_write(REG_RESULT, regval)
> + self.assertEqual(read_float(luxfile), lux)
I love the framework; this looks very easy to use.
One nit about this test; it seems like you cover just one test case
here - the happy path. Can you cover some other one? Particularly some
error paths?
Sorry, I am not trying to be cheeky here; it looks like this driver
actually should probably be fully (or very close to fully) testable
via roadtest as I understand it. It only looks like there are a
handful of cases to cover for the driver: the device is busy, the
device returned something invalid, the user requested something
invalid, and several SMBus read/write failures - it really only looks
like there are a handful of paths and I think they are all accessible
via the I2C interface (except for maybe the user requesting something
invalid).
+Kees Cook - I imagine you have already seen this, but I figured you
would be interested because of your recent work on the KUnit UAPI and
the mocking discussions.
+Dmitry Vyukov - This made me think of the syzkaller/KUnit experiments
we did a couple of years back - this would probably work a bit better.
On Fri, Mar 11, 2022 at 11:24 AM Vincent Whitchurch
<[email protected]> wrote:
>
> This patchset proposes roadtest, a device-driver testing framework. Drivers
> are tested under User Mode Linux (UML) and interact with mocked/modelled
> hardware. The tests and hardware models are written in Python, the former
> using Python's built-in unittest framework.
Wow! This sounds awesome! I was hoping to get some kind of hardware
modeling with KUnit eventually. I did some experiments, but this looks
way more mature.
> Drivers are tested via their userspace interfaces. The hardware models allow
> tests to inject values into registers and assert that drivers control the
> hardware in the right way and react as expected to stimuli.
I already took a look at the documentation patch - I'll comment there
more in detail, but I like the hardware modelling and device tree
code; it seems very usable.
> Roadtest is meant to be used for relatively simple drivers, such as the ones
> part of the IIO, regulator and RTC subsystems.
Obviously for an initial version going after simple stuff makes sense,
but I would hope there is applicability to any driver stack
eventually.
> Questions and answers:
>
> = Why do we need this?
>
> There are a large amount of these kind of drivers in the kernel. Most of the
> hardware is not available in current CI systems so most drivers can only, at
> best, be build-tested there. Even basic soundness such as a driver
> successfully probing and binding to the devices it tries to be support cannot
> be tested. Drivers cannot be easily regression-tested to ensure that bugs
> fixed once do not get reintroduced.
>
> Many drivers support multiple related hardware variants, and far from all patch
> submitters have access to all the variants which the driver that they are
> patching supports, so there is no way for them to easily verify that they
> haven't broken something basic on a variant which they do not own.
>
> Furthermore, hardware can be used in many different configurations with drivers
> supporting many different devicetree properties, so even just having access to
> all the variants would be insufficient.
>
> On top of that, some of the chips measure environmental conditions such as
> temperature, so testing extreme cases may not be simple even if one has access
> to the hardware.
>
> All this makes development, modification, maintenance, and reviewing of these
> drivers harder than it necessarily needs to be. Roadtest hopes to make some of
> these things slightly easier by providing a framework to create hardware
> models/mocks and to write testcases which exercise drivers using these models.
Very much agree. I used to do driver development and these
difficulties are what prompted me to do KUnit.
> = Do you have some specific examples of the kind of code this could be used to
> test?
>
> Here is an example of a patch which can easily be regression-tested using
> roadtest (in fact, this series includes such a regression test) but is much
> harder to do so automatically with real hardware since it requires specific
> environmental conditions:
>
> iio: light: opt3001: Fixed timeout error when 0 lux
> https://lore.kernel.org/lkml/[email protected]/
>
> Here is another example. This driver has code which correctly parses a
> documented devicetree property (amstaos,proximity-diodes) but which then fails
> to actually communicate this setting to the hardware in any way. Such code can
> be easily tested with roadtest since the framework integrates devicetree
> support and provides functions to assert that drivers writes expected registers
> with expected values:
>
> drivers/iio/light/tsl2772.c tsl2772_read_prox_diodes()
>
> (Both the above examples happen to be from the same subsystem but that should
> in no way be taken to imply that such issues are unique to that subsystem or
> that that subsystem has more of them.)
>
> = How does this relate to kselftests?
>
> Tests in kselftests also test kernel code using the userspace interfaces, but
> that's about what's common between the frameworks. kselftests has other goals
> and does not provide any kind of mechanism for hardware mocking.
I had a question that after thinking about it; I think I know the
answer, so I am going to ask the question anyway and attempt to answer
it myself:
I agree in regard to mocking, but why not use kselftest for driving
tests that check drivers from userspace? I believe there are other
kselftest tests implemented in Python, why can't you just run your
tests inside of kselftest?
Now, I believe the answer to this question is that you need to control
spinning up your own kernel to run inside your test harness because
you need to control the environment that the kernel runs in - is this
correct?
> = How does this relate to kunit?
>
> Kunit is for unit testing of functions in kernel code, and is not meant for
> testing kernel code via userspace interfaces. It could in theory be used to
> test some of the simple drivers too, but that would require (1) a large amount
> of mocking code in various kernel frameworks, and, more importantly, (2)
> refactoring of the drivers to be tested.
I mostly agree, but I think there is something that is missing here:
so roadtest seems to depend on having a user interface to test a
driver - for a simple smoke test on a simple driver without a big
driver stack on top, that makes sense, but what about testing error
paths or a platform driver buried beneath a deep driver stack? I think
there is potential for a powerful combination using KUnit to test the
low level kernel API and using roadtest to mock the hardware
environment and provide configuration.
I am imagining that we could have an in-kernel KUnit/roadtest API that
we can use to have an in-kernel test request changes to the
environment for creating error cases and the like that can be
validated by KUnit test cases.
Going even further, I wonder if we could run kselftests inside of
roadtest since roadtest allows us to change the environment on the
fly.
> This can be contrasted with roadtest which works with mostly unmodified drivers
> and which mocks the hardware at the lowest level without having to change
> kernel frameworks.
I think that is both potentially an advantage and a disadvantage.
The advantage is that your test is very general; roadtests would
likely be portable across kernel versions.
The disadvantage is that you don't get as much code introspection: I
imagine roadtest is not as good as testing error paths for example.
I also think that having to change code to make it more testable is
often an advantage as much as a disadvantage.
Still, I think that is a good set of tradeoffs for roadtest to make
when set against KUnit and kselftest since roadtest seems to fit in
where kselftest and KUnit are weak.
> = How do I use it?
>
> See Documentation/dev-tools/roadtest.rst added by the documentation patch for
> more information about running and writing tests using this framework.
>
> = What's included in the patchset?
>
> The current framework allows developing tests for hardware which uses the I2C
> bus. Hardware models can also control GPIOs and use them to trigger
> interrupts.
>
> This series includes tests for some IIO, regulator and RTC drivers. The
> regulator and RTC tests depend on a few driver patches which are either in
> review or in linux-next. These are noted in the commit messages.
>
> The entire patch set, including the required dependencies, is also available in
> a git tree:
>
> https://github.com/vwax/linux/commits/roadtest/rfc-v1
>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
>
> Vincent Whitchurch (10):
> roadtest: import libvhost-user from QEMU
> roadtest: add C backend
> roadtest: add framework
> roadtest: add base config
> roadtest: add build files
> roadtest: add documentation
> iio: light: opt3001: add roadtest
> iio: light: vcnl4000: add roadtest
> regulator: tps62864: add roadtest
> rtc: pcf8563: add roadtest
>
> Documentation/dev-tools/index.rst | 1 +
> Documentation/dev-tools/roadtest.rst | 669 ++++
> tools/testing/roadtest/.gitignore | 2 +
> tools/testing/roadtest/Dockerfile | 25 +
> tools/testing/roadtest/Makefile | 84 +
> tools/testing/roadtest/init.sh | 19 +
> tools/testing/roadtest/pyproject.toml | 10 +
> tools/testing/roadtest/requirements.txt | 4 +
> tools/testing/roadtest/roadtest/__init__.py | 2 +
> .../roadtest/roadtest/backend/__init__.py | 0
> .../roadtest/roadtest/backend/backend.py | 32 +
> .../testing/roadtest/roadtest/backend/gpio.py | 111 +
> .../testing/roadtest/roadtest/backend/i2c.py | 123 +
> .../testing/roadtest/roadtest/backend/main.py | 13 +
> .../testing/roadtest/roadtest/backend/mock.py | 20 +
> .../roadtest/roadtest/backend/test_gpio.py | 98 +
> .../roadtest/roadtest/backend/test_i2c.py | 84 +
> .../testing/roadtest/roadtest/cmd/__init__.py | 0
> tools/testing/roadtest/roadtest/cmd/main.py | 146 +
> tools/testing/roadtest/roadtest/cmd/remote.py | 48 +
> .../roadtest/roadtest/core/__init__.py | 0
> .../testing/roadtest/roadtest/core/control.py | 52 +
> .../roadtest/roadtest/core/devicetree.py | 155 +
> .../roadtest/roadtest/core/hardware.py | 94 +
> tools/testing/roadtest/roadtest/core/log.py | 42 +
> .../testing/roadtest/roadtest/core/modules.py | 38 +
> .../testing/roadtest/roadtest/core/opslog.py | 35 +
> tools/testing/roadtest/roadtest/core/proxy.py | 48 +
> tools/testing/roadtest/roadtest/core/suite.py | 286 ++
> tools/testing/roadtest/roadtest/core/sysfs.py | 77 +
> .../roadtest/roadtest/core/test_control.py | 35 +
> .../roadtest/roadtest/core/test_devicetree.py | 31 +
> .../roadtest/roadtest/core/test_hardware.py | 41 +
> .../roadtest/roadtest/core/test_log.py | 54 +
> .../roadtest/roadtest/core/test_opslog.py | 27 +
> .../roadtest/roadtest/tests/__init__.py | 0
> .../roadtest/roadtest/tests/base/config | 84 +
> .../roadtest/roadtest/tests/iio/__init__.py | 0
> .../roadtest/roadtest/tests/iio/config | 1 +
> .../roadtest/roadtest/tests/iio/iio.py | 112 +
> .../roadtest/tests/iio/light/__init__.py | 0
> .../roadtest/roadtest/tests/iio/light/config | 2 +
> .../roadtest/tests/iio/light/test_opt3001.py | 95 +
> .../roadtest/tests/iio/light/test_vcnl4000.py | 132 +
> .../roadtest/tests/iio/light/test_vcnl4010.py | 282 ++
> .../roadtest/tests/iio/light/test_vcnl4040.py | 104 +
> .../roadtest/tests/iio/light/test_vcnl4200.py | 96 +
> .../roadtest/tests/regulator/__init__.py | 0
> .../roadtest/roadtest/tests/regulator/config | 4 +
> .../roadtest/tests/regulator/test_tps62864.py | 187 ++
> .../roadtest/roadtest/tests/rtc/__init__.py | 0
> .../roadtest/roadtest/tests/rtc/config | 1 +
> .../roadtest/roadtest/tests/rtc/rtc.py | 73 +
> .../roadtest/tests/rtc/test_pcf8563.py | 348 ++
> tools/testing/roadtest/src/.gitignore | 1 +
> tools/testing/roadtest/src/backend.c | 884 +++++
> .../src/libvhost-user/include/atomic.h | 310 ++
> .../src/libvhost-user/libvhost-user.c | 2885 +++++++++++++++++
> .../src/libvhost-user/libvhost-user.h | 691 ++++
> 59 files changed, 8798 insertions(+)
> create mode 100644 Documentation/dev-tools/roadtest.rst
> create mode 100644 tools/testing/roadtest/.gitignore
> create mode 100644 tools/testing/roadtest/Dockerfile
> create mode 100644 tools/testing/roadtest/Makefile
> create mode 100755 tools/testing/roadtest/init.sh
> create mode 100644 tools/testing/roadtest/pyproject.toml
> create mode 100644 tools/testing/roadtest/requirements.txt
> create mode 100644 tools/testing/roadtest/roadtest/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/backend.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/gpio.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/i2c.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/main.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/mock.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/test_gpio.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/test_i2c.py
> create mode 100644 tools/testing/roadtest/roadtest/cmd/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/cmd/main.py
> create mode 100644 tools/testing/roadtest/roadtest/cmd/remote.py
> create mode 100644 tools/testing/roadtest/roadtest/core/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/core/control.py
> create mode 100644 tools/testing/roadtest/roadtest/core/devicetree.py
> create mode 100644 tools/testing/roadtest/roadtest/core/hardware.py
> create mode 100644 tools/testing/roadtest/roadtest/core/log.py
> create mode 100644 tools/testing/roadtest/roadtest/core/modules.py
> create mode 100644 tools/testing/roadtest/roadtest/core/opslog.py
> create mode 100644 tools/testing/roadtest/roadtest/core/proxy.py
> create mode 100644 tools/testing/roadtest/roadtest/core/suite.py
> create mode 100644 tools/testing/roadtest/roadtest/core/sysfs.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_control.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_devicetree.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_hardware.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_log.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_opslog.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/base/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/iio.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/regulator/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/regulator/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/regulator/test_tps62864.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/rtc.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/test_pcf8563.py
> create mode 100644 tools/testing/roadtest/src/.gitignore
> create mode 100644 tools/testing/roadtest/src/backend.c
> create mode 100644 tools/testing/roadtest/src/libvhost-user/include/atomic.h
> create mode 100644 tools/testing/roadtest/src/libvhost-user/libvhost-user.c
> create mode 100644 tools/testing/roadtest/src/libvhost-user/libvhost-user.h
>
> --
> 2.34.1
>
On Mon, Mar 14, 2022 at 11:24:59PM +0100, Brendan Higgins wrote:
> +Kees Cook - I imagine you have already seen this, but I figured you
> would be interested because of your recent work on the KUnit UAPI and
> the mocking discussions.
> +Dmitry Vyukov - This made me think of the syzkaller/KUnit experiments
> we did a couple of years back - this would probably work a bit better.
>
> On Fri, Mar 11, 2022 at 11:24 AM Vincent Whitchurch
> <[email protected]> wrote:
> >
> > This patchset proposes roadtest, a device-driver testing framework. Drivers
> > are tested under User Mode Linux (UML) and interact with mocked/modelled
> > hardware. The tests and hardware models are written in Python, the former
> > using Python's built-in unittest framework.
>
> Wow! This sounds awesome! I was hoping to get some kind of hardware
> modeling with KUnit eventually. I did some experiments, but this looks
> way more mature.
Thank you for the comments!
> > Drivers are tested via their userspace interfaces. The hardware models allow
> > tests to inject values into registers and assert that drivers control the
> > hardware in the right way and react as expected to stimuli.
>
> I already took a look at the documentation patch - I'll comment there
> more in detail, but I like the hardware modelling and device tree
> code; it seems very usable.
>
> > Roadtest is meant to be used for relatively simple drivers, such as the ones
> > part of the IIO, regulator and RTC subsystems.
>
> Obviously for an initial version going after simple stuff makes sense,
> but I would hope there is applicability to any driver stack
> eventually.
Yes, there is no inherent restriction to only simple hardware, but these
kinds of subsystem are the ones where it's easier to apply the framework
since there's simply less stuff to model/mock in the hardware.
Supporting different busses also requires some work in the framework and
potentially some new drivers. For I2C we use virtio-i2c but there's no
ready-made virtio-spi for example. For MMIO (PCI / platform drivers), I
did some basic experiments with UML's virtio-mmio in the early stages of
writing this framework.
> > = How does this relate to kselftests?
> >
> > Tests in kselftests also test kernel code using the userspace interfaces, but
> > that's about what's common between the frameworks. kselftests has other goals
> > and does not provide any kind of mechanism for hardware mocking.
>
> I had a question that after thinking about it; I think I know the
> answer, so I am going to ask the question anyway and attempt to answer
> it myself:
>
> I agree in regard to mocking, but why not use kselftest for driving
> tests that check drivers from userspace? I believe there are other
> kselftest tests implemented in Python, why can't you just run your
> tests inside of kselftest?
>
> Now, I believe the answer to this question is that you need to control
> spinning up your own kernel to run inside your test harness because
> you need to control the environment that the kernel runs in - is this
> correct?
Yes, that is correct. For example, the devicetree stuff requires that
the kernel be booted with the devicetree. For the other tests also it's
simpler to have a controlled environment without being affected by other
stuff going on on the host. And generally it's of course easier if the
kernel which is inevitably going to crash and burn due to buggy drivers
isn't the one powering your workstation.
Also, there is no currently way to use virtio drivers such as virtio-i2c
and virtio-gpio (which roadtest uses) with the virtio device side
implemented in userspace on the same system, so that would have also
required a fair bit of work to get running.
(On a side note, I've wondered why kselftest doesn't provide a standard
way to run all the tests under kvm or something similar with all the
correct configs. For example, the kernels I work with are on embedded
systems and I rarely recompile my host kernel, and I assume that there
are plenty of others in the same situation.)
> > = How does this relate to kunit?
> >
> > Kunit is for unit testing of functions in kernel code, and is not meant for
> > testing kernel code via userspace interfaces. It could in theory be used to
> > test some of the simple drivers too, but that would require (1) a large amount
> > of mocking code in various kernel frameworks, and, more importantly, (2)
> > refactoring of the drivers to be tested.
>
> I mostly agree, but I think there is something that is missing here:
> so roadtest seems to depend on having a user interface to test a
> driver - for a simple smoke test on a simple driver without a big
> driver stack on top, that makes sense, but what about testing error
> paths or a platform driver buried beneath a deep driver stack? I think
> there is potential for a powerful combination using KUnit to test the
> low level kernel API and using roadtest to mock the hardware
> environment and provide configuration.
Yes, that could be useful. I have previously written some kunit tests
for some experimental memory management code which required different
devicetree reserved-memory nodes and arm64 (no hardware mocking) to run,
and I ran them by having a shell script which ran QEMU several times
with appropriate -append kunit.filter_glob=foo and -dtb options and
post-processing the logs with kunit.py.
> I am imagining that we could have an in-kernel KUnit/roadtest API that
> we can use to have an in-kernel test request changes to the
> environment for creating error cases and the like that can be
> validated by KUnit test cases.
>
> Going even further, I wonder if we could run kselftests inside of
> roadtest since roadtest allows us to change the environment on the
> fly.
Sounds interesting, but I would likely need to see concrete examples to
understand what kind of environment we'd want to change from within the
kernel.
> > This can be contrasted with roadtest which works with mostly unmodified drivers
> > and which mocks the hardware at the lowest level without having to change
> > kernel frameworks.
>
> I think that is both potentially an advantage and a disadvantage.
>
> The advantage is that your test is very general; roadtests would
> likely be portable across kernel versions.
>
> The disadvantage is that you don't get as much code introspection: I
> imagine roadtest is not as good as testing error paths for example.
>
> I also think that having to change code to make it more testable is
> often an advantage as much as a disadvantage.
Yes, that's true, but I highlighted the unmodified drivers bit because
(1) the process of refactoring drivers which don't have tests to make
them testable in itself carries it with a risk of breaking stuff, and
(2) and there are simply so many existing drivers that it's very
unlikely that most of them get refactored, but it should be relatively
easy to, for example, add a regression test for a specific bug fix with
roadtest.
>
> Still, I think that is a good set of tradeoffs for roadtest to make
> when set against KUnit and kselftest since roadtest seems to fit in
> where kselftest and KUnit are weak.
On Fri, 2022-03-18 at 16:49 +0100, Vincent Whitchurch wrote:
>
> It should be possible, but upstream QEMU doesn't have everything that we
> need so some work is needed there. Also, of course work is need to
> provide user space for running the tests and communicating between the
> virtual machine and the backend:
>
> - We need user space, so build scripts would need to be provided to
> cross-compile busybox and Python (and whatever libraries it needs) for
> the target architecture.
You could possibly use some nix recipes for all of this, but that's a
fairly arcane thing (we use it, but ...)
> - We also use UML's hostfs feature to make things transparent to the
> user and to avoid having to set up things like networking for
> communication between the host and the backend. I think QEMU's 9pfs
> support can be used as a rootfs too but it's not something I've
> personally tested.
That works just fine, yes. We used to do exactly this in the wireless
test suite before we switched to UML, but the switch to UML was due to
the "time-travel" feature.
https://w1.fi/cgit/hostap/tree/tests/hwsim/vm
has support for both UML and qemu/kvm.
> - We use virtio-i2c and virtio-gpio and use virtio-uml which uses the
> vhost-user API to communicate from UML to the backend. The latest
> version of QEMU has support for vhost-user-i2c, but vhost-user-gpio
> doesn't seem to have been merged yet, so work is needed on the QEMU
> side. This will also be true for other buses in the future, if they
> are implemented with new virtio devices.
>
> - For MMIO, UML has virtio-mmio which allows implementing any PCIe
> device (and by extension any platform device) outside of UML, but last
> I checked, upstream QEMU did not have something similar.
I think you have this a bit fuzzy.
The virtio_uml[.c] you speak of is the "bus" driver for virtio in UML.
Obviously, qemu has support for virtio, so you don't need those bits.
Now, virtio_uml is actually the virtio (bus) driver inside the kernel,
like you'd have virtio-mmio/virtio-pci in qemu. However, virtio_uml
doesn't implement the devices in the hypervisor, where most qemu devices
are implemented, but uses vhost-user to run the device implementation in
a separate userspace. [1]
Now we're talking about vhost-user to talk to the device, and qemu
supports this as well, in fact the vhost-user spec is part of qemu:
https://git.qemu.org/?p=qemu.git;a=blob;f=docs/system/devices/vhost-user.rst;h=86128114fa3788a73679f0af38e141021087c828;hb=1d60bb4b14601e38ed17384277aa4c30c57925d3
https://www.qemu.org/docs/master/interop/vhost-user.html
The docs on how to use it are here:
https://www.qemu.org/docs/master/system/devices/vhost-user.html
So once you have a device implementation (regardless of whether it's for
use with any of the virtio-i2c, arch/um/drivers/virt-pci.c, virtio-gpio,
virtio-net, ... drivers) you can actually connect it to virtual machines
running as UML or in qemu.
(Actually, that's not strictly true today since it's
arch/um/drivers/virt-pci.c and I didn't get a proper device ID assigned
etc since it was for experimentation, I guess if we make this more
commonly used then we should move it to drivers/pci/controller/virtio-
pci.c and actually specify it in the OASIS virtio spec., at the very
least it'd have to be possible to compile this and lib/logic_iomem.c on
x86, but that's possible. Anyway I think PCI(e) is probably low on your
list of things ...)
> - Also, some paths in this driver needs a modification to be tested
> under roadtest. It uses wait_event_timeout() with a fixed value, but
> we cannot guarantee that this constraint is met in the test
> environment since it depends on things like CPU load on the host.
>
> (Also, we use UML's "time travel" feature which essentially
> fast-forwards through idle time, so the constraint can never be met
> in practice.)
Wohoo! This makes me very happy, finally somebody else who uses it :-)
[1] As an aside, you might be interested in usfstl (which you can find
at https://github.com/linux-test-project/usfstl) which is one way you
could implement the device side - though the focus here is on making a
device implementation easy while under "time-travel" mode.
If you ever want to use time-travel with multiple machines or actually
with virtio devices, it also contains the necessary controller program
to glue the entire simulation together. We use this very successfully to
test the (real but compiled for x86) wifi firmware for iwlwifi together
with the real driver actually seeing a PCIe device in UML, under time-
travel :)
johannes
On Tue, Mar 15, 2022 at 12:11:50AM +0100, Brendan Higgins wrote:
> On Fri, Mar 11, 2022 at 11:24 AM Vincent Whitchurch
> <[email protected]> wrote:
> > +class TestOPT3001(UMLTestCase):
>
> I am partial to starting with UML since there are a lot of nice easy
> things about starting there; however, I imagine people will eventually
> want to use this on other architectures (speaking from experience).
> How difficult do you think it would be to extend this to support
> manipulating fake devices in say QEMU?
It should be possible, but upstream QEMU doesn't have everything that we
need so some work is needed there. Also, of course work is need to
provide user space for running the tests and communicating between the
virtual machine and the backend:
- We need user space, so build scripts would need to be provided to
cross-compile busybox and Python (and whatever libraries it needs) for
the target architecture.
- We also use UML's hostfs feature to make things transparent to the
user and to avoid having to set up things like networking for
communication between the host and the backend. I think QEMU's 9pfs
support can be used as a rootfs too but it's not something I've
personally tested.
- We use virtio-i2c and virtio-gpio and use virtio-uml which uses the
vhost-user API to communicate from UML to the backend. The latest
version of QEMU has support for vhost-user-i2c, but vhost-user-gpio
doesn't seem to have been merged yet, so work is needed on the QEMU
side. This will also be true for other buses in the future, if they
are implemented with new virtio devices.
- For MMIO, UML has virtio-mmio which allows implementing any PCIe
device (and by extension any platform device) outside of UML, but last
I checked, upstream QEMU did not have something similar.
> I also have some colleagues inside of Google that worked on some
> projects to simulate simple devices on an FPGA to test software and
> adjacent devices in a conceptually similar way; one of these teams
> built a Domain Specific Language kind of like roadtest to implement
> the tests and the environment for the tests. The main reason I mention
> this here is I am thinking about maybe one day having an API you can
> implement so you can run your roadtests on UML, QEMU, or on any
> emulator or hardware testbed that implements the appropriate API.
>
> I'll try to dig up some people who might be interested and add them here.
>
> > + dts = DtFragment(
> > + src="""
> > +&i2c {
> > + light-sensor@$addr$ {
> > + compatible = "ti,opt3001";
> > + reg = <0x$addr$>;
> > + };
> > +};
> > + """,
> > + variables={
> > + "addr": DtVar.I2C_ADDR,
> > + },
> > + )
> > +
> > + @classmethod
> > + def setUpClass(cls) -> None:
> > + insmod("opt3001")
> > +
> > + @classmethod
> > + def tearDownClass(cls) -> None:
> > + rmmod("opt3001")
> > +
> > + def setUp(self) -> None:
> > + self.driver = I2CDriver("opt3001")
> > + self.hw = Hardware("i2c")
> > + self.hw.load_model(OPT3001)
> > +
> > + def tearDown(self) -> None:
> > + self.hw.close()
> > +
> > + def test_illuminance(self) -> None:
> > + data = [
> > + # Some values from datasheet, and 0
> > + (0b_0000_0000_0000_0000, 0),
> > + (0b_0000_0000_0000_0001, 0.01),
> > + (0b_0011_0100_0101_0110, 88.80),
> > + (0b_0111_1000_1001_1010, 2818.56),
> > + ]
> > + with self.driver.bind(self.dts["addr"]) as dev:
> > + luxfile = dev.path / "iio:device0/in_illuminance_input"
> > +
> > + for regval, lux in data:
> > + self.hw.reg_write(REG_RESULT, regval)
> > + self.assertEqual(read_float(luxfile), lux)
>
> I love the framework; this looks very easy to use.
>
> One nit about this test; it seems like you cover just one test case
> here - the happy path. Can you cover some other one? Particularly some
> error paths?
>
> Sorry, I am not trying to be cheeky here; it looks like this driver
> actually should probably be fully (or very close to fully) testable
> via roadtest as I understand it. It only looks like there are a
> handful of cases to cover for the driver: the device is busy, the
> device returned something invalid, the user requested something
> invalid, and several SMBus read/write failures - it really only looks
> like there are a handful of paths and I think they are all accessible
> via the I2C interface (except for maybe the user requesting something
> invalid).
Yes, there are more things that could be tested in this driver.
However, as the commit message says, I only indented this particular
test to serve as a regression test for the specific bug fix, which would
need an environment where the chip detects 0 lux to be able to test on
real hardware. There are a few reasons for this:
- Unlike the other drivers being tested in this series, I don't have
access to boards with this chip so my interest in this particular
piece of hardware is limited.
- I actually started writing more tests for this driver earlier on
(specifically, testing the configuration which uses interrupts), but
I quickly discovered that this driver has race conditions which
result in unbalanced mutex locking (in brief: the ok_to_ignore_lock
stuff is broken). This shows the value of the test framework, but I
also didn't want to write non-trivial fixes for drivers where I
didn't have real hardware to test.
- Also, some paths in this driver needs a modification to be tested
under roadtest. It uses wait_event_timeout() with a fixed value, but
we cannot guarantee that this constraint is met in the test
environment since it depends on things like CPU load on the host.
(Also, we use UML's "time travel" feature which essentially
fast-forwards through idle time, so the constraint can never be met
in practice.)
So the timeout parameter would have to be made adjustable via say a
module parameter, to be able to make it infinite (to test the normal
case) and not (to be able to test timeout handling). I think this
could be done fairly cleanly with a one- or two-liner patch to the
driver and by hiding the details in a header file behind a
roadtest-specific config option, but I wanted to avoid having to
patch the kernel proper for the initial version of the framework.
For vcnl4000, I have actually inherited some out-of-tree patches which
are in need of mainlining so the tests are a bit more complete since I'm
hoping to send some patches to that driver soon. The period mode busy
handling is not tested there either though, I can try to add that.
As for I2C API failures, I have not added tests for them in any of the
drivers. There's not much the test cases could assert, other than
perhaps error propagation, so it's unclear if there is enough value
compared to the effort required to implement test cases to make sure
that every I2C transaction's failure path is tested.
But I think that we do want to at least make sure the error paths are
executed, to check that drivers don't crash or deadlock due to faulty
cleanups and the like. A way to solve this could be to implement fault
injection support in the I2C framework. The fail-nth feature could be
used to systemically trigger each and every I2C transaction failure and
check that the driver doesn't blow up, while using the roadtest as a
means to hit the various code paths in the driver during each of the
iterations of fail-nth. Fault injection support would also be helpful
when testing on real hardware.
On Fri, 11 Mar 2022 17:24:43 +0100
Vincent Whitchurch <[email protected]> wrote:
> Add roadtests for the vcnl4000 driver, testing several of the driver's
> features including buffer and event handling. Since it's the first IIO
> roadtest testing the non-sysfs parts, some support code for using the
> IIO ABI is included.
>
> The different variants supported by the driver are in separate tests and
> models since no two variants have fully identical register interfaces.
> This duplicates some of the test code, but it:
>
> - Avoids the tests duplicating the same multi-variant logic as the
> driver, reducing the risk for both the test and the driver being
> wrong.
>
> - Allows each variant's test and model to be individually understood
> and modified looking at only one specific datasheet, making it easier
> to extend tests and implement new features in the driver.
>
> During development of these tests, two oddities were noticed in the
> driver's handling of VCNL4040, but the tests simply assume that the
> current driver knows what it's doing (although we may want to fix the
> first point later):
>
> - The driver reads an invalid/undefined register on the VCNL4040 when
> attempting to distinguish between that one and VCNL4200.
>
> - The driver uses a lux/step unit which differs from the datasheet (but
> which is specified in an application note).
>
> Signed-off-by: Vincent Whitchurch <[email protected]>
Hi Vincent,
Very interesting bit of work. My current approach for similar testing
is to write a qemu model for the hardware, but that currently
requires carefully crafted tests. Most of the time I'm only doing
that to verify refactoring of existing drivers.
One thing that makes me nervous here is the python element though
as I've not written significant python in about 20 years.
That is going to be a burden for kernel developers and maintainers...
Nothing quite like badly written tests to make for a mess in the long run
and I suspect my python for example would be very very badly written :)
Cut and paste will of course get us a long way...
I dream of a world where every driver is testable by people with out hardware
but I fear it may be a while yet. Hopefully this will get us a little
closer!
I more or less follow what is going on here (good docs btw in the earlier
patch definitely helped).
So far I'm thoroughly in favour of road test subject to actually being
able to review the tests or getting sufficient support to do so.
It's a 'how to scale it' question really...
Jonathan
> ---
> .../roadtest/roadtest/tests/iio/iio.py | 112 +++++++
> .../roadtest/roadtest/tests/iio/light/config | 1 +
> .../roadtest/tests/iio/light/test_vcnl4000.py | 132 ++++++++
> .../roadtest/tests/iio/light/test_vcnl4010.py | 282 ++++++++++++++++++
> .../roadtest/tests/iio/light/test_vcnl4040.py | 104 +++++++
> .../roadtest/tests/iio/light/test_vcnl4200.py | 96 ++++++
> 6 files changed, 727 insertions(+)
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/iio.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py
>
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/iio.py b/tools/testing/roadtest/roadtest/tests/iio/iio.py
> new file mode 100644
> index 000000000000..ea57b28ea9d3
> --- /dev/null
> +++ b/tools/testing/roadtest/roadtest/tests/iio/iio.py
> @@ -0,0 +1,112 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +# Copyright Axis Communications AB
> +
> +import contextlib
> +import enum
> +import fcntl
> +import struct
> +from dataclasses import dataclass, field
> +from typing import Any
> +
> +IIO_GET_EVENT_FD_IOCTL = 0x80046990
> +IIO_BUFFER_GET_FD_IOCTL = 0xC0046991
> +
> +
> +class IIOChanType(enum.IntEnum):
> + IIO_VOLTAGE = 0
> + IIO_CURRENT = 1
> + IIO_POWER = 2
> + IIO_ACCEL = 3
> + IIO_ANGL_VEL = 4
> + IIO_MAGN = 5
> + IIO_LIGHT = 6
> + IIO_INTENSITY = 7
> + IIO_PROXIMITY = 8
> + IIO_TEMP = 9
> + IIO_INCLI = 10
> + IIO_ROT = 11
> + IIO_ANGL = 12
> + IIO_TIMESTAMP = 13
> + IIO_CAPACITANCE = 14
> + IIO_ALTVOLTAGE = 15
> + IIO_CCT = 16
> + IIO_PRESSURE = 17
> + IIO_HUMIDITYRELATIVE = 18
> + IIO_ACTIVITY = 19
> + IIO_STEPS = 20
> + IIO_ENERGY = 21
> + IIO_DISTANCE = 22
> + IIO_VELOCITY = 23
> + IIO_CONCENTRATION = 24
> + IIO_RESISTANCE = 25
> + IIO_PH = 26
> + IIO_UVINDEX = 27
> + IIO_ELECTRICALCONDUCTIVITY = 28
> + IIO_COUNT = 29
> + IIO_INDEX = 30
> + IIO_GRAVITY = 31
> + IIO_POSITIONRELATIVE = 32
> + IIO_PHASE = 33
> + IIO_MASSCONCENTRATION = 34
> +
> +
> +@dataclass
> +class IIOEvent:
> + id: int
> + timestamp: int
> + type: IIOChanType = field(init=False)
> +
> + def __post_init__(self) -> None:
> + self.type = IIOChanType((self.id >> 32) & 0xFF)
> +
> +
> +class IIOEventMonitor(contextlib.AbstractContextManager):
> + def __init__(self, devname: str) -> None:
> + self.devname = devname
> +
> + def __enter__(self) -> "IIOEventMonitor":
> + self.file = open(self.devname, "rb")
> +
> + s = struct.Struct("L")
> + buf = bytearray(s.size)
> + fcntl.ioctl(self.file.fileno(), IIO_GET_EVENT_FD_IOCTL, buf)
> + eventfd = s.unpack(buf)[0]
> + self.eventf = open(eventfd, "rb")
> +
> + return self
> +
> + def read(self) -> IIOEvent:
> + s = struct.Struct("Qq")
> + buf = self.eventf.read(s.size)
> + return IIOEvent(*s.unpack(buf))
> +
> + def __exit__(self, *_: Any) -> None:
> + self.eventf.close()
> + self.file.close()
> +
> +
> +class IIOBuffer(contextlib.AbstractContextManager):
> + def __init__(self, devname: str, bufidx: int) -> None:
> + self.devname = devname
> + self.bufidx = bufidx
> +
> + def __enter__(self) -> "IIOBuffer":
> + self.file = open(self.devname, "rb")
> +
> + s = struct.Struct("L")
> + buf = bytearray(s.size)
> + s.pack_into(buf, 0, self.bufidx)
> + fcntl.ioctl(self.file.fileno(), IIO_BUFFER_GET_FD_IOCTL, buf)
> + eventfd = s.unpack(buf)[0]
> + self.eventf = open(eventfd, "rb")
> +
> + return self
> +
> + def read(self, spec: str) -> tuple:
> + s = struct.Struct(spec)
> + buf = self.eventf.read(s.size)
> + return s.unpack(buf)
> +
> + def __exit__(self, *_: Any) -> None:
> + self.eventf.close()
> + self.file.close()
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/config b/tools/testing/roadtest/roadtest/tests/iio/light/config
> index b9753f2d0728..3bd4125cbb6b 100644
> --- a/tools/testing/roadtest/roadtest/tests/iio/light/config
> +++ b/tools/testing/roadtest/roadtest/tests/iio/light/config
> @@ -1 +1,2 @@
> CONFIG_OPT3001=m
> +CONFIG_VCNL4000=m
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py
> new file mode 100644
> index 000000000000..16a5bed18b7e
> --- /dev/null
> +++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py
> @@ -0,0 +1,132 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +# Copyright Axis Communications AB
> +
> +import errno
> +import logging
> +from typing import Any, Final
> +
> +from roadtest.backend.i2c import SMBusModel
> +from roadtest.core.devicetree import DtFragment, DtVar
> +from roadtest.core.hardware import Hardware
> +from roadtest.core.modules import insmod, rmmod
> +from roadtest.core.suite import UMLTestCase
> +from roadtest.core.sysfs import I2CDriver, read_float, read_int, read_str
> +
> +logger = logging.getLogger(__name__)
> +
> +REG_COMMAND: Final = 0x80
> +REG_PRODUCT_ID_REVISION: Final = 0x81
> +REG_IR_LED_CURRENT: Final = 0x83
> +REG_ALS_PARAM: Final = 0x84
> +REG_ALS_RESULT_HIGH: Final = 0x85
> +REG_ALS_RESULT_LOW: Final = 0x86
> +REG_PROX_RESULT_HIGH: Final = 0x87
> +REG_PROX_RESULT_LOW: Final = 0x88
> +REG_PROX_SIGNAL_FREQ: Final = 0x89
> +
> +REG_COMMAND_ALS_DATA_RDY: Final = 1 << 6
> +REG_COMMAND_PROX_DATA_RDY: Final = 1 << 5
> +
> +
> +class VCNL4000(SMBusModel):
> + def __init__(self, **kwargs: Any) -> None:
> + super().__init__(regbytes=1, **kwargs)
> + self.regs = {
> + REG_COMMAND: 0b_1000_0000,
> + REG_PRODUCT_ID_REVISION: 0x11,
> + # Register "without function in current version"
> + 0x82: 0x00,
> + REG_IR_LED_CURRENT: 0x00,
> + REG_ALS_PARAM: 0x00,
> + REG_ALS_RESULT_HIGH: 0x00,
> + REG_ALS_RESULT_LOW: 0x00,
> + REG_PROX_RESULT_HIGH: 0x00,
> + REG_PROX_RESULT_LOW: 0x00,
> + REG_PROX_RESULT_LOW: 0x00,
> + }
> +
> + def reg_read(self, addr: int) -> int:
> + val = self.regs[addr]
> +
> + if addr in (REG_ALS_RESULT_HIGH, REG_ALS_RESULT_LOW):
> + self.regs[REG_COMMAND] &= ~REG_COMMAND_ALS_DATA_RDY
> + if addr in (REG_PROX_RESULT_HIGH, REG_PROX_RESULT_LOW):
> + self.regs[REG_COMMAND] &= ~REG_COMMAND_PROX_DATA_RDY
> +
> + return val
> +
> + def reg_write(self, addr: int, val: int) -> None:
> + assert addr in self.regs
> +
> + if addr == REG_COMMAND:
> + rw = 0b_0001_1000
> + val = (self.regs[addr] & ~rw) | (val & rw)
> +
> + self.regs[addr] = val
> +
> + def inject(self, addr: int, val: int, mask: int = ~0) -> None:
> + old = self.regs[addr] & ~mask
> + new = old | (val & mask)
> + self.regs[addr] = new
> +
> +
> +class TestVCNL4000(UMLTestCase):
> + dts = DtFragment(
> + src="""
> +&i2c {
> + light-sensor@$addr$ {
> + compatible = "vishay,vcnl4000";
> + reg = <0x$addr$>;
> + };
> +};
> + """,
> + variables={
> + "addr": DtVar.I2C_ADDR,
> + },
> + )
> +
> + @classmethod
> + def setUpClass(cls) -> None:
> + insmod("vcnl4000")
> +
> + @classmethod
> + def tearDownClass(cls) -> None:
> + rmmod("vcnl4000")
> +
> + def setUp(self) -> None:
> + self.driver = I2CDriver("vcnl4000")
> + self.hw = Hardware("i2c")
> + self.hw.load_model(VCNL4000)
> +
> + def tearDown(self) -> None:
> + self.hw.close()
> +
> + def test_lux(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + scale = read_float(dev.path / "iio:device0/in_illuminance_scale")
> + self.assertEqual(scale, 0.25)
> +
> + data = [
> + (0x00, 0x00),
> + (0x12, 0x34),
> + (0xFF, 0xFF),
> + ]
> + luxfile = dev.path / "iio:device0/in_illuminance_raw"
> + for high, low in data:
> + self.hw.inject(REG_ALS_RESULT_HIGH, high)
> + self.hw.inject(REG_ALS_RESULT_LOW, low)
> + self.hw.inject(
> + REG_COMMAND,
> + val=REG_COMMAND_ALS_DATA_RDY,
> + mask=REG_COMMAND_ALS_DATA_RDY,
> + )
> +
> + self.assertEqual(read_int(luxfile), high << 8 | low)
> +
> + def test_lux_timeout(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + # self.hw.set_never_ready(True)
> + with self.assertRaises(OSError) as cm:
> + luxfile = dev.path / "iio:device0/in_illuminance_raw"
> + read_str(luxfile)
> + self.assertEqual(cm.exception.errno, errno.EIO)
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py
> new file mode 100644
> index 000000000000..929db970405f
> --- /dev/null
> +++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py
> @@ -0,0 +1,282 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +# Copyright Axis Communications AB
> +
> +import errno
> +import logging
> +from pathlib import Path
> +from typing import Any, Final, Optional
> +
> +from roadtest.backend.i2c import SMBusModel
> +from roadtest.core.devicetree import DtFragment, DtVar
> +from roadtest.core.hardware import Hardware
> +from roadtest.core.modules import insmod, rmmod
> +from roadtest.core.suite import UMLTestCase
> +from roadtest.core.sysfs import (
> + I2CDriver,
> + read_float,
> + read_int,
> + read_str,
> + write_int,
> + write_str,
> +)
> +from roadtest.tests.iio import iio
> +
> +logger = logging.getLogger(__name__)
> +
> +REG_COMMAND: Final = 0x80
> +REG_PRODUCT_ID_REVISION: Final = 0x81
> +REG_PROXIMITY_RATE: Final = 0x82
> +REG_IR_LED_CURRENT: Final = 0x83
> +REG_ALS_PARAM: Final = 0x84
> +REG_ALS_RESULT_HIGH: Final = 0x85
> +REG_ALS_RESULT_LOW: Final = 0x86
> +REG_PROX_RESULT_HIGH: Final = 0x87
> +REG_PROX_RESULT_LOW: Final = 0x88
> +REG_INTERRUPT_CONTROL: Final = 0x89
> +REG_LOW_THRESHOLD_HIGH: Final = 0x8A
> +REG_LOW_THRESHOLD_LOW: Final = 0x8B
> +REG_HIGH_THRESHOLD_HIGH: Final = 0x8C
> +REG_HIGH_THRESHOLD_LOW: Final = 0x8D
> +REG_INTERRUPT_STATUS: Final = 0x8E
> +
> +REG_COMMAND_ALS_DATA_RDY: Final = 1 << 6
> +REG_COMMAND_PROX_DATA_RDY: Final = 1 << 5
> +
> +
> +class VCNL4010(SMBusModel):
> + def __init__(self, int: Optional[int] = None, **kwargs: Any) -> None:
> + super().__init__(regbytes=1, **kwargs)
> + self.int = int
> + self._set_int(False)
> + self.regs = {
> + REG_COMMAND: 0b_1000_0000,
> + REG_PRODUCT_ID_REVISION: 0x21,
> + REG_PROXIMITY_RATE: 0x00,
> + REG_IR_LED_CURRENT: 0x00,
> + REG_ALS_PARAM: 0x00,
> + REG_ALS_RESULT_HIGH: 0x00,
> + REG_ALS_RESULT_LOW: 0x00,
> + REG_PROX_RESULT_HIGH: 0x00,
> + REG_PROX_RESULT_LOW: 0x00,
> + REG_INTERRUPT_CONTROL: 0x00,
> + REG_LOW_THRESHOLD_HIGH: 0x00,
> + REG_LOW_THRESHOLD_LOW: 0x00,
> + REG_HIGH_THRESHOLD_HIGH: 0x00,
> + REG_HIGH_THRESHOLD_LOW: 0x00,
> + REG_INTERRUPT_STATUS: 0x00,
> + }
> +
> + def _set_int(self, active: int) -> None:
> + # Active-low
> + self.backend.gpio.set(self.int, not active)
> +
> + def _update_irq(self) -> None:
> + selftimed_en = self.regs[REG_COMMAND] & (1 << 0)
> + prox_en = self.regs[REG_COMMAND] & (1 << 1)
> + prox_data_rdy = self.regs[REG_COMMAND] & REG_COMMAND_PROX_DATA_RDY
> + int_prox_ready_en = self.regs[REG_INTERRUPT_CONTROL] & (1 << 3)
> +
> + logger.debug(
> + f"{selftimed_en=:x} {prox_en=:x} {prox_data_rdy=:x} {int_prox_ready_en=:x}"
> + )
> +
> + if selftimed_en and prox_en and prox_data_rdy and int_prox_ready_en:
> + self.regs[REG_INTERRUPT_STATUS] |= 1 << 3
> +
> + low_threshold = (
> + self.regs[REG_LOW_THRESHOLD_HIGH] << 8 | self.regs[REG_LOW_THRESHOLD_LOW]
> + )
> + high_threshold = (
> + self.regs[REG_HIGH_THRESHOLD_HIGH] << 8 | self.regs[REG_HIGH_THRESHOLD_LOW]
> + )
> + proximity = (
> + self.regs[REG_PROX_RESULT_HIGH] << 8 | self.regs[REG_PROX_RESULT_LOW]
> + )
> + int_thres_en = self.regs[REG_INTERRUPT_CONTROL] & (1 << 1)
> +
> + logger.debug(
> + f"{low_threshold=:x} {high_threshold=:x} {proximity=:x} {int_thres_en=:x}"
> + )
> +
> + if int_thres_en:
> + if proximity < low_threshold:
> + logger.debug("LOW")
> + self.regs[REG_INTERRUPT_STATUS] |= 1 << 1
> + if proximity > high_threshold:
> + logger.debug("HIGH")
> + self.regs[REG_INTERRUPT_STATUS] |= 1 << 0
> +
> + self._set_int(self.regs[REG_INTERRUPT_STATUS])
> +
> + def reg_read(self, addr: int) -> int:
> + val = self.regs[addr]
> +
> + if addr in (REG_ALS_RESULT_HIGH, REG_ALS_RESULT_LOW):
> + self.regs[REG_COMMAND] &= ~REG_COMMAND_ALS_DATA_RDY
> + if addr in (REG_PROX_RESULT_HIGH, REG_PROX_RESULT_LOW):
> + self.regs[REG_COMMAND] &= ~REG_COMMAND_PROX_DATA_RDY
> +
> + return val
> +
> + def reg_write(self, addr: int, val: int) -> None:
> + assert addr in self.regs
> +
> + if addr == REG_COMMAND:
> + rw = 0b_0001_1111
> + val = (self.regs[addr] & ~rw) | (val & rw)
> + elif addr == REG_INTERRUPT_STATUS:
> + val = self.regs[addr] & ~(val & 0xF)
> +
> + self.regs[addr] = val
> + self._update_irq()
> +
> + def inject(self, addr: int, val: int, mask: int = ~0) -> None:
> + old = self.regs[addr] & ~mask
> + new = old | (val & mask)
> + self.regs[addr] = new
> + self._update_irq()
> +
> + def set_bit(self, addr: int, val: int) -> None:
> + self.inject(addr, val, val)
> +
> +
> +class TestVCNL4010(UMLTestCase):
> + dts = DtFragment(
> + src="""
> +#include <dt-bindings/interrupt-controller/irq.h>
> +
> +&i2c {
> + light-sensor@$addr$ {
> + compatible = "vishay,vcnl4020";
> + reg = <0x$addr$>;
> + interrupt-parent = <&gpio>;
> + interrupts = <$gpio$ IRQ_TYPE_EDGE_FALLING>;
> + };
> +};
> + """,
> + variables={
> + "addr": DtVar.I2C_ADDR,
> + "gpio": DtVar.GPIO_PIN,
> + },
> + )
> +
> + @classmethod
> + def setUpClass(cls) -> None:
> + insmod("vcnl4000")
> +
> + @classmethod
> + def tearDownClass(cls) -> None:
> + rmmod("vcnl4000")
> +
> + def setUp(self) -> None:
> + self.driver = I2CDriver("vcnl4000")
> + self.hw = Hardware("i2c")
> + self.hw.load_model(VCNL4010, int=self.dts["gpio"])
> +
> + def tearDown(self) -> None:
> + self.hw.close()
> +
> + def test_lux(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> +
> + scale = read_float(dev.path / "iio:device0/in_illuminance_scale")
> + self.assertEqual(scale, 0.25)
> +
> + data = [
> + (0x00, 0x00),
> + (0x12, 0x34),
> + (0xFF, 0xFF),
> + ]
> + luxfile = dev.path / "iio:device0/in_illuminance_raw"
> + for high, low in data:
> + self.hw.inject(REG_ALS_RESULT_HIGH, high)
> + self.hw.inject(REG_ALS_RESULT_LOW, low)
> + self.hw.set_bit(REG_COMMAND, REG_COMMAND_ALS_DATA_RDY)
> +
> + self.assertEqual(read_int(luxfile), high << 8 | low)
> +
> + def test_lux_timeout(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + with self.assertRaises(OSError) as cm:
> + luxfile = dev.path / "iio:device0/in_illuminance_raw"
> + read_str(luxfile)
> + self.assertEqual(cm.exception.errno, errno.EIO)
> +
> + def test_proximity_thresh_rising(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + high_thresh = (
> + dev.path / "iio:device0/events/in_proximity_thresh_rising_value"
> + )
> + write_int(high_thresh, 0x1234)
> +
> + mock = self.hw.update_mock()
> + mock.assert_last_reg_write(self, REG_HIGH_THRESHOLD_HIGH, 0x12)
> + mock.assert_last_reg_write(self, REG_HIGH_THRESHOLD_LOW, 0x34)
> + mock.reset_mock()
> +
> + self.assertEqual(read_int(high_thresh), 0x1234)
> +
> + with iio.IIOEventMonitor("/dev/iio:device0") as mon:
> + en = dev.path / "iio:device0/events/in_proximity_thresh_either_en"
> + write_int(en, 1)
> +
> + self.hw.inject(REG_PROX_RESULT_HIGH, 0x12)
> + self.hw.inject(REG_PROX_RESULT_LOW, 0x35)
> + self.hw.set_bit(REG_COMMAND, REG_COMMAND_PROX_DATA_RDY)
> + self.hw.kick()
> +
> + self.assertEqual(read_int(en), 1)
> +
> + event = mon.read()
> + self.assertEqual(event.type, iio.IIOChanType.IIO_PROXIMITY)
> +
> + def test_proximity_thresh_falling(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + high_thresh = (
> + dev.path / "iio:device0/events/in_proximity_thresh_falling_value"
> + )
> + write_int(high_thresh, 0x0ABC)
> +
> + mock = self.hw.update_mock()
> + mock.assert_last_reg_write(self, REG_LOW_THRESHOLD_HIGH, 0x0A)
> + mock.assert_last_reg_write(self, REG_LOW_THRESHOLD_LOW, 0xBC)
> + mock.reset_mock()
> +
> + self.assertEqual(read_int(high_thresh), 0x0ABC)
> +
> + with iio.IIOEventMonitor("/dev/iio:device0") as mon:
> + write_int(
> + dev.path / "iio:device0/events/in_proximity_thresh_either_en", 1
> + )
> +
> + event = mon.read()
> + self.assertEqual(event.type, iio.IIOChanType.IIO_PROXIMITY)
> +
> + def test_proximity_triggered(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + data = [
> + (0x00, 0x00, 0),
> + (0x00, 0x01, 1),
> + (0xF0, 0x02, 0xF002),
> + (0xFF, 0xFF, 0xFFFF),
> + ]
> +
> + trigger = read_str(Path("/sys/bus/iio/devices/trigger0/name"))
> +
> + write_int(dev.path / "iio:device0/buffer0/in_proximity_en", 1)
> + write_str(dev.path / "iio:device0/trigger/current_trigger", trigger)
> +
> + with iio.IIOBuffer("/dev/iio:device0", bufidx=0) as buffer:
> + write_int(dev.path / "iio:device0/buffer0/length", 128)
> + write_int(dev.path / "iio:device0/buffer0/enable", 1)
> +
> + for low, high, expected in data:
> + self.hw.inject(REG_PROX_RESULT_HIGH, low)
> + self.hw.inject(REG_PROX_RESULT_LOW, high)
> + self.hw.set_bit(REG_COMMAND, REG_COMMAND_PROX_DATA_RDY)
> + self.hw.kick()
> +
> + scanline = buffer.read("H")
> +
> + val = scanline[0]
> + self.assertEqual(val, expected)
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py
> new file mode 100644
> index 000000000000..f2aa2cb9f3d5
> --- /dev/null
> +++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py
> @@ -0,0 +1,104 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +# Copyright Axis Communications AB
> +
> +import logging
> +from typing import Any
> +
> +from roadtest.backend.i2c import SMBusModel
> +from roadtest.core.devicetree import DtFragment, DtVar
> +from roadtest.core.hardware import Hardware
> +from roadtest.core.modules import insmod, rmmod
> +from roadtest.core.suite import UMLTestCase
> +from roadtest.core.sysfs import I2CDriver, read_float, read_int
> +
> +logger = logging.getLogger(__name__)
> +
> +
> +class VCNL4040(SMBusModel):
> + def __init__(self, **kwargs: Any) -> None:
> + super().__init__(regbytes=2, byteorder="little", **kwargs)
> + self.regs = {
> + 0x00: 0x0101,
> + 0x01: 0x0000,
> + 0x02: 0x0000,
> + 0x03: 0x0001,
> + 0x04: 0x0000,
> + 0x05: 0x0000,
> + 0x06: 0x0000,
> + 0x07: 0x0000,
> + 0x08: 0x0000,
> + 0x09: 0x0000,
> + 0x0A: 0x0000,
> + 0x0A: 0x0000,
> + 0x0B: 0x0000,
> + 0x0C: 0x0186,
> + # The driver reads this register which is undefined for
> + # VCNL4040. Perhaps the driver should be fixed instead
> + # of having this here?
> + 0x0E: 0x0000,
> + }
> +
> + def reg_read(self, addr: int) -> int:
> + return self.regs[addr]
> +
> + def reg_write(self, addr: int, val: int) -> None:
> + assert addr in self.regs
> + self.regs[addr] = val
> +
> +
> +class TestVCNL4040(UMLTestCase):
> + dts = DtFragment(
> + src="""
> +&i2c {
> + light-sensor@$addr$ {
> + compatible = "vishay,vcnl4040";
> + reg = <0x$addr$>;
> + };
> +};
> + """,
> + variables={
> + "addr": DtVar.I2C_ADDR,
> + },
> + )
> +
> + @classmethod
> + def setUpClass(cls) -> None:
> + insmod("vcnl4000")
> +
> + @classmethod
> + def tearDownClass(cls) -> None:
> + rmmod("vcnl4000")
> +
> + def setUp(self) -> None:
> + self.driver = I2CDriver("vcnl4000")
> + self.hw = Hardware("i2c")
> + self.hw.load_model(VCNL4040)
> +
> + def tearDown(self) -> None:
> + self.hw.close()
> +
> + def test_illuminance_scale(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + scalefile = dev.path / "iio:device0/in_illuminance_scale"
> + # The datasheet says 0.10 lux/step, but the driver follows
> + # the application note "Designing the VCNL4040 Into an
> + # Application" which claims a different value.
> + self.assertEqual(read_float(scalefile), 0.12)
> +
> + def test_illuminance(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + luxfile = dev.path / "iio:device0/in_illuminance_raw"
> +
> + data = [0x0000, 0x1234, 0xFFFF]
> + for regval in data:
> + self.hw.reg_write(0x09, regval)
> + self.assertEqual(read_int(luxfile), regval)
> +
> + def test_proximity(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + rawfile = dev.path / "iio:device0/in_proximity_raw"
> +
> + data = [0x0000, 0x1234, 0xFFFF]
> + for regval in data:
> + self.hw.reg_write(0x08, regval)
> + self.assertEqual(read_int(rawfile), regval)
> diff --git a/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py
> new file mode 100644
> index 000000000000..d1cf819e563e
> --- /dev/null
> +++ b/tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py
> @@ -0,0 +1,96 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +# Copyright Axis Communications AB
> +
> +import logging
> +from typing import Any
> +
> +from roadtest.backend.i2c import SMBusModel
> +from roadtest.core.devicetree import DtFragment, DtVar
> +from roadtest.core.hardware import Hardware
> +from roadtest.core.modules import insmod, rmmod
> +from roadtest.core.suite import UMLTestCase
> +from roadtest.core.sysfs import I2CDriver, read_float, read_int
> +
> +logger = logging.getLogger(__name__)
> +
> +
> +class VCNL4200(SMBusModel):
> + def __init__(self, **kwargs: Any) -> None:
> + super().__init__(regbytes=2, byteorder="little", **kwargs)
> + self.regs = {
> + 0x00: 0x0101,
> + 0x01: 0x0000,
> + 0x02: 0x0000,
> + 0x03: 0x0001,
> + 0x04: 0x0000,
> + 0x05: 0x0000,
> + 0x06: 0x0000,
> + 0x07: 0x0000,
> + 0x08: 0x0000,
> + 0x09: 0x0000,
> + 0x0A: 0x0000,
> + 0x0D: 0x0000,
> + 0x0E: 0x1058,
> + }
> +
> + def reg_read(self, addr: int) -> int:
> + return self.regs[addr]
> +
> + def reg_write(self, addr: int, val: int) -> None:
> + assert addr in self.regs
> + self.regs[addr] = val
> +
> +
> +class TestVCNL4200(UMLTestCase):
> + dts = DtFragment(
> + src="""
> +&i2c {
> + light-sensor@$addr$ {
> + compatible = "vishay,vcnl4200";
> + reg = <0x$addr$>;
> + };
> +};
> + """,
> + variables={
> + "addr": DtVar.I2C_ADDR,
> + },
> + )
> +
> + @classmethod
> + def setUpClass(cls) -> None:
> + insmod("vcnl4000")
> +
> + @classmethod
> + def tearDownClass(cls) -> None:
> + rmmod("vcnl4000")
> +
> + def setUp(self) -> None:
> + self.driver = I2CDriver("vcnl4000")
> + self.hw = Hardware("i2c")
> + self.hw.load_model(VCNL4200)
> +
> + def tearDown(self) -> None:
> + self.hw.close()
> +
> + def test_illuminance_scale(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + scalefile = dev.path / "iio:device0/in_illuminance_scale"
> + self.assertEqual(read_float(scalefile), 0.024)
> +
> + def test_illuminance(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + luxfile = dev.path / "iio:device0/in_illuminance_raw"
> +
> + data = [0x0000, 0x1234, 0xFFFF]
> + for regval in data:
> + self.hw.reg_write(0x09, regval)
> + self.assertEqual(read_int(luxfile), regval)
> +
> + def test_proximity(self) -> None:
> + with self.driver.bind(self.dts["addr"]) as dev:
> + rawfile = dev.path / "iio:device0/in_proximity_raw"
> +
> + data = [0x0000, 0x1234, 0xFFFF]
> + for regval in data:
> + self.hw.reg_write(0x08, regval)
> + self.assertEqual(read_int(rawfile), regval)
On Fri, 2022-03-11 at 17:24 +0100, Vincent Whitchurch wrote:
> Import the libvhost-user from QEMU for use in the implementation of the
> virtio devices in the roadtest backend.
>
So hm, I wonder if this is the sensible thing to do?
Not that I mind importing qemu code, but:
1) the implementation is rather complex in some places, and has support
for a LOT of virtio/vhost-user features that are really not needed
in these cases, for performance etc. It's also close to 4k LOC.
2) the implementation doesn't support time-travel mode which might come
in handy
We have another implementation that might be simpler:
https://github.com/linux-test-project/usfstl/blob/main/src/vhost.c
but it probably has dependencies on other things in this library, but
vhost.c itself is only ~1k LOC. (But I need to update it, I'm sure we
have some unpublished bugfixes etc. in this code)
johannes
On Fri, Mar 18, 2022 at 09:09:02PM +0100, Johannes Berg wrote:
> On Fri, 2022-03-18 at 16:49 +0100, Vincent Whitchurch wrote:
> > - We use virtio-i2c and virtio-gpio and use virtio-uml which uses the
> > vhost-user API to communicate from UML to the backend. The latest
> > version of QEMU has support for vhost-user-i2c, but vhost-user-gpio
> > doesn't seem to have been merged yet, so work is needed on the QEMU
> > side. This will also be true for other buses in the future, if they
> > are implemented with new virtio devices.
> >
> > - For MMIO, UML has virtio-mmio which allows implementing any PCIe
> > device (and by extension any platform device) outside of UML, but last
> > I checked, upstream QEMU did not have something similar.
>
> I think you have this a bit fuzzy.
>
> The virtio_uml[.c] you speak of is the "bus" driver for virtio in UML.
> Obviously, qemu has support for virtio, so you don't need those bits.
>
> Now, virtio_uml is actually the virtio (bus) driver inside the kernel,
> like you'd have virtio-mmio/virtio-pci in qemu. However, virtio_uml
> doesn't implement the devices in the hypervisor, where most qemu devices
> are implemented, but uses vhost-user to run the device implementation in
> a separate userspace. [1]
>
> Now we're talking about vhost-user to talk to the device, and qemu
> supports this as well, in fact the vhost-user spec is part of qemu:
> https://git.qemu.org/?p=qemu.git;a=blob;f=docs/system/devices/vhost-user.rst;h=86128114fa3788a73679f0af38e141021087c828;hb=1d60bb4b14601e38ed17384277aa4c30c57925d3
> https://www.qemu.org/docs/master/interop/vhost-user.html
>
> The docs on how to use it are here:
> https://www.qemu.org/docs/master/system/devices/vhost-user.html
>
> So once you have a device implementation (regardless of whether it's for
> use with any of the virtio-i2c, arch/um/drivers/virt-pci.c, virtio-gpio,
> virtio-net, ... drivers) you can actually connect it to virtual machines
> running as UML or in qemu.
I'm aware of vhost-user, but AFAICS QEMU needs glue for each device type
to be able to actually hook up vhost-user implementations to the devices
it exposes to the guest via the virtio PCI device. See e.g.
hw/virtio/vhost-user-i2c-pci.c and hw/virtio/vhost-user-i2c.c in QEMU.
That is what I meant was missing for virtio-gpio, there seems to be an
in-progress patch set for that here though:
https://lore.kernel.org/all/[email protected]/
Similarly, glue for something like arch/um/drivers/virt-pci.c does not
exist in QEMU.
Or perhaps you are implying that hw/virtio/vhost-user-i2c* in QEMU are
not strictly needed?
> (Actually, that's not strictly true today since it's
> arch/um/drivers/virt-pci.c and I didn't get a proper device ID assigned
> etc since it was for experimentation, I guess if we make this more
> commonly used then we should move it to drivers/pci/controller/virtio-
> pci.c and actually specify it in the OASIS virtio spec., at the very
> least it'd have to be possible to compile this and lib/logic_iomem.c on
> x86, but that's possible. Anyway I think PCI(e) is probably low on your
> list of things ...)
PCI is not that interesting, no, but platform devices are. I did some
experiments early on with arch/um/drivers/virt-pci.c and a corresponding
backend along with a simple PCI driver which probes all devicetree nodes
under it, and I was able to use this to get some platform drivers
working.
>
> > - Also, some paths in this driver needs a modification to be tested
> > under roadtest. It uses wait_event_timeout() with a fixed value, but
> > we cannot guarantee that this constraint is met in the test
> > environment since it depends on things like CPU load on the host.
> >
> > (Also, we use UML's "time travel" feature which essentially
> > fast-forwards through idle time, so the constraint can never be met
> > in practice.)
>
> Wohoo! This makes me very happy, finally somebody else who uses it :-)
Yes, thanks for that feature, it works well to speed up tests and also
has a knack for triggering race conditions (the RTC use-after-free for
example).
Time travel however sometimes triggers some WARN_ONs from the core
timekeeping code. I haven't seen them when running the test suites, but
they show up if the system under UML is idle for several (wall time)
seconds. I haven't had a chance to investigate it further though, but I
can dig up the splats if you are interested.
On Tue, 2022-03-29 at 16:50 +0200, Johannes Berg wrote:
> > Or perhaps you are implying that hw/virtio/vhost-user-i2c* in QEMU are
> > not strictly needed?
>
> I _thought_ that was the case, but honestly, that was just from reading
> about it, not looking at the code. Thinking about it though, I don't
> need special glue in UML, just passing the device ID on the command
> line? So not sure what they need the glue for. Looking at the code, it's
> not really much though? Not sure, I guess you need somebody more
> familiar with qemu here, sorry.
>
So here
https://www.qemu.org/docs/master/system/devices/vhost-user.html#vhost-user-device
the docs say:
These are simple stub devices that ensure the VirtIO device is
visible to the guest. The code is mostly boilerplate although each
device has a chardev option which specifies the ID of the --chardev
device that connects via a socket to the vhost-user daemon.
So maybe if the ID were specified via the command line too, you could
have a generic vhost-user stub in qemu?
johannes
On Tue, 2022-03-29 at 16:43 +0200, Vincent Whitchurch wrote:
>
> I'm aware of vhost-user, but AFAICS QEMU needs glue for each device type
> to be able to actually hook up vhost-user implementations to the devices
> it exposes to the guest via the virtio PCI device. See e.g.
> hw/virtio/vhost-user-i2c-pci.c and hw/virtio/vhost-user-i2c.c in QEMU.
Oh, I wasn't aware of that.
> That is what I meant was missing for virtio-gpio, there seems to be an
> in-progress patch set for that here though:
> https://lore.kernel.org/all/[email protected]/
>
> Similarly, glue for something like arch/um/drivers/virt-pci.c does not
> exist in QEMU.
>
> Or perhaps you are implying that hw/virtio/vhost-user-i2c* in QEMU are
> not strictly needed?
I _thought_ that was the case, but honestly, that was just from reading
about it, not looking at the code. Thinking about it though, I don't
need special glue in UML, just passing the device ID on the command
line? So not sure what they need the glue for. Looking at the code, it's
not really much though? Not sure, I guess you need somebody more
familiar with qemu here, sorry.
> > Wohoo! This makes me very happy, finally somebody else who uses it :-)
>
> Yes, thanks for that feature, it works well to speed up tests and also
> has a knack for triggering race conditions (the RTC use-after-free for
> example).
>
> Time travel however sometimes triggers some WARN_ONs from the core
> timekeeping code. I haven't seen them when running the test suites, but
> they show up if the system under UML is idle for several (wall time)
> seconds. I haven't had a chance to investigate it further though, but I
> can dig up the splats if you are interested.
Oh, I haven't seen that, and I'm pretty sure I've had systems idle for
very long periods of time passing inside (think weeks) ...
So yeah, if you have some splats (ideally with corresponding kernel
configs), I'd be interested.
johannes
On Sun, Mar 20, 2022 at 06:02:53PM +0100, Jonathan Cameron wrote:
> Very interesting bit of work. My current approach for similar testing
> is to write a qemu model for the hardware, but that currently
> requires carefully crafted tests. Most of the time I'm only doing
> that to verify refactoring of existing drivers.
Thank you for taking a look!
> One thing that makes me nervous here is the python element though
> as I've not written significant python in about 20 years.
> That is going to be a burden for kernel developers and maintainers...
> Nothing quite like badly written tests to make for a mess in the long run
> and I suspect my python for example would be very very badly written :)
There's a bunch of static checkers to ensure that the code follows some
basic guidelines, and CI can check that the tests work consistently, and
also calculate metrics such as test execution time and code coverage, so
even non-idiomatic Python in the tests wouldn't be entirely broken.
And unlike driver code, if the tests for a particular driver later do
turn out to be bad (in what way?), we could just throw those particular
tests out without breaking anybody's system.
> Cut and paste will of course get us a long way...
Isn't some amount of copy/paste followed by modification to be expected
even if the framework is written in say C (just as there's already
copy/paste + modification involved when writing drivers)?
As for the core logic of individual driver tests excluding the framework
bits, I have a hard time imagining what Python syntax looks like to
someone with no knowledge of Python, so yes, I guess it's going to be
harder to review.
> I dream of a world where every driver is testable by people with out hardware
> but I fear it may be a while yet. Hopefully this will get us a little
> closer!
>
> I more or less follow what is going on here (good docs btw in the earlier
> patch definitely helped).
>
> So far I'm thoroughly in favour of road test subject to actually being
> able to review the tests or getting sufficient support to do so.
> It's a 'how to scale it' question really...
Would rewriting the framework in C and forcing tests to be written in
that language mean that maintainers would be able to review tests
without external support?
On Thu, Mar 24, 2022 at 02:00:10PM +0100, Johannes Berg wrote:
> On Fri, 2022-03-11 at 17:24 +0100, Vincent Whitchurch wrote:
> > Import the libvhost-user from QEMU for use in the implementation of the
> > virtio devices in the roadtest backend.
>
> So hm, I wonder if this is the sensible thing to do?
>
> Not that I mind importing qemu code, but:
>
> 1) the implementation is rather complex in some places, and has support
> for a LOT of virtio/vhost-user features that are really not needed
> in these cases, for performance etc. It's also close to 4k LOC.
Is this really a problem given that the code is imported as-is? The
intention is not to have to make a lot of local modifications to it in
the kernel tree. The code is stable and presumably well-tested
upstream, and upstream maintains it as a separate library (in the QEMU
source tree though) to encourage reuse.
> 2) the implementation doesn't support time-travel mode which might come
> in handy
True, but I don't see the external time-travel controller stuff being
too useful for the kinds of tests this framework is targeting.
On Wed, Apr 06, 2022 at 03:08:16PM +0200, Jonathan Cameron wrote:
> On Tue, 5 Apr 2022 15:48:05 +0200
> Vincent Whitchurch <[email protected]> wrote:
> I messed around the other day with writing tests for
> drivers/staging/iio/cdc/ad7746.c and wasn't "too bad" and was useful for
> verifying some refactoring (and identified a possible precision problem
> in some integer approximation of floating point calcs)
Good to hear!
> I'll try and find time to flesh that test set out more in the near future and
> post it so you can see how bad my python is. It amused my wife if nothing
> else :)
>
> However a future project is to see if I can use this to hook up the SPDM
> attestation stack via mctp over i2c - just because I like to live dangerously :)
>
> For IIO use more generally we need a sensible path to SPI (and also platform
> drivers).
I have SPI working now. I was able to do this without patching the
kernel by have the Python code emulate an SC18IS602 I2C-SPI bridge which
has an existing driver. There is a limitation of 200 bytes per
transaction (in the SC18IS602 driver/chip) so not all SPI drivers will
work, but many will, and the underlying backend can be changed later
without having to change the test cases. I used this to implement a
test for drivers/iio/adc/ti-adc084s021.c.
Platform devices are going to take more work. I did do some experiments
(using arch/um/drivers/virt-pci.c) a while ago but I need to see how
well it works with the rest of the framework in place.
> For my day job I'd like to mess around with doing PCI devices
> as well. The PCI DOE support for example would be nice to run against a
> test set that doesn't involve spinning up QEMU.
> DOE driver support:
> https://lore.kernel.org/all/[email protected]/
>
> Effort wise, it's similar effort to hacking equivalent in QEMU but with the
> obvious advantage of being in tree and simpler for CI systems etc to use.
>
> It would be nice to only have to use QEMU for complex system CI tests
> like the ones we are doing for CXL.
>
> >
> > > I dream of a world where every driver is testable by people with out hardware
> > > but I fear it may be a while yet. Hopefully this will get us a little
> > > closer!
> > >
> > > I more or less follow what is going on here (good docs btw in the earlier
> > > patch definitely helped).
> > >
> > > So far I'm thoroughly in favour of road test subject to actually being
> > > able to review the tests or getting sufficient support to do so.
> > > It's a 'how to scale it' question really...
> >
> > Would rewriting the framework in C and forcing tests to be written in
> > that language mean that maintainers would be able to review tests
> > without external support?
>
> I was wondering that. If we stayed in python I think we'd definitely want
> someone to be the 'roadtester/tests' maintainer (or group of maintainers)
> and their Ack to be expected for all tests we upstream. Idea being they'd
> sanity check correct use of framework and just how bad the python code
> us C developers are writing is ;)
>
> However, we'd still need a good chunk of that 'framework' use review even
> if doing this in C.
I think this is reasonable, especially for the first tests for each
subsystem where there will likely be support code and framework bits
missing.
On Fri, 11 Mar 2022 17:24:35 +0100
Vincent Whitchurch <[email protected]> wrote:
> This patchset proposes roadtest, a device-driver testing framework. Drivers
> are tested under User Mode Linux (UML) and interact with mocked/modelled
> hardware. The tests and hardware models are written in Python, the former
> using Python's built-in unittest framework.
>
> Drivers are tested via their userspace interfaces. The hardware models allow
> tests to inject values into registers and assert that drivers control the
> hardware in the right way and react as expected to stimuli.
>
> Roadtest is meant to be used for relatively simple drivers, such as the ones
> part of the IIO, regulator and RTC subsystems.
Hi All,
Just wanted to very briefly report back on my experience of using this framework.
Given I wanted a suitable job to try out it's usefulness when doing refactoring
/development, I decided to tidy up one of the remaining IIO drivers in staging
and see how things went in developing tests to hit the particular code I was
modifying. At some point I might extend this to a more comprehensive test suite
for that driver, but for now it does basic channel reading and a few other things
+ verifies some of the register state changes seen on the hardware side of things.
Whilst my python could be said to be decidedly rusty (last time I recall writing
some was for an intern project 20 years back), it was fairly easy to get something
working using the docs in this series and the fine engineering tool of cut and paste.
Road test worked very well.
Was it easier than my existing hacked up QEMU board emulation that lets me
instantiate minimal emulation pretty quickly?
Pretty similar on balance but big advantage here is I'm not having to ask people
to go fetch a tree and build QEMU just to sanity check the driver changes.
Also note I'm doing a lot of QEMU work for the day job at the moment, so it's not
really a fair comparison if the question is what would most kernel driver
developers find useful.
So for now I'll probably mix and match depending on the complexity of the device
I'm emulating, but roadtest is definitely a good addition to the toolkit.
Note this is putting aside all the advantages of having tests in tree and the
much lighter amount of infrastructure needed to run those over QEMU CI.
If anyone is curious patch set with tests and the staging graduation of
the AD7746 CDC driver.
https://lore.kernel.org/all/[email protected]/
Great work Vincent. I'm looking forward to using this more.
Thanks,
Jonathan
>
> Questions and answers:
>
> = Why do we need this?
>
> There are a large amount of these kind of drivers in the kernel. Most of the
> hardware is not available in current CI systems so most drivers can only, at
> best, be build-tested there. Even basic soundness such as a driver
> successfully probing and binding to the devices it tries to be support cannot
> be tested. Drivers cannot be easily regression-tested to ensure that bugs
> fixed once do not get reintroduced.
>
> Many drivers support multiple related hardware variants, and far from all patch
> submitters have access to all the variants which the driver that they are
> patching supports, so there is no way for them to easily verify that they
> haven't broken something basic on a variant which they do not own.
>
> Furthermore, hardware can be used in many different configurations with drivers
> supporting many different devicetree properties, so even just having access to
> all the variants would be insufficient.
>
> On top of that, some of the chips measure environmental conditions such as
> temperature, so testing extreme cases may not be simple even if one has access
> to the hardware.
>
> All this makes development, modification, maintenance, and reviewing of these
> drivers harder than it necessarily needs to be. Roadtest hopes to make some of
> these things slightly easier by providing a framework to create hardware
> models/mocks and to write testcases which exercise drivers using these models.
>
> = Do you have some specific examples of the kind of code this could be used to
> test?
>
> Here is an example of a patch which can easily be regression-tested using
> roadtest (in fact, this series includes such a regression test) but is much
> harder to do so automatically with real hardware since it requires specific
> environmental conditions:
>
> iio: light: opt3001: Fixed timeout error when 0 lux
> https://lore.kernel.org/lkml/[email protected]/
>
> Here is another example. This driver has code which correctly parses a
> documented devicetree property (amstaos,proximity-diodes) but which then fails
> to actually communicate this setting to the hardware in any way. Such code can
> be easily tested with roadtest since the framework integrates devicetree
> support and provides functions to assert that drivers writes expected registers
> with expected values:
>
> drivers/iio/light/tsl2772.c tsl2772_read_prox_diodes()
>
> (Both the above examples happen to be from the same subsystem but that should
> in no way be taken to imply that such issues are unique to that subsystem or
> that that subsystem has more of them.)
>
> = How does this relate to kselftests?
>
> Tests in kselftests also test kernel code using the userspace interfaces, but
> that's about what's common between the frameworks. kselftests has other goals
> and does not provide any kind of mechanism for hardware mocking.
>
> = How does this relate to kunit?
>
> Kunit is for unit testing of functions in kernel code, and is not meant for
> testing kernel code via userspace interfaces. It could in theory be used to
> test some of the simple drivers too, but that would require (1) a large amount
> of mocking code in various kernel frameworks, and, more importantly, (2)
> refactoring of the drivers to be tested.
>
> This can be contrasted with roadtest which works with mostly unmodified drivers
> and which mocks the hardware at the lowest level without having to change
> kernel frameworks.
>
> = How do I use it?
>
> See Documentation/dev-tools/roadtest.rst added by the documentation patch for
> more information about running and writing tests using this framework.
>
> = What's included in the patchset?
>
> The current framework allows developing tests for hardware which uses the I2C
> bus. Hardware models can also control GPIOs and use them to trigger
> interrupts.
>
> This series includes tests for some IIO, regulator and RTC drivers. The
> regulator and RTC tests depend on a few driver patches which are either in
> review or in linux-next. These are noted in the commit messages.
>
> The entire patch set, including the required dependencies, is also available in
> a git tree:
>
> https://github.com/vwax/linux/commits/roadtest/rfc-v1
>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
>
> Cc: [email protected]
> Cc: [email protected]
>
> Vincent Whitchurch (10):
> roadtest: import libvhost-user from QEMU
> roadtest: add C backend
> roadtest: add framework
> roadtest: add base config
> roadtest: add build files
> roadtest: add documentation
> iio: light: opt3001: add roadtest
> iio: light: vcnl4000: add roadtest
> regulator: tps62864: add roadtest
> rtc: pcf8563: add roadtest
>
> Documentation/dev-tools/index.rst | 1 +
> Documentation/dev-tools/roadtest.rst | 669 ++++
> tools/testing/roadtest/.gitignore | 2 +
> tools/testing/roadtest/Dockerfile | 25 +
> tools/testing/roadtest/Makefile | 84 +
> tools/testing/roadtest/init.sh | 19 +
> tools/testing/roadtest/pyproject.toml | 10 +
> tools/testing/roadtest/requirements.txt | 4 +
> tools/testing/roadtest/roadtest/__init__.py | 2 +
> .../roadtest/roadtest/backend/__init__.py | 0
> .../roadtest/roadtest/backend/backend.py | 32 +
> .../testing/roadtest/roadtest/backend/gpio.py | 111 +
> .../testing/roadtest/roadtest/backend/i2c.py | 123 +
> .../testing/roadtest/roadtest/backend/main.py | 13 +
> .../testing/roadtest/roadtest/backend/mock.py | 20 +
> .../roadtest/roadtest/backend/test_gpio.py | 98 +
> .../roadtest/roadtest/backend/test_i2c.py | 84 +
> .../testing/roadtest/roadtest/cmd/__init__.py | 0
> tools/testing/roadtest/roadtest/cmd/main.py | 146 +
> tools/testing/roadtest/roadtest/cmd/remote.py | 48 +
> .../roadtest/roadtest/core/__init__.py | 0
> .../testing/roadtest/roadtest/core/control.py | 52 +
> .../roadtest/roadtest/core/devicetree.py | 155 +
> .../roadtest/roadtest/core/hardware.py | 94 +
> tools/testing/roadtest/roadtest/core/log.py | 42 +
> .../testing/roadtest/roadtest/core/modules.py | 38 +
> .../testing/roadtest/roadtest/core/opslog.py | 35 +
> tools/testing/roadtest/roadtest/core/proxy.py | 48 +
> tools/testing/roadtest/roadtest/core/suite.py | 286 ++
> tools/testing/roadtest/roadtest/core/sysfs.py | 77 +
> .../roadtest/roadtest/core/test_control.py | 35 +
> .../roadtest/roadtest/core/test_devicetree.py | 31 +
> .../roadtest/roadtest/core/test_hardware.py | 41 +
> .../roadtest/roadtest/core/test_log.py | 54 +
> .../roadtest/roadtest/core/test_opslog.py | 27 +
> .../roadtest/roadtest/tests/__init__.py | 0
> .../roadtest/roadtest/tests/base/config | 84 +
> .../roadtest/roadtest/tests/iio/__init__.py | 0
> .../roadtest/roadtest/tests/iio/config | 1 +
> .../roadtest/roadtest/tests/iio/iio.py | 112 +
> .../roadtest/tests/iio/light/__init__.py | 0
> .../roadtest/roadtest/tests/iio/light/config | 2 +
> .../roadtest/tests/iio/light/test_opt3001.py | 95 +
> .../roadtest/tests/iio/light/test_vcnl4000.py | 132 +
> .../roadtest/tests/iio/light/test_vcnl4010.py | 282 ++
> .../roadtest/tests/iio/light/test_vcnl4040.py | 104 +
> .../roadtest/tests/iio/light/test_vcnl4200.py | 96 +
> .../roadtest/tests/regulator/__init__.py | 0
> .../roadtest/roadtest/tests/regulator/config | 4 +
> .../roadtest/tests/regulator/test_tps62864.py | 187 ++
> .../roadtest/roadtest/tests/rtc/__init__.py | 0
> .../roadtest/roadtest/tests/rtc/config | 1 +
> .../roadtest/roadtest/tests/rtc/rtc.py | 73 +
> .../roadtest/tests/rtc/test_pcf8563.py | 348 ++
> tools/testing/roadtest/src/.gitignore | 1 +
> tools/testing/roadtest/src/backend.c | 884 +++++
> .../src/libvhost-user/include/atomic.h | 310 ++
> .../src/libvhost-user/libvhost-user.c | 2885 +++++++++++++++++
> .../src/libvhost-user/libvhost-user.h | 691 ++++
> 59 files changed, 8798 insertions(+)
> create mode 100644 Documentation/dev-tools/roadtest.rst
> create mode 100644 tools/testing/roadtest/.gitignore
> create mode 100644 tools/testing/roadtest/Dockerfile
> create mode 100644 tools/testing/roadtest/Makefile
> create mode 100755 tools/testing/roadtest/init.sh
> create mode 100644 tools/testing/roadtest/pyproject.toml
> create mode 100644 tools/testing/roadtest/requirements.txt
> create mode 100644 tools/testing/roadtest/roadtest/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/backend.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/gpio.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/i2c.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/main.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/mock.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/test_gpio.py
> create mode 100644 tools/testing/roadtest/roadtest/backend/test_i2c.py
> create mode 100644 tools/testing/roadtest/roadtest/cmd/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/cmd/main.py
> create mode 100644 tools/testing/roadtest/roadtest/cmd/remote.py
> create mode 100644 tools/testing/roadtest/roadtest/core/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/core/control.py
> create mode 100644 tools/testing/roadtest/roadtest/core/devicetree.py
> create mode 100644 tools/testing/roadtest/roadtest/core/hardware.py
> create mode 100644 tools/testing/roadtest/roadtest/core/log.py
> create mode 100644 tools/testing/roadtest/roadtest/core/modules.py
> create mode 100644 tools/testing/roadtest/roadtest/core/opslog.py
> create mode 100644 tools/testing/roadtest/roadtest/core/proxy.py
> create mode 100644 tools/testing/roadtest/roadtest/core/suite.py
> create mode 100644 tools/testing/roadtest/roadtest/core/sysfs.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_control.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_devicetree.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_hardware.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_log.py
> create mode 100644 tools/testing/roadtest/roadtest/core/test_opslog.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/base/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/iio.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_opt3001.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4000.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4010.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4040.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/iio/light/test_vcnl4200.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/regulator/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/regulator/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/regulator/test_tps62864.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/__init__.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/config
> create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/rtc.py
> create mode 100644 tools/testing/roadtest/roadtest/tests/rtc/test_pcf8563.py
> create mode 100644 tools/testing/roadtest/src/.gitignore
> create mode 100644 tools/testing/roadtest/src/backend.c
> create mode 100644 tools/testing/roadtest/src/libvhost-user/include/atomic.h
> create mode 100644 tools/testing/roadtest/src/libvhost-user/libvhost-user.c
> create mode 100644 tools/testing/roadtest/src/libvhost-user/libvhost-user.h
>