Copyright (c) 2023 Antmicro
Copyright (c) 2023 Meta

A TCP server for the Warp Pipe Library, which aims to facilitate creating PCIe links in a distributed simulation environment. This includes:

• packetizing/depacketizing PCIe transactions into TLPs and DLLPs
• transmitting PCIe transactions over sockets using a custom PCIe/IP TCP-based protocol
• creating PCIe links between instances of different simulators/emulators (e.g. Renode and QEMU)
• handling MSIs, packet routing and flow control

To build Warp Pipe, use the following snippet:

mkdir -p build cmake -S . -B build make -j $(nproc) -C build 

and install it using:

make install -C build 

You can select PATH where warp-pipe will be installed using CMAKE_INSTALL_PREFIX during cmake configuration step:

cmake -S . -B build -DCMAKE_INSTALL_PREFIX=`pwd`/install 

You can also disable building tests by setting -DENABLE_TESTS=OFF.

Tests are build by default while building warp-pipe library. To execute tests, run:

./build/warppipe-tests 

To generate tests coverage report, use the following snippet:

./scripts/coverage.sh 

Generated coverage report can be found in the coverage folder.

This repository contains a memory-mock application that uses warp-pipe library and acts as simple PCIe device that emulates memory. To build it, use the following snippet:

mkdir -p build_memory_mock cmake -S memory-mock -B build_memory_mock make -j $(nproc) -C build_memory_mock 

If you installed warp-pipe to custom localization, you might also need to set PKG_CONFIG_PATH to the path containing warp-pipe.pc file:

PKG_CONFIG_PATH=`pwd`/install/lib/pkgconfig cmake -S memory-mock -B build_memory_mock 

To launch the memory-mock, use:

./build_memory_mock/memory_mock 

Use the following commands to prepare the Zephyr working environment:

west init --local --mf zephyr-samples/warp-pipe-zephyr.yml west update -o=--depth=1 -n west zephyr-export 

This environment is required to build and run samples from zephyr-samples folder. More information about building each of zephyr samples can be found in respective folders.

This repository overrides default Zephyr west twister command to allow running tests that requires PCIe device implementing warp-pipe. It requires built memory-mock.

west twister --testsuite-root zephyr-tests/ 

To view logs, use:

journalctl -f