nvmecontrol: libxo-ify

Author: kenrap

sbin/nvmecontrol/Makefile

@@ -30,7 +30,7 @@ SRCS+=	telemetry.c
 CFLAGS+= -I${SRCTOP}/lib/libnvmf
 MAN=	nvmecontrol.8
 LDFLAGS+= -rdynamic
-LIBADD+= nvmf sbuf util
+LIBADD+= nvmf sbuf util xo
 SUBDIR=	modules
 HAS_TESTS=
 SUBDIR.${MK_TESTS}+= tests

sbin/nvmecontrol/devlist.c

@@ -36,6 +36,7 @@
 #include <stdbool.h>
 #include <libnvmf.h>
 #include <libutil.h>
+#include <libxo/xo.h>
 #include <paths.h>
 #include <stddef.h>
 #include <stdio.h>
@@ -110,9 +111,10 @@ scan_namespace(int fd, int ctrlr, uint32_t nsid)
 	if (opt.human) {
 		humanize_number(buf, sizeof(buf), size, "B",
 		    HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL);
-		printf("  %10s (%s)\n", name, buf);
+		xo_emit("{P:  }{:name/%10s} ({:buffer/%s})\n", name, buf);
 	} else {
-		printf("  %10s (%juMB)\n", name, (uintmax_t)size / 1024 / 1024);
+		xo_emit("{P:  }{:name/%10s} ({:buffer-megabytes/%ju}{U:MB})\n", name,
+			(uintmax_t)size / 1024 / 1024);
 	}
 }
 
@@ -151,7 +153,7 @@ print_controller_info(const char *name, int fd)
 	}
 
 	nvme_strvis(mn, cdata.mn, sizeof(mn), NVME_MODEL_NUMBER_LENGTH);
