Installation¶

xbtest (HW and SW) is delivered and installed as part of AVED deployment archive. Refer to Alveo Versal Example Design (AVED) installation guide.

Important

Refer to Set up xbtest, which also describes how to run a quick check of the installation.

For links to AVED deployment archive, go to Alveo data center accelerator card compatibility.

The following sections describe how xbtest is being installed and installed content.

Dependencies¶

The following figure describes xbtest application software (xbtSW) RPM or DEB package dependencies:

Important

Although the OS package manager will resolve xbtest packages dependencies, xbtest requires a correctly installed and operating card. For instructions on how to install AVED deployment archive, refer to Alveo Versal Example Design (AVED) installation guide.

xbtest application software (xbtSW) depends on the json-glib-1.0 and ncurses packages. These two dependencies will be resolved by the OS package manager (for example, yum or apt).

Caution

Different major version of xbtest cannot be installed simultaneously (for example v4 with v5). Before you can install a new version of xbtest, you must remove other versions of xbtest.

Install xbtest¶

This section explains how to identify and install xbtest application software (xbtSW) package RPM or DEB packages using your OS package manager.

Important

You can skip this section if you installed AVED deployment archive following Alveo Versal Example Design (AVED) installation guide. xbtSW package is already installed.

The high-level installation steps are first listed, and then specific details are outlined in the following section:

Identify your OS.

Get and install xbtSW RPM or DEB package compatible with your setup.

Step 1: Identify your OS and AVED¶

xbtSW RPM and DEB packages depend on OS version and system architecture.

Step 1.1: Identify your system architecture¶

Identify compatible xbtest package <architecture> which is returned by the command given in the following table:

Identify xbtest package architecture¶
OS	Command	Output
Red Hat / CentOS	$ uname -p	x86_64
Ubuntu	$ dpkg --print-architecture	amd64

Step 1.2: Identify your OS release¶

Identify compatible xbtest package <OS_release> depending on your distribution. The following table gives two examples of xbtest package <OS_release>:

Identify xbtest package OS release¶
OS	xbtest package OS release
Red Hat / CentOS	8.x
Ubuntu	18.04

You can check the OS release of your distribution by running the command:

$ lsb_release -rs

Step 2: Install xbtest application software package¶

Install first xbtest application software (xbtSW). The following table gives two examples of command based on architecture and OS release:

Install xbtest application software package¶
Distribution	Architecture	Command
Red Hat / CentOS 8.x	`x86_64`	$ sudo yum install xbtest-7.0-1234567.x86_64_8.x.rpm
Ubuntu 18.04	`amd64`	$ sudo apt install xbtest_7.0-1234567_amd64_18.04.deb

Note

xbtSW packages are named with the suffix <architecture>_<OS_release>.<extension> where:

<architecture> is the system architecture identified in Step 1.1: Identify your system architecture.

<OS_release> is the OS release identified in Step 1.2: Identify your OS release.

<extension> is the package extension (deb or rpm).

Installed content¶

Installed content of xbtest application software package¶

xbtest application software (xbtSW) executable file is installed in: /usr/local/bin/xbtest

Note

Other files are also installed in: /opt/amd/xbtest/

/opt/amd/xbtest/
├── README.md
└── license/

Installed xbtest specific content included AVED deployment archive¶

After the AVED deployment archive installation, the following xbtest specific content is present:

A set of pre-canned test JSON files, for example: verify, mmio, dma, memory, gt_mac, power and stress.

Card definition JSON file (xbtest_pfm_def.json)

xbtest metadata JSON files (xbtest_metadata.json and user_metadata.json) .

Caution

These files are specific to each Alveo Versal Example Design (AVED). Do not edit them.

Various AVED deployment archive can be installed and used simultaneously. The following shows an example of some installed files and directory structure for two Alveo Versal Example Design (AVED), <AVED_A> and <AVED_B>.

/opt/amd/aved/
├── <AVED_A>/
│   ├── <...>
│   └── xbtest/
│       ├── metadata/
│       │   ├── xbtest_pfm_def.json
│       │   ├── user_metadata.json
│       │   └── xbtest_metadata.json
│       └── test/
│           └── verify, mmio, dma, memory, power, stress.json
└── <AVED_B>/
    ├── <...>
    └── xbtest/
        ├── metadata/
        │   ├── xbtest_pfm_def.json
        │   ├── user_metadata.json
        │   └── xbtest_metadata.json
        └── test/
             └── verify, mmio, dma, gt_mac, switch, memory_host, memory, power, stress.json

Note

The folder test/ contains the pre-canned test JSON files. The quantity and content of the pre-canned test JSON files depend on the Alveo Versal Example Design (AVED).

xbtSW scans and checks all installed AVED deployment archives at start-up. A library is ignored when it is not installed correctly. For example, if:

Expected file does not exists.

JSON file syntax is invalid or content is not as expected.

When targeting a card for which the library is not correct, xbtSW reports that the AVED deployment archive is not found.

Note

Invalid AVED deployment archives are reported when using command line option -v or -h.

Removal¶

To fully remove xbtest run the command given in the following table based on your OS:

xbtest packages removal¶
OS	Command
Red Hat / CentOS	$ sudo yum remove xbtest
Ubuntu	$ sudo apt remove xbtest

Install xbtest to another location¶

Different Alveo™ cards could require different versions of xbtest but different versions of the same xbtest packages cannot be installed simultaneously with the OS package manager (for example, yum or apt).

To install xbtest to a user specified location <target directory>, use the following commands for each xbtest RPM or DEB package <xbtest pkg.rpm/deb>: This will extract xbtSW package content to the installation directory <target directory>/usr/local/bin/xbtest and <target directory>/opt/amd/xbtest/.

Extract xbtest packages¶
OS	Command
Red Hat / CentOS	$ cd <target directory>; rpm2cpio <xbtest pkg.rpm> \| cpio -idv
Ubuntu	$ dpkg -x <xbtest pkg.deb> <target directory>

Warning

RPM or DEB package dependencies are not checked with these commands.

Make sure that the dependency requirements are satisfied using the following commands:

Check dependencies¶
OS	Command
Red Hat / CentOS	$ yum deplist <xbtest pkg.rpm> or $ rpm -qpR <xbtest pkg.rpm>
Ubuntu	$ dpkg-deb -I <xbtest pkg.deb>