encounter
/
dawn-cmake
mirror of https://github.com/encounter/dawn-cmake.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
CMake-only fork of https://dawn.googlesource.com/dawn with cleaned, vendored dependencies
854 Commits 2 Branches 0 Tags 145 MiB
C++ 59.9%
HLSL 18.2%
GLSL 17.3%
Go 2.1%
Objective-C++ 0.8%
Other 1.6%
Go to file
Ben Clayton adb10d60de Add option and target for generating code cov info 
The new `tint-generate-coverage` CMake target can be used with the clang toolchain to generate a `lcov.info` file at the root of the project, along with a `coverage.summary` human readable plain text file.

The `lcov.info` file can then be used by various tools to display code coverage information in your IDE / code editor.

Useful for ensuring decent test coverage.

Change-Id: I3d846f6da3af25d3d600d8e028f27b89e35b545f
Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/31121
Commit-Queue: Ben Clayton <bclayton@google.com>
Commit-Queue: dan sinclair <dsinclair@chromium.org>
Reviewed-by: dan sinclair <dsinclair@chromium.org>
 		2020-10-27 21:04:59 +00:00
build_overrides Remove binutils from DEPS and pull in changes to build.gni from Dawn 2020-07-28 17:57:53 +00:00
docs doc/arch.md: say when numeric parameters are checked 2020-10-08 21:18:45 +00:00
fuzzers Add SPIR-V Reader Fuzzer 2020-07-30 21:24:29 +00:00
include/tint Add getting constant ID information from Inspector 2020-10-16 02:26:54 +00:00
infra/config Remove refs.cfg. 2020-07-16 19:02:29 +00:00
samples Emit validation errors after outputing result. 2020-10-14 15:16:41 +00:00
src [ast] Add AccessControlType. 2020-10-27 18:50:59 +00:00
test [wgsl-reader] Add parsing of named structs. 2020-10-19 15:31:47 +00:00
third_party Exclude spirv-tools from the all build target. 2020-10-07 15:55:13 +00:00
tools Add option and target for generating code cov info 2020-10-27 21:04:59 +00:00
.clang-format Initial commit 2020-03-02 15:47:43 -05:00
.gitignore Add option and target for generating code cov info 2020-10-27 21:04:59 +00:00
.gn Add in basic BUILD.gn and additional DEPS 2020-04-08 20:40:25 +00:00
BUILD.gn [ast] Add AccessControlType. 2020-10-27 18:50:59 +00:00
CMakeLists.txt Add option and target for generating code cov info 2020-10-27 21:04:59 +00:00
CODE_OF_CONDUCT.md Initial commit 2020-03-02 15:47:43 -05:00
CONTRIBUTING.md Fixup the contributing file. 2020-04-06 18:43:20 +00:00
CPPLINT.cfg Adding PRESUBMIT.py with a bunch of checks turned on 2020-06-03 13:41:41 +00:00
DEPS Roll Tint dependencies 2020-10-19 15:31:17 +00:00
Doxyfile Fixup some doc and compile issues. 2020-07-24 00:11:53 +00:00
LICENSE Initial commit 2020-03-02 15:47:43 -05:00
PRESUBMIT.py Fix nit in PRESUBMIT.py 2020-06-03 16:12:09 +00:00
README.md Add support for running [chromium-style] checks in CMake builds 2020-04-28 19:27:38 +00:00
standalone.gclient Convert dependency management to using gclient 2020-03-05 15:58:27 +00:00
tint_overrides_with_defaults.gni Change the default for BUILD.gn to build all the modules 2020-07-30 18:44:04 +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.