[SPIR-V] Add linking of separate translation units using spirv-link

[Anastasia]

Summary

Add support of linking files compiled into SPIR-V object files using spirv-link (https://github.com/KhronosGroup/SPIRV-Tools#linker).

Examples:

clang --target=spirv64 test1.cl test2.cl

clang  --target=spirv64 test1.cl -o test1.o
clang  --target=spirv64 test1.o test2.cl -o test_app.out

This will work independently from the SPIR-V generation method (via an external tool or an internal backend) and will apply to either approach that is being used.

[Anastasia]

RFC to clang dev list: https://lists.llvm.org/pipermail/cfe-dev/2022-January/069658.html

[svenvh]

LGTM. I made some minor comments, that can be fixed before committing.

clang/docs/UsersManual.rst

3602

(or: "+the spirv-link linker")

3604

clang/lib/Driver/ToolChains/SPIRV.cpp

78

Indentation seems to be slightly off? Can be fixed on commit.

[Anastasia]

Fix is committed to remove unused variable: https://github.com/llvm/llvm-project/commit/0eef65028e8a2f3417fb19e2eb5b0cbf50600c7e

[aganea]

clang/test/Driver/spirv-toolchain.cl

71

Hello @Anastasia, this line fails on my machine. It works with `// SPLINK: spirv-link{{.*}} [[SPV1]] [[SPV2]] "-o" "a.out"
`

See output with the error:

FAIL: Clang :: Driver/spirv-toolchain.cl (579 of 81682)
******************** TEST 'Clang :: Driver/spirv-toolchain.cl' FAILED ********************
Script:
--
: 'RUN: at line 2';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x cl -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 3';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 4';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x ir -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 5';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x clcpp -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 6';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x c -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 12';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 -x cl -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 13';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 14';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 -x ir -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 15';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 -x clcpp -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 16';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 -x c -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 24';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x cl -S D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPT64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 25';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x ir -S D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPT64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 26';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x clcpp -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 27';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x c -S D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPT64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 33';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 -x cl -S D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPT32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 34';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 -x ir -S D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPT32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 35';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 -x clcpp -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPV32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 36';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 -x c -S D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPT32 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 44';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x assembler -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=ASM D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 45';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv32 -x assembler -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=ASM D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 50';   d:\git\llvm-project\release\bin\clang.exe -### --target=spirv64 -x cl -c D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl --save-temps 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=TMP D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
: 'RUN: at line 63';   d:\git\llvm-project\release\bin\clang.exe -### -target spirv64 D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl 2>&1 | d:\git\llvm-project\release\bin\filecheck.exe --check-prefix=SPLINK D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl
--
Exit Code: 1

Command Output (stdout):
--
$ ":" "RUN: at line 2"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "cl" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 3"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 4"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "ir" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 5"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "clcpp" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 6"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "c" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 12"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "-x" "cl" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 13"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 14"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "-x" "ir" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 15"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "-x" "clcpp" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 16"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "-x" "c" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 24"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "cl" "-S" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPT64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 25"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "ir" "-S" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPT64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 26"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "clcpp" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 27"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "c" "-S" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPT64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 33"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "-x" "cl" "-S" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPT32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 34"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "-x" "ir" "-S" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPT32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 35"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "-x" "clcpp" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPV32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 36"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "-x" "c" "-S" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPT32" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 44"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "assembler" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=ASM" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 45"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv32" "-x" "assembler" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=ASM" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 50"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "--target=spirv64" "-x" "cl" "-c" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl" "--save-temps"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=TMP" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ ":" "RUN: at line 63"
$ "d:\git\llvm-project\release\bin\clang.exe" "-###" "-target" "spirv64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
$ "d:\git\llvm-project\release\bin\filecheck.exe" "--check-prefix=SPLINK" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
# command stderr:
D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl:71:12: error: SPLINK: expected string not found in input
// SPLINK: {{"spirv-link.*"}} [[SPV1]] [[SPV2]] "-o" "a.out"
           ^
<stdin>:8:160: note: scanning from here
 "llvm-spirv" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-3443c4.bc" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-0aa22f.o"
                                                                                                                                                               ^
<stdin>:8:160: note: with "SPV1" equal to "\"C:\\\\\\\\Users\\\\\\\\ALEXAN~1\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\spirv-toolchain-ab01cc\\.o\""
 "llvm-spirv" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-3443c4.bc" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-0aa22f.o"
                                                                                                                                                               ^
<stdin>:8:160: note: with "SPV2" equal to "\"C:\\\\\\\\Users\\\\\\\\ALEXAN~1\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\spirv-toolchain-0aa22f\\.o\""
 "llvm-spirv" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-3443c4.bc" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-0aa22f.o"
                                                                                                                                                               ^
<stdin>:9:187: note: possible intended match here
 "c:\\scoop\\user\\apps\\vulkan\\current\\bin\\spirv-link.exe" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-ab01cc.o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-0aa22f.o" "-o" "a.out"
                                                                                                                                                                                          ^

Input file: <stdin>
Check file: D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl

-dump-input=help explains the following input dump.

Input was:
<<<<<<
            1: clang version 14.0.0 (https://github.com/llvm/llvm-project.git be7dbd674cb0cec2558e054c39be0eb098a99394)
            2: Target: spirv64
            3: Thread model: posix
            4: InstalledDir: d:\git\llvm-project\release\bin
            5:  "d:\\git\\llvm-project\\release\\bin\\clang.exe" "-cc1" "-triple" "spirv64" "-Wspir-compat" "-emit-llvm-bc" "-emit-llvm-uselists" "-disable-free" "-clear-ast-before-backend" "-main-file-name" "spirv-toolchain.cl" "-mrelocation-model" "static" "-mframe-pointer=all" "-ffp-contract=on" "-fno-rounding-math" "-fno-verbose-asm" "-mconstructor-aliases" "-debugger-tuning=gdb" "-fcoverage-compilation-dir=D:\\git\\llvm-project\\release\\tools\\clang\\test\\Driver" "-resource-dir" "d:\\git\\llvm-project\\release\\lib\\clang\\14.0.0" "-fdebug-compilation-dir=D:\\git\\llvm-project\\release\\tools\\clang\\test\\Driver" "-ferror-limit" "19" "-finclude-default-header" "-fdeclare-opencl-builtins" "-fgnuc-version=4.2.1" "-fno-threadsafe-statics" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-84db8e.bc" "-x" "cl" "D:\\git\\llvm-project\\clang\\test\\Driver\\spirv-toolchain.cl"
            6:  "llvm-spirv" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-84db8e.bc" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-ab01cc.o"
            7:  "d:\\git\\llvm-project\\release\\bin\\clang.exe" "-cc1" "-triple" "spirv64" "-Wspir-compat" "-emit-llvm-bc" "-emit-llvm-uselists" "-disable-free" "-clear-ast-before-backend" "-main-file-name" "spirv-toolchain.cl" "-mrelocation-model" "static" "-mframe-pointer=all" "-ffp-contract=on" "-fno-rounding-math" "-fno-verbose-asm" "-mconstructor-aliases" "-debugger-tuning=gdb" "-fcoverage-compilation-dir=D:\\git\\llvm-project\\release\\tools\\clang\\test\\Driver" "-resource-dir" "d:\\git\\llvm-project\\release\\lib\\clang\\14.0.0" "-fdebug-compilation-dir=D:\\git\\llvm-project\\release\\tools\\clang\\test\\Driver" "-ferror-limit" "19" "-finclude-default-header" "-fdeclare-opencl-builtins" "-fgnuc-version=4.2.1" "-fno-threadsafe-statics" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-3443c4.bc" "-x" "cl" "D:\\git\\llvm-project\\clang\\test\\Driver\\spirv-toolchain.cl"
            8:  "llvm-spirv" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-3443c4.bc" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-0aa22f.o"
check:71'0                                                                                                                                                                    X error: no match found
check:71'1                                                                                                                                                                      with "SPV1" equal to "\"C:\\\\\\\\Users\\\\\\\\ALEXAN~1\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\spirv-toolchain-ab01cc\\.o\""
check:71'2                                                                                                                                                                      with "SPV2" equal to "\"C:\\\\\\\\Users\\\\\\\\ALEXAN~1\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\spirv-toolchain-0aa22f\\.o\""
            9:  "c:\\scoop\\user\\apps\\vulkan\\current\\bin\\spirv-link.exe" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-ab01cc.o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-0aa22f.o" "-o" "a.out"
check:71'0     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
check:71'3                                                                                                                                                                                               ?                              possible intended match
>>>>>>

error: command failed with exit status: 1

--

********************
Testing:  0.. 10.. 20.. 30.. 40.. 50.. 60.. 70.. 80.. 90..
********************
Failed Tests (1):
  Clang :: Driver/spirv-toolchain.cl

If I just run that command:

D:\git\llvm-project> "d:\git\llvm-project\release\bin\clang.exe" "-###" "-target" "spirv64" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl" "D:\git\llvm-project\clang\test\Driver\spirv-toolchain.cl"
clang version 14.0.0 (https://github.com/llvm/llvm-project.git be7dbd674cb0cec2558e054c39be0eb098a99394)
Target: spirv64
Thread model: posix
InstalledDir: d:\git\llvm-project\release\bin
 "d:\\git\\llvm-project\\release\\bin\\clang.exe" "-cc1" "-triple" "spirv64" "-Wspir-compat" "-emit-llvm-bc" "-emit-llvm-uselists" "-disable-free" "-clear-ast-before-backend" "-main-file-name" "spirv-toolchain.cl" "-mrelocation-model" "static" "-mframe-pointer=all" "-ffp-contract=on" "-fno-rounding-math" "-fno-verbose-asm" "-mconstructor-aliases" "-debugger-tuning=gdb" "-fcoverage-compilation-dir=D:\\git\\llvm-project" "-resource-dir" "d:\\git\\llvm-project\\release\\lib\\clang\\14.0.0" "-fdebug-compilation-dir=D:\\git\\llvm-project" "-ferror-limit" "19" "-fmessage-length=167" "-finclude-default-header" "-fdeclare-opencl-builtins" "-fgnuc-version=4.2.1" "-fno-threadsafe-statics" "-fcolor-diagnostics" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-6356aa.bc" "-x" "cl" "D:\\git\\llvm-project\\clang\\test\\Driver\\spirv-toolchain.cl"
 "llvm-spirv" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-6356aa.bc" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-0c9f09.o"
 "d:\\git\\llvm-project\\release\\bin\\clang.exe" "-cc1" "-triple" "spirv64" "-Wspir-compat" "-emit-llvm-bc" "-emit-llvm-uselists" "-disable-free" "-clear-ast-before-backend" "-main-file-name" "spirv-toolchain.cl" "-mrelocation-model" "static" "-mframe-pointer=all" "-ffp-contract=on" "-fno-rounding-math" "-fno-verbose-asm" "-mconstructor-aliases" "-debugger-tuning=gdb" "-fcoverage-compilation-dir=D:\\git\\llvm-project" "-resource-dir" "d:\\git\\llvm-project\\release\\lib\\clang\\14.0.0" "-fdebug-compilation-dir=D:\\git\\llvm-project" "-ferror-limit" "19" "-fmessage-length=167" "-finclude-default-header" "-fdeclare-opencl-builtins" "-fgnuc-version=4.2.1" "-fno-threadsafe-statics" "-fcolor-diagnostics" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-1794d3.bc" "-x" "cl" "D:\\git\\llvm-project\\clang\\test\\Driver\\spirv-toolchain.cl"
 "llvm-spirv" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-1794d3.bc" "-o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-facf65.o"
 "C:\\Scoop\\user\\apps\\vulkan\\current\\Bin\\spirv-link.exe" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-0c9f09.o" "C:\\Users\\ALEXAN~1\\AppData\\Local\\Temp\\spirv-toolchain-facf65.o" "-o" "a.out"

[svenvh]

clang/test/Driver/spirv-toolchain.cl

71

I have just committed a fix for that: 4b14fc6fe5a7 ("[SPIR-V] Drop double quote from test pattern", 2022-01-11)

[aganea]

clang/test/Driver/spirv-toolchain.cl

71

Great, thanks!

[bader]

clang/docs/UsersManual.rst

3602

@Anastasia, sorry for late feedback.
I think being able to link SPIR-V modules is a great feature, but I have a concerns regarding spirv-link tool.
The documentation says that the linker tool is still under development and from our experience this tool had issues blocking us from using it for SYCL mode. The last time new features were added to this tool is almost 4 year ago.
Do you know if there are any plans for to finish the development and if ? Are you aware of any "real-world usages" of this tool? Have you tried to use it for SPIR-V module produced from C++ (e.g. C++ for OpenCL)?
I think supporting SPIR-V extensions like SPV_KHR_linkonce_odr is quite important for code size and JIT compilation time reduction. As this extension was ratified recently, I suppose spirv-link doesn't support it yet.

[Anastasia]

clang/docs/UsersManual.rst

3602

Hi Alexey,

Sorry for the late reply. Do you have any other suggestions about the tools that can be used for linking SPIR-V binaries?

I am not in contact with the maintainers but it is an open-source project so I imagine contributions to enhance or improve functionality should be welcome... unless you have other experiences?

[bader]

clang/docs/UsersManual.rst

3602

Do you have any other suggestions about the tools that can be used for linking SPIR-V binaries?

I'm unaware of other tools for SPIR-V binaries linking. To link SPIR-V binaries in our toolchain, we translate them to/from LLVM IR to link LLVM IR.

I am not in contact with the maintainers but it is an open-source project so I imagine contributions to enhance or improve functionality should be welcome... unless you have other experiences?

I talked to the maintainers (but it was quite long time ago) and they told me that there are no active contributors to this tool.

clang/docs/UsersManual.rst

 `test.o` for 32 bit and 64 bit respectively. This file can be imported
 by an OpenCL driver that support SPIR-V consumption or it can be compiled
 further by offline SPIR-V consumer tools.
 
 Converting to SPIR-V produced with the optimization levels other than `-O0` is
 currently available as an experimental feature and it is not guaranteed to work
 in all cases.
 
+Linking is done using ``spirv-link`` from `the SPIRV-Tools project
+<https://github.com/KhronosGroup/SPIRV-Tools#linker>`_. Similar to other external
+linkers, Clang will expect ``spirv-link`` to be installed separately and to be
+present in the ``PATH`` environment variable. Please refer to `the build and
+installation instructions
+<https://github.com/KhronosGroup/SPIRV-Tools#build>`_.
+
 .. _clang-cl:
 
 clang-cl
 ========
 
 clang-cl is an alternative command-line interface to Clang, designed for
 compatibility with the Visual C++ compiler, cl.exe.
 

clang/include/clang/Basic/DiagnosticDriverKinds.td

 def warn_drv_unsupported_option_for_offload_arch_req_feature : Warning<
   "ignoring '%0' option as it is not currently supported for "
   "offload arch '%1'. Use it with an offload arch containing '%2' instead">,
   InGroup<OptionIgnored>;
 def warn_drv_unsupported_option_for_target : Warning<
   "ignoring '%0' option as it is not currently supported for target '%1'">,
   InGroup<OptionIgnored>;
 
-def warn_drv_spirv_linking_multiple_inputs_unsupported: Warning<
-  "Linking multiple input files is not supported for SPIR-V yet">,
-  InGroup<OptionIgnored>;
-
 def err_drv_invalid_thread_model_for_target : Error<
   "invalid thread model '%0' in '%1' for this target">;
 def err_drv_invalid_linker_name : Error<
   "invalid linker name in argument '%0'">;
 def err_drv_invalid_rtlib_name : Error<
   "invalid runtime library name in argument '%0'">;
 def err_drv_unsupported_rtlib_for_platform : Error<
   "unsupported runtime library '%0' for platform '%1'">;

clang/lib/Driver/Driver.cpp

void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
   if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
     if (A->getValue()[0] == '\0') {
       // It has to have a value.
       Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
       Args.eraseArg(options::OPT__SLASH_o);
     }
   }
 
-  // FIXME: Linking separate translation units for SPIR-V is not supported yet.
-  // It can be done either by LLVM IR linking before conversion of the final
-  // linked module to SPIR-V or external SPIR-V linkers can be used e.g.
-  // spirv-link.
-  if (C.getDefaultToolChain().getTriple().isSPIRV() && Inputs.size() > 1) {
-    Diag(clang::diag::warn_drv_spirv_linking_multiple_inputs_unsupported);
-  }
-
   handleArguments(C, Args, Inputs, Actions);
 
   // Builder to be used to build offloading actions.
   OffloadingActionBuilder OffloadBuilder(C, Args, Inputs);
 
   // Construct the actions to perform.
   HeaderModulePrecompileJobAction *HeaderModuleAction = nullptr;
   ActionList LinkerInputs;
for (phases::ID Phase : PL) {
       Current = OffloadBuilder.addDeviceDependencesToHostAction(
           Current, InputArg, Phase, PL.back(), FullPL);
       if (!Current)
         break;
 
       // Queue linker inputs.
       if (Phase == phases::Link) {
         assert(Phase == PL.back() && "linking must be final compilation step.");
-        // Compilation phases are setup per language, however for SPIR-V the
-        // final linking phase is meaningless since the compilation phase
-        // produces the final binary.
-        // FIXME: OpenCL - we could strip linking phase out from OpenCL
-        // compilation phases if we could verify it is not needed by any target.
-        if (!C.getDefaultToolChain().getTriple().isSPIRV()) {
-          LinkerInputs.push_back(Current);
-          Current = nullptr;
-        }
         break;
       }
 
       // TODO: Consider removing this because the merged may not end up being
       // the final Phase in the pipeline. Perhaps the merged could just merge
       // and then pass an artifact of some sort to the Link Phase.
       // Queue merger inputs.
       if (Phase == phases::IfsMerge) {

clang/lib/Driver/ToolChains/SPIRV.h

public:
   bool hasIntegratedAssembler() const override { return true; }
 
   void ConstructJob(Compilation &C, const JobAction &JA,
                     const InputInfo &Output, const InputInfoList &Inputs,
                     const llvm::opt::ArgList &TCArgs,
                     const char *LinkingOutput) const override;
 };
 
+class LLVM_LIBRARY_VISIBILITY Linker : public Tool {
+public:
+  Linker(const ToolChain &TC) : Tool("SPIRV::Linker", "spirv-link", TC) {}
+  bool hasIntegratedCPP() const override { return false; }
+  bool isLinkJob() const override { return true; }
+  void ConstructJob(Compilation &C, const JobAction &JA,
+                    const InputInfo &Output, const InputInfoList &Inputs,
+                    const llvm::opt::ArgList &TCArgs,
+                    const char *LinkingOutput) const override;
+};
+
 } // namespace SPIRV
 } // namespace tools
 
 namespace toolchains {
 
 class LLVM_LIBRARY_VISIBILITY SPIRVToolChain final : public ToolChain {
   mutable std::unique_ptr<Tool> Translator;
 
public:
   }
   bool isPICDefaultForced() const override { return false; }
   bool SupportsProfiling() const override { return false; }
 
   clang::driver::Tool *SelectTool(const JobAction &JA) const override;
 
 protected:
   clang::driver::Tool *getTool(Action::ActionClass AC) const override;
+  Tool *buildLinker() const override;
 
 private:
   clang::driver::Tool *getTranslator() const;
 };
 
 } // namespace toolchains
 } // namespace driver
 } // namespace clang
 #endif

