4827. [misc] Add a precommit check script util/checklibs.sh

                        [RT #46215]

(cherry picked from commit 7bc5d7f5e8966397d2151e4953abc3da1f1f3a29)

diff --git a/CHANGES b/CHANGES
index 12cd98f827af4320c773ff97823f352f55584992..d8e793c3c2bbe309bb8b999f63c28bdb44afda64 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,6 @@
+4827.  [misc]          Add a precommit check script util/checklibs.sh
+                       [RT #46215]
+
 4826.  [cleanup]       Prevent potential build failures in bin/confgen/ and
                        bin/named/ when using parallel make. [RT #46648]
 

diff --git a/util/checklibs.sh b/util/checklibs.sh
new file mode 100755 (executable)
index 0000000..5b88ea6
--- /dev/null
+++ b/util/checklibs.sh
@@ -0,0 +1,128 @@
+#!/bin/sh
+#
+# Copyright (C) 2012, 2016  Internet Systems Consortium, Inc. ("ISC")
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+status=0
+
+#
+# Check for missing #include <isc/print.h> or "print_p.h"
+#
+list=`git grep -l snprintf lib bin |
+      grep '\.c$' |
+      grep -vE -e '(lib/bind|lib/dns/rdata|lib/dns/gen.c)' \
+              -e '(lib/isc/win32/time.c|dlzexternal/driver.c)' |
+      xargs grep -EL "(isc/print.h|print_p.h)" 2> /dev/null`
+[ -n "$list" ] && {
+    status=1
+    echo 'Missing #include <isc/print.h> or #include "print_p.h":'
+    echo "$list"
+}
+
+#
+# Check for missing #include <isc/string.h>"
+#
+list=`git grep -lw strsep lib bin |
+      grep '\.c$' |
+      grep -vE -e '(lib/bind|lib/dns/rdata|lib/dns/gen.c)' \
+              -e '(lib/isc/win32/time.c)' |
+      xargs grep -L "<isc/string.h>"`
+[ -n "$list" ] && {
+    status=1
+    echo 'Missing #include <isc/string.h>:'
+    echo "$list"
+}
+
+#
+# Check for missing #include <inttypes.h>"
+#
+list=`git grep -l uintptr_t lib bin |
+      grep '\.c$' |
+      grep -vE -e '(lib/bind|lib/dns/rdata|lib/dns/gen.c)' \
+              -e '(lib/isc/win32/time.c)' |
+      xargs grep -L "<inttypes.h>"`
+[ -n "$list" ] && {
+    status=1
+    echo 'Missing #include <inttypes.h>:'
+    echo "$list"
+}
+
+#
+# Check for missing #include <config.h>
+#
+list=`git ls-files -c bin lib | grep '\.c$' |
+      xargs grep -L '#include ["<]config.h[">]' |
+      grep -vE -e '(/win32/|bin/pkcs11/|lib/dns/rdata|lib/bind/)' \
+              -e '(ifiter_|lib/dns/gen.c|lib/dns/spnego_asn1.c)' \
+              -e '(lib/dns/rbtdb64.c|lib/isc/entropy.c|lib/isc/fsaccess.c)' \
+              -e '(bin/tests/virtual-time/vtwrapper.c|symtbl.c|version.c)'`
+[ -n "$list" ] && {
+    status=1
+    echo 'Missing #include "config.h":'
+    echo "$list"
+}
+
+list=`git ls-files -c lib bin | grep '\.vcxproj\.in$' |
+      xargs grep -L '<ProjectGuid>' |
+      awk '{a[$2]++;} END { for (g in a) if (a[g] != 1) print g;}'`
+[ -n "$list" ] && {
+    status=1
+    echo 'duplicate <ProjectGuid>'"'"'s:'
+    echo "$list"
+}
+
+for lib in `git ls-files -c lib |
+           sed -n 's;^lib/\([^/]*\)/win32/.*\.def.*$;\1;p' |
+           sort -u`
+do
+    def=`git ls-files -c lib |
+        grep lib/${lib}/win32/lib${lib}.def |
+        sort |
+        tail -n 1`
+    test -z "$def" && continue;
+    test -f "$def" || continue;
+    dirs=
+    test -d lib/$lib/include && dirs="$dirs lib/$lib/include"
+    test -d lib/$lib/win32/include && dirs="$dirs lib/$lib/win32/include"
+    test -z "$dirs" && continue;
+    pat=$lib
+    test $lib = dns && pat='\(dns\|dst\)'
+    pat="^${pat}_[a-z0-9_]*("
+    list=`git ls-files -c $dirs | grep '\.h$' |
+         xargs grep "$pat" |
+         sed -e 's/.*://' -e 's/(.*//' |
+         while read p
+         do
+             case $p in
+             isc__app_register) continue;;                     # internal
+             isc__mem_register) continue;;                     # internal
+             isc__task_register) continue;;                    # internal
+             isc__taskmgr_dispatch) continue;;                 # internal
+             isc__timer_register) continue;;                   # internal
+             isc_ntsecurity_getaccountgroups) continue;;       # internal
+             isc__taskmgr_dispatch) continue;;                 # no threads
+             isc__taskmgr_ready) continue;;                    # no threads
+             isc_socketmgr_getmaxsockets) p=isc__socketmgr_getmaxsockets;;
+             esac
+             grep -q "^${p}"'$' $def && continue
+             test $lib = isc -a -f lib/isc/win32/libisc.def.exclude &&
+                 grep -q "^${p}"'$' lib/isc/win32/libisc.def.exclude &&
+                 continue
+             if test -d lib/$lib/win32
+             then
+                 grep -q "^$p(" lib/$lib/*.c lib/$lib/win32/*.c && echo "$p"
+             else
+                 grep -q "^$p(" lib/$lib/*.c && echo "$p"
+             fi
+         done`
+    [ -n "$list" ] && {
+       status=1
+       echo "Missing from ${def}:"
+       echo "$list"
+    }
+done
+
+exit $status