================ @@ -0,0 +1,64 @@ +==================== +Clang nvlink Wrapper +==================== + +.. contents:: + :local: + +.. _clang-nvlink-wrapper: + +Introduction +============ + +This tools works as a wrapper around the NVIDIA ``nvlink`` linker. The purpose +of this wrapper is to provide an interface similar to the ``ld.lld`` linker +while still relying on NVIDIA's proprietary linker to produce the final output. +Features include, static archive (.a) linking, LTO, and accepting files ending +in ``.o`` without error. + +Usage +===== + +This tool can be used with the following options. Any arguments not intended +only for the linker wrapper will be forwarded to ``nvlink``. + +.. code-block:: console + + OVERVIEW: A utility that wraps around the NVIDIA 'nvlink' linker. + This enables static linking and LTO handling for NVPTX targets. + + USAGE: clang-nvlink-wrapper [options] <options to passed to nvlink> + + OPTIONS: + --arch <value> Specify the 'sm_' name of the target architecture. + --cuda-path=<dir> Set the system CUDA path + --dry-run Print generated commands without running. + --feature <value> Specify the '+ptx' freature to use for LTO. + -g Specify that this was a debug compile. + -help-hidden Display all available options + -help Display available options (--help-hidden for more) + -L <dir> Add <dir> to the library search path + -l <libname> Search for library <libname> + -mllvm <arg> Arguments passed to LLVM, including Clang invocations, for which the '-mllvm' prefix is preserved. Use '-mllvm --help' for a list of options. + -o <path> Path to file to write output + --plugin-opt=jobs=<value> + Number of LTO codegen partitions + --plugin-opt=lto-partitions=<value> + Number of LTO codegen partitions + --plugin-opt=O<O0, O1, O2, or O3> + Optimization level for LTO + --plugin-opt=thinlto<value> + Enable the thin-lto backend + --plugin-opt=<value> Options passed to LLVM, not including the Clang invocation. Use '--plugin-opt=--help' for a list of options. + --save-temps Save intermediate results + --version Display the version number and exit + -v Print verbose information + +Example +======= + +This tool is intended to be invoked when targeting the NVPTX toolchain directly. ---------------- Artem-B wrote:
Does it mean "intended to be invoked **only** from direct compilation targeting NVPTX" ? Or do you foresee other potential use cases? https://github.com/llvm/llvm-project/pull/96561 _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