clang/lib/Driver/ToolChains/SPIRV.cpp

clang::driver::Tool *SPIRVToolChain::getTool(Action::ActionClass AC) const {
   default:
     break;
   case Action::BackendJobClass:
   case Action::AssembleJobClass:
     return SPIRVToolChain::getTranslator();
   }
   return ToolChain::getTool(AC);
 }
+clang::driver::Tool *SPIRVToolChain::buildLinker() const {
+  return new tools::SPIRV::Linker(*this);
+}
+
+void SPIRV::Linker::ConstructJob(Compilation &C, const JobAction &JA,
+                                 const InputInfo &Output,
+                                 const InputInfoList &Inputs,
+                                 const ArgList &Args,
+                                 const char *LinkingOutput) const {
+  const ToolChain &ToolChain = getToolChain();
+  const Driver &D = ToolChain.getDriver();
+  std::string Linker = ToolChain.GetProgramPath(getShortName());
+  ArgStringList CmdArgs;
+  AddLinkerInputs(getToolChain(), Inputs, Args, CmdArgs, JA);
+
+  CmdArgs.push_back("-o");
+  CmdArgs.push_back(Output.getFilename());
+
+  C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
+                                         Args.MakeArgString(Linker), CmdArgs,
+                                         Inputs, Output));
+}

