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::tidy::linuxkernel {
  15
  16 /// Checks Linux kernel code to see if it uses the results from the functions in
  17 /// linux/err.h. Also checks to see if code uses the results from functions that
  18 /// directly return a value from one of these error functions.
  19 ///
  20 /// This is important in the Linux kernel because ERR_PTR, PTR_ERR, IS_ERR,
  21 /// IS_ERR_OR_NULL, ERR_CAST, and PTR_ERR_OR_ZERO return values must be checked,
  22 /// since positive pointers and negative error codes are being used in the same
  23 /// context. These functions are marked with
  24 /// __attribute__((warn_unused_result)), but some kernel versions do not have
  25 /// this warning enabled for clang.
  26 ///
  27 /// For the user-facing documentation see:
  28 /// http://clang.llvm.org/extra/clang-tidy/checks/linuxkernel/must-use-errs.html
  29 class MustCheckErrsCheck : public ClangTidyCheck {
  30 public:
  31   MustCheckErrsCheck(StringRef Name, ClangTidyContext *Context)
  32       : ClangTidyCheck(Name, Context) {}
  33   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  34   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  35 };
  36
  37 } // namespace clang::tidy::linuxkernel
  38
  39 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LINUXKERNEL_MUSTCHECKERRSCHECK_H