L3 API example¶

For example code references please follow the link below.

1. Vitis BLAS L3 compilation

All examples provided here could be built with compilation steps similar to the following:

g++ -O0 -std=c++11 -fPIC -Wextra -Wall -Wno-ignored-attributes -Wno-unused-parameter -Wno-unused-variable -I$(XILINX_XRT)/include -I/include/sw -o example.exe example.cpp -L$(XILINX_XRT)/lib -lz -lstdc++ -lrt -pthread -lxrt_core -ldl -luuid

2. Vitis BLAS L3 run

Most of the examples could be run with steps similar to the following in machine with HW device installed. Detailed usages are also provided in each section.

./example.exe PATH_TO_XCLBIN/example.xclbin PATH_TO_XCLBIN/config_info.dat

3. Vitis BLAS L3 code example

The following is an example of how to use Vitis BLAS API. Users always need to include header file xf_blas.hpp.

#include "xf_blas.hpp"

# define IDX2R(i,j,ld) (((i)*( ld ))+(j))
# define m 128 // a - mxk matrix
# define n 128 // b - kxn matrix
# define k 128 // c - mxn matrix

using namespace std;

int main(int argc, char **argv) {

  if (argc < 3){
    cerr << " usage: \n"
         << " gemx_example.exe gemx.xclbin config_info.dat log.txt\n"
         << " gemx_example.exe gemx.xclbin config_info.dat\n";
    return EXIT_FAILURE;
  }
  unsigned int l_argIdx = 1;
  string l_xclbinFile(argv[l_argIdx++]);
  string l_configFile(argv[l_argIdx++]);
  string l_logFile;

  if (argc == 3){
    ofstream logFile("log.txt");
    logFile.close();
    l_logFile = "log.txt";
  } else {
    l_logFile = argv[l_argIdx++];
  }

  int i, j; // i-row index ,j- column index
  short * a, * b, * c;
  a = ( short *) malloc (m*k* sizeof ( short ));
  b = ( short *) malloc (k*n* sizeof ( short ));
  c = ( short *) malloc (m*n* sizeof ( short ));

  int ind = 1;
  for( i = 0; i<  m; i ++){
    for( j = 0; j < k; j ++){
      a[ IDX2R (i,j,k )]= (short) ind++;
    }
  }
  ind = 1;
  for( i = 0; i<  k; i ++){
    for( j = 0; j < n; j ++){
      b[ IDX2R (i,j,n )]= (short) ind++;
    }
  }

  for( i = 0; i<  m; i ++){
    for( j = 0; j < n; j ++){
      c[ IDX2R (i,j,n )]= 0;
    }
  }

  xfblasEngine_t engineName = XFBLAS_ENGINE_GEMM;
  xfblasStatus_t status = xfblasCreate(l_xclbinFile.c_str(), l_configFile, l_logFile.c_str(), engineName);
  status = xfblasMallocRestricted(m,k,sizeof(*a),a,k);
  status = xfblasMallocRestricted(k,n,sizeof(*b),b,n);
  status = xfblasMallocRestricted(m,n,sizeof(*c),c,n);
  status = xfblasSetMatrixRestricted(a);
  status = xfblasSetMatrixRestricted(b);
  status = xfblasSetMatrixRestricted(c);
  status = xfblasGemm(XFBLAS_OP_N, XFBLAS_OP_N, m, n, k, 1, a, k, b, n, 1, c, n);
  status = xfblasGetMatrixRestricted(c);

  for ( i = 0; i < 128; i ++){
    for ( j = 0; j < 128; j ++){
      cout<< (c[ IDX2R (i,j, k )])<<" ";
    }
    cout<<"\n";
  }


  xfblasFree(a);
  xfblasFree(b);
  xfblasFree(c);
  xfblasDestroy();
  free(a);
  free(b);
  free(c);

  return EXIT_SUCCESS;
}

These API functions run on the first kernel by default, but they could support multi-kernels xclbin. Users will need to put numbers of kernels or index of the kernel in those functions to let the API know. The following code shows how to initialize Vitis BLAS library to support a xclbin with 2 kernels and run with the second kernel.

xfblasStatus_t status = xfblasCreate(l_xclbinFile.c_str(), l_configFile, l_logFile.c_str(), XFBLAS_ENGINE_GEMM, 2);
status = xfblasMallocRestricted(m,k,sizeof(*a),a,k, 1);
status = xfblasMallocRestricted(k,n,sizeof(*b),b,n, 1);
status = xfblasMallocRestricted(m,n,sizeof(*c),c,n, 1);
status = xfblasSetMatrixRestricted(a, 1);
status = xfblasSetMatrixRestricted(b, 1);
status = xfblasSetMatrixRestricted(c, 1);
status = xfblasGemm(XFBLAS_OP_N, XFBLAS_OP_N, m, k, n, 1, a, k, b, n, 1, c, n, 1);
status = xfblasGetMatrixRestricted(c, 1);

4. Vitis BLAS L3 example

Please see L3 example folder for more example cases.