Can't install OPAE-SDK

[DatNguyen97-VN]

Hi Admin,
I'm learning OPAE framework i have faced some issues as mentioned below.

Setup info

Ubuntu 20.04

Action

S1: Downloaded opae with latest release at https://github.com/OFS/opae-sdk/releases.
S2: tar xfvz opae-sdk-2.14.0-2.tar.gz
S3: cd opae-sdk-2.14.0-2
S4: mkdir mybuild
S5: cd mybuild
S6: cmake .. -DBUILD_ASE=1
S7: make

Unexpected Behaviour

Scanning dependencies of target mmlink
[ 81%] Building CXX object binaries/mmlink/CMakeFiles/mmlink.dir/main.cpp.o
[ 81%] Linking CXX executable ../../bin/mmlink
[ 81%] Built target mmlink
Scanning dependencies of target opae.io
[ 81%] Building CXX object binaries/opae.io/CMakeFiles/opae.io.dir/main.cpp.o
In file included from /home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.cpp:39:
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h: In member function ‘int vfio_device::set_vf_token(const char*)’:
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:232:55: error: invalid application of ‘sizeof’ to incomplete type ‘vfio_device::set_vf_token(const char*)::vfio_device_feature’
          new uint8_t[sizeof(struct vfio_device_feature) + VFIO_VF_TOKEN_LEN];
                                                       ^
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:234:7: error: invalid use of incomplete type ‘struct vfio_device::set_vf_token(const char*)::vfio_device_feature’
     df->argsz = sizeof(df) + VFIO_VF_TOKEN_LEN;
       ^~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:228:12: note: forward declaration of ‘struct vfio_device::set_vf_token(const char*)::vfio_device_feature’
     struct vfio_device_feature *df;
            ^~~~~~~~~~~~~~~~~~~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:235:7: error: invalid use of incomplete type ‘struct vfio_device::set_vf_token(const char*)::vfio_device_feature’
     df->flags = VFIO_DEVICE_FEATURE_SET | VFIO_DEVICE_FEATURE_PCI_VF_TOKEN;
       ^~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:228:12: note: forward declaration of ‘struct vfio_device::set_vf_token(const char*)::vfio_device_feature’
     struct vfio_device_feature *df;
            ^~~~~~~~~~~~~~~~~~~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:235:17: error: ‘VFIO_DEVICE_FEATURE_SET’ was not declared in this scope
     df->flags = VFIO_DEVICE_FEATURE_SET | VFIO_DEVICE_FEATURE_PCI_VF_TOKEN;
                 ^~~~~~~~~~~~~~~~~~~~~~~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:235:17: note: suggested alternative: ‘VFIO_DEVICE_FLAGS_RESET’
     df->flags = VFIO_DEVICE_FEATURE_SET | VFIO_DEVICE_FEATURE_PCI_VF_TOKEN;
                 ^~~~~~~~~~~~~~~~~~~~~~~
                 VFIO_DEVICE_FLAGS_RESET
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:235:43: error: ‘VFIO_DEVICE_FEATURE_PCI_VF_TOKEN’ was not declared in this scope
     df->flags = VFIO_DEVICE_FEATURE_SET | VFIO_DEVICE_FEATURE_PCI_VF_TOKEN;
                                           ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:235:43: note: suggested alternative: ‘VFIO_DEVICE_API_PCI_STRING’
     df->flags = VFIO_DEVICE_FEATURE_SET | VFIO_DEVICE_FEATURE_PCI_VF_TOKEN;
                                           ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                                           VFIO_DEVICE_API_PCI_STRING
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:236:14: error: invalid use of incomplete type ‘struct vfio_device::set_vf_token(const char*)::vfio_device_feature’
     memcpy(df->data, vf_token, VFIO_VF_TOKEN_LEN);
              ^~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:228:12: note: forward declaration of ‘struct vfio_device::set_vf_token(const char*)::vfio_device_feature’
     struct vfio_device_feature *df;
            ^~~~~~~~~~~~~~~~~~~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:238:39: error: ‘VFIO_DEVICE_FEATURE’ was not declared in this scope
     ret = ioctl(v_->device.device_fd, VFIO_DEVICE_FEATURE, df);
                                       ^~~~~~~~~~~~~~~~~~~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:238:39: note: suggested alternative: ‘VFIO_DEVICE_FLAGS_AP’
     ret = ioctl(v_->device.device_fd, VFIO_DEVICE_FEATURE, df);
                                       ^~~~~~~~~~~~~~~~~~~
                                       VFIO_DEVICE_FLAGS_AP
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:239:14: error: possible problem detected in invocation of delete [] operator: [-Werror=delete-incomplete]
     delete[] df;
              ^~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:228:33: error: ‘df’ has incomplete type [-Werror]
     struct vfio_device_feature *df;
                                 ^~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:228:12: note: forward declaration of ‘struct vfio_device::set_vf_token(const char*)::vfio_device_feature’
     struct vfio_device_feature *df;
            ^~~~~~~~~~~~~~~~~~~
