From a1f08bc5f7b37450504a24735e5bb2c746553f5e Mon Sep 17 00:00:00 2001
From: joerg <joerg@FreeBSD.org>
Date: Wed, 30 Mar 2005 09:33:10 +0000
Subject: Support VTOC volume names.  This can be useful to distinguish
 multiple disks in a system.  Solaris' format(1m) displays the volume names in
 the disk overview.

MFC after:	1 month
---
 sbin/sunlabel/sunlabel.8 | 13 ++++++++++--
 sbin/sunlabel/sunlabel.c | 52 ++++++++++++++++++++++++++++++++++++++++++++----
 2 files changed, 59 insertions(+), 6 deletions(-)

(limited to 'sbin/sunlabel')

diff --git a/sbin/sunlabel/sunlabel.8 b/sbin/sunlabel/sunlabel.8
index 1662b0e..2460989 100644
--- a/sbin/sunlabel/sunlabel.8
+++ b/sbin/sunlabel/sunlabel.8
@@ -26,7 +26,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd June 1, 2004
+.Dd March 30, 2005
 .Dt SUNLABEL 8
 .Os
 .Sh NAME
@@ -238,7 +238,7 @@ be written to disk.
 The label presented for editing is the same as the standard
 printout, with some added hints about the possible options to
 specify the sector size and starting cylinder.
-There are two areas in the template that can be edited:
+The following areas in the template that can be edited:
 .Bl -tag -width indent
 .It Sy Textual label, geometry emulation
 The line
@@ -266,6 +266,15 @@ The product
 .D1 Em (CC + 2) * HH * SS
 must be less than or equal to the total number of sectors of the
 disk (which is given as a hint in a comment field).
+.It Sy Volume name
+The volume name (if present) is introduced by the string
+.Dq "volume name:" .
+It can be up to 8 characters long, and might be useful to distinguish
+different disks in a system.
+Note that volume names require the VTOC elements to be present, so
+any of the VTOC constraints described below need to be obeyed as well
+if a volume name is to be set.
+Setting an empty volume name will delete it from the label.
 .It Sy Partition entries
 Partition entries start with a letter from
 .Ql a
diff --git a/sbin/sunlabel/sunlabel.c b/sbin/sunlabel/sunlabel.c
index d299f36..7bf051e 100644
--- a/sbin/sunlabel/sunlabel.c
+++ b/sbin/sunlabel/sunlabel.c
@@ -1,6 +1,6 @@
 /*-
  * Copyright (c) 2003 Jake Burkholder.
- * Copyright (c) 2004 Joerg Wunsch.
+ * Copyright (c) 2004,2005 Joerg Wunsch.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -541,6 +541,7 @@ parse_label(struct sun_disklabel *sl, const char *file)
 	char tag[32];
 	char buf[128];
 	char text[128];
+	char volname[SUN_VOLNAME_LEN + 1];
 	struct sun_disklabel sl1;
 	char *bp;
 	const char *what;
@@ -631,6 +632,33 @@ parse_label(struct sun_disklabel *sl, const char *file)
 			    text, cyl, alt, hd, sec);
 			continue;
 		}
+		if (strncmp(bp, "volume name:", strlen("volume name:")) == 0) {
+			wantvtoc = 1; /* Volume name requires VTOC. */
+			bp += strlen("volume name:");
+#if SUN_VOLNAME_LEN != 8
+# error "scanf field width does not match SUN_VOLNAME_LEN"
+#endif
+			/*
+			 * We set the field length to one more than
+			 * SUN_VOLNAME_LEN to allow detecting an
+			 * overflow.
+			 */
+			memset(volname, 0, sizeof volname);
+			rv = sscanf(bp, " %9[^\n]", volname);
+			if (rv != 1) {
+				/* Clear the volume name. */
+				memset(sl1.sl_vtoc_volname, 0,
+				    SUN_VOLNAME_LEN);
+			} else {
+				memcpy(sl1.sl_vtoc_volname, volname,
+				    SUN_VOLNAME_LEN);
+				if (volname[SUN_VOLNAME_LEN] != '\0')
+					warnx(
+"%s, line %d: volume name longer than %d characters, truncating",
+					    file, line + 1, SUN_VOLNAME_LEN);
+			}
+			continue;
+		}
 		if (strlen(bp) < 2 || bp[1] != ':') {
 			line++;
 			continue;
@@ -742,9 +770,11 @@ parse_offset(struct sun_disklabel *sl, int part, char *offset)
 static void
 print_label(struct sun_disklabel *sl, const char *disk, FILE *out)
 {
-	int i;
+	int i, j;
 	int havevtoc;
 	uintmax_t secpercyl;
+	/* Long enough to hex-encode each character. */
+	char volname[4 * SUN_VOLNAME_LEN + 1];
 
 	havevtoc = sl->sl_vtoc_sane == SUN_VTOC_SANE;
 	secpercyl = sl->sl_nsectors * sl->sl_ntracks;
@@ -763,11 +793,25 @@ print_label(struct sun_disklabel *sl, const char *disk, FILE *out)
 		    "# max sectors/unit (including alt cylinders): %ju\n",
 		    (uintmax_t)mediasize / sectorsize);
 	fprintf(out,
-"sectors/unit: %ju\n"
+"sectors/unit: %ju\n",
+	    secpercyl * sl->sl_ncylinders);
+	if (havevtoc && sl->sl_vtoc_volname[0] != '\0') {
+		for (i = j = 0; i < SUN_VOLNAME_LEN; i++) {
+			if (sl->sl_vtoc_volname[i] == '\0')
+				break;
+			if (isprint(sl->sl_vtoc_volname[i]))
+				volname[j++] = sl->sl_vtoc_volname[i];
+			else
+				j += sprintf(volname + j, "\\x%02X",
+				    sl->sl_vtoc_volname[i]);
+		}
+		volname[j] = '\0';
+		fprintf(out, "volume name: %s\n", volname);
+	}
+	fprintf(out,
 "\n"
 "%d partitions:\n"
 "#\n",
-	    secpercyl * sl->sl_ncylinders,
 	    SUN_NPART);
 	if (!hflag) {
 		fprintf(out, "# Size is in %s.", cflag? "cylinders": "sectors");
-- 
cgit v1.1