clang-tools-extra/clang-tidy/linuxkernel/MustCheckErrsCheck.h

   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