From 611d2e4ee6a5150b45659abafd76e5917d4382a7 Mon Sep 17 00:00:00 2001 From: Aaron Ballman Date: Fri, 19 Feb 2016 14:03:20 +0000 Subject: [PATCH] Add a new check, cert-flp30-c, that diagnoses loop induction expressions of floating-point type. This check corresponds to the CERT secure coding rule: https://www.securecoding.cert.org/confluence/display/c/FLP30-C.+Do+not+use+floating-point+variables+as+loop+counters llvm-svn: 261324 --- .../clang-tidy/cert/CERTTidyModule.cpp | 5 ++- clang-tools-extra/clang-tidy/cert/CMakeLists.txt | 1 + .../clang-tidy/cert/FloatLoopCounter.cpp | 35 ++++++++++++++++++++ .../clang-tidy/cert/FloatLoopCounter.h | 37 ++++++++++++++++++++++ .../docs/clang-tidy/checks/cert-flp30-c.rst | 11 +++++++ clang-tools-extra/docs/clang-tidy/checks/list.rst | 1 + clang-tools-extra/test/clang-tidy/cert-flp30-c.c | 19 +++++++++++ 7 files changed, 108 insertions(+), 1 deletion(-) create mode 100644 clang-tools-extra/clang-tidy/cert/FloatLoopCounter.cpp create mode 100644 clang-tools-extra/clang-tidy/cert/FloatLoopCounter.h create mode 100644 clang-tools-extra/docs/clang-tidy/checks/cert-flp30-c.rst create mode 100644 clang-tools-extra/test/clang-tidy/cert-flp30-c.c diff --git a/clang-tools-extra/clang-tidy/cert/CERTTidyModule.cpp b/clang-tools-extra/clang-tidy/cert/CERTTidyModule.cpp index 4e0a6ed..05a631b 100644 --- a/clang-tools-extra/clang-tidy/cert/CERTTidyModule.cpp +++ b/clang-tools-extra/clang-tidy/cert/CERTTidyModule.cpp @@ -16,6 +16,7 @@ #include "../misc/NonCopyableObjects.h" #include "../misc/StaticAssertCheck.h" #include "../misc/ThrowByValueCatchByReferenceCheck.h" +#include "FloatLoopCounter.h" #include "SetLongJmpCheck.h" #include "StaticObjectExceptionCheck.h" #include "ThrownExceptionTypeCheck.h" @@ -53,7 +54,9 @@ public: // DCL CheckFactories.registerCheck( "cert-dcl03-c"); - + // FLP + CheckFactories.registerCheck( + "cert-flp30-c"); // FIO CheckFactories.registerCheck( "cert-fio38-c"); diff --git a/clang-tools-extra/clang-tidy/cert/CMakeLists.txt b/clang-tools-extra/clang-tidy/cert/CMakeLists.txt index da4eddd..8c097aa 100644 --- a/clang-tools-extra/clang-tidy/cert/CMakeLists.txt +++ b/clang-tools-extra/clang-tidy/cert/CMakeLists.txt @@ -2,6 +2,7 @@ set(LLVM_LINK_COMPONENTS support) add_clang_library(clangTidyCERTModule CERTTidyModule.cpp + FloatLoopCounter.cpp SetLongJmpCheck.cpp StaticObjectExceptionCheck.cpp ThrownExceptionTypeCheck.cpp diff --git a/clang-tools-extra/clang-tidy/cert/FloatLoopCounter.cpp b/clang-tools-extra/clang-tidy/cert/FloatLoopCounter.cpp new file mode 100644 index 0000000..e92552e --- /dev/null +++ b/clang-tools-extra/clang-tidy/cert/FloatLoopCounter.cpp @@ -0,0 +1,35 @@ +//===--- FloatLoopCounter.cpp - clang-tidy---------------------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "FloatLoopCounter.h" +#include "clang/AST/ASTContext.h" +#include "clang/ASTMatchers/ASTMatchFinder.h" + +using namespace clang::ast_matchers; + +namespace clang { +namespace tidy { +namespace cert { + +void FloatLoopCounter::registerMatchers(MatchFinder *Finder) { + Finder->addMatcher( + forStmt(hasIncrement(expr(hasType(realFloatingPointType())))).bind("for"), + this); +} + +void FloatLoopCounter::check(const MatchFinder::MatchResult &Result) { + const auto *FS = Result.Nodes.getNodeAs("for"); + + diag(FS->getInc()->getExprLoc(), "loop induction expression should not have " + "floating-point type"); +} + +} // namespace cert +} // namespace tidy +} // namespace clang diff --git a/clang-tools-extra/clang-tidy/cert/FloatLoopCounter.h b/clang-tools-extra/clang-tidy/cert/FloatLoopCounter.h new file mode 100644 index 0000000..c66e44a --- /dev/null +++ b/clang-tools-extra/clang-tidy/cert/FloatLoopCounter.h @@ -0,0 +1,37 @@ +//===--- FloatLoopCounter.h - clang-tidy-------------------------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CERT_FLOAT_LOOP_COUNTER_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CERT_FLOAT_LOOP_COUNTER_H + +#include "../ClangTidy.h" + +namespace clang { +namespace tidy { +namespace cert { + +/// This check diagnoses when the loop induction expression of a for loop has +/// floating-point type. The check corresponds to: +/// https://www.securecoding.cert.org/confluence/display/c/FLP30-C.+Do+not+use+floating-point+variables+as+loop+counters +/// +/// For the user-facing documentation see: +/// http://clang.llvm.org/extra/clang-tidy/checks/cert-flp30-c.html +class FloatLoopCounter : public ClangTidyCheck { +public: + FloatLoopCounter(StringRef Name, ClangTidyContext *Context) + : ClangTidyCheck(Name, Context) {} + void registerMatchers(ast_matchers::MatchFinder *Finder) override; + void check(const ast_matchers::MatchFinder::MatchResult &Result) override; +}; + +} // namespace cert +} // namespace tidy +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CERT_FLOAT_LOOP_COUNTER_H diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-flp30-c.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-flp30-c.rst new file mode 100644 index 0000000..cfccb77 --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/cert-flp30-c.rst @@ -0,0 +1,11 @@ +.. title:: clang-tidy - cert-flp30-c + +cert-flp30-c +============ + +This check flags ``for`` loops where the induction expression has a floating- +point type. + +This check corresponds to the CERT C Coding Standard rule +`FLP30-C. Do not use floating-point variables as loop counters +`_. diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst index 4c2795e..b19a7eb 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/list.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst @@ -13,6 +13,7 @@ Clang-Tidy Checks cert-err60-cpp cert-err61-cpp (redirects to misc-throw-by-value-catch-by-reference) cert-fio38-c (redirects to misc-non-copyable-objects) + cert-flp30-c cert-oop11-cpp (redirects to misc-move-constructor-init) cppcoreguidelines-pro-bounds-array-to-pointer-decay cppcoreguidelines-pro-bounds-constant-array-index diff --git a/clang-tools-extra/test/clang-tidy/cert-flp30-c.c b/clang-tools-extra/test/clang-tidy/cert-flp30-c.c new file mode 100644 index 0000000..eee16be --- /dev/null +++ b/clang-tools-extra/test/clang-tidy/cert-flp30-c.c @@ -0,0 +1,19 @@ +// RUN: %check_clang_tidy %s cert-flp30-c %t + +float g(void); + +void func(void) { + for (float x = 0.1f; x <= 1.0f; x += 0.1f) {} + // CHECK-MESSAGES: :[[@LINE-1]]:37: warning: loop induction expression should not have floating-point type [cert-flp30-c] + + float f = 1.0f; + for (; f > 0; --f) {} + // CHECK-MESSAGES: :[[@LINE-1]]:17: warning: loop induction expression + + for (;;g()) {} + // CHECK-MESSAGES: :[[@LINE-1]]:10: warning: loop induction expression + + for (int i = 0; i < 10; i += 1.0f) {} + + for (int i = 0; i < 10; ++i) {} +} -- 2.7.4