CMake-only fork of https://dawn.googlesource.com/dawn with cleaned, vendored dependencies
Go to file
Antonio Maiorano 8bc1a3045d HLSL: workaround FXC sometimes failing with 'not all control paths return a result' in functions with discard
To fix this, we trick the compiler by wrapping the function body with an
if (true) { <function body> } followed by returning an unused value of
the return type.

Bug: tint:1081
Change-Id: I763bf768f40d07a1045f0a70017bb40d488c8428
Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/68822
Kokoro: Kokoro <noreply+kokoro@google.com>
Reviewed-by: Ben Clayton <bclayton@google.com>
Commit-Queue: Antonio Maiorano <amaiorano@google.com>
2021-11-10 14:38:34 +00:00
.vscode .vscode: Fix quotations in windows 'configure' task 2021-07-21 13:24:21 +00:00
build_overrides GLSL writer: validate all entry points with glslang. 2021-10-14 14:39:36 +00:00
docs docs: Add a doc about end-to-end testing 2021-11-05 22:47:16 +00:00
fuzzers ast: Rename ArrayAccessorExpression to IndexAccessorExpression 2021-11-09 09:35:00 +00:00
include/tint Implement GLSL writer backend. 2021-10-06 18:55:10 +00:00
infra/config Infra: Use Python 3 for the Tint recipe 2021-11-01 19:00:52 +00:00
kokoro Kokoro: Move the clean checkout to tmpfs 2021-09-20 19:30:35 +00:00
samples main: Return non-zero status code on GLSL validation error 2021-11-05 22:45:23 +00:00
src HLSL: workaround FXC sometimes failing with 'not all control paths return a result' in functions with discard 2021-11-10 14:38:34 +00:00
test HLSL: workaround FXC sometimes failing with 'not all control paths return a result' in functions with discard 2021-11-10 14:38:34 +00:00
third_party GLSL writer: validate all entry points with glslang. 2021-10-14 14:39:36 +00:00
tools test-runner: don't generate for excluded paths on Windows 2021-11-10 14:34:55 +00:00
.clang-format Initial commit 2020-03-02 15:47:43 -05:00
.gitignore GLSL writer: validate all entry points with glslang. 2021-10-14 14:39:36 +00:00
.gn Get `gn gen --check` actually working in repo 2021-04-21 19:05:14 +00:00
AUTHORS Add spirv-tools fuzzer 2021-06-24 18:10:46 +00:00
BUILD.gn BUILD.gn: Remove the temporary group with Dawn migrated. 2021-03-17 07:41:03 +00:00
CMakeLists.txt CMakeLists: Make it easier to override options 2021-10-15 19:10:50 +00:00
CMakeSettings.json Add CMakeSettings.json with convenient defaults 2021-03-16 18:52:53 +00:00
CODE_OF_CONDUCT.md Initial commit 2020-03-02 15:47:43 -05:00
CONTRIBUTING.md Add a style guide 2021-04-08 15:10:47 +00:00
CPPLINT.cfg Adding PRESUBMIT.py with a bunch of checks turned on 2020-06-03 13:41:41 +00:00
DEPS GLSL writer: validate all entry points with glslang. 2021-10-14 14:39:36 +00:00
Doxyfile Implement AST fuzzer 2021-07-13 12:01:25 +00:00
LICENSE Initial commit 2020-03-02 15:47:43 -05:00
OWNERS Reduce OWNERS to 4 people 2021-08-24 09:59:31 +00:00
PRESUBMIT.py Force Python 3 in presubmit 2021-07-20 17:16:31 +00:00
README.md Proposed process for experimental extensions 2021-04-27 17:55:07 +00:00
standalone.gclient Convert dependency management to using gclient 2020-03-05 15:58:27 +00:00
tint_overrides_with_defaults.gni Implement GLSL writer backend. 2021-10-06 18:55:10 +00:00

README.md

Tint

Tint is a compiler for the WebGPU Shader Language (WGSL).

This is not an officially supported Google product.

Requirements

  • Git
  • CMake (3.10.2 or later)
  • Ninja (or other build tool)
  • Python, for fetching dependencies
  • depot_tools in your path

Build options

  • TINT_BUILD_SPV_READER : enable the SPIR-V input reader (off by default)
  • TINT_BUILD_WGSL_READER : enable the WGSL input reader (on by default)
  • TINT_BUILD_SPV_WRITER : enable the SPIR-V output writer (on by default)
  • TINT_BUILD_WGSL_WRITER : enable the WGSL output writer (on by default)
  • TINT_BUILD_FUZZERS : enable building fuzzzers (off by default)

Building

Tint uses Chromium dependency management so you need to install depot_tools and add it to your PATH.

Getting source & dependencies

# Clone the repo as "tint"
git clone https://dawn.googlesource.com/tint tint
cd tint

# Bootstrap the gclient configuration
cp standalone.gclient .gclient

# Fetch external dependencies and toolchains with gclient
gclient sync

Compiling using CMake + Ninja

mkdir -p out/Debug
cd out/Debug
cmake -GNinja ../..
ninja # or autoninja

Compiling using CMake + make

mkdir -p out/Debug
cd out/Debug
cmake ../..
make # -j N for N-way parallel build

Compiling using gn + ninja

mkdir -p out/Debug
gn gen out/Debug
autoninja -C out/Debug

Fuzzers on MacOS

If you are attempting fuzz, using TINT_BUILD_FUZZERS=ON, the version of llvm in the XCode SDK does not have the needed libfuzzer functionality included.

The build error that you will see from using the XCode SDK will look something like this:

ld: file not found:/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/11.0.0/lib/darwin/libclang_rt.fuzzer_osx.a

The solution to this problem is to use a full version llvm, like what you would get via homebrew, brew install llvm, and use something like CC=<path to full clang> cmake .. to setup a build using that toolchain.

Checking [chromium-style] issues in CMake builds

The gn based work flow uses the Chromium toolchain for building in anticipation of integration of Tint into Chromium based projects. This toolchain has additional plugins for checking for style issues, which are marked with [chromium-style] in log messages. This means that this toolchain is more strict then the default clang toolchain.

In the future we will have a CQ that will build this work flow and flag issues automatically. Until that is in place, to avoid causing breakages you can run the [chromium-style] checks using the CMake based work flows. This requires setting CC to the version of clang checked out by gclient sync and setting the TINT_CHECK_CHROMIUM_STYLE to ON.

mkdir -p out/style
cd out/style
cmake ../..
CC=../../third_party/llvm-build/Release+Asserts/bin/clang cmake -DTINT_CHECK_CHROMIUM_STYLE=ON ../../ # add -GNinja for ninja builds

Issues

Please file any issues or feature requests at https://bugs.chromium.org/p/tint/issues/entry

Contributing

Please see the CONTRIBUTING and CODE_OF_CONDUCT files on how to contribute to Tint.

Tint has a process for supporting experimental extensions.