clang-tools
15.0.0git
llvm-project
clang-tools-extra
clang-tidy
linuxkernel
MustCheckErrsCheck.h
Go to the documentation of this file.
1
//===--- MustCheckErrsCheck.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_LINUXKERNEL_MUSTCHECKERRSCHECK_H
10
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LINUXKERNEL_MUSTCHECKERRSCHECK_H
11
12
#include "../ClangTidyCheck.h"
13
14
namespace
clang
{
15
namespace
tidy {
16
namespace
linuxkernel {
17
18
/// Checks Linux kernel code to see if it uses the results from the functions in
19
/// linux/err.h. Also checks to see if code uses the results from functions that
20
/// directly return a value from one of these error functions.
21
///
22
/// This is important in the Linux kernel because ERR_PTR, PTR_ERR, IS_ERR,
23
/// IS_ERR_OR_NULL, ERR_CAST, and PTR_ERR_OR_ZERO return values must be checked,
24
/// since positive pointers and negative error codes are being used in the same
25
/// context. These functions are marked with
26
/// __attribute__((warn_unused_result)), but some kernel versions do not have
27
/// this warning enabled for clang.
28
///
29
/// For the user-facing documentation see:
30
/// http://clang.llvm.org/extra/clang-tidy/checks/linuxkernel/must-use-errs.html
31
class
MustCheckErrsCheck
:
public
ClangTidyCheck
{
32
public
:
33
MustCheckErrsCheck
(StringRef
Name
,
ClangTidyContext
*Context)
34
:
ClangTidyCheck
(
Name
, Context) {}
35
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
36
void
check
(
const
ast_matchers::MatchFinder::MatchResult &Result)
override
;
37
};
38
39
}
// namespace linuxkernel
40
}
// namespace tidy
41
}
// namespace clang
42
43
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LINUXKERNEL_MUSTCHECKERRSCHECK_H
clang::tidy::linuxkernel::MustCheckErrsCheck
Checks Linux kernel code to see if it uses the results from the functions in linux/err....
Definition:
MustCheckErrsCheck.h:31
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:53
clang::tidy::linuxkernel::MustCheckErrsCheck::MustCheckErrsCheck
MustCheckErrsCheck(StringRef Name, ClangTidyContext *Context)
Definition:
MustCheckErrsCheck.h:33
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:67
Name
Token Name
Definition:
MacroToEnumCheck.cpp:89
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
clang::tidy::linuxkernel::MustCheckErrsCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
MustCheckErrsCheck.cpp:19
clang::tidy::linuxkernel::MustCheckErrsCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition:
MustCheckErrsCheck.cpp:35
Generated on Sat Jun 25 2022 12:41:25 for clang-tools by
1.8.17