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

Download PDF
ID 767253
Date 3/31/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
Intel® oneAPI DPC++/C++ Compiler Developer Guide and Reference
Intel® oneAPI DPC++/C++ Compiler Developer Guide and Reference x
Intel® oneAPI DPC++/C++ Compiler Introduction Compiler Setup Compiler Reference Compilation Optimization and Programming Compatibility and Portability Notices and Disclaimers
Intel® oneAPI DPC++/C++ Compiler Introduction x
Get Help and Support Related Information
Compiler Setup x
Use the Command Line Use Eclipse Use Microsoft Visual Studio
Use the Command Line x
Specify Component Locations Invoke the Compiler Use the Command Line on Windows File Extensions Use Makefiles for Compilation Use CMake with the Compiler Use Compiler Options Specify Compiler Files Convert Projects to Use a Selected Compiler
Use Eclipse x
Add the Compiler to Eclipse Multiversion Compiler Support Use Cheat Sheets Create a Simple Eclipse Project Makefiles Use Intel Libraries with Eclipse
Use Microsoft Visual Studio x
Create a New Project Use the Intel® oneAPI DPC++/C++ Compiler Select the Compiler Version Specify a Base Platform Toolset Use Property Pages Use Intel® Libraries with Microsoft Visual Studio* Include MPI Support Dialog Box Help
Dialog Box Help x
Options: Compilers dialog box Use Intel® oneAPI DPC++/C++ Compiler dialog box Options: Intel Libraries for oneAPI dialog box Options: Converter dialog box
Compiler Reference x
C/C++/SYCL Calling Conventions Compiler Options Floating-Point Operations Attributes Intrinsics Libraries Macros Pragmas Error Handling
Compiler Options x
Alphabetical Option List General Rules for Compiler Options What Appears in the Compiler Option Descriptions Optimization Options Code Generation Options Interprocedural Optimization Options Advanced Optimization Options Optimization Report Options Offload Compilation, OpenMP*, and Parallel Processing Options Floating-Point Options Inlining Options Output, Debug, and Precompiled Header Options Preprocessor Options Component Control Options Language Options Data Options Compiler Diagnostic Options Compatibility Options Linking or Linker Options Miscellaneous Options Deprecated and Removed Compiler Options Display Option Information Alternate Compiler Options Portability and GCC-Compatible Warning Options
Optimization Options x
fast fbuiltin, Oi foptimize-sibling-calls GF nolib-inline O Od Ofast Os Ot Ox
Code Generation Options x
arch ax, Qax EH fasynchronous-unwind-tables fdata-sections, Gw fexceptions ffunction-sections, Gy fomit-frame-pointer Gd GR guard Gv m, Qm m64, Qm64 m80387 march masm mbranches-within-32B-boundaries, Qbranches-within-32B-boundaries mintrinsic-promote, Qintrinsic-promote momit-leaf-frame-pointer mtune, tune regcall, Qregcall x, Qx xHost, QxHost
Interprocedural Optimization Options x
flto ipo, Qipo
Advanced Optimization Options x
ffreestanding, Qfreestanding fjump-tables fvec-peel-loops, Qvec-peel-loops fvec-remainder-loops, Qvec-remainder-loops fvec-with-mask, Qvec-with-mask ipp-link, Qipp-link qactypes, Qactypes qdaal, Qdaal qipp, Qipp qmkl, Qmkl qmkl-ilp64, Qmkl-ilp64 qopt-assume-no-loop-carried-dep, Qopt-assume-no-loop-carried-dep qopt-dynamic-align, Qopt-dynamic-align qopt-for-throughput, Qopt-for-throughput qopt-mem-layout-trans, Qopt-mem-layout-trans qopt-multiple-gather-scatter-by-shuffles, Qopt-multiple-gather-scatter-by-shuffles qopt-streaming-stores, Qopt-streaming-stores qtbb, Qtbb unroll, Qunroll use-intel-optimized-headers, Quse-intel-optimized-headers vec, Qvec vec-threshold, Qvec-threshold
Optimization Report Options x
qopt-report, Qopt-report qopt-report-file, Qopt-report-file
Offload Compilation, OpenMP*, and Parallel Processing Options x
device-math-lib fintelfpga fiopenmp, Qiopenmp fno-sycl-libspirv foffload-static-lib fopenmp fopenmp-declare-target-scalar-defaultmap, Qopenmp-declare-target-scalar-defaultmap fopenmp-device-lib fopenmp-target-buffers, Qopenmp-target-buffers fopenmp-targets, Qopenmp-targets fsycl fsycl-add-targets fsycl-dead-args-optimization fsycl-device-code-split fsycl-device-lib fsycl-device-only fsycl-early-optimizations fsycl-enable-function-pointers fsycl-esimd-force-stateless-mem fsycl-explicit-simd fsycl-force-target fsycl-help fsycl-host-compiler fsycl-host-compiler-options fsycl-id-queries-fit-in-int fsycl-instrument-device-code fsycl-link fsycl-link-huge-device-code fsycl-link-targets fsycl-max-parallel-link-jobs fsycl-rdc fsycl-targets fsycl-unnamed-lambda fsycl-use-bitcode nolibsycl qopenmp, Qopenmp qopenmp-lib, Qopenmp-lib qopenmp-link qopenmp-simd, Qopenmp-simd qopenmp-stubs, Qopenmp-stubs reuse-exe Wno-sycl-strict Xopenmp-target Xs Xsycl-target
Floating-Point Options x
ffp-contract fimf-absolute-error, Qimf-absolute-error fimf-accuracy-bits, Qimf-accuracy-bits fimf-arch-consistency, Qimf-arch-consistency fimf-domain-exclusion, Qimf-domain-exclusion fimf-max-error, Qimf-max-error fimf-precision, Qimf-precision fimf-use-svml, Qimf-use-svml fma, Qfma fp-model, fp fp-speculation, Qfp-speculation pc, Qpc
Inlining Options x
fgnu89-inline finline finline-functions
Output, Debug, and Precompiled Header Options x
c debug (Linux*) debug (Windows*) Fa fasm-blocks Fe Fo Fp ftrapuv, Qtrapuv fverbose-asm g gdwarf grecord-gcc-switches gsplit-dwarf o RTC S use-msasm Y- Yc Yu Zi, Z7, ZI
Preprocessor Options x
B C D dD, QdD dM, QdM E EP FI H, QH I I- idirafter imacros iprefix iquote isystem iwithprefix iwithprefixbefore Kc++, TP M, QM MD, QMD MF, QMF MG, QMG MM, QMM MMD, QMMD MQ MT, QMT nostdinc++ P pragma-optimization-level U undef X
Component Control Options x
Qoption
Language Options x
ansi fno-gnu-keywords fno-operator-names fno-rtti fpermissive fshort-enums fsyntax-only funsigned-char J std, Qstd strict-ansi vd vmg x (type option) Zc Zg Zp Zs
Data Options x
fcommon fkeep-static-consts, Qkeep-static-consts fmath-errno fpack-struct fpic fpie fstack-protector fstack-security-check fvisibility fzero-initialized-in-bss, Qzero-initialized-in-bss GA Gs GS mcmodel Qlong-double
Compiler Diagnostic Options x
w w, W Wabi Wall Wcheck-unicode-security Wcomment Wdeprecated Weffc++, Qeffc++ Werror, WX Werror-all Wextra-tokens Wformat Wformat-security Wmain Wmissing-declarations Wmissing-prototypes Wpointer-arith Wreorder Wreturn-type Wshadow Wsign-compare Wstrict-aliasing Wstrict-prototypes Wtrigraphs Wuninitialized Wunknown-pragmas Wunused-function Wunused-variable Wwrite-strings
Compatibility Options x
gcc-toolchain vmv
Linking or Linker Options x
F (Windows*) fixed fuse-ld l L LD link MD MT no-libgcc nodefaultlibs no-intel-lib, Qno-intel-lib nostartfiles nostdlib pie pthread shared shared-intel shared-libgcc static static-intel static-libgcc static-libstdc++ T u (Linux*) v Wa Wl Wp Xlinker Zl
Miscellaneous Options x
dryrun dumpmachine dumpversion help nologo save-temps, Qsave-temps showIncludes sox, Qsox sysroot Tc TC Tp version watch
Floating-Point Operations x
Programming Tradeoffs in Floating-Point Applications Use the -fp-model, /fp Option Denormal Numbers Set the FTZ and DAZ Flags Tuning Performance IEEE Floating-Point Operations
Attributes x
align align_value allow_cpu_features concurrency_safe const cpu_dispatch, cpu_specific mpx target
Libraries x
Create Libraries Use Intel Shared Libraries on Linux Manage Libraries Redistribute Libraries When Deploying Applications Resolve References to Shared Libraries Intel's Memory Allocator Library SIMD Data Layout Templates Intel® C++ Class Libraries Intel's C++ Asynchronous I/O Extensions for Windows IEEE 754-2008 Binary Floating-Point Conformance Library Intel's Numeric String Conversion Library
SIMD Data Layout Templates x
Function Calls and Containers User-Level Interface Examples
Function Calls and Containers x
Construct an n_container Bounds
User-Level Interface x
SDLT Primitives soa1d_container aos1d_container n_container Bounds Accessors Proxy Objects Number Representation Indexes Convenience and Correctness
aos1d_container x
access_by
n_container x
Layouts Shape make_ n_container template function extent_d template function
Shape x
n_extent_generator
Bounds x
bounds_t sdlt::bounds Template Function n_bounds_t n_bounds_generator bounds_d Template Function
Accessors x
soa1d_container::accessor and aos1d_container::accessor soa1d_container::const_accessor and aos1d_container::const_accessor Accessor Concept
Proxy Objects x
Proxy ConstProxy
Number Representation x
aligned_offset fixed_offset
Indexes x
linear_index n_index_t n_index_generator index_d template function
Convenience and Correctness x
max_val min_val
Examples x
Efficiency with Structure of Arrays Example Complex SDLT Primitive Construction Example Forward Dependency Example Use of Offsets and Methods on a SDLT Primitive Example RGB to YUV Conversion Example
Intel® C++ Class Libraries x
C++ Classes and SIMD Operations Capabilities of C++ SIMD Classes Integer Vector Classes Floating-Point Vector Classes Classes Quick Reference Programming Example Intel's valarray Implementation
Integer Vector Classes x
Terms and Syntax Rules for Operators Assignment Operator Logical Operators Addition and Subtraction Operators Multiplication Operators Shift Operators Comparison Operators Conditional Select Operators Debug Operations Unpack Operators Pack Operators Clear MMX™ State Operator Integer Functions for Intel® Streaming SIMD Extensions Conversions between Fvec and Ivec
Floating-Point Vector Classes x
Fvec Syntax and Notation Data Alignment Conversions Constructors and Initialization Arithmetic Operators Minimum and Maximum Operators Logical Operators Compare Operators Conditional Select Operators for Fvec Classes Cacheability Support Operators Debug Operations Load and Store Operators Unpack Operators Move Mask Operators
Intel's C++ Asynchronous I/O Extensions for Windows x
Intel's C++ Asynchronous I/O Library for Windows Intel's C++ Asynchronous I/O Class for Windows
Intel's C++ Asynchronous I/O Library for Windows x
aio_read aio_write Example for aio_read and aio_write Functions aio_suspend Example for aio_suspend Function aio_error aio_return Example for aio_error and aio_return Functions aio_fsync aio_cancel Example for aio_cancel Function lio_listio Example for lio_listio Function Asynchronous I/O Function Errors
Intel's C++ Asynchronous I/O Class for Windows x
Template Class async_class get_last_operation_id wait get_status get_last_error get_error_operation_id stop_queue resume_queue clear_queue Example for Using async_class Template Class
IEEE 754-2008 Binary Floating-Point Conformance Library x
Intel® IEEE 754-2008 Binary Floating-Point Conformance Library and Usage Function List Homogeneous General-Computational Operations Functions General-Computational Operation Functions Quiet-Computational Operations Functions Signaling-Computational Operations Functions Non-Computational Operations Functions
Intel's Numeric String Conversion Library x
Use Intel's Numeric String Conversion Library Function List
Macros x
ISO Standard Predefined Macros Additional Predefined Macros Use Predefined Macros to Specify Intel® Compilers
Pragmas x
Intel-Specific Pragma Reference Intel-Supported Pragma Reference
Intel-Specific Pragma Reference x
block_loop/noblock_loop distribute_point inline, noinline, forceinline ivdep loop_count nofusion novector omp target variant dispatch ompx prefetch data prefetch/noprefetch unroll/nounroll unroll_and_jam/nounroll_and_jam vector
Compilation x
Compilation Overview Supported Environment Variables Pass Options to the Linker Specify Alternate Tools and Paths Use Configuration Files Use Response Files Global Symbols and Visibility Attributes for Linux* Save Compiler Information in Your Executable Link Debug Information Ahead of Time Compilation Device Offload Compilation Considerations Use a Third-Party Compiler as a Host Compiler for SYCL Code
Optimization and Programming x
Extensions OpenMP* Support Intel® oneAPI Level Zero Vectorization High-Level Optimization Interprocedural Optimization Methods to Optimize Code Size Intel® oneAPI DPC++/C++ Compiler Math Library
OpenMP* Support x
Add OpenMP* Support Parallel Processing Model Worksharing Using OpenMP* Control Thread Allocation OpenMP* Pragmas OpenMP* Library Support OpenMP* Advanced Issues OpenMP* Implementation-Defined Behaviors OpenMP* Examples
OpenMP* Library Support x
OpenMP* Runtime Library Routines Intel® Compiler Extension Routines to OpenMP* OpenMP* Support Libraries Use the OpenMP Libraries Thread Affinity Interface OpenMP* Memory Spaces and Allocators
Intel® oneAPI Level Zero x
Intel® oneAPI Level Zero Switch Intel® oneAPI Level Zero Backend Specification Programming with the Intel® oneAPI Level Zero Backend
Vectorization x
Automatic Vectorization Explicit Vector Programming
Automatic Vectorization x
Vectorization Programming Guidelines Use Automatic Vectorization Vectorization and Loops Loop Constructs
Explicit Vector Programming x
User-Mandated or SIMD Vectorization SIMD-Enabled Functions SIMD-Enabled Function Pointers Vectorize a Loop Using the _Simd Keyword Function Annotations and the SIMD Directive for Vectorization Explicit SIMD SYCL Extension
Interprocedural Optimization x
Use Interprocedural Optimization Performance and Large Program Considerations Create a Library from IPO Objects Inline Expansion of Functions
Intel® oneAPI DPC++/C++ Compiler Math Library x
Use the Intel® oneAPI DPC++/C++ Compiler Math Library Math Function List Trigonometric Functions Hyperbolic Functions Exponential Functions Special Functions Nearest Integer Functions Remainder Functions Miscellaneous Functions Complex Functions C99 Macros
Compatibility and Portability x
Standards Conformance GCC Compatibility and Interoperability Microsoft Compatibility Port from Microsoft Visual C++* to the Intel® oneAPI DPC++/C++ Compiler Port from GCC* to the Intel® oneAPI DPC++/C++ Compiler
Port from Microsoft Visual C++* to the Intel® oneAPI DPC++/C++ Compiler x
Modify Your makefile Other Considerations
Port from GCC* to the Intel® oneAPI DPC++/C++ Compiler x
Modify Your makefiledpc Other Considerations
Intel® oneAPI DPC++/C++ Compiler Developer Guide and Reference

