Introduce tprintf_comment and tprints_comment functions

* defs.h (tprintf_comment, tprints_comment): New prototypes.
* strace.c (tvprintf): New function.
(tprintf): Use it.
(tprintf_comment, tprints_comment): New functions.
* aio.c (tprint_lio_opcode): Use tprints_comment.
* dm.c (dm_decode_dm_target_spec, dm_decode_dm_target_deps,
dm_decode_dm_name_list, dm_decode_dm_target_versions,
dm_decode_dm_target_msg, dm_decode_string, dm_known_ioctl): Likewise.
* futex.c (SYS_FUNC(futex)): Likewise.
* perf.c (print_perf_event_attr): Likewise.
* seccomp.c (decode_bpf_code): Likewise.
* util.c (printxvals, printxval_searchn, printflags64): Likewise.
* btrfs.c (print_u64, btrfs_print_key_type, btrfs_print_objectid,
print_key_value_internal): Likewise.
(btrfs_ioctl): Use tprints_comment and tprintf_comment.
* dirent.c (SYS_FUNC(getdents)): Likewise.
* dirent64.c (SYS_FUNC(getdents64)): Likewise.
* execve.c (printargc): Use tprintf_comment.
* tests/btrfs.c (btrfs_test_get_dev_stats_ioctl,
btrfs_test_features_ioctls): Update expected output.

Author: ldv-alt

aio.c

@@ -73,7 +73,8 @@ tprint_lio_opcode(unsigned cmd)
 		tprints(cmds[cmd].name);
 		return cmds[cmd].sub;
 	}
-	tprintf("%u /* SUB_??? */", cmd);
+	tprintf("%u", cmd);
+	tprints_comment("SUB_???");
 	return SUB_NONE;
 }
 

btrfs.c

@@ -180,7 +180,7 @@ print_u64(const char *name, uint64_t value)
 {
 	tprintf(", %s=%" PRIu64, name, value);
 	if (value == UINT64_MAX)
-		tprints(" /* UINT64_MAX */");
+		tprints_comment("UINT64_MAX");
 }
 
 #define print_member_u64(obj, name) print_u64(#name, obj->name)
@@ -261,19 +261,15 @@ btrfs_print_qgroup_limit(const struct btrfs_qgroup_limit *lim)
 static void
 btrfs_print_key_type(uint32_t type)
 {
-	const char *str = xlookup(btrfs_key_types, type);
 	tprintf("%u", type);
-	if (str)
-		tprintf(" /* %s */", str);
+	tprints_comment(xlookup(btrfs_key_types, type));
 }
 
 static void
 btrfs_print_objectid(uint64_t objectid)
 {
-	const char *str = xlookup(btrfs_tree_objectids, objectid);
 	tprintf("%" PRIu64, objectid);
-	if (str)
-		tprintf(" /* %s */", str);
+	tprints_comment(xlookup(btrfs_tree_objectids, objectid));
 }
 
 static void
@@ -412,7 +408,7 @@ print_key_value_internal(struct tcb *tcp, const char *name, uint64_t value)
 	if (value) {
 		tprintf(", %s=%" PRIu64, name, value);
 		if (value == UINT64_MAX)
-			tprints(" /* UINT64_MAX */");
+			tprints_comment("UINT64_MAX");
 	}
 }
 #define print_key_value(tcp, key, name)					\
