Intel® oneAPI DPC++/C++ Compiler Developer Guide and Reference

Development Reference Guides

Contents

Invoke the Compiler

Requirements Before Using the Command Line

You may need to set certain environment variables before using the command line. For more information, see .

Different Compilers and Drivers

The table below provides the different compiler front-end and driver information.
To use Microsoft Visual C++* (MSVC) compatible options, use
dpcpp-cl
.
Compiler
Notes
Linux* Driver
Windows* Driver
Intel® DPC++ Compiler
A C++ and Khronos SYCL* compiler with a Clang front-end.
dpcpp
dpcpp
 (
clang
 compatible)
dpcpp-cl
 (
clang-cl
 compatible)
Intel® C++ Compiler
A C++ compiler with a Clang front-end, supporting OpenMP* offload.
icx
 for C
icpx
 for C++
icx

Use the Compiler from the Command Line

Use the compiler with the OS/language specific invocations below.
You can also use the compiler from within the IDE.
For more information on using Microsoft Visual Studio*, see Using Microsoft Visual Studio.
For information on using Eclipse*, see Using Eclipse.
Linux:
Invoke the compiler using
icx
/
icpx
 (for C/C++) or
dpcpp
 (for DPC++)
 to compile
LLVM
 C/C++
/DPC++
 source files.
  • When you invoke the compiler with
    dpcpp
     the compiler builds
    DPC++
     source files using
    DPC++
     libraries and
    DPC++
     include files. If you use
    dpcpp
     with a C source file, it is compiled as a
    DPC++
     file. Use
    dpcpp
     to link
    DPC++
     object files.
  • When you invoke the compiler with
    icx
     the compiler builds LLVM C source files using LLVM C libraries and LLVM C include files. If you use
    icx
    with a C++ source file, it is compiled as an LLVM C file. Use
    icx
     to link LLVM C object files.
  • When you invoke the compiler with
    icpx
     the compiler builds LLVM C++ source files using LLVM C++ libraries and LLVM C++ include files. If you use
    icpx
     with a C source file, it is compiled as an LLVM C++ file. Use
    icpx
     to link LLVM C++ object files.
    If you are using
    icpx
     as your main compiler, you must add
    -fsycl
     at the link stage, otherwise the offload kernels are not available in the main binary.
The
icx
/
icpx
 (for C/C++) or
dpcpp
 (for DPC++)
 command does the following:
  • Compiles and links the input source file(s).
  • Produces one executable file,
    a.out
    , in the current directory.
Windows:
You can invoke the compiler on the command line using the
icx
 (for C/C++) or
dpcpp-cl
 (for DPC++)
 command. This command:
  • Compiles and links the input source file(s).
  • Produces object file(s) and assigns the names of the respective source file(s), but with a
    .obj
     extension.
  • Produces one executable file and assigns it the name of the first input file on the command line, but with a
    .exe
     extension.
  • Places all the files in the current directory.
When compilation occurs with the compiler, many tools may be called to complete the task that may reproduce diagnostics unique to the given tool. For instance, the linker may return a message if it cannot resolve a global reference. The
watch
option can help clarify which component is generating the error.

Command Line Syntax

When you invoke the compiler, the syntax is:
For C/C++ projects:
// (Linux)
{icx/icpx} [options] file1 [file2...]
// (Windows)
icx [options] file1 [file2...] [/link link_options]
For DPC++ projects:
// (Linux)
dpcpp [options] file1 [file2...]
// (Windows)
dpcpp-cl [options] file1 [file2...] [/link link_options]
Argument
Description
options
Indicates one or more command line options.
On Linux systems, the compiler recognizes one or more letters preceded by a hyphen (
-
).
On Windows, options are preceded by a slash (
/
). This includes linker options.
Options are not required when invoking the compiler. The default behavior of the compiler implies that some options are ON by default when invoking compiler.
file1, file2...
Indicates one or more files to be processed by the compiler. You can specify more than one file, using
space
 as a delimiter for multiple files.
/link
 (Windows)
All options following
/link
 are passed to the linker. Compiler options must precede
link
if they are not to be passed to the linker.

Other Methods for Using the Command Line to Invoke the Compiler

  • Using makefiles from the Command Line:
     Use makefiles to specify a number of files with various paths and to save this information for multiple compilations. For more information on using makefiles, see .
  • Using a Batch File from the Command Line:
     Create and use a
    .bat
     file to consistently execute the compiler with a desired set of options instead of retyping the command each time you need to recompile.

Enable OpenMP* Offloading

To enable OpenMP* offloading for C++ applications, invoke the compiler with:
  • icpx -fiopenmp -fopenmp-targets=<arch>
     (Linux)
  • icx /Qiopenmp /Qopenmp-targets:<arch>
     (Windows).
To enable OpenMP offloading for DPC++ applications, invoke the compiler with:
  • dpcpp -fiopenmp -fopenmp-targets=<arch>
     (Linux)
  • dpcpp-cl /Qiopenmp /Qopenmp-targets:<arch>
     (Windows)

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.