.. index:: pair: page; Linking to the Library .. _doxid-dev_guide_link: Linking to the Library ====================== oneDNN includes several header files providing C and C++ APIs for the functionality and one or several libraries depending on how oneDNN was built. Header Files ~~~~~~~~~~~~ ============================================================================== ================================== File Description ============================================================================== ================================== ``include/oneapi/dnnl/dnnl.h`` C header ``include/oneapi/dnnl/dnnl.hpp`` C++ header ``include/oneapi/dnnl/dnnl_types.h`` Auxiliary C header ``include/oneapi/dnnl/dnnl_config.h`` Auxiliary C header ``include/oneapi/dnnl/dnnl_version.h`` C header with version information ``include/oneapi/dnnl/dnnl_graph.h`` C header for graph API ``:ref:`include/oneapi/dnnl/dnnl_graph.hpp ``` C++ header for graph API ``include/oneapi/dnnl/dnnl_graph_types.h`` Auxiliary C header for graph API ============================================================================== ================================== Libraries ~~~~~~~~~ Linux ----- =============== ==================================================================== File Description =============== ==================================================================== lib/libdnnl.so oneDNN dynamic library lib/libdnnl.a oneDNN static library (if built with ``DNNL_LIBRARY_TYPE=STATIC`` ) =============== ==================================================================== macOS ----- ================== ==================================================================== File Description ================== ==================================================================== lib/libdnnl.dylib oneDNN dynamic library lib/libdnnl.a oneDNN static library (if built with ``DNNL_LIBRARY_TYPE=STATIC`` ) ================== ==================================================================== Windows ------- ============= ============================================================================================== File Description ============= ============================================================================================== bin\dnnl.dll oneDNN dynamic library lib\dnnl.lib oneDNN import or full static library (the latter if built with ``DNNL_LIBRARY_TYPE=STATIC`` ) ============= ============================================================================================== Linking to oneDNN ~~~~~~~~~~~~~~~~~ The examples below assume that oneDNN is installed in the directory defined in the ``DNNLROOT`` environment variable. Linux/macOS ----------- .. ref-code-block:: cpp g++ -I${DNNLROOT}/include -L${DNNLROOT}/lib getting_started.cpp -ldnnl clang++ -I${DNNLROOT}/include -L${DNNLROOT}/lib getting_started.cpp -ldnnl icpx -I${DNNLROOT}/include -L${DNNLROOT}/lib getting_started.cpp -ldnnl .. note:: Applications linked dynamically will resolve the dependencies at runtime. Make sure that the dependencies are available in the standard locations defined by the operating system, in the locations listed in the ``LD_LIBRARY_PATH`` (Linux) or ``DYLD_LIBRARY_PATH`` (macOS) environment variable or the ``rpath`` mechanism. Support for macOS hardened runtime ++++++++++++++++++++++++++++++++++ oneDNN requires the `com.apple.security.cs.allow-jit `__ entitlement when it is integrated with an application that uses the macOS `hardened runtime `__. This requirement comes from the fact that oneDNN generates code on the fly and then executes it. It can be enabled in Xcode or passed to ``codesign`` like this: .. ref-code-block:: cpp codesign -s "Your identity" --options runtime --entitlements Entitlements.plist [other options...] /path/to/libdnnl.dylib Example ``Entitlements.plist`` : .. ref-code-block:: cpp com.apple.security.cs.allow-jit Windows ------- The examples below assume that oneDNN is installed in the directory defined in the ``DNNLROOT`` environment variable. .. ref-code-block:: cpp icx /EHa /I"%DNNLROOT%\include" getting_started.cpp "%DNNLROOT%\lib\dnnl.lib" cl /EHa /I"%DNNLROOT%\include" getting_started.cpp "%DNNLROOT%\lib\dnnl.lib" .. note:: You may also add paths to oneDNN headers and libraries to ``LIB`` and ``INCLUDE`` environment variables instead of specifying these in the build command. Refer to the `Microsoft Visual Studio documentation `__ on linking the application using MSVS solutions. .. note:: Applications linked dynamically will resolve the dependencies at runtime. Make sure that the dependencies are available in the standard locations defined by the operating system or in the locations listed in the ``PATH`` environment variable.