executor: remove block comments

1. We don't generally use /* */ block comments,
few precedents we have are inconsistent with the rest of the code.

2. pkg/csource does not strip them from the resulting code.

Remove the cases we have and add a test to prevent new ones being added.

7 files changed, 65 insertions, 81 deletions

diff --git a/executor/common.h b/executor/common.h
index d6e9d5b10..a3f442edc 100644
--- a/executor/common.h
+++ b/executor/common.h
@@ -462,7 +462,7 @@ static void loop(void)
 	int collide = 0;
 again:
 #endif
-	for (call = 0; call < /*NUM_CALLS*/; call++) {
+	for (call = 0; call < /*{{{NUM_CALLS}}}*/; call++) {
 		for (thread = 0; thread < (int)(sizeof(threads) / sizeof(threads[0])); thread++) {
 			struct thread_t* th = &threads[thread];
 			if (!th->created) {
@@ -482,7 +482,7 @@ again:
 			if (collide && (call % 2) == 0)
 				break;
 #endif
-			event_timedwait(&th->done, /*CALL_TIMEOUT*/);
+			event_timedwait(&th->done, /*{{{CALL_TIMEOUT}}}*/);
 			break;
 		}
 	}
@@ -535,7 +535,7 @@ static void loop(void)
 #endif
 	int iter;
 #if SYZ_REPEAT_TIMES
-	for (iter = 0; iter < /*REPEAT_TIMES*/; iter++) {
+	for (iter = 0; iter < /*{{{REPEAT_TIMES}}}*/; iter++) {
 #else
 	for (iter = 0;; iter++) {
 #endif
@@ -659,9 +659,9 @@ static void loop(void)
 #endif
 
 #if !SYZ_EXECUTOR
-/*SYSCALL_DEFINES*/
+/*{{{SYSCALL_DEFINES}}}*/
 
-/*RESULTS*/
+/*{{{RESULTS}}}*/
 
 #if SYZ_THREADED || SYZ_REPEAT || SYZ_SANDBOX_NONE || SYZ_SANDBOX_SETUID || SYZ_SANDBOX_NAMESPACE || SYZ_SANDBOX_ANDROID
 #if SYZ_THREADED
@@ -672,7 +672,7 @@ void execute_one(void)
 void loop(void)
 #endif
 {
-	/*SYSCALLS*/
+	/*{{{SYSCALLS}}}*/
 #if SYZ_HAVE_CLOSE_FDS && !SYZ_THREADED && !SYZ_REPEAT
 	close_fds();
 #endif
@@ -685,7 +685,7 @@ void loop(void)
 
 int main(int argc, char** argv)
 {
-	/*MMAP_DATA*/
+	/*{{{MMAP_DATA}}}*/
 
 	program_name = argv[0];
 	if (argc == 2 && strcmp(argv[1], "child") == 0)
@@ -693,7 +693,7 @@ int main(int argc, char** argv)
 #else
 int main(void)
 {
-	/*MMAP_DATA*/
+	/*{{{MMAP_DATA}}}*/
 #endif
 
 #if SYZ_BINFMT_MISC
@@ -716,13 +716,13 @@ int main(void)
 	install_segv_handler();
 #endif
 #if SYZ_MULTI_PROC
-	for (procid = 0; procid < /*PROCS*/; procid++) {
+	for (procid = 0; procid < /*{{{PROCS}}}*/; procid++) {
 		if (fork() == 0) {
 #endif
 #if SYZ_USE_TMP_DIR || SYZ_SANDBOX_ANDROID
 			use_temporary_dir();
 #endif
-			/*SANDBOX_FUNC*/
+			/*{{{SANDBOX_FUNC}}}*/
 #if SYZ_HAVE_CLOSE_FDS && !SYZ_THREADED && !SYZ_REPEAT && !SYZ_SANDBOX_NONE && \
     !SYZ_SANDBOX_SETUID && !SYZ_SANDBOX_NAMESPACE && !SYZ_SANDBOX_ANDROID
 			close_fds();
diff --git a/executor/common_bsd.h b/executor/common_bsd.h
index 54f58f49d..17306fb96 100644
--- a/executor/common_bsd.h
+++ b/executor/common_bsd.h
@@ -60,8 +60,8 @@ static int inject_fault(int nth)
 		fail("failed to open /dev/fault");
 
 	en.scope = FAULT_SCOPE_LWP;
-	en.mode = 0 /* FAULT_MODE_NTH_ONESHOT */;
-	en.nth = nth + 2 /* FAULT_NTH_MIN */;
+	en.mode = 0; // FAULT_MODE_NTH_ONESHOT
+	en.nth = nth + 2; //FAULT_NTH_MIN
 	if (ioctl(fd, FAULT_IOC_ENABLE, &en) != 0)
 		fail("FAULT_IOC_ENABLE failed with nth=%d", nth);
 
diff --git a/executor/common_linux.h b/executor/common_linux.h
index c9620bfe4..d73f8a66a 100644
--- a/executor/common_linux.h
+++ b/executor/common_linux.h
@@ -606,7 +606,7 @@ static int netlink_devlink_id_get(struct nlmsg* nlmsg, int sock)
 		debug("netlink: failed to parse message for devlink family id\n");
 		return -1;
 	}
-	recv(sock, nlmsg->buf, sizeof(nlmsg->buf), 0); /* recv ack */
+	recv(sock, nlmsg->buf, sizeof(nlmsg->buf), 0); // recv ack
 
 	return id;
 }
@@ -820,7 +820,7 @@ static int netlink_wireguard_id_get(struct nlmsg* nlmsg, int sock)
 		debug("netlink: failed to parse message for wireguard family id\n");
 		return -1;
 	}
-	recv(sock, nlmsg->buf, sizeof(nlmsg->buf), 0); /* recv ack */
+	recv(sock, nlmsg->buf, sizeof(nlmsg->buf), 0); // recv ack
 
 	return id;
 }
@@ -841,11 +841,11 @@ static void netlink_wireguard_setup(void)
 	const uint16 listen_c = 20003;
 	const uint16 af_inet = AF_INET;
 	const uint16 af_inet6 = AF_INET6;
-	/* Unused, but useful in case we change this:
-	const struct sockaddr_in endpoint_a_v4 = {
-	    .sin_family = AF_INET,
-	    .sin_port = htons(listen_a),
-	    .sin_addr = {htonl(INADDR_LOOPBACK)}};*/
+	// Unused, but useful in case we change this:
+	// const struct sockaddr_in endpoint_a_v4 = {
+	//     .sin_family = AF_INET,
+	//     .sin_port = htons(listen_a),
+	//     .sin_addr = {htonl(INADDR_LOOPBACK)}};
 	const struct sockaddr_in endpoint_b_v4 = {
 	    .sin_family = AF_INET,
 	    .sin_port = htons(listen_b),
@@ -858,11 +858,11 @@ static void netlink_wireguard_setup(void)
 	    .sin6_family = AF_INET6,
 	    .sin6_port = htons(listen_a)};
 	endpoint_a_v6.sin6_addr = in6addr_loopback;
-	/* Unused, but useful in case we change this:
-	const struct sockaddr_in6 endpoint_b_v6 = {
-	    .sin6_family = AF_INET6,
-	    .sin6_port = htons(listen_b)};
-	endpoint_b_v6.sin6_addr = in6addr_loopback; */
+	// Unused, but useful in case we change this:
+	// const struct sockaddr_in6 endpoint_b_v6 = {
+	//     .sin6_family = AF_INET6,
+	//     .sin6_port = htons(listen_b)};
+	// endpoint_b_v6.sin6_addr = in6addr_loopback;
 	struct sockaddr_in6 endpoint_c_v6 = {
 	    .sin6_family = AF_INET6,
 	    .sin6_port = htons(listen_c)};
diff --git a/executor/common_usb_netbsd.h b/executor/common_usb_netbsd.h
index af73e19c4..78cf4ba98 100644
--- a/executor/common_usb_netbsd.h
+++ b/executor/common_usb_netbsd.h
@@ -11,11 +11,7 @@
 #include <fcntl.h>
 #include <sys/ioctl.h>
 
-/* -------------------------------------------------------------------------- */
-
-/*
- * Redefinitions to match the linux types used in common_usb.h.
- */
+// Redefinitions to match the linux types used in common_usb.h.
 
 struct usb_endpoint_descriptor {
 	uint8 bLength;
@@ -155,8 +151,6 @@ struct usb_qualifier_descriptor {
 
 #include "common_usb.h"
 
-/* -------------------------------------------------------------------------- */
-
 static int vhci_open(void)
 {
 	char path[1024];
@@ -211,8 +205,6 @@ static int vhci_usb_send(int fd, void* buf, size_t size)
 	}
 }
 
-/* -------------------------------------------------------------------------- */
-
 static volatile long syz_usb_connect_impl(uint64 speed, uint64 dev_len,
 					  const char* dev, const struct vusb_connect_descriptors* descs,
 					  lookup_connect_out_response_t lookup_connect_response_out)
@@ -300,7 +292,7 @@ static volatile long syz_usb_connect_impl(uint64 speed, uint64 dev_len,
 
 		if ((req.u.ctrl.bmRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD &&
 		    req.u.ctrl.bRequest == USB_REQ_SET_CONFIGURATION) {
-			/* TODO: possibly revisit */
+			// TODO: possibly revisit.
 		}
 
 		if (response_length > sizeof(data))
diff --git a/pkg/csource/common.go b/pkg/csource/common.go
index c767349e2..a4adf3a56 100644
--- a/pkg/csource/common.go
+++ b/pkg/csource/common.go
@@ -52,7 +52,7 @@ func createCommonHeader(p, mmapProg *prog.Prog, replacements map[string]string,
 	}
 
 	for from, to := range replacements {
-		src = bytes.Replace(src, []byte("/*"+from+"*/"), []byte(to), -1)
+		src = bytes.Replace(src, []byte("/*{{{"+from+"}}}*/"), []byte(to), -1)
 	}
 
 	for from, to := range map[string]string{
diff --git a/pkg/csource/csource_test.go b/pkg/csource/csource_test.go
index 152c732b8..a3a731a7c 100644
--- a/pkg/csource/csource_test.go
+++ b/pkg/csource/csource_test.go
@@ -186,24 +186,38 @@ func TestExecutorMacros(t *testing.T) {
 }
 
 func TestExecutorMistakes(t *testing.T) {
-	mistakes := map[string][]string{
-		// We strip debug() calls from the resulting C source,
-		// this breaks the following pattern. Use {} around debug() to fix.
-		"\\)\n\\t*(debug|debug_dump_data)\\(": {
-			`
+	mistakes := []struct {
+		pattern string
+		message string
+		tests   []string
+	}{
+		{
+			pattern: `\)\n\t*(debug|debug_dump_data)\(`,
+			message: "debug() calls are stripped from C reproducers, this code will break. Use {} around debug() to fix",
+			tests: []string{
+				`
 if (foo)
 	debug("foo failed");
 `, `
 	if (x + y)
 		debug_dump_data(data, len);
 `,
+			},
+		},
+		{
+			// These are also not properly stripped by pkg/csource.
+			pattern: `/\*[^{]`,
+			message: "Don't use /* */ block comments. Use // line comments instead",
+			tests: []string{
+				`/* C++ comment */`,
+			},
 		},
 	}
-	for pattern, tests := range mistakes {
-		re := regexp.MustCompile(pattern)
-		for _, test := range tests {
+	for _, mistake := range mistakes {
+		re := regexp.MustCompile(mistake.pattern)
+		for _, test := range mistake.tests {
 			if !re.MatchString(test) {
-				t.Errorf("patter %q does not match test %q", pattern, test)
+				t.Errorf("patter %q does not match test %q", mistake.pattern, test)
 			}
 		}
 		for _, match := range re.FindAllStringIndex(commonHeader, -1) {
@@ -214,8 +228,7 @@ if (foo)
 			for end != len(commonHeader) && commonHeader[end] != '\n' {
 				end++
 			}
-			t.Errorf("pattern %q matches executor source:\n%v",
-				pattern, commonHeader[start:end])
+			t.Errorf("%v:%v", mistake.message, commonHeader[start:end])
 		}
 	}
 }
diff --git a/pkg/csource/generated.go b/pkg/csource/generated.go
index bd925d1df..e61ee2942 100644
--- a/pkg/csource/generated.go
+++ b/pkg/csource/generated.go
@@ -419,12 +419,6 @@ void child()
 #include <fcntl.h>
 #include <sys/ioctl.h>
 
-/* -------------------------------------------------------------------------- */
-
-/*
- * Redefinitions to match the linux types used in common_usb.h.
- */
-
 struct usb_endpoint_descriptor {
 	uint8 bLength;
 	uint8 bDescriptorType;
@@ -1336,8 +1330,6 @@ static bool lookup_control_response(const struct vusb_descriptors* descs, const
 #endif
 
 
-/* -------------------------------------------------------------------------- */
-
 static int vhci_open(void)
 {
 	char path[1024];
@@ -1392,8 +1384,6 @@ static int vhci_usb_send(int fd, void* buf, size_t size)
 	}
 }
 
-/* -------------------------------------------------------------------------- */
-
 static volatile long syz_usb_connect_impl(uint64 speed, uint64 dev_len,
 					  const char* dev, const struct vusb_connect_descriptors* descs,
 					  lookup_connect_out_response_t lookup_connect_response_out)
@@ -1481,7 +1471,6 @@ static volatile long syz_usb_connect_impl(uint64 speed, uint64 dev_len,
 
 		if ((req.u.ctrl.bmRequestType & USB_TYPE_MASK) == USB_TYPE_STANDARD &&
 		    req.u.ctrl.bRequest == USB_REQ_SET_CONFIGURATION) {
-			/* TODO: possibly revisit */
 		}
 
 		if (response_length > sizeof(data))
@@ -1595,8 +1584,8 @@ static int inject_fault(int nth)
 		fail("failed to open /dev/fault");
 
 	en.scope = FAULT_SCOPE_LWP;
-	en.mode = 0 /* FAULT_MODE_NTH_ONESHOT */;
-	en.nth = nth + 2 /* FAULT_NTH_MIN */;
+	en.mode = 0;
+	en.nth = nth + 2;
 	if (ioctl(fd, FAULT_IOC_ENABLE, &en) != 0)
 		fail("FAULT_IOC_ENABLE failed with nth=%d", nth);
 
@@ -2842,7 +2831,7 @@ static int netlink_devlink_id_get(struct nlmsg* nlmsg, int sock)
 		debug("netlink: failed to parse message for devlink family id\n");
 		return -1;
 	}
-	recv(sock, nlmsg->buf, sizeof(nlmsg->buf), 0); /* recv ack */
+	recv(sock, nlmsg->buf, sizeof(nlmsg->buf), 0);
 
 	return id;
 }
@@ -3054,7 +3043,7 @@ static int netlink_wireguard_id_get(struct nlmsg* nlmsg, int sock)
 		debug("netlink: failed to parse message for wireguard family id\n");
 		return -1;
 	}
-	recv(sock, nlmsg->buf, sizeof(nlmsg->buf), 0); /* recv ack */
+	recv(sock, nlmsg->buf, sizeof(nlmsg->buf), 0);
 
 	return id;
 }
@@ -3075,11 +3064,6 @@ static void netlink_wireguard_setup(void)
 	const uint16 listen_c = 20003;
 	const uint16 af_inet = AF_INET;
 	const uint16 af_inet6 = AF_INET6;
-	/* Unused, but useful in case we change this:
-	const struct sockaddr_in endpoint_a_v4 = {
-	    .sin_family = AF_INET,
-	    .sin_port = htons(listen_a),
-	    .sin_addr = {htonl(INADDR_LOOPBACK)}};*/
 	const struct sockaddr_in endpoint_b_v4 = {
 	    .sin_family = AF_INET,
 	    .sin_port = htons(listen_b),
@@ -3092,11 +3076,6 @@ static void netlink_wireguard_setup(void)
 	    .sin6_family = AF_INET6,
 	    .sin6_port = htons(listen_a)};
 	endpoint_a_v6.sin6_addr = in6addr_loopback;
-	/* Unused, but useful in case we change this:
-	const struct sockaddr_in6 endpoint_b_v6 = {
-	    .sin6_family = AF_INET6,
-	    .sin6_port = htons(listen_b)};
-	endpoint_b_v6.sin6_addr = in6addr_loopback; */
 	struct sockaddr_in6 endpoint_c_v6 = {
 	    .sin6_family = AF_INET6,
 	    .sin6_port = htons(listen_c)};
@@ -9098,7 +9077,7 @@ static void loop(void)
 	int collide = 0;
 again:
 #endif
-	for (call = 0; call < /*NUM_CALLS*/; call++) {
+	for (call = 0; call < /*{{{NUM_CALLS}}}*/; call++) {
 		for (thread = 0; thread < (int)(sizeof(threads) / sizeof(threads[0])); thread++) {
 			struct thread_t* th = &threads[thread];
 			if (!th->created) {
@@ -9118,7 +9097,7 @@ again:
 			if (collide && (call % 2) == 0)
 				break;
 #endif
-			event_timedwait(&th->done, /*CALL_TIMEOUT*/);
+			event_timedwait(&th->done, /*{{{CALL_TIMEOUT}}}*/);
 			break;
 		}
 	}
@@ -9168,7 +9147,7 @@ static void loop(void)
 #endif
 	int iter;
 #if SYZ_REPEAT_TIMES
-	for (iter = 0; iter < /*REPEAT_TIMES*/; iter++) {
+	for (iter = 0; iter < /*{{{REPEAT_TIMES}}}*/; iter++) {
 #else
 	for (iter = 0;; iter++) {
 #endif
@@ -9273,9 +9252,9 @@ static void loop(void)
 #endif
 
 #if !SYZ_EXECUTOR
-/*SYSCALL_DEFINES*/
+/*{{{SYSCALL_DEFINES}}}*/
 
-/*RESULTS*/
+/*{{{RESULTS}}}*/
 
 #if SYZ_THREADED || SYZ_REPEAT || SYZ_SANDBOX_NONE || SYZ_SANDBOX_SETUID || SYZ_SANDBOX_NAMESPACE || SYZ_SANDBOX_ANDROID
 #if SYZ_THREADED
@@ -9286,7 +9265,7 @@ void execute_one(void)
 void loop(void)
 #endif
 {
-	/*SYSCALLS*/
+	/*{{{SYSCALLS}}}*/
 #if SYZ_HAVE_CLOSE_FDS && !SYZ_THREADED && !SYZ_REPEAT
 	close_fds();
 #endif
@@ -9297,7 +9276,7 @@ void loop(void)
 
 int main(int argc, char** argv)
 {
-	/*MMAP_DATA*/
+	/*{{{MMAP_DATA}}}*/
 
 	program_name = argv[0];
 	if (argc == 2 && strcmp(argv[1], "child") == 0)
@@ -9305,7 +9284,7 @@ int main(int argc, char** argv)
 #else
 int main(void)
 {
-	/*MMAP_DATA*/
+	/*{{{MMAP_DATA}}}*/
 #endif
 
 #if SYZ_BINFMT_MISC
@@ -9328,13 +9307,13 @@ int main(void)
 	install_segv_handler();
 #endif
 #if SYZ_MULTI_PROC
-	for (procid = 0; procid < /*PROCS*/; procid++) {
+	for (procid = 0; procid < /*{{{PROCS}}}*/; procid++) {
 		if (fork() == 0) {
 #endif
 #if SYZ_USE_TMP_DIR || SYZ_SANDBOX_ANDROID
 			use_temporary_dir();
 #endif
-			/*SANDBOX_FUNC*/
+			/*{{{SANDBOX_FUNC}}}*/
 #if SYZ_HAVE_CLOSE_FDS && !SYZ_THREADED && !SYZ_REPEAT && !SYZ_SANDBOX_NONE && \
     !SYZ_SANDBOX_SETUID && !SYZ_SANDBOX_NAMESPACE && !SYZ_SANDBOX_ANDROID
 			close_fds();