Additional Predefined Macros

The compiler includes predefined macros specified by the ISO/ANSI standard and it also supports the predefined macros listed in the table below.

Macro OS Support Description

__AVX__

Linux

Windows

Linux: Defined as 1 when option -march=corei7-avx, -xAVX, or higher processor targeting options are specified.

Windows: Defined as 1 when option /QxAVX or higher processor targeting options are specified.

__AVX2__

Linux

Windows

Linux: Defined as 1 when option -march=core-avx2,-xCORE-AVX2, or higher processor targeting options are specified.

Windows: Defined as 1 when option /QxCORE-AVX2 or higher processor targeting options are specified.

NOTE:

When any of the above options are specified, they also define macro AVX.

__AVX512BW__

Linux

Windows

Defined as 1 for processors that support Intel® Advanced Vector Extensions 512 (Intel® AVX-512) Byte and Word Instructions (BWI).

__AVX512CD__

Linux

Windows

Defined as 1 for processors that support Intel® Advanced Vector Extensions 512 (Intel® AVX-512) Conflict Detection Instructions (CDI).

__AVX512DQ__

Linux

Windows

Defined as 1 for processors that support Intel® Advanced Vector Extensions 512 (Intel® AVX-512) Doubleword and Quadword Instructions (DQI).

__AVX512ER__

