From 0858d473d259a5a997dad12e818028e1be569dc3 Mon Sep 17 00:00:00 2001
From: Tim Ruffing <crypto@timruffing.de>
Date: Thu, 15 Oct 2020 18:36:30 +0200
Subject: [PATCH] Add simple static checker using clang-query

---
 .gitignore        |  2 ++
 .travis.yml       | 10 +++++++++
 clang-query.sh    | 53 +++++++++++++++++++++++++++++++++++++++++++++++
 contrib/travis.sh | 16 ++++++++++++++
 4 files changed, 81 insertions(+)
 create mode 100755 clang-query.sh

diff --git a/.gitignore b/.gitignore
index ccdef02b29..fe067824b2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,6 +33,8 @@ libtool
 *~
 *.log
 *.trs
+compile_commands.commands.json
+compile_commands.json
 src/libsecp256k1-config.h
 src/libsecp256k1-config.h.in
 src/ecmult_static_context.h
diff --git a/.travis.yml b/.travis.yml
index bcc8c210f5..363771ffd5 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -9,9 +9,11 @@ osx_image: xcode10.1
 addons:
   apt:
     packages:
+      - clang-tools-10
       - libgmp-dev
       - valgrind
       - libtool-bin
+      - bear
 compiler:
   - clang
   - gcc
@@ -43,10 +45,12 @@ matrix:
       addons:
         apt:
           packages:
+            - clang-tools-10
             - gcc-multilib
             - libgmp-dev:i386
             - valgrind
             - libtool-bin
+            - bear
             - libc6-dbg:i386
     - compiler: clang
       env: HOST=i686-linux-gnu
@@ -54,9 +58,11 @@ matrix:
       addons:
         apt:
           packages:
+            - clang-tools-10
             - gcc-multilib
             - valgrind
             - libtool-bin
+            - bear
             - libc6-dbg:i386
     - compiler: gcc
       env: HOST=i686-linux-gnu
@@ -64,6 +70,7 @@ matrix:
       addons:
         apt:
           packages:
+            - clang-tools-10
             - gcc-multilib
             - valgrind
             - libtool-bin
@@ -74,6 +81,7 @@ matrix:
       addons:
         apt:
           packages:
+            - clang-tools-10
             - gcc-multilib
             - libgmp-dev:i386
             - valgrind
@@ -104,5 +112,7 @@ after_script:
     - cat ./exhaustive_tests.log
     - cat ./valgrind_ctime_test.log
     - cat ./bench.log
+    - cat ./clang-query.log
+    - cat ./compile_commands.json
     - $CC --version
     - valgrind --version
diff --git a/clang-query.sh b/clang-query.sh
new file mode 100755
index 0000000000..ead87f683c
--- /dev/null
+++ b/clang-query.sh
@@ -0,0 +1,53 @@
+#!/bin/sh
+
+set -u
+
+matcher=$(cat <<'EOF'
+set print-matcher true
+enable output detailed-ast
+
+### Expressions of any floating point type (unless in a system header)
+match expr(allOf(unless(isExpansionInSystemHeader()), hasType(realFloatingPointType())))
+
+### Calls to memcmp (secp256k1_memcmp_var should be used instead)
+match callExpr(callee(functionDecl(hasName("memcmp"))))
+
+### Reserved identifiers (unless in a system header) with external linkage or at file scope.
+# Any function is in file scope. Any variable with static storage (unless static local variable) is in file scope.
+# Allowed exceptions: __builtin_expect
+# We need the "::" due to LLVM bug 47879.
+match namedDecl(allOf(unless(isExpansionInSystemHeader()), anyOf(hasExternalFormalLinkage(), functionDecl(), varDecl(allOf(hasStaticStorageDuration(), unless(isStaticLocal())))), allOf(matchesName("^::(_|((mem|is|to|str|wcs)[a-z]))"), unless(hasAnyName("__builtin_expect")))))
+
+### Reserved type names (unless in a system header)
+# Allowed exceptions: uint128_t, int128_t, __int128_t, __uint128_t (the latter two are "implicit", i.e., added by the compiler)
+match typedefDecl(allOf(unless(isExpansionInSystemHeader()), matchesName("(^::u?int)|(_t$)"), unless(hasAnyName("int128_t", "uint128_t", "__int128_t", "__uint128_t"))))
+
+quit
+EOF
+)
+
+# Poor man's JSON parser.
+# This is not great but it works with the output of all common tools and it does not need extra dependencies.
+files=$(grep 'file' compile_commands.json | uniq | cut -d '"' -f 4)
+echo "Running clang-query on files:"
+echo "$files"
+
+output=$(echo "$matcher" | ${CLANG_QUERY:-clang-query} "$@" $files)
+status=$?
+if [ $status -ne 0 ]
+then
+    exit $status
+fi
+
+echo "$output"
+# For some reason, clang-query returns a zero status even if clang failed to process the file (LLVM Bug 47880).
+# This is not a big issue. If clang errors, we'll notice that when trying to compile with clang anyway.
+# We still try to catch this case by grepping also for "error:".
+echo "$output" | grep -qE "^Match #|error:"
+if [ $? -eq 0 ]
+then
+    exit 1
+fi
+
+echo
+exit 0
diff --git a/contrib/travis.sh b/contrib/travis.sh
index 24cc9315cb..d7b4b1652a 100755
--- a/contrib/travis.sh
+++ b/contrib/travis.sh
@@ -23,6 +23,13 @@ fi
 
 if [ -n "$BUILD" ]
 then
+    if [ "$TRAVIS_OS_NAME" = "linux" ] && [ "$TRAVIS_COMPILER" = "clang" ]
+    then
+        # Use bear to generate compile_commands.json
+        # This needs to be the first make command because otherwise make does not invoke the compiler because the files are up to date.
+        # We need to update this to "bear -- make" when we move to bear 3.0.
+        bear make -j2
+    fi
     make -j2 "$BUILD"
 fi
 if [ "$RUN_VALGRIND" = "yes" ]
@@ -66,3 +73,12 @@ if [ "$CTIMETEST" = "yes" ]
 then
     ./libtool --mode=execute valgrind --error-exitcode=42 ./valgrind_ctime_test > valgrind_ctime_test.log 2>&1
 fi
+
+# This would also run on gcc builds but there's no need to run it for both compilers.
+if [ "$TRAVIS_OS_NAME" = "linux" ] && [ "$TRAVIS_COMPILER" = "clang" ]
+then
+    # Abuse `script` to run make clang-query believe it's running with a terminal (see https://superuser.com/a/1434381/404598).
+    # This lets us write color codes to clang-query.log.
+    # (Passing `--extra-arg=-fcolor-diagnostics` to clang-query works only if stdout but not stderr is redirected to a file...)
+    CLANG_QUERY=clang-query-10 script -efqc "./clang-query.sh 2>&1" clang-query.log
+fi