clang-tools  14.0.0git
SingleWorkItemBarrierCheck.h
Go to the documentation of this file.
1 //===--- SingleWorkItemBarrierCheck.h - clang-tidy---------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ALTERA_SINGLE_WORK_ITEM_BARRIER_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ALTERA_SINGLE_WORK_ITEM_BARRIER_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace altera {
17 
18 /// Detects OpenCL kernel functions that call a barrier but do not call an
19 /// ID-function function. These functions will be treated as single work-item
20 /// kernels, which may be inefficient or cause an error.
21 ///
22 /// For the user-facing documentation see:
23 /// http://clang.llvm.org/extra/clang-tidy/checks/opencl-single-work-item-barrier.html
25  const unsigned AOCVersion;
26 
27 public:
29  : ClangTidyCheck(Name, Context),
30  AOCVersion(Options.get("AOCVersion", 1600U)) {}
31  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
32  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
33  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
34 };
35 
36 } // namespace altera
37 } // namespace tidy
38 } // namespace clang
39 
40 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ALTERA_SINGLE_WORK_ITEM_BARRIER_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::altera::SingleWorkItemBarrierCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: SingleWorkItemBarrierCheck.cpp:19
clang::tidy::altera::SingleWorkItemBarrierCheck::SingleWorkItemBarrierCheck
SingleWorkItemBarrierCheck(StringRef Name, ClangTidyContext *Context)
Definition: SingleWorkItemBarrierCheck.h:28
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:416
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::altera::SingleWorkItemBarrierCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: SingleWorkItemBarrierCheck.cpp:77
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::altera::SingleWorkItemBarrierCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: SingleWorkItemBarrierCheck.cpp:42
clang::tidy::altera::SingleWorkItemBarrierCheck
Detects OpenCL kernel functions that call a barrier but do not call an ID-function function.
Definition: SingleWorkItemBarrierCheck.h:24