Linux

Windows

Defined as 1 for processors that support Intel® Advanced Vector Extensions 512 (Intel® AVX-512) Exponential and Reciprocal Instructions.

__AVX512F__

Linux

Windows

Defined as 1 for processors that support Intel® Advanced Vector Extensions 512 (Intel® AVX-512) Foundation instructions.

__AVX512PF__

Linux

Windows

Defined as 1 for processors that support Intel® Advanced Vector Extensions 512 (Intel® AVX-512) PreFetch Instructions (PFI).

__AVX512VL__

Linux

Windows

Defined as 1 for processors that support Intel® Advanced Vector Extensions 512 (Intel® AVX-512) Vector Length Extensions (VLE).

__BASE_FILE__

Linux

Windows

Name of source file.

__COUNTER__

Linux

Windows

Defined as zero.

__cplusplus

Linux

Defined when compiling C++. The setting depends on which -std=c++nn option is in effect. The default is 201703L.

__ELF__

Linux

Defined as 1 at the start of compilation.

__EXCEPTIONS

Linux

Defined as 1 when C++ exceptions are enabled (default for C++). Not defined in C or when option -fno-exceptions is specified.

__gnu_linux__

Linux

Defined as 1 at the start of compilation.

__GNUC__

Linux

Defined as 4.

