xref: /freebsd/sys/geom/label/g_label_disk_ident.c (revision a0409676120c1e558d0ade943019934e0f15118d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2012 Ivan Voras <ivoras@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 
37 #include <geom/geom.h>
38 #include <geom/geom_disk.h>
39 #include <geom/label/g_label.h>
40 #include <geom/multipath/g_multipath.h>
41 
42 static char* classes_pass[] = { G_DISK_CLASS_NAME, G_MULTIPATH_CLASS_NAME,
43     NULL };
44 
45 static void
46 g_label_disk_ident_taste(struct g_consumer *cp, char *label, size_t size)
47 {
48 	struct g_class *cls;
49 	char ident[DISK_IDENT_SIZE];
50 	int ident_len, found, i;
51 
52 	g_topology_assert_not();
53 	label[0] = '\0';
54 
55 	cls = cp->provider->geom->class;
56 
57 	/*
58 	 * Get the GEOM::ident string, and construct a label in the format
59 	 * "CLASS_NAME-ident"
60 	 */
61 	ident_len = sizeof(ident);
62 	if (g_io_getattr("GEOM::ident", cp, &ident_len, ident) == 0) {
63 		if (ident_len == 0 || ident[0] == '\0')
64 			return;
65 		for (i = 0, found = 0; classes_pass[i] != NULL; i++)
66 			if (strcmp(classes_pass[i], cls->name) == 0) {
67 				found = 1;
68 				break;
69 			}
70 		if (!found)
71 			return;
72 		/*
73 		 * We can safely ignore the result of snprintf(): the label
74 		 * will simply be truncated, which at most is only annoying.
75 		 */
76 		(void)snprintf(label, size, "%s-%s", cls->name, ident);
77 	}
78 }
79 
80 struct g_label_desc g_label_disk_ident = {
81 	.ld_taste = g_label_disk_ident_taste,
82 	.ld_dirprefix = "diskid/",
83 	.ld_enabled = 1
84 };
85 
86 G_LABEL_INIT(disk_ident, g_label_disk_ident, "Create device nodes for drives "
87     "which export a disk identification string");
88