clang/test/Driver/spirv-toolchain.cl

 // TMP-SAME: "-o" [[I:".*i"]]
 // TMP: "-cc1" "-triple" "spirv64"
 // TMP-SAME: "-o" [[BC:".*bc"]]
 // TMP-SAME: [[I]]
 // TMP: {{llvm-spirv.*"}} [[BC]] "--spirv-tools-dis" "-o" [[S:".*s"]]
 // TMP: {{llvm-spirv.*"}} [[S]] "-to-binary" "-o" {{".*o"}}
 
 //-----------------------------------------------------------------------------
-// Check that warning occurs if multiple input files are passed.
-// RUN: %clang -### --target=spirv64 %s %s 2>&1 | FileCheck --check-prefix=WARN %s
+// Check linking when multiple input files are passed.
+// RUN: %clang -### -target spirv64 %s %s 2>&1 | FileCheck --check-prefix=SPLINK %s
 
-// WARN: warning: Linking multiple input files is not supported for SPIR-V yet
+// SPLINK: clang{{.*}} "-cc1" "-triple" "spirv64"
+// SPLINK-SAME: "-o" [[BC:".*bc"]]
+// SPLINK: {{llvm-spirv.*"}} [[BC]] "-o" [[SPV1:".*o"]]
+// SPLINK: clang{{.*}} "-cc1" "-triple" "spirv64"
+// SPLINK-SAME: "-o" [[BC:".*bc"]]
+// SPLINK: {{llvm-spirv.*"}} [[BC]] "-o" [[SPV2:".*o"]]
+// SPLINK: {{"spirv-link.*"}} [[SPV1]] [[SPV2]] "-o" "a.out"