@@ -610,7 +606,7 @@ MPERS_PRINTER_DECL(int, btrfs_ioctl,
 
 		tprintf("%" PRIu64, (uint64_t) args.len);
 		if (args.len == UINT64_MAX)
-			tprints(" /* UINT64_MAX */");
+			tprints_comment("UINT64_MAX");
 
 		tprints(", flags=");
 		printflags64(btrfs_defrag_flags, args.flags,
@@ -702,35 +698,27 @@ MPERS_PRINTER_DECL(int, btrfs_ioctl,
 		printxval64(btrfs_dev_replace_results, args.result,
 			    "BTRFS_IOCTL_DEV_REPLACE_RESULT_???");
 		if (args.cmd == BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS) {
-			char buf[sizeof("HH:MM:SS") + 1];
-			time_t time;
 			tprints(", ");
 			printxval64(btrfs_dev_replace_state,
 				   args.status.replace_state,
 				   "BTRFS_IOCTL_DEV_REPLACE_STATE_???");
-			tprintf(", progress_1000=%" PRIu64 " /* ",
+			tprintf(", progress_1000=%" PRIu64,
 				(uint64_t) args.status.progress_1000);
+
 			if (args.status.progress_1000 <= 1000)
-				tprintf("%" PRIu64 ".%.2" PRIu64 "%%",
-					(uint64_t) args.status.progress_1000 / 10,
-					(uint64_t) args.status.progress_1000 % 10);
-			else
-				tprints("???");
-			tprints(" */ ,");
-
-			time = args.status.time_started;
-			strftime(buf, sizeof(buf), "%T",
-				 localtime(&time));
-			tprintf("time_started=%" PRIu64" /* %s */, ",
-				(uint64_t) args.status.time_started, buf);
-
-			time = args.status.time_stopped;
-			strftime(buf, sizeof(buf), "%T",
-				 localtime(&time));
-			tprintf("time_stopped=%" PRIu64" /* %s */, ",
-				(uint64_t) args.status.time_stopped, buf);
-
-			tprintf("num_write_errors=%" PRIu64
+				tprintf_comment("%u.%u%%",
+					(unsigned) args.status.progress_1000 / 10,
+					(unsigned) args.status.progress_1000 % 10);
+
+			tprintf(", time_started=%" PRIu64,
+				(uint64_t) args.status.time_started);
+			tprints_comment(sprinttime(args.status.time_started));
+
+			tprintf(", time_stopped=%" PRIu64,
+				(uint64_t) args.status.time_stopped);
+			tprints_comment(sprinttime(args.status.time_stopped));
+
+			tprintf(", num_write_errors=%" PRIu64
 				", num_uncorrectable_read_errors=%" PRIu64,
 				(uint64_t) args.status.num_write_errors,
 				(uint64_t) args.status.num_uncorrectable_read_errors);
@@ -779,14 +767,17 @@ MPERS_PRINTER_DECL(int, btrfs_ioctl,
 		if (umove_or_printaddr(tcp, arg, &flarg))
 			break;
 
-		tprints("[ /* supported */ ");
+		tprints("[");
 		btrfs_print_features(&flarg[0]);
+		tprints_comment("supported");
 
-		tprints(", /* safe to set */ ");
+		tprints(", ");
 		btrfs_print_features(&flarg[1]);
+		tprints_comment("safe to set");
 
-		tprints(", /* safe to clear */ ");
+		tprints(", ");
 		btrfs_print_features(&flarg[2]);
+		tprints_comment("safe to clear");
 		tprints("]");
 
 		break;
@@ -869,10 +860,8 @@ MPERS_PRINTER_DECL(int, btrfs_ioctl,
 				tprints("...");
 				break;
 			}
-			const char *name = xlookup(btrfs_dev_stats_values, i);
-			if (name)
-				tprintf("/* %s */ ", name);
 			tprintf("%" PRI__u64, args.values[i]);
+			tprints_comment(xlookup(btrfs_dev_stats_values, i));
 		}
 		tprints("]}");
 		break;
@@ -1108,7 +1097,7 @@ MPERS_PRINTER_DECL(int, btrfs_ioctl,
 					args.start);
 				tprintf("%" PRI__u64, args.end);
 				if (args.end == UINT64_MAX)
-					tprints(" /* UINT64_MAX */");
+					tprints_comment("UINT64_MAX");
 				tprints(", flags=");
 				printflags64(btrfs_scrub_flags, args.flags,
 					     "BTRFS_SCRUB_???");

defs.h

@@ -747,6 +747,8 @@ extern void line_ended(void);
 extern void tabto(void);
 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 extern void tprints(const char *str);
+extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
+extern void tprints_comment(const char *str);
 
 #if SUPPORTED_PERSONALITIES > 1
 extern void set_personality(int personality);

dirent.c

@@ -78,13 +78,13 @@ SYS_FUNC(getdents)
 
 	if (entering(tcp)) {
 		printfd(tcp, tcp->u_arg[0]);
-		tprints(", ");
 		return 0;
 	}
 
 	const unsigned int count = tcp->u_arg[2];
 
 	if (syserror(tcp) || !verbose(tcp)) {
+		tprints(", ");
 		printaddr(tcp->u_arg[1]);
 		tprintf(", %u", count);
 		return 0;
@@ -101,6 +101,7 @@ SYS_FUNC(getdents)
 	if (len) {
 		buf = malloc(len);
 		if (!buf || umoven(tcp, tcp->u_arg[1], len, buf) < 0) {
+			tprints(", ");
 			printaddr(tcp->u_arg[1]);
 			tprintf(", %u", count);
 			free(buf);
@@ -110,8 +111,9 @@ SYS_FUNC(getdents)
 		buf = NULL;
 	}
 
+	tprints(",");
 	if (!abbrev(tcp))
-		tprints("[");
+		tprints(" [");
 	for (i = 0; len && i <= len - sizeof(kernel_dirent); ) {
 		kernel_dirent *d = (kernel_dirent *) &buf[i];
 
@@ -143,15 +145,15 @@ SYS_FUNC(getdents)
 		}
 		dents++;
 		if (d->d_reclen < sizeof(kernel_dirent)) {
-			tprints("/* d_reclen < sizeof(struct dirent) */");
+			tprints_comment("d_reclen < sizeof(struct dirent)");
 			break;
 		}
 		i += d->d_reclen;
 	}
 	if (!abbrev(tcp))
 		tprints("]");
 	else
-		tprintf("/* %u entries */", dents);
+		tprintf_comment("%u entries", dents);
 	tprintf(", %u", count);
 	free(buf);
 	return 0;

dirent64.c

@@ -46,13 +46,13 @@ SYS_FUNC(getdents64)
 
 	if (entering(tcp)) {
 		printfd(tcp, tcp->u_arg[0]);
-		tprints(", ");
 		return 0;
 	}
 
 	const unsigned int count = tcp->u_arg[2];
 
 	if (syserror(tcp) || !verbose(tcp)) {
+		tprints(", ");
 		printaddr(tcp->u_arg[1]);
 		tprintf(", %u", count);
 		return 0;
@@ -69,6 +69,7 @@ SYS_FUNC(getdents64)
 	if (len) {
 		buf = malloc(len);
 		if (!buf || umoven(tcp, tcp->u_arg[1], len, buf) < 0) {
+			tprints(", ");
 			printaddr(tcp->u_arg[1]);
 			tprintf(", %u", count);
 			free(buf);
@@ -78,8 +79,9 @@ SYS_FUNC(getdents64)
 		buf = NULL;
 	}
 
+	tprints(",");
 	if (!abbrev(tcp))
-		tprints("[");
+		tprints(" [");
 	for (i = 0; len && i <= len - d_name_offset; ) {
 		struct dirent64 *d = (struct dirent64 *) &buf[i];
 		if (!abbrev(tcp)) {
@@ -110,7 +112,7 @@ SYS_FUNC(getdents64)
 			tprints("}");
 		}
 		if (d->d_reclen < d_name_offset) {
-			tprints("/* d_reclen < offsetof(struct dirent64, d_name) */");
+			tprints_comment("d_reclen < offsetof(struct dirent64, d_name)");
 			break;
 		}
 		i += d->d_reclen;
@@ -119,7 +121,7 @@ SYS_FUNC(getdents64)
 	if (!abbrev(tcp))
 		tprints("]");
 	else
-		tprintf("/* %u entries */", dents);
+		tprintf_comment("%u entries", dents);
 	tprintf(", %u", count);
 	free(buf);
 	return 0;

dm.c

@@ -195,7 +195,7 @@ dm_decode_dm_target_spec(struct tcb *const tcp, const kernel_ulong_t addr,
 
 misplaced:
 	tprints("???");
-	tprints(" /* misplaced struct dm_target_spec */");
+	tprints_comment("misplaced struct dm_target_spec");
 }
 
 bool
@@ -252,7 +252,7 @@ dm_decode_dm_target_deps(struct tcb *const tcp, const kernel_ulong_t addr,
 
 misplaced:
 	tprints("???");
-	tprints(" /* misplaced struct dm_target_deps */");
+	tprints_comment("misplaced struct dm_target_deps");
 }
 
 static void
@@ -311,7 +311,7 @@ dm_decode_dm_name_list(struct tcb *const tcp, const kernel_ulong_t addr,
 
 misplaced:
 	tprints("???");
-	tprints(" /* misplaced struct dm_name_list */");
+	tprints_comment("misplaced struct dm_name_list");
 }
 
 static void
@@ -368,7 +368,7 @@ dm_decode_dm_target_versions(struct tcb *const tcp, const kernel_ulong_t addr,
 
 misplaced:
 	tprints("???");
-	tprints(" /* misplaced struct dm_target_versions */");
+	tprints_comment("misplaced struct dm_target_versions");
 }
 
 static void
@@ -402,7 +402,7 @@ dm_decode_dm_target_msg(struct tcb *const tcp, const kernel_ulong_t addr,
 		tprints("}");
 	} else {
 		tprints("???");
-		tprints(" /* misplaced struct dm_target_msg */");
+		tprints_comment("misplaced struct dm_target_msg");
 	}
 }
 
@@ -425,7 +425,7 @@ dm_decode_string(struct tcb *const tcp, const kernel_ulong_t addr,
 			    QUOTE_0_TERMINATED);
 	} else {
 		tprints("???");
-		tprints(" /* misplaced string */");
+		tprints_comment("misplaced string");
 	}
 }
 
@@ -503,14 +503,14 @@ dm_known_ioctl(struct tcb *const tcp, const unsigned int code,
 	 * ioctl fields
 	 */
 	if (ioc->version[0] != DM_VERSION_MAJOR) {
-		tprints(" /* unsupported device mapper ABI version */");
+		tprints_comment("unsupported device mapper ABI version");
 		goto skip;
 	}
 
 	tprintf(", data_size=%u", ioc->data_size);
 
 	if (ioc->data_size < offsetof(struct dm_ioctl, data)) {
-		tprints(" /* data_size too small */");
+		tprints_comment("data_size too small");
 		goto skip;
 	}
 

execve.c

@@ -98,7 +98,7 @@ printargc(struct tcb *const tcp, kernel_ulong_t addr)
 		if (!cp)
 			break;
 	}
-	tprintf(" /* %u var%s%s */",
+	tprintf_comment("%u var%s%s",
 		count, count == 1 ? "" : "s",
 		unterminated ? ", unterminated" : "");
 }

futex.c

@@ -51,6 +51,7 @@ SYS_FUNC(futex)
 	const unsigned int val = tcp->u_arg[2];
 	const unsigned int val2 = tcp->u_arg[3];
 	const unsigned int val3 = tcp->u_arg[5];
+	const char *comment;
 
 	printaddr(uaddr);
 	tprints(", ");
@@ -94,15 +95,15 @@ SYS_FUNC(futex)
 		tprints(", ");
 		if ((val3 >> 28) & 8)
 			tprints("FUTEX_OP_OPARG_SHIFT<<28|");
-		if (printxval(futexwakeops, (val3 >> 28) & 0x7, NULL))
-			tprints("<<28");
-		else
-			tprints("<<28 /* FUTEX_OP_??? */");
+		comment = printxval(futexwakeops, (val3 >> 28) & 0x7, NULL)
+			? NULL : "FUTEX_OP_???";
+		tprints("<<28");
+		tprints_comment(comment);
 		tprintf("|%#x<<12|", (val3 >> 12) & 0xfff);
-		if (printxval(futexwakecmps, (val3 >> 24) & 0xf, NULL))
-			tprints("<<24");
-		else
-			tprints("<<24 /* FUTEX_OP_CMP_??? */");
+		comment = printxval(futexwakecmps, (val3 >> 24) & 0xf, NULL)
+			? NULL : "FUTEX_OP_CMP_???";
+		tprints("<<24");
+		tprints_comment(comment);
 		tprintf("|%#x", val3 & 0xfff);
 		break;
 	case FUTEX_WAIT_REQUEUE_PI: