HabanaAI / hl-thunk-open

Thunk library for HabanaLabs kernel driver

HabanaLabs thunk library for kernel driver

This is the userspace thunk library for HabanaLabs kernel driver.

Building

This project uses a cmake based build system. Quick start:

$ bash build.sh

Debian Derived

$ apt-get install build-essential cmake gcc

Fedora

$ dnf install cmake gcc

Building on CentOS 7

Install required packages:

$ yum install epel-release
$ yum install gcc make cmake3

Coding Style

This project uses the Linux kernel coding style with some minor changes, such as allowing typedefs.

Best practice is to use the checkpatch utility of the Linux kernel with the following ignores:

checkpatch.pl --ignore SPDX_LICENSE_TAG,NEW_TYPEDEFS

Testing

This library comes with a suite of tests for the various ASICs. The tests were developed using the CMocka testing framework. To build and run the tests suite, one needs to install the CMocka library and header files.

The minimum CMocka version required is 1.1.3

CMocka can be usually installed using the repository managers of the various distributions, or it can be compiled from source and installed.

The tests suite is not build by default. To build it, run cmake with -DUNIT_TESTING=ON