/home/tools/opae-sdk-2.14.0-2/binaries/opae.io/main.h:239:14: note: neither the destructor nor the class-specific operator delete [] will be called, even if they are declared when the class is defined
     delete[] df;
              ^~
cc1plus: all warnings being treated as errors
make[2]: *** [binaries/opae.io/CMakeFiles/opae.io.dir/build.make:63: binaries/opae.io/CMakeFiles/opae.io.dir/main.cpp.o] Error 1
make[1]: *** [CMakeFiles/Makefile2:3181: binaries/opae.io/CMakeFiles/opae.io.dir/all] Error 2
make: *** [Makefile:152: all] Error 2

Please let me know how to fix these errors.
Thank you,
Dat Nguyen

[pcolberg]

Hi @DatNguyen97-VN, OPAE SDK no longer supports Ubuntu 20.04; the recommendation would be to upgrade to Ubuntu 22.04 or 24.04. The compilation failure is due to your kernel being older than 5.7, which introduced the VFIO_DEVICE_FEATURE ioctl.

However, you can try updating to the Ubuntu 20.04 HWE kernel, which is 5.15:

apt install linux-generic-hwe-20.04

Do note that Ubuntu 20.04 LTS Standard Support ends on 31 May 2025.

[DatNguyen97-VN]

I have updated to 5.15.167.4-microsoft-standard-WSL2 version but these errors still appears 😭😭:

Action

apt install linux-generic-hwe-20.04

Result

Reading package lists... Done
Building dependency tree
Reading state information... Done
linux-generic-hwe-20.04 is already the newest version (5.15.0.134.145~20.04.1).
The following packages were automatically installed and are no longer required:
  docker-scan-plugin libpkgconf3
Use 'apt autoremove' to remove them.
0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.

Errors

Scanning dependencies of target opae.io
[ 78%] Building CXX object binaries/opae.io/CMakeFiles/opae.io.dir/main.cpp.o
In file included from /home/tools/opae-sdk/binaries/opae.io/main.cpp:39:
/home/tools/opae-sdk/binaries/opae.io/main.h: In member function ‘int vfio_device::set_vf_token(const char*)’:
/home/tools/opae-sdk/binaries/opae.io/main.h:232:55: error: invalid application of ‘sizeof’ to incomplete type ‘vfio_device::set_vf_token(const char*)::vfio_device_feature’
          new uint8_t[sizeof(struct vfio_device_feature) + VFIO_VF_TOKEN_LEN];

Setup Info

Ubuntu 20.04 on WSL

[DatNguyen97-VN]

Hi @pcolberg, i was installed opae-sdk 2.14.0 and want to install opae-sim but failed:

Opae-sdk
location: /usr/local/lib/opae-2.14.0
files: modules opae-config-version.cmake opae-config.cmake opae-targets-release.cmake opae-targets.cmake

Action

git clone https://github.com/OPAE/opae-sim.git
cd opae-sim
mkdir build
opae_DIR=/usr/local/lib/opae-2.14.0 cmake ..

Result

-- The C compiler identification is GNU 13.3.0
-- The CXX compiler identification is GNU 13.3.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Found PkgConfig: /usr/bin/pkg-config (found version "1.8.1")
-- Found libjson-c: /usr/local/include
-- Found libuuid: /usr/include
-- Found librt: /usr/lib/x86_64-linux-gnu/librt.a
CMake Error at ase/CMakeLists.txt:33 (find_package):
  Found package configuration file:

    /usr/local/lib/opae-2.14.0/opae-config.cmake

  but it set opae_FOUND to FALSE so package "opae" is considered to be NOT
  FOUND.  Reason given by package:

  The following imported targets are referenced, but are missing:
  json-c::json-c



-- Configuring incomplete, errors occurred!

Please help me.
Thank you,
Dat Nguyen