DEVELOPING.md

How to build

Dependencies

Required packages might vary from system to system. Below are the packages it was once required to install on a clean DUT CentOS 8 installation

1. libstdc++

sudo yum install libstdc++-static

2. Onload repository

It is necessary to have a copy of the Onload source code

git clone git@github.com:Xilinx/onload.git

Building

Execute the following command from the root of the repository:

export ONLOAD_TREE={path to the checked out onload repository}
make

Packaging

SRPM instructions

Use the zf_make_official_srpm script to create an SRPM package:

scripts/zf_make_official_srpm --version ${version}

The ${version} variable can be git hexsha such as d42f94d5 or a semver string such as 9.0.0.

Execute the following command to create an RPM package from SRPM:

rpmbuild --rebuild ~/rpmbuild/SRPMS/tcpdirect-${version}-1.src.rpm

Here, the ${version} variable is the same as for zf_make_official_srpm. The above command will build the tcpdirect package using the onload libraries installed as part of the onload rpm package, and the headers from the onload-devel package.

If you wish to build the tcpdirect package either from a specific onload tarball or without installing the system packages, you can add the following to the invocation of rpmbuild above:

--define "onload_tarball ${onload}"

Where the ${onload} variable points to an Onload tarball.

Deb instructions

To install TCPDirect from a DEB:

The DEB package depends on *onload-user and *onload-dev packages in addition to any other dependencies.

# 1. Extract debian-source tarball:
tar -xf tcpdirect_<version>-debiansource.tgz
# 2. Unpack debian source archive
dpkg-source -x tcpdirect_<version>-1.dsc
# 3. Enter newly created tcpdirect directory
cd tcpdirect-<version>
# 4. Build debian package
debuild -i -uc -us
# 5. Install debian package
dpkg -i ../tcpdirect_<version>-1_amd64.deb

How to run unit tests

Dependencies

In addition to the dependencies specified in the build section unit tests would require following dependencies in place:

1. perl-Test-Harness

$ sudo yum install perl-Test-Harness

Running tests

Execute the following commands from the root of the repository:

$ export ONLOAD_TREE={path to the checked out onload repository}
$ export ZF_DEVEL=1
$ make clean test

Note: sudo access will be required to run tests

Common Problems

1. If you get the problem 'Failed to allocate huge page for emu, are huge pages available?'

$ sudo sysctl vm.nr_hugepages=4096

Footnotes

SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: Copyright (C) 2020-2024 Advanced Micro Devices, Inc.