__GNUC_MINOR__

Linux

Defined as 2.

__GNUC_PATCHLEVEL__

Linux

Defined as 1.

__GNUG__

Linux

Defined as 4 when compiling C++.

_INTEGRAL_MAX_BITS

Windows

Defined as 64.

__INTEL_LLVM_COMPILER

Linux

Windows

The version of the compiler in the form VVVVMMUU , where VVVV is the major release version, MM is the minor release version, and UU is the update number. For example, the base release of 2023.1 is represented by the value 20230100.

This symbol is also recognized by CMake.

NOTE:
To identify the Intel® oneAPI DPC++/C++ Compiler, you must check for the existence of both __INTEL_LLVM_COMPILER and SYCL_LANGUAGE_VERSION, where SYCL_LANGUAGE_VERSION is part of the SYCL spec.

__LIBSYCL_MAJOR_VERSION

Linux

Windows

Set to the SYCL runtime library major version.

__LIBSYCL_MINOR_VERSION

Linux

Windows

Set to the SYCL runtime library minor version.

__LIBSYCL_PATCH_VERSION

Linux

Windows

Set to the SYCL runtime library patch version.

__linux__

__linux

linux

Linux

Defined as 1 at the start of compilation.

__LONG_DOUBLE_SIZE__

Linux

