General Information

c++11
c++14
c++17

Migrate the source files on the command line by using the
--vcxprojfile
option of the Intel® DPC++ Compatibility Tool.
Migrate the entire project in Microsoft Visual Studio with an Intel® DPC++ Compatibility Tool Microsoft Visual Studio plugin.

The Intel® DPC++ Compatibility Tool will try to detect the indent size of the original code and apply it to the resulting code. You can guide the tool by setting
TabWidth
and
UseTab
in the
.clang-format
file. Because the input source code is not well formatted, the indents in the resulting code may still be inconsistent.
Run the Intel® DPC++ Compatibility Tool with the
--format-range=all
option to format the entire resulting file. The change between input source code and resulting source code may be large and make it more difficult to compare the code.
Format your input source code, then use the Intel® DPC++ Compatibility Tool with the same
.clang-format
file for migration.

In Linux, load a dynamic library (
.so
) using
dlopen()
In Windows, load a dynamic library (
.dll
) using
LoadLibraryA()

// original code

int *device_mem = nullptr;device_mem = sycl::malloc_device<int>(size, dpct::get_default_queue());
device_mem[0] += somevalue;

// fixed SYCL code

int *device_mem = nullptr;device_mem = sycl::malloc_device<int>(size, dpct::get_default_queue());
dpct::get_default_queue().memset(0, size).wait();
device_mem[0] += somevalue;

Troubleshooting

Rely on the Intel® DPC++ Compatibility Tool to decide which files to migrate with:
compile_commands.json: “dpct -p=compile_commands.json --in-root=srcdir --out-root=dstdir”
Manually pass specific files to migrate, but do not pass the files that are included in other files and not supposed to be compiled as a standalone file in the original application. The header files are migrated automatically when they are included by the files provided as the input to the tool and are located within the
in-root
folder:
dpct --in-root= srcdir --out-root=dstdir sample.cu

Add
#include <algorithm>
to the source file before using
std::min
and
std::max
Define the NOMINMAX macro by inserting
#define NOMINMAX
before including
WinDef.h

The CUDA include path is specified by both
--cuda-include-path
and
-I*
, but the paths are different
The CUDA include path is specified by
-I*
, but there are other CUDA include files located on the default CUDA install path

Create a new C++ file
dpct_helper.cpp
.
Move the implementation of
instance()
in
class dev_mgr
from
dpct/device.hpp
to
dpct_helper.cpp
.
For example, the original
dpct/device.hpp
:
 class dev_mgr {
 public:
   static dev_mgr &instance() { // the implementation and the declaration of dev_mgr::instance
     static dev_mgr d_m;
     return d_m;
   }
   ...
 }
is updated to:
 class dev_mgr {
 public:
   static dev_mgr &instance();//the declaration of dev_mgr::instance
   ...
 }
and the new
dpct_helper.cpp
now contains the implementation of
dev_mgr::instance()
:
#include <dpct/device.hpp>
dpct::dev_mgr &dev_mgr::instance(){ // the implementation of dev_mgr::instance
  static dev_mgr d_m;
  return d_m;
}
Similar to step two, move the implementation of
instance()
in the
class mem_mgr
from
dpct/memory.hpp
to
dpct_helper.cpp
.
Build
dpct_helper.cpp
into a dynamic library
libdpct_helper
.
In Linux:

dpcpp -g -shared -o libdpct_helper.so -fPIC ./dpct_helper.cpp

In Windows:

cl.exe /LD dpct_helper.cpp
Add library
libdpct_helper
to the environment variables.
In Linux: Add the location of
libdpct_helper.so
into
LD_LIBRARY_PATH
.
In Windows: Add the location of
libdpct_helper.dll
into
PATH
.
Dynamically link
libdpct_helper
when building libraries and applications.

// migrated SYCL code

void foo() {
  ...
  unsigned int bit = index[tid] % 32;
  unsigned int val = in[tid] << 32 - bit;
  ...
}

// fixed SYCL code

void foo() {
  ...
  unsigned int bit = index[tid] % 32;
  unsigned int val;
  if(32 - bit == 32)
    val = 0;
  else
    val = in[tid] << 32 - bit;
  ...
}