xref: /NextBSD/sbin/geom/class/label/geom_label.c (revision eb1a5f8de9f7ea602c373a710f531abbf81141c4)
1 /*-
2  * Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <errno.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <strings.h>
36 #include <assert.h>
37 #include <libgeom.h>
38 #include <geom/label/g_label.h>
39 
40 #include "core/geom.h"
41 #include "misc/subr.h"
42 
43 #ifdef STATIC_GEOM_CLASSES
44 #define PUBSYM(x)	glabel_##x
45 #else
46 #define PUBSYM(x)	x
47 #endif
48 
49 uint32_t PUBSYM(lib_version) = G_LIB_VERSION;
50 uint32_t PUBSYM(version) = G_LABEL_VERSION;
51 
52 static void label_main(struct gctl_req *req, unsigned flags);
53 static void label_clear(struct gctl_req *req);
54 static void label_dump(struct gctl_req *req);
55 static void label_label(struct gctl_req *req);
56 
57 struct g_command PUBSYM(class_commands)[] = {
58 	{ "clear", G_FLAG_VERBOSE, label_main, G_NULL_OPTS,
59 	    "[-v] dev ..."
60 	},
61 	{ "create", G_FLAG_VERBOSE | G_FLAG_LOADKLD, NULL, G_NULL_OPTS,
62 	    "[-v] name dev"
63 	},
64 	{ "destroy", G_FLAG_VERBOSE, NULL,
65 	    {
66 		{ 'f', "force", NULL, G_TYPE_BOOL },
67 		G_OPT_SENTINEL
68 	    },
69 	    "[-fv] name ..."
70 	},
71 	{ "dump", 0, label_main, G_NULL_OPTS,
72 	    "dev ..."
73 	},
74 	{ "label", G_FLAG_VERBOSE | G_FLAG_LOADKLD, label_main, G_NULL_OPTS,
75 	    "[-v] name dev"
76 	},
77 	{ "stop", G_FLAG_VERBOSE, NULL,
78 	    {
79 		{ 'f', "force", NULL, G_TYPE_BOOL },
80 		G_OPT_SENTINEL
81 	    },
82 	    "[-fv] name ..."
83 	},
84 	G_CMD_SENTINEL
85 };
86 
87 static int verbose = 0;
88 
89 static void
label_main(struct gctl_req * req,unsigned flags)90 label_main(struct gctl_req *req, unsigned flags)
91 {
92 	const char *name;
93 
94 	if ((flags & G_FLAG_VERBOSE) != 0)
95 		verbose = 1;
96 
97 	name = gctl_get_ascii(req, "verb");
98 	if (name == NULL) {
99 		gctl_error(req, "No '%s' argument.", "verb");
100 		return;
101 	}
102 	if (strcmp(name, "label") == 0)
103 		label_label(req);
104 	else if (strcmp(name, "clear") == 0)
105 		label_clear(req);
106 	else if (strcmp(name, "dump") == 0)
107 		label_dump(req);
108 	else
109 		gctl_error(req, "Unknown command: %s.", name);
110 }
111 
112 static void
label_label(struct gctl_req * req)113 label_label(struct gctl_req *req)
114 {
115 	struct g_label_metadata md;
116 	const char *name, *label;
117 	u_char sector[512];
118 	int error, nargs;
119 
120 	nargs = gctl_get_int(req, "nargs");
121 	if (nargs != 2) {
122 		gctl_error(req, "Invalid number of arguments.");
123 		return;
124 	}
125 
126 	/*
127 	 * Clear last sector first to spoil all components if device exists.
128 	 */
129 	name = gctl_get_ascii(req, "arg1");
130 	error = g_metadata_clear(name, NULL);
131 	if (error != 0) {
132 		gctl_error(req, "Can't store metadata on %s: %s.", name,
133 		    strerror(error));
134 		return;
135 	}
136 
137 	strlcpy(md.md_magic, G_LABEL_MAGIC, sizeof(md.md_magic));
138 	md.md_version = G_LABEL_VERSION;
139 	label = gctl_get_ascii(req, "arg0");
140 	strlcpy(md.md_label, label, sizeof(md.md_label));
141 	md.md_provsize = g_get_mediasize(name);
142 	if (md.md_provsize == 0) {
143 		gctl_error(req, "Can't get mediasize of %s: %s.", name,
144 		    strerror(errno));
145 		return;
146 	}
147 
148 	/*
149 	 * Ok, store metadata.
150 	 */
151 	label_metadata_encode(&md, sector);
152 	error = g_metadata_store(name, sector, sizeof(sector));
153 	if (error != 0) {
154 		fprintf(stderr, "Can't store metadata on %s: %s.\n", name,
155 		    strerror(error));
156 		gctl_error(req, "Not done.");
157 	}
158 	if (verbose)
159 		printf("Metadata value stored on %s.\n", name);
160 }
161 
162 static void
label_clear(struct gctl_req * req)163 label_clear(struct gctl_req *req)
164 {
165 	const char *name;
166 	int error, i, nargs;
167 
168 	nargs = gctl_get_int(req, "nargs");
169 	if (nargs < 1) {
170 		gctl_error(req, "Too few arguments.");
171 		return;
172 	}
173 
174 	for (i = 0; i < nargs; i++) {
175 		name = gctl_get_ascii(req, "arg%d", i);
176 		error = g_metadata_clear(name, G_LABEL_MAGIC);
177 		if (error != 0) {
178 			fprintf(stderr, "Can't clear metadata on %s: %s.\n",
179 			    name, strerror(error));
180 			gctl_error(req, "Not fully done.");
181 			continue;
182 		}
183 		if (verbose)
184 			printf("Metadata cleared on %s.\n", name);
185 	}
186 }
187 
188 static void
label_metadata_dump(const struct g_label_metadata * md)189 label_metadata_dump(const struct g_label_metadata *md)
190 {
191 
192 	printf("    Magic string: %s\n", md->md_magic);
193 	printf("Metadata version: %u\n", (u_int)md->md_version);
194 	printf("           Label: %s\n", md->md_label);
195 }
196 
197 static void
label_dump(struct gctl_req * req)198 label_dump(struct gctl_req *req)
199 {
200 	struct g_label_metadata md, tmpmd;
201 	const char *name;
202 	int error, i, nargs;
203 
204 	nargs = gctl_get_int(req, "nargs");
205 	if (nargs < 1) {
206 		gctl_error(req, "Too few arguments.");
207 		return;
208 	}
209 
210 	for (i = 0; i < nargs; i++) {
211 		name = gctl_get_ascii(req, "arg%d", i);
212 		error = g_metadata_read(name, (u_char *)&tmpmd, sizeof(tmpmd),
213 		    G_LABEL_MAGIC);
214 		if (error != 0) {
215 			fprintf(stderr, "Can't read metadata from %s: %s.\n",
216 			    name, strerror(error));
217 			gctl_error(req, "Not fully done.");
218 			continue;
219 		}
220 		label_metadata_decode((u_char *)&tmpmd, &md);
221 		printf("Metadata on %s:\n", name);
222 		label_metadata_dump(&md);
223 		printf("\n");
224 	}
225 }
226