Windows

Linux: Defined as 80.

Windows: Defined as 64. However, if option Qlong-double is specified, it is defined as 80.

__LONG_MAX__

Linux

Windows

Linux: Defined as 9223372036854775807L.

Windows: Defined as 2147483647L.

__LP64__

Linux

Defined as 1.

_M_X64

Windows

Defined as 100.

MKL_ILP64

Linux

Windows

Defined as 1 when -qmkl-ilp64 or /Qmkl-ilp64 is specified on the command line, or when used with -fsycl -qmkl.

__MMX__

Linux

Defined as 1.

_MSC_EXTENSIONS

Windows

Defined when Microsoft extensions are enabled.

_MSC_FULL_VER

Windows

The Visual C++ version being used.

_MSC_VER

Windows

The Visual C++ version being used.

_MT

Windows

Defined as 1 when a multithreaded dynamic-link library (DLL) is used (that is, when option /MD[d] or /MT[d] is specified).

__NO_MATH_INLINES

Linux

Windows

Defined as 1.

_OPENMP

Linux

Windows

The default is 201811 when you specify option [q or Q]openmp.

__OPTIMIZE__

Linux

Windows

Defined as 1 when optimization is used.

Not defined if option -O0 is specified or in effect.

__pentium4

__pentium4__

Linux