-	printf("%6s: %s", name, mn);
+	xo_emit("{:name/%6s}: {:model-number/%s}", name, mn);
 	if (connected) {
 		const struct nvme_discovery_log_entry *dle;
 		size_t len;
@@ -160,7 +162,8 @@ print_controller_info(const char *name, int fd)
 		if (nvmf_reconnect_params(fd, &nvl) == 0) {
 			dle = nvlist_get_binary(nvl, "dle", &len);
 			if (len == sizeof(*dle)) {
-				printf(" (connected via %s %.*s:%.*s)",
+				xo_emit("{P: }(connected via {:trtype/%s} "
+					"{:traddr/%.*s}:{:trsvcid/%.*s})",
 				    nvmf_transport_type(dle->trtype),
 				    (int)sizeof(dle->traddr), dle->traddr,
 				    (int)sizeof(dle->trsvcid), dle->trsvcid);
@@ -176,10 +179,10 @@ print_controller_info(const char *name, int fd)
 		last_disconnect.tv_sec = nvlist_get_number(nvl_ts, "tv_sec");
 		last_disconnect.tv_nsec = nvlist_get_number(nvl_ts, "tv_nsec");
 		timespecsub(&now, &last_disconnect, &delta);
-		printf(" (disconnected for %ju seconds)",
+		xo_emit("{P: }(disconnected for {:seconds/%ju} seconds)",
 		    (uintmax_t)delta.tv_sec);
 	}
-	printf("\n");
+	xo_emit("\n");
 	nvlist_destroy(nvl);
 	return (connected);
 }
@@ -245,7 +248,7 @@ devlist(const struct cmd *f, int argc, char *argv[])
 	}
 
 	if (found == 0) {
-		printf("No NVMe controllers found.\n");
+		xo_emit("{d:No NVMe controllers found.}{e:devlist-page}\n");
 		exit(EX_UNAVAILABLE);
 	}
 

sbin/nvmecontrol/discover.c

@@ -7,6 +7,7 @@
 
 #include <err.h>
 #include <libnvmf.h>
+#include <libxo/xo.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -182,37 +183,43 @@ nvmf_tcp_security_type(uint8_t sectype)
 static void
 print_discovery_entry(u_int i, struct nvme_discovery_log_entry *entry)
 {
-	printf("Entry %02d\n", i + 1);
-	printf("========\n");
-	printf(" Transport type:       %s\n",
+	xo_emit("{T:Entry }{T:entry/%02d}\n", i + 1);
+	xo_emit("{T:========}\n");
+	xo_emit("{P: }{Lc:Transport type}{P:       }{:transport/%s}\n",
 	    nvmf_transport_type(entry->trtype));
-	printf(" Address family:       %s\n",
+	xo_emit("{P: }{Lc:Address family}{P:       }{:address/%s}\n",
 	    nvmf_address_family(entry->adrfam));
-	printf(" Subsystem type:       %s\n",
+	xo_emit("{P: }{Lc:Subsystem type}{P:       }{:subsystem/%s}\n",
 	    nvmf_subsystem_type(entry->subtype));
-	printf(" SQ flow control:      %s\n",
+	xo_emit("{P: }{Lc:SQ flow control}{P:      }{:sq-flow/%s}\n",
 	    (entry->treq & (1 << 2)) == 0 ? "required" : "optional");
-	printf(" Secure Channel:       %s\n", nvmf_secure_channel(entry->treq));
-	printf(" Port ID:              %u\n", entry->portid);
-	printf(" Controller ID:        %s\n",
+	xo_emit("{P: }{Lc:Secure Channel}{P:       }{:secure-chan/%s}\n",
+			nvmf_secure_channel(entry->treq));
+	xo_emit("{P: }{Lc:Port ID}{P:              }{:port-id/%u}\n",
+			entry->portid);
+	xo_emit("{P: }{Lc:Controller ID}{P:        }{:controller-id/%s}\n",
 	    nvmf_controller_id(entry->cntlid));
-	printf(" Max Admin SQ Size:    %u\n", entry->aqsz);
-	printf(" Sub NQN:              %s\n", entry->subnqn);
-	printf(" Transport address:    %s\n", entry->traddr);
-	printf(" Service identifier:   %s\n", entry->trsvcid);
+	xo_emit("{P: }{Lc:Max Admin SQ Size}{P:    }{:max-admin-sq/%u}\n",
+			entry->aqsz);
+	xo_emit("{P: }{Lc:Sub NQN}{P:              }{:sub-nqn/%s}\n",
+			entry->subnqn);
+	xo_emit("{P: }{Lc:Transport address}{P:    }{:transport-addr/%s}\n",
+			entry->traddr);
+	xo_emit("{P: }{Lc:Service identifier}{P:   }{:service-id/%s}\n",
+			entry->trsvcid);
 	switch (entry->trtype) {
 	case NVMF_TRTYPE_RDMA:
-		printf(" RDMA Service Type:    %s\n",
+		xo_emit("{P: }{Lc:RDMA Service Type}{P:    }{:rdma-service-type/%s}\n",
 		    nvmf_rdma_service_type(entry->tsas.rdma.rdma_qptype));
-		printf(" RDMA Provider Type:   %s\n",
+		xo_emit("{P: }{Lc:RDMA Provider Type}{P:   }{:rdma-provider-type/%s}\n",
 		    nvmf_rdma_provider_type(entry->tsas.rdma.rdma_prtype));
-		printf(" RDMA CMS:             %s\n",
+		xo_emit("{P: }{Lc:RDMA CMS}{P:             }{:rdma-cms-type/%s}\n",
 		    nvmf_rdma_cms(entry->tsas.rdma.rdma_cms));
-		printf(" Partition key:        %u\n",
+		xo_emit("{P: }{Lc:Partition key}{P:        }{:part-key/%u}\n",
 		    entry->tsas.rdma.rdma_pkey);
 		break;
 	case NVMF_TRTYPE_TCP:
-		printf(" Security Type:        %s\n",
+		xo_emit("{P: }{Lc:Security Type}{P:        }{:security-type/%s}\n",
 		    nvmf_tcp_security_type(entry->tsas.tcp.sectype));
 		break;
 	}
@@ -228,10 +235,10 @@ dump_discovery_log_page(struct nvmf_qpair *qp)
 	if (error != 0)
 		errc(EX_IOERR, error, "Failed to fetch discovery log page");
 
-	printf("Discovery\n");
-	printf("=========\n");
+	xo_emit("{T:Discovery}\n");
+	xo_emit("{T:=========}\n");
 	if (log->numrec == 0) {
-		printf("No entries found\n");
+		xo_emit("No entries found\n");
 	} else {
 		for (u_int i = 0; i < log->numrec; i++)
 			print_discovery_entry(i, &log->entries[i]);
@@ -262,7 +269,7 @@ discover(const struct cmd *f, int argc, char *argv[])
 	/* Use Identify to fetch controller data */
 	if (opt.verbose) {
 		identify_controller(qp);
-		printf("\n");
+		xo_emit("\n");
 	}
 
 	/* Fetch Log pages */

sbin/nvmecontrol/firmware.c

@@ -38,6 +38,7 @@
 #include <err.h>
 #include <fcntl.h>
 #include <inttypes.h>
+#include <libxo/xo.h>
 #include <stdbool.h>
 #include <stddef.h>
 #include <stdio.h>
@@ -308,31 +309,32 @@ firmware(const struct cmd *f, int argc, char *argv[])
 		read_image_file(opt.fw_img, &buf, &size);
 
 	if (opt.fw_img != NULL&& opt.activate)
-		printf("You are about to download and activate "
-		       "firmware image (%s) to controller %s.\n"
-		       "This may damage your controller and/or "
-		       "overwrite an existing firmware image.\n",
-		       opt.fw_img, opt.dev);
+		xo_emit("You are about to download and activate "
+			"firmware image ({:firmware-image/%s}) to "
+			"controller {:controller/%s}.\n"
+			"This may damage your controller and/or "
+			"overwrite an existing firmware image.\n",
+			opt.fw_img, opt.dev);
 	else if (opt.activate)
-		printf("You are about to activate a new firmware "
-		       "image on controller %s.\n"
-		       "This may damage your controller.\n",
-		       opt.dev);
+		xo_emit("You are about to activate a new firmware "
+			"image on controller {:controller/%s}.\n"
+			"This may damage your controller.\n",
+			opt.dev);
 	else if (opt.fw_img != NULL)
-		printf("You are about to download firmware image "
-		       "(%s) to controller %s.\n"
-		       "This may damage your controller and/or "
-		       "overwrite an existing firmware image.\n",
-		       opt.fw_img, opt.dev);
+		xo_emit("You are about to download firmware image "
+			"({:firmware-image/%s}) to controller {:controller/%s}.\n"
+			"This may damage your controller and/or "
+			"overwrite an existing firmware image.\n",
+			opt.fw_img, opt.dev);
 
-	printf("Are you sure you want to continue? (yes/no) ");
+	xo_emit("Are you sure you want to continue? (yes/no) ");
 	while (1) {
 		fgets(prompt, sizeof(prompt), stdin);
 		if (strncasecmp(prompt, "yes", 3) == 0)
 			break;
 		if (strncasecmp(prompt, "no", 2) == 0)
 			exit(EX_DATAERR);
-		printf("Please answer \"yes\" or \"no\". ");
+		xo_emit("Please answer \"yes\" or \"no\". ");
 	}
 
 	if (opt.fw_img != NULL) {
@@ -349,15 +351,15 @@ firmware(const struct cmd *f, int argc, char *argv[])
 
 	if (opt.activate) {
 		if (reboot_required) {
-			printf("New firmware image activated but requires "
-			       "conventional reset (i.e. reboot) to "
-			       "complete activation.\n");
+			xo_emit("New firmware image activated but requires "
+				"conventional reset (i.e. reboot) to "
+				"complete activation.\n");
 		} else {
-			printf("New firmware image activated and will take "
-			       "effect after next controller reset.\n"
-			       "Controller reset can be initiated via "
-			       "'nvmecontrol reset %s'\n",
-			       opt.dev);
+			xo_emit("New firmware image activated and will take "
+				"effect after next controller reset.\n"
+				"Controller reset can be initiated via "
+				"'nvmecontrol reset {:nvmecontrol-reset/%s}'\n",
+				opt.dev);
 		}
 	}