e253cc3e55
PS1 regenerates the Bazel files.
It is recommended to review this CL with a diff from PS1.
Example output when a file does not pass the test:
tools/sk_app/CommandSet.h should add these lines:
#include "include/core/SkTypes.h"
#include "include/private/SkTArray.h"
#include "tools/skui/InputState.h"
#include "tools/skui/Key.h"
#include "tools/skui/ModifierKey.h"
namespace sk_app { class Window; }
tools/sk_app/CommandSet.h should remove these lines:
- #include "tools/sk_app/Window.h"
The full include-list for tools/sk_app/CommandSet.h:
#include "include/core/SkString.h"
#include "include/core/SkTypes.h"
#include "include/private/SkTArray.h"
#include "tools/skui/InputState.h"
#include "tools/skui/Key.h"
#include "tools/skui/ModifierKey.h"
#include <functional>
#include <vector>
class SkCanvas;
namespace sk_app { class Window; }
---
This makes use of Bazel's toolchain features
https://bazel.build/docs/cc-toolchain-config-reference#features
to allow us to configure compiler flags when compiling
individual files. This analysis is off by default, and can
be turned on with --features skia_enforce_iwyu. When enabled,
it will only be run for files that have opted in.
Example:
bazelisk build //example:hello_world_gl --config=clang \
--sandbox_base=/dev/shm --features skia_enforce_iwyu
There are two ways to opt files in:
- Add enforce_iwyu = True to a generated_cc_atom rule
- Add enforce_iwyu_on_package() to a BUILD.bazel file
(which enforces IWYU for all rules in that file)
Note that Bazel does not propagate features to dependencies
or dependents, so trying to enable the feature on cc_library
or cc_executable targets will only impact any files listed in
srcs or hdrs, not deps. This may be counter-intuitive when
compared to things like defines.
IWYU supports a mapping file, which we supply to help properly
handle things system headers (//toolchain/IWYU_mapping.imp)
Suggested Review Order:
- toolchain/build_toolchain.bzl to see how we get the IWYU
binaries into the toolchain
- toolchain/BUILD.bazel and toolchain/IWYU_mapping.imp
to see how the mapping file is made available for
all compile steps
- toolchain/clang_toolchain_config.bzl, where we define the
skia_enforce_iwyu feature to turn on any verification at
all and skia_opt_file_into_iwyu to enable the check for
specific files using a define.
- toolchain/clang_trampoline.sh, which is the toolchain is
configured to call instead of clang directly (see line 83
of clang_toolchain_config.bzl). This bash script used to
just forward all arguments directly onto clang. Now it
inspects them and either calls clang directly (if
it does not find the define in the arguments or we are
linking [bazel sometimes links with clang instead of ld])
or calls clang and then include-what-you-use. In all cases,
the trampoline sends the arguments to clang and IWYU
unchanged).
- //tools/sk_app/... to see enforcement enabled (and fixed)
for select files, as an example of that method.
- //experimental/bazel_test/... to see enforcement enabled
for all rules in a BUILD.bazel file.
- all other files.
Change-Id: I60a2ea9d5dc9955b6a8f166bd449de9e2b81a233
Bug: skia:13052
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/519776
Reviewed-by: Ben Wagner <bungeman@google.com>
Reviewed-by: Leandro Lovisolo <lovisolo@google.com>
Commit-Queue: Kevin Lubick <kjlubick@google.com>
42 lines
2.0 KiB
Bash
Executable File
42 lines
2.0 KiB
Bash
Executable File
#!/bin/bash
|
|
# Copyright 2021 Google LLC
|
|
#
|
|
# Use of this source code is governed by a BSD-style license that can be
|
|
# found in the LICENSE file.
|
|
|
|
# If compilation fails, we want to exit right away
|
|
set -e
|
|
# We only want to run include-what-you-use if SKIA_ENFORCE_IWYU_FOR_THIS_FILE is in the arguments
|
|
# passed in (i.e. the "skia_opt_file_into_iwyu" feature is enabled) and we are not linking
|
|
# (as detected by the presence of -fuse-ld).
|
|
if [[ "$@" != *SKIA_ENFORCE_IWYU_FOR_THIS_FILE* || "$@" == *use-ld* ]]; then
|
|
external/clang_linux_amd64/bin/clang $@
|
|
exit 0
|
|
else
|
|
# Now try to compile with Clang, and then verify with IWYU
|
|
external/clang_linux_amd64/bin/clang $@
|
|
# IWYU always returns a non-zero code because it doesn't produce the .o file (that's why
|
|
# we ran Clang first). As such, we do not want bash to fail after running IWYU.
|
|
set +e
|
|
# Get absolute path to the mapping file because resolving the relative path is tricky, given
|
|
# how Bazel locates the toolchain files.
|
|
MAPPING_FILE=$(realpath $(dirname ${BASH_SOURCE[0]}))"/IWYU_mapping.imp"
|
|
# IWYU always outputs something to stderr, which can be noisy if everything is fixed.
|
|
# Otherwise, we send the exact same arguments to include-what-you-use that we would for
|
|
# regular compilation with clang.
|
|
external/clang_linux_amd64/usr/bin/include-what-you-use \
|
|
-Xiwyu --mapping_file=$MAPPING_FILE $@ 2>/dev/null
|
|
# IWYU returns 2 if everything looks good. It returns some other non-zero exit code otherwise.
|
|
if [ $? -eq 2 ]; then
|
|
exit 0 # keep the build going
|
|
else
|
|
# Run IWYU again, but this time display the output. Then return non-zero to fail the build.
|
|
# These flags are a little different, but only in ways that affect what was displayed, not the
|
|
# analysis.
|
|
external/clang_linux_amd64/usr/bin/include-what-you-use \
|
|
-Xiwyu --mapping_file=$MAPPING_FILE -Xiwyu --no_comments \
|
|
-Xiwyu --quoted_includes_first -Xiwyu --verbose=3 $@
|
|
exit 1 # fail the build
|
|
fi
|
|
fi
|