Defined as 1.

__PIC__

__pic__

Linux

Windows

Linux: Defined as 1 when option -fpic is specified.

Windows: Defined as 2.

__PTRDIFF_TYPE__

Linux

Windows

Linux: Defined as long int.

Windows: Defined as long long int.

__REGISTER_PREFIX__

Linux

Sets the prefix applied to CPU register names in assembly language. 

RESTRICT_WRITE_ACCESS_TO_CONSTANT_PTR

Linux

Windows

Due to implementation limitations, writing to raw pointers obtained from constant_ptr is not diagnosed by default. You can enable diagnostics by setting the RESTRICT_WRITE_ACCESS_TO_CONSTANT_PTR macro, which allows constant_ptr to use constant pointers as underlying pointer types.

After enabling the macro, conversions from constant_ptr to raw pointers return constant pointers, and writing to const pointers is diagnosed by the front end.

This behavior does not follow the SYCL specification, since constant_ptr conversions to the underlying pointer type will return pointers without any additional qualifiers.

This macro is disabled by default.

__SIZE_TYPE__

Linux

Windows

Linux: Defined as unsigned long int.

Windows: Defined as unsigned long long int.

__SSE__

Linux

Windows

Defined as 1 for processors that support SSE instructions.

__SSE2__

Linux

Windows

Defined as 1 for processors that support Intel® SSE2 instructions.

__SSE3__

Linux

Windows

Defined as 1 for processors that support Intel® SSE3 instructions.

__SSE4_1__

Linux

Windows

Defined as 1 for processors that support Intel® SSE4 instructions.

__SSE4_2__

Linux

Windows

Defined as 1 for processors that support SSSE4 instructions.

__SSSE3__

Linux

Windows

Defined as 1 for processors that support SSSE3 instructions.

__SYCL_COMPILER_VERSION

Linux

Windows

The build date of the SYCL library, presented in the format YYYYMMDD.

NOTE:
This is only available after the SYCL library headers are included in the source code.

SYCL_LANGUAGE_VERSION

Linux

Windows

An integer reflecting the version number and revision of the SYCL language that is supported by the implementation.

Enables compliance with the SYCL 2020 specification.

SYCL_USE_NATIVE_FP_ATOMICS

Linux

Windows

Enables functions to generate built-in floating-point atomics on the target device. If the target device does not support floating-point atomics, emulated atomics are used instead.

Enabled by default for for non-FPGA SPIR-V* targets.

SYCL2020_CONFORMANT_APIS

Linux

Windows

Enables compliance with the SYCL 2020 specification. It is useful because some current implementations may be widespread and not conform to that specification.

When this macro is defined, it currently has no effect on the API.

unix

__unix

__unix__

Linux

Defined as 1.

__USER_LABEL_PREFIX__

Linux

The prefix applied to user labels in assembly language. 

__VERSION__

Linux

The compiler version string.

__WCHAR_T

Linux

Defined as 1.

_WCHAR_T_DEFINED

Windows

Defined when option /Zc:wchar_t is specified or wctype_t is defined in the header file.

__WCHAR_TYPE__

Linux

Windows

Linux: Defined as int.

Windows: Defined as unsigned short int.

_WCTYPE_T_DEFINED

Windows

Defined when wctype_t is defined in the header file.

_WIN64

Windows

Defined as 1.

__WINT_TYPE__

Linux

Windows

Linux: Defined as unsigned int.

Windows: Defined as unsigned short int.

__x86_64

__x86_64__

Linux

Defined as 1.

Parent topic: Macros

See Also

arch compiler option
march compiler option
m compiler option
D compiler option
U compiler option
qopenmp, Qopenmp compiler option
x, Qx compiler option
Level Two Title