Add formatting enhancements (zmap#501)

Add formatting check to TravisCI and rerun formatting script.

Author: Alex Holland

.clang-format

@@ -8,4 +8,4 @@ DerivePointerAlignment: false
 PointerAlignment: Right
 BreakStringLiterals: false
 SortIncludes: false
-
+ReflowComments: false

.travis.yml

@@ -21,13 +21,20 @@ addons:
 before_install:
   - pip install --user sh
   - export PATH=/opt/bin:$PATH
+before_script:
+  - wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add -
+  - echo "deb http://apt.llvm.org/trusty/ llvm-toolchain-trusty-6.0 main" | sudo tee -a /etc/apt/sources.list
+  - sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
+  - sudo apt-get update -qq
+  - sudo apt-get install libstdc++-4.9-dev libllvm6.0 clang-format-6.0
 script: 
   - mkdir __build
   - cd __build
   - cmake -DENABLE_DEVELOPMENT=ON -DWITH_REDIS=ON $TRAVIS_BUILD_DIR
   - make
   - cd $TRAVIS_BUILD_DIR
   - python ./scripts/check_manfile.py
+  - ./checkFormat.sh
 compiler: clang
 notifications:
   email:

checkFormat.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+CLANG_FORMAT=clang-format-6.0
+
+files_to_lint=$(find ./src ./lib -type f -name '*.c' -or -name '*.h')
+
+fail=0
+for f in ${files_to_lint}; do
+  d="$(diff -u "$f" <($CLANG_FORMAT -style=file "$f") || true)"
+  if ! [ -z "$d" ]; then
+    printf "The file %s is not compliant with the coding style:\n%s\n" "$f" "$d"
+    fail=1
+  fi
+done
+
+if [ "$fail" -eq "1" ]; then
+  if [ ! -z $ZMAP_ENFORCE_FORMAT ]; then
+    exit 1
+  fi
+fi

format.sh

@@ -3,12 +3,12 @@ set -e
 set -o pipefail
 
 MAJOR_REV=$((clang-format --version | awk '{print $3}' | cut -d '.' -f 1) || echo 0)
-if [ $MAJOR_REV -ne 5 ]; then
-	echo "error: need clang-format version 5.x"
+if [ $MAJOR_REV -lt 5 ]; then
+	echo "error: need at least clang-format version 5.x"
 	exit 1
 fi
 
-FORMAT_CMD="clang-format -i"
+FORMAT_CMD="clang-format -i -style=file"
 
 # No files passed, format everything
 if [ $# -eq 0 ]; then

src/probe_modules/module_dns.c

@@ -584,7 +584,7 @@ static int dns_global_initialize(struct state_conf *conf)
 	qtypes = xmalloc(sizeof(uint16_t) * num_questions);
 
 	char *qtype_str = NULL;
-	char **domains = (char**) xmalloc(sizeof(char *) * num_questions);
+	char **domains = (char **)xmalloc(sizeof(char *) * num_questions);
 
 	for (int i = 0; i < num_questions; i++) {
 		domains[i] = (char *)default_domain;

src/probe_modules/module_udp.c

@@ -585,7 +585,7 @@ int udp_template_build(udp_payload_template_t *t, char *out, unsigned int len,
 
 		switch (c->ftype) {
 
-		// These fields have a specified output length value
+			// These fields have a specified output length value
 
 		case UDP_DATA:
 			if (!(c->data && c->length))
@@ -877,7 +877,7 @@ static fielddef_t fields[] = {
 probe_module_t module_udp = {
     .name = "udp",
     .packet_length = sizeof(struct ether_header) + sizeof(struct ip) +
-                     sizeof(struct udphdr) + MAX_UDP_PAYLOAD_LEN,
+		     sizeof(struct udphdr) + MAX_UDP_PAYLOAD_LEN,
     .pcap_filter = "udp || icmp",
     .pcap_snaplen = 1500,
     .port_args = 1,

src/send.c

@@ -138,15 +138,19 @@ iterator_t *send_init(void)
 
 	// only allow bandwidth or rate
 	if (zconf.bandwidth > 0 && zconf.rate > 0) {
-		log_fatal("send", "Must specify rate or bandwidth, or neither, not both.");
+		log_fatal(
+		    "send",
+		    "Must specify rate or bandwidth, or neither, not both.");
 	}
 	// convert specified bandwidth to packet rate
 	if (zconf.bandwidth > 0) {
 		size_t pkt_len = zconf.probe_module->packet_length;
 		pkt_len *= 8;
-		// 7 byte MAC preamble, 1 byte Start frame, 4 byte CRC, 12 byte inter-frame gap
+		// 7 byte MAC preamble, 1 byte Start frame, 4 byte CRC, 12 byte
+		// inter-frame gap
 		pkt_len += 8 * 24;
-		// adjust calculated length if less than the minimum size of an ethernet frame
+		// adjust calculated length if less than the minimum size of an
+		// ethernet frame
 		if (pkt_len < 84 * 8) {
 			pkt_len = 84 * 8;
 		}
@@ -164,9 +168,10 @@ iterator_t *send_init(void)
 				zconf.rate = 1;
 			}
 		}
-		log_debug("send",
-			  "using bandwidth %lu bits/s for %zu byte probe, rate set to %d pkt/s",
-			  zconf.bandwidth, pkt_len/8, zconf.rate);
+		log_debug(
+		    "send",
+		    "using bandwidth %lu bits/s for %zu byte probe, rate set to %d pkt/s",
+		    zconf.bandwidth, pkt_len / 8, zconf.rate);
 	}
 	// log rate, if explicitly specified
 	if (zconf.rate <= 0) {
@@ -329,9 +334,10 @@ int send_run(sock_t st, shard_t *s)
 					double t = now();
 					assert(count > last_count);
 					assert(t > last_time);
-					double multiplier = (double)(count - last_count) /
-						 (t - last_time) /
-						 (zconf.rate / zconf.senders);
+					double multiplier =
+					    (double)(count - last_count) /
+					    (t - last_time) /
+					    (zconf.rate / zconf.senders);
 					uint32_t old_delay = delay;
 					delay *= multiplier;
 					if (delay == old_delay) {

src/topt_compat.c

@@ -2,7 +2,7 @@
 #error "gcc version >= 4 is required"
 #elif __GNUC__ == 4 && __GNUC_MINOR__ >= 6
 #pragma GCC diagnostic ignored "-Wunused-but-set-variable"
-#elif __GNUC_MINOR__ >= 4 
+#elif __GNUC_MINOR__ >= 4
 #pragma GCC diagnostic ignored "-Wunused-but-set-variable"
 #endif