Ground work for cuda-related checks in clang-tidy

[barcisz]

Summary

This diff adds support for adding CUDA checks to clang-tidy, as well as tests for those checks. This is in preparation for the checks introduced in D133804 and D133956, both of which were
developed by Meta (formerly Facebook). The cuda-unused

[tschuett]

clang-tools-extra/clang-tidy/cuda/CudaTidyModule.cpp

26

Is Google a copy and paste error?

33

Is Google a copy and paste error?

[ivanmurashko]

clang-tools-extra/test/lit.cfg.py

19 ↗

(On Diff #458497)

.cu is specified several times there. It looks like the change is not necessary at the line

[barcisz]

Fixed a copy-paste error with Google->Cuda in CudaTidyModule.cpp

[barcisz]

removed duplication of '.cu' in the lit config for clang-tidy tests

[barcisz]

clang-tools-extra/clang-tidy/cuda/CudaTidyModule.cpp

26

Done

33

Done

clang-tools-extra/test/lit.cfg.py

19 ↗

(On Diff #458497)

Done

[barcisz]

@tschuett does it look alright now?

[barcisz]

Better explanation of cuda-related flags in tests

[barcisz]

Common documentation for cuda checks

[njames93]

What's with the .keep files. Will lit or sphinx fail if the cuda directory doesn't exist, if not I'd be happier removing them(they'd get removed once the first cuda check lands anyway).

clang-tools-extra/clang-tidy/cuda/CudaTidyModule.cpp

2

Google...

It may be easier/safer to use the add_new_check script to generate this, then just remove all the new check specific files.

clang-tools-extra/docs/ReleaseNotes.rst

98–100

Put it in here.

154

This line doesn't belong in the new checks portion of the release notes, just stick it in the general clang-tidy section.
Also maybe just say "Introduce the cuda module for checks specific to cuda code" and remove all the documentation below, That will be filled in when the first check lands.

clang-tools-extra/docs/clang-tidy/index.rst

143

Unnecessary edit can be removed.

241

Ditto.

clang-tools-extra/test/clang-tidy/checkers/Inputs/Headers/cuda/cuda-initializers.h

1 ↗

(On Diff #460070)

What's the purpose of this file here, do you envision many checks requiring to include this?

clang-tools-extra/test/clang-tidy/checkers/Inputs/Headers/cuda/cuda.h

4

This looks worrying as test cases don't run with a standard library

[barcisz]

Changes suggested by njames93

[barcisz]

Dummy definition for size_t

[barcisz]

moved size_t definition to an stddef.h stub

[njames93]

clang-tools-extra/test/clang-tidy/checkers/Inputs/Headers/stddef.h

12 ↗

(On Diff #460520)

If this is all the file is used for, and it's only used for this one test file, can probably remove this header and inline the definition.
I also feel this definition may be fragile on certain platforms.

[barcisz]

clang-tools-extra/test/clang-tidy/checkers/Inputs/Headers/stddef.h

12 ↗

(On Diff #460520)

I wanted to add it in a separate header for future proofness; as for the definition, I cannot really use uint64_t here since I cannot include the real stddef.h

[aaron.ballman]

clang-tools-extra/test/clang-tidy/checkers/Inputs/Headers/stddef.h

12 ↗

(On Diff #460520)

using size_t = decltype(sizeof(0)); is a better way to spell this, and I'd probably inline it rather than add a new header file.

[barcisz]

Inlined definition of size_t

clang-tools-extra/clang-tidy/CMakeLists.txt

 add_subdirectory(android)
 add_subdirectory(abseil)
 add_subdirectory(altera)
 add_subdirectory(boost)
 add_subdirectory(bugprone)
 add_subdirectory(cert)
 add_subdirectory(concurrency)
 add_subdirectory(cppcoreguidelines)
+add_subdirectory(cuda)
 add_subdirectory(darwin)
 add_subdirectory(fuchsia)
 add_subdirectory(google)
 add_subdirectory(hicpp)
 add_subdirectory(linuxkernel)
 add_subdirectory(llvm)
 add_subdirectory(llvmlibc)
 add_subdirectory(misc)
set(ALL_CLANG_TIDY_CHECKS
   clangTidyAndroidModule
   clangTidyAbseilModule
   clangTidyAlteraModule
   clangTidyBoostModule
   clangTidyBugproneModule
   clangTidyCERTModule
   clangTidyConcurrencyModule
   clangTidyCppCoreGuidelinesModule
+  clangTidyCudaModule
   clangTidyDarwinModule
   clangTidyFuchsiaModule
   clangTidyGoogleModule
   clangTidyHICPPModule
   clangTidyLinuxKernelModule
   clangTidyLLVMModule
   clangTidyLLVMLibcModule
   clangTidyMiscModule

clang-tools-extra/clang-tidy/ClangTidyForceLinker.h

 static int LLVM_ATTRIBUTE_UNUSED ConcurrencyModuleAnchorDestination =
     ConcurrencyModuleAnchorSource;
 
 // This anchor is used to force the linker to link the CppCoreGuidelinesModule.
 extern volatile int CppCoreGuidelinesModuleAnchorSource;
 static int LLVM_ATTRIBUTE_UNUSED CppCoreGuidelinesModuleAnchorDestination =
     CppCoreGuidelinesModuleAnchorSource;
 
+// This anchor is used to force the linker to link the CudaModule.
+extern volatile int CudaModuleAnchorSource;
+static int LLVM_ATTRIBUTE_UNUSED CudaModuleAnchorDestination =
+    CudaModuleAnchorSource;
+
 // This anchor is used to force the linker to link the DarwinModule.
 extern volatile int DarwinModuleAnchorSource;
 static int LLVM_ATTRIBUTE_UNUSED DarwinModuleAnchorDestination =
     DarwinModuleAnchorSource;
 
 // This anchor is used to force the linker to link the FuchsiaModule.
 extern volatile int FuchsiaModuleAnchorSource;
 static int LLVM_ATTRIBUTE_UNUSED FuchsiaModuleAnchorDestination =

clang-tools-extra/clang-tidy/cuda/CMakeLists.txt

+add_clang_library(clangTidyCudaModule
+  CudaTidyModule.cpp
+  LINK_LIBS
+  clangTidy
+  clangTidyUtils
+  )
+
+clang_target_link_libraries(clangTidyAlteraModule
+  PRIVATE
+  clangAnalysis
+  clangAST
+  clangASTMatchers
+  clangBasic
+  clangLex
+  )

clang-tools-extra/clang-tidy/cuda/CudaTidyModule.cpp

+//===--- CudaTidyModule.cpp - clang-tidy --------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "../ClangTidy.h"
+#include "../ClangTidyCheck.h"
+#include "../ClangTidyModule.h"
+#include "../ClangTidyModuleRegistry.h"
+
+using namespace clang::ast_matchers;
+
+namespace clang {
+namespace tidy {
+namespace cuda {
+
+class CudaModule : public ClangTidyModule {
+public:
+  void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {}
+};
+
+// Register the CudaTidyModule using this statically initialized variable.
+static ClangTidyModuleRegistry::Add<CudaModule>
+    X("cuda-module", "Adds Cuda-related lint checks.");
+
+} // namespace cuda
+
+// This anchor is used to force the linker to link in the generated object file
+// and thus register the CudaModule.
+volatile int CudaModuleAnchorSource = 0;
+
+} // namespace tidy
+} // namespace clang

clang-tools-extra/docs/ReleaseNotes.rst

 
 Improvements to clang-rename
 ----------------------------
 
 The improvements are...
 
 Improvements to clang-tidy
 --------------------------
 
+- Introduce the cuda module for checks specific to CUDA code.
+
 New checks
 ^^^^^^^^^^
 
 - New :doc:`cppcoreguidelines-avoid-const-or-ref-data-members
   <clang-tidy/checks/cppcoreguidelines/avoid-const-or-ref-data-members>` check.
 
   Warns when a struct or class uses const or reference (lvalue or rvalue) data members.
 

 - Improved :doc:`modernize-use-equals-default <clang-tidy/checks/modernize/use-equals-default>`
   check.
 
   The check now skips unions/union-like classes since in this case a default constructor
   with empty body is not equivalent to the explicitly defaulted one. The check also skips
   copy assignment operators with nonstandard return types. The check is restricted to
   c++11-or-later.
 
 Removed checks
 ^^^^^^^^^^^^^^
 
 Improvements to include-fixer
 -----------------------------
 
 The improvements are...
 
 Improvements to clang-include-fixer

clang-tools-extra/docs/clang-tidy/checks/list.rst

.. toctree::
    altera/*
    android/*
    boost/*
    bugprone/*
    cert/*
    clang-analyzer/*
    concurrency/*
    cppcoreguidelines/*
+   cuda/*
    darwin/*
    fuchsia/*
    google/*
    hicpp/*
    linuxkernel/*
    llvm/*
    llvmlibc/*
    misc/*

clang-tools-extra/docs/clang-tidy/index.rst

 ``android-``           Checks related to Android.
 ``boost-``             Checks related to Boost library.
 ``bugprone-``          Checks that target bug-prone code constructs.
 ``cert-``              Checks related to CERT Secure Coding Guidelines.
 ``clang-analyzer-``    Clang Static Analyzer checks.
 ``concurrency-``       Checks related to concurrent programming (including
                        threads, fibers, coroutines, etc.).
 ``cppcoreguidelines-`` Checks related to C++ Core Guidelines.
+``cuda-``              Checks related to CUDA best practices.
 ``darwin-``            Checks related to Darwin coding conventions.
 ``fuchsia-``           Checks related to Fuchsia coding conventions.
 ``google-``            Checks related to Google coding conventions.
 ``hicpp-``             Checks related to High Integrity C++ Coding Standard.
 ``linuxkernel-``       Checks related to the Linux Kernel coding conventions.
 ``llvm-``              Checks related to the LLVM coding conventions.
 ``llvmlibc-``          Checks related to the LLVM-libc coding standards.
 ``misc-``              Checks that we didn't have a better category for.
--checks=<string>              -
                                      file, if any.
     --config=<string>              -
                                      Specifies a configuration in YAML/JSON format:
                                        -config="{Checks: '*',
                                                  CheckOptions: {x, y}}"
                                      When the value is empty, clang-tidy will
                                      attempt to find a file named .clang-tidy for
                                      each source file in its parent directories.
     --config-file=<string>         - 
                                     Specify the path of .clang-tidy or custom config file:
                                       e.g. --config-file=/some/path/myTidyConfigFile
                                     This option internally works exactly the same way as
                                       --config option after reading specified config file.
                                     Use either --config-file or --config, not both.
     --dump-config                  -
                                      Dumps configuration in the YAML format to
                                      stdout. This option can be used along with a
--quiet                        -
                                      printing statistics about ignored warnings and
                                      warnings treated as errors if the respective
                                      options are specified.
     --store-check-profile=<prefix> -
                                      By default reports are printed in tabulated
                                      format to stderr. When this option is passed,
                                      these per-TU profiles are instead stored as JSON.
     --system-headers               - Display the errors from system headers.
     --use-color                    - 
                                     Use colors in diagnostics. If not set, colors
                                     will be used if the terminal connected to
                                     standard output supports colors.
                                     This option overrides the 'UseColor' option in
                                     .clang-tidy file, if any.
     --verify-config                -
                                      Check the config files to ensure each check and
                                      option is recognized.

clang-tools-extra/test/clang-tidy/check_clang_tidy.py

def __init__(self, args, extra_args):
     self.has_check_messages = False
     self.has_check_notes = False
     self.fixes = MessagePrefix('CHECK-FIXES')
     self.messages = MessagePrefix('CHECK-MESSAGES')
     self.notes = MessagePrefix('CHECK-NOTES')
 
     file_name_with_extension = self.assume_file_name or self.input_file_name
     _, extension = os.path.splitext(file_name_with_extension)
-    if extension not in ['.c', '.hpp', '.m', '.mm']:
+    if extension not in ['.c', '.cu', '.hpp', '.m', '.mm']:
       extension = '.cpp'
     self.temp_file_name = self.temp_file_name + extension
 
     self.clang_extra_args = []
     self.clang_tidy_extra_args = extra_args
     if '--' in extra_args:
       i = self.clang_tidy_extra_args.index('--')
       self.clang_extra_args = self.clang_tidy_extra_args[i + 1:]
       self.clang_tidy_extra_args = self.clang_tidy_extra_args[:i]
 
     # If the test does not specify a config style, force an empty one; otherwise
     # auto-detection logic can discover a ".clang-tidy" file that is not related to
     # the test.
     if not any(
         [arg.startswith('-config=') for arg in self.clang_tidy_extra_args]):
       self.clang_tidy_extra_args.append('-config={}')
 
     if extension in ['.m', '.mm']:
       self.clang_extra_args = ['-fobjc-abi-version=2', '-fobjc-arc', '-fblocks'] + \
           self.clang_extra_args
 
-    if extension in ['.cpp', '.hpp', '.mm']:
+    if extension in ['.cpp', '.cu', '.hpp', '.mm']:
       self.clang_extra_args.append('-std=' + self.std)
 
+    # Tests should not rely on a certain cuda headers and library version
+    # being available on the machine
+    if extension == '.cu':
+      self.clang_extra_args.extend(["--no-cuda-version-check", "-nocudalib", "-nocudainc"])
+
     # Tests should not rely on STL being available, and instead provide mock
     # implementations of relevant APIs.
     self.clang_extra_args.append('-nostdinc++')
 
     if self.resource_dir is not None:
       self.clang_extra_args.append('-resource-dir=%s' % self.resource_dir)
 
   def read_input(self):

clang-tools-extra/test/clang-tidy/checkers/Inputs/Headers/cuda/cuda.h

+/* Minimal declarations for CUDA support.  Testing purposes only. */
+
+#define __constant__ __attribute__((constant))
+#define __device__ __attribute__((device))
+#define __global__ __attribute__((global))
+#define __host__ __attribute__((host))
+#define __shared__ __attribute__((shared))
+
+struct dim3 {
+  unsigned x, y, z;
+  __host__ __device__ dim3(unsigned x, unsigned y = 1, unsigned z = 1) : x(x), y(y), z(z) {}
+};
+
+typedef struct cudaStream *cudaStream_t;
+typedef enum cudaError {} cudaError_t;
+extern "C" int cudaConfigureCall(dim3 gridSize, dim3 blockSize,
+                                 size_t sharedSize = 0,
+                                 cudaStream_t stream = 0);
+extern "C" int __cudaPushCallConfiguration(dim3 gridSize, dim3 blockSize,
+                                           size_t sharedSize = 0,
+                                           cudaStream_t stream = 0);
+extern "C" cudaError_t cudaLaunchKernel(const void *func, dim3 gridDim,
+                                        dim3 blockDim, void **args,
+                                        size_t sharedMem, cudaStream_t stream);
+
+extern "C" __device__ int printf(const char*, ...);